2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
6 * This program is free software; you can redistribute it and/or modify it under
7 * the terms of the GNU Affero General Public License version 3 as published by the
8 * Free Software Foundation with the addition of the following permission added
9 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
11 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
18 * You should have received a copy of the GNU Affero General Public License along with
19 * this program; if not, see http://www.gnu.org/licenses or write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
24 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
26 * The interactive user interfaces in modified source and object code versions
27 * of this program must display Appropriate Legal Notices, as required under
28 * Section 5 of the GNU Affero General Public License version 3.
30 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31 * these Appropriate Legal Notices must retain the display of the "Powered by
32 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
33 * technical reasons, the Appropriate Legal Notices must display the words
34 * "Powered by SugarCRM".
35 ********************************************************************************/
37 require_once('service/v3/SugarWebServiceUtilv3.php');
38 class SugarWebServiceUtilv3_1 extends SugarWebServiceUtilv3
41 function get_return_module_fields($value, $module,$fields, $translate=true)
43 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_return_module_fields');
45 $module_name = $module;
46 $result = $this->get_field_list($value,$fields, $translate);
47 $GLOBALS['log']->info('End: SoapHelperWebServices->get_return_module_fields');
49 $tableName = $value->getTableName();
51 return Array('module_name'=>$module, 'table_name' => $tableName,
52 'module_fields'=> $result['module_fields'],
53 'link_fields'=> $result['link_fields'],
59 * Track a view for a particular bean.
61 * @param SugarBean $seed
62 * @param string $current_view
64 function trackView($seed, $current_view)
66 $trackerManager = TrackerManager::getInstance();
67 if($monitor = $trackerManager->getMonitor('tracker'))
69 $monitor->setValue('date_modified', TimeDate::getInstance()->nowDb());
70 $monitor->setValue('user_id', $GLOBALS['current_user']->id);
71 $monitor->setValue('module_name', $seed->module_dir);
72 $monitor->setValue('action', $current_view);
73 $monitor->setValue('item_id', $seed->id);
74 $monitor->setValue('item_summary', $seed->get_summary_text());
75 $monitor->setValue('visible',true);
76 $trackerManager->saveMonitor($monitor, TRUE, TRUE);
81 * Convert modules list to Web services result
83 * @param array $list List of module candidates (only keys are used)
84 * @param array $availModules List of module availability from Session
86 public function getModulesFromList($list, $availModules)
88 global $app_list_strings;
89 $enabled_modules = array();
90 $availModulesKey = array_flip($availModules);
91 foreach ($list as $key=>$value)
93 if( isset($availModulesKey[$key]) )
95 $label = !empty( $app_list_strings['moduleList'][$key] ) ? $app_list_strings['moduleList'][$key] : '';
96 $acl = self::checkModuleRoleAccess($key);
97 $enabled_modules[] = array('module_key' => $key,'module_label' => $label, 'acls' => $acl);
100 return $enabled_modules;
104 * Examine the wireless_module_registry to determine which modules have been enabled for the mobile view.
106 * @param array $availModules An array of all the modules the user already has access to.
107 * @return array Modules enalbed for mobile view.
109 function get_visible_mobile_modules($availModules)
111 foreach ( array ( '','custom/') as $prefix)
113 if(file_exists($prefix.'include/MVC/Controller/wireless_module_registry.php'))
114 require $prefix.'include/MVC/Controller/wireless_module_registry.php' ;
116 return $this->getModulesFromList($wireless_module_registry, $availModules);
120 * Examine the application to determine which modules have been enabled..
122 * @param array $availModules An array of all the modules the user already has access to.
123 * @return array Modules enabled within the application.
125 function get_visible_modules($availModules)
127 require_once("modules/MySettings/TabController.php");
128 $controller = new TabController();
129 $tabs = $controller->get_tabs_system();
130 return $this->getModulesFromList($tabs[0], $availModules);
134 * Generate unifed search fields for a particular module even if the module does not participate in the unified search.
136 * @param string $moduleName
137 * @return array An array of fields to be searched against.
139 function generateUnifiedSearchFields($moduleName)
141 global $beanList, $beanFiles, $dictionary;
143 if(!isset($beanList[$moduleName]))
146 $beanName = $beanList[$moduleName];
148 if (!isset($beanFiles[$beanName]))
151 if($beanName == 'aCase')
154 $manager = new VardefManager ( );
155 $manager->loadVardef( $moduleName , $beanName ) ;
157 // obtain the field definitions used by generateSearchWhere (duplicate code in view.list.php)
158 if(file_exists('custom/modules/'.$moduleName.'/metadata/metafiles.php')){
159 require('custom/modules/'.$moduleName.'/metadata/metafiles.php');
160 }elseif(file_exists('modules/'.$moduleName.'/metadata/metafiles.php')){
161 require('modules/'.$moduleName.'/metadata/metafiles.php');
164 if(!empty($metafiles[$moduleName]['searchfields']))
165 require $metafiles[$moduleName]['searchfields'] ;
166 elseif(file_exists("modules/{$moduleName}/metadata/SearchFields.php"))
167 require "modules/{$moduleName}/metadata/SearchFields.php" ;
170 foreach ( $dictionary [ $beanName ][ 'fields' ] as $field => $def )
172 if (strpos($field,'email') !== false)
175 //bug: 38139 - allow phone to be searched through Global Search
176 if (strpos($field,'phone') !== false)
179 if ( isset($def['unified_search']) && $def['unified_search'] && isset ( $searchFields [ $moduleName ] [ $field ] ))
181 $fields [ $field ] = $searchFields [ $moduleName ] [ $field ] ;
185 //If no fields with the unified flag have been set then lets add a default field.
188 if( isset($dictionary[$beanName]['fields']['name']) && isset($searchFields[$moduleName]['name']) )
189 $fields['name'] = $searchFields[$moduleName]['name'];
192 if( isset($dictionary[$beanName]['fields']['first_name']) && isset($searchFields[$moduleName]['first_name']) )
193 $fields['first_name'] = $searchFields[$moduleName]['first_name'];
194 if( isset($dictionary[$beanName]['fields']['last_name']) && isset($searchFields[$moduleName]['last_name']) )
195 $fields['last_name'] = $searchFields[$moduleName]['last_name'];
203 * Check a module for acces to a set of available actions.
205 * @param string $module
206 * @return array results containing access and boolean indicating access
208 function checkModuleRoleAccess($module)
211 $actions = array('edit','delete','list','view','import','export');
212 foreach ($actions as $action)
214 $access = ACLController::checkAccess($module, $action, true);
215 $results[] = array('action' => $action, 'access' => $access);
221 function get_field_list($value,$fields, $translate=true) {
223 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_field_list');
224 $module_fields = array();
225 $link_fields = array();
226 if(!empty($value->field_defs)){
228 foreach($value->field_defs as $var){
229 if(!empty($fields) && !in_array( $var['name'], $fields))continue;
230 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;
231 if ((isset($var['source']) && $var['source'] == 'non_db') && (isset($var['type']) && $var['type'] != 'link')) {
235 $options_dom = array();
236 $options_ret = array();
237 // Apparently the only purpose of this check is to make sure we only return fields
238 // when we've read a record. Otherwise this function is identical to get_module_field_list
239 if( isset($var['required']) && ($var['required'] || $var['required'] == 'true' ) ){
243 if($var['type'] == 'bool')
244 $var['options'] = 'checkbox_dom';
246 if(isset($var['options'])){
247 $options_dom = translate($var['options'], $value->module_dir);
248 if(!is_array($options_dom)) $options_dom = array();
249 foreach($options_dom as $key=>$oneOption)
250 $options_ret[$key] = $this->get_name_value($key,$oneOption);
253 if(!empty($var['dbType']) && $var['type'] == 'bool') {
254 $options_ret['type'] = $this->get_name_value('type', $var['dbType']);
258 $entry['name'] = $var['name'];
259 $entry['type'] = $var['type'];
260 $entry['group'] = isset($var['group']) ? $var['group'] : '';
261 $entry['id_name'] = isset($var['id_name']) ? $var['id_name'] : '';
263 if ($var['type'] == 'link') {
264 $entry['relationship'] = (isset($var['relationship']) ? $var['relationship'] : '');
265 $entry['module'] = (isset($var['module']) ? $var['module'] : '');
266 $entry['bean_name'] = (isset($var['bean_name']) ? $var['bean_name'] : '');
267 $link_fields[$var['name']] = $entry;
270 $entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
272 $entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
274 $entry['required'] = $required;
275 $entry['options'] = $options_ret;
276 $entry['related_module'] = (isset($var['id_name']) && isset($var['module'])) ? $var['module'] : '';
277 $entry['calculated'] = (isset($var['calculated']) && $var['calculated']) ? true : false;
278 if(isset($var['default'])) {
279 $entry['default_value'] = $var['default'];
281 if( $var['type'] == 'parent' && isset($var['type_name']) )
282 $entry['type_name'] = $var['type_name'];
284 $module_fields[$var['name']] = $entry;
289 if($value->module_dir == 'Meetings' || $value->module_dir == 'Calls')
291 if( isset($module_fields['duration_minutes']) && isset($GLOBALS['app_list_strings']['duration_intervals']))
293 $options_dom = $GLOBALS['app_list_strings']['duration_intervals'];
294 $options_ret = array();
295 foreach($options_dom as $key=>$oneOption)
296 $options_ret[$key] = $this->get_name_value($key,$oneOption);
298 $module_fields['duration_minutes']['options'] = $options_ret;
302 if($value->module_dir == 'Bugs'){
303 require_once('modules/Releases/Release.php');
304 $seedRelease = new Release();
305 $options = $seedRelease->get_releases(TRUE, "Active");
306 $options_ret = array();
307 foreach($options as $name=>$value){
308 $options_ret[] = array('name'=> $name , 'value'=>$value);
310 if(isset($module_fields['fixed_in_release'])){
311 $module_fields['fixed_in_release']['type'] = 'enum';
312 $module_fields['fixed_in_release']['options'] = $options_ret;
314 if(isset($module_fields['found_in_release'])){
315 $module_fields['found_in_release']['type'] = 'enum';
316 $module_fields['found_in_release']['options'] = $options_ret;
318 if(isset($module_fields['release'])){
319 $module_fields['release']['type'] = 'enum';
320 $module_fields['release']['options'] = $options_ret;
322 if(isset($module_fields['release_name'])){
323 $module_fields['release_name']['type'] = 'enum';
324 $module_fields['release_name']['options'] = $options_ret;
328 if(isset($value->assigned_user_name) && isset($module_fields['assigned_user_id'])) {
329 $module_fields['assigned_user_name'] = $module_fields['assigned_user_id'];
330 $module_fields['assigned_user_name']['name'] = 'assigned_user_name';
332 if(isset($value->assigned_name) && isset($module_fields['team_id'])) {
333 $module_fields['team_name'] = $module_fields['team_id'];
334 $module_fields['team_name']['name'] = 'team_name';
336 if(isset($module_fields['modified_user_id'])) {
337 $module_fields['modified_by_name'] = $module_fields['modified_user_id'];
338 $module_fields['modified_by_name']['name'] = 'modified_by_name';
340 if(isset($module_fields['created_by'])) {
341 $module_fields['created_by_name'] = $module_fields['created_by'];
342 $module_fields['created_by_name']['name'] = 'created_by_name';
345 $GLOBALS['log']->info('End: SoapHelperWebServices->get_field_list');
346 return array('module_fields' => $module_fields, 'link_fields' => $link_fields);
350 * Return the contents of a file base64 encoded
352 * @param string $filename - Full path of filename
353 * @param bool $remove - Indicates if the file should be removed after the contents is retrieved.
355 * @return string - Contents base64'd.
357 function get_file_contents_base64($filename, $remove = FALSE)
360 if( file_exists($filename) )
362 $contents = base64_encode(file_get_contents($filename));
370 function get_module_view_defs($module_name, $type, $view){
371 require_once('include/MVC/View/SugarView.php');
372 $metadataFile = null;
374 $view = strtolower($view);
375 switch (strtolower($type)){
377 if( $view == 'list'){
378 require_once('include/SugarWireless/SugarWirelessListView.php');
379 $GLOBALS['module'] = $module_name; //WirelessView keys off global variable not instance variable...
380 $v = new SugarWirelessListView();
381 $results = $v->getMetaDataFile();
383 elseif ($view == 'subpanel')
384 $results = $this->get_subpanel_defs($module_name, $type);
386 require_once('include/SugarWireless/SugarWirelessView.php');
387 $v = new SugarWirelessView();
388 $v->module = $module_name;
389 $fullView = ucfirst($view) . 'View';
390 $meta = $v->getMetaDataFile('Wireless' . $fullView);
391 $metadataFile = $meta['filename'];
392 require($metadataFile);
393 //Wireless detail metadata may actually be just edit metadata.
394 $results = isset($viewdefs[$meta['module_name']][$fullView] ) ? $viewdefs[$meta['module_name']][$fullView] : $viewdefs[$meta['module_name']]['EditView'];
400 if ($view == 'subpanel')
401 $results = $this->get_subpanel_defs($module_name, $type);
404 $v = new SugarView(null,array());
405 $v->module = $module_name;
407 $fullView = ucfirst($view) . 'View';
408 $metadataFile = $v->getMetaDataFile();
409 require_once($metadataFile);
411 $results = $listViewDefs[$module_name];
413 $results = $viewdefs[$module_name][$fullView];
421 * Equivalent of get_list function within SugarBean but allows the possibility to pass in an indicator
422 * if the list should filter for favorites. Should eventually update the SugarBean function as well.
425 function get_data_list($seed, $order_by = "", $where = "", $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $favorites = false, $singleSelect=false)
427 $GLOBALS['log']->debug("get_list: order_by = '$order_by' and where = '$where' and limit = '$limit'");
428 if(isset($_SESSION['show_deleted']))
432 $order_by=$seed->process_order_by($order_by, null);
434 if($seed->bean_implements('ACL') && ACLController::requireOwner($seed->module_dir, 'list') )
436 global $current_user;
437 $owner_where = $seed->getOwnerWhere($current_user->id);
438 if(!empty($owner_where)){
440 $where = $owner_where;
442 $where .= ' AND '. $owner_where;
448 $params['favorites'] = true;
450 $query = $seed->create_new_list_query($order_by, $where,array(),$params, $show_deleted,'',false,null,$singleSelect);
451 return $seed->process_list_query($query, $row_offset, $limit, $max, $where);
455 * Add ACL values to metadata files.
457 * @param String $module_name
458 * @param String $view_type (wireless or detail)
459 * @param String $view (list, detail,edit, etc)
460 * @param array $metadata The metadata for the view type and view.
463 function addFieldLevelACLs($module_name,$view_type, $view, $metadata)
465 $functionName = "metdataAclParser" . ucfirst($view_type) . ucfirst($view);
466 if( method_exists($this, $functionName) )
467 return $this->$functionName($module_name, $metadata);
473 * Parse wireless listview metadata and add ACL values.
475 * @param String $module_name
476 * @param array $metadata
477 * @return array Metadata with acls added
479 function metdataAclParserWirelessList($module_name, $metadata)
481 global $beanList, $beanFiles;
482 $class_name = $beanList[$module_name];
483 require_once($beanFiles[$class_name]);
484 $seed = new $class_name();
487 foreach ($metadata as $field_name => $entry)
489 if($seed->bean_implements('ACL'))
490 $entry['acl'] = $this->getFieldLevelACLValue($seed->module_dir, strtolower($field_name));
494 $results[$field_name] = $entry;
501 * Parse wireless detailview metadata and add ACL values.
503 * @param String $module_name
504 * @param array $metadata
505 * @return array Metadata with acls added
507 function metdataAclParserWirelessEdit($module_name, $metadata)
509 global $beanList, $beanFiles;
510 $class_name = $beanList[$module_name];
511 require_once($beanFiles[$class_name]);
512 $seed = new $class_name();
515 $results['templateMeta'] = $metadata['templateMeta'];
517 //Wireless metadata only has a single panel definition.
518 foreach ($metadata['panels'] as $row)
521 foreach ($row as $field)
524 if( is_string($field) )
525 $aclField['name'] = $field;
529 if($seed->bean_implements('ACL'))
530 $aclField['acl'] = $this->getFieldLevelACLValue($seed->module_dir, $aclField['name']);
532 $aclField['acl'] = 99;
534 $aclRow[] = $aclField;
536 $aclRows[] = $aclRow;
539 $results['panels'] = $aclRows;
543 * Return the field level acl raw value. We cannot use the hasAccess call as we do not have a valid bean
544 * record at the moment and therefore can not specify the is_owner flag. We need the raw access value so we
545 * can do the computation on the client side. TODO: Move function into ACLField class.
547 * @param String $module Name of the module
548 * @param String $field Name of the field
551 function getFieldLevelACLValue($module, $field, $current_user = null)
553 if($current_user == null)
554 $current_user = $GLOBALS['current_user'];
556 if( is_admin($current_user) )
559 if(!isset($_SESSION['ACL'][$current_user->id][$module]['fields'][$field])){
563 return $_SESSION['ACL'][$current_user->id][$module]['fields'][$field];