]> CyberLeo.Net >> Repos - Github/sugarcrm.git/blob - include/export_utils.php
Release 6.3.0
[Github/sugarcrm.git] / include / export_utils.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-2011 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
40  * Description:
41  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights
42  * Reserved. Contributor(s): ______________________________________..
43  * *******************************************************************************/
44
45 /**
46  * gets the system default delimiter or an user-preference based override
47  * @return string the delimiter
48  */
49 function getDelimiter() {
50         global $sugar_config;
51         global $current_user;
52
53         $delimiter = ','; // default to "comma"
54         $userDelimiter = $current_user->getPreference('export_delimiter');
55         $delimiter = empty($sugar_config['export_delimiter']) ? $delimiter : $sugar_config['export_delimiter'];
56         $delimiter = empty($userDelimiter) ? $delimiter : $userDelimiter;
57
58         return $delimiter;
59 }
60
61
62 /**
63  * builds up a delimited string for export
64  * @param string type the bean-type to export
65  * @param array records an array of records if coming directly from a query
66  * @return string delimited string for export
67  */
68 function export($type, $records = null, $members = false, $sample=false) {
69         global $beanList;
70         global $beanFiles;
71         global $current_user;
72         global $app_strings;
73         global $app_list_strings;
74         global $timedate;
75     global $mod_strings;
76     global $current_language;
77     $sampleRecordNum = 5;
78         $contact_fields = array(
79                 "id"=>"Contact ID"
80                 ,"lead_source"=>"Lead Source"
81                 ,"date_entered"=>"Date Entered"
82                 ,"date_modified"=>"Date Modified"
83                 ,"first_name"=>"First Name"
84                 ,"last_name"=>"Last Name"
85                 ,"salutation"=>"Salutation"
86                 ,"birthdate"=>"Lead Source"
87                 ,"do_not_call"=>"Do Not Call"
88                 ,"email_opt_out"=>"Email Opt Out"
89                 ,"title"=>"Title"
90                 ,"department"=>"Department"
91                 ,"birthdate"=>"Birthdate"
92                 ,"do_not_call"=>"Do Not Call"
93                 ,"phone_home"=>"Phone (Home)"
94                 ,"phone_mobile"=>"Phone (Mobile)"
95                 ,"phone_work"=>"Phone (Work)"
96                 ,"phone_other"=>"Phone (Other)"
97                 ,"phone_fax"=>"Fax"
98                 ,"email1"=>"Email"
99                 ,"email2"=>"Email (Other)"
100                 ,"assistant"=>"Assistant"
101                 ,"assistant_phone"=>"Assistant Phone"
102                 ,"primary_address_street"=>"Primary Address Street"
103                 ,"primary_address_city"=>"Primary Address City"
104                 ,"primary_address_state"=>"Primary Address State"
105                 ,"primary_address_postalcode"=>"Primary Address Postalcode"
106                 ,"primary_address_country"=>"Primary Address Country"
107                 ,"alt_address_street"=>"Other Address Street"
108                 ,"alt_address_city"=>"Other Address City"
109                 ,"alt_address_state"=>"Other Address State"
110                 ,"alt_address_postalcode"=>"Other Address Postalcode"
111                 ,"alt_address_country"=>"Other Address Country"
112                 ,"description"=>"Description"
113         );
114
115         $account_fields = array(
116                 "id"=>"Account ID",
117                 "name"=>"Account Name",
118                 "website"=>"Website",
119                 "industry"=>"Industry",
120                 "account_type"=>"Type",
121                 "ticker_symbol"=>"Ticker Symbol",
122                 "employees"=>"Employees",
123                 "ownership"=>"Ownership",
124                 "phone_office"=>"Phone",
125                 "phone_fax"=>"Fax",
126                 "phone_alternate"=>"Other Phone",
127                 "email1"=>"Email",
128                 "email2"=>"Other Email",
129                 "rating"=>"Rating",
130                 "sic_code"=>"SIC Code",
131                 "annual_revenue"=>"Annual Revenue",
132                 "billing_address_street"=>"Billing Address Street",
133                 "billing_address_city"=>"Billing Address City",
134                 "billing_address_state"=>"Billing Address State",
135                 "billing_address_postalcode"=>"Billing Address Postalcode",
136                 "billing_address_country"=>"Billing Address Country",
137                 "shipping_address_street"=>"Shipping Address Street",
138                 "shipping_address_city"=>"Shipping Address City",
139                 "shipping_address_state"=>"Shipping Address State",
140                 "shipping_address_postalcode"=>"Shipping Address Postalcode",
141                 "shipping_address_country"=>"Shipping Address Country",
142                 "description"=>"Description"
143         );
144         $focus = 0;
145         $content = '';
146
147         $bean = $beanList[$type];
148         require_once($beanFiles[$bean]);
149         $focus = new $bean;
150     $searchFields = array();
151         $db = DBManagerFactory::getInstance();
152
153         if($records) {
154                 $records = explode(',', $records);
155                 $records = "'" . implode("','", $records) . "'";
156                 $where = "{$focus->table_name}.id in ($records)";
157         } elseif (isset($_REQUEST['all']) ) {
158                 $where = '';
159         } else {
160                 if(!empty($_REQUEST['current_post'])) {
161                         $ret_array = generateSearchWhere($type, $_REQUEST['current_post']);
162
163                         $where = $ret_array['where'];
164                         $searchFields = $ret_array['searchFields'];
165                 } else {
166                         $where = '';
167                 }
168         }
169         $order_by = "";
170         if($focus->bean_implements('ACL')){
171                 if(!ACLController::checkAccess($focus->module_dir, 'export', true)){
172                         ACLController::displayNoAccess();
173                         sugar_die('');
174                 }
175                 if(ACLController::requireOwner($focus->module_dir, 'export')){
176                         if(!empty($where)){
177                                 $where .= ' AND ';
178                         }
179                         $where .= $focus->getOwnerWhere($current_user->id);
180                 }
181
182         }
183     // Export entire list was broken because the where clause already has "where" in it
184     // and when the query is built, it has a "where" as well, so the query was ill-formed.
185     // Eliminating the "where" here so that the query can be constructed correctly.
186     if($members == true){
187                 $query = $focus->create_export_members_query($records);
188     }else{
189                 $beginWhere = substr(trim($where), 0, 5);
190             if ($beginWhere == "where")
191                 $where = substr(trim($where), 5, strlen($where));
192         $ret_array = create_export_query_relate_link_patch($type, $searchFields, $where);
193         if(!empty($ret_array['join'])) {
194                 $query = $focus->create_export_query($order_by,$ret_array['where'],$ret_array['join']);
195         } else {
196                 $query = $focus->create_export_query($order_by,$ret_array['where']);
197         }
198     }
199
200     $result = '';
201     $populate = false;
202     if($sample) {
203        $result = $db->limitQuery($query, 0, $sampleRecordNum, true, $app_strings['ERR_EXPORT_TYPE'].$type.": <BR>.".$query);
204         if( $focus->_get_num_rows_in_query($query)<1 ){
205             $populate = true;
206         }
207         }else{
208         $result = $db->query($query, true, $app_strings['ERR_EXPORT_TYPE'].$type.": <BR>.".$query);
209     }
210
211
212         $fields_array = $db->getFieldsArray($result,true);
213
214     //set up the order on the header row
215     $fields_array = get_field_order_mapping($focus->module_dir, $fields_array);
216
217     //set up labels to be used for the header row
218     $field_labels = $fields_array;
219     foreach($fields_array as $dbname){
220         //default to the db name of label does not exist
221         $field_labels[$dbname] = translateForExport($dbname,$focus);
222     }
223
224         // setup the "header" line with proper delimiters
225         $header = implode("\"".getDelimiter()."\"", array_values($field_labels));
226         if($members){
227                 $header = str_replace('"ea_deleted"'.getDelimiter().'"ear_deleted"'.getDelimiter().'"primary_address"'.getDelimiter().'','',$header);
228         }
229         $header = "\"" .$header;
230         $header .= "\"\r\n";
231         $content .= $header;
232         $pre_id = '';
233
234     if($populate){
235         //this is a sample request with no data, so create fake datarows
236          $content .= returnFakeDataRow($focus,$fields_array,$sampleRecordNum);
237     }else{
238         //process retrieved record
239         while($val = $db->fetchByAssoc($result, -1, false)) {
240
241             //order the values in the record array
242             $val = get_field_order_mapping($focus->module_dir,$val);
243
244             $new_arr = array();
245                 if($members){
246                         if($pre_id == $val['id'])
247                                 continue;
248                         if($val['ea_deleted']==1 || $val['ear_deleted']==1){
249                                 $val['primary_email_address'] = '';
250                         }
251                         unset($val['ea_deleted']);
252                         unset($val['ear_deleted']);
253                         unset($val['primary_address']);
254                 }
255                 $pre_id = $val['id'];
256
257                 foreach ($val as $key => $value)
258                 {
259             //getting content values depending on their types
260             $fieldNameMapKey = $fields_array[$key];
261
262             if (isset($focus->field_name_map[$fieldNameMapKey])  && $focus->field_name_map[$fieldNameMapKey]['type'])
263             {
264                 $fieldType = $focus->field_name_map[$fieldNameMapKey]['type'];
265                 switch ($fieldType)
266                 {
267                     //if our value is a currency field, then apply the users locale
268                     case 'currency':
269                         require_once('modules/Currencies/Currency.php');
270                         $value = currency_format_number($value);
271                         break;
272
273                     //if our value is a datetime field, then apply the users locale
274                     case 'datetime':
275                     case 'datetimecombo':
276                         $value = $timedate->to_display_date_time($value);
277                         $value = preg_replace('/([pm|PM|am|AM]+)/', ' \1', $value);
278                         break;
279
280                     //kbrill Bug #16296
281                     case 'date':
282                         $value = $timedate->to_display_date($value, false);
283                         break;
284
285                     // Bug 32463 - Properly have multienum field translated into something useful for the client
286                     case 'multienum':
287                         $value = str_replace("^","",$value);
288                         if (isset($focus->field_name_map[$fields_array[$key]]['options']) && isset($app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']]) )
289                         {
290                             $valueArray = explode(",",$value);
291                             foreach ($valueArray as $multikey => $multivalue )
292                             {
293                                 if (isset($app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']][$multivalue]) )
294                                 {
295                                     $valueArray[$multikey] = $app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']][$multivalue];
296                                 }
297                             }
298                             $value = implode(",",$valueArray);
299                         }
300                         break;
301                 }
302             }
303
304         array_push($new_arr, preg_replace("/\"/","\"\"", $value));
305         }
306         $line = implode("\"".getDelimiter()."\"", $new_arr);
307         $line = "\"" .$line;
308         $line .= "\"\r\n";
309         $content .= $line;
310     }
311
312
313     }
314         return $content;
315     
316 }
317
318 function generateSearchWhere($module, $query) {//this function is similar with function prepareSearchForm() in view.list.php
319     $seed = loadBean($module);
320     if(file_exists('modules/'.$module.'/SearchForm.html')){
321         if(file_exists('modules/' . $module . '/metadata/SearchFields.php')) {
322             require_once('include/SearchForm/SearchForm.php');
323             $searchForm = new SearchForm($module, $seed);
324         }
325         elseif(!empty($_SESSION['export_where'])) { //bug 26026, sometimes some module doesn't have a metadata/SearchFields.php, the searchfrom is generated in the ListView.php.
326         //So currently massupdate will not gernerate the where sql. It will use the sql stored in the SESSION. But this will cause bug 24722, and it cannot be avoided now.
327             $where = $_SESSION['export_where'];
328             $whereArr = explode (" ", trim($where));
329             if ($whereArr[0] == trim('where')) {
330                 $whereClean = array_shift($whereArr);
331             }
332             $where = implode(" ", $whereArr);
333             //rrs bug: 31329 - previously this was just returning $where, but the problem is the caller of this function
334             //expects the results in an array, not just a string. So rather than fixing the caller, I felt it would be best for
335             //the function to return the results in a standard format.
336             $ret_array['where'] = $where;
337                 $ret_array['searchFields'] =array();
338             return $ret_array;
339         }
340         else {
341             return;
342         }
343     }
344     else{
345         require_once('include/SearchForm/SearchForm2.php');
346
347         if(file_exists('custom/modules/'.$module.'/metadata/metafiles.php')){
348             require('custom/modules/'.$module.'/metadata/metafiles.php');
349         }elseif(file_exists('modules/'.$module.'/metadata/metafiles.php')){
350             require('modules/'.$module.'/metadata/metafiles.php');
351         }
352
353         if (file_exists('custom/modules/'.$module.'/metadata/searchdefs.php'))
354         {
355             require_once('custom/modules/'.$module.'/metadata/searchdefs.php');
356         }
357         elseif (!empty($metafiles[$module]['searchdefs']))
358         {
359             require_once($metafiles[$module]['searchdefs']);
360         }
361         elseif (file_exists('modules/'.$module.'/metadata/searchdefs.php'))
362         {
363             require_once('modules/'.$module.'/metadata/searchdefs.php');
364         }
365
366         if(!empty($metafiles[$module]['searchfields']))
367             require_once($metafiles[$module]['searchfields']);
368         elseif(file_exists('modules/'.$module.'/metadata/SearchFields.php'))
369             require_once('modules/'.$module.'/metadata/SearchFields.php');
370         if(empty($searchdefs) || empty($searchFields)) {
371            //for some modules, such as iframe, it has massupdate, but it doesn't have search function, the where sql should be empty.
372             return;
373         }
374         $searchForm = new SearchForm($seed, $module);
375         $searchForm->setup($searchdefs, $searchFields, 'include/SearchForm/tpls/SearchFormGeneric.tpl');
376     }
377     $searchForm->populateFromArray(unserialize(base64_decode($query)));
378     $where_clauses = $searchForm->generateSearchWhere(true, $module);
379     if (count($where_clauses) > 0 )$where = '('. implode(' ) AND ( ', $where_clauses) . ')';
380         $GLOBALS['log']->info("Export Where Clause: {$where}");
381     $ret_array['where'] = $where;
382     $ret_array['searchFields'] = $searchForm->searchFields;
383     return $ret_array;
384 }
385 /**
386   * calls export method to build up a delimited string and some sample instructional text on how to use this file
387   * @param string type the bean-type to export
388   * @return string delimited string for export with some tutorial text
389   */
390      function exportSample($type) {
391          global $app_strings;
392
393          //first grab the
394          $_REQUEST['all']=true;
395
396          //retrieve the export content
397          $content = export($type, null, false, true);
398
399          //add details on removing the sample data
400          return $content . $app_strings['LBL_IMPORT_SAMPLE_FILE_TEXT'];
401
402      }
403  //this function will take in the bean and field mapping and return a proper value
404  function returnFakeDataRow($focus,$field_array,$rowsToReturn = 5){
405
406     if(empty($focus) || empty($field_array))
407      return ;
408
409      //include the file that defines $sugar_demodata
410      include('install/demoData.en_us.php');
411
412     $person_bean = false;
413     if( isset($focus->first_name)){
414         $person_bean = true;
415     }
416
417      global $timedate;
418      $returnContent = '';
419      $counter = 0;
420      $new_arr = array();
421
422      //iterate through the record creation process as many times as defined.  Each iteration will create a new row
423      while($counter < $rowsToReturn){
424          $counter++;
425          //go through each field and populate with dummy data if possible
426          foreach($field_array as $field_name){
427
428             if(empty($focus->field_name_map[$field_name]) || empty($focus->field_name_map[$field_name]['type'])){
429                 //type is not set, fill in with empty string and continue;
430                 $returnContent .= '"",';
431                 continue;
432             }
433             $field = $focus->field_name_map[$field_name];
434                          //fill in value according to type
435             $type = $field['type'];
436
437              switch ($type) {
438
439                  case "id":
440                  case "assigned_user_name":
441                      //return new guid string
442                     $returnContent .= '"'.create_guid().'",';
443                      break;
444                  case "int":
445                      //return random number`
446                     $returnContent .= '"'.mt_rand(0,4).'",';
447                      break;
448                  case "name":
449                      //return first, last, user name, or random name string
450                      if($field['name'] == 'first_name'){
451                          $count = count($sugar_demodata['first_name_array']) - 1;
452                         $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
453                      }elseif($field['name'] == 'last_name'){
454                          $count = count($sugar_demodata['last_name_array']) - 1;
455                          $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
456                      }elseif($field['name'] == 'user_name'){
457                        $count = count($sugar_demodata['first_name_array']) - 1;
458                         $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'_'.mt_rand(1,111).'",';
459                      }else{
460                          //return based on bean
461                          if($focus->module_dir =='Accounts'){
462                              $count = count($sugar_demodata['company_name_array']) - 1;
463                             $returnContent .= '"'.$sugar_demodata['company_name_array'][mt_rand(0,$count)].'",';
464
465                          }elseif($focus->module_dir =='Bugs'){
466                              $count = count($sugar_demodata['bug_seed_names']) - 1;
467                             $returnContent .= '"'.$sugar_demodata['bug_seed_names'][mt_rand(0,$count)].'",';
468                          }elseif($focus->module_dir =='Notes'){
469                              $count = count($sugar_demodata['note_seed_names_and_Descriptions']) - 1;
470                             $returnContent .= '"'.$sugar_demodata['note_seed_names_and_Descriptions'][mt_rand(0,$count)].'",';
471
472                          }elseif($focus->module_dir =='Calls'){
473                               $count = count($sugar_demodata['call_seed_data_names']) - 1;
474                             $returnContent .= '"'.$sugar_demodata['call_seed_data_names'][mt_rand(0,$count)].'",';
475
476                          }elseif($focus->module_dir =='Tasks'){
477                              $count = count($sugar_demodata['task_seed_data_names']) - 1;
478                            $returnContent .= '"'.$sugar_demodata['task_seed_data_names'][mt_rand(0,$count)].'",';
479
480                          }elseif($focus->module_dir =='Meetings'){
481                              $count = count($sugar_demodata['meeting_seed_data_names']) - 1;
482                            $returnContent .= '"'.$sugar_demodata['meeting_seed_data_names'][mt_rand(0,$count)].'",';
483
484                          }elseif($focus->module_dir =='ProductCategories'){
485                              $count = count($sugar_demodata['productcategory_seed_data_names']) - 1;
486                            $returnContent .= '"'.$sugar_demodata['productcategory_seed_data_names'][mt_rand(0,$count)].'",';
487
488
489                          }elseif($focus->module_dir =='ProductTypes'){
490                              $count = count($sugar_demodata['producttype_seed_data_names']) - 1;
491                            $returnContent .= '"'.$sugar_demodata['producttype_seed_data_names'][mt_rand(0,$count)].'",';
492
493
494                          }elseif($focus->module_dir =='ProductTemplates'){
495                              $count = count($sugar_demodata['producttemplate_seed_data']) - 1;
496                            $returnContent .= '"'.$sugar_demodata['producttemplate_seed_data'][mt_rand(0,$count)].'",';
497
498                          }else{
499                            $returnContent .= '"Default Name for '.$focus->module_dir.'",';
500
501                          }
502
503                      }
504                     break;
505                  case "relate":
506                      if($field['name'] == 'team_name'){
507                          //apply team names and user_name
508                          $teams_count = count($sugar_demodata['teams']) - 1;
509                          $users_count = count($sugar_demodata['users']) - 1;
510
511                      $returnContent .= '"'.$sugar_demodata['teams'][mt_rand(0,$teams_count)]['name'].','.$sugar_demodata['users'][mt_rand(0,$users_count)]['user_name'].'",';
512
513                      }else{
514                          //apply GUID
515                          $returnContent .= '"'.create_guid().'",';
516                      }
517                      break;
518                  case "bool":
519                      //return 0 or 1
520                      $returnContent .= '"'.mt_rand(0,1).'",';
521                      break;
522
523                  case "text":
524                      //return random text
525                      $returnContent .= '"Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas porttitor congue massa. Fusce posuere, magna sed pulvinar ultricies, purus lectus malesuada libero, sit amet commodo magna eros quis urna",';
526                      break;
527
528                  case "team_list":
529                      $teams_count = count($sugar_demodata['teams']) - 1;
530                      //give fake team names (East,West,North,South)
531                      $returnContent .= '"'.$sugar_demodata['teams'][mt_rand(0,$teams_count)]['name'].'",';
532                      break;
533
534                  case "date":
535                      //return formatted date
536                      $timeStamp = strtotime('now');
537                      $value =    date($timedate->dbDayFormat, $timeStamp);
538                      $returnContent .= '"'.$timedate->to_display_date_time($value).'",';
539                      break;
540
541                  case "datetime":
542                  case "datetimecombo":
543                      //return formatted date time
544                      $timeStamp = strtotime('now');
545                      //Start with db date
546                      $value =    date($timedate->dbDayFormat.' '.$timedate->dbTimeFormat, $timeStamp);
547                      //use timedate to convert to user display format
548                      $value = $timedate->to_display_date_time($value);
549                      //finally forma the am/pm to have a space so it can be recognized as a date field in excel
550                      $value = preg_replace('/([pm|PM|am|AM]+)/', ' \1', $value);
551                      $returnContent .= '"'.$value.'",';
552
553                      break;
554                 case "phone":
555                     $value = '('.mt_rand(300,999).') '.mt_rand(300,999).'-'.mt_rand(1000,9999);
556                       $returnContent .= '"'.$value.'",';
557                      break;
558                  case "varchar":
559                                      //process varchar for possible values
560                                      if($field['name'] == 'first_name'){
561                                          $count = count($sugar_demodata['first_name_array']) - 1;
562                                         $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
563                                      }elseif($field['name'] == 'last_name'){
564                                          $count = count($sugar_demodata['last_name_array']) - 1;
565                                          $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
566                                      }elseif($field['name'] == 'user_name'){
567                                        $count = count($sugar_demodata['first_name_array']) - 1;
568                                         $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'_'.mt_rand(1,111).'",';
569                                      }elseif($field['name'] == 'title'){
570                                          $count = count($sugar_demodata['titles']) - 1;
571                                          $returnContent .= '"'.$sugar_demodata['titles'][mt_rand(0,$count)].'",';
572                                      }elseif(strpos($field['name'],'address_street')>0){
573                                        $count = count($sugar_demodata['street_address_array']) - 1;
574                                         $returnContent .= '"'.$sugar_demodata['street_address_array'][mt_rand(0,$count)].'",';
575                                      }elseif(strpos($field['name'],'address_city')>0){
576                                        $count = count($sugar_demodata['city_array']) - 1;
577                                         $returnContent .= '"'.$sugar_demodata['city_array'][mt_rand(0,$count)].'",';
578                                      }elseif(strpos($field['name'],'address_state')>0){
579                                          $state_arr = array('CA','NY','CO','TX','NV');
580                                        $count = count($state_arr) - 1;
581                                         $returnContent .= '"'.$state_arr[mt_rand(0,$count)].'",';
582                                      }elseif(strpos($field['name'],'address_postalcode')>0){
583                                         $returnContent .= '"'.mt_rand(12345,99999).'",';
584                                      }else{
585                                          $returnContent .= '"",';
586
587                                      }
588                      break;
589                 case "url":
590                      $returnContent .= '"https://www.sugarcrm.com",';
591                      break;
592
593                 case "enum":
594                     //get the associated enum if available
595                     global $app_list_strings;
596
597                     if(isset($focus->field_name_map[$field_name]['type']) && !empty($focus->field_name_map[$field_name]['options'])){
598                         if ( !empty($app_list_strings[$focus->field_name_map[$field_name]['options']]) ) {
599
600                             //get the values into an array
601                             $dd_values = $app_list_strings[$focus->field_name_map[$field_name]['options']];
602                             $dd_values = array_values($dd_values);
603
604                             //grab the count
605                             $count = count($dd_values) - 1;
606
607                             //choose one at random
608                             $returnContent .= '"'.$dd_values[mt_rand(0,$count)].'",';
609                             } else{
610                                 //name of enum options array was found but is empty, return blank
611                                 $returnContent .= '"",';
612                             }
613                     }else{
614                         //name of enum options array was not found on field, return blank
615                         $returnContent .= '"",';
616                     }
617                      break;
618                 default:
619                     //type is not matched, fill in with empty string and continue;
620                     $returnContent .= '"",';
621
622              }
623          }
624          $returnContent .= "\r\n";
625      }
626      return $returnContent;
627  }
628
629
630
631
632  //expects the field name to translate and a bean of the type being translated (to access field map and mod_strings)
633  function translateForExport($field_db_name,$focus){
634      global $mod_strings,$app_strings;
635
636      if (empty($field_db_name) || empty($focus)){
637         return false;
638      }
639
640     //grab the focus module strings
641     $temp_mod_strings = $mod_strings;
642     global $current_language;
643     $mod_strings = return_module_language($current_language, $focus->module_dir);
644     $fieldLabel = '';
645
646      //!! first check to see if we are overriding the label for export.
647      if (!empty($mod_strings['LBL_EXPORT_'.strtoupper($field_db_name)])){
648          //entry exists which means we are overriding this value for exporting, use this label
649          $fieldLabel = $mod_strings['LBL_EXPORT_'.strtoupper($field_db_name)];
650
651      }
652      //!! next check to see if we are overriding the label for export on app_strings.
653      elseif (!empty($app_strings['LBL_EXPORT_'.strtoupper($field_db_name)])){
654          //entry exists which means we are overriding this value for exporting, use this label
655          $fieldLabel = $app_strings['LBL_EXPORT_'.strtoupper($field_db_name)];
656
657      }//check to see if label exists in mapping and in mod strings
658      elseif (!empty($focus->field_name_map[$field_db_name]['vname']) && !empty($mod_strings[$focus->field_name_map[$field_db_name]['vname']])){
659          $fieldLabel = $mod_strings[$focus->field_name_map[$field_db_name]['vname']];
660
661      }//check to see if label exists in mapping and in app strings
662      elseif (!empty($focus->field_name_map[$field_db_name]['vname']) && !empty($app_strings[$focus->field_name_map[$field_db_name]['vname']])){
663          $fieldLabel = $app_strings[$focus->field_name_map[$field_db_name]['vname']];
664
665      }//field is not in mapping, so check to see if db can be uppercased and found in mod strings
666      elseif (!empty($mod_strings['LBL_'.strtoupper($field_db_name)])){
667          $fieldLabel = $mod_strings['LBL_'.strtoupper($field_db_name)];
668
669      }//check to see if db can be uppercased and found in app strings
670      elseif (!empty($app_strings['LBL_'.strtoupper($field_db_name)])){
671          $fieldLabel = $app_strings['LBL_'.strtoupper($field_db_name)];
672
673      }else{
674          //we could not find the label in mod_strings or app_strings based on either a mapping entry
675          //or on the db_name itself or being overwritten, so default to the db name as a last resort
676          $fieldLabel = $field_db_name;
677
678      }
679      //strip the label of any columns
680      $fieldLabel= preg_replace("/([:]|\xEF\xBC\x9A)[\\s]*$/", '', trim($fieldLabel));
681
682      //reset the bean mod_strings back to original import strings
683      $mod_strings = $temp_mod_strings;
684      return $fieldLabel;
685
686  }
687
688 //call this function to return the desired order to display columns for export in.
689 //if you pass in an array, it will reorder the array and send back to you.  It expects the array
690 //to have the db names as key values, or as labels
691 function get_field_order_mapping($name='',$reorderArr = '', $exclude = true){
692
693     $exemptModuleList = array('ProspectLists');
694     if(in_array($name, $exemptModuleList))
695         return $reorderArr;
696     
697     //define the ordering of fields, note that the key value is what is important, and should be the db field name
698     $field_order_array = array();
699     $field_order_array['accounts'] = array( 'name'=>'Name', 'id'=>'ID', 'website'=>'Website', 'email_address' =>'Email Address', 'phone_office' =>'Office Phone', 'phone_alternate' => 'Alternate Phone', 'phone_fax' => 'Fax', 'billing_address_street' => 'Billing Street', 'billing_address_city' => 'Billing City', 'billing_address_state' => 'Billing State', 'billing_address_postalcode' => 'Billing Postal Code', 'billing_address_country' => 'Billing Country', 'shipping_address_street' => 'Shipping Street', 'shipping_address_city' => 'Shipping City', 'shipping_address_state' => 'Shipping State', 'shipping_address_postalcode' => 'Shipping Postal Code', 'shipping_address_country' => 'Shipping Country', 'description' => 'Description', 'account_type' => 'Type', 'industry' =>'Industry', 'annual_revenue' => 'Annual Revenue', 'employees' => 'Employees', 'sic_code' => 'SIC Code', 'ticker_symbol' => 'Ticker Symbol', 'parent_id' => 'Parent Account ID', 'ownership' =>'Ownership', 'campaign_id' =>'Campaign ID', 'rating' =>'Rating', 'assigned_user_name' =>'Assigned to',  'assigned_user_id' =>'Assigned User ID', 'team_id' =>'Team Id', 'team_name' =>'Teams', 'team_set_id' =>'Team Set ID', 'date_entered' =>'Date Created', 'date_modified' =>'Date Modified', 'modified_user_id' =>'Modified By', 'created_by' =>'Created By', 'deleted' =>'Deleted');
700     $field_order_array['contacts'] = array( 'first_name' => 'First Name', 'last_name' => 'Last Name', 'id'=>'ID', 'salutation' => 'Salutation', 'title' => 'Title', 'department' => 'Department', 'account_name' => 'Account Name', 'email_address' => 'Email Address', 'phone_mobile' => 'Phone Mobile','phone_work' => 'Phone Work', 'phone_home' => 'Phone Home',  'phone_other' => 'Phone Other','phone_fax' => 'Phone Fax', 'primary_address_street' => 'Primary Address Street', 'primary_address_city' => 'Primary Address City', 'primary_address_state' => 'Primary Address State', 'primary_address_postalcode' => 'Primary Address Postal Code', 'primary_address_country' => 'Primary Address Country', 'alt_address_street' => 'Alternate Address Street', 'alt_address_city' => 'Alternate Address City', 'alt_address_state' => 'Alternate Address State', 'alt_address_postalcode' => 'Alternate Address Postal Code', 'alt_address_country' => 'Alternate Address Country', 'description' => 'Description', 'birthdate' => 'Birthdate', 'lead_source' => 'Lead Source', 'campaign_id' => 'campaign_id', 'do_not_call' => 'Do Not Call', 'portal_name' => 'Portal Name', 'portal_active' => 'Portal Active', 'portal_password' => 'Portal Password', 'portal_app' => 'Portal Application', 'reports_to_id' => 'Reports to ID', 'assistant' => 'Assistant', 'assistant_phone' => 'Assistant Phone', 'picture' => 'Picture', 'assigned_user_name' => 'Assigned User Name', 'assigned_user_id' => 'Assigned User ID', 'team_name' => 'Teams', 'team_id' => 'Team id', 'team_set_id' => 'Team Set ID', 'date_entered' =>'Date Created', 'date_modified' =>'Date Modified', 'modified_user_id' =>'Modified By', 'created_by' =>'Created By', 'deleted' =>'Deleted');
701     $field_order_array['leads']    = array( 'first_name' => 'First Name', 'last_name' => 'Last Name', 'id'=>'ID', 'salutation' => 'Salutation', 'title' => 'Title', 'department' => 'Department', 'account_name' => 'Account Name', 'account_description' =>  'Account Description', 'website' =>  'Website', 'email_address' =>  'Email Address', 'phone_mobile' =>  'Phone Mobile', 'phone_work' =>  'Phone Work', 'phone_home' =>  'Phone Home', 'phone_other' =>  'Phone Other', 'phone_fax' =>  'Phone Fax', 'primary_address_street' =>  'Primary Address Street', 'primary_address_city' =>  'Primary Address City', 'primary_address_state' =>  'Primary Address State', 'primary_address_postalcode' =>  'Primary Address Postal Code', 'primary_address_country' =>  'Primary Address Country', 'alt_address_street' =>  'Alt Address Street', 'alt_address_city' =>  'Alt Address City', 'alt_address_state' =>  'Alt Address State', 'alt_address_postalcode' =>  'Alt Address Postalcode', 'alt_address_country' =>  'Alt Address Country', 'status' =>  'Status', 'status_description' =>  'Status Description', 'lead_source' =>  'Lead Source', 'lead_source_description' =>  'Lead Source Description', 'description'=>'Description', 'converted' =>  'Converted', 'opportunity_name' =>  'Opportunity Name', 'opportunity_amount' =>  'Opportunity Amount', 'refered_by' =>  'Referred By', 'campaign_id' =>  'campaign_id', 'do_not_call' =>  'Do Not Call', 'portal_name' =>  'Portal Name', 'portal_app' =>  'Portal Application', 'reports_to_id' =>  'Reports To ID', 'assistant' =>  'Assistant', 'assistant_phone' =>  'Assistant Phone', 'birthdate'=>'Birthdate', 'contact_id' =>  'Contact ID', 'account_id' =>  'Account ID', 'opportunity_id' =>  'Opportunity ID',  'assigned_user_name' =>  'Assigned User Name', 'assigned_user_id' =>  'Assigned User ID', 'team_name' =>  'Teams', 'team_id' =>  'Team id', 'team_set_id' =>  'Team Set ID', 'date_entered' =>  'Date Created', 'date_modified' =>  'Date Modified', 'created_by' =>  'Created By ID', 'modified_user_id' =>  'Modified By ID', 'deleted' =>  'Deleted');
702     $field_order_array['opportunities'] = array( 'name' => 'Opportunity Name', 'id'=>'ID', 'amount' => 'Opportunity Amount', 'currency_id' => 'Currency', 'date_closed' => 'Expected Close Date', 'sales_stage' => 'Sales Stage', 'probability' => 'Probability (%)', 'next_step' => 'Next Step', 'opportunity_type' => 'Opportunity Type', 'account_name' => 'Account Name', 'description' => 'Description', 'amount_usdollar' => 'Amount', 'lead_source' => 'Lead Source', 'campaign_id' => 'campaign_id', 'assigned_user_name' => 'Assigned User Name', 'assigned_user_id' => 'Assigned User ID', 'team_name' => 'Teams', 'team_id' => 'Team id', 'team_set_id' => 'Team Set ID', 'date_entered' => 'Date Created', 'date_modified' => 'Date Modified', 'created_by' => 'Created By ID', 'modified_user_id' => 'Modified By ID', 'deleted' => 'Deleted');
703     $field_order_array['notes'] =         array( 'name' => 'Name', 'id'=>'ID', 'description' => 'Description', 'filename' => 'Attachment', 'parent_type' => 'Parent Type', 'parent_id' => 'Parent ID', 'contact_id' => 'Contact ID', 'portal_flag' => 'Display in Portal?', 'assigned_user_name' =>'Assigned to', 'assigned_user_id' => 'assigned_user_id', 'team_id' => 'Team id', 'team_set_id' => 'Team Set ID', 'date_entered' => 'Date Created', 'date_modified' => 'Date Modified',  'created_by' => 'Created By ID', 'modified_user_id' => 'Modified By ID', 'deleted' => 'Deleted' );
704     $field_order_array['bugs'] =   array('bug_number' => 'Bug Number', 'id'=>'ID', 'name' => 'Subject', 'description' => 'Description', 'status' => 'Status', 'type' => 'Type', 'priority' => 'Priority', 'resolution' => 'Resolution', 'work_log' => 'Work Log', 'found_in_release' => 'Found In Release', 'fixed_in_release' => 'Fixed In Release', 'found_in_release_name' => 'Found In Release Name', 'fixed_in_release_name' => 'Fixed In Release', 'product_category' => 'Category', 'source' => 'Source', 'portal_viewable' => 'Portal Viewable', 'system_id' => 'System ID', 'assigned_user_id' => 'Assigned User ID', 'assigned_user_name' => 'Assigned User Name', 'team_name'=>'Teams', 'team_id' => 'Team id', 'team_set_id' => 'Team Set ID', 'date_entered' =>'Date Created', 'date_modified' =>'Date Modified', 'modified_user_id' =>'Modified By', 'created_by' =>'Created By', 'deleted' =>'Deleted');
705     $field_order_array['tasks'] =   array( 'name'=>'Subject', 'id'=>'ID', 'description'=>'Description', 'status'=>'Status', 'date_start'=>'Date Start', 'date_due'=>'Date Due','priority'=>'Priority', 'parent_type'=>'Parent Type', 'parent_id'=>'Parent ID', 'contact_id'=>'Contact ID', 'assigned_user_name' =>'Assigned to', 'assigned_user_id'=>'Assigned User ID', 'team_name'=>'Teams', 'team_id'=>'Team id', 'team_set_id'=>'Team Set ID', 'date_entered'=>'Date Created', 'date_modified'=>'Date Modified', 'created_by'=>'Created By ID', 'modified_user_id'=>'Modified By ID', 'deleted'=>'Deleted');
706     $field_order_array['calls'] =   array( 'name'=>'Subject', 'id'=>'ID', 'description'=>'Description', 'status'=>'Status', 'direction'=>'Direction', 'date_start'=>'Date', 'date_end'=>'Date End', 'duration_hours'=>'Duration Hours', 'duration_minutes'=>'Duration Minutes', 'reminder_time'=>'Reminder Time', 'parent_type'=>'Parent Type', 'parent_id'=>'Parent ID', 'outlook_id'=>'Outlook ID', 'assigned_user_name' =>'Assigned to', 'assigned_user_id'=>'Assigned User ID', 'team_name'=>'Teams', 'team_id'=>'Team id', 'team_set_id'=>'Team Set ID', 'date_entered'=>'Date Created', 'date_modified'=>'Date Modified', 'created_by'=>'Created By ID', 'modified_user_id'=>'Modified By ID', 'deleted'=>'Deleted');
707     $field_order_array['meetings'] =array( 'name'=>'Subject', 'id'=>'ID', 'description'=>'Description', 'status'=>'Status', 'location'=>'Location', 'date_start'=>'Date', 'date_end'=>'Date End', 'duration_hours'=>'Duration Hours', 'duration_minutes'=>'Duration Minutes', 'reminder_time'=>'Reminder Time', 'type'=>'Meeting Type', 'external_id'=>'External ID', 'password'=>'Meeting Password', 'join_url'=>'Join Url', 'host_url'=>'Host Url', 'displayed_url'=>'Displayed Url', 'creator'=>'Meeting Creator', 'parent_type'=>'Related to', 'parent_id'=>'Related to', 'outlook_id'=>'Outlook ID','assigned_user_name' =>'Assigned to','assigned_user_id' => 'Assigned User ID', 'team_name' => 'Teams', 'team_id' => 'Team id', 'team_set_id' => 'Team Set ID', 'date_entered' => 'Date Created', 'date_modified' => 'Date Modified', 'created_by' => 'Created By ID', 'modified_user_id' => 'Modified By ID', 'deleted' => 'Deleted');
708     $field_order_array['cases'] =array( 'case_number'=>'Case Number', 'id'=>'ID', 'name'=>'Subject', 'description'=>'Description', 'status'=>'Status', 'type'=>'Type', 'priority'=>'Priority', 'resolution'=>'Resolution', 'work_log'=>'Work Log', 'portal_viewable'=>'Portal Viewable', 'account_name'=>'Account Name', 'account_id'=>'Account ID', 'assigned_user_id'=>'Assigned User ID', 'team_name'=>'Teams', 'team_id'=>'Team id', 'team_set_id'=>'Team Set ID', 'date_entered'=>'Date Created', 'date_modified'=>'Date Modified', 'created_by'=>'Created By ID', 'modified_user_id'=>'Modified By ID', 'deleted'=>'Deleted');
709     $field_order_array['prospects'] =array( 'first_name'=>'First Name', 'last_name'=>'Last Name', 'id'=>'ID', 'salutation'=>'Salutation', 'title'=>'Title', 'department'=>'Department', 'account_name'=>'Account Name', 'email_address'=>'Email Address', 'phone_mobile' => 'Phone Mobile', 'phone_work' => 'Phone Work', 'phone_home' => 'Phone Home', 'phone_other' => 'Phone Other', 'phone_fax' => 'Phone Fax',  'primary_address_street' => 'Primary Address Street', 'primary_address_city' => 'Primary Address City', 'primary_address_state' => 'Primary Address State', 'primary_address_postalcode' => 'Primary Address Postal Code', 'primary_address_country' => 'Primary Address Country', 'alt_address_street' => 'Alternate Address Street', 'alt_address_city' => 'Alternate Address City', 'alt_address_state' => 'Alternate Address State', 'alt_address_postalcode' => 'Alternate Address Postal Code', 'alt_address_country' => 'Alternate Address Country', 'description' => 'Description', 'birthdate' => 'Birthdate', 'assistant'=>'Assistant', 'assistant_phone'=>'Assistant Phone', 'campaign_id'=>'campaign_id', 'tracker_key'=>'Tracker Key', 'do_not_call'=>'Do Not Call', 'lead_id'=>'Lead Id', 'assigned_user_name'=>'Assigned User Name', 'assigned_user_id'=>'Assigned User ID', 'team_id' =>'Team Id', 'team_name' =>'Teams', 'team_set_id' =>'Team Set ID', 'date_entered' =>'Date Created', 'date_modified' =>'Date Modified', 'modified_user_id' =>'Modified By', 'created_by' =>'Created By', 'deleted' =>'Deleted');
710
711     $fields_to_exclude = array();
712     $fields_to_exclude['accounts'] = array('account_name');
713     $fields_to_exclude['bugs'] = array('system_id');
714     $fields_to_exclude['cases'] = array('system_id', 'modified_by_name', 'modified_by_name_owner', 'modified_by_name_mod', 'created_by_name', 'created_by_name_owner', 'created_by_name_mod', 'assigned_user_name', 'assigned_user_name_owner', 'assigned_user_name_mod', 'team_count', 'team_count_owner', 'team_count_mod', 'team_name_owner', 'team_name_mod', 'account_name_owner', 'account_name_mod', 'modified_user_name',  'modified_user_name_owner', 'modified_user_name_mod');
715     $fields_to_exclude['notes'] = array('first_name','last_name', 'file_mime_type','embed_flag');
716     $fields_to_exclude['tasks'] = array('date_start_flag', 'date_due_flag');
717
718     //of array is passed in for reordering, process array
719     if(!empty($name) && !empty($reorderArr) && is_array($reorderArr)){
720
721         //make sure reorderArr has values as keys, if not then iterate through and assign the value as the key
722         $newReorder = array();
723         foreach($reorderArr as $rk=> $rv){
724             if(is_int($rk)){
725                 $newReorder[$rv]=$rv;
726             }else{
727                 $newReorder[$rk]=$rv;
728             }
729         }
730
731         //if module is not defined, lets default the order to another module of the same type
732         //this would apply mostly to custom modules
733         if(!isset($field_order_array[strtolower($name)]) && isset($_REQUEST['module'])){
734             //get an instance of the bean
735             global $beanList;
736                 global $beanFiles;
737
738             $bean = $beanList[$_REQUEST['module']];
739             require_once($beanFiles[$bean]);
740             $focus = new $bean;
741
742
743             //if module is of type person
744             if($focus instanceof Person){
745                 $name = 'contacts';
746             }
747             //if module is of type company
748             else if ($focus instanceof Company){
749                 $name = 'accounts';
750             }
751             //if module is of type Sale
752             else if ($focus instanceof Sale){
753                 $name = 'opportunities';
754             }//if module is of type File
755             else if ($focus instanceof Issue){
756                 $name = 'bugs';
757             }//all others including type File can use basic
758             else{
759                 $name = 'Notes';
760             }
761
762         }
763
764         //lets iterate through and create a reordered temporary array using
765         //the  newly formatted copy of passed in array
766         $temp_result_arr = array();
767         $lname = strtolower($name);
768         if(!empty($field_order_array[$lname])) {
769                 foreach($field_order_array[$lname] as $fk=> $fv){
770         
771                     //if the value exists as a key in the passed in array, add to temp array and remove from reorder array.
772                     //Do not force into the temp array as we don't want to violate acl's
773                     if(array_key_exists($fk,$newReorder)){
774                         $temp_result_arr[$fk] = $newReorder[$fk];
775                         unset($newReorder[$fk]);
776                     }
777                 }
778         }
779         //add in all the left over values that were not in our ordered list
780         //array_splice($temp_result_arr, count($temp_result_arr), 0, $newReorder);
781         foreach($newReorder as $nrk=>$nrv){
782             $temp_result_arr[$nrk] = $nrv;
783         }
784
785
786         if($exclude){
787             //Some arrays have values we wish to exclude
788             if (isset($fields_to_exclude[$lname])){
789                 foreach($fields_to_exclude[$lname] as $exclude_field){
790                     unset($temp_result_arr[$exclude_field]);
791                 }
792             }
793         }
794
795         //return temp ordered list
796         return $temp_result_arr;
797     }
798
799     //if no array was passed in, pass back either the list of ordered columns by module, or the entireorder array
800     if(empty($name)){
801         return $field_order_array;
802     }else{
803         return $field_order_array[strtolower($name)];
804     }
805
806 }