git.sesse.net Git - vlc/blob - modules/gui/skins2/src/theme_loader.cpp

   1 /*****************************************************************************
   2  * theme_loader.cpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *          Olivier Teulière <ipkiss@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #include "theme_loader.hpp"
  26 #include "theme.hpp"
  27 #include "../parser/builder.hpp"
  28 #include "../parser/skin_parser.hpp"
  29 #include "../src/os_factory.hpp"
  30 #include "../src/vlcproc.hpp"
  31 #include "../src/window_manager.hpp"
  32
  33 #include <cctype>
  34
  35 #ifdef HAVE_FCNTL_H
  36 #   include <fcntl.h>
  37 #endif
  38 #ifdef HAVE_SYS_STAT_H
  39 #   include <sys/stat.h>
  40 #endif
  41 #ifdef HAVE_UNISTD_H
  42 #   include <unistd.h>
  43 #elif defined( WIN32 ) && !defined( UNDER_CE )
  44 #   include <direct.h>
  45 #endif
  46
  47 #ifdef HAVE_DIRENT_H
  48 #   include <dirent.h>
  49 #endif
  50
  51
  52 #if defined( HAVE_ZLIB_H )
  53 #   include <zlib.h>
  54 #   include <errno.h>
  55 int gzopen_frontend ( const char *pathname, int oflags, int mode );
  56 int gzclose_frontend( int );
  57 int gzread_frontend ( int, void *, size_t );
  58 int gzwrite_frontend( int, const void *, size_t );
  59 #if defined( HAVE_LIBTAR_H )
  60 #   include <libtar.h>
  61 #else
  62 typedef gzFile TAR;
  63 int tar_open        ( TAR **t, char *pathname, int oflags );
  64 int tar_extract_all ( TAR *t, char *prefix );
  65 int tar_close       ( TAR *t );
  66 int getoct( char *p, int width );
  67 #endif
  68 int makedir( const char *newdir );
  69 #endif
  70
  71 #define DEFAULT_XML_FILE "theme.xml"
  72 #define WINAMP2_XML_FILE "winamp2.xml"
  73 #define ZIP_BUFFER_SIZE 4096
  74
  75
  76 bool ThemeLoader::load( const string &fileName )
  77 {
  78     string path = getFilePath( fileName );
  79
  80     //Before all, let's see if the file is present
  81     struct stat p_stat;
  82     if( utf8_stat( path.c_str(), &p_stat ) )
  83         return false;
  84
  85     // First, we try to un-targz the file, and if it fails we hope it's a XML
  86     // file...
  87
  88 #if defined( HAVE_ZLIB_H )
  89     if( ! extract( sToLocale( fileName ) ) && ! parse( path, fileName ) )
  90         return false;
  91 #else
  92     if( ! parse( path, fileName ) )
  93         return false;
  94 #endif
  95
  96     Theme *pNewTheme = getIntf()->p_sys->p_theme;
  97     if( !pNewTheme )
  98     {
  99         return false;
 100     }
 101
 102     // Check if the skin to load is in the config file, to load its config
 103     char *skin_last = config_GetPsz( getIntf(), "skins2-last" );
 104     if( skin_last != NULL && fileName == (string)skin_last )
 105     {
 106         // Restore the theme configuration
 107         getIntf()->p_sys->p_theme->loadConfig();
 108         // Used to anchor the windows at the beginning
 109         pNewTheme->getWindowManager().stopMove();
 110     }
 111     else
 112     {
 113         config_PutPsz( getIntf(), "skins2-last", fileName.c_str() );
 114         // Show the windows
 115         pNewTheme->getWindowManager().showAll( true );
 116     }
 117     free( skin_last );
 118
 119     return true;
 120 }
 121
 122
 123 #if defined( HAVE_ZLIB_H )
 124 bool ThemeLoader::extractTarGz( const string &tarFile, const string &rootDir )
 125 {
 126     TAR *t;
 127 #if defined( HAVE_LIBTAR_H )
 128     tartype_t gztype = { (openfunc_t) gzopen_frontend,
 129                          (closefunc_t) gzclose_frontend,
 130                          (readfunc_t) gzread_frontend,
 131                          (writefunc_t) gzwrite_frontend };
 132
 133     if( tar_open( &t, (char *)tarFile.c_str(), &gztype, O_RDONLY, 0,
 134                   TAR_GNU ) == -1 )
 135 #else
 136     if( tar_open( &t, (char *)tarFile.c_str(), O_RDONLY ) == -1 )
 137 #endif
 138     {
 139         return false;
 140     }
 141
 142     if( tar_extract_all( t, (char *)rootDir.c_str() ) != 0 )
 143     {
 144         tar_close( t );
 145         return false;
 146     }
 147
 148     if( tar_close( t ) != 0 )
 149     {
 150         return false;
 151     }
 152
 153     return true;
 154 }
 155
 156
 157 bool ThemeLoader::extractZip( const string &zipFile, const string &rootDir )
 158 {
 159     // Try to open the ZIP file
 160     unzFile file = unzOpen( zipFile.c_str() );
 161     unz_global_info info;
 162
 163     if( unzGetGlobalInfo( file, &info ) != UNZ_OK )
 164     {
 165         return false;
 166     }
 167     // Extract all the files in the archive
 168     for( unsigned long i = 0; i < info.number_entry; i++ )
 169     {
 170         if( !extractFileInZip( file, rootDir ) )
 171         {
 172             msg_Warn( getIntf(), "error while unzipping %s",
 173                       zipFile.c_str() );
 174             unzClose( file );
 175             return false;
 176         }
 177
 178         if( i < info.number_entry - 1 )
 179         {
 180             // Go the next file in the archive
 181             if( unzGoToNextFile( file ) !=UNZ_OK )
 182             {
 183                 msg_Warn( getIntf(), "error while unzipping %s",
 184                           zipFile.c_str() );
 185                 unzClose( file );
 186                 return false;
 187             }
 188         }
 189     }
 190     unzClose( file );
 191     return true;
 192 }
 193
 194
 195 bool ThemeLoader::extractFileInZip( unzFile file, const string &rootDir )
 196 {
 197     // Read info for the current file
 198     char filenameInZip[256];
 199     unz_file_info fileInfo;
 200     if( unzGetCurrentFileInfo( file, &fileInfo, filenameInZip,
 201                                sizeof( filenameInZip), NULL, 0, NULL, 0 )
 202         != UNZ_OK )
 203     {
 204         return false;
 205     }
 206
 207     // Convert the file name to lower case, because some winamp skins
 208     // use the wrong case...
 209     for( size_t i=0; i< strlen( filenameInZip ); i++)
 210     {
 211         filenameInZip[i] = tolower( filenameInZip[i] );
 212     }
 213
 214     // Allocate the buffer
 215     void *pBuffer = malloc( ZIP_BUFFER_SIZE );
 216     if( !pBuffer )
 217         return false;
 218
 219     // Get the path of the file
 220     OSFactory *pOsFactory = OSFactory::instance( getIntf() );
 221     string fullPath = rootDir
 222         + pOsFactory->getDirSeparator()
 223         + fixDirSeparators( filenameInZip );
 224     string basePath = getFilePath( fullPath );
 225
 226     // Extract the file if is not a directory
 227     if( basePath != fullPath )
 228     {
 229         if( unzOpenCurrentFile( file ) )
 230         {
 231             free( pBuffer );
 232             return false;
 233         }
 234         makedir( basePath.c_str() );
 235         FILE *fout = fopen( fullPath.c_str(), "wb" );
 236         if( fout == NULL )
 237         {
 238             msg_Err( getIntf(), "error opening %s", fullPath.c_str() );
 239             free( pBuffer );
 240             return false;
 241         }
 242
 243         // Extract the current file
 244         int n;
 245         do
 246         {
 247             n = unzReadCurrentFile( file, pBuffer, ZIP_BUFFER_SIZE );
 248             if( n < 0 )
 249             {
 250                 msg_Err( getIntf(), "error while reading zip file" );
 251                 free( pBuffer );
 252                 return false;
 253             }
 254             else if( n > 0 )
 255             {
 256                 if( fwrite( pBuffer, n , 1, fout) != 1 )
 257                 {
 258                     msg_Err( getIntf(), "error while writing %s",
 259                              fullPath.c_str() );
 260                     free( pBuffer );
 261                     return false;
 262                 }
 263             }
 264         } while( n > 0 );
 265
 266         fclose(fout);
 267
 268         if( unzCloseCurrentFile( file ) != UNZ_OK )
 269         {
 270             free( pBuffer );
 271             return false;
 272         }
 273     }
 274
 275     free( pBuffer );
 276     return true;
 277 }
 278
 279
 280 bool ThemeLoader::extract( const string &fileName )
 281 {
 282     bool result = true;
 283     char *tmpdir = tempnam( NULL, "vlt" );
 284     string tempPath = sFromLocale( tmpdir );
 285     free( tmpdir );
 286
 287     // Extract the file in a temporary directory
 288     if( ! extractTarGz( fileName, tempPath ) &&
 289         ! extractZip( fileName, tempPath ) )
 290     {
 291         deleteTempFiles( tempPath );
 292         return false;
 293     }
 294
 295     string path;
 296     string xmlFile;
 297     OSFactory *pOsFactory = OSFactory::instance( getIntf() );
 298     // Find the XML file in the theme
 299     if( findFile( tempPath, DEFAULT_XML_FILE, xmlFile ) )
 300     {
 301         path = getFilePath( xmlFile );
 302     }
 303     else
 304     {
 305         // No XML file, check if it is a winamp2 skin
 306         string mainBmp;
 307         if( findFile( tempPath, "main.bmp", mainBmp ) )
 308         {
 309             msg_Dbg( getIntf(), "trying to load a winamp2 skin" );
 310             path = getFilePath( mainBmp );
 311
 312             // Look for winamp2.xml in the resource path
 313             list<string> resPath = pOsFactory->getResourcePath();
 314             list<string>::const_iterator it;
 315             for( it = resPath.begin(); it != resPath.end(); it++ )
 316             {
 317                 if( findFile( *it, WINAMP2_XML_FILE, xmlFile ) )
 318                     break;
 319             }
 320         }
 321     }
 322
 323     if( !xmlFile.empty() )
 324     {
 325         // Parse the XML file
 326         if (! parse( path, xmlFile ) )
 327         {
 328             msg_Err( getIntf(), "error while parsing %s", xmlFile.c_str() );
 329             result = false;
 330         }
 331     }
 332     else
 333     {
 334         msg_Err( getIntf(), "no XML found in theme %s", fileName.c_str() );
 335         result = false;
 336     }
 337
 338     // Clean-up
 339     deleteTempFiles( tempPath );
 340     return result;
 341 }
 342
 343
 344 void ThemeLoader::deleteTempFiles( const string &path )
 345 {
 346     OSFactory::instance( getIntf() )->rmDir( path );
 347 }
 348 #endif // HAVE_ZLIB_H
 349
 350
 351 bool ThemeLoader::parse( const string &path, const string &xmlFile )
 352 {
 353     // File loaded
 354     msg_Dbg( getIntf(), "using skin file: %s", xmlFile.c_str() );
 355
 356     // Start the parser
 357     SkinParser parser( getIntf(), xmlFile, path );
 358     if( ! parser.parse() )
 359         return false;
 360
 361     // Build and store the theme
 362     Builder builder( getIntf(), parser.getData(), path );
 363     getIntf()->p_sys->p_theme = builder.build();
 364
 365     return true;
 366 }
 367
 368
 369 string ThemeLoader::getFilePath( const string &rFullPath )
 370 {
 371     OSFactory *pOsFactory = OSFactory::instance( getIntf() );
 372     const string &sep = pOsFactory->getDirSeparator();
 373     // Find the last separator ('/' or '\')
 374     string::size_type p = rFullPath.rfind( sep, rFullPath.size() );
 375     string basePath;
 376     if( p != string::npos )
 377     {
 378         if( p < rFullPath.size() - 1)
 379         {
 380             basePath = rFullPath.substr( 0, p );
 381         }
 382         else
 383         {
 384             basePath = rFullPath;
 385         }
 386     }
 387     return basePath;
 388 }
 389
 390
 391 string ThemeLoader::fixDirSeparators( const string &rPath )
 392 {
 393     OSFactory *pOsFactory = OSFactory::instance( getIntf() );
 394     const string &sep = pOsFactory->getDirSeparator();
 395     string::size_type p = rPath.find( "/", 0 );
 396     string newPath = rPath;
 397     while( p != string::npos )
 398     {
 399         newPath = newPath.replace( p, 1, sep );
 400         p = newPath.find( "/", p + 1 );
 401     }
 402     return newPath;
 403 }
 404
 405
 406 bool ThemeLoader::findFile( const string &rootDir, const string &rFileName,
 407                             string &themeFilePath )
 408 {
 409     // Path separator
 410     const string &sep = OSFactory::instance( getIntf() )->getDirSeparator();
 411
 412     DIR *pCurrDir;
 413     char *pszDirContent;
 414
 415     // Open the dir
 416     pCurrDir = utf8_opendir( rootDir.c_str() );
 417
 418     if( pCurrDir == NULL )
 419     {
 420         // An error occurred
 421         msg_Dbg( getIntf(), "cannot open directory %s", rootDir.c_str() );
 422         return false;
 423     }
 424
 425     // While we still have entries in the directory
 426     while( ( pszDirContent = utf8_readdir( pCurrDir ) ) != NULL )
 427     {
 428         string newURI = rootDir + sep + pszDirContent;
 429
 430         // Skip . and ..
 431         if( string( pszDirContent ) != "." &&
 432             string( pszDirContent ) != ".." )
 433         {
 434 #if defined( S_ISDIR )
 435             struct stat stat_data;
 436
 437             if( ( utf8_stat( newURI.c_str(), &stat_data ) == 0 )
 438              && S_ISDIR(stat_data.st_mode) )
 439 #elif defined( DT_DIR )
 440             if( pDirContent->d_type & DT_DIR )
 441 #else
 442             if( 0 )
 443 #endif
 444             {
 445                 // Can we find the file in this subdirectory?
 446                 if( findFile( newURI, rFileName, themeFilePath ) )
 447                 {
 448                     free( pszDirContent );
 449                     closedir( pCurrDir );
 450                     return true;
 451                 }
 452             }
 453             else
 454             {
 455                 // Found the theme file?
 456                 if( rFileName == string( pszDirContent ) )
 457                 {
 458                     themeFilePath = newURI;
 459                     free( pszDirContent );
 460                     closedir( pCurrDir );
 461                     return true;
 462                 }
 463             }
 464         }
 465
 466         free( pszDirContent );
 467     }
 468
 469     closedir( pCurrDir );
 470     return false;
 471 }
 472
 473
 474 #if !defined( HAVE_LIBTAR_H ) && defined( HAVE_ZLIB_H )
 475
 476 /* Values used in typeflag field */
 477 #define REGTYPE  '0'            /* regular file */
 478 #define AREGTYPE '\0'           /* regular file */
 479 #define DIRTYPE  '5'            /* directory */
 480
 481 #define BLOCKSIZE 512
 482
 483 struct tar_header
 484 {                               /* byte offset */
 485     char name[100];             /*   0 */
 486     char mode[8];               /* 100 */
 487     char uid[8];                /* 108 */
 488     char gid[8];                /* 116 */
 489     char size[12];              /* 124 */
 490     char mtime[12];             /* 136 */
 491     char chksum[8];             /* 148 */
 492     char typeflag;              /* 156 */
 493     char linkname[100];         /* 157 */
 494     char magic[6];              /* 257 */
 495     char version[2];            /* 263 */
 496     char uname[32];             /* 265 */
 497     char gname[32];             /* 297 */
 498     char devmajor[8];           /* 329 */
 499     char devminor[8];           /* 337 */
 500     char prefix[155];           /* 345 */
 501                                 /* 500 */
 502 };
 503
 504
 505 union tar_buffer {
 506     char              buffer[BLOCKSIZE];
 507     struct tar_header header;
 508 };
 509
 510
 511
 512 int tar_open( TAR **t, char *pathname, int oflags )
 513 {
 514     gzFile f = gzopen( pathname, "rb" );
 515     if( f == NULL )
 516     {
 517         fprintf( stderr, "Couldn't gzopen %s\n", pathname );
 518         return -1;
 519     }
 520
 521     *t = (gzFile *)malloc( sizeof(gzFile) );
 522     **t = f;
 523     return 0;
 524 }
 525
 526
 527 int tar_extract_all( TAR *t, char *prefix )
 528 {
 529     union tar_buffer buffer;
 530     int   len, err, getheader = 1, remaining = 0;
 531     FILE  *outfile = NULL;
 532     char  fname[BLOCKSIZE + PATH_MAX];
 533
 534     while( 1 )
 535     {
 536         len = gzread( *t, &buffer, BLOCKSIZE );
 537         if( len < 0 )
 538         {
 539             fprintf( stderr, "%s\n", gzerror(*t, &err) );
 540         }
 541
 542         /*
 543          * Always expect complete blocks to process
 544          * the tar information.
 545          */
 546         if( len != 0 && len != BLOCKSIZE )
 547         {
 548             fprintf( stderr, "gzread: incomplete block read\n" );
 549             return -1;
 550         }
 551
 552         /*
 553          * If we have to get a tar header
 554          */
 555         if( getheader == 1 )
 556         {
 557             /*
 558              * If we met the end of the tar
 559              * or the end-of-tar block, we are done
 560              */
 561             if( (len == 0) || (buffer.header.name[0] == 0) )
 562             {
 563                 break;
 564             }
 565
 566             sprintf( fname, "%s/%s", prefix, buffer.header.name );
 567
 568             /* Check magic value in header */
 569             if( strncmp( buffer.header.magic, "GNUtar", 6 ) &&
 570                 strncmp( buffer.header.magic, "ustar", 5 ) )
 571             {
 572                 //fprintf(stderr, "not a tar file\n");
 573                 return -1;
 574             }
 575
 576             switch( buffer.header.typeflag )
 577             {
 578                 case DIRTYPE:
 579                     makedir( fname );
 580                     break;
 581                 case REGTYPE:
 582                 case AREGTYPE:
 583                     remaining = getoct( buffer.header.size, 12 );
 584                     if( remaining )
 585                     {
 586                         outfile = fopen( fname, "wb" );
 587                         if( outfile == NULL )
 588                         {
 589                             /* try creating directory */
 590                             char *p = strrchr( fname, '/' );
 591                             if( p != NULL )
 592                             {
 593                                 *p = '\0';
 594                                 makedir( fname );
 595                                 *p = '/';
 596                                 outfile = fopen( fname, "wb" );
 597                                 if( !outfile )
 598                                 {
 599                                     fprintf( stderr, "tar couldn't create %s\n",
 600                                              fname );
 601                                 }
 602                             }
 603                         }
 604                     }
 605                     else outfile = NULL;
 606
 607                 /*
 608                  * could have no contents
 609                  */
 610                 getheader = (remaining) ? 0 : 1;
 611                 break;
 612             default:
 613                 break;
 614             }
 615         }
 616         else
 617         {
 618             unsigned int bytes = (remaining > BLOCKSIZE)?BLOCKSIZE:remaining;
 619
 620             if( outfile != NULL )
 621             {
 622                 if( fwrite( &buffer, sizeof(char), bytes, outfile ) != bytes )
 623                 {
 624                     fprintf( stderr, "error writing %s skipping...\n", fname );
 625                     fclose( outfile );
 626                     outfile = NULL;
 627                     unlink( fname );
 628                 }
 629             }
 630             remaining -= bytes;
 631             if( remaining == 0 )
 632             {
 633                 getheader = 1;
 634                 if( outfile != NULL )
 635                 {
 636                     fclose(outfile);
 637                     outfile = NULL;
 638                 }
 639             }
 640         }
 641     }
 642
 643     return 0;
 644 }
 645
 646
 647 int tar_close( TAR *t )
 648 {
 649     if( gzclose( *t ) != Z_OK ) fprintf( stderr, "failed gzclose\n" );
 650     free( t );
 651     return 0;
 652 }
 653
 654
 655 /* helper functions */
 656 int getoct( char *p, int width )
 657 {
 658     int result = 0;
 659     char c;
 660
 661     while( width-- )
 662     {
 663         c = *p++;
 664         if( c == ' ' )
 665             continue;
 666         if( c == 0 )
 667             break;
 668         result = result * 8 + (c - '0');
 669     }
 670     return result;
 671 }
 672
 673 #endif
 674
 675 #ifdef WIN32
 676 #  define mkdir(dirname,mode) _mkdir(dirname)
 677 #endif
 678
 679 /* Recursive make directory
 680  * Abort if you get an ENOENT errno somewhere in the middle
 681  * e.g. ignore error "mkdir on existing directory"
 682  *
 683  * return 1 if OK, 0 on error
 684  */
 685 int makedir( const char *newdir )
 686 {
 687     char *p, *buffer = strdup( newdir );
 688     int  len = strlen( buffer );
 689
 690     if( len <= 0 )
 691     {
 692         free( buffer );
 693         return 0;
 694     }
 695
 696     if( buffer[len-1] == '/' )
 697     {
 698         buffer[len-1] = '\0';
 699     }
 700
 701     if( mkdir( buffer, 0775 ) == 0 )
 702     {
 703         free( buffer );
 704         return 1;
 705     }
 706
 707     p = buffer + 1;
 708     while( 1 )
 709     {
 710         char hold;
 711
 712         while( *p && *p != '\\' && *p != '/' ) p++;
 713         hold = *p;
 714         *p = 0;
 715         if( ( mkdir( buffer, 0775 ) == -1 ) && ( errno == ENOENT ) )
 716         {
 717             fprintf( stderr, "couldn't create directory %s\n", buffer );
 718             free( buffer );
 719             return 0;
 720         }
 721         if( hold == 0 ) break;
 722         *p++ = hold;
 723     }
 724     free( buffer );
 725     return 1;
 726 }
 727
 728 #ifdef HAVE_ZLIB_H
 729
 730 static int currentGzFd = -1;
 731 static void * currentGzVp = NULL;
 732
 733 int gzopen_frontend( const char *pathname, int oflags, int mode )
 734 {
 735     const char *gzflags;
 736     gzFile gzf;
 737
 738     switch( oflags )
 739     {
 740         case O_WRONLY:
 741             gzflags = "wb";
 742             break;
 743         case O_RDONLY:
 744             gzflags = "rb";
 745             break;
 746         case O_RDWR:
 747         default:
 748             errno = EINVAL;
 749             return -1;
 750     }
 751
 752     gzf = gzopen( pathname, gzflags );
 753     if( !gzf )
 754     {
 755         errno = ENOMEM;
 756         return -1;
 757     }
 758
 759     /** Hum ... */
 760     currentGzFd = 42;
 761     currentGzVp = gzf;
 762
 763     return currentGzFd;
 764 }
 765
 766 int gzclose_frontend( int fd )
 767 {
 768     if( currentGzVp != NULL && fd != -1 )
 769     {
 770         void *toClose = currentGzVp;
 771         currentGzVp = NULL;  currentGzFd = -1;
 772         return gzclose( toClose );
 773     }
 774     return -1;
 775 }
 776
 777 int gzread_frontend( int fd, void *p_buffer, size_t i_length )
 778 {
 779     if( currentGzVp != NULL && fd != -1 )
 780     {
 781         return gzread( currentGzVp, p_buffer, i_length );
 782     }
 783     return -1;
 784 }
 785
 786 int gzwrite_frontend( int fd, const void * p_buffer, size_t i_length )
 787 {
 788     if( currentGzVp != NULL && fd != -1 )
 789     {
 790         return gzwrite( currentGzVp, const_cast<void*>(p_buffer), i_length );
 791     }
 792     return -1;
 793 }
 794
 795 #endif