cache.c 24 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/*****************************************************************************
 * cache.c: Plugins cache
 *****************************************************************************
 * Copyright (C) 2001-2007 the VideoLAN team
 * $Id$
 *
 * Authors: Sam Hocevar <sam@zoy.org>
 *          Ethan C. Baldridge <BaldridgeE@cadmus.com>
 *          Hans-Peter Jansen <hpj@urpla.net>
 *          Gildas Bazin <gbazin@videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

27
28
29
30
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

31
#include <vlc_common.h>
32
33
34
35
36
#include "libvlc.h"

#include <stdlib.h>                                      /* free(), strtol() */
#include <stdio.h>                                              /* sprintf() */
#include <string.h>                                              /* strdup() */
37
#include <vlc_plugin.h>
38
#include <vlc_cpu.h>
39

40
#include <sys/types.h>
41
42
43
#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#endif
44
#include <assert.h>
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

#if !defined(HAVE_DYNAMIC_PLUGINS)
    /* no support for plugins */
#elif defined(HAVE_DL_DYLD)
#   if defined(HAVE_MACH_O_DYLD_H)
#       include <mach-o/dyld.h>
#   endif
#elif defined(HAVE_DL_BEOS)
#   if defined(HAVE_IMAGE_H)
#       include <image.h>
#   endif
#elif defined(HAVE_DL_WINDOWS)
#   include <windows.h>
#elif defined(HAVE_DL_DLOPEN)
#   if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
#       include <dlfcn.h>
#   endif
#   if defined(HAVE_SYS_DL_H)
#       include <sys/dl.h>
#   endif
#elif defined(HAVE_DL_SHL_LOAD)
#   if defined(HAVE_DL_H)
#       include <dl.h>
#   endif
#endif

71
#include "config/configuration.h"
72
73
74
75
76
77
78
79
80
81
82

#include "vlc_charset.h"

#include "modules/modules.h"


/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
#ifdef HAVE_DYNAMIC_PLUGINS
static int    CacheLoadConfig  ( module_t *, FILE * );
83
static int    CacheSaveConfig  ( module_t *, FILE * );
84
85
86

/* Sub-version number
 * (only used to avoid breakage in dev version when cache structure changes) */
87
#define CACHE_SUBVERSION_NUM 8
88

89
90
/* Format string for the cache filename */
#define CACHENAME_FORMAT \
91
    "plugins-%.2zx%.2zx%.2"PRIx8"-%x.dat"
92
93
/* Magic for the cache filename */
#define CACHENAME_VALUES \
94
    sizeof(int), sizeof(void *), *(uint8_t *)&(uint16_t){ 0xbe1e }, vlc_CPU()
95
96


97
98
99
100
101
102
103
104
/*****************************************************************************
 * LoadPluginsCache: loads the plugins cache file
 *****************************************************************************
 * This function will load the plugin cache if present and valid. This cache
 * will in turn be queried by AllocateAllPlugins() to see if it needs to
 * actually load the dynamically loadable module.
 * This allows us to only fully load plugins when they are actually used.
 *****************************************************************************/
105
void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
106
{
107
    char *psz_filename, *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
108
109
110
111
112
113
114
115
116
117
118
119
120
    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;
    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;
    }

121
122
    if( asprintf( &psz_filename, "%s"DIR_SEP CACHENAME_FORMAT,
                  psz_cachedir, CACHENAME_VALUES ) == -1 )
123
    {
124
        free( psz_cachedir );
125
126
        return;
    }
127
    free( psz_cachedir );
128

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
129
    if( b_delete )
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
    {
#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 );
        return;
    }

    msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );

    file = utf8_fopen( psz_filename, "rb" );
    if( !file )
    {
        msg_Warn( p_this, "could not open plugins cache file %s for reading",
                  psz_filename );
        free( psz_filename );
        return;
    }
    free( psz_filename );

    /* Check the file size */
    i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
    if( i_read != sizeof(i_file_size) )
    {
        msg_Warn( p_this, "This doesn't look like a valid plugins cache "
                  "(too short)" );
        fclose( file );
        return;
    }

    fseek( file, 0, SEEK_END );
    if( ftell( file ) != i_file_size )
    {
        msg_Warn( p_this, "This doesn't look like a valid plugins cache "
                  "(corrupted size)" );
        fclose( file );
        return;
    }
    fseek( file, sizeof(i_file_size), SEEK_SET );

    /* Check the file is a plugins cache */
    i_size = sizeof("cache " COPYRIGHT_MESSAGE) - 1;
    i_read = fread( p_cachestring, 1, i_size, file );
    if( i_read != i_size ||
        memcmp( p_cachestring, "cache " COPYRIGHT_MESSAGE, i_size ) )
    {
        msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
        fclose( file );
        return;
    }

