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