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