ui-lib.pl

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