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, $heading) = @_;
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>$heading</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_checked_columns_start(&headings, [width-percent], [noborder], [&tdtags],
77 # Returns HTML for a multi-column table whose first column will contain
78 # checkboxes or radio buttons
79 sub ui_checked_columns_start
81 return &theme_ui_checked_columns_start(@_)
82 if (defined(&theme_ui_checked_columns_start));
83 local ($heads, $width, $noborder, $tdtags, $heading) = @_;
84 local @cheads = ( " ", @$heads );
85 local @ctdtags = ( "width=5", $tdtags ? @$tdtags : ( ) );
86 return &ui_columns_start(\@cheads, $width, $noborder, \@ctdtags, $heading);
89 # ui_columns_row(&columns, &tdtags)
90 # Returns HTML for a row in a multi-column table
93 return &theme_ui_columns_row(@_) if (defined(&theme_ui_columns_row));
94 local ($cols, $tdtags) = @_;
96 $rv .= "<tr $cb class='ui_columns_row'>\n";
98 for($i=0; $i<@$cols; $i++) {
99 $rv .= "<td ".$tdtags->[$i].">".
100 ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i])."</td>\n";
106 # ui_columns_header(&columns, &tdtags)
107 # Returns HTML for a row in a multi-column table, with a header background
108 sub ui_columns_header
110 return &theme_ui_columns_header(@_) if (defined(&theme_ui_columns_header));
111 local ($cols, $tdtags) = @_;
113 $rv .= "<tr $tb class='ui_columns_header'>\n";
115 for($i=0; $i<@$cols; $i++) {
116 $rv .= "<td ".$tdtags->[$i]."><b>".
117 ($cols->[$i] eq "" ? "<br>" : $cols->[$i])."</b></td>\n";
123 # ui_checked_columns_row(&columns, &tdtags, checkname, checkvalue, [checked?],
125 # Returns HTML for a row in a multi-column table, in which the first
126 # column is a checkbox
127 sub ui_checked_columns_row
129 return &theme_ui_checked_columns_row(@_) if (defined(&theme_ui_checked_columns_row));
130 local ($cols, $tdtags, $checkname, $checkvalue, $checked, $disabled) = @_;
132 $rv .= "<tr $cb class='ui_checked_columns'>\n";
133 $rv .= "<td class='ui_checked_checkbox' ".$tdtags->[0].">".
134 &ui_checkbox($checkname, $checkvalue, undef, $checked, undef, $disabled).
137 for($i=0; $i<@$cols; $i++) {
138 $rv .= "<td ".$tdtags->[$i+1].">";
139 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
140 $rv .= "<label for=\"".
141 "e_escape("${checkname}_${checkvalue}")."\">";
143 $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
144 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
153 # ui_radio_columns_row(&columns, &tdtags, checkname, checkvalue, [checked])
154 # Returns HTML for a row in a multi-column table, in which the first
155 # column is a radio button
156 sub ui_radio_columns_row
158 return &theme_ui_radio_columns_row(@_) if (defined(&theme_ui_radio_columns_row));
159 local ($cols, $tdtags, $checkname, $checkvalue, $checked) = @_;
161 $rv .= "<tr $cb class='ui_radio_columns'>\n";
162 $rv .= "<td class='ui_radio_radio' ".$tdtags->[0].">".
163 &ui_oneradio($checkname, $checkvalue, "", $checked)."</td>\n";
165 for($i=0; $i<@$cols; $i++) {
166 $rv .= "<td ".$tdtags->[$i+1].">";
167 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
168 $rv .= "<label for=\"".
169 "e_escape("${checkname}_${checkvalue}")."\">";
171 $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
172 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
182 # Returns HTML to end a table started by ui_columns_start
185 return &theme_ui_columns_end(@_) if (defined(&theme_ui_columns_end));
189 # ui_checked_columns_end()
190 # Returns HTML to end a table started by ui_checked_columns_start
191 sub ui_checked_columns_end
193 return &theme_ui_checked_columns_end(@_)
194 if (defined(&theme_ui_checked_columns_end));
200 ####################### form generation functions
202 # ui_form_start(script, method, [target], [tags])
203 # Returns HTML for a form that submits to some script
206 return &theme_ui_form_start(@_) if (defined(&theme_ui_form_start));
207 local ($script, $method, $target, $tags) = @_;
209 $rv .= "<form class='ui_form' action='".&html_escape($script)."' ".
210 ($method eq "post" ? "method=post" :
211 $method eq "form-data" ?
212 "method=post enctype=multipart/form-data" :
214 ($target ? " target=$target" : "").
220 # ui_form_end([&buttons], [width])
221 # Returns HTML for the end of a form, optionally with a row of submit buttons
224 return &theme_ui_form_end(@_) if (defined(&theme_ui_form_end));
225 local ($buttons, $width) = @_;
227 if ($buttons && @$buttons) {
228 $rv .= "<table class='ui_form_end_buttons' ".($width ? " width=$width" : "")."><tr>\n";
230 foreach $b (@$buttons) {
232 $rv .= "<td".(!$width ? "" :
233 $b eq $buttons->[0] ? " align=left" :
234 $b eq $buttons->[@$buttons-1] ?
235 " align=right" : " align=center").">".
236 &ui_submit($b->[1], $b->[0], $b->[3], $b->[4]).
237 ($b->[2] ? " ".$b->[2] : "")."</td>\n";
240 $rv .= "<td>$b</td>\n";
243 $rv .= "<td> </td>\n";
246 $rv .= "</tr></table>\n";
252 # ui_textbox(name, value, size, [disabled?], [maxlength], [tags])
253 # Returns HTML for a text input
256 return &theme_ui_textbox(@_) if (defined(&theme_ui_textbox));
257 local ($name, $value, $size, $dis, $max, $tags) = @_;
258 $size = &ui_max_text_width($size);
259 return "<input name=\""."e_escape($name)."\" ".
260 "value=\""."e_escape($value)."\" ".
261 "size=$size ".($dis ? "disabled=true" : "").
262 ($max ? " maxlength=$max" : "").
267 # ui_bytesbox(name, bytes, [size], [disabled?])
268 # Returns HTML for entering a number of bytes, but with friendly kB/MB/GB
269 # options. May truncate values to 2 decimal points!
272 local ($name, $bytes, $size, $dis) = @_;
274 if ($bytes >= 10*1024*1024*1024) {
275 $units = 1024*1024*1024;
277 elsif ($bytes >= 10*1024*1024) {
280 elsif ($bytes >= 10*1024) {
287 $bytes = sprintf("%.2f", ($bytes*1.0)/$units);
290 $size = &ui_max_text_width($size || 8);
291 return &ui_textbox($name, $bytes, $size, $dis)." ".
292 &ui_select($name."_units", $units,
293 [ [ 1, "bytes" ], [ 1024, "kB" ], [ 1024*1024, "MB" ],
294 [ 1024*1024*1024, "GB" ] ], undef, undef, undef, $dis);
297 # ui_upload(name, size, [disabled?], [tags])
298 # Returns HTML for a file upload input
301 return &theme_ui_upload(@_) if (defined(&theme_ui_upload));
302 local ($name, $size, $dis, $tags) = @_;
303 $size = &ui_max_text_width($size);
304 return "<input type=file name=\""."e_escape($name)."\" ".
306 ($dis ? "disabled=true" : "").
307 ($tags ? " ".$tags : "").">";
310 # ui_password(name, value, size, [disabled?], [maxlength])
311 # Returns HTML for a password text input
314 return &theme_ui_password(@_) if (defined(&theme_ui_password));
315 local ($name, $value, $size, $dis, $max) = @_;
316 $size = &ui_max_text_width($size);
317 return "<input type=password name=\""."e_escape($name)."\" ".
318 "value=\""."e_escape($value)."\" ".
319 "size=$size ".($dis ? "disabled=true" : "").
320 ($max ? " maxlength=$max" : "").
324 # ui_hidden(name, value)
325 # Returns HTML for a hidden field
328 return &theme_ui_hidden(@_) if (defined(&theme_ui_hidden));
329 local ($name, $value) = @_;
330 return "<input type=hidden name=\""."e_escape($name)."\" ".
331 "value=\""."e_escape($value)."\">\n";
334 # ui_select(name, value|&values, &options, [size], [multiple],
335 # [add-if-missing], [disabled?], [javascript])
336 # Returns HTML for a drop-down menu or multiple selection list
339 return &theme_ui_select(@_) if (defined(&theme_ui_select));
340 local ($name, $value, $opts, $size, $multiple, $missing, $dis, $js) = @_;
342 $rv .= "<select name=\""."e_escape($name)."\"".
343 ($size ? " size=$size" : "").
344 ($multiple ? " multiple" : "").
345 ($dis ? " disabled=true" : "")." ".$js.">\n";
346 local ($o, %opt, $s);
347 local %sel = ref($value) ? ( map { $_, 1 } @$value ) : ( $value, 1 );
348 foreach $o (@$opts) {
349 $o = [ $o ] if (!ref($o));
350 $rv .= "<option value=\""."e_escape($o->[0])."\"".
351 ($sel{$o->[0]} ? " selected" : "").">".
352 ($o->[1] || $o->[0])."\n";
355 foreach $s (keys %sel) {
356 if (!$opt{$s} && $missing) {
357 $rv .= "<option value=\""."e_escape($s)."\"".
358 "selected>".($s eq "" ? " " : $s)."\n";
361 $rv .= "</select>\n";
365 # ui_radio(name, value, &options, [disabled?])
366 # Returns HTML for a series of radio buttons
369 return &theme_ui_radio(@_) if (defined(&theme_ui_radio));
370 local ($name, $value, $opts, $dis) = @_;
373 foreach $o (@$opts) {
374 local $id = "e_escape($name."_".$o->[0]);
375 local $label = $o->[1] || $o->[0];
377 if ($label =~ /^(.*?)((<a\s+href|<input|<select|<textarea)[\000-\377]*)$/i) {
381 $rv .= "<input type=radio name=\""."e_escape($name)."\" ".
382 "value=\""."e_escape($o->[0])."\"".
383 ($o->[0] eq $value ? " checked" : "").
384 ($dis ? " disabled=true" : "").
386 " $o->[2]> <label for=\"$id\">".
387 $label."</label>".$after."\n";
392 # ui_yesno_radio(name, value, [yes], [no], [disabled?])
393 # Like ui_yesno, but always displays just two inputs (yes and no)
396 local ($name, $value, $yes, $no, $dis) = @_;
397 return &theme_ui_yesno_radio(@_) if (defined(&theme_ui_yesno_radio));
398 $yes = 1 if (!defined($yes));
399 $no = 0 if (!defined($no));
400 $value = int($value);
401 return &ui_radio($name, $value, [ [ $yes, $text{'yes'} ],
402 [ $no, $text{'no'} ] ], $dis);
405 # ui_checkbox(name, value, label, selected?, [tags], [disabled?])
406 # Returns HTML for a single checkbox
409 return &theme_ui_checkbox(@_) if (defined(&theme_ui_checkbox));
410 local ($name, $value, $label, $sel, $tags, $dis) = @_;
412 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
416 return "<input type=checkbox name=\""."e_escape($name)."\" ".
417 "value=\""."e_escape($value)."\" ".
418 ($sel ? " checked" : "").($dis ? " disabled=true" : "").
419 " id=\""."e_escape("${name}_${value}")."\"".
421 ($label eq "" ? $after :
422 "<label for=\""."e_escape("${name}_${value}").
423 "\">$label</label>$after")."\n";
426 # ui_oneradio(name, value, label, selected?, [tags], [disabled?])
427 # Returns HTML for a single radio button
430 return &theme_ui_oneradio(@_) if (defined(&theme_ui_oneradio));
431 local ($name, $value, $label, $sel, $tags, $dis) = @_;
432 local $id = "e_escape("${name}_${value}");
434 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
438 return "<input type=radio name=\""."e_escape($name)."\" ".
439 "value=\""."e_escape($value)."\" ".
440 ($sel ? " checked" : "").($dis ? " disabled=true" : "").
442 " $tags> <label for=\"$id\">$label</label>$after\n";
445 # ui_textarea(name, value, rows, cols, [wrap], [disabled?], [tags])
446 # Returns HTML for a multi-line text input
449 return &theme_ui_textarea(@_) if (defined(&theme_ui_textarea));
450 local ($name, $value, $rows, $cols, $wrap, $dis, $tags) = @_;
451 $cols = &ui_max_text_width($cols, 1);
452 return "<textarea name=\""."e_escape($name)."\" ".
453 "rows=$rows cols=$cols".($wrap ? " wrap=$wrap" : "").
454 ($dis ? " disabled=true" : "").
455 ($tags ? " $tags" : "").">".
456 &html_escape($value).
460 # ui_user_textbox(name, value, [form], [disabled?], [tags])
461 # Returns HTML for a Unix user input
464 return &theme_ui_user_textbox(@_) if (defined(&theme_ui_user_textbox));
465 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
466 &user_chooser_button($_[0], 0, $_[2]);
469 # ui_group_textbox(name, value, [form], [disabled?], [tags])
470 # Returns HTML for a Unix group input
473 return &theme_ui_group_textbox(@_) if (defined(&theme_ui_group_textbox));
474 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
475 &group_chooser_button($_[0], 0, $_[2]);
478 # ui_opt_textbox(name, value, size, option1, [option2], [disabled?],
479 # [&extra-fields], [max])
480 # Returns HTML for a text field that is optional
483 return &theme_ui_opt_textbox(@_) if (defined(&theme_ui_opt_textbox));
484 local ($name, $value, $size, $opt1, $opt2, $dis, $extra, $max) = @_;
485 local $dis1 = &js_disable_inputs([ $name, @$extra ], [ ]);
486 local $dis2 = &js_disable_inputs([ ], [ $name, @$extra ]);
488 $size = &ui_max_text_width($size);
489 $rv .= &ui_radio($name."_def", $value eq '' ? 1 : 0,
490 [ [ 1, $opt1, "onClick='$dis1'" ],
491 [ 0, $opt2 || " ", "onClick='$dis2'" ] ], $dis)."\n";
492 $rv .= "<input name=\""."e_escape($name)."\" ".
493 "size=$size value=\""."e_escape($value)."\" ".
494 ($value eq "" || $dis ? "disabled=true" : "").
495 ($max ? " maxlength=$max" : "").">\n";
499 # ui_submit(label, [name], [disabled?], [tags])
500 # Returns HTML for a form submit button
503 return &theme_ui_submit(@_) if (defined(&theme_ui_submit));
504 local ($label, $name, $dis, $tags) = @_;
505 return "<input type=submit".
506 ($name ne '' ? " name=\""."e_escape($name)."\"" : "").
507 " value=\""."e_escape($label)."\"".
508 ($dis ? " disabled=true" : "").
509 ($tags ? " ".$tags : "").">\n";
513 # ui_reset(label, [disabled?])
514 # Returns HTML for a form reset button
517 return &theme_ui_reset(@_) if (defined(&theme_ui_reset));
518 local ($label, $dis) = @_;
519 return "<input type=reset value=\""."e_escape($label)."\"".
520 ($dis ? " disabled=true" : "").">\n";
524 # ui_button(label, [name], [disabled?], [tags])
525 # Returns HTML for a form button
528 return &theme_ui_button(@_) if (defined(&theme_ui_button));
529 local ($label, $name, $dis, $tags) = @_;
530 return "<input type=button".
531 ($name ne '' ? " name=\""."e_escape($name)."\"" : "").
532 " value=\""."e_escape($label)."\"".
533 ($dis ? " disabled=true" : "").
534 ($tags ? " ".$tags : "").">\n";
537 # ui_date_input(day, month, year, day-name, month-name, year-name, [disabled?])
538 # Returns HTML for a date-selection field
541 local ($day, $month, $year, $dayname, $monthname, $yearname, $dis) = @_;
543 $rv .= &ui_textbox($dayname, $day, 3, $dis);
545 $rv .= &ui_select($monthname, $month,
546 [ map { [ $_, $text{"smonth_$_"} ] } (1 .. 12) ],
549 $rv .= &ui_textbox($yearname, $year, 5, $dis);
553 # ui_table_row(label, value, [cols], [&td-tags])
554 # Returns HTML for a row in a table started by ui_table_start, with a 1-column
555 # label and 1+ column value.
558 return &theme_ui_table_row(@_) if (defined(&theme_ui_table_row));
559 local ($label, $value, $cols, $tds) = @_;
561 $tds ||= $main::ui_table_default_tds;
563 if ($main::ui_table_pos+$cols+1 > $main::ui_table_cols &&
564 $main::ui_table_pos != 0) {
565 # If the requested number of cols won't fit in the number
566 # remaining, start a new row
568 $main::ui_table_pos = 0;
570 $rv .= "<tr>\n" if ($main::ui_table_pos%$main::ui_table_cols == 0);
571 $rv .= "<td valign=top $tds->[0]><b>$label</b></td>\n" if (defined($label));
572 $rv .= "<td valign=top colspan=$cols $tds->[1]>$value</td>\n";
573 $main::ui_table_pos += $cols+(defined($label) ? 1 : 0);
574 if ($main::ui_table_pos%$main::ui_table_cols == 0) {
576 $main::ui_table_pos = 0;
584 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
590 $rv .= "<tr> <td colspan=$main::ui_table_cols><hr></td> </tr>\n";
594 # ui_table_span(text)
595 # Outputs a table row that spans the whole table, and contains the given text
599 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
605 $rv .= "<tr> <td colspan=$main::ui_table_cols>$text</td> </tr>\n";
612 return &theme_ui_buttons_start(@_) if (defined(&theme_ui_buttons_start));
613 return "<table width=100%>\n";
619 return &theme_ui_buttons_end(@_) if (defined(&theme_ui_buttons_end));
623 # ui_buttons_row(script, button-label, description, [hiddens], [after-submit],
627 return &theme_ui_buttons_row(@_) if (defined(&theme_ui_buttons_row));
628 local ($script, $label, $desc, $hiddens, $after, $before) = @_;
629 return "<form action=$script>\n".
631 "<tr> <td nowrap width=20% valign=top>".($before ? $before." " : "").
632 &ui_submit($label).($after ? " ".$after : "")."</td>\n".
633 "<td valign=top width=80% valign=top>$desc</td> </tr>\n".
637 # ui_buttons_hr([title])
641 return &theme_ui_buttons_hr(@_) if (defined(&theme_ui_buttons_hr));
643 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";
646 return "<tr> <td colspan=2><hr></td> </tr>\n";
650 ####################### header and footer functions
652 # ui_post_header([subtext])
653 # Returns HTML to appear directly after a standard header() call
656 return &theme_ui_post_header(@_) if (defined(&theme_ui_post_header));
659 $rv .= "<center class='ui_post_header'><font size=+1>$text</font></center>\n" if (defined($text));
660 if (!$tconfig{'nohr'} && !$tconfig{'notophr'}) {
661 $rv .= "<hr id='post_header_hr'>\n";
667 # Returns HTML to appear directly before a standard footer() call
670 return &theme_ui_pre_footer(@_) if (defined(&theme_ui_pre_footer));
672 if (!$tconfig{'nohr'} && !$tconfig{'nobottomhr'}) {
673 $rv .= "<hr id='pre_footer_hr'>\n";
678 # ui_print_header(subtext, args...)
679 # Print HTML for a header with the post-header line. The args are the same
680 # as those passed to header()
683 &load_theme_library();
684 return &theme_ui_print_header(@_) if (defined(&theme_ui_print_header));
685 local ($text, @args) = @_;
687 print &ui_post_header($text);
690 # ui_print_unbuffered_header(subtext, args...)
691 # Like ui_print_header, but ensures that output for this page is not buffered
692 # or contained in a table.
693 sub ui_print_unbuffered_header
695 &load_theme_library();
696 return &theme_ui_print_unbuffered_header(@_) if (defined(&theme_ui_print_unbuffered_header));
699 &ui_print_header(@_);
702 # ui_print_footer(args...)
703 # Print HTML for a footer with the pre-footer line. Args are the same as those
707 return &theme_ui_print_footer(@_) if (defined(&theme_ui_print_footer));
709 print &ui_pre_footer();
713 # ui_config_link(text, &subs)
714 # Returns HTML for a module config link. The first non-null sub will be
715 # replaced with the appropriate URL.
718 return &theme_ui_config_link(@_) if (defined(&theme_ui_config_link));
719 local ($text, $subs) = @_;
720 local @subs = map { $_ || "../config.cgi?$module_name" }
721 ($subs ? @$subs : ( undef ));
722 return "<p>".&text($text, @subs)."<p>\n";
725 # ui_print_endpage(text)
726 # Prints HTML for an error message followed by a page footer with a link to
727 # /, then exits. Good for main page error messages.
730 return &theme_ui_print_endpage(@_) if (defined(&theme_ui_print_endpage));
732 print $text,"<p class='ui_footer'>\n";
734 &ui_print_footer("/", $text{'index'});
738 # ui_subheading(text, ...)
739 # Returns HTML for a section heading
742 return &theme_ui_subheading(@_) if (defined(&theme_ui_subheading));
743 return "<h3 class='ui_subheading'>".join("", @_)."</h3>\n";
746 # ui_links_row(&links)
747 # Returns HTML for a row of links, like select all / invert selection / add..
750 return &theme_ui_links_row(@_) if (defined(&theme_ui_links_row));
752 return @$links ? join("\n|\n", @$links)."<br>\n"
756 ########################### collapsible section / tab functions
758 # ui_hidden_javascript()
759 # Returns <script> and <style> sections for hiding functions and CSS
760 sub ui_hidden_javascript
762 return &theme_ui_hidden_javascript(@_)
763 if (defined(&theme_ui_hidden_javascript));
765 local $imgdir = "$gconfig{'webprefix'}/images";
766 local ($jscb, $jstb) = ($cb, $tb);
772 .opener_shown {display:inline}
773 .opener_hidden {display:none}
776 // Open or close a hidden section
777 function hidden_opener(divid, openerid)
779 var divobj = document.getElementById(divid);
780 var openerobj = document.getElementById(openerid);
781 if (divobj.className == 'opener_shown') {
782 divobj.className = 'opener_hidden';
783 openerobj.innerHTML = '<img border=0 src=$imgdir/closed.gif>';
786 divobj.className = 'opener_shown';
787 openerobj.innerHTML = '<img border=0 src=$imgdir/open.gif>';
792 function select_tab(name, tabname, form)
794 var tabnames = document[name+'_tabnames'];
795 var tabtitles = document[name+'_tabtitles'];
796 for(var i=0; i<tabnames.length; i++) {
797 var tabobj = document.getElementById('tab_'+tabnames[i]);
798 var divobj = document.getElementById('div_'+tabnames[i]);
799 var title = tabtitles[i];
800 if (tabnames[i] == tabname) {
802 tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
803 '<td valign=top $jscb>'+
804 '<img src=$imgdir/lc2.gif alt=""></td>'+
806 ' <b>'+title+'</b> </td>'+
807 '<td valign=top $jscb>'+
808 '<img src=$imgdir/rc2.gif alt=""></td>'+
810 divobj.className = 'opener_shown';
814 tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
815 '<td valign=top $jstb>'+
816 '<img src=$imgdir/lc1.gif alt=""></td>'+
818 ' <a href=\\'\\' onClick=\\'return select_tab("'+
819 name+'", "'+tabnames[i]+'")\\'>'+title+'</a> </td>'+
820 '<td valign=top $jstb>'+
821 '<img src=$imgdir/rc1.gif alt=""></td>'+
823 divobj.className = 'opener_hidden';
826 if (document.forms[0] && document.forms[0][name]) {
827 document.forms[0][name].value = tabname;
835 # ui_hidden_start(title, name, status, thisurl)
836 # Returns HTML for the start of a collapsible hidden section, such as for
840 return &theme_ui_hidden_start(@_) if (defined(&theme_ui_hidden_start));
841 local ($title, $name, $status, $url) = @_;
843 if (!$main::ui_hidden_start_donejs++) {
844 $rv .= &ui_hidden_javascript();
846 local $divid = "hiddendiv_$name";
847 local $openerid = "hiddenopener_$name";
848 local $defimg = $status ? "open.gif" : "closed.gif";
849 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
850 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg' alt='*'></a>\n";
851 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
852 $rv .= "<div class='$defclass' id='$divid'>\n";
856 # ui_hidden_end(name)
857 # Returns HTML for the end of a hidden section
860 return &theme_ui_hidden_end(@_) if (defined(&theme_ui_hidden_end));
865 # ui_hidden_table_row_start(title, name, status, thisurl)
866 # Similar to ui_hidden_start, but for use within a table started with
868 sub ui_hidden_table_row_start
870 return &theme_ui_hidden_table_row_start(@_)
871 if (defined(&theme_ui_hidden_table_row_start));
872 local ($title, $name, $status, $url) = @_;
874 if (!$main::ui_hidden_start_donejs++) {
875 $rv .= &ui_hidden_javascript();
877 local $divid = "hiddendiv_$name";
878 local $openerid = "hiddenopener_$name";
879 local $defimg = $status ? "open.gif" : "closed.gif";
880 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
881 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a>\n";
882 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
883 $rv .= &ui_table_row(undef, $rrv, $main::ui_table_cols);
885 $rv .= "<div class='$defclass' id='$divid'>\n";
886 $rv .= "<table width=100%>\n";
890 # ui_hidden_table_row_end(name)
891 sub ui_hidden_table_row_end
893 return &theme_ui_hidden_table_row_end(@_)
894 if (defined(&theme_ui_hidden_table_row_end));
896 return "</table></div><table width=100%>\n";
899 # ui_hidden_table_start(heading, [tabletags], [cols], name, status,
901 # A table with a heading and table inside, and which is collapsible
902 sub ui_hidden_table_start
904 return &theme_ui_hidden_table_start(@_)
905 if (defined(&theme_ui_hidden_table_start));
906 local ($heading, $tabletags, $cols, $name, $status, $tds) = @_;
908 if (!$main::ui_hidden_start_donejs++) {
909 $rv .= &ui_hidden_javascript();
911 local $divid = "hiddendiv_$name";
912 local $openerid = "hiddenopener_$name";
913 local $defimg = $status ? "open.gif" : "closed.gif";
914 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
915 local $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
916 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
917 $rv .= "<table class='ui_table' border $tabletags class='ui_table'>\n";
918 $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));
919 $rv .= "<tr $cb> <td><div class='$defclass' id='$divid'><table width=100%>\n";
920 $main::ui_table_cols = $cols || 4;
921 $main::ui_table_pos = 0;
922 $main::ui_table_default_tds = $tds;
926 # ui_hidden_table_end(name)
927 # Returns HTML for the end of table with hiding, as started by
928 # ui_hidden_table_start
929 sub ui_hidden_table_end
932 return &theme_ui_hidden_table_end(@_) if (defined(&theme_ui_hidden_table_end));
933 return "</table></div></td></tr></table>\n";
936 # ui_tabs_start(&tabs, name, selected, show-border)
937 # Render a row of tabs from which one can be selected. Each tab is an array
938 # ref containing a name, title and link.
941 return &theme_ui_tabs_start(@_) if (defined(&theme_ui_tabs_start));
942 local ($tabs, $name, $sel, $border) = @_;
944 if (!$main::ui_hidden_start_donejs++) {
945 $rv .= &ui_hidden_javascript();
948 # Build list of tab titles and names
949 local $tabnames = "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$tabs)."]";
950 local $tabtitles = "[".join(",", map { "\"".&html_escape($_->[1])."\"" } @$tabs)."]";
952 $rv .= "document.${name}_tabnames = $tabnames;\n";
953 $rv .= "document.${name}_tabtitles = $tabtitles;\n";
954 $rv .= "</script>\n";
957 local $imgdir = "$gconfig{'webprefix'}/images";
958 $rv .= &ui_hidden($name, $sel)."\n";
959 $rv .= "<table border=0 cellpadding=0 cellspacing=0>\n";
960 $rv .= "<tr><td bgcolor=#ffffff colspan=".(scalar(@$tabs)*2+1).">";
961 if ($ENV{'HTTP_USER_AGENT'} !~ /msie/i) {
962 # For some reason, the 1-pixel space above the tabs appears huge on IE!
963 $rv .= "<img src=$imgdir/1x1.gif>";
965 $rv .= "</td></tr>\n";
967 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
968 foreach my $t (@$tabs) {
969 if ($t ne $tabs[0]) {
971 $rv .= "<td width=2 bgcolor=#ffffff>".
972 "<img src=$imgdir/1x1.gif></td>\n";
974 local $tabid = "tab_".$t->[0];
975 $rv .= "<td id=${tabid}>";
976 $rv .= "<table cellpadding=0 cellspacing=0 border=0><tr>";
977 if ($t->[0] eq $sel) {
979 $rv .= "<td valign=top $cb>".
980 "<img src=$imgdir/lc2.gif alt=\"\"></td>";
981 $rv .= "<td $cb nowrap>".
982 " <b>$t->[1]</b> </td>";
983 $rv .= "<td valign=top $cb>".
984 "<img src=$imgdir/rc2.gif alt=\"\"></td>";
987 # Other tab (which has a link)
988 $rv .= "<td valign=top $tb>".
989 "<img src=$imgdir/lc1.gif alt=\"\"></td>";
990 $rv .= "<td $tb nowrap>".
991 " <a href='$t->[2]' ".
992 "onClick='return select_tab(\"$name\", \"$t->[0]\")'>".
993 "$t->[1]</a> </td>";
994 $rv .= "<td valign=top $tb>".
995 "<img src=$imgdir/rc1.gif ".
999 $rv .= "</tr></table>";
1002 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1003 $rv .= "</table>\n";
1006 # All tabs are within a grey box
1007 $rv .= "<table width=100% cellpadding=0 cellspacing=0 border=0>\n";
1008 $rv .= "<tr> <td bgcolor=#ffffff rowspan=3 width=1><img src=$imgdir/1x1.gif></td>\n";
1009 $rv .= "<td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1010 $rv .= "<tr> <td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1011 $rv .= "<td valign=top>";
1013 $main::ui_tabs_selected = $sel;
1017 # ui_tabs_end(border)
1020 return &theme_ui_tabs_end(@_) if (defined(&theme_ui_tabs_end));
1021 local ($border) = @_;
1023 local $imgdir = "$gconfig{'webprefix'}/images";
1026 $rv .= "<td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1028 $rv .= "<tr> <td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1029 $rv .= "</table>\n";
1034 # ui_tabs_start_tab(name, tab)
1035 # Must be called before outputting the HTML for the named tab
1036 sub ui_tabs_start_tab
1038 return &theme_ui_tabs_start_tab(@_) if (defined(&theme_ui_tabs_start_tab));
1039 local ($name, $tab) = @_;
1040 local $defclass = $tab eq $main::ui_tabs_selected ?
1041 'opener_shown' : 'opener_hidden';
1042 local $rv = "<div id='div_$tab' class='$defclass'>\n";
1046 # ui_tabs_start_tabletab(name, tab)
1047 # Behaves like ui_tabs_start_tab, but for use within a ui_table_start block
1048 sub ui_tabs_start_tabletab
1050 return &theme_ui_tabs_start_tabletab(@_)
1051 if (defined(&theme_ui_tabs_start_tabletab));
1052 local $div = &ui_tabs_start_tab(@_);
1053 return "</table>\n".$div."<table width=100%>\n";
1058 return &theme_ui_tabs_end_tab(@_) if (defined(&theme_ui_tabs_end_tab));
1062 sub ui_tabs_end_tabletab
1064 return &theme_ui_tabs_end_tabletab(@_)
1065 if (defined(&theme_ui_tabs_end_tabletab));
1066 return "</table></div><table width=100%>\n";
1069 # ui_max_text_width(width, [text-area?])
1070 # Returns a new width for a text field, based on theme settings
1071 sub ui_max_text_width
1073 local ($w, $ta) = @_;
1074 local $max = $ta ? $tconfig{'maxareawidth'} : $tconfig{'maxboxwidth'};
1075 return $max && $w > $max ? $max : $w;
1078 ####################### radio hidden functions
1080 # ui_radio_selector(&opts, name, selected)
1081 # Returns HTML for a set of radio buttons, each of which shows a different
1082 # block of HTML when selected. &opts is an array ref to arrays containing
1083 # [ value, label, html ]
1084 sub ui_radio_selector
1086 return &theme_ui_radio_selector(@_) if (defined(&theme_ui_radio_selector));
1087 local ($opts, $name, $sel) = @_;
1089 if (!$main::ui_radio_selector_donejs++) {
1090 $rv .= &ui_radio_selector_javascript();
1093 "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$opts)."]";
1094 foreach my $o (@$opts) {
1095 $rv .= &ui_oneradio($name, $o->[0], $o->[1], $sel eq $o->[0],
1096 "onClick='selector_show(\"$name\", \"$o->[0]\", $optnames)'");
1099 foreach my $o (@$opts) {
1100 local $cls = $o->[0] eq $sel ? "selector_shown" : "selector_hidden";
1101 $rv .= "<div id=sel_${name}_$o->[0] class=$cls>".$o->[2]."</div>\n";
1106 sub ui_radio_selector_javascript
1110 .selector_shown {display:inline}
1111 .selector_hidden {display:none}
1114 function selector_show(name, value, values)
1116 for(var i=0; i<values.length; i++) {
1117 var divobj = document.getElementById('sel_'+name+'_'+values[i]);
1118 divobj.className = value == values[i] ? 'selector_shown'
1119 : 'selector_hidden';
1126 ####################### grid layout functions
1128 # ui_grid_table(&elements, columns, [width-percent], [tds], [tabletags],
1130 # Given a list of HTML elements, formats them into a table with the given
1131 # number of columns. However, themes are free to override this to use fewer
1132 # columns where space is limited.
1135 return &theme_ui_grid_table(@_) if (defined(&theme_ui_grid_table));
1136 local ($elements, $cols, $width, $tds, $tabletags, $title) = @_;
1137 return "" if (!@$elements);
1138 local $rv = "<table".
1139 ($width ? " width=$width%" : "").
1140 ($tabletags ? " ".$tabletags : "").
1143 for($i=0; $i<@$elements; $i++) {
1144 $rv .= "<tr>" if ($i%$cols == 0);
1145 $rv .= "<td ".$tds->[$i%$cols]." valign=top>".$elements->[$i]."</td>\n";
1146 $rv .= "</tr>" if ($i%$cols == $cols-1);
1150 $rv .= "<td ".$tds->[$i%$cols]."><br></td>\n";
1155 $rv .= "</table>\n";
1156 if (defined($title)) {
1157 $rv = "<table class=ui_table border ".
1158 ($width ? " width=$width%" : "").">\n".
1159 ($title ? "<tr $tb> <td><b>$title</b></td> </tr>\n" : "").
1160 "<tr $cb> <td>$rv</td> </tr>\n".
1166 # ui_radio_table(name, selected, &rows)
1167 # Returns HTML for a table of radio buttons, each of which has a label and
1168 # some associated inputs to the right.
1171 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
1172 local ($name, $sel, $rows) = @_;
1173 return "" if (!@$rows);
1174 local $rv = "<table>\n";
1175 foreach my $r (@$rows) {
1177 $rv .= "<td valign=top><b>".&ui_oneradio($name, $r->[0], $r->[1],
1178 $r->[0] eq $sel)."</b></td>\n";
1179 $rv .= "<td valign=top>".$r->[2]."</td>\n";
1182 $rv .= "</table>\n";
1186 # ui_up_down_arrows(uplink, downlink, up-show, down-show)
1187 # Returns HTML for moving some objects in a table up or down
1188 sub ui_up_down_arrows
1190 return &theme_ui_up_down_arrows(@_) if (defined(&theme_ui_up_down_arrows));
1191 local ($uplink, $downlink, $upshow, $downshow) = @_;
1193 local $imgdir = "$gconfig{'webprefix'}/images";
1195 $mover .= "<a href=\"$downlink\">".
1196 "<img src=$imgdir/movedown.gif border=0></a>";
1199 $mover .= "<img src=$imgdir/movegap.gif>";
1202 $mover .= "<a href=\"$uplink\">".
1203 "<img src=$imgdir/moveup.gif border=0></a>";
1206 $mover .= "<img src=$imgdir/movegap.gif>";
1212 # Returns a horizontal row tag
1215 return &theme_ui_hr() if (defined(&theme_ui_hr));
1219 ####################### javascript functions
1221 # js_disable_input(&disable-inputs, &enable-inputs, [tag])
1222 # Returns Javascript to disable some form elements and enable others
1223 sub js_disable_inputs
1227 foreach $f (@{$_[0]}) {
1228 $rv .= "e = form.elements[\"$f\"]; e.disabled = true; ";
1229 $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = true; } ";
1231 foreach $f (@{$_[1]}) {
1232 $rv .= "e = form.elements[\"$f\"]; e.disabled = false; ";
1233 $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = false; } ";
1235 foreach $f (@{$_[1]}) {
1236 if ($f =~ /^(.*)_def$/ && &indexof($1, @{$_[1]}) >= 0) {
1237 # When enabling both a _def field and its associated text field,
1238 # disable the text if the _def is set to 1
1240 $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 } } ";
1243 return $_[2] ? "$_[2]='$rv'" : $rv;
1246 # js_checkbox_disable(name, &checked-disable, &checked-enable, [tag])
1247 sub js_checkbox_disable
1251 foreach $f (@{$_[1]}) {
1252 $rv .= "form.elements[\"$f\"].disabled = $_[0].checked; ";
1254 foreach $f (@{$_[2]}) {
1255 $rv .= "form.elements[\"$f\"].disabled = !$_[0].checked; ";
1257 return $_[3] ? "$_[3]='$rv'" : $rv;