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);
19 // load icon themes if in use
23 $dirName = SM_PATH
. 'images/themes';
24 if (is_readable($dirName) && is_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");
36 if (! isset($use_iframe)) $use_iframe=false;
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
51 function load_optpage_data_display() {
52 global $theme, $fontsets, $language, $languages,$aTemplateSet,
53 $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
54 $show_alternative_names, $use_icons, $use_iframe, $sTplDir;
56 /* Build a simple array into which we will build options. */
60 /******************************************************/
61 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
62 /******************************************************/
64 /*** Load the General Options into the array ***/
65 $optgrps[SMOPT_GRP_GENERAL
] = _("General Display Options");
66 $optvals[SMOPT_GRP_GENERAL
] = array();
68 /* load the template set option */
69 $templateset_values = array();
71 foreach ($aTemplateSet as $sKey => $aTemplateSetAttributes) {
72 $templateset_values[$aTemplateSetAttributes['NAME']] = $aTemplateSetAttributes['PATH'];
74 ksort($templateset_values);
75 $templateset_values = array_flip($templateset_values);
76 // display template options only when there is more than one template
77 if (count($templateset_values)>1) {
78 $optvals[SMOPT_GRP_GENERAL
][] = array(
80 'caption' => _("Template"),
81 'type' => SMOPT_TYPE_STRLIST
,
82 'refresh' => SMOPT_REFRESH_ALL
,
83 'posvals' => $templateset_values,
84 'save' => 'save_option_template'
88 /* Load the theme option. */
89 $theme_values = array();
90 foreach ($theme as $theme_key => $theme_attributes) {
91 $theme_values[$theme_attributes['NAME']] = $theme_attributes['PATH'];
94 $theme_values = array_flip($theme_values);
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' => 'save_option_theme'
104 $css_values = array( 'none' => _("Default" ) );
105 $css_dir = SM_PATH
. 'themes/css';
106 if (is_readable($css_dir) && is_dir($css_dir)) {
107 $handle=opendir($css_dir);
108 while ($file = readdir($handle) ) {
109 if ( substr( $file, -4 ) == '.css' ) {
110 $css_values[$file] = substr( $file, 0, strlen( $file ) - 4 );
117 if ( count( $css_values ) > 1 ) {
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
130 $fontset_values = array();
131 $fontset_list = array();
133 if (!empty($fontsets) && is_array($fontsets)) {
135 foreach (array_keys($fontsets) as $fontset_key) {
136 $fontset_list[$fontset_key]=$fontset_key;
138 ksort($fontset_list);
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
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"),
164 $language_values = array();
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'];
176 asort($language_values);
178 array_merge(array('' => _("Default")), $language_values);
179 $language = $squirrelmail_language;
181 // add language selection only when more than 2 languages are available
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
194 /* Set values for the "use javascript" option. */
195 $optvals[SMOPT_GRP_GENERAL
][] = array(
196 'name' => 'javascript_setting',
197 'caption' => _("Use Javascript"),
198 'type' => SMOPT_TYPE_STRLIST
,
199 'refresh' => SMOPT_REFRESH_ALL
,
200 'posvals' => array(SMPREF_JS_AUTODETECT
=> _("Autodetect"),
201 SMPREF_JS_ON
=> _("Always"),
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
. '\';"'
207 $optvals[SMOPT_GRP_GENERAL
][] = array(
208 'name' => 'js_autodetect_results',
210 'type' => SMOPT_TYPE_HIDDEN
,
211 'refresh' => SMOPT_REFRESH_NONE
212 //'post_script' => $js_autodetect_script,
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"))
224 /* Icon theme selection */
226 global $icon_themes, $icon_theme;
229 for ($count = 0; $count < sizeof($icon_themes); $count++
) {
230 $temp[$count] = $icon_themes[$count]['NAME'];
231 if ($icon_theme == $icon_themes[$count]['PATH'] ||
232 (($icon_theme == $sTplDir.'images/') && ($icon_themes[$count]['PATH']=='template'))
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
,
244 'initial_value' => $value,
245 'save' => 'icon_theme_save'
250 /*** Load the General Options into the array ***/
251 $optgrps[SMOPT_GRP_MAILBOX
] = _("Mailbox Display Options");
252 $optvals[SMOPT_GRP_MAILBOX
] = array();
254 $optvals[SMOPT_GRP_MAILBOX
][] = array(
255 'name' => 'show_num',
256 'caption' => _("Number of Messages per Page"),
257 'type' => SMOPT_TYPE_INTEGER
,
258 'refresh' => SMOPT_REFRESH_NONE
,
259 'size' => SMOPT_SIZE_TINY
262 $optvals[SMOPT_GRP_MAILBOX
][] = array(
263 'name' => 'alt_index_colors',
264 'caption' => _("Enable Alternating Row Colors"),
265 'type' => SMOPT_TYPE_BOOLEAN
,
266 'refresh' => SMOPT_REFRESH_NONE
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
276 $optvals[SMOPT_GRP_MAILBOX
][] = array(
277 'name' => 'show_flag_buttons',
278 'caption' => _("Show Flag / Unflag Buttons"),
279 'type' => SMOPT_TYPE_BOOLEAN
,
280 'refresh' => SMOPT_REFRESH_NONE
283 $optvals[SMOPT_GRP_MAILBOX
][] = array(
284 'name' => 'page_selector',
285 'caption' => _("Enable Page Selector"),
286 'type' => SMOPT_TYPE_BOOLEAN
,
287 'refresh' => SMOPT_REFRESH_NONE
290 $optvals[SMOPT_GRP_MAILBOX
][] = array(
291 'name' => 'compact_paginator',
292 'caption' => _("Use Compact Page Selector"),
293 'type' => SMOPT_TYPE_BOOLEAN
,
294 'refresh' => SMOPT_REFRESH_NONE
297 $optvals[SMOPT_GRP_MAILBOX
][] = array(
298 'name' => 'page_selector_max',
299 'caption' => _("Maximum Number of Pages to Show"),
300 'type' => SMOPT_TYPE_INTEGER
,
301 'refresh' => SMOPT_REFRESH_NONE
,
302 'size' => SMOPT_SIZE_TINY
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
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
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
328 disabled because the template doesn't support it (yet?)
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
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
349 /*** Load the General Options into the array ***/
350 $optgrps[SMOPT_GRP_MESSAGE
] = _("Message Display Options");
351 $optvals[SMOPT_GRP_MESSAGE
] = array();
353 $optvals[SMOPT_GRP_MESSAGE
][] = array(
355 'caption' => _("Wrap Incoming Text At"),
356 'type' => SMOPT_TYPE_INTEGER
,
357 'refresh' => SMOPT_REFRESH_NONE
,
358 'size' => SMOPT_SIZE_TINY
361 $optvals[SMOPT_GRP_MESSAGE
][] = array(
362 'name' => 'show_html_default',
363 'caption' => _("Show HTML Version by Default"),
364 'type' => SMOPT_TYPE_BOOLEAN
,
365 'refresh' => SMOPT_REFRESH_NONE
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
378 $optvals[SMOPT_GRP_MESSAGE
][] = array(
379 'name' => 'enable_forward_as_attachment',
380 'caption' => _("Enable Forward as Attachment"),
381 'type' => SMOPT_TYPE_BOOLEAN
,
382 'refresh' => SMOPT_REFRESH_NONE
385 $optvals[SMOPT_GRP_MESSAGE
][] = array(
386 'name' => 'show_xmailer_default',
387 'caption' => _("Enable Mailer Display"),
388 'type' => SMOPT_TYPE_BOOLEAN
,
389 'refresh' => SMOPT_REFRESH_NONE
392 $optvals[SMOPT_GRP_MESSAGE
][] = array(
393 'name' => 'attachment_common_show_images',
394 'caption' => _("Display Attached Images with Message"),
395 'type' => SMOPT_TYPE_BOOLEAN
,
396 'refresh' => SMOPT_REFRESH_NONE
399 if ($default_use_mdn) {
400 $optvals[SMOPT_GRP_MESSAGE
][] = array(
401 'name' => 'mdn_user_support',
402 'caption' => _("Enable Mail Delivery Notification"),
403 'type' => SMOPT_TYPE_BOOLEAN
,
404 'refresh' => SMOPT_REFRESH_NONE
408 $optvals[SMOPT_GRP_MESSAGE
][] = array(
409 'name' => 'delete_prev_next_display',
410 'caption' => _("Show 'Delete & Prev/Next' Links"),
411 'type' => SMOPT_TYPE_BOOLEAN
,
412 'refresh' => SMOPT_REFRESH_ALL
415 /* Assemble all this together and return it as our result. */
423 /******************************************************************/
424 /** Define any specialized save functions for this option page. ***/
425 /******************************************************************/
428 * This function saves a new template setting.
429 * It updates the template array.
431 function save_option_template($option) {
432 global $aTemplateSet;
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;
443 if (!$templateset_in_array) {
444 $option->new_value
= '';
446 /* Save the option like normal. */
447 save_option($option);
451 * This function saves a new theme setting.
452 * It updates the theme array.
454 function save_option_theme($option) {
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;
466 if (!$theme_in_array) {
467 $option->new_value
= '';
470 /* Save the option like normal. */
471 save_option($option);
475 * This function saves the javascript detection option.
477 function save_option_javascript_autodetect($option) {
478 save_option($option);
479 checkForJavascript(TRUE);
483 * This function saves the user's icon theme setting
485 function icon_theme_save($option) {
487 global $icon_themes, $data_dir, $username;
490 // Don't assume the new value is there, double check
491 // and only save if found
493 if (isset($icon_themes[$option->new_value
]['PATH']))
494 setPref($data_dir, $username, 'icon_theme', $icon_themes[$option->new_value
]['PATH']);
496 setPref($data_dir, $username, 'icon_theme', 'none');