1 =head1 web-lib-funcs.pl
3 Common functions for Webmin CGI scripts. This file gets in-directly included
4 by all scripts that use web-lib.pl.
9 ui_print_header(undef, 'My Module', '');
10 print 'This is Webmin version ',get_webmin_version(),'<p>\n';
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);
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);
30 =head2 read_file(file, &hash, [&order], [lowercase], [split-char])
32 Fill the given hash reference with name=value pairs from a file. The required
35 =item file - The file to head, which must be text with each line like name=value
37 =item hash - The hash reference to add values read from the file to.
39 =item order - If given, an array reference to add names to in the order they were read
41 =item lowercase - If set to 1, names are converted to lower case
43 =item split-char - If set, names and values are split on this character instead of =
49 my $split = defined($_[4]) ? $_[4] : "=";
50 my $realfile = &translate_filename($_[0]);
51 &open_readfile(ARFILE, $_[0]) || return 0;
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);
60 $_[1]->{$_[3] ? lc($n) : $n} = $v;
61 push(@{$_[2]}, $n) if ($_[2]);
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]};
72 =head2 read_file_cached(file, &hash, [&order], [lowercase], [split-char])
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.
81 my $realfile = &translate_filename($_[0]);
82 if (defined($main::read_file_cache{$realfile})) {
84 %{$_[1]} = ( %{$_[1]}, %{$main::read_file_cache{$realfile}} );
87 elsif ($main::read_file_missing{$realfile}) {
88 # Doesn't exist, so don't re-try read
92 # Actually read the file
94 if (&read_file($_[0], \%d, $_[2], $_[3], $_[4])) {
95 %{$main::read_file_cache{$realfile}} = %d;
96 %{$_[1]} = ( %{$_[1]}, %d );
100 # Flag as non-existant
101 $main::read_file_missing{$realfile} = 1;
107 =head2 write_file(file, &hash, [join-char])
109 Write out the contents of a hash as name=value lines. The parameters are :
111 =item file - Full path to write to
113 =item hash - A hash reference containing names and values to output
115 =item join-char - If given, names and values are separated by this instead of =
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, $!));
131 foreach $k (keys %{$_[1]}) {
132 if (!exists($old{$k})) {
133 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
134 &error(&text("efilewrite", $realfile, $!));
137 &close_tempfile(ARFILE);
138 if (defined($main::read_file_cache{$realfile})) {
139 %{$main::read_file_cache{$realfile}} = %{$_[1]};
141 if (defined($main::read_file_missing{$realfile})) {
142 $main::read_file_missing{$realfile} = 0;
146 =head2 html_escape(string)
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.
158 $tmp =~ s/\"/"/g;
159 $tmp =~ s/\'/'/g;
164 =head2 quote_escape(string, [only-quote])
166 Converts ' and " characters in a string into HTML entities, and returns it.
167 Useful for outputing HTML tag values.
172 my ($tmp, $only) = @_;
173 if ($tmp !~ /\&[a-zA-Z]+;/ && $tmp !~ /\&#/) {
174 # convert &, unless it is part of &#nnn; or &foo;
175 $tmp =~ s/&([^#])/&$1/g;
177 $tmp =~ s/&$/&/g;
178 $tmp =~ s/\"/"/g if ($only eq '' || $only eq '"');
179 $tmp =~ s/\'/'/g if ($only eq '' || $only eq "'");
183 =head2 tempname([filename])
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.
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($<) :
203 if ($gconfig{'os_type'} eq 'windows' || $tmp_dir =~ /^[a-z]:/i) {
204 # On Windows system, just create temp dir if missing
206 mkdir($tmp_dir, 0755) ||
207 &error("Failed to create temp directory $tmp_dir : $!");
211 # On Unix systems, need to make sure temp dir is valid
213 while($tries++ < 10) {
214 my @st = lstat($tmp_dir);
215 last if ($st[4] == $< && (-d _) && ($st[2] & 0777) == 0755);
217 unlink($tmp_dir) || rmdir($tmp_dir) ||
218 system("/bin/rm -rf ".quotemeta($tmp_dir));
220 mkdir($tmp_dir, 0755) || next;
221 chown($<, $(, $tmp_dir);
222 chmod(0755, $tmp_dir);
225 my @st = lstat($tmp_dir);
226 &error("Failed to create temp directory $tmp_dir : uid=$st[4] mode=$st[2]");
230 if (defined($_[0]) && $_[0] !~ /\.\./) {
231 $rv = "$tmp_dir/$_[0]";
234 $main::tempfilecount++;
236 $rv = $tmp_dir."/".int(rand(1000000))."_".
237 $main::tempfilecount."_".$scriptname;
242 =head2 transname([filename])
244 Behaves exactly like tempname, but records the temp file for deletion when the
245 current Webmin script process exits.
250 my $rv = &tempname(@_);
251 push(@main::temporary_files, $rv);
255 =head2 trunc(string, maxlen)
257 Truncates a string to the shortest whole word less than or equal to the
258 given width. Useful for word wrapping.
263 if (length($_[0]) <= $_[1]) {
266 my $str = substr($_[0],0,$_[1]);
275 =head2 indexof(string, value, ...)
277 Returns the index of some value in an array of values, or -1 if it was not
283 for(my $i=1; $i <= $#_; $i++) {
284 if ($_[$i] eq $_[0]) { return $i - 1; }
289 =head2 indexoflc(string, value, ...)
291 Like indexof, but does a case-insensitive match
296 my $str = lc(shift(@_));
297 my @arr = map { lc($_) } @_;
298 return &indexof($str, @arr);
301 =head2 sysprint(handle, [string]+)
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.
309 my $fh = &callers_package($_[0]);
310 my $str = join('', @_[1..$#_]);
311 syswrite $fh, $str, length($str);
314 =head2 check_ipaddress(ip)
316 Check if some IPv4 address is properly formatted, returning 1 if so or 0 if not.
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;
328 =head2 check_ip6address(ip)
330 Check if some IPv6 address is properly formatted, and returns 1 if so.
335 my @blocks = split(/:/, $_[0]);
336 return 0 if (@blocks == 0 || @blocks > 8);
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].
342 my $where = index($blocks[$ib],"/");
345 my $b = substr($blocks[$ib],0,$where);
346 $m = substr($blocks[$ib],$where+1,length($blocks[$ib])-($where+1));
350 # The netmask must take its value in [0;128]
351 return 0 if ($m <0 || $m >128);
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 "::".
357 foreach $b (@blocks) {
358 return 0 if ($b ne "" && $b !~ /^[0-9a-f]{1,4}$/i);
359 $empty++ if ($b eq "");
361 return 0 if ($empty > 1 && !($_[0] =~ /^::/ && $empty == 2));
367 =head2 generate_icon(image, title, link, [href], [width], [height], [before-title], [after-title])
369 Prints HTML for an icon image. The parameters are :
371 =item image - URL for the image, like images/foo.gif
373 =item title - Text to appear under the icon
375 =item link - Optional destination for the icon's link
377 =item href - Other HTML attributes to be added to the <a href> for the link
379 =item width - Optional width of the icon
381 =item height - Optional height of the icon
383 =item before-title - HTML to appear before the title link, but which is not actually in the link
385 =item after-title - HTML to appear after the title link, but which is not actually in the link
390 &load_theme_library();
391 if (defined(&theme_generate_icon)) {
392 &theme_generate_icon(@_);
395 my $w = !defined($_[4]) ? "width=48" : $_[4] ? "width=$_[4]" : "";
396 my $h = !defined($_[5]) ? "height=48" : $_[5] ? "height=$_[5]" : "";
397 if ($tconfig{'noicons'}) {
399 print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
402 print "$_[6]$_[1]$_[7]\n";
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";
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";
420 Converts a string to a form ok for putting in a URL, using % escaping.
426 $rv =~ s/([^A-Za-z0-9])/sprintf("%%%2.2X", ord($1))/ge;
430 =head2 un_urlize(string)
432 Converts a URL-encoded string to it's original contents - the reverse of the
440 $rv =~ s/%(..)/pack("c",hex($1))/ge;
444 =head2 include(filename)
446 Read and output the contents of the given file.
452 open(INCLUDE, &translate_filename($_[0])) || return 0;
460 =head2 copydata(in-handle, out-handle)
462 Read from one file handle and write to another, until there is no more to read.
468 $in = &callers_package($in);
469 $out = &callers_package($out);
471 while(read($in, $buf, 1024) > 0) {
472 (print $out $buf) || return 0;
477 =head2 ReadParseMime([maximum], [&cbfunc, &cbargs])
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 :
482 =item maximum - If the number of bytes of input exceeds this number, stop reading and call error.
484 =item cbfunc - A function reference to call after reading each block of data.
486 =item cbargs - Additional parameters to the callback function.
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) {
498 &$cbfunc(0, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
500 <STDIN>; # skip first boundary
503 # Read section headers
507 $got += length($line);
508 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, @$cbargs) if ($cbfunc);
509 if ($max && $got > $max) {
514 if ($line =~ /^(\S+):\s*(.*)$/) {
515 $header{$lastheader = lc($1)} = $2;
517 elsif ($line =~ /^\s+(.*)$/) {
518 $header{$lastheader} .= $line;
522 # Parse out filename and type
523 if ($header{'content-disposition'} =~ /^form-data(.*)/) {
525 while ($rest =~ /([a-zA-Z]*)=\"([^\"]*)\"(.*)/) {
530 $foo = $name . "_$1";
537 &error($text{'readparse_cdheader'});
539 if ($header{'content-type'} =~ /^([^\s;]+)/) {
540 $foo = $name . "_content_type";
543 $file = $in{$name."_filename"};
546 $in{$name} .= "\0" if (defined($in{$name}));
549 $got += length($line);
550 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
552 if ($max && $got > $max) {
553 #print STDERR "over limit of $max\n";
558 &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
563 $ptline =~ s/[^a-zA-Z0-9\-]/\./g;
564 if (index($line, $boundary) != -1) { last; }
567 chop($in{$name}); chop($in{$name});
568 if (index($line,"$boundary--") != -1) { last; }
570 &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
573 =head2 ReadParse([&hash], [method], [noplus])
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
579 =item method - For use of this HTTP method, such as GET
581 =item noplus - Don't convert + in parameters to spaces.
586 my $a = $_[0] || \%in;
588 my $meth = $_[1] ? $_[1] : $ENV{'REQUEST_METHOD'};
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 : $!");
595 if ($ENV{'QUERY_STRING'}) {
596 if ($in) { $in .= "&".$ENV{'QUERY_STRING'}; }
597 else { $in = $ENV{'QUERY_STRING'}; }
599 @in = split(/\&/, $in);
600 foreach my $i (@in) {
601 my ($k, $v) = split(/=/, $i, 2);
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;
612 =head2 read_fully(fh, &buffer, length)
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.
621 my ($fh, $buf, $len) = @_;
622 $fh = &callers_package($fh);
625 my $r = read(STDIN, $$buf, $len-$got, $got);
632 =head2 read_parse_mime_callback(size, totalsize, upload-id)
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
639 sub read_parse_mime_callback
641 my ($size, $totalsize, $filename, $id) = @_;
642 return if ($gconfig{'no_upload_tracker'});
645 # Create the upload tracking directory - if running as non-root, this has to
646 # be under the user's home
649 my @uinfo = @remote_user_info ? @remote_user_info : getpwuid($<);
650 $vardir = "$uinfo[7]/.tmp";
653 $vardir = $ENV{'WEBMIN_VAR'};
656 &make_dir($vardir, 0755);
659 # Remove any upload.* files more than 1 hour old
660 if (!$main::read_parse_mime_callback_flushed) {
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");
671 $main::read_parse_mime_callback_flushed++;
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}) {
681 $main::read_parse_mime_callback_pc{$upfile} = $pc;
685 &open_tempfile(UPFILE, ">$upfile");
686 print UPFILE $size,"\n";
687 print UPFILE $totalsize,"\n";
688 print UPFILE $filename,"\n";
689 &close_tempfile(UPFILE);
692 =head2 read_parse_mime_javascript(upload-id, [&fields])
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.
698 sub read_parse_mime_javascript
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\");";
704 my $if = join(" || ", map { "typeof($_) != \"undefined\" && $_.value != \"\"" } @$fields);
705 return "onSubmit='if ($if) { $opener }'";
708 return "onSubmit='$opener'";
712 =head2 PrintHeader(charset)
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.
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";
727 if (defined($_[0])) {
728 print "Content-type: text/html; Charset=$_[0]\n\n";
731 print "Content-type: text/html\n\n";
735 =head2 header(title, image, [help], [config], [nomodule], [nowebmin], [rightside], [head-stuff], [body-stuff], [below])
737 Outputs a Webmin HTML page header with a title, including HTTP headers. The
740 =item title - The text to show at the top of the page
742 =item image - An image to show instead of the title text. This is typically left blank.
744 =item help - If set, this is the name of a help page that will be linked to in the title.
746 =item config - If set to 1, the title will contain a link to the module's config page.
748 =item nomodule - If set to 1, there will be no link in the title section to the module's index.
750 =item nowebmin - If set to 1, there will be no link in the title section to the Webmin index.
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.
754 =item head-stuff - HTML to be included in the <head> section of the page.
756 =item body-stuff - HTML attributes to be include in the <body> tag.
758 =item below - HTML to be displayed below the title. Typically this is used for application or server version information.
763 return if ($main::done_webmin_header++);
765 my $charset = defined($main::force_charset) ? $main::force_charset
767 &PrintHeader($charset);
768 &load_theme_library();
769 if (defined(&theme_header)) {
770 $module_name = &get_module_name();
774 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
777 if (defined(&theme_prehead)) {
781 print "<meta http-equiv=\"Content-Type\" ",
782 "content=\"text/html; Charset="."e_escape($charset)."\">\n";
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);
790 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
791 if ($tconfig{'headinclude'}) {
793 open(INC, "$theme_root_directory/$tconfig{'headinclude'}");
800 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
801 defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
802 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
803 defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
804 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
805 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
806 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
808 my $dir = $current_lang_info->{'dir'} ? "dir=\"$current_lang_info->{'dir'}\""
810 print "<body bgcolor=#$bgcolor link=#$link vlink=#$link text=#$text ",
811 "$bgimage $tconfig{'inbody'} $dir $_[8]>\n";
812 if (defined(&theme_prebody)) {
815 my $hostname = &get_display_hostname();
816 my $version = &get_webmin_version();
817 my $prebody = $tconfig{'prebody'};
819 $prebody =~ s/%HOSTNAME%/$hostname/g;
820 $prebody =~ s/%VERSION%/$version/g;
821 $prebody =~ s/%USER%/$remote_user/g;
822 $prebody =~ s/%OS%/$os_type $os_version/g;
825 if ($tconfig{'prebodyinclude'}) {
827 open(INC, "$theme_root_directory/$tconfig{'prebodyinclude'}");
834 print $tconfig{'preheader'};
835 my %this_module_info = &get_module_info(&get_module_name());
836 print "<table class='header' width=100%><tr>\n";
837 if ($gconfig{'sysinfo'} == 2 && $remote_user) {
838 print "<td id='headln1' colspan=3 align=center>\n";
839 print &get_html_status_line(1);
840 print "</td></tr> <tr>\n";
842 print "<td id='headln2l' width=15% valign=top align=left>";
843 if ($ENV{'HTTP_WEBMIN_SERVERS'} && !$tconfig{'framed'}) {
844 print "<a href='$ENV{'HTTP_WEBMIN_SERVERS'}'>",
845 "$text{'header_servers'}</a><br>\n";
847 if (!$_[5] && !$tconfig{'noindex'}) {
848 my @avail = &get_available_module_infos(1);
849 my $nolo = $ENV{'ANONYMOUS_USER'} ||
850 $ENV{'SSL_USER'} || $ENV{'LOCAL_USER'} ||
851 $ENV{'HTTP_USER_AGENT'} =~ /webmin/i;
852 if ($gconfig{'gotoone'} && $main::session_id && @avail == 1 &&
854 print "<a href='$gconfig{'webprefix'}/session_login.cgi?logout=1'>",
855 "$text{'main_logout'}</a><br>";
857 elsif ($gconfig{'gotoone'} && @avail == 1 && !$nolo) {
858 print "<a href=$gconfig{'webprefix'}/switch_user.cgi>",
859 "$text{'main_switch'}</a><br>";
861 elsif (!$gconfig{'gotoone'} || @avail > 1) {
862 print "<a href='$gconfig{'webprefix'}/?cat=",
863 $this_module_info{'category'},
864 "'>$text{'header_webmin'}</a><br>\n";
867 if (!$_[4] && !$tconfig{'nomoduleindex'}) {
868 my $idx = $this_module_info{'index_link'};
869 my $mi = $module_index_link || "/".&get_module_name()."/$idx";
870 my $mt = $module_index_name || $text{'header_module'};
871 print "<a href=\"$gconfig{'webprefix'}$mi\">$mt</a><br>\n";
873 if (ref($_[2]) eq "ARRAY" && !$ENV{'ANONYMOUS_USER'} &&
874 !$tconfig{'nohelp'}) {
875 print &hlink($text{'header_help'}, $_[2]->[0], $_[2]->[1]),
878 elsif (defined($_[2]) && !$ENV{'ANONYMOUS_USER'} &&
879 !$tconfig{'nohelp'}) {
880 print &hlink($text{'header_help'}, $_[2]),"<br>\n";
883 my %access = &get_module_acl();
884 if (!$access{'noconfig'} && !$config{'noprefs'}) {
885 my $cprog = $user_module_config_directory ?
886 "uconfig.cgi" : "config.cgi";
887 print "<a href=\"$gconfig{'webprefix'}/$cprog?",
888 &get_module_name()."\">",
889 $text{'header_config'},"</a><br>\n";
894 # Title is a single image
895 print "<td id='headln2c' align=center width=70%>",
896 "<img alt=\"$_[0]\" src=\"$_[1]\"></td>\n";
900 my $ts = defined($tconfig{'titlesize'}) ?
901 $tconfig{'titlesize'} : "+2";
902 print "<td id='headln2c' align=center width=70%>",
903 ($ts ? "<font size=$ts>" : ""),$_[0],
904 ($ts ? "</font>" : "");
905 print "<br>$_[9]\n" if ($_[9]);
908 print "<td id='headln2r' width=15% valign=top align=right>";
910 print "</td></tr></table>\n";
911 print $tconfig{'postheader'};
915 =head2 get_html_title(title)
917 Returns the full string to appear in the HTML <title> block.
924 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
925 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
926 if ($gconfig{'sysinfo'} == 1 && $remote_user) {
927 $title = sprintf "%s : %s on %s (%s %s)\n",
928 $msg, $remote_user, &get_display_hostname(),
929 $os_type, $os_version;
931 elsif ($gconfig{'sysinfo'} == 4 && $remote_user) {
932 $title = sprintf "%s on %s (%s %s)\n",
933 $remote_user, &get_display_hostname(),
934 $os_type, $os_version;
939 if ($gconfig{'showlogin'} && $remote_user) {
940 $title = $remote_user." : ".$title;
945 =head2 get_html_framed_title
947 Returns the title text for a framed theme main page.
950 sub get_html_framed_title
953 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
954 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
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;
963 # Title like 'Webmin x.yy on hostname (Linux 6)'
964 if ($os_version eq "*") {
968 $ostr = "$os_type $os_version";
970 my $host = &get_display_hostname();
971 $title = $gconfig{'nohostname'} ? $text{'main_title2'} :
972 &text('main_title', &get_webmin_version(), $host, $ostr);
973 if ($gconfig{'showlogin'}) {
974 $title = $remote_user." : ".$title;
980 =head2 get_html_status_line(text-only)
982 Returns HTML for a script block that sets the status line, or if text-only
983 is set to 1, just return the status line text.
986 sub get_html_status_line
989 if (($gconfig{'sysinfo'} != 0 || !$remote_user) && !$textonly) {
990 # Disabled in this mode
993 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
994 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
995 my $line = &text('header_statusmsg',
996 ($ENV{'ANONYMOUS_USER'} ? "Anonymous user"
998 ($ENV{'SSL_USER'} ? " (SSL certified)" :
999 $ENV{'LOCAL_USER'} ? " (Local user)" : ""),
1000 $text{'programname'},
1001 &get_webmin_version(),
1002 &get_display_hostname(),
1003 $os_type.($os_version eq "*" ? "" :" $os_version"));
1008 $line =~ s/\r|\n//g;
1009 return "<script language=JavaScript type=text/javascript>\n".
1010 "defaultStatus=\""."e_escape($line)."\";\n".
1015 =head2 popup_header([title], [head-stuff], [body-stuff])
1017 Outputs a page header, suitable for a popup window. If no title is given,
1018 absolutely no decorations are output. Also useful in framesets. The parameters
1021 =item title - Title text for the popup window.
1023 =item head-stuff - HTML to appear in the <head> section.
1025 =item body-stuff - HTML attributes to be include in the <body> tag.
1030 return if ($main::done_webmin_header++);
1032 my $charset = defined($main::force_charset) ? $main::force_charset
1034 &PrintHeader($charset);
1035 &load_theme_library();
1036 if (defined(&theme_popup_header)) {
1037 &theme_popup_header(@_);
1040 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
1043 if (defined(&theme_popup_prehead)) {
1044 &theme_popup_prehead(@_);
1046 print "<title>$_[0]</title>\n";
1048 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
1049 if ($tconfig{'headinclude'}) {
1051 open(INC, "$theme_root_directory/$tconfig{'headinclude'}");
1058 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
1059 defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
1060 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
1061 defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
1062 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1063 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1064 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
1066 print "<body id='popup' bgcolor=#$bgcolor link=#$link vlink=#$link ",
1067 "text=#$text $bgimage $tconfig{'inbody'} $_[2]>\n";
1068 if (defined(&theme_popup_prebody)) {
1069 &theme_popup_prebody(@_);
1073 =head2 footer([page, name]+, [noendbody])
1075 Outputs the footer for a Webmin HTML page, possibly with links back to other
1076 pages. The links are specified by pairs of parameters, the first of which is
1077 a link destination, and the second the link text. For example :
1079 footer('/', 'Webmin index', '', 'Module menu');
1084 &load_theme_library();
1085 my %this_module_info = &get_module_info(&get_module_name());
1086 if (defined(&theme_footer)) {
1087 $module_name = &get_module_name(); # Old themes use these
1088 %module_info = %this_module_info;
1092 for(my $i=0; $i+1<@_; $i+=2) {
1094 if ($url ne '/' || !$tconfig{'noindex'}) {
1096 $url = "/?cat=$this_module_info{'category'}";
1098 elsif ($url eq '' && &get_module_name()) {
1099 $url = "/".&get_module_name()."/".
1100 $this_module_info{'index_link'};
1102 elsif ($url =~ /^\?/ && &get_module_name()) {
1103 $url = "/".&get_module_name()."/$url";
1105 $url = "$gconfig{'webprefix'}$url" if ($url =~ /^\//);
1107 print "<a href=\"$url\"><img alt=\"<-\" align=middle border=0 src=$gconfig{'webprefix'}/images/left.gif></a>\n";
1112 print " <a href=\"$url\">",&text('main_return', $_[$i+1]),"</a>\n";
1117 my $postbody = $tconfig{'postbody'};
1119 my $hostname = &get_display_hostname();
1120 my $version = &get_webmin_version();
1121 my $os_type = $gconfig{'real_os_type'} ||
1122 $gconfig{'os_type'};
1123 my $os_version = $gconfig{'real_os_version'} ||
1124 $gconfig{'os_version'};
1125 $postbody =~ s/%HOSTNAME%/$hostname/g;
1126 $postbody =~ s/%VERSION%/$version/g;
1127 $postbody =~ s/%USER%/$remote_user/g;
1128 $postbody =~ s/%OS%/$os_type $os_version/g;
1129 print "$postbody\n";
1131 if ($tconfig{'postbodyinclude'}) {
1133 open(INC, "$theme_root_directory/$tconfig{'postbodyinclude'}");
1139 if (defined(&theme_postbody)) {
1140 &theme_postbody(@_);
1142 print "</body></html>\n";
1148 Outputs html for a footer for a popup window, started by popup_header.
1153 &load_theme_library();
1154 if (defined(&theme_popup_footer)) {
1155 &theme_popup_footer(@_);
1158 print "</body></html>\n";
1161 =head2 load_theme_library
1163 Immediately loads the current theme's theme.pl file. Not generally useful for
1164 most module developers, as this is called automatically by the header function.
1167 sub load_theme_library
1169 return if (!$current_theme || $loaded_theme_library++);
1170 for(my $i=0; $i<@theme_root_directories; $i++) {
1171 if ($theme_configs[$i]->{'functions'}) {
1172 do $theme_root_directories[$i]."/".
1173 $theme_configs[$i]->{'functions'};
1178 =head2 redirect(url)
1180 Output HTTP headers to redirect the browser to some page. The url parameter is
1181 typically a relative URL like index.cgi or list_users.cgi.
1186 my $port = $ENV{'SERVER_PORT'} == 443 && uc($ENV{'HTTPS'}) eq "ON" ? "" :
1187 $ENV{'SERVER_PORT'} == 80 && uc($ENV{'HTTPS'}) ne "ON" ? "" :
1188 ":$ENV{'SERVER_PORT'}";
1189 my $prot = uc($ENV{'HTTPS'}) eq "ON" ? "https" : "http";
1190 my $wp = $gconfig{'webprefixnoredir'} ? undef : $gconfig{'webprefix'};
1192 if ($_[0] =~ /^(http|https|ftp|gopher):/) {
1193 # Absolute URL (like http://...)
1196 elsif ($_[0] =~ /^\//) {
1197 # Absolute path (like /foo/bar.cgi)
1198 $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$_[0]";
1200 elsif ($ENV{'SCRIPT_NAME'} =~ /^(.*)\/[^\/]*$/) {
1201 # Relative URL (like foo.cgi)
1202 $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$1/$_[0]";
1205 $url = "$prot://$ENV{'SERVER_NAME'}$port/$wp$_[0]";
1207 &load_theme_library();
1208 if (defined(&theme_redirect)) {
1209 $module_name = &get_module_name(); # Old themes use these
1210 %module_info = &get_module_info($module_name);
1211 &theme_redirect($_[0], $url);
1214 print "Location: $url\n\n";
1218 =head2 kill_byname(name, signal)
1220 Finds a process whose command line contains the given name (such as httpd), and
1221 sends some signal to it. The signal can be numeric (like 9) or named
1227 my @pids = &find_byname($_[0]);
1228 return scalar(@pids) if (&is_readonly_mode());
1229 &webmin_debug_log('KILL', "signal=$_[1] name=$_[0]")
1230 if ($gconfig{'debug_what_procs'});
1231 if (@pids) { kill($_[1], @pids); return scalar(@pids); }
1235 =head2 kill_byname_logged(name, signal)
1237 Like kill_byname, but also logs the killing.
1240 sub kill_byname_logged
1242 my @pids = &find_byname($_[0]);
1243 return scalar(@pids) if (&is_readonly_mode());
1244 if (@pids) { &kill_logged($_[1], @pids); return scalar(@pids); }
1248 =head2 find_byname(name)
1250 Finds processes searching for the given name in their command lines, and
1251 returns a list of matching PIDs.
1256 if ($gconfig{'os_type'} =~ /-linux$/ && -r "/proc/$$/cmdline") {
1257 # Linux with /proc filesystem .. use cmdline files, as this is
1258 # faster than forking
1260 opendir(PROCDIR, "/proc");
1261 foreach my $f (readdir(PROCDIR)) {
1262 if ($f eq int($f) && $f != $$) {
1263 my $line = &read_file_contents("/proc/$f/cmdline");
1264 if ($line =~ /$_[0]/) {
1273 if (&foreign_check("proc")) {
1274 # Call the proc module
1275 &foreign_require("proc", "proc-lib.pl");
1276 if (defined(&proc::list_processes)) {
1277 my @procs = &proc::list_processes();
1279 foreach my $p (@procs) {
1280 if ($p->{'args'} =~ /$_[0]/) {
1281 push(@pids, $p->{'pid'});
1284 @pids = grep { $_ != $$ } @pids;
1289 # Fall back to running a command
1291 $cmd = $gconfig{'find_pid_command'};
1292 $cmd =~ s/NAME/"$_[0]"/g;
1293 $cmd = &translate_command($cmd);
1294 @pids = split(/\n/, `($cmd) <$null_file 2>$null_file`);
1295 @pids = grep { $_ != $$ } @pids;
1299 =head2 error([message]+)
1301 Display an error message and exit. This should be used by CGI scripts that
1302 encounter a fatal error or invalid user input to notify users of the problem.
1303 If error_setup has been called, the displayed error message will be prefixed
1304 by the message setup using that function.
1309 my $msg = join("", @_);
1310 $msg =~ s/<[^>]*>//g;
1311 if (!$main::error_must_die) {
1312 print STDERR "Error: ",$msg,"\n";
1314 &load_theme_library();
1315 if ($main::error_must_die) {
1316 if ($gconfig{'error_stack'}) {
1317 print STDERR "Error: ",$msg,"\n";
1318 for(my $i=0; my @stack = caller($i); $i++) {
1319 print STDERR "File: $stack[1] Line: $stack[2] ",
1320 "Function: $stack[3]\n";
1325 elsif (!$ENV{'REQUEST_METHOD'}) {
1326 # Show text-only error
1327 print STDERR "$text{'error'}\n";
1328 print STDERR "-----\n";
1329 print STDERR ($main::whatfailed ? "$main::whatfailed : " : ""),
1331 print STDERR "-----\n";
1332 if ($gconfig{'error_stack'}) {
1334 print STDERR $text{'error_stack'},"\n";
1335 for(my $i=0; my @stack = caller($i); $i++) {
1336 print STDERR &text('error_stackline',
1337 $stack[1], $stack[2], $stack[3]),"\n";
1342 elsif (defined(&theme_error)) {
1346 &header($text{'error'}, "");
1348 print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),
1350 if ($gconfig{'error_stack'}) {
1352 print "<h3>$text{'error_stack'}</h3>\n";
1354 print "<tr> <td><b>$text{'error_file'}</b></td> ",
1355 "<td><b>$text{'error_line'}</b></td> ",
1356 "<td><b>$text{'error_sub'}</b></td> </tr>\n";
1357 for($i=0; my @stack = caller($i); $i++) {
1359 print "<td>$stack[1]</td>\n";
1360 print "<td>$stack[2]</td>\n";
1361 print "<td>$stack[3]</td>\n";
1367 if ($ENV{'HTTP_REFERER'} && $main::completed_referers_check) {
1368 &footer($ENV{'HTTP_REFERER'}, $text{'error_previous'});
1374 &unlock_all_files();
1375 &cleanup_tempnames();
1379 =head2 popup_error([message]+)
1381 This function is almost identical to error, but displays the message with HTML
1382 headers suitable for a popup window.
1387 &load_theme_library();
1388 if ($main::error_must_die) {
1391 elsif (defined(&theme_popup_error)) {
1392 &theme_popup_error(@_);
1395 &popup_header($text{'error'}, "");
1396 print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),@_,"</h3>\n";
1399 &unlock_all_files();
1400 &cleanup_tempnames();
1404 =head2 error_setup(message)
1406 Registers a message to be prepended to all error messages displayed by the
1412 $main::whatfailed = $_[0];
1415 =head2 wait_for(handle, regexp, regexp, ...)
1417 Reads from the input stream until one of the regexps matches, and returns the
1418 index of the matching regexp, or -1 if input ended before any matched. This is
1419 very useful for parsing the output of interactive programs, and can be used with
1420 a two-way pipe to feed input to a program in response to output matched by
1423 If the matching regexp contains bracketed sub-expressions, their values will
1424 be placed in the global array @matches, indexed starting from 1. You cannot
1425 use the Perl variables $1, $2 and so on to capture matches.
1429 $rv = wait_for($loginfh, "username:");
1431 error("Didn't get username prompt");
1433 print $loginfh "joe\n";
1434 $rv = wait_for($loginfh, "password:");
1436 error("Didn't get password prompt");
1438 print $loginfh "smeg\n";
1443 my ($c, $i, $sw, $rv, $ha);
1444 undef($wait_for_input);
1445 if ($wait_for_debug) {
1446 print STDERR "wait_for(",join(",", @_),")\n";
1448 $ha = &callers_package($_[0]);
1449 if ($wait_for_debug) {
1450 print STDERR "File handle=$ha fd=",fileno($ha),"\n";
1455 " if ((\$c = getc(\$ha)) eq \"\") { return -1; }\n".
1456 " \$wait_for_input .= \$c;\n";
1457 if ($wait_for_debug) {
1458 $codes .= "print STDERR \$wait_for_input,\"\\n\";";
1460 for($i=1; $i<@_; $i++) {
1461 $sw = $i>1 ? "elsif" : "if";
1462 $codes .= " $sw (\$wait_for_input =~ /$_[$i]/i) { \$hit = $i-1; }\n";
1465 " if (defined(\$hit)) {\n".
1466 " \@matches = (-1, \$1, \$2, \$3, \$4, \$5, \$6, \$7, \$8, \$9);\n".
1472 &error("wait_for error : $@\n");
1477 =head2 fast_wait_for(handle, string, string, ...)
1479 This function behaves very similar to wait_for (documented above), but instead
1480 of taking regular expressions as parameters, it takes strings. As soon as the
1481 input contains one of them, it will return the index of the matching string.
1482 If the input ends before any match, it returns -1.
1487 my ($inp, $maxlen, $ha, $i, $c, $inpl);
1488 for($i=1; $i<@_; $i++) {
1489 $maxlen = length($_[$i]) > $maxlen ? length($_[$i]) : $maxlen;
1493 if (($c = getc($ha)) eq "") {
1494 &error("fast_wait_for read error : $!");
1497 if (length($inp) > $maxlen) {
1498 $inp = substr($inp, length($inp)-$maxlen);
1500 $inpl = length($inp);
1501 for($i=1; $i<@_; $i++) {
1502 if ($_[$i] eq substr($inp, $inpl-length($_[$i]))) {
1509 =head2 has_command(command)
1511 Returns the full path to the executable if some command is in the path, or
1512 undef if not found. If the given command is already an absolute path and
1513 exists, then the same path will be returned.
1518 if (!$_[0]) { return undef; }
1519 if (exists($main::has_command_cache{$_[0]})) {
1520 return $main::has_command_cache{$_[0]};
1523 my $slash = $gconfig{'os_type'} eq 'windows' ? '\\' : '/';
1524 if ($_[0] =~ /^\// || $_[0] =~ /^[a-z]:[\\\/]/i) {
1525 # Absolute path given - just use it
1526 my $t = &translate_filename($_[0]);
1527 $rv = (-x $t && !-d _) ? $_[0] : undef;
1530 # Check each directory in the path
1532 foreach my $d (split($path_separator, $ENV{'PATH'})) {
1533 next if ($donedir{$d}++);
1534 $d =~ s/$slash$// if ($d ne $slash);
1535 my $t = &translate_filename("$d/$_[0]");
1536 if (-x $t && !-d _) {
1537 $rv = $d.$slash.$_[0];
1540 if ($gconfig{'os_type'} eq 'windows') {
1541 foreach my $sfx (".exe", ".com", ".bat") {
1542 my $t = &translate_filename("$d/$_[0]").$sfx;
1543 if (-r $t && !-d _) {
1544 $rv = $d.$slash.$_[0].$sfx;
1551 $main::has_command_cache{$_[0]} = $rv;
1555 =head2 make_date(seconds, [date-only], [fmt])
1557 Converts a Unix date/time in seconds to a human-readable form, by default
1558 formatted like dd/mmm/yyyy hh:mm:ss. Parameters are :
1560 =item seconds - Unix time is seconds to convert.
1562 =item date-only - If set to 1, exclude the time from the returned string.
1564 =item fmt - Optional, one of dd/mon/yyyy, dd/mm/yyyy, mm/dd/yyyy or yyyy/mm/dd
1569 my ($secs, $only, $fmt) = @_;
1570 my @tm = localtime($secs);
1573 $fmt = $gconfig{'dateformat'} || 'dd/mon/yyyy';
1575 if ($fmt eq 'dd/mon/yyyy') {
1576 $date = sprintf "%2.2d/%s/%4.4d",
1577 $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900;
1579 elsif ($fmt eq 'dd/mm/yyyy') {
1580 $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[3], $tm[4]+1, $tm[5]+1900;
1582 elsif ($fmt eq 'mm/dd/yyyy') {
1583 $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[4]+1, $tm[3], $tm[5]+1900;
1585 elsif ($fmt eq 'yyyy/mm/dd') {
1586 $date = sprintf "%4.4d/%2.2d/%2.2d", $tm[5]+1900, $tm[4]+1, $tm[3];
1589 $date .= sprintf " %2.2d:%2.2d", $tm[2], $tm[1];
1594 =head2 file_chooser_button(input, type, [form], [chroot], [addmode])
1596 Return HTML for a button that pops up a file chooser when clicked, and places
1597 the selected filename into another HTML field. The parameters are :
1599 =item input - Name of the form field to store the filename in.
1601 =item type - 0 for file or directory chooser, or 1 for directory only.
1603 =item form - Index of the form containing the button.
1605 =item chroot - If set to 1, the chooser will be limited to this directory.
1607 =item addmode - If set to 1, the selected filename will be appended to the text box instead of replacing it's contents.
1610 sub file_chooser_button
1612 return &theme_file_chooser_button(@_)
1613 if (defined(&theme_file_chooser_button));
1614 my $form = defined($_[2]) ? $_[2] : 0;
1615 my $chroot = defined($_[3]) ? $_[3] : "/";
1616 my $add = int($_[4]);
1617 my ($w, $h) = (400, 300);
1618 if ($gconfig{'db_sizefile'}) {
1619 ($w, $h) = split(/x/, $gconfig{'db_sizefile'});
1621 return "<input type=button onClick='ifield = form.$_[0]; chooser = window.open(\"$gconfig{'webprefix'}/chooser.cgi?add=$add&type=$_[1]&chroot=$chroot&file=\"+escape(ifield.value), \"chooser\", \"toolbar=no,menubar=no,scrollbars=no,resizable=yes,width=$w,height=$h\"); chooser.ifield = ifield; window.ifield = ifield' value=\"...\">\n";
1624 =head2 popup_window_button(url, width, height, scrollbars?, &field-mappings)
1626 Returns HTML for a button that will popup a chooser window of some kind. The
1629 =item url - Base URL of the popup window's contents
1631 =item width - Width of the window in pixels
1633 =item height - Height in pixels
1635 =item scrollbars - Set to 1 if the window should have scrollbars
1637 The field-mappings parameter is an array ref of array refs containing
1639 =item - Attribute to assign field to in the popup window
1641 =item - Form field name
1643 =item - CGI parameter to URL for value, if any
1646 sub popup_window_button
1648 return &theme_popup_window_button(@_) if (defined(&theme_popup_window_button));
1649 my ($url, $w, $h, $scroll, $fields) = @_;
1650 my $scrollyn = $scroll ? "yes" : "no";
1651 my $rv = "<input type=button onClick='";
1652 foreach my $m (@$fields) {
1653 $rv .= "$m->[0] = form.$m->[1]; ";
1655 my $sep = $url =~ /\?/ ? "&" : "?";
1656 $rv .= "chooser = window.open(\"$url\"";
1657 foreach my $m (@$fields) {
1659 $rv .= "+\"$sep$m->[2]=\"+escape($m->[0].value)";
1663 $rv .= ", \"chooser\", \"toolbar=no,menubar=no,scrollbars=$scrollyn,resizable=yes,width=$w,height=$h\"); ";
1664 foreach my $m (@$fields) {
1665 $rv .= "chooser.$m->[0] = $m->[0]; ";
1666 $rv .= "window.$m->[0] = $m->[0]; ";
1668 $rv .= "' value=\"...\">";
1672 =head2 read_acl(&user-module-hash, &user-list-hash)
1674 Reads the Webmin acl file into the given hash references. The first is indexed
1675 by a combined key of username,module , with the value being set to 1 when
1676 the user has access to that module. The second is indexed by username, with
1677 the value being an array ref of allowed modules.
1679 This function is deprecated in favour of foreign_available, which performs a
1680 more comprehensive check of module availability.
1685 if (!defined(%main::acl_hash_cache)) {
1687 open(ACL, &acl_filename());
1689 if (/^([^:]+):\s*(.*)/) {
1691 my @mods = split(/\s+/, $2);
1692 foreach my $m (@mods) {
1693 $main::acl_hash_cache{$user,$m}++;
1695 $main::acl_array_cache{$user} = \@mods;
1700 if ($_[0]) { %{$_[0]} = %main::acl_hash_cache; }
1701 if ($_[1]) { %{$_[1]} = %main::acl_array_cache; }
1706 Returns the file containing the webmin ACL, which is usually
1707 /etc/webmin/webmin.acl.
1712 return "$config_directory/webmin.acl";
1717 Does nothing, but kept around for compatability.
1724 =head2 get_miniserv_config(&hash)
1726 Reads the Webmin webserver's (miniserv.pl) configuration file, usually located
1727 at /etc/webmin/miniserv.conf, and stores its names and values in the given
1731 sub get_miniserv_config
1733 return &read_file_cached(
1734 $ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf", $_[0]);
1737 =head2 put_miniserv_config(&hash)
1739 Writes out the Webmin webserver configuration file from the contents of
1740 the given hash ref. This should be initially populated by get_miniserv_config,
1743 get_miniserv_config(\%miniserv);
1744 $miniserv{'port'} = 10005;
1745 put_miniserv_config(\%miniserv);
1749 sub put_miniserv_config
1751 &write_file($ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf",
1755 =head2 restart_miniserv([nowait])
1757 Kill the old miniserv process and re-start it, then optionally waits for
1758 it to restart. This will apply all configuration settings.
1761 sub restart_miniserv
1764 return undef if (&is_readonly_mode());
1766 &get_miniserv_config(\%miniserv) || return;
1769 if ($gconfig{'os_type'} ne 'windows') {
1770 # On Unix systems, we can restart with a signal
1771 my ($pid, $addr, $i);
1772 $miniserv{'inetd'} && return;
1773 my @oldst = stat($miniserv{'pidfile'});
1774 open(PID, $miniserv{'pidfile'}) || &error("Failed to open PID file");
1777 if (!$pid) { &error("Invalid PID file"); }
1779 # Just signal miniserv to restart
1780 &kill_logged('HUP', $pid) || &error("Incorrect Webmin PID $pid");
1782 # Wait till new PID is written, indicating a restart
1783 for($i=0; $i<60; $i++) {
1785 my @newst = stat($miniserv{'pidfile'});
1786 last if ($newst[9] != $oldst[9]);
1788 $i < 60 || &error("Webmin server did not write new PID file");
1790 ## Totally kill the process and re-run it
1791 #$SIG{'TERM'} = 'IGNORE';
1792 #&kill_logged('TERM', $pid);
1793 #&system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1796 # On Windows, we need to use the flag file
1797 open(TOUCH, ">$miniserv{'restartflag'}");
1802 # wait for miniserv to come back up
1803 $addr = inet_aton($miniserv{'bind'} ? $miniserv{'bind'} : "127.0.0.1");
1805 for($i=0; $i<20; $i++) {
1807 socket(STEST, PF_INET, SOCK_STREAM, getprotobyname("tcp"));
1808 my $rv = connect(STEST,
1809 pack_sockaddr_in($miniserv{'port'}, $addr));
1811 last if ($rv && ++$ok >= 2);
1813 $i < 20 || &error("Failed to restart Webmin server!");
1817 =head2 reload_miniserv
1819 Sends a USR1 signal to the miniserv process, telling it to read-read it's
1820 configuration files. Not all changes will be applied though, such as the
1821 IP addresses and ports to accept connections on.
1826 return undef if (&is_readonly_mode());
1828 &get_miniserv_config(\%miniserv) || return;
1830 if ($gconfig{'os_type'} ne 'windows') {
1831 # Send a USR1 signal to re-read the config
1832 my ($pid, $addr, $i);
1833 $miniserv{'inetd'} && return;
1834 open(PID, $miniserv{'pidfile'}) || &error("Failed to open PID file");
1837 if (!$pid) { &error("Invalid PID file"); }
1838 &kill_logged('USR1', $pid) || &error("Incorrect Webmin PID $pid");
1840 # Make sure this didn't kill Webmin!
1842 if (!kill(0, $pid)) {
1843 print STDERR "USR1 signal killed Webmin - restarting\n";
1844 &system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1848 # On Windows, we need to use the flag file
1849 open(TOUCH, ">$miniserv{'reloadflag'}");
1854 =head2 check_os_support(&minfo, [os-type, os-version], [api-only])
1856 Returns 1 if some module is supported on the current operating system, or the
1857 OS supplies as parameters. The parameters are :
1859 =item minfo - A hash ref of module information, as returned by get_module_info
1861 =item os-type - The Webmin OS code to use instead of the system's real OS, such as redhat-linux
1863 =item os-version - The Webmin OS version to use, such as 13.0
1865 =item api-only - If set to 1, considers a module supported if it provides an API to other modules on this OS, even if the majority of its functionality is not supported.
1868 sub check_os_support
1870 my $oss = $_[0]->{'os_support'};
1871 if ($_[3] && $oss && $_[0]->{'api_os_support'}) {
1872 # May provide usable API
1873 $oss .= " ".$_[0]->{'api_os_support'};
1875 if ($_[0]->{'nozone'} && &running_in_zone()) {
1876 # Not supported in a Solaris Zone
1879 if ($_[0]->{'novserver'} && &running_in_vserver()) {
1880 # Not supported in a Linux Vserver
1883 if ($_[0]->{'noopenvz'} && &running_in_openvz()) {
1884 # Not supported in an OpenVZ container
1887 return 1 if (!$oss || $oss eq '*');
1888 my $osver = $_[2] || $gconfig{'os_version'};
1889 my $ostype = $_[1] || $gconfig{'os_type'};
1892 my ($os, $ver, $codes);
1893 my ($neg) = ($oss =~ s/^!//); # starts with !
1894 $anyneg++ if ($neg);
1895 if ($oss =~ /^([^\/\s]+)\/([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
1897 $os = $1; $ver = $2; $codes = $3; $oss = $4;
1899 elsif ($oss =~ /^([^\/\s]+)\/([^\/\s]+)\s*(.*)$/) {
1901 $os = $1; $ver = $2; $oss = $3;
1903 elsif ($oss =~ /^([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
1905 $os = $1; $codes = $2; $oss = $3;
1907 elsif ($oss =~ /^\{([^\}]*)\}\s*(.*)$/) {
1909 $codes = $1; $oss = $2;
1911 elsif ($oss =~ /^(\S+)\s*(.*)$/) {
1913 $os = $1; $oss = $2;
1916 next if ($os && !($os eq $ostype ||
1917 $ostype =~ /^(\S+)-(\S+)$/ && $os eq "*-$2"));
1918 if ($ver =~ /^([0-9\.]+)\-([0-9\.]+)$/) {
1919 next if ($osver < $1 || $osver > $2);
1921 elsif ($ver =~ /^([0-9\.]+)\-\*$/) {
1922 next if ($osver < $1);
1924 elsif ($ver =~ /^\*\-([0-9\.]+)$/) {
1925 next if ($osver > $1);
1928 next if ($ver ne $osver);
1930 next if ($codes && !eval $codes);
1936 =head2 http_download(host, port, page, destfile, [&error], [&callback], [sslmode], [user, pass], [timeout], [osdn-convert], [no-cache], [&headers])
1938 Downloads data from a HTTP url to a local file or string. The parameters are :
1940 =item host - The hostname part of the URL, such as www.google.com
1942 =item port - The HTTP port number, such as 80
1944 =item page - The filename part of the URL, like /index.html
1946 =item destfile - The local file to save the URL data to, like /tmp/index.html. This can also be a scalar reference, in which case the data will be appended to that scalar.
1948 =item error - If set to a scalar ref, the function will store any error message in this scalar and return 0 on failure, or 1 on success. If not set, it will simply call the error function if the download fails.
1950 =item callback - If set to a function ref, it will be called after each block of data is received. This is typically set to \&progress_callback, for printing download progress.
1952 =item sslmode - If set to 1, an HTTPS connection is used instead of HTTP.
1954 =item user - If set, HTTP authentication is done with this username.
1956 =item pass - The HTTP password to use with the username above.
1958 =item timeout - A timeout in seconds to wait for the TCP connection to be established before failing.
1960 =item osdn-convert - If set to 1, URL for downloads from sourceforge are converted to use an appropriate mirror site.
1962 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
1964 =item headers - If set to a hash ref of additional HTTP headers, they will be added to the request.
1969 my ($host, $port, $page, $dest, $error, $cbfunc, $ssl, $user, $pass,
1970 $timeout, $osdn, $nocache, $headers) = @_;
1971 if ($gconfig{'debug_what_net'}) {
1972 &webmin_debug_log('HTTP', "host=$host port=$port page=$page ssl=$ssl".
1973 ($user ? " user=$user pass=$pass" : "").
1974 (ref($dest) ? "" : " dest=$dest"));
1977 # Convert OSDN URL first
1978 my $prot = $ssl ? "https://" : "http://";
1979 my $portstr = $ssl && $port == 443 ||
1980 !$ssl && $port == 80 ? "" : ":$port";
1981 ($host, $port, $page, $ssl) = &parse_http_url(
1982 &convert_osdn_url($prot.$host.$portstr.$page));
1985 # Check if we already have cached the URL
1986 my $url = ($ssl ? "https://" : "http://").$host.":".$port.$page;
1987 my $cfile = &check_in_http_cache($url);
1988 if ($cfile && !$nocache) {
1989 # Yes! Copy to dest file or variable
1990 &$cbfunc(6, $url) if ($cbfunc);
1992 &open_readfile(CACHEFILE, $cfile);
1994 $$dest = <CACHEFILE>;
1998 ©_source_dest($cfile, $dest);
2005 push(@headers, [ "Host", $host ]);
2006 push(@headers, [ "User-agent", "Webmin" ]);
2008 my $auth = &encode_base64("$user:$pass");
2009 $auth =~ tr/\r\n//d;
2010 push(@headers, [ "Authorization", "Basic $auth" ]);
2012 foreach my $hname (keys %$headers) {
2013 push(@headers, [ $hname, $headers->{$hname} ]);
2016 # Actually download it
2017 $main::download_timed_out = undef;
2018 local $SIG{ALRM} = \&download_timeout;
2019 alarm($timeout || 60);
2020 my $h = &make_http_connection($host, $port, $ssl, "GET", $page, \@headers);
2022 $h = $main::download_timed_out if ($main::download_timed_out);
2024 if ($error) { $$error = $h; return; }
2025 else { &error($h); }
2027 &complete_http_download($h, $dest, $error, $cbfunc, $osdn, $host, $port,
2029 if ((!$error || !$$error) && !$nocache) {
2030 &write_to_http_cache($url, $dest);
2034 =head2 complete_http_download(handle, destfile, [&error], [&callback], [osdn], [oldhost], [oldport], [&send-headers], [old-ssl])
2036 Do a HTTP download, after the headers have been sent. For internal use only,
2037 typically called by http_download.
2040 sub complete_http_download
2042 local ($line, %header, @headers, $s); # Kept local so that callback funcs
2048 ($line = &read_http_connection($_[0])) =~ tr/\r\n//d;
2049 if ($line !~ /^HTTP\/1\..\s+(200|30[0-9])(\s+|$)/) {
2051 if ($_[2]) { ${$_[2]} = $line; return; }
2052 else { &error("Download failed : $line"); }
2055 &$cbfunc(1, $rcode >= 300 && $rcode < 400 ? 1 : 0)
2058 $line = &read_http_connection($_[0]);
2059 $line =~ tr/\r\n//d;
2060 $line =~ /^(\S+):\s+(.*)$/ || last;
2061 $header{lc($1)} = $2;
2062 push(@headers, [ lc($1), $2 ]);
2065 if ($main::download_timed_out) {
2066 if ($_[2]) { ${$_[2]} = $main::download_timed_out; return 0; }
2067 else { &error($main::download_timed_out); }
2069 &$cbfunc(2, $header{'content-length'}) if ($cbfunc);
2070 if ($rcode >= 300 && $rcode < 400) {
2071 # follow the redirect
2072 &$cbfunc(5, $header{'location'}) if ($cbfunc);
2073 my ($host, $port, $page, $ssl);
2074 if ($header{'location'} =~ /^(http|https):\/\/([^:]+):(\d+)(\/.*)?$/) {
2075 $ssl = $1 eq 'https' ? 1 : 0;
2076 $host = $2; $port = $3; $page = $4 || "/";
2078 elsif ($header{'location'} =~ /^(http|https):\/\/([^:\/]+)(\/.*)?$/) {
2079 $ssl = $1 eq 'https' ? 1 : 0;
2080 $host = $2; $port = 80; $page = $3 || "/";
2082 elsif ($header{'location'} =~ /^\// && $_[5]) {
2083 # Relative to same server
2087 $page = $header{'location'};
2089 elsif ($header{'location'}) {
2090 # Assume relative to same dir .. not handled
2091 if ($_[2]) { ${$_[2]} = "Invalid Location header $header{'location'}"; return; }
2092 else { &error("Invalid Location header $header{'location'}"); }
2095 if ($_[2]) { ${$_[2]} = "Missing Location header"; return; }
2096 else { &error("Missing Location header"); }
2099 ($page, $params) = split(/\?/, $page);
2101 $page .= "?".$params if (defined($params));
2102 &http_download($host, $port, $page, $_[1], $_[2], $cbfunc, $ssl,
2103 undef, undef, undef, $_[4], 0, $_[7]);
2108 # Append to a variable
2109 while(defined($buf = &read_http_connection($_[0], 1024))) {
2111 &$cbfunc(3, length(${$_[1]})) if ($cbfunc);
2117 if (!&open_tempfile(PFILE, ">$_[1]", 1)) {
2118 if ($_[2]) { ${$_[2]} = "Failed to write to $_[1] : $!"; return; }
2119 else { &error("Failed to write to $_[1] : $!"); }
2121 binmode(PFILE); # For windows
2122 while(defined($buf = &read_http_connection($_[0], 1024))) {
2123 &print_tempfile(PFILE, $buf);
2124 $got += length($buf);
2125 &$cbfunc(3, $got) if ($cbfunc);
2127 &close_tempfile(PFILE);
2128 if ($header{'content-length'} &&
2129 $got != $header{'content-length'}) {
2130 if ($_[2]) { ${$_[2]} = "Download incomplete"; return; }
2131 else { &error("Download incomplete"); }
2134 &$cbfunc(4) if ($cbfunc);
2136 &close_http_connection($_[0]);
2140 =head2 ftp_download(host, file, destfile, [&error], [&callback], [user, pass], [port])
2142 Download data from an FTP site to a local file. The parameters are :
2144 =item host - FTP server hostname
2146 =item file - File on the FTP server to download
2148 =item destfile - File on the Webmin system to download data to
2150 =item error - If set to a string ref, any error message is written into this string and the function returns 0 on failure, 1 on success. Otherwise, error is called on failure.
2152 =item callback - If set to a function ref, it will be called after each block of data is received. This is typically set to \&progress_callback, for printing download progress.
2154 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2156 =item pass - Password for the username above.
2158 =item port - FTP server port number, which defaults to 21 if not set.
2163 my ($host, $file, $dest, $error, $cbfunc, $user, $pass, $port) = @_;
2165 if ($gconfig{'debug_what_net'}) {
2166 &webmin_debug_log('FTP', "host=$host port=$port file=$file".
2167 ($user ? " user=$user pass=$pass" : "").
2168 (ref($dest) ? "" : " dest=$dest"));
2172 if (&is_readonly_mode()) {
2173 if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2175 else { &error("FTP connections not allowed in readonly mode"); }
2178 # Check if we already have cached the URL
2179 my $url = "ftp://".$host.$file;
2180 my $cfile = &check_in_http_cache($url);
2182 # Yes! Copy to dest file or variable
2183 &$cbfunc(6, $url) if ($cbfunc);
2185 &open_readfile(CACHEFILE, $cfile);
2187 $$dest = <CACHEFILE>;
2191 ©_source_dest($cfile, $dest);
2196 # Actually download it
2197 $main::download_timed_out = undef;
2198 local $SIG{ALRM} = \&download_timeout;
2201 if ($gconfig{'ftp_proxy'} =~ /^http:\/\/(\S+):(\d+)/ && !&no_proxy($_[0])) {
2202 # download through http-style proxy
2204 if (&open_socket($1, $2, "SOCK", \$error)) {
2206 if ($main::download_timed_out) {
2208 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2209 else { &error($main::download_timed_out); }
2211 my $esc = $_[1]; $esc =~ s/ /%20/g;
2212 my $up = "$_[5]:$_[6]\@" if ($_[5]);
2213 my $portstr = $port == 21 ? "" : ":$port";
2214 print SOCK "GET ftp://$up$_[0]$portstr$esc HTTP/1.0\r\n";
2215 print SOCK "User-agent: Webmin\r\n";
2216 if ($gconfig{'proxy_user'}) {
2217 my $auth = &encode_base64(
2218 "$gconfig{'proxy_user'}:$gconfig{'proxy_pass'}");
2219 $auth =~ tr/\r\n//d;
2220 print SOCK "Proxy-Authorization: Basic $auth\r\n";
2223 &complete_http_download({ 'fh' => "SOCK" }, $_[2], $_[3], $_[4]);
2226 elsif (!$gconfig{'proxy_fallback'}) {
2228 if ($error) { $$error = $main::download_timed_out; return 0; }
2229 else { &error($main::download_timed_out); }
2234 # connect to host and login with real FTP protocol
2235 &open_socket($_[0], $port, "SOCK", $_[3]) || return 0;
2237 if ($main::download_timed_out) {
2238 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2239 else { &error($main::download_timed_out); }
2241 &ftp_command("", 2, $_[3]) || return 0;
2243 # Login as supplied user
2244 my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2246 if (int($urv[1]/100) == 3) {
2247 &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2251 # Login as anonymous
2252 my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2254 if (int($urv[1]/100) == 3) {
2255 &ftp_command("PASS root\@".&get_system_hostname(), 2,
2259 &$cbfunc(1, 0) if ($cbfunc);
2262 # get the file size and tell the callback
2263 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2264 my $size = &ftp_command("SIZE $_[1]", 2, $_[3]);
2265 defined($size) || return 0;
2267 &$cbfunc(2, int($size));
2271 my $pasv = &ftp_command("PASV", 2, $_[3]);
2272 defined($pasv) || return 0;
2273 $pasv =~ /\(([0-9,]+)\)/;
2274 @n = split(/,/ , $1);
2275 &open_socket("$n[0].$n[1].$n[2].$n[3]",
2276 $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2277 &ftp_command("RETR $_[1]", 1, $_[3]) || return 0;
2281 &open_tempfile(PFILE, ">$_[2]", 1);
2282 while(read(CON, $buf, 1024) > 0) {
2283 &print_tempfile(PFILE, $buf);
2284 $got += length($buf);
2285 &$cbfunc(3, $got) if ($cbfunc);
2287 &close_tempfile(PFILE);
2289 if ($got != $size) {
2290 if ($_[3]) { ${$_[3]} = "Download incomplete"; return 0; }
2291 else { &error("Download incomplete"); }
2293 &$cbfunc(4) if ($cbfunc);
2295 &ftp_command("", 2, $_[3]) || return 0;
2299 &ftp_command("QUIT", 2, $_[3]) || return 0;
2303 &write_to_http_cache($url, $dest);
2307 =head2 ftp_upload(host, file, srcfile, [&error], [&callback], [user, pass], [port])
2309 Upload data from a local file to an FTP site. The parameters are :
2311 =item host - FTP server hostname
2313 =item file - File on the FTP server to write to
2315 =item srcfile - File on the Webmin system to upload data from
2317 =item error - If set to a string ref, any error message is written into this string and the function returns 0 on failure, 1 on success. Otherwise, error is called on failure.
2319 =item callback - If set to a function ref, it will be called after each block of data is received. This is typically set to \&progress_callback, for printing upload progress.
2321 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2323 =item pass - Password for the username above.
2325 =item port - FTP server port number, which defaults to 21 if not set.
2332 if (&is_readonly_mode()) {
2333 if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2335 else { &error("FTP connections not allowed in readonly mode"); }
2338 $main::download_timed_out = undef;
2339 local $SIG{ALRM} = \&download_timeout;
2342 # connect to host and login
2343 &open_socket($_[0], $_[7] || 21, "SOCK", $_[3]) || return 0;
2345 if ($main::download_timed_out) {
2346 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2347 else { &error($main::download_timed_out); }
2349 &ftp_command("", 2, $_[3]) || return 0;
2351 # Login as supplied user
2352 my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2354 if (int($urv[1]/100) == 3) {
2355 &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2359 # Login as anonymous
2360 my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2362 if (int($urv[1]/100) == 3) {
2363 &ftp_command("PASS root\@".&get_system_hostname(), 2,
2367 &$cbfunc(1, 0) if ($cbfunc);
2369 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2371 # get the file size and tell the callback
2372 my @st = stat($_[2]);
2374 &$cbfunc(2, $st[7]);
2378 my $pasv = &ftp_command("PASV", 2, $_[3]);
2379 defined($pasv) || return 0;
2380 $pasv =~ /\(([0-9,]+)\)/;
2381 @n = split(/,/ , $1);
2382 &open_socket("$n[0].$n[1].$n[2].$n[3]", $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2383 &ftp_command("STOR $_[1]", 1, $_[3]) || return 0;
2388 while(read(PFILE, $buf, 1024) > 0) {
2390 $got += length($buf);
2391 &$cbfunc(3, $got) if ($cbfunc);
2395 if ($got != $st[7]) {
2396 if ($_[3]) { ${$_[3]} = "Upload incomplete"; return 0; }
2397 else { &error("Upload incomplete"); }
2399 &$cbfunc(4) if ($cbfunc);
2402 &ftp_command("", 2, $_[3]) || return 0;
2403 &ftp_command("QUIT", 2, $_[3]) || return 0;
2409 =head2 no_proxy(host)
2411 Checks if some host is on the no proxy list. For internal use by the
2412 http_download and ftp_download functions.
2417 my $ip = &to_ipaddress($_[0]);
2418 foreach my $n (split(/\s+/, $gconfig{'noproxy'})) {
2419 return 1 if ($_[0] =~ /\Q$n\E/ ||
2425 =head2 open_socket(host, port, handle, [&error])
2427 Open a TCP connection to some host and port, using a file handle. The
2430 =item host - Hostname or IP address to connect to.
2432 =item port - TCP port number.
2434 =item handle - A file handle name to use for the connection.
2436 =item error - A string reference to write any error message into. If not set, the error function is called on failure.
2441 my ($host, $port, $fh, $err) = @_;
2442 $fh = &callers_package($fh);
2444 if ($gconfig{'debug_what_net'}) {
2445 &webmin_debug_log('TCP', "host=$host port=$port");
2447 if (!socket($fh, PF_INET, SOCK_STREAM, getprotobyname("tcp"))) {
2448 if ($err) { $$err = "Failed to create socket : $!"; return 0; }
2449 else { &error("Failed to create socket : $!"); }
2452 if (!($addr = inet_aton($host))) {
2453 if ($err) { $$err = "Failed to lookup IP address for $host"; return 0; }
2454 else { &error("Failed to lookup IP address for $host"); }
2456 if ($gconfig{'bind_proxy'}) {
2457 if (!bind($fh,pack_sockaddr_in(0, inet_aton($gconfig{'bind_proxy'})))) {
2458 if ($err) { $$err = "Failed to bind to source address : $!"; return 0; }
2459 else { &error("Failed to bind to source address : $!"); }
2462 if (!connect($fh, pack_sockaddr_in($port, $addr))) {
2463 if ($err) { $$err = "Failed to connect to $host:$port : $!"; return 0; }
2464 else { &error("Failed to connect to $host:$port : $!"); }
2466 my $old = select($fh); $| =1; select($old);
2470 =head2 download_timeout
2472 Called when a download times out. For internal use only.
2475 sub download_timeout
2477 $main::download_timed_out = "Download timed out";
2480 =head2 ftp_command(command, expected, [&error], [filehandle])
2482 Send an FTP command, and die if the reply is not what was expected. Mainly
2483 for internal use by the ftp_download and ftp_upload functions.
2488 my ($cmd, $expect, $err, $fh) = @_;
2490 $fh = &callers_package($fh);
2493 my $what = $cmd ne "" ? "<i>$cmd</i>" : "initial connection";
2495 print $fh "$cmd\r\n";
2498 if (!($line = <$fh>)) {
2500 if ($err) { $$err = "Failed to read reply to $what"; return undef; }
2501 else { &error("Failed to read reply to $what"); }
2503 $line =~ /^(...)(.)(.*)$/;
2506 foreach my $c (@$expect) {
2507 $found++ if (int($1/100) == $c);
2511 $found++ if (int($1/100) == $_[1]);
2515 if ($err) { $$err = "$what failed : $3"; return undef; }
2516 else { &error("$what failed : $3"); }
2521 # Need to skip extra stuff..
2523 if (!($line = <$fh>)) {
2525 if ($$err) { $$err = "Failed to read reply to $what";
2527 else { &error("Failed to read reply to $what"); }
2529 $line =~ /^(....)(.*)$/; $reply .= $2;
2530 if ($1 eq "$rcode ") { last; }
2534 return wantarray ? ($reply, $rcode) : $reply;
2537 =head2 to_ipaddress(hostname)
2539 Converts a hostname to an a.b.c.d format IP address, or returns undef if
2540 it cannot be resolved.
2545 if (&check_ipaddress($_[0])) {
2549 my $hn = gethostbyname($_[0]);
2550 return undef if (!$hn);
2551 local @ip = unpack("CCCC", $hn);
2552 return join("." , @ip);
2556 =head2 icons_table(&links, &titles, &icons, [columns], [href], [width], [height], &befores, &afters)
2558 Renders a 4-column table of icons. The useful parameters are :
2560 =item links - An array ref of link destination URLs for the icons.
2562 =item titles - An array ref of titles to appear under the icons.
2564 =item icons - An array ref of URLs for icon images.
2566 =item columns - Number of columns to layout the icons with. Defaults to 4.
2571 &load_theme_library();
2572 if (defined(&theme_icons_table)) {
2573 &theme_icons_table(@_);
2577 my $cols = $_[3] ? $_[3] : 4;
2578 my $per = int(100.0 / $cols);
2579 print "<table class='icons_table' width=100% cellpadding=5>\n";
2580 for(my $i=0; $i<@{$_[0]}; $i++) {
2581 if ($i%$cols == 0) { print "<tr>\n"; }
2582 print "<td width=$per% align=center valign=top>\n";
2583 &generate_icon($_[2]->[$i], $_[1]->[$i], $_[0]->[$i],
2584 ref($_[4]) ? $_[4]->[$i] : $_[4], $_[5], $_[6],
2585 $_[7]->[$i], $_[8]->[$i]);
2587 if ($i%$cols == $cols-1) { print "</tr>\n"; }
2589 while($i++%$cols) { print "<td width=$per%></td>\n"; $need_tr++; }
2590 print "</tr>\n" if ($need_tr);
2594 =head2 replace_file_line(file, line, [newline]*)
2596 Replaces one line in some file with 0 or more new lines. The parameters are :
2598 =item file - Full path to some file, like /etc/hosts.
2600 =item line - Line number to replace, starting from 0.
2602 =item newline - Zero or more lines to put into the file at the given line number. These must be newline-terminated strings.
2605 sub replace_file_line
2608 my $realfile = &translate_filename($_[0]);
2609 open(FILE, $realfile);
2612 if (@_ > 2) { splice(@lines, $_[1], 1, @_[2..$#_]); }
2613 else { splice(@lines, $_[1], 1); }
2614 &open_tempfile(FILE, ">$realfile");
2615 &print_tempfile(FILE, @lines);
2616 &close_tempfile(FILE);
2619 =head2 read_file_lines(file, [readonly])
2621 Returns a reference to an array containing the lines from some file. This
2622 array can be modified, and will be written out when flush_file_lines()
2623 is called. The parameters are :
2625 =item file - Full path to the file to read.
2627 =item readonly - Should be set 1 if the caller is only going to read the lines, and never write it out.
2631 $lref = read_file_lines("/etc/hosts");
2632 push(@$lref, "127.0.0.1 localhost");
2633 flush_file_lines("/etc/hosts");
2639 my ($package, $filename, $line) = caller;
2640 print STDERR "Missing file to read at ${package}::${filename} line $line\n";
2642 my $realfile = &translate_filename($_[0]);
2643 if (!$main::file_cache{$realfile}) {
2646 &webmin_debug_log('READ', $_[0]) if ($gconfig{'debug_what_read'});
2647 open(READFILE, $realfile);
2650 $eol = /\r\n$/ ? "\r\n" : "\n";
2656 $main::file_cache{$realfile} = \@lines;
2657 $main::file_cache_noflush{$realfile} = $_[1];
2658 $main::file_cache_eol{$realfile} = $eol || "\n";
2661 # Make read-write if currently readonly
2663 $main::file_cache_noflush{$realfile} = 0;
2666 return $main::file_cache{$realfile};
2669 =head2 flush_file_lines([file], [eol])
2671 Write out to a file previously read by read_file_lines to disk (except
2672 for those marked readonly). The parameters are :
2674 =item file - The file to flush out.
2676 =item eof - End-of-line character for each line. Defaults to \n.
2679 sub flush_file_lines
2683 local $trans = &translate_filename($_[0]);
2684 $main::file_cache{$trans} ||
2685 &error("flush_file_lines called on non-loaded file $trans");
2686 push(@files, $trans);
2689 @files = ( keys %main::file_cache );
2691 foreach my $f (@files) {
2692 my $eol = $_[1] || $main::file_cache_eol{$f} || "\n";
2693 if (!$main::file_cache_noflush{$f}) {
2694 no warnings; # XXX Bareword file handles should go away
2695 &open_tempfile(FLUSHFILE, ">$f");
2696 foreach my $line (@{$main::file_cache{$f}}) {
2697 (print FLUSHFILE $line,$eol) ||
2698 &error(&text("efilewrite", $f, $!));
2700 &close_tempfile(FLUSHFILE);
2702 delete($main::file_cache{$f});
2703 delete($main::file_cache_noflush{$f});
2707 =head2 unflush_file_lines(file)
2709 Clear the internal cache of some given file, previously read by read_file_lines.
2712 sub unflush_file_lines
2714 my $realfile = &translate_filename($_[0]);
2715 delete($main::file_cache{$realfile});
2716 delete($main::file_cache_noflush{$realfile});
2719 =head2 unix_user_input(fieldname, user, [form])
2721 Returns HTML for an input to select a Unix user. By default this is a text
2722 box with a user popup button next to it.
2727 if (defined(&theme_unix_user_input)) {
2728 return &theme_unix_user_input(@_);
2730 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
2731 &user_chooser_button($_[0], 0, $_[2] || 0)."\n";
2734 =head2 unix_group_input(fieldname, user, [form])
2736 Returns HTML for an input to select a Unix group. By default this is a text
2737 box with a group popup button next to it.
2740 sub unix_group_input
2742 if (defined(&theme_unix_group_input)) {
2743 return &theme_unix_group_input(@_);
2745 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
2746 &group_chooser_button($_[0], 0, $_[2] || 0)."\n";
2749 =head2 hlink(text, page, [module], [width], [height])
2751 Returns HTML for a link that when clicked on pops up a window for a Webmin
2752 help page. The parameters are :
2754 =item text - Text for the link.
2756 =item page - Help page code, such as 'intro'.
2758 =item module - Module the help page is in. Defaults to the current module.
2760 =item width - Width of the help popup window. Defaults to 600 pixels.
2762 =item height - Height of the help popup window. Defaults to 400 pixels.
2764 The actual help pages are in each module's help sub-directory, in files with
2770 if (defined(&theme_hlink)) {
2771 return &theme_hlink(@_);
2773 my $mod = $_[2] ? $_[2] : &get_module_name();
2774 my $width = $_[3] || $tconfig{'help_width'} || $gconfig{'help_width'} || 600;
2775 my $height = $_[4] || $tconfig{'help_height'} || $gconfig{'help_height'} || 400;
2776 return "<a onClick='window.open(\"$gconfig{'webprefix'}/help.cgi/$mod/$_[1]\", \"help\", \"toolbar=no,menubar=no,scrollbars=yes,width=$width,height=$height,resizable=yes\"); return false' href=\"$gconfig{'webprefix'}/help.cgi/$mod/$_[1]\">$_[0]</a>";
2779 =head2 user_chooser_button(field, multiple, [form])
2781 Returns HTML for a javascript button for choosing a Unix user or users.
2782 The parameters are :
2784 =item field - Name of the HTML field to place the username into.
2786 =item multiple - Set to 1 if multiple users can be selected.
2788 =item form - Index of the form on the page.
2791 sub user_chooser_button
2793 return undef if (!&supports_users());
2794 return &theme_user_chooser_button(@_)
2795 if (defined(&theme_user_chooser_button));
2796 my $form = defined($_[2]) ? $_[2] : 0;
2797 my $w = $_[1] ? 500 : 300;
2799 if ($_[1] && $gconfig{'db_sizeusers'}) {
2800 ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
2802 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
2803 ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
2805 return "<input type=button onClick='ifield = form.$_[0]; chooser = window.open(\"$gconfig{'webprefix'}/user_chooser.cgi?multi=$_[1]&user=\"+escape(ifield.value), \"chooser\", \"toolbar=no,menubar=no,scrollbars=yes,resizable=yes,width=$w,height=$h\"); chooser.ifield = ifield; window.ifield = ifield' value=\"...\">\n";
2808 =head2 group_chooser_button(field, multiple, [form])
2810 Returns HTML for a javascript button for choosing a Unix group or groups
2811 The parameters are :
2813 =item field - Name of the HTML field to place the group name into.
2815 =item multiple - Set to 1 if multiple groups can be selected.
2817 =item form - Index of the form on the page.
2820 sub group_chooser_button
2822 return undef if (!&supports_users());
2823 return &theme_group_chooser_button(@_)
2824 if (defined(&theme_group_chooser_button));
2825 my $form = defined($_[2]) ? $_[2] : 0;
2826 my $w = $_[1] ? 500 : 300;
2828 if ($_[1] && $gconfig{'db_sizeusers'}) {
2829 ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
2831 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
2832 ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
2834 return "<input type=button onClick='ifield = form.$_[0]; chooser = window.open(\"$gconfig{'webprefix'}/group_chooser.cgi?multi=$_[1]&group=\"+escape(ifield.value), \"chooser\", \"toolbar=no,menubar=no,scrollbars=yes,resizable=yes,width=$w,height=$h\"); chooser.ifield = ifield; window.ifield = ifield' value=\"...\">\n";
2837 =head2 foreign_check(module, [api-only])
2839 Checks if some other module exists and is supported on this OS. The parameters
2842 =item module - Name of the module to check.
2844 =item api-only - Set to 1 if you just want to check if the module provides an API that others can call, instead of the full web UI.
2849 my ($mod, $api) = @_;
2851 my $mdir = &module_root_directory($mod);
2852 &read_file_cached("$mdir/module.info", \%minfo) || return 0;
2853 return &check_os_support(\%minfo, undef, undef, $api);
2856 =head2 foreign_exists(module)
2858 Checks if some other module exists. The module parameter is the short module
2864 my $mdir = &module_root_directory($_[0]);
2865 return -r "$mdir/module.info";
2868 =head2 foreign_available(module)
2870 Returns 1 if some module is installed, and acessible to the current user. The
2871 module parameter is the module directory name.
2874 sub foreign_available
2876 return 0 if (!&foreign_check($_[0]) &&
2877 !$gconfig{'available_even_if_no_support'});
2878 my %foreign_module_info = &get_module_info($_[0]);
2880 # Check list of allowed modules
2882 &read_acl(\%acl, undef);
2883 return 0 if (!$acl{$base_remote_user,$_[0]} &&
2884 !$acl{$base_remote_user,'*'});
2886 # Check for usermod restrictions
2887 my @usermods = &list_usermods();
2888 return 0 if (!&available_usermods( [ \%foreign_module_info ], \@usermods));
2890 if (&get_product_name() eq "webmin") {
2891 # Check if the user has any RBAC privileges in this module
2892 if (&supports_rbac($_[0]) &&
2893 &use_rbac_module_acl(undef, $_[0])) {
2894 # RBAC is enabled for this user and module - check if he
2896 my $rbacs = &get_rbac_module_acl($remote_user, $_[0]);
2897 return 0 if (!$rbacs);
2899 elsif ($gconfig{'rbacdeny_'.$base_remote_user}) {
2900 # If denying access to modules not specifically allowed by
2901 # RBAC, then prevent access
2906 # Check readonly support
2907 if (&is_readonly_mode()) {
2908 return 0 if (!$foreign_module_info{'readonly'});
2911 # Check if theme vetos
2912 if (defined(&theme_foreign_available)) {
2913 return 0 if (!&theme_foreign_available($_[0]));
2916 # Check if licence module vetos
2917 if ($main::licence_module) {
2918 return 0 if (!&foreign_call($main::licence_module,
2919 "check_module_licence", $_[0]));
2925 =head2 foreign_require(module, [file], [package])
2927 Brings in functions from another module, and places them in the Perl namespace
2928 with the same name as the module. The parameters are :
2930 =item module - The source module's directory name, like sendmail.
2932 =item file - The API file in that module, like sendmail-lib.pl. If missing, all API files are loaded.
2934 =item package - Perl package to place the module's functions and global variables in.
2936 If the original module name contains dashes, they will be replaced with _ in
2942 my ($mod, $file, $pkg) = @_;
2943 $pkg ||= $mod || "global";
2944 $pkg =~ s/[^A-Za-z0-9]/_/g;
2947 push(@files, $file);
2951 my %minfo = &get_module_info($mod);
2952 if ($minfo{'library'}) {
2953 @files = split(/\s+/, $minfo{'library'});
2956 @files = ( $mod."-lib.pl" );
2959 @files = grep { !$main::done_foreign_require{$pkg,$_} } @files;
2960 return 1 if (!@files);
2961 foreach my $f (@files) {
2962 $main::done_foreign_require{$pkg,$f}++;
2965 my $mdir = &module_root_directory($mod);
2966 @INC = &unique($mdir, @INC);
2967 -d $mdir || &error("Module $mod does not exist");
2968 if (!&get_module_name() && $mod) {
2971 my $old_fmn = $ENV{'FOREIGN_MODULE_NAME'};
2972 my $old_frd = $ENV{'FOREIGN_ROOT_DIRECTORY'};
2973 my $code = "package $pkg; ".
2974 "\$ENV{'FOREIGN_MODULE_NAME'} = '$mod'; ".
2975 "\$ENV{'FOREIGN_ROOT_DIRECTORY'} = '$root_directory'; ";
2976 foreach my $f (@files) {
2977 $code .= "do '$mdir/$f' || die \$@; ";
2980 if (defined($old_fmn)) {
2981 $ENV{'FOREIGN_MODULE_NAME'} = $old_fmn;
2984 delete($ENV{'FOREIGN_MODULE_NAME'});
2986 if (defined($old_frd)) {
2987 $ENV{'FOREIGN_ROOT_DIRECTORY'} = $old_frd;
2990 delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
2993 if ($@) { &error("Require $mod/$files[0] failed : <pre>$@</pre>"); }
2997 =head2 foreign_call(module, function, [arg]*)
2999 Call a function in another module. The module parameter is the target module
3000 directory name, function is the perl sub to call, and the remaining parameters
3001 are the arguments. However, unless you need to call a function whose name
3002 is dynamic, it is better to use Perl's cross-module function call syntax
3003 like module::function(args).
3008 my $pkg = $_[0] || "global";
3009 $pkg =~ s/[^A-Za-z0-9]/_/g;
3010 my @args = @_[2 .. @_-1];
3011 $main::foreign_args = \@args;
3012 my @rv = eval <<EOF;
3014 &$_[1](\@{\$main::foreign_args});
3016 if ($@) { &error("$_[0]::$_[1] failed : $@"); }
3017 return wantarray ? @rv : $rv[0];
3020 =head2 foreign_config(module, [user-config])
3022 Get the configuration from another module, and return it as a hash. If the
3023 user-config parameter is set to 1, returns the Usermin user-level preferences
3024 for the current user instead.
3029 my ($mod, $uc) = @_;
3032 &read_file_cached("$root_directory/$mod/defaultuconfig", \%fconfig);
3033 &read_file_cached("$config_directory/$mod/uconfig", \%fconfig);
3034 &read_file_cached("$user_config_directory/$mod/config", \%fconfig);
3037 &read_file_cached("$config_directory/$mod/config", \%fconfig);
3042 =head2 foreign_installed(module, mode)
3044 Checks if the server for some module is installed, and possibly also checks
3045 if the module has been configured by Webmin.
3046 For mode 1, returns 2 if the server is installed and configured for use by
3047 Webmin, 1 if installed but not configured, or 0 otherwise.
3048 For mode 0, returns 1 if installed, 0 if not.
3049 If the module does not provide an install_check.pl script, assumes that
3050 the server is installed.
3053 sub foreign_installed
3055 my ($mod, $configured) = @_;
3056 if (defined($main::foreign_installed_cache{$mod,$configured})) {
3058 return $main::foreign_installed_cache{$mod,$configured};
3062 if (!&foreign_check($mod)) {
3067 my $mdir = &module_root_directory($mod);
3068 if (!-r "$mdir/install_check.pl") {
3069 # Not known, assume OK
3070 $rv = $configured ? 2 : 1;
3073 # Call function to check
3074 &foreign_require($mod, "install_check.pl");
3075 $rv = &foreign_call($mod, "is_installed", $configured);
3078 $main::foreign_installed_cache{$mod,$configured} = $rv;
3083 =head2 foreign_defined(module, function)
3085 Returns 1 if some function is defined in another module. In general, it is
3086 simpler to use the syntax &defined(module::function) instead.
3092 $pkg =~ s/[^A-Za-z0-9]/_/g;
3093 my $func = "${pkg}::$_[1]";
3094 return defined(&$func);
3097 =head2 get_system_hostname([short])
3099 Returns the hostname of this system. If the short parameter is set to 1,
3100 then the domain name is not prepended - otherwise, Webmin will attempt to get
3101 the fully qualified hostname, like foo.example.com.
3104 sub get_system_hostname
3107 if (!$main::get_system_hostname[$m]) {
3108 if ($gconfig{'os_type'} ne 'windows') {
3109 # Try some common Linux hostname files first
3111 if ($gconfig{'os_type'} eq 'redhat-linux') {
3113 &read_env_file("/etc/sysconfig/network", \%nc);
3114 if ($nc{'HOSTNAME'}) {
3115 $fromfile = $nc{'HOSTNAME'};
3118 elsif ($gconfig{'os_type'} eq 'debian-linux') {
3119 my $hn = &read_file_contents("/etc/hostname");
3125 elsif ($gconfig{'os_type'} eq 'open-linux') {
3126 my $hn = &read_file_contents("/etc/HOSTNAME");
3132 elsif ($gconfig{'os_type'} eq 'solaris') {
3133 my $hn = &read_file_contents("/etc/nodename");
3140 # If we found a hostname, use it if value
3141 if ($fromfile && ($m || $fromfile =~ /\./)) {
3143 $fromfile =~ s/\..*$//;
3145 $main::get_system_hostname[$m] = $fromfile;
3149 # Can use hostname command on Unix
3150 &execute_command("hostname", undef,
3151 \$main::get_system_hostname[$m], undef, 0, 1);
3152 chop($main::get_system_hostname[$m]);
3154 eval "use Sys::Hostname";
3156 $main::get_system_hostname[$m] = eval "hostname()";
3158 if ($@ || !$main::get_system_hostname[$m]) {
3159 $main::get_system_hostname[$m] = "UNKNOWN";
3162 elsif ($main::get_system_hostname[$m] !~ /\./ &&
3163 $gconfig{'os_type'} =~ /linux$/ &&
3164 !$gconfig{'no_hostname_f'} && !$_[0]) {
3165 # Try with -f flag to get fully qualified name
3167 my $ex = &execute_command("hostname -f", undef, \$flag,
3170 if ($ex || $flag eq "") {
3171 # -f not supported! We have probably set the
3172 # hostname to just '-f'. Fix the problem
3175 &execute_command("hostname ".
3176 quotemeta($main::get_system_hostname[$m]),
3177 undef, undef, undef, 0, 1);
3181 $main::get_system_hostname[$m] = $flag;
3186 # On Windows, try computername environment variable
3187 return $ENV{'computername'} if ($ENV{'computername'});
3188 return $ENV{'COMPUTERNAME'} if ($ENV{'COMPUTERNAME'});
3190 # Fall back to net name command
3191 my $out = `net name 2>&1`;
3192 if ($out =~ /\-+\r?\n(\S+)/) {
3193 $main::get_system_hostname[$m] = $1;
3196 $main::get_system_hostname[$m] = "windows";
3200 return $main::get_system_hostname[$m];
3203 =head2 get_webmin_version
3205 Returns the version of Webmin currently being run, such as 1.450.
3208 sub get_webmin_version
3210 if (!$get_webmin_version) {
3211 open(VERSION, "$root_directory/version") || return 0;
3212 ($get_webmin_version = <VERSION>) =~ tr/\r|\n//d;
3215 return $get_webmin_version;
3218 =head2 get_module_acl([user], [module], [no-rbac], [no-default])
3220 Returns a hash containing access control options for the given user and module.
3221 By default the current username and module name are used. If the no-rbac flag
3222 is given, the permissions will not be updated based on the user's RBAC role
3223 (as seen on Solaris). If the no-default flag is given, default permissions for
3224 the module will not be included.
3229 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
3230 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3231 my $mdir = &module_root_directory($m);
3234 # Read default ACL first, to be overridden by per-user settings
3235 &read_file_cached("$mdir/defaultacl", \%rv);
3237 # If this isn't a master admin user, apply the negative permissions
3238 # so that he doesn't un-expectedly gain access to new features
3240 &read_file_cached("$config_directory/$u.acl", \%gaccess);
3241 if ($gaccess{'negative'}) {
3242 &read_file_cached("$mdir/negativeacl", \%rv);
3246 if (!$_[2] && &supports_rbac($m) && &use_rbac_module_acl($u, $m)) {
3247 # RBAC overrides exist for this user in this module
3248 my $rbac = &get_rbac_module_acl(
3249 defined($_[0]) ? $_[0] : $remote_user, $m);
3250 foreach my $r (keys %$rbac) {
3251 $rv{$r} = $rbac->{$r};
3254 elsif ($gconfig{"risk_$u"} && $m) {
3255 # ACL is defined by user's risk level
3256 my $rf = $gconfig{"risk_$u"}.'.risk';
3257 &read_file_cached("$mdir/$rf", \%rv);
3259 my $sf = $gconfig{"skill_$u"}.'.skill';
3260 &read_file_cached("$mdir/$sf", \%rv);
3263 # Use normal Webmin ACL, if a user is set
3264 &read_file_cached("$config_directory/$m/$u.acl", \%rv);
3265 if ($remote_user ne $base_remote_user && !defined($_[0])) {
3266 &read_file_cached("$config_directory/$m/$remote_user.acl",\%rv);
3269 if ($tconfig{'preload_functions'}) {
3270 &load_theme_library();
3272 if (defined(&theme_get_module_acl)) {
3273 %rv = &theme_get_module_acl($u, $m, \%rv);
3278 =head2 get_group_module_acl(group, [module])
3280 Returns the ACL for a Webmin group, in an optional module (which defaults to
3281 the current module).
3284 sub get_group_module_acl
3287 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3288 my $mdir = &module_root_directory($m);
3290 &read_file_cached("$mdir/defaultacl", \%rv);
3291 &read_file_cached("$config_directory/$m/$g.gacl", \%rv);
3292 if (defined(&theme_get_module_acl)) {
3293 %rv = &theme_get_module_acl($g, $m, \%rv);
3298 =head2 save_module_acl(&acl, [user], [module])
3300 Updates the acl hash for some user and module. The parameters are :
3302 =item acl - Hash reference for the new access control options.
3304 =item user - User to update, defaulting to the current user.
3306 =item module - Module to update, defaulting to the caller.
3311 my $u = defined($_[1]) ? $_[1] : $base_remote_user;
3312 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3313 if (&foreign_check("acl")) {
3314 # Check if this user is a member of a group, and if he gets the
3315 # module from a group. If so, update its ACL as well
3316 &foreign_require("acl", "acl-lib.pl");
3318 foreach my $g (&acl::list_groups()) {
3319 if (&indexof($u, @{$g->{'members'}}) >= 0 &&
3320 &indexof($m, @{$g->{'modules'}}) >= 0) {
3326 &save_group_module_acl($_[0], $group->{'name'}, $m);
3329 if (!-d "$config_directory/$m") {
3330 mkdir("$config_directory/$m", 0755);
3332 &write_file("$config_directory/$m/$u.acl", $_[0]);
3335 =head2 save_group_module_acl(&acl, group, [module])
3337 Updates the acl hash for some group and module. The parameters are :
3339 =item acl - Hash reference for the new access control options.
3341 =item group - Group name to update.
3343 =item module - Module to update, defaulting to the caller.
3346 sub save_group_module_acl
3349 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3350 if (&foreign_check("acl")) {
3351 # Check if this group is a member of a group, and if it gets the
3352 # module from a group. If so, update the parent ACL as well
3353 &foreign_require("acl", "acl-lib.pl");
3355 foreach my $pg (&acl::list_groups()) {
3356 if (&indexof('@'.$g, @{$pg->{'members'}}) >= 0 &&
3357 &indexof($m, @{$pg->{'modules'}}) >= 0) {
3363 &save_group_module_acl($_[0], $group->{'name'}, $m);
3366 if (!-d "$config_directory/$m") {
3367 mkdir("$config_directory/$m", 0755);
3369 &write_file("$config_directory/$m/$g.gacl", $_[0]);
3374 This function must be called by all Webmin CGI scripts, either directly or
3375 indirectly via a per-module lib.pl file. It performs a number of initialization
3376 and housekeeping tasks, such as working out the module name, checking that the
3377 current user has access to the module, and populating global variables. Some
3378 of the variables set include :
3380 =item $config_directory - Base Webmin config directory, typically /etc/webmin
3382 =item $var_directory - Base logs directory, typically /var/webmin
3384 =item %config - Per-module configuration.
3386 =item %gconfig - Global configuration.
3388 =item $scriptname - Base name of the current perl script.
3390 =item $module_name - The name of the current module.
3392 =item $module_config_directory - The config directory for this module.
3394 =item $module_config_file - The config file for this module.
3396 =item $module_root_directory - This module's code directory.
3398 =item $webmin_logfile - The detailed logfile for webmin.
3400 =item $remote_user - The actual username used to login to webmin.
3402 =item $base_remote_user - The username whose permissions are in effect.
3404 =item $current_theme - The theme currently in use.
3406 =item $root_directory - The first root directory of this webmin install.
3408 =item @root_directories - All root directories for this webmin install.
3413 # Record first process ID that called this, so we know when it exited to clean
3415 $main::initial_process_id ||= $$;
3417 # Configuration and spool directories
3418 if (!defined($ENV{'WEBMIN_CONFIG'})) {
3419 die "WEBMIN_CONFIG not set";
3421 $config_directory = $ENV{'WEBMIN_CONFIG'};
3422 if (!defined($ENV{'WEBMIN_VAR'})) {
3423 open(VARPATH, "$config_directory/var-path");
3424 chop($var_directory = <VARPATH>);
3428 $var_directory = $ENV{'WEBMIN_VAR'};
3430 $main::http_cache_directory = $ENV{'WEBMIN_VAR'}."/cache";
3431 $main::default_debug_log_file = $ENV{'WEBMIN_VAR'}."/webmin.debug";
3433 if ($ENV{'SESSION_ID'}) {
3434 # Hide this variable from called programs, but keep it for internal use
3435 $main::session_id = $ENV{'SESSION_ID'};
3436 delete($ENV{'SESSION_ID'});
3438 if ($ENV{'REMOTE_PASS'}) {
3439 # Hide the password too
3440 $main::remote_pass = $ENV{'REMOTE_PASS'};
3441 delete($ENV{'REMOTE_PASS'});
3444 if ($> == 0 && $< != 0 && !$ENV{'FOREIGN_MODULE_NAME'}) {
3445 # Looks like we are running setuid, but the real UID hasn't been set.
3446 # Do so now, so that executed programs don't get confused
3451 # Read the webmin global config file. This contains the OS type and version,
3452 # OS specific configuration and global options such as proxy servers
3453 $config_file = "$config_directory/config";
3455 &read_file_cached($config_file, \%gconfig);
3456 $null_file = $gconfig{'os_type'} eq 'windows' ? "NUL" : "/dev/null";
3457 $path_separator = $gconfig{'os_type'} eq 'windows' ? ';' : ':';
3459 # If debugging is enabled, open the debug log
3460 if ($gconfig{'debug_enabled'} && !$main::opened_debug_log++) {
3461 my $dlog = $gconfig{'debug_file'} || $main::default_debug_log_file;
3462 if ($gconfig{'debug_size'}) {
3463 my @st = stat($dlog);
3464 if ($st[7] > $gconfig{'debug_size'}) {
3465 rename($dlog, $dlog.".0");
3468 open(main::DEBUGLOG, ">>$dlog");
3469 $main::opened_debug_log = 1;
3471 if ($gconfig{'debug_what_start'}) {
3472 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
3473 $main::debug_log_start_time = time();
3474 &webmin_debug_log("START", "script=$script_name");
3475 $main::debug_log_start_module = $module_name;
3479 # Set PATH and LD_LIBRARY_PATH
3480 if ($gconfig{'path'}) {
3481 if ($gconfig{'syspath'}) {
3483 $ENV{'PATH'} = $gconfig{'path'};
3487 $ENV{'PATH'} = $gconfig{'path'}.$path_separator.$ENV{'PATH'};
3490 $ENV{$gconfig{'ld_env'}} = $gconfig{'ld_path'} if ($gconfig{'ld_env'});
3492 # Set http_proxy and ftp_proxy environment variables, based on Webmin settings
3493 if ($gconfig{'http_proxy'}) {
3494 $ENV{'http_proxy'} = $gconfig{'http_proxy'};
3496 if ($gconfig{'ftp_proxy'}) {
3497 $ENV{'ftp_proxy'} = $gconfig{'ftp_proxy'};
3499 if ($gconfig{'noproxy'}) {
3500 $ENV{'no_proxy'} = $gconfig{'noproxy'};
3503 # Find all root directories
3505 if (&get_miniserv_config(\%miniserv)) {
3506 @root_directories = ( $miniserv{'root'} );
3507 for($i=0; defined($miniserv{"extraroot_$i"}); $i++) {
3508 push(@root_directories, $miniserv{"extraroot_$i"});
3512 # Work out which module we are in, and read the per-module config file
3513 $0 =~ s/\\/\//g; # Force consistent path on Windows
3514 if (defined($ENV{'FOREIGN_MODULE_NAME'})) {
3515 # In a foreign call - use the module name given
3516 $root_directory = $ENV{'FOREIGN_ROOT_DIRECTORY'};
3517 $module_name = $ENV{'FOREIGN_MODULE_NAME'};
3518 @root_directories = ( $root_directory ) if (!@root_directories);
3520 elsif ($ENV{'SCRIPT_NAME'}) {
3521 my $sn = $ENV{'SCRIPT_NAME'};
3522 $sn =~ s/^$gconfig{'webprefix'}//
3523 if (!$gconfig{'webprefixnoredir'});
3524 if ($sn =~ /^\/([^\/]+)\//) {
3525 # Get module name from CGI path
3528 if ($ENV{'SERVER_ROOT'}) {
3529 $root_directory = $ENV{'SERVER_ROOT'};
3531 elsif ($ENV{'SCRIPT_FILENAME'}) {
3532 $root_directory = $ENV{'SCRIPT_FILENAME'};
3533 $root_directory =~ s/$sn$//;
3535 @root_directories = ( $root_directory ) if (!@root_directories);
3538 # Get root directory from miniserv.conf, and deduce module name from $0
3539 $root_directory = $root_directories[0];
3541 foreach my $r (@root_directories) {
3542 if ($0 =~ /^$r\/([^\/]+)\/[^\/]+$/i) {
3543 # Under a module directory
3548 elsif ($0 =~ /^$root_directory\/[^\/]+$/i) {
3554 &error("Script was not run with full path (failed to find $0 under $root_directory)") if (!$rok);
3557 # Work out of this is a web, command line or cron job
3558 if (!$main::webmin_script_type) {
3559 if ($ENV{'SCRIPT_NAME'}) {
3561 $main::webmin_script_type = 'web';
3564 # Cron jobs have no TTY
3565 if ($gconfig{'os_type'} eq 'windows' ||
3566 open(DEVTTY, ">/dev/tty")) {
3567 $main::webmin_script_type = 'cmd';
3571 $main::webmin_script_type = 'cron';
3576 # Set the umask based on config
3577 if ($gconfig{'umask'} && !$main::umask_already++) {
3578 umask(oct($gconfig{'umask'}));
3581 # If this is a cron job or other background task, set the nice level
3582 if (!$main::nice_already && $main::webmin_script_type eq 'cron') {
3584 if ($gconfig{'nice'}) {
3585 eval 'POSIX::nice($gconfig{\'nice\'});';
3588 # Set IO scheduling class and priority
3589 if ($gconfig{'sclass'} ne '' || $gconfig{'sprio'} ne '') {
3591 $cmd .= " -c ".quotemeta($gconfig{'sclass'})
3592 if ($gconfig{'sclass'} ne '');
3593 $cmd .= " -n ".quotemeta($gconfig{'sprio'})
3594 if ($gconfig{'sprio'} ne '');
3596 &execute_command("$cmd >/dev/null 2>&1");
3599 $main::nice_already++;
3602 my $u = $ENV{'BASE_REMOTE_USER'} || $ENV{'REMOTE_USER'};
3603 $base_remote_user = $u;
3604 $remote_user = $ENV{'REMOTE_USER'};
3607 # Find and load the configuration file for this module
3608 my (@ruinfo, $rgroup);
3609 $module_config_directory = "$config_directory/$module_name";
3610 if (&get_product_name() eq "usermin" &&
3611 -r "$module_config_directory/config.$remote_user") {
3613 $module_config_file = "$module_config_directory/config.$remote_user";
3615 elsif (&get_product_name() eq "usermin" &&
3616 (@ruinfo = getpwnam($remote_user)) &&
3617 ($rgroup = getgrgid($ruinfo[3])) &&
3618 -r "$module_config_directory/config.\@$rgroup") {
3619 # Based on group name
3620 $module_config_file = "$module_config_directory/config.\@$rgroup";
3624 $module_config_file = "$module_config_directory/config";
3627 &read_file_cached($module_config_file, \%config);
3629 # Fix up windows-specific substitutions in values
3630 foreach my $k (keys %config) {
3631 if ($config{$k} =~ /\$\{systemroot\}/) {
3632 my $root = &get_windows_root();
3633 $config{$k} =~ s/\$\{systemroot\}/$root/g;
3638 # Record the initial module
3639 $main::initial_module_name ||= $module_name;
3641 # Set some useful variables
3643 $current_themes = $ENV{'MOBILE_DEVICE'} && defined($gconfig{'mobile_theme'}) ?
3644 $gconfig{'mobile_theme'} :
3645 defined($gconfig{'theme_'.$remote_user}) ?
3646 $gconfig{'theme_'.$remote_user} :
3647 defined($gconfig{'theme_'.$base_remote_user}) ?
3648 $gconfig{'theme_'.$base_remote_user} :
3650 @current_themes = split(/\s+/, $current_themes);
3651 $current_theme = $current_themes[0];
3652 @theme_root_directories = map { "$root_directory/$_" } @current_themes;
3653 $theme_root_directory = $theme_root_directories[0];
3654 @theme_configs = ( );
3655 foreach my $troot (@theme_root_directories) {
3657 &read_file_cached("$troot/config", \%onetconfig);
3658 &read_file_cached("$troot/config", \%tconfig);
3659 push(@theme_configs, \%onetconfig);
3661 $tb = defined($tconfig{'cs_header'}) ? "bgcolor=#$tconfig{'cs_header'}" :
3662 defined($gconfig{'cs_header'}) ? "bgcolor=#$gconfig{'cs_header'}" :
3664 $cb = defined($tconfig{'cs_table'}) ? "bgcolor=#$tconfig{'cs_table'}" :
3665 defined($gconfig{'cs_table'}) ? "bgcolor=#$gconfig{'cs_table'}" :
3667 $tb .= ' '.$tconfig{'tb'} if ($tconfig{'tb'});
3668 $cb .= ' '.$tconfig{'cb'} if ($tconfig{'cb'});
3669 if ($tconfig{'preload_functions'}) {
3670 # Force load of theme functions right now, if requested
3671 &load_theme_library();
3673 if ($tconfig{'oofunctions'} && !$main::loaded_theme_oo_library++) {
3674 # Load the theme's Webmin:: package classes
3675 do "$theme_root_directory/$tconfig{'oofunctions'}";
3680 $webmin_logfile = $gconfig{'webmin_log'} ? $gconfig{'webmin_log'}
3681 : "$var_directory/webmin.log";
3683 # Load language strings into %text
3684 my @langs = &list_languages();
3686 if ($gconfig{'acceptlang'}) {
3687 foreach my $a (split(/,/, $ENV{'HTTP_ACCEPT_LANGUAGE'})) {
3688 my ($al) = grep { $_->{'lang'} eq $a } @langs;
3690 $accepted_lang = $al->{'lang'};
3695 $current_lang = $force_lang ? $force_lang :
3696 $accepted_lang ? $accepted_lang :
3697 $gconfig{"lang_$remote_user"} ? $gconfig{"lang_$remote_user"} :
3698 $gconfig{"lang_$base_remote_user"} ? $gconfig{"lang_$base_remote_user"} :
3699 $gconfig{"lang"} ? $gconfig{"lang"} : $default_lang;
3700 foreach my $l (@langs) {
3701 $current_lang_info = $l if ($l->{'lang'} eq $current_lang);
3703 @lang_order_list = &unique($default_lang,
3704 split(/:/, $current_lang_info->{'fallback'}),
3706 %text = &load_language($module_name);
3707 %text || &error("Failed to determine Webmin root from SERVER_ROOT, SCRIPT_FILENAME or the full command line");
3709 # Get the %module_info for this module
3711 my ($mi) = grep { $_->{'dir'} eq $module_name }
3712 &get_all_module_infos(2);
3713 %module_info = %$mi;
3714 $module_root_directory = &module_root_directory($module_name);
3717 if ($module_name && !$main::no_acl_check &&
3718 !defined($ENV{'FOREIGN_MODULE_NAME'})) {
3719 # Check if the HTTP user can access this module
3720 if (!&foreign_available($module_name)) {
3721 if (!&foreign_check($module_name)) {
3722 &error(&text('emodulecheck',
3723 "<i>$module_info{'desc'}</i>"));
3726 &error(&text('emodule', "<i>$u</i>",
3727 "<i>$module_info{'desc'}</i>"));
3730 $main::no_acl_check++;
3733 # Check the Referer: header for nasty redirects
3734 my @referers = split(/\s+/, $gconfig{'referers'});
3736 if ($ENV{'HTTP_REFERER'} =~/^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?([^\/:@]+)/) {
3739 my $http_host = $ENV{'HTTP_HOST'};
3740 $http_host =~ s/:\d+$//;
3741 my $unsafe_index = $unsafe_index_cgi ||
3742 &get_module_variable('$unsafe_index_cgi');
3744 ($ENV{'SCRIPT_NAME'} !~ /^\/(index.cgi)?$/ || $unsafe_index) &&
3745 ($ENV{'SCRIPT_NAME'} !~ /^\/([a-z0-9\_\-]+)\/(index.cgi)?$/i ||
3747 $0 !~ /(session_login|pam_login)\.cgi$/ && !$gconfig{'referer'} &&
3748 $ENV{'MINISERV_CONFIG'} && !$main::no_referers_check &&
3749 $ENV{'HTTP_USER_AGENT'} !~ /^Webmin/i &&
3750 ($referer_site && $referer_site ne $http_host &&
3751 &indexof($referer_site, @referers) < 0 ||
3752 !$referer_site && $gconfig{'referers_none'}) &&
3753 !$trust_unknown_referers &&
3754 !&get_module_variable('$trust_unknown_referers')) {
3755 # Looks like a link from elsewhere .. show an error
3756 &header($text{'referer_title'}, "", undef, 0, 1, 1);
3758 $prot = lc($ENV{'HTTPS'}) eq 'on' ? "https" : "http";
3759 my $url = "<tt>".&html_escape("$prot://$ENV{'HTTP_HOST'}$ENV{'REQUEST_URI'}")."</tt>";
3760 if ($referer_site) {
3762 print &text('referer_warn',
3763 "<tt>".&html_escape($ENV{'HTTP_REFERER'})."</tt>", $url);
3765 print &text('referer_fix1', &html_escape($http_host)),"<p>\n";
3766 print &text('referer_fix2', &html_escape($http_host)),"<p>\n";
3769 # No referer info given
3770 print &text('referer_warn_unknown', $url),"<p>\n";
3771 print &text('referer_fix1u'),"<p>\n";
3772 print &text('referer_fix2u'),"<p>\n";
3776 &footer("/", $text{'index'});
3779 $main::no_referers_check++;
3780 $main::completed_referers_check++;
3782 # Call theme post-init
3783 if (defined(&theme_post_init_config)) {
3784 &theme_post_init_config(@_);
3787 # Record that we have done the calling library in this package
3788 my ($callpkg, $lib) = caller();
3790 $main::done_foreign_require{$callpkg,$lib} = 1;
3792 # If a licence checking is enabled, do it now
3793 if ($gconfig{'licence_module'} && !$main::done_licence_module_check &&
3794 &foreign_check($gconfig{'licence_module'}) &&
3795 -r "$root_directory/$gconfig{'licence_module'}/licence_check.pl") {
3796 my $oldpwd = &get_current_dir();
3797 $main::done_licence_module_check++;
3798 $main::licence_module = $gconfig{'licence_module'};
3799 &foreign_require($main::licence_module, "licence_check.pl");
3800 ($main::licence_status, $main::licence_message) =
3801 &foreign_call($main::licence_module, "check_licence");
3805 # Export global variables to caller
3806 if ($main::export_to_caller) {
3807 foreach my $v ('$config_file', '%gconfig', '$null_file',
3808 '$path_separator', '@root_directories',
3809 '$root_directory', '$module_name',
3810 '$base_remote_user', '$remote_user',
3811 '$module_config_directory', '$module_config_file',
3812 '%config', '@current_themes', '$current_theme',
3813 '@theme_root_directories', '$theme_root_directory',
3814 '%tconfig','@theme_configs', '$tb', '$cb', '$scriptname',
3815 '$webmin_logfile', '$current_lang',
3816 '$current_lang_info', '@lang_order_list', '%text',
3817 '%module_info', '$module_root_directory') {
3818 my ($vt, $vn) = split('', $v, 2);
3819 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
3826 =head2 load_language([module], [directory])
3828 Returns a hashtable mapping text codes to strings in the appropriate language,
3829 based on the $current_lang global variable, which is in turn set based on
3830 the Webmin user's selection. The optional module parameter tells the function
3831 which module to load strings for, and defaults to the calling module. The
3832 optional directory parameter can be used to load strings from a directory
3835 In regular module development you will never need to call this function
3836 directly, as init_config calls it for you, and places the module's strings
3837 into the %text hash.
3843 my $root = $root_directory;
3844 my $ol = $gconfig{'overlang'};
3845 my ($dir) = ($_[1] || "lang");
3847 # Read global lang files
3848 foreach my $o (@lang_order_list) {
3849 my $ok = &read_file_cached("$root/$dir/$o", \%text);
3850 return () if (!$ok && $o eq $default_lang);
3853 foreach my $o (@lang_order_list) {
3854 &read_file_cached("$root/$ol/$o", \%text);
3857 &read_file_cached("$config_directory/custom-lang", \%text);
3860 # Read module's lang files
3861 my $mdir = &module_root_directory($_[0]);
3862 foreach my $o (@lang_order_list) {
3863 &read_file_cached("$mdir/$dir/$o", \%text);
3866 foreach $o (@lang_order_list) {
3867 &read_file_cached("$mdir/$ol/$o", \%text);
3870 &read_file_cached("$config_directory/$_[0]/custom-lang", \%text);
3872 foreach $k (keys %text) {
3873 $text{$k} =~ s/\$(\{([^\}]+)\}|([A-Za-z0-9\.\-\_]+))/text_subs($2 || $3,\%text)/ge;
3876 if (defined(&theme_load_language)) {
3877 &theme_load_language(\%text, $_[0]);
3882 =head2 text_subs(string)
3884 Used internally by load_language to expand $code substitutions in language
3890 if (substr($_[0], 0, 8) eq "include:") {
3893 open(INCLUDE, substr($_[0], 8));
3901 my $t = $_[1]->{$_[0]};
3902 return defined($t) ? $t : '$'.$_[0];
3906 =head2 text(message, [substitute]+)
3908 Returns a translated message from %text, but with $1, $2, etc.. replaced with
3909 the substitute parameters. This makes it easy to use strings with placeholders
3910 that get replaced with programmatically generated text. For example :
3912 print &text('index_hello', $remote_user),"<p>\n";
3917 my $t = &get_module_variable('%text', 1);
3918 my $rv = exists($t->{$_[0]}) ? $t->{$_[0]} : $text{$_[0]};
3919 for(my $i=1; $i<@_; $i++) {
3920 $rv =~ s/\$$i/$_[$i]/g;
3925 =head2 encode_base64(string)
3927 Encodes a string into base64 format, for use in MIME email or HTTP
3928 authorization headers.
3934 pos($_[0]) = 0; # ensure start at the beginning
3935 while ($_[0] =~ /(.{1,57})/gs) {
3936 $res .= substr(pack('u57', $1), 1)."\n";
3939 $res =~ tr|\` -_|AA-Za-z0-9+/|;
3940 my $padding = (3 - length($_[0]) % 3) % 3;
3941 $res =~ s/.{$padding}$/'=' x $padding/e if ($padding);
3945 =head2 decode_base64(string)
3947 Converts a base64-encoded string into plain text. The opposite of encode_base64.
3954 $str =~ tr|A-Za-z0-9+=/||cd; # remove non-base64 chars
3955 if (length($str) % 4) {
3958 $str =~ s/=+$//; # remove padding
3959 $str =~ tr|A-Za-z0-9+/| -_|; # convert to uuencoded format
3960 while ($str =~ /(.{1,60})/gs) {
3961 my $len = chr(32 + length($1)*3/4); # compute length byte
3962 $res .= unpack("u", $len . $1 ); # uudecode
3967 =head2 get_module_info(module, [noclone], [forcache])
3969 Returns a hash containg details of the given module. Some useful keys are :
3971 =item dir - The module directory, like sendmail.
3973 =item desc - Human-readable description, in the current users' language.
3975 =item version - Optional module version number.
3977 =item os_support - List of supported operating systems and versions.
3979 =item category - Category on Webmin's left menu, like net.
3984 return () if ($_[0] =~ /^\./);
3985 my (%rv, $clone, $o);
3986 my $mdir = &module_root_directory($_[0]);
3987 &read_file_cached("$mdir/module.info", \%rv) || return ();
3989 foreach $o (@lang_order_list) {
3990 $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
3991 $rv{"longdesc"} = $rv{"longdesc_$o"} if ($rv{"longdesc_$o"});
3993 if ($clone && !$_[1] && $config_directory) {
3994 $rv{'clone'} = $rv{'desc'};
3995 &read_file("$config_directory/$_[0]/clone", \%rv);
3998 my %module_categories;
3999 &read_file_cached("$config_directory/webmin.cats", \%module_categories);
4000 my $pn = &get_product_name();
4001 if (defined($rv{'category_'.$pn})) {
4002 # Can override category for webmin/usermin
4003 $rv{'category'} = $rv{'category_'.$pn};
4005 $rv{'realcategory'} = $rv{'category'};
4006 $rv{'category'} = $module_categories{$_[0]}
4007 if (defined($module_categories{$_[0]}));
4009 # Apply description overrides
4010 $rv{'realdesc'} = $rv{'desc'};
4012 &read_file_cached("$config_directory/webmin.descs", \%descs);
4013 if ($descs{$_[0]." ".$current_lang}) {
4014 $rv{'desc'} = $descs{$_[0]." ".$current_lang};
4016 elsif ($descs{$_[0]}) {
4017 $rv{'desc'} = $descs{$_[0]};
4021 # Apply per-user description overridde
4022 my %gaccess = &get_module_acl(undef, "");
4023 if ($gaccess{'desc_'.$_[0]}) {
4024 $rv{'desc'} = $gaccess{'desc_'.$_[0]};
4028 if ($rv{'longdesc'}) {
4029 # All standard modules have an index.cgi
4030 $rv{'index_link'} = 'index.cgi';
4033 # Call theme-specific override function
4034 if (defined(&theme_get_module_info)) {
4035 %rv = &theme_get_module_info(\%rv, $_[0], $_[1], $_[2]);
4041 =head2 get_all_module_infos(cachemode)
4043 Returns a list contains the information on all modules in this webmin
4044 install, including clones. Uses caching to reduce the number of module.info
4045 files that need to be read. Each element of the array is a hash reference
4046 in the same format as returned by get_module_info. The cache mode flag can be :
4047 0 = read and write, 1 = don't read or write, 2 = read only
4050 sub get_all_module_infos
4054 # Is the cache out of date? (ie. have any of the root's changed?)
4055 my $cache_file = "$config_directory/module.infos.cache";
4057 if (&read_file_cached($cache_file, \%cache)) {
4058 foreach my $r (@root_directories) {
4060 if ($st[9] != $cache{'mtime_'.$r}) {
4070 if ($_[0] != 1 && !$changed && $cache{'lang'} eq $current_lang) {
4071 # Can use existing module.info cache
4073 foreach my $k (keys %cache) {
4074 if ($k =~ /^(\S+) (\S+)$/) {
4075 $mods{$1}->{$2} = $cache{$k};
4078 @rv = map { $mods{$_} } (keys %mods) if (%mods);
4081 # Need to rebuild cache
4083 foreach my $r (@root_directories) {
4085 foreach my $m (readdir(DIR)) {
4086 next if ($m =~ /^(config-|\.)/ || $m =~ /\.(cgi|pl)$/);
4087 my %minfo = &get_module_info($m, 0, 1);
4088 next if (!%minfo || !$minfo{'dir'});
4090 foreach $k (keys %minfo) {
4091 $cache{"${m} ${k}"} = $minfo{$k};
4096 $cache{'mtime_'.$r} = $st[9];
4098 $cache{'lang'} = $current_lang;
4099 &write_file($cache_file, \%cache) if (!$_[0] && $< == 0 && $> == 0);
4102 # Override descriptions for modules for current user
4103 my %gaccess = &get_module_acl(undef, "");
4104 foreach my $m (@rv) {
4105 if ($gaccess{"desc_".$m->{'dir'}}) {
4106 $m->{'desc'} = $gaccess{"desc_".$m->{'dir'}};
4110 # Apply installed flags
4112 &read_file_cached("$config_directory/installed.cache", \%installed);
4113 foreach my $m (@rv) {
4114 $m->{'installed'} = $installed{$m->{'dir'}};
4120 =head2 get_theme_info(theme)
4122 Returns a hash containing a theme's details, taken from it's theme.info file.
4123 Some useful keys are :
4125 =item dir - The theme directory, like blue-theme.
4127 =item desc - Human-readable description, in the current users' language.
4129 =item version - Optional module version number.
4131 =item os_support - List of supported operating systems and versions.
4136 return () if ($_[0] =~ /^\./);
4138 my $tdir = &module_root_directory($_[0]);
4139 &read_file("$tdir/theme.info", \%rv) || return ();
4140 foreach my $o (@lang_order_list) {
4141 $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4147 =head2 list_languages
4149 Returns an array of supported languages, taken from Webmin's os_list.txt file.
4150 Each is a hash reference with the following keys :
4152 =item lang - The short language code, like es for Spanish.
4154 =item desc - A human-readable description, in English.
4156 =item charset - An optional character set to use when displaying the language.
4158 =item titles - Set to 1 only if Webmin has title images for the language.
4160 =item fallback - The code for another language to use if a string does not exist in this one. For all languages, English is the ultimate fallback.
4165 if (!@main::list_languages_cache) {
4168 open(LANG, "$root_directory/lang_list.txt");
4170 if (/^(\S+)\s+(.*)/) {
4171 my $l = { 'desc' => $2 };
4172 foreach $o (split(/,/, $1)) {
4173 if ($o =~ /^([^=]+)=(.*)$/) {
4177 $l->{'index'} = scalar(@rv);
4178 push(@main::list_languages_cache, $l);
4182 @main::list_languages_cache = sort { $a->{'desc'} cmp $b->{'desc'} }
4183 @main::list_languages_cache;
4185 return @main::list_languages_cache;
4188 =head2 read_env_file(file, &hash)
4190 Similar to Webmin's read_file function, but handles files containing shell
4191 environment variables formatted like :
4196 The file parameter is the full path to the file to read, and hash a Perl hash
4197 ref to read names and values into.
4203 &open_readfile(FILE, $_[0]) || return 0;
4206 if (/^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*"(.*)"/i ||
4207 /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*'(.*)'/i ||
4208 /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*(.*)/i) {
4216 =head2 write_env_file(file, &hash, [export])
4218 Writes out a hash to a file in name='value' format, suitable for use in a shell
4219 script. The parameters are :
4221 =item file - Full path for a file to write to
4223 =item hash - Hash reference of names and values to write.
4225 =item export - If set to 1, preceed each variable setting with the word 'export'.
4230 my $exp = $_[2] ? "export " : "";
4231 &open_tempfile(FILE, ">$_[0]");
4232 foreach my $k (keys %{$_[1]}) {
4233 my $v = $_[1]->{$k};
4234 if ($v =~ /^\S+$/) {
4235 &print_tempfile(FILE, "$exp$k=$v\n");
4238 &print_tempfile(FILE, "$exp$k=\"$v\"\n");
4241 &close_tempfile(FILE);
4244 =head2 lock_file(filename, [readonly], [forcefile])
4246 Lock a file for exclusive access. If the file is already locked, spin
4247 until it is freed. Uses a .lock file, which is not 100% reliable, but seems
4248 to work OK. The parameters are :
4250 =item filename - File or directory to lock.
4252 =item readonly - If set, the lock is for reading the file only. More than one script can have a readonly lock, but only one can hold a write lock.
4254 =item forcefile - Force the file to be considered as a real file and not a symlink for Webmin actions logging purposes.
4259 my $realfile = &translate_filename($_[0]);
4260 return 0 if (!$_[0] || defined($main::locked_file_list{$realfile}));
4261 my $no_lock = !&can_lock_file($realfile);
4262 my $lock_tries_count = 0;
4265 if (!$no_lock && open(LOCKING, "$realfile.lock")) {
4270 if ($no_lock || !$pid || !kill(0, $pid) || $pid == $$) {
4273 # Create the .lock file
4274 open(LOCKING, ">$realfile.lock") || return 0;
4275 my $lck = eval "flock(LOCKING, 2+4)";
4277 # Lock of lock file failed! Wait till later
4280 print LOCKING $$,"\n";
4281 eval "flock(LOCKING, 8)";
4284 $main::locked_file_list{$realfile} = int($_[1]);
4285 push(@main::temporary_files, "$realfile.lock");
4286 if (($gconfig{'logfiles'} || $gconfig{'logfullfiles'}) &&
4287 !&get_module_variable('$no_log_file_changes') &&
4289 # Grab a copy of this file for later diffing
4291 $main::locked_file_data{$realfile} = undef;
4293 $main::locked_file_type{$realfile} = 1;
4294 $main::locked_file_data{$realfile} = '';
4296 elsif (!$_[2] && ($lnk = readlink($realfile))) {
4297 $main::locked_file_type{$realfile} = 2;
4298 $main::locked_file_data{$realfile} = $lnk;
4300 elsif (open(ORIGFILE, $realfile)) {
4301 $main::locked_file_type{$realfile} = 0;
4302 $main::locked_file_data{$realfile} = '';
4305 $main::locked_file_data{$realfile} .=$_;
4314 if ($lock_tries_count++ > 5*60) {
4315 # Give up after 5 minutes
4316 &error(&text('elock_tries', "<tt>$realfile</tt>", 5));
4322 =head2 unlock_file(filename)
4324 Release a lock on a file taken out by lock_file. If Webmin actions logging of
4325 file changes is enabled, then at unlock file a diff will be taken between the
4326 old and new contents, and stored under /var/webmin/diffs when webmin_log is
4327 called. This can then be viewed in the Webmin Actions Log module.
4332 my $realfile = &translate_filename($_[0]);
4333 return if (!$_[0] || !defined($main::locked_file_list{$realfile}));
4334 unlink("$realfile.lock") if (&can_lock_file($realfile));
4335 delete($main::locked_file_list{$realfile});
4336 if (exists($main::locked_file_data{$realfile})) {
4337 # Diff the new file with the old
4339 my $lnk = readlink($realfile);
4340 my $type = -d _ ? 1 : $lnk ? 2 : 0;
4341 my $oldtype = $main::locked_file_type{$realfile};
4342 my $new = !defined($main::locked_file_data{$realfile});
4343 if ($new && !-e _) {
4344 # file doesn't exist, and never did! do nothing ..
4346 elsif ($new && $type == 1 || !$new && $oldtype == 1) {
4347 # is (or was) a directory ..
4348 if (-d _ && !defined($main::locked_file_data{$realfile})) {
4349 push(@main::locked_file_diff,
4350 { 'type' => 'mkdir', 'object' => $realfile });
4352 elsif (!-d _ && defined($main::locked_file_data{$realfile})) {
4353 push(@main::locked_file_diff,
4354 { 'type' => 'rmdir', 'object' => $realfile });
4357 elsif ($new && $type == 2 || !$new && $oldtype == 2) {
4358 # is (or was) a symlink ..
4359 if ($lnk && !defined($main::locked_file_data{$realfile})) {
4360 push(@main::locked_file_diff,
4361 { 'type' => 'symlink', 'object' => $realfile,
4364 elsif (!$lnk && defined($main::locked_file_data{$realfile})) {
4365 push(@main::locked_file_diff,
4366 { 'type' => 'unsymlink', 'object' => $realfile,
4367 'data' => $main::locked_file_data{$realfile} });
4369 elsif ($lnk ne $main::locked_file_data{$realfile}) {
4370 push(@main::locked_file_diff,
4371 { 'type' => 'resymlink', 'object' => $realfile,
4376 # is a file, or has changed type?!
4377 my ($diff, $delete_file);
4378 my $type = "modify";
4380 open(NEWFILE, ">$realfile");
4385 if (!defined($main::locked_file_data{$realfile})) {
4388 open(ORIGFILE, ">$realfile.webminorig");
4389 print ORIGFILE $main::locked_file_data{$realfile};
4391 $diff = &backquote_command(
4392 "diff ".quotemeta("$realfile.webminorig")." ".
4393 quotemeta($realfile)." 2>/dev/null");
4394 push(@main::locked_file_diff,
4395 { 'type' => $type, 'object' => $realfile,
4396 'data' => $diff } ) if ($diff);
4397 unlink("$realfile.webminorig");
4398 unlink($realfile) if ($delete_file);
4401 if ($gconfig{'logfullfiles'}) {
4402 # Add file details to list of those to fully log
4403 $main::orig_file_data{$realfile} ||=
4404 $main::locked_file_data{$realfile};
4405 $main::orig_file_type{$realfile} ||=
4406 $main::locked_file_type{$realfile};
4409 delete($main::locked_file_data{$realfile});
4410 delete($main::locked_file_type{$realfile});
4414 =head2 test_lock(file)
4416 Returns 1 if some file is currently locked, 0 if not.
4421 my $realfile = &translate_filename($_[0]);
4422 return 0 if (!$_[0]);
4423 return 1 if (defined($main::locked_file_list{$realfile}));
4424 return 0 if (!&can_lock_file($realfile));
4426 if (open(LOCKING, "$realfile.lock")) {
4431 return $pid && kill(0, $pid);
4434 =head2 unlock_all_files
4436 Unlocks all files locked by the current script.
4439 sub unlock_all_files
4441 foreach $f (keys %main::locked_file_list) {
4446 =head2 can_lock_file(file)
4448 Returns 1 if some file should be locked, based on the settings in the
4449 Webmin Configuration module. For internal use by lock_file only.
4454 if (&is_readonly_mode()) {
4455 return 0; # never lock in read-only mode
4457 elsif ($gconfig{'lockmode'} == 0) {
4460 elsif ($gconfig{'lockmode'} == 1) {
4464 # Check if under any of the directories
4466 foreach my $d (split(/\t+/, $gconfig{'lockdirs'})) {
4467 if (&same_file($d, $_[0]) ||
4468 &is_under_directory($d, $_[0])) {
4472 return $gconfig{'lockmode'} == 2 ? $match : !$match;
4476 =head2 webmin_log(action, type, object, ¶ms, [module], [host, script-on-host, client-ip])
4478 Log some action taken by a user. This is typically called at the end of a
4479 script, once all file changes are complete and all commands run. The
4482 =item action - A short code for the action being performed, like 'create'.
4484 =item type - A code for the type of object the action is performed to, like 'user'.
4486 =item object - A short name for the object, like 'joe' if the Unix user 'joe' was just created.
4488 =item params - A hash ref of additional information about the action.
4490 =item module - Name of the module in which the action was performed, which defaults to the current module.
4492 =item host - Remote host on which the action was performed. You should never need to set this (or the following two parameters), as they are used only for remote Webmin logging.
4494 =item script-on-host - Script name like create_user.cgi on the host the action was performed on.
4496 =item client-ip - IP address of the browser that performed the action.
4501 return if (!$gconfig{'log'} || &is_readonly_mode());
4502 my $m = $_[4] ? $_[4] : &get_module_name();
4504 if ($gconfig{'logclear'}) {
4505 # check if it is time to clear the log
4506 my @st = stat("$webmin_logfile.time");
4507 my $write_logtime = 0;
4509 if ($st[9]+$gconfig{'logtime'}*60*60 < time()) {
4510 # clear logfile and all diff files
4511 &unlink_file("$ENV{'WEBMIN_VAR'}/diffs");
4512 &unlink_file("$ENV{'WEBMIN_VAR'}/files");
4513 &unlink_file("$ENV{'WEBMIN_VAR'}/annotations");
4514 unlink($webmin_logfile);
4521 if ($write_logtime) {
4522 open(LOGTIME, ">$webmin_logfile.time");
4523 print LOGTIME time(),"\n";
4528 # If an action script directory is defined, call the appropriate scripts
4529 if ($gconfig{'action_script_dir'}) {
4530 my ($action, $type, $object) = ($_[0], $_[1], $_[2]);
4531 my ($basedir) = $gconfig{'action_script_dir'};
4533 for my $dir ($basedir/$type/$action, $basedir/$type, $basedir) {
4536 opendir(DIR, $dir) or die "Can't open $dir: $!";
4537 while (defined($file = readdir(DIR))) {
4538 next if ($file =~ /^\.\.?$/); # skip '.' and '..'
4539 if (-x "$dir/$file") {
4540 # Call a script notifying it of the action
4542 $ENV{'ACTION_MODULE'} = &get_module_name();
4543 $ENV{'ACTION_ACTION'} = $_[0];
4544 $ENV{'ACTION_TYPE'} = $_[1];
4545 $ENV{'ACTION_OBJECT'} = $_[2];
4546 $ENV{'ACTION_SCRIPT'} = $script_name;
4547 foreach my $p (keys %param) {
4548 $ENV{'ACTION_PARAM_'.uc($p)} = $param{$p};
4550 system("$dir/$file", @_,
4551 "<$null_file", ">$null_file", "2>&1");
4559 # should logging be done at all?
4560 return if ($gconfig{'logusers'} && &indexof($base_remote_user,
4561 split(/\s+/, $gconfig{'logusers'})) < 0);
4562 return if ($gconfig{'logmodules'} && &indexof($m,
4563 split(/\s+/, $gconfig{'logmodules'})) < 0);
4567 my @tm = localtime($now);
4568 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
4569 my $id = sprintf "%d.%d.%d", $now, $$, $main::action_id_count;
4570 $main::action_id_count++;
4571 my $line = sprintf "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s %s \"%s\" \"%s\" \"%s\"",
4572 $id, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
4573 $tm[2], $tm[1], $tm[0],
4574 $remote_user || '-',
4575 $main::session_id || '-',
4576 $_[7] || $ENV{'REMOTE_HOST'} || '-',
4577 $m, $_[5] ? "$_[5]:$_[6]" : $script_name,
4578 $_[0], $_[1] ne '' ? $_[1] : '-', $_[2] ne '' ? $_[2] : '-';
4580 foreach my $k (sort { $a cmp $b } keys %{$_[3]}) {
4581 my $v = $_[3]->{$k};
4587 elsif (ref($v) eq 'ARRAY') {
4591 $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
4592 $line .= " $k='$vv'";
4596 foreach $vv (split(/\0/, $v)) {
4598 $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
4599 $line .= " $k='$vv'";
4602 $param{$k} = join(" ", @pv);
4604 open(WEBMINLOG, ">>$webmin_logfile");
4605 print WEBMINLOG $line,"\n";
4607 if ($gconfig{'logperms'}) {
4608 chmod(oct($gconfig{'logperms'}), $webmin_logfile);
4611 chmod(0600, $webmin_logfile);
4614 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
4615 # Find and record the changes made to any locked files, or commands run
4617 mkdir("$ENV{'WEBMIN_VAR'}/diffs", 0700);
4618 foreach my $d (@main::locked_file_diff) {
4619 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$id", 0700);
4620 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i");
4621 print DIFFLOG "$d->{'type'} $d->{'object'}\n";
4622 print DIFFLOG $d->{'data'};
4624 if ($d->{'input'}) {
4625 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
4626 print DIFFLOG $d->{'input'};
4629 if ($gconfig{'logperms'}) {
4630 chmod(oct($gconfig{'logperms'}),
4631 "$ENV{'WEBMIN_VAR'}/diffs/$id/$i",
4632 "$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
4636 @main::locked_file_diff = undef;
4638 if ($gconfig{'logfullfiles'}) {
4639 # Save the original contents of any modified files
4641 mkdir("$ENV{'WEBMIN_VAR'}/files", 0700);
4642 foreach my $f (keys %main::orig_file_data) {
4643 mkdir("$ENV{'WEBMIN_VAR'}/files/$id", 0700);
4644 open(ORIGLOG, ">$ENV{'WEBMIN_VAR'}/files/$id/$i");
4645 if (!defined($main::orig_file_type{$f})) {
4646 print ORIGLOG -1," ",$f,"\n";
4649 print ORIGLOG $main::orig_file_type{$f}," ",$f,"\n";
4651 print ORIGLOG $main::orig_file_data{$f};
4653 if ($gconfig{'logperms'}) {
4654 chmod(oct($gconfig{'logperms'}),
4655 "$ENV{'WEBMIN_VAR'}/files/$id.$i");
4659 %main::orig_file_data = undef;
4660 %main::orig_file_type = undef;
4664 if ($gconfig{'logsyslog'}) {
4665 eval 'use Sys::Syslog qw(:DEFAULT setlogsock);
4666 openlog(&get_product_name(), "cons,pid,ndelay", "daemon");
4667 setlogsock("inet");';
4669 # Syslog module is installed .. try to convert to a
4670 # human-readable form
4672 my $mod = &get_module_name();
4673 my $mdir = module_root_directory($mod);
4674 if (-r "$mdir/log_parser.pl") {
4675 &foreign_require($mod, "log_parser.pl");
4677 foreach my $k (keys %{$_[3]}) {
4678 my $v = $_[3]->{$k};
4679 if (ref($v) eq 'ARRAY') {
4680 $params{$k} = join("\0", @$v);
4686 $msg = &foreign_call($mod, "parse_webmin_log",
4687 $remote_user, $script_name,
4688 $_[0], $_[1], $_[2], \%params);
4689 $msg =~ s/<[^>]*>//g; # Remove tags
4691 elsif ($_[0] eq "_config_") {
4692 my %wtext = &load_language("webminlog");
4693 $msg = $wtext{'search_config'};
4695 $msg ||= "$_[0] $_[1] $_[2]";
4696 my %info = &get_module_info($m);
4697 eval { syslog("info", "%s", "[$info{'desc'}] $msg"); };
4702 =head2 additional_log(type, object, data, [input])
4704 Records additional log data for an upcoming call to webmin_log, such
4705 as a command that was run or SQL that was executed. Typically you will never
4706 need to call this function directory.
4711 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
4712 push(@main::locked_file_diff,
4713 { 'type' => $_[0], 'object' => $_[1], 'data' => $_[2],
4714 'input' => $_[3] } );
4718 =head2 webmin_debug_log(type, message)
4720 Write something to the Webmin debug log. For internal use only.
4723 sub webmin_debug_log
4725 my ($type, $msg) = @_;
4726 return 0 if (!$main::opened_debug_log);
4727 return 0 if ($gconfig{'debug_no'.$main::webmin_script_type});
4729 my @tm = localtime($now);
4731 "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s \"%s\"",
4732 $$, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
4733 $tm[2], $tm[1], $tm[0],
4734 $remote_user || "-",
4735 $ENV{'REMOTE_HOST'} || "-",
4736 &get_module_name() || "-",
4739 seek(main::DEBUGLOG, 0, 2);
4740 print main::DEBUGLOG $line."\n";
4744 =head2 system_logged(command)
4746 Just calls the Perl system() function, but also logs the command run.
4751 if (&is_readonly_mode()) {
4752 print STDERR "Vetoing command $_[0]\n";
4755 my @realcmd = ( &translate_command($_[0]), @_[1..$#_] );
4756 my $cmd = join(" ", @realcmd);
4758 if ($cmd =~ s/(\s*&\s*)$//) {
4761 while($cmd =~ s/(\d*)(<|>)((\/(tmp|dev)\S+)|&\d+)\s*$//) { }
4762 $cmd =~ s/^\((.*)\)\s*$/$1/;
4764 &additional_log('exec', undef, $cmd);
4765 return system(@realcmd);
4768 =head2 backquote_logged(command)
4770 Executes a command and returns the output (like `command`), but also logs it.
4773 sub backquote_logged
4775 if (&is_readonly_mode()) {
4777 print STDERR "Vetoing command $_[0]\n";
4780 my $realcmd = &translate_command($_[0]);
4783 if ($cmd =~ s/(\s*&\s*)$//) {
4786 while($cmd =~ s/(\d*)(<|>)((\/(tmp\/.webmin|dev)\S+)|&\d+)\s*$//) { }
4787 $cmd =~ s/^\((.*)\)\s*$/$1/;
4789 &additional_log('exec', undef, $cmd);
4790 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
4794 =head2 backquote_with_timeout(command, timeout, safe?, [maxlines])
4796 Runs some command, waiting at most the given number of seconds for it to
4797 complete, and returns the output. The maxlines parameter sets the number
4798 of lines of output to capture. The safe parameter should be set to 1 if the
4799 command is safe for read-only mode users to run.
4802 sub backquote_with_timeout
4804 my $realcmd = &translate_command($_[0]);
4805 &webmin_debug_log('CMD', "cmd=$realcmd timeout=$_[1]")
4806 if ($gconfig{'debug_what_cmd'});
4808 my $pid = &open_execute_command(OUT, "($realcmd) <$null_file", 1, $_[2]);
4813 my $elapsed = time() - $start;
4814 last if ($elapsed > $_[1]);
4816 vec($rmask, fileno(OUT), 1) = 1;
4817 my $sel = select($rmask, undef, undef, $_[1] - $elapsed);
4818 last if (!$sel || $sel < 0);
4820 last if (!defined($line));
4823 if ($_[3] && $linecount >= $_[3]) {
4828 if (kill('TERM', $pid) && time() - $start >= $_[1]) {
4832 return wantarray ? ($out, $timed_out) : $out;
4835 =head2 backquote_command(command, safe?)
4837 Executes a command and returns the output (like `command`), subject to
4838 command translation. The safe parameter should be set to 1 if the command
4839 is safe for read-only mode users to run.
4842 sub backquote_command
4844 if (&is_readonly_mode() && !$_[1]) {
4845 print STDERR "Vetoing command $_[0]\n";
4849 my $realcmd = &translate_command($_[0]);
4850 &webmin_debug_log('CMD', "cmd=$realcmd") if ($gconfig{'debug_what_cmd'});
4854 =head2 kill_logged(signal, pid, ...)
4856 Like Perl's built-in kill function, but also logs the fact that some process
4857 was killed. On Windows, falls back to calling process.exe to terminate a
4863 return scalar(@_)-1 if (&is_readonly_mode());
4864 &webmin_debug_log('KILL', "signal=$_[0] pids=".join(" ", @_[1..@_-1]))
4865 if ($gconfig{'debug_what_procs'});
4866 &additional_log('kill', $_[0], join(" ", @_[1..@_-1])) if (@_ > 1);
4867 if ($gconfig{'os_type'} eq 'windows') {
4868 # Emulate some kills with process.exe
4869 my $arg = $_[0] eq "KILL" ? "-k" :
4870 $_[0] eq "TERM" ? "-q" :
4871 $_[0] eq "STOP" ? "-s" :
4872 $_[0] eq "CONT" ? "-r" : undef;
4874 foreach my $p (@_[1..@_-1]) {
4876 $ok ||= kill($_[0], $p);
4879 &execute_command("process $arg $p");
4891 =head2 rename_logged(old, new)
4893 Re-names a file and logs the rename. If the old and new files are on different
4894 filesystems, calls mv or the Windows rename function to do the job.
4899 &additional_log('rename', $_[0], $_[1]) if ($_[0] ne $_[1]);
4900 return &rename_file($_[0], $_[1]);
4903 =head2 rename_file(old, new)
4905 Renames a file or directory. If the old and new files are on different
4906 filesystems, calls mv or the Windows rename function to do the job.
4911 if (&is_readonly_mode()) {
4912 print STDERR "Vetoing rename from $_[0] to $_[1]\n";
4915 my $src = &translate_filename($_[0]);
4916 my $dst = &translate_filename($_[1]);
4917 &webmin_debug_log('RENAME', "src=$src dst=$dst")
4918 if ($gconfig{'debug_what_ops'});
4919 my $ok = rename($src, $dst);
4920 if (!$ok && $! !~ /permission/i) {
4921 # Try the mv command, in case this is a cross-filesystem rename
4922 if ($gconfig{'os_type'} eq 'windows') {
4923 # Need to use rename
4924 my $out = &backquote_command("rename ".quotemeta($_[0]).
4925 " ".quotemeta($_[1])." 2>&1");
4927 $! = $out if (!$ok);
4931 my $out = &backquote_command("mv ".quotemeta($_[0]).
4932 " ".quotemeta($_[1])." 2>&1");
4934 $! = $out if (!$ok);
4940 =head2 symlink_logged(src, dest)
4942 Create a symlink, and logs it. Effectively does the same thing as the Perl
4949 my $rv = &symlink_file($_[0], $_[1]);
4950 &unlock_file($_[1]);
4954 =head2 symlink_file(src, dest)
4956 Creates a soft link, unless in read-only mode. Effectively does the same thing
4957 as the Perl symlink function.
4962 if (&is_readonly_mode()) {
4963 print STDERR "Vetoing symlink from $_[0] to $_[1]\n";
4966 my $src = &translate_filename($_[0]);
4967 my $dst = &translate_filename($_[1]);
4968 &webmin_debug_log('SYMLINK', "src=$src dst=$dst")
4969 if ($gconfig{'debug_what_ops'});
4970 return symlink($src, $dst);
4973 =head2 link_file(src, dest)
4975 Creates a hard link, unless in read-only mode. The existing new link file
4976 will be deleted if necessary. Effectively the same as Perl's link function.
4981 if (&is_readonly_mode()) {
4982 print STDERR "Vetoing link from $_[0] to $_[1]\n";
4985 my $src = &translate_filename($_[0]);
4986 my $dst = &translate_filename($_[1]);
4987 &webmin_debug_log('LINK', "src=$src dst=$dst")
4988 if ($gconfig{'debug_what_ops'});
4989 unlink($dst); # make sure link works
4990 return link($src, $dst);
4993 =head2 make_dir(dir, perms, recursive)
4995 Creates a directory and sets permissions on it, unless in read-only mode.
4996 The perms parameter sets the octal permissions to apply, which unlike Perl's
4997 mkdir will really get set. The recursive flag can be set to 1 to have the
4998 function create parent directories too.
5003 my ($dir, $perms, $recur) = @_;
5004 if (&is_readonly_mode()) {
5005 print STDERR "Vetoing directory $dir\n";
5008 $dir = &translate_filename($dir);
5009 my $exists = -d $dir ? 1 : 0;
5010 return 1 if ($exists && $recur); # already exists
5011 &webmin_debug_log('MKDIR', $dir) if ($gconfig{'debug_what_ops'});
5012 my $rv = mkdir($dir, $perms);
5013 if (!$rv && $recur) {
5014 # Failed .. try mkdir -p
5015 my $param = $gconfig{'os_type'} eq 'windows' ? "" : "-p";
5016 my $ex = &execute_command("mkdir $param "."e_path($dir));
5022 chmod($perms, $dir);
5027 =head2 set_ownership_permissions(user, group, perms, file, ...)
5029 Sets the user, group owner and permissions on some files. The parameters are :
5031 =item user - UID or username to change the file owner to. If undef, then the owner is not changed.
5033 =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.
5035 =item perms - Octal permissions set to set on the file. If undef, they are left alone.
5037 =item file - One or more files or directories to modify.
5040 sub set_ownership_permissions
5042 my ($user, $group, $perms, @files) = @_;
5043 if (&is_readonly_mode()) {
5044 print STDERR "Vetoing permission changes on ",join(" ", @files),"\n";
5047 @files = map { &translate_filename($_) } @files;
5048 if ($gconfig{'debug_what_ops'}) {
5049 foreach my $f (@files) {
5050 &webmin_debug_log('PERMS',
5051 "file=$f user=$user group=$group perms=$perms");
5055 if (defined($user)) {
5056 my $uid = $user !~ /^\d+$/ ? getpwnam($user) : $user;
5058 if (defined($group)) {
5059 $gid = $group !~ /^\d+$/ ? getgrnam($group) : $group;
5062 my @uinfo = getpwuid($uid);
5065 $rv = chown($uid, $gid, @files);
5067 if ($rv && defined($perms)) {
5068 $rv = chmod($perms, @files);
5073 =head2 unlink_logged(file, ...)
5075 Like Perl's unlink function, but locks the files beforehand and un-locks them
5076 after so that the deletion is logged by Webmin.
5082 foreach my $f (@_) {
5083 if (!&test_lock($f)) {
5088 my @rv = &unlink_file(@_);
5089 foreach my $f (@_) {
5094 return wantarray ? @rv : $rv[0];
5097 =head2 unlink_file(file, ...)
5099 Deletes some files or directories. Like Perl's unlink function, but also
5100 recursively deletes directories with the rm command if needed.
5105 return 1 if (&is_readonly_mode());
5108 foreach my $f (@_) {
5109 my $realf = &translate_filename($f);
5110 &webmin_debug_log('UNLINK', $realf) if ($gconfig{'debug_what_ops'});
5112 if (!rmdir($realf)) {
5114 if ($gconfig{'os_type'} eq 'windows') {
5115 # Call del and rmdir commands
5118 my $out = `del /q "$qm" 2>&1`;
5120 $out = `rmdir "$qm" 2>&1`;
5125 my $qm = quotemeta($realf);
5126 $out = `rm -rf $qm 2>&1`;
5135 if (!unlink($realf)) {
5141 return wantarray ? ($rv, $err) : $rv;
5144 =head2 copy_source_dest(source, dest)
5146 Copy some file or directory to a new location. Returns 1 on success, or 0
5147 on failure - also sets $! on failure. If the source is a directory, uses
5148 piped tar commands to copy a whole directory structure including permissions
5152 sub copy_source_dest
5154 return (1, undef) if (&is_readonly_mode());
5155 my ($src, $dst) = @_;
5158 &webmin_debug_log('COPY', "src=$src dst=$dst")
5159 if ($gconfig{'debug_what_ops'});
5160 if ($gconfig{'os_type'} eq 'windows') {
5161 # No tar or cp on windows, so need to use copy command
5165 $out = &backquote_logged("xcopy \"$src\" \"$dst\" /Y /E /I 2>&1");
5168 $out = &backquote_logged("copy /Y \"$src\" \"$dst\" 2>&1");
5176 # A directory .. need to copy with tar command
5177 my @st = stat($src);
5180 &set_ownership_permissions($st[4], $st[5], $st[2], $dst);
5181 $out = &backquote_logged("(cd ".quotemeta($src)." ; tar cf - . | (cd ".quotemeta($dst)." ; tar xf -)) 2>&1");
5188 # Can just copy with cp
5189 my $out = &backquote_logged("cp -p ".quotemeta($src).
5190 " ".quotemeta($dst)." 2>&1");
5196 return wantarray ? ($ok, $err) : $ok;
5199 =head2 remote_session_name(host|&server)
5201 Generates a session ID for some server. For this server, this will always
5202 be an empty string. For a server object it will include the hostname and
5203 port and PID. For a server name, it will include the hostname and PID. For
5207 sub remote_session_name
5209 return ref($_[0]) && $_[0]->{'host'} && $_[0]->{'port'} ?
5210 "$_[0]->{'host'}:$_[0]->{'port'}.$$" :
5211 $_[0] eq "" || ref($_[0]) && $_[0]->{'id'} == 0 ? "" :
5212 ref($_[0]) ? "" : "$_[0].$$";
5215 =head2 remote_foreign_require(server, module, file)
5217 Connects to rpc.cgi on a remote webmin server and have it open a session
5218 to a process that will actually do the require and run functions. This is the
5219 equivalent for foreign_require, but for a remote Webmin system. The server
5220 parameter can either be a hostname of a system registered in the Webmin
5221 Servers Index module, or a hash reference for a system from that module.
5224 sub remote_foreign_require
5226 my $call = { 'action' => 'require',
5229 my $sn = &remote_session_name($_[0]);
5230 if ($remote_session{$sn}) {
5231 $call->{'session'} = $remote_session{$sn};
5234 $call->{'newsession'} = 1;
5236 my $rv = &remote_rpc_call($_[0], $call);
5237 if ($rv->{'session'}) {
5238 $remote_session{$sn} = $rv->{'session'};
5239 $remote_session_server{$sn} = $_[0];
5243 =head2 remote_foreign_call(server, module, function, [arg]*)
5245 Call a function on a remote server. Must have been setup first with
5246 remote_foreign_require for the same server and module. Equivalent to
5247 foreign_call, but with the extra server parameter to specify the remote
5251 sub remote_foreign_call
5253 return undef if (&is_readonly_mode());
5254 my $sn = &remote_session_name($_[0]);
5255 return &remote_rpc_call($_[0], { 'action' => 'call',
5258 'session' => $remote_session{$sn},
5259 'args' => [ @_[3 .. $#_] ] } );
5262 =head2 remote_foreign_check(server, module, [api-only])
5264 Checks if some module is installed and supported on a remote server. Equivilant
5265 to foreign_check, but for the remote Webmin system specified by the server
5269 sub remote_foreign_check
5271 return &remote_rpc_call($_[0], { 'action' => 'check',
5276 =head2 remote_foreign_config(server, module)
5278 Gets the configuration for some module from a remote server, as a hash.
5279 Equivalent to foreign_config, but for a remote system.
5282 sub remote_foreign_config
5284 return &remote_rpc_call($_[0], { 'action' => 'config',
5285 'module' => $_[1] });
5288 =head2 remote_eval(server, module, code)
5290 Evaluates some perl code in the context of a module on a remote webmin server.
5291 The server parameter must be the hostname of a remote system, module must
5292 be a module directory name, and code a string of Perl code to run. This can
5293 only be called after remote_foreign_require for the same server and module.
5298 return undef if (&is_readonly_mode());
5299 my $sn = &remote_session_name($_[0]);
5300 return &remote_rpc_call($_[0], { 'action' => 'eval',
5303 'session' => $remote_session{$sn} });
5306 =head2 remote_write(server, localfile, [remotefile], [remotebasename])
5308 Transfers some local file to another server via Webmin's RPC protocol, and
5309 returns the resulting remote filename. If the remotefile parameter is given,
5310 that is the destination filename which will be used. Otherwise a randomly
5311 selected temporary filename will be used, and returned by the function.
5316 return undef if (&is_readonly_mode());
5318 my $sn = &remote_session_name($_[0]);
5319 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
5320 # Copy data over TCP connection
5321 my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpwrite',
5323 'name' => $_[3] } );
5325 my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
5326 &open_socket($serv || "localhost", $rv->[1], TWRITE, \$error);
5327 return &$main::remote_error_handler("Failed to transfer file : $error")
5330 while(read(FILE, $got, 1024) > 0) {
5334 shutdown(TWRITE, 1);
5336 if ($error && $error !~ /^OK/) {
5337 # Got back an error!
5338 return &$main::remote_error_handler("Failed to transfer file : $error");
5344 # Just pass file contents as parameters
5346 while(read(FILE, $got, 1024) > 0) {
5350 return &remote_rpc_call($_[0], { 'action' => 'write',
5353 'session' => $remote_session{$sn} });
5357 =head2 remote_read(server, localfile, remotefile)
5359 Transfers a file from a remote server to this system, using Webmin's RPC
5360 protocol. The server parameter must be the hostname of a system registered
5361 in the Webmin Servers Index module, localfile is the destination path on this
5362 system, and remotefile is the file to fetch from the remote server.
5367 my $sn = &remote_session_name($_[0]);
5368 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
5369 # Copy data over TCP connection
5370 my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpread',
5371 'file' => $_[2] } );
5373 return &$main::remote_error_handler("Failed to transfer file : $rv->[1]");
5376 my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
5377 &open_socket($serv || "localhost", $rv->[1], TREAD, \$error);
5378 return &$main::remote_error_handler("Failed to transfer file : $error")
5381 open(FILE, ">$_[1]");
5382 while(read(TREAD, $got, 1024) > 0) {
5389 # Just get data as return value
5390 my $d = &remote_rpc_call($_[0], { 'action' => 'read',
5392 'session' => $remote_session{$sn} });
5393 open(FILE, ">$_[1]");
5399 =head2 remote_finished
5401 Close all remote sessions. This happens automatically after a while
5402 anyway, but this function should be called to clean things up faster.
5407 foreach my $sn (keys %remote_session) {
5408 my $server = $remote_session_server{$sn};
5409 &remote_rpc_call($server, { 'action' => 'quit',
5410 'session' => $remote_session{$sn} } );
5411 delete($remote_session{$sn});
5412 delete($remote_session_server{$sn});
5414 foreach $fh (keys %fast_fh_cache) {
5416 delete($fast_fh_cache{$fh});
5420 =head2 remote_error_setup(&function)
5422 Sets a function to be called instead of &error when a remote RPC operation
5423 fails. Useful if you want to have more control over your remote operations.
5426 sub remote_error_setup
5428 $main::remote_error_handler = $_[0] || \&error;
5431 =head2 remote_rpc_call(server, structure)
5433 Calls rpc.cgi on some server and passes it a perl structure (hash,array,etc)
5434 and then reads back a reply structure. This is mainly for internal use only,
5435 and is called by the other remote_* functions.
5441 my $sn = &remote_session_name($_[0]); # Will be undef for local connection
5443 # Server structure was given
5445 $serv->{'user'} || $serv->{'id'} == 0 ||
5446 return &$main::remote_error_handler(
5447 "No Webmin login set for server");
5450 # lookup the server in the webmin servers module if needed
5451 if (!defined(%main::remote_servers_cache)) {
5452 &foreign_require("servers", "servers-lib.pl");
5453 foreach $s (&foreign_call("servers", "list_servers")) {
5454 $main::remote_servers_cache{$s->{'host'}} = $s;
5455 $main::remote_servers_cache{$s->{'host'}.":".$s->{'port'}} = $s;
5458 $serv = $main::remote_servers_cache{$_[0]};
5459 $serv || return &$main::remote_error_handler(
5460 "No Webmin Servers entry for $_[0]");
5461 $serv->{'user'} || return &$main::remote_error_handler(
5462 "No login set for server $_[0]");
5464 my $ip = $serv->{'ip'} || $serv->{'host'};
5466 # Work out the username and password
5468 if ($serv->{'sameuser'}) {
5469 $user = $remote_user;
5470 defined($main::remote_pass) || return &$main::remote_error_handler(
5471 "Password for this server is not available");
5472 $pass = $main::remote_pass;
5475 $user = $serv->{'user'};
5476 $pass = $serv->{'pass'};
5479 if ($serv->{'fast'} || !$sn) {
5480 # Make TCP connection call to fastrpc.cgi
5481 if (!$fast_fh_cache{$sn} && $sn) {
5482 # Need to open the connection
5483 my $con = &make_http_connection(
5484 $ip, $serv->{'port'}, $serv->{'ssl'},
5485 "POST", "/fastrpc.cgi");
5486 return &$main::remote_error_handler(
5487 "Failed to connect to $serv->{'host'} : $con")
5489 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
5490 &write_http_connection($con, "User-agent: Webmin\r\n");
5491 my $auth = &encode_base64("$user:$pass");
5493 &write_http_connection($con, "Authorization: basic $auth\r\n");
5494 &write_http_connection($con, "Content-length: ",
5495 length($tostr),"\r\n");
5496 &write_http_connection($con, "\r\n");
5497 &write_http_connection($con, $tostr);
5499 # read back the response
5500 my $line = &read_http_connection($con);
5501 $line =~ tr/\r\n//d;
5502 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
5503 return &$main::remote_error_handler("Login to RPC server as $user rejected");
5505 $line =~ /^HTTP\/1\..\s+200\s+/ ||
5506 return &$main::remote_error_handler("HTTP error : $line");
5508 $line = &read_http_connection($con);
5509 $line =~ tr/\r\n//d;
5511 $line = &read_http_connection($con);
5512 if ($line =~ /^0\s+(.*)/) {
5513 return &$main::remote_error_handler("RPC error : $1");
5515 elsif ($line =~ /^1\s+(\S+)\s+(\S+)\s+(\S+)/ ||
5516 $line =~ /^1\s+(\S+)\s+(\S+)/) {
5517 # Started ok .. connect and save SID
5518 &close_http_connection($con);
5519 my ($port, $sid, $version, $error) = ($1, $2, $3);
5520 &open_socket($ip, $port, $sid, \$error);
5521 return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error")
5523 $fast_fh_cache{$sn} = $sid;
5524 $remote_server_version{$sn} = $version;
5527 while($stuff = &read_http_connection($con)) {
5530 return &$main::remote_error_handler("Bad response from fastrpc.cgi : $line");
5533 elsif (!$fast_fh_cache{$sn}) {
5534 # Open the connection by running fastrpc.cgi locally
5535 pipe(RPCOUTr, RPCOUTw);
5539 open(STDOUT, ">&RPCOUTw");
5543 $ENV{'REQUEST_METHOD'} = 'GET';
5544 $ENV{'SCRIPT_NAME'} = '/fastrpc.cgi';
5545 $ENV{'SERVER_ROOT'} ||= $root_directory;
5547 if ($base_remote_user ne 'root' &&
5548 $base_remote_user ne 'admin') {
5549 # Need to fake up a login for the CGI!
5550 &read_acl(undef, \%acl);
5551 $ENV{'BASE_REMOTE_USER'} =
5552 $ENV{'REMOTE_USER'} =
5553 $acl{'root'} ? 'root' : 'admin';
5555 delete($ENV{'FOREIGN_MODULE_NAME'});
5556 delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
5557 chdir($root_directory);
5558 if (!exec("$root_directory/fastrpc.cgi")) {
5559 print "exec failed : $!\n";
5566 ($line = <RPCOUTr>) =~ tr/\r\n//d;
5570 if ($line =~ /^0\s+(.*)/) {
5571 return &$main::remote_error_handler("RPC error : $2");
5573 elsif ($line =~ /^1\s+(\S+)\s+(\S+)/) {
5574 # Started ok .. connect and save SID
5576 my ($port, $sid, $error) = ($1, $2, undef);
5577 &open_socket("localhost", $port, $sid, \$error);
5578 return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error") if ($error);
5579 $fast_fh_cache{$sn} = $sid;
5586 &error("Bad response from fastrpc.cgi : $line");
5589 # Got a connection .. send off the request
5590 my $fh = $fast_fh_cache{$sn};
5591 my $tostr = &serialise_variable($_[1]);
5592 print $fh length($tostr)," $fh\n";
5594 my $rlen = int(<$fh>);
5595 my ($fromstr, $got);
5596 while(length($fromstr) < $rlen) {
5597 return &$main::remote_error_handler("Failed to read from fastrpc.cgi")
5598 if (read($fh, $got, $rlen - length($fromstr)) <= 0);
5601 my $from = &unserialise_variable($fromstr);
5603 return &$main::remote_error_handler("Remote Webmin error");
5605 if (defined($from->{'arv'})) {
5606 return @{$from->{'arv'}};
5609 return $from->{'rv'};
5613 # Call rpc.cgi on remote server
5614 my $tostr = &serialise_variable($_[1]);
5616 my $con = &make_http_connection($ip, $serv->{'port'},
5617 $serv->{'ssl'}, "POST", "/rpc.cgi");
5618 return &$main::remote_error_handler("Failed to connect to $serv->{'host'} : $con") if (!ref($con));
5620 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
5621 &write_http_connection($con, "User-agent: Webmin\r\n");
5622 my $auth = &encode_base64("$user:$pass");
5624 &write_http_connection($con, "Authorization: basic $auth\r\n");
5625 &write_http_connection($con, "Content-length: ",length($tostr),"\r\n");
5626 &write_http_connection($con, "\r\n");
5627 &write_http_connection($con, $tostr);
5629 # read back the response
5630 my $line = &read_http_connection($con);
5631 $line =~ tr/\r\n//d;
5632 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
5633 return &$main::remote_error_handler("Login to RPC server as $user rejected");
5635 $line =~ /^HTTP\/1\..\s+200\s+/ || return &$main::remote_error_handler("RPC HTTP error : $line");
5637 $line = &read_http_connection($con);
5638 $line =~ tr/\r\n//d;
5641 while($line = &read_http_connection($con)) {
5645 my $from = &unserialise_variable($fromstr);
5646 return &$main::remote_error_handler("Invalid RPC login to $serv->{'host'}") if (!$from->{'status'});
5647 if (defined($from->{'arv'})) {
5648 return @{$from->{'arv'}};
5651 return $from->{'rv'};
5656 =head2 remote_multi_callback(&servers, parallel, &function, arg|&args, &returns, &errors, [module, library])
5658 Executes some function in parallel on multiple servers at once. Fills in
5659 the returns and errors arrays respectively. If the module and library
5660 parameters are given, that module is remotely required on the server first,
5661 to check if it is connectable. The parameters are :
5663 =item servers - A list of Webmin system hash references.
5665 =item parallel - Number of parallel operations to perform.
5667 =item function - Reference to function to call for each system.
5669 =item args - Additional parameters to the function.
5671 =item returns - Array ref to place return values into, in same order as servers.
5673 =item errors - Array ref to place error messages into.
5675 =item module - Optional module to require on the remote system first.
5677 =item library - Optional library to require in the module.
5680 sub remote_multi_callback
5682 my ($servs, $parallel, $func, $args, $rets, $errs, $mod, $lib) = @_;
5683 &remote_error_setup(\&remote_multi_callback_error);
5685 # Call the functions
5687 foreach my $g (@$servs) {
5693 $remote_multi_callback_err = undef;
5695 # Require the remote lib
5696 &remote_foreign_require($g->{'host'}, $mod, $lib);
5697 if ($remote_multi_callback_err) {
5698 # Failed .. return error
5699 print $wh &serialise_variable(
5700 [ undef, $remote_multi_callback_err ]);
5706 my $a = ref($args) ? $args->[$p] : $args;
5707 my $rv = &$func($g, $a);
5710 print $wh &serialise_variable(
5711 [ $rv, $remote_multi_callback_err ]);
5719 # Read back the results
5721 foreach my $g (@$servs) {
5725 $errs->[$p] = "Failed to read response from $g->{'host'}";
5728 my $rv = &unserialise_variable($line);
5730 $rets->[$p] = $rv->[0];
5731 $errs->[$p] = $rv->[1];
5736 &remote_error_setup(undef);
5739 sub remote_multi_callback_error
5741 $remote_multi_callback_err = $_[0];
5744 =head2 serialise_variable(variable)
5746 Converts some variable (maybe a scalar, hash ref, array ref or scalar ref)
5747 into a url-encoded string. In the cases of arrays and hashes, it is recursively
5748 called on each member to serialize the entire object.
5751 sub serialise_variable
5753 if (!defined($_[0])) {
5759 $rv = &urlize($_[0]);
5761 elsif ($r eq 'SCALAR') {
5762 $rv = &urlize(${$_[0]});
5764 elsif ($r eq 'ARRAY') {
5765 $rv = join(",", map { &urlize(&serialise_variable($_)) } @{$_[0]});
5767 elsif ($r eq 'HASH') {
5768 $rv = join(",", map { &urlize(&serialise_variable($_)).",".
5769 &urlize(&serialise_variable($_[0]->{$_})) }
5772 elsif ($r eq 'REF') {
5773 $rv = &serialise_variable(${$_[0]});
5775 elsif ($r eq 'CODE') {
5780 # An object - treat as a hash
5781 $r = "OBJECT ".&urlize($r);
5782 $rv = join(",", map { &urlize(&serialise_variable($_)).",".
5783 &urlize(&serialise_variable($_[0]->{$_})) }
5786 return ($r ? $r : 'VAL').",".$rv;
5789 =head2 unserialise_variable(string)
5791 Converts a string created by serialise_variable() back into the original
5792 scalar, hash ref, array ref or scalar ref. If the original variable was a Perl
5793 object, the same class is used on this system, if available.
5796 sub unserialise_variable
5798 my @v = split(/,/, $_[0]);
5800 if ($v[0] eq 'VAL') {
5801 @v = split(/,/, $_[0], -1);
5802 $rv = &un_urlize($v[1]);
5804 elsif ($v[0] eq 'SCALAR') {
5805 local $r = &un_urlize($v[1]);
5808 elsif ($v[0] eq 'ARRAY') {
5810 for(my $i=1; $i<@v; $i++) {
5811 push(@$rv, &unserialise_variable(&un_urlize($v[$i])));
5814 elsif ($v[0] eq 'HASH') {
5816 for(my $i=1; $i<@v; $i+=2) {
5817 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
5818 &unserialise_variable(&un_urlize($v[$i+1]));
5821 elsif ($v[0] eq 'REF') {
5822 local $r = &unserialise_variable($v[1]);
5825 elsif ($v[0] eq 'UNDEF') {
5828 elsif ($v[0] =~ /^OBJECT\s+(.*)$/) {
5829 # An object hash that we have to re-bless
5832 for(my $i=1; $i<@v; $i+=2) {
5833 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
5834 &unserialise_variable(&un_urlize($v[$i+1]));
5842 =head2 other_groups(user)
5844 Returns a list of secondary groups a user is a member of, as a list of
5853 while(my @g = getgrent()) {
5854 my @m = split(/\s+/, $g[3]);
5855 push(@rv, $g[2]) if (&indexof($user, @m) >= 0);
5857 endgrent() if ($gconfig{'os_type'} ne 'hpux');
5861 =head2 date_chooser_button(dayfield, monthfield, yearfield)
5863 Returns HTML for a button that pops up a data chooser window. The parameters
5866 =item dayfield - Name of the text field to place the day of the month into.
5868 =item monthfield - Name of the select field to select the month of the year in, indexed from 1.
5870 =item yearfield - Name of the text field to place the year into.
5873 sub date_chooser_button
5875 return &theme_date_chooser_button(@_)
5876 if (defined(&theme_date_chooser_button));
5877 my ($w, $h) = (250, 225);
5878 if ($gconfig{'db_sizedate'}) {
5879 ($w, $h) = split(/x/, $gconfig{'db_sizedate'});
5881 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";
5884 =head2 help_file(module, file)
5886 Returns the path to a module's help file of some name, typically under the
5887 help directory with a .html extension.
5892 my $mdir = &module_root_directory($_[0]);
5893 my $dir = "$mdir/help";
5894 foreach my $o (@lang_order_list) {
5895 my $lang = "$dir/$_[1].$o.html";
5896 return $lang if (-r $lang);
5898 return "$dir/$_[1].html";
5903 Seeds the random number generator, if not already done in this script. On Linux
5904 this makes use of the current time, process ID and a read from /dev/urandom.
5905 On other systems, only the current time and process ID are used.
5910 if (!$main::done_seed_random) {
5911 if (open(RANDOM, "/dev/urandom")) {
5913 read(RANDOM, $buf, 4);
5915 srand(time() ^ $$ ^ $buf);
5920 $main::done_seed_random = 1;
5924 =head2 disk_usage_kb(directory)
5926 Returns the number of kB used by some directory and all subdirs. Implemented
5927 by calling the C<du -k> command.
5932 my $dir = &translate_filename($_[0]);
5934 my $ex = &execute_command("du -sk ".quotemeta($dir), undef, \$out, undef, 0, 1);
5936 &execute_command("du -s ".quotemeta($dir), undef, \$out, undef, 0, 1);
5938 return $out =~ /^([0-9]+)/ ? $1 : "???";
5941 =head2 recursive_disk_usage(directory, [skip-regexp], [only-regexp])
5943 Returns the number of bytes taken up by all files in some directory and all
5944 sub-directories, by summing up their lengths. The disk_usage_kb is more
5945 reflective of reality, as the filesystem typically pads file sizes to 1k or
5949 sub recursive_disk_usage
5951 my $dir = &translate_filename($_[0]);
5958 my @st = stat($dir);
5964 my @files = readdir(DIR);
5966 foreach my $f (@files) {
5967 next if ($f eq "." || $f eq "..");
5968 next if ($skip && $f =~ /$skip/);
5969 next if ($only && $f !~ /$only/);
5970 $rv += &recursive_disk_usage("$dir/$f", $skip, $only);
5976 =head2 help_search_link(term, [ section, ... ] )
5978 Returns HTML for a link to the man module for searching local and online
5979 docs for various search terms. The term parameter can either be a single
5980 word like 'bind', or a space-separated list of words. This function is typically
5981 used by modules that want to refer users to additional documentation in man
5982 pages or local system doc files.
5985 sub help_search_link
5987 if (&foreign_available("man") && !$tconfig{'nosearch'}) {
5988 my $for = &urlize(shift(@_));
5989 return "<a href='$gconfig{'webprefix'}/man/search.cgi?".
5990 join("&", map { "section=$_" } @_)."&".
5991 "for=$for&exact=1&check=".&get_module_name()."'>".
5992 $text{'helpsearch'}."</a>\n";
5999 =head2 make_http_connection(host, port, ssl, method, page, [&headers])
6001 Opens a connection to some HTTP server, maybe through a proxy, and returns
6002 a handle object. The handle can then be used to send additional headers
6003 and read back a response. If anything goes wrong, returns an error string.
6004 The parameters are :
6006 =item host - Hostname or IP address of the webserver to connect to.
6008 =item port - HTTP port number to connect to.
6010 =item ssl - Set to 1 to connect in SSL mode.
6012 =item method - HTTP method, like GET or POST.
6014 =item page - Page to request on the webserver, like /foo/index.html
6016 =item headers - Array ref of additional HTTP headers, each of which is a 2-element array ref.
6019 sub make_http_connection
6021 my ($host, $port, $ssl, $method, $page, $headers) = @_;
6024 foreach my $h (@$headers) {
6025 $htxt .= $h->[0].": ".$h->[1]."\r\n";
6029 if (&is_readonly_mode()) {
6030 return "HTTP connections not allowed in readonly mode";
6032 my $rv = { 'fh' => time().$$ };
6035 eval "use Net::SSLeay";
6036 $@ && return $text{'link_essl'};
6037 eval "Net::SSLeay::SSLeay_add_ssl_algorithms()";
6038 eval "Net::SSLeay::load_error_strings()";
6039 $rv->{'ssl_ctx'} = Net::SSLeay::CTX_new() ||
6040 return "Failed to create SSL context";
6041 $rv->{'ssl_con'} = Net::SSLeay::new($rv->{'ssl_ctx'}) ||
6042 return "Failed to create SSL connection";
6044 if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6045 !&no_proxy($host)) {
6048 &open_socket($1, $2, $rv->{'fh'}, \$error);
6051 my $fh = $rv->{'fh'};
6052 print $fh "CONNECT $host:$port HTTP/1.0\r\n";
6053 if ($gconfig{'proxy_user'}) {
6054 my $auth = &encode_base64(
6055 "$gconfig{'proxy_user'}:".
6056 "$gconfig{'proxy_pass'}");
6057 $auth =~ tr/\r\n//d;
6058 print $fh "Proxy-Authorization: Basic $auth\r\n";
6062 if ($line =~ /^HTTP(\S+)\s+(\d+)\s+(.*)/) {
6063 return "Proxy error : $3" if ($2 != 200);
6066 return "Proxy error : $line";
6071 elsif (!$gconfig{'proxy_fallback'}) {
6072 # Connection to proxy failed - give up
6079 &open_socket($host, $port, $rv->{'fh'}, \$error);
6080 return $error if ($error);
6082 Net::SSLeay::set_fd($rv->{'ssl_con'}, fileno($rv->{'fh'}));
6083 Net::SSLeay::connect($rv->{'ssl_con'}) ||
6084 return "SSL connect() failed";
6085 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6086 Net::SSLeay::write($rv->{'ssl_con'}, $rtxt);
6089 # Plain HTTP request
6091 if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6092 !&no_proxy($host)) {
6095 &open_socket($1, $2, $rv->{'fh'}, \$error);
6099 my $fh = $rv->{'fh'};
6100 my $rtxt = $method." ".
6101 "http://$host:$port$page HTTP/1.0\r\n";
6102 if ($gconfig{'proxy_user'}) {
6103 my $auth = &encode_base64(
6104 "$gconfig{'proxy_user'}:".
6105 "$gconfig{'proxy_pass'}");
6106 $auth =~ tr/\r\n//d;
6107 $rtxt .= "Proxy-Authorization: Basic $auth\r\n";
6112 elsif (!$gconfig{'proxy_fallback'}) {
6117 # Connecting directly
6119 &open_socket($host, $port, $rv->{'fh'}, \$error);
6120 return $error if ($error);
6121 my $fh = $rv->{'fh'};
6122 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6129 =head2 read_http_connection(&handle, [bytes])
6131 Reads either one line or up to the specified number of bytes from the handle,
6132 originally supplied by make_http_connection.
6135 sub read_http_connection
6139 if ($h->{'ssl_con'}) {
6142 while(($idx = index($h->{'buffer'}, "\n")) < 0) {
6143 # need to read more..
6144 if (!($more = Net::SSLeay::read($h->{'ssl_con'}))) {
6146 $rv = $h->{'buffer'};
6147 delete($h->{'buffer'});
6150 $h->{'buffer'} .= $more;
6152 $rv = substr($h->{'buffer'}, 0, $idx+1);
6153 $h->{'buffer'} = substr($h->{'buffer'}, $idx+1);
6156 if (length($h->{'buffer'})) {
6157 $rv = $h->{'buffer'};
6158 delete($h->{'buffer'});
6161 $rv = Net::SSLeay::read($h->{'ssl_con'}, $_[1]);
6167 read($h->{'fh'}, $rv, $_[1]) > 0 || return undef;
6170 my $fh = $h->{'fh'};
6174 $rv = undef if ($rv eq "");
6178 =head2 write_http_connection(&handle, [data+])
6180 Writes the given data to the given HTTP connection handle.
6183 sub write_http_connection
6186 my $fh = $h->{'fh'};
6188 if ($h->{'ssl_ctx'}) {
6189 foreach my $s (@_) {
6190 my $ok = Net::SSLeay::write($h->{'ssl_con'}, $s);
6191 $allok = 0 if (!$ok);
6195 my $ok = (print $fh @_);
6196 $allok = 0 if (!$ok);
6201 =head2 close_http_connection(&handle)
6203 Closes a connection to an HTTP server, identified by the given handle.
6206 sub close_http_connection
6212 =head2 clean_environment
6214 Deletes any environment variables inherited from miniserv so that they
6215 won't be passed to programs started by webmin. This is useful when calling
6216 programs that check for CGI-related environment variables and modify their
6217 behaviour, and to avoid passing sensitive variables to un-trusted programs.
6220 sub clean_environment
6222 %UNCLEAN_ENV = %ENV;
6223 foreach my $k (keys %ENV) {
6224 if ($k =~ /^(HTTP|VIRTUALSERVER|QUOTA|USERADMIN)_/) {
6228 foreach my $e ('WEBMIN_CONFIG', 'SERVER_NAME', 'CONTENT_TYPE', 'REQUEST_URI',
6229 'PATH_INFO', 'WEBMIN_VAR', 'REQUEST_METHOD', 'GATEWAY_INTERFACE',
6230 'QUERY_STRING', 'REMOTE_USER', 'SERVER_SOFTWARE', 'SERVER_PROTOCOL',
6231 'REMOTE_HOST', 'SERVER_PORT', 'DOCUMENT_ROOT', 'SERVER_ROOT',
6232 'MINISERV_CONFIG', 'SCRIPT_NAME', 'SERVER_ADMIN', 'CONTENT_LENGTH',
6233 'HTTPS', 'FOREIGN_MODULE_NAME', 'FOREIGN_ROOT_DIRECTORY',
6234 'SCRIPT_FILENAME', 'PATH_TRANSLATED', 'BASE_REMOTE_USER',
6235 'DOCUMENT_REALROOT', 'MINISERV_CONFIG', 'MYSQL_PWD') {
6240 =head2 reset_environment
6242 Puts the environment back how it was before clean_environment was callled.
6245 sub reset_environment
6247 if (defined(%UNCLEAN_ENV)) {
6248 foreach my $k (keys %UNCLEAN_ENV) {
6249 $ENV{$k} = $UNCLEAN_ENV{$k};
6251 undef(%UNCLEAN_ENV);
6255 =head2 progress_callback
6257 Never called directly, but useful for passing to &http_download to print
6258 out progress of an HTTP request.
6261 sub progress_callback
6263 if (defined(&theme_progress_callback)) {
6264 # Call the theme override
6265 return &theme_progress_callback(@_);
6269 print $progress_callback_prefix;
6271 $progress_size = $_[1];
6272 $progress_step = int($_[1] / 10);
6273 print &text('progress_size', $progress_callback_url,
6274 $progress_size),"<br>\n";
6277 print &text('progress_nosize', $progress_callback_url),"<br>\n";
6279 $last_progress_time = $last_progress_size = undef;
6281 elsif ($_[0] == 3) {
6283 my $sp = $progress_callback_prefix.(" " x 5);
6284 if ($progress_size) {
6285 # And we have a size to compare against
6286 my $st = int(($_[1] * 10) / $progress_size);
6287 my $time_now = time();
6288 if ($st != $progress_step ||
6289 $time_now - $last_progress_time > 60) {
6290 # Show progress every 10% or 60 seconds
6291 print $sp,&text('progress_data', $_[1], int($_[1]*100/$progress_size)),"<br>\n";
6292 $last_progress_time = $time_now;
6294 $progress_step = $st;
6297 # No total size .. so only show in 100k jumps
6298 if ($_[1] > $last_progress_size+100*1024) {
6299 print $sp,&text('progress_data2', $_[1]),"<br>\n";
6300 $last_progress_size = $_[1];
6304 elsif ($_[0] == 4) {
6305 # All done downloading
6306 print $progress_callback_prefix,&text('progress_done'),"<br>\n";
6308 elsif ($_[0] == 5) {
6309 # Got new location after redirect
6310 $progress_callback_url = $_[1];
6312 elsif ($_[0] == 6) {
6314 $progress_callback_url = $_[1];
6315 print &text('progress_incache', $progress_callback_url),"<br>\n";
6319 =head2 switch_to_remote_user
6321 Changes the user and group of the current process to that of the unix user
6322 with the same name as the current webmin login, or fails if there is none.
6323 This should be called by Usermin module scripts that only need to run with
6324 limited permissions.
6327 sub switch_to_remote_user
6329 @remote_user_info = $remote_user ? getpwnam($remote_user) :
6331 @remote_user_info || &error(&text('switch_remote_euser', $remote_user));
6332 &create_missing_homedir(\@remote_user_info);
6334 &switch_to_unix_user(\@remote_user_info);
6335 $ENV{'USER'} = $ENV{'LOGNAME'} = $remote_user;
6336 $ENV{'HOME'} = $remote_user_info[7];
6338 # Export global variables to caller
6339 if ($main::export_to_caller) {
6340 my ($callpkg) = caller();
6341 eval "\@${callpkg}::remote_user_info = \@remote_user_info";
6345 =head2 switch_to_unix_user(&user-details)
6347 Switches the current process to the UID and group ID from the given list
6348 of user details, which must be in the format returned by getpwnam.
6351 sub switch_to_unix_user
6354 if (!defined($uinfo->[0])) {
6355 # No username given, so just use given GID
6356 ($(, $)) = ( $uinfo->[3], "$uinfo->[3] $uinfo->[3]" );
6359 # Use all groups from user
6360 ($(, $)) = ( $uinfo->[3],
6361 "$uinfo->[3] ".join(" ", $uinfo->[3],
6362 &other_groups($uinfo->[0])) );
6365 POSIX::setuid($uinfo->[2]);
6367 if ($< != $uinfo->[2] || $> != $uinfo->[2]) {
6368 ($>, $<) = ( $uinfo->[2], $uinfo->[2] );
6372 =head2 eval_as_unix_user(username, &code)
6374 Runs some code fragment with the effective UID and GID switch to that
6375 of the given Unix user, so that file IO takes place with his permissions.
6379 sub eval_as_unix_user
6381 my ($user, $code) = @_;
6382 my @uinfo = getpwnam($user);
6383 if (!scalar(@uinfo)) {
6384 &error("eval_as_unix_user called with invalid user $user");
6386 $) = $uinfo[3]." ".join(" ", $uinfo[3], &other_groups($user));
6390 local $main::error_must_die = 1;
6397 $err =~ s/\s+at\s+(\/\S+)\s+line\s+(\d+)\.?//;
6400 return wantarray ? @rv : $rv[0];
6403 =head2 create_user_config_dirs
6405 Creates per-user config directories and sets $user_config_directory and
6406 $user_module_config_directory to them. Also reads per-user module configs
6407 into %userconfig. This should be called by Usermin module scripts that need
6408 to store per-user preferences or other settings.
6411 sub create_user_config_dirs
6413 return if (!$gconfig{'userconfig'});
6414 my @uinfo = @remote_user_info ? @remote_user_info : getpwnam($remote_user);
6415 return if (!@uinfo || !$uinfo[7]);
6416 &create_missing_homedir(\@uinfo);
6417 $user_config_directory = "$uinfo[7]/$gconfig{'userconfig'}";
6418 if (!-d $user_config_directory) {
6419 mkdir($user_config_directory, 0700) ||
6420 &error("Failed to create $user_config_directory : $!");
6421 if ($< == 0 && $uinfo[2]) {
6422 chown($uinfo[2], $uinfo[3], $user_config_directory);
6425 if (&get_module_name()) {
6426 $user_module_config_directory = $user_config_directory."/".
6428 if (!-d $user_module_config_directory) {
6429 mkdir($user_module_config_directory, 0700) ||
6430 &error("Failed to create $user_module_config_directory : $!");
6431 if ($< == 0 && $uinfo[2]) {
6432 chown($uinfo[2], $uinfo[3], $user_config_directory);
6436 &read_file_cached("$module_root_directory/defaultuconfig",
6438 &read_file_cached("$module_config_directory/uconfig", \%userconfig);
6439 &read_file_cached("$user_module_config_directory/config",
6443 # Export global variables to caller
6444 if ($main::export_to_caller) {
6445 my ($callpkg) = caller();
6446 foreach my $v ('$user_config_directory',
6447 '$user_module_config_directory', '%userconfig') {
6448 my ($vt, $vn) = split('', $v, 2);
6449 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
6454 =head2 create_missing_homedir(&uinfo)
6456 If auto homedir creation is enabled, create one for this user if needed.
6457 For internal use only.
6460 sub create_missing_homedir
6463 if (!-e $uinfo->[7] && $gconfig{'create_homedir'}) {
6464 # Use has no home dir .. make one
6465 system("mkdir -p ".quotemeta($uinfo->[7]));
6466 chown($uinfo->[2], $uinfo->[3], $uinfo->[7]);
6467 if ($gconfig{'create_homedir_perms'} ne '') {
6468 chmod(oct($gconfig{'create_homedir_perms'}), $uinfo->[7]);
6473 =head2 filter_javascript(text)
6475 Disables all javascript <script>, onClick= and so on tags in the given HTML,
6476 and returns the new HTML. Useful for displaying HTML from an un-trusted source.
6479 sub filter_javascript
6482 $rv =~ s/<\s*script[^>]*>([\000-\377]*?)<\s*\/script\s*>//gi;
6483 $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;
6484 $rv =~ s/(javascript:)/x$1/gi;
6485 $rv =~ s/(vbscript:)/x$1/gi;
6489 =head2 resolve_links(path)
6491 Given a path that may contain symbolic links, returns the real path.
6497 $path =~ s/\/+/\//g;
6498 $path =~ s/\/$// if ($path ne "/");
6499 my @p = split(/\/+/, $path);
6501 for(my $i=0; $i<@p; $i++) {
6502 my $sofar = "/".join("/", @p[0..$i]);
6503 my $lnk = readlink($sofar);
6504 if ($lnk eq $sofar) {
6505 # Link to itself! Cannot do anything more really ..
6508 elsif ($lnk =~ /^\//) {
6509 # Link is absolute..
6510 return &resolve_links($lnk."/".join("/", @p[$i+1 .. $#p]));
6514 return &resolve_links("/".join("/", @p[0..$i-1])."/".$lnk."/".join("/", @p[$i+1 .. $#p]));
6520 =head2 simplify_path(path, bogus)
6522 Given a path, maybe containing elements ".." and "." , convert it to a
6523 clean, absolute form. Returns undef if this is not possible.
6531 my @bits = split(/\/+/, $dir);
6534 foreach my $b (@bits) {
6538 elsif ($b eq "..") {
6540 if (scalar(@fixedbits) == 0) {
6541 # Cannot! Already at root!
6548 push(@fixedbits, $b);
6551 return "/".join('/', @fixedbits);
6554 =head2 same_file(file1, file2)
6556 Returns 1 if two files are actually the same
6561 return 1 if ($_[0] eq $_[1]);
6562 return 0 if ($_[0] !~ /^\// || $_[1] !~ /^\//);
6563 my @stat1 = $stat_cache{$_[0]} ? @{$stat_cache{$_[0]}}
6564 : (@{$stat_cache{$_[0]}} = stat($_[0]));
6565 my @stat2 = $stat_cache{$_[1]} ? @{$stat_cache{$_[1]}}
6566 : (@{$stat_cache{$_[1]}} = stat($_[1]));
6567 return 0 if (!@stat1 || !@stat2);
6568 return $stat1[0] == $stat2[0] && $stat1[1] == $stat2[1];
6571 =head2 flush_webmin_caches
6573 Clears all in-memory and on-disk caches used by Webmin.
6576 sub flush_webmin_caches
6578 undef(%main::read_file_cache);
6579 undef(%main::acl_hash_cache);
6580 undef(%main::acl_array_cache);
6581 undef(%main::has_command_cache);
6582 undef(@main::list_languages_cache);
6583 undef($main::got_list_usermods_cache);
6584 undef(@main::list_usermods_cache);
6585 undef(%main::foreign_installed_cache);
6586 unlink("$config_directory/module.infos.cache");
6587 &get_all_module_infos();
6590 =head2 list_usermods
6592 Returns a list of additional module restrictions. For internal use in
6598 if (!$main::got_list_usermods_cache) {
6599 @main::list_usermods_cache = ( );
6601 open(USERMODS, "$config_directory/usermin.mods");
6603 if (/^([^:]+):(\+|-|):(.*)/) {
6604 push(@main::list_usermods_cache,
6605 [ $1, $2, [ split(/\s+/, $3) ] ]);
6609 $main::got_list_usermods_cache = 1;
6611 return @main::list_usermods_cache;
6614 =head2 available_usermods(&allmods, &usermods)
6616 Returns a list of modules that are available to the given user, based
6617 on usermod additional/subtractions. For internal use by Usermin only.
6620 sub available_usermods
6622 return @{$_[0]} if (!@{$_[1]});
6624 my %mods = map { $_->{'dir'}, 1 } @{$_[0]};
6625 my @uinfo = @remote_user_info;
6626 @uinfo = getpwnam($remote_user) if (!@uinfo);
6627 foreach my $u (@{$_[1]}) {
6629 if ($u->[0] eq "*" || $u->[0] eq $remote_user) {
6632 elsif ($u->[0] =~ /^\@(.*)$/) {
6633 # Check for group membership
6634 my @ginfo = getgrnam($1);
6635 $applies++ if (@ginfo && ($ginfo[2] == $uinfo[3] ||
6636 &indexof($remote_user, split(/\s+/, $ginfo[3])) >= 0));
6638 elsif ($u->[0] =~ /^\//) {
6639 # Check users and groups in file
6641 open(USERFILE, $u->[0]);
6644 if ($_ eq $remote_user) {
6647 elsif (/^\@(.*)$/) {
6648 my @ginfo = getgrnam($1);
6650 if (@ginfo && ($ginfo[2] == $uinfo[3] ||
6651 &indexof($remote_user,
6652 split(/\s+/, $ginfo[3])) >= 0));
6659 if ($u->[1] eq "+") {
6660 map { $mods{$_}++ } @{$u->[2]};
6662 elsif ($u->[1] eq "-") {
6663 map { delete($mods{$_}) } @{$u->[2]};
6667 map { $mods{$_}++ } @{$u->[2]};
6671 return grep { $mods{$_->{'dir'}} } @{$_[0]};
6674 =head2 get_available_module_infos(nocache)
6676 Returns a list of modules available to the current user, based on
6677 operating system support, access control and usermod restrictions. Useful
6678 in themes that need to display a list of modules the user can use.
6679 Each element of the returned array is a hash reference in the same format as
6680 returned by get_module_info.
6683 sub get_available_module_infos
6686 &read_acl(\%acl, \%uacl);
6687 my $risk = $gconfig{'risk_'.$base_remote_user};
6689 foreach my $minfo (&get_all_module_infos($_[0])) {
6690 next if (!&check_os_support($minfo));
6692 # Check module risk level
6693 next if ($risk ne 'high' && $minfo->{'risk'} &&
6694 $minfo->{'risk'} !~ /$risk/);
6698 next if (!$acl{$base_remote_user,$minfo->{'dir'}} &&
6699 !$acl{$base_remote_user,"*"});
6701 next if (&is_readonly_mode() && !$minfo->{'readonly'});
6705 # Check usermod restrictions
6706 my @usermods = &list_usermods();
6707 @rv = sort { $a->{'desc'} cmp $b->{'desc'} }
6708 &available_usermods(\@rv, \@usermods);
6710 # Check RBAC restrictions
6712 foreach my $m (@rv) {
6713 if (&supports_rbac($m->{'dir'}) &&
6714 &use_rbac_module_acl(undef, $m->{'dir'})) {
6715 local $rbacs = &get_rbac_module_acl($remote_user,
6723 # Module or system doesn't support RBAC
6724 push(@rbacrv, $m) if (!$gconfig{'rbacdeny_'.$base_remote_user});
6730 if (defined(&theme_foreign_available)) {
6731 foreach my $m (@rbacrv) {
6732 if (&theme_foreign_available($m->{'dir'})) {
6741 # Check licence module vetos
6743 if ($main::licence_module) {
6744 foreach my $m (@themerv) {
6745 if (&foreign_call($main::licence_module,
6746 "check_module_licence", $m->{'dir'})) {
6758 =head2 get_visible_module_infos(nocache)
6760 Like get_available_module_infos, but excludes hidden modules from the list.
6761 Each element of the returned array is a hash reference in the same format as
6762 returned by get_module_info.
6765 sub get_visible_module_infos
6768 my $pn = &get_product_name();
6769 return grep { !$_->{'hidden'} &&
6770 !$_->{$pn.'_hidden'} } &get_available_module_infos($nocache);
6773 =head2 get_visible_modules_categories(nocache)
6775 Returns a list of Webmin module categories, each of which is a hash ref
6776 with 'code', 'desc' and 'modules' keys. The modules value is an array ref
6777 of modules in the category, in the format returned by get_module_info.
6778 Un-used modules are automatically assigned to the 'unused' category, and
6779 those with no category are put into 'others'.
6782 sub get_visible_modules_categories
6785 my @mods = &get_visible_module_infos($nocache);
6787 if (&get_product_name() eq 'webmin') {
6788 @unmods = grep { $_->{'installed'} eq '0' } @mods;
6789 @mods = grep { $_->{'installed'} ne '0' } @mods;
6791 my %cats = &list_categories(\@mods);
6793 foreach my $c (keys %cats) {
6794 my $cat = { 'code' => $c || 'other',
6795 'desc' => $cats{$c} };
6796 $cat->{'modules'} = [ grep { $_->{'category'} eq $c } @mods ];
6799 @rv = sort { ($b->{'code'} eq "others" ? "" : $b->{'code'}) cmp
6800 ($a->{'code'} eq "others" ? "" : $a->{'code'}) } @rv;
6802 # Add un-installed modules in magic category
6803 my $cat = { 'code' => 'unused',
6804 'desc' => $text{'main_unused'},
6806 'modules' => \@unmods };
6812 =head2 is_under_directory(directory, file)
6814 Returns 1 if the given file is under the specified directory, 0 if not.
6815 Symlinks are taken into account in the file to find it's 'real' location.
6818 sub is_under_directory
6820 my ($dir, $file) = @_;
6821 return 1 if ($dir eq "/");
6822 return 0 if ($file =~ /\.\./);
6823 my $ld = &resolve_links($dir);
6825 return &is_under_directory($ld, $file);
6827 my $lp = &resolve_links($file);
6829 return &is_under_directory($dir, $lp);
6831 return 0 if (length($file) < length($dir));
6832 return 1 if ($dir eq $file);
6834 return substr($file, 0, length($dir)) eq $dir;
6837 =head2 parse_http_url(url, [basehost, baseport, basepage, basessl])
6839 Given an absolute URL, returns the host, port, page and ssl flag components.
6840 Relative URLs can also be parsed, if the base information is provided.
6845 if ($_[0] =~ /^(http|https):\/\/([^:\/]+)(:(\d+))?(\/\S*)?$/) {
6847 my $ssl = $1 eq 'https';
6848 return ($2, $3 ? $4 : $ssl ? 443 : 80, $5 || "/", $ssl);
6854 elsif ($_[0] =~ /^\/\S*$/) {
6855 # A relative to the server URL
6856 return ($_[1], $_[2], $_[0], $_[4]);
6859 # A relative to the directory URL
6861 $page =~ s/[^\/]+$//;
6862 return ($_[1], $_[2], $page.$_[0], $_[4]);
6866 =head2 check_clicks_function
6868 Returns HTML for a JavaScript function called check_clicks that returns
6869 true when first called, but false subsequently. Useful on onClick for
6870 critical buttons. Deprecated, as this method of preventing duplicate actions
6874 sub check_clicks_function
6879 function check_clicks(form)
6886 for(i=0; i<form.length; i++)
6887 form.elements[i].disabled = true;
6896 =head2 load_entities_map
6898 Returns a hash ref containing mappings between HTML entities (like ouml) and
6899 ascii values (like 246). Mainly for internal use.
6902 sub load_entities_map
6904 if (!defined(%entities_map_cache)) {
6906 open(EMAP, "$root_directory/entities_map.txt");
6908 if (/^(\d+)\s+(\S+)/) {
6909 $entities_map_cache{$2} = $1;
6914 return \%entities_map_cache;
6917 =head2 entities_to_ascii(string)
6919 Given a string containing HTML entities like ö and 7, replace them
6920 with their ASCII equivalents.
6923 sub entities_to_ascii
6926 my $emap = &load_entities_map();
6927 $str =~ s/&([a-z]+);/chr($emap->{$1})/ge;
6928 $str =~ s/&#(\d+);/chr($1)/ge;
6932 =head2 get_product_name
6934 Returns either 'webmin' or 'usermin', depending on which program the current
6935 module is in. Useful for modules that can be installed into either.
6938 sub get_product_name
6940 return $gconfig{'product'} if (defined($gconfig{'product'}));
6941 return defined($gconfig{'userconfig'}) ? 'usermin' : 'webmin';
6946 Returns the character set for the current language, such as iso-8859-1.
6951 my $charset = defined($gconfig{'charset'}) ? $gconfig{'charset'} :
6952 $current_lang_info->{'charset'} ?
6953 $current_lang_info->{'charset'} : $default_charset;
6957 =head2 get_display_hostname
6959 Returns the system's hostname for UI display purposes. This may be different
6960 from the actual hostname if you administrator has configured it so in the
6961 Webmin Configuration module.
6964 sub get_display_hostname
6966 if ($gconfig{'hostnamemode'} == 0) {
6967 return &get_system_hostname();
6969 elsif ($gconfig{'hostnamemode'} == 3) {
6970 return $gconfig{'hostnamedisplay'};
6973 my $h = $ENV{'HTTP_HOST'};
6975 if ($gconfig{'hostnamemode'} == 2) {
6976 $h =~ s/^(www|ftp|mail)\.//i;
6982 =head2 save_module_config([&config], [modulename])
6984 Saves the configuration for some module. The config parameter is an optional
6985 hash reference of names and values to save, which defaults to the global
6986 %config hash. The modulename parameter is the module to update the config
6987 file, which defaults to the current module.
6990 sub save_module_config
6992 my $c = $_[0] || { &get_module_variable('%config') };
6993 my $m = defined($_[1]) ? $_[1] : &get_module_name();
6994 &write_file("$config_directory/$m/config", $c);
6997 =head2 save_user_module_config([&config], [modulename])
6999 Saves the user's Usermin preferences for some module. The config parameter is
7000 an optional hash reference of names and values to save, which defaults to the
7001 global %userconfig hash. The modulename parameter is the module to update the
7002 config file, which defaults to the current module.
7005 sub save_user_module_config
7007 my $c = $_[0] || { &get_module_variable('%userconfig') };
7008 my $m = $_[1] || &get_module_name();
7009 my $ucd = $user_config_directory;
7011 my @uinfo = @remote_user_info ? @remote_user_info
7012 : getpwnam($remote_user);
7013 return if (!@uinfo || !$uinfo[7]);
7014 $ucd = "$uinfo[7]/$gconfig{'userconfig'}";
7016 &write_file("$ucd/$m/config", $c);
7019 =head2 nice_size(bytes, [min])
7021 Converts a number of bytes into a number followed by a suffix like GB, MB
7022 or kB. Rounding is to two decimal digits. The optional min parameter sets the
7023 smallest units to use - so you could pass 1024*1024 to never show bytes or kB.
7028 my ($units, $uname);
7029 if (abs($_[0]) > 1024*1024*1024*1024 || $_[1] >= 1024*1024*1024*1024) {
7030 $units = 1024*1024*1024*1024;
7033 elsif (abs($_[0]) > 1024*1024*1024 || $_[1] >= 1024*1024*1024) {
7034 $units = 1024*1024*1024;
7037 elsif (abs($_[0]) > 1024*1024 || $_[1] >= 1024*1024) {
7041 elsif (abs($_[0]) > 1024 || $_[1] >= 1024) {
7049 my $sz = sprintf("%.2f", ($_[0]*1.0 / $units));
7051 return $sz." ".$uname;
7054 =head2 get_perl_path
7056 Returns the path to Perl currently in use, such as /usr/bin/perl.
7061 if (open(PERL, "$config_directory/perl-path")) {
7067 return $^X if (-x $^X);
7068 return &has_command("perl");
7071 =head2 get_goto_module([&mods])
7073 Returns the details of a module that the current user should be re-directed
7074 to after logging in, or undef if none. Useful for themes.
7079 my @mods = $_[0] ? @{$_[0]} : &get_visible_module_infos();
7080 if ($gconfig{'gotomodule'}) {
7081 my ($goto) = grep { $_->{'dir'} eq $gconfig{'gotomodule'} } @mods;
7082 return $goto if ($goto);
7084 if (@mods == 1 && $gconfig{'gotoone'}) {
7090 =head2 select_all_link(field, form, [text])
7092 Returns HTML for a 'Select all' link that uses Javascript to select
7093 multiple checkboxes with the same name. The parameters are :
7095 =item field - Name of the checkbox inputs.
7097 =item form - Index of the form on the page.
7099 =item text - Message for the link, defaulting to 'Select all'.
7104 return &theme_select_all_link(@_) if (defined(&theme_select_all_link));
7105 my ($field, $form, $text) = @_;
7107 $text ||= $text{'ui_selall'};
7108 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>";
7111 =head2 select_invert_link(field, form, text)
7113 Returns HTML for an 'Invert selection' link that uses Javascript to invert the
7114 selection on multiple checkboxes with the same name. The parameters are :
7116 =item field - Name of the checkbox inputs.
7118 =item form - Index of the form on the page.
7120 =item text - Message for the link, defaulting to 'Invert selection'.
7123 sub select_invert_link
7125 return &theme_select_invert_link(@_) if (defined(&theme_select_invert_link));
7126 my ($field, $form, $text) = @_;
7128 $text ||= $text{'ui_selinv'};
7129 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>";
7132 =head2 select_rows_link(field, form, text, &rows)
7134 Returns HTML for a link that uses Javascript to select rows with particular
7135 values for their checkboxes. The parameters are :
7137 =item field - Name of the checkbox inputs.
7139 =item form - Index of the form on the page.
7141 =item text - Message for the link, de
7143 =item rows - Reference to an array of 1 or 0 values, indicating which rows to check.
7146 sub select_rows_link
7148 return &theme_select_rows_link(@_) if (defined(&theme_select_rows_link));
7149 my ($field, $form, $text, $rows) = @_;
7151 my $js = "var sel = { ".join(",", map { "\""."e_escape($_)."\":1" } @$rows)." }; ";
7152 $js .= "for(var i=0; i<document.forms[$form].${field}.length; i++) { var r = document.forms[$form].${field}[i]; r.checked = sel[r.value]; } ";
7153 $js .= "return false;";
7154 return "<a href='#' onClick='$js'>$text</a>";
7157 =head2 check_pid_file(file)
7159 Given a pid file, returns the PID it contains if the process is running.
7164 open(PIDFILE, $_[0]) || return undef;
7165 my $pid = <PIDFILE>;
7167 $pid =~ /^\s*(\d+)/ || return undef;
7168 kill(0, $1) || return undef;
7174 Return the local os-specific library name to this module. For internal use only.
7179 my $mn = &get_module_name();
7180 my $md = &module_root_directory($mn);
7181 if (-r "$md/$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl") {
7182 return "$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl";
7184 elsif (-r "$md/$mn-$gconfig{'os_type'}-lib.pl") {
7185 return "$mn-$gconfig{'os_type'}-lib.pl";
7187 elsif (-r "$md/$mn-generic-lib.pl") {
7188 return "$mn-generic-lib.pl";
7195 =head2 module_root_directory(module)
7197 Given a module name, returns its root directory. On a typical Webmin install,
7198 all modules are under the same directory - but it is theoretically possible to
7202 sub module_root_directory
7204 my $d = ref($_[0]) ? $_[0]->{'dir'} : $_[0];
7205 if (@root_directories > 1) {
7206 foreach my $r (@root_directories) {
7212 return "$root_directories[0]/$d";
7215 =head2 list_mime_types
7217 Returns a list of all known MIME types and their extensions, as a list of hash
7218 references with keys :
7220 =item type - The MIME type, like text/plain.
7222 =item exts - A list of extensions, like .doc and .avi.
7224 =item desc - A human-readable description for the MIME type.
7229 if (!@list_mime_types_cache) {
7231 open(MIME, "$root_directory/mime.types");
7235 if (s/#\s*(.*)$//g) {
7238 my ($type, @exts) = split(/\s+/);
7240 push(@list_mime_types_cache, { 'type' => $type,
7247 return @list_mime_types_cache;
7250 =head2 guess_mime_type(filename, [default])
7252 Given a file name like xxx.gif or foo.html, returns a guessed MIME type.
7253 The optional default parameter sets a default type of use if none is found,
7254 which defaults to application/octet-stream.
7259 if ($_[0] =~ /\.([A-Za-z0-9\-]+)$/) {
7261 foreach my $t (&list_mime_types()) {
7262 foreach my $e (@{$t->{'exts'}}) {
7263 return $t->{'type'} if (lc($e) eq lc($ext));
7267 return @_ > 1 ? $_[1] : "application/octet-stream";
7270 =head2 open_tempfile([handle], file, [no-error], [no-tempfile], [safe?])
7272 Opens a file handle for writing to a temporary file, which will only be
7273 renamed over the real file when the handle is closed. This allows critical
7274 files like /etc/shadow to be updated safely, even if writing fails part way
7275 through due to lack of disk space. The parameters are :
7277 =item handle - File handle to open, as you would use in Perl's open function.
7279 =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.
7281 =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.
7283 =item no-tempfile - If set to 1, writing will be direct to the file instead of using a temporary file.
7285 =item safe - Indicates to users in read-only mode that this write is safe and non-destructive.
7291 # Just getting a temp file
7292 if (!defined($main::open_tempfiles{$_[0]})) {
7293 $_[0] =~ /^(.*)\/(.*)$/ || return $_[0];
7294 my $dir = $1 || "/";
7295 my $tmp = "$dir/$2.webmintmp.$$";
7296 $main::open_tempfiles{$_[0]} = $tmp;
7297 push(@main::temporary_files, $tmp);
7299 return $main::open_tempfiles{$_[0]};
7303 my ($fh, $file, $noerror, $notemp, $safe) = @_;
7304 $fh = &callers_package($fh);
7306 my %gaccess = &get_module_acl(undef, "");
7307 my $db = $gconfig{'debug_what_write'};
7308 if ($file =~ /\r|\n|\0/) {
7309 if ($noerror) { return 0; }
7310 else { &error("Filename contains invalid characters"); }
7312 if (&is_readonly_mode() && $file =~ />/ && !$safe) {
7313 # Read-only mode .. veto all writes
7314 print STDERR "vetoing write to $file\n";
7315 return open($fh, ">$null_file");
7317 elsif ($file =~ /^(>|>>|)nul$/i) {
7318 # Write to Windows null device
7319 &webmin_debug_log($1 eq ">" ? "WRITE" :
7320 $1 eq ">>" ? "APPEND" : "READ", "nul") if ($db);
7322 elsif ($file =~ /^(>|>>)(\/dev\/.*)/ || lc($file) eq "nul") {
7323 # Writes to /dev/null or TTYs don't need to be handled
7324 &webmin_debug_log($1 eq ">" ? "WRITE" : "APPEND", $2) if ($db);
7325 return open($fh, $file);
7327 elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && !$notemp) {
7328 &webmin_debug_log("WRITE", $1) if ($db);
7329 # Over-writing a file, via a temp file
7331 $file = &translate_filename($file);
7333 # Open the link target instead
7334 $file = &resolve_links($file);
7337 # Cannot open a directory!
7338 if ($noerror) { return 0; }
7339 else { &error("Cannot write to directory $file"); }
7341 my $tmp = &open_tempfile($file);
7342 my $ex = open($fh, ">$tmp");
7343 if (!$ex && $! =~ /permission/i) {
7344 # Could not open temp file .. try opening actual file
7346 $ex = open($fh, ">$file");
7347 delete($main::open_tempfiles{$file});
7350 $main::open_temphandles{$fh} = $file;
7353 if (!$ex && !$noerror) {
7354 &error(&text("efileopen", $file, $!));
7358 elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && $notemp) {
7359 # Just writing direct to a file
7360 &webmin_debug_log("WRITE", $1) if ($db);
7362 $file = &translate_filename($file);
7363 my @old_attributes = &get_clear_file_attributes($file);
7364 my $ex = open($fh, ">$file");
7365 &reset_file_attributes($file, \@old_attributes);
7366 $main::open_temphandles{$fh} = $file;
7367 if (!$ex && !$noerror) {
7368 &error(&text("efileopen", $file, $!));
7373 elsif ($file =~ /^>>\s*(([a-zA-Z]:)?\/.*)$/) {
7374 # Appending to a file .. nothing special to do
7375 &webmin_debug_log("APPEND", $1) if ($db);
7377 $file = &translate_filename($file);
7378 my @old_attributes = &get_clear_file_attributes($file);
7379 my $ex = open($fh, ">>$file");
7380 &reset_file_attributes($file, \@old_attributes);
7381 $main::open_temphandles{$fh} = $file;
7382 if (!$ex && !$noerror) {
7383 &error(&text("efileopen", $file, $!));
7388 elsif ($file =~ /^([a-zA-Z]:)?\//) {
7389 # Read mode .. nothing to do here
7390 &webmin_debug_log("READ", $file) if ($db);
7391 $file = &translate_filename($file);
7392 return open($fh, $file);
7394 elsif ($file eq ">" || $file eq ">>") {
7395 my ($package, $filename, $line) = caller;
7396 if ($noerror) { return 0; }
7397 else { &error("Missing file to open at ${package}::${filename} line $line"); }
7400 my ($package, $filename, $line) = caller;
7401 &error("Unsupported file or mode $file at ${package}::${filename} line $line");
7406 =head2 close_tempfile(file|handle)
7408 Copies a temp file to the actual file, assuming that all writes were
7409 successful. The handle must have been one passed to open_tempfile.
7415 my $fh = &callers_package($_[0]);
7417 if (defined($file = $main::open_temphandles{$fh})) {
7419 close($fh) || &error(&text("efileclose", $file, $!));
7420 delete($main::open_temphandles{$fh});
7421 return &close_tempfile($file);
7423 elsif (defined($main::open_tempfiles{$_[0]})) {
7425 &webmin_debug_log("CLOSE", $_[0]) if ($gconfig{'debug_what_write'});
7426 my @st = stat($_[0]);
7427 if (&is_selinux_enabled() && &has_command("chcon")) {
7428 # Set original security context
7429 system("chcon --reference=".quotemeta($_[0]).
7430 " ".quotemeta($main::open_tempfiles{$_[0]}).
7431 " >/dev/null 2>&1");
7433 my @old_attributes = &get_clear_file_attributes($_[0]);
7434 rename($main::open_tempfiles{$_[0]}, $_[0]) || &error("Failed to replace $_[0] with $main::open_tempfiles{$_[0]} : $!");
7436 # Set original permissions and ownership
7437 chmod($st[2], $_[0]);
7438 chown($st[4], $st[5], $_[0]);
7440 &reset_file_attributes($_[0], \@old_attributes);
7441 delete($main::open_tempfiles{$_[0]});
7442 @main::temporary_files = grep { $_ ne $main::open_tempfiles{$_[0]} } @main::temporary_files;
7443 if ($main::open_templocks{$_[0]}) {
7444 &unlock_file($_[0]);
7445 delete($main::open_templocks{$_[0]});
7450 # Must be closing a handle not associated with a file
7456 =head2 print_tempfile(handle, text, ...)
7458 Like the normal print function, but calls &error on failure. Useful when
7459 combined with open_tempfile, to ensure that a criticial file is never
7460 only partially written.
7465 my ($fh, @args) = @_;
7466 $fh = &callers_package($fh);
7467 (print $fh @args) || &error(&text("efilewrite",
7468 $main::open_temphandles{$fh} || $fh, $!));
7471 =head2 is_selinux_enabled
7473 Returns 1 if SElinux is supported on this system and enabled, 0 if not.
7476 sub is_selinux_enabled
7478 if (!defined($main::selinux_enabled_cache)) {
7480 if ($gconfig{'os_type'} !~ /-linux$/) {
7481 # Not on linux, so no way
7482 $main::selinux_enabled_cache = 0;
7484 elsif (&read_env_file("/etc/selinux/config", \%seconfig)) {
7485 # Use global config file
7486 $main::selinux_enabled_cache =
7487 $seconfig{'SELINUX'} eq 'disabled' ||
7488 !$seconfig{'SELINUX'} ? 0 : 1;
7491 # Use selinuxenabled command
7492 #$selinux_enabled_cache =
7493 # system("selinuxenabled >/dev/null 2>&1") ? 0 : 1;
7494 $main::selinux_enabled_cache = 0;
7497 return $main::selinux_enabled_cache;
7500 =head2 get_clear_file_attributes(file)
7502 Finds file attributes that may prevent writing, clears them and returns them
7503 as a list. May call error. Mainly for internal use by open_tempfile and
7507 sub get_clear_file_attributes
7511 if ($gconfig{'chattr'}) {
7512 # Get original immutable bit
7513 my $out = &backquote_command(
7514 "lsattr ".quotemeta($file)." 2>/dev/null");
7516 $out =~ s/\s\S+\n//;
7517 @old_attributes = grep { $_ ne '-' } split(//, $out);
7519 if (&indexof("i", @old_attributes) >= 0) {
7520 my $err = &backquote_logged(
7521 "chattr -i ".quotemeta($file)." 2>&1");
7523 &error("Failed to remove immutable bit on ".
7528 return @old_attributes;
7531 =head2 reset_file_attributes(file, &attributes)
7533 Put back cleared attributes on some file. May call error. Mainly for internal
7534 use by close_tempfile.
7537 sub reset_file_attributes
7539 my ($file, $old_attributes) = @_;
7540 if (&indexof("i", @$old_attributes) >= 0) {
7541 my $err = &backquote_logged(
7542 "chattr +i ".quotemeta($file)." 2>&1");
7544 &error("Failed to restore immutable bit on ".
7550 =head2 cleanup_tempnames
7552 Remove all temporary files generated using transname. Typically only called
7553 internally when a Webmin script exits.
7556 sub cleanup_tempnames
7558 foreach my $t (@main::temporary_files) {
7561 @main::temporary_files = ( );
7564 =head2 open_lock_tempfile([handle], file, [no-error])
7566 Returns a temporary file for writing to some actual file, and also locks it.
7567 Effectively the same as calling lock_file and open_tempfile on the same file,
7568 but calls the unlock for you automatically when it is closed.
7571 sub open_lock_tempfile
7573 my ($fh, $file, $noerror, $notemp, $safe) = @_;
7574 $fh = &callers_package($fh);
7575 my $lockfile = $file;
7576 $lockfile =~ s/^[^\/]*//;
7577 if ($lockfile =~ /^\//) {
7578 $main::open_templocks{$lockfile} = &lock_file($lockfile);
7580 return &open_tempfile($fh, $file, $noerror, $notemp, $safe);
7585 $main::end_exit_status ||= $?;
7586 if ($$ == $main::initial_process_id) {
7587 # Exiting from initial process
7588 &cleanup_tempnames();
7589 if ($gconfig{'debug_what_start'} && $main::debug_log_start_time &&
7590 $main::debug_log_start_module eq &get_module_name()) {
7591 my $len = time() - $main::debug_log_start_time;
7592 &webmin_debug_log("STOP", "runtime=$len");
7593 $main::debug_log_start_time = 0;
7595 if (!$ENV{'SCRIPT_NAME'} &&
7596 $main::initial_module_name eq &get_module_name()) {
7597 # In a command-line script - call the real exit, so that the
7598 # exit status gets properly propogated. In some cases this
7599 # was not happening.
7600 exit($main::end_exit_status);
7605 =head2 month_to_number(month)
7607 Converts a month name like feb to a number like 1.
7612 return $month_to_number_map{lc(substr($_[0], 0, 3))};
7615 =head2 number_to_month(number)
7617 Converts a number like 1 to a month name like Feb.
7622 return ucfirst($number_to_month_map{$_[0]});
7625 =head2 get_rbac_module_acl(user, module)
7627 Returns a hash reference of RBAC overrides ACLs for some user and module.
7628 May return undef if none exist (indicating access denied), or the string *
7629 if full access is granted.
7632 sub get_rbac_module_acl
7634 my ($user, $mod) = @_;
7635 eval "use Authen::SolarisRBAC";
7636 return undef if ($@);
7639 if (Authen::SolarisRBAC::chkauth("webmin.$mod.admin", $user)) {
7640 # Automagic webmin.modulename.admin authorization exists .. allow access
7642 if (!Authen::SolarisRBAC::chkauth("webmin.$mod.config", $user)) {
7643 %rv = ( 'noconfig' => 1 );
7650 open(RBAC, &module_root_directory($mod)."/rbac-mapping");
7654 my ($auths, $acls) = split(/\s+/, $_);
7655 my @auths = split(/,/, $auths);
7657 my ($merge) = ($acls =~ s/^\+//);
7659 if ($auths eq "*") {
7660 # These ACLs apply to all RBAC users.
7661 # Only if there is some that match a specific authorization
7662 # later will they be used though.
7665 # Check each of the RBAC authorizations
7666 foreach my $a (@auths) {
7667 if (!Authen::SolarisRBAC::chkauth($a, $user)) {
7672 $foundany++ if ($gotall);
7675 # Found an RBAC authorization - return the ACLs
7676 return "*" if ($acls eq "*");
7677 my %acl = map { split(/=/, $_, 2) } split(/,/, $acls);
7679 # Just add to current set
7680 foreach my $a (keys %acl) {
7691 return !$foundany ? undef : %rv ? \%rv : undef;
7694 =head2 supports_rbac([module])
7696 Returns 1 if RBAC client support is available, such as on Solaris.
7701 return 0 if ($gconfig{'os_type'} ne 'solaris');
7702 eval "use Authen::SolarisRBAC";
7705 #return 0 if (!-r &module_root_directory($_[0])."/rbac-mapping");
7710 =head2 use_rbac_module_acl(user, module)
7712 Returns 1 if some user should use RBAC to get permissions for a module
7715 sub use_rbac_module_acl
7717 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
7718 my $m = defined($_[1]) ? $_[1] : &get_module_name();
7719 return 1 if ($gconfig{'rbacdeny_'.$u}); # RBAC forced for user
7720 my %access = &get_module_acl($u, $m, 1);
7721 return $access{'rbac'} ? 1 : 0;
7724 =head2 execute_command(command, stdin, stdout, stderr, translate-files?, safe?)
7726 Runs some command, possibly feeding it input and capturing output to the
7727 give files or scalar references. The parameters are :
7729 =item command - Full command to run, possibly including shell meta-characters.
7731 =item stdin - File to read input from, or a scalar ref containing input, or undef if no input should be given.
7733 =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.
7735 =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.
7737 =item translate-files - Set to 1 to apply filename translation to any filenames. Usually has no effect.
7739 =item safe - Set to 1 if this command is safe and does not modify the state of the system.
7744 my ($cmd, $stdin, $stdout, $stderr, $trans, $safe) = @_;
7745 if (&is_readonly_mode() && !$safe) {
7746 print STDERR "Vetoing command $_[0]\n";
7750 $cmd = &translate_command($cmd);
7752 # Use ` operator where possible
7753 if (!$stdin && ref($stdout) && !$stderr) {
7754 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7755 $$stdout = `$cmd 2>$null_file`;
7758 elsif (!$stdin && ref($stdout) && $stdout eq $stderr) {
7759 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7760 $$stdout = `$cmd 2>&1`;
7763 elsif (!$stdin && !$stdout && !$stderr) {
7764 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7765 return system("$cmd >$null_file 2>$null_file <$null_file");
7767 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
7770 $| = 1; # needed on some systems to flush before forking
7771 pipe(EXECSTDINr, EXECSTDINw);
7772 pipe(EXECSTDOUTr, EXECSTDOUTw);
7773 pipe(EXECSTDERRr, EXECSTDERRw);
7775 if (!($pid = fork())) {
7779 open(STDIN, "<&EXECSTDINr");
7780 open(STDOUT, ">&EXECSTDOUTw");
7781 if (ref($stderr) && $stderr eq $stdout) {
7782 open(STDERR, ">&EXECSTDOUTw");
7785 open(STDERR, ">&EXECSTDERRw");
7792 my $fullcmd = "($cmd)";
7793 if ($stdin && !ref($stdin)) {
7794 $fullcmd .= " <$stdin";
7796 if ($stdout && !ref($stdout)) {
7797 $fullcmd .= " >$stdout";
7799 if ($stderr && !ref($stderr)) {
7800 if ($stderr eq $stdout) {
7801 $fullcmd .= " 2>&1";
7804 $fullcmd .= " 2>$stderr";
7807 if ($gconfig{'os_type'} eq 'windows') {
7811 exec("/bin/sh", "-c", $fullcmd);
7813 print "Exec failed : $!\n";
7820 # Feed input and capture output
7822 if ($stdin && ref($stdin)) {
7823 print EXECSTDINw $$stdin;
7826 if ($stdout && ref($stdout)) {
7828 while(<EXECSTDOUTr>) {
7833 if ($stderr && ref($stderr) && $stderr ne $stdout) {
7835 while(<EXECSTDERRr>) {
7846 =head2 open_readfile(handle, file)
7848 Opens some file for reading. Returns 1 on success, 0 on failure. Pretty much
7849 exactly the same as Perl's open function.
7854 my ($fh, $file) = @_;
7855 $fh = &callers_package($fh);
7856 my $realfile = &translate_filename($file);
7857 &webmin_debug_log('READ', $file) if ($gconfig{'debug_what_read'});
7858 return open($fh, "<".$realfile);
7861 =head2 open_execute_command(handle, command, output?, safe?)
7863 Runs some command, with the specified file handle set to either write to it if
7864 in-or-out is set to 0, or read to it if output is set to 1. The safe flag
7865 indicates if the command modifies the state of the system or not.
7868 sub open_execute_command
7870 my ($fh, $cmd, $mode, $safe) = @_;
7871 $fh = &callers_package($fh);
7872 my $realcmd = &translate_command($cmd);
7873 if (&is_readonly_mode() && !$safe) {
7874 # Don't actually run it
7875 print STDERR "vetoing command $cmd\n";
7878 return open($fh, ">$null_file");
7881 return open($fh, $null_file);
7885 &webmin_debug_log('CMD', "cmd=$realcmd mode=$mode")
7886 if ($gconfig{'debug_what_cmd'});
7888 return open($fh, "| $cmd");
7890 elsif ($mode == 1) {
7891 return open($fh, "$cmd 2>$null_file |");
7893 elsif ($mode == 2) {
7894 return open($fh, "$cmd 2>&1 |");
7898 =head2 translate_filename(filename)
7900 Applies all relevant registered translation functions to a filename. Mostly
7901 for internal use, and typically does nothing.
7904 sub translate_filename
7906 my ($realfile) = @_;
7907 my @funcs = grep { $_->[0] eq &get_module_name() ||
7908 !defined($_->[0]) } @main::filename_callbacks;
7909 foreach my $f (@funcs) {
7911 $realfile = &$func($realfile, @{$f->[2]});
7916 =head2 translate_command(filename)
7918 Applies all relevant registered translation functions to a command. Mostly
7919 for internal use, and typically does nothing.
7922 sub translate_command
7925 my @funcs = grep { $_->[0] eq &get_module_name() ||
7926 !defined($_->[0]) } @main::command_callbacks;
7927 foreach my $f (@funcs) {
7929 $realcmd = &$func($realcmd, @{$f->[2]});
7934 =head2 register_filename_callback(module|undef, &function, &args)
7936 Registers some function to be called when the specified module (or all
7937 modules) tries to open a file for reading and writing. The function must
7938 return the actual file to open. This allows you to override which files
7939 other code actually operates on, via the translate_filename function.
7942 sub register_filename_callback
7944 my ($mod, $func, $args) = @_;
7945 push(@main::filename_callbacks, [ $mod, $func, $args ]);
7948 =head2 register_command_callback(module|undef, &function, &args)
7950 Registers some function to be called when the specified module (or all
7951 modules) tries to execute a command. The function must return the actual
7952 command to run. This allows you to override which commands other other code
7953 actually runs, via the translate_command function.
7956 sub register_command_callback
7958 my ($mod, $func, $args) = @_;
7959 push(@main::command_callbacks, [ $mod, $func, $args ]);
7962 =head2 capture_function_output(&function, arg, ...)
7964 Captures output that some function prints to STDOUT, and returns it. Useful
7965 for functions outside your control that print data when you really want to
7966 manipulate it before output.
7969 sub capture_function_output
7971 my ($func, @args) = @_;
7972 socketpair(SOCKET2, SOCKET1, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
7973 my $old = select(SOCKET1);
7974 my @rv = &$func(@args);
7983 return wantarray ? ($out, \@rv) : $out;
7986 =head2 capture_function_output_tempfile(&function, arg, ...)
7988 Behaves the same as capture_function_output, but uses a temporary file
7989 to avoid buffer full problems.
7992 sub capture_function_output_tempfile
7994 my ($func, @args) = @_;
7995 my $temp = &transname();
7996 open(BUFFER, ">$temp");
7997 my $old = select(BUFFER);
7998 my @rv = &$func(@args);
8001 my $out = &read_file_contents($temp);
8002 &unlink_file($temp);
8003 return wantarray ? ($out, \@rv) : $out;
8006 =head2 modules_chooser_button(field, multiple, [form])
8008 Returns HTML for a button for selecting one or many Webmin modules.
8009 field - Name of the HTML field to place the module names into.
8010 multiple - Set to 1 if multiple modules can be selected.
8011 form - Index of the form on the page.
8014 sub modules_chooser_button
8016 return &theme_modules_chooser_button(@_)
8017 if (defined(&theme_modules_chooser_button));
8018 my $form = defined($_[2]) ? $_[2] : 0;
8019 my $w = $_[1] ? 700 : 500;
8021 if ($_[1] && $gconfig{'db_sizemodules'}) {
8022 ($w, $h) = split(/x/, $gconfig{'db_sizemodules'});
8024 elsif (!$_[1] && $gconfig{'db_sizemodule'}) {
8025 ($w, $h) = split(/x/, $gconfig{'db_sizemodule'});
8027 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";
8030 =head2 substitute_template(text, &hash)
8032 Given some text and a hash reference, for each ocurrance of $FOO or ${FOO} in
8033 the text replaces it with the value of the hash key foo. Also supports blocks
8034 like ${IF-FOO} ... ${ENDIF-FOO}, whose contents are only included if foo is
8035 non-zero, and ${IF-FOO} ... ${ELSE-FOO} ... ${ENDIF-FOO}.
8038 sub substitute_template
8040 # Add some extra fixed parameters to the hash
8041 my %hash = %{$_[1]};
8042 $hash{'hostname'} = &get_system_hostname();
8043 $hash{'webmin_config'} = $config_directory;
8044 $hash{'webmin_etc'} = $config_directory;
8045 $hash{'module_config'} = &get_module_variable('$module_config_directory');
8046 $hash{'webmin_var'} = $var_directory;
8048 # Add time-based parameters, for use in DNS
8049 $hash{'current_time'} = time();
8050 my @tm = localtime($hash{'current_time'});
8051 $hash{'current_year'} = $tm[5]+1900;
8052 $hash{'current_month'} = sprintf("%2.2d", $tm[4]+1);
8053 $hash{'current_day'} = sprintf("%2.2d", $tm[3]);
8054 $hash{'current_hour'} = sprintf("%2.2d", $tm[2]);
8055 $hash{'current_minute'} = sprintf("%2.2d", $tm[1]);
8056 $hash{'current_second'} = sprintf("%2.2d", $tm[0]);
8058 # Actually do the substition
8060 foreach my $s (keys %hash) {
8061 next if ($s eq ''); # Prevent just $ from being subbed
8064 $rv =~ s/\$\{\Q$us\E\}/$sv/g;
8065 $rv =~ s/\$\Q$us\E/$sv/g;
8067 # Replace ${IF}..${ELSE}..${ENDIF} block with first value,
8068 # and ${IF}..${ENDIF} with value
8069 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8070 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8072 # Replace $IF..$ELSE..$ENDIF block with first value,
8073 # and $IF..$ENDIF with value
8074 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8075 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8077 # Replace ${IFEQ}..${ENDIFEQ} block with first value if
8078 # matching, nothing if not
8079 $rv =~ s/\$\{IFEQ-\Q$us\E-\Q$sv\E\}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-\Q$sv\E\}(\n?)/$2/g;
8080 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8082 # Replace $IFEQ..$ENDIFEQ block with first value if
8083 # matching, nothing if not
8084 $rv =~ s/\$IFEQ-\Q$us\E-\Q$sv\E(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\Q$sv\E(\n?)/$2/g;
8085 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8088 # Replace ${IF}..${ELSE}..${ENDIF} block with second value,
8089 # and ${IF}..${ENDIF} with nothing
8090 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$4/g;
8091 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)//g;
8093 # Replace $IF..$ELSE..$ENDIF block with second value,
8094 # and $IF..$ENDIF with nothing
8095 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$4/g;
8096 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)//g;
8098 # Replace ${IFEQ}..${ENDIFEQ} block with nothing
8099 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8100 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8104 # Now assume any $IF blocks whose variables are not present in the hash
8105 # evaluate to false.
8106 # $IF...$ELSE x $ENDIF => x
8107 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ELSE\-\1\}(.*?)\$\{ENDIF\-\1\}/$2/gs;
8108 # $IF...x...$ENDIF => (nothing)
8109 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ENDIF\-\1\}//gs;
8110 # ${var} => (nothing)
8111 $rv =~ s/\$\{[A-Z]+\}//g;
8116 =head2 running_in_zone
8118 Returns 1 if the current Webmin instance is running in a Solaris zone. Used to
8119 disable module and features that are not appropriate, like those that modify
8120 mounted filesystems.
8125 return 0 if ($gconfig{'os_type'} ne 'solaris' ||
8126 $gconfig{'os_version'} < 10);
8127 my $zn = `zonename 2>$null_file`;
8129 return $zn && $zn ne "global";
8132 =head2 running_in_vserver
8134 Returns 1 if the current Webmin instance is running in a Linux VServer.
8135 Used to disable modules and features that are not appropriate.
8138 sub running_in_vserver
8140 return 0 if ($gconfig{'os_type'} !~ /^\*-linux$/);
8143 open(MTAB, "/etc/mtab");
8145 my ($dev, $mp) = split(/\s+/, $_);
8146 if ($mp eq "/" && $dev =~ /^\/dev\/hdv/) {
8155 =head2 running_in_xen
8157 Returns 1 if Webmin is running inside a Xen instance, by looking
8158 at /proc/xen/capabilities.
8163 return 0 if (!-r "/proc/xen/capabilities");
8164 my $cap = &read_file_contents("/proc/xen/capabilities");
8165 return $cap =~ /control_d/ ? 0 : 1;
8168 =head2 running_in_openvz
8170 Returns 1 if Webmin is running inside an OpenVZ container, by looking
8171 at /proc/vz/veinfo for a non-zero line.
8174 sub running_in_openvz
8176 return 0 if (!-r "/proc/vz/veinfo");
8177 my $lref = &read_file_lines("/proc/vz/veinfo", 1);
8178 return 0 if (!$lref || !@$lref);
8179 foreach my $l (@$lref) {
8181 my @ll = split(/\s+/, $l);
8182 return 0 if ($ll[0] eq '0');
8187 =head2 list_categories(&modules, [include-empty])
8189 Returns a hash mapping category codes to names, including any custom-defined
8190 categories. The modules parameter must be an array ref of module hash objects,
8191 as returned by get_all_module_infos.
8196 my ($mods, $empty) = @_;
8197 my (%cats, %catnames);
8198 &read_file("$config_directory/webmin.catnames", \%catnames);
8199 foreach my $o (@lang_order_list) {
8200 &read_file("$config_directory/webmin.catnames.$o", \%catnames);
8205 foreach my $m (@$mods) {
8206 my $c = $m->{'category'};
8207 next if ($cats{$c});
8208 if (defined($catnames{$c})) {
8209 $cats{$c} = $catnames{$c};
8211 elsif ($text{"category_$c"}) {
8212 $cats{$c} = $text{"category_$c"};
8215 # try to get category name from module ..
8216 my %mtext = &load_language($m->{'dir'});
8217 if ($mtext{"category_$c"}) {
8218 $cats{$c} = $mtext{"category_$c"};
8221 $c = $m->{'category'} = "";
8222 $cats{$c} = $text{"category_$c"};
8229 =head2 is_readonly_mode
8231 Returns 1 if the current user is in read-only mode, and thus all writes
8232 to files and command execution should fail.
8235 sub is_readonly_mode
8237 if (!defined($main::readonly_mode_cache)) {
8238 my %gaccess = &get_module_acl(undef, "");
8239 $main::readonly_mode_cache = $gaccess{'readonly'} ? 1 : 0;
8241 return $main::readonly_mode_cache;
8244 =head2 command_as_user(user, with-env?, command, ...)
8246 Returns a command to execute some command as the given user, using the
8247 su statement. If on Linux, the /bin/sh shell is forced in case the user
8248 does not have a valid shell. If with-env is set to 1, the -s flag is added
8249 to the su command to read the user's .profile or .bashrc file.
8254 my ($user, $env, @args) = @_;
8255 my @uinfo = getpwnam($user);
8256 if ($uinfo[8] ne "/bin/sh" && $uinfo[8] !~ /\/bash$/) {
8257 # User shell doesn't appear to be valid
8258 if ($gconfig{'os_type'} =~ /-linux$/) {
8259 # Use -s /bin/sh to force it
8260 $shellarg = " -s /bin/sh";
8262 elsif ($gconfig{'os_type'} eq 'freebsd' ||
8263 $gconfig{'os_type'} eq 'solaris' &&
8264 $gconfig{'os_version'} >= 11 ||
8265 $gconfig{'os_type'} eq 'macos') {
8266 # Use -m and force /bin/sh
8267 @args = ( "/bin/sh", "-c", quotemeta(join(" ", @args)) );
8271 my $rv = "su".($env ? " -" : "").$shellarg.
8272 " ".quotemeta($user)." -c ".quotemeta(join(" ", @args));
8276 =head2 list_osdn_mirrors(project, file)
8278 This function is now deprecated in favor of letting sourceforge just
8279 redirect to the best mirror, and now just returns their primary download URL.
8282 sub list_osdn_mirrors
8284 my ($project, $file) = @_;
8285 return ( { 'url' => "http://downloads.sourceforge.net/$project/$file",
8287 'mirror' => 'downloads' } );
8290 =head2 convert_osdn_url(url)
8292 Given a URL like http://osdn.dl.sourceforge.net/sourceforge/project/file.zip
8293 or http://prdownloads.sourceforge.net/project/file.zip , convert it
8294 to a real URL on the sourceforge download redirector.
8297 sub convert_osdn_url
8300 if ($url =~ /^http:\/\/[^\.]+.dl.sourceforge.net\/sourceforge\/([^\/]+)\/(.*)$/ ||
8301 $url =~ /^http:\/\/prdownloads.sourceforge.net\/([^\/]+)\/(.*)$/) {
8302 # Always use the Sourceforge mail download URL, which does
8303 # a location-based redirect for us
8304 my ($project, $file) = ($1, $2);
8305 $url = "http://prdownloads.sourceforge.net/sourceforge/".
8307 return wantarray ? ( $url, 0 ) : $url;
8310 # Some other source .. don't change
8311 return wantarray ? ( $url, 2 ) : $url;
8315 =head2 get_current_dir
8317 Returns the directory the current process is running in.
8323 if ($gconfig{'os_type'} eq 'windows') {
8336 =head2 supports_users
8338 Returns 1 if the current OS supports Unix user concepts and functions like
8339 su , getpw* and so on. This will be true on Linux and other Unixes, but false
8345 return $gconfig{'os_type'} ne 'windows';
8348 =head2 supports_symlinks
8350 Returns 1 if the current OS supports symbolic and hard links. This will not
8351 be the case on Windows.
8354 sub supports_symlinks
8356 return $gconfig{'os_type'} ne 'windows';
8359 =head2 quote_path(path)
8361 Returns a path with safe quoting for the current operating system.
8367 if ($gconfig{'os_type'} eq 'windows' || $path =~ /^[a-z]:/i) {
8368 # Windows only supports "" style quoting
8372 return quotemeta($path);
8376 =head2 get_windows_root
8378 Returns the base windows system directory, like c:/windows.
8381 sub get_windows_root
8383 if ($ENV{'SystemRoot'}) {
8384 my $rv = $ENV{'SystemRoot'};
8389 return -d "c:/windows" ? "c:/windows" : "c:/winnt";
8393 =head2 read_file_contents(file)
8395 Given a filename, returns its complete contents as a string. Effectively
8396 the same as the Perl construct `cat file`.
8399 sub read_file_contents
8401 &open_readfile(FILE, $_[0]) || return undef;
8408 =head2 unix_crypt(password, salt)
8410 Performs Unix encryption on a password, using the built-in crypt function or
8411 the Crypt::UnixCrypt module if the former does not work. The salt parameter
8412 must be either an already-hashed password, or a two-character alpha-numeric
8418 my ($pass, $salt) = @_;
8419 return "" if ($salt !~ /^[a-zA-Z0-9\.\/]{2}/); # same as real crypt
8420 my $rv = eval "crypt(\$pass, \$salt)";
8422 return $rv if ($rv && !$@);
8423 eval "use Crypt::UnixCrypt";
8425 return Crypt::UnixCrypt::crypt($pass, $salt);
8428 &error("Failed to encrypt password : $err");
8432 =head2 split_quoted_string(string)
8434 Given a string like I<foo "bar baz" quux>, returns the array :
8438 sub split_quoted_string
8442 while($str =~ /^"([^"]*)"\s*([\000-\377]*)$/ ||
8443 $str =~ /^'([^']*)'\s*([\000-\377]*)$/ ||
8444 $str =~ /^(\S+)\s*([\000-\377]*)$/) {
8451 =head2 write_to_http_cache(url, file|&data)
8453 Updates the Webmin cache with the contents of the given file, possibly also
8454 clearing out old data. Mainly for internal use by http_download.
8457 sub write_to_http_cache
8459 my ($url, $file) = @_;
8460 return 0 if (!$gconfig{'cache_size'});
8462 # Don't cache downloads that look dynamic
8463 if ($url =~ /cgi-bin/ || $url =~ /\?/) {
8467 # Check if the current module should do caching
8468 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
8469 # Caching all except some modules
8470 my @mods = split(/\s+/, $1);
8471 return 0 if (&indexof(&get_module_name(), @mods) != -1);
8473 elsif ($gconfig{'cache_mods'}) {
8474 # Only caching some modules
8475 my @mods = split(/\s+/, $gconfig{'cache_mods'});
8476 return 0 if (&indexof(&get_module_name(), @mods) == -1);
8482 $size = length($$file);
8485 my @st = stat($file);
8489 if ($size > $gconfig{'cache_size'}) {
8490 # Bigger than the whole cache - so don't save it
8495 $cfile = "$main::http_cache_directory/$cfile";
8497 # See how much we have cached currently, clearing old files
8499 mkdir($main::http_cache_directory, 0700) if (!-d $main::http_cache_directory);
8500 opendir(CACHEDIR, $main::http_cache_directory);
8501 foreach my $f (readdir(CACHEDIR)) {
8502 next if ($f eq "." || $f eq "..");
8503 my $path = "$main::http_cache_directory/$f";
8504 my @st = stat($path);
8505 if ($gconfig{'cache_days'} &&
8506 time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
8507 # This file is too old .. trash it
8512 push(@cached, [ $path, $st[7], $st[9] ]);
8516 @cached = sort { $a->[2] <=> $b->[2] } @cached;
8517 while($total+$size > $gconfig{'cache_size'} && @cached) {
8518 # Cache is too big .. delete some files until the new one will fit
8519 unlink($cached[0]->[0]);
8520 $total -= $cached[0]->[1];
8524 # Finally, write out the new file
8526 &open_tempfile(CACHEFILE, ">$cfile");
8527 &print_tempfile(CACHEFILE, $$file);
8528 &close_tempfile(CACHEFILE);
8531 my ($ok, $err) = ©_source_dest($file, $cfile);
8537 =head2 check_in_http_cache(url)
8539 If some URL is in the cache and valid, return the filename for it. Mainly
8540 for internal use by http_download.
8543 sub check_in_http_cache
8546 return undef if (!$gconfig{'cache_size'});
8548 # Check if the current module should do caching
8549 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
8550 # Caching all except some modules
8551 my @mods = split(/\s+/, $1);
8552 return 0 if (&indexof(&get_module_name(), @mods) != -1);
8554 elsif ($gconfig{'cache_mods'}) {
8555 # Only caching some modules
8556 my @mods = split(/\s+/, $gconfig{'cache_mods'});
8557 return 0 if (&indexof(&get_module_name(), @mods) == -1);
8562 $cfile = "$main::http_cache_directory/$cfile";
8563 my @st = stat($cfile);
8564 return undef if (!@st || !$st[7]);
8565 if ($gconfig{'cache_days'} && time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
8570 open(TOUCH, ">>$cfile"); # Update the file time, to keep it in the cache
8575 =head2 supports_javascript
8577 Returns 1 if the current browser is assumed to support javascript.
8580 sub supports_javascript
8582 if (defined(&theme_supports_javascript)) {
8583 return &theme_supports_javascript();
8585 return $ENV{'MOBILE_DEVICE'} ? 0 : 1;
8588 =head2 get_module_name
8590 Returns the name of the Webmin module that called this function. For internal
8591 use only by other API functions.
8596 return &get_module_variable('$module_name');
8599 =head2 get_module_variable(name, [ref])
8601 Returns the value of some variable which is set in the caller's context, if
8602 using the new WebminCore package. For internal use only.
8605 sub get_module_variable
8607 my ($v, $wantref) = @_;
8608 my $slash = $wantref ? "\\" : "";
8609 my $thispkg = &web_libs_package();
8610 if ($thispkg eq 'WebminCore') {
8611 my ($vt, $vn) = split('', $v, 2);
8613 for(my $i=0; ($callpkg) = caller($i); $i++) {
8614 last if ($callpkg ne $thispkg);
8616 return eval "${slash}${vt}${callpkg}::${vn}";
8618 return eval "${slash}${v}";
8621 =head2 clear_time_locale()
8623 Temporarily force the locale to C, until reset_time_locale is called. This is
8624 useful if your code is going to call C<strftime> from the POSIX package, and
8625 you want to ensure that the output is in a consistent format.
8628 sub clear_time_locale
8630 if ($main::clear_time_locale_count == 0) {
8633 $main::clear_time_locale_old = POSIX::setlocale(POSIX::LC_TIME);
8634 POSIX::setlocale(POSIX::LC_TIME, "C");
8637 $main::clear_time_locale_count++;
8640 =head2 reset_time_locale()
8642 Revert the locale to whatever it was before clear_time_locale was called
8645 sub reset_time_locale
8647 if ($main::clear_time_locale_count == 1) {
8649 POSIX::setlocale(POSIX::LC_TIME, $main::clear_time_locale_old);
8650 $main::clear_time_locale_old = undef;
8653 $main::clear_time_locale_count--;
8656 =head2 callers_package(filehandle)
8658 Convert a non-module filehandle like FOO to one qualified with the
8659 caller's caller's package, like fsdump::FOO. For internal use only.
8665 my $callpkg = (caller(1))[0];
8666 my $thispkg = &web_libs_package();
8667 if (!ref($fh) && $fh !~ /::/ &&
8668 $callpkg ne $thispkg && $thispkg eq 'WebminCore') {
8669 $fh = $callpkg."::".$fh;
8674 =head2 web_libs_package()
8676 Returns the package this code is in. We can't always trust __PACKAGE__. For
8680 sub web_libs_package
8682 if ($called_from_webmin_core) {
8683 return "WebminCore";
8688 $done_web_lib_funcs = 1;