CRM/Contact/Form/Domain.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  * This class is to build the form for adding Group
  38  */
  39 class CRM_Contact_Form_Domain extends CRM_Core_Form {
  40
  41   /**
  42    * The group id, used when editing a group
  43    *
  44    * @var int
  45    */
  46   protected $_id;
  47
  48   /**
  49    * The contact_id of domain
  50    *
  51    * @var int
  52    */
  53   protected $_contactId;
  54
  55   /**
  56    * Default from email address option value id.
  57    *
  58    * @var int
  59    */
  60   protected $_fromEmailId = NULL;
  61
  62   /**
  63    * Default location type fields
  64    *
  65    * @var array
  66    */
  67   protected $_locationDefaults = array();
  68
  69   /**
  70    * How many locationBlocks should we display?
  71    *
  72    * @var int
  73    * @const
  74    */
  75   const LOCATION_BLOCKS = 1;
  76
  77   public function preProcess() {
  78     CRM_Utils_System::setTitle(ts('Organization Address and Contact Info'));
  79     $breadCrumbPath = CRM_Utils_System::url('civicrm/admin', 'reset=1');
  80     CRM_Utils_System::appendBreadCrumb(ts('Administer CiviCRM'), $breadCrumbPath);
  81     $session = CRM_Core_Session::singleton();
  82     $session->replaceUserContext(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
  83
  84     $this->_id = CRM_Core_Config::domainID();
  85     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
  86       $this, FALSE, 'view'
  87     );
  88     //location blocks.
  89     $location = new CRM_Contact_Form_Location();
  90     $location->preProcess($this);
  91   }
  92
  93   /*
  94    * Set default values for the form.
  95    * the default values are retrieved from the database
  96    *
  97    * @return void
  98    */
  99   /**
 100    * This virtual function is used to set the default values of
 101    * various form elements
 102    *
 103    * access        public
 104    *
 105    * @return array reference to the array of default values
 106    *
 107    */
 108   /**
 109    * @return array
 110    */
 111   public function setDefaultValues() {
 112     $defaults  = array();
 113     $params    = array();
 114
 115     if (isset($this->_id)) {
 116       $params['id'] = $this->_id;
 117       CRM_Core_BAO_Domain::retrieve($params, $domainDefaults);
 118       $this->_contactId = $domainDefaults['contact_id'];
 119       //get the default domain from email address. fix CRM-3552
 120       $optionValues = array();
 121       $grpParams['name'] = 'from_email_address';
 122       CRM_Core_OptionValue::getValues($grpParams, $optionValues);
 123       foreach ($optionValues as $Id => $value) {
 124         if ($value['is_default'] && $value['is_active']) {
 125           $this->_fromEmailId = $Id;
 126           $list = explode('"', $value['label']);
 127           $domainDefaults['email_name'] = CRM_Utils_Array::value(1, $list);
 128           $domainDefaults['email_address'] = CRM_Utils_Mail::pluckEmailFromHeader($value['label']);
 129           break;
 130         }
 131       }
 132
 133       unset($params['id']);
 134       $locParams = array('contact_id' => $domainDefaults['contact_id']);
 135       $this->_locationDefaults = $defaults = CRM_Core_BAO_Location::getValues($locParams);
 136
 137       $config = CRM_Core_Config::singleton();
 138       if (!isset($defaults['address'][1]['country_id'])) {
 139         $defaults['address'][1]['country_id'] = $config->defaultContactCountry;
 140       }
 141
 142       if (!isset($defaults['address'][1]['state_province_id'])) {
 143         $defaults['address'][1]['state_province_id'] = $config->defaultContactStateProvince;
 144       }
 145
 146     }
 147     $defaults = array_merge($defaults, $domainDefaults);
 148     return $defaults;
 149   }
 150
 151   /**
 152    * Build the form object
 153    *
 154    * @return void
 155    */
 156   public function buildQuickForm() {
 157
 158     $this->add('text', 'name', ts('Organization Name'), array('size' => 25), TRUE);
 159     $this->add('text', 'description', ts('Description'), array('size' => 25));
 160
 161     $this->add('text', 'email_name', ts('FROM Name'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', 'email'), TRUE);
 162
 163     $this->add('text', 'email_address', ts('FROM Email Address'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', 'email'), TRUE);
 164     $this->addRule('email_address', ts('Domain Email Address must use a valid email address format (e.g. \'info@example.org\').'), 'email');
 165
 166     //build location blocks.
 167     CRM_Contact_Form_Location::buildQuickForm($this);
 168
 169     $this->addButtons(array(
 170         array(
 171           'type' => 'next',
 172           'name' => ts('Save'),
 173           'subName' => 'view',
 174           'isDefault' => TRUE,
 175         ),
 176         array(
 177           'type' => 'cancel',
 178           'name' => ts('Cancel'),
 179         ),
 180       ));
 181
 182     if ($this->_action & CRM_Core_Action::VIEW) {
 183       $this->freeze();
 184     }
 185     $this->assign('emailDomain', TRUE);
 186   }
 187
 188   /**
 189    * Add local and global form rules
 190    *
 191    *
 192    * @return void
 193    */
 194   public function addRules() {
 195     $this->addFormRule(array('CRM_Contact_Form_Domain', 'formRule'));
 196   }
 197
 198   /**
 199    * Global validation rules for the form
 200    *
 201    * @param array $fields
 202    *   Posted values of the form.
 203    *
 204    * @return array list of errors to be posted back to the form
 205    * @static
 206    */
 207   public static function formRule($fields) {
 208     // check for state/country mapping
 209     $errors = CRM_Contact_Form_Edit_Address::formRule($fields, CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullObject);
 210     // $errors === TRUE means no errors from above formRule excution,
 211     // so declaring $errors to array for futher processing
 212     if ($errors === TRUE) {
 213       $errors = array();
 214     }
 215
 216     //fix for CRM-3552,
 217     //as we use "fromName"<emailaddresss> format for domain email.
 218     if (strpos($fields['email_name'], '"') !== FALSE) {
 219       $errors['email_name'] = ts('Double quotes are not allow in from name.');
 220     }
 221
 222     // Check for default from email address and organization (domain) name. Force them to change it.
 223     if ($fields['email_address'] == 'info@EXAMPLE.ORG') {
 224       $errors['email_address'] = ts('Please enter a valid default FROM email address for system-generated emails.');
 225     }
 226     if ($fields['name'] == 'Default Domain Name') {
 227       $errors['name'] = ts('Please enter the name of the organization or entity which owns this CiviCRM site.');
 228     }
 229
 230     return empty($errors) ? TRUE : $errors;
 231   }
 232
 233   /**
 234    * Process the form when submitted
 235    *
 236    * @return void
 237    */
 238   public function postProcess() {
 239     $params = $this->exportValues();
 240     $params['entity_id'] = $this->_id;
 241     $params['entity_table'] = CRM_Core_BAO_Domain::getTableName();
 242     $domain = CRM_Core_BAO_Domain::edit($params, $this->_id);
 243
 244     $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 245
 246     if (isset($this->_locationDefaults['address'][1]['location_type_id'])) {
 247       $params['address'][1]['location_type_id'] = $this->_locationDefaults['address'][1]['location_type_id'];
 248     }
 249     else {
 250       $params['address'][1]['location_type_id'] = $defaultLocationType->id;
 251     }
 252
 253     if (isset($this->_locationDefaults['phone'][1]['location_type_id'])) {
 254       $params['phone'][1]['location_type_id'] = $this->_locationDefaults['phone'][1]['location_type_id'];
 255     }
 256     else {
 257       $params['phone'][1]['location_type_id'] = $defaultLocationType->id;
 258     }
 259
 260     if (isset($this->_locationDefaults['email'][1]['location_type_id'])) {
 261       $params['email'][1]['location_type_id'] = $this->_locationDefaults['email'][1]['location_type_id'];
 262     }
 263     else {
 264       $params['email'][1]['location_type_id'] = $defaultLocationType->id;
 265     }
 266
 267     $params += array('contact_id' => $this->_contactId);
 268     $contactParams = array (
 269       'sort_name'    => $domain->name,
 270       'display_name' => $domain->name,
 271       'legal_name'   => $domain->name,
 272       'organization_name' => $domain->name,
 273       'contact_id' => $this->_contactId,
 274       'contact_type' => 'Organization',
 275     );
 276
 277     if ($this->_contactId) {
 278       $contactParams['contact_sub_type'] = CRM_Contact_BAO_Contact::getContactSubType($this->_contactId);
 279     }
 280
 281     CRM_Contact_BAO_Contact::add($contactParams);
 282     CRM_Core_BAO_Location::create($params, TRUE);
 283
 284     CRM_Core_BAO_Domain::edit($params, $this->_id);
 285
 286     //set domain from email address, CRM-3552
 287     $emailName = '"' . $params['email_name'] . '" <' . $params['email_address'] . '>';
 288
 289     $emailParams = array(
 290       'label' => $emailName,
 291       'description' => $params['description'],
 292       'is_active' => 1,
 293       'is_default' => 1,
 294     );
 295
 296     $groupParams = array('name' => 'from_email_address');
 297
 298     //get the option value wt.
 299     if ($this->_fromEmailId) {
 300       $action = $this->_action;
 301       $emailParams['weight'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_fromEmailId, 'weight');
 302     }
 303     else {
 304       //add from email address.
 305       $action = CRM_Core_Action::ADD;
 306       $grpId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'from_email_address', 'id', 'name');
 307       $fieldValues = array('option_group_id' => $grpId);
 308       $emailParams['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', $fieldValues);
 309     }
 310
 311
 312     //reset default within domain.
 313     $emailParams['reset_default_for'] = array('domain_id' => CRM_Core_Config::domainID());
 314
 315     CRM_Core_OptionValue::addOptionValue($emailParams, $groupParams, $action, $this->_fromEmailId);
 316
 317     CRM_Core_Session::setStatus(ts("Domain information for '%1' has been saved.", array(1 => $domain->name)), ts('Saved'), 'success');
 318     $session = CRM_Core_Session::singleton();
 319     $session->replaceUserContext(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
 320   }
 321 }