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, content, 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 content - 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, $content, $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 $gconfig{'webprefix'} = '' if (!exists($gconfig{'webprefix'}));
4127 $null_file = $gconfig{'os_type'} eq 'windows' ? "NUL" : "/dev/null";
4128 $path_separator = $gconfig{'os_type'} eq 'windows' ? ';' : ':';
4129
4130 # Work out of this is a web, command line or cron job
4131 if (!$main::webmin_script_type) {
4132         if ($ENV{'SCRIPT_NAME'}) {
4133                 # Run via a CGI
4134                 $main::webmin_script_type = 'web';
4135                 }
4136         else {
4137                 # Cron jobs have no TTY
4138                 if ($gconfig{'os_type'} eq 'windows' ||
4139                     open(DEVTTY, ">/dev/tty")) {
4140                         $main::webmin_script_type = 'cmd';
4141                         close(DEVTTY);
4142                         }
4143                 else {
4144                         $main::webmin_script_type = 'cron';
4145                         }
4146                 }
4147         }
4148
4149 # If debugging is enabled, open the debug log
4150 if ($gconfig{'debug_enabled'} && !$main::opened_debug_log++) {
4151         my $dlog = $gconfig{'debug_file'} || $main::default_debug_log_file;
4152         if ($gconfig{'debug_size'}) {
4153                 my @st = stat($dlog);
4154                 if ($st[7] > $gconfig{'debug_size'}) {
4155                         rename($dlog, $dlog.".0");
4156                         }
4157                 }
4158         open(main::DEBUGLOG, ">>$dlog");
4159         $main::opened_debug_log = 1;
4160
4161         if ($gconfig{'debug_what_start'}) {
4162                 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
4163                 $main::debug_log_start_time = time();
4164                 &webmin_debug_log("START", "script=$script_name");
4165                 $main::debug_log_start_module = $module_name;
4166                 }
4167         }
4168
4169 # Set PATH and LD_LIBRARY_PATH
4170 if ($gconfig{'path'}) {
4171         if ($gconfig{'syspath'}) {
4172                 # Webmin only
4173                 $ENV{'PATH'} = $gconfig{'path'};
4174                 }
4175         else {
4176                 # Include OS too
4177                 $ENV{'PATH'} = $gconfig{'path'}.$path_separator.$ENV{'PATH'};
4178                 }
4179         }
4180 $ENV{$gconfig{'ld_env'}} = $gconfig{'ld_path'} if ($gconfig{'ld_env'});
4181
4182 # Set http_proxy and ftp_proxy environment variables, based on Webmin settings
4183 if ($gconfig{'http_proxy'}) {
4184         $ENV{'http_proxy'} = $gconfig{'http_proxy'};
4185         }
4186 if ($gconfig{'ftp_proxy'}) {
4187         $ENV{'ftp_proxy'} = $gconfig{'ftp_proxy'};
4188         }
4189 if ($gconfig{'noproxy'}) {
4190         $ENV{'no_proxy'} = $gconfig{'noproxy'};
4191         }
4192
4193 # Find all root directories
4194 my %miniserv;
4195 if (&get_miniserv_config(\%miniserv)) {
4196         @root_directories = ( $miniserv{'root'} );
4197         for($i=0; defined($miniserv{"extraroot_$i"}); $i++) {
4198                 push(@root_directories, $miniserv{"extraroot_$i"});
4199                 }
4200         }
4201
4202 # Work out which module we are in, and read the per-module config file
4203 $0 =~ s/\\/\//g;        # Force consistent path on Windows
4204 if (defined($ENV{'FOREIGN_MODULE_NAME'})) {
4205         # In a foreign call - use the module name given
4206         $root_directory = $ENV{'FOREIGN_ROOT_DIRECTORY'};
4207         $module_name = $ENV{'FOREIGN_MODULE_NAME'};
4208         @root_directories = ( $root_directory ) if (!@root_directories);
4209         }
4210 elsif ($ENV{'SCRIPT_NAME'}) {
4211         my $sn = $ENV{'SCRIPT_NAME'};
4212         $sn =~ s/^$gconfig{'webprefix'}//
4213                 if (!$gconfig{'webprefixnoredir'});
4214         if ($sn =~ /^\/([^\/]+)\//) {
4215                 # Get module name from CGI path
4216                 $module_name = $1;
4217                 }
4218         if ($ENV{'SERVER_ROOT'}) {
4219                 $root_directory = $ENV{'SERVER_ROOT'};
4220                 }
4221         elsif ($ENV{'SCRIPT_FILENAME'}) {
4222                 $root_directory = $ENV{'SCRIPT_FILENAME'};
4223                 $root_directory =~ s/$sn$//;
4224                 }
4225         @root_directories = ( $root_directory ) if (!@root_directories);
4226         }
4227 else {
4228         # Get root directory from miniserv.conf, and deduce module name from $0
4229         $root_directory = $root_directories[0];
4230         my $rok = 0;
4231         foreach my $r (@root_directories) {
4232                 if ($0 =~ /^$r\/([^\/]+)\/[^\/]+$/i) {
4233                         # Under a module directory
4234                         $module_name = $1;
4235                         $rok = 1;
4236                         last;
4237                         }
4238                 elsif ($0 =~ /^$root_directory\/[^\/]+$/i) {
4239                         # At the top level
4240                         $rok = 1;
4241                         last;
4242                         }
4243                 }
4244         &error("Script was not run with full path (failed to find $0 under $root_directory)") if (!$rok);
4245         }
4246
4247 # Set the umask based on config
4248 if ($gconfig{'umask'} && !$main::umask_already++) {
4249         umask(oct($gconfig{'umask'}));
4250         }
4251
4252 # If this is a cron job or other background task, set the nice level
4253 if (!$main::nice_already && $main::webmin_script_type eq 'cron') {
4254         # Set nice level
4255         if ($gconfig{'nice'}) {
4256                 eval 'POSIX::nice($gconfig{\'nice\'});';
4257                 }
4258
4259         # Set IO scheduling class and priority
4260         if ($gconfig{'sclass'} ne '' || $gconfig{'sprio'} ne '') {
4261                 my $cmd = "ionice";
4262                 $cmd .= " -c ".quotemeta($gconfig{'sclass'})
4263                         if ($gconfig{'sclass'} ne '');
4264                 $cmd .= " -n ".quotemeta($gconfig{'sprio'})
4265                         if ($gconfig{'sprio'} ne '');
4266                 $cmd .= " -p $$";
4267                 &execute_command("$cmd >/dev/null 2>&1");
4268                 }
4269         }
4270 $main::nice_already++;
4271
4272 # Get the username
4273 my $u = $ENV{'BASE_REMOTE_USER'} || $ENV{'REMOTE_USER'};
4274 $base_remote_user = $u;
4275 $remote_user = $ENV{'REMOTE_USER'};
4276
4277 # Work out if user is definitely in the DB, and if so get his attrs
4278 $remote_user_proto = $ENV{"REMOTE_USER_PROTO"};
4279 %remote_user_attrs = ( );
4280 if ($remote_user_proto) {
4281         my $userdb = &get_userdb_string();
4282         my ($dbh, $proto, $prefix, $args) =
4283                 $userdb ? &connect_userdb($userdb) : ( );
4284         if (ref($dbh)) {
4285                 if ($proto eq "mysql" || $proto eq "postgresql") {
4286                         # Read attrs from SQL
4287                         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 = ?");
4288                         if ($cmd && $cmd->execute($base_remote_user)) {
4289                                 while(my ($attr, $value) = $cmd->fetchrow()) {
4290                                         $remote_user_attrs{$attr} = $value;
4291                                         }
4292                                 $cmd->finish();
4293                                 }
4294                         }
4295                 elsif ($proto eq "ldap") {
4296                         # Read attrs from LDAP
4297                         my $rv = $dbh->search(
4298                                 base => $prefix,
4299                                 filter => '(&(cn='.$base_remote_user.')'.
4300                                           '(objectClass='.
4301                                           $args->{'userclass'}.'))',
4302                                 scope => 'sub');
4303                         my ($u) = $rv && !$rv->code ? $rv->all_entries : ( );
4304                         if ($u) {
4305                                 foreach $la ($u->get_value('webminAttr')) {
4306                                         my ($attr, $value) = split(/=/, $la, 2);
4307                                         $remote_user_attrs{$attr} = $value;
4308                                         }
4309                                 }
4310                         }
4311                 &disconnect_userdb($userdb, $dbh);
4312                 }
4313         }
4314
4315 if ($module_name) {
4316         # Find and load the configuration file for this module
4317         my (@ruinfo, $rgroup);
4318         $module_config_directory = "$config_directory/$module_name";
4319         if (&get_product_name() eq "usermin" &&
4320             -r "$module_config_directory/config.$remote_user") {
4321                 # Based on username
4322                 $module_config_file = "$module_config_directory/config.$remote_user";
4323                 }
4324         elsif (&get_product_name() eq "usermin" &&
4325             (@ruinfo = getpwnam($remote_user)) &&
4326             ($rgroup = getgrgid($ruinfo[3])) &&
4327             -r "$module_config_directory/config.\@$rgroup") {
4328                 # Based on group name
4329                 $module_config_file = "$module_config_directory/config.\@$rgroup";
4330                 }
4331         else {
4332                 # Global config
4333                 $module_config_file = "$module_config_directory/config";
4334                 }
4335         %config = ( );
4336         &read_file_cached($module_config_file, \%config);
4337
4338         # Fix up windows-specific substitutions in values
4339         foreach my $k (keys %config) {
4340                 if ($config{$k} =~ /\$\{systemroot\}/) {
4341                         my $root = &get_windows_root();
4342                         $config{$k} =~ s/\$\{systemroot\}/$root/g;
4343                         }
4344                 }
4345         }
4346
4347 # Record the initial module
4348 $main::initial_module_name ||= $module_name;
4349
4350 # Set some useful variables
4351 my $current_themes;
4352 $current_themes = $ENV{'MOBILE_DEVICE'} && defined($gconfig{'mobile_theme'}) ?
4353                     $gconfig{'mobile_theme'} :
4354                   defined($remote_user_attrs{'theme'}) ?
4355                     $remote_user_attrs{'theme'} :
4356                   defined($gconfig{'theme_'.$remote_user}) ?
4357                     $gconfig{'theme_'.$remote_user} :
4358                   defined($gconfig{'theme_'.$base_remote_user}) ?
4359                     $gconfig{'theme_'.$base_remote_user} :
4360                     $gconfig{'theme'};
4361 @current_themes = split(/\s+/, $current_themes);
4362 $current_theme = $current_themes[0];
4363 @theme_root_directories = map { "$root_directory/$_" } @current_themes;
4364 $theme_root_directory = $theme_root_directories[0];
4365 @theme_configs = ( );
4366 foreach my $troot (@theme_root_directories) {
4367         my %onetconfig;
4368         &read_file_cached("$troot/config", \%onetconfig);
4369         &read_file_cached("$troot/config", \%tconfig);
4370         push(@theme_configs, \%onetconfig);
4371         }
4372 $tb = defined($tconfig{'cs_header'}) ? "bgcolor=#$tconfig{'cs_header'}" :
4373       defined($gconfig{'cs_header'}) ? "bgcolor=#$gconfig{'cs_header'}" :
4374                                        "bgcolor=#9999ff";
4375 $cb = defined($tconfig{'cs_table'}) ? "bgcolor=#$tconfig{'cs_table'}" :
4376       defined($gconfig{'cs_table'}) ? "bgcolor=#$gconfig{'cs_table'}" :
4377                                       "bgcolor=#cccccc";
4378 $tb .= ' '.$tconfig{'tb'} if ($tconfig{'tb'});
4379 $cb .= ' '.$tconfig{'cb'} if ($tconfig{'cb'});
4380 if ($tconfig{'preload_functions'}) {
4381         # Force load of theme functions right now, if requested
4382         &load_theme_library();
4383         }
4384 if ($tconfig{'oofunctions'} && !$main::loaded_theme_oo_library++) {
4385         # Load the theme's Webmin:: package classes
4386         do "$theme_root_directory/$tconfig{'oofunctions'}";
4387         }
4388
4389 $0 =~ /([^\/]+)$/;
4390 $scriptname = $1;
4391 $webmin_logfile = $gconfig{'webmin_log'} ? $gconfig{'webmin_log'}
4392                                          : "$var_directory/webmin.log";
4393
4394 # Load language strings into %text
4395 my @langs = &list_languages();
4396 my $accepted_lang;
4397 if ($gconfig{'acceptlang'}) {
4398         foreach my $a (split(/,/, $ENV{'HTTP_ACCEPT_LANGUAGE'})) {
4399                 my ($al) = grep { $_->{'lang'} eq $a } @langs;
4400                 if ($al) {
4401                         $accepted_lang = $al->{'lang'};
4402                         last;
4403                         }
4404                 }
4405         }
4406 $current_lang = $force_lang ? $force_lang :
4407     $accepted_lang ? $accepted_lang :
4408     $remote_user_attrs{'lang'} ? $remote_user_attrs{'lang'} :
4409     $gconfig{"lang_$remote_user"} ? $gconfig{"lang_$remote_user"} :
4410     $gconfig{"lang_$base_remote_user"} ? $gconfig{"lang_$base_remote_user"} :
4411     $gconfig{"lang"} ? $gconfig{"lang"} : $default_lang;
4412 foreach my $l (@langs) {
4413         $current_lang_info = $l if ($l->{'lang'} eq $current_lang);
4414         }
4415 @lang_order_list = &unique($default_lang,
4416                            split(/:/, $current_lang_info->{'fallback'}),
4417                            $current_lang);
4418 %text = &load_language($module_name);
4419 %text || &error("Failed to determine Webmin root from SERVER_ROOT, SCRIPT_FILENAME or the full command line");
4420
4421 # Get the %module_info for this module
4422 if ($module_name) {
4423         my ($mi) = grep { $_->{'dir'} eq $module_name }
4424                          &get_all_module_infos(2);
4425         %module_info = %$mi;
4426         $module_root_directory = &module_root_directory($module_name);
4427         }
4428
4429 if ($module_name && !$main::no_acl_check &&
4430     !defined($ENV{'FOREIGN_MODULE_NAME'})) {
4431         # Check if the HTTP user can access this module
4432         if (!&foreign_available($module_name)) {
4433                 if (!&foreign_check($module_name)) {
4434                         &error(&text('emodulecheck',
4435                                      "<i>$module_info{'desc'}</i>"));
4436                         }
4437                 else {
4438                         &error(&text('emodule', "<i>$u</i>",
4439                                      "<i>$module_info{'desc'}</i>"));
4440                         }
4441                 }
4442         $main::no_acl_check++;
4443         }
4444
4445 # Check the Referer: header for nasty redirects
4446 my @referers = split(/\s+/, $gconfig{'referers'});
4447 my $referer_site;
4448 my $r = $ENV{'HTTP_REFERER'};
4449 if ($r =~ /^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?\[([^\]]+)\]/ ||
4450     $r =~ /^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?([^\/:@]+)/) {
4451         $referer_site = $3;
4452         }
4453 my $http_host = $ENV{'HTTP_HOST'};
4454 $http_host =~ s/:\d+$//;
4455 $http_host =~ s/^\[(\S+)\]$/$1/;
4456 my $unsafe_index = $unsafe_index_cgi ||
4457                    &get_module_variable('$unsafe_index_cgi');
4458 if ($0 &&
4459     ($ENV{'SCRIPT_NAME'} !~ /^\/(index.cgi)?$/ || $unsafe_index) &&
4460     ($ENV{'SCRIPT_NAME'} !~ /^\/([a-z0-9\_\-]+)\/(index.cgi)?$/i ||
4461      $unsafe_index) &&
4462     $0 !~ /(session_login|pam_login)\.cgi$/ && !$gconfig{'referer'} &&
4463     $ENV{'MINISERV_CONFIG'} && !$main::no_referers_check &&
4464     $ENV{'HTTP_USER_AGENT'} !~ /^Webmin/i &&
4465     ($referer_site && $referer_site ne $http_host &&
4466      &indexof($referer_site, @referers) < 0 ||
4467     !$referer_site && $gconfig{'referers_none'}) &&
4468     !$trust_unknown_referers &&
4469     !&get_module_variable('$trust_unknown_referers')) {
4470         # Looks like a link from elsewhere .. show an error
4471         &header($text{'referer_title'}, "", undef, 0, 1, 1);
4472
4473         $prot = lc($ENV{'HTTPS'}) eq 'on' ? "https" : "http";
4474         my $url = "<tt>".&html_escape("$prot://$ENV{'HTTP_HOST'}$ENV{'REQUEST_URI'}")."</tt>";
4475         if ($referer_site) {
4476                 # From a known host
4477                 print &text('referer_warn',
4478                             "<tt>".&html_escape($r)."</tt>", $url);
4479                 print "<p>\n";
4480                 print &text('referer_fix1', &html_escape($http_host)),"<p>\n";
4481                 print &text('referer_fix2', &html_escape($http_host)),"<p>\n";
4482                 }
4483         else {
4484                 # No referer info given
4485                 print &text('referer_warn_unknown', $url),"<p>\n";
4486                 print &text('referer_fix1u'),"<p>\n";
4487                 print &text('referer_fix2u'),"<p>\n";
4488                 }
4489         print "<p>\n";
4490
4491         &footer("/", $text{'index'});
4492         exit;
4493         }
4494 $main::no_referers_check++;
4495 $main::completed_referers_check++;
4496
4497 # Call theme post-init
4498 if (defined(&theme_post_init_config)) {
4499         &theme_post_init_config(@_);
4500         }
4501
4502 # Record that we have done the calling library in this package
4503 my ($callpkg, $lib) = caller();
4504 $lib =~ s/^.*\///;
4505 $main::done_foreign_require{$callpkg,$lib} = 1;
4506
4507 # If a licence checking is enabled, do it now
4508 if ($gconfig{'licence_module'} && !$main::done_licence_module_check &&
4509     &foreign_check($gconfig{'licence_module'}) &&
4510     -r "$root_directory/$gconfig{'licence_module'}/licence_check.pl") {
4511         my $oldpwd = &get_current_dir();
4512         $main::done_licence_module_check++;
4513         $main::licence_module = $gconfig{'licence_module'};
4514         &foreign_require($main::licence_module, "licence_check.pl");
4515         ($main::licence_status, $main::licence_message) =
4516                 &foreign_call($main::licence_module, "check_licence");
4517         chdir($oldpwd);
4518         }
4519
4520 # Export global variables to caller
4521 if ($main::export_to_caller) {
4522         foreach my $v ('$config_file', '%gconfig', '$null_file',
4523                        '$path_separator', '@root_directories',
4524                        '$root_directory', '$module_name',
4525                        '$base_remote_user', '$remote_user',
4526                        '$remote_user_proto', '%remote_user_attrs',
4527                        '$module_config_directory', '$module_config_file',
4528                        '%config', '@current_themes', '$current_theme',
4529                        '@theme_root_directories', '$theme_root_directory',
4530                        '%tconfig','@theme_configs', '$tb', '$cb', '$scriptname',
4531                        '$webmin_logfile', '$current_lang',
4532                        '$current_lang_info', '@lang_order_list', '%text',
4533                        '%module_info', '$module_root_directory') {
4534                 my ($vt, $vn) = split('', $v, 2);
4535                 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
4536                 }
4537         }
4538
4539 return 1;
4540 }
4541
4542 =head2 load_language([module], [directory])
4543
4544 Returns a hashtable mapping text codes to strings in the appropriate language,
4545 based on the $current_lang global variable, which is in turn set based on
4546 the Webmin user's selection. The optional module parameter tells the function
4547 which module to load strings for, and defaults to the calling module. The
4548 optional directory parameter can be used to load strings from a directory
4549 other than lang.
4550
4551 In regular module development you will never need to call this function
4552 directly, as init_config calls it for you, and places the module's strings
4553 into the %text hash.
4554
4555 =cut
4556 sub load_language
4557 {
4558 my %text;
4559 my $root = $root_directory;
4560 my $ol = $gconfig{'overlang'};
4561 my ($dir) = ($_[1] || "lang");
4562
4563 # Read global lang files
4564 foreach my $o (@lang_order_list) {
4565         my $ok = &read_file_cached_with_stat("$root/$dir/$o", \%text);
4566         return () if (!$ok && $o eq $default_lang);
4567         }
4568 if ($ol) {
4569         foreach my $o (@lang_order_list) {
4570                 &read_file_cached("$root/$ol/$o", \%text);
4571                 }
4572         }
4573 &read_file_cached("$config_directory/custom-lang", \%text);
4574 foreach my $o (@lang_order_list) {
4575         next if ($o eq "en");
4576         &read_file_cached("$config_directory/custom-lang.$o", \%text);
4577         }
4578 my $norefs = $text{'__norefs'};
4579
4580 if ($_[0]) {
4581         # Read module's lang files
4582         delete($text{'__norefs'});
4583         my $mdir = &module_root_directory($_[0]);
4584         foreach my $o (@lang_order_list) {
4585                 &read_file_cached_with_stat("$mdir/$dir/$o", \%text);
4586                 }
4587         if ($ol) {
4588                 foreach my $o (@lang_order_list) {
4589                         &read_file_cached("$mdir/$ol/$o", \%text);
4590                         }
4591                 }
4592         &read_file_cached("$config_directory/$_[0]/custom-lang", \%text);
4593         foreach my $o (@lang_order_list) {
4594                 next if ($o eq "en");
4595                 &read_file_cached("$config_directory/$_[0]/custom-lang.$o",
4596                                   \%text);
4597                 }
4598         $norefs = $text{'__norefs'} if ($norefs);
4599         }
4600
4601 # Replace references to other strings
4602 if (!$norefs) {
4603         foreach $k (keys %text) {
4604                 $text{$k} =~ s/\$(\{([^\}]+)\}|([A-Za-z0-9\.\-\_]+))/text_subs($2 || $3,\%text)/ge;
4605                 }
4606         }
4607
4608 if (defined(&theme_load_language)) {
4609         &theme_load_language(\%text, $_[0]);
4610         }
4611 return %text;
4612 }
4613
4614 =head2 text_subs(string)
4615
4616 Used internally by load_language to expand $code substitutions in language
4617 files.
4618
4619 =cut
4620 sub text_subs
4621 {
4622 if (substr($_[0], 0, 8) eq "include:") {
4623         local $_;
4624         my $rv;
4625         open(INCLUDE, substr($_[0], 8));
4626         while(<INCLUDE>) {
4627                 $rv .= $_;
4628                 }
4629         close(INCLUDE);
4630         return $rv;
4631         }
4632 else {
4633         my $t = $_[1]->{$_[0]};
4634         return defined($t) ? $t : '$'.$_[0];
4635         }
4636 }
4637
4638 =head2 text(message, [substitute]+)
4639
4640 Returns a translated message from %text, but with $1, $2, etc.. replaced with
4641 the substitute parameters. This makes it easy to use strings with placeholders
4642 that get replaced with programmatically generated text. For example :
4643
4644  print &text('index_hello', $remote_user),"<p>\n";
4645
4646 =cut
4647 sub text
4648 {
4649 my $t = &get_module_variable('%text', 1);
4650 my $rv = exists($t->{$_[0]}) ? $t->{$_[0]} : $text{$_[0]};
4651 for(my $i=1; $i<@_; $i++) {
4652         $rv =~ s/\$$i/$_[$i]/g;
4653         }
4654 return $rv;
4655 }
4656
4657 =head2 encode_base64(string)
4658
4659 Encodes a string into base64 format, for use in MIME email or HTTP
4660 authorization headers.
4661
4662 =cut
4663 sub encode_base64
4664 {
4665 my $res;
4666 pos($_[0]) = 0;                          # ensure start at the beginning
4667 while ($_[0] =~ /(.{1,57})/gs) {
4668         $res .= substr(pack('u57', $1), 1)."\n";
4669         chop($res);
4670         }
4671 $res =~ tr|\` -_|AA-Za-z0-9+/|;
4672 my $padding = (3 - length($_[0]) % 3) % 3;
4673 $res =~ s/.{$padding}$/'=' x $padding/e if ($padding);
4674 return $res;
4675 }
4676
4677 =head2 decode_base64(string)
4678
4679 Converts a base64-encoded string into plain text. The opposite of encode_base64.
4680
4681 =cut
4682 sub decode_base64
4683 {
4684 my ($str) = @_;
4685 my $res;
4686 $str =~ tr|A-Za-z0-9+=/||cd;            # remove non-base64 chars
4687 if (length($str) % 4) {
4688         return undef;
4689 }
4690 $str =~ s/=+$//;                        # remove padding
4691 $str =~ tr|A-Za-z0-9+/| -_|;            # convert to uuencoded format
4692 while ($str =~ /(.{1,60})/gs) {
4693         my $len = chr(32 + length($1)*3/4); # compute length byte
4694         $res .= unpack("u", $len . $1 );    # uudecode
4695         }
4696 return $res;
4697 }
4698
4699 =head2 get_module_info(module, [noclone], [forcache])
4700
4701 Returns a hash containg details of the given module. Some useful keys are :
4702
4703 =item dir - The module directory, like sendmail.
4704
4705 =item desc - Human-readable description, in the current users' language.
4706
4707 =item version - Optional module version number.
4708
4709 =item os_support - List of supported operating systems and versions.
4710
4711 =item category - Category on Webmin's left menu, like net.
4712
4713 =cut
4714 sub get_module_info
4715 {
4716 return () if ($_[0] =~ /^\./);
4717 my (%rv, $clone, $o);
4718 my $mdir = &module_root_directory($_[0]);
4719 &read_file_cached("$mdir/module.info", \%rv) || return ();
4720 if (-l $mdir) {
4721         # A clone is a module that links to another directory under the root
4722         foreach my $r (@root_directories) {
4723                 if (&is_under_directory($r, $mdir)) {
4724                         $clone = 1;
4725                         last;
4726                         }
4727                 }
4728         }
4729 foreach $o (@lang_order_list) {
4730         $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4731         $rv{"longdesc"} = $rv{"longdesc_$o"} if ($rv{"longdesc_$o"});
4732         }
4733 if ($clone && !$_[1] && $config_directory) {
4734         $rv{'clone'} = $rv{'desc'};
4735         &read_file("$config_directory/$_[0]/clone", \%rv);
4736         }
4737 $rv{'dir'} = $_[0];
4738 my %module_categories;
4739 &read_file_cached("$config_directory/webmin.cats", \%module_categories);
4740 my $pn = &get_product_name();
4741 if (defined($rv{'category_'.$pn})) {
4742         # Can override category for webmin/usermin
4743         $rv{'category'} = $rv{'category_'.$pn};
4744         }
4745 $rv{'realcategory'} = $rv{'category'};
4746 $rv{'category'} = $module_categories{$_[0]}
4747         if (defined($module_categories{$_[0]}));
4748
4749 # Apply description overrides
4750 $rv{'realdesc'} = $rv{'desc'};
4751 my %descs;
4752 &read_file_cached("$config_directory/webmin.descs", \%descs);
4753 if ($descs{$_[0]}) {
4754         $rv{'desc'} = $descs{$_[0]};
4755         }
4756 foreach my $o (@lang_order_list) {
4757         my $ov = $descs{$_[0]." ".$o} || $descs{$_[0]."_".$o};
4758         $rv{'desc'} = $ov if ($ov);
4759         }
4760
4761 if (!$_[2]) {
4762         # Apply per-user description overridde
4763         my %gaccess = &get_module_acl(undef, "");
4764         if ($gaccess{'desc_'.$_[0]}) {
4765                 $rv{'desc'} = $gaccess{'desc_'.$_[0]};
4766                 }
4767         }
4768
4769 if ($rv{'longdesc'}) {
4770         # All standard modules have an index.cgi
4771         $rv{'index_link'} = 'index.cgi';
4772         }
4773
4774 # Call theme-specific override function
4775 if (defined(&theme_get_module_info)) {
4776         %rv = &theme_get_module_info(\%rv, $_[0], $_[1], $_[2]);
4777         }
4778
4779 return %rv;
4780 }
4781
4782 =head2 get_all_module_infos(cachemode)
4783
4784 Returns a list contains the information on all modules in this webmin
4785 install, including clones. Uses caching to reduce the number of module.info
4786 files that need to be read. Each element of the array is a hash reference
4787 in the same format as returned by get_module_info. The cache mode flag can be :
4788 0 = read and write, 1 = don't read or write, 2 = read only
4789
4790 =cut
4791 sub get_all_module_infos
4792 {
4793 my (%cache, @rv);
4794
4795 # Is the cache out of date? (ie. have any of the root's changed?)
4796 my $cache_file = "$config_directory/module.infos.cache";
4797 my $changed = 0;
4798 if (&read_file_cached($cache_file, \%cache)) {
4799         foreach my $r (@root_directories) {
4800                 my @st = stat($r);
4801                 if ($st[9] != $cache{'mtime_'.$r}) {
4802                         $changed = 2;
4803                         last;
4804                         }
4805                 }
4806         }
4807 else {
4808         $changed = 1;
4809         }
4810
4811 if ($_[0] != 1 && !$changed && $cache{'lang'} eq $current_lang) {
4812         # Can use existing module.info cache
4813         my %mods;
4814         foreach my $k (keys %cache) {
4815                 if ($k =~ /^(\S+) (\S+)$/) {
4816                         $mods{$1}->{$2} = $cache{$k};
4817                         }
4818                 }
4819         @rv = map { $mods{$_} } (keys %mods) if (%mods);
4820         }
4821 else {
4822         # Need to rebuild cache
4823         %cache = ( );
4824         foreach my $r (@root_directories) {
4825                 opendir(DIR, $r);
4826                 foreach my $m (readdir(DIR)) {
4827                         next if ($m =~ /^(config-|\.)/ || $m =~ /\.(cgi|pl)$/);
4828                         my %minfo = &get_module_info($m, 0, 1);
4829                         next if (!%minfo || !$minfo{'dir'});
4830                         push(@rv, \%minfo);
4831                         foreach $k (keys %minfo) {
4832                                 $cache{"${m} ${k}"} = $minfo{$k};
4833                                 }
4834                         }
4835                 closedir(DIR);
4836                 my @st = stat($r);
4837                 $cache{'mtime_'.$r} = $st[9];
4838                 }
4839         $cache{'lang'} = $current_lang;
4840         if (!$_[0] && $< == 0 && $> == 0) {
4841                 eval {
4842                         # Don't fail if cache write fails
4843                         local $main::error_must_die = 1;
4844                         &write_file($cache_file, \%cache);
4845                         }
4846                 }
4847         }
4848
4849 # Override descriptions for modules for current user
4850 my %gaccess = &get_module_acl(undef, "");
4851 foreach my $m (@rv) {
4852         if ($gaccess{"desc_".$m->{'dir'}}) {
4853                 $m->{'desc'} = $gaccess{"desc_".$m->{'dir'}};
4854                 }
4855         }
4856
4857 # Apply installed flags
4858 my %installed;
4859 &read_file_cached("$config_directory/installed.cache", \%installed);
4860 foreach my $m (@rv) {
4861         $m->{'installed'} = $installed{$m->{'dir'}};
4862         }
4863
4864 return @rv;
4865 }
4866
4867 =head2 get_theme_info(theme)
4868
4869 Returns a hash containing a theme's details, taken from it's theme.info file.
4870 Some useful keys are :
4871
4872 =item dir - The theme directory, like blue-theme.
4873
4874 =item desc - Human-readable description, in the current users' language.
4875
4876 =item version - Optional module version number.
4877
4878 =item os_support - List of supported operating systems and versions.
4879
4880 =cut
4881 sub get_theme_info
4882 {
4883 return () if ($_[0] =~ /^\./);
4884 my %rv;
4885 my $tdir = &module_root_directory($_[0]);
4886 &read_file("$tdir/theme.info", \%rv) || return ();
4887 foreach my $o (@lang_order_list) {
4888         $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4889         }
4890 $rv{"dir"} = $_[0];
4891 return %rv;
4892 }
4893
4894 =head2 list_languages
4895
4896 Returns an array of supported languages, taken from Webmin's os_list.txt file.
4897 Each is a hash reference with the following keys :
4898
4899 =item lang - The short language code, like es for Spanish.
4900
4901 =item desc - A human-readable description, in English.
4902
4903 =item charset - An optional character set to use when displaying the language.
4904
4905 =item titles - Set to 1 only if Webmin has title images for the language.
4906
4907 =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.
4908
4909 =cut
4910 sub list_languages
4911 {
4912 if (!@main::list_languages_cache) {
4913         my $o;
4914         local $_;
4915         open(LANG, "$root_directory/lang_list.txt");
4916         while(<LANG>) {
4917                 if (/^(\S+)\s+(.*)/) {
4918                         my $l = { 'desc' => $2 };
4919                         foreach $o (split(/,/, $1)) {
4920                                 if ($o =~ /^([^=]+)=(.*)$/) {
4921                                         $l->{$1} = $2;
4922                                         }
4923                                 }
4924                         $l->{'index'} = scalar(@rv);
4925                         push(@main::list_languages_cache, $l);
4926                         }
4927                 }
4928         close(LANG);
4929         @main::list_languages_cache = sort { $a->{'desc'} cmp $b->{'desc'} }
4930                                      @main::list_languages_cache;
4931         }
4932 return @main::list_languages_cache;
4933 }
4934
4935 =head2 read_env_file(file, &hash, [include-commented])
4936
4937 Similar to Webmin's read_file function, but handles files containing shell
4938 environment variables formatted like :
4939
4940   export FOO=bar
4941   SMEG="spod"
4942
4943 The file parameter is the full path to the file to read, and hash a Perl hash
4944 ref to read names and values into.
4945
4946 =cut
4947 sub read_env_file
4948 {
4949 local $_;
4950 &open_readfile(FILE, $_[0]) || return 0;
4951 while(<FILE>) {
4952         if ($_[2]) {
4953                 # Remove start of line comments
4954                 s/^\s*#+\s*//;
4955                 }
4956         s/#.*$//g;
4957         if (/^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*"(.*)"/i ||
4958             /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*'(.*)'/i ||
4959             /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*(.*)/i) {
4960                 $_[1]->{$2} = $3;
4961                 }
4962         }
4963 close(FILE);
4964 return 1;
4965 }
4966
4967 =head2 write_env_file(file, &hash, [export])
4968
4969 Writes out a hash to a file in name='value' format, suitable for use in a shell
4970 script. The parameters are :
4971
4972 =item file - Full path for a file to write to
4973
4974 =item hash - Hash reference of names and values to write.
4975
4976 =item export - If set to 1, preceed each variable setting with the word 'export'.
4977
4978 =cut
4979 sub write_env_file
4980 {
4981 my $exp = $_[2] ? "export " : "";
4982 &open_tempfile(FILE, ">$_[0]");
4983 foreach my $k (keys %{$_[1]}) {
4984         my $v = $_[1]->{$k};
4985         if ($v =~ /^\S+$/) {
4986                 &print_tempfile(FILE, "$exp$k=$v\n");
4987                 }
4988         else {
4989                 &print_tempfile(FILE, "$exp$k=\"$v\"\n");
4990                 }
4991         }
4992 &close_tempfile(FILE);
4993 }
4994
4995 =head2 lock_file(filename, [readonly], [forcefile])
4996
4997 Lock a file for exclusive access. If the file is already locked, spin
4998 until it is freed. Uses a .lock file, which is not 100% reliable, but seems
4999 to work OK. The parameters are :
5000
5001 =item filename - File or directory to lock.
5002
5003 =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.
5004
5005 =item forcefile - Force the file to be considered as a real file and not a symlink for Webmin actions logging purposes.
5006
5007 =cut
5008 sub lock_file
5009 {
5010 my $realfile = &translate_filename($_[0]);
5011 return 0 if (!$_[0] || defined($main::locked_file_list{$realfile}));
5012 my $no_lock = !&can_lock_file($realfile);
5013 my $lock_tries_count = 0;
5014 while(1) {
5015         my $pid;
5016         if (!$no_lock && open(LOCKING, "$realfile.lock")) {
5017                 $pid = <LOCKING>;
5018                 $pid = int($pid);
5019                 close(LOCKING);
5020                 }
5021         if ($no_lock || !$pid || !kill(0, $pid) || $pid == $$) {
5022                 # Got the lock!
5023                 if (!$no_lock) {
5024                         # Create the .lock file
5025                         open(LOCKING, ">$realfile.lock") || return 0;
5026                         my $lck = eval "flock(LOCKING, 2+4)";
5027                         if (!$lck && !$@) {
5028                                 # Lock of lock file failed! Wait till later
5029                                 goto tryagain;
5030                                 }
5031                         print LOCKING $$,"\n";
5032                         eval "flock(LOCKING, 8)";
5033                         close(LOCKING);
5034                         }
5035                 $main::locked_file_list{$realfile} = int($_[1]);
5036                 push(@main::temporary_files, "$realfile.lock");
5037                 if (($gconfig{'logfiles'} || $gconfig{'logfullfiles'}) &&
5038                     !&get_module_variable('$no_log_file_changes') &&
5039                     !$_[1]) {
5040                         # Grab a copy of this file for later diffing
5041                         my $lnk;
5042                         $main::locked_file_data{$realfile} = undef;
5043                         if (-d $realfile) {
5044                                 $main::locked_file_type{$realfile} = 1;
5045                                 $main::locked_file_data{$realfile} = '';
5046                                 }
5047                         elsif (!$_[2] && ($lnk = readlink($realfile))) {
5048                                 $main::locked_file_type{$realfile} = 2;
5049                                 $main::locked_file_data{$realfile} = $lnk;
5050                                 }
5051                         elsif (open(ORIGFILE, $realfile)) {
5052                                 $main::locked_file_type{$realfile} = 0;
5053                                 $main::locked_file_data{$realfile} = '';
5054                                 local $_;
5055                                 while(<ORIGFILE>) {
5056                                         $main::locked_file_data{$realfile} .=$_;
5057                                         }
5058                                 close(ORIGFILE);
5059                                 }
5060                         }
5061                 last;
5062                 }
5063 tryagain:
5064         sleep(1);
5065         if ($lock_tries_count++ > 5*60) {
5066                 # Give up after 5 minutes
5067                 &error(&text('elock_tries', "<tt>$realfile</tt>", 5));
5068                 }
5069         }
5070 return 1;
5071 }
5072
5073 =head2 unlock_file(filename)
5074
5075 Release a lock on a file taken out by lock_file. If Webmin actions logging of
5076 file changes is enabled, then at unlock file a diff will be taken between the
5077 old and new contents, and stored under /var/webmin/diffs when webmin_log is
5078 called. This can then be viewed in the Webmin Actions Log module.
5079
5080 =cut
5081 sub unlock_file
5082 {
5083 my $realfile = &translate_filename($_[0]);
5084 return if (!$_[0] || !defined($main::locked_file_list{$realfile}));
5085 unlink("$realfile.lock") if (&can_lock_file($realfile));
5086 delete($main::locked_file_list{$realfile});
5087 if (exists($main::locked_file_data{$realfile})) {
5088         # Diff the new file with the old
5089         stat($realfile);
5090         my $lnk = readlink($realfile);
5091         my $type = -d _ ? 1 : $lnk ? 2 : 0;
5092         my $oldtype = $main::locked_file_type{$realfile};
5093         my $new = !defined($main::locked_file_data{$realfile});
5094         if ($new && !-e _) {
5095                 # file doesn't exist, and never did! do nothing ..
5096                 }
5097         elsif ($new && $type == 1 || !$new && $oldtype == 1) {
5098                 # is (or was) a directory ..
5099                 if (-d _ && !defined($main::locked_file_data{$realfile})) {
5100                         push(@main::locked_file_diff,
5101                              { 'type' => 'mkdir', 'object' => $realfile });
5102                         }
5103                 elsif (!-d _ && defined($main::locked_file_data{$realfile})) {
5104                         push(@main::locked_file_diff,
5105                              { 'type' => 'rmdir', 'object' => $realfile });
5106                         }
5107                 }
5108         elsif ($new && $type == 2 || !$new && $oldtype == 2) {
5109                 # is (or was) a symlink ..
5110                 if ($lnk && !defined($main::locked_file_data{$realfile})) {
5111                         push(@main::locked_file_diff,
5112                              { 'type' => 'symlink', 'object' => $realfile,
5113                                'data' => $lnk });
5114                         }
5115                 elsif (!$lnk && defined($main::locked_file_data{$realfile})) {
5116                         push(@main::locked_file_diff,
5117                              { 'type' => 'unsymlink', 'object' => $realfile,
5118                                'data' => $main::locked_file_data{$realfile} });
5119                         }
5120                 elsif ($lnk ne $main::locked_file_data{$realfile}) {
5121                         push(@main::locked_file_diff,
5122                              { 'type' => 'resymlink', 'object' => $realfile,
5123                                'data' => $lnk });
5124                         }
5125                 }
5126         else {
5127                 # is a file, or has changed type?!
5128                 my ($diff, $delete_file);
5129                 my $type = "modify";
5130                 if (!-r _) {
5131                         open(NEWFILE, ">$realfile");
5132                         close(NEWFILE);
5133                         $delete_file++;
5134                         $type = "delete";
5135                         }
5136                 if (!defined($main::locked_file_data{$realfile})) {
5137                         $type = "create";
5138                         }
5139                 open(ORIGFILE, ">$realfile.webminorig");
5140                 print ORIGFILE $main::locked_file_data{$realfile};
5141                 close(ORIGFILE);
5142                 $diff = &backquote_command(
5143                         "diff ".quotemeta("$realfile.webminorig")." ".
5144                                 quotemeta($realfile)." 2>/dev/null");
5145                 push(@main::locked_file_diff,
5146                      { 'type' => $type, 'object' => $realfile,
5147                        'data' => $diff } ) if ($diff);
5148                 unlink("$realfile.webminorig");
5149                 unlink($realfile) if ($delete_file);
5150                 }
5151
5152         if ($gconfig{'logfullfiles'}) {
5153                 # Add file details to list of those to fully log
5154                 $main::orig_file_data{$realfile} ||=
5155                         $main::locked_file_data{$realfile};
5156                 $main::orig_file_type{$realfile} ||=
5157                         $main::locked_file_type{$realfile};
5158                 }
5159
5160         delete($main::locked_file_data{$realfile});
5161         delete($main::locked_file_type{$realfile});
5162         }
5163 }
5164
5165 =head2 test_lock(file)
5166
5167 Returns 1 if some file is currently locked, 0 if not.
5168
5169 =cut
5170 sub test_lock
5171 {
5172 my $realfile = &translate_filename($_[0]);
5173 return 0 if (!$_[0]);
5174 return 1 if (defined($main::locked_file_list{$realfile}));
5175 return 0 if (!&can_lock_file($realfile));
5176 my $pid;
5177 if (open(LOCKING, "$realfile.lock")) {
5178         $pid = <LOCKING>;
5179         $pid = int($pid);
5180         close(LOCKING);
5181         }
5182 return $pid && kill(0, $pid);
5183 }
5184
5185 =head2 unlock_all_files
5186
5187 Unlocks all files locked by the current script.
5188
5189 =cut
5190 sub unlock_all_files
5191 {
5192 foreach $f (keys %main::locked_file_list) {
5193         &unlock_file($f);
5194         }
5195 }
5196
5197 =head2 can_lock_file(file)
5198
5199 Returns 1 if some file should be locked, based on the settings in the
5200 Webmin Configuration module. For internal use by lock_file only.
5201
5202 =cut
5203 sub can_lock_file
5204 {
5205 if (&is_readonly_mode()) {
5206         return 0;       # never lock in read-only mode
5207         }
5208 elsif ($gconfig{'lockmode'} == 0) {
5209         return 1;       # always
5210         }
5211 elsif ($gconfig{'lockmode'} == 1) {
5212         return 0;       # never
5213         }
5214 else {
5215         # Check if under any of the directories
5216         my $match;
5217         foreach my $d (split(/\t+/, $gconfig{'lockdirs'})) {
5218                 if (&same_file($d, $_[0]) ||
5219                     &is_under_directory($d, $_[0])) {
5220                         $match = 1;
5221                         }
5222                 }
5223         return $gconfig{'lockmode'} == 2 ? $match : !$match;
5224         }
5225 }
5226
5227 =head2 webmin_log(action, type, object, &params, [module], [host, script-on-host, client-ip])
5228
5229 Log some action taken by a user. This is typically called at the end of a
5230 script, once all file changes are complete and all commands run. The
5231 parameters are :
5232
5233 =item action - A short code for the action being performed, like 'create'.
5234
5235 =item type - A code for the type of object the action is performed to, like 'user'.
5236
5237 =item object - A short name for the object, like 'joe' if the Unix user 'joe' was just created.
5238
5239 =item params - A hash ref of additional information about the action.
5240
5241 =item module - Name of the module in which the action was performed, which defaults to the current module.
5242
5243 =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.
5244
5245 =item script-on-host - Script name like create_user.cgi on the host the action was performed on.
5246
5247 =item client-ip - IP address of the browser that performed the action.
5248
5249 =cut
5250 sub webmin_log
5251 {
5252 return if (!$gconfig{'log'} || &is_readonly_mode());
5253 my $m = $_[4] ? $_[4] : &get_module_name();
5254
5255 if ($gconfig{'logclear'}) {
5256         # check if it is time to clear the log
5257         my @st = stat("$webmin_logfile.time");
5258         my $write_logtime = 0;
5259         if (@st) {
5260                 if ($st[9]+$gconfig{'logtime'}*60*60 < time()) {
5261                         # clear logfile and all diff files
5262                         &unlink_file("$ENV{'WEBMIN_VAR'}/diffs");
5263                         &unlink_file("$ENV{'WEBMIN_VAR'}/files");
5264                         &unlink_file("$ENV{'WEBMIN_VAR'}/annotations");
5265                         unlink($webmin_logfile);
5266                         $write_logtime = 1;
5267                         }
5268                 }
5269         else {
5270                 $write_logtime = 1;
5271                 }
5272         if ($write_logtime) {
5273                 open(LOGTIME, ">$webmin_logfile.time");
5274                 print LOGTIME time(),"\n";
5275                 close(LOGTIME);
5276                 }
5277         }
5278
5279 # If an action script directory is defined, call the appropriate scripts
5280 if ($gconfig{'action_script_dir'}) {
5281     my ($action, $type, $object) = ($_[0], $_[1], $_[2]);
5282     my ($basedir) = $gconfig{'action_script_dir'};
5283
5284     for my $dir ($basedir/$type/$action, $basedir/$type, $basedir) {
5285         if (-d $dir) {
5286             my ($file);
5287             opendir(DIR, $dir) or die "Can't open $dir: $!";
5288             while (defined($file = readdir(DIR))) {
5289                 next if ($file =~ /^\.\.?$/); # skip '.' and '..'
5290                 if (-x "$dir/$file") {
5291                     # Call a script notifying it of the action
5292                     my %OLDENV = %ENV;
5293                     $ENV{'ACTION_MODULE'} = &get_module_name();
5294                     $ENV{'ACTION_ACTION'} = $_[0];
5295                     $ENV{'ACTION_TYPE'} = $_[1];
5296                     $ENV{'ACTION_OBJECT'} = $_[2];
5297                     $ENV{'ACTION_SCRIPT'} = $script_name;
5298                     foreach my $p (keys %param) {
5299                             $ENV{'ACTION_PARAM_'.uc($p)} = $param{$p};
5300                             }
5301                     system("$dir/$file", @_,
5302                            "<$null_file", ">$null_file", "2>&1");
5303                     %ENV = %OLDENV;
5304                     }
5305                 }
5306             }
5307         }
5308     }
5309
5310 # should logging be done at all?
5311 return if ($gconfig{'logusers'} && &indexof($base_remote_user,
5312            split(/\s+/, $gconfig{'logusers'})) < 0);
5313 return if ($gconfig{'logmodules'} && &indexof($m,
5314            split(/\s+/, $gconfig{'logmodules'})) < 0);
5315
5316 # log the action
5317 my $now = time();
5318 my @tm = localtime($now);
5319 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
5320 my $id = sprintf "%d.%d.%d", $now, $$, $main::action_id_count;
5321 my $idprefix = substr($now, 0, 5);
5322 $main::action_id_count++;
5323 my $line = sprintf "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s %s \"%s\" \"%s\" \"%s\"",
5324         $id, $tm[3], ucfirst($number_to_month_map{$tm[4]}), $tm[5]+1900,
5325         $tm[2], $tm[1], $tm[0],
5326         $remote_user || '-',
5327         $main::session_id || '-',
5328         $_[7] || $ENV{'REMOTE_HOST'} || '-',
5329         $m, $_[5] ? "$_[5]:$_[6]" : $script_name,
5330         $_[0], $_[1] ne '' ? $_[1] : '-', $_[2] ne '' ? $_[2] : '-';
5331 my %param;
5332 foreach my $k (sort { $a cmp $b } keys %{$_[3]}) {
5333         my $v = $_[3]->{$k};
5334         my @pv;
5335         if ($v eq '') {
5336                 $line .= " $k=''";
5337                 @rv = ( "" );
5338                 }
5339         elsif (ref($v) eq 'ARRAY') {
5340                 foreach $vv (@$v) {
5341                         next if (ref($vv));
5342                         push(@pv, $vv);
5343                         $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
5344                         $line .= " $k='$vv'";
5345                         }
5346                 }
5347         elsif (!ref($v)) {
5348                 foreach $vv (split(/\0/, $v)) {
5349                         push(@pv, $vv);
5350                         $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
5351                         $line .= " $k='$vv'";
5352                         }
5353                 }
5354         $param{$k} = join(" ", @pv);
5355         }
5356 open(WEBMINLOG, ">>$webmin_logfile");
5357 print WEBMINLOG $line,"\n";
5358 close(WEBMINLOG);
5359 if ($gconfig{'logperms'}) {
5360         chmod(oct($gconfig{'logperms'}), $webmin_logfile);
5361         }
5362 else {
5363         chmod(0600, $webmin_logfile);
5364         }
5365
5366 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
5367         # Find and record the changes made to any locked files, or commands run
5368         my $i = 0;
5369         mkdir("$ENV{'WEBMIN_VAR'}/diffs", 0700);
5370         foreach my $d (@main::locked_file_diff) {
5371                 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$idprefix", 0700);
5372                 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id", 0700);
5373                 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i");
5374                 print DIFFLOG "$d->{'type'} $d->{'object'}\n";
5375                 print DIFFLOG $d->{'data'};
5376                 close(DIFFLOG);
5377                 if ($d->{'input'}) {
5378                         open(DIFFLOG,
5379                           ">$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i.input");
5380                         print DIFFLOG $d->{'input'};
5381                         close(DIFFLOG);
5382                         }
5383                 if ($gconfig{'logperms'}) {
5384                         chmod(oct($gconfig{'logperms'}),
5385                              "$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i",
5386                              "$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i.input");
5387                         }
5388                 $i++;
5389                 }
5390         @main::locked_file_diff = undef;
5391         }
5392
5393 if ($gconfig{'logfullfiles'}) {
5394         # Save the original contents of any modified files
5395         my $i = 0;
5396         mkdir("$ENV{'WEBMIN_VAR'}/files", 0700);
5397         foreach my $f (keys %main::orig_file_data) {
5398                 mkdir("$ENV{'WEBMIN_VAR'}/files/$idprefix", 0700);
5399                 mkdir("$ENV{'WEBMIN_VAR'}/files/$idprefix/$id", 0700);
5400                 open(ORIGLOG, ">$ENV{'WEBMIN_VAR'}/files/$idprefix/$id/$i");
5401                 if (!defined($main::orig_file_type{$f})) {
5402                         print ORIGLOG -1," ",$f,"\n";
5403                         }
5404                 else {
5405                         print ORIGLOG $main::orig_file_type{$f}," ",$f,"\n";
5406                         }
5407                 print ORIGLOG $main::orig_file_data{$f};
5408                 close(ORIGLOG);
5409                 if ($gconfig{'logperms'}) {
5410                         chmod(oct($gconfig{'logperms'}),
5411                               "$ENV{'WEBMIN_VAR'}/files/$idprefix/$id.$i");
5412                         }
5413                 $i++;
5414                 }
5415         %main::orig_file_data = undef;
5416         %main::orig_file_type = undef;
5417         }
5418
5419 if ($miniserv::page_capture_out) {
5420         # Save the whole page output
5421         mkdir("$ENV{'WEBMIN_VAR'}/output", 0700);
5422         mkdir("$ENV{'WEBMIN_VAR'}/output/$idprefix", 0700);
5423         open(PAGEOUT, ">$ENV{'WEBMIN_VAR'}/output/$idprefix/$id");
5424         print PAGEOUT $miniserv::page_capture_out;
5425         close(PAGEOUT);
5426         if ($gconfig{'logperms'}) {
5427                 chmod(oct($gconfig{'logperms'}),
5428                       "$ENV{'WEBMIN_VAR'}/output/$idprefix/$id");
5429                 }
5430         $miniserv::page_capture_out = undef;
5431         }
5432
5433 # Log to syslog too
5434 if ($gconfig{'logsyslog'}) {
5435         eval 'use Sys::Syslog qw(:DEFAULT setlogsock);
5436               openlog(&get_product_name(), "cons,pid,ndelay", "daemon");
5437               setlogsock("inet");';
5438         if (!$@) {
5439                 # Syslog module is installed .. try to convert to a
5440                 # human-readable form
5441                 my $msg;
5442                 my $mod = &get_module_name();
5443                 my $mdir = module_root_directory($mod);
5444                 if (-r "$mdir/log_parser.pl") {
5445                         &foreign_require($mod, "log_parser.pl");
5446                         my %params;
5447                         foreach my $k (keys %{$_[3]}) {
5448                                 my $v = $_[3]->{$k};
5449                                 if (ref($v) eq 'ARRAY') {
5450                                         $params{$k} = join("\0", @$v);
5451                                         }
5452                                 else {
5453                                         $params{$k} = $v;
5454                                         }
5455                                 }
5456                         $msg = &foreign_call($mod, "parse_webmin_log",
5457                                 $remote_user, $script_name,
5458                                 $_[0], $_[1], $_[2], \%params);
5459                         $msg =~ s/<[^>]*>//g;   # Remove tags
5460                         }
5461                 elsif ($_[0] eq "_config_") {
5462                         my %wtext = &load_language("webminlog");
5463                         $msg = $wtext{'search_config'};
5464                         }
5465                 $msg ||= "$_[0] $_[1] $_[2]";
5466                 my %info = &get_module_info($m);
5467                 eval { syslog("info", "%s", "[$info{'desc'}] $msg"); };
5468                 }
5469         }
5470 }
5471
5472 =head2 additional_log(type, object, data, [input])
5473
5474 Records additional log data for an upcoming call to webmin_log, such
5475 as a command that was run or SQL that was executed. Typically you will never
5476 need to call this function directory.
5477
5478 =cut
5479 sub additional_log
5480 {
5481 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
5482         push(@main::locked_file_diff,
5483              { 'type' => $_[0], 'object' => $_[1], 'data' => $_[2],
5484                'input' => $_[3] } );
5485         }
5486 }
5487
5488 =head2 webmin_debug_log(type, message)
5489
5490 Write something to the Webmin debug log. For internal use only.
5491
5492 =cut
5493 sub webmin_debug_log
5494 {
5495 my ($type, $msg) = @_;
5496 return 0 if (!$main::opened_debug_log);
5497 return 0 if ($gconfig{'debug_no'.$main::webmin_script_type});
5498 if ($gconfig{'debug_modules'}) {
5499         my @dmods = split(/\s+/, $gconfig{'debug_modules'});
5500         return 0 if (&indexof($main::initial_module_name, @dmods) < 0);
5501         }
5502 my $now;
5503 eval 'use Time::HiRes qw(gettimeofday); ($now, $ms) = gettimeofday';
5504 $now ||= time();
5505 my @tm = localtime($now);
5506 my $line = sprintf
5507         "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d.%6.6d] %s %s %s %s \"%s\"",
5508         $$, $tm[3], ucfirst($number_to_month_map{$tm[4]}), $tm[5]+1900,
5509         $tm[2], $tm[1], $tm[0], $ms,
5510         $remote_user || "-",
5511         $ENV{'REMOTE_HOST'} || "-",
5512         &get_module_name() || "-",
5513         $type,
5514         $msg;
5515 seek(main::DEBUGLOG, 0, 2);
5516 print main::DEBUGLOG $line."\n";
5517 return 1;
5518 }
5519
5520 =head2 system_logged(command)
5521
5522 Just calls the Perl system() function, but also logs the command run.
5523
5524 =cut
5525 sub system_logged
5526 {
5527 if (&is_readonly_mode()) {
5528         print STDERR "Vetoing command $_[0]\n";
5529         return 0;
5530         }
5531 my @realcmd = ( &translate_command($_[0]), @_[1..$#_] );
5532 my $cmd = join(" ", @realcmd);
5533 my $and;
5534 if ($cmd =~ s/(\s*&\s*)$//) {
5535         $and = $1;
5536         }
5537 while($cmd =~ s/(\d*)(<|>)((\/(tmp|dev)\S+)|&\d+)\s*$//) { }
5538 $cmd =~ s/^\((.*)\)\s*$/$1/;
5539 $cmd .= $and;
5540 &additional_log('exec', undef, $cmd);
5541 return system(@realcmd);
5542 }
5543
5544 =head2 backquote_logged(command)
5545
5546 Executes a command and returns the output (like `command`), but also logs it.
5547
5548 =cut
5549 sub backquote_logged
5550 {
5551 if (&is_readonly_mode()) {
5552         $? = 0;
5553         print STDERR "Vetoing command $_[0]\n";
5554         return undef;
5555         }
5556 my $realcmd = &translate_command($_[0]);
5557 my $cmd = $realcmd;
5558 my $and;
5559 if ($cmd =~ s/(\s*&\s*)$//) {
5560         $and = $1;
5561         }
5562 while($cmd =~ s/(\d*)(<|>)((\/(tmp\/.webmin|dev)\S+)|&\d+)\s*$//) { }
5563 $cmd =~ s/^\((.*)\)\s*$/$1/;
5564 $cmd .= $and;
5565 &additional_log('exec', undef, $cmd);
5566 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
5567 return `$realcmd`;
5568 }
5569
5570 =head2 backquote_with_timeout(command, timeout, safe?, [maxlines])
5571
5572 Runs some command, waiting at most the given number of seconds for it to
5573 complete, and returns the output. The maxlines parameter sets the number
5574 of lines of output to capture. The safe parameter should be set to 1 if the
5575 command is safe for read-only mode users to run.
5576
5577 =cut
5578 sub backquote_with_timeout
5579 {
5580 my $realcmd = &translate_command($_[0]);
5581 &webmin_debug_log('CMD', "cmd=$realcmd timeout=$_[1]")
5582         if ($gconfig{'debug_what_cmd'});
5583 my $out;
5584 my $pid = &open_execute_command(OUT, "($realcmd) <$null_file", 1, $_[2]);
5585 my $start = time();
5586 my $timed_out = 0;
5587 my $linecount = 0;
5588 while(1) {
5589         my $elapsed = time() - $start;
5590         last if ($elapsed > $_[1]);
5591         my $rmask;
5592         vec($rmask, fileno(OUT), 1) = 1;
5593         my $sel = select($rmask, undef, undef, $_[1] - $elapsed);
5594         last if (!$sel || $sel < 0);
5595         my $line = <OUT>;
5596         last if (!defined($line));
5597         $out .= $line;
5598         $linecount++;
5599         if ($_[3] && $linecount >= $_[3]) {
5600                 # Got enough lines
5601                 last;
5602                 }
5603         }
5604 if (kill('TERM', $pid) && time() - $start >= $_[1]) {
5605         $timed_out = 1;
5606         }
5607 close(OUT);
5608 return wantarray ? ($out, $timed_out) : $out;
5609 }
5610
5611 =head2 backquote_command(command, safe?)
5612
5613 Executes a command and returns the output (like `command`), subject to
5614 command translation. The safe parameter should be set to 1 if the command
5615 is safe for read-only mode users to run.
5616
5617 =cut
5618 sub backquote_command
5619 {
5620 if (&is_readonly_mode() && !$_[1]) {
5621         print STDERR "Vetoing command $_[0]\n";
5622         $? = 0;
5623         return undef;
5624         }
5625 my $realcmd = &translate_command($_[0]);
5626 &webmin_debug_log('CMD', "cmd=$realcmd") if ($gconfig{'debug_what_cmd'});
5627 return `$realcmd`;
5628 }
5629
5630 =head2 kill_logged(signal, pid, ...)
5631
5632 Like Perl's built-in kill function, but also logs the fact that some process
5633 was killed. On Windows, falls back to calling process.exe to terminate a
5634 process.
5635
5636 =cut
5637 sub kill_logged
5638 {
5639 return scalar(@_)-1 if (&is_readonly_mode());
5640 &webmin_debug_log('KILL', "signal=$_[0] pids=".join(" ", @_[1..@_-1]))
5641         if ($gconfig{'debug_what_procs'});
5642 &additional_log('kill', $_[0], join(" ", @_[1..@_-1])) if (@_ > 1);
5643 if ($gconfig{'os_type'} eq 'windows') {
5644         # Emulate some kills with process.exe
5645         my $arg = $_[0] eq "KILL" ? "-k" :
5646                   $_[0] eq "TERM" ? "-q" :
5647                   $_[0] eq "STOP" ? "-s" :
5648                   $_[0] eq "CONT" ? "-r" : undef;
5649         my $ok = 0;
5650         foreach my $p (@_[1..@_-1]) {
5651                 if ($p < 0) {
5652                         $ok ||= kill($_[0], $p);
5653                         }
5654                 elsif ($arg) {
5655                         &execute_command("process $arg $p");
5656                         $ok = 1;
5657                         }
5658                 }
5659         return $ok;
5660         }
5661 else {
5662         # Normal Unix kill
5663         return kill(@_);
5664         }
5665 }
5666
5667 =head2 rename_logged(old, new)
5668
5669 Re-names a file and logs the rename. If the old and new files are on different
5670 filesystems, calls mv or the Windows rename function to do the job.
5671
5672 =cut
5673 sub rename_logged
5674 {
5675 &additional_log('rename', $_[0], $_[1]) if ($_[0] ne $_[1]);
5676 return &rename_file($_[0], $_[1]);
5677 }
5678
5679 =head2 rename_file(old, new)
5680
5681 Renames a file or directory. If the old and new files are on different
5682 filesystems, calls mv or the Windows rename function to do the job.
5683
5684 =cut
5685 sub rename_file
5686 {
5687 if (&is_readonly_mode()) {
5688         print STDERR "Vetoing rename from $_[0] to $_[1]\n";
5689         return 1;
5690         }
5691 my $src = &translate_filename($_[0]);
5692 my $dst = &translate_filename($_[1]);
5693 &webmin_debug_log('RENAME', "src=$src dst=$dst")
5694         if ($gconfig{'debug_what_ops'});
5695 my $ok = rename($src, $dst);
5696 if (!$ok && $! !~ /permission/i) {
5697         # Try the mv command, in case this is a cross-filesystem rename
5698         if ($gconfig{'os_type'} eq 'windows') {
5699                 # Need to use rename
5700                 my $out = &backquote_command("rename ".quotemeta($_[0]).
5701                                              " ".quotemeta($_[1])." 2>&1");
5702                 $ok = !$?;
5703                 $! = $out if (!$ok);
5704                 }
5705         else {
5706                 # Can use mv
5707                 my $out = &backquote_command("mv ".quotemeta($_[0]).
5708                                              " ".quotemeta($_[1])." 2>&1");
5709                 $ok = !$?;
5710                 $! = $out if (!$ok);
5711                 }
5712         }
5713 return $ok;
5714 }
5715
5716 =head2 symlink_logged(src, dest)
5717
5718 Create a symlink, and logs it. Effectively does the same thing as the Perl
5719 symlink function.
5720
5721 =cut
5722 sub symlink_logged
5723 {
5724 &lock_file($_[1]);
5725 my $rv = &symlink_file($_[0], $_[1]);
5726 &unlock_file($_[1]);
5727 return $rv;
5728 }
5729
5730 =head2 symlink_file(src, dest)
5731
5732 Creates a soft link, unless in read-only mode. Effectively does the same thing
5733 as the Perl symlink function.
5734
5735 =cut
5736 sub symlink_file
5737 {
5738 if (&is_readonly_mode()) {
5739         print STDERR "Vetoing symlink from $_[0] to $_[1]\n";
5740         return 1;
5741         }
5742 my $src = &translate_filename($_[0]);
5743 my $dst = &translate_filename($_[1]);
5744 &webmin_debug_log('SYMLINK', "src=$src dst=$dst")
5745         if ($gconfig{'debug_what_ops'});
5746 return symlink($src, $dst);
5747 }
5748
5749 =head2 link_file(src, dest)
5750
5751 Creates a hard link, unless in read-only mode. The existing new link file
5752 will be deleted if necessary. Effectively the same as Perl's link function.
5753
5754 =cut
5755 sub link_file
5756 {
5757 if (&is_readonly_mode()) {
5758         print STDERR "Vetoing link from $_[0] to $_[1]\n";
5759         return 1;
5760         }
5761 my $src = &translate_filename($_[0]);
5762 my $dst = &translate_filename($_[1]);
5763 &webmin_debug_log('LINK', "src=$src dst=$dst")
5764         if ($gconfig{'debug_what_ops'});
5765 unlink($dst);                   # make sure link works
5766 return link($src, $dst);
5767 }
5768
5769 =head2 make_dir(dir, perms, recursive)
5770
5771 Creates a directory and sets permissions on it, unless in read-only mode.
5772 The perms parameter sets the octal permissions to apply, which unlike Perl's
5773 mkdir will really get set. The recursive flag can be set to 1 to have the
5774 function create parent directories too.
5775
5776 =cut
5777 sub make_dir
5778 {
5779 my ($dir, $perms, $recur) = @_;
5780 if (&is_readonly_mode()) {
5781         print STDERR "Vetoing directory $dir\n";
5782         return 1;
5783         }
5784 $dir = &translate_filename($dir);
5785 my $exists = -d $dir ? 1 : 0;
5786 return 1 if ($exists && $recur);        # already exists
5787 &webmin_debug_log('MKDIR', $dir) if ($gconfig{'debug_what_ops'});
5788 my $rv = mkdir($dir, $perms);
5789 if (!$rv && $recur) {
5790         # Failed .. try mkdir -p
5791         my $param = $gconfig{'os_type'} eq 'windows' ? "" : "-p";
5792         my $ex = &execute_command("mkdir $param ".&quote_path($dir));
5793         if ($ex) {
5794                 return 0;
5795                 }
5796         }
5797 if (!$exists) {
5798         chmod($perms, $dir);
5799         }
5800 return 1;
5801 }
5802
5803 =head2 set_ownership_permissions(user, group, perms, file, ...)
5804
5805 Sets the user, group owner and permissions on some files. The parameters are :
5806
5807 =item user - UID or username to change the file owner to. If undef, then the owner is not changed.
5808
5809 =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.
5810
5811 =item perms - Octal permissions set to set on the file. If undef, they are left alone.
5812
5813 =item file - One or more files or directories to modify.
5814
5815 =cut
5816 sub set_ownership_permissions
5817 {
5818 my ($user, $group, $perms, @files) = @_;
5819 if (&is_readonly_mode()) {
5820         print STDERR "Vetoing permission changes on ",join(" ", @files),"\n";
5821         return 1;
5822         }
5823 @files = map { &translate_filename($_) } @files;
5824 if ($gconfig{'debug_what_ops'}) {
5825         foreach my $f (@files) {
5826                 &webmin_debug_log('PERMS',
5827                         "file=$f user=$user group=$group perms=$perms");
5828                 }
5829         }
5830 my $rv = 1;
5831 if (defined($user)) {
5832         my $uid = $user !~ /^\d+$/ ? getpwnam($user) : $user;
5833         my $gid;
5834         if (defined($group)) {
5835                 $gid = $group !~ /^\d+$/ ? getgrnam($group) : $group;
5836                 }
5837         else {
5838                 my @uinfo = getpwuid($uid);
5839                 $gid = $uinfo[3];
5840                 }
5841         $rv = chown($uid, $gid, @files);
5842         }
5843 if ($rv && defined($perms)) {
5844         $rv = chmod($perms, @files);
5845         }
5846 return $rv;
5847 }
5848
5849 =head2 unlink_logged(file, ...)
5850
5851 Like Perl's unlink function, but locks the files beforehand and un-locks them
5852 after so that the deletion is logged by Webmin.
5853
5854 =cut
5855 sub unlink_logged
5856 {
5857 my %locked;
5858 foreach my $f (@_) {
5859         if (!&test_lock($f)) {
5860                 &lock_file($f);
5861                 $locked{$f} = 1;
5862                 }
5863         }
5864 my @rv = &unlink_file(@_);
5865 foreach my $f (@_) {
5866         if ($locked{$f}) {
5867                 &unlock_file($f);
5868                 }
5869         }
5870 return wantarray ? @rv : $rv[0];
5871 }
5872
5873 =head2 unlink_file(file, ...)
5874
5875 Deletes some files or directories. Like Perl's unlink function, but also
5876 recursively deletes directories with the rm command if needed.
5877
5878 =cut
5879 sub unlink_file
5880 {
5881 return 1 if (&is_readonly_mode());
5882 my $rv = 1;
5883 my $err;
5884 foreach my $f (@_) {
5885         &unflush_file_lines($f);
5886         my $realf = &translate_filename($f);
5887         &webmin_debug_log('UNLINK', $realf) if ($gconfig{'debug_what_ops'});
5888         if (-d $realf) {
5889                 if (!rmdir($realf)) {
5890                         my $out;
5891                         if ($gconfig{'os_type'} eq 'windows') {
5892                                 # Call del and rmdir commands
5893                                 my $qm = $realf;
5894                                 $qm =~ s/\//\\/g;
5895                                 my $out = `del /q "$qm" 2>&1`;
5896                                 if (!$?) {
5897                                         $out = `rmdir "$qm" 2>&1`;
5898                                         }
5899                                 }
5900                         else {
5901                                 # Use rm command
5902                                 my $qm = quotemeta($realf);
5903                                 $out = `rm -rf $qm 2>&1`;
5904                                 }
5905                         if ($?) {
5906                                 $rv = 0;
5907                                 $err = $out;
5908                                 }
5909                         }
5910                 }
5911         else {
5912                 if (!unlink($realf)) {
5913                         $rv = 0;
5914                         $err = $!;
5915                         }
5916                 }
5917         }
5918 return wantarray ? ($rv, $err) : $rv;
5919 }
5920
5921 =head2 copy_source_dest(source, dest)
5922
5923 Copy some file or directory to a new location. Returns 1 on success, or 0
5924 on failure - also sets $! on failure. If the source is a directory, uses
5925 piped tar commands to copy a whole directory structure including permissions
5926 and special files.
5927
5928 =cut
5929 sub copy_source_dest
5930 {
5931 return (1, undef) if (&is_readonly_mode());
5932 my ($src, $dst) = @_;
5933 my $ok = 1;
5934 my ($err, $out);
5935 &webmin_debug_log('COPY', "src=$src dst=$dst")
5936         if ($gconfig{'debug_what_ops'});
5937 if ($gconfig{'os_type'} eq 'windows') {
5938         # No tar or cp on windows, so need to use copy command
5939         $src =~ s/\//\\/g;
5940         $dst =~ s/\//\\/g;
5941         if (-d $src) {
5942                 $out = &backquote_logged("xcopy \"$src\" \"$dst\" /Y /E /I 2>&1");
5943                 }
5944         else {
5945                 $out = &backquote_logged("copy /Y \"$src\" \"$dst\" 2>&1");
5946                 }
5947         if ($?) {
5948                 $ok = 0;
5949                 $err = $out;
5950                 }
5951         }
5952 elsif (-d $src) {
5953         # A directory .. need to copy with tar command
5954         my @st = stat($src);
5955         unlink($dst);
5956         mkdir($dst, 0755);
5957         &set_ownership_permissions($st[4], $st[5], $st[2], $dst);
5958         $out = &backquote_logged("(cd ".quotemeta($src)." ; tar cf - . | (cd ".quotemeta($dst)." ; tar xf -)) 2>&1");
5959         if ($?) {
5960                 $ok = 0;
5961                 $err = $out;
5962                 }
5963         }
5964 else {
5965         # Can just copy with cp
5966         my $out = &backquote_logged("cp -p ".quotemeta($src).
5967                                     " ".quotemeta($dst)." 2>&1");
5968         if ($?) {
5969                 $ok = 0;
5970                 $err = $out;
5971                 }
5972         }
5973 return wantarray ? ($ok, $err) : $ok;
5974 }
5975
5976 =head2 remote_session_name(host|&server)
5977
5978 Generates a session ID for some server. For this server, this will always
5979 be an empty string. For a server object it will include the hostname and
5980 port and PID. For a server name, it will include the hostname and PID. For
5981 internal use only.
5982
5983 =cut
5984 sub remote_session_name
5985 {
5986 return ref($_[0]) && $_[0]->{'host'} && $_[0]->{'port'} ?
5987                 "$_[0]->{'host'}:$_[0]->{'port'}.$$" :
5988        $_[0] eq "" || ref($_[0]) && $_[0]->{'id'} == 0 ? "" :
5989        ref($_[0]) ? "" : "$_[0].$$";
5990 }
5991
5992 =head2 remote_foreign_require(server, module, file)
5993
5994 Connects to rpc.cgi on a remote webmin server and have it open a session
5995 to a process that will actually do the require and run functions. This is the
5996 equivalent for foreign_require, but for a remote Webmin system. The server
5997 parameter can either be a hostname of a system registered in the Webmin
5998 Servers Index module, or a hash reference for a system from that module.
5999
6000 =cut
6001 sub remote_foreign_require
6002 {
6003 my $call = { 'action' => 'require',
6004              'module' => $_[1],
6005              'file' => $_[2] };
6006 my $sn = &remote_session_name($_[0]);
6007 if ($remote_session{$sn}) {
6008         $call->{'session'} = $remote_session{$sn};
6009         }
6010 else {
6011         $call->{'newsession'} = 1;
6012         }
6013 my $rv = &remote_rpc_call($_[0], $call);
6014 if ($rv->{'session'}) {
6015         $remote_session{$sn} = $rv->{'session'};
6016         $remote_session_server{$sn} = $_[0];
6017         }
6018 }
6019
6020 =head2 remote_foreign_call(server, module, function, [arg]*)
6021
6022 Call a function on a remote server. Must have been setup first with
6023 remote_foreign_require for the same server and module. Equivalent to
6024 foreign_call, but with the extra server parameter to specify the remote
6025 system's hostname.
6026
6027 =cut
6028 sub remote_foreign_call
6029 {
6030 return undef if (&is_readonly_mode());
6031 my $sn = &remote_session_name($_[0]);
6032 return &remote_rpc_call($_[0], { 'action' => 'call',
6033                                  'module' => $_[1],
6034                                  'func' => $_[2],
6035                                  'session' => $remote_session{$sn},
6036                                  'args' => [ @_[3 .. $#_] ] } );
6037 }
6038
6039 =head2 remote_foreign_check(server, module, [api-only])
6040
6041 Checks if some module is installed and supported on a remote server. Equivilant
6042 to foreign_check, but for the remote Webmin system specified by the server
6043 parameter.
6044
6045 =cut
6046 sub remote_foreign_check
6047 {
6048 return &remote_rpc_call($_[0], { 'action' => 'check',
6049                                  'module' => $_[1],
6050                                  'api' => $_[2] });
6051 }
6052
6053 =head2 remote_foreign_config(server, module)
6054
6055 Gets the configuration for some module from a remote server, as a hash.
6056 Equivalent to foreign_config, but for a remote system.
6057
6058 =cut
6059 sub remote_foreign_config
6060 {
6061 return &remote_rpc_call($_[0], { 'action' => 'config',
6062                                  'module' => $_[1] });
6063 }
6064
6065 =head2 remote_eval(server, module, code)
6066
6067 Evaluates some perl code in the context of a module on a remote webmin server.
6068 The server parameter must be the hostname of a remote system, module must
6069 be a module directory name, and code a string of Perl code to run. This can
6070 only be called after remote_foreign_require for the same server and module.
6071
6072 =cut
6073 sub remote_eval
6074 {
6075 return undef if (&is_readonly_mode());
6076 my $sn = &remote_session_name($_[0]);
6077 return &remote_rpc_call($_[0], { 'action' => 'eval',
6078                                  'module' => $_[1],
6079                                  'code' => $_[2],
6080                                  'session' => $remote_session{$sn} });
6081 }
6082
6083 =head2 remote_write(server, localfile, [remotefile], [remotebasename])
6084
6085 Transfers some local file to another server via Webmin's RPC protocol, and
6086 returns the resulting remote filename. If the remotefile parameter is given,
6087 that is the destination filename which will be used. Otherwise a randomly
6088 selected temporary filename will be used, and returned by the function.
6089
6090 =cut
6091 sub remote_write
6092 {
6093 return undef if (&is_readonly_mode());
6094 my ($data, $got);
6095 my $sn = &remote_session_name($_[0]);
6096 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
6097         # Copy data over TCP connection
6098         my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpwrite',
6099                                            'file' => $_[2],
6100                                            'name' => $_[3] } );
6101         my $error;
6102         my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
6103         &open_socket($serv || "localhost", $rv->[1], TWRITE, \$error);
6104         return &$main::remote_error_handler("Failed to transfer file : $error")
6105                 if ($error);
6106         open(FILE, $_[1]);
6107         while(read(FILE, $got, 1024) > 0) {
6108                 print TWRITE $got;
6109                 }
6110         close(FILE);
6111         shutdown(TWRITE, 1);
6112         $error = <TWRITE>;
6113         if ($error && $error !~ /^OK/) {
6114                 # Got back an error!
6115                 return &$main::remote_error_handler("Failed to transfer file : $error");
6116                 }
6117         close(TWRITE);
6118         return $rv->[0];
6119         }
6120 else {
6121         # Just pass file contents as parameters
6122         open(FILE, $_[1]);
6123         while(read(FILE, $got, 1024) > 0) {
6124                 $data .= $got;
6125                 }
6126         close(FILE);
6127         return &remote_rpc_call($_[0], { 'action' => 'write',
6128                                          'data' => $data,
6129                                          'file' => $_[2],
6130                                          'session' => $remote_session{$sn} });
6131         }
6132 }
6133
6134 =head2 remote_read(server, localfile, remotefile)
6135
6136 Transfers a file from a remote server to this system, using Webmin's RPC
6137 protocol. The server parameter must be the hostname of a system registered
6138 in the Webmin Servers Index module, localfile is the destination path on this
6139 system, and remotefile is the file to fetch from the remote server.
6140
6141 =cut
6142 sub remote_read
6143 {
6144 my $sn = &remote_session_name($_[0]);
6145 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
6146         # Copy data over TCP connection
6147         my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpread',
6148                                            'file' => $_[2] } );
6149         if (!$rv->[0]) {
6150                 return &$main::remote_error_handler("Failed to transfer file : $rv->[1]");
6151                 }
6152         my $error;
6153         my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
6154         &open_socket($serv || "localhost", $rv->[1], TREAD, \$error);
6155         return &$main::remote_error_handler("Failed to transfer file : $error")
6156                 if ($error);
6157         my $got;
6158         open(FILE, ">$_[1]");
6159         while(read(TREAD, $got, 1024) > 0) {
6160                 print FILE $got;
6161                 }
6162         close(FILE);
6163         close(TREAD);
6164         }
6165 else {
6166         # Just get data as return value
6167         my $d = &remote_rpc_call($_[0], { 'action' => 'read',
6168                                           'file' => $_[2],
6169                                           'session' => $remote_session{$sn} });
6170         open(FILE, ">$_[1]");
6171         print FILE $d;
6172         close(FILE);
6173         }
6174 }
6175
6176 =head2 remote_finished
6177
6178 Close all remote sessions. This happens automatically after a while
6179 anyway, but this function should be called to clean things up faster.
6180
6181 =cut
6182 sub remote_finished
6183 {
6184 foreach my $sn (keys %remote_session) {
6185         my $server = $remote_session_server{$sn};
6186         &remote_rpc_call($server, { 'action' => 'quit',
6187                                     'session' => $remote_session{$sn} } );
6188         delete($remote_session{$sn});
6189         delete($remote_session_server{$sn});
6190         }
6191 foreach my $fh (keys %fast_fh_cache) {
6192         close($fh);
6193         delete($fast_fh_cache{$fh});
6194         }
6195 }
6196
6197 =head2 remote_error_setup(&function)
6198
6199 Sets a function to be called instead of &error when a remote RPC operation
6200 fails. Useful if you want to have more control over your remote operations.
6201
6202 =cut
6203 sub remote_error_setup
6204 {
6205 $main::remote_error_handler = $_[0] || \&error;
6206 }
6207
6208 =head2 remote_rpc_call(server, &structure)
6209
6210 Calls rpc.cgi on some server and passes it a perl structure (hash,array,etc)
6211 and then reads back a reply structure. This is mainly for internal use only,
6212 and is called by the other remote_* functions.
6213
6214 =cut
6215 sub remote_rpc_call
6216 {
6217 my $serv;
6218 my $sn = &remote_session_name($_[0]);   # Will be undef for local connection
6219 if (ref($_[0])) {
6220         # Server structure was given
6221         $serv = $_[0];
6222         $serv->{'user'} || $serv->{'id'} == 0 ||
6223                 return &$main::remote_error_handler(
6224                         "No Webmin login set for server");
6225         }
6226 elsif ($_[0]) {
6227         # lookup the server in the webmin servers module if needed
6228         if (!%main::remote_servers_cache) {
6229                 &foreign_require("servers", "servers-lib.pl");
6230                 foreach $s (&foreign_call("servers", "list_servers")) {
6231                         $main::remote_servers_cache{$s->{'host'}} = $s;
6232                         $main::remote_servers_cache{$s->{'host'}.":".$s->{'port'}} = $s;
6233                         }
6234                 }
6235         $serv = $main::remote_servers_cache{$_[0]};
6236         $serv || return &$main::remote_error_handler(
6237                                 "No Webmin Servers entry for $_[0]");
6238         $serv->{'user'} || return &$main::remote_error_handler(
6239                                 "No login set for server $_[0]");
6240         }
6241 my $ip = $serv->{'ip'} || $serv->{'host'};
6242
6243 # Work out the username and password
6244 my ($user, $pass);
6245 if ($serv->{'sameuser'}) {
6246         $user = $remote_user;
6247         defined($main::remote_pass) || return &$main::remote_error_handler(
6248                                    "Password for this server is not available");
6249         $pass = $main::remote_pass;
6250         }
6251 else {
6252         $user = $serv->{'user'};
6253         $pass = $serv->{'pass'};
6254         }
6255
6256 if ($serv->{'fast'} || !$sn) {
6257         # Make TCP connection call to fastrpc.cgi
6258         if (!$fast_fh_cache{$sn} && $sn) {
6259                 # Need to open the connection
6260                 my $con = &make_http_connection(
6261                         $ip, $serv->{'port'}, $serv->{'ssl'},
6262                         "POST", "/fastrpc.cgi");
6263                 return &$main::remote_error_handler(
6264                     "Failed to connect to $serv->{'host'} : $con")
6265                         if (!ref($con));
6266                 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
6267                 &write_http_connection($con, "User-agent: Webmin\r\n");
6268                 my $auth = &encode_base64("$user:$pass");
6269                 $auth =~ tr/\n//d;
6270                 &write_http_connection($con, "Authorization: basic $auth\r\n");
6271                 &write_http_connection($con, "Content-length: ",
6272                                              length($tostr),"\r\n");
6273                 &write_http_connection($con, "\r\n");
6274                 &write_http_connection($con, $tostr);
6275
6276                 # read back the response
6277                 my $line = &read_http_connection($con);
6278                 $line =~ tr/\r\n//d;
6279                 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
6280                         return &$main::remote_error_handler("Login to RPC server as $user rejected");
6281                         }
6282                 $line =~ /^HTTP\/1\..\s+200\s+/ ||
6283                         return &$main::remote_error_handler("HTTP error : $line");
6284                 do {
6285                         $line = &read_http_connection($con);
6286                         $line =~ tr/\r\n//d;
6287                         } while($line);
6288                 $line = &read_http_connection($con);
6289                 if ($line =~ /^0\s+(.*)/) {
6290                         return &$main::remote_error_handler("RPC error : $1");
6291                         }
6292                 elsif ($line =~ /^1\s+(\S+)\s+(\S+)\s+(\S+)/ ||
6293                        $line =~ /^1\s+(\S+)\s+(\S+)/) {
6294                         # Started ok .. connect and save SID
6295                         &close_http_connection($con);
6296                         my ($port, $sid, $version, $error) = ($1, $2, $3);
6297                         &open_socket($ip, $port, $sid, \$error);
6298                         return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error")
6299                                 if ($error);
6300                         $fast_fh_cache{$sn} = $sid;
6301                         $remote_server_version{$sn} = $version;
6302                         }
6303                 else {
6304                         while($stuff = &read_http_connection($con)) {
6305                                 $line .= $stuff;
6306                                 }
6307                         return &$main::remote_error_handler("Bad response from fastrpc.cgi : $line");
6308                         }
6309                 }
6310         elsif (!$fast_fh_cache{$sn}) {
6311                 # Open the connection by running fastrpc.cgi locally
6312                 pipe(RPCOUTr, RPCOUTw);
6313                 if (!fork()) {
6314                         untie(*STDIN);
6315                         untie(*STDOUT);
6316                         open(STDOUT, ">&RPCOUTw");
6317                         close(STDIN);
6318                         close(RPCOUTr);
6319                         $| = 1;
6320                         $ENV{'REQUEST_METHOD'} = 'GET';
6321                         $ENV{'SCRIPT_NAME'} = '/fastrpc.cgi';
6322                         $ENV{'SERVER_ROOT'} ||= $root_directory;
6323                         my %acl;
6324                         if ($base_remote_user ne 'root' &&
6325                             $base_remote_user ne 'admin') {
6326                                 # Need to fake up a login for the CGI!
6327                                 &read_acl(undef, \%acl, [ 'root' ]);
6328                                 $ENV{'BASE_REMOTE_USER'} =
6329                                         $ENV{'REMOTE_USER'} =
6330                                                 $acl{'root'} ? 'root' : 'admin';
6331                                 }
6332                         delete($ENV{'FOREIGN_MODULE_NAME'});
6333                         delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
6334                         chdir($root_directory);
6335                         if (!exec("$root_directory/fastrpc.cgi")) {
6336                                 print "exec failed : $!\n";
6337                                 exit 1;
6338                                 }
6339                         }
6340                 close(RPCOUTw);
6341                 my $line;
6342                 do {
6343                         ($line = <RPCOUTr>) =~ tr/\r\n//d;
6344                         } while($line);
6345                 $line = <RPCOUTr>;
6346                 #close(RPCOUTr);
6347                 if ($line =~ /^0\s+(.*)/) {
6348                         return &$main::remote_error_handler("RPC error : $2");
6349                         }
6350                 elsif ($line =~ /^1\s+(\S+)\s+(\S+)/) {
6351                         # Started ok .. connect and save SID
6352                         close(SOCK);
6353                         my ($port, $sid, $error) = ($1, $2, undef);
6354                         &open_socket("localhost", $port, $sid, \$error);
6355                         return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error") if ($error);
6356                         $fast_fh_cache{$sn} = $sid;
6357                         }
6358                 else {
6359                         local $_;
6360                         while(<RPCOUTr>) {
6361                                 $line .= $_;
6362                                 }
6363                         &error("Bad response from fastrpc.cgi : $line");
6364                         }
6365                 }
6366         # Got a connection .. send off the request
6367         my $fh = $fast_fh_cache{$sn};
6368         my $tostr = &serialise_variable($_[1]);
6369         print $fh length($tostr)," $fh\n";
6370         print $fh $tostr;
6371         my $rstr = <$fh>;
6372         if ($rstr eq '') {
6373                 return &$main::remote_error_handler(
6374                         "Error reading response length from fastrpc.cgi : $!")
6375                 }
6376         my $rlen = int($rstr);
6377         my ($fromstr, $got);
6378         while(length($fromstr) < $rlen) {
6379                 return &$main::remote_error_handler(
6380                         "Failed to read from fastrpc.cgi : $!")
6381                         if (read($fh, $got, $rlen - length($fromstr)) <= 0);
6382                 $fromstr .= $got;
6383                 }
6384         my $from = &unserialise_variable($fromstr);
6385         if (!$from) {
6386                 # No response at all
6387                 return &$main::remote_error_handler("Remote Webmin error");
6388                 }
6389         elsif (ref($from) ne 'HASH') {
6390                 # Not a hash?!
6391                 return &$main::remote_error_handler(
6392                         "Invalid remote Webmin response : $from");
6393                 }
6394         elsif (!$from->{'status'}) {
6395                 # Call failed
6396                 $from->{'rv'} =~ s/\s+at\s+(\S+)\s+line\s+(\d+)(,\s+<\S+>\s+line\s+(\d+))?//;
6397                 return &$main::remote_error_handler($from->{'rv'});
6398                 }
6399         if (defined($from->{'arv'})) {
6400                 return @{$from->{'arv'}};
6401                 }
6402         else {
6403                 return $from->{'rv'};
6404                 }
6405         }
6406 else {
6407         # Call rpc.cgi on remote server
6408         my $tostr = &serialise_variable($_[1]);
6409         my $error = 0;
6410         my $con = &make_http_connection($ip, $serv->{'port'},
6411                                         $serv->{'ssl'}, "POST", "/rpc.cgi");
6412         return &$main::remote_error_handler("Failed to connect to $serv->{'host'} : $con") if (!ref($con));
6413
6414         &write_http_connection($con, "Host: $serv->{'host'}\r\n");
6415         &write_http_connection($con, "User-agent: Webmin\r\n");
6416         my $auth = &encode_base64("$user:$pass");
6417         $auth =~ tr/\n//d;
6418         &write_http_connection($con, "Authorization: basic $auth\r\n");
6419         &write_http_connection($con, "Content-length: ",length($tostr),"\r\n");
6420         &write_http_connection($con, "\r\n");
6421         &write_http_connection($con, $tostr);
6422
6423         # read back the response
6424         my $line = &read_http_connection($con);
6425         $line =~ tr/\r\n//d;
6426         if ($line =~ /^HTTP\/1\..\s+401\s+/) {
6427                 return &$main::remote_error_handler("Login to RPC server as $user rejected");
6428                 }
6429         $line =~ /^HTTP\/1\..\s+200\s+/ || return &$main::remote_error_handler("RPC HTTP error : $line");
6430         do {
6431                 $line = &read_http_connection($con);
6432                 $line =~ tr/\r\n//d;
6433                 } while($line);
6434         my $fromstr;
6435         while($line = &read_http_connection($con)) {
6436                 $fromstr .= $line;
6437                 }
6438         close(SOCK);
6439         my $from = &unserialise_variable($fromstr);
6440         return &$main::remote_error_handler("Invalid RPC login to $serv->{'host'}") if (!$from->{'status'});
6441         if (defined($from->{'arv'})) {
6442                 return @{$from->{'arv'}};
6443                 }
6444         else {
6445                 return $from->{'rv'};
6446                 }
6447         }
6448 }
6449
6450 =head2 remote_multi_callback(&servers, parallel, &function, arg|&args, &returns, &errors, [module, library])
6451
6452 Executes some function in parallel on multiple servers at once. Fills in
6453 the returns and errors arrays respectively. If the module and library
6454 parameters are given, that module is remotely required on the server first,
6455 to check if it is connectable. The parameters are :
6456
6457 =item servers - A list of Webmin system hash references.
6458
6459 =item parallel - Number of parallel operations to perform.
6460
6461 =item function - Reference to function to call for each system.
6462
6463 =item args - Additional parameters to the function.
6464
6465 =item returns - Array ref to place return values into, in same order as servers.
6466
6467 =item errors - Array ref to place error messages into.
6468
6469 =item module - Optional module to require on the remote system first.
6470
6471 =item library - Optional library to require in the module.
6472
6473 =cut
6474 sub remote_multi_callback
6475 {
6476 my ($servs, $parallel, $func, $args, $rets, $errs, $mod, $lib) = @_;
6477 &remote_error_setup(\&remote_multi_callback_error);
6478
6479 # Call the functions
6480 my $p = 0;
6481 foreach my $g (@$servs) {
6482         my $rh = "READ$p";
6483         my $wh = "WRITE$p";
6484         pipe($rh, $wh);
6485         if (!fork()) {
6486                 close($rh);
6487                 $remote_multi_callback_err = undef;
6488                 if ($mod) {
6489                         # Require the remote lib
6490                         &remote_foreign_require($g->{'host'}, $mod, $lib);
6491                         if ($remote_multi_callback_err) {
6492                                 # Failed .. return error
6493                                 print $wh &serialise_variable(
6494                                         [ undef, $remote_multi_callback_err ]);
6495                                 exit(0);
6496                                 }
6497                         }
6498
6499                 # Call the function
6500                 my $a = ref($args) ? $args->[$p] : $args;
6501                 my $rv = &$func($g, $a);
6502
6503                 # Return the result
6504                 print $wh &serialise_variable(
6505                         [ $rv, $remote_multi_callback_err ]);
6506                 close($wh);
6507                 exit(0);
6508                 }
6509         close($wh);
6510         $p++;
6511         }
6512
6513 # Read back the results
6514 $p = 0;
6515 foreach my $g (@$servs) {
6516         my $rh = "READ$p";
6517         my $line = <$rh>;
6518         if (!$line) {
6519                 $errs->[$p] = "Failed to read response from $g->{'host'}";
6520                 }
6521         else {
6522                 my $rv = &unserialise_variable($line);
6523                 close($rh);
6524                 $rets->[$p] = $rv->[0];
6525                 $errs->[$p] = $rv->[1];
6526                 }
6527         $p++;
6528         }
6529
6530 &remote_error_setup(undef);
6531 }
6532
6533 sub remote_multi_callback_error
6534 {
6535 $remote_multi_callback_err = $_[0];
6536 }
6537
6538 =head2 serialise_variable(variable)
6539
6540 Converts some variable (maybe a scalar, hash ref, array ref or scalar ref)
6541 into a url-encoded string. In the cases of arrays and hashes, it is recursively
6542 called on each member to serialize the entire object.
6543
6544 =cut
6545 sub serialise_variable
6546 {
6547 if (!defined($_[0])) {
6548         return 'UNDEF';
6549         }
6550 my $r = ref($_[0]);
6551 my $rv;
6552 if (!$r) {
6553         $rv = &urlize($_[0]);
6554         }
6555 elsif ($r eq 'SCALAR') {
6556         $rv = &urlize(${$_[0]});
6557         }
6558 elsif ($r eq 'ARRAY') {
6559         $rv = join(",", map { &urlize(&serialise_variable($_)) } @{$_[0]});
6560         }
6561 elsif ($r eq 'HASH') {
6562         $rv = join(",", map { &urlize(&serialise_variable($_)).",".
6563                               &urlize(&serialise_variable($_[0]->{$_})) }
6564                             keys %{$_[0]});
6565         }
6566 elsif ($r eq 'REF') {
6567         $rv = &serialise_variable(${$_[0]});
6568         }
6569 elsif ($r eq 'CODE') {
6570         # Code not handled
6571         $rv = undef;
6572         }
6573 elsif ($r) {
6574         # An object - treat as a hash
6575         $r = "OBJECT ".&urlize($r);
6576         $rv = join(",", map { &urlize(&serialise_variable($_)).",".
6577                               &urlize(&serialise_variable($_[0]->{$_})) }
6578                             keys %{$_[0]});
6579         }
6580 return ($r ? $r : 'VAL').",".$rv;
6581 }
6582
6583 =head2 unserialise_variable(string)
6584
6585 Converts a string created by serialise_variable() back into the original
6586 scalar, hash ref, array ref or scalar ref. If the original variable was a Perl
6587 object, the same class is used on this system, if available.
6588
6589 =cut
6590 sub unserialise_variable
6591 {
6592 my @v = split(/,/, $_[0]);
6593 my $rv;
6594 if ($v[0] eq 'VAL') {
6595         @v = split(/,/, $_[0], -1);
6596         $rv = &un_urlize($v[1]);
6597         }
6598 elsif ($v[0] eq 'SCALAR') {
6599         local $r = &un_urlize($v[1]);
6600         $rv = \$r;
6601         }
6602 elsif ($v[0] eq 'ARRAY') {
6603         $rv = [ ];
6604         for(my $i=1; $i<@v; $i++) {
6605                 push(@$rv, &unserialise_variable(&un_urlize($v[$i])));
6606                 }
6607         }
6608 elsif ($v[0] eq 'HASH') {
6609         $rv = { };
6610         for(my $i=1; $i<@v; $i+=2) {
6611                 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6612                         &unserialise_variable(&un_urlize($v[$i+1]));
6613                 }
6614         }
6615 elsif ($v[0] eq 'REF') {
6616         local $r = &unserialise_variable($v[1]);
6617         $rv = \$r;
6618         }
6619 elsif ($v[0] eq 'UNDEF') {
6620         $rv = undef;
6621         }
6622 elsif ($v[0] =~ /^OBJECT\s+(.*)$/) {
6623         # An object hash that we have to re-bless
6624         my $cls = $1;
6625         $rv = { };
6626         for(my $i=1; $i<@v; $i+=2) {
6627                 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6628                         &unserialise_variable(&un_urlize($v[$i+1]));
6629                 }
6630         eval "use $cls";
6631         bless $rv, $cls;
6632         }
6633 return $rv;
6634 }
6635
6636 =head2 other_groups(user)
6637
6638 Returns a list of secondary groups a user is a member of, as a list of
6639 group names.
6640
6641 =cut
6642 sub other_groups
6643 {
6644 my ($user) = @_;
6645 my @rv;
6646 setgrent();
6647 while(my @g = getgrent()) {
6648         my @m = split(/\s+/, $g[3]);
6649         push(@rv, $g[2]) if (&indexof($user, @m) >= 0);
6650         }
6651 endgrent() if ($gconfig{'os_type'} ne 'hpux');
6652 return @rv;
6653 }
6654
6655 =head2 date_chooser_button(dayfield, monthfield, yearfield)
6656
6657 Returns HTML for a button that pops up a data chooser window. The parameters
6658 are :
6659
6660 =item dayfield - Name of the text field to place the day of the month into.
6661
6662 =item monthfield - Name of the select field to select the month of the year in, indexed from 1.
6663
6664 =item yearfield - Name of the text field to place the year into.
6665
6666 =cut
6667 sub date_chooser_button
6668 {
6669 return &theme_date_chooser_button(@_)
6670         if (defined(&theme_date_chooser_button));
6671 my ($w, $h) = (250, 225);
6672 if ($gconfig{'db_sizedate'}) {
6673         ($w, $h) = split(/x/, $gconfig{'db_sizedate'});
6674         }
6675 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";
6676 }
6677
6678 =head2 help_file(module, file)
6679
6680 Returns the path to a module's help file of some name, typically under the
6681 help directory with a .html extension.
6682
6683 =cut
6684 sub help_file
6685 {
6686 my $mdir = &module_root_directory($_[0]);
6687 my $dir = "$mdir/help";
6688 foreach my $o (@lang_order_list) {
6689         my $lang = "$dir/$_[1].$o.html";
6690         return $lang if (-r $lang);
6691         }
6692 return "$dir/$_[1].html";
6693 }
6694
6695 =head2 seed_random
6696
6697 Seeds the random number generator, if not already done in this script. On Linux
6698 this makes use of the current time, process ID and a read from /dev/urandom.
6699 On other systems, only the current time and process ID are used.
6700
6701 =cut
6702 sub seed_random
6703 {
6704 if (!$main::done_seed_random) {
6705         if (open(RANDOM, "/dev/urandom")) {
6706                 my $buf;
6707                 read(RANDOM, $buf, 4);
6708                 close(RANDOM);
6709                 srand(time() ^ $$ ^ $buf);
6710                 }
6711         else {
6712                 srand(time() ^ $$);
6713                 }
6714         $main::done_seed_random = 1;
6715         }
6716 }
6717
6718 =head2 disk_usage_kb(directory)
6719
6720 Returns the number of kB used by some directory and all subdirs. Implemented
6721 by calling the C<du -k> command.
6722
6723 =cut
6724 sub disk_usage_kb
6725 {
6726 my $dir = &translate_filename($_[0]);
6727 my $out;
6728 my $ex = &execute_command("du -sk ".quotemeta($dir), undef, \$out, undef, 0, 1);
6729 if ($ex) {
6730         &execute_command("du -s ".quotemeta($dir), undef, \$out, undef, 0, 1);
6731         }
6732 return $out =~ /^([0-9]+)/ ? $1 : "???";
6733 }
6734
6735 =head2 recursive_disk_usage(directory, [skip-regexp], [only-regexp])
6736
6737 Returns the number of bytes taken up by all files in some directory and all
6738 sub-directories, by summing up their lengths. The disk_usage_kb is more
6739 reflective of reality, as the filesystem typically pads file sizes to 1k or
6740 4k blocks.
6741
6742 =cut
6743 sub recursive_disk_usage
6744 {
6745 my $dir = &translate_filename($_[0]);
6746 my $skip = $_[1];
6747 my $only = $_[2];
6748 if (-l $dir) {
6749         return 0;
6750         }
6751 elsif (!-d $dir) {
6752         my @st = stat($dir);
6753         return $st[7];
6754         }
6755 else {
6756         my $rv = 0;
6757         opendir(DIR, $dir);
6758         my @files = readdir(DIR);
6759         closedir(DIR);
6760         foreach my $f (@files) {
6761                 next if ($f eq "." || $f eq "..");
6762                 next if ($skip && $f =~ /$skip/);
6763                 next if ($only && $f !~ /$only/);
6764                 $rv += &recursive_disk_usage("$dir/$f", $skip, $only);
6765                 }
6766         return $rv;
6767         }
6768 }
6769
6770 =head2 help_search_link(term, [ section, ... ] )
6771
6772 Returns HTML for a link to the man module for searching local and online
6773 docs for various search terms. The term parameter can either be a single
6774 word like 'bind', or a space-separated list of words. This function is typically
6775 used by modules that want to refer users to additional documentation in man
6776 pages or local system doc files.
6777
6778 =cut
6779 sub help_search_link
6780 {
6781 if (&foreign_available("man") && !$tconfig{'nosearch'}) {
6782         my $for = &urlize(shift(@_));
6783         return "<a href='$gconfig{'webprefix'}/man/search.cgi?".
6784                join("&", map { "section=$_" } @_)."&".
6785                "for=$for&exact=1&check=".&get_module_name()."'>".
6786                $text{'helpsearch'}."</a>\n";
6787         }
6788 else {
6789         return "";
6790         }
6791 }
6792
6793 =head2 make_http_connection(host, port, ssl, method, page, [&headers])
6794
6795 Opens a connection to some HTTP server, maybe through a proxy, and returns
6796 a handle object. The handle can then be used to send additional headers
6797 and read back a response. If anything goes wrong, returns an error string.
6798 The parameters are :
6799
6800 =item host - Hostname or IP address of the webserver to connect to.
6801
6802 =item port - HTTP port number to connect to.
6803
6804 =item ssl - Set to 1 to connect in SSL mode.
6805
6806 =item method - HTTP method, like GET or POST.
6807
6808 =item page - Page to request on the webserver, like /foo/index.html
6809
6810 =item headers - Array ref of additional HTTP headers, each of which is a 2-element array ref.
6811
6812 =cut
6813 sub make_http_connection
6814 {
6815 my ($host, $port, $ssl, $method, $page, $headers) = @_;
6816 my $htxt;
6817 if ($headers) {
6818         foreach my $h (@$headers) {
6819                 $htxt .= $h->[0].": ".$h->[1]."\r\n";
6820                 }
6821         $htxt .= "\r\n";
6822         }
6823 if (&is_readonly_mode()) {
6824         return "HTTP connections not allowed in readonly mode";
6825         }
6826 my $rv = { 'fh' => time().$$ };
6827 if ($ssl) {
6828         # Connect using SSL
6829         eval "use Net::SSLeay";
6830         $@ && return $text{'link_essl'};
6831         eval "Net::SSLeay::SSLeay_add_ssl_algorithms()";
6832         eval "Net::SSLeay::load_error_strings()";
6833         $rv->{'ssl_ctx'} = Net::SSLeay::CTX_new() ||
6834                 return "Failed to create SSL context";
6835         $rv->{'ssl_con'} = Net::SSLeay::new($rv->{'ssl_ctx'}) ||
6836                 return "Failed to create SSL connection";
6837         my $connected;
6838         if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6839             !&no_proxy($host)) {
6840                 # Via proxy
6841                 my $error;
6842                 &open_socket($1, $2, $rv->{'fh'}, \$error);
6843                 if (!$error) {
6844                         # Connected OK
6845                         my $fh = $rv->{'fh'};
6846                         print $fh "CONNECT $host:$port HTTP/1.0\r\n";
6847                         if ($gconfig{'proxy_user'}) {
6848                                 my $auth = &encode_base64(
6849                                    "$gconfig{'proxy_user'}:".
6850                                    "$gconfig{'proxy_pass'}");
6851                                 $auth =~ tr/\r\n//d;
6852                                 print $fh "Proxy-Authorization: Basic $auth\r\n";
6853                                 }
6854                         print $fh "\r\n";
6855                         my $line = <$fh>;
6856                         if ($line =~ /^HTTP(\S+)\s+(\d+)\s+(.*)/) {
6857                                 return "Proxy error : $3" if ($2 != 200);
6858                                 }
6859                         else {
6860                                 return "Proxy error : $line";
6861                                 }
6862                         $line = <$fh>;
6863                         $connected = 1;
6864                         }
6865                 elsif (!$gconfig{'proxy_fallback'}) {
6866                         # Connection to proxy failed - give up
6867                         return $error;
6868                         }
6869                 }
6870         if (!$connected) {
6871                 # Direct connection
6872                 my $error;
6873                 &open_socket($host, $port, $rv->{'fh'}, \$error);
6874                 return $error if ($error);
6875                 }
6876         Net::SSLeay::set_fd($rv->{'ssl_con'}, fileno($rv->{'fh'}));
6877         Net::SSLeay::connect($rv->{'ssl_con'}) ||
6878                 return "SSL connect() failed";
6879         my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6880         Net::SSLeay::write($rv->{'ssl_con'}, $rtxt);
6881         }
6882 else {
6883         # Plain HTTP request
6884         my $connected;
6885         if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6886             !&no_proxy($host)) {
6887                 # Via a proxy
6888                 my $error;
6889                 &open_socket($1, $2, $rv->{'fh'}, \$error);
6890                 if (!$error) {
6891                         # Connected OK
6892                         $connected = 1;
6893                         my $fh = $rv->{'fh'};
6894                         my $rtxt = $method." ".
6895                                    "http://$host:$port$page HTTP/1.0\r\n";
6896                         if ($gconfig{'proxy_user'}) {
6897                                 my $auth = &encode_base64(
6898                                    "$gconfig{'proxy_user'}:".
6899                                    "$gconfig{'proxy_pass'}");
6900                                 $auth =~ tr/\r\n//d;
6901                                 $rtxt .= "Proxy-Authorization: Basic $auth\r\n";
6902                                 }
6903                         $rtxt .= $htxt;
6904                         print $fh $rtxt;
6905                         }
6906                 elsif (!$gconfig{'proxy_fallback'}) {
6907                         return $error;
6908                         }
6909                 }
6910         if (!$connected) {
6911                 # Connecting directly
6912                 my $error;
6913                 &open_socket($host, $port, $rv->{'fh'}, \$error);
6914                 return $error if ($error);
6915                 my $fh = $rv->{'fh'};
6916                 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6917                 print $fh $rtxt;
6918                 }
6919         }
6920 return $rv;
6921 }
6922
6923 =head2 read_http_connection(&handle, [bytes])
6924
6925 Reads either one line or up to the specified number of bytes from the handle,
6926 originally supplied by make_http_connection.
6927
6928 =cut
6929 sub read_http_connection
6930 {
6931 my ($h) = @_;
6932 my $rv;
6933 if ($h->{'ssl_con'}) {
6934         if (!$_[1]) {
6935                 my ($idx, $more);
6936                 while(($idx = index($h->{'buffer'}, "\n")) < 0) {
6937                         # need to read more..
6938                         if (!($more = Net::SSLeay::read($h->{'ssl_con'}))) {
6939                                 # end of the data
6940                                 $rv = $h->{'buffer'};
6941                                 delete($h->{'buffer'});
6942                                 return $rv;
6943                                 }
6944                         $h->{'buffer'} .= $more;
6945                         }
6946                 $rv = substr($h->{'buffer'}, 0, $idx+1);
6947                 $h->{'buffer'} = substr($h->{'buffer'}, $idx+1);
6948                 }
6949         else {
6950                 if (length($h->{'buffer'})) {
6951                         $rv = $h->{'buffer'};
6952                         delete($h->{'buffer'});
6953                         }
6954                 else {
6955                         $rv = Net::SSLeay::read($h->{'ssl_con'}, $_[1]);
6956                         }
6957                 }
6958         }
6959 else {
6960         if ($_[1]) {
6961                 read($h->{'fh'}, $rv, $_[1]) > 0 || return undef;
6962                 }
6963         else {
6964                 my $fh = $h->{'fh'};
6965                 $rv = <$fh>;
6966                 }
6967         }
6968 $rv = undef if ($rv eq "");
6969 return $rv;
6970 }
6971
6972 =head2 write_http_connection(&handle, [data+])
6973
6974 Writes the given data to the given HTTP connection handle.
6975
6976 =cut
6977 sub write_http_connection
6978 {
6979 my $h = shift(@_);
6980 my $fh = $h->{'fh'};
6981 my $allok = 1;
6982 if ($h->{'ssl_ctx'}) {
6983         foreach my $s (@_) {
6984                 my $ok = Net::SSLeay::write($h->{'ssl_con'}, $s);
6985                 $allok = 0 if (!$ok);
6986                 }
6987         }
6988 else {
6989         my $ok = (print $fh @_);
6990         $allok = 0 if (!$ok);
6991         }
6992 return $allok;
6993 }
6994
6995 =head2 close_http_connection(&handle)
6996
6997 Closes a connection to an HTTP server, identified by the given handle.
6998
6999 =cut
7000 sub close_http_connection
7001 {
7002 my ($h) = @_;
7003 close($h->{'fh'});
7004 }
7005
7006 =head2 clean_environment
7007
7008 Deletes any environment variables inherited from miniserv so that they
7009 won't be passed to programs started by webmin. This is useful when calling
7010 programs that check for CGI-related environment variables and modify their
7011 behaviour, and to avoid passing sensitive variables to un-trusted programs.
7012
7013 =cut
7014 sub clean_environment
7015 {
7016 %UNCLEAN_ENV = %ENV;
7017 foreach my $k (keys %ENV) {
7018         if ($k =~ /^(HTTP|VIRTUALSERVER|QUOTA|USERADMIN)_/) {
7019                 delete($ENV{$k});
7020                 }
7021         }
7022 foreach my $e ('WEBMIN_CONFIG', 'SERVER_NAME', 'CONTENT_TYPE', 'REQUEST_URI',
7023             'PATH_INFO', 'WEBMIN_VAR', 'REQUEST_METHOD', 'GATEWAY_INTERFACE',
7024             'QUERY_STRING', 'REMOTE_USER', 'SERVER_SOFTWARE', 'SERVER_PROTOCOL',
7025             'REMOTE_HOST', 'SERVER_PORT', 'DOCUMENT_ROOT', 'SERVER_ROOT',
7026             'MINISERV_CONFIG', 'SCRIPT_NAME', 'SERVER_ADMIN', 'CONTENT_LENGTH',
7027             'HTTPS', 'FOREIGN_MODULE_NAME', 'FOREIGN_ROOT_DIRECTORY',
7028             'SCRIPT_FILENAME', 'PATH_TRANSLATED', 'BASE_REMOTE_USER',
7029             'DOCUMENT_REALROOT', 'MINISERV_CONFIG', 'MYSQL_PWD',
7030             'MINISERV_PID') {
7031         delete($ENV{$e});
7032         }
7033 }
7034
7035 =head2 reset_environment
7036
7037 Puts the environment back how it was before clean_environment was callled.
7038
7039 =cut
7040 sub reset_environment
7041 {
7042 if (%UNCLEAN_ENV) {
7043         foreach my $k (keys %UNCLEAN_ENV) {
7044                 $ENV{$k} = $UNCLEAN_ENV{$k};
7045                 }
7046         undef(%UNCLEAN_ENV);
7047         }
7048 }
7049
7050 =head2 progress_callback
7051
7052 Never called directly, but useful for passing to &http_download to print
7053 out progress of an HTTP request.
7054
7055 =cut
7056 sub progress_callback
7057 {
7058 if (defined(&theme_progress_callback)) {
7059         # Call the theme override
7060         return &theme_progress_callback(@_);
7061         }
7062 if ($_[0] == 2) {
7063         # Got size
7064         print $progress_callback_prefix;
7065         if ($_[1]) {
7066                 $progress_size = $_[1];
7067                 $progress_step = int($_[1] / 10);
7068                 print &text('progress_size2', $progress_callback_url,
7069                             &nice_size($progress_size)),"<br>\n";
7070                 }
7071         else {
7072                 $progress_size = undef;
7073                 print &text('progress_nosize', $progress_callback_url),"<br>\n";
7074                 }
7075         $last_progress_time = $last_progress_size = undef;
7076         }
7077 elsif ($_[0] == 3) {
7078         # Got data update
7079         my $sp = $progress_callback_prefix.("&nbsp;" x 5);
7080         if ($progress_size) {
7081                 # And we have a size to compare against
7082                 my $st = int(($_[1] * 10) / $progress_size);
7083                 my $time_now = time();
7084                 if ($st != $progress_step ||
7085                     $time_now - $last_progress_time > 60) {
7086                         # Show progress every 10% or 60 seconds
7087                         print $sp,&text('progress_datan', &nice_size($_[1]),
7088                                         int($_[1]*100/$progress_size)),"<br>\n";
7089                         $last_progress_time = $time_now;
7090                         }
7091                 $progress_step = $st;
7092                 }
7093         else {
7094                 # No total size .. so only show in 100k jumps
7095                 if ($_[1] > $last_progress_size+100*1024) {
7096                         print $sp,&text('progress_data2n',
7097                                         &nice_size($_[1])),"<br>\n";
7098                         $last_progress_size = $_[1];
7099                         }
7100                 }
7101         }
7102 elsif ($_[0] == 4) {
7103         # All done downloading
7104         print $progress_callback_prefix,&text('progress_done'),"<br>\n";
7105         }
7106 elsif ($_[0] == 5) {
7107         # Got new location after redirect
7108         $progress_callback_url = $_[1];
7109         }
7110 elsif ($_[0] == 6) {
7111         # URL is in cache
7112         $progress_callback_url = $_[1];
7113         print &text('progress_incache', $progress_callback_url),"<br>\n";
7114         }
7115 }
7116
7117 =head2 switch_to_remote_user
7118
7119 Changes the user and group of the current process to that of the unix user
7120 with the same name as the current webmin login, or fails if there is none.
7121 This should be called by Usermin module scripts that only need to run with
7122 limited permissions.
7123
7124 =cut
7125 sub switch_to_remote_user
7126 {
7127 @remote_user_info = $remote_user ? getpwnam($remote_user) :
7128                                    getpwuid($<);
7129 @remote_user_info || &error(&text('switch_remote_euser', $remote_user));
7130 &create_missing_homedir(\@remote_user_info);
7131 if ($< == 0) {
7132         &switch_to_unix_user(\@remote_user_info);
7133         $ENV{'USER'} = $ENV{'LOGNAME'} = $remote_user;
7134         $ENV{'HOME'} = $remote_user_info[7];
7135         }
7136 # Export global variables to caller
7137 if ($main::export_to_caller) {
7138         my ($callpkg) = caller();
7139         eval "\@${callpkg}::remote_user_info = \@remote_user_info";
7140         }
7141 }
7142
7143 =head2 switch_to_unix_user(&user-details)
7144
7145 Switches the current process to the UID and group ID from the given list
7146 of user details, which must be in the format returned by getpwnam.
7147
7148 =cut
7149 sub switch_to_unix_user
7150 {
7151 my ($uinfo) = @_;
7152 if (!defined($uinfo->[0])) {
7153         # No username given, so just use given GID
7154         ($(, $)) = ( $uinfo->[3], "$uinfo->[3] $uinfo->[3]" );
7155         }
7156 else {
7157         # Use all groups from user
7158         ($(, $)) = ( $uinfo->[3],
7159                      "$uinfo->[3] ".join(" ", $uinfo->[3],
7160                                          &other_groups($uinfo->[0])) );
7161         }
7162 eval {
7163         POSIX::setuid($uinfo->[2]);
7164         };
7165 if ($< != $uinfo->[2] || $> != $uinfo->[2]) {
7166         ($>, $<) = ( $uinfo->[2], $uinfo->[2] );
7167         }
7168 }
7169
7170 =head2 eval_as_unix_user(username, &code)
7171
7172 Runs some code fragment with the effective UID and GID switch to that
7173 of the given Unix user, so that file IO takes place with his permissions.
7174
7175 =cut
7176
7177 sub eval_as_unix_user
7178 {
7179 my ($user, $code) = @_;
7180 my @uinfo = getpwnam($user);
7181 if (!scalar(@uinfo)) {
7182         &error("eval_as_unix_user called with invalid user $user");
7183         }
7184 $) = $uinfo[3]." ".join(" ", $uinfo[3], &other_groups($user));
7185 $> = $uinfo[2];
7186 my @rv;
7187 eval {
7188         local $main::error_must_die = 1;
7189         @rv = &$code();
7190         };
7191 my $err = $@;
7192 $) = 0;
7193 $> = 0;
7194 if ($err) {
7195         $err =~ s/\s+at\s+(\/\S+)\s+line\s+(\d+)\.?//;
7196         &error($err);
7197         }
7198 return wantarray ? @rv : $rv[0];
7199 }
7200
7201 =head2 create_user_config_dirs
7202
7203 Creates per-user config directories and sets $user_config_directory and
7204 $user_module_config_directory to them. Also reads per-user module configs
7205 into %userconfig. This should be called by Usermin module scripts that need
7206 to store per-user preferences or other settings.
7207
7208 =cut
7209 sub create_user_config_dirs
7210 {
7211 return if (!$gconfig{'userconfig'});
7212 my @uinfo = @remote_user_info ? @remote_user_info : getpwnam($remote_user);
7213 return if (!@uinfo || !$uinfo[7]);
7214 &create_missing_homedir(\@uinfo);
7215 $user_config_directory = "$uinfo[7]/$gconfig{'userconfig'}";
7216 if (!-d $user_config_directory) {
7217         mkdir($user_config_directory, 0700) ||
7218                 &error("Failed to create $user_config_directory : $!");
7219         if ($< == 0 && $uinfo[2]) {
7220                 chown($uinfo[2], $uinfo[3], $user_config_directory);
7221                 }
7222         }
7223 if (&get_module_name()) {
7224         $user_module_config_directory = $user_config_directory."/".
7225                                         &get_module_name();
7226         if (!-d $user_module_config_directory) {
7227                 mkdir($user_module_config_directory, 0700) ||
7228                         &error("Failed to create $user_module_config_directory : $!");
7229                 if ($< == 0 && $uinfo[2]) {
7230                         chown($uinfo[2], $uinfo[3], $user_config_directory);
7231                         }
7232                 }
7233         undef(%userconfig);
7234         &read_file_cached("$module_root_directory/defaultuconfig",
7235                           \%userconfig);
7236         &read_file_cached("$module_config_directory/uconfig", \%userconfig);
7237         &read_file_cached("$user_module_config_directory/config",
7238                           \%userconfig);
7239         }
7240
7241 # Export global variables to caller
7242 if ($main::export_to_caller) {
7243         my ($callpkg) = caller();
7244         foreach my $v ('$user_config_directory',
7245                        '$user_module_config_directory', '%userconfig') {
7246                 my ($vt, $vn) = split('', $v, 2);
7247                 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
7248                 }
7249         }
7250 }
7251
7252 =head2 create_missing_homedir(&uinfo)
7253
7254 If auto homedir creation is enabled, create one for this user if needed.
7255 For internal use only.
7256
7257 =cut
7258 sub create_missing_homedir
7259 {
7260 my ($uinfo) = @_;
7261 if (!-e $uinfo->[7] && $gconfig{'create_homedir'}) {
7262         # Use has no home dir .. make one
7263         system("mkdir -p ".quotemeta($uinfo->[7]));
7264         chown($uinfo->[2], $uinfo->[3], $uinfo->[7]);
7265         if ($gconfig{'create_homedir_perms'} ne '') {
7266                 chmod(oct($gconfig{'create_homedir_perms'}), $uinfo->[7]);
7267                 }
7268         }
7269 }
7270
7271 =head2 filter_javascript(text)
7272
7273 Disables all javascript <script>, onClick= and so on tags in the given HTML,
7274 and returns the new HTML. Useful for displaying HTML from an un-trusted source.
7275
7276 =cut
7277 sub filter_javascript
7278 {
7279 my ($rv) = @_;
7280 $rv =~ s/<\s*script[^>]*>([\000-\377]*?)<\s*\/script\s*>//gi;
7281 $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;
7282 $rv =~ s/(javascript:)/x$1/gi;
7283 $rv =~ s/(vbscript:)/x$1/gi;
7284 return $rv;
7285 }
7286
7287 =head2 resolve_links(path)
7288
7289 Given a path that may contain symbolic links, returns the real path.
7290
7291 =cut
7292 sub resolve_links
7293 {
7294 my ($path) = @_;
7295 $path =~ s/\/+/\//g;
7296 $path =~ s/\/$// if ($path ne "/");
7297 my @p = split(/\/+/, $path);
7298 shift(@p);
7299 for(my $i=0; $i<@p; $i++) {
7300         my $sofar = "/".join("/", @p[0..$i]);
7301         my $lnk = readlink($sofar);
7302         if ($lnk eq $sofar) {
7303                 # Link to itself! Cannot do anything more really ..
7304                 last;
7305                 }
7306         elsif ($lnk =~ /^\//) {
7307                 # Link is absolute..
7308                 return &resolve_links($lnk."/".join("/", @p[$i+1 .. $#p]));
7309                 }
7310         elsif ($lnk) {
7311                 # Link is relative
7312                 return &resolve_links("/".join("/", @p[0..$i-1])."/".$lnk."/".join("/", @p[$i+1 .. $#p]));
7313                 }
7314         }
7315 return $path;
7316 }
7317
7318 =head2 simplify_path(path, bogus)
7319
7320 Given a path, maybe containing elements ".." and "." , convert it to a
7321 clean, absolute form. Returns undef if this is not possible.
7322
7323 =cut
7324 sub simplify_path
7325 {
7326 my ($dir) = @_;
7327 $dir =~ s/^\/+//g;
7328 $dir =~ s/\/+$//g;
7329 my @bits = split(/\/+/, $dir);
7330 my @fixedbits = ();
7331 $_[1] = 0;
7332 foreach my $b (@bits) {
7333         if ($b eq ".") {
7334                 # Do nothing..
7335                 }
7336         elsif ($b eq "..") {
7337                 # Remove last dir
7338                 if (scalar(@fixedbits) == 0) {
7339                         # Cannot! Already at root!
7340                         return undef;
7341                         }
7342                 pop(@fixedbits);
7343                 }
7344         else {
7345                 # Add dir to list
7346                 push(@fixedbits, $b);
7347                 }
7348         }
7349 return "/".join('/', @fixedbits);
7350 }
7351
7352 =head2 same_file(file1, file2)
7353
7354 Returns 1 if two files are actually the same
7355
7356 =cut
7357 sub same_file
7358 {
7359 return 1 if ($_[0] eq $_[1]);
7360 return 0 if ($_[0] !~ /^\// || $_[1] !~ /^\//);
7361 my @stat1 = $stat_cache{$_[0]} ? @{$stat_cache{$_[0]}}
7362                                : (@{$stat_cache{$_[0]}} = stat($_[0]));
7363 my @stat2 = $stat_cache{$_[1]} ? @{$stat_cache{$_[1]}}
7364                                : (@{$stat_cache{$_[1]}} = stat($_[1]));
7365 return 0 if (!@stat1 || !@stat2);
7366 return $stat1[0] == $stat2[0] && $stat1[1] == $stat2[1];
7367 }
7368
7369 =head2 flush_webmin_caches
7370
7371 Clears all in-memory and on-disk caches used by Webmin.
7372
7373 =cut
7374 sub flush_webmin_caches
7375 {
7376 undef(%main::read_file_cache);
7377 undef(%main::acl_hash_cache);
7378 undef(%main::acl_array_cache);
7379 undef(%main::has_command_cache);
7380 undef(@main::list_languages_cache);
7381 undef($main::got_list_usermods_cache);
7382 undef(@main::list_usermods_cache);
7383 undef(%main::foreign_installed_cache);
7384 unlink("$config_directory/module.infos.cache");
7385 &get_all_module_infos();
7386 }
7387
7388 =head2 list_usermods
7389
7390 Returns a list of additional module restrictions. For internal use in
7391 Usermin only.
7392
7393 =cut
7394 sub list_usermods
7395 {
7396 if (!$main::got_list_usermods_cache) {
7397         @main::list_usermods_cache = ( );
7398         local $_;
7399         open(USERMODS, "$config_directory/usermin.mods");
7400         while(<USERMODS>) {
7401                 if (/^([^:]+):(\+|-|):(.*)/) {
7402                         push(@main::list_usermods_cache,
7403                              [ $1, $2, [ split(/\s+/, $3) ] ]);
7404                         }
7405                 }
7406         close(USERMODS);
7407         $main::got_list_usermods_cache = 1;
7408         }
7409 return @main::list_usermods_cache;
7410 }
7411
7412 =head2 available_usermods(&allmods, &usermods)
7413
7414 Returns a list of modules that are available to the given user, based
7415 on usermod additional/subtractions. For internal use by Usermin only.
7416
7417 =cut
7418 sub available_usermods
7419 {
7420 return @{$_[0]} if (!@{$_[1]});
7421
7422 my %mods = map { $_->{'dir'}, 1 } @{$_[0]};
7423 my @uinfo = @remote_user_info;
7424 @uinfo = getpwnam($remote_user) if (!@uinfo);
7425 foreach my $u (@{$_[1]}) {
7426         my $applies;
7427         if ($u->[0] eq "*" || $u->[0] eq $remote_user) {
7428                 $applies++;
7429                 }
7430         elsif ($u->[0] =~ /^\@(.*)$/) {
7431                 # Check for group membership
7432                 my @ginfo = getgrnam($1);
7433                 $applies++ if (@ginfo && ($ginfo[2] == $uinfo[3] ||
7434                         &indexof($remote_user, split(/\s+/, $ginfo[3])) >= 0));
7435                 }
7436         elsif ($u->[0] =~ /^\//) {
7437                 # Check users and groups in file
7438                 local $_;
7439                 open(USERFILE, $u->[0]);
7440                 while(<USERFILE>) {
7441                         tr/\r\n//d;
7442                         if ($_ eq $remote_user) {
7443                                 $applies++;
7444                                 }
7445                         elsif (/^\@(.*)$/) {
7446                                 my @ginfo = getgrnam($1);
7447                                 $applies++
7448                                   if (@ginfo && ($ginfo[2] == $uinfo[3] ||
7449                                       &indexof($remote_user,
7450                                                split(/\s+/, $ginfo[3])) >= 0));
7451                                 }
7452                         last if ($applies);
7453                         }
7454                 close(USERFILE);
7455                 }
7456         if ($applies) {
7457                 if ($u->[1] eq "+") {
7458                         map { $mods{$_}++ } @{$u->[2]};
7459                         }
7460                 elsif ($u->[1] eq "-") {
7461                         map { delete($mods{$_}) } @{$u->[2]};
7462                         }
7463                 else {
7464                         undef(%mods);
7465                         map { $mods{$_}++ } @{$u->[2]};
7466                         }
7467                 }
7468         }
7469 return grep { $mods{$_->{'dir'}} } @{$_[0]};
7470 }
7471
7472 =head2 get_available_module_infos(nocache)
7473
7474 Returns a list of modules available to the current user, based on
7475 operating system support, access control and usermod restrictions. Useful
7476 in themes that need to display a list of modules the user can use.
7477 Each element of the returned array is a hash reference in the same format as
7478 returned by get_module_info.
7479
7480 =cut
7481 sub get_available_module_infos
7482 {
7483 my (%acl, %uacl);
7484 &read_acl(\%acl, \%uacl, [ $base_remote_user ]);
7485 my $risk = $gconfig{'risk_'.$base_remote_user};
7486 my @rv;
7487 foreach my $minfo (&get_all_module_infos($_[0])) {
7488         next if (!&check_os_support($minfo));
7489         if ($risk) {
7490                 # Check module risk level
7491                 next if ($risk ne 'high' && $minfo->{'risk'} &&
7492                          $minfo->{'risk'} !~ /$risk/);
7493                 }
7494         else {
7495                 # Check user's ACL
7496                 next if (!$acl{$base_remote_user,$minfo->{'dir'}} &&
7497                          !$acl{$base_remote_user,"*"});
7498                 }
7499         next if (&is_readonly_mode() && !$minfo->{'readonly'});
7500         push(@rv, $minfo);
7501         }
7502
7503 # Check usermod restrictions
7504 my @usermods = &list_usermods();
7505 @rv = sort { $a->{'desc'} cmp $b->{'desc'} }
7506             &available_usermods(\@rv, \@usermods);
7507
7508 # Check RBAC restrictions
7509 my @rbacrv;
7510 foreach my $m (@rv) {
7511         if (&supports_rbac($m->{'dir'}) &&
7512             &use_rbac_module_acl(undef, $m->{'dir'})) {
7513                 local $rbacs = &get_rbac_module_acl($remote_user,
7514                                                     $m->{'dir'});
7515                 if ($rbacs) {
7516                         # RBAC allows
7517                         push(@rbacrv, $m);
7518                         }
7519                 }
7520         else {
7521                 # Module or system doesn't support RBAC
7522                 push(@rbacrv, $m) if (!$gconfig{'rbacdeny_'.$base_remote_user});
7523                 }
7524         }
7525
7526 # Check theme vetos
7527 my @themerv;
7528 if (defined(&theme_foreign_available)) {
7529         foreach my $m (@rbacrv) {
7530                 if (&theme_foreign_available($m->{'dir'})) {
7531                         push(@themerv, $m);
7532                         }
7533                 }
7534         }
7535 else {
7536         @themerv = @rbacrv;
7537         }
7538
7539 # Check licence module vetos
7540 my @licrv;
7541 if ($main::licence_module) {
7542         foreach my $m (@themerv) {
7543                 if (&foreign_call($main::licence_module,
7544                                   "check_module_licence", $m->{'dir'})) {
7545                         push(@licrv, $m);
7546                         }
7547                 }
7548         }
7549 else {
7550         @licrv = @themerv;
7551         }
7552
7553 return @licrv;
7554 }
7555
7556 =head2 get_visible_module_infos(nocache)
7557
7558 Like get_available_module_infos, but excludes hidden modules from the list.
7559 Each element of the returned array is a hash reference in the same format as
7560 returned by get_module_info.
7561
7562 =cut
7563 sub get_visible_module_infos
7564 {
7565 my ($nocache) = @_;
7566 my $pn = &get_product_name();
7567 return grep { !$_->{'hidden'} &&
7568               !$_->{$pn.'_hidden'} } &get_available_module_infos($nocache);
7569 }
7570
7571 =head2 get_visible_modules_categories(nocache)
7572
7573 Returns a list of Webmin module categories, each of which is a hash ref
7574 with 'code', 'desc' and 'modules' keys. The modules value is an array ref
7575 of modules in the category, in the format returned by get_module_info.
7576 Un-used modules are automatically assigned to the 'unused' category, and
7577 those with no category are put into 'others'.
7578
7579 =cut
7580 sub get_visible_modules_categories
7581 {
7582 my ($nocache) = @_;
7583 my @mods = &get_visible_module_infos($nocache);
7584 my @unmods;
7585 if (&get_product_name() eq 'webmin') {
7586         @unmods = grep { $_->{'installed'} eq '0' } @mods;
7587         @mods = grep { $_->{'installed'} ne '0' } @mods;
7588         }
7589 my %cats = &list_categories(\@mods);
7590 my @rv;
7591 foreach my $c (keys %cats) {
7592         my $cat = { 'code' => $c || 'other',
7593                     'desc' => $cats{$c} };
7594         $cat->{'modules'} = [ grep { $_->{'category'} eq $c } @mods ];
7595         push(@rv, $cat);
7596         }
7597 @rv = sort { ($b->{'code'} eq "others" ? "" : $b->{'code'}) cmp
7598              ($a->{'code'} eq "others" ? "" : $a->{'code'}) } @rv;
7599 if (@unmods) {
7600         # Add un-installed modules in magic category
7601         my $cat = { 'code' => 'unused',
7602                     'desc' => $text{'main_unused'},
7603                     'unused' => 1,
7604                     'modules' => \@unmods };
7605         push(@rv, $cat);
7606         }
7607 return @rv;
7608 }
7609
7610 =head2 is_under_directory(directory, file)
7611
7612 Returns 1 if the given file is under the specified directory, 0 if not.
7613 Symlinks are taken into account in the file to find it's 'real' location.
7614
7615 =cut
7616 sub is_under_directory
7617 {
7618 my ($dir, $file) = @_;
7619 return 1 if ($dir eq "/");
7620 return 0 if ($file =~ /\.\./);
7621 my $ld = &resolve_links($dir);
7622 if ($ld ne $dir) {
7623         return &is_under_directory($ld, $file);
7624         }
7625 my $lp = &resolve_links($file);
7626 if ($lp ne $file) {
7627         return &is_under_directory($dir, $lp);
7628         }
7629 return 0 if (length($file) < length($dir));
7630 return 1 if ($dir eq $file);
7631 $dir =~ s/\/*$/\//;
7632 return substr($file, 0, length($dir)) eq $dir;
7633 }
7634
7635 =head2 parse_http_url(url, [basehost, baseport, basepage, basessl])
7636
7637 Given an absolute URL, returns the host, port, page and ssl flag components.
7638 If a username and password are given before the hostname, return those too.
7639 Relative URLs can also be parsed, if the base information is provided.
7640
7641 =cut
7642 sub parse_http_url
7643 {
7644 if ($_[0] =~ /^(http|https):\/\/([^\@]+\@)?\[([^\]]+)\](:(\d+))?(\/\S*)?$/ ||
7645     $_[0] =~ /^(http|https):\/\/([^\@]+\@)?([^:\/]+)(:(\d+))?(\/\S*)?$/) {
7646         # An absolute URL
7647         my $ssl = $1 eq 'https';
7648         my @rv = ($3, $4 ? $5 : $ssl ? 443 : 80, $6 || "/", $ssl);
7649         if ($2 =~ /^([^:]+):(\S+)\@/) {
7650                 push(@rv, $1, $2);
7651                 }
7652         return @rv;
7653         }
7654 elsif (!$_[1]) {
7655         # Could not parse
7656         return undef;
7657         }
7658 elsif ($_[0] =~ /^\/\S*$/) {
7659         # A relative to the server URL
7660         return ($_[1], $_[2], $_[0], $_[4], $_[5], $_[6]);
7661         }
7662 else {
7663         # A relative to the directory URL
7664         my $page = $_[3];
7665         $page =~ s/[^\/]+$//;
7666         return ($_[1], $_[2], $page.$_[0], $_[4], $_[5], $_[6]);
7667         }
7668 }
7669
7670 =head2 check_clicks_function
7671
7672 Returns HTML for a JavaScript function called check_clicks that returns
7673 true when first called, but false subsequently. Useful on onClick for
7674 critical buttons. Deprecated, as this method of preventing duplicate actions
7675 is un-reliable.
7676
7677 =cut
7678 sub check_clicks_function
7679 {
7680 return <<EOF;
7681 <script>
7682 clicks = 0;
7683 function check_clicks(form)
7684 {
7685 clicks++;
7686 if (clicks == 1)
7687         return true;
7688 else {
7689         if (form != null) {
7690                 for(i=0; i<form.length; i++)
7691                         form.elements[i].disabled = true;
7692                 }
7693         return false;
7694         }
7695 }
7696 </script>
7697 EOF
7698 }
7699
7700 =head2 load_entities_map
7701
7702 Returns a hash ref containing mappings between HTML entities (like ouml) and
7703 ascii values (like 246). Mainly for internal use.
7704
7705 =cut
7706 sub load_entities_map
7707 {
7708 if (!%entities_map_cache) {
7709         local $_;
7710         open(EMAP, "$root_directory/entities_map.txt");
7711         while(<EMAP>) {
7712                 if (/^(\d+)\s+(\S+)/) {
7713                         $entities_map_cache{$2} = $1;
7714                         }
7715                 }
7716         close(EMAP);
7717         }
7718 return \%entities_map_cache;
7719 }
7720
7721 =head2 entities_to_ascii(string)
7722
7723 Given a string containing HTML entities like &ouml; and &#55;, replace them
7724 with their ASCII equivalents.
7725
7726 =cut
7727 sub entities_to_ascii
7728 {
7729 my ($str) = @_;
7730 my $emap = &load_entities_map();
7731 $str =~ s/&([a-z]+);/chr($emap->{$1})/ge;
7732 $str =~ s/&#(\d+);/chr($1)/ge;
7733 return $str;
7734 }
7735
7736 =head2 get_product_name
7737
7738 Returns either 'webmin' or 'usermin', depending on which program the current
7739 module is in. Useful for modules that can be installed into either.
7740
7741 =cut
7742 sub get_product_name
7743 {
7744 return $gconfig{'product'} if (defined($gconfig{'product'}));
7745 return defined($gconfig{'userconfig'}) ? 'usermin' : 'webmin';
7746 }
7747
7748 =head2 get_charset
7749
7750 Returns the character set for the current language, such as iso-8859-1.
7751
7752 =cut
7753 sub get_charset
7754 {
7755 my $charset = defined($gconfig{'charset'}) ? $gconfig{'charset'} :
7756                  $current_lang_info->{'charset'} ?
7757                  $current_lang_info->{'charset'} : $default_charset;
7758 return $charset;
7759 }
7760
7761 =head2 get_display_hostname
7762
7763 Returns the system's hostname for UI display purposes. This may be different
7764 from the actual hostname if you administrator has configured it so in the
7765 Webmin Configuration module.
7766
7767 =cut
7768 sub get_display_hostname
7769 {
7770 if ($gconfig{'hostnamemode'} == 0) {
7771         return &get_system_hostname();
7772         }
7773 elsif ($gconfig{'hostnamemode'} == 3) {
7774         return $gconfig{'hostnamedisplay'};
7775         }
7776 else {
7777         my $h = $ENV{'HTTP_HOST'};
7778         $h =~ s/:\d+//g;
7779         if ($gconfig{'hostnamemode'} == 2) {
7780                 $h =~ s/^(www|ftp|mail)\.//i;
7781                 }
7782         return $h;
7783         }
7784 }
7785
7786 =head2 save_module_config([&config], [modulename])
7787
7788 Saves the configuration for some module. The config parameter is an optional
7789 hash reference of names and values to save, which defaults to the global
7790 %config hash. The modulename parameter is the module to update the config
7791 file, which defaults to the current module.
7792
7793 =cut
7794 sub save_module_config
7795 {
7796 my $c = $_[0] || { &get_module_variable('%config') };
7797 my $m = defined($_[1]) ? $_[1] : &get_module_name();
7798 &write_file("$config_directory/$m/config", $c);
7799 }
7800
7801 =head2 save_user_module_config([&config], [modulename])
7802
7803 Saves the user's Usermin preferences for some module. The config parameter is
7804 an optional hash reference of names and values to save, which defaults to the
7805 global %userconfig hash. The modulename parameter is the module to update the
7806 config file, which defaults to the current module.
7807
7808 =cut
7809 sub save_user_module_config
7810 {
7811 my $c = $_[0] || { &get_module_variable('%userconfig') };
7812 my $m = $_[1] || &get_module_name();
7813 my $ucd = $user_config_directory;
7814 if (!$ucd) {
7815         my @uinfo = @remote_user_info ? @remote_user_info
7816                                       : getpwnam($remote_user);
7817         return if (!@uinfo || !$uinfo[7]);
7818         $ucd = "$uinfo[7]/$gconfig{'userconfig'}";
7819         }
7820 &write_file("$ucd/$m/config", $c);
7821 }
7822
7823 =head2 nice_size(bytes, [min])
7824
7825 Converts a number of bytes into a number followed by a suffix like GB, MB
7826 or kB. Rounding is to two decimal digits. The optional min parameter sets the
7827 smallest units to use - so you could pass 1024*1024 to never show bytes or kB.
7828
7829 =cut
7830 sub nice_size
7831 {
7832 my ($units, $uname);
7833 if (abs($_[0]) > 1024*1024*1024*1024 || $_[1] >= 1024*1024*1024*1024) {
7834         $units = 1024*1024*1024*1024;
7835         $uname = "TB";
7836         }
7837 elsif (abs($_[0]) > 1024*1024*1024 || $_[1] >= 1024*1024*1024) {
7838         $units = 1024*1024*1024;
7839         $uname = "GB";
7840         }
7841 elsif (abs($_[0]) > 1024*1024 || $_[1] >= 1024*1024) {
7842         $units = 1024*1024;
7843         $uname = "MB";
7844         }
7845 elsif (abs($_[0]) > 1024 || $_[1] >= 1024) {
7846         $units = 1024;
7847         $uname = "kB";
7848         }
7849 else {
7850         $units = 1;
7851         $uname = "bytes";
7852         }
7853 my $sz = sprintf("%.2f", ($_[0]*1.0 / $units));
7854 $sz =~ s/\.00$//;
7855 return $sz." ".$uname;
7856 }
7857
7858 =head2 get_perl_path
7859
7860 Returns the path to Perl currently in use, such as /usr/bin/perl.
7861
7862 =cut
7863 sub get_perl_path
7864 {
7865 if (open(PERL, "$config_directory/perl-path")) {
7866         my $rv;
7867         chop($rv = <PERL>);
7868         close(PERL);
7869         return $rv;
7870         }
7871 return $^X if (-x $^X);
7872 return &has_command("perl");
7873 }
7874
7875 =head2 get_goto_module([&mods])
7876
7877 Returns the details of a module that the current user should be re-directed
7878 to after logging in, or undef if none. Useful for themes.
7879
7880 =cut
7881 sub get_goto_module
7882 {
7883 my @mods = $_[0] ? @{$_[0]} : &get_visible_module_infos();
7884 if ($gconfig{'gotomodule'}) {
7885         my ($goto) = grep { $_->{'dir'} eq $gconfig{'gotomodule'} } @mods;
7886         return $goto if ($goto);
7887         }
7888 if (@mods == 1 && $gconfig{'gotoone'}) {
7889         return $mods[0];
7890         }
7891 return undef;
7892 }
7893
7894 =head2 select_all_link(field, form, [text])
7895
7896 Returns HTML for a 'Select all' link that uses Javascript to select
7897 multiple checkboxes with the same name. The parameters are :
7898
7899 =item field - Name of the checkbox inputs.
7900
7901 =item form - Index of the form on the page.
7902
7903 =item text - Message for the link, defaulting to 'Select all'.
7904
7905 =cut
7906 sub select_all_link
7907 {
7908 return &theme_select_all_link(@_) if (defined(&theme_select_all_link));
7909 my ($field, $form, $text) = @_;
7910 $form = int($form);
7911 $text ||= $text{'ui_selall'};
7912 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>";
7913 }
7914
7915 =head2 select_invert_link(field, form, text)
7916
7917 Returns HTML for an 'Invert selection' link that uses Javascript to invert the
7918 selection on multiple checkboxes with the same name. The parameters are :
7919
7920 =item field - Name of the checkbox inputs.
7921
7922 =item form - Index of the form on the page.
7923
7924 =item text - Message for the link, defaulting to 'Invert selection'.
7925
7926 =cut
7927 sub select_invert_link
7928 {
7929 return &theme_select_invert_link(@_) if (defined(&theme_select_invert_link));
7930 my ($field, $form, $text) = @_;
7931 $form = int($form);
7932 $text ||= $text{'ui_selinv'};
7933 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>";
7934 }
7935
7936 =head2 select_rows_link(field, form, text, &rows)
7937
7938 Returns HTML for a link that uses Javascript to select rows with particular
7939 values for their checkboxes. The parameters are :
7940
7941 =item field - Name of the checkbox inputs.
7942
7943 =item form - Index of the form on the page.
7944
7945 =item text - Message for the link, de
7946
7947 =item rows - Reference to an array of 1 or 0 values, indicating which rows to check.
7948
7949 =cut
7950 sub select_rows_link
7951 {
7952 return &theme_select_rows_link(@_) if (defined(&theme_select_rows_link));
7953 my ($field, $form, $text, $rows) = @_;
7954 $form = int($form);
7955 my $js = "var sel = { ".join(",", map { "\"".&quote_escape($_)."\":1" } @$rows)." }; ";
7956 $js .= "for(var i=0; i<document.forms[$form].${field}.length; i++) { var r = document.forms[$form].${field}[i]; r.checked = sel[r.value]; } ";
7957 $js .= "return false;";
7958 return "<a href='#' onClick='$js'>$text</a>";
7959 }
7960
7961 =head2 check_pid_file(file)
7962
7963 Given a pid file, returns the PID it contains if the process is running.
7964
7965 =cut
7966 sub check_pid_file
7967 {
7968 open(PIDFILE, $_[0]) || return undef;
7969 my $pid = <PIDFILE>;
7970 close(PIDFILE);
7971 $pid =~ /^\s*(\d+)/ || return undef;
7972 kill(0, $1) || return undef;
7973 return $1;
7974 }
7975
7976 =head2 get_mod_lib
7977
7978 Return the local os-specific library name to this module. For internal use only.
7979
7980 =cut
7981 sub get_mod_lib
7982 {
7983 my $mn = &get_module_name();
7984 my $md = &module_root_directory($mn);
7985 if (-r "$md/$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl") {
7986         return "$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl";
7987         }
7988 elsif (-r "$md/$mn-$gconfig{'os_type'}-lib.pl") {
7989         return "$mn-$gconfig{'os_type'}-lib.pl";
7990         }
7991 elsif (-r "$md/$mn-generic-lib.pl") {
7992         return "$mn-generic-lib.pl";
7993         }
7994 else {
7995         return "";
7996         }
7997 }
7998
7999 =head2 module_root_directory(module)
8000
8001 Given a module name, returns its root directory. On a typical Webmin install,
8002 all modules are under the same directory - but it is theoretically possible to
8003 have more than one.
8004
8005 =cut
8006 sub module_root_directory
8007 {
8008 my $d = ref($_[0]) ? $_[0]->{'dir'} : $_[0];
8009 if (@root_directories > 1) {
8010         foreach my $r (@root_directories) {
8011                 if (-d "$r/$d") {
8012                         return "$r/$d";
8013                         }
8014                 }
8015         }
8016 return "$root_directories[0]/$d";
8017 }
8018
8019 =head2 list_mime_types
8020
8021 Returns a list of all known MIME types and their extensions, as a list of hash
8022 references with keys :
8023
8024 =item type - The MIME type, like text/plain.
8025
8026 =item exts - A list of extensions, like .doc and .avi.
8027
8028 =item desc - A human-readable description for the MIME type.
8029
8030 =cut
8031 sub list_mime_types
8032 {
8033 if (!@list_mime_types_cache) {
8034         local $_;
8035         open(MIME, "$root_directory/mime.types");
8036         while(<MIME>) {
8037                 my $cmt;
8038                 s/\r|\n//g;
8039                 if (s/#\s*(.*)$//g) {
8040                         $cmt = $1;
8041                         }
8042                 my ($type, @exts) = split(/\s+/);
8043                 if ($type) {
8044                         push(@list_mime_types_cache, { 'type' => $type,
8045                                                        'exts' => \@exts,
8046                                                        'desc' => $cmt });
8047                         }
8048                 }
8049         close(MIME);
8050         }
8051 return @list_mime_types_cache;
8052 }
8053
8054 =head2 guess_mime_type(filename, [default])
8055
8056 Given a file name like xxx.gif or foo.html, returns a guessed MIME type.
8057 The optional default parameter sets a default type of use if none is found,
8058 which defaults to application/octet-stream.
8059
8060 =cut
8061 sub guess_mime_type
8062 {
8063 if ($_[0] =~ /\.([A-Za-z0-9\-]+)$/) {
8064         my $ext = $1;
8065         foreach my $t (&list_mime_types()) {
8066                 foreach my $e (@{$t->{'exts'}}) {
8067                         return $t->{'type'} if (lc($e) eq lc($ext));
8068                         }
8069                 }
8070         }
8071 return @_ > 1 ? $_[1] : "application/octet-stream";
8072 }
8073
8074 =head2 open_tempfile([handle], file, [no-error], [no-tempfile], [safe?])
8075
8076 Opens a file handle for writing to a temporary file, which will only be
8077 renamed over the real file when the handle is closed. This allows critical
8078 files like /etc/shadow to be updated safely, even if writing fails part way
8079 through due to lack of disk space. The parameters are :
8080
8081 =item handle - File handle to open, as you would use in Perl's open function.
8082
8083 =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.
8084
8085 =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.
8086
8087 =item no-tempfile - If set to 1, writing will be direct to the file instead of using a temporary file.
8088
8089 =item safe - Indicates to users in read-only mode that this write is safe and non-destructive.
8090
8091 =cut
8092 sub open_tempfile
8093 {
8094 if (@_ == 1) {
8095         # Just getting a temp file
8096         if (!defined($main::open_tempfiles{$_[0]})) {
8097                 $_[0] =~ /^(.*)\/(.*)$/ || return $_[0];
8098                 my $dir = $1 || "/";
8099                 my $tmp = "$dir/$2.webmintmp.$$";
8100                 $main::open_tempfiles{$_[0]} = $tmp;
8101                 push(@main::temporary_files, $tmp);
8102                 }
8103         return $main::open_tempfiles{$_[0]};
8104         }
8105 else {
8106         # Actually opening
8107         my ($fh, $file, $noerror, $notemp, $safe) = @_;
8108         $fh = &callers_package($fh);
8109
8110         my %gaccess = &get_module_acl(undef, "");
8111         my $db = $gconfig{'debug_what_write'};
8112         if ($file =~ /\r|\n|\0/) {
8113                 if ($noerror) { return 0; }
8114                 else { &error("Filename contains invalid characters"); }
8115                 }
8116         if (&is_readonly_mode() && $file =~ />/ && !$safe) {
8117                 # Read-only mode .. veto all writes
8118                 print STDERR "vetoing write to $file\n";
8119                 return open($fh, ">$null_file");
8120                 }
8121         elsif ($file =~ /^(>|>>|)nul$/i) {
8122                 # Write to Windows null device
8123                 &webmin_debug_log($1 eq ">" ? "WRITE" :
8124                           $1 eq ">>" ? "APPEND" : "READ", "nul") if ($db);
8125                 }
8126         elsif ($file =~ /^(>|>>)(\/dev\/.*)/ || lc($file) eq "nul") {
8127                 # Writes to /dev/null or TTYs don't need to be handled
8128                 &webmin_debug_log($1 eq ">" ? "WRITE" : "APPEND", $2) if ($db);
8129                 return open($fh, $file);
8130                 }
8131         elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && !$notemp) {
8132                 &webmin_debug_log("WRITE", $1) if ($db);
8133                 # Over-writing a file, via a temp file
8134                 $file = $1;
8135                 $file = &translate_filename($file);
8136                 while(-l $file) {
8137                         # Open the link target instead
8138                         $file = &resolve_links($file);
8139                         }
8140                 if (-d $file) {
8141                         # Cannot open a directory!
8142                         if ($noerror) { return 0; }
8143                         else { &error("Cannot write to directory $file"); }
8144                         }
8145                 my $tmp = &open_tempfile($file);
8146                 my $ex = open($fh, ">$tmp");
8147                 if (!$ex && $! =~ /permission/i) {
8148                         # Could not open temp file .. try opening actual file
8149                         # instead directly
8150                         $ex = open($fh, ">$file");
8151                         delete($main::open_tempfiles{$file});
8152                         }
8153                 else {
8154                         $main::open_temphandles{$fh} = $file;
8155                         }
8156                 binmode($fh);
8157                 if (!$ex && !$noerror) {
8158                         &error(&text("efileopen", $file, $!));
8159                         }
8160                 return $ex;
8161                 }
8162         elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && $notemp) {
8163                 # Just writing direct to a file
8164                 &webmin_debug_log("WRITE", $1) if ($db);
8165                 $file = $1;
8166                 $file = &translate_filename($file);
8167                 my @old_attributes = &get_clear_file_attributes($file);
8168                 my $ex = open($fh, ">$file");
8169                 &reset_file_attributes($file, \@old_attributes);
8170                 $main::open_temphandles{$fh} = $file;
8171                 if (!$ex && !$noerror) {
8172                         &error(&text("efileopen", $file, $!));
8173                         }
8174                 binmode($fh);
8175                 return $ex;
8176                 }
8177         elsif ($file =~ /^>>\s*(([a-zA-Z]:)?\/.*)$/) {
8178                 # Appending to a file .. nothing special to do
8179                 &webmin_debug_log("APPEND", $1) if ($db);
8180                 $file = $1;
8181                 $file = &translate_filename($file);
8182                 my @old_attributes = &get_clear_file_attributes($file);
8183                 my $ex = open($fh, ">>$file");
8184                 &reset_file_attributes($file, \@old_attributes);
8185                 $main::open_temphandles{$fh} = $file;
8186                 if (!$ex && !$noerror) {
8187                         &error(&text("efileopen", $file, $!));
8188                         }
8189                 binmode($fh);
8190                 return $ex;
8191                 }
8192         elsif ($file =~ /^([a-zA-Z]:)?\//) {
8193                 # Read mode .. nothing to do here
8194                 &webmin_debug_log("READ", $file) if ($db);
8195                 $file = &translate_filename($file);
8196                 return open($fh, $file);
8197                 }
8198         elsif ($file eq ">" || $file eq ">>") {
8199                 my ($package, $filename, $line) = caller;
8200                 if ($noerror) { return 0; }
8201                 else { &error("Missing file to open at ${package}::${filename} line $line"); }
8202                 }
8203         else {
8204                 my ($package, $filename, $line) = caller;
8205                 &error("Unsupported file or mode $file at ${package}::${filename} line $line");
8206                 }
8207         }
8208 }
8209
8210 =head2 close_tempfile(file|handle)
8211
8212 Copies a temp file to the actual file, assuming that all writes were
8213 successful. The handle must have been one passed to open_tempfile.
8214
8215 =cut
8216 sub close_tempfile
8217 {
8218 my $file;
8219 my $fh = &callers_package($_[0]);
8220
8221 if (defined($file = $main::open_temphandles{$fh})) {
8222         # Closing a handle
8223         close($fh) || &error(&text("efileclose", $file, $!));
8224         delete($main::open_temphandles{$fh});
8225         return &close_tempfile($file);
8226         }
8227 elsif (defined($main::open_tempfiles{$_[0]})) {
8228         # Closing a file
8229         &webmin_debug_log("CLOSE", $_[0]) if ($gconfig{'debug_what_write'});
8230         my @st = stat($_[0]);
8231         if (&is_selinux_enabled() && &has_command("chcon")) {
8232                 # Set original security context
8233                 system("chcon --reference=".quotemeta($_[0]).
8234                        " ".quotemeta($main::open_tempfiles{$_[0]}).
8235                        " >/dev/null 2>&1");
8236                 }
8237         my @old_attributes = &get_clear_file_attributes($_[0]);
8238         rename($main::open_tempfiles{$_[0]}, $_[0]) || &error("Failed to replace $_[0] with $main::open_tempfiles{$_[0]} : $!");
8239         if (@st) {
8240                 # Set original permissions and ownership
8241                 chmod($st[2], $_[0]);
8242                 chown($st[4], $st[5], $_[0]);
8243                 }
8244         &reset_file_attributes($_[0], \@old_attributes);
8245         delete($main::open_tempfiles{$_[0]});
8246         @main::temporary_files = grep { $_ ne $main::open_tempfiles{$_[0]} } @main::temporary_files;
8247         if ($main::open_templocks{$_[0]}) {
8248                 &unlock_file($_[0]);
8249                 delete($main::open_templocks{$_[0]});
8250                 }
8251         return 1;
8252         }
8253 else {
8254         # Must be closing a handle not associated with a file
8255         close($_[0]);
8256         return 1;
8257         }
8258 }
8259
8260 =head2 print_tempfile(handle, text, ...)
8261
8262 Like the normal print function, but calls &error on failure. Useful when
8263 combined with open_tempfile, to ensure that a criticial file is never
8264 only partially written.
8265
8266 =cut
8267 sub print_tempfile
8268 {
8269 my ($fh, @args) = @_;
8270 $fh = &callers_package($fh);
8271 (print $fh @args) || &error(&text("efilewrite",
8272                             $main::open_temphandles{$fh} || $fh, $!));
8273 }
8274
8275 =head2 is_selinux_enabled
8276
8277 Returns 1 if SElinux is supported on this system and enabled, 0 if not.
8278
8279 =cut
8280 sub is_selinux_enabled
8281 {
8282 if (!defined($main::selinux_enabled_cache)) {
8283         my %seconfig;
8284         if ($gconfig{'os_type'} !~ /-linux$/) {
8285                 # Not on linux, so no way
8286                 $main::selinux_enabled_cache = 0;
8287                 }
8288         elsif (&read_env_file("/etc/selinux/config", \%seconfig)) {
8289                 # Use global config file
8290                 $main::selinux_enabled_cache =
8291                         $seconfig{'SELINUX'} eq 'disabled' ||
8292                         !$seconfig{'SELINUX'} ? 0 : 1;
8293                 }
8294         else {
8295                 # Use selinuxenabled command
8296                 #$selinux_enabled_cache =
8297                 #       system("selinuxenabled >/dev/null 2>&1") ? 0 : 1;
8298                 $main::selinux_enabled_cache = 0;
8299                 }
8300         }
8301 return $main::selinux_enabled_cache;
8302 }
8303
8304 =head2 get_clear_file_attributes(file)
8305
8306 Finds file attributes that may prevent writing, clears them and returns them
8307 as a list. May call error. Mainly for internal use by open_tempfile and
8308 close_tempfile.
8309
8310 =cut
8311 sub get_clear_file_attributes
8312 {
8313 my ($file) = @_;
8314 my @old_attributes;
8315 if ($gconfig{'chattr'}) {
8316         # Get original immutable bit
8317         my $out = &backquote_command(
8318                 "lsattr ".quotemeta($file)." 2>/dev/null");
8319         if (!$?) {
8320                 $out =~ s/\s\S+\n//;
8321                 @old_attributes = grep { $_ ne '-' } split(//, $out);
8322                 }
8323         if (&indexof("i", @old_attributes) >= 0) {
8324                 my $err = &backquote_logged(
8325                         "chattr -i ".quotemeta($file)." 2>&1");
8326                 if ($?) {
8327                         &error("Failed to remove immutable bit on ".
8328                                "$file : $err");
8329                         }
8330                 }
8331         }
8332 return @old_attributes;
8333 }
8334
8335 =head2 reset_file_attributes(file, &attributes)
8336
8337 Put back cleared attributes on some file. May call error. Mainly for internal
8338 use by close_tempfile.
8339
8340 =cut
8341 sub reset_file_attributes
8342 {
8343 my ($file, $old_attributes) = @_;
8344 if (&indexof("i", @$old_attributes) >= 0) {
8345         my $err = &backquote_logged(
8346                 "chattr +i ".quotemeta($file)." 2>&1");
8347         if ($?) {
8348                 &error("Failed to restore immutable bit on ".
8349                        "$file : $err");
8350                 }
8351         }
8352 }
8353
8354 =head2 cleanup_tempnames
8355
8356 Remove all temporary files generated using transname. Typically only called
8357 internally when a Webmin script exits.
8358
8359 =cut
8360 sub cleanup_tempnames
8361 {
8362 foreach my $t (@main::temporary_files) {
8363         &unlink_file($t);
8364         }
8365 @main::temporary_files = ( );
8366 }
8367
8368 =head2 open_lock_tempfile([handle], file, [no-error])
8369
8370 Returns a temporary file for writing to some actual file, and also locks it.
8371 Effectively the same as calling lock_file and open_tempfile on the same file,
8372 but calls the unlock for you automatically when it is closed.
8373
8374 =cut
8375 sub open_lock_tempfile
8376 {
8377 my ($fh, $file, $noerror, $notemp, $safe) = @_;
8378 $fh = &callers_package($fh);
8379 my $lockfile = $file;
8380 $lockfile =~ s/^[^\/]*//;
8381 if ($lockfile =~ /^\//) {
8382         $main::open_templocks{$lockfile} = &lock_file($lockfile);
8383         }
8384 return &open_tempfile($fh, $file, $noerror, $notemp, $safe);
8385 }
8386
8387 sub END
8388 {
8389 $main::end_exit_status ||= $?;
8390 if ($$ == $main::initial_process_id) {
8391         # Exiting from initial process
8392         &cleanup_tempnames();
8393         if ($gconfig{'debug_what_start'} && $main::debug_log_start_time &&
8394             $main::debug_log_start_module eq &get_module_name()) {
8395                 my $len = time() - $main::debug_log_start_time;
8396                 &webmin_debug_log("STOP", "runtime=$len");
8397                 $main::debug_log_start_time = 0;
8398                 }
8399         if (!$ENV{'SCRIPT_NAME'} &&
8400             $main::initial_module_name eq &get_module_name()) {
8401                 # In a command-line script - call the real exit, so that the
8402                 # exit status gets properly propogated. In some cases this
8403                 # was not happening.
8404                 exit($main::end_exit_status);
8405                 }
8406         }
8407 }
8408
8409 =head2 month_to_number(month)
8410
8411 Converts a month name like feb to a number like 1.
8412
8413 =cut
8414 sub month_to_number
8415 {
8416 return $month_to_number_map{lc(substr($_[0], 0, 3))};
8417 }
8418
8419 =head2 number_to_month(number)
8420
8421 Converts a number like 1 to a month name like Feb.
8422
8423 =cut
8424 sub number_to_month
8425 {
8426 return ucfirst($number_to_month_map{$_[0]});
8427 }
8428
8429 =head2 get_rbac_module_acl(user, module)
8430
8431 Returns a hash reference of RBAC overrides ACLs for some user and module.
8432 May return undef if none exist (indicating access denied), or the string *
8433 if full access is granted.
8434
8435 =cut
8436 sub get_rbac_module_acl
8437 {
8438 my ($user, $mod) = @_;
8439 eval "use Authen::SolarisRBAC";
8440 return undef if ($@);
8441 my %rv;
8442 my $foundany = 0;
8443 if (Authen::SolarisRBAC::chkauth("webmin.$mod.admin", $user)) {
8444         # Automagic webmin.modulename.admin authorization exists .. allow access
8445         $foundany = 1;
8446         if (!Authen::SolarisRBAC::chkauth("webmin.$mod.config", $user)) {
8447                 %rv = ( 'noconfig' => 1 );
8448                 }
8449         else {
8450                 %rv = ( );
8451                 }
8452         }
8453 local $_;
8454 open(RBAC, &module_root_directory($mod)."/rbac-mapping");
8455 while(<RBAC>) {
8456         s/\r|\n//g;
8457         s/#.*$//;
8458         my ($auths, $acls) = split(/\s+/, $_);
8459         my @auths = split(/,/, $auths);
8460         next if (!$auths);
8461         my ($merge) = ($acls =~ s/^\+//);
8462         my $gotall = 1;
8463         if ($auths eq "*") {
8464                 # These ACLs apply to all RBAC users.
8465                 # Only if there is some that match a specific authorization
8466                 # later will they be used though.
8467                 }
8468         else {
8469                 # Check each of the RBAC authorizations
8470                 foreach my $a (@auths) {
8471                         if (!Authen::SolarisRBAC::chkauth($a, $user)) {
8472                                 $gotall = 0;
8473                                 last;
8474                                 }
8475                         }
8476                 $foundany++ if ($gotall);
8477                 }
8478         if ($gotall) {
8479                 # Found an RBAC authorization - return the ACLs
8480                 return "*" if ($acls eq "*");
8481                 my %acl = map { split(/=/, $_, 2) } split(/,/, $acls);
8482                 if ($merge) {
8483                         # Just add to current set
8484                         foreach my $a (keys %acl) {
8485                                 $rv{$a} = $acl{$a};
8486                                 }
8487                         }
8488                 else {
8489                         # Found final ACLs
8490                         return \%acl;
8491                         }
8492                 }
8493         }
8494 close(RBAC);
8495 return !$foundany ? undef : %rv ? \%rv : undef;
8496 }
8497
8498 =head2 supports_rbac([module])
8499
8500 Returns 1 if RBAC client support is available, such as on Solaris.
8501
8502 =cut
8503 sub supports_rbac
8504 {
8505 return 0 if ($gconfig{'os_type'} ne 'solaris');
8506 eval "use Authen::SolarisRBAC";
8507 return 0 if ($@);
8508 if ($_[0]) {
8509         #return 0 if (!-r &module_root_directory($_[0])."/rbac-mapping");
8510         }
8511 return 1;
8512 }
8513
8514 =head2 supports_ipv6()
8515
8516 Returns 1 if outgoing IPv6 connections can be made
8517
8518 =cut
8519 sub supports_ipv6
8520 {
8521 return $ipv6_module_error ? 0 : 1;
8522 }
8523
8524 =head2 use_rbac_module_acl(user, module)
8525
8526 Returns 1 if some user should use RBAC to get permissions for a module
8527
8528 =cut
8529 sub use_rbac_module_acl
8530 {
8531 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
8532 my $m = defined($_[1]) ? $_[1] : &get_module_name();
8533 return 1 if ($gconfig{'rbacdeny_'.$u});         # RBAC forced for user
8534 my %access = &get_module_acl($u, $m, 1);
8535 return $access{'rbac'} ? 1 : 0;
8536 }
8537
8538 =head2 execute_command(command, stdin, stdout, stderr, translate-files?, safe?)
8539
8540 Runs some command, possibly feeding it input and capturing output to the
8541 give files or scalar references. The parameters are :
8542
8543 =item command - Full command to run, possibly including shell meta-characters.
8544
8545 =item stdin - File to read input from, or a scalar ref containing input, or undef if no input should be given.
8546
8547 =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.
8548
8549 =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.
8550
8551 =item translate-files - Set to 1 to apply filename translation to any filenames. Usually has no effect.
8552
8553 =item safe - Set to 1 if this command is safe and does not modify the state of the system.
8554
8555 =cut
8556 sub execute_command
8557 {
8558 my ($cmd, $stdin, $stdout, $stderr, $trans, $safe) = @_;
8559 if (&is_readonly_mode() && !$safe) {
8560         print STDERR "Vetoing command $_[0]\n";
8561         $? = 0;
8562         return 0;
8563         }
8564 $cmd = &translate_command($cmd);
8565
8566 # Use ` operator where possible
8567 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
8568 if (!$stdin && ref($stdout) && !$stderr) {
8569         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8570         $$stdout = `$cmd 2>$null_file`;
8571         return $?;
8572         }
8573 elsif (!$stdin && ref($stdout) && $stdout eq $stderr) {
8574         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8575         $$stdout = `$cmd 2>&1`;
8576         return $?;
8577         }
8578 elsif (!$stdin && !$stdout && !$stderr) {
8579         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8580         return system("$cmd >$null_file 2>$null_file <$null_file");
8581         }
8582
8583 # Setup pipes
8584 $| = 1;         # needed on some systems to flush before forking
8585 pipe(EXECSTDINr, EXECSTDINw);
8586 pipe(EXECSTDOUTr, EXECSTDOUTw);
8587 pipe(EXECSTDERRr, EXECSTDERRw);
8588 my $pid;
8589 if (!($pid = fork())) {
8590         untie(*STDIN);
8591         untie(*STDOUT);
8592         untie(*STDERR);
8593         open(STDIN, "<&EXECSTDINr");
8594         open(STDOUT, ">&EXECSTDOUTw");
8595         if (ref($stderr) && $stderr eq $stdout) {
8596                 open(STDERR, ">&EXECSTDOUTw");
8597                 }
8598         else {
8599                 open(STDERR, ">&EXECSTDERRw");
8600                 }
8601         $| = 1;
8602         close(EXECSTDINw);
8603         close(EXECSTDOUTr);
8604         close(EXECSTDERRr);
8605
8606         my $fullcmd = "($cmd)";
8607         if ($stdin && !ref($stdin)) {
8608                 $fullcmd .= " <$stdin";
8609                 }
8610         if ($stdout && !ref($stdout)) {
8611                 $fullcmd .= " >$stdout";
8612                 }
8613         if ($stderr && !ref($stderr)) {
8614                 if ($stderr eq $stdout) {
8615                         $fullcmd .= " 2>&1";
8616                         }
8617                 else {
8618                         $fullcmd .= " 2>$stderr";
8619                         }
8620                 }
8621         if ($gconfig{'os_type'} eq 'windows') {
8622                 exec($fullcmd);
8623                 }
8624         else {
8625                 exec("/bin/sh", "-c", $fullcmd);
8626                 }
8627         print "Exec failed : $!\n";
8628         exit(1);
8629         }
8630 close(EXECSTDINr);
8631 close(EXECSTDOUTw);
8632 close(EXECSTDERRw);
8633
8634 # Feed input and capture output
8635 local $_;
8636 if ($stdin && ref($stdin)) {
8637         print EXECSTDINw $$stdin;
8638         close(EXECSTDINw);
8639         }
8640 if ($stdout && ref($stdout)) {
8641         $$stdout = undef;
8642         while(<EXECSTDOUTr>) {
8643                 $$stdout .= $_;
8644                 }
8645         close(EXECSTDOUTr);
8646         }
8647 if ($stderr && ref($stderr) && $stderr ne $stdout) {
8648         $$stderr = undef;
8649         while(<EXECSTDERRr>) {
8650                 $$stderr .= $_;
8651                 }
8652         close(EXECSTDERRr);
8653         }
8654
8655 # Get exit status
8656 waitpid($pid, 0);
8657 return $?;
8658 }
8659
8660 =head2 open_readfile(handle, file)
8661
8662 Opens some file for reading. Returns 1 on success, 0 on failure. Pretty much
8663 exactly the same as Perl's open function.
8664
8665 =cut
8666 sub open_readfile
8667 {
8668 my ($fh, $file) = @_;
8669 $fh = &callers_package($fh);
8670 my $realfile = &translate_filename($file);
8671 &webmin_debug_log('READ', $file) if ($gconfig{'debug_what_read'});
8672 return open($fh, "<".$realfile);
8673 }
8674
8675 =head2 open_execute_command(handle, command, output?, safe?)
8676
8677 Runs some command, with the specified file handle set to either write to it if
8678 in-or-out is set to 0, or read to it if output is set to 1. The safe flag
8679 indicates if the command modifies the state of the system or not.
8680
8681 =cut
8682 sub open_execute_command
8683 {
8684 my ($fh, $cmd, $mode, $safe) = @_;
8685 $fh = &callers_package($fh);
8686 my $realcmd = &translate_command($cmd);
8687 if (&is_readonly_mode() && !$safe) {
8688         # Don't actually run it
8689         print STDERR "vetoing command $cmd\n";
8690         $? = 0;
8691         if ($mode == 0) {
8692                 return open($fh, ">$null_file");
8693                 }
8694         else {
8695                 return open($fh, $null_file);
8696                 }
8697         }
8698 # Really run it
8699 &webmin_debug_log('CMD', "cmd=$realcmd mode=$mode")
8700         if ($gconfig{'debug_what_cmd'});
8701 if ($mode == 0) {
8702         return open($fh, "| $cmd");
8703         }
8704 elsif ($mode == 1) {
8705         return open($fh, "$cmd 2>$null_file |");
8706         }
8707 elsif ($mode == 2) {
8708         return open($fh, "$cmd 2>&1 |");
8709         }
8710 }
8711
8712 =head2 translate_filename(filename)
8713
8714 Applies all relevant registered translation functions to a filename. Mostly
8715 for internal use, and typically does nothing.
8716
8717 =cut
8718 sub translate_filename
8719 {
8720 my ($realfile) = @_;
8721 my @funcs = grep { $_->[0] eq &get_module_name() ||
8722                    !defined($_->[0]) } @main::filename_callbacks;
8723 foreach my $f (@funcs) {
8724         my $func = $f->[1];
8725         $realfile = &$func($realfile, @{$f->[2]});
8726         }
8727 return $realfile;
8728 }
8729
8730 =head2 translate_command(filename)
8731
8732 Applies all relevant registered translation functions to a command. Mostly
8733 for internal use, and typically does nothing.
8734
8735 =cut
8736 sub translate_command
8737 {
8738 my ($realcmd) = @_;
8739 my @funcs = grep { $_->[0] eq &get_module_name() ||
8740                    !defined($_->[0]) } @main::command_callbacks;
8741 foreach my $f (@funcs) {
8742         my $func = $f->[1];
8743         $realcmd = &$func($realcmd, @{$f->[2]});
8744         }
8745 return $realcmd;
8746 }
8747
8748 =head2 register_filename_callback(module|undef, &function, &args)
8749
8750 Registers some function to be called when the specified module (or all
8751 modules) tries to open a file for reading and writing. The function must
8752 return the actual file to open. This allows you to override which files
8753 other code actually operates on, via the translate_filename function.
8754
8755 =cut
8756 sub register_filename_callback
8757 {
8758 my ($mod, $func, $args) = @_;
8759 push(@main::filename_callbacks, [ $mod, $func, $args ]);
8760 }
8761
8762 =head2 register_command_callback(module|undef, &function, &args)
8763
8764 Registers some function to be called when the specified module (or all
8765 modules) tries to execute a command. The function must return the actual
8766 command to run. This allows you to override which commands other other code
8767 actually runs, via the translate_command function.
8768
8769 =cut
8770 sub register_command_callback
8771 {
8772 my ($mod, $func, $args) = @_;
8773 push(@main::command_callbacks, [ $mod, $func, $args ]);
8774 }
8775
8776 =head2 capture_function_output(&function, arg, ...)
8777
8778 Captures output that some function prints to STDOUT, and returns it. Useful
8779 for functions outside your control that print data when you really want to
8780 manipulate it before output.
8781
8782 =cut
8783 sub capture_function_output
8784 {
8785 my ($func, @args) = @_;
8786 socketpair(SOCKET2, SOCKET1, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
8787 my $old = select(SOCKET1);
8788 my @rv = &$func(@args);
8789 select($old);
8790 close(SOCKET1);
8791 my $out;
8792 local $_;
8793 while(<SOCKET2>) {
8794         $out .= $_;
8795         }
8796 close(SOCKET2);
8797 return wantarray ? ($out, \@rv) : $out;
8798 }
8799
8800 =head2 capture_function_output_tempfile(&function, arg, ...)
8801
8802 Behaves the same as capture_function_output, but uses a temporary file
8803 to avoid buffer full problems.
8804
8805 =cut
8806 sub capture_function_output_tempfile
8807 {
8808 my ($func, @args) = @_;
8809 my $temp = &transname();
8810 open(BUFFER, ">$temp");
8811 my $old = select(BUFFER);
8812 my @rv = &$func(@args);
8813 select($old);
8814 close(BUFFER);
8815 my $out = &read_file_contents($temp);
8816 &unlink_file($temp);
8817 return wantarray ? ($out, \@rv) : $out;
8818 }
8819
8820 =head2 modules_chooser_button(field, multiple, [form])
8821
8822 Returns HTML for a button for selecting one or many Webmin modules.
8823 field - Name of the HTML field to place the module names into.
8824 multiple - Set to 1 if multiple modules can be selected.
8825 form - Index of the form on the page.
8826
8827 =cut
8828 sub modules_chooser_button
8829 {
8830 return &theme_modules_chooser_button(@_)
8831         if (defined(&theme_modules_chooser_button));
8832 my $form = defined($_[2]) ? $_[2] : 0;
8833 my $w = $_[1] ? 700 : 500;
8834 my $h = 200;
8835 if ($_[1] && $gconfig{'db_sizemodules'}) {
8836         ($w, $h) = split(/x/, $gconfig{'db_sizemodules'});
8837         }
8838 elsif (!$_[1] && $gconfig{'db_sizemodule'}) {
8839         ($w, $h) = split(/x/, $gconfig{'db_sizemodule'});
8840         }
8841 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";
8842 }
8843
8844 =head2 substitute_template(text, &hash)
8845
8846 Given some text and a hash reference, for each ocurrance of $FOO or ${FOO} in
8847 the text replaces it with the value of the hash key foo. Also supports blocks
8848 like ${IF-FOO} ... ${ENDIF-FOO}, whose contents are only included if foo is
8849 non-zero, and ${IF-FOO} ... ${ELSE-FOO} ... ${ENDIF-FOO}.
8850
8851 =cut
8852 sub substitute_template
8853 {
8854 # Add some extra fixed parameters to the hash
8855 my %hash = %{$_[1]};
8856 $hash{'hostname'} = &get_system_hostname();
8857 $hash{'webmin_config'} = $config_directory;
8858 $hash{'webmin_etc'} = $config_directory;
8859 $hash{'module_config'} = &get_module_variable('$module_config_directory');
8860 $hash{'webmin_var'} = $var_directory;
8861
8862 # Add time-based parameters, for use in DNS
8863 $hash{'current_time'} = time();
8864 my @tm = localtime($hash{'current_time'});
8865 $hash{'current_year'} = $tm[5]+1900;
8866 $hash{'current_month'} = sprintf("%2.2d", $tm[4]+1);
8867 $hash{'current_day'} = sprintf("%2.2d", $tm[3]);
8868 $hash{'current_hour'} = sprintf("%2.2d", $tm[2]);
8869 $hash{'current_minute'} = sprintf("%2.2d", $tm[1]);
8870 $hash{'current_second'} = sprintf("%2.2d", $tm[0]);
8871
8872 # Actually do the substition
8873 my $rv = $_[0];
8874 foreach my $s (keys %hash) {
8875         next if ($s eq '');     # Prevent just $ from being subbed
8876         my $us = uc($s);
8877         my $sv = $hash{$s};
8878         $rv =~ s/\$\{\Q$us\E\}/$sv/g;
8879         $rv =~ s/\$\Q$us\E/$sv/g;
8880         if ($sv) {
8881                 # Replace ${IF}..${ELSE}..${ENDIF} block with first value,
8882                 # and ${IF}..${ENDIF} with value
8883                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8884                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8885
8886                 # Replace $IF..$ELSE..$ENDIF block with first value,
8887                 # and $IF..$ENDIF with value
8888                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8889                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8890
8891                 # Replace ${IFEQ}..${ENDIFEQ} block with first value if
8892                 # matching, nothing if not
8893                 $rv =~ s/\$\{IFEQ-\Q$us\E-\Q$sv\E\}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-\Q$sv\E\}(\n?)/$2/g;
8894                 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8895
8896                 # Replace $IFEQ..$ENDIFEQ block with first value if
8897                 # matching, nothing if not
8898                 $rv =~ s/\$IFEQ-\Q$us\E-\Q$sv\E(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\Q$sv\E(\n?)/$2/g;
8899                 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8900                 }
8901         else {
8902                 # Replace ${IF}..${ELSE}..${ENDIF} block with second value,
8903                 # and ${IF}..${ENDIF} with nothing
8904                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$4/g;
8905                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)//g;
8906
8907                 # Replace $IF..$ELSE..$ENDIF block with second value,
8908                 # and $IF..$ENDIF with nothing
8909                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$4/g;
8910                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)//g;
8911
8912                 # Replace ${IFEQ}..${ENDIFEQ} block with nothing
8913                 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8914                 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8915                 }
8916         }
8917
8918 # Now assume any $IF blocks whose variables are not present in the hash
8919 # evaluate to false.
8920 # $IF...$ELSE x $ENDIF => x
8921 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ELSE\-\1\}(.*?)\$\{ENDIF\-\1\}/$2/gs;
8922 # $IF...x...$ENDIF => (nothing)
8923 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ENDIF\-\1\}//gs;
8924 # ${var} => (nothing)
8925 $rv =~ s/\$\{[A-Z]+\}//g;
8926
8927 return $rv;
8928 }
8929
8930 =head2 running_in_zone
8931
8932 Returns 1 if the current Webmin instance is running in a Solaris zone. Used to
8933 disable module and features that are not appropriate, like those that modify
8934 mounted filesystems.
8935
8936 =cut
8937 sub running_in_zone
8938 {
8939 return 0 if ($gconfig{'os_type'} ne 'solaris' ||
8940              $gconfig{'os_version'} < 10);
8941 my $zn = `zonename 2>$null_file`;
8942 chop($zn);
8943 return $zn && $zn ne "global";
8944 }
8945
8946 =head2 running_in_vserver
8947
8948 Returns 1 if the current Webmin instance is running in a Linux VServer.
8949 Used to disable modules and features that are not appropriate.
8950
8951 =cut
8952 sub running_in_vserver
8953 {
8954 return 0 if ($gconfig{'os_type'} !~ /^\*-linux$/);
8955 my $vserver;
8956 local $_;
8957 open(MTAB, "/etc/mtab");
8958 while(<MTAB>) {
8959         my ($dev, $mp) = split(/\s+/, $_);
8960         if ($mp eq "/" && $dev =~ /^\/dev\/hdv/) {
8961                 $vserver = 1;
8962                 last;
8963                 }
8964         }
8965 close(MTAB);
8966 return $vserver;
8967 }
8968
8969 =head2 running_in_xen
8970
8971 Returns 1 if Webmin is running inside a Xen instance, by looking
8972 at /proc/xen/capabilities.
8973
8974 =cut
8975 sub running_in_xen
8976 {
8977 return 0 if (!-r "/proc/xen/capabilities");
8978 my $cap = &read_file_contents("/proc/xen/capabilities");
8979 return $cap =~ /control_d/ ? 0 : 1;
8980 }
8981
8982 =head2 running_in_openvz
8983
8984 Returns 1 if Webmin is running inside an OpenVZ container, by looking
8985 at /proc/vz/veinfo for a non-zero line.
8986
8987 =cut
8988 sub running_in_openvz
8989 {
8990 return 0 if (!-r "/proc/vz/veinfo");
8991 my $lref = &read_file_lines("/proc/vz/veinfo", 1);
8992 return 0 if (!$lref || !@$lref);
8993 foreach my $l (@$lref) {
8994         $l =~ s/^\s+//;
8995         my @ll = split(/\s+/, $l);
8996         return 0 if ($ll[0] eq '0');
8997         }
8998 return 1;
8999 }
9000
9001 =head2 list_categories(&modules, [include-empty])
9002
9003 Returns a hash mapping category codes to names, including any custom-defined
9004 categories. The modules parameter must be an array ref of module hash objects,
9005 as returned by get_all_module_infos.
9006
9007 =cut
9008 sub list_categories
9009 {
9010 my ($mods, $empty) = @_;
9011 my (%cats, %catnames);
9012 &read_file("$config_directory/webmin.catnames", \%catnames);
9013 foreach my $o (@lang_order_list) {
9014         &read_file("$config_directory/webmin.catnames.$o", \%catnames);
9015         }
9016 if ($empty) {
9017         %cats = %catnames;
9018         }
9019 foreach my $m (@$mods) {
9020         my $c = $m->{'category'};
9021         next if ($cats{$c});
9022         if (defined($catnames{$c})) {
9023                 $cats{$c} = $catnames{$c};
9024                 }
9025         elsif ($text{"category_$c"}) {
9026                 $cats{$c} = $text{"category_$c"};
9027                 }
9028         else {
9029                 # try to get category name from module ..
9030                 my %mtext = &load_language($m->{'dir'});
9031                 if ($mtext{"category_$c"}) {
9032                         $cats{$c} = $mtext{"category_$c"};
9033                         }
9034                 else {
9035                         $c = $m->{'category'} = "";
9036                         $cats{$c} = $text{"category_$c"};
9037                         }
9038                 }
9039         }
9040 return %cats;
9041 }
9042
9043 =head2 is_readonly_mode
9044
9045 Returns 1 if the current user is in read-only mode, and thus all writes
9046 to files and command execution should fail.
9047
9048 =cut
9049 sub is_readonly_mode
9050 {
9051 if (!defined($main::readonly_mode_cache)) {
9052         my %gaccess = &get_module_acl(undef, "");
9053         $main::readonly_mode_cache = $gaccess{'readonly'} ? 1 : 0;
9054         }
9055 return $main::readonly_mode_cache;
9056 }
9057
9058 =head2 command_as_user(user, with-env?, command, ...)
9059
9060 Returns a command to execute some command as the given user, using the
9061 su statement. If on Linux, the /bin/sh shell is forced in case the user
9062 does not have a valid shell. If with-env is set to 1, the -s flag is added
9063 to the su command to read the user's .profile or .bashrc file.
9064
9065 =cut
9066 sub command_as_user
9067 {
9068 my ($user, $env, @args) = @_;
9069 my @uinfo = getpwnam($user);
9070 if ($uinfo[8] ne "/bin/sh" && $uinfo[8] !~ /\/bash$/) {
9071         # User shell doesn't appear to be valid
9072         if ($gconfig{'os_type'} =~ /-linux$/) {
9073                 # Use -s /bin/sh to force it
9074                 $shellarg = " -s /bin/sh";
9075                 }
9076         elsif ($gconfig{'os_type'} eq 'freebsd' ||
9077                $gconfig{'os_type'} eq 'solaris' &&
9078                 $gconfig{'os_version'} >= 11 ||
9079                $gconfig{'os_type'} eq 'macos') {
9080                 # Use -m and force /bin/sh
9081                 @args = ( "/bin/sh", "-c", quotemeta(join(" ", @args)) );
9082                 $shellarg = " -m";
9083                 }
9084         }
9085 my $rv = "su".($env ? " -" : "").$shellarg.
9086          " ".quotemeta($user)." -c ".quotemeta(join(" ", @args));
9087 return $rv;
9088 }
9089
9090 =head2 list_osdn_mirrors(project, file)
9091
9092 This function is now deprecated in favor of letting sourceforge just
9093 redirect to the best mirror, and now just returns their primary download URL.
9094
9095 =cut
9096 sub list_osdn_mirrors
9097 {
9098 my ($project, $file) = @_;
9099 return ( { 'url' => "http://downloads.sourceforge.net/$project/$file",
9100            'default' => 0,
9101            'mirror' => 'downloads' } );
9102 }
9103
9104 =head2 convert_osdn_url(url)
9105
9106 Given a URL like http://osdn.dl.sourceforge.net/sourceforge/project/file.zip
9107 or http://prdownloads.sourceforge.net/project/file.zip , convert it
9108 to a real URL on the sourceforge download redirector.
9109
9110 =cut
9111 sub convert_osdn_url
9112 {
9113 my ($url) = @_;
9114 if ($url =~ /^http:\/\/[^\.]+.dl.sourceforge.net\/sourceforge\/([^\/]+)\/(.*)$/ ||
9115     $url =~ /^http:\/\/prdownloads.sourceforge.net\/([^\/]+)\/(.*)$/) {
9116         # Always use the Sourceforge mail download URL, which does
9117         # a location-based redirect for us
9118         my ($project, $file) = ($1, $2);
9119         $url = "http://prdownloads.sourceforge.net/sourceforge/".
9120                "$project/$file";
9121         return wantarray ? ( $url, 0 ) : $url;
9122         }
9123 else {
9124         # Some other source .. don't change
9125         return wantarray ? ( $url, 2 ) : $url;
9126         }
9127 }
9128
9129 =head2 get_current_dir
9130
9131 Returns the directory the current process is running in.
9132
9133 =cut
9134 sub get_current_dir
9135 {
9136 my $out;
9137 if ($gconfig{'os_type'} eq 'windows') {
9138         # Use cd command
9139         $out = `cd`;
9140         }
9141 else {
9142         # Use pwd command
9143         $out = `pwd`;
9144         $out =~ s/\\/\//g;
9145         }
9146 $out =~ s/\r|\n//g;
9147 return $out;
9148 }
9149
9150 =head2 supports_users
9151
9152 Returns 1 if the current OS supports Unix user concepts and functions like
9153 su , getpw* and so on. This will be true on Linux and other Unixes, but false
9154 on Windows.
9155
9156 =cut
9157 sub supports_users
9158 {
9159 return $gconfig{'os_type'} ne 'windows';
9160 }
9161
9162 =head2 supports_symlinks
9163
9164 Returns 1 if the current OS supports symbolic and hard links. This will not
9165 be the case on Windows.
9166
9167 =cut
9168 sub supports_symlinks
9169 {
9170 return $gconfig{'os_type'} ne 'windows';
9171 }
9172
9173 =head2 quote_path(path)
9174
9175 Returns a path with safe quoting for the current operating system.
9176
9177 =cut
9178 sub quote_path
9179 {
9180 my ($path) = @_;
9181 if ($gconfig{'os_type'} eq 'windows' || $path =~ /^[a-z]:/i) {
9182         # Windows only supports "" style quoting
9183         return "\"$path\"";
9184         }
9185 else {
9186         return quotemeta($path);
9187         }
9188 }
9189
9190 =head2 get_windows_root
9191
9192 Returns the base windows system directory, like c:/windows.
9193
9194 =cut
9195 sub get_windows_root
9196 {
9197 if ($ENV{'SystemRoot'}) {
9198         my $rv = $ENV{'SystemRoot'};
9199         $rv =~ s/\\/\//g;
9200         return $rv;
9201         }
9202 else {
9203         return -d "c:/windows" ? "c:/windows" : "c:/winnt";
9204         }
9205 }
9206
9207 =head2 read_file_contents(file)
9208
9209 Given a filename, returns its complete contents as a string. Effectively
9210 the same as the Perl construct `cat file`.
9211
9212 =cut
9213 sub read_file_contents
9214 {
9215 &open_readfile(FILE, $_[0]) || return undef;
9216 local $/ = undef;
9217 my $rv = <FILE>;
9218 close(FILE);
9219 return $rv;
9220 }
9221
9222 =head2 unix_crypt(password, salt)
9223
9224 Performs Unix encryption on a password, using the built-in crypt function or
9225 the Crypt::UnixCrypt module if the former does not work. The salt parameter
9226 must be either an already-hashed password, or a two-character alpha-numeric
9227 string.
9228
9229 =cut
9230 sub unix_crypt
9231 {
9232 my ($pass, $salt) = @_;
9233 return "" if ($salt !~ /^[a-zA-Z0-9\.\/]{2}/);   # same as real crypt
9234 my $rv = eval "crypt(\$pass, \$salt)";
9235 my $err = $@;
9236 return $rv if ($rv && !$@);
9237 eval "use Crypt::UnixCrypt";
9238 if (!$@) {
9239         return Crypt::UnixCrypt::crypt($pass, $salt);
9240         }
9241 else {
9242         &error("Failed to encrypt password : $err");
9243         }
9244 }
9245
9246 =head2 split_quoted_string(string)
9247
9248 Given a string like I<foo "bar baz" quux>, returns the array :
9249 foo, bar baz, quux
9250
9251 =cut
9252 sub split_quoted_string
9253 {
9254 my ($str) = @_;
9255 my @rv;
9256 while($str =~ /^"([^"]*)"\s*([\000-\377]*)$/ ||
9257       $str =~ /^'([^']*)'\s*([\000-\377]*)$/ ||
9258       $str =~ /^(\S+)\s*([\000-\377]*)$/) {
9259         push(@rv, $1);
9260         $str = $2;
9261         }
9262 return @rv;
9263 }
9264
9265 =head2 write_to_http_cache(url, file|&data)
9266
9267 Updates the Webmin cache with the contents of the given file, possibly also
9268 clearing out old data. Mainly for internal use by http_download.
9269
9270 =cut
9271 sub write_to_http_cache
9272 {
9273 my ($url, $file) = @_;
9274 return 0 if (!$gconfig{'cache_size'});
9275
9276 # Don't cache downloads that look dynamic
9277 if ($url =~ /cgi-bin/ || $url =~ /\?/) {
9278         return 0;
9279         }
9280
9281 # Check if the current module should do caching
9282 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
9283         # Caching all except some modules
9284         my @mods = split(/\s+/, $1);
9285         return 0 if (&indexof(&get_module_name(), @mods) != -1);
9286         }
9287 elsif ($gconfig{'cache_mods'}) {
9288         # Only caching some modules
9289         my @mods = split(/\s+/, $gconfig{'cache_mods'});
9290         return 0 if (&indexof(&get_module_name(), @mods) == -1);
9291         }
9292
9293 # Work out the size
9294 my $size;
9295 if (ref($file)) {
9296         $size = length($$file);
9297         }
9298 else {
9299         my @st = stat($file);
9300         $size = $st[7];
9301         }
9302
9303 if ($size > $gconfig{'cache_size'}) {
9304         # Bigger than the whole cache - so don't save it
9305         return 0;
9306         }
9307 my $cfile = $url;
9308 $cfile =~ s/\//_/g;
9309 $cfile = "$main::http_cache_directory/$cfile";
9310
9311 # See how much we have cached currently, clearing old files
9312 my $total = 0;
9313 mkdir($main::http_cache_directory, 0700) if (!-d $main::http_cache_directory);
9314 opendir(CACHEDIR, $main::http_cache_directory);
9315 foreach my $f (readdir(CACHEDIR)) {
9316         next if ($f eq "." || $f eq "..");
9317         my $path = "$main::http_cache_directory/$f";
9318         my @st = stat($path);
9319         if ($gconfig{'cache_days'} &&
9320             time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
9321                 # This file is too old .. trash it
9322                 unlink($path);
9323                 }
9324         else {
9325                 $total += $st[7];
9326                 push(@cached, [ $path, $st[7], $st[9] ]);
9327                 }
9328         }
9329 closedir(CACHEDIR);
9330 @cached = sort { $a->[2] <=> $b->[2] } @cached;
9331 while($total+$size > $gconfig{'cache_size'} && @cached) {
9332         # Cache is too big .. delete some files until the new one will fit
9333         unlink($cached[0]->[0]);
9334         $total -= $cached[0]->[1];
9335         shift(@cached);
9336         }
9337
9338 # Finally, write out the new file
9339 if (ref($file)) {
9340         &open_tempfile(CACHEFILE, ">$cfile");
9341         &print_tempfile(CACHEFILE, $$file);
9342         &close_tempfile(CACHEFILE);
9343         }
9344 else {
9345         my ($ok, $err) = &copy_source_dest($file, $cfile);
9346         }
9347
9348 return 1;
9349 }
9350
9351 =head2 check_in_http_cache(url)
9352
9353 If some URL is in the cache and valid, return the filename for it. Mainly
9354 for internal use by http_download.
9355
9356 =cut
9357 sub check_in_http_cache
9358 {
9359 my ($url) = @_;
9360 return undef if (!$gconfig{'cache_size'});
9361
9362 # Check if the current module should do caching
9363 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
9364         # Caching all except some modules
9365         my @mods = split(/\s+/, $1);
9366         return 0 if (&indexof(&get_module_name(), @mods) != -1);
9367         }
9368 elsif ($gconfig{'cache_mods'}) {
9369         # Only caching some modules
9370         my @mods = split(/\s+/, $gconfig{'cache_mods'});
9371         return 0 if (&indexof(&get_module_name(), @mods) == -1);
9372         }
9373
9374 my $cfile = $url;
9375 $cfile =~ s/\//_/g;
9376 $cfile = "$main::http_cache_directory/$cfile";
9377 my @st = stat($cfile);
9378 return undef if (!@st || !$st[7]);
9379 if ($gconfig{'cache_days'} && time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
9380         # Too old!
9381         unlink($cfile);
9382         return undef;
9383         }
9384 open(TOUCH, ">>$cfile");        # Update the file time, to keep it in the cache
9385 close(TOUCH);
9386 return $cfile;
9387 }
9388
9389 =head2 supports_javascript
9390
9391 Returns 1 if the current browser is assumed to support javascript.
9392
9393 =cut
9394 sub supports_javascript
9395 {
9396 if (defined(&theme_supports_javascript)) {
9397         return &theme_supports_javascript();
9398         }
9399 return $ENV{'MOBILE_DEVICE'} ? 0 : 1;
9400 }
9401
9402 =head2 get_module_name
9403
9404 Returns the name of the Webmin module that called this function. For internal
9405 use only by other API functions.
9406
9407 =cut
9408 sub get_module_name
9409 {
9410 return &get_module_variable('$module_name');
9411 }
9412
9413 =head2 get_module_variable(name, [ref])
9414
9415 Returns the value of some variable which is set in the caller's context, if
9416 using the new WebminCore package. For internal use only.
9417
9418 =cut
9419 sub get_module_variable
9420 {
9421 my ($v, $wantref) = @_;
9422 my $slash = $wantref ? "\\" : "";
9423 my $thispkg = &web_libs_package();
9424 if ($thispkg eq 'WebminCore') {
9425         my ($vt, $vn) = split('', $v, 2);
9426         my $callpkg;
9427         for(my $i=0; ($callpkg) = caller($i); $i++) {
9428                 last if ($callpkg ne $thispkg);
9429                 }
9430         return eval "${slash}${vt}${callpkg}::${vn}";
9431         }
9432 return eval "${slash}${v}";
9433 }
9434
9435 =head2 clear_time_locale()
9436
9437 Temporarily force the locale to C, until reset_time_locale is called. This is
9438 useful if your code is going to call C<strftime> from the POSIX package, and
9439 you want to ensure that the output is in a consistent format.
9440
9441 =cut
9442 sub clear_time_locale
9443 {
9444 if ($main::clear_time_locale_count == 0) {
9445         eval {
9446                 use POSIX;
9447                 $main::clear_time_locale_old = POSIX::setlocale(POSIX::LC_TIME);
9448                 POSIX::setlocale(POSIX::LC_TIME, "C");
9449                 };
9450         }
9451 $main::clear_time_locale_count++;
9452 }
9453
9454 =head2 reset_time_locale()
9455
9456 Revert the locale to whatever it was before clear_time_locale was called
9457
9458 =cut
9459 sub reset_time_locale
9460 {
9461 if ($main::clear_time_locale_count == 1) {
9462         eval {
9463                 POSIX::setlocale(POSIX::LC_TIME, $main::clear_time_locale_old);
9464                 $main::clear_time_locale_old = undef;
9465                 };
9466         }
9467 $main::clear_time_locale_count--;
9468 }
9469
9470 =head2 callers_package(filehandle)
9471
9472 Convert a non-module filehandle like FOO to one qualified with the
9473 caller's caller's package, like fsdump::FOO. For internal use only.
9474
9475 =cut
9476 sub callers_package
9477 {
9478 my ($fh) = @_;
9479 my $callpkg = (caller(1))[0];
9480 my $thispkg = &web_libs_package();
9481 if (!ref($fh) && $fh !~ /::/ &&
9482     $callpkg ne $thispkg && $thispkg eq 'WebminCore') {
9483         $fh = $callpkg."::".$fh;
9484         }
9485 return $fh;
9486 }
9487
9488 =head2 web_libs_package()
9489
9490 Returns the package this code is in. We can't always trust __PACKAGE__. For
9491 internal use only.
9492
9493 =cut
9494 sub web_libs_package
9495 {
9496 if ($called_from_webmin_core) {
9497         return "WebminCore";
9498         }
9499 return __PACKAGE__;
9500 }
9501
9502 =head2 get_userdb_string
9503
9504 Returns the URL-style string for connecting to the users and groups database
9505
9506 =cut
9507 sub get_userdb_string
9508 {
9509 return undef if ($main::no_miniserv_userdb);
9510 my %miniserv;
9511 &get_miniserv_config(\%miniserv);
9512 return $miniserv{'userdb'};
9513 }
9514
9515 =head2 connect_userdb(string)
9516
9517 Returns a handle for talking to a user database - may be a DBI or LDAP handle.
9518 On failure returns an error message string. In an array context, returns the
9519 protocol type too.
9520
9521 =cut
9522 sub connect_userdb
9523 {
9524 my ($str) = @_;
9525 my ($proto, $user, $pass, $host, $prefix, $args) = &split_userdb_string($str);
9526 if ($proto eq "mysql") {
9527         # Connect to MySQL with DBI
9528         my $drh = eval "use DBI; DBI->install_driver('mysql');";
9529         $drh || return $text{'sql_emysqldriver'};
9530         my ($host, $port) = split(/:/, $host);
9531         my $cstr = "database=$prefix;host=$host";
9532         $cstr .= ";port=$port" if ($port);
9533         my $dbh = $drh->connect($cstr, $user, $pass, { });
9534         $dbh || return &text('sql_emysqlconnect', $drh->errstr);
9535         return wantarray ? ($dbh, $proto, $prefix, $args) : $dbh;
9536         }
9537 elsif ($proto eq "postgresql") {
9538         # Connect to PostgreSQL with DBI
9539         my $drh = eval "use DBI; DBI->install_driver('Pg');";
9540         $drh || return $text{'sql_epostgresqldriver'};
9541         my ($host, $port) = split(/:/, $host);
9542         my $cstr = "dbname=$prefix;host=$host";
9543         $cstr .= ";port=$port" if ($port);
9544         my $dbh = $drh->connect($cstr, $user, $pass);
9545         $dbh || return &text('sql_epostgresqlconnect', $drh->errstr);
9546         return wantarray ? ($dbh, $proto, $prefix, $args) : $dbh;
9547         }
9548 elsif ($proto eq "ldap") {
9549         # Connect with perl LDAP module
9550         eval "use Net::LDAP";
9551         $@ && return $text{'sql_eldapdriver'};
9552         my ($host, $port) = split(/:/, $host);
9553         my $scheme = $args->{'scheme'} || 'ldap';
9554         if (!$port) {
9555                 $port = $scheme eq 'ldaps' ? 636 : 389;
9556                 }
9557         my $ldap = Net::LDAP->new($host,
9558                                   port => $port,
9559                                   'scheme' => $scheme);
9560         $ldap || return &text('sql_eldapconnect', $host);
9561         my $mesg;
9562         if ($args->{'tls'}) {
9563                 # Switch to TLS mode
9564                 eval { $mesg = $ldap->start_tls(); };
9565                 if ($@ || !$mesg || $mesg->code) {
9566                         return &text('sql_eldaptls',
9567                             $@ ? $@ : $mesg ? $mesg->error : "Unknown error");
9568                         }
9569                 }
9570         # Login to the server
9571         if ($pass) {
9572                 $mesg = $ldap->bind(dn => $user, password => $pass);
9573                 }
9574         else {
9575                 $mesg = $ldap->bind(dn => $user, anonymous => 1);
9576                 }
9577         if (!$mesg || $mesg->code) {
9578                 return &text('sql_eldaplogin', $user,
9579                              $mesg ? $mesg->error : "Unknown error");
9580                 }
9581         return wantarray ? ($ldap, $proto, $prefix, $args) : $ldap;
9582         }
9583 else {
9584         return "Unknown protocol $proto";
9585         }
9586 }
9587
9588 =head2 disconnect_userdb(string, &handle)
9589
9590 Closes a handle opened by connect_userdb
9591
9592 =cut
9593 sub disconnect_userdb
9594 {
9595 my ($str, $h) = @_;
9596 if ($str =~ /^(mysql|postgresql):/) {
9597         # DBI disconnnect
9598         if (!$h->{'AutoCommit'}) {
9599                 $h->commit();
9600                 }
9601         $h->disconnect();
9602         }
9603 elsif ($str =~ /^ldap:/) {
9604         # LDAP disconnect
9605         $h->unbind();
9606         $h->disconnect();
9607         }
9608 }
9609
9610 =head2 split_userdb_string(string)
9611
9612 Converts a string like mysql://user:pass@host/db into separate parts
9613
9614 =cut
9615 sub split_userdb_string
9616 {
9617 my ($str) = @_;
9618 if ($str =~ /^([a-z]+):\/\/([^:]*):([^\@]*)\@([a-z0-9\.\-\_]+)\/([^\?]+)(\?(.*))?$/) {
9619         my ($proto, $user, $pass, $host, $prefix, $argstr) =
9620                 ($1, $2, $3, $4, $5, $7);
9621         my %args = map { split(/=/, $_, 2) } split(/\&/, $argstr);
9622         return ($proto, $user, $pass, $host, $prefix, \%args);
9623         }
9624 return ( );
9625 }
9626
9627 $done_web_lib_funcs = 1;
9628
9629 1;