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 &copy; 1999-2006 The SquirrelMail Project Team
  10.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11.  * @version $Id: load_prefs.php,v 1.70 2006/10/05 15:29:50 stevetruckstuff Exp $
  12.  * @package squirrelmail
  13.  */
  14.  
  15. /**
  16.  * do not allow to call this file directly
  17.  * FIXME: PHP CGI (at least on IIS 5.1) does not set 'SCRIPT_FILENAME' and
  18.  * code does not handle magic_quotes_gpc=on.
  19.  */
  20. if ((isset($_SERVER['SCRIPT_FILENAME']) && $_SERVER['SCRIPT_FILENAME'] == __FILE__) ||
  21.      (isset($HTTP_SERVER_SERVER['SCRIPT_FILENAME']) && $HTTP_SERVER_SERVER['SCRIPT_FILENAME'] == __FILE__) ) {
  22.     header("Location: ../src/login.php");
  23.     die();
  24. }
  25.  
  26. if( ! sqgetGlobalVar('username', $username, SQ_SESSION) ) {
  27.     $username = '';
  28. }
  29. // TODO Get rid of "none" strings when NULL or false should be used, i hate them i hate them i hate them!!!.
  30. $custom_css = getPref($data_dir, $username, 'custom_css', 'none' );
  31.  
  32.  
  33. // template set setup
  34. //
  35. $sDefaultTemplateID = Template::get_default_template_set();
  36. $sTemplateID = getPref($data_dir, $username, 'sTemplateID', $sDefaultTemplateID);
  37.  
  38. // check user prefs template selection against templates actually available
  39. //
  40. $found_templateset = false;
  41. for ($i = 0; $i < count($aTemplateSet); ++$i){
  42.     if ($aTemplateSet[$i]['ID'] == $sTemplateID) {
  43.         $found_templateset = true;
  44.         break;
  45.     }
  46. }
  47.  
  48. // FIXME: do we need/want to check here for actual presence of template sets?
  49. // selected template not available, fall back to default template
  50. //
  51. if (!$found_templateset) $sTemplateID = $sDefaultTemplateID;
  52.  
  53. // Load user theme
  54. $chosen_theme = getPref($data_dir, $username, 'chosen_theme');
  55. $found_theme = false;
  56. $chosen_theme_path = empty($chosen_theme) ?
  57.                      $chosen_theme_path = 'u_'.$user_themes[$user_theme_default]['PATH'] :
  58.                      $chosen_theme;
  59.  
  60. // Make sure the chosen theme is a legitimate one.
  61. // need to adjust $chosen_theme path with SM_PATH 
  62. $chosen_theme_path = preg_replace("/(\.\.\/){1,}/", SM_PATH, $chosen_theme_path);
  63. $k = 0;
  64. while (!$found_theme && $k < count($user_themes)) {
  65.     if ('u_'.$user_themes[$k]['PATH'] == $chosen_theme_path)
  66.         $found_theme = true;
  67.     $k++;
  68. }
  69. /**
  70.  * $oTemplate is not instantiated when this is called, so we need to devise
  71.  * a method of fething a list of tempalte-provided alt stylesheets to validate
  72.  * against.  For now, we assume that it is always found.
  73.  * 
  74.  * FIXME: fix this.
  75. PL: See include/init.php commit from 2 days ago, Template class should be
  76.     loaded before this file is, so the commented-out code below will probably 
  77.     work
  78. SB: Nope, still get errors.
  79.  */
  80. #$template_themes = $oTemplate->get_alternative_stylesheets();
  81. #while (!$found_theme && (list($path, $name) = each($template_themes))) {
  82. #    if ('t_'.$path == $chosen_theme_path)
  83. #        $found_theme = true;
  84. #}
  85. if (substr($chosen_theme, 0, 2) == 't_')
  86.     $found_theme = true;
  87.     
  88. if (!$found_theme || $chosen_theme == 'none') {
  89.     $chosen_theme_path = NULL;
  90. }
  91.  
  92. /* PL: Steve, is this commented out because it is part of the old system being removed?
  93.        Let's just remove it then... no?
  94.    
  95.    SB: Holding on to incase I need to reference later.  Will remove eventually. :)
  96.    
  97. $theme = ( !isset($theme) ? array() : $theme );
  98. $color = ( !isset($color) ? array() : $color );
  99.  
  100. $chosen_theme = getPref($data_dir, $username, 'chosen_theme');
  101. $found_theme = false;
  102.  
  103. // need to adjust $chosen_theme path with SM_PATH 
  104. $chosen_theme = preg_replace("/(\.\.\/){1,}/", SM_PATH, $chosen_theme);
  105.  
  106. for ($i = 0; $i < count($theme); ++$i){
  107.     if ($theme[$i]['PATH'] == $chosen_theme) {
  108.         $found_theme = true;
  109.         break;
  110.     }
  111. }
  112.  
  113. $chosen_theme = (!$found_theme ? '' : $chosen_theme);
  114.  
  115. if (isset($chosen_theme) && $found_theme && (file_exists($chosen_theme))) {
  116.     @include_once($chosen_theme);
  117. } else {
  118.     if (isset($theme) && isset($theme[$theme_default]) && file_exists($theme[$theme_default]['PATH'])) {
  119.         @include_once($theme[$theme_default]['PATH']);
  120.         $chosen_theme = $theme[$theme_default]['PATH'];
  121.     }
  122. }
  123.  
  124. */
  125.  
  126. // user's icon theme, if using icons
  127. $icon_theme = getPref($data_dir, $username, 'icon_theme');
  128. $default_icon_theme = $icon_themes[$icon_theme_def]['PATH'];
  129. $found_theme = false;
  130.  
  131. // Make sure the chosen icon theme is a legitimate one.
  132. // need to adjust $icon_theme path with SM_PATH 
  133. $icon_theme = preg_replace("/(\.\.\/){1,}/", SM_PATH, $icon_theme);
  134. $k = 0;
  135. while (!$found_theme && $k < count($icon_themes)) {
  136.     if ($icon_themes[$k]['PATH'] == $icon_theme)
  137.         $found_theme = true;
  138.     $k++;
  139. }
  140. if (!$found_theme) {
  141.     $icon_theme = $default_icon_theme;
  142. }
  143.  
  144. /*
  145.  * NOTE: The $icon_theme_path var should contain the path to the icon
  146.  *       theme to use.  If the admin has disabled icons, or the user has
  147.  *       set the icon theme to "None," no icons will be used.
  148.  */
  149. $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
  150.  
  151. // show (or not) flag and unflag buttons on mailbox list screen
  152. $show_flag_buttons = getPref($data_dir, $username, 'show_flag_buttons', SMPREF_ON );
  153.  
  154. /* Load the user's special folder preferences */
  155. $move_to_sent =
  156.     getPref($data_dir, $username, 'move_to_sent', $default_move_to_sent);
  157. $move_to_trash =
  158.     getPref($data_dir, $username, 'move_to_trash', $default_move_to_trash);
  159. $save_as_draft =
  160.     getPref($data_dir, $username, 'save_as_draft', $default_save_as_draft);
  161.  
  162. if ($default_unseen_type == '') {
  163.     $default_unseen_type = 1;
  164. }
  165. if ($default_unseen_notify == '') {
  166.     $default_unseen_notify = 2;
  167. }
  168. $unseen_type =
  169.     getPref($data_dir, $username, 'unseen_type', $default_unseen_type);
  170. $unseen_notify =
  171.     getPref($data_dir, $username, 'unseen_notify', $default_unseen_notify);
  172.  
  173. $unseen_cum =
  174.     getPref($data_dir, $username, 'unseen_cum', false);
  175.  
  176. $folder_prefix =
  177.     getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
  178.  
  179. /* Load special folder - trash */
  180. $load_trash_folder = getPref($data_dir, $username, 'trash_folder');
  181. if (($load_trash_folder == '') && ($move_to_trash)) {
  182.     $trash_folder = $folder_prefix . $trash_folder;
  183. } else {
  184.     $trash_folder = $load_trash_folder;
  185. }
  186.  
  187. /* Load special folder - sent */
  188. $load_sent_folder = getPref($data_dir, $username, 'sent_folder');
  189. if (($load_sent_folder == '') && ($move_to_sent)) {
  190.     $sent_folder = $folder_prefix . $sent_folder;
  191. } else {
  192.     $sent_folder = $load_sent_folder;
  193. }
  194.  
  195. /* Load special folder - draft */
  196. $load_draft_folder = getPref($data_dir, $username, 'draft_folder');
  197. if (($load_draft_folder == '') && ($save_as_draft)) {
  198.     $draft_folder = $folder_prefix . $draft_folder;
  199. } else {
  200.     $draft_folder = $load_draft_folder;
  201. }
  202.  
  203. $show_num = getPref($data_dir, $username, 'show_num', 15 );
  204.  
  205. $wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
  206. if ($wrap_at < 15) { $wrap_at = 15; }
  207.  
  208. $left_size = getPref($data_dir, $username, 'left_size');
  209. if ($left_size == '') {
  210.     if (isset($default_left_size)) {
  211.         $left_size = $default_left_size;
  212.     } else {
  213.         $left_size = 200;
  214.     }
  215. }
  216.  
  217. $editor_size = getPref($data_dir, $username, 'editor_size', 76 );
  218. $editor_height = getPref($data_dir, $username, 'editor_height', 20 );
  219. $use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF );
  220. $prefix_sig = getPref($data_dir, $username, 'prefix_sig');
  221.  
  222. /* Load timezone preferences */
  223. $timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE );
  224.  
  225. /* Load preferences for reply citation style. */
  226.  
  227. $reply_citation_style =
  228.     getPref($data_dir, $username, 'reply_citation_style', 'date_time_author' );
  229. $reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
  230. $reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
  231.  
  232. $body_quote = getPref($data_dir, $username, 'body_quote', '>');
  233. if ($body_quote == 'NONE') $body_quote = '';
  234.  
  235. // who is using those darn block comments?  poo!
  236.  
  237. // Load preference for cursor behavior for replies
  238. //
  239. $reply_focus = getPref($data_dir, $username, 'reply_focus', '');
  240.  
  241. /* left refresh rate, strtolower makes 1.0.6 prefs compatible */
  242. $left_refresh = getPref($data_dir, $username, 'left_refresh', 600 );
  243. $left_refresh = strtolower($left_refresh);
  244.  
  245. /* Load up the Signature file */
  246. $signature_abs = $signature = getSig($data_dir, $username, 'g');
  247.  
  248. /* Message Highlighting Rules */
  249. $message_highlight_list = array();
  250.  
  251. /* use new way of storing highlighting rules */
  252. if( $ser = getPref($data_dir, $username, 'hililist') ) {
  253.     $message_highlight_list = unserialize($ser);
  254. } else {
  255.     /* use old way */
  256.     for ($i = 0; $hlt = getPref($data_dir, $username, "highlight$i"); ++$i) {
  257.         $highlight_array = explode(',', $hlt);
  258.         $message_highlight_list[$i]['name'] = $highlight_array[0];
  259.         $message_highlight_list[$i]['color'] = $highlight_array[1];
  260.         $message_highlight_list[$i]['value'] = $highlight_array[2];
  261.         $message_highlight_list[$i]['match_type'] = $highlight_array[3];
  262.         removePref($data_dir, $username, "highlight$i");
  263.     }
  264.     /* store in new format for the next time */
  265.     setPref($data_dir, $username, 'hililist', serialize($message_highlight_list));
  266. }
  267.  
  268. /* use the internal date of the message for sorting instead of the supplied header date */
  269. /* OBSOLETE */
  270.  
  271. $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
  272.  
  273. /* Index order lets you change the order of the message index */
  274. $order = getPref($data_dir, $username, 'order1');
  275. if (isset($order1)) {
  276.     removePref($data_dir, $username, 'order1');
  277.     for ($i = 1; $order; ++$i) {
  278.         $index_order[$i-1] = $order -1;
  279.         $order = getPref($data_dir, $username, 'order'.($i+1));
  280.         removePref($data_dir, $username, 'order'.($i+1));
  281.     }
  282.     if (isset($internal_date_sort) && $internal_date_sort) {
  283.         if (in_array(SQM_COL_DATE,$index_order)) {
  284.             $k = array_search(SQM_COL_DATE,$index_order,true);
  285.             $index_order[$k] = SQM_COL_INT_DATE;
  286.         }
  287.     }
  288.     setPref($data_dir, $username, 'index_order', serialize($index_order));
  289. }
  290. $index_order = getPref($data_dir, $username, 'index_order');
  291. if (is_string($index_order)) {
  292.     $index_order = unserialize($index_order);
  293. }
  294.  
  295.  
  296. // new Index order handling
  297. //$default_mailbox_pref = unserialize(getPref($data_dir, $username, 'default_mailbox_pref'));
  298.  
  299. if (!$index_order) {
  300.     if (isset($internal_date_sort) && $internal_date_sort == false) {
  301.     } else {
  302.     }
  303.     setPref($data_dir, $username, 'index_order', serialize($index_order));
  304. }
  305.  
  306. if (!isset($default_mailbox_pref)) {
  307.     $show_num = (isset($show_num)) ? $show_num : 15;
  308.  
  309.     $default_mailbox_pref = array (
  310.         MBX_PREF_SORT => 0,
  311.         MBX_PREF_LIMIT => $show_num,
  312.         MBX_PREF_AUTO_EXPUNGE => $auto_expunge,
  313.         MBX_PREF_COLUMNS => $index_order);
  314.     // setPref($data_dir, $username, 'default_mailbox_pref', serialize($default_mailbox_pref));
  315.     // clean up the old prefs
  316. //    if (isset($prefs_cache['internal_date_sort'])) {
  317. //        unset($prefs_cache['internal_date_sort']);
  318. //        removePref($data_dir,$username,'internal_date_sort');
  319. //    }
  320. //    if (isset($prefs_cache['show_num'])) {
  321. //        unset($prefs_cache['show_num']);
  322. //        removePref($data_dir,$username,'show_num');
  323. //    }
  324. }
  325.  
  326.  
  327. $alt_index_colors =
  328.     getPref($data_dir, $username, 'alt_index_colors', SMPREF_ON );
  329.  
  330. $fancy_index_highlite =
  331.     getPref($data_dir, $username, 'fancy_index_highlite', SMPREF_ON );
  332.  
  333. /* Folder List Display Format */
  334. $location_of_bar =
  335.     getPref($data_dir, $username, 'location_of_bar', SMPREF_LOC_LEFT);
  336. $location_of_buttons =
  337.     getPref($data_dir, $username, 'location_of_buttons', SMPREF_LOC_BETWEEN);
  338.  
  339. $collapse_folders =
  340.     getPref($data_dir, $username, 'collapse_folders', SMPREF_ON);
  341.  
  342. $show_html_default =
  343.    getPref($data_dir, $username, 'show_html_default', SMPREF_ON);
  344.  
  345. $enable_forward_as_attachment =
  346.    getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON);
  347.  
  348. $show_xmailer_default =
  349.     getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF );
  350. $attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF );
  351.  
  352.  
  353. /* message disposition notification support setting */
  354. $mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON);
  355.  
  356. $include_self_reply_all =
  357.     getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON);
  358.  
  359. /* Page selector options */
  360. $page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
  361. $compact_paginator = getPref($data_dir, $username, 'compact_paginator', SMPREF_OFF);
  362. $page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
  363.  
  364. /* SqClock now in the core */
  365. $date_format = getPref($data_dir, $username, 'date_format', 3);
  366. $hour_format = getPref($data_dir, $username, 'hour_format', SMPREF_TIME_12HR);
  367.  
  368. /*  compose in new window setting */
  369. $compose_new_win = getPref($data_dir, $username, 'compose_new_win', SMPREF_OFF);
  370. $compose_height = getPref($data_dir, $username, 'compose_height', 550);
  371. $compose_width = getPref($data_dir, $username, 'compose_width', 640);
  372.  
  373.  
  374. /* signature placement settings */
  375. $sig_first = getPref($data_dir, $username, 'sig_first', SMPREF_OFF);
  376.  
  377. /* Strip signature when replying */
  378. $strip_sigs = getPref($data_dir, $username, 'strip_sigs', SMPREF_ON);
  379.  
  380. /* use the internal date of the message for sorting instead of the supplied header date */
  381. $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
  382.  
  383. /* if server sorting is enabled/disabled */
  384. $sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', SMPREF_ON);
  385.  
  386. /* Load the javascript settings. */
  387. $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
  388. if ( checkForJavascript() )
  389. {
  390.   $use_javascript_folder_list = getPref($data_dir, $username, 'use_javascript_folder_list');
  391.   $use_javascript_addr_book = getPref($data_dir, $username, 'use_javascript_addr_book', $default_use_javascript_addr_book);
  392. } else {
  393.   $use_javascript_folder_list = false;
  394.   $use_javascript_addr_book = false;
  395. }
  396.  
  397. $search_memory = getPref($data_dir, $username, 'search_memory', SMPREF_OFF);
  398.  
  399. $show_only_subscribed_folders =
  400.     getPref($data_dir, $username, 'show_only_subscribed_folders', SMPREF_ON);
  401.  
  402.  
  403. $forward_cc = getPref($data_dir, $username, 'forward_cc', SMPREF_OFF);
  404.  
  405. /* How are mailbox select lists displayed: 0. full names, 1. indented (default),
  406.  * 3. delimited) */
  407. $mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_ON);
  408.  
  409. /* Allow user to customize, and display the full date, instead of day, or time based
  410.    on time distance from date of message */
  411. $show_full_date = getPref($data_dir, $username, 'show_full_date', SMPREF_OFF);
  412.  
  413. /* Allow user to customize length of from field */
  414. $truncate_sender = getPref($data_dir, $username, 'truncate_sender', 50);
  415. /* Allow user to customize length of subject field */
  416. $truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
  417. /* Allow user to show recipient name if the message is from default identity */
  418. $show_recipient_instead = getPref($data_dir, $username, 'show_recipient_instead', SMPREF_OFF);
  419.  
  420. $delete_prev_next_display = getPref($data_dir, $username, 'delete_prev_next_display', SMPREF_ON);
  421.  
  422. /**
  423.  * Height of iframe that displays html formated emails
  424.  * @since 1.5.1
  425.  */
  426. $iframe_height = getPref($data_dir, $username, 'iframe_height', '300');
  427.  
  428. if (! isset($default_fontset)) $default_fontset=SMPREF_NONE;
  429. $chosen_fontset = getPref($data_dir, $username, 'chosen_fontset', $default_fontset);
  430. if (! isset($default_fontsize)) $default_fontsize=SMPREF_NONE;
  431. $chosen_fontsize = getPref($data_dir, $username, 'chosen_fontsize', $default_fontsize);
  432.  
  433. /**
  434.  * Controls translation of special folders
  435.  * @since 1.5.2
  436.  */
  437. $translate_special_folders = getPref($data_dir, $username, 'translate_special_folders', SMPREF_OFF);
  438. /**
  439.  * Controls display of message copy options
  440.  * @since 1.5.2
  441.  */
  442. $show_copy_buttons = getPref($data_dir, $username, 'show_copy_buttons', SMPREF_OFF);
  443.  
  444. /** Put in a safety net for authentication here, in case a naughty admin didn't run conf.pl when they upgraded */
  445.  
  446. // TODO Get rid of "none" strings when NULL should be used, i hate them i hate them i hate them!!!.
  447. if (! isset($smtp_auth_mech)) {
  448.     $smtp_auth_mech = 'none';
  449. }
  450.  
  451. if (! isset($imap_auth_mech)) {
  452.     $imap_auth_mech = 'login';
  453. }
  454.  
  455. if (! isset($use_imap_tls)) {
  456.     $use_imap_tls = false;
  457. }
  458.  
  459. if (! isset($use_smtp_tls)) {
  460.     $use_smtp_tls = false;
  461. }
  462.  
  463. do_hook('loading_prefs');

Documentation generated on Sat, 07 Oct 2006 16:12:13 +0300 by phpDocumentor 1.3.0RC6