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