]> git.sesse.net Git - vlc/blobdiff - src/modules/cache.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / src / modules / cache.c
index 0c8b616d51ee03c4a32f0b49ca7115153094b9a6..3f09ad8325ed6c3b9b0cd8d817ada68a5fcdebc6 100644 (file)
@@ -36,6 +36,7 @@
 #include <string.h>                                              /* strdup() */
 #include <vlc_plugin.h>
 #include <vlc_cpu.h>
+#include <errno.h>
 
 #include <sys/types.h>
 #ifdef HAVE_UNISTD_H
@@ -45,7 +46,7 @@
 
 #include "config/configuration.h"
 
-#include "vlc_charset.h"
+#include <vlc_fs.h>
 
 #include "modules/modules.h"
 
@@ -58,7 +59,7 @@ static int    CacheLoadConfig  ( module_t *, FILE * );
 
 /* Sub-version number
  * (only used to avoid breakage in dev version when cache structure changes) */
-#define CACHE_SUBVERSION_NUM 8
+#define CACHE_SUBVERSION_NUM 11
 
 /* Format string for the cache filename */
 #define CACHENAME_FORMAT \
@@ -66,8 +67,23 @@ static int    CacheLoadConfig  ( module_t *, FILE * );
 /* Magic for the cache filename */
 #define CACHENAME_VALUES \
     sizeof(int), sizeof(void *), *(uint8_t *)&(uint16_t){ 0xbe1e }, vlc_CPU()
+#define CACHE_STRING "cache "PACKAGE_NAME" "PACKAGE_VERSION
 
 
+void CacheDelete( vlc_object_t *obj, const char *dir )
+{
+    char *path;
+
+    assert( dir != NULL );
+
+    if( asprintf( &path, "%s"DIR_SEP CACHENAME_FORMAT,
+                  dir, CACHENAME_VALUES ) == -1 )
+        return;
+    msg_Dbg( obj, "removing plugins cache file %s", path );
+    vlc_unlink( path );
+    free( path );
+}
+
 /*****************************************************************************
  * LoadPluginsCache: loads the plugins cache file
  *****************************************************************************
@@ -76,50 +92,31 @@ static int    CacheLoadConfig  ( module_t *, FILE * );
  * actually load the dynamically loadable module.
  * This allows us to only fully load plugins when they are actually used.
  *****************************************************************************/
