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