ui-lib.pl

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