2 # Common functions for generating HTML for Webmin user interface elements
4 ####################### table generation functions
6 # ui_table_start(heading, [tabletags], [cols], [&default-tds])
7 # A table with a heading and table inside
10 return &theme_ui_table_start(@_) if (defined(&theme_ui_table_start));
11 local ($heading, $tabletags, $cols, $tds) = @_;
12 if (defined($main::ui_table_cols)) {
13 # Push on stack, for nested call
14 push(@main::ui_table_cols_stack, $main::ui_table_cols);
15 push(@main::ui_table_pos_stack, $main::ui_table_pos);
16 push(@main::ui_table_default_tds_stack, $main::ui_table_default_tds);
19 $rv .= "<table class='ui_table' border $tabletags>\n";
20 $rv .= "<tr $tb> <td><b>$heading</b></td> </tr>\n" if (defined($heading));
21 $rv .= "<tr $cb> <td><table width=100%>\n";
22 $main::ui_table_cols = $cols || 4;
23 $main::ui_table_pos = 0;
24 $main::ui_table_default_tds = $tds;
29 # The end of a table started by ui_table_start
32 return &theme_ui_table_end(@_) if (defined(&theme_ui_table_end));
34 if ($main::ui_table_cols == 4 && $main::ui_table_pos) {
35 # Add an empty block to balance the table
36 $rv .= &ui_table_row(" ", " ");
38 if (@main::ui_table_cols_stack) {
39 $main::ui_table_cols = pop(@main::ui_table_cols_stack);
40 $main::ui_table_pos = pop(@main::ui_table_pos_stack);
41 $main::ui_table_default_tds = pop(@main::ui_table_default_tds_stack);
44 $main::ui_table_cols = undef;
45 $main::ui_table_pos = undef;
46 $main::ui_table_default_tds = undef;
48 $rv .= "</table></td></tr></table>\n";
52 # ui_columns_start(&headings, [width-percent], [noborder], [&tdtags], [heading])
53 # Returns HTML for a multi-column table, with the given headings
56 return &theme_ui_columns_start(@_) if (defined(&theme_ui_columns_start));
57 local ($heads, $width, $noborder, $tdtags, $title) = @_;
59 $rv .= "<table".($noborder ? "" : " border").
60 (defined($width) ? " width=$width%" : "")." class='ui_columns'>\n";
62 $rv .= "<tr $tb><td colspan=".scalar(@$heads).
63 " class='ui_columns_heading'><b>$title</b></td></tr>\n";
65 $rv .= "<tr $tb class='ui_columns_heads'>\n";
67 for($i=0; $i<@$heads; $i++) {
68 $rv .= "<td ".$tdtags->[$i]."><b>".
69 ($heads->[$i] eq "" ? "<br>" : $heads->[$i])."</b></td>\n";
75 # ui_columns_row(&columns, &tdtags)
76 # Returns HTML for a row in a multi-column table
79 return &theme_ui_columns_row(@_) if (defined(&theme_ui_columns_row));
80 local ($cols, $tdtags) = @_;
82 $rv .= "<tr $cb class='ui_columns_row'>\n";
84 for($i=0; $i<@$cols; $i++) {
85 $rv .= "<td ".$tdtags->[$i].">".
86 ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i])."</td>\n";
92 # ui_columns_header(&columns, &tdtags)
93 # Returns HTML for a row in a multi-column table, with a header background
96 return &theme_ui_columns_header(@_) if (defined(&theme_ui_columns_header));
97 local ($cols, $tdtags) = @_;
99 $rv .= "<tr $tb class='ui_columns_header'>\n";
101 for($i=0; $i<@$cols; $i++) {
102 $rv .= "<td ".$tdtags->[$i]."><b>".
103 ($cols->[$i] eq "" ? "<br>" : $cols->[$i])."</b></td>\n";
109 # ui_checked_columns_row(&columns, &tdtags, checkname, checkvalue, [checked?],
111 # Returns HTML for a row in a multi-column table, in which the first
112 # column is a checkbox
113 sub ui_checked_columns_row
115 return &theme_ui_checked_columns_row(@_) if (defined(&theme_ui_checked_columns_row));
116 local ($cols, $tdtags, $checkname, $checkvalue, $checked, $disabled) = @_;
118 $rv .= "<tr $cb class='ui_checked_columns'>\n";
119 $rv .= "<td class='ui_checked_checkbox' ".$tdtags->[0].">".
120 &ui_checkbox($checkname, $checkvalue, undef, $checked, undef, $disabled).
123 for($i=0; $i<@$cols; $i++) {
124 $rv .= "<td ".$tdtags->[$i+1].">";
125 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
126 $rv .= "<label for=\"".
127 "e_escape("${checkname}_${checkvalue}")."\">";
129 $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
130 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
139 # ui_radio_columns_row(&columns, &tdtags, checkname, checkvalue, [checked],
141 # Returns HTML for a row in a multi-column table, in which the first
142 # column is a radio button
143 sub ui_radio_columns_row
145 return &theme_ui_radio_columns_row(@_) if (defined(&theme_ui_radio_columns_row));
146 local ($cols, $tdtags, $checkname, $checkvalue, $checked, $dis) = @_;
148 $rv .= "<tr $cb class='ui_radio_columns'>\n";
149 $rv .= "<td class='ui_radio_radio' ".$tdtags->[0].">".
150 &ui_oneradio($checkname, $checkvalue, "", $checked, undef, $dis)."</td>\n";
152 for($i=0; $i<@$cols; $i++) {
153 $rv .= "<td ".$tdtags->[$i+1].">";
154 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
155 $rv .= "<label for=\"".
156 "e_escape("${checkname}_${checkvalue}")."\">";
158 $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
159 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
169 # Returns HTML to end a table started by ui_columns_start
172 return &theme_ui_columns_end(@_) if (defined(&theme_ui_columns_end));
176 # ui_columns_table(&headings, width-percent, &data, &types, no-sort, title,
178 # Returns HTML for a complete table.
179 # headings - An array ref of heading HTML
180 # width-percent - Preferred total width
181 # data - A 2x2 array ref of table contents. Each can either be a simple string,
182 # or a hash ref like :
183 # { 'type' => 'group', 'desc' => 'Some section title' }
184 # { 'type' => 'string', 'value' => 'Foo', 'colums' => 3,
186 # { 'type' => 'checkbox', 'name' => 'd', 'value' => 'foo',
187 # 'label' => 'Yes', 'checked' => 1, 'disabled' => 1 }
188 # { 'type' => 'radio', 'name' => 'd', 'value' => 'foo', ... }
189 # types - An array ref of data types, such as 'string', 'number', 'bytes'
191 # no-sort - Set to 1 to disable sorting by theme
192 # title - Text to appear above the table
193 # empty-msg - Message to display if no data
196 return &theme_ui_columns_table(@_) if (defined(&theme_ui_columns_table));
197 local ($heads, $width, $data, $types, $nosort, $title, $emptymsg) = @_;
200 # Just show empty message if no data
201 if ($emptymsg && !@$data) {
202 $rv .= &ui_subheading($title) if ($title);
203 $rv .= "<b>$emptymsg</b><p>\n";
207 # Are there any checkboxes in each column? If so, make those columns narrow
208 local @tds = map { "valign=top" } @$heads;
210 foreach my $r (@$data) {
212 foreach my $c (@$r) {
214 ($c->{'type'} eq 'checkbox' || $c->{'type'} eq 'radio')) {
215 $tds[$cc] .= " width=5" if ($tds[$cc] !~ /width=/);
219 $maxwidth = $cc if ($cc > $maxwidth);
221 $rv .= &ui_columns_start($heads, $width, 0, \@tds, $title);
224 foreach my $r (@$data) {
226 if (ref($r->[0]) && ($r->[0]->{'type'} eq 'checkbox' ||
227 $r->[0]->{'type'} eq 'radio')) {
228 # First column is special
230 $r = [ @$r[1..(@$r-1)] ];
232 # Turn data into HTML
237 foreach my $c (@$r) {
242 elsif ($c->{'type'} eq 'checkbox') {
243 # Checkbox in non-first column
244 push(@cols, &ui_checkbox($c->{'name'}, $c->{'value'},
245 $c->{'label'}, $c->{'checked'},
246 undef, $c->{'disabled'}));
248 elsif ($c->{'type'} eq 'radio') {
249 # Radio button in non-first column
250 push(@cols, &ui_oneradio($c->{'name'}, $c->{'value'},
251 $c->{'label'}, $c->{'checked'},
252 undef, $c->{'disabled'}));
254 elsif ($c->{'type'} eq 'group') {
255 # Header row that spans whole table
256 $rv .= &ui_columns_header([ $c->{'desc'} ],
257 [ "colspan=$width" ]);
260 elsif ($c->{'type'} eq 'string') {
261 # A string, which might be special
262 push(@cols, $c->{'value'});
263 if ($c->{'columns'} > 1) {
264 splice(@rtds, $cn, $c->{'columns'},
265 "colspan=".$c->{'columns'});
267 if ($c->{'nowrap'}) {
268 $rtds[$cn] .= " nowrap";
275 $rv .= &ui_columns_row(\@cols, \@rtds);
277 elsif ($c0->{'type'} eq 'checkbox') {
278 $rv .= &ui_checked_columns_row(\@cols, \@rtds, $c0->{'name'},
279 $c0->{'value'}, $c0->{'checked'},
282 elsif ($c0->{'type'} eq 'radio') {
283 $rv .= &ui_radio_columns_row(\@cols, \@rtds, $c0->{'name'},
284 $c0->{'value'}, $c0->{'checked'},
289 $rv .= &ui_columns_end();
293 # ui_form_columns_table(cgi, &buttons, select-all, &otherlinks, &hiddens,
294 # &headings, width-percent, &data, &types, no-sort, title,
296 # Similar to ui_columns_table, but wrapped in a form. Args are :
297 # cgi - URL to submit the form to
298 # buttons - An array ref of buttons at the end of the form, similar to
299 # that taken by ui_form_end
300 # select-all - If set to 1, include select all / invert links
301 # otherslinks - An array ref of other links to put at the top of the table,
302 # each of which is a 3-element hash ref of url, text and
303 # alignment (left or right)
304 # hiddens - An array ref of hidden fields, each of which is a 2-element array
305 # ref containing the name and value
306 # All other parameters are the same as ui_columns_table
307 sub ui_form_columns_table
309 return &theme_ui_form_columns_table(@_)
310 if (defined(&theme_ui_form_columns_table));
311 local ($cgi, $buttons, $selectall, $others, $hiddens,
312 $heads, $width, $data, $types, $nosort, $title, $emptymsg) = @_;
316 local @leftlinks = map { "<a href='$_->[0]'>$_->[1]</a>" }
317 grep { $_->[2] ne 'right' } @$others;
318 local @rightlinks = map { "<a href='$_->[0]'>$_->[1]</a>" }
319 grep { $_->[2] eq 'right' } @$others;
326 foreach my $r (@$data) {
327 foreach my $c (@$r) {
328 if (ref($c) && $c->{'type'} eq 'checkbox') {
329 $cbname = $c->{'name'};
335 unshift(@leftlinks, &select_all_link($cbname),
336 &select_invert_link($cbname));
343 $links = &ui_grid_table([ &ui_links_row(\@leftlinks),
344 &ui_links_row(\@rightlinks) ], 2, 100,
345 [ undef, "align=right" ]);
348 $links = &ui_links_row(\@leftlinks);
351 # Start the form, if we need one
353 $rv .= &ui_form_start($cgi, "post");
354 foreach my $h (@$hiddens) {
355 $rv .= &ui_hidden(@$h);
361 $rv .= &ui_columns_table($heads, $width, $data, $types, $nosort, $title,
367 $rv .= &ui_form_end($buttons);
373 ####################### form generation functions
375 # ui_form_start(script, method, [target], [tags])
376 # Returns HTML for a form that submits to some script
379 return &theme_ui_form_start(@_) if (defined(&theme_ui_form_start));
380 local ($script, $method, $target, $tags) = @_;
382 $rv .= "<form class='ui_form' action='".&html_escape($script)."' ".
383 ($method eq "post" ? "method=post" :
384 $method eq "form-data" ?
385 "method=post enctype=multipart/form-data" :
387 ($target ? " target=$target" : "").
393 # ui_form_end([&buttons], [width])
394 # Returns HTML for the end of a form, optionally with a row of submit buttons
397 return &theme_ui_form_end(@_) if (defined(&theme_ui_form_end));
398 local ($buttons, $width) = @_;
400 if ($buttons && @$buttons) {
401 $rv .= "<table class='ui_form_end_buttons' ".($width ? " width=$width" : "")."><tr>\n";
403 foreach $b (@$buttons) {
405 $rv .= "<td".(!$width ? "" :
406 $b eq $buttons->[0] ? " align=left" :
407 $b eq $buttons->[@$buttons-1] ?
408 " align=right" : " align=center").">".
409 &ui_submit($b->[1], $b->[0], $b->[3], $b->[4]).
410 ($b->[2] ? " ".$b->[2] : "")."</td>\n";
413 $rv .= "<td>$b</td>\n";
416 $rv .= "<td> </td>\n";
419 $rv .= "</tr></table>\n";
425 # ui_textbox(name, value, size, [disabled?], [maxlength], [tags])
426 # Returns HTML for a text input
429 return &theme_ui_textbox(@_) if (defined(&theme_ui_textbox));
430 local ($name, $value, $size, $dis, $max, $tags) = @_;
431 $size = &ui_max_text_width($size);
432 return "<input name=\""."e_escape($name)."\" ".
433 "value=\""."e_escape($value)."\" ".
434 "size=$size ".($dis ? "disabled=true" : "").
435 ($max ? " maxlength=$max" : "").
440 # ui_bytesbox(name, bytes, [size], [disabled?])
441 # Returns HTML for entering a number of bytes, but with friendly kB/MB/GB
442 # options. May truncate values to 2 decimal points!
445 local ($name, $bytes, $size, $dis) = @_;
447 if ($bytes >= 10*1024*1024*1024) {
448 $units = 1024*1024*1024;
450 elsif ($bytes >= 10*1024*1024) {
453 elsif ($bytes >= 10*1024) {
460 $bytes = sprintf("%.2f", ($bytes*1.0)/$units);
463 $size = &ui_max_text_width($size || 8);
464 return &ui_textbox($name, $bytes, $size, $dis)." ".
465 &ui_select($name."_units", $units,
466 [ [ 1, "bytes" ], [ 1024, "kB" ], [ 1024*1024, "MB" ],
467 [ 1024*1024*1024, "GB" ] ], undef, undef, undef, $dis);
470 # ui_upload(name, size, [disabled?], [tags])
471 # Returns HTML for a file upload input
474 return &theme_ui_upload(@_) if (defined(&theme_ui_upload));
475 local ($name, $size, $dis, $tags) = @_;
476 $size = &ui_max_text_width($size);
477 return "<input type=file name=\""."e_escape($name)."\" ".
479 ($dis ? "disabled=true" : "").
480 ($tags ? " ".$tags : "").">";
483 # ui_password(name, value, size, [disabled?], [maxlength])
484 # Returns HTML for a password text input
487 return &theme_ui_password(@_) if (defined(&theme_ui_password));
488 local ($name, $value, $size, $dis, $max) = @_;
489 $size = &ui_max_text_width($size);
490 return "<input type=password name=\""."e_escape($name)."\" ".
491 "value=\""."e_escape($value)."\" ".
492 "size=$size ".($dis ? "disabled=true" : "").
493 ($max ? " maxlength=$max" : "").
497 # ui_hidden(name, value)
498 # Returns HTML for a hidden field
501 return &theme_ui_hidden(@_) if (defined(&theme_ui_hidden));
502 local ($name, $value) = @_;
503 return "<input type=hidden name=\""."e_escape($name)."\" ".
504 "value=\""."e_escape($value)."\">\n";
507 # ui_select(name, value|&values, &options, [size], [multiple],
508 # [add-if-missing], [disabled?], [javascript])
509 # Returns HTML for a drop-down menu or multiple selection list
512 return &theme_ui_select(@_) if (defined(&theme_ui_select));
513 local ($name, $value, $opts, $size, $multiple, $missing, $dis, $js) = @_;
515 $rv .= "<select name=\""."e_escape($name)."\"".
516 ($size ? " size=$size" : "").
517 ($multiple ? " multiple" : "").
518 ($dis ? " disabled=true" : "")." ".$js.">\n";
519 local ($o, %opt, $s);
520 local %sel = ref($value) ? ( map { $_, 1 } @$value ) : ( $value, 1 );
521 foreach $o (@$opts) {
522 $o = [ $o ] if (!ref($o));
523 $rv .= "<option value=\""."e_escape($o->[0])."\"".
524 ($sel{$o->[0]} ? " selected" : "").">".
525 ($o->[1] || $o->[0])."\n";
528 foreach $s (keys %sel) {
529 if (!$opt{$s} && $missing) {
530 $rv .= "<option value=\""."e_escape($s)."\"".
531 "selected>".($s eq "" ? " " : $s)."\n";
534 $rv .= "</select>\n";
538 # ui_radio(name, value, &options, [disabled?])
539 # Returns HTML for a series of radio buttons
542 return &theme_ui_radio(@_) if (defined(&theme_ui_radio));
543 local ($name, $value, $opts, $dis) = @_;
546 foreach $o (@$opts) {
547 local $id = "e_escape($name."_".$o->[0]);
548 local $label = $o->[1] || $o->[0];
550 if ($label =~ /^(.*?)((<a\s+href|<input|<select|<textarea)[\000-\377]*)$/i) {
554 $rv .= "<input type=radio name=\""."e_escape($name)."\" ".
555 "value=\""."e_escape($o->[0])."\"".
556 ($o->[0] eq $value ? " checked" : "").
557 ($dis ? " disabled=true" : "").
559 " $o->[2]> <label for=\"$id\">".
560 $label."</label>".$after."\n";
565 # ui_yesno_radio(name, value, [yes], [no], [disabled?])
566 # Like ui_yesno, but always displays just two inputs (yes and no)
569 local ($name, $value, $yes, $no, $dis) = @_;
570 return &theme_ui_yesno_radio(@_) if (defined(&theme_ui_yesno_radio));
571 $yes = 1 if (!defined($yes));
572 $no = 0 if (!defined($no));
573 $value = int($value);
574 return &ui_radio($name, $value, [ [ $yes, $text{'yes'} ],
575 [ $no, $text{'no'} ] ], $dis);
578 # ui_checkbox(name, value, label, selected?, [tags], [disabled?])
579 # Returns HTML for a single checkbox
582 return &theme_ui_checkbox(@_) if (defined(&theme_ui_checkbox));
583 local ($name, $value, $label, $sel, $tags, $dis) = @_;
585 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
589 return "<input type=checkbox name=\""."e_escape($name)."\" ".
590 "value=\""."e_escape($value)."\" ".
591 ($sel ? " checked" : "").($dis ? " disabled=true" : "").
592 " id=\""."e_escape("${name}_${value}")."\"".
594 ($label eq "" ? $after :
595 "<label for=\""."e_escape("${name}_${value}").
596 "\">$label</label>$after")."\n";
599 # ui_oneradio(name, value, label, selected?, [tags], [disabled?])
600 # Returns HTML for a single radio button
603 return &theme_ui_oneradio(@_) if (defined(&theme_ui_oneradio));
604 local ($name, $value, $label, $sel, $tags, $dis) = @_;
605 local $id = "e_escape("${name}_${value}");
607 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
611 return "<input type=radio name=\""."e_escape($name)."\" ".
612 "value=\""."e_escape($value)."\" ".
613 ($sel ? " checked" : "").($dis ? " disabled=true" : "").
615 " $tags> <label for=\"$id\">$label</label>$after\n";
618 # ui_textarea(name, value, rows, cols, [wrap], [disabled?], [tags])
619 # Returns HTML for a multi-line text input
622 return &theme_ui_textarea(@_) if (defined(&theme_ui_textarea));
623 local ($name, $value, $rows, $cols, $wrap, $dis, $tags) = @_;
624 $cols = &ui_max_text_width($cols, 1);
625 return "<textarea name=\""."e_escape($name)."\" ".
626 "rows=$rows cols=$cols".($wrap ? " wrap=$wrap" : "").
627 ($dis ? " disabled=true" : "").
628 ($tags ? " $tags" : "").">".
629 &html_escape($value).
633 # ui_user_textbox(name, value, [form], [disabled?], [tags])
634 # Returns HTML for a Unix user input
637 return &theme_ui_user_textbox(@_) if (defined(&theme_ui_user_textbox));
638 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
639 &user_chooser_button($_[0], 0, $_[2]);
642 # ui_group_textbox(name, value, [form], [disabled?], [tags])
643 # Returns HTML for a Unix group input
646 return &theme_ui_group_textbox(@_) if (defined(&theme_ui_group_textbox));
647 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
648 &group_chooser_button($_[0], 0, $_[2]);
651 # ui_opt_textbox(name, value, size, option1, [option2], [disabled?],
652 # [&extra-fields], [max])
653 # Returns HTML for a text field that is optional
656 return &theme_ui_opt_textbox(@_) if (defined(&theme_ui_opt_textbox));
657 local ($name, $value, $size, $opt1, $opt2, $dis, $extra, $max) = @_;
658 local $dis1 = &js_disable_inputs([ $name, @$extra ], [ ]);
659 local $dis2 = &js_disable_inputs([ ], [ $name, @$extra ]);
661 $size = &ui_max_text_width($size);
662 $rv .= &ui_radio($name."_def", $value eq '' ? 1 : 0,
663 [ [ 1, $opt1, "onClick='$dis1'" ],
664 [ 0, $opt2 || " ", "onClick='$dis2'" ] ], $dis)."\n";
665 $rv .= "<input name=\""."e_escape($name)."\" ".
666 "size=$size value=\""."e_escape($value)."\" ".
667 ($value eq "" || $dis ? "disabled=true" : "").
668 ($max ? " maxlength=$max" : "").">\n";
672 # ui_submit(label, [name], [disabled?], [tags])
673 # Returns HTML for a form submit button
676 return &theme_ui_submit(@_) if (defined(&theme_ui_submit));
677 local ($label, $name, $dis, $tags) = @_;
678 return "<input type=submit".
679 ($name ne '' ? " name=\""."e_escape($name)."\"" : "").
680 " value=\""."e_escape($label)."\"".
681 ($dis ? " disabled=true" : "").
682 ($tags ? " ".$tags : "").">\n";
686 # ui_reset(label, [disabled?])
687 # Returns HTML for a form reset button
690 return &theme_ui_reset(@_) if (defined(&theme_ui_reset));
691 local ($label, $dis) = @_;
692 return "<input type=reset value=\""."e_escape($label)."\"".
693 ($dis ? " disabled=true" : "").">\n";
697 # ui_button(label, [name], [disabled?], [tags])
698 # Returns HTML for a form button
701 return &theme_ui_button(@_) if (defined(&theme_ui_button));
702 local ($label, $name, $dis, $tags) = @_;
703 return "<input type=button".
704 ($name ne '' ? " name=\""."e_escape($name)."\"" : "").
705 " value=\""."e_escape($label)."\"".
706 ($dis ? " disabled=true" : "").
707 ($tags ? " ".$tags : "").">\n";
710 # ui_date_input(day, month, year, day-name, month-name, year-name, [disabled?])
711 # Returns HTML for a date-selection field
714 local ($day, $month, $year, $dayname, $monthname, $yearname, $dis) = @_;
716 $rv .= &ui_textbox($dayname, $day, 3, $dis);
718 $rv .= &ui_select($monthname, $month,
719 [ map { [ $_, $text{"smonth_$_"} ] } (1 .. 12) ],
722 $rv .= &ui_textbox($yearname, $year, 5, $dis);
726 # ui_table_row(label, value, [cols], [&td-tags])
727 # Returns HTML for a row in a table started by ui_table_start, with a 1-column
728 # label and 1+ column value.
731 return &theme_ui_table_row(@_) if (defined(&theme_ui_table_row));
732 local ($label, $value, $cols, $tds) = @_;
734 $tds ||= $main::ui_table_default_tds;
736 if ($main::ui_table_pos+$cols+1 > $main::ui_table_cols &&
737 $main::ui_table_pos != 0) {
738 # If the requested number of cols won't fit in the number
739 # remaining, start a new row
741 $main::ui_table_pos = 0;
743 $rv .= "<tr>\n" if ($main::ui_table_pos%$main::ui_table_cols == 0);
744 $rv .= "<td valign=top $tds->[0]><b>$label</b></td>\n" if (defined($label));
745 $rv .= "<td valign=top colspan=$cols $tds->[1]>$value</td>\n";
746 $main::ui_table_pos += $cols+(defined($label) ? 1 : 0);
747 if ($main::ui_table_pos%$main::ui_table_cols == 0) {
749 $main::ui_table_pos = 0;
757 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
763 $rv .= "<tr> <td colspan=$main::ui_table_cols><hr></td> </tr>\n";
767 # ui_table_span(text)
768 # Outputs a table row that spans the whole table, and contains the given text
772 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
778 $rv .= "<tr> <td colspan=$main::ui_table_cols>$text</td> </tr>\n";
785 return &theme_ui_buttons_start(@_) if (defined(&theme_ui_buttons_start));
786 return "<table width=100%>\n";
792 return &theme_ui_buttons_end(@_) if (defined(&theme_ui_buttons_end));
796 # ui_buttons_row(script, button-label, description, [hiddens], [after-submit],
800 return &theme_ui_buttons_row(@_) if (defined(&theme_ui_buttons_row));
801 local ($script, $label, $desc, $hiddens, $after, $before) = @_;
802 return "<form action=$script>\n".
804 "<tr> <td nowrap width=20% valign=top>".($before ? $before." " : "").
805 &ui_submit($label).($after ? " ".$after : "")."</td>\n".
806 "<td valign=top width=80% valign=top>$desc</td> </tr>\n".
810 # ui_buttons_hr([title])
814 return &theme_ui_buttons_hr(@_) if (defined(&theme_ui_buttons_hr));
816 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";
819 return "<tr> <td colspan=2><hr></td> </tr>\n";
823 ####################### header and footer functions
825 # ui_post_header([subtext])
826 # Returns HTML to appear directly after a standard header() call
829 return &theme_ui_post_header(@_) if (defined(&theme_ui_post_header));
832 $rv .= "<center class='ui_post_header'><font size=+1>$text</font></center>\n" if (defined($text));
833 if (!$tconfig{'nohr'} && !$tconfig{'notophr'}) {
834 $rv .= "<hr id='post_header_hr'>\n";
840 # Returns HTML to appear directly before a standard footer() call
843 return &theme_ui_pre_footer(@_) if (defined(&theme_ui_pre_footer));
845 if (!$tconfig{'nohr'} && !$tconfig{'nobottomhr'}) {
846 $rv .= "<hr id='pre_footer_hr'>\n";
851 # ui_print_header(subtext, args...)
852 # Print HTML for a header with the post-header line. The args are the same
853 # as those passed to header()
856 &load_theme_library();
857 return &theme_ui_print_header(@_) if (defined(&theme_ui_print_header));
858 local ($text, @args) = @_;
860 print &ui_post_header($text);
863 # ui_print_unbuffered_header(subtext, args...)
864 # Like ui_print_header, but ensures that output for this page is not buffered
865 # or contained in a table.
866 sub ui_print_unbuffered_header
868 &load_theme_library();
869 return &theme_ui_print_unbuffered_header(@_) if (defined(&theme_ui_print_unbuffered_header));
872 &ui_print_header(@_);
875 # ui_print_footer(args...)
876 # Print HTML for a footer with the pre-footer line. Args are the same as those
880 return &theme_ui_print_footer(@_) if (defined(&theme_ui_print_footer));
882 print &ui_pre_footer();
886 # ui_config_link(text, &subs)
887 # Returns HTML for a module config link. The first non-null sub will be
888 # replaced with the appropriate URL.
891 return &theme_ui_config_link(@_) if (defined(&theme_ui_config_link));
892 local ($text, $subs) = @_;
893 local @subs = map { $_ || "../config.cgi?$module_name" }
894 ($subs ? @$subs : ( undef ));
895 return "<p>".&text($text, @subs)."<p>\n";
898 # ui_print_endpage(text)
899 # Prints HTML for an error message followed by a page footer with a link to
900 # /, then exits. Good for main page error messages.
903 return &theme_ui_print_endpage(@_) if (defined(&theme_ui_print_endpage));
905 print $text,"<p class='ui_footer'>\n";
907 &ui_print_footer("/", $text{'index'});
911 # ui_subheading(text, ...)
912 # Returns HTML for a section heading
915 return &theme_ui_subheading(@_) if (defined(&theme_ui_subheading));
916 return "<h3 class='ui_subheading'>".join("", @_)."</h3>\n";
919 # ui_links_row(&links)
920 # Returns HTML for a row of links, like select all / invert selection / add..
923 return &theme_ui_links_row(@_) if (defined(&theme_ui_links_row));
925 return @$links ? join("\n|\n", @$links)."<br>\n"
929 ########################### collapsible section / tab functions
931 # ui_hidden_javascript()
932 # Returns <script> and <style> sections for hiding functions and CSS
933 sub ui_hidden_javascript
935 return &theme_ui_hidden_javascript(@_)
936 if (defined(&theme_ui_hidden_javascript));
938 local $imgdir = "$gconfig{'webprefix'}/images";
939 local ($jscb, $jstb) = ($cb, $tb);
945 .opener_shown {display:inline}
946 .opener_hidden {display:none}
949 // Open or close a hidden section
950 function hidden_opener(divid, openerid)
952 var divobj = document.getElementById(divid);
953 var openerobj = document.getElementById(openerid);
954 if (divobj.className == 'opener_shown') {
955 divobj.className = 'opener_hidden';
956 openerobj.innerHTML = '<img border=0 src=$imgdir/closed.gif>';
959 divobj.className = 'opener_shown';
960 openerobj.innerHTML = '<img border=0 src=$imgdir/open.gif>';
965 function select_tab(name, tabname, form)
967 var tabnames = document[name+'_tabnames'];
968 var tabtitles = document[name+'_tabtitles'];
969 for(var i=0; i<tabnames.length; i++) {
970 var tabobj = document.getElementById('tab_'+tabnames[i]);
971 var divobj = document.getElementById('div_'+tabnames[i]);
972 var title = tabtitles[i];
973 if (tabnames[i] == tabname) {
975 tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
976 '<td valign=top $jscb>'+
977 '<img src=$imgdir/lc2.gif alt=""></td>'+
979 ' <b>'+title+'</b> </td>'+
980 '<td valign=top $jscb>'+
981 '<img src=$imgdir/rc2.gif alt=""></td>'+
983 divobj.className = 'opener_shown';
987 tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
988 '<td valign=top $jstb>'+
989 '<img src=$imgdir/lc1.gif alt=""></td>'+
991 ' <a href=\\'\\' onClick=\\'return select_tab("'+
992 name+'", "'+tabnames[i]+'")\\'>'+title+'</a> </td>'+
993 '<td valign=top $jstb>'+
994 '<img src=$imgdir/rc1.gif alt=""></td>'+
996 divobj.className = 'opener_hidden';
999 if (document.forms[0] && document.forms[0][name]) {
1000 document.forms[0][name].value = tabname;
1008 # ui_hidden_start(title, name, status, thisurl)
1009 # Returns HTML for the start of a collapsible hidden section, such as for
1013 return &theme_ui_hidden_start(@_) if (defined(&theme_ui_hidden_start));
1014 local ($title, $name, $status, $url) = @_;
1016 if (!$main::ui_hidden_start_donejs++) {
1017 $rv .= &ui_hidden_javascript();
1019 local $divid = "hiddendiv_$name";
1020 local $openerid = "hiddenopener_$name";
1021 local $defimg = $status ? "open.gif" : "closed.gif";
1022 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1023 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg' alt='*'></a>\n";
1024 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
1025 $rv .= "<div class='$defclass' id='$divid'>\n";
1029 # ui_hidden_end(name)
1030 # Returns HTML for the end of a hidden section
1033 return &theme_ui_hidden_end(@_) if (defined(&theme_ui_hidden_end));
1038 # ui_hidden_table_row_start(title, name, status, thisurl)
1039 # Similar to ui_hidden_start, but for use within a table started with
1041 sub ui_hidden_table_row_start
1043 return &theme_ui_hidden_table_row_start(@_)
1044 if (defined(&theme_ui_hidden_table_row_start));
1045 local ($title, $name, $status, $url) = @_;
1047 if (!$main::ui_hidden_start_donejs++) {
1048 $rv .= &ui_hidden_javascript();
1050 local $divid = "hiddendiv_$name";
1051 local $openerid = "hiddenopener_$name";
1052 local $defimg = $status ? "open.gif" : "closed.gif";
1053 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1054 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a>\n";
1055 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
1056 $rv .= &ui_table_row(undef, $rrv, $main::ui_table_cols);
1057 $rv .= "</table>\n";
1058 $rv .= "<div class='$defclass' id='$divid'>\n";
1059 $rv .= "<table width=100%>\n";
1063 # ui_hidden_table_row_end(name)
1064 sub ui_hidden_table_row_end
1066 return &theme_ui_hidden_table_row_end(@_)
1067 if (defined(&theme_ui_hidden_table_row_end));
1069 return "</table></div><table width=100%>\n";
1072 # ui_hidden_table_start(heading, [tabletags], [cols], name, status,
1074 # A table with a heading and table inside, and which is collapsible
1075 sub ui_hidden_table_start
1077 return &theme_ui_hidden_table_start(@_)
1078 if (defined(&theme_ui_hidden_table_start));
1079 local ($heading, $tabletags, $cols, $name, $status, $tds) = @_;
1081 if (!$main::ui_hidden_start_donejs++) {
1082 $rv .= &ui_hidden_javascript();
1084 local $divid = "hiddendiv_$name";
1085 local $openerid = "hiddenopener_$name";
1086 local $defimg = $status ? "open.gif" : "closed.gif";
1087 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1088 local $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1089 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1090 $rv .= "<table class='ui_table' border $tabletags class='ui_table'>\n";
1091 $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));
1092 $rv .= "<tr $cb> <td><div class='$defclass' id='$divid'><table width=100%>\n";
1093 $main::ui_table_cols = $cols || 4;
1094 $main::ui_table_pos = 0;
1095 $main::ui_table_default_tds = $tds;
1099 # ui_hidden_table_end(name)
1100 # Returns HTML for the end of table with hiding, as started by
1101 # ui_hidden_table_start
1102 sub ui_hidden_table_end
1105 return &theme_ui_hidden_table_end(@_) if (defined(&theme_ui_hidden_table_end));
1106 return "</table></div></td></tr></table>\n";
1109 # ui_tabs_start(&tabs, name, selected, show-border)
1110 # Render a row of tabs from which one can be selected. Each tab is an array
1111 # ref containing a name, title and link.
1114 return &theme_ui_tabs_start(@_) if (defined(&theme_ui_tabs_start));
1115 local ($tabs, $name, $sel, $border) = @_;
1117 if (!$main::ui_hidden_start_donejs++) {
1118 $rv .= &ui_hidden_javascript();
1121 # Build list of tab titles and names
1122 local $tabnames = "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$tabs)."]";
1123 local $tabtitles = "[".join(",", map { "\"".&html_escape($_->[1])."\"" } @$tabs)."]";
1124 $rv .= "<script>\n";
1125 $rv .= "document.${name}_tabnames = $tabnames;\n";
1126 $rv .= "document.${name}_tabtitles = $tabtitles;\n";
1127 $rv .= "</script>\n";
1130 local $imgdir = "$gconfig{'webprefix'}/images";
1131 $rv .= &ui_hidden($name, $sel)."\n";
1132 $rv .= "<table border=0 cellpadding=0 cellspacing=0>\n";
1133 $rv .= "<tr><td bgcolor=#ffffff colspan=".(scalar(@$tabs)*2+1).">";
1134 if ($ENV{'HTTP_USER_AGENT'} !~ /msie/i) {
1135 # For some reason, the 1-pixel space above the tabs appears huge on IE!
1136 $rv .= "<img src=$imgdir/1x1.gif>";
1138 $rv .= "</td></tr>\n";
1140 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1141 foreach my $t (@$tabs) {
1142 if ($t ne $tabs[0]) {
1144 $rv .= "<td width=2 bgcolor=#ffffff>".
1145 "<img src=$imgdir/1x1.gif></td>\n";
1147 local $tabid = "tab_".$t->[0];
1148 $rv .= "<td id=${tabid}>";
1149 $rv .= "<table cellpadding=0 cellspacing=0 border=0><tr>";
1150 if ($t->[0] eq $sel) {
1152 $rv .= "<td valign=top $cb>".
1153 "<img src=$imgdir/lc2.gif alt=\"\"></td>";
1154 $rv .= "<td $cb nowrap>".
1155 " <b>$t->[1]</b> </td>";
1156 $rv .= "<td valign=top $cb>".
1157 "<img src=$imgdir/rc2.gif alt=\"\"></td>";
1160 # Other tab (which has a link)
1161 $rv .= "<td valign=top $tb>".
1162 "<img src=$imgdir/lc1.gif alt=\"\"></td>";
1163 $rv .= "<td $tb nowrap>".
1164 " <a href='$t->[2]' ".
1165 "onClick='return select_tab(\"$name\", \"$t->[0]\")'>".
1166 "$t->[1]</a> </td>";
1167 $rv .= "<td valign=top $tb>".
1168 "<img src=$imgdir/rc1.gif ".
1172 $rv .= "</tr></table>";
1175 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1176 $rv .= "</table>\n";
1179 # All tabs are within a grey box
1180 $rv .= "<table width=100% cellpadding=0 cellspacing=0 border=0>\n";
1181 $rv .= "<tr> <td bgcolor=#ffffff rowspan=3 width=1><img src=$imgdir/1x1.gif></td>\n";
1182 $rv .= "<td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1183 $rv .= "<tr> <td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1184 $rv .= "<td valign=top>";
1186 $main::ui_tabs_selected = $sel;
1190 # ui_tabs_end(border)
1193 return &theme_ui_tabs_end(@_) if (defined(&theme_ui_tabs_end));
1194 local ($border) = @_;
1196 local $imgdir = "$gconfig{'webprefix'}/images";
1199 $rv .= "<td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1201 $rv .= "<tr> <td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1202 $rv .= "</table>\n";
1207 # ui_tabs_start_tab(name, tab)
1208 # Must be called before outputting the HTML for the named tab
1209 sub ui_tabs_start_tab
1211 return &theme_ui_tabs_start_tab(@_) if (defined(&theme_ui_tabs_start_tab));
1212 local ($name, $tab) = @_;
1213 local $defclass = $tab eq $main::ui_tabs_selected ?
1214 'opener_shown' : 'opener_hidden';
1215 local $rv = "<div id='div_$tab' class='$defclass'>\n";
1219 # ui_tabs_start_tabletab(name, tab)
1220 # Behaves like ui_tabs_start_tab, but for use within a ui_table_start block
1221 sub ui_tabs_start_tabletab
1223 return &theme_ui_tabs_start_tabletab(@_)
1224 if (defined(&theme_ui_tabs_start_tabletab));
1225 local $div = &ui_tabs_start_tab(@_);
1226 return "</table>\n".$div."<table width=100%>\n";
1231 return &theme_ui_tabs_end_tab(@_) if (defined(&theme_ui_tabs_end_tab));
1235 sub ui_tabs_end_tabletab
1237 return &theme_ui_tabs_end_tabletab(@_)
1238 if (defined(&theme_ui_tabs_end_tabletab));
1239 return "</table></div><table width=100%>\n";
1242 # ui_max_text_width(width, [text-area?])
1243 # Returns a new width for a text field, based on theme settings
1244 sub ui_max_text_width
1246 local ($w, $ta) = @_;
1247 local $max = $ta ? $tconfig{'maxareawidth'} : $tconfig{'maxboxwidth'};
1248 return $max && $w > $max ? $max : $w;
1251 ####################### radio hidden functions
1253 # ui_radio_selector(&opts, name, selected)
1254 # Returns HTML for a set of radio buttons, each of which shows a different
1255 # block of HTML when selected. &opts is an array ref to arrays containing
1256 # [ value, label, html ]
1257 sub ui_radio_selector
1259 return &theme_ui_radio_selector(@_) if (defined(&theme_ui_radio_selector));
1260 local ($opts, $name, $sel) = @_;
1262 if (!$main::ui_radio_selector_donejs++) {
1263 $rv .= &ui_radio_selector_javascript();
1266 "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$opts)."]";
1267 foreach my $o (@$opts) {
1268 $rv .= &ui_oneradio($name, $o->[0], $o->[1], $sel eq $o->[0],
1269 "onClick='selector_show(\"$name\", \"$o->[0]\", $optnames)'");
1272 foreach my $o (@$opts) {
1273 local $cls = $o->[0] eq $sel ? "selector_shown" : "selector_hidden";
1274 $rv .= "<div id=sel_${name}_$o->[0] class=$cls>".$o->[2]."</div>\n";
1279 sub ui_radio_selector_javascript
1283 .selector_shown {display:inline}
1284 .selector_hidden {display:none}
1287 function selector_show(name, value, values)
1289 for(var i=0; i<values.length; i++) {
1290 var divobj = document.getElementById('sel_'+name+'_'+values[i]);
1291 divobj.className = value == values[i] ? 'selector_shown'
1292 : 'selector_hidden';
1299 ####################### grid layout functions
1301 # ui_grid_table(&elements, columns, [width-percent], [tds], [tabletags],
1303 # Given a list of HTML elements, formats them into a table with the given
1304 # number of columns. However, themes are free to override this to use fewer
1305 # columns where space is limited.
1308 return &theme_ui_grid_table(@_) if (defined(&theme_ui_grid_table));
1309 local ($elements, $cols, $width, $tds, $tabletags, $title) = @_;
1310 return "" if (!@$elements);
1311 local $rv = "<table".
1312 ($width ? " width=$width%" : "").
1313 ($tabletags ? " ".$tabletags : "").
1316 for($i=0; $i<@$elements; $i++) {
1317 $rv .= "<tr>" if ($i%$cols == 0);
1318 $rv .= "<td ".$tds->[$i%$cols]." valign=top>".$elements->[$i]."</td>\n";
1319 $rv .= "</tr>" if ($i%$cols == $cols-1);
1323 $rv .= "<td ".$tds->[$i%$cols]."><br></td>\n";
1328 $rv .= "</table>\n";
1329 if (defined($title)) {
1330 $rv = "<table class=ui_table border ".
1331 ($width ? " width=$width%" : "").">\n".
1332 ($title ? "<tr $tb> <td><b>$title</b></td> </tr>\n" : "").
1333 "<tr $cb> <td>$rv</td> </tr>\n".
1339 # ui_radio_table(name, selected, &rows)
1340 # Returns HTML for a table of radio buttons, each of which has a label and
1341 # some associated inputs to the right.
1344 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
1345 local ($name, $sel, $rows) = @_;
1346 return "" if (!@$rows);
1347 local $rv = "<table>\n";
1348 foreach my $r (@$rows) {
1350 $rv .= "<td valign=top><b>".&ui_oneradio($name, $r->[0], $r->[1],
1351 $r->[0] eq $sel)."</b></td>\n";
1352 $rv .= "<td valign=top>".$r->[2]."</td>\n";
1355 $rv .= "</table>\n";
1359 # ui_up_down_arrows(uplink, downlink, up-show, down-show)
1360 # Returns HTML for moving some objects in a table up or down
1361 sub ui_up_down_arrows
1363 return &theme_ui_up_down_arrows(@_) if (defined(&theme_ui_up_down_arrows));
1364 local ($uplink, $downlink, $upshow, $downshow) = @_;
1366 local $imgdir = "$gconfig{'webprefix'}/images";
1368 $mover .= "<a href=\"$downlink\">".
1369 "<img src=$imgdir/movedown.gif border=0></a>";
1372 $mover .= "<img src=$imgdir/movegap.gif>";
1375 $mover .= "<a href=\"$uplink\">".
1376 "<img src=$imgdir/moveup.gif border=0></a>";
1379 $mover .= "<img src=$imgdir/movegap.gif>";
1385 # Returns a horizontal row tag
1388 return &theme_ui_hr() if (defined(&theme_ui_hr));
1392 ####################### javascript functions
1394 # js_disable_input(&disable-inputs, &enable-inputs, [tag])
1395 # Returns Javascript to disable some form elements and enable others
1396 sub js_disable_inputs
1400 foreach $f (@{$_[0]}) {
1401 $rv .= "e = form.elements[\"$f\"]; e.disabled = true; ";
1402 $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = true; } ";
1404 foreach $f (@{$_[1]}) {
1405 $rv .= "e = form.elements[\"$f\"]; e.disabled = false; ";
1406 $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = false; } ";
1408 foreach $f (@{$_[1]}) {
1409 if ($f =~ /^(.*)_def$/ && &indexof($1, @{$_[1]}) >= 0) {
1410 # When enabling both a _def field and its associated text field,
1411 # disable the text if the _def is set to 1
1413 $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 } } ";
1416 return $_[2] ? "$_[2]='$rv'" : $rv;
1419 # js_checkbox_disable(name, &checked-disable, &checked-enable, [tag])
1420 sub js_checkbox_disable
1424 foreach $f (@{$_[1]}) {
1425 $rv .= "form.elements[\"$f\"].disabled = $_[0].checked; ";
1427 foreach $f (@{$_[2]}) {
1428 $rv .= "form.elements[\"$f\"].disabled = !$_[0].checked; ";
1430 return $_[3] ? "$_[3]='$rv'" : $rv;
1434 # Returns HTML to trigger a redirect to some URL
1438 if (defined(&theme_js_redirect)) {
1439 return &theme_js_redirect(@_);
1441 return "<script>window.location = '"."e_escape($url)."';</script>\n";