Merging FIXME into one row.
[squirrelmail.git] / include / options / display.php
CommitLineData
c36ed9cf 1<?php
e7db48af 2
35586184 3/**
4 * options_display.php
5 *
35586184 6 * Displays all optinos about display preferences
7 *
4b5049de 8 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
4b4abf93 9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
763b63fe 10 * @version $Id$
2b646597 11 * @package squirrelmail
35586184 12 */
cbe5423b 13
2b646597 14/** Define the group constants for the display options page. */
cbe5423b 15define('SMOPT_GRP_GENERAL', 0);
16define('SMOPT_GRP_MAILBOX', 1);
17define('SMOPT_GRP_MESSAGE', 2);
18
a144f6b8 19global $use_iframe;
20if (! isset($use_iframe)) $use_iframe=false;
21
48af4b64 22/**
23 * This function builds an array with all the information about
24 * the options available to the user, and returns it. The options
25 * are grouped by the groups in which they are displayed.
26 * For each option, the following information is stored:
27 * - name: the internal (variable) name
28 * - caption: the description of the option in the UI
29 * - type: one of SMOPT_TYPE_*
30 * - refresh: one of SMOPT_REFRESH_*
31 * - size: one of SMOPT_SIZE_*
32 * - save: the name of a function to call when saving this option
33 * @return array all option information
34 */
cbe5423b 35function load_optpage_data_display() {
299d1d03 36 global $theme, $fontsets, $language, $languages,$aTemplateSet,
ce68b76b 37 $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
1e721874 38 $show_alternative_names, $use_iframe, $use_icons,
39 $sTemplateID, $oTemplate,
40 $user_themes, $chosen_theme;
a3ec3c91 41
ce393174 42 /* Build a simple array into which we will build options. */
bbcafebd 43 $optgrps = array();
44 $optvals = array();
a3ec3c91 45
bbcafebd 46 /******************************************************/
47 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
48 /******************************************************/
bbcafebd 49
50 /*** Load the General Options into the array ***/
51 $optgrps[SMOPT_GRP_GENERAL] = _("General Display Options");
52 $optvals[SMOPT_GRP_GENERAL] = array();
53
299d1d03 54 /* load the template set option */
55 $templateset_values = array();
56
57 foreach ($aTemplateSet as $sKey => $aTemplateSetAttributes) {
28294310 58 $templateset_values[$aTemplateSetAttributes['NAME']] = $aTemplateSetAttributes['ID'];
299d1d03 59 }
60 ksort($templateset_values);
61 $templateset_values = array_flip($templateset_values);
9edbc08b 62 // display template options only when there is more than one template
63 if (count($templateset_values)>1) {
64 $optvals[SMOPT_GRP_GENERAL][] = array(
28294310 65 'name' => 'sTemplateID',
66 'caption' => _("Skin"),
9edbc08b 67 'type' => SMOPT_TYPE_STRLIST,
68 'refresh' => SMOPT_REFRESH_ALL,
69 'posvals' => $templateset_values,
70 'save' => 'save_option_template'
71 );
72 }
299d1d03 73
bbcafebd 74 /* Load the theme option. */
ce393174 75 $theme_values = array();
deb25c8f 76
77 // Always provide the template default first.
78 $theme_values['none'] = 'Template Default Theme';
79
dfbd2895 80 // List alternate themes provided by templates first
83fc5c5e 81 $template_themes = $oTemplate->get_alternative_stylesheets(true);
f9376f0b 82 asort($template_themes);
83 foreach ($template_themes as $sheet=>$name) {
83fc5c5e 84 $theme_values[$sheet] = 'Template Theme - '.htmlspecialchars($name);
deb25c8f 85 }
f9376f0b 86 // Next, list user-provided styles
82351c82 87 asort($user_themes);
88 foreach ($user_themes as $style) {
89 if ($style['PATH'] == 'none')
90 continue;
83fc5c5e 91 $theme_values[$style['PATH']] = 'User Theme - '.htmlspecialchars($style['NAME']);
ce393174 92 }
deb25c8f 93
82351c82 94 if (count($user_themes) + count($template_themes) > 1) {
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' => 'css_theme_save'
102 );
103 }
5d110fa6 104
dfbd2895 105 /* Icon theme selection */
106 if ($use_icons) {
107 global $icon_themes, $icon_theme;
5d110fa6 108
dfbd2895 109 $temp = array();
110 $value = 0;
111 for ($count = 0; $count < sizeof($icon_themes); $count++) {
112 $temp[$icon_themes[$count]['PATH']] = $icon_themes[$count]['NAME'];
113 }
114 if (sizeof($icon_themes) > 0) {
115 $optvals[SMOPT_GRP_GENERAL][] = array(
116 'name' => 'icon_theme',
117 'caption' => _("Icon Theme"),
118 'type' => SMOPT_TYPE_STRLIST,
119 'refresh' => SMOPT_REFRESH_NONE,
120 'posvals' => $temp,
121 'save' => 'icon_theme_save'
122 );
123 }
e2cdae1f 124 }
81132de8 125
126 $fontset_values = array();
bed0ac1d 127 $fontset_list = array();
128
129 if (!empty($fontsets) && is_array($fontsets)) {
130
131 foreach (array_keys($fontsets) as $fontset_key) {
132 $fontset_list[$fontset_key]=$fontset_key;
133 }
134 ksort($fontset_list);
81132de8 135 }
81132de8 136
137 if (count($fontset_list) > 1) {
138 $fontset_list = array_merge(array('' => _("Default font style")), $fontset_list);
139 $optvals[SMOPT_GRP_GENERAL][] = array(
140 'name' => 'chosen_fontset',
141 'caption' => _("Font style"),
142 'type' => SMOPT_TYPE_STRLIST,
143 'refresh' => SMOPT_REFRESH_ALL,
144 'posvals' => $fontset_list
145 );
146 }
147
148 $optvals[SMOPT_GRP_GENERAL][] = array(
149 'name' => 'chosen_fontsize',
150 'caption' => _("Font size"),
151 'type' => SMOPT_TYPE_STRLIST,
152 'refresh' => SMOPT_REFRESH_ALL,
153 'posvals' => array('' => _("Default font size"),
154 '8' => '8 px',
155 '10' => '10 px',
156 '12' => '12 px',
157 '14' => '14 px')
158 );
39d3ec89 159
e557fdb0 160 $language_values = array();
5ba5dc8e 161 foreach ($languages as $lang_key => $lang_attributes) {
162 if (isset($lang_attributes['NAME'])) {
163 $language_values[$lang_key] = $lang_attributes['NAME'];
164 if ( isset($show_alternative_names) &&
165 $show_alternative_names &&
166 isset($lang_attributes['ALTNAME']) ) {
167 $language_values[$lang_key] .= " / " . $lang_attributes['ALTNAME'];
0bb37159 168 }
169 }
ce393174 170 }
5ba5dc8e 171
e557fdb0 172 asort($language_values);
8405d0a4 173 $language_values =
174 array_merge(array('' => _("Default")), $language_values);
ec2c91a1 175 $language = $squirrelmail_language;
5ba5dc8e 176
299d1d03 177 // add language selection only when more than 2 languages are available
48d5ec1f 178 // (default, English and some other)
179 if (count($language_values)>2) {
180 $optvals[SMOPT_GRP_GENERAL][] = array(
181 'name' => 'language',
182 'caption' => _("Language"),
183 'type' => SMOPT_TYPE_STRLIST,
184 'refresh' => SMOPT_REFRESH_ALL,
185 'posvals' => $language_values,
186 'htmlencoded' => true
187 );
188 }
ce393174 189
a3ec3c91 190 /* Set values for the "use javascript" option. */
bbcafebd 191 $optvals[SMOPT_GRP_GENERAL][] = array(
a3ec3c91 192 'name' => 'javascript_setting',
ce393174 193 'caption' => _("Use Javascript"),
a3ec3c91 194 'type' => SMOPT_TYPE_STRLIST,
195 'refresh' => SMOPT_REFRESH_ALL,
196 'posvals' => array(SMPREF_JS_AUTODETECT => _("Autodetect"),
197 SMPREF_JS_ON => _("Always"),
ae958cd3 198 SMPREF_JS_OFF => _("Never")),
199 'save' => 'save_option_javascript_autodetect',
0177059f 200 'extra_attributes' => array('onclick' => 'document.forms[0].new_js_autodetect_results.value = \'' . SMPREF_JS_ON . '\';'),
a3ec3c91 201 );
202
bbcafebd 203 $optvals[SMOPT_GRP_GENERAL][] = array(
a3ec3c91 204 'name' => 'js_autodetect_results',
205 'caption' => '',
206 'type' => SMOPT_TYPE_HIDDEN,
ae958cd3 207 'refresh' => SMOPT_REFRESH_NONE
5826affb 208 //'post_script' => $js_autodetect_script,
a3ec3c91 209 );
f2df3fa1 210
5bcd1b00 211 $optvals[SMOPT_GRP_GENERAL][] = array(
212 'name' => 'hour_format',
213 'caption' => _("Hour Format"),
214 'type' => SMOPT_TYPE_STRLIST,
215 'refresh' => SMOPT_REFRESH_FOLDERLIST,
216 'posvals' => array(SMPREF_TIME_12HR => _("12-hour clock"),
217 SMPREF_TIME_24HR => _("24-hour clock"))
218 );
a3ec3c91 219
bbcafebd 220 /*** Load the General Options into the array ***/
221 $optgrps[SMOPT_GRP_MAILBOX] = _("Mailbox Display Options");
222 $optvals[SMOPT_GRP_MAILBOX] = array();
223
224 $optvals[SMOPT_GRP_MAILBOX][] = array(
a3ec3c91 225 'name' => 'show_num',
f2df3fa1 226 'caption' => _("Number of Messages per Page"),
a3ec3c91 227 'type' => SMOPT_TYPE_INTEGER,
bbcafebd 228 'refresh' => SMOPT_REFRESH_NONE,
229 'size' => SMOPT_SIZE_TINY
a3ec3c91 230 );
231
bbcafebd 232 $optvals[SMOPT_GRP_MAILBOX][] = array(
a440e68f 233 'name' => 'alt_index_colors',
234 'caption' => _("Enable Alternating Row Colors"),
235 'type' => SMOPT_TYPE_BOOLEAN,
236 'refresh' => SMOPT_REFRESH_NONE
237 );
238
18adc53f 239 $optvals[SMOPT_GRP_MAILBOX][] = array(
240 'name' => 'fancy_index_highlite',
241 'caption' => _("Enable Fancy Row Mouseover Highlighting"),
242 'type' => SMOPT_TYPE_BOOLEAN,
243 'refresh' => SMOPT_REFRESH_NONE
244 );
245
bbcafebd 246 $optvals[SMOPT_GRP_MAILBOX][] = array(
fd181f53 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(
24bb7e49 254 'name' => 'show_copy_buttons',
255 'caption' => _("Enable Message Copy Buttons"),
256 'type' => SMOPT_TYPE_BOOLEAN,
257 'refresh' => SMOPT_REFRESH_NONE
258 );
259
260 $optvals[SMOPT_GRP_MAILBOX][] = array(
a440e68f 261 'name' => 'page_selector',
262 'caption' => _("Enable Page Selector"),
263 'type' => SMOPT_TYPE_BOOLEAN,
264 'refresh' => SMOPT_REFRESH_NONE
265 );
266
bbcafebd 267 $optvals[SMOPT_GRP_MAILBOX][] = array(
0bb37159 268 'name' => 'compact_paginator',
269 'caption' => _("Use Compact Page Selector"),
270 'type' => SMOPT_TYPE_BOOLEAN,
271 'refresh' => SMOPT_REFRESH_NONE
272 );
273
274 $optvals[SMOPT_GRP_MAILBOX][] = array(
a440e68f 275 'name' => 'page_selector_max',
276 'caption' => _("Maximum Number of Pages to Show"),
277 'type' => SMOPT_TYPE_INTEGER,
bbcafebd 278 'refresh' => SMOPT_REFRESH_NONE,
279 'size' => SMOPT_SIZE_TINY
a440e68f 280 );
281
3e3b60e3 282 $optvals[SMOPT_GRP_MAILBOX][] = array(
283 'name' => 'show_full_date',
284 'caption' => _("Always Show Full Date"),
285 'type' => SMOPT_TYPE_BOOLEAN,
286 'refresh' => SMOPT_REFRESH_NONE
287 );
288
459e3347 289 $optvals[SMOPT_GRP_MAILBOX][] = array(
290 'name' => 'truncate_sender',
291 'caption' => _("Length of From/To Field (0 for full)"),
292 'type' => SMOPT_TYPE_INTEGER,
293 'refresh' => SMOPT_REFRESH_NONE,
294 'size' => SMOPT_SIZE_TINY
295 );
296
3fc1a95f 297 $optvals[SMOPT_GRP_MAILBOX][] = array(
298 'name' => 'truncate_subject',
299 'caption' => _("Length of Subject Field (0 for full)"),
300 'type' => SMOPT_TYPE_INTEGER,
301 'refresh' => SMOPT_REFRESH_NONE,
302 'size' => SMOPT_SIZE_TINY
303 );
91c27aee 304/*
28294310 305FIXME!
91c27aee 306 disabled because the template doesn't support it (yet?)
1ae2832e 307 $optvals[SMOPT_GRP_MAILBOX][] = array(
308 'name' => 'show_recipient_instead',
309 'caption' => _("Show recipient name if the message is from your default identity"),
310 'type' => SMOPT_TYPE_BOOLEAN,
311 'refresh' => SMOPT_REFRESH_NONE,
312 'size' => SMOPT_SIZE_TINY
313 );
91c27aee 314*/
f2df3fa1 315
5ed9d4fd 316 if ($allow_thread_sort == TRUE) {
317 $optvals[SMOPT_GRP_MAILBOX][] = array(
318 'name' => 'sort_by_ref',
319 'caption' => _("Enable Thread Sort by References Header"),
320 'type' => SMOPT_TYPE_BOOLEAN,
321 'refresh' => SMOPT_REFRESH_ALL
322 );
323 }
324
1ae2832e 325
459e3347 326
bbcafebd 327 /*** Load the General Options into the array ***/
5ed9d4fd 328 $optgrps[SMOPT_GRP_MESSAGE] = _("Message Display Options");
bbcafebd 329 $optvals[SMOPT_GRP_MESSAGE] = array();
330
331 $optvals[SMOPT_GRP_MESSAGE][] = array(
a3ec3c91 332 'name' => 'wrap_at',
333 'caption' => _("Wrap Incoming Text At"),
334 'type' => SMOPT_TYPE_INTEGER,
bbcafebd 335 'refresh' => SMOPT_REFRESH_NONE,
336 'size' => SMOPT_SIZE_TINY
a3ec3c91 337 );
338
bbcafebd 339 $optvals[SMOPT_GRP_MESSAGE][] = array(
fd87494d 340 'name' => 'show_html_default',
341 'caption' => _("Show HTML Version by Default"),
342 'type' => SMOPT_TYPE_BOOLEAN,
343 'refresh' => SMOPT_REFRESH_NONE
344 );
345
a144f6b8 346 if ($use_iframe) {
347 // Type is set to string in order to be able to use 100%.
348 $optvals[SMOPT_GRP_MESSAGE][] = array(
349 'name' => 'iframe_height',
350 'caption' => _("Height of inline frame"),
351 'type' => SMOPT_TYPE_STRING,
352 'size' => SMOPT_SIZE_TINY,
353 'refresh' => SMOPT_REFRESH_NONE
354 );
355 }
bbcafebd 356 $optvals[SMOPT_GRP_MESSAGE][] = array(
6206f6c4 357 'name' => 'enable_forward_as_attachment',
358 'caption' => _("Enable Forward as Attachment"),
fd87494d 359 'type' => SMOPT_TYPE_BOOLEAN,
360 'refresh' => SMOPT_REFRESH_NONE
361 );
362
bbcafebd 363 $optvals[SMOPT_GRP_MESSAGE][] = array(
9ab0d96f 364 'name' => 'show_xmailer_default',
a440e68f 365 'caption' => _("Enable Mailer Display"),
9ab0d96f 366 'type' => SMOPT_TYPE_BOOLEAN,
367 'refresh' => SMOPT_REFRESH_NONE
368 );
369
7baf86a9 370 $optvals[SMOPT_GRP_MESSAGE][] = array(
371 'name' => 'attachment_common_show_images',
10f0ce72 372 'caption' => _("Display Attached Images with Message"),
7baf86a9 373 'type' => SMOPT_TYPE_BOOLEAN,
374 'refresh' => SMOPT_REFRESH_NONE
375 );
376
57257333 377 if ($default_use_mdn) {
378 $optvals[SMOPT_GRP_MESSAGE][] = array(
379 'name' => 'mdn_user_support',
6206f6c4 380 'caption' => _("Enable Mail Delivery Notification"),
57257333 381 'type' => SMOPT_TYPE_BOOLEAN,
382 'refresh' => SMOPT_REFRESH_NONE
383 );
384 }
07687736 385
9c3e6cd4 386 $optvals[SMOPT_GRP_MESSAGE][] = array(
4267d5de 387 'name' => 'delete_prev_next_display',
407e7032 388 'caption' => _("Show 'Delete &amp; Prev/Next' Links"),
4267d5de 389 'type' => SMOPT_TYPE_BOOLEAN,
390 'refresh' => SMOPT_REFRESH_ALL
391 );
5d110fa6 392
cbe5423b 393 /* Assemble all this together and return it as our result. */
394 $result = array(
395 'grps' => $optgrps,
ae958cd3 396 'vals' => $optvals
cbe5423b 397 );
398 return ($result);
399}
a3ec3c91 400
cbe5423b 401/******************************************************************/
402/** Define any specialized save functions for this option page. ***/
403/******************************************************************/
f1e6f580 404
48af4b64 405/**
299d1d03 406 * This function saves a new template setting.
407 * It updates the template array.
408 */
409function save_option_template($option) {
410 global $aTemplateSet;
411
e4dd61df 412 /* Do checking to make sure new template is in the available templates array. */
299d1d03 413 $templateset_in_array = false;
414 for ($i = 0; $i < count($aTemplateSet); ++$i) {
28294310 415 if ($aTemplateSet[$i]['ID'] == $option->new_value) {
299d1d03 416 $templateset_in_array = true;
417 break;
418 }
419 }
420
421 if (!$templateset_in_array) {
422 $option->new_value = '';
e4dd61df 423 } else {
424
425 // clear template cache when changing template sets
426 // (in order to do so, we have to change the global
427 // template set ID now... should not be a problem --
428 // in fact, if we don't do it now, very anomalous
429 // problems occur)
430 //
431 global $sTemplateID;
432 $sTemplateID = $option->new_value;
433 Template::cache_template_file_hierarchy(TRUE);
434
299d1d03 435 }
e4dd61df 436
83fc5c5e 437 /**
438 * TODO: If the template changes and we are using a template provided theme
439 * ($user_theme), do we want to reset $user_theme?
440 */
299d1d03 441 /* Save the option like normal. */
442 save_option($option);
443}
444
445/**
48af4b64 446 * This function saves the javascript detection option.
447 */
cbe5423b 448function save_option_javascript_autodetect($option) {
ae958cd3 449 save_option($option);
450 checkForJavascript(TRUE);
cbe5423b 451}
452
5d110fa6 453/**
6395c46d 454 * This function saves the user's icon theme setting
455 */
456function icon_theme_save($option) {
f9376f0b 457 global $icon_themes;
6395c46d 458
459
5d110fa6 460 // Don't assume the new value is there, double check
461 // and only save if found
991c88e7 462 $found = false;
463 while (!$found && (list($index, $data) = each($icon_themes))) {
464 if ($data['PATH'] == $option->new_value)
465 $found = true;
466 }
4e655787 467
468 if (!$found)
469 $option->new_value = 'none';
470
471 save_option($option);
6395c46d 472}
deb25c8f 473
474function css_theme_save ($option) {
f9376f0b 475 global $user_themes, $oTemplate;
deb25c8f 476
477 // Don't assume the new value is there, double check
478 // and only save if found
deb25c8f 479 $found = false;
82351c82 480 reset($user_themes);
481 while (!$found && (list($index, $data) = each($user_themes))) {
83fc5c5e 482 if ($data['PATH'] == $option->new_value)
deb25c8f 483 $found = true;
484 }
f9376f0b 485
83fc5c5e 486 if (!$found) {
487 $template_themes = $oTemplate->get_alternative_stylesheets(true);
488 while (!$found && (list($path, $name) = each($template_themes))) {
489 if ($path == $option->new_value)
490 $found = true;
491 }
f9376f0b 492 }
493
494 if (!$found)
495 $option->new_value = 'none';
496
497 save_option($option);
deb25c8f 498}
499
500