Files
crm.e5.pl/include/export_utils.php

323 lines
13 KiB
PHP
Raw Normal View History

2024-04-27 09:23:34 +02:00
<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
/*********************************************************************************
* SugarCRM is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2010 SugarCRM Inc.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by the
* Free Software Foundation with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License along with
* this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* SugarCRM" logo. If the display of the logo is not reasonably feasible for
* technical reasons, the Appropriate Legal Notices must display the words
* "Powered by SugarCRM".
********************************************************************************/
/*********************************************************************************
* Description:
* Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights
* Reserved. Contributor(s): ______________________________________..
* *******************************************************************************/
/**
* gets the system default delimiter or an user-preference based override
* @return string the delimiter
*/
function getDelimiter() {
global $sugar_config;
global $current_user;
$delimiter = ','; // default to "comma"
$userDelimiter = $current_user->getPreference('export_delimiter');
$delimiter = empty($sugar_config['export_delimiter']) ? $delimiter : $sugar_config['export_delimiter'];
$delimiter = empty($userDelimiter) ? $delimiter : $userDelimiter;
return $delimiter;
}
/**
* builds up a delimited string for export
* @param string type the bean-type to export
* @param array records an array of records if coming directly from a query
* @return string delimited string for export
*/
function export($type, $records = null, $members = false) {
global $beanList;
global $beanFiles;
global $current_user;
global $app_strings;
global $app_list_strings;
global $timedate;
$contact_fields = array(
"id"=>"Contact ID"
,"lead_source"=>"Lead Source"
,"date_entered"=>"Date Entered"
,"date_modified"=>"Date Modified"
,"first_name"=>"First Name"
,"last_name"=>"Last Name"
,"salutation"=>"Salutation"
,"birthdate"=>"Lead Source"
,"do_not_call"=>"Do Not Call"
,"email_opt_out"=>"Email Opt Out"
,"title"=>"Title"
,"department"=>"Department"
,"birthdate"=>"Birthdate"
,"do_not_call"=>"Do Not Call"
,"phone_home"=>"Phone (Home)"
,"phone_mobile"=>"Phone (Mobile)"
,"phone_work"=>"Phone (Work)"
,"phone_other"=>"Phone (Other)"
,"phone_fax"=>"Fax"
,"email1"=>"Email"
,"email2"=>"Email (Other)"
,"assistant"=>"Assistant"
,"assistant_phone"=>"Assistant Phone"
,"primary_address_street"=>"Primary Address Street"
,"primary_address_city"=>"Primary Address City"
,"primary_address_state"=>"Primary Address State"
,"primary_address_postalcode"=>"Primary Address Postalcode"
,"primary_address_country"=>"Primary Address Country"
,"alt_address_street"=>"Other Address Street"
,"alt_address_city"=>"Other Address City"
,"alt_address_state"=>"Other Address State"
,"alt_address_postalcode"=>"Other Address Postalcode"
,"alt_address_country"=>"Other Address Country"
,"description"=>"Description"
);
$account_fields = array(
"id"=>"Account ID",
"name"=>"Account Name",
"website"=>"Website",
"industry"=>"Industry",
"account_type"=>"Type",
"ticker_symbol"=>"Ticker Symbol",
"employees"=>"Employees",
"ownership"=>"Ownership",
"phone_office"=>"Phone",
"phone_fax"=>"Fax",
"phone_alternate"=>"Other Phone",
"email1"=>"Email",
"email2"=>"Other Email",
"rating"=>"Rating",
"sic_code"=>"SIC Code",
"annual_revenue"=>"Annual Revenue",
"billing_address_street"=>"Billing Address Street",
"billing_address_city"=>"Billing Address City",
"billing_address_state"=>"Billing Address State",
"billing_address_postalcode"=>"Billing Address Postalcode",
"billing_address_country"=>"Billing Address Country",
"shipping_address_street"=>"Shipping Address Street",
"shipping_address_city"=>"Shipping Address City",
"shipping_address_state"=>"Shipping Address State",
"shipping_address_postalcode"=>"Shipping Address Postalcode",
"shipping_address_country"=>"Shipping Address Country",
"description"=>"Description"
);
$focus = 0;
$content = '';
$bean = $beanList[$type];
require_once($beanFiles[$bean]);
$focus = new $bean;
$searchFields = array();
$db = DBManagerFactory::getInstance();
if($records) {
$records = explode(',', $records);
$records = "'" . implode("','", $records) . "'";
$where = "{$focus->table_name}.id in ($records)";
} elseif (isset($_REQUEST['all']) ) {
$where = '';
} else {
if(!empty($_REQUEST['current_post'])) {
$ret_array = generateSearchWhere($type, $_REQUEST['current_post']);
$where = $ret_array['where'];
$searchFields = $ret_array['searchFields'];
} else {
$where = '';
}
}
$order_by = "";
if($focus->bean_implements('ACL')){
if(!ACLController::checkAccess($focus->module_dir, 'export', true)){
ACLController::displayNoAccess();
sugar_die('');
}
if(ACLController::requireOwner($focus->module_dir, 'export')){
if(!empty($where)){
$where .= ' AND ';
}
$where .= $focus->getOwnerWhere($current_user->id);
}
}
// Export entire list was broken because the where clause already has "where" in it
// and when the query is built, it has a "where" as well, so the query was ill-formed.
// Eliminating the "where" here so that the query can be constructed correctly.
if($members == true){
$query = $focus->create_export_members_query($records);
}else{
$beginWhere = substr(trim($where), 0, 5);
if ($beginWhere == "where")
$where = substr(trim($where), 5, strlen($where));
$ret_array = create_export_query_relate_link_patch($type, $searchFields, $where);
if(!empty($ret_array['join'])) {
$query = $focus->create_export_query($order_by,$ret_array['where'],$ret_array['join']);
} else {
$query = $focus->create_export_query($order_by,$ret_array['where']);
}
}
$result = $db->query($query, true, $app_strings['ERR_EXPORT_TYPE'].$type.": <BR>.".$query);
$fields_array = $db->getFieldsArray($result,true);
// setup the "header" line with proper delimiters
$header = implode("\"".getDelimiter()."\"", array_values($fields_array));
if($members){
$header = str_replace('"ea_deleted"'.getDelimiter().'"ear_deleted"'.getDelimiter().'"primary_address"'.getDelimiter().'','',$header);
}
$header = "\"" .$header;
$header .= "\"\r\n";
$content .= $header;
$pre_id = '';
while($val = $db->fetchByAssoc($result, -1, false)) {
$new_arr = array();
if($members){
if($pre_id == $val['id'])
continue;
if($val['ea_deleted']==1 || $val['ear_deleted']==1){
$val['primary_email_address'] = '';
}
unset($val['ea_deleted']);
unset($val['ear_deleted']);
unset($val['primary_address']);
}
$pre_id = $val['id'];
$vals = array_values($val);
foreach ($vals as $key => $value) {
//if our value is a datetime field, then apply the users locale
if(isset($focus->field_name_map[$fields_array[$key]]['type']) && ($focus->field_name_map[$fields_array[$key]]['type'] == 'datetime' || $focus->field_name_map[$fields_array[$key]]['type'] == 'datetimecombo')){
$value = $timedate->to_display_date_time($value);
$value = preg_replace('/([pm|PM|am|AM]+)/', ' \1', $value);
}
//kbrill Bug #16296
if(isset($focus->field_name_map[$fields_array[$key]]['type']) && $focus->field_name_map[$fields_array[$key]]['type'] == 'date'){
$value = $timedate->to_display_date($value, false);
}
// Bug 32463 - Properly have multienum field translated into something useful for the client
if(isset($focus->field_name_map[$fields_array[$key]]['type']) && $focus->field_name_map[$fields_array[$key]]['type'] == 'multienum'){
$value = str_replace("^","",$value);
if ( isset($focus->field_name_map[$fields_array[$key]]['options'])
&& isset($app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']]) ) {
$valueArray = explode(",",$value);
foreach ( $valueArray as $multikey => $multivalue ) {
if ( isset($app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']][$multivalue]) ) {
$valueArray[$multikey] = $app_list_strings[$focus->field_name_map[$fields_array[$key]]['options']][$multivalue];
}
}
$value = implode(",",$valueArray);
}
}
array_push($new_arr, preg_replace("/\"/","\"\"", $value));
}
$line = implode("\"".getDelimiter()."\"", $new_arr);
$line = "\"" .$line;
$line .= "\"\r\n";
$content .= $line;
}
return $content;
}
function generateSearchWhere($module, $query) {//this function is similar with function prepareSearchForm() in view.list.php
$seed = loadBean($module);
if(file_exists('modules/'.$module.'/SearchForm.html')){
if(file_exists('modules/' . $module . '/metadata/SearchFields.php')) {
require_once('include/SearchForm/SearchForm.php');
$searchForm = new SearchForm($module, $seed);
}
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.
//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.
$where = $_SESSION['export_where'];
$whereArr = explode (" ", trim($where));
if ($whereArr[0] == trim('where')) {
$whereClean = array_shift($whereArr);
}
$where = implode(" ", $whereArr);
//rrs bug: 31329 - previously this was just returning $where, but the problem is the caller of this function
//expects the results in an array, not just a string. So rather than fixing the caller, I felt it would be best for
//the function to return the results in a standard format.
$ret_array['where'] = $where;
$ret_array['searchFields'] =array();
return $ret_array;
}
else {
return;
}
}
else{
require_once('include/SearchForm/SearchForm2.php');
if (file_exists('custom/modules/'.$module.'/metadata/searchdefs.php'))
{
require_once('custom/modules/'.$module.'/metadata/searchdefs.php');
}
elseif (!empty($metafiles[$module]['searchdefs']))
{
require_once($metafiles[$module]['searchdefs']);
}
elseif (file_exists('modules/'.$module.'/metadata/searchdefs.php'))
{
require_once('modules/'.$module.'/metadata/searchdefs.php');
}
if(!empty($metafiles[$module]['searchfields']))
require_once($metafiles[$module]['searchfields']);
elseif(file_exists('modules/'.$module.'/metadata/SearchFields.php'))
require_once('modules/'.$module.'/metadata/SearchFields.php');
if(empty($searchdefs) || empty($searchFields)) {
//for some modules, such as iframe, it has massupdate, but it doesn't have search function, the where sql should be empty.
return;
}
$searchForm = new SearchForm($seed, $module);
$searchForm->setup($searchdefs, $searchFields, 'include/SearchForm/tpls/SearchFormGeneric.tpl');
}
$searchForm->populateFromArray(unserialize(base64_decode($query)));
$where_clauses = $searchForm->generateSearchWhere(true, $module);
if (count($where_clauses) > 0 )$where = '('. implode(' ) AND ( ', $where_clauses) . ')';
$GLOBALS['log']->info("Export Where Clause: {$where}");
$ret_array['where'] = $where;
$ret_array['searchFields'] = $searchForm->searchFields;
return $ret_array;
}
?>