CRM/ACL/Page/ACL.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  *
  38  * @package CRM
  39  * @copyright CiviCRM LLC (c) 2004-2014
  40  * $Id$
  41  *
  42  */
  43 class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic {
  44
  45   public $useLivePageJS = TRUE;
  46
  47   /**
  48    * The action links that we need to display for the browse screen
  49    *
  50    * @var array
  51    * @static
  52    */
  53   static $_links = NULL;
  54
  55   /**
  56    * Get BAO Name
  57    *
  58    * @return string Classname of BAO.
  59    */
  60   public function getBAOName() {
  61     return 'CRM_ACL_BAO_ACL';
  62   }
  63
  64   /**
  65    * Get action Links
  66    *
  67    * @return array (reference) of action links
  68    */
  69   public function &links() {
  70     if (!(self::$_links)) {
  71       self::$_links = array(
  72         CRM_Core_Action::UPDATE => array(
  73           'name' => ts('Edit'),
  74           'url' => 'civicrm/acl',
  75           'qs' => 'reset=1&action=update&id=%%id%%',
  76           'title' => ts('Edit ACL'),
  77         ),
  78         CRM_Core_Action::DISABLE => array(
  79           'name' => ts('Disable'),
  80           'ref' => 'crm-enable-disable',
  81           'title' => ts('Disable ACL'),
  82         ),
  83         CRM_Core_Action::ENABLE => array(
  84           'name' => ts('Enable'),
  85           'ref' => 'crm-enable-disable',
  86           'title' => ts('Enable ACL'),
  87         ),
  88         CRM_Core_Action::DELETE => array(
  89           'name' => ts('Delete'),
  90           'url' => 'civicrm/acl',
  91           'qs' => 'reset=1&action=delete&id=%%id%%',
  92           'title' => ts('Delete ACL'),
  93         ),
  94       );
  95     }
  96     return self::$_links;
  97   }
  98
  99   /**
 100    * Run the page.
 101    *
 102    * This method is called after the page is created. It checks for the
 103    * type of action and executes that action.
 104    * Finally it calls the parent's run method.
 105    *
 106    * @return void
 107    *
 108    */
 109   public function run() {
 110     // get the requested action
 111     $action = CRM_Utils_Request::retrieve('action', 'String',
 112       // default to 'browse'
 113       $this, FALSE, 'browse'
 114     );
 115
 116     // assign vars to templates
 117     $this->assign('action', $action);
 118     $id = CRM_Utils_Request::retrieve('id', 'Positive',
 119       $this, FALSE, 0
 120     );
 121
 122     // set breadcrumb to append to admin/access
 123     $breadCrumb = array(array('title' => ts('Access Control'),
 124         'url' => CRM_Utils_System::url('civicrm/admin/access',
 125           'reset=1'
 126         ),
 127       ));
 128     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 129     // what action to take ?
 130     if ($action & (CRM_Core_Action::ADD | CRM_Core_Action::DELETE)) {
 131       $this->edit($action, $id);
 132     }
 133
 134     if ($action & (CRM_Core_Action::UPDATE)) {
 135       $this->edit($action, $id);
 136
 137       if (isset($id)) {
 138         $aclName = CRM_Core_DAO::getFieldValue('CRM_ACL_DAO_ACL', $id);
 139         CRM_Utils_System::setTitle(ts('Edit ACL -  %1', array(1 => $aclName)));
 140       }
 141     }
 142
 143     // finally browse the acl's
 144     if ($action & CRM_Core_Action::BROWSE) {
 145       $this->browse();
 146     }
 147
 148     // parent run
 149     return parent::run();
 150   }
 151
 152   /**
 153    * Browse all acls
 154    *
 155    * @return void
 156    * @static
 157    */
 158   public function browse() {
 159     // get all acl's sorted by weight
 160     $acl = array();
 161     $query = "
 162   SELECT *
 163     FROM civicrm_acl
 164    WHERE ( object_table IN ( 'civicrm_saved_search', 'civicrm_uf_group', 'civicrm_custom_group', 'civicrm_event' ) )
 165 ORDER BY entity_id
 166 ";
 167     $dao = CRM_Core_DAO::executeQuery($query,
 168       CRM_Core_DAO::$_nullArray
 169     );
 170
 171     $roles = CRM_Core_OptionGroup::values('acl_role');
 172
 173     $group = array('-1' => ts('- select -'),
 174       '0' => ts('All Groups'),
 175     ) + CRM_Core_PseudoConstant::group();
 176     $customGroup = array('-1' => ts('- select -'),
 177       '0' => ts('All Custom Groups'),
 178     ) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_CustomField', 'custom_group_id');
 179     $ufGroup = array('-1' => ts('- select -'),
 180       '0' => ts('All Profiles'),
 181     ) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
 182
 183     $event = array('-1' => ts('- select -'),
 184       '0' => ts('All Events'),
 185     ) + CRM_Event_PseudoConstant::event();
 186
 187     while ($dao->fetch()) {
 188       $acl[$dao->id] = array();
 189       $acl[$dao->id]['name'] = $dao->name;
 190       $acl[$dao->id]['operation'] = $dao->operation;
 191       $acl[$dao->id]['entity_id'] = $dao->entity_id;
 192       $acl[$dao->id]['entity_table'] = $dao->entity_table;
 193       $acl[$dao->id]['object_table'] = $dao->object_table;
 194       $acl[$dao->id]['object_id'] = $dao->object_id;
 195       $acl[$dao->id]['is_active'] = $dao->is_active;
 196
 197
 198       if ($acl[$dao->id]['entity_id']) {
 199         $acl[$dao->id]['entity'] = $roles[$acl[$dao->id]['entity_id']];
 200       }
 201       else {
 202         $acl[$dao->id]['entity'] = ts('Everyone');
 203       }
 204
 205       switch ($acl[$dao->id]['object_table']) {
 206         case 'civicrm_saved_search':
 207           $acl[$dao->id]['object'] = $group[$acl[$dao->id]['object_id']];
 208           $acl[$dao->id]['object_name'] = ts('Group');
 209           break;
 210
 211         case 'civicrm_uf_group':
 212           $acl[$dao->id]['object'] = $ufGroup[$acl[$dao->id]['object_id']];
 213           $acl[$dao->id]['object_name'] = ts('Profile');
 214           break;
 215
 216         case 'civicrm_custom_group':
 217           $acl[$dao->id]['object'] = $customGroup[$acl[$dao->id]['object_id']];
 218           $acl[$dao->id]['object_name'] = ts('Custom Group');
 219           break;
 220
 221         case 'civicrm_event':
 222           $acl[$dao->id]['object'] = $event[$acl[$dao->id]['object_id']];
 223           $acl[$dao->id]['object_name'] = ts('Event');
 224           break;
 225       }
 226
 227       // form all action links
 228       $action = array_sum(array_keys($this->links()));
 229
 230       if ($dao->is_active) {
 231         $action -= CRM_Core_Action::ENABLE;
 232       }
 233       else {
 234         $action -= CRM_Core_Action::DISABLE;
 235       }
 236
 237       $acl[$dao->id]['action'] = CRM_Core_Action::formLink(
 238         self::links(),
 239         $action,
 240         array('id' => $dao->id),
 241         ts('more'),
 242         FALSE,
 243         'ACL.manage.action',
 244         'ACL',
 245         $dao->id
 246       );
 247     }
 248     $this->assign('rows', $acl);
 249   }
 250
 251   /**
 252    * Get name of edit form
 253    *
 254    * @return string Classname of edit form.
 255    */
 256   public function editForm() {
 257     return 'CRM_ACL_Form_ACL';
 258   }
 259
 260   /**
 261    * Get edit form name
 262    *
 263    * @return string name of this page.
 264    */
 265   public function editName() {
 266     return 'ACL';
 267   }
 268
 269   /**
 270    * Get user context.
 271    *
 272    * @param null $mode
 273    *
 274    * @return string user context.
 275    */
 276   public function userContext($mode = NULL) {
 277     return 'civicrm/acl';
 278   }
 279 }