2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
38 /*********************************************************************************
40 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
41 * All Rights Reserved.
42 * Contributor(s): ______________________________________..
43 ********************************************************************************/
45 require_once('include/SugarObjects/templates/person/Person.php');
46 // Contact is used to store customer information.
47 class Contact extends Person {
55 var $modified_user_id;
56 var $assigned_user_id;
59 var $modified_by_name;
82 var $primary_address_street;
83 var $primary_address_city;
84 var $primary_address_state;
85 var $primary_address_postalcode;
86 var $primary_address_country;
87 var $alt_address_street;
88 var $alt_address_city;
89 var $alt_address_state;
90 var $alt_address_postalcode;
91 var $alt_address_country;
95 var $contacts_users_id;
96 // These are for related fields
101 var $opportunity_role;
102 var $opportunity_rel_id;
112 var $assigned_user_name;
114 var $accept_status_id;
115 var $accept_status_name;
116 var $alt_address_street_2;
117 var $alt_address_street_3;
118 var $opportunity_role_id;
119 var $portal_password;
120 var $primary_address_street_2;
121 var $primary_address_street_3;
124 var $full_name; // l10n localized name
126 var $table_name = "contacts";
127 var $rel_account_table = "accounts_contacts";
128 //This is needed for upgrade. This table definition moved to Opportunity module.
129 var $rel_opportunity_table = "opportunities_contacts";
131 var $object_name = "Contact";
132 var $module_dir = 'Contacts';
134 var $new_schema = true;
135 var $importable = true;
137 // This is used to retrieve related fields from form posts.
138 var $additional_column_fields = Array('bug_id', 'assigned_user_name', 'account_name', 'account_id', 'opportunity_id', 'case_id', 'task_id', 'note_id', 'meeting_id', 'call_id', 'email_id'
141 var $relationship_fields = Array('account_id'=> 'accounts','bug_id' => 'bugs', 'call_id'=>'calls','case_id'=>'cases','email_id'=>'emails',
142 'meeting_id'=>'meetings','note_id'=>'notes','task_id'=>'tasks', 'opportunity_id'=>'opportunities', 'contacts_users_id' => 'user_sync'
152 function add_list_count_joins(&$query, $where)
155 if(stristr($where, "accounts.name"))
157 // add a join to the accounts table.
159 LEFT JOIN accounts_contacts
160 ON contacts.id=accounts_contacts.contact_id
162 ON accounts_contacts.account_id=accounts.id
165 $custom_join = $this->custom_fields->getJOIN();
167 $query .= $custom_join['join'];
173 function listviewACLHelper(){
174 $array_assign = parent::listviewACLHelper();
176 //MFH BUG 18281; JChi #15255
177 $is_owner = !empty($this->assigned_user_id) && $this->assigned_user_id == $GLOBALS['current_user']->id;
178 if(!ACLController::moduleSupportsACL('Accounts') || ACLController::checkAccess('Accounts', 'view', $is_owner)){
179 $array_assign['ACCOUNT'] = 'a';
181 $array_assign['ACCOUNT'] = 'span';
184 return $array_assign;
187 function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false)
189 //if this is from "contact address popup" action, then process popup list query
190 if(isset($_REQUEST['action']) && $_REQUEST['action'] == 'ContactAddressPopup'){
191 return $this->address_popup_create_new_list_query($order_by, $where, $filter, $params, $show_deleted, $join_type, $return_array, $parentbean, $singleSelect);
194 //any other action goes to parent function in sugarbean
195 if(strpos($order_by,'sync_contact') !== false){
196 //we have found that the user is ordering by the sync_contact field, it would be troublesome to sort by this field
197 //and perhaps a performance issue, so just remove it
200 return parent::create_new_list_query($order_by, $where, $filter, $params, $show_deleted, $join_type, $return_array, $parentbean, $singleSelect);
208 function address_popup_create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false)
210 //if this is any action that is not the contact address popup, then go to parent function in sugarbean
211 if(isset($_REQUEST['action']) && $_REQUEST['action'] !== 'ContactAddressPopup'){
212 return parent::create_new_list_query($order_by, $where, $filter, $params, $show_deleted, $join_type, $return_array, $parentbean, $singleSelect);
215 $custom_join = $this->custom_fields->getJOIN();
216 // MFH - BUG #14208 creates alias name for select
217 $select_query = "SELECT ";
218 $select_query .= db_concat($this->table_name,array('first_name','last_name')) . " name, ";
221 accounts.name as account_name,
222 accounts.id as account_id,
223 accounts.assigned_user_id account_id_owner,
224 users.user_name as assigned_user_name ";
226 $select_query .= $custom_join['select'];
228 $ret_array['select'] = $select_query;
233 $from_query .= "LEFT JOIN users
234 ON contacts.assigned_user_id=users.id
235 LEFT JOIN accounts_contacts
236 ON contacts.id=accounts_contacts.contact_id and accounts_contacts.deleted = 0
238 ON accounts_contacts.account_id=accounts.id AND accounts.deleted=0 ";
239 $from_query .= "LEFT JOIN email_addr_bean_rel eabl ON eabl.bean_id = contacts.id AND eabl.bean_module = 'Contacts' and eabl.primary_address = 1 and eabl.deleted=0 ";
240 $from_query .= "LEFT JOIN email_addresses ea ON (ea.id = eabl.email_address_id) ";
242 $from_query .= $custom_join['join'];
244 $ret_array['from'] = $from_query;
245 $ret_array['from_min'] = 'from contacts';
248 if($show_deleted == 0){
249 $where_auto = " $this->table_name.deleted=0 ";
250 //$where_auto .= " AND accounts.deleted=0 ";
251 }else if($show_deleted == 1){
252 $where_auto = " $this->table_name.deleted=1 ";
257 $where_query = "where ($where) AND ".$where_auto;
259 $where_query = "where ".$where_auto;
263 $ret_array['where'] = $where_query;
265 if(!empty($order_by)){
266 $orderby_query = " ORDER BY ". $this->process_order_by($order_by, null);
268 $ret_array['order_by'] = $orderby_query ;
275 return $ret_array['select'] . $ret_array['from'] . $ret_array['where']. $ret_array['order_by'];
282 function create_export_query(&$order_by, &$where, $relate_link_join='')
284 $custom_join = $this->custom_fields->getJOIN(true, true,$where);
286 $custom_join['join'] .= $relate_link_join;
288 contacts.*,email_addresses.email_address email_address,
289 accounts.name as account_name,
290 users.user_name as assigned_user_name ";
292 $query .= $custom_join['select'];
294 $query .= " FROM contacts ";
295 $query .= "LEFT JOIN users
296 ON contacts.assigned_user_id=users.id ";
297 $query .= "LEFT JOIN accounts_contacts
298 ON ( contacts.id=accounts_contacts.contact_id and (accounts_contacts.deleted is null or accounts_contacts.deleted = 0))
300 ON accounts_contacts.account_id=accounts.id ";
302 //join email address table too.
303 $query .= ' LEFT JOIN email_addr_bean_rel on contacts.id = email_addr_bean_rel.bean_id and email_addr_bean_rel.bean_module=\'Contacts\' and email_addr_bean_rel.deleted=0 and email_addr_bean_rel.primary_address=1 ';
304 $query .= ' LEFT JOIN email_addresses on email_addresses.id = email_addr_bean_rel.email_address_id ' ;
307 $query .= $custom_join['join'];
310 $where_auto = "( accounts.deleted IS NULL OR accounts.deleted=0 )
311 AND contacts.deleted=0 ";
314 $query .= "where ($where) AND ".$where_auto;
316 $query .= "where ".$where_auto;
318 if(!empty($order_by))
319 $query .= " ORDER BY ". $this->process_order_by($order_by, null);
324 function fill_in_additional_list_fields() {
325 parent::fill_in_additional_list_fields();
326 $this->_create_proper_name_field();
327 // cn: bug 8586 - l10n names for Contacts in Email TO: field
328 $this->email_and_name1 = "{$this->full_name} <".$this->email1.">";
329 $this->email_and_name2 = "{$this->full_name} <".$this->email2.">";
331 if($this->force_load_details == true) {
332 $this->fill_in_additional_detail_fields();
336 function fill_in_additional_detail_fields() {
337 parent::fill_in_additional_detail_fields();
338 if(empty($this->id)) return;
340 global $locale, $app_list_strings, $current_user;
342 // retrieve the account information and the information about the person the contact reports to.
343 $query = "SELECT acc.id, acc.name, con_reports_to.first_name, con_reports_to.last_name
345 left join accounts_contacts a_c on a_c.contact_id = '".$this->id."' and a_c.deleted=0
346 left join accounts acc on a_c.account_id = acc.id and acc.deleted=0
347 left join contacts con_reports_to on con_reports_to.id = contacts.reports_to_id
348 where contacts.id = '".$this->id."'";
349 // Bug 43196 - If a contact is related to multiple accounts, make sure we pull the one we are looking for
350 // Bug 44730 was introduced due to this, fix is to simply clear any whitespaces around the account_id first
352 $clean_account_id = trim($this->account_id);
354 if ( !empty($clean_account_id) ) {
355 $query .= " and acc.id = '{$this->account_id}'";
358 $query .= " ORDER BY a_c.date_modified DESC";
360 $result = $this->db->query($query,true," Error filling in additional detail fields: ");
362 // Get the id and the name.
363 $row = $this->db->fetchByAssoc($result);
367 $this->account_name = $row['name'];
368 $this->account_id = $row['id'];
369 $this->report_to_name = $locale->getLocaleFormattedName($row['first_name'], $row['last_name'],'','','',null,true);
373 $this->account_name = '';
374 $this->account_id = '';
375 $this->report_to_name = '';
377 $this->load_contacts_users_relationship();
378 /** concating this here because newly created Contacts do not have a
379 * 'name' attribute constructed to pass onto related items, such as Tasks
382 $this->name = $locale->getLocaleFormattedName($this->first_name, $this->last_name);
383 if(!empty($this->contacts_users_id)) {
384 $this->sync_contact = true;
387 if(!empty($this->portal_active) && $this->portal_active == 1) {
388 $this->portal_active = true;
390 // Set campaign name if there is a campaign id
391 if( !empty($this->campaign_id)){
393 $camp = new Campaign();
394 $where = "campaigns.id='{$this->campaign_id}'";
395 $campaign_list = $camp->get_full_list("campaigns.name", $where, true);
396 $this->campaign_name = $campaign_list[0]->name;
401 loads the contacts_users relationship to populate a checkbox
402 where a user can select if they would like to sync a particular
405 function load_contacts_users_relationship(){
406 global $current_user;
408 $this->load_relationship("user_sync");
410 $beanIDs = $this->user_sync->get();
412 if( in_array($current_user->id, $beanIDs) )
414 $this->contacts_users_id = $current_user->id;
418 function get_list_view_data($filter_fields = array()) {
419 global $system_config;
420 global $current_user;
422 $this->_create_proper_name_field();
423 $temp_array = $this->get_list_view_array();
424 $temp_array['NAME'] = $this->name;
425 $temp_array['ENCODED_NAME'] = $this->name;
427 if($filter_fields && !empty($filter_fields['sync_contact'])){
428 $this->load_contacts_users_relationship();
429 $temp_array['SYNC_CONTACT'] = !empty($this->contacts_users_id) ? 1 : 0;
431 $temp_array['EMAIL1'] = $this->emailAddress->getPrimaryAddress($this);
432 $this->email1 = $temp_array['EMAIL1'];
433 $temp_array['EMAIL1_LINK'] = $current_user->getEmailLink('email1', $this, '', '', 'ListView');
434 $temp_array['EMAIL_AND_NAME1'] = "{$this->full_name} <".$temp_array['EMAIL1'].">";
439 builds a generic search based on the query string using or
440 do not include any $this-> because this is called on without having the class instantiated
442 function build_generic_where_clause ($the_query_string)
444 $where_clauses = Array();
445 $the_query_string = $this->db->quote($the_query_string);
447 array_push($where_clauses, "contacts.last_name like '$the_query_string%'");
448 array_push($where_clauses, "contacts.first_name like '$the_query_string%'");
449 array_push($where_clauses, "accounts.name like '$the_query_string%'");
450 array_push($where_clauses, "contacts.assistant like '$the_query_string%'");
451 array_push($where_clauses, "ea.email_address like '$the_query_string%'");
453 if (is_numeric($the_query_string))
455 array_push($where_clauses, "contacts.phone_home like '%$the_query_string%'");
456 array_push($where_clauses, "contacts.phone_mobile like '%$the_query_string%'");
457 array_push($where_clauses, "contacts.phone_work like '%$the_query_string%'");
458 array_push($where_clauses, "contacts.phone_other like '%$the_query_string%'");
459 array_push($where_clauses, "contacts.phone_fax like '%$the_query_string%'");
460 array_push($where_clauses, "contacts.assistant_phone like '%$the_query_string%'");
464 foreach($where_clauses as $clause)
466 if($the_where != "") $the_where .= " or ";
467 $the_where .= $clause;
474 function set_notification_body($xtpl, $contact)
478 $xtpl->assign("CONTACT_NAME", trim($locale->getLocaleFormattedName($contact->first_name, $contact->last_name)));
479 $xtpl->assign("CONTACT_DESCRIPTION", $contact->description);
484 function get_contact_id_by_email($email)
486 $email = trim($email);
488 //email is empty, no need to query, return null
492 $where_clause = "(email1='$email' OR email2='$email') AND deleted=0";
494 $query = "SELECT id FROM $this->table_name WHERE $where_clause";
495 $GLOBALS['log']->debug("Retrieve $this->object_name: ".$query);
496 $result = $this->db->getOne($query, true, "Retrieving record $where_clause:");
498 return empty($result)?null:$result;
501 function save_relationship_changes($is_update) {
503 //if account_id was replaced unlink the previous account_id.
504 //this rel_fields_before_value is populated by sugarbean during the retrieve call.
505 if (!empty($this->account_id) and !empty($this->rel_fields_before_value['account_id']) and
506 (trim($this->account_id) != trim($this->rel_fields_before_value['account_id']))) {
507 //unlink the old record.
508 $this->load_relationship('accounts');
509 $this->accounts->delete($this->id,$this->rel_fields_before_value['account_id']);
511 parent::save_relationship_changes($is_update);
514 function bean_implements($interface)
517 case 'ACL':return true;
522 function get_unlinked_email_query($type=array())
524 return get_unlinked_email_query($type, $this);
528 * used by import to add a list of users
530 * Parameter can be one of the following:
531 * - string 'all': add this contact for all users
532 * - comma deliminated lists of teams and/or users
534 * @param string $list_of_user
536 function process_sync_to_outlook($list_of_users)
540 // cache this object since we'll be reusing it a bunch
541 if ( !($focus_user instanceof User) ) {
543 $focus_user = new User();
547 if ( empty($list_of_users) ) {
550 if ( !isset($this->users) ) {
551 $this->load_relationship('user_sync');
554 if ( strtolower($list_of_users) == 'all' ) {
555 // add all non-deleted users
556 $sql = "SELECT id FROM users WHERE deleted=0 AND is_group=0 AND portal_only=0";
557 $result=$this->db->query($sql);
558 while ( $hash = $this->db->fetchByAssoc($result) ) {
559 $this->user_sync->add($hash['id']);
563 $theList = explode(",",$list_of_users);
564 foreach ($theList as $eachItem) {
565 if ( ($user_id = $focus_user->retrieve_user_id($eachItem))
566 || $focus_user->retrieve($eachItem)) {
567 // it is a user, add user
568 $this->user_sync->add($user_id ? $user_id : $focus_user->id);