3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * Utilities for working with zip files
40 * Given a zip file which contains a single root directory, determine the root's name.
42 * @param ZipArchive $zip
45 * FALSE if #root level items !=1; otherwise, the name of base dir
47 public static function findBaseDirName(ZipArchive
$zip) {
48 $cnt = $zip->numFiles
;
53 for ($i = 0; $i < $cnt; $i++
) {
54 $filename = $zip->getNameIndex($i);
55 if ($base === FALSE) {
56 if (preg_match('/^[^\/]+\/$/', $filename) && $filename != './' && $filename != '../') {
58 $baselen = strlen($filename);
64 elseif (0 != substr_compare($base, $filename, 0, $baselen)) {
73 * Given a zip file, find all directory names in the root
75 * @param ZipArchive $zip
77 * @return array(string)
80 public static function findBaseDirs(ZipArchive
$zip) {
81 $cnt = $zip->numFiles
;
84 for ($i = 0; $i < $cnt; $i++
) {
85 $filename = $zip->getNameIndex($i);
86 // hypothetically, ./ or ../ would not be legit here
87 if (preg_match('/^[^\/]+\/$/', $filename) && $filename != './' && $filename != '../') {
88 $basedirs[] = rtrim($filename, '/');
96 * Determine the name of the folder within a zip.
98 * @param ZipArchive $zip
101 * @return string|bool
102 * Return string or FALSE
104 public static function guessBasedir(ZipArchive
$zip, $expected) {
106 $basedirs = CRM_Utils_Zip
::findBaseDirs($zip);
107 if (in_array($expected, $basedirs)) {
108 $candidate = $expected;
110 elseif (count($basedirs) == 1) {
111 $candidate = array_shift($basedirs);
113 if ($candidate !== FALSE && preg_match('/^[a-zA-Z0-9]/', $candidate)) {
122 * An inefficient helper for creating a ZIP file from data in memory.
123 * This is only intended for building temp files for unit-testing.
125 * @param string $zipName
128 * Array, list of directory paths.
129 * @param array $files
130 * Array, keys are file names and values are file contents.
133 public static function createTestZip($zipName, $dirs, $files) {
134 $zip = new ZipArchive();
135 $res = $zip->open($zipName, ZipArchive
::CREATE
);
137 foreach ($dirs as $dir) {
138 if (!$zip->addEmptyDir($dir)) {
142 foreach ($files as $fileName => $fileData) {
143 if (!$zip->addFromString($fileName, $fileData)) {