186
187
188
189
190
191
192
193
194
195
196
197
198
199
#ifdef DISTRO_VERSION
    /* Check for distribution specific version */
    char p_distrostring[sizeof( DISTRO_VERSION )];
    i_size = sizeof( DISTRO_VERSION ) - 1;
    i_read = fread( p_distrostring, 1, i_size, file );
    if( i_read != i_size ||
        memcmp( p_distrostring, DISTRO_VERSION, i_size ) )
    {
        msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
        fclose( file );
        return;
    }
#endif

200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
    /* Check Sub-version number */
    i_read = fread( &i_marker, 1, sizeof(i_marker), file );
    if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
    {
        msg_Warn( p_this, "This doesn't look like a valid plugins cache "
                  "(corrupted header)" );
        fclose( file );
        return;
    }

    /* Check header marker */
    i_read = fread( &i_marker, 1, sizeof(i_marker), file );
    if( i_read != sizeof(i_marker) ||
        i_marker != ftell( file ) - (int)sizeof(i_marker) )
    {
        msg_Warn( p_this, "This doesn't look like a valid plugins cache "
                  "(corrupted header)" );
        fclose( file );
        return;
    }

221
    p_bank->i_loaded_cache = 0;
222
223
224
225
226
227
228
229
230
    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 "
                  "(file too short)" );
        fclose( file );
        return;
    }

    if( i_cache )
231
        pp_cache = p_bank->pp_loaded_cache =
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
232
                   xmalloc( i_cache * sizeof(void *) );
233
234
235
236
237
238
239
240
241
242

#define LOAD_IMMEDIATE(a) \
    if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
#define LOAD_STRING(a) \
{ \
    a = NULL; \
    if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
     || ( i_size > 16384 ) ) \
        goto error; \
    if( i_size ) { \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
243
        char *psz = xmalloc( i_size ); \
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
        if( fread( psz, i_size, 1, file ) != 1 ) { \
            free( psz ); \
            goto error; \
        } \
        if( psz[i_size-1] ) { \
            free( psz ); \
            goto error; \
        } \
        a = psz; \
    } \
}

    for( i = 0; i < i_cache; i++ )
    {
        uint16_t i_size;
        int i_submodules;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
261
        pp_cache[i] = xmalloc( sizeof(module_cache_t) );
262
        p_bank->i_loaded_cache++;
263
264
265
266
267
268

        /* 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 );
269
        pp_cache[i]->b_used = false;
270
271
272
273
274
275

        if( pp_cache[i]->b_junk ) continue;

        pp_cache[i]->p_module = vlc_module_create( p_this );

        /* Load additional infos */
276
        free( pp_cache[i]->p_module->psz_object_name );
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
        LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
        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_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
        }
        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 );
        LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );

        /* Config stuff */
        if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
            goto error;

        LOAD_STRING( pp_cache[i]->p_module->psz_filename );

        LOAD_IMMEDIATE( i_submodules );

        while( i_submodules-- )
        {
            module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
Rafaël Carré's avatar
Rafaël Carré committed
301
            free( p_module->psz_object_name );
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
            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_STRING( p_module->pp_shortcuts[j] ); // FIX
            }
            LOAD_STRING( p_module->psz_capability );
            LOAD_IMMEDIATE( p_module->i_score );
            LOAD_IMMEDIATE( p_module->b_unloadable );
        }
    }

    fclose( file );
    return;

 error:

    msg_Warn( p_this, "plugins cache not loaded (corrupted)" );

    /* TODO: cleanup */
324
    p_bank->i_loaded_cache = 0;
325
326
327
328
329
330

    fclose( file );
    return;
}


331
332
333
334
335
336
337
338
339
340
/* This function should never be called.
 * It is only used as a non-NULL vlc_callback_t value for comparison. */
static int dummy_callback (vlc_object_t *obj, const char *name,
                           vlc_value_t oldval, vlc_value_t newval, void *data)
{
    (void) obj; (void)name; (void)oldval; (void)newval; (void)data;
    assert (0);
}


