repoUrl = $repoUrl;
$this->cacheDir = $cacheDir;
$this->indexPath = $indexPath;
if ($cacheDir && !file_exists($cacheDir) && is_dir(dirname($cacheDir)) && is_writable(dirname($cacheDir))) {
CRM_Utils_File::createDir($cacheDir, FALSE);
}
}
/**
* Determine whether the system policy allows downloading new extensions.
*
* This is reflection of *policy* and *intent*; it does not indicate whether
* the browser will actually *work*. For that, see checkRequirements().
*
* @return bool
*/
public function isEnabled() {
return (FALSE !== $this->getRepositoryUrl());
}
/**
* @return string
*/
public function getRepositoryUrl() {
return $this->repoUrl;
}
/**
* Refresh the cache of remotely-available extensions.
*/
public function refresh() {
$file = $this->getTsPath();
if (file_exists($file)) {
unlink($file);
}
}
/**
* Determine whether downloading is supported.
*
* @return array
* List of error messages; empty if OK.
*/
public function checkRequirements() {
if (!$this->isEnabled()) {
return array();
}
$errors = array();
if (!$this->cacheDir || !is_dir($this->cacheDir) || !is_writable($this->cacheDir)) {
$civicrmDestination = urlencode(CRM_Utils_System::url('civicrm/admin/extensions', 'reset=1'));
$url = CRM_Utils_System::url('civicrm/admin/setting/path', "reset=1&civicrmDestination=${civicrmDestination}");
$errors[] = array(
'title' => ts('Directory Unwritable'),
'message' => ts('Your extensions cache directory (%1) is not web server writable. Please go to the path setting page and correct it.
',
array(
1 => $this->cacheDir,
2 => $url,
)
),
);
}
return $errors;
}
/**
* Get a list of all available extensions.
*
* @return array
* ($key => CRM_Extension_Info)
*/
public function getExtensions() {
if (!$this->isEnabled() || count($this->checkRequirements())) {
return array();
}
$exts = array();
$remote = $this->_discoverRemote();
if (is_array($remote)) {
foreach ($remote as $dc => $e) {
$exts[$e->key] = $e;
}
}
return $exts;
}
/**
* Get a description of a particular extension.
*
* @param string $key
* Fully-qualified extension name.
*
* @return CRM_Extension_Info|NULL
*/
public function getExtension($key) {
// TODO optimize performance -- we don't need to fetch/cache the entire repo
$exts = $this->getExtensions();
if (array_key_exists($key, $exts)) {
return $exts[$key];
}
else {
// throw new CRM_Extension_Exception("Unknown remote extension: $key");
return NULL;
}
}
/**
* @return array
* @throws CRM_Extension_Exception_ParseException
*/
private function _discoverRemote() {
$tsPath = $this->getTsPath();
$timestamp = FALSE;
if (file_exists($tsPath)) {
$timestamp = file_get_contents($tsPath);
}
// 3 minutes ago for now
$outdated = (int) $timestamp < (time() - 180) ? TRUE : FALSE;
if (!$timestamp || $outdated) {
$remotes = $this->grabRemoteKeyList();
$cached = FALSE;
}
else {
$remotes = $this->grabCachedKeyList();
$cached = TRUE;
}
$this->_remotesDiscovered = array();
foreach ($remotes as $id => $rext) {
$xml = $this->grabRemoteInfoFile($rext['key'], $cached);
if ($xml != FALSE) {
$ext = CRM_Extension_Info::loadFromString($xml);
$this->_remotesDiscovered[] = $ext;
}
}
if (file_exists(dirname($tsPath))) {
file_put_contents($tsPath, (string) time());
}
return $this->_remotesDiscovered;
}
/**
* @return array
*/
private function grabCachedKeyList() {
$result = array();
$cachedPath = $this->cacheDir . DIRECTORY_SEPARATOR;
$files = scandir($cachedPath);
foreach ($files as $dc => $fname) {
if (substr($fname, -4) == '.xml') {
$result[] = array('key' => substr($fname, 0, -4));
}
}
return $result;
}
/**
* Connects to public server and grabs the list of publically available
* extensions.
*
*
* @return array
* list of extension names
*/
private function grabRemoteKeyList() {
ini_set('default_socket_timeout', CRM_Utils_VersionCheck::CHECK_TIMEOUT);
set_error_handler(array('CRM_Extension_Browser', 'downloadError'));
if (!ini_get('allow_url_fopen')) {
ini_set('allow_url_fopen', 1);
}
if (FALSE === $this->getRepositoryUrl()) {
// don't check if the user has configured civi not to check an external
// url for extensions. See CRM-10575.
CRM_Core_Session::setStatus(ts('Not checking remote URL for extensions since ext_repo_url is set to false.'), ts('Check Settings'), 'alert');
return array();
}
$exts = array();
list ($status, $extdir) = CRM_Utils_HttpClient::singleton()->get($this->getRepositoryUrl() . $this->indexPath);
if ($extdir === FALSE || $status !== CRM_Utils_HttpClient::STATUS_OK) {
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 CiviCRM forum.
', array(1 => $this->getRepositoryUrl())), ts('Connection Error'), 'error');
}
else {
$lines = explode("\n", $extdir);
foreach ($lines as $ln) {
if (preg_match("@\(.*)\@i", $ln, $out)) {
// success
$extsRaw[] = $out;
$key = strip_tags($out[1]);
if (substr($key, -4) == '.xml') {
$exts[] = array('key' => substr($key, 0, -4));
}
}
}
}
// 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.
if (empty($exts)) {
$config = CRM_Core_Config::singleton();
CRM_Core_Session::setStatus(ts('There are currently no extensions on the CiviCRM public extension directory which are compatible with version %2 (requested extensions from here). If you want to install an extension which is not marked as compatible, you may be able to download and install extensions manually (depending on access to your web server).
', array(
1 => $this->getRepositoryUrl(),
2 => $config->civiVersion,
3 => 'http://wiki.civicrm.org/confluence/display/CRMDOC/Extensions',
)), ts('No Extensions Available for this Version'), 'info');
}
ini_restore('allow_url_fopen');
ini_restore('default_socket_timeout');
restore_error_handler();
return $exts;
}
/**
* Given the key, retrieves the info XML from a remote server
* and stores locally, returning the contents.
*
* @param string $key
* Extension key.
* @param bool $cached
* Whether to use cached data.
*
* @return string
* Contents of info.xml, or null if info.xml cannot be retrieved or parsed.
*/
private function grabRemoteInfoFile($key, $cached = FALSE) {
$filename = $this->cacheDir . DIRECTORY_SEPARATOR . $key . '.xml';
$url = $this->getRepositoryUrl() . '/' . $key . '.xml';
if (!$cached || !file_exists($filename)) {
$fetchStatus = CRM_Utils_HttpClient::singleton()->fetch($url, $filename);
if ($fetchStatus != CRM_Utils_HttpClient::STATUS_OK) {
return NULL;
}
}
if (file_exists($filename)) {
$contents = file_get_contents($filename);
//parse just in case
$check = simplexml_load_string($contents);
if (!$check) {
foreach (libxml_get_errors() as $error) {
CRM_Core_Error::debug('xmlError', $error);
}
return;
}
return $contents;
}
}
/**
* @return string
*/
private function getTsPath() {
return $this->cacheDir . DIRECTORY_SEPARATOR . 'timestamp.txt';
}
/**
* A dummy function required for suppressing download errors.
*/
public static function downloadError($errorNumber, $errorString) {
}
}