-void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
+void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, const char *dir )
 {
-    char *psz_filename, *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
+    char *psz_filename;
     FILE *file;
-    int i, j, i_size, i_read;
-    char p_cachestring[sizeof("cache " COPYRIGHT_MESSAGE)];
-    int i_cache;
-    module_cache_t **pp_cache = 0;
+    int i_size, i_read;
+    char p_cachestring[sizeof(CACHE_STRING)];
+    size_t i_cache;
+    module_cache_t **pp_cache = NULL;
     int32_t i_file_size, i_marker;
 
-    if( !psz_cachedir ) /* XXX: this should never happen */
-    {
-        msg_Err( p_this, "Unable to get cache directory" );
-        return;
-    }
+    assert( dir != NULL );
 
-    if( asprintf( &psz_filename, "%s"DIR_SEP CACHENAME_FORMAT,
-                  psz_cachedir, CACHENAME_VALUES ) == -1 )
-    {
-        free( psz_cachedir );
+    if( !p_bank->b_cache )
         return;
-    }
-    free( psz_cachedir );
 
-    if( b_delete )
-    {
-#if !defined( UNDER_CE )
-        unlink( psz_filename );
-#else
-        wchar_t psz_wf[MAX_PATH];
-        MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
-        DeleteFile( psz_wf );
-#endif
-        msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
-        free( psz_filename );
+    if( asprintf( &psz_filename, "%s"DIR_SEP CACHENAME_FORMAT,
+                  dir, CACHENAME_VALUES ) == -1 )
         return;
-    }
 
     msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
 
-    file = utf8_fopen( psz_filename, "rb" );
+    file = vlc_fopen( psz_filename, "rb" );
     if( !file )
     {
-        msg_Warn( p_this, "could not open plugins cache file %s for reading",
+        msg_Warn( p_this, "cannot read %s (%m)",
                   psz_filename );
         free( psz_filename );
         return;
@@ -147,10 +144,10 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
     fseek( file, sizeof(i_file_size), SEEK_SET );
 
     /* Check the file is a plugins cache */
-    i_size = sizeof("cache " COPYRIGHT_MESSAGE) - 1;
+    i_size = sizeof(CACHE_STRING) - 1;
     i_read = fread( p_cachestring, 1, i_size, file );
     if( i_read != i_size ||
-        memcmp( p_cachestring, "cache " COPYRIGHT_MESSAGE, i_size ) )
+        memcmp( p_cachestring, CACHE_STRING, i_size ) )
     {
         msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
         fclose( file );
@@ -192,7 +189,6 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
         return;
     }
 
-    p_bank->i_loaded_cache = 0;
     if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
     {
         msg_Warn( p_this, "This doesn't look like a valid plugins cache "
@@ -202,8 +198,18 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
     }
 
     if( i_cache )
-        pp_cache = p_bank->pp_loaded_cache =
-                   xmalloc( i_cache * sizeof(void *) );
+    {
+        size_t i_already = p_bank->i_loaded_cache;
+        pp_cache = realloc( p_bank->pp_loaded_cache,
+                            (i_already + i_cache) * sizeof(*pp_cache) );
+        if( unlikely(pp_cache == NULL) )
+            i_cache = 0; /* don't load */
+        else
+        {
+            p_bank->pp_loaded_cache = pp_cache;
+            pp_cache += i_already;
+        }
+   }
 
 #define LOAD_IMMEDIATE(a) \
     if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
@@ -227,22 +233,17 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
     } \
 }
 
-    for( i = 0; i < i_cache; i++ )
+    for( size_t i = 0; i < i_cache; i++ )
     {
         uint16_t i_size;
         int i_submodules;
 
         pp_cache[i] = xmalloc( sizeof(module_cache_t) );
-        p_bank->i_loaded_cache++;
 
         /* Load common info */
         LOAD_STRING( pp_cache[i]->psz_file );
         LOAD_IMMEDIATE( pp_cache[i]->i_time );
         LOAD_IMMEDIATE( pp_cache[i]->i_size );
-        LOAD_IMMEDIATE( pp_cache[i]->b_junk );
-        pp_cache[i]->b_used = false;
-
-        if( pp_cache[i]->b_junk ) continue;
 
         pp_cache[i]->p_module = vlc_module_create( p_this );
 
@@ -252,10 +253,20 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
         LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
         LOAD_STRING( pp_cache[i]->p_module->psz_longname );
         LOAD_STRING( pp_cache[i]->p_module->psz_help );
-        for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
+
+        LOAD_IMMEDIATE( pp_cache[i]->p_module->i_shortcuts );
+        if( pp_cache[i]->p_module->i_shortcuts > MODULE_SHORTCUT_MAX )
+            goto error;
+        else if( pp_cache[i]->p_module->i_shortcuts == 0 )
+            pp_cache[i]->p_module->pp_shortcuts = NULL;
+        else
         {
-            LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
+            pp_cache[i]->p_module->pp_shortcuts =
+                    xmalloc( sizeof( char ** ) * pp_cache[i]->p_module->i_shortcuts );
+            for( unsigned j = 0; j < pp_cache[i]->p_module->i_shortcuts; j++ )
+                LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] );
         }
+
         LOAD_STRING( pp_cache[i]->p_module->psz_capability );
         LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
         LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
@@ -266,6 +277,9 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
             goto error;
 
         LOAD_STRING( pp_cache[i]->p_module->psz_filename );
+        LOAD_STRING( pp_cache[i]->p_module->domain );
+        if( pp_cache[i]->p_module->domain != NULL )
+            vlc_bindtextdomain( pp_cache[i]->p_module->domain );
 
         LOAD_IMMEDIATE( i_submodules );
 
