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