web-lib-funcs.pl

   1 =head1 web-lib-funcs.pl
   2
   3 Common functions for Webmin CGI scripts. This file gets in-directly included
   4 by all scripts that use web-lib.pl.
   5 Example code:
   6
   7   use WebminCore;
   8   init_config();
   9   ui_print_header(undef, 'My Module', '');
  10   print 'This is Webmin version ',get_webmin_version(),'<p>\n';
  11   ui_print_footer();
  12
  13 =cut
  14
  15 #use warnings;
  16 use Socket;
  17 use POSIX;
  18 eval "use Socket6";
  19 $ipv6_module_error = $@;
  20
  21 use vars qw($user_risk_level $loaded_theme_library $wait_for_input
  22             $done_webmin_header $trust_unknown_referers $unsafe_index_cgi
  23             %done_foreign_require $webmin_feedback_address
  24             $user_skill_level $pragma_no_cache $foreign_args);
  25 # Globals
  26 use vars qw($module_index_name $number_to_month_map $month_to_number_map
  27             $umask_already $default_charset $licence_status $os_type
  28             $licence_message $script_name $loaded_theme_oo_library
  29             $done_web_lib_funcs $os_version $module_index_link
  30             $called_from_webmin_core $ipv6_module_error);
  31
  32 =head2 read_file(file, &hash, [&order], [lowercase], [split-char])
  33
  34 Fill the given hash reference with name=value pairs from a file. The required
  35 parameters are :
  36
  37 =item file - The file to head, which must be text with each line like name=value
  38
  39 =item hash - The hash reference to add values read from the file to.
  40
  41 =item order - If given, an array reference to add names to in the order they were read
  42
  43 =item lowercase - If set to 1, names are converted to lower case
  44
  45 =item split-char - If set, names and values are split on this character instead of =
  46
  47 =cut
  48 sub read_file
  49 {
  50 local $_;
  51 my $split = defined($_[4]) ? $_[4] : "=";
  52 my $realfile = &translate_filename($_[0]);
  53 &open_readfile(ARFILE, $_[0]) || return 0;
  54 while(<ARFILE>) {
  55         chomp;
  56         my $hash = index($_, "#");
  57         my $eq = index($_, $split);
  58         if ($hash != 0 && $eq >= 0) {
  59                 my $n = substr($_, 0, $eq);
  60                 my $v = substr($_, $eq+1);
  61                 chomp($v);
  62                 $_[1]->{$_[3] ? lc($n) : $n} = $v;
  63                 push(@{$_[2]}, $n) if ($_[2]);
  64                 }
  65         }
  66 close(ARFILE);
  67 $main::read_file_missing{$realfile} = 0;        # It exists now
  68 if (defined($main::read_file_cache{$realfile})) {
  69         %{$main::read_file_cache{$realfile}} = %{$_[1]};
  70         }
  71 return 1;
  72 }
  73
  74 =head2 read_file_cached(file, &hash, [&order], [lowercase], [split-char])
  75
  76 Like read_file, but reads from an in-memory cache if the file has already been
  77 read in this Webmin script. Recommended, as it behaves exactly the same as
  78 read_file, but can be much faster.
  79
  80 =cut
  81 sub read_file_cached
  82 {
  83 my $realfile = &translate_filename($_[0]);
  84 if (defined($main::read_file_cache{$realfile})) {
  85         # Use cached data
  86         %{$_[1]} = ( %{$_[1]}, %{$main::read_file_cache{$realfile}} );
  87         return 1;
  88         }
  89 elsif ($main::read_file_missing{$realfile}) {
  90         # Doesn't exist, so don't re-try read
  91         return 0;
  92         }
  93 else {
  94         # Actually read the file
  95         my %d;
  96         if (&read_file($_[0], \%d, $_[2], $_[3], $_[4])) {
  97                 %{$main::read_file_cache{$realfile}} = %d;
  98                 %{$_[1]} = ( %{$_[1]}, %d );
  99                 return 1;
 100                 }
 101         else {
 102                 # Flag as non-existant
 103                 $main::read_file_missing{$realfile} = 1;
 104                 return 0;
 105                 }
 106         }
 107 }
 108
 109 =head2 read_file_cached_with_stat(file, &hash, [&order], [lowercase], [split-char])
 110
 111 Like read_file, but reads from an in-memory cache if the file has already been
 112 read in this Webmin script AND has not changed.
 113
 114 =cut
 115 sub read_file_cached_with_stat
 116 {
 117 my $realfile = &translate_filename($_[0]);
 118 my $t = $main::read_file_cache_time{$realfile};
 119 my @st = stat($realfile);
 120 if ($t && $st[9] != $t) {
 121         # Changed, invalidate cache
 122         delete($main::read_file_cache{$realfile});
 123         }
 124 my $rv = &read_file_cached(@_);
 125 $main::read_file_cache_time{$realfile} = $st[9];
 126 return $rv;
 127 }
 128
 129 =head2 write_file(file, &hash, [join-char])
 130
 131 Write out the contents of a hash as name=value lines. The parameters are :
 132
 133 =item file - Full path to write to
 134
 135 =item hash - A hash reference containing names and values to output
 136
 137 =item join-char - If given, names and values are separated by this instead of =
 138
 139 =cut
 140 sub write_file
 141 {
 142 my (%old, @order);
 143 my $join = defined($_[2]) ? $_[2] : "=";
 144 my $realfile = &translate_filename($_[0]);
 145 &read_file($_[0], \%old, \@order);
 146 &open_tempfile(ARFILE, ">$_[0]");
 147 foreach $k (@order) {
 148         if (exists($_[1]->{$k})) {
 149                 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
 150                         &error(&text("efilewrite", $realfile, $!));
 151                 }
 152         }
 153 foreach $k (keys %{$_[1]}) {
 154         if (!exists($old{$k})) {
 155                 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
 156                         &error(&text("efilewrite", $realfile, $!));
 157                 }
 158         }
 159 &close_tempfile(ARFILE);
 160 if (defined($main::read_file_cache{$realfile})) {
 161         %{$main::read_file_cache{$realfile}} = %{$_[1]};
 162         }
 163 if (defined($main::read_file_missing{$realfile})) {
 164         $main::read_file_missing{$realfile} = 0;
 165         }
 166 }
 167
 168 =head2 html_escape(string)
 169
 170 Converts &, < and > codes in text to HTML entities, and returns the new string.
 171 This should be used when including data read from other sources in HTML pages.
 172
 173 =cut
 174 sub html_escape
 175 {
 176 my ($tmp) = @_;
 177 $tmp =~ s/&/&amp;/g;
 178 $tmp =~ s/</&lt;/g;
 179 $tmp =~ s/>/&gt;/g;
 180 $tmp =~ s/\"/&quot;/g;
 181 $tmp =~ s/\'/&#39;/g;
 182 $tmp =~ s/=/&#61;/g;
 183 return $tmp;
 184 }
 185
 186 =head2 quote_escape(string, [only-quote])
 187
 188 Converts ' and " characters in a string into HTML entities, and returns it.
 189 Useful for outputing HTML tag values.
 190
 191 =cut
 192 sub quote_escape
 193 {
 194 my ($tmp, $only) = @_;
 195 if ($tmp !~ /\&[a-zA-Z]+;/ && $tmp !~ /\&#/) {
 196         # convert &, unless it is part of &#nnn; or &foo;
 197         $tmp =~ s/&([^#])/&amp;$1/g;
 198         }
 199 $tmp =~ s/&$/&amp;/g;
 200 $tmp =~ s/\"/&quot;/g if ($only eq '' || $only eq '"');
 201 $tmp =~ s/\'/&#39;/g if ($only eq '' || $only eq "'");
 202 return $tmp;
 203 }
 204
 205 =head2 tempname([filename])
 206
 207 Returns a mostly random temporary file name, typically under the /tmp/.webmin
 208 directory. If filename is given, this will be the base name used. Otherwise
 209 a unique name is selected randomly.
 210
 211 =cut
 212 sub tempname
 213 {
 214 my $tmp_base = $gconfig{'tempdir_'.&get_module_name()} ?
 215                         $gconfig{'tempdir_'.&get_module_name()} :
 216                   $gconfig{'tempdir'} ? $gconfig{'tempdir'} :
 217                   $ENV{'TEMP'} && $ENV{'TEMP'} ne "/tmp" ? $ENV{'TEMP'} :
 218                   $ENV{'TMP'} && $ENV{'TMP'} ne "/tmp" ? $ENV{'TMP'} :
 219                   -d "c:/temp" ? "c:/temp" : "/tmp/.webmin";
 220 my $tmp_dir = -d $remote_user_info[7] && !$gconfig{'nohometemp'} ?
 221                         "$remote_user_info[7]/.tmp" :
 222                  @remote_user_info ? $tmp_base."-".$remote_user :
 223                  $< != 0 ? $tmp_base."-".getpwuid($<) :
 224                                      $tmp_base;
 225 if ($gconfig{'os_type'} eq 'windows' || $tmp_dir =~ /^[a-z]:/i) {
 226         # On Windows system, just create temp dir if missing
 227         if (!-d $tmp_dir) {
 228                 mkdir($tmp_dir, 0755) ||
 229                         &error("Failed to create temp directory $tmp_dir : $!");
 230                 }
 231         }
 232 else {
 233         # On Unix systems, need to make sure temp dir is valid
 234         my $tries = 0;
 235         while($tries++ < 10) {
 236                 my @st = lstat($tmp_dir);
 237                 last if ($st[4] == $< && (-d _) && ($st[2] & 0777) == 0755);
 238                 if (@st) {
 239                         unlink($tmp_dir) || rmdir($tmp_dir) ||
 240                                 system("/bin/rm -rf ".quotemeta($tmp_dir));
 241                         }
 242                 mkdir($tmp_dir, 0755) || next;
 243                 chown($<, $(, $tmp_dir);
 244                 chmod(0755, $tmp_dir);
 245                 }
 246         if ($tries >= 10) {
 247                 my @st = lstat($tmp_dir);
 248                 &error("Failed to create temp directory $tmp_dir : uid=$st[4] mode=$st[2]");
 249                 }
 250         }
 251 my $rv;
 252 if (defined($_[0]) && $_[0] !~ /\.\./) {
 253         $rv = "$tmp_dir/$_[0]";
 254         }
 255 else {
 256         $main::tempfilecount++;
 257         &seed_random();
 258         $rv = $tmp_dir."/".int(rand(1000000))."_".
 259                $main::tempfilecount."_".$scriptname;
 260         }
 261 return $rv;
 262 }
 263
 264 =head2 transname([filename])
 265
 266 Behaves exactly like tempname, but records the temp file for deletion when the
 267 current Webmin script process exits.
 268
 269 =cut
 270 sub transname
 271 {
 272 my $rv = &tempname(@_);
 273 push(@main::temporary_files, $rv);
 274 return $rv;
 275 }
 276
 277 =head2 trunc(string, maxlen)
 278
 279 Truncates a string to the shortest whole word less than or equal to the
 280 given width. Useful for word wrapping.
 281
 282 =cut
 283 sub trunc
 284 {
 285 if (length($_[0]) <= $_[1]) {
 286         return $_[0];
 287         }
 288 my $str = substr($_[0],0,$_[1]);
 289 my $c;
 290 do {
 291         $c = chop($str);
 292         } while($c !~ /\S/);
 293 $str =~ s/\s+$//;
 294 return $str;
 295 }
 296
 297 =head2 indexof(string, value, ...)
 298
 299 Returns the index of some value in an array of values, or -1 if it was not
 300 found.
 301
 302 =cut
 303 sub indexof
 304 {
 305 for(my $i=1; $i <= $#_; $i++) {
 306         if ($_[$i] eq $_[0]) { return $i - 1; }
 307         }
 308 return -1;
 309 }
 310
 311 =head2 indexoflc(string, value, ...)
 312
 313 Like indexof, but does a case-insensitive match
 314
 315 =cut
 316 sub indexoflc
 317 {
 318 my $str = lc(shift(@_));
 319 my @arr = map { lc($_) } @_;
 320 return &indexof($str, @arr);
 321 }
 322
 323 =head2 sysprint(handle, [string]+)
 324
 325 Outputs some strings to a file handle, but bypassing IO buffering. Can be used
 326 as a replacement for print when writing to pipes or sockets.
 327
 328 =cut
 329 sub sysprint
 330 {
 331 my $fh = &callers_package($_[0]);
 332 my $str = join('', @_[1..$#_]);
 333 syswrite $fh, $str, length($str);
 334 }
 335
 336 =head2 check_ipaddress(ip)
 337
 338 Check if some IPv4 address is properly formatted, returning 1 if so or 0 if not.
 339
 340 =cut
 341 sub check_ipaddress
 342 {
 343 return $_[0] =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/ &&
 344         $1 >= 0 && $1 <= 255 &&
 345         $2 >= 0 && $2 <= 255 &&
 346         $3 >= 0 && $3 <= 255 &&
 347         $4 >= 0 && $4 <= 255;
 348 }
 349
 350 =head2 check_ip6address(ip)
 351
 352 Check if some IPv6 address is properly formatted, and returns 1 if so.
 353
 354 =cut
 355 sub check_ip6address
 356 {
 357   my @blocks = split(/:/, $_[0]);
 358   return 0 if (@blocks == 0 || @blocks > 8);
 359
 360   # The address/netmask format is accepted. So we're looking for a "/" to isolate a possible netmask.
 361   # After that, we delete the netmask to control the address only format, but we verify whether the netmask
 362   # value is in [0;128].
 363   my $ib = $#blocks;
 364   my $where = index($blocks[$ib],"/");
 365   my $m = 0;
 366   if ($where != -1) {
 367     my $b = substr($blocks[$ib],0,$where);
 368     $m = substr($blocks[$ib],$where+1,length($blocks[$ib])-($where+1));
 369     $blocks[$ib]=$b;
 370   }
 371
 372   # The netmask must take its value in [0;128]
 373   return 0 if ($m <0 || $m >128);
 374
 375   # Check the different blocks of the address : 16 bits block in hexa notation.
 376   # Possibility of 1 empty block or 2 if the address begins with "::".
 377   my $b;
 378   my $empty = 0;
 379   foreach $b (@blocks) {
 380           return 0 if ($b ne "" && $b !~ /^[0-9a-f]{1,4}$/i);
 381           $empty++ if ($b eq "");
 382           }
 383   return 0 if ($empty > 1 && !($_[0] =~ /^::/ && $empty == 2));
 384   return 1;
 385 }
 386
 387
 388
 389 =head2 generate_icon(image, title, link, [href], [width], [height], [before-title], [after-title])
 390
 391 Prints HTML for an icon image. The parameters are :
 392
 393 =item image - URL for the image, like images/foo.gif
 394
 395 =item title - Text to appear under the icon
 396
 397 =item link - Optional destination for the icon's link
 398
 399 =item href - Other HTML attributes to be added to the <a href> for the link
 400
 401 =item width - Optional width of the icon
 402
 403 =item height - Optional height of the icon
 404
 405 =item before-title - HTML to appear before the title link, but which is not actually in the link
 406
 407 =item after-title - HTML to appear after the title link, but which is not actually in the link
 408
 409 =cut
 410 sub generate_icon
 411 {
 412 &load_theme_library();
 413 if (defined(&theme_generate_icon)) {
 414         &theme_generate_icon(@_);
 415         return;
 416         }
 417 my $w = !defined($_[4]) ? "width=48" : $_[4] ? "width=$_[4]" : "";
 418 my $h = !defined($_[5]) ? "height=48" : $_[5] ? "height=$_[5]" : "";
 419 if ($tconfig{'noicons'}) {
 420         if ($_[2]) {
 421                 print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
 422                 }
 423         else {
 424                 print "$_[6]$_[1]$_[7]\n";
 425                 }
 426         }
 427 elsif ($_[2]) {
 428         print "<table border><tr><td width=48 height=48>\n",
 429               "<a href=\"$_[2]\" $_[3]><img src=\"$_[0]\" alt=\"\" border=0 ",
 430               "$w $h></a></td></tr></table>\n";
 431         print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
 432         }
 433 else {
 434         print "<table border><tr><td width=48 height=48>\n",
 435               "<img src=\"$_[0]\" alt=\"\" border=0 $w $h>",
 436               "</td></tr></table>\n$_[6]$_[1]$_[7]\n";
 437         }
 438 }
 439
 440 =head2 urlize
 441
 442 Converts a string to a form ok for putting in a URL, using % escaping.
 443
 444 =cut
 445 sub urlize
 446 {
 447 my ($rv) = @_;
 448 $rv =~ s/([^A-Za-z0-9])/sprintf("%%%2.2X", ord($1))/ge;
 449 return $rv;
 450 }
 451
 452 =head2 un_urlize(string)
 453
 454 Converts a URL-encoded string to it's original contents - the reverse of the
 455 urlize function.
 456
 457 =cut
 458 sub un_urlize
 459 {
 460 my ($rv) = @_;
 461 $rv =~ s/\+/ /g;
 462 $rv =~ s/%(..)/pack("c",hex($1))/ge;
 463 return $rv;
 464 }
 465
 466 =head2 include(filename)
 467
 468 Read and output the contents of the given file.
 469
 470 =cut
 471 sub include
 472 {
 473 local $_;
 474 open(INCLUDE, &translate_filename($_[0])) || return 0;
 475 while(<INCLUDE>) {
 476         print;
 477         }
 478 close(INCLUDE);
 479 return 1;
 480 }
 481
 482 =head2 copydata(in-handle, out-handle)
 483
 484 Read from one file handle and write to another, until there is no more to read.
 485
 486 =cut
 487 sub copydata
 488 {
 489 my ($in, $out) = @_;
 490 $in = &callers_package($in);
 491 $out = &callers_package($out);
 492 my $buf;
 493 while(read($in, $buf, 1024) > 0) {
 494         (print $out $buf) || return 0;
 495         }
 496 return 1;
 497 }
 498
 499 =head2 ReadParseMime([maximum], [&cbfunc, &cbargs])
 500
 501 Read data submitted via a POST request using the multipart/form-data coding,
 502 and store it in the global %in hash. The optional parameters are :
 503
 504 =item maximum - If the number of bytes of input exceeds this number, stop reading and call error.
 505
 506 =item cbfunc - A function reference to call after reading each block of data.
 507
 508 =item cbargs - Additional parameters to the callback function.
 509
 510 =cut
 511 sub ReadParseMime
 512 {
 513 my ($max, $cbfunc, $cbargs) = @_;
 514 my ($boundary, $line, $foo, $name, $got, $file);
 515 my $err = &text('readparse_max', $max);
 516 $ENV{'CONTENT_TYPE'} =~ /boundary=(.*)$/ || &error($text{'readparse_enc'});
 517 if ($ENV{'CONTENT_LENGTH'} && $max && $ENV{'CONTENT_LENGTH'} > $max) {
 518         &error($err);
 519         }
 520 &$cbfunc(0, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
 521 $boundary = $1;
 522 <STDIN>;        # skip first boundary
 523 while(1) {
 524         $name = "";
 525         # Read section headers
 526         my $lastheader;
 527         while(1) {
 528                 $line = <STDIN>;
 529                 $got += length($line);
 530                 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, @$cbargs) if ($cbfunc);
 531                 if ($max && $got > $max) {
 532                         &error($err)
 533                         }
 534                 $line =~ tr/\r\n//d;
 535                 last if (!$line);
 536                 if ($line =~ /^(\S+):\s*(.*)$/) {
 537                         $header{$lastheader = lc($1)} = $2;
 538                         }
 539                 elsif ($line =~ /^\s+(.*)$/) {
 540                         $header{$lastheader} .= $line;
 541                         }
 542                 }
 543
 544         # Parse out filename and type
 545         if ($header{'content-disposition'} =~ /^form-data(.*)/) {
 546                 $rest = $1;
 547                 while ($rest =~ /([a-zA-Z]*)=\"([^\"]*)\"(.*)/) {
 548                         if ($1 eq 'name') {
 549                                 $name = $2;
 550                                 }
 551                         else {
 552                                 $foo = $name . "_$1";
 553                                 $in{$foo} = $2;
 554                                 }
 555                         $rest = $3;
 556                         }
 557                 }
 558         else {
 559                 &error($text{'readparse_cdheader'});
 560                 }
 561         if ($header{'content-type'} =~ /^([^\s;]+)/) {
 562                 $foo = $name . "_content_type";
 563                 $in{$foo} = $1;
 564                 }
 565         $file = $in{$name."_filename"};
 566
 567         # Read data
 568         $in{$name} .= "\0" if (defined($in{$name}));
 569         while(1) {
 570                 $line = <STDIN>;
 571                 $got += length($line);
 572                 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
 573                         if ($cbfunc);
 574                 if ($max && $got > $max) {
 575                         #print STDERR "over limit of $max\n";
 576                         #&error($err);
 577                         }
 578                 if (!$line) {
 579                         # Unexpected EOF?
 580                         &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
 581                                 if ($cbfunc);
 582                         return;
 583                         }
 584                 my $ptline = $line;
 585                 $ptline =~ s/[^a-zA-Z0-9\-]/\./g;
 586                 if (index($line, $boundary) != -1) { last; }
 587                 $in{$name} .= $line;
 588                 }
 589         chop($in{$name}); chop($in{$name});
 590         if (index($line,"$boundary--") != -1) { last; }
 591         }
 592 &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
 593 }
 594
 595 =head2 ReadParse([&hash], [method], [noplus])
 596
 597 Fills the given hash reference with CGI parameters, or uses the global hash
 598 %in if none is given. Also sets the global variables $in and @in. The other
 599 parameters are :
 600
 601 =item method - For use of this HTTP method, such as GET
 602
 603 =item noplus - Don't convert + in parameters to spaces.
 604
 605 =cut
 606 sub ReadParse
 607 {
 608 my $a = $_[0] || \%in;
 609 %$a = ( );
 610 my $meth = $_[1] ? $_[1] : $ENV{'REQUEST_METHOD'};
 611 undef($in);
 612 if ($meth eq 'POST') {
 613         my $clen = $ENV{'CONTENT_LENGTH'};
 614         &read_fully(STDIN, \$in, $clen) == $clen ||
 615                 &error("Failed to read POST input : $!");
 616         }
 617 if ($ENV{'QUERY_STRING'}) {
 618         if ($in) { $in .= "&".$ENV{'QUERY_STRING'}; }
 619         else { $in = $ENV{'QUERY_STRING'}; }
 620         }
 621 @in = split(/\&/, $in);
 622 foreach my $i (@in) {
 623         my ($k, $v) = split(/=/, $i, 2);
 624         if (!$_[2]) {
 625                 $k =~ tr/\+/ /;
 626                 $v =~ tr/\+/ /;
 627                 }
 628         $k =~ s/%(..)/pack("c",hex($1))/ge;
 629         $v =~ s/%(..)/pack("c",hex($1))/ge;
 630         $a->{$k} = defined($a->{$k}) ? $a->{$k}."\0".$v : $v;
 631         }
 632 }
 633
 634 =head2 read_fully(fh, &buffer, length)
 635
 636 Read data from some file handle up to the given length, even in the face
 637 of partial reads. Reads the number of bytes read. Stores received data in the
 638 string pointed to be the buffer reference.
 639
 640 =cut
 641 sub read_fully
 642 {
 643 my ($fh, $buf, $len) = @_;
 644 $fh = &callers_package($fh);
 645 my $got = 0;
 646 while($got < $len) {
 647         my $r = read(STDIN, $$buf, $len-$got, $got);
 648         last if ($r <= 0);
 649         $got += $r;
 650         }
 651 return $got;
 652 }
 653
 654 =head2 read_parse_mime_callback(size, totalsize, upload-id)
 655
 656 Called by ReadParseMime as new data arrives from a form-data POST. Only updates
 657 the file on every 1% change though. For internal use by the upload progress
 658 tracker.
 659
 660 =cut
 661 sub read_parse_mime_callback
 662 {
 663 my ($size, $totalsize, $filename, $id) = @_;
 664 return if ($gconfig{'no_upload_tracker'});
 665 return if (!$id);
 666
 667 # Create the upload tracking directory - if running as non-root, this has to
 668 # be under the user's home
 669 my $vardir;
 670 if ($<) {
 671         my @uinfo = @remote_user_info ? @remote_user_info : getpwuid($<);
 672         $vardir = "$uinfo[7]/.tmp";
 673         }
 674 else {
 675         $vardir = $ENV{'WEBMIN_VAR'};
 676         }
 677 if (!-d $vardir) {
 678         &make_dir($vardir, 0755);
 679         }
 680
 681 # Remove any upload.* files more than 1 hour old
 682 if (!$main::read_parse_mime_callback_flushed) {
 683         my $now = time();
 684         opendir(UPDIR, $vardir);
 685         foreach my $f (readdir(UPDIR)) {
 686                 next if ($f !~ /^upload\./);
 687                 my @st = stat("$vardir/$f");
 688                 if ($st[9] < $now-3600) {
 689                         unlink("$vardir/$f");
 690                         }
 691                 }
 692         closedir(UPDIR);
 693         $main::read_parse_mime_callback_flushed++;
 694         }
 695
 696 # Only update file once per percent
 697 my $upfile = "$vardir/upload.$id";
 698 if ($totalsize && $size >= 0) {
 699         my $pc = int(100 * $size / $totalsize);
 700         if ($pc <= $main::read_parse_mime_callback_pc{$upfile}) {
 701                 return;
 702                 }
 703         $main::read_parse_mime_callback_pc{$upfile} = $pc;
 704         }
 705
 706 # Write to the file
 707 &open_tempfile(UPFILE, ">$upfile");
 708 print UPFILE $size,"\n";
 709 print UPFILE $totalsize,"\n";
 710 print UPFILE $filename,"\n";
 711 &close_tempfile(UPFILE);
 712 }
 713
 714 =head2 read_parse_mime_javascript(upload-id, [&fields])
 715
 716 Returns an onSubmit= Javascript statement to popup a window for tracking
 717 an upload with the given ID. For internal use by the upload progress tracker.
 718
 719 =cut
 720 sub read_parse_mime_javascript
 721 {
 722 my ($id, $fields) = @_;
 723 return "" if ($gconfig{'no_upload_tracker'});
 724 my $opener = "window.open(\"$gconfig{'webprefix'}/uptracker.cgi?id=$id&uid=$<\", \"uptracker\", \"toolbar=no,menubar=no,scrollbars=no,width=500,height=100\");";
 725 if ($fields) {
 726         my $if = join(" || ", map { "typeof($_) != \"undefined\" && $_.value != \"\"" } @$fields);
 727         return "onSubmit='if ($if) { $opener }'";
 728         }
 729 else {
 730         return "onSubmit='$opener'";
 731         }
 732 }
 733
 734 =head2 PrintHeader(charset)
 735
 736 Outputs the HTTP headers for an HTML page. The optional charset parameter
 737 can be used to set a character set. Normally this function is not called
 738 directly, but is rather called by ui_print_header or header.
 739
 740 =cut
 741 sub PrintHeader
 742 {
 743 if ($pragma_no_cache || $gconfig{'pragma_no_cache'}) {
 744         print "pragma: no-cache\n";
 745         print "Expires: Thu, 1 Jan 1970 00:00:00 GMT\n";
 746         print "Cache-Control: no-store, no-cache, must-revalidate\n";
 747         print "Cache-Control: post-check=0, pre-check=0\n";
 748         }
 749 if (defined($_[0])) {
 750         print "Content-type: text/html; Charset=$_[0]\n\n";
 751         }
 752 else {
 753         print "Content-type: text/html\n\n";
 754         }
 755 }
 756
 757 =head2 header(title, image, [help], [config], [nomodule], [nowebmin], [rightside], [head-stuff], [body-stuff], [below])
 758
 759 Outputs a Webmin HTML page header with a title, including HTTP headers. The
 760 parameters are :
 761
 762 =item title - The text to show at the top of the page
 763
 764 =item image - An image to show instead of the title text. This is typically left blank.
 765
 766 =item help - If set, this is the name of a help page that will be linked to in the title.
 767
 768 =item config - If set to 1, the title will contain a link to the module's config page.
 769
 770 =item nomodule - If set to 1, there will be no link in the title section to the module's index.
 771
 772 =item nowebmin - If set to 1, there will be no link in the title section to the Webmin index.
 773
 774 =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.
 775
 776 =item head-stuff - HTML to be included in the <head> section of the page.
 777
 778 =item body-stuff - HTML attributes to be include in the <body> tag.
 779
 780 =item below - HTML to be displayed below the title. Typically this is used for application or server version information.
 781
 782 =cut
 783 sub header
 784 {
 785 return if ($main::done_webmin_header++);
 786 my $ll;
 787 my $charset = defined($main::force_charset) ? $main::force_charset
 788                                             : &get_charset();
 789 &PrintHeader($charset);
 790 &load_theme_library();
 791 if (defined(&theme_header)) {
 792         $module_name = &get_module_name();
 793         &theme_header(@_);
 794         $miniserv::page_capture = 1;
 795         return;
 796         }
 797 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
 798 print "<html>\n";
 799 print "<head>\n";
 800 if (defined(&theme_prehead)) {
 801         &theme_prehead(@_);
 802         }
 803 if ($charset) {
 804         print "<meta http-equiv=\"Content-Type\" ",
 805               "content=\"text/html; Charset=".&quote_escape($charset)."\">\n";
 806         }
 807 if (@_ > 0) {
 808         my $title = &get_html_title($_[0]);
 809         print "<title>$title</title>\n";
 810         print $_[7] if ($_[7]);
 811         print &get_html_status_line(0);
 812         }
 813 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
 814 if ($tconfig{'headinclude'}) {
 815         print &read_file_contents(
 816                 "$theme_root_directory/$tconfig{'headinclude'}");
 817         }
 818 print "</head>\n";
 819 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
 820                  defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
 821 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
 822               defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
 823 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
 824               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
 825 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
 826                                               : "";
 827 my $dir = $current_lang_info->{'dir'} ? "dir=\"$current_lang_info->{'dir'}\""
 828                                          : "";
 829 print "<body bgcolor=#$bgcolor link=#$link vlink=#$link text=#$text ",
 830       "$bgimage $tconfig{'inbody'} $dir $_[8]>\n";
 831 if (defined(&theme_prebody)) {
 832         &theme_prebody(@_);
 833         }
 834 my $hostname = &get_display_hostname();
 835 my $version = &get_webmin_version();
 836 my $prebody = $tconfig{'prebody'};
 837 if ($prebody) {
 838         $prebody =~ s/%HOSTNAME%/$hostname/g;
 839         $prebody =~ s/%VERSION%/$version/g;
 840         $prebody =~ s/%USER%/$remote_user/g;
 841         $prebody =~ s/%OS%/$os_type $os_version/g;
 842         print "$prebody\n";
 843         }
 844 if ($tconfig{'prebodyinclude'}) {
 845         local $_;
 846         open(INC, "$theme_root_directory/$tconfig{'prebodyinclude'}");
 847         while(<INC>) {
 848                 print;
 849                 }
 850         close(INC);
 851         }
 852 if (@_ > 1) {
 853         print $tconfig{'preheader'};
 854         my %this_module_info = &get_module_info(&get_module_name());
 855         print "<table class='header' width=100%><tr>\n";
 856         if ($gconfig{'sysinfo'} == 2 && $remote_user) {
 857                 print "<td id='headln1' colspan=3 align=center>\n";
 858                 print &get_html_status_line(1);
 859                 print "</td></tr> <tr>\n";
 860                 }
 861         print "<td id='headln2l' width=15% valign=top align=left>";
 862         if ($ENV{'HTTP_WEBMIN_SERVERS'} && !$tconfig{'framed'}) {
 863                 print "<a href='$ENV{'HTTP_WEBMIN_SERVERS'}'>",
 864                       "$text{'header_servers'}</a><br>\n";
 865                 }
 866         if (!$_[5] && !$tconfig{'noindex'}) {
 867                 my @avail = &get_available_module_infos(1);
 868                 my $nolo = $ENV{'ANONYMOUS_USER'} ||
 869                               $ENV{'SSL_USER'} || $ENV{'LOCAL_USER'} ||
 870                               $ENV{'HTTP_USER_AGENT'} =~ /webmin/i;
 871                 if ($gconfig{'gotoone'} && $main::session_id && @avail == 1 &&
 872                     !$nolo) {
 873                         print "<a href='$gconfig{'webprefix'}/session_login.cgi?logout=1'>",
 874                               "$text{'main_logout'}</a><br>";
 875                         }
 876                 elsif ($gconfig{'gotoone'} && @avail == 1 && !$nolo) {
 877                         print "<a href=$gconfig{'webprefix'}/switch_user.cgi>",
 878                               "$text{'main_switch'}</a><br>";
 879                         }
 880                 elsif (!$gconfig{'gotoone'} || @avail > 1) {
 881                         print "<a href='$gconfig{'webprefix'}/?cat=",
 882                               $this_module_info{'category'},
 883                               "'>$text{'header_webmin'}</a><br>\n";
 884                         }
 885                 }
 886         if (!$_[4] && !$tconfig{'nomoduleindex'}) {
 887                 my $idx = $this_module_info{'index_link'};
 888                 my $mi = $module_index_link || "/".&get_module_name()."/$idx";
 889                 my $mt = $module_index_name || $text{'header_module'};
 890                 print "<a href=\"$gconfig{'webprefix'}$mi\">$mt</a><br>\n";
 891                 }
 892         if (ref($_[2]) eq "ARRAY" && !$ENV{'ANONYMOUS_USER'} &&
 893             !$tconfig{'nohelp'}) {
 894                 print &hlink($text{'header_help'}, $_[2]->[0], $_[2]->[1]),
 895                       "<br>\n";
 896                 }
 897         elsif (defined($_[2]) && !$ENV{'ANONYMOUS_USER'} &&
 898                !$tconfig{'nohelp'}) {
 899                 print &hlink($text{'header_help'}, $_[2]),"<br>\n";
 900                 }
 901         if ($_[3]) {
 902                 my %access = &get_module_acl();
 903                 if (!$access{'noconfig'} && !$config{'noprefs'}) {
 904                         my $cprog = $user_module_config_directory ?
 905                                         "uconfig.cgi" : "config.cgi";
 906                         print "<a href=\"$gconfig{'webprefix'}/$cprog?",
 907                               &get_module_name()."\">",
 908                               $text{'header_config'},"</a><br>\n";
 909                         }
 910                 }
 911         print "</td>\n";
 912         if ($_[1]) {
 913                 # Title is a single image
 914                 print "<td id='headln2c' align=center width=70%>",
 915                       "<img alt=\"$_[0]\" src=\"$_[1]\"></td>\n";
 916                 }
 917         else {
 918                 # Title is just text
 919                 my $ts = defined($tconfig{'titlesize'}) ?
 920                                 $tconfig{'titlesize'} : "+2";
 921                 print "<td id='headln2c' align=center width=70%>",
 922                       ($ts ? "<font size=$ts>" : ""),$_[0],
 923                       ($ts ? "</font>" : "");
 924                 print "<br>$_[9]\n" if ($_[9]);
 925                 print "</td>\n";
 926                 }
 927         print "<td id='headln2r' width=15% valign=top align=right>";
 928         print $_[6];
 929         print "</td></tr></table>\n";
 930         print $tconfig{'postheader'};
 931         }
 932 $miniserv::page_capture = 1;
 933 }
 934
 935 =head2 get_html_title(title)
 936
 937 Returns the full string to appear in the HTML <title> block.
 938
 939 =cut
 940 sub get_html_title
 941 {
 942 my ($msg) = @_;
 943 my $title;
 944 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
 945 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
 946 my $host = &get_display_hostname();
 947 if ($gconfig{'sysinfo'} == 1 && $remote_user) {
 948         $title = sprintf "%s : %s on %s (%s %s)\n",
 949                 $msg, $remote_user, $host,
 950                 $os_type, $os_version;
 951         }
 952 elsif ($gconfig{'sysinfo'} == 4 && $remote_user) {
 953         $title = sprintf "%s on %s (%s %s)\n",
 954                 $remote_user, $host,
 955                 $os_type, $os_version;
 956         }
 957 else {
 958         $title = $msg;
 959         }
 960 if ($gconfig{'showlogin'} && $remote_user) {
 961         $title = $remote_user.($title ? " : ".$title : "");
 962         }
 963 if ($gconfig{'showhost'}) {
 964         $title = $host.($title ? " : ".$title : "");
 965         }
 966 return $title;
 967 }
 968
 969 =head2 get_html_framed_title
 970
 971 Returns the title text for a framed theme main page.
 972
 973 =cut
 974 sub get_html_framed_title
 975 {
 976 my $ostr;
 977 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
 978 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
 979 my $title;
 980 if (($gconfig{'sysinfo'} == 4 || $gconfig{'sysinfo'} == 1) && $remote_user) {
 981         # Alternate title mode requested
 982         $title = sprintf "%s on %s (%s %s)\n",
 983                 $remote_user, &get_display_hostname(),
 984                 $os_type, $os_version;
 985         }
 986 else {
 987         # Title like 'Webmin x.yy on hostname (Linux 6)'
 988         if ($os_version eq "*") {
 989                 $ostr = $os_type;
 990                 }
 991         else {
 992                 $ostr = "$os_type $os_version";
 993                 }
 994         my $host = &get_display_hostname();
 995         my $ver = &get_webmin_version();
 996         $title = $gconfig{'nohostname'} ? $text{'main_title2'} :
 997                  $gconfig{'showhost'} ? &text('main_title3', $ver, $ostr) :
 998                                         &text('main_title', $ver, $host, $ostr);
 999         if ($gconfig{'showlogin'}) {
1000                 $title = $remote_user.($title ? " : ".$title : "");
1001                 }
1002         if ($gconfig{'showhost'}) {
1003                 $title = $host.($title ? " : ".$title : "");
1004                 }
1005         }
1006 return $title;
1007 }
1008
1009 =head2 get_html_status_line(text-only)
1010
1011 Returns HTML for a script block that sets the status line, or if text-only
1012 is set to 1, just return the status line text.
1013
1014 =cut
1015 sub get_html_status_line
1016 {
1017 my ($textonly) = @_;
1018 if (($gconfig{'sysinfo'} != 0 || !$remote_user) && !$textonly) {
1019         # Disabled in this mode
1020         return undef;
1021         }
1022 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
1023 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
1024 my $line = &text('header_statusmsg',
1025                  ($ENV{'ANONYMOUS_USER'} ? "Anonymous user"
1026                                            : $remote_user).
1027                  ($ENV{'SSL_USER'} ? " (SSL certified)" :
1028                   $ENV{'LOCAL_USER'} ? " (Local user)" : ""),
1029                  $text{'programname'},
1030                  &get_webmin_version(),
1031                  &get_display_hostname(),
1032                  $os_type.($os_version eq "*" ? "" :" $os_version"));
1033 if ($textonly) {
1034         return $line;
1035         }
1036 else {
1037         $line =~ s/\r|\n//g;
1038         return "<script language=JavaScript type=text/javascript>\n".
1039                "defaultStatus=\"".&quote_escape($line)."\";\n".
1040                "</script>\n";
1041         }
1042 }
1043
1044 =head2 popup_header([title], [head-stuff], [body-stuff], [no-body])
1045
1046 Outputs a page header, suitable for a popup window. If no title is given,
1047 absolutely no decorations are output. Also useful in framesets. The parameters
1048 are :
1049
1050 =item title - Title text for the popup window.
1051
1052 =item head-stuff - HTML to appear in the <head> section.
1053
1054 =item body-stuff - HTML attributes to be include in the <body> tag.
1055
1056 =item no-body - If set to 1, don't generate a body tag
1057
1058 =cut
1059 sub popup_header
1060 {
1061 return if ($main::done_webmin_header++);
1062 my $ll;
1063 my $charset = defined($main::force_charset) ? $main::force_charset
1064                                             : &get_charset();
1065 &PrintHeader($charset);
1066 &load_theme_library();
1067 if (defined(&theme_popup_header)) {
1068         &theme_popup_header(@_);
1069         $miniserv::page_capture = 1;
1070         return;
1071         }
1072 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
1073 print "<html>\n";
1074 print "<head>\n";
1075 if (defined(&theme_popup_prehead)) {
1076         &theme_popup_prehead(@_);
1077         }
1078 print "<title>$_[0]</title>\n";
1079 print $_[1];
1080 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
1081 if ($tconfig{'headinclude'}) {
1082         print &read_file_contents(
1083                 "$theme_root_directory/$tconfig{'headinclude'}");
1084         }
1085 print "</head>\n";
1086 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
1087                  defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
1088 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
1089               defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
1090 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1091               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1092 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
1093                                               : "";
1094 if (!$_[3]) {
1095         print "<body id='popup' bgcolor=#$bgcolor link=#$link vlink=#$link ",
1096               "text=#$text $bgimage $tconfig{'inbody'} $_[2]>\n";
1097         if (defined(&theme_popup_prebody)) {
1098                 &theme_popup_prebody(@_);
1099                 }
1100         }
1101 $miniserv::page_capture = 1;
1102 }
1103
1104 =head2 footer([page, name]+, [noendbody])
1105
1106 Outputs the footer for a Webmin HTML page, possibly with links back to other
1107 pages. The links are specified by pairs of parameters, the first of which is
1108 a link destination, and the second the link text. For example :
1109
1110  footer('/', 'Webmin index', '', 'Module menu');
1111
1112 =cut
1113 sub footer
1114 {
1115 $miniserv::page_capture = 0;
1116 &load_theme_library();
1117 my %this_module_info = &get_module_info(&get_module_name());
1118 if (defined(&theme_footer)) {
1119         $module_name = &get_module_name();      # Old themes use these
1120         %module_info = %this_module_info;
1121         &theme_footer(@_);
1122         return;
1123         }
1124 for(my $i=0; $i+1<@_; $i+=2) {
1125         my $url = $_[$i];
1126         if ($url ne '/' || !$tconfig{'noindex'}) {
1127                 if ($url eq '/') {
1128                         $url = "/?cat=$this_module_info{'category'}";
1129                         }
1130                 elsif ($url eq '' && &get_module_name()) {
1131                         $url = "/".&get_module_name()."/".
1132                                $this_module_info{'index_link'};
1133                         }
1134                 elsif ($url =~ /^\?/ && &get_module_name()) {
1135                         $url = "/".&get_module_name()."/$url";
1136                         }
1137                 $url = "$gconfig{'webprefix'}$url" if ($url =~ /^\//);
1138                 if ($i == 0) {
1139                         print "<a href=\"$url\"><img alt=\"<-\" align=middle border=0 src=$gconfig{'webprefix'}/images/left.gif></a>\n";
1140                         }
1141                 else {
1142                         print "&nbsp;|\n";
1143                         }
1144                 print "&nbsp;<a href=\"$url\">",&text('main_return', $_[$i+1]),"</a>\n";
1145                 }
1146         }
1147 print "<br>\n";
1148 if (!$_[$i]) {
1149         my $postbody = $tconfig{'postbody'};
1150         if ($postbody) {
1151                 my $hostname = &get_display_hostname();
1152                 my $version = &get_webmin_version();
1153                 my $os_type = $gconfig{'real_os_type'} ||
1154                               $gconfig{'os_type'};
1155                 my $os_version = $gconfig{'real_os_version'} ||
1156                                  $gconfig{'os_version'};
1157                 $postbody =~ s/%HOSTNAME%/$hostname/g;
1158                 $postbody =~ s/%VERSION%/$version/g;
1159                 $postbody =~ s/%USER%/$remote_user/g;
1160                 $postbody =~ s/%OS%/$os_type $os_version/g;
1161                 print "$postbody\n";
1162                 }
1163         if ($tconfig{'postbodyinclude'}) {
1164                 local $_;
1165                 open(INC, "$theme_root_directory/$tconfig{'postbodyinclude'}");
1166                 while(<INC>) {
1167                         print;
1168                         }
1169                 close(INC);
1170                 }
1171         if (defined(&theme_postbody)) {
1172                 &theme_postbody(@_);
1173                 }
1174         print "</body></html>\n";
1175         }
1176 }
1177
1178 =head2 popup_footer([no-body])
1179
1180 Outputs html for a footer for a popup window, started by popup_header.
1181
1182 =cut
1183 sub popup_footer
1184 {
1185 $miniserv::page_capture = 0;
1186 &load_theme_library();
1187 if (defined(&theme_popup_footer)) {
1188         &theme_popup_footer(@_);
1189         return;
1190         }
1191 if (!$_[0]) {
1192         print "</body>\n";
1193         }
1194 print "</html>\n";
1195 }
1196
1197 =head2 load_theme_library
1198
1199 Immediately loads the current theme's theme.pl file. Not generally useful for
1200 most module developers, as this is called automatically by the header function.
1201
1202 =cut
1203 sub load_theme_library
1204 {
1205 return if (!$current_theme || $loaded_theme_library++);
1206 for(my $i=0; $i<@theme_root_directories; $i++) {
1207         if ($theme_configs[$i]->{'functions'}) {
1208                 do $theme_root_directories[$i]."/".
1209                    $theme_configs[$i]->{'functions'};
1210                 }
1211         }
1212 }
1213
1214 =head2 redirect(url)
1215
1216 Output HTTP headers to redirect the browser to some page. The url parameter is
1217 typically a relative URL like index.cgi or list_users.cgi.
1218
1219 =cut
1220 sub redirect
1221 {
1222 my $port = $ENV{'SERVER_PORT'} == 443 && uc($ENV{'HTTPS'}) eq "ON" ? "" :
1223            $ENV{'SERVER_PORT'} == 80 && uc($ENV{'HTTPS'}) ne "ON" ? "" :
1224                 ":$ENV{'SERVER_PORT'}";
1225 my $prot = uc($ENV{'HTTPS'}) eq "ON" ? "https" : "http";
1226 my $wp = $gconfig{'webprefixnoredir'} ? undef : $gconfig{'webprefix'};
1227 my $url;
1228 if ($_[0] =~ /^(http|https|ftp|gopher):/) {
1229         # Absolute URL (like http://...)
1230         $url = $_[0];
1231         }
1232 elsif ($_[0] =~ /^\//) {
1233         # Absolute path (like /foo/bar.cgi)
1234         $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$_[0]";
1235         }
1236 elsif ($ENV{'SCRIPT_NAME'} =~ /^(.*)\/[^\/]*$/) {
1237         # Relative URL (like foo.cgi)
1238         $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$1/$_[0]";
1239         }
1240 else {
1241         $url = "$prot://$ENV{'SERVER_NAME'}$port/$wp$_[0]";
1242         }
1243 &load_theme_library();
1244 if (defined(&theme_redirect)) {
1245         $module_name = &get_module_name();      # Old themes use these
1246         %module_info = &get_module_info($module_name);
1247         &theme_redirect($_[0], $url);
1248         }
1249 else {
1250         print "Location: $url\n\n";
1251         }
1252 }
1253
1254 =head2 kill_byname(name, signal)
1255
1256 Finds a process whose command line contains the given name (such as httpd), and
1257 sends some signal to it. The signal can be numeric (like 9) or named
1258 (like KILL).
1259
1260 =cut
1261 sub kill_byname
1262 {
1263 my @pids = &find_byname($_[0]);
1264 return scalar(@pids) if (&is_readonly_mode());
1265 &webmin_debug_log('KILL', "signal=$_[1] name=$_[0]")
1266         if ($gconfig{'debug_what_procs'});
1267 if (@pids) { kill($_[1], @pids); return scalar(@pids); }
1268 else { return 0; }
1269 }
1270
1271 =head2 kill_byname_logged(name, signal)
1272
1273 Like kill_byname, but also logs the killing.
1274
1275 =cut
1276 sub kill_byname_logged
1277 {
1278 my @pids = &find_byname($_[0]);
1279 return scalar(@pids) if (&is_readonly_mode());
1280 if (@pids) { &kill_logged($_[1], @pids); return scalar(@pids); }
1281 else { return 0; }
1282 }
1283
1284 =head2 find_byname(name)
1285
1286 Finds processes searching for the given name in their command lines, and
1287 returns a list of matching PIDs.
1288
1289 =cut
1290 sub find_byname
1291 {
1292 if ($gconfig{'os_type'} =~ /-linux$/ && -r "/proc/$$/cmdline") {
1293         # Linux with /proc filesystem .. use cmdline files, as this is
1294         # faster than forking
1295         my @pids;
1296         opendir(PROCDIR, "/proc");
1297         foreach my $f (readdir(PROCDIR)) {
1298                 if ($f eq int($f) && $f != $$) {
1299                         my $line = &read_file_contents("/proc/$f/cmdline");
1300                         if ($line =~ /$_[0]/) {
1301                                 push(@pids, $f);
1302                                 }
1303                         }
1304                 }
1305         closedir(PROCDIR);
1306         return @pids;
1307         }
1308
1309 if (&foreign_check("proc")) {
1310         # Call the proc module
1311         &foreign_require("proc", "proc-lib.pl");
1312         if (defined(&proc::list_processes)) {
1313                 my @procs = &proc::list_processes();
1314                 my @pids;
1315                 foreach my $p (@procs) {
1316                         if ($p->{'args'} =~ /$_[0]/) {
1317                                 push(@pids, $p->{'pid'});
1318                                 }
1319                         }
1320                 @pids = grep { $_ != $$ } @pids;
1321                 return @pids;
1322                 }
1323         }
1324
1325 # Fall back to running a command
1326 my ($cmd, @pids);
1327 $cmd = $gconfig{'find_pid_command'};
1328 $cmd =~ s/NAME/"$_[0]"/g;
1329 $cmd = &translate_command($cmd);
1330 @pids = split(/\n/, `($cmd) <$null_file 2>$null_file`);
1331 @pids = grep { $_ != $$ } @pids;
1332 return @pids;
1333 }
1334
1335 =head2 error([message]+)
1336
1337 Display an error message and exit. This should be used by CGI scripts that
1338 encounter a fatal error or invalid user input to notify users of the problem.
1339 If error_setup has been called, the displayed error message will be prefixed
1340 by the message setup using that function.
1341
1342 =cut
1343 sub error
1344 {
1345 $main::no_miniserv_userdb = 1;
1346 my $msg = join("", @_);
1347 $msg =~ s/<[^>]*>//g;
1348 if (!$main::error_must_die) {
1349         print STDERR "Error: ",$msg,"\n";
1350         }
1351 &load_theme_library();
1352 if ($main::error_must_die) {
1353         if ($gconfig{'error_stack'}) {
1354                 print STDERR "Error: ",$msg,"\n";
1355                 for(my $i=0; my @stack = caller($i); $i++) {
1356                         print STDERR "File: $stack[1] Line: $stack[2] ",
1357                                      "Function: $stack[3]\n";
1358                         }
1359                 }
1360         die @_;
1361         }
1362 elsif (!$ENV{'REQUEST_METHOD'}) {
1363         # Show text-only error
1364         print STDERR "$text{'error'}\n";
1365         print STDERR "-----\n";
1366         print STDERR ($main::whatfailed ? "$main::whatfailed : " : ""),
1367                      $msg,"\n";
1368         print STDERR "-----\n";
1369         if ($gconfig{'error_stack'}) {
1370                 # Show call stack
1371                 print STDERR $text{'error_stack'},"\n";
1372                 for(my $i=0; my @stack = caller($i); $i++) {
1373                         print STDERR &text('error_stackline',
1374                                 $stack[1], $stack[2], $stack[3]),"\n";
1375                         }
1376                 }
1377
1378         }
1379 elsif (defined(&theme_error)) {
1380         &theme_error(@_);
1381         }
1382 else {
1383         &header($text{'error'}, "");
1384         print "<hr>\n";
1385         print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),
1386                      @_,"</h3>\n";
1387         if ($gconfig{'error_stack'}) {
1388                 # Show call stack
1389                 print "<h3>$text{'error_stack'}</h3>\n";
1390                 print "<table>\n";
1391                 print "<tr> <td><b>$text{'error_file'}</b></td> ",
1392                       "<td><b>$text{'error_line'}</b></td> ",
1393                       "<td><b>$text{'error_sub'}</b></td> </tr>\n";
1394                 for($i=0; my @stack = caller($i); $i++) {
1395                         print "<tr>\n";
1396                         print "<td>$stack[1]</td>\n";
1397                         print "<td>$stack[2]</td>\n";
1398                         print "<td>$stack[3]</td>\n";
1399                         print "</tr>\n";
1400                         }
1401                 print "</table>\n";
1402                 }
1403         print "<hr>\n";
1404         if ($ENV{'HTTP_REFERER'} && $main::completed_referers_check) {
1405                 &footer($ENV{'HTTP_REFERER'}, $text{'error_previous'});
1406                 }
1407         else {
1408                 &footer();
1409                 }
1410         }
1411 &unlock_all_files();
1412 &cleanup_tempnames();
1413 exit(1);
1414 }
1415
1416 =head2 popup_error([message]+)
1417
1418 This function is almost identical to error, but displays the message with HTML
1419 headers suitable for a popup window.
1420
1421 =cut
1422 sub popup_error
1423 {
1424 $main::no_miniserv_userdb = 1;
1425 &load_theme_library();
1426 if ($main::error_must_die) {
1427         die @_;
1428         }
1429 elsif (defined(&theme_popup_error)) {
1430         &theme_popup_error(@_);
1431         }
1432 else {
1433         &popup_header($text{'error'}, "");
1434         print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),@_,"</h3>\n";
1435         &popup_footer();
1436         }
1437 &unlock_all_files();
1438 &cleanup_tempnames();
1439 exit;
1440 }
1441
1442 =head2 error_setup(message)
1443
1444 Registers a message to be prepended to all error messages displayed by the
1445 error function.
1446
1447 =cut
1448 sub error_setup
1449 {
1450 $main::whatfailed = $_[0];
1451 }
1452
1453 =head2 wait_for(handle, regexp, regexp, ...)
1454
1455 Reads from the input stream until one of the regexps matches, and returns the
1456 index of the matching regexp, or -1 if input ended before any matched. This is
1457 very useful for parsing the output of interactive programs, and can be used with
1458 a two-way pipe to feed input to a program in response to output matched by
1459 this function.
1460
1461 If the matching regexp contains bracketed sub-expressions, their values will
1462 be placed in the global array @matches, indexed starting from 1. You cannot
1463 use the Perl variables $1, $2 and so on to capture matches.
1464
1465 Example code:
1466
1467  $rv = wait_for($loginfh, "username:");
1468  if ($rv == -1) {
1469    error("Didn't get username prompt");
1470  }
1471  print $loginfh "joe\n";
1472  $rv = wait_for($loginfh, "password:");
1473  if ($rv == -1) {
1474    error("Didn't get password prompt");
1475  }
1476  print $loginfh "smeg\n";
1477
1478 =cut
1479 sub wait_for
1480 {
1481 my ($c, $i, $sw, $rv, $ha);
1482 undef($wait_for_input);
1483 if ($wait_for_debug) {
1484         print STDERR "wait_for(",join(",", @_),")\n";
1485         }
1486 $ha = &callers_package($_[0]);
1487 if ($wait_for_debug) {
1488         print STDERR "File handle=$ha fd=",fileno($ha),"\n";
1489         }
1490 $codes =
1491 "my \$hit;\n".
1492 "while(1) {\n".
1493 " if ((\$c = getc(\$ha)) eq \"\") { return -1; }\n".
1494 " \$wait_for_input .= \$c;\n";
1495 if ($wait_for_debug) {
1496         $codes .= "print STDERR \$wait_for_input,\"\\n\";";
1497         }
1498 for($i=1; $i<@_; $i++) {
1499         $sw = $i>1 ? "elsif" : "if";
1500         $codes .= " $sw (\$wait_for_input =~ /$_[$i]/i) { \$hit = $i-1; }\n";
1501         }
1502 $codes .=
1503 " if (defined(\$hit)) {\n".
1504 "  \@matches = (-1, \$1, \$2, \$3, \$4, \$5, \$6, \$7, \$8, \$9);\n".
1505 "  return \$hit;\n".
1506 "  }\n".
1507 " }\n";
1508 $rv = eval $codes;
1509 if ($@) {
1510         &error("wait_for error : $@\n");
1511         }
1512 return $rv;
1513 }
1514
1515 =head2 fast_wait_for(handle, string, string, ...)
1516
1517 This function behaves very similar to wait_for (documented above), but instead
1518 of taking regular expressions as parameters, it takes strings. As soon as the
1519 input contains one of them, it will return the index of the matching string.
1520 If the input ends before any match, it returns -1.
1521
1522 =cut
1523 sub fast_wait_for
1524 {
1525 my ($inp, $maxlen, $ha, $i, $c, $inpl);
1526 for($i=1; $i<@_; $i++) {
1527         $maxlen = length($_[$i]) > $maxlen ? length($_[$i]) : $maxlen;
1528         }
1529 $ha = $_[0];
1530 while(1) {
1531         if (($c = getc($ha)) eq "") {
1532                 &error("fast_wait_for read error : $!");
1533                 }
1534         $inp .= $c;
1535         if (length($inp) > $maxlen) {
1536                 $inp = substr($inp, length($inp)-$maxlen);
1537                 }
1538         $inpl = length($inp);
1539         for($i=1; $i<@_; $i++) {
1540                 if ($_[$i] eq substr($inp, $inpl-length($_[$i]))) {
1541                         return $i-1;
1542                         }
1543                 }
1544         }
1545 }
1546
1547 =head2 has_command(command)
1548
1549 Returns the full path to the executable if some command is in the path, or
1550 undef if not found. If the given command is already an absolute path and
1551 exists, then the same path will be returned.
1552
1553 =cut
1554 sub has_command
1555 {
1556 if (!$_[0]) { return undef; }
1557 if (exists($main::has_command_cache{$_[0]})) {
1558         return $main::has_command_cache{$_[0]};
1559         }
1560 my $rv = undef;
1561 my $slash = $gconfig{'os_type'} eq 'windows' ? '\\' : '/';
1562 if ($_[0] =~ /^\// || $_[0] =~ /^[a-z]:[\\\/]/i) {
1563         # Absolute path given - just use it
1564         my $t = &translate_filename($_[0]);
1565         $rv = (-x $t && !-d _) ? $_[0] : undef;
1566         }
1567 else {
1568         # Check each directory in the path
1569         my %donedir;
1570         foreach my $d (split($path_separator, $ENV{'PATH'})) {
1571                 next if ($donedir{$d}++);
1572                 $d =~ s/$slash$// if ($d ne $slash);
1573                 my $t = &translate_filename("$d/$_[0]");
1574                 if (-x $t && !-d _) {
1575                         $rv = $d.$slash.$_[0];
1576                         last;
1577                         }
1578                 if ($gconfig{'os_type'} eq 'windows') {
1579                         foreach my $sfx (".exe", ".com", ".bat") {
1580                                 my $t = &translate_filename("$d/$_[0]").$sfx;
1581                                 if (-r $t && !-d _) {
1582                                         $rv = $d.$slash.$_[0].$sfx;
1583                                         last;
1584                                         }
1585                                 }
1586                         }
1587                 }
1588         }
1589 $main::has_command_cache{$_[0]} = $rv;
1590 return $rv;
1591 }
1592
1593 =head2 make_date(seconds, [date-only], [fmt])
1594
1595 Converts a Unix date/time in seconds to a human-readable form, by default
1596 formatted like dd/mmm/yyyy hh:mm:ss. Parameters are :
1597
1598 =item seconds - Unix time is seconds to convert.
1599
1600 =item date-only - If set to 1, exclude the time from the returned string.
1601
1602 =item fmt - Optional, one of dd/mon/yyyy, dd/mm/yyyy, mm/dd/yyyy or yyyy/mm/dd
1603
1604 =cut
1605 sub make_date
1606 {
1607 my ($secs, $only, $fmt) = @_;
1608 my @tm = localtime($secs);
1609 my $date;
1610 if (!$fmt) {
1611         $fmt = $gconfig{'dateformat'} || 'dd/mon/yyyy';
1612         }
1613 if ($fmt eq 'dd/mon/yyyy') {
1614         $date = sprintf "%2.2d/%s/%4.4d",
1615                         $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900;
1616         }
1617 elsif ($fmt eq 'dd/mm/yyyy') {
1618         $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[3], $tm[4]+1, $tm[5]+1900;
1619         }
1620 elsif ($fmt eq 'mm/dd/yyyy') {
1621         $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[4]+1, $tm[3], $tm[5]+1900;
1622         }
1623 elsif ($fmt eq 'yyyy/mm/dd') {
1624         $date = sprintf "%4.4d/%2.2d/%2.2d", $tm[5]+1900, $tm[4]+1, $tm[3];
1625         }
1626 elsif ($fmt eq 'd. mon yyyy') {
1627         $date = sprintf "%d. %s %4.4d",
1628                         $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900;
1629         }
1630 elsif ($fmt eq 'dd.mm.yyyy') {
1631         $date = sprintf "%2.2d.%2.2d.%4.4d", $tm[3], $tm[4]+1, $tm[5]+1900;
1632         }
1633 elsif ($fmt eq 'yyyy-mm-dd') {
1634         $date = sprintf "%4.4d-%2.2d-%2.2d", $tm[5]+1900, $tm[4]+1, $tm[3];
1635         }
1636 if (!$only) {
1637         $date .= sprintf " %2.2d:%2.2d", $tm[2], $tm[1];
1638         }
1639 return $date;
1640 }
1641
1642 =head2 file_chooser_button(input, type, [form], [chroot], [addmode])
1643
1644 Return HTML for a button that pops up a file chooser when clicked, and places
1645 the selected filename into another HTML field. The parameters are :
1646
1647 =item input - Name of the form field to store the filename in.
1648
1649 =item type - 0 for file or directory chooser, or 1 for directory only.
1650
1651 =item form - Index of the form containing the button.
1652
1653 =item chroot - If set to 1, the chooser will be limited to this directory.
1654
1655 =item addmode - If set to 1, the selected filename will be appended to the text box instead of replacing it's contents.
1656
1657 =cut
1658 sub file_chooser_button
1659 {
1660 return &theme_file_chooser_button(@_)
1661         if (defined(&theme_file_chooser_button));
1662 my $form = defined($_[2]) ? $_[2] : 0;
1663 my $chroot = defined($_[3]) ? $_[3] : "/";
1664 my $add = int($_[4]);
1665 my ($w, $h) = (400, 300);
1666 if ($gconfig{'db_sizefile'}) {
1667         ($w, $h) = split(/x/, $gconfig{'db_sizefile'});
1668         }
1669 return "<input type=button onClick='ifield = form.$_[0]; chooser = window.open(\"$gconfig{'webprefix'}/chooser.cgi?add=$add&type=$_[1]&chroot=$chroot&file=\"+escape(ifield.value), \"chooser\", \"toolbar=no,menubar=no,scrollbars=no,resizable=yes,width=$w,height=$h\"); chooser.ifield = ifield; window.ifield = ifield' value=\"...\">\n";
1670 }
1671
1672 =head2 popup_window_button(url, width, height, scrollbars?, &field-mappings)
1673
1674 Returns HTML for a button that will popup a chooser window of some kind. The
1675 parameters are :
1676
1677 =item url - Base URL of the popup window's contents
1678
1679 =item width - Width of the window in pixels
1680
1681 =item height - Height in pixels
1682
1683 =item scrollbars - Set to 1 if the window should have scrollbars
1684
1685 The field-mappings parameter is an array ref of array refs containing
1686
1687 =item - Attribute to assign field to in the popup window
1688
1689 =item - Form field name
1690
1691 =item - CGI parameter to URL for value, if any
1692
1693 =cut
1694 sub popup_window_button
1695 {
1696 return &theme_popup_window_button(@_) if (defined(&theme_popup_window_button));
1697 my ($url, $w, $h, $scroll, $fields) = @_;
1698 my $scrollyn = $scroll ? "yes" : "no";
1699 my $rv = "<input type=button onClick='";
1700 foreach my $m (@$fields) {
1701         $rv .= "$m->[0] = form.$m->[1]; ";
1702         }
1703 my $sep = $url =~ /\?/ ? "&" : "?";
1704 $rv .= "chooser = window.open(\"$url\"";
1705 foreach my $m (@$fields) {
1706         if ($m->[2]) {
1707                 $rv .= "+\"$sep$m->[2]=\"+escape($m->[0].value)";
1708                 $sep = "&";
1709                 }
1710         }
1711 $rv .= ", \"chooser\", \"toolbar=no,menubar=no,scrollbars=$scrollyn,resizable=yes,width=$w,height=$h\"); ";
1712 foreach my $m (@$fields) {
1713         $rv .= "chooser.$m->[0] = $m->[0]; ";
1714         $rv .= "window.$m->[0] = $m->[0]; ";
1715         }
1716 $rv .= "' value=\"...\">";
1717 return $rv;
1718 }
1719
1720 =head2 read_acl(&user-module-hash, &user-list-hash, [&only-users])
1721
1722 Reads the Webmin acl file into the given hash references. The first is indexed
1723 by a combined key of username,module , with the value being set to 1 when
1724 the user has access to that module. The second is indexed by username, with
1725 the value being an array ref of allowed modules.
1726
1727 This function is deprecated in favour of foreign_available, which performs a
1728 more comprehensive check of module availability.
1729
1730 If the only-users array ref parameter is given, the results may be limited to
1731 users in that list of names.
1732
1733 =cut
1734 sub read_acl
1735 {
1736 my ($usermod, $userlist, $only) = @_;
1737 if (!%main::acl_hash_cache) {
1738         # Read from local files
1739         local $_;
1740         open(ACL, &acl_filename());
1741         while(<ACL>) {
1742                 if (/^([^:]+):\s*(.*)/) {
1743                         my $user = $1;
1744                         my @mods = split(/\s+/, $2);
1745                         foreach my $m (@mods) {
1746                                 $main::acl_hash_cache{$user,$m}++;
1747                                 }
1748                         $main::acl_array_cache{$user} = \@mods;
1749                         }
1750                 }
1751         close(ACL);
1752         }
1753 %$usermod = %main::acl_hash_cache if ($usermod);
1754 %$userlist = %main::acl_array_cache if ($userlist);
1755
1756 # Read from user DB
1757 my $userdb = &get_userdb_string();
1758 my ($dbh, $proto, $prefix, $args) =
1759         $userdb ? &connect_userdb($userdb) : ( );
1760 if (ref($dbh)) {
1761         if ($proto eq "mysql" || $proto eq "postgresql") {
1762                 # Select usernames and modules from SQL DB
1763                 my $cmd = $dbh->prepare(
1764                         "select webmin_user.name,webmin_user_attr.value ".
1765                         "from webmin_user,webmin_user_attr ".
1766                         "where webmin_user.id = webmin_user_attr.id ".
1767                         "and webmin_user_attr.attr = 'modules' ".
1768                         ($only ? " and webmin_user.name in (".
1769                                  join(",", map { "'$_'" } @$only).")" : ""));
1770                 if ($cmd && $cmd->execute()) {
1771                         while(my ($user, $mods) = $cmd->fetchrow()) {
1772                                 my @mods = split(/\s+/, $mods);
1773                                 foreach my $m (@mods) {
1774                                         $usermod->{$user,$m}++ if ($usermod);
1775                                         }
1776                                 $userlist->{$user} = \@mods if ($userlist);
1777                                 }
1778                         }
1779                 $cmd->finish() if ($cmd);
1780                 }
1781         elsif ($proto eq "ldap") {
1782                 # Find users in LDAP
1783                 my $filter = '(objectClass='.$args->{'userclass'}.')';
1784                 if ($only) {
1785                         my $ufilter =
1786                                 "(|".join("", map { "(cn=$_)" } @$only).")";
1787                         $filter = "(&".$filter.$ufilter.")";
1788                         }
1789                 my $rv = $dbh->search(
1790                         base => $prefix,
1791                         filter => $filter,
1792                         scope => 'sub',
1793                         attrs => [ 'cn', 'webminModule' ]);
1794                 if ($rv && !$rv->code) {
1795                         foreach my $u ($rv->all_entries) {
1796                                 my $user = $u->get_value('cn');
1797                                 my @mods =$u->get_value('webminModule');
1798                                 foreach my $m (@mods) {
1799                                         $usermod->{$user,$m}++ if ($usermod);
1800                                         }
1801                                 $userlist->{$user} = \@mods if ($userlist);
1802                                 }
1803                         }
1804                 }
1805         &disconnect_userdb($userdb, $dbh);
1806         }
1807 }
1808
1809 =head2 acl_filename
1810
1811 Returns the file containing the webmin ACL, which is usually
1812 /etc/webmin/webmin.acl.
1813
1814 =cut
1815 sub acl_filename
1816 {
1817 return "$config_directory/webmin.acl";
1818 }
1819
1820 =head2 acl_check
1821
1822 Does nothing, but kept around for compatability.
1823
1824 =cut
1825 sub acl_check
1826 {
1827 }
1828
1829 =head2 get_miniserv_config(&hash)
1830
1831 Reads the Webmin webserver's (miniserv.pl) configuration file, usually located
1832 at /etc/webmin/miniserv.conf, and stores its names and values in the given
1833 hash reference.
1834
1835 =cut
1836 sub get_miniserv_config
1837 {
1838 return &read_file_cached(
1839         $ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf", $_[0]);
1840 }
1841
1842 =head2 put_miniserv_config(&hash)
1843
1844 Writes out the Webmin webserver configuration file from the contents of
1845 the given hash ref. This should be initially populated by get_miniserv_config,
1846 like so :
1847
1848  get_miniserv_config(\%miniserv);
1849  $miniserv{'port'} = 10005;
1850  put_miniserv_config(\%miniserv);
1851  restart_miniserv();
1852
1853 =cut
1854 sub put_miniserv_config
1855 {
1856 &write_file($ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf",
1857             $_[0]);
1858 }
1859
1860 =head2 restart_miniserv([nowait])
1861
1862 Kill the old miniserv process and re-start it, then optionally waits for
1863 it to restart. This will apply all configuration settings.
1864
1865 =cut
1866 sub restart_miniserv
1867 {
1868 my ($nowait) = @_;
1869 return undef if (&is_readonly_mode());
1870 my %miniserv;
1871 &get_miniserv_config(\%miniserv) || return;
1872 if ($main::webmin_script_type eq 'web' && !$ENV{"MINISERV_CONFIG"} &&
1873     !$ENV{'MINISERV_PID'}) {
1874         # Running under some web server other than miniserv, so do nothing
1875         return;
1876         }
1877
1878 my $i;
1879 if ($gconfig{'os_type'} ne 'windows') {
1880         # On Unix systems, we can restart with a signal
1881         my ($pid, $addr, $i);
1882         $miniserv{'inetd'} && return;
1883         my @oldst = stat($miniserv{'pidfile'});
1884         $pid = $ENV{'MINISERV_PID'};
1885         if (!$pid) {
1886                 if (!open(PID, $miniserv{'pidfile'})) {
1887                         print STDERR "PID file $miniserv{'pidfile'} does ",
1888                                      "not exist\n";
1889                         return;
1890                         }
1891                 chop($pid = <PID>);
1892                 close(PID);
1893                 if (!$pid) {
1894                         print STDERR "Invalid PID file $miniserv{'pidfile'}\n";
1895                         return;
1896                         }
1897                 if (!kill(0, $pid)) {
1898                         print STDERR "PID $pid from file $miniserv{'pidfile'} ",
1899                                      "is not valid\n";
1900                         return;
1901                         }
1902                 }
1903
1904         # Just signal miniserv to restart
1905         &kill_logged('HUP', $pid) || &error("Incorrect Webmin PID $pid");
1906
1907         # Wait till new PID is written, indicating a restart
1908         for($i=0; $i<60; $i++) {
1909                 sleep(1);
1910                 my @newst = stat($miniserv{'pidfile'});
1911                 last if ($newst[9] != $oldst[9]);
1912                 }
1913         $i < 60 || &error("Webmin server did not write new PID file");
1914
1915         ## Totally kill the process and re-run it
1916         #$SIG{'TERM'} = 'IGNORE';
1917         #&kill_logged('TERM', $pid);
1918         #&system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1919         }
1920 else {
1921         # On Windows, we need to use the flag file
1922         open(TOUCH, ">$miniserv{'restartflag'}");
1923         close(TOUCH);
1924         }
1925
1926 if (!$nowait) {
1927         # Wait for miniserv to come back up
1928         my $addr = $miniserv{'bind'} || "127.0.0.1";
1929         my $ok = 0;
1930         for($i=0; $i<20; $i++) {
1931                 my $err;
1932                 sleep(1);
1933                 &open_socket($addr, $miniserv{'port'}, STEST, \$err);
1934                 close(STEST);
1935                 last if (!$err && ++$ok >= 2);
1936                 }
1937         $i < 20 || &error("Failed to restart Webmin server!");
1938         }
1939 }
1940
1941 =head2 reload_miniserv
1942
1943 Sends a USR1 signal to the miniserv process, telling it to read-read it's
1944 configuration files. Not all changes will be applied though, such as the
1945 IP addresses and ports to accept connections on.
1946
1947 =cut
1948 sub reload_miniserv
1949 {
1950 return undef if (&is_readonly_mode());
1951 my %miniserv;
1952 &get_miniserv_config(\%miniserv) || return;
1953 if ($main::webmin_script_type eq 'web' && !$ENV{"MINISERV_CONFIG"} &&
1954     !$ENV{'MINISERV_PID'}) {
1955         # Running under some web server other than miniserv, so do nothing
1956         return;
1957         }
1958
1959 if ($gconfig{'os_type'} ne 'windows') {
1960         # Send a USR1 signal to re-read the config
1961         my ($pid, $addr, $i);
1962         $miniserv{'inetd'} && return;
1963         $pid = $ENV{'MINISERV_PID'};
1964         if (!$pid) {
1965                 if (!open(PID, $miniserv{'pidfile'})) {
1966                         print STDERR "PID file $miniserv{'pidfile'} does ",
1967                                      "not exist\n";
1968                         return;
1969                         }
1970                 chop($pid = <PID>);
1971                 close(PID);
1972                 if (!$pid) {
1973                         print STDERR "Invalid PID file $miniserv{'pidfile'}\n";
1974                         return;
1975                         }
1976                 if (!kill(0, $pid)) {
1977                         print STDERR "PID $pid from file $miniserv{'pidfile'} ",
1978                                      "is not valid\n";
1979                         return;
1980                         }
1981                 }
1982         &kill_logged('USR1', $pid) || &error("Incorrect Webmin PID $pid");
1983
1984         # Make sure this didn't kill Webmin!
1985         sleep(1);
1986         if (!kill(0, $pid)) {
1987                 print STDERR "USR1 signal killed Webmin - restarting\n";
1988                 &system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1989                 }
1990         }
1991 else {
1992         # On Windows, we need to use the flag file
1993         open(TOUCH, ">$miniserv{'reloadflag'}");
1994         close(TOUCH);
1995         }
1996 }
1997
1998 =head2 check_os_support(&minfo, [os-type, os-version], [api-only])
1999
2000 Returns 1 if some module is supported on the current operating system, or the
2001 OS supplies as parameters. The parameters are :
2002
2003 =item minfo - A hash ref of module information, as returned by get_module_info
2004
2005 =item os-type - The Webmin OS code to use instead of the system's real OS, such as redhat-linux
2006
2007 =item os-version - The Webmin OS version to use, such as 13.0
2008
2009 =item api-only - If set to 1, considers a module supported if it provides an API to other modules on this OS, even if the majority of its functionality is not supported.
2010
2011 =cut
2012 sub check_os_support
2013 {
2014 my $oss = $_[0]->{'os_support'};
2015 if ($_[3] && $oss && $_[0]->{'api_os_support'}) {
2016         # May provide usable API
2017         $oss .= " ".$_[0]->{'api_os_support'};
2018         }
2019 if ($_[0]->{'nozone'} && &running_in_zone()) {
2020         # Not supported in a Solaris Zone
2021         return 0;
2022         }
2023 if ($_[0]->{'novserver'} && &running_in_vserver()) {
2024         # Not supported in a Linux Vserver
2025         return 0;
2026         }
2027 if ($_[0]->{'noopenvz'} && &running_in_openvz()) {
2028         # Not supported in an OpenVZ container
2029         return 0;
2030         }
2031 return 1 if (!$oss || $oss eq '*');
2032 my $osver = $_[2] || $gconfig{'os_version'};
2033 my $ostype = $_[1] || $gconfig{'os_type'};
2034 my $anyneg = 0;
2035 while(1) {
2036         my ($os, $ver, $codes);
2037         my ($neg) = ($oss =~ s/^!//);   # starts with !
2038         $anyneg++ if ($neg);
2039         if ($oss =~ /^([^\/\s]+)\/([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
2040                 # OS/version{code}
2041                 $os = $1; $ver = $2; $codes = $3; $oss = $4;
2042                 }
2043         elsif ($oss =~ /^([^\/\s]+)\/([^\/\s]+)\s*(.*)$/) {
2044                 # OS/version
2045                 $os = $1; $ver = $2; $oss = $3;
2046                 }
2047         elsif ($oss =~ /^([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
2048                 # OS/{code}
2049                 $os = $1; $codes = $2; $oss = $3;
2050                 }
2051         elsif ($oss =~ /^\{([^\}]*)\}\s*(.*)$/) {
2052                 # {code}
2053                 $codes = $1; $oss = $2;
2054                 }
2055         elsif ($oss =~ /^(\S+)\s*(.*)$/) {
2056                 # OS
2057                 $os = $1; $oss = $2;
2058                 }
2059         else { last; }
2060         next if ($os && !($os eq $ostype ||
2061                           $ostype =~ /^(\S+)-(\S+)$/ && $os eq "*-$2"));
2062         if ($ver =~ /^([0-9\.]+)\-([0-9\.]+)$/) {
2063                 next if ($osver < $1 || $osver > $2);
2064                 }
2065         elsif ($ver =~ /^([0-9\.]+)\-\*$/) {
2066                 next if ($osver < $1);
2067                 }
2068         elsif ($ver =~ /^\*\-([0-9\.]+)$/) {
2069                 next if ($osver > $1);
2070                 }
2071         elsif ($ver) {
2072                 next if ($ver ne $osver);
2073                 }
2074         next if ($codes && !eval $codes);
2075         return !$neg;
2076         }
2077 return $anyneg;
2078 }
2079
2080 =head2 http_download(host, port, page, destfile, [&error], [&callback], [sslmode], [user, pass], [timeout], [osdn-convert], [no-cache], [&headers])
2081
2082 Downloads data from a HTTP url to a local file or string. The parameters are :
2083
2084 =item host - The hostname part of the URL, such as www.google.com
2085
2086 =item port - The HTTP port number, such as 80
2087
2088 =item page - The filename part of the URL, like /index.html
2089
2090 =item destfile - The local file to save the URL data to, like /tmp/index.html. This can also be a scalar reference, in which case the data will be appended to that scalar.
2091
2092 =item error - If set to a scalar ref, the function will store any error message in this scalar and return 0 on failure, or 1 on success. If not set, it will simply call the error function if the download fails.
2093
2094 =item callback - If set to a function ref, it will be called after each block of data is received. This is typically set to \&progress_callback, for printing download progress.
2095
2096 =item sslmode - If set to 1, an HTTPS connection is used instead of HTTP.
2097
2098 =item user - If set, HTTP authentication is done with this username.
2099
2100 =item pass - The HTTP password to use with the username above.
2101
2102 =item timeout - A timeout in seconds to wait for the TCP connection to be established before failing.
2103
2104 =item osdn-convert - If set to 1, URL for downloads from sourceforge are converted to use an appropriate mirror site.
2105
2106 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
2107
2108 =item headers - If set to a hash ref of additional HTTP headers, they will be added to the request.
2109
2110 =cut
2111 sub http_download
2112 {
2113 my ($host, $port, $page, $dest, $error, $cbfunc, $ssl, $user, $pass,
2114     $timeout, $osdn, $nocache, $headers) = @_;
2115 if ($gconfig{'debug_what_net'}) {
2116         &webmin_debug_log('HTTP', "host=$host port=$port page=$page ssl=$ssl".
2117                                   ($user ? " user=$user pass=$pass" : "").
2118                                   (ref($dest) ? "" : " dest=$dest"));
2119         }
2120 if ($osdn) {
2121         # Convert OSDN URL first
2122         my $prot = $ssl ? "https://" : "http://";
2123         my $portstr = $ssl && $port == 443 ||
2124                          !$ssl && $port == 80 ? "" : ":$port";
2125         ($host, $port, $page, $ssl) = &parse_http_url(
2126                 &convert_osdn_url($prot.$host.$portstr.$page));
2127         }
2128
2129 # Check if we already have cached the URL
2130 my $url = ($ssl ? "https://" : "http://").$host.":".$port.$page;
2131 my $cfile = &check_in_http_cache($url);
2132 if ($cfile && !$nocache) {
2133         # Yes! Copy to dest file or variable
2134         &$cbfunc(6, $url) if ($cbfunc);
2135         if (ref($dest)) {
2136                 &open_readfile(CACHEFILE, $cfile);
2137                 local $/ = undef;
2138                 $$dest = <CACHEFILE>;
2139                 close(CACHEFILE);
2140                 }
2141         else {
2142                 &copy_source_dest($cfile, $dest);
2143                 }
2144         return;
2145         }
2146
2147 # Build headers
2148 my @headers;
2149 push(@headers, [ "Host", $host ]);
2150 push(@headers, [ "User-agent", "Webmin" ]);
2151 push(@headers, [ "Accept-language", "en" ]);
2152 if ($user) {
2153         my $auth = &encode_base64("$user:$pass");
2154         $auth =~ tr/\r\n//d;
2155         push(@headers, [ "Authorization", "Basic $auth" ]);
2156         }
2157 foreach my $hname (keys %$headers) {
2158         push(@headers, [ $hname, $headers->{$hname} ]);
2159         }
2160
2161 # Actually download it
2162 $main::download_timed_out = undef;
2163 local $SIG{ALRM} = \&download_timeout;
2164 alarm($timeout || 60);
2165 my $h = &make_http_connection($host, $port, $ssl, "GET", $page, \@headers);
2166 alarm(0);
2167 $h = $main::download_timed_out if ($main::download_timed_out);
2168 if (!ref($h)) {
2169         if ($error) { $$error = $h; return; }
2170         else { &error($h); }
2171         }
2172 &complete_http_download($h, $dest, $error, $cbfunc, $osdn, $host, $port,
2173                         $headers, $ssl, $nocache);
2174 if ((!$error || !$$error) && !$nocache) {
2175         &write_to_http_cache($url, $dest);
2176         }
2177 }
2178
2179 =head2 complete_http_download(handle, destfile, [&error], [&callback], [osdn], [oldhost], [oldport], [&send-headers], [old-ssl], [no-cache])
2180
2181 Do a HTTP download, after the headers have been sent. For internal use only,
2182 typically called by http_download.
2183
2184 =cut
2185 sub complete_http_download
2186 {
2187 local ($line, %header, @headers, $s);  # Kept local so that callback funcs
2188                                        # can access them.
2189 my $cbfunc = $_[3];
2190
2191 # read headers
2192 alarm(60);
2193 ($line = &read_http_connection($_[0])) =~ tr/\r\n//d;
2194 if ($line !~ /^HTTP\/1\..\s+(200|30[0-9])(\s+|$)/) {
2195         alarm(0);
2196         if ($_[2]) { ${$_[2]} = $line; return; }
2197         else { &error("Download failed : $line"); }
2198         }
2199 my $rcode = $1;
2200 &$cbfunc(1, $rcode >= 300 && $rcode < 400 ? 1 : 0)
2201         if ($cbfunc);
2202 while(1) {
2203         $line = &read_http_connection($_[0]);
2204         $line =~ tr/\r\n//d;
2205         $line =~ /^(\S+):\s+(.*)$/ || last;
2206         $header{lc($1)} = $2;
2207         push(@headers, [ lc($1), $2 ]);
2208         }
2209 alarm(0);
2210 if ($main::download_timed_out) {
2211         if ($_[2]) { ${$_[2]} = $main::download_timed_out; return 0; }
2212         else { &error($main::download_timed_out); }
2213         }
2214 &$cbfunc(2, $header{'content-length'}) if ($cbfunc);
2215 if ($rcode >= 300 && $rcode < 400) {
2216         # follow the redirect
2217         &$cbfunc(5, $header{'location'}) if ($cbfunc);
2218         my ($host, $port, $page, $ssl);
2219         if ($header{'location'} =~ /^(http|https):\/\/([^:]+):(\d+)(\/.*)?$/) {
2220                 $ssl = $1 eq 'https' ? 1 : 0;
2221                 $host = $2;
2222                 $port = $3;
2223                 $page = $4 || "/";
2224                 }
2225         elsif ($header{'location'} =~ /^(http|https):\/\/([^:\/]+)(\/.*)?$/) {
2226                 $ssl = $1 eq 'https' ? 1 : 0;
2227                 $host = $2;
2228                 $port = $ssl ? 443 : 80;
2229                 $page = $3 || "/";
2230                 }
2231         elsif ($header{'location'} =~ /^\// && $_[5]) {
2232                 # Relative to same server
2233                 $host = $_[5];
2234                 $port = $_[6];
2235                 $ssl = $_[8];
2236                 $page = $header{'location'};
2237                 }
2238         elsif ($header{'location'}) {
2239                 # Assume relative to same dir .. not handled
2240                 if ($_[2]) { ${$_[2]} = "Invalid Location header $header{'location'}"; return; }
2241                 else { &error("Invalid Location header $header{'location'}"); }
2242                 }
2243         else {
2244                 if ($_[2]) { ${$_[2]} = "Missing Location header"; return; }
2245                 else { &error("Missing Location header"); }
2246                 }
2247         my $params;
2248         ($page, $params) = split(/\?/, $page);
2249         $page =~ s/ /%20/g;
2250         $page .= "?".$params if (defined($params));
2251         &http_download($host, $port, $page, $_[1], $_[2], $cbfunc, $ssl,
2252                        undef, undef, undef, $_[4], $_[9], $_[7]);
2253         }
2254 else {
2255         # read data
2256         if (ref($_[1])) {
2257                 # Append to a variable
2258                 while(defined($buf = &read_http_connection($_[0], 1024))) {
2259                         ${$_[1]} .= $buf;
2260                         &$cbfunc(3, length(${$_[1]})) if ($cbfunc);
2261                         }
2262                 }
2263         else {
2264                 # Write to a file
2265                 my $got = 0;
2266                 if (!&open_tempfile(PFILE, ">$_[1]", 1)) {
2267                         if ($_[2]) { ${$_[2]} = "Failed to write to $_[1] : $!"; return; }
2268                         else { &error("Failed to write to $_[1] : $!"); }
2269                         }
2270                 binmode(PFILE);         # For windows
2271                 while(defined($buf = &read_http_connection($_[0], 1024))) {
2272                         &print_tempfile(PFILE, $buf);
2273                         $got += length($buf);
2274                         &$cbfunc(3, $got) if ($cbfunc);
2275                         }
2276                 &close_tempfile(PFILE);
2277                 if ($header{'content-length'} &&
2278                     $got != $header{'content-length'}) {
2279                         if ($_[2]) { ${$_[2]} = "Download incomplete"; return; }
2280                         else { &error("Download incomplete"); }
2281                         }
2282                 }
2283         &$cbfunc(4) if ($cbfunc);
2284         }
2285 &close_http_connection($_[0]);
2286 }
2287
2288
2289 =head2 http_post(host, port, page, content, destfile, [&error], [&callback], [sslmode], [user, pass], [timeout], [osdn-convert], [no-cache], [&headers])
2290
2291 Posts data to an HTTP url and downloads the response to a local file or string. The parameters are :
2292
2293 =item host - The hostname part of the URL, such as www.google.com
2294
2295 =item port - The HTTP port number, such as 80
2296
2297 =item page - The filename part of the URL, like /index.html
2298
2299 =item content - The data to post
2300
2301 =item destfile - The local file to save the URL data to, like /tmp/index.html. This can also be a scalar reference, in which case the data will be appended to that scalar.
2302
2303 =item error - If set to a scalar ref, the function will store any error message in this scalar and return 0 on failure, or 1 on success. If not set, it will simply call the error function if the download fails.
2304
2305 =item callback - If set to a function ref, it will be called after each block of data is received. This is typically set to \&progress_callback, for printing download progress.
2306
2307 =item sslmode - If set to 1, an HTTPS connection is used instead of HTTP.
2308
2309 =item user - If set, HTTP authentication is done with this username.
2310
2311 =item pass - The HTTP password to use with the username above.
2312
2313 =item timeout - A timeout in seconds to wait for the TCP connection to be established before failing.
2314
2315 =item osdn-convert - If set to 1, URL for downloads from sourceforge are converted to use an appropriate mirror site.
2316
2317 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
2318
2319 =item headers - If set to a hash ref of additional HTTP headers, they will be added to the request.
2320
2321 =cut
2322 sub http_post
2323 {
2324 my ($host, $port, $page, $content, $dest, $error, $cbfunc, $ssl, $user, $pass,
2325     $timeout, $osdn, $nocache, $headers) = @_;
2326 if ($gconfig{'debug_what_net'}) {
2327         &webmin_debug_log('HTTP', "host=$host port=$port page=$page ssl=$ssl".
2328                                   ($user ? " user=$user pass=$pass" : "").
2329                                   (ref($dest) ? "" : " dest=$dest"));
2330         }
2331 if ($osdn) {
2332         # Convert OSDN URL first
2333         my $prot = $ssl ? "https://" : "http://";
2334         my $portstr = $ssl && $port == 443 ||
2335                          !$ssl && $port == 80 ? "" : ":$port";
2336         ($host, $port, $page, $ssl) = &parse_http_url(
2337                 &convert_osdn_url($prot.$host.$portstr.$page));
2338         }
2339
2340 # Build headers
2341 my @headers;
2342 push(@headers, [ "Host", $host ]);
2343 push(@headers, [ "User-agent", "Webmin" ]);
2344 push(@headers, [ "Accept-language", "en" ]);
2345 push(@headers, [ "Content-type", "application/x-www-form-urlencoded" ]);
2346 push(@headers, [ "Content-length", length($content) ]);
2347 if ($user) {
2348         my $auth = &encode_base64("$user:$pass");
2349         $auth =~ tr/\r\n//d;
2350         push(@headers, [ "Authorization", "Basic $auth" ]);
2351         }
2352 foreach my $hname (keys %$headers) {
2353         push(@headers, [ $hname, $headers->{$hname} ]);
2354         }
2355
2356 # Actually download it
2357 $main::download_timed_out = undef;
2358 local $SIG{ALRM} = \&download_timeout;
2359 alarm($timeout || 60);
2360 my $h = &make_http_connection($host, $port, $ssl, "POST", $page, \@headers);
2361 alarm(0);
2362 $h = $main::download_timed_out if ($main::download_timed_out);
2363 if (!ref($h)) {
2364         if ($error) { $$error = $h; return; }
2365         else { &error($h); }
2366         }
2367 &write_http_connection($content."\r\n");
2368 &complete_http_download($h, $dest, $error, $cbfunc, $osdn, $host, $port,
2369                         $headers, $ssl, $nocache);
2370 if ((!$error || !$$error) && !$nocache) {
2371         &write_to_http_cache($url, $dest);
2372         }
2373 }
2374
2375 =head2 ftp_download(host, file, destfile, [&error], [&callback], [user, pass], [port], [no-cache])
2376
2377 Download data from an FTP site to a local file. The parameters are :
2378
2379 =item host - FTP server hostname
2380
2381 =item file - File on the FTP server to download
2382
2383 =item destfile - File on the Webmin system to download data to
2384
2385 =item error - If set to a string ref, any error message is written into this string and the function returns 0 on failure, 1 on success. Otherwise, error is called on failure.
2386
2387 =item callback - If set to a function ref, it will be called after each block of data is received. This is typically set to \&progress_callback, for printing download progress.
2388
2389 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2390
2391 =item pass - Password for the username above.
2392
2393 =item port - FTP server port number, which defaults to 21 if not set.
2394
2395 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
2396
2397 =cut
2398 sub ftp_download
2399 {
2400 my ($host, $file, $dest, $error, $cbfunc, $user, $pass, $port, $nocache) = @_;
2401 $port ||= 21;
2402 if ($gconfig{'debug_what_net'}) {
2403         &webmin_debug_log('FTP', "host=$host port=$port file=$file".
2404                                  ($user ? " user=$user pass=$pass" : "").
2405                                  (ref($dest) ? "" : " dest=$dest"));
2406         }
2407 my ($buf, @n);
2408 $cbfunc = $_[4];
2409 if (&is_readonly_mode()) {
2410         if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2411                      return 0; }
2412         else { &error("FTP connections not allowed in readonly mode"); }
2413         }
2414
2415 # Check if we already have cached the URL
2416 my $url = "ftp://".$host.$file;
2417 my $cfile = &check_in_http_cache($url);
2418 if ($cfile && !$nocache) {
2419         # Yes! Copy to dest file or variable
2420         &$cbfunc(6, $url) if ($cbfunc);
2421         if (ref($dest)) {
2422                 &open_readfile(CACHEFILE, $cfile);
2423                 local $/ = undef;
2424                 $$dest = <CACHEFILE>;
2425                 close(CACHEFILE);
2426                 }
2427         else {
2428                 &copy_source_dest($cfile, $dest);
2429                 }
2430         return;
2431         }
2432
2433 # Actually download it
2434 $main::download_timed_out = undef;
2435 local $SIG{ALRM} = \&download_timeout;
2436 alarm(60);
2437 my $connected;
2438 if ($gconfig{'ftp_proxy'} =~ /^http:\/\/(\S+):(\d+)/ && !&no_proxy($_[0])) {
2439         # download through http-style proxy
2440         my $error;
2441         if (&open_socket($1, $2, "SOCK", \$error)) {
2442                 # Connected OK
2443                 if ($main::download_timed_out) {
2444                         alarm(0);
2445                         if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2446                         else { &error($main::download_timed_out); }
2447                         }
2448                 my $esc = $_[1]; $esc =~ s/ /%20/g;
2449                 my $up = "$_[5]:$_[6]\@" if ($_[5]);
2450                 my $portstr = $port == 21 ? "" : ":$port";
2451                 print SOCK "GET ftp://$up$_[0]$portstr$esc HTTP/1.0\r\n";
2452                 print SOCK "User-agent: Webmin\r\n";
2453                 if ($gconfig{'proxy_user'}) {
2454                         my $auth = &encode_base64(
2455                            "$gconfig{'proxy_user'}:$gconfig{'proxy_pass'}");
2456                         $auth =~ tr/\r\n//d;
2457                         print SOCK "Proxy-Authorization: Basic $auth\r\n";
2458                         }
2459                 print SOCK "\r\n";
2460                 &complete_http_download({ 'fh' => "SOCK" }, $_[2], $_[3], $_[4],
2461                                 undef, undef, undef, undef, 0, $nocache);
2462                 $connected = 1;
2463                 }
2464         elsif (!$gconfig{'proxy_fallback'}) {
2465                 alarm(0);
2466                 if ($error) { $$error = $main::download_timed_out; return 0; }
2467                 else { &error($main::download_timed_out); }
2468                 }
2469         }
2470
2471 if (!$connected) {
2472         # connect to host and login with real FTP protocol
2473         &open_socket($_[0], $port, "SOCK", $_[3]) || return 0;
2474         alarm(0);
2475         if ($main::download_timed_out) {
2476                 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2477                 else { &error($main::download_timed_out); }
2478                 }
2479         &ftp_command("", 2, $_[3]) || return 0;
2480         if ($_[5]) {
2481                 # Login as supplied user
2482                 my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2483                 @urv || return 0;
2484                 if (int($urv[1]/100) == 3) {
2485                         &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2486                         }
2487                 }
2488         else {
2489                 # Login as anonymous
2490                 my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2491                 @urv || return 0;
2492                 if (int($urv[1]/100) == 3) {
2493                         &ftp_command("PASS root\@".&get_system_hostname(), 2,
2494                                      $_[3]) || return 0;
2495                         }
2496                 }
2497         &$cbfunc(1, 0) if ($cbfunc);
2498
2499         if ($_[1]) {
2500                 # get the file size and tell the callback
2501                 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2502                 my $size = &ftp_command("SIZE $_[1]", 2, $_[3]);
2503                 defined($size) || return 0;
2504                 if ($cbfunc) {
2505                         &$cbfunc(2, int($size));
2506                         }
2507
2508                 # request the file
2509                 my $pasv = &ftp_command("PASV", 2, $_[3]);
2510                 defined($pasv) || return 0;
2511                 $pasv =~ /\(([0-9,]+)\)/;
2512                 @n = split(/,/ , $1);
2513                 &open_socket("$n[0].$n[1].$n[2].$n[3]",
2514                         $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2515                 &ftp_command("RETR $_[1]", 1, $_[3]) || return 0;
2516
2517                 # transfer data
2518                 my $got = 0;
2519                 &open_tempfile(PFILE, ">$_[2]", 1);
2520                 while(read(CON, $buf, 1024) > 0) {
2521                         &print_tempfile(PFILE, $buf);
2522                         $got += length($buf);
2523                         &$cbfunc(3, $got) if ($cbfunc);
2524                         }
2525                 &close_tempfile(PFILE);
2526                 close(CON);
2527                 if ($got != $size) {
2528                         if ($_[3]) { ${$_[3]} = "Download incomplete"; return 0; }
2529                         else { &error("Download incomplete"); }
2530                         }
2531                 &$cbfunc(4) if ($cbfunc);
2532
2533                 &ftp_command("", 2, $_[3]) || return 0;
2534                 }
2535
2536         # finish off..
2537         &ftp_command("QUIT", 2, $_[3]) || return 0;
2538         close(SOCK);
2539         }
2540
2541 &write_to_http_cache($url, $dest);
2542 return 1;
2543 }
2544
2545 =head2 ftp_upload(host, file, srcfile, [&error], [&callback], [user, pass], [port])
2546
2547 Upload data from a local file to an FTP site. The parameters are :
2548
2549 =item host - FTP server hostname
2550
2551 =item file - File on the FTP server to write to
2552
2553 =item srcfile - File on the Webmin system to upload data from
2554
2555 =item error - If set to a string ref, any error message is written into this string and the function returns 0 on failure, 1 on success. Otherwise, error is called on failure.
2556
2557 =item callback - If set to a function ref, it will be called after each block of data is received. This is typically set to \&progress_callback, for printing upload progress.
2558
2559 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2560
2561 =item pass - Password for the username above.
2562
2563 =item port - FTP server port number, which defaults to 21 if not set.
2564
2565 =cut
2566 sub ftp_upload
2567 {
2568 my ($buf, @n);
2569 my $cbfunc = $_[4];
2570 if (&is_readonly_mode()) {
2571         if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2572                      return 0; }
2573         else { &error("FTP connections not allowed in readonly mode"); }
2574         }
2575
2576 $main::download_timed_out = undef;
2577 local $SIG{ALRM} = \&download_timeout;
2578 alarm(60);
2579
2580 # connect to host and login
2581 &open_socket($_[0], $_[7] || 21, "SOCK", $_[3]) || return 0;
2582 alarm(0);
2583 if ($main::download_timed_out) {
2584         if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2585         else { &error($main::download_timed_out); }
2586         }
2587 &ftp_command("", 2, $_[3]) || return 0;
2588 if ($_[5]) {
2589         # Login as supplied user
2590         my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2591         @urv || return 0;
2592         if (int($urv[1]/100) == 3) {
2593                 &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2594                 }
2595         }
2596 else {
2597         # Login as anonymous
2598         my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2599         @urv || return 0;
2600         if (int($urv[1]/100) == 3) {
2601                 &ftp_command("PASS root\@".&get_system_hostname(), 2,
2602                              $_[3]) || return 0;
2603                 }
2604         }
2605 &$cbfunc(1, 0) if ($cbfunc);
2606
2607 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2608
2609 # get the file size and tell the callback
2610 my @st = stat($_[2]);
2611 if ($cbfunc) {
2612         &$cbfunc(2, $st[7]);
2613         }
2614
2615 # send the file
2616 my $pasv = &ftp_command("PASV", 2, $_[3]);
2617 defined($pasv) || return 0;
2618 $pasv =~ /\(([0-9,]+)\)/;
2619 @n = split(/,/ , $1);
2620 &open_socket("$n[0].$n[1].$n[2].$n[3]", $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2621 &ftp_command("STOR $_[1]", 1, $_[3]) || return 0;
2622
2623 # transfer data
2624 my $got;
2625 open(PFILE, $_[2]);
2626 while(read(PFILE, $buf, 1024) > 0) {
2627         print CON $buf;
2628         $got += length($buf);
2629         &$cbfunc(3, $got) if ($cbfunc);
2630         }
2631 close(PFILE);
2632 close(CON);
2633 if ($got != $st[7]) {
2634         if ($_[3]) { ${$_[3]} = "Upload incomplete"; return 0; }
2635         else { &error("Upload incomplete"); }
2636         }
2637 &$cbfunc(4) if ($cbfunc);
2638
2639 # finish off..
2640 &ftp_command("", 2, $_[3]) || return 0;
2641 &ftp_command("QUIT", 2, $_[3]) || return 0;
2642 close(SOCK);
2643
2644 return 1;
2645 }
2646
2647 =head2 no_proxy(host)
2648
2649 Checks if some host is on the no proxy list. For internal use by the
2650 http_download and ftp_download functions.
2651
2652 =cut
2653 sub no_proxy
2654 {
2655 my $ip = &to_ipaddress($_[0]);
2656 foreach my $n (split(/\s+/, $gconfig{'noproxy'})) {
2657         return 1 if ($_[0] =~ /\Q$n\E/ ||
2658                      $ip =~ /\Q$n\E/);
2659         }
2660 return 0;
2661 }
2662
2663 =head2 open_socket(host, port, handle, [&error])
2664
2665 Open a TCP connection to some host and port, using a file handle. The
2666 parameters are :
2667
2668 =item host - Hostname or IP address to connect to.
2669
2670 =item port - TCP port number.
2671
2672 =item handle - A file handle name to use for the connection.
2673
2674 =item error - A string reference to write any error message into. If not set, the error function is called on failure.
2675
2676 =cut
2677 sub open_socket
2678 {
2679 my ($host, $port, $fh, $err) = @_;
2680 $fh = &callers_package($fh);
2681
2682 if ($gconfig{'debug_what_net'}) {
2683         &webmin_debug_log('TCP', "host=$host port=$port");
2684         }
2685
2686 # Lookup IP address for the host. Try v4 first, and failing that v6
2687 my $ip;
2688 my $proto = getprotobyname("tcp");
2689 if ($ip = &to_ipaddress($host)) {
2690         # Create IPv4 socket and connection
2691         if (!socket($fh, PF_INET(), SOCK_STREAM, $proto)) {
2692                 my $msg = "Failed to create socket : $!";
2693                 if ($err) { $$err = $msg; return 0; }
2694                 else { &error($msg); }
2695                 }
2696         my $addr = inet_aton($ip);
2697         if ($gconfig{'bind_proxy'}) {
2698                 # BIND to outgoing IP
2699                 if (!bind($fh,pack_sockaddr_in(0, inet_aton($gconfig{'bind_proxy'})))) {
2700                         my $msg = "Failed to bind to source address : $!";
2701                         if ($err) { $$err = $msg; return 0; }
2702                         else { &error($msg); }
2703                         }
2704                 }
2705         if (!connect($fh, pack_sockaddr_in($port, $addr))) {
2706                 my $msg = "Failed to connect to $host:$port : $!";
2707                 if ($err) { $$err = $msg; return 0; }
2708                 else { &error($msg); }
2709                 }
2710         }
2711 elsif ($ip = &to_ip6address($host)) {
2712         # Create IPv6 socket and connection
2713         if (!&supports_ipv6()) {
2714                 $msg = "IPv6 connections are not supported";
2715                 if ($err) { $$err = $msg; return 0; }
2716                 else { &error($msg); }
2717                 }
2718         if (!socket($fh, Socket6::PF_INET6(), SOCK_STREAM, $proto)) {
2719                 my $msg = "Failed to create IPv6 socket : $!";
2720                 if ($err) { $$err = $msg; return 0; }
2721                 else { &error($msg); }
2722                 }
2723         my $addr = inet_pton(Socket6::AF_INET6(), $ip);
2724         if (!connect($fh, pack_sockaddr_in6($port, $addr))) {
2725                 my $msg = "Failed to IPv6 connect to $host:$port : $!";
2726                 if ($err) { $$err = $msg; return 0; }
2727                 else { &error($msg); }
2728                 }
2729         }
2730 else {
2731         # Resolution failed
2732         my $msg = "Failed to lookup IP address for $host";
2733         if ($err) { $$err = $msg; return 0; }
2734         else { &error($msg); }
2735         }
2736
2737 # Disable buffering
2738 my $old = select($fh);
2739 $| = 1;
2740 select($old);
2741 return 1;
2742 }
2743
2744 =head2 download_timeout
2745
2746 Called when a download times out. For internal use only.
2747
2748 =cut
2749 sub download_timeout
2750 {
2751 $main::download_timed_out = "Download timed out";
2752 }
2753
2754 =head2 ftp_command(command, expected, [&error], [filehandle])
2755
2756 Send an FTP command, and die if the reply is not what was expected. Mainly
2757 for internal use by the ftp_download and ftp_upload functions.
2758
2759 =cut
2760 sub ftp_command
2761 {
2762 my ($cmd, $expect, $err, $fh) = @_;
2763 $fh ||= "SOCK";
2764 $fh = &callers_package($fh);
2765
2766 my $line;
2767 my $what = $cmd ne "" ? "<i>$cmd</i>" : "initial connection";
2768 if ($cmd ne "") {
2769         print $fh "$cmd\r\n";
2770         }
2771 alarm(60);
2772 if (!($line = <$fh>)) {
2773         alarm(0);
2774         if ($err) { $$err = "Failed to read reply to $what"; return undef; }
2775         else { &error("Failed to read reply to $what"); }
2776         }
2777 $line =~ /^(...)(.)(.*)$/;
2778 my $found = 0;
2779 if (ref($expect)) {
2780         foreach my $c (@$expect) {
2781                 $found++ if (int($1/100) == $c);
2782                 }
2783         }
2784 else {
2785         $found++ if (int($1/100) == $_[1]);
2786         }
2787 if (!$found) {
2788         alarm(0);
2789         if ($err) { $$err = "$what failed : $3"; return undef; }
2790         else { &error("$what failed : $3"); }
2791         }
2792 my $rcode = $1;
2793 my $reply = $3;
2794 if ($2 eq "-") {
2795         # Need to skip extra stuff..
2796         while(1) {
2797                 if (!($line = <$fh>)) {
2798                         alarm(0);
2799                         if ($$err) { $$err = "Failed to read reply to $what";
2800                                      return undef; }
2801                         else { &error("Failed to read reply to $what"); }
2802                         }
2803                 $line =~ /^(....)(.*)$/; $reply .= $2;
2804                 if ($1 eq "$rcode ") { last; }
2805                 }
2806         }
2807 alarm(0);
2808 return wantarray ? ($reply, $rcode) : $reply;
2809 }
2810
2811 =head2 to_ipaddress(hostname)
2812
2813 Converts a hostname to an a.b.c.d format IP address, or returns undef if
2814 it cannot be resolved.
2815
2816 =cut
2817 sub to_ipaddress
2818 {
2819 if (&check_ipaddress($_[0])) {
2820         return $_[0];   # Already in v4 format
2821         }
2822 elsif (&check_ip6address($_[0])) {
2823         return undef;   # A v6 address cannot be converted to v4
2824         }
2825 else {
2826         my $hn = gethostbyname($_[0]);
2827         return undef if (!$hn);
2828         local @ip = unpack("CCCC", $hn);
2829         return join("." , @ip);
2830         }
2831 }
2832
2833 =head2 to_ip6address(hostname)
2834
2835 Converts a hostname to IPv6 address, or returns undef if it cannot be resolved.
2836
2837 =cut
2838 sub to_ip6address
2839 {
2840 if (&check_ip6address($_[0])) {
2841         return $_[0];   # Already in v6 format
2842         }
2843 elsif (&check_ipaddress($_[0])) {
2844         return undef;   # A v4 address cannot be v6
2845         }
2846 elsif (!&supports_ipv6()) {
2847         return undef;   # Cannot lookup
2848         }
2849 else {
2850         # Perform IPv6 DNS lookup
2851         my $inaddr;
2852         (undef, undef, undef, $inaddr) =
2853             getaddrinfo($_[0], undef, Socket6::AF_INET6(), SOCK_STREAM);
2854         return undef if (!$inaddr);
2855         my $addr;
2856         (undef, $addr) = unpack_sockaddr_in6($inaddr);
2857         return inet_ntop(Socket6::AF_INET6(), $addr);
2858         }
2859 }
2860
2861 =head2 to_hostname(ipv4|ipv6-address)
2862
2863 Reverse-resolves an IPv4 or 6 address to a hostname
2864
2865 =cut
2866 sub to_hostname
2867 {
2868 my ($addr) = @_;
2869 if (&check_ip6address($addr) && &supports_ipv6()) {
2870         return gethostbyaddr(inet_pton(Socket6::AF_INET6(), $addr),
2871                              Socket6::AF_INET6());
2872         }
2873 else {
2874         return gethostbyaddr(inet_aton($addr), AF_INET);
2875         }
2876 }
2877
2878 =head2 icons_table(&links, &titles, &icons, [columns], [href], [width], [height], &befores, &afters)
2879
2880 Renders a 4-column table of icons. The useful parameters are :
2881
2882 =item links - An array ref of link destination URLs for the icons.
2883
2884 =item titles - An array ref of titles to appear under the icons.
2885
2886 =item icons - An array ref of URLs for icon images.
2887
2888 =item columns - Number of columns to layout the icons with. Defaults to 4.
2889
2890 =cut
2891 sub icons_table
2892 {
2893 &load_theme_library();
2894 if (defined(&theme_icons_table)) {
2895         &theme_icons_table(@_);
2896         return;
2897         }
2898 my $need_tr;
2899 my $cols = $_[3] ? $_[3] : 4;
2900 my $per = int(100.0 / $cols);
2901 print "<table class='icons_table' width=100% cellpadding=5>\n";
2902 for(my $i=0; $i<@{$_[0]}; $i++) {
2903         if ($i%$cols == 0) { print "<tr>\n"; }
2904         print "<td width=$per% align=center valign=top>\n";
2905         &generate_icon($_[2]->[$i], $_[1]->[$i], $_[0]->[$i],
2906                        ref($_[4]) ? $_[4]->[$i] : $_[4], $_[5], $_[6],
2907                        $_[7]->[$i], $_[8]->[$i]);
2908         print "</td>\n";
2909         if ($i%$cols == $cols-1) { print "</tr>\n"; }
2910         }
2911 while($i++%$cols) { print "<td width=$per%></td>\n"; $need_tr++; }
2912 print "</tr>\n" if ($need_tr);
2913 print "</table>\n";
2914 }
2915
2916 =head2 replace_file_line(file, line, [newline]*)
2917
2918 Replaces one line in some file with 0 or more new lines. The parameters are :
2919
2920 =item file - Full path to some file, like /etc/hosts.
2921
2922 =item line - Line number to replace, starting from 0.
2923
2924 =item newline - Zero or more lines to put into the file at the given line number. These must be newline-terminated strings.
2925
2926 =cut
2927 sub replace_file_line
2928 {
2929 my @lines;
2930 my $realfile = &translate_filename($_[0]);
2931 open(FILE, $realfile);
2932 @lines = <FILE>;
2933 close(FILE);
2934 if (@_ > 2) { splice(@lines, $_[1], 1, @_[2..$#_]); }
2935 else { splice(@lines, $_[1], 1); }
2936 &open_tempfile(FILE, ">$realfile");
2937 &print_tempfile(FILE, @lines);
2938 &close_tempfile(FILE);
2939 }
2940
2941 =head2 read_file_lines(file, [readonly])
2942
2943 Returns a reference to an array containing the lines from some file. This
2944 array can be modified, and will be written out when flush_file_lines()
2945 is called. The parameters are :
2946
2947 =item file - Full path to the file to read.
2948
2949 =item readonly - Should be set 1 if the caller is only going to read the lines, and never write it out.
2950
2951 Example code :
2952
2953  $lref = read_file_lines("/etc/hosts");
2954  push(@$lref, "127.0.0.1 localhost");
2955  flush_file_lines("/etc/hosts");
2956
2957 =cut
2958 sub read_file_lines
2959 {
2960 if (!$_[0]) {
2961         my ($package, $filename, $line) = caller;
2962         print STDERR "Missing file to read at ${package}::${filename} line $line\n";
2963         }
2964 my $realfile = &translate_filename($_[0]);
2965 if (!$main::file_cache{$realfile}) {
2966         my (@lines, $eol);
2967         local $_;
2968         &webmin_debug_log('READ', $_[0]) if ($gconfig{'debug_what_read'});
2969         open(READFILE, $realfile);
2970         while(<READFILE>) {
2971                 if (!$eol) {
2972                         $eol = /\r\n$/ ? "\r\n" : "\n";
2973                         }
2974                 tr/\r\n//d;
2975                 push(@lines, $_);
2976                 }
2977         close(READFILE);
2978         $main::file_cache{$realfile} = \@lines;
2979         $main::file_cache_noflush{$realfile} = $_[1];
2980         $main::file_cache_eol{$realfile} = $eol || "\n";
2981         }
2982 else {
2983         # Make read-write if currently readonly
2984         if (!$_[1]) {
2985                 $main::file_cache_noflush{$realfile} = 0;
2986                 }
2987         }
2988 return $main::file_cache{$realfile};
2989 }
2990
2991 =head2 flush_file_lines([file], [eol])
2992
2993 Write out to a file previously read by read_file_lines to disk (except
2994 for those marked readonly). The parameters are :
2995
2996 =item file - The file to flush out.
2997
2998 =item eof - End-of-line character for each line. Defaults to \n.
2999
3000 =cut
3001 sub flush_file_lines
3002 {
3003 my @files;
3004 if ($_[0]) {
3005         local $trans = &translate_filename($_[0]);
3006         $main::file_cache{$trans} ||
3007                 &error("flush_file_lines called on non-loaded file $trans");
3008         push(@files, $trans);
3009         }
3010 else {
3011         @files = ( keys %main::file_cache );
3012         }
3013 foreach my $f (@files) {
3014         my $eol = $_[1] || $main::file_cache_eol{$f} || "\n";
3015         if (!$main::file_cache_noflush{$f}) {
3016                 no warnings; # XXX Bareword file handles should go away
3017                 &open_tempfile(FLUSHFILE, ">$f");
3018                 foreach my $line (@{$main::file_cache{$f}}) {
3019                         (print FLUSHFILE $line,$eol) ||
3020                                 &error(&text("efilewrite", $f, $!));
3021                         }
3022                 &close_tempfile(FLUSHFILE);
3023                 }
3024         delete($main::file_cache{$f});
3025         delete($main::file_cache_noflush{$f});
3026         }
3027 }
3028
3029 =head2 unflush_file_lines(file)
3030
3031 Clear the internal cache of some given file, previously read by read_file_lines.
3032
3033 =cut
3034 sub unflush_file_lines
3035 {
3036 my $realfile = &translate_filename($_[0]);
3037 delete($main::file_cache{$realfile});
3038 delete($main::file_cache_noflush{$realfile});
3039 }
3040
3041 =head2 unix_user_input(fieldname, user, [form])
3042
3043 Returns HTML for an input to select a Unix user. By default this is a text
3044 box with a user popup button next to it.
3045
3046 =cut
3047 sub unix_user_input
3048 {
3049 if (defined(&theme_unix_user_input)) {
3050         return &theme_unix_user_input(@_);
3051         }
3052 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
3053        &user_chooser_button($_[0], 0, $_[2] || 0)."\n";
3054 }
3055
3056 =head2 unix_group_input(fieldname, user, [form])
3057
3058 Returns HTML for an input to select a Unix group. By default this is a text
3059 box with a group popup button next to it.
3060
3061 =cut
3062 sub unix_group_input
3063 {
3064 if (defined(&theme_unix_group_input)) {
3065         return &theme_unix_group_input(@_);
3066         }
3067 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
3068        &group_chooser_button($_[0], 0, $_[2] || 0)."\n";
3069 }
3070
3071 =head2 hlink(text, page, [module], [width], [height])
3072
3073 Returns HTML for a link that when clicked on pops up a window for a Webmin
3074 help page. The parameters are :
3075
3076 =item text - Text for the link.
3077
3078 =item page - Help page code, such as 'intro'.
3079
3080 =item module - Module the help page is in. Defaults to the current module.
3081
3082 =item width - Width of the help popup window. Defaults to 600 pixels.
3083
3084 =item height - Height of the help popup window. Defaults to 400 pixels.
3085
3086 The actual help pages are in each module's help sub-directory, in files with
3087 .html extensions.
3088
3089 =cut
3090 sub hlink
3091 {
3092 if (defined(&theme_hlink)) {
3093         return &theme_hlink(@_);
3094         }
3095 my $mod = $_[2] ? $_[2] : &get_module_name();
3096 my $width = $_[3] || $tconfig{'help_width'} || $gconfig{'help_width'} || 600;
3097 my $height = $_[4] || $tconfig{'help_height'} || $gconfig{'help_height'} || 400;
3098 return "<a onClick='window.open(\"$gconfig{'webprefix'}/help.cgi/$mod/$_[1]\", \"help\", \"toolbar=no,menubar=no,scrollbars=yes,width=$width,height=$height,resizable=yes\"); return false' href=\"$gconfig{'webprefix'}/help.cgi/$mod/$_[1]\">$_[0]</a>";
3099 }
3100
3101 =head2 user_chooser_button(field, multiple, [form])
3102
3103 Returns HTML for a javascript button for choosing a Unix user or users.
3104 The parameters are :
3105
3106 =item field - Name of the HTML field to place the username into.
3107
3108 =item multiple - Set to 1 if multiple users can be selected.
3109
3110 =item form - Index of the form on the page.
3111
3112 =cut
3113 sub user_chooser_button
3114 {
3115 return undef if (!&supports_users());
3116 return &theme_user_chooser_button(@_)
3117         if (defined(&theme_user_chooser_button));
3118 my $form = defined($_[2]) ? $_[2] : 0;
3119 my $w = $_[1] ? 500 : 300;
3120 my $h = 200;
3121 if ($_[1] && $gconfig{'db_sizeusers'}) {
3122         ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
3123         }
3124 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
3125         ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
3126         }
3127 return "<input type=button onClick='ifield = form.$_[0]; chooser = window.open(\"$gconfig{'webprefix'}/user_chooser.cgi?multi=$_[1]&user=\"+escape(ifield.value), \"chooser\", \"toolbar=no,menubar=no,scrollbars=yes,resizable=yes,width=$w,height=$h\"); chooser.ifield = ifield; window.ifield = ifield' value=\"...\">\n";
3128 }
3129
3130 =head2 group_chooser_button(field, multiple, [form])
3131
3132 Returns HTML for a javascript button for choosing a Unix group or groups
3133 The parameters are :
3134
3135 =item field - Name of the HTML field to place the group name into.
3136
3137 =item multiple - Set to 1 if multiple groups can be selected.
3138
3139 =item form - Index of the form on the page.
3140
3141 =cut
3142 sub group_chooser_button
3143 {
3144 return undef if (!&supports_users());
3145 return &theme_group_chooser_button(@_)
3146         if (defined(&theme_group_chooser_button));
3147 my $form = defined($_[2]) ? $_[2] : 0;
3148 my $w = $_[1] ? 500 : 300;
3149 my $h = 200;
3150 if ($_[1] && $gconfig{'db_sizeusers'}) {
3151         ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
3152         }
3153 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
3154         ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
3155         }
3156 return "<input type=button onClick='ifield = form.$_[0]; chooser = window.open(\"$gconfig{'webprefix'}/group_chooser.cgi?multi=$_[1]&group=\"+escape(ifield.value), \"chooser\", \"toolbar=no,menubar=no,scrollbars=yes,resizable=yes,width=$w,height=$h\"); chooser.ifield = ifield; window.ifield = ifield' value=\"...\">\n";
3157 }
3158
3159 =head2 foreign_check(module, [api-only])
3160
3161 Checks if some other module exists and is supported on this OS. The parameters
3162 are :
3163
3164 =item module - Name of the module to check.
3165
3166 =item api-only - Set to 1 if you just want to check if the module provides an API that others can call, instead of the full web UI.
3167
3168 =cut
3169 sub foreign_check
3170 {
3171 my ($mod, $api) = @_;
3172 my %minfo;
3173 my $mdir = &module_root_directory($mod);
3174 &read_file_cached("$mdir/module.info", \%minfo) || return 0;
3175 return &check_os_support(\%minfo, undef, undef, $api);
3176 }
3177
3178 =head2 foreign_exists(module)
3179
3180 Checks if some other module exists. The module parameter is the short module
3181 name.
3182
3183 =cut
3184 sub foreign_exists
3185 {
3186 my $mdir = &module_root_directory($_[0]);
3187 return -r "$mdir/module.info";
3188 }
3189
3190 =head2 foreign_available(module)
3191
3192 Returns 1 if some module is installed, and acessible to the current user. The
3193 module parameter is the module directory name.
3194
3195 =cut
3196 sub foreign_available
3197 {
3198 return 0 if (!&foreign_check($_[0]) &&
3199              !$gconfig{'available_even_if_no_support'});
3200 my %foreign_module_info = &get_module_info($_[0]);
3201
3202 # Check list of allowed modules
3203 my %acl;
3204 &read_acl(\%acl, undef, [ $base_remote_user ]);
3205 return 0 if (!$acl{$base_remote_user,$_[0]} &&
3206              !$acl{$base_remote_user,'*'});
3207
3208 # Check for usermod restrictions
3209 my @usermods = &list_usermods();
3210 return 0 if (!&available_usermods( [ \%foreign_module_info ], \@usermods));
3211
3212 if (&get_product_name() eq "webmin") {
3213         # Check if the user has any RBAC privileges in this module
3214         if (&supports_rbac($_[0]) &&
3215             &use_rbac_module_acl(undef, $_[0])) {
3216                 # RBAC is enabled for this user and module - check if he
3217                 # has any rights
3218                 my $rbacs = &get_rbac_module_acl($remote_user, $_[0]);
3219                 return 0 if (!$rbacs);
3220                 }
3221         elsif ($gconfig{'rbacdeny_'.$base_remote_user}) {
3222                 # If denying access to modules not specifically allowed by
3223                 # RBAC, then prevent access
3224                 return 0;
3225                 }
3226         }
3227
3228 # Check readonly support
3229 if (&is_readonly_mode()) {
3230         return 0 if (!$foreign_module_info{'readonly'});
3231         }
3232
3233 # Check if theme vetos
3234 if (defined(&theme_foreign_available)) {
3235         return 0 if (!&theme_foreign_available($_[0]));
3236         }
3237
3238 # Check if licence module vetos
3239 if ($main::licence_module) {
3240         return 0 if (!&foreign_call($main::licence_module,
3241                                     "check_module_licence", $_[0]));
3242         }
3243
3244 return 1;
3245 }
3246
3247 =head2 foreign_require(module, [file], [package])
3248
3249 Brings in functions from another module, and places them in the Perl namespace
3250 with the same name as the module. The parameters are :
3251
3252 =item module - The source module's directory name, like sendmail.
3253
3254 =item file - The API file in that module, like sendmail-lib.pl. If missing, all API files are loaded.
3255
3256 =item package - Perl package to place the module's functions and global variables in.
3257
3258 If the original module name contains dashes, they will be replaced with _ in
3259 the package name.
3260
3261 =cut
3262 sub foreign_require
3263 {
3264 my ($mod, $file, $pkg) = @_;
3265 $pkg ||= $mod || "global";
3266 $pkg =~ s/[^A-Za-z0-9]/_/g;
3267 my @files;
3268 if ($file) {
3269         push(@files, $file);
3270         }
3271 else {
3272         # Auto-detect files
3273         my %minfo = &get_module_info($mod);
3274         if ($minfo{'library'}) {
3275                 @files = split(/\s+/, $minfo{'library'});
3276                 }
3277         else {
3278                 @files = ( $mod."-lib.pl" );
3279                 }
3280         }
3281 @files = grep { !$main::done_foreign_require{$pkg,$_} } @files;
3282 return 1 if (!@files);
3283 foreach my $f (@files) {
3284         $main::done_foreign_require{$pkg,$f}++;
3285         }
3286 my @OLDINC = @INC;
3287 my $mdir = &module_root_directory($mod);
3288 @INC = &unique($mdir, @INC);
3289 -d $mdir || &error("Module $mod does not exist");
3290 if (!&get_module_name() && $mod) {
3291         chdir($mdir);
3292         }
3293 my $old_fmn = $ENV{'FOREIGN_MODULE_NAME'};
3294 my $old_frd = $ENV{'FOREIGN_ROOT_DIRECTORY'};
3295 my $code = "package $pkg; ".
3296            "\$ENV{'FOREIGN_MODULE_NAME'} = '$mod'; ".
3297            "\$ENV{'FOREIGN_ROOT_DIRECTORY'} = '$root_directory'; ";
3298 foreach my $f (@files) {
3299         $code .= "do '$mdir/$f' || die \$@; ";
3300         }
3301 eval $code;
3302 if (defined($old_fmn)) {
3303         $ENV{'FOREIGN_MODULE_NAME'} = $old_fmn;
3304         }
3305 else {
3306         delete($ENV{'FOREIGN_MODULE_NAME'});
3307         }
3308 if (defined($old_frd)) {
3309         $ENV{'FOREIGN_ROOT_DIRECTORY'} = $old_frd;
3310         }
3311 else {
3312         delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
3313         }
3314 @INC = @OLDINC;
3315 if ($@) { &error("Require $mod/$files[0] failed : <pre>$@</pre>"); }
3316 return 1;
3317 }
3318
3319 =head2 foreign_call(module, function, [arg]*)
3320
3321 Call a function in another module. The module parameter is the target module
3322 directory name, function is the perl sub to call, and the remaining parameters
3323 are the arguments. However, unless you need to call a function whose name
3324 is dynamic, it is better to use Perl's cross-module function call syntax
3325 like module::function(args).
3326
3327 =cut
3328 sub foreign_call
3329 {
3330 my $pkg = $_[0] || "global";
3331 $pkg =~ s/[^A-Za-z0-9]/_/g;
3332 my @args = @_[2 .. @_-1];
3333 $main::foreign_args = \@args;
3334 my @rv = eval <<EOF;
3335 package $pkg;
3336 &$_[1](\@{\$main::foreign_args});
3337 EOF
3338 if ($@) { &error("$_[0]::$_[1] failed : $@"); }
3339 return wantarray ? @rv : $rv[0];
3340 }
3341
3342 =head2 foreign_config(module, [user-config])
3343
3344 Get the configuration from another module, and return it as a hash. If the
3345 user-config parameter is set to 1, returns the Usermin user-level preferences
3346 for the current user instead.
3347
3348 =cut
3349 sub foreign_config
3350 {
3351 my ($mod, $uc) = @_;
3352 my %fconfig;
3353 if ($uc) {
3354         &read_file_cached("$root_directory/$mod/defaultuconfig", \%fconfig);
3355         &read_file_cached("$config_directory/$mod/uconfig", \%fconfig);
3356         &read_file_cached("$user_config_directory/$mod/config", \%fconfig);
3357         }
3358 else {
3359         &read_file_cached("$config_directory/$mod/config", \%fconfig);
3360         }
3361 return %fconfig;
3362 }
3363
3364 =head2 foreign_installed(module, mode)
3365
3366 Checks if the server for some module is installed, and possibly also checks
3367 if the module has been configured by Webmin.
3368 For mode 1, returns 2 if the server is installed and configured for use by
3369 Webmin, 1 if installed but not configured, or 0 otherwise.
3370 For mode 0, returns 1 if installed, 0 if not.
3371 If the module does not provide an install_check.pl script, assumes that
3372 the server is installed.
3373
3374 =cut
3375 sub foreign_installed
3376 {
3377 my ($mod, $configured) = @_;
3378 if (defined($main::foreign_installed_cache{$mod,$configured})) {
3379         # Already cached..
3380         return $main::foreign_installed_cache{$mod,$configured};
3381         }
3382 else {
3383         my $rv;
3384         if (!&foreign_check($mod)) {
3385                 # Module is missing
3386                 $rv = 0;
3387                 }
3388         else {
3389                 my $mdir = &module_root_directory($mod);
3390                 if (!-r "$mdir/install_check.pl") {
3391                         # Not known, assume OK
3392                         $rv = $configured ? 2 : 1;
3393                         }
3394                 else {
3395                         # Call function to check
3396                         &foreign_require($mod, "install_check.pl");
3397                         $rv = &foreign_call($mod, "is_installed", $configured);
3398                         }
3399                 }
3400         $main::foreign_installed_cache{$mod,$configured} = $rv;
3401         return $rv;
3402         }
3403 }
3404
3405 =head2 foreign_defined(module, function)
3406
3407 Returns 1 if some function is defined in another module. In general, it is
3408 simpler to use the syntax &defined(module::function) instead.
3409
3410 =cut
3411 sub foreign_defined
3412 {
3413 my ($pkg) = @_;
3414 $pkg =~ s/[^A-Za-z0-9]/_/g;
3415 my $func = "${pkg}::$_[1]";
3416 return defined(&$func);
3417 }
3418
3419 =head2 get_system_hostname([short], [skip-file])
3420
3421 Returns the hostname of this system. If the short parameter is set to 1,
3422 then the domain name is not prepended - otherwise, Webmin will attempt to get
3423 the fully qualified hostname, like foo.example.com.
3424
3425 =cut
3426 sub get_system_hostname
3427 {
3428 my $m = int($_[0]);
3429 my $skipfile = $_[1];
3430 if (!$main::get_system_hostname[$m]) {
3431         if ($gconfig{'os_type'} ne 'windows') {
3432                 # Try some common Linux hostname files first
3433                 my $fromfile;
3434                 if ($skipfile) {
3435                         # Never get from file
3436                         }
3437                 elsif ($gconfig{'os_type'} eq 'redhat-linux') {
3438                         my %nc;
3439                         &read_env_file("/etc/sysconfig/network", \%nc);
3440                         if ($nc{'HOSTNAME'}) {
3441                                 $fromfile = $nc{'HOSTNAME'};
3442                                 }
3443                         }
3444                 elsif ($gconfig{'os_type'} eq 'debian-linux') {
3445                         my $hn = &read_file_contents("/etc/hostname");
3446                         if ($hn) {
3447                                 $hn =~ s/\r|\n//g;
3448                                 $fromfile = $hn;
3449                                 }
3450                         }
3451                 elsif ($gconfig{'os_type'} eq 'open-linux') {
3452                         my $hn = &read_file_contents("/etc/HOSTNAME");
3453                         if ($hn) {
3454                                 $hn =~ s/\r|\n//g;
3455                                 $fromfile = $hn;
3456                                 }
3457                         }
3458                 elsif ($gconfig{'os_type'} eq 'solaris') {
3459                         my $hn = &read_file_contents("/etc/nodename");
3460                         if ($hn) {
3461                                 $hn =~ s/\r|\n//g;
3462                                 $fromfile = $hn;
3463                                 }
3464                         }
3465
3466                 # If we found a hostname in a file, use it
3467                 if ($fromfile && ($m || $fromfile =~ /\./)) {
3468                         if ($m) {
3469                                 $fromfile =~ s/\..*$//;
3470                                 }
3471                         $main::get_system_hostname[$m] = $fromfile;
3472                         return $fromfile;
3473                         }
3474
3475                 # Can use hostname command on Unix
3476                 &execute_command("hostname", undef,
3477                                  \$main::get_system_hostname[$m], undef, 0, 1);
3478                 chop($main::get_system_hostname[$m]);
3479                 if ($?) {
3480                         eval "use Sys::Hostname";
3481                         if (!$@) {
3482                                 $main::get_system_hostname[$m] = eval "hostname()";
3483                                 }
3484                         if ($@ || !$main::get_system_hostname[$m]) {
3485                                 $main::get_system_hostname[$m] = "UNKNOWN";
3486                                 }
3487                         }
3488                 elsif ($main::get_system_hostname[$m] !~ /\./ &&
3489                        $gconfig{'os_type'} =~ /linux$/ &&
3490                        !$gconfig{'no_hostname_f'} && !$_[0]) {
3491                         # Try with -f flag to get fully qualified name
3492                         my $flag;
3493                         my $ex = &execute_command("hostname -f", undef, \$flag,
3494                                                   undef, 0, 1);
3495                         chop($flag);
3496                         if ($ex || $flag eq "") {
3497                                 # -f not supported! We have probably set the
3498                                 # hostname to just '-f'. Fix the problem
3499                                 # (if we are root)
3500                                 if ($< == 0) {
3501                                         &execute_command("hostname ".
3502                                                 quotemeta($main::get_system_hostname[$m]),
3503                                                 undef, undef, undef, 0, 1);
3504                                         }
3505                                 }
3506                         else {
3507                                 $main::get_system_hostname[$m] = $flag;
3508                                 }
3509                         }
3510                 }
3511         else {
3512                 # On Windows, try computername environment variable
3513                 return $ENV{'computername'} if ($ENV{'computername'});
3514                 return $ENV{'COMPUTERNAME'} if ($ENV{'COMPUTERNAME'});
3515
3516                 # Fall back to net name command
3517                 my $out = `net name 2>&1`;
3518                 if ($out =~ /\-+\r?\n(\S+)/) {
3519                         $main::get_system_hostname[$m] = $1;
3520                         }
3521                 else {
3522                         $main::get_system_hostname[$m] = "windows";
3523                         }
3524                 }
3525         }
3526 return $main::get_system_hostname[$m];
3527 }
3528
3529 =head2 get_webmin_version
3530
3531 Returns the version of Webmin currently being run, such as 1.450.
3532
3533 =cut
3534 sub get_webmin_version
3535 {
3536 if (!$get_webmin_version) {
3537         open(VERSION, "$root_directory/version") || return 0;
3538         ($get_webmin_version = <VERSION>) =~ tr/\r|\n//d;
3539         close(VERSION);
3540         }
3541 return $get_webmin_version;
3542 }
3543
3544 =head2 get_module_acl([user], [module], [no-rbac], [no-default])
3545
3546 Returns a hash containing access control options for the given user and module.
3547 By default the current username and module name are used. If the no-rbac flag
3548 is given, the permissions will not be updated based on the user's RBAC role
3549 (as seen on Solaris). If the no-default flag is given, default permissions for
3550 the module will not be included.
3551
3552 =cut
3553 sub get_module_acl
3554 {
3555 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
3556 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3557 my $mdir = &module_root_directory($m);
3558 my %rv;
3559 if (!$_[3]) {
3560         # Read default ACL first, to be overridden by per-user settings
3561         &read_file_cached("$mdir/defaultacl", \%rv);
3562
3563         # If this isn't a master admin user, apply the negative permissions
3564         # so that he doesn't un-expectedly gain access to new features
3565         my %gacccess;
3566         &read_file_cached("$config_directory/$u.acl", \%gaccess);
3567         if ($gaccess{'negative'}) {
3568                 &read_file_cached("$mdir/negativeacl", \%rv);
3569                 }
3570         }
3571 my %usersacl;
3572 if (!$_[2] && &supports_rbac($m) && &use_rbac_module_acl($u, $m)) {
3573         # RBAC overrides exist for this user in this module
3574         my $rbac = &get_rbac_module_acl(
3575                         defined($_[0]) ? $_[0] : $remote_user, $m);
3576         foreach my $r (keys %$rbac) {
3577                 $rv{$r} = $rbac->{$r};
3578                 }
3579         }
3580 elsif ($gconfig{"risk_$u"} && $m) {
3581         # ACL is defined by user's risk level
3582         my $rf = $gconfig{"risk_$u"}.'.risk';
3583         &read_file_cached("$mdir/$rf", \%rv);
3584
3585         my $sf = $gconfig{"skill_$u"}.'.skill';
3586         &read_file_cached("$mdir/$sf", \%rv);
3587         }
3588 elsif ($u ne '') {
3589         # Use normal Webmin ACL, if a user is set
3590         my $userdb = &get_userdb_string();
3591         my $foundindb = 0;
3592         if ($userdb && ($u ne $base_remote_user || $remote_user_proto)) {
3593                 # Look for this user in the user/group DB, if one is defined
3594                 # and if the user might be in the DB
3595                 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3596                 ref($dbh) || &error(&text('euserdbacl', $dbh));
3597                 if ($proto eq "mysql" || $proto eq "postgresql") {
3598                         # Find the user in the SQL DB
3599                         my $cmd = $dbh->prepare(
3600                                 "select id from webmin_user where name = ?");
3601                         $cmd && $cmd->execute($u) ||
3602                                 &error(&text('euserdbacl', $dbh->errstr));
3603                         my ($id) = $cmd->fetchrow();
3604                         $foundindb = 1 if (defined($id));
3605                         $cmd->finish();
3606
3607                         # Fetch ACLs with SQL
3608                         if ($foundindb) {
3609                                 my $cmd = $dbh->prepare(
3610                                     "select attr,value from webmin_user_acl ".
3611                                     "where id = ? and module = ?");
3612                                 $cmd && $cmd->execute($id, $m) ||
3613                                     &error(&text('euserdbacl', $dbh->errstr));
3614                                 while(my ($a, $v) = $cmd->fetchrow()) {
3615                                         $rv{$a} = $v;
3616                                         }
3617                                 $cmd->finish();
3618                                 }
3619                         }
3620                 elsif ($proto eq "ldap") {
3621                         # Find user in LDAP
3622                         my $rv = $dbh->search(
3623                                 base => $prefix,
3624                                 filter => '(&(cn='.$u.')(objectClass='.
3625                                           $args->{'userclass'}.'))',
3626                                 scope => 'sub');
3627                         if (!$rv || $rv->code) {
3628                                 &error(&text('euserdbacl',
3629                                      $rv ? $rv->error : "Unknown error"));
3630                                 }
3631                         my ($user) = $rv->all_entries;
3632
3633                         # Find ACL sub-object for the module
3634                         my $ldapm = $m || "global";
3635                         if ($user) {
3636                                 my $rv = $dbh->search(
3637                                         base => $user->dn(),
3638                                         filter => '(cn='.$ldapm.')',
3639                                         scope => 'one');
3640                                 if (!$rv || $rv->code) {
3641                                         &error(&text('euserdbacl',
3642                                            $rv ? $rv->error : "Unknown error"));
3643                                         }
3644                                 my ($acl) = $rv->all_entries;
3645                                 if ($acl) {
3646                                         foreach my $av ($acl->get_value(
3647                                                         'webminAclEntry')) {
3648                                                 my ($a, $v) = split(/=/, $av,2);
3649                                                 $rv{$a} = $v;
3650                                                 }
3651                                         }
3652                                 }
3653                         }
3654                 &disconnect_userdb($userdb, $dbh);
3655                 }
3656
3657         if (!$foundindb) {
3658                 # Read from local files
3659                 &read_file_cached("$config_directory/$m/$u.acl", \%rv);
3660                 if ($remote_user ne $base_remote_user && !defined($_[0])) {
3661                         &read_file_cached(
3662                                 "$config_directory/$m/$remote_user.acl",\%rv);
3663                         }
3664                 }
3665         }
3666 if ($tconfig{'preload_functions'}) {
3667         &load_theme_library();
3668         }
3669 if (defined(&theme_get_module_acl)) {
3670         %rv = &theme_get_module_acl($u, $m, \%rv);
3671         }
3672 return %rv;
3673 }
3674
3675 =head2 get_group_module_acl(group, [module], [no-default])
3676
3677 Returns the ACL for a Webmin group, in an optional module (which defaults to
3678 the current module).
3679
3680 =cut
3681 sub get_group_module_acl
3682 {
3683 my $g = $_[0];
3684 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3685 my $mdir = &module_root_directory($m);
3686 my %rv;
3687 if (!$_[2]) {
3688         &read_file_cached("$mdir/defaultacl", \%rv);
3689         }
3690
3691 my $userdb = &get_userdb_string();
3692 my $foundindb = 0;
3693 if ($userdb) {
3694         # Look for this group in the user/group DB
3695         my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3696         ref($dbh) || &error(&text('egroupdbacl', $dbh));
3697         if ($proto eq "mysql" || $proto eq "postgresql") {
3698                 # Find the group in the SQL DB
3699                 my $cmd = $dbh->prepare(
3700                         "select id from webmin_group where name = ?");
3701                 $cmd && $cmd->execute($g) ||
3702                         &error(&text('egroupdbacl', $dbh->errstr));
3703                 my ($id) = $cmd->fetchrow();
3704                 $foundindb = 1 if (defined($id));
3705                 $cmd->finish();
3706
3707                 # Fetch ACLs with SQL
3708                 if ($foundindb) {
3709                         my $cmd = $dbh->prepare(
3710                             "select attr,value from webmin_group_acl ".
3711                             "where id = ? and module = ?");
3712                         $cmd && $cmd->execute($id, $m) ||
3713                             &error(&text('egroupdbacl', $dbh->errstr));
3714                         while(my ($a, $v) = $cmd->fetchrow()) {
3715                                 $rv{$a} = $v;
3716                                 }
3717                         $cmd->finish();
3718                         }
3719                 }
3720         elsif ($proto eq "ldap") {
3721                 # Find group in LDAP
3722                 my $rv = $dbh->search(
3723                         base => $prefix,
3724                         filter => '(&(cn='.$g.')(objectClass='.
3725                                   $args->{'groupclass'}.'))',
3726                         scope => 'sub');
3727                 if (!$rv || $rv->code) {
3728                         &error(&text('egroupdbacl',
3729                                      $rv ? $rv->error : "Unknown error"));
3730                         }
3731                 my ($group) = $rv->all_entries;
3732
3733                 # Find ACL sub-object for the module
3734                 my $ldapm = $m || "global";
3735                 if ($group) {
3736                         my $rv = $dbh->search(
3737                                 base => $group->dn(),
3738                                 filter => '(cn='.$ldapm.')',
3739                                 scope => 'one');
3740                         if (!$rv || $rv->code) {
3741                                 &error(&text('egroupdbacl',
3742                                      $rv ? $rv->error : "Unknown error"));
3743                                 }
3744                         my ($acl) = $rv->all_entries;
3745                         if ($acl) {
3746                                 foreach my $av ($acl->get_value(
3747                                                 'webminAclEntry')) {
3748                                         my ($a, $v) = split(/=/, $av, 2);
3749                                         $rv{$a} = $v;
3750                                         }
3751                                 }
3752                         }
3753                 }
3754         &disconnect_userdb($userdb, $dbh);
3755         }
3756 if (!$foundindb) {
3757         # Read from local files
3758         &read_file_cached("$config_directory/$m/$g.gacl", \%rv);
3759         }
3760 if (defined(&theme_get_module_acl)) {
3761         %rv = &theme_get_module_acl($g, $m, \%rv);
3762         }
3763 return %rv;
3764 }
3765
3766 =head2 save_module_acl(&acl, [user], [module], [never-update-group])
3767
3768 Updates the acl hash for some user and module. The parameters are :
3769
3770 =item acl - Hash reference for the new access control options, or undef to clear
3771
3772 =item user - User to update, defaulting to the current user.
3773
3774 =item module - Module to update, defaulting to the caller.
3775
3776 =item never-update-group - Never update the user's group's ACL
3777
3778 =cut
3779 sub save_module_acl
3780 {
3781 my $u = defined($_[1]) ? $_[1] : $base_remote_user;
3782 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3783 if (!$_[3] && &foreign_check("acl")) {
3784         # Check if this user is a member of a group, and if he gets the
3785         # module from a group. If so, update its ACL as well
3786         &foreign_require("acl", "acl-lib.pl");
3787         my $group;
3788         foreach my $g (&acl::list_groups()) {
3789                 if (&indexof($u, @{$g->{'members'}}) >= 0 &&
3790                     &indexof($m, @{$g->{'modules'}}) >= 0) {
3791                         $group = $g;
3792                         last;
3793                         }
3794                 }
3795         if ($group) {
3796                 &save_group_module_acl($_[0], $group->{'name'}, $m);
3797                 }
3798         }
3799
3800 my $userdb = &get_userdb_string();
3801 my $foundindb = 0;
3802 if ($userdb && ($u ne $base_remote_user || $remote_user_proto)) {
3803         # Look for this user in the user/group DB
3804         my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3805         ref($dbh) || &error(&text('euserdbacl', $dbh));
3806         if ($proto eq "mysql" || $proto eq "postgresql") {
3807                 # Find the user in the SQL DB
3808                 my $cmd = $dbh->prepare(
3809                         "select id from webmin_user where name = ?");
3810                 $cmd && $cmd->execute($u) ||
3811                         &error(&text('euserdbacl2', $dbh->errstr));
3812                 my ($id) = $cmd->fetchrow();
3813                 $foundindb = 1 if (defined($id));
3814                 $cmd->finish();
3815
3816                 # Replace ACLs for user
3817                 if ($foundindb) {
3818                         my $cmd = $dbh->prepare("delete from webmin_user_acl ".
3819                                                 "where id = ? and module = ?");
3820                         $cmd && $cmd->execute($id, $m) ||
3821                             &error(&text('euserdbacl', $dbh->errstr));
3822                         $cmd->finish();
3823                         if ($_[0]) {
3824                                 my $cmd = $dbh->prepare(
3825                                     "insert into webmin_user_acl ".
3826                                     "(id,module,attr,value) values (?,?,?,?)");
3827                                 $cmd || &error(&text('euserdbacl2',
3828                                                      $dbh->errstr));
3829                                 foreach my $a (keys %{$_[0]}) {
3830                                         $cmd->execute($id,$m,$a,$_[0]->{$a}) ||
3831                                             &error(&text('euserdbacl2',
3832                                                          $dbh->errstr));
3833                                         $cmd->finish();
3834                                         }
3835                                 }
3836                         }
3837                 }
3838         elsif ($proto eq "ldap") {
3839                 # Find the user in LDAP
3840                 my $rv = $dbh->search(
3841                         base => $prefix,
3842                         filter => '(&(cn='.$u.')(objectClass='.
3843                                   $args->{'userclass'}.'))',
3844                         scope => 'sub');
3845                 if (!$rv || $rv->code) {
3846                         &error(&text('euserdbacl',
3847                                      $rv ? $rv->error : "Unknown error"));
3848                         }
3849                 my ($user) = $rv->all_entries;
3850
3851                 if ($user) {
3852                         # Find the ACL sub-object for the module
3853                         $foundindb = 1;
3854                         my $ldapm = $m || "global";
3855                         my $rv = $dbh->search(
3856                                 base => $user->dn(),
3857                                 filter => '(cn='.$ldapm.')',
3858                                 scope => 'one');
3859                         if (!$rv || $rv->code) {
3860                                 &error(&text('euserdbacl',
3861                                      $rv ? $rv->error : "Unknown error"));
3862                                 }
3863                         my ($acl) = $rv->all_entries;
3864
3865                         my @al;
3866                         foreach my $a (keys %{$_[0]}) {
3867                                 push(@al, $a."=".$_[0]->{$a});
3868                                 }
3869                         if ($acl) {
3870                                 # Update attributes
3871                                 $rv = $dbh->modify($acl->dn(),
3872                                   replace => { "webminAclEntry", \@al });
3873                                 }
3874                         else {
3875                                 # Add a sub-object
3876                                 my @attrs = ( "cn", $ldapm,
3877                                               "objectClass", "webminAcl",
3878                                               "webminAclEntry", \@al );
3879                                 $rv = $dbh->add("cn=".$ldapm.",".$user->dn(),
3880                                                 attr => \@attrs);
3881                                 }
3882                         if (!$rv || $rv->code) {
3883                                 &error(&text('euserdbacl2',
3884                                      $rv ? $rv->error : "Unknown error"));
3885                                 }
3886                         }
3887                 }
3888         &disconnect_userdb($userdb, $dbh);
3889         }
3890
3891 if (!$foundindb) {
3892         # Save ACL to local file
3893         if (!-d "$config_directory/$m") {
3894                 mkdir("$config_directory/$m", 0755);
3895                 }
3896         if ($_[0]) {
3897                 &write_file("$config_directory/$m/$u.acl", $_[0]);
3898                 }
3899         else {
3900                 &unlink_file("$config_directory/$m/$u.acl");
3901                 }
3902         }
3903 }
3904
3905 =head2 save_group_module_acl(&acl, group, [module], [never-update-group])
3906
3907 Updates the acl hash for some group and module. The parameters are :
3908
3909 =item acl - Hash reference for the new access control options.
3910
3911 =item group - Group name to update.
3912
3913 =item module - Module to update, defaulting to the caller.
3914
3915 =item never-update-group - Never update the parent group's ACL
3916
3917 =cut
3918 sub save_group_module_acl
3919 {
3920 my $g = $_[1];
3921 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3922 if (!$_[3] && &foreign_check("acl")) {
3923         # Check if this group is a member of a group, and if it gets the
3924         # module from a group. If so, update the parent ACL as well
3925         &foreign_require("acl", "acl-lib.pl");
3926         my $group;
3927         foreach my $pg (&acl::list_groups()) {
3928                 if (&indexof('@'.$g, @{$pg->{'members'}}) >= 0 &&
3929                     &indexof($m, @{$pg->{'modules'}}) >= 0) {
3930                         $group = $g;
3931                         last;
3932                         }
3933                 }
3934         if ($group) {
3935                 &save_group_module_acl($_[0], $group->{'name'}, $m);
3936                 }
3937         }
3938
3939 my $userdb = &get_userdb_string();
3940 my $foundindb = 0;
3941 if ($userdb) {
3942         # Look for this group in the user/group DB
3943         my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3944         ref($dbh) || &error(&text('egroupdbacl', $dbh));
3945         if ($proto eq "mysql" || $proto eq "postgresql") {
3946                 # Find the group in the SQL DB
3947                 my $cmd = $dbh->prepare(
3948                         "select id from webmin_group where name = ?");
3949                 $cmd && $cmd->execute($g) ||
3950                         &error(&text('egroupdbacl2', $dbh->errstr));
3951                 my ($id) = $cmd->fetchrow();
3952                 $foundindb = 1 if (defined($id));
3953                 $cmd->finish();
3954
3955                 # Replace ACLs for group
3956                 if ($foundindb) {
3957                         my $cmd = $dbh->prepare("delete from webmin_group_acl ".
3958                                                 "where id = ? and module = ?");
3959                         $cmd && $cmd->execute($id, $m) ||
3960                             &error(&text('egroupdbacl', $dbh->errstr));
3961                         $cmd->finish();
3962                         if ($_[0]) {
3963                                 my $cmd = $dbh->prepare(
3964                                     "insert into webmin_group_acl ".
3965                                     "(id,module,attr,value) values (?,?,?,?)");
3966                                 $cmd || &error(&text('egroupdbacl2',
3967                                                      $dbh->errstr));
3968                                 foreach my $a (keys %{$_[0]}) {
3969                                         $cmd->execute($id,$m,$a,$_[0]->{$a}) ||
3970                                             &error(&text('egroupdbacl2',
3971                                                          $dbh->errstr));
3972                                         $cmd->finish();
3973                                         }
3974                                 }
3975                         }
3976                 }
3977         elsif ($proto eq "ldap") {
3978                 # Find the group in LDAP
3979                 my $rv = $dbh->search(
3980                         base => $prefix,
3981                         filter => '(&(cn='.$g.')(objectClass='.
3982                                   $args->{'groupclass'}.'))',
3983                         scope => 'sub');
3984                 if (!$rv || $rv->code) {
3985                         &error(&text('egroupdbacl',
3986                                      $rv ? $rv->error : "Unknown error"));
3987                         }
3988                 my ($group) = $rv->all_entries;
3989
3990                 my $ldapm = $m || "global";
3991                 if ($group) {
3992                         # Find the ACL sub-object for the module
3993                         $foundindb = 1;
3994                         my $rv = $dbh->search(
3995                                 base => $group->dn(),
3996                                 filter => '(cn='.$ldapm.')',
3997                                 scope => 'one');
3998                         if (!$rv || $rv->code) {
3999                                 &error(&text('egroupdbacl',
4000                                      $rv ? $rv->error : "Unknown error"));
4001                                 }
4002                         my ($acl) = $rv->all_entries;
4003
4004                         my @al;
4005                         foreach my $a (keys %{$_[0]}) {
4006                                 push(@al, $a."=".$_[0]->{$a});
4007                                 }
4008                         if ($acl) {
4009                                 # Update attributes
4010                                 $rv = $dbh->modify($acl->dn(),
4011                                         replace => { "webminAclEntry", \@al });
4012                                 }
4013                         else {
4014                                 # Add a sub-object
4015                                 my @attrs = ( "cn", $ldapm,
4016                                               "objectClass", "webminAcl",
4017                                               "webminAclEntry", \@al );
4018                                 $rv = $dbh->add("cn=".$ldapm.",".$group->dn(),
4019                                                 attr => \@attrs);
4020                                 }
4021                         if (!$rv || $rv->code) {
4022                                 &error(&text('egroupdbacl2',
4023                                      $rv ? $rv->error : "Unknown error"));
4024                                 }
4025                         }
4026                 }
4027         &disconnect_userdb($userdb, $dbh);
4028         }
4029
4030 if (!$foundindb) {
4031         # Save ACL to local file
4032         if (!-d "$config_directory/$m") {
4033                 mkdir("$config_directory/$m", 0755);
4034                 }
4035         if ($_[0]) {
4036                 &write_file("$config_directory/$m/$g.gacl", $_[0]);
4037                 }
4038         else {
4039                 &unlink_file("$config_directory/$m/$g.gacl");
4040                 }
4041         }
4042 }
4043
4044 =head2 init_config
4045
4046 This function must be called by all Webmin CGI scripts, either directly or
4047 indirectly via a per-module lib.pl file. It performs a number of initialization
4048 and housekeeping tasks, such as working out the module name, checking that the
4049 current user has access to the module, and populating global variables. Some
4050 of the variables set include :
4051
4052 =item $config_directory - Base Webmin config directory, typically /etc/webmin
4053
4054 =item $var_directory - Base logs directory, typically /var/webmin
4055
4056 =item %config - Per-module configuration.
4057
4058 =item %gconfig - Global configuration.
4059
4060 =item $scriptname - Base name of the current perl script.
4061
4062 =item $module_name - The name of the current module.
4063
4064 =item $module_config_directory - The config directory for this module.
4065
4066 =item $module_config_file - The config file for this module.
4067
4068 =item $module_root_directory - This module's code directory.
4069
4070 =item $webmin_logfile - The detailed logfile for webmin.
4071
4072 =item $remote_user - The actual username used to login to webmin.
4073
4074 =item $base_remote_user - The username whose permissions are in effect.
4075
4076 =item $current_theme - The theme currently in use.
4077
4078 =item $root_directory - The first root directory of this webmin install.
4079
4080 =item @root_directories - All root directories for this webmin install.
4081
4082 =cut
4083 sub init_config
4084 {
4085 # Record first process ID that called this, so we know when it exited to clean
4086 # up temp files
4087 $main::initial_process_id ||= $$;
4088
4089 # Configuration and spool directories
4090 if (!defined($ENV{'WEBMIN_CONFIG'})) {
4091         die "WEBMIN_CONFIG not set";
4092         }
4093 $config_directory = $ENV{'WEBMIN_CONFIG'};
4094 if (!defined($ENV{'WEBMIN_VAR'})) {
4095         open(VARPATH, "$config_directory/var-path");
4096         chop($var_directory = <VARPATH>);
4097         close(VARPATH);
4098         }
4099 else {
4100         $var_directory = $ENV{'WEBMIN_VAR'};
4101         }
4102 $main::http_cache_directory = $ENV{'WEBMIN_VAR'}."/cache";
4103 $main::default_debug_log_file = $ENV{'WEBMIN_VAR'}."/webmin.debug";
4104
4105 if ($ENV{'SESSION_ID'}) {
4106         # Hide this variable from called programs, but keep it for internal use
4107         $main::session_id = $ENV{'SESSION_ID'};
4108         delete($ENV{'SESSION_ID'});
4109         }
4110 if ($ENV{'REMOTE_PASS'}) {
4111         # Hide the password too
4112         $main::remote_pass = $ENV{'REMOTE_PASS'};
4113         delete($ENV{'REMOTE_PASS'});
4114         }
4115
4116 if ($> == 0 && $< != 0 && !$ENV{'FOREIGN_MODULE_NAME'}) {
4117         # Looks like we are running setuid, but the real UID hasn't been set.
4118         # Do so now, so that executed programs don't get confused
4119         $( = $);
4120         $< = $>;
4121         }
4122
4123 # Read the webmin global config file. This contains the OS type and version,
4124 # OS specific configuration and global options such as proxy servers
4125 $config_file = "$config_directory/config";
4126 %gconfig = ( );
4127 &read_file_cached($config_file, \%gconfig);
4128 $gconfig{'webprefix'} = '' if (!exists($gconfig{'webprefix'}));
4129 $null_file = $gconfig{'os_type'} eq 'windows' ? "NUL" : "/dev/null";
4130 $path_separator = $gconfig{'os_type'} eq 'windows' ? ';' : ':';
4131
4132 # Work out of this is a web, command line or cron job
4133 if (!$main::webmin_script_type) {
4134         if ($ENV{'SCRIPT_NAME'}) {
4135                 # Run via a CGI
4136                 $main::webmin_script_type = 'web';
4137                 }
4138         else {
4139                 # Cron jobs have no TTY
4140                 if ($gconfig{'os_type'} eq 'windows' ||
4141                     open(DEVTTY, ">/dev/tty")) {
4142                         $main::webmin_script_type = 'cmd';
4143                         close(DEVTTY);
4144                         }
4145                 else {
4146                         $main::webmin_script_type = 'cron';
4147                         }
4148                 }
4149         }
4150
4151 # If this is a cron job, suppress STDERR warnings
4152 if ($main::webmin_script_type eq 'cron') {
4153         $SIG{__WARN__} = sub { };
4154         }
4155
4156 # If debugging is enabled, open the debug log
4157 if ($gconfig{'debug_enabled'} && !$main::opened_debug_log++) {
4158         my $dlog = $gconfig{'debug_file'} || $main::default_debug_log_file;
4159         if ($gconfig{'debug_size'}) {
4160                 my @st = stat($dlog);
4161                 if ($st[7] > $gconfig{'debug_size'}) {
4162                         rename($dlog, $dlog.".0");
4163                         }
4164                 }
4165         open(main::DEBUGLOG, ">>$dlog");
4166         $main::opened_debug_log = 1;
4167
4168         if ($gconfig{'debug_what_start'}) {
4169                 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
4170                 $main::debug_log_start_time = time();
4171                 &webmin_debug_log("START", "script=$script_name");
4172                 $main::debug_log_start_module = $module_name;
4173                 }
4174         }
4175
4176 # Set PATH and LD_LIBRARY_PATH
4177 if ($gconfig{'path'}) {
4178         if ($gconfig{'syspath'}) {
4179                 # Webmin only
4180                 $ENV{'PATH'} = $gconfig{'path'};
4181                 }
4182         else {
4183                 # Include OS too
4184                 $ENV{'PATH'} = $gconfig{'path'}.$path_separator.$ENV{'PATH'};
4185                 }
4186         }
4187 $ENV{$gconfig{'ld_env'}} = $gconfig{'ld_path'} if ($gconfig{'ld_env'});
4188
4189 # Set http_proxy and ftp_proxy environment variables, based on Webmin settings
4190 if ($gconfig{'http_proxy'}) {
4191         $ENV{'http_proxy'} = $gconfig{'http_proxy'};
4192         }
4193 if ($gconfig{'ftp_proxy'}) {
4194         $ENV{'ftp_proxy'} = $gconfig{'ftp_proxy'};
4195         }
4196 if ($gconfig{'noproxy'}) {
4197         $ENV{'no_proxy'} = $gconfig{'noproxy'};
4198         }
4199
4200 # Find all root directories
4201 my %miniserv;
4202 if (&get_miniserv_config(\%miniserv)) {
4203         @root_directories = ( $miniserv{'root'} );
4204         for($i=0; defined($miniserv{"extraroot_$i"}); $i++) {
4205                 push(@root_directories, $miniserv{"extraroot_$i"});
4206                 }
4207         }
4208
4209 # Work out which module we are in, and read the per-module config file
4210 $0 =~ s/\\/\//g;        # Force consistent path on Windows
4211 if (defined($ENV{'FOREIGN_MODULE_NAME'})) {
4212         # In a foreign call - use the module name given
4213         $root_directory = $ENV{'FOREIGN_ROOT_DIRECTORY'};
4214         $module_name = $ENV{'FOREIGN_MODULE_NAME'};
4215         @root_directories = ( $root_directory ) if (!@root_directories);
4216         }
4217 elsif ($ENV{'SCRIPT_NAME'}) {
4218         my $sn = $ENV{'SCRIPT_NAME'};
4219         $sn =~ s/^$gconfig{'webprefix'}//
4220                 if (!$gconfig{'webprefixnoredir'});
4221         if ($sn =~ /^\/([^\/]+)\//) {
4222                 # Get module name from CGI path
4223                 $module_name = $1;
4224                 }
4225         if ($ENV{'SERVER_ROOT'}) {
4226                 $root_directory = $ENV{'SERVER_ROOT'};
4227                 }
4228         elsif ($ENV{'SCRIPT_FILENAME'}) {
4229                 $root_directory = $ENV{'SCRIPT_FILENAME'};
4230                 $root_directory =~ s/$sn$//;
4231                 }
4232         @root_directories = ( $root_directory ) if (!@root_directories);
4233         }
4234 else {
4235         # Get root directory from miniserv.conf, and deduce module name from $0
4236         $root_directory = $root_directories[0];
4237         my $rok = 0;
4238         foreach my $r (@root_directories) {
4239                 if ($0 =~ /^$r\/([^\/]+)\/[^\/]+$/i) {
4240                         # Under a module directory
4241                         $module_name = $1;
4242                         $rok = 1;
4243                         last;
4244                         }
4245                 elsif ($0 =~ /^$root_directory\/[^\/]+$/i) {
4246                         # At the top level
4247                         $rok = 1;
4248                         last;
4249                         }
4250                 }
4251         &error("Script was not run with full path (failed to find $0 under $root_directory)") if (!$rok);
4252         }
4253
4254 # Set the umask based on config
4255 if ($gconfig{'umask'} && !$main::umask_already++) {
4256         umask(oct($gconfig{'umask'}));
4257         }
4258
4259 # If this is a cron job or other background task, set the nice level
4260 if (!$main::nice_already && $main::webmin_script_type eq 'cron') {
4261         # Set nice level
4262         if ($gconfig{'nice'}) {
4263                 eval 'POSIX::nice($gconfig{\'nice\'});';
4264                 }
4265
4266         # Set IO scheduling class and priority
4267         if ($gconfig{'sclass'} ne '' || $gconfig{'sprio'} ne '') {
4268                 my $cmd = "ionice";
4269                 $cmd .= " -c ".quotemeta($gconfig{'sclass'})
4270                         if ($gconfig{'sclass'} ne '');
4271                 $cmd .= " -n ".quotemeta($gconfig{'sprio'})
4272                         if ($gconfig{'sprio'} ne '');
4273                 $cmd .= " -p $$";
4274                 &execute_command("$cmd >/dev/null 2>&1");
4275                 }
4276         }
4277 $main::nice_already++;
4278
4279 # Get the username
4280 my $u = $ENV{'BASE_REMOTE_USER'} || $ENV{'REMOTE_USER'};
4281 $base_remote_user = $u;
4282 $remote_user = $ENV{'REMOTE_USER'};
4283
4284 # Work out if user is definitely in the DB, and if so get his attrs
4285 $remote_user_proto = $ENV{"REMOTE_USER_PROTO"};
4286 %remote_user_attrs = ( );
4287 if ($remote_user_proto) {
4288         my $userdb = &get_userdb_string();
4289         my ($dbh, $proto, $prefix, $args) =
4290                 $userdb ? &connect_userdb($userdb) : ( );
4291         if (ref($dbh)) {
4292                 if ($proto eq "mysql" || $proto eq "postgresql") {
4293                         # Read attrs from SQL
4294                         my $cmd = $dbh->prepare("select webmin_user_attr.attr,webmin_user_attr.value from webmin_user_attr,webmin_user where webmin_user_attr.id = webmin_user.id and webmin_user.name = ?");
4295                         if ($cmd && $cmd->execute($base_remote_user)) {
4296                                 while(my ($attr, $value) = $cmd->fetchrow()) {
4297                                         $remote_user_attrs{$attr} = $value;
4298                                         }
4299                                 $cmd->finish();
4300                                 }
4301                         }
4302                 elsif ($proto eq "ldap") {
4303                         # Read attrs from LDAP
4304                         my $rv = $dbh->search(
4305                                 base => $prefix,
4306                                 filter => '(&(cn='.$base_remote_user.')'.
4307                                           '(objectClass='.
4308                                           $args->{'userclass'}.'))',
4309                                 scope => 'sub');
4310                         my ($u) = $rv && !$rv->code ? $rv->all_entries : ( );
4311                         if ($u) {
4312                                 foreach $la ($u->get_value('webminAttr')) {
4313                                         my ($attr, $value) = split(/=/, $la, 2);
4314                                         $remote_user_attrs{$attr} = $value;
4315                                         }
4316                                 }
4317                         }
4318                 &disconnect_userdb($userdb, $dbh);
4319                 }
4320         }
4321
4322 if ($module_name) {
4323         # Find and load the configuration file for this module
4324         my (@ruinfo, $rgroup);
4325         $module_config_directory = "$config_directory/$module_name";
4326         if (&get_product_name() eq "usermin" &&
4327             -r "$module_config_directory/config.$remote_user") {
4328                 # Based on username
4329                 $module_config_file = "$module_config_directory/config.$remote_user";
4330                 }
4331         elsif (&get_product_name() eq "usermin" &&
4332             (@ruinfo = getpwnam($remote_user)) &&
4333             ($rgroup = getgrgid($ruinfo[3])) &&
4334             -r "$module_config_directory/config.\@$rgroup") {
4335                 # Based on group name
4336                 $module_config_file = "$module_config_directory/config.\@$rgroup";
4337                 }
4338         else {
4339                 # Global config
4340                 $module_config_file = "$module_config_directory/config";
4341                 }
4342         %config = ( );
4343         &read_file_cached($module_config_file, \%config);
4344
4345         # Fix up windows-specific substitutions in values
4346         foreach my $k (keys %config) {
4347                 if ($config{$k} =~ /\$\{systemroot\}/) {
4348                         my $root = &get_windows_root();
4349                         $config{$k} =~ s/\$\{systemroot\}/$root/g;
4350                         }
4351                 }
4352         }
4353
4354 # Record the initial module
4355 $main::initial_module_name ||= $module_name;
4356
4357 # Set some useful variables
4358 my $current_themes;
4359 $current_themes = $ENV{'MOBILE_DEVICE'} && defined($gconfig{'mobile_theme'}) ?
4360                     $gconfig{'mobile_theme'} :
4361                   defined($remote_user_attrs{'theme'}) ?
4362                     $remote_user_attrs{'theme'} :
4363                   defined($gconfig{'theme_'.$remote_user}) ?
4364                     $gconfig{'theme_'.$remote_user} :
4365                   defined($gconfig{'theme_'.$base_remote_user}) ?
4366                     $gconfig{'theme_'.$base_remote_user} :
4367                     $gconfig{'theme'};
4368 @current_themes = split(/\s+/, $current_themes);
4369 $current_theme = $current_themes[0];
4370 @theme_root_directories = map { "$root_directory/$_" } @current_themes;
4371 $theme_root_directory = $theme_root_directories[0];
4372 @theme_configs = ( );
4373 foreach my $troot (@theme_root_directories) {
4374         my %onetconfig;
4375         &read_file_cached("$troot/config", \%onetconfig);
4376         &read_file_cached("$troot/config", \%tconfig);
4377         push(@theme_configs, \%onetconfig);
4378         }
4379 $tb = defined($tconfig{'cs_header'}) ? "bgcolor=#$tconfig{'cs_header'}" :
4380       defined($gconfig{'cs_header'}) ? "bgcolor=#$gconfig{'cs_header'}" :
4381                                        "bgcolor=#9999ff";
4382 $cb = defined($tconfig{'cs_table'}) ? "bgcolor=#$tconfig{'cs_table'}" :
4383       defined($gconfig{'cs_table'}) ? "bgcolor=#$gconfig{'cs_table'}" :
4384                                       "bgcolor=#cccccc";
4385 $tb .= ' '.$tconfig{'tb'} if ($tconfig{'tb'});
4386 $cb .= ' '.$tconfig{'cb'} if ($tconfig{'cb'});
4387 if ($tconfig{'preload_functions'}) {
4388         # Force load of theme functions right now, if requested
4389         &load_theme_library();
4390         }
4391 if ($tconfig{'oofunctions'} && !$main::loaded_theme_oo_library++) {
4392         # Load the theme's Webmin:: package classes
4393         do "$theme_root_directory/$tconfig{'oofunctions'}";
4394         }
4395
4396 $0 =~ /([^\/]+)$/;
4397 $scriptname = $1;
4398 $webmin_logfile = $gconfig{'webmin_log'} ? $gconfig{'webmin_log'}
4399                                          : "$var_directory/webmin.log";
4400
4401 # Load language strings into %text
4402 my @langs = &list_languages();
4403 my $accepted_lang;
4404 if ($gconfig{'acceptlang'}) {
4405         foreach my $a (split(/,/, $ENV{'HTTP_ACCEPT_LANGUAGE'})) {
4406                 $a =~ s/;.*//;  # Remove ;q=0.5 or similar
4407                 my ($al) = grep { $_->{'lang'} eq $a } @langs;
4408                 if ($al) {
4409                         $accepted_lang = $al->{'lang'};
4410                         last;
4411                         }
4412                 }
4413         }
4414 $current_lang = $force_lang ? $force_lang :
4415     $accepted_lang ? $accepted_lang :
4416     $remote_user_attrs{'lang'} ? $remote_user_attrs{'lang'} :
4417     $gconfig{"lang_$remote_user"} ? $gconfig{"lang_$remote_user"} :
4418     $gconfig{"lang_$base_remote_user"} ? $gconfig{"lang_$base_remote_user"} :
4419     $gconfig{"lang"} ? $gconfig{"lang"} : $default_lang;
4420 foreach my $l (@langs) {
4421         $current_lang_info = $l if ($l->{'lang'} eq $current_lang);
4422         }
4423 @lang_order_list = &unique($default_lang,
4424                            split(/:/, $current_lang_info->{'fallback'}),
4425                            $current_lang);
4426 %text = &load_language($module_name);
4427 %text || &error("Failed to determine Webmin root from SERVER_ROOT, SCRIPT_FILENAME or the full command line");
4428
4429 # Get the %module_info for this module
4430 if ($module_name) {
4431         my ($mi) = grep { $_->{'dir'} eq $module_name }
4432                          &get_all_module_infos(2);
4433         %module_info = %$mi;
4434         $module_root_directory = &module_root_directory($module_name);
4435         }
4436
4437 if ($module_name && !$main::no_acl_check &&
4438     !defined($ENV{'FOREIGN_MODULE_NAME'})) {
4439         # Check if the HTTP user can access this module
4440         if (!&foreign_available($module_name)) {
4441                 if (!&foreign_check($module_name)) {
4442                         &error(&text('emodulecheck',
4443                                      "<i>$module_info{'desc'}</i>"));
4444                         }
4445                 else {
4446                         &error(&text('emodule', "<i>$u</i>",
4447                                      "<i>$module_info{'desc'}</i>"));
4448                         }
4449                 }
4450         $main::no_acl_check++;
4451         }
4452
4453 # Check the Referer: header for nasty redirects
4454 my @referers = split(/\s+/, $gconfig{'referers'});
4455 my $referer_site;
4456 my $r = $ENV{'HTTP_REFERER'};
4457 if ($r =~ /^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?\[([^\]]+)\]/ ||
4458     $r =~ /^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?([^\/:@]+)/) {
4459         $referer_site = $3;
4460         }
4461 my $http_host = $ENV{'HTTP_HOST'};
4462 $http_host =~ s/:\d+$//;
4463 $http_host =~ s/^\[(\S+)\]$/$1/;
4464 my $unsafe_index = $unsafe_index_cgi ||
4465                    &get_module_variable('$unsafe_index_cgi');
4466 if ($0 &&
4467     ($ENV{'SCRIPT_NAME'} !~ /^\/(index.cgi)?$/ || $unsafe_index) &&
4468     ($ENV{'SCRIPT_NAME'} !~ /^\/([a-z0-9\_\-]+)\/(index.cgi)?$/i ||
4469      $unsafe_index) &&
4470     $0 !~ /(session_login|pam_login)\.cgi$/ && !$gconfig{'referer'} &&
4471     $ENV{'MINISERV_CONFIG'} && !$main::no_referers_check &&
4472     $ENV{'HTTP_USER_AGENT'} !~ /^Webmin/i &&
4473     ($referer_site && $referer_site ne $http_host &&
4474      &indexof($referer_site, @referers) < 0 ||
4475     !$referer_site && $gconfig{'referers_none'}) &&
4476     !$trust_unknown_referers &&
4477     !&get_module_variable('$trust_unknown_referers')) {
4478         # Looks like a link from elsewhere .. show an error
4479         &header($text{'referer_title'}, "", undef, 0, 1, 1);
4480
4481         $prot = lc($ENV{'HTTPS'}) eq 'on' ? "https" : "http";
4482         my $url = "<tt>".&html_escape("$prot://$ENV{'HTTP_HOST'}$ENV{'REQUEST_URI'}")."</tt>";
4483         if ($referer_site) {
4484                 # From a known host
4485                 print &text('referer_warn',
4486                             "<tt>".&html_escape($r)."</tt>", $url);
4487                 print "<p>\n";
4488                 print &text('referer_fix1', &html_escape($http_host)),"<p>\n";
4489                 print &text('referer_fix2', &html_escape($http_host)),"<p>\n";
4490                 }
4491         else {
4492                 # No referer info given
4493                 print &text('referer_warn_unknown', $url),"<p>\n";
4494                 print &text('referer_fix1u'),"<p>\n";
4495                 print &text('referer_fix2u'),"<p>\n";
4496                 }
4497         print "<p>\n";
4498
4499         &footer("/", $text{'index'});
4500         exit;
4501         }
4502 $main::no_referers_check++;
4503 $main::completed_referers_check++;
4504
4505 # Call theme post-init
4506 if (defined(&theme_post_init_config)) {
4507         &theme_post_init_config(@_);
4508         }
4509
4510 # Record that we have done the calling library in this package
4511 my ($callpkg, $lib) = caller();
4512 $lib =~ s/^.*\///;
4513 $main::done_foreign_require{$callpkg,$lib} = 1;
4514
4515 # If a licence checking is enabled, do it now
4516 if ($gconfig{'licence_module'} && !$main::done_licence_module_check &&
4517     &foreign_check($gconfig{'licence_module'}) &&
4518     -r "$root_directory/$gconfig{'licence_module'}/licence_check.pl") {
4519         my $oldpwd = &get_current_dir();
4520         $main::done_licence_module_check++;
4521         $main::licence_module = $gconfig{'licence_module'};
4522         &foreign_require($main::licence_module, "licence_check.pl");
4523         ($main::licence_status, $main::licence_message) =
4524                 &foreign_call($main::licence_module, "check_licence");
4525         chdir($oldpwd);
4526         }
4527
4528 # Export global variables to caller
4529 if ($main::export_to_caller) {
4530         foreach my $v ('$config_file', '%gconfig', '$null_file',
4531                        '$path_separator', '@root_directories',
4532                        '$root_directory', '$module_name',
4533                        '$base_remote_user', '$remote_user',
4534                        '$remote_user_proto', '%remote_user_attrs',
4535                        '$module_config_directory', '$module_config_file',
4536                        '%config', '@current_themes', '$current_theme',
4537                        '@theme_root_directories', '$theme_root_directory',
4538                        '%tconfig','@theme_configs', '$tb', '$cb', '$scriptname',
4539                        '$webmin_logfile', '$current_lang',
4540                        '$current_lang_info', '@lang_order_list', '%text',
4541                        '%module_info', '$module_root_directory') {
4542                 my ($vt, $vn) = split('', $v, 2);
4543                 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
4544                 }
4545         }
4546
4547 return 1;
4548 }
4549
4550 =head2 load_language([module], [directory])
4551
4552 Returns a hashtable mapping text codes to strings in the appropriate language,
4553 based on the $current_lang global variable, which is in turn set based on
4554 the Webmin user's selection. The optional module parameter tells the function
4555 which module to load strings for, and defaults to the calling module. The
4556 optional directory parameter can be used to load strings from a directory
4557 other than lang.
4558
4559 In regular module development you will never need to call this function
4560 directly, as init_config calls it for you, and places the module's strings
4561 into the %text hash.
4562
4563 =cut
4564 sub load_language
4565 {
4566 my %text;
4567 my $root = $root_directory;
4568 my $ol = $gconfig{'overlang'};
4569 my ($dir) = ($_[1] || "lang");
4570
4571 # Read global lang files
4572 foreach my $o (@lang_order_list) {
4573         my $ok = &read_file_cached_with_stat("$root/$dir/$o", \%text);
4574         return () if (!$ok && $o eq $default_lang);
4575         }
4576 if ($ol) {
4577         foreach my $o (@lang_order_list) {
4578                 &read_file_cached("$root/$ol/$o", \%text);
4579                 }
4580         }
4581 &read_file_cached("$config_directory/custom-lang", \%text);
4582 foreach my $o (@lang_order_list) {
4583         next if ($o eq "en");
4584         &read_file_cached("$config_directory/custom-lang.$o", \%text);
4585         }
4586 my $norefs = $text{'__norefs'};
4587
4588 if ($_[0]) {
4589         # Read module's lang files
4590         delete($text{'__norefs'});
4591         my $mdir = &module_root_directory($_[0]);
4592         foreach my $o (@lang_order_list) {
4593                 &read_file_cached_with_stat("$mdir/$dir/$o", \%text);
4594                 }
4595         if ($ol) {
4596                 foreach my $o (@lang_order_list) {
4597                         &read_file_cached("$mdir/$ol/$o", \%text);
4598                         }
4599                 }
4600         &read_file_cached("$config_directory/$_[0]/custom-lang", \%text);
4601         foreach my $o (@lang_order_list) {
4602                 next if ($o eq "en");
4603                 &read_file_cached("$config_directory/$_[0]/custom-lang.$o",
4604                                   \%text);
4605                 }
4606         $norefs = $text{'__norefs'} if ($norefs);
4607         }
4608
4609 # Replace references to other strings
4610 if (!$norefs) {
4611         foreach $k (keys %text) {
4612                 $text{$k} =~ s/\$(\{([^\}]+)\}|([A-Za-z0-9\.\-\_]+))/text_subs($2 || $3,\%text)/ge;
4613                 }
4614         }
4615
4616 if (defined(&theme_load_language)) {
4617         &theme_load_language(\%text, $_[0]);
4618         }
4619 return %text;
4620 }
4621
4622 =head2 text_subs(string)
4623
4624 Used internally by load_language to expand $code substitutions in language
4625 files.
4626
4627 =cut
4628 sub text_subs
4629 {
4630 if (substr($_[0], 0, 8) eq "include:") {
4631         local $_;
4632         my $rv;
4633         open(INCLUDE, substr($_[0], 8));
4634         while(<INCLUDE>) {
4635                 $rv .= $_;
4636                 }
4637         close(INCLUDE);
4638         return $rv;
4639         }
4640 else {
4641         my $t = $_[1]->{$_[0]};
4642         return defined($t) ? $t : '$'.$_[0];
4643         }
4644 }
4645
4646 =head2 text(message, [substitute]+)
4647
4648 Returns a translated message from %text, but with $1, $2, etc.. replaced with
4649 the substitute parameters. This makes it easy to use strings with placeholders
4650 that get replaced with programmatically generated text. For example :
4651
4652  print &text('index_hello', $remote_user),"<p>\n";
4653
4654 =cut
4655 sub text
4656 {
4657 my $t = &get_module_variable('%text', 1);
4658 my $rv = exists($t->{$_[0]}) ? $t->{$_[0]} : $text{$_[0]};
4659 for(my $i=1; $i<@_; $i++) {
4660         $rv =~ s/\$$i/$_[$i]/g;
4661         }
4662 return $rv;
4663 }
4664
4665 =head2 encode_base64(string)
4666
4667 Encodes a string into base64 format, for use in MIME email or HTTP
4668 authorization headers.
4669
4670 =cut
4671 sub encode_base64
4672 {
4673 my $res;
4674 pos($_[0]) = 0;                          # ensure start at the beginning
4675 while ($_[0] =~ /(.{1,57})/gs) {
4676         $res .= substr(pack('u57', $1), 1)."\n";
4677         chop($res);
4678         }
4679 $res =~ tr|\` -_|AA-Za-z0-9+/|;
4680 my $padding = (3 - length($_[0]) % 3) % 3;
4681 $res =~ s/.{$padding}$/'=' x $padding/e if ($padding);
4682 return $res;
4683 }
4684
4685 =head2 decode_base64(string)
4686
4687 Converts a base64-encoded string into plain text. The opposite of encode_base64.
4688
4689 =cut
4690 sub decode_base64
4691 {
4692 my ($str) = @_;
4693 my $res;
4694 $str =~ tr|A-Za-z0-9+=/||cd;            # remove non-base64 chars
4695 if (length($str) % 4) {
4696         return undef;
4697 }
4698 $str =~ s/=+$//;                        # remove padding
4699 $str =~ tr|A-Za-z0-9+/| -_|;            # convert to uuencoded format
4700 while ($str =~ /(.{1,60})/gs) {
4701         my $len = chr(32 + length($1)*3/4); # compute length byte
4702         $res .= unpack("u", $len . $1 );    # uudecode
4703         }
4704 return $res;
4705 }
4706
4707 =head2 get_module_info(module, [noclone], [forcache])
4708
4709 Returns a hash containg details of the given module. Some useful keys are :
4710
4711 =item dir - The module directory, like sendmail.
4712
4713 =item desc - Human-readable description, in the current users' language.
4714
4715 =item version - Optional module version number.
4716
4717 =item os_support - List of supported operating systems and versions.
4718
4719 =item category - Category on Webmin's left menu, like net.
4720
4721 =cut
4722 sub get_module_info
4723 {
4724 return () if ($_[0] =~ /^\./);
4725 my (%rv, $clone, $o);
4726 my $mdir = &module_root_directory($_[0]);
4727 &read_file_cached("$mdir/module.info", \%rv) || return ();
4728 if (-l $mdir) {
4729         # A clone is a module that links to another directory under the root
4730         foreach my $r (@root_directories) {
4731                 if (&is_under_directory($r, $mdir)) {
4732                         $clone = 1;
4733                         last;
4734                         }
4735                 }
4736         }
4737 foreach $o (@lang_order_list) {
4738         $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4739         $rv{"longdesc"} = $rv{"longdesc_$o"} if ($rv{"longdesc_$o"});
4740         }
4741 if ($clone && !$_[1] && $config_directory) {
4742         $rv{'clone'} = $rv{'desc'};
4743         &read_file("$config_directory/$_[0]/clone", \%rv);
4744         }
4745 $rv{'dir'} = $_[0];
4746 my %module_categories;
4747 &read_file_cached("$config_directory/webmin.cats", \%module_categories);
4748 my $pn = &get_product_name();
4749 if (defined($rv{'category_'.$pn})) {
4750         # Can override category for webmin/usermin
4751         $rv{'category'} = $rv{'category_'.$pn};
4752         }
4753 $rv{'realcategory'} = $rv{'category'};
4754 $rv{'category'} = $module_categories{$_[0]}
4755         if (defined($module_categories{$_[0]}));
4756
4757 # Apply description overrides
4758 $rv{'realdesc'} = $rv{'desc'};
4759 my %descs;
4760 &read_file_cached("$config_directory/webmin.descs", \%descs);
4761 if ($descs{$_[0]}) {
4762         $rv{'desc'} = $descs{$_[0]};
4763         }
4764 foreach my $o (@lang_order_list) {
4765         my $ov = $descs{$_[0]." ".$o} || $descs{$_[0]."_".$o};
4766         $rv{'desc'} = $ov if ($ov);
4767         }
4768
4769 if (!$_[2]) {
4770         # Apply per-user description overridde
4771         my %gaccess = &get_module_acl(undef, "");
4772         if ($gaccess{'desc_'.$_[0]}) {
4773                 $rv{'desc'} = $gaccess{'desc_'.$_[0]};
4774                 }
4775         }
4776
4777 if ($rv{'longdesc'}) {
4778         # All standard modules have an index.cgi
4779         $rv{'index_link'} = 'index.cgi';
4780         }
4781
4782 # Call theme-specific override function
4783 if (defined(&theme_get_module_info)) {
4784         %rv = &theme_get_module_info(\%rv, $_[0], $_[1], $_[2]);
4785         }
4786
4787 return %rv;
4788 }
4789
4790 =head2 get_all_module_infos(cachemode)
4791
4792 Returns a list contains the information on all modules in this webmin
4793 install, including clones. Uses caching to reduce the number of module.info
4794 files that need to be read. Each element of the array is a hash reference
4795 in the same format as returned by get_module_info. The cache mode flag can be :
4796 0 = read and write, 1 = don't read or write, 2 = read only
4797
4798 =cut
4799 sub get_all_module_infos
4800 {
4801 my (%cache, @rv);
4802
4803 # Is the cache out of date? (ie. have any of the root's changed?)
4804 my $cache_file = "$config_directory/module.infos.cache";
4805 my $changed = 0;
4806 if (&read_file_cached($cache_file, \%cache)) {
4807         foreach my $r (@root_directories) {
4808                 my @st = stat($r);
4809                 if ($st[9] != $cache{'mtime_'.$r}) {
4810                         $changed = 2;
4811                         last;
4812                         }
4813                 }
4814         }
4815 else {
4816         $changed = 1;
4817         }
4818
4819 if ($_[0] != 1 && !$changed && $cache{'lang'} eq $current_lang) {
4820         # Can use existing module.info cache
4821         my %mods;
4822         foreach my $k (keys %cache) {
4823                 if ($k =~ /^(\S+) (\S+)$/) {
4824                         $mods{$1}->{$2} = $cache{$k};
4825                         }
4826                 }
4827         @rv = map { $mods{$_} } (keys %mods) if (%mods);
4828         }
4829 else {
4830         # Need to rebuild cache
4831         %cache = ( );
4832         foreach my $r (@root_directories) {
4833                 opendir(DIR, $r);
4834                 foreach my $m (readdir(DIR)) {
4835                         next if ($m =~ /^(config-|\.)/ || $m =~ /\.(cgi|pl)$/);
4836                         my %minfo = &get_module_info($m, 0, 1);
4837                         next if (!%minfo || !$minfo{'dir'});
4838                         push(@rv, \%minfo);
4839                         foreach $k (keys %minfo) {
4840                                 $cache{"${m} ${k}"} = $minfo{$k};
4841                                 }
4842                         }
4843                 closedir(DIR);
4844                 my @st = stat($r);
4845                 $cache{'mtime_'.$r} = $st[9];
4846                 }
4847         $cache{'lang'} = $current_lang;
4848         if (!$_[0] && $< == 0 && $> == 0) {
4849                 eval {
4850                         # Don't fail if cache write fails
4851                         local $main::error_must_die = 1;
4852                         &write_file($cache_file, \%cache);
4853                         }
4854                 }
4855         }
4856
4857 # Override descriptions for modules for current user
4858 my %gaccess = &get_module_acl(undef, "");
4859 foreach my $m (@rv) {
4860         if ($gaccess{"desc_".$m->{'dir'}}) {
4861                 $m->{'desc'} = $gaccess{"desc_".$m->{'dir'}};
4862                 }
4863         }
4864
4865 # Apply installed flags
4866 my %installed;
4867 &read_file_cached("$config_directory/installed.cache", \%installed);
4868 foreach my $m (@rv) {
4869         $m->{'installed'} = $installed{$m->{'dir'}};
4870         }
4871
4872 return @rv;
4873 }
4874
4875 =head2 list_themes
4876
4877 Returns an array of all installed themes, each of which is a hash ref
4878 corresponding to the theme.info file.
4879
4880 =cut
4881 sub list_themes
4882 {
4883 my @rv;
4884 opendir(DIR, $root_directory);
4885 foreach my $m (readdir(DIR)) {
4886         my %tinfo;
4887         next if ($m =~ /^\./);
4888         next if (!&read_file_cached("$root_directory/$m/theme.info", \%tinfo));
4889         next if (!&check_os_support(\%tinfo));
4890         foreach my $o (@lang_order_list) {
4891                 if ($tinfo{'desc_'.$o}) {
4892                         $tinfo{'desc'} = $tinfo{'desc_'.$o};
4893                         }
4894                 }
4895         $tinfo{'dir'} = $m;
4896         push(@rv, \%tinfo);
4897         }
4898 closedir(DIR);
4899 return sort { lc($a->{'desc'}) cmp lc($b->{'desc'}) } @rv;
4900 }
4901
4902 =head2 get_theme_info(theme)
4903
4904 Returns a hash containing a theme's details, taken from it's theme.info file.
4905 Some useful keys are :
4906
4907 =item dir - The theme directory, like blue-theme.
4908
4909 =item desc - Human-readable description, in the current users' language.
4910
4911 =item version - Optional module version number.
4912
4913 =item os_support - List of supported operating systems and versions.
4914
4915 =cut
4916 sub get_theme_info
4917 {
4918 return () if ($_[0] =~ /^\./);
4919 my %rv;
4920 my $tdir = &module_root_directory($_[0]);
4921 &read_file("$tdir/theme.info", \%rv) || return ();
4922 foreach my $o (@lang_order_list) {
4923         $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4924         }
4925 $rv{"dir"} = $_[0];
4926 return %rv;
4927 }
4928
4929 =head2 list_languages
4930
4931 Returns an array of supported languages, taken from Webmin's os_list.txt file.
4932 Each is a hash reference with the following keys :
4933
4934 =item lang - The short language code, like es for Spanish.
4935
4936 =item desc - A human-readable description, in English.
4937
4938 =item charset - An optional character set to use when displaying the language.
4939
4940 =item titles - Set to 1 only if Webmin has title images for the language.
4941
4942 =item fallback - The code for another language to use if a string does not exist in this one. For all languages, English is the ultimate fallback.
4943
4944 =cut
4945 sub list_languages
4946 {
4947 if (!@main::list_languages_cache) {
4948         my $o;
4949         local $_;
4950         open(LANG, "$root_directory/lang_list.txt");
4951         while(<LANG>) {
4952                 if (/^(\S+)\s+(.*)/) {
4953                         my $l = { 'desc' => $2 };
4954                         foreach $o (split(/,/, $1)) {
4955                                 if ($o =~ /^([^=]+)=(.*)$/) {
4956                                         $l->{$1} = $2;
4957                                         }
4958                                 }
4959                         $l->{'index'} = scalar(@rv);
4960                         push(@main::list_languages_cache, $l);
4961                         }
4962                 }
4963         close(LANG);
4964         @main::list_languages_cache = sort { $a->{'desc'} cmp $b->{'desc'} }
4965                                      @main::list_languages_cache;
4966         }
4967 return @main::list_languages_cache;
4968 }
4969
4970 =head2 read_env_file(file, &hash, [include-commented])
4971
4972 Similar to Webmin's read_file function, but handles files containing shell
4973 environment variables formatted like :
4974
4975   export FOO=bar
4976   SMEG="spod"
4977
4978 The file parameter is the full path to the file to read, and hash a Perl hash
4979 ref to read names and values into.
4980
4981 =cut
4982 sub read_env_file
4983 {
4984 local $_;
4985 &open_readfile(FILE, $_[0]) || return 0;
4986 while(<FILE>) {
4987         if ($_[2]) {
4988                 # Remove start of line comments
4989                 s/^\s*#+\s*//;
4990                 }
4991         s/#.*$//g;
4992         if (/^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*"(.*)"/i ||
4993             /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*'(.*)'/i ||
4994             /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*(.*)/i) {
4995                 $_[1]->{$2} = $3;
4996                 }
4997         }
4998 close(FILE);
4999 return 1;
5000 }
5001
5002 =head2 write_env_file(file, &hash, [export])
5003
5004 Writes out a hash to a file in name='value' format, suitable for use in a shell
5005 script. The parameters are :
5006
5007 =item file - Full path for a file to write to
5008
5009 =item hash - Hash reference of names and values to write.
5010
5011 =item export - If set to 1, preceed each variable setting with the word 'export'.
5012
5013 =cut
5014 sub write_env_file
5015 {
5016 my $exp = $_[2] ? "export " : "";
5017 &open_tempfile(FILE, ">$_[0]");
5018 foreach my $k (keys %{$_[1]}) {
5019         my $v = $_[1]->{$k};
5020         if ($v =~ /^\S+$/) {
5021                 &print_tempfile(FILE, "$exp$k=$v\n");
5022                 }
5023         else {
5024                 &print_tempfile(FILE, "$exp$k=\"$v\"\n");
5025                 }
5026         }
5027 &close_tempfile(FILE);
5028 }
5029
5030 =head2 lock_file(filename, [readonly], [forcefile])
5031
5032 Lock a file for exclusive access. If the file is already locked, spin
5033 until it is freed. Uses a .lock file, which is not 100% reliable, but seems
5034 to work OK. The parameters are :
5035
5036 =item filename - File or directory to lock.
5037
5038 =item readonly - If set, the lock is for reading the file only. More than one script can have a readonly lock, but only one can hold a write lock.
5039
5040 =item forcefile - Force the file to be considered as a real file and not a symlink for Webmin actions logging purposes.
5041
5042 =cut
5043 sub lock_file
5044 {
5045 my $realfile = &translate_filename($_[0]);
5046 return 0 if (!$_[0] || defined($main::locked_file_list{$realfile}));
5047 my $no_lock = !&can_lock_file($realfile);
5048 my $lock_tries_count = 0;
5049 while(1) {
5050         my $pid;
5051         if (!$no_lock && open(LOCKING, "$realfile.lock")) {
5052                 $pid = <LOCKING>;
5053                 $pid = int($pid);
5054                 close(LOCKING);
5055                 }
5056         if ($no_lock || !$pid || !kill(0, $pid) || $pid == $$) {
5057                 # Got the lock!
5058                 if (!$no_lock) {
5059                         # Create the .lock file
5060                         open(LOCKING, ">$realfile.lock") || return 0;
5061                         my $lck = eval "flock(LOCKING, 2+4)";
5062                         if (!$lck && !$@) {
5063                                 # Lock of lock file failed! Wait till later
5064                                 goto tryagain;
5065                                 }
5066                         print LOCKING $$,"\n";
5067                         eval "flock(LOCKING, 8)";
5068                         close(LOCKING);
5069                         }
5070                 $main::locked_file_list{$realfile} = int($_[1]);
5071                 push(@main::temporary_files, "$realfile.lock");
5072                 if (($gconfig{'logfiles'} || $gconfig{'logfullfiles'}) &&
5073                     !&get_module_variable('$no_log_file_changes') &&
5074                     !$_[1]) {
5075                         # Grab a copy of this file for later diffing
5076                         my $lnk;
5077                         $main::locked_file_data{$realfile} = undef;
5078                         if (-d $realfile) {
5079                                 $main::locked_file_type{$realfile} = 1;
5080                                 $main::locked_file_data{$realfile} = '';
5081                                 }
5082                         elsif (!$_[2] && ($lnk = readlink($realfile))) {
5083                                 $main::locked_file_type{$realfile} = 2;
5084                                 $main::locked_file_data{$realfile} = $lnk;
5085                                 }
5086                         elsif (open(ORIGFILE, $realfile)) {
5087                                 $main::locked_file_type{$realfile} = 0;
5088                                 $main::locked_file_data{$realfile} = '';
5089                                 local $_;
5090                                 while(<ORIGFILE>) {
5091                                         $main::locked_file_data{$realfile} .=$_;
5092                                         }
5093                                 close(ORIGFILE);
5094                                 }
5095                         }
5096                 last;
5097                 }
5098 tryagain:
5099         sleep(1);
5100         if ($lock_tries_count++ > 5*60) {
5101                 # Give up after 5 minutes
5102                 &error(&text('elock_tries', "<tt>$realfile</tt>", 5));
5103                 }
5104         }
5105 return 1;
5106 }
5107
5108 =head2 unlock_file(filename)
5109
5110 Release a lock on a file taken out by lock_file. If Webmin actions logging of
5111 file changes is enabled, then at unlock file a diff will be taken between the
5112 old and new contents, and stored under /var/webmin/diffs when webmin_log is
5113 called. This can then be viewed in the Webmin Actions Log module.
5114
5115 =cut
5116 sub unlock_file
5117 {
5118 my $realfile = &translate_filename($_[0]);
5119 return if (!$_[0] || !defined($main::locked_file_list{$realfile}));
5120 unlink("$realfile.lock") if (&can_lock_file($realfile));
5121 delete($main::locked_file_list{$realfile});
5122 if (exists($main::locked_file_data{$realfile})) {
5123         # Diff the new file with the old
5124         stat($realfile);
5125         my $lnk = readlink($realfile);
5126         my $type = -d _ ? 1 : $lnk ? 2 : 0;
5127         my $oldtype = $main::locked_file_type{$realfile};
5128         my $new = !defined($main::locked_file_data{$realfile});
5129         if ($new && !-e _) {
5130                 # file doesn't exist, and never did! do nothing ..
5131                 }
5132         elsif ($new && $type == 1 || !$new && $oldtype == 1) {
5133                 # is (or was) a directory ..
5134                 if (-d _ && !defined($main::locked_file_data{$realfile})) {
5135                         push(@main::locked_file_diff,
5136                              { 'type' => 'mkdir', 'object' => $realfile });
5137                         }
5138                 elsif (!-d _ && defined($main::locked_file_data{$realfile})) {
5139                         push(@main::locked_file_diff,
5140                              { 'type' => 'rmdir', 'object' => $realfile });
5141                         }
5142                 }
5143         elsif ($new && $type == 2 || !$new && $oldtype == 2) {
5144                 # is (or was) a symlink ..
5145                 if ($lnk && !defined($main::locked_file_data{$realfile})) {
5146                         push(@main::locked_file_diff,
5147                              { 'type' => 'symlink', 'object' => $realfile,
5148                                'data' => $lnk });
5149                         }
5150                 elsif (!$lnk && defined($main::locked_file_data{$realfile})) {
5151                         push(@main::locked_file_diff,
5152                              { 'type' => 'unsymlink', 'object' => $realfile,
5153                                'data' => $main::locked_file_data{$realfile} });
5154                         }
5155                 elsif ($lnk ne $main::locked_file_data{$realfile}) {
5156                         push(@main::locked_file_diff,
5157                              { 'type' => 'resymlink', 'object' => $realfile,
5158                                'data' => $lnk });
5159                         }
5160                 }
5161         else {
5162                 # is a file, or has changed type?!
5163                 my ($diff, $delete_file);
5164                 my $type = "modify";
5165                 if (!-r _) {
5166                         open(NEWFILE, ">$realfile");
5167                         close(NEWFILE);
5168                         $delete_file++;
5169                         $type = "delete";
5170                         }
5171                 if (!defined($main::locked_file_data{$realfile})) {
5172                         $type = "create";
5173                         }
5174                 open(ORIGFILE, ">$realfile.webminorig");
5175                 print ORIGFILE $main::locked_file_data{$realfile};
5176                 close(ORIGFILE);
5177                 $diff = &backquote_command(
5178                         "diff ".quotemeta("$realfile.webminorig")." ".
5179                                 quotemeta($realfile)." 2>/dev/null");
5180                 push(@main::locked_file_diff,
5181                      { 'type' => $type, 'object' => $realfile,
5182                        'data' => $diff } ) if ($diff);
5183                 unlink("$realfile.webminorig");
5184                 unlink($realfile) if ($delete_file);
5185                 }
5186
5187         if ($gconfig{'logfullfiles'}) {
5188                 # Add file details to list of those to fully log
5189                 $main::orig_file_data{$realfile} ||=
5190                         $main::locked_file_data{$realfile};
5191                 $main::orig_file_type{$realfile} ||=
5192                         $main::locked_file_type{$realfile};
5193                 }
5194
5195         delete($main::locked_file_data{$realfile});
5196         delete($main::locked_file_type{$realfile});
5197         }
5198 }
5199
5200 =head2 test_lock(file)
5201
5202 Returns 1 if some file is currently locked, 0 if not.
5203
5204 =cut
5205 sub test_lock
5206 {
5207 my $realfile = &translate_filename($_[0]);
5208 return 0 if (!$_[0]);
5209 return 1 if (defined($main::locked_file_list{$realfile}));
5210 return 0 if (!&can_lock_file($realfile));
5211 my $pid;
5212 if (open(LOCKING, "$realfile.lock")) {
5213         $pid = <LOCKING>;
5214         $pid = int($pid);
5215         close(LOCKING);
5216         }
5217 return $pid && kill(0, $pid);
5218 }
5219
5220 =head2 unlock_all_files
5221
5222 Unlocks all files locked by the current script.
5223
5224 =cut
5225 sub unlock_all_files
5226 {
5227 foreach $f (keys %main::locked_file_list) {
5228         &unlock_file($f);
5229         }
5230 }
5231
5232 =head2 can_lock_file(file)
5233
5234 Returns 1 if some file should be locked, based on the settings in the
5235 Webmin Configuration module. For internal use by lock_file only.
5236
5237 =cut
5238 sub can_lock_file
5239 {
5240 if (&is_readonly_mode()) {
5241         return 0;       # never lock in read-only mode
5242         }
5243 elsif ($gconfig{'lockmode'} == 0) {
5244         return 1;       # always
5245         }
5246 elsif ($gconfig{'lockmode'} == 1) {
5247         return 0;       # never
5248         }
5249 else {
5250         # Check if under any of the directories
5251         my $match;
5252         foreach my $d (split(/\t+/, $gconfig{'lockdirs'})) {
5253                 if (&same_file($d, $_[0]) ||
5254                     &is_under_directory($d, $_[0])) {
5255                         $match = 1;
5256                         }
5257                 }
5258         return $gconfig{'lockmode'} == 2 ? $match : !$match;
5259         }
5260 }
5261
5262 =head2 webmin_log(action, type, object, &params, [module], [host, script-on-host, client-ip])
5263
5264 Log some action taken by a user. This is typically called at the end of a
5265 script, once all file changes are complete and all commands run. The
5266 parameters are :
5267
5268 =item action - A short code for the action being performed, like 'create'.
5269
5270 =item type - A code for the type of object the action is performed to, like 'user'.
5271
5272 =item object - A short name for the object, like 'joe' if the Unix user 'joe' was just created.
5273
5274 =item params - A hash ref of additional information about the action.
5275
5276 =item module - Name of the module in which the action was performed, which defaults to the current module.
5277
5278 =item host - Remote host on which the action was performed. You should never need to set this (or the following two parameters), as they are used only for remote Webmin logging.
5279
5280 =item script-on-host - Script name like create_user.cgi on the host the action was performed on.
5281
5282 =item client-ip - IP address of the browser that performed the action.
5283
5284 =cut
5285 sub webmin_log
5286 {
5287 return if (!$gconfig{'log'} || &is_readonly_mode());
5288 my $m = $_[4] ? $_[4] : &get_module_name();
5289
5290 if ($gconfig{'logclear'}) {
5291         # check if it is time to clear the log
5292         my @st = stat("$webmin_logfile.time");
5293         my $write_logtime = 0;
5294         if (@st) {
5295                 if ($st[9]+$gconfig{'logtime'}*60*60 < time()) {
5296                         # clear logfile and all diff files
5297                         &unlink_file("$ENV{'WEBMIN_VAR'}/diffs");
5298                         &unlink_file("$ENV{'WEBMIN_VAR'}/files");
5299                         &unlink_file("$ENV{'WEBMIN_VAR'}/annotations");
5300                         unlink($webmin_logfile);
5301                         $write_logtime = 1;
5302                         }
5303                 }
5304         else {
5305                 $write_logtime = 1;
5306                 }
5307         if ($write_logtime) {
5308                 open(LOGTIME, ">$webmin_logfile.time");
5309                 print LOGTIME time(),"\n";
5310                 close(LOGTIME);
5311                 }
5312         }
5313
5314 # If an action script directory is defined, call the appropriate scripts
5315 if ($gconfig{'action_script_dir'}) {
5316     my ($action, $type, $object) = ($_[0], $_[1], $_[2]);
5317     my ($basedir) = $gconfig{'action_script_dir'};
5318
5319     for my $dir ($basedir/$type/$action, $basedir/$type, $basedir) {
5320         if (-d $dir) {
5321             my ($file);
5322             opendir(DIR, $dir) or die "Can't open $dir: $!";
5323             while (defined($file = readdir(DIR))) {
5324                 next if ($file =~ /^\.\.?$/); # skip '.' and '..'
5325                 if (-x "$dir/$file") {
5326                     # Call a script notifying it of the action
5327                     my %OLDENV = %ENV;
5328                     $ENV{'ACTION_MODULE'} = &get_module_name();
5329                     $ENV{'ACTION_ACTION'} = $_[0];
5330                     $ENV{'ACTION_TYPE'} = $_[1];
5331                     $ENV{'ACTION_OBJECT'} = $_[2];
5332                     $ENV{'ACTION_SCRIPT'} = $script_name;
5333                     foreach my $p (keys %param) {
5334                             $ENV{'ACTION_PARAM_'.uc($p)} = $param{$p};
5335                             }
5336                     system("$dir/$file", @_,
5337                            "<$null_file", ">$null_file", "2>&1");
5338                     %ENV = %OLDENV;
5339                     }
5340                 }
5341             }
5342         }
5343     }
5344
5345 # should logging be done at all?
5346 return if ($gconfig{'logusers'} && &indexof($base_remote_user,
5347            split(/\s+/, $gconfig{'logusers'})) < 0);
5348 return if ($gconfig{'logmodules'} && &indexof($m,
5349            split(/\s+/, $gconfig{'logmodules'})) < 0);
5350
5351 # log the action
5352 my $now = time();
5353 my @tm = localtime($now);
5354 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
5355 my $id = sprintf "%d.%d.%d", $now, $$, $main::action_id_count;
5356 my $idprefix = substr($now, 0, 5);
5357 $main::action_id_count++;
5358 my $line = sprintf "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s %s \"%s\" \"%s\" \"%s\"",
5359         $id, $tm[3], ucfirst($number_to_month_map{$tm[4]}), $tm[5]+1900,
5360         $tm[2], $tm[1], $tm[0],
5361         $remote_user || '-',
5362         $main::session_id || '-',
5363         $_[7] || $ENV{'REMOTE_HOST'} || '-',
5364         $m, $_[5] ? "$_[5]:$_[6]" : $script_name,
5365         $_[0], $_[1] ne '' ? $_[1] : '-', $_[2] ne '' ? $_[2] : '-';
5366 my %param;
5367 foreach my $k (sort { $a cmp $b } keys %{$_[3]}) {
5368         my $v = $_[3]->{$k};
5369         my @pv;
5370         if ($v eq '') {
5371                 $line .= " $k=''";
5372                 @rv = ( "" );
5373                 }
5374         elsif (ref($v) eq 'ARRAY') {
5375                 foreach $vv (@$v) {
5376                         next if (ref($vv));
5377                         push(@pv, $vv);
5378                         $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
5379                         $line .= " $k='$vv'";
5380                         }
5381                 }
5382         elsif (!ref($v)) {
5383                 foreach $vv (split(/\0/, $v)) {
5384                         push(@pv, $vv);
5385                         $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
5386                         $line .= " $k='$vv'";
5387                         }
5388                 }
5389         $param{$k} = join(" ", @pv);
5390         }
5391 open(WEBMINLOG, ">>$webmin_logfile");
5392 print WEBMINLOG $line,"\n";
5393 close(WEBMINLOG);
5394 if ($gconfig{'logperms'}) {
5395         chmod(oct($gconfig{'logperms'}), $webmin_logfile);
5396         }
5397 else {
5398         chmod(0600, $webmin_logfile);
5399         }
5400
5401 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
5402         # Find and record the changes made to any locked files, or commands run
5403         my $i = 0;
5404         mkdir("$ENV{'WEBMIN_VAR'}/diffs", 0700);
5405         foreach my $d (@main::locked_file_diff) {
5406                 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$idprefix", 0700);
5407                 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id", 0700);
5408                 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i");
5409                 print DIFFLOG "$d->{'type'} $d->{'object'}\n";
5410                 print DIFFLOG $d->{'data'};
5411                 close(DIFFLOG);
5412                 if ($d->{'input'}) {
5413                         open(DIFFLOG,
5414                           ">$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i.input");
5415                         print DIFFLOG $d->{'input'};
5416                         close(DIFFLOG);
5417                         }
5418                 if ($gconfig{'logperms'}) {
5419                         chmod(oct($gconfig{'logperms'}),
5420                              "$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i",
5421                              "$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i.input");
5422                         }
5423                 $i++;
5424                 }
5425         @main::locked_file_diff = undef;
5426         }
5427
5428 if ($gconfig{'logfullfiles'}) {
5429         # Save the original contents of any modified files
5430         my $i = 0;
5431         mkdir("$ENV{'WEBMIN_VAR'}/files", 0700);
5432         foreach my $f (keys %main::orig_file_data) {
5433                 mkdir("$ENV{'WEBMIN_VAR'}/files/$idprefix", 0700);
5434                 mkdir("$ENV{'WEBMIN_VAR'}/files/$idprefix/$id", 0700);
5435                 open(ORIGLOG, ">$ENV{'WEBMIN_VAR'}/files/$idprefix/$id/$i");
5436                 if (!defined($main::orig_file_type{$f})) {
5437                         print ORIGLOG -1," ",$f,"\n";
5438                         }
5439                 else {
5440                         print ORIGLOG $main::orig_file_type{$f}," ",$f,"\n";
5441                         }
5442                 print ORIGLOG $main::orig_file_data{$f};
5443                 close(ORIGLOG);
5444                 if ($gconfig{'logperms'}) {
5445                         chmod(oct($gconfig{'logperms'}),
5446                               "$ENV{'WEBMIN_VAR'}/files/$idprefix/$id.$i");
5447                         }
5448                 $i++;
5449                 }
5450         %main::orig_file_data = undef;
5451         %main::orig_file_type = undef;
5452         }
5453
5454 if ($miniserv::page_capture_out) {
5455         # Save the whole page output
5456         mkdir("$ENV{'WEBMIN_VAR'}/output", 0700);
5457         mkdir("$ENV{'WEBMIN_VAR'}/output/$idprefix", 0700);
5458         open(PAGEOUT, ">$ENV{'WEBMIN_VAR'}/output/$idprefix/$id");
5459         print PAGEOUT $miniserv::page_capture_out;
5460         close(PAGEOUT);
5461         if ($gconfig{'logperms'}) {
5462                 chmod(oct($gconfig{'logperms'}),
5463                       "$ENV{'WEBMIN_VAR'}/output/$idprefix/$id");
5464                 }
5465         $miniserv::page_capture_out = undef;
5466         }
5467
5468 # Log to syslog too
5469 if ($gconfig{'logsyslog'}) {
5470         eval 'use Sys::Syslog qw(:DEFAULT setlogsock);
5471               openlog(&get_product_name(), "cons,pid,ndelay", "daemon");
5472               setlogsock("inet");';
5473         if (!$@) {
5474                 # Syslog module is installed .. try to convert to a
5475                 # human-readable form
5476                 my $msg;
5477                 my $mod = &get_module_name();
5478                 my $mdir = module_root_directory($mod);
5479                 if (-r "$mdir/log_parser.pl") {
5480                         &foreign_require($mod, "log_parser.pl");
5481                         my %params;
5482                         foreach my $k (keys %{$_[3]}) {
5483                                 my $v = $_[3]->{$k};
5484                                 if (ref($v) eq 'ARRAY') {
5485                                         $params{$k} = join("\0", @$v);
5486                                         }
5487                                 else {
5488                                         $params{$k} = $v;
5489                                         }
5490                                 }
5491                         $msg = &foreign_call($mod, "parse_webmin_log",
5492                                 $remote_user, $script_name,
5493                                 $_[0], $_[1], $_[2], \%params);
5494                         $msg =~ s/<[^>]*>//g;   # Remove tags
5495                         }
5496                 elsif ($_[0] eq "_config_") {
5497                         my %wtext = &load_language("webminlog");
5498                         $msg = $wtext{'search_config'};
5499                         }
5500                 $msg ||= "$_[0] $_[1] $_[2]";
5501                 my %info = &get_module_info($m);
5502                 eval { syslog("info", "%s", "[$info{'desc'}] $msg"); };
5503                 }
5504         }
5505 }
5506
5507 =head2 additional_log(type, object, data, [input])
5508
5509 Records additional log data for an upcoming call to webmin_log, such
5510 as a command that was run or SQL that was executed. Typically you will never
5511 need to call this function directory.
5512
5513 =cut
5514 sub additional_log
5515 {
5516 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
5517         push(@main::locked_file_diff,
5518              { 'type' => $_[0], 'object' => $_[1], 'data' => $_[2],
5519                'input' => $_[3] } );
5520         }
5521 }
5522
5523 =head2 webmin_debug_log(type, message)
5524
5525 Write something to the Webmin debug log. For internal use only.
5526
5527 =cut
5528 sub webmin_debug_log
5529 {
5530 my ($type, $msg) = @_;
5531 return 0 if (!$main::opened_debug_log);
5532 return 0 if ($gconfig{'debug_no'.$main::webmin_script_type});
5533 if ($gconfig{'debug_modules'}) {
5534         my @dmods = split(/\s+/, $gconfig{'debug_modules'});
5535         return 0 if (&indexof($main::initial_module_name, @dmods) < 0);
5536         }
5537 my $now;
5538 eval 'use Time::HiRes qw(gettimeofday); ($now, $ms) = gettimeofday';
5539 $now ||= time();
5540 my @tm = localtime($now);
5541 my $line = sprintf
5542         "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d.%6.6d] %s %s %s %s \"%s\"",
5543         $$, $tm[3], ucfirst($number_to_month_map{$tm[4]}), $tm[5]+1900,
5544         $tm[2], $tm[1], $tm[0], $ms,
5545         $remote_user || "-",
5546         $ENV{'REMOTE_HOST'} || "-",
5547         &get_module_name() || "-",
5548         $type,
5549         $msg;
5550 seek(main::DEBUGLOG, 0, 2);
5551 print main::DEBUGLOG $line."\n";
5552 return 1;
5553 }
5554
5555 =head2 system_logged(command)
5556
5557 Just calls the Perl system() function, but also logs the command run.
5558
5559 =cut
5560 sub system_logged
5561 {
5562 if (&is_readonly_mode()) {
5563         print STDERR "Vetoing command $_[0]\n";
5564         return 0;
5565         }
5566 my @realcmd = ( &translate_command($_[0]), @_[1..$#_] );
5567 my $cmd = join(" ", @realcmd);
5568 my $and;
5569 if ($cmd =~ s/(\s*&\s*)$//) {
5570         $and = $1;
5571         }
5572 while($cmd =~ s/(\d*)(<|>)((\/(tmp|dev)\S+)|&\d+)\s*$//) { }
5573 $cmd =~ s/^\((.*)\)\s*$/$1/;
5574 $cmd .= $and;
5575 &additional_log('exec', undef, $cmd);
5576 return system(@realcmd);
5577 }
5578
5579 =head2 backquote_logged(command)
5580
5581 Executes a command and returns the output (like `command`), but also logs it.
5582
5583 =cut
5584 sub backquote_logged
5585 {
5586 if (&is_readonly_mode()) {
5587         $? = 0;
5588         print STDERR "Vetoing command $_[0]\n";
5589         return undef;
5590         }
5591 my $realcmd = &translate_command($_[0]);
5592 my $cmd = $realcmd;
5593 my $and;
5594 if ($cmd =~ s/(\s*&\s*)$//) {
5595         $and = $1;
5596         }
5597 while($cmd =~ s/(\d*)(<|>)((\/(tmp\/.webmin|dev)\S+)|&\d+)\s*$//) { }
5598 $cmd =~ s/^\((.*)\)\s*$/$1/;
5599 $cmd .= $and;
5600 &additional_log('exec', undef, $cmd);
5601 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
5602 return `$realcmd`;
5603 }
5604
5605 =head2 backquote_with_timeout(command, timeout, safe?, [maxlines])
5606
5607 Runs some command, waiting at most the given number of seconds for it to
5608 complete, and returns the output. The maxlines parameter sets the number
5609 of lines of output to capture. The safe parameter should be set to 1 if the
5610 command is safe for read-only mode users to run.
5611
5612 =cut
5613 sub backquote_with_timeout
5614 {
5615 my $realcmd = &translate_command($_[0]);
5616 &webmin_debug_log('CMD', "cmd=$realcmd timeout=$_[1]")
5617         if ($gconfig{'debug_what_cmd'});
5618 my $out;
5619 my $pid = &open_execute_command(OUT, "($realcmd) <$null_file", 1, $_[2]);
5620 my $start = time();
5621 my $timed_out = 0;
5622 my $linecount = 0;
5623 while(1) {
5624         my $elapsed = time() - $start;
5625         last if ($elapsed > $_[1]);
5626         my $rmask;
5627         vec($rmask, fileno(OUT), 1) = 1;
5628         my $sel = select($rmask, undef, undef, $_[1] - $elapsed);
5629         last if (!$sel || $sel < 0);
5630         my $line = <OUT>;
5631         last if (!defined($line));
5632         $out .= $line;
5633         $linecount++;
5634         if ($_[3] && $linecount >= $_[3]) {
5635                 # Got enough lines
5636                 last;
5637                 }
5638         }
5639 if (kill('TERM', $pid) && time() - $start >= $_[1]) {
5640         $timed_out = 1;
5641         }
5642 close(OUT);
5643 return wantarray ? ($out, $timed_out) : $out;
5644 }
5645
5646 =head2 backquote_command(command, safe?)
5647
5648 Executes a command and returns the output (like `command`), subject to
5649 command translation. The safe parameter should be set to 1 if the command
5650 is safe for read-only mode users to run.
5651
5652 =cut
5653 sub backquote_command
5654 {
5655 if (&is_readonly_mode() && !$_[1]) {
5656         print STDERR "Vetoing command $_[0]\n";
5657         $? = 0;
5658         return undef;
5659         }
5660 my $realcmd = &translate_command($_[0]);
5661 &webmin_debug_log('CMD', "cmd=$realcmd") if ($gconfig{'debug_what_cmd'});
5662 return `$realcmd`;
5663 }
5664
5665 =head2 kill_logged(signal, pid, ...)
5666
5667 Like Perl's built-in kill function, but also logs the fact that some process
5668 was killed. On Windows, falls back to calling process.exe to terminate a
5669 process.
5670
5671 =cut
5672 sub kill_logged
5673 {
5674 return scalar(@_)-1 if (&is_readonly_mode());
5675 &webmin_debug_log('KILL', "signal=$_[0] pids=".join(" ", @_[1..@_-1]))
5676         if ($gconfig{'debug_what_procs'});
5677 &additional_log('kill', $_[0], join(" ", @_[1..@_-1])) if (@_ > 1);
5678 if ($gconfig{'os_type'} eq 'windows') {
5679         # Emulate some kills with process.exe
5680         my $arg = $_[0] eq "KILL" ? "-k" :
5681                   $_[0] eq "TERM" ? "-q" :
5682                   $_[0] eq "STOP" ? "-s" :
5683                   $_[0] eq "CONT" ? "-r" : undef;
5684         my $ok = 0;
5685         foreach my $p (@_[1..@_-1]) {
5686                 if ($p < 0) {
5687                         $ok ||= kill($_[0], $p);
5688                         }
5689                 elsif ($arg) {
5690                         &execute_command("process $arg $p");
5691                         $ok = 1;
5692                         }
5693                 }
5694         return $ok;
5695         }
5696 else {
5697         # Normal Unix kill
5698         return kill(@_);
5699         }
5700 }
5701
5702 =head2 rename_logged(old, new)
5703
5704 Re-names a file and logs the rename. If the old and new files are on different
5705 filesystems, calls mv or the Windows rename function to do the job.
5706
5707 =cut
5708 sub rename_logged
5709 {
5710 &additional_log('rename', $_[0], $_[1]) if ($_[0] ne $_[1]);
5711 return &rename_file($_[0], $_[1]);
5712 }
5713
5714 =head2 rename_file(old, new)
5715
5716 Renames a file or directory. If the old and new files are on different
5717 filesystems, calls mv or the Windows rename function to do the job.
5718
5719 =cut
5720 sub rename_file
5721 {
5722 if (&is_readonly_mode()) {
5723         print STDERR "Vetoing rename from $_[0] to $_[1]\n";
5724         return 1;
5725         }
5726 my $src = &translate_filename($_[0]);
5727 my $dst = &translate_filename($_[1]);
5728 &webmin_debug_log('RENAME', "src=$src dst=$dst")
5729         if ($gconfig{'debug_what_ops'});
5730 my $ok = rename($src, $dst);
5731 if (!$ok && $! !~ /permission/i) {
5732         # Try the mv command, in case this is a cross-filesystem rename
5733         if ($gconfig{'os_type'} eq 'windows') {
5734                 # Need to use rename
5735                 my $out = &backquote_command("rename ".quotemeta($_[0]).
5736                                              " ".quotemeta($_[1])." 2>&1");
5737                 $ok = !$?;
5738                 $! = $out if (!$ok);
5739                 }
5740         else {
5741                 # Can use mv
5742                 my $out = &backquote_command("mv ".quotemeta($_[0]).
5743                                              " ".quotemeta($_[1])." 2>&1");
5744                 $ok = !$?;
5745                 $! = $out if (!$ok);
5746                 }
5747         }
5748 return $ok;
5749 }
5750
5751 =head2 symlink_logged(src, dest)
5752
5753 Create a symlink, and logs it. Effectively does the same thing as the Perl
5754 symlink function.
5755
5756 =cut
5757 sub symlink_logged
5758 {
5759 &lock_file($_[1]);
5760 my $rv = &symlink_file($_[0], $_[1]);
5761 &unlock_file($_[1]);
5762 return $rv;
5763 }
5764
5765 =head2 symlink_file(src, dest)
5766
5767 Creates a soft link, unless in read-only mode. Effectively does the same thing
5768 as the Perl symlink function.
5769
5770 =cut
5771 sub symlink_file
5772 {
5773 if (&is_readonly_mode()) {
5774         print STDERR "Vetoing symlink from $_[0] to $_[1]\n";
5775         return 1;
5776         }
5777 my $src = &translate_filename($_[0]);
5778 my $dst = &translate_filename($_[1]);
5779 &webmin_debug_log('SYMLINK', "src=$src dst=$dst")
5780         if ($gconfig{'debug_what_ops'});
5781 return symlink($src, $dst);
5782 }
5783
5784 =head2 link_file(src, dest)
5785
5786 Creates a hard link, unless in read-only mode. The existing new link file
5787 will be deleted if necessary. Effectively the same as Perl's link function.
5788
5789 =cut
5790 sub link_file
5791 {
5792 if (&is_readonly_mode()) {
5793         print STDERR "Vetoing link from $_[0] to $_[1]\n";
5794         return 1;
5795         }
5796 my $src = &translate_filename($_[0]);
5797 my $dst = &translate_filename($_[1]);
5798 &webmin_debug_log('LINK', "src=$src dst=$dst")
5799         if ($gconfig{'debug_what_ops'});
5800 unlink($dst);                   # make sure link works
5801 return link($src, $dst);
5802 }
5803
5804 =head2 make_dir(dir, perms, recursive)
5805
5806 Creates a directory and sets permissions on it, unless in read-only mode.
5807 The perms parameter sets the octal permissions to apply, which unlike Perl's
5808 mkdir will really get set. The recursive flag can be set to 1 to have the
5809 function create parent directories too.
5810
5811 =cut
5812 sub make_dir
5813 {
5814 my ($dir, $perms, $recur) = @_;
5815 if (&is_readonly_mode()) {
5816         print STDERR "Vetoing directory $dir\n";
5817         return 1;
5818         }
5819 $dir = &translate_filename($dir);
5820 my $exists = -d $dir ? 1 : 0;
5821 return 1 if ($exists && $recur);        # already exists
5822 &webmin_debug_log('MKDIR', $dir) if ($gconfig{'debug_what_ops'});
5823 my $rv = mkdir($dir, $perms);
5824 if (!$rv && $recur) {
5825         # Failed .. try mkdir -p
5826         my $param = $gconfig{'os_type'} eq 'windows' ? "" : "-p";
5827         my $ex = &execute_command("mkdir $param ".&quote_path($dir));
5828         if ($ex) {
5829                 return 0;
5830                 }
5831         }
5832 if (!$exists) {
5833         chmod($perms, $dir);
5834         }
5835 return 1;
5836 }
5837
5838 =head2 set_ownership_permissions(user, group, perms, file, ...)
5839
5840 Sets the user, group owner and permissions on some files. The parameters are :
5841
5842 =item user - UID or username to change the file owner to. If undef, then the owner is not changed.
5843
5844 =item group - GID or group name to change the file group to. If undef, then the group is set to the user's primary group.
5845
5846 =item perms - Octal permissions set to set on the file. If undef, they are left alone.
5847
5848 =item file - One or more files or directories to modify.
5849
5850 =cut
5851 sub set_ownership_permissions
5852 {
5853 my ($user, $group, $perms, @files) = @_;
5854 if (&is_readonly_mode()) {
5855         print STDERR "Vetoing permission changes on ",join(" ", @files),"\n";
5856         return 1;
5857         }
5858 @files = map { &translate_filename($_) } @files;
5859 if ($gconfig{'debug_what_ops'}) {
5860         foreach my $f (@files) {
5861                 &webmin_debug_log('PERMS',
5862                         "file=$f user=$user group=$group perms=$perms");
5863                 }
5864         }
5865 my $rv = 1;
5866 if (defined($user)) {
5867         my $uid = $user !~ /^\d+$/ ? getpwnam($user) : $user;
5868         my $gid;
5869         if (defined($group)) {
5870                 $gid = $group !~ /^\d+$/ ? getgrnam($group) : $group;
5871                 }
5872         else {
5873                 my @uinfo = getpwuid($uid);
5874                 $gid = $uinfo[3];
5875                 }
5876         $rv = chown($uid, $gid, @files);
5877         }
5878 if ($rv && defined($perms)) {
5879         $rv = chmod($perms, @files);
5880         }
5881 return $rv;
5882 }
5883
5884 =head2 unlink_logged(file, ...)
5885
5886 Like Perl's unlink function, but locks the files beforehand and un-locks them
5887 after so that the deletion is logged by Webmin.
5888
5889 =cut
5890 sub unlink_logged
5891 {
5892 my %locked;
5893 foreach my $f (@_) {
5894         if (!&test_lock($f)) {
5895                 &lock_file($f);
5896                 $locked{$f} = 1;
5897                 }
5898         }
5899 my @rv = &unlink_file(@_);
5900 foreach my $f (@_) {
5901         if ($locked{$f}) {
5902                 &unlock_file($f);
5903                 }
5904         }
5905 return wantarray ? @rv : $rv[0];
5906 }
5907
5908 =head2 unlink_file(file, ...)
5909
5910 Deletes some files or directories. Like Perl's unlink function, but also
5911 recursively deletes directories with the rm command if needed.
5912
5913 =cut
5914 sub unlink_file
5915 {
5916 return 1 if (&is_readonly_mode());
5917 my $rv = 1;
5918 my $err;
5919 foreach my $f (@_) {
5920         &unflush_file_lines($f);
5921         my $realf = &translate_filename($f);
5922         &webmin_debug_log('UNLINK', $realf) if ($gconfig{'debug_what_ops'});
5923         if (-d $realf) {
5924                 if (!rmdir($realf)) {
5925                         my $out;
5926                         if ($gconfig{'os_type'} eq 'windows') {
5927                                 # Call del and rmdir commands
5928                                 my $qm = $realf;
5929                                 $qm =~ s/\//\\/g;
5930                                 my $out = `del /q "$qm" 2>&1`;
5931                                 if (!$?) {
5932                                         $out = `rmdir "$qm" 2>&1`;
5933                                         }
5934                                 }
5935                         else {
5936                                 # Use rm command
5937                                 my $qm = quotemeta($realf);
5938                                 $out = `rm -rf $qm 2>&1`;
5939                                 }
5940                         if ($?) {
5941                                 $rv = 0;
5942                                 $err = $out;
5943                                 }
5944                         }
5945                 }
5946         else {
5947                 if (!unlink($realf)) {
5948                         $rv = 0;
5949                         $err = $!;
5950                         }
5951                 }
5952         }
5953 return wantarray ? ($rv, $err) : $rv;
5954 }
5955
5956 =head2 copy_source_dest(source, dest)
5957
5958 Copy some file or directory to a new location. Returns 1 on success, or 0
5959 on failure - also sets $! on failure. If the source is a directory, uses
5960 piped tar commands to copy a whole directory structure including permissions
5961 and special files.
5962
5963 =cut
5964 sub copy_source_dest
5965 {
5966 return (1, undef) if (&is_readonly_mode());
5967 my ($src, $dst) = @_;
5968 my $ok = 1;
5969 my ($err, $out);
5970 &webmin_debug_log('COPY', "src=$src dst=$dst")
5971         if ($gconfig{'debug_what_ops'});
5972 if ($gconfig{'os_type'} eq 'windows') {
5973         # No tar or cp on windows, so need to use copy command
5974         $src =~ s/\//\\/g;
5975         $dst =~ s/\//\\/g;
5976         if (-d $src) {
5977                 $out = &backquote_logged("xcopy \"$src\" \"$dst\" /Y /E /I 2>&1");
5978                 }
5979         else {
5980                 $out = &backquote_logged("copy /Y \"$src\" \"$dst\" 2>&1");
5981                 }
5982         if ($?) {
5983                 $ok = 0;
5984                 $err = $out;
5985                 }
5986         }
5987 elsif (-d $src) {
5988         # A directory .. need to copy with tar command
5989         my @st = stat($src);
5990         unlink($dst);
5991         mkdir($dst, 0755);
5992         &set_ownership_permissions($st[4], $st[5], $st[2], $dst);
5993         $out = &backquote_logged("(cd ".quotemeta($src)." ; tar cf - . | (cd ".quotemeta($dst)." ; tar xf -)) 2>&1");
5994         if ($?) {
5995                 $ok = 0;
5996                 $err = $out;
5997                 }
5998         }
5999 else {
6000         # Can just copy with cp
6001         my $out = &backquote_logged("cp -p ".quotemeta($src).
6002                                     " ".quotemeta($dst)." 2>&1");
6003         if ($?) {
6004                 $ok = 0;
6005                 $err = $out;
6006                 }
6007         }
6008 return wantarray ? ($ok, $err) : $ok;
6009 }
6010
6011 =head2 remote_session_name(host|&server)
6012
6013 Generates a session ID for some server. For this server, this will always
6014 be an empty string. For a server object it will include the hostname and
6015 port and PID. For a server name, it will include the hostname and PID. For
6016 internal use only.
6017
6018 =cut
6019 sub remote_session_name
6020 {
6021 return ref($_[0]) && $_[0]->{'host'} && $_[0]->{'port'} ?
6022                 "$_[0]->{'host'}:$_[0]->{'port'}.$$" :
6023        $_[0] eq "" || ref($_[0]) && $_[0]->{'id'} == 0 ? "" :
6024        ref($_[0]) ? "" : "$_[0].$$";
6025 }
6026
6027 =head2 remote_foreign_require(server, module, file)
6028
6029 Connects to rpc.cgi on a remote webmin server and have it open a session
6030 to a process that will actually do the require and run functions. This is the
6031 equivalent for foreign_require, but for a remote Webmin system. The server
6032 parameter can either be a hostname of a system registered in the Webmin
6033 Servers Index module, or a hash reference for a system from that module.
6034
6035 =cut
6036 sub remote_foreign_require
6037 {
6038 my $call = { 'action' => 'require',
6039              'module' => $_[1],
6040              'file' => $_[2] };
6041 my $sn = &remote_session_name($_[0]);
6042 if ($remote_session{$sn}) {
6043         $call->{'session'} = $remote_session{$sn};
6044         }
6045 else {
6046         $call->{'newsession'} = 1;
6047         }
6048 my $rv = &remote_rpc_call($_[0], $call);
6049 if ($rv->{'session'}) {
6050         $remote_session{$sn} = $rv->{'session'};
6051         $remote_session_server{$sn} = $_[0];
6052         }
6053 }
6054
6055 =head2 remote_foreign_call(server, module, function, [arg]*)
6056
6057 Call a function on a remote server. Must have been setup first with
6058 remote_foreign_require for the same server and module. Equivalent to
6059 foreign_call, but with the extra server parameter to specify the remote
6060 system's hostname.
6061
6062 =cut
6063 sub remote_foreign_call
6064 {
6065 return undef if (&is_readonly_mode());
6066 my $sn = &remote_session_name($_[0]);
6067 return &remote_rpc_call($_[0], { 'action' => 'call',
6068                                  'module' => $_[1],
6069                                  'func' => $_[2],
6070                                  'session' => $remote_session{$sn},
6071                                  'args' => [ @_[3 .. $#_] ] } );
6072 }
6073
6074 =head2 remote_foreign_check(server, module, [api-only])
6075
6076 Checks if some module is installed and supported on a remote server. Equivilant
6077 to foreign_check, but for the remote Webmin system specified by the server
6078 parameter.
6079
6080 =cut
6081 sub remote_foreign_check
6082 {
6083 return &remote_rpc_call($_[0], { 'action' => 'check',
6084                                  'module' => $_[1],
6085                                  'api' => $_[2] });
6086 }
6087
6088 =head2 remote_foreign_config(server, module)
6089
6090 Gets the configuration for some module from a remote server, as a hash.
6091 Equivalent to foreign_config, but for a remote system.
6092
6093 =cut
6094 sub remote_foreign_config
6095 {
6096 return &remote_rpc_call($_[0], { 'action' => 'config',
6097                                  'module' => $_[1] });
6098 }
6099
6100 =head2 remote_eval(server, module, code)
6101
6102 Evaluates some perl code in the context of a module on a remote webmin server.
6103 The server parameter must be the hostname of a remote system, module must
6104 be a module directory name, and code a string of Perl code to run. This can
6105 only be called after remote_foreign_require for the same server and module.
6106
6107 =cut
6108 sub remote_eval
6109 {
6110 return undef if (&is_readonly_mode());
6111 my $sn = &remote_session_name($_[0]);
6112 return &remote_rpc_call($_[0], { 'action' => 'eval',
6113                                  'module' => $_[1],
6114                                  'code' => $_[2],
6115                                  'session' => $remote_session{$sn} });
6116 }
6117
6118 =head2 remote_write(server, localfile, [remotefile], [remotebasename])
6119
6120 Transfers some local file to another server via Webmin's RPC protocol, and
6121 returns the resulting remote filename. If the remotefile parameter is given,
6122 that is the destination filename which will be used. Otherwise a randomly
6123 selected temporary filename will be used, and returned by the function.
6124
6125 =cut
6126 sub remote_write
6127 {
6128 return undef if (&is_readonly_mode());
6129 my ($data, $got);
6130 my $sn = &remote_session_name($_[0]);
6131 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
6132         # Copy data over TCP connection
6133         my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpwrite',
6134                                            'file' => $_[2],
6135                                            'name' => $_[3] } );
6136         my $error;
6137         my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
6138         &open_socket($serv || "localhost", $rv->[1], TWRITE, \$error);
6139         return &$main::remote_error_handler("Failed to transfer file : $error")
6140                 if ($error);
6141         open(FILE, $_[1]);
6142         while(read(FILE, $got, 1024) > 0) {
6143                 print TWRITE $got;
6144                 }
6145         close(FILE);
6146         shutdown(TWRITE, 1);
6147         $error = <TWRITE>;
6148         if ($error && $error !~ /^OK/) {
6149                 # Got back an error!
6150                 return &$main::remote_error_handler("Failed to transfer file : $error");
6151                 }
6152         close(TWRITE);
6153         return $rv->[0];
6154         }
6155 else {
6156         # Just pass file contents as parameters
6157         open(FILE, $_[1]);
6158         while(read(FILE, $got, 1024) > 0) {
6159                 $data .= $got;
6160                 }
6161         close(FILE);
6162         return &remote_rpc_call($_[0], { 'action' => 'write',
6163                                          'data' => $data,
6164                                          'file' => $_[2],
6165                                          'session' => $remote_session{$sn} });
6166         }
6167 }
6168
6169 =head2 remote_read(server, localfile, remotefile)
6170
6171 Transfers a file from a remote server to this system, using Webmin's RPC
6172 protocol. The server parameter must be the hostname of a system registered
6173 in the Webmin Servers Index module, localfile is the destination path on this
6174 system, and remotefile is the file to fetch from the remote server.
6175
6176 =cut
6177 sub remote_read
6178 {
6179 my $sn = &remote_session_name($_[0]);
6180 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
6181         # Copy data over TCP connection
6182         my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpread',
6183                                            'file' => $_[2] } );
6184         if (!$rv->[0]) {
6185                 return &$main::remote_error_handler("Failed to transfer file : $rv->[1]");
6186                 }
6187         my $error;
6188         my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
6189         &open_socket($serv || "localhost", $rv->[1], TREAD, \$error);
6190         return &$main::remote_error_handler("Failed to transfer file : $error")
6191                 if ($error);
6192         my $got;
6193         open(FILE, ">$_[1]");
6194         while(read(TREAD, $got, 1024) > 0) {
6195                 print FILE $got;
6196                 }
6197         close(FILE);
6198         close(TREAD);
6199         }
6200 else {
6201         # Just get data as return value
6202         my $d = &remote_rpc_call($_[0], { 'action' => 'read',
6203                                           'file' => $_[2],
6204                                           'session' => $remote_session{$sn} });
6205         open(FILE, ">$_[1]");
6206         print FILE $d;
6207         close(FILE);
6208         }
6209 }
6210
6211 =head2 remote_finished
6212
6213 Close all remote sessions. This happens automatically after a while
6214 anyway, but this function should be called to clean things up faster.
6215
6216 =cut
6217 sub remote_finished
6218 {
6219 foreach my $sn (keys %remote_session) {
6220         my $server = $remote_session_server{$sn};
6221         &remote_rpc_call($server, { 'action' => 'quit',
6222                                     'session' => $remote_session{$sn} } );
6223         delete($remote_session{$sn});
6224         delete($remote_session_server{$sn});
6225         }
6226 foreach my $fh (keys %fast_fh_cache) {
6227         close($fh);
6228         delete($fast_fh_cache{$fh});
6229         }
6230 }
6231
6232 =head2 remote_error_setup(&function)
6233
6234 Sets a function to be called instead of &error when a remote RPC operation
6235 fails. Useful if you want to have more control over your remote operations.
6236
6237 =cut
6238 sub remote_error_setup
6239 {
6240 $main::remote_error_handler = $_[0] || \&error;
6241 }
6242
6243 =head2 remote_rpc_call(server, &structure)
6244
6245 Calls rpc.cgi on some server and passes it a perl structure (hash,array,etc)
6246 and then reads back a reply structure. This is mainly for internal use only,
6247 and is called by the other remote_* functions.
6248
6249 =cut
6250 sub remote_rpc_call
6251 {
6252 my $serv;
6253 my $sn = &remote_session_name($_[0]);   # Will be undef for local connection
6254 if (ref($_[0])) {
6255         # Server structure was given
6256         $serv = $_[0];
6257         $serv->{'user'} || $serv->{'id'} == 0 ||
6258                 return &$main::remote_error_handler(
6259                         "No Webmin login set for server");
6260         }
6261 elsif ($_[0]) {
6262         # lookup the server in the webmin servers module if needed
6263         if (!%main::remote_servers_cache) {
6264                 &foreign_require("servers", "servers-lib.pl");
6265                 foreach $s (&foreign_call("servers", "list_servers")) {
6266                         $main::remote_servers_cache{$s->{'host'}} = $s;
6267                         $main::remote_servers_cache{$s->{'host'}.":".$s->{'port'}} = $s;
6268                         }
6269                 }
6270         $serv = $main::remote_servers_cache{$_[0]};
6271         $serv || return &$main::remote_error_handler(
6272                                 "No Webmin Servers entry for $_[0]");
6273         $serv->{'user'} || return &$main::remote_error_handler(
6274                                 "No login set for server $_[0]");
6275         }
6276 my $ip = $serv->{'ip'} || $serv->{'host'};
6277
6278 # Work out the username and password
6279 my ($user, $pass);
6280 if ($serv->{'sameuser'}) {
6281         $user = $remote_user;
6282         defined($main::remote_pass) || return &$main::remote_error_handler(
6283                                    "Password for this server is not available");
6284         $pass = $main::remote_pass;
6285         }
6286 else {
6287         $user = $serv->{'user'};
6288         $pass = $serv->{'pass'};
6289         }
6290
6291 if ($serv->{'fast'} || !$sn) {
6292         # Make TCP connection call to fastrpc.cgi
6293         if (!$fast_fh_cache{$sn} && $sn) {
6294                 # Need to open the connection
6295                 my $con = &make_http_connection(
6296                         $ip, $serv->{'port'}, $serv->{'ssl'},
6297                         "POST", "/fastrpc.cgi");
6298                 return &$main::remote_error_handler(
6299                     "Failed to connect to $serv->{'host'} : $con")
6300                         if (!ref($con));
6301                 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
6302                 &write_http_connection($con, "User-agent: Webmin\r\n");
6303                 my $auth = &encode_base64("$user:$pass");
6304                 $auth =~ tr/\n//d;
6305                 &write_http_connection($con, "Authorization: basic $auth\r\n");
6306                 &write_http_connection($con, "Content-length: ",
6307                                              length($tostr),"\r\n");
6308                 &write_http_connection($con, "\r\n");
6309                 &write_http_connection($con, $tostr);
6310
6311                 # read back the response
6312                 my $line = &read_http_connection($con);
6313                 $line =~ tr/\r\n//d;
6314                 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
6315                         return &$main::remote_error_handler("Login to RPC server as $user rejected");
6316                         }
6317                 $line =~ /^HTTP\/1\..\s+200\s+/ ||
6318                         return &$main::remote_error_handler("HTTP error : $line");
6319                 do {
6320                         $line = &read_http_connection($con);
6321                         $line =~ tr/\r\n//d;
6322                         } while($line);
6323                 $line = &read_http_connection($con);
6324                 if ($line =~ /^0\s+(.*)/) {
6325                         return &$main::remote_error_handler("RPC error : $1");
6326                         }
6327                 elsif ($line =~ /^1\s+(\S+)\s+(\S+)\s+(\S+)/ ||
6328                        $line =~ /^1\s+(\S+)\s+(\S+)/) {
6329                         # Started ok .. connect and save SID
6330                         &close_http_connection($con);
6331                         my ($port, $sid, $version, $error) = ($1, $2, $3);
6332                         &open_socket($ip, $port, $sid, \$error);
6333                         return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error")
6334                                 if ($error);
6335                         $fast_fh_cache{$sn} = $sid;
6336                         $remote_server_version{$sn} = $version;
6337                         }
6338                 else {
6339                         while($stuff = &read_http_connection($con)) {
6340                                 $line .= $stuff;
6341                                 }
6342                         return &$main::remote_error_handler("Bad response from fastrpc.cgi : $line");
6343                         }
6344                 }
6345         elsif (!$fast_fh_cache{$sn}) {
6346                 # Open the connection by running fastrpc.cgi locally
6347                 pipe(RPCOUTr, RPCOUTw);
6348                 if (!fork()) {
6349                         untie(*STDIN);
6350                         untie(*STDOUT);
6351                         open(STDOUT, ">&RPCOUTw");
6352                         close(STDIN);
6353                         close(RPCOUTr);
6354                         $| = 1;
6355                         $ENV{'REQUEST_METHOD'} = 'GET';
6356                         $ENV{'SCRIPT_NAME'} = '/fastrpc.cgi';
6357                         $ENV{'SERVER_ROOT'} ||= $root_directory;
6358                         my %acl;
6359                         if ($base_remote_user ne 'root' &&
6360                             $base_remote_user ne 'admin') {
6361                                 # Need to fake up a login for the CGI!
6362                                 &read_acl(undef, \%acl, [ 'root' ]);
6363                                 $ENV{'BASE_REMOTE_USER'} =
6364                                         $ENV{'REMOTE_USER'} =
6365                                                 $acl{'root'} ? 'root' : 'admin';
6366                                 }
6367                         delete($ENV{'FOREIGN_MODULE_NAME'});
6368                         delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
6369                         chdir($root_directory);
6370                         if (!exec("$root_directory/fastrpc.cgi")) {
6371                                 print "exec failed : $!\n";
6372                                 exit 1;
6373                                 }
6374                         }
6375                 close(RPCOUTw);
6376                 my $line;
6377                 do {
6378                         ($line = <RPCOUTr>) =~ tr/\r\n//d;
6379                         } while($line);
6380                 $line = <RPCOUTr>;
6381                 #close(RPCOUTr);
6382                 if ($line =~ /^0\s+(.*)/) {
6383                         return &$main::remote_error_handler("RPC error : $2");
6384                         }
6385                 elsif ($line =~ /^1\s+(\S+)\s+(\S+)/) {
6386                         # Started ok .. connect and save SID
6387                         close(SOCK);
6388                         my ($port, $sid, $error) = ($1, $2, undef);
6389                         &open_socket("localhost", $port, $sid, \$error);
6390                         return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error") if ($error);
6391                         $fast_fh_cache{$sn} = $sid;
6392                         }
6393                 else {
6394                         local $_;
6395                         while(<RPCOUTr>) {
6396                                 $line .= $_;
6397                                 }
6398                         &error("Bad response from fastrpc.cgi : $line");
6399                         }
6400                 }
6401         # Got a connection .. send off the request
6402         my $fh = $fast_fh_cache{$sn};
6403         my $tostr = &serialise_variable($_[1]);
6404         print $fh length($tostr)," $fh\n";
6405         print $fh $tostr;
6406         my $rstr = <$fh>;
6407         if ($rstr eq '') {
6408                 return &$main::remote_error_handler(
6409                         "Error reading response length from fastrpc.cgi : $!")
6410                 }
6411         my $rlen = int($rstr);
6412         my ($fromstr, $got);
6413         while(length($fromstr) < $rlen) {
6414                 return &$main::remote_error_handler(
6415                         "Failed to read from fastrpc.cgi : $!")
6416                         if (read($fh, $got, $rlen - length($fromstr)) <= 0);
6417                 $fromstr .= $got;
6418                 }
6419         my $from = &unserialise_variable($fromstr);
6420         if (!$from) {
6421                 # No response at all
6422                 return &$main::remote_error_handler("Remote Webmin error");
6423                 }
6424         elsif (ref($from) ne 'HASH') {
6425                 # Not a hash?!
6426                 return &$main::remote_error_handler(
6427                         "Invalid remote Webmin response : $from");
6428                 }
6429         elsif (!$from->{'status'}) {
6430                 # Call failed
6431                 $from->{'rv'} =~ s/\s+at\s+(\S+)\s+line\s+(\d+)(,\s+<\S+>\s+line\s+(\d+))?//;
6432                 return &$main::remote_error_handler($from->{'rv'});
6433                 }
6434         if (defined($from->{'arv'})) {
6435                 return @{$from->{'arv'}};
6436                 }
6437         else {
6438                 return $from->{'rv'};
6439                 }
6440         }
6441 else {
6442         # Call rpc.cgi on remote server
6443         my $tostr = &serialise_variable($_[1]);
6444         my $error = 0;
6445         my $con = &make_http_connection($ip, $serv->{'port'},
6446                                         $serv->{'ssl'}, "POST", "/rpc.cgi");
6447         return &$main::remote_error_handler("Failed to connect to $serv->{'host'} : $con") if (!ref($con));
6448
6449         &write_http_connection($con, "Host: $serv->{'host'}\r\n");
6450         &write_http_connection($con, "User-agent: Webmin\r\n");
6451         my $auth = &encode_base64("$user:$pass");
6452         $auth =~ tr/\n//d;
6453         &write_http_connection($con, "Authorization: basic $auth\r\n");
6454         &write_http_connection($con, "Content-length: ",length($tostr),"\r\n");
6455         &write_http_connection($con, "\r\n");
6456         &write_http_connection($con, $tostr);
6457
6458         # read back the response
6459         my $line = &read_http_connection($con);
6460         $line =~ tr/\r\n//d;
6461         if ($line =~ /^HTTP\/1\..\s+401\s+/) {
6462                 return &$main::remote_error_handler("Login to RPC server as $user rejected");
6463                 }
6464         $line =~ /^HTTP\/1\..\s+200\s+/ || return &$main::remote_error_handler("RPC HTTP error : $line");
6465         do {
6466                 $line = &read_http_connection($con);
6467                 $line =~ tr/\r\n//d;
6468                 } while($line);
6469         my $fromstr;
6470         while($line = &read_http_connection($con)) {
6471                 $fromstr .= $line;
6472                 }
6473         close(SOCK);
6474         my $from = &unserialise_variable($fromstr);
6475         return &$main::remote_error_handler("Invalid RPC login to $serv->{'host'}") if (!$from->{'status'});
6476         if (defined($from->{'arv'})) {
6477                 return @{$from->{'arv'}};
6478                 }
6479         else {
6480                 return $from->{'rv'};
6481                 }
6482         }
6483 }
6484
6485 =head2 remote_multi_callback(&servers, parallel, &function, arg|&args, &returns, &errors, [module, library])
6486
6487 Executes some function in parallel on multiple servers at once. Fills in
6488 the returns and errors arrays respectively. If the module and library
6489 parameters are given, that module is remotely required on the server first,
6490 to check if it is connectable. The parameters are :
6491
6492 =item servers - A list of Webmin system hash references.
6493
6494 =item parallel - Number of parallel operations to perform.
6495
6496 =item function - Reference to function to call for each system.
6497
6498 =item args - Additional parameters to the function.
6499
6500 =item returns - Array ref to place return values into, in same order as servers.
6501
6502 =item errors - Array ref to place error messages into.
6503
6504 =item module - Optional module to require on the remote system first.
6505
6506 =item library - Optional library to require in the module.
6507
6508 =cut
6509 sub remote_multi_callback
6510 {
6511 my ($servs, $parallel, $func, $args, $rets, $errs, $mod, $lib) = @_;
6512 &remote_error_setup(\&remote_multi_callback_error);
6513
6514 # Call the functions
6515 my $p = 0;
6516 foreach my $g (@$servs) {
6517         my $rh = "READ$p";
6518         my $wh = "WRITE$p";
6519         pipe($rh, $wh);
6520         if (!fork()) {
6521                 close($rh);
6522                 $remote_multi_callback_err = undef;
6523                 if ($mod) {
6524                         # Require the remote lib
6525                         &remote_foreign_require($g->{'host'}, $mod, $lib);
6526                         if ($remote_multi_callback_err) {
6527                                 # Failed .. return error
6528                                 print $wh &serialise_variable(
6529                                         [ undef, $remote_multi_callback_err ]);
6530                                 exit(0);
6531                                 }
6532                         }
6533
6534                 # Call the function
6535                 my $a = ref($args) ? $args->[$p] : $args;
6536                 my $rv = &$func($g, $a);
6537
6538                 # Return the result
6539                 print $wh &serialise_variable(
6540                         [ $rv, $remote_multi_callback_err ]);
6541                 close($wh);
6542                 exit(0);
6543                 }
6544         close($wh);
6545         $p++;
6546         }
6547
6548 # Read back the results
6549 $p = 0;
6550 foreach my $g (@$servs) {
6551         my $rh = "READ$p";
6552         my $line = <$rh>;
6553         if (!$line) {
6554                 $errs->[$p] = "Failed to read response from $g->{'host'}";
6555                 }
6556         else {
6557                 my $rv = &unserialise_variable($line);
6558                 close($rh);
6559                 $rets->[$p] = $rv->[0];
6560                 $errs->[$p] = $rv->[1];
6561                 }
6562         $p++;
6563         }
6564
6565 &remote_error_setup(undef);
6566 }
6567
6568 sub remote_multi_callback_error
6569 {
6570 $remote_multi_callback_err = $_[0];
6571 }
6572
6573 =head2 serialise_variable(variable)
6574
6575 Converts some variable (maybe a scalar, hash ref, array ref or scalar ref)
6576 into a url-encoded string. In the cases of arrays and hashes, it is recursively
6577 called on each member to serialize the entire object.
6578
6579 =cut
6580 sub serialise_variable
6581 {
6582 if (!defined($_[0])) {
6583         return 'UNDEF';
6584         }
6585 my $r = ref($_[0]);
6586 my $rv;
6587 if (!$r) {
6588         $rv = &urlize($_[0]);
6589         }
6590 elsif ($r eq 'SCALAR') {
6591         $rv = &urlize(${$_[0]});
6592         }
6593 elsif ($r eq 'ARRAY') {
6594         $rv = join(",", map { &urlize(&serialise_variable($_)) } @{$_[0]});
6595         }
6596 elsif ($r eq 'HASH') {
6597         $rv = join(",", map { &urlize(&serialise_variable($_)).",".
6598                               &urlize(&serialise_variable($_[0]->{$_})) }
6599                             keys %{$_[0]});
6600         }
6601 elsif ($r eq 'REF') {
6602         $rv = &serialise_variable(${$_[0]});
6603         }
6604 elsif ($r eq 'CODE') {
6605         # Code not handled
6606         $rv = undef;
6607         }
6608 elsif ($r) {
6609         # An object - treat as a hash
6610         $r = "OBJECT ".&urlize($r);
6611         $rv = join(",", map { &urlize(&serialise_variable($_)).",".
6612                               &urlize(&serialise_variable($_[0]->{$_})) }
6613                             keys %{$_[0]});
6614         }
6615 return ($r ? $r : 'VAL').",".$rv;
6616 }
6617
6618 =head2 unserialise_variable(string)
6619
6620 Converts a string created by serialise_variable() back into the original
6621 scalar, hash ref, array ref or scalar ref. If the original variable was a Perl
6622 object, the same class is used on this system, if available.
6623
6624 =cut
6625 sub unserialise_variable
6626 {
6627 my @v = split(/,/, $_[0]);
6628 my $rv;
6629 if ($v[0] eq 'VAL') {
6630         @v = split(/,/, $_[0], -1);
6631         $rv = &un_urlize($v[1]);
6632         }
6633 elsif ($v[0] eq 'SCALAR') {
6634         local $r = &un_urlize($v[1]);
6635         $rv = \$r;
6636         }
6637 elsif ($v[0] eq 'ARRAY') {
6638         $rv = [ ];
6639         for(my $i=1; $i<@v; $i++) {
6640                 push(@$rv, &unserialise_variable(&un_urlize($v[$i])));
6641                 }
6642         }
6643 elsif ($v[0] eq 'HASH') {
6644         $rv = { };
6645         for(my $i=1; $i<@v; $i+=2) {
6646                 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6647                         &unserialise_variable(&un_urlize($v[$i+1]));
6648                 }
6649         }
6650 elsif ($v[0] eq 'REF') {
6651         local $r = &unserialise_variable($v[1]);
6652         $rv = \$r;
6653         }
6654 elsif ($v[0] eq 'UNDEF') {
6655         $rv = undef;
6656         }
6657 elsif ($v[0] =~ /^OBJECT\s+(.*)$/) {
6658         # An object hash that we have to re-bless
6659         my $cls = $1;
6660         $rv = { };
6661         for(my $i=1; $i<@v; $i+=2) {
6662                 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6663                         &unserialise_variable(&un_urlize($v[$i+1]));
6664                 }
6665         eval "use $cls";
6666         bless $rv, $cls;
6667         }
6668 return $rv;
6669 }
6670
6671 =head2 other_groups(user)
6672
6673 Returns a list of secondary groups a user is a member of, as a list of
6674 group names.
6675
6676 =cut
6677 sub other_groups
6678 {
6679 my ($user) = @_;
6680 my @rv;
6681 setgrent();
6682 while(my @g = getgrent()) {
6683         my @m = split(/\s+/, $g[3]);
6684         push(@rv, $g[2]) if (&indexof($user, @m) >= 0);
6685         }
6686 endgrent() if ($gconfig{'os_type'} ne 'hpux');
6687 return @rv;
6688 }
6689
6690 =head2 date_chooser_button(dayfield, monthfield, yearfield)
6691
6692 Returns HTML for a button that pops up a data chooser window. The parameters
6693 are :
6694
6695 =item dayfield - Name of the text field to place the day of the month into.
6696
6697 =item monthfield - Name of the select field to select the month of the year in, indexed from 1.
6698
6699 =item yearfield - Name of the text field to place the year into.
6700
6701 =cut
6702 sub date_chooser_button
6703 {
6704 return &theme_date_chooser_button(@_)
6705         if (defined(&theme_date_chooser_button));
6706 my ($w, $h) = (250, 225);
6707 if ($gconfig{'db_sizedate'}) {
6708         ($w, $h) = split(/x/, $gconfig{'db_sizedate'});
6709         }
6710 return "<input type=button onClick='window.dfield = form.$_[0]; window.mfield = form.$_[1]; window.yfield = form.$_[2]; window.open(\"$gconfig{'webprefix'}/date_chooser.cgi?day=\"+escape(dfield.value)+\"&month=\"+escape(mfield.selectedIndex)+\"&year=\"+yfield.value, \"chooser\", \"toolbar=no,menubar=no,scrollbars=yes,width=$w,height=$h\")' value=\"...\">\n";
6711 }
6712
6713 =head2 help_file(module, file)
6714
6715 Returns the path to a module's help file of some name, typically under the
6716 help directory with a .html extension.
6717
6718 =cut
6719 sub help_file
6720 {
6721 my $mdir = &module_root_directory($_[0]);
6722 my $dir = "$mdir/help";
6723 foreach my $o (@lang_order_list) {
6724         my $lang = "$dir/$_[1].$o.html";
6725         return $lang if (-r $lang);
6726         }
6727 return "$dir/$_[1].html";
6728 }
6729
6730 =head2 seed_random
6731
6732 Seeds the random number generator, if not already done in this script. On Linux
6733 this makes use of the current time, process ID and a read from /dev/urandom.
6734 On other systems, only the current time and process ID are used.
6735
6736 =cut
6737 sub seed_random
6738 {
6739 if (!$main::done_seed_random) {
6740         if (open(RANDOM, "/dev/urandom")) {
6741                 my $buf;
6742                 read(RANDOM, $buf, 4);
6743                 close(RANDOM);
6744                 srand(time() ^ $$ ^ $buf);
6745                 }
6746         else {
6747                 srand(time() ^ $$);
6748                 }
6749         $main::done_seed_random = 1;
6750         }
6751 }
6752
6753 =head2 disk_usage_kb(directory)
6754
6755 Returns the number of kB used by some directory and all subdirs. Implemented
6756 by calling the C<du -k> command.
6757
6758 =cut
6759 sub disk_usage_kb
6760 {
6761 my $dir = &translate_filename($_[0]);
6762 my $out;
6763 my $ex = &execute_command("du -sk ".quotemeta($dir), undef, \$out, undef, 0, 1);
6764 if ($ex) {
6765         &execute_command("du -s ".quotemeta($dir), undef, \$out, undef, 0, 1);
6766         }
6767 return $out =~ /^([0-9]+)/ ? $1 : "???";
6768 }
6769
6770 =head2 recursive_disk_usage(directory, [skip-regexp], [only-regexp])
6771
6772 Returns the number of bytes taken up by all files in some directory and all
6773 sub-directories, by summing up their lengths. The disk_usage_kb is more
6774 reflective of reality, as the filesystem typically pads file sizes to 1k or
6775 4k blocks.
6776
6777 =cut
6778 sub recursive_disk_usage
6779 {
6780 my $dir = &translate_filename($_[0]);
6781 my $skip = $_[1];
6782 my $only = $_[2];
6783 if (-l $dir) {
6784         return 0;
6785         }
6786 elsif (!-d $dir) {
6787         my @st = stat($dir);
6788         return $st[7];
6789         }
6790 else {
6791         my $rv = 0;
6792         opendir(DIR, $dir);
6793         my @files = readdir(DIR);
6794         closedir(DIR);
6795         foreach my $f (@files) {
6796                 next if ($f eq "." || $f eq "..");
6797                 next if ($skip && $f =~ /$skip/);
6798                 next if ($only && $f !~ /$only/);
6799                 $rv += &recursive_disk_usage("$dir/$f", $skip, $only);
6800                 }
6801         return $rv;
6802         }
6803 }
6804
6805 =head2 help_search_link(term, [ section, ... ] )
6806
6807 Returns HTML for a link to the man module for searching local and online
6808 docs for various search terms. The term parameter can either be a single
6809 word like 'bind', or a space-separated list of words. This function is typically
6810 used by modules that want to refer users to additional documentation in man
6811 pages or local system doc files.
6812
6813 =cut
6814 sub help_search_link
6815 {
6816 if (&foreign_available("man") && !$tconfig{'nosearch'}) {
6817         my $for = &urlize(shift(@_));
6818         return "<a href='$gconfig{'webprefix'}/man/search.cgi?".
6819                join("&", map { "section=$_" } @_)."&".
6820                "for=$for&exact=1&check=".&get_module_name()."'>".
6821                $text{'helpsearch'}."</a>\n";
6822         }
6823 else {
6824         return "";
6825         }
6826 }
6827
6828 =head2 make_http_connection(host, port, ssl, method, page, [&headers])
6829
6830 Opens a connection to some HTTP server, maybe through a proxy, and returns
6831 a handle object. The handle can then be used to send additional headers
6832 and read back a response. If anything goes wrong, returns an error string.
6833 The parameters are :
6834
6835 =item host - Hostname or IP address of the webserver to connect to.
6836
6837 =item port - HTTP port number to connect to.
6838
6839 =item ssl - Set to 1 to connect in SSL mode.
6840
6841 =item method - HTTP method, like GET or POST.
6842
6843 =item page - Page to request on the webserver, like /foo/index.html
6844
6845 =item headers - Array ref of additional HTTP headers, each of which is a 2-element array ref.
6846
6847 =cut
6848 sub make_http_connection
6849 {
6850 my ($host, $port, $ssl, $method, $page, $headers) = @_;
6851 my $htxt;
6852 if ($headers) {
6853         foreach my $h (@$headers) {
6854                 $htxt .= $h->[0].": ".$h->[1]."\r\n";
6855                 }
6856         $htxt .= "\r\n";
6857         }
6858 if (&is_readonly_mode()) {
6859         return "HTTP connections not allowed in readonly mode";
6860         }
6861 my $rv = { 'fh' => time().$$ };
6862 if ($ssl) {
6863         # Connect using SSL
6864         eval "use Net::SSLeay";
6865         $@ && return $text{'link_essl'};
6866         eval "Net::SSLeay::SSLeay_add_ssl_algorithms()";
6867         eval "Net::SSLeay::load_error_strings()";
6868         $rv->{'ssl_ctx'} = Net::SSLeay::CTX_new() ||
6869                 return "Failed to create SSL context";
6870         $rv->{'ssl_con'} = Net::SSLeay::new($rv->{'ssl_ctx'}) ||
6871                 return "Failed to create SSL connection";
6872         my $connected;
6873         if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6874             !&no_proxy($host)) {
6875                 # Via proxy
6876                 my $error;
6877                 &open_socket($1, $2, $rv->{'fh'}, \$error);
6878                 if (!$error) {
6879                         # Connected OK
6880                         my $fh = $rv->{'fh'};
6881                         print $fh "CONNECT $host:$port HTTP/1.0\r\n";
6882                         if ($gconfig{'proxy_user'}) {
6883                                 my $auth = &encode_base64(
6884                                    "$gconfig{'proxy_user'}:".
6885                                    "$gconfig{'proxy_pass'}");
6886                                 $auth =~ tr/\r\n//d;
6887                                 print $fh "Proxy-Authorization: Basic $auth\r\n";
6888                                 }
6889                         print $fh "\r\n";
6890                         my $line = <$fh>;
6891                         if ($line =~ /^HTTP(\S+)\s+(\d+)\s+(.*)/) {
6892                                 return "Proxy error : $3" if ($2 != 200);
6893                                 }
6894                         else {
6895                                 return "Proxy error : $line";
6896                                 }
6897                         $line = <$fh>;
6898                         $connected = 1;
6899                         }
6900                 elsif (!$gconfig{'proxy_fallback'}) {
6901                         # Connection to proxy failed - give up
6902                         return $error;
6903                         }
6904                 }
6905         if (!$connected) {
6906                 # Direct connection
6907                 my $error;
6908                 &open_socket($host, $port, $rv->{'fh'}, \$error);
6909                 return $error if ($error);
6910                 }
6911         Net::SSLeay::set_fd($rv->{'ssl_con'}, fileno($rv->{'fh'}));
6912         Net::SSLeay::connect($rv->{'ssl_con'}) ||
6913                 return "SSL connect() failed";
6914         my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6915         Net::SSLeay::write($rv->{'ssl_con'}, $rtxt);
6916         }
6917 else {
6918         # Plain HTTP request
6919         my $connected;
6920         if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6921             !&no_proxy($host)) {
6922                 # Via a proxy
6923                 my $error;
6924                 &open_socket($1, $2, $rv->{'fh'}, \$error);
6925                 if (!$error) {
6926                         # Connected OK
6927                         $connected = 1;
6928                         my $fh = $rv->{'fh'};
6929                         my $rtxt = $method." ".
6930                                    "http://$host:$port$page HTTP/1.0\r\n";
6931                         if ($gconfig{'proxy_user'}) {
6932                                 my $auth = &encode_base64(
6933                                    "$gconfig{'proxy_user'}:".
6934                                    "$gconfig{'proxy_pass'}");
6935                                 $auth =~ tr/\r\n//d;
6936                                 $rtxt .= "Proxy-Authorization: Basic $auth\r\n";
6937                                 }
6938                         $rtxt .= $htxt;
6939                         print $fh $rtxt;
6940                         }
6941                 elsif (!$gconfig{'proxy_fallback'}) {
6942                         return $error;
6943                         }
6944                 }
6945         if (!$connected) {
6946                 # Connecting directly
6947                 my $error;
6948                 &open_socket($host, $port, $rv->{'fh'}, \$error);
6949                 return $error if ($error);
6950                 my $fh = $rv->{'fh'};
6951                 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6952                 print $fh $rtxt;
6953                 }
6954         }
6955 return $rv;
6956 }
6957
6958 =head2 read_http_connection(&handle, [bytes])
6959
6960 Reads either one line or up to the specified number of bytes from the handle,
6961 originally supplied by make_http_connection.
6962
6963 =cut
6964 sub read_http_connection
6965 {
6966 my ($h) = @_;
6967 my $rv;
6968 if ($h->{'ssl_con'}) {
6969         if (!$_[1]) {
6970                 my ($idx, $more);
6971                 while(($idx = index($h->{'buffer'}, "\n")) < 0) {
6972                         # need to read more..
6973                         if (!($more = Net::SSLeay::read($h->{'ssl_con'}))) {
6974                                 # end of the data
6975                                 $rv = $h->{'buffer'};
6976                                 delete($h->{'buffer'});
6977                                 return $rv;
6978                                 }
6979                         $h->{'buffer'} .= $more;
6980                         }
6981                 $rv = substr($h->{'buffer'}, 0, $idx+1);
6982                 $h->{'buffer'} = substr($h->{'buffer'}, $idx+1);
6983                 }
6984         else {
6985                 if (length($h->{'buffer'})) {
6986                         $rv = $h->{'buffer'};
6987                         delete($h->{'buffer'});
6988                         }
6989                 else {
6990                         $rv = Net::SSLeay::read($h->{'ssl_con'}, $_[1]);
6991                         }
6992                 }
6993         }
6994 else {
6995         if ($_[1]) {
6996                 read($h->{'fh'}, $rv, $_[1]) > 0 || return undef;
6997                 }
6998         else {
6999                 my $fh = $h->{'fh'};
7000                 $rv = <$fh>;
7001                 }
7002         }
7003 $rv = undef if ($rv eq "");
7004 return $rv;
7005 }
7006
7007 =head2 write_http_connection(&handle, [data+])
7008
7009 Writes the given data to the given HTTP connection handle.
7010
7011 =cut
7012 sub write_http_connection
7013 {
7014 my $h = shift(@_);
7015 my $fh = $h->{'fh'};
7016 my $allok = 1;
7017 if ($h->{'ssl_ctx'}) {
7018         foreach my $s (@_) {
7019                 my $ok = Net::SSLeay::write($h->{'ssl_con'}, $s);
7020                 $allok = 0 if (!$ok);
7021                 }
7022         }
7023 else {
7024         my $ok = (print $fh @_);
7025         $allok = 0 if (!$ok);
7026         }
7027 return $allok;
7028 }
7029
7030 =head2 close_http_connection(&handle)
7031
7032 Closes a connection to an HTTP server, identified by the given handle.
7033
7034 =cut
7035 sub close_http_connection
7036 {
7037 my ($h) = @_;
7038 close($h->{'fh'});
7039 }
7040
7041 =head2 clean_environment
7042
7043 Deletes any environment variables inherited from miniserv so that they
7044 won't be passed to programs started by webmin. This is useful when calling
7045 programs that check for CGI-related environment variables and modify their
7046 behaviour, and to avoid passing sensitive variables to un-trusted programs.
7047
7048 =cut
7049 sub clean_environment
7050 {
7051 %UNCLEAN_ENV = %ENV;
7052 foreach my $k (keys %ENV) {
7053         if ($k =~ /^(HTTP|VIRTUALSERVER|QUOTA|USERADMIN)_/) {
7054                 delete($ENV{$k});
7055                 }
7056         }
7057 foreach my $e ('WEBMIN_CONFIG', 'SERVER_NAME', 'CONTENT_TYPE', 'REQUEST_URI',
7058             'PATH_INFO', 'WEBMIN_VAR', 'REQUEST_METHOD', 'GATEWAY_INTERFACE',
7059             'QUERY_STRING', 'REMOTE_USER', 'SERVER_SOFTWARE', 'SERVER_PROTOCOL',
7060             'REMOTE_HOST', 'SERVER_PORT', 'DOCUMENT_ROOT', 'SERVER_ROOT',
7061             'MINISERV_CONFIG', 'SCRIPT_NAME', 'SERVER_ADMIN', 'CONTENT_LENGTH',
7062             'HTTPS', 'FOREIGN_MODULE_NAME', 'FOREIGN_ROOT_DIRECTORY',
7063             'SCRIPT_FILENAME', 'PATH_TRANSLATED', 'BASE_REMOTE_USER',
7064             'DOCUMENT_REALROOT', 'MINISERV_CONFIG', 'MYSQL_PWD',
7065             'MINISERV_PID') {
7066         delete($ENV{$e});
7067         }
7068 }
7069
7070 =head2 reset_environment
7071
7072 Puts the environment back how it was before clean_environment was callled.
7073
7074 =cut
7075 sub reset_environment
7076 {
7077 if (%UNCLEAN_ENV) {
7078         foreach my $k (keys %UNCLEAN_ENV) {
7079                 $ENV{$k} = $UNCLEAN_ENV{$k};
7080                 }
7081         undef(%UNCLEAN_ENV);
7082         }
7083 }
7084
7085 =head2 progress_callback
7086
7087 Never called directly, but useful for passing to &http_download to print
7088 out progress of an HTTP request.
7089
7090 =cut
7091 sub progress_callback
7092 {
7093 if (defined(&theme_progress_callback)) {
7094         # Call the theme override
7095         return &theme_progress_callback(@_);
7096         }
7097 if ($_[0] == 2) {
7098         # Got size
7099         print $progress_callback_prefix;
7100         if ($_[1]) {
7101                 $progress_size = $_[1];
7102                 $progress_step = int($_[1] / 10);
7103                 print &text('progress_size2', $progress_callback_url,
7104                             &nice_size($progress_size)),"<br>\n";
7105                 }
7106         else {
7107                 $progress_size = undef;
7108                 print &text('progress_nosize', $progress_callback_url),"<br>\n";
7109                 }
7110         $last_progress_time = $last_progress_size = undef;
7111         }
7112 elsif ($_[0] == 3) {
7113         # Got data update
7114         my $sp = $progress_callback_prefix.("&nbsp;" x 5);
7115         if ($progress_size) {
7116                 # And we have a size to compare against
7117                 my $st = int(($_[1] * 10) / $progress_size);
7118                 my $time_now = time();
7119                 if ($st != $progress_step ||
7120                     $time_now - $last_progress_time > 60) {
7121                         # Show progress every 10% or 60 seconds
7122                         print $sp,&text('progress_datan', &nice_size($_[1]),
7123                                         int($_[1]*100/$progress_size)),"<br>\n";
7124                         $last_progress_time = $time_now;
7125                         }
7126                 $progress_step = $st;
7127                 }
7128         else {
7129                 # No total size .. so only show in 100k jumps
7130                 if ($_[1] > $last_progress_size+100*1024) {
7131                         print $sp,&text('progress_data2n',
7132                                         &nice_size($_[1])),"<br>\n";
7133                         $last_progress_size = $_[1];
7134                         }
7135                 }
7136         }
7137 elsif ($_[0] == 4) {
7138         # All done downloading
7139         print $progress_callback_prefix,&text('progress_done'),"<br>\n";
7140         }
7141 elsif ($_[0] == 5) {
7142         # Got new location after redirect
7143         $progress_callback_url = $_[1];
7144         }
7145 elsif ($_[0] == 6) {
7146         # URL is in cache
7147         $progress_callback_url = $_[1];
7148         print &text('progress_incache', $progress_callback_url),"<br>\n";
7149         }
7150 }
7151
7152 =head2 switch_to_remote_user
7153
7154 Changes the user and group of the current process to that of the unix user
7155 with the same name as the current webmin login, or fails if there is none.
7156 This should be called by Usermin module scripts that only need to run with
7157 limited permissions.
7158
7159 =cut
7160 sub switch_to_remote_user
7161 {
7162 @remote_user_info = $remote_user ? getpwnam($remote_user) :
7163                                    getpwuid($<);
7164 @remote_user_info || &error(&text('switch_remote_euser', $remote_user));
7165 &create_missing_homedir(\@remote_user_info);
7166 if ($< == 0) {
7167         &switch_to_unix_user(\@remote_user_info);
7168         $ENV{'USER'} = $ENV{'LOGNAME'} = $remote_user;
7169         $ENV{'HOME'} = $remote_user_info[7];
7170         }
7171 # Export global variables to caller
7172 if ($main::export_to_caller) {
7173         my ($callpkg) = caller();
7174         eval "\@${callpkg}::remote_user_info = \@remote_user_info";
7175         }
7176 }
7177
7178 =head2 switch_to_unix_user(&user-details)
7179
7180 Switches the current process to the UID and group ID from the given list
7181 of user details, which must be in the format returned by getpwnam.
7182
7183 =cut
7184 sub switch_to_unix_user
7185 {
7186 my ($uinfo) = @_;
7187 if (!defined($uinfo->[0])) {
7188         # No username given, so just use given GID
7189         ($(, $)) = ( $uinfo->[3], "$uinfo->[3] $uinfo->[3]" );
7190         }
7191 else {
7192         # Use all groups from user
7193         ($(, $)) = ( $uinfo->[3],
7194                      "$uinfo->[3] ".join(" ", $uinfo->[3],
7195                                          &other_groups($uinfo->[0])) );
7196         }
7197 eval {
7198         POSIX::setuid($uinfo->[2]);
7199         };
7200 if ($< != $uinfo->[2] || $> != $uinfo->[2]) {
7201         ($>, $<) = ( $uinfo->[2], $uinfo->[2] );
7202         }
7203 }
7204
7205 =head2 eval_as_unix_user(username, &code)
7206
7207 Runs some code fragment with the effective UID and GID switch to that
7208 of the given Unix user, so that file IO takes place with his permissions.
7209
7210 =cut
7211
7212 sub eval_as_unix_user
7213 {
7214 my ($user, $code) = @_;
7215 my @uinfo = getpwnam($user);
7216 if (!scalar(@uinfo)) {
7217         &error("eval_as_unix_user called with invalid user $user");
7218         }
7219 $) = $uinfo[3]." ".join(" ", $uinfo[3], &other_groups($user));
7220 $> = $uinfo[2];
7221 my @rv;
7222 eval {
7223         local $main::error_must_die = 1;
7224         @rv = &$code();
7225         };
7226 my $err = $@;
7227 $) = 0;
7228 $> = 0;
7229 if ($err) {
7230         $err =~ s/\s+at\s+(\/\S+)\s+line\s+(\d+)\.?//;
7231         &error($err);
7232         }
7233 return wantarray ? @rv : $rv[0];
7234 }
7235
7236 =head2 create_user_config_dirs
7237
7238 Creates per-user config directories and sets $user_config_directory and
7239 $user_module_config_directory to them. Also reads per-user module configs
7240 into %userconfig. This should be called by Usermin module scripts that need
7241 to store per-user preferences or other settings.
7242
7243 =cut
7244 sub create_user_config_dirs
7245 {
7246 return if (!$gconfig{'userconfig'});
7247 my @uinfo = @remote_user_info ? @remote_user_info : getpwnam($remote_user);
7248 return if (!@uinfo || !$uinfo[7]);
7249 &create_missing_homedir(\@uinfo);
7250 $user_config_directory = "$uinfo[7]/$gconfig{'userconfig'}";
7251 if (!-d $user_config_directory) {
7252         mkdir($user_config_directory, 0700) ||
7253                 &error("Failed to create $user_config_directory : $!");
7254         if ($< == 0 && $uinfo[2]) {
7255                 chown($uinfo[2], $uinfo[3], $user_config_directory);
7256                 }
7257         }
7258 if (&get_module_name()) {
7259         $user_module_config_directory = $user_config_directory."/".
7260                                         &get_module_name();
7261         if (!-d $user_module_config_directory) {
7262                 mkdir($user_module_config_directory, 0700) ||
7263                         &error("Failed to create $user_module_config_directory : $!");
7264                 if ($< == 0 && $uinfo[2]) {
7265                         chown($uinfo[2], $uinfo[3], $user_config_directory);
7266                         }
7267                 }
7268         undef(%userconfig);
7269         &read_file_cached("$module_root_directory/defaultuconfig",
7270                           \%userconfig);
7271         &read_file_cached("$module_config_directory/uconfig", \%userconfig);
7272         &read_file_cached("$user_module_config_directory/config",
7273                           \%userconfig);
7274         }
7275
7276 # Export global variables to caller
7277 if ($main::export_to_caller) {
7278         my ($callpkg) = caller();
7279         foreach my $v ('$user_config_directory',
7280                        '$user_module_config_directory', '%userconfig') {
7281                 my ($vt, $vn) = split('', $v, 2);
7282                 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
7283                 }
7284         }
7285 }
7286
7287 =head2 create_missing_homedir(&uinfo)
7288
7289 If auto homedir creation is enabled, create one for this user if needed.
7290 For internal use only.
7291
7292 =cut
7293 sub create_missing_homedir
7294 {
7295 my ($uinfo) = @_;
7296 if (!-e $uinfo->[7] && $gconfig{'create_homedir'}) {
7297         # Use has no home dir .. make one
7298         system("mkdir -p ".quotemeta($uinfo->[7]));
7299         chown($uinfo->[2], $uinfo->[3], $uinfo->[7]);
7300         if ($gconfig{'create_homedir_perms'} ne '') {
7301                 chmod(oct($gconfig{'create_homedir_perms'}), $uinfo->[7]);
7302                 }
7303         }
7304 }
7305
7306 =head2 filter_javascript(text)
7307
7308 Disables all javascript <script>, onClick= and so on tags in the given HTML,
7309 and returns the new HTML. Useful for displaying HTML from an un-trusted source.
7310
7311 =cut
7312 sub filter_javascript
7313 {
7314 my ($rv) = @_;
7315 $rv =~ s/<\s*script[^>]*>([\000-\377]*?)<\s*\/script\s*>//gi;
7316 $rv =~ s/(on(Abort|Blur|Change|Click|DblClick|DragDrop|Error|Focus|KeyDown|KeyPress|KeyUp|Load|MouseDown|MouseMove|MouseOut|MouseOver|MouseUp|Move|Reset|Resize|Select|Submit|Unload)=)/x$1/gi;
7317 $rv =~ s/(javascript:)/x$1/gi;
7318 $rv =~ s/(vbscript:)/x$1/gi;
7319 return $rv;
7320 }
7321
7322 =head2 resolve_links(path)
7323
7324 Given a path that may contain symbolic links, returns the real path.
7325
7326 =cut
7327 sub resolve_links
7328 {
7329 my ($path) = @_;
7330 $path =~ s/\/+/\//g;
7331 $path =~ s/\/$// if ($path ne "/");
7332 my @p = split(/\/+/, $path);
7333 shift(@p);
7334 for(my $i=0; $i<@p; $i++) {
7335         my $sofar = "/".join("/", @p[0..$i]);
7336         my $lnk = readlink($sofar);
7337         if ($lnk eq $sofar) {
7338                 # Link to itself! Cannot do anything more really ..
7339                 last;
7340                 }
7341         elsif ($lnk =~ /^\//) {
7342                 # Link is absolute..
7343                 return &resolve_links($lnk."/".join("/", @p[$i+1 .. $#p]));
7344                 }
7345         elsif ($lnk) {
7346                 # Link is relative
7347                 return &resolve_links("/".join("/", @p[0..$i-1])."/".$lnk."/".join("/", @p[$i+1 .. $#p]));
7348                 }
7349         }
7350 return $path;
7351 }
7352
7353 =head2 simplify_path(path, bogus)
7354
7355 Given a path, maybe containing elements ".." and "." , convert it to a
7356 clean, absolute form. Returns undef if this is not possible.
7357
7358 =cut
7359 sub simplify_path
7360 {
7361 my ($dir) = @_;
7362 $dir =~ s/^\/+//g;
7363 $dir =~ s/\/+$//g;
7364 my @bits = split(/\/+/, $dir);
7365 my @fixedbits = ();
7366 $_[1] = 0;
7367 foreach my $b (@bits) {
7368         if ($b eq ".") {
7369                 # Do nothing..
7370                 }
7371         elsif ($b eq "..") {
7372                 # Remove last dir
7373                 if (scalar(@fixedbits) == 0) {
7374                         # Cannot! Already at root!
7375                         return undef;
7376                         }
7377                 pop(@fixedbits);
7378                 }
7379         else {
7380                 # Add dir to list
7381                 push(@fixedbits, $b);
7382                 }
7383         }
7384 return "/".join('/', @fixedbits);
7385 }
7386
7387 =head2 same_file(file1, file2)
7388
7389 Returns 1 if two files are actually the same
7390
7391 =cut
7392 sub same_file
7393 {
7394 return 1 if ($_[0] eq $_[1]);
7395 return 0 if ($_[0] !~ /^\// || $_[1] !~ /^\//);
7396 my @stat1 = $stat_cache{$_[0]} ? @{$stat_cache{$_[0]}}
7397                                : (@{$stat_cache{$_[0]}} = stat($_[0]));
7398 my @stat2 = $stat_cache{$_[1]} ? @{$stat_cache{$_[1]}}
7399                                : (@{$stat_cache{$_[1]}} = stat($_[1]));
7400 return 0 if (!@stat1 || !@stat2);
7401 return $stat1[0] == $stat2[0] && $stat1[1] == $stat2[1];
7402 }
7403
7404 =head2 flush_webmin_caches
7405
7406 Clears all in-memory and on-disk caches used by Webmin.
7407
7408 =cut
7409 sub flush_webmin_caches
7410 {
7411 undef(%main::read_file_cache);
7412 undef(%main::acl_hash_cache);
7413 undef(%main::acl_array_cache);
7414 undef(%main::has_command_cache);
7415 undef(@main::list_languages_cache);
7416 undef($main::got_list_usermods_cache);
7417 undef(@main::list_usermods_cache);
7418 undef(%main::foreign_installed_cache);
7419 unlink("$config_directory/module.infos.cache");
7420 &get_all_module_infos();
7421 }
7422
7423 =head2 list_usermods
7424
7425 Returns a list of additional module restrictions. For internal use in
7426 Usermin only.
7427
7428 =cut
7429 sub list_usermods
7430 {
7431 if (!$main::got_list_usermods_cache) {
7432         @main::list_usermods_cache = ( );
7433         local $_;
7434         open(USERMODS, "$config_directory/usermin.mods");
7435         while(<USERMODS>) {
7436                 if (/^([^:]+):(\+|-|):(.*)/) {
7437                         push(@main::list_usermods_cache,
7438                              [ $1, $2, [ split(/\s+/, $3) ] ]);
7439                         }
7440                 }
7441         close(USERMODS);
7442         $main::got_list_usermods_cache = 1;
7443         }
7444 return @main::list_usermods_cache;
7445 }
7446
7447 =head2 available_usermods(&allmods, &usermods)
7448
7449 Returns a list of modules that are available to the given user, based
7450 on usermod additional/subtractions. For internal use by Usermin only.
7451
7452 =cut
7453 sub available_usermods
7454 {
7455 return @{$_[0]} if (!@{$_[1]});
7456
7457 my %mods = map { $_->{'dir'}, 1 } @{$_[0]};
7458 my @uinfo = @remote_user_info;
7459 @uinfo = getpwnam($remote_user) if (!@uinfo);
7460 foreach my $u (@{$_[1]}) {
7461         my $applies;
7462         if ($u->[0] eq "*" || $u->[0] eq $remote_user) {
7463                 $applies++;
7464                 }
7465         elsif ($u->[0] =~ /^\@(.*)$/) {
7466                 # Check for group membership
7467                 my @ginfo = getgrnam($1);
7468                 $applies++ if (@ginfo && ($ginfo[2] == $uinfo[3] ||
7469                         &indexof($remote_user, split(/\s+/, $ginfo[3])) >= 0));
7470                 }
7471         elsif ($u->[0] =~ /^\//) {
7472                 # Check users and groups in file
7473                 local $_;
7474                 open(USERFILE, $u->[0]);
7475                 while(<USERFILE>) {
7476                         tr/\r\n//d;
7477                         if ($_ eq $remote_user) {
7478                                 $applies++;
7479                                 }
7480                         elsif (/^\@(.*)$/) {
7481                                 my @ginfo = getgrnam($1);
7482                                 $applies++
7483                                   if (@ginfo && ($ginfo[2] == $uinfo[3] ||
7484                                       &indexof($remote_user,
7485                                                split(/\s+/, $ginfo[3])) >= 0));
7486                                 }
7487                         last if ($applies);
7488                         }
7489                 close(USERFILE);
7490                 }
7491         if ($applies) {
7492                 if ($u->[1] eq "+") {
7493                         map { $mods{$_}++ } @{$u->[2]};
7494                         }
7495                 elsif ($u->[1] eq "-") {
7496                         map { delete($mods{$_}) } @{$u->[2]};
7497                         }
7498                 else {
7499                         undef(%mods);
7500                         map { $mods{$_}++ } @{$u->[2]};
7501                         }
7502                 }
7503         }
7504 return grep { $mods{$_->{'dir'}} } @{$_[0]};
7505 }
7506
7507 =head2 get_available_module_infos(nocache)
7508
7509 Returns a list of modules available to the current user, based on
7510 operating system support, access control and usermod restrictions. Useful
7511 in themes that need to display a list of modules the user can use.
7512 Each element of the returned array is a hash reference in the same format as
7513 returned by get_module_info.
7514
7515 =cut
7516 sub get_available_module_infos
7517 {
7518 my (%acl, %uacl);
7519 &read_acl(\%acl, \%uacl, [ $base_remote_user ]);
7520 my $risk = $gconfig{'risk_'.$base_remote_user};
7521 my @rv;
7522 foreach my $minfo (&get_all_module_infos($_[0])) {
7523         next if (!&check_os_support($minfo));
7524         if ($risk) {
7525                 # Check module risk level
7526                 next if ($risk ne 'high' && $minfo->{'risk'} &&
7527                          $minfo->{'risk'} !~ /$risk/);
7528                 }
7529         else {
7530                 # Check user's ACL
7531                 next if (!$acl{$base_remote_user,$minfo->{'dir'}} &&
7532                          !$acl{$base_remote_user,"*"});
7533                 }
7534         next if (&is_readonly_mode() && !$minfo->{'readonly'});
7535         push(@rv, $minfo);
7536         }
7537
7538 # Check usermod restrictions
7539 my @usermods = &list_usermods();
7540 @rv = sort { $a->{'desc'} cmp $b->{'desc'} }
7541             &available_usermods(\@rv, \@usermods);
7542
7543 # Check RBAC restrictions
7544 my @rbacrv;
7545 foreach my $m (@rv) {
7546         if (&supports_rbac($m->{'dir'}) &&
7547             &use_rbac_module_acl(undef, $m->{'dir'})) {
7548                 local $rbacs = &get_rbac_module_acl($remote_user,
7549                                                     $m->{'dir'});
7550                 if ($rbacs) {
7551                         # RBAC allows
7552                         push(@rbacrv, $m);
7553                         }
7554                 }
7555         else {
7556                 # Module or system doesn't support RBAC
7557                 push(@rbacrv, $m) if (!$gconfig{'rbacdeny_'.$base_remote_user});
7558                 }
7559         }
7560
7561 # Check theme vetos
7562 my @themerv;
7563 if (defined(&theme_foreign_available)) {
7564         foreach my $m (@rbacrv) {
7565                 if (&theme_foreign_available($m->{'dir'})) {
7566                         push(@themerv, $m);
7567                         }
7568                 }
7569         }
7570 else {
7571         @themerv = @rbacrv;
7572         }
7573
7574 # Check licence module vetos
7575 my @licrv;
7576 if ($main::licence_module) {
7577         foreach my $m (@themerv) {
7578                 if (&foreign_call($main::licence_module,
7579                                   "check_module_licence", $m->{'dir'})) {
7580                         push(@licrv, $m);
7581                         }
7582                 }
7583         }
7584 else {
7585         @licrv = @themerv;
7586         }
7587
7588 return @licrv;
7589 }
7590
7591 =head2 get_visible_module_infos(nocache)
7592
7593 Like get_available_module_infos, but excludes hidden modules from the list.
7594 Each element of the returned array is a hash reference in the same format as
7595 returned by get_module_info.
7596
7597 =cut
7598 sub get_visible_module_infos
7599 {
7600 my ($nocache) = @_;
7601 my $pn = &get_product_name();
7602 return grep { !$_->{'hidden'} &&
7603               !$_->{$pn.'_hidden'} } &get_available_module_infos($nocache);
7604 }
7605
7606 =head2 get_visible_modules_categories(nocache)
7607
7608 Returns a list of Webmin module categories, each of which is a hash ref
7609 with 'code', 'desc' and 'modules' keys. The modules value is an array ref
7610 of modules in the category, in the format returned by get_module_info.
7611 Un-used modules are automatically assigned to the 'unused' category, and
7612 those with no category are put into 'others'.
7613
7614 =cut
7615 sub get_visible_modules_categories
7616 {
7617 my ($nocache) = @_;
7618 my @mods = &get_visible_module_infos($nocache);
7619 my @unmods;
7620 if (&get_product_name() eq 'webmin') {
7621         @unmods = grep { $_->{'installed'} eq '0' } @mods;
7622         @mods = grep { $_->{'installed'} ne '0' } @mods;
7623         }
7624 my %cats = &list_categories(\@mods);
7625 my @rv;
7626 foreach my $c (keys %cats) {
7627         my $cat = { 'code' => $c || 'other',
7628                     'desc' => $cats{$c} };
7629         $cat->{'modules'} = [ grep { $_->{'category'} eq $c } @mods ];
7630         push(@rv, $cat);
7631         }
7632 @rv = sort { ($b->{'code'} eq "others" ? "" : $b->{'code'}) cmp
7633              ($a->{'code'} eq "others" ? "" : $a->{'code'}) } @rv;
7634 if (@unmods) {
7635         # Add un-installed modules in magic category
7636         my $cat = { 'code' => 'unused',
7637                     'desc' => $text{'main_unused'},
7638                     'unused' => 1,
7639                     'modules' => \@unmods };
7640         push(@rv, $cat);
7641         }
7642 return @rv;
7643 }
7644
7645 =head2 is_under_directory(directory, file)
7646
7647 Returns 1 if the given file is under the specified directory, 0 if not.
7648 Symlinks are taken into account in the file to find it's 'real' location.
7649
7650 =cut
7651 sub is_under_directory
7652 {
7653 my ($dir, $file) = @_;
7654 return 1 if ($dir eq "/");
7655 return 0 if ($file =~ /\.\./);
7656 my $ld = &resolve_links($dir);
7657 if ($ld ne $dir) {
7658         return &is_under_directory($ld, $file);
7659         }
7660 my $lp = &resolve_links($file);
7661 if ($lp ne $file) {
7662         return &is_under_directory($dir, $lp);
7663         }
7664 return 0 if (length($file) < length($dir));
7665 return 1 if ($dir eq $file);
7666 $dir =~ s/\/*$/\//;
7667 return substr($file, 0, length($dir)) eq $dir;
7668 }
7669
7670 =head2 parse_http_url(url, [basehost, baseport, basepage, basessl])
7671
7672 Given an absolute URL, returns the host, port, page and ssl flag components.
7673 If a username and password are given before the hostname, return those too.
7674 Relative URLs can also be parsed, if the base information is provided.
7675
7676 =cut
7677 sub parse_http_url
7678 {
7679 if ($_[0] =~ /^(http|https):\/\/([^\@]+\@)?\[([^\]]+)\](:(\d+))?(\/\S*)?$/ ||
7680     $_[0] =~ /^(http|https):\/\/([^\@]+\@)?([^:\/]+)(:(\d+))?(\/\S*)?$/) {
7681         # An absolute URL
7682         my $ssl = $1 eq 'https';
7683         my @rv = ($3, $4 ? $5 : $ssl ? 443 : 80, $6 || "/", $ssl);
7684         if ($2 =~ /^([^:]+):(\S+)\@/) {
7685                 push(@rv, $1, $2);
7686                 }
7687         return @rv;
7688         }
7689 elsif (!$_[1]) {
7690         # Could not parse
7691         return undef;
7692         }
7693 elsif ($_[0] =~ /^\/\S*$/) {
7694         # A relative to the server URL
7695         return ($_[1], $_[2], $_[0], $_[4], $_[5], $_[6]);
7696         }
7697 else {
7698         # A relative to the directory URL
7699         my $page = $_[3];
7700         $page =~ s/[^\/]+$//;
7701         return ($_[1], $_[2], $page.$_[0], $_[4], $_[5], $_[6]);
7702         }
7703 }
7704
7705 =head2 check_clicks_function
7706
7707 Returns HTML for a JavaScript function called check_clicks that returns
7708 true when first called, but false subsequently. Useful on onClick for
7709 critical buttons. Deprecated, as this method of preventing duplicate actions
7710 is un-reliable.
7711
7712 =cut
7713 sub check_clicks_function
7714 {
7715 return <<EOF;
7716 <script>
7717 clicks = 0;
7718 function check_clicks(form)
7719 {
7720 clicks++;
7721 if (clicks == 1)
7722         return true;
7723 else {
7724         if (form != null) {
7725                 for(i=0; i<form.length; i++)
7726                         form.elements[i].disabled = true;
7727                 }
7728         return false;
7729         }
7730 }
7731 </script>
7732 EOF
7733 }
7734
7735 =head2 load_entities_map
7736
7737 Returns a hash ref containing mappings between HTML entities (like ouml) and
7738 ascii values (like 246). Mainly for internal use.
7739
7740 =cut
7741 sub load_entities_map
7742 {
7743 if (!%entities_map_cache) {
7744         local $_;
7745         open(EMAP, "$root_directory/entities_map.txt");
7746         while(<EMAP>) {
7747                 if (/^(\d+)\s+(\S+)/) {
7748                         $entities_map_cache{$2} = $1;
7749                         }
7750                 }
7751         close(EMAP);
7752         }
7753 return \%entities_map_cache;
7754 }
7755
7756 =head2 entities_to_ascii(string)
7757
7758 Given a string containing HTML entities like &ouml; and &#55;, replace them
7759 with their ASCII equivalents.
7760
7761 =cut
7762 sub entities_to_ascii
7763 {
7764 my ($str) = @_;
7765 my $emap = &load_entities_map();
7766 $str =~ s/&([a-z]+);/chr($emap->{$1})/ge;
7767 $str =~ s/&#(\d+);/chr($1)/ge;
7768 return $str;
7769 }
7770
7771 =head2 get_product_name
7772
7773 Returns either 'webmin' or 'usermin', depending on which program the current
7774 module is in. Useful for modules that can be installed into either.
7775
7776 =cut
7777 sub get_product_name
7778 {
7779 return $gconfig{'product'} if (defined($gconfig{'product'}));
7780 return defined($gconfig{'userconfig'}) ? 'usermin' : 'webmin';
7781 }
7782
7783 =head2 get_charset
7784
7785 Returns the character set for the current language, such as iso-8859-1.
7786
7787 =cut
7788 sub get_charset
7789 {
7790 my $charset = defined($gconfig{'charset'}) ? $gconfig{'charset'} :
7791                  $current_lang_info->{'charset'} ?
7792                  $current_lang_info->{'charset'} : $default_charset;
7793 return $charset;
7794 }
7795
7796 =head2 get_display_hostname
7797
7798 Returns the system's hostname for UI display purposes. This may be different
7799 from the actual hostname if you administrator has configured it so in the
7800 Webmin Configuration module.
7801
7802 =cut
7803 sub get_display_hostname
7804 {
7805 if ($gconfig{'hostnamemode'} == 0) {
7806         return &get_system_hostname();
7807         }
7808 elsif ($gconfig{'hostnamemode'} == 3) {
7809         return $gconfig{'hostnamedisplay'};
7810         }
7811 else {
7812         my $h = $ENV{'HTTP_HOST'};
7813         $h =~ s/:\d+//g;
7814         if ($gconfig{'hostnamemode'} == 2) {
7815                 $h =~ s/^(www|ftp|mail)\.//i;
7816                 }
7817         return $h;
7818         }
7819 }
7820
7821 =head2 save_module_config([&config], [modulename])
7822
7823 Saves the configuration for some module. The config parameter is an optional
7824 hash reference of names and values to save, which defaults to the global
7825 %config hash. The modulename parameter is the module to update the config
7826 file, which defaults to the current module.
7827
7828 =cut
7829 sub save_module_config
7830 {
7831 my $c = $_[0] || { &get_module_variable('%config') };
7832 my $m = defined($_[1]) ? $_[1] : &get_module_name();
7833 &write_file("$config_directory/$m/config", $c);
7834 }
7835
7836 =head2 save_user_module_config([&config], [modulename])
7837
7838 Saves the user's Usermin preferences for some module. The config parameter is
7839 an optional hash reference of names and values to save, which defaults to the
7840 global %userconfig hash. The modulename parameter is the module to update the
7841 config file, which defaults to the current module.
7842
7843 =cut
7844 sub save_user_module_config
7845 {
7846 my $c = $_[0] || { &get_module_variable('%userconfig') };
7847 my $m = $_[1] || &get_module_name();
7848 my $ucd = $user_config_directory;
7849 if (!$ucd) {
7850         my @uinfo = @remote_user_info ? @remote_user_info
7851                                       : getpwnam($remote_user);
7852         return if (!@uinfo || !$uinfo[7]);
7853         $ucd = "$uinfo[7]/$gconfig{'userconfig'}";
7854         }
7855 &write_file("$ucd/$m/config", $c);
7856 }
7857
7858 =head2 nice_size(bytes, [min])
7859
7860 Converts a number of bytes into a number followed by a suffix like GB, MB
7861 or kB. Rounding is to two decimal digits. The optional min parameter sets the
7862 smallest units to use - so you could pass 1024*1024 to never show bytes or kB.
7863
7864 =cut
7865 sub nice_size
7866 {
7867 my ($units, $uname);
7868 if (abs($_[0]) > 1024*1024*1024*1024 || $_[1] >= 1024*1024*1024*1024) {
7869         $units = 1024*1024*1024*1024;
7870         $uname = "TB";
7871         }
7872 elsif (abs($_[0]) > 1024*1024*1024 || $_[1] >= 1024*1024*1024) {
7873         $units = 1024*1024*1024;
7874         $uname = "GB";
7875         }
7876 elsif (abs($_[0]) > 1024*1024 || $_[1] >= 1024*1024) {
7877         $units = 1024*1024;
7878         $uname = "MB";
7879         }
7880 elsif (abs($_[0]) > 1024 || $_[1] >= 1024) {
7881         $units = 1024;
7882         $uname = "kB";
7883         }
7884 else {
7885         $units = 1;
7886         $uname = "bytes";
7887         }
7888 my $sz = sprintf("%.2f", ($_[0]*1.0 / $units));
7889 $sz =~ s/\.00$//;
7890 return $sz." ".$uname;
7891 }
7892
7893 =head2 get_perl_path
7894
7895 Returns the path to Perl currently in use, such as /usr/bin/perl.
7896
7897 =cut
7898 sub get_perl_path
7899 {
7900 if (open(PERL, "$config_directory/perl-path")) {
7901         my $rv;
7902         chop($rv = <PERL>);
7903         close(PERL);
7904         return $rv;
7905         }
7906 return $^X if (-x $^X);
7907 return &has_command("perl");
7908 }
7909
7910 =head2 get_goto_module([&mods])
7911
7912 Returns the details of a module that the current user should be re-directed
7913 to after logging in, or undef if none. Useful for themes.
7914
7915 =cut
7916 sub get_goto_module
7917 {
7918 my @mods = $_[0] ? @{$_[0]} : &get_visible_module_infos();
7919 if ($gconfig{'gotomodule'}) {
7920         my ($goto) = grep { $_->{'dir'} eq $gconfig{'gotomodule'} } @mods;
7921         return $goto if ($goto);
7922         }
7923 if (@mods == 1 && $gconfig{'gotoone'}) {
7924         return $mods[0];
7925         }
7926 return undef;
7927 }
7928
7929 =head2 select_all_link(field, form, [text])
7930
7931 Returns HTML for a 'Select all' link that uses Javascript to select
7932 multiple checkboxes with the same name. The parameters are :
7933
7934 =item field - Name of the checkbox inputs.
7935
7936 =item form - Index of the form on the page.
7937
7938 =item text - Message for the link, defaulting to 'Select all'.
7939
7940 =cut
7941 sub select_all_link
7942 {
7943 return &theme_select_all_link(@_) if (defined(&theme_select_all_link));
7944 my ($field, $form, $text) = @_;
7945 $form = int($form);
7946 $text ||= $text{'ui_selall'};
7947 return "<a class='select_all' href='#' onClick='var ff = document.forms[$form].$field; ff.checked = true; for(i=0; i<ff.length; i++) { if (!ff[i].disabled) { ff[i].checked = true; } } return false'>$text</a>";
7948 }
7949
7950 =head2 select_invert_link(field, form, text)
7951
7952 Returns HTML for an 'Invert selection' link that uses Javascript to invert the
7953 selection on multiple checkboxes with the same name. The parameters are :
7954
7955 =item field - Name of the checkbox inputs.
7956
7957 =item form - Index of the form on the page.
7958
7959 =item text - Message for the link, defaulting to 'Invert selection'.
7960
7961 =cut
7962 sub select_invert_link
7963 {
7964 return &theme_select_invert_link(@_) if (defined(&theme_select_invert_link));
7965 my ($field, $form, $text) = @_;
7966 $form = int($form);
7967 $text ||= $text{'ui_selinv'};
7968 return "<a class='select_invert' href='#' onClick='var ff = document.forms[$form].$field; ff.checked = !ff.checked; for(i=0; i<ff.length; i++) { if (!ff[i].disabled) { ff[i].checked = !ff[i].checked; } } return false'>$text</a>";
7969 }
7970
7971 =head2 select_rows_link(field, form, text, &rows)
7972
7973 Returns HTML for a link that uses Javascript to select rows with particular
7974 values for their checkboxes. The parameters are :
7975
7976 =item field - Name of the checkbox inputs.
7977
7978 =item form - Index of the form on the page.
7979
7980 =item text - Message for the link, de
7981
7982 =item rows - Reference to an array of 1 or 0 values, indicating which rows to check.
7983
7984 =cut
7985 sub select_rows_link
7986 {
7987 return &theme_select_rows_link(@_) if (defined(&theme_select_rows_link));
7988 my ($field, $form, $text, $rows) = @_;
7989 $form = int($form);
7990 my $js = "var sel = { ".join(",", map { "\"".&quote_escape($_)."\":1" } @$rows)." }; ";
7991 $js .= "for(var i=0; i<document.forms[$form].${field}.length; i++) { var r = document.forms[$form].${field}[i]; r.checked = sel[r.value]; } ";
7992 $js .= "return false;";
7993 return "<a href='#' onClick='$js'>$text</a>";
7994 }
7995
7996 =head2 check_pid_file(file)
7997
7998 Given a pid file, returns the PID it contains if the process is running.
7999
8000 =cut
8001 sub check_pid_file
8002 {
8003 open(PIDFILE, $_[0]) || return undef;
8004 my $pid = <PIDFILE>;
8005 close(PIDFILE);
8006 $pid =~ /^\s*(\d+)/ || return undef;
8007 kill(0, $1) || return undef;
8008 return $1;
8009 }
8010
8011 =head2 get_mod_lib
8012
8013 Return the local os-specific library name to this module. For internal use only.
8014
8015 =cut
8016 sub get_mod_lib
8017 {
8018 my $mn = &get_module_name();
8019 my $md = &module_root_directory($mn);
8020 if (-r "$md/$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl") {
8021         return "$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl";
8022         }
8023 elsif (-r "$md/$mn-$gconfig{'os_type'}-lib.pl") {
8024         return "$mn-$gconfig{'os_type'}-lib.pl";
8025         }
8026 elsif (-r "$md/$mn-generic-lib.pl") {
8027         return "$mn-generic-lib.pl";
8028         }
8029 else {
8030         return "";
8031         }
8032 }
8033
8034 =head2 module_root_directory(module)
8035
8036 Given a module name, returns its root directory. On a typical Webmin install,
8037 all modules are under the same directory - but it is theoretically possible to
8038 have more than one.
8039
8040 =cut
8041 sub module_root_directory
8042 {
8043 my $d = ref($_[0]) ? $_[0]->{'dir'} : $_[0];
8044 if (@root_directories > 1) {
8045         foreach my $r (@root_directories) {
8046                 if (-d "$r/$d") {
8047                         return "$r/$d";
8048                         }
8049                 }
8050         }
8051 return "$root_directories[0]/$d";
8052 }
8053
8054 =head2 list_mime_types
8055
8056 Returns a list of all known MIME types and their extensions, as a list of hash
8057 references with keys :
8058
8059 =item type - The MIME type, like text/plain.
8060
8061 =item exts - A list of extensions, like .doc and .avi.
8062
8063 =item desc - A human-readable description for the MIME type.
8064
8065 =cut
8066 sub list_mime_types
8067 {
8068 if (!@list_mime_types_cache) {
8069         local $_;
8070         open(MIME, "$root_directory/mime.types");
8071         while(<MIME>) {
8072                 my $cmt;
8073                 s/\r|\n//g;
8074                 if (s/#\s*(.*)$//g) {
8075                         $cmt = $1;
8076                         }
8077                 my ($type, @exts) = split(/\s+/);
8078                 if ($type) {
8079                         push(@list_mime_types_cache, { 'type' => $type,
8080                                                        'exts' => \@exts,
8081                                                        'desc' => $cmt });
8082                         }
8083                 }
8084         close(MIME);
8085         }
8086 return @list_mime_types_cache;
8087 }
8088
8089 =head2 guess_mime_type(filename, [default])
8090
8091 Given a file name like xxx.gif or foo.html, returns a guessed MIME type.
8092 The optional default parameter sets a default type of use if none is found,
8093 which defaults to application/octet-stream.
8094
8095 =cut
8096 sub guess_mime_type
8097 {
8098 if ($_[0] =~ /\.([A-Za-z0-9\-]+)$/) {
8099         my $ext = $1;
8100         foreach my $t (&list_mime_types()) {
8101                 foreach my $e (@{$t->{'exts'}}) {
8102                         return $t->{'type'} if (lc($e) eq lc($ext));
8103                         }
8104                 }
8105         }
8106 return @_ > 1 ? $_[1] : "application/octet-stream";
8107 }
8108
8109 =head2 open_tempfile([handle], file, [no-error], [no-tempfile], [safe?])
8110
8111 Opens a file handle for writing to a temporary file, which will only be
8112 renamed over the real file when the handle is closed. This allows critical
8113 files like /etc/shadow to be updated safely, even if writing fails part way
8114 through due to lack of disk space. The parameters are :
8115
8116 =item handle - File handle to open, as you would use in Perl's open function.
8117
8118 =item file - Full path to the file to write, prefixed by > or >> to indicate over-writing or appending. In append mode, no temp file is used.
8119
8120 =item no-error - By default, this function will call error if the open fails. Setting this parameter to 1 causes it to return 0 on failure, and set $! with the error code.
8121
8122 =item no-tempfile - If set to 1, writing will be direct to the file instead of using a temporary file.
8123
8124 =item safe - Indicates to users in read-only mode that this write is safe and non-destructive.
8125
8126 =cut
8127 sub open_tempfile
8128 {
8129 if (@_ == 1) {
8130         # Just getting a temp file
8131         if (!defined($main::open_tempfiles{$_[0]})) {
8132                 $_[0] =~ /^(.*)\/(.*)$/ || return $_[0];
8133                 my $dir = $1 || "/";
8134                 my $tmp = "$dir/$2.webmintmp.$$";
8135                 $main::open_tempfiles{$_[0]} = $tmp;
8136                 push(@main::temporary_files, $tmp);
8137                 }
8138         return $main::open_tempfiles{$_[0]};
8139         }
8140 else {
8141         # Actually opening
8142         my ($fh, $file, $noerror, $notemp, $safe) = @_;
8143         $fh = &callers_package($fh);
8144
8145         my %gaccess = &get_module_acl(undef, "");
8146         my $db = $gconfig{'debug_what_write'};
8147         if ($file =~ /\r|\n|\0/) {
8148                 if ($noerror) { return 0; }
8149                 else { &error("Filename contains invalid characters"); }
8150                 }
8151         if (&is_readonly_mode() && $file =~ />/ && !$safe) {
8152                 # Read-only mode .. veto all writes
8153                 print STDERR "vetoing write to $file\n";
8154                 return open($fh, ">$null_file");
8155                 }
8156         elsif ($file =~ /^(>|>>|)nul$/i) {
8157                 # Write to Windows null device
8158                 &webmin_debug_log($1 eq ">" ? "WRITE" :
8159                           $1 eq ">>" ? "APPEND" : "READ", "nul") if ($db);
8160                 }
8161         elsif ($file =~ /^(>|>>)(\/dev\/.*)/ || lc($file) eq "nul") {
8162                 # Writes to /dev/null or TTYs don't need to be handled
8163                 &webmin_debug_log($1 eq ">" ? "WRITE" : "APPEND", $2) if ($db);
8164                 return open($fh, $file);
8165                 }
8166         elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && !$notemp) {
8167                 &webmin_debug_log("WRITE", $1) if ($db);
8168                 # Over-writing a file, via a temp file
8169                 $file = $1;
8170                 $file = &translate_filename($file);
8171                 while(-l $file) {
8172                         # Open the link target instead
8173                         $file = &resolve_links($file);
8174                         }
8175                 if (-d $file) {
8176                         # Cannot open a directory!
8177                         if ($noerror) { return 0; }
8178                         else { &error("Cannot write to directory $file"); }
8179                         }
8180                 my $tmp = &open_tempfile($file);
8181                 my $ex = open($fh, ">$tmp");
8182                 if (!$ex && $! =~ /permission/i) {
8183                         # Could not open temp file .. try opening actual file
8184                         # instead directly
8185                         $ex = open($fh, ">$file");
8186                         delete($main::open_tempfiles{$file});
8187                         }
8188                 else {
8189                         $main::open_temphandles{$fh} = $file;
8190                         }
8191                 binmode($fh);
8192                 if (!$ex && !$noerror) {
8193                         &error(&text("efileopen", $file, $!));
8194                         }
8195                 return $ex;
8196                 }
8197         elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && $notemp) {
8198                 # Just writing direct to a file
8199                 &webmin_debug_log("WRITE", $1) if ($db);
8200                 $file = $1;
8201                 $file = &translate_filename($file);
8202                 my @old_attributes = &get_clear_file_attributes($file);
8203                 my $ex = open($fh, ">$file");
8204                 &reset_file_attributes($file, \@old_attributes);
8205                 $main::open_temphandles{$fh} = $file;
8206                 if (!$ex && !$noerror) {
8207                         &error(&text("efileopen", $file, $!));
8208                         }
8209                 binmode($fh);
8210                 return $ex;
8211                 }
8212         elsif ($file =~ /^>>\s*(([a-zA-Z]:)?\/.*)$/) {
8213                 # Appending to a file .. nothing special to do
8214                 &webmin_debug_log("APPEND", $1) if ($db);
8215                 $file = $1;
8216                 $file = &translate_filename($file);
8217                 my @old_attributes = &get_clear_file_attributes($file);
8218                 my $ex = open($fh, ">>$file");
8219                 &reset_file_attributes($file, \@old_attributes);
8220                 $main::open_temphandles{$fh} = $file;
8221                 if (!$ex && !$noerror) {
8222                         &error(&text("efileopen", $file, $!));
8223                         }
8224                 binmode($fh);
8225                 return $ex;
8226                 }
8227         elsif ($file =~ /^([a-zA-Z]:)?\//) {
8228                 # Read mode .. nothing to do here
8229                 &webmin_debug_log("READ", $file) if ($db);
8230                 $file = &translate_filename($file);
8231                 return open($fh, $file);
8232                 }
8233         elsif ($file eq ">" || $file eq ">>") {
8234                 my ($package, $filename, $line) = caller;
8235                 if ($noerror) { return 0; }
8236                 else { &error("Missing file to open at ${package}::${filename} line $line"); }
8237                 }
8238         else {
8239                 my ($package, $filename, $line) = caller;
8240                 &error("Unsupported file or mode $file at ${package}::${filename} line $line");
8241                 }
8242         }
8243 }
8244
8245 =head2 close_tempfile(file|handle)
8246
8247 Copies a temp file to the actual file, assuming that all writes were
8248 successful. The handle must have been one passed to open_tempfile.
8249
8250 =cut
8251 sub close_tempfile
8252 {
8253 my $file;
8254 my $fh = &callers_package($_[0]);
8255
8256 if (defined($file = $main::open_temphandles{$fh})) {
8257         # Closing a handle
8258         close($fh) || &error(&text("efileclose", $file, $!));
8259         delete($main::open_temphandles{$fh});
8260         return &close_tempfile($file);
8261         }
8262 elsif (defined($main::open_tempfiles{$_[0]})) {
8263         # Closing a file
8264         &webmin_debug_log("CLOSE", $_[0]) if ($gconfig{'debug_what_write'});
8265         my @st = stat($_[0]);
8266         if (&is_selinux_enabled() && &has_command("chcon")) {
8267                 # Set original security context
8268                 system("chcon --reference=".quotemeta($_[0]).
8269                        " ".quotemeta($main::open_tempfiles{$_[0]}).
8270                        " >/dev/null 2>&1");
8271                 }
8272         my @old_attributes = &get_clear_file_attributes($_[0]);
8273         rename($main::open_tempfiles{$_[0]}, $_[0]) || &error("Failed to replace $_[0] with $main::open_tempfiles{$_[0]} : $!");
8274         if (@st) {
8275                 # Set original permissions and ownership
8276                 chmod($st[2], $_[0]);
8277                 chown($st[4], $st[5], $_[0]);
8278                 }
8279         &reset_file_attributes($_[0], \@old_attributes);
8280         delete($main::open_tempfiles{$_[0]});
8281         @main::temporary_files = grep { $_ ne $main::open_tempfiles{$_[0]} } @main::temporary_files;
8282         if ($main::open_templocks{$_[0]}) {
8283                 &unlock_file($_[0]);
8284                 delete($main::open_templocks{$_[0]});
8285                 }
8286         return 1;
8287         }
8288 else {
8289         # Must be closing a handle not associated with a file
8290         close($_[0]);
8291         return 1;
8292         }
8293 }
8294
8295 =head2 print_tempfile(handle, text, ...)
8296
8297 Like the normal print function, but calls &error on failure. Useful when
8298 combined with open_tempfile, to ensure that a criticial file is never
8299 only partially written.
8300
8301 =cut
8302 sub print_tempfile
8303 {
8304 my ($fh, @args) = @_;
8305 $fh = &callers_package($fh);
8306 (print $fh @args) || &error(&text("efilewrite",
8307                             $main::open_temphandles{$fh} || $fh, $!));
8308 }
8309
8310 =head2 is_selinux_enabled
8311
8312 Returns 1 if SElinux is supported on this system and enabled, 0 if not.
8313
8314 =cut
8315 sub is_selinux_enabled
8316 {
8317 if (!defined($main::selinux_enabled_cache)) {
8318         my %seconfig;
8319         if ($gconfig{'os_type'} !~ /-linux$/) {
8320                 # Not on linux, so no way
8321                 $main::selinux_enabled_cache = 0;
8322                 }
8323         elsif (&read_env_file("/etc/selinux/config", \%seconfig)) {
8324                 # Use global config file
8325                 $main::selinux_enabled_cache =
8326                         $seconfig{'SELINUX'} eq 'disabled' ||
8327                         !$seconfig{'SELINUX'} ? 0 : 1;
8328                 }
8329         else {
8330                 # Use selinuxenabled command
8331                 #$selinux_enabled_cache =
8332                 #       system("selinuxenabled >/dev/null 2>&1") ? 0 : 1;
8333                 $main::selinux_enabled_cache = 0;
8334                 }
8335         }
8336 return $main::selinux_enabled_cache;
8337 }
8338
8339 =head2 get_clear_file_attributes(file)
8340
8341 Finds file attributes that may prevent writing, clears them and returns them
8342 as a list. May call error. Mainly for internal use by open_tempfile and
8343 close_tempfile.
8344
8345 =cut
8346 sub get_clear_file_attributes
8347 {
8348 my ($file) = @_;
8349 my @old_attributes;
8350 if ($gconfig{'chattr'}) {
8351         # Get original immutable bit
8352         my $out = &backquote_command(
8353                 "lsattr ".quotemeta($file)." 2>/dev/null");
8354         if (!$?) {
8355                 $out =~ s/\s\S+\n//;
8356                 @old_attributes = grep { $_ ne '-' } split(//, $out);
8357                 }
8358         if (&indexof("i", @old_attributes) >= 0) {
8359                 my $err = &backquote_logged(
8360                         "chattr -i ".quotemeta($file)." 2>&1");
8361                 if ($?) {
8362                         &error("Failed to remove immutable bit on ".
8363                                "$file : $err");
8364                         }
8365                 }
8366         }
8367 return @old_attributes;
8368 }
8369
8370 =head2 reset_file_attributes(file, &attributes)
8371
8372 Put back cleared attributes on some file. May call error. Mainly for internal
8373 use by close_tempfile.
8374
8375 =cut
8376 sub reset_file_attributes
8377 {
8378 my ($file, $old_attributes) = @_;
8379 if (&indexof("i", @$old_attributes) >= 0) {
8380         my $err = &backquote_logged(
8381                 "chattr +i ".quotemeta($file)." 2>&1");
8382         if ($?) {
8383                 &error("Failed to restore immutable bit on ".
8384                        "$file : $err");
8385                 }
8386         }
8387 }
8388
8389 =head2 cleanup_tempnames
8390
8391 Remove all temporary files generated using transname. Typically only called
8392 internally when a Webmin script exits.
8393
8394 =cut
8395 sub cleanup_tempnames
8396 {
8397 foreach my $t (@main::temporary_files) {
8398         &unlink_file($t);
8399         }
8400 @main::temporary_files = ( );
8401 }
8402
8403 =head2 open_lock_tempfile([handle], file, [no-error])
8404
8405 Returns a temporary file for writing to some actual file, and also locks it.
8406 Effectively the same as calling lock_file and open_tempfile on the same file,
8407 but calls the unlock for you automatically when it is closed.
8408
8409 =cut
8410 sub open_lock_tempfile
8411 {
8412 my ($fh, $file, $noerror, $notemp, $safe) = @_;
8413 $fh = &callers_package($fh);
8414 my $lockfile = $file;
8415 $lockfile =~ s/^[^\/]*//;
8416 if ($lockfile =~ /^\//) {
8417         $main::open_templocks{$lockfile} = &lock_file($lockfile);
8418         }
8419 return &open_tempfile($fh, $file, $noerror, $notemp, $safe);
8420 }
8421
8422 sub END
8423 {
8424 $main::end_exit_status ||= $?;
8425 if ($$ == $main::initial_process_id) {
8426         # Exiting from initial process
8427         &cleanup_tempnames();
8428         if ($gconfig{'debug_what_start'} && $main::debug_log_start_time &&
8429             $main::debug_log_start_module eq &get_module_name()) {
8430                 my $len = time() - $main::debug_log_start_time;
8431                 &webmin_debug_log("STOP", "runtime=$len");
8432                 $main::debug_log_start_time = 0;
8433                 }
8434         if (!$ENV{'SCRIPT_NAME'} &&
8435             $main::initial_module_name eq &get_module_name()) {
8436                 # In a command-line script - call the real exit, so that the
8437                 # exit status gets properly propogated. In some cases this
8438                 # was not happening.
8439                 exit($main::end_exit_status);
8440                 }
8441         }
8442 }
8443
8444 =head2 month_to_number(month)
8445
8446 Converts a month name like feb to a number like 1.
8447
8448 =cut
8449 sub month_to_number
8450 {
8451 return $month_to_number_map{lc(substr($_[0], 0, 3))};
8452 }
8453
8454 =head2 number_to_month(number)
8455
8456 Converts a number like 1 to a month name like Feb.
8457
8458 =cut
8459 sub number_to_month
8460 {
8461 return ucfirst($number_to_month_map{$_[0]});
8462 }
8463
8464 =head2 get_rbac_module_acl(user, module)
8465
8466 Returns a hash reference of RBAC overrides ACLs for some user and module.
8467 May return undef if none exist (indicating access denied), or the string *
8468 if full access is granted.
8469
8470 =cut
8471 sub get_rbac_module_acl
8472 {
8473 my ($user, $mod) = @_;
8474 eval "use Authen::SolarisRBAC";
8475 return undef if ($@);
8476 my %rv;
8477 my $foundany = 0;
8478 if (Authen::SolarisRBAC::chkauth("webmin.$mod.admin", $user)) {
8479         # Automagic webmin.modulename.admin authorization exists .. allow access
8480         $foundany = 1;
8481         if (!Authen::SolarisRBAC::chkauth("webmin.$mod.config", $user)) {
8482                 %rv = ( 'noconfig' => 1 );
8483                 }
8484         else {
8485                 %rv = ( );
8486                 }
8487         }
8488 local $_;
8489 open(RBAC, &module_root_directory($mod)."/rbac-mapping");
8490 while(<RBAC>) {
8491         s/\r|\n//g;
8492         s/#.*$//;
8493         my ($auths, $acls) = split(/\s+/, $_);
8494         my @auths = split(/,/, $auths);
8495         next if (!$auths);
8496         my ($merge) = ($acls =~ s/^\+//);
8497         my $gotall = 1;
8498         if ($auths eq "*") {
8499                 # These ACLs apply to all RBAC users.
8500                 # Only if there is some that match a specific authorization
8501                 # later will they be used though.
8502                 }
8503         else {
8504                 # Check each of the RBAC authorizations
8505                 foreach my $a (@auths) {
8506                         if (!Authen::SolarisRBAC::chkauth($a, $user)) {
8507                                 $gotall = 0;
8508                                 last;
8509                                 }
8510                         }
8511                 $foundany++ if ($gotall);
8512                 }
8513         if ($gotall) {
8514                 # Found an RBAC authorization - return the ACLs
8515                 return "*" if ($acls eq "*");
8516                 my %acl = map { split(/=/, $_, 2) } split(/,/, $acls);
8517                 if ($merge) {
8518                         # Just add to current set
8519                         foreach my $a (keys %acl) {
8520                                 $rv{$a} = $acl{$a};
8521                                 }
8522                         }
8523                 else {
8524                         # Found final ACLs
8525                         return \%acl;
8526                         }
8527                 }
8528         }
8529 close(RBAC);
8530 return !$foundany ? undef : %rv ? \%rv : undef;
8531 }
8532
8533 =head2 supports_rbac([module])
8534
8535 Returns 1 if RBAC client support is available, such as on Solaris.
8536
8537 =cut
8538 sub supports_rbac
8539 {
8540 return 0 if ($gconfig{'os_type'} ne 'solaris');
8541 eval "use Authen::SolarisRBAC";
8542 return 0 if ($@);
8543 if ($_[0]) {
8544         #return 0 if (!-r &module_root_directory($_[0])."/rbac-mapping");
8545         }
8546 return 1;
8547 }
8548
8549 =head2 supports_ipv6()
8550
8551 Returns 1 if outgoing IPv6 connections can be made
8552
8553 =cut
8554 sub supports_ipv6
8555 {
8556 return $ipv6_module_error ? 0 : 1;
8557 }
8558
8559 =head2 use_rbac_module_acl(user, module)
8560
8561 Returns 1 if some user should use RBAC to get permissions for a module
8562
8563 =cut
8564 sub use_rbac_module_acl
8565 {
8566 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
8567 my $m = defined($_[1]) ? $_[1] : &get_module_name();
8568 return 1 if ($gconfig{'rbacdeny_'.$u});         # RBAC forced for user
8569 my %access = &get_module_acl($u, $m, 1);
8570 return $access{'rbac'} ? 1 : 0;
8571 }
8572
8573 =head2 execute_command(command, stdin, stdout, stderr, translate-files?, safe?)
8574
8575 Runs some command, possibly feeding it input and capturing output to the
8576 give files or scalar references. The parameters are :
8577
8578 =item command - Full command to run, possibly including shell meta-characters.
8579
8580 =item stdin - File to read input from, or a scalar ref containing input, or undef if no input should be given.
8581
8582 =item stdout - File to write output to, or a scalar ref into which output should be placed, or undef if the output is to be discarded.
8583
8584 =item stderr - File to write error output to, or a scalar ref into which error output should be placed, or undef if the error output is to be discarded.
8585
8586 =item translate-files - Set to 1 to apply filename translation to any filenames. Usually has no effect.
8587
8588 =item safe - Set to 1 if this command is safe and does not modify the state of the system.
8589
8590 =cut
8591 sub execute_command
8592 {
8593 my ($cmd, $stdin, $stdout, $stderr, $trans, $safe) = @_;
8594 if (&is_readonly_mode() && !$safe) {
8595         print STDERR "Vetoing command $_[0]\n";
8596         $? = 0;
8597         return 0;
8598         }
8599 $cmd = &translate_command($cmd);
8600
8601 # Use ` operator where possible
8602 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
8603 if (!$stdin && ref($stdout) && !$stderr) {
8604         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8605         $$stdout = `$cmd 2>$null_file`;
8606         return $?;
8607         }
8608 elsif (!$stdin && ref($stdout) && $stdout eq $stderr) {
8609         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8610         $$stdout = `$cmd 2>&1`;
8611         return $?;
8612         }
8613 elsif (!$stdin && !$stdout && !$stderr) {
8614         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8615         return system("$cmd >$null_file 2>$null_file <$null_file");
8616         }
8617
8618 # Setup pipes
8619 $| = 1;         # needed on some systems to flush before forking
8620 pipe(EXECSTDINr, EXECSTDINw);
8621 pipe(EXECSTDOUTr, EXECSTDOUTw);
8622 pipe(EXECSTDERRr, EXECSTDERRw);
8623 my $pid;
8624 if (!($pid = fork())) {
8625         untie(*STDIN);
8626         untie(*STDOUT);
8627         untie(*STDERR);
8628         open(STDIN, "<&EXECSTDINr");
8629         open(STDOUT, ">&EXECSTDOUTw");
8630         if (ref($stderr) && $stderr eq $stdout) {
8631                 open(STDERR, ">&EXECSTDOUTw");
8632                 }
8633         else {
8634                 open(STDERR, ">&EXECSTDERRw");
8635                 }
8636         $| = 1;
8637         close(EXECSTDINw);
8638         close(EXECSTDOUTr);
8639         close(EXECSTDERRr);
8640
8641         my $fullcmd = "($cmd)";
8642         if ($stdin && !ref($stdin)) {
8643                 $fullcmd .= " <$stdin";
8644                 }
8645         if ($stdout && !ref($stdout)) {
8646                 $fullcmd .= " >$stdout";
8647                 }
8648         if ($stderr && !ref($stderr)) {
8649                 if ($stderr eq $stdout) {
8650                         $fullcmd .= " 2>&1";
8651                         }
8652                 else {
8653                         $fullcmd .= " 2>$stderr";
8654                         }
8655                 }
8656         if ($gconfig{'os_type'} eq 'windows') {
8657                 exec($fullcmd);
8658                 }
8659         else {
8660                 exec("/bin/sh", "-c", $fullcmd);
8661                 }
8662         print "Exec failed : $!\n";
8663         exit(1);
8664         }
8665 close(EXECSTDINr);
8666 close(EXECSTDOUTw);
8667 close(EXECSTDERRw);
8668
8669 # Feed input and capture output
8670 local $_;
8671 if ($stdin && ref($stdin)) {
8672         print EXECSTDINw $$stdin;
8673         close(EXECSTDINw);
8674         }
8675 if ($stdout && ref($stdout)) {
8676         $$stdout = undef;
8677         while(<EXECSTDOUTr>) {
8678                 $$stdout .= $_;
8679                 }
8680         close(EXECSTDOUTr);
8681         }
8682 if ($stderr && ref($stderr) && $stderr ne $stdout) {
8683         $$stderr = undef;
8684         while(<EXECSTDERRr>) {
8685                 $$stderr .= $_;
8686                 }
8687         close(EXECSTDERRr);
8688         }
8689
8690 # Get exit status
8691 waitpid($pid, 0);
8692 return $?;
8693 }
8694
8695 =head2 open_readfile(handle, file)
8696
8697 Opens some file for reading. Returns 1 on success, 0 on failure. Pretty much
8698 exactly the same as Perl's open function.
8699
8700 =cut
8701 sub open_readfile
8702 {
8703 my ($fh, $file) = @_;
8704 $fh = &callers_package($fh);
8705 my $realfile = &translate_filename($file);
8706 &webmin_debug_log('READ', $file) if ($gconfig{'debug_what_read'});
8707 return open($fh, "<".$realfile);
8708 }
8709
8710 =head2 open_execute_command(handle, command, output?, safe?)
8711
8712 Runs some command, with the specified file handle set to either write to it if
8713 in-or-out is set to 0, or read to it if output is set to 1. The safe flag
8714 indicates if the command modifies the state of the system or not.
8715
8716 =cut
8717 sub open_execute_command
8718 {
8719 my ($fh, $cmd, $mode, $safe) = @_;
8720 $fh = &callers_package($fh);
8721 my $realcmd = &translate_command($cmd);
8722 if (&is_readonly_mode() && !$safe) {
8723         # Don't actually run it
8724         print STDERR "vetoing command $cmd\n";
8725         $? = 0;
8726         if ($mode == 0) {
8727                 return open($fh, ">$null_file");
8728                 }
8729         else {
8730                 return open($fh, $null_file);
8731                 }
8732         }
8733 # Really run it
8734 &webmin_debug_log('CMD', "cmd=$realcmd mode=$mode")
8735         if ($gconfig{'debug_what_cmd'});
8736 if ($mode == 0) {
8737         return open($fh, "| $cmd");
8738         }
8739 elsif ($mode == 1) {
8740         return open($fh, "$cmd 2>$null_file |");
8741         }
8742 elsif ($mode == 2) {
8743         return open($fh, "$cmd 2>&1 |");
8744         }
8745 }
8746
8747 =head2 translate_filename(filename)
8748
8749 Applies all relevant registered translation functions to a filename. Mostly
8750 for internal use, and typically does nothing.
8751
8752 =cut
8753 sub translate_filename
8754 {
8755 my ($realfile) = @_;
8756 my @funcs = grep { $_->[0] eq &get_module_name() ||
8757                    !defined($_->[0]) } @main::filename_callbacks;
8758 foreach my $f (@funcs) {
8759         my $func = $f->[1];
8760         $realfile = &$func($realfile, @{$f->[2]});
8761         }
8762 return $realfile;
8763 }
8764
8765 =head2 translate_command(filename)
8766
8767 Applies all relevant registered translation functions to a command. Mostly
8768 for internal use, and typically does nothing.
8769
8770 =cut
8771 sub translate_command
8772 {
8773 my ($realcmd) = @_;
8774 my @funcs = grep { $_->[0] eq &get_module_name() ||
8775                    !defined($_->[0]) } @main::command_callbacks;
8776 foreach my $f (@funcs) {
8777         my $func = $f->[1];
8778         $realcmd = &$func($realcmd, @{$f->[2]});
8779         }
8780 return $realcmd;
8781 }
8782
8783 =head2 register_filename_callback(module|undef, &function, &args)
8784
8785 Registers some function to be called when the specified module (or all
8786 modules) tries to open a file for reading and writing. The function must
8787 return the actual file to open. This allows you to override which files
8788 other code actually operates on, via the translate_filename function.
8789
8790 =cut
8791 sub register_filename_callback
8792 {
8793 my ($mod, $func, $args) = @_;
8794 push(@main::filename_callbacks, [ $mod, $func, $args ]);
8795 }
8796
8797 =head2 register_command_callback(module|undef, &function, &args)
8798
8799 Registers some function to be called when the specified module (or all
8800 modules) tries to execute a command. The function must return the actual
8801 command to run. This allows you to override which commands other other code
8802 actually runs, via the translate_command function.
8803
8804 =cut
8805 sub register_command_callback
8806 {
8807 my ($mod, $func, $args) = @_;
8808 push(@main::command_callbacks, [ $mod, $func, $args ]);
8809 }
8810
8811 =head2 capture_function_output(&function, arg, ...)
8812
8813 Captures output that some function prints to STDOUT, and returns it. Useful
8814 for functions outside your control that print data when you really want to
8815 manipulate it before output.
8816
8817 =cut
8818 sub capture_function_output
8819 {
8820 my ($func, @args) = @_;
8821 socketpair(SOCKET2, SOCKET1, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
8822 my $old = select(SOCKET1);
8823 my @rv = &$func(@args);
8824 select($old);
8825 close(SOCKET1);
8826 my $out;
8827 local $_;
8828 while(<SOCKET2>) {
8829         $out .= $_;
8830         }
8831 close(SOCKET2);
8832 return wantarray ? ($out, \@rv) : $out;
8833 }
8834
8835 =head2 capture_function_output_tempfile(&function, arg, ...)
8836
8837 Behaves the same as capture_function_output, but uses a temporary file
8838 to avoid buffer full problems.
8839
8840 =cut
8841 sub capture_function_output_tempfile
8842 {
8843 my ($func, @args) = @_;
8844 my $temp = &transname();
8845 open(BUFFER, ">$temp");
8846 my $old = select(BUFFER);
8847 my @rv = &$func(@args);
8848 select($old);
8849 close(BUFFER);
8850 my $out = &read_file_contents($temp);
8851 &unlink_file($temp);
8852 return wantarray ? ($out, \@rv) : $out;
8853 }
8854
8855 =head2 modules_chooser_button(field, multiple, [form])
8856
8857 Returns HTML for a button for selecting one or many Webmin modules.
8858 field - Name of the HTML field to place the module names into.
8859 multiple - Set to 1 if multiple modules can be selected.
8860 form - Index of the form on the page.
8861
8862 =cut
8863 sub modules_chooser_button
8864 {
8865 return &theme_modules_chooser_button(@_)
8866         if (defined(&theme_modules_chooser_button));
8867 my $form = defined($_[2]) ? $_[2] : 0;
8868 my $w = $_[1] ? 700 : 500;
8869 my $h = 200;
8870 if ($_[1] && $gconfig{'db_sizemodules'}) {
8871         ($w, $h) = split(/x/, $gconfig{'db_sizemodules'});
8872         }
8873 elsif (!$_[1] && $gconfig{'db_sizemodule'}) {
8874         ($w, $h) = split(/x/, $gconfig{'db_sizemodule'});
8875         }
8876 return "<input type=button onClick='ifield = document.forms[$form].$_[0]; chooser = window.open(\"$gconfig{'webprefix'}/module_chooser.cgi?multi=$_[1]&module=\"+escape(ifield.value), \"chooser\", \"toolbar=no,menubar=no,scrollbars=yes,width=$w,height=$h\"); chooser.ifield = ifield; window.ifield = ifield' value=\"...\">\n";
8877 }
8878
8879 =head2 substitute_template(text, &hash)
8880
8881 Given some text and a hash reference, for each ocurrance of $FOO or ${FOO} in
8882 the text replaces it with the value of the hash key foo. Also supports blocks
8883 like ${IF-FOO} ... ${ENDIF-FOO}, whose contents are only included if foo is
8884 non-zero, and ${IF-FOO} ... ${ELSE-FOO} ... ${ENDIF-FOO}.
8885
8886 =cut
8887 sub substitute_template
8888 {
8889 # Add some extra fixed parameters to the hash
8890 my %hash = %{$_[1]};
8891 $hash{'hostname'} = &get_system_hostname();
8892 $hash{'webmin_config'} = $config_directory;
8893 $hash{'webmin_etc'} = $config_directory;
8894 $hash{'module_config'} = &get_module_variable('$module_config_directory');
8895 $hash{'webmin_var'} = $var_directory;
8896
8897 # Add time-based parameters, for use in DNS
8898 $hash{'current_time'} = time();
8899 my @tm = localtime($hash{'current_time'});
8900 $hash{'current_year'} = $tm[5]+1900;
8901 $hash{'current_month'} = sprintf("%2.2d", $tm[4]+1);
8902 $hash{'current_day'} = sprintf("%2.2d", $tm[3]);
8903 $hash{'current_hour'} = sprintf("%2.2d", $tm[2]);
8904 $hash{'current_minute'} = sprintf("%2.2d", $tm[1]);
8905 $hash{'current_second'} = sprintf("%2.2d", $tm[0]);
8906
8907 # Actually do the substition
8908 my $rv = $_[0];
8909 foreach my $s (keys %hash) {
8910         next if ($s eq '');     # Prevent just $ from being subbed
8911         my $us = uc($s);
8912         my $sv = $hash{$s};
8913         $rv =~ s/\$\{\Q$us\E\}/$sv/g;
8914         $rv =~ s/\$\Q$us\E/$sv/g;
8915         if ($sv) {
8916                 # Replace ${IF}..${ELSE}..${ENDIF} block with first value,
8917                 # and ${IF}..${ENDIF} with value
8918                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8919                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8920
8921                 # Replace $IF..$ELSE..$ENDIF block with first value,
8922                 # and $IF..$ENDIF with value
8923                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8924                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8925
8926                 # Replace ${IFEQ}..${ENDIFEQ} block with first value if
8927                 # matching, nothing if not
8928                 $rv =~ s/\$\{IFEQ-\Q$us\E-\Q$sv\E\}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-\Q$sv\E\}(\n?)/$2/g;
8929                 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8930
8931                 # Replace $IFEQ..$ENDIFEQ block with first value if
8932                 # matching, nothing if not
8933                 $rv =~ s/\$IFEQ-\Q$us\E-\Q$sv\E(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\Q$sv\E(\n?)/$2/g;
8934                 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8935                 }
8936         else {
8937                 # Replace ${IF}..${ELSE}..${ENDIF} block with second value,
8938                 # and ${IF}..${ENDIF} with nothing
8939                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$4/g;
8940                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)//g;
8941
8942                 # Replace $IF..$ELSE..$ENDIF block with second value,
8943                 # and $IF..$ENDIF with nothing
8944                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$4/g;
8945                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)//g;
8946
8947                 # Replace ${IFEQ}..${ENDIFEQ} block with nothing
8948                 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8949                 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8950                 }
8951         }
8952
8953 # Now assume any $IF blocks whose variables are not present in the hash
8954 # evaluate to false.
8955 # $IF...$ELSE x $ENDIF => x
8956 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ELSE\-\1\}(.*?)\$\{ENDIF\-\1\}/$2/gs;
8957 # $IF...x...$ENDIF => (nothing)
8958 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ENDIF\-\1\}//gs;
8959 # ${var} => (nothing)
8960 $rv =~ s/\$\{[A-Z]+\}//g;
8961
8962 return $rv;
8963 }
8964
8965 =head2 running_in_zone
8966
8967 Returns 1 if the current Webmin instance is running in a Solaris zone. Used to
8968 disable module and features that are not appropriate, like those that modify
8969 mounted filesystems.
8970
8971 =cut
8972 sub running_in_zone
8973 {
8974 return 0 if ($gconfig{'os_type'} ne 'solaris' ||
8975              $gconfig{'os_version'} < 10);
8976 my $zn = `zonename 2>$null_file`;
8977 chop($zn);
8978 return $zn && $zn ne "global";
8979 }
8980
8981 =head2 running_in_vserver
8982
8983 Returns 1 if the current Webmin instance is running in a Linux VServer.
8984 Used to disable modules and features that are not appropriate.
8985
8986 =cut
8987 sub running_in_vserver
8988 {
8989 return 0 if ($gconfig{'os_type'} !~ /^\*-linux$/);
8990 my $vserver;
8991 local $_;
8992 open(MTAB, "/etc/mtab");
8993 while(<MTAB>) {
8994         my ($dev, $mp) = split(/\s+/, $_);
8995         if ($mp eq "/" && $dev =~ /^\/dev\/hdv/) {
8996                 $vserver = 1;
8997                 last;
8998                 }
8999         }
9000 close(MTAB);
9001 return $vserver;
9002 }
9003
9004 =head2 running_in_xen
9005
9006 Returns 1 if Webmin is running inside a Xen instance, by looking
9007 at /proc/xen/capabilities.
9008
9009 =cut
9010 sub running_in_xen
9011 {
9012 return 0 if (!-r "/proc/xen/capabilities");
9013 my $cap = &read_file_contents("/proc/xen/capabilities");
9014 return $cap =~ /control_d/ ? 0 : 1;
9015 }
9016
9017 =head2 running_in_openvz
9018
9019 Returns 1 if Webmin is running inside an OpenVZ container, by looking
9020 at /proc/vz/veinfo for a non-zero line.
9021
9022 =cut
9023 sub running_in_openvz
9024 {
9025 return 0 if (!-r "/proc/vz/veinfo");
9026 my $lref = &read_file_lines("/proc/vz/veinfo", 1);
9027 return 0 if (!$lref || !@$lref);
9028 foreach my $l (@$lref) {
9029         $l =~ s/^\s+//;
9030         my @ll = split(/\s+/, $l);
9031         return 0 if ($ll[0] eq '0');
9032         }
9033 return 1;
9034 }
9035
9036 =head2 list_categories(&modules, [include-empty])
9037
9038 Returns a hash mapping category codes to names, including any custom-defined
9039 categories. The modules parameter must be an array ref of module hash objects,
9040 as returned by get_all_module_infos.
9041
9042 =cut
9043 sub list_categories
9044 {
9045 my ($mods, $empty) = @_;
9046 my (%cats, %catnames);
9047 &read_file("$config_directory/webmin.catnames", \%catnames);
9048 foreach my $o (@lang_order_list) {
9049         &read_file("$config_directory/webmin.catnames.$o", \%catnames);
9050         }
9051 if ($empty) {
9052         %cats = %catnames;
9053         }
9054 foreach my $m (@$mods) {
9055         my $c = $m->{'category'};
9056         next if ($cats{$c});
9057         if (defined($catnames{$c})) {
9058                 $cats{$c} = $catnames{$c};
9059                 }
9060         elsif ($text{"category_$c"}) {
9061                 $cats{$c} = $text{"category_$c"};
9062                 }
9063         else {
9064                 # try to get category name from module ..
9065                 my %mtext = &load_language($m->{'dir'});
9066                 if ($mtext{"category_$c"}) {
9067                         $cats{$c} = $mtext{"category_$c"};
9068                         }
9069                 else {
9070                         $c = $m->{'category'} = "";
9071                         $cats{$c} = $text{"category_$c"};
9072                         }
9073                 }
9074         }
9075 return %cats;
9076 }
9077
9078 =head2 is_readonly_mode
9079
9080 Returns 1 if the current user is in read-only mode, and thus all writes
9081 to files and command execution should fail.
9082
9083 =cut
9084 sub is_readonly_mode
9085 {
9086 if (!defined($main::readonly_mode_cache)) {
9087         my %gaccess = &get_module_acl(undef, "");
9088         $main::readonly_mode_cache = $gaccess{'readonly'} ? 1 : 0;
9089         }
9090 return $main::readonly_mode_cache;
9091 }
9092
9093 =head2 command_as_user(user, with-env?, command, ...)
9094
9095 Returns a command to execute some command as the given user, using the
9096 su statement. If on Linux, the /bin/sh shell is forced in case the user
9097 does not have a valid shell. If with-env is set to 1, the -s flag is added
9098 to the su command to read the user's .profile or .bashrc file.
9099
9100 =cut
9101 sub command_as_user
9102 {
9103 my ($user, $env, @args) = @_;
9104 my @uinfo = getpwnam($user);
9105 if ($uinfo[8] ne "/bin/sh" && $uinfo[8] !~ /\/bash$/) {
9106         # User shell doesn't appear to be valid
9107         if ($gconfig{'os_type'} =~ /-linux$/) {
9108                 # Use -s /bin/sh to force it
9109                 $shellarg = " -s /bin/sh";
9110                 }
9111         elsif ($gconfig{'os_type'} eq 'freebsd' ||
9112                $gconfig{'os_type'} eq 'solaris' &&
9113                 $gconfig{'os_version'} >= 11 ||
9114                $gconfig{'os_type'} eq 'macos') {
9115                 # Use -m and force /bin/sh
9116                 @args = ( "/bin/sh", "-c", quotemeta(join(" ", @args)) );
9117                 $shellarg = " -m";
9118                 }
9119         }
9120 my $rv = "su".($env ? " -" : "").$shellarg.
9121          " ".quotemeta($user)." -c ".quotemeta(join(" ", @args));
9122 return $rv;
9123 }
9124
9125 =head2 list_osdn_mirrors(project, file)
9126
9127 This function is now deprecated in favor of letting sourceforge just
9128 redirect to the best mirror, and now just returns their primary download URL.
9129
9130 =cut
9131 sub list_osdn_mirrors
9132 {
9133 my ($project, $file) = @_;
9134 return ( { 'url' => "http://downloads.sourceforge.net/$project/$file",
9135            'default' => 0,
9136            'mirror' => 'downloads' } );
9137 }
9138
9139 =head2 convert_osdn_url(url)
9140
9141 Given a URL like http://osdn.dl.sourceforge.net/sourceforge/project/file.zip
9142 or http://prdownloads.sourceforge.net/project/file.zip , convert it
9143 to a real URL on the sourceforge download redirector.
9144
9145 =cut
9146 sub convert_osdn_url
9147 {
9148 my ($url) = @_;
9149 if ($url =~ /^http:\/\/[^\.]+.dl.sourceforge.net\/sourceforge\/([^\/]+)\/(.*)$/ ||
9150     $url =~ /^http:\/\/prdownloads.sourceforge.net\/([^\/]+)\/(.*)$/) {
9151         # Always use the Sourceforge mail download URL, which does
9152         # a location-based redirect for us
9153         my ($project, $file) = ($1, $2);
9154         $url = "http://prdownloads.sourceforge.net/sourceforge/".
9155                "$project/$file";
9156         return wantarray ? ( $url, 0 ) : $url;
9157         }
9158 else {
9159         # Some other source .. don't change
9160         return wantarray ? ( $url, 2 ) : $url;
9161         }
9162 }
9163
9164 =head2 get_current_dir
9165
9166 Returns the directory the current process is running in.
9167
9168 =cut
9169 sub get_current_dir
9170 {
9171 my $out;
9172 if ($gconfig{'os_type'} eq 'windows') {
9173         # Use cd command
9174         $out = `cd`;
9175         }
9176 else {
9177         # Use pwd command
9178         $out = `pwd`;
9179         $out =~ s/\\/\//g;
9180         }
9181 $out =~ s/\r|\n//g;
9182 return $out;
9183 }
9184
9185 =head2 supports_users
9186
9187 Returns 1 if the current OS supports Unix user concepts and functions like
9188 su , getpw* and so on. This will be true on Linux and other Unixes, but false
9189 on Windows.
9190
9191 =cut
9192 sub supports_users
9193 {
9194 return $gconfig{'os_type'} ne 'windows';
9195 }
9196
9197 =head2 supports_symlinks
9198
9199 Returns 1 if the current OS supports symbolic and hard links. This will not
9200 be the case on Windows.
9201
9202 =cut
9203 sub supports_symlinks
9204 {
9205 return $gconfig{'os_type'} ne 'windows';
9206 }
9207
9208 =head2 quote_path(path)
9209
9210 Returns a path with safe quoting for the current operating system.
9211
9212 =cut
9213 sub quote_path
9214 {
9215 my ($path) = @_;
9216 if ($gconfig{'os_type'} eq 'windows' || $path =~ /^[a-z]:/i) {
9217         # Windows only supports "" style quoting
9218         return "\"$path\"";
9219         }
9220 else {
9221         return quotemeta($path);
9222         }
9223 }
9224
9225 =head2 get_windows_root
9226
9227 Returns the base windows system directory, like c:/windows.
9228
9229 =cut
9230 sub get_windows_root
9231 {
9232 if ($ENV{'SystemRoot'}) {
9233         my $rv = $ENV{'SystemRoot'};
9234         $rv =~ s/\\/\//g;
9235         return $rv;
9236         }
9237 else {
9238         return -d "c:/windows" ? "c:/windows" : "c:/winnt";
9239         }
9240 }
9241
9242 =head2 read_file_contents(file)
9243
9244 Given a filename, returns its complete contents as a string. Effectively
9245 the same as the Perl construct `cat file`.
9246
9247 =cut
9248 sub read_file_contents
9249 {
9250 &open_readfile(FILE, $_[0]) || return undef;
9251 local $/ = undef;
9252 my $rv = <FILE>;
9253 close(FILE);
9254 return $rv;
9255 }
9256
9257 =head2 unix_crypt(password, salt)
9258
9259 Performs Unix encryption on a password, using the built-in crypt function or
9260 the Crypt::UnixCrypt module if the former does not work. The salt parameter
9261 must be either an already-hashed password, or a two-character alpha-numeric
9262 string.
9263
9264 =cut
9265 sub unix_crypt
9266 {
9267 my ($pass, $salt) = @_;
9268 return "" if ($salt !~ /^[a-zA-Z0-9\.\/]{2}/);   # same as real crypt
9269 my $rv = eval "crypt(\$pass, \$salt)";
9270 my $err = $@;
9271 return $rv if ($rv && !$@);
9272 eval "use Crypt::UnixCrypt";
9273 if (!$@) {
9274         return Crypt::UnixCrypt::crypt($pass, $salt);
9275         }
9276 else {
9277         &error("Failed to encrypt password : $err");
9278         }
9279 }
9280
9281 =head2 split_quoted_string(string)
9282
9283 Given a string like I<foo "bar baz" quux>, returns the array :
9284 foo, bar baz, quux
9285
9286 =cut
9287 sub split_quoted_string
9288 {
9289 my ($str) = @_;
9290 my @rv;
9291 while($str =~ /^"([^"]*)"\s*([\000-\377]*)$/ ||
9292       $str =~ /^'([^']*)'\s*([\000-\377]*)$/ ||
9293       $str =~ /^(\S+)\s*([\000-\377]*)$/) {
9294         push(@rv, $1);
9295         $str = $2;
9296         }
9297 return @rv;
9298 }
9299
9300 =head2 write_to_http_cache(url, file|&data)
9301
9302 Updates the Webmin cache with the contents of the given file, possibly also
9303 clearing out old data. Mainly for internal use by http_download.
9304
9305 =cut
9306 sub write_to_http_cache
9307 {
9308 my ($url, $file) = @_;
9309 return 0 if (!$gconfig{'cache_size'});
9310
9311 # Don't cache downloads that look dynamic
9312 if ($url =~ /cgi-bin/ || $url =~ /\?/) {
9313         return 0;
9314         }
9315
9316 # Check if the current module should do caching
9317 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
9318         # Caching all except some modules
9319         my @mods = split(/\s+/, $1);
9320         return 0 if (&indexof(&get_module_name(), @mods) != -1);
9321         }
9322 elsif ($gconfig{'cache_mods'}) {
9323         # Only caching some modules
9324         my @mods = split(/\s+/, $gconfig{'cache_mods'});
9325         return 0 if (&indexof(&get_module_name(), @mods) == -1);
9326         }
9327
9328 # Work out the size
9329 my $size;
9330 if (ref($file)) {
9331         $size = length($$file);
9332         }
9333 else {
9334         my @st = stat($file);
9335         $size = $st[7];
9336         }
9337
9338 if ($size > $gconfig{'cache_size'}) {
9339         # Bigger than the whole cache - so don't save it
9340         return 0;
9341         }
9342 my $cfile = $url;
9343 $cfile =~ s/\//_/g;
9344 $cfile = "$main::http_cache_directory/$cfile";
9345
9346 # See how much we have cached currently, clearing old files
9347 my $total = 0;
9348 mkdir($main::http_cache_directory, 0700) if (!-d $main::http_cache_directory);
9349 opendir(CACHEDIR, $main::http_cache_directory);
9350 foreach my $f (readdir(CACHEDIR)) {
9351         next if ($f eq "." || $f eq "..");
9352         my $path = "$main::http_cache_directory/$f";
9353         my @st = stat($path);
9354         if ($gconfig{'cache_days'} &&
9355             time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
9356                 # This file is too old .. trash it
9357                 unlink($path);
9358                 }
9359         else {
9360                 $total += $st[7];
9361                 push(@cached, [ $path, $st[7], $st[9] ]);
9362                 }
9363         }
9364 closedir(CACHEDIR);
9365 @cached = sort { $a->[2] <=> $b->[2] } @cached;
9366 while($total+$size > $gconfig{'cache_size'} && @cached) {
9367         # Cache is too big .. delete some files until the new one will fit
9368         unlink($cached[0]->[0]);
9369         $total -= $cached[0]->[1];
9370         shift(@cached);
9371         }
9372
9373 # Finally, write out the new file
9374 if (ref($file)) {
9375         &open_tempfile(CACHEFILE, ">$cfile");
9376         &print_tempfile(CACHEFILE, $$file);
9377         &close_tempfile(CACHEFILE);
9378         }
9379 else {
9380         my ($ok, $err) = &copy_source_dest($file, $cfile);
9381         }
9382
9383 return 1;
9384 }
9385
9386 =head2 check_in_http_cache(url)
9387
9388 If some URL is in the cache and valid, return the filename for it. Mainly
9389 for internal use by http_download.
9390
9391 =cut
9392 sub check_in_http_cache
9393 {
9394 my ($url) = @_;
9395 return undef if (!$gconfig{'cache_size'});
9396
9397 # Check if the current module should do caching
9398 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
9399         # Caching all except some modules
9400         my @mods = split(/\s+/, $1);
9401         return 0 if (&indexof(&get_module_name(), @mods) != -1);
9402         }
9403 elsif ($gconfig{'cache_mods'}) {
9404         # Only caching some modules
9405         my @mods = split(/\s+/, $gconfig{'cache_mods'});
9406         return 0 if (&indexof(&get_module_name(), @mods) == -1);
9407         }
9408
9409 my $cfile = $url;
9410 $cfile =~ s/\//_/g;
9411 $cfile = "$main::http_cache_directory/$cfile";
9412 my @st = stat($cfile);
9413 return undef if (!@st || !$st[7]);
9414 if ($gconfig{'cache_days'} && time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
9415         # Too old!
9416         unlink($cfile);
9417         return undef;
9418         }
9419 open(TOUCH, ">>$cfile");        # Update the file time, to keep it in the cache
9420 close(TOUCH);
9421 return $cfile;
9422 }
9423
9424 =head2 supports_javascript
9425
9426 Returns 1 if the current browser is assumed to support javascript.
9427
9428 =cut
9429 sub supports_javascript
9430 {
9431 if (defined(&theme_supports_javascript)) {
9432         return &theme_supports_javascript();
9433         }
9434 return $ENV{'MOBILE_DEVICE'} ? 0 : 1;
9435 }
9436
9437 =head2 get_module_name
9438
9439 Returns the name of the Webmin module that called this function. For internal
9440 use only by other API functions.
9441
9442 =cut
9443 sub get_module_name
9444 {
9445 return &get_module_variable('$module_name');
9446 }
9447
9448 =head2 get_module_variable(name, [ref])
9449
9450 Returns the value of some variable which is set in the caller's context, if
9451 using the new WebminCore package. For internal use only.
9452
9453 =cut
9454 sub get_module_variable
9455 {
9456 my ($v, $wantref) = @_;
9457 my $slash = $wantref ? "\\" : "";
9458 my $thispkg = &web_libs_package();
9459 if ($thispkg eq 'WebminCore') {
9460         my ($vt, $vn) = split('', $v, 2);
9461         my $callpkg;
9462         for(my $i=0; ($callpkg) = caller($i); $i++) {
9463                 last if ($callpkg ne $thispkg);
9464                 }
9465         return eval "${slash}${vt}${callpkg}::${vn}";
9466         }
9467 return eval "${slash}${v}";
9468 }
9469
9470 =head2 clear_time_locale()
9471
9472 Temporarily force the locale to C, until reset_time_locale is called. This is
9473 useful if your code is going to call C<strftime> from the POSIX package, and
9474 you want to ensure that the output is in a consistent format.
9475
9476 =cut
9477 sub clear_time_locale
9478 {
9479 if ($main::clear_time_locale_count == 0) {
9480         eval {
9481                 use POSIX;
9482                 $main::clear_time_locale_old = POSIX::setlocale(POSIX::LC_TIME);
9483                 POSIX::setlocale(POSIX::LC_TIME, "C");
9484                 };
9485         }
9486 $main::clear_time_locale_count++;
9487 }
9488
9489 =head2 reset_time_locale()
9490
9491 Revert the locale to whatever it was before clear_time_locale was called
9492
9493 =cut
9494 sub reset_time_locale
9495 {
9496 if ($main::clear_time_locale_count == 1) {
9497         eval {
9498                 POSIX::setlocale(POSIX::LC_TIME, $main::clear_time_locale_old);
9499                 $main::clear_time_locale_old = undef;
9500                 };
9501         }
9502 $main::clear_time_locale_count--;
9503 }
9504
9505 =head2 callers_package(filehandle)
9506
9507 Convert a non-module filehandle like FOO to one qualified with the
9508 caller's caller's package, like fsdump::FOO. For internal use only.
9509
9510 =cut
9511 sub callers_package
9512 {
9513 my ($fh) = @_;
9514 my $callpkg = (caller(1))[0];
9515 my $thispkg = &web_libs_package();
9516 if (!ref($fh) && $fh !~ /::/ &&
9517     $callpkg ne $thispkg && $thispkg eq 'WebminCore') {
9518         $fh = $callpkg."::".$fh;
9519         }
9520 return $fh;
9521 }
9522
9523 =head2 web_libs_package()
9524
9525 Returns the package this code is in. We can't always trust __PACKAGE__. For
9526 internal use only.
9527
9528 =cut
9529 sub web_libs_package
9530 {
9531 if ($called_from_webmin_core) {
9532         return "WebminCore";
9533         }
9534 return __PACKAGE__;
9535 }
9536
9537 =head2 get_userdb_string
9538
9539 Returns the URL-style string for connecting to the users and groups database
9540
9541 =cut
9542 sub get_userdb_string
9543 {
9544 return undef if ($main::no_miniserv_userdb);
9545 my %miniserv;
9546 &get_miniserv_config(\%miniserv);
9547 return $miniserv{'userdb'};
9548 }
9549
9550 =head2 connect_userdb(string)
9551
9552 Returns a handle for talking to a user database - may be a DBI or LDAP handle.
9553 On failure returns an error message string. In an array context, returns the
9554 protocol type too.
9555
9556 =cut
9557 sub connect_userdb
9558 {
9559 my ($str) = @_;
9560 my ($proto, $user, $pass, $host, $prefix, $args) = &split_userdb_string($str);
9561 if ($proto eq "mysql") {
9562         # Connect to MySQL with DBI
9563         my $drh = eval "use DBI; DBI->install_driver('mysql');";
9564         $drh || return $text{'sql_emysqldriver'};
9565         my ($host, $port) = split(/:/, $host);
9566         my $cstr = "database=$prefix;host=$host";
9567         $cstr .= ";port=$port" if ($port);
9568         my $dbh = $drh->connect($cstr, $user, $pass, { });
9569         $dbh || return &text('sql_emysqlconnect', $drh->errstr);
9570         return wantarray ? ($dbh, $proto, $prefix, $args) : $dbh;
9571         }
9572 elsif ($proto eq "postgresql") {
9573         # Connect to PostgreSQL with DBI
9574         my $drh = eval "use DBI; DBI->install_driver('Pg');";
9575         $drh || return $text{'sql_epostgresqldriver'};
9576         my ($host, $port) = split(/:/, $host);
9577         my $cstr = "dbname=$prefix;host=$host";
9578         $cstr .= ";port=$port" if ($port);
9579         my $dbh = $drh->connect($cstr, $user, $pass);
9580         $dbh || return &text('sql_epostgresqlconnect', $drh->errstr);
9581         return wantarray ? ($dbh, $proto, $prefix, $args) : $dbh;
9582         }
9583 elsif ($proto eq "ldap") {
9584         # Connect with perl LDAP module
9585         eval "use Net::LDAP";
9586         $@ && return $text{'sql_eldapdriver'};
9587         my ($host, $port) = split(/:/, $host);
9588         my $scheme = $args->{'scheme'} || 'ldap';
9589         if (!$port) {
9590                 $port = $scheme eq 'ldaps' ? 636 : 389;
9591                 }
9592         my $ldap = Net::LDAP->new($host,
9593                                   port => $port,
9594                                   'scheme' => $scheme);
9595         $ldap || return &text('sql_eldapconnect', $host);
9596         my $mesg;
9597         if ($args->{'tls'}) {
9598                 # Switch to TLS mode
9599                 eval { $mesg = $ldap->start_tls(); };
9600                 if ($@ || !$mesg || $mesg->code) {
9601                         return &text('sql_eldaptls',
9602                             $@ ? $@ : $mesg ? $mesg->error : "Unknown error");
9603                         }
9604                 }
9605         # Login to the server
9606         if ($pass) {
9607                 $mesg = $ldap->bind(dn => $user, password => $pass);
9608                 }
9609         else {
9610                 $mesg = $ldap->bind(dn => $user, anonymous => 1);
9611                 }
9612         if (!$mesg || $mesg->code) {
9613                 return &text('sql_eldaplogin', $user,
9614                              $mesg ? $mesg->error : "Unknown error");
9615                 }
9616         return wantarray ? ($ldap, $proto, $prefix, $args) : $ldap;
9617         }
9618 else {
9619         return "Unknown protocol $proto";
9620         }
9621 }
9622
9623 =head2 disconnect_userdb(string, &handle)
9624
9625 Closes a handle opened by connect_userdb
9626
9627 =cut
9628 sub disconnect_userdb
9629 {
9630 my ($str, $h) = @_;
9631 if ($str =~ /^(mysql|postgresql):/) {
9632         # DBI disconnnect
9633         if (!$h->{'AutoCommit'}) {
9634                 $h->commit();
9635                 }
9636         $h->disconnect();
9637         }
9638 elsif ($str =~ /^ldap:/) {
9639         # LDAP disconnect
9640         $h->unbind();
9641         $h->disconnect();
9642         }
9643 }
9644
9645 =head2 split_userdb_string(string)
9646
9647 Converts a string like mysql://user:pass@host/db into separate parts
9648
9649 =cut
9650 sub split_userdb_string
9651 {
9652 my ($str) = @_;
9653 if ($str =~ /^([a-z]+):\/\/([^:]*):([^\@]*)\@([a-z0-9\.\-\_]+)\/([^\?]+)(\?(.*))?$/) {
9654         my ($proto, $user, $pass, $host, $prefix, $argstr) =
9655                 ($1, $2, $3, $4, $5, $7);
9656         my %args = map { split(/=/, $_, 2) } split(/\&/, $argstr);
9657         return ($proto, $user, $pass, $host, $prefix, \%args);
9658         }
9659 return ( );
9660 }
9661
9662 $done_web_lib_funcs = 1;
9663
9664 1;