@@ -273,19 +287,31 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
         {
             module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
             free( p_module->psz_object_name );
+            free( p_module->pp_shortcuts );
             LOAD_STRING( p_module->psz_object_name );
             LOAD_STRING( p_module->psz_shortname );
             LOAD_STRING( p_module->psz_longname );
             LOAD_STRING( p_module->psz_help );
-            for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
+
+            LOAD_IMMEDIATE( p_module->i_shortcuts );
+            if( p_module->i_shortcuts > MODULE_SHORTCUT_MAX )
+                goto error;
+            else if( p_module->i_shortcuts == 0 )
+                p_module->pp_shortcuts = NULL;
+            else
             {
-                LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
+                p_module->pp_shortcuts = xmalloc( sizeof( char ** ) * p_module->i_shortcuts );
+                for( unsigned j = 0; j < p_module->i_shortcuts; j++ )
+                    LOAD_STRING( p_module->pp_shortcuts[j] );
             }
+
             LOAD_STRING( p_module->psz_capability );
             LOAD_IMMEDIATE( p_module->i_score );
             LOAD_IMMEDIATE( p_module->b_unloadable );
+            LOAD_STRING( p_module->domain );
         }
     }
+    p_bank->i_loaded_cache += i_cache;
 
     fclose( file );
     return;
@@ -295,8 +321,6 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
     msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
 
     /* TODO: cleanup */
-    p_bank->i_loaded_cache = 0;
-
     fclose( file );
     return;
 }
@@ -431,63 +455,62 @@ static int CacheLoadConfig( module_t *p_module, FILE *file )
     return VLC_EGENERIC;
 }
 
-static int CacheSaveBank( FILE *file, module_bank_t *p_bank );
+static int CacheSaveBank( FILE *file, module_cache_t *const *, size_t );
 
 /*****************************************************************************
  * SavePluginsCache: saves the plugins cache to a file
  *****************************************************************************/
-void CacheSave( vlc_object_t *p_this, module_bank_t *p_bank )
+void CacheSave (vlc_object_t *p_this, const char *dir,
+                module_cache_t *const *pp_cache, size_t n)
 {
-    char *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
-    if( !psz_cachedir ) /* XXX: this should never happen */
+    char *filename, *tmpname;
+
+    if (asprintf (&filename, "%s"DIR_SEP CACHENAME_FORMAT, dir,
+                  CACHENAME_VALUES ) == -1)
+        return;
+
+    if (asprintf (&tmpname, "%s.%"PRIu32, filename, (uint32_t)getpid ()) == -1)
     {
-        msg_Err( p_this, "unable to get cache directory" );
+        free (filename);
         return;
     }
+    msg_Dbg (p_this, "saving plugins cache %s", filename);
 
-    char psz_filename[sizeof(DIR_SEP) + 32 + strlen(psz_cachedir)];
-    config_CreateDir( p_this, psz_cachedir );
-
-    snprintf( psz_filename, sizeof( psz_filename ),
-              "%s"DIR_SEP CACHENAME_FORMAT, psz_cachedir,
-              CACHENAME_VALUES );
-    free( psz_cachedir );
-
-    char psz_tmpname[sizeof (psz_filename) + 12];
-    snprintf (psz_tmpname, sizeof (psz_tmpname), "%s.%"PRIu32, psz_filename,
-              (uint32_t)getpid ());
-    FILE *file = utf8_fopen( psz_tmpname, "wb" );
+    FILE *file = vlc_fopen (tmpname, "wb");
     if (file == NULL)
-        goto error;
+    {
+        if (errno != EACCES && errno != ENOENT)
+            msg_Warn (p_this, "cannot create %s (%m)", tmpname);
+        goto out;
+    }
 
-    msg_Dbg (p_this, "writing plugins cache %s", psz_filename);
-    if (CacheSaveBank (file, p_bank))
-        goto error;
+    if (CacheSaveBank (file, pp_cache, n))
+    {
+        msg_Warn (p_this, "cannot write %s (%m)", tmpname);
+        clearerr (file);
+        fclose (file);
+        vlc_unlink (tmpname);
+        goto out;
+    }
 
 #ifndef WIN32
-    utf8_rename (psz_tmpname, psz_filename); /* atomically replace old cache */
+    vlc_rename (tmpname, filename); /* atomically replace old cache */
     fclose (file);
 #else
-    utf8_unlink (psz_filename);
+    vlc_unlink (filename);
     fclose (file);
-    utf8_rename (psz_tmpname, psz_filename);
+    vlc_rename (tmpname, filename);
 #endif
-    return; /* success! */
-
-error:
-    msg_Warn (p_this, "could not write plugins cache %s (%m)",
-              psz_filename);
-    if (file != NULL)
-    {
-        clearerr (file);
-        fclose (file);
-    }
+out:
+    free (filename);
+    free (tmpname);
 }
 
