3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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 glues together the various parts of the extension
33 * @copyright CiviCRM LLC (c) 2004-2015
37 class CRM_Extension_Browser
{
40 * An URL for public extensions repository.
42 const DEFAULT_EXTENSIONS_REPOSITORY
= 'https://civicrm.org/extdir/ver={ver}|cms={uf}';
45 * @param string $repoUrl
46 * URL of the remote repository.
47 * @param string $indexPath
48 * Relative path of the 'index' file within the repository.
49 * @param string $cacheDir
50 * Local path in which to cache files.
52 public function __construct($repoUrl, $indexPath, $cacheDir) {
53 $this->repoUrl
= $repoUrl;
54 $this->cacheDir
= $cacheDir;
55 $this->indexPath
= $indexPath;
56 if ($cacheDir && !file_exists($cacheDir) && is_dir(dirname($cacheDir)) && is_writable(dirname($cacheDir))) {
57 CRM_Utils_File
::createDir($cacheDir, FALSE);
62 * Determine whether the system policy allows downloading new extensions.
64 * This is reflection of *policy* and *intent*; it does not indicate whether
65 * the browser will actually *work*. For that, see checkRequirements().
69 public function isEnabled() {
70 return (FALSE !== $this->getRepositoryUrl());
76 public function getRepositoryUrl() {
77 return $this->repoUrl
;
81 * Refresh the cache of remotely-available extensions.
83 public function refresh() {
84 $file = $this->getTsPath();
85 if (file_exists($file)) {
91 * Determine whether downloading is supported.
94 * List of error messages; empty if OK.
96 public function checkRequirements() {
97 if (!$this->isEnabled()) {
103 if (!$this->cacheDir ||
!is_dir($this->cacheDir
) ||
!is_writable($this->cacheDir
)) {
104 $civicrmDestination = urlencode(CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1'));
105 $url = CRM_Utils_System
::url('civicrm/admin/setting/path', "reset=1&civicrmDestination=${civicrmDestination}");
107 'title' => ts('Directory Unwritable'),
108 'message' => ts('Your extensions cache directory (%1) is not web server writable. Please go to the <a href="%2">path setting page</a> and correct it.<br/>',
110 1 => $this->cacheDir
,
121 * Get a list of all available extensions.
124 * ($key => CRM_Extension_Info)
126 public function getExtensions() {
127 if (!$this->isEnabled() ||
count($this->checkRequirements())) {
133 $remote = $this->_discoverRemote();
134 if (is_array($remote)) {
135 foreach ($remote as $dc => $e) {
144 * Get a description of a particular extension.
147 * Fully-qualified extension name.
149 * @return CRM_Extension_Info|NULL
151 public function getExtension($key) {
152 // TODO optimize performance -- we don't need to fetch/cache the entire repo
153 $exts = $this->getExtensions();
154 if (array_key_exists($key, $exts)) {
158 // throw new CRM_Extension_Exception("Unknown remote extension: $key");
165 * @throws CRM_Extension_Exception_ParseException
167 private function _discoverRemote() {
168 $tsPath = $this->getTsPath();
171 if (file_exists($tsPath)) {
172 $timestamp = file_get_contents($tsPath);
175 // 3 minutes ago for now
176 $outdated = (int) $timestamp < (time() - 180) ?
TRUE : FALSE;
178 if (!$timestamp ||
$outdated) {
179 $remotes = $this->grabRemoteKeyList();
183 $remotes = $this->grabCachedKeyList();
187 $this->_remotesDiscovered
= array();
188 foreach ($remotes as $id => $rext) {
189 $xml = $this->grabRemoteInfoFile($rext['key'], $cached);
191 $ext = CRM_Extension_Info
::loadFromString($xml);
192 $this->_remotesDiscovered
[] = $ext;
196 if (file_exists(dirname($tsPath))) {
197 file_put_contents($tsPath, (string) time());
200 return $this->_remotesDiscovered
;
206 private function grabCachedKeyList() {
208 $cachedPath = $this->cacheDir
. DIRECTORY_SEPARATOR
;
209 $files = scandir($cachedPath);
210 foreach ($files as $dc => $fname) {
211 if (substr($fname, -4) == '.xml') {
212 $result[] = array('key' => substr($fname, 0, -4));
219 * Connects to public server and grabs the list of publically available
224 * list of extension names
226 private function grabRemoteKeyList() {
228 ini_set('default_socket_timeout', CRM_Utils_VersionCheck
::CHECK_TIMEOUT
);
229 set_error_handler(array('CRM_Extension_Browser', 'downloadError'));
231 if (!ini_get('allow_url_fopen')) {
232 ini_set('allow_url_fopen', 1);
235 if (FALSE === $this->getRepositoryUrl()) {
236 // don't check if the user has configured civi not to check an external
237 // url for extensions. See CRM-10575.
238 CRM_Core_Session
::setStatus(ts('Not checking remote URL for extensions since ext_repo_url is set to false.'), ts('Check Settings'), 'alert');
243 list ($status, $extdir) = CRM_Utils_HttpClient
::singleton()->get($this->getRepositoryUrl() . $this->indexPath
);
244 if ($extdir === FALSE ||
$status !== CRM_Utils_HttpClient
::STATUS_OK
) {
245 CRM_Core_Session
::setStatus(ts('The CiviCRM public extensions directory at %1 could not be contacted - please check your webserver can make external HTTP requests or contact CiviCRM team on <a href="http://forum.civicrm.org/">CiviCRM forum</a>.<br />', array(1 => $this->getRepositoryUrl())), ts('Connection Error'), 'error');
248 $lines = explode("\n", $extdir);
250 foreach ($lines as $ln) {
251 if (preg_match("@\<li\>(.*)\</li\>@i", $ln, $out)) {
254 $key = strip_tags($out[1]);
255 if (substr($key, -4) == '.xml') {
256 $exts[] = array('key' => substr($key, 0, -4));
262 // CRM-13141 There may not be any compatible extensions available for the requested CiviCRM version + CMS. If so, $extdir is empty so just return a notification.
264 $config = CRM_Core_Config
::singleton();
265 CRM_Core_Session
::setStatus(ts('There are currently no extensions on the CiviCRM public extension directory which are compatible with version %2 (<a href="%1">requested extensions from here</a>). If you want to install an extension which is not marked as compatible, you may be able to <a href="%3">download and install extensions manually</a> (depending on access to your web server).<br />', array(
266 1 => $this->getRepositoryUrl(),
267 2 => $config->civiVersion
,
268 3 => 'http://wiki.civicrm.org/confluence/display/CRMDOC/Extensions',
269 )), ts('No Extensions Available for this Version'), 'info');
272 ini_restore('allow_url_fopen');
273 ini_restore('default_socket_timeout');
275 restore_error_handler();
281 * Given the key, retrieves the info XML from a remote server
282 * and stores locally, returning the contents.
286 * @param bool $cached
287 * Whether to use cached data.
290 * Contents of info.xml, or null if info.xml cannot be retrieved or parsed.
292 private function grabRemoteInfoFile($key, $cached = FALSE) {
293 $filename = $this->cacheDir
. DIRECTORY_SEPARATOR
. $key . '.xml';
294 $url = $this->getRepositoryUrl() . '/' . $key . '.xml';
296 if (!$cached ||
!file_exists($filename)) {
297 $fetchStatus = CRM_Utils_HttpClient
::singleton()->fetch($url, $filename);
298 if ($fetchStatus != CRM_Utils_HttpClient
::STATUS_OK
) {
303 if (file_exists($filename)) {
304 $contents = file_get_contents($filename);
307 $check = simplexml_load_string($contents);
310 foreach (libxml_get_errors() as $error) {
311 CRM_Core_Error
::debug('xmlError', $error);
323 private function getTsPath() {
324 return $this->cacheDir
. DIRECTORY_SEPARATOR
. 'timestamp.txt';
328 * A dummy function required for suppressing download errors.
330 * @param $errorNumber
331 * @param $errorString
333 public static function downloadError($errorNumber, $errorString) {