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