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;
230 for ($count = 0; $count < sizeof($icon_themes); $count++
) {
231 $temp[$count] = $icon_themes[$count]['NAME'];
232 if ($icon_theme == $icon_themes[$count]['PATH'] ||
233 (($icon_theme == $sTplDir.'images/') && ($icon_themes[$count]['PATH']=='template'))
238 if (sizeof($icon_themes) > 0) {
239 $optvals[SMOPT_GRP_GENERAL
][] = array(
240 'name' => 'icon_theme',
241 'caption' => _("Icon Theme"),
242 'type' => SMOPT_TYPE_STRLIST
,
243 'refresh' => SMOPT_REFRESH_NONE
,
245 'initial_value' => $value,
246 'save' => 'icon_theme_save'
252 /*** Load the General Options into the array ***/
253 $optgrps[SMOPT_GRP_MAILBOX
] = _("Mailbox Display Options");
254 $optvals[SMOPT_GRP_MAILBOX
] = array();
256 $optvals[SMOPT_GRP_MAILBOX
][] = array(
257 'name' => 'show_num',
258 'caption' => _("Number of Messages per Page"),
259 'type' => SMOPT_TYPE_INTEGER
,
260 'refresh' => SMOPT_REFRESH_NONE
,
261 'size' => SMOPT_SIZE_TINY
264 $optvals[SMOPT_GRP_MAILBOX
][] = array(
265 'name' => 'alt_index_colors',
266 'caption' => _("Enable Alternating Row Colors"),
267 'type' => SMOPT_TYPE_BOOLEAN
,
268 'refresh' => SMOPT_REFRESH_NONE
271 $optvals[SMOPT_GRP_MAILBOX
][] = array(
272 'name' => 'fancy_index_highlite',
273 'caption' => _("Enable Fancy Row Mouseover Highlighting"),
274 'type' => SMOPT_TYPE_BOOLEAN
,
275 'refresh' => SMOPT_REFRESH_NONE
278 $optvals[SMOPT_GRP_MAILBOX
][] = array(
279 'name' => 'show_flag_buttons',
280 'caption' => _("Show Flag / Unflag Buttons"),
281 'type' => SMOPT_TYPE_BOOLEAN
,
282 'refresh' => SMOPT_REFRESH_NONE
285 $optvals[SMOPT_GRP_MAILBOX
][] = array(
286 'name' => 'show_copy_buttons',
287 'caption' => _("Enable Message Copy Buttons"),
288 'type' => SMOPT_TYPE_BOOLEAN
,
289 'refresh' => SMOPT_REFRESH_NONE
292 $optvals[SMOPT_GRP_MAILBOX
][] = array(
293 'name' => 'page_selector',
294 'caption' => _("Enable Page Selector"),
295 'type' => SMOPT_TYPE_BOOLEAN
,
296 'refresh' => SMOPT_REFRESH_NONE
299 $optvals[SMOPT_GRP_MAILBOX
][] = array(
300 'name' => 'compact_paginator',
301 'caption' => _("Use Compact Page Selector"),
302 'type' => SMOPT_TYPE_BOOLEAN
,
303 'refresh' => SMOPT_REFRESH_NONE
306 $optvals[SMOPT_GRP_MAILBOX
][] = array(
307 'name' => 'page_selector_max',
308 'caption' => _("Maximum Number of Pages to Show"),
309 'type' => SMOPT_TYPE_INTEGER
,
310 'refresh' => SMOPT_REFRESH_NONE
,
311 'size' => SMOPT_SIZE_TINY
314 $optvals[SMOPT_GRP_MAILBOX
][] = array(
315 'name' => 'show_full_date',
316 'caption' => _("Always Show Full Date"),
317 'type' => SMOPT_TYPE_BOOLEAN
,
318 'refresh' => SMOPT_REFRESH_NONE
321 $optvals[SMOPT_GRP_MAILBOX
][] = array(
322 'name' => 'truncate_sender',
323 'caption' => _("Length of From/To Field (0 for full)"),
324 'type' => SMOPT_TYPE_INTEGER
,
325 'refresh' => SMOPT_REFRESH_NONE
,
326 'size' => SMOPT_SIZE_TINY
329 $optvals[SMOPT_GRP_MAILBOX
][] = array(
330 'name' => 'truncate_subject',
331 'caption' => _("Length of Subject Field (0 for full)"),
332 'type' => SMOPT_TYPE_INTEGER
,
333 'refresh' => SMOPT_REFRESH_NONE
,
334 'size' => SMOPT_SIZE_TINY
337 disabled because the template doesn't support it (yet?)
338 $optvals[SMOPT_GRP_MAILBOX][] = array(
339 'name' => 'show_recipient_instead',
340 'caption' => _("Show recipient name if the message is from your default identity"),
341 'type' => SMOPT_TYPE_BOOLEAN,
342 'refresh' => SMOPT_REFRESH_NONE,
343 'size' => SMOPT_SIZE_TINY
347 if ($allow_thread_sort == TRUE) {
348 $optvals[SMOPT_GRP_MAILBOX
][] = array(
349 'name' => 'sort_by_ref',
350 'caption' => _("Enable Thread Sort by References Header"),
351 'type' => SMOPT_TYPE_BOOLEAN
,
352 'refresh' => SMOPT_REFRESH_ALL
358 /*** Load the General Options into the array ***/
359 $optgrps[SMOPT_GRP_MESSAGE
] = _("Message Display Options");
360 $optvals[SMOPT_GRP_MESSAGE
] = array();
362 $optvals[SMOPT_GRP_MESSAGE
][] = array(
364 'caption' => _("Wrap Incoming Text At"),
365 'type' => SMOPT_TYPE_INTEGER
,
366 'refresh' => SMOPT_REFRESH_NONE
,
367 'size' => SMOPT_SIZE_TINY
370 $optvals[SMOPT_GRP_MESSAGE
][] = array(
371 'name' => 'show_html_default',
372 'caption' => _("Show HTML Version by Default"),
373 'type' => SMOPT_TYPE_BOOLEAN
,
374 'refresh' => SMOPT_REFRESH_NONE
378 // Type is set to string in order to be able to use 100%.
379 $optvals[SMOPT_GRP_MESSAGE
][] = array(
380 'name' => 'iframe_height',
381 'caption' => _("Height of inline frame"),
382 'type' => SMOPT_TYPE_STRING
,
383 'size' => SMOPT_SIZE_TINY
,
384 'refresh' => SMOPT_REFRESH_NONE
387 $optvals[SMOPT_GRP_MESSAGE
][] = array(
388 'name' => 'enable_forward_as_attachment',
389 'caption' => _("Enable Forward as Attachment"),
390 'type' => SMOPT_TYPE_BOOLEAN
,
391 'refresh' => SMOPT_REFRESH_NONE
394 $optvals[SMOPT_GRP_MESSAGE
][] = array(
395 'name' => 'show_xmailer_default',
396 'caption' => _("Enable Mailer Display"),
397 'type' => SMOPT_TYPE_BOOLEAN
,
398 'refresh' => SMOPT_REFRESH_NONE
401 $optvals[SMOPT_GRP_MESSAGE
][] = array(
402 'name' => 'attachment_common_show_images',
403 'caption' => _("Display Attached Images with Message"),
404 'type' => SMOPT_TYPE_BOOLEAN
,
405 'refresh' => SMOPT_REFRESH_NONE
408 if ($default_use_mdn) {
409 $optvals[SMOPT_GRP_MESSAGE
][] = array(
410 'name' => 'mdn_user_support',
411 'caption' => _("Enable Mail Delivery Notification"),
412 'type' => SMOPT_TYPE_BOOLEAN
,
413 'refresh' => SMOPT_REFRESH_NONE
417 $optvals[SMOPT_GRP_MESSAGE
][] = array(
418 'name' => 'delete_prev_next_display',
419 'caption' => _("Show 'Delete & Prev/Next' Links"),
420 'type' => SMOPT_TYPE_BOOLEAN
,
421 'refresh' => SMOPT_REFRESH_ALL
424 /* Assemble all this together and return it as our result. */
432 /******************************************************************/
433 /** Define any specialized save functions for this option page. ***/
434 /******************************************************************/
437 * This function saves a new template setting.
438 * It updates the template array.
440 function save_option_template($option) {
441 global $aTemplateSet;
443 /* Do checking to make sure $new_theme is in the array. */
444 $templateset_in_array = false;
445 for ($i = 0; $i < count($aTemplateSet); ++
$i) {
446 if ($aTemplateSet[$i]['PATH'] == $option->new_value
) {
447 $templateset_in_array = true;
452 if (!$templateset_in_array) {
453 $option->new_value
= '';
455 /* Save the option like normal. */
456 save_option($option);
460 * This function saves a new theme setting.
461 * It updates the theme array.
463 function save_option_theme($option) {
466 /* Do checking to make sure $new_theme is in the array. */
467 $theme_in_array = false;
468 for ($i = 0; $i < count($theme); ++
$i) {
469 if ($theme[$i]['PATH'] == $option->new_value
) {
470 $theme_in_array = true;
475 if (!$theme_in_array) {
476 $option->new_value
= '';
479 /* Save the option like normal. */
480 save_option($option);
484 * This function saves the javascript detection option.
486 function save_option_javascript_autodetect($option) {
487 save_option($option);
488 checkForJavascript(TRUE);
492 * This function saves the user's icon theme setting
494 function icon_theme_save($option) {
496 global $icon_themes, $data_dir, $username;
499 // Don't assume the new value is there, double check
500 // and only save if found
502 if (isset($icon_themes[$option->new_value
]['PATH']))
503 setPref($data_dir, $username, 'icon_theme', $icon_themes[$option->new_value
]['PATH']);
505 setPref($data_dir, $username, 'icon_theme', 'none');