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