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