modules/Tasks/Task.php

   1 <?php
   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-2013 SugarCRM Inc.
   6  *
   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.
  13  *
  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
  17  * details.
  18  *
  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
  22  * 02110-1301 USA.
  23  *
  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.
  26  *
  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.
  30  *
  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  ********************************************************************************/
  37
  38
  39 // Task is used to store customer information.
  40 class Task extends SugarBean {
  41         var $field_name_map;
  42
  43         // Stored fields
  44         var $id;
  45         var $date_entered;
  46         var $date_modified;
  47         var $assigned_user_id;
  48         var $modified_user_id;
  49         var $created_by;
  50         var $created_by_name;
  51         var $modified_by_name;
  52         var $description;
  53         var $name;
  54         var $status;
  55         var $date_due_flag;
  56         var $date_due;
  57         var $time_due;
  58         var $date_start_flag;
  59         var $date_start;
  60         var $time_start;
  61         var $priority;
  62         var $parent_type;
  63         var $parent_id;
  64         var $contact_id;
  65
  66         var $parent_name;
  67         var $contact_name;
  68         var $contact_phone;
  69         var $contact_email;
  70         var $assigned_user_name;
  71
  72 //bug 28138 todo
  73 //      var $default_task_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', 'Call to schedule meeting', 'Setup evaluation', 'Get demo feedback', 'Arrange introduction', 'Escalate support request', 'Close out support request', 'Ship product', 'Arrange reference call', 'Schedule training', 'Send local user group information', 'Add to mailing list');
  74
  75         var $table_name = "tasks";
  76
  77         var $object_name = "Task";
  78         var $module_dir = 'Tasks';
  79
  80         var $importable = true;
  81         // This is used to retrieve related fields from form posts.
  82         var $additional_column_fields = Array('assigned_user_name', 'assigned_user_id', 'contact_name', 'contact_phone', 'contact_email', 'parent_name');
  83
  84
  85         function Task() {
  86                 parent::SugarBean();
  87         }
  88
  89         var $new_schema = true;
  90
  91     function save($check_notify = FALSE)
  92     {
  93         if (empty($this->status) ) {
  94             $this->status = $this->getDefaultStatus();
  95         }
  96         return parent::save($check_notify);
  97     }
  98
  99         function get_summary_text()
 100         {
 101                 return "$this->name";
 102         }
 103
 104     function create_export_query(&$order_by, &$where, $relate_link_join='')
 105     {
 106         $custom_join = $this->getCustomJoin(true, true, $where);
 107         $custom_join['join'] .= $relate_link_join;
 108                 $contact_required = stristr($where,"contacts");
 109                 if($contact_required)
 110                 {
 111                         $query = "SELECT tasks.*, contacts.first_name, contacts.last_name, users.user_name as assigned_user_name ";
 112                         $query .= $custom_join['select'];
 113                         $query .= " FROM contacts, tasks ";
 114                         $where_auto = "tasks.contact_id = contacts.id AND tasks.deleted=0 AND contacts.deleted=0";
 115                 }
 116                 else
 117                 {
 118                         $query = 'SELECT tasks.*, users.user_name as assigned_user_name ';
 119                         $query .= $custom_join['select'];
 120                         $query .= ' FROM tasks ';
 121                         $where_auto = "tasks.deleted=0";
 122                 }
 123
 124
 125         $query .= $custom_join['join'];
 126                 $query .= "  LEFT JOIN users ON tasks.assigned_user_id=users.id ";
 127
 128                 if($where != "")
 129                         $query .= "where $where AND ".$where_auto;
 130                 else
 131                         $query .= "where ".$where_auto;
 132
 133                 if($order_by != "")
 134                         $query .=  " ORDER BY ". $this->process_order_by($order_by, null);
 135                 else
 136                         $query .= " ORDER BY tasks.name";
 137                 return $query;
 138
 139         }
 140
 141
 142
 143         function fill_in_additional_list_fields()
 144         {
 145
 146         }
 147
 148         function fill_in_additional_detail_fields()
 149         {
 150         parent::fill_in_additional_detail_fields();
 151                 global $app_strings;
 152
 153                 if (isset($this->contact_id)) {
 154
 155                         $contact = new Contact();
 156                         $contact->retrieve($this->contact_id);
 157
 158                         if($contact->id != "") {
 159                                 $this->contact_name = $contact->full_name;
 160                                 $this->contact_name_owner = $contact->assigned_user_id;
 161                                 $this->contact_name_mod = 'Contacts';
 162                                 $this->contact_phone = $contact->phone_work;
 163                                 $this->contact_email = $contact->emailAddress->getPrimaryAddress($contact);
 164                         } else {
 165                                 $this->contact_name_mod = '';
 166                                 $this->contact_name_owner = '';
 167                                 $this->contact_name='';
 168                                 $this->contact_email = '';
 169                                 $this->contact_id='';
 170                         }
 171
 172                 }
 173
 174                 $this->fill_in_additional_parent_fields();
 175         }
 176
 177         function fill_in_additional_parent_fields()
 178         {
 179
 180                 $this->parent_name = '';
 181                 global $app_strings, $beanFiles, $beanList, $locale;
 182                 if ( ! isset($beanList[$this->parent_type]))
 183                 {
 184                         $this->parent_name = '';
 185                         return;
 186                 }
 187
 188             $beanType = $beanList[$this->parent_type];
 189                 require_once($beanFiles[$beanType]);
 190                 $parent = new $beanType();
 191
 192                 if (is_subclass_of($parent, 'Person')) {
 193                         $query = "SELECT first_name, last_name, assigned_user_id parent_name_owner from $parent->table_name where id = '$this->parent_id'";
 194                 }
 195                 else if (is_subclass_of($parent, 'File')) {
 196                         $query = "SELECT document_name, assigned_user_id parent_name_owner from $parent->table_name where id = '$this->parent_id'";
 197                 }
 198                 else {
 199
 200                         $query = "SELECT name ";
 201                         if(isset($parent->field_defs['assigned_user_id'])){
 202                                 $query .= " , assigned_user_id parent_name_owner ";
 203                         }else{
 204                                 $query .= " , created_by parent_name_owner ";
 205                         }
 206                         $query .= " from $parent->table_name where id = '$this->parent_id'";
 207                 }
 208                 $result = $this->db->query($query,true," Error filling in additional detail fields: ");
 209
 210                 // Get the id and the name.
 211                 $row = $this->db->fetchByAssoc($result);
 212
 213                 if ($row && !empty($row['parent_name_owner'])){
 214                         $this->parent_name_owner = $row['parent_name_owner'];
 215                         $this->parent_name_mod = $this->parent_type;
 216                 }
 217                 if (is_subclass_of($parent, 'Person') and $row != null)
 218                 {
 219                         $this->parent_name = $locale->getLocaleFormattedName(stripslashes($row['first_name']), stripslashes($row['last_name']));
 220                 }
 221                 else if (is_subclass_of($parent, 'File') && $row != null) {
 222                         $this->parent_name = $row['document_name'];
 223                 }
 224                 elseif($row != null)
 225                 {
 226                         $this->parent_name = stripslashes($row['name']);
 227                 }
 228                 else {
 229                         $this->parent_name = '';
 230                 }
 231         }
 232
 233
 234     protected function formatStartAndDueDates(&$task_fields, $dbtime, $override_date_for_subpanel)
 235     {
 236         global $timedate;
 237
 238         if(empty($dbtime)) return;
 239
 240         $today = $timedate->nowDbDate();
 241
 242         $task_fields['TIME_DUE'] = $timedate->to_display_time($dbtime);
 243         $task_fields['DATE_DUE'] = $timedate->to_display_date($dbtime);
 244
 245         $date_due = $task_fields['DATE_DUE'];
 246
 247         $dd = $timedate->to_db_date($date_due, false);
 248         $taskClass = 'futureTask';
 249                 if ($dd < $today){
 250             $taskClass = 'overdueTask';
 251                 }else if( $dd   == $today ){
 252             $taskClass = 'todaysTask';
 253                 }
 254         $task_fields['DATE_DUE']= "<font class='$taskClass'>$date_due</font>";
 255         if($override_date_for_subpanel){
 256             $task_fields['DATE_START']= "<font class='$taskClass'>$date_due</font>";
 257         }
 258     }
 259
 260         function get_list_view_data(){
 261                 global $action, $currentModule, $focus, $current_module_strings, $app_list_strings, $timedate;
 262
 263                 $override_date_for_subpanel = false;
 264                 if(!empty($_REQUEST['module']) && $_REQUEST['module'] !='Calendar' && $_REQUEST['module'] !='Tasks' && $_REQUEST['module'] !='Home'){
 265                         //this is a subpanel list view, so override the due date with start date so that collections subpanel works as expected
 266                         $override_date_for_subpanel = true;
 267                 }
 268
 269                 $today = $timedate->nowDb();
 270                 $task_fields = $this->get_list_view_array();
 271                 $dbtime = $timedate->to_db($task_fields['DATE_DUE']);
 272                 if($override_date_for_subpanel){
 273                         $dbtime = $timedate->to_db($task_fields['DATE_START']);
 274                 }
 275
 276         if(!empty($dbtime))
 277         {
 278             $task_fields['TIME_DUE'] = $timedate->to_display_time($dbtime);
 279             $task_fields['DATE_DUE'] = $timedate->to_display_date($dbtime);
 280             $this->formatStartAndDueDates($task_fields, $dbtime, $override_date_for_subpanel);
 281         }
 282
 283                 if (!empty($this->priority))
 284                         $task_fields['PRIORITY'] = $app_list_strings['task_priority_dom'][$this->priority];
 285                 if (isset($this->parent_type))
 286                         $task_fields['PARENT_MODULE'] = $this->parent_type;
 287                 if ($this->status != "Completed" && $this->status != "Deferred" )
 288                 {
 289                         $setCompleteUrl = "<a id='{$this->id}' onclick='SUGAR.util.closeActivityPanel.show(\"{$this->module_dir}\",\"{$this->id}\",\"Completed\",\"listview\",\"1\");'>";
 290                     $task_fields['SET_COMPLETE'] = $setCompleteUrl . SugarThemeRegistry::current()->getImage("close_inline","title=".translate('LBL_LIST_CLOSE','Tasks')." border='0'",null,null,'.gif',translate('LBL_LIST_CLOSE','Tasks'))."</a>";
 291                 }
 292
 293         // make sure we grab the localized version of the contact name, if a contact is provided
 294         if (!empty($this->contact_id))
 295         {
 296             $contact_temp = BeanFactory::getBean("Contacts", $this->contact_id);
 297             if (!empty($contact_temp))
 298             {
 299                 // Make first name, last name, salutation and title of Contacts respect field level ACLs
 300                 $contact_temp->_create_proper_name_field();
 301                 $this->contact_name = $contact_temp->full_name;
 302                 $this->contact_phone = $contact_temp->phone_work;
 303             }
 304         }
 305
 306                 $task_fields['CONTACT_NAME']= $this->contact_name;
 307                 $task_fields['CONTACT_PHONE']= $this->contact_phone;
 308                 $task_fields['TITLE'] = '';
 309                 if (!empty($task_fields['CONTACT_NAME'])) {
 310                         $task_fields['TITLE'] .= $current_module_strings['LBL_LIST_CONTACT'].": ".$task_fields['CONTACT_NAME'];
 311                 }
 312                 if (!empty($this->parent_name)) {
 313                         $task_fields['TITLE'] .= "\n".$app_list_strings['parent_type_display'][$this->parent_type].": ".$this->parent_name;
 314                         $task_fields['PARENT_NAME']=$this->parent_name;
 315                 }
 316
 317                 return $task_fields;
 318         }
 319
 320         function set_notification_body($xtpl, $task)
 321         {
 322                 global $app_list_strings;
 323         global $timedate;
 324         $notifyUser = $task->current_notify_user;
 325         $prefDate = $notifyUser->getUserDateTimePreferences();
 326                 $xtpl->assign("TASK_SUBJECT", $task->name);
 327                 //MFH #13507
 328                 $xtpl->assign("TASK_PRIORITY", (isset($task->priority)?$app_list_strings['task_priority_dom'][$task->priority]:""));
 329
 330         if(!empty($task->date_due))
 331         {
 332                     $duedate = $timedate->fromDb($task->date_due);
 333             $xtpl->assign("TASK_DUEDATE", $timedate->asUser($duedate, $notifyUser)." ".TimeDate::userTimezoneSuffix($duedate, $notifyUser));
 334         } else {
 335             $xtpl->assign("TASK_DUEDATE", '');
 336         }
 337
 338                 $xtpl->assign("TASK_STATUS", (isset($task->status)?$app_list_strings['task_status_dom'][$task->status]:""));
 339                 $xtpl->assign("TASK_DESCRIPTION", $task->description);
 340
 341                 return $xtpl;
 342         }
 343
 344         function bean_implements($interface){
 345                 switch($interface){
 346                         case 'ACL':return true;
 347                 }
 348                 return false;
 349         }
 350         function listviewACLHelper(){
 351                 $array_assign = parent::listviewACLHelper();
 352                 $is_owner = false;
 353                 if(!empty($this->parent_name)){
 354                         if(!empty($this->parent_name_owner)){
 355                                 global $current_user;
 356                                 $is_owner = $current_user->id == $this->parent_name_owner;
 357                         }
 358                 }
 359
 360                         if(!ACLController::moduleSupportsACL($this->parent_type) || ACLController::checkAccess($this->parent_type, 'view', $is_owner)){
 361                                 $array_assign['PARENT'] = 'a';
 362                         }else{
 363                                 $array_assign['PARENT'] = 'span';
 364                         }
 365                 $is_owner = false;
 366                 if(!empty($this->contact_name)){
 367                         if(!empty($this->contact_name_owner)){
 368                                 global $current_user;
 369                                 $is_owner = $current_user->id == $this->contact_name_owner;
 370                         }
 371                 }
 372
 373                 if( ACLController::checkAccess('Contacts', 'view', $is_owner)){
 374                                 $array_assign['CONTACT'] = 'a';
 375                 }else{
 376                                 $array_assign['CONTACT'] = 'span';
 377                 }
 378
 379                 return $array_assign;
 380         }
 381
 382         public function getDefaultStatus()
 383     {
 384          $def = $this->field_defs['status'];
 385          if (isset($def['default'])) {
 386              return $def['default'];
 387          } else {
 388             $app = return_app_list_strings_language($GLOBALS['current_language']);
 389             if (isset($def['options']) && isset($app[$def['options']])) {
 390                 $keys = array_keys($app[$def['options']]);
 391                 return $keys[0];
 392             }
 393         }
 394         return '';
 395     }
 396
 397 }