CRM/Core/Page/Basic.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
  18
  19   protected $_action;
  20
  21   /**
  22    * Define all the abstract functions here.
  23    */
  24
  25   /**
  26    * Name of the BAO to perform various DB manipulations.
  27    *
  28    * @return string
  29    */
  30   abstract protected function getBAOName();
  31
  32   /**
  33    * An array of action links.
  34    *
  35    * @return array
  36    *   (reference)
  37    */
  38   abstract protected function &links();
  39
  40   /**
  41    * Name of the edit form class.
  42    *
  43    * @return string
  44    */
  45   abstract protected function editForm();
  46
  47   /**
  48    * Name of the form.
  49    *
  50    * @return string
  51    */
  52   abstract protected function editName();
  53
  54   /**
  55    * UserContext to pop back to.
  56    *
  57    * @param int $mode
  58    *   Mode that we are in.
  59    *
  60    * @return string
  61    */
  62   abstract protected function userContext($mode = NULL);
  63
  64   /**
  65    * Get userContext params.
  66    *
  67    * @param int $mode
  68    *   Mode that we are in.
  69    *
  70    * @return string
  71    */
  72   public function userContextParams($mode = NULL) {
  73     return 'reset=1&action=browse';
  74   }
  75
  76   /**
  77    * Allow objects to be added based on permission.
  78    *
  79    * @param int $id
  80    *   The id of the object.
  81    * @param int $name
  82    *   The name or title of the object.
  83    *
  84    * @return string
  85    *   permission value if permission is granted, else null
  86    */
  87   public function checkPermission($id, $name) {
  88     return CRM_Core_Permission::EDIT;
  89   }
  90
  91   /**
  92    * Allows the derived class to add some more state variables to
  93    * the controller. By default does nothing, and hence is abstract
  94    *
  95    * @param CRM_Core_Controller $controller
  96    *   The controller object.
  97    */
  98   public function addValues($controller) {
  99   }
 100
 101   /**
 102    * Class constructor.
 103    *
 104    * @param string $title
 105    *   Title of the page.
 106    * @param int $mode
 107    *   Mode of the page.
 108    *
 109    * @return \CRM_Core_Page_Basic
 110    */
 111   public function __construct($title = NULL, $mode = NULL) {
 112     parent::__construct($title, $mode);
 113   }
 114
 115   /**
 116    * Run the basic page (run essentially starts execution for that page).
 117    */
 118   public function run() {
 119     // CRM-9034
 120     // do not see args or pageArgs being used, so we should
 121     // consider eliminating them in a future version
 122     $n = func_num_args();
 123     $args = ($n > 0) ? func_get_arg(0) : NULL;
 124     $pageArgs = ($n > 1) ? func_get_arg(1) : NULL;
 125     $sort = ($n > 2) ? func_get_arg(2) : NULL;
 126     // what action do we want to perform ? (store it for smarty too.. :)
 127
 128     $id = $this->getIdAndAction();
 129
 130     if ($this->_action & (CRM_Core_Action::VIEW |
 131         CRM_Core_Action::ADD |
 132         CRM_Core_Action::UPDATE |
 133         CRM_Core_Action::COPY |
 134         CRM_Core_Action::ENABLE |
 135         CRM_Core_Action::DISABLE |
 136         CRM_Core_Action::DELETE
 137       )
 138     ) {
 139       // use edit form for view, add or update or delete
 140       $this->edit($this->_action, $id);
 141     }
 142     else {
 143       // if no action or browse
 144       $this->browse(NULL, $sort);
 145     }
 146
 147     return parent::run();
 148   }
 149
 150   /**
 151    * Retrieve the action and ID from the request.
 152    *
 153    * Action is assigned to the template while we're at it.  This is pulled from
 154    * the `run()` method above.
 155    *
 156    * @return int
 157    *   The ID if present, or 0.
 158    * @throws \CRM_Core_Exception
 159    */
 160   public function getIdAndAction() {
 161     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
 162     $this->assign('action', $this->_action);
 163
 164     $this->assign('selectedChild', CRM_Utils_Request::retrieve('selectedChild', 'Alphanumeric', $this));
 165
 166     // get 'id' if present
 167     $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
 168
 169     require_once str_replace('_', DIRECTORY_SEPARATOR, $this->getBAOName()) . ".php";
 170
 171     if ($id) {
 172       if (!$this->checkPermission($id, NULL)) {
 173         CRM_Core_Error::statusBounce(ts('You do not have permission to make changes to the record'));
 174       }
 175     }
 176
 177     return $id;
 178   }
 179
 180   /**
 181    * @return string
 182    */
 183   public function superRun() {
 184     return parent::run();
 185   }
 186
 187   /**
 188    * Browse all entities.
 189    */
 190   public function browse() {
 191     $n = func_num_args();
 192     $action = ($n > 0) ? func_get_arg(0) : NULL;
 193     $sort = ($n > 0) ? func_get_arg(1) : NULL;
 194     $links = &$this->links();
 195     if ($action == NULL) {
 196       if (!empty($links)) {
 197         $action = array_sum(array_keys($links));
 198       }
 199     }
 200     if ($action & CRM_Core_Action::DISABLE) {
 201       $action -= CRM_Core_Action::DISABLE;
 202     }
 203     if ($action & CRM_Core_Action::ENABLE) {
 204       $action -= CRM_Core_Action::ENABLE;
 205     }
 206     $baoString = $this->getBAOName();
 207     $object = new $baoString();
 208
 209     $values = [];
 210
 211     // lets make sure we get the stuff sorted by name if it exists
 212     $fields = &$object->fields();
 213     $key = '';
 214     if (!empty($fields['title'])) {
 215       $key = 'title';
 216     }
 217     elseif (!empty($fields['label'])) {
 218       $key = 'label';
 219     }
 220     elseif (!empty($fields['name'])) {
 221       $key = 'name';
 222     }
 223
 224     if (trim($sort)) {
 225       $object->orderBy($sort);
 226     }
 227     elseif ($key) {
 228       $object->orderBy($key . ' asc');
 229     }
 230
 231     $contactTypes = CRM_Contact_BAO_ContactType::getSelectElements(FALSE, FALSE);
 232     // find all objects
 233     $object->find();
 234     while ($object->fetch()) {
 235       if (!isset($object->mapping_type_id) ||
 236         // "1 for Search Builder"
 237         $object->mapping_type_id != 1
 238       ) {
 239         $permission = CRM_Core_Permission::EDIT;
 240         if ($key) {
 241           $permission = $this->checkPermission($object->id, $object->$key);
 242         }
 243         if ($permission) {
 244           $values[$object->id] = [];
 245           CRM_Core_DAO::storeValues($object, $values[$object->id]);
 246
 247           if (is_a($object, 'CRM_Contact_DAO_RelationshipType')) {
 248             if (isset($values[$object->id]['contact_type_a'])) {
 249               $values[$object->id]['contact_type_a_display'] = $contactTypes[$values[$object->id]['contact_type_a']];
 250             }
 251             if (isset($values[$object->id]['contact_type_b'])) {
 252               $values[$object->id]['contact_type_b_display'] = $contactTypes[$values[$object->id]['contact_type_b']];
 253             }
 254           }
 255
 256           // populate action links
 257           $this->action($object, $action, $values[$object->id], $links, $permission);
 258
 259           if (isset($object->mapping_type_id)) {
 260             $mappintTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Mapping', 'mapping_type_id');
 261             $values[$object->id]['mapping_type'] = $mappintTypes[$object->mapping_type_id];
 262           }
 263         }
 264       }
 265     }
 266     $this->assign('rows', $values);
 267   }
 268
 269   /**
 270    * Given an object, get the actions that can be associated with this
 271    * object. Check the is_active and is_required flags to display valid
 272    * actions
 273    *
 274    * @param CRM_Core_DAO $object
 275    *   The object being considered.
 276    * @param int $action
 277    *   The base set of actions.
 278    * @param array $values
 279    *   The array of values that we send to the template.
 280    * @param array $links
 281    *   The array of links.
 282    * @param string $permission
 283    *   The permission assigned to this object.
 284    *
 285    * @param bool $forceAction
 286    */
 287   public function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
 288     $values['class'] = '';
 289     $newAction = $action;
 290     $hasDelete = $hasDisable = TRUE;
 291
 292     if (!empty($values['name']) && in_array($values['name'], [
 293       'encounter_medium',
 294       'case_type',
 295       'case_status',
 296     ])) {
 297       static $caseCount = NULL;
 298       if (!isset($caseCount)) {
 299         $caseCount = CRM_Case_BAO_Case::caseCount(NULL, FALSE);
 300       }
 301       if ($caseCount > 0) {
 302         $hasDelete = $hasDisable = FALSE;
 303       }
 304     }
 305
 306     $object_type = get_class($object);
 307
 308     if (!$forceAction) {
 309       if (property_exists($object, 'is_reserved') && $object->is_reserved) {
 310         $values['class'] = 'reserved';
 311         // check if object is relationship type
 312
 313         $exceptions = [
 314           'CRM_Contact_BAO_RelationshipType',
 315           'CRM_Core_BAO_LocationType',
 316           'CRM_Badge_BAO_Layout',
 317         ];
 318
 319         if (in_array($object_type, $exceptions)) {
 320           $newAction = CRM_Core_Action::VIEW + CRM_Core_Action::UPDATE;
 321         }
 322         else {
 323           $newAction = 0;
 324           $values['action'] = '';
 325           return;
 326         }
 327       }
 328       else {
 329         if (property_exists($object, 'is_active')) {
 330           if ($object->is_active) {
 331             if ($hasDisable) {
 332               $newAction += CRM_Core_Action::DISABLE;
 333             }
 334           }
 335           else {
 336             $newAction += CRM_Core_Action::ENABLE;
 337           }
 338         }
 339       }
 340     }
 341
 342     //CRM-4418, handling edit and delete separately.
 343     $permissions = [$permission];
 344     if ($hasDelete && ($permission == CRM_Core_Permission::EDIT)) {
 345       //previously delete was subset of edit
 346       //so for consistency lets grant delete also.
 347       $permissions[] = CRM_Core_Permission::DELETE;
 348     }
 349
 350     // make sure we only allow those actions that the user is permissioned for
 351     $newAction = $newAction & CRM_Core_Action::mask($permissions);
 352
 353     $values['action'] = CRM_Core_Action::formLink(
 354       $links,
 355       $newAction,
 356       ['id' => $object->id],
 357       'more',
 358       FALSE,
 359       "basic.$object_type.page",
 360       $object_type,
 361       $object->id
 362     );
 363   }
 364
 365   /**
 366    * Edit this entity.
 367    *
 368    * @param int $mode
 369    *   What mode for the form ?.
 370    * @param int $id
 371    *   Id of the entity (for update, view operations).
 372    *
 373    * @param bool $imageUpload
 374    * @param bool $pushUserContext
 375    */
 376   public function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) {
 377     $controller = new CRM_Core_Controller_Simple($this->editForm(),
 378       $this->editName(),
 379       $mode,
 380       $imageUpload
 381     );
 382
 383     // set the userContext stack
 384     if ($pushUserContext) {
 385       $session = CRM_Core_Session::singleton();
 386       $session->pushUserContext(CRM_Utils_System::url($this->userContext($mode), $this->userContextParams($mode)));
 387     }
 388     if ($id !== NULL) {
 389       $controller->set('id', $id);
 390     }
 391     $controller->set('BAOName', $this->getBAOName());
 392     $this->addValues($controller);
 393     $controller->setEmbedded(TRUE);
 394     $controller->process();
 395     $controller->run();
 396   }
 397
 398 }