3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 +--------------------------------------------------------------------+
29 * This class handles downloads of remotely-provided extensions
32 * @copyright CiviCRM LLC (c) 2004-2017
34 class CRM_Extension_Downloader
{
36 * @var CRM_Extension_Container_Basic the place where downloaded extensions are ultimately stored
41 * @var string local path to a temporary data directory
46 * @param CRM_Extension_Manager $manager
47 * @param string $containerDir
48 * The place to store downloaded & extracted extensions.
49 * @param string $tmpDir
51 public function __construct(CRM_Extension_Manager
$manager, $containerDir, $tmpDir) {
52 $this->manager
= $manager;
53 $this->containerDir
= $containerDir;
54 $this->tmpDir
= $tmpDir;
58 * Determine whether downloading is supported.
61 * list of error messages; empty if OK
63 public function checkRequirements() {
66 if (!$this->containerDir ||
!is_dir($this->containerDir
) ||
!is_writable($this->containerDir
)) {
67 $civicrmDestination = urlencode(CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1'));
68 $url = CRM_Utils_System
::url('civicrm/admin/setting/path', "reset=1&civicrmDestination=${civicrmDestination}");
70 'title' => ts('Directory Unwritable'),
71 'message' => ts("Your extensions directory is not set or is not writable. Click <a href='%1'>here</a> to set the extensions directory.",
79 if (!class_exists('ZipArchive')) {
81 'title' => ts('ZIP Support Required'),
82 'message' => ts('You will not be able to install extensions at this time because your installation of PHP does not support ZIP archives. Please ask your system administrator to install the standard PHP-ZIP extension.'),
86 if (empty($errors) && !CRM_Utils_HttpClient
::singleton()->isRedirectSupported()) {
87 CRM_Core_Session
::setStatus(ts('WARNING: The downloader may be unable to download files which require HTTP redirection. This may be a configuration issue with PHP\'s open_basedir or safe_mode.'));
88 CRM_Core_Error
::debug_log_message('WARNING: The downloader may be unable to download files which require HTTP redirection. This may be a configuration issue with PHP\'s open_basedir or safe_mode.');
95 * Install or upgrade an extension from a remote URL.
98 * The name of the extension being installed.
99 * @param string $downloadUrl
100 * URL of a .zip file.
103 * @throws CRM_Extension_Exception
105 public function download($key, $downloadUrl) {
106 $filename = $this->tmpDir
. DIRECTORY_SEPARATOR
. $key . '.zip';
107 $destDir = $this->containerDir
. DIRECTORY_SEPARATOR
. $key;
110 CRM_Core_Error
::fatal('Cannot install this extension - downloadUrl is not set!');
113 if (!$this->fetch($downloadUrl, $filename)) {
117 $extractedZipPath = $this->extractFiles($key, $filename);
118 if (!$extractedZipPath) {
122 if (!$this->validateFiles($key, $extractedZipPath)) {
126 $this->manager
->replace($extractedZipPath);
132 * Download the remote zipfile.
134 * @param string $remoteFile
135 * URL of a .zip file.
136 * @param string $localFile
137 * Path at which to store the .zip file.
139 * Whether the download was successful.
141 public function fetch($remoteFile, $localFile) {
142 $result = CRM_Utils_HttpClient
::singleton()->fetch($remoteFile, $localFile);
144 case CRM_Utils_HttpClient
::STATUS_OK
:
153 * Extract an extension from a zip file.
156 * The name of the extension being installed; this usually matches the basedir in the .zip.
157 * @param string $zipFile
158 * The local path to a .zip file.
159 * @return string|FALSE
162 public function extractFiles($key, $zipFile) {
163 $config = CRM_Core_Config
::singleton();
165 $zip = new ZipArchive();
166 $res = $zip->open($zipFile);
168 $zipSubDir = CRM_Utils_Zip
::guessBasedir($zip, $key);
169 if ($zipSubDir === FALSE) {
170 CRM_Core_Session
::setStatus(ts('Unable to extract the extension: bad directory structure'), '', 'error');
173 $extractedZipPath = $this->tmpDir
. DIRECTORY_SEPARATOR
. $zipSubDir;
174 if (is_dir($extractedZipPath)) {
175 if (!CRM_Utils_File
::cleanDir($extractedZipPath, TRUE, FALSE)) {
176 CRM_Core_Session
::setStatus(ts('Unable to extract the extension: %1 cannot be cleared', array(1 => $extractedZipPath)), ts('Installation Error'), 'error');
180 if (!$zip->extractTo($this->tmpDir
)) {
181 CRM_Core_Session
::setStatus(ts('Unable to extract the extension to %1.', array(1 => $this->tmpDir
)), ts('Installation Error'), 'error');
187 CRM_Core_Session
::setStatus(ts('Unable to extract the extension.'), '', 'error');
191 return $extractedZipPath;
195 * Validate that $extractedZipPath contains valid for extension $key
198 * @param $extractedZipPath
202 public function validateFiles($key, $extractedZipPath) {
203 $filename = $extractedZipPath . DIRECTORY_SEPARATOR
. CRM_Extension_Info
::FILENAME
;
204 if (!is_readable($filename)) {
205 CRM_Core_Session
::setStatus(ts('Failed reading data from %1 during installation', array(1 => $filename)), ts('Installation Error'), 'error');
210 $newInfo = CRM_Extension_Info
::loadFromFile($filename);
212 catch (Exception
$e) {
213 CRM_Core_Session
::setStatus(ts('Failed reading data from %1 during installation', array(1 => $filename)), ts('Installation Error'), 'error');
217 if ($newInfo->key
!= $key) {
218 CRM_Core_Error
::fatal('Cannot install - there are differences between extdir XML file and archive XML file!');