Initial checkin of Webmin
[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] eq "" ? "<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] eq "" ? "<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)
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) = @_;
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, "", 0)."</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]).
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 =~ /^([^<]*)(<[\000-\377]*)$/) {
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_radio_table(name, value, &options, [disabled?])
345 # Returns HTML for a series of radio buttons, one per line in a table
346 sub ui_radio_table
347 {
348 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
349 local ($name, $value, $opts, $dis) = @_;
350 local $rv = "<table>";
351 local $o;
352 foreach $o (@$opts) {
353         local $id = &quote_escape($name."_".$o->[0]);
354         local $label = $o->[1] || $o->[0];
355         local $after;
356         if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
357                 $label = $1;
358                 $after = $2;
359                 }
360         $rv .= "<tr> <td>";
361         $rv .= "<input type=radio name=\"".&quote_escape($name)."\" ".
362                "value=\"".&quote_escape($o->[0])."\"".
363                ($o->[0] eq $value ? " checked" : "").
364                ($dis ? " disabled=true" : "").
365                " id=\"$id\"".
366                " $o->[3]> <label for=\"$id\">".
367                $label."</label>".$after."</td>\n";
368         $rv .= "<td>$o->[2]</td>\n";
369         $rv .= "</tr>\n";
370         }
371 $rv .= "</table>\n";
372 return $rv;
373 }
374
375 # ui_yesno_radio(name, value, [yes], [no], [disabled?])
376 # Like ui_yesno, but always displays just two inputs (yes and no)
377 sub ui_yesno_radio
378 {
379 local ($name, $value, $yes, $no, $dis) = @_;
380 return &theme_ui_yesno_radio(@_) if (defined(&theme_ui_yesno_radio));
381 $yes = 1 if (!defined($yes));
382 $no = 0 if (!defined($no));
383 $value = int($value);
384 return &ui_radio($name, $value, [ [ $yes, $text{'yes'} ],
385                                   [ $no, $text{'no'} ] ], $dis);
386 }
387
388 # ui_checkbox(name, value, label, selected?, [tags], [disabled?])
389 # Returns HTML for a single checkbox
390 sub ui_checkbox
391 {
392 return &theme_ui_checkbox(@_) if (defined(&theme_ui_checkbox));
393 local ($name, $value, $label, $sel, $tags, $dis) = @_;
394 local $after;
395 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
396         $label = $1;
397         $after = $2;
398         }
399 return "<input type=checkbox name=\"".&quote_escape($name)."\" ".
400        "value=\"".&quote_escape($value)."\" ".
401        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
402        " id=\"".&quote_escape("${name}_${value}")."\"".
403        " $tags> ".
404        ($label eq "" ? $after :
405          "<label for=\"".&quote_escape("${name}_${value}").
406          "\">$label</label>$after")."\n";
407 }
408
409 # ui_oneradio(name, value, label, selected?, [tags], [disabled?])
410 # Returns HTML for a single radio button
411 sub ui_oneradio
412 {
413 return &theme_ui_oneradio(@_) if (defined(&theme_ui_oneradio));
414 local ($name, $value, $label, $sel, $tags, $dis) = @_;
415 local $id = &quote_escape("${name}_${value}");
416 local $after;
417 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
418         $label = $1;
419         $after = $2;
420         }
421 return "<input type=radio name=\"".&quote_escape($name)."\" ".
422        "value=\"".&quote_escape($value)."\" ".
423        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
424        " id=\"$id\"".
425        " $tags> <label for=\"$id\">$label</label>$after\n";
426 }
427
428 # ui_textarea(name, value, rows, cols, [wrap], [disabled?], [tags])
429 # Returns HTML for a multi-line text input
430 sub ui_textarea
431 {
432 return &theme_ui_textarea(@_) if (defined(&theme_ui_textarea));
433 local ($name, $value, $rows, $cols, $wrap, $dis, $tags) = @_;
434 $cols = &ui_max_text_width($cols, 1);
435 return "<textarea name=\"".&quote_escape($name)."\" ".
436        "rows=$rows cols=$cols".($wrap ? " wrap=$wrap" : "").
437        ($dis ? " disabled=true" : "").
438        ($tags ? " $tags" : "").">".
439        &html_escape($value).
440        "</textarea>";
441 }
442
443 # ui_user_textbox(name, value, [form], [disabled?])
444 # Returns HTML for a Unix user input
445 sub ui_user_textbox
446 {
447 return &theme_ui_user_textbox(@_) if (defined(&theme_ui_user_textbox));
448 return &ui_textbox($_[0], $_[1], 13, $_[3])." ".
449        &user_chooser_button($_[0], 0, $_[2]);
450 }
451
452 # ui_group_textbox(name, value, [form], [disabled?])
453 # Returns HTML for a Unix group input
454 sub ui_group_textbox
455 {
456 return &theme_ui_group_textbox(@_) if (defined(&theme_ui_group_textbox));
457 return &ui_textbox($_[0], $_[1], 13, $_[3])." ".
458        &group_chooser_button($_[0], 0, $_[2]);
459 }
460
461 # ui_opt_textbox(name, value, size, option1, [option2], [disabled?],
462 #                [&extra-fields], [max])
463 # Returns HTML for a text field that is optional
464 sub ui_opt_textbox
465 {
466 return &theme_ui_opt_textbox(@_) if (defined(&theme_ui_opt_textbox));
467 local ($name, $value, $size, $opt1, $opt2, $dis, $extra, $max) = @_;
468 local $dis1 = &js_disable_inputs([ $name, @$extra ], [ ]);
469 local $dis2 = &js_disable_inputs([ ], [ $name, @$extra ]);
470 local $rv;
471 $size = &ui_max_text_width($size);
472 $rv .= &ui_radio($name."_def", $value eq '' ? 1 : 0,
473                  [ [ 1, $opt1, "onClick='$dis1'" ],
474                    [ 0, $opt2 || " ", "onClick='$dis2'" ] ], $dis)."\n";
475 $rv .= "<input name=\"".&quote_escape($name)."\" ".
476        "size=$size value=\"".&quote_escape($value)."\" ".
477        ($value eq "" || $dis ? "disabled=true" : "").
478        ($max ? " maxlength=$max" : "").">\n";
479 return $rv;
480 }
481
482 # ui_submit(label, [name], [disabled?])
483 # Returns HTML for a form submit button
484 sub ui_submit
485 {
486 return &theme_ui_submit(@_) if (defined(&theme_ui_submit));
487 local ($label, $name, $dis) = @_;
488 return "<input type=submit".
489        ($name ne '' ? " name=\"".&quote_escape($name)."\"" : "").
490        " value=\"".&quote_escape($label)."\"".
491        ($dis ? " disabled=true" : "").">\n";
492                         
493 }
494
495 # ui_reset(label, [disabled?])
496 # Returns HTML for a form reset button
497 sub ui_reset
498 {
499 return &theme_ui_reset(@_) if (defined(&theme_ui_reset));
500 local ($label, $dis) = @_;
501 return "<input type=submit value=\"".&quote_escape($label).
502        ($dis ? " disabled=true" : "")."\">\n";
503                         
504 }
505
506 # ui_date_input(day, month, year, day-name, month-name, year-name, [disabled?])
507 # Returns HTML for a date-selection field
508 sub ui_date_input
509 {
510 local ($day, $month, $year, $dayname, $monthname, $yearname, $dis) = @_;
511 local $rv;
512 $rv .= &ui_textbox($dayname, $day, 3, $dis);
513 $rv .= "/";
514 $rv .= &ui_select($monthname, $month,
515                   [ map { [ $_, $text{"smonth_$_"} ] } (1 .. 12) ],
516                   1, 0, 0, $dis);
517 $rv .= "/";
518 $rv .= &ui_textbox($yearname, $year, 5, $dis);
519 return $rv;
520 }
521
522 # ui_table_row(label, value, [cols], [&td-tags])
523 # Returns HTML for a row in a table started by ui_table_start, with a 1-column
524 # label and 1+ column value.
525 sub ui_table_row
526 {
527 return &theme_ui_table_row(@_) if (defined(&theme_ui_table_row));
528 local ($label, $value, $cols, $tds) = @_;
529 $cols ||= 1;
530 $tds ||= $main::ui_table_default_tds;
531 local $rv;
532 if ($main::ui_table_pos+$cols+1 > $main::ui_table_cols) {
533         # If the requested number of cols won't fit in the number
534         # remaining, start a new row
535         $rv .= "</tr>\n";
536         $main::ui_table_pos = 0;
537         }
538 $rv .= "<tr>\n" if ($main::ui_table_pos%$main::ui_table_cols == 0);
539 $rv .= "<td valign=top $tds->[0]><b>$label</b></td>\n" if (defined($label));
540 $rv .= "<td valign=top colspan=$cols $tds->[1]>$value</td>\n";
541 $main::ui_table_pos += $cols+(defined($label) ? 1 : 0);
542 if ($main::ui_table_pos%$main::ui_table_cols == 0) {
543         $rv .= "</tr>\n";
544         $main::ui_table_pos = 0;
545         }
546 return $rv;
547 }
548
549 # ui_table_hr()
550 sub ui_table_hr
551 {
552 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
553 local $rv;
554 if ($ui_table_pos) {
555         $rv .= "</tr>\n";
556         $ui_table_pos = 0;
557         }
558 $rv .= "<tr> <td colspan=$main::ui_table_cols><hr></td> </tr>\n";
559 return $rv;
560 }
561
562 # ui_table_span(text)
563 # Outputs a table row that spans the whole table, and contains the given text
564 sub ui_table_span
565 {
566 local ($text) = @_;
567 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
568 local $rv;
569 if ($ui_table_pos) {
570         $rv .= "</tr>\n";
571         $ui_table_pos = 0;
572         }
573 $rv .= "<tr> <td colspan=$main::ui_table_cols>$text</td> </tr>\n";
574 return $rv;
575 }
576
577 # ui_buttons_start()
578 sub ui_buttons_start
579 {
580 return &theme_ui_buttons_start(@_) if (defined(&theme_ui_buttons_start));
581 return "<table width=100%>\n";
582 }
583
584 # ui_buttons_end()
585 sub ui_buttons_end
586 {
587 return &theme_ui_buttons_end(@_) if (defined(&theme_ui_buttons_end));
588 return "</table>\n";
589 }
590
591 # ui_buttons_row(script, button-label, description, [hiddens], [after-submit],
592 #                [before-submit]) 
593 sub ui_buttons_row
594 {
595 return &theme_ui_buttons_row(@_) if (defined(&theme_ui_buttons_row));
596 local ($script, $label, $desc, $hiddens, $after, $before) = @_;
597 return "<form action=$script>\n".
598        $hiddens.
599        "<tr> <td nowrap width=20% valign=top>".($before ? $before." " : "").
600        &ui_submit($label).($after ? " ".$after : "")."</td>\n".
601        "<td valign=top width=80% valign=top>$desc</td> </tr>\n".
602        "</form>\n";
603 }
604
605 # ui_buttons_hr([title])
606 sub ui_buttons_hr
607 {
608 local ($title) = @_;
609 return &theme_ui_buttons_hr(@_) if (defined(&theme_ui_buttons_hr));
610 if ($title) {
611         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";
612         }
613 else {
614         return "<tr> <td colspan=2><hr></td> </tr>\n";
615         }
616 }
617
618 ####################### header and footer functions
619
620 # ui_post_header([subtext])
621 # Returns HTML to appear directly after a standard header() call
622 sub ui_post_header
623 {
624 return &theme_ui_post_header(@_) if (defined(&theme_ui_post_header));
625 local ($text) = @_;
626 local $rv;
627 $rv .= "<center class='ui_post_header'><font size=+1>$text</font></center>\n" if (defined($text));
628 if (!$tconfig{'nohr'} && !$tconfig{'notophr'}) {
629         $rv .= "<hr id='post_header_hr'>\n";
630         }
631 return $rv;
632 }
633
634 # ui_pre_footer()
635 # Returns HTML to appear directly before a standard footer() call
636 sub ui_pre_footer
637 {
638 return &theme_ui_pre_footer(@_) if (defined(&theme_ui_pre_footer));
639 local $rv;
640 if (!$tconfig{'nohr'} && !$tconfig{'nobottomhr'}) {
641         $rv .= "<hr id='pre_footer_hr'>\n";
642         }
643 return $rv;
644 }
645
646 # ui_print_header(subtext, args...)
647 # Print HTML for a header with the post-header line. The args are the same
648 # as those passed to header()
649 sub ui_print_header
650 {
651 &load_theme_library();
652 return &theme_ui_print_header(@_) if (defined(&theme_ui_print_header));
653 local ($text, @args) = @_;
654 &header(@args);
655 print &ui_post_header($text);
656 }
657
658 # ui_print_unbuffered_header(subtext, args...)
659 # Like ui_print_header, but ensures that output for this page is not buffered
660 # or contained in a table.
661 sub ui_print_unbuffered_header
662 {
663 &load_theme_library();
664 return &theme_ui_print_unbuffered_header(@_) if (defined(&theme_ui_print_unbuffered_header));
665 $| = 1;
666 $theme_no_table = 1;
667 &ui_print_header(@_);
668 }
669
670 # ui_print_footer(args...)
671 # Print HTML for a footer with the pre-footer line. Args are the same as those
672 # passed to footer()
673 sub ui_print_footer
674 {
675 return &theme_ui_print_footer(@_) if (defined(&theme_ui_print_footer));
676 local @args = @_;
677 print &ui_pre_footer();
678 &footer(@args);
679 }
680
681 # ui_config_link(text, &subs)
682 # Returns HTML for a module config link. The first non-null sub will be
683 # replaced with the appropriate URL.
684 sub ui_config_link
685 {
686 return &theme_ui_config_link(@_) if (defined(&theme_ui_config_link));
687 local ($text, $subs) = @_;
688 local @subs = map { $_ || "../config.cgi?$module_name" }
689                   ($subs ? @$subs : ( undef ));
690 return "<p>".&text($text, @subs)."<p>\n";
691 }
692
693 # ui_print_endpage(text)
694 # Prints HTML for an error message followed by a page footer with a link to
695 # /, then exits. Good for main page error messages.
696 sub ui_print_endpage
697 {
698 return &theme_ui_print_endpage(@_) if (defined(&theme_ui_print_endpage));
699 local ($text) = @_;
700 print $text,"<p class='ui_footer'>\n";
701 print "</p>\n";
702 &ui_print_footer("/", $text{'index'});
703 exit;
704 }
705
706 # ui_subheading(text, ...)
707 # Returns HTML for a section heading
708 sub ui_subheading
709 {
710 return &theme_ui_subheading(@_) if (defined(&theme_ui_subheading));
711 return "<h3 class='ui_subheading'>".join("", @_)."</h3>\n";
712 }
713
714 # ui_links_row(&links)
715 # Returns HTML for a row of links, like select all / invert selection / add..
716 sub ui_links_row
717 {
718 return &theme_ui_links_row(@_) if (defined(&theme_ui_links_row));
719 local ($links) = @_;
720 return @$links ? join("\n|\n", @$links)."<br>\n"
721                : "";
722 }
723
724 ########################### collapsible section / tab functions
725
726 # ui_hidden_javascript()
727 # Returns <script> and <style> sections for hiding functions and CSS
728 sub ui_hidden_javascript
729 {
730 return &theme_ui_hidden_javascript(@_)
731         if (defined(&theme_ui_hidden_javascript));
732 local $rv;
733 local $imgdir = "$gconfig{'webprefix'}/images";
734 local ($jscb, $jstb) = ($cb, $tb);
735 $jscb =~ s/'/\\'/g;
736 $jstb =~ s/'/\\'/g;
737
738 return <<EOF;
739 <style>
740 .opener_shown {display:inline}
741 .opener_hidden {display:none}
742 </style>
743 <script>
744 // Open or close a hidden section
745 function hidden_opener(divid, openerid)
746 {
747 var divobj = document.getElementById(divid);
748 var openerobj = document.getElementById(openerid);
749 if (divobj.className == 'opener_shown') {
750   divobj.className = 'opener_hidden';
751   openerobj.innerHTML = '<img border=0 src=$imgdir/closed.gif>';
752   }
753 else {
754   divobj.className = 'opener_shown';
755   openerobj.innerHTML = '<img border=0 src=$imgdir/open.gif>';
756   }
757 }
758
759 // Show a tab
760 function select_tab(name, tabname, form)
761 {
762 var tabnames = document[name+'_tabnames'];
763 var tabtitles = document[name+'_tabtitles'];
764 for(var i=0; i<tabnames.length; i++) {
765   var tabobj = document.getElementById('tab_'+tabnames[i]);
766   var divobj = document.getElementById('div_'+tabnames[i]);
767   var title = tabtitles[i];
768   if (tabnames[i] == tabname) {
769     // Selected table
770     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
771                        '<td valign=top $jscb>'+
772                        '<img src=$imgdir/lc2.gif alt=""></td>'+
773                        '<td $jscb nowrap>'+
774                        '&nbsp;<b>'+title+'</b>&nbsp;</td>'+
775                        '<td valign=top $jscb>'+
776                        '<img src=$imgdir/rc2.gif alt=""></td>'+
777                        '</tr></table>';
778     divobj.className = 'opener_shown';
779     }
780   else {
781     // Non-selected tab
782     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
783                        '<td valign=top $jstb>'+
784                        '<img src=$imgdir/lc1.gif alt=""></td>'+
785                        '<td $jstb nowrap>'+
786                        '&nbsp;<a href=\\'\\' onClick=\\'return select_tab("'+
787                        name+'", "'+tabnames[i]+'")\\'>'+title+'</a>&nbsp;</td>'+
788                        '<td valign=top $jstb>'+
789                        '<img src=$imgdir/rc1.gif alt=""></td>'+
790                        '</tr></table>';
791     divobj.className = 'opener_hidden';
792     }
793   }
794 if (document.forms[0] && document.forms[0][name]) {
795   document.forms[0][name].value = tabname;
796   }
797 return false;
798 }
799 </script>
800 EOF
801 }
802
803 # ui_hidden_start(title, name, status, thisurl)
804 # Returns HTML for the start of a collapsible hidden section, such as for
805 # advanced options.
806 sub ui_hidden_start
807 {
808 return &theme_ui_hidden_start(@_) if (defined(&theme_ui_hidden_start));
809 local ($title, $name, $status, $url) = @_;
810 local $rv;
811 if (!$main::ui_hidden_start_donejs++) {
812         $rv .= &ui_hidden_javascript();
813         }
814 local $divid = "hiddendiv_$name";
815 local $openerid = "hiddenopener_$name";
816 local $defimg = $status ? "open.gif" : "closed.gif";
817 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
818 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a>\n";
819 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
820 $rv .= "<div class='$defclass' id='$divid'>\n";
821 return $rv;
822 }
823
824 # ui_hidden_end(name)
825 # Returns HTML for the end of a hidden section
826 sub ui_hidden_end
827 {
828 return &theme_ui_hidden_end(@_) if (defined(&theme_ui_hidden_end));
829 local ($name) = @_;
830 return "</div>\n";
831 }
832
833 # ui_hidden_table_start(heading, [tabletags], [cols], name, status,
834 #                       [&default-tds])
835 # A table with a heading and table inside, and which is collapsible
836 sub ui_hidden_table_start
837 {
838 return &theme_ui_hidden_table_start(@_)
839         if (defined(&theme_ui_hidden_table_start));
840 local ($heading, $tabletags, $cols, $name, $status, $tds) = @_;
841 local $rv;
842 if (!$main::ui_hidden_start_donejs++) {
843         $rv .= &ui_hidden_javascript();
844         }
845 local $divid = "hiddendiv_$name";
846 local $openerid = "hiddenopener_$name";
847 local $defimg = $status ? "open.gif" : "closed.gif";
848 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
849 local $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} : 
850               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
851 $rv .= "<table border $tabletags>\n";
852 $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));
853 $rv .= "<tr $cb> <td><div class='$defclass' id='$divid'><table width=100%>\n";
854 $main::ui_table_cols = $cols || 4;
855 $main::ui_table_pos = 0;
856 $main::ui_table_default_tds = $tds;
857 return $rv;
858 }
859
860 # ui_hidden_table_end(name)
861 # Returns HTML for the end of table with hiding, as started by
862 # ui_hidden_table_start
863 sub ui_hidden_table_end
864 {
865 local ($name) = @_;
866 return &theme_ui_hidden_table_end(@_) if (defined(&theme_ui_hidden_table_end));
867 return "</table></div></td></tr></table>\n";
868 }
869
870 # ui_tabs_start(&tabs, name, selected, show-border)
871 # Render a row of tabs from which one can be selected. Each tab is an array
872 # ref containing a name, title and link.
873 sub ui_tabs_start
874 {
875 return &theme_ui_tabs_start(@_) if (defined(&theme_ui_tabs_start));
876 local ($tabs, $name, $sel, $border) = @_;
877 local $rv;
878 if (!$main::ui_hidden_start_donejs++) {
879         $rv .= &ui_hidden_javascript();
880         }
881
882 # Build list of tab titles and names
883 local $tabnames = "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$tabs)."]";
884 local $tabtitles = "[".join(",", map { "\"".&html_escape($_->[1])."\"" } @$tabs)."]";
885 $rv .= "<script>\n";
886 $rv .= "document.${name}_tabnames = $tabnames;\n";
887 $rv .= "document.${name}_tabtitles = $tabtitles;\n";
888 $rv .= "</script>\n";
889
890 # Output the tabs
891 local $imgdir = "$gconfig{'webprefix'}/images";
892 $rv .= &ui_hidden($name, $sel)."\n";
893 $rv .= "<table border=0 cellpadding=0 cellspacing=0>\n";
894 $rv .= "<tr><td bgcolor=#ffffff colspan=".(scalar(@$tabs)*2+1).">";
895 if ($ENV{'HTTP_USER_AGENT'} !~ /msie/i) {
896         # For some reason, the 1-pixel space above the tabs appears huge on IE!
897         $rv .= "<img src=$imgdir/1x1.gif>";
898         }
899 $rv .= "</td></tr>\n";
900 $rv .= "<tr>\n";
901 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
902 foreach my $t (@$tabs) {
903         if ($t ne $tabs[0]) {
904                 # Spacer
905                 $rv .= "<td width=2 bgcolor=#ffffff>".
906                        "<img src=$imgdir/1x1.gif></td>\n";
907                 }
908         local $tabid = "tab_".$t->[0];
909         $rv .= "<td id=${tabid}>";
910         $rv .= "<table cellpadding=0 cellspacing=0 border=0><tr>";
911         if ($t->[0] eq $sel) {
912                 # Selected tab
913                 $rv .= "<td valign=top $cb>".
914                        "<img src=$imgdir/lc2.gif alt=\"\"></td>";
915                 $rv .= "<td $cb nowrap>".
916                        "&nbsp;<b>$t->[1]</b>&nbsp;</td>";
917                 $rv .= "<td valign=top $cb>".
918                        "<img src=$imgdir/rc2.gif alt=\"\"></td>";
919                 }
920         else {
921                 # Other tab (which has a link)
922                 $rv .= "<td valign=top $tb>".
923                        "<img src=$imgdir/lc1.gif alt=\"\"></td>";
924                 $rv .= "<td $tb nowrap>".
925                        "&nbsp;<a href='$t->[2]' ".
926                        "onClick='return select_tab(\"$name\", \"$t->[0]\")'>".
927                        "$t->[1]</a>&nbsp;</td>";
928                 $rv .= "<td valign=top $tb>".
929                        "<img src=$imgdir/rc1.gif ".
930                        "alt=\"\"></td>";
931                 $rv .= "</td>\n";
932                 }
933         $rv .= "</tr></table>";
934         $rv .= "</td>\n";
935         }
936 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
937 $rv .= "</table>\n";
938
939 if ($border) {
940         # All tabs are within a grey box
941         $rv .= "<table width=100% cellpadding=0 cellspacing=0 border=0>\n";
942         $rv .= "<tr> <td bgcolor=#ffffff rowspan=3 width=1><img src=$imgdir/1x1.gif></td>\n";
943         $rv .= "<td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
944         $rv .= "<tr> <td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
945         $rv .= "<td valign=top>";
946         }
947 $main::ui_tabs_selected = $sel;
948 return $rv;
949 }
950
951 # ui_tabs_end(border)
952 sub ui_tabs_end
953 {
954 return &theme_ui_tabs_end(@_) if (defined(&theme_ui_tabs_end));
955 local ($border) = @_;
956 local $rv;
957 local $imgdir = "$gconfig{'webprefix'}/images";
958 if ($border) {
959         $rv .= "</td>\n";
960         $rv .= "<td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
961         $rv .= "</tr>\n";
962         $rv .= "<tr> <td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
963         $rv .= "</table>\n";
964         }
965 return $rv;
966 }
967
968 # ui_tabs_start_tab(name, tab)
969 # Must be called before outputting the HTML for the named tab
970 sub ui_tabs_start_tab
971 {
972 return &theme_ui_tabs_start_tab(@_) if (defined(&theme_ui_tabs_start_tab));
973 local ($name, $tab) = @_;
974 local $defclass = $tab eq $main::ui_tabs_selected ?
975                         'opener_shown' : 'opener_hidden';
976 local $rv = "<div id='div_$tab' class='$defclass'>\n";
977 return $rv;
978 }
979
980 # ui_tabs_start_tabletab(name, tab)
981 # Behaves like ui_tabs_start_tab, but for use within a ui_table_start block
982 sub ui_tabs_start_tabletab
983 {
984 return &theme_ui_tabs_start_tabletab(@_)
985         if (defined(&theme_ui_tabs_start_tabletab));
986 local $div = &ui_tabs_start_tab(@_);
987 return "</table>\n".$div."<table width=100%>\n";
988 }
989
990 sub ui_tabs_end_tab
991 {
992 return &theme_ui_tabs_end_tab(@_) if (defined(&theme_ui_tabs_end_tab));
993 return "</div>\n";
994 }
995
996 sub ui_tabs_end_tabletab
997 {
998 return &theme_ui_tabs_end_tabletab(@_)
999         if (defined(&theme_ui_tabs_end_tabletab));
1000 return "</table></div><table width=100%>\n";
1001 }
1002
1003 # ui_max_text_width(width, [text-area?])
1004 # Returns a new width for a text field, based on theme settings
1005 sub ui_max_text_width
1006 {
1007 local ($w, $ta) = @_;
1008 local $max = $ta ? $tconfig{'maxareawidth'} : $tconfig{'maxboxwidth'};
1009 return $max && $w > $max ? $max : $w;
1010 }
1011
1012 ####################### radio hidden functions
1013
1014 # ui_radio_selector(&opts, name, selected)
1015 # Returns HTML for a set of radio buttons, each of which shows a different
1016 # block of HTML when selected. &opts is an array ref to arrays containing
1017 # [ value, label, html ]
1018 sub ui_radio_selector
1019 {
1020 return &theme_ui_radio_selector(@_) if (defined(&theme_ui_radio_selector));
1021 local ($opts, $name, $sel) = @_;
1022 local $rv;
1023 if (!$main::ui_radio_selector_donejs++) {
1024         $rv .= &ui_radio_selector_javascript();
1025         }
1026 local $optnames =
1027         "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$opts)."]";
1028 foreach my $o (@opts) {
1029         $rv .= &ui_oneradio($name, $o->[0], $o->[1], $sel eq $o->[0],
1030             "onClick='selector_show(\"$name\", \"$o->[0]\", $optnames)'");
1031         }
1032 $rv .= "<br>\n";
1033 foreach my $o (@opts) {
1034         local $cls = $o->[0] eq $sel ? "selector_shown" : "selector_hidden";
1035         $rv .= "<div id=sel_${name}_$o->[0] class=$cls>".$o->[2]."</div>\n";
1036         }
1037 return $rv;
1038 }
1039
1040 sub ui_radio_selector_javascript
1041 {
1042 return <<EOF;
1043 <style>
1044 .selector_shown {display:inline}
1045 .selector_hidden {display:none}
1046 </style>
1047 <script>
1048 function selector_show(name, value, values)
1049 {
1050 for(var i=0; i<values.length; i++) {
1051         var divobj = document.getElementById('sel_'+name+'_'+values[i]);
1052         divobj.className = value == values[i] ? 'selector_shown'
1053                                               : 'selector_hidden';
1054         }
1055 }
1056 </script>
1057 EOF
1058 }
1059
1060 ####################### grid layout functions
1061
1062 # ui_grid_table(&elements, columns, [width-percent], [tds])
1063 # Given a list of HTML elements, formats them into a table with the given
1064 # number of columns. However, themes are free to override this to use fewer
1065 # columns where space is limited.
1066 sub ui_grid_table
1067 {
1068 return &theme_ui_grid_table(@_) if (defined(&theme_ui_grid_table));
1069 local ($elements, $cols, $width, $tds) = @_;
1070 return "" if (!@$elements);
1071 local $rv = "<table ".($width ? "width=$width%" : "").">\n";
1072 for(my $i=0; $i<@$elements; $i++) {
1073         $rv .= "<tr>" if ($i%$cols == 0);
1074         $rv .= "<td ".$tds->[$i%$cols].">".$elements->[$i]."</td>\n";
1075         $rv .= "</tr>" if ($i%$cols == $cols-1);
1076         }
1077 if ($i%$cols) {
1078         while($i%$cols) {
1079                 $rv .= "<td ".$tds->[$i%$cols]."><br></td>\n";
1080                 $i++;
1081                 }
1082         $rv .= "</tr>\n";
1083         }
1084 $rv .= "</table>\n";
1085 return $rv;
1086 }
1087
1088 # ui_radio_table(name, selected, &rows)
1089 # Returns HTML for a table of radio buttons, each of which has a label and
1090 # some associated inputs to the right.
1091 sub ui_radio_table
1092 {
1093 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
1094 local ($name, $sel, $rows) = @_;
1095 return "" if (!@$rows);
1096 local $rv = "<table>\n";
1097 foreach my $r (@$rows) {
1098         $rv .= "<tr>\n";
1099         $rv .= "<td>".&ui_oneradio($name, $r->[0], "<b>$r->[1]</b>",
1100                                    $r->[0] eq $sel)."</td>\n";
1101         $rv .= "<td>".$r->[2]."</td>\n";
1102         $rv .= "</tr>\n";
1103         }
1104 $rv .= "</table>\n";
1105 return $rv;
1106 }
1107
1108 ####################### javascript functions
1109
1110 # js_disable_input(&disable-inputs, &enable-inputs, [tag])
1111 # Returns Javascript to disable some form elements and enable others
1112 sub js_disable_inputs
1113 {
1114 local $rv;
1115 local $f;
1116 foreach $f (@{$_[0]}) {
1117         $rv .= "form.elements[\"$f\"].disabled = true; ";
1118         }
1119 foreach $f (@{$_[1]}) {
1120         $rv .= "form.elements[\"$f\"].disabled = false; ";
1121         }
1122 return $_[2] ? "$_[2]='$rv'" : $rv;
1123 }
1124
1125 # js_checkbox_disable(name, &checked-disable, &checked-enable, [tag])
1126 sub js_checkbox_disable
1127 {
1128 local $rv;
1129 local $f;
1130 foreach $f (@{$_[1]}) {
1131         $rv .= "form.elements[\"$f\"].disabled = $_[0].checked; ";
1132         }
1133 foreach $f (@{$_[2]}) {
1134         $rv .= "form.elements[\"$f\"].disabled = !$_[0].checked; ";
1135         }
1136 return $_[3] ? "$_[3]='$rv'" : $rv;
1137 }
1138
1139 1;
1140