3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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
35 class CRM_Extension_Browser
{
38 * An URL for public extensions repository.
40 const DEFAULT_EXTENSIONS_REPOSITORY
= 'https://civicrm.org/extdir/ver={ver}|cms={uf}';
43 * Relative path below remote repository URL for single extensions file.
45 const SINGLE_FILE_PATH
= '/single';
48 * The name of the single JSON extension cache file.
50 const CACHE_JSON_FILE
= 'extensions.json';
53 * @param string $repoUrl
54 * URL of the remote repository.
55 * @param string $indexPath
56 * Relative path of the 'index' file within the repository.
57 * @param string $cacheDir
58 * Local path in which to cache files.
60 public function __construct($repoUrl, $indexPath, $cacheDir) {
61 $this->repoUrl
= $repoUrl;
62 $this->cacheDir
= $cacheDir;
63 $this->indexPath
= empty($indexPath) ? self
::SINGLE_FILE_PATH
: $indexPath;
64 if ($cacheDir && !file_exists($cacheDir) && is_dir(dirname($cacheDir)) && is_writable(dirname($cacheDir))) {
65 CRM_Utils_File
::createDir($cacheDir, FALSE);
70 * Determine whether the system policy allows downloading new extensions.
72 * This is reflection of *policy* and *intent*; it does not indicate whether
73 * the browser will actually *work*. For that, see checkRequirements().
77 public function isEnabled() {
78 return (FALSE !== $this->getRepositoryUrl());
84 public function getRepositoryUrl() {
85 return $this->repoUrl
;
89 * Refresh the cache of remotely-available extensions.
91 public function refresh() {
92 $file = $this->getTsPath();
93 if (file_exists($file)) {
99 * Determine whether downloading is supported.
102 * List of error messages; empty if OK.
104 public function checkRequirements() {
105 if (!$this->isEnabled()) {
111 if (!$this->cacheDir ||
!is_dir($this->cacheDir
) ||
!is_writable($this->cacheDir
)) {
112 $civicrmDestination = urlencode(CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1'));
113 $url = CRM_Utils_System
::url('civicrm/admin/setting/path', "reset=1&civicrmDestination=${civicrmDestination}");
115 'title' => ts('Directory Unwritable'),
116 '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/>',
118 1 => $this->cacheDir
,
129 * Get a list of all available extensions.
132 * ($key => CRM_Extension_Info)
134 public function getExtensions() {
135 if (!$this->isEnabled() ||
count($this->checkRequirements())) {
141 $remote = $this->_discoverRemote();
142 if (is_array($remote)) {
143 foreach ($remote as $dc => $e) {
152 * Get a description of a particular extension.
155 * Fully-qualified extension name.
157 * @return CRM_Extension_Info|NULL
159 public function getExtension($key) {
160 // TODO optimize performance -- we don't need to fetch/cache the entire repo
161 $exts = $this->getExtensions();
162 if (array_key_exists($key, $exts)) {
172 * @throws CRM_Extension_Exception_ParseException
174 private function _discoverRemote() {
175 $tsPath = $this->getTsPath();
178 if (file_exists($tsPath)) {
179 $timestamp = file_get_contents($tsPath);
182 // 3 minutes ago for now
183 $outdated = (int) $timestamp < (time() - 180) ?
TRUE : FALSE;
185 if (!$timestamp ||
$outdated) {
186 $remotes = json_decode($this->grabRemoteJson(), TRUE);
189 $remotes = json_decode($this->grabCachedJson(), TRUE);
192 $this->_remotesDiscovered
= array();
193 foreach ($remotes as $id => $xml) {
194 $ext = CRM_Extension_Info
::loadFromString($xml);
195 $this->_remotesDiscovered
[] = $ext;
198 if (file_exists(dirname($tsPath))) {
199 file_put_contents($tsPath, (string) time());
202 return $this->_remotesDiscovered
;
206 * Loads the extensions data from the cache file. If it is empty
207 * or doesn't exist, try fetching from remote instead.
211 private function grabCachedJson() {
212 $filename = $this->cacheDir
. DIRECTORY_SEPARATOR
. self
::CACHE_JSON_FILE
;
213 $json = file_get_contents($filename);
215 $json = $this->grabRemoteJson();
221 * Connects to public server and grabs the list of publicly available
225 * @throws \CRM_Extension_Exception
227 private function grabRemoteJson() {
229 ini_set('default_socket_timeout', CRM_Utils_VersionCheck
::CHECK_TIMEOUT
);
230 set_error_handler(array('CRM_Extension_Browser', 'downloadError'));
232 if (!ini_get('allow_url_fopen')) {
233 ini_set('allow_url_fopen', 1);
236 if (FALSE === $this->getRepositoryUrl()) {
237 // don't check if the user has configured civi not to check an external
238 // url for extensions. See CRM-10575.
242 $filename = $this->cacheDir
. DIRECTORY_SEPARATOR
. self
::CACHE_JSON_FILE
;
243 $url = $this->getRepositoryUrl() . $this->indexPath
;
244 $status = CRM_Utils_HttpClient
::singleton()->fetch($url, $filename);
246 ini_restore('allow_url_fopen');
247 ini_restore('default_socket_timeout');
249 restore_error_handler();
251 if ($status !== CRM_Utils_HttpClient
::STATUS_OK
) {
252 throw new CRM_Extension_Exception(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>.', array(1 => $this->getRepositoryUrl())), 'connection_error');
255 // Don't call grabCachedJson here, that would risk infinite recursion
256 return file_get_contents($filename);
262 private function getTsPath() {
263 return $this->cacheDir
. DIRECTORY_SEPARATOR
. 'timestamp.txt';
267 * A dummy function required for suppressing download errors.
269 * @param $errorNumber
270 * @param $errorString
272 public static function downloadError($errorNumber, $errorString) {