web-lib-funcs.pl

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