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 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);
  17         }
  18 local $rv;
  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;
  25 return $rv;
  26 }
  27
  28 # ui_table_end()
  29 # The end of a table started by ui_table_start
  30 sub ui_table_end
  31 {
  32 return &theme_ui_table_end(@_) if (defined(&theme_ui_table_end));
  33 local $rv;
  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(" ", " ");
  37         }
  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);
  42         }
  43 else {
  44         $main::ui_table_cols = undef;
  45         $main::ui_table_pos = undef;
  46         $main::ui_table_default_tds = undef;
  47         }
  48 $rv .= "</table></td></tr></table>\n";
  49 return $rv;
  50 }
  51
  52 # ui_columns_start(&headings, [width-percent], [noborder], [&tdtags], [heading])
  53 # Returns HTML for a multi-column table, with the given headings
  54 sub ui_columns_start
  55 {
  56 return &theme_ui_columns_start(@_) if (defined(&theme_ui_columns_start));
  57 local ($heads, $width, $noborder, $tdtags, $title) = @_;
  58 local $rv;
  59 $rv .= "<table".($noborder ? "" : " border").
  60                 (defined($width) ? " width=$width%" : "")." class='ui_columns'>\n";
  61 if ($title) {
  62         $rv .= "<tr $tb><td colspan=".scalar(@$heads).
  63                " class='ui_columns_heading'><b>$title</b></td></tr>\n";
  64         }
  65 $rv .= "<tr $tb class='ui_columns_heads'>\n";
  66 local $i;
  67 for($i=0; $i<@$heads; $i++) {
  68         $rv .= "<td ".$tdtags->[$i]."><b>".
  69                ($heads->[$i] eq "" ? "<br>" : $heads->[$i])."</b></td>\n";
  70         }
  71 $rv .= "</tr>\n";
  72 return $rv;
  73 }
  74
  75 # ui_columns_row(&columns, &tdtags)
  76 # Returns HTML for a row in a multi-column table
  77 sub ui_columns_row
  78 {
  79 return &theme_ui_columns_row(@_) if (defined(&theme_ui_columns_row));
  80 local ($cols, $tdtags) = @_;
  81 local $rv;
  82 $rv .= "<tr $cb class='ui_columns_row'>\n";
  83 local $i;
  84 for($i=0; $i<@$cols; $i++) {
  85         $rv .= "<td ".$tdtags->[$i].">".
  86                ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i])."</td>\n";
  87         }
  88 $rv .= "</tr>\n";
  89 return $rv;
  90 }
  91
  92 # ui_columns_header(&columns, &tdtags)
  93 # Returns HTML for a row in a multi-column table, with a header background
  94 sub ui_columns_header
  95 {
  96 return &theme_ui_columns_header(@_) if (defined(&theme_ui_columns_header));
  97 local ($cols, $tdtags) = @_;
  98 local $rv;
  99 $rv .= "<tr $tb class='ui_columns_header'>\n";
 100 local $i;
 101 for($i=0; $i<@$cols; $i++) {
 102         $rv .= "<td ".$tdtags->[$i]."><b>".
 103                ($cols->[$i] eq "" ? "<br>" : $cols->[$i])."</b></td>\n";
 104         }
 105 $rv .= "</tr>\n";
 106 return $rv;
 107 }
 108
 109 # ui_checked_columns_row(&columns, &tdtags, checkname, checkvalue, [checked?],
 110 #                        [disabled])
 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
 114 {
 115 return &theme_ui_checked_columns_row(@_) if (defined(&theme_ui_checked_columns_row));
 116 local ($cols, $tdtags, $checkname, $checkvalue, $checked, $disabled) = @_;
 117 local $rv;
 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).
 121        "</td>\n";
 122 local $i;
 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                         &quote_escape("${checkname}_${checkvalue}")."\">";
 128                 }
 129         $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
 130         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
 131                 $rv .= "</label>";
 132                 }
 133         $rv .= "</td>\n";
 134         }
 135 $rv .= "</tr>\n";
 136 return $rv;
 137 }
 138
 139 # ui_radio_columns_row(&columns, &tdtags, checkname, checkvalue, [checked],
 140 #                      [disabled])
 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
 144 {
 145 return &theme_ui_radio_columns_row(@_) if (defined(&theme_ui_radio_columns_row));
 146 local ($cols, $tdtags, $checkname, $checkvalue, $checked, $dis) = @_;
 147 local $rv;
 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";
 151 local $i;
 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                         &quote_escape("${checkname}_${checkvalue}")."\">";
 157                 }
 158         $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
 159         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
 160                 $rv .= "</label>";
 161                 }
 162         $rv .= "</td>\n";
 163         }
 164 $rv .= "</tr>\n";
 165 return $rv;
 166 }
 167
 168 # ui_columns_end()
 169 # Returns HTML to end a table started by ui_columns_start
 170 sub ui_columns_end
 171 {
 172 return &theme_ui_columns_end(@_) if (defined(&theme_ui_columns_end));
 173 return "</table>\n";
 174 }
 175
 176 # ui_columns_table(&headings, width-percent, &data, &types, no-sort, title,
 177 #                  empty-msg)
 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 }
 185 #          { 'type' => 'checkbox', 'name' => 'd', 'value' => 'foo',
 186 #            'label' => 'Yes', 'checked' => 1, 'disabled' => 1 }
 187 #          { 'type' => 'radio', 'name' => 'd', 'value' => 'foo', ... }
 188 # types - An array ref of data types, such as 'string', 'number', 'bytes'
 189 #         or 'date'
 190 # no-sort - Set to 1 to disable sorting by theme
 191 # title - Text to appear above the table
 192 # empty-msg - Message to display if no data
 193 sub ui_columns_table
 194 {
 195 return &theme_ui_columns_table(@_) if (defined(&theme_ui_columns_table));
 196 local ($heads, $width, $data, $types, $nosort, $title, $emptymsg) = @_;
 197 local $rv;
 198
 199 # Just show empty message if no data
 200 if ($emptymsg && !@$data) {
 201         $rv .= &ui_subheading($title) if ($title);
 202         $rv .= "<b>$emptymsg</b><p>\n";
 203         return $rv;
 204         }
 205
 206 # Are there any checkboxes in each column? If so, make those columns narrow
 207 local @tds = ( );
 208 local $maxwidth = 0;
 209 foreach my $r (@$data) {
 210         local $cc = 0;
 211         foreach my $c (@$r) {
 212                 if (ref($c) &&
 213                     ($c->{'type'} eq 'checkbox' || $c->{'type'} eq 'radio')) {
 214                         $tds[$cc] = "width=5";
 215                         }
 216                 $cc++;
 217                 }
 218         $maxwidth = $cc if ($cc > $maxwidth);
 219         }
 220 $rv .= &ui_columns_start($heads, $width, $noborder, \@tds, $title);
 221
 222 # Add the data rows
 223 foreach my $r (@$data) {
 224         local $c0;
 225         if (ref($r->[0]) && ($r->[0]->{'type'} eq 'checkbox' ||
 226                              $r->[0]->{'type'} eq 'radio')) {
 227                 # First column is special
 228                 $c0 = $r->[0];
 229                 $r = [ @$r[1..(@$r-1)] ];
 230                 }
 231         # Turn data into HTML
 232         local @rtds = @tds;
 233         local @cols;
 234         foreach my $c (@$r) {
 235                 if (!ref($c)) {
 236                         # Plain old string
 237                         push(@cols, $c);
 238                         }
 239                 elsif ($c->{'type'} eq 'checkbox') {
 240                         # Checkbox in non-first column
 241                         push(@cols, &ui_checkbox($c->{'name'}, $c->{'value'},
 242                                                  $c->{'label'}, $c->{'checked'},
 243                                                  undef, $c->{'disabled'}));
 244                         }
 245                 elsif ($c->{'type'} eq 'radio') {
 246                         # Radio button in non-first column
 247                         push(@cols, &ui_oneradio($c->{'name'}, $c->{'value'},
 248                                                  $c->{'label'}, $c->{'checked'},
 249                                                  undef, $c->{'disabled'}));
 250                         }
 251                 elsif ($c->{'type'} eq 'group') {
 252                         # Header row that spans whole table
 253                         $rv .= &ui_columns_header([ $c->{'desc'} ],
 254                                                   [ "colspan=$width" ]);
 255                         next;
 256                         }
 257                 elsif ($c->{'type'} eq 'string') {
 258                         # A string, which might be special
 259                         push(@cols, $c->{'value'});
 260                         if ($c->{'columns'} > 1) {
 261                                 splice(@rtds, 0, $c->{'columns'},
 262                                        "colspan=".$c->{'columns'});
 263                                 }
 264                         }
 265                 }
 266         # Add the row
 267         if (!$c0) {
 268                 $rv .= &ui_columns_row(\@cols, \@rtds);
 269                 }
 270         elsif ($c0->{'type'} eq 'checkbox') {
 271                 $rv .= &ui_checked_columns_row(\@cols, \@rtds, $c0->{'name'},
 272                                                $c0->{'value'}, $c0->{'checked'},
 273                                                $c0->{'disabled'});
 274                 }
 275         elsif ($c0->{'type'} eq 'radio') {
 276                 $rv .= &ui_radio_columns_row(\@cols, \@rtds, $c0->{'name'},
 277                                              $c0->{'value'}, $c0->{'checked'},
 278                                              $c0->{'disabled'});
 279                 }
 280         }
 281
 282 $rv .= &ui_columns_end();
 283 return $rv;
 284 }
 285
 286 # ui_form_columns_table(cgi, &buttons, select-all, &otherlinks, &hiddens,
 287 #                       &headings, width-percent, &data, &types, no-sort, title,
 288 #                       empty-msg)
 289 # Similar to ui_columns_table, but wrapped in a form. Args are :
 290 # cgi - URL to submit the form to
 291 # buttons - An array ref of buttons at the end of the form, similar to
 292 #           that taken by ui_form_end
 293 # select-all - If set to 1, include select all / invert links
 294 # otherslinks - An array ref of other links to put at the top of the table,
 295 #               each of which is a 3-element hash ref of url, text and
 296 #               alignment (left or right)
 297 # hiddens - An array ref of hidden fields, each of which is a 2-element array
 298 #           ref containing the name and value
 299 # All other parameters are the same as ui_columns_table
 300 sub ui_form_columns_table
 301 {
 302 return &theme_ui_form_columns_table(@_)
 303         if (defined(&theme_ui_form_columns_table));
 304 local ($cgi, $buttons, $selectall, $others, $hiddens,
 305        $heads, $width, $data, $types, $nosort, $title, $emptymsg) = @_;
 306 local $rv;
 307
 308 # Build links
 309 local @leftlinks = map { "<a href='$_->[0]'>$_->[1]</a>" }
 310                        grep { $_->[2] ne 'right' } @$others;
 311 local @rightlinks = map { "<a href='$_->[0]'>$_->[1]</a>" }
 312                        grep { $_->[2] eq 'right' } @$others;
 313 local $links;
 314
 315 # Add select links
 316 if (@$data) {
 317         if ($selectall) {
 318                 local $cbname;
 319                 foreach my $r (@$data) {
 320                         foreach my $c (@$r) {
 321                                 if (ref($c) && $c->{'type'} eq 'checkbox') {
 322                                         $cbname = $c->{'name'};
 323                                         last;
 324                                         }
 325                                 }
 326                         }
 327                 if ($cbname) {
 328                         unshift(@leftlinks, &select_all_link("d"),
 329                                             &select_invert_link("d"));
 330                         }
 331                 }
 332         }
 333
 334 # Turn to HTML
 335 if (@rightlinks) {
 336         $links = &ui_grid_table([ &ui_links_row(\@leftlinks),
 337                                   &ui_links_row(\@rightlinks) ], 2, 100,
 338                                 [ undef, "align=right" ]);
 339         }
 340 elsif (@leftlinks) {
 341         $links = &ui_links_row(\@leftlinks);
 342         }
 343
 344 # Start the form, if we need one
 345 if (@$data) {
 346         $rv .= &ui_form_start($cgi, "post");
 347         foreach my $h (@$hiddens) {
 348                 $rv .= &ui_hidden(@$h);
 349                 }
 350         $rv .= $links;
 351         }
 352
 353 # Add the table
 354 $rv .= &ui_columns_table($heads, $width, $data, $types, $nosort, $title,
 355                          $emptymsg);
 356
 357 # Add form end
 358 $rv .= $links;
 359 if (@$data) {
 360         $rv .= &ui_form_end($buttons);
 361         }
 362
 363 return $rv;
 364 }
 365
 366 ####################### form generation functions
 367
 368 # ui_form_start(script, method, [target], [tags])
 369 # Returns HTML for a form that submits to some script
 370 sub ui_form_start
 371 {
 372 return &theme_ui_form_start(@_) if (defined(&theme_ui_form_start));
 373 local ($script, $method, $target, $tags) = @_;
 374 local $rv;
 375 $rv .= "<form class='ui_form' action='".&html_escape($script)."' ".
 376         ($method eq "post" ? "method=post" :
 377          $method eq "form-data" ?
 378                 "method=post enctype=multipart/form-data" :
 379                 "method=get").
 380         ($target ? " target=$target" : "").
 381         " ".$tags.
 382        ">\n";
 383 return $rv;
 384 }
 385
 386 # ui_form_end([&buttons], [width])
 387 # Returns HTML for the end of a form, optionally with a row of submit buttons
 388 sub ui_form_end
 389 {
 390 return &theme_ui_form_end(@_) if (defined(&theme_ui_form_end));
 391 local ($buttons, $width) = @_;
 392 local $rv;
 393 if ($buttons && @$buttons) {
 394         $rv .= "<table class='ui_form_end_buttons' ".($width ? " width=$width" : "")."><tr>\n";
 395         local $b;
 396         foreach $b (@$buttons) {
 397                 if (ref($b)) {
 398                         $rv .= "<td".(!$width ? "" :
 399                                       $b eq $buttons->[0] ? " align=left" :
 400                                       $b eq $buttons->[@$buttons-1] ?
 401                                         " align=right" : " align=center").">".
 402                                &ui_submit($b->[1], $b->[0], $b->[3], $b->[4]).
 403                                ($b->[2] ? " ".$b->[2] : "")."</td>\n";
 404                         }
 405                 elsif ($b) {
 406                         $rv .= "<td>$b</td>\n";
 407                         }
 408                 else {
 409                         $rv .= "<td>&nbsp;&nbsp;</td>\n";
 410                         }
 411                 }
 412         $rv .= "</tr></table>\n";
 413         }
 414 $rv .= "</form>\n";
 415 return $rv;
 416 }
 417
 418 # ui_textbox(name, value, size, [disabled?], [maxlength], [tags])
 419 # Returns HTML for a text input
 420 sub ui_textbox
 421 {
 422 return &theme_ui_textbox(@_) if (defined(&theme_ui_textbox));
 423 local ($name, $value, $size, $dis, $max, $tags) = @_;
 424 $size = &ui_max_text_width($size);
 425 return "<input name=\"".&quote_escape($name)."\" ".
 426        "value=\"".&quote_escape($value)."\" ".
 427        "size=$size ".($dis ? "disabled=true" : "").
 428        ($max ? " maxlength=$max" : "").
 429        " ".$tags.
 430        ">";
 431 }
 432
 433 # ui_bytesbox(name, bytes, [size], [disabled?])
 434 # Returns HTML for entering a number of bytes, but with friendly kB/MB/GB
 435 # options. May truncate values to 2 decimal points!
 436 sub ui_bytesbox
 437 {
 438 local ($name, $bytes, $size, $dis) = @_;
 439 local $units = 1;
 440 if ($bytes >= 10*1024*1024*1024) {
 441         $units = 1024*1024*1024;
 442         }
 443 elsif ($bytes >= 10*1024*1024) {
 444         $units = 1024*1024;
 445         }
 446 elsif ($bytes >= 10*1024) {
 447         $units = 1024;
 448         }
 449 else {
 450         $units = 1;
 451         }
 452 if ($bytes ne "") {
 453         $bytes = sprintf("%.2f", ($bytes*1.0)/$units);
 454         $bytes =~ s/\.00$//;
 455         }
 456 $size = &ui_max_text_width($size || 8);
 457 return &ui_textbox($name, $bytes, $size, $dis)." ".
 458        &ui_select($name."_units", $units,
 459                  [ [ 1, "bytes" ], [ 1024, "kB" ], [ 1024*1024, "MB" ],
 460                    [ 1024*1024*1024, "GB" ] ], undef, undef, undef, $dis);
 461 }
 462
 463 # ui_upload(name, size, [disabled?], [tags])
 464 # Returns HTML for a file upload input
 465 sub ui_upload
 466 {
 467 return &theme_ui_upload(@_) if (defined(&theme_ui_upload));
 468 local ($name, $size, $dis, $tags) = @_;
 469 $size = &ui_max_text_width($size);
 470 return "<input type=file name=\"".&quote_escape($name)."\" ".
 471        "size=$size ".
 472        ($dis ? "disabled=true" : "").
 473        ($tags ? " ".$tags : "").">";
 474 }
 475
 476 # ui_password(name, value, size, [disabled?], [maxlength])
 477 # Returns HTML for a password text input
 478 sub ui_password
 479 {
 480 return &theme_ui_password(@_) if (defined(&theme_ui_password));
 481 local ($name, $value, $size, $dis, $max) = @_;
 482 $size = &ui_max_text_width($size);
 483 return "<input type=password name=\"".&quote_escape($name)."\" ".
 484        "value=\"".&quote_escape($value)."\" ".
 485        "size=$size ".($dis ? "disabled=true" : "").
 486        ($max ? " maxlength=$max" : "").
 487        ">";
 488 }
 489
 490 # ui_hidden(name, value)
 491 # Returns HTML for a hidden field
 492 sub ui_hidden
 493 {
 494 return &theme_ui_hidden(@_) if (defined(&theme_ui_hidden));
 495 local ($name, $value) = @_;
 496 return "<input type=hidden name=\"".&quote_escape($name)."\" ".
 497        "value=\"".&quote_escape($value)."\">\n";
 498 }
 499
 500 # ui_select(name, value|&values, &options, [size], [multiple],
 501 #           [add-if-missing], [disabled?], [javascript])
 502 # Returns HTML for a drop-down menu or multiple selection list
 503 sub ui_select
 504 {
 505 return &theme_ui_select(@_) if (defined(&theme_ui_select));
 506 local ($name, $value, $opts, $size, $multiple, $missing, $dis, $js) = @_;
 507 local $rv;
 508 $rv .= "<select name=\"".&quote_escape($name)."\"".
 509        ($size ? " size=$size" : "").
 510        ($multiple ? " multiple" : "").
 511        ($dis ? " disabled=true" : "")." ".$js.">\n";
 512 local ($o, %opt, $s);
 513 local %sel = ref($value) ? ( map { $_, 1 } @$value ) : ( $value, 1 );
 514 foreach $o (@$opts) {
 515         $o = [ $o ] if (!ref($o));
 516         $rv .= "<option value=\"".&quote_escape($o->[0])."\"".
 517                ($sel{$o->[0]} ? " selected" : "").">".
 518                ($o->[1] || $o->[0])."\n";
 519         $opt{$o->[0]}++;
 520         }
 521 foreach $s (keys %sel) {
 522         if (!$opt{$s} && $missing) {
 523                 $rv .= "<option value=\"".&quote_escape($s)."\"".
 524                        "selected>".($s eq "" ? "&nbsp;" : $s)."\n";
 525                 }
 526         }
 527 $rv .= "</select>\n";
 528 return $rv;
 529 }
 530
 531 # ui_radio(name, value, &options, [disabled?])
 532 # Returns HTML for a series of radio buttons
 533 sub ui_radio
 534 {
 535 return &theme_ui_radio(@_) if (defined(&theme_ui_radio));
 536 local ($name, $value, $opts, $dis) = @_;
 537 local $rv;
 538 local $o;
 539 foreach $o (@$opts) {
 540         local $id = &quote_escape($name."_".$o->[0]);
 541         local $label = $o->[1] || $o->[0];
 542         local $after;
 543         if ($label =~ /^(.*?)((<a\s+href|<input|<select|<textarea)[\000-\377]*)$/i) {
 544                 $label = $1;
 545                 $after = $2;
 546                 }
 547         $rv .= "<input type=radio name=\"".&quote_escape($name)."\" ".
 548                "value=\"".&quote_escape($o->[0])."\"".
 549                ($o->[0] eq $value ? " checked" : "").
 550                ($dis ? " disabled=true" : "").
 551                " id=\"$id\"".
 552                " $o->[2]> <label for=\"$id\">".
 553                $label."</label>".$after."\n";
 554         }
 555 return $rv;
 556 }
 557
 558 # ui_yesno_radio(name, value, [yes], [no], [disabled?])
 559 # Like ui_yesno, but always displays just two inputs (yes and no)
 560 sub ui_yesno_radio
 561 {
 562 local ($name, $value, $yes, $no, $dis) = @_;
 563 return &theme_ui_yesno_radio(@_) if (defined(&theme_ui_yesno_radio));
 564 $yes = 1 if (!defined($yes));
 565 $no = 0 if (!defined($no));
 566 $value = int($value);
 567 return &ui_radio($name, $value, [ [ $yes, $text{'yes'} ],
 568                                   [ $no, $text{'no'} ] ], $dis);
 569 }
 570
 571 # ui_checkbox(name, value, label, selected?, [tags], [disabled?])
 572 # Returns HTML for a single checkbox
 573 sub ui_checkbox
 574 {
 575 return &theme_ui_checkbox(@_) if (defined(&theme_ui_checkbox));
 576 local ($name, $value, $label, $sel, $tags, $dis) = @_;
 577 local $after;
 578 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
 579         $label = $1;
 580         $after = $2;
 581         }
 582 return "<input type=checkbox name=\"".&quote_escape($name)."\" ".
 583        "value=\"".&quote_escape($value)."\" ".
 584        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
 585        " id=\"".&quote_escape("${name}_${value}")."\"".
 586        " $tags> ".
 587        ($label eq "" ? $after :
 588          "<label for=\"".&quote_escape("${name}_${value}").
 589          "\">$label</label>$after")."\n";
 590 }
 591
 592 # ui_oneradio(name, value, label, selected?, [tags], [disabled?])
 593 # Returns HTML for a single radio button
 594 sub ui_oneradio
 595 {
 596 return &theme_ui_oneradio(@_) if (defined(&theme_ui_oneradio));
 597 local ($name, $value, $label, $sel, $tags, $dis) = @_;
 598 local $id = &quote_escape("${name}_${value}");
 599 local $after;
 600 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
 601         $label = $1;
 602         $after = $2;
 603         }
 604 return "<input type=radio name=\"".&quote_escape($name)."\" ".
 605        "value=\"".&quote_escape($value)."\" ".
 606        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
 607        " id=\"$id\"".
 608        " $tags> <label for=\"$id\">$label</label>$after\n";
 609 }
 610
 611 # ui_textarea(name, value, rows, cols, [wrap], [disabled?], [tags])
 612 # Returns HTML for a multi-line text input
 613 sub ui_textarea
 614 {
 615 return &theme_ui_textarea(@_) if (defined(&theme_ui_textarea));
 616 local ($name, $value, $rows, $cols, $wrap, $dis, $tags) = @_;
 617 $cols = &ui_max_text_width($cols, 1);
 618 return "<textarea name=\"".&quote_escape($name)."\" ".
 619        "rows=$rows cols=$cols".($wrap ? " wrap=$wrap" : "").
 620        ($dis ? " disabled=true" : "").
 621        ($tags ? " $tags" : "").">".
 622        &html_escape($value).
 623        "</textarea>";
 624 }
 625
 626 # ui_user_textbox(name, value, [form], [disabled?], [tags])
 627 # Returns HTML for a Unix user input
 628 sub ui_user_textbox
 629 {
 630 return &theme_ui_user_textbox(@_) if (defined(&theme_ui_user_textbox));
 631 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
 632        &user_chooser_button($_[0], 0, $_[2]);
 633 }
 634
 635 # ui_group_textbox(name, value, [form], [disabled?], [tags])
 636 # Returns HTML for a Unix group input
 637 sub ui_group_textbox
 638 {
 639 return &theme_ui_group_textbox(@_) if (defined(&theme_ui_group_textbox));
 640 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
 641        &group_chooser_button($_[0], 0, $_[2]);
 642 }
 643
 644 # ui_opt_textbox(name, value, size, option1, [option2], [disabled?],
 645 #                [&extra-fields], [max])
 646 # Returns HTML for a text field that is optional
 647 sub ui_opt_textbox
 648 {
 649 return &theme_ui_opt_textbox(@_) if (defined(&theme_ui_opt_textbox));
 650 local ($name, $value, $size, $opt1, $opt2, $dis, $extra, $max) = @_;
 651 local $dis1 = &js_disable_inputs([ $name, @$extra ], [ ]);
 652 local $dis2 = &js_disable_inputs([ ], [ $name, @$extra ]);
 653 local $rv;
 654 $size = &ui_max_text_width($size);
 655 $rv .= &ui_radio($name."_def", $value eq '' ? 1 : 0,
 656                  [ [ 1, $opt1, "onClick='$dis1'" ],
 657                    [ 0, $opt2 || " ", "onClick='$dis2'" ] ], $dis)."\n";
 658 $rv .= "<input name=\"".&quote_escape($name)."\" ".
 659        "size=$size value=\"".&quote_escape($value)."\" ".
 660        ($value eq "" || $dis ? "disabled=true" : "").
 661        ($max ? " maxlength=$max" : "").">\n";
 662 return $rv;
 663 }
 664
 665 # ui_submit(label, [name], [disabled?], [tags])
 666 # Returns HTML for a form submit button
 667 sub ui_submit
 668 {
 669 return &theme_ui_submit(@_) if (defined(&theme_ui_submit));
 670 local ($label, $name, $dis, $tags) = @_;
 671 return "<input type=submit".
 672        ($name ne '' ? " name=\"".&quote_escape($name)."\"" : "").
 673        " value=\"".&quote_escape($label)."\"".
 674        ($dis ? " disabled=true" : "").
 675        ($tags ? " ".$tags : "").">\n";
 676
 677 }
 678
 679 # ui_reset(label, [disabled?])
 680 # Returns HTML for a form reset button
 681 sub ui_reset
 682 {
 683 return &theme_ui_reset(@_) if (defined(&theme_ui_reset));
 684 local ($label, $dis) = @_;
 685 return "<input type=reset value=\"".&quote_escape($label)."\"".
 686        ($dis ? " disabled=true" : "").">\n";
 687
 688 }
 689
 690 # ui_button(label, [name], [disabled?], [tags])
 691 # Returns HTML for a form button
 692 sub ui_button
 693 {
 694 return &theme_ui_button(@_) if (defined(&theme_ui_button));
 695 local ($label, $name, $dis, $tags) = @_;
 696 return "<input type=button".
 697        ($name ne '' ? " name=\"".&quote_escape($name)."\"" : "").
 698        " value=\"".&quote_escape($label)."\"".
 699        ($dis ? " disabled=true" : "").
 700        ($tags ? " ".$tags : "").">\n";
 701 }
 702
 703 # ui_date_input(day, month, year, day-name, month-name, year-name, [disabled?])
 704 # Returns HTML for a date-selection field
 705 sub ui_date_input
 706 {
 707 local ($day, $month, $year, $dayname, $monthname, $yearname, $dis) = @_;
 708 local $rv;
 709 $rv .= &ui_textbox($dayname, $day, 3, $dis);
 710 $rv .= "/";
 711 $rv .= &ui_select($monthname, $month,
 712                   [ map { [ $_, $text{"smonth_$_"} ] } (1 .. 12) ],
 713                   1, 0, 0, $dis);
 714 $rv .= "/";
 715 $rv .= &ui_textbox($yearname, $year, 5, $dis);
 716 return $rv;
 717 }
 718
 719 # ui_table_row(label, value, [cols], [&td-tags])
 720 # Returns HTML for a row in a table started by ui_table_start, with a 1-column
 721 # label and 1+ column value.
 722 sub ui_table_row
 723 {
 724 return &theme_ui_table_row(@_) if (defined(&theme_ui_table_row));
 725 local ($label, $value, $cols, $tds) = @_;
 726 $cols ||= 1;
 727 $tds ||= $main::ui_table_default_tds;
 728 local $rv;
 729 if ($main::ui_table_pos+$cols+1 > $main::ui_table_cols &&
 730     $main::ui_table_pos != 0) {
 731         # If the requested number of cols won't fit in the number
 732         # remaining, start a new row
 733         $rv .= "</tr>\n";
 734         $main::ui_table_pos = 0;
 735         }
 736 $rv .= "<tr>\n" if ($main::ui_table_pos%$main::ui_table_cols == 0);
 737 $rv .= "<td valign=top $tds->[0]><b>$label</b></td>\n" if (defined($label));
 738 $rv .= "<td valign=top colspan=$cols $tds->[1]>$value</td>\n";
 739 $main::ui_table_pos += $cols+(defined($label) ? 1 : 0);
 740 if ($main::ui_table_pos%$main::ui_table_cols == 0) {
 741         $rv .= "</tr>\n";
 742         $main::ui_table_pos = 0;
 743         }
 744 return $rv;
 745 }
 746
 747 # ui_table_hr()
 748 sub ui_table_hr
 749 {
 750 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
 751 local $rv;
 752 if ($ui_table_pos) {
 753         $rv .= "</tr>\n";
 754         $ui_table_pos = 0;
 755         }
 756 $rv .= "<tr> <td colspan=$main::ui_table_cols><hr></td> </tr>\n";
 757 return $rv;
 758 }
 759
 760 # ui_table_span(text)
 761 # Outputs a table row that spans the whole table, and contains the given text
 762 sub ui_table_span
 763 {
 764 local ($text) = @_;
 765 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
 766 local $rv;
 767 if ($ui_table_pos) {
 768         $rv .= "</tr>\n";
 769         $ui_table_pos = 0;
 770         }
 771 $rv .= "<tr> <td colspan=$main::ui_table_cols>$text</td> </tr>\n";
 772 return $rv;
 773 }
 774
 775 # ui_buttons_start()
 776 sub ui_buttons_start
 777 {
 778 return &theme_ui_buttons_start(@_) if (defined(&theme_ui_buttons_start));
 779 return "<table width=100%>\n";
 780 }
 781
 782 # ui_buttons_end()
 783 sub ui_buttons_end
 784 {
 785 return &theme_ui_buttons_end(@_) if (defined(&theme_ui_buttons_end));
 786 return "</table>\n";
 787 }
 788
 789 # ui_buttons_row(script, button-label, description, [hiddens], [after-submit],
 790 #                [before-submit])
 791 sub ui_buttons_row
 792 {
 793 return &theme_ui_buttons_row(@_) if (defined(&theme_ui_buttons_row));
 794 local ($script, $label, $desc, $hiddens, $after, $before) = @_;
 795 return "<form action=$script>\n".
 796        $hiddens.
 797        "<tr> <td nowrap width=20% valign=top>".($before ? $before." " : "").
 798        &ui_submit($label).($after ? " ".$after : "")."</td>\n".
 799        "<td valign=top width=80% valign=top>$desc</td> </tr>\n".
 800        "</form>\n";
 801 }
 802
 803 # ui_buttons_hr([title])
 804 sub ui_buttons_hr
 805 {
 806 local ($title) = @_;
 807 return &theme_ui_buttons_hr(@_) if (defined(&theme_ui_buttons_hr));
 808 if ($title) {
 809         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";
 810         }
 811 else {
 812         return "<tr> <td colspan=2><hr></td> </tr>\n";
 813         }
 814 }
 815
 816 ####################### header and footer functions
 817
 818 # ui_post_header([subtext])
 819 # Returns HTML to appear directly after a standard header() call
 820 sub ui_post_header
 821 {
 822 return &theme_ui_post_header(@_) if (defined(&theme_ui_post_header));
 823 local ($text) = @_;
 824 local $rv;
 825 $rv .= "<center class='ui_post_header'><font size=+1>$text</font></center>\n" if (defined($text));
 826 if (!$tconfig{'nohr'} && !$tconfig{'notophr'}) {
 827         $rv .= "<hr id='post_header_hr'>\n";
 828         }
 829 return $rv;
 830 }
 831
 832 # ui_pre_footer()
 833 # Returns HTML to appear directly before a standard footer() call
 834 sub ui_pre_footer
 835 {
 836 return &theme_ui_pre_footer(@_) if (defined(&theme_ui_pre_footer));
 837 local $rv;
 838 if (!$tconfig{'nohr'} && !$tconfig{'nobottomhr'}) {
 839         $rv .= "<hr id='pre_footer_hr'>\n";
 840         }
 841 return $rv;
 842 }
 843
 844 # ui_print_header(subtext, args...)
 845 # Print HTML for a header with the post-header line. The args are the same
 846 # as those passed to header()
 847 sub ui_print_header
 848 {
 849 &load_theme_library();
 850 return &theme_ui_print_header(@_) if (defined(&theme_ui_print_header));
 851 local ($text, @args) = @_;
 852 &header(@args);
 853 print &ui_post_header($text);
 854 }
 855
 856 # ui_print_unbuffered_header(subtext, args...)
 857 # Like ui_print_header, but ensures that output for this page is not buffered
 858 # or contained in a table.
 859 sub ui_print_unbuffered_header
 860 {
 861 &load_theme_library();
 862 return &theme_ui_print_unbuffered_header(@_) if (defined(&theme_ui_print_unbuffered_header));
 863 $| = 1;
 864 $theme_no_table = 1;
 865 &ui_print_header(@_);
 866 }
 867
 868 # ui_print_footer(args...)
 869 # Print HTML for a footer with the pre-footer line. Args are the same as those
 870 # passed to footer()
 871 sub ui_print_footer
 872 {
 873 return &theme_ui_print_footer(@_) if (defined(&theme_ui_print_footer));
 874 local @args = @_;
 875 print &ui_pre_footer();
 876 &footer(@args);
 877 }
 878
 879 # ui_config_link(text, &subs)
 880 # Returns HTML for a module config link. The first non-null sub will be
 881 # replaced with the appropriate URL.
 882 sub ui_config_link
 883 {
 884 return &theme_ui_config_link(@_) if (defined(&theme_ui_config_link));
 885 local ($text, $subs) = @_;
 886 local @subs = map { $_ || "../config.cgi?$module_name" }
 887                   ($subs ? @$subs : ( undef ));
 888 return "<p>".&text($text, @subs)."<p>\n";
 889 }
 890
 891 # ui_print_endpage(text)
 892 # Prints HTML for an error message followed by a page footer with a link to
 893 # /, then exits. Good for main page error messages.
 894 sub ui_print_endpage
 895 {
 896 return &theme_ui_print_endpage(@_) if (defined(&theme_ui_print_endpage));
 897 local ($text) = @_;
 898 print $text,"<p class='ui_footer'>\n";
 899 print "</p>\n";
 900 &ui_print_footer("/", $text{'index'});
 901 exit;
 902 }
 903
 904 # ui_subheading(text, ...)
 905 # Returns HTML for a section heading
 906 sub ui_subheading
 907 {
 908 return &theme_ui_subheading(@_) if (defined(&theme_ui_subheading));
 909 return "<h3 class='ui_subheading'>".join("", @_)."</h3>\n";
 910 }
 911
 912 # ui_links_row(&links)
 913 # Returns HTML for a row of links, like select all / invert selection / add..
 914 sub ui_links_row
 915 {
 916 return &theme_ui_links_row(@_) if (defined(&theme_ui_links_row));
 917 local ($links) = @_;
 918 return @$links ? join("\n|\n", @$links)."<br>\n"
 919                : "";
 920 }
 921
 922 ########################### collapsible section / tab functions
 923
 924 # ui_hidden_javascript()
 925 # Returns <script> and <style> sections for hiding functions and CSS
 926 sub ui_hidden_javascript
 927 {
 928 return &theme_ui_hidden_javascript(@_)
 929         if (defined(&theme_ui_hidden_javascript));
 930 local $rv;
 931 local $imgdir = "$gconfig{'webprefix'}/images";
 932 local ($jscb, $jstb) = ($cb, $tb);
 933 $jscb =~ s/'/\\'/g;
 934 $jstb =~ s/'/\\'/g;
 935
 936 return <<EOF;
 937 <style>
 938 .opener_shown {display:inline}
 939 .opener_hidden {display:none}
 940 </style>
 941 <script>
 942 // Open or close a hidden section
 943 function hidden_opener(divid, openerid)
 944 {
 945 var divobj = document.getElementById(divid);
 946 var openerobj = document.getElementById(openerid);
 947 if (divobj.className == 'opener_shown') {
 948   divobj.className = 'opener_hidden';
 949   openerobj.innerHTML = '<img border=0 src=$imgdir/closed.gif>';
 950   }
 951 else {
 952   divobj.className = 'opener_shown';
 953   openerobj.innerHTML = '<img border=0 src=$imgdir/open.gif>';
 954   }
 955 }
 956
 957 // Show a tab
 958 function select_tab(name, tabname, form)
 959 {
 960 var tabnames = document[name+'_tabnames'];
 961 var tabtitles = document[name+'_tabtitles'];
 962 for(var i=0; i<tabnames.length; i++) {
 963   var tabobj = document.getElementById('tab_'+tabnames[i]);
 964   var divobj = document.getElementById('div_'+tabnames[i]);
 965   var title = tabtitles[i];
 966   if (tabnames[i] == tabname) {
 967     // Selected table
 968     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
 969                        '<td valign=top $jscb>'+
 970                        '<img src=$imgdir/lc2.gif alt=""></td>'+
 971                        '<td $jscb nowrap>'+
 972                        '&nbsp;<b>'+title+'</b>&nbsp;</td>'+
 973                        '<td valign=top $jscb>'+
 974                        '<img src=$imgdir/rc2.gif alt=""></td>'+
 975                        '</tr></table>';
 976     divobj.className = 'opener_shown';
 977     }
 978   else {
 979     // Non-selected tab
 980     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
 981                        '<td valign=top $jstb>'+
 982                        '<img src=$imgdir/lc1.gif alt=""></td>'+
 983                        '<td $jstb nowrap>'+
 984                        '&nbsp;<a href=\\'\\' onClick=\\'return select_tab("'+
 985                        name+'", "'+tabnames[i]+'")\\'>'+title+'</a>&nbsp;</td>'+
 986                        '<td valign=top $jstb>'+
 987                        '<img src=$imgdir/rc1.gif alt=""></td>'+
 988                        '</tr></table>';
 989     divobj.className = 'opener_hidden';
 990     }
 991   }
 992 if (document.forms[0] && document.forms[0][name]) {
 993   document.forms[0][name].value = tabname;
 994   }
 995 return false;
 996 }
 997 </script>
 998 EOF
 999 }
1000
1001 # ui_hidden_start(title, name, status, thisurl)
1002 # Returns HTML for the start of a collapsible hidden section, such as for
1003 # advanced options.
1004 sub ui_hidden_start
1005 {
1006 return &theme_ui_hidden_start(@_) if (defined(&theme_ui_hidden_start));
1007 local ($title, $name, $status, $url) = @_;
1008 local $rv;
1009 if (!$main::ui_hidden_start_donejs++) {
1010         $rv .= &ui_hidden_javascript();
1011         }
1012 local $divid = "hiddendiv_$name";
1013 local $openerid = "hiddenopener_$name";
1014 local $defimg = $status ? "open.gif" : "closed.gif";
1015 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1016 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg' alt='*'></a>\n";
1017 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
1018 $rv .= "<div class='$defclass' id='$divid'>\n";
1019 return $rv;
1020 }
1021
1022 # ui_hidden_end(name)
1023 # Returns HTML for the end of a hidden section
1024 sub ui_hidden_end
1025 {
1026 return &theme_ui_hidden_end(@_) if (defined(&theme_ui_hidden_end));
1027 local ($name) = @_;
1028 return "</div>\n";
1029 }
1030
1031 # ui_hidden_table_row_start(title, name, status, thisurl)
1032 # Similar to ui_hidden_start, but for use within a table started with
1033 # ui_table_start
1034 sub ui_hidden_table_row_start
1035 {
1036 return &theme_ui_hidden_table_row_start(@_)
1037         if (defined(&theme_ui_hidden_table_row_start));
1038 local ($title, $name, $status, $url) = @_;
1039 local ($rv, $rrv);
1040 if (!$main::ui_hidden_start_donejs++) {
1041         $rv .= &ui_hidden_javascript();
1042         }
1043 local $divid = "hiddendiv_$name";
1044 local $openerid = "hiddenopener_$name";
1045 local $defimg = $status ? "open.gif" : "closed.gif";
1046 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1047 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a>\n";
1048 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
1049 $rv .= &ui_table_row(undef, $rrv, $main::ui_table_cols);
1050 $rv .= "</table>\n";
1051 $rv .= "<div class='$defclass' id='$divid'>\n";
1052 $rv .= "<table width=100%>\n";
1053 return $rv;
1054 }
1055
1056 # ui_hidden_table_row_end(name)
1057 sub ui_hidden_table_row_end
1058 {
1059 return &theme_ui_hidden_table_row_end(@_)
1060         if (defined(&theme_ui_hidden_table_row_end));
1061 local ($name) = @_;
1062 return "</table></div><table width=100%>\n";
1063 }
1064
1065 # ui_hidden_table_start(heading, [tabletags], [cols], name, status,
1066 #                       [&default-tds])
1067 # A table with a heading and table inside, and which is collapsible
1068 sub ui_hidden_table_start
1069 {
1070 return &theme_ui_hidden_table_start(@_)
1071         if (defined(&theme_ui_hidden_table_start));
1072 local ($heading, $tabletags, $cols, $name, $status, $tds) = @_;
1073 local $rv;
1074 if (!$main::ui_hidden_start_donejs++) {
1075         $rv .= &ui_hidden_javascript();
1076         }
1077 local $divid = "hiddendiv_$name";
1078 local $openerid = "hiddenopener_$name";
1079 local $defimg = $status ? "open.gif" : "closed.gif";
1080 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1081 local $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1082               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1083 $rv .= "<table class='ui_table' border $tabletags class='ui_table'>\n";
1084 $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));
1085 $rv .= "<tr $cb> <td><div class='$defclass' id='$divid'><table width=100%>\n";
1086 $main::ui_table_cols = $cols || 4;
1087 $main::ui_table_pos = 0;
1088 $main::ui_table_default_tds = $tds;
1089 return $rv;
1090 }
1091
1092 # ui_hidden_table_end(name)
1093 # Returns HTML for the end of table with hiding, as started by
1094 # ui_hidden_table_start
1095 sub ui_hidden_table_end
1096 {
1097 local ($name) = @_;
1098 return &theme_ui_hidden_table_end(@_) if (defined(&theme_ui_hidden_table_end));
1099 return "</table></div></td></tr></table>\n";
1100 }
1101
1102 # ui_tabs_start(&tabs, name, selected, show-border)
1103 # Render a row of tabs from which one can be selected. Each tab is an array
1104 # ref containing a name, title and link.
1105 sub ui_tabs_start
1106 {
1107 return &theme_ui_tabs_start(@_) if (defined(&theme_ui_tabs_start));
1108 local ($tabs, $name, $sel, $border) = @_;
1109 local $rv;
1110 if (!$main::ui_hidden_start_donejs++) {
1111         $rv .= &ui_hidden_javascript();
1112         }
1113
1114 # Build list of tab titles and names
1115 local $tabnames = "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$tabs)."]";
1116 local $tabtitles = "[".join(",", map { "\"".&html_escape($_->[1])."\"" } @$tabs)."]";
1117 $rv .= "<script>\n";
1118 $rv .= "document.${name}_tabnames = $tabnames;\n";
1119 $rv .= "document.${name}_tabtitles = $tabtitles;\n";
1120 $rv .= "</script>\n";
1121
1122 # Output the tabs
1123 local $imgdir = "$gconfig{'webprefix'}/images";
1124 $rv .= &ui_hidden($name, $sel)."\n";
1125 $rv .= "<table border=0 cellpadding=0 cellspacing=0>\n";
1126 $rv .= "<tr><td bgcolor=#ffffff colspan=".(scalar(@$tabs)*2+1).">";
1127 if ($ENV{'HTTP_USER_AGENT'} !~ /msie/i) {
1128         # For some reason, the 1-pixel space above the tabs appears huge on IE!
1129         $rv .= "<img src=$imgdir/1x1.gif>";
1130         }
1131 $rv .= "</td></tr>\n";
1132 $rv .= "<tr>\n";
1133 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1134 foreach my $t (@$tabs) {
1135         if ($t ne $tabs[0]) {
1136                 # Spacer
1137                 $rv .= "<td width=2 bgcolor=#ffffff>".
1138                        "<img src=$imgdir/1x1.gif></td>\n";
1139                 }
1140         local $tabid = "tab_".$t->[0];
1141         $rv .= "<td id=${tabid}>";
1142         $rv .= "<table cellpadding=0 cellspacing=0 border=0><tr>";
1143         if ($t->[0] eq $sel) {
1144                 # Selected tab
1145                 $rv .= "<td valign=top $cb>".
1146                        "<img src=$imgdir/lc2.gif alt=\"\"></td>";
1147                 $rv .= "<td $cb nowrap>".
1148                        "&nbsp;<b>$t->[1]</b>&nbsp;</td>";
1149                 $rv .= "<td valign=top $cb>".
1150                        "<img src=$imgdir/rc2.gif alt=\"\"></td>";
1151                 }
1152         else {
1153                 # Other tab (which has a link)
1154                 $rv .= "<td valign=top $tb>".
1155                        "<img src=$imgdir/lc1.gif alt=\"\"></td>";
1156                 $rv .= "<td $tb nowrap>".
1157                        "&nbsp;<a href='$t->[2]' ".
1158                        "onClick='return select_tab(\"$name\", \"$t->[0]\")'>".
1159                        "$t->[1]</a>&nbsp;</td>";
1160                 $rv .= "<td valign=top $tb>".
1161                        "<img src=$imgdir/rc1.gif ".
1162                        "alt=\"\"></td>";
1163                 $rv .= "</td>\n";
1164                 }
1165         $rv .= "</tr></table>";
1166         $rv .= "</td>\n";
1167         }
1168 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1169 $rv .= "</table>\n";
1170
1171 if ($border) {
1172         # All tabs are within a grey box
1173         $rv .= "<table width=100% cellpadding=0 cellspacing=0 border=0>\n";
1174         $rv .= "<tr> <td bgcolor=#ffffff rowspan=3 width=1><img src=$imgdir/1x1.gif></td>\n";
1175         $rv .= "<td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1176         $rv .= "<tr> <td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1177         $rv .= "<td valign=top>";
1178         }
1179 $main::ui_tabs_selected = $sel;
1180 return $rv;
1181 }
1182
1183 # ui_tabs_end(border)
1184 sub ui_tabs_end
1185 {
1186 return &theme_ui_tabs_end(@_) if (defined(&theme_ui_tabs_end));
1187 local ($border) = @_;
1188 local $rv;
1189 local $imgdir = "$gconfig{'webprefix'}/images";
1190 if ($border) {
1191         $rv .= "</td>\n";
1192         $rv .= "<td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1193         $rv .= "</tr>\n";
1194         $rv .= "<tr> <td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1195         $rv .= "</table>\n";
1196         }
1197 return $rv;
1198 }
1199
1200 # ui_tabs_start_tab(name, tab)
1201 # Must be called before outputting the HTML for the named tab
1202 sub ui_tabs_start_tab
1203 {
1204 return &theme_ui_tabs_start_tab(@_) if (defined(&theme_ui_tabs_start_tab));
1205 local ($name, $tab) = @_;
1206 local $defclass = $tab eq $main::ui_tabs_selected ?
1207                         'opener_shown' : 'opener_hidden';
1208 local $rv = "<div id='div_$tab' class='$defclass'>\n";
1209 return $rv;
1210 }
1211
1212 # ui_tabs_start_tabletab(name, tab)
1213 # Behaves like ui_tabs_start_tab, but for use within a ui_table_start block
1214 sub ui_tabs_start_tabletab
1215 {
1216 return &theme_ui_tabs_start_tabletab(@_)
1217         if (defined(&theme_ui_tabs_start_tabletab));
1218 local $div = &ui_tabs_start_tab(@_);
1219 return "</table>\n".$div."<table width=100%>\n";
1220 }
1221
1222 sub ui_tabs_end_tab
1223 {
1224 return &theme_ui_tabs_end_tab(@_) if (defined(&theme_ui_tabs_end_tab));
1225 return "</div>\n";
1226 }
1227
1228 sub ui_tabs_end_tabletab
1229 {
1230 return &theme_ui_tabs_end_tabletab(@_)
1231         if (defined(&theme_ui_tabs_end_tabletab));
1232 return "</table></div><table width=100%>\n";
1233 }
1234
1235 # ui_max_text_width(width, [text-area?])
1236 # Returns a new width for a text field, based on theme settings
1237 sub ui_max_text_width
1238 {
1239 local ($w, $ta) = @_;
1240 local $max = $ta ? $tconfig{'maxareawidth'} : $tconfig{'maxboxwidth'};
1241 return $max && $w > $max ? $max : $w;
1242 }
1243
1244 ####################### radio hidden functions
1245
1246 # ui_radio_selector(&opts, name, selected)
1247 # Returns HTML for a set of radio buttons, each of which shows a different
1248 # block of HTML when selected. &opts is an array ref to arrays containing
1249 # [ value, label, html ]
1250 sub ui_radio_selector
1251 {
1252 return &theme_ui_radio_selector(@_) if (defined(&theme_ui_radio_selector));
1253 local ($opts, $name, $sel) = @_;
1254 local $rv;
1255 if (!$main::ui_radio_selector_donejs++) {
1256         $rv .= &ui_radio_selector_javascript();
1257         }
1258 local $optnames =
1259         "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$opts)."]";
1260 foreach my $o (@$opts) {
1261         $rv .= &ui_oneradio($name, $o->[0], $o->[1], $sel eq $o->[0],
1262             "onClick='selector_show(\"$name\", \"$o->[0]\", $optnames)'");
1263         }
1264 $rv .= "<br>\n";
1265 foreach my $o (@$opts) {
1266         local $cls = $o->[0] eq $sel ? "selector_shown" : "selector_hidden";
1267         $rv .= "<div id=sel_${name}_$o->[0] class=$cls>".$o->[2]."</div>\n";
1268         }
1269 return $rv;
1270 }
1271
1272 sub ui_radio_selector_javascript
1273 {
1274 return <<EOF;
1275 <style>
1276 .selector_shown {display:inline}
1277 .selector_hidden {display:none}
1278 </style>
1279 <script>
1280 function selector_show(name, value, values)
1281 {
1282 for(var i=0; i<values.length; i++) {
1283         var divobj = document.getElementById('sel_'+name+'_'+values[i]);
1284         divobj.className = value == values[i] ? 'selector_shown'
1285                                               : 'selector_hidden';
1286         }
1287 }
1288 </script>
1289 EOF
1290 }
1291
1292 ####################### grid layout functions
1293
1294 # ui_grid_table(&elements, columns, [width-percent], [tds], [tabletags],
1295 #               [title])
1296 # Given a list of HTML elements, formats them into a table with the given
1297 # number of columns. However, themes are free to override this to use fewer
1298 # columns where space is limited.
1299 sub ui_grid_table
1300 {
1301 return &theme_ui_grid_table(@_) if (defined(&theme_ui_grid_table));
1302 local ($elements, $cols, $width, $tds, $tabletags, $title) = @_;
1303 return "" if (!@$elements);
1304 local $rv = "<table".
1305             ($width ? " width=$width%" : "").
1306             ($tabletags ? " ".$tabletags : "").
1307             ">\n";
1308 my $i;
1309 for($i=0; $i<@$elements; $i++) {
1310         $rv .= "<tr>" if ($i%$cols == 0);
1311         $rv .= "<td ".$tds->[$i%$cols]." valign=top>".$elements->[$i]."</td>\n";
1312         $rv .= "</tr>" if ($i%$cols == $cols-1);
1313         }
1314 if ($i%$cols) {
1315         while($i%$cols) {
1316                 $rv .= "<td ".$tds->[$i%$cols]."><br></td>\n";
1317                 $i++;
1318                 }
1319         $rv .= "</tr>\n";
1320         }
1321 $rv .= "</table>\n";
1322 if (defined($title)) {
1323         $rv = "<table class=ui_table border ".
1324               ($width ? " width=$width%" : "").">\n".
1325               ($title ? "<tr $tb> <td><b>$title</b></td> </tr>\n" : "").
1326               "<tr $cb> <td>$rv</td> </tr>\n".
1327               "</table>";
1328         }
1329 return $rv;
1330 }
1331
1332 # ui_radio_table(name, selected, &rows)
1333 # Returns HTML for a table of radio buttons, each of which has a label and
1334 # some associated inputs to the right.
1335 sub ui_radio_table
1336 {
1337 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
1338 local ($name, $sel, $rows) = @_;
1339 return "" if (!@$rows);
1340 local $rv = "<table>\n";
1341 foreach my $r (@$rows) {
1342         $rv .= "<tr>\n";
1343         $rv .= "<td valign=top><b>".&ui_oneradio($name, $r->[0], $r->[1],
1344                                    $r->[0] eq $sel)."</b></td>\n";
1345         $rv .= "<td valign=top>".$r->[2]."</td>\n";
1346         $rv .= "</tr>\n";
1347         }
1348 $rv .= "</table>\n";
1349 return $rv;
1350 }
1351
1352 # ui_up_down_arrows(uplink, downlink, up-show, down-show)
1353 # Returns HTML for moving some objects in a table up or down
1354 sub ui_up_down_arrows
1355 {
1356 return &theme_ui_up_down_arrows(@_) if (defined(&theme_ui_up_down_arrows));
1357 local ($uplink, $downlink, $upshow, $downshow) = @_;
1358 local $mover;
1359 local $imgdir = "$gconfig{'webprefix'}/images";
1360 if ($downshow) {
1361         $mover .= "<a href=\"$downlink\">".
1362                   "<img src=$imgdir/movedown.gif border=0></a>";
1363         }
1364 else {
1365         $mover .= "<img src=$imgdir/movegap.gif>";
1366         }
1367 if ($upshow) {
1368         $mover .= "<a href=\"$uplink\">".
1369                   "<img src=$imgdir/moveup.gif border=0></a>";
1370         }
1371 else {
1372         $mover .= "<img src=$imgdir/movegap.gif>";
1373         }
1374 return $mover;
1375 }
1376
1377 # ui_hr()
1378 # Returns a horizontal row tag
1379 sub ui_hr
1380 {
1381 return &theme_ui_hr() if (defined(&theme_ui_hr));
1382 return "<hr>\n";
1383 }
1384
1385 ####################### javascript functions
1386
1387 # js_disable_input(&disable-inputs, &enable-inputs, [tag])
1388 # Returns Javascript to disable some form elements and enable others
1389 sub js_disable_inputs
1390 {
1391 local $rv;
1392 local $f;
1393 foreach $f (@{$_[0]}) {
1394         $rv .= "e = form.elements[\"$f\"]; e.disabled = true; ";
1395         $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = true; } ";
1396         }
1397 foreach $f (@{$_[1]}) {
1398         $rv .= "e = form.elements[\"$f\"]; e.disabled = false; ";
1399         $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = false; } ";
1400         }
1401 foreach $f (@{$_[1]}) {
1402         if ($f =~ /^(.*)_def$/ && &indexof($1, @{$_[1]}) >= 0) {
1403                 # When enabling both a _def field and its associated text field,
1404                 # disable the text if the _def is set to 1
1405                 local $tf = $1;
1406                 $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 } } ";
1407                 }
1408         }
1409 return $_[2] ? "$_[2]='$rv'" : $rv;
1410 }
1411
1412 # js_checkbox_disable(name, &checked-disable, &checked-enable, [tag])
1413 sub js_checkbox_disable
1414 {
1415 local $rv;
1416 local $f;
1417 foreach $f (@{$_[1]}) {
1418         $rv .= "form.elements[\"$f\"].disabled = $_[0].checked; ";
1419         }
1420 foreach $f (@{$_[2]}) {
1421         $rv .= "form.elements[\"$f\"].disabled = !$_[0].checked; ";
1422         }
1423 return $_[3] ? "$_[3]='$rv'" : $rv;
1424 }
1425
1426 1;
1427