CRM/Contact/BAO/Group.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.4                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group {
  36
  37   /**
  38    * class constructor
  39    */
  40   function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * Takes a bunch of params that are needed to match certain criteria and
  46    * retrieves the relevant objects. Typically the valid params are only
  47    * group_id. We'll tweak this function to be more full featured over a period
  48    * of time. This is the inverse function of create. It also stores all the retrieved
  49    * values in the default array
  50    *
  51    * @param array $params   (reference ) an assoc array of name/value pairs
  52    * @param array $defaults (reference ) an assoc array to hold the flattened values
  53    *
  54    * @return object CRM_Contact_BAO_Group object
  55    * @access public
  56    * @static
  57    */
  58   static function retrieve(&$params, &$defaults) {
  59     $group = new CRM_Contact_DAO_Group();
  60     $group->copyValues($params);
  61     if ($group->find(TRUE)) {
  62       CRM_Core_DAO::storeValues($group, $defaults);
  63       return $group;
  64     }
  65
  66     return NULL;
  67   }
  68
  69   /**
  70    * Function to delete the group and all the object that connect to
  71    * this group. Incredibly destructive
  72    *
  73    * @param int $id group id
  74    *
  75    * @return null
  76    * @access public
  77    * @static
  78    *
  79    */
  80   static function discard($id) {
  81     CRM_Utils_Hook::pre('delete', 'Group', $id, CRM_Core_DAO::$_nullArray);
  82
  83     $transaction = new CRM_Core_Transaction();
  84
  85     // added for CRM-1631 and CRM-1794
  86     // delete all subscribed mails with the selected group id
  87     $subscribe = new CRM_Mailing_Event_DAO_Subscribe();
  88     $subscribe->group_id = $id;
  89     $subscribe->delete();
  90
  91     // delete all Subscription  records with the selected group id
  92     $subHistory = new CRM_Contact_DAO_SubscriptionHistory();
  93     $subHistory->group_id = $id;
  94     $subHistory->delete();
  95
  96     // delete all crm_group_contact records with the selected group id
  97     $groupContact = new CRM_Contact_DAO_GroupContact();
  98     $groupContact->group_id = $id;
  99     $groupContact->delete();
 100
 101     // make all the 'add_to_group_id' field of 'civicrm_uf_group table', pointing to this group, as null
 102     $params = array(1 => array($id, 'Integer'));
 103     $query = "UPDATE civicrm_uf_group SET `add_to_group_id`= NULL WHERE `add_to_group_id` = %1";
 104     CRM_Core_DAO::executeQuery($query, $params);
 105
 106     $query = "UPDATE civicrm_uf_group SET `limit_listings_group_id`= NULL WHERE `limit_listings_group_id` = %1";
 107     CRM_Core_DAO::executeQuery($query, $params);
 108
 109     // make sure u delete all the entries from civicrm_mailing_group and civicrm_campaign_group
 110     // CRM-6186
 111     $query = "DELETE FROM civicrm_mailing_group where entity_table = 'civicrm_group' AND entity_id = %1";
 112     CRM_Core_DAO::executeQuery($query, $params);
 113
 114     $query = "DELETE FROM civicrm_campaign_group where entity_table = 'civicrm_group' AND entity_id = %1";
 115     CRM_Core_DAO::executeQuery($query, $params);
 116
 117     $query = "DELETE FROM civicrm_acl_entity_role where entity_table = 'civicrm_group' AND entity_id = %1";
 118     CRM_Core_DAO::executeQuery($query, $params);
 119
 120     if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
 121         'is_enabled'
 122       )) {
 123       // clear any descendant groups cache if exists
 124       $finalGroups = CRM_Core_BAO_Cache::deleteGroup('descendant groups for an org');
 125     }
 126
 127     // delete from group table
 128     $group = new CRM_Contact_DAO_Group();
 129     $group->id = $id;
 130     $group->delete();
 131
 132     $transaction->commit();
 133
 134     CRM_Utils_Hook::post('delete', 'Group', $id, $group);
 135
 136     // delete the recently created Group
 137     $groupRecent = array(
 138       'id' => $id,
 139       'type' => 'Group',
 140     );
 141     CRM_Utils_Recent::del($groupRecent);
 142   }
 143
 144   /**
 145    * Returns an array of the contacts in the given group.
 146    *
 147    */
 148   static function getGroupContacts($id) {
 149     $params = array(array('group', 'IN', array($id => 1), 0, 0));
 150     list($contacts, $_) = CRM_Contact_BAO_Query::apiQuery($params, array('contact_id'));
 151     return $contacts;
 152   }
 153
 154   /**
 155    * Get the count of a members in a group with the specific status
 156    *
 157    * @param int $id      group id
 158    * @param enum $status status of members in group
 159    *
 160    * @return int count of members in the group with above status
 161    * @access public
 162    */
 163   static function memberCount($id, $status = 'Added', $countChildGroups = FALSE) {
 164     $groupContact = new CRM_Contact_DAO_GroupContact();
 165     $groupIds = array($id);
 166     if ($countChildGroups) {
 167       $groupIds = CRM_Contact_BAO_GroupNesting::getDescendentGroupIds($groupIds);
 168     }
 169     $count = 0;
 170
 171     $contacts = self::getGroupContacts($id);
 172
 173     foreach ($groupIds as $groupId) {
 174
 175       $groupContacts = self::getGroupContacts($groupId);
 176       foreach ($groupContacts as $gcontact) {
 177         if ($groupId != $id) {
 178           // Loop through main group's contacts
 179           // and subtract from the count for each contact which
 180           // matches one in the present group, if it is not the
 181           // main group
 182           foreach ($contacts as $contact) {
 183             if ($contact['contact_id'] == $gcontact['contact_id']) {
 184               $count--;
 185             }
 186           }
 187         }
 188       }
 189       $groupContact->group_id = $groupId;
 190       if (isset($status)) {
 191         $groupContact->status = $status;
 192       }
 193       $groupContact->_query['condition'] = 'WHERE contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)';
 194       $count += $groupContact->count();
 195     }
 196     return $count;
 197   }
 198
 199   /**
 200    * Get the list of member for a group id
 201    *
 202    * @param int $lngGroupId this is group id
 203    *
 204    * @return array $aMembers this arrray contains the list of members for this group id
 205    * @access public
 206    * @static
 207    */
 208   static function &getMember($groupID, $useCache = TRUE) {
 209     $params = array(array('group', 'IN', array($groupID => 1), 0, 0));
 210     $returnProperties = array('contact_id');
 211     list($contacts, $_) = CRM_Contact_BAO_Query::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, $useCache);
 212
 213     $aMembers = array();
 214     foreach ($contacts as $contact) {
 215       $aMembers[$contact['contact_id']] = 1;
 216     }
 217
 218     return $aMembers;
 219   }
 220
 221   /**
 222    * Returns array of group object(s) matching a set of one or Group properties.
 223    *
 224    * @param array       $param             Array of one or more valid property_name=>value pairs.
 225    *                                       Limits the set of groups returned.
 226    * @param array       $returnProperties  Which properties should be included in the returned group objects.
 227    *                                       (member_count should be last element.)
 228    *
 229    * @return  An array of group objects.
 230    *
 231    * @access public
 232    *
 233    * @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and
 234    * add in essential fields (e.g. id). This should follow a regular pattern like the others
 235    */
 236   static function getGroups(
 237     $params = NULL,
 238     $returnProperties = NULL,
 239     $sort = NULL,
 240     $offset = NULL,
 241     $rowCount = NULL
 242   ) {
 243     $dao = new CRM_Contact_DAO_Group();
 244     if (!isset($params['is_active'])) {
 245       $dao->is_active = 1;
 246     }
 247     if ($params) {
 248       foreach ($params as $k => $v) {
 249         if ($k == 'name' || $k == 'title') {
 250           $dao->whereAdd($k . ' LIKE "' . CRM_Core_DAO::escapeString($v) . '"');
 251         }
 252         elseif ($k == 'group_type') {
 253           foreach ((array) $v as $type) {
 254             $dao->whereAdd($k . " LIKE '%" . CRM_Core_DAO::VALUE_SEPARATOR . (int) $type . CRM_Core_DAO::VALUE_SEPARATOR . "%'");
 255           }
 256         }
 257         elseif (is_array($v)) {
 258           foreach ($v as &$num) {
 259             $num = (int) $num;
 260           }
 261           $dao->whereAdd($k . ' IN (' . implode(',', $v) . ')');
 262         }
 263         else {
 264           $dao->$k = $v;
 265         }
 266       }
 267     }
 268
 269     if ($offset || $rowCount) {
 270       $offset = ($offset > 0) ? $offset : 0;
 271       $rowCount = ($rowCount > 0) ? $rowCount : 25;
 272       $dao->limit($offset, $rowCount);
 273     }
 274
 275     if ($sort) {
 276       $dao->orderBy($sort);
 277     }
 278
 279     // return only specific fields if returnproperties are sent
 280     if (!empty($returnProperties)) {
 281       $dao->selectAdd();
 282       $dao->selectAdd(implode(',', $returnProperties));
 283     }
 284     $dao->find();
 285
 286     $flag = $returnProperties && in_array('member_count', $returnProperties) ? 1 : 0;
 287
 288     $groups = array();
 289     while ($dao->fetch()) {
 290       $group = new CRM_Contact_DAO_Group();
 291       if ($flag) {
 292         $dao->member_count = CRM_Contact_BAO_Group::memberCount($dao->id);
 293       }
 294       $groups[] = clone($dao);
 295     }
 296     return $groups;
 297   }
 298
 299   /**
 300    * make sure that the user has permission to access this group
 301    *
 302    * @param int $id   the id of the object
 303    *
 304    * @return string   the permission that the user has (or null)
 305    * @access public
 306    * @static
 307    */
 308   static function checkPermission($id) {
 309     $allGroups = CRM_Core_PseudoConstant::allGroup();
 310
 311     $permissions = NULL;
 312     if (CRM_Core_Permission::check('edit all contacts') ||
 313       CRM_ACL_API::groupPermission(CRM_ACL_API::EDIT, $id, NULL,
 314         'civicrm_saved_search', $allGroups
 315       )
 316     ) {
 317       $permissions[] = CRM_Core_Permission::EDIT;
 318     }
 319
 320     if (CRM_Core_Permission::check('view all contacts') ||
 321       CRM_ACL_API::groupPermission(CRM_ACL_API::VIEW, $id, NULL,
 322         'civicrm_saved_search', $allGroups
 323       )
 324     ) {
 325       $permissions[] = CRM_Core_Permission::VIEW;
 326     }
 327
 328     if (!empty($permissions) && CRM_Core_Permission::check('delete contacts')) {
 329       // Note: using !empty() in if condition, restricts the scope of delete
 330       // permission to groups/contacts that are editable/viewable.
 331       // We can remove this !empty condition once we have ACL support for delete functionality.
 332       $permissions[] = CRM_Core_Permission::DELETE;
 333     }
 334
 335     return $permissions;
 336   }
 337
 338   /**
 339    * Create a new group
 340    *
 341    * @param array $params     Associative array of parameters
 342    *
 343    * @return object|null      The new group BAO (if created)
 344    * @access public
 345    * @static
 346    */
 347   public static function &create(&$params) {
 348
 349     if (!empty($params['id'])) {
 350       CRM_Utils_Hook::pre('edit', 'Group', $params['id'], $params);
 351     }
 352     else {
 353       CRM_Utils_Hook::pre('create', 'Group', NULL, $params);
 354     }
 355
 356     // form the name only if missing: CRM-627
 357     $nameParam = CRM_Utils_Array::value('name', $params, NULL);
 358     if (!$nameParam && empty($params['id'])) {
 359       $params['name'] = CRM_Utils_String::titleToVar($params['title']);
 360     }
 361
 362     // convert params if array type
 363     if (isset($params['group_type'])) {
 364       if (is_array($params['group_type'])) {
 365         $params['group_type'] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
 366           array_keys($params['group_type'])
 367         ) . CRM_Core_DAO::VALUE_SEPARATOR;
 368       }
 369     }
 370     else {
 371       $params['group_type'] = '';
 372     }
 373
 374     $session = CRM_Core_Session::singleton( );
 375     $cid = $session->get('userID');
 376     // this action is add
 377     if ($cid && empty($params['id'])) {
 378       $params['created_id'] = $cid;
 379     }
 380     // this action is update
 381     if ($cid && !empty($params['id'])) {
 382       $params['modified_id'] = $cid;
 383     }
 384
 385     $group = new CRM_Contact_BAO_Group();
 386     $group->copyValues($params);
 387     //@todo very hacky fix for the fact this function wants to receive 'parents' as an array further down but
 388     // needs it as a separated string for the DB. Preferred approaches are having the copyParams or save fn
 389     // use metadata to translate the array to the appropriate DB type or altering the param in the api layer,
 390     // or at least altering the param in same section as 'group_type' rather than repeating here. However, further down
 391     // we need the $params one to be in it's original form & we are not sure what test coverage we have on that
 392     if(isset($group->parents) && is_array($group->parents)) {
 393       $group->parents = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
 394         array_keys($group->parents)
 395       ) . CRM_Core_DAO::VALUE_SEPARATOR;
 396     }
 397     if (empty($params['id']) &&
 398       !$nameParam
 399     ) {
 400       $group->name .= "_tmp";
 401     }
 402     $group->save();
 403
 404     if (!$group->id) {
 405       return NULL;
 406     }
 407
 408     if (empty($params['id']) &&
 409       !$nameParam
 410     ) {
 411       $group->name = substr($group->name, 0, -4) . "_{$group->id}";
 412     }
 413
 414     $group->buildClause();
 415     $group->save();
 416
 417     // add custom field values
 418     if (!empty($params['custom'])) {
 419       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_group', $group->id);
 420     }
 421
 422     // make the group, child of domain/site group by default.
 423     $domainGroupID = CRM_Core_BAO_Domain::getGroupId();
 424     if (CRM_Utils_Array::value('no_parent', $params) !== 1) {
 425       if (empty($params['parents']) &&
 426         $domainGroupID != $group->id &&
 427         CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
 428           'is_enabled'
 429         ) &&
 430         !CRM_Contact_BAO_GroupNesting::hasParentGroups($group->id)
 431       ) {
 432         // if no parent present and the group doesn't already have any parents,
 433         // make sure site group goes as parent
 434         $params['parents'] = array($domainGroupID => 1);
 435       }
 436       elseif (array_key_exists('parents', $params) && !is_array($params['parents'])) {
 437         $params['parents'] = array($params['parents'] => 1);
 438       }
 439
 440       if (!empty($params['parents'])) {
 441         foreach ($params['parents'] as $parentId => $dnc) {
 442           if ($parentId && !CRM_Contact_BAO_GroupNesting::isParentChild($parentId, $group->id)) {
 443             CRM_Contact_BAO_GroupNesting::add($parentId, $group->id);
 444           }
 445         }
 446       }
 447
 448       // clear any descendant groups cache if exists
 449       $finalGroups = CRM_Core_BAO_Cache::deleteGroup('descendant groups for an org');
 450
 451       // this is always required, since we don't know when a
 452       // parent group is removed
 453       CRM_Contact_BAO_GroupNestingCache::update();
 454
 455       // update group contact cache for all parent groups
 456       $parentIds = CRM_Contact_BAO_GroupNesting::getParentGroupIds($group->id);
 457       foreach ($parentIds as $parentId) {
 458         CRM_Contact_BAO_GroupContactCache::add($parentId);
 459       }
 460     }
 461
 462     if (!empty($params['organization_id'])) {
 463       $groupOrg = array();
 464       $groupOrg = $params;
 465       $groupOrg['group_id'] = $group->id;
 466       CRM_Contact_BAO_GroupOrganization::add($groupOrg);
 467     }
 468
 469     CRM_Contact_BAO_GroupContactCache::add($group->id);
 470
 471     if (!empty($params['id'])) {
 472       CRM_Utils_Hook::post('edit', 'Group', $group->id, $group);
 473     }
 474     else {
 475       CRM_Utils_Hook::post('create', 'Group', $group->id, $group);
 476     }
 477
 478     $recentOther = array();
 479     if (CRM_Core_Permission::check('edit groups')) {
 480       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/group', 'reset=1&action=update&id=' . $group->id);
 481       // currently same permission we are using for delete a group
 482       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/group', 'reset=1&action=delete&id=' . $group->id);
 483     }
 484
 485     // add the recently added group (unless hidden: CRM-6432)
 486     if (!$group->is_hidden) {
 487       CRM_Utils_Recent::add($group->title,
 488         CRM_Utils_System::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id),
 489         $group->id,
 490         'Group',
 491         NULL,
 492         NULL,
 493         $recentOther
 494       );
 495     }
 496     return $group;
 497   }
 498
 499   /**
 500    * given a saved search compute the clause and the tables
 501    * and store it for future use
 502    */
 503   function buildClause() {
 504     $params = array(array('group', 'IN', array($this->id => 1), 0, 0));
 505
 506     if (!empty($params)) {
 507       $tables = $whereTables = array();
 508       $this->where_clause = CRM_Contact_BAO_Query::getWhereClause($params, NULL, $tables, $whereTables);
 509       if (!empty($tables)) {
 510         $this->select_tables = serialize($tables);
 511       }
 512       if (!empty($whereTables)) {
 513         $this->where_tables = serialize($whereTables);
 514       }
 515     }
 516
 517     return;
 518   }
 519
 520   /**
 521    * Defines a new smart group
 522    *
 523    * @param array $params     Associative array of parameters
 524    *
 525    * @return object|null      The new group BAO (if created)
 526    * @access public
 527    * @static
 528    */
 529   public static function createSmartGroup(&$params) {
 530     if (!empty($params['formValues'])) {
 531       $ssParams = $params;
 532       unset($ssParams['id']);
 533       if (isset($ssParams['saved_search_id'])) {
 534         $ssParams['id'] = $ssParams['saved_search_id'];
 535       }
 536
 537       $savedSearch = CRM_Contact_BAO_SavedSearch::create($params);
 538
 539       $params['saved_search_id'] = $savedSearch->id;
 540     }
 541     else {
 542       return NULL;
 543     }
 544
 545     return self::create($params);
 546   }
 547
 548   /**
 549    * update the is_active flag in the db
 550    *
 551    * @param int      $id        id of the database record
 552    * @param boolean  $isActive  value we want to set the is_active field
 553    *
 554    * @return Object             DAO object on sucess, null otherwise
 555    * @static
 556    */
 557   static function setIsActive($id, $isActive) {
 558     return CRM_Core_DAO::setFieldValue('CRM_Contact_DAO_Group', $id, 'is_active', $isActive);
 559   }
 560
 561   /**
 562    * build the condition to retrieve groups.
 563    *
 564    * @param string  $groupType type of group(Access/Mailing) OR the key of the group
 565    * @param boolen  $excludeHidden exclude hidden groups.
 566    *
 567    * @return string $condition
 568    * @static
 569    */
 570   static function groupTypeCondition($groupType = NULL, $excludeHidden = TRUE) {
 571     $value = NULL;
 572     if ($groupType == 'Mailing') {
 573       $value = CRM_Core_DAO::VALUE_SEPARATOR . '2' . CRM_Core_DAO::VALUE_SEPARATOR;
 574     }
 575     elseif ($groupType == 'Access') {
 576       $value = CRM_Core_DAO::VALUE_SEPARATOR . '1' . CRM_Core_DAO::VALUE_SEPARATOR;
 577     }
 578     elseif (!empty($groupType)){
 579       // ie we have been given the group key
 580       $value = CRM_Core_DAO::VALUE_SEPARATOR . $groupType . CRM_Core_DAO::VALUE_SEPARATOR;
 581     }
 582
 583     $condition = NULL;
 584     if ($excludeHidden) {
 585       $condition = "is_hidden = 0";
 586     }
 587
 588     if ($value) {
 589       if ($condition) {
 590         $condition .= " AND group_type LIKE '%$value%'";
 591       }
 592       else {
 593         $condition = "group_type LIKE '%$value%'";
 594       }
 595     }
 596
 597     return $condition;
 598   }
 599
 600   public function __toString() {
 601     return $this->title;
 602   }
 603
 604   /**
 605    * This function create the hidden smart group when user perform
 606    * contact seach and want to send mailing to search contacts.
 607    *
 608    * @param  array $params ( reference ) an assoc array of name/value pairs
 609    *
 610    * @return array ( smartGroupId, ssId ) smart group id and saved search id
 611    * @access public
 612    * @static
 613    */
 614   static function createHiddenSmartGroup($params) {
 615     $ssId = CRM_Utils_Array::value('saved_search_id', $params);
 616
 617     //add mapping record only for search builder saved search
 618     $mappingId = NULL;
 619     if ($params['search_context'] == 'builder') {
 620       //save the mapping for search builder
 621       if (!$ssId) {
 622         //save record in mapping table
 623         $temp          = array();
 624         $mappingParams = array('mapping_type' => 'Search Builder');
 625         $mapping       = CRM_Core_BAO_Mapping::add($mappingParams, $temp);
 626         $mappingId     = $mapping->id;
 627       }
 628       else {
 629         //get the mapping id from saved search
 630         $savedSearch = new CRM_Contact_BAO_SavedSearch();
 631         $savedSearch->id = $ssId;
 632         $savedSearch->find(TRUE);
 633         $mappingId = $savedSearch->mapping_id;
 634       }
 635
 636       //save mapping fields
 637       CRM_Core_BAO_Mapping::saveMappingFields($params['form_values'], $mappingId);
 638     }
 639
 640     //create/update saved search record.
 641     $savedSearch = new CRM_Contact_BAO_SavedSearch();
 642     $savedSearch->id = $ssId;
 643     $savedSearch->form_values = serialize($params['form_values']);
 644     $savedSearch->mapping_id = $mappingId;
 645     $savedSearch->search_custom_id = CRM_Utils_Array::value('search_custom_id', $params);
 646     $savedSearch->save();
 647
 648     $ssId = $savedSearch->id;
 649     if (!$ssId) {
 650       return NULL;
 651     }
 652
 653     $smartGroupId = NULL;
 654     if (!empty($params['saved_search_id'])) {
 655       $smartGroupId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $ssId, 'id', 'saved_search_id');
 656     }
 657     else {
 658       //create group only when new saved search.
 659       $groupParams = array(
 660         'title' => "Hidden Smart Group {$ssId}",
 661         'is_active' => CRM_Utils_Array::value('is_active', $params, 1),
 662         'is_hidden' => CRM_Utils_Array::value('is_hidden', $params, 1),
 663         'group_type' => CRM_Utils_Array::value('group_type', $params),
 664         'visibility' => CRM_Utils_Array::value('visibility', $params),
 665         'saved_search_id' => $ssId,
 666       );
 667
 668       $smartGroup = self::create($groupParams);
 669       $smartGroupId = $smartGroup->id;
 670     }
 671
 672     return array($smartGroupId, $ssId);
 673   }
 674
 675   /**
 676    * This function is a wrapper for ajax group selector
 677    *
 678    * @param  array   $params associated array for params record id.
 679    *
 680    * @return array   $groupList associated array of group list
 681    * @access public
 682    */
 683   public function getGroupListSelector(&$params) {
 684     // format the params
 685     $params['offset']   = ($params['page'] - 1) * $params['rp'];
 686     $params['rowCount'] = $params['rp'];
 687     $params['sort']     = CRM_Utils_Array::value('sortBy', $params);
 688
 689     // get groups
 690     $groups = CRM_Contact_BAO_Group::getGroupList($params);
 691
 692     //skip total if we are making call to show only children
 693     if (empty($params['parent_id'])) {
 694       // add total
 695       $params['total'] = CRM_Contact_BAO_Group::getGroupCount($params);
 696
 697       // get all the groups
 698       $allGroups = CRM_Core_PseudoConstant::allGroup();
 699     }
 700
 701     // format params and add links
 702     $groupList = array();
 703     if (!empty($groups)) {
 704       foreach ($groups as $id => $value) {
 705         $groupList[$id]['group_id'] = $value['id'];
 706         $groupList[$id]['group_name'] = $value['title'];
 707         $groupList[$id]['class'] = implode(' ', $value['class']);
 708
 709         // append parent names if in search mode
 710         if (empty($params['parent_id']) && !empty($value['parents'])) {
 711           $groupIds = explode(',', $value['parents']);
 712           $title = array();
 713           foreach($groupIds as $gId) {
 714             $title[] = $allGroups[$gId];
 715           }
 716           $groupList[$id]['group_name'] .= '<div class="crm-row-parent-name"><em>'.ts('Child of').'</em>: ' . implode(', ', $title) . '</div>';
 717           $groupList[$id]['class'] = in_array('disabled', $value['class']) ? 'disabled' : '';
 718         }
 719
 720         $groupList[$id]['group_description'] = CRM_Utils_Array::value('description', $value);
 721         if (!empty($value['group_type'])) {
 722           $groupList[$id]['group_type'] = $value['group_type'];
 723         }
 724         else {
 725           $groupList[$id]['group_type'] = '';
 726         }
 727         $groupList[$id]['visibility'] = $value['visibility'];
 728         $groupList[$id]['links'] = $value['action'];
 729         $groupList[$id]['org_info'] = CRM_Utils_Array::value('org_info', $value);
 730         $groupList[$id]['created_by'] = CRM_Utils_Array::value('created_by', $value);
 731
 732         $groupList[$id]['is_parent'] = $value['is_parent'];
 733       }
 734       return $groupList;
 735     }
 736   }
 737
 738   /**
 739    * This function to get list of groups
 740    *
 741    * @param  array   $params associated array for params
 742    * @access public
 743    */
 744   static function getGroupList(&$params) {
 745     $config = CRM_Core_Config::singleton();
 746
 747     $whereClause = self::whereClause($params, FALSE);
 748
 749     //$this->pagerAToZ( $whereClause, $params );
 750
 751     if (!empty($params['rowCount']) &&
 752       $params['rowCount'] > 0
 753     ) {
 754       $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
 755     }
 756
 757     $orderBy = ' ORDER BY groups.title asc';
 758     if (!empty($params['sort'])) {
 759       $orderBy = ' ORDER BY ' . CRM_Utils_Type::escape($params['sort'], 'String');
 760     }
 761
 762     $select = $from = $where = "";
 763     $groupOrg = FALSE;
 764     if (CRM_Core_Permission::check('administer Multiple Organizations') &&
 765       CRM_Core_Permission::isMultisiteEnabled()
 766     ) {
 767       $select = ", contact.display_name as org_name, contact.id as org_id";
 768       $from = " LEFT JOIN civicrm_group_organization gOrg
 769                                ON gOrg.group_id = groups.id
 770                         LEFT JOIN civicrm_contact contact
 771                                ON contact.id = gOrg.organization_id ";
 772
 773       //get the Organization ID
 774       $orgID = CRM_Utils_Request::retrieve('oid', 'Positive', CRM_Core_DAO::$_nullObject);
 775       if ($orgID) {
 776         $where = " AND gOrg.organization_id = {$orgID}";
 777       }
 778
 779       $groupOrg = TRUE;
 780     }
 781
 782     $query = "
 783         SELECT groups.*, createdBy.sort_name as created_by {$select}
 784         FROM  civicrm_group groups
 785               LEFT JOIN civicrm_contact createdBy
 786                      ON createdBy.id = groups.created_id
 787               {$from}
 788         WHERE $whereClause {$where}
 789         {$orderBy}
 790         {$limit}";
 791
 792     $object = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Contact_DAO_Group');
 793
 794     //FIXME CRM-4418, now we are handling delete separately
 795     //if we introduce 'delete for group' make sure to handle here.
 796     $groupPermissions = array(CRM_Core_Permission::VIEW);
 797     if (CRM_Core_Permission::check('edit groups')) {
 798       $groupPermissions[] = CRM_Core_Permission::EDIT;
 799       $groupPermissions[] = CRM_Core_Permission::DELETE;
 800     }
 801
 802     // CRM-9936
 803     $reservedPermission = CRM_Core_Permission::check('administer reserved groups');
 804
 805     $links = self::actionLinks();
 806
 807     $allTypes = CRM_Core_OptionGroup::values('group_type');
 808     $values = array();
 809
 810     while ($object->fetch()) {
 811       $permission = CRM_Contact_BAO_Group::checkPermission($object->id, $object->title);
 812       //@todo CRM-12209 introduced an ACL check in the whereClause function
 813       // it may be that this checking is now obsolete - or that what remains
 814       // should be removed to the whereClause (which is also accessed by getCount)
 815
 816       if ($permission) {
 817         $newLinks = $links;
 818         $values[$object->id] = array('class' => array());
 819         CRM_Core_DAO::storeValues($object, $values[$object->id]);
 820         if ($object->saved_search_id) {
 821           $values[$object->id]['title'] .= ' (' . ts('Smart Group') . ')';
 822           // check if custom search, if so fix view link
 823           $customSearchID = CRM_Core_DAO::getFieldValue(
 824             'CRM_Contact_DAO_SavedSearch',
 825             $object->saved_search_id,
 826             'search_custom_id'
 827           );
 828
 829           if ($customSearchID) {
 830             $newLinks[CRM_Core_Action::VIEW]['url'] = 'civicrm/contact/search/custom';
 831             $newLinks[CRM_Core_Action::VIEW]['qs'] = "reset=1&force=1&ssID={$object->saved_search_id}";
 832           }
 833         }
 834
 835         $action = array_sum(array_keys($newLinks));
 836
 837         // CRM-9936
 838         if (array_key_exists('is_reserved', $object)) {
 839           //if group is reserved and I don't have reserved permission, suppress delete/edit
 840           if ($object->is_reserved && !$reservedPermission) {
 841             $action -= CRM_Core_Action::DELETE;
 842             $action -= CRM_Core_Action::UPDATE;
 843             $action -= CRM_Core_Action::DISABLE;
 844           }
 845         }
 846
 847         if (array_key_exists('is_active', $object)) {
 848           if ($object->is_active) {
 849             $action -= CRM_Core_Action::ENABLE;
 850           }
 851           else {
 852             $values[$object->id]['class'][] = 'disabled';
 853             $action -= CRM_Core_Action::VIEW;
 854             $action -= CRM_Core_Action::DISABLE;
 855           }
 856         }
 857
 858         $action = $action & CRM_Core_Action::mask($groupPermissions);
 859
 860         $values[$object->id]['visibility'] = CRM_Contact_DAO_Group::tsEnum('visibility',
 861           $values[$object->id]['visibility']
 862         );
 863         if (isset($values[$object->id]['group_type'])) {
 864           $groupTypes = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 865             substr($values[$object->id]['group_type'], 1, -1)
 866           );
 867           $types = array();
 868           foreach ($groupTypes as $type) {
 869             $types[] = CRM_Utils_Array::value($type, $allTypes);
 870           }
 871           $values[$object->id]['group_type'] = implode(', ', $types);
 872         }
 873         $values[$object->id]['action'] = CRM_Core_Action::formLink($newLinks,
 874           $action,
 875           array(
 876             'id' => $object->id,
 877             'ssid' => $object->saved_search_id,
 878           ),
 879           ts('more'),
 880           FALSE,
 881           'group.selector.row',
 882           'Group',
 883           $object->id
 884         );
 885
 886         // If group has children, add class for link to view children
 887         $values[$object->id]['is_parent'] = false;
 888         if (array_key_exists('children', $values[$object->id])) {
 889           $values[$object->id]['class'][] = "crm-group-parent";
 890           $values[$object->id]['is_parent'] = true;
 891         }
 892
 893         // If group is a child, add child class
 894         if (array_key_exists('parents', $values[$object->id])) {
 895           $values[$object->id]['class'][] = "crm-group-child";
 896         }
 897
 898         if ($groupOrg) {
 899           if ($object->org_id) {
 900             $contactUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$object->org_id}");
 901             $values[$object->id]['org_info'] = "<a href='{$contactUrl}'>{$object->org_name}</a>";
 902           }
 903           else {
 904             $values[$object->id]['org_info'] = ''; // Empty cell
 905           }
 906         }
 907         else {
 908           $values[$object->id]['org_info'] = NULL; // Collapsed column if all cells are NULL
 909         }
 910         if ($object->created_id) {
 911           $contactUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$object->created_id}");
 912           $values[$object->id]['created_by'] = "<a href='{$contactUrl}'>{$object->created_by}</a>";
 913         }
 914       }
 915     }
 916
 917     return $values;
 918   }
 919
 920   /**
 921    * This function to get hierarchical list of groups (parent followed by children)
 922    *
 923    * @param  array   $groupIDs array of group ids
 924    *
 925    * @access public
 926    */
 927   static function getGroupsHierarchy (
 928     $groupIDs,
 929     $parents  = NULL,
 930     $spacer = '<span class="child-indent"></span>',
 931     $titleOnly = FALSE
 932    ) {
 933     if (empty($groupIDs)) {
 934       return array();
 935     }
 936
 937     $groupIdString = '(' . implode(',', array_keys($groupIDs)) . ')';
 938      // <span class="child-icon"></span>
 939      // need to return id, title (w/ spacer), description, visibility
 940
 941      // We need to build a list of tags ordered by hierarchy and sorted by
 942      // name. The heirarchy will be communicated by an accumulation of
 943      // separators in front of the name to give it a visual offset.
 944      // Instead of recursively making mysql queries, we'll make one big
 945      // query and build the heirarchy with the algorithm below.
 946      $groups = array();
 947      $args = array(1 => array($groupIdString, 'String'));
 948      $query = "
 949 SELECT id, title, description, visibility, parents
 950 FROM   civicrm_group
 951 WHERE  id IN $groupIdString
 952 ";
 953      if ($parents) {
 954        // group can have > 1 parent so parents may be comma separated list (eg. '1,2,5'). We just grab and match on 1st parent.
 955        $parentArray = explode(',', $parents);
 956        $parent = $parentArray[0];
 957        $args[2] = array($parent, 'Integer');
 958        $query .= " AND SUBSTRING_INDEX(parents, ',', 1) = %2";
 959      }
 960      $query .= " ORDER BY title";
 961      $dao = CRM_Core_DAO::executeQuery($query, $args);
 962
 963      // Sort the groups into the correct storage by the parent
 964      // $roots represent the current leaf nodes that need to be checked for
 965      // children. $rows represent the unplaced nodes
 966      $roots = $rows = $allGroups = array();
 967      while ($dao->fetch()) {
 968        $allGroups[$dao->id] = array('title' => $dao->title,
 969                                     'visibility' => $dao->visibility,
 970                                     'description' => $dao->description);
 971
 972        if ($dao->parents == $parents) {
 973          $roots[] = array('id' => $dao->id,
 974                           'prefix' => '',
 975                           'title' => $dao->title);
 976        }
 977        else {
 978          // group can have > 1 parent so $dao->parents may be comma separated list (eg. '1,2,5'). Grab and match on 1st parent.
 979          $parentArray = explode(',', $dao->parents);
 980          $parent = $parentArray[0];
 981          $rows[] = array('id' => $dao->id,
 982                           'prefix' => '',
 983                           'title' => $dao->title,
 984                           'parents' => $parent);
 985        }
 986      }
 987      $dao->free();
 988      // While we have nodes left to build, shift the first (alphabetically)
 989      // node of the list, place it in our groups list and loop through the
 990      // list of unplaced nodes to find its children. We make a copy to
 991      // iterate through because we must modify the unplaced nodes list
 992      // during the loop.
 993      while (count($roots)) {
 994        $new_roots         = array();
 995        $current_rows      = $rows;
 996        $root              = array_shift($roots);
 997        $groups[$root['id']] = array($root['prefix'], $root['title']);
 998
 999        // As you find the children, append them to the end of the new set
1000        // of roots (maintain alphabetical ordering). Also remove the node
1001        // from the set of unplaced nodes.
1002        if (is_array($current_rows)) {
1003          foreach ($current_rows as $key => $row) {
1004            if ($row['parents'] == $root['id']) {
1005              $new_roots[] = array('id' => $row['id'], 'prefix' => $groups[$root['id']][0] . $spacer, 'title' => $row['title']);
1006              unset($rows[$key]);
1007            }
1008          }
1009        }
1010
1011        //As a group, insert the new roots into the beginning of the roots
1012        //list. This maintains the hierarchical ordering of the tags.
1013        $roots = array_merge($new_roots, $roots);
1014      }
1015
1016      // Prefix titles with the calcuated spacing to give the visual
1017      // appearance of ordering when transformed into HTML in the form layer. Add description and visibility.
1018      $groupsReturn = array();
1019      foreach ($groups as $key=>$value) {
1020        if ($titleOnly) {
1021          $groupsReturn[$key] = $value[0] . $value[1];
1022        } else {
1023          $groupsReturn[$key] = array(
1024            'title' => $value[0] . $value[1],
1025            'description' => $allGroups[$key]['description'],
1026            'visibility' => $allGroups[$key]['visibility'],
1027          );
1028        }
1029      }
1030
1031      return $groupsReturn;
1032   }
1033
1034   static function getGroupCount(&$params) {
1035     $whereClause = self::whereClause($params, FALSE);
1036     $query = "SELECT COUNT(*) FROM civicrm_group groups";
1037
1038     if (!empty($params['created_by'])) {
1039       $query .= "
1040 INNER JOIN civicrm_contact createdBy
1041        ON createdBy.id = groups.created_id";
1042     }
1043     $query .= "
1044 WHERE {$whereClause}";
1045     return CRM_Core_DAO::singleValueQuery($query, $params);
1046   }
1047
1048   function whereClause(&$params, $sortBy = TRUE, $excludeHidden = TRUE) {
1049     $values = array();
1050     $clauses = array();
1051
1052     $title = CRM_Utils_Array::value('title', $params);
1053     if ($title) {
1054       $clauses[] = "groups.title LIKE %1";
1055       if (strpos($title, '%') !== FALSE) {
1056         $params[1] = array($title, 'String', FALSE);
1057       }
1058       else {
1059         $params[1] = array($title, 'String', TRUE);
1060       }
1061     }
1062
1063     $groupType = CRM_Utils_Array::value('group_type', $params);
1064     if ($groupType) {
1065       $types = explode(',', $groupType);
1066       if (!empty($types)) {
1067         $clauses[]  = 'groups.group_type LIKE %2';
1068         $typeString = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $types) . CRM_Core_DAO::VALUE_SEPARATOR;
1069         $params[2]  = array($typeString, 'String', TRUE);
1070       }
1071     }
1072
1073     $visibility = CRM_Utils_Array::value('visibility', $params);
1074     if ($visibility) {
1075       $clauses[] = 'groups.visibility = %3';
1076       $params[3] = array($visibility, 'String');
1077     }
1078
1079     $groupStatus = CRM_Utils_Array::value('status', $params);
1080     if ($groupStatus) {
1081       switch ($groupStatus) {
1082         case 1:
1083           $clauses[] = 'groups.is_active = 1';
1084           $params[4] = array($groupStatus, 'Integer');
1085           break;
1086
1087         case 2:
1088           $clauses[] = 'groups.is_active = 0';
1089           $params[4] = array($groupStatus, 'Integer');
1090           break;
1091
1092         case 3:
1093           $clauses[] = '(groups.is_active = 0 OR groups.is_active = 1 )';
1094           break;
1095       }
1096     }
1097
1098     $parentsOnly = CRM_Utils_Array::value('parentsOnly', $params);
1099     if ($parentsOnly) {
1100       $clauses[] = 'groups.parents IS NULL';
1101     }
1102
1103     // only show child groups of a specific parent group
1104     $parent_id = CRM_Utils_Array::value('parent_id', $params);
1105     if ($parent_id) {
1106       $clauses[] = 'groups.id IN (SELECT child_group_id FROM civicrm_group_nesting WHERE parent_group_id = %5)';
1107       $params[5] = array($parent_id, 'Integer');
1108     }
1109
1110     if ($createdBy = CRM_Utils_Array::value('created_by', $params)) {
1111       $clauses[] = "createdBy.sort_name LIKE %6";
1112       if (strpos($createdBy, '%') !== FALSE) {
1113         $params[6] = array($createdBy, 'String', FALSE);
1114       }
1115       else {
1116         $params[6] = array($createdBy, 'String', TRUE);
1117       }
1118     }
1119
1120     /*
1121       if ( $sortBy &&
1122       $this->_sortByCharacter !== null ) {
1123       $clauses[] =
1124       "groups.title LIKE '" .
1125       strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) .
1126       "%'";
1127       }
1128
1129       // dont do a the below assignement when doing a
1130       // AtoZ pager clause
1131       if ( $sortBy ) {
1132       if ( count( $clauses ) > 1 ) {
1133       $this->assign( 'isSearch', 1 );
1134       } else {
1135       $this->assign( 'isSearch', 0 );
1136       }
1137       }
1138     */
1139
1140
1141     if (empty($clauses)) {
1142       $clauses[] = 'groups.is_active = 1';
1143     }
1144
1145     if ($excludeHidden) {
1146       $clauses[] = 'groups.is_hidden = 0';
1147     }
1148     //CRM-12209
1149     if (!CRM_Core_Permission::check('view all contacts')) {
1150       //get the allowed groups for the current user
1151       $groups = CRM_ACL_API::group(CRM_ACL_API::VIEW);
1152       if (!empty( $groups)) {
1153         $groupList = implode( ', ', array_values( $groups ) );
1154         $clauses[] = "groups.id IN ( $groupList ) ";
1155       }
1156     }
1157
1158     return implode(' AND ', $clauses);
1159   }
1160
1161   /**
1162    * Function to define action links
1163    *
1164    * @return array $links array of action links
1165    * @access public
1166    */
1167   static function actionLinks() {
1168     $links = array(
1169       CRM_Core_Action::VIEW => array(
1170         'name' => ts('Contacts'),
1171         'url' => 'civicrm/group/search',
1172         'qs' => 'reset=1&force=1&context=smog&gid=%%id%%',
1173         'title' => ts('Group Contacts'),
1174       ),
1175       CRM_Core_Action::UPDATE => array(
1176         'name' => ts('Settings'),
1177         'url' => 'civicrm/group',
1178         'qs' => 'reset=1&action=update&id=%%id%%',
1179         'title' => ts('Edit Group'),
1180       ),
1181       CRM_Core_Action::DISABLE => array(
1182         'name' => ts('Disable'),
1183         'ref' => 'crm-enable-disable',
1184         'title' => ts('Disable Group'),
1185       ),
1186       CRM_Core_Action::ENABLE => array(
1187         'name' => ts('Enable'),
1188         'ref' => 'crm-enable-disable',
1189         'title' => ts('Enable Group'),
1190       ),
1191       CRM_Core_Action::DELETE => array(
1192         'name' => ts('Delete'),
1193         'url' => 'civicrm/group',
1194         'qs' => 'reset=1&action=delete&id=%%id%%',
1195         'title' => ts('Delete Group'),
1196       ),
1197     );
1198
1199     return $links;
1200   }
1201
1202   function pagerAtoZ($whereClause, $whereParams) {
1203     $query = "
1204         SELECT DISTINCT UPPER(LEFT(groups.title, 1)) as sort_name
1205         FROM  civicrm_group groups
1206         WHERE $whereClause
1207         ORDER BY LEFT(groups.title, 1)
1208             ";
1209     $dao = CRM_Core_DAO::executeQuery($query, $whereParams);
1210
1211     return CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE);
1212   }
1213 }
1214