web-lib-funcs.pl

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