92d4c995c8bab36bd3ab949c3e912da63ae40e1a
[squirrelmail.git] / include / options / display.php
1 <?php
2
3 /**
4 * options_display.php
5 *
6 * Copyright (c) 1999-2005 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * Displays all optinos about display preferences
10 *
11 * @version $Id$
12 * @package squirrelmail
13 */
14
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);
19
20 // load icon themes if in use
21 global $use_icons;
22 if ($use_icons) {
23 global $icon_themes;
24 $dirName = SM_PATH . 'images/themes';
25 if (is_readable($dirName) && is_dir($dirName)) {
26 $d = 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");
31 }
32 }
33 }
34 }
35
36 /**
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
48 */
49 function load_optpage_data_display() {
50 global $theme, $language, $languages,
51 $default_use_mdn, $squirrelmail_language, $allow_thread_sort,
52 $show_alternative_names, $available_languages, $use_icons;
53
54 /* Build a simple array into which we will build options. */
55 $optgrps = array();
56 $optvals = array();
57
58 /******************************************************/
59 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
60 /******************************************************/
61
62 /*** Load the General Options into the array ***/
63 $optgrps[SMOPT_GRP_GENERAL] = _("General Display Options");
64 $optvals[SMOPT_GRP_GENERAL] = array();
65
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'];
70 }
71 ksort($theme_values);
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'
80 );
81
82 $css_values = array( 'none' => _("Default" ) );
83 $css_dir = SM_PATH . 'themes/css';
84 if (is_readable($css_dir) && is_dir($css_dir)) {
85 $handle=opendir($css_dir);
86 while ($file = readdir($handle) ) {
87 if ( substr( $file, -4 ) == '.css' ) {
88 $css_values[$file] = substr( $file, 0, strlen( $file ) - 4 );
89 }
90 }
91 closedir($handle);
92 }
93
94 if ( count( $css_values ) > 1 ) {
95
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
102 );
103
104 }
105
106 // config.php can be unupdated.
107 if (! isset($available_languages) || $available_languages=="" ) {
108 $available_languages="ALL"; }
109
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'];
119 }
120 }
121 }
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'];
132 }
133 }
134 }
135 }
136 asort($language_values);
137 $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,
148 'htmlencoded' => true
149 );
150 }
151
152 /* Set values for the "use javascript" option. */
153 $optvals[SMOPT_GRP_GENERAL][] = array(
154 'name' => 'javascript_setting',
155 'caption' => _("Use Javascript"),
156 'type' => SMOPT_TYPE_STRLIST,
157 'refresh' => SMOPT_REFRESH_ALL,
158 'posvals' => array(SMPREF_JS_AUTODETECT => _("Autodetect"),
159 SMPREF_JS_ON => _("Always"),
160 SMPREF_JS_OFF => _("Never")),
161 'save' => 'save_option_javascript_autodetect',
162 'script' => 'onclick="document.forms[0].new_js_autodetect_results.value = \'' . SMPREF_JS_ON . '\';"'
163 );
164
165 $optvals[SMOPT_GRP_GENERAL][] = array(
166 'name' => 'js_autodetect_results',
167 'caption' => '',
168 'type' => SMOPT_TYPE_HIDDEN,
169 'refresh' => SMOPT_REFRESH_NONE
170 //'post_script' => $js_autodetect_script,
171 );
172
173 /*** Load the General Options into the array ***/
174 $optgrps[SMOPT_GRP_MAILBOX] = _("Mailbox Display Options");
175 $optvals[SMOPT_GRP_MAILBOX] = array();
176
177 $optvals[SMOPT_GRP_MAILBOX][] = array(
178 'name' => 'show_num',
179 'caption' => _("Number of Messages on one Page"),
180 'type' => SMOPT_TYPE_INTEGER,
181 'refresh' => SMOPT_REFRESH_NONE,
182 'size' => SMOPT_SIZE_TINY
183 );
184
185 $optvals[SMOPT_GRP_MAILBOX][] = array(
186 'name' => 'alt_index_colors',
187 'caption' => _("Enable Alternating Row Colors"),
188 'type' => SMOPT_TYPE_BOOLEAN,
189 'refresh' => SMOPT_REFRESH_NONE
190 );
191
192 if ($use_icons) {
193 global $icon_themes, $icon_theme;
194 $temp = array();
195 for ($count = 0; $count < sizeof($icon_themes); $count++) {
196 $temp[$count] = $icon_themes[$count]['NAME'];
197 if ($icon_theme == $icon_themes[$count]['PATH'])
198 $value = $count;
199 }
200 if (sizeof($icon_themes) > 0) {
201 $optvals[SMOPT_GRP_MAILBOX][] = array(
202 'name' => 'icon_theme',
203 'caption' => _("Message Flags Icon Theme"),
204 'type' => SMOPT_TYPE_STRLIST,
205 'refresh' => SMOPT_REFRESH_NONE,
206 'posvals' => $temp,
207 'initial_value' => $value,
208 'save' => 'icon_theme_save'
209 );
210 }
211 }
212
213 $optvals[SMOPT_GRP_MAILBOX][] = array(
214 'name' => 'show_flag_buttons',
215 'caption' => _("Show Flag / Unflag Buttons"),
216 'type' => SMOPT_TYPE_BOOLEAN,
217 'refresh' => SMOPT_REFRESH_NONE
218 );
219
220 $optvals[SMOPT_GRP_MAILBOX][] = array(
221 'name' => 'page_selector',
222 'caption' => _("Enable Page Selector"),
223 'type' => SMOPT_TYPE_BOOLEAN,
224 'refresh' => SMOPT_REFRESH_NONE
225 );
226
227 $optvals[SMOPT_GRP_MAILBOX][] = array(
228 'name' => 'compact_paginator',
229 'caption' => _("Use Compact Page Selector"),
230 'type' => SMOPT_TYPE_BOOLEAN,
231 'refresh' => SMOPT_REFRESH_NONE
232 );
233
234 $optvals[SMOPT_GRP_MAILBOX][] = array(
235 'name' => 'page_selector_max',
236 'caption' => _("Maximum Number of Pages to Show"),
237 'type' => SMOPT_TYPE_INTEGER,
238 'refresh' => SMOPT_REFRESH_NONE,
239 'size' => SMOPT_SIZE_TINY
240 );
241
242 $optvals[SMOPT_GRP_MAILBOX][] = array(
243 'name' => 'show_full_date',
244 'caption' => _("Always Show Full Date"),
245 'type' => SMOPT_TYPE_BOOLEAN,
246 'refresh' => SMOPT_REFRESH_NONE
247 );
248
249 $optvals[SMOPT_GRP_MAILBOX][] = array(
250 'name' => 'truncate_sender',
251 'caption' => _("Length of From/To Field (0 for full)"),
252 'type' => SMOPT_TYPE_INTEGER,
253 'refresh' => SMOPT_REFRESH_NONE,
254 'size' => SMOPT_SIZE_TINY
255 );
256
257 $optvals[SMOPT_GRP_MAILBOX][] = array(
258 'name' => 'truncate_subject',
259 'caption' => _("Length of Subject Field (0 for full)"),
260 'type' => SMOPT_TYPE_INTEGER,
261 'refresh' => SMOPT_REFRESH_NONE,
262 'size' => SMOPT_SIZE_TINY
263 );
264
265 $optvals[SMOPT_GRP_MAILBOX][] = array(
266 'name' => 'show_recipient_instead',
267 'caption' => _("Show recipient name if the message is from your default identity"),
268 'type' => SMOPT_TYPE_BOOLEAN,
269 'refresh' => SMOPT_REFRESH_NONE,
270 'size' => SMOPT_SIZE_TINY
271 );
272
273 $optvals[SMOPT_GRP_MAILBOX][] = array(
274 'name' => 'internal_date_sort',
275 'caption' => _("Sort by Received Date"),
276 'type' => SMOPT_TYPE_BOOLEAN,
277 'refresh' => SMOPT_REFRESH_ALL
278 );
279 if ($allow_thread_sort == TRUE) {
280 $optvals[SMOPT_GRP_MAILBOX][] = array(
281 'name' => 'sort_by_ref',
282 'caption' => _("Enable Thread Sort by References Header"),
283 'type' => SMOPT_TYPE_BOOLEAN,
284 'refresh' => SMOPT_REFRESH_ALL
285 );
286 }
287
288
289
290 /*** Load the General Options into the array ***/
291 $optgrps[SMOPT_GRP_MESSAGE] = _("Message Display Options");
292 $optvals[SMOPT_GRP_MESSAGE] = array();
293
294 $optvals[SMOPT_GRP_MESSAGE][] = array(
295 'name' => 'wrap_at',
296 'caption' => _("Wrap Incoming Text At"),
297 'type' => SMOPT_TYPE_INTEGER,
298 'refresh' => SMOPT_REFRESH_NONE,
299 'size' => SMOPT_SIZE_TINY
300 );
301
302 $optvals[SMOPT_GRP_MESSAGE][] = array(
303 'name' => 'show_html_default',
304 'caption' => _("Show HTML Version by Default"),
305 'type' => SMOPT_TYPE_BOOLEAN,
306 'refresh' => SMOPT_REFRESH_NONE
307 );
308
309 $optvals[SMOPT_GRP_MESSAGE][] = array(
310 'name' => 'enable_forward_as_attachment',
311 'caption' => _("Enable Forward as Attachment"),
312 'type' => SMOPT_TYPE_BOOLEAN,
313 'refresh' => SMOPT_REFRESH_NONE
314 );
315
316 $optvals[SMOPT_GRP_MESSAGE][] = array(
317 'name' => 'show_xmailer_default',
318 'caption' => _("Enable Mailer Display"),
319 'type' => SMOPT_TYPE_BOOLEAN,
320 'refresh' => SMOPT_REFRESH_NONE
321 );
322
323 $optvals[SMOPT_GRP_MESSAGE][] = array(
324 'name' => 'attachment_common_show_images',
325 'caption' => _("Display Attached Images with Message"),
326 'type' => SMOPT_TYPE_BOOLEAN,
327 'refresh' => SMOPT_REFRESH_NONE
328 );
329
330 if ($default_use_mdn) {
331 $optvals[SMOPT_GRP_MESSAGE][] = array(
332 'name' => 'mdn_user_support',
333 'caption' => _("Enable Mail Delivery Notification"),
334 'type' => SMOPT_TYPE_BOOLEAN,
335 'refresh' => SMOPT_REFRESH_NONE
336 );
337 }
338
339 $optvals[SMOPT_GRP_MESSAGE][] = array(
340 'name' => 'delete_prev_next_display',
341 'caption' => _("Show 'Delete & Prev/Next' Links"),
342 'type' => SMOPT_TYPE_BOOLEAN,
343 'refresh' => SMOPT_REFRESH_ALL
344 );
345
346 /* Assemble all this together and return it as our result. */
347 $result = array(
348 'grps' => $optgrps,
349 'vals' => $optvals
350 );
351 return ($result);
352 }
353
354 /******************************************************************/
355 /** Define any specialized save functions for this option page. ***/
356 /******************************************************************/
357
358 function save_option_header($option) {
359 }
360
361 /**
362 * This function saves a new theme setting.
363 * It updates the theme array.
364 */
365 function save_option_theme($option) {
366 global $theme;
367
368 /* Do checking to make sure $new_theme is in the array. */
369 $theme_in_array = false;
370 for ($i = 0; $i < count($theme); ++$i) {
371 if ($theme[$i]['PATH'] == $option->new_value) {
372 $theme_in_array = true;
373 break;
374 }
375 }
376
377 if (!$theme_in_array) {
378 $option->new_value = '';
379 }
380
381 /* Save the option like normal. */
382 save_option($option);
383 }
384
385 /**
386 * This function saves the javascript detection option.
387 */
388 function save_option_javascript_autodetect($option) {
389 save_option($option);
390 checkForJavascript(TRUE);
391 }
392
393 /**
394 * This function saves the user's icon theme setting
395 */
396 function icon_theme_save($option) {
397
398 global $icon_themes, $data_dir, $username;
399
400
401 // Don't assume the new value is there, double check
402 // and only save if found
403 //
404 if (isset($icon_themes[$option->new_value]['PATH']))
405 setPref($data_dir, $username, 'icon_theme', $icon_themes[$option->new_value]['PATH']);
406 else
407 setPref($data_dir, $username, 'icon_theme', 'none');
408
409 }
410
411 /**
412 * This function saves the reply prefix (body_quote) character(s)
413 */
414 function save_option_reply_prefix($option) {
415
416 // save as "NONE" if it was blanked out
417 //
418 if (empty($option->new_value)) $option->new_value = 'NONE';
419
420
421 // Save the option like normal.
422 //
423 save_option($option);
424
425 }
426
427 ?>