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