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