web-lib-funcs.pl

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