include/utils/php_zip_utils.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 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
  41 function unzip( $zip_archive, $zip_dir)
  42 {
  43    return unzip_file($zip_archive, null, $zip_dir);
  44 }
  45
  46 function unzip_file( $zip_archive, $archive_file, $zip_dir)
  47 {
  48     if( !is_dir( $zip_dir ) ) {
  49         if (defined('SUGAR_PHPUNIT_RUNNER') || defined('SUGARCRM_INSTALL'))
  50         {
  51                 $GLOBALS['log']->fatal("Specified directory '$zip_dir' for zip file '$zip_archive' extraction does not exist.");
  52                 return false;
  53         } else {
  54             die( "Specified directory '$zip_dir' for zip file '$zip_archive' extraction does not exist." );
  55         }
  56     }
  57
  58     $zip = new ZipArchive;
  59
  60     $res = $zip->open(UploadFile::realpath($zip_archive)); // we need realpath here for PHP streams support
  61
  62     if($res !== TRUE) {
  63         if (defined('SUGAR_PHPUNIT_RUNNER') || defined('SUGARCRM_INSTALL'))
  64         {
  65                 $GLOBALS['log']->fatal(sprintf("ZIP Error(%d): Status(%s): Arhive(%s): Directory(%s)", $res, $zip->status, $zip_archive, $zip_dir));
  66             return false;
  67         } else {
  68                 die(sprintf("ZIP Error(%d): Status(%s): Arhive(%s): Directory(%s)", $res, $zip->status, $zip_archive, $zip_dir));
  69         }
  70
  71     }
  72
  73     if($archive_file !== null) {
  74         $res = $zip->extractTo(UploadFile::realpath($zip_dir), $archive_file);
  75     } else {
  76         $res = $zip->extractTo(UploadFile::realpath($zip_dir));
  77     }
  78
  79     if($res !== TRUE) {
  80         if (defined('SUGAR_PHPUNIT_RUNNER') || defined('SUGARCRM_INSTALL'))
  81         {
  82                 $GLOBALS['log']->fatal(sprintf("ZIP Error(%d): Status(%s): Arhive(%s): Directory(%s)", $res, $zip->status, $zip_archive, $zip_dir));
  83             return false;
  84         } else {
  85                 die(sprintf("ZIP Error(%d): Status(%s): Arhive(%s): Directory(%s)", $res, $zip->status, $zip_archive, $zip_dir));
  86         }
  87     }
  88     return true;
  89 }
  90
  91 function zip_dir( $zip_dir, $zip_archive )
  92 {
  93     if( !is_dir( $zip_dir ) ){
  94         if (!defined('SUGAR_PHPUNIT_RUNNER'))
  95             die( "Specified directory '$zip_dir' for zip file '$zip_archive' extraction does not exist." );
  96         return false;
  97     }
  98     $zip = new ZipArchive();
  99     $zip->open(UploadFile::realpath($zip_archive), ZIPARCHIVE::CREATE|ZIPARCHIVE::OVERWRITE); // we need realpath here for PHP streams support
 100     $path = UploadFile::realpath($zip_dir);
 101     $chop = strlen($path)+1;
 102     $dir = new RecursiveDirectoryIterator($path);
 103     $it = new RecursiveIteratorIterator($dir, RecursiveIteratorIterator::SELF_FIRST);
 104     foreach ($it as $k => $fileinfo) {
 105         // Bug # 45143
 106         // ensure that . and .. are not zipped up, otherwise, the
 107         // CENT OS and others will fail when deploying module
 108         $fileName = $fileinfo->getFilename();
 109         if ($fileName == "." || $fileName == "..")
 110             continue;
 111         $localname = str_replace("\\", "/",substr($fileinfo->getPathname(), $chop)); // ensure file
 112         if($fileinfo->isDir()) {
 113             $zip->addEmptyDir($localname."/");
 114         } else {
 115             $zip->addFile($fileinfo->getPathname(), $localname);
 116         }
 117     }
 118 }
 119
 120 /**
 121  * Zip list of files, optionally stripping prefix
 122  * FIXME: check what happens with streams
 123  * @param string $zip_file
 124  * @param array $file_list
 125  * @param string $prefix Regular expression for the prefix to strip
 126  */
 127 function zip_files_list($zip_file, $file_list, $prefix = '')
 128 {
 129     $archive    = new ZipArchive();
 130     $res = $archive->open(UploadFile::realpath($zip_file), ZipArchive::CREATE|ZipArchive::OVERWRITE); // we need realpath here for PHP streams support
 131     if($res !== TRUE)
 132     {
 133         $GLOBALS['log']->fatal("Unable to open zip file, check directory permissions: $zip_file");
 134         return FALSE;
 135     }
 136     foreach($file_list as $file) {
 137         if(!empty($prefix) && preg_match($prefix, $file, $matches) > 0) {
 138             $zipname = substr($file, strlen($matches[0]));
 139         } else {
 140             $zipname = $file;
 141         }
 142         $archive->addFile($file, $zipname);
 143     }
 144     return TRUE;
 145 }