include/utils/php_zip_utils.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM 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'))
  50             die( "Specified directory '$zip_dir' for zip file '$zip_archive' extraction does not exist." );
  51         return false;
  52     }
  53     $zip = new ZipArchive;
  54     $res = $zip->open($zip_archive);
  55     if($res !== true) {
  56         if (!defined('SUGAR_PHPUNIT_RUNNER'))
  57             die(sprintf("ZIP Error(%d): %s", $res, $zip->status));
  58         return false;
  59     }
  60
  61     if($archive_file !== null) {
  62         $res = $zip->extractTo($zip_dir, $archive_file);
  63     } else {
  64         $res = $zip->extractTo($zip_dir);
  65     }
  66     if($res !== true) {
  67         if (!defined('SUGAR_PHPUNIT_RUNNER'))
  68             die(sprintf("ZIP Error(%d): %s", $res, $zip->status));
  69         return false;
  70     }
  71     return true;
  72 }
  73
  74 function zip_dir( $zip_dir, $zip_archive )
  75 {
  76     if( !is_dir( $zip_dir ) ){
  77         if (!defined('SUGAR_PHPUNIT_RUNNER'))
  78             die( "Specified directory '$zip_dir' for zip file '$zip_archive' extraction does not exist." );
  79         return false;
  80     }
  81     $zip = new ZipArchive();
  82     $zip->open($zip_archive, ZIPARCHIVE::CREATE|ZIPARCHIVE::OVERWRITE);
  83     $path = realpath($zip_dir);
  84     $chop = strlen($path)+1;
  85     $dir = new RecursiveDirectoryIterator($path);
  86     $it = new RecursiveIteratorIterator($dir, RecursiveIteratorIterator::SELF_FIRST);
  87     foreach ($it as $k => $fileinfo) {
  88         $localname = substr($fileinfo->getPathname(), $chop);
  89         if($fileinfo->isDir()) {
  90             $zip->addEmptyDir($localname);
  91         } else {
  92             $zip->addFile($fileinfo->getPathname(), $localname);
  93         }
  94     }
  95 }
  96
  97 /**
  98  * Zip list of files, optionally stripping prefix
  99  * @param string $zip_file
 100  * @param array $file_list
 101  * @param string $prefix Regular expression for the prefix to strip
 102  */
 103 function zip_files_list($zip_file, $file_list, $prefix = '')
 104 {
 105     $archive    = new ZipArchive();
 106     $res = $archive->open($zip_file, ZipArchive::CREATE|ZipArchive::OVERWRITE);
 107     if($res !== TRUE)
 108     {
 109         $GLOBALS['log']->fatal("Unable to open zip file, check directory permissions: $zip_file");
 110         return FALSE;
 111     }
 112     foreach($file_list as $file) {
 113         if(!empty($prefix) && preg_match($prefix, $file, $matches) > 0) {
 114             $zipname = substr($file, strlen($matches[0]));
 115         } else {
 116             $zipname = $file;
 117         }
 118         $archive->addFile($file, $zipname);
 119     }
 120     return TRUE;
 121 }