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