web-lib-funcs.pl

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