include/utils/zip_utils.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37
  38
  39 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
  40 if(class_exists("ZipArchive")) {
  41     require_once 'include/utils/php_zip_utils.php';
  42     return;
  43 } else {
  44 require_once('include/pclzip/pclzip.lib.php');
  45 if ( isset($GLOBALS['log']) && class_implements($GLOBALS['log'],'LoggerTemplate') ) {
  46     $GLOBALS['log']->deprecated('Use of PCLZip has been deprecated. Please enable the zip extension in your PHP install ( see http://www.php.net/manual/en/zip.installation.php for more details ).');
  47 }
  48 function unzip( $zip_archive, $zip_dir, $forceOverwrite = false ){
  49     if( !is_dir( $zip_dir ) ){
  50         if (!defined('SUGAR_PHPUNIT_RUNNER'))
  51             die( "Specified directory '$zip_dir' for zip file '$zip_archive' extraction does not exist." );
  52         return false;
  53     }
  54
  55     $archive = new PclZip( $zip_archive );
  56
  57     if ( $forceOverwrite ) {
  58         if( $archive->extract( PCLZIP_OPT_PATH, $zip_dir, PCLZIP_OPT_REPLACE_NEWER ) == 0 ){
  59             if (!defined('SUGAR_PHPUNIT_RUNNER'))
  60                 die( "Error: " . $archive->errorInfo(true) );
  61             return false;
  62         }
  63     }
  64     else {
  65         if( $archive->extract( PCLZIP_OPT_PATH, $zip_dir ) == 0 ){
  66             if (!defined('SUGAR_PHPUNIT_RUNNER'))
  67                 die( "Error: " . $archive->errorInfo(true) );
  68             return false;
  69         }
  70     }
  71 }
  72
  73 function unzip_file( $zip_archive, $archive_file, $to_dir, $forceOverwrite = false ){
  74     if( !is_dir( $to_dir ) ){
  75         if (!defined('SUGAR_PHPUNIT_RUNNER'))
  76             die( "Specified directory '$to_dir' for zip file '$zip_archive' extraction does not exist." );
  77         return false;
  78     }
  79
  80     $archive = new PclZip($zip_archive);
  81     if ( $forceOverwrite ) {
  82         if( $archive->extract(  PCLZIP_OPT_BY_NAME, $archive_file,
  83                                 PCLZIP_OPT_PATH,    $to_dir,
  84                                 PCLZIP_OPT_REPLACE_NEWER ) == 0 ){
  85             if (!defined('SUGAR_PHPUNIT_RUNNER'))
  86                 die( "Error: " . $archive->errorInfo(true) );
  87             return false;
  88         }
  89     }
  90     else {
  91         if( $archive->extract(  PCLZIP_OPT_BY_NAME, $archive_file,
  92                                 PCLZIP_OPT_PATH,    $to_dir        ) == 0 ){
  93             if (!defined('SUGAR_PHPUNIT_RUNNER'))
  94                 die( "Error: " . $archive->errorInfo(true) );
  95             return false;
  96         }
  97     }
  98 }
  99
 100 function zip_dir( $zip_dir, $zip_archive ){
 101     $archive    = new PclZip( $zip_archive );
 102     $v_list     = $archive->create( $zip_dir );
 103     if( $v_list == 0 ){
 104         if (!defined('SUGAR_PHPUNIT_RUNNER'))
 105             die( "Error: " . $archive->errorInfo(true) );
 106         return false;
 107     }
 108 }
 109
 110 /**
 111  * Zip list of files, optionally stripping prefix
 112  * @param string $zip_file
 113  * @param array $file_list
 114  * @param string $prefix Regular expression for the prefix to strip
 115  */
 116 function zip_files_list($zip_file, $file_list, $prefix = '')
 117 {
 118     $archive    = new PclZip( $zip_file );
 119     foreach($file_list as $file) {
 120         if(!empty($prefix) && preg_match($prefix, $file, $matches) > 0) {
 121             $remove_path = $matches[0];
 122             $archive->add($file, PCLZIP_OPT_REMOVE_PATH, $prefix);
 123         } else {
 124             $archive->add($file);
 125         }
 126     }
 127     return true;
 128 }
 129
 130 } // if (ZipArchive exists)