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.
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 require_once('include/SugarObjects/templates/person/Person.php');
55 require_once('include/SugarObjects/templates/person/Person.php');
57 // Lead is used to store profile information for people who may become customers.
58 class Lead extends Person {
64 var $modified_user_id;
65 var $assigned_user_id;
68 var $modified_by_name;
85 var $primary_address_street;
86 var $primary_address_city;
87 var $primary_address_state;
88 var $primary_address_postalcode;
89 var $primary_address_country;
90 var $alt_address_street;
91 var $alt_address_city;
92 var $alt_address_state;
93 var $alt_address_postalcode;
94 var $alt_address_country;
103 var $opportunity_name;
104 var $opportunity_amount;
105 //used for vcard export only
108 var $status_description;
111 var $lead_source_description;
112 // These are for related fields
114 var $acc_name_from_accounts;
116 var $account_description;
125 var $assigned_user_name;
128 var $alt_address_street_2;
129 var $alt_address_street_3;
130 var $primary_address_street_2;
131 var $primary_address_street_3;
134 var $table_name = "leads";
135 var $object_name = "Lead";
136 var $object_names = "Leads";
137 var $module_dir = "Leads";
138 var $new_schema = true;
141 var $importable = true;
143 // This is used to retrieve related fields from form posts.
144 var $additional_column_fields = Array('assigned_user_name', 'task_id', 'note_id', 'meeting_id', 'call_id', 'email_id');
145 var $relationship_fields = Array('email_id'=>'emails','call_id'=>'calls','meeting_id'=>'meetings','task_id'=>'tasks',);
151 function get_account()
153 if(isset($this->account_id) && !empty($this->account_id)){
154 $query = "SELECT name , assigned_user_id account_name_owner FROM accounts WHERE id='{$this->account_id}'";
156 //requireSingleResult has beeen deprecated.
157 //$result = $this->db->requireSingleResult($query);
158 $result = $this->db->limitQuery($query,0,1,true, "Want only a single row");
161 $row = $this->db->fetchByAssoc($result);
162 $this->account_name = $row['name'];
163 $this->account_name_owner = $row['account_name_owner'];
164 $this->account_name_mod = 'Accounts';
168 function get_opportunity()
170 if(isset($this->opportunity_id) && !empty($this->opportunity_id)){
171 $query = "SELECT name, assigned_user_id opportunity_name_owner FROM opportunities WHERE id='{$this->opportunity_id}'";
173 //requireSingleResult has beeen deprecated.
174 //$result = $this->db->requireSingleResult($query);
175 $result = $this->db->limitQuery($query,0,1,true, "Want only a single row");
178 $row = $this->db->fetchByAssoc($result);
179 $this->opportunity_name = $row['name'];
180 $this->opportunity_name_owner = $row['opportunity_name_owner'];
181 $this->opportunity_name_mod = 'Opportunities';
185 function get_contact()
188 if(isset($this->contact_id) && !empty($this->contact_id)){
189 $query = "SELECT first_name, last_name, assigned_user_id contact_name_owner FROM contacts WHERE id='{$this->contact_id}'";
191 //requireSingleResult has beeen deprecated.
192 //$result = $this->db->requireSingleResult($query);
193 $result = $this->db->limitQuery($query,0,1,true, "Want only a single row");
195 $row= $this->db->fetchByAssoc($result);
196 $this->contact_name = $locale->getLocaleFormattedName($row['first_name'], $row['last_name']);
197 $this->contact_name_owner = $row['contact_name_owner'];
198 $this->contact_name_mod = 'Contacts';
203 function create_list_query($order_by, $where, $show_deleted=0)
205 $custom_join = $this->getCustomJoin();
209 $query .= "$this->table_name.*, users.user_name assigned_user_name";
210 $query .= $custom_join['select'];
211 $query .= " FROM leads ";
213 $query .= " LEFT JOIN users
214 ON leads.assigned_user_id=users.id ";
215 $query .= "LEFT JOIN email_addr_bean_rel eabl ON eabl.bean_id = leads.id AND eabl.bean_module = 'Leads' and eabl.primary_address = 1 and eabl.deleted=0 ";
216 $query .= "LEFT JOIN email_addresses ea ON (ea.id = eabl.email_address_id) ";
217 $query .= $custom_join['join'];
219 if($show_deleted == 0){
220 $where_auto = " leads.deleted=0 ";
221 }else if($show_deleted == 1){
222 $where_auto = " leads.deleted=1 ";
226 $query .= "where ($where) AND ".$where_auto;
228 $query .= "where ".$where_auto; //."and (leads.converted='0')";
230 if(!empty($order_by))
231 $query .= " ORDER BY $order_by";
236 function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false, $parentbean = null, $singleSelect = false){
238 $ret_array = parent::create_new_list_query($order_by, $where, $filter, $params, $show_deleted, $join_type, true, $parentbean, $singleSelect);
239 if(strpos($ret_array['select'],"leads.account_name") == false && strpos($ret_array['select'],"leads.*") == false)
240 $ret_array['select'] .= " ,leads.account_name";
241 if ( !$return_array )
242 return $ret_array['select'] . $ret_array['from'] . $ret_array['where']. $ret_array['order_by'];
246 function create_export_query(&$order_by, &$where, $relate_link_join='')
248 $custom_join = $this->getCustomJoin(true, true, $where);
249 $custom_join['join'] .= $relate_link_join;
251 leads.*, email_addresses.email_address email_address,
252 users.user_name assigned_user_name";
253 $query .= $custom_join['select'];
254 $query .= " FROM leads ";
255 $query .= " LEFT JOIN users
256 ON leads.assigned_user_id=users.id ";
258 //join email address table too.
259 $query .= ' LEFT JOIN email_addr_bean_rel on leads.id = email_addr_bean_rel.bean_id and email_addr_bean_rel.bean_module=\'Leads\' and email_addr_bean_rel.deleted=0 and email_addr_bean_rel.primary_address=1 ';
260 $query .= ' LEFT JOIN email_addresses on email_addresses.id = email_addr_bean_rel.email_address_id ' ;
263 $query .= $custom_join['join'];
265 $where_auto = " leads.deleted=0 ";
268 $query .= "where ($where) AND ".$where_auto;
270 $query .= "where ".$where_auto;
272 if(!empty($order_by))
273 $query .= " ORDER BY $order_by";
277 function converted_lead($leadid, $contactid, $accountid, $opportunityid){
278 $query = "UPDATE leads set converted='1', contact_id=$contactid, account_id=$accountid, opportunity_id=$opportunityid where id=$leadid and deleted=0";
279 $this->db->query($query,true,"Error converting lead: ");
281 //we must move the status out here in order to be able to capture workflow conditions
282 $leadid = str_replace("'","", $leadid);
284 $lead->retrieve($leadid);
285 $lead->status='Converted';
289 function fill_in_additional_list_fields()
291 parent::fill_in_additional_list_fields();
292 $this->_create_proper_name_field();
293 $this->get_account();
297 function fill_in_additional_detail_fields()
299 //Fill in the assigned_user_name
300 //if(!empty($this->status))
301 //$this->status = translate('lead_status_dom', '', $this->status);
302 parent::fill_in_additional_detail_fields();
303 $this->_create_proper_name_field();
304 $this->get_contact();
305 $this->get_opportunity();
306 $this->get_account();
308 if(!empty($this->campaign_id)){
310 $camp = new Campaign();
311 $where = "campaigns.id='$this->campaign_id'";
312 $campaign_list = $camp->get_full_list("campaigns.name", $where, true);
313 if(!empty($campaign_list))
314 $this->campaign_name = $campaign_list[0]->name;
318 function get_list_view_data(){
319 /*global $app_list_strings;
320 global $current_user;
322 $temp_array = $this->get_list_view_array();
323 $temp_array['STATUS'] = (empty($temp_array['STATUS'])) ? '' : $temp_array['STATUS'];
324 $temp_array['ENCODED_NAME']=$this->name;
325 $temp_array['NAME']=$this->name;
326 $temp_array['EMAIL1'] = $this->emailAddress->getPrimaryAddress($this);
327 $this->email1 = $temp_array['EMAIL1'];
328 $temp_array['EMAIL1_LINK'] = $current_user->getEmailLink('email1', $this, '', '', 'ListView');
329 $temp_array['ACC_NAME_FROM_ACCOUNTS'] = empty($temp_array['ACC_NAME_FROM_ACCOUNTS']) ? ($temp_array['ACCOUNT_NAME']) : ($temp_array['ACC_NAME_FROM_ACCOUNTS']);
332 $this->_create_proper_name_field();
333 $temp_array = parent::get_list_view_data();
334 $temp_array['ACC_NAME_FROM_ACCOUNTS'] = empty($temp_array['ACC_NAME_FROM_ACCOUNTS']) ? ($temp_array['ACCOUNT_NAME']) : ($temp_array['ACC_NAME_FROM_ACCOUNTS']);
339 * Returns an array of fields that are of type link.
341 * @return array List of fields.
343 * Internal function, do not override.
345 //fix for bug 27339 Shine
346 function get_linked_fields()
348 $linked_fields=array();
349 $fieldDefs = $this->getFieldDefinitions();
351 //find all definitions of type link.
352 if (!empty($fieldDefs))
354 foreach ($fieldDefs as $name=>$properties)
356 if ($name == 'oldmeetings' || $name == 'oldcalls') { continue; }
357 elseif (array_search('link',$properties) === 'type')
359 $linked_fields[$name]=$properties;
363 return $linked_fields;
367 builds a generic search based on the query string using or
368 do not include any $this-> because this is called on without having the class instantiated
370 function build_generic_where_clause ($the_query_string) {
371 $where_clauses = Array();
372 $the_query_string = $GLOBALS['db']->quote($the_query_string);
374 array_push($where_clauses, "leads.last_name like '$the_query_string%'");
375 array_push($where_clauses, "leads.account_name like '$the_query_string%'");
376 array_push($where_clauses, "leads.first_name like '$the_query_string%'");
377 array_push($where_clauses, "ea.email_address like '$the_query_string%'");
379 if (is_numeric($the_query_string)) {
380 array_push($where_clauses, "leads.phone_home like '%$the_query_string%'");
381 array_push($where_clauses, "leads.phone_mobile like '%$the_query_string%'");
382 array_push($where_clauses, "leads.phone_work like '%$the_query_string%'");
383 array_push($where_clauses, "leads.phone_other like '%$the_query_string%'");
384 array_push($where_clauses, "leads.phone_fax like '%$the_query_string%'");
389 foreach($where_clauses as $clause)
391 if($the_where != "") $the_where .= " or ";
392 $the_where .= $clause;
399 function set_notification_body($xtpl, $lead)
401 global $app_list_strings;
404 $xtpl->assign("LEAD_NAME", $locale->getLocaleFormattedName($lead->first_name, $lead->last_name, $lead->salutation));
405 $xtpl->assign("LEAD_SOURCE", (isset($lead->lead_source) ? $app_list_strings['lead_source_dom'][$lead->lead_source] : ""));
406 $xtpl->assign("LEAD_STATUS", (isset($lead->status)? $app_list_strings['lead_status_dom'][$lead->status]:""));
407 $xtpl->assign("LEAD_DESCRIPTION", $lead->description);
412 function bean_implements($interface){
414 case 'ACL':return true;
418 function listviewACLHelper(){
419 $array_assign = parent::listviewACLHelper();
421 if(!empty($this->account_name)){
423 if(!empty($this->account_name_owner)){
424 global $current_user;
425 $is_owner = $current_user->id == $this->account_name_owner;
428 if( ACLController::checkAccess('Accounts', 'view', $is_owner)){
429 $array_assign['ACCOUNT'] = 'a';
431 $array_assign['ACCOUNT'] = 'span';
434 if(!empty($this->opportunity_name)){
436 if(!empty($this->opportunity_name_owner)){
437 global $current_user;
438 $is_owner = $current_user->id == $this->opportunity_name_owner;
441 if( ACLController::checkAccess('Opportunities', 'view', $is_owner)){
442 $array_assign['OPPORTUNITY'] = 'a';
444 $array_assign['OPPORTUNITY'] = 'span';
449 if(!empty($this->contact_name)){
451 if(!empty($this->contact_name_owner)){
452 global $current_user;
453 $is_owner = $current_user->id == $this->contact_name_owner;
456 if( ACLController::checkAccess('Contacts', 'view', $is_owner)){
457 $array_assign['CONTACT'] = 'a';
459 $array_assign['CONTACT'] = 'span';
462 return $array_assign;
465 //carrys forward custom lead fields to contacts, accounts, opportunities during Lead Conversion
466 function convertCustomFieldsForm(&$form, &$tempBean, &$prefix) {
468 global $mod_strings, $app_list_strings, $app_strings, $lbl_required_symbol;
470 foreach($this->field_defs as $field => $value) {
472 if(!empty($value['source']) && $value['source'] == 'custom_fields') {
473 if( !empty($tempBean->field_defs[$field]) AND isset($tempBean->field_defs[$field]) ) {
474 $form .= "<tr><td nowrap colspan='4' class='dataLabel'>".$mod_strings[$tempBean->field_defs[$field]['vname']].":";
476 if( !empty($tempBean->custom_fields->avail_fields[$field]['required']) AND ( ($tempBean->custom_fields->avail_fields[$field]['required']== 1) OR ($tempBean->custom_fields->avail_fields[$field]['required']== '1') OR ($tempBean->custom_fields->avail_fields[$field]['required']== 'true') OR ($tempBean->custom_fields->avail_fields[$field]['required']== true) ) ) {
477 $form .= " <span class='required'>".$lbl_required_symbol."</span>";
479 $form .= "</td></tr>";
480 $form .= "<tr><td nowrap colspan='4' class='dataField' nowrap>";
482 if(isset($value['isMultiSelect']) && $value['isMultiSelect'] == 1){
483 $this->$field = unencodeMultienum($this->$field);
484 $multiple = "multiple";
491 if(!empty($value['options']) AND isset($value['options']) ) {
492 $form .= "<select " . $multiple . " name='".$prefix.$field.$array."'>";
493 $form .= get_select_options_with_id($app_list_strings[$value['options']], $this->$field);
495 } elseif($value['type'] == 'bool' ) {
496 if( ($this->$field == 1) OR ($this->$field == '1') ) { $checked = 'checked'; } else { $checked = ''; }
497 $form .= "<input type='checkbox' name='".$prefix.$field."' id='".$prefix.$field."' value='1' ".$checked."/>";
498 } elseif($value['type'] == 'text' ) {
499 $form .= "<textarea name='".$prefix.$field."' rows='6' cols='50'>".$this->$field."</textarea>";
500 } elseif($value['type'] == 'date' ) {
501 $form .= "<input name='".$prefix.$field."' id='jscal_field".$field."' type='text' size='11' maxlength='10' value='".$this->$field."'> ".SugarThemeRegistry::current()->getImage("jscalendar", "id='jscal_trigger".$field."' align='absmiddle'", null, null, ".gif", $mod_strings['LBL_ENTERDATE'])."' <span class='dateFormat'>yyyy-mm-dd</span><script type='text/javascript'>Calendar.setup ({inputField : 'jscal_field".$field."', ifFormat : '%Y-%m-%d', showsTime : false, button : 'jscal_trigger".$field."', singleClick : true, step : 1, weekNumbers:false}); addToValidate('ConvertLead', '".$field."', 'date', false,'".$mod_strings[$tempBean->field_defs[$field]['vname']]."' );</script>";
503 $form .= "<input name='".$prefix.$field."' type='text' value='".$this->$field."'>";
505 if($this->custom_fields->avail_fields[$field]['type'] == 'int') {
506 $form .= "<script>addToValidate('ConvertLead', '".$prefix.$field."', 'int', false,'".$prefix.":".$mod_strings[$tempBean->field_defs[$field]['vname']]."' );</script>";
508 elseif($this->custom_fields->avail_fields[$field]['type'] == 'float') {
509 $form .= "<script>addToValidate('ConvertLead', '".$prefix.$field."', 'float', false,'".$prefix.":".$mod_strings[$tempBean->field_defs[$field]['vname']]."' );</script>";
514 if( !empty($tempBean->custom_fields->avail_fields[$field]['required']) AND ( ($tempBean->custom_fields->avail_fields[$field]['required']== 1) OR ($tempBean->custom_fields->avail_fields[$field]['required']== '1') OR ($tempBean->custom_fields->avail_fields[$field]['required']== 'true') OR ($tempBean->custom_fields->avail_fields[$field]['required']== true) ) ) {
515 $form .= "<script>addToValidate('ConvertLead', '".$prefix.$field."', 'relate', true,'".$prefix.":".$mod_strings[$tempBean->field_defs[$field]['vname']]."' );</script>";
518 $form .= "</td></tr>";
529 function save($check_notify = false) {
530 if(empty($this->status))
531 $this->status = 'New';
532 // call save first so that $this->id will be set
533 $value = parent::save($check_notify);
536 function get_unlinked_email_query($type=array()) {
538 return get_unlinked_email_query($type, $this);
542 * Returns query to find the related calls created pre-5.1
544 * @return string SQL statement
546 public function get_old_related_calls()
548 $return_array['select']='SELECT calls.id ';
549 $return_array['from']='FROM calls ';
550 $return_array['where']=" WHERE calls.parent_id = '$this->id'
551 AND calls.parent_type = 'Leads' AND calls.id NOT IN ( SELECT call_id FROM calls_leads ) ";
552 $return_array['join'] = "";
553 $return_array['join_tables'][0] = '';
555 return $return_array;
559 * Returns array of lead conversion activity options
561 * @return string SQL statement
563 public static function getActivitiesOptions() {
565 if (isset($GLOBALS['app_list_strings']['lead_conv_activity_opt'])) {
566 return $GLOBALS['app_list_strings']['lead_conv_activity_opt'];
574 * Returns query to find the related meetings created pre-5.1
576 * @return string SQL statement
578 public function get_old_related_meetings()
580 $return_array['select']='SELECT meetings.id ';
581 $return_array['from']='FROM meetings ';
582 $return_array['where']=" WHERE meetings.parent_id = '$this->id'
583 AND meetings.parent_type = 'Leads' AND meetings.id NOT IN ( SELECT meeting_id FROM meetings_leads ) ";
584 $return_array['join'] = "";
585 $return_array['join_tables'][0] = '';
587 return $return_array;