include/options/display.php

   1 <?php
   2
   3 /**
   4  * options_display.php
   5  *
   6  * Copyright (c) 1999-2004 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * Displays all optinos about display preferences
  10  *
  11  * $Id$
  12  * @package squirrelmail
  13  */
  14
  15 /** Define the group constants for the display options page. */
  16 define('SMOPT_GRP_GENERAL', 0);
  17 define('SMOPT_GRP_MAILBOX', 1);
  18 define('SMOPT_GRP_MESSAGE', 2);
  19
  20 // load icon themes if in use
  21 global $use_icons;
  22 if ($use_icons) {
  23     global $icon_themes;
  24     $dirName = SM_PATH . 'images/themes';
  25     $d = dir($dirName);
  26     while($dir = $d->read()) {
  27         if ($dir != "." && $dir != "..") {
  28             if (is_dir($dirName."/".$dir) && file_exists("$dirName/$dir/theme.php"))
  29                 include("$dirName/$dir/theme.php");
  30         }
  31     }
  32 }
  33
  34 /**
  35  * This function builds an array with all the information about
  36  * the options available to the user, and returns it. The options
  37  * are grouped by the groups in which they are displayed.
  38  * For each option, the following information is stored:
  39  * - name: the internal (variable) name
  40  * - caption: the description of the option in the UI
  41  * - type: one of SMOPT_TYPE_*
  42  * - refresh: one of SMOPT_REFRESH_*
  43  * - size: one of SMOPT_SIZE_*
  44  * - save: the name of a function to call when saving this option
  45  * @return array all option information
  46  */
  47 function load_optpage_data_display() {
  48     global $theme, $language, $languages, $js_autodetect_results, $javascript_setting,
  49     $compose_new_win, $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
  50     $optmode, $show_alternative_names, $available_languages, $use_icons;
  51
  52     /* Build a simple array into which we will build options. */
  53     $optgrps = array();
  54     $optvals = array();
  55
  56     /******************************************************/
  57     /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
  58     /******************************************************/
  59
  60     /*** Load the General Options into the array ***/
  61     $optgrps[SMOPT_GRP_GENERAL] = _("General Display Options");
  62     $optvals[SMOPT_GRP_GENERAL] = array();
  63
  64     /* Load the theme option. */
  65     $theme_values = array();
  66     foreach ($theme as $theme_key => $theme_attributes) {
  67         $theme_values[$theme_attributes['NAME']] = $theme_attributes['PATH'];
  68     }
  69     ksort($theme_values);
  70     $theme_values = array_flip($theme_values);
  71     $optvals[SMOPT_GRP_GENERAL][] = array(
  72         'name'    => 'chosen_theme',
  73         'caption' => _("Theme"),
  74         'type'    => SMOPT_TYPE_STRLIST,
  75         'refresh' => SMOPT_REFRESH_ALL,
  76         'posvals' => $theme_values,
  77         'save'    => 'save_option_theme'
  78     );
  79
  80     $css_values = array( 'none' => _("Default" ) );
  81     $handle=opendir('../themes/css/');
  82     while ($file = readdir($handle) ) {
  83         if ( substr( $file, -4 ) == '.css' ) {
  84             $css_values[$file] = substr( $file, 0, strlen( $file ) - 4 );
  85         }
  86     }
  87     closedir($handle);
  88
  89     if ( count( $css_values ) > 1 ) {
  90
  91         $optvals[SMOPT_GRP_GENERAL][] = array(
  92             'name'    => 'custom_css',
  93             'caption' => _("Custom Stylesheet"),
  94             'type'    => SMOPT_TYPE_STRLIST,
  95             'refresh' => SMOPT_REFRESH_ALL,
  96             'posvals' => $css_values
  97         );
  98
  99     }
 100
 101     // config.php can be unupdated.
 102     if (! isset($available_languages) || $available_languages=="" ) {
 103      $available_languages="ALL"; }
 104
 105     $language_values = array();
 106     if ( strtoupper($available_languages)=='ALL') {
 107         foreach ($languages as $lang_key => $lang_attributes) {
 108             if (isset($lang_attributes['NAME'])) {
 109                 $language_values[$lang_key] = $lang_attributes['NAME'];
 110                 if ( isset($show_alternative_names) &&
 111                   $show_alternative_names &&
 112                   isset($lang_attributes['ALTNAME']) ) {
 113                     $language_values[$lang_key] .= " / " . $lang_attributes['ALTNAME'];
 114                 }
 115             }
 116         }
 117     } else if (strtoupper($available_languages)!='NONE') {
 118         // admin can set list of available languages in config
 119         $available_languages_array=explode (" ",$available_languages);
 120         foreach ($available_languages_array as $lang_key ) {
 121             if (isset($languages[$lang_key]['NAME'])) {
 122                 $language_values[$lang_key] = $languages[$lang_key]['NAME'];
 123                 if ( isset($show_alternative_names) &&
 124                  $show_alternative_names &&
 125                  isset($languages[$lang_key]['ALTNAME']) ) {
 126                     $language_values[$lang_key] .= " / " . $languages[$lang_key]['ALTNAME'];
 127                 }
 128             }
 129         }
 130     }
 131     asort($language_values);
 132     $language_values =
 133         array_merge(array('' => _("Default")), $language_values);
 134     $language = $squirrelmail_language;
 135     if (strtoupper($available_languages)!='NONE') {
 136         // if set to 'none', interface will use only default language
 137         $optvals[SMOPT_GRP_GENERAL][] = array(
 138             'name'    => 'language',
 139             'caption' => _("Language"),
 140             'type'    => SMOPT_TYPE_STRLIST,
 141             'refresh' => SMOPT_REFRESH_ALL,
 142             'posvals' => $language_values
 143         );
 144     }
 145
 146     /* Set values for the "use javascript" option. */
 147     $optvals[SMOPT_GRP_GENERAL][] = array(
 148         'name'    => 'javascript_setting',
 149         'caption' => _("Use Javascript"),
 150         'type'    => SMOPT_TYPE_STRLIST,
 151         'refresh' => SMOPT_REFRESH_ALL,
 152         'posvals' => array(SMPREF_JS_AUTODETECT => _("Autodetect"),
 153                            SMPREF_JS_ON         => _("Always"),
 154                            SMPREF_JS_OFF        => _("Never")),
 155         'save'    => 'save_option_javascript_autodetect',
 156         'script'  => 'onclick="document.forms[0].new_js_autodetect_results.value = \'' . SMPREF_JS_ON . '\';"'
 157     );
 158
 159     $optvals[SMOPT_GRP_GENERAL][] = array(
 160         'name'    => 'js_autodetect_results',
 161         'caption' => '',
 162         'type'    => SMOPT_TYPE_HIDDEN,
 163         'refresh' => SMOPT_REFRESH_NONE
 164         //'post_script' => $js_autodetect_script,
 165     );
 166
 167     /*** Load the General Options into the array ***/
 168     $optgrps[SMOPT_GRP_MAILBOX] = _("Mailbox Display Options");
 169     $optvals[SMOPT_GRP_MAILBOX] = array();
 170
 171     $optvals[SMOPT_GRP_MAILBOX][] = array(
 172         'name'    => 'show_num',
 173         'caption' => _("Number of Messages to Index"),
 174         'type'    => SMOPT_TYPE_INTEGER,
 175         'refresh' => SMOPT_REFRESH_NONE,
 176         'size'    => SMOPT_SIZE_TINY
 177     );
 178
 179     $optvals[SMOPT_GRP_MAILBOX][] = array(
 180         'name'    => 'alt_index_colors',
 181         'caption' => _("Enable Alternating Row Colors"),
 182         'type'    => SMOPT_TYPE_BOOLEAN,
 183         'refresh' => SMOPT_REFRESH_NONE
 184     );
 185
 186     if ($use_icons) {
 187         global $icon_themes, $icon_theme;
 188         $temp = array();
 189         for ($count = 0; $count < sizeof($icon_themes); $count++) {
 190             $temp[$count] = $icon_themes[$count]['NAME'];
 191             if ($icon_theme == $icon_themes[$count]['PATH'])
 192                 $value = $count;
 193         }
 194         $optvals[SMOPT_GRP_MAILBOX][] = array(
 195             'name'          => 'icon_theme',
 196             'caption'       => _("Message Flags Icon Theme"),
 197             'type'          => SMOPT_TYPE_STRLIST,
 198             'refresh'       => SMOPT_REFRESH_NONE,
 199             'posvals'       => $temp,
 200             'initial_value' => $value,
 201             'save'          => 'icon_theme_save'
 202         );
 203     }
 204
 205     $optvals[SMOPT_GRP_MAILBOX][] = array(
 206         'name'    => 'show_flag_buttons',
 207         'caption' => _("Show Flag / Unflag Buttons"),
 208         'type'    => SMOPT_TYPE_BOOLEAN,
 209         'refresh' => SMOPT_REFRESH_NONE
 210     );
 211
 212     $optvals[SMOPT_GRP_MAILBOX][] = array(
 213         'name'    => 'page_selector',
 214         'caption' => _("Enable Page Selector"),
 215         'type'    => SMOPT_TYPE_BOOLEAN,
 216         'refresh' => SMOPT_REFRESH_NONE
 217     );
 218
 219     $optvals[SMOPT_GRP_MAILBOX][] = array(
 220         'name'    => 'page_selector_max',
 221         'caption' => _("Maximum Number of Pages to Show"),
 222         'type'    => SMOPT_TYPE_INTEGER,
 223         'refresh' => SMOPT_REFRESH_NONE,
 224         'size'    => SMOPT_SIZE_TINY
 225     );
 226
 227     $optvals[SMOPT_GRP_MAILBOX][] = array(
 228         'name'    => 'show_full_date',
 229         'caption' => _("Always Show Full Date"),
 230         'type'    => SMOPT_TYPE_BOOLEAN,
 231         'refresh' => SMOPT_REFRESH_NONE
 232     );
 233
 234     $optvals[SMOPT_GRP_MAILBOX][] = array(
 235         'name'    => 'truncate_sender',
 236         'caption' => _("Length of From/To Field (0 for full)"),
 237         'type'    => SMOPT_TYPE_INTEGER,
 238         'refresh' => SMOPT_REFRESH_NONE,
 239         'size'    => SMOPT_SIZE_TINY
 240     );
 241
 242     $optvals[SMOPT_GRP_MAILBOX][] = array(
 243         'name'    => 'truncate_subject',
 244         'caption' => _("Length of Subject Field (0 for full)"),
 245         'type'    => SMOPT_TYPE_INTEGER,
 246         'refresh' => SMOPT_REFRESH_NONE,
 247         'size'    => SMOPT_SIZE_TINY
 248     );
 249
 250     $optvals[SMOPT_GRP_MAILBOX][] = array(
 251         'name'    => 'show_recipient_instead',
 252         'caption' => _("Show recipient name if the message is from your default identity"),
 253         'type'    => SMOPT_TYPE_BOOLEAN,
 254         'refresh' => SMOPT_REFRESH_NONE,
 255         'size'    => SMOPT_SIZE_TINY
 256     );
 257
 258
 259     /*** Load the General Options into the array ***/
 260     $optgrps[SMOPT_GRP_MESSAGE] = _("Message Display and Composition");
 261     $optvals[SMOPT_GRP_MESSAGE] = array();
 262
 263     $optvals[SMOPT_GRP_MESSAGE][] = array(
 264         'name'    => 'wrap_at',
 265         'caption' => _("Wrap Incoming Text At"),
 266         'type'    => SMOPT_TYPE_INTEGER,
 267         'refresh' => SMOPT_REFRESH_NONE,
 268         'size'    => SMOPT_SIZE_TINY
 269     );
 270
 271     $optvals[SMOPT_GRP_MESSAGE][] = array(
 272         'name'    => 'editor_size',
 273         'caption' => _("Width of Editor Window"),
 274         'type'    => SMOPT_TYPE_INTEGER,
 275         'refresh' => SMOPT_REFRESH_NONE,
 276         'size'    => SMOPT_SIZE_TINY
 277     );
 278
 279     $optvals[SMOPT_GRP_MESSAGE][] = array(
 280         'name'    => 'editor_height',
 281         'caption' => _("Height of Editor Window"),
 282         'type'    => SMOPT_TYPE_INTEGER,
 283         'refresh' => SMOPT_REFRESH_NONE,
 284         'size'    => SMOPT_SIZE_TINY
 285     );
 286
 287     $optvals[SMOPT_GRP_MESSAGE][] = array(
 288         'name'    => 'location_of_buttons',
 289         'caption' => _("Location of Buttons when Composing"),
 290         'type'    => SMOPT_TYPE_STRLIST,
 291         'refresh' => SMOPT_REFRESH_NONE,
 292         'posvals' => array(SMPREF_LOC_TOP     => _("Before headers"),
 293                            SMPREF_LOC_BETWEEN => _("Between headers and message body"),
 294                            SMPREF_LOC_BOTTOM  => _("After message body"))
 295     );
 296
 297
 298     $optvals[SMOPT_GRP_MESSAGE][] = array(
 299         'name'    => 'use_javascript_addr_book',
 300         'caption' => _("Addressbook Display Format"),
 301         'type'    => SMOPT_TYPE_STRLIST,
 302         'refresh' => SMOPT_REFRESH_NONE,
 303         'posvals' => array('1' => _("Javascript"),
 304                            '0' => _("HTML"))
 305     );
 306
 307     $optvals[SMOPT_GRP_MESSAGE][] = array(
 308         'name'    => 'show_html_default',
 309         'caption' => _("Show HTML Version by Default"),
 310         'type'    => SMOPT_TYPE_BOOLEAN,
 311         'refresh' => SMOPT_REFRESH_NONE
 312     );
 313
 314     $optvals[SMOPT_GRP_MESSAGE][] = array(
 315         'name'    => 'enable_forward_as_attachment',
 316         'caption' => _("Enable Forward as Attachment"),
 317         'type'    => SMOPT_TYPE_BOOLEAN,
 318         'refresh' => SMOPT_REFRESH_NONE
 319     );
 320
 321     $optvals[SMOPT_GRP_MESSAGE][] = array(
 322         'name'    => 'forward_cc',
 323         'caption' => _("Include CCs when Forwarding Messages"),
 324         'type'    => SMOPT_TYPE_BOOLEAN,
 325         'refresh' => SMOPT_REFRESH_NONE
 326     );
 327
 328     $optvals[SMOPT_GRP_MESSAGE][] = array(
 329         'name'    => 'include_self_reply_all',
 330         'caption' => _("Include Me in CC when I Reply All"),
 331         'type'    => SMOPT_TYPE_BOOLEAN,
 332         'refresh' => SMOPT_REFRESH_NONE
 333     );
 334
 335     $optvals[SMOPT_GRP_MESSAGE][] = array(
 336         'name'    => 'show_xmailer_default',
 337         'caption' => _("Enable Mailer Display"),
 338         'type'    => SMOPT_TYPE_BOOLEAN,
 339         'refresh' => SMOPT_REFRESH_NONE
 340     );
 341
 342     $optvals[SMOPT_GRP_MESSAGE][] = array(
 343         'name'    => 'attachment_common_show_images',
 344         'caption' => _("Display Attached Images with Message"),
 345         'type'    => SMOPT_TYPE_BOOLEAN,
 346         'refresh' => SMOPT_REFRESH_NONE
 347     );
 348
 349     $optvals[SMOPT_GRP_MESSAGE][] = array(
 350         'name'    => 'pf_cleandisplay',
 351         'caption' => _("Enable Printer Friendly Clean Display"),
 352         'type'    => SMOPT_TYPE_BOOLEAN,
 353         'refresh' => SMOPT_REFRESH_NONE
 354     );
 355
 356     if ($default_use_mdn) {
 357         $optvals[SMOPT_GRP_MESSAGE][] = array(
 358             'name'    => 'mdn_user_support',
 359             'caption' => _("Enable Mail Delivery Notification"),
 360             'type'    => SMOPT_TYPE_BOOLEAN,
 361             'refresh' => SMOPT_REFRESH_NONE
 362         );
 363     }
 364
 365     $optvals[SMOPT_GRP_MESSAGE][] = array(
 366         'name'    => 'compose_new_win',
 367         'caption' => _("Compose Messages in New Window"),
 368         'type'    => SMOPT_TYPE_BOOLEAN,
 369         'refresh' => SMOPT_REFRESH_ALL
 370     );
 371
 372     $optvals[SMOPT_GRP_MESSAGE][] = array(
 373         'name'    => 'compose_width',
 374         'caption' => _("Width of Compose Window"),
 375         'type'    => SMOPT_TYPE_INTEGER,
 376         'refresh' => SMOPT_REFRESH_ALL,
 377         'size'    => SMOPT_SIZE_TINY
 378     );
 379
 380     $optvals[SMOPT_GRP_MESSAGE][] = array(
 381         'name'    => 'compose_height',
 382         'caption' => _("Height of Compose Window"),
 383         'type'    => SMOPT_TYPE_INTEGER,
 384         'refresh' => SMOPT_REFRESH_ALL,
 385         'size'    => SMOPT_SIZE_TINY
 386     );
 387
 388     $optvals[SMOPT_GRP_MESSAGE][] = array(
 389         'name'    => 'sig_first',
 390         'caption' => _("Append Signature before Reply/Forward Text"),
 391         'type'    => SMOPT_TYPE_BOOLEAN,
 392         'refresh' => SMOPT_REFRESH_NONE
 393     );
 394
 395     $optvals[SMOPT_GRP_MESSAGE][] = array(
 396         'name'    => 'reply_focus',
 397         'caption' => _("Cursor Position when Replying"),
 398         'type'    => SMOPT_TYPE_STRLIST,
 399         'refresh' => SMOPT_REFRESH_NONE,
 400         'posvals' => array('' => _("To: field"),
 401                            'focus' => _("Focus in body"),
 402                            'select' => _("Select body"))
 403     );
 404
 405     $optvals[SMOPT_GRP_MESSAGE][] = array(
 406         'name'    => 'strip_sigs',
 407         'caption' => _("Strip signature when replying"),
 408         'type'    => SMOPT_TYPE_BOOLEAN,
 409         'refresh' => SMOPT_REFRESH_NONE
 410     );
 411
 412     $optvals[SMOPT_GRP_MESSAGE][] = array(
 413         'name'    => 'internal_date_sort',
 414         'caption' => _("Enable Sort by of Receive Date"),
 415         'type'    => SMOPT_TYPE_BOOLEAN,
 416         'refresh' => SMOPT_REFRESH_ALL
 417     );
 418     if ($allow_thread_sort == TRUE) {
 419         $optvals[SMOPT_GRP_MESSAGE][] = array(
 420             'name'    => 'sort_by_ref',
 421             'caption' => _("Enable Thread Sort by References Header"),
 422             'type'    => SMOPT_TYPE_BOOLEAN,
 423             'refresh' => SMOPT_REFRESH_ALL
 424         );
 425     $optvals[SMOPT_GRP_MESSAGE][] = array(
 426         'name'    => 'delete_prev_next_display',
 427         'caption' => _("Show 'Delete & Prev/Next' Links"),
 428         'type'    => SMOPT_TYPE_BOOLEAN,
 429         'refresh' => SMOPT_REFRESH_ALL
 430     );
 431
 432     }
 433     /* Assemble all this together and return it as our result. */
 434     $result = array(
 435         'grps' => $optgrps,
 436         'vals' => $optvals
 437     );
 438     return ($result);
 439 }
 440
 441 /******************************************************************/
 442 /** Define any specialized save functions for this option page. ***/
 443 /******************************************************************/
 444
 445 /**
 446  * This function saves a new theme setting.
 447  * It updates the theme array.
 448  */
 449 function save_option_theme($option) {
 450     global $theme;
 451
 452     /* Do checking to make sure $new_theme is in the array. */
 453     $theme_in_array = false;
 454     for ($i = 0; $i < count($theme); ++$i) {
 455         if ($theme[$i]['PATH'] == $option->new_value) {
 456             $theme_in_array = true;
 457             break;
 458         }
 459     }
 460
 461     if (!$theme_in_array) {
 462         $option->new_value = '';
 463     }
 464
 465     /* Save the option like normal. */
 466     save_option($option);
 467 }
 468
 469 /**
 470  * This function saves the javascript detection option.
 471  */
 472 function save_option_javascript_autodetect($option) {
 473     global $data_dir, $username;
 474
 475     save_option($option);
 476     checkForJavascript(TRUE);
 477 }
 478
 479 /**
 480  * This function saves the user's icon theme setting
 481  */
 482 function icon_theme_save($option) {
 483
 484     global $icon_themes, $data_dir, $username;
 485
 486
 487     // Don't assume the new value is there, double check
 488     // and only save if found
 489     //
 490     if (isset($icon_themes[$option->new_value]['PATH']))
 491         setPref($data_dir, $username, 'icon_theme', $icon_themes[$option->new_value]['PATH']);
 492     else
 493        setPref($data_dir, $username, 'icon_theme', 'none');
 494
 495 }
 496
 497 ?>