include/options/display.php

   1 <?php
   2
   3 /**
   4  * options_display.php
   5  *
   6  * Displays all optinos about display preferences
   7  *
   8  * @copyright &copy; 1999-2005 The SquirrelMail Project Team
   9  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10  * @version $Id$
  11  * @package squirrelmail
  12  */
  13
  14 /** Define the group constants for the display options page. */
  15 define('SMOPT_GRP_GENERAL', 0);
  16 define('SMOPT_GRP_MAILBOX', 1);
  17 define('SMOPT_GRP_MESSAGE', 2);
  18
  19 // load icon themes if in use
  20 global $use_icons;
  21 if ($use_icons) {
  22     global $icon_themes;
  23     $dirName = SM_PATH . 'images/themes';
  24     if (is_readable($dirName) && is_dir($dirName)) {
  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 global $use_iframe;
  36 if (! isset($use_iframe)) $use_iframe=false;
  37
  38 /**
  39  * This function builds an array with all the information about
  40  * the options available to the user, and returns it. The options
  41  * are grouped by the groups in which they are displayed.
  42  * For each option, the following information is stored:
  43  * - name: the internal (variable) name
  44  * - caption: the description of the option in the UI
  45  * - type: one of SMOPT_TYPE_*
  46  * - refresh: one of SMOPT_REFRESH_*
  47  * - size: one of SMOPT_SIZE_*
  48  * - save: the name of a function to call when saving this option
  49  * @return array all option information
  50  */
  51 function load_optpage_data_display() {
  52     global $theme, $fontsets, $language, $languages,
  53     $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
  54     $show_alternative_names, $use_icons, $use_iframe;
  55
  56     /* Build a simple array into which we will build options. */
  57     $optgrps = array();
  58     $optvals = array();
  59
  60     /******************************************************/
  61     /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
  62     /******************************************************/
  63
  64     /*** Load the General Options into the array ***/
  65     $optgrps[SMOPT_GRP_GENERAL] = _("General Display Options");
  66     $optvals[SMOPT_GRP_GENERAL] = array();
  67
  68     /* Load the theme option. */
  69     $theme_values = array();
  70     foreach ($theme as $theme_key => $theme_attributes) {
  71         $theme_values[$theme_attributes['NAME']] = $theme_attributes['PATH'];
  72     }
  73     ksort($theme_values);
  74     $theme_values = array_flip($theme_values);
  75     $optvals[SMOPT_GRP_GENERAL][] = array(
  76         'name'    => 'chosen_theme',
  77         'caption' => _("Theme"),
  78         'type'    => SMOPT_TYPE_STRLIST,
  79         'refresh' => SMOPT_REFRESH_ALL,
  80         'posvals' => $theme_values,
  81         'save'    => 'save_option_theme'
  82     );
  83
  84     $css_values = array( 'none' => _("Default" ) );
  85     $css_dir = SM_PATH . 'themes/css';
  86     if (is_readable($css_dir) && is_dir($css_dir)) {
  87         $handle=opendir($css_dir);
  88         while ($file = readdir($handle) ) {
  89             if ( substr( $file, -4 ) == '.css' ) {
  90                 $css_values[$file] = substr( $file, 0, strlen( $file ) - 4 );
  91             }
  92         }
  93         closedir($handle);
  94     }
  95
  96     /*
  97     if ( count( $css_values ) > 1 ) {
  98
  99         $optvals[SMOPT_GRP_GENERAL][] = array(
 100             'name'    => 'custom_css',
 101             'caption' => _("Custom Stylesheet"),
 102             'type'    => SMOPT_TYPE_STRLIST,
 103             'refresh' => SMOPT_REFRESH_ALL,
 104             'posvals' => $css_values
 105         );
 106
 107     }
 108     */
 109
 110     $fontset_values = array();
 111     foreach (array_keys($fontsets) as $fontset_key) {
 112         $fontset_list[$fontset_key]=$fontset_key;
 113     }
 114     ksort($fontset_list);
 115
 116     if (count($fontset_list) > 1) {
 117         $fontset_list = array_merge(array('' => _("Default font style")), $fontset_list);
 118         $optvals[SMOPT_GRP_GENERAL][] = array(
 119             'name'    => 'chosen_fontset',
 120             'caption' => _("Font style"),
 121             'type'    => SMOPT_TYPE_STRLIST,
 122             'refresh' => SMOPT_REFRESH_ALL,
 123             'posvals' => $fontset_list
 124         );
 125     }
 126
 127     $optvals[SMOPT_GRP_GENERAL][] = array(
 128         'name'    => 'chosen_fontsize',
 129         'caption' => _("Font size"),
 130         'type'    => SMOPT_TYPE_STRLIST,
 131         'refresh' => SMOPT_REFRESH_ALL,
 132         'posvals' => array('' => _("Default font size"),
 133                            '8' => '8 px',
 134                            '10' => '10 px',
 135                            '12' => '12 px',
 136                            '14' => '14 px')
 137     );
 138
 139     $language_values = array();
 140     foreach ($languages as $lang_key => $lang_attributes) {
 141         if (isset($lang_attributes['NAME'])) {
 142             $language_values[$lang_key] = $lang_attributes['NAME'];
 143             if ( isset($show_alternative_names) &&
 144                  $show_alternative_names &&
 145                  isset($lang_attributes['ALTNAME']) ) {
 146                 $language_values[$lang_key] .= " / " . $lang_attributes['ALTNAME'];
 147             }
 148         }
 149     }
 150
 151     asort($language_values);
 152     $language_values =
 153         array_merge(array('' => _("Default")), $language_values);
 154     $language = $squirrelmail_language;
 155
 156     // add language selection only when more than 2 languages are available
 157     // (default, English and some other)
 158     if (count($language_values)>2) {
 159         $optvals[SMOPT_GRP_GENERAL][] = array(
 160             'name'    => 'language',
 161             'caption' => _("Language"),
 162             'type'    => SMOPT_TYPE_STRLIST,
 163             'refresh' => SMOPT_REFRESH_ALL,
 164             'posvals' => $language_values,
 165             'htmlencoded' => true
 166         );
 167     }
 168
 169     /* Set values for the "use javascript" option. */
 170     $optvals[SMOPT_GRP_GENERAL][] = array(
 171         'name'    => 'javascript_setting',
 172         'caption' => _("Use Javascript"),
 173         'type'    => SMOPT_TYPE_STRLIST,
 174         'refresh' => SMOPT_REFRESH_ALL,
 175         'posvals' => array(SMPREF_JS_AUTODETECT => _("Autodetect"),
 176                            SMPREF_JS_ON         => _("Always"),
 177                            SMPREF_JS_OFF        => _("Never")),
 178         'save'    => 'save_option_javascript_autodetect',
 179         'script'  => 'onclick="document.forms[0].new_js_autodetect_results.value = \'' . SMPREF_JS_ON . '\';"'
 180     );
 181
 182     $optvals[SMOPT_GRP_GENERAL][] = array(
 183         'name'    => 'js_autodetect_results',
 184         'caption' => '',
 185         'type'    => SMOPT_TYPE_HIDDEN,
 186         'refresh' => SMOPT_REFRESH_NONE
 187         //'post_script' => $js_autodetect_script,
 188     );
 189
 190     $optvals[SMOPT_GRP_GENERAL][] = array(
 191         'name'    => 'hour_format',
 192         'caption' => _("Hour Format"),
 193         'type'    => SMOPT_TYPE_STRLIST,
 194         'refresh' => SMOPT_REFRESH_FOLDERLIST,
 195         'posvals' => array(SMPREF_TIME_12HR => _("12-hour clock"),
 196                            SMPREF_TIME_24HR => _("24-hour clock"))
 197     );
 198
 199     /*** Load the General Options into the array ***/
 200     $optgrps[SMOPT_GRP_MAILBOX] = _("Mailbox Display Options");
 201     $optvals[SMOPT_GRP_MAILBOX] = array();
 202
 203     $optvals[SMOPT_GRP_MAILBOX][] = array(
 204         'name'    => 'show_num',
 205         'caption' => _("Number of Messages per Page"),
 206         'type'    => SMOPT_TYPE_INTEGER,
 207         'refresh' => SMOPT_REFRESH_NONE,
 208         'size'    => SMOPT_SIZE_TINY
 209     );
 210
 211     $optvals[SMOPT_GRP_MAILBOX][] = array(
 212         'name'    => 'alt_index_colors',
 213         'caption' => _("Enable Alternating Row Colors"),
 214         'type'    => SMOPT_TYPE_BOOLEAN,
 215         'refresh' => SMOPT_REFRESH_NONE
 216     );
 217
 218     $optvals[SMOPT_GRP_MAILBOX][] = array(
 219         'name'    => 'fancy_index_highlite',
 220         'caption' => _("Enable Fancy Row Mouseover Highlighting"),
 221         'type'    => SMOPT_TYPE_BOOLEAN,
 222         'refresh' => SMOPT_REFRESH_NONE
 223     );
 224
 225     if ($use_icons) {
 226         global $icon_themes, $icon_theme;
 227         $temp = array();
 228         for ($count = 0; $count < sizeof($icon_themes); $count++) {
 229             $temp[$count] = $icon_themes[$count]['NAME'];
 230             if ($icon_theme == $icon_themes[$count]['PATH'])
 231                 $value = $count;
 232         }
 233         if (sizeof($icon_themes) > 0) {
 234             $optvals[SMOPT_GRP_MAILBOX][] = array(
 235                 'name'          => 'icon_theme',
 236                 'caption'       => _("Message Flags Icon Theme"),
 237                 'type'          => SMOPT_TYPE_STRLIST,
 238                 'refresh'       => SMOPT_REFRESH_NONE,
 239                 'posvals'       => $temp,
 240                 'initial_value' => $value,
 241                 'save'          => 'icon_theme_save'
 242             );
 243         }
 244     }
 245
 246     $optvals[SMOPT_GRP_MAILBOX][] = array(
 247         'name'    => 'show_flag_buttons',
 248         'caption' => _("Show Flag / Unflag Buttons"),
 249         'type'    => SMOPT_TYPE_BOOLEAN,
 250         'refresh' => SMOPT_REFRESH_NONE
 251     );
 252
 253     $optvals[SMOPT_GRP_MAILBOX][] = array(
 254         'name'    => 'page_selector',
 255         'caption' => _("Enable Page Selector"),
 256         'type'    => SMOPT_TYPE_BOOLEAN,
 257         'refresh' => SMOPT_REFRESH_NONE
 258     );
 259
 260     $optvals[SMOPT_GRP_MAILBOX][] = array(
 261         'name'    => 'compact_paginator',
 262         'caption' => _("Use Compact Page Selector"),
 263         'type'    => SMOPT_TYPE_BOOLEAN,
 264         'refresh' => SMOPT_REFRESH_NONE
 265     );
 266
 267     $optvals[SMOPT_GRP_MAILBOX][] = array(
 268         'name'    => 'page_selector_max',
 269         'caption' => _("Maximum Number of Pages to Show"),
 270         'type'    => SMOPT_TYPE_INTEGER,
 271         'refresh' => SMOPT_REFRESH_NONE,
 272         'size'    => SMOPT_SIZE_TINY
 273     );
 274
 275     $optvals[SMOPT_GRP_MAILBOX][] = array(
 276         'name'    => 'show_full_date',
 277         'caption' => _("Always Show Full Date"),
 278         'type'    => SMOPT_TYPE_BOOLEAN,
 279         'refresh' => SMOPT_REFRESH_NONE
 280     );
 281
 282     $optvals[SMOPT_GRP_MAILBOX][] = array(
 283         'name'    => 'truncate_sender',
 284         'caption' => _("Length of From/To Field (0 for full)"),
 285         'type'    => SMOPT_TYPE_INTEGER,
 286         'refresh' => SMOPT_REFRESH_NONE,
 287         'size'    => SMOPT_SIZE_TINY
 288     );
 289
 290     $optvals[SMOPT_GRP_MAILBOX][] = array(
 291         'name'    => 'truncate_subject',
 292         'caption' => _("Length of Subject Field (0 for full)"),
 293         'type'    => SMOPT_TYPE_INTEGER,
 294         'refresh' => SMOPT_REFRESH_NONE,
 295         'size'    => SMOPT_SIZE_TINY
 296     );
 297 /*
 298   disabled because the template doesn't support it (yet?)
 299     $optvals[SMOPT_GRP_MAILBOX][] = array(
 300         'name'    => 'show_recipient_instead',
 301         'caption' => _("Show recipient name if the message is from your default identity"),
 302         'type'    => SMOPT_TYPE_BOOLEAN,
 303         'refresh' => SMOPT_REFRESH_NONE,
 304         'size'    => SMOPT_SIZE_TINY
 305     );
 306 */
 307
 308     if ($allow_thread_sort == TRUE) {
 309         $optvals[SMOPT_GRP_MAILBOX][] = array(
 310             'name'    => 'sort_by_ref',
 311             'caption' => _("Enable Thread Sort by References Header"),
 312             'type'    => SMOPT_TYPE_BOOLEAN,
 313             'refresh' => SMOPT_REFRESH_ALL
 314         );
 315     }
 316
 317
 318
 319     /*** Load the General Options into the array ***/
 320     $optgrps[SMOPT_GRP_MESSAGE] = _("Message Display Options");
 321     $optvals[SMOPT_GRP_MESSAGE] = array();
 322
 323     $optvals[SMOPT_GRP_MESSAGE][] = array(
 324         'name'    => 'wrap_at',
 325         'caption' => _("Wrap Incoming Text At"),
 326         'type'    => SMOPT_TYPE_INTEGER,
 327         'refresh' => SMOPT_REFRESH_NONE,
 328         'size'    => SMOPT_SIZE_TINY
 329     );
 330
 331     $optvals[SMOPT_GRP_MESSAGE][] = array(
 332         'name'    => 'show_html_default',
 333         'caption' => _("Show HTML Version by Default"),
 334         'type'    => SMOPT_TYPE_BOOLEAN,
 335         'refresh' => SMOPT_REFRESH_NONE
 336     );
 337
 338     if ($use_iframe) {
 339         // Type is set to string in order to be able to use 100%.
 340         $optvals[SMOPT_GRP_MESSAGE][] = array(
 341             'name'    => 'iframe_height',
 342             'caption' => _("Height of inline frame"),
 343             'type'    => SMOPT_TYPE_STRING,
 344             'size'    => SMOPT_SIZE_TINY,
 345             'refresh' => SMOPT_REFRESH_NONE
 346         );
 347     }
 348     $optvals[SMOPT_GRP_MESSAGE][] = array(
 349         'name'    => 'enable_forward_as_attachment',
 350         'caption' => _("Enable Forward as Attachment"),
 351         'type'    => SMOPT_TYPE_BOOLEAN,
 352         'refresh' => SMOPT_REFRESH_NONE
 353     );
 354
 355     $optvals[SMOPT_GRP_MESSAGE][] = array(
 356         'name'    => 'show_xmailer_default',
 357         'caption' => _("Enable Mailer Display"),
 358         'type'    => SMOPT_TYPE_BOOLEAN,
 359         'refresh' => SMOPT_REFRESH_NONE
 360     );
 361
 362     $optvals[SMOPT_GRP_MESSAGE][] = array(
 363         'name'    => 'attachment_common_show_images',
 364         'caption' => _("Display Attached Images with Message"),
 365         'type'    => SMOPT_TYPE_BOOLEAN,
 366         'refresh' => SMOPT_REFRESH_NONE
 367     );
 368
 369     if ($default_use_mdn) {
 370         $optvals[SMOPT_GRP_MESSAGE][] = array(
 371             'name'    => 'mdn_user_support',
 372             'caption' => _("Enable Mail Delivery Notification"),
 373             'type'    => SMOPT_TYPE_BOOLEAN,
 374             'refresh' => SMOPT_REFRESH_NONE
 375         );
 376     }
 377
 378     $optvals[SMOPT_GRP_MESSAGE][] = array(
 379         'name'    => 'delete_prev_next_display',
 380         'caption' => _("Show 'Delete & Prev/Next' Links"),
 381         'type'    => SMOPT_TYPE_BOOLEAN,
 382         'refresh' => SMOPT_REFRESH_ALL
 383     );
 384
 385     /* Assemble all this together and return it as our result. */
 386     $result = array(
 387         'grps' => $optgrps,
 388         'vals' => $optvals
 389     );
 390     return ($result);
 391 }
 392
 393 /******************************************************************/
 394 /** Define any specialized save functions for this option page. ***/
 395 /******************************************************************/
 396
 397 /**
 398  * This function saves a new theme setting.
 399  * It updates the theme array.
 400  */
 401 function save_option_theme($option) {
 402     global $theme;
 403
 404     /* Do checking to make sure $new_theme is in the array. */
 405     $theme_in_array = false;
 406     for ($i = 0; $i < count($theme); ++$i) {
 407         if ($theme[$i]['PATH'] == $option->new_value) {
 408             $theme_in_array = true;
 409             break;
 410         }
 411     }
 412
 413     if (!$theme_in_array) {
 414         $option->new_value = '';
 415     }
 416
 417     /* Save the option like normal. */
 418     save_option($option);
 419 }
 420
 421 /**
 422  * This function saves the javascript detection option.
 423  */
 424 function save_option_javascript_autodetect($option) {
 425     save_option($option);
 426     checkForJavascript(TRUE);
 427 }
 428
 429 /**
 430  * This function saves the user's icon theme setting
 431  */
 432 function icon_theme_save($option) {
 433
 434     global $icon_themes, $data_dir, $username;
 435
 436
 437     // Don't assume the new value is there, double check
 438     // and only save if found
 439     //
 440     if (isset($icon_themes[$option->new_value]['PATH']))
 441         setPref($data_dir, $username, 'icon_theme', $icon_themes[$option->new_value]['PATH']);
 442     else
 443        setPref($data_dir, $username, 'icon_theme', 'none');
 444
 445 }
 446
 447 ?>