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