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) {
 470         $units = 1024*1024*1024;
 471         }
 472 elsif ($bytes >= 10*1024*1024) {
 473         $units = 1024*1024;
 474         }
 475 elsif ($bytes >= 10*1024) {
 476         $units = 1024;
 477         }
 478 else {
 479         $units = 1;
 480         }
 481 if ($bytes ne "") {
 482         $bytes = sprintf("%.2f", ($bytes*1.0)/$units);
 483         $bytes =~ s/\.00$//;
 484         }
 485 $size = &ui_max_text_width($size || 8);
 486 return &ui_textbox($name, $bytes, $size, $dis)." ".
 487        &ui_select($name."_units", $units,
 488                  [ [ 1, "bytes" ], [ 1024, "kB" ], [ 1024*1024, "MB" ],
 489                    [ 1024*1024*1024, "GB" ] ], undef, undef, undef, $dis);
 490 }
 491
 492 # ui_upload(name, size, [disabled?], [tags])
 493 # Returns HTML for a file upload input
 494 sub ui_upload
 495 {
 496 return &theme_ui_upload(@_) if (defined(&theme_ui_upload));
 497 my ($name, $size, $dis, $tags) = @_;
 498 $size = &ui_max_text_width($size);
 499 return "<input type=file name=\"".&quote_escape($name)."\" ".
 500        "size=$size ".
 501        ($dis ? "disabled=true" : "").
 502        ($tags ? " ".$tags : "").">";
 503 }
 504
 505 # ui_password(name, value, size, [disabled?], [maxlength])
 506 # Returns HTML for a password text input
 507 sub ui_password
 508 {
 509 return &theme_ui_password(@_) if (defined(&theme_ui_password));
 510 my ($name, $value, $size, $dis, $max) = @_;
 511 $size = &ui_max_text_width($size);
 512 return "<input type=password name=\"".&quote_escape($name)."\" ".
 513        "value=\"".&quote_escape($value)."\" ".
 514        "size=$size ".($dis ? "disabled=true" : "").
 515        ($max ? " maxlength=$max" : "").
 516        ">";
 517 }
 518
 519 # ui_hidden(name, value)
 520 # Returns HTML for a hidden field
 521 sub ui_hidden
 522 {
 523 return &theme_ui_hidden(@_) if (defined(&theme_ui_hidden));
 524 my ($name, $value) = @_;
 525 return "<input type=hidden name=\"".&quote_escape($name)."\" ".
 526        "value=\"".&quote_escape($value)."\">\n";
 527 }
 528
 529 # ui_select(name, value|&values, &options, [size], [multiple],
 530 #           [add-if-missing], [disabled?], [javascript])
 531 # Returns HTML for a drop-down menu or multiple selection list
 532 sub ui_select
 533 {
 534 return &theme_ui_select(@_) if (defined(&theme_ui_select));
 535 my ($name, $value, $opts, $size, $multiple, $missing, $dis, $js) = @_;
 536 my $rv;
 537 $rv .= "<select name=\"".&quote_escape($name)."\"".
 538        ($size ? " size=$size" : "").
 539        ($multiple ? " multiple" : "").
 540        ($dis ? " disabled=true" : "")." ".$js.">\n";
 541 my ($o, %opt, $s);
 542 my %sel = ref($value) ? ( map { $_, 1 } @$value ) : ( $value, 1 );
 543 foreach $o (@$opts) {
 544         $o = [ $o ] if (!ref($o));
 545         $rv .= "<option value=\"".&quote_escape($o->[0])."\"".
 546                ($sel{$o->[0]} ? " selected" : "")." ".$o->[2].">".
 547                ($o->[1] || $o->[0])."\n";
 548         $opt{$o->[0]}++;
 549         }
 550 foreach $s (keys %sel) {
 551         if (!$opt{$s} && $missing) {
 552                 $rv .= "<option value=\"".&quote_escape($s)."\"".
 553                        "selected>".($s eq "" ? "&nbsp;" : $s)."\n";
 554                 }
 555         }
 556 $rv .= "</select>\n";
 557 return $rv;
 558 }
 559
 560 # ui_multi_select(name, &values, &options, size, [add-if-missing], [disabled?],
 561 #                 [options-title, values-title], [width])
 562 # Returns HTML for selecting many of many from a list. By default, this is
 563 # implemented using two <select> lists and Javascript buttons to move elements
 564 # between them. The resulting input value is \n separated.
 565 sub ui_multi_select
 566 {
 567 return &theme_ui_multi_select(@_) if (defined(&theme_ui_multi_select));
 568 my ($name, $values, $opts, $size, $missing, $dis,
 569        $opts_title, $vals_title, $width) = @_;
 570 my $rv;
 571 my %already = map { $_->[0], $_ } @$values;
 572 my $leftover = [ grep { !$already{$_->[0]} } @$opts ];
 573 if ($missing) {
 574         my %optsalready = map { $_->[0], $_ } @$opts;
 575         push(@$opts, grep { !$optsalready{$_->[0]} } @$values);
 576         }
 577 if (!defined($width)) {
 578         $width = "200";
 579         }
 580 my $wstyle = $width ? "style='width:$width'" : "";
 581
 582 if (!$main::ui_multi_select_donejs++) {
 583         $rv .= &ui_multi_select_javascript();
 584         }
 585 $rv .= "<table cellpadding=0 cellspacing=0 class='ui_multi_select'>";
 586 if (defined($opts_title)) {
 587         $rv .= "<tr class='ui_multi_select_heads'> ".
 588                "<td><b>$opts_title</b></td> ".
 589                "<td></td> <td><b>$vals_title</b></td> </tr>";
 590         }
 591 $rv .= "<tr class='ui_multi_select_row'>";
 592 $rv .= "<td>".&ui_select($name."_opts", [ ], $leftover,
 593                          $size, 0, 0, $dis, $wstyle)."</td>\n";
 594 $rv .= "<td>".&ui_button("->", undef, $dis,
 595                  "onClick='multi_select_move(\"$name\", form, 1)'")."<br>".
 596               &ui_button("<-", undef, $dis,
 597                  "onClick='multi_select_move(\"$name\", form, 0)'")."</td>\n";
 598 $rv .= "<td>".&ui_select($name."_vals", [ ], $values,
 599                          $size, 0, 0, $dis, $wstyle)."</td>\n";
 600 $rv .= "</tr></table>\n";
 601 $rv .= &ui_hidden($name, join("\n", map { $_->[0] } @$values));
 602 return $rv;
 603 }
 604
 605 # ui_multi_select_javascript()
 606 # Returns <script> section for left/right select boxes
 607 sub ui_multi_select_javascript
 608 {
 609 return &theme_ui_multiselect_javascript()
 610         if (defined(&theme_ui_multiselect_javascript));
 611 return <<EOF;
 612 <script>
 613 // Move an element from the options list to the values list, or vice-versa
 614 function multi_select_move(name, f, dir)
 615 {
 616 var opts = f.elements[name+"_opts"];
 617 var vals = f.elements[name+"_vals"];
 618 var opts_idx = opts.selectedIndex;
 619 var vals_idx = vals.selectedIndex;
 620 if (dir == 1 && opts_idx >= 0) {
 621         // Moving from options to selected list
 622         var o = opts.options[opts_idx];
 623         vals.options[vals.options.length] = new Option(o.text, o.value);
 624         opts.remove(opts_idx);
 625         }
 626 else if (dir == 0 && vals_idx >= 0) {
 627         // Moving the other way
 628         var o = vals.options[vals_idx];
 629         opts.options[opts.options.length] = new Option(o.text, o.value);
 630         vals.remove(vals_idx);
 631         }
 632 // Fill in hidden field
 633 var hid = f.elements[name];
 634 if (hid) {
 635         var hv = new Array();
 636         for(var i=0; i<vals.options.length; i++) {
 637                 hv.push(vals.options[i].value);
 638                 }
 639         hid.value = hv.join("\\n");
 640         }
 641 }
 642 </script>
 643 EOF
 644 }
 645
 646 # ui_radio(name, value, &options, [disabled?])
 647 # Returns HTML for a series of radio buttons
 648 sub ui_radio
 649 {
 650 return &theme_ui_radio(@_) if (defined(&theme_ui_radio));
 651 my ($name, $value, $opts, $dis) = @_;
 652 my $rv;
 653 my $o;
 654 foreach $o (@$opts) {
 655         my $id = &quote_escape($name."_".$o->[0]);
 656         my $label = $o->[1] || $o->[0];
 657         my $after;
 658         if ($label =~ /^(.*?)((<a\s+href|<input|<select|<textarea)[\000-\377]*)$/i) {
 659                 $label = $1;
 660                 $after = $2;
 661                 }
 662         $rv .= "<input type=radio name=\"".&quote_escape($name)."\" ".
 663                "value=\"".&quote_escape($o->[0])."\"".
 664                ($o->[0] eq $value ? " checked" : "").
 665                ($dis ? " disabled=true" : "").
 666                " id=\"$id\"".
 667                " $o->[2]> <label for=\"$id\">".
 668                $label."</label>".$after."\n";
 669         }
 670 return $rv;
 671 }
 672
 673 # ui_yesno_radio(name, value, [yes], [no], [disabled?])
 674 # Like ui_yesno, but always displays just two inputs (yes and no)
 675 sub ui_yesno_radio
 676 {
 677 my ($name, $value, $yes, $no, $dis) = @_;
 678 return &theme_ui_yesno_radio(@_) if (defined(&theme_ui_yesno_radio));
 679 $yes = 1 if (!defined($yes));
 680 $no = 0 if (!defined($no));
 681 $value = int($value);
 682 return &ui_radio($name, $value, [ [ $yes, $text{'yes'} ],
 683                                   [ $no, $text{'no'} ] ], $dis);
 684 }
 685
 686 # ui_checkbox(name, value, label, selected?, [tags], [disabled?])
 687 # Returns HTML for a single checkbox
 688 sub ui_checkbox
 689 {
 690 return &theme_ui_checkbox(@_) if (defined(&theme_ui_checkbox));
 691 my ($name, $value, $label, $sel, $tags, $dis) = @_;
 692 my $after;
 693 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
 694         $label = $1;
 695         $after = $2;
 696         }
 697 return "<input type=checkbox name=\"".&quote_escape($name)."\" ".
 698        "value=\"".&quote_escape($value)."\" ".
 699        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
 700        " id=\"".&quote_escape("${name}_${value}")."\"".
 701        " $tags> ".
 702        ($label eq "" ? $after :
 703          "<label for=\"".&quote_escape("${name}_${value}").
 704          "\">$label</label>$after")."\n";
 705 }
 706
 707 # ui_oneradio(name, value, label, selected?, [tags], [disabled?])
 708 # Returns HTML for a single radio button
 709 sub ui_oneradio
 710 {
 711 return &theme_ui_oneradio(@_) if (defined(&theme_ui_oneradio));
 712 my ($name, $value, $label, $sel, $tags, $dis) = @_;
 713 my $id = &quote_escape("${name}_${value}");
 714 my $after;
 715 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
 716         $label = $1;
 717         $after = $2;
 718         }
 719 return "<input type=radio name=\"".&quote_escape($name)."\" ".
 720        "value=\"".&quote_escape($value)."\" ".
 721        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
 722        " id=\"$id\"".
 723        " $tags> <label for=\"$id\">$label</label>$after\n";
 724 }
 725
 726 # ui_textarea(name, value, rows, cols, [wrap], [disabled?], [tags])
 727 # Returns HTML for a multi-line text input
 728 sub ui_textarea
 729 {
 730 return &theme_ui_textarea(@_) if (defined(&theme_ui_textarea));
 731 my ($name, $value, $rows, $cols, $wrap, $dis, $tags) = @_;
 732 $cols = &ui_max_text_width($cols, 1);
 733 return "<textarea name=\"".&quote_escape($name)."\" ".
 734        "rows=$rows cols=$cols".($wrap ? " wrap=$wrap" : "").
 735        ($dis ? " disabled=true" : "").
 736        ($tags ? " $tags" : "").">".
 737        &html_escape($value).
 738        "</textarea>";
 739 }
 740
 741 # ui_user_textbox(name, value, [form], [disabled?], [tags])
 742 # Returns HTML for a Unix user input
 743 sub ui_user_textbox
 744 {
 745 return &theme_ui_user_textbox(@_) if (defined(&theme_ui_user_textbox));
 746 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
 747        &user_chooser_button($_[0], 0, $_[2]);
 748 }
 749
 750 # ui_group_textbox(name, value, [form], [disabled?], [tags])
 751 # Returns HTML for a Unix group input
 752 sub ui_group_textbox
 753 {
 754 return &theme_ui_group_textbox(@_) if (defined(&theme_ui_group_textbox));
 755 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
 756        &group_chooser_button($_[0], 0, $_[2]);
 757 }
 758
 759 # ui_opt_textbox(name, value, size, option1, [option2], [disabled?],
 760 #                [&extra-fields], [max])
 761 # Returns HTML for a text field that is optional
 762 sub ui_opt_textbox
 763 {
 764 return &theme_ui_opt_textbox(@_) if (defined(&theme_ui_opt_textbox));
 765 my ($name, $value, $size, $opt1, $opt2, $dis, $extra, $max) = @_;
 766 my $dis1 = &js_disable_inputs([ $name, @$extra ], [ ]);
 767 my $dis2 = &js_disable_inputs([ ], [ $name, @$extra ]);
 768 my $rv;
 769 $size = &ui_max_text_width($size);
 770 $rv .= &ui_radio($name."_def", $value eq '' ? 1 : 0,
 771                  [ [ 1, $opt1, "onClick='$dis1'" ],
 772                    [ 0, $opt2 || " ", "onClick='$dis2'" ] ], $dis)."\n";
 773 $rv .= "<input name=\"".&quote_escape($name)."\" ".
 774        "size=$size value=\"".&quote_escape($value)."\" ".
 775        ($value eq "" || $dis ? "disabled=true" : "").
 776        ($max ? " maxlength=$max" : "").">\n";
 777 return $rv;
 778 }
 779
 780 # ui_submit(label, [name], [disabled?], [tags])
 781 # Returns HTML for a form submit button
 782 sub ui_submit
 783 {
 784 return &theme_ui_submit(@_) if (defined(&theme_ui_submit));
 785 my ($label, $name, $dis, $tags) = @_;
 786 return "<input type=submit".
 787        ($name ne '' ? " name=\"".&quote_escape($name)."\"" : "").
 788        " value=\"".&quote_escape($label)."\"".
 789        ($dis ? " disabled=true" : "").
 790        ($tags ? " ".$tags : "").">\n";
 791
 792 }
 793
 794 # ui_reset(label, [disabled?])
 795 # Returns HTML for a form reset button
 796 sub ui_reset
 797 {
 798 return &theme_ui_reset(@_) if (defined(&theme_ui_reset));
 799 my ($label, $dis) = @_;
 800 return "<input type=reset value=\"".&quote_escape($label)."\"".
 801        ($dis ? " disabled=true" : "").">\n";
 802
 803 }
 804
 805 # ui_button(label, [name], [disabled?], [tags])
 806 # Returns HTML for a form button
 807 sub ui_button
 808 {
 809 return &theme_ui_button(@_) if (defined(&theme_ui_button));
 810 my ($label, $name, $dis, $tags) = @_;
 811 return "<input type=button".
 812        ($name ne '' ? " name=\"".&quote_escape($name)."\"" : "").
 813        " value=\"".&quote_escape($label)."\"".
 814        ($dis ? " disabled=true" : "").
 815        ($tags ? " ".$tags : "").">\n";
 816 }
 817
 818 # ui_date_input(day, month, year, day-name, month-name, year-name, [disabled?])
 819 # Returns HTML for a date-selection field
 820 sub ui_date_input
 821 {
 822 my ($day, $month, $year, $dayname, $monthname, $yearname, $dis) = @_;
 823 my $rv;
 824 $rv .= &ui_textbox($dayname, $day, 3, $dis);
 825 $rv .= "/";
 826 $rv .= &ui_select($monthname, $month,
 827                   [ map { [ $_, $text{"smonth_$_"} ] } (1 .. 12) ],
 828                   1, 0, 0, $dis);
 829 $rv .= "/";
 830 $rv .= &ui_textbox($yearname, $year, 5, $dis);
 831 return $rv;
 832 }
 833
 834 # ui_table_row(label, value, [cols], [&td-tags])
 835 # Returns HTML for a row in a table started by ui_table_start, with a 1-column
 836 # label and 1+ column value.
 837 sub ui_table_row
 838 {
 839 return &theme_ui_table_row(@_) if (defined(&theme_ui_table_row));
 840 my ($label, $value, $cols, $tds) = @_;
 841 $cols ||= 1;
 842 $tds ||= $main::ui_table_default_tds;
 843 my $rv;
 844 if ($main::ui_table_pos+$cols+1 > $main::ui_table_cols &&
 845     $main::ui_table_pos != 0) {
 846         # If the requested number of cols won't fit in the number
 847         # remaining, start a new row
 848         $rv .= "</tr>\n";
 849         $main::ui_table_pos = 0;
 850         }
 851 $rv .= "<tr>\n" if ($main::ui_table_pos%$main::ui_table_cols == 0);
 852 $rv .= "<td valign=top $tds->[0]><b>$label</b></td>\n" if (defined($label));
 853 $rv .= "<td valign=top colspan=$cols $tds->[1]>$value</td>\n";
 854 $main::ui_table_pos += $cols+(defined($label) ? 1 : 0);
 855 if ($main::ui_table_pos%$main::ui_table_cols == 0) {
 856         $rv .= "</tr>\n";
 857         $main::ui_table_pos = 0;
 858         }
 859 return $rv;
 860 }
 861
 862 # ui_table_hr()
 863 sub ui_table_hr
 864 {
 865 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
 866 my $rv;
 867 if ($ui_table_pos) {
 868         $rv .= "</tr>\n";
 869         $ui_table_pos = 0;
 870         }
 871 $rv .= "<tr> <td colspan=$main::ui_table_cols><hr></td> </tr>\n";
 872 return $rv;
 873 }
 874
 875 # ui_table_span(text)
 876 # Outputs a table row that spans the whole table, and contains the given text
 877 sub ui_table_span
 878 {
 879 my ($text) = @_;
 880 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
 881 my $rv;
 882 if ($ui_table_pos) {
 883         $rv .= "</tr>\n";
 884         $ui_table_pos = 0;
 885         }
 886 $rv .= "<tr> <td colspan=$main::ui_table_cols>$text</td> </tr>\n";
 887 return $rv;
 888 }
 889
 890 # ui_buttons_start()
 891 sub ui_buttons_start
 892 {
 893 return &theme_ui_buttons_start(@_) if (defined(&theme_ui_buttons_start));
 894 return "<table width=100%>\n";
 895 }
 896
 897 # ui_buttons_end()
 898 sub ui_buttons_end
 899 {
 900 return &theme_ui_buttons_end(@_) if (defined(&theme_ui_buttons_end));
 901 return "</table>\n";
 902 }
 903
 904 # ui_buttons_row(script, button-label, description, [hiddens], [after-submit],
 905 #                [before-submit])
 906 sub ui_buttons_row
 907 {
 908 return &theme_ui_buttons_row(@_) if (defined(&theme_ui_buttons_row));
 909 my ($script, $label, $desc, $hiddens, $after, $before) = @_;
 910 return "<form action=$script>\n".
 911        $hiddens.
 912        "<tr> <td nowrap width=20% valign=top>".($before ? $before." " : "").
 913        &ui_submit($label).($after ? " ".$after : "")."</td>\n".
 914        "<td valign=top width=80% valign=top>$desc</td> </tr>\n".
 915        "</form>\n";
 916 }
 917
 918 # ui_buttons_hr([title])
 919 sub ui_buttons_hr
 920 {
 921 my ($title) = @_;
 922 return &theme_ui_buttons_hr(@_) if (defined(&theme_ui_buttons_hr));
 923 if ($title) {
 924         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";
 925         }
 926 else {
 927         return "<tr> <td colspan=2><hr></td> </tr>\n";
 928         }
 929 }
 930
 931 ####################### header and footer functions
 932
 933 # ui_post_header([subtext])
 934 # Returns HTML to appear directly after a standard header() call
 935 sub ui_post_header
 936 {
 937 return &theme_ui_post_header(@_) if (defined(&theme_ui_post_header));
 938 my ($text) = @_;
 939 my $rv;
 940 $rv .= "<center class='ui_post_header'><font size=+1>$text</font></center>\n" if (defined($text));
 941 if (!$tconfig{'nohr'} && !$tconfig{'notophr'}) {
 942         $rv .= "<hr id='post_header_hr'>\n";
 943         }
 944 return $rv;
 945 }
 946
 947 # ui_pre_footer()
 948 # Returns HTML to appear directly before a standard footer() call
 949 sub ui_pre_footer
 950 {
 951 return &theme_ui_pre_footer(@_) if (defined(&theme_ui_pre_footer));
 952 my $rv;
 953 if (!$tconfig{'nohr'} && !$tconfig{'nobottomhr'}) {
 954         $rv .= "<hr id='pre_footer_hr'>\n";
 955         }
 956 return $rv;
 957 }
 958
 959 # ui_print_header(subtext, args...)
 960 # Print HTML for a header with the post-header line. The args are the same
 961 # as those passed to header()
 962 sub ui_print_header
 963 {
 964 &load_theme_library();
 965 return &theme_ui_print_header(@_) if (defined(&theme_ui_print_header));
 966 my ($text, @args) = @_;
 967 &header(@args);
 968 print &ui_post_header($text);
 969 }
 970
 971 # ui_print_unbuffered_header(subtext, args...)
 972 # Like ui_print_header, but ensures that output for this page is not buffered
 973 # or contained in a table.
 974 sub ui_print_unbuffered_header
 975 {
 976 &load_theme_library();
 977 return &theme_ui_print_unbuffered_header(@_) if (defined(&theme_ui_print_unbuffered_header));
 978 $| = 1;
 979 $theme_no_table = 1;
 980 &ui_print_header(@_);
 981 }
 982
 983 # ui_print_footer(args...)
 984 # Print HTML for a footer with the pre-footer line. Args are the same as those
 985 # passed to footer()
 986 sub ui_print_footer
 987 {
 988 return &theme_ui_print_footer(@_) if (defined(&theme_ui_print_footer));
 989 my @args = @_;
 990 print &ui_pre_footer();
 991 &footer(@args);
 992 }
 993
 994 # ui_config_link(text, &subs)
 995 # Returns HTML for a module config link. The first non-null sub will be
 996 # replaced with the appropriate URL.
 997 sub ui_config_link
 998 {
 999 return &theme_ui_config_link(@_) if (defined(&theme_ui_config_link));
1000 my ($text, $subs) = @_;
1001 my @subs = map { $_ || "../config.cgi?$module_name" }
1002                   ($subs ? @$subs : ( undef ));
1003 return "<p>".&text($text, @subs)."<p>\n";
1004 }
1005
1006 # ui_print_endpage(text)
1007 # Prints HTML for an error message followed by a page footer with a link to
1008 # /, then exits. Good for main page error messages.
1009 sub ui_print_endpage
1010 {
1011 return &theme_ui_print_endpage(@_) if (defined(&theme_ui_print_endpage));
1012 my ($text) = @_;
1013 print $text,"<p class='ui_footer'>\n";
1014 print "</p>\n";
1015 &ui_print_footer("/", $text{'index'});
1016 exit;
1017 }
1018
1019 # ui_subheading(text, ...)
1020 # Returns HTML for a section heading
1021 sub ui_subheading
1022 {
1023 return &theme_ui_subheading(@_) if (defined(&theme_ui_subheading));
1024 return "<h3 class='ui_subheading'>".join("", @_)."</h3>\n";
1025 }
1026
1027 # ui_links_row(&links)
1028 # Returns HTML for a row of links, like select all / invert selection / add..
1029 sub ui_links_row
1030 {
1031 return &theme_ui_links_row(@_) if (defined(&theme_ui_links_row));
1032 my ($links) = @_;
1033 return @$links ? join("\n|\n", @$links)."<br>\n"
1034                : "";
1035 }
1036
1037 ########################### collapsible section / tab functions
1038
1039 # ui_hidden_javascript()
1040 # Returns <script> and <style> sections for hiding functions and CSS
1041 sub ui_hidden_javascript
1042 {
1043 return &theme_ui_hidden_javascript(@_)
1044         if (defined(&theme_ui_hidden_javascript));
1045 my $rv;
1046 my $imgdir = "$gconfig{'webprefix'}/images";
1047 my ($jscb, $jstb) = ($cb, $tb);
1048 $jscb =~ s/'/\\'/g;
1049 $jstb =~ s/'/\\'/g;
1050
1051 return <<EOF;
1052 <style>
1053 .opener_shown {display:inline}
1054 .opener_hidden {display:none}
1055 </style>
1056 <script>
1057 // Open or close a hidden section
1058 function hidden_opener(divid, openerid)
1059 {
1060 var divobj = document.getElementById(divid);
1061 var openerobj = document.getElementById(openerid);
1062 if (divobj.className == 'opener_shown') {
1063   divobj.className = 'opener_hidden';
1064   openerobj.innerHTML = '<img border=0 src=$imgdir/closed.gif>';
1065   }
1066 else {
1067   divobj.className = 'opener_shown';
1068   openerobj.innerHTML = '<img border=0 src=$imgdir/open.gif>';
1069   }
1070 }
1071
1072 // Show a tab
1073 function select_tab(name, tabname, form)
1074 {
1075 var tabnames = document[name+'_tabnames'];
1076 var tabtitles = document[name+'_tabtitles'];
1077 for(var i=0; i<tabnames.length; i++) {
1078   var tabobj = document.getElementById('tab_'+tabnames[i]);
1079   var divobj = document.getElementById('div_'+tabnames[i]);
1080   var title = tabtitles[i];
1081   if (tabnames[i] == tabname) {
1082     // Selected table
1083     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
1084                        '<td valign=top $jscb>'+
1085                        '<img src=$imgdir/lc2.gif alt=""></td>'+
1086                        '<td $jscb nowrap>'+
1087                        '&nbsp;<b>'+title+'</b>&nbsp;</td>'+
1088                        '<td valign=top $jscb>'+
1089                        '<img src=$imgdir/rc2.gif alt=""></td>'+
1090                        '</tr></table>';
1091     divobj.className = 'opener_shown';
1092     }
1093   else {
1094     // Non-selected tab
1095     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
1096                        '<td valign=top $jstb>'+
1097                        '<img src=$imgdir/lc1.gif alt=""></td>'+
1098                        '<td $jstb nowrap>'+
1099                        '&nbsp;<a href=\\'\\' onClick=\\'return select_tab("'+
1100                        name+'", "'+tabnames[i]+'")\\'>'+title+'</a>&nbsp;</td>'+
1101                        '<td valign=top $jstb>'+
1102                        '<img src=$imgdir/rc1.gif alt=""></td>'+
1103                        '</tr></table>';
1104     divobj.className = 'opener_hidden';
1105     }
1106   }
1107 if (document.forms[0] && document.forms[0][name]) {
1108   document.forms[0][name].value = tabname;
1109   }
1110 return false;
1111 }
1112 </script>
1113 EOF
1114 }
1115
1116 # ui_hidden_start(title, name, status, thisurl)
1117 # Returns HTML for the start of a collapsible hidden section, such as for
1118 # advanced options.
1119 sub ui_hidden_start
1120 {
1121 return &theme_ui_hidden_start(@_) if (defined(&theme_ui_hidden_start));
1122 my ($title, $name, $status, $url) = @_;
1123 my $rv;
1124 if (!$main::ui_hidden_start_donejs++) {
1125         $rv .= &ui_hidden_javascript();
1126         }
1127 my $divid = "hiddendiv_$name";
1128 my $openerid = "hiddenopener_$name";
1129 my $defimg = $status ? "open.gif" : "closed.gif";
1130 my $defclass = $status ? 'opener_shown' : 'opener_hidden';
1131 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg' alt='*'></a>\n";
1132 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
1133 $rv .= "<div class='$defclass' id='$divid'>\n";
1134 return $rv;
1135 }
1136
1137 # ui_hidden_end(name)
1138 # Returns HTML for the end of a hidden section
1139 sub ui_hidden_end
1140 {
1141 return &theme_ui_hidden_end(@_) if (defined(&theme_ui_hidden_end));
1142 my ($name) = @_;
1143 return "</div>\n";
1144 }
1145
1146 # ui_hidden_table_row_start(title, name, status, thisurl)
1147 # Similar to ui_hidden_start, but for use within a table started with
1148 # ui_table_start
1149 sub ui_hidden_table_row_start
1150 {
1151 return &theme_ui_hidden_table_row_start(@_)
1152         if (defined(&theme_ui_hidden_table_row_start));
1153 my ($title, $name, $status, $url) = @_;
1154 my ($rv, $rrv);
1155 if (!$main::ui_hidden_start_donejs++) {
1156         $rv .= &ui_hidden_javascript();
1157         }
1158 my $divid = "hiddendiv_$name";
1159 my $openerid = "hiddenopener_$name";
1160 my $defimg = $status ? "open.gif" : "closed.gif";
1161 my $defclass = $status ? 'opener_shown' : 'opener_hidden';
1162 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a>\n";
1163 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
1164 $rv .= &ui_table_row(undef, $rrv, $main::ui_table_cols);
1165 $rv .= "</table>\n";
1166 $rv .= "<div class='$defclass' id='$divid'>\n";
1167 $rv .= "<table width=100%>\n";
1168 return $rv;
1169 }
1170
1171 # ui_hidden_table_row_end(name)
1172 sub ui_hidden_table_row_end
1173 {
1174 return &theme_ui_hidden_table_row_end(@_)
1175         if (defined(&theme_ui_hidden_table_row_end));
1176 my ($name) = @_;
1177 return "</table></div><table width=100%>\n";
1178 }
1179
1180 # ui_hidden_table_start(heading, [tabletags], [cols], name, status,
1181 #                       [&default-tds])
1182 # A table with a heading and table inside, and which is collapsible
1183 sub ui_hidden_table_start
1184 {
1185 return &theme_ui_hidden_table_start(@_)
1186         if (defined(&theme_ui_hidden_table_start));
1187 my ($heading, $tabletags, $cols, $name, $status, $tds) = @_;
1188 my $rv;
1189 if (!$main::ui_hidden_start_donejs++) {
1190         $rv .= &ui_hidden_javascript();
1191         }
1192 my $divid = "hiddendiv_$name";
1193 my $openerid = "hiddenopener_$name";
1194 my $defimg = $status ? "open.gif" : "closed.gif";
1195 my $defclass = $status ? 'opener_shown' : 'opener_hidden';
1196 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1197               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1198 $rv .= "<table class='ui_table' border $tabletags class='ui_table'>\n";
1199 $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));
1200 $rv .= "<tr $cb> <td><div class='$defclass' id='$divid'><table width=100%>\n";
1201 $main::ui_table_cols = $cols || 4;
1202 $main::ui_table_pos = 0;
1203 $main::ui_table_default_tds = $tds;
1204 return $rv;
1205 }
1206
1207 # ui_hidden_table_end(name)
1208 # Returns HTML for the end of table with hiding, as started by
1209 # ui_hidden_table_start
1210 sub ui_hidden_table_end
1211 {
1212 my ($name) = @_;
1213 return &theme_ui_hidden_table_end(@_) if (defined(&theme_ui_hidden_table_end));
1214 return "</table></div></td></tr></table>\n";
1215 }
1216
1217 # ui_tabs_start(&tabs, name, selected, show-border)
1218 # Render a row of tabs from which one can be selected. Each tab is an array
1219 # ref containing a name, title and link.
1220 sub ui_tabs_start
1221 {
1222 return &theme_ui_tabs_start(@_) if (defined(&theme_ui_tabs_start));
1223 my ($tabs, $name, $sel, $border) = @_;
1224 my $rv;
1225 if (!$main::ui_hidden_start_donejs++) {
1226         $rv .= &ui_hidden_javascript();
1227         }
1228
1229 # Build list of tab titles and names
1230 my $tabnames = "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$tabs)."]";
1231 my $tabtitles = "[".join(",", map { "\"".&html_escape($_->[1])."\"" } @$tabs)."]";
1232 $rv .= "<script>\n";
1233 $rv .= "document.${name}_tabnames = $tabnames;\n";
1234 $rv .= "document.${name}_tabtitles = $tabtitles;\n";
1235 $rv .= "</script>\n";
1236
1237 # Output the tabs
1238 my $imgdir = "$gconfig{'webprefix'}/images";
1239 $rv .= &ui_hidden($name, $sel)."\n";
1240 $rv .= "<table border=0 cellpadding=0 cellspacing=0>\n";
1241 $rv .= "<tr><td bgcolor=#ffffff colspan=".(scalar(@$tabs)*2+1).">";
1242 if ($ENV{'HTTP_USER_AGENT'} !~ /msie/i) {
1243         # For some reason, the 1-pixel space above the tabs appears huge on IE!
1244         $rv .= "<img src=$imgdir/1x1.gif>";
1245         }
1246 $rv .= "</td></tr>\n";
1247 $rv .= "<tr>\n";
1248 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1249 foreach my $t (@$tabs) {
1250         if ($t ne $tabs[0]) {
1251                 # Spacer
1252                 $rv .= "<td width=2 bgcolor=#ffffff>".
1253                        "<img src=$imgdir/1x1.gif></td>\n";
1254                 }
1255         my $tabid = "tab_".$t->[0];
1256         $rv .= "<td id=${tabid}>";
1257         $rv .= "<table cellpadding=0 cellspacing=0 border=0><tr>";
1258         if ($t->[0] eq $sel) {
1259                 # Selected tab
1260                 $rv .= "<td valign=top $cb class='selectedTabLeft'>".
1261                        "<img src=$imgdir/lc2.gif alt=\"\"></td>";
1262                 $rv .= "<td $cb nowrap class='selectedTabMiddle'>".
1263                        "&nbsp;<b>$t->[1]</b>&nbsp;</td>";
1264                 $rv .= "<td valign=top $cb class='selectedTabRight'>".
1265                        "<img src=$imgdir/rc2.gif alt=\"\"></td>";
1266                 }
1267         else {
1268                 # Other tab (which has a link)
1269                 $rv .= "<td valign=top $tb>".
1270                        "<img src=$imgdir/lc1.gif alt=\"\"></td>";
1271                 $rv .= "<td $tb nowrap>".
1272                        "&nbsp;<a href='$t->[2]' ".
1273                        "onClick='return select_tab(\"$name\", \"$t->[0]\")'>".
1274                        "$t->[1]</a>&nbsp;</td>";
1275                 $rv .= "<td valign=top $tb>".
1276                        "<img src=$imgdir/rc1.gif ".
1277                        "alt=\"\"></td>";
1278                 $rv .= "</td>\n";
1279                 }
1280         $rv .= "</tr></table>";
1281         $rv .= "</td>\n";
1282         }
1283 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1284 $rv .= "</table>\n";
1285
1286 if ($border) {
1287         # All tabs are within a grey box
1288         $rv .= "<table width=100% cellpadding=0 cellspacing=0 border=0>\n";
1289         $rv .= "<tr> <td bgcolor=#ffffff rowspan=3 width=1><img src=$imgdir/1x1.gif></td>\n";
1290         $rv .= "<td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1291         $rv .= "<tr> <td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1292         $rv .= "<td valign=top>";
1293         }
1294 $main::ui_tabs_selected = $sel;
1295 return $rv;
1296 }
1297
1298 # ui_tabs_end(border)
1299 sub ui_tabs_end
1300 {
1301 return &theme_ui_tabs_end(@_) if (defined(&theme_ui_tabs_end));
1302 my ($border) = @_;
1303 my $rv;
1304 my $imgdir = "$gconfig{'webprefix'}/images";
1305 if ($border) {
1306         $rv .= "</td>\n";
1307         $rv .= "<td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1308         $rv .= "</tr>\n";
1309         $rv .= "<tr> <td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1310         $rv .= "</table>\n";
1311         }
1312 return $rv;
1313 }
1314
1315 # ui_tabs_start_tab(name, tab)
1316 # Must be called before outputting the HTML for the named tab
1317 sub ui_tabs_start_tab
1318 {
1319 return &theme_ui_tabs_start_tab(@_) if (defined(&theme_ui_tabs_start_tab));
1320 my ($name, $tab) = @_;
1321 my $defclass = $tab eq $main::ui_tabs_selected ?
1322                         'opener_shown' : 'opener_hidden';
1323 my $rv = "<div id='div_$tab' class='$defclass'>\n";
1324 return $rv;
1325 }
1326
1327 # ui_tabs_start_tabletab(name, tab)
1328 # Behaves like ui_tabs_start_tab, but for use within a ui_table_start block
1329 sub ui_tabs_start_tabletab
1330 {
1331 return &theme_ui_tabs_start_tabletab(@_)
1332         if (defined(&theme_ui_tabs_start_tabletab));
1333 my $div = &ui_tabs_start_tab(@_);
1334 return "</table>\n".$div."<table width=100%>\n";
1335 }
1336
1337 sub ui_tabs_end_tab
1338 {
1339 return &theme_ui_tabs_end_tab(@_) if (defined(&theme_ui_tabs_end_tab));
1340 return "</div>\n";
1341 }
1342
1343 sub ui_tabs_end_tabletab
1344 {
1345 return &theme_ui_tabs_end_tabletab(@_)
1346         if (defined(&theme_ui_tabs_end_tabletab));
1347 return "</table></div><table width=100%>\n";
1348 }
1349
1350 # ui_max_text_width(width, [text-area?])
1351 # Returns a new width for a text field, based on theme settings
1352 sub ui_max_text_width
1353 {
1354 my ($w, $ta) = @_;
1355 my $max = $ta ? $tconfig{'maxareawidth'} : $tconfig{'maxboxwidth'};
1356 return $max && $w > $max ? $max : $w;
1357 }
1358
1359 ####################### radio hidden functions
1360
1361 # ui_radio_selector(&opts, name, selected)
1362 # Returns HTML for a set of radio buttons, each of which shows a different
1363 # block of HTML when selected. &opts is an array ref to arrays containing
1364 # [ value, label, html ]
1365 sub ui_radio_selector
1366 {
1367 return &theme_ui_radio_selector(@_) if (defined(&theme_ui_radio_selector));
1368 my ($opts, $name, $sel) = @_;
1369 my $rv;
1370 if (!$main::ui_radio_selector_donejs++) {
1371         $rv .= &ui_radio_selector_javascript();
1372         }
1373 my $optnames =
1374         "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$opts)."]";
1375 foreach my $o (@$opts) {
1376         $rv .= &ui_oneradio($name, $o->[0], $o->[1], $sel eq $o->[0],
1377             "onClick='selector_show(\"$name\", \"$o->[0]\", $optnames)'");
1378         }
1379 $rv .= "<br>\n";
1380 foreach my $o (@$opts) {
1381         my $cls = $o->[0] eq $sel ? "selector_shown" : "selector_hidden";
1382         $rv .= "<div id=sel_${name}_$o->[0] class=$cls>".$o->[2]."</div>\n";
1383         }
1384 return $rv;
1385 }
1386
1387 sub ui_radio_selector_javascript
1388 {
1389 return <<EOF;
1390 <style>
1391 .selector_shown {display:inline}
1392 .selector_hidden {display:none}
1393 </style>
1394 <script>
1395 function selector_show(name, value, values)
1396 {
1397 for(var i=0; i<values.length; i++) {
1398         var divobj = document.getElementById('sel_'+name+'_'+values[i]);
1399         divobj.className = value == values[i] ? 'selector_shown'
1400                                               : 'selector_hidden';
1401         }
1402 }
1403 </script>
1404 EOF
1405 }
1406
1407 ####################### grid layout functions
1408
1409 # ui_grid_table(&elements, columns, [width-percent], [tds], [tabletags],
1410 #               [title])
1411 # Given a list of HTML elements, formats them into a table with the given
1412 # number of columns. However, themes are free to override this to use fewer
1413 # columns where space is limited.
1414 sub ui_grid_table
1415 {
1416 return &theme_ui_grid_table(@_) if (defined(&theme_ui_grid_table));
1417 my ($elements, $cols, $width, $tds, $tabletags, $title) = @_;
1418 return "" if (!@$elements);
1419 my $rv = "<table".
1420             ($width ? " width=$width%" : "").
1421             ($tabletags ? " ".$tabletags : "").
1422             ">\n";
1423 my $i;
1424 for($i=0; $i<@$elements; $i++) {
1425         $rv .= "<tr>" if ($i%$cols == 0);
1426         $rv .= "<td ".$tds->[$i%$cols]." valign=top>".$elements->[$i]."</td>\n";
1427         $rv .= "</tr>" if ($i%$cols == $cols-1);
1428         }
1429 if ($i%$cols) {
1430         while($i%$cols) {
1431                 $rv .= "<td ".$tds->[$i%$cols]."><br></td>\n";
1432                 $i++;
1433                 }
1434         $rv .= "</tr>\n";
1435         }
1436 $rv .= "</table>\n";
1437 if (defined($title)) {
1438         $rv = "<table class=ui_table border ".
1439               ($width ? " width=$width%" : "").">\n".
1440               ($title ? "<tr $tb> <td><b>$title</b></td> </tr>\n" : "").
1441               "<tr $cb> <td>$rv</td> </tr>\n".
1442               "</table>";
1443         }
1444 return $rv;
1445 }
1446
1447 # ui_radio_table(name, selected, &rows)
1448 # Returns HTML for a table of radio buttons, each of which has a label and
1449 # some associated inputs to the right.
1450 sub ui_radio_table
1451 {
1452 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
1453 my ($name, $sel, $rows) = @_;
1454 return "" if (!@$rows);
1455 my $rv = "<table>\n";
1456 foreach my $r (@$rows) {
1457         $rv .= "<tr>\n";
1458         $rv .= "<td valign=top".(defined($r->[2]) ? "" : " colspan=2").
1459                "><b>".
1460                &ui_oneradio($name, $r->[0], $r->[1], $r->[0] eq $sel).
1461                "</b></td>\n";
1462         if (defined($r->[2])) {
1463                 $rv .= "<td valign=top>".$r->[2]."</td>\n";
1464                 }
1465         $rv .= "</tr>\n";
1466         }
1467 $rv .= "</table>\n";
1468 return $rv;
1469 }
1470
1471 # ui_up_down_arrows(uplink, downlink, up-show, down-show)
1472 # Returns HTML for moving some objects in a table up or down
1473 sub ui_up_down_arrows
1474 {
1475 return &theme_ui_up_down_arrows(@_) if (defined(&theme_ui_up_down_arrows));
1476 my ($uplink, $downlink, $upshow, $downshow) = @_;
1477 my $mover;
1478 my $imgdir = "$gconfig{'webprefix'}/images";
1479 if ($downshow) {
1480         $mover .= "<a href=\"$downlink\">".
1481                   "<img src=$imgdir/movedown.gif border=0></a>";
1482         }
1483 else {
1484         $mover .= "<img src=$imgdir/movegap.gif>";
1485         }
1486 if ($upshow) {
1487         $mover .= "<a href=\"$uplink\">".
1488                   "<img src=$imgdir/moveup.gif border=0></a>";
1489         }
1490 else {
1491         $mover .= "<img src=$imgdir/movegap.gif>";
1492         }
1493 return $mover;
1494 }
1495
1496 # ui_hr()
1497 # Returns a horizontal row tag
1498 sub ui_hr
1499 {
1500 return &theme_ui_hr() if (defined(&theme_ui_hr));
1501 return "<hr>\n";
1502 }
1503
1504 # ui_nav_link(direction, url, disabled)
1505 # Returns an arrow icon linking to provided url
1506 sub ui_nav_link
1507 {
1508 return &theme_ui_nav_link(@_) if (defined(&theme_ui_nav_link));
1509 my ($direction, $url, $disabled) = @_;
1510 my $alt = $direction eq "left" ? '<-' : '->';
1511 if ($disabled) {
1512         return "<img alt=\"$alt\" align=\"middle\""
1513              . "src=\"$gconfig{'webprefix'}/images/$direction-grey.gif\">\n";
1514         }
1515 else {
1516         return "<a href=\"$url\"><img alt=\"$alt\" align=\"middle\""
1517              . "src=\"$gconfig{'webprefix'}/images/$direction.gif\"></a>\n";
1518         }
1519 }
1520
1521 # ui_confirmation_form(cgi, message, &hiddens, [&buttons], [&otherinputs],
1522 #                      [extra-warning])
1523 # Returns HTML for a form asking for confirmation before performing some
1524 # action, such as deleting a user.
1525 sub ui_confirmation_form
1526 {
1527 my ($cgi, $message, $hiddens, $buttons, $others, $warning) = @_;
1528 my $rv;
1529 $rv .= "<center class=ui_confirmation>\n";
1530 $rv .= &ui_form_start($cgi, "post");
1531 foreach my $h (@$hiddens) {
1532         $rv .= &ui_hidden(@$h);
1533         }
1534 $rv .= "<b>$message</b><p>\n";
1535 if ($warning) {
1536         $rv .= "<b><font color=#ff0000>$warning</font></b><p>\n";
1537         }
1538 if ($others) {
1539         $rv .= $others."<p>\n";
1540         }
1541 $rv .= &ui_form_end($buttons);
1542 $rv .= "</center>\n";
1543 return $rv;
1544 }
1545
1546 ####################### javascript functions
1547
1548 # js_disable_input(&disable-inputs, &enable-inputs, [tag])
1549 # Returns Javascript to disable some form elements and enable others
1550 sub js_disable_inputs
1551 {
1552 my $rv;
1553 my $f;
1554 foreach $f (@{$_[0]}) {
1555         $rv .= "e = form.elements[\"$f\"]; e.disabled = true; ";
1556         $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = true; } ";
1557         }
1558 foreach $f (@{$_[1]}) {
1559         $rv .= "e = form.elements[\"$f\"]; e.disabled = false; ";
1560         $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = false; } ";
1561         }
1562 foreach $f (@{$_[1]}) {
1563         if ($f =~ /^(.*)_def$/ && &indexof($1, @{$_[1]}) >= 0) {
1564                 # When enabling both a _def field and its associated text field,
1565                 # disable the text if the _def is set to 1
1566                 my $tf = $1;
1567                 $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 } } ";
1568                 }
1569         }
1570 return $_[2] ? "$_[2]='$rv'" : $rv;
1571 }
1572
1573 # ui_page_flipper(message, [inputs, cgi], left-link, right-link,
1574 #                 [far-left-link], [far-right-link])
1575 # Returns HTML for moving left and right in some large list, such as an inbox
1576 # or database table. If only 5 parameters are given, no far links are included.
1577 # If any link is undef, that array will be greyed out.
1578 sub ui_page_flipper
1579 {
1580 return &theme_ui_page_flipper(@_) if (defined(&theme_ui_page_flipper));
1581 my ($msg, $inputs, $cgi, $left, $right, $farleft, $farright) = @_;
1582 my $rv = "<center>";
1583 $rv .= &ui_form_start($cgi) if ($cgi);
1584
1585 # Far left link, if needed
1586 if (@_ > 5) {
1587         if ($farleft) {
1588                 $rv .= "<a href='$farleft'><img src=/images/first.gif ".
1589                        "border=0 align=middle></a>\n";
1590                 }
1591         else {
1592                 $rv .= "<img src=/images/first-grey.gif ".
1593                        "border=0 align=middle></a>\n";
1594                 }
1595         }
1596
1597 # Left link
1598 if ($left) {
1599         $rv .= "<a href='$left'><img src=/images/left.gif ".
1600                "border=0 align=middle></a>\n";
1601         }
1602 else {
1603         $rv .= "<img src=/images/left-grey.gif ".
1604                "border=0 align=middle></a>\n";
1605         }
1606
1607 # Message and inputs
1608 $rv .= $msg;
1609 $rv .= " ".$inputs if ($inputs);
1610
1611 # Right link
1612 if ($right) {
1613         $rv .= "<a href='$right'><img src=/images/right.gif ".
1614                "border=0 align=middle></a>\n";
1615         }
1616 else {
1617         $rv .= "<img src=/images/right-grey.gif ".
1618                "border=0 align=middle></a>\n";
1619         }
1620
1621 # Far right link, if needed
1622 if (@_ > 5) {
1623         if ($farright) {
1624                 $rv .= "<a href='$farright'><img src=/images/last.gif ".
1625                        "border=0 align=middle></a>\n";
1626                 }
1627         else {
1628                 $rv .= "<img src=/images/last-grey.gif ".
1629                        "border=0 align=middle></a>\n";
1630                 }
1631         }
1632
1633 $rv .= &ui_form_end() if ($cgi);
1634 $rv .= "</center>\n";
1635 return $rv;
1636 }
1637
1638 # js_checkbox_disable(name, &checked-disable, &checked-enable, [tag])
1639 sub js_checkbox_disable
1640 {
1641 my $rv;
1642 my $f;
1643 foreach $f (@{$_[1]}) {
1644         $rv .= "form.elements[\"$f\"].disabled = $_[0].checked; ";
1645         }
1646 foreach $f (@{$_[2]}) {
1647         $rv .= "form.elements[\"$f\"].disabled = !$_[0].checked; ";
1648         }
1649 return $_[3] ? "$_[3]='$rv'" : $rv;
1650 }
1651
1652 # js_redirect(url)
1653 # Returns HTML to trigger a redirect to some URL
1654 sub js_redirect
1655 {
1656 my ($url) = @_;
1657 if (defined(&theme_js_redirect)) {
1658         return &theme_js_redirect(@_);
1659         }
1660 return "<script>window.location = '".&quote_escape($url)."';</script>\n";
1661 }
1662
1663 1;
1664