web-lib-funcs.pl

   1 =head1 web-lib-funcs.pl
   2
   3 Common functions for Webmin CGI scripts. This file gets in-directly included
   4 by all scripts that use web-lib.pl.
   5 Example code:
   6
   7   use WebminCore;
   8   init_config();
   9   ui_print_header(undef, 'My Module', '');
  10   print 'This is Webmin version ',get_webmin_version(),'<p>\n';
  11   ui_print_footer();
  12
  13 =cut
  14
  15 #use warnings;
  16 use Socket;
  17 use POSIX;
  18
  19 use vars qw($user_risk_level $loaded_theme_library $wait_for_input
  20             $done_webmin_header $trust_unknown_referers $unsafe_index_cgi
  21             %done_foreign_require $webmin_feedback_address
  22             $user_skill_level $pragma_no_cache $foreign_args);
  23 # Globals
  24 use vars qw($module_index_name $number_to_month_map $month_to_number_map
  25             $umask_already $default_charset $licence_status $os_type
  26             $licence_message $script_name $loaded_theme_oo_library
  27             $done_web_lib_funcs $os_version $module_index_link
  28             $called_from_webmin_core);
  29
  30 =head2 read_file(file, &hash, [&order], [lowercase], [split-char])
  31
  32 Fill the given hash reference with name=value pairs from a file. The required
  33 parameters are :
  34
  35 =item file - The file to head, which must be text with each line like name=value
  36
  37 =item hash - The hash reference to add values read from the file to.
  38
  39 =item order - If given, an array reference to add names to in the order they were read
  40
  41 =item lowercase - If set to 1, names are converted to lower case
  42
  43 =item split-char - If set, names and values are split on this character instead of =
  44
  45 =cut
  46 sub read_file
  47 {
  48 local $_;
  49 my $split = defined($_[4]) ? $_[4] : "=";
  50 my $realfile = &translate_filename($_[0]);
  51 &open_readfile(ARFILE, $_[0]) || return 0;
  52 while(<ARFILE>) {
  53         chomp;
  54         my $hash = index($_, "#");
  55         my $eq = index($_, $split);
  56         if ($hash != 0 && $eq >= 0) {
  57                 my $n = substr($_, 0, $eq);
  58                 my $v = substr($_, $eq+1);
  59                 chomp($v);
  60                 $_[1]->{$_[3] ? lc($n) : $n} = $v;
  61                 push(@{$_[2]}, $n) if ($_[2]);
  62                 }
  63         }
  64 close(ARFILE);
  65 $main::read_file_missing{$realfile} = 0;        # It exists now
  66 if (defined($main::read_file_cache{$realfile})) {
  67         %{$main::read_file_cache{$realfile}} = %{$_[1]};
  68         }
  69 return 1;
  70 }
  71
  72 =head2 read_file_cached(file, &hash, [&order], [lowercase], [split-char])
  73
  74 Like read_file, but reads from an in-memory cache if the file has already been
  75 read in this Webmin script. Recommended, as it behaves exactly the same as
  76 read_file, but can be much faster.
  77
  78 =cut
  79 sub read_file_cached
  80 {
  81 my $realfile = &translate_filename($_[0]);
  82 if (defined($main::read_file_cache{$realfile})) {
  83         # Use cached data
  84         %{$_[1]} = ( %{$_[1]}, %{$main::read_file_cache{$realfile}} );
  85         return 1;
  86         }
  87 elsif ($main::read_file_missing{$realfile}) {
  88         # Doesn't exist, so don't re-try read
  89         return 0;
  90         }
  91 else {
  92         # Actually read the file
  93         my %d;
  94         if (&read_file($_[0], \%d, $_[2], $_[3], $_[4])) {
  95                 %{$main::read_file_cache{$realfile}} = %d;
  96                 %{$_[1]} = ( %{$_[1]}, %d );
  97                 return 1;
  98                 }
  99         else {
 100                 # Flag as non-existant
 101                 $main::read_file_missing{$realfile} = 1;
 102                 return 0;
 103                 }
 104         }
 105 }
 106
 107 =head2 write_file(file, &hash, [join-char])
 108
 109 Write out the contents of a hash as name=value lines. The parameters are :
 110
 111 =item file - Full path to write to
 112
 113 =item hash - A hash reference containing names and values to output
 114
 115 =item join-char - If given, names and values are separated by this instead of =
 116
 117 =cut
 118 sub write_file
 119 {
 120 my (%old, @order);
 121 my $join = defined($_[2]) ? $_[2] : "=";
 122 my $realfile = &translate_filename($_[0]);
 123 &read_file($_[0], \%old, \@order);
 124 &open_tempfile(ARFILE, ">$_[0]");
 125 foreach $k (@order) {
 126         if (exists($_[1]->{$k})) {
 127                 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
 128                         &error(&text("efilewrite", $realfile, $!));
 129                 }
 130         }
 131 foreach $k (keys %{$_[1]}) {
 132         if (!exists($old{$k})) {
 133                 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
 134                         &error(&text("efilewrite", $realfile, $!));
 135                 }
 136         }
 137 &close_tempfile(ARFILE);
 138 if (defined($main::read_file_cache{$realfile})) {
 139         %{$main::read_file_cache{$realfile}} = %{$_[1]};
 140         }
 141 if (defined($main::read_file_missing{$realfile})) {
 142         $main::read_file_missing{$realfile} = 0;
 143         }
 144 }
 145
 146 =head2 html_escape(string)
 147
 148 Converts &, < and > codes in text to HTML entities, and returns the new string.
 149 This should be used when including data read from other sources in HTML pages.
 150
 151 =cut
 152 sub html_escape
 153 {
 154 my ($tmp) = @_;
 155 $tmp =~ s/&/&amp;/g;
 156 $tmp =~ s/</&lt;/g;
 157 $tmp =~ s/>/&gt;/g;
 158 $tmp =~ s/\"/&quot;/g;
 159 $tmp =~ s/\'/&#39;/g;
 160 $tmp =~ s/=/&#61;/g;
 161 return $tmp;
 162 }
 163
 164 =head2 quote_escape(string, [only-quote])
 165
 166 Converts ' and " characters in a string into HTML entities, and returns it.
 167 Useful for outputing HTML tag values.
 168
 169 =cut
 170 sub quote_escape
 171 {
 172 my ($tmp, $only) = @_;
 173 if ($tmp !~ /\&[a-zA-Z]+;/ && $tmp !~ /\&#/) {
 174         # convert &, unless it is part of &#nnn; or &foo;
 175         $tmp =~ s/&([^#])/&amp;$1/g;
 176         }
 177 $tmp =~ s/&$/&amp;/g;
 178 $tmp =~ s/\"/&quot;/g if ($only eq '' || $only eq '"');
 179 $tmp =~ s/\'/&#39;/g if ($only eq '' || $only eq "'");
 180 return $tmp;
 181 }
 182
 183 =head2 tempname([filename])
 184
 185 Returns a mostly random temporary file name, typically under the /tmp/.webmin
 186 directory. If filename is given, this will be the base name used. Otherwise
 187 a unique name is selected randomly.
 188
 189 =cut
 190 sub tempname
 191 {
 192 my $tmp_base = $gconfig{'tempdir_'.&get_module_name()} ?
 193                         $gconfig{'tempdir_'.&get_module_name()} :
 194                   $gconfig{'tempdir'} ? $gconfig{'tempdir'} :
 195                   $ENV{'TEMP'} ? $ENV{'TEMP'} :
 196                   $ENV{'TMP'} ? $ENV{'TMP'} :
 197                   -d "c:/temp" ? "c:/temp" : "/tmp/.webmin";
 198 my $tmp_dir = -d $remote_user_info[7] && !$gconfig{'nohometemp'} ?
 199                         "$remote_user_info[7]/.tmp" :
 200                  @remote_user_info ? $tmp_base."-".$remote_user :
 201                  $< != 0 ? $tmp_base."-".getpwuid($<) :
 202                                      $tmp_base;
 203 if ($gconfig{'os_type'} eq 'windows' || $tmp_dir =~ /^[a-z]:/i) {
 204         # On Windows system, just create temp dir if missing
 205         if (!-d $tmp_dir) {
 206                 mkdir($tmp_dir, 0755) ||
 207                         &error("Failed to create temp directory $tmp_dir : $!");
 208                 }
 209         }
 210 else {
 211         # On Unix systems, need to make sure temp dir is valid
 212         my $tries = 0;
 213         while($tries++ < 10) {
 214                 my @st = lstat($tmp_dir);
 215                 last if ($st[4] == $< && (-d _) && ($st[2] & 0777) == 0755);
 216                 if (@st) {
 217                         unlink($tmp_dir) || rmdir($tmp_dir) ||
 218                                 system("/bin/rm -rf ".quotemeta($tmp_dir));
 219                         }
 220                 mkdir($tmp_dir, 0755) || next;
 221                 chown($<, $(, $tmp_dir);
 222                 chmod(0755, $tmp_dir);
 223                 }
 224         if ($tries >= 10) {
 225                 my @st = lstat($tmp_dir);
 226                 &error("Failed to create temp directory $tmp_dir : uid=$st[4] mode=$st[2]");
 227                 }
 228         }
 229 my $rv;
 230 if (defined($_[0]) && $_[0] !~ /\.\./) {
 231         $rv = "$tmp_dir/$_[0]";
 232         }
 233 else {
 234         $main::tempfilecount++;
 235         &seed_random();
 236         $rv = $tmp_dir."/".int(rand(1000000))."_".
 237                $main::tempfilecount."_".$scriptname;
 238         }
 239 return $rv;
 240 }
 241
 242 =head2 transname([filename])
 243
 244 Behaves exactly like tempname, but records the temp file for deletion when the
 245 current Webmin script process exits.
 246
 247 =cut
 248 sub transname
 249 {
 250 my $rv = &tempname(@_);
 251 push(@main::temporary_files, $rv);
 252 return $rv;
 253 }
 254
 255 =head2 trunc(string, maxlen)
 256
 257 Truncates a string to the shortest whole word less than or equal to the
 258 given width. Useful for word wrapping.
 259
 260 =cut
 261 sub trunc
 262 {
 263 if (length($_[0]) <= $_[1]) {
 264         return $_[0];
 265         }
 266 my $str = substr($_[0],0,$_[1]);
 267 my $c;
 268 do {
 269         $c = chop($str);
 270         } while($c !~ /\S/);
 271 $str =~ s/\s+$//;
 272 return $str;
 273 }
 274
 275 =head2 indexof(string, value, ...)
 276
 277 Returns the index of some value in an array of values, or -1 if it was not
 278 found.
 279
 280 =cut
 281 sub indexof
 282 {
 283 for(my $i=1; $i <= $#_; $i++) {
 284         if ($_[$i] eq $_[0]) { return $i - 1; }
 285         }
 286 return -1;
 287 }
 288
 289 =head2 indexoflc(string, value, ...)
 290
 291 Like indexof, but does a case-insensitive match
 292
 293 =cut
 294 sub indexoflc
 295 {
 296 my $str = lc(shift(@_));
 297 my @arr = map { lc($_) } @_;
 298 return &indexof($str, @arr);
 299 }
 300
 301 =head2 sysprint(handle, [string]+)
 302
 303 Outputs some strings to a file handle, but bypassing IO buffering. Can be used
 304 as a replacement for print when writing to pipes or sockets.
 305
 306 =cut
 307 sub sysprint
 308 {
 309 my $fh = &callers_package($_[0]);
 310 my $str = join('', @_[1..$#_]);
 311 syswrite $fh, $str, length($str);
 312 }
 313
 314 =head2 check_ipaddress(ip)
 315
 316 Check if some IPv4 address is properly formatted, returning 1 if so or 0 if not.
 317
 318 =cut
 319 sub check_ipaddress
 320 {
 321 return $_[0] =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/ &&
 322         $1 >= 0 && $1 <= 255 &&
 323         $2 >= 0 && $2 <= 255 &&
 324         $3 >= 0 && $3 <= 255 &&
 325         $4 >= 0 && $4 <= 255;
 326 }
 327
 328 =head2 check_ip6address(ip)
 329
 330 Check if some IPv6 address is properly formatted, and returns 1 if so.
 331
 332 =cut
 333 sub check_ip6address
 334 {
 335   my @blocks = split(/:/, $_[0]);
 336   return 0 if (@blocks == 0 || @blocks > 8);
 337
 338   # The address/netmask format is accepted. So we're looking for a "/" to isolate a possible netmask.
 339   # After that, we delete the netmask to control the address only format, but we verify whether the netmask
 340   # value is in [0;128].
 341   my $ib = $#blocks;
 342   my $where = index($blocks[$ib],"/");
 343   my $m = 0;
 344   if ($where != -1) {
 345     my $b = substr($blocks[$ib],0,$where);
 346     $m = substr($blocks[$ib],$where+1,length($blocks[$ib])-($where+1));
 347     $blocks[$ib]=$b;
 348   }
 349
 350   # The netmask must take its value in [0;128]
 351   return 0 if ($m <0 || $m >128);
 352
 353   # Check the different blocks of the address : 16 bits block in hexa notation.
 354   # Possibility of 1 empty block or 2 if the address begins with "::".
 355   my $b;
 356   my $empty = 0;
 357   foreach $b (@blocks) {
 358           return 0 if ($b ne "" && $b !~ /^[0-9a-f]{1,4}$/i);
 359           $empty++ if ($b eq "");
 360           }
 361   return 0 if ($empty > 1 && !($_[0] =~ /^::/ && $empty == 2));
 362   return 1;
 363 }
 364
 365
 366
 367 =head2 generate_icon(image, title, link, [href], [width], [height], [before-title], [after-title])
 368
 369 Prints HTML for an icon image. The parameters are :
 370
 371 =item image - URL for the image, like images/foo.gif
 372
 373 =item title - Text to appear under the icon
 374
 375 =item link - Optional destination for the icon's link
 376
 377 =item href - Other HTML attributes to be added to the <a href> for the link
 378
 379 =item width - Optional width of the icon
 380
 381 =item height - Optional height of the icon
 382
 383 =item before-title - HTML to appear before the title link, but which is not actually in the link
 384
 385 =item after-title - HTML to appear after the title link, but which is not actually in the link
 386
 387 =cut
 388 sub generate_icon
 389 {
 390 &load_theme_library();
 391 if (defined(&theme_generate_icon)) {
 392         &theme_generate_icon(@_);
 393         return;
 394         }
 395 my $w = !defined($_[4]) ? "width=48" : $_[4] ? "width=$_[4]" : "";
 396 my $h = !defined($_[5]) ? "height=48" : $_[5] ? "height=$_[5]" : "";
 397 if ($tconfig{'noicons'}) {
 398         if ($_[2]) {
 399                 print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
 400                 }
 401         else {
 402                 print "$_[6]$_[1]$_[7]\n";
 403                 }
 404         }
 405 elsif ($_[2]) {
 406         print "<table border><tr><td width=48 height=48>\n",
 407               "<a href=\"$_[2]\" $_[3]><img src=\"$_[0]\" alt=\"\" border=0 ",
 408               "$w $h></a></td></tr></table>\n";
 409         print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
 410         }
 411 else {
 412         print "<table border><tr><td width=48 height=48>\n",
 413               "<img src=\"$_[0]\" alt=\"\" border=0 $w $h>",
 414               "</td></tr></table>\n$_[6]$_[1]$_[7]\n";
 415         }
 416 }
 417
 418 =head2 urlize
 419
 420 Converts a string to a form ok for putting in a URL, using % escaping.
 421
 422 =cut
 423 sub urlize
 424 {
 425 my ($rv) = @_;
 426 $rv =~ s/([^A-Za-z0-9])/sprintf("%%%2.2X", ord($1))/ge;
 427 return $rv;
 428 }
 429
 430 =head2 un_urlize(string)
 431
 432 Converts a URL-encoded string to it's original contents - the reverse of the
 433 urlize function.
 434
 435 =cut
 436 sub un_urlize
 437 {
 438 my ($rv) = @_;
 439 $rv =~ s/\+/ /g;
 440 $rv =~ s/%(..)/pack("c",hex($1))/ge;
 441 return $rv;
 442 }
 443
 444 =head2 include(filename)
 445
 446 Read and output the contents of the given file.
 447
 448 =cut
 449 sub include
 450 {
 451 local $_;
 452 open(INCLUDE, &translate_filename($_[0])) || return 0;
 453 while(<INCLUDE>) {
 454         print;
 455         }
 456 close(INCLUDE);
 457 return 1;
 458 }
 459
 460 =head2 copydata(in-handle, out-handle)
 461
 462 Read from one file handle and write to another, until there is no more to read.
 463
 464 =cut
 465 sub copydata
 466 {
 467 my ($in, $out) = @_;
 468 $in = &callers_package($in);
 469 $out = &callers_package($out);
 470 my $buf;
 471 while(read($in, $buf, 1024) > 0) {
 472         (print $out $buf) || return 0;
 473         }
 474 return 1;
 475 }
 476
 477 =head2 ReadParseMime([maximum], [&cbfunc, &cbargs])
 478
 479 Read data submitted via a POST request using the multipart/form-data coding,
 480 and store it in the global %in hash. The optional parameters are :
 481
 482 =item maximum - If the number of bytes of input exceeds this number, stop reading and call error.
 483
 484 =item cbfunc - A function reference to call after reading each block of data.
 485
 486 =item cbargs - Additional parameters to the callback function.
 487
 488 =cut
 489 sub ReadParseMime
 490 {
 491 my ($max, $cbfunc, $cbargs) = @_;
 492 my ($boundary, $line, $foo, $name, $got, $file);
 493 my $err = &text('readparse_max', $max);
 494 $ENV{'CONTENT_TYPE'} =~ /boundary=(.*)$/ || &error($text{'readparse_enc'});
 495 if ($ENV{'CONTENT_LENGTH'} && $max && $ENV{'CONTENT_LENGTH'} > $max) {
 496         &error($err);
 497         }
 498 &$cbfunc(0, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
 499 $boundary = $1;
 500 <STDIN>;        # skip first boundary
 501 while(1) {
 502         $name = "";
 503         # Read section headers
 504         my $lastheader;
 505         while(1) {
 506                 $line = <STDIN>;
 507                 $got += length($line);
 508                 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, @$cbargs) if ($cbfunc);
 509                 if ($max && $got > $max) {
 510                         &error($err)
 511                         }
 512                 $line =~ tr/\r\n//d;
 513                 last if (!$line);
 514                 if ($line =~ /^(\S+):\s*(.*)$/) {
 515                         $header{$lastheader = lc($1)} = $2;
 516                         }
 517                 elsif ($line =~ /^\s+(.*)$/) {
 518                         $header{$lastheader} .= $line;
 519                         }
 520                 }
 521
 522         # Parse out filename and type
 523         if ($header{'content-disposition'} =~ /^form-data(.*)/) {
 524                 $rest = $1;
 525                 while ($rest =~ /([a-zA-Z]*)=\"([^\"]*)\"(.*)/) {
 526                         if ($1 eq 'name') {
 527                                 $name = $2;
 528                                 }
 529                         else {
 530                                 $foo = $name . "_$1";
 531                                 $in{$foo} = $2;
 532                                 }
 533                         $rest = $3;
 534                         }
 535                 }
 536         else {
 537                 &error($text{'readparse_cdheader'});
 538                 }
 539         if ($header{'content-type'} =~ /^([^\s;]+)/) {
 540                 $foo = $name . "_content_type";
 541                 $in{$foo} = $1;
 542                 }
 543         $file = $in{$name."_filename"};
 544
 545         # Read data
 546         $in{$name} .= "\0" if (defined($in{$name}));
 547         while(1) {
 548                 $line = <STDIN>;
 549                 $got += length($line);
 550                 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
 551                         if ($cbfunc);
 552                 if ($max && $got > $max) {
 553                         #print STDERR "over limit of $max\n";
 554                         #&error($err);
 555                         }
 556                 if (!$line) {
 557                         # Unexpected EOF?
 558                         &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
 559                                 if ($cbfunc);
 560                         return;
 561                         }
 562                 my $ptline = $line;
 563                 $ptline =~ s/[^a-zA-Z0-9\-]/\./g;
 564                 if (index($line, $boundary) != -1) { last; }
 565                 $in{$name} .= $line;
 566                 }
 567         chop($in{$name}); chop($in{$name});
 568         if (index($line,"$boundary--") != -1) { last; }
 569         }
 570 &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
 571 }
 572
 573 =head2 ReadParse([&hash], [method], [noplus])
 574
 575 Fills the given hash reference with CGI parameters, or uses the global hash
 576 %in if none is given. Also sets the global variables $in and @in. The other
 577 parameters are :
 578
 579 =item method - For use of this HTTP method, such as GET
 580
 581 =item noplus - Don't convert + in parameters to spaces.
 582
 583 =cut
 584 sub ReadParse
 585 {
 586 my $a = $_[0] || \%in;
 587 %$a = ( );
 588 my $meth = $_[1] ? $_[1] : $ENV{'REQUEST_METHOD'};
 589 undef($in);
 590 if ($meth eq 'POST') {
 591         my $clen = $ENV{'CONTENT_LENGTH'};
 592         &read_fully(STDIN, \$in, $clen) == $clen ||
 593                 &error("Failed to read POST input : $!");
 594         }
 595 if ($ENV{'QUERY_STRING'}) {
 596         if ($in) { $in .= "&".$ENV{'QUERY_STRING'}; }
 597         else { $in = $ENV{'QUERY_STRING'}; }
 598         }
 599 @in = split(/\&/, $in);
 600 foreach my $i (@in) {
 601         my ($k, $v) = split(/=/, $i, 2);
 602         if (!$_[2]) {
 603                 $k =~ tr/\+/ /;
 604                 $v =~ tr/\+/ /;
 605                 }
 606         $k =~ s/%(..)/pack("c",hex($1))/ge;
 607         $v =~ s/%(..)/pack("c",hex($1))/ge;
 608         $a->{$k} = defined($a->{$k}) ? $a->{$k}."\0".$v : $v;
 609         }
 610 }
 611
 612 =head2 read_fully(fh, &buffer, length)
 613
 614 Read data from some file handle up to the given length, even in the face
 615 of partial reads. Reads the number of bytes read. Stores received data in the
 616 string pointed to be the buffer reference.
 617
 618 =cut
 619 sub read_fully
 620 {
 621 my ($fh, $buf, $len) = @_;
 622 $fh = &callers_package($fh);
 623 my $got = 0;
 624 while($got < $len) {
 625         my $r = read(STDIN, $$buf, $len-$got, $got);
 626         last if ($r <= 0);
 627         $got += $r;
 628         }
 629 return $got;
 630 }
 631
 632 =head2 read_parse_mime_callback(size, totalsize, upload-id)
 633
 634 Called by ReadParseMime as new data arrives from a form-data POST. Only updates
 635 the file on every 1% change though. For internal use by the upload progress
 636 tracker.
 637
 638 =cut
 639 sub read_parse_mime_callback
 640 {
 641 my ($size, $totalsize, $filename, $id) = @_;
 642 return if ($gconfig{'no_upload_tracker'});
 643 return if (!$id);
 644
 645 # Create the upload tracking directory - if running as non-root, this has to
 646 # be under the user's home
 647 my $vardir;
 648 if ($<) {
 649         my @uinfo = @remote_user_info ? @remote_user_info : getpwuid($<);
 650         $vardir = "$uinfo[7]/.tmp";
 651         }
 652 else {
 653         $vardir = $ENV{'WEBMIN_VAR'};
 654         }
 655 if (!-d $vardir) {
 656         &make_dir($vardir, 0755);
 657         }
 658
 659 # Remove any upload.* files more than 1 hour old
 660 if (!$main::read_parse_mime_callback_flushed) {
 661         my $now = time();
 662         opendir(UPDIR, $vardir);
 663         foreach my $f (readdir(UPDIR)) {
 664                 next if ($f !~ /^upload\./);
 665                 my @st = stat("$vardir/$f");
 666                 if ($st[9] < $now-3600) {
 667                         unlink("$vardir/$f");
 668                         }
 669                 }
 670         closedir(UPDIR);
 671         $main::read_parse_mime_callback_flushed++;
 672         }
 673
 674 # Only update file once per percent
 675 my $upfile = "$vardir/upload.$id";
 676 if ($totalsize && $size >= 0) {
 677         my $pc = int(100 * $size / $totalsize);
 678         if ($pc <= $main::read_parse_mime_callback_pc{$upfile}) {
 679                 return;
 680                 }
 681         $main::read_parse_mime_callback_pc{$upfile} = $pc;
 682         }
 683
 684 # Write to the file
 685 &open_tempfile(UPFILE, ">$upfile");
 686 print UPFILE $size,"\n";
 687 print UPFILE $totalsize,"\n";
 688 print UPFILE $filename,"\n";
 689 &close_tempfile(UPFILE);
 690 }
 691
 692 =head2 read_parse_mime_javascript(upload-id, [&fields])
 693
 694 Returns an onSubmit= Javascript statement to popup a window for tracking
 695 an upload with the given ID. For internal use by the upload progress tracker.
 696
 697 =cut
 698 sub read_parse_mime_javascript
 699 {
 700 my ($id, $fields) = @_;
 701 return "" if ($gconfig{'no_upload_tracker'});
 702 my $opener = "window.open(\"$gconfig{'webprefix'}/uptracker.cgi?id=$id&uid=$<\", \"uptracker\", \"toolbar=no,menubar=no,scrollbars=no,width=500,height=100\");";
 703 if ($fields) {
 704         my $if = join(" || ", map { "typeof($_) != \"undefined\" && $_.value != \"\"" } @$fields);
 705         return "onSubmit='if ($if) { $opener }'";
 706         }
 707 else {
 708         return "onSubmit='$opener'";
 709         }
 710 }
 711
 712 =head2 PrintHeader(charset)
 713
 714 Outputs the HTTP headers for an HTML page. The optional charset parameter
 715 can be used to set a character set. Normally this function is not called
 716 directly, but is rather called by ui_print_header or header.
 717
 718 =cut
 719 sub PrintHeader
 720 {
 721 if ($pragma_no_cache || $gconfig{'pragma_no_cache'}) {
 722         print "pragma: no-cache\n";
 723         print "Expires: Thu, 1 Jan 1970 00:00:00 GMT\n";
 724         print "Cache-Control: no-store, no-cache, must-revalidate\n";
 725         print "Cache-Control: post-check=0, pre-check=0\n";
 726         }
 727 if (defined($_[0])) {
 728         print "Content-type: text/html; Charset=$_[0]\n\n";
 729         }
 730 else {
 731         print "Content-type: text/html\n\n";
 732         }
 733 }
 734
 735 =head2 header(title, image, [help], [config], [nomodule], [nowebmin], [rightside], [head-stuff], [body-stuff], [below])
 736
 737 Outputs a Webmin HTML page header with a title, including HTTP headers. The
 738 parameters are :
 739
 740 =item title - The text to show at the top of the page
 741
 742 =item image - An image to show instead of the title text. This is typically left blank.
 743
 744 =item help - If set, this is the name of a help page that will be linked to in the title.
 745
 746 =item config - If set to 1, the title will contain a link to the module's config page.
 747
 748 =item nomodule - If set to 1, there will be no link in the title section to the module's index.
 749
 750 =item nowebmin - If set to 1, there will be no link in the title section to the Webmin index.
 751
 752 =item rightside - HTML to be shown on the right-hand side of the title. Can contain multiple lines, separated by <br>. Typically this is used for links to stop, start or restart servers.
 753
 754 =item head-stuff - HTML to be included in the <head> section of the page.
 755
 756 =item body-stuff - HTML attributes to be include in the <body> tag.
 757
 758 =item below - HTML to be displayed below the title. Typically this is used for application or server version information.
 759
 760 =cut
 761 sub header
 762 {
 763 return if ($main::done_webmin_header++);
 764 my $ll;
 765 my $charset = defined($main::force_charset) ? $main::force_charset
 766                                             : &get_charset();
 767 &PrintHeader($charset);
 768 &load_theme_library();
 769 if (defined(&theme_header)) {
 770         $module_name = &get_module_name();
 771         &theme_header(@_);
 772         return;
 773         }
 774 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
 775 print "<html>\n";
 776 print "<head>\n";
 777 if (defined(&theme_prehead)) {
 778         &theme_prehead(@_);
 779         }
 780 if ($charset) {
 781         print "<meta http-equiv=\"Content-Type\" ",
 782               "content=\"text/html; Charset=".&quote_escape($charset)."\">\n";
 783         }
 784 if (@_ > 0) {
 785         my $title = &get_html_title($_[0]);
 786         print "<title>$title</title>\n";
 787         print $_[7] if ($_[7]);
 788         print &get_html_status_line(0);
 789         }
 790 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
 791 if ($tconfig{'headinclude'}) {
 792         local $_;
 793         open(INC, "$theme_root_directory/$tconfig{'headinclude'}");
 794         while(<INC>) {
 795                 print;
 796                 }
 797         close(INC);
 798         }
 799 print "</head>\n";
 800 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
 801                  defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
 802 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
 803               defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
 804 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
 805               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
 806 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
 807                                               : "";
 808 my $dir = $current_lang_info->{'dir'} ? "dir=\"$current_lang_info->{'dir'}\""
 809                                          : "";
 810 print "<body bgcolor=#$bgcolor link=#$link vlink=#$link text=#$text ",
 811       "$bgimage $tconfig{'inbody'} $dir $_[8]>\n";
 812 if (defined(&theme_prebody)) {
 813         &theme_prebody(@_);
 814         }
 815 my $hostname = &get_display_hostname();
 816 my $version = &get_webmin_version();
 817 my $prebody = $tconfig{'prebody'};
 818 if ($prebody) {
 819         $prebody =~ s/%HOSTNAME%/$hostname/g;
 820         $prebody =~ s/%VERSION%/$version/g;
 821         $prebody =~ s/%USER%/$remote_user/g;
 822         $prebody =~ s/%OS%/$os_type $os_version/g;
 823         print "$prebody\n";
 824         }
 825 if ($tconfig{'prebodyinclude'}) {
 826         local $_;
 827         open(INC, "$theme_root_directory/$tconfig{'prebodyinclude'}");
 828         while(<INC>) {
 829                 print;
 830                 }
 831         close(INC);
 832         }
 833 if (@_ > 1) {
 834         print $tconfig{'preheader'};
 835         my %this_module_info = &get_module_info(&get_module_name());
 836         print "<table class='header' width=100%><tr>\n";
 837         if ($gconfig{'sysinfo'} == 2 && $remote_user) {
 838                 print "<td id='headln1' colspan=3 align=center>\n";
 839                 print &get_html_status_line(1);
 840                 print "</td></tr> <tr>\n";
 841                 }
 842         print "<td id='headln2l' width=15% valign=top align=left>";
 843         if ($ENV{'HTTP_WEBMIN_SERVERS'} && !$tconfig{'framed'}) {
 844                 print "<a href='$ENV{'HTTP_WEBMIN_SERVERS'}'>",
 845                       "$text{'header_servers'}</a><br>\n";
 846                 }
 847         if (!$_[5] && !$tconfig{'noindex'}) {
 848                 my @avail = &get_available_module_infos(1);
 849                 my $nolo = $ENV{'ANONYMOUS_USER'} ||
 850                               $ENV{'SSL_USER'} || $ENV{'LOCAL_USER'} ||
 851                               $ENV{'HTTP_USER_AGENT'} =~ /webmin/i;
 852                 if ($gconfig{'gotoone'} && $main::session_id && @avail == 1 &&
 853                     !$nolo) {
 854                         print "<a href='$gconfig{'webprefix'}/session_login.cgi?logout=1'>",
 855                               "$text{'main_logout'}</a><br>";
 856                         }
 857                 elsif ($gconfig{'gotoone'} && @avail == 1 && !$nolo) {
 858                         print "<a href=$gconfig{'webprefix'}/switch_user.cgi>",
 859                               "$text{'main_switch'}</a><br>";
 860                         }
 861                 elsif (!$gconfig{'gotoone'} || @avail > 1) {
 862                         print "<a href='$gconfig{'webprefix'}/?cat=",
 863                               $this_module_info{'category'},
 864                               "'>$text{'header_webmin'}</a><br>\n";
 865                         }
 866                 }
 867         if (!$_[4] && !$tconfig{'nomoduleindex'}) {
 868                 my $idx = $this_module_info{'index_link'};
 869                 my $mi = $module_index_link || "/".&get_module_name()."/$idx";
 870                 my $mt = $module_index_name || $text{'header_module'};
 871                 print "<a href=\"$gconfig{'webprefix'}$mi\">$mt</a><br>\n";
 872                 }
 873         if (ref($_[2]) eq "ARRAY" && !$ENV{'ANONYMOUS_USER'} &&
 874             !$tconfig{'nohelp'}) {
 875                 print &hlink($text{'header_help'}, $_[2]->[0], $_[2]->[1]),
 876                       "<br>\n";
 877                 }
 878         elsif (defined($_[2]) && !$ENV{'ANONYMOUS_USER'} &&
 879                !$tconfig{'nohelp'}) {
 880                 print &hlink($text{'header_help'}, $_[2]),"<br>\n";
 881                 }
 882         if ($_[3]) {
 883                 my %access = &get_module_acl();
 884                 if (!$access{'noconfig'} && !$config{'noprefs'}) {
 885                         my $cprog = $user_module_config_directory ?
 886                                         "uconfig.cgi" : "config.cgi";
 887                         print "<a href=\"$gconfig{'webprefix'}/$cprog?",
 888                               &get_module_name()."\">",
 889                               $text{'header_config'},"</a><br>\n";
 890                         }
 891                 }
 892         print "</td>\n";
 893         if ($_[1]) {
 894                 # Title is a single image
 895                 print "<td id='headln2c' align=center width=70%>",
 896                       "<img alt=\"$_[0]\" src=\"$_[1]\"></td>\n";
 897                 }
 898         else {
 899                 # Title is just text
 900                 my $ts = defined($tconfig{'titlesize'}) ?
 901                                 $tconfig{'titlesize'} : "+2";
 902                 print "<td id='headln2c' align=center width=70%>",
 903                       ($ts ? "<font size=$ts>" : ""),$_[0],
 904                       ($ts ? "</font>" : "");
 905                 print "<br>$_[9]\n" if ($_[9]);
 906                 print "</td>\n";
 907                 }
 908         print "<td id='headln2r' width=15% valign=top align=right>";
 909         print $_[6];
 910         print "</td></tr></table>\n";
 911         print $tconfig{'postheader'};
 912         }
 913 }
 914
 915 =head2 get_html_title(title)
 916
 917 Returns the full string to appear in the HTML <title> block.
 918
 919 =cut
 920 sub get_html_title
 921 {
 922 my ($msg) = @_;
 923 my $title;
 924 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
 925 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
 926 my $host = &get_display_hostname();
 927 if ($gconfig{'sysinfo'} == 1 && $remote_user) {
 928         $title = sprintf "%s : %s on %s (%s %s)\n",
 929                 $msg, $remote_user, $host,
 930                 $os_type, $os_version;
 931         }
 932 elsif ($gconfig{'sysinfo'} == 4 && $remote_user) {
 933         $title = sprintf "%s on %s (%s %s)\n",
 934                 $remote_user, $host,
 935                 $os_type, $os_version;
 936         }
 937 else {
 938         $title = $msg;
 939         }
 940 if ($gconfig{'showlogin'} && $remote_user) {
 941         $title = $remote_user." : ".$title;
 942         }
 943 if ($gconfig{'showhost'}) {
 944         $title = $host." : ".$title;
 945         }
 946 return $title;
 947 }
 948
 949 =head2 get_html_framed_title
 950
 951 Returns the title text for a framed theme main page.
 952
 953 =cut
 954 sub get_html_framed_title
 955 {
 956 my $ostr;
 957 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
 958 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
 959 my $title;
 960 if (($gconfig{'sysinfo'} == 4 || $gconfig{'sysinfo'} == 1) && $remote_user) {
 961         # Alternate title mode requested
 962         $title = sprintf "%s on %s (%s %s)\n",
 963                 $remote_user, &get_display_hostname(),
 964                 $os_type, $os_version;
 965         }
 966 else {
 967         # Title like 'Webmin x.yy on hostname (Linux 6)'
 968         if ($os_version eq "*") {
 969                 $ostr = $os_type;
 970                 }
 971         else {
 972                 $ostr = "$os_type $os_version";
 973                 }
 974         my $host = &get_display_hostname();
 975         my $ver = &get_webmin_version();
 976         $title = $gconfig{'nohostname'} ? $text{'main_title2'} :
 977                  $gconfig{'showhost'} ? &text('main_title3', $ver, $ostr) :
 978                                         &text('main_title', $ver, $host, $ostr);
 979         if ($gconfig{'showlogin'}) {
 980                 $title = $remote_user." : ".$title;
 981                 }
 982         if ($gconfig{'showhost'}) {
 983                 $title = $host." : ".$title;
 984                 }
 985         }
 986 return $title;
 987 }
 988
 989 =head2 get_html_status_line(text-only)
 990
 991 Returns HTML for a script block that sets the status line, or if text-only
 992 is set to 1, just return the status line text.
 993
 994 =cut
 995 sub get_html_status_line
 996 {
 997 my ($textonly) = @_;
 998 if (($gconfig{'sysinfo'} != 0 || !$remote_user) && !$textonly) {
 999         # Disabled in this mode
1000         return undef;
1001         }
1002 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
1003 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
1004 my $line = &text('header_statusmsg',
1005                  ($ENV{'ANONYMOUS_USER'} ? "Anonymous user"
1006                                            : $remote_user).
1007                  ($ENV{'SSL_USER'} ? " (SSL certified)" :
1008                   $ENV{'LOCAL_USER'} ? " (Local user)" : ""),
1009                  $text{'programname'},
1010                  &get_webmin_version(),
1011                  &get_display_hostname(),
1012                  $os_type.($os_version eq "*" ? "" :" $os_version"));
1013 if ($textonly) {
1014         return $line;
1015         }
1016 else {
1017         $line =~ s/\r|\n//g;
1018         return "<script language=JavaScript type=text/javascript>\n".
1019                "defaultStatus=\"".&quote_escape($line)."\";\n".
1020                "</script>\n";
1021         }
1022 }
1023
1024 =head2 popup_header([title], [head-stuff], [body-stuff])
1025
1026 Outputs a page header, suitable for a popup window. If no title is given,
1027 absolutely no decorations are output. Also useful in framesets. The parameters
1028 are :
1029
1030 =item title - Title text for the popup window.
1031
1032 =item head-stuff - HTML to appear in the <head> section.
1033
1034 =item body-stuff - HTML attributes to be include in the <body> tag.
1035
1036 =cut
1037 sub popup_header
1038 {
1039 return if ($main::done_webmin_header++);
1040 my $ll;
1041 my $charset = defined($main::force_charset) ? $main::force_charset
1042                                             : &get_charset();
1043 &PrintHeader($charset);
1044 &load_theme_library();
1045 if (defined(&theme_popup_header)) {
1046         &theme_popup_header(@_);
1047         return;
1048         }
1049 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
1050 print "<html>\n";
1051 print "<head>\n";
1052 if (defined(&theme_popup_prehead)) {
1053         &theme_popup_prehead(@_);
1054         }
1055 print "<title>$_[0]</title>\n";
1056 print $_[1];
1057 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
1058 if ($tconfig{'headinclude'}) {
1059         local $_;
1060         open(INC, "$theme_root_directory/$tconfig{'headinclude'}");
1061         while(<INC>) {
1062                 print;
1063                 }
1064         close(INC);
1065         }
1066 print "</head>\n";
1067 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
1068                  defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
1069 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
1070               defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
1071 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1072               defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1073 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
1074                                               : "";
1075 print "<body id='popup' bgcolor=#$bgcolor link=#$link vlink=#$link ",
1076       "text=#$text $bgimage $tconfig{'inbody'} $_[2]>\n";
1077 if (defined(&theme_popup_prebody)) {
1078         &theme_popup_prebody(@_);
1079         }
1080 }
1081
1082 =head2 footer([page, name]+, [noendbody])
1083
1084 Outputs the footer for a Webmin HTML page, possibly with links back to other
1085 pages. The links are specified by pairs of parameters, the first of which is
1086 a link destination, and the second the link text. For example :
1087
1088  footer('/', 'Webmin index', '', 'Module menu');
1089
1090 =cut
1091 sub footer
1092 {
1093 &load_theme_library();
1094 my %this_module_info = &get_module_info(&get_module_name());
1095 if (defined(&theme_footer)) {
1096         $module_name = &get_module_name();      # Old themes use these
1097         %module_info = %this_module_info;
1098         &theme_footer(@_);
1099         return;
1100         }
1101 for(my $i=0; $i+1<@_; $i+=2) {
1102         my $url = $_[$i];
1103         if ($url ne '/' || !$tconfig{'noindex'}) {
1104                 if ($url eq '/') {
1105                         $url = "/?cat=$this_module_info{'category'}";
1106                         }
1107                 elsif ($url eq '' && &get_module_name()) {
1108                         $url = "/".&get_module_name()."/".
1109                                $this_module_info{'index_link'};
1110                         }
1111                 elsif ($url =~ /^\?/ && &get_module_name()) {
1112                         $url = "/".&get_module_name()."/$url";
1113                         }
1114                 $url = "$gconfig{'webprefix'}$url" if ($url =~ /^\//);
1115                 if ($i == 0) {
1116                         print "<a href=\"$url\"><img alt=\"<-\" align=middle border=0 src=$gconfig{'webprefix'}/images/left.gif></a>\n";
1117                         }
1118                 else {
1119                         print "&nbsp;|\n";
1120                         }
1121                 print "&nbsp;<a href=\"$url\">",&text('main_return', $_[$i+1]),"</a>\n";
1122                 }
1123         }
1124 print "<br>\n";
1125 if (!$_[$i]) {
1126         my $postbody = $tconfig{'postbody'};
1127         if ($postbody) {
1128                 my $hostname = &get_display_hostname();
1129                 my $version = &get_webmin_version();
1130                 my $os_type = $gconfig{'real_os_type'} ||
1131                               $gconfig{'os_type'};
1132                 my $os_version = $gconfig{'real_os_version'} ||
1133                                  $gconfig{'os_version'};
1134                 $postbody =~ s/%HOSTNAME%/$hostname/g;
1135                 $postbody =~ s/%VERSION%/$version/g;
1136                 $postbody =~ s/%USER%/$remote_user/g;
1137                 $postbody =~ s/%OS%/$os_type $os_version/g;
1138                 print "$postbody\n";
1139                 }
1140         if ($tconfig{'postbodyinclude'}) {
1141                 local $_;
1142                 open(INC, "$theme_root_directory/$tconfig{'postbodyinclude'}");
1143                 while(<INC>) {
1144                         print;
1145                         }
1146                 close(INC);
1147                 }
1148         if (defined(&theme_postbody)) {
1149                 &theme_postbody(@_);
1150                 }
1151         print "</body></html>\n";
1152         }
1153 }
1154
1155 =head2 popup_footer
1156
1157 Outputs html for a footer for a popup window, started by popup_header.
1158
1159 =cut
1160 sub popup_footer
1161 {
1162 &load_theme_library();
1163 if (defined(&theme_popup_footer)) {
1164         &theme_popup_footer(@_);
1165         return;
1166         }
1167 print "</body></html>\n";
1168 }
1169
1170 =head2 load_theme_library
1171
1172 Immediately loads the current theme's theme.pl file. Not generally useful for
1173 most module developers, as this is called automatically by the header function.
1174
1175 =cut
1176 sub load_theme_library
1177 {
1178 return if (!$current_theme || $loaded_theme_library++);
1179 for(my $i=0; $i<@theme_root_directories; $i++) {
1180         if ($theme_configs[$i]->{'functions'}) {
1181                 do $theme_root_directories[$i]."/".
1182                    $theme_configs[$i]->{'functions'};
1183                 }
1184         }
1185 }
1186
1187 =head2 redirect(url)
1188
1189 Output HTTP headers to redirect the browser to some page. The url parameter is
1190 typically a relative URL like index.cgi or list_users.cgi.
1191
1192 =cut
1193 sub redirect
1194 {
1195 my $port = $ENV{'SERVER_PORT'} == 443 && uc($ENV{'HTTPS'}) eq "ON" ? "" :
1196            $ENV{'SERVER_PORT'} == 80 && uc($ENV{'HTTPS'}) ne "ON" ? "" :
1197                 ":$ENV{'SERVER_PORT'}";
1198 my $prot = uc($ENV{'HTTPS'}) eq "ON" ? "https" : "http";
1199 my $wp = $gconfig{'webprefixnoredir'} ? undef : $gconfig{'webprefix'};
1200 my $url;
1201 if ($_[0] =~ /^(http|https|ftp|gopher):/) {
1202         # Absolute URL (like http://...)
1203         $url = $_[0];
1204         }
1205 elsif ($_[0] =~ /^\//) {
1206         # Absolute path (like /foo/bar.cgi)
1207         $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$_[0]";
1208         }
1209 elsif ($ENV{'SCRIPT_NAME'} =~ /^(.*)\/[^\/]*$/) {
1210         # Relative URL (like foo.cgi)
1211         $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$1/$_[0]";
1212         }
1213 else {
1214         $url = "$prot://$ENV{'SERVER_NAME'}$port/$wp$_[0]";
1215         }
1216 &load_theme_library();
1217 if (defined(&theme_redirect)) {
1218         $module_name = &get_module_name();      # Old themes use these
1219         %module_info = &get_module_info($module_name);
1220         &theme_redirect($_[0], $url);
1221         }
1222 else {
1223         print "Location: $url\n\n";
1224         }
1225 }
1226
1227 =head2 kill_byname(name, signal)
1228
1229 Finds a process whose command line contains the given name (such as httpd), and
1230 sends some signal to it. The signal can be numeric (like 9) or named
1231 (like KILL).
1232
1233 =cut
1234 sub kill_byname
1235 {
1236 my @pids = &find_byname($_[0]);
1237 return scalar(@pids) if (&is_readonly_mode());
1238 &webmin_debug_log('KILL', "signal=$_[1] name=$_[0]")
1239         if ($gconfig{'debug_what_procs'});
1240 if (@pids) { kill($_[1], @pids); return scalar(@pids); }
1241 else { return 0; }
1242 }
1243
1244 =head2 kill_byname_logged(name, signal)
1245
1246 Like kill_byname, but also logs the killing.
1247
1248 =cut
1249 sub kill_byname_logged
1250 {
1251 my @pids = &find_byname($_[0]);
1252 return scalar(@pids) if (&is_readonly_mode());
1253 if (@pids) { &kill_logged($_[1], @pids); return scalar(@pids); }
1254 else { return 0; }
1255 }
1256
1257 =head2 find_byname(name)
1258
1259 Finds processes searching for the given name in their command lines, and
1260 returns a list of matching PIDs.
1261
1262 =cut
1263 sub find_byname
1264 {
1265 if ($gconfig{'os_type'} =~ /-linux$/ && -r "/proc/$$/cmdline") {
1266         # Linux with /proc filesystem .. use cmdline files, as this is
1267         # faster than forking
1268         my @pids;
1269         opendir(PROCDIR, "/proc");
1270         foreach my $f (readdir(PROCDIR)) {
1271                 if ($f eq int($f) && $f != $$) {
1272                         my $line = &read_file_contents("/proc/$f/cmdline");
1273                         if ($line =~ /$_[0]/) {
1274                                 push(@pids, $f);
1275                                 }
1276                         }
1277                 }
1278         closedir(PROCDIR);
1279         return @pids;
1280         }
1281
1282 if (&foreign_check("proc")) {
1283         # Call the proc module
1284         &foreign_require("proc", "proc-lib.pl");
1285         if (defined(&proc::list_processes)) {
1286                 my @procs = &proc::list_processes();
1287                 my @pids;
1288                 foreach my $p (@procs) {
1289                         if ($p->{'args'} =~ /$_[0]/) {
1290                                 push(@pids, $p->{'pid'});
1291                                 }
1292                         }
1293                 @pids = grep { $_ != $$ } @pids;
1294                 return @pids;
1295                 }
1296         }
1297
1298 # Fall back to running a command
1299 my ($cmd, @pids);
1300 $cmd = $gconfig{'find_pid_command'};
1301 $cmd =~ s/NAME/"$_[0]"/g;
1302 $cmd = &translate_command($cmd);
1303 @pids = split(/\n/, `($cmd) <$null_file 2>$null_file`);
1304 @pids = grep { $_ != $$ } @pids;
1305 return @pids;
1306 }
1307
1308 =head2 error([message]+)
1309
1310 Display an error message and exit. This should be used by CGI scripts that
1311 encounter a fatal error or invalid user input to notify users of the problem.
1312 If error_setup has been called, the displayed error message will be prefixed
1313 by the message setup using that function.
1314
1315 =cut
1316 sub error
1317 {
1318 my $msg = join("", @_);
1319 $msg =~ s/<[^>]*>//g;
1320 if (!$main::error_must_die) {
1321         print STDERR "Error: ",$msg,"\n";
1322         }
1323 &load_theme_library();
1324 if ($main::error_must_die) {
1325         if ($gconfig{'error_stack'}) {
1326                 print STDERR "Error: ",$msg,"\n";
1327                 for(my $i=0; my @stack = caller($i); $i++) {
1328                         print STDERR "File: $stack[1] Line: $stack[2] ",
1329                                      "Function: $stack[3]\n";
1330                         }
1331                 }
1332         die @_;
1333         }
1334 elsif (!$ENV{'REQUEST_METHOD'}) {
1335         # Show text-only error
1336         print STDERR "$text{'error'}\n";
1337         print STDERR "-----\n";
1338         print STDERR ($main::whatfailed ? "$main::whatfailed : " : ""),
1339                      $msg,"\n";
1340         print STDERR "-----\n";
1341         if ($gconfig{'error_stack'}) {
1342                 # Show call stack
1343                 print STDERR $text{'error_stack'},"\n";
1344                 for(my $i=0; my @stack = caller($i); $i++) {
1345                         print STDERR &text('error_stackline',
1346                                 $stack[1], $stack[2], $stack[3]),"\n";
1347                         }
1348                 }
1349
1350         }
1351 elsif (defined(&theme_error)) {
1352         &theme_error(@_);
1353         }
1354 else {
1355         &header($text{'error'}, "");
1356         print "<hr>\n";
1357         print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),
1358                      @_,"</h3>\n";
1359         if ($gconfig{'error_stack'}) {
1360                 # Show call stack
1361                 print "<h3>$text{'error_stack'}</h3>\n";
1362                 print "<table>\n";
1363                 print "<tr> <td><b>$text{'error_file'}</b></td> ",
1364                       "<td><b>$text{'error_line'}</b></td> ",
1365                       "<td><b>$text{'error_sub'}</b></td> </tr>\n";
1366                 for($i=0; my @stack = caller($i); $i++) {
1367                         print "<tr>\n";
1368                         print "<td>$stack[1]</td>\n";
1369                         print "<td>$stack[2]</td>\n";
1370                         print "<td>$stack[3]</td>\n";
1371                         print "</tr>\n";
1372                         }
1373                 print "</table>\n";
1374                 }
1375         print "<hr>\n";
1376         if ($ENV{'HTTP_REFERER'} && $main::completed_referers_check) {
1377                 &footer($ENV{'HTTP_REFERER'}, $text{'error_previous'});
1378                 }
1379         else {
1380                 &footer();
1381                 }
1382         }
1383 &unlock_all_files();
1384 &cleanup_tempnames();
1385 exit(1);
1386 }
1387
1388 =head2 popup_error([message]+)
1389
1390 This function is almost identical to error, but displays the message with HTML
1391 headers suitable for a popup window.
1392
1393 =cut
1394 sub popup_error
1395 {
1396 &load_theme_library();
1397 if ($main::error_must_die) {
1398         die @_;
1399         }
1400 elsif (defined(&theme_popup_error)) {
1401         &theme_popup_error(@_);
1402         }
1403 else {
1404         &popup_header($text{'error'}, "");
1405         print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),@_,"</h3>\n";
1406         &popup_footer();
1407         }
1408 &unlock_all_files();
1409 &cleanup_tempnames();
1410 exit;
1411 }
1412
1413 =head2 error_setup(message)
1414
1415 Registers a message to be prepended to all error messages displayed by the
1416 error function.
1417
1418 =cut
1419 sub error_setup
1420 {
1421 $main::whatfailed = $_[0];
1422 }
1423
1424 =head2 wait_for(handle, regexp, regexp, ...)
1425
1426 Reads from the input stream until one of the regexps matches, and returns the
1427 index of the matching regexp, or -1 if input ended before any matched. This is
1428 very useful for parsing the output of interactive programs, and can be used with
1429 a two-way pipe to feed input to a program in response to output matched by
1430 this function.
1431
1432 If the matching regexp contains bracketed sub-expressions, their values will
1433 be placed in the global array @matches, indexed starting from 1. You cannot
1434 use the Perl variables $1, $2 and so on to capture matches.
1435
1436 Example code:
1437
1438  $rv = wait_for($loginfh, "username:");
1439  if ($rv == -1) {
1440    error("Didn't get username prompt");
1441  }
1442  print $loginfh "joe\n";
1443  $rv = wait_for($loginfh, "password:");
1444  if ($rv == -1) {
1445    error("Didn't get password prompt");
1446  }
1447  print $loginfh "smeg\n";
1448
1449 =cut
1450 sub wait_for
1451 {
1452 my ($c, $i, $sw, $rv, $ha);
1453 undef($wait_for_input);
1454 if ($wait_for_debug) {
1455         print STDERR "wait_for(",join(",", @_),")\n";
1456         }
1457 $ha = &callers_package($_[0]);
1458 if ($wait_for_debug) {
1459         print STDERR "File handle=$ha fd=",fileno($ha),"\n";
1460         }
1461 $codes =
1462 "my \$hit;\n".
1463 "while(1) {\n".
1464 " if ((\$c = getc(\$ha)) eq \"\") { return -1; }\n".
1465 " \$wait_for_input .= \$c;\n";
1466 if ($wait_for_debug) {
1467         $codes .= "print STDERR \$wait_for_input,\"\\n\";";
1468         }
1469 for($i=1; $i<@_; $i++) {
1470         $sw = $i>1 ? "elsif" : "if";
1471         $codes .= " $sw (\$wait_for_input =~ /$_[$i]/i) { \$hit = $i-1; }\n";
1472         }
1473 $codes .=
1474 " if (defined(\$hit)) {\n".
1475 "  \@matches = (-1, \$1, \$2, \$3, \$4, \$5, \$6, \$7, \$8, \$9);\n".
1476 "  return \$hit;\n".
1477 "  }\n".
1478 " }\n";
1479 $rv = eval $codes;
1480 if ($@) {
1481         &error("wait_for error : $@\n");
1482         }
1483 return $rv;
1484 }
1485
1486 =head2 fast_wait_for(handle, string, string, ...)
1487
1488 This function behaves very similar to wait_for (documented above), but instead
1489 of taking regular expressions as parameters, it takes strings. As soon as the
1490 input contains one of them, it will return the index of the matching string.
1491 If the input ends before any match, it returns -1.
1492
1493 =cut
1494 sub fast_wait_for
1495 {
1496 my ($inp, $maxlen, $ha, $i, $c, $inpl);
1497 for($i=1; $i<@_; $i++) {
1498         $maxlen = length($_[$i]) > $maxlen ? length($_[$i]) : $maxlen;
1499         }
1500 $ha = $_[0];
1501 while(1) {
1502         if (($c = getc($ha)) eq "") {
1503                 &error("fast_wait_for read error : $!");
1504                 }
1505         $inp .= $c;
1506         if (length($inp) > $maxlen) {
1507                 $inp = substr($inp, length($inp)-$maxlen);
1508                 }
1509         $inpl = length($inp);
1510         for($i=1; $i<@_; $i++) {
1511                 if ($_[$i] eq substr($inp, $inpl-length($_[$i]))) {
1512                         return $i-1;
1513                         }
1514                 }
1515         }
1516 }
1517
1518 =head2 has_command(command)
1519
1520 Returns the full path to the executable if some command is in the path, or
1521 undef if not found. If the given command is already an absolute path and
1522 exists, then the same path will be returned.
1523
1524 =cut
1525 sub has_command
1526 {
1527 if (!$_[0]) { return undef; }
1528 if (exists($main::has_command_cache{$_[0]})) {
1529         return $main::has_command_cache{$_[0]};
1530         }
1531 my $rv = undef;
1532 my $slash = $gconfig{'os_type'} eq 'windows' ? '\\' : '/';
1533 if ($_[0] =~ /^\// || $_[0] =~ /^[a-z]:[\\\/]/i) {
1534         # Absolute path given - just use it
1535         my $t = &translate_filename($_[0]);
1536         $rv = (-x $t && !-d _) ? $_[0] : undef;
1537         }
1538 else {
1539         # Check each directory in the path
1540         my %donedir;
1541         foreach my $d (split($path_separator, $ENV{'PATH'})) {
1542                 next if ($donedir{$d}++);
1543                 $d =~ s/$slash$// if ($d ne $slash);
1544                 my $t = &translate_filename("$d/$_[0]");
1545                 if (-x $t && !-d _) {
1546                         $rv = $d.$slash.$_[0];
1547                         last;
1548                         }
1549                 if ($gconfig{'os_type'} eq 'windows') {
1550                         foreach my $sfx (".exe", ".com", ".bat") {
1551                                 my $t = &translate_filename("$d/$_[0]").$sfx;
1552                                 if (-r $t && !-d _) {
1553                                         $rv = $d.$slash.$_[0].$sfx;
1554                                         last;
1555                                         }
1556                                 }
1557                         }
1558                 }
1559         }
1560 $main::has_command_cache{$_[0]} = $rv;
1561 return $rv;
1562 }
1563
1564 =head2 make_date(seconds, [date-only], [fmt])
1565
1566 Converts a Unix date/time in seconds to a human-readable form, by default
1567 formatted like dd/mmm/yyyy hh:mm:ss. Parameters are :
1568
1569 =item seconds - Unix time is seconds to convert.
1570
1571 =item date-only - If set to 1, exclude the time from the returned string.
1572
1573 =item fmt - Optional, one of dd/mon/yyyy, dd/mm/yyyy, mm/dd/yyyy or yyyy/mm/dd
1574
1575 =cut
1576 sub make_date
1577 {
1578 my ($secs, $only, $fmt) = @_;
1579 my @tm = localtime($secs);
1580 my $date;
1581 if (!$fmt) {
1582         $fmt = $gconfig{'dateformat'} || 'dd/mon/yyyy';
1583         }
1584 if ($fmt eq 'dd/mon/yyyy') {
1585         $date = sprintf "%2.2d/%s/%4.4d",
1586                         $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900;
1587         }
1588 elsif ($fmt eq 'dd/mm/yyyy') {
1589         $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[3], $tm[4]+1, $tm[5]+1900;
1590         }
1591 elsif ($fmt eq 'mm/dd/yyyy') {
1592         $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[4]+1, $tm[3], $tm[5]+1900;
1593         }
1594 elsif ($fmt eq 'yyyy/mm/dd') {
1595         $date = sprintf "%4.4d/%2.2d/%2.2d", $tm[5]+1900, $tm[4]+1, $tm[3];
1596         }
1597 if (!$only) {
1598         $date .= sprintf " %2.2d:%2.2d", $tm[2], $tm[1];
1599         }
1600 return $date;
1601 }
1602
1603 =head2 file_chooser_button(input, type, [form], [chroot], [addmode])
1604
1605 Return HTML for a button that pops up a file chooser when clicked, and places
1606 the selected filename into another HTML field. The parameters are :
1607
1608 =item input - Name of the form field to store the filename in.
1609
1610 =item type - 0 for file or directory chooser, or 1 for directory only.
1611
1612 =item form - Index of the form containing the button.
1613
1614 =item chroot - If set to 1, the chooser will be limited to this directory.
1615
1616 =item addmode - If set to 1, the selected filename will be appended to the text box instead of replacing it's contents.
1617
1618 =cut
1619 sub file_chooser_button
1620 {
1621 return &theme_file_chooser_button(@_)
1622         if (defined(&theme_file_chooser_button));
1623 my $form = defined($_[2]) ? $_[2] : 0;
1624 my $chroot = defined($_[3]) ? $_[3] : "/";
1625 my $add = int($_[4]);
1626 my ($w, $h) = (400, 300);
1627 if ($gconfig{'db_sizefile'}) {
1628         ($w, $h) = split(/x/, $gconfig{'db_sizefile'});
1629         }
1630 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";
1631 }
1632
1633 =head2 popup_window_button(url, width, height, scrollbars?, &field-mappings)
1634
1635 Returns HTML for a button that will popup a chooser window of some kind. The
1636 parameters are :
1637
1638 =item url - Base URL of the popup window's contents
1639
1640 =item width - Width of the window in pixels
1641
1642 =item height - Height in pixels
1643
1644 =item scrollbars - Set to 1 if the window should have scrollbars
1645
1646 The field-mappings parameter is an array ref of array refs containing
1647
1648 =item - Attribute to assign field to in the popup window
1649
1650 =item - Form field name
1651
1652 =item - CGI parameter to URL for value, if any
1653
1654 =cut
1655 sub popup_window_button
1656 {
1657 return &theme_popup_window_button(@_) if (defined(&theme_popup_window_button));
1658 my ($url, $w, $h, $scroll, $fields) = @_;
1659 my $scrollyn = $scroll ? "yes" : "no";
1660 my $rv = "<input type=button onClick='";
1661 foreach my $m (@$fields) {
1662         $rv .= "$m->[0] = form.$m->[1]; ";
1663         }
1664 my $sep = $url =~ /\?/ ? "&" : "?";
1665 $rv .= "chooser = window.open(\"$url\"";
1666 foreach my $m (@$fields) {
1667         if ($m->[2]) {
1668                 $rv .= "+\"$sep$m->[2]=\"+escape($m->[0].value)";
1669                 $sep = "&";
1670                 }
1671         }
1672 $rv .= ", \"chooser\", \"toolbar=no,menubar=no,scrollbars=$scrollyn,resizable=yes,width=$w,height=$h\"); ";
1673 foreach my $m (@$fields) {
1674         $rv .= "chooser.$m->[0] = $m->[0]; ";
1675         $rv .= "window.$m->[0] = $m->[0]; ";
1676         }
1677 $rv .= "' value=\"...\">";
1678 return $rv;
1679 }
1680
1681 =head2 read_acl(&user-module-hash, &user-list-hash)
1682
1683 Reads the Webmin acl file into the given hash references. The first is indexed
1684 by a combined key of username,module , with the value being set to 1 when
1685 the user has access to that module. The second is indexed by username, with
1686 the value being an array ref of allowed modules.
1687
1688 This function is deprecated in favour of foreign_available, which performs a
1689 more comprehensive check of module availability.
1690
1691 =cut
1692 sub read_acl
1693 {
1694 if (!defined(%main::acl_hash_cache)) {
1695         local $_;
1696         open(ACL, &acl_filename());
1697         while(<ACL>) {
1698                 if (/^([^:]+):\s*(.*)/) {
1699                         my $user = $1;
1700                         my @mods = split(/\s+/, $2);
1701                         foreach my $m (@mods) {
1702                                 $main::acl_hash_cache{$user,$m}++;
1703                                 }
1704                         $main::acl_array_cache{$user} = \@mods;
1705                         }
1706                 }
1707         close(ACL);
1708         }
1709 if ($_[0]) { %{$_[0]} = %main::acl_hash_cache; }
1710 if ($_[1]) { %{$_[1]} = %main::acl_array_cache; }
1711 }
1712
1713 =head2 acl_filename
1714
1715 Returns the file containing the webmin ACL, which is usually
1716 /etc/webmin/webmin.acl.
1717
1718 =cut
1719 sub acl_filename
1720 {
1721 return "$config_directory/webmin.acl";
1722 }
1723
1724 =head2 acl_check
1725
1726 Does nothing, but kept around for compatability.
1727
1728 =cut
1729 sub acl_check
1730 {
1731 }
1732
1733 =head2 get_miniserv_config(&hash)
1734
1735 Reads the Webmin webserver's (miniserv.pl) configuration file, usually located
1736 at /etc/webmin/miniserv.conf, and stores its names and values in the given
1737 hash reference.
1738
1739 =cut
1740 sub get_miniserv_config
1741 {
1742 return &read_file_cached(
1743         $ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf", $_[0]);
1744 }
1745
1746 =head2 put_miniserv_config(&hash)
1747
1748 Writes out the Webmin webserver configuration file from the contents of
1749 the given hash ref. This should be initially populated by get_miniserv_config,
1750 like so :
1751
1752  get_miniserv_config(\%miniserv);
1753  $miniserv{'port'} = 10005;
1754  put_miniserv_config(\%miniserv);
1755  restart_miniserv();
1756
1757 =cut
1758 sub put_miniserv_config
1759 {
1760 &write_file($ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf",
1761             $_[0]);
1762 }
1763
1764 =head2 restart_miniserv([nowait])
1765
1766 Kill the old miniserv process and re-start it, then optionally waits for
1767 it to restart. This will apply all configuration settings.
1768
1769 =cut
1770 sub restart_miniserv
1771 {
1772 my ($nowait) = @_;
1773 return undef if (&is_readonly_mode());
1774 my %miniserv;
1775 &get_miniserv_config(\%miniserv) || return;
1776
1777 my $i;
1778 if ($gconfig{'os_type'} ne 'windows') {
1779         # On Unix systems, we can restart with a signal
1780         my ($pid, $addr, $i);
1781         $miniserv{'inetd'} && return;
1782         my @oldst = stat($miniserv{'pidfile'});
1783         open(PID, $miniserv{'pidfile'}) || &error("Failed to open PID file");
1784         chop($pid = <PID>);
1785         close(PID);
1786         if (!$pid) { &error("Invalid PID file"); }
1787
1788         # Just signal miniserv to restart
1789         &kill_logged('HUP', $pid) || &error("Incorrect Webmin PID $pid");
1790
1791         # Wait till new PID is written, indicating a restart
1792         for($i=0; $i<60; $i++) {
1793                 sleep(1);
1794                 my @newst = stat($miniserv{'pidfile'});
1795                 last if ($newst[9] != $oldst[9]);
1796                 }
1797         $i < 60 || &error("Webmin server did not write new PID file");
1798
1799         ## Totally kill the process and re-run it
1800         #$SIG{'TERM'} = 'IGNORE';
1801         #&kill_logged('TERM', $pid);
1802         #&system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1803         }
1804 else {
1805         # On Windows, we need to use the flag file
1806         open(TOUCH, ">$miniserv{'restartflag'}");
1807         close(TOUCH);
1808         }
1809
1810 if (!$nowait) {
1811         # wait for miniserv to come back up
1812         $addr = inet_aton($miniserv{'bind'} ? $miniserv{'bind'} : "127.0.0.1");
1813         my $ok = 0;
1814         for($i=0; $i<20; $i++) {
1815                 sleep(1);
1816                 socket(STEST, PF_INET, SOCK_STREAM, getprotobyname("tcp"));
1817                 my $rv = connect(STEST,
1818                                  pack_sockaddr_in($miniserv{'port'}, $addr));
1819                 close(STEST);
1820                 last if ($rv && ++$ok >= 2);
1821                 }
1822         $i < 20 || &error("Failed to restart Webmin server!");
1823         }
1824 }
1825
1826 =head2 reload_miniserv
1827
1828 Sends a USR1 signal to the miniserv process, telling it to read-read it's
1829 configuration files. Not all changes will be applied though, such as the
1830 IP addresses and ports to accept connections on.
1831
1832 =cut
1833 sub reload_miniserv
1834 {
1835 return undef if (&is_readonly_mode());
1836 my %miniserv;
1837 &get_miniserv_config(\%miniserv) || return;
1838
1839 if ($gconfig{'os_type'} ne 'windows') {
1840         # Send a USR1 signal to re-read the config
1841         my ($pid, $addr, $i);
1842         $miniserv{'inetd'} && return;
1843         open(PID, $miniserv{'pidfile'}) || &error("Failed to open PID file");
1844         chop($pid = <PID>);
1845         close(PID);
1846         if (!$pid) { &error("Invalid PID file"); }
1847         &kill_logged('USR1', $pid) || &error("Incorrect Webmin PID $pid");
1848
1849         # Make sure this didn't kill Webmin!
1850         sleep(1);
1851         if (!kill(0, $pid)) {
1852                 print STDERR "USR1 signal killed Webmin - restarting\n";
1853                 &system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1854                 }
1855         }
1856 else {
1857         # On Windows, we need to use the flag file
1858         open(TOUCH, ">$miniserv{'reloadflag'}");
1859         close(TOUCH);
1860         }
1861 }
1862
1863 =head2 check_os_support(&minfo, [os-type, os-version], [api-only])
1864
1865 Returns 1 if some module is supported on the current operating system, or the
1866 OS supplies as parameters. The parameters are :
1867
1868 =item minfo - A hash ref of module information, as returned by get_module_info
1869
1870 =item os-type - The Webmin OS code to use instead of the system's real OS, such as redhat-linux
1871
1872 =item os-version - The Webmin OS version to use, such as 13.0
1873
1874 =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.
1875
1876 =cut
1877 sub check_os_support
1878 {
1879 my $oss = $_[0]->{'os_support'};
1880 if ($_[3] && $oss && $_[0]->{'api_os_support'}) {
1881         # May provide usable API
1882         $oss .= " ".$_[0]->{'api_os_support'};
1883         }
1884 if ($_[0]->{'nozone'} && &running_in_zone()) {
1885         # Not supported in a Solaris Zone
1886         return 0;
1887         }
1888 if ($_[0]->{'novserver'} && &running_in_vserver()) {
1889         # Not supported in a Linux Vserver
1890         return 0;
1891         }
1892 if ($_[0]->{'noopenvz'} && &running_in_openvz()) {
1893         # Not supported in an OpenVZ container
1894         return 0;
1895         }
1896 return 1 if (!$oss || $oss eq '*');
1897 my $osver = $_[2] || $gconfig{'os_version'};
1898 my $ostype = $_[1] || $gconfig{'os_type'};
1899 my $anyneg = 0;
1900 while(1) {
1901         my ($os, $ver, $codes);
1902         my ($neg) = ($oss =~ s/^!//);   # starts with !
1903         $anyneg++ if ($neg);
1904         if ($oss =~ /^([^\/\s]+)\/([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
1905                 # OS/version{code}
1906                 $os = $1; $ver = $2; $codes = $3; $oss = $4;
1907                 }
1908         elsif ($oss =~ /^([^\/\s]+)\/([^\/\s]+)\s*(.*)$/) {
1909                 # OS/version
1910                 $os = $1; $ver = $2; $oss = $3;
1911                 }
1912         elsif ($oss =~ /^([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
1913                 # OS/{code}
1914                 $os = $1; $codes = $2; $oss = $3;
1915                 }
1916         elsif ($oss =~ /^\{([^\}]*)\}\s*(.*)$/) {
1917                 # {code}
1918                 $codes = $1; $oss = $2;
1919                 }
1920         elsif ($oss =~ /^(\S+)\s*(.*)$/) {
1921                 # OS
1922                 $os = $1; $oss = $2;
1923                 }
1924         else { last; }
1925         next if ($os && !($os eq $ostype ||
1926                           $ostype =~ /^(\S+)-(\S+)$/ && $os eq "*-$2"));
1927         if ($ver =~ /^([0-9\.]+)\-([0-9\.]+)$/) {
1928                 next if ($osver < $1 || $osver > $2);
1929                 }
1930         elsif ($ver =~ /^([0-9\.]+)\-\*$/) {
1931                 next if ($osver < $1);
1932                 }
1933         elsif ($ver =~ /^\*\-([0-9\.]+)$/) {
1934                 next if ($osver > $1);
1935                 }
1936         elsif ($ver) {
1937                 next if ($ver ne $osver);
1938                 }
1939         next if ($codes && !eval $codes);
1940         return !$neg;
1941         }
1942 return $anyneg;
1943 }
1944
1945 =head2 http_download(host, port, page, destfile, [&error], [&callback], [sslmode], [user, pass], [timeout], [osdn-convert], [no-cache], [&headers])
1946
1947 Downloads data from a HTTP url to a local file or string. The parameters are :
1948
1949 =item host - The hostname part of the URL, such as www.google.com
1950
1951 =item port - The HTTP port number, such as 80
1952
1953 =item page - The filename part of the URL, like /index.html
1954
1955 =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.
1956
1957 =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.
1958
1959 =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.
1960
1961 =item sslmode - If set to 1, an HTTPS connection is used instead of HTTP.
1962
1963 =item user - If set, HTTP authentication is done with this username.
1964
1965 =item pass - The HTTP password to use with the username above.
1966
1967 =item timeout - A timeout in seconds to wait for the TCP connection to be established before failing.
1968
1969 =item osdn-convert - If set to 1, URL for downloads from sourceforge are converted to use an appropriate mirror site.
1970
1971 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
1972
1973 =item headers - If set to a hash ref of additional HTTP headers, they will be added to the request.
1974
1975 =cut
1976 sub http_download
1977 {
1978 my ($host, $port, $page, $dest, $error, $cbfunc, $ssl, $user, $pass,
1979     $timeout, $osdn, $nocache, $headers) = @_;
1980 if ($gconfig{'debug_what_net'}) {
1981         &webmin_debug_log('HTTP', "host=$host port=$port page=$page ssl=$ssl".
1982                                   ($user ? " user=$user pass=$pass" : "").
1983                                   (ref($dest) ? "" : " dest=$dest"));
1984         }
1985 if ($osdn) {
1986         # Convert OSDN URL first
1987         my $prot = $ssl ? "https://" : "http://";
1988         my $portstr = $ssl && $port == 443 ||
1989                          !$ssl && $port == 80 ? "" : ":$port";
1990         ($host, $port, $page, $ssl) = &parse_http_url(
1991                 &convert_osdn_url($prot.$host.$portstr.$page));
1992         }
1993
1994 # Check if we already have cached the URL
1995 my $url = ($ssl ? "https://" : "http://").$host.":".$port.$page;
1996 my $cfile = &check_in_http_cache($url);
1997 if ($cfile && !$nocache) {
1998         # Yes! Copy to dest file or variable
1999         &$cbfunc(6, $url) if ($cbfunc);
2000         if (ref($dest)) {
2001                 &open_readfile(CACHEFILE, $cfile);
2002                 local $/ = undef;
2003                 $$dest = <CACHEFILE>;
2004                 close(CACHEFILE);
2005                 }
2006         else {
2007                 &copy_source_dest($cfile, $dest);
2008                 }
2009         return;
2010         }
2011
2012 # Build headers
2013 my @headers;
2014 push(@headers, [ "Host", $host ]);
2015 push(@headers, [ "User-agent", "Webmin" ]);
2016 if ($user) {
2017         my $auth = &encode_base64("$user:$pass");
2018         $auth =~ tr/\r\n//d;
2019         push(@headers, [ "Authorization", "Basic $auth" ]);
2020         }
2021 foreach my $hname (keys %$headers) {
2022         push(@headers, [ $hname, $headers->{$hname} ]);
2023         }
2024
2025 # Actually download it
2026 $main::download_timed_out = undef;
2027 local $SIG{ALRM} = \&download_timeout;
2028 alarm($timeout || 60);
2029 my $h = &make_http_connection($host, $port, $ssl, "GET", $page, \@headers);
2030 alarm(0);
2031 $h = $main::download_timed_out if ($main::download_timed_out);
2032 if (!ref($h)) {
2033         if ($error) { $$error = $h; return; }
2034         else { &error($h); }
2035         }
2036 &complete_http_download($h, $dest, $error, $cbfunc, $osdn, $host, $port,
2037                         $headers, $ssl);
2038 if ((!$error || !$$error) && !$nocache) {
2039         &write_to_http_cache($url, $dest);
2040         }
2041 }
2042
2043 =head2 complete_http_download(handle, destfile, [&error], [&callback], [osdn], [oldhost], [oldport], [&send-headers], [old-ssl])
2044
2045 Do a HTTP download, after the headers have been sent. For internal use only,
2046 typically called by http_download.
2047
2048 =cut
2049 sub complete_http_download
2050 {
2051 local ($line, %header, @headers, $s);  # Kept local so that callback funcs
2052                                        # can access them.
2053 my $cbfunc = $_[3];
2054
2055 # read headers
2056 alarm(60);
2057 ($line = &read_http_connection($_[0])) =~ tr/\r\n//d;
2058 if ($line !~ /^HTTP\/1\..\s+(200|30[0-9])(\s+|$)/) {
2059         alarm(0);
2060         if ($_[2]) { ${$_[2]} = $line; return; }
2061         else { &error("Download failed : $line"); }
2062         }
2063 my $rcode = $1;
2064 &$cbfunc(1, $rcode >= 300 && $rcode < 400 ? 1 : 0)
2065         if ($cbfunc);
2066 while(1) {
2067         $line = &read_http_connection($_[0]);
2068         $line =~ tr/\r\n//d;
2069         $line =~ /^(\S+):\s+(.*)$/ || last;
2070         $header{lc($1)} = $2;
2071         push(@headers, [ lc($1), $2 ]);
2072         }
2073 alarm(0);
2074 if ($main::download_timed_out) {
2075         if ($_[2]) { ${$_[2]} = $main::download_timed_out; return 0; }
2076         else { &error($main::download_timed_out); }
2077         }
2078 &$cbfunc(2, $header{'content-length'}) if ($cbfunc);
2079 if ($rcode >= 300 && $rcode < 400) {
2080         # follow the redirect
2081         &$cbfunc(5, $header{'location'}) if ($cbfunc);
2082         my ($host, $port, $page, $ssl);
2083         if ($header{'location'} =~ /^(http|https):\/\/([^:]+):(\d+)(\/.*)?$/) {
2084                 $ssl = $1 eq 'https' ? 1 : 0;
2085                 $host = $2; $port = $3; $page = $4 || "/";
2086                 }
2087         elsif ($header{'location'} =~ /^(http|https):\/\/([^:\/]+)(\/.*)?$/) {
2088                 $ssl = $1 eq 'https' ? 1 : 0;
2089                 $host = $2; $port = 80; $page = $3 || "/";
2090                 }
2091         elsif ($header{'location'} =~ /^\// && $_[5]) {
2092                 # Relative to same server
2093                 $host = $_[5];
2094                 $port = $_[6];
2095                 $ssl = $_[8];
2096                 $page = $header{'location'};
2097                 }
2098         elsif ($header{'location'}) {
2099                 # Assume relative to same dir .. not handled
2100                 if ($_[2]) { ${$_[2]} = "Invalid Location header $header{'location'}"; return; }
2101                 else { &error("Invalid Location header $header{'location'}"); }
2102                 }
2103         else {
2104                 if ($_[2]) { ${$_[2]} = "Missing Location header"; return; }
2105                 else { &error("Missing Location header"); }
2106                 }
2107         my $params;
2108         ($page, $params) = split(/\?/, $page);
2109         $page =~ s/ /%20/g;
2110         $page .= "?".$params if (defined($params));
2111         &http_download($host, $port, $page, $_[1], $_[2], $cbfunc, $ssl,
2112                        undef, undef, undef, $_[4], 0, $_[7]);
2113         }
2114 else {
2115         # read data
2116         if (ref($_[1])) {
2117                 # Append to a variable
2118                 while(defined($buf = &read_http_connection($_[0], 1024))) {
2119                         ${$_[1]} .= $buf;
2120                         &$cbfunc(3, length(${$_[1]})) if ($cbfunc);
2121                         }
2122                 }
2123         else {
2124                 # Write to a file
2125                 my $got = 0;
2126                 if (!&open_tempfile(PFILE, ">$_[1]", 1)) {
2127                         if ($_[2]) { ${$_[2]} = "Failed to write to $_[1] : $!"; return; }
2128                         else { &error("Failed to write to $_[1] : $!"); }
2129                         }
2130                 binmode(PFILE);         # For windows
2131                 while(defined($buf = &read_http_connection($_[0], 1024))) {
2132                         &print_tempfile(PFILE, $buf);
2133                         $got += length($buf);
2134                         &$cbfunc(3, $got) if ($cbfunc);
2135                         }
2136                 &close_tempfile(PFILE);
2137                 if ($header{'content-length'} &&
2138                     $got != $header{'content-length'}) {
2139                         if ($_[2]) { ${$_[2]} = "Download incomplete"; return; }
2140                         else { &error("Download incomplete"); }
2141                         }
2142                 }
2143         &$cbfunc(4) if ($cbfunc);
2144         }
2145 &close_http_connection($_[0]);
2146 }
2147
2148
2149 =head2 ftp_download(host, file, destfile, [&error], [&callback], [user, pass], [port])
2150
2151 Download data from an FTP site to a local file. The parameters are :
2152
2153 =item host - FTP server hostname
2154
2155 =item file - File on the FTP server to download
2156
2157 =item destfile - File on the Webmin system to download data to
2158
2159 =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.
2160
2161 =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.
2162
2163 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2164
2165 =item pass - Password for the username above.
2166
2167 =item port - FTP server port number, which defaults to 21 if not set.
2168
2169 =cut
2170 sub ftp_download
2171 {
2172 my ($host, $file, $dest, $error, $cbfunc, $user, $pass, $port) = @_;
2173 $port ||= 21;
2174 if ($gconfig{'debug_what_net'}) {
2175         &webmin_debug_log('FTP', "host=$host port=$port file=$file".
2176                                  ($user ? " user=$user pass=$pass" : "").
2177                                  (ref($dest) ? "" : " dest=$dest"));
2178         }
2179 my ($buf, @n);
2180 $cbfunc = $_[4];
2181 if (&is_readonly_mode()) {
2182         if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2183                      return 0; }
2184         else { &error("FTP connections not allowed in readonly mode"); }
2185         }
2186
2187 # Check if we already have cached the URL
2188 my $url = "ftp://".$host.$file;
2189 my $cfile = &check_in_http_cache($url);
2190 if ($cfile) {
2191         # Yes! Copy to dest file or variable
2192         &$cbfunc(6, $url) if ($cbfunc);
2193         if (ref($dest)) {
2194                 &open_readfile(CACHEFILE, $cfile);
2195                 local $/ = undef;
2196                 $$dest = <CACHEFILE>;
2197                 close(CACHEFILE);
2198                 }
2199         else {
2200                 &copy_source_dest($cfile, $dest);
2201                 }
2202         return;
2203         }
2204
2205 # Actually download it
2206 $main::download_timed_out = undef;
2207 local $SIG{ALRM} = \&download_timeout;
2208 alarm(60);
2209 my $connected;
2210 if ($gconfig{'ftp_proxy'} =~ /^http:\/\/(\S+):(\d+)/ && !&no_proxy($_[0])) {
2211         # download through http-style proxy
2212         my $error;
2213         if (&open_socket($1, $2, "SOCK", \$error)) {
2214                 # Connected OK
2215                 if ($main::download_timed_out) {
2216                         alarm(0);
2217                         if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2218                         else { &error($main::download_timed_out); }
2219                         }
2220                 my $esc = $_[1]; $esc =~ s/ /%20/g;
2221                 my $up = "$_[5]:$_[6]\@" if ($_[5]);
2222                 my $portstr = $port == 21 ? "" : ":$port";
2223                 print SOCK "GET ftp://$up$_[0]$portstr$esc HTTP/1.0\r\n";
2224                 print SOCK "User-agent: Webmin\r\n";
2225                 if ($gconfig{'proxy_user'}) {
2226                         my $auth = &encode_base64(
2227                            "$gconfig{'proxy_user'}:$gconfig{'proxy_pass'}");
2228                         $auth =~ tr/\r\n//d;
2229                         print SOCK "Proxy-Authorization: Basic $auth\r\n";
2230                         }
2231                 print SOCK "\r\n";
2232                 &complete_http_download({ 'fh' => "SOCK" }, $_[2], $_[3], $_[4]);
2233                 $connected = 1;
2234                 }
2235         elsif (!$gconfig{'proxy_fallback'}) {
2236                 alarm(0);
2237                 if ($error) { $$error = $main::download_timed_out; return 0; }
2238                 else { &error($main::download_timed_out); }
2239                 }
2240         }
2241
2242 if (!$connected) {
2243         # connect to host and login with real FTP protocol
2244         &open_socket($_[0], $port, "SOCK", $_[3]) || return 0;
2245         alarm(0);
2246         if ($main::download_timed_out) {
2247                 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2248                 else { &error($main::download_timed_out); }
2249                 }
2250         &ftp_command("", 2, $_[3]) || return 0;
2251         if ($_[5]) {
2252                 # Login as supplied user
2253                 my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2254                 @urv || return 0;
2255                 if (int($urv[1]/100) == 3) {
2256                         &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2257                         }
2258                 }
2259         else {
2260                 # Login as anonymous
2261                 my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2262                 @urv || return 0;
2263                 if (int($urv[1]/100) == 3) {
2264                         &ftp_command("PASS root\@".&get_system_hostname(), 2,
2265                                      $_[3]) || return 0;
2266                         }
2267                 }
2268         &$cbfunc(1, 0) if ($cbfunc);
2269
2270         if ($_[1]) {
2271                 # get the file size and tell the callback
2272                 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2273                 my $size = &ftp_command("SIZE $_[1]", 2, $_[3]);
2274                 defined($size) || return 0;
2275                 if ($cbfunc) {
2276                         &$cbfunc(2, int($size));
2277                         }
2278
2279                 # request the file
2280                 my $pasv = &ftp_command("PASV", 2, $_[3]);
2281                 defined($pasv) || return 0;
2282                 $pasv =~ /\(([0-9,]+)\)/;
2283                 @n = split(/,/ , $1);
2284                 &open_socket("$n[0].$n[1].$n[2].$n[3]",
2285                         $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2286                 &ftp_command("RETR $_[1]", 1, $_[3]) || return 0;
2287
2288                 # transfer data
2289                 my $got = 0;
2290                 &open_tempfile(PFILE, ">$_[2]", 1);
2291                 while(read(CON, $buf, 1024) > 0) {
2292                         &print_tempfile(PFILE, $buf);
2293                         $got += length($buf);
2294                         &$cbfunc(3, $got) if ($cbfunc);
2295                         }
2296                 &close_tempfile(PFILE);
2297                 close(CON);
2298                 if ($got != $size) {
2299                         if ($_[3]) { ${$_[3]} = "Download incomplete"; return 0; }
2300                         else { &error("Download incomplete"); }
2301                         }
2302                 &$cbfunc(4) if ($cbfunc);
2303
2304                 &ftp_command("", 2, $_[3]) || return 0;
2305                 }
2306
2307         # finish off..
2308         &ftp_command("QUIT", 2, $_[3]) || return 0;
2309         close(SOCK);
2310         }
2311
2312 &write_to_http_cache($url, $dest);
2313 return 1;
2314 }
2315
2316 =head2 ftp_upload(host, file, srcfile, [&error], [&callback], [user, pass], [port])
2317
2318 Upload data from a local file to an FTP site. The parameters are :
2319
2320 =item host - FTP server hostname
2321
2322 =item file - File on the FTP server to write to
2323
2324 =item srcfile - File on the Webmin system to upload data from
2325
2326 =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.
2327
2328 =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.
2329
2330 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2331
2332 =item pass - Password for the username above.
2333
2334 =item port - FTP server port number, which defaults to 21 if not set.
2335
2336 =cut
2337 sub ftp_upload
2338 {
2339 my ($buf, @n);
2340 my $cbfunc = $_[4];
2341 if (&is_readonly_mode()) {
2342         if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2343                      return 0; }
2344         else { &error("FTP connections not allowed in readonly mode"); }
2345         }
2346
2347 $main::download_timed_out = undef;
2348 local $SIG{ALRM} = \&download_timeout;
2349 alarm(60);
2350
2351 # connect to host and login
2352 &open_socket($_[0], $_[7] || 21, "SOCK", $_[3]) || return 0;
2353 alarm(0);
2354 if ($main::download_timed_out) {
2355         if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2356         else { &error($main::download_timed_out); }
2357         }
2358 &ftp_command("", 2, $_[3]) || return 0;
2359 if ($_[5]) {
2360         # Login as supplied user
2361         my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2362         @urv || return 0;
2363         if (int($urv[1]/100) == 3) {
2364                 &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2365                 }
2366         }
2367 else {
2368         # Login as anonymous
2369         my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2370         @urv || return 0;
2371         if (int($urv[1]/100) == 3) {
2372                 &ftp_command("PASS root\@".&get_system_hostname(), 2,
2373                              $_[3]) || return 0;
2374                 }
2375         }
2376 &$cbfunc(1, 0) if ($cbfunc);
2377
2378 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2379
2380 # get the file size and tell the callback
2381 my @st = stat($_[2]);
2382 if ($cbfunc) {
2383         &$cbfunc(2, $st[7]);
2384         }
2385
2386 # send the file
2387 my $pasv = &ftp_command("PASV", 2, $_[3]);
2388 defined($pasv) || return 0;
2389 $pasv =~ /\(([0-9,]+)\)/;
2390 @n = split(/,/ , $1);
2391 &open_socket("$n[0].$n[1].$n[2].$n[3]", $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2392 &ftp_command("STOR $_[1]", 1, $_[3]) || return 0;
2393
2394 # transfer data
2395 my $got;
2396 open(PFILE, $_[2]);
2397 while(read(PFILE, $buf, 1024) > 0) {
2398         print CON $buf;
2399         $got += length($buf);
2400         &$cbfunc(3, $got) if ($cbfunc);
2401         }
2402 close(PFILE);
2403 close(CON);
2404 if ($got != $st[7]) {
2405         if ($_[3]) { ${$_[3]} = "Upload incomplete"; return 0; }
2406         else { &error("Upload incomplete"); }
2407         }
2408 &$cbfunc(4) if ($cbfunc);
2409
2410 # finish off..
2411 &ftp_command("", 2, $_[3]) || return 0;
2412 &ftp_command("QUIT", 2, $_[3]) || return 0;
2413 close(SOCK);
2414
2415 return 1;
2416 }
2417
2418 =head2 no_proxy(host)
2419
2420 Checks if some host is on the no proxy list. For internal use by the
2421 http_download and ftp_download functions.
2422
2423 =cut
2424 sub no_proxy
2425 {
2426 my $ip = &to_ipaddress($_[0]);
2427 foreach my $n (split(/\s+/, $gconfig{'noproxy'})) {
2428         return 1 if ($_[0] =~ /\Q$n\E/ ||
2429                      $ip =~ /\Q$n\E/);
2430         }
2431 return 0;
2432 }
2433
2434 =head2 open_socket(host, port, handle, [&error])
2435
2436 Open a TCP connection to some host and port, using a file handle. The
2437 parameters are :
2438
2439 =item host - Hostname or IP address to connect to.
2440
2441 =item port - TCP port number.
2442
2443 =item handle - A file handle name to use for the connection.
2444
2445 =item error - A string reference to write any error message into. If not set, the error function is called on failure.
2446
2447 =cut
2448 sub open_socket
2449 {
2450 my ($host, $port, $fh, $err) = @_;
2451 $fh = &callers_package($fh);
2452
2453 if ($gconfig{'debug_what_net'}) {
2454         &webmin_debug_log('TCP', "host=$host port=$port");
2455         }
2456 if (!socket($fh, PF_INET, SOCK_STREAM, getprotobyname("tcp"))) {
2457         if ($err) { $$err = "Failed to create socket : $!"; return 0; }
2458         else { &error("Failed to create socket : $!"); }
2459         }
2460 my $addr;
2461 if (!($addr = inet_aton($host))) {
2462         if ($err) { $$err = "Failed to lookup IP address for $host"; return 0; }
2463         else { &error("Failed to lookup IP address for $host"); }
2464         }
2465 if ($gconfig{'bind_proxy'}) {
2466         if (!bind($fh,pack_sockaddr_in(0, inet_aton($gconfig{'bind_proxy'})))) {
2467                 if ($err) { $$err = "Failed to bind to source address : $!"; return 0; }
2468                 else { &error("Failed to bind to source address : $!"); }
2469                 }
2470         }
2471 if (!connect($fh, pack_sockaddr_in($port, $addr))) {
2472         if ($err) { $$err = "Failed to connect to $host:$port : $!"; return 0; }
2473         else { &error("Failed to connect to $host:$port : $!"); }
2474         }
2475 my $old = select($fh); $| =1; select($old);
2476 return 1;
2477 }
2478
2479 =head2 download_timeout
2480
2481 Called when a download times out. For internal use only.
2482
2483 =cut
2484 sub download_timeout
2485 {
2486 $main::download_timed_out = "Download timed out";
2487 }
2488
2489 =head2 ftp_command(command, expected, [&error], [filehandle])
2490
2491 Send an FTP command, and die if the reply is not what was expected. Mainly
2492 for internal use by the ftp_download and ftp_upload functions.
2493
2494 =cut
2495 sub ftp_command
2496 {
2497 my ($cmd, $expect, $err, $fh) = @_;
2498 $fh ||= "SOCK";
2499 $fh = &callers_package($fh);
2500
2501 my $line;
2502 my $what = $cmd ne "" ? "<i>$cmd</i>" : "initial connection";
2503 if ($cmd ne "") {
2504         print $fh "$cmd\r\n";
2505         }
2506 alarm(60);
2507 if (!($line = <$fh>)) {
2508         alarm(0);
2509         if ($err) { $$err = "Failed to read reply to $what"; return undef; }
2510         else { &error("Failed to read reply to $what"); }
2511         }
2512 $line =~ /^(...)(.)(.*)$/;
2513 my $found = 0;
2514 if (ref($expect)) {
2515         foreach my $c (@$expect) {
2516                 $found++ if (int($1/100) == $c);
2517                 }
2518         }
2519 else {
2520         $found++ if (int($1/100) == $_[1]);
2521         }
2522 if (!$found) {
2523         alarm(0);
2524         if ($err) { $$err = "$what failed : $3"; return undef; }
2525         else { &error("$what failed : $3"); }
2526         }
2527 my $rcode = $1;
2528 my $reply = $3;
2529 if ($2 eq "-") {
2530         # Need to skip extra stuff..
2531         while(1) {
2532                 if (!($line = <$fh>)) {
2533                         alarm(0);
2534                         if ($$err) { $$err = "Failed to read reply to $what";
2535                                      return undef; }
2536                         else { &error("Failed to read reply to $what"); }
2537                         }
2538                 $line =~ /^(....)(.*)$/; $reply .= $2;
2539                 if ($1 eq "$rcode ") { last; }
2540                 }
2541         }
2542 alarm(0);
2543 return wantarray ? ($reply, $rcode) : $reply;
2544 }
2545
2546 =head2 to_ipaddress(hostname)
2547
2548 Converts a hostname to an a.b.c.d format IP address, or returns undef if
2549 it cannot be resolved.
2550
2551 =cut
2552 sub to_ipaddress
2553 {
2554 if (&check_ipaddress($_[0])) {
2555         return $_[0];
2556         }
2557 else {
2558         my $hn = gethostbyname($_[0]);
2559         return undef if (!$hn);
2560         local @ip = unpack("CCCC", $hn);
2561         return join("." , @ip);
2562         }
2563 }
2564
2565 =head2 icons_table(&links, &titles, &icons, [columns], [href], [width], [height], &befores, &afters)
2566
2567 Renders a 4-column table of icons. The useful parameters are :
2568
2569 =item links - An array ref of link destination URLs for the icons.
2570
2571 =item titles - An array ref of titles to appear under the icons.
2572
2573 =item icons - An array ref of URLs for icon images.
2574
2575 =item columns - Number of columns to layout the icons with. Defaults to 4.
2576
2577 =cut
2578 sub icons_table
2579 {
2580 &load_theme_library();
2581 if (defined(&theme_icons_table)) {
2582         &theme_icons_table(@_);
2583         return;
2584         }
2585 my $need_tr;
2586 my $cols = $_[3] ? $_[3] : 4;
2587 my $per = int(100.0 / $cols);
2588 print "<table class='icons_table' width=100% cellpadding=5>\n";
2589 for(my $i=0; $i<@{$_[0]}; $i++) {
2590         if ($i%$cols == 0) { print "<tr>\n"; }
2591         print "<td width=$per% align=center valign=top>\n";
2592         &generate_icon($_[2]->[$i], $_[1]->[$i], $_[0]->[$i],
2593                        ref($_[4]) ? $_[4]->[$i] : $_[4], $_[5], $_[6],
2594                        $_[7]->[$i], $_[8]->[$i]);
2595         print "</td>\n";
2596         if ($i%$cols == $cols-1) { print "</tr>\n"; }
2597         }
2598 while($i++%$cols) { print "<td width=$per%></td>\n"; $need_tr++; }
2599 print "</tr>\n" if ($need_tr);
2600 print "</table>\n";
2601 }
2602
2603 =head2 replace_file_line(file, line, [newline]*)
2604
2605 Replaces one line in some file with 0 or more new lines. The parameters are :
2606
2607 =item file - Full path to some file, like /etc/hosts.
2608
2609 =item line - Line number to replace, starting from 0.
2610
2611 =item newline - Zero or more lines to put into the file at the given line number. These must be newline-terminated strings.
2612
2613 =cut
2614 sub replace_file_line
2615 {
2616 my @lines;
2617 my $realfile = &translate_filename($_[0]);
2618 open(FILE, $realfile);
2619 @lines = <FILE>;
2620 close(FILE);
2621 if (@_ > 2) { splice(@lines, $_[1], 1, @_[2..$#_]); }
2622 else { splice(@lines, $_[1], 1); }
2623 &open_tempfile(FILE, ">$realfile");
2624 &print_tempfile(FILE, @lines);
2625 &close_tempfile(FILE);
2626 }
2627
2628 =head2 read_file_lines(file, [readonly])
2629
2630 Returns a reference to an array containing the lines from some file. This
2631 array can be modified, and will be written out when flush_file_lines()
2632 is called. The parameters are :
2633
2634 =item file - Full path to the file to read.
2635
2636 =item readonly - Should be set 1 if the caller is only going to read the lines, and never write it out.
2637
2638 Example code :
2639
2640  $lref = read_file_lines("/etc/hosts");
2641  push(@$lref, "127.0.0.1 localhost");
2642  flush_file_lines("/etc/hosts");
2643
2644 =cut
2645 sub read_file_lines
2646 {
2647 if (!$_[0]) {
2648         my ($package, $filename, $line) = caller;
2649         print STDERR "Missing file to read at ${package}::${filename} line $line\n";
2650         }
2651 my $realfile = &translate_filename($_[0]);
2652 if (!$main::file_cache{$realfile}) {
2653         my (@lines, $eol);
2654         local $_;
2655         &webmin_debug_log('READ', $_[0]) if ($gconfig{'debug_what_read'});
2656         open(READFILE, $realfile);
2657         while(<READFILE>) {
2658                 if (!$eol) {
2659                         $eol = /\r\n$/ ? "\r\n" : "\n";
2660                         }
2661                 tr/\r\n//d;
2662                 push(@lines, $_);
2663                 }
2664         close(READFILE);
2665         $main::file_cache{$realfile} = \@lines;
2666         $main::file_cache_noflush{$realfile} = $_[1];
2667         $main::file_cache_eol{$realfile} = $eol || "\n";
2668         }
2669 else {
2670         # Make read-write if currently readonly
2671         if (!$_[1]) {
2672                 $main::file_cache_noflush{$realfile} = 0;
2673                 }
2674         }
2675 return $main::file_cache{$realfile};
2676 }
2677
2678 =head2 flush_file_lines([file], [eol])
2679
2680 Write out to a file previously read by read_file_lines to disk (except
2681 for those marked readonly). The parameters are :
2682
2683 =item file - The file to flush out.
2684
2685 =item eof - End-of-line character for each line. Defaults to \n.
2686
2687 =cut
2688 sub flush_file_lines
2689 {
2690 my @files;
2691 if ($_[0]) {
2692         local $trans = &translate_filename($_[0]);
2693         $main::file_cache{$trans} ||
2694                 &error("flush_file_lines called on non-loaded file $trans");
2695         push(@files, $trans);
2696         }
2697 else {
2698         @files = ( keys %main::file_cache );
2699         }
2700 foreach my $f (@files) {
2701         my $eol = $_[1] || $main::file_cache_eol{$f} || "\n";
2702         if (!$main::file_cache_noflush{$f}) {
2703                 no warnings; # XXX Bareword file handles should go away
2704                 &open_tempfile(FLUSHFILE, ">$f");
2705                 foreach my $line (@{$main::file_cache{$f}}) {
2706                         (print FLUSHFILE $line,$eol) ||
2707                                 &error(&text("efilewrite", $f, $!));
2708                         }
2709                 &close_tempfile(FLUSHFILE);
2710                 }
2711         delete($main::file_cache{$f});
2712         delete($main::file_cache_noflush{$f});
2713         }
2714 }
2715
2716 =head2 unflush_file_lines(file)
2717
2718 Clear the internal cache of some given file, previously read by read_file_lines.
2719
2720 =cut
2721 sub unflush_file_lines
2722 {
2723 my $realfile = &translate_filename($_[0]);
2724 delete($main::file_cache{$realfile});
2725 delete($main::file_cache_noflush{$realfile});
2726 }
2727
2728 =head2 unix_user_input(fieldname, user, [form])
2729
2730 Returns HTML for an input to select a Unix user. By default this is a text
2731 box with a user popup button next to it.
2732
2733 =cut
2734 sub unix_user_input
2735 {
2736 if (defined(&theme_unix_user_input)) {
2737         return &theme_unix_user_input(@_);
2738         }
2739 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
2740        &user_chooser_button($_[0], 0, $_[2] || 0)."\n";
2741 }
2742
2743 =head2 unix_group_input(fieldname, user, [form])
2744
2745 Returns HTML for an input to select a Unix group. By default this is a text
2746 box with a group popup button next to it.
2747
2748 =cut
2749 sub unix_group_input
2750 {
2751 if (defined(&theme_unix_group_input)) {
2752         return &theme_unix_group_input(@_);
2753         }
2754 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
2755        &group_chooser_button($_[0], 0, $_[2] || 0)."\n";
2756 }
2757
2758 =head2 hlink(text, page, [module], [width], [height])
2759
2760 Returns HTML for a link that when clicked on pops up a window for a Webmin
2761 help page. The parameters are :
2762
2763 =item text - Text for the link.
2764
2765 =item page - Help page code, such as 'intro'.
2766
2767 =item module - Module the help page is in. Defaults to the current module.
2768
2769 =item width - Width of the help popup window. Defaults to 600 pixels.
2770
2771 =item height - Height of the help popup window. Defaults to 400 pixels.
2772
2773 The actual help pages are in each module's help sub-directory, in files with
2774 .html extensions.
2775
2776 =cut
2777 sub hlink
2778 {
2779 if (defined(&theme_hlink)) {
2780         return &theme_hlink(@_);
2781         }
2782 my $mod = $_[2] ? $_[2] : &get_module_name();
2783 my $width = $_[3] || $tconfig{'help_width'} || $gconfig{'help_width'} || 600;
2784 my $height = $_[4] || $tconfig{'help_height'} || $gconfig{'help_height'} || 400;
2785 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>";
2786 }
2787
2788 =head2 user_chooser_button(field, multiple, [form])
2789
2790 Returns HTML for a javascript button for choosing a Unix user or users.
2791 The parameters are :
2792
2793 =item field - Name of the HTML field to place the username into.
2794
2795 =item multiple - Set to 1 if multiple users can be selected.
2796
2797 =item form - Index of the form on the page.
2798
2799 =cut
2800 sub user_chooser_button
2801 {
2802 return undef if (!&supports_users());
2803 return &theme_user_chooser_button(@_)
2804         if (defined(&theme_user_chooser_button));
2805 my $form = defined($_[2]) ? $_[2] : 0;
2806 my $w = $_[1] ? 500 : 300;
2807 my $h = 200;
2808 if ($_[1] && $gconfig{'db_sizeusers'}) {
2809         ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
2810         }
2811 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
2812         ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
2813         }
2814 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";
2815 }
2816
2817 =head2 group_chooser_button(field, multiple, [form])
2818
2819 Returns HTML for a javascript button for choosing a Unix group or groups
2820 The parameters are :
2821
2822 =item field - Name of the HTML field to place the group name into.
2823
2824 =item multiple - Set to 1 if multiple groups can be selected.
2825
2826 =item form - Index of the form on the page.
2827
2828 =cut
2829 sub group_chooser_button
2830 {
2831 return undef if (!&supports_users());
2832 return &theme_group_chooser_button(@_)
2833         if (defined(&theme_group_chooser_button));
2834 my $form = defined($_[2]) ? $_[2] : 0;
2835 my $w = $_[1] ? 500 : 300;
2836 my $h = 200;
2837 if ($_[1] && $gconfig{'db_sizeusers'}) {
2838         ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
2839         }
2840 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
2841         ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
2842         }
2843 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";
2844 }
2845
2846 =head2 foreign_check(module, [api-only])
2847
2848 Checks if some other module exists and is supported on this OS. The parameters
2849 are :
2850
2851 =item module - Name of the module to check.
2852
2853 =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.
2854
2855 =cut
2856 sub foreign_check
2857 {
2858 my ($mod, $api) = @_;
2859 my %minfo;
2860 my $mdir = &module_root_directory($mod);
2861 &read_file_cached("$mdir/module.info", \%minfo) || return 0;
2862 return &check_os_support(\%minfo, undef, undef, $api);
2863 }
2864
2865 =head2 foreign_exists(module)
2866
2867 Checks if some other module exists. The module parameter is the short module
2868 name.
2869
2870 =cut
2871 sub foreign_exists
2872 {
2873 my $mdir = &module_root_directory($_[0]);
2874 return -r "$mdir/module.info";
2875 }
2876
2877 =head2 foreign_available(module)
2878
2879 Returns 1 if some module is installed, and acessible to the current user. The
2880 module parameter is the module directory name.
2881
2882 =cut
2883 sub foreign_available
2884 {
2885 return 0 if (!&foreign_check($_[0]) &&
2886              !$gconfig{'available_even_if_no_support'});
2887 my %foreign_module_info = &get_module_info($_[0]);
2888
2889 # Check list of allowed modules
2890 my %acl;
2891 &read_acl(\%acl, undef);
2892 return 0 if (!$acl{$base_remote_user,$_[0]} &&
2893              !$acl{$base_remote_user,'*'});
2894
2895 # Check for usermod restrictions
2896 my @usermods = &list_usermods();
2897 return 0 if (!&available_usermods( [ \%foreign_module_info ], \@usermods));
2898
2899 if (&get_product_name() eq "webmin") {
2900         # Check if the user has any RBAC privileges in this module
2901         if (&supports_rbac($_[0]) &&
2902             &use_rbac_module_acl(undef, $_[0])) {
2903                 # RBAC is enabled for this user and module - check if he
2904                 # has any rights
2905                 my $rbacs = &get_rbac_module_acl($remote_user, $_[0]);
2906                 return 0 if (!$rbacs);
2907                 }
2908         elsif ($gconfig{'rbacdeny_'.$base_remote_user}) {
2909                 # If denying access to modules not specifically allowed by
2910                 # RBAC, then prevent access
2911                 return 0;
2912                 }
2913         }
2914
2915 # Check readonly support
2916 if (&is_readonly_mode()) {
2917         return 0 if (!$foreign_module_info{'readonly'});
2918         }
2919
2920 # Check if theme vetos
2921 if (defined(&theme_foreign_available)) {
2922         return 0 if (!&theme_foreign_available($_[0]));
2923         }
2924
2925 # Check if licence module vetos
2926 if ($main::licence_module) {
2927         return 0 if (!&foreign_call($main::licence_module,
2928                                     "check_module_licence", $_[0]));
2929         }
2930
2931 return 1;
2932 }
2933
2934 =head2 foreign_require(module, [file], [package])
2935
2936 Brings in functions from another module, and places them in the Perl namespace
2937 with the same name as the module. The parameters are :
2938
2939 =item module - The source module's directory name, like sendmail.
2940
2941 =item file - The API file in that module, like sendmail-lib.pl. If missing, all API files are loaded.
2942
2943 =item package - Perl package to place the module's functions and global variables in.
2944
2945 If the original module name contains dashes, they will be replaced with _ in
2946 the package name.
2947
2948 =cut
2949 sub foreign_require
2950 {
2951 my ($mod, $file, $pkg) = @_;
2952 $pkg ||= $mod || "global";
2953 $pkg =~ s/[^A-Za-z0-9]/_/g;
2954 my @files;
2955 if ($file) {
2956         push(@files, $file);
2957         }
2958 else {
2959         # Auto-detect files
2960         my %minfo = &get_module_info($mod);
2961         if ($minfo{'library'}) {
2962                 @files = split(/\s+/, $minfo{'library'});
2963                 }
2964         else {
2965                 @files = ( $mod."-lib.pl" );
2966                 }
2967         }
2968 @files = grep { !$main::done_foreign_require{$pkg,$_} } @files;
2969 return 1 if (!@files);
2970 foreach my $f (@files) {
2971         $main::done_foreign_require{$pkg,$f}++;
2972         }
2973 my @OLDINC = @INC;
2974 my $mdir = &module_root_directory($mod);
2975 @INC = &unique($mdir, @INC);
2976 -d $mdir || &error("Module $mod does not exist");
2977 if (!&get_module_name() && $mod) {
2978         chdir($mdir);
2979         }
2980 my $old_fmn = $ENV{'FOREIGN_MODULE_NAME'};
2981 my $old_frd = $ENV{'FOREIGN_ROOT_DIRECTORY'};
2982 my $code = "package $pkg; ".
2983            "\$ENV{'FOREIGN_MODULE_NAME'} = '$mod'; ".
2984            "\$ENV{'FOREIGN_ROOT_DIRECTORY'} = '$root_directory'; ";
2985 foreach my $f (@files) {
2986         $code .= "do '$mdir/$f' || die \$@; ";
2987         }
2988 eval $code;
2989 if (defined($old_fmn)) {
2990         $ENV{'FOREIGN_MODULE_NAME'} = $old_fmn;
2991         }
2992 else {
2993         delete($ENV{'FOREIGN_MODULE_NAME'});
2994         }
2995 if (defined($old_frd)) {
2996         $ENV{'FOREIGN_ROOT_DIRECTORY'} = $old_frd;
2997         }
2998 else {
2999         delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
3000         }
3001 @INC = @OLDINC;
3002 if ($@) { &error("Require $mod/$files[0] failed : <pre>$@</pre>"); }
3003 return 1;
3004 }
3005
3006 =head2 foreign_call(module, function, [arg]*)
3007
3008 Call a function in another module. The module parameter is the target module
3009 directory name, function is the perl sub to call, and the remaining parameters
3010 are the arguments. However, unless you need to call a function whose name
3011 is dynamic, it is better to use Perl's cross-module function call syntax
3012 like module::function(args).
3013
3014 =cut
3015 sub foreign_call
3016 {
3017 my $pkg = $_[0] || "global";
3018 $pkg =~ s/[^A-Za-z0-9]/_/g;
3019 my @args = @_[2 .. @_-1];
3020 $main::foreign_args = \@args;
3021 my @rv = eval <<EOF;
3022 package $pkg;
3023 &$_[1](\@{\$main::foreign_args});
3024 EOF
3025 if ($@) { &error("$_[0]::$_[1] failed : $@"); }
3026 return wantarray ? @rv : $rv[0];
3027 }
3028
3029 =head2 foreign_config(module, [user-config])
3030
3031 Get the configuration from another module, and return it as a hash. If the
3032 user-config parameter is set to 1, returns the Usermin user-level preferences
3033 for the current user instead.
3034
3035 =cut
3036 sub foreign_config
3037 {
3038 my ($mod, $uc) = @_;
3039 my %fconfig;
3040 if ($uc) {
3041         &read_file_cached("$root_directory/$mod/defaultuconfig", \%fconfig);
3042         &read_file_cached("$config_directory/$mod/uconfig", \%fconfig);
3043         &read_file_cached("$user_config_directory/$mod/config", \%fconfig);
3044         }
3045 else {
3046         &read_file_cached("$config_directory/$mod/config", \%fconfig);
3047         }
3048 return %fconfig;
3049 }
3050
3051 =head2 foreign_installed(module, mode)
3052
3053 Checks if the server for some module is installed, and possibly also checks
3054 if the module has been configured by Webmin.
3055 For mode 1, returns 2 if the server is installed and configured for use by
3056 Webmin, 1 if installed but not configured, or 0 otherwise.
3057 For mode 0, returns 1 if installed, 0 if not.
3058 If the module does not provide an install_check.pl script, assumes that
3059 the server is installed.
3060
3061 =cut
3062 sub foreign_installed
3063 {
3064 my ($mod, $configured) = @_;
3065 if (defined($main::foreign_installed_cache{$mod,$configured})) {
3066         # Already cached..
3067         return $main::foreign_installed_cache{$mod,$configured};
3068         }
3069 else {
3070         my $rv;
3071         if (!&foreign_check($mod)) {
3072                 # Module is missing
3073                 $rv = 0;
3074                 }
3075         else {
3076                 my $mdir = &module_root_directory($mod);
3077                 if (!-r "$mdir/install_check.pl") {
3078                         # Not known, assume OK
3079                         $rv = $configured ? 2 : 1;
3080                         }
3081                 else {
3082                         # Call function to check
3083                         &foreign_require($mod, "install_check.pl");
3084                         $rv = &foreign_call($mod, "is_installed", $configured);
3085                         }
3086                 }
3087         $main::foreign_installed_cache{$mod,$configured} = $rv;
3088         return $rv;
3089         }
3090 }
3091
3092 =head2 foreign_defined(module, function)
3093
3094 Returns 1 if some function is defined in another module. In general, it is
3095 simpler to use the syntax &defined(module::function) instead.
3096
3097 =cut
3098 sub foreign_defined
3099 {
3100 my ($pkg) = @_;
3101 $pkg =~ s/[^A-Za-z0-9]/_/g;
3102 my $func = "${pkg}::$_[1]";
3103 return defined(&$func);
3104 }
3105
3106 =head2 get_system_hostname([short])
3107
3108 Returns the hostname of this system. If the short parameter is set to 1,
3109 then the domain name is not prepended - otherwise, Webmin will attempt to get
3110 the fully qualified hostname, like foo.example.com.
3111
3112 =cut
3113 sub get_system_hostname
3114 {
3115 my $m = int($_[0]);
3116 if (!$main::get_system_hostname[$m]) {
3117         if ($gconfig{'os_type'} ne 'windows') {
3118                 # Try some common Linux hostname files first
3119                 my $fromfile;
3120                 if ($gconfig{'os_type'} eq 'redhat-linux') {
3121                         my %nc;
3122                         &read_env_file("/etc/sysconfig/network", \%nc);
3123                         if ($nc{'HOSTNAME'}) {
3124                                 $fromfile = $nc{'HOSTNAME'};
3125                                 }
3126                         }
3127                 elsif ($gconfig{'os_type'} eq 'debian-linux') {
3128                         my $hn = &read_file_contents("/etc/hostname");
3129                         if ($hn) {
3130                                 $hn =~ s/\r|\n//g;
3131                                 $fromfile = $hn;
3132                                 }
3133                         }
3134                 elsif ($gconfig{'os_type'} eq 'open-linux') {
3135                         my $hn = &read_file_contents("/etc/HOSTNAME");
3136                         if ($hn) {
3137                                 $hn =~ s/\r|\n//g;
3138                                 $fromfile = $hn;
3139                                 }
3140                         }
3141                 elsif ($gconfig{'os_type'} eq 'solaris') {
3142                         my $hn = &read_file_contents("/etc/nodename");
3143                         if ($hn) {
3144                                 $hn =~ s/\r|\n//g;
3145                                 $fromfile = $hn;
3146                                 }
3147                         }
3148
3149                 # If we found a hostname, use it if value
3150                 if ($fromfile && ($m || $fromfile =~ /\./)) {
3151                         if ($m) {
3152                                 $fromfile =~ s/\..*$//;
3153                                 }
3154                         $main::get_system_hostname[$m] = $fromfile;
3155                         return $fromfile;
3156                         }
3157
3158                 # Can use hostname command on Unix
3159                 &execute_command("hostname", undef,
3160                                  \$main::get_system_hostname[$m], undef, 0, 1);
3161                 chop($main::get_system_hostname[$m]);
3162                 if ($?) {
3163                         eval "use Sys::Hostname";
3164                         if (!$@) {
3165                                 $main::get_system_hostname[$m] = eval "hostname()";
3166                                 }
3167                         if ($@ || !$main::get_system_hostname[$m]) {
3168                                 $main::get_system_hostname[$m] = "UNKNOWN";
3169                                 }
3170                         }
3171                 elsif ($main::get_system_hostname[$m] !~ /\./ &&
3172                        $gconfig{'os_type'} =~ /linux$/ &&
3173                        !$gconfig{'no_hostname_f'} && !$_[0]) {
3174                         # Try with -f flag to get fully qualified name
3175                         my $flag;
3176                         my $ex = &execute_command("hostname -f", undef, \$flag,
3177                                                   undef, 0, 1);
3178                         chop($flag);
3179                         if ($ex || $flag eq "") {
3180                                 # -f not supported! We have probably set the
3181                                 # hostname to just '-f'. Fix the problem
3182                                 # (if we are root)
3183                                 if ($< == 0) {
3184                                         &execute_command("hostname ".
3185                                                 quotemeta($main::get_system_hostname[$m]),
3186                                                 undef, undef, undef, 0, 1);
3187                                         }
3188                                 }
3189                         else {
3190                                 $main::get_system_hostname[$m] = $flag;
3191                                 }
3192                         }
3193                 }
3194         else {
3195                 # On Windows, try computername environment variable
3196                 return $ENV{'computername'} if ($ENV{'computername'});
3197                 return $ENV{'COMPUTERNAME'} if ($ENV{'COMPUTERNAME'});
3198
3199                 # Fall back to net name command
3200                 my $out = `net name 2>&1`;
3201                 if ($out =~ /\-+\r?\n(\S+)/) {
3202                         $main::get_system_hostname[$m] = $1;
3203                         }
3204                 else {
3205                         $main::get_system_hostname[$m] = "windows";
3206                         }
3207                 }
3208         }
3209 return $main::get_system_hostname[$m];
3210 }
3211
3212 =head2 get_webmin_version
3213
3214 Returns the version of Webmin currently being run, such as 1.450.
3215
3216 =cut
3217 sub get_webmin_version
3218 {
3219 if (!$get_webmin_version) {
3220         open(VERSION, "$root_directory/version") || return 0;
3221         ($get_webmin_version = <VERSION>) =~ tr/\r|\n//d;
3222         close(VERSION);
3223         }
3224 return $get_webmin_version;
3225 }
3226
3227 =head2 get_module_acl([user], [module], [no-rbac], [no-default])
3228
3229 Returns a hash containing access control options for the given user and module.
3230 By default the current username and module name are used. If the no-rbac flag
3231 is given, the permissions will not be updated based on the user's RBAC role
3232 (as seen on Solaris). If the no-default flag is given, default permissions for
3233 the module will not be included.
3234
3235 =cut
3236 sub get_module_acl
3237 {
3238 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
3239 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3240 my $mdir = &module_root_directory($m);
3241 my %rv;
3242 if (!$_[3]) {
3243         # Read default ACL first, to be overridden by per-user settings
3244         &read_file_cached("$mdir/defaultacl", \%rv);
3245
3246         # If this isn't a master admin user, apply the negative permissions
3247         # so that he doesn't un-expectedly gain access to new features
3248         my %gacccess;
3249         &read_file_cached("$config_directory/$u.acl", \%gaccess);
3250         if ($gaccess{'negative'}) {
3251                 &read_file_cached("$mdir/negativeacl", \%rv);
3252                 }
3253         }
3254 my %usersacl;
3255 if (!$_[2] && &supports_rbac($m) && &use_rbac_module_acl($u, $m)) {
3256         # RBAC overrides exist for this user in this module
3257         my $rbac = &get_rbac_module_acl(
3258                         defined($_[0]) ? $_[0] : $remote_user, $m);
3259         foreach my $r (keys %$rbac) {
3260                 $rv{$r} = $rbac->{$r};
3261                 }
3262         }
3263 elsif ($gconfig{"risk_$u"} && $m) {
3264         # ACL is defined by user's risk level
3265         my $rf = $gconfig{"risk_$u"}.'.risk';
3266         &read_file_cached("$mdir/$rf", \%rv);
3267
3268         my $sf = $gconfig{"skill_$u"}.'.skill';
3269         &read_file_cached("$mdir/$sf", \%rv);
3270         }
3271 elsif ($u ne '') {
3272         # Use normal Webmin ACL, if a user is set
3273         &read_file_cached("$config_directory/$m/$u.acl", \%rv);
3274         if ($remote_user ne $base_remote_user && !defined($_[0])) {
3275                 &read_file_cached("$config_directory/$m/$remote_user.acl",\%rv);
3276                 }
3277         }
3278 if ($tconfig{'preload_functions'}) {
3279         &load_theme_library();
3280         }
3281 if (defined(&theme_get_module_acl)) {
3282         %rv = &theme_get_module_acl($u, $m, \%rv);
3283         }
3284 return %rv;
3285 }
3286
3287 =head2 get_group_module_acl(group, [module])
3288
3289 Returns the ACL for a Webmin group, in an optional module (which defaults to
3290 the current module).
3291
3292 =cut
3293 sub get_group_module_acl
3294 {
3295 my $g = $_[0];
3296 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3297 my $mdir = &module_root_directory($m);
3298 my %rv;
3299 &read_file_cached("$mdir/defaultacl", \%rv);
3300 &read_file_cached("$config_directory/$m/$g.gacl", \%rv);
3301 if (defined(&theme_get_module_acl)) {
3302         %rv = &theme_get_module_acl($g, $m, \%rv);
3303         }
3304 return %rv;
3305 }
3306
3307 =head2 save_module_acl(&acl, [user], [module])
3308
3309 Updates the acl hash for some user and module. The parameters are :
3310
3311 =item acl - Hash reference for the new access control options.
3312
3313 =item user - User to update, defaulting to the current user.
3314
3315 =item module - Module to update, defaulting to the caller.
3316
3317 =cut
3318 sub save_module_acl
3319 {
3320 my $u = defined($_[1]) ? $_[1] : $base_remote_user;
3321 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3322 if (&foreign_check("acl")) {
3323         # Check if this user is a member of a group, and if he gets the
3324         # module from a group. If so, update its ACL as well
3325         &foreign_require("acl", "acl-lib.pl");
3326         my $group;
3327         foreach my $g (&acl::list_groups()) {
3328                 if (&indexof($u, @{$g->{'members'}}) >= 0 &&
3329                     &indexof($m, @{$g->{'modules'}}) >= 0) {
3330                         $group = $g;
3331                         last;
3332                         }
3333                 }
3334         if ($group) {
3335                 &save_group_module_acl($_[0], $group->{'name'}, $m);
3336                 }
3337         }
3338 if (!-d "$config_directory/$m") {
3339         mkdir("$config_directory/$m", 0755);
3340         }
3341 &write_file("$config_directory/$m/$u.acl", $_[0]);
3342 }
3343
3344 =head2 save_group_module_acl(&acl, group, [module])
3345
3346 Updates the acl hash for some group and module. The parameters are :
3347
3348 =item acl - Hash reference for the new access control options.
3349
3350 =item group - Group name to update.
3351
3352 =item module - Module to update, defaulting to the caller.
3353
3354 =cut
3355 sub save_group_module_acl
3356 {
3357 my $g = $_[1];
3358 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3359 if (&foreign_check("acl")) {
3360         # Check if this group is a member of a group, and if it gets the
3361         # module from a group. If so, update the parent ACL as well
3362         &foreign_require("acl", "acl-lib.pl");
3363         my $group;
3364         foreach my $pg (&acl::list_groups()) {
3365                 if (&indexof('@'.$g, @{$pg->{'members'}}) >= 0 &&
3366                     &indexof($m, @{$pg->{'modules'}}) >= 0) {
3367                         $group = $g;
3368                         last;
3369                         }
3370                 }
3371         if ($group) {
3372                 &save_group_module_acl($_[0], $group->{'name'}, $m);
3373                 }
3374         }
3375 if (!-d "$config_directory/$m") {
3376         mkdir("$config_directory/$m", 0755);
3377         }
3378 &write_file("$config_directory/$m/$g.gacl", $_[0]);
3379 }
3380
3381 =head2 init_config
3382
3383 This function must be called by all Webmin CGI scripts, either directly or
3384 indirectly via a per-module lib.pl file. It performs a number of initialization
3385 and housekeeping tasks, such as working out the module name, checking that the
3386 current user has access to the module, and populating global variables. Some
3387 of the variables set include :
3388
3389 =item $config_directory - Base Webmin config directory, typically /etc/webmin
3390
3391 =item $var_directory - Base logs directory, typically /var/webmin
3392
3393 =item %config - Per-module configuration.
3394
3395 =item %gconfig - Global configuration.
3396
3397 =item $scriptname - Base name of the current perl script.
3398
3399 =item $module_name - The name of the current module.
3400
3401 =item $module_config_directory - The config directory for this module.
3402
3403 =item $module_config_file - The config file for this module.
3404
3405 =item $module_root_directory - This module's code directory.
3406
3407 =item $webmin_logfile - The detailed logfile for webmin.
3408
3409 =item $remote_user - The actual username used to login to webmin.
3410
3411 =item $base_remote_user - The username whose permissions are in effect.
3412
3413 =item $current_theme - The theme currently in use.
3414
3415 =item $root_directory - The first root directory of this webmin install.
3416
3417 =item @root_directories - All root directories for this webmin install.
3418
3419 =cut
3420 sub init_config
3421 {
3422 # Record first process ID that called this, so we know when it exited to clean
3423 # up temp files
3424 $main::initial_process_id ||= $$;
3425
3426 # Configuration and spool directories
3427 if (!defined($ENV{'WEBMIN_CONFIG'})) {
3428         die "WEBMIN_CONFIG not set";
3429         }
3430 $config_directory = $ENV{'WEBMIN_CONFIG'};
3431 if (!defined($ENV{'WEBMIN_VAR'})) {
3432         open(VARPATH, "$config_directory/var-path");
3433         chop($var_directory = <VARPATH>);
3434         close(VARPATH);
3435         }
3436 else {
3437         $var_directory = $ENV{'WEBMIN_VAR'};
3438         }
3439 $main::http_cache_directory = $ENV{'WEBMIN_VAR'}."/cache";
3440 $main::default_debug_log_file = $ENV{'WEBMIN_VAR'}."/webmin.debug";
3441
3442 if ($ENV{'SESSION_ID'}) {
3443         # Hide this variable from called programs, but keep it for internal use
3444         $main::session_id = $ENV{'SESSION_ID'};
3445         delete($ENV{'SESSION_ID'});
3446         }
3447 if ($ENV{'REMOTE_PASS'}) {
3448         # Hide the password too
3449         $main::remote_pass = $ENV{'REMOTE_PASS'};
3450         delete($ENV{'REMOTE_PASS'});
3451         }
3452
3453 if ($> == 0 && $< != 0 && !$ENV{'FOREIGN_MODULE_NAME'}) {
3454         # Looks like we are running setuid, but the real UID hasn't been set.
3455         # Do so now, so that executed programs don't get confused
3456         $( = $);
3457         $< = $>;
3458         }
3459
3460 # Read the webmin global config file. This contains the OS type and version,
3461 # OS specific configuration and global options such as proxy servers
3462 $config_file = "$config_directory/config";
3463 %gconfig = ( );
3464 &read_file_cached($config_file, \%gconfig);
3465 $null_file = $gconfig{'os_type'} eq 'windows' ? "NUL" : "/dev/null";
3466 $path_separator = $gconfig{'os_type'} eq 'windows' ? ';' : ':';
3467
3468 # If debugging is enabled, open the debug log
3469 if ($gconfig{'debug_enabled'} && !$main::opened_debug_log++) {
3470         my $dlog = $gconfig{'debug_file'} || $main::default_debug_log_file;
3471         if ($gconfig{'debug_size'}) {
3472                 my @st = stat($dlog);
3473                 if ($st[7] > $gconfig{'debug_size'}) {
3474                         rename($dlog, $dlog.".0");
3475                         }
3476                 }
3477         open(main::DEBUGLOG, ">>$dlog");
3478         $main::opened_debug_log = 1;
3479
3480         if ($gconfig{'debug_what_start'}) {
3481                 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
3482                 $main::debug_log_start_time = time();
3483                 &webmin_debug_log("START", "script=$script_name");
3484                 $main::debug_log_start_module = $module_name;
3485                 }
3486         }
3487
3488 # Set PATH and LD_LIBRARY_PATH
3489 if ($gconfig{'path'}) {
3490         if ($gconfig{'syspath'}) {
3491                 # Webmin only
3492                 $ENV{'PATH'} = $gconfig{'path'};
3493                 }
3494         else {
3495                 # Include OS too
3496                 $ENV{'PATH'} = $gconfig{'path'}.$path_separator.$ENV{'PATH'};
3497                 }
3498         }
3499 $ENV{$gconfig{'ld_env'}} = $gconfig{'ld_path'} if ($gconfig{'ld_env'});
3500
3501 # Set http_proxy and ftp_proxy environment variables, based on Webmin settings
3502 if ($gconfig{'http_proxy'}) {
3503         $ENV{'http_proxy'} = $gconfig{'http_proxy'};
3504         }
3505 if ($gconfig{'ftp_proxy'}) {
3506         $ENV{'ftp_proxy'} = $gconfig{'ftp_proxy'};
3507         }
3508 if ($gconfig{'noproxy'}) {
3509         $ENV{'no_proxy'} = $gconfig{'noproxy'};
3510         }
3511
3512 # Find all root directories
3513 my %miniserv;
3514 if (&get_miniserv_config(\%miniserv)) {
3515         @root_directories = ( $miniserv{'root'} );
3516         for($i=0; defined($miniserv{"extraroot_$i"}); $i++) {
3517                 push(@root_directories, $miniserv{"extraroot_$i"});
3518                 }
3519         }
3520
3521 # Work out which module we are in, and read the per-module config file
3522 $0 =~ s/\\/\//g;        # Force consistent path on Windows
3523 if (defined($ENV{'FOREIGN_MODULE_NAME'})) {
3524         # In a foreign call - use the module name given
3525         $root_directory = $ENV{'FOREIGN_ROOT_DIRECTORY'};
3526         $module_name = $ENV{'FOREIGN_MODULE_NAME'};
3527         @root_directories = ( $root_directory ) if (!@root_directories);
3528         }
3529 elsif ($ENV{'SCRIPT_NAME'}) {
3530         my $sn = $ENV{'SCRIPT_NAME'};
3531         $sn =~ s/^$gconfig{'webprefix'}//
3532                 if (!$gconfig{'webprefixnoredir'});
3533         if ($sn =~ /^\/([^\/]+)\//) {
3534                 # Get module name from CGI path
3535                 $module_name = $1;
3536                 }
3537         if ($ENV{'SERVER_ROOT'}) {
3538                 $root_directory = $ENV{'SERVER_ROOT'};
3539                 }
3540         elsif ($ENV{'SCRIPT_FILENAME'}) {
3541                 $root_directory = $ENV{'SCRIPT_FILENAME'};
3542                 $root_directory =~ s/$sn$//;
3543                 }
3544         @root_directories = ( $root_directory ) if (!@root_directories);
3545         }
3546 else {
3547         # Get root directory from miniserv.conf, and deduce module name from $0
3548         $root_directory = $root_directories[0];
3549         my $rok = 0;
3550         foreach my $r (@root_directories) {
3551                 if ($0 =~ /^$r\/([^\/]+)\/[^\/]+$/i) {
3552                         # Under a module directory
3553                         $module_name = $1;
3554                         $rok = 1;
3555                         last;
3556                         }
3557                 elsif ($0 =~ /^$root_directory\/[^\/]+$/i) {
3558                         # At the top level
3559                         $rok = 1;
3560                         last;
3561                         }
3562                 }
3563         &error("Script was not run with full path (failed to find $0 under $root_directory)") if (!$rok);
3564         }
3565
3566 # Work out of this is a web, command line or cron job
3567 if (!$main::webmin_script_type) {
3568         if ($ENV{'SCRIPT_NAME'}) {
3569                 # Run via a CGI
3570                 $main::webmin_script_type = 'web';
3571                 }
3572         else {
3573                 # Cron jobs have no TTY
3574                 if ($gconfig{'os_type'} eq 'windows' ||
3575                     open(DEVTTY, ">/dev/tty")) {
3576                         $main::webmin_script_type = 'cmd';
3577                         close(DEVTTY);
3578                         }
3579                 else {
3580                         $main::webmin_script_type = 'cron';
3581                         }
3582                 }
3583         }
3584
3585 # Set the umask based on config
3586 if ($gconfig{'umask'} && !$main::umask_already++) {
3587         umask(oct($gconfig{'umask'}));
3588         }
3589
3590 # If this is a cron job or other background task, set the nice level
3591 if (!$main::nice_already && $main::webmin_script_type eq 'cron') {
3592         # Set nice level
3593         if ($gconfig{'nice'}) {
3594                 eval 'POSIX::nice($gconfig{\'nice\'});';
3595                 }
3596
3597         # Set IO scheduling class and priority
3598         if ($gconfig{'sclass'} ne '' || $gconfig{'sprio'} ne '') {
3599                 my $cmd = "ionice";
3600                 $cmd .= " -c ".quotemeta($gconfig{'sclass'})
3601                         if ($gconfig{'sclass'} ne '');
3602                 $cmd .= " -n ".quotemeta($gconfig{'sprio'})
3603                         if ($gconfig{'sprio'} ne '');
3604                 $cmd .= " -p $$";
3605                 &execute_command("$cmd >/dev/null 2>&1");
3606                 }
3607         }
3608 $main::nice_already++;
3609
3610 # Get the username
3611 my $u = $ENV{'BASE_REMOTE_USER'} || $ENV{'REMOTE_USER'};
3612 $base_remote_user = $u;
3613 $remote_user = $ENV{'REMOTE_USER'};
3614
3615 if ($module_name) {
3616         # Find and load the configuration file for this module
3617         my (@ruinfo, $rgroup);
3618         $module_config_directory = "$config_directory/$module_name";
3619         if (&get_product_name() eq "usermin" &&
3620             -r "$module_config_directory/config.$remote_user") {
3621                 # Based on username
3622                 $module_config_file = "$module_config_directory/config.$remote_user";
3623                 }
3624         elsif (&get_product_name() eq "usermin" &&
3625             (@ruinfo = getpwnam($remote_user)) &&
3626             ($rgroup = getgrgid($ruinfo[3])) &&
3627             -r "$module_config_directory/config.\@$rgroup") {
3628                 # Based on group name
3629                 $module_config_file = "$module_config_directory/config.\@$rgroup";
3630                 }
3631         else {
3632                 # Global config
3633                 $module_config_file = "$module_config_directory/config";
3634                 }
3635         %config = ( );
3636         &read_file_cached($module_config_file, \%config);
3637
3638         # Fix up windows-specific substitutions in values
3639         foreach my $k (keys %config) {
3640                 if ($config{$k} =~ /\$\{systemroot\}/) {
3641                         my $root = &get_windows_root();
3642                         $config{$k} =~ s/\$\{systemroot\}/$root/g;
3643                         }
3644                 }
3645         }
3646
3647 # Record the initial module
3648 $main::initial_module_name ||= $module_name;
3649
3650 # Set some useful variables
3651 my $current_themes;
3652 $current_themes = $ENV{'MOBILE_DEVICE'} && defined($gconfig{'mobile_theme'}) ?
3653                     $gconfig{'mobile_theme'} :
3654                   defined($gconfig{'theme_'.$remote_user}) ?
3655                     $gconfig{'theme_'.$remote_user} :
3656                   defined($gconfig{'theme_'.$base_remote_user}) ?
3657                     $gconfig{'theme_'.$base_remote_user} :
3658                     $gconfig{'theme'};
3659 @current_themes = split(/\s+/, $current_themes);
3660 $current_theme = $current_themes[0];
3661 @theme_root_directories = map { "$root_directory/$_" } @current_themes;
3662 $theme_root_directory = $theme_root_directories[0];
3663 @theme_configs = ( );
3664 foreach my $troot (@theme_root_directories) {
3665         my %onetconfig;
3666         &read_file_cached("$troot/config", \%onetconfig);
3667         &read_file_cached("$troot/config", \%tconfig);
3668         push(@theme_configs, \%onetconfig);
3669         }
3670 $tb = defined($tconfig{'cs_header'}) ? "bgcolor=#$tconfig{'cs_header'}" :
3671       defined($gconfig{'cs_header'}) ? "bgcolor=#$gconfig{'cs_header'}" :
3672                                        "bgcolor=#9999ff";
3673 $cb = defined($tconfig{'cs_table'}) ? "bgcolor=#$tconfig{'cs_table'}" :
3674       defined($gconfig{'cs_table'}) ? "bgcolor=#$gconfig{'cs_table'}" :
3675                                       "bgcolor=#cccccc";
3676 $tb .= ' '.$tconfig{'tb'} if ($tconfig{'tb'});
3677 $cb .= ' '.$tconfig{'cb'} if ($tconfig{'cb'});
3678 if ($tconfig{'preload_functions'}) {
3679         # Force load of theme functions right now, if requested
3680         &load_theme_library();
3681         }
3682 if ($tconfig{'oofunctions'} && !$main::loaded_theme_oo_library++) {
3683         # Load the theme's Webmin:: package classes
3684         do "$theme_root_directory/$tconfig{'oofunctions'}";
3685         }
3686
3687 $0 =~ /([^\/]+)$/;
3688 $scriptname = $1;
3689 $webmin_logfile = $gconfig{'webmin_log'} ? $gconfig{'webmin_log'}
3690                                          : "$var_directory/webmin.log";
3691
3692 # Load language strings into %text
3693 my @langs = &list_languages();
3694 my $accepted_lang;
3695 if ($gconfig{'acceptlang'}) {
3696         foreach my $a (split(/,/, $ENV{'HTTP_ACCEPT_LANGUAGE'})) {
3697                 my ($al) = grep { $_->{'lang'} eq $a } @langs;
3698                 if ($al) {
3699                         $accepted_lang = $al->{'lang'};
3700                         last;
3701                         }
3702                 }
3703         }
3704 $current_lang = $force_lang ? $force_lang :
3705     $accepted_lang ? $accepted_lang :
3706     $gconfig{"lang_$remote_user"} ? $gconfig{"lang_$remote_user"} :
3707     $gconfig{"lang_$base_remote_user"} ? $gconfig{"lang_$base_remote_user"} :
3708     $gconfig{"lang"} ? $gconfig{"lang"} : $default_lang;
3709 foreach my $l (@langs) {
3710         $current_lang_info = $l if ($l->{'lang'} eq $current_lang);
3711         }
3712 @lang_order_list = &unique($default_lang,
3713                            split(/:/, $current_lang_info->{'fallback'}),
3714                            $current_lang);
3715 %text = &load_language($module_name);
3716 %text || &error("Failed to determine Webmin root from SERVER_ROOT, SCRIPT_FILENAME or the full command line");
3717
3718 # Get the %module_info for this module
3719 if ($module_name) {
3720         my ($mi) = grep { $_->{'dir'} eq $module_name }
3721                          &get_all_module_infos(2);
3722         %module_info = %$mi;
3723         $module_root_directory = &module_root_directory($module_name);
3724         }
3725
3726 if ($module_name && !$main::no_acl_check &&
3727     !defined($ENV{'FOREIGN_MODULE_NAME'})) {
3728         # Check if the HTTP user can access this module
3729         if (!&foreign_available($module_name)) {
3730                 if (!&foreign_check($module_name)) {
3731                         &error(&text('emodulecheck',
3732                                      "<i>$module_info{'desc'}</i>"));
3733                         }
3734                 else {
3735                         &error(&text('emodule', "<i>$u</i>",
3736                                      "<i>$module_info{'desc'}</i>"));
3737                         }
3738                 }
3739         $main::no_acl_check++;
3740         }
3741
3742 # Check the Referer: header for nasty redirects
3743 my @referers = split(/\s+/, $gconfig{'referers'});
3744 my $referer_site;
3745 if ($ENV{'HTTP_REFERER'} =~/^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?([^\/:@]+)/) {
3746         $referer_site = $3;
3747         }
3748 my $http_host = $ENV{'HTTP_HOST'};
3749 $http_host =~ s/:\d+$//;
3750 my $unsafe_index = $unsafe_index_cgi ||
3751                    &get_module_variable('$unsafe_index_cgi');
3752 if ($0 &&
3753     ($ENV{'SCRIPT_NAME'} !~ /^\/(index.cgi)?$/ || $unsafe_index) &&
3754     ($ENV{'SCRIPT_NAME'} !~ /^\/([a-z0-9\_\-]+)\/(index.cgi)?$/i ||
3755      $unsafe_index) &&
3756     $0 !~ /(session_login|pam_login)\.cgi$/ && !$gconfig{'referer'} &&
3757     $ENV{'MINISERV_CONFIG'} && !$main::no_referers_check &&
3758     $ENV{'HTTP_USER_AGENT'} !~ /^Webmin/i &&
3759     ($referer_site && $referer_site ne $http_host &&
3760      &indexof($referer_site, @referers) < 0 ||
3761     !$referer_site && $gconfig{'referers_none'}) &&
3762     !$trust_unknown_referers &&
3763     !&get_module_variable('$trust_unknown_referers')) {
3764         # Looks like a link from elsewhere .. show an error
3765         &header($text{'referer_title'}, "", undef, 0, 1, 1);
3766
3767         $prot = lc($ENV{'HTTPS'}) eq 'on' ? "https" : "http";
3768         my $url = "<tt>".&html_escape("$prot://$ENV{'HTTP_HOST'}$ENV{'REQUEST_URI'}")."</tt>";
3769         if ($referer_site) {
3770                 # From a known host
3771                 print &text('referer_warn',
3772                      "<tt>".&html_escape($ENV{'HTTP_REFERER'})."</tt>", $url);
3773                 print "<p>\n";
3774                 print &text('referer_fix1', &html_escape($http_host)),"<p>\n";
3775                 print &text('referer_fix2', &html_escape($http_host)),"<p>\n";
3776                 }
3777         else {
3778                 # No referer info given
3779                 print &text('referer_warn_unknown', $url),"<p>\n";
3780                 print &text('referer_fix1u'),"<p>\n";
3781                 print &text('referer_fix2u'),"<p>\n";
3782                 }
3783         print "<p>\n";
3784
3785         &footer("/", $text{'index'});
3786         exit;
3787         }
3788 $main::no_referers_check++;
3789 $main::completed_referers_check++;
3790
3791 # Call theme post-init
3792 if (defined(&theme_post_init_config)) {
3793         &theme_post_init_config(@_);
3794         }
3795
3796 # Record that we have done the calling library in this package
3797 my ($callpkg, $lib) = caller();
3798 $lib =~ s/^.*\///;
3799 $main::done_foreign_require{$callpkg,$lib} = 1;
3800
3801 # If a licence checking is enabled, do it now
3802 if ($gconfig{'licence_module'} && !$main::done_licence_module_check &&
3803     &foreign_check($gconfig{'licence_module'}) &&
3804     -r "$root_directory/$gconfig{'licence_module'}/licence_check.pl") {
3805         my $oldpwd = &get_current_dir();
3806         $main::done_licence_module_check++;
3807         $main::licence_module = $gconfig{'licence_module'};
3808         &foreign_require($main::licence_module, "licence_check.pl");
3809         ($main::licence_status, $main::licence_message) =
3810                 &foreign_call($main::licence_module, "check_licence");
3811         chdir($oldpwd);
3812         }
3813
3814 # Export global variables to caller
3815 if ($main::export_to_caller) {
3816         foreach my $v ('$config_file', '%gconfig', '$null_file',
3817                        '$path_separator', '@root_directories',
3818                        '$root_directory', '$module_name',
3819                        '$base_remote_user', '$remote_user',
3820                        '$module_config_directory', '$module_config_file',
3821                        '%config', '@current_themes', '$current_theme',
3822                        '@theme_root_directories', '$theme_root_directory',
3823                        '%tconfig','@theme_configs', '$tb', '$cb', '$scriptname',
3824                        '$webmin_logfile', '$current_lang',
3825                        '$current_lang_info', '@lang_order_list', '%text',
3826                        '%module_info', '$module_root_directory') {
3827                 my ($vt, $vn) = split('', $v, 2);
3828                 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
3829                 }
3830         }
3831
3832 return 1;
3833 }
3834
3835 =head2 load_language([module], [directory])
3836
3837 Returns a hashtable mapping text codes to strings in the appropriate language,
3838 based on the $current_lang global variable, which is in turn set based on
3839 the Webmin user's selection. The optional module parameter tells the function
3840 which module to load strings for, and defaults to the calling module. The
3841 optional directory parameter can be used to load strings from a directory
3842 other than lang.
3843
3844 In regular module development you will never need to call this function
3845 directly, as init_config calls it for you, and places the module's strings
3846 into the %text hash.
3847
3848 =cut
3849 sub load_language
3850 {
3851 my %text;
3852 my $root = $root_directory;
3853 my $ol = $gconfig{'overlang'};
3854 my ($dir) = ($_[1] || "lang");
3855
3856 # Read global lang files
3857 foreach my $o (@lang_order_list) {
3858         my $ok = &read_file_cached("$root/$dir/$o", \%text);
3859         return () if (!$ok && $o eq $default_lang);
3860         }
3861 if ($ol) {
3862         foreach my $o (@lang_order_list) {
3863                 &read_file_cached("$root/$ol/$o", \%text);
3864                 }
3865         }
3866 &read_file_cached("$config_directory/custom-lang", \%text);
3867
3868 if ($_[0]) {
3869         # Read module's lang files
3870         my $mdir = &module_root_directory($_[0]);
3871         foreach my $o (@lang_order_list) {
3872                 &read_file_cached("$mdir/$dir/$o", \%text);
3873                 }
3874         if ($ol) {
3875                 foreach $o (@lang_order_list) {
3876                         &read_file_cached("$mdir/$ol/$o", \%text);
3877                         }
3878                 }
3879         &read_file_cached("$config_directory/$_[0]/custom-lang", \%text);
3880         }
3881 foreach $k (keys %text) {
3882         $text{$k} =~ s/\$(\{([^\}]+)\}|([A-Za-z0-9\.\-\_]+))/text_subs($2 || $3,\%text)/ge;
3883         }
3884
3885 if (defined(&theme_load_language)) {
3886         &theme_load_language(\%text, $_[0]);
3887         }
3888 return %text;
3889 }
3890
3891 =head2 text_subs(string)
3892
3893 Used internally by load_language to expand $code substitutions in language
3894 files.
3895
3896 =cut
3897 sub text_subs
3898 {
3899 if (substr($_[0], 0, 8) eq "include:") {
3900         local $_;
3901         my $rv;
3902         open(INCLUDE, substr($_[0], 8));
3903         while(<INCLUDE>) {
3904                 $rv .= $_;
3905                 }
3906         close(INCLUDE);
3907         return $rv;
3908         }
3909 else {
3910         my $t = $_[1]->{$_[0]};
3911         return defined($t) ? $t : '$'.$_[0];
3912         }
3913 }
3914
3915 =head2 text(message, [substitute]+)
3916
3917 Returns a translated message from %text, but with $1, $2, etc.. replaced with
3918 the substitute parameters. This makes it easy to use strings with placeholders
3919 that get replaced with programmatically generated text. For example :
3920
3921  print &text('index_hello', $remote_user),"<p>\n";
3922
3923 =cut
3924 sub text
3925 {
3926 my $t = &get_module_variable('%text', 1);
3927 my $rv = exists($t->{$_[0]}) ? $t->{$_[0]} : $text{$_[0]};
3928 for(my $i=1; $i<@_; $i++) {
3929         $rv =~ s/\$$i/$_[$i]/g;
3930         }
3931 return $rv;
3932 }
3933
3934 =head2 encode_base64(string)
3935
3936 Encodes a string into base64 format, for use in MIME email or HTTP
3937 authorization headers.
3938
3939 =cut
3940 sub encode_base64
3941 {
3942 my $res;
3943 pos($_[0]) = 0;                          # ensure start at the beginning
3944 while ($_[0] =~ /(.{1,57})/gs) {
3945         $res .= substr(pack('u57', $1), 1)."\n";
3946         chop($res);
3947         }
3948 $res =~ tr|\` -_|AA-Za-z0-9+/|;
3949 my $padding = (3 - length($_[0]) % 3) % 3;
3950 $res =~ s/.{$padding}$/'=' x $padding/e if ($padding);
3951 return $res;
3952 }
3953
3954 =head2 decode_base64(string)
3955
3956 Converts a base64-encoded string into plain text. The opposite of encode_base64.
3957
3958 =cut
3959 sub decode_base64
3960 {
3961 my ($str) = @_;
3962 my $res;
3963 $str =~ tr|A-Za-z0-9+=/||cd;            # remove non-base64 chars
3964 if (length($str) % 4) {
3965         return undef;
3966 }
3967 $str =~ s/=+$//;                        # remove padding
3968 $str =~ tr|A-Za-z0-9+/| -_|;            # convert to uuencoded format
3969 while ($str =~ /(.{1,60})/gs) {
3970         my $len = chr(32 + length($1)*3/4); # compute length byte
3971         $res .= unpack("u", $len . $1 );    # uudecode
3972         }
3973 return $res;
3974 }
3975
3976 =head2 get_module_info(module, [noclone], [forcache])
3977
3978 Returns a hash containg details of the given module. Some useful keys are :
3979
3980 =item dir - The module directory, like sendmail.
3981
3982 =item desc - Human-readable description, in the current users' language.
3983
3984 =item version - Optional module version number.
3985
3986 =item os_support - List of supported operating systems and versions.
3987
3988 =item category - Category on Webmin's left menu, like net.
3989
3990 =cut
3991 sub get_module_info
3992 {
3993 return () if ($_[0] =~ /^\./);
3994 my (%rv, $clone, $o);
3995 my $mdir = &module_root_directory($_[0]);
3996 &read_file_cached("$mdir/module.info", \%rv) || return ();
3997 $clone = -l $mdir;
3998 foreach $o (@lang_order_list) {
3999         $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4000         $rv{"longdesc"} = $rv{"longdesc_$o"} if ($rv{"longdesc_$o"});
4001         }
4002 if ($clone && !$_[1] && $config_directory) {
4003         $rv{'clone'} = $rv{'desc'};
4004         &read_file("$config_directory/$_[0]/clone", \%rv);
4005         }
4006 $rv{'dir'} = $_[0];
4007 my %module_categories;
4008 &read_file_cached("$config_directory/webmin.cats", \%module_categories);
4009 my $pn = &get_product_name();
4010 if (defined($rv{'category_'.$pn})) {
4011         # Can override category for webmin/usermin
4012         $rv{'category'} = $rv{'category_'.$pn};
4013         }
4014 $rv{'realcategory'} = $rv{'category'};
4015 $rv{'category'} = $module_categories{$_[0]}
4016         if (defined($module_categories{$_[0]}));
4017
4018 # Apply description overrides
4019 $rv{'realdesc'} = $rv{'desc'};
4020 my %descs;
4021 &read_file_cached("$config_directory/webmin.descs", \%descs);
4022 if ($descs{$_[0]." ".$current_lang}) {
4023         $rv{'desc'} = $descs{$_[0]." ".$current_lang};
4024         }
4025 elsif ($descs{$_[0]}) {
4026         $rv{'desc'} = $descs{$_[0]};
4027         }
4028
4029 if (!$_[2]) {
4030         # Apply per-user description overridde
4031         my %gaccess = &get_module_acl(undef, "");
4032         if ($gaccess{'desc_'.$_[0]}) {
4033                 $rv{'desc'} = $gaccess{'desc_'.$_[0]};
4034                 }
4035         }
4036
4037 if ($rv{'longdesc'}) {
4038         # All standard modules have an index.cgi
4039         $rv{'index_link'} = 'index.cgi';
4040         }
4041
4042 # Call theme-specific override function
4043 if (defined(&theme_get_module_info)) {
4044         %rv = &theme_get_module_info(\%rv, $_[0], $_[1], $_[2]);
4045         }
4046
4047 return %rv;
4048 }
4049
4050 =head2 get_all_module_infos(cachemode)
4051
4052 Returns a list contains the information on all modules in this webmin
4053 install, including clones. Uses caching to reduce the number of module.info
4054 files that need to be read. Each element of the array is a hash reference
4055 in the same format as returned by get_module_info. The cache mode flag can be :
4056 0 = read and write, 1 = don't read or write, 2 = read only
4057
4058 =cut
4059 sub get_all_module_infos
4060 {
4061 my (%cache, @rv);
4062
4063 # Is the cache out of date? (ie. have any of the root's changed?)
4064 my $cache_file = "$config_directory/module.infos.cache";
4065 my $changed = 0;
4066 if (&read_file_cached($cache_file, \%cache)) {
4067         foreach my $r (@root_directories) {
4068                 my @st = stat($r);
4069                 if ($st[9] != $cache{'mtime_'.$r}) {
4070                         $changed = 2;
4071                         last;
4072                         }
4073                 }
4074         }
4075 else {
4076         $changed = 1;
4077         }
4078
4079 if ($_[0] != 1 && !$changed && $cache{'lang'} eq $current_lang) {
4080         # Can use existing module.info cache
4081         my %mods;
4082         foreach my $k (keys %cache) {
4083                 if ($k =~ /^(\S+) (\S+)$/) {
4084                         $mods{$1}->{$2} = $cache{$k};
4085                         }
4086                 }
4087         @rv = map { $mods{$_} } (keys %mods) if (%mods);
4088         }
4089 else {
4090         # Need to rebuild cache
4091         %cache = ( );
4092         foreach my $r (@root_directories) {
4093                 opendir(DIR, $r);
4094                 foreach my $m (readdir(DIR)) {
4095                         next if ($m =~ /^(config-|\.)/ || $m =~ /\.(cgi|pl)$/);
4096                         my %minfo = &get_module_info($m, 0, 1);
4097                         next if (!%minfo || !$minfo{'dir'});
4098                         push(@rv, \%minfo);
4099                         foreach $k (keys %minfo) {
4100                                 $cache{"${m} ${k}"} = $minfo{$k};
4101                                 }
4102                         }
4103                 closedir(DIR);
4104                 my @st = stat($r);
4105                 $cache{'mtime_'.$r} = $st[9];
4106                 }
4107         $cache{'lang'} = $current_lang;
4108         &write_file($cache_file, \%cache) if (!$_[0] && $< == 0 && $> == 0);
4109         }
4110
4111 # Override descriptions for modules for current user
4112 my %gaccess = &get_module_acl(undef, "");
4113 foreach my $m (@rv) {
4114         if ($gaccess{"desc_".$m->{'dir'}}) {
4115                 $m->{'desc'} = $gaccess{"desc_".$m->{'dir'}};
4116                 }
4117         }
4118
4119 # Apply installed flags
4120 my %installed;
4121 &read_file_cached("$config_directory/installed.cache", \%installed);
4122 foreach my $m (@rv) {
4123         $m->{'installed'} = $installed{$m->{'dir'}};
4124         }
4125
4126 return @rv;
4127 }
4128
4129 =head2 get_theme_info(theme)
4130
4131 Returns a hash containing a theme's details, taken from it's theme.info file.
4132 Some useful keys are :
4133
4134 =item dir - The theme directory, like blue-theme.
4135
4136 =item desc - Human-readable description, in the current users' language.
4137
4138 =item version - Optional module version number.
4139
4140 =item os_support - List of supported operating systems and versions.
4141
4142 =cut
4143 sub get_theme_info
4144 {
4145 return () if ($_[0] =~ /^\./);
4146 my %rv;
4147 my $tdir = &module_root_directory($_[0]);
4148 &read_file("$tdir/theme.info", \%rv) || return ();
4149 foreach my $o (@lang_order_list) {
4150         $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4151         }
4152 $rv{"dir"} = $_[0];
4153 return %rv;
4154 }
4155
4156 =head2 list_languages
4157
4158 Returns an array of supported languages, taken from Webmin's os_list.txt file.
4159 Each is a hash reference with the following keys :
4160
4161 =item lang - The short language code, like es for Spanish.
4162
4163 =item desc - A human-readable description, in English.
4164
4165 =item charset - An optional character set to use when displaying the language.
4166
4167 =item titles - Set to 1 only if Webmin has title images for the language.
4168
4169 =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.
4170
4171 =cut
4172 sub list_languages
4173 {
4174 if (!@main::list_languages_cache) {
4175         my $o;
4176         local $_;
4177         open(LANG, "$root_directory/lang_list.txt");
4178         while(<LANG>) {
4179                 if (/^(\S+)\s+(.*)/) {
4180                         my $l = { 'desc' => $2 };
4181                         foreach $o (split(/,/, $1)) {
4182                                 if ($o =~ /^([^=]+)=(.*)$/) {
4183                                         $l->{$1} = $2;
4184                                         }
4185                                 }
4186                         $l->{'index'} = scalar(@rv);
4187                         push(@main::list_languages_cache, $l);
4188                         }
4189                 }
4190         close(LANG);
4191         @main::list_languages_cache = sort { $a->{'desc'} cmp $b->{'desc'} }
4192                                      @main::list_languages_cache;
4193         }
4194 return @main::list_languages_cache;
4195 }
4196
4197 =head2 read_env_file(file, &hash)
4198
4199 Similar to Webmin's read_file function, but handles files containing shell
4200 environment variables formatted like :
4201
4202   export FOO=bar
4203   SMEG="spod"
4204
4205 The file parameter is the full path to the file to read, and hash a Perl hash
4206 ref to read names and values into.
4207
4208 =cut
4209 sub read_env_file
4210 {
4211 local $_;
4212 &open_readfile(FILE, $_[0]) || return 0;
4213 while(<FILE>) {
4214         s/#.*$//g;
4215         if (/^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*"(.*)"/i ||
4216             /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*'(.*)'/i ||
4217             /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*(.*)/i) {
4218                 $_[1]->{$2} = $3;
4219                 }
4220         }
4221 close(FILE);
4222 return 1;
4223 }
4224
4225 =head2 write_env_file(file, &hash, [export])
4226
4227 Writes out a hash to a file in name='value' format, suitable for use in a shell
4228 script. The parameters are :
4229
4230 =item file - Full path for a file to write to
4231
4232 =item hash - Hash reference of names and values to write.
4233
4234 =item export - If set to 1, preceed each variable setting with the word 'export'.
4235
4236 =cut
4237 sub write_env_file
4238 {
4239 my $exp = $_[2] ? "export " : "";
4240 &open_tempfile(FILE, ">$_[0]");
4241 foreach my $k (keys %{$_[1]}) {
4242         my $v = $_[1]->{$k};
4243         if ($v =~ /^\S+$/) {
4244                 &print_tempfile(FILE, "$exp$k=$v\n");
4245                 }
4246         else {
4247                 &print_tempfile(FILE, "$exp$k=\"$v\"\n");
4248                 }
4249         }
4250 &close_tempfile(FILE);
4251 }
4252
4253 =head2 lock_file(filename, [readonly], [forcefile])
4254
4255 Lock a file for exclusive access. If the file is already locked, spin
4256 until it is freed. Uses a .lock file, which is not 100% reliable, but seems
4257 to work OK. The parameters are :
4258
4259 =item filename - File or directory to lock.
4260
4261 =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.
4262
4263 =item forcefile - Force the file to be considered as a real file and not a symlink for Webmin actions logging purposes.
4264
4265 =cut
4266 sub lock_file
4267 {
4268 my $realfile = &translate_filename($_[0]);
4269 return 0 if (!$_[0] || defined($main::locked_file_list{$realfile}));
4270 my $no_lock = !&can_lock_file($realfile);
4271 my $lock_tries_count = 0;
4272 while(1) {
4273         my $pid;
4274         if (!$no_lock && open(LOCKING, "$realfile.lock")) {
4275                 $pid = <LOCKING>;
4276                 $pid = int($pid);
4277                 close(LOCKING);
4278                 }
4279         if ($no_lock || !$pid || !kill(0, $pid) || $pid == $$) {
4280                 # Got the lock!
4281                 if (!$no_lock) {
4282                         # Create the .lock file
4283                         open(LOCKING, ">$realfile.lock") || return 0;
4284                         my $lck = eval "flock(LOCKING, 2+4)";
4285                         if (!$lck && !$@) {
4286                                 # Lock of lock file failed! Wait till later
4287                                 goto tryagain;
4288                                 }
4289                         print LOCKING $$,"\n";
4290                         eval "flock(LOCKING, 8)";
4291                         close(LOCKING);
4292                         }
4293                 $main::locked_file_list{$realfile} = int($_[1]);
4294                 push(@main::temporary_files, "$realfile.lock");
4295                 if (($gconfig{'logfiles'} || $gconfig{'logfullfiles'}) &&
4296                     !&get_module_variable('$no_log_file_changes') &&
4297                     !$_[1]) {
4298                         # Grab a copy of this file for later diffing
4299                         my $lnk;
4300                         $main::locked_file_data{$realfile} = undef;
4301                         if (-d $realfile) {
4302                                 $main::locked_file_type{$realfile} = 1;
4303                                 $main::locked_file_data{$realfile} = '';
4304                                 }
4305                         elsif (!$_[2] && ($lnk = readlink($realfile))) {
4306                                 $main::locked_file_type{$realfile} = 2;
4307                                 $main::locked_file_data{$realfile} = $lnk;
4308                                 }
4309                         elsif (open(ORIGFILE, $realfile)) {
4310                                 $main::locked_file_type{$realfile} = 0;
4311                                 $main::locked_file_data{$realfile} = '';
4312                                 local $_;
4313                                 while(<ORIGFILE>) {
4314                                         $main::locked_file_data{$realfile} .=$_;
4315                                         }
4316                                 close(ORIGFILE);
4317                                 }
4318                         }
4319                 last;
4320                 }
4321 tryagain:
4322         sleep(1);
4323         if ($lock_tries_count++ > 5*60) {
4324                 # Give up after 5 minutes
4325                 &error(&text('elock_tries', "<tt>$realfile</tt>", 5));
4326                 }
4327         }
4328 return 1;
4329 }
4330
4331 =head2 unlock_file(filename)
4332
4333 Release a lock on a file taken out by lock_file. If Webmin actions logging of
4334 file changes is enabled, then at unlock file a diff will be taken between the
4335 old and new contents, and stored under /var/webmin/diffs when webmin_log is
4336 called. This can then be viewed in the Webmin Actions Log module.
4337
4338 =cut
4339 sub unlock_file
4340 {
4341 my $realfile = &translate_filename($_[0]);
4342 return if (!$_[0] || !defined($main::locked_file_list{$realfile}));
4343 unlink("$realfile.lock") if (&can_lock_file($realfile));
4344 delete($main::locked_file_list{$realfile});
4345 if (exists($main::locked_file_data{$realfile})) {
4346         # Diff the new file with the old
4347         stat($realfile);
4348         my $lnk = readlink($realfile);
4349         my $type = -d _ ? 1 : $lnk ? 2 : 0;
4350         my $oldtype = $main::locked_file_type{$realfile};
4351         my $new = !defined($main::locked_file_data{$realfile});
4352         if ($new && !-e _) {
4353                 # file doesn't exist, and never did! do nothing ..
4354                 }
4355         elsif ($new && $type == 1 || !$new && $oldtype == 1) {
4356                 # is (or was) a directory ..
4357                 if (-d _ && !defined($main::locked_file_data{$realfile})) {
4358                         push(@main::locked_file_diff,
4359                              { 'type' => 'mkdir', 'object' => $realfile });
4360                         }
4361                 elsif (!-d _ && defined($main::locked_file_data{$realfile})) {
4362                         push(@main::locked_file_diff,
4363                              { 'type' => 'rmdir', 'object' => $realfile });
4364                         }
4365                 }
4366         elsif ($new && $type == 2 || !$new && $oldtype == 2) {
4367                 # is (or was) a symlink ..
4368                 if ($lnk && !defined($main::locked_file_data{$realfile})) {
4369                         push(@main::locked_file_diff,
4370                              { 'type' => 'symlink', 'object' => $realfile,
4371                                'data' => $lnk });
4372                         }
4373                 elsif (!$lnk && defined($main::locked_file_data{$realfile})) {
4374                         push(@main::locked_file_diff,
4375                              { 'type' => 'unsymlink', 'object' => $realfile,
4376                                'data' => $main::locked_file_data{$realfile} });
4377                         }
4378                 elsif ($lnk ne $main::locked_file_data{$realfile}) {
4379                         push(@main::locked_file_diff,
4380                              { 'type' => 'resymlink', 'object' => $realfile,
4381                                'data' => $lnk });
4382                         }
4383                 }
4384         else {
4385                 # is a file, or has changed type?!
4386                 my ($diff, $delete_file);
4387                 my $type = "modify";
4388                 if (!-r _) {
4389                         open(NEWFILE, ">$realfile");
4390                         close(NEWFILE);
4391                         $delete_file++;
4392                         $type = "delete";
4393                         }
4394                 if (!defined($main::locked_file_data{$realfile})) {
4395                         $type = "create";
4396                         }
4397                 open(ORIGFILE, ">$realfile.webminorig");
4398                 print ORIGFILE $main::locked_file_data{$realfile};
4399                 close(ORIGFILE);
4400                 $diff = &backquote_command(
4401                         "diff ".quotemeta("$realfile.webminorig")." ".
4402                                 quotemeta($realfile)." 2>/dev/null");
4403                 push(@main::locked_file_diff,
4404                      { 'type' => $type, 'object' => $realfile,
4405                        'data' => $diff } ) if ($diff);
4406                 unlink("$realfile.webminorig");
4407                 unlink($realfile) if ($delete_file);
4408                 }
4409
4410         if ($gconfig{'logfullfiles'}) {
4411                 # Add file details to list of those to fully log
4412                 $main::orig_file_data{$realfile} ||=
4413                         $main::locked_file_data{$realfile};
4414                 $main::orig_file_type{$realfile} ||=
4415                         $main::locked_file_type{$realfile};
4416                 }
4417
4418         delete($main::locked_file_data{$realfile});
4419         delete($main::locked_file_type{$realfile});
4420         }
4421 }
4422
4423 =head2 test_lock(file)
4424
4425 Returns 1 if some file is currently locked, 0 if not.
4426
4427 =cut
4428 sub test_lock
4429 {
4430 my $realfile = &translate_filename($_[0]);
4431 return 0 if (!$_[0]);
4432 return 1 if (defined($main::locked_file_list{$realfile}));
4433 return 0 if (!&can_lock_file($realfile));
4434 my $pid;
4435 if (open(LOCKING, "$realfile.lock")) {
4436         $pid = <LOCKING>;
4437         $pid = int($pid);
4438         close(LOCKING);
4439         }
4440 return $pid && kill(0, $pid);
4441 }
4442
4443 =head2 unlock_all_files
4444
4445 Unlocks all files locked by the current script.
4446
4447 =cut
4448 sub unlock_all_files
4449 {
4450 foreach $f (keys %main::locked_file_list) {
4451         &unlock_file($f);
4452         }
4453 }
4454
4455 =head2 can_lock_file(file)
4456
4457 Returns 1 if some file should be locked, based on the settings in the
4458 Webmin Configuration module. For internal use by lock_file only.
4459
4460 =cut
4461 sub can_lock_file
4462 {
4463 if (&is_readonly_mode()) {
4464         return 0;       # never lock in read-only mode
4465         }
4466 elsif ($gconfig{'lockmode'} == 0) {
4467         return 1;       # always
4468         }
4469 elsif ($gconfig{'lockmode'} == 1) {
4470         return 0;       # never
4471         }
4472 else {
4473         # Check if under any of the directories
4474         my $match;
4475         foreach my $d (split(/\t+/, $gconfig{'lockdirs'})) {
4476                 if (&same_file($d, $_[0]) ||
4477                     &is_under_directory($d, $_[0])) {
4478                         $match = 1;
4479                         }
4480                 }
4481         return $gconfig{'lockmode'} == 2 ? $match : !$match;
4482         }
4483 }
4484
4485 =head2 webmin_log(action, type, object, &params, [module], [host, script-on-host, client-ip])
4486
4487 Log some action taken by a user. This is typically called at the end of a
4488 script, once all file changes are complete and all commands run. The
4489 parameters are :
4490
4491 =item action - A short code for the action being performed, like 'create'.
4492
4493 =item type - A code for the type of object the action is performed to, like 'user'.
4494
4495 =item object - A short name for the object, like 'joe' if the Unix user 'joe' was just created.
4496
4497 =item params - A hash ref of additional information about the action.
4498
4499 =item module - Name of the module in which the action was performed, which defaults to the current module.
4500
4501 =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.
4502
4503 =item script-on-host - Script name like create_user.cgi on the host the action was performed on.
4504
4505 =item client-ip - IP address of the browser that performed the action.
4506
4507 =cut
4508 sub webmin_log
4509 {
4510 return if (!$gconfig{'log'} || &is_readonly_mode());
4511 my $m = $_[4] ? $_[4] : &get_module_name();
4512
4513 if ($gconfig{'logclear'}) {
4514         # check if it is time to clear the log
4515         my @st = stat("$webmin_logfile.time");
4516         my $write_logtime = 0;
4517         if (@st) {
4518                 if ($st[9]+$gconfig{'logtime'}*60*60 < time()) {
4519                         # clear logfile and all diff files
4520                         &unlink_file("$ENV{'WEBMIN_VAR'}/diffs");
4521                         &unlink_file("$ENV{'WEBMIN_VAR'}/files");
4522                         &unlink_file("$ENV{'WEBMIN_VAR'}/annotations");
4523                         unlink($webmin_logfile);
4524                         $write_logtime = 1;
4525                         }
4526                 }
4527         else {
4528                 $write_logtime = 1;
4529                 }
4530         if ($write_logtime) {
4531                 open(LOGTIME, ">$webmin_logfile.time");
4532                 print LOGTIME time(),"\n";
4533                 close(LOGTIME);
4534                 }
4535         }
4536
4537 # If an action script directory is defined, call the appropriate scripts
4538 if ($gconfig{'action_script_dir'}) {
4539     my ($action, $type, $object) = ($_[0], $_[1], $_[2]);
4540     my ($basedir) = $gconfig{'action_script_dir'};
4541
4542     for my $dir ($basedir/$type/$action, $basedir/$type, $basedir) {
4543         if (-d $dir) {
4544             my ($file);
4545             opendir(DIR, $dir) or die "Can't open $dir: $!";
4546             while (defined($file = readdir(DIR))) {
4547                 next if ($file =~ /^\.\.?$/); # skip '.' and '..'
4548                 if (-x "$dir/$file") {
4549                     # Call a script notifying it of the action
4550                     my %OLDENV = %ENV;
4551                     $ENV{'ACTION_MODULE'} = &get_module_name();
4552                     $ENV{'ACTION_ACTION'} = $_[0];
4553                     $ENV{'ACTION_TYPE'} = $_[1];
4554                     $ENV{'ACTION_OBJECT'} = $_[2];
4555                     $ENV{'ACTION_SCRIPT'} = $script_name;
4556                     foreach my $p (keys %param) {
4557                             $ENV{'ACTION_PARAM_'.uc($p)} = $param{$p};
4558                             }
4559                     system("$dir/$file", @_,
4560                            "<$null_file", ">$null_file", "2>&1");
4561                     %ENV = %OLDENV;
4562                     }
4563                 }
4564             }
4565         }
4566     }
4567
4568 # should logging be done at all?
4569 return if ($gconfig{'logusers'} && &indexof($base_remote_user,
4570            split(/\s+/, $gconfig{'logusers'})) < 0);
4571 return if ($gconfig{'logmodules'} && &indexof($m,
4572            split(/\s+/, $gconfig{'logmodules'})) < 0);
4573
4574 # log the action
4575 my $now = time();
4576 my @tm = localtime($now);
4577 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
4578 my $id = sprintf "%d.%d.%d", $now, $$, $main::action_id_count;
4579 $main::action_id_count++;
4580 my $line = sprintf "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s %s \"%s\" \"%s\" \"%s\"",
4581         $id, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
4582         $tm[2], $tm[1], $tm[0],
4583         $remote_user || '-',
4584         $main::session_id || '-',
4585         $_[7] || $ENV{'REMOTE_HOST'} || '-',
4586         $m, $_[5] ? "$_[5]:$_[6]" : $script_name,
4587         $_[0], $_[1] ne '' ? $_[1] : '-', $_[2] ne '' ? $_[2] : '-';
4588 my %param;
4589 foreach my $k (sort { $a cmp $b } keys %{$_[3]}) {
4590         my $v = $_[3]->{$k};
4591         my @pv;
4592         if ($v eq '') {
4593                 $line .= " $k=''";
4594                 @rv = ( "" );
4595                 }
4596         elsif (ref($v) eq 'ARRAY') {
4597                 foreach $vv (@$v) {
4598                         next if (ref($vv));
4599                         push(@pv, $vv);
4600                         $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
4601                         $line .= " $k='$vv'";
4602                         }
4603                 }
4604         elsif (!ref($v)) {
4605                 foreach $vv (split(/\0/, $v)) {
4606                         push(@pv, $vv);
4607                         $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
4608                         $line .= " $k='$vv'";
4609                         }
4610                 }
4611         $param{$k} = join(" ", @pv);
4612         }
4613 open(WEBMINLOG, ">>$webmin_logfile");
4614 print WEBMINLOG $line,"\n";
4615 close(WEBMINLOG);
4616 if ($gconfig{'logperms'}) {
4617         chmod(oct($gconfig{'logperms'}), $webmin_logfile);
4618         }
4619 else {
4620         chmod(0600, $webmin_logfile);
4621         }
4622
4623 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
4624         # Find and record the changes made to any locked files, or commands run
4625         my $i = 0;
4626         mkdir("$ENV{'WEBMIN_VAR'}/diffs", 0700);
4627         foreach my $d (@main::locked_file_diff) {
4628                 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$id", 0700);
4629                 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i");
4630                 print DIFFLOG "$d->{'type'} $d->{'object'}\n";
4631                 print DIFFLOG $d->{'data'};
4632                 close(DIFFLOG);
4633                 if ($d->{'input'}) {
4634                         open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
4635                         print DIFFLOG $d->{'input'};
4636                         close(DIFFLOG);
4637                         }
4638                 if ($gconfig{'logperms'}) {
4639                         chmod(oct($gconfig{'logperms'}),
4640                               "$ENV{'WEBMIN_VAR'}/diffs/$id/$i",
4641                               "$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
4642                         }
4643                 $i++;
4644                 }
4645         @main::locked_file_diff = undef;
4646         }
4647 if ($gconfig{'logfullfiles'}) {
4648         # Save the original contents of any modified files
4649         my $i = 0;
4650         mkdir("$ENV{'WEBMIN_VAR'}/files", 0700);
4651         foreach my $f (keys %main::orig_file_data) {
4652                 mkdir("$ENV{'WEBMIN_VAR'}/files/$id", 0700);
4653                 open(ORIGLOG, ">$ENV{'WEBMIN_VAR'}/files/$id/$i");
4654                 if (!defined($main::orig_file_type{$f})) {
4655                         print ORIGLOG -1," ",$f,"\n";
4656                         }
4657                 else {
4658                         print ORIGLOG $main::orig_file_type{$f}," ",$f,"\n";
4659                         }
4660                 print ORIGLOG $main::orig_file_data{$f};
4661                 close(ORIGLOG);
4662                 if ($gconfig{'logperms'}) {
4663                         chmod(oct($gconfig{'logperms'}),
4664                               "$ENV{'WEBMIN_VAR'}/files/$id.$i");
4665                         }
4666                 $i++;
4667                 }
4668         %main::orig_file_data = undef;
4669         %main::orig_file_type = undef;
4670         }
4671
4672 # Log to syslog too
4673 if ($gconfig{'logsyslog'}) {
4674         eval 'use Sys::Syslog qw(:DEFAULT setlogsock);
4675               openlog(&get_product_name(), "cons,pid,ndelay", "daemon");
4676               setlogsock("inet");';
4677         if (!$@) {
4678                 # Syslog module is installed .. try to convert to a
4679                 # human-readable form
4680                 my $msg;
4681                 my $mod = &get_module_name();
4682                 my $mdir = module_root_directory($mod);
4683                 if (-r "$mdir/log_parser.pl") {
4684                         &foreign_require($mod, "log_parser.pl");
4685                         my %params;
4686                         foreach my $k (keys %{$_[3]}) {
4687                                 my $v = $_[3]->{$k};
4688                                 if (ref($v) eq 'ARRAY') {
4689                                         $params{$k} = join("\0", @$v);
4690                                         }
4691                                 else {
4692                                         $params{$k} = $v;
4693                                         }
4694                                 }
4695                         $msg = &foreign_call($mod, "parse_webmin_log",
4696                                 $remote_user, $script_name,
4697                                 $_[0], $_[1], $_[2], \%params);
4698                         $msg =~ s/<[^>]*>//g;   # Remove tags
4699                         }
4700                 elsif ($_[0] eq "_config_") {
4701                         my %wtext = &load_language("webminlog");
4702                         $msg = $wtext{'search_config'};
4703                         }
4704                 $msg ||= "$_[0] $_[1] $_[2]";
4705                 my %info = &get_module_info($m);
4706                 eval { syslog("info", "%s", "[$info{'desc'}] $msg"); };
4707                 }
4708         }
4709 }
4710
4711 =head2 additional_log(type, object, data, [input])
4712
4713 Records additional log data for an upcoming call to webmin_log, such
4714 as a command that was run or SQL that was executed. Typically you will never
4715 need to call this function directory.
4716
4717 =cut
4718 sub additional_log
4719 {
4720 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
4721         push(@main::locked_file_diff,
4722              { 'type' => $_[0], 'object' => $_[1], 'data' => $_[2],
4723                'input' => $_[3] } );
4724         }
4725 }
4726
4727 =head2 webmin_debug_log(type, message)
4728
4729 Write something to the Webmin debug log. For internal use only.
4730
4731 =cut
4732 sub webmin_debug_log
4733 {
4734 my ($type, $msg) = @_;
4735 return 0 if (!$main::opened_debug_log);
4736 return 0 if ($gconfig{'debug_no'.$main::webmin_script_type});
4737 if ($gconfig{'debug_modules'}) {
4738         my @dmods = split(/\s+/, $gconfig{'debug_modules'});
4739         return 0 if (&indexof($main::initial_module_name, @dmods) < 0);
4740         }
4741 my $now = time();
4742 my @tm = localtime($now);
4743 my $line = sprintf
4744         "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s \"%s\"",
4745         $$, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
4746         $tm[2], $tm[1], $tm[0],
4747         $remote_user || "-",
4748         $ENV{'REMOTE_HOST'} || "-",
4749         &get_module_name() || "-",
4750         $type,
4751         $msg;
4752 seek(main::DEBUGLOG, 0, 2);
4753 print main::DEBUGLOG $line."\n";
4754 return 1;
4755 }
4756
4757 =head2 system_logged(command)
4758
4759 Just calls the Perl system() function, but also logs the command run.
4760
4761 =cut
4762 sub system_logged
4763 {
4764 if (&is_readonly_mode()) {
4765         print STDERR "Vetoing command $_[0]\n";
4766         return 0;
4767         }
4768 my @realcmd = ( &translate_command($_[0]), @_[1..$#_] );
4769 my $cmd = join(" ", @realcmd);
4770 my $and;
4771 if ($cmd =~ s/(\s*&\s*)$//) {
4772         $and = $1;
4773         }
4774 while($cmd =~ s/(\d*)(<|>)((\/(tmp|dev)\S+)|&\d+)\s*$//) { }
4775 $cmd =~ s/^\((.*)\)\s*$/$1/;
4776 $cmd .= $and;
4777 &additional_log('exec', undef, $cmd);
4778 return system(@realcmd);
4779 }
4780
4781 =head2 backquote_logged(command)
4782
4783 Executes a command and returns the output (like `command`), but also logs it.
4784
4785 =cut
4786 sub backquote_logged
4787 {
4788 if (&is_readonly_mode()) {
4789         $? = 0;
4790         print STDERR "Vetoing command $_[0]\n";
4791         return undef;
4792         }
4793 my $realcmd = &translate_command($_[0]);
4794 my $cmd = $realcmd;
4795 my $and;
4796 if ($cmd =~ s/(\s*&\s*)$//) {
4797         $and = $1;
4798         }
4799 while($cmd =~ s/(\d*)(<|>)((\/(tmp\/.webmin|dev)\S+)|&\d+)\s*$//) { }
4800 $cmd =~ s/^\((.*)\)\s*$/$1/;
4801 $cmd .= $and;
4802 &additional_log('exec', undef, $cmd);
4803 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
4804 return `$realcmd`;
4805 }
4806
4807 =head2 backquote_with_timeout(command, timeout, safe?, [maxlines])
4808
4809 Runs some command, waiting at most the given number of seconds for it to
4810 complete, and returns the output. The maxlines parameter sets the number
4811 of lines of output to capture. The safe parameter should be set to 1 if the
4812 command is safe for read-only mode users to run.
4813
4814 =cut
4815 sub backquote_with_timeout
4816 {
4817 my $realcmd = &translate_command($_[0]);
4818 &webmin_debug_log('CMD', "cmd=$realcmd timeout=$_[1]")
4819         if ($gconfig{'debug_what_cmd'});
4820 my $out;
4821 my $pid = &open_execute_command(OUT, "($realcmd) <$null_file", 1, $_[2]);
4822 my $start = time();
4823 my $timed_out = 0;
4824 my $linecount = 0;
4825 while(1) {
4826         my $elapsed = time() - $start;
4827         last if ($elapsed > $_[1]);
4828         my $rmask;
4829         vec($rmask, fileno(OUT), 1) = 1;
4830         my $sel = select($rmask, undef, undef, $_[1] - $elapsed);
4831         last if (!$sel || $sel < 0);
4832         my $line = <OUT>;
4833         last if (!defined($line));
4834         $out .= $line;
4835         $linecount++;
4836         if ($_[3] && $linecount >= $_[3]) {
4837                 # Got enough lines
4838                 last;
4839                 }
4840         }
4841 if (kill('TERM', $pid) && time() - $start >= $_[1]) {
4842         $timed_out = 1;
4843         }
4844 close(OUT);
4845 return wantarray ? ($out, $timed_out) : $out;
4846 }
4847
4848 =head2 backquote_command(command, safe?)
4849
4850 Executes a command and returns the output (like `command`), subject to
4851 command translation. The safe parameter should be set to 1 if the command
4852 is safe for read-only mode users to run.
4853
4854 =cut
4855 sub backquote_command
4856 {
4857 if (&is_readonly_mode() && !$_[1]) {
4858         print STDERR "Vetoing command $_[0]\n";
4859         $? = 0;
4860         return undef;
4861         }
4862 my $realcmd = &translate_command($_[0]);
4863 &webmin_debug_log('CMD', "cmd=$realcmd") if ($gconfig{'debug_what_cmd'});
4864 return `$realcmd`;
4865 }
4866
4867 =head2 kill_logged(signal, pid, ...)
4868
4869 Like Perl's built-in kill function, but also logs the fact that some process
4870 was killed. On Windows, falls back to calling process.exe to terminate a
4871 process.
4872
4873 =cut
4874 sub kill_logged
4875 {
4876 return scalar(@_)-1 if (&is_readonly_mode());
4877 &webmin_debug_log('KILL', "signal=$_[0] pids=".join(" ", @_[1..@_-1]))
4878         if ($gconfig{'debug_what_procs'});
4879 &additional_log('kill', $_[0], join(" ", @_[1..@_-1])) if (@_ > 1);
4880 if ($gconfig{'os_type'} eq 'windows') {
4881         # Emulate some kills with process.exe
4882         my $arg = $_[0] eq "KILL" ? "-k" :
4883                   $_[0] eq "TERM" ? "-q" :
4884                   $_[0] eq "STOP" ? "-s" :
4885                   $_[0] eq "CONT" ? "-r" : undef;
4886         my $ok = 0;
4887         foreach my $p (@_[1..@_-1]) {
4888                 if ($p < 0) {
4889                         $ok ||= kill($_[0], $p);
4890                         }
4891                 elsif ($arg) {
4892                         &execute_command("process $arg $p");
4893                         $ok = 1;
4894                         }
4895                 }
4896         return $ok;
4897         }
4898 else {
4899         # Normal Unix kill
4900         return kill(@_);
4901         }
4902 }
4903
4904 =head2 rename_logged(old, new)
4905
4906 Re-names a file and logs the rename. If the old and new files are on different
4907 filesystems, calls mv or the Windows rename function to do the job.
4908
4909 =cut
4910 sub rename_logged
4911 {
4912 &additional_log('rename', $_[0], $_[1]) if ($_[0] ne $_[1]);
4913 return &rename_file($_[0], $_[1]);
4914 }
4915
4916 =head2 rename_file(old, new)
4917
4918 Renames a file or directory. If the old and new files are on different
4919 filesystems, calls mv or the Windows rename function to do the job.
4920
4921 =cut
4922 sub rename_file
4923 {
4924 if (&is_readonly_mode()) {
4925         print STDERR "Vetoing rename from $_[0] to $_[1]\n";
4926         return 1;
4927         }
4928 my $src = &translate_filename($_[0]);
4929 my $dst = &translate_filename($_[1]);
4930 &webmin_debug_log('RENAME', "src=$src dst=$dst")
4931         if ($gconfig{'debug_what_ops'});
4932 my $ok = rename($src, $dst);
4933 if (!$ok && $! !~ /permission/i) {
4934         # Try the mv command, in case this is a cross-filesystem rename
4935         if ($gconfig{'os_type'} eq 'windows') {
4936                 # Need to use rename
4937                 my $out = &backquote_command("rename ".quotemeta($_[0]).
4938                                              " ".quotemeta($_[1])." 2>&1");
4939                 $ok = !$?;
4940                 $! = $out if (!$ok);
4941                 }
4942         else {
4943                 # Can use mv
4944                 my $out = &backquote_command("mv ".quotemeta($_[0]).
4945                                              " ".quotemeta($_[1])." 2>&1");
4946                 $ok = !$?;
4947                 $! = $out if (!$ok);
4948                 }
4949         }
4950 return $ok;
4951 }
4952
4953 =head2 symlink_logged(src, dest)
4954
4955 Create a symlink, and logs it. Effectively does the same thing as the Perl
4956 symlink function.
4957
4958 =cut
4959 sub symlink_logged
4960 {
4961 &lock_file($_[1]);
4962 my $rv = &symlink_file($_[0], $_[1]);
4963 &unlock_file($_[1]);
4964 return $rv;
4965 }
4966
4967 =head2 symlink_file(src, dest)
4968
4969 Creates a soft link, unless in read-only mode. Effectively does the same thing
4970 as the Perl symlink function.
4971
4972 =cut
4973 sub symlink_file
4974 {
4975 if (&is_readonly_mode()) {
4976         print STDERR "Vetoing symlink from $_[0] to $_[1]\n";
4977         return 1;
4978         }
4979 my $src = &translate_filename($_[0]);
4980 my $dst = &translate_filename($_[1]);
4981 &webmin_debug_log('SYMLINK', "src=$src dst=$dst")
4982         if ($gconfig{'debug_what_ops'});
4983 return symlink($src, $dst);
4984 }
4985
4986 =head2 link_file(src, dest)
4987
4988 Creates a hard link, unless in read-only mode. The existing new link file
4989 will be deleted if necessary. Effectively the same as Perl's link function.
4990
4991 =cut
4992 sub link_file
4993 {
4994 if (&is_readonly_mode()) {
4995         print STDERR "Vetoing link from $_[0] to $_[1]\n";
4996         return 1;
4997         }
4998 my $src = &translate_filename($_[0]);
4999 my $dst = &translate_filename($_[1]);
5000 &webmin_debug_log('LINK', "src=$src dst=$dst")
5001         if ($gconfig{'debug_what_ops'});
5002 unlink($dst);                   # make sure link works
5003 return link($src, $dst);
5004 }
5005
5006 =head2 make_dir(dir, perms, recursive)
5007
5008 Creates a directory and sets permissions on it, unless in read-only mode.
5009 The perms parameter sets the octal permissions to apply, which unlike Perl's
5010 mkdir will really get set. The recursive flag can be set to 1 to have the
5011 function create parent directories too.
5012
5013 =cut
5014 sub make_dir
5015 {
5016 my ($dir, $perms, $recur) = @_;
5017 if (&is_readonly_mode()) {
5018         print STDERR "Vetoing directory $dir\n";
5019         return 1;
5020         }
5021 $dir = &translate_filename($dir);
5022 my $exists = -d $dir ? 1 : 0;
5023 return 1 if ($exists && $recur);        # already exists
5024 &webmin_debug_log('MKDIR', $dir) if ($gconfig{'debug_what_ops'});
5025 my $rv = mkdir($dir, $perms);
5026 if (!$rv && $recur) {
5027         # Failed .. try mkdir -p
5028         my $param = $gconfig{'os_type'} eq 'windows' ? "" : "-p";
5029         my $ex = &execute_command("mkdir $param ".&quote_path($dir));
5030         if ($ex) {
5031                 return 0;
5032                 }
5033         }
5034 if (!$exists) {
5035         chmod($perms, $dir);
5036         }
5037 return 1;
5038 }
5039
5040 =head2 set_ownership_permissions(user, group, perms, file, ...)
5041
5042 Sets the user, group owner and permissions on some files. The parameters are :
5043
5044 =item user - UID or username to change the file owner to. If undef, then the owner is not changed.
5045
5046 =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.
5047
5048 =item perms - Octal permissions set to set on the file. If undef, they are left alone.
5049
5050 =item file - One or more files or directories to modify.
5051
5052 =cut
5053 sub set_ownership_permissions
5054 {
5055 my ($user, $group, $perms, @files) = @_;
5056 if (&is_readonly_mode()) {
5057         print STDERR "Vetoing permission changes on ",join(" ", @files),"\n";
5058         return 1;
5059         }
5060 @files = map { &translate_filename($_) } @files;
5061 if ($gconfig{'debug_what_ops'}) {
5062         foreach my $f (@files) {
5063                 &webmin_debug_log('PERMS',
5064                         "file=$f user=$user group=$group perms=$perms");
5065                 }
5066         }
5067 my $rv = 1;
5068 if (defined($user)) {
5069         my $uid = $user !~ /^\d+$/ ? getpwnam($user) : $user;
5070         my $gid;
5071         if (defined($group)) {
5072                 $gid = $group !~ /^\d+$/ ? getgrnam($group) : $group;
5073                 }
5074         else {
5075                 my @uinfo = getpwuid($uid);
5076                 $gid = $uinfo[3];
5077                 }
5078         $rv = chown($uid, $gid, @files);
5079         }
5080 if ($rv && defined($perms)) {
5081         $rv = chmod($perms, @files);
5082         }
5083 return $rv;
5084 }
5085
5086 =head2 unlink_logged(file, ...)
5087
5088 Like Perl's unlink function, but locks the files beforehand and un-locks them
5089 after so that the deletion is logged by Webmin.
5090
5091 =cut
5092 sub unlink_logged
5093 {
5094 my %locked;
5095 foreach my $f (@_) {
5096         if (!&test_lock($f)) {
5097                 &lock_file($f);
5098                 $locked{$f} = 1;
5099                 }
5100         }
5101 my @rv = &unlink_file(@_);
5102 foreach my $f (@_) {
5103         if ($locked{$f}) {
5104                 &unlock_file($f);
5105                 }
5106         }
5107 return wantarray ? @rv : $rv[0];
5108 }
5109
5110 =head2 unlink_file(file, ...)
5111
5112 Deletes some files or directories. Like Perl's unlink function, but also
5113 recursively deletes directories with the rm command if needed.
5114
5115 =cut
5116 sub unlink_file
5117 {
5118 return 1 if (&is_readonly_mode());
5119 my $rv = 1;
5120 my $err;
5121 foreach my $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 if (!$stdin && ref($stdout) && !$stderr) {
7769         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7770         $$stdout = `$cmd 2>$null_file`;
7771         return $?;
7772         }
7773 elsif (!$stdin && ref($stdout) && $stdout eq $stderr) {
7774         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7775         $$stdout = `$cmd 2>&1`;
7776         return $?;
7777         }
7778 elsif (!$stdin && !$stdout && !$stderr) {
7779         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7780         return system("$cmd >$null_file 2>$null_file <$null_file");
7781         }
7782 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
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;