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