CRM/Admin/Page/Extensions.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This is a part of CiviCRM extension management functionality.
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2018
  33  */
  34
  35 /**
  36  * This page displays the list of extensions registered in the system.
  37  */
  38 class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic {
  39
  40   /**
  41    * The action links that we need to display for the browse screen.
  42    *
  43    * @var array
  44    */
  45   static $_links = NULL;
  46
  47   /**
  48    * Obtains the group name from url and sets the title.
  49    */
  50   public function preProcess() {
  51     Civi::resources()->addStyleFile('civicrm', 'css/admin.css');
  52
  53     CRM_Utils_System::setTitle(ts('CiviCRM Extensions'));
  54     $destination = CRM_Utils_System::url('civicrm/admin/extensions',
  55       'reset=1');
  56
  57     $destination = urlencode($destination);
  58     $this->assign('destination', $destination);
  59   }
  60
  61   /**
  62    * Get BAO Name.
  63    *
  64    * @return string
  65    *   Classname of BAO.
  66    */
  67   public function getBAOName() {
  68     return 'CRM_Core_BAO_Extension';
  69   }
  70
  71   /**
  72    * Get action Links.
  73    *
  74    * @return array
  75    *   (reference) of action links
  76    */
  77   public function &links() {
  78     if (!(self::$_links)) {
  79       self::$_links = array(
  80         CRM_Core_Action::ADD => array(
  81           'name' => ts('Install'),
  82           'url' => 'civicrm/admin/extensions',
  83           'qs' => 'action=add&id=%%id%%&key=%%key%%',
  84           'title' => ts('Install'),
  85         ),
  86         CRM_Core_Action::ENABLE => array(
  87           'name' => ts('Enable'),
  88           'url' => 'civicrm/admin/extensions',
  89           'qs' => 'action=enable&id=%%id%%&key=%%key%%',
  90           'ref' => 'enable-action',
  91           'title' => ts('Enable'),
  92         ),
  93         CRM_Core_Action::DISABLE => array(
  94           'name' => ts('Disable'),
  95           'url' => 'civicrm/admin/extensions',
  96           'qs' => 'action=disable&id=%%id%%&key=%%key%%',
  97           'title' => ts('Disable'),
  98         ),
  99         CRM_Core_Action::DELETE => array(
 100           'name' => ts('Uninstall'),
 101           'url' => 'civicrm/admin/extensions',
 102           'qs' => 'action=delete&id=%%id%%&key=%%key%%',
 103           'title' => ts('Uninstall Extension'),
 104         ),
 105         CRM_Core_Action::UPDATE => array(
 106           'name' => ts('Download'),
 107           'url' => 'civicrm/admin/extensions',
 108           'qs' => 'action=update&id=%%id%%&key=%%key%%',
 109           'title' => ts('Download Extension'),
 110         ),
 111       );
 112     }
 113     return self::$_links;
 114   }
 115
 116   /**
 117    * Run the basic page (run essentially starts execution for that page).
 118    */
 119   public function run() {
 120     $this->preProcess();
 121     return parent::run();
 122   }
 123
 124   /**
 125    * Browse all options.
 126    */
 127   public function browse() {
 128
 129     // build announcements at the top of the page
 130     $this->assign('extAddNewEnabled', CRM_Extension_System::singleton()->getBrowser()->isEnabled());
 131     $reqs = CRM_Extension_System::singleton()->getDownloader()->checkRequirements();
 132     if (empty($reqs)) {
 133       $reqs = CRM_Extension_System::singleton()->getBrowser()->checkRequirements();
 134     }
 135     if (empty($reqs)) {
 136       $reqs = CRM_Extension_System::singleton()->getDefaultContainer()->checkRequirements();
 137     }
 138     $this->assign('extAddNewReqs', $reqs);
 139
 140     $this->assign('extDbUpgrades', CRM_Extension_Upgrades::hasPending());
 141     $this->assign('extDbUpgradeUrl', CRM_Utils_System::url('civicrm/admin/extensions/upgrade', 'reset=1'));
 142
 143     // TODO: Debate whether to immediately detect changes in underlying source tree
 144     // $manager->refresh();
 145
 146     $localExtensionRows = $this->formatLocalExtensionRows();
 147     $this->assign('localExtensionRows', $localExtensionRows);
 148
 149     $remoteExtensionRows = $this->formatRemoteExtensionRows($localExtensionRows);
 150     $this->assign('remoteExtensionRows', $remoteExtensionRows);
 151   }
 152
 153   /**
 154    * Get the list of local extensions and format them as a table with
 155    * status and action data.
 156    *
 157    * @return array
 158    */
 159   public function formatLocalExtensionRows() {
 160     $mapper = CRM_Extension_System::singleton()->getMapper();
 161     $manager = CRM_Extension_System::singleton()->getManager();
 162
 163     $localExtensionRows = array(); // array($pseudo_id => extended_CRM_Extension_Info)
 164     $keys = array_keys($manager->getStatuses());
 165     sort($keys);
 166     foreach ($keys as $key) {
 167       try {
 168         $obj = $mapper->keyToInfo($key);
 169       }
 170       catch (CRM_Extension_Exception $ex) {
 171         CRM_Core_Session::setStatus(ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key)));
 172         continue;
 173       }
 174
 175       $row = self::createExtendedInfo($obj);
 176       $row['id'] = $obj->key;
 177
 178       // assign actions
 179       $action = 0;
 180       switch ($row['status']) {
 181         case CRM_Extension_Manager::STATUS_UNINSTALLED:
 182           $action += CRM_Core_Action::ADD;
 183           break;
 184
 185         case CRM_Extension_Manager::STATUS_DISABLED:
 186           $action += CRM_Core_Action::ENABLE;
 187           $action += CRM_Core_Action::DELETE;
 188           break;
 189
 190         case CRM_Extension_Manager::STATUS_DISABLED_MISSING:
 191           $action += CRM_Core_Action::DELETE;
 192           break;
 193
 194         case CRM_Extension_Manager::STATUS_INSTALLED:
 195         case CRM_Extension_Manager::STATUS_INSTALLED_MISSING:
 196           $action += CRM_Core_Action::DISABLE;
 197           break;
 198
 199         default:
 200       }
 201       // TODO if extbrowser is enabled and extbrowser has newer version than extcontainer,
 202       // then $action += CRM_Core_Action::UPDATE
 203       $row['action'] = CRM_Core_Action::formLink(self::links(),
 204         $action,
 205         array(
 206           'id' => $row['id'],
 207           'key' => $obj->key,
 208         ),
 209         ts('more'),
 210         FALSE,
 211         'extension.local.action',
 212         'Extension',
 213         $row['id']
 214       );
 215       // Key would be better to send, but it's not an integer.  Moreover, sending the
 216       // values to hook_civicrm_links means that you can still get at the key
 217
 218       $localExtensionRows[$row['id']] = $row;
 219     }
 220     return $localExtensionRows;
 221   }
 222
 223   /**
 224    * Get the list of local extensions and format them as a table with
 225    * status and action data.
 226    *
 227    * @param array $localExtensionRows
 228    * @return array
 229    */
 230   public function formatRemoteExtensionRows($localExtensionRows) {
 231     try {
 232       $remoteExtensions = CRM_Extension_System::singleton()->getBrowser()->getExtensions();
 233     }
 234     catch (CRM_Extension_Exception $e) {
 235       $remoteExtensions = array();
 236       CRM_Core_Session::setStatus($e->getMessage(), ts('Extension download error'), 'error');
 237     }
 238
 239     // build list of available downloads
 240     $remoteExtensionRows = array();
 241     foreach ($remoteExtensions as $info) {
 242       $row = (array) $info;
 243       $row['id'] = $info->key;
 244       $action = CRM_Core_Action::UPDATE;
 245       $row['action'] = CRM_Core_Action::formLink(self::links(),
 246         $action,
 247         array(
 248           'id' => $row['id'],
 249           'key' => $row['key'],
 250         ),
 251         ts('more'),
 252         FALSE,
 253         'extension.remote.action',
 254         'Extension',
 255         $row['id']
 256       );
 257       if (isset($localExtensionRows[$info->key])) {
 258         if (array_key_exists('version', $localExtensionRows[$info->key])) {
 259           if (version_compare($localExtensionRows[$info->key]['version'], $info->version, '<')) {
 260             $row['is_upgradeable'] = TRUE;
 261           }
 262         }
 263       }
 264       $remoteExtensionRows[$row['id']] = $row;
 265     }
 266
 267     return $remoteExtensionRows;
 268   }
 269
 270   /**
 271    * Get name of edit form.
 272    *
 273    * @return string
 274    *   Classname of edit form.
 275    */
 276   public function editForm() {
 277     return 'CRM_Admin_Form_Extensions';
 278   }
 279
 280   /**
 281    * Get edit form name.
 282    *
 283    * @return string
 284    *   name of this page.
 285    */
 286   public function editName() {
 287     return 'CRM_Admin_Form_Extensions';
 288   }
 289
 290   /**
 291    * Get user context.
 292    *
 293    * @param null $mode
 294    *
 295    * @return string
 296    *   user context.
 297    */
 298   public function userContext($mode = NULL) {
 299     return 'civicrm/admin/extensions';
 300   }
 301
 302   /**
 303    * Get userContext params.
 304    *
 305    * @param int $mode
 306    *   Mode that we are in.
 307    *
 308    * @return string
 309    */
 310   public function userContextParams($mode = NULL) {
 311     return 'reset=1&action=browse';
 312   }
 313
 314   /**
 315    * Take an extension's raw XML info and add information about the
 316    * extension's status on the local system.
 317    *
 318    * The result format resembles the old CRM_Core_Extensions_Extension.
 319    *
 320    * @param CRM_Extension_Info $obj
 321    *
 322    * @return array
 323    */
 324   public static function createExtendedInfo(CRM_Extension_Info $obj) {
 325     return CRM_Extension_System::createExtendedInfo($obj);
 326   }
 327
 328 }