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-2007 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     header("Location: ../src/login.php");
  22     die();
  23 }
  24
  25 if( ! sqgetGlobalVar('username', $username, SQ_SESSION) ) {
  26     $username = '';
  27 }
  28 // TODO Get rid of "none" strings when NULL or false should be used, i hate them i hate them i hate them!!!.
  29 $custom_css = getPref($data_dir, $username, 'custom_css', 'none' );
  30
  31
  32 // template set setup
  33 //
  34 $sDefaultTemplateID = Template::get_default_template_set();
  35 if (PAGE_NAME == 'squirrelmail_rpc') {
  36     $sTemplateID = Template::get_rpc_template_set();
  37 } else {
  38     $sTemplateID = getPref($data_dir, $username, 'sTemplateID', $sDefaultTemplateID);
  39 }
  40
  41
  42 // load user theme
  43 //
  44 $chosen_theme = getPref($data_dir, $username, 'chosen_theme');
  45 $chosen_theme_path = empty($chosen_theme) ?
  46                      $chosen_theme_path = $user_themes[$user_theme_default]['PATH'] :
  47                      $chosen_theme;
  48
  49
  50 // user's icon theme, if using icons
  51 $icon_theme = getPref($data_dir, $username, 'icon_theme');
  52 $default_icon_theme = $icon_themes[$icon_theme_def]['PATH'];
  53 $fallback_icon_theme = $icon_themes[$icon_theme_fallback]['PATH'];
  54 $found_theme = false;
  55
  56 // Make sure the chosen icon theme is a legitimate one.
  57 // need to adjust $icon_theme path with SM_PATH
  58 $icon_theme = preg_replace("/(\.\.\/){1,}/", SM_PATH, $icon_theme);
  59 $k = 0;
  60 while (!$found_theme && $k < count($icon_themes)) {
  61     if ($icon_themes[$k]['PATH'] == $icon_theme)
  62         $found_theme = true;
  63     $k++;
  64 }
  65 if (!$found_theme) {
  66     $icon_theme = $default_icon_theme;
  67 }
  68
  69
  70 // show (or not) flag and unflag buttons on mailbox list screen
  71 $show_flag_buttons = getPref($data_dir, $username, 'show_flag_buttons', SMPREF_ON );
  72
  73 /* Load the user's special folder preferences */
  74 $move_to_sent =
  75     getPref($data_dir, $username, 'move_to_sent', $default_move_to_sent);
  76 $move_to_trash =
  77     getPref($data_dir, $username, 'move_to_trash', $default_move_to_trash);
  78 $save_as_draft =
  79     getPref($data_dir, $username, 'save_as_draft', $default_save_as_draft);
  80
  81 if ($default_unseen_type == '') {
  82     $default_unseen_type = 1;
  83 }
  84 if ($default_unseen_notify == '') {
  85     $default_unseen_notify = 2;
  86 }
  87 $unseen_type =
  88     getPref($data_dir, $username, 'unseen_type', $default_unseen_type);
  89 $unseen_notify =
  90     getPref($data_dir, $username, 'unseen_notify', $default_unseen_notify);
  91
  92 $unseen_cum =
  93     getPref($data_dir, $username, 'unseen_cum', false);
  94
  95 $folder_prefix =
  96     getPref($data_dir, $username, 'folder_prefix', $default_folder_prefix);
  97
  98 /* Load special folder - trash */
  99 $load_trash_folder = getPref($data_dir, $username, 'trash_folder');
 100 if (($load_trash_folder == '') && ($move_to_trash)) {
 101     $trash_folder = $folder_prefix . $trash_folder;
 102 } else {
 103     $trash_folder = $load_trash_folder;
 104 }
 105
 106 /* Load special folder - sent */
 107 $load_sent_folder = getPref($data_dir, $username, 'sent_folder');
 108 if (($load_sent_folder == '') && ($move_to_sent)) {
 109     $sent_folder = $folder_prefix . $sent_folder;
 110 } else {
 111     $sent_folder = $load_sent_folder;
 112 }
 113
 114 /* Load special folder - draft */
 115 $load_draft_folder = getPref($data_dir, $username, 'draft_folder');
 116 if (($load_draft_folder == '') && ($save_as_draft)) {
 117     $draft_folder = $folder_prefix . $draft_folder;
 118 } else {
 119     $draft_folder = $load_draft_folder;
 120 }
 121
 122 $show_num = getPref($data_dir, $username, 'show_num', 15 );
 123
 124 $wrap_at = getPref( $data_dir, $username, 'wrap_at', 86 );
 125 if ($wrap_at < 15) { $wrap_at = 15; }
 126
 127 $left_size = getPref($data_dir, $username, 'left_size');
 128 if ($left_size == '') {
 129     if (isset($default_left_size)) {
 130         $left_size = $default_left_size;
 131     } else {
 132         $left_size = 200;
 133     }
 134 }
 135
 136 $editor_size = getPref($data_dir, $username, 'editor_size', 76 );
 137 $editor_height = getPref($data_dir, $username, 'editor_height', 20 );
 138 $use_signature = getPref($data_dir, $username, 'use_signature', SMPREF_OFF );
 139 $prefix_sig = getPref($data_dir, $username, 'prefix_sig');
 140
 141 /* Load timezone preferences */
 142 $timezone = getPref($data_dir, $username, 'timezone', SMPREF_NONE );
 143
 144 /* Load preferences for reply citation style. */
 145
 146 $reply_citation_style =
 147     getPref($data_dir, $username, 'reply_citation_style', 'date_time_author' );
 148 $reply_citation_start = getPref($data_dir, $username, 'reply_citation_start');
 149 $reply_citation_end = getPref($data_dir, $username, 'reply_citation_end');
 150
 151 $body_quote = getPref($data_dir, $username, 'body_quote', '>');
 152 if ($body_quote == 'NONE') $body_quote = '';
 153
 154 // who is using those darn block comments?  poo!
 155
 156 // Load preference for cursor behavior for replies
 157 //
 158 $reply_focus = getPref($data_dir, $username, 'reply_focus', '');
 159
 160 /* left refresh rate, strtolower makes 1.0.6 prefs compatible */
 161 $left_refresh = getPref($data_dir, $username, 'left_refresh', 600 );
 162 $left_refresh = strtolower($left_refresh);
 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 $addrsrch_fullname =
 264    getPref($data_dir, $username, 'addrsrch_fullname', 'fullname');
 265
 266 $enable_forward_as_attachment =
 267    getPref($data_dir, $username, 'enable_forward_as_attachment', SMPREF_ON);
 268
 269 $show_xmailer_default =
 270     getPref($data_dir, $username, 'show_xmailer_default', SMPREF_OFF );
 271 $attachment_common_show_images = getPref($data_dir, $username, 'attachment_common_show_images', SMPREF_OFF );
 272
 273
 274 /* message disposition notification support setting */
 275 $mdn_user_support = getPref($data_dir, $username, 'mdn_user_support', SMPREF_ON);
 276
 277 $include_self_reply_all =
 278     getPref($data_dir, $username, 'include_self_reply_all', SMPREF_ON);
 279
 280 /* Page selector options */
 281 $page_selector = getPref($data_dir, $username, 'page_selector', SMPREF_ON);
 282 $compact_paginator = getPref($data_dir, $username, 'compact_paginator', SMPREF_OFF);
 283 $page_selector_max = getPref($data_dir, $username, 'page_selector_max', 10);
 284
 285 /* Abook page selector options */
 286 $abook_show_num = getPref($data_dir, $username, 'abook_show_num', 15 );
 287 $abook_page_selector = getPref($data_dir, $username, 'abook_page_selector', SMPREF_ON);
 288 $abook_compact_paginator = getPref($data_dir, $username, 'abook_compact_paginator', SMPREF_OFF);
 289 $abook_page_selector_max = getPref($data_dir, $username, 'abook_page_selector_max', 5);
 290
 291 /* SqClock now in the core */
 292 $date_format = getPref($data_dir, $username, 'date_format', 3);
 293 $hour_format = getPref($data_dir, $username, 'hour_format', SMPREF_TIME_12HR);
 294
 295 /*  compose in new window setting */
 296 $compose_new_win = getPref($data_dir, $username, 'compose_new_win', SMPREF_OFF);
 297 $compose_height = getPref($data_dir, $username, 'compose_height', 550);
 298 $compose_width = getPref($data_dir, $username, 'compose_width', 640);
 299
 300
 301 /* signature placement settings */
 302 $sig_first = getPref($data_dir, $username, 'sig_first', SMPREF_OFF);
 303
 304 /* Strip signature when replying */
 305 $strip_sigs = getPref($data_dir, $username, 'strip_sigs', SMPREF_ON);
 306
 307 /* use the internal date of the message for sorting instead of the supplied header date */
 308 $internal_date_sort = getPref($data_dir, $username, 'internal_date_sort', SMPREF_ON);
 309
 310 /* if server sorting is enabled/disabled */
 311 $sort_by_ref = getPref($data_dir, $username, 'sort_by_ref', SMPREF_ON);
 312
 313 /* Load the javascript settings. */
 314 $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
 315 if ( checkForJavascript() )
 316 {
 317   $use_javascript_folder_list = getPref($data_dir, $username, 'use_javascript_folder_list');
 318   $use_javascript_addr_book = getPref($data_dir, $username, 'use_javascript_addr_book', $default_use_javascript_addr_book);
 319 } else {
 320   $use_javascript_folder_list = false;
 321   $use_javascript_addr_book = false;
 322 }
 323
 324 $search_memory = getPref($data_dir, $username, 'search_memory', SMPREF_OFF);
 325
 326 $show_only_subscribed_folders =
 327     getPref($data_dir, $username, 'show_only_subscribed_folders', SMPREF_ON);
 328
 329
 330 /* How are mailbox select lists displayed: 0. full names, 1. indented (default),
 331  * 3. delimited) */
 332 $mailbox_select_style = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED);
 333
 334 /* Allow user to customize, and display the full date, instead of day, or time based
 335    on time distance from date of message */
 336 $custom_date_format = getPref($data_dir, $username, 'custom_date_format', '');
 337 $show_full_date = getPref($data_dir, $username, 'show_full_date', SMPREF_OFF);
 338
 339 /* Allow user to customize length of from field */
 340 $truncate_sender = getPref($data_dir, $username, 'truncate_sender', 50);
 341 /* Allow user to customize length of subject field */
 342 $truncate_subject = getPref($data_dir, $username, 'truncate_subject', 50);
 343 /* Allow user to show recipient name if the message is from default identity */
 344 $show_recipient_instead = getPref($data_dir, $username, 'show_recipient_instead', SMPREF_OFF);
 345
 346 $delete_prev_next_display = getPref($data_dir, $username, 'delete_prev_next_display', SMPREF_ON);
 347
 348 /**
 349  * Height of iframe that displays html formated emails
 350  * @since 1.5.1
 351  */
 352 $iframe_height = getPref($data_dir, $username, 'iframe_height', '300');
 353
 354 if (! isset($default_fontset)) $default_fontset=SMPREF_NONE;
 355 $chosen_fontset = getPref($data_dir, $username, 'chosen_fontset', $default_fontset);
 356 if (! isset($default_fontsize)) $default_fontsize=SMPREF_NONE;
 357 $chosen_fontsize = getPref($data_dir, $username, 'chosen_fontsize', $default_fontsize);
 358
 359 /**
 360  * Controls translation of special folders
 361  * @since 1.5.2
 362  */
 363 $translate_special_folders = getPref($data_dir, $username, 'translate_special_folders', SMPREF_OFF);
 364 /**
 365  * Controls display of message copy options
 366  * @since 1.5.2
 367  */
 368 $show_copy_buttons = getPref($data_dir, $username, 'show_copy_buttons', SMPREF_OFF);
 369
 370 /** Put in a safety net for authentication here, in case a naughty admin didn't run conf.pl when they upgraded */
 371
 372 // TODO Get rid of "none" strings when NULL should be used, i hate them i hate them i hate them!!!.
 373 if (! isset($smtp_auth_mech)) {
 374     $smtp_auth_mech = 'none';
 375 }
 376
 377 if (! isset($imap_auth_mech)) {
 378     $imap_auth_mech = 'login';
 379 }
 380
 381 if (! isset($use_imap_tls)) {
 382     $use_imap_tls = false;
 383 }
 384
 385 if (! isset($use_smtp_tls)) {
 386     $use_smtp_tls = false;
 387 }
 388
 389
 390 // allow plugins to override user prefs
 391 //
 392 do_hook('loading_prefs', $null);
 393
 394
 395 // check user prefs template selection against templates actually available
 396 //
 397 $found_templateset = false;
 398 if (PAGE_NAME == 'squirrelmail_rpc') {
 399     // RPC skins have no in-memory list
 400     if (is_dir(SM_PATH . Template::calculate_template_file_directory($sTemplateID))) {
 401         $found_templateset = true;
 402     }
 403 } else {
 404     for ($i = 0; $i < count($aTemplateSet); ++$i){
 405         if ($aTemplateSet[$i]['ID'] == $sTemplateID) {
 406             $found_templateset = true;
 407             break;
 408         }
 409     }
 410 }
 411
 412 // FIXME: do we need/want to check here for actual presence of template sets?
 413 // selected template not available, fall back to default template
 414 //
 415 if (!$found_templateset) $sTemplateID = $sDefaultTemplateID;
 416
 417 // need to build this object now because it is used below to validate
 418 // user css theme choice
 419 //
 420 $oTemplate = Template::construct_template($sTemplateID);
 421
 422
 423 // Make sure the chosen theme is a legitimate one.
 424 //
 425 // need to adjust $chosen_theme path with SM_PATH
 426 $chosen_theme_path = preg_replace("/(\.\.\/){1,}/", SM_PATH, $chosen_theme_path);
 427 $found_theme = false;
 428 while (!$found_theme && (list($index, $data) = each($user_themes))) {
 429     if ($data['PATH'] == $chosen_theme_path)
 430         $found_theme = true;
 431 }
 432
 433 if (!$found_theme) {
 434     $template_themes = $oTemplate->get_alternative_stylesheets(true);
 435     while (!$found_theme && (list($path, $name) = each($template_themes))) {
 436         if ($path == $chosen_theme_path)
 437             $found_theme = true;
 438     }
 439 }
 440
 441 if (!$found_theme || $chosen_theme == 'none') {
 442     $chosen_theme_path = NULL;
 443 }
 444
 445
 446 /*
 447  * NOTE: The $icon_theme_path var should contain the path to the icon
 448  *       theme to use.  If the admin has disabled icons, or the user has
 449  *       set the icon theme to "None," no icons will be used.
 450  */
 451 $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
 452 $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);
 453 $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);
 454
 455 /* Load up the Signature file */
 456 $signature_abs = $signature = getSig($data_dir, $username, 'g');
 457