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 &open_tempfile(FLUSHFILE, ">$f");
2695 foreach my $line (@{$main::file_cache{$f}}) {
2696 (print FLUSHFILE $line,$eol) ||
2697 &error(&text("efilewrite", $f, $!));
2699 &close_tempfile(FLUSHFILE);
2701 delete($main::file_cache{$f});
2702 delete($main::file_cache_noflush{$f});
2706 =head2 unflush_file_lines(file)
2708 Clear the internal cache of some given file, previously read by read_file_lines.
2711 sub unflush_file_lines
2713 my $realfile = &translate_filename($_[0]);
2714 delete($main::file_cache{$realfile});
2715 delete($main::file_cache_noflush{$realfile});
2718 =head2 unix_user_input(fieldname, user, [form])
2720 Returns HTML for an input to select a Unix user. By default this is a text
2721 box with a user popup button next to it.
2726 if (defined(&theme_unix_user_input)) {
2727 return &theme_unix_user_input(@_);
2729 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
2730 &user_chooser_button($_[0], 0, $_[2] || 0)."\n";
2733 =head2 unix_group_input(fieldname, user, [form])
2735 Returns HTML for an input to select a Unix group. By default this is a text
2736 box with a group popup button next to it.
2739 sub unix_group_input
2741 if (defined(&theme_unix_group_input)) {
2742 return &theme_unix_group_input(@_);
2744 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
2745 &group_chooser_button($_[0], 0, $_[2] || 0)."\n";
2748 =head2 hlink(text, page, [module], [width], [height])
2750 Returns HTML for a link that when clicked on pops up a window for a Webmin
2751 help page. The parameters are :
2753 =item text - Text for the link.
2755 =item page - Help page code, such as 'intro'.
2757 =item module - Module the help page is in. Defaults to the current module.
2759 =item width - Width of the help popup window. Defaults to 600 pixels.
2761 =item height - Height of the help popup window. Defaults to 400 pixels.
2763 The actual help pages are in each module's help sub-directory, in files with
2769 if (defined(&theme_hlink)) {
2770 return &theme_hlink(@_);
2772 my $mod = $_[2] ? $_[2] : &get_module_name();
2773 my $width = $_[3] || $tconfig{'help_width'} || $gconfig{'help_width'} || 600;
2774 my $height = $_[4] || $tconfig{'help_height'} || $gconfig{'help_height'} || 400;
2775 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>";
2778 =head2 user_chooser_button(field, multiple, [form])
2780 Returns HTML for a javascript button for choosing a Unix user or users.
2781 The parameters are :
2783 =item field - Name of the HTML field to place the username into.
2785 =item multiple - Set to 1 if multiple users can be selected.
2787 =item form - Index of the form on the page.
2790 sub user_chooser_button
2792 return undef if (!&supports_users());
2793 return &theme_user_chooser_button(@_)
2794 if (defined(&theme_user_chooser_button));
2795 my $form = defined($_[2]) ? $_[2] : 0;
2796 my $w = $_[1] ? 500 : 300;
2798 if ($_[1] && $gconfig{'db_sizeusers'}) {
2799 ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
2801 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
2802 ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
2804 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";
2807 =head2 group_chooser_button(field, multiple, [form])
2809 Returns HTML for a javascript button for choosing a Unix group or groups
2810 The parameters are :
2812 =item field - Name of the HTML field to place the group name into.
2814 =item multiple - Set to 1 if multiple groups can be selected.
2816 =item form - Index of the form on the page.
2819 sub group_chooser_button
2821 return undef if (!&supports_users());
2822 return &theme_group_chooser_button(@_)
2823 if (defined(&theme_group_chooser_button));
2824 my $form = defined($_[2]) ? $_[2] : 0;
2825 my $w = $_[1] ? 500 : 300;
2827 if ($_[1] && $gconfig{'db_sizeusers'}) {
2828 ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
2830 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
2831 ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
2833 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";
2836 =head2 foreign_check(module, [api-only])
2838 Checks if some other module exists and is supported on this OS. The parameters
2841 =item module - Name of the module to check.
2843 =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.
2848 my ($mod, $api) = @_;
2850 my $mdir = &module_root_directory($mod);
2851 &read_file_cached("$mdir/module.info", \%minfo) || return 0;
2852 return &check_os_support(\%minfo, undef, undef, $api);
2855 =head2 foreign_exists(module)
2857 Checks if some other module exists. The module parameter is the short module
2863 my $mdir = &module_root_directory($_[0]);
2864 return -r "$mdir/module.info";
2867 =head2 foreign_available(module)
2869 Returns 1 if some module is installed, and acessible to the current user. The
2870 module parameter is the module directory name.
2873 sub foreign_available
2875 return 0 if (!&foreign_check($_[0]) &&
2876 !$gconfig{'available_even_if_no_support'});
2877 my %foreign_module_info = &get_module_info($_[0]);
2879 # Check list of allowed modules
2881 &read_acl(\%acl, undef);
2882 return 0 if (!$acl{$base_remote_user,$_[0]} &&
2883 !$acl{$base_remote_user,'*'});
2885 # Check for usermod restrictions
2886 my @usermods = &list_usermods();
2887 return 0 if (!&available_usermods( [ \%foreign_module_info ], \@usermods));
2889 if (&get_product_name() eq "webmin") {
2890 # Check if the user has any RBAC privileges in this module
2891 if (&supports_rbac($_[0]) &&
2892 &use_rbac_module_acl(undef, $_[0])) {
2893 # RBAC is enabled for this user and module - check if he
2895 my $rbacs = &get_rbac_module_acl($remote_user, $_[0]);
2896 return 0 if (!$rbacs);
2898 elsif ($gconfig{'rbacdeny_'.$base_remote_user}) {
2899 # If denying access to modules not specifically allowed by
2900 # RBAC, then prevent access
2905 # Check readonly support
2906 if (&is_readonly_mode()) {
2907 return 0 if (!$foreign_module_info{'readonly'});
2910 # Check if theme vetos
2911 if (defined(&theme_foreign_available)) {
2912 return 0 if (!&theme_foreign_available($_[0]));
2915 # Check if licence module vetos
2916 if ($main::licence_module) {
2917 return 0 if (!&foreign_call($main::licence_module,
2918 "check_module_licence", $_[0]));
2924 =head2 foreign_require(module, [file], [package])
2926 Brings in functions from another module, and places them in the Perl namespace
2927 with the same name as the module. The parameters are :
2929 =item module - The source module's directory name, like sendmail.
2931 =item file - The API file in that module, like sendmail-lib.pl. If missing, all API files are loaded.
2933 =item package - Perl package to place the module's functions and global variables in.
2935 If the original module name contains dashes, they will be replaced with _ in
2941 my ($mod, $file, $pkg) = @_;
2942 $pkg ||= $mod || "global";
2943 $pkg =~ s/[^A-Za-z0-9]/_/g;
2946 push(@files, $file);
2950 my %minfo = &get_module_info($mod);
2951 if ($minfo{'library'}) {
2952 @files = split(/\s+/, $minfo{'library'});
2955 @files = ( $mod."-lib.pl" );
2958 @files = grep { !$main::done_foreign_require{$pkg,$_} } @files;
2959 return 1 if (!@files);
2960 foreach my $f (@files) {
2961 $main::done_foreign_require{$pkg,$f}++;
2964 my $mdir = &module_root_directory($mod);
2965 @INC = &unique($mdir, @INC);
2966 -d $mdir || &error("Module $mod does not exist");
2967 if (!&get_module_name() && $mod) {
2970 my $old_fmn = $ENV{'FOREIGN_MODULE_NAME'};
2971 my $old_frd = $ENV{'FOREIGN_ROOT_DIRECTORY'};
2972 my $code = "package $pkg; ".
2973 "\$ENV{'FOREIGN_MODULE_NAME'} = '$mod'; ".
2974 "\$ENV{'FOREIGN_ROOT_DIRECTORY'} = '$root_directory'; ";
2975 foreach my $f (@files) {
2976 $code .= "do '$mdir/$f' || die \$@; ";
2979 if (defined($old_fmn)) {
2980 $ENV{'FOREIGN_MODULE_NAME'} = $old_fmn;
2983 delete($ENV{'FOREIGN_MODULE_NAME'});
2985 if (defined($old_frd)) {
2986 $ENV{'FOREIGN_ROOT_DIRECTORY'} = $old_frd;
2989 delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
2992 if ($@) { &error("Require $mod/$files[0] failed : <pre>$@</pre>"); }
2996 =head2 foreign_call(module, function, [arg]*)
2998 Call a function in another module. The module parameter is the target module
2999 directory name, function is the perl sub to call, and the remaining parameters
3000 are the arguments. However, unless you need to call a function whose name
3001 is dynamic, it is better to use Perl's cross-module function call syntax
3002 like module::function(args).
3007 my $pkg = $_[0] || "global";
3008 $pkg =~ s/[^A-Za-z0-9]/_/g;
3009 my @args = @_[2 .. @_-1];
3010 $main::foreign_args = \@args;
3011 my @rv = eval <<EOF;
3013 &$_[1](\@{\$main::foreign_args});
3015 if ($@) { &error("$_[0]::$_[1] failed : $@"); }
3016 return wantarray ? @rv : $rv[0];
3019 =head2 foreign_config(module, [user-config])
3021 Get the configuration from another module, and return it as a hash. If the
3022 user-config parameter is set to 1, returns the Usermin user-level preferences
3023 for the current user instead.
3028 my ($mod, $uc) = @_;
3031 &read_file_cached("$root_directory/$mod/defaultuconfig", \%fconfig);
3032 &read_file_cached("$config_directory/$mod/uconfig", \%fconfig);
3033 &read_file_cached("$user_config_directory/$mod/config", \%fconfig);
3036 &read_file_cached("$config_directory/$mod/config", \%fconfig);
3041 =head2 foreign_installed(module, mode)
3043 Checks if the server for some module is installed, and possibly also checks
3044 if the module has been configured by Webmin.
3045 For mode 1, returns 2 if the server is installed and configured for use by
3046 Webmin, 1 if installed but not configured, or 0 otherwise.
3047 For mode 0, returns 1 if installed, 0 if not.
3048 If the module does not provide an install_check.pl script, assumes that
3049 the server is installed.
3052 sub foreign_installed
3054 my ($mod, $configured) = @_;
3055 if (defined($main::foreign_installed_cache{$mod,$configured})) {
3057 return $main::foreign_installed_cache{$mod,$configured};
3061 if (!&foreign_check($mod)) {
3066 my $mdir = &module_root_directory($mod);
3067 if (!-r "$mdir/install_check.pl") {
3068 # Not known, assume OK
3069 $rv = $configured ? 2 : 1;
3072 # Call function to check
3073 &foreign_require($mod, "install_check.pl");
3074 $rv = &foreign_call($mod, "is_installed", $configured);
3077 $main::foreign_installed_cache{$mod,$configured} = $rv;
3082 =head2 foreign_defined(module, function)
3084 Returns 1 if some function is defined in another module. In general, it is
3085 simpler to use the syntax &defined(module::function) instead.
3091 $pkg =~ s/[^A-Za-z0-9]/_/g;
3092 my $func = "${pkg}::$_[1]";
3093 return defined(&$func);
3096 =head2 get_system_hostname([short])
3098 Returns the hostname of this system. If the short parameter is set to 1,
3099 then the domain name is not prepended - otherwise, Webmin will attempt to get
3100 the fully qualified hostname, like foo.example.com.
3103 sub get_system_hostname
3106 if (!$main::get_system_hostname[$m]) {
3107 if ($gconfig{'os_type'} ne 'windows') {
3108 # Try some common Linux hostname files first
3110 if ($gconfig{'os_type'} eq 'redhat-linux') {
3112 &read_env_file("/etc/sysconfig/network", \%nc);
3113 if ($nc{'HOSTNAME'}) {
3114 $fromfile = $nc{'HOSTNAME'};
3117 elsif ($gconfig{'os_type'} eq 'debian-linux') {
3118 my $hn = &read_file_contents("/etc/hostname");
3124 elsif ($gconfig{'os_type'} eq 'open-linux') {
3125 my $hn = &read_file_contents("/etc/HOSTNAME");
3131 elsif ($gconfig{'os_type'} eq 'solaris') {
3132 my $hn = &read_file_contents("/etc/nodename");
3139 # If we found a hostname, use it if value
3140 if ($fromfile && ($m || $fromfile =~ /\./)) {
3142 $fromfile =~ s/\..*$//;
3144 $main::get_system_hostname[$m] = $fromfile;
3148 # Can use hostname command on Unix
3149 &execute_command("hostname", undef,
3150 \$main::get_system_hostname[$m], undef, 0, 1);
3151 chop($main::get_system_hostname[$m]);
3153 eval "use Sys::Hostname";
3155 $main::get_system_hostname[$m] = eval "hostname()";
3157 if ($@ || !$main::get_system_hostname[$m]) {
3158 $main::get_system_hostname[$m] = "UNKNOWN";
3161 elsif ($main::get_system_hostname[$m] !~ /\./ &&
3162 $gconfig{'os_type'} =~ /linux$/ &&
3163 !$gconfig{'no_hostname_f'} && !$_[0]) {
3164 # Try with -f flag to get fully qualified name
3166 my $ex = &execute_command("hostname -f", undef, \$flag,
3169 if ($ex || $flag eq "") {
3170 # -f not supported! We have probably set the
3171 # hostname to just '-f'. Fix the problem
3174 &execute_command("hostname ".
3175 quotemeta($main::get_system_hostname[$m]),
3176 undef, undef, undef, 0, 1);
3180 $main::get_system_hostname[$m] = $flag;
3185 # On Windows, try computername environment variable
3186 return $ENV{'computername'} if ($ENV{'computername'});
3187 return $ENV{'COMPUTERNAME'} if ($ENV{'COMPUTERNAME'});
3189 # Fall back to net name command
3190 my $out = `net name 2>&1`;
3191 if ($out =~ /\-+\r?\n(\S+)/) {
3192 $main::get_system_hostname[$m] = $1;
3195 $main::get_system_hostname[$m] = "windows";
3199 return $main::get_system_hostname[$m];
3202 =head2 get_webmin_version
3204 Returns the version of Webmin currently being run, such as 1.450.
3207 sub get_webmin_version
3209 if (!$get_webmin_version) {
3210 open(VERSION, "$root_directory/version") || return 0;
3211 ($get_webmin_version = <VERSION>) =~ tr/\r|\n//d;
3214 return $get_webmin_version;
3217 =head2 get_module_acl([user], [module], [no-rbac], [no-default])
3219 Returns a hash containing access control options for the given user and module.
3220 By default the current username and module name are used. If the no-rbac flag
3221 is given, the permissions will not be updated based on the user's RBAC role
3222 (as seen on Solaris). If the no-default flag is given, default permissions for
3223 the module will not be included.
3228 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
3229 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3230 my $mdir = &module_root_directory($m);
3233 # Read default ACL first, to be overridden by per-user settings
3234 &read_file_cached("$mdir/defaultacl", \%rv);
3236 # If this isn't a master admin user, apply the negative permissions
3237 # so that he doesn't un-expectedly gain access to new features
3239 &read_file_cached("$config_directory/$u.acl", \%gaccess);
3240 if ($gaccess{'negative'}) {
3241 &read_file_cached("$mdir/negativeacl", \%rv);
3245 if (!$_[2] && &supports_rbac($m) && &use_rbac_module_acl($u, $m)) {
3246 # RBAC overrides exist for this user in this module
3247 my $rbac = &get_rbac_module_acl(
3248 defined($_[0]) ? $_[0] : $remote_user, $m);
3249 foreach my $r (keys %$rbac) {
3250 $rv{$r} = $rbac->{$r};
3253 elsif ($gconfig{"risk_$u"} && $m) {
3254 # ACL is defined by user's risk level
3255 my $rf = $gconfig{"risk_$u"}.'.risk';
3256 &read_file_cached("$mdir/$rf", \%rv);
3258 my $sf = $gconfig{"skill_$u"}.'.skill';
3259 &read_file_cached("$mdir/$sf", \%rv);
3262 # Use normal Webmin ACL, if a user is set
3263 &read_file_cached("$config_directory/$m/$u.acl", \%rv);
3264 if ($remote_user ne $base_remote_user && !defined($_[0])) {
3265 &read_file_cached("$config_directory/$m/$remote_user.acl",\%rv);
3268 if ($tconfig{'preload_functions'}) {
3269 &load_theme_library();
3271 if (defined(&theme_get_module_acl)) {
3272 %rv = &theme_get_module_acl($u, $m, \%rv);
3277 =head2 get_group_module_acl(group, [module])
3279 Returns the ACL for a Webmin group, in an optional module (which defaults to
3280 the current module).
3283 sub get_group_module_acl
3286 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3287 my $mdir = &module_root_directory($m);
3289 &read_file_cached("$mdir/defaultacl", \%rv);
3290 &read_file_cached("$config_directory/$m/$g.gacl", \%rv);
3291 if (defined(&theme_get_module_acl)) {
3292 %rv = &theme_get_module_acl($g, $m, \%rv);
3297 =head2 save_module_acl(&acl, [user], [module])
3299 Updates the acl hash for some user and module. The parameters are :
3301 =item acl - Hash reference for the new access control options.
3303 =item user - User to update, defaulting to the current user.
3305 =item module - Module to update, defaulting to the caller.
3310 my $u = defined($_[1]) ? $_[1] : $base_remote_user;
3311 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3312 if (&foreign_check("acl")) {
3313 # Check if this user is a member of a group, and if he gets the
3314 # module from a group. If so, update its ACL as well
3315 &foreign_require("acl", "acl-lib.pl");
3317 foreach my $g (&acl::list_groups()) {
3318 if (&indexof($u, @{$g->{'members'}}) >= 0 &&
3319 &indexof($m, @{$g->{'modules'}}) >= 0) {
3325 &save_group_module_acl($_[0], $group->{'name'}, $m);
3328 if (!-d "$config_directory/$m") {
3329 mkdir("$config_directory/$m", 0755);
3331 &write_file("$config_directory/$m/$u.acl", $_[0]);
3334 =head2 save_group_module_acl(&acl, group, [module])
3336 Updates the acl hash for some group and module. The parameters are :
3338 =item acl - Hash reference for the new access control options.
3340 =item group - Group name to update.
3342 =item module - Module to update, defaulting to the caller.
3345 sub save_group_module_acl
3348 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3349 if (&foreign_check("acl")) {
3350 # Check if this group is a member of a group, and if it gets the
3351 # module from a group. If so, update the parent ACL as well
3352 &foreign_require("acl", "acl-lib.pl");
3354 foreach my $pg (&acl::list_groups()) {
3355 if (&indexof('@'.$g, @{$pg->{'members'}}) >= 0 &&
3356 &indexof($m, @{$pg->{'modules'}}) >= 0) {
3362 &save_group_module_acl($_[0], $group->{'name'}, $m);
3365 if (!-d "$config_directory/$m") {
3366 mkdir("$config_directory/$m", 0755);
3368 &write_file("$config_directory/$m/$g.gacl", $_[0]);
3373 This function must be called by all Webmin CGI scripts, either directly or
3374 indirectly via a per-module lib.pl file. It performs a number of initialization
3375 and housekeeping tasks, such as working out the module name, checking that the
3376 current user has access to the module, and populating global variables. Some
3377 of the variables set include :
3379 =item $config_directory - Base Webmin config directory, typically /etc/webmin
3381 =item $var_directory - Base logs directory, typically /var/webmin
3383 =item %config - Per-module configuration.
3385 =item %gconfig - Global configuration.
3387 =item $scriptname - Base name of the current perl script.
3389 =item $module_name - The name of the current module.
3391 =item $module_config_directory - The config directory for this module.
3393 =item $module_config_file - The config file for this module.
3395 =item $module_root_directory - This module's code directory.
3397 =item $webmin_logfile - The detailed logfile for webmin.
3399 =item $remote_user - The actual username used to login to webmin.
3401 =item $base_remote_user - The username whose permissions are in effect.
3403 =item $current_theme - The theme currently in use.
3405 =item $root_directory - The first root directory of this webmin install.
3407 =item @root_directories - All root directories for this webmin install.
3412 # Record first process ID that called this, so we know when it exited to clean
3414 $main::initial_process_id ||= $$;
3416 # Configuration and spool directories
3417 if (!defined($ENV{'WEBMIN_CONFIG'})) {
3418 die "WEBMIN_CONFIG not set";
3420 $config_directory = $ENV{'WEBMIN_CONFIG'};
3421 if (!defined($ENV{'WEBMIN_VAR'})) {
3422 open(VARPATH, "$config_directory/var-path");
3423 chop($var_directory = <VARPATH>);
3427 $var_directory = $ENV{'WEBMIN_VAR'};
3429 $main::http_cache_directory = $ENV{'WEBMIN_VAR'}."/cache";
3430 $main::default_debug_log_file = $ENV{'WEBMIN_VAR'}."/webmin.debug";
3432 if ($ENV{'SESSION_ID'}) {
3433 # Hide this variable from called programs, but keep it for internal use
3434 $main::session_id = $ENV{'SESSION_ID'};
3435 delete($ENV{'SESSION_ID'});
3437 if ($ENV{'REMOTE_PASS'}) {
3438 # Hide the password too
3439 $main::remote_pass = $ENV{'REMOTE_PASS'};
3440 delete($ENV{'REMOTE_PASS'});
3443 if ($> == 0 && $< != 0 && !$ENV{'FOREIGN_MODULE_NAME'}) {
3444 # Looks like we are running setuid, but the real UID hasn't been set.
3445 # Do so now, so that executed programs don't get confused
3450 # Read the webmin global config file. This contains the OS type and version,
3451 # OS specific configuration and global options such as proxy servers
3452 $config_file = "$config_directory/config";
3454 &read_file_cached($config_file, \%gconfig);
3455 $null_file = $gconfig{'os_type'} eq 'windows' ? "NUL" : "/dev/null";
3456 $path_separator = $gconfig{'os_type'} eq 'windows' ? ';' : ':';
3458 # If debugging is enabled, open the debug log
3459 if ($gconfig{'debug_enabled'} && !$main::opened_debug_log++) {
3460 my $dlog = $gconfig{'debug_file'} || $main::default_debug_log_file;
3461 if ($gconfig{'debug_size'}) {
3462 my @st = stat($dlog);
3463 if ($st[7] > $gconfig{'debug_size'}) {
3464 rename($dlog, $dlog.".0");
3467 open(main::DEBUGLOG, ">>$dlog");
3468 $main::opened_debug_log = 1;
3470 if ($gconfig{'debug_what_start'}) {
3471 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
3472 $main::debug_log_start_time = time();
3473 &webmin_debug_log("START", "script=$script_name");
3474 $main::debug_log_start_module = $module_name;
3478 # Set PATH and LD_LIBRARY_PATH
3479 if ($gconfig{'path'}) {
3480 if ($gconfig{'syspath'}) {
3482 $ENV{'PATH'} = $gconfig{'path'};
3486 $ENV{'PATH'} = $gconfig{'path'}.$path_separator.$ENV{'PATH'};
3489 $ENV{$gconfig{'ld_env'}} = $gconfig{'ld_path'} if ($gconfig{'ld_env'});
3491 # Set http_proxy and ftp_proxy environment variables, based on Webmin settings
3492 if ($gconfig{'http_proxy'}) {
3493 $ENV{'http_proxy'} = $gconfig{'http_proxy'};
3495 if ($gconfig{'ftp_proxy'}) {
3496 $ENV{'ftp_proxy'} = $gconfig{'ftp_proxy'};
3498 if ($gconfig{'noproxy'}) {
3499 $ENV{'no_proxy'} = $gconfig{'noproxy'};
3502 # Find all root directories
3504 if (&get_miniserv_config(\%miniserv)) {
3505 @root_directories = ( $miniserv{'root'} );
3506 for($i=0; defined($miniserv{"extraroot_$i"}); $i++) {
3507 push(@root_directories, $miniserv{"extraroot_$i"});
3511 # Work out which module we are in, and read the per-module config file
3512 $0 =~ s/\\/\//g; # Force consistent path on Windows
3513 if (defined($ENV{'FOREIGN_MODULE_NAME'})) {
3514 # In a foreign call - use the module name given
3515 $root_directory = $ENV{'FOREIGN_ROOT_DIRECTORY'};
3516 $module_name = $ENV{'FOREIGN_MODULE_NAME'};
3517 @root_directories = ( $root_directory ) if (!@root_directories);
3519 elsif ($ENV{'SCRIPT_NAME'}) {
3520 my $sn = $ENV{'SCRIPT_NAME'};
3521 $sn =~ s/^$gconfig{'webprefix'}//
3522 if (!$gconfig{'webprefixnoredir'});
3523 if ($sn =~ /^\/([^\/]+)\//) {
3524 # Get module name from CGI path
3527 if ($ENV{'SERVER_ROOT'}) {
3528 $root_directory = $ENV{'SERVER_ROOT'};
3530 elsif ($ENV{'SCRIPT_FILENAME'}) {
3531 $root_directory = $ENV{'SCRIPT_FILENAME'};
3532 $root_directory =~ s/$sn$//;
3534 @root_directories = ( $root_directory ) if (!@root_directories);
3537 # Get root directory from miniserv.conf, and deduce module name from $0
3538 $root_directory = $root_directories[0];
3540 foreach my $r (@root_directories) {
3541 if ($0 =~ /^$r\/([^\/]+)\/[^\/]+$/i) {
3542 # Under a module directory
3547 elsif ($0 =~ /^$root_directory\/[^\/]+$/i) {
3553 &error("Script was not run with full path (failed to find $0 under $root_directory)") if (!$rok);
3556 # Work out of this is a web, command line or cron job
3557 if (!$main::webmin_script_type) {
3558 if ($ENV{'SCRIPT_NAME'}) {
3560 $main::webmin_script_type = 'web';
3563 # Cron jobs have no TTY
3564 if ($gconfig{'os_type'} eq 'windows' ||
3565 open(DEVTTY, ">/dev/tty")) {
3566 $main::webmin_script_type = 'cmd';
3570 $main::webmin_script_type = 'cron';
3575 # Set the umask based on config
3576 if ($gconfig{'umask'} && !$main::umask_already++) {
3577 umask(oct($gconfig{'umask'}));
3580 # If this is a cron job or other background task, set the nice level
3581 if (!$main::nice_already && $main::webmin_script_type eq 'cron') {
3583 if ($gconfig{'nice'}) {
3584 eval 'POSIX::nice($gconfig{\'nice\'});';
3587 # Set IO scheduling class and priority
3588 if ($gconfig{'sclass'} ne '' || $gconfig{'sprio'} ne '') {
3590 $cmd .= " -c ".quotemeta($gconfig{'sclass'})
3591 if ($gconfig{'sclass'} ne '');
3592 $cmd .= " -n ".quotemeta($gconfig{'sprio'})
3593 if ($gconfig{'sprio'} ne '');
3595 &execute_command("$cmd >/dev/null 2>&1");
3598 $main::nice_already++;
3601 my $u = $ENV{'BASE_REMOTE_USER'} || $ENV{'REMOTE_USER'};
3602 $base_remote_user = $u;
3603 $remote_user = $ENV{'REMOTE_USER'};
3606 # Find and load the configuration file for this module
3607 my (@ruinfo, $rgroup);
3608 $module_config_directory = "$config_directory/$module_name";
3609 if (&get_product_name() eq "usermin" &&
3610 -r "$module_config_directory/config.$remote_user") {
3612 $module_config_file = "$module_config_directory/config.$remote_user";
3614 elsif (&get_product_name() eq "usermin" &&
3615 (@ruinfo = getpwnam($remote_user)) &&
3616 ($rgroup = getgrgid($ruinfo[3])) &&
3617 -r "$module_config_directory/config.\@$rgroup") {
3618 # Based on group name
3619 $module_config_file = "$module_config_directory/config.\@$rgroup";
3623 $module_config_file = "$module_config_directory/config";
3626 &read_file_cached($module_config_file, \%config);
3628 # Fix up windows-specific substitutions in values
3629 foreach my $k (keys %config) {
3630 if ($config{$k} =~ /\$\{systemroot\}/) {
3631 my $root = &get_windows_root();
3632 $config{$k} =~ s/\$\{systemroot\}/$root/g;
3637 # Record the initial module
3638 $main::initial_module_name ||= $module_name;
3640 # Set some useful variables
3642 $current_themes = $ENV{'MOBILE_DEVICE'} && defined($gconfig{'mobile_theme'}) ?
3643 $gconfig{'mobile_theme'} :
3644 defined($gconfig{'theme_'.$remote_user}) ?
3645 $gconfig{'theme_'.$remote_user} :
3646 defined($gconfig{'theme_'.$base_remote_user}) ?
3647 $gconfig{'theme_'.$base_remote_user} :
3649 @current_themes = split(/\s+/, $current_themes);
3650 $current_theme = $current_themes[0];
3651 @theme_root_directories = map { "$root_directory/$_" } @current_themes;
3652 $theme_root_directory = $theme_root_directories[0];
3653 @theme_configs = ( );
3654 foreach my $troot (@theme_root_directories) {
3656 &read_file_cached("$troot/config", \%onetconfig);
3657 &read_file_cached("$troot/config", \%tconfig);
3658 push(@theme_configs, \%onetconfig);
3660 $tb = defined($tconfig{'cs_header'}) ? "bgcolor=#$tconfig{'cs_header'}" :
3661 defined($gconfig{'cs_header'}) ? "bgcolor=#$gconfig{'cs_header'}" :
3663 $cb = defined($tconfig{'cs_table'}) ? "bgcolor=#$tconfig{'cs_table'}" :
3664 defined($gconfig{'cs_table'}) ? "bgcolor=#$gconfig{'cs_table'}" :
3666 $tb .= ' '.$tconfig{'tb'} if ($tconfig{'tb'});
3667 $cb .= ' '.$tconfig{'cb'} if ($tconfig{'cb'});
3668 if ($tconfig{'preload_functions'}) {
3669 # Force load of theme functions right now, if requested
3670 &load_theme_library();
3672 if ($tconfig{'oofunctions'} && !$main::loaded_theme_oo_library++) {
3673 # Load the theme's Webmin:: package classes
3674 do "$theme_root_directory/$tconfig{'oofunctions'}";
3679 $webmin_logfile = $gconfig{'webmin_log'} ? $gconfig{'webmin_log'}
3680 : "$var_directory/webmin.log";
3682 # Load language strings into %text
3683 my @langs = &list_languages();
3685 if ($gconfig{'acceptlang'}) {
3686 foreach my $a (split(/,/, $ENV{'HTTP_ACCEPT_LANGUAGE'})) {
3687 my ($al) = grep { $_->{'lang'} eq $a } @langs;
3689 $accepted_lang = $al->{'lang'};
3694 $current_lang = $force_lang ? $force_lang :
3695 $accepted_lang ? $accepted_lang :
3696 $gconfig{"lang_$remote_user"} ? $gconfig{"lang_$remote_user"} :
3697 $gconfig{"lang_$base_remote_user"} ? $gconfig{"lang_$base_remote_user"} :
3698 $gconfig{"lang"} ? $gconfig{"lang"} : $default_lang;
3699 foreach my $l (@langs) {
3700 $current_lang_info = $l if ($l->{'lang'} eq $current_lang);
3702 @lang_order_list = &unique($default_lang,
3703 split(/:/, $current_lang_info->{'fallback'}),
3705 %text = &load_language($module_name);
3706 %text || &error("Failed to determine Webmin root from SERVER_ROOT, SCRIPT_FILENAME or the full command line");
3708 # Get the %module_info for this module
3710 my ($mi) = grep { $_->{'dir'} eq $module_name }
3711 &get_all_module_infos(2);
3712 %module_info = %$mi;
3713 $module_root_directory = &module_root_directory($module_name);
3716 if ($module_name && !$main::no_acl_check &&
3717 !defined($ENV{'FOREIGN_MODULE_NAME'})) {
3718 # Check if the HTTP user can access this module
3719 if (!&foreign_available($module_name)) {
3720 if (!&foreign_check($module_name)) {
3721 &error(&text('emodulecheck',
3722 "<i>$module_info{'desc'}</i>"));
3725 &error(&text('emodule', "<i>$u</i>",
3726 "<i>$module_info{'desc'}</i>"));
3729 $main::no_acl_check++;
3732 # Check the Referer: header for nasty redirects
3733 my @referers = split(/\s+/, $gconfig{'referers'});
3735 if ($ENV{'HTTP_REFERER'} =~/^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?([^\/:@]+)/) {
3738 my $http_host = $ENV{'HTTP_HOST'};
3739 $http_host =~ s/:\d+$//;
3741 ($ENV{'SCRIPT_NAME'} !~ /^\/(index.cgi)?$/ || $unsafe_index_cgi) &&
3742 ($ENV{'SCRIPT_NAME'} !~ /^\/([a-z0-9\_\-]+)\/(index.cgi)?$/i ||
3743 $unsafe_index_cgi) &&
3744 $0 !~ /(session_login|pam_login)\.cgi$/ && !$gconfig{'referer'} &&
3745 $ENV{'MINISERV_CONFIG'} && !$main::no_referers_check &&
3746 $ENV{'HTTP_USER_AGENT'} !~ /^Webmin/i &&
3747 ($referer_site && $referer_site ne $http_host &&
3748 &indexof($referer_site, @referers) < 0 ||
3749 !$referer_site && $gconfig{'referers_none'}) &&
3750 !$trust_unknown_referers &&
3751 !&get_module_variable('$trust_unknown_referers')) {
3752 # Looks like a link from elsewhere .. show an error
3753 &header($text{'referer_title'}, "", undef, 0, 1, 1);
3755 $prot = lc($ENV{'HTTPS'}) eq 'on' ? "https" : "http";
3756 my $url = "<tt>".&html_escape("$prot://$ENV{'HTTP_HOST'}$ENV{'REQUEST_URI'}")."</tt>";
3757 if ($referer_site) {
3759 print &text('referer_warn',
3760 "<tt>".&html_escape($ENV{'HTTP_REFERER'})."</tt>", $url);
3762 print &text('referer_fix1', &html_escape($http_host)),"<p>\n";
3763 print &text('referer_fix2', &html_escape($http_host)),"<p>\n";
3766 # No referer info given
3767 print &text('referer_warn_unknown', $url),"<p>\n";
3768 print &text('referer_fix1u'),"<p>\n";
3769 print &text('referer_fix2u'),"<p>\n";
3773 &footer("/", $text{'index'});
3776 $main::no_referers_check++;
3777 $main::completed_referers_check++;
3779 # Call theme post-init
3780 if (defined(&theme_post_init_config)) {
3781 &theme_post_init_config(@_);
3784 # Record that we have done the calling library in this package
3785 my ($callpkg, $lib) = caller();
3787 $main::done_foreign_require{$callpkg,$lib} = 1;
3789 # If a licence checking is enabled, do it now
3790 if ($gconfig{'licence_module'} && !$main::done_licence_module_check &&
3791 &foreign_check($gconfig{'licence_module'}) &&
3792 -r "$root_directory/$gconfig{'licence_module'}/licence_check.pl") {
3793 my $oldpwd = &get_current_dir();
3794 $main::done_licence_module_check++;
3795 $main::licence_module = $gconfig{'licence_module'};
3796 &foreign_require($main::licence_module, "licence_check.pl");
3797 ($main::licence_status, $main::licence_message) =
3798 &foreign_call($main::licence_module, "check_licence");
3802 # Export global variables to caller
3803 if ($main::export_to_caller) {
3804 foreach my $v ('$config_file', '%gconfig', '$null_file',
3805 '$path_separator', '@root_directories',
3806 '$root_directory', '$module_name',
3807 '$base_remote_user', '$remote_user',
3808 '$module_config_directory', '$module_config_file',
3809 '%config', '@current_themes', '$current_theme',
3810 '@theme_root_directories', '$theme_root_directory',
3811 '%tconfig','@theme_configs', '$tb', '$cb', '$scriptname',
3812 '$webmin_logfile', '$current_lang',
3813 '$current_lang_info', '@lang_order_list', '%text',
3814 '%module_info', '$module_root_directory') {
3815 my ($vt, $vn) = split('', $v, 2);
3816 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
3823 =head2 load_language([module], [directory])
3825 Returns a hashtable mapping text codes to strings in the appropriate language,
3826 based on the $current_lang global variable, which is in turn set based on
3827 the Webmin user's selection. The optional module parameter tells the function
3828 which module to load strings for, and defaults to the calling module. The
3829 optional directory parameter can be used to load strings from a directory
3832 In regular module development you will never need to call this function
3833 directly, as init_config calls it for you, and places the module's strings
3834 into the %text hash.
3840 my $root = $root_directory;
3841 my $ol = $gconfig{'overlang'};
3842 my ($dir) = ($_[1] || "lang");
3844 # Read global lang files
3845 foreach my $o (@lang_order_list) {
3846 my $ok = &read_file_cached("$root/$dir/$o", \%text);
3847 return () if (!$ok && $o eq $default_lang);
3850 foreach my $o (@lang_order_list) {
3851 &read_file_cached("$root/$ol/$o", \%text);
3854 &read_file_cached("$config_directory/custom-lang", \%text);
3857 # Read module's lang files
3858 my $mdir = &module_root_directory($_[0]);
3859 foreach my $o (@lang_order_list) {
3860 &read_file_cached("$mdir/$dir/$o", \%text);
3863 foreach $o (@lang_order_list) {
3864 &read_file_cached("$mdir/$ol/$o", \%text);
3867 &read_file_cached("$config_directory/$_[0]/custom-lang", \%text);
3869 foreach $k (keys %text) {
3870 $text{$k} =~ s/\$(\{([^\}]+)\}|([A-Za-z0-9\.\-\_]+))/text_subs($2 || $3,\%text)/ge;
3873 if (defined(&theme_load_language)) {
3874 &theme_load_language(\%text, $_[0]);
3879 =head2 text_subs(string)
3881 Used internally by load_language to expand $code substitutions in language
3887 if (substr($_[0], 0, 8) eq "include:") {
3890 open(INCLUDE, substr($_[0], 8));
3898 my $t = $_[1]->{$_[0]};
3899 return defined($t) ? $t : '$'.$_[0];
3903 =head2 text(message, [substitute]+)
3905 Returns a translated message from %text, but with $1, $2, etc.. replaced with
3906 the substitute parameters. This makes it easy to use strings with placeholders
3907 that get replaced with programmatically generated text. For example :
3909 print &text('index_hello', $remote_user),"<p>\n";
3914 my $t = &get_module_variable('%text', 1);
3915 my $rv = exists($t->{$_[0]}) ? $t->{$_[0]} : $text{$_[0]};
3916 for(my $i=1; $i<@_; $i++) {
3917 $rv =~ s/\$$i/$_[$i]/g;
3922 =head2 encode_base64(string)
3924 Encodes a string into base64 format, for use in MIME email or HTTP
3925 authorization headers.
3931 pos($_[0]) = 0; # ensure start at the beginning
3932 while ($_[0] =~ /(.{1,57})/gs) {
3933 $res .= substr(pack('u57', $1), 1)."\n";
3936 $res =~ tr|\` -_|AA-Za-z0-9+/|;
3937 my $padding = (3 - length($_[0]) % 3) % 3;
3938 $res =~ s/.{$padding}$/'=' x $padding/e if ($padding);
3942 =head2 decode_base64(string)
3944 Converts a base64-encoded string into plain text. The opposite of encode_base64.
3951 $str =~ tr|A-Za-z0-9+=/||cd; # remove non-base64 chars
3952 if (length($str) % 4) {
3955 $str =~ s/=+$//; # remove padding
3956 $str =~ tr|A-Za-z0-9+/| -_|; # convert to uuencoded format
3957 while ($str =~ /(.{1,60})/gs) {
3958 my $len = chr(32 + length($1)*3/4); # compute length byte
3959 $res .= unpack("u", $len . $1 ); # uudecode
3964 =head2 get_module_info(module, [noclone], [forcache])
3966 Returns a hash containg details of the given module. Some useful keys are :
3968 =item dir - The module directory, like sendmail.
3970 =item desc - Human-readable description, in the current users' language.
3972 =item version - Optional module version number.
3974 =item os_support - List of supported operating systems and versions.
3976 =item category - Category on Webmin's left menu, like net.
3981 return () if ($_[0] =~ /^\./);
3982 my (%rv, $clone, $o);
3983 my $mdir = &module_root_directory($_[0]);
3984 &read_file_cached("$mdir/module.info", \%rv) || return ();
3986 foreach $o (@lang_order_list) {
3987 $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
3988 $rv{"longdesc"} = $rv{"longdesc_$o"} if ($rv{"longdesc_$o"});
3990 if ($clone && !$_[1] && $config_directory) {
3991 $rv{'clone'} = $rv{'desc'};
3992 &read_file("$config_directory/$_[0]/clone", \%rv);
3995 my %module_categories;
3996 &read_file_cached("$config_directory/webmin.cats", \%module_categories);
3997 my $pn = &get_product_name();
3998 if (defined($rv{'category_'.$pn})) {
3999 # Can override category for webmin/usermin
4000 $rv{'category'} = $rv{'category_'.$pn};
4002 $rv{'realcategory'} = $rv{'category'};
4003 $rv{'category'} = $module_categories{$_[0]}
4004 if (defined($module_categories{$_[0]}));
4006 # Apply description overrides
4007 $rv{'realdesc'} = $rv{'desc'};
4009 &read_file_cached("$config_directory/webmin.descs", \%descs);
4010 if ($descs{$_[0]." ".$current_lang}) {
4011 $rv{'desc'} = $descs{$_[0]." ".$current_lang};
4013 elsif ($descs{$_[0]}) {
4014 $rv{'desc'} = $descs{$_[0]};
4018 # Apply per-user description overridde
4019 my %gaccess = &get_module_acl(undef, "");
4020 if ($gaccess{'desc_'.$_[0]}) {
4021 $rv{'desc'} = $gaccess{'desc_'.$_[0]};
4025 if ($rv{'longdesc'}) {
4026 # All standard modules have an index.cgi
4027 $rv{'index_link'} = 'index.cgi';
4030 # Call theme-specific override function
4031 if (defined(&theme_get_module_info)) {
4032 %rv = &theme_get_module_info(\%rv, $_[0], $_[1], $_[2]);
4038 =head2 get_all_module_infos(cachemode)
4040 Returns a list contains the information on all modules in this webmin
4041 install, including clones. Uses caching to reduce the number of module.info
4042 files that need to be read. Each element of the array is a hash reference
4043 in the same format as returned by get_module_info. The cache mode flag can be :
4044 0 = read and write, 1 = don't read or write, 2 = read only
4047 sub get_all_module_infos
4051 # Is the cache out of date? (ie. have any of the root's changed?)
4052 my $cache_file = "$config_directory/module.infos.cache";
4054 if (&read_file_cached($cache_file, \%cache)) {
4055 foreach my $r (@root_directories) {
4057 if ($st[9] != $cache{'mtime_'.$r}) {
4067 if ($_[0] != 1 && !$changed && $cache{'lang'} eq $current_lang) {
4068 # Can use existing module.info cache
4070 foreach my $k (keys %cache) {
4071 if ($k =~ /^(\S+) (\S+)$/) {
4072 $mods{$1}->{$2} = $cache{$k};
4075 @rv = map { $mods{$_} } (keys %mods) if (%mods);
4078 # Need to rebuild cache
4080 foreach my $r (@root_directories) {
4082 foreach my $m (readdir(DIR)) {
4083 next if ($m =~ /^(config-|\.)/ || $m =~ /\.(cgi|pl)$/);
4084 my %minfo = &get_module_info($m, 0, 1);
4085 next if (!%minfo || !$minfo{'dir'});
4087 foreach $k (keys %minfo) {
4088 $cache{"${m} ${k}"} = $minfo{$k};
4093 $cache{'mtime_'.$r} = $st[9];
4095 $cache{'lang'} = $current_lang;
4096 &write_file($cache_file, \%cache) if (!$_[0] && $< == 0 && $> == 0);
4099 # Override descriptions for modules for current user
4100 my %gaccess = &get_module_acl(undef, "");
4101 foreach my $m (@rv) {
4102 if ($gaccess{"desc_".$m->{'dir'}}) {
4103 $m->{'desc'} = $gaccess{"desc_".$m->{'dir'}};
4107 # Apply installed flags
4109 &read_file_cached("$config_directory/installed.cache", \%installed);
4110 foreach my $m (@rv) {
4111 $m->{'installed'} = $installed{$m->{'dir'}};
4117 =head2 get_theme_info(theme)
4119 Returns a hash containing a theme's details, taken from it's theme.info file.
4120 Some useful keys are :
4122 =item dir - The theme directory, like blue-theme.
4124 =item desc - Human-readable description, in the current users' language.
4126 =item version - Optional module version number.
4128 =item os_support - List of supported operating systems and versions.
4133 return () if ($_[0] =~ /^\./);
4135 my $tdir = &module_root_directory($_[0]);
4136 &read_file("$tdir/theme.info", \%rv) || return ();
4137 foreach my $o (@lang_order_list) {
4138 $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4144 =head2 list_languages
4146 Returns an array of supported languages, taken from Webmin's os_list.txt file.
4147 Each is a hash reference with the following keys :
4149 =item lang - The short language code, like es for Spanish.
4151 =item desc - A human-readable description, in English.
4153 =item charset - An optional character set to use when displaying the language.
4155 =item titles - Set to 1 only if Webmin has title images for the language.
4157 =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.
4162 if (!@main::list_languages_cache) {
4165 open(LANG, "$root_directory/lang_list.txt");
4167 if (/^(\S+)\s+(.*)/) {
4168 my $l = { 'desc' => $2 };
4169 foreach $o (split(/,/, $1)) {
4170 if ($o =~ /^([^=]+)=(.*)$/) {
4174 $l->{'index'} = scalar(@rv);
4175 push(@main::list_languages_cache, $l);
4179 @main::list_languages_cache = sort { $a->{'desc'} cmp $b->{'desc'} }
4180 @main::list_languages_cache;
4182 return @main::list_languages_cache;
4185 =head2 read_env_file(file, &hash)
4187 Similar to Webmin's read_file function, but handles files containing shell
4188 environment variables formatted like :
4193 The file parameter is the full path to the file to read, and hash a Perl hash
4194 ref to read names and values into.
4200 &open_readfile(FILE, $_[0]) || return 0;
4203 if (/^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*"(.*)"/i ||
4204 /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*'(.*)'/i ||
4205 /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*(.*)/i) {
4213 =head2 write_env_file(file, &hash, [export])
4215 Writes out a hash to a file in name='value' format, suitable for use in a shell
4216 script. The parameters are :
4218 =item file - Full path for a file to write to
4220 =item hash - Hash reference of names and values to write.
4222 =item export - If set to 1, preceed each variable setting with the word 'export'.
4227 my $exp = $_[2] ? "export " : "";
4228 &open_tempfile(FILE, ">$_[0]");
4229 foreach my $k (keys %{$_[1]}) {
4230 my $v = $_[1]->{$k};
4231 if ($v =~ /^\S+$/) {
4232 &print_tempfile(FILE, "$exp$k=$v\n");
4235 &print_tempfile(FILE, "$exp$k=\"$v\"\n");
4238 &close_tempfile(FILE);
4241 =head2 lock_file(filename, [readonly], [forcefile])
4243 Lock a file for exclusive access. If the file is already locked, spin
4244 until it is freed. Uses a .lock file, which is not 100% reliable, but seems
4245 to work OK. The parameters are :
4247 =item filename - File or directory to lock.
4249 =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.
4251 =item forcefile - Force the file to be considered as a real file and not a symlink for Webmin actions logging purposes.
4256 my $realfile = &translate_filename($_[0]);
4257 return 0 if (!$_[0] || defined($main::locked_file_list{$realfile}));
4258 my $no_lock = !&can_lock_file($realfile);
4259 my $lock_tries_count = 0;
4262 if (!$no_lock && open(LOCKING, "$realfile.lock")) {
4267 if ($no_lock || !$pid || !kill(0, $pid) || $pid == $$) {
4270 # Create the .lock file
4271 open(LOCKING, ">$realfile.lock") || return 0;
4272 my $lck = eval "flock(LOCKING, 2+4)";
4274 # Lock of lock file failed! Wait till later
4277 print LOCKING $$,"\n";
4278 eval "flock(LOCKING, 8)";
4281 $main::locked_file_list{$realfile} = int($_[1]);
4282 push(@main::temporary_files, "$realfile.lock");
4283 if (($gconfig{'logfiles'} || $gconfig{'logfullfiles'}) &&
4284 !&get_module_variable('$no_log_file_changes') &&
4286 # Grab a copy of this file for later diffing
4288 $main::locked_file_data{$realfile} = undef;
4290 $main::locked_file_type{$realfile} = 1;
4291 $main::locked_file_data{$realfile} = '';
4293 elsif (!$_[2] && ($lnk = readlink($realfile))) {
4294 $main::locked_file_type{$realfile} = 2;
4295 $main::locked_file_data{$realfile} = $lnk;
4297 elsif (open(ORIGFILE, $realfile)) {
4298 $main::locked_file_type{$realfile} = 0;
4299 $main::locked_file_data{$realfile} = '';
4302 $main::locked_file_data{$realfile} .=$_;
4311 if ($lock_tries_count++ > 5*60) {
4312 # Give up after 5 minutes
4313 &error(&text('elock_tries', "<tt>$realfile</tt>", 5));
4319 =head2 unlock_file(filename)
4321 Release a lock on a file taken out by lock_file. If Webmin actions logging of
4322 file changes is enabled, then at unlock file a diff will be taken between the
4323 old and new contents, and stored under /var/webmin/diffs when webmin_log is
4324 called. This can then be viewed in the Webmin Actions Log module.
4329 my $realfile = &translate_filename($_[0]);
4330 return if (!$_[0] || !defined($main::locked_file_list{$realfile}));
4331 unlink("$realfile.lock") if (&can_lock_file($realfile));
4332 delete($main::locked_file_list{$realfile});
4333 if (exists($main::locked_file_data{$realfile})) {
4334 # Diff the new file with the old
4336 my $lnk = readlink($realfile);
4337 my $type = -d _ ? 1 : $lnk ? 2 : 0;
4338 my $oldtype = $main::locked_file_type{$realfile};
4339 my $new = !defined($main::locked_file_data{$realfile});
4340 if ($new && !-e _) {
4341 # file doesn't exist, and never did! do nothing ..
4343 elsif ($new && $type == 1 || !$new && $oldtype == 1) {
4344 # is (or was) a directory ..
4345 if (-d _ && !defined($main::locked_file_data{$realfile})) {
4346 push(@main::locked_file_diff,
4347 { 'type' => 'mkdir', 'object' => $realfile });
4349 elsif (!-d _ && defined($main::locked_file_data{$realfile})) {
4350 push(@main::locked_file_diff,
4351 { 'type' => 'rmdir', 'object' => $realfile });
4354 elsif ($new && $type == 2 || !$new && $oldtype == 2) {
4355 # is (or was) a symlink ..
4356 if ($lnk && !defined($main::locked_file_data{$realfile})) {
4357 push(@main::locked_file_diff,
4358 { 'type' => 'symlink', 'object' => $realfile,
4361 elsif (!$lnk && defined($main::locked_file_data{$realfile})) {
4362 push(@main::locked_file_diff,
4363 { 'type' => 'unsymlink', 'object' => $realfile,
4364 'data' => $main::locked_file_data{$realfile} });
4366 elsif ($lnk ne $main::locked_file_data{$realfile}) {
4367 push(@main::locked_file_diff,
4368 { 'type' => 'resymlink', 'object' => $realfile,
4373 # is a file, or has changed type?!
4374 my ($diff, $delete_file);
4375 my $type = "modify";
4377 open(NEWFILE, ">$realfile");
4382 if (!defined($main::locked_file_data{$realfile})) {
4385 open(ORIGFILE, ">$realfile.webminorig");
4386 print ORIGFILE $main::locked_file_data{$realfile};
4388 $diff = &backquote_command(
4389 "diff ".quotemeta("$realfile.webminorig")." ".
4390 quotemeta($realfile)." 2>/dev/null");
4391 push(@main::locked_file_diff,
4392 { 'type' => $type, 'object' => $realfile,
4393 'data' => $diff } ) if ($diff);
4394 unlink("$realfile.webminorig");
4395 unlink($realfile) if ($delete_file);
4398 if ($gconfig{'logfullfiles'}) {
4399 # Add file details to list of those to fully log
4400 $main::orig_file_data{$realfile} ||=
4401 $main::locked_file_data{$realfile};
4402 $main::orig_file_type{$realfile} ||=
4403 $main::locked_file_type{$realfile};
4406 delete($main::locked_file_data{$realfile});
4407 delete($main::locked_file_type{$realfile});
4411 =head2 test_lock(file)
4413 Returns 1 if some file is currently locked, 0 if not.
4418 my $realfile = &translate_filename($_[0]);
4419 return 0 if (!$_[0]);
4420 return 1 if (defined($main::locked_file_list{$realfile}));
4421 return 0 if (!&can_lock_file($realfile));
4423 if (open(LOCKING, "$realfile.lock")) {
4428 return $pid && kill(0, $pid);
4431 =head2 unlock_all_files
4433 Unlocks all files locked by the current script.
4436 sub unlock_all_files
4438 foreach $f (keys %main::locked_file_list) {
4443 =head2 can_lock_file(file)
4445 Returns 1 if some file should be locked, based on the settings in the
4446 Webmin Configuration module. For internal use by lock_file only.
4451 if (&is_readonly_mode()) {
4452 return 0; # never lock in read-only mode
4454 elsif ($gconfig{'lockmode'} == 0) {
4457 elsif ($gconfig{'lockmode'} == 1) {
4461 # Check if under any of the directories
4463 foreach my $d (split(/\t+/, $gconfig{'lockdirs'})) {
4464 if (&same_file($d, $_[0]) ||
4465 &is_under_directory($d, $_[0])) {
4469 return $gconfig{'lockmode'} == 2 ? $match : !$match;
4473 =head2 webmin_log(action, type, object, ¶ms, [module], [host, script-on-host, client-ip])
4475 Log some action taken by a user. This is typically called at the end of a
4476 script, once all file changes are complete and all commands run. The
4479 =item action - A short code for the action being performed, like 'create'.
4481 =item type - A code for the type of object the action is performed to, like 'user'.
4483 =item object - A short name for the object, like 'joe' if the Unix user 'joe' was just created.
4485 =item params - A hash ref of additional information about the action.
4487 =item module - Name of the module in which the action was performed, which defaults to the current module.
4489 =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.
4491 =item script-on-host - Script name like create_user.cgi on the host the action was performed on.
4493 =item client-ip - IP address of the browser that performed the action.
4498 return if (!$gconfig{'log'} || &is_readonly_mode());
4499 my $m = $_[4] ? $_[4] : &get_module_name();
4501 if ($gconfig{'logclear'}) {
4502 # check if it is time to clear the log
4503 my @st = stat("$webmin_logfile.time");
4504 my $write_logtime = 0;
4506 if ($st[9]+$gconfig{'logtime'}*60*60 < time()) {
4507 # clear logfile and all diff files
4508 &unlink_file("$ENV{'WEBMIN_VAR'}/diffs");
4509 &unlink_file("$ENV{'WEBMIN_VAR'}/files");
4510 &unlink_file("$ENV{'WEBMIN_VAR'}/annotations");
4511 unlink($webmin_logfile);
4518 if ($write_logtime) {
4519 open(LOGTIME, ">$webmin_logfile.time");
4520 print LOGTIME time(),"\n";
4525 # If an action script directory is defined, call the appropriate scripts
4526 if ($gconfig{'action_script_dir'}) {
4527 my ($action, $type, $object) = ($_[0], $_[1], $_[2]);
4528 my ($basedir) = $gconfig{'action_script_dir'};
4530 for my $dir ($basedir/$type/$action, $basedir/$type, $basedir) {
4533 opendir(DIR, $dir) or die "Can't open $dir: $!";
4534 while (defined($file = readdir(DIR))) {
4535 next if ($file =~ /^\.\.?$/); # skip '.' and '..'
4536 if (-x "$dir/$file") {
4537 # Call a script notifying it of the action
4539 $ENV{'ACTION_MODULE'} = &get_module_name();
4540 $ENV{'ACTION_ACTION'} = $_[0];
4541 $ENV{'ACTION_TYPE'} = $_[1];
4542 $ENV{'ACTION_OBJECT'} = $_[2];
4543 $ENV{'ACTION_SCRIPT'} = $script_name;
4544 foreach my $p (keys %param) {
4545 $ENV{'ACTION_PARAM_'.uc($p)} = $param{$p};
4547 system("$dir/$file", @_,
4548 "<$null_file", ">$null_file", "2>&1");
4556 # should logging be done at all?
4557 return if ($gconfig{'logusers'} && &indexof($base_remote_user,
4558 split(/\s+/, $gconfig{'logusers'})) < 0);
4559 return if ($gconfig{'logmodules'} && &indexof($m,
4560 split(/\s+/, $gconfig{'logmodules'})) < 0);
4564 my @tm = localtime($now);
4565 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
4566 my $id = sprintf "%d.%d.%d", $now, $$, $main::action_id_count;
4567 $main::action_id_count++;
4568 my $line = sprintf "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s %s \"%s\" \"%s\" \"%s\"",
4569 $id, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
4570 $tm[2], $tm[1], $tm[0],
4571 $remote_user || '-',
4572 $main::session_id || '-',
4573 $_[7] || $ENV{'REMOTE_HOST'} || '-',
4574 $m, $_[5] ? "$_[5]:$_[6]" : $script_name,
4575 $_[0], $_[1] ne '' ? $_[1] : '-', $_[2] ne '' ? $_[2] : '-';
4577 foreach my $k (sort { $a cmp $b } keys %{$_[3]}) {
4578 my $v = $_[3]->{$k};
4584 elsif (ref($v) eq 'ARRAY') {
4588 $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
4589 $line .= " $k='$vv'";
4593 foreach $vv (split(/\0/, $v)) {
4595 $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
4596 $line .= " $k='$vv'";
4599 $param{$k} = join(" ", @pv);
4601 open(WEBMINLOG, ">>$webmin_logfile");
4602 print WEBMINLOG $line,"\n";
4604 if ($gconfig{'logperms'}) {
4605 chmod(oct($gconfig{'logperms'}), $webmin_logfile);
4608 chmod(0600, $webmin_logfile);
4611 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
4612 # Find and record the changes made to any locked files, or commands run
4614 mkdir("$ENV{'WEBMIN_VAR'}/diffs", 0700);
4615 foreach my $d (@main::locked_file_diff) {
4616 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$id", 0700);
4617 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i");
4618 print DIFFLOG "$d->{'type'} $d->{'object'}\n";
4619 print DIFFLOG $d->{'data'};
4621 if ($d->{'input'}) {
4622 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
4623 print DIFFLOG $d->{'input'};
4626 if ($gconfig{'logperms'}) {
4627 chmod(oct($gconfig{'logperms'}),
4628 "$ENV{'WEBMIN_VAR'}/diffs/$id/$i",
4629 "$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
4633 @main::locked_file_diff = undef;
4635 if ($gconfig{'logfullfiles'}) {
4636 # Save the original contents of any modified files
4638 mkdir("$ENV{'WEBMIN_VAR'}/files", 0700);
4639 foreach my $f (keys %main::orig_file_data) {
4640 mkdir("$ENV{'WEBMIN_VAR'}/files/$id", 0700);
4641 open(ORIGLOG, ">$ENV{'WEBMIN_VAR'}/files/$id/$i");
4642 if (!defined($main::orig_file_type{$f})) {
4643 print ORIGLOG -1," ",$f,"\n";
4646 print ORIGLOG $main::orig_file_type{$f}," ",$f,"\n";
4648 print ORIGLOG $main::orig_file_data{$f};
4650 if ($gconfig{'logperms'}) {
4651 chmod(oct($gconfig{'logperms'}),
4652 "$ENV{'WEBMIN_VAR'}/files/$id.$i");
4656 %main::orig_file_data = undef;
4657 %main::orig_file_type = undef;
4661 if ($gconfig{'logsyslog'}) {
4662 eval 'use Sys::Syslog qw(:DEFAULT setlogsock);
4663 openlog(&get_product_name(), "cons,pid,ndelay", "daemon");
4664 setlogsock("inet");';
4666 # Syslog module is installed .. try to convert to a
4667 # human-readable form
4669 my $mod = &get_module_name();
4670 my $mdir = module_root_directory($mod);
4671 if (-r "$mdir/log_parser.pl") {
4672 &foreign_require($mod, "log_parser.pl");
4674 foreach my $k (keys %{$_[3]}) {
4675 my $v = $_[3]->{$k};
4676 if (ref($v) eq 'ARRAY') {
4677 $params{$k} = join("\0", @$v);
4683 $msg = &foreign_call($mod, "parse_webmin_log",
4684 $remote_user, $script_name,
4685 $_[0], $_[1], $_[2], \%params);
4686 $msg =~ s/<[^>]*>//g; # Remove tags
4688 elsif ($_[0] eq "_config_") {
4689 my %wtext = &load_language("webminlog");
4690 $msg = $wtext{'search_config'};
4692 $msg ||= "$_[0] $_[1] $_[2]";
4693 my %info = &get_module_info($m);
4694 eval { syslog("info", "%s", "[$info{'desc'}] $msg"); };
4699 =head2 additional_log(type, object, data, [input])
4701 Records additional log data for an upcoming call to webmin_log, such
4702 as a command that was run or SQL that was executed. Typically you will never
4703 need to call this function directory.
4708 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
4709 push(@main::locked_file_diff,
4710 { 'type' => $_[0], 'object' => $_[1], 'data' => $_[2],
4711 'input' => $_[3] } );
4715 =head2 webmin_debug_log(type, message)
4717 Write something to the Webmin debug log. For internal use only.
4720 sub webmin_debug_log
4722 my ($type, $msg) = @_;
4723 return 0 if (!$main::opened_debug_log);
4724 return 0 if ($gconfig{'debug_no'.$main::webmin_script_type});
4726 my @tm = localtime($now);
4728 "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s \"%s\"",
4729 $$, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
4730 $tm[2], $tm[1], $tm[0],
4731 $remote_user || "-",
4732 $ENV{'REMOTE_HOST'} || "-",
4733 &get_module_name() || "-",
4736 seek(main::DEBUGLOG, 0, 2);
4737 print main::DEBUGLOG $line."\n";
4741 =head2 system_logged(command)
4743 Just calls the Perl system() function, but also logs the command run.
4748 if (&is_readonly_mode()) {
4749 print STDERR "Vetoing command $_[0]\n";
4752 my @realcmd = ( &translate_command($_[0]), @_[1..$#_] );
4753 my $cmd = join(" ", @realcmd);
4755 if ($cmd =~ s/(\s*&\s*)$//) {
4758 while($cmd =~ s/(\d*)(<|>)((\/(tmp|dev)\S+)|&\d+)\s*$//) { }
4759 $cmd =~ s/^\((.*)\)\s*$/$1/;
4761 &additional_log('exec', undef, $cmd);
4762 return system(@realcmd);
4765 =head2 backquote_logged(command)
4767 Executes a command and returns the output (like `command`), but also logs it.
4770 sub backquote_logged
4772 if (&is_readonly_mode()) {
4774 print STDERR "Vetoing command $_[0]\n";
4777 my $realcmd = &translate_command($_[0]);
4780 if ($cmd =~ s/(\s*&\s*)$//) {
4783 while($cmd =~ s/(\d*)(<|>)((\/(tmp\/.webmin|dev)\S+)|&\d+)\s*$//) { }
4784 $cmd =~ s/^\((.*)\)\s*$/$1/;
4786 &additional_log('exec', undef, $cmd);
4787 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
4791 =head2 backquote_with_timeout(command, timeout, safe?, [maxlines])
4793 Runs some command, waiting at most the given number of seconds for it to
4794 complete, and returns the output. The maxlines parameter sets the number
4795 of lines of output to capture. The safe parameter should be set to 1 if the
4796 command is safe for read-only mode users to run.
4799 sub backquote_with_timeout
4801 my $realcmd = &translate_command($_[0]);
4802 &webmin_debug_log('CMD', "cmd=$realcmd timeout=$_[1]")
4803 if ($gconfig{'debug_what_cmd'});
4805 my $pid = &open_execute_command(OUT, "($realcmd) <$null_file", 1, $_[2]);
4810 my $elapsed = time() - $start;
4811 last if ($elapsed > $_[1]);
4813 vec($rmask, fileno(OUT), 1) = 1;
4814 my $sel = select($rmask, undef, undef, $_[1] - $elapsed);
4815 last if (!$sel || $sel < 0);
4817 last if (!defined($line));
4820 if ($_[3] && $linecount >= $_[3]) {
4825 if (kill('TERM', $pid) && time() - $start >= $_[1]) {
4829 return wantarray ? ($out, $timed_out) : $out;
4832 =head2 backquote_command(command, safe?)
4834 Executes a command and returns the output (like `command`), subject to
4835 command translation. The safe parameter should be set to 1 if the command
4836 is safe for read-only mode users to run.
4839 sub backquote_command
4841 if (&is_readonly_mode() && !$_[1]) {
4842 print STDERR "Vetoing command $_[0]\n";
4846 my $realcmd = &translate_command($_[0]);
4847 &webmin_debug_log('CMD', "cmd=$realcmd") if ($gconfig{'debug_what_cmd'});
4851 =head2 kill_logged(signal, pid, ...)
4853 Like Perl's built-in kill function, but also logs the fact that some process
4854 was killed. On Windows, falls back to calling process.exe to terminate a
4860 return scalar(@_)-1 if (&is_readonly_mode());
4861 &webmin_debug_log('KILL', "signal=$_[0] pids=".join(" ", @_[1..@_-1]))
4862 if ($gconfig{'debug_what_procs'});
4863 &additional_log('kill', $_[0], join(" ", @_[1..@_-1])) if (@_ > 1);
4864 if ($gconfig{'os_type'} eq 'windows') {
4865 # Emulate some kills with process.exe
4866 my $arg = $_[0] eq "KILL" ? "-k" :
4867 $_[0] eq "TERM" ? "-q" :
4868 $_[0] eq "STOP" ? "-s" :
4869 $_[0] eq "CONT" ? "-r" : undef;
4871 foreach my $p (@_[1..@_-1]) {
4873 $ok ||= kill($_[0], $p);
4876 &execute_command("process $arg $p");
4888 =head2 rename_logged(old, new)
4890 Re-names a file and logs the rename. If the old and new files are on different
4891 filesystems, calls mv or the Windows rename function to do the job.
4896 &additional_log('rename', $_[0], $_[1]) if ($_[0] ne $_[1]);
4897 return &rename_file($_[0], $_[1]);
4900 =head2 rename_file(old, new)
4902 Renames a file or directory. If the old and new files are on different
4903 filesystems, calls mv or the Windows rename function to do the job.
4908 if (&is_readonly_mode()) {
4909 print STDERR "Vetoing rename from $_[0] to $_[1]\n";
4912 my $src = &translate_filename($_[0]);
4913 my $dst = &translate_filename($_[1]);
4914 &webmin_debug_log('RENAME', "src=$src dst=$dst")
4915 if ($gconfig{'debug_what_ops'});
4916 my $ok = rename($src, $dst);
4917 if (!$ok && $! !~ /permission/i) {
4918 # Try the mv command, in case this is a cross-filesystem rename
4919 if ($gconfig{'os_type'} eq 'windows') {
4920 # Need to use rename
4921 my $out = &backquote_command("rename ".quotemeta($_[0]).
4922 " ".quotemeta($_[1])." 2>&1");
4924 $! = $out if (!$ok);
4928 my $out = &backquote_command("mv ".quotemeta($_[0]).
4929 " ".quotemeta($_[1])." 2>&1");
4931 $! = $out if (!$ok);
4937 =head2 symlink_logged(src, dest)
4939 Create a symlink, and logs it. Effectively does the same thing as the Perl
4946 my $rv = &symlink_file($_[0], $_[1]);
4947 &unlock_file($_[1]);
4951 =head2 symlink_file(src, dest)
4953 Creates a soft link, unless in read-only mode. Effectively does the same thing
4954 as the Perl symlink function.
4959 if (&is_readonly_mode()) {
4960 print STDERR "Vetoing symlink from $_[0] to $_[1]\n";
4963 my $src = &translate_filename($_[0]);
4964 my $dst = &translate_filename($_[1]);
4965 &webmin_debug_log('SYMLINK', "src=$src dst=$dst")
4966 if ($gconfig{'debug_what_ops'});
4967 return symlink($src, $dst);
4970 =head2 link_file(src, dest)
4972 Creates a hard link, unless in read-only mode. The existing new link file
4973 will be deleted if necessary. Effectively the same as Perl's link function.
4978 if (&is_readonly_mode()) {
4979 print STDERR "Vetoing link from $_[0] to $_[1]\n";
4982 my $src = &translate_filename($_[0]);
4983 my $dst = &translate_filename($_[1]);
4984 &webmin_debug_log('LINK', "src=$src dst=$dst")
4985 if ($gconfig{'debug_what_ops'});
4986 unlink($dst); # make sure link works
4987 return link($src, $dst);
4990 =head2 make_dir(dir, perms, recursive)
4992 Creates a directory and sets permissions on it, unless in read-only mode.
4993 The perms parameter sets the octal permissions to apply, which unlike Perl's
4994 mkdir will really get set. The recursive flag can be set to 1 to have the
4995 function create parent directories too.
5000 my ($dir, $perms, $recur) = @_;
5001 if (&is_readonly_mode()) {
5002 print STDERR "Vetoing directory $dir\n";
5005 $dir = &translate_filename($dir);
5006 my $exists = -d $dir ? 1 : 0;
5007 return 1 if ($exists && $recur); # already exists
5008 &webmin_debug_log('MKDIR', $dir) if ($gconfig{'debug_what_ops'});
5009 my $rv = mkdir($dir, $perms);
5010 if (!$rv && $recur) {
5011 # Failed .. try mkdir -p
5012 my $param = $gconfig{'os_type'} eq 'windows' ? "" : "-p";
5013 my $ex = &execute_command("mkdir $param "."e_path($dir));
5019 chmod($perms, $dir);
5024 =head2 set_ownership_permissions(user, group, perms, file, ...)
5026 Sets the user, group owner and permissions on some files. The parameters are :
5028 =item user - UID or username to change the file owner to. If undef, then the owner is not changed.
5030 =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.
5032 =item perms - Octal permissions set to set on the file. If undef, they are left alone.
5034 =item file - One or more files or directories to modify.
5037 sub set_ownership_permissions
5039 my ($user, $group, $perms, @files) = @_;
5040 if (&is_readonly_mode()) {
5041 print STDERR "Vetoing permission changes on ",join(" ", @files),"\n";
5044 @files = map { &translate_filename($_) } @files;
5045 if ($gconfig{'debug_what_ops'}) {
5046 foreach my $f (@files) {
5047 &webmin_debug_log('PERMS',
5048 "file=$f user=$user group=$group perms=$perms");
5052 if (defined($user)) {
5053 my $uid = $user !~ /^\d+$/ ? getpwnam($user) : $user;
5055 if (defined($group)) {
5056 $gid = $group !~ /^\d+$/ ? getgrnam($group) : $group;
5059 my @uinfo = getpwuid($uid);
5062 $rv = chown($uid, $gid, @files);
5064 if ($rv && defined($perms)) {
5065 $rv = chmod($perms, @files);
5070 =head2 unlink_logged(file, ...)
5072 Like Perl's unlink function, but locks the files beforehand and un-locks them
5073 after so that the deletion is logged by Webmin.
5079 foreach my $f (@_) {
5080 if (!&test_lock($f)) {
5085 my @rv = &unlink_file(@_);
5086 foreach my $f (@_) {
5091 return wantarray ? @rv : $rv[0];
5094 =head2 unlink_file(file, ...)
5096 Deletes some files or directories. Like Perl's unlink function, but also
5097 recursively deletes directories with the rm command if needed.
5102 return 1 if (&is_readonly_mode());
5105 foreach my $f (@_) {
5106 my $realf = &translate_filename($f);
5107 &webmin_debug_log('UNLINK', $realf) if ($gconfig{'debug_what_ops'});
5109 if (!rmdir($realf)) {
5111 if ($gconfig{'os_type'} eq 'windows') {
5112 # Call del and rmdir commands
5115 my $out = `del /q "$qm" 2>&1`;
5117 $out = `rmdir "$qm" 2>&1`;
5122 my $qm = quotemeta($realf);
5123 $out = `rm -rf $qm 2>&1`;
5132 if (!unlink($realf)) {
5138 return wantarray ? ($rv, $err) : $rv;
5141 =head2 copy_source_dest(source, dest)
5143 Copy some file or directory to a new location. Returns 1 on success, or 0
5144 on failure - also sets $! on failure. If the source is a directory, uses
5145 piped tar commands to copy a whole directory structure including permissions
5149 sub copy_source_dest
5151 return (1, undef) if (&is_readonly_mode());
5152 my ($src, $dst) = @_;
5155 &webmin_debug_log('COPY', "src=$src dst=$dst")
5156 if ($gconfig{'debug_what_ops'});
5157 if ($gconfig{'os_type'} eq 'windows') {
5158 # No tar or cp on windows, so need to use copy command
5162 $out = &backquote_logged("xcopy \"$src\" \"$dst\" /Y /E /I 2>&1");
5165 $out = &backquote_logged("copy /Y \"$src\" \"$dst\" 2>&1");
5173 # A directory .. need to copy with tar command
5174 my @st = stat($src);
5177 &set_ownership_permissions($st[4], $st[5], $st[2], $dst);
5178 $out = &backquote_logged("(cd ".quotemeta($src)." ; tar cf - . | (cd ".quotemeta($dst)." ; tar xf -)) 2>&1");
5185 # Can just copy with cp
5186 my $out = &backquote_logged("cp -p ".quotemeta($src).
5187 " ".quotemeta($dst)." 2>&1");
5193 return wantarray ? ($ok, $err) : $ok;
5196 =head2 remote_session_name(host|&server)
5198 Generates a session ID for some server. For this server, this will always
5199 be an empty string. For a server object it will include the hostname and
5200 port and PID. For a server name, it will include the hostname and PID. For
5204 sub remote_session_name
5206 return ref($_[0]) && $_[0]->{'host'} && $_[0]->{'port'} ?
5207 "$_[0]->{'host'}:$_[0]->{'port'}.$$" :
5208 $_[0] eq "" || ref($_[0]) && $_[0]->{'id'} == 0 ? "" :
5209 ref($_[0]) ? "" : "$_[0].$$";
5212 =head2 remote_foreign_require(server, module, file)
5214 Connects to rpc.cgi on a remote webmin server and have it open a session
5215 to a process that will actually do the require and run functions. This is the
5216 equivalent for foreign_require, but for a remote Webmin system. The server
5217 parameter can either be a hostname of a system registered in the Webmin
5218 Servers Index module, or a hash reference for a system from that module.
5221 sub remote_foreign_require
5223 my $call = { 'action' => 'require',
5226 my $sn = &remote_session_name($_[0]);
5227 if ($remote_session{$sn}) {
5228 $call->{'session'} = $remote_session{$sn};
5231 $call->{'newsession'} = 1;
5233 my $rv = &remote_rpc_call($_[0], $call);
5234 if ($rv->{'session'}) {
5235 $remote_session{$sn} = $rv->{'session'};
5236 $remote_session_server{$sn} = $_[0];
5240 =head2 remote_foreign_call(server, module, function, [arg]*)
5242 Call a function on a remote server. Must have been setup first with
5243 remote_foreign_require for the same server and module. Equivalent to
5244 foreign_call, but with the extra server parameter to specify the remote
5248 sub remote_foreign_call
5250 return undef if (&is_readonly_mode());
5251 my $sn = &remote_session_name($_[0]);
5252 return &remote_rpc_call($_[0], { 'action' => 'call',
5255 'session' => $remote_session{$sn},
5256 'args' => [ @_[3 .. $#_] ] } );
5259 =head2 remote_foreign_check(server, module, [api-only])
5261 Checks if some module is installed and supported on a remote server. Equivilant
5262 to foreign_check, but for the remote Webmin system specified by the server
5266 sub remote_foreign_check
5268 return &remote_rpc_call($_[0], { 'action' => 'check',
5273 =head2 remote_foreign_config(server, module)
5275 Gets the configuration for some module from a remote server, as a hash.
5276 Equivalent to foreign_config, but for a remote system.
5279 sub remote_foreign_config
5281 return &remote_rpc_call($_[0], { 'action' => 'config',
5282 'module' => $_[1] });
5285 =head2 remote_eval(server, module, code)
5287 Evaluates some perl code in the context of a module on a remote webmin server.
5288 The server parameter must be the hostname of a remote system, module must
5289 be a module directory name, and code a string of Perl code to run. This can
5290 only be called after remote_foreign_require for the same server and module.
5295 return undef if (&is_readonly_mode());
5296 my $sn = &remote_session_name($_[0]);
5297 return &remote_rpc_call($_[0], { 'action' => 'eval',
5300 'session' => $remote_session{$sn} });
5303 =head2 remote_write(server, localfile, [remotefile], [remotebasename])
5305 Transfers some local file to another server via Webmin's RPC protocol, and
5306 returns the resulting remote filename. If the remotefile parameter is given,
5307 that is the destination filename which will be used. Otherwise a randomly
5308 selected temporary filename will be used, and returned by the function.
5313 return undef if (&is_readonly_mode());
5315 my $sn = &remote_session_name($_[0]);
5316 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
5317 # Copy data over TCP connection
5318 my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpwrite',
5320 'name' => $_[3] } );
5322 my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
5323 &open_socket($serv || "localhost", $rv->[1], TWRITE, \$error);
5324 return &$main::remote_error_handler("Failed to transfer file : $error")
5327 while(read(FILE, $got, 1024) > 0) {
5331 shutdown(TWRITE, 1);
5333 if ($error && $error !~ /^OK/) {
5334 # Got back an error!
5335 return &$main::remote_error_handler("Failed to transfer file : $error");
5341 # Just pass file contents as parameters
5343 while(read(FILE, $got, 1024) > 0) {
5347 return &remote_rpc_call($_[0], { 'action' => 'write',
5350 'session' => $remote_session{$sn} });
5354 =head2 remote_read(server, localfile, remotefile)
5356 Transfers a file from a remote server to this system, using Webmin's RPC
5357 protocol. The server parameter must be the hostname of a system registered
5358 in the Webmin Servers Index module, localfile is the destination path on this
5359 system, and remotefile is the file to fetch from the remote server.
5364 my $sn = &remote_session_name($_[0]);
5365 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
5366 # Copy data over TCP connection
5367 my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpread',
5368 'file' => $_[2] } );
5370 return &$main::remote_error_handler("Failed to transfer file : $rv->[1]");
5373 my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
5374 &open_socket($serv || "localhost", $rv->[1], TREAD, \$error);
5375 return &$main::remote_error_handler("Failed to transfer file : $error")
5378 open(FILE, ">$_[1]");
5379 while(read(TREAD, $got, 1024) > 0) {
5386 # Just get data as return value
5387 my $d = &remote_rpc_call($_[0], { 'action' => 'read',
5389 'session' => $remote_session{$sn} });
5390 open(FILE, ">$_[1]");
5396 =head2 remote_finished
5398 Close all remote sessions. This happens automatically after a while
5399 anyway, but this function should be called to clean things up faster.
5404 foreach my $sn (keys %remote_session) {
5405 my $server = $remote_session_server{$sn};
5406 &remote_rpc_call($server, { 'action' => 'quit',
5407 'session' => $remote_session{$sn} } );
5408 delete($remote_session{$sn});
5409 delete($remote_session_server{$sn});
5411 foreach $fh (keys %fast_fh_cache) {
5413 delete($fast_fh_cache{$fh});
5417 =head2 remote_error_setup(&function)
5419 Sets a function to be called instead of &error when a remote RPC operation
5420 fails. Useful if you want to have more control over your remote operations.
5423 sub remote_error_setup
5425 $main::remote_error_handler = $_[0] || \&error;
5428 =head2 remote_rpc_call(server, structure)
5430 Calls rpc.cgi on some server and passes it a perl structure (hash,array,etc)
5431 and then reads back a reply structure. This is mainly for internal use only,
5432 and is called by the other remote_* functions.
5438 my $sn = &remote_session_name($_[0]); # Will be undef for local connection
5440 # Server structure was given
5442 $serv->{'user'} || $serv->{'id'} == 0 ||
5443 return &$main::remote_error_handler(
5444 "No Webmin login set for server");
5447 # lookup the server in the webmin servers module if needed
5448 if (!defined(%main::remote_servers_cache)) {
5449 &foreign_require("servers", "servers-lib.pl");
5450 foreach $s (&foreign_call("servers", "list_servers")) {
5451 $main::remote_servers_cache{$s->{'host'}} = $s;
5452 $main::remote_servers_cache{$s->{'host'}.":".$s->{'port'}} = $s;
5455 $serv = $main::remote_servers_cache{$_[0]};
5456 $serv || return &$main::remote_error_handler(
5457 "No Webmin Servers entry for $_[0]");
5458 $serv->{'user'} || return &$main::remote_error_handler(
5459 "No login set for server $_[0]");
5462 # Work out the username and password
5464 if ($serv->{'sameuser'}) {
5465 $user = $remote_user;
5466 defined($main::remote_pass) || return &$main::remote_error_handler(
5467 "Password for this server is not available");
5468 $pass = $main::remote_pass;
5471 $user = $serv->{'user'};
5472 $pass = $serv->{'pass'};
5475 if ($serv->{'fast'} || !$sn) {
5476 # Make TCP connection call to fastrpc.cgi
5477 if (!$fast_fh_cache{$sn} && $sn) {
5478 # Need to open the connection
5479 my $con = &make_http_connection(
5480 $serv->{'host'}, $serv->{'port'}, $serv->{'ssl'},
5481 "POST", "/fastrpc.cgi");
5482 return &$main::remote_error_handler(
5483 "Failed to connect to $serv->{'host'} : $con")
5485 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
5486 &write_http_connection($con, "User-agent: Webmin\r\n");
5487 my $auth = &encode_base64("$user:$pass");
5489 &write_http_connection($con, "Authorization: basic $auth\r\n");
5490 &write_http_connection($con, "Content-length: ",
5491 length($tostr),"\r\n");
5492 &write_http_connection($con, "\r\n");
5493 &write_http_connection($con, $tostr);
5495 # read back the response
5496 my $line = &read_http_connection($con);
5497 $line =~ tr/\r\n//d;
5498 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
5499 return &$main::remote_error_handler("Login to RPC server as $user rejected");
5501 $line =~ /^HTTP\/1\..\s+200\s+/ ||
5502 return &$main::remote_error_handler("HTTP error : $line");
5504 $line = &read_http_connection($con);
5505 $line =~ tr/\r\n//d;
5507 $line = &read_http_connection($con);
5508 if ($line =~ /^0\s+(.*)/) {
5509 return &$main::remote_error_handler("RPC error : $1");
5511 elsif ($line =~ /^1\s+(\S+)\s+(\S+)\s+(\S+)/ ||
5512 $line =~ /^1\s+(\S+)\s+(\S+)/) {
5513 # Started ok .. connect and save SID
5514 &close_http_connection($con);
5515 my ($port, $sid, $version, $error) = ($1, $2, $3);
5516 &open_socket($serv->{'host'}, $port, $sid, \$error);
5517 return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error")
5519 $fast_fh_cache{$sn} = $sid;
5520 $remote_server_version{$sn} = $version;
5523 while($stuff = &read_http_connection($con)) {
5526 return &$main::remote_error_handler("Bad response from fastrpc.cgi : $line");
5529 elsif (!$fast_fh_cache{$sn}) {
5530 # Open the connection by running fastrpc.cgi locally
5531 pipe(RPCOUTr, RPCOUTw);
5535 open(STDOUT, ">&RPCOUTw");
5539 $ENV{'REQUEST_METHOD'} = 'GET';
5540 $ENV{'SCRIPT_NAME'} = '/fastrpc.cgi';
5541 $ENV{'SERVER_ROOT'} ||= $root_directory;
5543 if ($base_remote_user ne 'root' &&
5544 $base_remote_user ne 'admin') {
5545 # Need to fake up a login for the CGI!
5546 &read_acl(undef, \%acl);
5547 $ENV{'BASE_REMOTE_USER'} =
5548 $ENV{'REMOTE_USER'} =
5549 $acl{'root'} ? 'root' : 'admin';
5551 delete($ENV{'FOREIGN_MODULE_NAME'});
5552 delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
5553 chdir($root_directory);
5554 if (!exec("$root_directory/fastrpc.cgi")) {
5555 print "exec failed : $!\n";
5562 ($line = <RPCOUTr>) =~ tr/\r\n//d;
5566 if ($line =~ /^0\s+(.*)/) {
5567 return &$main::remote_error_handler("RPC error : $2");
5569 elsif ($line =~ /^1\s+(\S+)\s+(\S+)/) {
5570 # Started ok .. connect and save SID
5572 my ($port, $sid, $error) = ($1, $2, undef);
5573 &open_socket("localhost", $port, $sid, \$error);
5574 return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error") if ($error);
5575 $fast_fh_cache{$sn} = $sid;
5582 &error("Bad response from fastrpc.cgi : $line");
5585 # Got a connection .. send off the request
5586 my $fh = $fast_fh_cache{$sn};
5587 my $tostr = &serialise_variable($_[1]);
5588 print $fh length($tostr)," $fh\n";
5590 my $rlen = int(<$fh>);
5591 my ($fromstr, $got);
5592 while(length($fromstr) < $rlen) {
5593 return &$main::remote_error_handler("Failed to read from fastrpc.cgi")
5594 if (read($fh, $got, $rlen - length($fromstr)) <= 0);
5597 my $from = &unserialise_variable($fromstr);
5599 return &$main::remote_error_handler("Remote Webmin error");
5601 if (defined($from->{'arv'})) {
5602 return @{$from->{'arv'}};
5605 return $from->{'rv'};
5609 # Call rpc.cgi on remote server
5610 my $tostr = &serialise_variable($_[1]);
5612 my $con = &make_http_connection($serv->{'host'}, $serv->{'port'},
5613 $serv->{'ssl'}, "POST", "/rpc.cgi");
5614 return &$main::remote_error_handler("Failed to connect to $serv->{'host'} : $con") if (!ref($con));
5616 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
5617 &write_http_connection($con, "User-agent: Webmin\r\n");
5618 my $auth = &encode_base64("$user:$pass");
5620 &write_http_connection($con, "Authorization: basic $auth\r\n");
5621 &write_http_connection($con, "Content-length: ",length($tostr),"\r\n");
5622 &write_http_connection($con, "\r\n");
5623 &write_http_connection($con, $tostr);
5625 # read back the response
5626 my $line = &read_http_connection($con);
5627 $line =~ tr/\r\n//d;
5628 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
5629 return &$main::remote_error_handler("Login to RPC server as $user rejected");
5631 $line =~ /^HTTP\/1\..\s+200\s+/ || return &$main::remote_error_handler("RPC HTTP error : $line");
5633 $line = &read_http_connection($con);
5634 $line =~ tr/\r\n//d;
5637 while($line = &read_http_connection($con)) {
5641 my $from = &unserialise_variable($fromstr);
5642 return &$main::remote_error_handler("Invalid RPC login to $serv->{'host'}") if (!$from->{'status'});
5643 if (defined($from->{'arv'})) {
5644 return @{$from->{'arv'}};
5647 return $from->{'rv'};
5652 =head2 remote_multi_callback(&servers, parallel, &function, arg|&args, &returns, &errors, [module, library])
5654 Executes some function in parallel on multiple servers at once. Fills in
5655 the returns and errors arrays respectively. If the module and library
5656 parameters are given, that module is remotely required on the server first,
5657 to check if it is connectable. The parameters are :
5659 =item servers - A list of Webmin system hash references.
5661 =item parallel - Number of parallel operations to perform.
5663 =item function - Reference to function to call for each system.
5665 =item args - Additional parameters to the function.
5667 =item returns - Array ref to place return values into, in same order as servers.
5669 =item errors - Array ref to place error messages into.
5671 =item module - Optional module to require on the remote system first.
5673 =item library - Optional library to require in the module.
5676 sub remote_multi_callback
5678 my ($servs, $parallel, $func, $args, $rets, $errs, $mod, $lib) = @_;
5679 &remote_error_setup(\&remote_multi_callback_error);
5681 # Call the functions
5683 foreach my $g (@$servs) {
5689 $remote_multi_callback_err = undef;
5691 # Require the remote lib
5692 &remote_foreign_require($g->{'host'}, $mod, $lib);
5693 if ($remote_multi_callback_err) {
5694 # Failed .. return error
5695 print $wh &serialise_variable(
5696 [ undef, $remote_multi_callback_err ]);
5702 my $a = ref($args) ? $args->[$p] : $args;
5703 my $rv = &$func($g, $a);
5706 print $wh &serialise_variable(
5707 [ $rv, $remote_multi_callback_err ]);
5715 # Read back the results
5717 foreach my $g (@$servs) {
5721 $errs->[$p] = "Failed to read response from $g->{'host'}";
5724 my $rv = &unserialise_variable($line);
5726 $rets->[$p] = $rv->[0];
5727 $errs->[$p] = $rv->[1];
5732 &remote_error_setup(undef);
5735 sub remote_multi_callback_error
5737 $remote_multi_callback_err = $_[0];
5740 =head2 serialise_variable(variable)
5742 Converts some variable (maybe a scalar, hash ref, array ref or scalar ref)
5743 into a url-encoded string. In the cases of arrays and hashes, it is recursively
5744 called on each member to serialize the entire object.
5747 sub serialise_variable
5749 if (!defined($_[0])) {
5755 $rv = &urlize($_[0]);
5757 elsif ($r eq 'SCALAR') {
5758 $rv = &urlize(${$_[0]});
5760 elsif ($r eq 'ARRAY') {
5761 $rv = join(",", map { &urlize(&serialise_variable($_)) } @{$_[0]});
5763 elsif ($r eq 'HASH') {
5764 $rv = join(",", map { &urlize(&serialise_variable($_)).",".
5765 &urlize(&serialise_variable($_[0]->{$_})) }
5768 elsif ($r eq 'REF') {
5769 $rv = &serialise_variable(${$_[0]});
5771 elsif ($r eq 'CODE') {
5776 # An object - treat as a hash
5777 $r = "OBJECT ".&urlize($r);
5778 $rv = join(",", map { &urlize(&serialise_variable($_)).",".
5779 &urlize(&serialise_variable($_[0]->{$_})) }
5782 return ($r ? $r : 'VAL').",".$rv;
5785 =head2 unserialise_variable(string)
5787 Converts a string created by serialise_variable() back into the original
5788 scalar, hash ref, array ref or scalar ref. If the original variable was a Perl
5789 object, the same class is used on this system, if available.
5792 sub unserialise_variable
5794 my @v = split(/,/, $_[0]);
5796 if ($v[0] eq 'VAL') {
5797 @v = split(/,/, $_[0], -1);
5798 $rv = &un_urlize($v[1]);
5800 elsif ($v[0] eq 'SCALAR') {
5801 local $r = &un_urlize($v[1]);
5804 elsif ($v[0] eq 'ARRAY') {
5806 for(my $i=1; $i<@v; $i++) {
5807 push(@$rv, &unserialise_variable(&un_urlize($v[$i])));
5810 elsif ($v[0] eq 'HASH') {
5812 for(my $i=1; $i<@v; $i+=2) {
5813 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
5814 &unserialise_variable(&un_urlize($v[$i+1]));
5817 elsif ($v[0] eq 'REF') {
5818 local $r = &unserialise_variable($v[1]);
5821 elsif ($v[0] eq 'UNDEF') {
5824 elsif ($v[0] =~ /^OBJECT\s+(.*)$/) {
5825 # An object hash that we have to re-bless
5828 for(my $i=1; $i<@v; $i+=2) {
5829 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
5830 &unserialise_variable(&un_urlize($v[$i+1]));
5838 =head2 other_groups(user)
5840 Returns a list of secondary groups a user is a member of, as a list of
5849 while(my @g = getgrent()) {
5850 my @m = split(/\s+/, $g[3]);
5851 push(@rv, $g[2]) if (&indexof($user, @m) >= 0);
5853 endgrent() if ($gconfig{'os_type'} ne 'hpux');
5857 =head2 date_chooser_button(dayfield, monthfield, yearfield)
5859 Returns HTML for a button that pops up a data chooser window. The parameters
5862 =item dayfield - Name of the text field to place the day of the month into.
5864 =item monthfield - Name of the select field to select the month of the year in, indexed from 1.
5866 =item yearfield - Name of the text field to place the year into.
5869 sub date_chooser_button
5871 return &theme_date_chooser_button(@_)
5872 if (defined(&theme_date_chooser_button));
5873 my ($w, $h) = (250, 225);
5874 if ($gconfig{'db_sizedate'}) {
5875 ($w, $h) = split(/x/, $gconfig{'db_sizedate'});
5877 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";
5880 =head2 help_file(module, file)
5882 Returns the path to a module's help file of some name, typically under the
5883 help directory with a .html extension.
5888 my $mdir = &module_root_directory($_[0]);
5889 my $dir = "$mdir/help";
5890 foreach my $o (@lang_order_list) {
5891 my $lang = "$dir/$_[1].$current_lang.html";
5892 return $lang if (-r $lang);
5894 return "$dir/$_[1].html";
5899 Seeds the random number generator, if not already done in this script. On Linux
5900 this makes use of the current time, process ID and a read from /dev/urandom.
5901 On other systems, only the current time and process ID are used.
5906 if (!$main::done_seed_random) {
5907 if (open(RANDOM, "/dev/urandom")) {
5909 read(RANDOM, $buf, 4);
5911 srand(time() ^ $$ ^ $buf);
5916 $main::done_seed_random = 1;
5920 =head2 disk_usage_kb(directory)
5922 Returns the number of kB used by some directory and all subdirs. Implemented
5923 by calling the C<du -k> command.
5928 my $dir = &translate_filename($_[0]);
5930 my $ex = &execute_command("du -sk ".quotemeta($dir), undef, \$out, undef, 0, 1);
5932 &execute_command("du -s ".quotemeta($dir), undef, \$out, undef, 0, 1);
5934 return $out =~ /^([0-9]+)/ ? $1 : "???";
5937 =head2 recursive_disk_usage(directory)
5939 Returns the number of bytes taken up by all files in some directory and all
5940 sub-directories, by summing up their lengths. The disk_usage_kb is more
5941 reflective of reality, as the filesystem typically pads file sizes to 1k or
5945 sub recursive_disk_usage
5947 my $dir = &translate_filename($_[0]);
5952 my @st = stat($dir);
5958 my @files = readdir(DIR);
5960 foreach my $f (@files) {
5961 next if ($f eq "." || $f eq "..");
5962 $rv += &recursive_disk_usage("$dir/$f");
5968 =head2 help_search_link(term, [ section, ... ] )
5970 Returns HTML for a link to the man module for searching local and online
5971 docs for various search terms. The term parameter can either be a single
5972 word like 'bind', or a space-separated list of words. This function is typically
5973 used by modules that want to refer users to additional documentation in man
5974 pages or local system doc files.
5977 sub help_search_link
5979 if (&foreign_available("man") && !$tconfig{'nosearch'}) {
5980 my $for = &urlize(shift(@_));
5981 return "<a href='$gconfig{'webprefix'}/man/search.cgi?".
5982 join("&", map { "section=$_" } @_)."&".
5983 "for=$for&exact=1&check=".&get_module_name()."'>".
5984 $text{'helpsearch'}."</a>\n";
5991 =head2 make_http_connection(host, port, ssl, method, page, [&headers])
5993 Opens a connection to some HTTP server, maybe through a proxy, and returns
5994 a handle object. The handle can then be used to send additional headers
5995 and read back a response. If anything goes wrong, returns an error string.
5996 The parameters are :
5998 =item host - Hostname or IP address of the webserver to connect to.
6000 =item port - HTTP port number to connect to.
6002 =item ssl - Set to 1 to connect in SSL mode.
6004 =item method - HTTP method, like GET or POST.
6006 =item page - Page to request on the webserver, like /foo/index.html
6008 =item headers - Array ref of additional HTTP headers, each of which is a 2-element array ref.
6011 sub make_http_connection
6013 my ($host, $port, $ssl, $method, $page, $headers) = @_;
6016 foreach my $h (@$headers) {
6017 $htxt .= $h->[0].": ".$h->[1]."\r\n";
6021 if (&is_readonly_mode()) {
6022 return "HTTP connections not allowed in readonly mode";
6024 my $rv = { 'fh' => time().$$ };
6027 eval "use Net::SSLeay";
6028 $@ && return $text{'link_essl'};
6029 eval "Net::SSLeay::SSLeay_add_ssl_algorithms()";
6030 eval "Net::SSLeay::load_error_strings()";
6031 $rv->{'ssl_ctx'} = Net::SSLeay::CTX_new() ||
6032 return "Failed to create SSL context";
6033 $rv->{'ssl_con'} = Net::SSLeay::new($rv->{'ssl_ctx'}) ||
6034 return "Failed to create SSL connection";
6036 if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6037 !&no_proxy($host)) {
6040 &open_socket($1, $2, $rv->{'fh'}, \$error);
6043 my $fh = $rv->{'fh'};
6044 print $fh "CONNECT $host:$port HTTP/1.0\r\n";
6045 if ($gconfig{'proxy_user'}) {
6046 my $auth = &encode_base64(
6047 "$gconfig{'proxy_user'}:".
6048 "$gconfig{'proxy_pass'}");
6049 $auth =~ tr/\r\n//d;
6050 print $fh "Proxy-Authorization: Basic $auth\r\n";
6054 if ($line =~ /^HTTP(\S+)\s+(\d+)\s+(.*)/) {
6055 return "Proxy error : $3" if ($2 != 200);
6058 return "Proxy error : $line";
6063 elsif (!$gconfig{'proxy_fallback'}) {
6064 # Connection to proxy failed - give up
6071 &open_socket($host, $port, $rv->{'fh'}, \$error);
6072 return $error if ($error);
6074 Net::SSLeay::set_fd($rv->{'ssl_con'}, fileno($rv->{'fh'}));
6075 Net::SSLeay::connect($rv->{'ssl_con'}) ||
6076 return "SSL connect() failed";
6077 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6078 Net::SSLeay::write($rv->{'ssl_con'}, $rtxt);
6081 # Plain HTTP request
6083 if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6084 !&no_proxy($host)) {
6087 &open_socket($1, $2, $rv->{'fh'}, \$error);
6091 my $fh = $rv->{'fh'};
6092 my $rtxt = $method." ".
6093 "http://$host:$port$page HTTP/1.0\r\n";
6094 if ($gconfig{'proxy_user'}) {
6095 my $auth = &encode_base64(
6096 "$gconfig{'proxy_user'}:".
6097 "$gconfig{'proxy_pass'}");
6098 $auth =~ tr/\r\n//d;
6099 $rtxt .= "Proxy-Authorization: Basic $auth\r\n";
6104 elsif (!$gconfig{'proxy_fallback'}) {
6109 # Connecting directly
6111 &open_socket($host, $port, $rv->{'fh'}, \$error);
6112 return $error if ($error);
6113 my $fh = $rv->{'fh'};
6114 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6121 =head2 read_http_connection(&handle, [bytes])
6123 Reads either one line or up to the specified number of bytes from the handle,
6124 originally supplied by make_http_connection.
6127 sub read_http_connection
6131 if ($h->{'ssl_con'}) {
6134 while(($idx = index($h->{'buffer'}, "\n")) < 0) {
6135 # need to read more..
6136 if (!($more = Net::SSLeay::read($h->{'ssl_con'}))) {
6138 $rv = $h->{'buffer'};
6139 delete($h->{'buffer'});
6142 $h->{'buffer'} .= $more;
6144 $rv = substr($h->{'buffer'}, 0, $idx+1);
6145 $h->{'buffer'} = substr($h->{'buffer'}, $idx+1);
6148 if (length($h->{'buffer'})) {
6149 $rv = $h->{'buffer'};
6150 delete($h->{'buffer'});
6153 $rv = Net::SSLeay::read($h->{'ssl_con'}, $_[1]);
6159 read($h->{'fh'}, $rv, $_[1]) > 0 || return undef;
6162 my $fh = $h->{'fh'};
6166 $rv = undef if ($rv eq "");
6170 =head2 write_http_connection(&handle, [data+])
6172 Writes the given data to the given HTTP connection handle.
6175 sub write_http_connection
6178 my $fh = $h->{'fh'};
6180 if ($h->{'ssl_ctx'}) {
6181 foreach my $s (@_) {
6182 my $ok = Net::SSLeay::write($h->{'ssl_con'}, $s);
6183 $allok = 0 if (!$ok);
6187 my $ok = (print $fh @_);
6188 $allok = 0 if (!$ok);
6193 =head2 close_http_connection(&handle)
6195 Closes a connection to an HTTP server, identified by the given handle.
6198 sub close_http_connection
6204 =head2 clean_environment
6206 Deletes any environment variables inherited from miniserv so that they
6207 won't be passed to programs started by webmin. This is useful when calling
6208 programs that check for CGI-related environment variables and modify their
6209 behaviour, and to avoid passing sensitive variables to un-trusted programs.
6212 sub clean_environment
6214 %UNCLEAN_ENV = %ENV;
6215 foreach my $k (keys %ENV) {
6216 if ($k =~ /^(HTTP|VIRTUALSERVER|QUOTA|USERADMIN)_/) {
6220 foreach my $e ('WEBMIN_CONFIG', 'SERVER_NAME', 'CONTENT_TYPE', 'REQUEST_URI',
6221 'PATH_INFO', 'WEBMIN_VAR', 'REQUEST_METHOD', 'GATEWAY_INTERFACE',
6222 'QUERY_STRING', 'REMOTE_USER', 'SERVER_SOFTWARE', 'SERVER_PROTOCOL',
6223 'REMOTE_HOST', 'SERVER_PORT', 'DOCUMENT_ROOT', 'SERVER_ROOT',
6224 'MINISERV_CONFIG', 'SCRIPT_NAME', 'SERVER_ADMIN', 'CONTENT_LENGTH',
6225 'HTTPS', 'FOREIGN_MODULE_NAME', 'FOREIGN_ROOT_DIRECTORY',
6226 'SCRIPT_FILENAME', 'PATH_TRANSLATED', 'BASE_REMOTE_USER',
6227 'DOCUMENT_REALROOT', 'MINISERV_CONFIG', 'MYSQL_PWD') {
6232 =head2 reset_environment
6234 Puts the environment back how it was before clean_environment was callled.
6237 sub reset_environment
6239 if (defined(%UNCLEAN_ENV)) {
6240 foreach my $k (keys %UNCLEAN_ENV) {
6241 $ENV{$k} = $UNCLEAN_ENV{$k};
6243 undef(%UNCLEAN_ENV);
6247 =head2 progress_callback
6249 Never called directly, but useful for passing to &http_download to print
6250 out progress of an HTTP request.
6253 sub progress_callback
6255 if (defined(&theme_progress_callback)) {
6256 # Call the theme override
6257 return &theme_progress_callback(@_);
6261 print $progress_callback_prefix;
6263 $progress_size = $_[1];
6264 $progress_step = int($_[1] / 10);
6265 print &text('progress_size', $progress_callback_url,
6266 $progress_size),"<br>\n";
6269 print &text('progress_nosize', $progress_callback_url),"<br>\n";
6271 $last_progress_time = $last_progress_size = undef;
6273 elsif ($_[0] == 3) {
6275 my $sp = $progress_callback_prefix.(" " x 5);
6276 if ($progress_size) {
6277 # And we have a size to compare against
6278 my $st = int(($_[1] * 10) / $progress_size);
6279 my $time_now = time();
6280 if ($st != $progress_step ||
6281 $time_now - $last_progress_time > 60) {
6282 # Show progress every 10% or 60 seconds
6283 print $sp,&text('progress_data', $_[1], int($_[1]*100/$progress_size)),"<br>\n";
6284 $last_progress_time = $time_now;
6286 $progress_step = $st;
6289 # No total size .. so only show in 100k jumps
6290 if ($_[1] > $last_progress_size+100*1024) {
6291 print $sp,&text('progress_data2', $_[1]),"<br>\n";
6292 $last_progress_size = $_[1];
6296 elsif ($_[0] == 4) {
6297 # All done downloading
6298 print $progress_callback_prefix,&text('progress_done'),"<br>\n";
6300 elsif ($_[0] == 5) {
6301 # Got new location after redirect
6302 $progress_callback_url = $_[1];
6304 elsif ($_[0] == 6) {
6306 $progress_callback_url = $_[1];
6307 print &text('progress_incache', $progress_callback_url),"<br>\n";
6311 =head2 switch_to_remote_user
6313 Changes the user and group of the current process to that of the unix user
6314 with the same name as the current webmin login, or fails if there is none.
6315 This should be called by Usermin module scripts that only need to run with
6316 limited permissions.
6319 sub switch_to_remote_user
6321 @remote_user_info = $remote_user ? getpwnam($remote_user) :
6323 @remote_user_info || &error(&text('switch_remote_euser', $remote_user));
6324 &create_missing_homedir(\@remote_user_info);
6326 &switch_to_unix_user(\@remote_user_info);
6327 $ENV{'USER'} = $ENV{'LOGNAME'} = $remote_user;
6328 $ENV{'HOME'} = $remote_user_info[7];
6330 # Export global variables to caller
6331 if ($main::export_to_caller) {
6332 my ($callpkg) = caller();
6333 eval "\@${callpkg}::remote_user_info = \@remote_user_info";
6337 =head2 switch_to_unix_user(&user-details)
6339 Switches the current process to the UID and group ID from the given list
6340 of user details, which must be in the format returned by getpwnam.
6343 sub switch_to_unix_user
6346 if (!defined($uinfo->[0])) {
6347 # No username given, so just use given GID
6348 ($(, $)) = ( $uinfo->[3], "$uinfo->[3] $uinfo->[3]" );
6351 # Use all groups from user
6352 ($(, $)) = ( $uinfo->[3],
6353 "$uinfo->[3] ".join(" ", $uinfo->[3],
6354 &other_groups($uinfo->[0])) );
6357 POSIX::setuid($uinfo->[2]);
6359 if ($< != $uinfo->[2] || $> != $uinfo->[2]) {
6360 ($>, $<) = ( $uinfo->[2], $uinfo->[2] );
6364 =head2 eval_as_unix_user(username, &code)
6366 Runs some code fragment with the effective UID and GID switch to that
6367 of the given Unix user, so that file IO takes place with his permissions.
6371 sub eval_as_unix_user
6373 my ($user, $code) = @_;
6374 my @uinfo = getpwnam($user);
6375 if (!scalar(@uinfo)) {
6376 &error("eval_as_unix_user called with invalid user $user");
6378 $) = $uinfo[3]." ".join(" ", $uinfo[3], &other_groups($user));
6382 local $main::error_must_die = 1;
6389 $err =~ s/\s+at\s+(\/\S+)\s+line\s+(\d+)\.?//;
6392 return wantarray ? @rv : $rv[0];
6395 =head2 create_user_config_dirs
6397 Creates per-user config directories and sets $user_config_directory and
6398 $user_module_config_directory to them. Also reads per-user module configs
6399 into %userconfig. This should be called by Usermin module scripts that need
6400 to store per-user preferences or other settings.
6403 sub create_user_config_dirs
6405 return if (!$gconfig{'userconfig'});
6406 my @uinfo = @remote_user_info ? @remote_user_info : getpwnam($remote_user);
6407 return if (!@uinfo || !$uinfo[7]);
6408 &create_missing_homedir(\@uinfo);
6409 $user_config_directory = "$uinfo[7]/$gconfig{'userconfig'}";
6410 if (!-d $user_config_directory) {
6411 mkdir($user_config_directory, 0700) ||
6412 &error("Failed to create $user_config_directory : $!");
6413 if ($< == 0 && $uinfo[2]) {
6414 chown($uinfo[2], $uinfo[3], $user_config_directory);
6417 if (&get_module_name()) {
6418 $user_module_config_directory = $user_config_directory."/".
6420 if (!-d $user_module_config_directory) {
6421 mkdir($user_module_config_directory, 0700) ||
6422 &error("Failed to create $user_module_config_directory : $!");
6423 if ($< == 0 && $uinfo[2]) {
6424 chown($uinfo[2], $uinfo[3], $user_config_directory);
6428 &read_file_cached("$module_root_directory/defaultuconfig",
6430 &read_file_cached("$module_config_directory/uconfig", \%userconfig);
6431 &read_file_cached("$user_module_config_directory/config",
6435 # Export global variables to caller
6436 if ($main::export_to_caller) {
6437 my ($callpkg) = caller();
6438 foreach my $v ('$user_config_directory',
6439 '$user_module_config_directory', '%userconfig') {
6440 my ($vt, $vn) = split('', $v, 2);
6441 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
6446 =head2 create_missing_homedir(&uinfo)
6448 If auto homedir creation is enabled, create one for this user if needed.
6449 For internal use only.
6452 sub create_missing_homedir
6455 if (!-e $uinfo->[7] && $gconfig{'create_homedir'}) {
6456 # Use has no home dir .. make one
6457 system("mkdir -p ".quotemeta($uinfo->[7]));
6458 chown($uinfo->[2], $uinfo->[3], $uinfo->[7]);
6459 if ($gconfig{'create_homedir_perms'} ne '') {
6460 chmod(oct($gconfig{'create_homedir_perms'}), $uinfo->[7]);
6465 =head2 filter_javascript(text)
6467 Disables all javascript <script>, onClick= and so on tags in the given HTML,
6468 and returns the new HTML. Useful for displaying HTML from an un-trusted source.
6471 sub filter_javascript
6474 $rv =~ s/<\s*script[^>]*>([\000-\377]*?)<\s*\/script\s*>//gi;
6475 $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;
6476 $rv =~ s/(javascript:)/x$1/gi;
6477 $rv =~ s/(vbscript:)/x$1/gi;
6481 =head2 resolve_links(path)
6483 Given a path that may contain symbolic links, returns the real path.
6489 $path =~ s/\/+/\//g;
6490 $path =~ s/\/$// if ($path ne "/");
6491 my @p = split(/\/+/, $path);
6493 for(my $i=0; $i<@p; $i++) {
6494 my $sofar = "/".join("/", @p[0..$i]);
6495 my $lnk = readlink($sofar);
6496 if ($lnk eq $sofar) {
6497 # Link to itself! Cannot do anything more really ..
6500 elsif ($lnk =~ /^\//) {
6501 # Link is absolute..
6502 return &resolve_links($lnk."/".join("/", @p[$i+1 .. $#p]));
6506 return &resolve_links("/".join("/", @p[0..$i-1])."/".$lnk."/".join("/", @p[$i+1 .. $#p]));
6512 =head2 simplify_path(path, bogus)
6514 Given a path, maybe containing elements ".." and "." , convert it to a
6515 clean, absolute form. Returns undef if this is not possible.
6523 my @bits = split(/\/+/, $dir);
6526 foreach my $b (@bits) {
6530 elsif ($b eq "..") {
6532 if (scalar(@fixedbits) == 0) {
6533 # Cannot! Already at root!
6540 push(@fixedbits, $b);
6543 return "/".join('/', @fixedbits);
6546 =head2 same_file(file1, file2)
6548 Returns 1 if two files are actually the same
6553 return 1 if ($_[0] eq $_[1]);
6554 return 0 if ($_[0] !~ /^\// || $_[1] !~ /^\//);
6555 my @stat1 = $stat_cache{$_[0]} ? @{$stat_cache{$_[0]}}
6556 : (@{$stat_cache{$_[0]}} = stat($_[0]));
6557 my @stat2 = $stat_cache{$_[1]} ? @{$stat_cache{$_[1]}}
6558 : (@{$stat_cache{$_[1]}} = stat($_[1]));
6559 return 0 if (!@stat1 || !@stat2);
6560 return $stat1[0] == $stat2[0] && $stat1[1] == $stat2[1];
6563 =head2 flush_webmin_caches
6565 Clears all in-memory and on-disk caches used by Webmin.
6568 sub flush_webmin_caches
6570 undef(%main::read_file_cache);
6571 undef(%main::acl_hash_cache);
6572 undef(%main::acl_array_cache);
6573 undef(%main::has_command_cache);
6574 undef(@main::list_languages_cache);
6575 undef($main::got_list_usermods_cache);
6576 undef(@main::list_usermods_cache);
6577 undef(%main::foreign_installed_cache);
6578 unlink("$config_directory/module.infos.cache");
6579 &get_all_module_infos();
6582 =head2 list_usermods
6584 Returns a list of additional module restrictions. For internal use in
6590 if (!$main::got_list_usermods_cache) {
6591 @main::list_usermods_cache = ( );
6593 open(USERMODS, "$config_directory/usermin.mods");
6595 if (/^([^:]+):(\+|-|):(.*)/) {
6596 push(@main::list_usermods_cache,
6597 [ $1, $2, [ split(/\s+/, $3) ] ]);
6601 $main::got_list_usermods_cache = 1;
6603 return @main::list_usermods_cache;
6606 =head2 available_usermods(&allmods, &usermods)
6608 Returns a list of modules that are available to the given user, based
6609 on usermod additional/subtractions. For internal use by Usermin only.
6612 sub available_usermods
6614 return @{$_[0]} if (!@{$_[1]});
6616 my %mods = map { $_->{'dir'}, 1 } @{$_[0]};
6617 my @uinfo = @remote_user_info;
6618 @uinfo = getpwnam($remote_user) if (!@uinfo);
6619 foreach my $u (@{$_[1]}) {
6621 if ($u->[0] eq "*" || $u->[0] eq $remote_user) {
6624 elsif ($u->[0] =~ /^\@(.*)$/) {
6625 # Check for group membership
6626 my @ginfo = getgrnam($1);
6627 $applies++ if (@ginfo && ($ginfo[2] == $uinfo[3] ||
6628 &indexof($remote_user, split(/\s+/, $ginfo[3])) >= 0));
6630 elsif ($u->[0] =~ /^\//) {
6631 # Check users and groups in file
6633 open(USERFILE, $u->[0]);
6636 if ($_ eq $remote_user) {
6639 elsif (/^\@(.*)$/) {
6640 my @ginfo = getgrnam($1);
6642 if (@ginfo && ($ginfo[2] == $uinfo[3] ||
6643 &indexof($remote_user,
6644 split(/\s+/, $ginfo[3])) >= 0));
6651 if ($u->[1] eq "+") {
6652 map { $mods{$_}++ } @{$u->[2]};
6654 elsif ($u->[1] eq "-") {
6655 map { delete($mods{$_}) } @{$u->[2]};
6659 map { $mods{$_}++ } @{$u->[2]};
6663 return grep { $mods{$_->{'dir'}} } @{$_[0]};
6666 =head2 get_available_module_infos(nocache)
6668 Returns a list of modules available to the current user, based on
6669 operating system support, access control and usermod restrictions. Useful
6670 in themes that need to display a list of modules the user can use.
6671 Each element of the returned array is a hash reference in the same format as
6672 returned by get_module_info.
6675 sub get_available_module_infos
6678 &read_acl(\%acl, \%uacl);
6679 my $risk = $gconfig{'risk_'.$base_remote_user};
6681 foreach my $minfo (&get_all_module_infos($_[0])) {
6682 next if (!&check_os_support($minfo));
6684 # Check module risk level
6685 next if ($risk ne 'high' && $minfo->{'risk'} &&
6686 $minfo->{'risk'} !~ /$risk/);
6690 next if (!$acl{$base_remote_user,$minfo->{'dir'}} &&
6691 !$acl{$base_remote_user,"*"});
6693 next if (&is_readonly_mode() && !$minfo->{'readonly'});
6697 # Check usermod restrictions
6698 my @usermods = &list_usermods();
6699 @rv = sort { $a->{'desc'} cmp $b->{'desc'} }
6700 &available_usermods(\@rv, \@usermods);
6702 # Check RBAC restrictions
6704 foreach my $m (@rv) {
6705 if (&supports_rbac($m->{'dir'}) &&
6706 &use_rbac_module_acl(undef, $m->{'dir'})) {
6707 local $rbacs = &get_rbac_module_acl($remote_user,
6715 # Module or system doesn't support RBAC
6716 push(@rbacrv, $m) if (!$gconfig{'rbacdeny_'.$base_remote_user});
6722 if (defined(&theme_foreign_available)) {
6723 foreach my $m (@rbacrv) {
6724 if (&theme_foreign_available($m->{'dir'})) {
6733 # Check licence module vetos
6735 if ($main::licence_module) {
6736 foreach my $m (@themerv) {
6737 if (&foreign_call($main::licence_module,
6738 "check_module_licence", $m->{'dir'})) {
6750 =head2 get_visible_module_infos(nocache)
6752 Like get_available_module_infos, but excludes hidden modules from the list.
6753 Each element of the returned array is a hash reference in the same format as
6754 returned by get_module_info.
6757 sub get_visible_module_infos
6760 my $pn = &get_product_name();
6761 return grep { !$_->{'hidden'} &&
6762 !$_->{$pn.'_hidden'} } &get_available_module_infos($nocache);
6765 =head2 get_visible_modules_categories(nocache)
6767 Returns a list of Webmin module categories, each of which is a hash ref
6768 with 'code', 'desc' and 'modules' keys. The modules value is an array ref
6769 of modules in the category, in the format returned by get_module_info.
6770 Un-used modules are automatically assigned to the 'unused' category, and
6771 those with no category are put into 'others'.
6774 sub get_visible_modules_categories
6777 my @mods = &get_visible_module_infos($nocache);
6779 if (&get_product_name() eq 'webmin') {
6780 @unmods = grep { $_->{'installed'} eq '0' } @mods;
6781 @mods = grep { $_->{'installed'} ne '0' } @mods;
6783 my %cats = &list_categories(\@mods);
6785 foreach my $c (keys %cats) {
6786 my $cat = { 'code' => $c || 'other',
6787 'desc' => $cats{$c} };
6788 $cat->{'modules'} = [ grep { $_->{'category'} eq $c } @mods ];
6791 @rv = sort { ($b->{'code'} eq "others" ? "" : $b->{'code'}) cmp
6792 ($a->{'code'} eq "others" ? "" : $a->{'code'}) } @rv;
6794 # Add un-installed modules in magic category
6795 my $cat = { 'code' => 'unused',
6796 'desc' => $text{'main_unused'},
6798 'modules' => \@unmods };
6804 =head2 is_under_directory(directory, file)
6806 Returns 1 if the given file is under the specified directory, 0 if not.
6807 Symlinks are taken into account in the file to find it's 'real' location.
6810 sub is_under_directory
6812 my ($dir, $file) = @_;
6813 return 1 if ($dir eq "/");
6814 return 0 if ($file =~ /\.\./);
6815 my $ld = &resolve_links($dir);
6817 return &is_under_directory($ld, $file);
6819 my $lp = &resolve_links($file);
6821 return &is_under_directory($dir, $lp);
6823 return 0 if (length($file) < length($dir));
6824 return 1 if ($dir eq $file);
6826 return substr($file, 0, length($dir)) eq $dir;
6829 =head2 parse_http_url(url, [basehost, baseport, basepage, basessl])
6831 Given an absolute URL, returns the host, port, page and ssl flag components.
6832 Relative URLs can also be parsed, if the base information is provided.
6837 if ($_[0] =~ /^(http|https):\/\/([^:\/]+)(:(\d+))?(\/\S*)?$/) {
6839 my $ssl = $1 eq 'https';
6840 return ($2, $3 ? $4 : $ssl ? 443 : 80, $5 || "/", $ssl);
6846 elsif ($_[0] =~ /^\/\S*$/) {
6847 # A relative to the server URL
6848 return ($_[1], $_[2], $_[0], $_[4]);
6851 # A relative to the directory URL
6853 $page =~ s/[^\/]+$//;
6854 return ($_[1], $_[2], $page.$_[0], $_[4]);
6858 =head2 check_clicks_function
6860 Returns HTML for a JavaScript function called check_clicks that returns
6861 true when first called, but false subsequently. Useful on onClick for
6862 critical buttons. Deprecated, as this method of preventing duplicate actions
6866 sub check_clicks_function
6871 function check_clicks(form)
6878 for(i=0; i<form.length; i++)
6879 form.elements[i].disabled = true;
6888 =head2 load_entities_map
6890 Returns a hash ref containing mappings between HTML entities (like ouml) and
6891 ascii values (like 246). Mainly for internal use.
6894 sub load_entities_map
6896 if (!defined(%entities_map_cache)) {
6898 open(EMAP, "$root_directory/entities_map.txt");
6900 if (/^(\d+)\s+(\S+)/) {
6901 $entities_map_cache{$2} = $1;
6906 return \%entities_map_cache;
6909 =head2 entities_to_ascii(string)
6911 Given a string containing HTML entities like ö and 7, replace them
6912 with their ASCII equivalents.
6915 sub entities_to_ascii
6918 my $emap = &load_entities_map();
6919 $str =~ s/&([a-z]+);/chr($emap->{$1})/ge;
6920 $str =~ s/&#(\d+);/chr($1)/ge;
6924 =head2 get_product_name
6926 Returns either 'webmin' or 'usermin', depending on which program the current
6927 module is in. Useful for modules that can be installed into either.
6930 sub get_product_name
6932 return $gconfig{'product'} if (defined($gconfig{'product'}));
6933 return defined($gconfig{'userconfig'}) ? 'usermin' : 'webmin';
6938 Returns the character set for the current language, such as iso-8859-1.
6943 my $charset = defined($gconfig{'charset'}) ? $gconfig{'charset'} :
6944 $current_lang_info->{'charset'} ?
6945 $current_lang_info->{'charset'} : $default_charset;
6949 =head2 get_display_hostname
6951 Returns the system's hostname for UI display purposes. This may be different
6952 from the actual hostname if you administrator has configured it so in the
6953 Webmin Configuration module.
6956 sub get_display_hostname
6958 if ($gconfig{'hostnamemode'} == 0) {
6959 return &get_system_hostname();
6961 elsif ($gconfig{'hostnamemode'} == 3) {
6962 return $gconfig{'hostnamedisplay'};
6965 my $h = $ENV{'HTTP_HOST'};
6967 if ($gconfig{'hostnamemode'} == 2) {
6968 $h =~ s/^(www|ftp|mail)\.//i;
6974 =head2 save_module_config([&config], [modulename])
6976 Saves the configuration for some module. The config parameter is an optional
6977 hash reference of names and values to save, which defaults to the global
6978 %config hash. The modulename parameter is the module to update the config
6979 file, which defaults to the current module.
6982 sub save_module_config
6984 my $c = $_[0] || { &get_module_variable('%config') };
6985 my $m = defined($_[1]) ? $_[1] : &get_module_name();
6986 &write_file("$config_directory/$m/config", $c);
6989 =head2 save_user_module_config([&config], [modulename])
6991 Saves the user's Usermin preferences for some module. The config parameter is
6992 an optional hash reference of names and values to save, which defaults to the
6993 global %userconfig hash. The modulename parameter is the module to update the
6994 config file, which defaults to the current module.
6997 sub save_user_module_config
6999 my $c = $_[0] || { &get_module_variable('%userconfig') };
7000 my $m = $_[1] || &get_module_name();
7001 my $ucd = $user_config_directory;
7003 my @uinfo = @remote_user_info ? @remote_user_info
7004 : getpwnam($remote_user);
7005 return if (!@uinfo || !$uinfo[7]);
7006 $ucd = "$uinfo[7]/$gconfig{'userconfig'}";
7008 &write_file("$ucd/$m/config", $c);
7011 =head2 nice_size(bytes, [min])
7013 Converts a number of bytes into a number followed by a suffix like GB, MB
7014 or kB. Rounding is to two decimal digits. The optional min parameter sets the
7015 smallest units to use - so you could pass 1024*1024 to never show bytes or kB.
7020 my ($units, $uname);
7021 if (abs($_[0]) > 1024*1024*1024*1024 || $_[1] >= 1024*1024*1024*1024) {
7022 $units = 1024*1024*1024*1024;
7025 elsif (abs($_[0]) > 1024*1024*1024 || $_[1] >= 1024*1024*1024) {
7026 $units = 1024*1024*1024;
7029 elsif (abs($_[0]) > 1024*1024 || $_[1] >= 1024*1024) {
7033 elsif (abs($_[0]) > 1024 || $_[1] >= 1024) {
7041 my $sz = sprintf("%.2f", ($_[0]*1.0 / $units));
7043 return $sz." ".$uname;
7046 =head2 get_perl_path
7048 Returns the path to Perl currently in use, such as /usr/bin/perl.
7053 if (open(PERL, "$config_directory/perl-path")) {
7059 return $^X if (-x $^X);
7060 return &has_command("perl");
7063 =head2 get_goto_module([&mods])
7065 Returns the details of a module that the current user should be re-directed
7066 to after logging in, or undef if none. Useful for themes.
7071 my @mods = $_[0] ? @{$_[0]} : &get_visible_module_infos();
7072 if ($gconfig{'gotomodule'}) {
7073 my ($goto) = grep { $_->{'dir'} eq $gconfig{'gotomodule'} } @mods;
7074 return $goto if ($goto);
7076 if (@mods == 1 && $gconfig{'gotoone'}) {
7082 =head2 select_all_link(field, form, [text])
7084 Returns HTML for a 'Select all' link that uses Javascript to select
7085 multiple checkboxes with the same name. The parameters are :
7087 =item field - Name of the checkbox inputs.
7089 =item form - Index of the form on the page.
7091 =item text - Message for the link, defaulting to 'Select all'.
7096 return &theme_select_all_link(@_) if (defined(&theme_select_all_link));
7097 my ($field, $form, $text) = @_;
7099 $text ||= $text{'ui_selall'};
7100 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>";
7103 =head2 select_invert_link(field, form, text)
7105 Returns HTML for an 'Invert selection' link that uses Javascript to invert the
7106 selection on multiple checkboxes with the same name. The parameters are :
7108 =item field - Name of the checkbox inputs.
7110 =item form - Index of the form on the page.
7112 =item text - Message for the link, defaulting to 'Invert selection'.
7115 sub select_invert_link
7117 return &theme_select_invert_link(@_) if (defined(&theme_select_invert_link));
7118 my ($field, $form, $text) = @_;
7120 $text ||= $text{'ui_selinv'};
7121 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>";
7124 =head2 select_rows_link(field, form, text, &rows)
7126 Returns HTML for a link that uses Javascript to select rows with particular
7127 values for their checkboxes. The parameters are :
7129 =item field - Name of the checkbox inputs.
7131 =item form - Index of the form on the page.
7133 =item text - Message for the link, de
7135 =item rows - Reference to an array of 1 or 0 values, indicating which rows to check.
7138 sub select_rows_link
7140 return &theme_select_rows_link(@_) if (defined(&theme_select_rows_link));
7141 my ($field, $form, $text, $rows) = @_;
7143 my $js = "var sel = { ".join(",", map { "\""."e_escape($_)."\":1" } @$rows)." }; ";
7144 $js .= "for(var i=0; i<document.forms[$form].${field}.length; i++) { var r = document.forms[$form].${field}[i]; r.checked = sel[r.value]; } ";
7145 $js .= "return false;";
7146 return "<a href='#' onClick='$js'>$text</a>";
7149 =head2 check_pid_file(file)
7151 Given a pid file, returns the PID it contains if the process is running.
7156 open(PIDFILE, $_[0]) || return undef;
7157 my $pid = <PIDFILE>;
7159 $pid =~ /^\s*(\d+)/ || return undef;
7160 kill(0, $1) || return undef;
7166 Return the local os-specific library name to this module. For internal use only.
7171 my $mn = &get_module_name();
7172 my $md = &module_root_directory($mn);
7173 if (-r "$md/$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl") {
7174 return "$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl";
7176 elsif (-r "$md/$mn-$gconfig{'os_type'}-lib.pl") {
7177 return "$mn-$gconfig{'os_type'}-lib.pl";
7179 elsif (-r "$md/$mn-generic-lib.pl") {
7180 return "$mn-generic-lib.pl";
7187 =head2 module_root_directory(module)
7189 Given a module name, returns its root directory. On a typical Webmin install,
7190 all modules are under the same directory - but it is theoretically possible to
7194 sub module_root_directory
7196 my $d = ref($_[0]) ? $_[0]->{'dir'} : $_[0];
7197 if (@root_directories > 1) {
7198 foreach my $r (@root_directories) {
7204 return "$root_directories[0]/$d";
7207 =head2 list_mime_types
7209 Returns a list of all known MIME types and their extensions, as a list of hash
7210 references with keys :
7212 =item type - The MIME type, like text/plain.
7214 =item exts - A list of extensions, like .doc and .avi.
7216 =item desc - A human-readable description for the MIME type.
7221 if (!@list_mime_types_cache) {
7223 open(MIME, "$root_directory/mime.types");
7227 if (s/#\s*(.*)$//g) {
7230 my ($type, @exts) = split(/\s+/);
7232 push(@list_mime_types_cache, { 'type' => $type,
7239 return @list_mime_types_cache;
7242 =head2 guess_mime_type(filename, [default])
7244 Given a file name like xxx.gif or foo.html, returns a guessed MIME type.
7245 The optional default parameter sets a default type of use if none is found,
7246 which defaults to application/octet-stream.
7251 if ($_[0] =~ /\.([A-Za-z0-9\-]+)$/) {
7253 foreach my $t (&list_mime_types()) {
7254 foreach my $e (@{$t->{'exts'}}) {
7255 return $t->{'type'} if (lc($e) eq lc($ext));
7259 return @_ > 1 ? $_[1] : "application/octet-stream";
7262 =head2 open_tempfile([handle], file, [no-error], [no-tempfile], [safe?])
7264 Opens a file handle for writing to a temporary file, which will only be
7265 renamed over the real file when the handle is closed. This allows critical
7266 files like /etc/shadow to be updated safely, even if writing fails part way
7267 through due to lack of disk space. The parameters are :
7269 =item handle - File handle to open, as you would use in Perl's open function.
7271 =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.
7273 =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.
7275 =item no-tempfile - If set to 1, writing will be direct to the file instead of using a temporary file.
7277 =item safe - Indicates to users in read-only mode that this write is safe and non-destructive.
7283 # Just getting a temp file
7284 if (!defined($main::open_tempfiles{$_[0]})) {
7285 $_[0] =~ /^(.*)\/(.*)$/ || return $_[0];
7286 my $dir = $1 || "/";
7287 my $tmp = "$dir/$2.webmintmp.$$";
7288 $main::open_tempfiles{$_[0]} = $tmp;
7289 push(@main::temporary_files, $tmp);
7291 return $main::open_tempfiles{$_[0]};
7295 my ($fh, $file, $noerror, $notemp, $safe) = @_;
7296 $fh = &callers_package($fh);
7298 my %gaccess = &get_module_acl(undef, "");
7299 my $db = $gconfig{'debug_what_write'};
7300 if ($file =~ /\r|\n|\0/) {
7301 if ($noerror) { return 0; }
7302 else { &error("Filename contains invalid characters"); }
7304 if (&is_readonly_mode() && $file =~ />/ && !$safe) {
7305 # Read-only mode .. veto all writes
7306 print STDERR "vetoing write to $file\n";
7307 return open($fh, ">$null_file");
7309 elsif ($file =~ /^(>|>>|)nul$/i) {
7310 # Write to Windows null device
7311 &webmin_debug_log($1 eq ">" ? "WRITE" :
7312 $1 eq ">>" ? "APPEND" : "READ", "nul") if ($db);
7314 elsif ($file =~ /^(>|>>)(\/dev\/.*)/ || lc($file) eq "nul") {
7315 # Writes to /dev/null or TTYs don't need to be handled
7316 &webmin_debug_log($1 eq ">" ? "WRITE" : "APPEND", $2) if ($db);
7317 return open($fh, $file);
7319 elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && !$notemp) {
7320 &webmin_debug_log("WRITE", $1) if ($db);
7321 # Over-writing a file, via a temp file
7323 $file = &translate_filename($file);
7325 # Open the link target instead
7326 $file = &resolve_links($file);
7329 # Cannot open a directory!
7330 if ($noerror) { return 0; }
7331 else { &error("Cannot write to directory $file"); }
7333 my $tmp = &open_tempfile($file);
7334 my $ex = open($fh, ">$tmp");
7335 if (!$ex && $! =~ /permission/i) {
7336 # Could not open temp file .. try opening actual file
7338 $ex = open($fh, ">$file");
7339 delete($main::open_tempfiles{$file});
7342 $main::open_temphandles{$fh} = $file;
7345 if (!$ex && !$noerror) {
7346 &error(&text("efileopen", $file, $!));
7350 elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && $notemp) {
7351 # Just writing direct to a file
7352 &webmin_debug_log("WRITE", $1) if ($db);
7354 $file = &translate_filename($file);
7355 my @old_attributes = &get_clear_file_attributes($file);
7356 my $ex = open($fh, ">$file");
7357 &reset_file_attributes($file, \@old_attributes);
7358 $main::open_temphandles{$fh} = $file;
7359 if (!$ex && !$noerror) {
7360 &error(&text("efileopen", $file, $!));
7365 elsif ($file =~ /^>>\s*(([a-zA-Z]:)?\/.*)$/) {
7366 # Appending to a file .. nothing special to do
7367 &webmin_debug_log("APPEND", $1) if ($db);
7369 $file = &translate_filename($file);
7370 my @old_attributes = &get_clear_file_attributes($file);
7371 my $ex = open($fh, ">>$file");
7372 &reset_file_attributes($file, \@old_attributes);
7373 $main::open_temphandles{$fh} = $file;
7374 if (!$ex && !$noerror) {
7375 &error(&text("efileopen", $file, $!));
7380 elsif ($file =~ /^([a-zA-Z]:)?\//) {
7381 # Read mode .. nothing to do here
7382 &webmin_debug_log("READ", $file) if ($db);
7383 $file = &translate_filename($file);
7384 return open($fh, $file);
7386 elsif ($file eq ">" || $file eq ">>") {
7387 my ($package, $filename, $line) = caller;
7388 if ($noerror) { return 0; }
7389 else { &error("Missing file to open at ${package}::${filename} line $line"); }
7392 my ($package, $filename, $line) = caller;
7393 &error("Unsupported file or mode $file at ${package}::${filename} line $line");
7398 =head2 close_tempfile(file|handle)
7400 Copies a temp file to the actual file, assuming that all writes were
7401 successful. The handle must have been one passed to open_tempfile.
7407 my $fh = &callers_package($_[0]);
7409 if (defined($file = $main::open_temphandles{$fh})) {
7411 close($fh) || &error(&text("efileclose", $file, $!));
7412 delete($main::open_temphandles{$fh});
7413 return &close_tempfile($file);
7415 elsif (defined($main::open_tempfiles{$_[0]})) {
7417 &webmin_debug_log("CLOSE", $_[0]) if ($gconfig{'debug_what_write'});
7418 my @st = stat($_[0]);
7419 if (&is_selinux_enabled() && &has_command("chcon")) {
7420 # Set original security context
7421 system("chcon --reference=".quotemeta($_[0]).
7422 " ".quotemeta($main::open_tempfiles{$_[0]}).
7423 " >/dev/null 2>&1");
7425 my @old_attributes = &get_clear_file_attributes($_[0]);
7426 rename($main::open_tempfiles{$_[0]}, $_[0]) || &error("Failed to replace $_[0] with $main::open_tempfiles{$_[0]} : $!");
7428 # Set original permissions and ownership
7429 chmod($st[2], $_[0]);
7430 chown($st[4], $st[5], $_[0]);
7432 &reset_file_attributes($_[0], \@old_attributes);
7433 delete($main::open_tempfiles{$_[0]});
7434 @main::temporary_files = grep { $_ ne $main::open_tempfiles{$_[0]} } @main::temporary_files;
7435 if ($main::open_templocks{$_[0]}) {
7436 &unlock_file($_[0]);
7437 delete($main::open_templocks{$_[0]});
7442 # Must be closing a handle not associated with a file
7448 =head2 print_tempfile(handle, text, ...)
7450 Like the normal print function, but calls &error on failure. Useful when
7451 combined with open_tempfile, to ensure that a criticial file is never
7452 only partially written.
7457 my ($fh, @args) = @_;
7458 $fh = &callers_package($fh);
7459 (print $fh @args) || &error(&text("efilewrite",
7460 $main::open_temphandles{$fh} || $fh, $!));
7463 =head2 is_selinux_enabled
7465 Returns 1 if SElinux is supported on this system and enabled, 0 if not.
7468 sub is_selinux_enabled
7470 if (!defined($main::selinux_enabled_cache)) {
7472 if ($gconfig{'os_type'} !~ /-linux$/) {
7473 # Not on linux, so no way
7474 $main::selinux_enabled_cache = 0;
7476 elsif (&read_env_file("/etc/selinux/config", \%seconfig)) {
7477 # Use global config file
7478 $main::selinux_enabled_cache =
7479 $seconfig{'SELINUX'} eq 'disabled' ||
7480 !$seconfig{'SELINUX'} ? 0 : 1;
7483 # Use selinuxenabled command
7484 #$selinux_enabled_cache =
7485 # system("selinuxenabled >/dev/null 2>&1") ? 0 : 1;
7486 $main::selinux_enabled_cache = 0;
7489 return $main::selinux_enabled_cache;
7492 =head2 get_clear_file_attributes(file)
7494 Finds file attributes that may prevent writing, clears them and returns them
7495 as a list. May call error. Mainly for internal use by open_tempfile and
7499 sub get_clear_file_attributes
7503 if ($gconfig{'chattr'}) {
7504 # Get original immutable bit
7505 my $out = &backquote_command(
7506 "lsattr ".quotemeta($file)." 2>/dev/null");
7508 $out =~ s/\s\S+\n//;
7509 @old_attributes = grep { $_ ne '-' } split(//, $out);
7511 if (&indexof("i", @old_attributes) >= 0) {
7512 my $err = &backquote_logged(
7513 "chattr -i ".quotemeta($file)." 2>&1");
7515 &error("Failed to remove immutable bit on ".
7520 return @old_attributes;
7523 =head2 reset_file_attributes(file, &attributes)
7525 Put back cleared attributes on some file. May call error. Mainly for internal
7526 use by close_tempfile.
7529 sub reset_file_attributes
7531 my ($file, $old_attributes) = @_;
7532 if (&indexof("i", @$old_attributes) >= 0) {
7533 my $err = &backquote_logged(
7534 "chattr +i ".quotemeta($file)." 2>&1");
7536 &error("Failed to restore immutable bit on ".
7542 =head2 cleanup_tempnames
7544 Remove all temporary files generated using transname. Typically only called
7545 internally when a Webmin script exits.
7548 sub cleanup_tempnames
7550 foreach my $t (@main::temporary_files) {
7553 @main::temporary_files = ( );
7556 =head2 open_lock_tempfile([handle], file, [no-error])
7558 Returns a temporary file for writing to some actual file, and also locks it.
7559 Effectively the same as calling lock_file and open_tempfile on the same file,
7560 but calls the unlock for you automatically when it is closed.
7563 sub open_lock_tempfile
7565 my ($fh, $file, $noerror, $notemp, $safe) = @_;
7566 $fh = &callers_package($fh);
7567 my $lockfile = $file;
7568 $lockfile =~ s/^[^\/]*//;
7569 if ($lockfile =~ /^\//) {
7570 $main::open_templocks{$lockfile} = &lock_file($lockfile);
7572 return &open_tempfile($fh, $file, $noerror, $notemp, $safe);
7577 $main::end_exit_status ||= $?;
7578 if ($$ == $main::initial_process_id) {
7579 # Exiting from initial process
7580 &cleanup_tempnames();
7581 if ($gconfig{'debug_what_start'} && $main::debug_log_start_time &&
7582 $main::debug_log_start_module eq &get_module_name()) {
7583 my $len = time() - $main::debug_log_start_time;
7584 &webmin_debug_log("STOP", "runtime=$len");
7585 $main::debug_log_start_time = 0;
7587 if (!$ENV{'SCRIPT_NAME'} &&
7588 $main::initial_module_name eq &get_module_name()) {
7589 # In a command-line script - call the real exit, so that the
7590 # exit status gets properly propogated. In some cases this
7591 # was not happening.
7592 exit($main::end_exit_status);
7597 =head2 month_to_number(month)
7599 Converts a month name like feb to a number like 1.
7604 return $month_to_number_map{lc(substr($_[0], 0, 3))};
7607 =head2 number_to_month(number)
7609 Converts a number like 1 to a month name like Feb.
7614 return ucfirst($number_to_month_map{$_[0]});
7617 =head2 get_rbac_module_acl(user, module)
7619 Returns a hash reference of RBAC overrides ACLs for some user and module.
7620 May return undef if none exist (indicating access denied), or the string *
7621 if full access is granted.
7624 sub get_rbac_module_acl
7626 my ($user, $mod) = @_;
7627 eval "use Authen::SolarisRBAC";
7628 return undef if ($@);
7631 if (Authen::SolarisRBAC::chkauth("webmin.$mod.admin", $user)) {
7632 # Automagic webmin.modulename.admin authorization exists .. allow access
7634 if (!Authen::SolarisRBAC::chkauth("webmin.$mod.config", $user)) {
7635 %rv = ( 'noconfig' => 1 );
7642 open(RBAC, &module_root_directory($mod)."/rbac-mapping");
7646 my ($auths, $acls) = split(/\s+/, $_);
7647 my @auths = split(/,/, $auths);
7649 my ($merge) = ($acls =~ s/^\+//);
7651 if ($auths eq "*") {
7652 # These ACLs apply to all RBAC users.
7653 # Only if there is some that match a specific authorization
7654 # later will they be used though.
7657 # Check each of the RBAC authorizations
7658 foreach my $a (@auths) {
7659 if (!Authen::SolarisRBAC::chkauth($a, $user)) {
7664 $foundany++ if ($gotall);
7667 # Found an RBAC authorization - return the ACLs
7668 return "*" if ($acls eq "*");
7669 my %acl = map { split(/=/, $_, 2) } split(/,/, $acls);
7671 # Just add to current set
7672 foreach my $a (keys %acl) {
7683 return !$foundany ? undef : %rv ? \%rv : undef;
7686 =head2 supports_rbac([module])
7688 Returns 1 if RBAC client support is available, such as on Solaris.
7693 return 0 if ($gconfig{'os_type'} ne 'solaris');
7694 eval "use Authen::SolarisRBAC";
7697 #return 0 if (!-r &module_root_directory($_[0])."/rbac-mapping");
7702 =head2 use_rbac_module_acl(user, module)
7704 Returns 1 if some user should use RBAC to get permissions for a module
7707 sub use_rbac_module_acl
7709 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
7710 my $m = defined($_[1]) ? $_[1] : &get_module_name();
7711 return 1 if ($gconfig{'rbacdeny_'.$u}); # RBAC forced for user
7712 my %access = &get_module_acl($u, $m, 1);
7713 return $access{'rbac'} ? 1 : 0;
7716 =head2 execute_command(command, stdin, stdout, stderr, translate-files?, safe?)
7718 Runs some command, possibly feeding it input and capturing output to the
7719 give files or scalar references. The parameters are :
7721 =item command - Full command to run, possibly including shell meta-characters.
7723 =item stdin - File to read input from, or a scalar ref containing input, or undef if no input should be given.
7725 =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.
7727 =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.
7729 =item translate-files - Set to 1 to apply filename translation to any filenames. Usually has no effect.
7731 =item safe - Set to 1 if this command is safe and does not modify the state of the system.
7736 my ($cmd, $stdin, $stdout, $stderr, $trans, $safe) = @_;
7737 if (&is_readonly_mode() && !$safe) {
7738 print STDERR "Vetoing command $_[0]\n";
7742 $cmd = &translate_command($cmd);
7744 # Use ` operator where possible
7745 if (!$stdin && ref($stdout) && !$stderr) {
7746 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7747 $$stdout = `$cmd 2>$null_file`;
7750 elsif (!$stdin && ref($stdout) && $stdout eq $stderr) {
7751 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7752 $$stdout = `$cmd 2>&1`;
7755 elsif (!$stdin && !$stdout && !$stderr) {
7756 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
7757 return system("$cmd >$null_file 2>$null_file <$null_file");
7759 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
7762 $| = 1; # needed on some systems to flush before forking
7763 pipe(EXECSTDINr, EXECSTDINw);
7764 pipe(EXECSTDOUTr, EXECSTDOUTw);
7765 pipe(EXECSTDERRr, EXECSTDERRw);
7767 if (!($pid = fork())) {
7771 open(STDIN, "<&EXECSTDINr");
7772 open(STDOUT, ">&EXECSTDOUTw");
7773 if (ref($stderr) && $stderr eq $stdout) {
7774 open(STDERR, ">&EXECSTDOUTw");
7777 open(STDERR, ">&EXECSTDERRw");
7784 my $fullcmd = "($cmd)";
7785 if ($stdin && !ref($stdin)) {
7786 $fullcmd .= " <$stdin";
7788 if ($stdout && !ref($stdout)) {
7789 $fullcmd .= " >$stdout";
7791 if ($stderr && !ref($stderr)) {
7792 if ($stderr eq $stdout) {
7793 $fullcmd .= " 2>&1";
7796 $fullcmd .= " 2>$stderr";
7799 if ($gconfig{'os_type'} eq 'windows') {
7803 exec("/bin/sh", "-c", $fullcmd);
7805 print "Exec failed : $!\n";
7812 # Feed input and capture output
7814 if ($stdin && ref($stdin)) {
7815 print EXECSTDINw $$stdin;
7818 if ($stdout && ref($stdout)) {
7820 while(<EXECSTDOUTr>) {
7825 if ($stderr && ref($stderr) && $stderr ne $stdout) {
7827 while(<EXECSTDERRr>) {
7838 =head2 open_readfile(handle, file)
7840 Opens some file for reading. Returns 1 on success, 0 on failure. Pretty much
7841 exactly the same as Perl's open function.
7846 my ($fh, $file) = @_;
7847 $fh = &callers_package($fh);
7848 my $realfile = &translate_filename($file);
7849 &webmin_debug_log('READ', $file) if ($gconfig{'debug_what_read'});
7850 return open($fh, "<".$realfile);
7853 =head2 open_execute_command(handle, command, output?, safe?)
7855 Runs some command, with the specified file handle set to either write to it if
7856 in-or-out is set to 0, or read to it if output is set to 1. The safe flag
7857 indicates if the command modifies the state of the system or not.
7860 sub open_execute_command
7862 my ($fh, $cmd, $mode, $safe) = @_;
7863 $fh = &callers_package($fh);
7864 my $realcmd = &translate_command($cmd);
7865 if (&is_readonly_mode() && !$safe) {
7866 # Don't actually run it
7867 print STDERR "vetoing command $cmd\n";
7870 return open($fh, ">$null_file");
7873 return open($fh, $null_file);
7877 &webmin_debug_log('CMD', "cmd=$realcmd mode=$mode")
7878 if ($gconfig{'debug_what_cmd'});
7880 return open($fh, "| $cmd");
7882 elsif ($mode == 1) {
7883 return open($fh, "$cmd 2>$null_file |");
7885 elsif ($mode == 2) {
7886 return open($fh, "$cmd 2>&1 |");
7890 =head2 translate_filename(filename)
7892 Applies all relevant registered translation functions to a filename. Mostly
7893 for internal use, and typically does nothing.
7896 sub translate_filename
7898 my ($realfile) = @_;
7899 my @funcs = grep { $_->[0] eq &get_module_name() ||
7900 !defined($_->[0]) } @main::filename_callbacks;
7901 foreach my $f (@funcs) {
7903 $realfile = &$func($realfile, @{$f->[2]});
7908 =head2 translate_command(filename)
7910 Applies all relevant registered translation functions to a command. Mostly
7911 for internal use, and typically does nothing.
7914 sub translate_command
7917 my @funcs = grep { $_->[0] eq &get_module_name() ||
7918 !defined($_->[0]) } @main::command_callbacks;
7919 foreach my $f (@funcs) {
7921 $realcmd = &$func($realcmd, @{$f->[2]});
7926 =head2 register_filename_callback(module|undef, &function, &args)
7928 Registers some function to be called when the specified module (or all
7929 modules) tries to open a file for reading and writing. The function must
7930 return the actual file to open. This allows you to override which files
7931 other code actually operates on, via the translate_filename function.
7934 sub register_filename_callback
7936 my ($mod, $func, $args) = @_;
7937 push(@main::filename_callbacks, [ $mod, $func, $args ]);
7940 =head2 register_command_callback(module|undef, &function, &args)
7942 Registers some function to be called when the specified module (or all
7943 modules) tries to execute a command. The function must return the actual
7944 command to run. This allows you to override which commands other other code
7945 actually runs, via the translate_command function.
7948 sub register_command_callback
7950 my ($mod, $func, $args) = @_;
7951 push(@main::command_callbacks, [ $mod, $func, $args ]);
7954 =head2 capture_function_output(&function, arg, ...)
7956 Captures output that some function prints to STDOUT, and returns it. Useful
7957 for functions outside your control that print data when you really want to
7958 manipulate it before output.
7961 sub capture_function_output
7963 my ($func, @args) = @_;
7964 socketpair(SOCKET2, SOCKET1, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
7965 my $old = select(SOCKET1);
7966 my @rv = &$func(@args);
7975 return wantarray ? ($out, \@rv) : $out;
7978 =head2 capture_function_output_tempfile(&function, arg, ...)
7980 Behaves the same as capture_function_output, but uses a temporary file
7981 to avoid buffer full problems.
7984 sub capture_function_output_tempfile
7986 my ($func, @args) = @_;
7987 my $temp = &transname();
7988 open(BUFFER, ">$temp");
7989 my $old = select(BUFFER);
7990 my @rv = &$func(@args);
7993 my $out = &read_file_contents($temp);
7994 &unlink_file($temp);
7995 return wantarray ? ($out, \@rv) : $out;
7998 =head2 modules_chooser_button(field, multiple, [form])
8000 Returns HTML for a button for selecting one or many Webmin modules.
8001 field - Name of the HTML field to place the module names into.
8002 multiple - Set to 1 if multiple modules can be selected.
8003 form - Index of the form on the page.
8006 sub modules_chooser_button
8008 return &theme_modules_chooser_button(@_)
8009 if (defined(&theme_modules_chooser_button));
8010 my $form = defined($_[2]) ? $_[2] : 0;
8011 my $w = $_[1] ? 700 : 500;
8013 if ($_[1] && $gconfig{'db_sizemodules'}) {
8014 ($w, $h) = split(/x/, $gconfig{'db_sizemodules'});
8016 elsif (!$_[1] && $gconfig{'db_sizemodule'}) {
8017 ($w, $h) = split(/x/, $gconfig{'db_sizemodule'});
8019 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";
8022 =head2 substitute_template(text, &hash)
8024 Given some text and a hash reference, for each ocurrance of $FOO or ${FOO} in
8025 the text replaces it with the value of the hash key foo. Also supports blocks
8026 like ${IF-FOO} ... ${ENDIF-FOO}, whose contents are only included if foo is
8027 non-zero, and ${IF-FOO} ... ${ELSE-FOO} ... ${ENDIF-FOO}.
8030 sub substitute_template
8032 # Add some extra fixed parameters to the hash
8033 my %hash = %{$_[1]};
8034 $hash{'hostname'} = &get_system_hostname();
8035 $hash{'webmin_config'} = $config_directory;
8036 $hash{'webmin_etc'} = $config_directory;
8037 $hash{'module_config'} = &get_module_variable('$module_config_directory');
8038 $hash{'webmin_var'} = $var_directory;
8040 # Add time-based parameters, for use in DNS
8041 $hash{'current_time'} = time();
8042 my @tm = localtime($hash{'current_time'});
8043 $hash{'current_year'} = $tm[5]+1900;
8044 $hash{'current_month'} = sprintf("%2.2d", $tm[4]+1);
8045 $hash{'current_day'} = sprintf("%2.2d", $tm[3]);
8046 $hash{'current_hour'} = sprintf("%2.2d", $tm[2]);
8047 $hash{'current_minute'} = sprintf("%2.2d", $tm[1]);
8048 $hash{'current_second'} = sprintf("%2.2d", $tm[0]);
8050 # Actually do the substition
8052 foreach my $s (keys %hash) {
8053 next if ($s eq ''); # Prevent just $ from being subbed
8056 $rv =~ s/\$\{\Q$us\E\}/$sv/g;
8057 $rv =~ s/\$\Q$us\E/$sv/g;
8059 # Replace ${IF}..${ELSE}..${ENDIF} block with first value,
8060 # and ${IF}..${ENDIF} with value
8061 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8062 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8064 # Replace $IF..$ELSE..$ENDIF block with first value,
8065 # and $IF..$ENDIF with value
8066 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8067 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8069 # Replace ${IFEQ}..${ENDIFEQ} block with first value if
8070 # matching, nothing if not
8071 $rv =~ s/\$\{IFEQ-\Q$us\E-\Q$sv\E\}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-\Q$sv\E\}(\n?)/$2/g;
8072 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8074 # Replace $IFEQ..$ENDIFEQ block with first value if
8075 # matching, nothing if not
8076 $rv =~ s/\$IFEQ-\Q$us\E-\Q$sv\E(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\Q$sv\E(\n?)/$2/g;
8077 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8080 # Replace ${IF}..${ELSE}..${ENDIF} block with second value,
8081 # and ${IF}..${ENDIF} with nothing
8082 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$4/g;
8083 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)//g;
8085 # Replace $IF..$ELSE..$ENDIF block with second value,
8086 # and $IF..$ENDIF with nothing
8087 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$4/g;
8088 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)//g;
8090 # Replace ${IFEQ}..${ENDIFEQ} block with nothing
8091 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8092 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8096 # Now assume any $IF blocks whose variables are not present in the hash
8097 # evaluate to false.
8098 # $IF...$ELSE x $ENDIF => x
8099 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ELSE\-\1\}(.*?)\$\{ENDIF\-\1\}/$2/gs;
8100 # $IF...x...$ENDIF => (nothing)
8101 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ENDIF\-\1\}//gs;
8102 # ${var} => (nothing)
8103 $rv =~ s/\$\{[A-Z]+\}//g;
8108 =head2 running_in_zone
8110 Returns 1 if the current Webmin instance is running in a Solaris zone. Used to
8111 disable module and features that are not appropriate, like those that modify
8112 mounted filesystems.
8117 return 0 if ($gconfig{'os_type'} ne 'solaris' ||
8118 $gconfig{'os_version'} < 10);
8119 my $zn = `zonename 2>$null_file`;
8121 return $zn && $zn ne "global";
8124 =head2 running_in_vserver
8126 Returns 1 if the current Webmin instance is running in a Linux VServer.
8127 Used to disable modules and features that are not appropriate.
8130 sub running_in_vserver
8132 return 0 if ($gconfig{'os_type'} !~ /^\*-linux$/);
8135 open(MTAB, "/etc/mtab");
8137 my ($dev, $mp) = split(/\s+/, $_);
8138 if ($mp eq "/" && $dev =~ /^\/dev\/hdv/) {
8147 =head2 running_in_xen
8149 Returns 1 if Webmin is running inside a Xen instance, by looking
8150 at /proc/xen/capabilities.
8155 return 0 if (!-r "/proc/xen/capabilities");
8156 my $cap = &read_file_contents("/proc/xen/capabilities");
8157 return $cap =~ /control_d/ ? 0 : 1;
8160 =head2 running_in_openvz
8162 Returns 1 if Webmin is running inside an OpenVZ container, by looking
8163 at /proc/vz/veinfo for a non-zero line.
8166 sub running_in_openvz
8168 return 0 if (!-r "/proc/vz/veinfo");
8169 my $lref = &read_file_lines("/proc/vz/veinfo", 1);
8170 return 0 if (!$lref || !@$lref);
8171 foreach my $l (@$lref) {
8173 my @ll = split(/\s+/, $l);
8174 return 0 if ($ll[0] eq '0');
8179 =head2 list_categories(&modules, [include-empty])
8181 Returns a hash mapping category codes to names, including any custom-defined
8182 categories. The modules parameter must be an array ref of module hash objects,
8183 as returned by get_all_module_infos.
8188 my ($mods, $empty) = @_;
8189 my (%cats, %catnames);
8190 &read_file("$config_directory/webmin.catnames", \%catnames);
8191 foreach my $o (@lang_order_list) {
8192 &read_file("$config_directory/webmin.catnames.$o", \%catnames);
8197 foreach my $m (@$mods) {
8198 my $c = $m->{'category'};
8199 next if ($cats{$c});
8200 if (defined($catnames{$c})) {
8201 $cats{$c} = $catnames{$c};
8203 elsif ($text{"category_$c"}) {
8204 $cats{$c} = $text{"category_$c"};
8207 # try to get category name from module ..
8208 my %mtext = &load_language($m->{'dir'});
8209 if ($mtext{"category_$c"}) {
8210 $cats{$c} = $mtext{"category_$c"};
8213 $c = $m->{'category'} = "";
8214 $cats{$c} = $text{"category_$c"};
8221 =head2 is_readonly_mode
8223 Returns 1 if the current user is in read-only mode, and thus all writes
8224 to files and command execution should fail.
8227 sub is_readonly_mode
8229 if (!defined($main::readonly_mode_cache)) {
8230 my %gaccess = &get_module_acl(undef, "");
8231 $main::readonly_mode_cache = $gaccess{'readonly'} ? 1 : 0;
8233 return $main::readonly_mode_cache;
8236 =head2 command_as_user(user, with-env?, command, ...)
8238 Returns a command to execute some command as the given user, using the
8239 su statement. If on Linux, the /bin/sh shell is forced in case the user
8240 does not have a valid shell. If with-env is set to 1, the -s flag is added
8241 to the su command to read the user's .profile or .bashrc file.
8246 my ($user, $env, @args) = @_;
8247 my @uinfo = getpwnam($user);
8248 if ($uinfo[8] ne "/bin/sh" && $uinfo[8] !~ /\/bash$/) {
8249 # User shell doesn't appear to be valid
8250 if ($gconfig{'os_type'} =~ /-linux$/) {
8251 # Use -s /bin/sh to force it
8252 $shellarg = " -s /bin/sh";
8254 elsif ($gconfig{'os_type'} eq 'freebsd' ||
8255 $gconfig{'os_type'} eq 'solaris' &&
8256 $gconfig{'os_version'} >= 11 ||
8257 $gconfig{'os_type'} eq 'macos') {
8258 # Use -m and force /bin/sh
8259 @args = ( "/bin/sh", "-c", quotemeta(join(" ", @args)) );
8263 my $rv = "su".($env ? " -" : "").$shellarg.
8264 " ".quotemeta($user)." -c ".quotemeta(join(" ", @args));
8268 =head2 list_osdn_mirrors(project, file)
8270 This function is now deprecated in favor of letting sourceforge just
8271 redirect to the best mirror, and now just returns their primary download URL.
8274 sub list_osdn_mirrors
8276 my ($project, $file) = @_;
8277 return ( { 'url' => "http://downloads.sourceforge.net/$project/$file",
8279 'mirror' => 'downloads' } );
8282 =head2 convert_osdn_url(url)
8284 Given a URL like http://osdn.dl.sourceforge.net/sourceforge/project/file.zip
8285 or http://prdownloads.sourceforge.net/project/file.zip , convert it
8286 to a real URL on the sourceforge download redirector.
8289 sub convert_osdn_url
8292 if ($url =~ /^http:\/\/[^\.]+.dl.sourceforge.net\/sourceforge\/([^\/]+)\/(.*)$/ ||
8293 $url =~ /^http:\/\/prdownloads.sourceforge.net\/([^\/]+)\/(.*)$/) {
8294 # Always use the Sourceforge mail download URL, which does
8295 # a location-based redirect for us
8296 my ($project, $file) = ($1, $2);
8297 $url = "http://prdownloads.sourceforge.net/sourceforge/".
8299 return wantarray ? ( $url, 0 ) : $url;
8302 # Some other source .. don't change
8303 return wantarray ? ( $url, 2 ) : $url;
8307 =head2 get_current_dir
8309 Returns the directory the current process is running in.
8315 if ($gconfig{'os_type'} eq 'windows') {
8328 =head2 supports_users
8330 Returns 1 if the current OS supports Unix user concepts and functions like
8331 su , getpw* and so on. This will be true on Linux and other Unixes, but false
8337 return $gconfig{'os_type'} ne 'windows';
8340 =head2 supports_symlinks
8342 Returns 1 if the current OS supports symbolic and hard links. This will not
8343 be the case on Windows.
8346 sub supports_symlinks
8348 return $gconfig{'os_type'} ne 'windows';
8351 =head2 quote_path(path)
8353 Returns a path with safe quoting for the current operating system.
8359 if ($gconfig{'os_type'} eq 'windows' || $path =~ /^[a-z]:/i) {
8360 # Windows only supports "" style quoting
8364 return quotemeta($path);
8368 =head2 get_windows_root
8370 Returns the base windows system directory, like c:/windows.
8373 sub get_windows_root
8375 if ($ENV{'SystemRoot'}) {
8376 my $rv = $ENV{'SystemRoot'};
8381 return -d "c:/windows" ? "c:/windows" : "c:/winnt";
8385 =head2 read_file_contents(file)
8387 Given a filename, returns its complete contents as a string. Effectively
8388 the same as the Perl construct `cat file`.
8391 sub read_file_contents
8393 &open_readfile(FILE, $_[0]) || return undef;
8400 =head2 unix_crypt(password, salt)
8402 Performs Unix encryption on a password, using the built-in crypt function or
8403 the Crypt::UnixCrypt module if the former does not work. The salt parameter
8404 must be either an already-hashed password, or a two-character alpha-numeric
8410 my ($pass, $salt) = @_;
8411 return "" if ($salt !~ /^[a-zA-Z0-9\.\/]{2}/); # same as real crypt
8412 my $rv = eval "crypt(\$pass, \$salt)";
8414 return $rv if ($rv && !$@);
8415 eval "use Crypt::UnixCrypt";
8417 return Crypt::UnixCrypt::crypt($pass, $salt);
8420 &error("Failed to encrypt password : $err");
8424 =head2 split_quoted_string(string)
8426 Given a string like I<foo "bar baz" quux>, returns the array :
8430 sub split_quoted_string
8434 while($str =~ /^"([^"]*)"\s*([\000-\377]*)$/ ||
8435 $str =~ /^'([^']*)'\s*([\000-\377]*)$/ ||
8436 $str =~ /^(\S+)\s*([\000-\377]*)$/) {
8443 =head2 write_to_http_cache(url, file|&data)
8445 Updates the Webmin cache with the contents of the given file, possibly also
8446 clearing out old data. Mainly for internal use by http_download.
8449 sub write_to_http_cache
8451 my ($url, $file) = @_;
8452 return 0 if (!$gconfig{'cache_size'});
8454 # Don't cache downloads that look dynamic
8455 if ($url =~ /cgi-bin/ || $url =~ /\?/) {
8459 # Check if the current module should do caching
8460 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
8461 # Caching all except some modules
8462 my @mods = split(/\s+/, $1);
8463 return 0 if (&indexof(&get_module_name(), @mods) != -1);
8465 elsif ($gconfig{'cache_mods'}) {
8466 # Only caching some modules
8467 my @mods = split(/\s+/, $gconfig{'cache_mods'});
8468 return 0 if (&indexof(&get_module_name(), @mods) == -1);
8474 $size = length($$file);
8477 my @st = stat($file);
8481 if ($size > $gconfig{'cache_size'}) {
8482 # Bigger than the whole cache - so don't save it
8487 $cfile = "$main::http_cache_directory/$cfile";
8489 # See how much we have cached currently, clearing old files
8491 mkdir($main::http_cache_directory, 0700) if (!-d $main::http_cache_directory);
8492 opendir(CACHEDIR, $main::http_cache_directory);
8493 foreach my $f (readdir(CACHEDIR)) {
8494 next if ($f eq "." || $f eq "..");
8495 my $path = "$main::http_cache_directory/$f";
8496 my @st = stat($path);
8497 if ($gconfig{'cache_days'} &&
8498 time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
8499 # This file is too old .. trash it
8504 push(@cached, [ $path, $st[7], $st[9] ]);
8508 @cached = sort { $a->[2] <=> $b->[2] } @cached;
8509 while($total+$size > $gconfig{'cache_size'} && @cached) {
8510 # Cache is too big .. delete some files until the new one will fit
8511 unlink($cached[0]->[0]);
8512 $total -= $cached[0]->[1];
8516 # Finally, write out the new file
8518 &open_tempfile(CACHEFILE, ">$cfile");
8519 &print_tempfile(CACHEFILE, $$file);
8520 &close_tempfile(CACHEFILE);
8523 my ($ok, $err) = ©_source_dest($file, $cfile);
8529 =head2 check_in_http_cache(url)
8531 If some URL is in the cache and valid, return the filename for it. Mainly
8532 for internal use by http_download.
8535 sub check_in_http_cache
8538 return undef if (!$gconfig{'cache_size'});
8540 # Check if the current module should do caching
8541 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
8542 # Caching all except some modules
8543 my @mods = split(/\s+/, $1);
8544 return 0 if (&indexof(&get_module_name(), @mods) != -1);
8546 elsif ($gconfig{'cache_mods'}) {
8547 # Only caching some modules
8548 my @mods = split(/\s+/, $gconfig{'cache_mods'});
8549 return 0 if (&indexof(&get_module_name(), @mods) == -1);
8554 $cfile = "$main::http_cache_directory/$cfile";
8555 my @st = stat($cfile);
8556 return undef if (!@st || !$st[7]);
8557 if ($gconfig{'cache_days'} && time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
8562 open(TOUCH, ">>$cfile"); # Update the file time, to keep it in the cache
8567 =head2 supports_javascript
8569 Returns 1 if the current browser is assumed to support javascript.
8572 sub supports_javascript
8574 if (defined(&theme_supports_javascript)) {
8575 return &theme_supports_javascript();
8577 return $ENV{'MOBILE_DEVICE'} ? 0 : 1;
8580 =head2 get_module_name
8582 Returns the name of the Webmin module that called this function. For internal
8583 use only by other API functions.
8588 return &get_module_variable('$module_name');
8591 =head2 get_module_variable(name, [ref])
8593 Returns the value of some variable which is set in the caller's context, if
8594 using the new WebminCore package. For internal use only.
8597 sub get_module_variable
8599 my ($v, $wantref) = @_;
8600 my $slash = $wantref ? "\\" : "";
8601 my $thispkg = &web_libs_package();
8602 if ($thispkg eq 'WebminCore') {
8603 my ($vt, $vn) = split('', $v, 2);
8605 for(my $i=0; ($callpkg) = caller($i); $i++) {
8606 last if ($callpkg ne $thispkg);
8608 return eval "${slash}${vt}${callpkg}::${vn}";
8610 return eval "${slash}${v}";
8613 =head2 clear_time_locale()
8615 Temporarily force the locale to C, until reset_time_locale is called. This is
8616 useful if your code is going to call C<strftime> from the POSIX package, and
8617 you want to ensure that the output is in a consistent format.
8620 sub clear_time_locale
8622 if ($main::clear_time_locale_count == 0) {
8625 $main::clear_time_locale_old = POSIX::setlocale(POSIX::LC_TIME);
8626 POSIX::setlocale(POSIX::LC_TIME, "C");
8629 $main::clear_time_locale_count++;
8632 =head2 reset_time_locale()
8634 Revert the locale to whatever it was before clear_time_locale was called
8637 sub reset_time_locale
8639 if ($main::clear_time_locale_count == 1) {
8641 POSIX::setlocale(POSIX::LC_TIME, $main::clear_time_locale_old);
8642 $main::clear_time_locale_old = undef;
8645 $main::clear_time_locale_count--;
8648 =head2 callers_package(filehandle)
8650 Convert a non-module filehandle like FOO to one qualified with the
8651 caller's caller's package, like fsdump::FOO. For internal use only.
8657 my $callpkg = (caller(1))[0];
8658 my $thispkg = &web_libs_package();
8659 if (!ref($fh) && $fh !~ /::/ &&
8660 $callpkg ne $thispkg && $thispkg eq 'WebminCore') {
8661 $fh = $callpkg."::".$fh;
8666 =head2 web_libs_package()
8668 Returns the package this code is in. We can't always trust __PACKAGE__. For
8672 sub web_libs_package
8674 if ($called_from_webmin_core) {
8675 return "WebminCore";
8680 $done_web_lib_funcs = 1;