ui-lib.pl

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