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