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