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