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-2006 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,$aTemplateSet,
  53     $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
  54     $show_alternative_names, $use_icons, $use_iframe, $sTemplateID;
  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 template set option */
  69     $templateset_values = array();
  70
  71     foreach ($aTemplateSet as $sKey => $aTemplateSetAttributes) {
  72         $templateset_values[$aTemplateSetAttributes['NAME']] = $aTemplateSetAttributes['ID'];
  73     }
  74     ksort($templateset_values);
  75     $templateset_values = array_flip($templateset_values);
  76     // display template options only when there is more than one template
  77     if (count($templateset_values)>1) {
  78         $optvals[SMOPT_GRP_GENERAL][] = array(
  79             'name'    => 'sTemplateID',
  80             'caption' => _("Skin"),
  81             'type'    => SMOPT_TYPE_STRLIST,
  82             'refresh' => SMOPT_REFRESH_ALL,
  83             'posvals' => $templateset_values,
  84             'save'    => 'save_option_template'
  85         );
  86     }
  87
  88     /* Load the theme option. */
  89     $theme_values = array();
  90     // List alternate themes provided by templates first
  91 #    var_dump(Template::get_template_file_directory());
  92     #list_files
  93     foreach ($theme as $theme_key => $theme_attributes) {
  94         $theme_values[$theme_attributes['NAME']] = $theme_attributes['PATH'];
  95     }
  96     ksort($theme_values);
  97     $theme_values = array_flip($theme_values);
  98     $optvals[SMOPT_GRP_GENERAL][] = array(
  99         'name'    => 'chosen_theme',
 100         'caption' => _("Theme"),
 101         'type'    => SMOPT_TYPE_STRLIST,
 102         'refresh' => SMOPT_REFRESH_ALL,
 103         'posvals' => $theme_values,
 104         'save'    => 'save_option_theme'
 105     );
 106
 107     $css_values = array( 'none' => _("Default" ) );
 108     $css_dir = SM_PATH . 'themes/css';
 109     if (is_readable($css_dir) && is_dir($css_dir)) {
 110         $handle=opendir($css_dir);
 111         while ($file = readdir($handle) ) {
 112             if ( substr( $file, -4 ) == '.css' ) {
 113                 $css_values[$file] = substr( $file, 0, strlen( $file ) - 4 );
 114             }
 115         }
 116         closedir($handle);
 117     }
 118
 119     /* Icon theme selection */
 120     if ($use_icons) {
 121         global $icon_themes, $icon_theme;
 122
 123         $temp = array();
 124         $value = 0;
 125         for ($count = 0; $count < sizeof($icon_themes); $count++) {
 126             $temp[$icon_themes[$count]['PATH']] = $icon_themes[$count]['NAME'];
 127         }
 128         if (sizeof($icon_themes) > 0) {
 129             $optvals[SMOPT_GRP_GENERAL][] = array(
 130                 'name'          => 'icon_theme',
 131                 'caption'       => _("Icon Theme"),
 132                 'type'          => SMOPT_TYPE_STRLIST,
 133                 'refresh'       => SMOPT_REFRESH_NONE,
 134                 'posvals'       => $temp,
 135                 'save'          => 'icon_theme_save'
 136             );
 137         }
 138     }
 139
 140     $fontset_values = array();
 141     $fontset_list = array();
 142
 143     if (!empty($fontsets) && is_array($fontsets)) {
 144
 145         foreach (array_keys($fontsets) as $fontset_key) {
 146             $fontset_list[$fontset_key]=$fontset_key;
 147         }
 148         ksort($fontset_list);
 149     }
 150
 151     if (count($fontset_list) > 1) {
 152         $fontset_list = array_merge(array('' => _("Default font style")), $fontset_list);
 153         $optvals[SMOPT_GRP_GENERAL][] = array(
 154             'name'    => 'chosen_fontset',
 155             'caption' => _("Font style"),
 156             'type'    => SMOPT_TYPE_STRLIST,
 157             'refresh' => SMOPT_REFRESH_ALL,
 158             'posvals' => $fontset_list
 159         );
 160     }
 161
 162     $optvals[SMOPT_GRP_GENERAL][] = array(
 163         'name'    => 'chosen_fontsize',
 164         'caption' => _("Font size"),
 165         'type'    => SMOPT_TYPE_STRLIST,
 166         'refresh' => SMOPT_REFRESH_ALL,
 167         'posvals' => array('' => _("Default font size"),
 168                            '8' => '8 px',
 169                            '10' => '10 px',
 170                            '12' => '12 px',
 171                            '14' => '14 px')
 172     );
 173
 174     $language_values = array();
 175     foreach ($languages as $lang_key => $lang_attributes) {
 176         if (isset($lang_attributes['NAME'])) {
 177             $language_values[$lang_key] = $lang_attributes['NAME'];
 178             if ( isset($show_alternative_names) &&
 179                  $show_alternative_names &&
 180                  isset($lang_attributes['ALTNAME']) ) {
 181                 $language_values[$lang_key] .= " / " . $lang_attributes['ALTNAME'];
 182             }
 183         }
 184     }
 185
 186     asort($language_values);
 187     $language_values =
 188         array_merge(array('' => _("Default")), $language_values);
 189     $language = $squirrelmail_language;
 190
 191     // add language selection only when more than 2 languages are available
 192     // (default, English and some other)
 193     if (count($language_values)>2) {
 194         $optvals[SMOPT_GRP_GENERAL][] = array(
 195             'name'    => 'language',
 196             'caption' => _("Language"),
 197             'type'    => SMOPT_TYPE_STRLIST,
 198             'refresh' => SMOPT_REFRESH_ALL,
 199             'posvals' => $language_values,
 200             'htmlencoded' => true
 201         );
 202     }
 203
 204     /* Set values for the "use javascript" option. */
 205     $optvals[SMOPT_GRP_GENERAL][] = array(
 206         'name'    => 'javascript_setting',
 207         'caption' => _("Use Javascript"),
 208         'type'    => SMOPT_TYPE_STRLIST,
 209         'refresh' => SMOPT_REFRESH_ALL,
 210         'posvals' => array(SMPREF_JS_AUTODETECT => _("Autodetect"),
 211                            SMPREF_JS_ON         => _("Always"),
 212                            SMPREF_JS_OFF        => _("Never")),
 213         'save'    => 'save_option_javascript_autodetect',
 214         'script'  => 'onclick="document.forms[0].new_js_autodetect_results.value = \'' . SMPREF_JS_ON . '\';"'
 215     );
 216
 217     $optvals[SMOPT_GRP_GENERAL][] = array(
 218         'name'    => 'js_autodetect_results',
 219         'caption' => '',
 220         'type'    => SMOPT_TYPE_HIDDEN,
 221         'refresh' => SMOPT_REFRESH_NONE
 222         //'post_script' => $js_autodetect_script,
 223     );
 224
 225     $optvals[SMOPT_GRP_GENERAL][] = array(
 226         'name'    => 'hour_format',
 227         'caption' => _("Hour Format"),
 228         'type'    => SMOPT_TYPE_STRLIST,
 229         'refresh' => SMOPT_REFRESH_FOLDERLIST,
 230         'posvals' => array(SMPREF_TIME_12HR => _("12-hour clock"),
 231                            SMPREF_TIME_24HR => _("24-hour clock"))
 232     );
 233
 234     /*** Load the General Options into the array ***/
 235     $optgrps[SMOPT_GRP_MAILBOX] = _("Mailbox Display Options");
 236     $optvals[SMOPT_GRP_MAILBOX] = array();
 237
 238     $optvals[SMOPT_GRP_MAILBOX][] = array(
 239         'name'    => 'show_num',
 240         'caption' => _("Number of Messages per Page"),
 241         'type'    => SMOPT_TYPE_INTEGER,
 242         'refresh' => SMOPT_REFRESH_NONE,
 243         'size'    => SMOPT_SIZE_TINY
 244     );
 245
 246     $optvals[SMOPT_GRP_MAILBOX][] = array(
 247         'name'    => 'alt_index_colors',
 248         'caption' => _("Enable Alternating Row Colors"),
 249         'type'    => SMOPT_TYPE_BOOLEAN,
 250         'refresh' => SMOPT_REFRESH_NONE
 251     );
 252
 253     $optvals[SMOPT_GRP_MAILBOX][] = array(
 254         'name'    => 'fancy_index_highlite',
 255         'caption' => _("Enable Fancy Row Mouseover Highlighting"),
 256         'type'    => SMOPT_TYPE_BOOLEAN,
 257         'refresh' => SMOPT_REFRESH_NONE
 258     );
 259
 260     $optvals[SMOPT_GRP_MAILBOX][] = array(
 261         'name'    => 'show_flag_buttons',
 262         'caption' => _("Show Flag / Unflag Buttons"),
 263         'type'    => SMOPT_TYPE_BOOLEAN,
 264         'refresh' => SMOPT_REFRESH_NONE
 265     );
 266
 267     $optvals[SMOPT_GRP_MAILBOX][] = array(
 268         'name'    => 'show_copy_buttons',
 269         'caption' => _("Enable Message Copy Buttons"),
 270         'type'    => SMOPT_TYPE_BOOLEAN,
 271         'refresh' => SMOPT_REFRESH_NONE
 272     );
 273
 274     $optvals[SMOPT_GRP_MAILBOX][] = array(
 275         'name'    => 'page_selector',
 276         'caption' => _("Enable Page Selector"),
 277         'type'    => SMOPT_TYPE_BOOLEAN,
 278         'refresh' => SMOPT_REFRESH_NONE
 279     );
 280
 281     $optvals[SMOPT_GRP_MAILBOX][] = array(
 282         'name'    => 'compact_paginator',
 283         'caption' => _("Use Compact Page Selector"),
 284         'type'    => SMOPT_TYPE_BOOLEAN,
 285         'refresh' => SMOPT_REFRESH_NONE
 286     );
 287
 288     $optvals[SMOPT_GRP_MAILBOX][] = array(
 289         'name'    => 'page_selector_max',
 290         'caption' => _("Maximum Number of Pages to Show"),
 291         'type'    => SMOPT_TYPE_INTEGER,
 292         'refresh' => SMOPT_REFRESH_NONE,
 293         'size'    => SMOPT_SIZE_TINY
 294     );
 295
 296     $optvals[SMOPT_GRP_MAILBOX][] = array(
 297         'name'    => 'show_full_date',
 298         'caption' => _("Always Show Full Date"),
 299         'type'    => SMOPT_TYPE_BOOLEAN,
 300         'refresh' => SMOPT_REFRESH_NONE
 301     );
 302
 303     $optvals[SMOPT_GRP_MAILBOX][] = array(
 304         'name'    => 'truncate_sender',
 305         'caption' => _("Length of From/To Field (0 for full)"),
 306         'type'    => SMOPT_TYPE_INTEGER,
 307         'refresh' => SMOPT_REFRESH_NONE,
 308         'size'    => SMOPT_SIZE_TINY
 309     );
 310
 311     $optvals[SMOPT_GRP_MAILBOX][] = array(
 312         'name'    => 'truncate_subject',
 313         'caption' => _("Length of Subject Field (0 for full)"),
 314         'type'    => SMOPT_TYPE_INTEGER,
 315         'refresh' => SMOPT_REFRESH_NONE,
 316         'size'    => SMOPT_SIZE_TINY
 317     );
 318 /*
 319 FIXME!
 320   disabled because the template doesn't support it (yet?)
 321     $optvals[SMOPT_GRP_MAILBOX][] = array(
 322         'name'    => 'show_recipient_instead',
 323         'caption' => _("Show recipient name if the message is from your default identity"),
 324         'type'    => SMOPT_TYPE_BOOLEAN,
 325         'refresh' => SMOPT_REFRESH_NONE,
 326         'size'    => SMOPT_SIZE_TINY
 327     );
 328 */
 329
 330     if ($allow_thread_sort == TRUE) {
 331         $optvals[SMOPT_GRP_MAILBOX][] = array(
 332             'name'    => 'sort_by_ref',
 333             'caption' => _("Enable Thread Sort by References Header"),
 334             'type'    => SMOPT_TYPE_BOOLEAN,
 335             'refresh' => SMOPT_REFRESH_ALL
 336         );
 337     }
 338
 339
 340
 341     /*** Load the General Options into the array ***/
 342     $optgrps[SMOPT_GRP_MESSAGE] = _("Message Display Options");
 343     $optvals[SMOPT_GRP_MESSAGE] = array();
 344
 345     $optvals[SMOPT_GRP_MESSAGE][] = array(
 346         'name'    => 'wrap_at',
 347         'caption' => _("Wrap Incoming Text At"),
 348         'type'    => SMOPT_TYPE_INTEGER,
 349         'refresh' => SMOPT_REFRESH_NONE,
 350         'size'    => SMOPT_SIZE_TINY
 351     );
 352
 353     $optvals[SMOPT_GRP_MESSAGE][] = array(
 354         'name'    => 'show_html_default',
 355         'caption' => _("Show HTML Version by Default"),
 356         'type'    => SMOPT_TYPE_BOOLEAN,
 357         'refresh' => SMOPT_REFRESH_NONE
 358     );
 359
 360     if ($use_iframe) {
 361         // Type is set to string in order to be able to use 100%.
 362         $optvals[SMOPT_GRP_MESSAGE][] = array(
 363             'name'    => 'iframe_height',
 364             'caption' => _("Height of inline frame"),
 365             'type'    => SMOPT_TYPE_STRING,
 366             'size'    => SMOPT_SIZE_TINY,
 367             'refresh' => SMOPT_REFRESH_NONE
 368         );
 369     }
 370     $optvals[SMOPT_GRP_MESSAGE][] = array(
 371         'name'    => 'enable_forward_as_attachment',
 372         'caption' => _("Enable Forward as Attachment"),
 373         'type'    => SMOPT_TYPE_BOOLEAN,
 374         'refresh' => SMOPT_REFRESH_NONE
 375     );
 376
 377     $optvals[SMOPT_GRP_MESSAGE][] = array(
 378         'name'    => 'show_xmailer_default',
 379         'caption' => _("Enable Mailer Display"),
 380         'type'    => SMOPT_TYPE_BOOLEAN,
 381         'refresh' => SMOPT_REFRESH_NONE
 382     );
 383
 384     $optvals[SMOPT_GRP_MESSAGE][] = array(
 385         'name'    => 'attachment_common_show_images',
 386         'caption' => _("Display Attached Images with Message"),
 387         'type'    => SMOPT_TYPE_BOOLEAN,
 388         'refresh' => SMOPT_REFRESH_NONE
 389     );
 390
 391     if ($default_use_mdn) {
 392         $optvals[SMOPT_GRP_MESSAGE][] = array(
 393             'name'    => 'mdn_user_support',
 394             'caption' => _("Enable Mail Delivery Notification"),
 395             'type'    => SMOPT_TYPE_BOOLEAN,
 396             'refresh' => SMOPT_REFRESH_NONE
 397         );
 398     }
 399
 400     $optvals[SMOPT_GRP_MESSAGE][] = array(
 401         'name'    => 'delete_prev_next_display',
 402         'caption' => _("Show 'Delete &amp; Prev/Next' Links"),
 403         'type'    => SMOPT_TYPE_BOOLEAN,
 404         'refresh' => SMOPT_REFRESH_ALL
 405     );
 406
 407     /* Assemble all this together and return it as our result. */
 408     $result = array(
 409         'grps' => $optgrps,
 410         'vals' => $optvals
 411     );
 412     return ($result);
 413 }
 414
 415 /******************************************************************/
 416 /** Define any specialized save functions for this option page. ***/
 417 /******************************************************************/
 418
 419 /**
 420  * This function saves a new template setting.
 421  * It updates the template array.
 422  */
 423 function save_option_template($option) {
 424     global $aTemplateSet;
 425
 426     /* Do checking to make sure $new_theme is in the array. */
 427     $templateset_in_array = false;
 428     for ($i = 0; $i < count($aTemplateSet); ++$i) {
 429         if ($aTemplateSet[$i]['ID'] == $option->new_value) {
 430             $templateset_in_array = true;
 431             break;
 432         }
 433     }
 434
 435     if (!$templateset_in_array) {
 436         $option->new_value = '';
 437     }
 438     /* Save the option like normal. */
 439     save_option($option);
 440 }
 441
 442 /**
 443  * This function saves a new theme setting.
 444  * It updates the theme array.
 445  */
 446 function save_option_theme($option) {
 447     global $theme;
 448
 449     /* Do checking to make sure $new_theme is in the array. */
 450     $theme_in_array = false;
 451     for ($i = 0; $i < count($theme); ++$i) {
 452         if ($theme[$i]['PATH'] == $option->new_value) {
 453             $theme_in_array = true;
 454             break;
 455         }
 456     }
 457
 458     if (!$theme_in_array) {
 459         $option->new_value = '';
 460     }
 461
 462     /* Save the option like normal. */
 463     save_option($option);
 464 }
 465
 466 /**
 467  * This function saves the javascript detection option.
 468  */
 469 function save_option_javascript_autodetect($option) {
 470     save_option($option);
 471     checkForJavascript(TRUE);
 472 }
 473
 474 /**
 475  * This function saves the user's icon theme setting
 476  */
 477 function icon_theme_save($option) {
 478     global $icon_themes, $data_dir, $username;
 479
 480
 481     // Don't assume the new value is there, double check
 482     // and only save if found
 483     //
 484     $found = false;
 485     while (!$found && (list($index, $data) = each($icon_themes))) {
 486         if ($data['PATH'] == $option->new_value)
 487             $found = true;
 488     }
 489     if ($found)
 490         setPref($data_dir, $username, 'icon_theme', $option->new_value);
 491     else
 492        setPref($data_dir, $username, 'icon_theme', 'none');
 493
 494 }