2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
38 /*********************************************************************************
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 if (!empty($sugar_config['export_excel_compatible'])) {
57 $delimiter = ','; // default to "comma"
58 $userDelimiter = $current_user->getPreference('export_delimiter');
59 $delimiter = empty($sugar_config['export_delimiter']) ? $delimiter : $sugar_config['export_delimiter'];
60 $delimiter = empty($userDelimiter) ? $delimiter : $userDelimiter;
67 * builds up a delimited string for export
68 * @param string type the bean-type to export
69 * @param array records an array of records if coming directly from a query
70 * @return string delimited string for export
72 function export($type, $records = null, $members = false, $sample=false) {
78 global $app_list_strings;
81 global $current_language;
83 $contact_fields = array(
85 ,"lead_source"=>"Lead Source"
86 ,"date_entered"=>"Date Entered"
87 ,"date_modified"=>"Date Modified"
88 ,"first_name"=>"First Name"
89 ,"last_name"=>"Last Name"
90 ,"salutation"=>"Salutation"
91 ,"birthdate"=>"Lead Source"
92 ,"do_not_call"=>"Do Not Call"
93 ,"email_opt_out"=>"Email Opt Out"
95 ,"department"=>"Department"
96 ,"birthdate"=>"Birthdate"
97 ,"do_not_call"=>"Do Not Call"
98 ,"phone_home"=>"Phone (Home)"
99 ,"phone_mobile"=>"Phone (Mobile)"
100 ,"phone_work"=>"Phone (Work)"
101 ,"phone_other"=>"Phone (Other)"
104 ,"email2"=>"Email (Other)"
105 ,"assistant"=>"Assistant"
106 ,"assistant_phone"=>"Assistant Phone"
107 ,"primary_address_street"=>"Primary Address Street"
108 ,"primary_address_city"=>"Primary Address City"
109 ,"primary_address_state"=>"Primary Address State"
110 ,"primary_address_postalcode"=>"Primary Address Postalcode"
111 ,"primary_address_country"=>"Primary Address Country"
112 ,"alt_address_street"=>"Other Address Street"
113 ,"alt_address_city"=>"Other Address City"
114 ,"alt_address_state"=>"Other Address State"
115 ,"alt_address_postalcode"=>"Other Address Postalcode"
116 ,"alt_address_country"=>"Other Address Country"
117 ,"description"=>"Description"
120 $account_fields = array(
122 "name"=>"Account Name",
123 "website"=>"Website",
124 "industry"=>"Industry",
125 "account_type"=>"Type",
126 "ticker_symbol"=>"Ticker Symbol",
127 "employees"=>"Employees",
128 "ownership"=>"Ownership",
129 "phone_office"=>"Phone",
131 "phone_alternate"=>"Other Phone",
133 "email2"=>"Other Email",
135 "sic_code"=>"SIC Code",
136 "annual_revenue"=>"Annual Revenue",
137 "billing_address_street"=>"Billing Address Street",
138 "billing_address_city"=>"Billing Address City",
139 "billing_address_state"=>"Billing Address State",
140 "billing_address_postalcode"=>"Billing Address Postalcode",
141 "billing_address_country"=>"Billing Address Country",
142 "shipping_address_street"=>"Shipping Address Street",
143 "shipping_address_city"=>"Shipping Address City",
144 "shipping_address_state"=>"Shipping Address State",
145 "shipping_address_postalcode"=>"Shipping Address Postalcode",
146 "shipping_address_country"=>"Shipping Address Country",
147 "description"=>"Description"
149 //Array of fields that should not be exported, and are only used for logic
150 $remove_from_members = array("ea_deleted", "ear_deleted", "primary_address");
153 $bean = $beanList[$type];
154 require_once($beanFiles[$bean]);
156 $searchFields = array();
157 $db = DBManagerFactory::getInstance();
160 $records = explode(',', $records);
161 $records = "'" . implode("','", $records) . "'";
162 $where = "{$focus->table_name}.id in ($records)";
163 } elseif (isset($_REQUEST['all']) ) {
166 if(!empty($_REQUEST['current_post'])) {
167 $ret_array = generateSearchWhere($type, $_REQUEST['current_post']);
169 $where = $ret_array['where'];
170 $searchFields = $ret_array['searchFields'];
176 if($focus->bean_implements('ACL')){
177 if(!ACLController::checkAccess($focus->module_dir, 'export', true)){
178 ACLController::displayNoAccess();
181 if(ACLController::requireOwner($focus->module_dir, 'export')){
185 $where .= $focus->getOwnerWhere($current_user->id);
189 // Export entire list was broken because the where clause already has "where" in it
190 // and when the query is built, it has a "where" as well, so the query was ill-formed.
191 // Eliminating the "where" here so that the query can be constructed correctly.
192 if($members == true){
193 $query = $focus->create_export_members_query($records);
195 $beginWhere = substr(trim($where), 0, 5);
196 if ($beginWhere == "where")
197 $where = substr(trim($where), 5, strlen($where));
198 $ret_array = create_export_query_relate_link_patch($type, $searchFields, $where);
199 if(!empty($ret_array['join'])) {
200 $query = $focus->create_export_query($order_by,$ret_array['where'],$ret_array['join']);
202 $query = $focus->create_export_query($order_by,$ret_array['where']);
209 $result = $db->limitQuery($query, 0, $sampleRecordNum, true, $app_strings['ERR_EXPORT_TYPE'].$type.": <BR>.".$query);
210 if( $focus->_get_num_rows_in_query($query)<1 ){
215 $result = $db->query($query, true, $app_strings['ERR_EXPORT_TYPE'].$type.": <BR>.".$query);
219 $fields_array = $db->getFieldsArray($result,true);
221 //set up the order on the header row
222 $fields_array = get_field_order_mapping($focus->module_dir, $fields_array);
226 //set up labels to be used for the header row
227 $field_labels = array();
228 foreach($fields_array as $key=>$dbname){
229 //Remove fields that are only used for logic
230 if($members && (in_array($dbname, $remove_from_members)))
233 //default to the db name of label does not exist
234 $field_labels[$key] = translateForExport($dbname,$focus);
237 $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : '';
238 if ($locale->getExportCharset() == 'UTF-8' &&
239 ! preg_match('/macintosh|mac os x|mac_powerpc/i', $user_agent)) // Bug 60377 - Mac Excel doesn't support UTF-8
241 //Bug 55520 - add BOM to the exporting CSV so any symbols are displayed correctly in Excel
242 $BOM = "\xEF\xBB\xBF";
250 // setup the "header" line with proper delimiters
251 $content .= "\"".implode("\"".getDelimiter()."\"", array_values($field_labels))."\"\r\n";
255 //this is a sample request with no data, so create fake datarows
256 $content .= returnFakeDataRow($focus,$fields_array,$sampleRecordNum);
260 //process retrieved record
261 while($val = $db->fetchByAssoc($result, false)) {
263 //order the values in the record array
264 $val = get_field_order_mapping($focus->module_dir,$val);
268 if($pre_id == $val['id'])
270 if($val['ea_deleted']==1 || $val['ear_deleted']==1){
271 $val['primary_email_address'] = '';
273 unset($val['ea_deleted']);
274 unset($val['ear_deleted']);
275 unset($val['primary_address']);
277 $pre_id = $val['id'];
279 foreach ($val as $key => $value)
281 //getting content values depending on their types
282 $fieldNameMapKey = $fields_array[$key];
284 if (isset($focus->field_name_map[$fieldNameMapKey]) && $focus->field_name_map[$fieldNameMapKey]['type'])
286 $fieldType = $focus->field_name_map[$fieldNameMapKey]['type'];
289 //if our value is a currency field, then apply the users locale
291 require_once('modules/Currencies/Currency.php');
292 $value = currency_format_number($value);
295 //if our value is a datetime field, then apply the users locale
297 case 'datetimecombo':
298 $value = $timedate->to_display_date_time($db->fromConvert($value, 'datetime'));
299 $value = preg_replace('/([pm|PM|am|AM]+)/', ' \1', $value);
304 $value = $timedate->to_display_date($db->fromConvert($value, 'date'), false);
307 // Bug 32463 - Properly have multienum field translated into something useful for the client
309 $value = str_replace("^","",$value);
310 if (isset($focus->field_name_map[$fields_array[$key]]['options']) && isset($app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']]) )
312 $valueArray = explode(",",$value);
313 foreach ($valueArray as $multikey => $multivalue )
315 if (isset($app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']][$multivalue]) )
317 $valueArray[$multikey] = $app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']][$multivalue];
320 $value = implode(",",$valueArray);
327 // Keep as $key => $value for post-processing
328 $new_arr[$key] = preg_replace("/\"/","\"\"", $value);
331 // Use Bean ID as key for records
332 $records[$pre_id] = $new_arr;
335 // Check if we're going to export non-primary emails
336 if ($focus->hasEmails() && in_array('email_addresses_non_primary', $fields_array))
338 // $records keys are bean ids
339 $keys = array_keys($records);
341 // Split the ids array into chunks of size 100
342 $chunks = array_chunk($keys, 100);
344 foreach ($chunks as $chunk)
346 // Pick all the non-primary mails for the chunk
349 SELECT eabr.bean_id, ea.email_address
350 FROM email_addr_bean_rel eabr
351 LEFT JOIN email_addresses ea ON ea.id = eabr.email_address_id
352 WHERE eabr.bean_module = '{$focus->module_dir}'
353 AND eabr.primary_address = '0'
354 AND eabr.bean_id IN ('" . implode("', '", $chunk) . "')
355 AND eabr.deleted != '1'
356 ORDER BY eabr.bean_id, eabr.reply_to_address, eabr.primary_address DESC
359 $result = $db->query($query, true, $app_strings['ERR_EXPORT_TYPE'] . $type . ": <BR>." . $query);
361 while ($val = $db->fetchByAssoc($result, false)) {
362 if (empty($records[$val['bean_id']]['email_addresses_non_primary'])) {
363 $records[$val['bean_id']]['email_addresses_non_primary'] = $val['email_address'];
365 // No custom non-primary mail delimeter yet, use semi-colon
366 $records[$val['bean_id']]['email_addresses_non_primary'] .= ';' . $val['email_address'];
372 foreach($records as $record)
374 $line = implode("\"" . getDelimiter() . "\"", $record);
375 $line = "\"" . $line;
387 function generateSearchWhere($module, $query) {//this function is similar with function prepareSearchForm() in view.list.php
388 $seed = loadBean($module);
389 if(file_exists('modules/'.$module.'/SearchForm.html')){
390 if(file_exists('modules/' . $module . '/metadata/SearchFields.php')) {
391 require_once('include/SearchForm/SearchForm.php');
392 $searchForm = new SearchForm($module, $seed);
394 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.
395 // 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.
396 $where = $_SESSION['export_where'];
397 $whereArr = explode (" ", trim($where));
398 if ($whereArr[0] == trim('where')) {
399 $whereClean = array_shift($whereArr);
401 $where = implode(" ", $whereArr);
402 //rrs bug: 31329 - previously this was just returning $where, but the problem is the caller of this function
403 //expects the results in an array, not just a string. So rather than fixing the caller, I felt it would be best for
404 //the function to return the results in a standard format.
405 $ret_array['where'] = $where;
406 $ret_array['searchFields'] =array();
414 require_once('include/SearchForm/SearchForm2.php');
416 if(file_exists('custom/modules/'.$module.'/metadata/metafiles.php')){
417 require('custom/modules/'.$module.'/metadata/metafiles.php');
418 }elseif(file_exists('modules/'.$module.'/metadata/metafiles.php')){
419 require('modules/'.$module.'/metadata/metafiles.php');
422 if (file_exists('custom/modules/'.$module.'/metadata/searchdefs.php'))
424 require_once('custom/modules/'.$module.'/metadata/searchdefs.php');
426 elseif (!empty($metafiles[$module]['searchdefs']))
428 require_once($metafiles[$module]['searchdefs']);
430 elseif (file_exists('modules/'.$module.'/metadata/searchdefs.php'))
432 require_once('modules/'.$module.'/metadata/searchdefs.php');
435 //fixing bug #48483: Date Range search on custom date field then export ignores range filter
436 // first of all custom folder should be checked
437 if(file_exists('custom/modules/'.$module.'/metadata/SearchFields.php'))
439 require_once('custom/modules/'.$module.'/metadata/SearchFields.php');
441 elseif(!empty($metafiles[$module]['searchfields']))
443 require_once($metafiles[$module]['searchfields']);
445 elseif(file_exists('modules/'.$module.'/metadata/SearchFields.php'))
447 require_once('modules/'.$module.'/metadata/SearchFields.php');
449 if(empty($searchdefs) || empty($searchFields)) {
450 //for some modules, such as iframe, it has massupdate, but it doesn't have search function, the where sql should be empty.
453 $searchForm = new SearchForm($seed, $module);
454 $searchForm->setup($searchdefs, $searchFields, 'SearchFormGeneric.tpl');
456 $searchForm->populateFromArray(unserialize(base64_decode($query)));
457 $where_clauses = $searchForm->generateSearchWhere(true, $module);
458 if (count($where_clauses) > 0 )$where = '('. implode(' ) AND ( ', $where_clauses) . ')';
459 $GLOBALS['log']->info("Export Where Clause: {$where}");
460 $ret_array['where'] = $where;
461 $ret_array['searchFields'] = $searchForm->searchFields;
465 * calls export method to build up a delimited string and some sample instructional text on how to use this file
466 * @param string type the bean-type to export
467 * @return string delimited string for export with some tutorial text
469 function exportSample($type) {
473 $_REQUEST['all']=true;
475 //retrieve the export content
476 $content = export($type, null, false, true);
478 // Add a new row and add details on removing the sample data
479 // Our Importer will stop after he gets to the new row, ignoring the text below
480 return $content . "\n" . $app_strings['LBL_IMPORT_SAMPLE_FILE_TEXT'];
483 //this function will take in the bean and field mapping and return a proper value
484 function returnFakeDataRow($focus,$field_array,$rowsToReturn = 5){
486 if(empty($focus) || empty($field_array))
489 //include the file that defines $sugar_demodata
490 include('install/demoData.en_us.php');
492 $person_bean = false;
493 if( isset($focus->first_name)){
502 //iterate through the record creation process as many times as defined. Each iteration will create a new row
503 while($counter < $rowsToReturn){
505 //go through each field and populate with dummy data if possible
506 foreach($field_array as $field_name){
508 if(empty($focus->field_name_map[$field_name]) || empty($focus->field_name_map[$field_name]['type'])){
509 //type is not set, fill in with empty string and continue;
510 $returnContent .= '"",';
513 $field = $focus->field_name_map[$field_name];
514 //fill in value according to type
515 $type = $field['type'];
520 case "assigned_user_name":
521 //return new guid string
522 $returnContent .= '"'.create_guid().'",';
525 //return random number`
526 $returnContent .= '"'.mt_rand(0,4).'",';
529 //return first, last, user name, or random name string
530 if($field['name'] == 'first_name'){
531 $count = count($sugar_demodata['first_name_array']) - 1;
532 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
533 }elseif($field['name'] == 'last_name'){
534 $count = count($sugar_demodata['last_name_array']) - 1;
535 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
536 }elseif($field['name'] == 'user_name'){
537 $count = count($sugar_demodata['first_name_array']) - 1;
538 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'_'.mt_rand(1,111).'",';
540 //return based on bean
541 if($focus->module_dir =='Accounts'){
542 $count = count($sugar_demodata['company_name_array']) - 1;
543 $returnContent .= '"'.$sugar_demodata['company_name_array'][mt_rand(0,$count)].'",';
545 }elseif($focus->module_dir =='Bugs'){
546 $count = count($sugar_demodata['bug_seed_names']) - 1;
547 $returnContent .= '"'.$sugar_demodata['bug_seed_names'][mt_rand(0,$count)].'",';
548 }elseif($focus->module_dir =='Notes'){
549 $count = count($sugar_demodata['note_seed_names_and_Descriptions']) - 1;
550 $returnContent .= '"'.$sugar_demodata['note_seed_names_and_Descriptions'][mt_rand(0,$count)].'",';
552 }elseif($focus->module_dir =='Calls'){
553 $count = count($sugar_demodata['call_seed_data_names']) - 1;
554 $returnContent .= '"'.$sugar_demodata['call_seed_data_names'][mt_rand(0,$count)].'",';
556 }elseif($focus->module_dir =='Tasks'){
557 $count = count($sugar_demodata['task_seed_data_names']) - 1;
558 $returnContent .= '"'.$sugar_demodata['task_seed_data_names'][mt_rand(0,$count)].'",';
560 }elseif($focus->module_dir =='Meetings'){
561 $count = count($sugar_demodata['meeting_seed_data_names']) - 1;
562 $returnContent .= '"'.$sugar_demodata['meeting_seed_data_names'][mt_rand(0,$count)].'",';
564 }elseif($focus->module_dir =='ProductCategories'){
565 $count = count($sugar_demodata['productcategory_seed_data_names']) - 1;
566 $returnContent .= '"'.$sugar_demodata['productcategory_seed_data_names'][mt_rand(0,$count)].'",';
569 }elseif($focus->module_dir =='ProductTypes'){
570 $count = count($sugar_demodata['producttype_seed_data_names']) - 1;
571 $returnContent .= '"'.$sugar_demodata['producttype_seed_data_names'][mt_rand(0,$count)].'",';
574 }elseif($focus->module_dir =='ProductTemplates'){
575 $count = count($sugar_demodata['producttemplate_seed_data']) - 1;
576 $returnContent .= '"'.$sugar_demodata['producttemplate_seed_data'][mt_rand(0,$count)].'",';
579 $returnContent .= '"Default Name for '.$focus->module_dir.'",';
586 if($field['name'] == 'team_name'){
587 //apply team names and user_name
588 $teams_count = count($sugar_demodata['teams']) - 1;
589 $users_count = count($sugar_demodata['users']) - 1;
591 $returnContent .= '"'.$sugar_demodata['teams'][mt_rand(0,$teams_count)]['name'].','.$sugar_demodata['users'][mt_rand(0,$users_count)]['user_name'].'",';
595 $returnContent .= '"'.create_guid().'",';
600 $returnContent .= '"'.mt_rand(0,1).'",';
605 $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",';
609 $teams_count = count($sugar_demodata['teams']) - 1;
610 //give fake team names (East,West,North,South)
611 $returnContent .= '"'.$sugar_demodata['teams'][mt_rand(0,$teams_count)]['name'].'",';
615 //return formatted date
616 $timeStamp = strtotime('now');
617 $value = date($timedate->dbDayFormat, $timeStamp);
618 $returnContent .= '"'.$timedate->to_display_date_time($value).'",';
622 case "datetimecombo":
623 //return formatted date time
624 $timeStamp = strtotime('now');
626 $value = date($timedate->dbDayFormat.' '.$timedate->dbTimeFormat, $timeStamp);
627 //use timedate to convert to user display format
628 $value = $timedate->to_display_date_time($value);
629 //finally forma the am/pm to have a space so it can be recognized as a date field in excel
630 $value = preg_replace('/([pm|PM|am|AM]+)/', ' \1', $value);
631 $returnContent .= '"'.$value.'",';
635 $value = '('.mt_rand(300,999).') '.mt_rand(300,999).'-'.mt_rand(1000,9999);
636 $returnContent .= '"'.$value.'",';
639 //process varchar for possible values
640 if($field['name'] == 'first_name'){
641 $count = count($sugar_demodata['first_name_array']) - 1;
642 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
643 }elseif($field['name'] == 'last_name'){
644 $count = count($sugar_demodata['last_name_array']) - 1;
645 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'",';
646 }elseif($field['name'] == 'user_name'){
647 $count = count($sugar_demodata['first_name_array']) - 1;
648 $returnContent .= '"'.$sugar_demodata['last_name_array'][mt_rand(0,$count)].'_'.mt_rand(1,111).'",';
649 }elseif($field['name'] == 'title'){
650 $count = count($sugar_demodata['titles']) - 1;
651 $returnContent .= '"'.$sugar_demodata['titles'][mt_rand(0,$count)].'",';
652 }elseif(strpos($field['name'],'address_street')>0){
653 $count = count($sugar_demodata['street_address_array']) - 1;
654 $returnContent .= '"'.$sugar_demodata['street_address_array'][mt_rand(0,$count)].'",';
655 }elseif(strpos($field['name'],'address_city')>0){
656 $count = count($sugar_demodata['city_array']) - 1;
657 $returnContent .= '"'.$sugar_demodata['city_array'][mt_rand(0,$count)].'",';
658 }elseif(strpos($field['name'],'address_state')>0){
659 $state_arr = array('CA','NY','CO','TX','NV');
660 $count = count($state_arr) - 1;
661 $returnContent .= '"'.$state_arr[mt_rand(0,$count)].'",';
662 }elseif(strpos($field['name'],'address_postalcode')>0){
663 $returnContent .= '"'.mt_rand(12345,99999).'",';
665 $returnContent .= '"",';
670 $returnContent .= '"https://www.sugarcrm.com",';
674 //get the associated enum if available
675 global $app_list_strings;
677 if(isset($focus->field_name_map[$field_name]['type']) && !empty($focus->field_name_map[$field_name]['options'])){
678 if ( !empty($app_list_strings[$focus->field_name_map[$field_name]['options']]) ) {
680 //get the values into an array
681 $dd_values = $app_list_strings[$focus->field_name_map[$field_name]['options']];
682 $dd_values = array_values($dd_values);
685 $count = count($dd_values) - 1;
687 //choose one at random
688 $returnContent .= '"'.$dd_values[mt_rand(0,$count)].'",';
690 //name of enum options array was found but is empty, return blank
691 $returnContent .= '"",';
694 //name of enum options array was not found on field, return blank
695 $returnContent .= '"",';
699 //type is not matched, fill in with empty string and continue;
700 $returnContent .= '"",';
704 $returnContent .= "\r\n";
706 return $returnContent;
712 //expects the field name to translate and a bean of the type being translated (to access field map and mod_strings)
713 function translateForExport($field_db_name,$focus){
714 global $mod_strings,$app_strings;
716 if (empty($field_db_name) || empty($focus)){
720 //grab the focus module strings
721 $temp_mod_strings = $mod_strings;
722 global $current_language;
723 $mod_strings = return_module_language($current_language, $focus->module_dir);
726 //!! first check to see if we are overriding the label for export.
727 if (!empty($mod_strings['LBL_EXPORT_'.strtoupper($field_db_name)])){
728 //entry exists which means we are overriding this value for exporting, use this label
729 $fieldLabel = $mod_strings['LBL_EXPORT_'.strtoupper($field_db_name)];
732 //!! next check to see if we are overriding the label for export on app_strings.
733 elseif (!empty($app_strings['LBL_EXPORT_'.strtoupper($field_db_name)])){
734 //entry exists which means we are overriding this value for exporting, use this label
735 $fieldLabel = $app_strings['LBL_EXPORT_'.strtoupper($field_db_name)];
737 }//check to see if label exists in mapping and in mod strings
738 elseif (!empty($focus->field_name_map[$field_db_name]['vname']) && !empty($mod_strings[$focus->field_name_map[$field_db_name]['vname']])){
739 $fieldLabel = $mod_strings[$focus->field_name_map[$field_db_name]['vname']];
741 }//check to see if label exists in mapping and in app strings
742 elseif (!empty($focus->field_name_map[$field_db_name]['vname']) && !empty($app_strings[$focus->field_name_map[$field_db_name]['vname']])){
743 $fieldLabel = $app_strings[$focus->field_name_map[$field_db_name]['vname']];
745 }//field is not in mapping, so check to see if db can be uppercased and found in mod strings
746 elseif (!empty($mod_strings['LBL_'.strtoupper($field_db_name)])){
747 $fieldLabel = $mod_strings['LBL_'.strtoupper($field_db_name)];
749 }//check to see if db can be uppercased and found in app strings
750 elseif (!empty($app_strings['LBL_'.strtoupper($field_db_name)])){
751 $fieldLabel = $app_strings['LBL_'.strtoupper($field_db_name)];
754 //we could not find the label in mod_strings or app_strings based on either a mapping entry
755 //or on the db_name itself or being overwritten, so default to the db name as a last resort
756 $fieldLabel = $field_db_name;
759 //strip the label of any columns
760 $fieldLabel= preg_replace("/([:]|\xEF\xBC\x9A)[\\s]*$/", '', trim($fieldLabel));
762 //reset the bean mod_strings back to original import strings
763 $mod_strings = $temp_mod_strings;
768 //call this function to return the desired order to display columns for export in.
769 //if you pass in an array, it will reorder the array and send back to you. It expects the array
770 //to have the db names as key values, or as labels
771 function get_field_order_mapping($name='',$reorderArr = '', $exclude = true){
773 //define the ordering of fields, note that the key value is what is important, and should be the db field name
774 $field_order_array = array();
775 $field_order_array['accounts'] = array( 'name'=>'Name', 'id'=>'ID', 'website'=>'Website', 'email_address' =>'Email Address', 'email_addresses_non_primary' => 'Non Primary E-mails', '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');
776 $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', 'email_addresses_non_primary' => 'Non Primary E-mails for Import', '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');
777 $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', 'email_addresses_non_primary' => 'Non Primary E-mails for Import', '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');
778 $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');
779 $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' );
780 $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');
781 $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');
782 $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');
783 $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');
784 $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');
785 $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', 'email_addresses_non_primary' => 'Non Primary E-mails for Import', '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');
787 $fields_to_exclude = array();
788 $fields_to_exclude['accounts'] = array('account_name');
789 $fields_to_exclude['bugs'] = array('system_id');
790 $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');
791 $fields_to_exclude['notes'] = array('first_name','last_name', 'file_mime_type','embed_flag');
792 $fields_to_exclude['tasks'] = array('date_start_flag', 'date_due_flag');
794 //of array is passed in for reordering, process array
795 if(!empty($name) && !empty($reorderArr) && is_array($reorderArr)){
797 //make sure reorderArr has values as keys, if not then iterate through and assign the value as the key
798 $newReorder = array();
799 foreach($reorderArr as $rk=> $rv){
801 $newReorder[$rv]=$rv;
803 $newReorder[$rk]=$rv;
807 //if module is not defined, lets default the order to another module of the same type
808 //this would apply mostly to custom modules
809 if(!isset($field_order_array[strtolower($name)]) && isset($_REQUEST['module'])){
811 $exemptModuleList = array('ProspectLists');
812 if(in_array($name, $exemptModuleList))
815 //get an instance of the bean
819 $bean = $beanList[$_REQUEST['module']];
820 require_once($beanFiles[$bean]);
824 //if module is of type person
825 if($focus instanceof Person){
828 //if module is of type company
829 else if ($focus instanceof Company){
832 //if module is of type Sale
833 else if ($focus instanceof Sale){
834 $name = 'opportunities';
835 }//if module is of type File
836 else if ($focus instanceof Issue){
838 }//all others including type File can use basic
845 //lets iterate through and create a reordered temporary array using
846 //the newly formatted copy of passed in array
847 $temp_result_arr = array();
848 $lname = strtolower($name);
849 if(!empty($field_order_array[$lname])) {
850 foreach($field_order_array[$lname] as $fk=> $fv){
852 //if the value exists as a key in the passed in array, add to temp array and remove from reorder array.
853 //Do not force into the temp array as we don't want to violate acl's
854 if(array_key_exists($fk,$newReorder)){
855 $temp_result_arr[$fk] = $newReorder[$fk];
856 unset($newReorder[$fk]);
860 //add in all the left over values that were not in our ordered list
861 //array_splice($temp_result_arr, count($temp_result_arr), 0, $newReorder);
862 foreach($newReorder as $nrk=>$nrv){
863 $temp_result_arr[$nrk] = $nrv;
868 //Some arrays have values we wish to exclude
869 if (isset($fields_to_exclude[$lname])){
870 foreach($fields_to_exclude[$lname] as $exclude_field){
871 unset($temp_result_arr[$exclude_field]);
876 //return temp ordered list
877 return $temp_result_arr;
880 //if no array was passed in, pass back either the list of ordered columns by module, or the entireorder array
882 return $field_order_array;
884 return $field_order_array[strtolower($name)];