3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * This class handles downloads of remotely-provided extensions
16 * @copyright CiviCRM LLC https://civicrm.org/licensing
18 class CRM_Extension_Downloader
{
20 * @var CRM_Extension_Container_Basic the place where downloaded extensions are ultimately stored
25 * @var string local path to a temporary data directory
30 * @param CRM_Extension_Manager $manager
31 * @param string $containerDir
32 * The place to store downloaded & extracted extensions.
33 * @param string $tmpDir
35 public function __construct(CRM_Extension_Manager
$manager, $containerDir, $tmpDir) {
36 $this->manager
= $manager;
37 $this->containerDir
= $containerDir;
38 $this->tmpDir
= $tmpDir;
42 * Determine whether downloading is supported.
44 * @param \CRM_EXtension_Info $extensionInfo Optional info for (updated) extension
47 * list of error messages; empty if OK
49 public function checkRequirements($extensionInfo = NULL) {
52 if (!$this->containerDir ||
!is_dir($this->containerDir
) ||
!is_writable($this->containerDir
)) {
53 $civicrmDestination = urlencode(CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1'));
54 $url = CRM_Utils_System
::url('civicrm/admin/setting/path', "reset=1&civicrmDestination=${civicrmDestination}");
56 'title' => ts('Directory Unwritable'),
57 'message' => ts("Your extensions directory is not set or is not writable. Click <a href='%1'>here</a> to set the extensions directory.",
65 if (!class_exists('ZipArchive')) {
67 'title' => ts('ZIP Support Required'),
68 '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.'),
72 if (empty($errors) && !CRM_Utils_HttpClient
::singleton()->isRedirectSupported()) {
73 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.'));
74 Civi
::log()->debug('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.');
78 $requiredExtensions = CRM_Extension_System
::singleton()->getManager()->findInstallRequirements([$extensionInfo->key
], $extensionInfo);
79 foreach ($requiredExtensions as $extension) {
80 if (CRM_Extension_System
::singleton()->getManager()->getStatus($extension) !== CRM_Extension_Manager
::STATUS_INSTALLED
&& $extension !== $extensionInfo->key
) {
82 'title' => ts('Missing Requirement: %1', [1 => $extension]),
83 'message' => ts('You will not be able to install/upgrade %1 until you have installed the %2 extension.', [1 => $extensionInfo->key
, 2 => $extension]),
93 * Install or upgrade an extension from a remote URL.
96 * The name of the extension being installed.
97 * @param string $downloadUrl
101 * @throws CRM_Extension_Exception
103 public function download($key, $downloadUrl) {
104 $filename = $this->tmpDir
. DIRECTORY_SEPARATOR
. $key . '.zip';
105 $destDir = $this->containerDir
. DIRECTORY_SEPARATOR
. $key;
108 throw new CRM_Extension_Exception(ts('Cannot install this extension - downloadUrl is not set!'));
111 if (!$this->fetch($downloadUrl, $filename)) {
115 $extractedZipPath = $this->extractFiles($key, $filename);
116 if (!$extractedZipPath) {
120 if (!$this->validateFiles($key, $extractedZipPath)) {
124 $this->manager
->replace($extractedZipPath);
130 * Download the remote zipfile.
132 * @param string $remoteFile
133 * URL of a .zip file.
134 * @param string $localFile
135 * Path at which to store the .zip file.
137 * Whether the download was successful.
139 public function fetch($remoteFile, $localFile) {
140 $result = CRM_Utils_HttpClient
::singleton()->fetch($remoteFile, $localFile);
142 case CRM_Utils_HttpClient
::STATUS_OK
:
151 * Extract an extension from a zip file.
154 * The name of the extension being installed; this usually matches the basedir in the .zip.
155 * @param string $zipFile
156 * The local path to a .zip file.
157 * @return string|FALSE
160 public function extractFiles($key, $zipFile) {
161 $config = CRM_Core_Config
::singleton();
163 $zip = new ZipArchive();
164 $res = $zip->open($zipFile);
166 $zipSubDir = CRM_Utils_Zip
::guessBasedir($zip, $key);
167 if ($zipSubDir === FALSE) {
168 CRM_Core_Session
::setStatus(ts('Unable to extract the extension: bad directory structure'), '', 'error');
171 $extractedZipPath = $this->tmpDir
. DIRECTORY_SEPARATOR
. $zipSubDir;
172 if (is_dir($extractedZipPath)) {
173 if (!CRM_Utils_File
::cleanDir($extractedZipPath, TRUE, FALSE)) {
174 CRM_Core_Session
::setStatus(ts('Unable to extract the extension: %1 cannot be cleared', array(1 => $extractedZipPath)), ts('Installation Error'), 'error');
178 if (!$zip->extractTo($this->tmpDir
)) {
179 CRM_Core_Session
::setStatus(ts('Unable to extract the extension to %1.', array(1 => $this->tmpDir
)), ts('Installation Error'), 'error');
185 CRM_Core_Session
::setStatus(ts('Unable to extract the extension.'), '', 'error');
189 return $extractedZipPath;
193 * Validate that $extractedZipPath contains valid for extension $key
196 * @param $extractedZipPath
199 * @throws CRM_Core_Exception
201 public function validateFiles($key, $extractedZipPath) {
202 $filename = $extractedZipPath . DIRECTORY_SEPARATOR
. CRM_Extension_Info
::FILENAME
;
203 if (!is_readable($filename)) {
204 CRM_Core_Session
::setStatus(ts('Failed reading data from %1 during installation', array(1 => $filename)), ts('Installation Error'), 'error');
209 $newInfo = CRM_Extension_Info
::loadFromFile($filename);
211 catch (Exception
$e) {
212 CRM_Core_Session
::setStatus(ts('Failed reading data from %1 during installation', array(1 => $filename)), ts('Installation Error'), 'error');
216 if ($newInfo->key
!= $key) {
217 throw new CRM_Core_Exception(ts('Cannot install - there are differences between extdir XML file and archive XML file!'));