include/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$
  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 $theme = ( !isset($theme) ? array() : $theme );
  33 $color = ( !isset($color) ? array() : $color );
  34 $aTemplateSet = ( !isset($aTemplateSet) ? array() : $aTemplateSet );
  35 $templateset_default = ( !isset($templateset_default) ? 0 : $templateset_default );
  36
  37 $chosen_theme = getPref($data_dir, $username, 'chosen_theme');
  38 $sTplDir = getPref($data_dir, $username, 'sTplDir', SM_PATH . 'templates/default/');
  39 $found_templateset = false;
  40
  41 /* need to adjust $chosen_template path with SM_PATH */
  42 $sTplDir = preg_replace("/(\.\.\/){1,}/", SM_PATH, $sTplDir);
  43
  44 for ($i = 0; $i < count($aTemplateSet); ++$i){
  45     if ($aTemplateSet[$i]['PATH'] == $sTplDir) {
  46         $found_templateset = true;
  47         break;
  48     }
  49 }
  50 $sTplDir = ($found_templateset ? $sTplDir : '');
  51 if (!$found_templateset) {
  52     if (isset($aTemplateSet) && isset($aTemplateSet[$templateset_default]) && file_exists($aTemplateSet[$templateset_default]['PATH'])) {
  53        $sTplDir = $aTemplateSet[$templateset_default]['PATH'];
  54     } else {
  55        $sTplDir = SM_PATH.'templates/default/';
  56     }
  57 } else if (!file_exists($sTplDir)) {
  58     $sTplDir = SM_PATH.'templates/default/';
  59 }
  60
  61 $found_theme = false;
  62
  63 /* need to adjust $chosen_theme path with SM_PATH */
  64 $chosen_theme = preg_replace("/(\.\.\/){1,}/", SM_PATH, $chosen_theme);
  65
  66 for ($i = 0; $i < count($theme); ++$i){
  67     if ($theme[$i]['PATH'] == $chosen_theme) {
  68         $found_theme = true;
  69         break;
  70     }
  71 }
  72
  73 $chosen_theme = (!$found_theme ? '' : $chosen_theme);
  74
  75 if (isset($chosen_theme) && $found_theme && (file_exists($chosen_theme))) {
  76     @include_once($chosen_theme);
  77 } else {
  78     if (isset($theme) && isset($theme[$theme_default]) && file_exists($theme[$theme_default]['PATH'])) {
  79         @include_once($theme[$theme_default]['PATH']);
  80         $chosen_theme = $theme[$theme_default]['PATH'];
  81     }
  82 }
  83
  84 // user's icon theme, if using icons
  85 $icon_theme = getPref($data_dir, $username, 'icon_theme', 'images/themes/xp/' );
  86
  87 /*
  88  * NOTE: The $icon_theme_path var should contain the path to the icon
  89  *       theme to use.  If the admin has disabled icons, or the user has
  90  *       set the icon theme to "None," no icons will be used.
  91  */
  92 $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? $sTplDir . 'images/' : $icon_theme);
  93
  94 // show (or not) flag and unflag buttons on mailbox list screen
  95 $show_flag_buttons = getPref($data_dir, $username, 'show_flag_buttons', SMPREF_ON );
  96
  97 /* Load the user's special folder preferences */
  98 $move_to_sent =
  99     getPref($data_dir, $username, 'move_to_sent', $default_move_to_sent);
 100 $move_to_trash =
 101     getPref($data_dir, $username, 'move_to_trash', $default_move_to_trash);
 102 $save_as_draft =
 103     getPref($data_dir, $username, 'save_as_draft', $default_save_as_draft);
 104
 105 if ($default_unseen_type == '') {
 106     $default_unseen_type = 1;
 107 }
 108 if ($default_unseen_notify == '') {
 109     $default_unseen_notify = 2;
 110 }
 111 $unseen_type =
 112     getPref($data_dir, $username, 'unseen_type', $default_unseen_type);
 113 $unseen_notify =
 114     getPref($data_dir, $username, 'unseen_notify', $default_unseen_notify);
 115
 116 $unseen_cum =
 117     getPref($data_dir, $username, 'unseen_cum', false);
 118
 119 $folder_prefix =
 120     getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
 121
 122 /* Load special folder - trash */
 123 $load_trash_folder = getPref($data_dir, $username, 'trash_folder');
 124 if (($load_trash_folder == '') && ($move_to_trash)) {
 125     $trash_folder = $folder_prefix . $trash_folder;
 126 } else {
 127     $trash_folder = $load_trash_folder;
 128 }
 129
 130 /* Load special folder - sent */
 131 $load_sent_folder = getPref($data_dir, $username, 'sent_folder');
 132 if (($load_sent_folder == '') && ($move_to_sent)) {
 133     $sent_folder = $folder_prefix . $sent_folder;
 134 } else {
 135     $sent_folder = $load_sent_folder;
 136 }
 137
 138 /* Load special folder - draft */
 139 $load_draft_folder = getPref($data_dir, $username, 'draft_folder');
 140 if (($load_draft_folder == '') && ($save_as_draft)) {
 141     $draft_folder = $folder_prefix . $draft_folder;
 142 } else {
 143     $draft_folder = $load_draft_folder;
 144 }
 145
 146 $show_num = getPref($data_dir, $username, 'show_num', 15 );
 147
 148 $wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
 149 if ($wrap_at < 15) { $wrap_at = 15; }
 150
 151 $left_size = getPref($data_dir, $username, 'left_size');
 152 if ($left_size == '') {
 153     if (isset($default_left_size)) {
 154         $left_size = $default_left_size;
 155     } else {
 156         $left_size = 200;
 157     }
 158 }
 159
 160 $editor_size = getPref($data_dir, $username, 'editor_size', 76 );
 161 $editor_height = getPref($data_dir, $username, 'editor_height', 20 );
 162 $use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF );
 163 $prefix_sig = getPref($data_dir, $username, 'prefix_sig');
 164
 165 /* Load timezone preferences */
 166 $timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE );
 167
 168 /* Load preferences for reply citation style. */
 169
 170 $reply_citation_style =
 171     getPref($data_dir, $username, 'reply_citation_style', 'date_time_author' );
 172 $reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
 173 $reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
 174
 175 $body_quote = getPref($data_dir, $username, 'body_quote', '>');
 176 if ($body_quote == 'NONE') $body_quote = '';
 177
 178 // who is using those darn block comments?  poo!
 179
 180 // Load preference for cursor behavior for replies
 181 //
 182 $reply_focus = getPref($data_dir, $username, 'reply_focus', '');
 183
 184 /* left refresh rate, strtolower makes 1.0.6 prefs compatible */
 185 $left_refresh = getPref($data_dir, $username, 'left_refresh', 600 );
 186 $left_refresh = strtolower($left_refresh);
 187
 188 /* Load up the Signature file */
 189 $signature_abs = $signature = getSig($data_dir, $username, 'g');
 190
 191 /* Message Highlighting Rules */
 192 $message_highlight_list = array();
 193
 194 /* use new way of storing highlighting rules */
 195 if( $ser = getPref($data_dir, $username, 'hililist') ) {
 196     $message_highlight_list = unserialize($ser);
 197 } else {
 198     /* use old way */
 199     for ($i = 0; $hlt = getPref($data_dir, $username, "highlight$i"); ++$i) {
 200         $highlight_array = explode(',', $hlt);
 201         $message_highlight_list[$i]['name'] = $highlight_array[0];
 202         $message_highlight_list[$i]['color'] = $highlight_array[1];
 203         $message_highlight_list[$i]['value'] = $highlight_array[2];
 204         $message_highlight_list[$i]['match_type'] = $highlight_array[3];
 205         removePref($data_dir, $username, "highlight$i");
 206     }
 207     /* store in new format for the next time */
 208     setPref($data_dir, $username, 'hililist', serialize($message_highlight_list));
 209 }
 210
 211 /* use the internal date of the message for sorting instead of the supplied header date */
 212 /* OBSOLETE */
 213
 214 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
 215
 216 /* Index order lets you change the order of the message index */
 217 $order = getPref($data_dir, $username, 'order1');
 218 if (isset($order1)) {
 219     removePref($data_dir, $username, 'order1');
 220     for ($i = 1; $order; ++$i) {
 221         $index_order[$i-1] = $order -1;
 222         $order = getPref($data_dir, $username, 'order'.($i+1));
 223         removePref($data_dir, $username, 'order'.($i+1));
 224     }
 225     if (isset($internal_date_sort) && $internal_date_sort) {
 226         if (in_array(SQM_COL_DATE,$index_order)) {
 227             $k = array_search(SQM_COL_DATE,$index_order,true);
 228             $index_order[$k] = SQM_COL_INT_DATE;
 229         }
 230     }
 231     setPref($data_dir, $username, 'index_order', serialize($index_order));
 232 }
 233 $index_order = getPref($data_dir, $username, 'index_order');
 234 if (is_string($index_order)) {
 235     $index_order = unserialize($index_order);
 236 }
 237
 238
 239 // new Index order handling
 240 //$default_mailbox_pref = unserialize(getPref($data_dir, $username, 'default_mailbox_pref'));
 241
 242 if (!$index_order) {
 243     if (isset($internal_date_sort) && $internal_date_sort == false) {
 244         $index_order = array(SQM_COL_CHECK,SQM_COL_FROM,SQM_COL_DATE,SQM_COL_FLAGS,SQM_COL_ATTACHMENT,SQM_COL_PRIO,SQM_COL_SUBJ);
 245     } else {
 246         $index_order = array(SQM_COL_CHECK,SQM_COL_FROM,SQM_COL_INT_DATE,SQM_COL_FLAGS,SQM_COL_ATTACHMENT,SQM_COL_PRIO,SQM_COL_SUBJ);
 247     }
 248     setPref($data_dir, $username, 'index_order', serialize($index_order));
 249 }
 250
 251 if (!isset($default_mailbox_pref)) {
 252     $show_num = (isset($show_num)) ? $show_num : 15;
 253
 254     $default_mailbox_pref = array (
 255         MBX_PREF_SORT => 0,
 256         MBX_PREF_LIMIT => $show_num,
 257         MBX_PREF_AUTO_EXPUNGE => $auto_expunge,
 258         MBX_PREF_COLUMNS => $index_order);
 259     // setPref($data_dir, $username, 'default_mailbox_pref', serialize($default_mailbox_pref));
 260     // clean up the old prefs
 261 //    if (isset($prefs_cache['internal_date_sort'])) {
 262 //        unset($prefs_cache['internal_date_sort']);
 263 //        removePref($data_dir,$username,'internal_date_sort');
 264 //    }
 265 //    if (isset($prefs_cache['show_num'])) {
 266 //        unset($prefs_cache['show_num']);
 267 //        removePref($data_dir,$username,'show_num');
 268 //    }
 269 }
 270
 271
 272 $alt_index_colors =
 273     getPref($data_dir, $username, 'alt_index_colors', SMPREF_ON );
 274
 275 $fancy_index_highlite =
 276     getPref($data_dir, $username, 'fancy_index_highlite', SMPREF_ON );
 277
 278 /* Folder List Display Format */
 279 $location_of_bar =
 280     getPref($data_dir, $username, 'location_of_bar', SMPREF_LOC_LEFT);
 281 $location_of_buttons =
 282     getPref($data_dir, $username, 'location_of_buttons', SMPREF_LOC_BETWEEN);
 283
 284 $collapse_folders =
 285     getPref($data_dir, $username, 'collapse_folders', SMPREF_ON);
 286
 287 $show_html_default =
 288    getPref($data_dir, $username, 'show_html_default', SMPREF_ON);
 289
 290 $enable_forward_as_attachment =
 291    getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON);
 292
 293 $show_xmailer_default =
 294     getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF );
 295 $attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF );
 296
 297
 298 /* message disposition notification support setting */
 299 $mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON);
 300
 301 $include_self_reply_all =
 302     getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON);
 303
 304 /* Page selector options */
 305 $page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
 306 $compact_paginator = getPref($data_dir, $username, 'compact_paginator', SMPREF_OFF);
 307 $page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
 308
 309 /* SqClock now in the core */
 310 $date_format = getPref($data_dir, $username, 'date_format', 3);
 311 $hour_format = getPref($data_dir, $username, 'hour_format', SMPREF_TIME_12HR);
 312
 313 /*  compose in new window setting */
 314 $compose_new_win = getPref($data_dir, $username, 'compose_new_win', SMPREF_OFF);
 315 $compose_height = getPref($data_dir, $username, 'compose_height', 550);
 316 $compose_width = getPref($data_dir, $username, 'compose_width', 640);
 317
 318
 319 /* signature placement settings */
 320 $sig_first = getPref($data_dir, $username, 'sig_first', SMPREF_OFF);
 321
 322 /* Strip signature when replying */
 323 $strip_sigs = getPref($data_dir, $username, 'strip_sigs', SMPREF_ON);
 324
 325 /* use the internal date of the message for sorting instead of the supplied header date */
 326 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
 327
 328 /* if server sorting is enabled/disabled */
 329 $sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', SMPREF_ON);
 330
 331 /* Load the javascript settings. */
 332 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
 333 if ( checkForJavascript() )
 334 {
 335   $use_javascript_folder_list = getPref($data_dir, $username, 'use_javascript_folder_list');
 336   $use_javascript_addr_book = getPref($data_dir, $username, 'use_javascript_addr_book', $default_use_javascript_addr_book);
 337 } else {
 338   $use_javascript_folder_list = false;
 339   $use_javascript_addr_book = false;
 340 }
 341
 342 $search_memory = getPref($data_dir, $username, 'search_memory', SMPREF_OFF);
 343
 344 $show_only_subscribed_folders =
 345     getPref($data_dir, $username, 'show_only_subscribed_folders', SMPREF_ON);
 346
 347
 348 $forward_cc = getPref($data_dir, $username, 'forward_cc', SMPREF_OFF);
 349
 350 /* How are mailbox select lists displayed: 0. full names, 1. indented (default),
 351  * 3. delimited) */
 352 $mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_ON);
 353
 354 /* Allow user to customize, and display the full date, instead of day, or time based
 355    on time distance from date of message */
 356 $show_full_date = getPref($data_dir, $username, 'show_full_date', SMPREF_OFF);
 357
 358 /* Allow user to customize length of from field */
 359 $truncate_sender = getPref($data_dir, $username, 'truncate_sender', 50);
 360 /* Allow user to customize length of subject field */
 361 $truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
 362 /* Allow user to show recipient name if the message is from default identity */
 363 $show_recipient_instead = getPref($data_dir, $username, 'show_recipient_instead', SMPREF_OFF);
 364
 365 $delete_prev_next_display = getPref($data_dir, $username, 'delete_prev_next_display', SMPREF_ON);
 366
 367 /**
 368  * Height of iframe that displays html formated emails
 369  * @since 1.5.1
 370  */
 371 $iframe_height = getPref($data_dir, $username, 'iframe_height', '300');
 372
 373 if (! isset($default_fontset)) $default_fontset=SMPREF_NONE;
 374 $chosen_fontset = getPref($data_dir, $username, 'chosen_fontset', $default_fontset);
 375 if (! isset($default_fontsize)) $default_fontsize=SMPREF_NONE;
 376 $chosen_fontsize = getPref($data_dir, $username, 'chosen_fontsize', $default_fontsize);
 377
 378 /**
 379  * Controls translation of special folders
 380  * @since 1.5.2
 381  */
 382 $translate_special_folders = getPref($data_dir, $username, 'translate_special_folders', SMPREF_OFF);
 383 /**
 384  * Controls display of message copy options
 385  * @since 1.5.2
 386  */
 387 $show_copy_buttons = getPref($data_dir, $username, 'show_copy_buttons', SMPREF_OFF);
 388
 389 /** Put in a safety net for authentication here, in case a naughty admin didn't run conf.pl when they upgraded */
 390
 391 // TODO Get rid of "none" strings when NULL should be used, i hate them i hate them i hate them!!!.
 392 if (! isset($smtp_auth_mech)) {
 393     $smtp_auth_mech = 'none';
 394 }
 395
 396 if (! isset($imap_auth_mech)) {
 397     $imap_auth_mech = 'login';
 398 }
 399
 400 if (! isset($use_imap_tls)) {
 401     $use_imap_tls = false;
 402 }
 403
 404 if (! isset($use_smtp_tls)) {
 405     $use_smtp_tls = false;
 406 }
 407
 408 do_hook('loading_prefs');