ui-lib.pl

   1 # ui-lib.pl
   2 # Common functions for generating HTML for Webmin user interface elements
   3
   4 ####################### table generation functions
   5
   6 # ui_table_start(heading, [tabletags], [cols], [&default-tds])
   7 # A table with a heading and table inside
   8 sub ui_table_start
   9 {
  10 return &theme_ui_table_start(@_) if (defined(&theme_ui_table_start));
  11 local ($heading, $tabletags, $cols, $tds) = @_;
  12 if (defined($main::ui_table_cols)) {
  13         # Push on stack, for nested call
  14         push(@main::ui_table_cols_stack, $main::ui_table_cols);
  15         push(@main::ui_table_pos_stack, $main::ui_table_pos);
  16         push(@main::ui_table_default_tds_stack, $main::ui_table_default_tds);
  17         }
  18 local $rv;
  19 $rv .= "<table class='ui_table' border $tabletags>\n";
  20 $rv .= "<tr $tb> <td><b>$heading</b></td> </tr>\n" if (defined($heading));
  21 $rv .= "<tr $cb> <td><table width=100%>\n";
  22 $main::ui_table_cols = $cols || 4;
  23 $main::ui_table_pos = 0;
  24 $main::ui_table_default_tds = $tds;
  25 return $rv;
  26 }
  27
  28 # ui_table_end()
  29 # The end of a table started by ui_table_start
  30 sub ui_table_end
  31 {
  32 return &theme_ui_table_end(@_) if (defined(&theme_ui_table_end));
  33 local $rv;
  34 if ($main::ui_table_cols == 4 && $main::ui_table_pos) {
  35         # Add an empty block to balance the table
  36         $rv .= &ui_table_row(" ", " ");
  37         }
  38 if (@main::ui_table_cols_stack) {
  39         $main::ui_table_cols = pop(@main::ui_table_cols_stack);
  40         $main::ui_table_pos = pop(@main::ui_table_pos_stack);
  41         $main::ui_table_default_tds = pop(@main::ui_table_default_tds_stack);
  42         }
  43 else {
  44         $main::ui_table_cols = undef;
  45         $main::ui_table_pos = undef;
  46         $main::ui_table_default_tds = undef;
  47         }
  48 $rv .= "</table></td></tr></table>\n";
  49 return $rv;
  50 }
  51
  52 # ui_columns_start(&headings, [width-percent], [noborder], [&tdtags], [heading])
  53 # Returns HTML for a multi-column table, with the given headings
  54 sub ui_columns_start
  55 {
  56 return &theme_ui_columns_start(@_) if (defined(&theme_ui_columns_start));
  57 local ($heads, $width, $noborder, $tdtags, $title) = @_;
  58 local $rv;
  59 $rv .= "<table".($noborder ? "" : " border").
  60                 (defined($width) ? " width=$width%" : "")." class='ui_columns'>\n";
  61 if ($title) {
  62         $rv .= "<tr $tb><td colspan=".scalar(@$heads).
  63                " class='ui_columns_heading'><b>$title</b></td></tr>\n";
  64         }
  65 $rv .= "<tr $tb class='ui_columns_heads'>\n";
  66 local $i;
  67 for($i=0; $i<@$heads; $i++) {
  68         $rv .= "<td ".$tdtags->[$i]."><b>".
  69                ($heads->[$i] eq "" ? "<br>" : $heads->[$i])."</b></td>\n";
  70         }
  71 $rv .= "</tr>\n";
  72 return $rv;
  73 }
  74
  75 # ui_columns_row(&columns, &tdtags)
  76 # Returns HTML for a row in a multi-column table
  77 sub ui_columns_row
  78 {
  79 return &theme_ui_columns_row(@_) if (defined(&theme_ui_columns_row));
  80 local ($cols, $tdtags) = @_;
  81 local $rv;
  82 $rv .= "<tr $cb class='ui_columns_row'>\n";
  83 local $i;
  84 for($i=0; $i<@$cols; $i++) {
  85         $rv .= "<td ".$tdtags->[$i].">".
  86                ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i])."</td>\n";
  87         }
  88 $rv .= "</tr>\n";
  89 return $rv;
  90 }
  91
  92 # ui_columns_header(&columns, &tdtags)
  93 # Returns HTML for a row in a multi-column table, with a header background
  94 sub ui_columns_header
  95 {
  96 return &theme_ui_columns_header(@_) if (defined(&theme_ui_columns_header));
  97 local ($cols, $tdtags) = @_;
  98 local $rv;
  99 $rv .= "<tr $tb class='ui_columns_header'>\n";
 100 local $i;
 101 for($i=0; $i<@$cols; $i++) {
 102         $rv .= "<td ".$tdtags->[$i]."><b>".
 103                ($cols->[$i] eq "" ? "<br>" : $cols->[$i])."</b></td>\n";
 104         }
 105 $rv .= "</tr>\n";
 106 return $rv;
 107 }
 108
 109 # ui_checked_columns_row(&columns, &tdtags, checkname, checkvalue, [checked?],
 110 #                        [disabled])
 111 # Returns HTML for a row in a multi-column table, in which the first
 112 # column is a checkbox
 113 sub ui_checked_columns_row
 114 {
 115 return &theme_ui_checked_columns_row(@_) if (defined(&theme_ui_checked_columns_row));
 116 local ($cols, $tdtags, $checkname, $checkvalue, $checked, $disabled) = @_;
 117 local $rv;
 118 $rv .= "<tr $cb class='ui_checked_columns'>\n";
 119 $rv .= "<td class='ui_checked_checkbox' ".$tdtags->[0].">".
 120        &ui_checkbox($checkname, $checkvalue, undef, $checked, undef, $disabled).
 121        "</td>\n";
 122 local $i;
 123 for($i=0; $i<@$cols; $i++) {
 124         $rv .= "<td ".$tdtags->[$i+1].">";
 125         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
 126                 $rv .= "<label for=\"".
 127                         &quote_escape("${checkname}_${checkvalue}")."\">";
 128                 }
 129         $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
 130         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
 131                 $rv .= "</label>";
 132                 }
 133         $rv .= "</td>\n";
 134         }
 135 $rv .= "</tr>\n";
 136 return $rv;
 137 }
 138
 139 # ui_radio_columns_row(&columns, &tdtags, checkname, checkvalue, [checked],
 140 #                      [disabled])
 141 # Returns HTML for a row in a multi-column table, in which the first
 142 # column is a radio button
 143 sub ui_radio_columns_row
 144 {
 145 return &theme_ui_radio_columns_row(@_) if (defined(&theme_ui_radio_columns_row));
 146 local ($cols, $tdtags, $checkname, $checkvalue, $checked, $dis) = @_;
 147 local $rv;
 148 $rv .= "<tr $cb class='ui_radio_columns'>\n";
 149 $rv .= "<td class='ui_radio_radio' ".$tdtags->[0].">".
 150     &ui_oneradio($checkname, $checkvalue, "", $checked, undef, $dis)."</td>\n";
 151 local $i;
 152 for($i=0; $i<@$cols; $i++) {
 153         $rv .= "<td ".$tdtags->[$i+1].">";
 154         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
 155                 $rv .= "<label for=\"".
 156                         &quote_escape("${checkname}_${checkvalue}")."\">";
 157                 }
 158         $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
 159         if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
 160                 $rv .= "</label>";
 161                 }
 162         $rv .= "</td>\n";
 163         }
 164 $rv .= "</tr>\n";
 165 return $rv;
 166 }
 167
 168 # ui_columns_end()
 169 # Returns HTML to end a table started by ui_columns_start
 170 sub ui_columns_end
 171 {
 172 return &theme_ui_columns_end(@_) if (defined(&theme_ui_columns_end));
 173 return "</table>\n";
 174 }
 175
 176 # ui_columns_table(&headings, width-percent, &data, &types, no-sort, title,
 177 #                  empty-msg)
 178 # Returns HTML for a complete table.
 179 # headings - An array ref of heading HTML
 180 # width-percent - Preferred total width
 181 # data - A 2x2 array ref of table contents. Each can either be a simple string,
 182 #        or a hash ref like :
 183 #          { 'type' => 'group', 'desc' => 'Some section title' }
 184 #          { 'type' => 'string', 'value' => 'Foo', 'colums' => 3,
 185 #            '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 local ($heads, $width, $data, $types, $nosort, $title, $emptymsg) = @_;
 198 local $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 local @tds = map { "valign=top" } @$heads;
 209 local $maxwidth = 0;
 210 foreach my $r (@$data) {
 211         local $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         local $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         local @rtds = @tds;
 234         local @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 local ($cgi, $buttons, $selectall, $others, $hiddens,
 312        $heads, $width, $data, $types, $nosort, $title, $emptymsg) = @_;
 313 local $rv;
 314
 315 # Build links
 316 local @leftlinks = map { "<a href='$_->[0]'>$_->[1]</a>" }
 317                        grep { $_->[2] ne 'right' } @$others;
 318 local @rightlinks = map { "<a href='$_->[0]'>$_->[1]</a>" }
 319                        grep { $_->[2] eq 'right' } @$others;
 320 local $links;
 321
 322 # Add select links
 323 if (@$data) {
 324         if ($selectall) {
 325                 local $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 local ($script, $method, $target, $tags) = @_;
 381 local $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 local ($buttons, $width) = @_;
 399 local $rv;
 400 if ($buttons && @$buttons) {
 401         $rv .= "<table class='ui_form_end_buttons' ".($width ? " width=$width" : "")."><tr>\n";
 402         local $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 local ($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 local ($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 local ($name, $bytes, $size, $dis) = @_;
 456 local $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 local ($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 local ($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 local ($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 local ($name, $value, $opts, $size, $multiple, $missing, $dis, $js) = @_;
 524 local $rv;
 525 $rv .= "<select name=\"".&quote_escape($name)."\"".
 526        ($size ? " size=$size" : "").
 527        ($multiple ? " multiple" : "").
 528        ($dis ? " disabled=true" : "")." ".$js.">\n";
 529 local ($o, %opt, $s);
 530 local %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 # XXX IE testing
 554 # XXX mobile theme
 555 sub ui_multi_select
 556 {
 557 return &theme_ui_multi_select(@_) if (defined(&theme_ui_multi_select));
 558 local ($name, $values, $opts, $size, $missing, $dis,
 559        $opts_title, $vals_title, $width) = @_;
 560 local $rv;
 561 local %already = map { $_->[0], $_ } @$values;
 562 local $leftover = [ grep { !$already{$_->[0]} } @$opts ];
 563 if ($missing) {
 564         local %optsalready = map { $_->[0], $_ } @$opts;
 565         push(@$opts, grep { !$optsalready{$_->[0]} } @$values);
 566         }
 567 if (!defined($width)) {
 568         $width = "200";
 569         }
 570 local $wstyle = $width ? "style='width:$width'" : "";
 571
 572 if (!$main::ui_multi_select_donejs++) {
 573         $rv .= &ui_multi_select_javascript();
 574         }
 575 $rv .= "<table cellpadding=0 cellspacing=0 class='ui_multi_select'>";
 576 if (defined($opts_title)) {
 577         $rv .= "<tr class='ui_multi_select_heads'> ".
 578                "<td><b>$opts_title</b></td> ".
 579                "<td></td> <td><b>$vals_title</b></td> </tr>";
 580         }
 581 $rv .= "<tr class='ui_multi_select_row'>";
 582 $rv .= "<td>".&ui_select($name."_opts", [ ], $leftover,
 583                          $size, 0, 0, $dis, $wstyle)."</td>\n";
 584 $rv .= "<td>".&ui_button("->", undef, $dis,
 585                  "onClick='multi_select_move(\"$name\", form, 1)'")."<br>".
 586               &ui_button("<-", undef, $dis,
 587                  "onClick='multi_select_move(\"$name\", form, 0)'")."</td>\n";
 588 $rv .= "<td>".&ui_select($name."_vals", [ ], $values,
 589                          $size, 0, 0, $dis, $wstyle)."</td>\n";
 590 $rv .= "</tr></table>\n";
 591 $rv .= &ui_hidden($name, join("\n", map { $_->[0] } @$values));
 592 return $rv;
 593 }
 594
 595 # ui_multi_select_javascript()
 596 # Returns <script> section for left/right select boxes
 597 sub ui_multi_select_javascript
 598 {
 599 return &theme_ui_multiselect_javascript()
 600         if (defined(&theme_ui_multiselect_javascript));
 601 return <<EOF;
 602 <script>
 603 // Move an element from the options list to the values list, or vice-versa
 604 function multi_select_move(name, f, dir)
 605 {
 606 var opts = f.elements[name+"_opts"];
 607 var vals = f.elements[name+"_vals"];
 608 var opts_idx = opts.selectedIndex;
 609 var vals_idx = vals.selectedIndex;
 610 if (dir == 1 && opts_idx >= 0) {
 611         // Moving from options to selected list
 612         var o = opts.options[opts_idx];
 613         vals.options[vals.options.length] = o;
 614         opts.remove(opts_idx);
 615         }
 616 else if (dir == 0 && vals_idx >= 0) {
 617         // Moving the other way
 618         var o = vals.options[vals_idx];
 619         opts.options[opts.options.length] = o;
 620         vals.remove(vals_idx);
 621         }
 622 // Fill in hidden field
 623 var hid = f.elements[name];
 624 if (hid) {
 625         var hv = new Array();
 626         for(var i=0; i<vals.options.length; i++) {
 627                 hv.push(vals.options[i].value);
 628                 }
 629         hid.value = hv.join("\\n");
 630         }
 631 }
 632 </script>
 633 EOF
 634 }
 635
 636 # ui_radio(name, value, &options, [disabled?])
 637 # Returns HTML for a series of radio buttons
 638 sub ui_radio
 639 {
 640 return &theme_ui_radio(@_) if (defined(&theme_ui_radio));
 641 local ($name, $value, $opts, $dis) = @_;
 642 local $rv;
 643 local $o;
 644 foreach $o (@$opts) {
 645         local $id = &quote_escape($name."_".$o->[0]);
 646         local $label = $o->[1] || $o->[0];
 647         local $after;
 648         if ($label =~ /^(.*?)((<a\s+href|<input|<select|<textarea)[\000-\377]*)$/i) {
 649                 $label = $1;
 650                 $after = $2;
 651                 }
 652         $rv .= "<input type=radio name=\"".&quote_escape($name)."\" ".
 653                "value=\"".&quote_escape($o->[0])."\"".
 654                ($o->[0] eq $value ? " checked" : "").
 655                ($dis ? " disabled=true" : "").
 656                " id=\"$id\"".
 657                " $o->[2]> <label for=\"$id\">".
 658                $label."</label>".$after."\n";
 659         }
 660 return $rv;
 661 }
 662
 663 # ui_yesno_radio(name, value, [yes], [no], [disabled?])
 664 # Like ui_yesno, but always displays just two inputs (yes and no)
 665 sub ui_yesno_radio
 666 {
 667 local ($name, $value, $yes, $no, $dis) = @_;
 668 return &theme_ui_yesno_radio(@_) if (defined(&theme_ui_yesno_radio));
 669 $yes = 1 if (!defined($yes));
 670 $no = 0 if (!defined($no));
 671 $value = int($value);
 672 return &ui_radio($name, $value, [ [ $yes, $text{'yes'} ],
 673                                   [ $no, $text{'no'} ] ], $dis);
 674 }
 675
 676 # ui_checkbox(name, value, label, selected?, [tags], [disabled?])
 677 # Returns HTML for a single checkbox
 678 sub ui_checkbox
 679 {
 680 return &theme_ui_checkbox(@_) if (defined(&theme_ui_checkbox));
 681 local ($name, $value, $label, $sel, $tags, $dis) = @_;
 682 local $after;
 683 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
 684         $label = $1;
 685         $after = $2;
 686         }
 687 return "<input type=checkbox name=\"".&quote_escape($name)."\" ".
 688        "value=\"".&quote_escape($value)."\" ".
 689        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
 690        " id=\"".&quote_escape("${name}_${value}")."\"".
 691        " $tags> ".
 692        ($label eq "" ? $after :
 693          "<label for=\"".&quote_escape("${name}_${value}").
 694          "\">$label</label>$after")."\n";
 695 }
 696
 697 # ui_oneradio(name, value, label, selected?, [tags], [disabled?])
 698 # Returns HTML for a single radio button
 699 sub ui_oneradio
 700 {
 701 return &theme_ui_oneradio(@_) if (defined(&theme_ui_oneradio));
 702 local ($name, $value, $label, $sel, $tags, $dis) = @_;
 703 local $id = &quote_escape("${name}_${value}");
 704 local $after;
 705 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
 706         $label = $1;
 707         $after = $2;
 708         }
 709 return "<input type=radio name=\"".&quote_escape($name)."\" ".
 710        "value=\"".&quote_escape($value)."\" ".
 711        ($sel ? " checked" : "").($dis ? " disabled=true" : "").
 712        " id=\"$id\"".
 713        " $tags> <label for=\"$id\">$label</label>$after\n";
 714 }
 715
 716 # ui_textarea(name, value, rows, cols, [wrap], [disabled?], [tags])
 717 # Returns HTML for a multi-line text input
 718 sub ui_textarea
 719 {
 720 return &theme_ui_textarea(@_) if (defined(&theme_ui_textarea));
 721 local ($name, $value, $rows, $cols, $wrap, $dis, $tags) = @_;
 722 $cols = &ui_max_text_width($cols, 1);
 723 return "<textarea name=\"".&quote_escape($name)."\" ".
 724        "rows=$rows cols=$cols".($wrap ? " wrap=$wrap" : "").
 725        ($dis ? " disabled=true" : "").
 726        ($tags ? " $tags" : "").">".
 727        &html_escape($value).
 728        "</textarea>";
 729 }
 730
 731 # ui_user_textbox(name, value, [form], [disabled?], [tags])
 732 # Returns HTML for a Unix user input
 733 sub ui_user_textbox
 734 {
 735 return &theme_ui_user_textbox(@_) if (defined(&theme_ui_user_textbox));
 736 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
 737        &user_chooser_button($_[0], 0, $_[2]);
 738 }
 739
 740 # ui_group_textbox(name, value, [form], [disabled?], [tags])
 741 # Returns HTML for a Unix group input
 742 sub ui_group_textbox
 743 {
 744 return &theme_ui_group_textbox(@_) if (defined(&theme_ui_group_textbox));
 745 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
 746        &group_chooser_button($_[0], 0, $_[2]);
 747 }
 748
 749 # ui_opt_textbox(name, value, size, option1, [option2], [disabled?],
 750 #                [&extra-fields], [max])
 751 # Returns HTML for a text field that is optional
 752 sub ui_opt_textbox
 753 {
 754 return &theme_ui_opt_textbox(@_) if (defined(&theme_ui_opt_textbox));
 755 local ($name, $value, $size, $opt1, $opt2, $dis, $extra, $max) = @_;
 756 local $dis1 = &js_disable_inputs([ $name, @$extra ], [ ]);
 757 local $dis2 = &js_disable_inputs([ ], [ $name, @$extra ]);
 758 local $rv;
 759 $size = &ui_max_text_width($size);
 760 $rv .= &ui_radio($name."_def", $value eq '' ? 1 : 0,
 761                  [ [ 1, $opt1, "onClick='$dis1'" ],
 762                    [ 0, $opt2 || " ", "onClick='$dis2'" ] ], $dis)."\n";
 763 $rv .= "<input name=\"".&quote_escape($name)."\" ".
 764        "size=$size value=\"".&quote_escape($value)."\" ".
 765        ($value eq "" || $dis ? "disabled=true" : "").
 766        ($max ? " maxlength=$max" : "").">\n";
 767 return $rv;
 768 }
 769
 770 # ui_submit(label, [name], [disabled?], [tags])
 771 # Returns HTML for a form submit button
 772 sub ui_submit
 773 {
 774 return &theme_ui_submit(@_) if (defined(&theme_ui_submit));
 775 local ($label, $name, $dis, $tags) = @_;
 776 return "<input type=submit".
 777        ($name ne '' ? " name=\"".&quote_escape($name)."\"" : "").
 778        " value=\"".&quote_escape($label)."\"".
 779        ($dis ? " disabled=true" : "").
 780        ($tags ? " ".$tags : "").">\n";
 781
 782 }
 783
 784 # ui_reset(label, [disabled?])
 785 # Returns HTML for a form reset button
 786 sub ui_reset
 787 {
 788 return &theme_ui_reset(@_) if (defined(&theme_ui_reset));
 789 local ($label, $dis) = @_;
 790 return "<input type=reset value=\"".&quote_escape($label)."\"".
 791        ($dis ? " disabled=true" : "").">\n";
 792
 793 }
 794
 795 # ui_button(label, [name], [disabled?], [tags])
 796 # Returns HTML for a form button
 797 sub ui_button
 798 {
 799 return &theme_ui_button(@_) if (defined(&theme_ui_button));
 800 local ($label, $name, $dis, $tags) = @_;
 801 return "<input type=button".
 802        ($name ne '' ? " name=\"".&quote_escape($name)."\"" : "").
 803        " value=\"".&quote_escape($label)."\"".
 804        ($dis ? " disabled=true" : "").
 805        ($tags ? " ".$tags : "").">\n";
 806 }
 807
 808 # ui_date_input(day, month, year, day-name, month-name, year-name, [disabled?])
 809 # Returns HTML for a date-selection field
 810 sub ui_date_input
 811 {
 812 local ($day, $month, $year, $dayname, $monthname, $yearname, $dis) = @_;
 813 local $rv;
 814 $rv .= &ui_textbox($dayname, $day, 3, $dis);
 815 $rv .= "/";
 816 $rv .= &ui_select($monthname, $month,
 817                   [ map { [ $_, $text{"smonth_$_"} ] } (1 .. 12) ],
 818                   1, 0, 0, $dis);
 819 $rv .= "/";
 820 $rv .= &ui_textbox($yearname, $year, 5, $dis);
 821 return $rv;
 822 }
 823
 824 # ui_table_row(label, value, [cols], [&td-tags])
 825 # Returns HTML for a row in a table started by ui_table_start, with a 1-column
 826 # label and 1+ column value.
 827 sub ui_table_row
 828 {
 829 return &theme_ui_table_row(@_) if (defined(&theme_ui_table_row));
 830 local ($label, $value, $cols, $tds) = @_;
 831 $cols ||= 1;
 832 $tds ||= $main::ui_table_default_tds;
 833 local $rv;
 834 if ($main::ui_table_pos+$cols+1 > $main::ui_table_cols &&
 835     $main::ui_table_pos != 0) {
 836         # If the requested number of cols won't fit in the number
 837         # remaining, start a new row
 838         $rv .= "</tr>\n";
 839         $main::ui_table_pos = 0;
 840         }
 841 $rv .= "<tr>\n" if ($main::ui_table_pos%$main::ui_table_cols == 0);
 842 $rv .= "<td valign=top $tds->[0]><b>$label</b></td>\n" if (defined($label));
 843 $rv .= "<td valign=top colspan=$cols $tds->[1]>$value</td>\n";
 844 $main::ui_table_pos += $cols+(defined($label) ? 1 : 0);
 845 if ($main::ui_table_pos%$main::ui_table_cols == 0) {
 846         $rv .= "</tr>\n";
 847         $main::ui_table_pos = 0;
 848         }
 849 return $rv;
 850 }
 851
 852 # ui_table_hr()
 853 sub ui_table_hr
 854 {
 855 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
 856 local $rv;
 857 if ($ui_table_pos) {
 858         $rv .= "</tr>\n";
 859         $ui_table_pos = 0;
 860         }
 861 $rv .= "<tr> <td colspan=$main::ui_table_cols><hr></td> </tr>\n";
 862 return $rv;
 863 }
 864
 865 # ui_table_span(text)
 866 # Outputs a table row that spans the whole table, and contains the given text
 867 sub ui_table_span
 868 {
 869 local ($text) = @_;
 870 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
 871 local $rv;
 872 if ($ui_table_pos) {
 873         $rv .= "</tr>\n";
 874         $ui_table_pos = 0;
 875         }
 876 $rv .= "<tr> <td colspan=$main::ui_table_cols>$text</td> </tr>\n";
 877 return $rv;
 878 }
 879
 880 # ui_buttons_start()
 881 sub ui_buttons_start
 882 {
 883 return &theme_ui_buttons_start(@_) if (defined(&theme_ui_buttons_start));
 884 return "<table width=100%>\n";
 885 }
 886
 887 # ui_buttons_end()
 888 sub ui_buttons_end
 889 {
 890 return &theme_ui_buttons_end(@_) if (defined(&theme_ui_buttons_end));
 891 return "</table>\n";
 892 }
 893
 894 # ui_buttons_row(script, button-label, description, [hiddens], [after-submit],
 895 #                [before-submit])
 896 sub ui_buttons_row
 897 {
 898 return &theme_ui_buttons_row(@_) if (defined(&theme_ui_buttons_row));
 899 local ($script, $label, $desc, $hiddens, $after, $before) = @_;
 900 return "<form action=$script>\n".
 901        $hiddens.
 902        "<tr> <td nowrap width=20% valign=top>".($before ? $before." " : "").
 903        &ui_submit($label).($after ? " ".$after : "")."</td>\n".
 904        "<td valign=top width=80% valign=top>$desc</td> </tr>\n".
 905        "</form>\n";
 906 }
 907
 908 # ui_buttons_hr([title])
 909 sub ui_buttons_hr
 910 {
 911 local ($title) = @_;
 912 return &theme_ui_buttons_hr(@_) if (defined(&theme_ui_buttons_hr));
 913 if ($title) {
 914         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";
 915         }
 916 else {
 917         return "<tr> <td colspan=2><hr></td> </tr>\n";
 918         }
 919 }
 920
 921 ####################### header and footer functions
 922
 923 # ui_post_header([subtext])
 924 # Returns HTML to appear directly after a standard header() call
 925 sub ui_post_header
 926 {
 927 return &theme_ui_post_header(@_) if (defined(&theme_ui_post_header));
 928 local ($text) = @_;
 929 local $rv;
 930 $rv .= "<center class='ui_post_header'><font size=+1>$text</font></center>\n" if (defined($text));
 931 if (!$tconfig{'nohr'} && !$tconfig{'notophr'}) {
 932         $rv .= "<hr id='post_header_hr'>\n";
 933         }
 934 return $rv;
 935 }
 936
 937 # ui_pre_footer()
 938 # Returns HTML to appear directly before a standard footer() call
 939 sub ui_pre_footer
 940 {
 941 return &theme_ui_pre_footer(@_) if (defined(&theme_ui_pre_footer));
 942 local $rv;
 943 if (!$tconfig{'nohr'} && !$tconfig{'nobottomhr'}) {
 944         $rv .= "<hr id='pre_footer_hr'>\n";
 945         }
 946 return $rv;
 947 }
 948
 949 # ui_print_header(subtext, args...)
 950 # Print HTML for a header with the post-header line. The args are the same
 951 # as those passed to header()
 952 sub ui_print_header
 953 {
 954 &load_theme_library();
 955 return &theme_ui_print_header(@_) if (defined(&theme_ui_print_header));
 956 local ($text, @args) = @_;
 957 &header(@args);
 958 print &ui_post_header($text);
 959 }
 960
 961 # ui_print_unbuffered_header(subtext, args...)
 962 # Like ui_print_header, but ensures that output for this page is not buffered
 963 # or contained in a table.
 964 sub ui_print_unbuffered_header
 965 {
 966 &load_theme_library();
 967 return &theme_ui_print_unbuffered_header(@_) if (defined(&theme_ui_print_unbuffered_header));
 968 $| = 1;
 969 $theme_no_table = 1;
 970 &ui_print_header(@_);
 971 }
 972
 973 # ui_print_footer(args...)
 974 # Print HTML for a footer with the pre-footer line. Args are the same as those
 975 # passed to footer()
 976 sub ui_print_footer
 977 {
 978 return &theme_ui_print_footer(@_) if (defined(&theme_ui_print_footer));
 979 local @args = @_;
 980 print &ui_pre_footer();
 981 &footer(@args);
 982 }
 983
 984 # ui_config_link(text, &subs)
 985 # Returns HTML for a module config link. The first non-null sub will be
 986 # replaced with the appropriate URL.
 987 sub ui_config_link
 988 {
 989 return &theme_ui_config_link(@_) if (defined(&theme_ui_config_link));
 990 local ($text, $subs) = @_;
 991 local @subs = map { $_ || "../config.cgi?$module_name" }
 992                   ($subs ? @$subs : ( undef ));
 993 return "<p>".&text($text, @subs)."<p>\n";
 994 }
 995
 996 # ui_print_endpage(text)
 997 # Prints HTML for an error message followed by a page footer with a link to
 998 # /, then exits. Good for main page error messages.
 999 sub ui_print_endpage
1000 {
1001 return &theme_ui_print_endpage(@_) if (defined(&theme_ui_print_endpage));
1002 local ($text) = @_;
1003 print $text,"<p class='ui_footer'>\n";
1004 print "</p>\n";
1005 &ui_print_footer("/", $text{'index'});
1006 exit;
1007 }
1008
1009 # ui_subheading(text, ...)
1010 # Returns HTML for a section heading
1011 sub ui_subheading
1012 {
1013 return &theme_ui_subheading(@_) if (defined(&theme_ui_subheading));
1014 return "<h3 class='ui_subheading'>".join("", @_)."</h3>\n";
1015 }
1016
1017 # ui_links_row(&links)
1018 # Returns HTML for a row of links, like select all / invert selection / add..
1019 sub ui_links_row
1020 {
1021 return &theme_ui_links_row(@_) if (defined(&theme_ui_links_row));
1022 local ($links) = @_;
1023 return @$links ? join("\n|\n", @$links)."<br>\n"
1024                : "";
1025 }
1026
1027 ########################### collapsible section / tab functions
1028
1029 # ui_hidden_javascript()
1030 # Returns <script> and <style> sections for hiding functions and CSS
1031 sub ui_hidden_javascript
1032 {
1033 return &theme_ui_hidden_javascript(@_)
1034         if (defined(&theme_ui_hidden_javascript));
1035 local $rv;
1036 local $imgdir = "$gconfig{'webprefix'}/images";
1037 local ($jscb, $jstb) = ($cb, $tb);
1038 $jscb =~ s/'/\\'/g;
1039 $jstb =~ s/'/\\'/g;
1040
1041 return <<EOF;
1042 <style>
1043 .opener_shown {display:inline}
1044 .opener_hidden {display:none}
1045 </style>
1046 <script>
1047 // Open or close a hidden section
1048 function hidden_opener(divid, openerid)
1049 {
1050 var divobj = document.getElementById(divid);
1051 var openerobj = document.getElementById(openerid);
1052 if (divobj.className == 'opener_shown') {
1053   divobj.className = 'opener_hidden';
1054   openerobj.innerHTML = '<img border=0 src=$imgdir/closed.gif>';
1055   }
1056 else {
1057   divobj.className = 'opener_shown';
1058   openerobj.innerHTML = '<img border=0 src=$imgdir/open.gif>';
1059   }
1060 }
1061
1062 // Show a tab
1063 function select_tab(name, tabname, form)
1064 {
1065 var tabnames = document[name+'_tabnames'];
1066 var tabtitles = document[name+'_tabtitles'];
1067 for(var i=0; i<tabnames.length; i++) {
1068   var tabobj = document.getElementById('tab_'+tabnames[i]);
1069   var divobj = document.getElementById('div_'+tabnames[i]);
1070   var title = tabtitles[i];
1071   if (tabnames[i] == tabname) {
1072     // Selected table
1073     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
1074                        '<td valign=top $jscb>'+
1075                        '<img src=$imgdir/lc2.gif alt=""></td>'+
1076                        '<td $jscb nowrap>'+
1077                        '&nbsp;<b>'+title+'</b>&nbsp;</td>'+
1078                        '<td valign=top $jscb>'+
1079                        '<img src=$imgdir/rc2.gif alt=""></td>'+
1080                        '</tr></table>';
1081     divobj.className = 'opener_shown';
1082     }
1083   else {
1084     // Non-selected tab
1085     tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
1086                        '<td valign=top $jstb>'+
1087                        '<img src=$imgdir/lc1.gif alt=""></td>'+
1088                        '<td $jstb nowrap>'+
1089                        '&nbsp;<a href=\\'\\' onClick=\\'return select_tab("'+
1090                        name+'", "'+tabnames[i]+'")\\'>'+title+'</a>&nbsp;</td>'+
1091                        '<td valign=top $jstb>'+
1092                        '<img src=$imgdir/rc1.gif alt=""></td>'+
1093                        '</tr></table>';
1094     divobj.className = 'opener_hidden';
1095     }
1096   }
1097 if (document.forms[0] && document.forms[0][name]) {
1098   document.forms[0][name].value = tabname;
1099   }
1100 return false;
1101 }
1102 </script>
1103 EOF
1104 }
1105
1106 # ui_hidden_start(title, name, status, thisurl)
1107 # Returns HTML for the start of a collapsible hidden section, such as for
1108 # advanced options.
1109 sub ui_hidden_start
1110 {
1111 return &theme_ui_hidden_start(@_) if (defined(&theme_ui_hidden_start));
1112 local ($title, $name, $status, $url) = @_;
1113 local $rv;
1114 if (!$main::ui_hidden_start_donejs++) {
1115         $rv .= &ui_hidden_javascript();
1116         }
1117 local $divid = "hiddendiv_$name";
1118 local $openerid = "hiddenopener_$name";
1119 local $defimg = $status ? "open.gif" : "closed.gif";
1120 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1121 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg' alt='*'></a>\n";
1122 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
1123 $rv .= "<div class='$defclass' id='$divid'>\n";
1124 return $rv;
1125 }
1126
1127 # ui_hidden_end(name)
1128 # Returns HTML for the end of a hidden section
1129 sub ui_hidden_end
1130 {
1131 return &theme_ui_hidden_end(@_) if (defined(&theme_ui_hidden_end));
1132 local ($name) = @_;
1133 return "</div>\n";
1134 }
1135
1136 # ui_hidden_table_row_start(title, name, status, thisurl)
1137 # Similar to ui_hidden_start, but for use within a table started with
1138 # ui_table_start
1139 sub ui_hidden_table_row_start
1140 {
1141 return &theme_ui_hidden_table_row_start(@_)
1142         if (defined(&theme_ui_hidden_table_row_start));
1143 local ($title, $name, $status, $url) = @_;
1144 local ($rv, $rrv);
1145 if (!$main::ui_hidden_start_donejs++) {
1146         $rv .= &ui_hidden_javascript();
1147         }
1148 local $divid = "hiddendiv_$name";
1149 local $openerid = "hiddenopener_$name";
1150 local $defimg = $status ? "open.gif" : "closed.gif";
1151 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1152 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a>\n";
1153 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
1154 $rv .= &ui_table_row(undef, $rrv, $main::ui_table_cols);
1155 $rv .= "</table>\n";
1156 $rv .= "<div class='$defclass' id='$divid'>\n";
1157 $rv .= "<table width=100%>\n";
1158 return $rv;
1159 }
1160
1161 # ui_hidden_table_row_end(name)
1162 sub ui_hidden_table_row_end
1163 {
1164 return &theme_ui_hidden_table_row_end(@_)
1165         if (defined(&theme_ui_hidden_table_row_end));
1166 local ($name) = @_;
1167 return "</table></div><table width=100%>\n";
1168 }
1169
1170 # ui_hidden_table_start(heading, [tabletags], [cols], name, status,
1171 #                       [&default-tds])
1172 # A table with a heading and table inside, and which is collapsible
1173 sub ui_hidden_table_start
1174 {
1175 return &theme_ui_hidden_table_start(@_)
1176         if (defined(&theme_ui_hidden_table_start));
1177 local ($heading, $tabletags, $cols, $name, $status, $tds) = @_;
1178 local $rv;
1179 if (!$main::ui_hidden_start_donejs++) {
1180         $rv .= &ui_hidden_javascript();
1181         }
1182 local $divid = "hiddendiv_$name";
1183 local $openerid = "hiddenopener_$name";
1184 local $defimg = $status ? "open.gif" : "closed.gif";
1185 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
1186 local $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1187               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1188 $rv .= "<table class='ui_table' border $tabletags class='ui_table'>\n";
1189 $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));
1190 $rv .= "<tr $cb> <td><div class='$defclass' id='$divid'><table width=100%>\n";
1191 $main::ui_table_cols = $cols || 4;
1192 $main::ui_table_pos = 0;
1193 $main::ui_table_default_tds = $tds;
1194 return $rv;
1195 }
1196
1197 # ui_hidden_table_end(name)
1198 # Returns HTML for the end of table with hiding, as started by
1199 # ui_hidden_table_start
1200 sub ui_hidden_table_end
1201 {
1202 local ($name) = @_;
1203 return &theme_ui_hidden_table_end(@_) if (defined(&theme_ui_hidden_table_end));
1204 return "</table></div></td></tr></table>\n";
1205 }
1206
1207 # ui_tabs_start(&tabs, name, selected, show-border)
1208 # Render a row of tabs from which one can be selected. Each tab is an array
1209 # ref containing a name, title and link.
1210 sub ui_tabs_start
1211 {
1212 return &theme_ui_tabs_start(@_) if (defined(&theme_ui_tabs_start));
1213 local ($tabs, $name, $sel, $border) = @_;
1214 local $rv;
1215 if (!$main::ui_hidden_start_donejs++) {
1216         $rv .= &ui_hidden_javascript();
1217         }
1218
1219 # Build list of tab titles and names
1220 local $tabnames = "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$tabs)."]";
1221 local $tabtitles = "[".join(",", map { "\"".&html_escape($_->[1])."\"" } @$tabs)."]";
1222 $rv .= "<script>\n";
1223 $rv .= "document.${name}_tabnames = $tabnames;\n";
1224 $rv .= "document.${name}_tabtitles = $tabtitles;\n";
1225 $rv .= "</script>\n";
1226
1227 # Output the tabs
1228 local $imgdir = "$gconfig{'webprefix'}/images";
1229 $rv .= &ui_hidden($name, $sel)."\n";
1230 $rv .= "<table border=0 cellpadding=0 cellspacing=0>\n";
1231 $rv .= "<tr><td bgcolor=#ffffff colspan=".(scalar(@$tabs)*2+1).">";
1232 if ($ENV{'HTTP_USER_AGENT'} !~ /msie/i) {
1233         # For some reason, the 1-pixel space above the tabs appears huge on IE!
1234         $rv .= "<img src=$imgdir/1x1.gif>";
1235         }
1236 $rv .= "</td></tr>\n";
1237 $rv .= "<tr>\n";
1238 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1239 foreach my $t (@$tabs) {
1240         if ($t ne $tabs[0]) {
1241                 # Spacer
1242                 $rv .= "<td width=2 bgcolor=#ffffff>".
1243                        "<img src=$imgdir/1x1.gif></td>\n";
1244                 }
1245         local $tabid = "tab_".$t->[0];
1246         $rv .= "<td id=${tabid}>";
1247         $rv .= "<table cellpadding=0 cellspacing=0 border=0><tr>";
1248         if ($t->[0] eq $sel) {
1249                 # Selected tab
1250                 $rv .= "<td valign=top $cb>".
1251                        "<img src=$imgdir/lc2.gif alt=\"\"></td>";
1252                 $rv .= "<td $cb nowrap>".
1253                        "&nbsp;<b>$t->[1]</b>&nbsp;</td>";
1254                 $rv .= "<td valign=top $cb>".
1255                        "<img src=$imgdir/rc2.gif alt=\"\"></td>";
1256                 }
1257         else {
1258                 # Other tab (which has a link)
1259                 $rv .= "<td valign=top $tb>".
1260                        "<img src=$imgdir/lc1.gif alt=\"\"></td>";
1261                 $rv .= "<td $tb nowrap>".
1262                        "&nbsp;<a href='$t->[2]' ".
1263                        "onClick='return select_tab(\"$name\", \"$t->[0]\")'>".
1264                        "$t->[1]</a>&nbsp;</td>";
1265                 $rv .= "<td valign=top $tb>".
1266                        "<img src=$imgdir/rc1.gif ".
1267                        "alt=\"\"></td>";
1268                 $rv .= "</td>\n";
1269                 }
1270         $rv .= "</tr></table>";
1271         $rv .= "</td>\n";
1272         }
1273 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
1274 $rv .= "</table>\n";
1275
1276 if ($border) {
1277         # All tabs are within a grey box
1278         $rv .= "<table width=100% cellpadding=0 cellspacing=0 border=0>\n";
1279         $rv .= "<tr> <td bgcolor=#ffffff rowspan=3 width=1><img src=$imgdir/1x1.gif></td>\n";
1280         $rv .= "<td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1281         $rv .= "<tr> <td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1282         $rv .= "<td valign=top>";
1283         }
1284 $main::ui_tabs_selected = $sel;
1285 return $rv;
1286 }
1287
1288 # ui_tabs_end(border)
1289 sub ui_tabs_end
1290 {
1291 return &theme_ui_tabs_end(@_) if (defined(&theme_ui_tabs_end));
1292 local ($border) = @_;
1293 local $rv;
1294 local $imgdir = "$gconfig{'webprefix'}/images";
1295 if ($border) {
1296         $rv .= "</td>\n";
1297         $rv .= "<td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1298         $rv .= "</tr>\n";
1299         $rv .= "<tr> <td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1300         $rv .= "</table>\n";
1301         }
1302 return $rv;
1303 }
1304
1305 # ui_tabs_start_tab(name, tab)
1306 # Must be called before outputting the HTML for the named tab
1307 sub ui_tabs_start_tab
1308 {
1309 return &theme_ui_tabs_start_tab(@_) if (defined(&theme_ui_tabs_start_tab));
1310 local ($name, $tab) = @_;
1311 local $defclass = $tab eq $main::ui_tabs_selected ?
1312                         'opener_shown' : 'opener_hidden';
1313 local $rv = "<div id='div_$tab' class='$defclass'>\n";
1314 return $rv;
1315 }
1316
1317 # ui_tabs_start_tabletab(name, tab)
1318 # Behaves like ui_tabs_start_tab, but for use within a ui_table_start block
1319 sub ui_tabs_start_tabletab
1320 {
1321 return &theme_ui_tabs_start_tabletab(@_)
1322         if (defined(&theme_ui_tabs_start_tabletab));
1323 local $div = &ui_tabs_start_tab(@_);
1324 return "</table>\n".$div."<table width=100%>\n";
1325 }
1326
1327 sub ui_tabs_end_tab
1328 {
1329 return &theme_ui_tabs_end_tab(@_) if (defined(&theme_ui_tabs_end_tab));
1330 return "</div>\n";
1331 }
1332
1333 sub ui_tabs_end_tabletab
1334 {
1335 return &theme_ui_tabs_end_tabletab(@_)
1336         if (defined(&theme_ui_tabs_end_tabletab));
1337 return "</table></div><table width=100%>\n";
1338 }
1339
1340 # ui_max_text_width(width, [text-area?])
1341 # Returns a new width for a text field, based on theme settings
1342 sub ui_max_text_width
1343 {
1344 local ($w, $ta) = @_;
1345 local $max = $ta ? $tconfig{'maxareawidth'} : $tconfig{'maxboxwidth'};
1346 return $max && $w > $max ? $max : $w;
1347 }
1348
1349 ####################### radio hidden functions
1350
1351 # ui_radio_selector(&opts, name, selected)
1352 # Returns HTML for a set of radio buttons, each of which shows a different
1353 # block of HTML when selected. &opts is an array ref to arrays containing
1354 # [ value, label, html ]
1355 sub ui_radio_selector
1356 {
1357 return &theme_ui_radio_selector(@_) if (defined(&theme_ui_radio_selector));
1358 local ($opts, $name, $sel) = @_;
1359 local $rv;
1360 if (!$main::ui_radio_selector_donejs++) {
1361         $rv .= &ui_radio_selector_javascript();
1362         }
1363 local $optnames =
1364         "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$opts)."]";
1365 foreach my $o (@$opts) {
1366         $rv .= &ui_oneradio($name, $o->[0], $o->[1], $sel eq $o->[0],
1367             "onClick='selector_show(\"$name\", \"$o->[0]\", $optnames)'");
1368         }
1369 $rv .= "<br>\n";
1370 foreach my $o (@$opts) {
1371         local $cls = $o->[0] eq $sel ? "selector_shown" : "selector_hidden";
1372         $rv .= "<div id=sel_${name}_$o->[0] class=$cls>".$o->[2]."</div>\n";
1373         }
1374 return $rv;
1375 }
1376
1377 sub ui_radio_selector_javascript
1378 {
1379 return <<EOF;
1380 <style>
1381 .selector_shown {display:inline}
1382 .selector_hidden {display:none}
1383 </style>
1384 <script>
1385 function selector_show(name, value, values)
1386 {
1387 for(var i=0; i<values.length; i++) {
1388         var divobj = document.getElementById('sel_'+name+'_'+values[i]);
1389         divobj.className = value == values[i] ? 'selector_shown'
1390                                               : 'selector_hidden';
1391         }
1392 }
1393 </script>
1394 EOF
1395 }
1396
1397 ####################### grid layout functions
1398
1399 # ui_grid_table(&elements, columns, [width-percent], [tds], [tabletags],
1400 #               [title])
1401 # Given a list of HTML elements, formats them into a table with the given
1402 # number of columns. However, themes are free to override this to use fewer
1403 # columns where space is limited.
1404 sub ui_grid_table
1405 {
1406 return &theme_ui_grid_table(@_) if (defined(&theme_ui_grid_table));
1407 local ($elements, $cols, $width, $tds, $tabletags, $title) = @_;
1408 return "" if (!@$elements);
1409 local $rv = "<table".
1410             ($width ? " width=$width%" : "").
1411             ($tabletags ? " ".$tabletags : "").
1412             ">\n";
1413 my $i;
1414 for($i=0; $i<@$elements; $i++) {
1415         $rv .= "<tr>" if ($i%$cols == 0);
1416         $rv .= "<td ".$tds->[$i%$cols]." valign=top>".$elements->[$i]."</td>\n";
1417         $rv .= "</tr>" if ($i%$cols == $cols-1);
1418         }
1419 if ($i%$cols) {
1420         while($i%$cols) {
1421                 $rv .= "<td ".$tds->[$i%$cols]."><br></td>\n";
1422                 $i++;
1423                 }
1424         $rv .= "</tr>\n";
1425         }
1426 $rv .= "</table>\n";
1427 if (defined($title)) {
1428         $rv = "<table class=ui_table border ".
1429               ($width ? " width=$width%" : "").">\n".
1430               ($title ? "<tr $tb> <td><b>$title</b></td> </tr>\n" : "").
1431               "<tr $cb> <td>$rv</td> </tr>\n".
1432               "</table>";
1433         }
1434 return $rv;
1435 }
1436
1437 # ui_radio_table(name, selected, &rows)
1438 # Returns HTML for a table of radio buttons, each of which has a label and
1439 # some associated inputs to the right.
1440 sub ui_radio_table
1441 {
1442 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
1443 local ($name, $sel, $rows) = @_;
1444 return "" if (!@$rows);
1445 local $rv = "<table>\n";
1446 foreach my $r (@$rows) {
1447         $rv .= "<tr>\n";
1448         $rv .= "<td valign=top><b>".&ui_oneradio($name, $r->[0], $r->[1],
1449                                    $r->[0] eq $sel)."</b></td>\n";
1450         $rv .= "<td valign=top>".$r->[2]."</td>\n";
1451         $rv .= "</tr>\n";
1452         }
1453 $rv .= "</table>\n";
1454 return $rv;
1455 }
1456
1457 # ui_up_down_arrows(uplink, downlink, up-show, down-show)
1458 # Returns HTML for moving some objects in a table up or down
1459 sub ui_up_down_arrows
1460 {
1461 return &theme_ui_up_down_arrows(@_) if (defined(&theme_ui_up_down_arrows));
1462 local ($uplink, $downlink, $upshow, $downshow) = @_;
1463 local $mover;
1464 local $imgdir = "$gconfig{'webprefix'}/images";
1465 if ($downshow) {
1466         $mover .= "<a href=\"$downlink\">".
1467                   "<img src=$imgdir/movedown.gif border=0></a>";
1468         }
1469 else {
1470         $mover .= "<img src=$imgdir/movegap.gif>";
1471         }
1472 if ($upshow) {
1473         $mover .= "<a href=\"$uplink\">".
1474                   "<img src=$imgdir/moveup.gif border=0></a>";
1475         }
1476 else {
1477         $mover .= "<img src=$imgdir/movegap.gif>";
1478         }
1479 return $mover;
1480 }
1481
1482 # ui_hr()
1483 # Returns a horizontal row tag
1484 sub ui_hr
1485 {
1486 return &theme_ui_hr() if (defined(&theme_ui_hr));
1487 return "<hr>\n";
1488 }
1489
1490 ####################### javascript functions
1491
1492 # js_disable_input(&disable-inputs, &enable-inputs, [tag])
1493 # Returns Javascript to disable some form elements and enable others
1494 sub js_disable_inputs
1495 {
1496 local $rv;
1497 local $f;
1498 foreach $f (@{$_[0]}) {
1499         $rv .= "e = form.elements[\"$f\"]; e.disabled = true; ";
1500         $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = true; } ";
1501         }
1502 foreach $f (@{$_[1]}) {
1503         $rv .= "e = form.elements[\"$f\"]; e.disabled = false; ";
1504         $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = false; } ";
1505         }
1506 foreach $f (@{$_[1]}) {
1507         if ($f =~ /^(.*)_def$/ && &indexof($1, @{$_[1]}) >= 0) {
1508                 # When enabling both a _def field and its associated text field,
1509                 # disable the text if the _def is set to 1
1510                 local $tf = $1;
1511                 $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 } } ";
1512                 }
1513         }
1514 return $_[2] ? "$_[2]='$rv'" : $rv;
1515 }
1516
1517 # js_checkbox_disable(name, &checked-disable, &checked-enable, [tag])
1518 sub js_checkbox_disable
1519 {
1520 local $rv;
1521 local $f;
1522 foreach $f (@{$_[1]}) {
1523         $rv .= "form.elements[\"$f\"].disabled = $_[0].checked; ";
1524         }
1525 foreach $f (@{$_[2]}) {
1526         $rv .= "form.elements[\"$f\"].disabled = !$_[0].checked; ";
1527         }
1528 return $_[3] ? "$_[3]='$rv'" : $rv;
1529 }
1530
1531 # js_redirect(url)
1532 # Returns HTML to trigger a redirect to some URL
1533 sub js_redirect
1534 {
1535 local ($url) = @_;
1536 if (defined(&theme_js_redirect)) {
1537         return &theme_js_redirect(@_);
1538         }
1539 return "<script>window.location = '".&quote_escape($url)."';</script>\n";
1540 }
1541
1542 1;
1543