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