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