341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
static int CacheLoadConfig( module_t *p_module, FILE *file )
{
    uint32_t i_lines;
    uint16_t i_size;

    /* Calculate the structure length */
    LOAD_IMMEDIATE( p_module->i_config_items );
    LOAD_IMMEDIATE( p_module->i_bool_items );

    LOAD_IMMEDIATE( i_lines );

    /* Allocate memory */
    if (i_lines)
    {
        p_module->p_config =
            (module_config_t *)calloc( i_lines, sizeof(module_config_t) );
        if( p_module->p_config == NULL )
        {
            p_module->confsize = 0;
            return VLC_ENOMEM;
        }
    }
    p_module->confsize = i_lines;

    /* Do the duplication job */
    for (size_t i = 0; i < i_lines; i++ )
    {
        LOAD_IMMEDIATE( p_module->p_config[i] );

        LOAD_STRING( p_module->p_config[i].psz_type );
        LOAD_STRING( p_module->p_config[i].psz_name );
        LOAD_STRING( p_module->p_config[i].psz_text );
        LOAD_STRING( p_module->p_config[i].psz_longtext );
374
375
        LOAD_STRING( p_module->p_config[i].psz_oldname );
        LOAD_IMMEDIATE( p_module->p_config[i].b_removed );
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392

        if (IsConfigStringType (p_module->p_config[i].i_type))
        {
            LOAD_STRING (p_module->p_config[i].orig.psz);
            p_module->p_config[i].value.psz =
                    (p_module->p_config[i].orig.psz != NULL)
                        ? strdup (p_module->p_config[i].orig.psz) : NULL;
            p_module->p_config[i].saved.psz = NULL;
        }
        else
        {
            memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
                    sizeof (p_module->p_config[i].value));
            memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
                    sizeof (p_module->p_config[i].saved));
        }

393
        p_module->p_config[i].b_dirty = false;
394

395
        p_module->p_config[i].p_lock = &p_module->lock;
396
397
398
399
400
401
402

        if( p_module->p_config[i].i_list )
        {
            if( p_module->p_config[i].ppsz_list )
            {
                int j;
                p_module->p_config[i].ppsz_list =
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
403
                    xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
404
405
406
407
408
409
410
411
412
413
414
                if( p_module->p_config[i].ppsz_list )
                {
                    for( j = 0; j < p_module->p_config[i].i_list; j++ )
                        LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
                    p_module->p_config[i].ppsz_list[j] = NULL;
                }
            }
            if( p_module->p_config[i].ppsz_list_text )
            {
                int j;
                p_module->p_config[i].ppsz_list_text =
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
415
                    xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
416
417
418
419
420
421
422
423
424
425
                if( p_module->p_config[i].ppsz_list_text )
                {
                  for( j = 0; j < p_module->p_config[i].i_list; j++ )
                      LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
                  p_module->p_config[i].ppsz_list_text[j] = NULL;
                }
            }
            if( p_module->p_config[i].pi_list )
            {
                p_module->p_config[i].pi_list =
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
426
                    xmalloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
427
428
429
430
431
432
433
434
435
436
437
                if( p_module->p_config[i].pi_list )
                {
                    for (int j = 0; j < p_module->p_config[i].i_list; j++)
                        LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
                }
            }
        }

        if( p_module->p_config[i].i_action )
        {
            p_module->p_config[i].ppf_action =
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
438
                xmalloc( p_module->p_config[i].i_action * sizeof(void *) );
439
            p_module->p_config[i].ppsz_action_text =
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
440
                xmalloc( p_module->p_config[i].i_action * sizeof(char *) );
441
442
443
444
445
446
447
448

            for (int j = 0; j < p_module->p_config[i].i_action; j++)
            {
                p_module->p_config[i].ppf_action[j] = 0;
                LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
            }
        }

449
450
451
452
        bool has_callback;
        LOAD_IMMEDIATE( has_callback );
        if (has_callback)
            p_module->p_config[i].pf_callback = dummy_callback;
453
454
455
456
457
458
459
460
461
    }

    return VLC_SUCCESS;

 error:

    return VLC_EGENERIC;
}

462
463
static int CacheSaveSubmodule( FILE *file, module_t *p_module );

464
465
466
/*****************************************************************************
 * SavePluginsCache: saves the plugins cache to a file
 *****************************************************************************/
