CRM/Group/Form/Edit.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 /**
  35  * This class is to build the form for adding Group.
  36  */
  37 class CRM_Group_Form_Edit extends CRM_Core_Form {
  38
  39   /**
  40    * The group id, used when editing a group
  41    *
  42    * @var int
  43    */
  44   protected $_id;
  45
  46   /**
  47    * The group object, if an id is present
  48    *
  49    * @var object
  50    */
  51   protected $_group;
  52
  53   /**
  54    * The title of the group being deleted
  55    *
  56    * @var string
  57    */
  58   protected $_title;
  59
  60   /**
  61    * Store the group values
  62    *
  63    * @var array
  64    */
  65   protected $_groupValues;
  66
  67   /**
  68    * What blocks should we show and hide.
  69    *
  70    * @var CRM_Core_ShowHideBlocks
  71    */
  72   protected $_showHide;
  73
  74   /**
  75    * The civicrm_group_organization table id
  76    *
  77    * @var int
  78    */
  79   protected $_groupOrganizationID;
  80
  81   /**
  82    * Set up variables to build the form.
  83    */
  84   public function preProcess() {
  85     $this->_id = $this->get('id');
  86     if ($this->_id) {
  87       $breadCrumb = array(
  88         array(
  89           'title' => ts('Manage Groups'),
  90           'url' => CRM_Utils_System::url('civicrm/group',
  91             'reset=1'
  92           ),
  93         ),
  94       );
  95       CRM_Utils_System::appendBreadCrumb($breadCrumb);
  96
  97       $this->_groupValues = array();
  98       $params = array('id' => $this->_id);
  99       $this->_group = CRM_Contact_BAO_Group::retrieve($params, $this->_groupValues);
 100       $this->_title = $this->_groupValues['title'];
 101     }
 102
 103     $this->assign('action', $this->_action);
 104     $this->assign('showBlockJS', TRUE);
 105
 106     if ($this->_action == CRM_Core_Action::DELETE) {
 107       if (isset($this->_id)) {
 108         $this->assign('title', $this->_title);
 109         $this->assign('count', CRM_Contact_BAO_Group::memberCount($this->_id));
 110         CRM_Utils_System::setTitle(ts('Confirm Group Delete'));
 111       }
 112       if ($this->_groupValues['is_reserved'] == 1 && !CRM_Core_Permission::check('administer reserved groups')) {
 113         CRM_Core_Error::statusBounce(ts("You do not have sufficient permission to delete this reserved group."));
 114       }
 115     }
 116     else {
 117       if ($this->_groupValues['is_reserved'] == 1 && !CRM_Core_Permission::check('administer reserved groups')) {
 118         CRM_Core_Error::statusBounce(ts("You do not have sufficient permission to change settings for this reserved group."));
 119       }
 120       if (isset($this->_id)) {
 121         $groupValues = array(
 122           'id' => $this->_id,
 123           'title' => $this->_title,
 124           'saved_search_id' => isset($this->_groupValues['saved_search_id']) ? $this->_groupValues['saved_search_id'] : '',
 125         );
 126         if (isset($this->_groupValues['saved_search_id'])) {
 127           $groupValues['mapping_id'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch',
 128             $this->_groupValues['saved_search_id'],
 129             'mapping_id'
 130           );
 131           $groupValues['search_custom_id'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch',
 132             $this->_groupValues['saved_search_id'],
 133             'search_custom_id'
 134           );
 135         }
 136         if (!empty($this->_groupValues['created_id'])) {
 137           $groupValues['created_by'] = CRM_Core_DAO::getFieldValue("CRM_Contact_DAO_Contact", $this->_groupValues['created_id'], 'sort_name', 'id');
 138         }
 139
 140         if (!empty($this->_groupValues['modified_id'])) {
 141           $groupValues['modified_by'] = CRM_Core_DAO::getFieldValue("CRM_Contact_DAO_Contact", $this->_groupValues['modified_id'], 'sort_name', 'id');
 142         }
 143
 144         $this->assign_by_ref('group', $groupValues);
 145
 146         CRM_Utils_System::setTitle(ts('Group Settings: %1', array(1 => $this->_title)));
 147       }
 148       $session = CRM_Core_Session::singleton();
 149       $session->pushUserContext(CRM_Utils_System::url('civicrm/group', 'reset=1'));
 150     }
 151
 152     //build custom data
 153     CRM_Custom_Form_CustomData::preProcess($this, NULL, NULL, 1, 'Group', $this->_id);
 154   }
 155
 156   /**
 157    * Set default values for the form.
 158    *
 159    * @return array
 160    */
 161   public function setDefaultValues() {
 162     $defaults = array();
 163     if (isset($this->_id)) {
 164       $defaults = $this->_groupValues;
 165       if (!empty($defaults['group_type'])) {
 166         $types = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 167           substr($defaults['group_type'], 1, -1)
 168         );
 169         $defaults['group_type'] = array();
 170         foreach ($types as $type) {
 171           $defaults['group_type'][$type] = 1;
 172         }
 173       }
 174
 175       if (CRM_Core_Permission::check('administer Multiple Organizations') && CRM_Core_Permission::isMultisiteEnabled()) {
 176         CRM_Contact_BAO_GroupOrganization::retrieve($this->_id, $defaults);
 177       }
 178     } else {
 179       $defaults['is_active'] = 1;
 180     }
 181
 182     if (!((CRM_Core_Permission::check('access CiviMail')) ||
 183       (CRM_Mailing_Info::workflowEnabled() &&
 184         CRM_Core_Permission::check('create mailings')
 185       )
 186     )
 187     ) {
 188       $groupTypes = CRM_Core_OptionGroup::values('group_type', TRUE);
 189       if ($defaults['group_type'][$groupTypes['Mailing List']] == 1) {
 190         $this->assign('freezeMailignList', $groupTypes['Mailing List']);
 191       }
 192       else {
 193         $this->assign('hideMailignList', $groupTypes['Mailing List']);
 194       }
 195     }
 196
 197     if (empty($defaults['parents'])) {
 198       $defaults['parents'] = CRM_Core_BAO_Domain::getGroupId();
 199     }
 200
 201     // custom data set defaults
 202     $defaults += CRM_Custom_Form_CustomData::setDefaultValues($this);
 203     return $defaults;
 204   }
 205
 206   /**
 207    * Build the form object.
 208    */
 209   public function buildQuickForm() {
 210     if ($this->_action == CRM_Core_Action::DELETE) {
 211       $this->addButtons(array(
 212           array(
 213             'type' => 'next',
 214             'name' => ts('Delete Group'),
 215             'isDefault' => TRUE,
 216           ),
 217           array(
 218             'type' => 'cancel',
 219             'name' => ts('Cancel'),
 220           ),
 221         )
 222       );
 223       return;
 224     }
 225
 226     // We want the "new group" form to redirect the user
 227     if ($this->_action == CRM_Core_Action::ADD) {
 228       $this->preventAjaxSubmit();
 229     }
 230
 231     $this->applyFilter('__ALL__', 'trim');
 232     $this->add('text', 'title', ts('Name') . ' ',
 233       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Group', 'title'), TRUE
 234     );
 235
 236     $this->add('textarea', 'description', ts('Description') . ' ',
 237       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Group', 'description')
 238     );
 239
 240     $groupTypes = CRM_Core_OptionGroup::values('group_type', TRUE);
 241
 242     if (isset($this->_id) && !empty($this->_groupValues['saved_search_id'])) {
 243       unset($groupTypes['Access Control']);
 244     }
 245
 246     if (!empty($groupTypes)) {
 247       $this->addCheckBox('group_type',
 248         ts('Group Type'),
 249         $groupTypes,
 250         NULL, NULL, NULL, NULL, '&nbsp;&nbsp;&nbsp;'
 251       );
 252     }
 253
 254     $this->add('select', 'visibility', ts('Visibility'), CRM_Core_SelectValues::groupVisibility(), TRUE);
 255
 256     //CRM-14190
 257     $parentGroups = self::buildParentGroups($this);
 258     self::buildGroupOrganizations($this);
 259
 260     // is_reserved property CRM-9936
 261     $this->addElement('checkbox', 'is_reserved', ts('Reserved Group?'));
 262     if (!CRM_Core_Permission::check('administer reserved groups')) {
 263       $this->freeze('is_reserved');
 264     }
 265     $this->addElement('checkbox', 'is_active', ts('Is active?'));
 266
 267     //build custom data
 268     CRM_Custom_Form_CustomData::buildQuickForm($this);
 269
 270     $this->addButtons(array(
 271         array(
 272           'type' => 'upload',
 273           'name' => ($this->_action == CRM_Core_Action::ADD) ? ts('Continue') : ts('Save'),
 274           'isDefault' => TRUE,
 275         ),
 276         array(
 277           'type' => 'cancel',
 278           'name' => ts('Cancel'),
 279         ),
 280       )
 281     );
 282
 283     $doParentCheck = FALSE;
 284     if (CRM_Core_Permission::isMultisiteEnabled()) {
 285       $doParentCheck = ($this->_id && CRM_Core_BAO_Domain::isDomainGroup($this->_id)) ? FALSE : TRUE;
 286     }
 287
 288     $options = array(
 289       'selfObj' => $this,
 290       'parentGroups' => $parentGroups,
 291       'doParentCheck' => $doParentCheck,
 292     );
 293     $this->addFormRule(array('CRM_Group_Form_Edit', 'formRule'), $options);
 294   }
 295
 296   /**
 297    * Global validation rules for the form.
 298    *
 299    * @param array $fields
 300    *   Posted values of the form.
 301    * @param array $fileParams
 302    * @param array $options
 303    *
 304    * @return array
 305    *   list of errors to be posted back to the form
 306    */
 307   public static function formRule($fields, $fileParams, $options) {
 308     $errors = array();
 309
 310     $doParentCheck = $options['doParentCheck'];
 311     $self = &$options['selfObj'];
 312
 313     if ($doParentCheck) {
 314       $parentGroups = $options['parentGroups'];
 315
 316       $grpRemove = 0;
 317       foreach ($fields as $key => $val) {
 318         if (substr($key, 0, 20) == 'remove_parent_group_') {
 319           $grpRemove++;
 320         }
 321       }
 322
 323       $grpAdd = 0;
 324       if (!empty($fields['parents'])) {
 325         $grpAdd++;
 326       }
 327
 328       if ((count($parentGroups) >= 1) && (($grpRemove - $grpAdd) >= count($parentGroups))) {
 329         $errors['parents'] = ts('Make sure at least one parent group is set.');
 330       }
 331     }
 332
 333     // do check for both name and title uniqueness
 334     if (!empty($fields['title'])) {
 335       $title = trim($fields['title']);
 336       $query = "
 337 SELECT count(*)
 338 FROM   civicrm_group
 339 WHERE  title = %1
 340 ";
 341       $params = array(1 => array($title, 'String'));
 342
 343       if ($self->_id) {
 344         $query .= "AND id <> %2";
 345         $params[2] = array($self->_id, 'Integer');
 346       }
 347
 348       $grpCnt = CRM_Core_DAO::singleValueQuery($query, $params);
 349       if ($grpCnt) {
 350         $errors['title'] = ts('Group \'%1\' already exists.', array(1 => $fields['title']));
 351       }
 352     }
 353
 354     return empty($errors) ? TRUE : $errors;
 355   }
 356
 357   /**
 358    * Process the form when submitted.
 359    */
 360   public function postProcess() {
 361     CRM_Utils_System::flushCache('CRM_Core_DAO_Group');
 362
 363     $updateNestingCache = FALSE;
 364     if ($this->_action & CRM_Core_Action::DELETE) {
 365       CRM_Contact_BAO_Group::discard($this->_id);
 366       CRM_Core_Session::setStatus(ts("The Group '%1' has been deleted.", array(1 => $this->_title)), ts('Group Deleted'), 'success');
 367       $updateNestingCache = TRUE;
 368     }
 369     else {
 370       // store the submitted values in an array
 371       $params = $this->controller->exportValues($this->_name);
 372       if ($this->_action & CRM_Core_Action::UPDATE) {
 373         $params['id'] = $this->_id;
 374       }
 375
 376       if ($this->_action & CRM_Core_Action::UPDATE && isset($this->_groupOrganizationID)) {
 377         $params['group_organization'] = $this->_groupOrganizationID;
 378       }
 379
 380       $params['is_reserved'] = CRM_Utils_Array::value('is_reserved', $params, FALSE);
 381       $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 382       $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 383         $this->_id,
 384         'Group'
 385       );
 386
 387       $group = CRM_Contact_BAO_Group::create($params);
 388
 389       //Remove any parent groups requested to be removed
 390       if (!empty($this->_groupValues['parents'])) {
 391         $parentGroupIds = explode(',', $this->_groupValues['parents']);
 392         foreach ($parentGroupIds as $parentGroupId) {
 393           if (isset($params["remove_parent_group_$parentGroupId"])) {
 394             CRM_Contact_BAO_GroupNesting::remove($parentGroupId, $group->id);
 395             $updateNestingCache = TRUE;
 396           }
 397         }
 398       }
 399
 400       CRM_Core_Session::setStatus(ts('The Group \'%1\' has been saved.', array(1 => $group->title)), ts('Group Saved'), 'success');
 401
 402       // Add context to the session, in case we are adding members to the group
 403       if ($this->_action & CRM_Core_Action::ADD) {
 404         $this->set('context', 'amtg');
 405         $this->set('amtgID', $group->id);
 406
 407         $session = CRM_Core_Session::singleton();
 408         $session->pushUserContext(CRM_Utils_System::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id));
 409       }
 410     }
 411
 412     // update the nesting cache
 413     if ($updateNestingCache) {
 414       CRM_Contact_BAO_GroupNestingCache::update();
 415     }
 416   }
 417
 418   /**
 419    * Build parent groups form elements.
 420    *
 421    * @param CRM_Core_Form $form
 422    *
 423    * @return array
 424    *   parent groups
 425    */
 426   public static function buildParentGroups(&$form) {
 427     $groupNames = CRM_Core_PseudoConstant::group();
 428     $parentGroups = $parentGroupElements = array();
 429     if (isset($form->_id) && !empty($form->_groupValues['parents'])) {
 430       $parentGroupIds = explode(',', $form->_groupValues['parents']);
 431       foreach ($parentGroupIds as $parentGroupId) {
 432         $parentGroups[$parentGroupId] = $groupNames[$parentGroupId];
 433         if (array_key_exists($parentGroupId, $groupNames)) {
 434           $parentGroupElements[$parentGroupId] = $groupNames[$parentGroupId];
 435           $form->addElement('checkbox', "remove_parent_group_$parentGroupId",
 436             $groupNames[$parentGroupId]
 437           );
 438         }
 439       }
 440     }
 441     $form->assign_by_ref('parent_groups', $parentGroupElements);
 442
 443     if (isset($form->_id)) {
 444       $potentialParentGroupIds = CRM_Contact_BAO_GroupNestingCache::getPotentialCandidates($form->_id, $groupNames);
 445     }
 446     else {
 447       $potentialParentGroupIds = array_keys($groupNames);
 448     }
 449
 450     $parentGroupSelectValues = array('' => '- ' . ts('select group') . ' -');
 451     foreach ($potentialParentGroupIds as $potentialParentGroupId) {
 452       if (array_key_exists($potentialParentGroupId, $groupNames)) {
 453         $parentGroupSelectValues[$potentialParentGroupId] = $groupNames[$potentialParentGroupId];
 454       }
 455     }
 456
 457     if (count($parentGroupSelectValues) > 1) {
 458       if (CRM_Core_Permission::isMultisiteEnabled()) {
 459         $required = !isset($form->_id) || ($form->_id && CRM_Core_BAO_Domain::isDomainGroup($form->_id)) ? FALSE : empty($parentGroups);
 460       }
 461       else {
 462         $required = FALSE;
 463       }
 464       $form->add('select', 'parents', ts('Add Parent'), $parentGroupSelectValues, $required, array('class' => 'crm-select2'));
 465     }
 466
 467     return $parentGroups;
 468   }
 469
 470   /**
 471    * Add the group organization checkbox to the form.
 472    *
 473    * Note this was traditionally a multisite thing - there is no particular reason why it is not available
 474    * as a general field - it's historical use-case driven.
 475    *
 476    * @param CRM_Core_Form $form
 477    */
 478   public static function buildGroupOrganizations(&$form) {
 479     if (CRM_Core_Permission::check('administer Multiple Organizations') && CRM_Core_Permission::isMultisiteEnabled()) {
 480       //group organization Element
 481       $props = array('api' => array('params' => array('contact_type' => 'Organization')));
 482       $form->addEntityRef('organization_id', ts('Organization'), $props);
 483     }
 484   }
 485
 486 }