const STATUS_UNKNOWN = 'unknown';
/**
- * The extension is fully installed and enabled
+ * The extension is installed but the code is not accessible
*/
const STATUS_INSTALLED_MISSING = 'installed-missing';
/**
- * The extension is fully installed and enabled
+ * The extension was installed and is now disabled; the code is not accessible
*/
const STATUS_DISABLED_MISSING = 'disabled-missing';
public $fullContainer;
/**
- * @var CRM_Extension_Container_Basic|FALSE
+ * Default container.
+ *
+ * @var CRM_Extension_Container_Basic|false
*
* Note: Treat as private. This is only public to facilitate debugging.
*/
public $defaultContainer;
/**
+ * Mapper.
+ *
* @var CRM_Extension_Mapper
*
* Note: Treat as private. This is only public to facilitate debugging.
public $mapper;
/**
- * @var array (typeName => CRM_Extension_Manager_Interface)
+ * Type managers.
+ *
+ * @var array
+ *
+ * Format is (typeName => CRM_Extension_Manager_Interface)
*
* Note: Treat as private. This is only public to facilitate debugging.
*/
public $typeManagers;
/**
- * @var array (extensionKey => statusConstant)
+ * Statuses.
+ *
+ * @var array
+ *
+ * Format is (extensionKey => statusConstant)
*
* Note: Treat as private. This is only public to facilitate debugging.
*/
public $statuses;
/**
+ * Class constructor.
+ *
* @param CRM_Extension_Container_Interface $fullContainer
* @param CRM_Extension_Container_Basic|FALSE $defaultContainer
* @param CRM_Extension_Mapper $mapper
- * @param $typeManagers
+ * @param array $typeManagers
*/
public function __construct(CRM_Extension_Container_Interface $fullContainer, $defaultContainer, CRM_Extension_Mapper $mapper, $typeManagers) {
$this->fullContainer = $fullContainer;
/**
* Add records of the extension to the database -- and enable it
*
- * @param array $keys
- * List of extension keys.
+ * @param string|array $keys
+ * One or more extension keys.
* @throws CRM_Extension_Exception
*/
public function install($keys) {
+ $keys = (array) $keys;
$origStatuses = $this->getStatuses();
// TODO: to mitigate the risk of crashing during installation, scan
// keys/statuses/types before doing anything
+ // Check compatibility
+ $incompatible = [];
foreach ($keys as $key) {
- // throws Exception
+ if ($this->isIncompatible($key)) {
+ $incompatible[] = $key;
+ }
+ }
+ if ($incompatible) {
+ throw new CRM_Extension_Exception('Cannot install incompatible extension: ' . implode(', ', $incompatible));
+ }
+
+ foreach ($keys as $key) {
+ /** @var CRM_Extension_Info $info */
+ /** @var CRM_Extension_Manager_Base $typeManager */
list ($info, $typeManager) = $this->_getInfoTypeHandler($key);
switch ($origStatuses[$key]) {
}
/**
- * Add records of the extension to the database -- and enable it
+ * Disable extension without removing record from db.
*
- * @param array $keys
- * List of extension keys.
+ * @param string|array $keys
+ * One or more extension keys.
* @throws CRM_Extension_Exception
*/
public function disable($keys) {
+ $keys = (array) $keys;
$origStatuses = $this->getStatuses();
// TODO: to mitigate the risk of crashing during installation, scan
// This munges order, but makes it comparable.
sort($disableRequirements);
if ($keys !== $disableRequirements) {
- throw new CRM_Extension_Exception_DependencyException("Cannot disable extension due dependencies. Consider disabling all these: " . implode(',', $disableRequirements));
+ throw new CRM_Extension_Exception_DependencyException("Cannot disable extension due to dependencies. Consider disabling all these: " . implode(',', $disableRequirements));
}
foreach ($keys as $key) {
/**
* Remove all database references to an extension.
*
- * Add records of the extension to the database -- and enable it
- *
- * @param array $keys
- * List of extension keys.
+ * @param string|array $keys
+ * One or more extension keys.
* @throws CRM_Extension_Exception
*/
public function uninstall($keys) {
+ $keys = (array) $keys;
$origStatuses = $this->getStatuses();
// TODO: to mitigate the risk of crashing during installation, scan
* @param $key
*
* @return string
- * constant (STATUS_INSTALLED, STATUS_DISABLED, STATUS_UNINSTALLED, STATUS_UNKNOWN)
+ * constant self::STATUS_*
*/
public function getStatus($key) {
$statuses = $this->getStatuses();
}
}
+ /**
+ * Check if a given extension is incompatible with this version of CiviCRM
+ *
+ * @param $key
+ * @return bool|array
+ */
+ public function isIncompatible($key) {
+ $info = CRM_Extension_System::getCompatibilityInfo();
+ return $info[$key] ?? FALSE;
+ }
+
/**
* Determine the status of all extensions.
*
*/
public function getStatuses() {
if (!is_array($this->statuses)) {
+ $compat = CRM_Extension_System::getCompatibilityInfo();
+
$this->statuses = [];
foreach ($this->fullContainer->getKeys() as $key) {
catch (CRM_Extension_Exception $e) {
$codeExists = FALSE;
}
- if ($dao->is_active) {
+ if (!empty($compat[$dao->full_name]['force-uninstall'])) {
+ $this->statuses[$dao->full_name] = self::STATUS_UNINSTALLED;
+ }
+ elseif ($dao->is_active) {
$this->statuses[$dao->full_name] = $codeExists ? self::STATUS_INSTALLED : self::STATUS_INSTALLED_MISSING;
}
else {
*
* @throws CRM_Extension_Exception
* @return array
- * (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface)
+ * [CRM_Extension_Info, CRM_Extension_Manager_Interface]
*/
private function _getInfoTypeHandler($key) {
// throws Exception
*
* @throws CRM_Extension_Exception
* @return array
- * (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface)
+ * [CRM_Extension_Info, CRM_Extension_Manager_Interface]
*/
private function _getMissingInfoTypeHandler($key) {
$info = $this->createInfoFromDB($key);
*
* @param array $keys
* List of extensions to install.
+ * @param \CRM_Extension_Info $info
+ * An extension info object that we should use instead of our local versions (eg. when checking for upgradeability).
+ *
* @return array
* List of extension keys, including dependencies, in order of installation.
+ * @throws \CRM_Extension_Exception
+ * @throws \MJS\TopSort\CircularDependencyException
+ * @throws \MJS\TopSort\ElementNotFoundException
*/
- public function findInstallRequirements($keys) {
- $infos = $this->mapper->getAllInfos();
+ public function findInstallRequirements($keys, $info = NULL) {
+ // Use our passed in info, or get the local versions
+ if ($info) {
+ $infos[$info->key] = $info;
+ }
+ else {
+ $infos = $this->mapper->getAllInfos();
+ }
// array(string $key).
$todoKeys = array_unique($keys);
// array(string $key => 1);
/** @var CRM_Extension_Info $info */
$info = @$infos[$key];
- if ($this->getStatus($key) === self::STATUS_INSTALLED) {
- $sorter->add($key, []);
- }
- elseif ($info && $info->requires) {
+ if ($info && $info->requires) {
$sorter->add($key, $info->requires);
$todoKeys = array_merge($todoKeys, $info->requires);
}