web-lib-funcs.pl

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