6 * Copyright (c) 1999-2004 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * Displays all optinos about display preferences
12 * @package squirrelmail
15 /** Define the group constants for the display options page. */
16 define('SMOPT_GRP_GENERAL', 0);
17 define('SMOPT_GRP_MAILBOX', 1);
18 define('SMOPT_GRP_MESSAGE', 2);
20 // load icon themes if in use
24 $dirName = SM_PATH
. 'images/themes';
25 if (is_readable($dirName) && is_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");
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
49 function load_optpage_data_display() {
50 global $theme, $language, $languages, $js_autodetect_results, $javascript_setting,
51 $compose_new_win, $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
52 $optmode, $show_alternative_names, $available_languages, $use_icons;
54 /* Build a simple array into which we will build options. */
58 /******************************************************/
59 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
60 /******************************************************/
62 /*** Load the General Options into the array ***/
63 $optgrps[SMOPT_GRP_GENERAL
] = _("General Display Options");
64 $optvals[SMOPT_GRP_GENERAL
] = array();
66 /* Load the theme option. */
67 $theme_values = array();
68 foreach ($theme as $theme_key => $theme_attributes) {
69 $theme_values[$theme_attributes['NAME']] = $theme_attributes['PATH'];
72 $theme_values = array_flip($theme_values);
73 $optvals[SMOPT_GRP_GENERAL
][] = array(
74 'name' => 'chosen_theme',
75 'caption' => _("Theme"),
76 'type' => SMOPT_TYPE_STRLIST
,
77 'refresh' => SMOPT_REFRESH_ALL
,
78 'posvals' => $theme_values,
79 'save' => 'save_option_theme'
82 $css_values = array( 'none' => _("Default" ) );
84 if (is_readable(SM_PATH
. 'themes/css') && is_dir(SM_PATH
. 'themes/css')) {
85 $handle=opendir(SM_PATH
. 'themes/css');
86 while ($file = readdir($handle) ) {
87 if ( substr( $file, -4 ) == '.css' ) {
88 $css_values[$file] = substr( $file, 0, strlen( $file ) - 4 );
94 if ( count( $css_values ) > 1 ) {
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
106 // config.php can be unupdated.
107 if (! isset($available_languages) ||
$available_languages=="" ) {
108 $available_languages="ALL"; }
110 $language_values = array();
111 if ( strtoupper($available_languages)=='ALL') {
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'];
122 } else if (strtoupper($available_languages)!='NONE') {
123 // admin can set list of available languages in config
124 $available_languages_array=explode (" ",$available_languages);
125 foreach ($available_languages_array as $lang_key ) {
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'];
136 asort($language_values);
138 array_merge(array('' => _("Default")), $language_values);
139 $language = $squirrelmail_language;
140 if (strtoupper($available_languages)!='NONE') {
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
151 /* Set values for the "use javascript" option. */
152 $optvals[SMOPT_GRP_GENERAL
][] = array(
153 'name' => 'javascript_setting',
154 'caption' => _("Use Javascript"),
155 'type' => SMOPT_TYPE_STRLIST
,
156 'refresh' => SMOPT_REFRESH_ALL
,
157 'posvals' => array(SMPREF_JS_AUTODETECT
=> _("Autodetect"),
158 SMPREF_JS_ON
=> _("Always"),
159 SMPREF_JS_OFF
=> _("Never")),
160 'save' => 'save_option_javascript_autodetect',
161 'script' => 'onclick="document.forms[0].new_js_autodetect_results.value = \'' . SMPREF_JS_ON
. '\';"'
164 $optvals[SMOPT_GRP_GENERAL
][] = array(
165 'name' => 'js_autodetect_results',
167 'type' => SMOPT_TYPE_HIDDEN
,
168 'refresh' => SMOPT_REFRESH_NONE
169 //'post_script' => $js_autodetect_script,
172 /*** Load the General Options into the array ***/
173 $optgrps[SMOPT_GRP_MAILBOX
] = _("Mailbox Display Options");
174 $optvals[SMOPT_GRP_MAILBOX
] = array();
176 $optvals[SMOPT_GRP_MAILBOX
][] = array(
177 'name' => 'show_num',
178 'caption' => _("Number of Messages to Index"),
179 'type' => SMOPT_TYPE_INTEGER
,
180 'refresh' => SMOPT_REFRESH_NONE
,
181 'size' => SMOPT_SIZE_TINY
184 $optvals[SMOPT_GRP_MAILBOX
][] = array(
185 'name' => 'alt_index_colors',
186 'caption' => _("Enable Alternating Row Colors"),
187 'type' => SMOPT_TYPE_BOOLEAN
,
188 'refresh' => SMOPT_REFRESH_NONE
192 global $icon_themes, $icon_theme;
194 for ($count = 0; $count < sizeof($icon_themes); $count++
) {
195 $temp[$count] = $icon_themes[$count]['NAME'];
196 if ($icon_theme == $icon_themes[$count]['PATH'])
199 if (sizeof($icon_themes) > 0) {
200 $optvals[SMOPT_GRP_MAILBOX
][] = array(
201 'name' => 'icon_theme',
202 'caption' => _("Message Flags Icon Theme"),
203 'type' => SMOPT_TYPE_STRLIST
,
204 'refresh' => SMOPT_REFRESH_NONE
,
206 'initial_value' => $value,
207 'save' => 'icon_theme_save'
212 $optvals[SMOPT_GRP_MAILBOX
][] = array(
213 'name' => 'show_flag_buttons',
214 'caption' => _("Show Flag / Unflag Buttons"),
215 'type' => SMOPT_TYPE_BOOLEAN
,
216 'refresh' => SMOPT_REFRESH_NONE
219 $optvals[SMOPT_GRP_MAILBOX
][] = array(
220 'name' => 'page_selector',
221 'caption' => _("Enable Page Selector"),
222 'type' => SMOPT_TYPE_BOOLEAN
,
223 'refresh' => SMOPT_REFRESH_NONE
226 $optvals[SMOPT_GRP_MAILBOX
][] = array(
227 'name' => 'page_selector_max',
228 'caption' => _("Maximum Number of Pages to Show"),
229 'type' => SMOPT_TYPE_INTEGER
,
230 'refresh' => SMOPT_REFRESH_NONE
,
231 'size' => SMOPT_SIZE_TINY
234 $optvals[SMOPT_GRP_MAILBOX
][] = array(
235 'name' => 'show_full_date',
236 'caption' => _("Always Show Full Date"),
237 'type' => SMOPT_TYPE_BOOLEAN
,
238 'refresh' => SMOPT_REFRESH_NONE
241 $optvals[SMOPT_GRP_MAILBOX
][] = array(
242 'name' => 'truncate_sender',
243 'caption' => _("Length of From/To Field (0 for full)"),
244 'type' => SMOPT_TYPE_INTEGER
,
245 'refresh' => SMOPT_REFRESH_NONE
,
246 'size' => SMOPT_SIZE_TINY
249 $optvals[SMOPT_GRP_MAILBOX
][] = array(
250 'name' => 'truncate_subject',
251 'caption' => _("Length of Subject Field (0 for full)"),
252 'type' => SMOPT_TYPE_INTEGER
,
253 'refresh' => SMOPT_REFRESH_NONE
,
254 'size' => SMOPT_SIZE_TINY
257 $optvals[SMOPT_GRP_MAILBOX
][] = array(
258 'name' => 'show_recipient_instead',
259 'caption' => _("Show recipient name if the message is from your default identity"),
260 'type' => SMOPT_TYPE_BOOLEAN
,
261 'refresh' => SMOPT_REFRESH_NONE
,
262 'size' => SMOPT_SIZE_TINY
266 /*** Load the General Options into the array ***/
267 $optgrps[SMOPT_GRP_MESSAGE
] = _("Message Display and Composition");
268 $optvals[SMOPT_GRP_MESSAGE
] = array();
270 $optvals[SMOPT_GRP_MESSAGE
][] = array(
272 'caption' => _("Wrap Incoming Text At"),
273 'type' => SMOPT_TYPE_INTEGER
,
274 'refresh' => SMOPT_REFRESH_NONE
,
275 'size' => SMOPT_SIZE_TINY
278 $optvals[SMOPT_GRP_MESSAGE
][] = array(
279 'name' => 'editor_size',
280 'caption' => _("Width of Editor Window"),
281 'type' => SMOPT_TYPE_INTEGER
,
282 'refresh' => SMOPT_REFRESH_NONE
,
283 'size' => SMOPT_SIZE_TINY
286 $optvals[SMOPT_GRP_MESSAGE
][] = array(
287 'name' => 'editor_height',
288 'caption' => _("Height of Editor Window"),
289 'type' => SMOPT_TYPE_INTEGER
,
290 'refresh' => SMOPT_REFRESH_NONE
,
291 'size' => SMOPT_SIZE_TINY
294 $optvals[SMOPT_GRP_MESSAGE
][] = array(
295 'name' => 'location_of_buttons',
296 'caption' => _("Location of Buttons when Composing"),
297 'type' => SMOPT_TYPE_STRLIST
,
298 'refresh' => SMOPT_REFRESH_NONE
,
299 'posvals' => array(SMPREF_LOC_TOP
=> _("Before headers"),
300 SMPREF_LOC_BETWEEN
=> _("Between headers and message body"),
301 SMPREF_LOC_BOTTOM
=> _("After message body"))
305 $optvals[SMOPT_GRP_MESSAGE
][] = array(
306 'name' => 'use_javascript_addr_book',
307 'caption' => _("Addressbook Display Format"),
308 'type' => SMOPT_TYPE_STRLIST
,
309 'refresh' => SMOPT_REFRESH_NONE
,
310 'posvals' => array('1' => _("Javascript"),
314 $optvals[SMOPT_GRP_MESSAGE
][] = array(
315 'name' => 'show_html_default',
316 'caption' => _("Show HTML Version by Default"),
317 'type' => SMOPT_TYPE_BOOLEAN
,
318 'refresh' => SMOPT_REFRESH_NONE
321 $optvals[SMOPT_GRP_MESSAGE
][] = array(
322 'name' => 'enable_forward_as_attachment',
323 'caption' => _("Enable Forward as Attachment"),
324 'type' => SMOPT_TYPE_BOOLEAN
,
325 'refresh' => SMOPT_REFRESH_NONE
328 $optvals[SMOPT_GRP_MESSAGE
][] = array(
329 'name' => 'forward_cc',
330 'caption' => _("Include CCs when Forwarding Messages"),
331 'type' => SMOPT_TYPE_BOOLEAN
,
332 'refresh' => SMOPT_REFRESH_NONE
335 $optvals[SMOPT_GRP_MESSAGE
][] = array(
336 'name' => 'include_self_reply_all',
337 'caption' => _("Include Me in CC when I Reply All"),
338 'type' => SMOPT_TYPE_BOOLEAN
,
339 'refresh' => SMOPT_REFRESH_NONE
342 $optvals[SMOPT_GRP_MESSAGE
][] = array(
343 'name' => 'show_xmailer_default',
344 'caption' => _("Enable Mailer Display"),
345 'type' => SMOPT_TYPE_BOOLEAN
,
346 'refresh' => SMOPT_REFRESH_NONE
349 $optvals[SMOPT_GRP_MESSAGE
][] = array(
350 'name' => 'attachment_common_show_images',
351 'caption' => _("Display Attached Images with Message"),
352 'type' => SMOPT_TYPE_BOOLEAN
,
353 'refresh' => SMOPT_REFRESH_NONE
356 $optvals[SMOPT_GRP_MESSAGE
][] = array(
357 'name' => 'pf_cleandisplay',
358 'caption' => _("Enable Printer Friendly Clean Display"),
359 'type' => SMOPT_TYPE_BOOLEAN
,
360 'refresh' => SMOPT_REFRESH_NONE
363 if ($default_use_mdn) {
364 $optvals[SMOPT_GRP_MESSAGE
][] = array(
365 'name' => 'mdn_user_support',
366 'caption' => _("Enable Mail Delivery Notification"),
367 'type' => SMOPT_TYPE_BOOLEAN
,
368 'refresh' => SMOPT_REFRESH_NONE
372 $optvals[SMOPT_GRP_MESSAGE
][] = array(
373 'name' => 'compose_new_win',
374 'caption' => _("Compose Messages in New Window"),
375 'type' => SMOPT_TYPE_BOOLEAN
,
376 'refresh' => SMOPT_REFRESH_ALL
379 $optvals[SMOPT_GRP_MESSAGE
][] = array(
380 'name' => 'compose_width',
381 'caption' => _("Width of Compose Window"),
382 'type' => SMOPT_TYPE_INTEGER
,
383 'refresh' => SMOPT_REFRESH_ALL
,
384 'size' => SMOPT_SIZE_TINY
387 $optvals[SMOPT_GRP_MESSAGE
][] = array(
388 'name' => 'compose_height',
389 'caption' => _("Height of Compose Window"),
390 'type' => SMOPT_TYPE_INTEGER
,
391 'refresh' => SMOPT_REFRESH_ALL
,
392 'size' => SMOPT_SIZE_TINY
395 $optvals[SMOPT_GRP_MESSAGE
][] = array(
396 'name' => 'sig_first',
397 'caption' => _("Append Signature before Reply/Forward Text"),
398 'type' => SMOPT_TYPE_BOOLEAN
,
399 'refresh' => SMOPT_REFRESH_NONE
402 $optvals[SMOPT_GRP_MESSAGE
][] = array(
403 'name' => 'body_quote',
404 'caption' => _("Prefix for Original Message when Replying"),
405 'type' => SMOPT_TYPE_STRING
,
406 'refresh' => SMOPT_REFRESH_NONE
,
407 'size' => SMOPT_SIZE_TINY
,
408 'save' => 'save_option_reply_prefix'
411 $optvals[SMOPT_GRP_MESSAGE
][] = array(
412 'name' => 'reply_focus',
413 'caption' => _("Cursor Position when Replying"),
414 'type' => SMOPT_TYPE_STRLIST
,
415 'refresh' => SMOPT_REFRESH_NONE
,
416 'posvals' => array('' => _("To: field"),
417 'focus' => _("Focus in body"),
418 'select' => _("Select body"),
419 'none' => _("No focus"))
422 $optvals[SMOPT_GRP_MESSAGE
][] = array(
423 'name' => 'strip_sigs',
424 'caption' => _("Strip signature when replying"),
425 'type' => SMOPT_TYPE_BOOLEAN
,
426 'refresh' => SMOPT_REFRESH_NONE
429 $optvals[SMOPT_GRP_MESSAGE
][] = array(
430 'name' => 'internal_date_sort',
431 'caption' => _("Enable Sort by of Receive Date"),
432 'type' => SMOPT_TYPE_BOOLEAN
,
433 'refresh' => SMOPT_REFRESH_ALL
435 if ($allow_thread_sort == TRUE) {
436 $optvals[SMOPT_GRP_MESSAGE
][] = array(
437 'name' => 'sort_by_ref',
438 'caption' => _("Enable Thread Sort by References Header"),
439 'type' => SMOPT_TYPE_BOOLEAN
,
440 'refresh' => SMOPT_REFRESH_ALL
442 $optvals[SMOPT_GRP_MESSAGE
][] = array(
443 'name' => 'delete_prev_next_display',
444 'caption' => _("Show 'Delete & Prev/Next' Links"),
445 'type' => SMOPT_TYPE_BOOLEAN
,
446 'refresh' => SMOPT_REFRESH_ALL
450 /* Assemble all this together and return it as our result. */
458 /******************************************************************/
459 /** Define any specialized save functions for this option page. ***/
460 /******************************************************************/
462 function save_option_header($option) {
466 * This function saves a new theme setting.
467 * It updates the theme array.
469 function save_option_theme($option) {
471 /* Do checking to make sure $new_theme is in the array. */
472 $theme_in_array = false;
473 for ($i = 0; $i < count($theme); ++
$i) {
474 if ($theme[$i]['PATH'] == $option->new_value
) {
475 $theme_in_array = true;
480 if (!$theme_in_array) {
481 $option->new_value
= '';
484 /* Save the option like normal. */
485 save_option($option);
489 * This function saves the javascript detection option.
491 function save_option_javascript_autodetect($option) {
492 global $data_dir, $username;
494 save_option($option);
495 checkForJavascript(TRUE);
499 * This function saves the user's icon theme setting
501 function icon_theme_save($option) {
503 global $icon_themes, $data_dir, $username;
506 // Don't assume the new value is there, double check
507 // and only save if found
509 if (isset($icon_themes[$option->new_value
]['PATH']))
510 setPref($data_dir, $username, 'icon_theme', $icon_themes[$option->new_value
]['PATH']);
512 setPref($data_dir, $username, 'icon_theme', 'none');
517 * This function saves the reply prefix (body_quote) character(s)
519 function save_option_reply_prefix($option) {
520 global $data_dir, $username, $new_javascript_setting;
522 // save as "NONE" if it was blanked out
524 if (empty($option->new_value
)) $option->new_value
= 'NONE';
527 // Save the option like normal.
529 save_option($option);