6 * Displays all optinos about display preferences
8 * @copyright © 1999-2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @package squirrelmail
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);
20 if (! isset($use_iframe)) $use_iframe=false;
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
35 function load_optpage_data_display() {
36 global $theme, $fontsets, $language, $languages,$aTemplateSet,
37 $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
38 $show_alternative_names, $use_iframe, $use_icons,
39 $sTemplateID, $oTemplate,
40 $user_themes, $chosen_theme;
42 /* Build a simple array into which we will build options. */
46 /******************************************************/
47 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
48 /******************************************************/
50 /*** Load the General Options into the array ***/
51 $optgrps[SMOPT_GRP_GENERAL
] = _("General Display Options");
52 $optvals[SMOPT_GRP_GENERAL
] = array();
54 /* load the template set option */
55 $templateset_values = array();
57 foreach ($aTemplateSet as $sKey => $aTemplateSetAttributes) {
58 $templateset_values[$aTemplateSetAttributes['NAME']] = $aTemplateSetAttributes['ID'];
60 ksort($templateset_values);
61 $templateset_values = array_flip($templateset_values);
62 // display template options only when there is more than one template
63 if (count($templateset_values)>1) {
64 $optvals[SMOPT_GRP_GENERAL
][] = array(
65 'name' => 'sTemplateID',
66 'caption' => _("Skin"),
67 'type' => SMOPT_TYPE_STRLIST
,
68 'refresh' => SMOPT_REFRESH_ALL
,
69 'posvals' => $templateset_values,
70 'save' => 'save_option_template'
74 /* Load the theme option. */
77 * User themes start with a 'u_', template themes start with a 't_' to
78 * differentiate which is which. This seems kind of hackish, but we can
79 * come up with a better solution later.
80 PL: No need for the prefixes. Just use full paths, no?
82 SB: Don't think so. If the user chooses a template theme than changes the
83 path to the template, it would error out, right? Or should we worry about
88 $theme_values = array();
90 // Always provide the template default first.
91 $theme_values['none'] = 'Template Default Theme';
93 // List alternate themes provided by templates first
94 $template_themes = array();
96 * Since this requires mods to the template class, I'm holding off on alternate
97 * template styles until Paul finishes template inheritence.
100 $template_themes = $oTemplate->get_alternative_stylesheets();
101 asort($template_provided);
102 foreach ($template_provided as $sheet=>$name) {
103 $theme_values['t_'.$sheet] = 'Template Theme - '.htmlspecialchars($name);
106 // Next, list styles provided in SM_PATH/css/
108 foreach ($user_themes as $style) {
109 if ($style['PATH'] == 'none')
111 $theme_values['u_'.$style['PATH']] = 'User Theme - '.htmlspecialchars($style['NAME']);
114 if (count($user_themes) +
count($template_themes) > 1) {
115 $optvals[SMOPT_GRP_GENERAL
][] = array(
116 'name' => 'chosen_theme',
117 'caption' => _("Theme"),
118 'type' => SMOPT_TYPE_STRLIST
,
119 'refresh' => SMOPT_REFRESH_ALL
,
120 'posvals' => $theme_values,
121 'save' => 'css_theme_save'
125 /* Icon theme selection */
127 global $icon_themes, $icon_theme;
131 for ($count = 0; $count < sizeof($icon_themes); $count++
) {
132 $temp[$icon_themes[$count]['PATH']] = $icon_themes[$count]['NAME'];
134 if (sizeof($icon_themes) > 0) {
135 $optvals[SMOPT_GRP_GENERAL
][] = array(
136 'name' => 'icon_theme',
137 'caption' => _("Icon Theme"),
138 'type' => SMOPT_TYPE_STRLIST
,
139 'refresh' => SMOPT_REFRESH_NONE
,
141 'save' => 'icon_theme_save'
146 $fontset_values = array();
147 $fontset_list = array();
149 if (!empty($fontsets) && is_array($fontsets)) {
151 foreach (array_keys($fontsets) as $fontset_key) {
152 $fontset_list[$fontset_key]=$fontset_key;
154 ksort($fontset_list);
157 if (count($fontset_list) > 1) {
158 $fontset_list = array_merge(array('' => _("Default font style")), $fontset_list);
159 $optvals[SMOPT_GRP_GENERAL
][] = array(
160 'name' => 'chosen_fontset',
161 'caption' => _("Font style"),
162 'type' => SMOPT_TYPE_STRLIST
,
163 'refresh' => SMOPT_REFRESH_ALL
,
164 'posvals' => $fontset_list
168 $optvals[SMOPT_GRP_GENERAL
][] = array(
169 'name' => 'chosen_fontsize',
170 'caption' => _("Font size"),
171 'type' => SMOPT_TYPE_STRLIST
,
172 'refresh' => SMOPT_REFRESH_ALL
,
173 'posvals' => array('' => _("Default font size"),
180 $language_values = array();
181 foreach ($languages as $lang_key => $lang_attributes) {
182 if (isset($lang_attributes['NAME'])) {
183 $language_values[$lang_key] = $lang_attributes['NAME'];
184 if ( isset($show_alternative_names) &&
185 $show_alternative_names &&
186 isset($lang_attributes['ALTNAME']) ) {
187 $language_values[$lang_key] .= " / " . $lang_attributes['ALTNAME'];
192 asort($language_values);
194 array_merge(array('' => _("Default")), $language_values);
195 $language = $squirrelmail_language;
197 // add language selection only when more than 2 languages are available
198 // (default, English and some other)
199 if (count($language_values)>2) {
200 $optvals[SMOPT_GRP_GENERAL
][] = array(
201 'name' => 'language',
202 'caption' => _("Language"),
203 'type' => SMOPT_TYPE_STRLIST
,
204 'refresh' => SMOPT_REFRESH_ALL
,
205 'posvals' => $language_values,
206 'htmlencoded' => true
210 /* Set values for the "use javascript" option. */
211 $optvals[SMOPT_GRP_GENERAL
][] = array(
212 'name' => 'javascript_setting',
213 'caption' => _("Use Javascript"),
214 'type' => SMOPT_TYPE_STRLIST
,
215 'refresh' => SMOPT_REFRESH_ALL
,
216 'posvals' => array(SMPREF_JS_AUTODETECT
=> _("Autodetect"),
217 SMPREF_JS_ON
=> _("Always"),
218 SMPREF_JS_OFF
=> _("Never")),
219 'save' => 'save_option_javascript_autodetect',
220 'script' => 'onclick="document.forms[0].new_js_autodetect_results.value = \'' . SMPREF_JS_ON
. '\';"'
223 $optvals[SMOPT_GRP_GENERAL
][] = array(
224 'name' => 'js_autodetect_results',
226 'type' => SMOPT_TYPE_HIDDEN
,
227 'refresh' => SMOPT_REFRESH_NONE
228 //'post_script' => $js_autodetect_script,
231 $optvals[SMOPT_GRP_GENERAL
][] = array(
232 'name' => 'hour_format',
233 'caption' => _("Hour Format"),
234 'type' => SMOPT_TYPE_STRLIST
,
235 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
236 'posvals' => array(SMPREF_TIME_12HR
=> _("12-hour clock"),
237 SMPREF_TIME_24HR
=> _("24-hour clock"))
240 /*** Load the General Options into the array ***/
241 $optgrps[SMOPT_GRP_MAILBOX
] = _("Mailbox Display Options");
242 $optvals[SMOPT_GRP_MAILBOX
] = array();
244 $optvals[SMOPT_GRP_MAILBOX
][] = array(
245 'name' => 'show_num',
246 'caption' => _("Number of Messages per Page"),
247 'type' => SMOPT_TYPE_INTEGER
,
248 'refresh' => SMOPT_REFRESH_NONE
,
249 'size' => SMOPT_SIZE_TINY
252 $optvals[SMOPT_GRP_MAILBOX
][] = array(
253 'name' => 'alt_index_colors',
254 'caption' => _("Enable Alternating Row Colors"),
255 'type' => SMOPT_TYPE_BOOLEAN
,
256 'refresh' => SMOPT_REFRESH_NONE
259 $optvals[SMOPT_GRP_MAILBOX
][] = array(
260 'name' => 'fancy_index_highlite',
261 'caption' => _("Enable Fancy Row Mouseover Highlighting"),
262 'type' => SMOPT_TYPE_BOOLEAN
,
263 'refresh' => SMOPT_REFRESH_NONE
266 $optvals[SMOPT_GRP_MAILBOX
][] = array(
267 'name' => 'show_flag_buttons',
268 'caption' => _("Show Flag / Unflag Buttons"),
269 'type' => SMOPT_TYPE_BOOLEAN
,
270 'refresh' => SMOPT_REFRESH_NONE
273 $optvals[SMOPT_GRP_MAILBOX
][] = array(
274 'name' => 'show_copy_buttons',
275 'caption' => _("Enable Message Copy Buttons"),
276 'type' => SMOPT_TYPE_BOOLEAN
,
277 'refresh' => SMOPT_REFRESH_NONE
280 $optvals[SMOPT_GRP_MAILBOX
][] = array(
281 'name' => 'page_selector',
282 'caption' => _("Enable Page Selector"),
283 'type' => SMOPT_TYPE_BOOLEAN
,
284 'refresh' => SMOPT_REFRESH_NONE
287 $optvals[SMOPT_GRP_MAILBOX
][] = array(
288 'name' => 'compact_paginator',
289 'caption' => _("Use Compact Page Selector"),
290 'type' => SMOPT_TYPE_BOOLEAN
,
291 'refresh' => SMOPT_REFRESH_NONE
294 $optvals[SMOPT_GRP_MAILBOX
][] = array(
295 'name' => 'page_selector_max',
296 'caption' => _("Maximum Number of Pages to Show"),
297 'type' => SMOPT_TYPE_INTEGER
,
298 'refresh' => SMOPT_REFRESH_NONE
,
299 'size' => SMOPT_SIZE_TINY
302 $optvals[SMOPT_GRP_MAILBOX
][] = array(
303 'name' => 'show_full_date',
304 'caption' => _("Always Show Full Date"),
305 'type' => SMOPT_TYPE_BOOLEAN
,
306 'refresh' => SMOPT_REFRESH_NONE
309 $optvals[SMOPT_GRP_MAILBOX
][] = array(
310 'name' => 'truncate_sender',
311 'caption' => _("Length of From/To Field (0 for full)"),
312 'type' => SMOPT_TYPE_INTEGER
,
313 'refresh' => SMOPT_REFRESH_NONE
,
314 'size' => SMOPT_SIZE_TINY
317 $optvals[SMOPT_GRP_MAILBOX
][] = array(
318 'name' => 'truncate_subject',
319 'caption' => _("Length of Subject Field (0 for full)"),
320 'type' => SMOPT_TYPE_INTEGER
,
321 'refresh' => SMOPT_REFRESH_NONE
,
322 'size' => SMOPT_SIZE_TINY
326 disabled because the template doesn't support it (yet?)
327 $optvals[SMOPT_GRP_MAILBOX][] = array(
328 'name' => 'show_recipient_instead',
329 'caption' => _("Show recipient name if the message is from your default identity"),
330 'type' => SMOPT_TYPE_BOOLEAN,
331 'refresh' => SMOPT_REFRESH_NONE,
332 'size' => SMOPT_SIZE_TINY
336 if ($allow_thread_sort == TRUE) {
337 $optvals[SMOPT_GRP_MAILBOX
][] = array(
338 'name' => 'sort_by_ref',
339 'caption' => _("Enable Thread Sort by References Header"),
340 'type' => SMOPT_TYPE_BOOLEAN
,
341 'refresh' => SMOPT_REFRESH_ALL
347 /*** Load the General Options into the array ***/
348 $optgrps[SMOPT_GRP_MESSAGE
] = _("Message Display Options");
349 $optvals[SMOPT_GRP_MESSAGE
] = array();
351 $optvals[SMOPT_GRP_MESSAGE
][] = array(
353 'caption' => _("Wrap Incoming Text At"),
354 'type' => SMOPT_TYPE_INTEGER
,
355 'refresh' => SMOPT_REFRESH_NONE
,
356 'size' => SMOPT_SIZE_TINY
359 $optvals[SMOPT_GRP_MESSAGE
][] = array(
360 'name' => 'show_html_default',
361 'caption' => _("Show HTML Version by Default"),
362 'type' => SMOPT_TYPE_BOOLEAN
,
363 'refresh' => SMOPT_REFRESH_NONE
367 // Type is set to string in order to be able to use 100%.
368 $optvals[SMOPT_GRP_MESSAGE
][] = array(
369 'name' => 'iframe_height',
370 'caption' => _("Height of inline frame"),
371 'type' => SMOPT_TYPE_STRING
,
372 'size' => SMOPT_SIZE_TINY
,
373 'refresh' => SMOPT_REFRESH_NONE
376 $optvals[SMOPT_GRP_MESSAGE
][] = array(
377 'name' => 'enable_forward_as_attachment',
378 'caption' => _("Enable Forward as Attachment"),
379 'type' => SMOPT_TYPE_BOOLEAN
,
380 'refresh' => SMOPT_REFRESH_NONE
383 $optvals[SMOPT_GRP_MESSAGE
][] = array(
384 'name' => 'show_xmailer_default',
385 'caption' => _("Enable Mailer Display"),
386 'type' => SMOPT_TYPE_BOOLEAN
,
387 'refresh' => SMOPT_REFRESH_NONE
390 $optvals[SMOPT_GRP_MESSAGE
][] = array(
391 'name' => 'attachment_common_show_images',
392 'caption' => _("Display Attached Images with Message"),
393 'type' => SMOPT_TYPE_BOOLEAN
,
394 'refresh' => SMOPT_REFRESH_NONE
397 if ($default_use_mdn) {
398 $optvals[SMOPT_GRP_MESSAGE
][] = array(
399 'name' => 'mdn_user_support',
400 'caption' => _("Enable Mail Delivery Notification"),
401 'type' => SMOPT_TYPE_BOOLEAN
,
402 'refresh' => SMOPT_REFRESH_NONE
406 $optvals[SMOPT_GRP_MESSAGE
][] = array(
407 'name' => 'delete_prev_next_display',
408 'caption' => _("Show 'Delete & Prev/Next' Links"),
409 'type' => SMOPT_TYPE_BOOLEAN
,
410 'refresh' => SMOPT_REFRESH_ALL
413 /* Assemble all this together and return it as our result. */
421 /******************************************************************/
422 /** Define any specialized save functions for this option page. ***/
423 /******************************************************************/
426 * This function saves a new template setting.
427 * It updates the template array.
429 function save_option_template($option) {
430 global $aTemplateSet;
432 /* Do checking to make sure new template is in the available templates array. */
433 $templateset_in_array = false;
434 for ($i = 0; $i < count($aTemplateSet); ++
$i) {
435 if ($aTemplateSet[$i]['ID'] == $option->new_value
) {
436 $templateset_in_array = true;
441 if (!$templateset_in_array) {
442 $option->new_value
= '';
445 // clear template cache when changing template sets
446 // (in order to do so, we have to change the global
447 // template set ID now... should not be a problem --
448 // in fact, if we don't do it now, very anomalous
452 $sTemplateID = $option->new_value
;
453 Template
::cache_template_file_hierarchy(TRUE);
457 /* Save the option like normal. */
458 save_option($option);
462 * This function saves the javascript detection option.
464 function save_option_javascript_autodetect($option) {
465 save_option($option);
466 checkForJavascript(TRUE);
470 * This function saves the user's icon theme setting
472 function icon_theme_save($option) {
473 global $icon_themes, $data_dir, $username;
476 // Don't assume the new value is there, double check
477 // and only save if found
480 while (!$found && (list($index, $data) = each($icon_themes))) {
481 if ($data['PATH'] == $option->new_value
)
486 $option->new_value
= 'none';
488 save_option($option);
491 function css_theme_save ($option) {
492 global $user_themes, $data_dir, $username;
494 // Don't assume the new value is there, double check
495 // and only save if found
499 while (!$found && (list($index, $data) = each($user_themes))) {
500 if ('u_'.$data['PATH'] == $option->new_value
)
504 setPref($data_dir, $username, 'chosen_theme', $option->new_value
);
506 setPref($data_dir, $username, 'chosen_theme', 'none');