Source for file load_prefs.php

Documentation is available at load_prefs.php

  1. <?php
  2.  
  3. /**
  4.  * load_prefs.php
  5.  *
  6.  * Loads preferences from the $username.pref file used by almost
  7.  * every other script in the source directory and alswhere.
  8.  *
  9.  * @copyright 1999-2020 The SquirrelMail Project Team
  10.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11.  * @version $Id: load_prefs.php 14840 2020-01-07 07:42:38Z pdontthink $
  12.  * @package squirrelmail
  13.  */
  14.  
  15. /** SquirrelMail required files. */
  16. require_once(SM_PATH . 'include/validate.php');
  17. require_once(SM_PATH . 'functions/plugin.php');
  18. require_once(SM_PATH . 'functions/constants.php');
  19. require_once(SM_PATH . 'functions/prefs.php');
  20.  
  21. if( ! sqgetGlobalVar('username', $username, SQ_SESSION) ) {
  22.     $username = '';
  23. }
  24.  
  25. $custom_css = getPref($data_dir, $username, 'custom_css', 'none' );
  26.  
  27. $theme = ( !isset($theme) ? array() : $theme );
  28. $color = ( !isset($color) ? array() : $color );
  29.  
  30. $chosen_theme = getPref($data_dir, $username, 'chosen_theme');
  31. $found_theme = false;
  32.  
  33. /* need to adjust $chosen_theme path with SM_PATH */
  34. $chosen_theme = preg_replace("/(\.\.\/){1,}/", SM_PATH, $chosen_theme);
  35.  
  36. for ($i = 0; $i < count($theme); ++$i){
  37.     if ($theme[$i]['PATH'] == $chosen_theme) {
  38.         $found_theme = true;
  39.         break;
  40.     }
  41. }
  42. $chosen_theme = (!$found_theme ? '' : $chosen_theme);
  43.  
  44. /**
  45. * This theme as a failsafe if no themes were found. It makes
  46. * no sense to cause the whole thing to exit just because themes
  47. * were not found. This is the absolute last resort.
  48. * Moved here to provide 'sane' defaults for incomplete themes.
  49. */
  50. $color[0]  = '#DCDCDC';  /* light gray    TitleBar                */
  51. $color[1]  = '#800000';  /* red                                   */
  52. $color[2]  = '#CC0000';  /* light red     Warning/Error Messages  */
  53. $color[3]  = '#A0B8C8';  /* green-blue    Left Bar Background     */
  54. $color[4]  = '#FFFFFF';  /* white         Normal Background       */
  55. $color[5]  = '#FFFFCC';  /* light yellow  Table Headers           */
  56. $color[6]  = '#000000';  /* black         Text on left bar        */
  57. $color[7]  = '#0000CC';  /* blue          Links                   */
  58. $color[8]  = '#000000';  /* black         Normal text             */
  59. $color[9]  = '#ABABAB';  /* mid-gray      Darker version of #0    */
  60. $color[10] = '#666666';  /* dark gray     Darker version of #9    */
  61. $color[11] = '#770000';  /* dark red      Special Folders color   */
  62. $color[12] = '#EDEDED';
  63. $color[15] = '#002266';  /* (dark blue)      Unselectable folders */
  64. $color[16] = '#ff9933';  /* (orange)         Highlight color      */
  65.  
  66. if (isset($chosen_theme) && $found_theme && (file_exists($chosen_theme))) {
  67.     @include_once($chosen_theme);
  68. } else {
  69.     if (isset($theme) && isset($theme[$theme_default]) && file_exists($theme[$theme_default]['PATH'])) {
  70.         @include_once($theme[$theme_default]['PATH']);
  71.         $chosen_theme = $theme[$theme_default]['PATH'];
  72.     }
  73. }
  74.  
  75.  
  76. // "download_php" is found nowhere in the source - this must be some orphaned legacy code
  77. // if (!defined('download_php')) {
  78.     sqsession_register($theme_css, 'theme_css');
  79. // }
  80.  
  81.  
  82. /* Load the user's special folder preferences */
  83. $move_to_sent =
  84.     getPref($data_dir, $username, 'move_to_sent', $default_move_to_sent);
  85. $move_to_trash =
  86.     getPref($data_dir, $username, 'move_to_trash', $default_move_to_trash);
  87. $save_as_draft =
  88.     getPref($data_dir, $username, 'save_as_draft', $default_save_as_draft);
  89.  
  90. if ($default_unseen_type == '') {
  91.     $default_unseen_type = 1;
  92. }
  93. if ($default_unseen_notify == '') {
  94.     $default_unseen_notify = 2;
  95. }
  96. $unseen_type =
  97.     getPref($data_dir, $username, 'unseen_type', $default_unseen_type);
  98. $unseen_notify =
  99.     getPref($data_dir, $username, 'unseen_notify', $default_unseen_notify);
  100.  
  101. $unseen_cum =
  102.     getPref($data_dir, $username, 'unseen_cum', false);
  103.  
  104. $folder_prefix =
  105.     getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
  106.  
  107. /* Load special folder - trash */
  108. $load_trash_folder = getPref($data_dir, $username, 'trash_folder');
  109. if (($load_trash_folder == '') && ($move_to_trash)) {
  110.     $trash_folder = $folder_prefix . $trash_folder;
  111. } else {
  112.     $trash_folder = $load_trash_folder;
  113. }
  114.  
  115. /* Load special folder - sent */
  116. $load_sent_folder = getPref($data_dir, $username, 'sent_folder');
  117. if (($load_sent_folder == '') && ($move_to_sent)) {
  118.     $sent_folder = $folder_prefix . $sent_folder;
  119. } else {
  120.     $sent_folder = $load_sent_folder;
  121. }
  122.  
  123. /* Load special folder - draft */
  124. $load_draft_folder = getPref($data_dir, $username, 'draft_folder');
  125. if (($load_draft_folder == '') && ($save_as_draft)) {
  126.     $draft_folder = $folder_prefix . $draft_folder;
  127. } else {
  128.     $draft_folder = $load_draft_folder;
  129. }
  130.  
  131. $show_num = getPref($data_dir, $username, 'show_num', 15 );
  132.  
  133. $wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
  134. if ($wrap_at < 15) { $wrap_at = 15; }
  135.  
  136. $left_size = getPref($data_dir, $username, 'left_size');
  137. if ($left_size == '') {
  138.     if (isset($default_left_size)) {
  139.         $left_size = $default_left_size;
  140.     } else {
  141.         $left_size = 200;
  142.     }
  143. }
  144.  
  145. $editor_size = getPref($data_dir, $username, 'editor_size', 76 );
  146. $editor_height = getPref($data_dir, $username, 'editor_height', 20 );
  147. $use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF );
  148. $prefix_sig = getPref($data_dir, $username, 'prefix_sig');
  149.  
  150. /* Load timezone preferences */
  151. $timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE );
  152.  
  153. /* Load preferences for reply citation style. */
  154.  
  155. $reply_citation_style =
  156.     getPref($data_dir, $username, 'reply_citation_style', SMPREF_NONE );
  157. $reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
  158. $reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
  159.  
  160. $body_quote = getPref($data_dir, $username, 'body_quote', '>');
  161. if ($body_quote == 'NONE') $body_quote = '';
  162.  
  163. // Load preference for cursor behavior for replies
  164. //
  165. $reply_focus = getPref($data_dir, $username, 'reply_focus', '');
  166.  
  167. /* left refresh rate, strtolower makes 1.0.6 prefs compatible */
  168. $left_refresh = getPref($data_dir, $username, 'left_refresh', 600 );
  169. $left_refresh = strtolower($left_refresh);
  170.  
  171. $sort = getPref($data_dir, $username, 'sort', 6 );
  172.  
  173. /* Load up the Signature file */
  174. $signature_abs = $signature = getSig($data_dir, $username, 'g');
  175.  
  176. /* Message Highlighting Rules */
  177. $message_highlight_list = array();
  178.  
  179. /* use new way of storing highlighting rules */
  180. if( $ser = getPref($data_dir, $username, 'hililist') ) {
  181.     $message_highlight_list = unserialize($ser);
  182. } else {
  183.     /* use old way */
  184.     for ($i = 0; $hlt = getPref($data_dir, $username, "highlight$i"); ++$i) {
  185.         $highlight_array = explode(',', $hlt);
  186.         $message_highlight_list[$i]['name'] = $highlight_array[0];
  187.         $message_highlight_list[$i]['color'] = $highlight_array[1];
  188.         $message_highlight_list[$i]['value'] = $highlight_array[2];
  189.         $message_highlight_list[$i]['match_type'] = $highlight_array[3];
  190.         removePref($data_dir, $username, "highlight$i");
  191.     }
  192. // NB: The fact that this preference is always set here means that some plugins rely on testing it to know if a user has logged in before - the "old way" above is probably long since obsolete and unneeded, but the setPref() below should not be removed
  193.     /* store in new format for the next time */
  194.     setPref($data_dir, $username, 'hililist', serialize($message_highlight_list));
  195. }
  196.  
  197. /* Index order lets you change the order of the message index */
  198. $order = getPref($data_dir, $username, 'order1');
  199. for ($i = 1; $order; ++$i) {
  200.     $index_order[$i] = $order;
  201.     $order = getPref($data_dir, $username, 'order'.($i+1));
  202. }
  203. if (!isset($index_order)) {
  204.     $index_order[1] = 1;
  205.     $index_order[2] = 2;
  206.     $index_order[3] = 3;
  207.     $index_order[4] = 5;
  208.     $index_order[5] = 4;
  209. }
  210.  
  211. $alt_index_colors =
  212.     getPref($data_dir, $username, 'alt_index_colors', SMPREF_ON );
  213.  
  214. // Folder List Display Format 
  215. $location_of_bar =
  216.     getPref($data_dir, $username, 'location_of_bar', SMPREF_LOC_LEFT);
  217. $location_of_buttons =
  218.     getPref($data_dir, $username, 'location_of_buttons', SMPREF_LOC_BETWEEN);
  219.  
  220. $collapse_folders =
  221.     getPref($data_dir, $username, 'collapse_folders', SMPREF_ON);
  222.  
  223. $show_html_default =
  224.    getPref($data_dir, $username, 'show_html_default', SMPREF_OFF);
  225.  
  226. $addrsrch_fullname =
  227.    getPref($data_dir, $username, 'addrsrch_fullname', 'fullname');
  228.  
  229. $enable_forward_as_attachment =
  230.    getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON);
  231.  
  232. $show_xmailer_default =
  233.     getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF );
  234. $attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF );
  235. $pf_cleandisplay = getPref($data_dir, $username, 'pf_cleandisplay', SMPREF_OFF);
  236.  
  237. /* message disposition notification support setting */
  238. $mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON);
  239.  
  240. $do_not_reply_to_self =
  241.     getPref($data_dir, $username, 'do_not_reply_to_self', SMPREF_OFF);
  242.  
  243. $include_self_reply_all =
  244.     getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON);
  245.  
  246. $return_to_message_after_reply =
  247.     getPref($data_dir, $username, 'return_to_message_after_reply', SMPREF_OFF);
  248.  
  249. /* Page selector options */
  250. $page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
  251. $page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
  252.  
  253. /* SqClock now in the core */
  254. $date_format = getPref($data_dir, $username, 'date_format', 3);
  255. $hour_format = getPref($data_dir, $username, 'hour_format', SMPREF_TIME_12HR);
  256.  
  257. /*  compose in new window setting */
  258. $compose_new_win = getPref($data_dir, $username, 'compose_new_win', 0);
  259. $compose_height = getPref($data_dir, $username, 'compose_height', 550);
  260. $compose_width = getPref($data_dir, $username, 'compose_width', 640);
  261.  
  262.  
  263. /* signature placement settings */
  264. $sig_first = getPref($data_dir, $username, 'sig_first', 0);
  265.  
  266. /* strip signature from replies setting */
  267. $strip_sigs = getPref($data_dir, $username, 'strip_sigs', 0);
  268.  
  269. /* use the internal date of the message for sorting instead of the supplied header date */
  270. $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
  271.  
  272. /* if server sorting is enabled/disabled */
  273. $sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', 1);
  274.  
  275. /* Load the javascript settings. */
  276. $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
  277. $javascript_on = getPref($data_dir, $username, 'javascript_on', SMPREF_ON);
  278. $use_javascript_addr_book = getPref($data_dir, $username, 'use_javascript_addr_book', $default_use_javascript_addr_book);
  279.  
  280. $search_memory = getPref($data_dir, $username, 'search_memory', 0);
  281.  
  282. $mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', 1);
  283.  
  284. /* Allow user to customize, and display the full date, instead of day, or time based
  285.    on time distance from date of message */
  286. $show_full_date = getPref($data_dir, $username, 'show_full_date', 0);
  287.  
  288. /* Allow user to customize length of from field */
  289. $truncate_sender = getPref($data_dir, $username, 'truncate_sender', 50);
  290. /* Allow user to customize length of subject field */
  291. $truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
  292.  
  293. do_hook('loading_prefs');

Documentation generated on Mon, 13 Jan 2020 04:24:52 +0100 by phpDocumentor 1.4.3