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