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