467
void CacheSave( vlc_object_t *p_this, module_bank_t *p_bank )
468
469
470
471
472
473
474
{
    static char const psz_tag[] =
        "Signature: 8a477f597d28d172789f06886806bc55\r\n"
        "# This file is a cache directory tag created by VLC.\r\n"
        "# For information about cache directory tags, see:\r\n"
        "#   http://www.brynosaurus.com/cachedir/\r\n";

475
    char *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
476
477
478
    FILE *file;
    int i, j, i_cache;
    module_cache_t **pp_cache;
479
    uint32_t i_file_size = 0;
480
481
482

    if( !psz_cachedir ) /* XXX: this should never happen */
    {
483
        msg_Err( p_this, "unable to get cache directory" );
484
485
486
487
488
489
490
491
492
        return;
    }

    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"CACHEDIR.TAG", psz_cachedir );
    file = utf8_fopen( psz_filename, "wb" );
493
    if (file != NULL)
494
    {
495
496
        if (fwrite (psz_tag, 1, sizeof (psz_tag) - 1, file) != 1)
            clearerr (file); /* what else can we do? */
497
498
499
500
        fclose( file );
    }

    snprintf( psz_filename, sizeof( psz_filename ),
501
502
              "%s"DIR_SEP CACHENAME_FORMAT, psz_cachedir,
              CACHENAME_VALUES );
503
    free( psz_cachedir );
504
    msg_Dbg( p_this, "writing plugins cache %s", psz_filename );
505

506
507
    char psz_tmpname[sizeof (psz_filename) + 12];
    snprintf (psz_tmpname, sizeof (psz_tmpname), "%s.%"PRIu32, psz_filename,
508
              (uint32_t)getpid ());
509
    file = utf8_fopen( psz_tmpname, "wb" );
510
511
    if (file == NULL)
        goto error;
512
513

    /* Empty space for file size */
514
515
    if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
        goto error;
516
517

    /* Contains version number */
518
519
    if (fputs ("cache "COPYRIGHT_MESSAGE, file) == EOF)
        goto error;
520
521
522
523
524
#ifdef DISTRO_VERSION
    /* Allow binary maintaner to pass a string to detect new binary version*/
    if (fputs( DISTRO_VERSION, file ) == EOF)
        goto error;
#endif
525
526
527
    /* Sub-version number (to avoid breakage in the dev version when cache
     * structure changes) */
    i_file_size = CACHE_SUBVERSION_NUM;
528
529
    if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1 )
        goto error;
530
531
532

    /* Header marker */
    i_file_size = ftell( file );
533
534
    if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
        goto error;
535

536
537
    i_cache = p_bank->i_cache;
    pp_cache = p_bank->pp_cache;
538

539
540
541
542
543
544
545
546
547
548
549
550
    if (fwrite( &i_cache, sizeof (i_cache), 1, file) != 1)
        goto error;

#define SAVE_IMMEDIATE( a ) \
    if (fwrite (&a, sizeof(a), 1, file) != 1) \
        goto error
#define SAVE_STRING( a ) \
    { \
        uint16_t i_size = (a != NULL) ? (strlen (a) + 1) : 0; \
        if ((fwrite (&i_size, sizeof (i_size), 1, file) != 1) \
         || (a && (fwrite (a, 1, i_size, file) != i_size))) \
            goto error; \
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
    } while(0)

    for( i = 0; i < i_cache; i++ )
    {
        uint32_t i_submodule;

        /* Save common info */
        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( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
        {
            SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
        }
        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 );
        SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );

        /* Config stuff */
580
581
        if (CacheSaveConfig (pp_cache[i]->p_module, file))
            goto error;
582
583
584

        SAVE_STRING( pp_cache[i]->p_module->psz_filename );

585
        i_submodule = pp_cache[i]->p_module->submodule_count;
586
        SAVE_IMMEDIATE( i_submodule );
587
588
        if( CacheSaveSubmodule( file, pp_cache[i]->p_module->submodule ) )
            goto error;
589
590
591
592
593
    }

    /* Fill-up file size */
    i_file_size = ftell( file );
    fseek( file, 0, SEEK_SET );
594
595
    if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1
     || fflush (file)) /* flush libc buffers */
596
        goto error;
597

598
#ifndef WIN32
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
599
    utf8_rename (psz_tmpname, psz_filename); /* atomically replace old cache */
600
601
    fclose (file);
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
602
    utf8_unlink (psz_filename);
603
    fclose (file);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
604
    utf8_rename (psz_tmpname, psz_filename);
605
606
#endif
    return; /* success! */
607
608
609
610
611
612
613
614
615

