web-lib-funcs.pl

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