archive/salesagility_SuiteCRM
0
0
Fork 0
mirror of https://github.com/salesagility/SuiteCRM.git synced 2025-02-05 14:39:45 +00:00
Code Issues Projects Releases Wiki Activity
salesagility_SuiteCRM/service/v3/SugarWebServiceUtilv3.php
Clemente Raposo ff5fe5c894 Run rector on service folder
2023-07-18 15:53:08 +01:00

436 lines
19 KiB
PHP
Executable file
Raw Permalink Blame History

<?php
/**
*
* SugarCRM Community Edition is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
*
* SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
* Copyright (C) 2011 - 2018 SalesAgility Ltd.
*
* 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 and "Supercharged by SuiteCRM" logo. If the display of the logos is not
* reasonably feasible for technical reasons, the Appropriate Legal Notices must
* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
*/
require_once('service/core/SoapHelperWebService.php');
#[\AllowDynamicProperties]
class SugarWebServiceUtilv3 extends SoapHelperWebServices
{
public function get_name_value($field, $value)
{
if ($value instanceof Link2 && !method_exists($value, '__toString')) {
$value = '';
}
return array('name'=>$field, 'value'=>$value);
}
public function filter_fields($value, $fields)
{
$GLOBALS['log']->info('Begin: SoapHelperWebServices->filter_fields');
global $invalid_contact_fields;
$filterFields = array();
foreach ($fields as $field) {
if (is_array($invalid_contact_fields)) {
if (in_array($field, $invalid_contact_fields)) {
continue;
}
}
if (isset($value->field_defs[$field])) {
$var = $value->field_defs[$field];
if ($var['type'] == 'link') {
continue;
}
if (isset($var['source'])
&& ($var['source'] != 'db' && $var['source'] != 'custom_fields' && $var['source'] != 'non-db')
&& $var['name'] != 'email1' && $var['name'] != 'email2'
&& (!isset($var['type'])|| $var['type'] != 'relate')) {
if ($value->module_dir == 'Emails'
&& (($var['name'] == 'description') || ($var['name'] == 'description_html') || ($var['name'] == 'from_addr_name')
|| ($var['name'] == 'reply_to_addr') || ($var['name'] == 'to_addrs_names') || ($var['name'] == 'cc_addrs_names')
|| ($var['name'] == 'bcc_addrs_names') || ($var['name'] == 'raw_source'))) {
} else {
continue;
}
}
}
$filterFields[] = $field;
}
$GLOBALS['log']->info('End: SoapHelperWebServices->filter_fields');
return $filterFields;
}
public function getRelationshipResults($bean, $link_field_name, $link_module_fields, $optional_where = '', $order_by = '')
{
$GLOBALS['log']->info('Begin: SoapHelperWebServices->getRelationshipResults');
require_once('include/TimeDate.php');
global $beanList, $beanFiles, $current_user;
global $disable_date_format, $timedate;
$bean->load_relationship($link_field_name);
if (isset($bean->$link_field_name)) {
//First get all the related beans
$params = array();
if (!empty($optional_where)) {
$params['where'] = $optional_where;
}
$related_beans = $bean->$link_field_name->getBeans($params);
//Create a list of field/value rows based on $link_module_fields
$list = array();
$filterFields = array();
if (!empty($order_by) && !empty($related_beans)) {
$related_beans = order_beans($related_beans, $order_by);
}
foreach ($related_beans as $id => $bean) {
if (empty($filterFields) && !empty($link_module_fields)) {
$filterFields = $this->filter_fields($bean, $link_module_fields);
}
$row = array();
foreach ($filterFields as $field) {
if (isset($bean->$field)) {
if (isset($bean->field_defs[$field]['type']) && $bean->field_defs[$field]['type'] == 'date') {
$row[$field] = $timedate->to_display_date_time($bean->$field);
}
$row[$field] = $bean->$field;
} else {
$row[$field] = "";
}
}
//Users can't see other user's hashes
if (is_a($bean, 'User') && $current_user->id != $bean->id && isset($row['user_hash'])) {
$row['user_hash'] = "";
}
$row = clean_sensitive_data($bean->field_defs, $row);
$list[] = $row;
}
$GLOBALS['log']->info('End: SoapHelperWebServices->getRelationshipResults');
return array('rows' => $list, 'fields_set_on_rows' => $filterFields);
}
$GLOBALS['log']->info('End: SoapHelperWebServices->getRelationshipResults - ' . $link_field_name . ' relationship does not exists');
return false;
// else
} // fn
public function get_field_list($value, $fields, $translate=true)
{
$GLOBALS['log']->info('Begin: SoapHelperWebServices->get_field_list');
$module_fields = array();
$link_fields = array();
if (!empty($value->field_defs)) {
foreach ($value->field_defs as $var) {
if (!empty($fields) && !in_array($var['name'], $fields)) {
continue;
}
if (isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'non-db' &&$var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate')) {
continue;
}
if ((isset($var['source']) && $var['source'] == 'non_db') || (isset($var['type']) && $var['type'] == 'link')) {
continue;
}
$required = 0;
$options_dom = array();
$options_ret = array();
// Apparently the only purpose of this check is to make sure we only return fields
// when we've read a record. Otherwise this function is identical to get_module_field_list
if (isset($var['required']) && ($var['required'] || $var['required'] == 'true')) {
$required = 1;
}
if (isset($var['options'])) {
$options_dom = translate($var['options'], $value->module_dir);
if (!is_array($options_dom)) {
$options_dom = array();
}
foreach ($options_dom as $key=>$oneOption) {
$options_ret[$key] = $this->get_name_value($key, $oneOption);
}
}
if (!empty($var['dbType']) && $var['type'] == 'bool') {
$options_ret['type'] = $this->get_name_value('type', $var['dbType']);
}
$entry = array();
$entry['name'] = $var['name'];
$entry['type'] = $var['type'];
$entry['group'] = isset($var['group']) ? $var['group'] : '';
$entry['id_name'] = isset($var['id_name']) ? $var['id_name'] : '';
if ($var['type'] == 'link') {
$entry['relationship'] = (isset($var['relationship']) ? $var['relationship'] : '');
$entry['module'] = (isset($var['module']) ? $var['module'] : '');
$entry['bean_name'] = (isset($var['bean_name']) ? $var['bean_name'] : '');
$link_fields[$var['name']] = $entry;
} else {
if ($translate) {
$entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
} else {
$entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
}
$entry['required'] = $required;
$entry['options'] = $options_ret;
$entry['related_module'] = (isset($var['id_name']) && isset($var['module'])) ? $var['module'] : '';
if (isset($var['default'])) {
$entry['default_value'] = $var['default'];
}
$module_fields[$var['name']] = $entry;
} // else
} //foreach
} //if
if ($value->module_dir == 'Bugs') {
require_once('modules/Releases/Release.php');
$seedRelease = BeanFactory::newBean('Releases');
$options = $seedRelease->get_releases(true, "Active");
$options_ret = array();
foreach ($options as $name=>$value) {
$options_ret[] = array('name'=> $name , 'value'=>$value);
}
if (isset($module_fields['fixed_in_release'])) {
$module_fields['fixed_in_release']['type'] = 'enum';
$module_fields['fixed_in_release']['options'] = $options_ret;
}
if (isset($module_fields['release'])) {
$module_fields['release']['type'] = 'enum';
$module_fields['release']['options'] = $options_ret;
}
if (isset($module_fields['release_name'])) {
$module_fields['release_name']['type'] = 'enum';
$module_fields['release_name']['options'] = $options_ret;
}
}
if (isset($value->assigned_user_name) && isset($module_fields['assigned_user_id'])) {
$module_fields['assigned_user_name'] = $module_fields['assigned_user_id'];
$module_fields['assigned_user_name']['name'] = 'assigned_user_name';
}
if (isset($value->assigned_name) && isset($module_fields['team_id'])) {
$module_fields['team_name'] = $module_fields['team_id'];
$module_fields['team_name']['name'] = 'team_name';
}
if (isset($module_fields['modified_user_id'])) {
$module_fields['modified_by_name'] = $module_fields['modified_user_id'];
$module_fields['modified_by_name']['name'] = 'modified_by_name';
}
if (isset($module_fields['created_by'])) {
$module_fields['created_by_name'] = $module_fields['created_by'];
$module_fields['created_by_name']['name'] = 'created_by_name';
}
$GLOBALS['log']->info('End: SoapHelperWebServices->get_field_list');
return array('module_fields' => $module_fields, 'link_fields' => $link_fields);
}
public function get_subpanel_defs($module, $type)
{
global $beanList, $beanFiles;
$results = array();
switch ($type) {
case 'default':
default:
if (file_exists('modules/'.$module.'/metadata/subpaneldefs.php')) {
require('modules/'.$module.'/metadata/subpaneldefs.php');
}
if (file_exists('custom/modules/'.$module.'/Ext/Layoutdefs/layoutdefs.ext.php')) {
require('custom/modules/'.$module.'/Ext/Layoutdefs/layoutdefs.ext.php');
}
}
//Filter results for permissions
foreach ($layout_defs[$module]['subpanel_setup'] as $subpanel => $subpaneldefs) {
$moduleToCheck = $subpaneldefs['module'];
if (!isset($beanList[$moduleToCheck])) {
continue;
}
$class_name = $beanList[$moduleToCheck];
$bean = new $class_name();
if ($bean->ACLAccess('list')) {
$results[$subpanel] = $subpaneldefs;
}
}
return $results;
}
public function get_module_view_defs($module_name, $type, $view)
{
$listViewDefs = [];
$viewdefs = [];
require_once('include/MVC/View/SugarView.php');
$metadataFile = null;
$results = array();
$view = strtolower($view);
switch (strtolower($type)) {
case 'default':
default:
if ($view == 'subpanel') {
$results = $this->get_subpanel_defs($module_name, $type);
} else {
$v = new SugarView(null, array());
$v->module = $module_name;
$v->type = $view;
$fullView = ucfirst($view) . 'View';
$metadataFile = $v->getMetaDataFile();
require_once($metadataFile);
if ($view == 'list') {
$results = $listViewDefs[$module_name];
} else {
$results = $viewdefs[$module_name][$fullView];
}
}
}
return $results;
}
/**
* Examine the application to determine which modules have been enabled..
*
* @param array $availModules An array of all the modules the user already has access to.
* @return array Modules enabled within the application.
*/
public function get_visible_modules($availModules)
{
require_once("modules/MySettings/TabController.php");
$controller = new TabController();
$tabs = $controller->get_tabs_system();
$enabled_modules= array();
$availModulesKey = array_flip($availModules);
foreach ($tabs[0] as $key=>$value) {
if (isset($availModulesKey[$key])) {
$enabled_modules[] = $key;
}
}
return $enabled_modules;
}
/**
* Retrieve all of the upcoming activities for a particular user.
*
* @return array
*/
public function get_upcoming_activities()
{
global $beanList;
$maxCount = 10;
$activityModules = array('Meetings' => array('date_field' => 'date_start','status' => 'Planned','status_field' => 'status', 'status_opp' => '='),
'Calls' => array('date_field' => 'date_start','status' => 'Planned','status_field' => 'status', 'status_opp' => '='),
'Tasks' => array('date_field' =>'date_due','status' => 'Not Started','status_field' => 'status','status_opp' => '='),
'Opportunities' => array('date_field' => 'date_closed','status' => array('Closed Won','Closed Lost'), 'status_field' => 'sales_stage', 'status_opp' => '!=') );
$results = array();
foreach ($activityModules as $module => $meta) {
if (!self::check_modules_access($GLOBALS['current_user'], $module, 'read')) {
$GLOBALS['log']->debug("SugarWebServiceImpl->get_last_viewed: NO ACCESS to $module");
continue;
}
$class_name = $beanList[$module];
$seed = new $class_name();
$query = $this->generateUpcomingActivitiesWhereClause($seed, $meta);
$response = $seed->get_list(/* Order by date field */"{$meta['date_field']} ASC", /*Where clause */
$query, /* No Offset */
0,
/* No limit */
-1, /* Max 10 items */
10, /*No Deleted */
0
);
$result = array();
if (isset($response['list'])) {
$result = $this->format_upcoming_activities_entries($response['list'], $meta['date_field']);
}
$results = array_merge($results, $result);
}
//Sort the result list by the date due flag in ascending order
usort($results, array( $this , "cmp_datedue" )) ;
//Only return a subset of the results.
$results = array_slice($results, 0, $maxCount);
return $results;
}
public function generateUpcomingActivitiesWhereClause($seed, $meta)
{
$query = array();
$query_date = TimeDate::getInstance()->nowDb();
$query[] = " {$seed->table_name}.{$meta['date_field']} > '$query_date'"; //Add date filter
$query[] = "{$seed->table_name}.assigned_user_id = '{$GLOBALS['current_user']->id}' "; //Add assigned user filter
if (is_array($meta['status_field'])) {
foreach ($meta['status'] as $field) {
$query[] = "{$seed->table_name}.{$meta['status_field']} {$meta['status_opp']} '".$GLOBALS['db']->quote($field)."' ";
}
} else {
$query[] = "{$seed->table_name}.{$meta['status_field']} {$meta['status_opp']} '".$GLOBALS['db']->quote($meta['status'])."' ";
}
return implode(" AND ", $query);
}
/**
* Given a list of bean entries, format the expected response.
*
* @param array $list An array containing a bean list.
* @param string $date_field Name of the field storing the date field we are examining
* @return array The results.
*/
public function format_upcoming_activities_entries($list, $date_field)
{
$results = array();
foreach ($list as $bean) {
$results[] = array('id' => $bean->id, 'module' => $bean->module_dir,'date_due' => $bean->$date_field,
'summary' => $bean->get_summary_text() );
}
return $results;
}
/**
* Sort the array for upcoming activities based on the date due flag ascending.
*
* @param array $a
* @param array $b
* @return int Indicates equality for date due flag
*/
public static function cmp_datedue($a, $b)
{
$a_date = strtotime($a['date_due']) ;
$b_date = strtotime($b['date_due']) ;
if ($a_date === $b_date) {
return 0 ;
}
return ($a_date > $b_date) ? 1 : -1;
}
}
Reference in a new issue View git blame Copy permalink