CRM/Core/Action.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * The core concept of the system is an action performed on an object. Typically this will be a "data model" object
  30  * as specified in the API specs. We attempt to keep the number and type of actions consistent
  31  * and similar across all objects (thus providing both reuse and standards)
  32  *
  33  * @package CRM
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id$
  36  *
  37  */
  38 class CRM_Core_Action {
  39
  40   /**
  41    * Different possible actions are defined here. Keep in sync with the
  42    * constant from CRM_Core_Form for various modes.
  43    *
  44    * @var integer const
  45    *
  46    * @access public
  47    */
  48   CONST
  49     NONE = 0,
  50     ADD = 1,
  51     UPDATE = 2,
  52     VIEW = 4,
  53     DELETE = 8,
  54     BROWSE = 16,
  55     ENABLE = 32,
  56     DISABLE = 64,
  57     EXPORT = 128,
  58     BASIC = 256,
  59     ADVANCED = 512,
  60     PREVIEW = 1024,
  61     FOLLOWUP = 2048,
  62     MAP = 4096,
  63     PROFILE = 8192,
  64     COPY = 16384,
  65     RENEW = 32768,
  66     DETACH = 65536,
  67     REVERT = 131072,
  68     CLOSE        =  262144,
  69     REOPEN       =  524288,
  70     MAX_ACTION   = 1048575;
  71
  72   //make sure MAX_ACTION = 2^n - 1 ( n = total number of actions )
  73
  74   /**
  75    * map the action names to the relevant constant. We perform
  76    * bit manipulation operations so we can perform multiple
  77    * actions on the same object if needed
  78    *
  79    * @var array  _names  tupe of variable name to action constant
  80    *
  81    * @access private
  82    * @static
  83    *
  84    */
  85   static $_names = array(
  86     'add' => self::ADD,
  87     'update' => self::UPDATE,
  88     'view' => self::VIEW,
  89     'delete' => self::DELETE,
  90     'browse' => self::BROWSE,
  91     'enable' => self::ENABLE,
  92     'disable' => self::DISABLE,
  93     'export' => self::EXPORT,
  94     'preview' => self::PREVIEW,
  95     'map' => self::MAP,
  96     'copy' => self::COPY,
  97     'profile' => self::PROFILE,
  98     'renew' => self::RENEW,
  99     'detach' => self::DETACH,
 100     'revert' => self::REVERT,
 101                            'close'         => self::CLOSE,
 102                            'reopen'        => self::REOPEN,
 103   );
 104
 105   /**
 106    * the flipped version of the names array, initialized when used
 107    *
 108    * @var array
 109    * @static
 110    */
 111   static $_description;
 112
 113   /**
 114    *
 115    * called by the request object to translate a string into a mask
 116    *
 117    * @param $str
 118    *
 119    * @internal param string $action the action to be resolved
 120    *
 121    * @return int the action mask corresponding to the input string
 122    * @access public
 123    * @static
 124    */
 125   static function resolve($str) {
 126     $action = 0;
 127     if ($str) {
 128       $items = explode('|', $str);
 129       $action = self::map($items);
 130     }
 131     return $action;
 132   }
 133
 134   /**
 135    * Given a string or an array of strings, determine the bitmask
 136    * for this set of actions
 137    *
 138    * @param mixed either a single string or an array of strings
 139    *
 140    * @return int the action mask corresponding to the input args
 141    * @access public
 142    * @static
 143    *
 144    */
 145   static function map($item) {
 146     $mask = 0;
 147
 148     if (is_array($item)) {
 149       foreach ($item as $it) {
 150         $mask |= self::mapItem($it);
 151       }
 152       return $mask;
 153     }
 154     else {
 155       return self::mapItem($item);
 156     }
 157   }
 158
 159   /**
 160    * Given a string determine the bitmask for this specific string
 161    *
 162    * @param string the input action to process
 163    *
 164    * @return int the action mask corresponding to the input string
 165    * @access public
 166    * @static
 167    *
 168    */
 169   static function mapItem($item) {
 170     $mask = CRM_Utils_Array::value(trim($item), self::$_names);
 171     return $mask ? $mask : 0;
 172   }
 173
 174   /**
 175    *
 176    * Given an action mask, find the corresponding description
 177    *
 178    * @param int the action mask
 179    *
 180    * @return string the corresponding action description
 181    * @access public
 182    * @static
 183    *
 184    */
 185   static function description($mask) {
 186     if (!isset($_description)) {
 187       self::$_description = array_flip(self::$_names);
 188     }
 189
 190     return CRM_Utils_Array::value($mask, self::$_description, 'NO DESCRIPTION SET');
 191   }
 192
 193   /**
 194    * given a set of links and a mask, return the html action string for
 195    * the links associated with the mask
 196    *
 197    * @param array $links the set of link items
 198    * @param int $mask the mask to be used. a null mask means all items
 199    * @param array $values the array of values for parameter substitution in the link items
 200    * @param string $extraULName enclosed extra links in this UL.
 201    * @param boolean $enclosedAllInSingleUL force to enclosed all links in single UL.
 202    *
 203    * @param null $op
 204    * @param null $objectName
 205    * @param null $objectId
 206    *
 207    * @return string       the html string
 208    * @access public
 209    * @static
 210    */
 211   static function formLink($links,
 212     $mask,
 213     $values,
 214     $extraULName = 'more',
 215     $enclosedAllInSingleUL = FALSE,
 216     $op = NULL,
 217     $objectName = NULL,
 218     $objectId = NULL
 219   ) {
 220     $config = CRM_Core_Config::singleton();
 221     if (empty($links)) {
 222       return NULL;
 223     }
 224
 225     // make links indexed sequentially instead of by bitmask
 226     // otherwise it's next to impossible to reliably add new ones
 227     $seqLinks = array();
 228     foreach ($links as $bit => $link) {
 229       $link['bit'] = $bit;
 230       $seqLinks[] = $link;
 231     }
 232
 233     if ($op && $objectName && $objectId) {
 234       CRM_Utils_Hook::links($op, $objectName, $objectId, $seqLinks, $mask, $values);
 235     }
 236
 237     $url = array();
 238
 239     foreach ($seqLinks as $i => $link) {
 240       if (!$mask || !array_key_exists('bit', $link) || ($mask & $link['bit'])) {
 241         $extra = isset($link['extra']) ? self::replace($link['extra'], $values) : NULL;
 242
 243         $frontend = (isset($link['fe'])) ? TRUE : FALSE;
 244
 245         if (isset($link['qs']) && !CRM_Utils_System::isNull($link['qs'])) {
 246           $urlPath = CRM_Utils_System::url(self::replace($link['url'], $values),
 247             self::replace($link['qs'], $values), TRUE, NULL, TRUE, $frontend
 248           );
 249         }
 250         else {
 251           $urlPath = CRM_Utils_Array::value('url', $link, '#');
 252         }
 253
 254         $classes = 'action-item crm-hover-button';
 255         if (isset($link['ref'])) {
 256           $classes .= ' ' . strtolower($link['ref']);
 257         }
 258
 259         //get the user specified classes in.
 260         if (isset($link['class'])) {
 261           $className = is_array($link['class']) ? implode(' ', $link['class']) : $link['class'];
 262           $classes .= ' ' . strtolower($className);
 263         }
 264
 265         if ($urlPath !== '#' && $frontend) {
 266           $extra .= ' target="_blank"';
 267         }
 268         // Hack to make delete dialogs smaller
 269         if (strpos($urlPath, '/delete') || strpos($urlPath, 'action=delete')) {
 270           $classes .= " small-popup";
 271         }
 272         $url[] = sprintf('<a href="%s" class="%s" %s' . $extra . '>%s</a>',
 273           $urlPath,
 274           $classes,
 275           !empty($link['title']) ? "title='{$link['title']}' " : '',
 276           $link['name']
 277         );
 278       }
 279     }
 280
 281
 282     $mainLinks = $url;
 283     if ($enclosedAllInSingleUL) {
 284       $allLinks = '';
 285       CRM_Utils_String::append($allLinks, '</li><li>', $mainLinks);
 286       $allLinks = "{$extraULName}<ul class='panel'><li>{$allLinks}</li></ul>";
 287       $result = "<span class='btn-slide crm-hover-button'>{$allLinks}</span>";
 288     }
 289     else {
 290       $extra = '';
 291       $extraLinks = array_splice($url, 2);
 292       if (count($extraLinks) > 1) {
 293         $mainLinks = array_slice($url, 0, 2);
 294         CRM_Utils_String::append($extra, '</li><li>', $extraLinks);
 295         $extra = "{$extraULName}<ul class='panel'><li>{$extra}</li></ul>";
 296       }
 297       $resultLinks = '';
 298       CRM_Utils_String::append($resultLinks, '', $mainLinks);
 299       if ($extra) {
 300         $result = "<span>{$resultLinks}</span><span class='btn-slide crm-hover-button'>{$extra}</span>";
 301       }
 302       else {
 303         $result = "<span>{$resultLinks}</span>";
 304       }
 305     }
 306
 307     return $result;
 308   }
 309
 310   /**
 311    * given a string and an array of values, substitute the real values
 312    * in the placeholder in the str in the CiviCRM format
 313    *
 314    * @param string $str    the string to be replaced
 315    * @param array  $values the array of values for parameter substitution in the str
 316    *
 317    * @return string        the substituted string
 318    * @access public
 319    * @static
 320    */
 321   static function &replace(&$str, &$values) {
 322     foreach ($values as $n => $v) {
 323       $str = str_replace("%%$n%%", $v, $str);
 324     }
 325     return $str;
 326   }
 327
 328   /**
 329    * get the mask for a permission (view, edit or null)
 330    *
 331    * @param string the permission
 332    *
 333    * @return int   the mask for the above permission
 334    * @static
 335    * @access public
 336    */
 337   static function mask($permissions) {
 338     $mask = NULL;
 339     if (!is_array($permissions) || CRM_Utils_System::isNull($permissions)) {
 340       return $mask;
 341     }
 342     //changed structure since we are handling delete separately - CRM-4418
 343     if (in_array(CRM_Core_Permission::VIEW, $permissions)) {
 344       $mask |= self::VIEW | self::EXPORT | self::BASIC | self::ADVANCED | self::BROWSE | self::MAP | self::PROFILE;
 345     }
 346     if (in_array(CRM_Core_Permission::DELETE, $permissions)) {
 347       $mask |= self::DELETE;
 348     }
 349     if (in_array(CRM_Core_Permission::EDIT, $permissions)) {
 350       //make sure we make self::MAX_ACTION = 2^n - 1
 351       //if we add more actions; ( n = total number of actions )
 352       $mask |= (self::MAX_ACTION & ~self::DELETE);
 353     }
 354
 355     return $mask;
 356   }
 357 }
 358