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 proivdes various helper functions for locating extensions
14 * data. It's designed for compatibility with pre-existing functions from
15 * CRM_Core_Extensions.
17 * Most of these helper functions originate with the first major iteration
18 * of extensions -- a time when every extension had one eponymous PHP class,
19 * when there was no PHP class-loader, and when there was special-case logic
20 * sprinkled around to handle loading of "extension classes".
22 * With module-extensions (Civi 4.2+), there are no eponymous classes --
23 * instead, module-extensions follow the same class-naming and class-loading
24 * practices as core (and don't require special-case logic for class
25 * loading). Consequently, the helpers in here aren't much used with
29 * @copyright CiviCRM LLC https://civicrm.org/licensing
31 class CRM_Extension_Mapper
{
34 * An URL for public extensions repository.
38 * Extension info file name.
40 const EXT_TEMPLATES_DIRNAME
= 'templates';
43 * @var CRM_Extension_Container_Interface
48 * @var \CRM_Extension_Info[]
49 * (key => CRM_Extension_Info)
51 protected $infos = [];
56 protected $moduleExtensions = NULL;
59 * @var CRM_Utils_Cache_Interface
65 protected $civicrmPath;
67 protected $civicrmUrl;
70 * @param CRM_Extension_Container_Interface $container
71 * @param CRM_Utils_Cache_Interface $cache
72 * @param null $cacheKey
73 * @param null $civicrmPath
74 * @param null $civicrmUrl
76 public function __construct(CRM_Extension_Container_Interface
$container, CRM_Utils_Cache_Interface
$cache = NULL, $cacheKey = NULL, $civicrmPath = NULL, $civicrmUrl = NULL) {
77 $this->container
= $container;
78 $this->cache
= $cache;
79 $this->cacheKey
= $cacheKey;
81 $this->civicrmUrl
= rtrim($civicrmUrl, '/');
84 $config = CRM_Core_Config
::singleton();
85 $this->civicrmUrl
= rtrim($config->resourceBase
, '/');
88 $this->civicrmPath
= rtrim($civicrmPath, '/');
92 $this->civicrmPath
= rtrim($civicrm_root, '/');
97 * Given the class, provides extension's key.
100 * @param string $clazz
101 * Extension class name.
104 * name of extension key
106 public function classToKey($clazz) {
107 return str_replace('_', '.', $clazz);
111 * Given the class, provides extension path.
117 * full path the extension .php file
119 public function classToPath($clazz) {
120 $elements = explode('_', $clazz);
121 $key = implode('.', $elements);
122 return $this->keyToPath($key);
126 * Given the string, returns true or false if it's an extension key.
130 * A string which might be an extension key.
133 * true if given string is an extension name
135 public function isExtensionKey($key) {
136 // check if the string is an extension name or the class
137 return (strpos($key, '.') !== FALSE) ?
TRUE : FALSE;
141 * Given the string, returns true or false if it's an extension class name.
144 * @param string $clazz
145 * A string which might be an extension class name.
148 * true if given string is an extension class name
150 public function isExtensionClass($clazz) {
152 if (substr($clazz, 0, 4) != 'CRM_') {
153 return (bool) preg_match('/^[a-z0-9]+(_[a-z0-9]+)+$/', $clazz);
160 * Extension fully-qualified-name.
163 * @throws CRM_Extension_Exception
165 * @return CRM_Extension_Info
167 public function keyToInfo($key, $fresh = FALSE) {
168 if ($fresh ||
!array_key_exists($key, $this->infos
)) {
170 $this->infos
[$key] = CRM_Extension_Info
::loadFromFile($this->container
->getPath($key) . DIRECTORY_SEPARATOR
. CRM_Extension_Info
::FILENAME
);
172 catch (CRM_Extension_Exception
$e) {
173 // file has more detailed info, but we'll fallback to DB if it's missing -- DB has enough info to uninstall
174 $dbInfo = CRM_Extension_System
::singleton()->getManager()->createInfoFromDB($key);
178 $this->infos
[$key] = $dbInfo;
181 return $this->infos
[$key];
185 * Given the key, provides extension's class name.
192 * name of extension's main class
194 public function keyToClass($key) {
195 return str_replace('.', '_', $key);
199 * Given the key, provides the path to file containing
200 * extension's main class.
207 * path to file containing extension's main class
209 public function keyToPath($key) {
210 $info = $this->keyToInfo($key);
211 return $this->container
->getPath($key) . DIRECTORY_SEPARATOR
. $info->file
. '.php';
215 * Given the key, provides the path to file containing
216 * extension's main class.
221 * local path of the extension source tree
223 public function keyToBasePath($key) {
224 if ($key == 'civicrm') {
225 return $this->civicrmPath
;
227 return $this->container
->getPath($key);
231 * Given the key, provides the path to file containing
232 * extension's main class.
239 * url for resources in this extension
241 * @throws \CRM_Extension_Exception_MissingException
243 public function keyToUrl($key) {
244 if ($key === 'civicrm') {
245 // CRM-12130 Workaround: If the domain's config_backend is NULL at the start of the request,
246 // then the Mapper is wrongly constructed with an empty value for $this->civicrmUrl.
247 if (empty($this->civicrmUrl
)) {
248 $config = CRM_Core_Config
::singleton();
249 return rtrim($config->resourceBase
, '/');
251 return $this->civicrmUrl
;
254 return $this->container
->getResUrl($key);
258 * Fetch the list of active extensions of type 'module'
261 * whether to forcibly reload extensions list from canonical store.
263 * array(array('prefix' => $, 'fullName' => $, 'filePath' => $))
265 public function getActiveModuleFiles($fresh = FALSE) {
266 if (!defined('CIVICRM_DSN')) {
271 // The list of module files is cached in two tiers. The tiers are slightly
274 // 1. The persistent tier (cache) stores
275 // names WITHOUT absolute paths.
276 // 2. The ephemeral/thread-local tier (statics) stores names
277 // WITH absolute paths.
278 // Return static value instead of re-running query
279 if (isset(Civi
::$statics[__CLASS__
]['moduleExtensions']) && !$fresh) {
280 return Civi
::$statics[__CLASS__
]['moduleExtensions'];
283 $moduleExtensions = NULL;
285 // Checked if it's stored in the persistent cache.
286 if ($this->cache
&& !$fresh) {
287 $moduleExtensions = $this->cache
->get($this->cacheKey
. '_moduleFiles');
290 // If cache is empty we build it from database.
291 if (!is_array($moduleExtensions)) {
292 $compat = CRM_Extension_System
::getCompatibilityInfo();
294 // Check canonical module list
295 $moduleExtensions = [];
297 SELECT full_name, file
298 FROM civicrm_extension
302 $dao = CRM_Core_DAO
::executeQuery($sql);
303 while ($dao->fetch()) {
304 if (!empty($compat[$dao->full_name
]['force-uninstall'])) {
307 $moduleExtensions[] = [
308 'prefix' => $dao->file
,
309 'fullName' => $dao->full_name
,
315 $this->cache
->set($this->cacheKey
. '_moduleFiles', $moduleExtensions);
319 // Since we're not caching the full path we add it now.
320 array_walk($moduleExtensions, function(&$value, $key) {
322 if (!$value['filePath']) {
323 $value['filePath'] = $this->keyToPath($value['fullName']);
326 catch (CRM_Extension_Exception
$e) {
327 // Putting a stub here provides more consistency
328 // in how getActiveModuleFiles when racing between
329 // dirty file-removals and cache-clears.
330 CRM_Core_Session
::setStatus($e->getMessage(), '', 'error');
331 $value['filePath'] = NULL;
335 Civi
::$statics[__CLASS__
]['moduleExtensions'] = $moduleExtensions;
337 return $moduleExtensions;
341 * Get a list of base URLs for all active modules.
344 * (string $extKey => string $baseUrl)
346 * @throws \CRM_Extension_Exception_MissingException
348 public function getActiveModuleUrls() {
349 // TODO optimization/caching
351 $urls['civicrm'] = $this->keyToUrl('civicrm');
352 foreach ($this->getModules() as $module) {
353 /** @var $module CRM_Core_Module */
354 if ($module->is_active
) {
356 $urls[$module->name
] = $this->keyToUrl($module->name
);
358 catch (CRM_Extension_Exception_MissingException
$e) {
359 CRM_Core_Session
::setStatus(ts('An enabled extension is missing from the extensions directory') . ':' . $module->name
);
367 * Get a list of extension keys, filtered by the corresponding file path.
369 * @param string $pattern
370 * A file path. To search subdirectories, append "*".
371 * Ex: "/var/www/extensions/*"
372 * Ex: "/var/www/extensions/org.foo.bar"
374 * Array(string $key).
375 * Ex: array("org.foo.bar").
377 public function getKeysByPath($pattern) {
380 if (CRM_Utils_String
::endsWith($pattern, '*')) {
381 $prefix = rtrim($pattern, '*');
382 foreach ($this->container
->getKeys() as $key) {
383 $path = CRM_Utils_File
::addTrailingSlash($this->container
->getPath($key));
384 if (realpath($prefix) == realpath($path) || CRM_Utils_File
::isChildPath($prefix, $path)) {
390 foreach ($this->container
->getKeys() as $key) {
391 $path = CRM_Utils_File
::addTrailingSlash($this->container
->getPath($key));
392 if (realpath($pattern) == realpath($path)) {
402 * Get a list of extensions which match a given tag.
407 * Array(string $key).
408 * Ex: array("org.foo.bar").
410 public function getKeysByTag($tag) {
411 $allTags = $this->getAllTags();
412 return $allTags[$tag] ??
[];
416 * Get a list of extension tags.
419 * Ex: ['form-building' => ['org.civicrm.afform-gui', 'org.civicrm.afform-html']]
421 public function getAllTags() {
422 $tags = Civi
::cache('short')->get('extension_tags', NULL);
423 if ($tags !== NULL) {
428 $allInfos = $this->getAllInfos();
429 foreach ($allInfos as $key => $info) {
430 foreach ($info->tags
as $tag) {
431 $tags[$tag][] = $key;
439 * Ex: $result['org.civicrm.foobar'] = new CRM_Extension_Info(...).
440 * @throws \CRM_Extension_Exception
443 public function getAllInfos() {
444 foreach ($this->container
->getKeys() as $key) {
446 $this->keyToInfo($key);
448 catch (CRM_Extension_Exception_ParseException
$e) {
449 CRM_Core_Session
::setStatus(ts('Parse error in extension: %1', [
450 1 => $e->getMessage(),
452 CRM_Core_Error
::debug_log_message("Parse error in extension: " . $e->getMessage());
460 * @param string $name
464 public function isActiveModule($name) {
465 $activeModules = $this->getActiveModuleFiles();
466 foreach ($activeModules as $activeModule) {
467 if ($activeModule['prefix'] == $name) {
475 * Get a list of all installed modules, including enabled and disabled ones
480 public function getModules() {
482 $dao = new CRM_Core_DAO_Extension();
483 $dao->type
= 'module';
485 while ($dao->fetch()) {
486 $result[] = new CRM_Core_Module($dao->full_name
, $dao->is_active
);
492 * Given the class, provides the template path.
495 * @param string $clazz
496 * Extension class name.
499 * path to extension's templates directory
501 public function getTemplatePath($clazz) {
502 $path = $this->container
->getPath($this->classToKey($clazz));
503 return $path . DIRECTORY_SEPARATOR
. self
::EXT_TEMPLATES_DIRNAME
;
505 $path = $this->classToPath($clazz);
506 $pathElm = explode(DIRECTORY_SEPARATOR, $path);
508 return implode(DIRECTORY_SEPARATOR, $pathElm) . DIRECTORY_SEPARATOR . self::EXT_TEMPLATES_DIRNAME;
513 * Given te class, provides the template name.
514 * @todo consider multiple templates, support for one template for now
517 * @param string $clazz
518 * Extension class name.
521 * extension's template name
523 public function getTemplateName($clazz) {
524 $info = $this->keyToInfo($this->classToKey($clazz));
525 return (string) $info->file
. '.tpl';
528 public function refresh() {
530 $this->moduleExtensions
= NULL;
532 $this->cache
->delete($this->cacheKey
. '_moduleFiles');
534 // FIXME: How can code so code wrong be so right?
535 CRM_Extension_System
::singleton()->getClassLoader()->refresh();
539 * This returns a formatted string containing an extension upgrade link for the UI.
540 * @todo We should improve this to return more appropriate text. eg. when an extension is not installed
541 * it should not say "version xx is installed".
543 * @param array $remoteExtensionInfo
544 * @param array $localExtensionInfo
548 public function getUpgradeLink($remoteExtensionInfo, $localExtensionInfo) {
549 if (!empty($remoteExtensionInfo) && version_compare($localExtensionInfo['version'], $remoteExtensionInfo->version
, '<')) {
550 return ts('Version %1 is installed. <a %2>Upgrade to version %3</a>.', [
551 1 => $localExtensionInfo['version'],
552 2 => 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', "action=update&id={$localExtensionInfo['key']}&key={$localExtensionInfo['key']}") . '"',
553 3 => $remoteExtensionInfo->version
,