Fixed ui_reset
[webmin.git] / ui-lib.pl
1 # ui-lib.pl
2 # Common functions for generating HTML for Webmin user interface elements
3
4 ####################### table generation functions
5
6 # ui_table_start(heading, [tabletags], [cols], [&default-tds])
7 # A table with a heading and table inside
8 sub ui_table_start
9 {
10 return &theme_ui_table_start(@_) if (defined(&theme_ui_table_start));
11 local ($heading, $tabletags, $cols, $tds) = @_;
12 local $rv;
13 $rv .= "<table class='ui_table' border $tabletags>\n";
14 $rv .= "<tr $tb> <td><b>$heading</b></td> </tr>\n" if (defined($heading));
15 $rv .= "<tr $cb> <td><table width=100%>\n";
16 $main::ui_table_cols = $cols || 4;
17 $main::ui_table_pos = 0;
18 $main::ui_table_default_tds = $tds;
19 return $rv;
20 }
21
22 # ui_table_end()
23 # The end of a table started by ui_table_start
24 sub ui_table_end
25 {
26 return &theme_ui_table_end(@_) if (defined(&theme_ui_table_end));
27 $main::ui_table_default_tds = undef;
28 return "</table></td></tr></table>\n";
29 }
30
31 # ui_columns_start(&headings, [width-percent], [noborder], [&tdtags], [heading])
32 # Returns HTML for a multi-column table, with the given headings
33 sub ui_columns_start
34 {
35 return &theme_ui_columns_start(@_) if (defined(&theme_ui_columns_start));
36 local ($heads, $width, $noborder, $tdtags, $heading) = @_;
37 local $rv;
38 $rv .= "<table".($noborder ? "" : " border").
39                 (defined($width) ? " width=$width%" : "")." class='ui_columns'>\n";
40 if ($heading) {
41         $rv .= "<tr $tb><td colspan=".scalar(@$heads).
42                " class='ui_columns_heading'><b>$heading</b></td></tr>\n";
43         }
44 $rv .= "<tr $tb class='ui_columns_heads'>\n";
45 local $i;
46 for($i=0; $i<@$heads; $i++) {
47         $rv .= "<td ".$tdtags->[$i]."><b>".
48                ($heads->[$i] eq "" ? "<br>" : $heads->[$i])."</b></td>\n";
49         }
50 $rv .= "</tr>\n";
51 return $rv;
52 }
53
54 # ui_columns_row(&columns, &tdtags)
55 # Returns HTML for a row in a multi-column table
56 sub ui_columns_row
57 {
58 return &theme_ui_columns_row(@_) if (defined(&theme_ui_columns_row));
59 local ($cols, $tdtags) = @_;
60 local $rv;
61 $rv .= "<tr $cb class='ui_columns_row'>\n";
62 local $i;
63 for($i=0; $i<@$cols; $i++) {
64         $rv .= "<td ".$tdtags->[$i].">".
65                ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i])."</td>\n";
66         }
67 $rv .= "</tr>\n";
68 return $rv;
69 }
70
71 # ui_columns_header(&columns, &tdtags)
72 # Returns HTML for a row in a multi-column table, with a header background
73 sub ui_columns_header
74 {
75 return &theme_ui_columns_header(@_) if (defined(&theme_ui_columns_header));
76 local ($cols, $tdtags) = @_;
77 local $rv;
78 $rv .= "<tr $tb class='ui_columns_header'>\n";
79 local $i;
80 for($i=0; $i<@$cols; $i++) {
81         $rv .= "<td ".$tdtags->[$i]."><b>".
82                ($cols->[$i] eq "" ? "<br>" : $cols->[$i])."</b></td>\n";
83         }
84 $rv .= "</tr>\n";
85 return $rv;
86 }
87
88 # ui_checked_columns_row(&columns, &tdtags, checkname, checkvalue, [checked?])
89 # Returns HTML for a row in a multi-column table, in which the first
90 # column is a checkbox
91 sub ui_checked_columns_row
92 {
93 return &theme_ui_checked_columns_row(@_) if (defined(&theme_ui_checked_columns_row));
94 local ($cols, $tdtags, $checkname, $checkvalue, $checked) = @_;
95 local $rv;
96 $rv .= "<tr $cb class='ui_checked_columns'>\n";
97 $rv .= "<td class='ui_checked_checkbox' ".$tdtags->[0].">".
98        &ui_checkbox($checkname, $checkvalue, undef, $checked)."</td>\n";
99 local $i;
100 for($i=0; $i<@$cols; $i++) {
101         $rv .= "<td ".$tdtags->[$i+1].">";
102         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
103                 $rv .= "<label for=\"".
104                         &quote_escape("${checkname}_${checkvalue}")."\">";
105                 }
106         $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
107         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
108                 $rv .= "</label>";
109                 }
110         $rv .= "</td>\n";
111         }
112 $rv .= "</tr>\n";
113 return $rv;
114 }
115
116 # ui_radio_columns_row(&columns, &tdtags, checkname, checkvalue, [checked])
117 # Returns HTML for a row in a multi-column table, in which the first
118 # column is a radio button
119 sub ui_radio_columns_row
120 {
121 return &theme_ui_radio_columns_row(@_) if (defined(&theme_ui_radio_columns_row));
122 local ($cols, $tdtags, $checkname, $checkvalue, $checked) = @_;
123 local $rv;
124 $rv .= "<tr $cb class='ui_radio_columns'>\n";
125 $rv .= "<td class='ui_radio_radio' ".$tdtags->[0].">".
126        &ui_oneradio($checkname, $checkvalue, "", $checked)."</td>\n";
127 local $i;
128 for($i=0; $i<@$cols; $i++) {
129         $rv .= "<td ".$tdtags->[$i+1].">";
130         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
131                 $rv .= "<label for=\"".
132                         &quote_escape("${checkname}_${checkvalue}")."\">";
133                 }
134         $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
135         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
136                 $rv .= "</label>";
137                 }
138         $rv .= "</td>\n";
139         }
140 $rv .= "</tr>\n";
141 return $rv;
142 }
143
144 # ui_columns_end()
145 # Returns HTML to end a table started by ui_columns_start
146 sub ui_columns_end
147 {
148 return &theme_ui_columns_end(@_) if (defined(&theme_ui_columns_end));
149 return "</table>\n";
150 }
151
152 ####################### form generation functions
153
154 # ui_form_start(script, method, [target], [tags])
155 # Returns HTML for a form that submits to some script
156 sub ui_form_start
157 {
158 return &theme_ui_form_start(@_) if (defined(&theme_ui_form_start));
159 local ($script, $method, $target, $tags) = @_;
160 local $rv;
161 $rv .= "<form class='ui_form' action='$script' ".
162         ($method eq "post" ? "method=post" :
163          $method eq "form-data" ?
164                 "method=post enctype=multipart/form-data" :
165                 "method=get").
166         ($target ? " target=$target" : "").
167         " ".$tags.
168        ">\n";
169 return $rv;
170 }
171
172 # ui_form_end([&buttons], [width])
173 # Returns HTML for the end of a form, optionally with a row of submit buttons
174 sub ui_form_end
175 {
176 return &theme_ui_form_end(@_) if (defined(&theme_ui_form_end));
177 local ($buttons, $width) = @_;
178 local $rv;
179 if ($buttons && @$buttons) {
180         $rv .= "<table class='ui_form_end_buttons' ".($width ? " width=$width" : "")."><tr>\n";
181         local $b;
182         foreach $b (@$buttons) {
183                 if (ref($b)) {
184                         $rv .= "<td".(!$width ? "" :
185                                       $b eq $buttons->[0] ? " align=left" :
186                                       $b eq $buttons->[@$buttons-1] ?
187                                         " align=right" : " align=center").">".
188                                &ui_submit($b->[1], $b->[0], $b->[3], $b->[4]).
189                                ($b->[2] ? " ".$b->[2] : "")."</td>\n";
190                         }
191                 elsif ($b) {
192                         $rv .= "<td>$b</td>\n";
193                         }
194                 else {
195                         $rv .= "<td>&nbsp;&nbsp;</td>\n";
196                         }
197                 }
198         $rv .= "</tr></table>\n";
199         }
200 $rv .= "</form>\n";
201 return $rv;
202 }
203
204 # ui_textbox(name, value, size, [disabled?], [maxlength], [tags])
205 # Returns HTML for a text input
206 sub ui_textbox
207 {
208 return &theme_ui_textbox(@_) if (defined(&theme_ui_textbox));
209 local ($name, $value, $size, $dis, $max, $tags) = @_;
210 $size = &ui_max_text_width($size);
211 return "<input name=\"".&quote_escape($name)."\" ".
212        "value=\"".&quote_escape($value)."\" ".
213        "size=$size ".($dis ? "disabled=true" : "").
214        ($max ? " maxlength=$max" : "").
215        " ".$tags.
216        ">";
217 }
218
219 # ui_bytesbox(name, bytes, [size], [disabled?])
220 # Returns HTML for entering a number of bytes, but with friendly kB/MB/GB
221 # options. May truncate values to 2 decimal points!
222 sub ui_bytesbox
223 {
224 local ($name, $bytes, $size, $dis) = @_;
225 local $units = 1;
226 if ($bytes >= 10*1024*1024*1024) {
227         $units = 1024*1024*1024;
228         }
229 elsif ($bytes >= 10*1024*1024) {
230         $units = 1024*1024;
231         }
232 elsif ($bytes >= 10*1024) {
233         $units = 1024;
234         }
235 else {
236         $units = 1;
237         }
238 if ($bytes ne "") {
239         $bytes = sprintf("%.2f", ($bytes*1.0)/$units);
240         $bytes =~ s/\.00$//;
241         }
242 $size = &ui_max_text_width($size || 8);
243 return &ui_textbox($name, $bytes, $size, $dis)." ".
244        &ui_select($name."_units", $units,
245                  [ [ 1, "bytes" ], [ 1024, "kB" ], [ 1024*1024, "MB" ],
246                    [ 1024*1024*1024, "GB" ] ], undef, undef, undef, $dis);
247 }
248
249 # ui_upload(name, size, [disabled?], [tags])
250 # Returns HTML for a file upload input
251 sub ui_upload
252 {
253 return &theme_ui_upload(@_) if (defined(&theme_ui_upload));
254 local ($name, $size, $dis, $tags) = @_;
255 $size = &ui_max_text_width($size);
256 return "<input type=file name=\"".&quote_escape($name)."\" ".
257        "size=$size ".
258        ($dis ? "disabled=true" : "").
259        ($tags ? " ".$tags : "").">";
260 }
261
262 # ui_password(name, value, size, [disabled?], [maxlength])
263 # Returns HTML for a password text input
264 sub ui_password
265 {
266 return &theme_ui_password(@_) if (defined(&theme_ui_password));
267 local ($name, $value, $size, $dis, $max) = @_;
268 $size = &ui_max_text_width($size);
269 return "<input type=password name=\"".&quote_escape($name)."\" ".
270        "value=\"".&quote_escape($value)."\" ".
271        "size=$size ".($dis ? "disabled=true" : "").
272        ($max ? " maxlength=$max" : "").
273        ">";
274 }
275
276 # ui_hidden(name, value)
277 # Returns HTML for a hidden field
278 sub ui_hidden
279 {
280 return &theme_ui_hidden(@_) if (defined(&theme_ui_hidden));
281 local ($name, $value) = @_;
282 return "<input type=hidden name=\"".&quote_escape($name)."\" ".
283        "value=\"".&quote_escape($value)."\">\n";
284 }
285
286 # ui_select(name, value|&values, &options, [size], [multiple],
287 #           [add-if-missing], [disabled?], [javascript])
288 # Returns HTML for a drop-down menu or multiple selection list
289 sub ui_select
290 {
291 return &theme_ui_select(@_) if (defined(&theme_ui_select));
292 local ($name, $value, $opts, $size, $multiple, $missing, $dis, $js) = @_;
293 local $rv;
294 $rv .= "<select name=\"".&quote_escape($name)."\"".
295        ($size ? " size=$size" : "").
296        ($multiple ? " multiple" : "").
297        ($dis ? " disabled=true" : "")." ".$js.">\n";
298 local ($o, %opt, $s);
299 local %sel = ref($value) ? ( map { $_, 1 } @$value ) : ( $value, 1 );
300 foreach $o (@$opts) {
301         $o = [ $o ] if (!ref($o));
302         $rv .= "<option value=\"".&quote_escape($o->[0])."\"".
303                ($sel{$o->[0]} ? " selected" : "").">".
304                ($o->[1] || $o->[0])."\n";
305         $opt{$o->[0]}++;
306         }
307 foreach $s (keys %sel) {
308         if (!$opt{$s} && $missing) {
309                 $rv .= "<option value=\"".&quote_escape($s)."\"".
310                        "selected>".($s eq "" ? "&nbsp;" : $s)."\n";
311                 }
312         }
313 $rv .= "</select>\n";
314 return $rv;
315 }
316
317 # ui_radio(name, value, &options, [disabled?])
318 # Returns HTML for a series of radio buttons
319 sub ui_radio
320 {
321 return &theme_ui_radio(@_) if (defined(&theme_ui_radio));
322 local ($name, $value, $opts, $dis) = @_;
323 local $rv;
324 local $o;
325 foreach $o (@$opts) {
326         local $id = &quote_escape($name."_".$o->[0]);
327         local $label = $o->[1] || $o->[0];
328         local $after;
329         if ($label =~ /^(.*?)((<a\s+href|<input|<select|<textarea)[\000-\377]*)$/i) {
330                 $label = $1;
331                 $after = $2;
332                 }
333         $rv .= "<input type=radio name=\"".&quote_escape($name)."\" ".
334                "value=\"".&quote_escape($o->[0])."\"".
335                ($o->[0] eq $value ? " checked" : "").
336                ($dis ? " disabled=true" : "").
337                " id=\"$id\"".
338                " $o->[2]> <label for=\"$id\">".
339                $label."</label>".$after."\n";
340         }
341 return $rv;
342 }
343
344 # ui_yesno_radio(name, value, [yes], [no], [disabled?])
345 # Like ui_yesno, but always displays just two inputs (yes and no)
346 sub ui_yesno_radio
347 {
348 local ($name, $value, $yes, $no, $dis) = @_;
349 return &theme_ui_yesno_radio(@_) if (defined(&theme_ui_yesno_radio));
350 $yes = 1 if (!defined($yes));
351 $no = 0 if (!defined($no));
352 $value = int($value);
353 return &ui_radio($name, $value, [ [ $yes, $text{'yes'} ],
354                                   [ $no, $text{'no'} ] ], $dis);
355 }
356
357 # ui_checkbox(name, value, label, selected?, [tags], [disabled?])
358 # Returns HTML for a single checkbox
359 sub ui_checkbox
360 {
361 return &theme_ui_checkbox(@_) if (defined(&theme_ui_checkbox));
362 local ($name, $value, $label, $sel, $tags, $dis) = @_;
363 local $after;
364 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
365         $label = $1;
366         $after = $2;
367         }
368 return "<input type=checkbox name=\"".&quote_escape($name)."\" ".
369        "value=\"".&quote_escape($value)."\" ".
370        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
371        " id=\"".&quote_escape("${name}_${value}")."\"".
372        " $tags> ".
373        ($label eq "" ? $after :
374          "<label for=\"".&quote_escape("${name}_${value}").
375          "\">$label</label>$after")."\n";
376 }
377
378 # ui_oneradio(name, value, label, selected?, [tags], [disabled?])
379 # Returns HTML for a single radio button
380 sub ui_oneradio
381 {
382 return &theme_ui_oneradio(@_) if (defined(&theme_ui_oneradio));
383 local ($name, $value, $label, $sel, $tags, $dis) = @_;
384 local $id = &quote_escape("${name}_${value}");
385 local $after;
386 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
387         $label = $1;
388         $after = $2;
389         }
390 return "<input type=radio name=\"".&quote_escape($name)."\" ".
391        "value=\"".&quote_escape($value)."\" ".
392        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
393        " id=\"$id\"".
394        " $tags> <label for=\"$id\">$label</label>$after\n";
395 }
396
397 # ui_textarea(name, value, rows, cols, [wrap], [disabled?], [tags])
398 # Returns HTML for a multi-line text input
399 sub ui_textarea
400 {
401 return &theme_ui_textarea(@_) if (defined(&theme_ui_textarea));
402 local ($name, $value, $rows, $cols, $wrap, $dis, $tags) = @_;
403 $cols = &ui_max_text_width($cols, 1);
404 return "<textarea name=\"".&quote_escape($name)."\" ".
405        "rows=$rows cols=$cols".($wrap ? " wrap=$wrap" : "").
406        ($dis ? " disabled=true" : "").
407        ($tags ? " $tags" : "").">".
408        &html_escape($value).
409        "</textarea>";
410 }
411
412 # ui_user_textbox(name, value, [form], [disabled?])
413 # Returns HTML for a Unix user input
414 sub ui_user_textbox
415 {
416 return &theme_ui_user_textbox(@_) if (defined(&theme_ui_user_textbox));
417 return &ui_textbox($_[0], $_[1], 13, $_[3])." ".
418        &user_chooser_button($_[0], 0, $_[2]);
419 }
420
421 # ui_group_textbox(name, value, [form], [disabled?])
422 # Returns HTML for a Unix group input
423 sub ui_group_textbox
424 {
425 return &theme_ui_group_textbox(@_) if (defined(&theme_ui_group_textbox));
426 return &ui_textbox($_[0], $_[1], 13, $_[3])." ".
427        &group_chooser_button($_[0], 0, $_[2]);
428 }
429
430 # ui_opt_textbox(name, value, size, option1, [option2], [disabled?],
431 #                [&extra-fields], [max])
432 # Returns HTML for a text field that is optional
433 sub ui_opt_textbox
434 {
435 return &theme_ui_opt_textbox(@_) if (defined(&theme_ui_opt_textbox));
436 local ($name, $value, $size, $opt1, $opt2, $dis, $extra, $max) = @_;
437 local $dis1 = &js_disable_inputs([ $name, @$extra ], [ ]);
438 local $dis2 = &js_disable_inputs([ ], [ $name, @$extra ]);
439 local $rv;
440 $size = &ui_max_text_width($size);
441 $rv .= &ui_radio($name."_def", $value eq '' ? 1 : 0,
442                  [ [ 1, $opt1, "onClick='$dis1'" ],
443                    [ 0, $opt2 || " ", "onClick='$dis2'" ] ], $dis)."\n";
444 $rv .= "<input name=\"".&quote_escape($name)."\" ".
445        "size=$size value=\"".&quote_escape($value)."\" ".
446        ($value eq "" || $dis ? "disabled=true" : "").
447        ($max ? " maxlength=$max" : "").">\n";
448 return $rv;
449 }
450
451 # ui_submit(label, [name], [disabled?], [tags])
452 # Returns HTML for a form submit button
453 sub ui_submit
454 {
455 return &theme_ui_submit(@_) if (defined(&theme_ui_submit));
456 local ($label, $name, $dis, $tags) = @_;
457 return "<input type=submit".
458        ($name ne '' ? " name=\"".&quote_escape($name)."\"" : "").
459        " value=\"".&quote_escape($label)."\"".
460        ($dis ? " disabled=true" : "").
461        ($tags ? " ".$tags : "").">\n";
462                         
463 }
464
465 # ui_reset(label, [disabled?])
466 # Returns HTML for a form reset button
467 sub ui_reset
468 {
469 return &theme_ui_reset(@_) if (defined(&theme_ui_reset));
470 local ($label, $dis) = @_;
471 return "<input type=reset value=\"".&quote_escape($label)."\"".
472        ($dis ? " disabled=true" : "").">\n";
473                         
474 }
475
476 # ui_date_input(day, month, year, day-name, month-name, year-name, [disabled?])
477 # Returns HTML for a date-selection field
478 sub ui_date_input
479 {
480 local ($day, $month, $year, $dayname, $monthname, $yearname, $dis) = @_;
481 local $rv;
482 $rv .= &ui_textbox($dayname, $day, 3, $dis);
483 $rv .= "/";
484 $rv .= &ui_select($monthname, $month,
485                   [ map { [ $_, $text{"smonth_$_"} ] } (1 .. 12) ],
486                   1, 0, 0, $dis);
487 $rv .= "/";
488 $rv .= &ui_textbox($yearname, $year, 5, $dis);
489 return $rv;
490 }
491
492 # ui_table_row(label, value, [cols], [&td-tags])
493 # Returns HTML for a row in a table started by ui_table_start, with a 1-column
494 # label and 1+ column value.
495 sub ui_table_row
496 {
497 return &theme_ui_table_row(@_) if (defined(&theme_ui_table_row));
498 local ($label, $value, $cols, $tds) = @_;
499 $cols ||= 1;
500 $tds ||= $main::ui_table_default_tds;
501 local $rv;
502 if ($main::ui_table_pos+$cols+1 > $main::ui_table_cols) {
503         # If the requested number of cols won't fit in the number
504         # remaining, start a new row
505         $rv .= "</tr>\n";
506         $main::ui_table_pos = 0;
507         }
508 $rv .= "<tr>\n" if ($main::ui_table_pos%$main::ui_table_cols == 0);
509 $rv .= "<td valign=top $tds->[0]><b>$label</b></td>\n" if (defined($label));
510 $rv .= "<td valign=top colspan=$cols $tds->[1]>$value</td>\n";
511 $main::ui_table_pos += $cols+(defined($label) ? 1 : 0);
512 if ($main::ui_table_pos%$main::ui_table_cols == 0) {
513         $rv .= "</tr>\n";
514         $main::ui_table_pos = 0;
515         }
516 return $rv;
517 }
518
519 # ui_table_hr()
520 sub ui_table_hr
521 {
522 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
523 local $rv;
524 if ($ui_table_pos) {
525         $rv .= "</tr>\n";
526         $ui_table_pos = 0;
527         }
528 $rv .= "<tr> <td colspan=$main::ui_table_cols><hr></td> </tr>\n";
529 return $rv;
530 }
531
532 # ui_table_span(text)
533 # Outputs a table row that spans the whole table, and contains the given text
534 sub ui_table_span
535 {
536 local ($text) = @_;
537 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
538 local $rv;
539 if ($ui_table_pos) {
540         $rv .= "</tr>\n";
541         $ui_table_pos = 0;
542         }
543 $rv .= "<tr> <td colspan=$main::ui_table_cols>$text</td> </tr>\n";
544 return $rv;
545 }
546
547 # ui_buttons_start()
548 sub ui_buttons_start
549 {
550 return &theme_ui_buttons_start(@_) if (defined(&theme_ui_buttons_start));
551 return "<table width=100%>\n";
552 }
553
554 # ui_buttons_end()
555 sub ui_buttons_end
556 {
557 return &theme_ui_buttons_end(@_) if (defined(&theme_ui_buttons_end));
558 return "</table>\n";
559 }
560
561 # ui_buttons_row(script, button-label, description, [hiddens], [after-submit],
562 #                [before-submit]) 
563 sub ui_buttons_row
564 {
565 return &theme_ui_buttons_row(@_) if (defined(&theme_ui_buttons_row));
566 local ($script, $label, $desc, $hiddens, $after, $before) = @_;
567 return "<form action=$script>\n".
568        $hiddens.
569        "<tr> <td nowrap width=20% valign=top>".($before ? $before." " : "").
570        &ui_submit($label).($after ? " ".$after : "")."</td>\n".
571        "<td valign=top width=80% valign=top>$desc</td> </tr>\n".
572        "</form>\n";
573 }
574
575 # ui_buttons_hr([title])
576 sub ui_buttons_hr
577 {
578 local ($title) = @_;
579 return &theme_ui_buttons_hr(@_) if (defined(&theme_ui_buttons_hr));
580 if ($title) {
581         return "<tr> <td colspan=2><table cellpadding=0 cellspacing=0 width=100%><tr> <td width=50%><hr></td> <td nowrap>$title</td> <td width=50%><hr></td> </tr></table></td> </tr>\n";
582         }
583 else {
584         return "<tr> <td colspan=2><hr></td> </tr>\n";
585         }
586 }
587
588 ####################### header and footer functions
589
590 # ui_post_header([subtext])
591 # Returns HTML to appear directly after a standard header() call
592 sub ui_post_header
593 {
594 return &theme_ui_post_header(@_) if (defined(&theme_ui_post_header));
595 local ($text) = @_;
596 local $rv;
597 $rv .= "<center class='ui_post_header'><font size=+1>$text</font></center>\n" if (defined($text));
598 if (!$tconfig{'nohr'} && !$tconfig{'notophr'}) {
599         $rv .= "<hr id='post_header_hr'>\n";
600         }
601 return $rv;
602 }
603
604 # ui_pre_footer()
605 # Returns HTML to appear directly before a standard footer() call
606 sub ui_pre_footer
607 {
608 return &theme_ui_pre_footer(@_) if (defined(&theme_ui_pre_footer));
609 local $rv;
610 if (!$tconfig{'nohr'} && !$tconfig{'nobottomhr'}) {
611         $rv .= "<hr id='pre_footer_hr'>\n";
612         }
613 return $rv;
614 }
615
616 # ui_print_header(subtext, args...)
617 # Print HTML for a header with the post-header line. The args are the same
618 # as those passed to header()
619 sub ui_print_header
620 {
621 &load_theme_library();
622 return &theme_ui_print_header(@_) if (defined(&theme_ui_print_header));
623 local ($text, @args) = @_;
624 &header(@args);
625 print &ui_post_header($text);
626 }
627
628 # ui_print_unbuffered_header(subtext, args...)
629 # Like ui_print_header, but ensures that output for this page is not buffered
630 # or contained in a table.
631 sub ui_print_unbuffered_header
632 {
633 &load_theme_library();
634 return &theme_ui_print_unbuffered_header(@_) if (defined(&theme_ui_print_unbuffered_header));
635 $| = 1;
636 $theme_no_table = 1;
637 &ui_print_header(@_);
638 }
639
640 # ui_print_footer(args...)
641 # Print HTML for a footer with the pre-footer line. Args are the same as those
642 # passed to footer()
643 sub ui_print_footer
644 {
645 return &theme_ui_print_footer(@_) if (defined(&theme_ui_print_footer));
646 local @args = @_;
647 print &ui_pre_footer();
648 &footer(@args);
649 }
650
651 # ui_config_link(text, &subs)
652 # Returns HTML for a module config link. The first non-null sub will be
653 # replaced with the appropriate URL.
654 sub ui_config_link
655 {
656 return &theme_ui_config_link(@_) if (defined(&theme_ui_config_link));
657 local ($text, $subs) = @_;
658 local @subs = map { $_ || "../config.cgi?$module_name" }
659                   ($subs ? @$subs : ( undef ));
660 return "<p>".&text($text, @subs)."<p>\n";
661 }
662
663 # ui_print_endpage(text)
664 # Prints HTML for an error message followed by a page footer with a link to
665 # /, then exits. Good for main page error messages.
666 sub ui_print_endpage
667 {
668 return &theme_ui_print_endpage(@_) if (defined(&theme_ui_print_endpage));
669 local ($text) = @_;
670 print $text,"<p class='ui_footer'>\n";
671 print "</p>\n";
672 &ui_print_footer("/", $text{'index'});
673 exit;
674 }
675
676 # ui_subheading(text, ...)
677 # Returns HTML for a section heading
678 sub ui_subheading
679 {
680 return &theme_ui_subheading(@_) if (defined(&theme_ui_subheading));
681 return "<h3 class='ui_subheading'>".join("", @_)."</h3>\n";
682 }
683
684 # ui_links_row(&links)
685 # Returns HTML for a row of links, like select all / invert selection / add..
686 sub ui_links_row
687 {
688 return &theme_ui_links_row(@_) if (defined(&theme_ui_links_row));
689 local ($links) = @_;
690 return @$links ? join("\n|\n", @$links)."<br>\n"
691                : "";
692 }
693
694 ########################### collapsible section / tab functions
695
696 # ui_hidden_javascript()
697 # Returns <script> and <style> sections for hiding functions and CSS
698 sub ui_hidden_javascript
699 {
700 return &theme_ui_hidden_javascript(@_)
701         if (defined(&theme_ui_hidden_javascript));
702 local $rv;
703 local $imgdir = "$gconfig{'webprefix'}/images";
704 local ($jscb, $jstb) = ($cb, $tb);
705 $jscb =~ s/'/\\'/g;
706 $jstb =~ s/'/\\'/g;
707
708 return <<EOF;
709 <style>
710 .opener_shown {display:inline}
711 .opener_hidden {display:none}
712 </style>
713 <script>
714 // Open or close a hidden section
715 function hidden_opener(divid, openerid)
716 {
717 var divobj = document.getElementById(divid);
718 var openerobj = document.getElementById(openerid);
719 if (divobj.className == 'opener_shown') {
720   divobj.className = 'opener_hidden';
721   openerobj.innerHTML = '<img border=0 src=$imgdir/closed.gif>';
722   }
723 else {
724   divobj.className = 'opener_shown';
725   openerobj.innerHTML = '<img border=0 src=$imgdir/open.gif>';
726   }
727 }
728
729 // Show a tab
730 function select_tab(name, tabname, form)
731 {
732 var tabnames = document[name+'_tabnames'];
733 var tabtitles = document[name+'_tabtitles'];
734 for(var i=0; i<tabnames.length; i++) {
735   var tabobj = document.getElementById('tab_'+tabnames[i]);
736   var divobj = document.getElementById('div_'+tabnames[i]);
737   var title = tabtitles[i];
738   if (tabnames[i] == tabname) {
739     // Selected table
740     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
741                        '<td valign=top $jscb>'+
742                        '<img src=$imgdir/lc2.gif alt=""></td>'+
743                        '<td $jscb nowrap>'+
744                        '&nbsp;<b>'+title+'</b>&nbsp;</td>'+
745                        '<td valign=top $jscb>'+
746                        '<img src=$imgdir/rc2.gif alt=""></td>'+
747                        '</tr></table>';
748     divobj.className = 'opener_shown';
749     }
750   else {
751     // Non-selected tab
752     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
753                        '<td valign=top $jstb>'+
754                        '<img src=$imgdir/lc1.gif alt=""></td>'+
755                        '<td $jstb nowrap>'+
756                        '&nbsp;<a href=\\'\\' onClick=\\'return select_tab("'+
757                        name+'", "'+tabnames[i]+'")\\'>'+title+'</a>&nbsp;</td>'+
758                        '<td valign=top $jstb>'+
759                        '<img src=$imgdir/rc1.gif alt=""></td>'+
760                        '</tr></table>';
761     divobj.className = 'opener_hidden';
762     }
763   }
764 if (document.forms[0] && document.forms[0][name]) {
765   document.forms[0][name].value = tabname;
766   }
767 return false;
768 }
769 </script>
770 EOF
771 }
772
773 # ui_hidden_start(title, name, status, thisurl)
774 # Returns HTML for the start of a collapsible hidden section, such as for
775 # advanced options.
776 sub ui_hidden_start
777 {
778 return &theme_ui_hidden_start(@_) if (defined(&theme_ui_hidden_start));
779 local ($title, $name, $status, $url) = @_;
780 local $rv;
781 if (!$main::ui_hidden_start_donejs++) {
782         $rv .= &ui_hidden_javascript();
783         }
784 local $divid = "hiddendiv_$name";
785 local $openerid = "hiddenopener_$name";
786 local $defimg = $status ? "open.gif" : "closed.gif";
787 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
788 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a>\n";
789 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
790 $rv .= "<div class='$defclass' id='$divid'>\n";
791 return $rv;
792 }
793
794 # ui_hidden_end(name)
795 # Returns HTML for the end of a hidden section
796 sub ui_hidden_end
797 {
798 return &theme_ui_hidden_end(@_) if (defined(&theme_ui_hidden_end));
799 local ($name) = @_;
800 return "</div>\n";
801 }
802
803 # ui_hidden_table_start(heading, [tabletags], [cols], name, status,
804 #                       [&default-tds])
805 # A table with a heading and table inside, and which is collapsible
806 sub ui_hidden_table_start
807 {
808 return &theme_ui_hidden_table_start(@_)
809         if (defined(&theme_ui_hidden_table_start));
810 local ($heading, $tabletags, $cols, $name, $status, $tds) = @_;
811 local $rv;
812 if (!$main::ui_hidden_start_donejs++) {
813         $rv .= &ui_hidden_javascript();
814         }
815 local $divid = "hiddendiv_$name";
816 local $openerid = "hiddenopener_$name";
817 local $defimg = $status ? "open.gif" : "closed.gif";
818 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
819 local $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} : 
820               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
821 $rv .= "<table class='ui_table' border $tabletags class='ui_table'>\n";
822 $rv .= "<tr $tb> <td><a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a> <a href=\"javascript:hidden_opener('$divid', '$openerid')\"><b><font color=#$text>$heading</font></b></a></td> </tr>\n" if (defined($heading));
823 $rv .= "<tr $cb> <td><div class='$defclass' id='$divid'><table width=100%>\n";
824 $main::ui_table_cols = $cols || 4;
825 $main::ui_table_pos = 0;
826 $main::ui_table_default_tds = $tds;
827 return $rv;
828 }
829
830 # ui_hidden_table_end(name)
831 # Returns HTML for the end of table with hiding, as started by
832 # ui_hidden_table_start
833 sub ui_hidden_table_end
834 {
835 local ($name) = @_;
836 return &theme_ui_hidden_table_end(@_) if (defined(&theme_ui_hidden_table_end));
837 return "</table></div></td></tr></table>\n";
838 }
839
840 # ui_tabs_start(&tabs, name, selected, show-border)
841 # Render a row of tabs from which one can be selected. Each tab is an array
842 # ref containing a name, title and link.
843 sub ui_tabs_start
844 {
845 return &theme_ui_tabs_start(@_) if (defined(&theme_ui_tabs_start));
846 local ($tabs, $name, $sel, $border) = @_;
847 local $rv;
848 if (!$main::ui_hidden_start_donejs++) {
849         $rv .= &ui_hidden_javascript();
850         }
851
852 # Build list of tab titles and names
853 local $tabnames = "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$tabs)."]";
854 local $tabtitles = "[".join(",", map { "\"".&html_escape($_->[1])."\"" } @$tabs)."]";
855 $rv .= "<script>\n";
856 $rv .= "document.${name}_tabnames = $tabnames;\n";
857 $rv .= "document.${name}_tabtitles = $tabtitles;\n";
858 $rv .= "</script>\n";
859
860 # Output the tabs
861 local $imgdir = "$gconfig{'webprefix'}/images";
862 $rv .= &ui_hidden($name, $sel)."\n";
863 $rv .= "<table border=0 cellpadding=0 cellspacing=0>\n";
864 $rv .= "<tr><td bgcolor=#ffffff colspan=".(scalar(@$tabs)*2+1).">";
865 if ($ENV{'HTTP_USER_AGENT'} !~ /msie/i) {
866         # For some reason, the 1-pixel space above the tabs appears huge on IE!
867         $rv .= "<img src=$imgdir/1x1.gif>";
868         }
869 $rv .= "</td></tr>\n";
870 $rv .= "<tr>\n";
871 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
872 foreach my $t (@$tabs) {
873         if ($t ne $tabs[0]) {
874                 # Spacer
875                 $rv .= "<td width=2 bgcolor=#ffffff>".
876                        "<img src=$imgdir/1x1.gif></td>\n";
877                 }
878         local $tabid = "tab_".$t->[0];
879         $rv .= "<td id=${tabid}>";
880         $rv .= "<table cellpadding=0 cellspacing=0 border=0><tr>";
881         if ($t->[0] eq $sel) {
882                 # Selected tab
883                 $rv .= "<td valign=top $cb>".
884                        "<img src=$imgdir/lc2.gif alt=\"\"></td>";
885                 $rv .= "<td $cb nowrap>".
886                        "&nbsp;<b>$t->[1]</b>&nbsp;</td>";
887                 $rv .= "<td valign=top $cb>".
888                        "<img src=$imgdir/rc2.gif alt=\"\"></td>";
889                 }
890         else {
891                 # Other tab (which has a link)
892                 $rv .= "<td valign=top $tb>".
893                        "<img src=$imgdir/lc1.gif alt=\"\"></td>";
894                 $rv .= "<td $tb nowrap>".
895                        "&nbsp;<a href='$t->[2]' ".
896                        "onClick='return select_tab(\"$name\", \"$t->[0]\")'>".
897                        "$t->[1]</a>&nbsp;</td>";
898                 $rv .= "<td valign=top $tb>".
899                        "<img src=$imgdir/rc1.gif ".
900                        "alt=\"\"></td>";
901                 $rv .= "</td>\n";
902                 }
903         $rv .= "</tr></table>";
904         $rv .= "</td>\n";
905         }
906 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
907 $rv .= "</table>\n";
908
909 if ($border) {
910         # All tabs are within a grey box
911         $rv .= "<table width=100% cellpadding=0 cellspacing=0 border=0>\n";
912         $rv .= "<tr> <td bgcolor=#ffffff rowspan=3 width=1><img src=$imgdir/1x1.gif></td>\n";
913         $rv .= "<td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
914         $rv .= "<tr> <td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
915         $rv .= "<td valign=top>";
916         }
917 $main::ui_tabs_selected = $sel;
918 return $rv;
919 }
920
921 # ui_tabs_end(border)
922 sub ui_tabs_end
923 {
924 return &theme_ui_tabs_end(@_) if (defined(&theme_ui_tabs_end));
925 local ($border) = @_;
926 local $rv;
927 local $imgdir = "$gconfig{'webprefix'}/images";
928 if ($border) {
929         $rv .= "</td>\n";
930         $rv .= "<td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
931         $rv .= "</tr>\n";
932         $rv .= "<tr> <td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
933         $rv .= "</table>\n";
934         }
935 return $rv;
936 }
937
938 # ui_tabs_start_tab(name, tab)
939 # Must be called before outputting the HTML for the named tab
940 sub ui_tabs_start_tab
941 {
942 return &theme_ui_tabs_start_tab(@_) if (defined(&theme_ui_tabs_start_tab));
943 local ($name, $tab) = @_;
944 local $defclass = $tab eq $main::ui_tabs_selected ?
945                         'opener_shown' : 'opener_hidden';
946 local $rv = "<div id='div_$tab' class='$defclass'>\n";
947 return $rv;
948 }
949
950 # ui_tabs_start_tabletab(name, tab)
951 # Behaves like ui_tabs_start_tab, but for use within a ui_table_start block
952 sub ui_tabs_start_tabletab
953 {
954 return &theme_ui_tabs_start_tabletab(@_)
955         if (defined(&theme_ui_tabs_start_tabletab));
956 local $div = &ui_tabs_start_tab(@_);
957 return "</table>\n".$div."<table width=100%>\n";
958 }
959
960 sub ui_tabs_end_tab
961 {
962 return &theme_ui_tabs_end_tab(@_) if (defined(&theme_ui_tabs_end_tab));
963 return "</div>\n";
964 }
965
966 sub ui_tabs_end_tabletab
967 {
968 return &theme_ui_tabs_end_tabletab(@_)
969         if (defined(&theme_ui_tabs_end_tabletab));
970 return "</table></div><table width=100%>\n";
971 }
972
973 # ui_max_text_width(width, [text-area?])
974 # Returns a new width for a text field, based on theme settings
975 sub ui_max_text_width
976 {
977 local ($w, $ta) = @_;
978 local $max = $ta ? $tconfig{'maxareawidth'} : $tconfig{'maxboxwidth'};
979 return $max && $w > $max ? $max : $w;
980 }
981
982 ####################### radio hidden functions
983
984 # ui_radio_selector(&opts, name, selected)
985 # Returns HTML for a set of radio buttons, each of which shows a different
986 # block of HTML when selected. &opts is an array ref to arrays containing
987 # [ value, label, html ]
988 sub ui_radio_selector
989 {
990 return &theme_ui_radio_selector(@_) if (defined(&theme_ui_radio_selector));
991 local ($opts, $name, $sel) = @_;
992 local $rv;
993 if (!$main::ui_radio_selector_donejs++) {
994         $rv .= &ui_radio_selector_javascript();
995         }
996 local $optnames =
997         "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$opts)."]";
998 foreach my $o (@opts) {
999         $rv .= &ui_oneradio($name, $o->[0], $o->[1], $sel eq $o->[0],
1000             "onClick='selector_show(\"$name\", \"$o->[0]\", $optnames)'");
1001         }
1002 $rv .= "<br>\n";
1003 foreach my $o (@opts) {
1004         local $cls = $o->[0] eq $sel ? "selector_shown" : "selector_hidden";
1005         $rv .= "<div id=sel_${name}_$o->[0] class=$cls>".$o->[2]."</div>\n";
1006         }
1007 return $rv;
1008 }
1009
1010 sub ui_radio_selector_javascript
1011 {
1012 return <<EOF;
1013 <style>
1014 .selector_shown {display:inline}
1015 .selector_hidden {display:none}
1016 </style>
1017 <script>
1018 function selector_show(name, value, values)
1019 {
1020 for(var i=0; i<values.length; i++) {
1021         var divobj = document.getElementById('sel_'+name+'_'+values[i]);
1022         divobj.className = value == values[i] ? 'selector_shown'
1023                                               : 'selector_hidden';
1024         }
1025 }
1026 </script>
1027 EOF
1028 }
1029
1030 ####################### grid layout functions
1031
1032 # ui_grid_table(&elements, columns, [width-percent], [tds], [tabletags])
1033 # Given a list of HTML elements, formats them into a table with the given
1034 # number of columns. However, themes are free to override this to use fewer
1035 # columns where space is limited.
1036 sub ui_grid_table
1037 {
1038 return &theme_ui_grid_table(@_) if (defined(&theme_ui_grid_table));
1039 local ($elements, $cols, $width, $tds, $tabletags) = @_;
1040 return "" if (!@$elements);
1041 local $rv = "<table".
1042             ($width ? " width=$width%" : "").
1043             ($tabletags ? " ".$tabletags : "").
1044             ">\n";
1045 for(my $i=0; $i<@$elements; $i++) {
1046         $rv .= "<tr>" if ($i%$cols == 0);
1047         $rv .= "<td ".$tds->[$i%$cols]." valign=top>".$elements->[$i]."</td>\n";
1048         $rv .= "</tr>" if ($i%$cols == $cols-1);
1049         }
1050 if ($i%$cols) {
1051         while($i%$cols) {
1052                 $rv .= "<td ".$tds->[$i%$cols]."><br></td>\n";
1053                 $i++;
1054                 }
1055         $rv .= "</tr>\n";
1056         }
1057 $rv .= "</table>\n";
1058 return $rv;
1059 }
1060
1061 # ui_radio_table(name, selected, &rows)
1062 # Returns HTML for a table of radio buttons, each of which has a label and
1063 # some associated inputs to the right.
1064 sub ui_radio_table
1065 {
1066 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
1067 local ($name, $sel, $rows) = @_;
1068 return "" if (!@$rows);
1069 local $rv = "<table>\n";
1070 foreach my $r (@$rows) {
1071         $rv .= "<tr>\n";
1072         $rv .= "<td valign=top>".&ui_oneradio($name, $r->[0], "<b>$r->[1]</b>",
1073                                    $r->[0] eq $sel)."</td>\n";
1074         $rv .= "<td valign=top>".$r->[2]."</td>\n";
1075         $rv .= "</tr>\n";
1076         }
1077 $rv .= "</table>\n";
1078 return $rv;
1079 }
1080
1081 ####################### javascript functions
1082
1083 # js_disable_input(&disable-inputs, &enable-inputs, [tag])
1084 # Returns Javascript to disable some form elements and enable others
1085 sub js_disable_inputs
1086 {
1087 local $rv;
1088 local $f;
1089 foreach $f (@{$_[0]}) {
1090         $rv .= "e = form.elements[\"$f\"]; e.disabled = true; ";
1091         $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = true; } ";
1092         }
1093 foreach $f (@{$_[1]}) {
1094         $rv .= "e = form.elements[\"$f\"]; e.disabled = false; ";
1095         $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = false; } ";
1096         }
1097 foreach $f (@{$_[1]}) {
1098         if ($f =~ /^(.*)_def$/ && &indexof($1, @{$_[1]}) >= 0) {
1099                 # When enabling both a _def field and its associated text field,
1100                 # disable the text if the _def is set to 1
1101                 local $tf = $1;
1102                 $rv .= "e = form.elements[\"$f\"]; for(i=0; i<e.length; i++) { if (e[i].checked && e[i].value == \"1\") { form.elements[\"$tf\"].disabled = true } } ";
1103                 }
1104         }
1105 return $_[2] ? "$_[2]='$rv'" : $rv;
1106 }
1107
1108 # js_checkbox_disable(name, &checked-disable, &checked-enable, [tag])
1109 sub js_checkbox_disable
1110 {
1111 local $rv;
1112 local $f;
1113 foreach $f (@{$_[1]}) {
1114         $rv .= "form.elements[\"$f\"].disabled = $_[0].checked; ";
1115         }
1116 foreach $f (@{$_[2]}) {
1117         $rv .= "form.elements[\"$f\"].disabled = !$_[0].checked; ";
1118         }
1119 return $_[3] ? "$_[3]='$rv'" : $rv;
1120 }
1121
1122 1;
1123