error:
    msg_Warn (p_this, "could not write plugins cache %s (%m)",
              psz_filename);
    if (file != NULL)
    {
        clearerr (file);
        fclose (file);
    }
616
617
}

618
619
static int CacheSaveSubmodule( FILE *file, module_t *p_module )
{
620
621
622
    if( !p_module )
        return 0;
    if( CacheSaveSubmodule( file, p_module->next ) )
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
        goto error;

    SAVE_STRING( p_module->psz_object_name );
    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_STRING( p_module->psz_capability );
    SAVE_IMMEDIATE( p_module->i_score );
    SAVE_IMMEDIATE( p_module->b_unloadable );
    return 0;

error:
    return -1;
}


642
static int CacheSaveConfig( module_t *p_module, FILE *file )
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
{
    uint32_t i_lines = p_module->confsize;

    SAVE_IMMEDIATE( p_module->i_config_items );
    SAVE_IMMEDIATE( p_module->i_bool_items );
    SAVE_IMMEDIATE( i_lines );

    for (size_t i = 0; i < i_lines ; i++)
    {
        SAVE_IMMEDIATE( p_module->p_config[i] );

        SAVE_STRING( p_module->p_config[i].psz_type );
        SAVE_STRING( p_module->p_config[i].psz_name );
        SAVE_STRING( p_module->p_config[i].psz_text );
        SAVE_STRING( p_module->p_config[i].psz_longtext );
658
659
660
        SAVE_STRING( p_module->p_config[i].psz_oldname );
        SAVE_IMMEDIATE( p_module->p_config[i].b_removed );

661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
        if (IsConfigStringType (p_module->p_config[i].i_type))
            SAVE_STRING( p_module->p_config[i].orig.psz );

        if( p_module->p_config[i].i_list )
        {
            if( p_module->p_config[i].ppsz_list )
            {
                for (int j = 0; j < p_module->p_config[i].i_list; j++)
                    SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
            }

            if( p_module->p_config[i].ppsz_list_text )
            {
                for (int j = 0; j < p_module->p_config[i].i_list; j++)
                    SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
            }
            if( p_module->p_config[i].pi_list )
            {
                for (int j = 0; j < p_module->p_config[i].i_list; j++)
                    SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
            }
        }

        for (int j = 0; j < p_module->p_config[i].i_action; j++)
            SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );

687
688
        bool has_callback = p_module->p_config[i].pf_callback != NULL;
        SAVE_IMMEDIATE( has_callback );
689
    }
690
691
692
693
    return 0;

error:
    return -1;
694
695
696
697
698
699
700
701
702
703
704
705
706
}

/*****************************************************************************
 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
 *****************************************************************************/
void CacheMerge( vlc_object_t *p_this, module_t *p_cache, module_t *p_module )
{
    (void)p_this;

    p_cache->pf_activate = p_module->pf_activate;
    p_cache->pf_deactivate = p_module->pf_deactivate;
    p_cache->handle = p_module->handle;

707
708
709
710
711
712
    /* FIXME: This looks too simplistic an algorithm to me. What if the module
     * file was altered such that the number of order of submodules was
     * altered... after VLC started -- Courmisch, 09/2008 */
    module_t *p_child = p_module->submodule,
             *p_cchild = p_cache->submodule;
    while( p_child && p_cchild )
713
714
715
    {
        p_cchild->pf_activate = p_child->pf_activate;
        p_cchild->pf_deactivate = p_child->pf_deactivate;
716
717
        p_child = p_child->next;
        p_cchild = p_cchild->next;
718
719
    }

720
721
    p_cache->b_loaded = true;
    p_module->b_loaded = false;
722
723
724
725
726
}

/*****************************************************************************
 * CacheFind: finds the cache entry corresponding to a file
 *****************************************************************************/
727
module_cache_t *CacheFind( module_bank_t *p_bank, const char *psz_file,
728
729
730
731
732
                           int64_t i_time, int64_t i_size )
{
    module_cache_t **pp_cache;
    int i_cache, i;

733
734
    pp_cache = p_bank->pp_loaded_cache;
    i_cache = p_bank->i_loaded_cache;
735
736
737
738
739
740
741
742
743
744
745
746

    for( i = 0; i < i_cache; i++ )
    {
        if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
            pp_cache[i]->i_time == i_time &&
            pp_cache[i]->i_size == i_size ) return pp_cache[i];
    }

    return NULL;
}

#endif /* HAVE_DYNAMIC_PLUGINS */