2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 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 * Description: TODO: To be written.
41 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
42 * All Rights Reserved.
43 * Contributor(s): ______________________________________..
44 ********************************************************************************/
46 // Call is used to store customer information.
47 class Call extends SugarBean
55 var $assigned_user_id;
56 var $modified_user_id;
63 var $duration_minutes;
66 var $parent_type_options;
73 var $reminder_time_options;
74 var $reminder_checked;
79 var $modified_by_name;
87 var $assigned_user_name;
90 var $update_vcal = true;
94 var $default_call_name_values = array('Assemble catalogs', 'Make travel arrangements', 'Send a letter', 'Send contract', 'Send fax', 'Send a follow-up letter', 'Send literature', 'Send proposal', 'Send quote');
95 var $minutes_value_default = 15;
96 var $minutes_values = array('0'=>'00','15'=>'15','30'=>'30','45'=>'45');
97 var $table_name = "calls";
98 var $rel_users_table = "calls_users";
99 var $rel_contacts_table = "calls_contacts";
100 var $rel_leads_table = "calls_leads";
101 var $module_dir = 'Calls';
102 var $object_name = "Call";
103 var $new_schema = true;
104 var $importable = true;
106 // This is used to retrieve related fields from form posts.
107 var $additional_column_fields = array('assigned_user_name', 'assigned_user_id', 'contact_id', 'user_id', 'contact_name');
108 var $relationship_fields = array( 'account_id' => 'accounts',
109 'opportunity_id' => 'opportunities',
110 'contact_id' => 'contacts',
111 'case_id' => 'cases',
112 'user_id' => 'users',
113 'assigned_user_id' => 'users',
114 'note_id' => 'notes',
119 global $app_list_strings;
121 $this->setupCustomFields('Calls');
123 foreach ($this->field_defs as $field) {
124 $this->field_name_map[$field['name']] = $field;
128 if(!empty($GLOBALS['app_list_strings']['duration_intervals']))
129 $this->minutes_values = $GLOBALS['app_list_strings']['duration_intervals'];
132 // save date_end by calculating user input
133 // this is for calendar
134 function save($check_notify = FALSE) {
135 global $timedate,$current_user;
136 global $disable_date_format;
138 if(isset($this->date_start) && isset($this->duration_hours) && isset($this->duration_minutes))
140 $td = $timedate->fromDb($this->date_start);
143 $this->date_end = $td->modify("+{$this->duration_hours} hours {$this->duration_minutes} mins")->asDb();
147 if(!empty($_REQUEST['send_invites']) && $_REQUEST['send_invites'] == '1') {
148 $check_notify = true;
150 $check_notify = false;
152 if(empty($_REQUEST['send_invites'])) {
153 if(!empty($this->id)) {
154 $old_record = new Call();
155 $old_record->retrieve($this->id);
156 $old_assigned_user_id = $old_record->assigned_user_id;
158 if((empty($this->id) && isset($_REQUEST['assigned_user_id']) && !empty($_REQUEST['assigned_user_id']) && $GLOBALS['current_user']->id != $_REQUEST['assigned_user_id']) || (isset($old_assigned_user_id) && !empty($old_assigned_user_id) && isset($_REQUEST['assigned_user_id']) && !empty($_REQUEST['assigned_user_id']) && $old_assigned_user_id != $_REQUEST['assigned_user_id']) ){
159 $this->special_notification = true;
160 $check_notify = true;
161 if(isset($_REQUEST['assigned_user_name'])) {
162 $this->new_assigned_user_name = $_REQUEST['assigned_user_name'];
166 if (empty($this->status) ) {
167 $this->status = $this->getDefaultStatus();
169 /*nsingh 7/3/08 commenting out as bug #20814 is invalid
170 if($current_user->getPreference('reminder_time')!= -1 && isset($_POST['reminder_checked']) && isset($_POST['reminder_time']) && $_POST['reminder_checked']==0 && $_POST['reminder_time']==-1){
171 $this->reminder_checked = '1';
172 $this->reminder_time = $current_user->getPreference('reminder_time');
175 $return_id = parent::save($check_notify);
176 global $current_user;
179 if($this->update_vcal) {
180 vCal::cache_sugar_vcal($current_user);
186 /** Returns a list of the associated contacts
187 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
188 * All Rights Reserved..
189 * Contributor(s): ______________________________________..
191 function get_contacts()
193 // First, get the list of IDs.
194 $query = "SELECT contact_id as id from calls_contacts where call_id='$this->id' AND deleted=0";
196 return $this->build_related_list($query, new Contact());
200 function get_summary_text()
202 return "$this->name";
205 function create_list_query($order_by, $where, $show_deleted=0)
207 $custom_join = $this->custom_fields->getJOIN();
211 if ( preg_match("/calls_users\.user_id/",$where))
213 $query .= "calls_users.required,
214 calls_users.accept_status,";
218 users.user_name as assigned_user_name";
220 $query .= $custom_join['select'];
223 // this line will help generate a GMT-metric to compare to a locale's timezone
225 if ( preg_match("/contacts/",$where)){
226 $query .= ", contacts.first_name, contacts.last_name";
227 $query .= ", contacts.assigned_user_id contact_name_owner";
229 $query .= " FROM calls ";
232 if ( $this->db->dbType == 'mssql' )
234 $query .= ", calls.date_start ";
235 if ( preg_match("/contacts/",$where)){
236 $query .= ", contacts.first_name, contacts.last_name";
237 $query .= ", contacts.assigned_user_id contact_name_owner";
239 $query .= " FROM calls ";
242 if ( preg_match("/contacts/",$where)){
243 $query .= "LEFT JOIN calls_contacts
244 ON calls.id=calls_contacts.call_id
246 ON calls_contacts.contact_id=contacts.id ";
248 if ( preg_match("/calls_users\.user_id/",$where))
250 $query .= "LEFT JOIN calls_users
251 ON calls.id=calls_users.call_id and calls_users.deleted=0 ";
255 ON calls.assigned_user_id=users.id ";
257 $query .= $custom_join['join'];
260 if($show_deleted == 0){
261 $where_auto = " $this->table_name.deleted=0 ";
262 }else if($show_deleted == 1){
263 $where_auto = " $this->table_name.deleted=1 ";
266 //$where_auto .= " GROUP BY calls.id";
269 $query .= "where $where AND ".$where_auto;
271 $query .= "where ".$where_auto;
274 $query .= " ORDER BY ". $this->process_order_by($order_by, null);
276 $query .= " ORDER BY calls.name";
280 function create_export_query(&$order_by, &$where, $relate_link_join='')
282 $custom_join = $this->custom_fields->getJOIN(true, true,$where);
284 $custom_join['join'] .= $relate_link_join;
285 $contact_required = stristr($where, "contacts");
286 if($contact_required)
288 $query = "SELECT calls.*, contacts.first_name, contacts.last_name";
290 $query .= $custom_join['select'];
292 $query .= " FROM contacts, calls, calls_contacts ";
293 $where_auto = "calls_contacts.contact_id = contacts.id AND calls_contacts.call_id = calls.id AND calls.deleted=0 AND contacts.deleted=0";
297 $query = 'SELECT calls.*';
299 $query .= $custom_join['select'];
301 $query .= ' FROM calls ';
302 $where_auto = "calls.deleted=0";
307 $query .= $custom_join['join'];
311 $query .= "where $where AND ".$where_auto;
313 $query .= "where ".$where_auto;
316 $query .= " ORDER BY ". $this->process_order_by($order_by, null);
318 $query .= " ORDER BY calls.name";
327 function fill_in_additional_detail_fields()
330 parent::fill_in_additional_detail_fields();
331 if (!empty($this->contact_id)) {
332 $query = "SELECT first_name, last_name FROM contacts ";
333 $query .= "WHERE id='$this->contact_id' AND deleted=0";
334 $result = $this->db->limitQuery($query,0,1,true," Error filling in additional detail fields: ");
336 // Get the contact name.
337 $row = $this->db->fetchByAssoc($result);
338 $GLOBALS['log']->info("additional call fields $query");
341 $this->contact_name = $locale->getLocaleFormattedName($row['first_name'], $row['last_name'], '', '');
342 $GLOBALS['log']->debug("Call($this->id): contact_name = $this->contact_name");
343 $GLOBALS['log']->debug("Call($this->id): contact_id = $this->contact_id");
346 if (!isset($this->duration_minutes)) {
347 $this->duration_minutes = $this->minutes_value_default;
351 //setting default date and time
352 if (is_null($this->date_start)) {
353 $this->date_start = $timedate->now();
356 if (is_null($this->duration_hours))
357 $this->duration_hours = "0";
358 if (is_null($this->duration_minutes))
359 $this->duration_minutes = "1";
361 $this->fill_in_additional_parent_fields();
363 global $app_list_strings;
364 $parent_types = $app_list_strings['record_type_display'];
365 $disabled_parent_types = ACLController::disabledModuleList($parent_types,false, 'list');
366 foreach($disabled_parent_types as $disabled_parent_type){
367 if($disabled_parent_type != $this->parent_type){
368 unset($parent_types[$disabled_parent_type]);
372 $this->parent_type_options = get_select_options_with_id($parent_types, $this->parent_type);
374 if (empty($this->reminder_time)) {
375 $this->reminder_time = -1;
378 if ( empty($this->id) ) {
379 $reminder_t = $GLOBALS['current_user']->getPreference('reminder_time');
380 if ( isset($reminder_t) )
381 $this->reminder_time = $reminder_t;
383 $this->reminder_checked = $this->reminder_time == -1 ? false : true;
386 if (isset ($_REQUEST['parent_type'])) {
387 $this->parent_type = $_REQUEST['parent_type'];
388 } elseif (is_null($this->parent_type)) {
389 $this->parent_type = $app_list_strings['record_type_default_key'];
394 function get_list_view_data(){
395 $call_fields = $this->get_list_view_array();
396 global $app_list_strings, $focus, $action, $currentModule;
397 if (isset($focus->id)) $id = $focus->id;
399 if (isset($this->parent_type) && $this->parent_type != null)
401 $call_fields['PARENT_MODULE'] = $this->parent_type;
403 if ($this->status == "Planned") {
404 //cn: added this if() to deal with sequential Closes in Meetings. this is a hack to a hack (formbase.php->handleRedirect)
408 $setCompleteUrl = "<a onclick='SUGAR.util.closeActivityPanel.show(\"{$this->module_dir}\",\"{$this->id}\",\"Held\",\"listview\",\"1\");'>";
409 $call_fields['SET_COMPLETE'] = $setCompleteUrl . SugarThemeRegistry::current()->getImage("close_inline","title=".translate('LBL_LIST_CLOSE','Calls')." border='0'")."</a>";
412 $today = $timedate->nowDb();
413 $nextday = $timedate->asDbDate($timedate->getNow()->modify("+1 day"));
414 $mergeTime = $call_fields['DATE_START']; //$timedate->merge_date_time($call_fields['DATE_START'], $call_fields['TIME_START']);
415 $date_db = $timedate->to_db($mergeTime);
416 if( $date_db < $today){
417 $call_fields['DATE_START']= "<font class='overdueTask'>".$call_fields['DATE_START']."</font>";
418 }else if($date_db < $nextday){
419 $call_fields['DATE_START'] = "<font class='todaysTask'>".$call_fields['DATE_START']."</font>";
421 $call_fields['DATE_START'] = "<font class='futureTask'>".$call_fields['DATE_START']."</font>";
423 $this->fill_in_additional_detail_fields();
425 //make sure we grab the localized version of the contact name, if a contact is provided
426 if (!empty($this->contact_id)) {
428 $query = "SELECT first_name, last_name, salutation, title FROM contacts ";
429 $query .= "WHERE id='$this->contact_id' AND deleted=0";
430 $result = $this->db->limitQuery($query,0,1,true," Error filling in contact name fields: ");
432 // Get the contact name.
433 $row = $this->db->fetchByAssoc($result);
437 $this->contact_name = $locale->getLocaleFormattedName($row['first_name'], $row['last_name'], $row['salutation'], $row['title']);
441 $call_fields['CONTACT_ID'] = $this->contact_id;
442 $call_fields['CONTACT_NAME'] = $this->contact_name;
444 $call_fields['PARENT_NAME'] = $this->parent_name;
446 $call_fields['REMINDER_CHECKED'] = $this->reminder_time==-1 ? false : true;
451 function set_notification_body($xtpl, $call) {
452 global $sugar_config;
453 global $app_list_strings;
454 global $current_user;
455 global $app_list_strings;
458 // rrs: bug 42684 - passing a contact breaks this call
459 $notifyUser =($call->current_notify_user->object_name == 'User') ? $call->current_notify_user : $current_user;
462 // Assumes $call dates are in user format
463 $calldate = $timedate->fromDb($call->date_start);
464 $xOffset = $timedate->asUser($calldate, $notifyUser).' '.$timedate->userTimezoneSuffix($calldate, $notifyUser);
466 if ( strtolower(get_class($call->current_notify_user)) == 'contact' ) {
467 $xtpl->assign("ACCEPT_URL", $sugar_config['site_url'].
468 '/index.php?entryPoint=acceptDecline&module=Calls&contact_id='.$call->current_notify_user->id.'&record='.$call->id);
469 } elseif ( strtolower(get_class($call->current_notify_user)) == 'lead' ) {
470 $xtpl->assign("ACCEPT_URL", $sugar_config['site_url'].
471 '/index.php?entryPoint=acceptDecline&module=Calls&lead_id='.$call->current_notify_user->id.'&record='.$call->id);
473 $xtpl->assign("ACCEPT_URL", $sugar_config['site_url'].
474 '/index.php?entryPoint=acceptDecline&module=Calls&user_id='.$call->current_notify_user->id.'&record='.$call->id);
477 $xtpl->assign("CALL_TO", $call->current_notify_user->new_assigned_user_name);
478 $xtpl->assign("CALL_SUBJECT", $call->name);
479 $xtpl->assign("CALL_STARTDATE", $xOffset);
480 $xtpl->assign("CALL_HOURS", $call->duration_hours);
481 $xtpl->assign("CALL_MINUTES", $call->duration_minutes);
482 $xtpl->assign("CALL_STATUS", ((isset($call->status))?$app_list_strings['call_status_dom'][$call->status] : ""));
483 $xtpl->assign("CALL_DESCRIPTION", $call->description);
489 function get_call_users() {
490 $template = new User();
491 // First, get the list of IDs.
492 $query = "SELECT calls_users.required, calls_users.accept_status, calls_users.user_id from calls_users where calls_users.call_id='$this->id' AND calls_users.deleted=0";
493 $GLOBALS['log']->debug("Finding linked records $this->object_name: ".$query);
494 $result = $this->db->query($query, true);
497 while($row = $this->db->fetchByAssoc($result)) {
498 $template = new User(); // PHP 5 will retrieve by reference, always over-writing the "old" one
499 $record = $template->retrieve($row['user_id']);
500 $template->required = $row['required'];
501 $template->accept_status = $row['accept_status'];
503 if($record != null) {
504 // this copies the object into the array
512 function get_invite_calls(&$user)
515 // First, get the list of IDs.
516 $query = "SELECT calls_users.required, calls_users.accept_status, calls_users.call_id from calls_users where calls_users.user_id='$user->id' AND ( calls_users.accept_status IS NULL OR calls_users.accept_status='none') AND calls_users.deleted=0";
517 $GLOBALS['log']->debug("Finding linked records $this->object_name: ".$query);
520 $result = $this->db->query($query, true);
526 while($row = $this->db->fetchByAssoc($result))
528 $record = $template->retrieve($row['call_id']);
529 $template->required = $row['required'];
530 $template->accept_status = $row['accept_status'];
535 // this copies the object into the array
544 function set_accept_status(&$user,$status)
546 if ( $user->object_name == 'User')
548 $relate_values = array('user_id'=>$user->id,'call_id'=>$this->id);
549 $data_values = array('accept_status'=>$status);
550 $this->set_relationship($this->rel_users_table, $relate_values, true, true,$data_values);
551 global $current_user;
553 if ( $this->update_vcal )
555 vCal::cache_sugar_vcal($user);
558 else if ( $user->object_name == 'Contact')
560 $relate_values = array('contact_id'=>$user->id,'call_id'=>$this->id);
561 $data_values = array('accept_status'=>$status);
562 $this->set_relationship($this->rel_contacts_table, $relate_values, true, true,$data_values);
564 else if ( $user->object_name == 'Lead')
566 $relate_values = array('lead_id'=>$user->id,'call_id'=>$this->id);
567 $data_values = array('accept_status'=>$status);
568 $this->set_relationship($this->rel_leads_table, $relate_values, true, true,$data_values);
574 function get_notification_recipients() {
575 if($this->special_notification) {
576 return parent::get_notification_recipients();
579 // $GLOBALS['log']->debug('Call.php->get_notification_recipients():'.print_r($this,true));
581 if(!is_array($this->contacts_arr)) {
582 $this->contacts_arr = array();
585 if(!is_array($this->users_arr)) {
586 $this->users_arr = array();
589 if(!is_array($this->leads_arr)) {
590 $this->leads_arr = array();
593 foreach($this->users_arr as $user_id) {
594 $notify_user = new User();
595 $notify_user->retrieve($user_id);
596 $notify_user->new_assigned_user_name = $notify_user->full_name;
597 $GLOBALS['log']->info("Notifications: recipient is $notify_user->new_assigned_user_name");
598 $list[$notify_user->id] = $notify_user;
601 foreach($this->contacts_arr as $contact_id) {
602 $notify_user = new Contact();
603 $notify_user->retrieve($contact_id);
604 $notify_user->new_assigned_user_name = $notify_user->full_name;
605 $GLOBALS['log']->info("Notifications: recipient is $notify_user->new_assigned_user_name");
606 $list[$notify_user->id] = $notify_user;
609 foreach($this->leads_arr as $lead_id) {
610 $notify_user = new Lead();
611 $notify_user->retrieve($lead_id);
612 $notify_user->new_assigned_user_name = $notify_user->full_name;
613 $GLOBALS['log']->info("Notifications: recipient is $notify_user->new_assigned_user_name");
614 $list[$notify_user->id] = $notify_user;
616 // $GLOBALS['log']->debug('Call.php->get_notification_recipients():'.print_r($list,true));
620 function bean_implements($interface){
622 case 'ACL':return true;
627 function listviewACLHelper(){
628 $array_assign = parent::listviewACLHelper();
630 if(!empty($this->parent_name)){
632 if(!empty($this->parent_name_owner)){
633 global $current_user;
634 $is_owner = $current_user->id == $this->parent_name_owner;
637 if(!ACLController::moduleSupportsACL($this->parent_type) || ACLController::checkAccess($this->parent_type, 'view', $is_owner)){
638 $array_assign['PARENT'] = 'a';
640 $array_assign['PARENT'] = 'span';
643 if(!empty($this->contact_name)){
645 if(!empty($this->contact_name_owner)){
646 global $current_user;
647 $is_owner = $current_user->id == $this->contact_name_owner;
650 if( ACLController::checkAccess('Contacts', 'view', $is_owner)){
651 $array_assign['CONTACT'] = 'a';
653 $array_assign['CONTACT'] = 'span';
656 return $array_assign;
659 function save_relationship_changes($is_update) {
661 if(empty($this->in_workflow)) {
662 //if the global soap_server_object variable is not empty (as in from a soap/OPI call), then process the assigned_user_id relationship, otherwise
663 //add assigned_user_id to exclude list and let the logic from MeetingFormBase determine whether assigned user id gets added to the relationship
664 if(!empty($GLOBALS['soap_server_object'])){
665 $exclude = array('lead_id', 'contact_id', 'user_id');
667 $exclude = array('lead_id', 'contact_id', 'user_id', 'assigned_user_id');
670 parent::save_relationship_changes($is_update, $exclude);
673 public function getDefaultStatus()
675 $def = $this->field_defs['status'];
676 if (isset($def['default'])) {
677 return $def['default'];
679 $app = return_app_list_strings_language($GLOBALS['current_language']);
680 if (isset($def['options']) && isset($app[$def['options']])) {
681 $keys = array_keys($app[$def['options']]);