2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
38 /*********************************************************************************
41 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights
42 * Reserved. Contributor(s): ______________________________________..
43 * *******************************************************************************/
46 * gets the system default delimiter or an user-preference based override
47 * @return string the delimiter
49 function getDelimiter() {
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;
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
68 function export($type, $records = null, $members = false, $sample=false) {
73 global $app_list_strings;
76 global $current_language;
78 $contact_fields = array(
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"
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)"
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"
115 $account_fields = array(
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",
126 "phone_alternate"=>"Other Phone",
128 "email2"=>"Other Email",
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"
144 //Array of fields that should not be exported, and are only used for logic
145 $remove_from_members = array("ea_deleted", "ear_deleted", "primary_address");
149 $bean = $beanList[$type];
150 require_once($beanFiles[$bean]);
152 $searchFields = array();
153 $db = DBManagerFactory::getInstance();
156 $records = explode(',', $records);
157 $records = "'" . implode("','", $records) . "'";
158 $where = "{$focus->table_name}.id in ($records)";
159 } elseif (isset($_REQUEST['all']) ) {
162 if(!empty($_REQUEST['current_post'])) {
163 $ret_array = generateSearchWhere($type, $_REQUEST['current_post']);
165 $where = $ret_array['where'];
166 $searchFields = $ret_array['searchFields'];
172 if($focus->bean_implements('ACL')){
173 if(!ACLController::checkAccess($focus->module_dir, 'export', true)){
174 ACLController::displayNoAccess();
177 if(ACLController::requireOwner($focus->module_dir, 'export')){
181 $where .= $focus->getOwnerWhere($current_user->id);
185 // Export entire list was broken because the where clause already has "where" in it
186 // and when the query is built, it has a "where" as well, so the query was ill-formed.
187 // Eliminating the "where" here so that the query can be constructed correctly.
188 if($members == true){
189 $query = $focus->create_export_members_query($records);
191 $beginWhere = substr(trim($where), 0, 5);
192 if ($beginWhere == "where")
193 $where = substr(trim($where), 5, strlen($where));
194 $ret_array = create_export_query_relate_link_patch($type, $searchFields, $where);
195 if(!empty($ret_array['join'])) {
196 $query = $focus->create_export_query($order_by,$ret_array['where'],$ret_array['join']);
198 $query = $focus->create_export_query($order_by,$ret_array['where']);
205 $result = $db->limitQuery($query, 0, $sampleRecordNum, true, $app_strings['ERR_EXPORT_TYPE'].$type.": <BR>.".$query);
206 if( $focus->_get_num_rows_in_query($query)<1 ){
211 $result = $db->query($query, true, $app_strings['ERR_EXPORT_TYPE'].$type.": <BR>.".$query);
215 $fields_array = $db->getFieldsArray($result,true);
217 //set up the order on the header row
218 $fields_array = get_field_order_mapping($focus->module_dir, $fields_array);
220 //set up labels to be used for the header row
221 $field_labels = array();
222 foreach($fields_array as $key=>$dbname){
223 //Remove fields that are only used for logic
224 if($members && (in_array($dbname, $remove_from_members)))
227 //default to the db name of label does not exist
228 $field_labels[$key] = translateForExport($dbname,$focus);
231 // setup the "header" line with proper delimiters
232 $content = "\"".implode("\"".getDelimiter()."\"", array_values($field_labels))."\"\r\n";
236 //this is a sample request with no data, so create fake datarows
237 $content .= returnFakeDataRow($focus,$fields_array,$sampleRecordNum);
239 //process retrieved record
240 while($val = $db->fetchByAssoc($result, false)) {
242 //order the values in the record array
243 $val = get_field_order_mapping($focus->module_dir,$val);
247 if($pre_id == $val['id'])
249 if($val['ea_deleted']==1 || $val['ear_deleted']==1){
250 $val['primary_email_address'] = '';
252 unset($val['ea_deleted']);
253 unset($val['ear_deleted']);
254 unset($val['primary_address']);
256 $pre_id = $val['id'];
258 foreach ($val as $key => $value)
260 //getting content values depending on their types
261 $fieldNameMapKey = $fields_array[$key];
263 if (isset($focus->field_name_map[$fieldNameMapKey]) && $focus->field_name_map[$fieldNameMapKey]['type'])
265 $fieldType = $focus->field_name_map[$fieldNameMapKey]['type'];
268 //if our value is a currency field, then apply the users locale
270 require_once('modules/Currencies/Currency.php');
271 $value = currency_format_number($value);
274 //if our value is a datetime field, then apply the users locale
276 case 'datetimecombo':
277 $value = $timedate->to_display_date_time($db->fromConvert($value, 'datetime'));
278 $value = preg_replace('/([pm|PM|am|AM]+)/', ' \1', $value);
283 $value = $timedate->to_display_date($db->fromConvert($value, 'date'), false);
286 // Bug 32463 - Properly have multienum field translated into something useful for the client
288 $value = str_replace("^","",$value);
289 if (isset($focus->field_name_map[$fields_array[$key]]['options']) && isset($app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']]) )
291 $valueArray = explode(",",$value);
292 foreach ($valueArray as $multikey => $multivalue )
294 if (isset($app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']][$multivalue]) )
296 $valueArray[$multikey] = $app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']][$multivalue];
299 $value = implode(",",$valueArray);
305 array_push($new_arr, preg_replace("/\"/","\"\"", $value));
307 $line = implode("\"".getDelimiter()."\"", $new_arr);
319 function generateSearchWhere($module, $query) {//this function is similar with function prepareSearchForm() in view.list.php
320 $seed = loadBean($module);
321 if(file_exists('modules/'.$module.'/SearchForm.html')){
322 if(file_exists('modules/' . $module . '/metadata/SearchFields.php')) {
323 require_once('include/SearchForm/SearchForm.php');
324 $searchForm = new SearchForm($module, $seed);
326 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.
327 // Currently, massupdate will not generate the where sql. It will use the sql stored in the SESSION. But this will cause bug 24722, and it cannot be avoided now.
328 $where = $_SESSION['export_where'];
329 $whereArr = explode (" ", trim($where));
330 if ($whereArr[0] == trim('where')) {
331 $whereClean = array_shift($whereArr);
333 $where = implode(" ", $whereArr);
334 //rrs bug: 31329 - previously this was just returning $where, but the problem is the caller of this function
335 //expects the results in an array, not just a string. So rather than fixing the caller, I felt it would be best for
336 //the function to return the results in a standard format.
337 $ret_array['where'] = $where;
338 $ret_array['searchFields'] =array();
346 require_once('include/SearchForm/SearchForm2.php');
348 if(file_exists('custom/modules/'.$module.'/metadata/metafiles.php')){
349 require('custom/modules/'.$module.'/metadata/metafiles.php');
350 }elseif(file_exists('modules/'.$module.'/metadata/metafiles.php')){
351 require('modules/'.$module.'/metadata/metafiles.php');
354 if (file_exists('custom/modules/'.$module.'/metadata/searchdefs.php'))
356 require_once('custom/modules/'.$module.'/metadata/searchdefs.php');
358 elseif (!empty($metafiles[$module]['searchdefs']))
360 require_once($metafiles[$module]['searchdefs']);
362 elseif (file_exists('modules/'.$module.'/metadata/searchdefs.php'))
364 require_once('modules/'.$module.'/metadata/searchdefs.php');
367 //fixing bug #48483: Date Range search on custom date field then export ignores range filter
368 // first of all custom folder should be checked
369 if(file_exists('custom/modules/'.$module.'/metadata/SearchFields.php'))
371 require_once('custom/modules/'.$module.'/metadata/SearchFields.php');
373 elseif(!empty($metafiles[$module]['searchfields']))
375 require_once($metafiles[$module]['searchfields']);
377 elseif(file_exists('modules/'.$module.'/metadata/SearchFields.php'))
379 require_once('modules/'.$module.'/metadata/SearchFields.php');
381 if(empty($searchdefs) || empty($searchFields)) {
382 //for some modules, such as iframe, it has massupdate, but it doesn't have search function, the where sql should be empty.
385 $searchForm = new SearchForm($seed, $module);
386 $searchForm->setup($searchdefs, $searchFields, 'SearchFormGeneric.tpl');
388 $searchForm->populateFromArray(unserialize(base64_decode($query)));
389 $where_clauses = $searchForm->generateSearchWhere(true, $module);
390 if (count($where_clauses) > 0 )$where = '('. implode(' ) AND ( ', $where_clauses) . ')';
391 $GLOBALS['log']->info("Export Where Clause: {$where}");
392 $ret_array['where'] = $where;
393 $ret_array['searchFields'] = $searchForm->searchFields;
397 * calls export method to build up a delimited string and some sample instructional text on how to use this file
398 * @param string type the bean-type to export
399 * @return string delimited string for export with some tutorial text
401 function exportSample($type) {
405 $_REQUEST['all']=true;
407 //retrieve the export content
408 $content = export($type, null, false, true);
410 // Add a new row and add details on removing the sample data
411 // Our Importer will stop after he gets to the new row, ignoring the text below
412 return $content . "\n" . $app_strings['LBL_IMPORT_SAMPLE_FILE_TEXT'];
415 //this function will take in the bean and field mapping and return a proper value
416 function returnFakeDataRow($focus,$field_array,$rowsToReturn = 5){
418 if(empty($focus) || empty($field_array))
421 //include the file that defines $sugar_demodata
422 include('install/demoData.en_us.php');
424 $person_bean = false;
425 if( isset($focus->first_name)){
434 //iterate through the record creation process as many times as defined. Each iteration will create a new row
435 while($counter < $rowsToReturn){
437 //go through each field and populate with dummy data if possible
438 foreach($field_array as $field_name){
440 if(empty($focus->field_name_map[$field_name]) || empty($focus->field_name_map[$field_name]['type'])){
441 //type is not set, fill in with empty string and continue;
442 $returnContent .= '"",';
445 $field = $focus->field_name_map[$field_name];
446 //fill in value according to type
447 $type = $field['type'];
452 case "assigned_user_name":
453 //return new guid string
454 $returnContent .= '"'.create_guid().'",';
457 //return random number`
458 $returnContent .= '"'.mt_rand(0,4).'",';
461 //return first, last, user name, or random name string
462 if($field['name'] == 'first_name'){
463 $count = count($sugar_demodata['first_name_array']) - 1;
464 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
465 }elseif($field['name'] == 'last_name'){
466 $count = count($sugar_demodata['last_name_array']) - 1;
467 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
468 }elseif($field['name'] == 'user_name'){
469 $count = count($sugar_demodata['first_name_array']) - 1;
470 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'_'.mt_rand(1,111).'",';
472 //return based on bean
473 if($focus->module_dir =='Accounts'){
474 $count = count($sugar_demodata['company_name_array']) - 1;
475 $returnContent .= '"'.$sugar_demodata['company_name_array'][mt_rand(0,$count)].'",';
477 }elseif($focus->module_dir =='Bugs'){
478 $count = count($sugar_demodata['bug_seed_names']) - 1;
479 $returnContent .= '"'.$sugar_demodata['bug_seed_names'][mt_rand(0,$count)].'",';
480 }elseif($focus->module_dir =='Notes'){
481 $count = count($sugar_demodata['note_seed_names_and_Descriptions']) - 1;
482 $returnContent .= '"'.$sugar_demodata['note_seed_names_and_Descriptions'][mt_rand(0,$count)].'",';
484 }elseif($focus->module_dir =='Calls'){
485 $count = count($sugar_demodata['call_seed_data_names']) - 1;
486 $returnContent .= '"'.$sugar_demodata['call_seed_data_names'][mt_rand(0,$count)].'",';
488 }elseif($focus->module_dir =='Tasks'){
489 $count = count($sugar_demodata['task_seed_data_names']) - 1;
490 $returnContent .= '"'.$sugar_demodata['task_seed_data_names'][mt_rand(0,$count)].'",';
492 }elseif($focus->module_dir =='Meetings'){
493 $count = count($sugar_demodata['meeting_seed_data_names']) - 1;
494 $returnContent .= '"'.$sugar_demodata['meeting_seed_data_names'][mt_rand(0,$count)].'",';
496 }elseif($focus->module_dir =='ProductCategories'){
497 $count = count($sugar_demodata['productcategory_seed_data_names']) - 1;
498 $returnContent .= '"'.$sugar_demodata['productcategory_seed_data_names'][mt_rand(0,$count)].'",';
501 }elseif($focus->module_dir =='ProductTypes'){
502 $count = count($sugar_demodata['producttype_seed_data_names']) - 1;
503 $returnContent .= '"'.$sugar_demodata['producttype_seed_data_names'][mt_rand(0,$count)].'",';
506 }elseif($focus->module_dir =='ProductTemplates'){
507 $count = count($sugar_demodata['producttemplate_seed_data']) - 1;
508 $returnContent .= '"'.$sugar_demodata['producttemplate_seed_data'][mt_rand(0,$count)].'",';
511 $returnContent .= '"Default Name for '.$focus->module_dir.'",';
518 if($field['name'] == 'team_name'){
519 //apply team names and user_name
520 $teams_count = count($sugar_demodata['teams']) - 1;
521 $users_count = count($sugar_demodata['users']) - 1;
523 $returnContent .= '"'.$sugar_demodata['teams'][mt_rand(0,$teams_count)]['name'].','.$sugar_demodata['users'][mt_rand(0,$users_count)]['user_name'].'",';
527 $returnContent .= '"'.create_guid().'",';
532 $returnContent .= '"'.mt_rand(0,1).'",';
537 $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",';
541 $teams_count = count($sugar_demodata['teams']) - 1;
542 //give fake team names (East,West,North,South)
543 $returnContent .= '"'.$sugar_demodata['teams'][mt_rand(0,$teams_count)]['name'].'",';
547 //return formatted date
548 $timeStamp = strtotime('now');
549 $value = date($timedate->dbDayFormat, $timeStamp);
550 $returnContent .= '"'.$timedate->to_display_date_time($value).'",';
554 case "datetimecombo":
555 //return formatted date time
556 $timeStamp = strtotime('now');
558 $value = date($timedate->dbDayFormat.' '.$timedate->dbTimeFormat, $timeStamp);
559 //use timedate to convert to user display format
560 $value = $timedate->to_display_date_time($value);
561 //finally forma the am/pm to have a space so it can be recognized as a date field in excel
562 $value = preg_replace('/([pm|PM|am|AM]+)/', ' \1', $value);
563 $returnContent .= '"'.$value.'",';
567 $value = '('.mt_rand(300,999).') '.mt_rand(300,999).'-'.mt_rand(1000,9999);
568 $returnContent .= '"'.$value.'",';
571 //process varchar for possible values
572 if($field['name'] == 'first_name'){
573 $count = count($sugar_demodata['first_name_array']) - 1;
574 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
575 }elseif($field['name'] == 'last_name'){
576 $count = count($sugar_demodata['last_name_array']) - 1;
577 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
578 }elseif($field['name'] == 'user_name'){
579 $count = count($sugar_demodata['first_name_array']) - 1;
580 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'_'.mt_rand(1,111).'",';
581 }elseif($field['name'] == 'title'){
582 $count = count($sugar_demodata['titles']) - 1;
583 $returnContent .= '"'.$sugar_demodata['titles'][mt_rand(0,$count)].'",';
584 }elseif(strpos($field['name'],'address_street')>0){
585 $count = count($sugar_demodata['street_address_array']) - 1;
586 $returnContent .= '"'.$sugar_demodata['street_address_array'][mt_rand(0,$count)].'",';
587 }elseif(strpos($field['name'],'address_city')>0){
588 $count = count($sugar_demodata['city_array']) - 1;
589 $returnContent .= '"'.$sugar_demodata['city_array'][mt_rand(0,$count)].'",';
590 }elseif(strpos($field['name'],'address_state')>0){
591 $state_arr = array('CA','NY','CO','TX','NV');
592 $count = count($state_arr) - 1;
593 $returnContent .= '"'.$state_arr[mt_rand(0,$count)].'",';
594 }elseif(strpos($field['name'],'address_postalcode')>0){
595 $returnContent .= '"'.mt_rand(12345,99999).'",';
597 $returnContent .= '"",';
602 $returnContent .= '"https://www.sugarcrm.com",';
606 //get the associated enum if available
607 global $app_list_strings;
609 if(isset($focus->field_name_map[$field_name]['type']) && !empty($focus->field_name_map[$field_name]['options'])){
610 if ( !empty($app_list_strings[$focus->field_name_map[$field_name]['options']]) ) {
612 //get the values into an array
613 $dd_values = $app_list_strings[$focus->field_name_map[$field_name]['options']];
614 $dd_values = array_values($dd_values);
617 $count = count($dd_values) - 1;
619 //choose one at random
620 $returnContent .= '"'.$dd_values[mt_rand(0,$count)].'",';
622 //name of enum options array was found but is empty, return blank
623 $returnContent .= '"",';
626 //name of enum options array was not found on field, return blank
627 $returnContent .= '"",';
631 //type is not matched, fill in with empty string and continue;
632 $returnContent .= '"",';
636 $returnContent .= "\r\n";
638 return $returnContent;
644 //expects the field name to translate and a bean of the type being translated (to access field map and mod_strings)
645 function translateForExport($field_db_name,$focus){
646 global $mod_strings,$app_strings;
648 if (empty($field_db_name) || empty($focus)){
652 //grab the focus module strings
653 $temp_mod_strings = $mod_strings;
654 global $current_language;
655 $mod_strings = return_module_language($current_language, $focus->module_dir);
658 //!! first check to see if we are overriding the label for export.
659 if (!empty($mod_strings['LBL_EXPORT_'.strtoupper($field_db_name)])){
660 //entry exists which means we are overriding this value for exporting, use this label
661 $fieldLabel = $mod_strings['LBL_EXPORT_'.strtoupper($field_db_name)];
664 //!! next check to see if we are overriding the label for export on app_strings.
665 elseif (!empty($app_strings['LBL_EXPORT_'.strtoupper($field_db_name)])){
666 //entry exists which means we are overriding this value for exporting, use this label
667 $fieldLabel = $app_strings['LBL_EXPORT_'.strtoupper($field_db_name)];
669 }//check to see if label exists in mapping and in mod strings
670 elseif (!empty($focus->field_name_map[$field_db_name]['vname']) && !empty($mod_strings[$focus->field_name_map[$field_db_name]['vname']])){
671 $fieldLabel = $mod_strings[$focus->field_name_map[$field_db_name]['vname']];
673 }//check to see if label exists in mapping and in app strings
674 elseif (!empty($focus->field_name_map[$field_db_name]['vname']) && !empty($app_strings[$focus->field_name_map[$field_db_name]['vname']])){
675 $fieldLabel = $app_strings[$focus->field_name_map[$field_db_name]['vname']];
677 }//field is not in mapping, so check to see if db can be uppercased and found in mod strings
678 elseif (!empty($mod_strings['LBL_'.strtoupper($field_db_name)])){
679 $fieldLabel = $mod_strings['LBL_'.strtoupper($field_db_name)];
681 }//check to see if db can be uppercased and found in app strings
682 elseif (!empty($app_strings['LBL_'.strtoupper($field_db_name)])){
683 $fieldLabel = $app_strings['LBL_'.strtoupper($field_db_name)];
686 //we could not find the label in mod_strings or app_strings based on either a mapping entry
687 //or on the db_name itself or being overwritten, so default to the db name as a last resort
688 $fieldLabel = $field_db_name;
691 //strip the label of any columns
692 $fieldLabel= preg_replace("/([:]|\xEF\xBC\x9A)[\\s]*$/", '', trim($fieldLabel));
694 //reset the bean mod_strings back to original import strings
695 $mod_strings = $temp_mod_strings;
700 //call this function to return the desired order to display columns for export in.
701 //if you pass in an array, it will reorder the array and send back to you. It expects the array
702 //to have the db names as key values, or as labels
703 function get_field_order_mapping($name='',$reorderArr = '', $exclude = true){
705 //define the ordering of fields, note that the key value is what is important, and should be the db field name
706 $field_order_array = array();
707 $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');
708 $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');
709 $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');
710 $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');
711 $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' );
712 $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');
713 $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');
714 $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');
715 $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');
716 $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');
717 $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');
719 $fields_to_exclude = array();
720 $fields_to_exclude['accounts'] = array('account_name');
721 $fields_to_exclude['bugs'] = array('system_id');
722 $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');
723 $fields_to_exclude['notes'] = array('first_name','last_name', 'file_mime_type','embed_flag');
724 $fields_to_exclude['tasks'] = array('date_start_flag', 'date_due_flag');
726 //of array is passed in for reordering, process array
727 if(!empty($name) && !empty($reorderArr) && is_array($reorderArr)){
729 //make sure reorderArr has values as keys, if not then iterate through and assign the value as the key
730 $newReorder = array();
731 foreach($reorderArr as $rk=> $rv){
733 $newReorder[$rv]=$rv;
735 $newReorder[$rk]=$rv;
739 //if module is not defined, lets default the order to another module of the same type
740 //this would apply mostly to custom modules
741 if(!isset($field_order_array[strtolower($name)]) && isset($_REQUEST['module'])){
743 $exemptModuleList = array('ProspectLists');
744 if(in_array($name, $exemptModuleList))
747 //get an instance of the bean
751 $bean = $beanList[$_REQUEST['module']];
752 require_once($beanFiles[$bean]);
756 //if module is of type person
757 if($focus instanceof Person){
760 //if module is of type company
761 else if ($focus instanceof Company){
764 //if module is of type Sale
765 else if ($focus instanceof Sale){
766 $name = 'opportunities';
767 }//if module is of type File
768 else if ($focus instanceof Issue){
770 }//all others including type File can use basic
777 //lets iterate through and create a reordered temporary array using
778 //the newly formatted copy of passed in array
779 $temp_result_arr = array();
780 $lname = strtolower($name);
781 if(!empty($field_order_array[$lname])) {
782 foreach($field_order_array[$lname] as $fk=> $fv){
784 //if the value exists as a key in the passed in array, add to temp array and remove from reorder array.
785 //Do not force into the temp array as we don't want to violate acl's
786 if(array_key_exists($fk,$newReorder)){
787 $temp_result_arr[$fk] = $newReorder[$fk];
788 unset($newReorder[$fk]);
792 //add in all the left over values that were not in our ordered list
793 //array_splice($temp_result_arr, count($temp_result_arr), 0, $newReorder);
794 foreach($newReorder as $nrk=>$nrv){
795 $temp_result_arr[$nrk] = $nrv;
800 //Some arrays have values we wish to exclude
801 if (isset($fields_to_exclude[$lname])){
802 foreach($fields_to_exclude[$lname] as $exclude_field){
803 unset($temp_result_arr[$exclude_field]);
808 //return temp ordered list
809 return $temp_result_arr;
812 //if no array was passed in, pass back either the list of ordered columns by module, or the entireorder array
814 return $field_order_array;
816 return $field_order_array[strtolower($name)];