PageRenderTime 97ms CodeModel.GetById 35ms RepoModel.GetById 0ms app.codeStats 1ms

/include/utils.php

https://github.com/bojkic/SuiteCRM
PHP | 5083 lines | 3452 code | 616 blank | 1015 comment | 735 complexity | 300c757f56f3b674a79ca87e471c9e0f MD5 | raw file
Possible License(s): LGPL-2.1, MPL-2.0-no-copyleft-exception
  1. <?php
  2. /*********************************************************************************
  3. * SugarCRM Community Edition is a customer relationship management program developed by
  4. * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
  5. * SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd.
  6. * Copyright (C) 2011 - 2014 Salesagility Ltd.
  7. *
  8. * This program is free software; you can redistribute it and/or modify it under
  9. * the terms of the GNU Affero General Public License version 3 as published by the
  10. * Free Software Foundation with the addition of the following permission added
  11. * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  12. * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  13. * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  14. *
  15. * This program is distributed in the hope that it will be useful, but WITHOUT
  16. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17. * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
  18. * details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License along with
  21. * this program; if not, see http://www.gnu.org/licenses or write to the Free
  22. * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23. * 02110-1301 USA.
  24. *
  25. * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  26. * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  27. *
  28. * The interactive user interfaces in modified source and object code versions
  29. * of this program must display Appropriate Legal Notices, as required under
  30. * Section 5 of the GNU Affero General Public License version 3.
  31. *
  32. * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  33. * these Appropriate Legal Notices must retain the display of the "Powered by
  34. * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
  35. * reasonably feasible for technical reasons, the Appropriate Legal Notices must
  36. * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
  37. ********************************************************************************/
  38. /*********************************************************************************
  39. * Description: Includes generic helper functions used throughout the application.
  40. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  41. * All Rights Reserved.
  42. * Contributor(s): ______________________________________..
  43. ********************************************************************************/
  44. require_once('include/SugarObjects/SugarConfig.php');
  45. require_once('include/utils/security_utils.php');
  46. function make_sugar_config(&$sugar_config)
  47. {
  48. /* used to convert non-array config.php file to array format */
  49. global $admin_export_only;
  50. global $cache_dir;
  51. global $calculate_response_time;
  52. global $create_default_user;
  53. global $dateFormats;
  54. global $dbconfig;
  55. global $dbconfigoption;
  56. global $default_action;
  57. global $default_charset;
  58. global $default_currency_name;
  59. global $default_currency_symbol;
  60. global $default_currency_iso4217;
  61. global $defaultDateFormat;
  62. global $default_language;
  63. global $default_module;
  64. global $default_password;
  65. global $default_permission_mode;
  66. global $default_theme;
  67. global $defaultTimeFormat;
  68. global $default_user_is_admin;
  69. global $default_user_name;
  70. global $disable_export;
  71. global $disable_persistent_connections;
  72. global $display_email_template_variable_chooser;
  73. global $display_inbound_email_buttons;
  74. global $history_max_viewed;
  75. global $host_name;
  76. global $import_dir;
  77. global $languages;
  78. global $list_max_entries_per_page;
  79. global $lock_default_user_name;
  80. global $log_memory_usage;
  81. global $nameFormats;
  82. global $requireAccounts;
  83. global $RSS_CACHE_TIME;
  84. global $session_dir;
  85. global $site_URL;
  86. global $site_url;
  87. global $sugar_version;
  88. global $timeFormats;
  89. global $tmp_dir;
  90. global $translation_string_prefix;
  91. global $unique_key;
  92. global $upload_badext;
  93. global $upload_dir;
  94. global $upload_maxsize;
  95. global $import_max_execution_time;
  96. global $list_max_entries_per_subpanel;
  97. global $passwordsetting;
  98. // assumes the following variables must be set:
  99. // $dbconfig, $dbconfigoption, $cache_dir, $session_dir, $site_URL, $upload_dir
  100. $sugar_config = array (
  101. 'admin_export_only' => empty($admin_export_only) ? false : $admin_export_only,
  102. 'export_delimiter' => empty($export_delimiter) ? ',' : $export_delimiter,
  103. 'cache_dir' => empty($cache_dir) ? 'cache/' : $cache_dir,
  104. 'calculate_response_time' => empty($calculate_response_time) ? true : $calculate_response_time,
  105. 'create_default_user' => empty($create_default_user) ? false : $create_default_user,
  106. 'chartEngine' => 'Jit',
  107. 'date_formats' => empty($dateFormats) ? array(
  108. 'Y-m-d'=>'2010-12-23',
  109. 'd-m-Y' => '23-12-2010',
  110. 'm-d-Y'=>'12-23-2010',
  111. 'Y/m/d'=>'2010/12/23',
  112. 'd/m/Y' => '23/12/2010',
  113. 'm/d/Y'=>'12/23/2010',
  114. 'Y.m.d' => '2010.12.23',
  115. 'd.m.Y' => '23.12.2010',
  116. 'm.d.Y' => '12.23.2010'
  117. ) : $dateFormats,
  118. 'dbconfig' => $dbconfig, // this must be set!!
  119. 'dbconfigoption' => $dbconfigoption, // this must be set!!
  120. 'default_action' => empty($default_action) ? 'index' : $default_action,
  121. 'default_charset' => empty($default_charset) ? 'UTF-8' : $default_charset,
  122. 'default_currency_name' => empty($default_currency_name) ? 'US Dollar' : $default_currency_name,
  123. 'default_currency_symbol' => empty($default_currency_symbol) ? '$' : $default_currency_symbol,
  124. 'default_currency_iso4217' => empty($default_currency_iso4217) ? '$' : $default_currency_iso4217,
  125. 'default_date_format' => empty($defaultDateFormat) ? 'm/d/Y' : $defaultDateFormat,
  126. 'default_locale_name_format' => empty($defaultNameFormat) ? 's f l' : $defaultNameFormat,
  127. 'default_export_charset' => 'UTF-8',
  128. 'default_language' => empty($default_language) ? 'en_us' : $default_language,
  129. 'default_module' => empty($default_module) ? 'Home' : $default_module,
  130. 'default_password' => empty($default_password) ? '' : $default_password,
  131. 'default_permissions' => array (
  132. 'dir_mode' => 02770,
  133. 'file_mode' => 0660,
  134. 'chown' => '',
  135. 'chgrp' => '',
  136. ),
  137. 'default_theme' => empty($default_theme) ? 'Sugar5' : $default_theme,
  138. 'default_time_format' => empty($defaultTimeFormat) ? 'h:ia' : $defaultTimeFormat,
  139. 'default_user_is_admin' => empty($default_user_is_admin) ? false : $default_user_is_admin,
  140. 'default_user_name' => empty($default_user_name) ? '' : $default_user_name,
  141. 'disable_export' => empty($disable_export) ? false : $disable_export,
  142. 'disable_persistent_connections' => empty($disable_persistent_connections) ? false : $disable_persistent_connections,
  143. 'display_email_template_variable_chooser' => empty($display_email_template_variable_chooser) ? false : $display_email_template_variable_chooser,
  144. 'display_inbound_email_buttons' => empty($display_inbound_email_buttons) ? false : $display_inbound_email_buttons,
  145. 'history_max_viewed' => empty($history_max_viewed) ? 50 : $history_max_viewed,
  146. 'host_name' => empty($host_name) ? 'localhost' : $host_name,
  147. 'import_dir' => $import_dir, // this must be set!!
  148. 'import_max_records_per_file' => 100,
  149. 'import_max_records_total_limit' => '',
  150. 'languages' => empty($languages) ? array('en_us' => 'English (US)') : $languages,
  151. 'list_max_entries_per_page' => empty($list_max_entries_per_page) ? 20 : $list_max_entries_per_page,
  152. 'list_max_entries_per_subpanel' => empty($list_max_entries_per_subpanel) ? 10 : $list_max_entries_per_subpanel,
  153. 'lock_default_user_name' => empty($lock_default_user_name) ? false : $lock_default_user_name,
  154. 'log_memory_usage' => empty($log_memory_usage) ? false : $log_memory_usage,
  155. 'name_formats' => empty($nameFormats) ? array(
  156. 's f l' => 's f l', 'f l' => 'f l', 's l' => 's l', 'l, s f' => 'l, s f',
  157. 'l, f' => 'l, f', 's l, f' => 's l, f', 'l s f' => 'l s f', 'l f s' => 'l f s'
  158. ) : $nameFormats,
  159. 'portal_view' => 'single_user',
  160. 'resource_management' => array (
  161. 'special_query_limit' => 50000,
  162. 'special_query_modules' => array('Reports', 'Export', 'Import', 'Administration', 'Sync'),
  163. 'default_limit' => 1000,
  164. ),
  165. 'require_accounts' => empty($requireAccounts) ? true : $requireAccounts,
  166. 'rss_cache_time' => empty($RSS_CACHE_TIME) ? '10800' : $RSS_CACHE_TIME,
  167. 'session_dir' => $session_dir, // this must be set!!
  168. 'site_url' => empty($site_URL) ? $site_url : $site_URL, // this must be set!!
  169. 'showDetailData' => true, // if true, read-only ACL fields will still appear on EditViews as non-editable
  170. 'showThemePicker' => true,
  171. 'sugar_version' => empty($sugar_version) ? 'unknown' : $sugar_version,
  172. 'time_formats' => empty($timeFormats) ? array (
  173. 'H:i'=>'23:00', 'h:ia'=>'11:00 pm', 'h:iA'=>'11:00PM',
  174. 'H.i'=>'23.00', 'h.ia'=>'11.00 pm', 'h.iA'=>'11.00PM' ) : $timeFormats,
  175. 'tmp_dir' => $tmp_dir, // this must be set!!
  176. 'translation_string_prefix' => empty($translation_string_prefix) ? false : $translation_string_prefix,
  177. 'unique_key' => empty($unique_key) ? md5(create_guid()) : $unique_key,
  178. 'upload_badext' => empty($upload_badext) ? array (
  179. 'php', 'php3', 'php4', 'php5', 'pl', 'cgi', 'py',
  180. 'asp', 'cfm', 'js', 'vbs', 'html', 'htm' ) : $upload_badext,
  181. 'upload_dir' => $upload_dir, // this must be set!!
  182. 'upload_maxsize' => empty($upload_maxsize) ? 30000000 : $upload_maxsize,
  183. 'import_max_execution_time' => empty($import_max_execution_time) ? 3600 : $import_max_execution_time,
  184. 'lock_homepage' => false,
  185. 'lock_subpanels' => false,
  186. 'max_dashlets_homepage' => 15,
  187. 'dashlet_display_row_options' => array('1','3','5','10'),
  188. 'default_max_tabs' => empty($max_tabs) ? '7' : $max_tabs,
  189. 'default_subpanel_tabs' => empty($subpanel_tabs) ? true : $subpanel_tabs,
  190. 'default_subpanel_links' => empty($subpanel_links) ? false : $subpanel_links,
  191. 'default_swap_last_viewed' => empty($swap_last_viewed) ? false : $swap_last_viewed,
  192. 'default_swap_shortcuts' => empty($swap_shortcuts) ? false : $swap_shortcuts,
  193. 'default_navigation_paradigm' => empty($navigation_paradigm) ? 'gm' : $navigation_paradigm,
  194. 'default_call_status' => 'Planned',
  195. 'js_lang_version' => 1,
  196. 'passwordsetting' => empty($passwordsetting) ? array (
  197. 'SystemGeneratedPasswordON' => '',
  198. 'generatepasswordtmpl' => '',
  199. 'lostpasswordtmpl' => '',
  200. 'forgotpasswordON' => true,
  201. 'linkexpiration' => '1',
  202. 'linkexpirationtime' => '30',
  203. 'linkexpirationtype' => '1',
  204. 'systexpiration' => '0',
  205. 'systexpirationtime' => '',
  206. 'systexpirationtype' => '0',
  207. 'systexpirationlogin' => '',
  208. ) : $passwordsetting,
  209. 'use_sprites' => function_exists('imagecreatetruecolor'),
  210. 'search_wildcard_infront' => false,
  211. 'search_wildcard_char' => '%',
  212. 'jobs' => array(
  213. 'min_retry_interval' => 60, // minimal job retry delay
  214. 'max_retries' => 5, // how many times to retry the job
  215. 'timeout' => 86400, // how long a job may spend as running before being force-failed
  216. 'soft_lifetime' => 7, // how many days until job record will be soft deleted after completion
  217. 'hard_lifetime' => 21, // how many days until job record will be purged from DB
  218. ),
  219. "cron" => array(
  220. 'max_cron_jobs' => 10, // max jobs per cron schedule run
  221. 'max_cron_runtime' => 60, // max runtime for cron jobs
  222. 'min_cron_interval' => 30, // minimal interval between cron jobs
  223. ),
  224. );
  225. }
  226. function get_sugar_config_defaults() {
  227. global $locale;
  228. /**
  229. * used for getting base values for array style config.php. used by the
  230. * installer and to fill in new entries on upgrades. see also:
  231. * sugar_config_union
  232. */
  233. $sugar_config_defaults = array (
  234. 'admin_export_only' => false,
  235. 'export_delimiter' => ',',
  236. 'export_excel_compatible' => false,
  237. 'cache_dir' => 'cache/',
  238. 'calculate_response_time' => true,
  239. 'create_default_user' => false,
  240. 'chartEngine' => 'Jit',
  241. 'date_formats' => array (
  242. 'Y-m-d' => '2010-12-23', 'm-d-Y' => '12-23-2010', 'd-m-Y' => '23-12-2010',
  243. 'Y/m/d' => '2010/12/23', 'm/d/Y' => '12/23/2010', 'd/m/Y' => '23/12/2010',
  244. 'Y.m.d' => '2010.12.23', 'd.m.Y' => '23.12.2010', 'm.d.Y' => '12.23.2010',),
  245. 'name_formats' => array (
  246. 's f l' => 's f l', 'f l' => 'f l', 's l' => 's l', 'l, s f' => 'l, s f',
  247. 'l, f' => 'l, f', 's l, f' => 's l, f', 'l s f' => 'l s f', 'l f s' => 'l f s'
  248. ),
  249. 'dbconfigoption' => array (
  250. 'persistent' => true,
  251. 'autofree' => false,
  252. 'debug' => 0,
  253. 'ssl' => false ),
  254. 'default_action' => 'index',
  255. 'default_charset' => return_session_value_or_default('default_charset',
  256. 'UTF-8'),
  257. 'default_currency_name' => return_session_value_or_default('default_currency_name', 'US Dollar'),
  258. 'default_currency_symbol' => return_session_value_or_default('default_currency_symbol', '$'),
  259. 'default_currency_iso4217' => return_session_value_or_default('default_currency_iso4217', 'USD'),
  260. 'default_currency_significant_digits' => return_session_value_or_default('default_currency_significant_digits', 2),
  261. 'default_number_grouping_seperator' => return_session_value_or_default('default_number_grouping_seperator', ','),
  262. 'default_decimal_seperator' => return_session_value_or_default('default_decimal_seperator', '.'),
  263. 'default_date_format' => 'm/d/Y',
  264. 'default_locale_name_format' => 's f l',
  265. 'default_export_charset' => 'UTF-8',
  266. 'default_language' => return_session_value_or_default('default_language',
  267. 'en_us'),
  268. 'default_module' => 'Home',
  269. 'default_password' => '',
  270. 'default_permissions' => array (
  271. 'dir_mode' => 02770,
  272. 'file_mode' => 0660,
  273. 'user' => '',
  274. 'group' => '',
  275. ),
  276. 'default_theme' => return_session_value_or_default('site_default_theme', 'Sugar5'),
  277. 'default_time_format' => 'h:ia',
  278. 'default_user_is_admin' => false,
  279. 'default_user_name' => '',
  280. 'disable_export' => false,
  281. 'disable_persistent_connections' =>
  282. return_session_value_or_default('disable_persistent_connections',
  283. 'false'),
  284. 'display_email_template_variable_chooser' => false,
  285. 'display_inbound_email_buttons' => false,
  286. 'dump_slow_queries' => false,
  287. 'email_address_separator' => ',', // use RFC2368 spec unless we have a noncompliant email client
  288. 'email_default_editor' => 'html',
  289. 'email_default_client' => 'sugar',
  290. 'email_default_delete_attachments' => true,
  291. 'history_max_viewed' => 50,
  292. 'installer_locked' => true,
  293. 'import_max_records_per_file' => 100,
  294. 'import_max_records_total_limit' => '',
  295. 'languages' => array('en_us' => 'English (US)'),
  296. 'large_scale_test' => false,
  297. 'list_max_entries_per_page' => 20,
  298. 'list_max_entries_per_subpanel' => 10,
  299. 'lock_default_user_name' => false,
  300. 'log_memory_usage' => false,
  301. 'portal_view' => 'single_user',
  302. 'resource_management' => array (
  303. 'special_query_limit' => 50000,
  304. 'special_query_modules' => array('Reports', 'Export', 'Import', 'Administration', 'Sync'),
  305. 'default_limit' => 1000,
  306. ),
  307. 'require_accounts' => true,
  308. 'rss_cache_time' => return_session_value_or_default('rss_cache_time',
  309. '10800'),
  310. 'save_query' => 'all',
  311. 'showDetailData' => true, // if true, read-only ACL fields will still appear on EditViews as non-editable
  312. 'showThemePicker' => true,
  313. 'slow_query_time_msec' => '100',
  314. 'sugarbeet' => true,
  315. 'time_formats' => array (
  316. 'H:i'=>'23:00', 'h:ia'=>'11:00pm', 'h:iA'=>'11:00PM', 'h:i a'=>'11:00 pm', 'h:i A'=>'11:00 PM',
  317. 'H.i'=>'23.00', 'h.ia'=>'11.00pm', 'h.iA'=>'11.00PM', 'h.i a'=>'11.00 pm', 'h.i A'=>'11.00 PM' ),
  318. 'tracker_max_display_length' => 15,
  319. 'translation_string_prefix' =>
  320. return_session_value_or_default('translation_string_prefix', false),
  321. 'upload_badext' => array (
  322. 'php', 'php3', 'php4', 'php5', 'pl', 'cgi', 'py',
  323. 'asp', 'cfm', 'js', 'vbs', 'html', 'htm' ),
  324. 'upload_maxsize' => 30000000,
  325. 'import_max_execution_time' => 3600,
  326. // 'use_php_code_json' => returnPhpJsonStatus(),
  327. 'verify_client_ip' => true,
  328. 'js_custom_version' => '',
  329. 'js_lang_version' => 1,
  330. 'lead_conv_activity_opt' => 'donothing',
  331. 'default_number_grouping_seperator' => ',',
  332. 'default_decimal_seperator' => '.',
  333. 'lock_homepage' => false,
  334. 'lock_subpanels' => false,
  335. 'max_dashlets_homepage' => '15',
  336. 'default_max_tabs' => '7',
  337. 'dashlet_display_row_options' => array('1','3','5','10'),
  338. 'default_subpanel_tabs' => true,
  339. 'default_subpanel_links' => false,
  340. 'default_swap_last_viewed' => false,
  341. 'default_swap_shortcuts' => false,
  342. 'default_navigation_paradigm' => 'gm',
  343. 'admin_access_control' => false,
  344. 'use_common_ml_dir' => false,
  345. 'common_ml_dir' => '',
  346. 'vcal_time' => '2',
  347. 'calendar' => array(
  348. 'default_view' => 'week',
  349. 'show_calls_by_default' => true,
  350. 'show_tasks_by_default' => true,
  351. 'show_completed_by_default' => true,
  352. 'editview_width' => 990,
  353. 'editview_height' => 485,
  354. 'day_timestep' => 15,
  355. 'week_timestep' => 30,
  356. 'items_draggable' => true,
  357. 'items_resizable' => true,
  358. 'enable_repeat' => true,
  359. 'max_repeat_count' => 1000,
  360. ),
  361. 'passwordsetting' => empty($passwordsetting) ? array (
  362. 'SystemGeneratedPasswordON' => '',
  363. 'generatepasswordtmpl' => '',
  364. 'lostpasswordtmpl' => '',
  365. 'forgotpasswordON' => false,
  366. 'linkexpiration' => '1',
  367. 'linkexpirationtime' => '30',
  368. 'linkexpirationtype' => '1',
  369. 'systexpiration' => '0',
  370. 'systexpirationtime' => '',
  371. 'systexpirationtype' => '0',
  372. 'systexpirationlogin' => '',
  373. ) : $passwordsetting,
  374. 'use_real_names' => true,
  375. 'search_wildcard_infront' => false,
  376. 'search_wildcard_char' => '%',
  377. 'jobs' => array(
  378. 'min_retry_interval' => 30, // 30 seconds minimal job retry
  379. 'max_retries' => 5, // how many times to retry the job
  380. 'timeout' => 86400, // how long a job may spend as running before being force-failed
  381. ),
  382. "cron" => array(
  383. 'max_cron_jobs' => 10, // max jobs per cron schedule run
  384. 'max_cron_runtime' => 30, // max runtime for cron jobs
  385. 'min_cron_interval' => 30, // minimal interval between cron jobs
  386. ),
  387. );
  388. if(!is_object($locale)) {
  389. $locale = new Localization();
  390. }
  391. $sugar_config_defaults['default_currencies'] = $locale->getDefaultCurrencies();
  392. $sugar_config_defaults = sugarArrayMerge($locale->getLocaleConfigDefaults(), $sugar_config_defaults);
  393. return( $sugar_config_defaults );
  394. }
  395. /**
  396. * @deprecated use SugarView::getMenu() instead
  397. */
  398. function load_menu($path){
  399. global $module_menu;
  400. if(file_exists($path . 'Menu.php'))
  401. {
  402. require($path . 'Menu.php');
  403. }
  404. if(file_exists('custom/' . $path . 'Ext/Menus/menu.ext.php'))
  405. {
  406. require('custom/' . $path . 'Ext/Menus/menu.ext.php');
  407. }
  408. if(file_exists('custom/application/Ext/Menus/menu.ext.php'))
  409. {
  410. require('custom/application/Ext/Menus/menu.ext.php');
  411. }
  412. return $module_menu;
  413. }
  414. /**
  415. * get_notify_template_file
  416. * This function will return the location of the email notifications template to use
  417. *
  418. * @return string relative file path to email notifications template file
  419. */
  420. function get_notify_template_file($language){
  421. /*
  422. * Order of operation:
  423. * 1) custom version of specified language
  424. * 2) stock version of specified language
  425. * 3) custom version of en_us template
  426. * 4) stock en_us template
  427. */
  428. // set $file to the base code template so it's set if none of the conditions pass
  429. $file = "include/language/en_us.notify_template.html";
  430. if(file_exists("custom/include/language/{$language}.notify_template.html")){
  431. $file = "custom/include/language/{$language}.notify_template.html";
  432. }
  433. else if(file_exists("include/language/{$language}.notify_template.html")){
  434. $file = "include/language/{$language}.notify_template.html";
  435. }
  436. else if(file_exists("custom/include/language/en_us.notify_template.html")){
  437. $file = "custom/include/language/en_us.notify_template.html";
  438. }
  439. return $file;
  440. }
  441. function sugar_config_union( $default, $override ){
  442. // a little different then array_merge and array_merge_recursive. we want
  443. // the second array to override the first array if the same value exists,
  444. // otherwise merge the unique keys. it handles arrays of arrays recursively
  445. // might be suitable for a generic array_union
  446. if( !is_array( $override ) ){
  447. $override = array();
  448. }
  449. foreach( $default as $key => $value ){
  450. if( !array_key_exists($key, $override) ){
  451. $override[$key] = $value;
  452. }
  453. else if( is_array( $key ) ){
  454. $override[$key] = sugar_config_union( $value, $override[$key] );
  455. }
  456. }
  457. return( $override );
  458. }
  459. function make_not_writable( $file ){
  460. // Returns true if the given file/dir has been made not writable
  461. $ret_val = false;
  462. if( is_file($file) || is_dir($file) ){
  463. if( !is_writable($file) ){
  464. $ret_val = true;
  465. }
  466. else {
  467. $original_fileperms = fileperms($file);
  468. // take away writable permissions
  469. $new_fileperms = $original_fileperms & ~0x0092;
  470. @sugar_chmod($file, $new_fileperms);
  471. if( !is_writable($file) ){
  472. $ret_val = true;
  473. }
  474. }
  475. }
  476. return $ret_val;
  477. }
  478. /** This function returns the name of the person.
  479. * It currently returns "first last". It should not put the space if either name is not available.
  480. * It should not return errors if either name is not available.
  481. * If no names are present, it will return ""
  482. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  483. * All Rights Reserved.
  484. * Contributor(s): ______________________________________..
  485. */
  486. function return_name($row, $first_column, $last_column)
  487. {
  488. $first_name = "";
  489. $last_name = "";
  490. $full_name = "";
  491. if(isset($row[$first_column]))
  492. {
  493. $first_name = stripslashes($row[$first_column]);
  494. }
  495. if(isset($row[$last_column]))
  496. {
  497. $last_name = stripslashes($row[$last_column]);
  498. }
  499. $full_name = $first_name;
  500. // If we have a first name and we have a last name
  501. if($full_name != "" && $last_name != "")
  502. {
  503. // append a space, then the last name
  504. $full_name .= " ".$last_name;
  505. }
  506. // If we have no first name, but we have a last name
  507. else if($last_name != "")
  508. {
  509. // append the last name without the space.
  510. $full_name .= $last_name;
  511. }
  512. return $full_name;
  513. }
  514. function get_languages()
  515. {
  516. global $sugar_config;
  517. $lang = $sugar_config['languages'];
  518. if(!empty($sugar_config['disabled_languages'])){
  519. foreach(explode(',', $sugar_config['disabled_languages']) as $disable) {
  520. unset($lang[$disable]);
  521. }
  522. }
  523. return $lang;
  524. }
  525. function get_all_languages()
  526. {
  527. global $sugar_config;
  528. return $sugar_config['languages'];
  529. }
  530. function get_language_display($key)
  531. {
  532. global $sugar_config;
  533. return $sugar_config['languages'][$key];
  534. }
  535. function get_assigned_user_name($assigned_user_id, $is_group = '') {
  536. static $saved_user_list = null;
  537. if(empty($saved_user_list)) {
  538. $saved_user_list = get_user_array(false, '', '', false, null, $is_group);
  539. }
  540. if(isset($saved_user_list[$assigned_user_id])) {
  541. return $saved_user_list[$assigned_user_id];
  542. }
  543. return '';
  544. }
  545. /**
  546. * retrieves the user_name column value (login)
  547. * @param string id GUID of user
  548. * @return string
  549. */
  550. function get_user_name($id) {
  551. global $db;
  552. if(empty($db))
  553. $db = DBManagerFactory::getInstance();
  554. $q = "SELECT user_name FROM users WHERE id='{$id}'";
  555. $r = $db->query($q);
  556. $a = $db->fetchByAssoc($r);
  557. return (empty($a)) ? '' : $a['user_name'];
  558. }
  559. //TODO Update to use global cache
  560. /**
  561. * get_user_array
  562. *
  563. * This is a helper function to return an Array of users depending on the parameters passed into the function.
  564. * This function uses the get_register_value function by default to use a caching layer where supported.
  565. * This function has been updated return the array sorted by user preference of name display (bug 62712)
  566. *
  567. * @param bool $add_blank Boolean value to add a blank entry to the array results, true by default
  568. * @param string $status String value indicating the status to filter users by, "Active" by default
  569. * @param string $user_id String value to specify a particular user id value (searches the id column of users table), blank by default
  570. * @param bool $use_real_name Boolean value indicating whether or not results should include the full name or just user_name, false by default
  571. * @param String $user_name_filter String value indicating the user_name filter (searches the user_name column of users table) to optionally search with, blank by default
  572. * @param string $portal_filter String query filter for portal users (defaults to searching non-portal users), change to blank if you wish to search for all users including portal users
  573. * @param bool $from_cache Boolean value indicating whether or not to use the get_register_value function for caching, true by default
  574. * @return array Array of users matching the filter criteria that may be from cache (if similar search was previously run)
  575. */
  576. function get_user_array($add_blank=true, $status="Active", $user_id='', $use_real_name=false, $user_name_filter='', $portal_filter=' AND portal_only=0 ', $from_cache = true) {
  577. global $locale, $sugar_config, $current_user;
  578. if(empty($locale)) {
  579. $locale = new Localization();
  580. }
  581. if($from_cache) {
  582. $key_name = $add_blank. $status . $user_id . $use_real_name . $user_name_filter . $portal_filter;
  583. $user_array = get_register_value('user_array', $key_name);
  584. }
  585. if(empty($user_array)) {
  586. $db = DBManagerFactory::getInstance();
  587. $temp_result = Array();
  588. // Including deleted users for now.
  589. if (empty($status)) {
  590. $query = "SELECT id, first_name, last_name, user_name from users WHERE 1=1".$portal_filter;
  591. }
  592. else {
  593. $query = "SELECT id, first_name, last_name, user_name from users WHERE status='$status'".$portal_filter;
  594. }
  595. /* BEGIN - SECURITY GROUPS */
  596. global $current_user, $sugar_config;
  597. if(!is_admin($current_user)
  598. && isset($sugar_config['securitysuite_filter_user_list'])
  599. && $sugar_config['securitysuite_filter_user_list'] == true
  600. && (empty($_REQUEST['module']) || $_REQUEST['module'] != 'Home')
  601. && (empty($_REQUEST['action']) || $_REQUEST['action'] != 'DynamicAction')
  602. ) {
  603. require_once('modules/SecurityGroups/SecurityGroup.php');
  604. global $current_user;
  605. $group_where = SecurityGroup::getGroupUsersWhere($current_user->id);
  606. $query .= " AND (".$group_where.") ";
  607. }
  608. /* END - SECURITY GROUPS */
  609. if (!empty($user_name_filter)) {
  610. $user_name_filter = $db->quote($user_name_filter);
  611. $query .= " AND user_name LIKE '$user_name_filter%' ";
  612. }
  613. if (!empty($user_id)) {
  614. $query .= " OR id='{$user_id}'";
  615. }
  616. //get the user preference for name formatting, to be used in order by
  617. $order_by_string =' user_name ASC ';
  618. if(!empty($current_user) && !empty($current_user->id))
  619. {
  620. $formatString = $current_user->getPreference('default_locale_name_format');
  621. //create the order by string based on position of first and last name in format string
  622. $order_by_string =' user_name ASC ';
  623. $firstNamePos = strpos( $formatString, 'f');
  624. $lastNamePos = strpos( $formatString, 'l');
  625. if($firstNamePos !== false || $lastNamePos !== false){
  626. //its possible for first name to be skipped, check for this
  627. if($firstNamePos===false){
  628. $order_by_string = 'last_name ASC';
  629. }else{
  630. $order_by_string = ($lastNamePos < $firstNamePos) ? "last_name, first_name ASC" : "first_name, last_name ASC";
  631. }
  632. }
  633. }
  634. $query = $query.' ORDER BY '.$order_by_string;
  635. $GLOBALS['log']->debug("get_user_array query: $query");
  636. $result = $db->query($query, true, "Error filling in user array: ");
  637. if ($add_blank==true) {
  638. // Add in a blank row
  639. $temp_result[''] = '';
  640. }
  641. // Get the id and the name.
  642. while($row = $db->fetchByAssoc($result)) {
  643. if($use_real_name == true || showFullName()) {
  644. if(isset($row['last_name'])) { // cn: we will ALWAYS have both first_name and last_name (empty value if blank in db)
  645. $temp_result[$row['id']] = $locale->getLocaleFormattedName($row['first_name'],$row['last_name']);
  646. } else {
  647. $temp_result[$row['id']] = $row['user_name'];
  648. }
  649. } else {
  650. $temp_result[$row['id']] = $row['user_name'];
  651. }
  652. }
  653. $user_array = $temp_result;
  654. if($from_cache)
  655. {
  656. set_register_value('user_array', $key_name, $temp_result);
  657. }
  658. }
  659. return $user_array;
  660. }
  661. /**
  662. * uses a different query to return a list of users than get_user_array()
  663. * Used from QuickSearch.php
  664. * @param args string where clause entry
  665. * @return array Array of Users' details that match passed criteria
  666. */
  667. function getUserArrayFromFullName($args, $hide_portal_users = false) {
  668. global $locale;
  669. $db = DBManagerFactory::getInstance();
  670. // jmorais@dri - Bug #51411
  671. //
  672. // Refactor the code responsible for parsing supplied $args, this way we
  673. // ensure that if $args has at least one space (after trim), the $inClause
  674. // will be composed by several clauses ($inClauses) inside parenthesis.
  675. //
  676. // Ensuring that operator precedence is respected, and avoiding
  677. // inactive/deleted users to be retrieved.
  678. //
  679. $args = trim($args);
  680. if (strpos($args, ' ')) {
  681. $inClauses = array();
  682. $argArray = explode(' ', $args);
  683. foreach ($argArray as $arg) {
  684. $arg = $db->quote($arg);
  685. $inClauses[] = "(first_name LIKE '{$arg}%' OR last_name LIKE '{$arg}%')";
  686. }
  687. $inClause = '(' . implode('OR ', $inClauses) . ')';
  688. } else {
  689. $args = $db->quote($args);
  690. $inClause = "(first_name LIKE '{$args}%' OR last_name LIKE '{$args}%')";
  691. }
  692. // ~jmorais@dri
  693. $query = "SELECT id, first_name, last_name, user_name FROM users WHERE status='Active' AND deleted=0 AND ";
  694. if ( $hide_portal_users ) {
  695. $query .= " portal_only=0 AND ";
  696. }
  697. $query .= $inClause;
  698. /* BEGIN - SECURITY GROUPS */
  699. global $current_user, $sugar_config;
  700. if(!is_admin($current_user)
  701. && isset($sugar_config['securitysuite_filter_user_list'])
  702. && $sugar_config['securitysuite_filter_user_list'] == true
  703. ) {
  704. require_once('modules/SecurityGroups/SecurityGroup.php');
  705. global $current_user;
  706. $group_where = SecurityGroup::getGroupUsersWhere($current_user->id);
  707. $query .= " AND (".$group_where.") ";
  708. }
  709. /* END - SECURITY GROUPS */
  710. $query .= " ORDER BY last_name ASC";
  711. $r = $db->query($query);
  712. $ret = array();
  713. while($a = $db->fetchByAssoc($r)) {
  714. $ret[$a['id']] = $locale->getLocaleFormattedName($a['first_name'], $a['last_name']);
  715. }
  716. return $ret;
  717. }
  718. /**
  719. *
  720. * based on user pref then system pref
  721. */
  722. function showFullName() {
  723. global $sugar_config;
  724. global $current_user;
  725. static $showFullName = null;
  726. if (is_null($showFullName)) {
  727. $sysPref = !empty($sugar_config['use_real_names']);
  728. $userPref = (is_object($current_user)) ? $current_user->getPreference('use_real_names') : null;
  729. if($userPref != null) {
  730. $showFullName = ($userPref == 'on');
  731. } else {
  732. $showFullName = $sysPref;
  733. }
  734. }
  735. return $showFullName;
  736. }
  737. function clean($string, $maxLength)
  738. {
  739. $string = substr($string, 0, $maxLength);
  740. return escapeshellcmd($string);
  741. }
  742. /**
  743. * Copy the specified request variable to the member variable of the specified object.
  744. * Do no copy if the member variable is already set.
  745. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  746. * All Rights Reserved.
  747. * Contributor(s): ______________________________________..
  748. */
  749. function safe_map($request_var, & $focus, $always_copy = false)
  750. {
  751. safe_map_named($request_var, $focus, $request_var, $always_copy);
  752. }
  753. /**
  754. * Copy the specified request variable to the member variable of the specified object.
  755. * Do no copy if the member variable is already set.
  756. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  757. * All Rights Reserved.
  758. * Contributor(s): ______________________________________..
  759. */
  760. function safe_map_named($request_var, & $focus, $member_var, $always_copy)
  761. {
  762. if (isset($_REQUEST[$request_var]) && ($always_copy || is_null($focus->$member_var))) {
  763. $GLOBALS['log']->debug("safe map named called assigning '{$_REQUEST[$request_var]}' to $member_var");
  764. $focus->$member_var = $_REQUEST[$request_var];
  765. }
  766. }
  767. /**
  768. * This function retrieves an application language file and returns the array of strings included in the $app_list_strings var.
  769. *
  770. * @param string $language specific language to load
  771. * @return array lang strings
  772. */
  773. function return_app_list_strings_language($language)
  774. {
  775. global $app_list_strings;
  776. global $sugar_config;
  777. $cache_key = 'app_list_strings.'.$language;
  778. // Check for cached value
  779. $cache_entry = sugar_cache_retrieve($cache_key);
  780. if(!empty($cache_entry))
  781. {
  782. return $cache_entry;
  783. }
  784. $default_language = $sugar_config['default_language'];
  785. $temp_app_list_strings = $app_list_strings;
  786. $langs = array();
  787. if ($language != 'en_us') {
  788. $langs[] = 'en_us';
  789. }
  790. if ($default_language != 'en_us' && $language != $default_language) {
  791. $langs[] = $default_language;
  792. }
  793. $langs[] = $language;
  794. $app_list_strings_array = array();
  795. foreach ( $langs as $lang ) {
  796. $app_list_strings = array();
  797. if(file_exists("include/language/$lang.lang.php")) {
  798. include("include/language/$lang.lang.php");
  799. $GLOBALS['log']->info("Found language file: $lang.lang.php");
  800. }
  801. if(file_exists("include/language/$lang.lang.override.php")) {
  802. include("include/language/$lang.lang.override.php");
  803. $GLOBALS['log']->info("Found override language file: $lang.lang.override.php");
  804. }
  805. if(file_exists("include/language/$lang.lang.php.override")) {
  806. include("include/language/$lang.lang.php.override");
  807. $GLOBALS['log']->info("Found override language file: $lang.lang.php.override");
  808. }
  809. $app_list_strings_array[] = $app_list_strings;
  810. }
  811. $app_list_strings = array();
  812. foreach ( $app_list_strings_array as $app_list_strings_item ) {
  813. $app_list_strings = sugarLangArrayMerge($app_list_strings, $app_list_strings_item);
  814. }
  815. foreach ( $langs as $lang ) {
  816. if(file_exists("custom/application/Ext/Language/$lang.lang.ext.php")) {
  817. $app_list_strings = _mergeCustomAppListStrings("custom/application/Ext/Language/$lang.lang.ext.php" , $app_list_strings);
  818. $GLOBALS['log']->info("Found extended language file: $lang.lang.ext.php");
  819. }
  820. if(file_exists("custom/include/language/$lang.lang.php")) {
  821. include("custom/include/language/$lang.lang.php");
  822. $GLOBALS['log']->info("Found custom language file: $lang.lang.php");
  823. }
  824. }
  825. if(!isset($app_list_strings)) {
  826. $GLOBALS['log']->fatal("Unable to load the application language file for the selected language ($language) or the default language ($default_language) or the en_us language");
  827. return null;
  828. }
  829. $return_value = $app_list_strings;
  830. $app_list_strings = $temp_app_list_strings;
  831. sugar_cache_put($cache_key, $return_value);
  832. return $return_value;
  833. }
  834. /**
  835. * The dropdown items in custom language files is $app_list_strings['$key']['$second_key'] = $value not
  836. * $GLOBALS['app_list_strings']['$key'] = $value, so we have to delete the original ones in app_list_strings and relace it with the custom ones.
  837. * @param file string the language that you want include,
  838. * @param app_list_strings array the golbal strings
  839. * @return array
  840. */
  841. //jchi 25347
  842. function _mergeCustomAppListStrings($file , $app_list_strings){
  843. $app_list_strings_original = $app_list_strings;
  844. unset($app_list_strings);
  845. // FG - bug 45525 - $exemptDropdown array is defined (once) here, not inside the foreach
  846. // This way, language file can add items to save specific standard codelist from being overwritten
  847. $exemptDropdowns = array();
  848. include($file);
  849. if(!isset($app_list_strings) || !is_array($app_list_strings)){
  850. return $app_list_strings_original;
  851. }
  852. //Bug 25347: We should not merge custom dropdown fields unless they relate to parent fields or the module list.
  853. // FG - bug 45525 - Specific codelists must NOT be overwritten
  854. $exemptDropdowns[] = "moduleList";
  855. $exemptDropdowns[] = "moduleListSingular";
  856. $exemptDropdowns = array_merge($exemptDropdowns, getTypeDisplayList());
  857. foreach($app_list_strings as $key=>$value)
  858. {
  859. if (!in_array($key, $exemptDropdowns) && array_key_exists($key, $app_list_strings_original))
  860. {
  861. unset($app_list_strings_original["$key"]);
  862. }
  863. }
  864. $app_list_strings = sugarArrayMergeRecursive($app_list_strings_original , $app_list_strings);
  865. return $app_list_strings;
  866. }
  867. /**
  868. * This function retrieves an application language file and returns the array of strings included.
  869. *
  870. * @param string $language specific language to load
  871. * @return array lang strings
  872. */
  873. function return_application_language($language)
  874. {
  875. global $app_strings, $sugar_config;
  876. $cache_key = 'app_strings.'.$language;
  877. // Check for cached value
  878. $cache_entry = sugar_cache_retrieve($cache_key);
  879. if(!empty($cache_entry))
  880. {
  881. return $cache_entry;
  882. }
  883. $temp_app_strings = $app_strings;
  884. $default_language = $sugar_config['default_language'];
  885. $langs = array();
  886. if ($language != 'en_us') {
  887. $langs[] = 'en_us';
  888. }
  889. if ($default_language != 'en_us' && $language != $default_language) {
  890. $langs[] = $default_language;
  891. }
  892. $langs[] = $language;
  893. $app_strings_array = array();
  894. foreach ( $langs as $lang ) {
  895. $app_strings = array();
  896. if(file_exists("include/language/$lang.lang.php")) {
  897. include("include/language/$lang.lang.php");
  898. $GLOBALS['log']->info("Found language file: $lang.lang.php");
  899. }
  900. if(file_exists("include/language/$lang.lang.override.php")) {
  901. include("include/language/$lang.lang.override.php");
  902. $GLOBALS['log']->info("Found override language file: $lang.lang.override.php");
  903. }
  904. if(file_exists("include/language/$lang.lang.php.override")) {
  905. include("include/language/$lang.lang.php.override");
  906. $GLOBALS['log']->info("Found override language file: $lang.lang.php.override");
  907. }
  908. if(file_exists("custom/application/Ext/Language/$lang.lang.ext.php")) {
  909. include("custom/application/Ext/Language/$lang.lang.ext.php");
  910. $GLOBALS['log']->info("Found extended language file: $lang.lang.ext.php");
  911. }
  912. if(file_exists("custom/include/language/$lang.lang.php")) {
  913. include("custom/include/language/$lang.lang.php");
  914. $GLOBALS['log']->info("Found custom language file: $lang.lang.php");
  915. }
  916. $app_strings_array[] = $app_strings;
  917. }
  918. $app_strings = array();
  919. foreach ( $app_strings_array as $app_strings_item ) {
  920. $app_strings = sugarLangArrayMerge($app_strings, $app_strings_item);
  921. }
  922. if(!isset($app_strings)) {
  923. $GLOBALS['log']->fatal("Unable to load the application language strings");
  924. return null;
  925. }
  926. // If we are in debug mode for translating, turn on the prefix now!
  927. if(!empty($sugar_config['translation_string_prefix']))
  928. {
  929. foreach($app_strings as $entry_key=>$entry_value) {
  930. $app_strings[$entry_key] = $language.' '.$entry_value;
  931. }
  932. }
  933. if(isset($_SESSION['show_deleted'])) {
  934. $app_strings['LBL_DELETE_BUTTON'] = $app_strings['LBL_UNDELETE_BUTTON'];
  935. $app_strings['LBL_DELETE_BUTTON_LABEL'] = $app_strings['LBL_UNDELETE_BUTTON_LABEL'];
  936. $app_strings['LBL_DELETE_BUTTON_TITLE'] = $app_strings['LBL_UNDELETE_BUTTON_TITLE'];
  937. $app_strings['LBL_DELETE'] = $app_strings['LBL_UNDELETE'];
  938. }
  939. $app_strings['LBL_ALT_HOT_KEY'] = get_alt_hot_key();
  940. $return_value = $app_strings;
  941. $app_strings = $temp_app_strings;
  942. sugar_cache_put($cache_key, $return_value);
  943. return $return_value;
  944. }
  945. /**
  946. * This function retrieves a module's language file and returns the array of strings included.
  947. *
  948. * @param string $language specific language to load
  949. * @param string $module module name to load strings for
  950. * @param bool $refresh optional, true if you want to rebuild the language strings
  951. * @return array lang strings
  952. */
  953. function return_module_language($language, $module, $refresh=false)
  954. {
  955. global $mod_strings;
  956. global $sugar_config;
  957. global $currentModule;
  958. // Jenny - Bug 8119: Need to check if $module is not empty
  959. if (empty($module)) {
  960. $stack = debug_backtrace();
  961. $GLOBALS['log']->warn("Variable module is not in return_module_language ". var_export($stack, true));
  962. return array();
  963. }
  964. if( !$refresh )
  965. {
  966. $cache_key = LanguageManager::getLanguageCacheKey($module, $language);
  967. // Check for cached value
  968. $cache_entry = sugar_cache_retrieve($cache_key);
  969. if(!empty($cache_entry) && is_array($cache_entry))
  970. {
  971. return $cache_entry;
  972. }
  973. }
  974. // Store the current mod strings for later
  975. $temp_mod_strings = $mod_strings;
  976. $loaded_mod_strings = array();
  977. $language_used = $language;
  978. $default_language = $sugar_config['default_language'];
  979. if(empty($language)) {
  980. $language = $default_language;
  981. }
  982. // Bug 21559 - So we can get all the strings defined in the template, refresh
  983. // the vardefs file if the cached language file doesn't exist.
  984. if(!file_exists(sugar_cached('modules/'). $module . '/language/'.$language.'.lang.php')
  985. && !empty($GLOBALS['beanList'][$module])){
  986. $object = BeanFactory::getObjectName($module);
  987. VardefManager::refreshVardefs($module,$object);
  988. }
  989. $loaded_mod_strings = LanguageManager::loadModuleLanguage($module, $language,$refresh);
  990. // cn: bug 6048 - merge en_us with requested language
  991. if($language != $sugar_config['default_language'])
  992. $loaded_mod_strings = sugarLangArrayMerge(
  993. LanguageManager::loadModuleLanguage($module, $sugar_config['default_language'],$refresh),
  994. $loaded_mod_strings
  995. );
  996. // Load in en_us strings by default
  997. if($language != 'en_us' && $sugar_config['default_language'] != 'en_us')
  998. $loaded_mod_strings = sugarLangArrayMerge(
  999. LanguageManager::loadModuleLanguage($module, 'en_us', $refresh),
  1000. $loaded_mod_strings
  1001. );
  1002. // If we are in debug mode for translating, turn on the prefix now!
  1003. if($sugar_config['translation_string_prefix']) {
  1004. foreach($loaded_mod_strings as $entry_key=>$entry_value) {
  1005. $loaded_mod_strings[$entry_key] = $language_used.' '.$entry_value;
  1006. }
  1007. }
  1008. $return_value = $loaded_mod_strings;
  1009. if(!isset($mod_strings)){
  1010. $mod_strings = $return_value;
  1011. }
  1012. else
  1013. $mod_strings = $temp_mod_strings;
  1014. $cache_key = LanguageManager::getLanguageCacheKey($module, $language);
  1015. sugar_cache_put($cache_key, $return_value);
  1016. return $return_value;
  1017. }
  1018. /** This function retrieves an application language file and returns the array of strings included in the $mod_list_strings var.
  1019. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1020. * All Rights Reserved.
  1021. * Contributor(s): ______________________________________..
  1022. * If you are using the current language, do not call this function unless you are loading it for the first time */
  1023. function return_mod_list_strings_language($language,$module) {
  1024. global $mod_list_strings;
  1025. global $sugar_config;
  1026. global $currentModule;
  1027. $cache_key = "mod_list_str_lang.".$language.$module;
  1028. // Check for cached value
  1029. $cache_entry = sugar_cache_retrieve($cache_key);
  1030. if(!empty($cache_entry))
  1031. {
  1032. return $cache_entry;
  1033. }
  1034. $language_used = $language;
  1035. $temp_mod_list_strings = $mod_list_strings;
  1036. $default_language = $sugar_config['default_language'];
  1037. if($currentModule == $module && isset($mod_list_strings) && $mod_list_strings != null) {
  1038. return $mod_list_strings;
  1039. }
  1040. // cn: bug 6351 - include en_us if file langpack not available
  1041. // cn: bug 6048 - merge en_us with requested language
  1042. include("modules/$module/language/en_us.lang.php");
  1043. $en_mod_list_strings = array();
  1044. if($language_used != $default_language)
  1045. $en_mod_list_strings = $mod_list_strings;
  1046. if(file_exists("modules/$module/language/$language.lang.php")) {
  1047. include("modules/$module/language/$language.lang.php");
  1048. }
  1049. if(file_exists("modules/$module/language/$language.lang.override.php")){
  1050. include("modules/$module/language/$language.lang.override.php");
  1051. }
  1052. if(file_exists("modules/$module/language/$language.lang.php.override")){
  1053. echo 'Please Change:<br>' . "modules/$module/language/$language.lang.php.override" . '<br>to<br>' . 'Please Change:<br>' . "modules/$module/language/$language.lang.override.php";
  1054. include("modules/$module/language/$language.lang.php.override");
  1055. }
  1056. // cn: bug 6048 - merge en_us with requested language
  1057. $mod_list_strings = sugarLangArrayMerge($en_mod_list_strings, $mod_list_strings);
  1058. // if we still don't have a language pack, then log an error
  1059. if(!isset($mod_list_strings)) {
  1060. $GLOBALS['log']->fatal("Unable to load the application list language file for the selected language($language) or the default language($default_language) for module({$module})");
  1061. return null;
  1062. }
  1063. $return_value = $mod_list_strings;
  1064. $mod_list_strings = $temp_mod_list_strings;
  1065. sugar_cache_put($cache_key, $return_value);
  1066. return $return_value;
  1067. }
  1068. /** This function retrieves a theme's language file and returns the array of strings included.
  1069. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1070. * All Rights Reserved.
  1071. * Contributor(s): ______________________________________..
  1072. */
  1073. function return_theme_language($language, $theme)
  1074. {
  1075. global $mod_strings, $sugar_config, $current_language;
  1076. $language_used = $language;
  1077. $default_language = $sugar_config['default_language'];
  1078. include(SugarThemeRegistry::get($theme)->getFilePath()."/language/$current_language.lang.php");
  1079. if(file_exists(SugarThemeRegistry::get($theme)->getFilePath()."/language/$current_language.lang.override.php")){
  1080. include(SugarThemeRegistry::get($theme)->getFilePath()."/language/$current_language.lang.override.php");
  1081. }
  1082. if(file_exists(SugarThemeRegistry::get($theme)->getFilePath()."/language/$current_language.lang.php.override")){
  1083. echo 'Please Change:<br>' . SugarThemeRegistry::get($theme)->getFilePath()."/language/$current_language.lang.php.override" . '<br>to<br>' . 'Please Change:<br>' . SugarThemeRegistry::get($theme)->getFilePath()."/language/$current_language.lang.override.php";
  1084. include(SugarThemeRegistry::get($theme)->getFilePath()."/language/$current_language.lang.php.override");
  1085. }
  1086. if(!isset($theme_strings))
  1087. {
  1088. $GLOBALS['log']->warn("Unable to find the theme file for language: ".$language." and theme: ".$theme);
  1089. require(SugarThemeRegistry::get($theme)->getFilePath()."/language/$default_language.lang.php");
  1090. $language_used = $default_language;
  1091. }
  1092. if(!isset($theme_strings))
  1093. {
  1094. $GLOBALS['log']->fatal("Unable to load the theme($theme) language file for the selected language($language) or the default language($default_language)");
  1095. return null;
  1096. }
  1097. // If we are in debug mode for translating, turn on the prefix now!
  1098. if($sugar_config['translation_string_prefix'])
  1099. {
  1100. foreach($theme_strings as $entry_key=>$entry_value)
  1101. {
  1102. $theme_strings[$entry_key] = $language_used.' '.$entry_value;
  1103. }
  1104. }
  1105. return $theme_strings;
  1106. }
  1107. /** If the session variable is defined and is not equal to "" then return it. Otherwise, return the default value.
  1108. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1109. * All Rights Reserved.
  1110. * Contributor(s): ______________________________________..
  1111. */
  1112. function return_session_value_or_default($varname, $default)
  1113. {
  1114. if(isset($_SESSION[$varname]) && $_SESSION[$varname] != "")
  1115. {
  1116. return $_SESSION[$varname];
  1117. }
  1118. return $default;
  1119. }
  1120. /**
  1121. * Creates an array of where restrictions. These are used to construct a where SQL statement on the query
  1122. * It looks for the variable in the $_REQUEST array. If it is set and is not "" it will create a where clause out of it.
  1123. * @param &$where_clauses - The array to append the clause to
  1124. * @param $variable_name - The name of the variable to look for an add to the where clause if found
  1125. * @param $SQL_name - [Optional] If specified, this is the SQL column name that is used. If not specified, the $variable_name is used as the SQL_name.
  1126. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1127. * All Rights Reserved.
  1128. * Contributor(s): ______________________________________..
  1129. */
  1130. function append_where_clause(&$where_clauses, $variable_name, $SQL_name = null)
  1131. {
  1132. if($SQL_name == null)
  1133. {
  1134. $SQL_name = $variable_name;
  1135. }
  1136. if(isset($_REQUEST[$variable_name]) && $_REQUEST[$variable_name] != "")
  1137. {
  1138. array_push($where_clauses, "$SQL_name like '".$GLOBALS['db']->quote($_REQUEST[$variable_name])."%'");
  1139. }
  1140. }
  1141. /**
  1142. * Generate the appropriate SQL based on the where clauses.
  1143. * @param $where_clauses - An Array of individual where clauses stored as strings
  1144. * @returns string where_clause - The final SQL where clause to be executed.
  1145. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1146. * All Rights Reserved.
  1147. * Contributor(s): ______________________________________..
  1148. */
  1149. function generate_where_statement($where_clauses)
  1150. {
  1151. $where = "";
  1152. foreach($where_clauses as $clause)
  1153. {
  1154. if($where != "")
  1155. $where .= " and ";
  1156. $where .= $clause;
  1157. }
  1158. $GLOBALS['log']->info("Here is the where clause for the list view: $where");
  1159. return $where;
  1160. }
  1161. /**
  1162. * determines if a passed string matches the criteria for a Sugar GUID
  1163. * @param string $guid
  1164. * @return bool False on failure
  1165. */
  1166. function is_guid($guid) {
  1167. if(strlen($guid) != 36) {
  1168. return false;
  1169. }
  1170. if(preg_match("/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}/i", $guid)) {
  1171. return true;
  1172. }
  1173. return true;;
  1174. }
  1175. /**
  1176. * A temporary method of generating GUIDs of the correct format for our DB.
  1177. * @return String contianing a GUID in the format: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
  1178. *
  1179. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1180. * All Rights Reserved.
  1181. * Contributor(s): ______________________________________..
  1182. */
  1183. function create_guid()
  1184. {
  1185. $microTime = microtime();
  1186. list($a_dec, $a_sec) = explode(" ", $microTime);
  1187. $dec_hex = dechex($a_dec* 1000000);
  1188. $sec_hex = dechex($a_sec);
  1189. ensure_length($dec_hex, 5);
  1190. ensure_length($sec_hex, 6);
  1191. $guid = "";
  1192. $guid .= $dec_hex;
  1193. $guid .= create_guid_section(3);
  1194. $guid .= '-';
  1195. $guid .= create_guid_section(4);
  1196. $guid .= '-';
  1197. $guid .= create_guid_section(4);
  1198. $guid .= '-';
  1199. $guid .= create_guid_section(4);
  1200. $guid .= '-';
  1201. $guid .= $sec_hex;
  1202. $guid .= create_guid_section(6);
  1203. return $guid;
  1204. }
  1205. function create_guid_section($characters)
  1206. {
  1207. $return = "";
  1208. for($i=0; $i<$characters; $i++)
  1209. {
  1210. $return .= dechex(mt_rand(0,15));
  1211. }
  1212. return $return;
  1213. }
  1214. function ensure_length(&$string, $length)
  1215. {
  1216. $strlen = strlen($string);
  1217. if($strlen < $length)
  1218. {
  1219. $string = str_pad($string,$length,"0");
  1220. }
  1221. else if($strlen > $length)
  1222. {
  1223. $string = substr($string, 0, $length);
  1224. }
  1225. }
  1226. function microtime_diff($a, $b) {
  1227. list($a_dec, $a_sec) = explode(" ", $a);
  1228. list($b_dec, $b_sec) = explode(" ", $b);
  1229. return $b_sec - $a_sec + $b_dec - $a_dec;
  1230. }
  1231. // check if Studio is displayed.
  1232. function displayStudioForCurrentUser()
  1233. {
  1234. global $current_user;
  1235. if ( $current_user->isAdmin() ) {
  1236. return true;
  1237. }
  1238. return true;
  1239. }
  1240. function displayWorkflowForCurrentUser()
  1241. {
  1242. $_SESSION['display_workflow_for_user'] = false;
  1243. return false;
  1244. }
  1245. // return an array with all modules where the user is an admin.
  1246. function get_admin_modules_for_user($user) {
  1247. $GLOBALS['log']->deprecated("get_admin_modules_for_user() is deprecated as of 6.2.2 and may disappear in the future, use Users->getDeveloperModules() instead");
  1248. if(!isset($user)){
  1249. $modules = array();
  1250. return $modules;
  1251. }
  1252. return($user->getDeveloperModules());
  1253. }
  1254. function get_workflow_admin_modules_for_user($user){
  1255. if (isset($_SESSION['get_workflow_admin_modules_for_user'])) {
  1256. return $_SESSION['get_workflow_admin_modules_for_user'];
  1257. }
  1258. global $moduleList;
  1259. $workflow_mod_list = array();
  1260. foreach($moduleList as $module){
  1261. $workflow_mod_list[$module] = $module;
  1262. }
  1263. // This list is taken from teh previous version of workflow_utils.php
  1264. $workflow_mod_list['Tasks'] = "Tasks";
  1265. $workflow_mod_list['Calls'] = "Calls";
  1266. $workflow_mod_list['Meetings'] = "Meetings";
  1267. $workflow_mod_list['Notes'] = "Notes";
  1268. $workflow_mod_list['ProjectTask'] = "Project Tasks";
  1269. $workflow_mod_list['Leads'] = "Leads";
  1270. $workflow_mod_list['Opportunities'] = "Opportunities";
  1271. // End of list
  1272. $workflow_admin_modules = array();
  1273. if(empty($user)) {
  1274. return $workflow_admin_modules;
  1275. }
  1276. $actions = ACLAction::getUserActions($user->id);
  1277. //check for ForecastSchedule because it doesn't exist in $workflow_mod_list
  1278. if (isset($actions['ForecastSchedule']['module']['admin']['aclaccess']) && ($actions['ForecastSchedule']['module']['admin']['aclaccess']==ACL_ALLOW_DEV ||
  1279. $actions['ForecastSchedule']['module']['admin']['aclaccess']==ACL_ALLOW_ADMIN_DEV)) {
  1280. $workflow_admin_modules['Forecasts'] = 'Forecasts';
  1281. }
  1282. foreach ($workflow_mod_list as $key=>$val) {
  1283. if(!in_array($val, $workflow_admin_modules) && ($val!='iFrames' && $val!='Feeds' && $val!='Home' && $val!='Dashboard'
  1284. && $val!='Calendar' && $val!='Activities' && $val!='Reports') &&
  1285. ($user->isDeveloperForModule($key))) {
  1286. $workflow_admin_modules[$key] = $val;
  1287. }
  1288. }
  1289. $_SESSION['get_workflow_admin_modules_for_user'] = $workflow_admin_modules;
  1290. return ($workflow_admin_modules);
  1291. }
  1292. // Check if user is admin for at least one module.
  1293. function is_admin_for_any_module($user) {
  1294. if (!isset($user)){
  1295. return false;
  1296. }
  1297. if($user->isAdmin()) {
  1298. return true;
  1299. }
  1300. return false;
  1301. }
  1302. // Check if user is admin for a specific module.
  1303. function is_admin_for_module($user,$module) {
  1304. if (!isset($user)) {
  1305. return false;
  1306. }
  1307. if ($user->isAdmin()) {
  1308. return true;
  1309. }
  1310. return false;
  1311. }
  1312. /**
  1313. * Check if user id belongs to a system admin.
  1314. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1315. * All Rights Reserved.
  1316. * Contributor(s): ______________________________________..
  1317. */
  1318. function is_admin($user) {
  1319. if(empty($user)) {
  1320. return false;
  1321. }
  1322. return $user->isAdmin();
  1323. }
  1324. /**
  1325. * Return the display name for a theme if it exists.
  1326. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1327. * All Rights Reserved.
  1328. * Contributor(s): ______________________________________..
  1329. *
  1330. * @deprecated use SugarThemeRegistry::get($theme)->name instead
  1331. */
  1332. function get_theme_display($theme)
  1333. {
  1334. return SugarThemeRegistry::get($theme)->name;
  1335. }
  1336. /**
  1337. * Return an array of directory names.
  1338. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1339. * All Rights Reserved.
  1340. * Contributor(s): ______________________________________..
  1341. *
  1342. * @deprecated use SugarThemeRegistry::availableThemes() instead.
  1343. */
  1344. function get_themes()
  1345. {
  1346. return SugarThemeRegistry::availableThemes();
  1347. }
  1348. /**
  1349. * THIS FUNCTION IS DEPRECATED AND SHOULD NOT BE USED; USE get_select_options_with_id()
  1350. * Create HTML to display select options in a dropdown list. To be used inside
  1351. * of a select statement in a form.
  1352. * param $option_list - the array of strings to that contains the option list
  1353. * param $selected - the string which contains the default value
  1354. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1355. * All Rights Reserved.
  1356. * Contributor(s): ______________________________________..
  1357. */
  1358. function get_select_options ($option_list, $selected) {
  1359. return get_select_options_with_id($option_list, $selected);
  1360. }
  1361. /**
  1362. * Create HTML to display select options in a dropdown list. To be used inside
  1363. * of a select statement in a form. This method expects the option list to have keys and values. The keys are the ids. The values are the display strings.
  1364. * param $option_list - the array of strings to that contains the option list
  1365. * param $selected - the string which contains the default value
  1366. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1367. * All Rights Reserved.
  1368. * Contributor(s): ______________________________________..
  1369. */
  1370. function get_select_options_with_id ($option_list, $selected_key) {
  1371. return get_select_options_with_id_separate_key($option_list, $option_list, $selected_key);
  1372. }
  1373. /**
  1374. * Create HTML to display select options in a dropdown list. To be used inside
  1375. * of a select statement in a form. This method expects the option list to have keys and values. The keys are the ids. The values are the display strings.
  1376. * param $label_list - the array of strings to that contains the option list
  1377. * param $key_list - the array of strings to that contains the values list
  1378. * param $selected - the string which contains the default value
  1379. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1380. * All Rights Reserved.
  1381. * Contributor(s): ______________________________________..
  1382. */
  1383. function get_select_options_with_id_separate_key ($label_list, $key_list, $selected_key, $massupdate=false) {
  1384. global $app_strings;
  1385. $select_options = "";
  1386. //for setting null selection values to human readable --None--
  1387. $pattern = "/'0?'></";
  1388. $replacement = "''>".$app_strings['LBL_NONE']."<";
  1389. if($massupdate){
  1390. $replacement .= "/OPTION>\n<OPTION value='__SugarMassUpdateClearField__'><"; // Giving the user the option to unset a drop down list. I.e. none means that it won't get updated
  1391. }
  1392. if (empty($key_list)) $key_list = array();
  1393. //create the type dropdown domain and set the selected value if $opp value already exists
  1394. foreach ($key_list as $option_key=>$option_value) {
  1395. $selected_string = '';
  1396. // the system is evaluating $selected_key == 0 || '' to true. Be very careful when changing this. Test all cases.
  1397. // The bug was only happening with one of the users in the drop down. It was being replaced by none.
  1398. if (
  1399. ($option_key != '' && $selected_key == $option_key)
  1400. || (
  1401. $option_key == ''
  1402. && (($selected_key == '' && !$massupdate) || $selected_key == '__SugarMassUpdateClearField__')
  1403. )
  1404. || (is_array($selected_key) && in_array($option_key, $selected_key))
  1405. ) {
  1406. $selected_string = 'selected ';
  1407. }
  1408. $html_value = $option_key;
  1409. $select_options .= "\n<OPTION ".$selected_string."value='$html_value'>$label_list[$option_key]</OPTION>";
  1410. }
  1411. $select_options = preg_replace($pattern, $replacement, $select_options);
  1412. return $select_options;
  1413. }
  1414. /**
  1415. * Call this method instead of die().
  1416. * We print the error message and then die with an appropriate
  1417. * exit code.
  1418. */
  1419. function sugar_die($error_message, $exit_code = 1)
  1420. {
  1421. global $focus;
  1422. sugar_cleanup();
  1423. echo $error_message;
  1424. die($exit_code);
  1425. }
  1426. /**
  1427. * Create javascript to clear values of all elements in a form.
  1428. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1429. * All Rights Reserved.
  1430. * Contributor(s): ______________________________________..
  1431. */
  1432. function get_clear_form_js () {
  1433. $the_script = <<<EOQ
  1434. <script type="text/javascript" language="JavaScript">
  1435. function clear_form(form) {
  1436. var newLoc = 'index.php?action=' + form.action.value + '&module=' + form.module.value + '&query=true&clear_query=true';
  1437. if(typeof(form.advanced) != 'undefined'){
  1438. newLoc += '&advanced=' + form.advanced.value;
  1439. }
  1440. document.location.href= newLoc;
  1441. }
  1442. </script>
  1443. EOQ;
  1444. return $the_script;
  1445. }
  1446. /**
  1447. * Create javascript to set the cursor focus to specific field in a form
  1448. * when the screen is rendered. The field name is currently hardcoded into the
  1449. * the function.
  1450. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1451. * All Rights Reserved.
  1452. * Contributor(s): ______________________________________..
  1453. */
  1454. function get_set_focus_js () {
  1455. //TODO Clint 5/20 - Make this function more generic so that it can take in the target form and field names as variables
  1456. $the_script = <<<EOQ
  1457. <script type="text/javascript" language="JavaScript">
  1458. <!--
  1459. function set_focus() {
  1460. if (document.forms.length > 0) {
  1461. for (i = 0; i < document.forms.length; i++) {
  1462. for (j = 0; j < document.forms[i].elements.length; j++) {
  1463. var field = document.forms[i].elements[j];
  1464. if ((field.type == "text" || field.type == "textarea" || field.type == "password") &&
  1465. !field.disabled && (field.name == "first_name" || field.name == "name" || field.name == "user_name" || field.name=="document_name")) {
  1466. field.focus();
  1467. if (field.type == "text") {
  1468. field.select();
  1469. }
  1470. break;
  1471. }
  1472. }
  1473. }
  1474. }
  1475. }
  1476. -->
  1477. </script>
  1478. EOQ;
  1479. return $the_script;
  1480. }
  1481. /**
  1482. * Very cool algorithm for sorting multi-dimensional arrays. Found at http://us2.php.net/manual/en/function.array-multisort.php
  1483. * Syntax: $new_array = array_csort($array [, 'col1' [, SORT_FLAG [, SORT_FLAG]]]...);
  1484. * Explanation: $array is the array you want to sort, 'col1' is the name of the column
  1485. * you want to sort, SORT_FLAGS are : SORT_ASC, SORT_DESC, SORT_REGULAR, SORT_NUMERIC, SORT_STRING
  1486. * you can repeat the 'col',FLAG,FLAG, as often you want, the highest prioritiy is given to
  1487. * the first - so the array is sorted by the last given column first, then the one before ...
  1488. * Example: $array = array_csort($array,'town','age',SORT_DESC,'name');
  1489. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1490. * All Rights Reserved.
  1491. * Contributor(s): ______________________________________..
  1492. */
  1493. function array_csort() {
  1494. $args = func_get_args();
  1495. $marray = array_shift($args);
  1496. $i = 0;
  1497. $msortline = "return(array_multisort(";
  1498. foreach ($args as $arg) {
  1499. $i++;
  1500. if (is_string($arg)) {
  1501. foreach ($marray as $row) {
  1502. $sortarr[$i][] = $row[$arg];
  1503. }
  1504. } else {
  1505. $sortarr[$i] = $arg;
  1506. }
  1507. $msortline .= "\$sortarr[".$i."],";
  1508. }
  1509. $msortline .= "\$marray));";
  1510. eval($msortline);
  1511. return $marray;
  1512. }
  1513. /**
  1514. * Converts localized date format string to jscalendar format
  1515. * Example: $array = array_csort($array,'town','age',SORT_DESC,'name');
  1516. * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  1517. * All Rights Reserved.
  1518. * Contributor(s): ______________________________________..
  1519. */
  1520. function parse_calendardate($local_format) {
  1521. preg_match('/\(?([^-]{1})[^-]*-([^-]{1})[^-]*-([^-]{1})[^-]*\)/', $local_format, $matches);
  1522. $calendar_format = "%" . $matches[1] . "-%" . $matches[2] . "-%" . $matches[3];
  1523. return str_replace(array("y", "ᅣ1�7", "a", "j"), array("Y", "Y", "Y", "d"), $calendar_format);
  1524. }
  1525. function translate($string, $mod='', $selectedValue=''){
  1526. //$test_start = microtime();
  1527. //static $mod_strings_results = array();
  1528. if(!empty($mod)){
  1529. global $current_language;
  1530. //Bug 31275
  1531. if(isset($_REQUEST['login_language'])){
  1532. $current_language = ($_REQUEST['login_language'] == $current_language)? $current_language : $_REQUEST['login_language'];
  1533. }
  1534. $mod_strings = return_module_language($current_language, $mod);
  1535. if ($mod == "")
  1536. echo "Language is <pre>" . $mod_strings . "</pre>";
  1537. }else{
  1538. global $mod_strings;
  1539. }
  1540. $returnValue = '';
  1541. global $app_strings, $app_list_strings;
  1542. if (isset($mod_strings[$string]))
  1543. $returnValue = $mod_strings[$string];
  1544. else if (isset($app_strings[$string]))
  1545. $returnValue = $app_strings[$string];
  1546. else if (isset($app_list_strings[$string]))
  1547. $returnValue = $app_list_strings[$string];
  1548. else if (isset($app_list_strings['moduleList']) && isset($app_list_strings['moduleList'][$string]))
  1549. $returnValue = $app_list_strings['moduleList'][$string];
  1550. //$test_end = microtime();
  1551. //
  1552. // $mod_strings_results[$mod] = microtime_diff($test_start,$test_end);
  1553. //
  1554. // echo("translate results:");
  1555. // $total_time = 0;
  1556. // $total_strings = 0;
  1557. // foreach($mod_strings_results as $key=>$value)
  1558. // {
  1559. // echo("Module $key \t\t time $value \t\t<br>");
  1560. // $total_time += $value;
  1561. // }
  1562. //
  1563. // echo("Total time: $total_time<br>");
  1564. if(empty($returnValue)){
  1565. return $string;
  1566. }
  1567. // Bug 48996 - Custom enums with '0' value were not returning because of empty check
  1568. // Added a numeric 0 checker to the conditional to allow 0 value indexed to pass
  1569. if(is_array($returnValue) && (!empty($selectedValue) || (is_numeric($selectedValue) && $selectedValue == 0)) && isset($returnValue[$selectedValue]) ){
  1570. return $returnValue[$selectedValue];
  1571. }
  1572. return $returnValue;
  1573. }
  1574. function unTranslateNum($num) {
  1575. static $dec_sep;
  1576. static $num_grp_sep;
  1577. global $current_user, $sugar_config;
  1578. if($dec_sep == null) {
  1579. $user_dec_sep = $current_user->getPreference('dec_sep');
  1580. $dec_sep = (empty($user_dec_sep) ? $sugar_config['default_decimal_seperator'] : $user_dec_sep);
  1581. }
  1582. if($num_grp_sep == null) {
  1583. $user_num_grp_sep = $current_user->getPreference('num_grp_sep');
  1584. $num_grp_sep = (empty($user_num_grp_sep) ? $sugar_config['default_number_grouping_seperator'] : $user_num_grp_sep);
  1585. }
  1586. $num = preg_replace("'" . preg_quote($num_grp_sep) . "'", '', $num);
  1587. $num = preg_replace("'" . preg_quote($dec_sep) . "'", '.', $num);
  1588. return $num;
  1589. }
  1590. function add_http($url) {
  1591. if(!preg_match("@://@i", $url)) {
  1592. $scheme = "http";
  1593. if(!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on') {
  1594. $scheme = 'https';
  1595. }
  1596. return "{$scheme}://{$url}";
  1597. }
  1598. return $url;
  1599. }
  1600. /**
  1601. * returns a default array of XSS tags to clean
  1602. * @return array
  1603. */
  1604. function getDefaultXssTags() {
  1605. $tmp = array(
  1606. "applet" => "applet",
  1607. "base" => "base",
  1608. "embed" => "embed",
  1609. "form" => "form",
  1610. "frame" => "frame",
  1611. "frameset" => "frameset",
  1612. "iframe" => "iframe",
  1613. "import" => "\?import",
  1614. "layer" => "layer",
  1615. "link" => "link",
  1616. "object" => "object",
  1617. "script" => "script",
  1618. "xmp" => "xmp",
  1619. );
  1620. $ret = base64_encode(serialize($tmp));
  1621. return $ret;
  1622. }
  1623. /**
  1624. * Remove potential xss vectors from strings
  1625. * @param string str String to search for XSS attack vectors
  1626. * @deprecated
  1627. * @return string
  1628. */
  1629. function remove_xss($str)
  1630. {
  1631. return SugarCleaner::cleanHtml($str, false);
  1632. }
  1633. /**
  1634. * Detects typical XSS attack patterns
  1635. * @deprecated
  1636. * @param string str String to search for XSS attack vectors
  1637. * @param bool cleanImg Flag to allow <img> tags to survive - only used by InboundEmail for inline images.
  1638. * @return array Array of matches, empty on clean string
  1639. */
  1640. function clean_xss($str, $cleanImg=true) {
  1641. global $sugar_config;
  1642. if(empty($sugar_config['email_xss']))
  1643. $sugar_config['email_xss'] = getDefaultXssTags();
  1644. $xsstags = unserialize(base64_decode($sugar_config['email_xss']));
  1645. // cn: bug 13079 - "on\w" matched too many non-events (cONTact, strONG, etc.)
  1646. $jsEvents = "onblur|onfocus|oncontextmenu|onresize|onscroll|onunload|ondblclick|onclick|";
  1647. $jsEvents .= "onmouseup|onmouseover|onmousedown|onmouseenter|onmouseleave|onmousemove|onload|onchange|";
  1648. $jsEvents .= "onreset|onselect|onsubmit|onkeydown|onkeypress|onkeyup|onabort|onerror|ondragdrop";
  1649. $attribute_regex = "#\b({$jsEvents})\s*=\s*(?|(?!['\"])\S+|['\"].+?['\"])#sim";
  1650. $javascript_regex = '@<[^/>][^>]+(expression\(|j\W*a\W*v\W*a|v\W*b\W*s\W*c\W*r|&#|/\*|\*/)[^>]*>@sim';
  1651. $imgsrc_regex = '#<[^>]+src[^=]*=([^>]*?http(s)?://[^>]*)>#sim';
  1652. $css_url = '#url\(.*\.\w+\)#';
  1653. $tagsrex = '#<\/?(\w+)((?:\s+(?:\w|\w[\w-]*\w)(?:\s*=\s*(?:\".*?\"|\'.*?\'|[^\'\">\s]+))?)+\s*|\s*)\/?>#im';
  1654. $tagmatches = array();
  1655. $matches = array();
  1656. preg_match_all($tagsrex, $str, $tagmatches, PREG_PATTERN_ORDER);
  1657. foreach($tagmatches[1] as $no => $tag) {
  1658. if(in_array($tag, $xsstags)) {
  1659. // dangerous tag - take out whole
  1660. $matches[] = $tagmatches[0][$no];
  1661. continue;
  1662. }
  1663. $attrmatch = array();
  1664. preg_match_all($attribute_regex, $tagmatches[2][$no], $attrmatch, PREG_PATTERN_ORDER);
  1665. if(!empty($attrmatch[0])) {
  1666. $matches = array_merge($matches, $attrmatch[0]);
  1667. }
  1668. }
  1669. $matches = array_merge($matches, xss_check_pattern($javascript_regex, $str));
  1670. if($cleanImg) {
  1671. $matches = array_merge($matches,
  1672. xss_check_pattern($imgsrc_regex, $str)
  1673. );
  1674. }
  1675. // cn: bug 13498 - custom white-list of allowed domains that vet remote images
  1676. preg_match_all($css_url, $str, $cssUrlMatches, PREG_PATTERN_ORDER);
  1677. if(isset($sugar_config['security_trusted_domains']) && !empty($sugar_config['security_trusted_domains']) && is_array($sugar_config['security_trusted_domains'])) {
  1678. if(is_array($cssUrlMatches) && count($cssUrlMatches) > 0) {
  1679. // normalize whitelist
  1680. foreach($sugar_config['security_trusted_domains'] as $k => $v) {
  1681. $sugar_config['security_trusted_domains'][$k] = strtolower($v);
  1682. }
  1683. foreach($cssUrlMatches[0] as $match) {
  1684. $domain = strtolower(substr(strstr($match, "://"), 3));
  1685. $baseUrl = substr($domain, 0, strpos($domain, "/"));
  1686. if(!in_array($baseUrl, $sugar_config['security_trusted_domains'])) {
  1687. $matches[] = $match;
  1688. }
  1689. }
  1690. }
  1691. } else {
  1692. $matches = array_merge($matches, $cssUrlMatches[0]);
  1693. }
  1694. return $matches;
  1695. }
  1696. /**
  1697. * Helper function used by clean_xss() to parse for known-bad vectors
  1698. * @param string pattern Regex pattern to use
  1699. * @param string str String to parse for badness
  1700. * @return array
  1701. */
  1702. function xss_check_pattern($pattern, $str) {
  1703. preg_match_all($pattern, $str, $matches, PREG_PATTERN_ORDER);
  1704. return $matches[1];
  1705. }
  1706. /**
  1707. * Designed to take a string passed in the URL as a parameter and clean all "bad" data from it
  1708. *
  1709. * @param string $str
  1710. * @param string $filter which corresponds to a regular expression to use; choices are:
  1711. * "STANDARD" ( default )
  1712. * "STANDARDSPACE"
  1713. * "FILE"
  1714. * "NUMBER"
  1715. * "SQL_COLUMN_LIST"
  1716. * "PATH_NO_URL"
  1717. * "SAFED_GET"
  1718. * "UNIFIED_SEARCH"
  1719. * "AUTO_INCREMENT"
  1720. * "ALPHANUM"
  1721. * @param boolean $dieOnBadData true (default) if you want to die if bad data if found, false if not
  1722. */
  1723. function clean_string($str, $filter = "STANDARD", $dieOnBadData = true)
  1724. {
  1725. global $sugar_config;
  1726. $filters = Array(
  1727. "STANDARD" => '#[^A-Z0-9\-_\.\@]#i',
  1728. "STANDARDSPACE" => '#[^A-Z0-9\-_\.\@\ ]#i',
  1729. "FILE" => '#[^A-Z0-9\-_\.]#i',
  1730. "NUMBER" => '#[^0-9\-]#i',
  1731. "SQL_COLUMN_LIST" => '#[^A-Z0-9\(\),_\.]#i',
  1732. "PATH_NO_URL" => '#://#i',
  1733. "SAFED_GET" => '#[^A-Z0-9\@\=\&\?\.\/\-_~+]#i', /* range of allowed characters in a GET string */
  1734. "UNIFIED_SEARCH" => "#[\\x00]#", /* cn: bug 3356 & 9236 - MBCS search strings */
  1735. "AUTO_INCREMENT" => '#[^0-9\-,\ ]#i',
  1736. "ALPHANUM" => '#[^A-Z0-9\-]#i',
  1737. );
  1738. if (preg_match($filters[$filter], $str)) {
  1739. if (isset($GLOBALS['log']) && is_object($GLOBALS['log'])) {
  1740. $GLOBALS['log']->fatal("SECURITY[$filter]: bad data passed in; string: {$str}");
  1741. }
  1742. if ( $dieOnBadData ) {
  1743. die("Bad data passed in; <a href=\"{$sugar_config['site_url']}\">Return to Home</a>");
  1744. }
  1745. return false;
  1746. }
  1747. else {
  1748. return $str;
  1749. }
  1750. }
  1751. function clean_special_arguments() {
  1752. if(isset($_SERVER['PHP_SELF'])) {
  1753. if (!empty($_SERVER['PHP_SELF'])) clean_string($_SERVER['PHP_SELF'], 'SAFED_GET');
  1754. }
  1755. if (!empty($_REQUEST) && !empty($_REQUEST['login_theme'])) clean_string($_REQUEST['login_theme'], "STANDARD");
  1756. if (!empty($_REQUEST) && !empty($_REQUEST['login_module'])) clean_string($_REQUEST['login_module'], "STANDARD");
  1757. if (!empty($_REQUEST) && !empty($_REQUEST['login_action'])) clean_string($_REQUEST['login_action'], "STANDARD");
  1758. if (!empty($_REQUEST) && !empty($_REQUEST['ck_login_theme_20'])) clean_string($_REQUEST['ck_login_theme_20'], "STANDARD");
  1759. if (!empty($_SESSION) && !empty($_SESSION['authenticated_user_theme'])) clean_string($_SESSION['authenticated_user_theme'], "STANDARD");
  1760. if (!empty($_REQUEST) && !empty($_REQUEST['module_name'])) clean_string($_REQUEST['module_name'], "STANDARD");
  1761. if (!empty($_REQUEST) && !empty($_REQUEST['module'])) clean_string($_REQUEST['module'], "STANDARD");
  1762. if (!empty($_POST) && !empty($_POST['parent_type'])) clean_string($_POST['parent_type'], "STANDARD");
  1763. if (!empty($_REQUEST) && !empty($_REQUEST['mod_lang'])) clean_string($_REQUEST['mod_lang'], "STANDARD");
  1764. if (!empty($_SESSION) && !empty($_SESSION['authenticated_user_language'])) clean_string($_SESSION['authenticated_user_language'], "STANDARD");
  1765. if (!empty($_SESSION) && !empty($_SESSION['dyn_layout_file'])) clean_string($_SESSION['dyn_layout_file'], "PATH_NO_URL");
  1766. if (!empty($_GET) && !empty($_GET['from'])) clean_string($_GET['from']);
  1767. if (!empty($_GET) && !empty($_GET['gmto'])) clean_string($_GET['gmto'], "NUMBER");
  1768. if (!empty($_GET) && !empty($_GET['case_number'])) clean_string($_GET['case_number'], "AUTO_INCREMENT");
  1769. if (!empty($_GET) && !empty($_GET['bug_number'])) clean_string($_GET['bug_number'], "AUTO_INCREMENT");
  1770. if (!empty($_GET) && !empty($_GET['quote_num'])) clean_string($_GET['quote_num'], "AUTO_INCREMENT");
  1771. clean_superglobals('stamp', 'ALPHANUM'); // for vcr controls
  1772. clean_superglobals('offset', 'ALPHANUM');
  1773. clean_superglobals('return_action');
  1774. clean_superglobals('return_module');
  1775. return TRUE;
  1776. }
  1777. /**
  1778. * cleans the given key in superglobals $_GET, $_POST, $_REQUEST
  1779. */
  1780. function clean_superglobals($key, $filter = 'STANDARD') {
  1781. if(isset($_GET[$key])) clean_string($_GET[$key], $filter);
  1782. if(isset($_POST[$key])) clean_string($_POST[$key], $filter);
  1783. if(isset($_REQUEST[$key])) clean_string($_REQUEST[$key], $filter);
  1784. }
  1785. function set_superglobals($key, $val){
  1786. $_GET[$key] = $val;
  1787. $_POST[$key] = $val;
  1788. $_REQUEST[$key] = $val;
  1789. }
  1790. // Works in conjunction with clean_string() to defeat SQL injection, file inclusion attacks, and XSS
  1791. function clean_incoming_data() {
  1792. global $sugar_config;
  1793. global $RAW_REQUEST;
  1794. if(get_magic_quotes_gpc()) {
  1795. // magic quotes screw up data, we'd have to clean up
  1796. $RAW_REQUEST = array_map("cleanup_slashes", $_REQUEST);
  1797. } else {
  1798. $RAW_REQUEST = $_REQUEST;
  1799. }
  1800. if (get_magic_quotes_gpc() == 1) {
  1801. $req = array_map("preprocess_param", $_REQUEST);
  1802. $post = array_map("preprocess_param", $_POST);
  1803. $get = array_map("preprocess_param", $_GET);
  1804. } else {
  1805. $req = array_map("securexss", $_REQUEST);
  1806. $post = array_map("securexss", $_POST);
  1807. $get = array_map("securexss", $_GET);
  1808. }
  1809. // PHP cannot stomp out superglobals reliably
  1810. foreach($post as $k => $v) { $_POST[$k] = $v; }
  1811. foreach($get as $k => $v) { $_GET[$k] = $v; }
  1812. foreach($req as $k => $v) {
  1813. $_REQUEST[$k] = $v;
  1814. //ensure the keys are safe as well. If mbstring encoding translation is on, the post keys don't
  1815. //get translated, so scrub the data but don't die
  1816. if(ini_get('mbstring.encoding_translation')==='1'){
  1817. securexsskey($k,false);
  1818. }else{
  1819. securexsskey($k,true);
  1820. }
  1821. }
  1822. // Any additional variables that need to be cleaned should be added here
  1823. if (isset($_REQUEST['login_theme'])) clean_string($_REQUEST['login_theme']);
  1824. if (isset($_REQUEST['login_module'])) clean_string($_REQUEST['login_module']);
  1825. if (isset($_REQUEST['login_action'])) clean_string($_REQUEST['login_action']);
  1826. if (isset($_REQUEST['login_language'])) clean_string($_REQUEST['login_language']);
  1827. if (isset($_REQUEST['action'])) clean_string($_REQUEST['action']);
  1828. if (isset($_REQUEST['module'])) clean_string($_REQUEST['module']);
  1829. if (isset($_REQUEST['record'])) clean_string($_REQUEST['record'], 'STANDARDSPACE');
  1830. if (isset($_SESSION['authenticated_user_theme'])) clean_string($_SESSION['authenticated_user_theme']);
  1831. if (isset($_SESSION['authenticated_user_language'])) clean_string($_SESSION['authenticated_user_language']);
  1832. if (isset($_REQUEST['language'])) clean_string($_REQUEST['language']);
  1833. if (isset($sugar_config['default_theme'])) clean_string($sugar_config['default_theme']);
  1834. if (isset($_REQUEST['offset'])) clean_string($_REQUEST['offset']);
  1835. if (isset($_REQUEST['stamp'])) clean_string($_REQUEST['stamp']);
  1836. if(isset($_REQUEST['lvso'])){
  1837. set_superglobals('lvso', (strtolower($_REQUEST['lvso']) === 'desc')?'desc':'asc');
  1838. }
  1839. // Clean "offset" and "order_by" parameters in URL
  1840. foreach ($_REQUEST as $key => $val) {
  1841. if (str_end($key, "_offset")) {
  1842. clean_string($_REQUEST[$key], "ALPHANUM"); // keep this ALPHANUM for disable_count_query
  1843. set_superglobals($key, $_REQUEST[$key]);
  1844. }
  1845. elseif (str_end($key, "_ORDER_BY")) {
  1846. clean_string($_REQUEST[$key], "SQL_COLUMN_LIST");
  1847. set_superglobals($key, $_REQUEST[$key]);
  1848. }
  1849. }
  1850. return 0;
  1851. }
  1852. // Returns TRUE if $str begins with $begin
  1853. function str_begin($str, $begin) {
  1854. return (substr($str, 0, strlen($begin)) == $begin);
  1855. }
  1856. // Returns TRUE if $str ends with $end
  1857. function str_end($str, $end) {
  1858. return (substr($str, strlen($str) - strlen($end)) == $end);
  1859. }
  1860. function securexss($value) {
  1861. if(is_array($value)){
  1862. $new = array();
  1863. foreach($value as $key=>$val){
  1864. $new[$key] = securexss($val);
  1865. }
  1866. return $new;
  1867. }
  1868. static $xss_cleanup= array("&quot;" => "&#38;", '"' =>'&quot;', "'" => '&#039;' , '<' =>'&lt;' , '>'=>'&gt;');
  1869. $value = preg_replace(array('/javascript:/i', '/\0/'), array('java script:', ''), $value);
  1870. $value = preg_replace('/javascript:/i', 'java script:', $value);
  1871. return str_replace(array_keys($xss_cleanup), array_values($xss_cleanup), $value);
  1872. }
  1873. function securexsskey($value, $die=true){
  1874. global $sugar_config;
  1875. $matches = array();
  1876. preg_match('/[\'"<>]/', $value, $matches);
  1877. if(!empty($matches)){
  1878. if($die){
  1879. die("Bad data passed in; <a href=\"{$sugar_config['site_url']}\">Return to Home</a>");
  1880. }else{
  1881. unset($_REQUEST[$value]);
  1882. unset($_POST[$value]);
  1883. unset($_GET[$value]);
  1884. }
  1885. }
  1886. }
  1887. function preprocess_param($value){
  1888. if(is_string($value)){
  1889. if(get_magic_quotes_gpc() == 1){
  1890. $value = stripslashes($value);
  1891. }
  1892. $value = securexss($value);
  1893. }
  1894. else if (is_array($value)){
  1895. foreach ($value as $key => $element) {
  1896. $value[$key] = preprocess_param($element);
  1897. }
  1898. }
  1899. return $value;
  1900. }
  1901. function cleanup_slashes($value)
  1902. {
  1903. if(is_string($value)) return stripslashes($value);
  1904. return $value;
  1905. }
  1906. function set_register_value($category, $name, $value){
  1907. return sugar_cache_put("{$category}:{$name}", $value);
  1908. }
  1909. function get_register_value($category,$name){
  1910. return sugar_cache_retrieve("{$category}:{$name}");
  1911. }
  1912. function clear_register_value($category,$name){
  1913. return sugar_cache_clear("{$category}:{$name}");
  1914. }
  1915. // this function cleans id's when being imported
  1916. function convert_id($string)
  1917. {
  1918. return preg_replace_callback( '|[^A-Za-z0-9\-]|',
  1919. create_function(
  1920. // single quotes are essential here,
  1921. // or alternative escape all $ as \$
  1922. '$matches',
  1923. 'return ord($matches[0]);'
  1924. ) ,$string);
  1925. }
  1926. /**
  1927. * @deprecated use SugarTheme::getImage()
  1928. */
  1929. function get_image($image,$other_attributes,$width="",$height="",$ext='.gif',$alt="")
  1930. {
  1931. return SugarThemeRegistry::current()->getImage(basename($image), $other_attributes, empty($width) ? null : $width, empty($height) ? null : $height, $ext, $alt );
  1932. }
  1933. /**
  1934. * @deprecated use SugarTheme::getImageURL()
  1935. */
  1936. function getImagePath($image_name)
  1937. {
  1938. return SugarThemeRegistry::current()->getImageURL($image_name);
  1939. }
  1940. function getWebPath($relative_path){
  1941. //if it has a :// then it isn't a relative path
  1942. if(substr_count($relative_path, '://') > 0) return $relative_path;
  1943. if(defined('TEMPLATE_URL'))$relative_path = SugarTemplateUtilities::getWebPath($relative_path);
  1944. return $relative_path;
  1945. }
  1946. function getVersionedPath($path, $additional_attrs='')
  1947. {
  1948. if(empty($GLOBALS['sugar_config']['js_custom_version'])) $GLOBALS['sugar_config']['js_custom_version'] = 1;
  1949. $js_version_key = isset($GLOBALS['js_version_key'])?$GLOBALS['js_version_key']:'';
  1950. if(inDeveloperMode()) {
  1951. static $rand;
  1952. if(empty($rand)) $rand = mt_rand();
  1953. $dev = $rand;
  1954. } else {
  1955. $dev = '';
  1956. }
  1957. if(is_array($additional_attrs)) {
  1958. $additional_attrs = join("|",$additional_attrs);
  1959. }
  1960. // cutting 2 last chars here because since md5 is 32 chars, it's always ==
  1961. $str = substr(base64_encode(md5("$js_version_key|{$GLOBALS['sugar_config']['js_custom_version']}|$dev|$additional_attrs", true)), 0, -2);
  1962. // remove / - it confuses some parsers
  1963. $str = strtr($str, '/+', '-_');
  1964. if(empty($path)) return $str;
  1965. return $path . "?v=$str";
  1966. }
  1967. function getVersionedScript($path, $additional_attrs='')
  1968. {
  1969. return '<script type="text/javascript" src="'.getVersionedPath($path, $additional_attrs).'"></script>';
  1970. }
  1971. function getJSPath($relative_path, $additional_attrs='')
  1972. {
  1973. if(defined('TEMPLATE_URL'))$relative_path = SugarTemplateUtilities::getWebPath($relative_path);
  1974. return getVersionedPath($relative_path).(!empty($additional_attrs)?"&$additional_attrs":"");
  1975. }
  1976. function getSWFPath($relative_path, $additional_params=''){
  1977. $path = $relative_path;
  1978. if (!empty($additional_params)){
  1979. $path .= '?' . $additional_params;
  1980. }
  1981. if (defined('TEMPLATE_URL')){
  1982. $path = TEMPLATE_URL . '/' . $path;
  1983. }
  1984. return $path;
  1985. }
  1986. function getSQLDate($date_str)
  1987. {
  1988. if (preg_match('/^(\d{1,2})-(\d{1,2})-(\d{4})$/',$date_str,$match))
  1989. {
  1990. if ( strlen($match[2]) == 1)
  1991. {
  1992. $match[2] = "0".$match[2];
  1993. }
  1994. if ( strlen($match[1]) == 1)
  1995. {
  1996. $match[1] = "0".$match[1];
  1997. }
  1998. return "{$match[3]}-{$match[1]}-{$match[2]}";
  1999. }
  2000. else if (preg_match('/^(\d{1,2})\/(\d{1,2})\/(\d{4})$/',$date_str,$match))
  2001. {
  2002. if ( strlen($match[2]) == 1)
  2003. {
  2004. $match[2] = "0".$match[2];
  2005. }
  2006. if ( strlen($match[1]) == 1)
  2007. {
  2008. $match[1] = "0".$match[1];
  2009. }
  2010. return "{$match[3]}-{$match[1]}-{$match[2]}";
  2011. }
  2012. else
  2013. {
  2014. return "";
  2015. }
  2016. }
  2017. function clone_history(&$db, $from_id,$to_id, $to_type)
  2018. {
  2019. global $timedate;
  2020. $old_note_id=null;
  2021. $old_filename=null;
  2022. require_once('include/upload_file.php');
  2023. $tables = array('calls'=>'Call', 'meetings'=>'Meeting', 'notes'=>'Note', 'tasks'=>'Task');
  2024. $location=array('Email'=>"modules/Emails/Email.php",
  2025. 'Call'=>"modules/Calls/Call.php",
  2026. 'Meeting'=>"modules/Meetings/Meeting.php",
  2027. 'Note'=>"modules/Notes/Note.php",
  2028. 'Tasks'=>"modules/Tasks/Task.php",
  2029. );
  2030. foreach($tables as $table=>$bean_class)
  2031. {
  2032. if (!class_exists($bean_class))
  2033. {
  2034. require_once($location[$bean_class]);
  2035. }
  2036. $bProcessingNotes=false;
  2037. if ($table=='notes')
  2038. {
  2039. $bProcessingNotes=true;
  2040. }
  2041. $query = "SELECT id FROM $table WHERE parent_id='$from_id'";
  2042. $results = $db->query($query);
  2043. while($row = $db->fetchByAssoc($results))
  2044. {
  2045. //retrieve existing record.
  2046. $bean= new $bean_class();
  2047. $bean->retrieve($row['id']);
  2048. //process for new instance.
  2049. if ($bProcessingNotes)
  2050. {
  2051. $old_note_id=$row['id'];
  2052. $old_filename=$bean->filename;
  2053. }
  2054. $bean->id=null;
  2055. $bean->parent_id=$to_id;
  2056. $bean->parent_type=$to_type;
  2057. if ($to_type=='Contacts' and in_array('contact_id',$bean->column_fields))
  2058. {
  2059. $bean->contact_id=$to_id;
  2060. }
  2061. $bean->update_date_modified = false;
  2062. $bean->update_modified_by = false;
  2063. if(isset($bean->date_modified))
  2064. $bean->date_modified = $timedate->to_db($bean->date_modified);
  2065. if(isset($bean->date_entered))
  2066. $bean->date_entered = $timedate->to_db($bean->date_entered);
  2067. //save
  2068. $new_id=$bean->save();
  2069. //duplicate the file now. for notes.
  2070. if ($bProcessingNotes && !empty($old_filename))
  2071. {
  2072. UploadFile::duplicate_file($old_note_id,$new_id,$old_filename);
  2073. }
  2074. //reset the values needed for attachment duplication.
  2075. $old_note_id=null;
  2076. $old_filename=null;
  2077. }
  2078. }
  2079. }
  2080. function values_to_keys($array)
  2081. {
  2082. $new_array = array();
  2083. if(!is_array($array))
  2084. {
  2085. return $new_array;
  2086. }
  2087. foreach($array as $arr){
  2088. $new_array[$arr] = $arr;
  2089. }
  2090. return $new_array;
  2091. }
  2092. function clone_relationship(&$db, $tables = array(), $from_column, $from_id, $to_id)
  2093. {
  2094. foreach($tables as $table)
  2095. {
  2096. if ($table == 'emails_beans') {
  2097. $query = "SELECT * FROM $table WHERE $from_column='$from_id' and bean_module='Leads'";
  2098. } else {
  2099. $query = "SELECT * FROM $table WHERE $from_column='$from_id'";
  2100. }
  2101. $results = $db->query($query);
  2102. while($row = $db->fetchByAssoc($results))
  2103. {
  2104. $query = "INSERT INTO $table ";
  2105. $names = '';
  2106. $values = '';
  2107. $row[$from_column] = $to_id;
  2108. $row['id'] = create_guid();
  2109. if ($table=='emails_beans') {
  2110. $row['bean_module'] =='Contacts';
  2111. }
  2112. foreach($row as $name=>$value)
  2113. {
  2114. if(empty($names))
  2115. {
  2116. $names .= $name;
  2117. $values .= "'$value'";
  2118. } else
  2119. {
  2120. $names .= ', '. $name;
  2121. $values .= ", '$value'";
  2122. }
  2123. }
  2124. $query .= "($names) VALUES ($values)";
  2125. $db->query($query);
  2126. }
  2127. }
  2128. }
  2129. function get_unlinked_email_query($type, $bean) {
  2130. global $current_user;
  2131. $return_array['select']='SELECT emails.id ';
  2132. $return_array['from']='FROM emails ';
  2133. $return_array['where']="";
  2134. $return_array['join'] = " JOIN (select DISTINCT email_id from emails_email_addr_rel eear
  2135. join email_addr_bean_rel eabr on eabr.bean_id ='$bean->id' and eabr.bean_module = '$bean->module_dir' and
  2136. eabr.email_address_id = eear.email_address_id and eabr.deleted=0
  2137. where eear.deleted=0 and eear.email_id not in
  2138. (select eb.email_id from emails_beans eb where eb.bean_module ='$bean->module_dir' and eb.bean_id = '$bean->id')
  2139. ) derivedemails on derivedemails.email_id = emails.id";
  2140. $return_array['join_tables'][0] = '';
  2141. if (isset($type) and !empty($type['return_as_array'])) {
  2142. return $return_array;
  2143. }
  2144. return $return_array['select'] . $return_array['from'] . $return_array['where'] . $return_array['join'] ;
  2145. } // fn
  2146. function get_emails_by_assign_or_link($params)
  2147. {
  2148. $relation = $params['link'];
  2149. $bean = $GLOBALS['app']->controller->bean;
  2150. if(empty($bean->$relation)) {
  2151. $bean->load_relationship($relation);
  2152. }
  2153. if(empty($bean->$relation)) {
  2154. $GLOBALS['log']->error("Bad relation '$relation' for bean '{$bean->object_name}' id '{$bean->id}'");
  2155. return array();
  2156. }
  2157. $rel_module = $bean->$relation->getRelatedModuleName();
  2158. $rel_join = $bean->$relation->getJoin(array(
  2159. 'join_table_alias' => 'link_bean',
  2160. 'join_table_link_alias' => 'linkt',
  2161. ));
  2162. $rel_join = str_replace("{$bean->table_name}.id", "'{$bean->id}'", $rel_join);
  2163. $return_array['select']='SELECT DISTINCT emails.id ';
  2164. $return_array['from'] = "FROM emails ";
  2165. $return_array['join'] = array();
  2166. // directly assigned emails
  2167. $return_array['join'][] = "
  2168. SELECT
  2169. eb.email_id,
  2170. 'direct' source
  2171. FROM
  2172. emails_beans eb
  2173. WHERE
  2174. eb.bean_module = '{$bean->module_dir}'
  2175. AND eb.bean_id = '{$bean->id}'
  2176. AND eb.deleted=0
  2177. ";
  2178. // Related by directly by email
  2179. $return_array['join'][] = "
  2180. SELECT DISTINCT
  2181. eear.email_id,
  2182. 'relate' source
  2183. FROM
  2184. emails_email_addr_rel eear
  2185. INNER JOIN
  2186. email_addr_bean_rel eabr
  2187. ON
  2188. eabr.bean_id ='{$bean->id}'
  2189. AND eabr.bean_module = '{$bean->module_dir}'
  2190. AND eabr.email_address_id = eear.email_address_id
  2191. AND eabr.deleted=0
  2192. WHERE
  2193. eear.deleted=0
  2194. ";
  2195. $showEmailsOfRelatedContacts = empty($bean->field_defs[$relation]['hide_history_contacts_emails']);
  2196. if (!empty($GLOBALS['sugar_config']['hide_history_contacts_emails']) && isset($GLOBALS['sugar_config']['hide_history_contacts_emails'][$bean->module_name])) {
  2197. $showEmailsOfRelatedContacts = empty($GLOBALS['sugar_config']['hide_history_contacts_emails'][$bean->module_name]);
  2198. }
  2199. if ($showEmailsOfRelatedContacts) {
  2200. // Assigned to contacts
  2201. $return_array['join'][] = "
  2202. SELECT DISTINCT
  2203. eb.email_id,
  2204. 'contact' source
  2205. FROM
  2206. emails_beans eb
  2207. $rel_join AND link_bean.id = eb.bean_id
  2208. WHERE
  2209. eb.bean_module = '$rel_module'
  2210. AND eb.deleted=0
  2211. ";
  2212. // Related by email to linked contact
  2213. $return_array['join'][] = "
  2214. SELECT DISTINCT
  2215. eear.email_id,
  2216. 'relate_contact' source
  2217. FROM
  2218. emails_email_addr_rel eear
  2219. INNER JOIN
  2220. email_addr_bean_rel eabr
  2221. ON
  2222. eabr.email_address_id=eear.email_address_id
  2223. AND eabr.bean_module = '$rel_module'
  2224. AND eabr.deleted=0
  2225. $rel_join AND link_bean.id = eabr.bean_id
  2226. WHERE
  2227. eear.deleted=0
  2228. ";
  2229. }
  2230. $return_array['join'] = " INNER JOIN (" . implode(" UNION ", $return_array['join']). ") email_ids ON emails.id=email_ids.email_id ";
  2231. $return_array['where']=" WHERE emails.deleted=0 ";
  2232. //$return_array['join'] = '';
  2233. $return_array['join_tables'][0] = '';
  2234. if($bean->object_name == "Case" && !empty($bean->case_number)) {
  2235. $where = str_replace("%1", $bean->case_number, $bean->getEmailSubjectMacro());
  2236. $return_array["where"] .= "\n AND (email_ids.source = 'direct' OR emails.name LIKE '%$where%')";
  2237. }
  2238. return $return_array;
  2239. }
  2240. /**
  2241. * Check to see if the number is empty or non-zero
  2242. * @param $value
  2243. * @return boolean
  2244. **/
  2245. function number_empty($value)
  2246. {
  2247. return empty($value) && $value != '0';
  2248. }
  2249. function get_bean_select_array($add_blank=true, $bean_name, $display_columns, $where='', $order_by='', $blank_is_none=false)
  2250. {
  2251. global $beanFiles;
  2252. require_once($beanFiles[$bean_name]);
  2253. $focus = new $bean_name();
  2254. $user_array = array();
  2255. $key = ($bean_name == 'EmailTemplate') ? $bean_name : $bean_name . $display_columns. $where . $order_by;
  2256. $user_array = get_register_value('select_array', $key );
  2257. if(!$user_array)
  2258. {
  2259. $db = DBManagerFactory::getInstance();
  2260. $temp_result = Array();
  2261. $query = "SELECT {$focus->table_name}.id, {$display_columns} as display from {$focus->table_name} ";
  2262. $query .= "where ";
  2263. if ( $where != '')
  2264. {
  2265. $query .= $where." AND ";
  2266. }
  2267. $query .= " {$focus->table_name}.deleted=0";
  2268. /* BEGIN - SECURITY GROUPS */
  2269. global $current_user, $sugar_config;
  2270. if($focus->module_dir == 'Users' && !is_admin($current_user)
  2271. && isset($sugar_config['securitysuite_filter_user_list'])
  2272. && $sugar_config['securitysuite_filter_user_list'] == true
  2273. ) {
  2274. require_once('modules/SecurityGroups/SecurityGroup.php');
  2275. $group_where = SecurityGroup::getGroupUsersWhere($current_user->id);
  2276. $query .= " AND (".$group_where.") ";
  2277. } else
  2278. if($focus->bean_implements('ACL') && ACLController::requireSecurityGroup($focus->module_dir, 'list') )
  2279. {
  2280. require_once('modules/SecurityGroups/SecurityGroup.php');
  2281. $owner_where = $focus->getOwnerWhere($current_user->id);
  2282. $group_where = SecurityGroup::getGroupWhere($focus->table_name,$focus->module_dir,$current_user->id);
  2283. if(!empty($owner_where)){
  2284. $query .= " AND (". $owner_where." or ".$group_where.") ";
  2285. } else {
  2286. $query .= ' AND '. $group_where;
  2287. }
  2288. }
  2289. /* END - SECURITY GROUPS */
  2290. if ( $order_by != '')
  2291. {
  2292. $query .= " order by {$focus->table_name}.{$order_by}";
  2293. }
  2294. $GLOBALS['log']->debug("get_user_array query: $query");
  2295. $result = $db->query($query, true, "Error filling in user array: ");
  2296. if ($add_blank==true){
  2297. // Add in a blank row
  2298. if($blank_is_none == true) { // set 'blank row' to "--None--"
  2299. global $app_strings;
  2300. $temp_result[''] = $app_strings['LBL_NONE'];
  2301. } else {
  2302. $temp_result[''] = '';
  2303. }
  2304. }
  2305. // Get the id and the name.
  2306. while($row = $db->fetchByAssoc($result))
  2307. {
  2308. $temp_result[$row['id']] = $row['display'];
  2309. }
  2310. $user_array = $temp_result;
  2311. set_register_value('select_array', $key ,$temp_result);
  2312. }
  2313. return $user_array;
  2314. }
  2315. /**
  2316. *
  2317. *
  2318. * @param unknown_type $listArray
  2319. */
  2320. // function parse_list_modules
  2321. // searches a list for items in a user's allowed tabs and returns an array that removes unallowed tabs from list
  2322. function parse_list_modules(&$listArray)
  2323. {
  2324. global $modListHeader;
  2325. $returnArray = array();
  2326. foreach($listArray as $optionName => $optionVal)
  2327. {
  2328. if(array_key_exists($optionName, $modListHeader))
  2329. {
  2330. $returnArray[$optionName] = $optionVal;
  2331. }
  2332. // special case for projects
  2333. if(array_key_exists('Project', $modListHeader))
  2334. {
  2335. $returnArray['ProjectTask'] = $listArray['ProjectTask'];
  2336. }
  2337. }
  2338. $acldenied = ACLController::disabledModuleList($listArray,false);
  2339. foreach($acldenied as $denied){
  2340. unset($returnArray[$denied]);
  2341. }
  2342. asort($returnArray);
  2343. return $returnArray;
  2344. }
  2345. function display_notice($msg = false){
  2346. global $error_notice;
  2347. //no error notice - lets just display the error to the user
  2348. if(!isset($error_notice)){
  2349. echo '<br>'.$msg . '<br>';
  2350. }else{
  2351. $error_notice .= $msg . '<br>';
  2352. }
  2353. }
  2354. /* checks if it is a number that at least has the plus at the beginning.
  2355. */
  2356. function skype_formatted($number){
  2357. //kbrill - BUG #15375
  2358. if(isset($_REQUEST['action']) && $_REQUEST['action']=="Popup") {
  2359. return false;
  2360. } else {
  2361. return substr($number, 0, 1) == '+' || substr($number, 0, 2) == '00' || substr($number, 0, 3) == '011';
  2362. }
  2363. // return substr($number, 0, 1) == '+' || substr($number, 0, 2) == '00' || substr($number, 0, 2) == '011';
  2364. }
  2365. function format_skype($number) {
  2366. return preg_replace('/[^\+0-9]/','',$number);
  2367. }
  2368. function insert_charset_header() {
  2369. header('Content-Type: text/html; charset=UTF-8');
  2370. }
  2371. function getCurrentURL()
  2372. {
  2373. $href = "http:";
  2374. if(!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on')
  2375. {
  2376. $href = 'https:';
  2377. }
  2378. $href.= "//".$_SERVER['HTTP_HOST'].$_SERVER['SCRIPT_NAME'].'?'.$_SERVER['QUERY_STRING'];
  2379. return $href;
  2380. }
  2381. function javascript_escape($str) {
  2382. $new_str = '';
  2383. for($i = 0; $i < strlen($str); $i++) {
  2384. if(ord(substr($str, $i, 1))==10){
  2385. $new_str .= '\n';
  2386. }elseif(ord(substr($str, $i, 1))==13){
  2387. $new_str .= '\r';
  2388. }
  2389. else {
  2390. $new_str .= $str{$i};
  2391. }
  2392. }
  2393. $new_str = str_replace("'", "\\'", $new_str);
  2394. return $new_str;
  2395. }
  2396. function js_escape($str, $keep=true){
  2397. $str = html_entity_decode(str_replace("\\", "", $str), ENT_QUOTES);
  2398. if($keep){
  2399. $str = javascript_escape($str);
  2400. }
  2401. else {
  2402. $str = str_replace("'", " ", $str);
  2403. $str = str_replace('"', " ", $str);
  2404. }
  2405. return $str;
  2406. //end function js_escape
  2407. }
  2408. function br2nl($str) {
  2409. $regex = "#<[^>]+br.+?>#i";
  2410. preg_match_all($regex, $str, $matches);
  2411. foreach($matches[0] as $match) {
  2412. $str = str_replace($match, "<br>", $str);
  2413. }
  2414. $brs = array('<br>','<br/>', '<br />');
  2415. $str = str_replace("\r\n", "\n", $str); // make from windows-returns, *nix-returns
  2416. $str = str_replace("\n\r", "\n", $str); // make from windows-returns, *nix-returns
  2417. $str = str_replace("\r", "\n", $str); // make from windows-returns, *nix-returns
  2418. $str = str_ireplace($brs, "\n", $str); // to retrieve it
  2419. return $str;
  2420. }
  2421. /**
  2422. * Private helper function for displaying the contents of a given variable.
  2423. * This function is only intended to be used for SugarCRM internal development.
  2424. * The ppd stands for Pre Print Die.
  2425. */
  2426. function _ppd($mixed)
  2427. {
  2428. }
  2429. /**
  2430. * Private helper function for displaying the contents of a given variable in
  2431. * the Logger. This function is only intended to be used for SugarCRM internal
  2432. * development. The pp stands for Pre Print.
  2433. * @param $mixed var to print_r()
  2434. * @param $die boolean end script flow
  2435. * @param $displayStackTrace also show stack trace
  2436. */
  2437. function _ppl($mixed, $die=false, $displayStackTrace=false, $loglevel="fatal") {
  2438. if(!isset($GLOBALS['log']) || empty($GLOBALS['log'])) {
  2439. $GLOBALS['log'] = LoggerManager :: getLogger('SugarCRM');
  2440. }
  2441. $mix = print_r($mixed, true); // send print_r() output to $mix
  2442. $stack = debug_backtrace();
  2443. $GLOBALS['log']->$loglevel('------------------------------ _ppLogger() output start -----------------------------');
  2444. $GLOBALS['log']->$loglevel($mix);
  2445. if($displayStackTrace) {
  2446. foreach($stack as $position) {
  2447. $GLOBALS['log']->$loglevel($position['file']."({$position['line']})");
  2448. }
  2449. }
  2450. $GLOBALS['log']->$loglevel('------------------------------ _ppLogger() output end -----------------------------');
  2451. $GLOBALS['log']->$loglevel('------------------------------ _ppLogger() file: '.$stack[0]['file'].' line#: '.$stack[0]['line'].'-----------------------------');
  2452. if($die) {
  2453. die();
  2454. }
  2455. }
  2456. /**
  2457. * private helper function to quickly show the major, direct, field attributes of a given bean.
  2458. * The ppf stands for Pre[formatted] Print Focus [object]
  2459. * @param object bean The focus bean
  2460. */
  2461. function _ppf($bean, $die=false) {
  2462. }
  2463. /**
  2464. * Private helper function for displaying the contents of a given variable.
  2465. * This function is only intended to be used for SugarCRM internal development.
  2466. * The pp stands for Pre Print.
  2467. */
  2468. function _pp($mixed)
  2469. {
  2470. }
  2471. /**
  2472. * Private helper function for displaying the contents of a given variable.
  2473. * This function is only intended to be used for SugarCRM internal development.
  2474. * The pp stands for Pre Print.
  2475. */
  2476. function _pstack_trace($mixed=NULL)
  2477. {
  2478. }
  2479. /**
  2480. * Private helper function for displaying the contents of a given variable.
  2481. * This function is only intended to be used for SugarCRM internal development.
  2482. * The pp stands for Pre Print Trace.
  2483. */
  2484. function _ppt($mixed, $textOnly=false)
  2485. {
  2486. }
  2487. /**
  2488. * Private helper function for displaying the contents of a given variable.
  2489. * This function is only intended to be used for SugarCRM internal development.
  2490. * The pp stands for Pre Print Trace Die.
  2491. */
  2492. function _pptd($mixed)
  2493. {
  2494. }
  2495. /**
  2496. * Private helper function for decoding javascript UTF8
  2497. * This function is only intended to be used for SugarCRM internal development.
  2498. */
  2499. function decodeJavascriptUTF8($str) {
  2500. }
  2501. /**
  2502. * Will check if a given PHP version string is supported (tested on this ver),
  2503. * unsupported (results unknown), or invalid (something will break on this
  2504. * ver). Do not pass in any pararameter to default to a check against the
  2505. * current environment's PHP version.
  2506. *
  2507. * @return 1 implies supported, 0 implies unsupported, -1 implies invalid
  2508. */
  2509. function check_php_version($sys_php_version = '') {
  2510. $sys_php_version = empty($sys_php_version) ? constant('PHP_VERSION') : $sys_php_version;
  2511. // versions below $min_considered_php_version considered invalid by default,
  2512. // versions equal to or above this ver will be considered depending
  2513. // on the rules that follow
  2514. $min_considered_php_version = '5.2.2';
  2515. // only the supported versions,
  2516. // should be mutually exclusive with $invalid_php_versions
  2517. $supported_php_versions = array (
  2518. '5.2.2', '5.2.3', '5.2.4', '5.2.5', '5.2.6', '5.2.8', '5.3.0'
  2519. );
  2520. // invalid versions above the $min_considered_php_version,
  2521. // should be mutually exclusive with $supported_php_versions
  2522. // SugarCRM prohibits install on PHP 5.2.7 on all platforms
  2523. $invalid_php_versions = array('5.2.7');
  2524. // default unsupported
  2525. $retval = 0;
  2526. // versions below $min_considered_php_version are invalid
  2527. if(1 == version_compare($sys_php_version, $min_considered_php_version, '<')) {
  2528. $retval = -1;
  2529. }
  2530. // supported version check overrides default unsupported
  2531. foreach($supported_php_versions as $ver) {
  2532. if(1 == version_compare($sys_php_version, $ver, 'eq') || strpos($sys_php_version,$ver) !== false) {
  2533. $retval = 1;
  2534. break;
  2535. }
  2536. }
  2537. // invalid version check overrides default unsupported
  2538. foreach($invalid_php_versions as $ver) {
  2539. if(1 == version_compare($sys_php_version, $ver, 'eq') && strpos($sys_php_version,$ver) !== false) {
  2540. $retval = -1;
  2541. break;
  2542. }
  2543. }
  2544. //allow a redhat distro to install, regardless of version. We are assuming the redhat naming convention is followed
  2545. //and the php version contains 'rh' characters
  2546. if(strpos($sys_php_version, 'rh') !== false) {
  2547. $retval = 1;
  2548. }
  2549. return $retval;
  2550. }
  2551. /**
  2552. * Will check if a given IIS version string is supported (tested on this ver),
  2553. * unsupported (results unknown), or invalid (something will break on this
  2554. * ver).
  2555. *
  2556. * @return 1 implies supported, 0 implies unsupported, -1 implies invalid
  2557. */
  2558. function check_iis_version($sys_iis_version = '') {
  2559. $server_software = $_SERVER["SERVER_SOFTWARE"];
  2560. $iis_version = '';
  2561. if(strpos($server_software,'Microsoft-IIS') !== false && preg_match_all("/^.*\/(\d+\.?\d*)$/", $server_software, $out))
  2562. $iis_version = $out[1][0];
  2563. $sys_iis_version = empty($sys_iis_version) ? $iis_version : $sys_iis_version;
  2564. // versions below $min_considered_iis_version considered invalid by default,
  2565. // versions equal to or above this ver will be considered depending
  2566. // on the rules that follow
  2567. $min_considered_iis_version = '6.0';
  2568. // only the supported versions,
  2569. // should be mutually exclusive with $invalid_iis_versions
  2570. $supported_iis_versions = array ('6.0', '7.0',);
  2571. $unsupported_iis_versions = array();
  2572. $invalid_iis_versions = array('5.0',);
  2573. // default unsupported
  2574. $retval = 0;
  2575. // versions below $min_considered_iis_version are invalid
  2576. if(1 == version_compare($sys_iis_version, $min_considered_iis_version, '<')) {
  2577. $retval = -1;
  2578. }
  2579. // supported version check overrides default unsupported
  2580. foreach($supported_iis_versions as $ver) {
  2581. if(1 == version_compare($sys_iis_version, $ver, 'eq') || strpos($sys_iis_version,$ver) !== false) {
  2582. $retval = 1;
  2583. break;
  2584. }
  2585. }
  2586. // unsupported version check overrides default unsupported
  2587. foreach($unsupported_iis_versions as $ver) {
  2588. if(1 == version_compare($sys_iis_version, $ver, 'eq') && strpos($sys_iis_version,$ver) !== false) {
  2589. $retval = 0;
  2590. break;
  2591. }
  2592. }
  2593. // invalid version check overrides default unsupported
  2594. foreach($invalid_iis_versions as $ver) {
  2595. if(1 == version_compare($sys_iis_version, $ver, 'eq') && strpos($sys_iis_version,$ver) !== false) {
  2596. $retval = -1;
  2597. break;
  2598. }
  2599. }
  2600. return $retval;
  2601. }
  2602. function pre_login_check(){
  2603. global $action, $login_error;
  2604. if(!empty($action)&& $action == 'Login'){
  2605. if(!empty($login_error)){
  2606. $login_error = htmlentities($login_error);
  2607. $login_error = str_replace(array("&lt;pre&gt;","&lt;/pre&gt;","\r\n", "\n"), "<br>", $login_error);
  2608. $_SESSION['login_error'] = $login_error;
  2609. echo '<script>
  2610. function set_focus() {}
  2611. if(document.getElementById("post_error")) {
  2612. document.getElementById("post_error").innerHTML="'. $login_error. '";
  2613. document.getElementById("cant_login").value=1;
  2614. document.getElementById("login_button").disabled = true;
  2615. document.getElementById("user_name").disabled = true;
  2616. //document.getElementById("user_password").disabled = true;
  2617. }
  2618. </script>';
  2619. }
  2620. }
  2621. }
  2622. function sugar_cleanup($exit = false) {
  2623. static $called = false;
  2624. if($called)return;
  2625. $called = true;
  2626. set_include_path(realpath(dirname(__FILE__) . '/..') . PATH_SEPARATOR . get_include_path());
  2627. chdir(realpath(dirname(__FILE__) . '/..'));
  2628. global $sugar_config;
  2629. require_once('include/utils/LogicHook.php');
  2630. LogicHook::initialize();
  2631. $GLOBALS['logic_hook']->call_custom_logic('', 'server_round_trip');
  2632. //added this check to avoid errors during install.
  2633. if (empty($sugar_config['dbconfig'])) {
  2634. if ($exit) exit; else return;
  2635. }
  2636. if (!class_exists('Tracker', true)) {
  2637. require_once 'modules/Trackers/Tracker.php';
  2638. }
  2639. Tracker::logPage();
  2640. // Now write the cached tracker_queries
  2641. if(!empty($GLOBALS['savePreferencesToDB']) && $GLOBALS['savePreferencesToDB']) {
  2642. if ( isset($GLOBALS['current_user']) && $GLOBALS['current_user'] instanceOf User )
  2643. $GLOBALS['current_user']->savePreferencesToDB();
  2644. }
  2645. //check to see if this is not an `ajax call AND the user preference error flag is set
  2646. if(
  2647. (isset($_SESSION['USER_PREFRENCE_ERRORS']) && $_SESSION['USER_PREFRENCE_ERRORS'])
  2648. && ($_REQUEST['action']!='modulelistmenu' && $_REQUEST['action']!='DynamicAction')
  2649. && ($_REQUEST['action']!='favorites' && $_REQUEST['action']!='DynamicAction')
  2650. && (empty($_REQUEST['to_pdf']) || !$_REQUEST['to_pdf'] )
  2651. && (empty($_REQUEST['sugar_body_only']) || !$_REQUEST['sugar_body_only'] )
  2652. ){
  2653. global $app_strings;
  2654. //this is not an ajax call and the user preference error flag is set, so reset the flag and print js to flash message
  2655. $err_mess = $app_strings['ERROR_USER_PREFS'];
  2656. $_SESSION['USER_PREFRENCE_ERRORS'] = false;
  2657. echo "
  2658. <script>
  2659. ajaxStatus.flashStatus('$err_mess',7000);
  2660. </script>";
  2661. }
  2662. pre_login_check();
  2663. if(class_exists('DBManagerFactory')) {
  2664. $db = DBManagerFactory::getInstance();
  2665. $db->disconnect();
  2666. if($exit) {
  2667. exit;
  2668. }
  2669. }
  2670. }
  2671. register_shutdown_function('sugar_cleanup');
  2672. /*
  2673. check_logic_hook - checks to see if your custom logic is in the logic file
  2674. if not, it will add it. If the file isn't built yet, it will create the file
  2675. */
  2676. function check_logic_hook_file($module_name, $event, $action_array){
  2677. require_once('include/utils/logic_utils.php');
  2678. $add_logic = false;
  2679. if(file_exists("custom/modules/$module_name/logic_hooks.php")){
  2680. $hook_array = get_hook_array($module_name);
  2681. if(check_existing_element($hook_array, $event, $action_array)==true){
  2682. //the hook at hand is present, so do nothing
  2683. } else {
  2684. $add_logic = true;
  2685. $logic_count = 0;
  2686. if(!empty($hook_array[$event]))
  2687. {
  2688. $logic_count = count($hook_array[$event]);
  2689. }
  2690. if($action_array[0]==""){
  2691. $action_array[0] = $logic_count + 1;
  2692. }
  2693. $hook_array[$event][] = $action_array;
  2694. }
  2695. //end if the file exists already
  2696. } else {
  2697. $add_logic = true;
  2698. if($action_array[0]==""){
  2699. $action_array[0] = 1;
  2700. }
  2701. $hook_array = array();
  2702. $hook_array[$event][] = $action_array;
  2703. //end if else file exists already
  2704. }
  2705. if($add_logic == true){
  2706. //reorder array by element[0]
  2707. //$hook_array = reorder_array($hook_array, $event);
  2708. //!!!Finish this above TODO
  2709. $new_contents = replace_or_add_logic_type($hook_array);
  2710. write_logic_file($module_name, $new_contents);
  2711. //end if add_element is true
  2712. }
  2713. //end function check_logic_hook_file
  2714. }
  2715. function remove_logic_hook($module_name, $event, $action_array) {
  2716. require_once('include/utils/logic_utils.php');
  2717. $add_logic = false;
  2718. if(file_exists("custom/modules/".$module_name."/logic_hooks.php")){
  2719. // The file exists, let's make sure the hook is there
  2720. $hook_array = get_hook_array($module_name);
  2721. if(check_existing_element($hook_array, $event, $action_array)==true){
  2722. // The hook is there, time to take it out.
  2723. foreach ( $hook_array[$event] as $i => $hook ) {
  2724. // We don't do a full comparison below just in case the filename changes
  2725. if ( $hook[0] == $action_array[0]
  2726. && $hook[1] == $action_array[1]
  2727. && $hook[3] == $action_array[3]
  2728. && $hook[4] == $action_array[4] ) {
  2729. unset($hook_array[$event][$i]);
  2730. }
  2731. }
  2732. $new_contents = replace_or_add_logic_type($hook_array);
  2733. write_logic_file($module_name, $new_contents);
  2734. }
  2735. }
  2736. }
  2737. function display_stack_trace($textOnly=false){
  2738. $stack = debug_backtrace();
  2739. echo "\n\n display_stack_trace caller, file: " . $stack[0]['file']. ' line#: ' .$stack[0]['line'];
  2740. if(!$textOnly)
  2741. echo '<br>';
  2742. $first = true;
  2743. $out = '';
  2744. foreach($stack as $item) {
  2745. $file = '';
  2746. $class = '';
  2747. $line = '';
  2748. $function = '';
  2749. if(isset($item['file']))
  2750. $file = $item['file'];
  2751. if(isset($item['class']))
  2752. $class = $item['class'];
  2753. if(isset($item['line']))
  2754. $line = $item['line'];
  2755. if(isset($item['function']))
  2756. $function = $item['function'];
  2757. if(!$first) {
  2758. if(!$textOnly) {
  2759. $out .= '<font color="black"><b>';
  2760. }
  2761. $out .= $file;
  2762. if(!$textOnly) {
  2763. $out .= '</b></font><font color="blue">';
  2764. }
  2765. $out .= "[L:{$line}]";
  2766. if(!$textOnly) {
  2767. $out .= '</font><font color="red">';
  2768. }
  2769. $out .= "({$class}:{$function})";
  2770. if(!$textOnly) {
  2771. $out .= '</font><br>';
  2772. } else {
  2773. $out .= "\n";
  2774. }
  2775. } else {
  2776. $first = false;
  2777. }
  2778. }
  2779. echo $out;
  2780. }
  2781. function StackTraceErrorHandler($errno, $errstr, $errfile,$errline, $errcontext) {
  2782. $error_msg = " $errstr occurred in <b>$errfile</b> on line $errline [" . date("Y-m-d H:i:s") . ']';
  2783. $halt_script = true;
  2784. switch($errno){
  2785. case 2048: return; //depricated we have lots of these ignore them
  2786. case E_USER_NOTICE:
  2787. case E_NOTICE:
  2788. if ( error_reporting() & E_NOTICE ) {
  2789. $halt_script = false;
  2790. $type = 'Notice';
  2791. }
  2792. else
  2793. return;
  2794. break;
  2795. case E_USER_WARNING:
  2796. case E_COMPILE_WARNING:
  2797. case E_CORE_WARNING:
  2798. case E_WARNING:
  2799. $halt_script = false;
  2800. $type = "Warning";
  2801. break;
  2802. case E_USER_ERROR:
  2803. case E_COMPILE_ERROR:
  2804. case E_CORE_ERROR:
  2805. case E_ERROR:
  2806. $type = "Fatal Error";
  2807. break;
  2808. case E_PARSE:
  2809. $type = "Parse Error";
  2810. break;
  2811. default:
  2812. //don't know what it is might not be so bad
  2813. $halt_script = false;
  2814. $type = "Unknown Error ($errno)";
  2815. break;
  2816. }
  2817. $error_msg = '<b>'.$type.'</b>:' . $error_msg;
  2818. echo $error_msg;
  2819. display_stack_trace();
  2820. if($halt_script){
  2821. exit -1;
  2822. }
  2823. }
  2824. if(isset($sugar_config['stack_trace_errors']) && $sugar_config['stack_trace_errors']){
  2825. set_error_handler('StackTraceErrorHandler');
  2826. }
  2827. function get_sub_cookies($name){
  2828. $cookies = array();
  2829. if(isset($_COOKIE[$name])){
  2830. $subs = explode('#', $_COOKIE[$name]);
  2831. foreach($subs as $cookie){
  2832. if(!empty($cookie)){
  2833. $cookie = explode('=', $cookie);
  2834. $cookies[$cookie[0]] = $cookie[1];
  2835. }
  2836. }
  2837. }
  2838. return $cookies;
  2839. }
  2840. function mark_delete_components($sub_object_array, $run_second_level=false, $sub_sub_array=""){
  2841. if(!empty($sub_object_array)){
  2842. foreach($sub_object_array as $sub_object){
  2843. //run_second level is set to true if you need to remove sub-sub components
  2844. if($run_second_level==true){
  2845. mark_delete_components($sub_object->get_linked_beans($sub_sub_array['rel_field'],$sub_sub_array['rel_module']));
  2846. //end if run_second_level is true
  2847. }
  2848. $sub_object->mark_deleted($sub_object->id);
  2849. //end foreach sub component
  2850. }
  2851. //end if this is not empty
  2852. }
  2853. //end function mark_delete_components
  2854. }
  2855. /**
  2856. * For translating the php.ini memory values into bytes. e.g. input value of '8M' will return 8388608.
  2857. */
  2858. function return_bytes($val)
  2859. {
  2860. $val = trim($val);
  2861. $last = strtolower($val{strlen($val)-1});
  2862. switch($last)
  2863. {
  2864. // The 'G' modifier is available since PHP 5.1.0
  2865. case 'g':
  2866. $val *= 1024;
  2867. case 'm':
  2868. $val *= 1024;
  2869. case 'k':
  2870. $val *= 1024;
  2871. }
  2872. return $val;
  2873. }
  2874. /**
  2875. * Adds the href HTML tags around any URL in the $string
  2876. */
  2877. function url2html($string) {
  2878. //
  2879. $return_string = preg_replace('/(\w+:\/\/)(\S+)/', ' <a href="\\1\\2" target="_new" style="font-weight: normal;">\\1\\2</a>', $string);
  2880. return $return_string;
  2881. }
  2882. // End customization by Julian
  2883. /**
  2884. * tries to determine whether the Host machine is a Windows machine
  2885. */
  2886. function is_windows() {
  2887. static $is_windows = null;
  2888. if (!isset($is_windows)) {
  2889. $is_windows = strtoupper(substr(PHP_OS, 0, 3)) == 'WIN';
  2890. }
  2891. return $is_windows;
  2892. }
  2893. /**
  2894. * equivalent for windows filesystem for PHP's is_writable()
  2895. * @param string file Full path to the file/dir
  2896. * @return bool true if writable
  2897. */
  2898. function is_writable_windows($file) {
  2899. if($file{strlen($file)-1}=='/') {
  2900. return is_writable_windows($file.uniqid(mt_rand()).'.tmp');
  2901. }
  2902. // the assumption here is that Windows has an inherited permissions scheme
  2903. // any file that is a descendant of an unwritable directory will inherit
  2904. // that property and will trigger a failure below.
  2905. if(is_dir($file)) {
  2906. return true;
  2907. }
  2908. $file = str_replace("/", '\\', $file);
  2909. if(file_exists($file)) {
  2910. if (!($f = @sugar_fopen($file, 'r+')))
  2911. return false;
  2912. fclose($f);
  2913. return true;
  2914. }
  2915. if(!($f = @sugar_fopen($file, 'w')))
  2916. return false;
  2917. fclose($f);
  2918. unlink($file);
  2919. return true;
  2920. }
  2921. /**
  2922. * best guesses Timezone based on webserver's TZ settings
  2923. */
  2924. function lookupTimezone($userOffset = 0)
  2925. {
  2926. return TimeDate::guessTimezone($userOffset);
  2927. }
  2928. function convert_module_to_singular($module_array){
  2929. global $beanList;
  2930. foreach($module_array as $key => $value){
  2931. if(!empty($beanList[$value])) $module_array[$key] = $beanList[$value];
  2932. if($value=="Cases") {
  2933. $module_array[$key] = "Case";
  2934. }
  2935. if($key=="projecttask"){
  2936. $module_array['ProjectTask'] = "Project Task";
  2937. unset($module_array[$key]);
  2938. }
  2939. }
  2940. return $module_array;
  2941. //end function convert_module_to_singular
  2942. }
  2943. /*
  2944. * Given the bean_name which may be plural or singular return the singular
  2945. * bean_name. This is important when you need to include files.
  2946. */
  2947. function get_singular_bean_name($bean_name){
  2948. global $beanFiles, $beanList;
  2949. if(array_key_exists($bean_name, $beanList)){
  2950. return $beanList[$bean_name];
  2951. }
  2952. else{
  2953. return $bean_name;
  2954. }
  2955. }
  2956. /*
  2957. * Given the potential module name (singular name, renamed module name)
  2958. * Return the real internal module name.
  2959. */
  2960. function get_module_from_singular($singular) {
  2961. // find the internal module name for a singular name
  2962. if (isset($GLOBALS['app_list_strings']['moduleListSingular'])) {
  2963. $singular_modules = $GLOBALS['app_list_strings']['moduleListSingular'];
  2964. foreach ($singular_modules as $mod_name=>$sin_name) {
  2965. if ($singular == $sin_name and $mod_name != $sin_name) {
  2966. return $mod_name;
  2967. }
  2968. }
  2969. }
  2970. // find the internal module name for a renamed module
  2971. if (isset($GLOBALS['app_list_strings']['moduleList'])) {
  2972. $moduleList = $GLOBALS['app_list_strings']['moduleList'];
  2973. foreach ($moduleList as $mod_name=>$name) {
  2974. if ($singular == $name and $mod_name != $name) {
  2975. return $mod_name;
  2976. }
  2977. }
  2978. }
  2979. // if it's not a singular name, nor a renamed name, return the original value
  2980. return $singular;
  2981. }
  2982. function get_label($label_tag, $temp_module_strings){
  2983. global $app_strings;
  2984. if(!empty($temp_module_strings[$label_tag])){
  2985. $label_name = $temp_module_strings[$label_tag];
  2986. } else {
  2987. if(!empty($app_strings[$label_tag])){
  2988. $label_name = $app_strings[$label_tag];
  2989. } else {
  2990. $label_name = $label_tag;
  2991. }
  2992. }
  2993. return $label_name;
  2994. //end function get_label
  2995. }
  2996. function search_filter_rel_info(& $focus, $tar_rel_module, $relationship_name){
  2997. $rel_list = array();
  2998. foreach($focus->relationship_fields as $rel_key => $rel_value){
  2999. if($rel_value == $relationship_name){
  3000. $temp_bean = get_module_info($tar_rel_module);
  3001. // echo $focus->$rel_key;
  3002. $temp_bean->retrieve($focus->$rel_key);
  3003. if($temp_bean->id!=""){
  3004. $rel_list[] = $temp_bean;
  3005. return $rel_list;
  3006. }
  3007. }
  3008. }
  3009. foreach($focus->field_defs as $field_name => $field_def){
  3010. //Check if the relationship_name matches a "relate" field
  3011. if(!empty($field_def['type']) && $field_def['type'] == 'relate'
  3012. && !empty($field_def['id_name']) && !empty($focus->field_defs[$field_def['id_name']])
  3013. && !empty($focus->field_defs[$field_def['id_name']]['relationship'])
  3014. && $focus->field_defs[$field_def['id_name']]['relationship'] == $relationship_name)
  3015. {
  3016. $temp_bean = get_module_info($tar_rel_module);
  3017. // echo $focus->$field_def['id_name'];
  3018. $temp_bean->retrieve($focus->$field_def['id_name']);
  3019. if($temp_bean->id!=""){
  3020. $rel_list[] = $temp_bean;
  3021. return $rel_list;
  3022. }
  3023. //Check if the relationship_name matches a "link" in a relate field
  3024. } else if(!empty($rel_value['link']) && !empty($rel_value['id_name']) && $rel_value['link'] == $relationship_name){
  3025. $temp_bean = get_module_info($tar_rel_module);
  3026. // echo $focus->$rel_value['id_name'];
  3027. $temp_bean->retrieve($focus->$rel_value['id_name']);
  3028. if($temp_bean->id!=""){
  3029. $rel_list[] = $temp_bean;
  3030. return $rel_list;
  3031. }
  3032. }
  3033. }
  3034. // special case for unlisted parent-type relationships
  3035. if( !empty($focus->parent_type) && $focus->parent_type == $tar_rel_module && !empty($focus->parent_id)) {
  3036. $temp_bean = get_module_info($tar_rel_module);
  3037. $temp_bean->retrieve($focus->parent_id);
  3038. if($temp_bean->id!=""){
  3039. $rel_list[] = $temp_bean;
  3040. return $rel_list;
  3041. }
  3042. }
  3043. return $rel_list;
  3044. //end function search_filter_rel_info
  3045. }
  3046. function get_module_info($module_name){
  3047. global $beanList;
  3048. global $dictionary;
  3049. //Get dictionary and focus data for module
  3050. $vardef_name = $beanList[$module_name];
  3051. if($vardef_name=="aCase"){
  3052. $class_name = "Case";
  3053. } else {
  3054. $class_name = $vardef_name;
  3055. }
  3056. if(!file_exists('modules/'. $module_name . '/'.$class_name.'.php')){
  3057. return;
  3058. }
  3059. include_once('modules/'. $module_name . '/'.$class_name.'.php');
  3060. $module_bean = new $vardef_name();
  3061. return $module_bean;
  3062. //end function get_module_table
  3063. }
  3064. /**
  3065. * In order to have one place to obtain the proper object name. aCase for example causes issues throughout the application.
  3066. *
  3067. * @param string $moduleName
  3068. */
  3069. function get_valid_bean_name($module_name){
  3070. global $beanList;
  3071. $vardef_name = $beanList[$module_name];
  3072. if($vardef_name=="aCase"){
  3073. $bean_name = "Case";
  3074. } else {
  3075. $bean_name = $vardef_name;
  3076. }
  3077. return $bean_name;
  3078. }
  3079. function checkAuthUserStatus(){
  3080. //authUserStatus();
  3081. }
  3082. /**
  3083. * This function returns an array of phpinfo() results that can be parsed and
  3084. * used to figure out what version we run, what modules are compiled in, etc.
  3085. * @param $level int info level constant (1,2,4,8...64);
  3086. * @return $returnInfo array array of info about the PHP environment
  3087. * @author original by "code at adspeed dot com" Fron php.net
  3088. * @author customized for Sugar by Chris N.
  3089. */
  3090. function getPhpInfo($level=-1) {
  3091. /** Name (constant) Value Description
  3092. INFO_GENERAL 1 The configuration line, php.ini location, build date, Web Server, System and more.
  3093. INFO_CREDITS 2 PHP Credits. See also phpcredits().
  3094. INFO_CONFIGURATION 4 Current Local and Master values for PHP directives. See also ini_get().
  3095. INFO_MODULES 8 Loaded modules and their respective settings. See also get_loaded_extensions().
  3096. INFO_ENVIRONMENT 16 Environment Variable information that's also available in $_ENV.
  3097. INFO_VARIABLES 32 Shows all predefined variables from EGPCS (Environment, GET, POST, Cookie, Server).
  3098. INFO_LICENSE 64 PHP License information. See also the license FAQ.
  3099. INFO_ALL -1 Shows all of the above. This is the default value.
  3100. */
  3101. ob_start();
  3102. phpinfo($level);
  3103. $phpinfo = ob_get_contents();
  3104. ob_end_clean();
  3105. $phpinfo = strip_tags($phpinfo,'<h1><h2><th><td>');
  3106. $phpinfo = preg_replace('/<th[^>]*>([^<]+)<\/th>/',"<info>\\1</info>",$phpinfo);
  3107. $phpinfo = preg_replace('/<td[^>]*>([^<]+)<\/td>/',"<info>\\1</info>",$phpinfo);
  3108. $parsedInfo = preg_split('/(<h.?>[^<]+<\/h.>)/', $phpinfo, -1, PREG_SPLIT_DELIM_CAPTURE);
  3109. $match = '';
  3110. $version = '';
  3111. $returnInfo = array();
  3112. if(preg_match('/<h1 class\=\"p\">PHP Version ([^<]+)<\/h1>/', $phpinfo, $version)) {
  3113. $returnInfo['PHP Version'] = $version[1];
  3114. }
  3115. for ($i=1; $i<count($parsedInfo); $i++) {
  3116. if (preg_match('/<h.>([^<]+)<\/h.>/', $parsedInfo[$i], $match)) {
  3117. $vName = trim($match[1]);
  3118. $parsedInfo2 = explode("\n",$parsedInfo[$i+1]);
  3119. foreach ($parsedInfo2 AS $vOne) {
  3120. $vPat = '<info>([^<]+)<\/info>';
  3121. $vPat3 = "/$vPat\s*$vPat\s*$vPat/";
  3122. $vPat2 = "/$vPat\s*$vPat/";
  3123. if (preg_match($vPat3,$vOne,$match)) { // 3cols
  3124. $returnInfo[$vName][trim($match[1])] = array(trim($match[2]),trim($match[3]));
  3125. } elseif (preg_match($vPat2,$vOne,$match)) { // 2cols
  3126. $returnInfo[$vName][trim($match[1])] = trim($match[2]);
  3127. }
  3128. }
  3129. } elseif(true) {
  3130. }
  3131. }
  3132. return $returnInfo;
  3133. }
  3134. /**
  3135. * This function will take a string that has tokens like {0}, {1} and will replace
  3136. * those tokens with the args provided
  3137. * @param $format string to format
  3138. * @param $args args to replace
  3139. * @return $result a formatted string
  3140. */
  3141. function string_format($format, $args){
  3142. $result = $format;
  3143. /** Bug47277 fix.
  3144. * If args array has only one argument, and it's empty, so empty single quotes are used '' . That's because
  3145. * IN () fails and IN ('') works.
  3146. */
  3147. if (count($args) == 1)
  3148. {
  3149. reset($args);
  3150. $singleArgument = current($args);
  3151. if (empty($singleArgument))
  3152. {
  3153. return str_replace("{0}", "''", $result);
  3154. }
  3155. }
  3156. /* End of fix */
  3157. for($i = 0; $i < count($args); $i++){
  3158. $result = str_replace('{'.$i.'}', $args[$i], $result);
  3159. }
  3160. return $result;
  3161. }
  3162. /**
  3163. * Generate a string for displaying a unique identifier that is composed
  3164. * of a system_id and number. This is use to allow us to generate quote
  3165. * numbers using a DB auto-increment key from offline clients and still
  3166. * have the number be unique (since it is modified by the system_id.
  3167. *
  3168. * @param $num of bean
  3169. * @param $system_id from system
  3170. * @return $result a formatted string
  3171. */
  3172. function format_number_display($num, $system_id){
  3173. global $sugar_config;
  3174. if(isset($num) && !empty($num)){
  3175. $num=unformat_number($num);
  3176. if(isset($system_id) && $system_id == 1){
  3177. return sprintf("%d", $num);
  3178. }
  3179. else{
  3180. return sprintf("%d-%d", $num, $system_id);
  3181. }
  3182. }
  3183. }
  3184. function checkLoginUserStatus(){
  3185. }
  3186. /**
  3187. * This function will take a number and system_id and format
  3188. * @param $url URL containing host to append port
  3189. * @param $port the port number - if '' is passed, no change to url
  3190. * @return $resulturl the new URL with the port appended to the host
  3191. */
  3192. function appendPortToHost($url, $port)
  3193. {
  3194. $resulturl = $url;
  3195. // if no port, don't change the url
  3196. if($port != '')
  3197. {
  3198. $split = explode("/", $url);
  3199. //check if it starts with http, in case they didn't include that in url
  3200. if(str_begin($url, 'http'))
  3201. {
  3202. //third index ($split[2]) will be the host
  3203. $split[2] .= ":".$port;
  3204. }
  3205. else // otherwise assumed to start with host name
  3206. {
  3207. //first index ($split[0]) will be the host
  3208. $split[0] .= ":".$port;
  3209. }
  3210. $resulturl = implode("/", $split);
  3211. }
  3212. return $resulturl;
  3213. }
  3214. /**
  3215. * Singleton to return JSON object
  3216. * @return JSON object
  3217. */
  3218. function getJSONobj() {
  3219. static $json = null;
  3220. if(!isset($json)) {
  3221. require_once('include/JSON.php');
  3222. $json = new JSON(JSON_LOOSE_TYPE);
  3223. }
  3224. return $json;
  3225. }
  3226. require_once('include/utils/db_utils.php');
  3227. /**
  3228. * Set default php.ini settings for entry points
  3229. */
  3230. function setPhpIniSettings() {
  3231. // zlib module
  3232. // Bug 37579 - Comment out force enabling zlib.output_compression, since it can cause problems on certain hosts
  3233. /*
  3234. if(function_exists('gzclose') && headers_sent() == false) {
  3235. ini_set('zlib.output_compression', 1);
  3236. }
  3237. */
  3238. // mbstring module
  3239. //nsingh: breaks zip/unzip functionality. Commenting out 4/23/08
  3240. /*if(function_exists('mb_strlen')) {
  3241. ini_set('mbstring.func_overload', 7);
  3242. ini_set('mbstring.internal_encoding', 'UTF-8');
  3243. }*/
  3244. // http://us3.php.net/manual/en/ref.pcre.php#ini.pcre.backtrack-limit
  3245. // starting with 5.2.0, backtrack_limit breaks JSON decoding
  3246. $backtrack_limit = ini_get('pcre.backtrack_limit');
  3247. if(!empty($backtrack_limit)) {
  3248. ini_set('pcre.backtrack_limit', '-1');
  3249. }
  3250. }
  3251. /**
  3252. * Identical to sugarArrayMerge but with some speed improvements and used specifically to merge
  3253. * language files. Language file merges do not need to account for null values so we can get some
  3254. * performance increases by using this specialized function. Note this merge function does not properly
  3255. * handle null values.
  3256. *
  3257. * @param $gimp
  3258. * @param $dom
  3259. * @return array
  3260. */
  3261. function sugarLangArrayMerge($gimp, $dom)
  3262. {
  3263. if(is_array($gimp) && is_array($dom))
  3264. {
  3265. foreach($dom as $domKey => $domVal)
  3266. {
  3267. if(isset($gimp[$domKey]))
  3268. {
  3269. if(is_array($domVal))
  3270. {
  3271. $tempArr = array();
  3272. foreach ( $domVal as $domArrKey => $domArrVal )
  3273. $tempArr[$domArrKey] = $domArrVal;
  3274. foreach ( $gimp[$domKey] as $gimpArrKey => $gimpArrVal )
  3275. if ( !isset($tempArr[$gimpArrKey]) )
  3276. $tempArr[$gimpArrKey] = $gimpArrVal;
  3277. $gimp[$domKey] = $tempArr;
  3278. }
  3279. else
  3280. {
  3281. $gimp[$domKey] = $domVal;
  3282. }
  3283. }
  3284. else
  3285. {
  3286. $gimp[$domKey] = $domVal;
  3287. }
  3288. }
  3289. }
  3290. // if the passed value for gimp isn't an array, then return the $dom
  3291. elseif(is_array($dom))
  3292. {
  3293. return $dom;
  3294. }
  3295. return $gimp;
  3296. }
  3297. /**
  3298. * like array_merge() but will handle array elements that are themselves arrays;
  3299. * PHP's version just overwrites the element with the new one.
  3300. *
  3301. * @internal Note that this function deviates from the internal array_merge()
  3302. * functions in that it does does not treat numeric keys differently
  3303. * than string keys. Additionally, it deviates from
  3304. * array_merge_recursive() by not creating an array when like values
  3305. * found.
  3306. *
  3307. * @param array gimp the array whose values will be overloaded
  3308. * @param array dom the array whose values will pwn the gimp's
  3309. * @return array beaten gimp
  3310. */
  3311. function sugarArrayMerge($gimp, $dom) {
  3312. if(is_array($gimp) && is_array($dom)) {
  3313. foreach($dom as $domKey => $domVal) {
  3314. if(array_key_exists($domKey, $gimp)) {
  3315. if(is_array($domVal)) {
  3316. $tempArr = array();
  3317. foreach ( $domVal as $domArrKey => $domArrVal )
  3318. $tempArr[$domArrKey] = $domArrVal;
  3319. foreach ( $gimp[$domKey] as $gimpArrKey => $gimpArrVal )
  3320. if ( !array_key_exists($gimpArrKey, $tempArr) )
  3321. $tempArr[$gimpArrKey] = $gimpArrVal;
  3322. $gimp[$domKey] = $tempArr;
  3323. } else {
  3324. $gimp[$domKey] = $domVal;
  3325. }
  3326. } else {
  3327. $gimp[$domKey] = $domVal;
  3328. }
  3329. }
  3330. }
  3331. // if the passed value for gimp isn't an array, then return the $dom
  3332. elseif(is_array($dom))
  3333. return $dom;
  3334. return $gimp;
  3335. }
  3336. /**
  3337. * Similiar to sugarArrayMerge except arrays of N depth are merged.
  3338. *
  3339. * @param array gimp the array whose values will be overloaded
  3340. * @param array dom the array whose values will pwn the gimp's
  3341. * @return array beaten gimp
  3342. */
  3343. function sugarArrayMergeRecursive($gimp, $dom) {
  3344. if(is_array($gimp) && is_array($dom)) {
  3345. foreach($dom as $domKey => $domVal) {
  3346. if(array_key_exists($domKey, $gimp)) {
  3347. if(is_array($domVal) && is_array($gimp[$domKey])) {
  3348. $gimp[$domKey] = sugarArrayMergeRecursive($gimp[$domKey], $domVal);
  3349. } else {
  3350. $gimp[$domKey] = $domVal;
  3351. }
  3352. } else {
  3353. $gimp[$domKey] = $domVal;
  3354. }
  3355. }
  3356. }
  3357. // if the passed value for gimp isn't an array, then return the $dom
  3358. elseif(is_array($dom))
  3359. return $dom;
  3360. return $gimp;
  3361. }
  3362. /**
  3363. * finds the correctly working versions of PHP-JSON
  3364. * @return bool True if NOT found or WRONG version
  3365. */
  3366. function returnPhpJsonStatus() {
  3367. if(function_exists('json_encode')) {
  3368. $phpInfo = getPhpInfo(8);
  3369. return version_compare($phpInfo['json']['json version'], '1.1.1', '<');
  3370. }
  3371. return true; // not found
  3372. }
  3373. /**
  3374. * getTrackerSubstring
  3375. *
  3376. * Returns a [number]-char or less string for the Tracker to display in the header
  3377. * based on the tracker_max_display_length setting in config.php. If not set,
  3378. * or invalid length, then defaults to 15 for COM editions, 30 for others.
  3379. *
  3380. * @param string name field for a given Object
  3381. * @return string [number]-char formatted string if length of string exceeds the max allowed
  3382. */
  3383. function getTrackerSubstring($name) {
  3384. static $max_tracker_item_length;
  3385. //Trim the name
  3386. $name = html_entity_decode($name, ENT_QUOTES, 'UTF-8');
  3387. $strlen = function_exists('mb_strlen') ? mb_strlen($name) : strlen($name);
  3388. global $sugar_config;
  3389. if(!isset($max_tracker_item_length)) {
  3390. if(isset($sugar_config['tracker_max_display_length'])) {
  3391. $max_tracker_item_length = (is_int($sugar_config['tracker_max_display_length']) && $sugar_config['tracker_max_display_length'] > 0 && $sugar_config['tracker_max_display_length'] < 50) ? $sugar_config['tracker_max_display_length'] : 15;
  3392. } else {
  3393. $max_tracker_item_length = 15;
  3394. }
  3395. }
  3396. if($strlen > $max_tracker_item_length) {
  3397. $chopped = function_exists('mb_substr') ? mb_substr($name, 0, $max_tracker_item_length-3, "UTF-8") : substr($name, 0, $max_tracker_item_length-3);
  3398. $chopped .= "...";
  3399. } else {
  3400. $chopped = $name;
  3401. }
  3402. return $chopped;
  3403. }
  3404. function generate_search_where ($field_list=array(),$values=array(),&$bean,$add_custom_fields=false,$module='') {
  3405. $where_clauses= array();
  3406. $like_char='%';
  3407. $table_name=$bean->object_name;
  3408. foreach ($field_list[$module] as $field=>$parms) {
  3409. if(isset($values[$field]) && $values[$field] != "") {
  3410. $operator='like';
  3411. if (!empty($parms['operator'])) {
  3412. $operator=$parms['operator'];
  3413. }
  3414. if (is_array($values[$field])) {
  3415. $operator='in';
  3416. $field_value='';
  3417. foreach ($values[$field] as $key => $val) {
  3418. if ($val != ' ' and $val != '') {
  3419. if (!empty($field_value)) {
  3420. $field_value.=',';
  3421. }
  3422. $field_value .= "'".$GLOBALS['db']->quote($val)."'";
  3423. }
  3424. }
  3425. } else {
  3426. $field_value=$GLOBALS['db']->quote($values[$field]);
  3427. }
  3428. //set db_fields array.
  3429. if (!isset($parms['db_field']) ) {
  3430. $parms['db_field'] = array($field);
  3431. }
  3432. if (isset($parms['my_items']) and $parms['my_items'] == true) {
  3433. global $current_user;
  3434. $field_value = $GLOBALS['db']->quote($current_user->id);
  3435. $operator='=';
  3436. }
  3437. $where='';
  3438. $itr=0;
  3439. if ($field_value != '') {
  3440. foreach ($parms['db_field'] as $db_field) {
  3441. if (strstr($db_field,'.')===false) {
  3442. $db_field=$bean->table_name.".".$db_field;
  3443. }
  3444. if ($GLOBALS['db']->supports('case_sensitive') && isset($parms['query_type']) && $parms['query_type']=='case_insensitive') {
  3445. $db_field='upper('.$db_field.")";
  3446. $field_value=strtoupper($field_value);
  3447. }
  3448. $itr++;
  3449. if (!empty($where)) {
  3450. $where .= " OR ";
  3451. }
  3452. switch (strtolower($operator)) {
  3453. case 'like' :
  3454. $where .= $db_field . " like '".$field_value.$like_char."'";
  3455. break;
  3456. case 'in':
  3457. $where .= $db_field . " in (".$field_value.')';
  3458. break;
  3459. case '=':
  3460. $where .= $db_field . " = '".$field_value ."'";
  3461. break;
  3462. }
  3463. }
  3464. }
  3465. if (!empty($where)) {
  3466. if ($itr>1) {
  3467. array_push($where_clauses, '( '.$where.' )');
  3468. } else {
  3469. array_push($where_clauses, $where);
  3470. }
  3471. }
  3472. }
  3473. }
  3474. if ($add_custom_fields) {
  3475. require_once('modules/DynamicFields/DynamicField.php');
  3476. $bean->setupCustomFields($module);
  3477. $bean->custom_fields->setWhereClauses($where_clauses);
  3478. }
  3479. return $where_clauses;
  3480. }
  3481. function add_quotes($str) {
  3482. return "'{$str}'";
  3483. }
  3484. /**
  3485. * This function will rebuild the config file
  3486. * @param $sugar_config
  3487. * @param $sugar_version
  3488. * @return bool true if successful
  3489. */
  3490. function rebuildConfigFile($sugar_config, $sugar_version) {
  3491. // add defaults to missing values of in-memory sugar_config
  3492. $sugar_config = sugarArrayMerge(get_sugar_config_defaults(), $sugar_config );
  3493. // need to override version with default no matter what
  3494. $sugar_config['sugar_version'] = $sugar_version;
  3495. ksort( $sugar_config );
  3496. if( write_array_to_file( "sugar_config", $sugar_config, "config.php" ) ){
  3497. return true;
  3498. }
  3499. else {
  3500. return false;
  3501. }
  3502. }
  3503. /**
  3504. * Loads clean configuration, not overridden by config_override.php
  3505. *
  3506. * @return array
  3507. */
  3508. function loadCleanConfig()
  3509. {
  3510. $sugar_config = array();
  3511. require 'config.php';
  3512. return $sugar_config;
  3513. }
  3514. /**
  3515. * getJavascriptSiteURL
  3516. * This function returns a URL for the client javascript calls to access
  3517. * the site. It uses $_SERVER['HTTP_REFERER'] in the event that Proxy servers
  3518. * are used to access the site. Thus, the hostname in the URL returned may
  3519. * not always match that of $sugar_config['site_url']. Basically, the
  3520. * assumption is that however the user accessed the website is how they
  3521. * will continue to with subsequent javascript requests. If the variable
  3522. * $_SERVER['HTTP_REFERER'] is not found then we default to old algorithm.
  3523. * @return $site_url The url used to refer to the website
  3524. */
  3525. function getJavascriptSiteURL() {
  3526. global $sugar_config;
  3527. if(!empty($_SERVER['HTTP_REFERER'])) {
  3528. $url = parse_url($_SERVER['HTTP_REFERER']);
  3529. $replacement_url = $url['scheme']."://".$url['host'];
  3530. if(!empty($url['port']))
  3531. $replacement_url .= ':'.$url['port'];
  3532. $site_url = preg_replace('/^http[s]?\:\/\/[^\/]+/',$replacement_url,$sugar_config['site_url']);
  3533. } else {
  3534. $site_url = preg_replace('/^http(s)?\:\/\/[^\/]+/',"http$1://".$_SERVER['HTTP_HOST'],$sugar_config['site_url']);
  3535. if(!empty($_SERVER['SERVER_PORT']) &&$_SERVER['SERVER_PORT'] == '443') {
  3536. $site_url = preg_replace('/^http\:/','https:',$site_url);
  3537. }
  3538. }
  3539. $GLOBALS['log']->debug("getJavascriptSiteURL(), site_url=". $site_url);
  3540. return $site_url;
  3541. }
  3542. // works nicely with array_map() -- can be used to wrap single quotes around each element in an array
  3543. function add_squotes($str) {
  3544. return "'" . $str . "'";
  3545. }
  3546. // recursive function to count the number of levels within an array
  3547. function array_depth($array, $depth_count=-1, $depth_array=array()){
  3548. $depth_count++;
  3549. if (is_array($array)){
  3550. foreach ($array as $key => $value){
  3551. $depth_array[] = array_depth($value, $depth_count);
  3552. }
  3553. }
  3554. else{
  3555. return $depth_count;
  3556. }
  3557. foreach ($depth_array as $value){
  3558. $depth_count = $value > $depth_count ? $value : $depth_count;
  3559. }
  3560. return $depth_count;
  3561. }
  3562. /**
  3563. * Creates a new Group User
  3564. * @param string $name Name of Group User
  3565. * @return string GUID of new Group User
  3566. */
  3567. function createGroupUser($name) {
  3568. $group = new User();
  3569. $group->user_name = $name;
  3570. $group->last_name = $name;
  3571. $group->is_group = 1;
  3572. $group->deleted = 0;
  3573. $group->status = 'Active'; // cn: bug 6711
  3574. $group->setPreference('timezone', TimeDate::userTimezone());
  3575. $group->save();
  3576. return $group->id;
  3577. }
  3578. /*
  3579. * Helper function to locate an icon file given only a name
  3580. * Searches through the various paths for the file
  3581. * @param string iconFileName The filename of the icon
  3582. * @return string Relative pathname of the located icon, or '' if not found
  3583. */
  3584. function _getIcon($iconFileName)
  3585. {
  3586. $iconName = "icon_{$iconFileName}.gif";
  3587. $iconFound = SugarThemeRegistry::current()->getImageURL($iconName,false);
  3588. //First try un-ucfirst-ing the icon name
  3589. if ( empty($iconFound) )
  3590. $iconName = "icon_" . strtolower(substr($iconFileName,0,1)).substr($iconFileName,1) . ".gif";
  3591. $iconFound = SugarThemeRegistry::current()->getImageURL($iconName,false);
  3592. //Next try removing the icon prefix
  3593. if ( empty($iconFound) )
  3594. $iconName = "{$iconFileName}.gif";
  3595. $iconFound = SugarThemeRegistry::current()->getImageURL($iconName,false);
  3596. if ( empty($iconFound) )
  3597. $iconName = '';
  3598. return $iconName;
  3599. }
  3600. /**
  3601. * Function to grab the correct icon image for Studio
  3602. * @param string $iconFileName Name of the icon file
  3603. * @param string $altfilename Name of a fallback icon file (displayed if the imagefilename doesn't exist)
  3604. * @param string $width Width of image
  3605. * @param string $height Height of image
  3606. * @param string $align Alignment of image
  3607. * @param string $alt Alt tag of image
  3608. * @return string $string <img> tag with corresponding image
  3609. */
  3610. function getStudioIcon($iconFileName='', $altFileName='', $width='48', $height='48', $align='baseline', $alt='' )
  3611. {
  3612. global $app_strings, $theme;
  3613. $iconName = _getIcon($iconFileName);
  3614. if(empty($iconName)){
  3615. $iconName = _getIcon($altFileName);
  3616. if (empty($iconName))
  3617. {
  3618. return $app_strings['LBL_NO_IMAGE'];
  3619. }
  3620. }
  3621. return SugarThemeRegistry::current()->getImage($iconName, "align=\"$align\" border=\"0\"", $width, $height);
  3622. }
  3623. /**
  3624. * Function to grab the correct icon image for Dashlets Dialog
  3625. * @param string $filename Location of the icon file
  3626. * @param string $module Name of the module to fall back onto if file does not exist
  3627. * @param string $width Width of image
  3628. * @param string $height Height of image
  3629. * @param string $align Alignment of image
  3630. * @param string $alt Alt tag of image
  3631. * @return string $string <img> tag with corresponding image
  3632. */
  3633. function get_dashlets_dialog_icon($module='', $width='32', $height='32', $align='absmiddle',$alt=''){
  3634. global $app_strings, $theme;
  3635. $iconName = _getIcon($module . "_32");
  3636. if (empty($iconName))
  3637. {
  3638. $iconName = _getIcon($module);
  3639. }
  3640. if(empty($iconName)){
  3641. return $app_strings['LBL_NO_IMAGE'];
  3642. }
  3643. return SugarThemeRegistry::current()->getImage($iconName, "align=\"$align\" border=\"0\"", $width, $height);
  3644. }
  3645. // works nicely to change UTF8 strings that are html entities - good for PDF conversions
  3646. function html_entity_decode_utf8($string)
  3647. {
  3648. static $trans_tbl;
  3649. // replace numeric entities
  3650. //php will have issues with numbers with leading zeros, so do not include them in what we send to code2utf.
  3651. $string = preg_replace('~&#x0*([0-9a-f]+);~ei', 'code2utf(hexdec("\\1"))', $string);
  3652. $string = preg_replace('~&#0*([0-9]+);~e', 'code2utf(\\1)', $string);
  3653. // replace literal entities
  3654. if (!isset($trans_tbl))
  3655. {
  3656. $trans_tbl = array();
  3657. foreach (get_html_translation_table(HTML_ENTITIES) as $val=>$key)
  3658. $trans_tbl[$key] = utf8_encode($val);
  3659. }
  3660. return strtr($string, $trans_tbl);
  3661. }
  3662. // Returns the utf string corresponding to the unicode value
  3663. function code2utf($num)
  3664. {
  3665. if ($num < 128) return chr($num);
  3666. if ($num < 2048) return chr(($num >> 6) + 192) . chr(($num & 63) + 128);
  3667. if ($num < 65536) return chr(($num >> 12) + 224) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
  3668. if ($num < 2097152) return chr(($num >> 18) + 240) . chr((($num >> 12) & 63) + 128) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
  3669. return '';
  3670. }
  3671. function str_split_php4($string, $length = 1) {
  3672. $string_length = strlen($string);
  3673. $return = array();
  3674. $cursor = 0;
  3675. if ($length > $string_length) {
  3676. // use the string_length as the string is shorter than the length
  3677. $length = $string_length;
  3678. }
  3679. for ($cursor = 0; $cursor < $string_length; $cursor = $cursor + $length) {
  3680. $return[] = substr($string, $cursor, $length);
  3681. }
  3682. return $return;
  3683. }
  3684. if (version_compare(phpversion(), '5.0.0', '<')) {
  3685. function str_split($string, $length = 1) {
  3686. return str_split_php4($string, $length);
  3687. }
  3688. }
  3689. /*
  3690. * @deprecated use DBManagerFactory::isFreeTDS
  3691. */
  3692. function is_freetds()
  3693. {
  3694. return DBManagerFactory::isFreeTDS();
  3695. }
  3696. /**
  3697. * Chart dashlet helper function that returns the correct CSS file, dependent on the current theme.
  3698. *
  3699. * @todo this won't work completely right until we impliment css compression and combination
  3700. * for now, we'll just include the last css file found.
  3701. *
  3702. * @return chart.css file to use
  3703. */
  3704. function chartStyle()
  3705. {
  3706. return SugarThemeRegistry::current()->getCSSURL('chart.css');
  3707. }
  3708. /**
  3709. * Chart dashlet helper functions that returns the correct XML color file for charts,
  3710. * dependent on the current theme.
  3711. *
  3712. * @return sugarColors.xml to use
  3713. */
  3714. function chartColors()
  3715. {
  3716. if (SugarThemeRegistry::current()->getCSSURL('sugarColors.xml')=='')
  3717. return SugarThemeRegistry::current()->getImageURL('sugarColors.xml');
  3718. return SugarThemeRegistry::current()->getCSSURL('sugarColors.xml');
  3719. }
  3720. /* End Chart Dashlet helper functions */
  3721. /**
  3722. * This function is designed to set up the php enviroment
  3723. * for AJAX requests.
  3724. */
  3725. function ajaxInit() {
  3726. ini_set('display_errors', 'false');
  3727. }
  3728. /**
  3729. * Returns an absolute path from the given path, determining if it is relative or absolute
  3730. *
  3731. * @param string $path
  3732. * @return string
  3733. */
  3734. function getAbsolutePath(
  3735. $path,
  3736. $currentServer = false
  3737. )
  3738. {
  3739. $path = trim($path);
  3740. // try to match absolute paths like \\server\share, /directory or c:\
  3741. if ( ( substr($path,0,2) == '\\\\' )
  3742. || ( $path[0] == '/' )
  3743. || preg_match('/^[A-z]:/i',$path)
  3744. || $currentServer )
  3745. return $path;
  3746. return getcwd().'/'.$path;
  3747. }
  3748. /**
  3749. * Returns the bean object of the given module
  3750. *
  3751. * @deprecated use SugarModule::loadBean() instead
  3752. * @param string $module
  3753. * @return object
  3754. */
  3755. function loadBean(
  3756. $module
  3757. )
  3758. {
  3759. return SugarModule::get($module)->loadBean();
  3760. }
  3761. /**
  3762. * Returns true if the application is being accessed on a touch screen interface ( like an iPad )
  3763. */
  3764. function isTouchScreen()
  3765. {
  3766. $ua = empty($_SERVER['HTTP_USER_AGENT']) ? "undefined" : strtolower($_SERVER['HTTP_USER_AGENT']);
  3767. // first check if we have forced use of the touch enhanced interface
  3768. if ( isset($_COOKIE['touchscreen']) && $_COOKIE['touchscreen'] == '1' ) {
  3769. return true;
  3770. }
  3771. // next check if we should use the touch interface with our device
  3772. if ( strpos($ua, 'ipad') !== false ) {
  3773. return true;
  3774. }
  3775. return false;
  3776. }
  3777. /**
  3778. * Returns the shortcut keys to access the shortcut links. Shortcut
  3779. * keys vary depending on browser versions and operating systems.
  3780. * @return String value of the shortcut keys
  3781. */
  3782. function get_alt_hot_key() {
  3783. $ua = '';
  3784. if ( isset($_SERVER['HTTP_USER_AGENT']) )
  3785. $ua = strtolower($_SERVER['HTTP_USER_AGENT']);
  3786. $isMac = strpos($ua, 'mac') !== false;
  3787. $isLinux = strpos($ua, 'linux') !== false;
  3788. if(!$isMac && !$isLinux && strpos($ua, 'mozilla') !== false) {
  3789. if(preg_match('/firefox\/(\d)?\./', $ua, $matches)) {
  3790. return $matches[1] < 2 ? 'Alt+' : 'Alt+Shift+';
  3791. }
  3792. }
  3793. return $isMac ? 'Ctrl+' : 'Alt+';
  3794. }
  3795. function can_start_session(){
  3796. if(!empty($_GET['PHPSESSID'])) {
  3797. return true;
  3798. }
  3799. $session_id = session_id();
  3800. return empty($session_id) ? true : false;
  3801. }
  3802. function load_link_class($properties){
  3803. $class = 'Link2';
  3804. if(!empty($properties['link_class']) && !empty($properties['link_file'])){
  3805. require_once($properties['link_file']);
  3806. $class = $properties['link_class'];
  3807. }
  3808. return $class;
  3809. }
  3810. function inDeveloperMode()
  3811. {
  3812. return isset($GLOBALS['sugar_config']['developerMode']) && $GLOBALS['sugar_config']['developerMode'];
  3813. }
  3814. /**
  3815. * Filter the protocol list for inbound email accounts.
  3816. *
  3817. * @param array $protocol
  3818. */
  3819. function filterInboundEmailPopSelection($protocol)
  3820. {
  3821. if ( !isset($GLOBALS['sugar_config']['allow_pop_inbound']) || ! $GLOBALS['sugar_config']['allow_pop_inbound'] )
  3822. {
  3823. if( isset($protocol['pop3']) )
  3824. unset($protocol['pop3']);
  3825. }
  3826. else
  3827. $protocol['pop3'] = 'POP3';
  3828. return $protocol;
  3829. }
  3830. /**
  3831. * The function is used because currently we are not supporting mbstring.func_overload
  3832. * For some user using mssql without FreeTDS, they may store multibyte charaters in varchar using latin_general collation. It cannot store so many mutilbyte characters, so we need to use strlen.
  3833. * The varchar in MySQL, Orcale, and nvarchar in FreeTDS, we can store $length mutilbyte charaters in it. we need mb_substr to keep more info.
  3834. * @returns the substred strings.
  3835. */
  3836. function sugar_substr($string, $length, $charset='UTF-8')
  3837. {
  3838. if(mb_strlen($string,$charset) > $length) {
  3839. $string = trim(mb_substr(trim($string),0,$length,$charset));
  3840. }
  3841. return $string;
  3842. }
  3843. /**
  3844. * The function is used because on FastCGI enviroment, the ucfirst(Chinese Characters) will produce bad charcters.
  3845. * This will work even without setting the mbstring.*encoding
  3846. */
  3847. function sugar_ucfirst($string, $charset='UTF-8') {
  3848. return mb_strtoupper(mb_substr($string, 0, 1, $charset), $charset) . mb_substr($string, 1, mb_strlen($string), $charset);
  3849. }
  3850. /**
  3851. *
  3852. */
  3853. function unencodeMultienum($string) {
  3854. if (is_array($string))
  3855. {
  3856. return $string;
  3857. }
  3858. if (substr($string, 0 ,1) == "^" && substr($string, -1) == "^") {
  3859. $string = substr(substr($string, 1), 0, strlen($string) -2);
  3860. }
  3861. return explode('^,^', $string);
  3862. }
  3863. function encodeMultienumValue($arr) {
  3864. if (!is_array($arr))
  3865. return $arr;
  3866. if (empty($arr))
  3867. return "";
  3868. $string = "^" . implode('^,^', $arr) . "^";
  3869. return $string;
  3870. }
  3871. /**
  3872. * create_export_query is used for export and massupdate
  3873. * We haven't handle the these fields: $field['type'] == 'relate' && isset($field['link']
  3874. * This function will correct the where clause and output necessary join condition for them
  3875. * @param $module: the module name
  3876. * @param $searchFields: searchFields which is got after $searchForm->populateFromArray()
  3877. * @param $where: where clauses
  3878. * @return $ret_array['where']: corrected where clause
  3879. * @return $ret_array['join']: extra join condition
  3880. */
  3881. function create_export_query_relate_link_patch($module, $searchFields, $where){
  3882. if(file_exists('modules/'.$module.'/SearchForm.html')){
  3883. $ret_array['where'] = $where;
  3884. return $ret_array;
  3885. }
  3886. $seed = loadBean($module);
  3887. foreach($seed->field_defs as $name=>$field)
  3888. {
  3889. if( $field['type'] == 'relate' && isset($field['link']) && !empty($searchFields[$name]['value']) ){
  3890. $seed->load_relationship($field['link']);
  3891. $params = array();
  3892. if(empty($join_type))
  3893. {
  3894. $params['join_type'] = ' LEFT JOIN ';
  3895. }
  3896. else
  3897. {
  3898. $params['join_type'] = $join_type;
  3899. }
  3900. if(isset($data['join_name']))
  3901. {
  3902. $params['join_table_alias'] = $field['join_name'];
  3903. }
  3904. else
  3905. {
  3906. $params['join_table_alias'] = 'join_'.$field['name'];
  3907. }
  3908. if(isset($data['join_link_name']))
  3909. {
  3910. $params['join_table_link_alias'] = $field['join_link_name'];
  3911. }
  3912. else
  3913. {
  3914. $params['join_table_link_alias'] = 'join_link_'.$field['name'];
  3915. }
  3916. $join = $seed->$field['link']->getJoin($params, true);
  3917. $join_table_alias = 'join_'.$field['name'];
  3918. if(isset($field['db_concat_fields'])){
  3919. $db_field = db_concat($join_table_alias, $field['db_concat_fields']);
  3920. $where = preg_replace('/'.$field['name'].'/', $db_field, $where);
  3921. }else{
  3922. $where = preg_replace('/(^|[\s(])' . $field['name'] . '/', '${1}' . $join_table_alias . '.'.$field['rname'], $where);
  3923. }
  3924. }
  3925. }
  3926. $ret_array = array('where'=>$where, 'join'=> isset($join['join']) ? $join['join'] : '');
  3927. return $ret_array;
  3928. }
  3929. /**
  3930. * We need to clear all the js cache files, including the js language files in serval places in MB. So I extract them into a util function here.
  3931. * @Depends on QuickRepairAndRebuild.php
  3932. * @Relate bug 30642 ,23177
  3933. */
  3934. function clearAllJsAndJsLangFilesWithoutOutput(){
  3935. global $current_language , $mod_strings;
  3936. $MBmodStrings = $mod_strings;
  3937. $mod_strings = return_module_language ( $current_language, 'Administration' ) ;
  3938. include_once ('modules/Administration/QuickRepairAndRebuild.php') ;
  3939. $repair = new RepairAndClear();
  3940. $repair->module_list = array();
  3941. $repair->show_output = false;
  3942. $repair->clearJsLangFiles();
  3943. $repair->clearJsFiles();
  3944. $mod_strings = $MBmodStrings;
  3945. }
  3946. /**
  3947. * This function will allow you to get a variable value from query string
  3948. */
  3949. function getVariableFromQueryString($variable, $string){
  3950. $matches = array();
  3951. $number = preg_match("/{$variable}=([a-zA-Z0-9_-]+)[&]?/", $string, $matches);
  3952. if($number){
  3953. return $matches[1];
  3954. }
  3955. else{
  3956. return false;
  3957. }
  3958. }
  3959. /**
  3960. * should_hide_iframes
  3961. * This is a helper method to determine whether or not to show iframes (My Sites) related
  3962. * information in the application.
  3963. *
  3964. * @return boolean flag indicating whether or not iframes module should be hidden
  3965. */
  3966. function should_hide_iframes() {
  3967. //Remove the MySites module
  3968. if(file_exists('modules/iFrames/iFrame.php')) {
  3969. if(!class_exists("iFrame")) {
  3970. require_once('modules/iFrames/iFrame.php');
  3971. }
  3972. return false;
  3973. }
  3974. return true;
  3975. }
  3976. /**
  3977. * Given a version such as 5.5.0RC1 return RC. If we have a version such as: 5.5 then return GA
  3978. *
  3979. * @param string $version
  3980. * @return string RC, BETA, GA
  3981. */
  3982. function getVersionStatus($version){
  3983. if(preg_match('/^[\d\.]+?([a-zA-Z]+?)[\d]*?$/si', $version, $matches)) {
  3984. return strtoupper($matches[1]);
  3985. }else{
  3986. return 'GA';
  3987. }
  3988. }
  3989. /**
  3990. * Return the numeric portion of a version. For example if passed 5.5.0RC1 then return 5.5. If given
  3991. * 5.5.1RC1 then return 5.5.1
  3992. *
  3993. * @param string $version
  3994. * @return version
  3995. */
  3996. function getMajorMinorVersion($version){
  3997. if(preg_match('/^([\d\.]+).*$/si', $version, $matches2)){
  3998. $version = $matches2[1];
  3999. $arr = explode('.', $version);
  4000. if(count($arr) > 2){
  4001. if($arr[2] == '0'){
  4002. $version = substr($version, 0, 3);
  4003. }
  4004. }
  4005. }
  4006. return $version;
  4007. }
  4008. /**
  4009. * Return string composed of seconds & microseconds of current time, without dots
  4010. * @return string
  4011. */
  4012. function sugar_microtime()
  4013. {
  4014. $now = explode(' ', microtime());
  4015. $unique_id = $now[1].str_replace('.', '', $now[0]);
  4016. return $unique_id;
  4017. }
  4018. /**
  4019. * Extract urls from a piece of text
  4020. * @param $string
  4021. * @return array of urls found in $string
  4022. */
  4023. function getUrls($string)
  4024. {
  4025. $lines = explode("<br>", trim($string));
  4026. $urls = array();
  4027. foreach($lines as $line){
  4028. $regex = '/http?\:\/\/[^\" ]+/i';
  4029. preg_match_all($regex, $line, $matches);
  4030. foreach($matches[0] as $match){
  4031. $urls[] = $match;
  4032. }
  4033. }
  4034. return $urls;
  4035. }
  4036. /**
  4037. * Sanitize image file from hostile content
  4038. * @param string $path Image file
  4039. * @param bool $jpeg Accept only JPEGs?
  4040. */
  4041. function verify_image_file($path, $jpeg = false)
  4042. {
  4043. if(function_exists('imagepng') && function_exists('imagejpeg') && function_exists('imagecreatefromstring')) {
  4044. $img = imagecreatefromstring(file_get_contents($path));
  4045. if(!$img) {
  4046. return false;
  4047. }
  4048. $img_size = getimagesize($path);
  4049. $filetype = $img_size['mime'];
  4050. //if filetype is jpeg or if we are only allowing jpegs, create jpg image
  4051. if($filetype == "image/jpeg" || $jpeg) {
  4052. ob_start();
  4053. imagejpeg($img);
  4054. $image = ob_get_clean();
  4055. // not writing directly because imagejpeg does not work with streams
  4056. if(file_put_contents($path, $image)) {
  4057. return true;
  4058. }
  4059. } elseif ($filetype == "image/png") {
  4060. // else if the filetype is png, create png
  4061. imagealphablending($img, true);
  4062. imagesavealpha($img, true);
  4063. ob_start();
  4064. imagepng($img);
  4065. $image = ob_get_clean();
  4066. if(file_put_contents($path, $image)) {
  4067. return true;
  4068. }
  4069. } else {
  4070. return false;
  4071. }
  4072. } else {
  4073. // check image manually
  4074. $fp = fopen($path, "rb");
  4075. if(!$fp) return false;
  4076. $data = '';
  4077. // read the whole file in chunks
  4078. while(!feof($fp)) {
  4079. $data .= fread($fp,8192);
  4080. }
  4081. fclose($fp);
  4082. if(preg_match("/<(\?php|html|!doctype|script|body|head|plaintext|table|img |pre(>| )|frameset|iframe|object|link|base|style|font|applet|meta|center|form|isindex)/i",
  4083. $data, $m)) {
  4084. $GLOBALS['log']->fatal("Found {$m[0]} in $path, not allowing upload");
  4085. return false;
  4086. }
  4087. return true;
  4088. }
  4089. return false;
  4090. }
  4091. /**
  4092. * Verify uploaded image
  4093. * Verifies that image has proper extension, MIME type and doesn't contain hostile content
  4094. * @param string $path Image path
  4095. * @param bool $jpeg_only Accept only JPEGs?
  4096. */
  4097. function verify_uploaded_image($path, $jpeg_only = false)
  4098. {
  4099. $supportedExtensions = array('jpg' => 'image/jpeg', 'jpeg' => 'image/jpeg');
  4100. if(!$jpeg_only) {
  4101. $supportedExtensions['png'] = 'image/png';
  4102. }
  4103. if(!file_exists($path) || !is_file($path)) {
  4104. return false;
  4105. }
  4106. $img_size = getimagesize($path);
  4107. $filetype = $img_size['mime'];
  4108. $ext = end(explode(".", $path));
  4109. if(substr_count('..', $path) > 0 || ($ext !== $path && !isset($supportedExtensions[strtolower($ext)])) ||
  4110. !in_array($filetype, array_values($supportedExtensions))) {
  4111. return false;
  4112. }
  4113. return verify_image_file($path, $jpeg_only);
  4114. }
  4115. function cmp_beans($a, $b)
  4116. {
  4117. global $sugar_web_service_order_by;
  4118. //If the order_by field is not valid, return 0;
  4119. if (empty($sugar_web_service_order_by) || !isset($a->$sugar_web_service_order_by) || !isset($b->$sugar_web_service_order_by)){
  4120. return 0;
  4121. }
  4122. if (is_object($a->$sugar_web_service_order_by) || is_object($b->$sugar_web_service_order_by)
  4123. || is_array($a->$sugar_web_service_order_by) || is_array($b->$sugar_web_service_order_by))
  4124. {
  4125. return 0;
  4126. }
  4127. if ($a->$sugar_web_service_order_by < $b->$sugar_web_service_order_by)
  4128. {
  4129. return -1;
  4130. } else {
  4131. return 1;
  4132. }
  4133. }
  4134. function order_beans($beans, $field_name)
  4135. {
  4136. //Since php 5.2 doesn't include closures, we must use a global to pass the order field to cmp_beans.
  4137. global $sugar_web_service_order_by;
  4138. $sugar_web_service_order_by = $field_name;
  4139. usort($beans, "cmp_beans");
  4140. return $beans;
  4141. }
  4142. /**
  4143. * Return search like string
  4144. * This function takes a user input string and returns a string that contains wild card(s) that can be used in db query.
  4145. * @param string $str string to be searched
  4146. * @param string $like_char Database like character, usually '%'
  4147. * @return string Returns a string to be searched in db query
  4148. */
  4149. function sql_like_string($str, $like_char, $wildcard = '%', $appendWildcard = true) {
  4150. // override default wildcard character
  4151. if (isset($GLOBALS['sugar_config']['search_wildcard_char']) &&
  4152. strlen($GLOBALS['sugar_config']['search_wildcard_char']) == 1) {
  4153. $wildcard = $GLOBALS['sugar_config']['search_wildcard_char'];
  4154. }
  4155. // add wildcard at the beginning of the search string
  4156. if (isset($GLOBALS['sugar_config']['search_wildcard_infront']) &&
  4157. $GLOBALS['sugar_config']['search_wildcard_infront'] == true) {
  4158. if (substr($str,0,1) <> $wildcard)
  4159. $str = $wildcard.$str;
  4160. }
  4161. // add wildcard at the end of search string (default)
  4162. if ($appendWildcard) {
  4163. if(substr($str,-1) <> $wildcard) {
  4164. $str .= $wildcard;
  4165. }
  4166. }
  4167. return str_replace($wildcard, $like_char, $str);
  4168. }
  4169. //check to see if custom utils exists
  4170. if(file_exists('custom/include/custom_utils.php')){
  4171. include_once('custom/include/custom_utils.php');
  4172. }
  4173. //check to see if custom utils exists in Extension framework
  4174. if(file_exists('custom/application/Ext/Utils/custom_utils.ext.php')) {
  4175. include_once('custom/application/Ext/Utils/custom_utils.ext.php');
  4176. }
  4177. /**
  4178. * @param $input - the input string to sanitize
  4179. * @param int $quotes - use quotes
  4180. * @param string $charset - the default charset
  4181. * @param bool $remove - strip tags or not
  4182. * @return string - the sanitized string
  4183. */
  4184. function sanitize($input, $quotes = ENT_QUOTES, $charset = 'UTF-8', $remove = false)
  4185. {
  4186. return htmlentities($input, $quotes, $charset);
  4187. }
  4188. /**
  4189. * @return string - the full text search engine name
  4190. */
  4191. function getFTSEngineType()
  4192. {
  4193. if (isset($GLOBALS['sugar_config']['full_text_engine']) && is_array($GLOBALS['sugar_config']['full_text_engine'])) {
  4194. foreach ($GLOBALS['sugar_config']['full_text_engine'] as $name => $defs) {
  4195. return $name;
  4196. }
  4197. }
  4198. return '';
  4199. }
  4200. /**
  4201. * @param string $optionName - name of the option to be retrieved from app_list_strings
  4202. * @return array - the array to be used in option element
  4203. */
  4204. function getFTSBoostOptions($optionName)
  4205. {
  4206. if (isset($GLOBALS['app_list_strings'][$optionName])) {
  4207. return $GLOBALS['app_list_strings'][$optionName];
  4208. }
  4209. else {
  4210. return array();
  4211. }
  4212. }
  4213. /**
  4214. * utf8_recursive_encode
  4215. *
  4216. * This function walks through an Array and recursively calls utf8_encode on the
  4217. * values of each of the elements.
  4218. *
  4219. * @param $data Array of data to encode
  4220. * @return utf8 encoded Array data
  4221. */
  4222. function utf8_recursive_encode($data)
  4223. {
  4224. $result = array();
  4225. foreach($data as $key=>$val) {
  4226. if(is_array($val)) {
  4227. $result[$key] = utf8_recursive_encode($val);
  4228. } else {
  4229. $result[$key] = utf8_encode($val);
  4230. }
  4231. }
  4232. return $result;
  4233. }
  4234. /**
  4235. * get_language_header
  4236. *
  4237. * This is a utility function for 508 Compliance. It returns the lang=[Current Language] text string used
  4238. * inside the <html> tag. If no current language is specified, it defaults to lang='en'.
  4239. *
  4240. * @return String The lang=[Current Language] markup to insert into the <html> tag
  4241. */
  4242. function get_language_header()
  4243. {
  4244. return isset($GLOBALS['current_language']) ? "lang='{$GLOBALS['current_language']}'" : "lang='en'";
  4245. }
  4246. /**
  4247. * get_custom_file_if_exists
  4248. *
  4249. * This function handles the repetitive code we have where we first check if a file exists in the
  4250. * custom directory to determine whether we should load it, require it, include it, etc. This function returns the
  4251. * path of the custom file if it exists. It basically checks if custom/{$file} exists and returns this path if so;
  4252. * otherwise it return $file
  4253. *
  4254. * @param $file String of filename to check
  4255. * @return $file String of filename including custom directory if found
  4256. */
  4257. function get_custom_file_if_exists($file)
  4258. {
  4259. return file_exists("custom/{$file}") ? "custom/{$file}" : $file;
  4260. }
  4261. /**
  4262. * get_help_url
  4263. *
  4264. * This will return the URL used to redirect the user to the help documentation.
  4265. * It can be overriden completely by setting the custom_help_url or partially by setting the custom_help_base_url
  4266. * in config.php or config_override.php.
  4267. *
  4268. * @param string $send_edition
  4269. * @param string $send_version
  4270. * @param string $send_lang
  4271. * @param string $send_module
  4272. * @param string $send_action
  4273. * @param string $dev_status
  4274. * @param string $send_key
  4275. * @param string $send_anchor
  4276. * @return string the completed help URL
  4277. */
  4278. function get_help_url($send_edition = '', $send_version = '', $send_lang = '', $send_module = '', $send_action = '', $dev_status = '', $send_key = '', $send_anchor = '') {
  4279. global $sugar_config;
  4280. if (!empty($sugar_config['custom_help_url'])) {
  4281. $sendUrl = $sugar_config['custom_help_url'];
  4282. } else {
  4283. if (!empty($sugar_config['custom_help_base_url'])) {
  4284. $baseUrl= $sugar_config['custom_help_base_url'];
  4285. } else {
  4286. $baseUrl = "http://www.sugarcrm.com/crm/product_doc.php";
  4287. }
  4288. $sendUrl = $baseUrl . "?edition={$send_edition}&version={$send_version}&lang={$send_lang}&module={$send_module}&help_action={$send_action}&status={$dev_status}&key={$send_key}";
  4289. if(!empty($send_anchor)) {
  4290. $sendUrl .= "&anchor=".$send_anchor;
  4291. }
  4292. }
  4293. return $sendUrl;
  4294. }
  4295. /**
  4296. * generateETagHeader
  4297. *
  4298. * This function generates the necessary cache headers for using ETags with dynamic content. You
  4299. * simply have to generate the ETag, pass it in, and the function handles the rest.
  4300. *
  4301. * @param string $etag ETag to use for this content.
  4302. */
  4303. function generateETagHeader($etag){
  4304. header("cache-control:");
  4305. header('Expires: ');
  4306. header("ETag: " . $etag);
  4307. header("Pragma:");
  4308. if(isset($_SERVER["HTTP_IF_NONE_MATCH"])){
  4309. if($etag == $_SERVER["HTTP_IF_NONE_MATCH"]){
  4310. ob_clean();
  4311. header("Status: 304 Not Modified");
  4312. header("HTTP/1.0 304 Not Modified");
  4313. die();
  4314. }
  4315. }
  4316. }
  4317. /**
  4318. * getReportNameTranslation
  4319. *
  4320. * Translates the report name if a translation exists,
  4321. * otherwise just returns the name
  4322. *
  4323. * @param string $reportName
  4324. * @return string translated report name
  4325. */
  4326. function getReportNameTranslation($reportName) {
  4327. global $current_language;
  4328. // Used for translating reports
  4329. $mod_strings = return_module_language($current_language, 'Reports');
  4330. // Search for the report name in the default language and get the key
  4331. $key = array_search($reportName, return_module_language("", "Reports"));
  4332. // If the key was found, use it to get a translation, otherwise just use report name
  4333. if (!empty($key)) {
  4334. $title = $mod_strings[$key];
  4335. } else {
  4336. $title = $reportName;
  4337. }
  4338. return $title;
  4339. }
  4340. /**
  4341. * Remove vars marked senstitive from array
  4342. * @param array $defs
  4343. * @param SugarBean|array $data
  4344. * @return mixed $data without sensitive fields
  4345. */
  4346. function clean_sensitive_data($defs, $data)
  4347. {
  4348. foreach($defs as $field => $def) {
  4349. if(!empty($def['sensitive'])) {
  4350. if(is_array($data)) {
  4351. $data[$field] = '';
  4352. }
  4353. if($data instanceof SugarBean) {
  4354. $data->$field = '';
  4355. }
  4356. }
  4357. }
  4358. return $data;
  4359. }
  4360. /**
  4361. * Return relations with labels for duplicates
  4362. */
  4363. function getDuplicateRelationListWithTitle($def, $var_def, $module)
  4364. {
  4365. global $current_language;
  4366. $select_array = array_unique($def);
  4367. if (count($select_array) < count($def))
  4368. {
  4369. $temp_module_strings = return_module_language($current_language, $module);
  4370. $temp_duplicate_array = array_diff_assoc($def, $select_array);
  4371. $temp_duplicate_array = array_merge($temp_duplicate_array, array_intersect($select_array, $temp_duplicate_array));
  4372. foreach ($temp_duplicate_array as $temp_key => $temp_value)
  4373. {
  4374. // Don't add duplicate relationships
  4375. if (!empty($var_def[$temp_key]['relationship']) && array_key_exists($var_def[$temp_key]['relationship'], $select_array))
  4376. {
  4377. continue;
  4378. }
  4379. $select_array[$temp_key] = $temp_value;
  4380. }
  4381. // Add the relationship name for easier recognition
  4382. foreach ($select_array as $key => $value)
  4383. {
  4384. $select_array[$key] .= ' (' . $key . ')';
  4385. }
  4386. }
  4387. asort($select_array);
  4388. return $select_array;
  4389. }
  4390. /**
  4391. * Gets the list of "*type_display*".
  4392. *
  4393. * @return array
  4394. */
  4395. function getTypeDisplayList()
  4396. {
  4397. return array('record_type_display', 'parent_type_display', 'record_type_display_notes');
  4398. }
  4399. /**
  4400. * Breaks given string into substring according
  4401. * to 'db_concat_fields' from field definition
  4402. * and assigns values to corresponding properties
  4403. * of bean.
  4404. *
  4405. * @param SugarBean $bean
  4406. * @param array $fieldDef
  4407. * @param string $value
  4408. */
  4409. function assignConcatenatedValue(SugarBean $bean, $fieldDef, $value)
  4410. {
  4411. $valueParts = explode(' ',$value);
  4412. $valueParts = array_filter($valueParts);
  4413. $fieldNum = count($fieldDef['db_concat_fields']);
  4414. if (count($valueParts) == 1 && $fieldDef['db_concat_fields'] == array('first_name', 'last_name'))
  4415. {
  4416. $bean->last_name = $value;
  4417. }
  4418. // elseif ($fieldNum >= count($valueParts))
  4419. else
  4420. {
  4421. for ($i = 0; $i < $fieldNum; $i++)
  4422. {
  4423. $fieldValue = array_shift($valueParts);
  4424. $fieldName = $fieldDef['db_concat_fields'][$i];
  4425. $bean->$fieldName = $fieldValue !== false ? $fieldValue : '';
  4426. }
  4427. if (!empty($valueParts))
  4428. {
  4429. $bean->$fieldName .= ' ' . implode(' ', $valueParts);
  4430. }
  4431. }
  4432. }