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 &read_file_cached("$config_directory/$m/$g.gacl", \%rv);
3385 if (defined(&theme_get_module_acl)) {
3386         %rv = &theme_get_module_acl($g, $m, \%rv);
3387         }
3388 return %rv;
3389 }
3390
3391 =head2 save_module_acl(&acl, [user], [module], [never-update-group])
3392
3393 Updates the acl hash for some user and module. The parameters are :
3394
3395 =item acl - Hash reference for the new access control options, or undef to clear
3396
3397 =item user - User to update, defaulting to the current user.
3398
3399 =item module - Module to update, defaulting to the caller.
3400
3401 =item never-update-group - Never update the user's group's ACL
3402
3403 =cut
3404 sub save_module_acl
3405 {
3406 my $u = defined($_[1]) ? $_[1] : $base_remote_user;
3407 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3408 if (!$_[3] && &foreign_check("acl")) {
3409         # Check if this user is a member of a group, and if he gets the
3410         # module from a group. If so, update its ACL as well
3411         &foreign_require("acl", "acl-lib.pl");
3412         my $group;
3413         foreach my $g (&acl::list_groups()) {
3414                 if (&indexof($u, @{$g->{'members'}}) >= 0 &&
3415                     &indexof($m, @{$g->{'modules'}}) >= 0) {
3416                         $group = $g;
3417                         last;
3418                         }
3419                 }
3420         if ($group) {
3421                 &save_group_module_acl($_[0], $group->{'name'}, $m);
3422                 }
3423         }
3424
3425 my $userdb = &get_userdb_string();
3426 my $foundindb = 0;
3427 if ($userdb) {
3428         # Look for this user in the user/group DB
3429         my ($dbh, $proto) = &connect_userdb($userdb);
3430         ref($dbh) || &error(&text('euserdbacl', $dbh));
3431         if ($proto eq "mysql" || $proto eq "postgresql") {
3432                 # Find the user in the SQL DB
3433                 my $cmd = $dbh->prepare(
3434                         "select id from webmin_user where name = ?");
3435                 $cmd && $cmd->execute($u) ||
3436                         &error(&text('euserdbacl2', $dbh->errstr));
3437                 my ($id) = $cmd->fetchrow();
3438                 $foundindb = 1 if (defined($id));
3439                 $cmd->finish();
3440
3441                 # Replace ACLs for user
3442                 if ($foundindb) {
3443                         my $cmd = $dbh->prepare("delete from webmin_user_acl ".
3444                                                 "where id = ? and module = ?");
3445                         $cmd && $cmd->execute($id, $m) ||
3446                             &error(&text('euserdbacl', $dbh->errstr));
3447                         $cmd->finish();
3448                         if ($_[0]) {
3449                                 my $cmd = $dbh->prepare(
3450                                     "insert into webmin_user_acl ".
3451                                     "(id,module,attr,value) values (?,?,?,?)");
3452                                 $cmd || &error(&text('euserdbacl2',
3453                                                      $dbh->errstr));
3454                                 foreach my $a (keys %{$_[0]}) {
3455                                         $cmd->execute($id,$m,$a,$_[0]->{$a}) ||
3456                                             &error(&text('euserdbacl2',
3457                                                          $dbh->errstr));
3458                                         $cmd->finish();
3459                                         }
3460                                 }
3461                         }
3462                 }
3463         elsif ($proto eq "ldap") {
3464                 # Update ACLs in LDAP
3465                 # XXX
3466                 }
3467         &disconnect_userdb($userdb, $dbh);
3468         }
3469
3470 if (!$foundindb) {
3471         # Save ACL to local file
3472         if (!-d "$config_directory/$m") {
3473                 mkdir("$config_directory/$m", 0755);
3474                 }
3475         if ($_[0]) {
3476                 &write_file("$config_directory/$m/$u.acl", $_[0]);
3477                 }
3478         else {
3479                 &unlink_file("$config_directory/$m/$u.acl");
3480                 }
3481         }
3482 }
3483
3484 =head2 save_group_module_acl(&acl, group, [module], [never-update-group])
3485
3486 Updates the acl hash for some group and module. The parameters are :
3487
3488 =item acl - Hash reference for the new access control options.
3489
3490 =item group - Group name to update.
3491
3492 =item module - Module to update, defaulting to the caller.
3493
3494 =item never-update-group - Never update the parent group's ACL
3495
3496 =cut
3497 sub save_group_module_acl
3498 {
3499 my $g = $_[1];
3500 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3501 if (!$_[3] && &foreign_check("acl")) {
3502         # Check if this group is a member of a group, and if it gets the
3503         # module from a group. If so, update the parent ACL as well
3504         &foreign_require("acl", "acl-lib.pl");
3505         my $group;
3506         foreach my $pg (&acl::list_groups()) {
3507                 if (&indexof('@'.$g, @{$pg->{'members'}}) >= 0 &&
3508                     &indexof($m, @{$pg->{'modules'}}) >= 0) {
3509                         $group = $g;
3510                         last;
3511                         }
3512                 }
3513         if ($group) {
3514                 &save_group_module_acl($_[0], $group->{'name'}, $m);
3515                 }
3516         }
3517
3518 my $userdb = &get_userdb_string();
3519 my $foundindb = 0;
3520 if ($userdb) {
3521         # Look for this group in the user/group DB
3522         my ($dbh, $proto) = &connect_userdb($userdb);
3523         ref($dbh) || &error(&text('egroupdbacl', $dbh));
3524         if ($proto eq "mysql" || $proto eq "postgresql") {
3525                 # Find the group in the SQL DB
3526                 my $cmd = $dbh->prepare(
3527                         "select id from webmin_group where name = ?");
3528                 $cmd && $cmd->execute($u) ||
3529                         &error(&text('egroupdbacl2', $dbh->errstr));
3530                 my ($id) = $cmd->fetchrow();
3531                 $foundindb = 1 if (defined($id));
3532                 $cmd->finish();
3533
3534                 # Replace ACLs for group
3535                 if ($foundindb) {
3536                         my $cmd = $dbh->prepare("delete from webmin_group_acl ".
3537                                                 "where id = ? and module = ?");
3538                         $cmd && $cmd->execute($id, $m) ||
3539                             &error(&text('egroupdbacl', $dbh->errstr));
3540                         $cmd->finish();
3541                         if ($_[0]) {
3542                                 my $cmd = $dbh->prepare(
3543                                     "insert into webmin_group_acl ".
3544                                     "(id,module,attr,value) values (?,?,?,?)");
3545                                 $cmd || &error(&text('egroupdbacl2',
3546                                                      $dbh->errstr));
3547                                 foreach my $a (keys %{$_[0]}) {
3548                                         $cmd->execute($id,$m,$a,$_[0]->{$a}) ||
3549                                             &error(&text('egroupdbacl2',
3550                                                          $dbh->errstr));
3551                                         $cmd->finish();
3552                                         }
3553                                 }
3554                         }
3555                 }
3556         elsif ($proto eq "ldap") {
3557                 # Update ACLs in LDAP
3558                 # XXX
3559                 }
3560         &disconnect_userdb($userdb, $dbh);
3561         }
3562
3563
3564
3565 if (!$foundindb) {
3566         # Save ACL to local file
3567         if (!-d "$config_directory/$m") {
3568                 mkdir("$config_directory/$m", 0755);
3569                 }
3570         if ($_[0]) {
3571                 &write_file("$config_directory/$m/$g.gacl", $_[0]);
3572                 }
3573         else {
3574                 &unlink_file("$config_directory/$m/$g.gacl");
3575                 }
3576         }
3577 }
3578
3579 =head2 init_config
3580
3581 This function must be called by all Webmin CGI scripts, either directly or
3582 indirectly via a per-module lib.pl file. It performs a number of initialization
3583 and housekeeping tasks, such as working out the module name, checking that the
3584 current user has access to the module, and populating global variables. Some
3585 of the variables set include :
3586
3587 =item $config_directory - Base Webmin config directory, typically /etc/webmin
3588
3589 =item $var_directory - Base logs directory, typically /var/webmin
3590
3591 =item %config - Per-module configuration.
3592
3593 =item %gconfig - Global configuration.
3594
3595 =item $scriptname - Base name of the current perl script.
3596
3597 =item $module_name - The name of the current module.
3598
3599 =item $module_config_directory - The config directory for this module.
3600
3601 =item $module_config_file - The config file for this module.
3602
3603 =item $module_root_directory - This module's code directory.
3604
3605 =item $webmin_logfile - The detailed logfile for webmin.
3606
3607 =item $remote_user - The actual username used to login to webmin.
3608
3609 =item $base_remote_user - The username whose permissions are in effect.
3610
3611 =item $current_theme - The theme currently in use.
3612
3613 =item $root_directory - The first root directory of this webmin install.
3614
3615 =item @root_directories - All root directories for this webmin install.
3616
3617 =cut
3618 sub init_config
3619 {
3620 # Record first process ID that called this, so we know when it exited to clean
3621 # up temp files
3622 $main::initial_process_id ||= $$;
3623
3624 # Configuration and spool directories
3625 if (!defined($ENV{'WEBMIN_CONFIG'})) {
3626         die "WEBMIN_CONFIG not set";
3627         }
3628 $config_directory = $ENV{'WEBMIN_CONFIG'};
3629 if (!defined($ENV{'WEBMIN_VAR'})) {
3630         open(VARPATH, "$config_directory/var-path");
3631         chop($var_directory = <VARPATH>);
3632         close(VARPATH);
3633         }
3634 else {
3635         $var_directory = $ENV{'WEBMIN_VAR'};
3636         }
3637 $main::http_cache_directory = $ENV{'WEBMIN_VAR'}."/cache";
3638 $main::default_debug_log_file = $ENV{'WEBMIN_VAR'}."/webmin.debug";
3639
3640 if ($ENV{'SESSION_ID'}) {
3641         # Hide this variable from called programs, but keep it for internal use
3642         $main::session_id = $ENV{'SESSION_ID'};
3643         delete($ENV{'SESSION_ID'});
3644         }
3645 if ($ENV{'REMOTE_PASS'}) {
3646         # Hide the password too
3647         $main::remote_pass = $ENV{'REMOTE_PASS'};
3648         delete($ENV{'REMOTE_PASS'});
3649         }
3650
3651 if ($> == 0 && $< != 0 && !$ENV{'FOREIGN_MODULE_NAME'}) {
3652         # Looks like we are running setuid, but the real UID hasn't been set.
3653         # Do so now, so that executed programs don't get confused
3654         $( = $);
3655         $< = $>;
3656         }
3657
3658 # Read the webmin global config file. This contains the OS type and version,
3659 # OS specific configuration and global options such as proxy servers
3660 $config_file = "$config_directory/config";
3661 %gconfig = ( );
3662 &read_file_cached($config_file, \%gconfig);
3663 $null_file = $gconfig{'os_type'} eq 'windows' ? "NUL" : "/dev/null";
3664 $path_separator = $gconfig{'os_type'} eq 'windows' ? ';' : ':';
3665
3666 # If debugging is enabled, open the debug log
3667 if ($gconfig{'debug_enabled'} && !$main::opened_debug_log++) {
3668         my $dlog = $gconfig{'debug_file'} || $main::default_debug_log_file;
3669         if ($gconfig{'debug_size'}) {
3670                 my @st = stat($dlog);
3671                 if ($st[7] > $gconfig{'debug_size'}) {
3672                         rename($dlog, $dlog.".0");
3673                         }
3674                 }
3675         open(main::DEBUGLOG, ">>$dlog");
3676         $main::opened_debug_log = 1;
3677
3678         if ($gconfig{'debug_what_start'}) {
3679                 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
3680                 $main::debug_log_start_time = time();
3681                 &webmin_debug_log("START", "script=$script_name");
3682                 $main::debug_log_start_module = $module_name;
3683                 }
3684         }
3685
3686 # Set PATH and LD_LIBRARY_PATH
3687 if ($gconfig{'path'}) {
3688         if ($gconfig{'syspath'}) {
3689                 # Webmin only
3690                 $ENV{'PATH'} = $gconfig{'path'};
3691                 }
3692         else {
3693                 # Include OS too
3694                 $ENV{'PATH'} = $gconfig{'path'}.$path_separator.$ENV{'PATH'};
3695                 }
3696         }
3697 $ENV{$gconfig{'ld_env'}} = $gconfig{'ld_path'} if ($gconfig{'ld_env'});
3698
3699 # Set http_proxy and ftp_proxy environment variables, based on Webmin settings
3700 if ($gconfig{'http_proxy'}) {
3701         $ENV{'http_proxy'} = $gconfig{'http_proxy'};
3702         }
3703 if ($gconfig{'ftp_proxy'}) {
3704         $ENV{'ftp_proxy'} = $gconfig{'ftp_proxy'};
3705         }
3706 if ($gconfig{'noproxy'}) {
3707         $ENV{'no_proxy'} = $gconfig{'noproxy'};
3708         }
3709
3710 # Find all root directories
3711 my %miniserv;
3712 if (&get_miniserv_config(\%miniserv)) {
3713         @root_directories = ( $miniserv{'root'} );
3714         for($i=0; defined($miniserv{"extraroot_$i"}); $i++) {
3715                 push(@root_directories, $miniserv{"extraroot_$i"});
3716                 }
3717         }
3718
3719 # Work out which module we are in, and read the per-module config file
3720 $0 =~ s/\\/\//g;        # Force consistent path on Windows
3721 if (defined($ENV{'FOREIGN_MODULE_NAME'})) {
3722         # In a foreign call - use the module name given
3723         $root_directory = $ENV{'FOREIGN_ROOT_DIRECTORY'};
3724         $module_name = $ENV{'FOREIGN_MODULE_NAME'};
3725         @root_directories = ( $root_directory ) if (!@root_directories);
3726         }
3727 elsif ($ENV{'SCRIPT_NAME'}) {
3728         my $sn = $ENV{'SCRIPT_NAME'};
3729         $sn =~ s/^$gconfig{'webprefix'}//
3730                 if (!$gconfig{'webprefixnoredir'});
3731         if ($sn =~ /^\/([^\/]+)\//) {
3732                 # Get module name from CGI path
3733                 $module_name = $1;
3734                 }
3735         if ($ENV{'SERVER_ROOT'}) {
3736                 $root_directory = $ENV{'SERVER_ROOT'};
3737                 }
3738         elsif ($ENV{'SCRIPT_FILENAME'}) {
3739                 $root_directory = $ENV{'SCRIPT_FILENAME'};
3740                 $root_directory =~ s/$sn$//;
3741                 }
3742         @root_directories = ( $root_directory ) if (!@root_directories);
3743         }
3744 else {
3745         # Get root directory from miniserv.conf, and deduce module name from $0
3746         $root_directory = $root_directories[0];
3747         my $rok = 0;
3748         foreach my $r (@root_directories) {
3749                 if ($0 =~ /^$r\/([^\/]+)\/[^\/]+$/i) {
3750                         # Under a module directory
3751                         $module_name = $1;
3752                         $rok = 1;
3753                         last;
3754                         }
3755                 elsif ($0 =~ /^$root_directory\/[^\/]+$/i) {
3756                         # At the top level
3757                         $rok = 1;
3758                         last;
3759                         }
3760                 }
3761         &error("Script was not run with full path (failed to find $0 under $root_directory)") if (!$rok);
3762         }
3763
3764 # Work out of this is a web, command line or cron job
3765 if (!$main::webmin_script_type) {
3766         if ($ENV{'SCRIPT_NAME'}) {
3767                 # Run via a CGI
3768                 $main::webmin_script_type = 'web';
3769                 }
3770         else {
3771                 # Cron jobs have no TTY
3772                 if ($gconfig{'os_type'} eq 'windows' ||
3773                     open(DEVTTY, ">/dev/tty")) {
3774                         $main::webmin_script_type = 'cmd';
3775                         close(DEVTTY);
3776                         }
3777                 else {
3778                         $main::webmin_script_type = 'cron';
3779                         }
3780                 }
3781         }
3782
3783 # Set the umask based on config
3784 if ($gconfig{'umask'} && !$main::umask_already++) {
3785         umask(oct($gconfig{'umask'}));
3786         }
3787
3788 # If this is a cron job or other background task, set the nice level
3789 if (!$main::nice_already && $main::webmin_script_type eq 'cron') {
3790         # Set nice level
3791         if ($gconfig{'nice'}) {
3792                 eval 'POSIX::nice($gconfig{\'nice\'});';
3793                 }
3794
3795         # Set IO scheduling class and priority
3796         if ($gconfig{'sclass'} ne '' || $gconfig{'sprio'} ne '') {
3797                 my $cmd = "ionice";
3798                 $cmd .= " -c ".quotemeta($gconfig{'sclass'})
3799                         if ($gconfig{'sclass'} ne '');
3800                 $cmd .= " -n ".quotemeta($gconfig{'sprio'})
3801                         if ($gconfig{'sprio'} ne '');
3802                 $cmd .= " -p $$";
3803                 &execute_command("$cmd >/dev/null 2>&1");
3804                 }
3805         }
3806 $main::nice_already++;
3807
3808 # Get the username
3809 my $u = $ENV{'BASE_REMOTE_USER'} || $ENV{'REMOTE_USER'};
3810 $base_remote_user = $u;
3811 $remote_user = $ENV{'REMOTE_USER'};
3812
3813 if ($module_name) {
3814         # Find and load the configuration file for this module
3815         my (@ruinfo, $rgroup);
3816         $module_config_directory = "$config_directory/$module_name";
3817         if (&get_product_name() eq "usermin" &&
3818             -r "$module_config_directory/config.$remote_user") {
3819                 # Based on username
3820                 $module_config_file = "$module_config_directory/config.$remote_user";
3821                 }
3822         elsif (&get_product_name() eq "usermin" &&
3823             (@ruinfo = getpwnam($remote_user)) &&
3824             ($rgroup = getgrgid($ruinfo[3])) &&
3825             -r "$module_config_directory/config.\@$rgroup") {
3826                 # Based on group name
3827                 $module_config_file = "$module_config_directory/config.\@$rgroup";
3828                 }
3829         else {
3830                 # Global config
3831                 $module_config_file = "$module_config_directory/config";
3832                 }
3833         %config = ( );
3834         &read_file_cached($module_config_file, \%config);
3835
3836         # Fix up windows-specific substitutions in values
3837         foreach my $k (keys %config) {
3838                 if ($config{$k} =~ /\$\{systemroot\}/) {
3839                         my $root = &get_windows_root();
3840                         $config{$k} =~ s/\$\{systemroot\}/$root/g;
3841                         }
3842                 }
3843         }
3844
3845 # Record the initial module
3846 $main::initial_module_name ||= $module_name;
3847
3848 # Set some useful variables
3849 my $current_themes;
3850 $current_themes = $ENV{'MOBILE_DEVICE'} && defined($gconfig{'mobile_theme'}) ?
3851                     $gconfig{'mobile_theme'} :
3852                   defined($gconfig{'theme_'.$remote_user}) ?
3853                     $gconfig{'theme_'.$remote_user} :
3854                   defined($gconfig{'theme_'.$base_remote_user}) ?
3855                     $gconfig{'theme_'.$base_remote_user} :
3856                     $gconfig{'theme'};
3857 @current_themes = split(/\s+/, $current_themes);
3858 $current_theme = $current_themes[0];
3859 @theme_root_directories = map { "$root_directory/$_" } @current_themes;
3860 $theme_root_directory = $theme_root_directories[0];
3861 @theme_configs = ( );
3862 foreach my $troot (@theme_root_directories) {
3863         my %onetconfig;
3864         &read_file_cached("$troot/config", \%onetconfig);
3865         &read_file_cached("$troot/config", \%tconfig);
3866         push(@theme_configs, \%onetconfig);
3867         }
3868 $tb = defined($tconfig{'cs_header'}) ? "bgcolor=#$tconfig{'cs_header'}" :
3869       defined($gconfig{'cs_header'}) ? "bgcolor=#$gconfig{'cs_header'}" :
3870                                        "bgcolor=#9999ff";
3871 $cb = defined($tconfig{'cs_table'}) ? "bgcolor=#$tconfig{'cs_table'}" :
3872       defined($gconfig{'cs_table'}) ? "bgcolor=#$gconfig{'cs_table'}" :
3873                                       "bgcolor=#cccccc";
3874 $tb .= ' '.$tconfig{'tb'} if ($tconfig{'tb'});
3875 $cb .= ' '.$tconfig{'cb'} if ($tconfig{'cb'});
3876 if ($tconfig{'preload_functions'}) {
3877         # Force load of theme functions right now, if requested
3878         &load_theme_library();
3879         }
3880 if ($tconfig{'oofunctions'} && !$main::loaded_theme_oo_library++) {
3881         # Load the theme's Webmin:: package classes
3882         do "$theme_root_directory/$tconfig{'oofunctions'}";
3883         }
3884
3885 $0 =~ /([^\/]+)$/;
3886 $scriptname = $1;
3887 $webmin_logfile = $gconfig{'webmin_log'} ? $gconfig{'webmin_log'}
3888                                          : "$var_directory/webmin.log";
3889
3890 # Load language strings into %text
3891 my @langs = &list_languages();
3892 my $accepted_lang;
3893 if ($gconfig{'acceptlang'}) {
3894         foreach my $a (split(/,/, $ENV{'HTTP_ACCEPT_LANGUAGE'})) {
3895                 my ($al) = grep { $_->{'lang'} eq $a } @langs;
3896                 if ($al) {
3897                         $accepted_lang = $al->{'lang'};
3898                         last;
3899                         }
3900                 }
3901         }
3902 $current_lang = $force_lang ? $force_lang :
3903     $accepted_lang ? $accepted_lang :
3904     $gconfig{"lang_$remote_user"} ? $gconfig{"lang_$remote_user"} :
3905     $gconfig{"lang_$base_remote_user"} ? $gconfig{"lang_$base_remote_user"} :
3906     $gconfig{"lang"} ? $gconfig{"lang"} : $default_lang;
3907 foreach my $l (@langs) {
3908         $current_lang_info = $l if ($l->{'lang'} eq $current_lang);
3909         }
3910 @lang_order_list = &unique($default_lang,
3911                            split(/:/, $current_lang_info->{'fallback'}),
3912                            $current_lang);
3913 %text = &load_language($module_name);
3914 %text || &error("Failed to determine Webmin root from SERVER_ROOT, SCRIPT_FILENAME or the full command line");
3915
3916 # Get the %module_info for this module
3917 if ($module_name) {
3918         my ($mi) = grep { $_->{'dir'} eq $module_name }
3919                          &get_all_module_infos(2);
3920         %module_info = %$mi;
3921         $module_root_directory = &module_root_directory($module_name);
3922         }
3923
3924 if ($module_name && !$main::no_acl_check &&
3925     !defined($ENV{'FOREIGN_MODULE_NAME'})) {
3926         # Check if the HTTP user can access this module
3927         if (!&foreign_available($module_name)) {
3928                 if (!&foreign_check($module_name)) {
3929                         &error(&text('emodulecheck',
3930                                      "<i>$module_info{'desc'}</i>"));
3931                         }
3932                 else {
3933                         &error(&text('emodule', "<i>$u</i>",
3934                                      "<i>$module_info{'desc'}</i>"));
3935                         }
3936                 }
3937         $main::no_acl_check++;
3938         }
3939
3940 # Check the Referer: header for nasty redirects
3941 my @referers = split(/\s+/, $gconfig{'referers'});
3942 my $referer_site;
3943 if ($ENV{'HTTP_REFERER'} =~/^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?([^\/:@]+)/) {
3944         $referer_site = $3;
3945         }
3946 my $http_host = $ENV{'HTTP_HOST'};
3947 $http_host =~ s/:\d+$//;
3948 my $unsafe_index = $unsafe_index_cgi ||
3949                    &get_module_variable('$unsafe_index_cgi');
3950 if ($0 &&
3951     ($ENV{'SCRIPT_NAME'} !~ /^\/(index.cgi)?$/ || $unsafe_index) &&
3952     ($ENV{'SCRIPT_NAME'} !~ /^\/([a-z0-9\_\-]+)\/(index.cgi)?$/i ||
3953      $unsafe_index) &&
3954     $0 !~ /(session_login|pam_login)\.cgi$/ && !$gconfig{'referer'} &&
3955     $ENV{'MINISERV_CONFIG'} && !$main::no_referers_check &&
3956     $ENV{'HTTP_USER_AGENT'} !~ /^Webmin/i &&
3957     ($referer_site && $referer_site ne $http_host &&
3958      &indexof($referer_site, @referers) < 0 ||
3959     !$referer_site && $gconfig{'referers_none'}) &&
3960     !$trust_unknown_referers &&
3961     !&get_module_variable('$trust_unknown_referers')) {
3962         # Looks like a link from elsewhere .. show an error
3963         &header($text{'referer_title'}, "", undef, 0, 1, 1);
3964
3965         $prot = lc($ENV{'HTTPS'}) eq 'on' ? "https" : "http";
3966         my $url = "<tt>".&html_escape("$prot://$ENV{'HTTP_HOST'}$ENV{'REQUEST_URI'}")."</tt>";
3967         if ($referer_site) {
3968                 # From a known host
3969                 print &text('referer_warn',
3970                      "<tt>".&html_escape($ENV{'HTTP_REFERER'})."</tt>", $url);
3971                 print "<p>\n";
3972                 print &text('referer_fix1', &html_escape($http_host)),"<p>\n";
3973                 print &text('referer_fix2', &html_escape($http_host)),"<p>\n";
3974                 }
3975         else {
3976                 # No referer info given
3977                 print &text('referer_warn_unknown', $url),"<p>\n";
3978                 print &text('referer_fix1u'),"<p>\n";
3979                 print &text('referer_fix2u'),"<p>\n";
3980                 }
3981         print "<p>\n";
3982
3983         &footer("/", $text{'index'});
3984         exit;
3985         }
3986 $main::no_referers_check++;
3987 $main::completed_referers_check++;
3988
3989 # Call theme post-init
3990 if (defined(&theme_post_init_config)) {
3991         &theme_post_init_config(@_);
3992         }
3993
3994 # Record that we have done the calling library in this package
3995 my ($callpkg, $lib) = caller();
3996 $lib =~ s/^.*\///;
3997 $main::done_foreign_require{$callpkg,$lib} = 1;
3998
3999 # If a licence checking is enabled, do it now
4000 if ($gconfig{'licence_module'} && !$main::done_licence_module_check &&
4001     &foreign_check($gconfig{'licence_module'}) &&
4002     -r "$root_directory/$gconfig{'licence_module'}/licence_check.pl") {
4003         my $oldpwd = &get_current_dir();
4004         $main::done_licence_module_check++;
4005         $main::licence_module = $gconfig{'licence_module'};
4006         &foreign_require($main::licence_module, "licence_check.pl");
4007         ($main::licence_status, $main::licence_message) =
4008                 &foreign_call($main::licence_module, "check_licence");
4009         chdir($oldpwd);
4010         }
4011
4012 # Export global variables to caller
4013 if ($main::export_to_caller) {
4014         foreach my $v ('$config_file', '%gconfig', '$null_file',
4015                        '$path_separator', '@root_directories',
4016                        '$root_directory', '$module_name',
4017                        '$base_remote_user', '$remote_user',
4018                        '$module_config_directory', '$module_config_file',
4019                        '%config', '@current_themes', '$current_theme',
4020                        '@theme_root_directories', '$theme_root_directory',
4021                        '%tconfig','@theme_configs', '$tb', '$cb', '$scriptname',
4022                        '$webmin_logfile', '$current_lang',
4023                        '$current_lang_info', '@lang_order_list', '%text',
4024                        '%module_info', '$module_root_directory') {
4025                 my ($vt, $vn) = split('', $v, 2);
4026                 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
4027                 }
4028         }
4029
4030 return 1;
4031 }
4032
4033 =head2 load_language([module], [directory])
4034
4035 Returns a hashtable mapping text codes to strings in the appropriate language,
4036 based on the $current_lang global variable, which is in turn set based on
4037 the Webmin user's selection. The optional module parameter tells the function
4038 which module to load strings for, and defaults to the calling module. The
4039 optional directory parameter can be used to load strings from a directory
4040 other than lang.
4041
4042 In regular module development you will never need to call this function
4043 directly, as init_config calls it for you, and places the module's strings
4044 into the %text hash.
4045
4046 =cut
4047 sub load_language
4048 {
4049 my %text;
4050 my $root = $root_directory;
4051 my $ol = $gconfig{'overlang'};
4052 my ($dir) = ($_[1] || "lang");
4053
4054 # Read global lang files
4055 foreach my $o (@lang_order_list) {
4056         my $ok = &read_file_cached("$root/$dir/$o", \%text);
4057         return () if (!$ok && $o eq $default_lang);
4058         }
4059 if ($ol) {
4060         foreach my $o (@lang_order_list) {
4061                 &read_file_cached("$root/$ol/$o", \%text);
4062                 }
4063         }
4064 &read_file_cached("$config_directory/custom-lang", \%text);
4065
4066 if ($_[0]) {
4067         # Read module's lang files
4068         my $mdir = &module_root_directory($_[0]);
4069         foreach my $o (@lang_order_list) {
4070                 &read_file_cached("$mdir/$dir/$o", \%text);
4071                 }
4072         if ($ol) {
4073                 foreach $o (@lang_order_list) {
4074                         &read_file_cached("$mdir/$ol/$o", \%text);
4075                         }
4076                 }
4077         &read_file_cached("$config_directory/$_[0]/custom-lang", \%text);
4078         }
4079 foreach $k (keys %text) {
4080         $text{$k} =~ s/\$(\{([^\}]+)\}|([A-Za-z0-9\.\-\_]+))/text_subs($2 || $3,\%text)/ge;
4081         }
4082
4083 if (defined(&theme_load_language)) {
4084         &theme_load_language(\%text, $_[0]);
4085         }
4086 return %text;
4087 }
4088
4089 =head2 text_subs(string)
4090
4091 Used internally by load_language to expand $code substitutions in language
4092 files.
4093
4094 =cut
4095 sub text_subs
4096 {
4097 if (substr($_[0], 0, 8) eq "include:") {
4098         local $_;
4099         my $rv;
4100         open(INCLUDE, substr($_[0], 8));
4101         while(<INCLUDE>) {
4102                 $rv .= $_;
4103                 }
4104         close(INCLUDE);
4105         return $rv;
4106         }
4107 else {
4108         my $t = $_[1]->{$_[0]};
4109         return defined($t) ? $t : '$'.$_[0];
4110         }
4111 }
4112
4113 =head2 text(message, [substitute]+)
4114
4115 Returns a translated message from %text, but with $1, $2, etc.. replaced with
4116 the substitute parameters. This makes it easy to use strings with placeholders
4117 that get replaced with programmatically generated text. For example :
4118
4119  print &text('index_hello', $remote_user),"<p>\n";
4120
4121 =cut
4122 sub text
4123 {
4124 my $t = &get_module_variable('%text', 1);
4125 my $rv = exists($t->{$_[0]}) ? $t->{$_[0]} : $text{$_[0]};
4126 for(my $i=1; $i<@_; $i++) {
4127         $rv =~ s/\$$i/$_[$i]/g;
4128         }
4129 return $rv;
4130 }
4131
4132 =head2 encode_base64(string)
4133
4134 Encodes a string into base64 format, for use in MIME email or HTTP
4135 authorization headers.
4136
4137 =cut
4138 sub encode_base64
4139 {
4140 my $res;
4141 pos($_[0]) = 0;                          # ensure start at the beginning
4142 while ($_[0] =~ /(.{1,57})/gs) {
4143         $res .= substr(pack('u57', $1), 1)."\n";
4144         chop($res);
4145         }
4146 $res =~ tr|\` -_|AA-Za-z0-9+/|;
4147 my $padding = (3 - length($_[0]) % 3) % 3;
4148 $res =~ s/.{$padding}$/'=' x $padding/e if ($padding);
4149 return $res;
4150 }
4151
4152 =head2 decode_base64(string)
4153
4154 Converts a base64-encoded string into plain text. The opposite of encode_base64.
4155
4156 =cut
4157 sub decode_base64
4158 {
4159 my ($str) = @_;
4160 my $res;
4161 $str =~ tr|A-Za-z0-9+=/||cd;            # remove non-base64 chars
4162 if (length($str) % 4) {
4163         return undef;
4164 }
4165 $str =~ s/=+$//;                        # remove padding
4166 $str =~ tr|A-Za-z0-9+/| -_|;            # convert to uuencoded format
4167 while ($str =~ /(.{1,60})/gs) {
4168         my $len = chr(32 + length($1)*3/4); # compute length byte
4169         $res .= unpack("u", $len . $1 );    # uudecode
4170         }
4171 return $res;
4172 }
4173
4174 =head2 get_module_info(module, [noclone], [forcache])
4175
4176 Returns a hash containg details of the given module. Some useful keys are :
4177
4178 =item dir - The module directory, like sendmail.
4179
4180 =item desc - Human-readable description, in the current users' language.
4181
4182 =item version - Optional module version number.
4183
4184 =item os_support - List of supported operating systems and versions.
4185
4186 =item category - Category on Webmin's left menu, like net.
4187
4188 =cut
4189 sub get_module_info
4190 {
4191 return () if ($_[0] =~ /^\./);
4192 my (%rv, $clone, $o);
4193 my $mdir = &module_root_directory($_[0]);
4194 &read_file_cached("$mdir/module.info", \%rv) || return ();
4195 $clone = -l $mdir;
4196 foreach $o (@lang_order_list) {
4197         $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4198         $rv{"longdesc"} = $rv{"longdesc_$o"} if ($rv{"longdesc_$o"});
4199         }
4200 if ($clone && !$_[1] && $config_directory) {
4201         $rv{'clone'} = $rv{'desc'};
4202         &read_file("$config_directory/$_[0]/clone", \%rv);
4203         }
4204 $rv{'dir'} = $_[0];
4205 my %module_categories;
4206 &read_file_cached("$config_directory/webmin.cats", \%module_categories);
4207 my $pn = &get_product_name();
4208 if (defined($rv{'category_'.$pn})) {
4209         # Can override category for webmin/usermin
4210         $rv{'category'} = $rv{'category_'.$pn};
4211         }
4212 $rv{'realcategory'} = $rv{'category'};
4213 $rv{'category'} = $module_categories{$_[0]}
4214         if (defined($module_categories{$_[0]}));
4215
4216 # Apply description overrides
4217 $rv{'realdesc'} = $rv{'desc'};
4218 my %descs;
4219 &read_file_cached("$config_directory/webmin.descs", \%descs);
4220 if ($descs{$_[0]." ".$current_lang}) {
4221         $rv{'desc'} = $descs{$_[0]." ".$current_lang};
4222         }
4223 elsif ($descs{$_[0]}) {
4224         $rv{'desc'} = $descs{$_[0]};
4225         }
4226
4227 if (!$_[2]) {
4228         # Apply per-user description overridde
4229         my %gaccess = &get_module_acl(undef, "");
4230         if ($gaccess{'desc_'.$_[0]}) {
4231                 $rv{'desc'} = $gaccess{'desc_'.$_[0]};
4232                 }
4233         }
4234
4235 if ($rv{'longdesc'}) {
4236         # All standard modules have an index.cgi
4237         $rv{'index_link'} = 'index.cgi';
4238         }
4239
4240 # Call theme-specific override function
4241 if (defined(&theme_get_module_info)) {
4242         %rv = &theme_get_module_info(\%rv, $_[0], $_[1], $_[2]);
4243         }
4244
4245 return %rv;
4246 }
4247
4248 =head2 get_all_module_infos(cachemode)
4249
4250 Returns a list contains the information on all modules in this webmin
4251 install, including clones. Uses caching to reduce the number of module.info
4252 files that need to be read. Each element of the array is a hash reference
4253 in the same format as returned by get_module_info. The cache mode flag can be :
4254 0 = read and write, 1 = don't read or write, 2 = read only
4255
4256 =cut
4257 sub get_all_module_infos
4258 {
4259 my (%cache, @rv);
4260
4261 # Is the cache out of date? (ie. have any of the root's changed?)
4262 my $cache_file = "$config_directory/module.infos.cache";
4263 my $changed = 0;
4264 if (&read_file_cached($cache_file, \%cache)) {
4265         foreach my $r (@root_directories) {
4266                 my @st = stat($r);
4267                 if ($st[9] != $cache{'mtime_'.$r}) {
4268                         $changed = 2;
4269                         last;
4270                         }
4271                 }
4272         }
4273 else {
4274         $changed = 1;
4275         }
4276
4277 if ($_[0] != 1 && !$changed && $cache{'lang'} eq $current_lang) {
4278         # Can use existing module.info cache
4279         my %mods;
4280         foreach my $k (keys %cache) {
4281                 if ($k =~ /^(\S+) (\S+)$/) {
4282                         $mods{$1}->{$2} = $cache{$k};
4283                         }
4284                 }
4285         @rv = map { $mods{$_} } (keys %mods) if (%mods);
4286         }
4287 else {
4288         # Need to rebuild cache
4289         %cache = ( );
4290         foreach my $r (@root_directories) {
4291                 opendir(DIR, $r);
4292                 foreach my $m (readdir(DIR)) {
4293                         next if ($m =~ /^(config-|\.)/ || $m =~ /\.(cgi|pl)$/);
4294                         my %minfo = &get_module_info($m, 0, 1);
4295                         next if (!%minfo || !$minfo{'dir'});
4296                         push(@rv, \%minfo);
4297                         foreach $k (keys %minfo) {
4298                                 $cache{"${m} ${k}"} = $minfo{$k};
4299                                 }
4300                         }
4301                 closedir(DIR);
4302                 my @st = stat($r);
4303                 $cache{'mtime_'.$r} = $st[9];
4304                 }
4305         $cache{'lang'} = $current_lang;
4306         &write_file($cache_file, \%cache) if (!$_[0] && $< == 0 && $> == 0);
4307         }
4308
4309 # Override descriptions for modules for current user
4310 my %gaccess = &get_module_acl(undef, "");
4311 foreach my $m (@rv) {
4312         if ($gaccess{"desc_".$m->{'dir'}}) {
4313                 $m->{'desc'} = $gaccess{"desc_".$m->{'dir'}};
4314                 }
4315         }
4316
4317 # Apply installed flags
4318 my %installed;
4319 &read_file_cached("$config_directory/installed.cache", \%installed);
4320 foreach my $m (@rv) {
4321         $m->{'installed'} = $installed{$m->{'dir'}};
4322         }
4323
4324 return @rv;
4325 }
4326
4327 =head2 get_theme_info(theme)
4328
4329 Returns a hash containing a theme's details, taken from it's theme.info file.
4330 Some useful keys are :
4331
4332 =item dir - The theme directory, like blue-theme.
4333
4334 =item desc - Human-readable description, in the current users' language.
4335
4336 =item version - Optional module version number.
4337
4338 =item os_support - List of supported operating systems and versions.
4339
4340 =cut
4341 sub get_theme_info
4342 {
4343 return () if ($_[0] =~ /^\./);
4344 my %rv;
4345 my $tdir = &module_root_directory($_[0]);
4346 &read_file("$tdir/theme.info", \%rv) || return ();
4347 foreach my $o (@lang_order_list) {
4348         $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4349         }
4350 $rv{"dir"} = $_[0];
4351 return %rv;
4352 }
4353
4354 =head2 list_languages
4355
4356 Returns an array of supported languages, taken from Webmin's os_list.txt file.
4357 Each is a hash reference with the following keys :
4358
4359 =item lang - The short language code, like es for Spanish.
4360
4361 =item desc - A human-readable description, in English.
4362
4363 =item charset - An optional character set to use when displaying the language.
4364
4365 =item titles - Set to 1 only if Webmin has title images for the language.
4366
4367 =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.
4368
4369 =cut
4370 sub list_languages
4371 {
4372 if (!@main::list_languages_cache) {
4373         my $o;
4374         local $_;
4375         open(LANG, "$root_directory/lang_list.txt");
4376         while(<LANG>) {
4377                 if (/^(\S+)\s+(.*)/) {
4378                         my $l = { 'desc' => $2 };
4379                         foreach $o (split(/,/, $1)) {
4380                                 if ($o =~ /^([^=]+)=(.*)$/) {
4381                                         $l->{$1} = $2;
4382                                         }
4383                                 }
4384                         $l->{'index'} = scalar(@rv);
4385                         push(@main::list_languages_cache, $l);
4386                         }
4387                 }
4388         close(LANG);
4389         @main::list_languages_cache = sort { $a->{'desc'} cmp $b->{'desc'} }
4390                                      @main::list_languages_cache;
4391         }
4392 return @main::list_languages_cache;
4393 }
4394
4395 =head2 read_env_file(file, &hash)
4396
4397 Similar to Webmin's read_file function, but handles files containing shell
4398 environment variables formatted like :
4399
4400   export FOO=bar
4401   SMEG="spod"
4402
4403 The file parameter is the full path to the file to read, and hash a Perl hash
4404 ref to read names and values into.
4405
4406 =cut
4407 sub read_env_file
4408 {
4409 local $_;
4410 &open_readfile(FILE, $_[0]) || return 0;
4411 while(<FILE>) {
4412         s/#.*$//g;
4413         if (/^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*"(.*)"/i ||
4414             /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*'(.*)'/i ||
4415             /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*(.*)/i) {
4416                 $_[1]->{$2} = $3;
4417                 }
4418         }
4419 close(FILE);
4420 return 1;
4421 }
4422
4423 =head2 write_env_file(file, &hash, [export])
4424
4425 Writes out a hash to a file in name='value' format, suitable for use in a shell
4426 script. The parameters are :
4427
4428 =item file - Full path for a file to write to
4429
4430 =item hash - Hash reference of names and values to write.
4431
4432 =item export - If set to 1, preceed each variable setting with the word 'export'.
4433
4434 =cut
4435 sub write_env_file
4436 {
4437 my $exp = $_[2] ? "export " : "";
4438 &open_tempfile(FILE, ">$_[0]");
4439 foreach my $k (keys %{$_[1]}) {
4440         my $v = $_[1]->{$k};
4441         if ($v =~ /^\S+$/) {
4442                 &print_tempfile(FILE, "$exp$k=$v\n");
4443                 }
4444         else {
4445                 &print_tempfile(FILE, "$exp$k=\"$v\"\n");
4446                 }
4447         }
4448 &close_tempfile(FILE);
4449 }
4450
4451 =head2 lock_file(filename, [readonly], [forcefile])
4452
4453 Lock a file for exclusive access. If the file is already locked, spin
4454 until it is freed. Uses a .lock file, which is not 100% reliable, but seems
4455 to work OK. The parameters are :
4456
4457 =item filename - File or directory to lock.
4458
4459 =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.
4460
4461 =item forcefile - Force the file to be considered as a real file and not a symlink for Webmin actions logging purposes.
4462
4463 =cut
4464 sub lock_file
4465 {
4466 my $realfile = &translate_filename($_[0]);
4467 return 0 if (!$_[0] || defined($main::locked_file_list{$realfile}));
4468 my $no_lock = !&can_lock_file($realfile);
4469 my $lock_tries_count = 0;
4470 while(1) {
4471         my $pid;
4472         if (!$no_lock && open(LOCKING, "$realfile.lock")) {
4473                 $pid = <LOCKING>;
4474                 $pid = int($pid);
4475                 close(LOCKING);
4476                 }
4477         if ($no_lock || !$pid || !kill(0, $pid) || $pid == $$) {
4478                 # Got the lock!
4479                 if (!$no_lock) {
4480                         # Create the .lock file
4481                         open(LOCKING, ">$realfile.lock") || return 0;
4482                         my $lck = eval "flock(LOCKING, 2+4)";
4483                         if (!$lck && !$@) {
4484                                 # Lock of lock file failed! Wait till later
4485                                 goto tryagain;
4486                                 }
4487                         print LOCKING $$,"\n";
4488                         eval "flock(LOCKING, 8)";
4489                         close(LOCKING);
4490                         }
4491                 $main::locked_file_list{$realfile} = int($_[1]);
4492                 push(@main::temporary_files, "$realfile.lock");
4493                 if (($gconfig{'logfiles'} || $gconfig{'logfullfiles'}) &&
4494                     !&get_module_variable('$no_log_file_changes') &&
4495                     !$_[1]) {
4496                         # Grab a copy of this file for later diffing
4497                         my $lnk;
4498                         $main::locked_file_data{$realfile} = undef;
4499                         if (-d $realfile) {
4500                                 $main::locked_file_type{$realfile} = 1;
4501                                 $main::locked_file_data{$realfile} = '';
4502                                 }
4503                         elsif (!$_[2] && ($lnk = readlink($realfile))) {
4504                                 $main::locked_file_type{$realfile} = 2;
4505                                 $main::locked_file_data{$realfile} = $lnk;
4506                                 }
4507                         elsif (open(ORIGFILE, $realfile)) {
4508                                 $main::locked_file_type{$realfile} = 0;
4509                                 $main::locked_file_data{$realfile} = '';
4510                                 local $_;
4511                                 while(<ORIGFILE>) {
4512                                         $main::locked_file_data{$realfile} .=$_;
4513                                         }
4514                                 close(ORIGFILE);
4515                                 }
4516                         }
4517                 last;
4518                 }
4519 tryagain:
4520         sleep(1);
4521         if ($lock_tries_count++ > 5*60) {
4522                 # Give up after 5 minutes
4523                 &error(&text('elock_tries', "<tt>$realfile</tt>", 5));
4524                 }
4525         }
4526 return 1;
4527 }
4528
4529 =head2 unlock_file(filename)
4530
4531 Release a lock on a file taken out by lock_file. If Webmin actions logging of
4532 file changes is enabled, then at unlock file a diff will be taken between the
4533 old and new contents, and stored under /var/webmin/diffs when webmin_log is
4534 called. This can then be viewed in the Webmin Actions Log module.
4535
4536 =cut
4537 sub unlock_file
4538 {
4539 my $realfile = &translate_filename($_[0]);
4540 return if (!$_[0] || !defined($main::locked_file_list{$realfile}));
4541 unlink("$realfile.lock") if (&can_lock_file($realfile));
4542 delete($main::locked_file_list{$realfile});
4543 if (exists($main::locked_file_data{$realfile})) {
4544         # Diff the new file with the old
4545         stat($realfile);
4546         my $lnk = readlink($realfile);
4547         my $type = -d _ ? 1 : $lnk ? 2 : 0;
4548         my $oldtype = $main::locked_file_type{$realfile};
4549         my $new = !defined($main::locked_file_data{$realfile});
4550         if ($new && !-e _) {
4551                 # file doesn't exist, and never did! do nothing ..
4552                 }
4553         elsif ($new && $type == 1 || !$new && $oldtype == 1) {
4554                 # is (or was) a directory ..
4555                 if (-d _ && !defined($main::locked_file_data{$realfile})) {
4556                         push(@main::locked_file_diff,
4557                              { 'type' => 'mkdir', 'object' => $realfile });
4558                         }
4559                 elsif (!-d _ && defined($main::locked_file_data{$realfile})) {
4560                         push(@main::locked_file_diff,
4561                              { 'type' => 'rmdir', 'object' => $realfile });
4562                         }
4563                 }
4564         elsif ($new && $type == 2 || !$new && $oldtype == 2) {
4565                 # is (or was) a symlink ..
4566                 if ($lnk && !defined($main::locked_file_data{$realfile})) {
4567                         push(@main::locked_file_diff,
4568                              { 'type' => 'symlink', 'object' => $realfile,
4569                                'data' => $lnk });
4570                         }
4571                 elsif (!$lnk && defined($main::locked_file_data{$realfile})) {
4572                         push(@main::locked_file_diff,
4573                              { 'type' => 'unsymlink', 'object' => $realfile,
4574                                'data' => $main::locked_file_data{$realfile} });
4575                         }
4576                 elsif ($lnk ne $main::locked_file_data{$realfile}) {
4577                         push(@main::locked_file_diff,
4578                              { 'type' => 'resymlink', 'object' => $realfile,
4579                                'data' => $lnk });
4580                         }
4581                 }
4582         else {
4583                 # is a file, or has changed type?!
4584                 my ($diff, $delete_file);
4585                 my $type = "modify";
4586                 if (!-r _) {
4587                         open(NEWFILE, ">$realfile");
4588                         close(NEWFILE);
4589                         $delete_file++;
4590                         $type = "delete";
4591                         }
4592                 if (!defined($main::locked_file_data{$realfile})) {
4593                         $type = "create";
4594                         }
4595                 open(ORIGFILE, ">$realfile.webminorig");
4596                 print ORIGFILE $main::locked_file_data{$realfile};
4597                 close(ORIGFILE);
4598                 $diff = &backquote_command(
4599                         "diff ".quotemeta("$realfile.webminorig")." ".
4600                                 quotemeta($realfile)." 2>/dev/null");
4601                 push(@main::locked_file_diff,
4602                      { 'type' => $type, 'object' => $realfile,
4603                        'data' => $diff } ) if ($diff);
4604                 unlink("$realfile.webminorig");
4605                 unlink($realfile) if ($delete_file);
4606                 }
4607
4608         if ($gconfig{'logfullfiles'}) {
4609                 # Add file details to list of those to fully log
4610                 $main::orig_file_data{$realfile} ||=
4611                         $main::locked_file_data{$realfile};
4612                 $main::orig_file_type{$realfile} ||=
4613                         $main::locked_file_type{$realfile};
4614                 }
4615
4616         delete($main::locked_file_data{$realfile});
4617         delete($main::locked_file_type{$realfile});
4618         }
4619 }
4620
4621 =head2 test_lock(file)
4622
4623 Returns 1 if some file is currently locked, 0 if not.
4624
4625 =cut
4626 sub test_lock
4627 {
4628 my $realfile = &translate_filename($_[0]);
4629 return 0 if (!$_[0]);
4630 return 1 if (defined($main::locked_file_list{$realfile}));
4631 return 0 if (!&can_lock_file($realfile));
4632 my $pid;
4633 if (open(LOCKING, "$realfile.lock")) {
4634         $pid = <LOCKING>;
4635         $pid = int($pid);
4636         close(LOCKING);
4637         }
4638 return $pid && kill(0, $pid);
4639 }
4640
4641 =head2 unlock_all_files
4642
4643 Unlocks all files locked by the current script.
4644
4645 =cut
4646 sub unlock_all_files
4647 {
4648 foreach $f (keys %main::locked_file_list) {
4649         &unlock_file($f);
4650         }
4651 }
4652
4653 =head2 can_lock_file(file)
4654
4655 Returns 1 if some file should be locked, based on the settings in the
4656 Webmin Configuration module. For internal use by lock_file only.
4657
4658 =cut
4659 sub can_lock_file
4660 {
4661 if (&is_readonly_mode()) {
4662         return 0;       # never lock in read-only mode
4663         }
4664 elsif ($gconfig{'lockmode'} == 0) {
4665         return 1;       # always
4666         }
4667 elsif ($gconfig{'lockmode'} == 1) {
4668         return 0;       # never
4669         }
4670 else {
4671         # Check if under any of the directories
4672         my $match;
4673         foreach my $d (split(/\t+/, $gconfig{'lockdirs'})) {
4674                 if (&same_file($d, $_[0]) ||
4675                     &is_under_directory($d, $_[0])) {
4676                         $match = 1;
4677                         }
4678                 }
4679         return $gconfig{'lockmode'} == 2 ? $match : !$match;
4680         }
4681 }
4682
4683 =head2 webmin_log(action, type, object, &params, [module], [host, script-on-host, client-ip])
4684
4685 Log some action taken by a user. This is typically called at the end of a
4686 script, once all file changes are complete and all commands run. The
4687 parameters are :
4688
4689 =item action - A short code for the action being performed, like 'create'.
4690
4691 =item type - A code for the type of object the action is performed to, like 'user'.
4692
4693 =item object - A short name for the object, like 'joe' if the Unix user 'joe' was just created.
4694
4695 =item params - A hash ref of additional information about the action.
4696
4697 =item module - Name of the module in which the action was performed, which defaults to the current module.
4698
4699 =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.
4700
4701 =item script-on-host - Script name like create_user.cgi on the host the action was performed on.
4702
4703 =item client-ip - IP address of the browser that performed the action.
4704
4705 =cut
4706 sub webmin_log
4707 {
4708 return if (!$gconfig{'log'} || &is_readonly_mode());
4709 my $m = $_[4] ? $_[4] : &get_module_name();
4710
4711 if ($gconfig{'logclear'}) {
4712         # check if it is time to clear the log
4713         my @st = stat("$webmin_logfile.time");
4714         my $write_logtime = 0;
4715         if (@st) {
4716                 if ($st[9]+$gconfig{'logtime'}*60*60 < time()) {
4717                         # clear logfile and all diff files
4718                         &unlink_file("$ENV{'WEBMIN_VAR'}/diffs");
4719                         &unlink_file("$ENV{'WEBMIN_VAR'}/files");
4720                         &unlink_file("$ENV{'WEBMIN_VAR'}/annotations");
4721                         unlink($webmin_logfile);
4722                         $write_logtime = 1;
4723                         }
4724                 }
4725         else {
4726                 $write_logtime = 1;
4727                 }
4728         if ($write_logtime) {
4729                 open(LOGTIME, ">$webmin_logfile.time");
4730                 print LOGTIME time(),"\n";
4731                 close(LOGTIME);
4732                 }
4733         }
4734
4735 # If an action script directory is defined, call the appropriate scripts
4736 if ($gconfig{'action_script_dir'}) {
4737     my ($action, $type, $object) = ($_[0], $_[1], $_[2]);
4738     my ($basedir) = $gconfig{'action_script_dir'};
4739
4740     for my $dir ($basedir/$type/$action, $basedir/$type, $basedir) {
4741         if (-d $dir) {
4742             my ($file);
4743             opendir(DIR, $dir) or die "Can't open $dir: $!";
4744             while (defined($file = readdir(DIR))) {
4745                 next if ($file =~ /^\.\.?$/); # skip '.' and '..'
4746                 if (-x "$dir/$file") {
4747                     # Call a script notifying it of the action
4748                     my %OLDENV = %ENV;
4749                     $ENV{'ACTION_MODULE'} = &get_module_name();
4750                     $ENV{'ACTION_ACTION'} = $_[0];
4751                     $ENV{'ACTION_TYPE'} = $_[1];
4752                     $ENV{'ACTION_OBJECT'} = $_[2];
4753                     $ENV{'ACTION_SCRIPT'} = $script_name;
4754                     foreach my $p (keys %param) {
4755                             $ENV{'ACTION_PARAM_'.uc($p)} = $param{$p};
4756                             }
4757                     system("$dir/$file", @_,
4758                            "<$null_file", ">$null_file", "2>&1");
4759                     %ENV = %OLDENV;
4760                     }
4761                 }
4762             }
4763         }
4764     }
4765
4766 # should logging be done at all?
4767 return if ($gconfig{'logusers'} && &indexof($base_remote_user,
4768            split(/\s+/, $gconfig{'logusers'})) < 0);
4769 return if ($gconfig{'logmodules'} && &indexof($m,
4770            split(/\s+/, $gconfig{'logmodules'})) < 0);
4771
4772 # log the action
4773 my $now = time();
4774 my @tm = localtime($now);
4775 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
4776 my $id = sprintf "%d.%d.%d", $now, $$, $main::action_id_count;
4777 $main::action_id_count++;
4778 my $line = sprintf "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s %s \"%s\" \"%s\" \"%s\"",
4779         $id, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
4780         $tm[2], $tm[1], $tm[0],
4781         $remote_user || '-',
4782         $main::session_id || '-',
4783         $_[7] || $ENV{'REMOTE_HOST'} || '-',
4784         $m, $_[5] ? "$_[5]:$_[6]" : $script_name,
4785         $_[0], $_[1] ne '' ? $_[1] : '-', $_[2] ne '' ? $_[2] : '-';
4786 my %param;
4787 foreach my $k (sort { $a cmp $b } keys %{$_[3]}) {
4788         my $v = $_[3]->{$k};
4789         my @pv;
4790         if ($v eq '') {
4791                 $line .= " $k=''";
4792                 @rv = ( "" );
4793                 }
4794         elsif (ref($v) eq 'ARRAY') {
4795                 foreach $vv (@$v) {
4796                         next if (ref($vv));
4797                         push(@pv, $vv);
4798                         $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
4799                         $line .= " $k='$vv'";
4800                         }
4801                 }
4802         elsif (!ref($v)) {
4803                 foreach $vv (split(/\0/, $v)) {
4804                         push(@pv, $vv);
4805                         $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
4806                         $line .= " $k='$vv'";
4807                         }
4808                 }
4809         $param{$k} = join(" ", @pv);
4810         }
4811 open(WEBMINLOG, ">>$webmin_logfile");
4812 print WEBMINLOG $line,"\n";
4813 close(WEBMINLOG);
4814 if ($gconfig{'logperms'}) {
4815         chmod(oct($gconfig{'logperms'}), $webmin_logfile);
4816         }
4817 else {
4818         chmod(0600, $webmin_logfile);
4819         }
4820
4821 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
4822         # Find and record the changes made to any locked files, or commands run
4823         my $i = 0;
4824         mkdir("$ENV{'WEBMIN_VAR'}/diffs", 0700);
4825         foreach my $d (@main::locked_file_diff) {
4826                 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$id", 0700);
4827                 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i");
4828                 print DIFFLOG "$d->{'type'} $d->{'object'}\n";
4829                 print DIFFLOG $d->{'data'};
4830                 close(DIFFLOG);
4831                 if ($d->{'input'}) {
4832                         open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
4833                         print DIFFLOG $d->{'input'};
4834                         close(DIFFLOG);
4835                         }
4836                 if ($gconfig{'logperms'}) {
4837                         chmod(oct($gconfig{'logperms'}),
4838                               "$ENV{'WEBMIN_VAR'}/diffs/$id/$i",
4839                               "$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
4840                         }
4841                 $i++;
4842                 }
4843         @main::locked_file_diff = undef;
4844         }
4845 if ($gconfig{'logfullfiles'}) {
4846         # Save the original contents of any modified files
4847         my $i = 0;
4848         mkdir("$ENV{'WEBMIN_VAR'}/files", 0700);
4849         foreach my $f (keys %main::orig_file_data) {
4850                 mkdir("$ENV{'WEBMIN_VAR'}/files/$id", 0700);
4851                 open(ORIGLOG, ">$ENV{'WEBMIN_VAR'}/files/$id/$i");
4852                 if (!defined($main::orig_file_type{$f})) {
4853                         print ORIGLOG -1," ",$f,"\n";
4854                         }
4855                 else {
4856                         print ORIGLOG $main::orig_file_type{$f}," ",$f,"\n";
4857                         }
4858                 print ORIGLOG $main::orig_file_data{$f};
4859                 close(ORIGLOG);
4860                 if ($gconfig{'logperms'}) {
4861                         chmod(oct($gconfig{'logperms'}),
4862                               "$ENV{'WEBMIN_VAR'}/files/$id.$i");
4863                         }
4864                 $i++;
4865                 }
4866         %main::orig_file_data = undef;
4867         %main::orig_file_type = undef;
4868         }
4869
4870 # Log to syslog too
4871 if ($gconfig{'logsyslog'}) {
4872         eval 'use Sys::Syslog qw(:DEFAULT setlogsock);
4873               openlog(&get_product_name(), "cons,pid,ndelay", "daemon");
4874               setlogsock("inet");';
4875         if (!$@) {
4876                 # Syslog module is installed .. try to convert to a
4877                 # human-readable form
4878                 my $msg;
4879                 my $mod = &get_module_name();
4880                 my $mdir = module_root_directory($mod);
4881                 if (-r "$mdir/log_parser.pl") {
4882                         &foreign_require($mod, "log_parser.pl");
4883                         my %params;
4884                         foreach my $k (keys %{$_[3]}) {
4885                                 my $v = $_[3]->{$k};
4886                                 if (ref($v) eq 'ARRAY') {
4887                                         $params{$k} = join("\0", @$v);
4888                                         }
4889                                 else {
4890                                         $params{$k} = $v;
4891                                         }
4892                                 }
4893                         $msg = &foreign_call($mod, "parse_webmin_log",
4894                                 $remote_user, $script_name,
4895                                 $_[0], $_[1], $_[2], \%params);
4896                         $msg =~ s/<[^>]*>//g;   # Remove tags
4897                         }
4898                 elsif ($_[0] eq "_config_") {
4899                         my %wtext = &load_language("webminlog");
4900                         $msg = $wtext{'search_config'};
4901                         }
4902                 $msg ||= "$_[0] $_[1] $_[2]";
4903                 my %info = &get_module_info($m);
4904                 eval { syslog("info", "%s", "[$info{'desc'}] $msg"); };
4905                 }
4906         }
4907 }
4908
4909 =head2 additional_log(type, object, data, [input])
4910
4911 Records additional log data for an upcoming call to webmin_log, such
4912 as a command that was run or SQL that was executed. Typically you will never
4913 need to call this function directory.
4914
4915 =cut
4916 sub additional_log
4917 {
4918 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
4919         push(@main::locked_file_diff,
4920              { 'type' => $_[0], 'object' => $_[1], 'data' => $_[2],
4921                'input' => $_[3] } );
4922         }
4923 }
4924
4925 =head2 webmin_debug_log(type, message)
4926
4927 Write something to the Webmin debug log. For internal use only.
4928
4929 =cut
4930 sub webmin_debug_log
4931 {
4932 my ($type, $msg) = @_;
4933 return 0 if (!$main::opened_debug_log);
4934 return 0 if ($gconfig{'debug_no'.$main::webmin_script_type});
4935 if ($gconfig{'debug_modules'}) {
4936         my @dmods = split(/\s+/, $gconfig{'debug_modules'});
4937         return 0 if (&indexof($main::initial_module_name, @dmods) < 0);
4938         }
4939 my $now = time();
4940 my @tm = localtime($now);
4941 my $line = sprintf
4942         "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s \"%s\"",
4943         $$, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
4944         $tm[2], $tm[1], $tm[0],
4945         $remote_user || "-",
4946         $ENV{'REMOTE_HOST'} || "-",
4947         &get_module_name() || "-",
4948         $type,
4949         $msg;
4950 seek(main::DEBUGLOG, 0, 2);
4951 print main::DEBUGLOG $line."\n";
4952 return 1;
4953 }
4954
4955 =head2 system_logged(command)
4956
4957 Just calls the Perl system() function, but also logs the command run.
4958
4959 =cut
4960 sub system_logged
4961 {
4962 if (&is_readonly_mode()) {
4963         print STDERR "Vetoing command $_[0]\n";
4964         return 0;
4965         }
4966 my @realcmd = ( &translate_command($_[0]), @_[1..$#_] );
4967 my $cmd = join(" ", @realcmd);
4968 my $and;
4969 if ($cmd =~ s/(\s*&\s*)$//) {
4970         $and = $1;
4971         }
4972 while($cmd =~ s/(\d*)(<|>)((\/(tmp|dev)\S+)|&\d+)\s*$//) { }
4973 $cmd =~ s/^\((.*)\)\s*$/$1/;
4974 $cmd .= $and;
4975 &additional_log('exec', undef, $cmd);
4976 return system(@realcmd);
4977 }
4978
4979 =head2 backquote_logged(command)
4980
4981 Executes a command and returns the output (like `command`), but also logs it.
4982
4983 =cut
4984 sub backquote_logged
4985 {
4986 if (&is_readonly_mode()) {
4987         $? = 0;
4988         print STDERR "Vetoing command $_[0]\n";
4989         return undef;
4990         }
4991 my $realcmd = &translate_command($_[0]);
4992 my $cmd = $realcmd;
4993 my $and;
4994 if ($cmd =~ s/(\s*&\s*)$//) {
4995         $and = $1;
4996         }
4997 while($cmd =~ s/(\d*)(<|>)((\/(tmp\/.webmin|dev)\S+)|&\d+)\s*$//) { }
4998 $cmd =~ s/^\((.*)\)\s*$/$1/;
4999 $cmd .= $and;
5000 &additional_log('exec', undef, $cmd);
5001 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
5002 return `$realcmd`;
5003 }
5004
5005 =head2 backquote_with_timeout(command, timeout, safe?, [maxlines])
5006
5007 Runs some command, waiting at most the given number of seconds for it to
5008 complete, and returns the output. The maxlines parameter sets the number
5009 of lines of output to capture. The safe parameter should be set to 1 if the
5010 command is safe for read-only mode users to run.
5011
5012 =cut
5013 sub backquote_with_timeout
5014 {
5015 my $realcmd = &translate_command($_[0]);
5016 &webmin_debug_log('CMD', "cmd=$realcmd timeout=$_[1]")
5017         if ($gconfig{'debug_what_cmd'});
5018 my $out;
5019 my $pid = &open_execute_command(OUT, "($realcmd) <$null_file", 1, $_[2]);
5020 my $start = time();
5021 my $timed_out = 0;
5022 my $linecount = 0;
5023 while(1) {
5024         my $elapsed = time() - $start;
5025         last if ($elapsed > $_[1]);
5026         my $rmask;
5027         vec($rmask, fileno(OUT), 1) = 1;
5028         my $sel = select($rmask, undef, undef, $_[1] - $elapsed);
5029         last if (!$sel || $sel < 0);
5030         my $line = <OUT>;
5031         last if (!defined($line));
5032         $out .= $line;
5033         $linecount++;
5034         if ($_[3] && $linecount >= $_[3]) {
5035                 # Got enough lines
5036                 last;
5037                 }
5038         }
5039 if (kill('TERM', $pid) && time() - $start >= $_[1]) {
5040         $timed_out = 1;
5041         }
5042 close(OUT);
5043 return wantarray ? ($out, $timed_out) : $out;
5044 }
5045
5046 =head2 backquote_command(command, safe?)
5047
5048 Executes a command and returns the output (like `command`), subject to
5049 command translation. The safe parameter should be set to 1 if the command
5050 is safe for read-only mode users to run.
5051
5052 =cut
5053 sub backquote_command
5054 {
5055 if (&is_readonly_mode() && !$_[1]) {
5056         print STDERR "Vetoing command $_[0]\n";
5057         $? = 0;
5058         return undef;
5059         }
5060 my $realcmd = &translate_command($_[0]);
5061 &webmin_debug_log('CMD', "cmd=$realcmd") if ($gconfig{'debug_what_cmd'});
5062 return `$realcmd`;
5063 }
5064
5065 =head2 kill_logged(signal, pid, ...)
5066
5067 Like Perl's built-in kill function, but also logs the fact that some process
5068 was killed. On Windows, falls back to calling process.exe to terminate a
5069 process.
5070
5071 =cut
5072 sub kill_logged
5073 {
5074 return scalar(@_)-1 if (&is_readonly_mode());
5075 &webmin_debug_log('KILL', "signal=$_[0] pids=".join(" ", @_[1..@_-1]))
5076         if ($gconfig{'debug_what_procs'});
5077 &additional_log('kill', $_[0], join(" ", @_[1..@_-1])) if (@_ > 1);
5078 if ($gconfig{'os_type'} eq 'windows') {
5079         # Emulate some kills with process.exe
5080         my $arg = $_[0] eq "KILL" ? "-k" :
5081                   $_[0] eq "TERM" ? "-q" :
5082                   $_[0] eq "STOP" ? "-s" :
5083                   $_[0] eq "CONT" ? "-r" : undef;
5084         my $ok = 0;
5085         foreach my $p (@_[1..@_-1]) {
5086                 if ($p < 0) {
5087                         $ok ||= kill($_[0], $p);
5088                         }
5089                 elsif ($arg) {
5090                         &execute_command("process $arg $p");
5091                         $ok = 1;
5092                         }
5093                 }
5094         return $ok;
5095         }
5096 else {
5097         # Normal Unix kill
5098         return kill(@_);
5099         }
5100 }
5101
5102 =head2 rename_logged(old, new)
5103
5104 Re-names a file and logs the rename. If the old and new files are on different
5105 filesystems, calls mv or the Windows rename function to do the job.
5106
5107 =cut
5108 sub rename_logged
5109 {
5110 &additional_log('rename', $_[0], $_[1]) if ($_[0] ne $_[1]);
5111 return &rename_file($_[0], $_[1]);
5112 }
5113
5114 =head2 rename_file(old, new)
5115
5116 Renames a file or directory. If the old and new files are on different
5117 filesystems, calls mv or the Windows rename function to do the job.
5118
5119 =cut
5120 sub rename_file
5121 {
5122 if (&is_readonly_mode()) {
5123         print STDERR "Vetoing rename from $_[0] to $_[1]\n";
5124         return 1;
5125         }
5126 my $src = &translate_filename($_[0]);
5127 my $dst = &translate_filename($_[1]);
5128 &webmin_debug_log('RENAME', "src=$src dst=$dst")
5129         if ($gconfig{'debug_what_ops'});
5130 my $ok = rename($src, $dst);
5131 if (!$ok && $! !~ /permission/i) {
5132         # Try the mv command, in case this is a cross-filesystem rename
5133         if ($gconfig{'os_type'} eq 'windows') {
5134                 # Need to use rename
5135                 my $out = &backquote_command("rename ".quotemeta($_[0]).
5136                                              " ".quotemeta($_[1])." 2>&1");
5137                 $ok = !$?;
5138                 $! = $out if (!$ok);
5139                 }
5140         else {
5141                 # Can use mv
5142                 my $out = &backquote_command("mv ".quotemeta($_[0]).
5143                                              " ".quotemeta($_[1])." 2>&1");
5144                 $ok = !$?;
5145                 $! = $out if (!$ok);
5146                 }
5147         }
5148 return $ok;
5149 }
5150
5151 =head2 symlink_logged(src, dest)
5152
5153 Create a symlink, and logs it. Effectively does the same thing as the Perl
5154 symlink function.
5155
5156 =cut
5157 sub symlink_logged
5158 {
5159 &lock_file($_[1]);
5160 my $rv = &symlink_file($_[0], $_[1]);
5161 &unlock_file($_[1]);
5162 return $rv;
5163 }
5164
5165 =head2 symlink_file(src, dest)
5166
5167 Creates a soft link, unless in read-only mode. Effectively does the same thing
5168 as the Perl symlink function.
5169
5170 =cut
5171 sub symlink_file
5172 {
5173 if (&is_readonly_mode()) {
5174         print STDERR "Vetoing symlink from $_[0] to $_[1]\n";
5175         return 1;
5176         }
5177 my $src = &translate_filename($_[0]);
5178 my $dst = &translate_filename($_[1]);
5179 &webmin_debug_log('SYMLINK', "src=$src dst=$dst")
5180         if ($gconfig{'debug_what_ops'});
5181 return symlink($src, $dst);
5182 }
5183
5184 =head2 link_file(src, dest)
5185
5186 Creates a hard link, unless in read-only mode. The existing new link file
5187 will be deleted if necessary. Effectively the same as Perl's link function.
5188
5189 =cut
5190 sub link_file
5191 {
5192 if (&is_readonly_mode()) {
5193         print STDERR "Vetoing link from $_[0] to $_[1]\n";
5194         return 1;
5195         }
5196 my $src = &translate_filename($_[0]);
5197 my $dst = &translate_filename($_[1]);
5198 &webmin_debug_log('LINK', "src=$src dst=$dst")
5199         if ($gconfig{'debug_what_ops'});
5200 unlink($dst);                   # make sure link works
5201 return link($src, $dst);
5202 }
5203
5204 =head2 make_dir(dir, perms, recursive)
5205
5206 Creates a directory and sets permissions on it, unless in read-only mode.
5207 The perms parameter sets the octal permissions to apply, which unlike Perl's
5208 mkdir will really get set. The recursive flag can be set to 1 to have the
5209 function create parent directories too.
5210
5211 =cut
5212 sub make_dir
5213 {
5214 my ($dir, $perms, $recur) = @_;
5215 if (&is_readonly_mode()) {
5216         print STDERR "Vetoing directory $dir\n";
5217         return 1;
5218         }
5219 $dir = &translate_filename($dir);
5220 my $exists = -d $dir ? 1 : 0;
5221 return 1 if ($exists && $recur);        # already exists
5222 &webmin_debug_log('MKDIR', $dir) if ($gconfig{'debug_what_ops'});
5223 my $rv = mkdir($dir, $perms);
5224 if (!$rv && $recur) {
5225         # Failed .. try mkdir -p
5226         my $param = $gconfig{'os_type'} eq 'windows' ? "" : "-p";
5227         my $ex = &execute_command("mkdir $param ".&quote_path($dir));
5228         if ($ex) {
5229                 return 0;
5230                 }
5231         }
5232 if (!$exists) {
5233         chmod($perms, $dir);
5234         }
5235 return 1;
5236 }
5237
5238 =head2 set_ownership_permissions(user, group, perms, file, ...)
5239
5240 Sets the user, group owner and permissions on some files. The parameters are :
5241
5242 =item user - UID or username to change the file owner to. If undef, then the owner is not changed.
5243
5244 =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.
5245
5246 =item perms - Octal permissions set to set on the file. If undef, they are left alone.
5247
5248 =item file - One or more files or directories to modify.
5249
5250 =cut
5251 sub set_ownership_permissions
5252 {
5253 my ($user, $group, $perms, @files) = @_;
5254 if (&is_readonly_mode()) {
5255         print STDERR "Vetoing permission changes on ",join(" ", @files),"\n";
5256         return 1;
5257         }
5258 @files = map { &translate_filename($_) } @files;
5259 if ($gconfig{'debug_what_ops'}) {
5260         foreach my $f (@files) {
5261                 &webmin_debug_log('PERMS',
5262                         "file=$f user=$user group=$group perms=$perms");
5263                 }
5264         }
5265 my $rv = 1;
5266 if (defined($user)) {
5267         my $uid = $user !~ /^\d+$/ ? getpwnam($user) : $user;
5268         my $gid;
5269         if (defined($group)) {
5270                 $gid = $group !~ /^\d+$/ ? getgrnam($group) : $group;
5271                 }
5272         else {
5273                 my @uinfo = getpwuid($uid);
5274                 $gid = $uinfo[3];
5275                 }
5276         $rv = chown($uid, $gid, @files);
5277         }
5278 if ($rv && defined($perms)) {
5279         $rv = chmod($perms, @files);
5280         }
5281 return $rv;
5282 }
5283
5284 =head2 unlink_logged(file, ...)
5285
5286 Like Perl's unlink function, but locks the files beforehand and un-locks them
5287 after so that the deletion is logged by Webmin.
5288
5289 =cut
5290 sub unlink_logged
5291 {
5292 my %locked;
5293 foreach my $f (@_) {
5294         if (!&test_lock($f)) {
5295                 &lock_file($f);
5296                 $locked{$f} = 1;
5297                 }
5298         }
5299 my @rv = &unlink_file(@_);
5300 foreach my $f (@_) {
5301         if ($locked{$f}) {
5302                 &unlock_file($f);
5303                 }
5304         }
5305 return wantarray ? @rv : $rv[0];
5306 }
5307
5308 =head2 unlink_file(file, ...)
5309
5310 Deletes some files or directories. Like Perl's unlink function, but also
5311 recursively deletes directories with the rm command if needed.
5312
5313 =cut
5314 sub unlink_file
5315 {
5316 return 1 if (&is_readonly_mode());
5317 my $rv = 1;
5318 my $err;
5319 foreach my $f (@_) {
5320         &unflush_file_lines($f);
5321         my $realf = &translate_filename($f);
5322         &webmin_debug_log('UNLINK', $realf) if ($gconfig{'debug_what_ops'});
5323         if (-d $realf) {
5324                 if (!rmdir($realf)) {
5325                         my $out;
5326                         if ($gconfig{'os_type'} eq 'windows') {
5327                                 # Call del and rmdir commands
5328                                 my $qm = $realf;
5329                                 $qm =~ s/\//\\/g;
5330                                 my $out = `del /q "$qm" 2>&1`;
5331                                 if (!$?) {
5332                                         $out = `rmdir "$qm" 2>&1`;
5333                                         }
5334                                 }
5335                         else {
5336                                 # Use rm command
5337                                 my $qm = quotemeta($realf);
5338                                 $out = `rm -rf $qm 2>&1`;
5339                                 }
5340                         if ($?) {
5341                                 $rv = 0;
5342                                 $err = $out;
5343                                 }
5344                         }
5345                 }
5346         else {
5347                 if (!unlink($realf)) {
5348                         $rv = 0;
5349                         $err = $!;
5350                         }
5351                 }
5352         }
5353 return wantarray ? ($rv, $err) : $rv;
5354 }
5355
5356 =head2 copy_source_dest(source, dest)
5357
5358 Copy some file or directory to a new location. Returns 1 on success, or 0
5359 on failure - also sets $! on failure. If the source is a directory, uses
5360 piped tar commands to copy a whole directory structure including permissions
5361 and special files.
5362
5363 =cut
5364 sub copy_source_dest
5365 {
5366 return (1, undef) if (&is_readonly_mode());
5367 my ($src, $dst) = @_;
5368 my $ok = 1;
5369 my ($err, $out);
5370 &webmin_debug_log('COPY', "src=$src dst=$dst")
5371         if ($gconfig{'debug_what_ops'});
5372 if ($gconfig{'os_type'} eq 'windows') {
5373         # No tar or cp on windows, so need to use copy command
5374         $src =~ s/\//\\/g;
5375         $dst =~ s/\//\\/g;
5376         if (-d $src) {
5377                 $out = &backquote_logged("xcopy \"$src\" \"$dst\" /Y /E /I 2>&1");
5378                 }
5379         else {
5380                 $out = &backquote_logged("copy /Y \"$src\" \"$dst\" 2>&1");
5381                 }
5382         if ($?) {
5383                 $ok = 0;
5384                 $err = $out;
5385                 }
5386         }
5387 elsif (-d $src) {
5388         # A directory .. need to copy with tar command
5389         my @st = stat($src);
5390         unlink($dst);
5391         mkdir($dst, 0755);
5392         &set_ownership_permissions($st[4], $st[5], $st[2], $dst);
5393         $out = &backquote_logged("(cd ".quotemeta($src)." ; tar cf - . | (cd ".quotemeta($dst)." ; tar xf -)) 2>&1");
5394         if ($?) {
5395                 $ok = 0;
5396                 $err = $out;
5397                 }
5398         }
5399 else {
5400         # Can just copy with cp
5401         my $out = &backquote_logged("cp -p ".quotemeta($src).
5402                                     " ".quotemeta($dst)." 2>&1");
5403         if ($?) {
5404                 $ok = 0;
5405                 $err = $out;
5406                 }
5407         }
5408 return wantarray ? ($ok, $err) : $ok;
5409 }
5410
5411 =head2 remote_session_name(host|&server)
5412
5413 Generates a session ID for some server. For this server, this will always
5414 be an empty string. For a server object it will include the hostname and
5415 port and PID. For a server name, it will include the hostname and PID. For
5416 internal use only.
5417
5418 =cut
5419 sub remote_session_name
5420 {
5421 return ref($_[0]) && $_[0]->{'host'} && $_[0]->{'port'} ?
5422                 "$_[0]->{'host'}:$_[0]->{'port'}.$$" :
5423        $_[0] eq "" || ref($_[0]) && $_[0]->{'id'} == 0 ? "" :
5424        ref($_[0]) ? "" : "$_[0].$$";
5425 }
5426
5427 =head2 remote_foreign_require(server, module, file)
5428
5429 Connects to rpc.cgi on a remote webmin server and have it open a session
5430 to a process that will actually do the require and run functions. This is the
5431 equivalent for foreign_require, but for a remote Webmin system. The server
5432 parameter can either be a hostname of a system registered in the Webmin
5433 Servers Index module, or a hash reference for a system from that module.
5434
5435 =cut
5436 sub remote_foreign_require
5437 {
5438 my $call = { 'action' => 'require',
5439              'module' => $_[1],
5440              'file' => $_[2] };
5441 my $sn = &remote_session_name($_[0]);
5442 if ($remote_session{$sn}) {
5443         $call->{'session'} = $remote_session{$sn};
5444         }
5445 else {
5446         $call->{'newsession'} = 1;
5447         }
5448 my $rv = &remote_rpc_call($_[0], $call);
5449 if ($rv->{'session'}) {
5450         $remote_session{$sn} = $rv->{'session'};
5451         $remote_session_server{$sn} = $_[0];
5452         }
5453 }
5454
5455 =head2 remote_foreign_call(server, module, function, [arg]*)
5456
5457 Call a function on a remote server. Must have been setup first with
5458 remote_foreign_require for the same server and module. Equivalent to
5459 foreign_call, but with the extra server parameter to specify the remote
5460 system's hostname.
5461
5462 =cut
5463 sub remote_foreign_call
5464 {
5465 return undef if (&is_readonly_mode());
5466 my $sn = &remote_session_name($_[0]);
5467 return &remote_rpc_call($_[0], { 'action' => 'call',
5468                                  'module' => $_[1],
5469                                  'func' => $_[2],
5470                                  'session' => $remote_session{$sn},
5471                                  'args' => [ @_[3 .. $#_] ] } );
5472 }
5473
5474 =head2 remote_foreign_check(server, module, [api-only])
5475
5476 Checks if some module is installed and supported on a remote server. Equivilant
5477 to foreign_check, but for the remote Webmin system specified by the server
5478 parameter.
5479
5480 =cut
5481 sub remote_foreign_check
5482 {
5483 return &remote_rpc_call($_[0], { 'action' => 'check',
5484                                  'module' => $_[1],
5485                                  'api' => $_[2] });
5486 }
5487
5488 =head2 remote_foreign_config(server, module)
5489
5490 Gets the configuration for some module from a remote server, as a hash.
5491 Equivalent to foreign_config, but for a remote system.
5492
5493 =cut
5494 sub remote_foreign_config
5495 {
5496 return &remote_rpc_call($_[0], { 'action' => 'config',
5497                                  'module' => $_[1] });
5498 }
5499
5500 =head2 remote_eval(server, module, code)
5501
5502 Evaluates some perl code in the context of a module on a remote webmin server.
5503 The server parameter must be the hostname of a remote system, module must
5504 be a module directory name, and code a string of Perl code to run. This can
5505 only be called after remote_foreign_require for the same server and module.
5506
5507 =cut
5508 sub remote_eval
5509 {
5510 return undef if (&is_readonly_mode());
5511 my $sn = &remote_session_name($_[0]);
5512 return &remote_rpc_call($_[0], { 'action' => 'eval',
5513                                  'module' => $_[1],
5514                                  'code' => $_[2],
5515                                  'session' => $remote_session{$sn} });
5516 }
5517
5518 =head2 remote_write(server, localfile, [remotefile], [remotebasename])
5519
5520 Transfers some local file to another server via Webmin's RPC protocol, and
5521 returns the resulting remote filename. If the remotefile parameter is given,
5522 that is the destination filename which will be used. Otherwise a randomly
5523 selected temporary filename will be used, and returned by the function.
5524
5525 =cut
5526 sub remote_write
5527 {
5528 return undef if (&is_readonly_mode());
5529 my ($data, $got);
5530 my $sn = &remote_session_name($_[0]);
5531 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
5532         # Copy data over TCP connection
5533         my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpwrite',
5534                                            'file' => $_[2],
5535                                            'name' => $_[3] } );
5536         my $error;
5537         my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
5538         &open_socket($serv || "localhost", $rv->[1], TWRITE, \$error);
5539         return &$main::remote_error_handler("Failed to transfer file : $error")
5540                 if ($error);
5541         open(FILE, $_[1]);
5542         while(read(FILE, $got, 1024) > 0) {
5543                 print TWRITE $got;
5544                 }
5545         close(FILE);
5546         shutdown(TWRITE, 1);
5547         $error = <TWRITE>;
5548         if ($error && $error !~ /^OK/) {
5549                 # Got back an error!
5550                 return &$main::remote_error_handler("Failed to transfer file : $error");
5551                 }
5552         close(TWRITE);
5553         return $rv->[0];
5554         }
5555 else {
5556         # Just pass file contents as parameters
5557         open(FILE, $_[1]);
5558         while(read(FILE, $got, 1024) > 0) {
5559                 $data .= $got;
5560                 }
5561         close(FILE);
5562         return &remote_rpc_call($_[0], { 'action' => 'write',
5563                                          'data' => $data,
5564                                          'file' => $_[2],
5565                                          'session' => $remote_session{$sn} });
5566         }
5567 }
5568
5569 =head2 remote_read(server, localfile, remotefile)
5570
5571 Transfers a file from a remote server to this system, using Webmin's RPC
5572 protocol. The server parameter must be the hostname of a system registered
5573 in the Webmin Servers Index module, localfile is the destination path on this
5574 system, and remotefile is the file to fetch from the remote server.
5575
5576 =cut
5577 sub remote_read
5578 {
5579 my $sn = &remote_session_name($_[0]);
5580 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
5581         # Copy data over TCP connection
5582         my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpread',
5583                                            'file' => $_[2] } );
5584         if (!$rv->[0]) {
5585                 return &$main::remote_error_handler("Failed to transfer file : $rv->[1]");
5586                 }
5587         my $error;
5588         my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
5589         &open_socket($serv || "localhost", $rv->[1], TREAD, \$error);
5590         return &$main::remote_error_handler("Failed to transfer file : $error")
5591                 if ($error);
5592         my $got;
5593         open(FILE, ">$_[1]");
5594         while(read(TREAD, $got, 1024) > 0) {
5595                 print FILE $got;
5596                 }
5597         close(FILE);
5598         close(TREAD);
5599         }
5600 else {
5601         # Just get data as return value
5602         my $d = &remote_rpc_call($_[0], { 'action' => 'read',
5603                                           'file' => $_[2],
5604                                           'session' => $remote_session{$sn} });
5605         open(FILE, ">$_[1]");
5606         print FILE $d;
5607         close(FILE);
5608         }
5609 }
5610
5611 =head2 remote_finished
5612
5613 Close all remote sessions. This happens automatically after a while
5614 anyway, but this function should be called to clean things up faster.
5615
5616 =cut
5617 sub remote_finished
5618 {
5619 foreach my $sn (keys %remote_session) {
5620         my $server = $remote_session_server{$sn};
5621         &remote_rpc_call($server, { 'action' => 'quit',
5622                                     'session' => $remote_session{$sn} } );
5623         delete($remote_session{$sn});
5624         delete($remote_session_server{$sn});
5625         }
5626 foreach $fh (keys %fast_fh_cache) {
5627         close($fh);
5628         delete($fast_fh_cache{$fh});
5629         }
5630 }
5631
5632 =head2 remote_error_setup(&function)
5633
5634 Sets a function to be called instead of &error when a remote RPC operation
5635 fails. Useful if you want to have more control over your remote operations.
5636
5637 =cut
5638 sub remote_error_setup
5639 {
5640 $main::remote_error_handler = $_[0] || \&error;
5641 }
5642
5643 =head2 remote_rpc_call(server, structure)
5644
5645 Calls rpc.cgi on some server and passes it a perl structure (hash,array,etc)
5646 and then reads back a reply structure. This is mainly for internal use only,
5647 and is called by the other remote_* functions.
5648
5649 =cut
5650 sub remote_rpc_call
5651 {
5652 my $serv;
5653 my $sn = &remote_session_name($_[0]);   # Will be undef for local connection
5654 if (ref($_[0])) {
5655         # Server structure was given
5656         $serv = $_[0];
5657         $serv->{'user'} || $serv->{'id'} == 0 ||
5658                 return &$main::remote_error_handler(
5659                         "No Webmin login set for server");
5660         }
5661 elsif ($_[0]) {
5662         # lookup the server in the webmin servers module if needed
5663         if (!%main::remote_servers_cache) {
5664                 &foreign_require("servers", "servers-lib.pl");
5665                 foreach $s (&foreign_call("servers", "list_servers")) {
5666                         $main::remote_servers_cache{$s->{'host'}} = $s;
5667                         $main::remote_servers_cache{$s->{'host'}.":".$s->{'port'}} = $s;
5668                         }
5669                 }
5670         $serv = $main::remote_servers_cache{$_[0]};
5671         $serv || return &$main::remote_error_handler(
5672                                 "No Webmin Servers entry for $_[0]");
5673         $serv->{'user'} || return &$main::remote_error_handler(
5674                                 "No login set for server $_[0]");
5675         }
5676 my $ip = $serv->{'ip'} || $serv->{'host'};
5677
5678 # Work out the username and password
5679 my ($user, $pass);
5680 if ($serv->{'sameuser'}) {
5681         $user = $remote_user;
5682         defined($main::remote_pass) || return &$main::remote_error_handler(
5683                                    "Password for this server is not available");
5684         $pass = $main::remote_pass;
5685         }
5686 else {
5687         $user = $serv->{'user'};
5688         $pass = $serv->{'pass'};
5689         }
5690
5691 if ($serv->{'fast'} || !$sn) {
5692         # Make TCP connection call to fastrpc.cgi
5693         if (!$fast_fh_cache{$sn} && $sn) {
5694                 # Need to open the connection
5695                 my $con = &make_http_connection(
5696                         $ip, $serv->{'port'}, $serv->{'ssl'},
5697                         "POST", "/fastrpc.cgi");
5698                 return &$main::remote_error_handler(
5699                     "Failed to connect to $serv->{'host'} : $con")
5700                         if (!ref($con));
5701                 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
5702                 &write_http_connection($con, "User-agent: Webmin\r\n");
5703                 my $auth = &encode_base64("$user:$pass");
5704                 $auth =~ tr/\n//d;
5705                 &write_http_connection($con, "Authorization: basic $auth\r\n");
5706                 &write_http_connection($con, "Content-length: ",
5707                                              length($tostr),"\r\n");
5708                 &write_http_connection($con, "\r\n");
5709                 &write_http_connection($con, $tostr);
5710
5711                 # read back the response
5712                 my $line = &read_http_connection($con);
5713                 $line =~ tr/\r\n//d;
5714                 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
5715                         return &$main::remote_error_handler("Login to RPC server as $user rejected");
5716                         }
5717                 $line =~ /^HTTP\/1\..\s+200\s+/ ||
5718                         return &$main::remote_error_handler("HTTP error : $line");
5719                 do {
5720                         $line = &read_http_connection($con);
5721                         $line =~ tr/\r\n//d;
5722                         } while($line);
5723                 $line = &read_http_connection($con);
5724                 if ($line =~ /^0\s+(.*)/) {
5725                         return &$main::remote_error_handler("RPC error : $1");
5726                         }
5727                 elsif ($line =~ /^1\s+(\S+)\s+(\S+)\s+(\S+)/ ||
5728                        $line =~ /^1\s+(\S+)\s+(\S+)/) {
5729                         # Started ok .. connect and save SID
5730                         &close_http_connection($con);
5731                         my ($port, $sid, $version, $error) = ($1, $2, $3);
5732                         &open_socket($ip, $port, $sid, \$error);
5733                         return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error")
5734                                 if ($error);
5735                         $fast_fh_cache{$sn} = $sid;
5736                         $remote_server_version{$sn} = $version;
5737                         }
5738                 else {
5739                         while($stuff = &read_http_connection($con)) {
5740                                 $line .= $stuff;
5741                                 }
5742                         return &$main::remote_error_handler("Bad response from fastrpc.cgi : $line");
5743                         }
5744                 }
5745         elsif (!$fast_fh_cache{$sn}) {
5746                 # Open the connection by running fastrpc.cgi locally
5747                 pipe(RPCOUTr, RPCOUTw);
5748                 if (!fork()) {
5749                         untie(*STDIN);
5750                         untie(*STDOUT);
5751                         open(STDOUT, ">&RPCOUTw");
5752                         close(STDIN);
5753                         close(RPCOUTr);
5754                         $| = 1;
5755                         $ENV{'REQUEST_METHOD'} = 'GET';
5756                         $ENV{'SCRIPT_NAME'} = '/fastrpc.cgi';
5757                         $ENV{'SERVER_ROOT'} ||= $root_directory;
5758                         my %acl;
5759                         if ($base_remote_user ne 'root' &&
5760                             $base_remote_user ne 'admin') {
5761                                 # Need to fake up a login for the CGI!
5762                                 &read_acl(undef, \%acl);
5763                                 $ENV{'BASE_REMOTE_USER'} =
5764                                         $ENV{'REMOTE_USER'} =
5765                                                 $acl{'root'} ? 'root' : 'admin';
5766                                 }
5767                         delete($ENV{'FOREIGN_MODULE_NAME'});
5768                         delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
5769                         chdir($root_directory);
5770                         if (!exec("$root_directory/fastrpc.cgi")) {
5771                                 print "exec failed : $!\n";
5772                                 exit 1;
5773                                 }
5774                         }
5775                 close(RPCOUTw);
5776                 my $line;
5777                 do {
5778                         ($line = <RPCOUTr>) =~ tr/\r\n//d;
5779                         } while($line);
5780                 $line = <RPCOUTr>;
5781                 #close(RPCOUTr);
5782                 if ($line =~ /^0\s+(.*)/) {
5783                         return &$main::remote_error_handler("RPC error : $2");
5784                         }
5785                 elsif ($line =~ /^1\s+(\S+)\s+(\S+)/) {
5786                         # Started ok .. connect and save SID
5787                         close(SOCK);
5788                         my ($port, $sid, $error) = ($1, $2, undef);
5789                         &open_socket("localhost", $port, $sid, \$error);
5790                         return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error") if ($error);
5791                         $fast_fh_cache{$sn} = $sid;
5792                         }
5793                 else {
5794                         local $_;
5795                         while(<RPCOUTr>) {
5796                                 $line .= $_;
5797                                 }
5798                         &error("Bad response from fastrpc.cgi : $line");
5799                         }
5800                 }
5801         # Got a connection .. send off the request
5802         my $fh = $fast_fh_cache{$sn};
5803         my $tostr = &serialise_variable($_[1]);
5804         print $fh length($tostr)," $fh\n";
5805         print $fh $tostr;
5806         my $rlen = int(<$fh>);
5807         my ($fromstr, $got);
5808         while(length($fromstr) < $rlen) {
5809                 return &$main::remote_error_handler("Failed to read from fastrpc.cgi")
5810                         if (read($fh, $got, $rlen - length($fromstr)) <= 0);
5811                 $fromstr .= $got;
5812                 }
5813         my $from = &unserialise_variable($fromstr);
5814         if (!$from) {
5815                 return &$main::remote_error_handler("Remote Webmin error");
5816                 }
5817         if (defined($from->{'arv'})) {
5818                 return @{$from->{'arv'}};
5819                 }
5820         else {
5821                 return $from->{'rv'};
5822                 }
5823         }
5824 else {
5825         # Call rpc.cgi on remote server
5826         my $tostr = &serialise_variable($_[1]);
5827         my $error = 0;
5828         my $con = &make_http_connection($ip, $serv->{'port'},
5829                                         $serv->{'ssl'}, "POST", "/rpc.cgi");
5830         return &$main::remote_error_handler("Failed to connect to $serv->{'host'} : $con") if (!ref($con));
5831
5832         &write_http_connection($con, "Host: $serv->{'host'}\r\n");
5833         &write_http_connection($con, "User-agent: Webmin\r\n");
5834         my $auth = &encode_base64("$user:$pass");
5835         $auth =~ tr/\n//d;
5836         &write_http_connection($con, "Authorization: basic $auth\r\n");
5837         &write_http_connection($con, "Content-length: ",length($tostr),"\r\n");
5838         &write_http_connection($con, "\r\n");
5839         &write_http_connection($con, $tostr);
5840
5841         # read back the response
5842         my $line = &read_http_connection($con);
5843         $line =~ tr/\r\n//d;
5844         if ($line =~ /^HTTP\/1\..\s+401\s+/) {
5845                 return &$main::remote_error_handler("Login to RPC server as $user rejected");
5846                 }
5847         $line =~ /^HTTP\/1\..\s+200\s+/ || return &$main::remote_error_handler("RPC HTTP error : $line");
5848         do {
5849                 $line = &read_http_connection($con);
5850                 $line =~ tr/\r\n//d;
5851                 } while($line);
5852         my $fromstr;
5853         while($line = &read_http_connection($con)) {
5854                 $fromstr .= $line;
5855                 }
5856         close(SOCK);
5857         my $from = &unserialise_variable($fromstr);
5858         return &$main::remote_error_handler("Invalid RPC login to $serv->{'host'}") if (!$from->{'status'});
5859         if (defined($from->{'arv'})) {
5860                 return @{$from->{'arv'}};
5861                 }
5862         else {
5863                 return $from->{'rv'};
5864                 }
5865         }
5866 }
5867
5868 =head2 remote_multi_callback(&servers, parallel, &function, arg|&args, &returns, &errors, [module, library])
5869
5870 Executes some function in parallel on multiple servers at once. Fills in
5871 the returns and errors arrays respectively. If the module and library
5872 parameters are given, that module is remotely required on the server first,
5873 to check if it is connectable. The parameters are :
5874
5875 =item servers - A list of Webmin system hash references.
5876
5877 =item parallel - Number of parallel operations to perform.
5878
5879 =item function - Reference to function to call for each system.
5880
5881 =item args - Additional parameters to the function.
5882
5883 =item returns - Array ref to place return values into, in same order as servers.
5884
5885 =item errors - Array ref to place error messages into.
5886
5887 =item module - Optional module to require on the remote system first.
5888
5889 =item library - Optional library to require in the module.
5890
5891 =cut
5892 sub remote_multi_callback
5893 {
5894 my ($servs, $parallel, $func, $args, $rets, $errs, $mod, $lib) = @_;
5895 &remote_error_setup(\&remote_multi_callback_error);
5896
5897 # Call the functions
5898 my $p = 0;
5899 foreach my $g (@$servs) {
5900         my $rh = "READ$p";
5901         my $wh = "WRITE$p";
5902         pipe($rh, $wh);
5903         if (!fork()) {
5904                 close($rh);
5905                 $remote_multi_callback_err = undef;
5906                 if ($mod) {
5907                         # Require the remote lib
5908                         &remote_foreign_require($g->{'host'}, $mod, $lib);
5909                         if ($remote_multi_callback_err) {
5910                                 # Failed .. return error
5911                                 print $wh &serialise_variable(
5912                                         [ undef, $remote_multi_callback_err ]);
5913                                 exit(0);
5914                                 }
5915                         }
5916
5917                 # Call the function
5918                 my $a = ref($args) ? $args->[$p] : $args;
5919                 my $rv = &$func($g, $a);
5920
5921                 # Return the result
5922                 print $wh &serialise_variable(
5923                         [ $rv, $remote_multi_callback_err ]);
5924                 close($wh);
5925                 exit(0);
5926                 }
5927         close($wh);
5928         $p++;
5929         }
5930
5931 # Read back the results
5932 $p = 0;
5933 foreach my $g (@$servs) {
5934         my $rh = "READ$p";
5935         my $line = <$rh>;
5936         if (!$line) {
5937                 $errs->[$p] = "Failed to read response from $g->{'host'}";
5938                 }
5939         else {
5940                 my $rv = &unserialise_variable($line);
5941                 close($rh);
5942                 $rets->[$p] = $rv->[0];
5943                 $errs->[$p] = $rv->[1];
5944                 }
5945         $p++;
5946         }
5947
5948 &remote_error_setup(undef);
5949 }
5950
5951 sub remote_multi_callback_error
5952 {
5953 $remote_multi_callback_err = $_[0];
5954 }
5955
5956 =head2 serialise_variable(variable)
5957
5958 Converts some variable (maybe a scalar, hash ref, array ref or scalar ref)
5959 into a url-encoded string. In the cases of arrays and hashes, it is recursively
5960 called on each member to serialize the entire object.
5961
5962 =cut
5963 sub serialise_variable
5964 {
5965 if (!defined($_[0])) {
5966         return 'UNDEF';
5967         }
5968 my $r = ref($_[0]);
5969 my $rv;
5970 if (!$r) {
5971         $rv = &urlize($_[0]);
5972         }
5973 elsif ($r eq 'SCALAR') {
5974         $rv = &urlize(${$_[0]});
5975         }
5976 elsif ($r eq 'ARRAY') {
5977         $rv = join(",", map { &urlize(&serialise_variable($_)) } @{$_[0]});
5978         }
5979 elsif ($r eq 'HASH') {
5980         $rv = join(",", map { &urlize(&serialise_variable($_)).",".
5981                               &urlize(&serialise_variable($_[0]->{$_})) }
5982                             keys %{$_[0]});
5983         }
5984 elsif ($r eq 'REF') {
5985         $rv = &serialise_variable(${$_[0]});
5986         }
5987 elsif ($r eq 'CODE') {
5988         # Code not handled
5989         $rv = undef;
5990         }
5991 elsif ($r) {
5992         # An object - treat as a hash
5993         $r = "OBJECT ".&urlize($r);
5994         $rv = join(",", map { &urlize(&serialise_variable($_)).",".
5995                               &urlize(&serialise_variable($_[0]->{$_})) }
5996                             keys %{$_[0]});
5997         }
5998 return ($r ? $r : 'VAL').",".$rv;
5999 }
6000
6001 =head2 unserialise_variable(string)
6002
6003 Converts a string created by serialise_variable() back into the original
6004 scalar, hash ref, array ref or scalar ref. If the original variable was a Perl
6005 object, the same class is used on this system, if available.
6006
6007 =cut
6008 sub unserialise_variable
6009 {
6010 my @v = split(/,/, $_[0]);
6011 my $rv;
6012 if ($v[0] eq 'VAL') {
6013         @v = split(/,/, $_[0], -1);
6014         $rv = &un_urlize($v[1]);
6015         }
6016 elsif ($v[0] eq 'SCALAR') {
6017         local $r = &un_urlize($v[1]);
6018         $rv = \$r;
6019         }
6020 elsif ($v[0] eq 'ARRAY') {
6021         $rv = [ ];
6022         for(my $i=1; $i<@v; $i++) {
6023                 push(@$rv, &unserialise_variable(&un_urlize($v[$i])));
6024                 }
6025         }
6026 elsif ($v[0] eq 'HASH') {
6027         $rv = { };
6028         for(my $i=1; $i<@v; $i+=2) {
6029                 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6030                         &unserialise_variable(&un_urlize($v[$i+1]));
6031                 }
6032         }
6033 elsif ($v[0] eq 'REF') {
6034         local $r = &unserialise_variable($v[1]);
6035         $rv = \$r;
6036         }
6037 elsif ($v[0] eq 'UNDEF') {
6038         $rv = undef;
6039         }
6040 elsif ($v[0] =~ /^OBJECT\s+(.*)$/) {
6041         # An object hash that we have to re-bless
6042         my $cls = $1;
6043         $rv = { };
6044         for(my $i=1; $i<@v; $i+=2) {
6045                 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6046                         &unserialise_variable(&un_urlize($v[$i+1]));
6047                 }
6048         eval "use $cls";
6049         bless $rv, $cls;
6050         }
6051 return $rv;
6052 }
6053
6054 =head2 other_groups(user)
6055
6056 Returns a list of secondary groups a user is a member of, as a list of
6057 group names.
6058
6059 =cut
6060 sub other_groups
6061 {
6062 my ($user) = @_;
6063 my @rv;
6064 setgrent();
6065 while(my @g = getgrent()) {
6066         my @m = split(/\s+/, $g[3]);
6067         push(@rv, $g[2]) if (&indexof($user, @m) >= 0);
6068         }
6069 endgrent() if ($gconfig{'os_type'} ne 'hpux');
6070 return @rv;
6071 }
6072
6073 =head2 date_chooser_button(dayfield, monthfield, yearfield)
6074
6075 Returns HTML for a button that pops up a data chooser window. The parameters
6076 are :
6077
6078 =item dayfield - Name of the text field to place the day of the month into.
6079
6080 =item monthfield - Name of the select field to select the month of the year in, indexed from 1.
6081
6082 =item yearfield - Name of the text field to place the year into.
6083
6084 =cut
6085 sub date_chooser_button
6086 {
6087 return &theme_date_chooser_button(@_)
6088         if (defined(&theme_date_chooser_button));
6089 my ($w, $h) = (250, 225);
6090 if ($gconfig{'db_sizedate'}) {
6091         ($w, $h) = split(/x/, $gconfig{'db_sizedate'});
6092         }
6093 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";
6094 }
6095
6096 =head2 help_file(module, file)
6097
6098 Returns the path to a module's help file of some name, typically under the
6099 help directory with a .html extension.
6100
6101 =cut
6102 sub help_file
6103 {
6104 my $mdir = &module_root_directory($_[0]);
6105 my $dir = "$mdir/help";
6106 foreach my $o (@lang_order_list) {
6107         my $lang = "$dir/$_[1].$o.html";
6108         return $lang if (-r $lang);
6109         }
6110 return "$dir/$_[1].html";
6111 }
6112
6113 =head2 seed_random
6114
6115 Seeds the random number generator, if not already done in this script. On Linux
6116 this makes use of the current time, process ID and a read from /dev/urandom.
6117 On other systems, only the current time and process ID are used.
6118
6119 =cut
6120 sub seed_random
6121 {
6122 if (!$main::done_seed_random) {
6123         if (open(RANDOM, "/dev/urandom")) {
6124                 my $buf;
6125                 read(RANDOM, $buf, 4);
6126                 close(RANDOM);
6127                 srand(time() ^ $$ ^ $buf);
6128                 }
6129         else {
6130                 srand(time() ^ $$);
6131                 }
6132         $main::done_seed_random = 1;
6133         }
6134 }
6135
6136 =head2 disk_usage_kb(directory)
6137
6138 Returns the number of kB used by some directory and all subdirs. Implemented
6139 by calling the C<du -k> command.
6140
6141 =cut
6142 sub disk_usage_kb
6143 {
6144 my $dir = &translate_filename($_[0]);
6145 my $out;
6146 my $ex = &execute_command("du -sk ".quotemeta($dir), undef, \$out, undef, 0, 1);
6147 if ($ex) {
6148         &execute_command("du -s ".quotemeta($dir), undef, \$out, undef, 0, 1);
6149         }
6150 return $out =~ /^([0-9]+)/ ? $1 : "???";
6151 }
6152
6153 =head2 recursive_disk_usage(directory, [skip-regexp], [only-regexp])
6154
6155 Returns the number of bytes taken up by all files in some directory and all
6156 sub-directories, by summing up their lengths. The disk_usage_kb is more
6157 reflective of reality, as the filesystem typically pads file sizes to 1k or
6158 4k blocks.
6159
6160 =cut
6161 sub recursive_disk_usage
6162 {
6163 my $dir = &translate_filename($_[0]);
6164 my $skip = $_[1];
6165 my $only = $_[2];
6166 if (-l $dir) {
6167         return 0;
6168         }
6169 elsif (!-d $dir) {
6170         my @st = stat($dir);
6171         return $st[7];
6172         }
6173 else {
6174         my $rv = 0;
6175         opendir(DIR, $dir);
6176         my @files = readdir(DIR);
6177         closedir(DIR);
6178         foreach my $f (@files) {
6179                 next if ($f eq "." || $f eq "..");
6180                 next if ($skip && $f =~ /$skip/);
6181                 next if ($only && $f !~ /$only/);
6182                 $rv += &recursive_disk_usage("$dir/$f", $skip, $only);
6183                 }
6184         return $rv;
6185         }
6186 }
6187
6188 =head2 help_search_link(term, [ section, ... ] )
6189
6190 Returns HTML for a link to the man module for searching local and online
6191 docs for various search terms. The term parameter can either be a single
6192 word like 'bind', or a space-separated list of words. This function is typically
6193 used by modules that want to refer users to additional documentation in man
6194 pages or local system doc files.
6195
6196 =cut
6197 sub help_search_link
6198 {
6199 if (&foreign_available("man") && !$tconfig{'nosearch'}) {
6200         my $for = &urlize(shift(@_));
6201         return "<a href='$gconfig{'webprefix'}/man/search.cgi?".
6202                join("&", map { "section=$_" } @_)."&".
6203                "for=$for&exact=1&check=".&get_module_name()."'>".
6204                $text{'helpsearch'}."</a>\n";
6205         }
6206 else {
6207         return "";
6208         }
6209 }
6210
6211 =head2 make_http_connection(host, port, ssl, method, page, [&headers])
6212
6213 Opens a connection to some HTTP server, maybe through a proxy, and returns
6214 a handle object. The handle can then be used to send additional headers
6215 and read back a response. If anything goes wrong, returns an error string.
6216 The parameters are :
6217
6218 =item host - Hostname or IP address of the webserver to connect to.
6219
6220 =item port - HTTP port number to connect to.
6221
6222 =item ssl - Set to 1 to connect in SSL mode.
6223
6224 =item method - HTTP method, like GET or POST.
6225
6226 =item page - Page to request on the webserver, like /foo/index.html
6227
6228 =item headers - Array ref of additional HTTP headers, each of which is a 2-element array ref.
6229
6230 =cut
6231 sub make_http_connection
6232 {
6233 my ($host, $port, $ssl, $method, $page, $headers) = @_;
6234 my $htxt;
6235 if ($headers) {
6236         foreach my $h (@$headers) {
6237                 $htxt .= $h->[0].": ".$h->[1]."\r\n";
6238                 }
6239         $htxt .= "\r\n";
6240         }
6241 if (&is_readonly_mode()) {
6242         return "HTTP connections not allowed in readonly mode";
6243         }
6244 my $rv = { 'fh' => time().$$ };
6245 if ($ssl) {
6246         # Connect using SSL
6247         eval "use Net::SSLeay";
6248         $@ && return $text{'link_essl'};
6249         eval "Net::SSLeay::SSLeay_add_ssl_algorithms()";
6250         eval "Net::SSLeay::load_error_strings()";
6251         $rv->{'ssl_ctx'} = Net::SSLeay::CTX_new() ||
6252                 return "Failed to create SSL context";
6253         $rv->{'ssl_con'} = Net::SSLeay::new($rv->{'ssl_ctx'}) ||
6254                 return "Failed to create SSL connection";
6255         my $connected;
6256         if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6257             !&no_proxy($host)) {
6258                 # Via proxy
6259                 my $error;
6260                 &open_socket($1, $2, $rv->{'fh'}, \$error);
6261                 if (!$error) {
6262                         # Connected OK
6263                         my $fh = $rv->{'fh'};
6264                         print $fh "CONNECT $host:$port HTTP/1.0\r\n";
6265                         if ($gconfig{'proxy_user'}) {
6266                                 my $auth = &encode_base64(
6267                                    "$gconfig{'proxy_user'}:".
6268                                    "$gconfig{'proxy_pass'}");
6269                                 $auth =~ tr/\r\n//d;
6270                                 print $fh "Proxy-Authorization: Basic $auth\r\n";
6271                                 }
6272                         print $fh "\r\n";
6273                         my $line = <$fh>;
6274                         if ($line =~ /^HTTP(\S+)\s+(\d+)\s+(.*)/) {
6275                                 return "Proxy error : $3" if ($2 != 200);
6276                                 }
6277                         else {
6278                                 return "Proxy error : $line";
6279                                 }
6280                         $line = <$fh>;
6281                         $connected = 1;
6282                         }
6283                 elsif (!$gconfig{'proxy_fallback'}) {
6284                         # Connection to proxy failed - give up
6285                         return $error;
6286                         }
6287                 }
6288         if (!$connected) {
6289                 # Direct connection
6290                 my $error;
6291                 &open_socket($host, $port, $rv->{'fh'}, \$error);
6292                 return $error if ($error);
6293                 }
6294         Net::SSLeay::set_fd($rv->{'ssl_con'}, fileno($rv->{'fh'}));
6295         Net::SSLeay::connect($rv->{'ssl_con'}) ||
6296                 return "SSL connect() failed";
6297         my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6298         Net::SSLeay::write($rv->{'ssl_con'}, $rtxt);
6299         }
6300 else {
6301         # Plain HTTP request
6302         my $connected;
6303         if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6304             !&no_proxy($host)) {
6305                 # Via a proxy
6306                 my $error;
6307                 &open_socket($1, $2, $rv->{'fh'}, \$error);
6308                 if (!$error) {
6309                         # Connected OK
6310                         $connected = 1;
6311                         my $fh = $rv->{'fh'};
6312                         my $rtxt = $method." ".
6313                                    "http://$host:$port$page HTTP/1.0\r\n";
6314                         if ($gconfig{'proxy_user'}) {
6315                                 my $auth = &encode_base64(
6316                                    "$gconfig{'proxy_user'}:".
6317                                    "$gconfig{'proxy_pass'}");
6318                                 $auth =~ tr/\r\n//d;
6319                                 $rtxt .= "Proxy-Authorization: Basic $auth\r\n";
6320                                 }
6321                         $rtxt .= $htxt;
6322                         print $fh $rtxt;
6323                         }
6324                 elsif (!$gconfig{'proxy_fallback'}) {
6325                         return $error;
6326                         }
6327                 }
6328         if (!$connected) {
6329                 # Connecting directly
6330                 my $error;
6331                 &open_socket($host, $port, $rv->{'fh'}, \$error);
6332                 return $error if ($error);
6333                 my $fh = $rv->{'fh'};
6334                 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6335                 print $fh $rtxt;
6336                 }
6337         }
6338 return $rv;
6339 }
6340
6341 =head2 read_http_connection(&handle, [bytes])
6342
6343 Reads either one line or up to the specified number of bytes from the handle,
6344 originally supplied by make_http_connection.
6345
6346 =cut
6347 sub read_http_connection
6348 {
6349 my ($h) = @_;
6350 my $rv;
6351 if ($h->{'ssl_con'}) {
6352         if (!$_[1]) {
6353                 my ($idx, $more);
6354                 while(($idx = index($h->{'buffer'}, "\n")) < 0) {
6355                         # need to read more..
6356                         if (!($more = Net::SSLeay::read($h->{'ssl_con'}))) {
6357                                 # end of the data
6358                                 $rv = $h->{'buffer'};
6359                                 delete($h->{'buffer'});
6360                                 return $rv;
6361                                 }
6362                         $h->{'buffer'} .= $more;
6363                         }
6364                 $rv = substr($h->{'buffer'}, 0, $idx+1);
6365                 $h->{'buffer'} = substr($h->{'buffer'}, $idx+1);
6366                 }
6367         else {
6368                 if (length($h->{'buffer'})) {
6369                         $rv = $h->{'buffer'};
6370                         delete($h->{'buffer'});
6371                         }
6372                 else {
6373                         $rv = Net::SSLeay::read($h->{'ssl_con'}, $_[1]);
6374                         }
6375                 }
6376         }
6377 else {
6378         if ($_[1]) {
6379                 read($h->{'fh'}, $rv, $_[1]) > 0 || return undef;
6380                 }
6381         else {
6382                 my $fh = $h->{'fh'};
6383                 $rv = <$fh>;
6384                 }
6385         }
6386 $rv = undef if ($rv eq "");
6387 return $rv;
6388 }
6389
6390 =head2 write_http_connection(&handle, [data+])
6391
6392 Writes the given data to the given HTTP connection handle.
6393
6394 =cut
6395 sub write_http_connection
6396 {
6397 my $h = shift(@_);
6398 my $fh = $h->{'fh'};
6399 my $allok = 1;
6400 if ($h->{'ssl_ctx'}) {
6401         foreach my $s (@_) {
6402                 my $ok = Net::SSLeay::write($h->{'ssl_con'}, $s);
6403                 $allok = 0 if (!$ok);
6404                 }
6405         }
6406 else {
6407         my $ok = (print $fh @_);
6408         $allok = 0 if (!$ok);
6409         }
6410 return $allok;
6411 }
6412
6413 =head2 close_http_connection(&handle)
6414
6415 Closes a connection to an HTTP server, identified by the given handle.
6416
6417 =cut
6418 sub close_http_connection
6419 {
6420 my ($h) = @_;
6421 close($h->{'fh'});
6422 }
6423
6424 =head2 clean_environment
6425
6426 Deletes any environment variables inherited from miniserv so that they
6427 won't be passed to programs started by webmin. This is useful when calling
6428 programs that check for CGI-related environment variables and modify their
6429 behaviour, and to avoid passing sensitive variables to un-trusted programs.
6430
6431 =cut
6432 sub clean_environment
6433 {
6434 %UNCLEAN_ENV = %ENV;
6435 foreach my $k (keys %ENV) {
6436         if ($k =~ /^(HTTP|VIRTUALSERVER|QUOTA|USERADMIN)_/) {
6437                 delete($ENV{$k});
6438                 }
6439         }
6440 foreach my $e ('WEBMIN_CONFIG', 'SERVER_NAME', 'CONTENT_TYPE', 'REQUEST_URI',
6441             'PATH_INFO', 'WEBMIN_VAR', 'REQUEST_METHOD', 'GATEWAY_INTERFACE',
6442             'QUERY_STRING', 'REMOTE_USER', 'SERVER_SOFTWARE', 'SERVER_PROTOCOL',
6443             'REMOTE_HOST', 'SERVER_PORT', 'DOCUMENT_ROOT', 'SERVER_ROOT',
6444             'MINISERV_CONFIG', 'SCRIPT_NAME', 'SERVER_ADMIN', 'CONTENT_LENGTH',
6445             'HTTPS', 'FOREIGN_MODULE_NAME', 'FOREIGN_ROOT_DIRECTORY',
6446             'SCRIPT_FILENAME', 'PATH_TRANSLATED', 'BASE_REMOTE_USER',
6447             'DOCUMENT_REALROOT', 'MINISERV_CONFIG', 'MYSQL_PWD',
6448             'MINISERV_PID') {
6449         delete($ENV{$e});
6450         }
6451 }
6452
6453 =head2 reset_environment
6454
6455 Puts the environment back how it was before clean_environment was callled.
6456
6457 =cut
6458 sub reset_environment
6459 {
6460 if (%UNCLEAN_ENV) {
6461         foreach my $k (keys %UNCLEAN_ENV) {
6462                 $ENV{$k} = $UNCLEAN_ENV{$k};
6463                 }
6464         undef(%UNCLEAN_ENV);
6465         }
6466 }
6467
6468 =head2 progress_callback
6469
6470 Never called directly, but useful for passing to &http_download to print
6471 out progress of an HTTP request.
6472
6473 =cut
6474 sub progress_callback
6475 {
6476 if (defined(&theme_progress_callback)) {
6477         # Call the theme override
6478         return &theme_progress_callback(@_);
6479         }
6480 if ($_[0] == 2) {
6481         # Got size
6482         print $progress_callback_prefix;
6483         if ($_[1]) {
6484                 $progress_size = $_[1];
6485                 $progress_step = int($_[1] / 10);
6486                 print &text('progress_size2', $progress_callback_url,
6487                             &nice_size($progress_size)),"<br>\n";
6488                 }
6489         else {
6490                 print &text('progress_nosize', $progress_callback_url),"<br>\n";
6491                 }
6492         $last_progress_time = $last_progress_size = undef;
6493         }
6494 elsif ($_[0] == 3) {
6495         # Got data update
6496         my $sp = $progress_callback_prefix.("&nbsp;" x 5);
6497         if ($progress_size) {
6498                 # And we have a size to compare against
6499                 my $st = int(($_[1] * 10) / $progress_size);
6500                 my $time_now = time();
6501                 if ($st != $progress_step ||
6502                     $time_now - $last_progress_time > 60) {
6503                         # Show progress every 10% or 60 seconds
6504                         print $sp,&text('progress_datan', &nice_size($_[1]),
6505                                         int($_[1]*100/$progress_size)),"<br>\n";
6506                         $last_progress_time = $time_now;
6507                         }
6508                 $progress_step = $st;
6509                 }
6510         else {
6511                 # No total size .. so only show in 100k jumps
6512                 if ($_[1] > $last_progress_size+100*1024) {
6513                         print $sp,&text('progress_data2n',
6514                                         &nice_size($_[1])),"<br>\n";
6515                         $last_progress_size = $_[1];
6516                         }
6517                 }
6518         }
6519 elsif ($_[0] == 4) {
6520         # All done downloading
6521         print $progress_callback_prefix,&text('progress_done'),"<br>\n";
6522         }
6523 elsif ($_[0] == 5) {
6524         # Got new location after redirect
6525         $progress_callback_url = $_[1];
6526         }
6527 elsif ($_[0] == 6) {
6528         # URL is in cache
6529         $progress_callback_url = $_[1];
6530         print &text('progress_incache', $progress_callback_url),"<br>\n";
6531         }
6532 }
6533
6534 =head2 switch_to_remote_user
6535
6536 Changes the user and group of the current process to that of the unix user
6537 with the same name as the current webmin login, or fails if there is none.
6538 This should be called by Usermin module scripts that only need to run with
6539 limited permissions.
6540
6541 =cut
6542 sub switch_to_remote_user
6543 {
6544 @remote_user_info = $remote_user ? getpwnam($remote_user) :
6545                                    getpwuid($<);
6546 @remote_user_info || &error(&text('switch_remote_euser', $remote_user));
6547 &create_missing_homedir(\@remote_user_info);
6548 if ($< == 0) {
6549         &switch_to_unix_user(\@remote_user_info);
6550         $ENV{'USER'} = $ENV{'LOGNAME'} = $remote_user;
6551         $ENV{'HOME'} = $remote_user_info[7];
6552         }
6553 # Export global variables to caller
6554 if ($main::export_to_caller) {
6555         my ($callpkg) = caller();
6556         eval "\@${callpkg}::remote_user_info = \@remote_user_info";
6557         }
6558 }
6559
6560 =head2 switch_to_unix_user(&user-details)
6561
6562 Switches the current process to the UID and group ID from the given list
6563 of user details, which must be in the format returned by getpwnam.
6564
6565 =cut
6566 sub switch_to_unix_user
6567 {
6568 my ($uinfo) = @_;
6569 if (!defined($uinfo->[0])) {
6570         # No username given, so just use given GID
6571         ($(, $)) = ( $uinfo->[3], "$uinfo->[3] $uinfo->[3]" );
6572         }
6573 else {
6574         # Use all groups from user
6575         ($(, $)) = ( $uinfo->[3],
6576                      "$uinfo->[3] ".join(" ", $uinfo->[3],
6577                                          &other_groups($uinfo->[0])) );
6578         }
6579 eval {
6580         POSIX::setuid($uinfo->[2]);
6581         };
6582 if ($< != $uinfo->[2] || $> != $uinfo->[2]) {
6583         ($>, $<) = ( $uinfo->[2], $uinfo->[2] );
6584         }
6585 }
6586
6587 =head2 eval_as_unix_user(username, &code)
6588
6589 Runs some code fragment with the effective UID and GID switch to that
6590 of the given Unix user, so that file IO takes place with his permissions.
6591
6592 =cut
6593
6594 sub eval_as_unix_user
6595 {
6596 my ($user, $code) = @_;
6597 my @uinfo = getpwnam($user);
6598 if (!scalar(@uinfo)) {
6599         &error("eval_as_unix_user called with invalid user $user");
6600         }
6601 $) = $uinfo[3]." ".join(" ", $uinfo[3], &other_groups($user));
6602 $> = $uinfo[2];
6603 my @rv;
6604 eval {
6605         local $main::error_must_die = 1;
6606         @rv = &$code();
6607         };
6608 my $err = $@;
6609 $) = 0;
6610 $> = 0;
6611 if ($err) {
6612         $err =~ s/\s+at\s+(\/\S+)\s+line\s+(\d+)\.?//;
6613         &error($err);
6614         }
6615 return wantarray ? @rv : $rv[0];
6616 }
6617
6618 =head2 create_user_config_dirs
6619
6620 Creates per-user config directories and sets $user_config_directory and
6621 $user_module_config_directory to them. Also reads per-user module configs
6622 into %userconfig. This should be called by Usermin module scripts that need
6623 to store per-user preferences or other settings.
6624
6625 =cut
6626 sub create_user_config_dirs
6627 {
6628 return if (!$gconfig{'userconfig'});
6629 my @uinfo = @remote_user_info ? @remote_user_info : getpwnam($remote_user);
6630 return if (!@uinfo || !$uinfo[7]);
6631 &create_missing_homedir(\@uinfo);
6632 $user_config_directory = "$uinfo[7]/$gconfig{'userconfig'}";
6633 if (!-d $user_config_directory) {
6634         mkdir($user_config_directory, 0700) ||
6635                 &error("Failed to create $user_config_directory : $!");
6636         if ($< == 0 && $uinfo[2]) {
6637                 chown($uinfo[2], $uinfo[3], $user_config_directory);
6638                 }
6639         }
6640 if (&get_module_name()) {
6641         $user_module_config_directory = $user_config_directory."/".
6642                                         &get_module_name();
6643         if (!-d $user_module_config_directory) {
6644                 mkdir($user_module_config_directory, 0700) ||
6645                         &error("Failed to create $user_module_config_directory : $!");
6646                 if ($< == 0 && $uinfo[2]) {
6647                         chown($uinfo[2], $uinfo[3], $user_config_directory);
6648                         }
6649                 }
6650         undef(%userconfig);
6651         &read_file_cached("$module_root_directory/defaultuconfig",
6652                           \%userconfig);
6653         &read_file_cached("$module_config_directory/uconfig", \%userconfig);
6654         &read_file_cached("$user_module_config_directory/config",
6655                           \%userconfig);
6656         }
6657
6658 # Export global variables to caller
6659 if ($main::export_to_caller) {
6660         my ($callpkg) = caller();
6661         foreach my $v ('$user_config_directory',
6662                        '$user_module_config_directory', '%userconfig') {
6663                 my ($vt, $vn) = split('', $v, 2);
6664                 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
6665                 }
6666         }
6667 }
6668
6669 =head2 create_missing_homedir(&uinfo)
6670
6671 If auto homedir creation is enabled, create one for this user if needed.
6672 For internal use only.
6673
6674 =cut
6675 sub create_missing_homedir
6676 {
6677 my ($uinfo) = @_;
6678 if (!-e $uinfo->[7] && $gconfig{'create_homedir'}) {
6679         # Use has no home dir .. make one
6680         system("mkdir -p ".quotemeta($uinfo->[7]));
6681         chown($uinfo->[2], $uinfo->[3], $uinfo->[7]);
6682         if ($gconfig{'create_homedir_perms'} ne '') {
6683                 chmod(oct($gconfig{'create_homedir_perms'}), $uinfo->[7]);
6684                 }
6685         }
6686 }
6687
6688 =head2 filter_javascript(text)
6689
6690 Disables all javascript <script>, onClick= and so on tags in the given HTML,
6691 and returns the new HTML. Useful for displaying HTML from an un-trusted source.
6692
6693 =cut
6694 sub filter_javascript
6695 {
6696 my ($rv) = @_;
6697 $rv =~ s/<\s*script[^>]*>([\000-\377]*?)<\s*\/script\s*>//gi;
6698 $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;
6699 $rv =~ s/(javascript:)/x$1/gi;
6700 $rv =~ s/(vbscript:)/x$1/gi;
6701 return $rv;
6702 }
6703
6704 =head2 resolve_links(path)
6705
6706 Given a path that may contain symbolic links, returns the real path.
6707
6708 =cut
6709 sub resolve_links
6710 {
6711 my ($path) = @_;
6712 $path =~ s/\/+/\//g;
6713 $path =~ s/\/$// if ($path ne "/");
6714 my @p = split(/\/+/, $path);
6715 shift(@p);
6716 for(my $i=0; $i<@p; $i++) {
6717         my $sofar = "/".join("/", @p[0..$i]);
6718         my $lnk = readlink($sofar);
6719         if ($lnk eq $sofar) {
6720                 # Link to itself! Cannot do anything more really ..
6721                 last;
6722                 }
6723         elsif ($lnk =~ /^\//) {
6724                 # Link is absolute..
6725                 return &resolve_links($lnk."/".join("/", @p[$i+1 .. $#p]));
6726                 }
6727         elsif ($lnk) {
6728                 # Link is relative
6729                 return &resolve_links("/".join("/", @p[0..$i-1])."/".$lnk."/".join("/", @p[$i+1 .. $#p]));
6730                 }
6731         }
6732 return $path;
6733 }
6734
6735 =head2 simplify_path(path, bogus)
6736
6737 Given a path, maybe containing elements ".." and "." , convert it to a
6738 clean, absolute form. Returns undef if this is not possible.
6739
6740 =cut
6741 sub simplify_path
6742 {
6743 my ($dir) = @_;
6744 $dir =~ s/^\/+//g;
6745 $dir =~ s/\/+$//g;
6746 my @bits = split(/\/+/, $dir);
6747 my @fixedbits = ();
6748 $_[1] = 0;
6749 foreach my $b (@bits) {
6750         if ($b eq ".") {
6751                 # Do nothing..
6752                 }
6753         elsif ($b eq "..") {
6754                 # Remove last dir
6755                 if (scalar(@fixedbits) == 0) {
6756                         # Cannot! Already at root!
6757                         return undef;
6758                         }
6759                 pop(@fixedbits);
6760                 }
6761         else {
6762                 # Add dir to list
6763                 push(@fixedbits, $b);
6764                 }
6765         }
6766 return "/".join('/', @fixedbits);
6767 }
6768
6769 =head2 same_file(file1, file2)
6770
6771 Returns 1 if two files are actually the same
6772
6773 =cut
6774 sub same_file
6775 {
6776 return 1 if ($_[0] eq $_[1]);
6777 return 0 if ($_[0] !~ /^\// || $_[1] !~ /^\//);
6778 my @stat1 = $stat_cache{$_[0]} ? @{$stat_cache{$_[0]}}
6779                                : (@{$stat_cache{$_[0]}} = stat($_[0]));
6780 my @stat2 = $stat_cache{$_[1]} ? @{$stat_cache{$_[1]}}
6781                                : (@{$stat_cache{$_[1]}} = stat($_[1]));
6782 return 0 if (!@stat1 || !@stat2);
6783 return $stat1[0] == $stat2[0] && $stat1[1] == $stat2[1];
6784 }
6785
6786 =head2 flush_webmin_caches
6787
6788 Clears all in-memory and on-disk caches used by Webmin.
6789
6790 =cut
6791 sub flush_webmin_caches
6792 {
6793 undef(%main::read_file_cache);
6794 undef(%main::acl_hash_cache);
6795 undef(%main::acl_array_cache);
6796 undef(%main::has_command_cache);
6797 undef(@main::list_languages_cache);
6798 undef($main::got_list_usermods_cache);
6799 undef(@main::list_usermods_cache);
6800 undef(%main::foreign_installed_cache);
6801 unlink("$config_directory/module.infos.cache");
6802 &get_all_module_infos();
6803 }
6804
6805 =head2 list_usermods
6806
6807 Returns a list of additional module restrictions. For internal use in
6808 Usermin only.
6809
6810 =cut
6811 sub list_usermods
6812 {
6813 if (!$main::got_list_usermods_cache) {
6814         @main::list_usermods_cache = ( );
6815         local $_;
6816         open(USERMODS, "$config_directory/usermin.mods");
6817         while(<USERMODS>) {
6818                 if (/^([^:]+):(\+|-|):(.*)/) {
6819                         push(@main::list_usermods_cache,
6820                              [ $1, $2, [ split(/\s+/, $3) ] ]);
6821                         }
6822                 }
6823         close(USERMODS);
6824         $main::got_list_usermods_cache = 1;
6825         }
6826 return @main::list_usermods_cache;
6827 }
6828
6829 =head2 available_usermods(&allmods, &usermods)
6830
6831 Returns a list of modules that are available to the given user, based
6832 on usermod additional/subtractions. For internal use by Usermin only.
6833
6834 =cut
6835 sub available_usermods
6836 {
6837 return @{$_[0]} if (!@{$_[1]});
6838
6839 my %mods = map { $_->{'dir'}, 1 } @{$_[0]};
6840 my @uinfo = @remote_user_info;
6841 @uinfo = getpwnam($remote_user) if (!@uinfo);
6842 foreach my $u (@{$_[1]}) {
6843         my $applies;
6844         if ($u->[0] eq "*" || $u->[0] eq $remote_user) {
6845                 $applies++;
6846                 }
6847         elsif ($u->[0] =~ /^\@(.*)$/) {
6848                 # Check for group membership
6849                 my @ginfo = getgrnam($1);
6850                 $applies++ if (@ginfo && ($ginfo[2] == $uinfo[3] ||
6851                         &indexof($remote_user, split(/\s+/, $ginfo[3])) >= 0));
6852                 }
6853         elsif ($u->[0] =~ /^\//) {
6854                 # Check users and groups in file
6855                 local $_;
6856                 open(USERFILE, $u->[0]);
6857                 while(<USERFILE>) {
6858                         tr/\r\n//d;
6859                         if ($_ eq $remote_user) {
6860                                 $applies++;
6861                                 }
6862                         elsif (/^\@(.*)$/) {
6863                                 my @ginfo = getgrnam($1);
6864                                 $applies++
6865                                   if (@ginfo && ($ginfo[2] == $uinfo[3] ||
6866                                       &indexof($remote_user,
6867                                                split(/\s+/, $ginfo[3])) >= 0));
6868                                 }
6869                         last if ($applies);
6870                         }
6871                 close(USERFILE);
6872                 }
6873         if ($applies) {
6874                 if ($u->[1] eq "+") {
6875                         map { $mods{$_}++ } @{$u->[2]};
6876                         }
6877                 elsif ($u->[1] eq "-") {
6878                         map { delete($mods{$_}) } @{$u->[2]};
6879                         }
6880                 else {
6881                         undef(%mods);
6882                         map { $mods{$_}++ } @{$u->[2]};
6883                         }
6884                 }
6885         }
6886 return grep { $mods{$_->{'dir'}} } @{$_[0]};
6887 }
6888
6889 =head2 get_available_module_infos(nocache)
6890
6891 Returns a list of modules available to the current user, based on
6892 operating system support, access control and usermod restrictions. Useful
6893 in themes that need to display a list of modules the user can use.
6894 Each element of the returned array is a hash reference in the same format as
6895 returned by get_module_info.
6896
6897 =cut
6898 sub get_available_module_infos
6899 {
6900 my (%acl, %uacl);
6901 &read_acl(\%acl, \%uacl);
6902 my $risk = $gconfig{'risk_'.$base_remote_user};
6903 my @rv;
6904 foreach my $minfo (&get_all_module_infos($_[0])) {
6905         next if (!&check_os_support($minfo));
6906         if ($risk) {
6907                 # Check module risk level
6908                 next if ($risk ne 'high' && $minfo->{'risk'} &&
6909                          $minfo->{'risk'} !~ /$risk/);
6910                 }
6911         else {
6912                 # Check user's ACL
6913                 next if (!$acl{$base_remote_user,$minfo->{'dir'}} &&
6914                          !$acl{$base_remote_user,"*"});
6915                 }
6916         next if (&is_readonly_mode() && !$minfo->{'readonly'});
6917         push(@rv, $minfo);
6918         }
6919
6920 # Check usermod restrictions
6921 my @usermods = &list_usermods();
6922 @rv = sort { $a->{'desc'} cmp $b->{'desc'} }
6923             &available_usermods(\@rv, \@usermods);
6924
6925 # Check RBAC restrictions
6926 my @rbacrv;
6927 foreach my $m (@rv) {
6928         if (&supports_rbac($m->{'dir'}) &&
6929             &use_rbac_module_acl(undef, $m->{'dir'})) {
6930                 local $rbacs = &get_rbac_module_acl($remote_user,
6931                                                     $m->{'dir'});
6932                 if ($rbacs) {
6933                         # RBAC allows
6934                         push(@rbacrv, $m);
6935                         }
6936                 }
6937         else {
6938                 # Module or system doesn't support RBAC
6939                 push(@rbacrv, $m) if (!$gconfig{'rbacdeny_'.$base_remote_user});
6940                 }
6941         }
6942
6943 # Check theme vetos
6944 my @themerv;
6945 if (defined(&theme_foreign_available)) {
6946         foreach my $m (@rbacrv) {
6947                 if (&theme_foreign_available($m->{'dir'})) {
6948                         push(@themerv, $m);
6949                         }
6950                 }
6951         }
6952 else {
6953         @themerv = @rbacrv;
6954         }
6955
6956 # Check licence module vetos
6957 my @licrv;
6958 if ($main::licence_module) {
6959         foreach my $m (@themerv) {
6960                 if (&foreign_call($main::licence_module,
6961                                   "check_module_licence", $m->{'dir'})) {
6962                         push(@licrv, $m);
6963                         }
6964                 }
6965         }
6966 else {
6967         @licrv = @themerv;
6968         }
6969
6970 return @licrv;
6971 }
6972
6973 =head2 get_visible_module_infos(nocache)
6974
6975 Like get_available_module_infos, but excludes hidden modules from the list.
6976 Each element of the returned array is a hash reference in the same format as
6977 returned by get_module_info.
6978
6979 =cut
6980 sub get_visible_module_infos
6981 {
6982 my ($nocache) = @_;
6983 my $pn = &get_product_name();
6984 return grep { !$_->{'hidden'} &&
6985               !$_->{$pn.'_hidden'} } &get_available_module_infos($nocache);
6986 }
6987
6988 =head2 get_visible_modules_categories(nocache)
6989
6990 Returns a list of Webmin module categories, each of which is a hash ref
6991 with 'code', 'desc' and 'modules' keys. The modules value is an array ref
6992 of modules in the category, in the format returned by get_module_info.
6993 Un-used modules are automatically assigned to the 'unused' category, and
6994 those with no category are put into 'others'.
6995
6996 =cut
6997 sub get_visible_modules_categories
6998 {
6999 my ($nocache) = @_;
7000 my @mods = &get_visible_module_infos($nocache);
7001 my @unmods;
7002 if (&get_product_name() eq 'webmin') {
7003         @unmods = grep { $_->{'installed'} eq '0' } @mods;
7004         @mods = grep { $_->{'installed'} ne '0' } @mods;
7005         }
7006 my %cats = &list_categories(\@mods);
7007 my @rv;
7008 foreach my $c (keys %cats) {
7009         my $cat = { 'code' => $c || 'other',
7010                     'desc' => $cats{$c} };
7011         $cat->{'modules'} = [ grep { $_->{'category'} eq $c } @mods ];
7012         push(@rv, $cat);
7013         }
7014 @rv = sort { ($b->{'code'} eq "others" ? "" : $b->{'code'}) cmp
7015              ($a->{'code'} eq "others" ? "" : $a->{'code'}) } @rv;
7016 if (@unmods) {
7017         # Add un-installed modules in magic category
7018         my $cat = { 'code' => 'unused',
7019                     'desc' => $text{'main_unused'},
7020                     'unused' => 1,
7021                     'modules' => \@unmods };
7022         push(@rv, $cat);
7023         }
7024 return @rv;
7025 }
7026
7027 =head2 is_under_directory(directory, file)
7028
7029 Returns 1 if the given file is under the specified directory, 0 if not.
7030 Symlinks are taken into account in the file to find it's 'real' location.
7031
7032 =cut
7033 sub is_under_directory
7034 {
7035 my ($dir, $file) = @_;
7036 return 1 if ($dir eq "/");
7037 return 0 if ($file =~ /\.\./);
7038 my $ld = &resolve_links($dir);
7039 if ($ld ne $dir) {
7040         return &is_under_directory($ld, $file);
7041         }
7042 my $lp = &resolve_links($file);
7043 if ($lp ne $file) {
7044         return &is_under_directory($dir, $lp);
7045         }
7046 return 0 if (length($file) < length($dir));
7047 return 1 if ($dir eq $file);
7048 $dir =~ s/\/*$/\//;
7049 return substr($file, 0, length($dir)) eq $dir;
7050 }
7051
7052 =head2 parse_http_url(url, [basehost, baseport, basepage, basessl])
7053
7054 Given an absolute URL, returns the host, port, page and ssl flag components.
7055 Relative URLs can also be parsed, if the base information is provided.
7056
7057 =cut
7058 sub parse_http_url
7059 {
7060 if ($_[0] =~ /^(http|https):\/\/([^:\/]+)(:(\d+))?(\/\S*)?$/) {
7061         # An absolute URL
7062         my $ssl = $1 eq 'https';
7063         return ($2, $3 ? $4 : $ssl ? 443 : 80, $5 || "/", $ssl);
7064         }
7065 elsif (!$_[1]) {
7066         # Could not parse
7067         return undef;
7068         }
7069 elsif ($_[0] =~ /^\/\S*$/) {
7070         # A relative to the server URL
7071         return ($_[1], $_[2], $_[0], $_[4]);
7072         }
7073 else {
7074         # A relative to the directory URL
7075         my $page = $_[3];
7076         $page =~ s/[^\/]+$//;
7077         return ($_[1], $_[2], $page.$_[0], $_[4]);
7078         }
7079 }
7080
7081 =head2 check_clicks_function
7082
7083 Returns HTML for a JavaScript function called check_clicks that returns
7084 true when first called, but false subsequently. Useful on onClick for
7085 critical buttons. Deprecated, as this method of preventing duplicate actions
7086 is un-reliable.
7087
7088 =cut
7089 sub check_clicks_function
7090 {
7091 return <<EOF;
7092 <script>
7093 clicks = 0;
7094 function check_clicks(form)
7095 {
7096 clicks++;
7097 if (clicks == 1)
7098         return true;
7099 else {
7100         if (form != null) {
7101                 for(i=0; i<form.length; i++)
7102                         form.elements[i].disabled = true;
7103                 }
7104         return false;
7105         }
7106 }
7107 </script>
7108 EOF
7109 }
7110
7111 =head2 load_entities_map
7112
7113 Returns a hash ref containing mappings between HTML entities (like ouml) and
7114 ascii values (like 246). Mainly for internal use.
7115
7116 =cut
7117 sub load_entities_map
7118 {
7119 if (!%entities_map_cache) {
7120         local $_;
7121         open(EMAP, "$root_directory/entities_map.txt");
7122         while(<EMAP>) {
7123                 if (/^(\d+)\s+(\S+)/) {
7124                         $entities_map_cache{$2} = $1;
7125                         }
7126                 }
7127         close(EMAP);
7128         }
7129 return \%entities_map_cache;
7130 }
7131
7132 =head2 entities_to_ascii(string)
7133
7134 Given a string containing HTML entities like &ouml; and &#55;, replace them
7135 with their ASCII equivalents.
7136
7137 =cut
7138 sub entities_to_ascii
7139 {
7140 my ($str) = @_;
7141 my $emap = &load_entities_map();
7142 $str =~ s/&([a-z]+);/chr($emap->{$1})/ge;
7143 $str =~ s/&#(\d+);/chr($1)/ge;
7144 return $str;
7145 }
7146
7147 =head2 get_product_name
7148
7149 Returns either 'webmin' or 'usermin', depending on which program the current
7150 module is in. Useful for modules that can be installed into either.
7151
7152 =cut
7153 sub get_product_name
7154 {
7155 return $gconfig{'product'} if (defined($gconfig{'product'}));
7156 return defined($gconfig{'userconfig'}) ? 'usermin' : 'webmin';
7157 }
7158
7159 =head2 get_charset
7160
7161 Returns the character set for the current language, such as iso-8859-1.
7162
7163 =cut
7164 sub get_charset
7165 {
7166 my $charset = defined($gconfig{'charset'}) ? $gconfig{'charset'} :
7167                  $current_lang_info->{'charset'} ?
7168                  $current_lang_info->{'charset'} : $default_charset;
7169 return $charset;
7170 }
7171
7172 =head2 get_display_hostname
7173
7174 Returns the system's hostname for UI display purposes. This may be different
7175 from the actual hostname if you administrator has configured it so in the
7176 Webmin Configuration module.
7177
7178 =cut
7179 sub get_display_hostname
7180 {
7181 if ($gconfig{'hostnamemode'} == 0) {
7182         return &get_system_hostname();
7183         }
7184 elsif ($gconfig{'hostnamemode'} == 3) {
7185         return $gconfig{'hostnamedisplay'};
7186         }
7187 else {
7188         my $h = $ENV{'HTTP_HOST'};
7189         $h =~ s/:\d+//g;
7190         if ($gconfig{'hostnamemode'} == 2) {
7191                 $h =~ s/^(www|ftp|mail)\.//i;
7192                 }
7193         return $h;
7194         }
7195 }
7196
7197 =head2 save_module_config([&config], [modulename])
7198
7199 Saves the configuration for some module. The config parameter is an optional
7200 hash reference of names and values to save, which defaults to the global
7201 %config hash. The modulename parameter is the module to update the config
7202 file, which defaults to the current module.
7203
7204 =cut
7205 sub save_module_config
7206 {
7207 my $c = $_[0] || { &get_module_variable('%config') };
7208 my $m = defined($_[1]) ? $_[1] : &get_module_name();
7209 &write_file("$config_directory/$m/config", $c);
7210 }
7211
7212 =head2 save_user_module_config([&config], [modulename])
7213
7214 Saves the user's Usermin preferences for some module. The config parameter is
7215 an optional hash reference of names and values to save, which defaults to the
7216 global %userconfig hash. The modulename parameter is the module to update the
7217 config file, which defaults to the current module.
7218
7219 =cut
7220 sub save_user_module_config
7221 {
7222 my $c = $_[0] || { &get_module_variable('%userconfig') };
7223 my $m = $_[1] || &get_module_name();
7224 my $ucd = $user_config_directory;
7225 if (!$ucd) {
7226         my @uinfo = @remote_user_info ? @remote_user_info
7227                                       : getpwnam($remote_user);
7228         return if (!@uinfo || !$uinfo[7]);
7229         $ucd = "$uinfo[7]/$gconfig{'userconfig'}";
7230         }
7231 &write_file("$ucd/$m/config", $c);
7232 }
7233
7234 =head2 nice_size(bytes, [min])
7235
7236 Converts a number of bytes into a number followed by a suffix like GB, MB
7237 or kB. Rounding is to two decimal digits. The optional min parameter sets the
7238 smallest units to use - so you could pass 1024*1024 to never show bytes or kB.
7239
7240 =cut
7241 sub nice_size
7242 {
7243 my ($units, $uname);
7244 if (abs($_[0]) > 1024*1024*1024*1024 || $_[1] >= 1024*1024*1024*1024) {
7245         $units = 1024*1024*1024*1024;
7246         $uname = "TB";
7247         }
7248 elsif (abs($_[0]) > 1024*1024*1024 || $_[1] >= 1024*1024*1024) {
7249         $units = 1024*1024*1024;
7250         $uname = "GB";
7251         }
7252 elsif (abs($_[0]) > 1024*1024 || $_[1] >= 1024*1024) {
7253         $units = 1024*1024;
7254         $uname = "MB";
7255         }
7256 elsif (abs($_[0]) > 1024 || $_[1] >= 1024) {
7257         $units = 1024;
7258         $uname = "kB";
7259         }
7260 else {
7261         $units = 1;
7262         $uname = "bytes";
7263         }
7264 my $sz = sprintf("%.2f", ($_[0]*1.0 / $units));
7265 $sz =~ s/\.00$//;
7266 return $sz." ".$uname;
7267 }
7268
7269 =head2 get_perl_path
7270
7271 Returns the path to Perl currently in use, such as /usr/bin/perl.
7272
7273 =cut
7274 sub get_perl_path
7275 {
7276 if (open(PERL, "$config_directory/perl-path")) {
7277         my $rv;
7278         chop($rv = <PERL>);
7279         close(PERL);
7280         return $rv;
7281         }
7282 return $^X if (-x $^X);
7283 return &has_command("perl");
7284 }
7285
7286 =head2 get_goto_module([&mods])
7287
7288 Returns the details of a module that the current user should be re-directed
7289 to after logging in, or undef if none. Useful for themes.
7290
7291 =cut
7292 sub get_goto_module
7293 {
7294 my @mods = $_[0] ? @{$_[0]} : &get_visible_module_infos();
7295 if ($gconfig{'gotomodule'}) {
7296         my ($goto) = grep { $_->{'dir'} eq $gconfig{'gotomodule'} } @mods;
7297         return $goto if ($goto);
7298         }
7299 if (@mods == 1 && $gconfig{'gotoone'}) {
7300         return $mods[0];
7301         }
7302 return undef;
7303 }
7304
7305 =head2 select_all_link(field, form, [text])
7306
7307 Returns HTML for a 'Select all' link that uses Javascript to select
7308 multiple checkboxes with the same name. The parameters are :
7309
7310 =item field - Name of the checkbox inputs.
7311
7312 =item form - Index of the form on the page.
7313
7314 =item text - Message for the link, defaulting to 'Select all'.
7315
7316 =cut
7317 sub select_all_link
7318 {
7319 return &theme_select_all_link(@_) if (defined(&theme_select_all_link));
7320 my ($field, $form, $text) = @_;
7321 $form = int($form);
7322 $text ||= $text{'ui_selall'};
7323 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>";
7324 }
7325
7326 =head2 select_invert_link(field, form, text)
7327
7328 Returns HTML for an 'Invert selection' link that uses Javascript to invert the
7329 selection on multiple checkboxes with the same name. The parameters are :
7330
7331 =item field - Name of the checkbox inputs.
7332
7333 =item form - Index of the form on the page.
7334
7335 =item text - Message for the link, defaulting to 'Invert selection'.
7336
7337 =cut
7338 sub select_invert_link
7339 {
7340 return &theme_select_invert_link(@_) if (defined(&theme_select_invert_link));
7341 my ($field, $form, $text) = @_;
7342 $form = int($form);
7343 $text ||= $text{'ui_selinv'};
7344 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>";
7345 }
7346
7347 =head2 select_rows_link(field, form, text, &rows)
7348
7349 Returns HTML for a link that uses Javascript to select rows with particular
7350 values for their checkboxes. The parameters are :
7351
7352 =item field - Name of the checkbox inputs.
7353
7354 =item form - Index of the form on the page.
7355
7356 =item text - Message for the link, de
7357
7358 =item rows - Reference to an array of 1 or 0 values, indicating which rows to check.
7359
7360 =cut
7361 sub select_rows_link
7362 {
7363 return &theme_select_rows_link(@_) if (defined(&theme_select_rows_link));
7364 my ($field, $form, $text, $rows) = @_;
7365 $form = int($form);
7366 my $js = "var sel = { ".join(",", map { "\"".&quote_escape($_)."\":1" } @$rows)." }; ";
7367 $js .= "for(var i=0; i<document.forms[$form].${field}.length; i++) { var r = document.forms[$form].${field}[i]; r.checked = sel[r.value]; } ";
7368 $js .= "return false;";
7369 return "<a href='#' onClick='$js'>$text</a>";
7370 }
7371
7372 =head2 check_pid_file(file)
7373
7374 Given a pid file, returns the PID it contains if the process is running.
7375
7376 =cut
7377 sub check_pid_file
7378 {
7379 open(PIDFILE, $_[0]) || return undef;
7380 my $pid = <PIDFILE>;
7381 close(PIDFILE);
7382 $pid =~ /^\s*(\d+)/ || return undef;
7383 kill(0, $1) || return undef;
7384 return $1;
7385 }
7386
7387 =head2 get_mod_lib
7388
7389 Return the local os-specific library name to this module. For internal use only.
7390
7391 =cut
7392 sub get_mod_lib
7393 {
7394 my $mn = &get_module_name();
7395 my $md = &module_root_directory($mn);
7396 if (-r "$md/$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl") {
7397         return "$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl";
7398         }
7399 elsif (-r "$md/$mn-$gconfig{'os_type'}-lib.pl") {
7400         return "$mn-$gconfig{'os_type'}-lib.pl";
7401         }
7402 elsif (-r "$md/$mn-generic-lib.pl") {
7403         return "$mn-generic-lib.pl";
7404         }
7405 else {
7406         return "";
7407         }
7408 }
7409
7410 =head2 module_root_directory(module)
7411
7412 Given a module name, returns its root directory. On a typical Webmin install,
7413 all modules are under the same directory - but it is theoretically possible to
7414 have more than one.
7415
7416 =cut
7417 sub module_root_directory
7418 {
7419 my $d = ref($_[0]) ? $_[0]->{'dir'} : $_[0];
7420 if (@root_directories > 1) {
7421         foreach my $r (@root_directories) {
7422                 if (-d "$r/$d") {
7423                         return "$r/$d";
7424                         }
7425                 }
7426         }
7427 return "$root_directories[0]/$d";
7428 }
7429
7430 =head2 list_mime_types
7431
7432 Returns a list of all known MIME types and their extensions, as a list of hash
7433 references with keys :
7434
7435 =item type - The MIME type, like text/plain.
7436
7437 =item exts - A list of extensions, like .doc and .avi.
7438
7439 =item desc - A human-readable description for the MIME type.
7440
7441 =cut
7442 sub list_mime_types
7443 {
7444 if (!@list_mime_types_cache) {
7445         local $_;
7446         open(MIME, "$root_directory/mime.types");
7447         while(<MIME>) {
7448                 my $cmt;
7449                 s/\r|\n//g;
7450                 if (s/#\s*(.*)$//g) {
7451                         $cmt = $1;
7452                         }
7453                 my ($type, @exts) = split(/\s+/);
7454                 if ($type) {
7455                         push(@list_mime_types_cache, { 'type' => $type,
7456                                                        'exts' => \@exts,
7457                                                        'desc' => $cmt });
7458                         }
7459                 }
7460         close(MIME);
7461         }
7462 return @list_mime_types_cache;
7463 }
7464
7465 =head2 guess_mime_type(filename, [default])
7466
7467 Given a file name like xxx.gif or foo.html, returns a guessed MIME type.
7468 The optional default parameter sets a default type of use if none is found,
7469 which defaults to application/octet-stream.
7470
7471 =cut
7472 sub guess_mime_type
7473 {
7474 if ($_[0] =~ /\.([A-Za-z0-9\-]+)$/) {
7475         my $ext = $1;
7476         foreach my $t (&list_mime_types()) {
7477                 foreach my $e (@{$t->{'exts'}}) {
7478                         return $t->{'type'} if (lc($e) eq lc($ext));
7479                         }
7480                 }
7481         }
7482 return @_ > 1 ? $_[1] : "application/octet-stream";
7483 }
7484
7485 =head2 open_tempfile([handle], file, [no-error], [no-tempfile], [safe?])
7486
7487 Opens a file handle for writing to a temporary file, which will only be
7488 renamed over the real file when the handle is closed. This allows critical
7489 files like /etc/shadow to be updated safely, even if writing fails part way
7490 through due to lack of disk space. The parameters are :
7491
7492 =item handle - File handle to open, as you would use in Perl's open function.
7493
7494 =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.
7495
7496 =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.
7497
7498 =item no-tempfile - If set to 1, writing will be direct to the file instead of using a temporary file.
7499
7500 =item safe - Indicates to users in read-only mode that this write is safe and non-destructive.
7501
7502 =cut
7503 sub open_tempfile
7504 {
7505 if (@_ == 1) {
7506         # Just getting a temp file
7507         if (!defined($main::open_tempfiles{$_[0]})) {
7508                 $_[0] =~ /^(.*)\/(.*)$/ || return $_[0];
7509                 my $dir = $1 || "/";
7510                 my $tmp = "$dir/$2.webmintmp.$$";
7511                 $main::open_tempfiles{$_[0]} = $tmp;
7512                 push(@main::temporary_files, $tmp);
7513                 }
7514         return $main::open_tempfiles{$_[0]};
7515         }
7516 else {
7517         # Actually opening
7518         my ($fh, $file, $noerror, $notemp, $safe) = @_;
7519         $fh = &callers_package($fh);
7520
7521         my %gaccess = &get_module_acl(undef, "");
7522         my $db = $gconfig{'debug_what_write'};
7523         if ($file =~ /\r|\n|\0/) {
7524                 if ($noerror) { return 0; }
7525                 else { &error("Filename contains invalid characters"); }
7526                 }
7527         if (&is_readonly_mode() && $file =~ />/ && !$safe) {
7528                 # Read-only mode .. veto all writes
7529                 print STDERR "vetoing write to $file\n";
7530                 return open($fh, ">$null_file");
7531                 }
7532         elsif ($file =~ /^(>|>>|)nul$/i) {
7533                 # Write to Windows null device
7534                 &webmin_debug_log($1 eq ">" ? "WRITE" :
7535                           $1 eq ">>" ? "APPEND" : "READ", "nul") if ($db);
7536                 }
7537         elsif ($file =~ /^(>|>>)(\/dev\/.*)/ || lc($file) eq "nul") {
7538                 # Writes to /dev/null or TTYs don't need to be handled
7539                 &webmin_debug_log($1 eq ">" ? "WRITE" : "APPEND", $2) if ($db);
7540                 return open($fh, $file);
7541                 }
7542         elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && !$notemp) {
7543                 &webmin_debug_log("WRITE", $1) if ($db);
7544                 # Over-writing a file, via a temp file
7545                 $file = $1;
7546                 $file = &translate_filename($file);
7547                 while(-l $file) {
7548                         # Open the link target instead
7549                         $file = &resolve_links($file);
7550                         }
7551                 if (-d $file) {
7552                         # Cannot open a directory!
7553                         if ($noerror) { return 0; }
7554                         else { &error("Cannot write to directory $file"); }
7555                         }
7556                 my $tmp = &open_tempfile($file);
7557                 my $ex = open($fh, ">$tmp");
7558                 if (!$ex && $! =~ /permission/i) {
7559                         # Could not open temp file .. try opening actual file
7560                         # instead directly
7561                         $ex = open($fh, ">$file");
7562                         delete($main::open_tempfiles{$file});
7563                         }
7564                 else {
7565                         $main::open_temphandles{$fh} = $file;
7566                         }
7567                 binmode($fh);
7568                 if (!$ex && !$noerror) {
7569                         &error(&text("efileopen", $file, $!));
7570                         }
7571                 return $ex;
7572                 }
7573         elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && $notemp) {
7574                 # Just writing direct to a file
7575                 &webmin_debug_log("WRITE", $1) if ($db);
7576                 $file = $1;
7577                 $file = &translate_filename($file);
7578                 my @old_attributes = &get_clear_file_attributes($file);
7579                 my $ex = open($fh, ">$file");
7580                 &reset_file_attributes($file, \@old_attributes);
7581                 $main::open_temphandles{$fh} = $file;
7582                 if (!$ex && !$noerror) {
7583                         &error(&text("efileopen", $file, $!));
7584                         }
7585                 binmode($fh);
7586                 return $ex;
7587                 }
7588         elsif ($file =~ /^>>\s*(([a-zA-Z]:)?\/.*)$/) {
7589                 # Appending to a file .. nothing special to do
7590                 &webmin_debug_log("APPEND", $1) if ($db);
7591                 $file = $1;
7592                 $file = &translate_filename($file);
7593                 my @old_attributes = &get_clear_file_attributes($file);
7594                 my $ex = open($fh, ">>$file");
7595                 &reset_file_attributes($file, \@old_attributes);
7596                 $main::open_temphandles{$fh} = $file;
7597                 if (!$ex && !$noerror) {
7598                         &error(&text("efileopen", $file, $!));
7599                         }
7600                 binmode($fh);
7601                 return $ex;
7602                 }
7603         elsif ($file =~ /^([a-zA-Z]:)?\//) {
7604                 # Read mode .. nothing to do here
7605                 &webmin_debug_log("READ", $file) if ($db);
7606                 $file = &translate_filename($file);
7607                 return open($fh, $file);
7608                 }
7609         elsif ($file eq ">" || $file eq ">>") {
7610                 my ($package, $filename, $line) = caller;
7611                 if ($noerror) { return 0; }
7612                 else { &error("Missing file to open at ${package}::${filename} line $line"); }
7613                 }
7614         else {
7615                 my ($package, $filename, $line) = caller;
7616                 &error("Unsupported file or mode $file at ${package}::${filename} line $line");
7617                 }
7618         }
7619 }
7620
7621 =head2 close_tempfile(file|handle)
7622
7623 Copies a temp file to the actual file, assuming that all writes were
7624 successful. The handle must have been one passed to open_tempfile.
7625
7626 =cut
7627 sub close_tempfile
7628 {
7629 my $file;
7630 my $fh = &callers_package($_[0]);
7631
7632 if (defined($file = $main::open_temphandles{$fh})) {
7633         # Closing a handle
7634         close($fh) || &error(&text("efileclose", $file, $!));
7635         delete($main::open_temphandles{$fh});
7636         return &close_tempfile($file);
7637         }
7638 elsif (defined($main::open_tempfiles{$_[0]})) {
7639         # Closing a file
7640         &webmin_debug_log("CLOSE", $_[0]) if ($gconfig{'debug_what_write'});
7641         my @st = stat($_[0]);
7642         if (&is_selinux_enabled() && &has_command("chcon")) {
7643                 # Set original security context
7644                 system("chcon --reference=".quotemeta($_[0]).
7645                        " ".quotemeta($main::open_tempfiles{$_[0]}).
7646                        " >/dev/null 2>&1");
7647                 }
7648         my @old_attributes = &get_clear_file_attributes($_[0]);
7649         rename($main::open_tempfiles{$_[0]}, $_[0]) || &error("Failed to replace $_[0] with $main::open_tempfiles{$_[0]} : $!");
7650         if (@st) {
7651                 # Set original permissions and ownership
7652                 chmod($st[2], $_[0]);
7653                 chown($st[4], $st[5], $_[0]);
7654                 }
7655         &reset_file_attributes($_[0], \@old_attributes);
7656         delete($main::open_tempfiles{$_[0]});
7657         @main::temporary_files = grep { $_ ne $main::open_tempfiles{$_[0]} } @main::temporary_files;
7658         if ($main::open_templocks{$_[0]}) {
7659                 &unlock_file($_[0]);
7660                 delete($main::open_templocks{$_[0]});
7661                 }
7662         return 1;
7663         }
7664 else {
7665         # Must be closing a handle not associated with a file
7666         close($_[0]);
7667         return 1;
7668         }
7669 }
7670
7671 =head2 print_tempfile(handle, text, ...)
7672
7673 Like the normal print function, but calls &error on failure. Useful when
7674 combined with open_tempfile, to ensure that a criticial file is never
7675 only partially written.
7676
7677 =cut
7678 sub print_tempfile
7679 {
7680 my ($fh, @args) = @_;
7681 $fh = &callers_package($fh);
7682 (print $fh @args) || &error(&text("efilewrite",
7683                             $main::open_temphandles{$fh} || $fh, $!));
7684 }
7685
7686 =head2 is_selinux_enabled
7687
7688 Returns 1 if SElinux is supported on this system and enabled, 0 if not.
7689
7690 =cut
7691 sub is_selinux_enabled
7692 {
7693 if (!defined($main::selinux_enabled_cache)) {
7694         my %seconfig;
7695         if ($gconfig{'os_type'} !~ /-linux$/) {
7696                 # Not on linux, so no way
7697                 $main::selinux_enabled_cache = 0;
7698                 }
7699         elsif (&read_env_file("/etc/selinux/config", \%seconfig)) {
7700                 # Use global config file
7701                 $main::selinux_enabled_cache =
7702                         $seconfig{'SELINUX'} eq 'disabled' ||
7703                         !$seconfig{'SELINUX'} ? 0 : 1;
7704                 }
7705         else {
7706                 # Use selinuxenabled command
7707                 #$selinux_enabled_cache =
7708                 #       system("selinuxenabled >/dev/null 2>&1") ? 0 : 1;
7709                 $main::selinux_enabled_cache = 0;
7710                 }
7711         }
7712 return $main::selinux_enabled_cache;
7713 }
7714
7715 =head2 get_clear_file_attributes(file)
7716
7717 Finds file attributes that may prevent writing, clears them and returns them
7718 as a list. May call error. Mainly for internal use by open_tempfile and
7719 close_tempfile.
7720
7721 =cut
7722 sub get_clear_file_attributes
7723 {
7724 my ($file) = @_;
7725 my @old_attributes;
7726 if ($gconfig{'chattr'}) {
7727         # Get original immutable bit
7728         my $out = &backquote_command(
7729                 "lsattr ".quotemeta($file)." 2>/dev/null");
7730         if (!$?) {
7731                 $out =~ s/\s\S+\n//;
7732                 @old_attributes = grep { $_ ne '-' } split(//, $out);
7733                 }
7734         if (&indexof("i", @old_attributes) >= 0) {
7735                 my $err = &backquote_logged(
7736                         "chattr -i ".quotemeta($file)." 2>&1");
7737                 if ($?) {
7738                         &error("Failed to remove immutable bit on ".
7739                                "$file : $err");
7740                         }
7741                 }
7742         }
7743 return @old_attributes;
7744 }
7745
7746 =head2 reset_file_attributes(file, &attributes)
7747
7748 Put back cleared attributes on some file. May call error. Mainly for internal
7749 use by close_tempfile.
7750
7751 =cut
7752 sub reset_file_attributes
7753 {
7754 my ($file, $old_attributes) = @_;
7755 if (&indexof("i", @$old_attributes) >= 0) {
7756         my $err = &backquote_logged(
7757                 "chattr +i ".quotemeta($file)." 2>&1");
7758         if ($?) {
7759                 &error("Failed to restore immutable bit on ".
7760                        "$file : $err");
7761                 }
7762         }
7763 }
7764
7765 =head2 cleanup_tempnames
7766
7767 Remove all temporary files generated using transname. Typically only called
7768 internally when a Webmin script exits.
7769
7770 =cut
7771 sub cleanup_tempnames
7772 {
7773 foreach my $t (@main::temporary_files) {
7774         &unlink_file($t);
7775         }
7776 @main::temporary_files = ( );
7777 }
7778
7779 =head2 open_lock_tempfile([handle], file, [no-error])
7780
7781 Returns a temporary file for writing to some actual file, and also locks it.
7782 Effectively the same as calling lock_file and open_tempfile on the same file,
7783 but calls the unlock for you automatically when it is closed.
7784
7785 =cut
7786 sub open_lock_tempfile
7787 {
7788 my ($fh, $file, $noerror, $notemp, $safe) = @_;
7789 $fh = &callers_package($fh);
7790 my $lockfile = $file;
7791 $lockfile =~ s/^[^\/]*//;
7792 if ($lockfile =~ /^\//) {
7793         $main::open_templocks{$lockfile} = &lock_file($lockfile);
7794         }
7795 return &open_tempfile($fh, $file, $noerror, $notemp, $safe);
7796 }
7797
7798 sub END
7799 {
7800 $main::end_exit_status ||= $?;
7801 if ($$ == $main::initial_process_id) {
7802         # Exiting from initial process
7803         &cleanup_tempnames();
7804         if ($gconfig{'debug_what_start'} && $main::debug_log_start_time &&
7805             $main::debug_log_start_module eq &get_module_name()) {
7806                 my $len = time() - $main::debug_log_start_time;
7807                 &webmin_debug_log("STOP", "runtime=$len");
7808                 $main::debug_log_start_time = 0;
7809                 }
7810         if (!$ENV{'SCRIPT_NAME'} &&
7811             $main::initial_module_name eq &get_module_name()) {
7812                 # In a command-line script - call the real exit, so that the
7813                 # exit status gets properly propogated. In some cases this
7814                 # was not happening.
7815                 exit($main::end_exit_status);
7816                 }
7817         }
7818 }
7819
7820 =head2 month_to_number(month)
7821
7822 Converts a month name like feb to a number like 1.
7823
7824 =cut
7825 sub month_to_number
7826 {
7827 return $month_to_number_map{lc(substr($_[0], 0, 3))};
7828 }
7829
7830 =head2 number_to_month(number)
7831
7832 Converts a number like 1 to a month name like Feb.
7833
7834 =cut
7835 sub number_to_month
7836 {
7837 return ucfirst($number_to_month_map{$_[0]});
7838 }
7839
7840 =head2 get_rbac_module_acl(user, module)
7841
7842 Returns a hash reference of RBAC overrides ACLs for some user and module.
7843 May return undef if none exist (indicating access denied), or the string *
7844 if full access is granted.
7845
7846 =cut
7847 sub get_rbac_module_acl
7848 {
7849 my ($user, $mod) = @_;
7850 eval "use Authen::SolarisRBAC";
7851 return undef if ($@);
7852 my %rv;
7853 my $foundany = 0;
7854 if (Authen::SolarisRBAC::chkauth("webmin.$mod.admin", $user)) {
7855         # Automagic webmin.modulename.admin authorization exists .. allow access
7856         $foundany = 1;
7857         if (!Authen::SolarisRBAC::chkauth("webmin.$mod.config", $user)) {
7858                 %rv = ( 'noconfig' => 1 );
7859                 }
7860         else {
7861                 %rv = ( );
7862                 }
7863         }
7864 local $_;
7865 open(RBAC, &module_root_directory($mod)."/rbac-mapping");
7866 while(<RBAC>) {
7867         s/\r|\n//g;
7868         s/#.*$//;
7869         my ($auths, $acls) = split(/\s+/, $_);
7870         my @auths = split(/,/, $auths);
7871         next if (!$auths);
7872         my ($merge) = ($acls =~ s/^\+//);
7873         my $gotall = 1;
7874         if ($auths eq "*") {
7875                 # These ACLs apply to all RBAC users.
7876                 # Only if there is some that match a specific authorization
7877                 # later will they be used though.
7878                 }
7879         else {
7880                 # Check each of the RBAC authorizations
7881                 foreach my $a (@auths) {
7882                         if (!Authen::SolarisRBAC::chkauth($a, $user)) {
7883                                 $gotall = 0;
7884                                 last;
7885                                 }
7886                         }
7887                 $foundany++ if ($gotall);
7888                 }
7889         if ($gotall) {
7890                 # Found an RBAC authorization - return the ACLs
7891                 return "*" if ($acls eq "*");
7892                 my %acl = map { split(/=/, $_, 2) } split(/,/, $acls);
7893                 if ($merge) {
7894                         # Just add to current set
7895                         foreach my $a (keys %acl) {
7896                                 $rv{$a} = $acl{$a};
7897                                 }
7898                         }
7899                 else {
7900                         # Found final ACLs
7901                         return \%acl;
7902                         }
7903                 }
7904         }
7905 close(RBAC);
7906 return !$foundany ? undef : %rv ? \%rv : undef;
7907 }
7908
7909 =head2 supports_rbac([module])
7910
7911 Returns 1 if RBAC client support is available, such as on Solaris.
7912
7913 =cut
7914 sub supports_rbac
7915 {
7916 return 0 if ($gconfig{'os_type'} ne 'solaris');
7917 eval "use Authen::SolarisRBAC";
7918 return 0 if ($@);
7919 if ($_[0]) {
7920         #return 0 if (!-r &module_root_directory($_[0])."/rbac-mapping");
7921         }
7922 return 1;
7923 }
7924
7925 =head2 use_rbac_module_acl(user, module)
7926
7927 Returns 1 if some user should use RBAC to get permissions for a module
7928
7929 =cut
7930 sub use_rbac_module_acl
7931 {
7932 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
7933 my $m = defined($_[1]) ? $_[1] : &get_module_name();
7934 return 1 if ($gconfig{'rbacdeny_'.$u});         # RBAC forced for user
7935 my %access = &get_module_acl($u, $m, 1);
7936 return $access{'rbac'} ? 1 : 0;
7937 }
7938
7939 =head2 execute_command(command, stdin, stdout, stderr, translate-files?, safe?)
7940
7941 Runs some command, possibly feeding it input and capturing output to the
7942 give files or scalar references. The parameters are :
7943
7944 =item command - Full command to run, possibly including shell meta-characters.
7945
7946 =item stdin - File to read input from, or a scalar ref containing input, or undef if no input should be given.
7947
7948 =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.
7949
7950 =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.
7951
7952 =item translate-files - Set to 1 to apply filename translation to any filenames. Usually has no effect.
7953
7954 =item safe - Set to 1 if this command is safe and does not modify the state of the system.
7955
7956 =cut
7957 sub execute_command
7958 {
7959 my ($cmd, $stdin, $stdout, $stderr, $trans, $safe) = @_;
7960 if (&is_readonly_mode() && !$safe) {
7961         print STDERR "Vetoing command $_[0]\n";
7962         $? = 0;
7963         return 0;
7964         }
7965 $cmd = &translate_command($cmd);
7966
7967 # Use ` operator where possible
7968 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
7969 if (!$stdin && ref($stdout) && !$stderr) {
7970         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7971         $$stdout = `$cmd 2>$null_file`;
7972         return $?;
7973         }
7974 elsif (!$stdin && ref($stdout) && $stdout eq $stderr) {
7975         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7976         $$stdout = `$cmd 2>&1`;
7977         return $?;
7978         }
7979 elsif (!$stdin && !$stdout && !$stderr) {
7980         $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7981         return system("$cmd >$null_file 2>$null_file <$null_file");
7982         }
7983
7984 # Setup pipes
7985 $| = 1;         # needed on some systems to flush before forking
7986 pipe(EXECSTDINr, EXECSTDINw);
7987 pipe(EXECSTDOUTr, EXECSTDOUTw);
7988 pipe(EXECSTDERRr, EXECSTDERRw);
7989 my $pid;
7990 if (!($pid = fork())) {
7991         untie(*STDIN);
7992         untie(*STDOUT);
7993         untie(*STDERR);
7994         open(STDIN, "<&EXECSTDINr");
7995         open(STDOUT, ">&EXECSTDOUTw");
7996         if (ref($stderr) && $stderr eq $stdout) {
7997                 open(STDERR, ">&EXECSTDOUTw");
7998                 }
7999         else {
8000                 open(STDERR, ">&EXECSTDERRw");
8001                 }
8002         $| = 1;
8003         close(EXECSTDINw);
8004         close(EXECSTDOUTr);
8005         close(EXECSTDERRr);
8006
8007         my $fullcmd = "($cmd)";
8008         if ($stdin && !ref($stdin)) {
8009                 $fullcmd .= " <$stdin";
8010                 }
8011         if ($stdout && !ref($stdout)) {
8012                 $fullcmd .= " >$stdout";
8013                 }
8014         if ($stderr && !ref($stderr)) {
8015                 if ($stderr eq $stdout) {
8016                         $fullcmd .= " 2>&1";
8017                         }
8018                 else {
8019                         $fullcmd .= " 2>$stderr";
8020                         }
8021                 }
8022         if ($gconfig{'os_type'} eq 'windows') {
8023                 exec($fullcmd);
8024                 }
8025         else {
8026                 exec("/bin/sh", "-c", $fullcmd);
8027                 }
8028         print "Exec failed : $!\n";
8029         exit(1);
8030         }
8031 close(EXECSTDINr);
8032 close(EXECSTDOUTw);
8033 close(EXECSTDERRw);
8034
8035 # Feed input and capture output
8036 local $_;
8037 if ($stdin && ref($stdin)) {
8038         print EXECSTDINw $$stdin;
8039         close(EXECSTDINw);
8040         }
8041 if ($stdout && ref($stdout)) {
8042         $$stdout = undef;
8043         while(<EXECSTDOUTr>) {
8044                 $$stdout .= $_;
8045                 }
8046         close(EXECSTDOUTr);
8047         }
8048 if ($stderr && ref($stderr) && $stderr ne $stdout) {
8049         $$stderr = undef;
8050         while(<EXECSTDERRr>) {
8051                 $$stderr .= $_;
8052                 }
8053         close(EXECSTDERRr);
8054         }
8055
8056 # Get exit status
8057 waitpid($pid, 0);
8058 return $?;
8059 }
8060
8061 =head2 open_readfile(handle, file)
8062
8063 Opens some file for reading. Returns 1 on success, 0 on failure. Pretty much
8064 exactly the same as Perl's open function.
8065
8066 =cut
8067 sub open_readfile
8068 {
8069 my ($fh, $file) = @_;
8070 $fh = &callers_package($fh);
8071 my $realfile = &translate_filename($file);
8072 &webmin_debug_log('READ', $file) if ($gconfig{'debug_what_read'});
8073 return open($fh, "<".$realfile);
8074 }
8075
8076 =head2 open_execute_command(handle, command, output?, safe?)
8077
8078 Runs some command, with the specified file handle set to either write to it if
8079 in-or-out is set to 0, or read to it if output is set to 1. The safe flag
8080 indicates if the command modifies the state of the system or not.
8081
8082 =cut
8083 sub open_execute_command
8084 {
8085 my ($fh, $cmd, $mode, $safe) = @_;
8086 $fh = &callers_package($fh);
8087 my $realcmd = &translate_command($cmd);
8088 if (&is_readonly_mode() && !$safe) {
8089         # Don't actually run it
8090         print STDERR "vetoing command $cmd\n";
8091         $? = 0;
8092         if ($mode == 0) {
8093                 return open($fh, ">$null_file");
8094                 }
8095         else {
8096                 return open($fh, $null_file);
8097                 }
8098         }
8099 # Really run it
8100 &webmin_debug_log('CMD', "cmd=$realcmd mode=$mode")
8101         if ($gconfig{'debug_what_cmd'});
8102 if ($mode == 0) {
8103         return open($fh, "| $cmd");
8104         }
8105 elsif ($mode == 1) {
8106         return open($fh, "$cmd 2>$null_file |");
8107         }
8108 elsif ($mode == 2) {
8109         return open($fh, "$cmd 2>&1 |");
8110         }
8111 }
8112
8113 =head2 translate_filename(filename)
8114
8115 Applies all relevant registered translation functions to a filename. Mostly
8116 for internal use, and typically does nothing.
8117
8118 =cut
8119 sub translate_filename
8120 {
8121 my ($realfile) = @_;
8122 my @funcs = grep { $_->[0] eq &get_module_name() ||
8123                    !defined($_->[0]) } @main::filename_callbacks;
8124 foreach my $f (@funcs) {
8125         my $func = $f->[1];
8126         $realfile = &$func($realfile, @{$f->[2]});
8127         }
8128 return $realfile;
8129 }
8130
8131 =head2 translate_command(filename)
8132
8133 Applies all relevant registered translation functions to a command. Mostly
8134 for internal use, and typically does nothing.
8135
8136 =cut
8137 sub translate_command
8138 {
8139 my ($realcmd) = @_;
8140 my @funcs = grep { $_->[0] eq &get_module_name() ||
8141                    !defined($_->[0]) } @main::command_callbacks;
8142 foreach my $f (@funcs) {
8143         my $func = $f->[1];
8144         $realcmd = &$func($realcmd, @{$f->[2]});
8145         }
8146 return $realcmd;
8147 }
8148
8149 =head2 register_filename_callback(module|undef, &function, &args)
8150
8151 Registers some function to be called when the specified module (or all
8152 modules) tries to open a file for reading and writing. The function must
8153 return the actual file to open. This allows you to override which files
8154 other code actually operates on, via the translate_filename function.
8155
8156 =cut
8157 sub register_filename_callback
8158 {
8159 my ($mod, $func, $args) = @_;
8160 push(@main::filename_callbacks, [ $mod, $func, $args ]);
8161 }
8162
8163 =head2 register_command_callback(module|undef, &function, &args)
8164
8165 Registers some function to be called when the specified module (or all
8166 modules) tries to execute a command. The function must return the actual
8167 command to run. This allows you to override which commands other other code
8168 actually runs, via the translate_command function.
8169
8170 =cut
8171 sub register_command_callback
8172 {
8173 my ($mod, $func, $args) = @_;
8174 push(@main::command_callbacks, [ $mod, $func, $args ]);
8175 }
8176
8177 =head2 capture_function_output(&function, arg, ...)
8178
8179 Captures output that some function prints to STDOUT, and returns it. Useful
8180 for functions outside your control that print data when you really want to
8181 manipulate it before output.
8182
8183 =cut
8184 sub capture_function_output
8185 {
8186 my ($func, @args) = @_;
8187 socketpair(SOCKET2, SOCKET1, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
8188 my $old = select(SOCKET1);
8189 my @rv = &$func(@args);
8190 select($old);
8191 close(SOCKET1);
8192 my $out;
8193 local $_;
8194 while(<SOCKET2>) {
8195         $out .= $_;
8196         }
8197 close(SOCKET2);
8198 return wantarray ? ($out, \@rv) : $out;
8199 }
8200
8201 =head2 capture_function_output_tempfile(&function, arg, ...)
8202
8203 Behaves the same as capture_function_output, but uses a temporary file
8204 to avoid buffer full problems.
8205
8206 =cut
8207 sub capture_function_output_tempfile
8208 {
8209 my ($func, @args) = @_;
8210 my $temp = &transname();
8211 open(BUFFER, ">$temp");
8212 my $old = select(BUFFER);
8213 my @rv = &$func(@args);
8214 select($old);
8215 close(BUFFER);
8216 my $out = &read_file_contents($temp);
8217 &unlink_file($temp);
8218 return wantarray ? ($out, \@rv) : $out;
8219 }
8220
8221 =head2 modules_chooser_button(field, multiple, [form])
8222
8223 Returns HTML for a button for selecting one or many Webmin modules.
8224 field - Name of the HTML field to place the module names into.
8225 multiple - Set to 1 if multiple modules can be selected.
8226 form - Index of the form on the page.
8227
8228 =cut
8229 sub modules_chooser_button
8230 {
8231 return &theme_modules_chooser_button(@_)
8232         if (defined(&theme_modules_chooser_button));
8233 my $form = defined($_[2]) ? $_[2] : 0;
8234 my $w = $_[1] ? 700 : 500;
8235 my $h = 200;
8236 if ($_[1] && $gconfig{'db_sizemodules'}) {
8237         ($w, $h) = split(/x/, $gconfig{'db_sizemodules'});
8238         }
8239 elsif (!$_[1] && $gconfig{'db_sizemodule'}) {
8240         ($w, $h) = split(/x/, $gconfig{'db_sizemodule'});
8241         }
8242 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";
8243 }
8244
8245 =head2 substitute_template(text, &hash)
8246
8247 Given some text and a hash reference, for each ocurrance of $FOO or ${FOO} in
8248 the text replaces it with the value of the hash key foo. Also supports blocks
8249 like ${IF-FOO} ... ${ENDIF-FOO}, whose contents are only included if foo is
8250 non-zero, and ${IF-FOO} ... ${ELSE-FOO} ... ${ENDIF-FOO}.
8251
8252 =cut
8253 sub substitute_template
8254 {
8255 # Add some extra fixed parameters to the hash
8256 my %hash = %{$_[1]};
8257 $hash{'hostname'} = &get_system_hostname();
8258 $hash{'webmin_config'} = $config_directory;
8259 $hash{'webmin_etc'} = $config_directory;
8260 $hash{'module_config'} = &get_module_variable('$module_config_directory');
8261 $hash{'webmin_var'} = $var_directory;
8262
8263 # Add time-based parameters, for use in DNS
8264 $hash{'current_time'} = time();
8265 my @tm = localtime($hash{'current_time'});
8266 $hash{'current_year'} = $tm[5]+1900;
8267 $hash{'current_month'} = sprintf("%2.2d", $tm[4]+1);
8268 $hash{'current_day'} = sprintf("%2.2d", $tm[3]);
8269 $hash{'current_hour'} = sprintf("%2.2d", $tm[2]);
8270 $hash{'current_minute'} = sprintf("%2.2d", $tm[1]);
8271 $hash{'current_second'} = sprintf("%2.2d", $tm[0]);
8272
8273 # Actually do the substition
8274 my $rv = $_[0];
8275 foreach my $s (keys %hash) {
8276         next if ($s eq '');     # Prevent just $ from being subbed
8277         my $us = uc($s);
8278         my $sv = $hash{$s};
8279         $rv =~ s/\$\{\Q$us\E\}/$sv/g;
8280         $rv =~ s/\$\Q$us\E/$sv/g;
8281         if ($sv) {
8282                 # Replace ${IF}..${ELSE}..${ENDIF} block with first value,
8283                 # and ${IF}..${ENDIF} with value
8284                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8285                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8286
8287                 # Replace $IF..$ELSE..$ENDIF block with first value,
8288                 # and $IF..$ENDIF with value
8289                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8290                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8291
8292                 # Replace ${IFEQ}..${ENDIFEQ} block with first value if
8293                 # matching, nothing if not
8294                 $rv =~ s/\$\{IFEQ-\Q$us\E-\Q$sv\E\}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-\Q$sv\E\}(\n?)/$2/g;
8295                 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8296
8297                 # Replace $IFEQ..$ENDIFEQ block with first value if
8298                 # matching, nothing if not
8299                 $rv =~ s/\$IFEQ-\Q$us\E-\Q$sv\E(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\Q$sv\E(\n?)/$2/g;
8300                 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8301                 }
8302         else {
8303                 # Replace ${IF}..${ELSE}..${ENDIF} block with second value,
8304                 # and ${IF}..${ENDIF} with nothing
8305                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$4/g;
8306                 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)//g;
8307
8308                 # Replace $IF..$ELSE..$ENDIF block with second value,
8309                 # and $IF..$ENDIF with nothing
8310                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$4/g;
8311                 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)//g;
8312
8313                 # Replace ${IFEQ}..${ENDIFEQ} block with nothing
8314                 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8315                 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8316                 }
8317         }
8318
8319 # Now assume any $IF blocks whose variables are not present in the hash
8320 # evaluate to false.
8321 # $IF...$ELSE x $ENDIF => x
8322 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ELSE\-\1\}(.*?)\$\{ENDIF\-\1\}/$2/gs;
8323 # $IF...x...$ENDIF => (nothing)
8324 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ENDIF\-\1\}//gs;
8325 # ${var} => (nothing)
8326 $rv =~ s/\$\{[A-Z]+\}//g;
8327
8328 return $rv;
8329 }
8330
8331 =head2 running_in_zone
8332
8333 Returns 1 if the current Webmin instance is running in a Solaris zone. Used to
8334 disable module and features that are not appropriate, like those that modify
8335 mounted filesystems.
8336
8337 =cut
8338 sub running_in_zone
8339 {
8340 return 0 if ($gconfig{'os_type'} ne 'solaris' ||
8341              $gconfig{'os_version'} < 10);
8342 my $zn = `zonename 2>$null_file`;
8343 chop($zn);
8344 return $zn && $zn ne "global";
8345 }
8346
8347 =head2 running_in_vserver
8348
8349 Returns 1 if the current Webmin instance is running in a Linux VServer.
8350 Used to disable modules and features that are not appropriate.
8351
8352 =cut
8353 sub running_in_vserver
8354 {
8355 return 0 if ($gconfig{'os_type'} !~ /^\*-linux$/);
8356 my $vserver;
8357 local $_;
8358 open(MTAB, "/etc/mtab");
8359 while(<MTAB>) {
8360         my ($dev, $mp) = split(/\s+/, $_);
8361         if ($mp eq "/" && $dev =~ /^\/dev\/hdv/) {
8362                 $vserver = 1;
8363                 last;
8364                 }
8365         }
8366 close(MTAB);
8367 return $vserver;
8368 }
8369
8370 =head2 running_in_xen
8371
8372 Returns 1 if Webmin is running inside a Xen instance, by looking
8373 at /proc/xen/capabilities.
8374
8375 =cut
8376 sub running_in_xen
8377 {
8378 return 0 if (!-r "/proc/xen/capabilities");
8379 my $cap = &read_file_contents("/proc/xen/capabilities");
8380 return $cap =~ /control_d/ ? 0 : 1;
8381 }
8382
8383 =head2 running_in_openvz
8384
8385 Returns 1 if Webmin is running inside an OpenVZ container, by looking
8386 at /proc/vz/veinfo for a non-zero line.
8387
8388 =cut
8389 sub running_in_openvz
8390 {
8391 return 0 if (!-r "/proc/vz/veinfo");
8392 my $lref = &read_file_lines("/proc/vz/veinfo", 1);
8393 return 0 if (!$lref || !@$lref);
8394 foreach my $l (@$lref) {
8395         $l =~ s/^\s+//;
8396         my @ll = split(/\s+/, $l);
8397         return 0 if ($ll[0] eq '0');
8398         }
8399 return 1;
8400 }
8401
8402 =head2 list_categories(&modules, [include-empty])
8403
8404 Returns a hash mapping category codes to names, including any custom-defined
8405 categories. The modules parameter must be an array ref of module hash objects,
8406 as returned by get_all_module_infos.
8407
8408 =cut
8409 sub list_categories
8410 {
8411 my ($mods, $empty) = @_;
8412 my (%cats, %catnames);
8413 &read_file("$config_directory/webmin.catnames", \%catnames);
8414 foreach my $o (@lang_order_list) {
8415         &read_file("$config_directory/webmin.catnames.$o", \%catnames);
8416         }
8417 if ($empty) {
8418         %cats = %catnames;
8419         }
8420 foreach my $m (@$mods) {
8421         my $c = $m->{'category'};
8422         next if ($cats{$c});
8423         if (defined($catnames{$c})) {
8424                 $cats{$c} = $catnames{$c};
8425                 }
8426         elsif ($text{"category_$c"}) {
8427                 $cats{$c} = $text{"category_$c"};
8428                 }
8429         else {
8430                 # try to get category name from module ..
8431                 my %mtext = &load_language($m->{'dir'});
8432                 if ($mtext{"category_$c"}) {
8433                         $cats{$c} = $mtext{"category_$c"};
8434                         }
8435                 else {
8436                         $c = $m->{'category'} = "";
8437                         $cats{$c} = $text{"category_$c"};
8438                         }
8439                 }
8440         }
8441 return %cats;
8442 }
8443
8444 =head2 is_readonly_mode
8445
8446 Returns 1 if the current user is in read-only mode, and thus all writes
8447 to files and command execution should fail.
8448
8449 =cut
8450 sub is_readonly_mode
8451 {
8452 if (!defined($main::readonly_mode_cache)) {
8453         my %gaccess = &get_module_acl(undef, "");
8454         $main::readonly_mode_cache = $gaccess{'readonly'} ? 1 : 0;
8455         }
8456 return $main::readonly_mode_cache;
8457 }
8458
8459 =head2 command_as_user(user, with-env?, command, ...)
8460
8461 Returns a command to execute some command as the given user, using the
8462 su statement. If on Linux, the /bin/sh shell is forced in case the user
8463 does not have a valid shell. If with-env is set to 1, the -s flag is added
8464 to the su command to read the user's .profile or .bashrc file.
8465
8466 =cut
8467 sub command_as_user
8468 {
8469 my ($user, $env, @args) = @_;
8470 my @uinfo = getpwnam($user);
8471 if ($uinfo[8] ne "/bin/sh" && $uinfo[8] !~ /\/bash$/) {
8472         # User shell doesn't appear to be valid
8473         if ($gconfig{'os_type'} =~ /-linux$/) {
8474                 # Use -s /bin/sh to force it
8475                 $shellarg = " -s /bin/sh";
8476                 }
8477         elsif ($gconfig{'os_type'} eq 'freebsd' ||
8478                $gconfig{'os_type'} eq 'solaris' &&
8479                 $gconfig{'os_version'} >= 11 ||
8480                $gconfig{'os_type'} eq 'macos') {
8481                 # Use -m and force /bin/sh
8482                 @args = ( "/bin/sh", "-c", quotemeta(join(" ", @args)) );
8483                 $shellarg = " -m";
8484                 }
8485         }
8486 my $rv = "su".($env ? " -" : "").$shellarg.
8487          " ".quotemeta($user)." -c ".quotemeta(join(" ", @args));
8488 return $rv;
8489 }
8490
8491 =head2 list_osdn_mirrors(project, file)
8492
8493 This function is now deprecated in favor of letting sourceforge just
8494 redirect to the best mirror, and now just returns their primary download URL.
8495
8496 =cut
8497 sub list_osdn_mirrors
8498 {
8499 my ($project, $file) = @_;
8500 return ( { 'url' => "http://downloads.sourceforge.net/$project/$file",
8501            'default' => 0,
8502            'mirror' => 'downloads' } );
8503 }
8504
8505 =head2 convert_osdn_url(url)
8506
8507 Given a URL like http://osdn.dl.sourceforge.net/sourceforge/project/file.zip
8508 or http://prdownloads.sourceforge.net/project/file.zip , convert it
8509 to a real URL on the sourceforge download redirector.
8510
8511 =cut
8512 sub convert_osdn_url
8513 {
8514 my ($url) = @_;
8515 if ($url =~ /^http:\/\/[^\.]+.dl.sourceforge.net\/sourceforge\/([^\/]+)\/(.*)$/ ||
8516     $url =~ /^http:\/\/prdownloads.sourceforge.net\/([^\/]+)\/(.*)$/) {
8517         # Always use the Sourceforge mail download URL, which does
8518         # a location-based redirect for us
8519         my ($project, $file) = ($1, $2);
8520         $url = "http://prdownloads.sourceforge.net/sourceforge/".
8521                "$project/$file";
8522         return wantarray ? ( $url, 0 ) : $url;
8523         }
8524 else {
8525         # Some other source .. don't change
8526         return wantarray ? ( $url, 2 ) : $url;
8527         }
8528 }
8529
8530 =head2 get_current_dir
8531
8532 Returns the directory the current process is running in.
8533
8534 =cut
8535 sub get_current_dir
8536 {
8537 my $out;
8538 if ($gconfig{'os_type'} eq 'windows') {
8539         # Use cd command
8540         $out = `cd`;
8541         }
8542 else {
8543         # Use pwd command
8544         $out = `pwd`;
8545         $out =~ s/\\/\//g;
8546         }
8547 $out =~ s/\r|\n//g;
8548 return $out;
8549 }
8550
8551 =head2 supports_users
8552
8553 Returns 1 if the current OS supports Unix user concepts and functions like
8554 su , getpw* and so on. This will be true on Linux and other Unixes, but false
8555 on Windows.
8556
8557 =cut
8558 sub supports_users
8559 {
8560 return $gconfig{'os_type'} ne 'windows';
8561 }
8562
8563 =head2 supports_symlinks
8564
8565 Returns 1 if the current OS supports symbolic and hard links. This will not
8566 be the case on Windows.
8567
8568 =cut
8569 sub supports_symlinks
8570 {
8571 return $gconfig{'os_type'} ne 'windows';
8572 }
8573
8574 =head2 quote_path(path)
8575
8576 Returns a path with safe quoting for the current operating system.
8577
8578 =cut
8579 sub quote_path
8580 {
8581 my ($path) = @_;
8582 if ($gconfig{'os_type'} eq 'windows' || $path =~ /^[a-z]:/i) {
8583         # Windows only supports "" style quoting
8584         return "\"$path\"";
8585         }
8586 else {
8587         return quotemeta($path);
8588         }
8589 }
8590
8591 =head2 get_windows_root
8592
8593 Returns the base windows system directory, like c:/windows.
8594
8595 =cut
8596 sub get_windows_root
8597 {
8598 if ($ENV{'SystemRoot'}) {
8599         my $rv = $ENV{'SystemRoot'};
8600         $rv =~ s/\\/\//g;
8601         return $rv;
8602         }
8603 else {
8604         return -d "c:/windows" ? "c:/windows" : "c:/winnt";
8605         }
8606 }
8607
8608 =head2 read_file_contents(file)
8609
8610 Given a filename, returns its complete contents as a string. Effectively
8611 the same as the Perl construct `cat file`.
8612
8613 =cut
8614 sub read_file_contents
8615 {
8616 &open_readfile(FILE, $_[0]) || return undef;
8617 local $/ = undef;
8618 my $rv = <FILE>;
8619 close(FILE);
8620 return $rv;
8621 }
8622
8623 =head2 unix_crypt(password, salt)
8624
8625 Performs Unix encryption on a password, using the built-in crypt function or
8626 the Crypt::UnixCrypt module if the former does not work. The salt parameter
8627 must be either an already-hashed password, or a two-character alpha-numeric
8628 string.
8629
8630 =cut
8631 sub unix_crypt
8632 {
8633 my ($pass, $salt) = @_;
8634 return "" if ($salt !~ /^[a-zA-Z0-9\.\/]{2}/);   # same as real crypt
8635 my $rv = eval "crypt(\$pass, \$salt)";
8636 my $err = $@;
8637 return $rv if ($rv && !$@);
8638 eval "use Crypt::UnixCrypt";
8639 if (!$@) {
8640         return Crypt::UnixCrypt::crypt($pass, $salt);
8641         }
8642 else {
8643         &error("Failed to encrypt password : $err");
8644         }
8645 }
8646
8647 =head2 split_quoted_string(string)
8648
8649 Given a string like I<foo "bar baz" quux>, returns the array :
8650 foo, bar baz, quux
8651
8652 =cut
8653 sub split_quoted_string
8654 {
8655 my ($str) = @_;
8656 my @rv;
8657 while($str =~ /^"([^"]*)"\s*([\000-\377]*)$/ ||
8658       $str =~ /^'([^']*)'\s*([\000-\377]*)$/ ||
8659       $str =~ /^(\S+)\s*([\000-\377]*)$/) {
8660         push(@rv, $1);
8661         $str = $2;
8662         }
8663 return @rv;
8664 }
8665
8666 =head2 write_to_http_cache(url, file|&data)
8667
8668 Updates the Webmin cache with the contents of the given file, possibly also
8669 clearing out old data. Mainly for internal use by http_download.
8670
8671 =cut
8672 sub write_to_http_cache
8673 {
8674 my ($url, $file) = @_;
8675 return 0 if (!$gconfig{'cache_size'});
8676
8677 # Don't cache downloads that look dynamic
8678 if ($url =~ /cgi-bin/ || $url =~ /\?/) {
8679         return 0;
8680         }
8681
8682 # Check if the current module should do caching
8683 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
8684         # Caching all except some modules
8685         my @mods = split(/\s+/, $1);
8686         return 0 if (&indexof(&get_module_name(), @mods) != -1);
8687         }
8688 elsif ($gconfig{'cache_mods'}) {
8689         # Only caching some modules
8690         my @mods = split(/\s+/, $gconfig{'cache_mods'});
8691         return 0 if (&indexof(&get_module_name(), @mods) == -1);
8692         }
8693
8694 # Work out the size
8695 my $size;
8696 if (ref($file)) {
8697         $size = length($$file);
8698         }
8699 else {
8700         my @st = stat($file);
8701         $size = $st[7];
8702         }
8703
8704 if ($size > $gconfig{'cache_size'}) {
8705         # Bigger than the whole cache - so don't save it
8706         return 0;
8707         }
8708 my $cfile = $url;
8709 $cfile =~ s/\//_/g;
8710 $cfile = "$main::http_cache_directory/$cfile";
8711
8712 # See how much we have cached currently, clearing old files
8713 my $total = 0;
8714 mkdir($main::http_cache_directory, 0700) if (!-d $main::http_cache_directory);
8715 opendir(CACHEDIR, $main::http_cache_directory);
8716 foreach my $f (readdir(CACHEDIR)) {
8717         next if ($f eq "." || $f eq "..");
8718         my $path = "$main::http_cache_directory/$f";
8719         my @st = stat($path);
8720         if ($gconfig{'cache_days'} &&
8721             time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
8722                 # This file is too old .. trash it
8723                 unlink($path);
8724                 }
8725         else {
8726                 $total += $st[7];
8727                 push(@cached, [ $path, $st[7], $st[9] ]);
8728                 }
8729         }
8730 closedir(CACHEDIR);
8731 @cached = sort { $a->[2] <=> $b->[2] } @cached;
8732 while($total+$size > $gconfig{'cache_size'} && @cached) {
8733         # Cache is too big .. delete some files until the new one will fit
8734         unlink($cached[0]->[0]);
8735         $total -= $cached[0]->[1];
8736         shift(@cached);
8737         }
8738
8739 # Finally, write out the new file
8740 if (ref($file)) {
8741         &open_tempfile(CACHEFILE, ">$cfile");
8742         &print_tempfile(CACHEFILE, $$file);
8743         &close_tempfile(CACHEFILE);
8744         }
8745 else {
8746         my ($ok, $err) = &copy_source_dest($file, $cfile);
8747         }
8748
8749 return 1;
8750 }
8751
8752 =head2 check_in_http_cache(url)
8753
8754 If some URL is in the cache and valid, return the filename for it. Mainly
8755 for internal use by http_download.
8756
8757 =cut
8758 sub check_in_http_cache
8759 {
8760 my ($url) = @_;
8761 return undef if (!$gconfig{'cache_size'});
8762
8763 # Check if the current module should do caching
8764 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
8765         # Caching all except some modules
8766         my @mods = split(/\s+/, $1);
8767         return 0 if (&indexof(&get_module_name(), @mods) != -1);
8768         }
8769 elsif ($gconfig{'cache_mods'}) {
8770         # Only caching some modules
8771         my @mods = split(/\s+/, $gconfig{'cache_mods'});
8772         return 0 if (&indexof(&get_module_name(), @mods) == -1);
8773         }
8774
8775 my $cfile = $url;
8776 $cfile =~ s/\//_/g;
8777 $cfile = "$main::http_cache_directory/$cfile";
8778 my @st = stat($cfile);
8779 return undef if (!@st || !$st[7]);
8780 if ($gconfig{'cache_days'} && time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
8781         # Too old!
8782         unlink($cfile);
8783         return undef;
8784         }
8785 open(TOUCH, ">>$cfile");        # Update the file time, to keep it in the cache
8786 close(TOUCH);
8787 return $cfile;
8788 }
8789
8790 =head2 supports_javascript
8791
8792 Returns 1 if the current browser is assumed to support javascript.
8793
8794 =cut
8795 sub supports_javascript
8796 {
8797 if (defined(&theme_supports_javascript)) {
8798         return &theme_supports_javascript();
8799         }
8800 return $ENV{'MOBILE_DEVICE'} ? 0 : 1;
8801 }
8802
8803 =head2 get_module_name
8804
8805 Returns the name of the Webmin module that called this function. For internal
8806 use only by other API functions.
8807
8808 =cut
8809 sub get_module_name
8810 {
8811 return &get_module_variable('$module_name');
8812 }
8813
8814 =head2 get_module_variable(name, [ref])
8815
8816 Returns the value of some variable which is set in the caller's context, if
8817 using the new WebminCore package. For internal use only.
8818
8819 =cut
8820 sub get_module_variable
8821 {
8822 my ($v, $wantref) = @_;
8823 my $slash = $wantref ? "\\" : "";
8824 my $thispkg = &web_libs_package();
8825 if ($thispkg eq 'WebminCore') {
8826         my ($vt, $vn) = split('', $v, 2);
8827         my $callpkg;
8828         for(my $i=0; ($callpkg) = caller($i); $i++) {
8829                 last if ($callpkg ne $thispkg);
8830                 }
8831         return eval "${slash}${vt}${callpkg}::${vn}";
8832         }
8833 return eval "${slash}${v}";
8834 }
8835
8836 =head2 clear_time_locale()
8837
8838 Temporarily force the locale to C, until reset_time_locale is called. This is
8839 useful if your code is going to call C<strftime> from the POSIX package, and
8840 you want to ensure that the output is in a consistent format.
8841
8842 =cut
8843 sub clear_time_locale
8844 {
8845 if ($main::clear_time_locale_count == 0) {
8846         eval {
8847                 use POSIX;
8848                 $main::clear_time_locale_old = POSIX::setlocale(POSIX::LC_TIME);
8849                 POSIX::setlocale(POSIX::LC_TIME, "C");
8850                 };
8851         }
8852 $main::clear_time_locale_count++;
8853 }
8854
8855 =head2 reset_time_locale()
8856
8857 Revert the locale to whatever it was before clear_time_locale was called
8858
8859 =cut
8860 sub reset_time_locale
8861 {
8862 if ($main::clear_time_locale_count == 1) {
8863         eval {
8864                 POSIX::setlocale(POSIX::LC_TIME, $main::clear_time_locale_old);
8865                 $main::clear_time_locale_old = undef;
8866                 };
8867         }
8868 $main::clear_time_locale_count--;
8869 }
8870
8871 =head2 callers_package(filehandle)
8872
8873 Convert a non-module filehandle like FOO to one qualified with the
8874 caller's caller's package, like fsdump::FOO. For internal use only.
8875
8876 =cut
8877 sub callers_package
8878 {
8879 my ($fh) = @_;
8880 my $callpkg = (caller(1))[0];
8881 my $thispkg = &web_libs_package();
8882 if (!ref($fh) && $fh !~ /::/ &&
8883     $callpkg ne $thispkg && $thispkg eq 'WebminCore') {
8884         $fh = $callpkg."::".$fh;
8885         }
8886 return $fh;
8887 }
8888
8889 =head2 web_libs_package()
8890
8891 Returns the package this code is in. We can't always trust __PACKAGE__. For
8892 internal use only.
8893
8894 =cut
8895 sub web_libs_package
8896 {
8897 if ($called_from_webmin_core) {
8898         return "WebminCore";
8899         }
8900 return __PACKAGE__;
8901 }
8902
8903 =head2 get_userdb_string
8904
8905 Returns the URL-style string for connecting to the users and groups database
8906
8907 =cut
8908 sub get_userdb_string
8909 {
8910 my %miniserv;
8911 &get_miniserv_config(\%miniserv);
8912 return $miniserv{'userdb'};
8913 }
8914
8915 =head2 connect_userdb(string)
8916
8917 Returns a handle for talking to a user database - may be a DBI or LDAP handle.
8918 On failure returns an error message string. In an array context, returns the
8919 protocol type too.
8920
8921 =cut
8922 sub connect_userdb
8923 {
8924 my ($str) = @_;
8925 my ($proto, $user, $pass, $host, $prefix, $args) = &split_userdb_string($str);
8926 if ($proto eq "mysql") {
8927         # Connect to MySQL with DBI
8928         my $drh = eval "use DBI; DBI->install_driver('mysql');";
8929         $drh || return $text{'sql_emysqldriver'};
8930         my ($host, $port) = split(/:/, $host);
8931         my $cstr = "database=$prefix;host=$host";
8932         $cstr .= ";port=$port" if ($port);
8933         my $dbh = $drh->connect($cstr, $user, $pass, { });
8934         $dbh || return &text('sql_emysqlconnect', $drh->errstr);
8935         return wantarray ? ($dbh, $proto) : $dbh;
8936         }
8937 elsif ($proto eq "postgresql") {
8938         # Connect to PostgreSQL with DBI
8939         my $drh = eval "use DBI; DBI->install_driver('Pg');";
8940         $drh || return $text{'sql_epostgresqldriver'};
8941         my ($host, $port) = split(/:/, $host);
8942         my $cstr = "dbname=$prefix;host=$host";
8943         $cstr .= ";port=$port" if ($port);
8944         my $dbh = $drh->connect($cstr, $user, $pass);
8945         $dbh || return &text('sql_epostgresqlconnect', $drh->errstr);
8946         return wantarray ? ($dbh, $proto) : $dbh;
8947         }
8948 elsif ($proto eq "ldap") {
8949         # XXX
8950         return "LDAP not done yet";
8951         }
8952 else {
8953         return "Unknown protocol $proto";
8954         }
8955 }
8956
8957 =head2 disconnect_userdb(string, &handle)
8958
8959 Closes a handle opened by connect_userdb
8960
8961 =cut
8962 sub disconnect_userdb
8963 {
8964 my ($str, $h) = @_;
8965 if ($str =~ /^(mysql|postgresql):/) {
8966         # DBI disconnnect
8967         $h->disconnect();
8968         }
8969 elsif ($str =~ /^ldap:/) {
8970         # LDAP disconnect
8971         $h->disconnect();
8972         }
8973 }
8974
8975 =head2 split_userdb_string(string)
8976
8977 Converts a string like mysql://user:pass@host/db into separate parts
8978
8979 =cut
8980 sub split_userdb_string
8981 {
8982 my ($str) = @_;
8983 if ($str =~ /^([a-z]+):\/\/([^:]*):([^\@]*)\@([a-z0-9\.\-\_]+)\/([^\?]+)(\?(.*))?$/) {
8984         my ($proto, $user, $pass, $host, $prefix, $argstr) =
8985                 ($1, $2, $3, $4, $5, $7);
8986         my %args = map { split(/=/, $_, 2) } split(/\&/, $argstr);
8987         return ($proto, $user, $pass, $host, $prefix, \%args);
8988         }
8989 return ( );
8990 }
8991
8992 $done_web_lib_funcs = 1;
8993
8994 1;