need to encode & in strings
[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 *
47ccfad4 8 * @copyright &copy; 1999-2006 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
6395c46d 19// load icon themes if in use
20global $use_icons;
21if ($use_icons) {
22 global $icon_themes;
23 $dirName = SM_PATH . 'images/themes';
4f7a5870 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 }
6395c46d 31 }
32 }
33}
34
a144f6b8 35global $use_iframe;
36if (! isset($use_iframe)) $use_iframe=false;
37
48af4b64 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 */
cbe5423b 51function load_optpage_data_display() {
299d1d03 52 global $theme, $fontsets, $language, $languages,$aTemplateSet,
ce68b76b 53 $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
299d1d03 54 $show_alternative_names, $use_icons, $use_iframe, $sTplDir;
a3ec3c91 55
ce393174 56 /* Build a simple array into which we will build options. */
bbcafebd 57 $optgrps = array();
58 $optvals = array();
a3ec3c91 59
bbcafebd 60 /******************************************************/
61 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
62 /******************************************************/
bbcafebd 63
64 /*** Load the General Options into the array ***/
65 $optgrps[SMOPT_GRP_GENERAL] = _("General Display Options");
66 $optvals[SMOPT_GRP_GENERAL] = array();
67
299d1d03 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);
9edbc08b 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 }
299d1d03 87
bbcafebd 88 /* Load the theme option. */
ce393174 89 $theme_values = array();
90 foreach ($theme as $theme_key => $theme_attributes) {
be278741 91 $theme_values[$theme_attributes['NAME']] = $theme_attributes['PATH'];
ce393174 92 }
be278741 93 ksort($theme_values);
94 $theme_values = array_flip($theme_values);
bbcafebd 95 $optvals[SMOPT_GRP_GENERAL][] = array(
ce393174 96 'name' => 'chosen_theme',
97 'caption' => _("Theme"),
98 'type' => SMOPT_TYPE_STRLIST,
99 'refresh' => SMOPT_REFRESH_ALL,
cbe5423b 100 'posvals' => $theme_values,
101 'save' => 'save_option_theme'
ce393174 102 );
5d110fa6 103
8f1ba72b 104 $css_values = array( 'none' => _("Default" ) );
bb7173fa 105 $css_dir = SM_PATH . 'themes/css';
106 if (is_readable($css_dir) && is_dir($css_dir)) {
107 $handle=opendir($css_dir);
4f7a5870 108 while ($file = readdir($handle) ) {
109 if ( substr( $file, -4 ) == '.css' ) {
110 $css_values[$file] = substr( $file, 0, strlen( $file ) - 4 );
111 }
8f1ba72b 112 }
4f7a5870 113 closedir($handle);
dcd6f144 114 }
5d110fa6 115
81132de8 116 /*
54078578 117 if ( count( $css_values ) > 1 ) {
5d110fa6 118
e2cdae1f 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 );
5d110fa6 126
e2cdae1f 127 }
81132de8 128 */
129
130 $fontset_values = array();
bed0ac1d 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);
81132de8 139 }
81132de8 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 );
39d3ec89 163
e557fdb0 164 $language_values = array();
5ba5dc8e 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'];
0bb37159 172 }
173 }
ce393174 174 }
5ba5dc8e 175
e557fdb0 176 asort($language_values);
8405d0a4 177 $language_values =
178 array_merge(array('' => _("Default")), $language_values);
ec2c91a1 179 $language = $squirrelmail_language;
5ba5dc8e 180
299d1d03 181 // add language selection only when more than 2 languages are available
48d5ec1f 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 }
ce393174 193
a3ec3c91 194 /* Set values for the "use javascript" option. */
bbcafebd 195 $optvals[SMOPT_GRP_GENERAL][] = array(
a3ec3c91 196 'name' => 'javascript_setting',
ce393174 197 'caption' => _("Use Javascript"),
a3ec3c91 198 'type' => SMOPT_TYPE_STRLIST,
199 'refresh' => SMOPT_REFRESH_ALL,
200 'posvals' => array(SMPREF_JS_AUTODETECT => _("Autodetect"),
201 SMPREF_JS_ON => _("Always"),
ae958cd3 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 . '\';"'
a3ec3c91 205 );
206
bbcafebd 207 $optvals[SMOPT_GRP_GENERAL][] = array(
a3ec3c91 208 'name' => 'js_autodetect_results',
209 'caption' => '',
210 'type' => SMOPT_TYPE_HIDDEN,
ae958cd3 211 'refresh' => SMOPT_REFRESH_NONE
5826affb 212 //'post_script' => $js_autodetect_script,
a3ec3c91 213 );
f2df3fa1 214
5bcd1b00 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 );
a3ec3c91 223
29997535 224 /* Icon theme selection */
225 if ($use_icons) {
226 global $icon_themes, $icon_theme;
a2b1987f 227
29997535 228 $temp = array();
229 for ($count = 0; $count < sizeof($icon_themes); $count++) {
230 $temp[$count] = $icon_themes[$count]['NAME'];
a2b1987f 231 if ($icon_theme == $icon_themes[$count]['PATH'] ||
232 (($icon_theme == $sTplDir.'images/') && ($icon_themes[$count]['PATH']=='template'))
233 ) {
29997535 234 $value = $count;
a2b1987f 235 }
29997535 236 }
237 if (sizeof($icon_themes) > 0) {
238 $optvals[SMOPT_GRP_GENERAL][] = array(
239 'name' => 'icon_theme',
240 'caption' => _("Icon Theme"),
241 'type' => SMOPT_TYPE_STRLIST,
242 'refresh' => SMOPT_REFRESH_NONE,
243 'posvals' => $temp,
244 'initial_value' => $value,
245 'save' => 'icon_theme_save'
246 );
247 }
248 }
249
bbcafebd 250 /*** Load the General Options into the array ***/
251 $optgrps[SMOPT_GRP_MAILBOX] = _("Mailbox Display Options");
252 $optvals[SMOPT_GRP_MAILBOX] = array();
253
254 $optvals[SMOPT_GRP_MAILBOX][] = array(
a3ec3c91 255 'name' => 'show_num',
f2df3fa1 256 'caption' => _("Number of Messages per Page"),
a3ec3c91 257 'type' => SMOPT_TYPE_INTEGER,
bbcafebd 258 'refresh' => SMOPT_REFRESH_NONE,
259 'size' => SMOPT_SIZE_TINY
a3ec3c91 260 );
261
bbcafebd 262 $optvals[SMOPT_GRP_MAILBOX][] = array(
a440e68f 263 'name' => 'alt_index_colors',
264 'caption' => _("Enable Alternating Row Colors"),
265 'type' => SMOPT_TYPE_BOOLEAN,
266 'refresh' => SMOPT_REFRESH_NONE
267 );
268
18adc53f 269 $optvals[SMOPT_GRP_MAILBOX][] = array(
270 'name' => 'fancy_index_highlite',
271 'caption' => _("Enable Fancy Row Mouseover Highlighting"),
272 'type' => SMOPT_TYPE_BOOLEAN,
273 'refresh' => SMOPT_REFRESH_NONE
274 );
275
bbcafebd 276 $optvals[SMOPT_GRP_MAILBOX][] = array(
fd181f53 277 'name' => 'show_flag_buttons',
278 'caption' => _("Show Flag / Unflag Buttons"),
279 'type' => SMOPT_TYPE_BOOLEAN,
280 'refresh' => SMOPT_REFRESH_NONE
281 );
282
283 $optvals[SMOPT_GRP_MAILBOX][] = array(
a440e68f 284 'name' => 'page_selector',
285 'caption' => _("Enable Page Selector"),
286 'type' => SMOPT_TYPE_BOOLEAN,
287 'refresh' => SMOPT_REFRESH_NONE
288 );
289
bbcafebd 290 $optvals[SMOPT_GRP_MAILBOX][] = array(
0bb37159 291 'name' => 'compact_paginator',
292 'caption' => _("Use Compact Page Selector"),
293 'type' => SMOPT_TYPE_BOOLEAN,
294 'refresh' => SMOPT_REFRESH_NONE
295 );
296
297 $optvals[SMOPT_GRP_MAILBOX][] = array(
a440e68f 298 'name' => 'page_selector_max',
299 'caption' => _("Maximum Number of Pages to Show"),
300 'type' => SMOPT_TYPE_INTEGER,
bbcafebd 301 'refresh' => SMOPT_REFRESH_NONE,
302 'size' => SMOPT_SIZE_TINY
a440e68f 303 );
304
3e3b60e3 305 $optvals[SMOPT_GRP_MAILBOX][] = array(
306 'name' => 'show_full_date',
307 'caption' => _("Always Show Full Date"),
308 'type' => SMOPT_TYPE_BOOLEAN,
309 'refresh' => SMOPT_REFRESH_NONE
310 );
311
459e3347 312 $optvals[SMOPT_GRP_MAILBOX][] = array(
313 'name' => 'truncate_sender',
314 'caption' => _("Length of From/To Field (0 for full)"),
315 'type' => SMOPT_TYPE_INTEGER,
316 'refresh' => SMOPT_REFRESH_NONE,
317 'size' => SMOPT_SIZE_TINY
318 );
319
3fc1a95f 320 $optvals[SMOPT_GRP_MAILBOX][] = array(
321 'name' => 'truncate_subject',
322 'caption' => _("Length of Subject Field (0 for full)"),
323 'type' => SMOPT_TYPE_INTEGER,
324 'refresh' => SMOPT_REFRESH_NONE,
325 'size' => SMOPT_SIZE_TINY
326 );
91c27aee 327/*
328 disabled because the template doesn't support it (yet?)
1ae2832e 329 $optvals[SMOPT_GRP_MAILBOX][] = array(
330 'name' => 'show_recipient_instead',
331 'caption' => _("Show recipient name if the message is from your default identity"),
332 'type' => SMOPT_TYPE_BOOLEAN,
333 'refresh' => SMOPT_REFRESH_NONE,
334 'size' => SMOPT_SIZE_TINY
335 );
91c27aee 336*/
f2df3fa1 337
5ed9d4fd 338 if ($allow_thread_sort == TRUE) {
339 $optvals[SMOPT_GRP_MAILBOX][] = array(
340 'name' => 'sort_by_ref',
341 'caption' => _("Enable Thread Sort by References Header"),
342 'type' => SMOPT_TYPE_BOOLEAN,
343 'refresh' => SMOPT_REFRESH_ALL
344 );
345 }
346
1ae2832e 347
459e3347 348
bbcafebd 349 /*** Load the General Options into the array ***/
5ed9d4fd 350 $optgrps[SMOPT_GRP_MESSAGE] = _("Message Display Options");
bbcafebd 351 $optvals[SMOPT_GRP_MESSAGE] = array();
352
353 $optvals[SMOPT_GRP_MESSAGE][] = array(
a3ec3c91 354 'name' => 'wrap_at',
355 'caption' => _("Wrap Incoming Text At"),
356 'type' => SMOPT_TYPE_INTEGER,
bbcafebd 357 'refresh' => SMOPT_REFRESH_NONE,
358 'size' => SMOPT_SIZE_TINY
a3ec3c91 359 );
360
bbcafebd 361 $optvals[SMOPT_GRP_MESSAGE][] = array(
fd87494d 362 'name' => 'show_html_default',
363 'caption' => _("Show HTML Version by Default"),
364 'type' => SMOPT_TYPE_BOOLEAN,
365 'refresh' => SMOPT_REFRESH_NONE
366 );
367
a144f6b8 368 if ($use_iframe) {
369 // Type is set to string in order to be able to use 100%.
370 $optvals[SMOPT_GRP_MESSAGE][] = array(
371 'name' => 'iframe_height',
372 'caption' => _("Height of inline frame"),
373 'type' => SMOPT_TYPE_STRING,
374 'size' => SMOPT_SIZE_TINY,
375 'refresh' => SMOPT_REFRESH_NONE
376 );
377 }
bbcafebd 378 $optvals[SMOPT_GRP_MESSAGE][] = array(
6206f6c4 379 'name' => 'enable_forward_as_attachment',
380 'caption' => _("Enable Forward as Attachment"),
fd87494d 381 'type' => SMOPT_TYPE_BOOLEAN,
382 'refresh' => SMOPT_REFRESH_NONE
383 );
384
bbcafebd 385 $optvals[SMOPT_GRP_MESSAGE][] = array(
9ab0d96f 386 'name' => 'show_xmailer_default',
a440e68f 387 'caption' => _("Enable Mailer Display"),
9ab0d96f 388 'type' => SMOPT_TYPE_BOOLEAN,
389 'refresh' => SMOPT_REFRESH_NONE
390 );
391
7baf86a9 392 $optvals[SMOPT_GRP_MESSAGE][] = array(
393 'name' => 'attachment_common_show_images',
10f0ce72 394 'caption' => _("Display Attached Images with Message"),
7baf86a9 395 'type' => SMOPT_TYPE_BOOLEAN,
396 'refresh' => SMOPT_REFRESH_NONE
397 );
398
57257333 399 if ($default_use_mdn) {
400 $optvals[SMOPT_GRP_MESSAGE][] = array(
401 'name' => 'mdn_user_support',
6206f6c4 402 'caption' => _("Enable Mail Delivery Notification"),
57257333 403 'type' => SMOPT_TYPE_BOOLEAN,
404 'refresh' => SMOPT_REFRESH_NONE
405 );
406 }
07687736 407
9c3e6cd4 408 $optvals[SMOPT_GRP_MESSAGE][] = array(
4267d5de 409 'name' => 'delete_prev_next_display',
407e7032 410 'caption' => _("Show 'Delete &amp; Prev/Next' Links"),
4267d5de 411 'type' => SMOPT_TYPE_BOOLEAN,
412 'refresh' => SMOPT_REFRESH_ALL
413 );
5d110fa6 414
cbe5423b 415 /* Assemble all this together and return it as our result. */
416 $result = array(
417 'grps' => $optgrps,
ae958cd3 418 'vals' => $optvals
cbe5423b 419 );
420 return ($result);
421}
a3ec3c91 422
cbe5423b 423/******************************************************************/
424/** Define any specialized save functions for this option page. ***/
425/******************************************************************/
f1e6f580 426
48af4b64 427/**
299d1d03 428 * This function saves a new template setting.
429 * It updates the template array.
430 */
431function save_option_template($option) {
432 global $aTemplateSet;
433
434 /* Do checking to make sure $new_theme is in the array. */
435 $templateset_in_array = false;
436 for ($i = 0; $i < count($aTemplateSet); ++$i) {
437 if ($aTemplateSet[$i]['PATH'] == $option->new_value) {
438 $templateset_in_array = true;
439 break;
440 }
441 }
442
443 if (!$templateset_in_array) {
444 $option->new_value = '';
445 }
446 /* Save the option like normal. */
447 save_option($option);
448}
449
450/**
48af4b64 451 * This function saves a new theme setting.
452 * It updates the theme array.
453 */
cbe5423b 454function save_option_theme($option) {
455 global $theme;
bb7173fa 456
cbe5423b 457 /* Do checking to make sure $new_theme is in the array. */
458 $theme_in_array = false;
459 for ($i = 0; $i < count($theme); ++$i) {
460 if ($theme[$i]['PATH'] == $option->new_value) {
461 $theme_in_array = true;
462 break;
463 }
464 }
465
466 if (!$theme_in_array) {
467 $option->new_value = '';
468 }
e7db48af 469
cbe5423b 470 /* Save the option like normal. */
471 save_option($option);
472}
e7db48af 473
48af4b64 474/**
475 * This function saves the javascript detection option.
476 */
cbe5423b 477function save_option_javascript_autodetect($option) {
ae958cd3 478 save_option($option);
479 checkForJavascript(TRUE);
cbe5423b 480}
481
5d110fa6 482/**
6395c46d 483 * This function saves the user's icon theme setting
484 */
485function icon_theme_save($option) {
486
487 global $icon_themes, $data_dir, $username;
488
489
5d110fa6 490 // Don't assume the new value is there, double check
491 // and only save if found
6395c46d 492 //
493 if (isset($icon_themes[$option->new_value]['PATH']))
494 setPref($data_dir, $username, 'icon_theme', $icon_themes[$option->new_value]['PATH']);
495 else
496 setPref($data_dir, $username, 'icon_theme', 'none');
497
498}
499
bed0ac1d 500?>