-static int CacheSaveConfig (FILE *, module_t *);
-static int CacheSaveSubmodule (FILE *, module_t *);
+static int CacheSaveConfig (FILE *, const module_t *);
+static int CacheSaveSubmodule (FILE *, const module_t *);
 
-static int CacheSaveBank (FILE *file, module_bank_t *p_bank)
+static int CacheSaveBank (FILE *file, module_cache_t *const *pp_cache,
+                          size_t i_cache)
 {
     uint32_t i_file_size = 0;
 
@@ -496,7 +519,7 @@ static int CacheSaveBank (FILE *file, module_bank_t *p_bank)
         goto error;
 
     /* Contains version number */
-    if (fputs ("cache "COPYRIGHT_MESSAGE, file) == EOF)
+    if (fputs (CACHE_STRING, file) == EOF)
         goto error;
 #ifdef DISTRO_VERSION
     /* Allow binary maintaner to pass a string to detect new binary version*/
@@ -514,9 +537,6 @@ static int CacheSaveBank (FILE *file, module_bank_t *p_bank)
     if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
         goto error;
 
-    module_cache_t **pp_cache = p_bank->pp_cache;
-    uint32_t i_cache = p_bank->i_cache;
-
     if (fwrite( &i_cache, sizeof (i_cache), 1, file) != 1)
         goto error;
 
@@ -539,19 +559,16 @@ static int CacheSaveBank (FILE *file, module_bank_t *p_bank)
         SAVE_STRING( pp_cache[i]->psz_file );
         SAVE_IMMEDIATE( pp_cache[i]->i_time );
         SAVE_IMMEDIATE( pp_cache[i]->i_size );
-        SAVE_IMMEDIATE( pp_cache[i]->b_junk );
-
-        if( pp_cache[i]->b_junk ) continue;
 
         /* Save additional infos */
         SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
         SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
         SAVE_STRING( pp_cache[i]->p_module->psz_longname );
         SAVE_STRING( pp_cache[i]->p_module->psz_help );
-        for (unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++)
-        {
-            SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
-        }
+        SAVE_IMMEDIATE( pp_cache[i]->p_module->i_shortcuts );
+        for (unsigned j = 0; j < pp_cache[i]->p_module->i_shortcuts; j++)
+            SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] );
+
         SAVE_STRING( pp_cache[i]->p_module->psz_capability );
         SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
         SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
@@ -562,6 +579,7 @@ static int CacheSaveBank (FILE *file, module_bank_t *p_bank)
             goto error;
 
         SAVE_STRING( pp_cache[i]->p_module->psz_filename );
+        SAVE_STRING( pp_cache[i]->p_module->domain );
 
         i_submodule = pp_cache[i]->p_module->submodule_count;
         SAVE_IMMEDIATE( i_submodule );
@@ -581,7 +599,7 @@ error:
     return -1;
 }
 
-static int CacheSaveSubmodule( FILE *file, module_t *p_module )
+static int CacheSaveSubmodule( FILE *file, const module_t *p_module )
 {
     if( !p_module )
         return 0;
@@ -592,12 +610,14 @@ static int CacheSaveSubmodule( FILE *file, module_t *p_module )
     SAVE_STRING( p_module->psz_shortname );
     SAVE_STRING( p_module->psz_longname );
     SAVE_STRING( p_module->psz_help );
-    for( unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++ )
-         SAVE_STRING( p_module->pp_shortcuts[j] ); // FIXME
+    SAVE_IMMEDIATE( p_module->i_shortcuts );
+    for( unsigned j = 0; j < p_module->i_shortcuts; j++ )
+         SAVE_STRING( p_module->pp_shortcuts[j] );
 
     SAVE_STRING( p_module->psz_capability );
     SAVE_IMMEDIATE( p_module->i_score );
     SAVE_IMMEDIATE( p_module->b_unloadable );
+    SAVE_STRING( p_module->domain );
     return 0;
 
 error:
@@ -605,7 +625,7 @@ error:
 }
 
 
-static int CacheSaveConfig (FILE *file, module_t *p_module)
+static int CacheSaveConfig (FILE *file, const module_t *p_module)
 {
     uint32_t i_lines = p_module->confsize;