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 $ipv6_module_error = $@;
21 use vars qw($user_risk_level $loaded_theme_library $wait_for_input
22 $done_webmin_header $trust_unknown_referers $unsafe_index_cgi
23 %done_foreign_require $webmin_feedback_address
24 $user_skill_level $pragma_no_cache $foreign_args);
26 use vars qw($module_index_name $number_to_month_map $month_to_number_map
27 $umask_already $default_charset $licence_status $os_type
28 $licence_message $script_name $loaded_theme_oo_library
29 $done_web_lib_funcs $os_version $module_index_link
30 $called_from_webmin_core $ipv6_module_error);
32 =head2 read_file(file, &hash, [&order], [lowercase], [split-char])
34 Fill the given hash reference with name=value pairs from a file. The required
37 =item file - The file to head, which must be text with each line like name=value
39 =item hash - The hash reference to add values read from the file to.
41 =item order - If given, an array reference to add names to in the order they were read
43 =item lowercase - If set to 1, names are converted to lower case
45 =item split-char - If set, names and values are split on this character instead of =
51 my $split = defined($_[4]) ? $_[4] : "=";
52 my $realfile = &translate_filename($_[0]);
53 &open_readfile(ARFILE, $_[0]) || return 0;
56 my $hash = index($_, "#");
57 my $eq = index($_, $split);
58 if ($hash != 0 && $eq >= 0) {
59 my $n = substr($_, 0, $eq);
60 my $v = substr($_, $eq+1);
62 $_[1]->{$_[3] ? lc($n) : $n} = $v;
63 push(@{$_[2]}, $n) if ($_[2]);
67 $main::read_file_missing{$realfile} = 0; # It exists now
68 if (defined($main::read_file_cache{$realfile})) {
69 %{$main::read_file_cache{$realfile}} = %{$_[1]};
74 =head2 read_file_cached(file, &hash, [&order], [lowercase], [split-char])
76 Like read_file, but reads from an in-memory cache if the file has already been
77 read in this Webmin script. Recommended, as it behaves exactly the same as
78 read_file, but can be much faster.
83 my $realfile = &translate_filename($_[0]);
84 if (defined($main::read_file_cache{$realfile})) {
86 %{$_[1]} = ( %{$_[1]}, %{$main::read_file_cache{$realfile}} );
89 elsif ($main::read_file_missing{$realfile}) {
90 # Doesn't exist, so don't re-try read
94 # Actually read the file
96 if (&read_file($_[0], \%d, $_[2], $_[3], $_[4])) {
97 %{$main::read_file_cache{$realfile}} = %d;
98 %{$_[1]} = ( %{$_[1]}, %d );
102 # Flag as non-existant
103 $main::read_file_missing{$realfile} = 1;
109 =head2 write_file(file, &hash, [join-char])
111 Write out the contents of a hash as name=value lines. The parameters are :
113 =item file - Full path to write to
115 =item hash - A hash reference containing names and values to output
117 =item join-char - If given, names and values are separated by this instead of =
123 my $join = defined($_[2]) ? $_[2] : "=";
124 my $realfile = &translate_filename($_[0]);
125 &read_file($_[0], \%old, \@order);
126 &open_tempfile(ARFILE, ">$_[0]");
127 foreach $k (@order) {
128 if (exists($_[1]->{$k})) {
129 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
130 &error(&text("efilewrite", $realfile, $!));
133 foreach $k (keys %{$_[1]}) {
134 if (!exists($old{$k})) {
135 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
136 &error(&text("efilewrite", $realfile, $!));
139 &close_tempfile(ARFILE);
140 if (defined($main::read_file_cache{$realfile})) {
141 %{$main::read_file_cache{$realfile}} = %{$_[1]};
143 if (defined($main::read_file_missing{$realfile})) {
144 $main::read_file_missing{$realfile} = 0;
148 =head2 html_escape(string)
150 Converts &, < and > codes in text to HTML entities, and returns the new string.
151 This should be used when including data read from other sources in HTML pages.
160 $tmp =~ s/\"/"/g;
161 $tmp =~ s/\'/'/g;
166 =head2 quote_escape(string, [only-quote])
168 Converts ' and " characters in a string into HTML entities, and returns it.
169 Useful for outputing HTML tag values.
174 my ($tmp, $only) = @_;
175 if ($tmp !~ /\&[a-zA-Z]+;/ && $tmp !~ /\&#/) {
176 # convert &, unless it is part of &#nnn; or &foo;
177 $tmp =~ s/&([^#])/&$1/g;
179 $tmp =~ s/&$/&/g;
180 $tmp =~ s/\"/"/g if ($only eq '' || $only eq '"');
181 $tmp =~ s/\'/'/g if ($only eq '' || $only eq "'");
185 =head2 tempname([filename])
187 Returns a mostly random temporary file name, typically under the /tmp/.webmin
188 directory. If filename is given, this will be the base name used. Otherwise
189 a unique name is selected randomly.
194 my $tmp_base = $gconfig{'tempdir_'.&get_module_name()} ?
195 $gconfig{'tempdir_'.&get_module_name()} :
196 $gconfig{'tempdir'} ? $gconfig{'tempdir'} :
197 $ENV{'TEMP'} ? $ENV{'TEMP'} :
198 $ENV{'TMP'} ? $ENV{'TMP'} :
199 -d "c:/temp" ? "c:/temp" : "/tmp/.webmin";
200 my $tmp_dir = -d $remote_user_info[7] && !$gconfig{'nohometemp'} ?
201 "$remote_user_info[7]/.tmp" :
202 @remote_user_info ? $tmp_base."-".$remote_user :
203 $< != 0 ? $tmp_base."-".getpwuid($<) :
205 if ($gconfig{'os_type'} eq 'windows' || $tmp_dir =~ /^[a-z]:/i) {
206 # On Windows system, just create temp dir if missing
208 mkdir($tmp_dir, 0755) ||
209 &error("Failed to create temp directory $tmp_dir : $!");
213 # On Unix systems, need to make sure temp dir is valid
215 while($tries++ < 10) {
216 my @st = lstat($tmp_dir);
217 last if ($st[4] == $< && (-d _) && ($st[2] & 0777) == 0755);
219 unlink($tmp_dir) || rmdir($tmp_dir) ||
220 system("/bin/rm -rf ".quotemeta($tmp_dir));
222 mkdir($tmp_dir, 0755) || next;
223 chown($<, $(, $tmp_dir);
224 chmod(0755, $tmp_dir);
227 my @st = lstat($tmp_dir);
228 &error("Failed to create temp directory $tmp_dir : uid=$st[4] mode=$st[2]");
232 if (defined($_[0]) && $_[0] !~ /\.\./) {
233 $rv = "$tmp_dir/$_[0]";
236 $main::tempfilecount++;
238 $rv = $tmp_dir."/".int(rand(1000000))."_".
239 $main::tempfilecount."_".$scriptname;
244 =head2 transname([filename])
246 Behaves exactly like tempname, but records the temp file for deletion when the
247 current Webmin script process exits.
252 my $rv = &tempname(@_);
253 push(@main::temporary_files, $rv);
257 =head2 trunc(string, maxlen)
259 Truncates a string to the shortest whole word less than or equal to the
260 given width. Useful for word wrapping.
265 if (length($_[0]) <= $_[1]) {
268 my $str = substr($_[0],0,$_[1]);
277 =head2 indexof(string, value, ...)
279 Returns the index of some value in an array of values, or -1 if it was not
285 for(my $i=1; $i <= $#_; $i++) {
286 if ($_[$i] eq $_[0]) { return $i - 1; }
291 =head2 indexoflc(string, value, ...)
293 Like indexof, but does a case-insensitive match
298 my $str = lc(shift(@_));
299 my @arr = map { lc($_) } @_;
300 return &indexof($str, @arr);
303 =head2 sysprint(handle, [string]+)
305 Outputs some strings to a file handle, but bypassing IO buffering. Can be used
306 as a replacement for print when writing to pipes or sockets.
311 my $fh = &callers_package($_[0]);
312 my $str = join('', @_[1..$#_]);
313 syswrite $fh, $str, length($str);
316 =head2 check_ipaddress(ip)
318 Check if some IPv4 address is properly formatted, returning 1 if so or 0 if not.
323 return $_[0] =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/ &&
324 $1 >= 0 && $1 <= 255 &&
325 $2 >= 0 && $2 <= 255 &&
326 $3 >= 0 && $3 <= 255 &&
327 $4 >= 0 && $4 <= 255;
330 =head2 check_ip6address(ip)
332 Check if some IPv6 address is properly formatted, and returns 1 if so.
337 my @blocks = split(/:/, $_[0]);
338 return 0 if (@blocks == 0 || @blocks > 8);
340 # The address/netmask format is accepted. So we're looking for a "/" to isolate a possible netmask.
341 # After that, we delete the netmask to control the address only format, but we verify whether the netmask
342 # value is in [0;128].
344 my $where = index($blocks[$ib],"/");
347 my $b = substr($blocks[$ib],0,$where);
348 $m = substr($blocks[$ib],$where+1,length($blocks[$ib])-($where+1));
352 # The netmask must take its value in [0;128]
353 return 0 if ($m <0 || $m >128);
355 # Check the different blocks of the address : 16 bits block in hexa notation.
356 # Possibility of 1 empty block or 2 if the address begins with "::".
359 foreach $b (@blocks) {
360 return 0 if ($b ne "" && $b !~ /^[0-9a-f]{1,4}$/i);
361 $empty++ if ($b eq "");
363 return 0 if ($empty > 1 && !($_[0] =~ /^::/ && $empty == 2));
369 =head2 generate_icon(image, title, link, [href], [width], [height], [before-title], [after-title])
371 Prints HTML for an icon image. The parameters are :
373 =item image - URL for the image, like images/foo.gif
375 =item title - Text to appear under the icon
377 =item link - Optional destination for the icon's link
379 =item href - Other HTML attributes to be added to the <a href> for the link
381 =item width - Optional width of the icon
383 =item height - Optional height of the icon
385 =item before-title - HTML to appear before the title link, but which is not actually in the link
387 =item after-title - HTML to appear after the title link, but which is not actually in the link
392 &load_theme_library();
393 if (defined(&theme_generate_icon)) {
394 &theme_generate_icon(@_);
397 my $w = !defined($_[4]) ? "width=48" : $_[4] ? "width=$_[4]" : "";
398 my $h = !defined($_[5]) ? "height=48" : $_[5] ? "height=$_[5]" : "";
399 if ($tconfig{'noicons'}) {
401 print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
404 print "$_[6]$_[1]$_[7]\n";
408 print "<table border><tr><td width=48 height=48>\n",
409 "<a href=\"$_[2]\" $_[3]><img src=\"$_[0]\" alt=\"\" border=0 ",
410 "$w $h></a></td></tr></table>\n";
411 print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
414 print "<table border><tr><td width=48 height=48>\n",
415 "<img src=\"$_[0]\" alt=\"\" border=0 $w $h>",
416 "</td></tr></table>\n$_[6]$_[1]$_[7]\n";
422 Converts a string to a form ok for putting in a URL, using % escaping.
428 $rv =~ s/([^A-Za-z0-9])/sprintf("%%%2.2X", ord($1))/ge;
432 =head2 un_urlize(string)
434 Converts a URL-encoded string to it's original contents - the reverse of the
442 $rv =~ s/%(..)/pack("c",hex($1))/ge;
446 =head2 include(filename)
448 Read and output the contents of the given file.
454 open(INCLUDE, &translate_filename($_[0])) || return 0;
462 =head2 copydata(in-handle, out-handle)
464 Read from one file handle and write to another, until there is no more to read.
470 $in = &callers_package($in);
471 $out = &callers_package($out);
473 while(read($in, $buf, 1024) > 0) {
474 (print $out $buf) || return 0;
479 =head2 ReadParseMime([maximum], [&cbfunc, &cbargs])
481 Read data submitted via a POST request using the multipart/form-data coding,
482 and store it in the global %in hash. The optional parameters are :
484 =item maximum - If the number of bytes of input exceeds this number, stop reading and call error.
486 =item cbfunc - A function reference to call after reading each block of data.
488 =item cbargs - Additional parameters to the callback function.
493 my ($max, $cbfunc, $cbargs) = @_;
494 my ($boundary, $line, $foo, $name, $got, $file);
495 my $err = &text('readparse_max', $max);
496 $ENV{'CONTENT_TYPE'} =~ /boundary=(.*)$/ || &error($text{'readparse_enc'});
497 if ($ENV{'CONTENT_LENGTH'} && $max && $ENV{'CONTENT_LENGTH'} > $max) {
500 &$cbfunc(0, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
502 <STDIN>; # skip first boundary
505 # Read section headers
509 $got += length($line);
510 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, @$cbargs) if ($cbfunc);
511 if ($max && $got > $max) {
516 if ($line =~ /^(\S+):\s*(.*)$/) {
517 $header{$lastheader = lc($1)} = $2;
519 elsif ($line =~ /^\s+(.*)$/) {
520 $header{$lastheader} .= $line;
524 # Parse out filename and type
525 if ($header{'content-disposition'} =~ /^form-data(.*)/) {
527 while ($rest =~ /([a-zA-Z]*)=\"([^\"]*)\"(.*)/) {
532 $foo = $name . "_$1";
539 &error($text{'readparse_cdheader'});
541 if ($header{'content-type'} =~ /^([^\s;]+)/) {
542 $foo = $name . "_content_type";
545 $file = $in{$name."_filename"};
548 $in{$name} .= "\0" if (defined($in{$name}));
551 $got += length($line);
552 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
554 if ($max && $got > $max) {
555 #print STDERR "over limit of $max\n";
560 &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
565 $ptline =~ s/[^a-zA-Z0-9\-]/\./g;
566 if (index($line, $boundary) != -1) { last; }
569 chop($in{$name}); chop($in{$name});
570 if (index($line,"$boundary--") != -1) { last; }
572 &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
575 =head2 ReadParse([&hash], [method], [noplus])
577 Fills the given hash reference with CGI parameters, or uses the global hash
578 %in if none is given. Also sets the global variables $in and @in. The other
581 =item method - For use of this HTTP method, such as GET
583 =item noplus - Don't convert + in parameters to spaces.
588 my $a = $_[0] || \%in;
590 my $meth = $_[1] ? $_[1] : $ENV{'REQUEST_METHOD'};
592 if ($meth eq 'POST') {
593 my $clen = $ENV{'CONTENT_LENGTH'};
594 &read_fully(STDIN, \$in, $clen) == $clen ||
595 &error("Failed to read POST input : $!");
597 if ($ENV{'QUERY_STRING'}) {
598 if ($in) { $in .= "&".$ENV{'QUERY_STRING'}; }
599 else { $in = $ENV{'QUERY_STRING'}; }
601 @in = split(/\&/, $in);
602 foreach my $i (@in) {
603 my ($k, $v) = split(/=/, $i, 2);
608 $k =~ s/%(..)/pack("c",hex($1))/ge;
609 $v =~ s/%(..)/pack("c",hex($1))/ge;
610 $a->{$k} = defined($a->{$k}) ? $a->{$k}."\0".$v : $v;
614 =head2 read_fully(fh, &buffer, length)
616 Read data from some file handle up to the given length, even in the face
617 of partial reads. Reads the number of bytes read. Stores received data in the
618 string pointed to be the buffer reference.
623 my ($fh, $buf, $len) = @_;
624 $fh = &callers_package($fh);
627 my $r = read(STDIN, $$buf, $len-$got, $got);
634 =head2 read_parse_mime_callback(size, totalsize, upload-id)
636 Called by ReadParseMime as new data arrives from a form-data POST. Only updates
637 the file on every 1% change though. For internal use by the upload progress
641 sub read_parse_mime_callback
643 my ($size, $totalsize, $filename, $id) = @_;
644 return if ($gconfig{'no_upload_tracker'});
647 # Create the upload tracking directory - if running as non-root, this has to
648 # be under the user's home
651 my @uinfo = @remote_user_info ? @remote_user_info : getpwuid($<);
652 $vardir = "$uinfo[7]/.tmp";
655 $vardir = $ENV{'WEBMIN_VAR'};
658 &make_dir($vardir, 0755);
661 # Remove any upload.* files more than 1 hour old
662 if (!$main::read_parse_mime_callback_flushed) {
664 opendir(UPDIR, $vardir);
665 foreach my $f (readdir(UPDIR)) {
666 next if ($f !~ /^upload\./);
667 my @st = stat("$vardir/$f");
668 if ($st[9] < $now-3600) {
669 unlink("$vardir/$f");
673 $main::read_parse_mime_callback_flushed++;
676 # Only update file once per percent
677 my $upfile = "$vardir/upload.$id";
678 if ($totalsize && $size >= 0) {
679 my $pc = int(100 * $size / $totalsize);
680 if ($pc <= $main::read_parse_mime_callback_pc{$upfile}) {
683 $main::read_parse_mime_callback_pc{$upfile} = $pc;
687 &open_tempfile(UPFILE, ">$upfile");
688 print UPFILE $size,"\n";
689 print UPFILE $totalsize,"\n";
690 print UPFILE $filename,"\n";
691 &close_tempfile(UPFILE);
694 =head2 read_parse_mime_javascript(upload-id, [&fields])
696 Returns an onSubmit= Javascript statement to popup a window for tracking
697 an upload with the given ID. For internal use by the upload progress tracker.
700 sub read_parse_mime_javascript
702 my ($id, $fields) = @_;
703 return "" if ($gconfig{'no_upload_tracker'});
704 my $opener = "window.open(\"$gconfig{'webprefix'}/uptracker.cgi?id=$id&uid=$<\", \"uptracker\", \"toolbar=no,menubar=no,scrollbars=no,width=500,height=100\");";
706 my $if = join(" || ", map { "typeof($_) != \"undefined\" && $_.value != \"\"" } @$fields);
707 return "onSubmit='if ($if) { $opener }'";
710 return "onSubmit='$opener'";
714 =head2 PrintHeader(charset)
716 Outputs the HTTP headers for an HTML page. The optional charset parameter
717 can be used to set a character set. Normally this function is not called
718 directly, but is rather called by ui_print_header or header.
723 if ($pragma_no_cache || $gconfig{'pragma_no_cache'}) {
724 print "pragma: no-cache\n";
725 print "Expires: Thu, 1 Jan 1970 00:00:00 GMT\n";
726 print "Cache-Control: no-store, no-cache, must-revalidate\n";
727 print "Cache-Control: post-check=0, pre-check=0\n";
729 if (defined($_[0])) {
730 print "Content-type: text/html; Charset=$_[0]\n\n";
733 print "Content-type: text/html\n\n";
737 =head2 header(title, image, [help], [config], [nomodule], [nowebmin], [rightside], [head-stuff], [body-stuff], [below])
739 Outputs a Webmin HTML page header with a title, including HTTP headers. The
742 =item title - The text to show at the top of the page
744 =item image - An image to show instead of the title text. This is typically left blank.
746 =item help - If set, this is the name of a help page that will be linked to in the title.
748 =item config - If set to 1, the title will contain a link to the module's config page.
750 =item nomodule - If set to 1, there will be no link in the title section to the module's index.
752 =item nowebmin - If set to 1, there will be no link in the title section to the Webmin index.
754 =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.
756 =item head-stuff - HTML to be included in the <head> section of the page.
758 =item body-stuff - HTML attributes to be include in the <body> tag.
760 =item below - HTML to be displayed below the title. Typically this is used for application or server version information.
765 return if ($main::done_webmin_header++);
767 my $charset = defined($main::force_charset) ? $main::force_charset
769 &PrintHeader($charset);
770 &load_theme_library();
771 if (defined(&theme_header)) {
772 $module_name = &get_module_name();
774 $miniserv::page_capture = 1;
777 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
780 if (defined(&theme_prehead)) {
784 print "<meta http-equiv=\"Content-Type\" ",
785 "content=\"text/html; Charset="."e_escape($charset)."\">\n";
788 my $title = &get_html_title($_[0]);
789 print "<title>$title</title>\n";
790 print $_[7] if ($_[7]);
791 print &get_html_status_line(0);
793 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
794 if ($tconfig{'headinclude'}) {
795 print &read_file_contents(
796 "$theme_root_directory/$tconfig{'headinclude'}");
799 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
800 defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
801 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
802 defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
803 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
804 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
805 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
807 my $dir = $current_lang_info->{'dir'} ? "dir=\"$current_lang_info->{'dir'}\""
809 print "<body bgcolor=#$bgcolor link=#$link vlink=#$link text=#$text ",
810 "$bgimage $tconfig{'inbody'} $dir $_[8]>\n";
811 if (defined(&theme_prebody)) {
814 my $hostname = &get_display_hostname();
815 my $version = &get_webmin_version();
816 my $prebody = $tconfig{'prebody'};
818 $prebody =~ s/%HOSTNAME%/$hostname/g;
819 $prebody =~ s/%VERSION%/$version/g;
820 $prebody =~ s/%USER%/$remote_user/g;
821 $prebody =~ s/%OS%/$os_type $os_version/g;
824 if ($tconfig{'prebodyinclude'}) {
826 open(INC, "$theme_root_directory/$tconfig{'prebodyinclude'}");
833 print $tconfig{'preheader'};
834 my %this_module_info = &get_module_info(&get_module_name());
835 print "<table class='header' width=100%><tr>\n";
836 if ($gconfig{'sysinfo'} == 2 && $remote_user) {
837 print "<td id='headln1' colspan=3 align=center>\n";
838 print &get_html_status_line(1);
839 print "</td></tr> <tr>\n";
841 print "<td id='headln2l' width=15% valign=top align=left>";
842 if ($ENV{'HTTP_WEBMIN_SERVERS'} && !$tconfig{'framed'}) {
843 print "<a href='$ENV{'HTTP_WEBMIN_SERVERS'}'>",
844 "$text{'header_servers'}</a><br>\n";
846 if (!$_[5] && !$tconfig{'noindex'}) {
847 my @avail = &get_available_module_infos(1);
848 my $nolo = $ENV{'ANONYMOUS_USER'} ||
849 $ENV{'SSL_USER'} || $ENV{'LOCAL_USER'} ||
850 $ENV{'HTTP_USER_AGENT'} =~ /webmin/i;
851 if ($gconfig{'gotoone'} && $main::session_id && @avail == 1 &&
853 print "<a href='$gconfig{'webprefix'}/session_login.cgi?logout=1'>",
854 "$text{'main_logout'}</a><br>";
856 elsif ($gconfig{'gotoone'} && @avail == 1 && !$nolo) {
857 print "<a href=$gconfig{'webprefix'}/switch_user.cgi>",
858 "$text{'main_switch'}</a><br>";
860 elsif (!$gconfig{'gotoone'} || @avail > 1) {
861 print "<a href='$gconfig{'webprefix'}/?cat=",
862 $this_module_info{'category'},
863 "'>$text{'header_webmin'}</a><br>\n";
866 if (!$_[4] && !$tconfig{'nomoduleindex'}) {
867 my $idx = $this_module_info{'index_link'};
868 my $mi = $module_index_link || "/".&get_module_name()."/$idx";
869 my $mt = $module_index_name || $text{'header_module'};
870 print "<a href=\"$gconfig{'webprefix'}$mi\">$mt</a><br>\n";
872 if (ref($_[2]) eq "ARRAY" && !$ENV{'ANONYMOUS_USER'} &&
873 !$tconfig{'nohelp'}) {
874 print &hlink($text{'header_help'}, $_[2]->[0], $_[2]->[1]),
877 elsif (defined($_[2]) && !$ENV{'ANONYMOUS_USER'} &&
878 !$tconfig{'nohelp'}) {
879 print &hlink($text{'header_help'}, $_[2]),"<br>\n";
882 my %access = &get_module_acl();
883 if (!$access{'noconfig'} && !$config{'noprefs'}) {
884 my $cprog = $user_module_config_directory ?
885 "uconfig.cgi" : "config.cgi";
886 print "<a href=\"$gconfig{'webprefix'}/$cprog?",
887 &get_module_name()."\">",
888 $text{'header_config'},"</a><br>\n";
893 # Title is a single image
894 print "<td id='headln2c' align=center width=70%>",
895 "<img alt=\"$_[0]\" src=\"$_[1]\"></td>\n";
899 my $ts = defined($tconfig{'titlesize'}) ?
900 $tconfig{'titlesize'} : "+2";
901 print "<td id='headln2c' align=center width=70%>",
902 ($ts ? "<font size=$ts>" : ""),$_[0],
903 ($ts ? "</font>" : "");
904 print "<br>$_[9]\n" if ($_[9]);
907 print "<td id='headln2r' width=15% valign=top align=right>";
909 print "</td></tr></table>\n";
910 print $tconfig{'postheader'};
912 $miniserv::page_capture = 1;
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 my $host = &get_display_hostname();
927 if ($gconfig{'sysinfo'} == 1 && $remote_user) {
928 $title = sprintf "%s : %s on %s (%s %s)\n",
929 $msg, $remote_user, $host,
930 $os_type, $os_version;
932 elsif ($gconfig{'sysinfo'} == 4 && $remote_user) {
933 $title = sprintf "%s on %s (%s %s)\n",
935 $os_type, $os_version;
940 if ($gconfig{'showlogin'} && $remote_user) {
941 $title = $remote_user.($title ? " : ".$title : "");
943 if ($gconfig{'showhost'}) {
944 $title = $host.($title ? " : ".$title : "");
949 =head2 get_html_framed_title
951 Returns the title text for a framed theme main page.
954 sub get_html_framed_title
957 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
958 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
960 if (($gconfig{'sysinfo'} == 4 || $gconfig{'sysinfo'} == 1) && $remote_user) {
961 # Alternate title mode requested
962 $title = sprintf "%s on %s (%s %s)\n",
963 $remote_user, &get_display_hostname(),
964 $os_type, $os_version;
967 # Title like 'Webmin x.yy on hostname (Linux 6)'
968 if ($os_version eq "*") {
972 $ostr = "$os_type $os_version";
974 my $host = &get_display_hostname();
975 my $ver = &get_webmin_version();
976 $title = $gconfig{'nohostname'} ? $text{'main_title2'} :
977 $gconfig{'showhost'} ? &text('main_title3', $ver, $ostr) :
978 &text('main_title', $ver, $host, $ostr);
979 if ($gconfig{'showlogin'}) {
980 $title = $remote_user.($title ? " : ".$title : "");
982 if ($gconfig{'showhost'}) {
983 $title = $host.($title ? " : ".$title : "");
989 =head2 get_html_status_line(text-only)
991 Returns HTML for a script block that sets the status line, or if text-only
992 is set to 1, just return the status line text.
995 sub get_html_status_line
998 if (($gconfig{'sysinfo'} != 0 || !$remote_user) && !$textonly) {
999 # Disabled in this mode
1002 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
1003 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
1004 my $line = &text('header_statusmsg',
1005 ($ENV{'ANONYMOUS_USER'} ? "Anonymous user"
1007 ($ENV{'SSL_USER'} ? " (SSL certified)" :
1008 $ENV{'LOCAL_USER'} ? " (Local user)" : ""),
1009 $text{'programname'},
1010 &get_webmin_version(),
1011 &get_display_hostname(),
1012 $os_type.($os_version eq "*" ? "" :" $os_version"));
1017 $line =~ s/\r|\n//g;
1018 return "<script language=JavaScript type=text/javascript>\n".
1019 "defaultStatus=\""."e_escape($line)."\";\n".
1024 =head2 popup_header([title], [head-stuff], [body-stuff], [no-body])
1026 Outputs a page header, suitable for a popup window. If no title is given,
1027 absolutely no decorations are output. Also useful in framesets. The parameters
1030 =item title - Title text for the popup window.
1032 =item head-stuff - HTML to appear in the <head> section.
1034 =item body-stuff - HTML attributes to be include in the <body> tag.
1036 =item no-body - If set to 1, don't generate a body tag
1041 return if ($main::done_webmin_header++);
1043 my $charset = defined($main::force_charset) ? $main::force_charset
1045 &PrintHeader($charset);
1046 &load_theme_library();
1047 if (defined(&theme_popup_header)) {
1048 &theme_popup_header(@_);
1049 $miniserv::page_capture = 1;
1052 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
1055 if (defined(&theme_popup_prehead)) {
1056 &theme_popup_prehead(@_);
1058 print "<title>$_[0]</title>\n";
1060 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
1061 if ($tconfig{'headinclude'}) {
1062 print &read_file_contents(
1063 "$theme_root_directory/$tconfig{'headinclude'}");
1066 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
1067 defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
1068 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
1069 defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
1070 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1071 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1072 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
1075 print "<body id='popup' bgcolor=#$bgcolor link=#$link vlink=#$link ",
1076 "text=#$text $bgimage $tconfig{'inbody'} $_[2]>\n";
1077 if (defined(&theme_popup_prebody)) {
1078 &theme_popup_prebody(@_);
1081 $miniserv::page_capture = 1;
1084 =head2 footer([page, name]+, [noendbody])
1086 Outputs the footer for a Webmin HTML page, possibly with links back to other
1087 pages. The links are specified by pairs of parameters, the first of which is
1088 a link destination, and the second the link text. For example :
1090 footer('/', 'Webmin index', '', 'Module menu');
1095 $miniserv::page_capture = 0;
1096 &load_theme_library();
1097 my %this_module_info = &get_module_info(&get_module_name());
1098 if (defined(&theme_footer)) {
1099 $module_name = &get_module_name(); # Old themes use these
1100 %module_info = %this_module_info;
1104 for(my $i=0; $i+1<@_; $i+=2) {
1106 if ($url ne '/' || !$tconfig{'noindex'}) {
1108 $url = "/?cat=$this_module_info{'category'}";
1110 elsif ($url eq '' && &get_module_name()) {
1111 $url = "/".&get_module_name()."/".
1112 $this_module_info{'index_link'};
1114 elsif ($url =~ /^\?/ && &get_module_name()) {
1115 $url = "/".&get_module_name()."/$url";
1117 $url = "$gconfig{'webprefix'}$url" if ($url =~ /^\//);
1119 print "<a href=\"$url\"><img alt=\"<-\" align=middle border=0 src=$gconfig{'webprefix'}/images/left.gif></a>\n";
1124 print " <a href=\"$url\">",&text('main_return', $_[$i+1]),"</a>\n";
1129 my $postbody = $tconfig{'postbody'};
1131 my $hostname = &get_display_hostname();
1132 my $version = &get_webmin_version();
1133 my $os_type = $gconfig{'real_os_type'} ||
1134 $gconfig{'os_type'};
1135 my $os_version = $gconfig{'real_os_version'} ||
1136 $gconfig{'os_version'};
1137 $postbody =~ s/%HOSTNAME%/$hostname/g;
1138 $postbody =~ s/%VERSION%/$version/g;
1139 $postbody =~ s/%USER%/$remote_user/g;
1140 $postbody =~ s/%OS%/$os_type $os_version/g;
1141 print "$postbody\n";
1143 if ($tconfig{'postbodyinclude'}) {
1145 open(INC, "$theme_root_directory/$tconfig{'postbodyinclude'}");
1151 if (defined(&theme_postbody)) {
1152 &theme_postbody(@_);
1154 print "</body></html>\n";
1158 =head2 popup_footer([no-body])
1160 Outputs html for a footer for a popup window, started by popup_header.
1165 $miniserv::page_capture = 0;
1166 &load_theme_library();
1167 if (defined(&theme_popup_footer)) {
1168 &theme_popup_footer(@_);
1177 =head2 load_theme_library
1179 Immediately loads the current theme's theme.pl file. Not generally useful for
1180 most module developers, as this is called automatically by the header function.
1183 sub load_theme_library
1185 return if (!$current_theme || $loaded_theme_library++);
1186 for(my $i=0; $i<@theme_root_directories; $i++) {
1187 if ($theme_configs[$i]->{'functions'}) {
1188 do $theme_root_directories[$i]."/".
1189 $theme_configs[$i]->{'functions'};
1194 =head2 redirect(url)
1196 Output HTTP headers to redirect the browser to some page. The url parameter is
1197 typically a relative URL like index.cgi or list_users.cgi.
1202 my $port = $ENV{'SERVER_PORT'} == 443 && uc($ENV{'HTTPS'}) eq "ON" ? "" :
1203 $ENV{'SERVER_PORT'} == 80 && uc($ENV{'HTTPS'}) ne "ON" ? "" :
1204 ":$ENV{'SERVER_PORT'}";
1205 my $prot = uc($ENV{'HTTPS'}) eq "ON" ? "https" : "http";
1206 my $wp = $gconfig{'webprefixnoredir'} ? undef : $gconfig{'webprefix'};
1208 if ($_[0] =~ /^(http|https|ftp|gopher):/) {
1209 # Absolute URL (like http://...)
1212 elsif ($_[0] =~ /^\//) {
1213 # Absolute path (like /foo/bar.cgi)
1214 $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$_[0]";
1216 elsif ($ENV{'SCRIPT_NAME'} =~ /^(.*)\/[^\/]*$/) {
1217 # Relative URL (like foo.cgi)
1218 $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$1/$_[0]";
1221 $url = "$prot://$ENV{'SERVER_NAME'}$port/$wp$_[0]";
1223 &load_theme_library();
1224 if (defined(&theme_redirect)) {
1225 $module_name = &get_module_name(); # Old themes use these
1226 %module_info = &get_module_info($module_name);
1227 &theme_redirect($_[0], $url);
1230 print "Location: $url\n\n";
1234 =head2 kill_byname(name, signal)
1236 Finds a process whose command line contains the given name (such as httpd), and
1237 sends some signal to it. The signal can be numeric (like 9) or named
1243 my @pids = &find_byname($_[0]);
1244 return scalar(@pids) if (&is_readonly_mode());
1245 &webmin_debug_log('KILL', "signal=$_[1] name=$_[0]")
1246 if ($gconfig{'debug_what_procs'});
1247 if (@pids) { kill($_[1], @pids); return scalar(@pids); }
1251 =head2 kill_byname_logged(name, signal)
1253 Like kill_byname, but also logs the killing.
1256 sub kill_byname_logged
1258 my @pids = &find_byname($_[0]);
1259 return scalar(@pids) if (&is_readonly_mode());
1260 if (@pids) { &kill_logged($_[1], @pids); return scalar(@pids); }
1264 =head2 find_byname(name)
1266 Finds processes searching for the given name in their command lines, and
1267 returns a list of matching PIDs.
1272 if ($gconfig{'os_type'} =~ /-linux$/ && -r "/proc/$$/cmdline") {
1273 # Linux with /proc filesystem .. use cmdline files, as this is
1274 # faster than forking
1276 opendir(PROCDIR, "/proc");
1277 foreach my $f (readdir(PROCDIR)) {
1278 if ($f eq int($f) && $f != $$) {
1279 my $line = &read_file_contents("/proc/$f/cmdline");
1280 if ($line =~ /$_[0]/) {
1289 if (&foreign_check("proc")) {
1290 # Call the proc module
1291 &foreign_require("proc", "proc-lib.pl");
1292 if (defined(&proc::list_processes)) {
1293 my @procs = &proc::list_processes();
1295 foreach my $p (@procs) {
1296 if ($p->{'args'} =~ /$_[0]/) {
1297 push(@pids, $p->{'pid'});
1300 @pids = grep { $_ != $$ } @pids;
1305 # Fall back to running a command
1307 $cmd = $gconfig{'find_pid_command'};
1308 $cmd =~ s/NAME/"$_[0]"/g;
1309 $cmd = &translate_command($cmd);
1310 @pids = split(/\n/, `($cmd) <$null_file 2>$null_file`);
1311 @pids = grep { $_ != $$ } @pids;
1315 =head2 error([message]+)
1317 Display an error message and exit. This should be used by CGI scripts that
1318 encounter a fatal error or invalid user input to notify users of the problem.
1319 If error_setup has been called, the displayed error message will be prefixed
1320 by the message setup using that function.
1325 $main::no_miniserv_userdb = 1;
1326 my $msg = join("", @_);
1327 $msg =~ s/<[^>]*>//g;
1328 if (!$main::error_must_die) {
1329 print STDERR "Error: ",$msg,"\n";
1331 &load_theme_library();
1332 if ($main::error_must_die) {
1333 if ($gconfig{'error_stack'}) {
1334 print STDERR "Error: ",$msg,"\n";
1335 for(my $i=0; my @stack = caller($i); $i++) {
1336 print STDERR "File: $stack[1] Line: $stack[2] ",
1337 "Function: $stack[3]\n";
1342 elsif (!$ENV{'REQUEST_METHOD'}) {
1343 # Show text-only error
1344 print STDERR "$text{'error'}\n";
1345 print STDERR "-----\n";
1346 print STDERR ($main::whatfailed ? "$main::whatfailed : " : ""),
1348 print STDERR "-----\n";
1349 if ($gconfig{'error_stack'}) {
1351 print STDERR $text{'error_stack'},"\n";
1352 for(my $i=0; my @stack = caller($i); $i++) {
1353 print STDERR &text('error_stackline',
1354 $stack[1], $stack[2], $stack[3]),"\n";
1359 elsif (defined(&theme_error)) {
1363 &header($text{'error'}, "");
1365 print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),
1367 if ($gconfig{'error_stack'}) {
1369 print "<h3>$text{'error_stack'}</h3>\n";
1371 print "<tr> <td><b>$text{'error_file'}</b></td> ",
1372 "<td><b>$text{'error_line'}</b></td> ",
1373 "<td><b>$text{'error_sub'}</b></td> </tr>\n";
1374 for($i=0; my @stack = caller($i); $i++) {
1376 print "<td>$stack[1]</td>\n";
1377 print "<td>$stack[2]</td>\n";
1378 print "<td>$stack[3]</td>\n";
1384 if ($ENV{'HTTP_REFERER'} && $main::completed_referers_check) {
1385 &footer($ENV{'HTTP_REFERER'}, $text{'error_previous'});
1391 &unlock_all_files();
1392 &cleanup_tempnames();
1396 =head2 popup_error([message]+)
1398 This function is almost identical to error, but displays the message with HTML
1399 headers suitable for a popup window.
1404 $main::no_miniserv_userdb = 1;
1405 &load_theme_library();
1406 if ($main::error_must_die) {
1409 elsif (defined(&theme_popup_error)) {
1410 &theme_popup_error(@_);
1413 &popup_header($text{'error'}, "");
1414 print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),@_,"</h3>\n";
1417 &unlock_all_files();
1418 &cleanup_tempnames();
1422 =head2 error_setup(message)
1424 Registers a message to be prepended to all error messages displayed by the
1430 $main::whatfailed = $_[0];
1433 =head2 wait_for(handle, regexp, regexp, ...)
1435 Reads from the input stream until one of the regexps matches, and returns the
1436 index of the matching regexp, or -1 if input ended before any matched. This is
1437 very useful for parsing the output of interactive programs, and can be used with
1438 a two-way pipe to feed input to a program in response to output matched by
1441 If the matching regexp contains bracketed sub-expressions, their values will
1442 be placed in the global array @matches, indexed starting from 1. You cannot
1443 use the Perl variables $1, $2 and so on to capture matches.
1447 $rv = wait_for($loginfh, "username:");
1449 error("Didn't get username prompt");
1451 print $loginfh "joe\n";
1452 $rv = wait_for($loginfh, "password:");
1454 error("Didn't get password prompt");
1456 print $loginfh "smeg\n";
1461 my ($c, $i, $sw, $rv, $ha);
1462 undef($wait_for_input);
1463 if ($wait_for_debug) {
1464 print STDERR "wait_for(",join(",", @_),")\n";
1466 $ha = &callers_package($_[0]);
1467 if ($wait_for_debug) {
1468 print STDERR "File handle=$ha fd=",fileno($ha),"\n";
1473 " if ((\$c = getc(\$ha)) eq \"\") { return -1; }\n".
1474 " \$wait_for_input .= \$c;\n";
1475 if ($wait_for_debug) {
1476 $codes .= "print STDERR \$wait_for_input,\"\\n\";";
1478 for($i=1; $i<@_; $i++) {
1479 $sw = $i>1 ? "elsif" : "if";
1480 $codes .= " $sw (\$wait_for_input =~ /$_[$i]/i) { \$hit = $i-1; }\n";
1483 " if (defined(\$hit)) {\n".
1484 " \@matches = (-1, \$1, \$2, \$3, \$4, \$5, \$6, \$7, \$8, \$9);\n".
1490 &error("wait_for error : $@\n");
1495 =head2 fast_wait_for(handle, string, string, ...)
1497 This function behaves very similar to wait_for (documented above), but instead
1498 of taking regular expressions as parameters, it takes strings. As soon as the
1499 input contains one of them, it will return the index of the matching string.
1500 If the input ends before any match, it returns -1.
1505 my ($inp, $maxlen, $ha, $i, $c, $inpl);
1506 for($i=1; $i<@_; $i++) {
1507 $maxlen = length($_[$i]) > $maxlen ? length($_[$i]) : $maxlen;
1511 if (($c = getc($ha)) eq "") {
1512 &error("fast_wait_for read error : $!");
1515 if (length($inp) > $maxlen) {
1516 $inp = substr($inp, length($inp)-$maxlen);
1518 $inpl = length($inp);
1519 for($i=1; $i<@_; $i++) {
1520 if ($_[$i] eq substr($inp, $inpl-length($_[$i]))) {
1527 =head2 has_command(command)
1529 Returns the full path to the executable if some command is in the path, or
1530 undef if not found. If the given command is already an absolute path and
1531 exists, then the same path will be returned.
1536 if (!$_[0]) { return undef; }
1537 if (exists($main::has_command_cache{$_[0]})) {
1538 return $main::has_command_cache{$_[0]};
1541 my $slash = $gconfig{'os_type'} eq 'windows' ? '\\' : '/';
1542 if ($_[0] =~ /^\// || $_[0] =~ /^[a-z]:[\\\/]/i) {
1543 # Absolute path given - just use it
1544 my $t = &translate_filename($_[0]);
1545 $rv = (-x $t && !-d _) ? $_[0] : undef;
1548 # Check each directory in the path
1550 foreach my $d (split($path_separator, $ENV{'PATH'})) {
1551 next if ($donedir{$d}++);
1552 $d =~ s/$slash$// if ($d ne $slash);
1553 my $t = &translate_filename("$d/$_[0]");
1554 if (-x $t && !-d _) {
1555 $rv = $d.$slash.$_[0];
1558 if ($gconfig{'os_type'} eq 'windows') {
1559 foreach my $sfx (".exe", ".com", ".bat") {
1560 my $t = &translate_filename("$d/$_[0]").$sfx;
1561 if (-r $t && !-d _) {
1562 $rv = $d.$slash.$_[0].$sfx;
1569 $main::has_command_cache{$_[0]} = $rv;
1573 =head2 make_date(seconds, [date-only], [fmt])
1575 Converts a Unix date/time in seconds to a human-readable form, by default
1576 formatted like dd/mmm/yyyy hh:mm:ss. Parameters are :
1578 =item seconds - Unix time is seconds to convert.
1580 =item date-only - If set to 1, exclude the time from the returned string.
1582 =item fmt - Optional, one of dd/mon/yyyy, dd/mm/yyyy, mm/dd/yyyy or yyyy/mm/dd
1587 my ($secs, $only, $fmt) = @_;
1588 my @tm = localtime($secs);
1591 $fmt = $gconfig{'dateformat'} || 'dd/mon/yyyy';
1593 if ($fmt eq 'dd/mon/yyyy') {
1594 $date = sprintf "%2.2d/%s/%4.4d",
1595 $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900;
1597 elsif ($fmt eq 'dd/mm/yyyy') {
1598 $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[3], $tm[4]+1, $tm[5]+1900;
1600 elsif ($fmt eq 'mm/dd/yyyy') {
1601 $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[4]+1, $tm[3], $tm[5]+1900;
1603 elsif ($fmt eq 'yyyy/mm/dd') {
1604 $date = sprintf "%4.4d/%2.2d/%2.2d", $tm[5]+1900, $tm[4]+1, $tm[3];
1606 elsif ($fmt eq 'd. mon yyyy') {
1607 $date = sprintf "%d. %s %4.4d",
1608 $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900;
1610 elsif ($fmt eq 'dd.mm.yyyy') {
1611 $date = sprintf "%2.2d.%2.2d.%4.4d", $tm[3], $tm[4]+1, $tm[5]+1900;
1613 elsif ($fmt eq 'yyyy-mm-dd') {
1614 $date = sprintf "%4.4d-%2.2d-%2.2d", $tm[5]+1900, $tm[4]+1, $tm[3];
1617 $date .= sprintf " %2.2d:%2.2d", $tm[2], $tm[1];
1622 =head2 file_chooser_button(input, type, [form], [chroot], [addmode])
1624 Return HTML for a button that pops up a file chooser when clicked, and places
1625 the selected filename into another HTML field. The parameters are :
1627 =item input - Name of the form field to store the filename in.
1629 =item type - 0 for file or directory chooser, or 1 for directory only.
1631 =item form - Index of the form containing the button.
1633 =item chroot - If set to 1, the chooser will be limited to this directory.
1635 =item addmode - If set to 1, the selected filename will be appended to the text box instead of replacing it's contents.
1638 sub file_chooser_button
1640 return &theme_file_chooser_button(@_)
1641 if (defined(&theme_file_chooser_button));
1642 my $form = defined($_[2]) ? $_[2] : 0;
1643 my $chroot = defined($_[3]) ? $_[3] : "/";
1644 my $add = int($_[4]);
1645 my ($w, $h) = (400, 300);
1646 if ($gconfig{'db_sizefile'}) {
1647 ($w, $h) = split(/x/, $gconfig{'db_sizefile'});
1649 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";
1652 =head2 popup_window_button(url, width, height, scrollbars?, &field-mappings)
1654 Returns HTML for a button that will popup a chooser window of some kind. The
1657 =item url - Base URL of the popup window's contents
1659 =item width - Width of the window in pixels
1661 =item height - Height in pixels
1663 =item scrollbars - Set to 1 if the window should have scrollbars
1665 The field-mappings parameter is an array ref of array refs containing
1667 =item - Attribute to assign field to in the popup window
1669 =item - Form field name
1671 =item - CGI parameter to URL for value, if any
1674 sub popup_window_button
1676 return &theme_popup_window_button(@_) if (defined(&theme_popup_window_button));
1677 my ($url, $w, $h, $scroll, $fields) = @_;
1678 my $scrollyn = $scroll ? "yes" : "no";
1679 my $rv = "<input type=button onClick='";
1680 foreach my $m (@$fields) {
1681 $rv .= "$m->[0] = form.$m->[1]; ";
1683 my $sep = $url =~ /\?/ ? "&" : "?";
1684 $rv .= "chooser = window.open(\"$url\"";
1685 foreach my $m (@$fields) {
1687 $rv .= "+\"$sep$m->[2]=\"+escape($m->[0].value)";
1691 $rv .= ", \"chooser\", \"toolbar=no,menubar=no,scrollbars=$scrollyn,resizable=yes,width=$w,height=$h\"); ";
1692 foreach my $m (@$fields) {
1693 $rv .= "chooser.$m->[0] = $m->[0]; ";
1694 $rv .= "window.$m->[0] = $m->[0]; ";
1696 $rv .= "' value=\"...\">";
1700 =head2 read_acl(&user-module-hash, &user-list-hash, [&only-users])
1702 Reads the Webmin acl file into the given hash references. The first is indexed
1703 by a combined key of username,module , with the value being set to 1 when
1704 the user has access to that module. The second is indexed by username, with
1705 the value being an array ref of allowed modules.
1707 This function is deprecated in favour of foreign_available, which performs a
1708 more comprehensive check of module availability.
1710 If the only-users array ref parameter is given, the results may be limited to
1711 users in that list of names.
1716 my ($usermod, $userlist, $only) = @_;
1717 if (!%main::acl_hash_cache) {
1718 # Read from local files
1720 open(ACL, &acl_filename());
1722 if (/^([^:]+):\s*(.*)/) {
1724 my @mods = split(/\s+/, $2);
1725 foreach my $m (@mods) {
1726 $main::acl_hash_cache{$user,$m}++;
1728 $main::acl_array_cache{$user} = \@mods;
1733 %$usermod = %main::acl_hash_cache if ($usermod);
1734 %$userlist = %main::acl_array_cache if ($userlist);
1737 my $userdb = &get_userdb_string();
1738 my ($dbh, $proto, $prefix, $args) =
1739 $userdb ? &connect_userdb($userdb) : ( );
1741 if ($proto eq "mysql" || $proto eq "postgresql") {
1742 # Select usernames and modules from SQL DB
1743 my $cmd = $dbh->prepare(
1744 "select webmin_user.name,webmin_user_attr.value ".
1745 "from webmin_user,webmin_user_attr ".
1746 "where webmin_user.id = webmin_user_attr.id ".
1747 "and webmin_user_attr.attr = 'modules' ".
1748 ($only ? " and webmin_user.name in (".
1749 join(",", map { "'$_'" } @$only).")" : ""));
1750 if ($cmd && $cmd->execute()) {
1751 while(my ($user, $mods) = $cmd->fetchrow()) {
1752 my @mods = split(/\s+/, $mods);
1753 foreach my $m (@mods) {
1754 $usermod->{$user,$m}++ if ($usermod);
1756 $userlist->{$user} = \@mods if ($userlist);
1759 $cmd->finish() if ($cmd);
1761 elsif ($proto eq "ldap") {
1762 # Find users in LDAP
1763 my $filter = '(objectClass='.$args->{'userclass'}.')';
1766 "(|".join("", map { "(cn=$_)" } @$only).")";
1767 $filter = "(&".$filter.$ufilter.")";
1769 my $rv = $dbh->search(
1773 attrs => [ 'cn', 'webminModule' ]);
1774 if ($rv && !$rv->code) {
1775 foreach my $u ($rv->all_entries) {
1776 my $user = $u->get_value('cn');
1777 my @mods =$u->get_value('webminModule');
1778 foreach my $m (@mods) {
1779 $usermod->{$user,$m}++ if ($usermod);
1781 $userlist->{$user} = \@mods if ($userlist);
1785 &disconnect_userdb($userdb, $dbh);
1791 Returns the file containing the webmin ACL, which is usually
1792 /etc/webmin/webmin.acl.
1797 return "$config_directory/webmin.acl";
1802 Does nothing, but kept around for compatability.
1809 =head2 get_miniserv_config(&hash)
1811 Reads the Webmin webserver's (miniserv.pl) configuration file, usually located
1812 at /etc/webmin/miniserv.conf, and stores its names and values in the given
1816 sub get_miniserv_config
1818 return &read_file_cached(
1819 $ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf", $_[0]);
1822 =head2 put_miniserv_config(&hash)
1824 Writes out the Webmin webserver configuration file from the contents of
1825 the given hash ref. This should be initially populated by get_miniserv_config,
1828 get_miniserv_config(\%miniserv);
1829 $miniserv{'port'} = 10005;
1830 put_miniserv_config(\%miniserv);
1834 sub put_miniserv_config
1836 &write_file($ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf",
1840 =head2 restart_miniserv([nowait])
1842 Kill the old miniserv process and re-start it, then optionally waits for
1843 it to restart. This will apply all configuration settings.
1846 sub restart_miniserv
1849 return undef if (&is_readonly_mode());
1851 &get_miniserv_config(\%miniserv) || return;
1854 if ($gconfig{'os_type'} ne 'windows') {
1855 # On Unix systems, we can restart with a signal
1856 my ($pid, $addr, $i);
1857 $miniserv{'inetd'} && return;
1858 my @oldst = stat($miniserv{'pidfile'});
1859 $pid = $ENV{'MINISERV_PID'};
1861 open(PID, $miniserv{'pidfile'}) ||
1862 &error("Failed to open PID file $miniserv{'pidfile'}");
1865 $pid || &error("Invalid PID file $miniserv{'pidfile'}");
1868 # Just signal miniserv to restart
1869 &kill_logged('HUP', $pid) || &error("Incorrect Webmin PID $pid");
1871 # Wait till new PID is written, indicating a restart
1872 for($i=0; $i<60; $i++) {
1874 my @newst = stat($miniserv{'pidfile'});
1875 last if ($newst[9] != $oldst[9]);
1877 $i < 60 || &error("Webmin server did not write new PID file");
1879 ## Totally kill the process and re-run it
1880 #$SIG{'TERM'} = 'IGNORE';
1881 #&kill_logged('TERM', $pid);
1882 #&system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1885 # On Windows, we need to use the flag file
1886 open(TOUCH, ">$miniserv{'restartflag'}");
1891 # Wait for miniserv to come back up
1892 my $addr = $miniserv{'bind'} || "127.0.0.1";
1894 for($i=0; $i<20; $i++) {
1897 &open_socket($addr, $miniserv{'port'}, STEST, \$err);
1899 last if (!$err && ++$ok >= 2);
1901 $i < 20 || &error("Failed to restart Webmin server!");
1905 =head2 reload_miniserv
1907 Sends a USR1 signal to the miniserv process, telling it to read-read it's
1908 configuration files. Not all changes will be applied though, such as the
1909 IP addresses and ports to accept connections on.
1914 return undef if (&is_readonly_mode());
1916 &get_miniserv_config(\%miniserv) || return;
1918 if ($gconfig{'os_type'} ne 'windows') {
1919 # Send a USR1 signal to re-read the config
1920 my ($pid, $addr, $i);
1921 $miniserv{'inetd'} && return;
1922 $pid = $ENV{'MINISERV_PID'};
1924 open(PID, $miniserv{'pidfile'}) ||
1925 &error("Failed to open PID file $miniserv{'pidfile'}");
1928 $pid || &error("Invalid PID file $miniserv{'pidfile'}");
1930 &kill_logged('USR1', $pid) || &error("Incorrect Webmin PID $pid");
1932 # Make sure this didn't kill Webmin!
1934 if (!kill(0, $pid)) {
1935 print STDERR "USR1 signal killed Webmin - restarting\n";
1936 &system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1940 # On Windows, we need to use the flag file
1941 open(TOUCH, ">$miniserv{'reloadflag'}");
1946 =head2 check_os_support(&minfo, [os-type, os-version], [api-only])
1948 Returns 1 if some module is supported on the current operating system, or the
1949 OS supplies as parameters. The parameters are :
1951 =item minfo - A hash ref of module information, as returned by get_module_info
1953 =item os-type - The Webmin OS code to use instead of the system's real OS, such as redhat-linux
1955 =item os-version - The Webmin OS version to use, such as 13.0
1957 =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.
1960 sub check_os_support
1962 my $oss = $_[0]->{'os_support'};
1963 if ($_[3] && $oss && $_[0]->{'api_os_support'}) {
1964 # May provide usable API
1965 $oss .= " ".$_[0]->{'api_os_support'};
1967 if ($_[0]->{'nozone'} && &running_in_zone()) {
1968 # Not supported in a Solaris Zone
1971 if ($_[0]->{'novserver'} && &running_in_vserver()) {
1972 # Not supported in a Linux Vserver
1975 if ($_[0]->{'noopenvz'} && &running_in_openvz()) {
1976 # Not supported in an OpenVZ container
1979 return 1 if (!$oss || $oss eq '*');
1980 my $osver = $_[2] || $gconfig{'os_version'};
1981 my $ostype = $_[1] || $gconfig{'os_type'};
1984 my ($os, $ver, $codes);
1985 my ($neg) = ($oss =~ s/^!//); # starts with !
1986 $anyneg++ if ($neg);
1987 if ($oss =~ /^([^\/\s]+)\/([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
1989 $os = $1; $ver = $2; $codes = $3; $oss = $4;
1991 elsif ($oss =~ /^([^\/\s]+)\/([^\/\s]+)\s*(.*)$/) {
1993 $os = $1; $ver = $2; $oss = $3;
1995 elsif ($oss =~ /^([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
1997 $os = $1; $codes = $2; $oss = $3;
1999 elsif ($oss =~ /^\{([^\}]*)\}\s*(.*)$/) {
2001 $codes = $1; $oss = $2;
2003 elsif ($oss =~ /^(\S+)\s*(.*)$/) {
2005 $os = $1; $oss = $2;
2008 next if ($os && !($os eq $ostype ||
2009 $ostype =~ /^(\S+)-(\S+)$/ && $os eq "*-$2"));
2010 if ($ver =~ /^([0-9\.]+)\-([0-9\.]+)$/) {
2011 next if ($osver < $1 || $osver > $2);
2013 elsif ($ver =~ /^([0-9\.]+)\-\*$/) {
2014 next if ($osver < $1);
2016 elsif ($ver =~ /^\*\-([0-9\.]+)$/) {
2017 next if ($osver > $1);
2020 next if ($ver ne $osver);
2022 next if ($codes && !eval $codes);
2028 =head2 http_download(host, port, page, destfile, [&error], [&callback], [sslmode], [user, pass], [timeout], [osdn-convert], [no-cache], [&headers])
2030 Downloads data from a HTTP url to a local file or string. The parameters are :
2032 =item host - The hostname part of the URL, such as www.google.com
2034 =item port - The HTTP port number, such as 80
2036 =item page - The filename part of the URL, like /index.html
2038 =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.
2040 =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.
2042 =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.
2044 =item sslmode - If set to 1, an HTTPS connection is used instead of HTTP.
2046 =item user - If set, HTTP authentication is done with this username.
2048 =item pass - The HTTP password to use with the username above.
2050 =item timeout - A timeout in seconds to wait for the TCP connection to be established before failing.
2052 =item osdn-convert - If set to 1, URL for downloads from sourceforge are converted to use an appropriate mirror site.
2054 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
2056 =item headers - If set to a hash ref of additional HTTP headers, they will be added to the request.
2061 my ($host, $port, $page, $dest, $error, $cbfunc, $ssl, $user, $pass,
2062 $timeout, $osdn, $nocache, $headers) = @_;
2063 if ($gconfig{'debug_what_net'}) {
2064 &webmin_debug_log('HTTP', "host=$host port=$port page=$page ssl=$ssl".
2065 ($user ? " user=$user pass=$pass" : "").
2066 (ref($dest) ? "" : " dest=$dest"));
2069 # Convert OSDN URL first
2070 my $prot = $ssl ? "https://" : "http://";
2071 my $portstr = $ssl && $port == 443 ||
2072 !$ssl && $port == 80 ? "" : ":$port";
2073 ($host, $port, $page, $ssl) = &parse_http_url(
2074 &convert_osdn_url($prot.$host.$portstr.$page));
2077 # Check if we already have cached the URL
2078 my $url = ($ssl ? "https://" : "http://").$host.":".$port.$page;
2079 my $cfile = &check_in_http_cache($url);
2080 if ($cfile && !$nocache) {
2081 # Yes! Copy to dest file or variable
2082 &$cbfunc(6, $url) if ($cbfunc);
2084 &open_readfile(CACHEFILE, $cfile);
2086 $$dest = <CACHEFILE>;
2090 ©_source_dest($cfile, $dest);
2097 push(@headers, [ "Host", $host ]);
2098 push(@headers, [ "User-agent", "Webmin" ]);
2099 push(@headers, [ "Accept-language", "en" ]);
2101 my $auth = &encode_base64("$user:$pass");
2102 $auth =~ tr/\r\n//d;
2103 push(@headers, [ "Authorization", "Basic $auth" ]);
2105 foreach my $hname (keys %$headers) {
2106 push(@headers, [ $hname, $headers->{$hname} ]);
2109 # Actually download it
2110 $main::download_timed_out = undef;
2111 local $SIG{ALRM} = \&download_timeout;
2112 alarm($timeout || 60);
2113 my $h = &make_http_connection($host, $port, $ssl, "GET", $page, \@headers);
2115 $h = $main::download_timed_out if ($main::download_timed_out);
2117 if ($error) { $$error = $h; return; }
2118 else { &error($h); }
2120 &complete_http_download($h, $dest, $error, $cbfunc, $osdn, $host, $port,
2121 $headers, $ssl, $nocache);
2122 if ((!$error || !$$error) && !$nocache) {
2123 &write_to_http_cache($url, $dest);
2127 =head2 complete_http_download(handle, destfile, [&error], [&callback], [osdn], [oldhost], [oldport], [&send-headers], [old-ssl], [no-cache])
2129 Do a HTTP download, after the headers have been sent. For internal use only,
2130 typically called by http_download.
2133 sub complete_http_download
2135 local ($line, %header, @headers, $s); # Kept local so that callback funcs
2141 ($line = &read_http_connection($_[0])) =~ tr/\r\n//d;
2142 if ($line !~ /^HTTP\/1\..\s+(200|30[0-9])(\s+|$)/) {
2144 if ($_[2]) { ${$_[2]} = $line; return; }
2145 else { &error("Download failed : $line"); }
2148 &$cbfunc(1, $rcode >= 300 && $rcode < 400 ? 1 : 0)
2151 $line = &read_http_connection($_[0]);
2152 $line =~ tr/\r\n//d;
2153 $line =~ /^(\S+):\s+(.*)$/ || last;
2154 $header{lc($1)} = $2;
2155 push(@headers, [ lc($1), $2 ]);
2158 if ($main::download_timed_out) {
2159 if ($_[2]) { ${$_[2]} = $main::download_timed_out; return 0; }
2160 else { &error($main::download_timed_out); }
2162 &$cbfunc(2, $header{'content-length'}) if ($cbfunc);
2163 if ($rcode >= 300 && $rcode < 400) {
2164 # follow the redirect
2165 &$cbfunc(5, $header{'location'}) if ($cbfunc);
2166 my ($host, $port, $page, $ssl);
2167 if ($header{'location'} =~ /^(http|https):\/\/([^:]+):(\d+)(\/.*)?$/) {
2168 $ssl = $1 eq 'https' ? 1 : 0;
2169 $host = $2; $port = $3; $page = $4 || "/";
2171 elsif ($header{'location'} =~ /^(http|https):\/\/([^:\/]+)(\/.*)?$/) {
2172 $ssl = $1 eq 'https' ? 1 : 0;
2173 $host = $2; $port = 80; $page = $3 || "/";
2175 elsif ($header{'location'} =~ /^\// && $_[5]) {
2176 # Relative to same server
2180 $page = $header{'location'};
2182 elsif ($header{'location'}) {
2183 # Assume relative to same dir .. not handled
2184 if ($_[2]) { ${$_[2]} = "Invalid Location header $header{'location'}"; return; }
2185 else { &error("Invalid Location header $header{'location'}"); }
2188 if ($_[2]) { ${$_[2]} = "Missing Location header"; return; }
2189 else { &error("Missing Location header"); }
2192 ($page, $params) = split(/\?/, $page);
2194 $page .= "?".$params if (defined($params));
2195 &http_download($host, $port, $page, $_[1], $_[2], $cbfunc, $ssl,
2196 undef, undef, undef, $_[4], $_[9], $_[7]);
2201 # Append to a variable
2202 while(defined($buf = &read_http_connection($_[0], 1024))) {
2204 &$cbfunc(3, length(${$_[1]})) if ($cbfunc);
2210 if (!&open_tempfile(PFILE, ">$_[1]", 1)) {
2211 if ($_[2]) { ${$_[2]} = "Failed to write to $_[1] : $!"; return; }
2212 else { &error("Failed to write to $_[1] : $!"); }
2214 binmode(PFILE); # For windows
2215 while(defined($buf = &read_http_connection($_[0], 1024))) {
2216 &print_tempfile(PFILE, $buf);
2217 $got += length($buf);
2218 &$cbfunc(3, $got) if ($cbfunc);
2220 &close_tempfile(PFILE);
2221 if ($header{'content-length'} &&
2222 $got != $header{'content-length'}) {
2223 if ($_[2]) { ${$_[2]} = "Download incomplete"; return; }
2224 else { &error("Download incomplete"); }
2227 &$cbfunc(4) if ($cbfunc);
2229 &close_http_connection($_[0]);
2233 =head2 ftp_download(host, file, destfile, [&error], [&callback], [user, pass], [port])
2235 Download data from an FTP site to a local file. The parameters are :
2237 =item host - FTP server hostname
2239 =item file - File on the FTP server to download
2241 =item destfile - File on the Webmin system to download data to
2243 =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.
2245 =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.
2247 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2249 =item pass - Password for the username above.
2251 =item port - FTP server port number, which defaults to 21 if not set.
2256 my ($host, $file, $dest, $error, $cbfunc, $user, $pass, $port) = @_;
2258 if ($gconfig{'debug_what_net'}) {
2259 &webmin_debug_log('FTP', "host=$host port=$port file=$file".
2260 ($user ? " user=$user pass=$pass" : "").
2261 (ref($dest) ? "" : " dest=$dest"));
2265 if (&is_readonly_mode()) {
2266 if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2268 else { &error("FTP connections not allowed in readonly mode"); }
2271 # Check if we already have cached the URL
2272 my $url = "ftp://".$host.$file;
2273 my $cfile = &check_in_http_cache($url);
2275 # Yes! Copy to dest file or variable
2276 &$cbfunc(6, $url) if ($cbfunc);
2278 &open_readfile(CACHEFILE, $cfile);
2280 $$dest = <CACHEFILE>;
2284 ©_source_dest($cfile, $dest);
2289 # Actually download it
2290 $main::download_timed_out = undef;
2291 local $SIG{ALRM} = \&download_timeout;
2294 if ($gconfig{'ftp_proxy'} =~ /^http:\/\/(\S+):(\d+)/ && !&no_proxy($_[0])) {
2295 # download through http-style proxy
2297 if (&open_socket($1, $2, "SOCK", \$error)) {
2299 if ($main::download_timed_out) {
2301 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2302 else { &error($main::download_timed_out); }
2304 my $esc = $_[1]; $esc =~ s/ /%20/g;
2305 my $up = "$_[5]:$_[6]\@" if ($_[5]);
2306 my $portstr = $port == 21 ? "" : ":$port";
2307 print SOCK "GET ftp://$up$_[0]$portstr$esc HTTP/1.0\r\n";
2308 print SOCK "User-agent: Webmin\r\n";
2309 if ($gconfig{'proxy_user'}) {
2310 my $auth = &encode_base64(
2311 "$gconfig{'proxy_user'}:$gconfig{'proxy_pass'}");
2312 $auth =~ tr/\r\n//d;
2313 print SOCK "Proxy-Authorization: Basic $auth\r\n";
2316 &complete_http_download({ 'fh' => "SOCK" }, $_[2], $_[3], $_[4]);
2319 elsif (!$gconfig{'proxy_fallback'}) {
2321 if ($error) { $$error = $main::download_timed_out; return 0; }
2322 else { &error($main::download_timed_out); }
2327 # connect to host and login with real FTP protocol
2328 &open_socket($_[0], $port, "SOCK", $_[3]) || return 0;
2330 if ($main::download_timed_out) {
2331 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2332 else { &error($main::download_timed_out); }
2334 &ftp_command("", 2, $_[3]) || return 0;
2336 # Login as supplied user
2337 my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2339 if (int($urv[1]/100) == 3) {
2340 &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2344 # Login as anonymous
2345 my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2347 if (int($urv[1]/100) == 3) {
2348 &ftp_command("PASS root\@".&get_system_hostname(), 2,
2352 &$cbfunc(1, 0) if ($cbfunc);
2355 # get the file size and tell the callback
2356 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2357 my $size = &ftp_command("SIZE $_[1]", 2, $_[3]);
2358 defined($size) || return 0;
2360 &$cbfunc(2, int($size));
2364 my $pasv = &ftp_command("PASV", 2, $_[3]);
2365 defined($pasv) || return 0;
2366 $pasv =~ /\(([0-9,]+)\)/;
2367 @n = split(/,/ , $1);
2368 &open_socket("$n[0].$n[1].$n[2].$n[3]",
2369 $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2370 &ftp_command("RETR $_[1]", 1, $_[3]) || return 0;
2374 &open_tempfile(PFILE, ">$_[2]", 1);
2375 while(read(CON, $buf, 1024) > 0) {
2376 &print_tempfile(PFILE, $buf);
2377 $got += length($buf);
2378 &$cbfunc(3, $got) if ($cbfunc);
2380 &close_tempfile(PFILE);
2382 if ($got != $size) {
2383 if ($_[3]) { ${$_[3]} = "Download incomplete"; return 0; }
2384 else { &error("Download incomplete"); }
2386 &$cbfunc(4) if ($cbfunc);
2388 &ftp_command("", 2, $_[3]) || return 0;
2392 &ftp_command("QUIT", 2, $_[3]) || return 0;
2396 &write_to_http_cache($url, $dest);
2400 =head2 ftp_upload(host, file, srcfile, [&error], [&callback], [user, pass], [port])
2402 Upload data from a local file to an FTP site. The parameters are :
2404 =item host - FTP server hostname
2406 =item file - File on the FTP server to write to
2408 =item srcfile - File on the Webmin system to upload data from
2410 =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.
2412 =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.
2414 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2416 =item pass - Password for the username above.
2418 =item port - FTP server port number, which defaults to 21 if not set.
2425 if (&is_readonly_mode()) {
2426 if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2428 else { &error("FTP connections not allowed in readonly mode"); }
2431 $main::download_timed_out = undef;
2432 local $SIG{ALRM} = \&download_timeout;
2435 # connect to host and login
2436 &open_socket($_[0], $_[7] || 21, "SOCK", $_[3]) || return 0;
2438 if ($main::download_timed_out) {
2439 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2440 else { &error($main::download_timed_out); }
2442 &ftp_command("", 2, $_[3]) || return 0;
2444 # Login as supplied user
2445 my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2447 if (int($urv[1]/100) == 3) {
2448 &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2452 # Login as anonymous
2453 my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2455 if (int($urv[1]/100) == 3) {
2456 &ftp_command("PASS root\@".&get_system_hostname(), 2,
2460 &$cbfunc(1, 0) if ($cbfunc);
2462 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2464 # get the file size and tell the callback
2465 my @st = stat($_[2]);
2467 &$cbfunc(2, $st[7]);
2471 my $pasv = &ftp_command("PASV", 2, $_[3]);
2472 defined($pasv) || return 0;
2473 $pasv =~ /\(([0-9,]+)\)/;
2474 @n = split(/,/ , $1);
2475 &open_socket("$n[0].$n[1].$n[2].$n[3]", $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2476 &ftp_command("STOR $_[1]", 1, $_[3]) || return 0;
2481 while(read(PFILE, $buf, 1024) > 0) {
2483 $got += length($buf);
2484 &$cbfunc(3, $got) if ($cbfunc);
2488 if ($got != $st[7]) {
2489 if ($_[3]) { ${$_[3]} = "Upload incomplete"; return 0; }
2490 else { &error("Upload incomplete"); }
2492 &$cbfunc(4) if ($cbfunc);
2495 &ftp_command("", 2, $_[3]) || return 0;
2496 &ftp_command("QUIT", 2, $_[3]) || return 0;
2502 =head2 no_proxy(host)
2504 Checks if some host is on the no proxy list. For internal use by the
2505 http_download and ftp_download functions.
2510 my $ip = &to_ipaddress($_[0]);
2511 foreach my $n (split(/\s+/, $gconfig{'noproxy'})) {
2512 return 1 if ($_[0] =~ /\Q$n\E/ ||
2518 =head2 open_socket(host, port, handle, [&error])
2520 Open a TCP connection to some host and port, using a file handle. The
2523 =item host - Hostname or IP address to connect to.
2525 =item port - TCP port number.
2527 =item handle - A file handle name to use for the connection.
2529 =item error - A string reference to write any error message into. If not set, the error function is called on failure.
2534 my ($host, $port, $fh, $err) = @_;
2535 $fh = &callers_package($fh);
2537 if ($gconfig{'debug_what_net'}) {
2538 &webmin_debug_log('TCP', "host=$host port=$port");
2541 # Lookup IP address for the host. Try v4 first, and failing that v6
2543 my $proto = getprotobyname("tcp");
2544 if ($ip = &to_ipaddress($host)) {
2545 # Create IPv4 socket and connection
2546 if (!socket($fh, PF_INET, SOCK_STREAM, $proto)) {
2547 my $msg = "Failed to create socket : $!";
2548 if ($err) { $$err = $msg; return 0; }
2549 else { &error($msg); }
2551 my $addr = inet_aton($ip);
2552 if ($gconfig{'bind_proxy'}) {
2553 # BIND to outgoing IP
2554 if (!bind($fh,pack_sockaddr_in(0, inet_aton($gconfig{'bind_proxy'})))) {
2555 my $msg = "Failed to bind to source address : $!";
2556 if ($err) { $$err = $msg; return 0; }
2557 else { &error($msg); }
2560 if (!connect($fh, pack_sockaddr_in($port, $addr))) {
2561 my $msg = "Failed to connect to $host:$port : $!";
2562 if ($err) { $$err = $msg; return 0; }
2563 else { &error($msg); }
2566 elsif ($ip = &to_ip6address($host)) {
2567 # Create IPv6 socket and connection
2568 if (!socket($fh, Socket6::PF_INET6(), SOCK_STREAM, $proto)) {
2569 my $msg = "Failed to create IPv6 socket : $!";
2570 if ($err) { $$err = $msg; return 0; }
2571 else { &error($msg); }
2573 my $addr = inet_pton(Socket6::AF_INET6(), $ip);
2574 if (!connect($fh, pack_sockaddr_in6($port, $addr))) {
2575 my $msg = "Failed to IPv6 connect to $host:$port : $!";
2576 if ($err) { $$err = $msg; return 0; }
2577 else { &error($msg); }
2582 my $msg = "Failed to lookup IP address for $host";
2583 if ($err) { $$err = $msg; return 0; }
2584 else { &error($msg); }
2588 my $old = select($fh);
2594 =head2 download_timeout
2596 Called when a download times out. For internal use only.
2599 sub download_timeout
2601 $main::download_timed_out = "Download timed out";
2604 =head2 ftp_command(command, expected, [&error], [filehandle])
2606 Send an FTP command, and die if the reply is not what was expected. Mainly
2607 for internal use by the ftp_download and ftp_upload functions.
2612 my ($cmd, $expect, $err, $fh) = @_;
2614 $fh = &callers_package($fh);
2617 my $what = $cmd ne "" ? "<i>$cmd</i>" : "initial connection";
2619 print $fh "$cmd\r\n";
2622 if (!($line = <$fh>)) {
2624 if ($err) { $$err = "Failed to read reply to $what"; return undef; }
2625 else { &error("Failed to read reply to $what"); }
2627 $line =~ /^(...)(.)(.*)$/;
2630 foreach my $c (@$expect) {
2631 $found++ if (int($1/100) == $c);
2635 $found++ if (int($1/100) == $_[1]);
2639 if ($err) { $$err = "$what failed : $3"; return undef; }
2640 else { &error("$what failed : $3"); }
2645 # Need to skip extra stuff..
2647 if (!($line = <$fh>)) {
2649 if ($$err) { $$err = "Failed to read reply to $what";
2651 else { &error("Failed to read reply to $what"); }
2653 $line =~ /^(....)(.*)$/; $reply .= $2;
2654 if ($1 eq "$rcode ") { last; }
2658 return wantarray ? ($reply, $rcode) : $reply;
2661 =head2 to_ipaddress(hostname)
2663 Converts a hostname to an a.b.c.d format IP address, or returns undef if
2664 it cannot be resolved.
2669 if (&check_ipaddress($_[0])) {
2670 return $_[0]; # Already in v4 format
2672 elsif (&check_ip6address($_[0])) {
2673 return undef; # A v6 address cannot be converted to v4
2676 my $hn = gethostbyname($_[0]);
2677 return undef if (!$hn);
2678 local @ip = unpack("CCCC", $hn);
2679 return join("." , @ip);
2683 =head2 to_ip6address(hostname)
2685 Converts a hostname to IPv6 address, or returns undef if it cannot be resolved.
2690 if (&check_ip6address($_[0])) {
2691 return $_[0]; # Already in v6 format
2693 elsif (&check_ipaddress($_[0])) {
2694 return undef; # A v4 address cannot be v6
2696 elsif (!&supports_ipv6()) {
2697 return undef; # Cannot lookup
2700 # Perform IPv6 DNS lookup
2702 (undef, undef, undef, $inaddr) =
2703 getaddrinfo($_[0], undef, Socket6::AF_INET6(), SOCK_STREAM);
2704 return undef if (!$inaddr);
2706 (undef, $addr) = unpack_sockaddr_in6($inaddr);
2707 return inet_ntop(Socket6::AF_INET6(), $addr);
2711 =head2 to_hostname(ipv4|ipv6-address)
2713 Reverse-resolves an IPv4 or 6 address to a hostname
2719 if (&check_ip6address($addr) && &supports_ipv6()) {
2720 return gethostbyaddr(inet_pton(Socket6::AF_INET6(), $addr),
2721 Socket6::AF_INET6());
2724 return gethostbyaddr(inet_aton($addr), AF_INET);
2728 =head2 icons_table(&links, &titles, &icons, [columns], [href], [width], [height], &befores, &afters)
2730 Renders a 4-column table of icons. The useful parameters are :
2732 =item links - An array ref of link destination URLs for the icons.
2734 =item titles - An array ref of titles to appear under the icons.
2736 =item icons - An array ref of URLs for icon images.
2738 =item columns - Number of columns to layout the icons with. Defaults to 4.
2743 &load_theme_library();
2744 if (defined(&theme_icons_table)) {
2745 &theme_icons_table(@_);
2749 my $cols = $_[3] ? $_[3] : 4;
2750 my $per = int(100.0 / $cols);
2751 print "<table class='icons_table' width=100% cellpadding=5>\n";
2752 for(my $i=0; $i<@{$_[0]}; $i++) {
2753 if ($i%$cols == 0) { print "<tr>\n"; }
2754 print "<td width=$per% align=center valign=top>\n";
2755 &generate_icon($_[2]->[$i], $_[1]->[$i], $_[0]->[$i],
2756 ref($_[4]) ? $_[4]->[$i] : $_[4], $_[5], $_[6],
2757 $_[7]->[$i], $_[8]->[$i]);
2759 if ($i%$cols == $cols-1) { print "</tr>\n"; }
2761 while($i++%$cols) { print "<td width=$per%></td>\n"; $need_tr++; }
2762 print "</tr>\n" if ($need_tr);
2766 =head2 replace_file_line(file, line, [newline]*)
2768 Replaces one line in some file with 0 or more new lines. The parameters are :
2770 =item file - Full path to some file, like /etc/hosts.
2772 =item line - Line number to replace, starting from 0.
2774 =item newline - Zero or more lines to put into the file at the given line number. These must be newline-terminated strings.
2777 sub replace_file_line
2780 my $realfile = &translate_filename($_[0]);
2781 open(FILE, $realfile);
2784 if (@_ > 2) { splice(@lines, $_[1], 1, @_[2..$#_]); }
2785 else { splice(@lines, $_[1], 1); }
2786 &open_tempfile(FILE, ">$realfile");
2787 &print_tempfile(FILE, @lines);
2788 &close_tempfile(FILE);
2791 =head2 read_file_lines(file, [readonly])
2793 Returns a reference to an array containing the lines from some file. This
2794 array can be modified, and will be written out when flush_file_lines()
2795 is called. The parameters are :
2797 =item file - Full path to the file to read.
2799 =item readonly - Should be set 1 if the caller is only going to read the lines, and never write it out.
2803 $lref = read_file_lines("/etc/hosts");
2804 push(@$lref, "127.0.0.1 localhost");
2805 flush_file_lines("/etc/hosts");
2811 my ($package, $filename, $line) = caller;
2812 print STDERR "Missing file to read at ${package}::${filename} line $line\n";
2814 my $realfile = &translate_filename($_[0]);
2815 if (!$main::file_cache{$realfile}) {
2818 &webmin_debug_log('READ', $_[0]) if ($gconfig{'debug_what_read'});
2819 open(READFILE, $realfile);
2822 $eol = /\r\n$/ ? "\r\n" : "\n";
2828 $main::file_cache{$realfile} = \@lines;
2829 $main::file_cache_noflush{$realfile} = $_[1];
2830 $main::file_cache_eol{$realfile} = $eol || "\n";
2833 # Make read-write if currently readonly
2835 $main::file_cache_noflush{$realfile} = 0;
2838 return $main::file_cache{$realfile};
2841 =head2 flush_file_lines([file], [eol])
2843 Write out to a file previously read by read_file_lines to disk (except
2844 for those marked readonly). The parameters are :
2846 =item file - The file to flush out.
2848 =item eof - End-of-line character for each line. Defaults to \n.
2851 sub flush_file_lines
2855 local $trans = &translate_filename($_[0]);
2856 $main::file_cache{$trans} ||
2857 &error("flush_file_lines called on non-loaded file $trans");
2858 push(@files, $trans);
2861 @files = ( keys %main::file_cache );
2863 foreach my $f (@files) {
2864 my $eol = $_[1] || $main::file_cache_eol{$f} || "\n";
2865 if (!$main::file_cache_noflush{$f}) {
2866 no warnings; # XXX Bareword file handles should go away
2867 &open_tempfile(FLUSHFILE, ">$f");
2868 foreach my $line (@{$main::file_cache{$f}}) {
2869 (print FLUSHFILE $line,$eol) ||
2870 &error(&text("efilewrite", $f, $!));
2872 &close_tempfile(FLUSHFILE);
2874 delete($main::file_cache{$f});
2875 delete($main::file_cache_noflush{$f});
2879 =head2 unflush_file_lines(file)
2881 Clear the internal cache of some given file, previously read by read_file_lines.
2884 sub unflush_file_lines
2886 my $realfile = &translate_filename($_[0]);
2887 delete($main::file_cache{$realfile});
2888 delete($main::file_cache_noflush{$realfile});
2891 =head2 unix_user_input(fieldname, user, [form])
2893 Returns HTML for an input to select a Unix user. By default this is a text
2894 box with a user popup button next to it.
2899 if (defined(&theme_unix_user_input)) {
2900 return &theme_unix_user_input(@_);
2902 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
2903 &user_chooser_button($_[0], 0, $_[2] || 0)."\n";
2906 =head2 unix_group_input(fieldname, user, [form])
2908 Returns HTML for an input to select a Unix group. By default this is a text
2909 box with a group popup button next to it.
2912 sub unix_group_input
2914 if (defined(&theme_unix_group_input)) {
2915 return &theme_unix_group_input(@_);
2917 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
2918 &group_chooser_button($_[0], 0, $_[2] || 0)."\n";
2921 =head2 hlink(text, page, [module], [width], [height])
2923 Returns HTML for a link that when clicked on pops up a window for a Webmin
2924 help page. The parameters are :
2926 =item text - Text for the link.
2928 =item page - Help page code, such as 'intro'.
2930 =item module - Module the help page is in. Defaults to the current module.
2932 =item width - Width of the help popup window. Defaults to 600 pixels.
2934 =item height - Height of the help popup window. Defaults to 400 pixels.
2936 The actual help pages are in each module's help sub-directory, in files with
2942 if (defined(&theme_hlink)) {
2943 return &theme_hlink(@_);
2945 my $mod = $_[2] ? $_[2] : &get_module_name();
2946 my $width = $_[3] || $tconfig{'help_width'} || $gconfig{'help_width'} || 600;
2947 my $height = $_[4] || $tconfig{'help_height'} || $gconfig{'help_height'} || 400;
2948 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>";
2951 =head2 user_chooser_button(field, multiple, [form])
2953 Returns HTML for a javascript button for choosing a Unix user or users.
2954 The parameters are :
2956 =item field - Name of the HTML field to place the username into.
2958 =item multiple - Set to 1 if multiple users can be selected.
2960 =item form - Index of the form on the page.
2963 sub user_chooser_button
2965 return undef if (!&supports_users());
2966 return &theme_user_chooser_button(@_)
2967 if (defined(&theme_user_chooser_button));
2968 my $form = defined($_[2]) ? $_[2] : 0;
2969 my $w = $_[1] ? 500 : 300;
2971 if ($_[1] && $gconfig{'db_sizeusers'}) {
2972 ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
2974 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
2975 ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
2977 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";
2980 =head2 group_chooser_button(field, multiple, [form])
2982 Returns HTML for a javascript button for choosing a Unix group or groups
2983 The parameters are :
2985 =item field - Name of the HTML field to place the group name into.
2987 =item multiple - Set to 1 if multiple groups can be selected.
2989 =item form - Index of the form on the page.
2992 sub group_chooser_button
2994 return undef if (!&supports_users());
2995 return &theme_group_chooser_button(@_)
2996 if (defined(&theme_group_chooser_button));
2997 my $form = defined($_[2]) ? $_[2] : 0;
2998 my $w = $_[1] ? 500 : 300;
3000 if ($_[1] && $gconfig{'db_sizeusers'}) {
3001 ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
3003 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
3004 ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
3006 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";
3009 =head2 foreign_check(module, [api-only])
3011 Checks if some other module exists and is supported on this OS. The parameters
3014 =item module - Name of the module to check.
3016 =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.
3021 my ($mod, $api) = @_;
3023 my $mdir = &module_root_directory($mod);
3024 &read_file_cached("$mdir/module.info", \%minfo) || return 0;
3025 return &check_os_support(\%minfo, undef, undef, $api);
3028 =head2 foreign_exists(module)
3030 Checks if some other module exists. The module parameter is the short module
3036 my $mdir = &module_root_directory($_[0]);
3037 return -r "$mdir/module.info";
3040 =head2 foreign_available(module)
3042 Returns 1 if some module is installed, and acessible to the current user. The
3043 module parameter is the module directory name.
3046 sub foreign_available
3048 return 0 if (!&foreign_check($_[0]) &&
3049 !$gconfig{'available_even_if_no_support'});
3050 my %foreign_module_info = &get_module_info($_[0]);
3052 # Check list of allowed modules
3054 &read_acl(\%acl, undef, [ $base_remote_user ]);
3055 return 0 if (!$acl{$base_remote_user,$_[0]} &&
3056 !$acl{$base_remote_user,'*'});
3058 # Check for usermod restrictions
3059 my @usermods = &list_usermods();
3060 return 0 if (!&available_usermods( [ \%foreign_module_info ], \@usermods));
3062 if (&get_product_name() eq "webmin") {
3063 # Check if the user has any RBAC privileges in this module
3064 if (&supports_rbac($_[0]) &&
3065 &use_rbac_module_acl(undef, $_[0])) {
3066 # RBAC is enabled for this user and module - check if he
3068 my $rbacs = &get_rbac_module_acl($remote_user, $_[0]);
3069 return 0 if (!$rbacs);
3071 elsif ($gconfig{'rbacdeny_'.$base_remote_user}) {
3072 # If denying access to modules not specifically allowed by
3073 # RBAC, then prevent access
3078 # Check readonly support
3079 if (&is_readonly_mode()) {
3080 return 0 if (!$foreign_module_info{'readonly'});
3083 # Check if theme vetos
3084 if (defined(&theme_foreign_available)) {
3085 return 0 if (!&theme_foreign_available($_[0]));
3088 # Check if licence module vetos
3089 if ($main::licence_module) {
3090 return 0 if (!&foreign_call($main::licence_module,
3091 "check_module_licence", $_[0]));
3097 =head2 foreign_require(module, [file], [package])
3099 Brings in functions from another module, and places them in the Perl namespace
3100 with the same name as the module. The parameters are :
3102 =item module - The source module's directory name, like sendmail.
3104 =item file - The API file in that module, like sendmail-lib.pl. If missing, all API files are loaded.
3106 =item package - Perl package to place the module's functions and global variables in.
3108 If the original module name contains dashes, they will be replaced with _ in
3114 my ($mod, $file, $pkg) = @_;
3115 $pkg ||= $mod || "global";
3116 $pkg =~ s/[^A-Za-z0-9]/_/g;
3119 push(@files, $file);
3123 my %minfo = &get_module_info($mod);
3124 if ($minfo{'library'}) {
3125 @files = split(/\s+/, $minfo{'library'});
3128 @files = ( $mod."-lib.pl" );
3131 @files = grep { !$main::done_foreign_require{$pkg,$_} } @files;
3132 return 1 if (!@files);
3133 foreach my $f (@files) {
3134 $main::done_foreign_require{$pkg,$f}++;
3137 my $mdir = &module_root_directory($mod);
3138 @INC = &unique($mdir, @INC);
3139 -d $mdir || &error("Module $mod does not exist");
3140 if (!&get_module_name() && $mod) {
3143 my $old_fmn = $ENV{'FOREIGN_MODULE_NAME'};
3144 my $old_frd = $ENV{'FOREIGN_ROOT_DIRECTORY'};
3145 my $code = "package $pkg; ".
3146 "\$ENV{'FOREIGN_MODULE_NAME'} = '$mod'; ".
3147 "\$ENV{'FOREIGN_ROOT_DIRECTORY'} = '$root_directory'; ";
3148 foreach my $f (@files) {
3149 $code .= "do '$mdir/$f' || die \$@; ";
3152 if (defined($old_fmn)) {
3153 $ENV{'FOREIGN_MODULE_NAME'} = $old_fmn;
3156 delete($ENV{'FOREIGN_MODULE_NAME'});
3158 if (defined($old_frd)) {
3159 $ENV{'FOREIGN_ROOT_DIRECTORY'} = $old_frd;
3162 delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
3165 if ($@) { &error("Require $mod/$files[0] failed : <pre>$@</pre>"); }
3169 =head2 foreign_call(module, function, [arg]*)
3171 Call a function in another module. The module parameter is the target module
3172 directory name, function is the perl sub to call, and the remaining parameters
3173 are the arguments. However, unless you need to call a function whose name
3174 is dynamic, it is better to use Perl's cross-module function call syntax
3175 like module::function(args).
3180 my $pkg = $_[0] || "global";
3181 $pkg =~ s/[^A-Za-z0-9]/_/g;
3182 my @args = @_[2 .. @_-1];
3183 $main::foreign_args = \@args;
3184 my @rv = eval <<EOF;
3186 &$_[1](\@{\$main::foreign_args});
3188 if ($@) { &error("$_[0]::$_[1] failed : $@"); }
3189 return wantarray ? @rv : $rv[0];
3192 =head2 foreign_config(module, [user-config])
3194 Get the configuration from another module, and return it as a hash. If the
3195 user-config parameter is set to 1, returns the Usermin user-level preferences
3196 for the current user instead.
3201 my ($mod, $uc) = @_;
3204 &read_file_cached("$root_directory/$mod/defaultuconfig", \%fconfig);
3205 &read_file_cached("$config_directory/$mod/uconfig", \%fconfig);
3206 &read_file_cached("$user_config_directory/$mod/config", \%fconfig);
3209 &read_file_cached("$config_directory/$mod/config", \%fconfig);
3214 =head2 foreign_installed(module, mode)
3216 Checks if the server for some module is installed, and possibly also checks
3217 if the module has been configured by Webmin.
3218 For mode 1, returns 2 if the server is installed and configured for use by
3219 Webmin, 1 if installed but not configured, or 0 otherwise.
3220 For mode 0, returns 1 if installed, 0 if not.
3221 If the module does not provide an install_check.pl script, assumes that
3222 the server is installed.
3225 sub foreign_installed
3227 my ($mod, $configured) = @_;
3228 if (defined($main::foreign_installed_cache{$mod,$configured})) {
3230 return $main::foreign_installed_cache{$mod,$configured};
3234 if (!&foreign_check($mod)) {
3239 my $mdir = &module_root_directory($mod);
3240 if (!-r "$mdir/install_check.pl") {
3241 # Not known, assume OK
3242 $rv = $configured ? 2 : 1;
3245 # Call function to check
3246 &foreign_require($mod, "install_check.pl");
3247 $rv = &foreign_call($mod, "is_installed", $configured);
3250 $main::foreign_installed_cache{$mod,$configured} = $rv;
3255 =head2 foreign_defined(module, function)
3257 Returns 1 if some function is defined in another module. In general, it is
3258 simpler to use the syntax &defined(module::function) instead.
3264 $pkg =~ s/[^A-Za-z0-9]/_/g;
3265 my $func = "${pkg}::$_[1]";
3266 return defined(&$func);
3269 =head2 get_system_hostname([short])
3271 Returns the hostname of this system. If the short parameter is set to 1,
3272 then the domain name is not prepended - otherwise, Webmin will attempt to get
3273 the fully qualified hostname, like foo.example.com.
3276 sub get_system_hostname
3279 if (!$main::get_system_hostname[$m]) {
3280 if ($gconfig{'os_type'} ne 'windows') {
3281 # Try some common Linux hostname files first
3283 if ($gconfig{'os_type'} eq 'redhat-linux') {
3285 &read_env_file("/etc/sysconfig/network", \%nc);
3286 if ($nc{'HOSTNAME'}) {
3287 $fromfile = $nc{'HOSTNAME'};
3290 elsif ($gconfig{'os_type'} eq 'debian-linux') {
3291 my $hn = &read_file_contents("/etc/hostname");
3297 elsif ($gconfig{'os_type'} eq 'open-linux') {
3298 my $hn = &read_file_contents("/etc/HOSTNAME");
3304 elsif ($gconfig{'os_type'} eq 'solaris') {
3305 my $hn = &read_file_contents("/etc/nodename");
3312 # If we found a hostname, use it if value
3313 if ($fromfile && ($m || $fromfile =~ /\./)) {
3315 $fromfile =~ s/\..*$//;
3317 $main::get_system_hostname[$m] = $fromfile;
3321 # Can use hostname command on Unix
3322 &execute_command("hostname", undef,
3323 \$main::get_system_hostname[$m], undef, 0, 1);
3324 chop($main::get_system_hostname[$m]);
3326 eval "use Sys::Hostname";
3328 $main::get_system_hostname[$m] = eval "hostname()";
3330 if ($@ || !$main::get_system_hostname[$m]) {
3331 $main::get_system_hostname[$m] = "UNKNOWN";
3334 elsif ($main::get_system_hostname[$m] !~ /\./ &&
3335 $gconfig{'os_type'} =~ /linux$/ &&
3336 !$gconfig{'no_hostname_f'} && !$_[0]) {
3337 # Try with -f flag to get fully qualified name
3339 my $ex = &execute_command("hostname -f", undef, \$flag,
3342 if ($ex || $flag eq "") {
3343 # -f not supported! We have probably set the
3344 # hostname to just '-f'. Fix the problem
3347 &execute_command("hostname ".
3348 quotemeta($main::get_system_hostname[$m]),
3349 undef, undef, undef, 0, 1);
3353 $main::get_system_hostname[$m] = $flag;
3358 # On Windows, try computername environment variable
3359 return $ENV{'computername'} if ($ENV{'computername'});
3360 return $ENV{'COMPUTERNAME'} if ($ENV{'COMPUTERNAME'});
3362 # Fall back to net name command
3363 my $out = `net name 2>&1`;
3364 if ($out =~ /\-+\r?\n(\S+)/) {
3365 $main::get_system_hostname[$m] = $1;
3368 $main::get_system_hostname[$m] = "windows";
3372 return $main::get_system_hostname[$m];
3375 =head2 get_webmin_version
3377 Returns the version of Webmin currently being run, such as 1.450.
3380 sub get_webmin_version
3382 if (!$get_webmin_version) {
3383 open(VERSION, "$root_directory/version") || return 0;
3384 ($get_webmin_version = <VERSION>) =~ tr/\r|\n//d;
3387 return $get_webmin_version;
3390 =head2 get_module_acl([user], [module], [no-rbac], [no-default])
3392 Returns a hash containing access control options for the given user and module.
3393 By default the current username and module name are used. If the no-rbac flag
3394 is given, the permissions will not be updated based on the user's RBAC role
3395 (as seen on Solaris). If the no-default flag is given, default permissions for
3396 the module will not be included.
3401 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
3402 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3403 my $mdir = &module_root_directory($m);
3406 # Read default ACL first, to be overridden by per-user settings
3407 &read_file_cached("$mdir/defaultacl", \%rv);
3409 # If this isn't a master admin user, apply the negative permissions
3410 # so that he doesn't un-expectedly gain access to new features
3412 &read_file_cached("$config_directory/$u.acl", \%gaccess);
3413 if ($gaccess{'negative'}) {
3414 &read_file_cached("$mdir/negativeacl", \%rv);
3418 if (!$_[2] && &supports_rbac($m) && &use_rbac_module_acl($u, $m)) {
3419 # RBAC overrides exist for this user in this module
3420 my $rbac = &get_rbac_module_acl(
3421 defined($_[0]) ? $_[0] : $remote_user, $m);
3422 foreach my $r (keys %$rbac) {
3423 $rv{$r} = $rbac->{$r};
3426 elsif ($gconfig{"risk_$u"} && $m) {
3427 # ACL is defined by user's risk level
3428 my $rf = $gconfig{"risk_$u"}.'.risk';
3429 &read_file_cached("$mdir/$rf", \%rv);
3431 my $sf = $gconfig{"skill_$u"}.'.skill';
3432 &read_file_cached("$mdir/$sf", \%rv);
3435 # Use normal Webmin ACL, if a user is set
3436 my $userdb = &get_userdb_string();
3438 if ($userdb && ($u ne $base_remote_user || $remote_user_proto)) {
3439 # Look for this user in the user/group DB, if one is defined
3440 # and if the user might be in the DB
3441 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3442 ref($dbh) || &error(&text('euserdbacl', $dbh));
3443 if ($proto eq "mysql" || $proto eq "postgresql") {
3444 # Find the user in the SQL DB
3445 my $cmd = $dbh->prepare(
3446 "select id from webmin_user where name = ?");
3447 $cmd && $cmd->execute($u) ||
3448 &error(&text('euserdbacl', $dbh->errstr));
3449 my ($id) = $cmd->fetchrow();
3450 $foundindb = 1 if (defined($id));
3453 # Fetch ACLs with SQL
3455 my $cmd = $dbh->prepare(
3456 "select attr,value from webmin_user_acl ".
3457 "where id = ? and module = ?");
3458 $cmd && $cmd->execute($id, $m) ||
3459 &error(&text('euserdbacl', $dbh->errstr));
3460 while(my ($a, $v) = $cmd->fetchrow()) {
3466 elsif ($proto eq "ldap") {
3468 my $rv = $dbh->search(
3470 filter => '(&(cn='.$u.')(objectClass='.
3471 $args->{'userclass'}.'))',
3473 if (!$rv || $rv->code) {
3474 &error(&text('euserdbacl',
3475 $rv ? $rv->error : "Unknown error"));
3477 my ($user) = $rv->all_entries;
3479 # Find ACL sub-object for the module
3480 my $ldapm = $m || "global";
3482 my $rv = $dbh->search(
3483 base => $user->dn(),
3484 filter => '(cn='.$ldapm.')',
3486 if (!$rv || $rv->code) {
3487 &error(&text('euserdbacl',
3488 $rv ? $rv->error : "Unknown error"));
3490 my ($acl) = $rv->all_entries;
3492 foreach my $av ($acl->get_value(
3493 'webminAclEntry')) {
3494 my ($a, $v) = split(/=/, $av,2);
3500 &disconnect_userdb($userdb, $dbh);
3504 # Read from local files
3505 &read_file_cached("$config_directory/$m/$u.acl", \%rv);
3506 if ($remote_user ne $base_remote_user && !defined($_[0])) {
3508 "$config_directory/$m/$remote_user.acl",\%rv);
3512 if ($tconfig{'preload_functions'}) {
3513 &load_theme_library();
3515 if (defined(&theme_get_module_acl)) {
3516 %rv = &theme_get_module_acl($u, $m, \%rv);
3521 =head2 get_group_module_acl(group, [module], [no-default])
3523 Returns the ACL for a Webmin group, in an optional module (which defaults to
3524 the current module).
3527 sub get_group_module_acl
3530 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3531 my $mdir = &module_root_directory($m);
3534 &read_file_cached("$mdir/defaultacl", \%rv);
3537 my $userdb = &get_userdb_string();
3540 # Look for this group in the user/group DB
3541 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3542 ref($dbh) || &error(&text('egroupdbacl', $dbh));
3543 if ($proto eq "mysql" || $proto eq "postgresql") {
3544 # Find the group in the SQL DB
3545 my $cmd = $dbh->prepare(
3546 "select id from webmin_group where name = ?");
3547 $cmd && $cmd->execute($g) ||
3548 &error(&text('egroupdbacl', $dbh->errstr));
3549 my ($id) = $cmd->fetchrow();
3550 $foundindb = 1 if (defined($id));
3553 # Fetch ACLs with SQL
3555 my $cmd = $dbh->prepare(
3556 "select attr,value from webmin_group_acl ".
3557 "where id = ? and module = ?");
3558 $cmd && $cmd->execute($id, $m) ||
3559 &error(&text('egroupdbacl', $dbh->errstr));
3560 while(my ($a, $v) = $cmd->fetchrow()) {
3566 elsif ($proto eq "ldap") {
3567 # Find group in LDAP
3568 my $rv = $dbh->search(
3570 filter => '(&(cn='.$g.')(objectClass='.
3571 $args->{'groupclass'}.'))',
3573 if (!$rv || $rv->code) {
3574 &error(&text('egroupdbacl',
3575 $rv ? $rv->error : "Unknown error"));
3577 my ($group) = $rv->all_entries;
3579 # Find ACL sub-object for the module
3580 my $ldapm = $m || "global";
3582 my $rv = $dbh->search(
3583 base => $group->dn(),
3584 filter => '(cn='.$ldapm.')',
3586 if (!$rv || $rv->code) {
3587 &error(&text('egroupdbacl',
3588 $rv ? $rv->error : "Unknown error"));
3590 my ($acl) = $rv->all_entries;
3592 foreach my $av ($acl->get_value(
3593 'webminAclEntry')) {
3594 my ($a, $v) = split(/=/, $av, 2);
3600 &disconnect_userdb($userdb, $dbh);
3603 # Read from local files
3604 &read_file_cached("$config_directory/$m/$g.gacl", \%rv);
3606 if (defined(&theme_get_module_acl)) {
3607 %rv = &theme_get_module_acl($g, $m, \%rv);
3612 =head2 save_module_acl(&acl, [user], [module], [never-update-group])
3614 Updates the acl hash for some user and module. The parameters are :
3616 =item acl - Hash reference for the new access control options, or undef to clear
3618 =item user - User to update, defaulting to the current user.
3620 =item module - Module to update, defaulting to the caller.
3622 =item never-update-group - Never update the user's group's ACL
3627 my $u = defined($_[1]) ? $_[1] : $base_remote_user;
3628 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3629 if (!$_[3] && &foreign_check("acl")) {
3630 # Check if this user is a member of a group, and if he gets the
3631 # module from a group. If so, update its ACL as well
3632 &foreign_require("acl", "acl-lib.pl");
3634 foreach my $g (&acl::list_groups()) {
3635 if (&indexof($u, @{$g->{'members'}}) >= 0 &&
3636 &indexof($m, @{$g->{'modules'}}) >= 0) {
3642 &save_group_module_acl($_[0], $group->{'name'}, $m);
3646 my $userdb = &get_userdb_string();
3648 if ($userdb && ($u ne $base_remote_user || $remote_user_proto)) {
3649 # Look for this user in the user/group DB
3650 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3651 ref($dbh) || &error(&text('euserdbacl', $dbh));
3652 if ($proto eq "mysql" || $proto eq "postgresql") {
3653 # Find the user in the SQL DB
3654 my $cmd = $dbh->prepare(
3655 "select id from webmin_user where name = ?");
3656 $cmd && $cmd->execute($u) ||
3657 &error(&text('euserdbacl2', $dbh->errstr));
3658 my ($id) = $cmd->fetchrow();
3659 $foundindb = 1 if (defined($id));
3662 # Replace ACLs for user
3664 my $cmd = $dbh->prepare("delete from webmin_user_acl ".
3665 "where id = ? and module = ?");
3666 $cmd && $cmd->execute($id, $m) ||
3667 &error(&text('euserdbacl', $dbh->errstr));
3670 my $cmd = $dbh->prepare(
3671 "insert into webmin_user_acl ".
3672 "(id,module,attr,value) values (?,?,?,?)");
3673 $cmd || &error(&text('euserdbacl2',
3675 foreach my $a (keys %{$_[0]}) {
3676 $cmd->execute($id,$m,$a,$_[0]->{$a}) ||
3677 &error(&text('euserdbacl2',
3684 elsif ($proto eq "ldap") {
3685 # Find the user in LDAP
3686 my $rv = $dbh->search(
3688 filter => '(&(cn='.$u.')(objectClass='.
3689 $args->{'userclass'}.'))',
3691 if (!$rv || $rv->code) {
3692 &error(&text('euserdbacl',
3693 $rv ? $rv->error : "Unknown error"));
3695 my ($user) = $rv->all_entries;
3698 # Find the ACL sub-object for the module
3700 my $ldapm = $m || "global";
3701 my $rv = $dbh->search(
3702 base => $user->dn(),
3703 filter => '(cn='.$ldapm.')',
3705 if (!$rv || $rv->code) {
3706 &error(&text('euserdbacl',
3707 $rv ? $rv->error : "Unknown error"));
3709 my ($acl) = $rv->all_entries;
3712 foreach my $a (keys %{$_[0]}) {
3713 push(@al, $a."=".$_[0]->{$a});
3717 $rv = $dbh->modify($acl->dn(),
3718 replace => { "webminAclEntry", \@al });
3722 my @attrs = ( "cn", $ldapm,
3723 "objectClass", "webminAcl",
3724 "webminAclEntry", \@al );
3725 $rv = $dbh->add("cn=".$ldapm.",".$user->dn(),
3728 if (!$rv || $rv->code) {
3729 &error(&text('euserdbacl2',
3730 $rv ? $rv->error : "Unknown error"));
3734 &disconnect_userdb($userdb, $dbh);
3738 # Save ACL to local file
3739 if (!-d "$config_directory/$m") {
3740 mkdir("$config_directory/$m", 0755);
3743 &write_file("$config_directory/$m/$u.acl", $_[0]);
3746 &unlink_file("$config_directory/$m/$u.acl");
3751 =head2 save_group_module_acl(&acl, group, [module], [never-update-group])
3753 Updates the acl hash for some group and module. The parameters are :
3755 =item acl - Hash reference for the new access control options.
3757 =item group - Group name to update.
3759 =item module - Module to update, defaulting to the caller.
3761 =item never-update-group - Never update the parent group's ACL
3764 sub save_group_module_acl
3767 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3768 if (!$_[3] && &foreign_check("acl")) {
3769 # Check if this group is a member of a group, and if it gets the
3770 # module from a group. If so, update the parent ACL as well
3771 &foreign_require("acl", "acl-lib.pl");
3773 foreach my $pg (&acl::list_groups()) {
3774 if (&indexof('@'.$g, @{$pg->{'members'}}) >= 0 &&
3775 &indexof($m, @{$pg->{'modules'}}) >= 0) {
3781 &save_group_module_acl($_[0], $group->{'name'}, $m);
3785 my $userdb = &get_userdb_string();
3788 # Look for this group in the user/group DB
3789 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3790 ref($dbh) || &error(&text('egroupdbacl', $dbh));
3791 if ($proto eq "mysql" || $proto eq "postgresql") {
3792 # Find the group in the SQL DB
3793 my $cmd = $dbh->prepare(
3794 "select id from webmin_group where name = ?");
3795 $cmd && $cmd->execute($g) ||
3796 &error(&text('egroupdbacl2', $dbh->errstr));
3797 my ($id) = $cmd->fetchrow();
3798 $foundindb = 1 if (defined($id));
3801 # Replace ACLs for group
3803 my $cmd = $dbh->prepare("delete from webmin_group_acl ".
3804 "where id = ? and module = ?");
3805 $cmd && $cmd->execute($id, $m) ||
3806 &error(&text('egroupdbacl', $dbh->errstr));
3809 my $cmd = $dbh->prepare(
3810 "insert into webmin_group_acl ".
3811 "(id,module,attr,value) values (?,?,?,?)");
3812 $cmd || &error(&text('egroupdbacl2',
3814 foreach my $a (keys %{$_[0]}) {
3815 $cmd->execute($id,$m,$a,$_[0]->{$a}) ||
3816 &error(&text('egroupdbacl2',
3823 elsif ($proto eq "ldap") {
3824 # Find the group in LDAP
3825 my $rv = $dbh->search(
3827 filter => '(&(cn='.$g.')(objectClass='.
3828 $args->{'groupclass'}.'))',
3830 if (!$rv || $rv->code) {
3831 &error(&text('egroupdbacl',
3832 $rv ? $rv->error : "Unknown error"));
3834 my ($group) = $rv->all_entries;
3836 my $ldapm = $m || "global";
3838 # Find the ACL sub-object for the module
3840 my $rv = $dbh->search(
3841 base => $group->dn(),
3842 filter => '(cn='.$ldapm.')',
3844 if (!$rv || $rv->code) {
3845 &error(&text('egroupdbacl',
3846 $rv ? $rv->error : "Unknown error"));
3848 my ($acl) = $rv->all_entries;
3851 foreach my $a (keys %{$_[0]}) {
3852 push(@al, $a."=".$_[0]->{$a});
3856 $rv = $dbh->modify($acl->dn(),
3857 replace => { "webminAclEntry", \@al });
3861 my @attrs = ( "cn", $ldapm,
3862 "objectClass", "webminAcl",
3863 "webminAclEntry", \@al );
3864 $rv = $dbh->add("cn=".$ldapm.",".$group->dn(),
3867 if (!$rv || $rv->code) {
3868 &error(&text('egroupdbacl2',
3869 $rv ? $rv->error : "Unknown error"));
3873 &disconnect_userdb($userdb, $dbh);
3877 # Save ACL to local file
3878 if (!-d "$config_directory/$m") {
3879 mkdir("$config_directory/$m", 0755);
3882 &write_file("$config_directory/$m/$g.gacl", $_[0]);
3885 &unlink_file("$config_directory/$m/$g.gacl");
3892 This function must be called by all Webmin CGI scripts, either directly or
3893 indirectly via a per-module lib.pl file. It performs a number of initialization
3894 and housekeeping tasks, such as working out the module name, checking that the
3895 current user has access to the module, and populating global variables. Some
3896 of the variables set include :
3898 =item $config_directory - Base Webmin config directory, typically /etc/webmin
3900 =item $var_directory - Base logs directory, typically /var/webmin
3902 =item %config - Per-module configuration.
3904 =item %gconfig - Global configuration.
3906 =item $scriptname - Base name of the current perl script.
3908 =item $module_name - The name of the current module.
3910 =item $module_config_directory - The config directory for this module.
3912 =item $module_config_file - The config file for this module.
3914 =item $module_root_directory - This module's code directory.
3916 =item $webmin_logfile - The detailed logfile for webmin.
3918 =item $remote_user - The actual username used to login to webmin.
3920 =item $base_remote_user - The username whose permissions are in effect.
3922 =item $current_theme - The theme currently in use.
3924 =item $root_directory - The first root directory of this webmin install.
3926 =item @root_directories - All root directories for this webmin install.
3931 # Record first process ID that called this, so we know when it exited to clean
3933 $main::initial_process_id ||= $$;
3935 # Configuration and spool directories
3936 if (!defined($ENV{'WEBMIN_CONFIG'})) {
3937 die "WEBMIN_CONFIG not set";
3939 $config_directory = $ENV{'WEBMIN_CONFIG'};
3940 if (!defined($ENV{'WEBMIN_VAR'})) {
3941 open(VARPATH, "$config_directory/var-path");
3942 chop($var_directory = <VARPATH>);
3946 $var_directory = $ENV{'WEBMIN_VAR'};
3948 $main::http_cache_directory = $ENV{'WEBMIN_VAR'}."/cache";
3949 $main::default_debug_log_file = $ENV{'WEBMIN_VAR'}."/webmin.debug";
3951 if ($ENV{'SESSION_ID'}) {
3952 # Hide this variable from called programs, but keep it for internal use
3953 $main::session_id = $ENV{'SESSION_ID'};
3954 delete($ENV{'SESSION_ID'});
3956 if ($ENV{'REMOTE_PASS'}) {
3957 # Hide the password too
3958 $main::remote_pass = $ENV{'REMOTE_PASS'};
3959 delete($ENV{'REMOTE_PASS'});
3962 if ($> == 0 && $< != 0 && !$ENV{'FOREIGN_MODULE_NAME'}) {
3963 # Looks like we are running setuid, but the real UID hasn't been set.
3964 # Do so now, so that executed programs don't get confused
3969 # Read the webmin global config file. This contains the OS type and version,
3970 # OS specific configuration and global options such as proxy servers
3971 $config_file = "$config_directory/config";
3973 &read_file_cached($config_file, \%gconfig);
3974 $null_file = $gconfig{'os_type'} eq 'windows' ? "NUL" : "/dev/null";
3975 $path_separator = $gconfig{'os_type'} eq 'windows' ? ';' : ':';
3977 # If debugging is enabled, open the debug log
3978 if ($gconfig{'debug_enabled'} && !$main::opened_debug_log++) {
3979 my $dlog = $gconfig{'debug_file'} || $main::default_debug_log_file;
3980 if ($gconfig{'debug_size'}) {
3981 my @st = stat($dlog);
3982 if ($st[7] > $gconfig{'debug_size'}) {
3983 rename($dlog, $dlog.".0");
3986 open(main::DEBUGLOG, ">>$dlog");
3987 $main::opened_debug_log = 1;
3989 if ($gconfig{'debug_what_start'}) {
3990 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
3991 $main::debug_log_start_time = time();
3992 &webmin_debug_log("START", "script=$script_name");
3993 $main::debug_log_start_module = $module_name;
3997 # Set PATH and LD_LIBRARY_PATH
3998 if ($gconfig{'path'}) {
3999 if ($gconfig{'syspath'}) {
4001 $ENV{'PATH'} = $gconfig{'path'};
4005 $ENV{'PATH'} = $gconfig{'path'}.$path_separator.$ENV{'PATH'};
4008 $ENV{$gconfig{'ld_env'}} = $gconfig{'ld_path'} if ($gconfig{'ld_env'});
4010 # Set http_proxy and ftp_proxy environment variables, based on Webmin settings
4011 if ($gconfig{'http_proxy'}) {
4012 $ENV{'http_proxy'} = $gconfig{'http_proxy'};
4014 if ($gconfig{'ftp_proxy'}) {
4015 $ENV{'ftp_proxy'} = $gconfig{'ftp_proxy'};
4017 if ($gconfig{'noproxy'}) {
4018 $ENV{'no_proxy'} = $gconfig{'noproxy'};
4021 # Find all root directories
4023 if (&get_miniserv_config(\%miniserv)) {
4024 @root_directories = ( $miniserv{'root'} );
4025 for($i=0; defined($miniserv{"extraroot_$i"}); $i++) {
4026 push(@root_directories, $miniserv{"extraroot_$i"});
4030 # Work out which module we are in, and read the per-module config file
4031 $0 =~ s/\\/\//g; # Force consistent path on Windows
4032 if (defined($ENV{'FOREIGN_MODULE_NAME'})) {
4033 # In a foreign call - use the module name given
4034 $root_directory = $ENV{'FOREIGN_ROOT_DIRECTORY'};
4035 $module_name = $ENV{'FOREIGN_MODULE_NAME'};
4036 @root_directories = ( $root_directory ) if (!@root_directories);
4038 elsif ($ENV{'SCRIPT_NAME'}) {
4039 my $sn = $ENV{'SCRIPT_NAME'};
4040 $sn =~ s/^$gconfig{'webprefix'}//
4041 if (!$gconfig{'webprefixnoredir'});
4042 if ($sn =~ /^\/([^\/]+)\//) {
4043 # Get module name from CGI path
4046 if ($ENV{'SERVER_ROOT'}) {
4047 $root_directory = $ENV{'SERVER_ROOT'};
4049 elsif ($ENV{'SCRIPT_FILENAME'}) {
4050 $root_directory = $ENV{'SCRIPT_FILENAME'};
4051 $root_directory =~ s/$sn$//;
4053 @root_directories = ( $root_directory ) if (!@root_directories);
4056 # Get root directory from miniserv.conf, and deduce module name from $0
4057 $root_directory = $root_directories[0];
4059 foreach my $r (@root_directories) {
4060 if ($0 =~ /^$r\/([^\/]+)\/[^\/]+$/i) {
4061 # Under a module directory
4066 elsif ($0 =~ /^$root_directory\/[^\/]+$/i) {
4072 &error("Script was not run with full path (failed to find $0 under $root_directory)") if (!$rok);
4075 # Work out of this is a web, command line or cron job
4076 if (!$main::webmin_script_type) {
4077 if ($ENV{'SCRIPT_NAME'}) {
4079 $main::webmin_script_type = 'web';
4082 # Cron jobs have no TTY
4083 if ($gconfig{'os_type'} eq 'windows' ||
4084 open(DEVTTY, ">/dev/tty")) {
4085 $main::webmin_script_type = 'cmd';
4089 $main::webmin_script_type = 'cron';
4094 # Set the umask based on config
4095 if ($gconfig{'umask'} && !$main::umask_already++) {
4096 umask(oct($gconfig{'umask'}));
4099 # If this is a cron job or other background task, set the nice level
4100 if (!$main::nice_already && $main::webmin_script_type eq 'cron') {
4102 if ($gconfig{'nice'}) {
4103 eval 'POSIX::nice($gconfig{\'nice\'});';
4106 # Set IO scheduling class and priority
4107 if ($gconfig{'sclass'} ne '' || $gconfig{'sprio'} ne '') {
4109 $cmd .= " -c ".quotemeta($gconfig{'sclass'})
4110 if ($gconfig{'sclass'} ne '');
4111 $cmd .= " -n ".quotemeta($gconfig{'sprio'})
4112 if ($gconfig{'sprio'} ne '');
4114 &execute_command("$cmd >/dev/null 2>&1");
4117 $main::nice_already++;
4120 my $u = $ENV{'BASE_REMOTE_USER'} || $ENV{'REMOTE_USER'};
4121 $base_remote_user = $u;
4122 $remote_user = $ENV{'REMOTE_USER'};
4124 # Work out if user is definitely in the DB, and if so get his attrs
4125 $remote_user_proto = $ENV{"REMOTE_USER_PROTO"};
4126 %remote_user_attrs = ( );
4127 if ($remote_user_proto) {
4128 my $userdb = &get_userdb_string();
4129 my ($dbh, $proto, $prefix, $args) =
4130 $userdb ? &connect_userdb($userdb) : ( );
4132 if ($proto eq "mysql" || $proto eq "postgresql") {
4133 # Read attrs from SQL
4134 my $cmd = $dbh->prepare("select webmin_user_attr.attr,webmin_user_attr.value from webmin_user_attr,webmin_user where webmin_user_attr.id = webmin_user.id and webmin_user.name = ?");
4135 if ($cmd && $cmd->execute($base_remote_user)) {
4136 while(my ($attr, $value) = $cmd->fetchrow()) {
4137 $remote_user_attrs{$attr} = $value;
4142 elsif ($proto eq "ldap") {
4143 # Read attrs from LDAP
4144 my $rv = $dbh->search(
4146 filter => '(&(cn='.$base_remote_user.')'.
4148 $args->{'userclass'}.'))',
4150 my ($u) = $rv && !$rv->code ? $rv->all_entries : ( );
4152 foreach $la ($u->get_value('webminAttr')) {
4153 my ($attr, $value) = split(/=/, $la, 2);
4154 $remote_user_attrs{$attr} = $value;
4158 &disconnect_userdb($userdb, $dbh);
4163 # Find and load the configuration file for this module
4164 my (@ruinfo, $rgroup);
4165 $module_config_directory = "$config_directory/$module_name";
4166 if (&get_product_name() eq "usermin" &&
4167 -r "$module_config_directory/config.$remote_user") {
4169 $module_config_file = "$module_config_directory/config.$remote_user";
4171 elsif (&get_product_name() eq "usermin" &&
4172 (@ruinfo = getpwnam($remote_user)) &&
4173 ($rgroup = getgrgid($ruinfo[3])) &&
4174 -r "$module_config_directory/config.\@$rgroup") {
4175 # Based on group name
4176 $module_config_file = "$module_config_directory/config.\@$rgroup";
4180 $module_config_file = "$module_config_directory/config";
4183 &read_file_cached($module_config_file, \%config);
4185 # Fix up windows-specific substitutions in values
4186 foreach my $k (keys %config) {
4187 if ($config{$k} =~ /\$\{systemroot\}/) {
4188 my $root = &get_windows_root();
4189 $config{$k} =~ s/\$\{systemroot\}/$root/g;
4194 # Record the initial module
4195 $main::initial_module_name ||= $module_name;
4197 # Set some useful variables
4199 $current_themes = $ENV{'MOBILE_DEVICE'} && defined($gconfig{'mobile_theme'}) ?
4200 $gconfig{'mobile_theme'} :
4201 defined($remote_user_attrs{'theme'}) ?
4202 $remote_user_attrs{'theme'} :
4203 defined($gconfig{'theme_'.$remote_user}) ?
4204 $gconfig{'theme_'.$remote_user} :
4205 defined($gconfig{'theme_'.$base_remote_user}) ?
4206 $gconfig{'theme_'.$base_remote_user} :
4208 @current_themes = split(/\s+/, $current_themes);
4209 $current_theme = $current_themes[0];
4210 @theme_root_directories = map { "$root_directory/$_" } @current_themes;
4211 $theme_root_directory = $theme_root_directories[0];
4212 @theme_configs = ( );
4213 foreach my $troot (@theme_root_directories) {
4215 &read_file_cached("$troot/config", \%onetconfig);
4216 &read_file_cached("$troot/config", \%tconfig);
4217 push(@theme_configs, \%onetconfig);
4219 $tb = defined($tconfig{'cs_header'}) ? "bgcolor=#$tconfig{'cs_header'}" :
4220 defined($gconfig{'cs_header'}) ? "bgcolor=#$gconfig{'cs_header'}" :
4222 $cb = defined($tconfig{'cs_table'}) ? "bgcolor=#$tconfig{'cs_table'}" :
4223 defined($gconfig{'cs_table'}) ? "bgcolor=#$gconfig{'cs_table'}" :
4225 $tb .= ' '.$tconfig{'tb'} if ($tconfig{'tb'});
4226 $cb .= ' '.$tconfig{'cb'} if ($tconfig{'cb'});
4227 if ($tconfig{'preload_functions'}) {
4228 # Force load of theme functions right now, if requested
4229 &load_theme_library();
4231 if ($tconfig{'oofunctions'} && !$main::loaded_theme_oo_library++) {
4232 # Load the theme's Webmin:: package classes
4233 do "$theme_root_directory/$tconfig{'oofunctions'}";
4238 $webmin_logfile = $gconfig{'webmin_log'} ? $gconfig{'webmin_log'}
4239 : "$var_directory/webmin.log";
4241 # Load language strings into %text
4242 my @langs = &list_languages();
4244 if ($gconfig{'acceptlang'}) {
4245 foreach my $a (split(/,/, $ENV{'HTTP_ACCEPT_LANGUAGE'})) {
4246 my ($al) = grep { $_->{'lang'} eq $a } @langs;
4248 $accepted_lang = $al->{'lang'};
4253 $current_lang = $force_lang ? $force_lang :
4254 $accepted_lang ? $accepted_lang :
4255 $remote_user_attrs{'lang'} ? $remote_user_attrs{'lang'} :
4256 $gconfig{"lang_$remote_user"} ? $gconfig{"lang_$remote_user"} :
4257 $gconfig{"lang_$base_remote_user"} ? $gconfig{"lang_$base_remote_user"} :
4258 $gconfig{"lang"} ? $gconfig{"lang"} : $default_lang;
4259 foreach my $l (@langs) {
4260 $current_lang_info = $l if ($l->{'lang'} eq $current_lang);
4262 @lang_order_list = &unique($default_lang,
4263 split(/:/, $current_lang_info->{'fallback'}),
4265 %text = &load_language($module_name);
4266 %text || &error("Failed to determine Webmin root from SERVER_ROOT, SCRIPT_FILENAME or the full command line");
4268 # Get the %module_info for this module
4270 my ($mi) = grep { $_->{'dir'} eq $module_name }
4271 &get_all_module_infos(2);
4272 %module_info = %$mi;
4273 $module_root_directory = &module_root_directory($module_name);
4276 if ($module_name && !$main::no_acl_check &&
4277 !defined($ENV{'FOREIGN_MODULE_NAME'})) {
4278 # Check if the HTTP user can access this module
4279 if (!&foreign_available($module_name)) {
4280 if (!&foreign_check($module_name)) {
4281 &error(&text('emodulecheck',
4282 "<i>$module_info{'desc'}</i>"));
4285 &error(&text('emodule', "<i>$u</i>",
4286 "<i>$module_info{'desc'}</i>"));
4289 $main::no_acl_check++;
4292 # Check the Referer: header for nasty redirects
4293 my @referers = split(/\s+/, $gconfig{'referers'});
4295 if ($ENV{'HTTP_REFERER'} =~/^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?([^\/:@]+)/) {
4298 my $http_host = $ENV{'HTTP_HOST'};
4299 $http_host =~ s/:\d+$//;
4300 my $unsafe_index = $unsafe_index_cgi ||
4301 &get_module_variable('$unsafe_index_cgi');
4303 ($ENV{'SCRIPT_NAME'} !~ /^\/(index.cgi)?$/ || $unsafe_index) &&
4304 ($ENV{'SCRIPT_NAME'} !~ /^\/([a-z0-9\_\-]+)\/(index.cgi)?$/i ||
4306 $0 !~ /(session_login|pam_login)\.cgi$/ && !$gconfig{'referer'} &&
4307 $ENV{'MINISERV_CONFIG'} && !$main::no_referers_check &&
4308 $ENV{'HTTP_USER_AGENT'} !~ /^Webmin/i &&
4309 ($referer_site && $referer_site ne $http_host &&
4310 &indexof($referer_site, @referers) < 0 ||
4311 !$referer_site && $gconfig{'referers_none'}) &&
4312 !$trust_unknown_referers &&
4313 !&get_module_variable('$trust_unknown_referers')) {
4314 # Looks like a link from elsewhere .. show an error
4315 &header($text{'referer_title'}, "", undef, 0, 1, 1);
4317 $prot = lc($ENV{'HTTPS'}) eq 'on' ? "https" : "http";
4318 my $url = "<tt>".&html_escape("$prot://$ENV{'HTTP_HOST'}$ENV{'REQUEST_URI'}")."</tt>";
4319 if ($referer_site) {
4321 print &text('referer_warn',
4322 "<tt>".&html_escape($ENV{'HTTP_REFERER'})."</tt>", $url);
4324 print &text('referer_fix1', &html_escape($http_host)),"<p>\n";
4325 print &text('referer_fix2', &html_escape($http_host)),"<p>\n";
4328 # No referer info given
4329 print &text('referer_warn_unknown', $url),"<p>\n";
4330 print &text('referer_fix1u'),"<p>\n";
4331 print &text('referer_fix2u'),"<p>\n";
4335 &footer("/", $text{'index'});
4338 $main::no_referers_check++;
4339 $main::completed_referers_check++;
4341 # Call theme post-init
4342 if (defined(&theme_post_init_config)) {
4343 &theme_post_init_config(@_);
4346 # Record that we have done the calling library in this package
4347 my ($callpkg, $lib) = caller();
4349 $main::done_foreign_require{$callpkg,$lib} = 1;
4351 # If a licence checking is enabled, do it now
4352 if ($gconfig{'licence_module'} && !$main::done_licence_module_check &&
4353 &foreign_check($gconfig{'licence_module'}) &&
4354 -r "$root_directory/$gconfig{'licence_module'}/licence_check.pl") {
4355 my $oldpwd = &get_current_dir();
4356 $main::done_licence_module_check++;
4357 $main::licence_module = $gconfig{'licence_module'};
4358 &foreign_require($main::licence_module, "licence_check.pl");
4359 ($main::licence_status, $main::licence_message) =
4360 &foreign_call($main::licence_module, "check_licence");
4364 # Export global variables to caller
4365 if ($main::export_to_caller) {
4366 foreach my $v ('$config_file', '%gconfig', '$null_file',
4367 '$path_separator', '@root_directories',
4368 '$root_directory', '$module_name',
4369 '$base_remote_user', '$remote_user',
4370 '$remote_user_proto', '%remote_user_attrs',
4371 '$module_config_directory', '$module_config_file',
4372 '%config', '@current_themes', '$current_theme',
4373 '@theme_root_directories', '$theme_root_directory',
4374 '%tconfig','@theme_configs', '$tb', '$cb', '$scriptname',
4375 '$webmin_logfile', '$current_lang',
4376 '$current_lang_info', '@lang_order_list', '%text',
4377 '%module_info', '$module_root_directory') {
4378 my ($vt, $vn) = split('', $v, 2);
4379 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
4386 =head2 load_language([module], [directory])
4388 Returns a hashtable mapping text codes to strings in the appropriate language,
4389 based on the $current_lang global variable, which is in turn set based on
4390 the Webmin user's selection. The optional module parameter tells the function
4391 which module to load strings for, and defaults to the calling module. The
4392 optional directory parameter can be used to load strings from a directory
4395 In regular module development you will never need to call this function
4396 directly, as init_config calls it for you, and places the module's strings
4397 into the %text hash.
4403 my $root = $root_directory;
4404 my $ol = $gconfig{'overlang'};
4405 my ($dir) = ($_[1] || "lang");
4407 # Read global lang files
4408 foreach my $o (@lang_order_list) {
4409 my $ok = &read_file_cached("$root/$dir/$o", \%text);
4410 return () if (!$ok && $o eq $default_lang);
4413 foreach my $o (@lang_order_list) {
4414 &read_file_cached("$root/$ol/$o", \%text);
4417 &read_file_cached("$config_directory/custom-lang", \%text);
4420 # Read module's lang files
4421 my $mdir = &module_root_directory($_[0]);
4422 foreach my $o (@lang_order_list) {
4423 &read_file_cached("$mdir/$dir/$o", \%text);
4426 foreach $o (@lang_order_list) {
4427 &read_file_cached("$mdir/$ol/$o", \%text);
4430 &read_file_cached("$config_directory/$_[0]/custom-lang", \%text);
4432 foreach $k (keys %text) {
4433 $text{$k} =~ s/\$(\{([^\}]+)\}|([A-Za-z0-9\.\-\_]+))/text_subs($2 || $3,\%text)/ge;
4436 if (defined(&theme_load_language)) {
4437 &theme_load_language(\%text, $_[0]);
4442 =head2 text_subs(string)
4444 Used internally by load_language to expand $code substitutions in language
4450 if (substr($_[0], 0, 8) eq "include:") {
4453 open(INCLUDE, substr($_[0], 8));
4461 my $t = $_[1]->{$_[0]};
4462 return defined($t) ? $t : '$'.$_[0];
4466 =head2 text(message, [substitute]+)
4468 Returns a translated message from %text, but with $1, $2, etc.. replaced with
4469 the substitute parameters. This makes it easy to use strings with placeholders
4470 that get replaced with programmatically generated text. For example :
4472 print &text('index_hello', $remote_user),"<p>\n";
4477 my $t = &get_module_variable('%text', 1);
4478 my $rv = exists($t->{$_[0]}) ? $t->{$_[0]} : $text{$_[0]};
4479 for(my $i=1; $i<@_; $i++) {
4480 $rv =~ s/\$$i/$_[$i]/g;
4485 =head2 encode_base64(string)
4487 Encodes a string into base64 format, for use in MIME email or HTTP
4488 authorization headers.
4494 pos($_[0]) = 0; # ensure start at the beginning
4495 while ($_[0] =~ /(.{1,57})/gs) {
4496 $res .= substr(pack('u57', $1), 1)."\n";
4499 $res =~ tr|\` -_|AA-Za-z0-9+/|;
4500 my $padding = (3 - length($_[0]) % 3) % 3;
4501 $res =~ s/.{$padding}$/'=' x $padding/e if ($padding);
4505 =head2 decode_base64(string)
4507 Converts a base64-encoded string into plain text. The opposite of encode_base64.
4514 $str =~ tr|A-Za-z0-9+=/||cd; # remove non-base64 chars
4515 if (length($str) % 4) {
4518 $str =~ s/=+$//; # remove padding
4519 $str =~ tr|A-Za-z0-9+/| -_|; # convert to uuencoded format
4520 while ($str =~ /(.{1,60})/gs) {
4521 my $len = chr(32 + length($1)*3/4); # compute length byte
4522 $res .= unpack("u", $len . $1 ); # uudecode
4527 =head2 get_module_info(module, [noclone], [forcache])
4529 Returns a hash containg details of the given module. Some useful keys are :
4531 =item dir - The module directory, like sendmail.
4533 =item desc - Human-readable description, in the current users' language.
4535 =item version - Optional module version number.
4537 =item os_support - List of supported operating systems and versions.
4539 =item category - Category on Webmin's left menu, like net.
4544 return () if ($_[0] =~ /^\./);
4545 my (%rv, $clone, $o);
4546 my $mdir = &module_root_directory($_[0]);
4547 &read_file_cached("$mdir/module.info", \%rv) || return ();
4549 # A clone is a module that links to another directory under the root
4550 foreach my $r (@root_directories) {
4551 if (&is_under_directory($r, $mdir)) {
4557 foreach $o (@lang_order_list) {
4558 $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4559 $rv{"longdesc"} = $rv{"longdesc_$o"} if ($rv{"longdesc_$o"});
4561 if ($clone && !$_[1] && $config_directory) {
4562 $rv{'clone'} = $rv{'desc'};
4563 &read_file("$config_directory/$_[0]/clone", \%rv);
4566 my %module_categories;
4567 &read_file_cached("$config_directory/webmin.cats", \%module_categories);
4568 my $pn = &get_product_name();
4569 if (defined($rv{'category_'.$pn})) {
4570 # Can override category for webmin/usermin
4571 $rv{'category'} = $rv{'category_'.$pn};
4573 $rv{'realcategory'} = $rv{'category'};
4574 $rv{'category'} = $module_categories{$_[0]}
4575 if (defined($module_categories{$_[0]}));
4577 # Apply description overrides
4578 $rv{'realdesc'} = $rv{'desc'};
4580 &read_file_cached("$config_directory/webmin.descs", \%descs);
4581 if ($descs{$_[0]." ".$current_lang}) {
4582 $rv{'desc'} = $descs{$_[0]." ".$current_lang};
4584 elsif ($descs{$_[0]}) {
4585 $rv{'desc'} = $descs{$_[0]};
4589 # Apply per-user description overridde
4590 my %gaccess = &get_module_acl(undef, "");
4591 if ($gaccess{'desc_'.$_[0]}) {
4592 $rv{'desc'} = $gaccess{'desc_'.$_[0]};
4596 if ($rv{'longdesc'}) {
4597 # All standard modules have an index.cgi
4598 $rv{'index_link'} = 'index.cgi';
4601 # Call theme-specific override function
4602 if (defined(&theme_get_module_info)) {
4603 %rv = &theme_get_module_info(\%rv, $_[0], $_[1], $_[2]);
4609 =head2 get_all_module_infos(cachemode)
4611 Returns a list contains the information on all modules in this webmin
4612 install, including clones. Uses caching to reduce the number of module.info
4613 files that need to be read. Each element of the array is a hash reference
4614 in the same format as returned by get_module_info. The cache mode flag can be :
4615 0 = read and write, 1 = don't read or write, 2 = read only
4618 sub get_all_module_infos
4622 # Is the cache out of date? (ie. have any of the root's changed?)
4623 my $cache_file = "$config_directory/module.infos.cache";
4625 if (&read_file_cached($cache_file, \%cache)) {
4626 foreach my $r (@root_directories) {
4628 if ($st[9] != $cache{'mtime_'.$r}) {
4638 if ($_[0] != 1 && !$changed && $cache{'lang'} eq $current_lang) {
4639 # Can use existing module.info cache
4641 foreach my $k (keys %cache) {
4642 if ($k =~ /^(\S+) (\S+)$/) {
4643 $mods{$1}->{$2} = $cache{$k};
4646 @rv = map { $mods{$_} } (keys %mods) if (%mods);
4649 # Need to rebuild cache
4651 foreach my $r (@root_directories) {
4653 foreach my $m (readdir(DIR)) {
4654 next if ($m =~ /^(config-|\.)/ || $m =~ /\.(cgi|pl)$/);
4655 my %minfo = &get_module_info($m, 0, 1);
4656 next if (!%minfo || !$minfo{'dir'});
4658 foreach $k (keys %minfo) {
4659 $cache{"${m} ${k}"} = $minfo{$k};
4664 $cache{'mtime_'.$r} = $st[9];
4666 $cache{'lang'} = $current_lang;
4667 &write_file($cache_file, \%cache) if (!$_[0] && $< == 0 && $> == 0);
4670 # Override descriptions for modules for current user
4671 my %gaccess = &get_module_acl(undef, "");
4672 foreach my $m (@rv) {
4673 if ($gaccess{"desc_".$m->{'dir'}}) {
4674 $m->{'desc'} = $gaccess{"desc_".$m->{'dir'}};
4678 # Apply installed flags
4680 &read_file_cached("$config_directory/installed.cache", \%installed);
4681 foreach my $m (@rv) {
4682 $m->{'installed'} = $installed{$m->{'dir'}};
4688 =head2 get_theme_info(theme)
4690 Returns a hash containing a theme's details, taken from it's theme.info file.
4691 Some useful keys are :
4693 =item dir - The theme directory, like blue-theme.
4695 =item desc - Human-readable description, in the current users' language.
4697 =item version - Optional module version number.
4699 =item os_support - List of supported operating systems and versions.
4704 return () if ($_[0] =~ /^\./);
4706 my $tdir = &module_root_directory($_[0]);
4707 &read_file("$tdir/theme.info", \%rv) || return ();
4708 foreach my $o (@lang_order_list) {
4709 $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4715 =head2 list_languages
4717 Returns an array of supported languages, taken from Webmin's os_list.txt file.
4718 Each is a hash reference with the following keys :
4720 =item lang - The short language code, like es for Spanish.
4722 =item desc - A human-readable description, in English.
4724 =item charset - An optional character set to use when displaying the language.
4726 =item titles - Set to 1 only if Webmin has title images for the language.
4728 =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.
4733 if (!@main::list_languages_cache) {
4736 open(LANG, "$root_directory/lang_list.txt");
4738 if (/^(\S+)\s+(.*)/) {
4739 my $l = { 'desc' => $2 };
4740 foreach $o (split(/,/, $1)) {
4741 if ($o =~ /^([^=]+)=(.*)$/) {
4745 $l->{'index'} = scalar(@rv);
4746 push(@main::list_languages_cache, $l);
4750 @main::list_languages_cache = sort { $a->{'desc'} cmp $b->{'desc'} }
4751 @main::list_languages_cache;
4753 return @main::list_languages_cache;
4756 =head2 read_env_file(file, &hash)
4758 Similar to Webmin's read_file function, but handles files containing shell
4759 environment variables formatted like :
4764 The file parameter is the full path to the file to read, and hash a Perl hash
4765 ref to read names and values into.
4771 &open_readfile(FILE, $_[0]) || return 0;
4774 if (/^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*"(.*)"/i ||
4775 /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*'(.*)'/i ||
4776 /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*(.*)/i) {
4784 =head2 write_env_file(file, &hash, [export])
4786 Writes out a hash to a file in name='value' format, suitable for use in a shell
4787 script. The parameters are :
4789 =item file - Full path for a file to write to
4791 =item hash - Hash reference of names and values to write.
4793 =item export - If set to 1, preceed each variable setting with the word 'export'.
4798 my $exp = $_[2] ? "export " : "";
4799 &open_tempfile(FILE, ">$_[0]");
4800 foreach my $k (keys %{$_[1]}) {
4801 my $v = $_[1]->{$k};
4802 if ($v =~ /^\S+$/) {
4803 &print_tempfile(FILE, "$exp$k=$v\n");
4806 &print_tempfile(FILE, "$exp$k=\"$v\"\n");
4809 &close_tempfile(FILE);
4812 =head2 lock_file(filename, [readonly], [forcefile])
4814 Lock a file for exclusive access. If the file is already locked, spin
4815 until it is freed. Uses a .lock file, which is not 100% reliable, but seems
4816 to work OK. The parameters are :
4818 =item filename - File or directory to lock.
4820 =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.
4822 =item forcefile - Force the file to be considered as a real file and not a symlink for Webmin actions logging purposes.
4827 my $realfile = &translate_filename($_[0]);
4828 return 0 if (!$_[0] || defined($main::locked_file_list{$realfile}));
4829 my $no_lock = !&can_lock_file($realfile);
4830 my $lock_tries_count = 0;
4833 if (!$no_lock && open(LOCKING, "$realfile.lock")) {
4838 if ($no_lock || !$pid || !kill(0, $pid) || $pid == $$) {
4841 # Create the .lock file
4842 open(LOCKING, ">$realfile.lock") || return 0;
4843 my $lck = eval "flock(LOCKING, 2+4)";
4845 # Lock of lock file failed! Wait till later
4848 print LOCKING $$,"\n";
4849 eval "flock(LOCKING, 8)";
4852 $main::locked_file_list{$realfile} = int($_[1]);
4853 push(@main::temporary_files, "$realfile.lock");
4854 if (($gconfig{'logfiles'} || $gconfig{'logfullfiles'}) &&
4855 !&get_module_variable('$no_log_file_changes') &&
4857 # Grab a copy of this file for later diffing
4859 $main::locked_file_data{$realfile} = undef;
4861 $main::locked_file_type{$realfile} = 1;
4862 $main::locked_file_data{$realfile} = '';
4864 elsif (!$_[2] && ($lnk = readlink($realfile))) {
4865 $main::locked_file_type{$realfile} = 2;
4866 $main::locked_file_data{$realfile} = $lnk;
4868 elsif (open(ORIGFILE, $realfile)) {
4869 $main::locked_file_type{$realfile} = 0;
4870 $main::locked_file_data{$realfile} = '';
4873 $main::locked_file_data{$realfile} .=$_;
4882 if ($lock_tries_count++ > 5*60) {
4883 # Give up after 5 minutes
4884 &error(&text('elock_tries', "<tt>$realfile</tt>", 5));
4890 =head2 unlock_file(filename)
4892 Release a lock on a file taken out by lock_file. If Webmin actions logging of
4893 file changes is enabled, then at unlock file a diff will be taken between the
4894 old and new contents, and stored under /var/webmin/diffs when webmin_log is
4895 called. This can then be viewed in the Webmin Actions Log module.
4900 my $realfile = &translate_filename($_[0]);
4901 return if (!$_[0] || !defined($main::locked_file_list{$realfile}));
4902 unlink("$realfile.lock") if (&can_lock_file($realfile));
4903 delete($main::locked_file_list{$realfile});
4904 if (exists($main::locked_file_data{$realfile})) {
4905 # Diff the new file with the old
4907 my $lnk = readlink($realfile);
4908 my $type = -d _ ? 1 : $lnk ? 2 : 0;
4909 my $oldtype = $main::locked_file_type{$realfile};
4910 my $new = !defined($main::locked_file_data{$realfile});
4911 if ($new && !-e _) {
4912 # file doesn't exist, and never did! do nothing ..
4914 elsif ($new && $type == 1 || !$new && $oldtype == 1) {
4915 # is (or was) a directory ..
4916 if (-d _ && !defined($main::locked_file_data{$realfile})) {
4917 push(@main::locked_file_diff,
4918 { 'type' => 'mkdir', 'object' => $realfile });
4920 elsif (!-d _ && defined($main::locked_file_data{$realfile})) {
4921 push(@main::locked_file_diff,
4922 { 'type' => 'rmdir', 'object' => $realfile });
4925 elsif ($new && $type == 2 || !$new && $oldtype == 2) {
4926 # is (or was) a symlink ..
4927 if ($lnk && !defined($main::locked_file_data{$realfile})) {
4928 push(@main::locked_file_diff,
4929 { 'type' => 'symlink', 'object' => $realfile,
4932 elsif (!$lnk && defined($main::locked_file_data{$realfile})) {
4933 push(@main::locked_file_diff,
4934 { 'type' => 'unsymlink', 'object' => $realfile,
4935 'data' => $main::locked_file_data{$realfile} });
4937 elsif ($lnk ne $main::locked_file_data{$realfile}) {
4938 push(@main::locked_file_diff,
4939 { 'type' => 'resymlink', 'object' => $realfile,
4944 # is a file, or has changed type?!
4945 my ($diff, $delete_file);
4946 my $type = "modify";
4948 open(NEWFILE, ">$realfile");
4953 if (!defined($main::locked_file_data{$realfile})) {
4956 open(ORIGFILE, ">$realfile.webminorig");
4957 print ORIGFILE $main::locked_file_data{$realfile};
4959 $diff = &backquote_command(
4960 "diff ".quotemeta("$realfile.webminorig")." ".
4961 quotemeta($realfile)." 2>/dev/null");
4962 push(@main::locked_file_diff,
4963 { 'type' => $type, 'object' => $realfile,
4964 'data' => $diff } ) if ($diff);
4965 unlink("$realfile.webminorig");
4966 unlink($realfile) if ($delete_file);
4969 if ($gconfig{'logfullfiles'}) {
4970 # Add file details to list of those to fully log
4971 $main::orig_file_data{$realfile} ||=
4972 $main::locked_file_data{$realfile};
4973 $main::orig_file_type{$realfile} ||=
4974 $main::locked_file_type{$realfile};
4977 delete($main::locked_file_data{$realfile});
4978 delete($main::locked_file_type{$realfile});
4982 =head2 test_lock(file)
4984 Returns 1 if some file is currently locked, 0 if not.
4989 my $realfile = &translate_filename($_[0]);
4990 return 0 if (!$_[0]);
4991 return 1 if (defined($main::locked_file_list{$realfile}));
4992 return 0 if (!&can_lock_file($realfile));
4994 if (open(LOCKING, "$realfile.lock")) {
4999 return $pid && kill(0, $pid);
5002 =head2 unlock_all_files
5004 Unlocks all files locked by the current script.
5007 sub unlock_all_files
5009 foreach $f (keys %main::locked_file_list) {
5014 =head2 can_lock_file(file)
5016 Returns 1 if some file should be locked, based on the settings in the
5017 Webmin Configuration module. For internal use by lock_file only.
5022 if (&is_readonly_mode()) {
5023 return 0; # never lock in read-only mode
5025 elsif ($gconfig{'lockmode'} == 0) {
5028 elsif ($gconfig{'lockmode'} == 1) {
5032 # Check if under any of the directories
5034 foreach my $d (split(/\t+/, $gconfig{'lockdirs'})) {
5035 if (&same_file($d, $_[0]) ||
5036 &is_under_directory($d, $_[0])) {
5040 return $gconfig{'lockmode'} == 2 ? $match : !$match;
5044 =head2 webmin_log(action, type, object, ¶ms, [module], [host, script-on-host, client-ip])
5046 Log some action taken by a user. This is typically called at the end of a
5047 script, once all file changes are complete and all commands run. The
5050 =item action - A short code for the action being performed, like 'create'.
5052 =item type - A code for the type of object the action is performed to, like 'user'.
5054 =item object - A short name for the object, like 'joe' if the Unix user 'joe' was just created.
5056 =item params - A hash ref of additional information about the action.
5058 =item module - Name of the module in which the action was performed, which defaults to the current module.
5060 =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.
5062 =item script-on-host - Script name like create_user.cgi on the host the action was performed on.
5064 =item client-ip - IP address of the browser that performed the action.
5069 return if (!$gconfig{'log'} || &is_readonly_mode());
5070 my $m = $_[4] ? $_[4] : &get_module_name();
5072 if ($gconfig{'logclear'}) {
5073 # check if it is time to clear the log
5074 my @st = stat("$webmin_logfile.time");
5075 my $write_logtime = 0;
5077 if ($st[9]+$gconfig{'logtime'}*60*60 < time()) {
5078 # clear logfile and all diff files
5079 &unlink_file("$ENV{'WEBMIN_VAR'}/diffs");
5080 &unlink_file("$ENV{'WEBMIN_VAR'}/files");
5081 &unlink_file("$ENV{'WEBMIN_VAR'}/annotations");
5082 unlink($webmin_logfile);
5089 if ($write_logtime) {
5090 open(LOGTIME, ">$webmin_logfile.time");
5091 print LOGTIME time(),"\n";
5096 # If an action script directory is defined, call the appropriate scripts
5097 if ($gconfig{'action_script_dir'}) {
5098 my ($action, $type, $object) = ($_[0], $_[1], $_[2]);
5099 my ($basedir) = $gconfig{'action_script_dir'};
5101 for my $dir ($basedir/$type/$action, $basedir/$type, $basedir) {
5104 opendir(DIR, $dir) or die "Can't open $dir: $!";
5105 while (defined($file = readdir(DIR))) {
5106 next if ($file =~ /^\.\.?$/); # skip '.' and '..'
5107 if (-x "$dir/$file") {
5108 # Call a script notifying it of the action
5110 $ENV{'ACTION_MODULE'} = &get_module_name();
5111 $ENV{'ACTION_ACTION'} = $_[0];
5112 $ENV{'ACTION_TYPE'} = $_[1];
5113 $ENV{'ACTION_OBJECT'} = $_[2];
5114 $ENV{'ACTION_SCRIPT'} = $script_name;
5115 foreach my $p (keys %param) {
5116 $ENV{'ACTION_PARAM_'.uc($p)} = $param{$p};
5118 system("$dir/$file", @_,
5119 "<$null_file", ">$null_file", "2>&1");
5127 # should logging be done at all?
5128 return if ($gconfig{'logusers'} && &indexof($base_remote_user,
5129 split(/\s+/, $gconfig{'logusers'})) < 0);
5130 return if ($gconfig{'logmodules'} && &indexof($m,
5131 split(/\s+/, $gconfig{'logmodules'})) < 0);
5135 my @tm = localtime($now);
5136 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
5137 my $id = sprintf "%d.%d.%d", $now, $$, $main::action_id_count;
5138 $main::action_id_count++;
5139 my $line = sprintf "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s %s \"%s\" \"%s\" \"%s\"",
5140 $id, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
5141 $tm[2], $tm[1], $tm[0],
5142 $remote_user || '-',
5143 $main::session_id || '-',
5144 $_[7] || $ENV{'REMOTE_HOST'} || '-',
5145 $m, $_[5] ? "$_[5]:$_[6]" : $script_name,
5146 $_[0], $_[1] ne '' ? $_[1] : '-', $_[2] ne '' ? $_[2] : '-';
5148 foreach my $k (sort { $a cmp $b } keys %{$_[3]}) {
5149 my $v = $_[3]->{$k};
5155 elsif (ref($v) eq 'ARRAY') {
5159 $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
5160 $line .= " $k='$vv'";
5164 foreach $vv (split(/\0/, $v)) {
5166 $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
5167 $line .= " $k='$vv'";
5170 $param{$k} = join(" ", @pv);
5172 open(WEBMINLOG, ">>$webmin_logfile");
5173 print WEBMINLOG $line,"\n";
5175 if ($gconfig{'logperms'}) {
5176 chmod(oct($gconfig{'logperms'}), $webmin_logfile);
5179 chmod(0600, $webmin_logfile);
5182 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
5183 # Find and record the changes made to any locked files, or commands run
5185 mkdir("$ENV{'WEBMIN_VAR'}/diffs", 0700);
5186 foreach my $d (@main::locked_file_diff) {
5187 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$id", 0700);
5188 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i");
5189 print DIFFLOG "$d->{'type'} $d->{'object'}\n";
5190 print DIFFLOG $d->{'data'};
5192 if ($d->{'input'}) {
5193 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
5194 print DIFFLOG $d->{'input'};
5197 if ($gconfig{'logperms'}) {
5198 chmod(oct($gconfig{'logperms'}),
5199 "$ENV{'WEBMIN_VAR'}/diffs/$id/$i",
5200 "$ENV{'WEBMIN_VAR'}/diffs/$id/$i.input");
5204 @main::locked_file_diff = undef;
5207 if ($gconfig{'logfullfiles'}) {
5208 # Save the original contents of any modified files
5210 mkdir("$ENV{'WEBMIN_VAR'}/files", 0700);
5211 foreach my $f (keys %main::orig_file_data) {
5212 mkdir("$ENV{'WEBMIN_VAR'}/files/$id", 0700);
5213 open(ORIGLOG, ">$ENV{'WEBMIN_VAR'}/files/$id/$i");
5214 if (!defined($main::orig_file_type{$f})) {
5215 print ORIGLOG -1," ",$f,"\n";
5218 print ORIGLOG $main::orig_file_type{$f}," ",$f,"\n";
5220 print ORIGLOG $main::orig_file_data{$f};
5222 if ($gconfig{'logperms'}) {
5223 chmod(oct($gconfig{'logperms'}),
5224 "$ENV{'WEBMIN_VAR'}/files/$id.$i");
5228 %main::orig_file_data = undef;
5229 %main::orig_file_type = undef;
5232 if ($miniserv::page_capture_out) {
5233 # Save the whole page output
5234 mkdir("$ENV{'WEBMIN_VAR'}/output", 0700);
5235 open(PAGEOUT, ">$ENV{'WEBMIN_VAR'}/output/$id");
5236 print PAGEOUT $miniserv::page_capture_out;
5238 if ($gconfig{'logperms'}) {
5239 chmod(oct($gconfig{'logperms'}),
5240 "$ENV{'WEBMIN_VAR'}/output/$id");
5245 if ($gconfig{'logsyslog'}) {
5246 eval 'use Sys::Syslog qw(:DEFAULT setlogsock);
5247 openlog(&get_product_name(), "cons,pid,ndelay", "daemon");
5248 setlogsock("inet");';
5250 # Syslog module is installed .. try to convert to a
5251 # human-readable form
5253 my $mod = &get_module_name();
5254 my $mdir = module_root_directory($mod);
5255 if (-r "$mdir/log_parser.pl") {
5256 &foreign_require($mod, "log_parser.pl");
5258 foreach my $k (keys %{$_[3]}) {
5259 my $v = $_[3]->{$k};
5260 if (ref($v) eq 'ARRAY') {
5261 $params{$k} = join("\0", @$v);
5267 $msg = &foreign_call($mod, "parse_webmin_log",
5268 $remote_user, $script_name,
5269 $_[0], $_[1], $_[2], \%params);
5270 $msg =~ s/<[^>]*>//g; # Remove tags
5272 elsif ($_[0] eq "_config_") {
5273 my %wtext = &load_language("webminlog");
5274 $msg = $wtext{'search_config'};
5276 $msg ||= "$_[0] $_[1] $_[2]";
5277 my %info = &get_module_info($m);
5278 eval { syslog("info", "%s", "[$info{'desc'}] $msg"); };
5282 print STDERR $miniserv::page_capture_out,"\n";
5285 =head2 additional_log(type, object, data, [input])
5287 Records additional log data for an upcoming call to webmin_log, such
5288 as a command that was run or SQL that was executed. Typically you will never
5289 need to call this function directory.
5294 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
5295 push(@main::locked_file_diff,
5296 { 'type' => $_[0], 'object' => $_[1], 'data' => $_[2],
5297 'input' => $_[3] } );
5301 =head2 webmin_debug_log(type, message)
5303 Write something to the Webmin debug log. For internal use only.
5306 sub webmin_debug_log
5308 my ($type, $msg) = @_;
5309 return 0 if (!$main::opened_debug_log);
5310 return 0 if ($gconfig{'debug_no'.$main::webmin_script_type});
5311 if ($gconfig{'debug_modules'}) {
5312 my @dmods = split(/\s+/, $gconfig{'debug_modules'});
5313 return 0 if (&indexof($main::initial_module_name, @dmods) < 0);
5316 my @tm = localtime($now);
5318 "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s \"%s\"",
5319 $$, $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900,
5320 $tm[2], $tm[1], $tm[0],
5321 $remote_user || "-",
5322 $ENV{'REMOTE_HOST'} || "-",
5323 &get_module_name() || "-",
5326 seek(main::DEBUGLOG, 0, 2);
5327 print main::DEBUGLOG $line."\n";
5331 =head2 system_logged(command)
5333 Just calls the Perl system() function, but also logs the command run.
5338 if (&is_readonly_mode()) {
5339 print STDERR "Vetoing command $_[0]\n";
5342 my @realcmd = ( &translate_command($_[0]), @_[1..$#_] );
5343 my $cmd = join(" ", @realcmd);
5345 if ($cmd =~ s/(\s*&\s*)$//) {
5348 while($cmd =~ s/(\d*)(<|>)((\/(tmp|dev)\S+)|&\d+)\s*$//) { }
5349 $cmd =~ s/^\((.*)\)\s*$/$1/;
5351 &additional_log('exec', undef, $cmd);
5352 return system(@realcmd);
5355 =head2 backquote_logged(command)
5357 Executes a command and returns the output (like `command`), but also logs it.
5360 sub backquote_logged
5362 if (&is_readonly_mode()) {
5364 print STDERR "Vetoing command $_[0]\n";
5367 my $realcmd = &translate_command($_[0]);
5370 if ($cmd =~ s/(\s*&\s*)$//) {
5373 while($cmd =~ s/(\d*)(<|>)((\/(tmp\/.webmin|dev)\S+)|&\d+)\s*$//) { }
5374 $cmd =~ s/^\((.*)\)\s*$/$1/;
5376 &additional_log('exec', undef, $cmd);
5377 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
5381 =head2 backquote_with_timeout(command, timeout, safe?, [maxlines])
5383 Runs some command, waiting at most the given number of seconds for it to
5384 complete, and returns the output. The maxlines parameter sets the number
5385 of lines of output to capture. The safe parameter should be set to 1 if the
5386 command is safe for read-only mode users to run.
5389 sub backquote_with_timeout
5391 my $realcmd = &translate_command($_[0]);
5392 &webmin_debug_log('CMD', "cmd=$realcmd timeout=$_[1]")
5393 if ($gconfig{'debug_what_cmd'});
5395 my $pid = &open_execute_command(OUT, "($realcmd) <$null_file", 1, $_[2]);
5400 my $elapsed = time() - $start;
5401 last if ($elapsed > $_[1]);
5403 vec($rmask, fileno(OUT), 1) = 1;
5404 my $sel = select($rmask, undef, undef, $_[1] - $elapsed);
5405 last if (!$sel || $sel < 0);
5407 last if (!defined($line));
5410 if ($_[3] && $linecount >= $_[3]) {
5415 if (kill('TERM', $pid) && time() - $start >= $_[1]) {
5419 return wantarray ? ($out, $timed_out) : $out;
5422 =head2 backquote_command(command, safe?)
5424 Executes a command and returns the output (like `command`), subject to
5425 command translation. The safe parameter should be set to 1 if the command
5426 is safe for read-only mode users to run.
5429 sub backquote_command
5431 if (&is_readonly_mode() && !$_[1]) {
5432 print STDERR "Vetoing command $_[0]\n";
5436 my $realcmd = &translate_command($_[0]);
5437 &webmin_debug_log('CMD', "cmd=$realcmd") if ($gconfig{'debug_what_cmd'});
5441 =head2 kill_logged(signal, pid, ...)
5443 Like Perl's built-in kill function, but also logs the fact that some process
5444 was killed. On Windows, falls back to calling process.exe to terminate a
5450 return scalar(@_)-1 if (&is_readonly_mode());
5451 &webmin_debug_log('KILL', "signal=$_[0] pids=".join(" ", @_[1..@_-1]))
5452 if ($gconfig{'debug_what_procs'});
5453 &additional_log('kill', $_[0], join(" ", @_[1..@_-1])) if (@_ > 1);
5454 if ($gconfig{'os_type'} eq 'windows') {
5455 # Emulate some kills with process.exe
5456 my $arg = $_[0] eq "KILL" ? "-k" :
5457 $_[0] eq "TERM" ? "-q" :
5458 $_[0] eq "STOP" ? "-s" :
5459 $_[0] eq "CONT" ? "-r" : undef;
5461 foreach my $p (@_[1..@_-1]) {
5463 $ok ||= kill($_[0], $p);
5466 &execute_command("process $arg $p");
5478 =head2 rename_logged(old, new)
5480 Re-names a file and logs the rename. If the old and new files are on different
5481 filesystems, calls mv or the Windows rename function to do the job.
5486 &additional_log('rename', $_[0], $_[1]) if ($_[0] ne $_[1]);
5487 return &rename_file($_[0], $_[1]);
5490 =head2 rename_file(old, new)
5492 Renames a file or directory. If the old and new files are on different
5493 filesystems, calls mv or the Windows rename function to do the job.
5498 if (&is_readonly_mode()) {
5499 print STDERR "Vetoing rename from $_[0] to $_[1]\n";
5502 my $src = &translate_filename($_[0]);
5503 my $dst = &translate_filename($_[1]);
5504 &webmin_debug_log('RENAME', "src=$src dst=$dst")
5505 if ($gconfig{'debug_what_ops'});
5506 my $ok = rename($src, $dst);
5507 if (!$ok && $! !~ /permission/i) {
5508 # Try the mv command, in case this is a cross-filesystem rename
5509 if ($gconfig{'os_type'} eq 'windows') {
5510 # Need to use rename
5511 my $out = &backquote_command("rename ".quotemeta($_[0]).
5512 " ".quotemeta($_[1])." 2>&1");
5514 $! = $out if (!$ok);
5518 my $out = &backquote_command("mv ".quotemeta($_[0]).
5519 " ".quotemeta($_[1])." 2>&1");
5521 $! = $out if (!$ok);
5527 =head2 symlink_logged(src, dest)
5529 Create a symlink, and logs it. Effectively does the same thing as the Perl
5536 my $rv = &symlink_file($_[0], $_[1]);
5537 &unlock_file($_[1]);
5541 =head2 symlink_file(src, dest)
5543 Creates a soft link, unless in read-only mode. Effectively does the same thing
5544 as the Perl symlink function.
5549 if (&is_readonly_mode()) {
5550 print STDERR "Vetoing symlink from $_[0] to $_[1]\n";
5553 my $src = &translate_filename($_[0]);
5554 my $dst = &translate_filename($_[1]);
5555 &webmin_debug_log('SYMLINK', "src=$src dst=$dst")
5556 if ($gconfig{'debug_what_ops'});
5557 return symlink($src, $dst);
5560 =head2 link_file(src, dest)
5562 Creates a hard link, unless in read-only mode. The existing new link file
5563 will be deleted if necessary. Effectively the same as Perl's link function.
5568 if (&is_readonly_mode()) {
5569 print STDERR "Vetoing link from $_[0] to $_[1]\n";
5572 my $src = &translate_filename($_[0]);
5573 my $dst = &translate_filename($_[1]);
5574 &webmin_debug_log('LINK', "src=$src dst=$dst")
5575 if ($gconfig{'debug_what_ops'});
5576 unlink($dst); # make sure link works
5577 return link($src, $dst);
5580 =head2 make_dir(dir, perms, recursive)
5582 Creates a directory and sets permissions on it, unless in read-only mode.
5583 The perms parameter sets the octal permissions to apply, which unlike Perl's
5584 mkdir will really get set. The recursive flag can be set to 1 to have the
5585 function create parent directories too.
5590 my ($dir, $perms, $recur) = @_;
5591 if (&is_readonly_mode()) {
5592 print STDERR "Vetoing directory $dir\n";
5595 $dir = &translate_filename($dir);
5596 my $exists = -d $dir ? 1 : 0;
5597 return 1 if ($exists && $recur); # already exists
5598 &webmin_debug_log('MKDIR', $dir) if ($gconfig{'debug_what_ops'});
5599 my $rv = mkdir($dir, $perms);
5600 if (!$rv && $recur) {
5601 # Failed .. try mkdir -p
5602 my $param = $gconfig{'os_type'} eq 'windows' ? "" : "-p";
5603 my $ex = &execute_command("mkdir $param "."e_path($dir));
5609 chmod($perms, $dir);
5614 =head2 set_ownership_permissions(user, group, perms, file, ...)
5616 Sets the user, group owner and permissions on some files. The parameters are :
5618 =item user - UID or username to change the file owner to. If undef, then the owner is not changed.
5620 =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.
5622 =item perms - Octal permissions set to set on the file. If undef, they are left alone.
5624 =item file - One or more files or directories to modify.
5627 sub set_ownership_permissions
5629 my ($user, $group, $perms, @files) = @_;
5630 if (&is_readonly_mode()) {
5631 print STDERR "Vetoing permission changes on ",join(" ", @files),"\n";
5634 @files = map { &translate_filename($_) } @files;
5635 if ($gconfig{'debug_what_ops'}) {
5636 foreach my $f (@files) {
5637 &webmin_debug_log('PERMS',
5638 "file=$f user=$user group=$group perms=$perms");
5642 if (defined($user)) {
5643 my $uid = $user !~ /^\d+$/ ? getpwnam($user) : $user;
5645 if (defined($group)) {
5646 $gid = $group !~ /^\d+$/ ? getgrnam($group) : $group;
5649 my @uinfo = getpwuid($uid);
5652 $rv = chown($uid, $gid, @files);
5654 if ($rv && defined($perms)) {
5655 $rv = chmod($perms, @files);
5660 =head2 unlink_logged(file, ...)
5662 Like Perl's unlink function, but locks the files beforehand and un-locks them
5663 after so that the deletion is logged by Webmin.
5669 foreach my $f (@_) {
5670 if (!&test_lock($f)) {
5675 my @rv = &unlink_file(@_);
5676 foreach my $f (@_) {
5681 return wantarray ? @rv : $rv[0];
5684 =head2 unlink_file(file, ...)
5686 Deletes some files or directories. Like Perl's unlink function, but also
5687 recursively deletes directories with the rm command if needed.
5692 return 1 if (&is_readonly_mode());
5695 foreach my $f (@_) {
5696 &unflush_file_lines($f);
5697 my $realf = &translate_filename($f);
5698 &webmin_debug_log('UNLINK', $realf) if ($gconfig{'debug_what_ops'});
5700 if (!rmdir($realf)) {
5702 if ($gconfig{'os_type'} eq 'windows') {
5703 # Call del and rmdir commands
5706 my $out = `del /q "$qm" 2>&1`;
5708 $out = `rmdir "$qm" 2>&1`;
5713 my $qm = quotemeta($realf);
5714 $out = `rm -rf $qm 2>&1`;
5723 if (!unlink($realf)) {
5729 return wantarray ? ($rv, $err) : $rv;
5732 =head2 copy_source_dest(source, dest)
5734 Copy some file or directory to a new location. Returns 1 on success, or 0
5735 on failure - also sets $! on failure. If the source is a directory, uses
5736 piped tar commands to copy a whole directory structure including permissions
5740 sub copy_source_dest
5742 return (1, undef) if (&is_readonly_mode());
5743 my ($src, $dst) = @_;
5746 &webmin_debug_log('COPY', "src=$src dst=$dst")
5747 if ($gconfig{'debug_what_ops'});
5748 if ($gconfig{'os_type'} eq 'windows') {
5749 # No tar or cp on windows, so need to use copy command
5753 $out = &backquote_logged("xcopy \"$src\" \"$dst\" /Y /E /I 2>&1");
5756 $out = &backquote_logged("copy /Y \"$src\" \"$dst\" 2>&1");
5764 # A directory .. need to copy with tar command
5765 my @st = stat($src);
5768 &set_ownership_permissions($st[4], $st[5], $st[2], $dst);
5769 $out = &backquote_logged("(cd ".quotemeta($src)." ; tar cf - . | (cd ".quotemeta($dst)." ; tar xf -)) 2>&1");
5776 # Can just copy with cp
5777 my $out = &backquote_logged("cp -p ".quotemeta($src).
5778 " ".quotemeta($dst)." 2>&1");
5784 return wantarray ? ($ok, $err) : $ok;
5787 =head2 remote_session_name(host|&server)
5789 Generates a session ID for some server. For this server, this will always
5790 be an empty string. For a server object it will include the hostname and
5791 port and PID. For a server name, it will include the hostname and PID. For
5795 sub remote_session_name
5797 return ref($_[0]) && $_[0]->{'host'} && $_[0]->{'port'} ?
5798 "$_[0]->{'host'}:$_[0]->{'port'}.$$" :
5799 $_[0] eq "" || ref($_[0]) && $_[0]->{'id'} == 0 ? "" :
5800 ref($_[0]) ? "" : "$_[0].$$";
5803 =head2 remote_foreign_require(server, module, file)
5805 Connects to rpc.cgi on a remote webmin server and have it open a session
5806 to a process that will actually do the require and run functions. This is the
5807 equivalent for foreign_require, but for a remote Webmin system. The server
5808 parameter can either be a hostname of a system registered in the Webmin
5809 Servers Index module, or a hash reference for a system from that module.
5812 sub remote_foreign_require
5814 my $call = { 'action' => 'require',
5817 my $sn = &remote_session_name($_[0]);
5818 if ($remote_session{$sn}) {
5819 $call->{'session'} = $remote_session{$sn};
5822 $call->{'newsession'} = 1;
5824 my $rv = &remote_rpc_call($_[0], $call);
5825 if ($rv->{'session'}) {
5826 $remote_session{$sn} = $rv->{'session'};
5827 $remote_session_server{$sn} = $_[0];
5831 =head2 remote_foreign_call(server, module, function, [arg]*)
5833 Call a function on a remote server. Must have been setup first with
5834 remote_foreign_require for the same server and module. Equivalent to
5835 foreign_call, but with the extra server parameter to specify the remote
5839 sub remote_foreign_call
5841 return undef if (&is_readonly_mode());
5842 my $sn = &remote_session_name($_[0]);
5843 return &remote_rpc_call($_[0], { 'action' => 'call',
5846 'session' => $remote_session{$sn},
5847 'args' => [ @_[3 .. $#_] ] } );
5850 =head2 remote_foreign_check(server, module, [api-only])
5852 Checks if some module is installed and supported on a remote server. Equivilant
5853 to foreign_check, but for the remote Webmin system specified by the server
5857 sub remote_foreign_check
5859 return &remote_rpc_call($_[0], { 'action' => 'check',
5864 =head2 remote_foreign_config(server, module)
5866 Gets the configuration for some module from a remote server, as a hash.
5867 Equivalent to foreign_config, but for a remote system.
5870 sub remote_foreign_config
5872 return &remote_rpc_call($_[0], { 'action' => 'config',
5873 'module' => $_[1] });
5876 =head2 remote_eval(server, module, code)
5878 Evaluates some perl code in the context of a module on a remote webmin server.
5879 The server parameter must be the hostname of a remote system, module must
5880 be a module directory name, and code a string of Perl code to run. This can
5881 only be called after remote_foreign_require for the same server and module.
5886 return undef if (&is_readonly_mode());
5887 my $sn = &remote_session_name($_[0]);
5888 return &remote_rpc_call($_[0], { 'action' => 'eval',
5891 'session' => $remote_session{$sn} });
5894 =head2 remote_write(server, localfile, [remotefile], [remotebasename])
5896 Transfers some local file to another server via Webmin's RPC protocol, and
5897 returns the resulting remote filename. If the remotefile parameter is given,
5898 that is the destination filename which will be used. Otherwise a randomly
5899 selected temporary filename will be used, and returned by the function.
5904 return undef if (&is_readonly_mode());
5906 my $sn = &remote_session_name($_[0]);
5907 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
5908 # Copy data over TCP connection
5909 my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpwrite',
5911 'name' => $_[3] } );
5913 my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
5914 &open_socket($serv || "localhost", $rv->[1], TWRITE, \$error);
5915 return &$main::remote_error_handler("Failed to transfer file : $error")
5918 while(read(FILE, $got, 1024) > 0) {
5922 shutdown(TWRITE, 1);
5924 if ($error && $error !~ /^OK/) {
5925 # Got back an error!
5926 return &$main::remote_error_handler("Failed to transfer file : $error");
5932 # Just pass file contents as parameters
5934 while(read(FILE, $got, 1024) > 0) {
5938 return &remote_rpc_call($_[0], { 'action' => 'write',
5941 'session' => $remote_session{$sn} });
5945 =head2 remote_read(server, localfile, remotefile)
5947 Transfers a file from a remote server to this system, using Webmin's RPC
5948 protocol. The server parameter must be the hostname of a system registered
5949 in the Webmin Servers Index module, localfile is the destination path on this
5950 system, and remotefile is the file to fetch from the remote server.
5955 my $sn = &remote_session_name($_[0]);
5956 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
5957 # Copy data over TCP connection
5958 my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpread',
5959 'file' => $_[2] } );
5961 return &$main::remote_error_handler("Failed to transfer file : $rv->[1]");
5964 my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
5965 &open_socket($serv || "localhost", $rv->[1], TREAD, \$error);
5966 return &$main::remote_error_handler("Failed to transfer file : $error")
5969 open(FILE, ">$_[1]");
5970 while(read(TREAD, $got, 1024) > 0) {
5977 # Just get data as return value
5978 my $d = &remote_rpc_call($_[0], { 'action' => 'read',
5980 'session' => $remote_session{$sn} });
5981 open(FILE, ">$_[1]");
5987 =head2 remote_finished
5989 Close all remote sessions. This happens automatically after a while
5990 anyway, but this function should be called to clean things up faster.
5995 foreach my $sn (keys %remote_session) {
5996 my $server = $remote_session_server{$sn};
5997 &remote_rpc_call($server, { 'action' => 'quit',
5998 'session' => $remote_session{$sn} } );
5999 delete($remote_session{$sn});
6000 delete($remote_session_server{$sn});
6002 foreach $fh (keys %fast_fh_cache) {
6004 delete($fast_fh_cache{$fh});
6008 =head2 remote_error_setup(&function)
6010 Sets a function to be called instead of &error when a remote RPC operation
6011 fails. Useful if you want to have more control over your remote operations.
6014 sub remote_error_setup
6016 $main::remote_error_handler = $_[0] || \&error;
6019 =head2 remote_rpc_call(server, structure)
6021 Calls rpc.cgi on some server and passes it a perl structure (hash,array,etc)
6022 and then reads back a reply structure. This is mainly for internal use only,
6023 and is called by the other remote_* functions.
6029 my $sn = &remote_session_name($_[0]); # Will be undef for local connection
6031 # Server structure was given
6033 $serv->{'user'} || $serv->{'id'} == 0 ||
6034 return &$main::remote_error_handler(
6035 "No Webmin login set for server");
6038 # lookup the server in the webmin servers module if needed
6039 if (!%main::remote_servers_cache) {
6040 &foreign_require("servers", "servers-lib.pl");
6041 foreach $s (&foreign_call("servers", "list_servers")) {
6042 $main::remote_servers_cache{$s->{'host'}} = $s;
6043 $main::remote_servers_cache{$s->{'host'}.":".$s->{'port'}} = $s;
6046 $serv = $main::remote_servers_cache{$_[0]};
6047 $serv || return &$main::remote_error_handler(
6048 "No Webmin Servers entry for $_[0]");
6049 $serv->{'user'} || return &$main::remote_error_handler(
6050 "No login set for server $_[0]");
6052 my $ip = $serv->{'ip'} || $serv->{'host'};
6054 # Work out the username and password
6056 if ($serv->{'sameuser'}) {
6057 $user = $remote_user;
6058 defined($main::remote_pass) || return &$main::remote_error_handler(
6059 "Password for this server is not available");
6060 $pass = $main::remote_pass;
6063 $user = $serv->{'user'};
6064 $pass = $serv->{'pass'};
6067 if ($serv->{'fast'} || !$sn) {
6068 # Make TCP connection call to fastrpc.cgi
6069 if (!$fast_fh_cache{$sn} && $sn) {
6070 # Need to open the connection
6071 my $con = &make_http_connection(
6072 $ip, $serv->{'port'}, $serv->{'ssl'},
6073 "POST", "/fastrpc.cgi");
6074 return &$main::remote_error_handler(
6075 "Failed to connect to $serv->{'host'} : $con")
6077 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
6078 &write_http_connection($con, "User-agent: Webmin\r\n");
6079 my $auth = &encode_base64("$user:$pass");
6081 &write_http_connection($con, "Authorization: basic $auth\r\n");
6082 &write_http_connection($con, "Content-length: ",
6083 length($tostr),"\r\n");
6084 &write_http_connection($con, "\r\n");
6085 &write_http_connection($con, $tostr);
6087 # read back the response
6088 my $line = &read_http_connection($con);
6089 $line =~ tr/\r\n//d;
6090 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
6091 return &$main::remote_error_handler("Login to RPC server as $user rejected");
6093 $line =~ /^HTTP\/1\..\s+200\s+/ ||
6094 return &$main::remote_error_handler("HTTP error : $line");
6096 $line = &read_http_connection($con);
6097 $line =~ tr/\r\n//d;
6099 $line = &read_http_connection($con);
6100 if ($line =~ /^0\s+(.*)/) {
6101 return &$main::remote_error_handler("RPC error : $1");
6103 elsif ($line =~ /^1\s+(\S+)\s+(\S+)\s+(\S+)/ ||
6104 $line =~ /^1\s+(\S+)\s+(\S+)/) {
6105 # Started ok .. connect and save SID
6106 &close_http_connection($con);
6107 my ($port, $sid, $version, $error) = ($1, $2, $3);
6108 &open_socket($ip, $port, $sid, \$error);
6109 return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error")
6111 $fast_fh_cache{$sn} = $sid;
6112 $remote_server_version{$sn} = $version;
6115 while($stuff = &read_http_connection($con)) {
6118 return &$main::remote_error_handler("Bad response from fastrpc.cgi : $line");
6121 elsif (!$fast_fh_cache{$sn}) {
6122 # Open the connection by running fastrpc.cgi locally
6123 pipe(RPCOUTr, RPCOUTw);
6127 open(STDOUT, ">&RPCOUTw");
6131 $ENV{'REQUEST_METHOD'} = 'GET';
6132 $ENV{'SCRIPT_NAME'} = '/fastrpc.cgi';
6133 $ENV{'SERVER_ROOT'} ||= $root_directory;
6135 if ($base_remote_user ne 'root' &&
6136 $base_remote_user ne 'admin') {
6137 # Need to fake up a login for the CGI!
6138 &read_acl(undef, \%acl, [ 'root' ]);
6139 $ENV{'BASE_REMOTE_USER'} =
6140 $ENV{'REMOTE_USER'} =
6141 $acl{'root'} ? 'root' : 'admin';
6143 delete($ENV{'FOREIGN_MODULE_NAME'});
6144 delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
6145 chdir($root_directory);
6146 if (!exec("$root_directory/fastrpc.cgi")) {
6147 print "exec failed : $!\n";
6154 ($line = <RPCOUTr>) =~ tr/\r\n//d;
6158 if ($line =~ /^0\s+(.*)/) {
6159 return &$main::remote_error_handler("RPC error : $2");
6161 elsif ($line =~ /^1\s+(\S+)\s+(\S+)/) {
6162 # Started ok .. connect and save SID
6164 my ($port, $sid, $error) = ($1, $2, undef);
6165 &open_socket("localhost", $port, $sid, \$error);
6166 return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error") if ($error);
6167 $fast_fh_cache{$sn} = $sid;
6174 &error("Bad response from fastrpc.cgi : $line");
6177 # Got a connection .. send off the request
6178 my $fh = $fast_fh_cache{$sn};
6179 my $tostr = &serialise_variable($_[1]);
6180 print $fh length($tostr)," $fh\n";
6182 my $rlen = int(<$fh>);
6183 my ($fromstr, $got);
6184 while(length($fromstr) < $rlen) {
6185 return &$main::remote_error_handler("Failed to read from fastrpc.cgi")
6186 if (read($fh, $got, $rlen - length($fromstr)) <= 0);
6189 my $from = &unserialise_variable($fromstr);
6191 return &$main::remote_error_handler("Remote Webmin error");
6193 if (defined($from->{'arv'})) {
6194 return @{$from->{'arv'}};
6197 return $from->{'rv'};
6201 # Call rpc.cgi on remote server
6202 my $tostr = &serialise_variable($_[1]);
6204 my $con = &make_http_connection($ip, $serv->{'port'},
6205 $serv->{'ssl'}, "POST", "/rpc.cgi");
6206 return &$main::remote_error_handler("Failed to connect to $serv->{'host'} : $con") if (!ref($con));
6208 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
6209 &write_http_connection($con, "User-agent: Webmin\r\n");
6210 my $auth = &encode_base64("$user:$pass");
6212 &write_http_connection($con, "Authorization: basic $auth\r\n");
6213 &write_http_connection($con, "Content-length: ",length($tostr),"\r\n");
6214 &write_http_connection($con, "\r\n");
6215 &write_http_connection($con, $tostr);
6217 # read back the response
6218 my $line = &read_http_connection($con);
6219 $line =~ tr/\r\n//d;
6220 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
6221 return &$main::remote_error_handler("Login to RPC server as $user rejected");
6223 $line =~ /^HTTP\/1\..\s+200\s+/ || return &$main::remote_error_handler("RPC HTTP error : $line");
6225 $line = &read_http_connection($con);
6226 $line =~ tr/\r\n//d;
6229 while($line = &read_http_connection($con)) {
6233 my $from = &unserialise_variable($fromstr);
6234 return &$main::remote_error_handler("Invalid RPC login to $serv->{'host'}") if (!$from->{'status'});
6235 if (defined($from->{'arv'})) {
6236 return @{$from->{'arv'}};
6239 return $from->{'rv'};
6244 =head2 remote_multi_callback(&servers, parallel, &function, arg|&args, &returns, &errors, [module, library])
6246 Executes some function in parallel on multiple servers at once. Fills in
6247 the returns and errors arrays respectively. If the module and library
6248 parameters are given, that module is remotely required on the server first,
6249 to check if it is connectable. The parameters are :
6251 =item servers - A list of Webmin system hash references.
6253 =item parallel - Number of parallel operations to perform.
6255 =item function - Reference to function to call for each system.
6257 =item args - Additional parameters to the function.
6259 =item returns - Array ref to place return values into, in same order as servers.
6261 =item errors - Array ref to place error messages into.
6263 =item module - Optional module to require on the remote system first.
6265 =item library - Optional library to require in the module.
6268 sub remote_multi_callback
6270 my ($servs, $parallel, $func, $args, $rets, $errs, $mod, $lib) = @_;
6271 &remote_error_setup(\&remote_multi_callback_error);
6273 # Call the functions
6275 foreach my $g (@$servs) {
6281 $remote_multi_callback_err = undef;
6283 # Require the remote lib
6284 &remote_foreign_require($g->{'host'}, $mod, $lib);
6285 if ($remote_multi_callback_err) {
6286 # Failed .. return error
6287 print $wh &serialise_variable(
6288 [ undef, $remote_multi_callback_err ]);
6294 my $a = ref($args) ? $args->[$p] : $args;
6295 my $rv = &$func($g, $a);
6298 print $wh &serialise_variable(
6299 [ $rv, $remote_multi_callback_err ]);
6307 # Read back the results
6309 foreach my $g (@$servs) {
6313 $errs->[$p] = "Failed to read response from $g->{'host'}";
6316 my $rv = &unserialise_variable($line);
6318 $rets->[$p] = $rv->[0];
6319 $errs->[$p] = $rv->[1];
6324 &remote_error_setup(undef);
6327 sub remote_multi_callback_error
6329 $remote_multi_callback_err = $_[0];
6332 =head2 serialise_variable(variable)
6334 Converts some variable (maybe a scalar, hash ref, array ref or scalar ref)
6335 into a url-encoded string. In the cases of arrays and hashes, it is recursively
6336 called on each member to serialize the entire object.
6339 sub serialise_variable
6341 if (!defined($_[0])) {
6347 $rv = &urlize($_[0]);
6349 elsif ($r eq 'SCALAR') {
6350 $rv = &urlize(${$_[0]});
6352 elsif ($r eq 'ARRAY') {
6353 $rv = join(",", map { &urlize(&serialise_variable($_)) } @{$_[0]});
6355 elsif ($r eq 'HASH') {
6356 $rv = join(",", map { &urlize(&serialise_variable($_)).",".
6357 &urlize(&serialise_variable($_[0]->{$_})) }
6360 elsif ($r eq 'REF') {
6361 $rv = &serialise_variable(${$_[0]});
6363 elsif ($r eq 'CODE') {
6368 # An object - treat as a hash
6369 $r = "OBJECT ".&urlize($r);
6370 $rv = join(",", map { &urlize(&serialise_variable($_)).",".
6371 &urlize(&serialise_variable($_[0]->{$_})) }
6374 return ($r ? $r : 'VAL').",".$rv;
6377 =head2 unserialise_variable(string)
6379 Converts a string created by serialise_variable() back into the original
6380 scalar, hash ref, array ref or scalar ref. If the original variable was a Perl
6381 object, the same class is used on this system, if available.
6384 sub unserialise_variable
6386 my @v = split(/,/, $_[0]);
6388 if ($v[0] eq 'VAL') {
6389 @v = split(/,/, $_[0], -1);
6390 $rv = &un_urlize($v[1]);
6392 elsif ($v[0] eq 'SCALAR') {
6393 local $r = &un_urlize($v[1]);
6396 elsif ($v[0] eq 'ARRAY') {
6398 for(my $i=1; $i<@v; $i++) {
6399 push(@$rv, &unserialise_variable(&un_urlize($v[$i])));
6402 elsif ($v[0] eq 'HASH') {
6404 for(my $i=1; $i<@v; $i+=2) {
6405 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6406 &unserialise_variable(&un_urlize($v[$i+1]));
6409 elsif ($v[0] eq 'REF') {
6410 local $r = &unserialise_variable($v[1]);
6413 elsif ($v[0] eq 'UNDEF') {
6416 elsif ($v[0] =~ /^OBJECT\s+(.*)$/) {
6417 # An object hash that we have to re-bless
6420 for(my $i=1; $i<@v; $i+=2) {
6421 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6422 &unserialise_variable(&un_urlize($v[$i+1]));
6430 =head2 other_groups(user)
6432 Returns a list of secondary groups a user is a member of, as a list of
6441 while(my @g = getgrent()) {
6442 my @m = split(/\s+/, $g[3]);
6443 push(@rv, $g[2]) if (&indexof($user, @m) >= 0);
6445 endgrent() if ($gconfig{'os_type'} ne 'hpux');
6449 =head2 date_chooser_button(dayfield, monthfield, yearfield)
6451 Returns HTML for a button that pops up a data chooser window. The parameters
6454 =item dayfield - Name of the text field to place the day of the month into.
6456 =item monthfield - Name of the select field to select the month of the year in, indexed from 1.
6458 =item yearfield - Name of the text field to place the year into.
6461 sub date_chooser_button
6463 return &theme_date_chooser_button(@_)
6464 if (defined(&theme_date_chooser_button));
6465 my ($w, $h) = (250, 225);
6466 if ($gconfig{'db_sizedate'}) {
6467 ($w, $h) = split(/x/, $gconfig{'db_sizedate'});
6469 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";
6472 =head2 help_file(module, file)
6474 Returns the path to a module's help file of some name, typically under the
6475 help directory with a .html extension.
6480 my $mdir = &module_root_directory($_[0]);
6481 my $dir = "$mdir/help";
6482 foreach my $o (@lang_order_list) {
6483 my $lang = "$dir/$_[1].$o.html";
6484 return $lang if (-r $lang);
6486 return "$dir/$_[1].html";
6491 Seeds the random number generator, if not already done in this script. On Linux
6492 this makes use of the current time, process ID and a read from /dev/urandom.
6493 On other systems, only the current time and process ID are used.
6498 if (!$main::done_seed_random) {
6499 if (open(RANDOM, "/dev/urandom")) {
6501 read(RANDOM, $buf, 4);
6503 srand(time() ^ $$ ^ $buf);
6508 $main::done_seed_random = 1;
6512 =head2 disk_usage_kb(directory)
6514 Returns the number of kB used by some directory and all subdirs. Implemented
6515 by calling the C<du -k> command.
6520 my $dir = &translate_filename($_[0]);
6522 my $ex = &execute_command("du -sk ".quotemeta($dir), undef, \$out, undef, 0, 1);
6524 &execute_command("du -s ".quotemeta($dir), undef, \$out, undef, 0, 1);
6526 return $out =~ /^([0-9]+)/ ? $1 : "???";
6529 =head2 recursive_disk_usage(directory, [skip-regexp], [only-regexp])
6531 Returns the number of bytes taken up by all files in some directory and all
6532 sub-directories, by summing up their lengths. The disk_usage_kb is more
6533 reflective of reality, as the filesystem typically pads file sizes to 1k or
6537 sub recursive_disk_usage
6539 my $dir = &translate_filename($_[0]);
6546 my @st = stat($dir);
6552 my @files = readdir(DIR);
6554 foreach my $f (@files) {
6555 next if ($f eq "." || $f eq "..");
6556 next if ($skip && $f =~ /$skip/);
6557 next if ($only && $f !~ /$only/);
6558 $rv += &recursive_disk_usage("$dir/$f", $skip, $only);
6564 =head2 help_search_link(term, [ section, ... ] )
6566 Returns HTML for a link to the man module for searching local and online
6567 docs for various search terms. The term parameter can either be a single
6568 word like 'bind', or a space-separated list of words. This function is typically
6569 used by modules that want to refer users to additional documentation in man
6570 pages or local system doc files.
6573 sub help_search_link
6575 if (&foreign_available("man") && !$tconfig{'nosearch'}) {
6576 my $for = &urlize(shift(@_));
6577 return "<a href='$gconfig{'webprefix'}/man/search.cgi?".
6578 join("&", map { "section=$_" } @_)."&".
6579 "for=$for&exact=1&check=".&get_module_name()."'>".
6580 $text{'helpsearch'}."</a>\n";
6587 =head2 make_http_connection(host, port, ssl, method, page, [&headers])
6589 Opens a connection to some HTTP server, maybe through a proxy, and returns
6590 a handle object. The handle can then be used to send additional headers
6591 and read back a response. If anything goes wrong, returns an error string.
6592 The parameters are :
6594 =item host - Hostname or IP address of the webserver to connect to.
6596 =item port - HTTP port number to connect to.
6598 =item ssl - Set to 1 to connect in SSL mode.
6600 =item method - HTTP method, like GET or POST.
6602 =item page - Page to request on the webserver, like /foo/index.html
6604 =item headers - Array ref of additional HTTP headers, each of which is a 2-element array ref.
6607 sub make_http_connection
6609 my ($host, $port, $ssl, $method, $page, $headers) = @_;
6612 foreach my $h (@$headers) {
6613 $htxt .= $h->[0].": ".$h->[1]."\r\n";
6617 if (&is_readonly_mode()) {
6618 return "HTTP connections not allowed in readonly mode";
6620 my $rv = { 'fh' => time().$$ };
6623 eval "use Net::SSLeay";
6624 $@ && return $text{'link_essl'};
6625 eval "Net::SSLeay::SSLeay_add_ssl_algorithms()";
6626 eval "Net::SSLeay::load_error_strings()";
6627 $rv->{'ssl_ctx'} = Net::SSLeay::CTX_new() ||
6628 return "Failed to create SSL context";
6629 $rv->{'ssl_con'} = Net::SSLeay::new($rv->{'ssl_ctx'}) ||
6630 return "Failed to create SSL connection";
6632 if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6633 !&no_proxy($host)) {
6636 &open_socket($1, $2, $rv->{'fh'}, \$error);
6639 my $fh = $rv->{'fh'};
6640 print $fh "CONNECT $host:$port HTTP/1.0\r\n";
6641 if ($gconfig{'proxy_user'}) {
6642 my $auth = &encode_base64(
6643 "$gconfig{'proxy_user'}:".
6644 "$gconfig{'proxy_pass'}");
6645 $auth =~ tr/\r\n//d;
6646 print $fh "Proxy-Authorization: Basic $auth\r\n";
6650 if ($line =~ /^HTTP(\S+)\s+(\d+)\s+(.*)/) {
6651 return "Proxy error : $3" if ($2 != 200);
6654 return "Proxy error : $line";
6659 elsif (!$gconfig{'proxy_fallback'}) {
6660 # Connection to proxy failed - give up
6667 &open_socket($host, $port, $rv->{'fh'}, \$error);
6668 return $error if ($error);
6670 Net::SSLeay::set_fd($rv->{'ssl_con'}, fileno($rv->{'fh'}));
6671 Net::SSLeay::connect($rv->{'ssl_con'}) ||
6672 return "SSL connect() failed";
6673 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6674 Net::SSLeay::write($rv->{'ssl_con'}, $rtxt);
6677 # Plain HTTP request
6679 if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6680 !&no_proxy($host)) {
6683 &open_socket($1, $2, $rv->{'fh'}, \$error);
6687 my $fh = $rv->{'fh'};
6688 my $rtxt = $method." ".
6689 "http://$host:$port$page HTTP/1.0\r\n";
6690 if ($gconfig{'proxy_user'}) {
6691 my $auth = &encode_base64(
6692 "$gconfig{'proxy_user'}:".
6693 "$gconfig{'proxy_pass'}");
6694 $auth =~ tr/\r\n//d;
6695 $rtxt .= "Proxy-Authorization: Basic $auth\r\n";
6700 elsif (!$gconfig{'proxy_fallback'}) {
6705 # Connecting directly
6707 &open_socket($host, $port, $rv->{'fh'}, \$error);
6708 return $error if ($error);
6709 my $fh = $rv->{'fh'};
6710 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6717 =head2 read_http_connection(&handle, [bytes])
6719 Reads either one line or up to the specified number of bytes from the handle,
6720 originally supplied by make_http_connection.
6723 sub read_http_connection
6727 if ($h->{'ssl_con'}) {
6730 while(($idx = index($h->{'buffer'}, "\n")) < 0) {
6731 # need to read more..
6732 if (!($more = Net::SSLeay::read($h->{'ssl_con'}))) {
6734 $rv = $h->{'buffer'};
6735 delete($h->{'buffer'});
6738 $h->{'buffer'} .= $more;
6740 $rv = substr($h->{'buffer'}, 0, $idx+1);
6741 $h->{'buffer'} = substr($h->{'buffer'}, $idx+1);
6744 if (length($h->{'buffer'})) {
6745 $rv = $h->{'buffer'};
6746 delete($h->{'buffer'});
6749 $rv = Net::SSLeay::read($h->{'ssl_con'}, $_[1]);
6755 read($h->{'fh'}, $rv, $_[1]) > 0 || return undef;
6758 my $fh = $h->{'fh'};
6762 $rv = undef if ($rv eq "");
6766 =head2 write_http_connection(&handle, [data+])
6768 Writes the given data to the given HTTP connection handle.
6771 sub write_http_connection
6774 my $fh = $h->{'fh'};
6776 if ($h->{'ssl_ctx'}) {
6777 foreach my $s (@_) {
6778 my $ok = Net::SSLeay::write($h->{'ssl_con'}, $s);
6779 $allok = 0 if (!$ok);
6783 my $ok = (print $fh @_);
6784 $allok = 0 if (!$ok);
6789 =head2 close_http_connection(&handle)
6791 Closes a connection to an HTTP server, identified by the given handle.
6794 sub close_http_connection
6800 =head2 clean_environment
6802 Deletes any environment variables inherited from miniserv so that they
6803 won't be passed to programs started by webmin. This is useful when calling
6804 programs that check for CGI-related environment variables and modify their
6805 behaviour, and to avoid passing sensitive variables to un-trusted programs.
6808 sub clean_environment
6810 %UNCLEAN_ENV = %ENV;
6811 foreach my $k (keys %ENV) {
6812 if ($k =~ /^(HTTP|VIRTUALSERVER|QUOTA|USERADMIN)_/) {
6816 foreach my $e ('WEBMIN_CONFIG', 'SERVER_NAME', 'CONTENT_TYPE', 'REQUEST_URI',
6817 'PATH_INFO', 'WEBMIN_VAR', 'REQUEST_METHOD', 'GATEWAY_INTERFACE',
6818 'QUERY_STRING', 'REMOTE_USER', 'SERVER_SOFTWARE', 'SERVER_PROTOCOL',
6819 'REMOTE_HOST', 'SERVER_PORT', 'DOCUMENT_ROOT', 'SERVER_ROOT',
6820 'MINISERV_CONFIG', 'SCRIPT_NAME', 'SERVER_ADMIN', 'CONTENT_LENGTH',
6821 'HTTPS', 'FOREIGN_MODULE_NAME', 'FOREIGN_ROOT_DIRECTORY',
6822 'SCRIPT_FILENAME', 'PATH_TRANSLATED', 'BASE_REMOTE_USER',
6823 'DOCUMENT_REALROOT', 'MINISERV_CONFIG', 'MYSQL_PWD',
6829 =head2 reset_environment
6831 Puts the environment back how it was before clean_environment was callled.
6834 sub reset_environment
6837 foreach my $k (keys %UNCLEAN_ENV) {
6838 $ENV{$k} = $UNCLEAN_ENV{$k};
6840 undef(%UNCLEAN_ENV);
6844 =head2 progress_callback
6846 Never called directly, but useful for passing to &http_download to print
6847 out progress of an HTTP request.
6850 sub progress_callback
6852 if (defined(&theme_progress_callback)) {
6853 # Call the theme override
6854 return &theme_progress_callback(@_);
6858 print $progress_callback_prefix;
6860 $progress_size = $_[1];
6861 $progress_step = int($_[1] / 10);
6862 print &text('progress_size2', $progress_callback_url,
6863 &nice_size($progress_size)),"<br>\n";
6866 print &text('progress_nosize', $progress_callback_url),"<br>\n";
6868 $last_progress_time = $last_progress_size = undef;
6870 elsif ($_[0] == 3) {
6872 my $sp = $progress_callback_prefix.(" " x 5);
6873 if ($progress_size) {
6874 # And we have a size to compare against
6875 my $st = int(($_[1] * 10) / $progress_size);
6876 my $time_now = time();
6877 if ($st != $progress_step ||
6878 $time_now - $last_progress_time > 60) {
6879 # Show progress every 10% or 60 seconds
6880 print $sp,&text('progress_datan', &nice_size($_[1]),
6881 int($_[1]*100/$progress_size)),"<br>\n";
6882 $last_progress_time = $time_now;
6884 $progress_step = $st;
6887 # No total size .. so only show in 100k jumps
6888 if ($_[1] > $last_progress_size+100*1024) {
6889 print $sp,&text('progress_data2n',
6890 &nice_size($_[1])),"<br>\n";
6891 $last_progress_size = $_[1];
6895 elsif ($_[0] == 4) {
6896 # All done downloading
6897 print $progress_callback_prefix,&text('progress_done'),"<br>\n";
6899 elsif ($_[0] == 5) {
6900 # Got new location after redirect
6901 $progress_callback_url = $_[1];
6903 elsif ($_[0] == 6) {
6905 $progress_callback_url = $_[1];
6906 print &text('progress_incache', $progress_callback_url),"<br>\n";
6910 =head2 switch_to_remote_user
6912 Changes the user and group of the current process to that of the unix user
6913 with the same name as the current webmin login, or fails if there is none.
6914 This should be called by Usermin module scripts that only need to run with
6915 limited permissions.
6918 sub switch_to_remote_user
6920 @remote_user_info = $remote_user ? getpwnam($remote_user) :
6922 @remote_user_info || &error(&text('switch_remote_euser', $remote_user));
6923 &create_missing_homedir(\@remote_user_info);
6925 &switch_to_unix_user(\@remote_user_info);
6926 $ENV{'USER'} = $ENV{'LOGNAME'} = $remote_user;
6927 $ENV{'HOME'} = $remote_user_info[7];
6929 # Export global variables to caller
6930 if ($main::export_to_caller) {
6931 my ($callpkg) = caller();
6932 eval "\@${callpkg}::remote_user_info = \@remote_user_info";
6936 =head2 switch_to_unix_user(&user-details)
6938 Switches the current process to the UID and group ID from the given list
6939 of user details, which must be in the format returned by getpwnam.
6942 sub switch_to_unix_user
6945 if (!defined($uinfo->[0])) {
6946 # No username given, so just use given GID
6947 ($(, $)) = ( $uinfo->[3], "$uinfo->[3] $uinfo->[3]" );
6950 # Use all groups from user
6951 ($(, $)) = ( $uinfo->[3],
6952 "$uinfo->[3] ".join(" ", $uinfo->[3],
6953 &other_groups($uinfo->[0])) );
6956 POSIX::setuid($uinfo->[2]);
6958 if ($< != $uinfo->[2] || $> != $uinfo->[2]) {
6959 ($>, $<) = ( $uinfo->[2], $uinfo->[2] );
6963 =head2 eval_as_unix_user(username, &code)
6965 Runs some code fragment with the effective UID and GID switch to that
6966 of the given Unix user, so that file IO takes place with his permissions.
6970 sub eval_as_unix_user
6972 my ($user, $code) = @_;
6973 my @uinfo = getpwnam($user);
6974 if (!scalar(@uinfo)) {
6975 &error("eval_as_unix_user called with invalid user $user");
6977 $) = $uinfo[3]." ".join(" ", $uinfo[3], &other_groups($user));
6981 local $main::error_must_die = 1;
6988 $err =~ s/\s+at\s+(\/\S+)\s+line\s+(\d+)\.?//;
6991 return wantarray ? @rv : $rv[0];
6994 =head2 create_user_config_dirs
6996 Creates per-user config directories and sets $user_config_directory and
6997 $user_module_config_directory to them. Also reads per-user module configs
6998 into %userconfig. This should be called by Usermin module scripts that need
6999 to store per-user preferences or other settings.
7002 sub create_user_config_dirs
7004 return if (!$gconfig{'userconfig'});
7005 my @uinfo = @remote_user_info ? @remote_user_info : getpwnam($remote_user);
7006 return if (!@uinfo || !$uinfo[7]);
7007 &create_missing_homedir(\@uinfo);
7008 $user_config_directory = "$uinfo[7]/$gconfig{'userconfig'}";
7009 if (!-d $user_config_directory) {
7010 mkdir($user_config_directory, 0700) ||
7011 &error("Failed to create $user_config_directory : $!");
7012 if ($< == 0 && $uinfo[2]) {
7013 chown($uinfo[2], $uinfo[3], $user_config_directory);
7016 if (&get_module_name()) {
7017 $user_module_config_directory = $user_config_directory."/".
7019 if (!-d $user_module_config_directory) {
7020 mkdir($user_module_config_directory, 0700) ||
7021 &error("Failed to create $user_module_config_directory : $!");
7022 if ($< == 0 && $uinfo[2]) {
7023 chown($uinfo[2], $uinfo[3], $user_config_directory);
7027 &read_file_cached("$module_root_directory/defaultuconfig",
7029 &read_file_cached("$module_config_directory/uconfig", \%userconfig);
7030 &read_file_cached("$user_module_config_directory/config",
7034 # Export global variables to caller
7035 if ($main::export_to_caller) {
7036 my ($callpkg) = caller();
7037 foreach my $v ('$user_config_directory',
7038 '$user_module_config_directory', '%userconfig') {
7039 my ($vt, $vn) = split('', $v, 2);
7040 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
7045 =head2 create_missing_homedir(&uinfo)
7047 If auto homedir creation is enabled, create one for this user if needed.
7048 For internal use only.
7051 sub create_missing_homedir
7054 if (!-e $uinfo->[7] && $gconfig{'create_homedir'}) {
7055 # Use has no home dir .. make one
7056 system("mkdir -p ".quotemeta($uinfo->[7]));
7057 chown($uinfo->[2], $uinfo->[3], $uinfo->[7]);
7058 if ($gconfig{'create_homedir_perms'} ne '') {
7059 chmod(oct($gconfig{'create_homedir_perms'}), $uinfo->[7]);
7064 =head2 filter_javascript(text)
7066 Disables all javascript <script>, onClick= and so on tags in the given HTML,
7067 and returns the new HTML. Useful for displaying HTML from an un-trusted source.
7070 sub filter_javascript
7073 $rv =~ s/<\s*script[^>]*>([\000-\377]*?)<\s*\/script\s*>//gi;
7074 $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;
7075 $rv =~ s/(javascript:)/x$1/gi;
7076 $rv =~ s/(vbscript:)/x$1/gi;
7080 =head2 resolve_links(path)
7082 Given a path that may contain symbolic links, returns the real path.
7088 $path =~ s/\/+/\//g;
7089 $path =~ s/\/$// if ($path ne "/");
7090 my @p = split(/\/+/, $path);
7092 for(my $i=0; $i<@p; $i++) {
7093 my $sofar = "/".join("/", @p[0..$i]);
7094 my $lnk = readlink($sofar);
7095 if ($lnk eq $sofar) {
7096 # Link to itself! Cannot do anything more really ..
7099 elsif ($lnk =~ /^\//) {
7100 # Link is absolute..
7101 return &resolve_links($lnk."/".join("/", @p[$i+1 .. $#p]));
7105 return &resolve_links("/".join("/", @p[0..$i-1])."/".$lnk."/".join("/", @p[$i+1 .. $#p]));
7111 =head2 simplify_path(path, bogus)
7113 Given a path, maybe containing elements ".." and "." , convert it to a
7114 clean, absolute form. Returns undef if this is not possible.
7122 my @bits = split(/\/+/, $dir);
7125 foreach my $b (@bits) {
7129 elsif ($b eq "..") {
7131 if (scalar(@fixedbits) == 0) {
7132 # Cannot! Already at root!
7139 push(@fixedbits, $b);
7142 return "/".join('/', @fixedbits);
7145 =head2 same_file(file1, file2)
7147 Returns 1 if two files are actually the same
7152 return 1 if ($_[0] eq $_[1]);
7153 return 0 if ($_[0] !~ /^\// || $_[1] !~ /^\//);
7154 my @stat1 = $stat_cache{$_[0]} ? @{$stat_cache{$_[0]}}
7155 : (@{$stat_cache{$_[0]}} = stat($_[0]));
7156 my @stat2 = $stat_cache{$_[1]} ? @{$stat_cache{$_[1]}}
7157 : (@{$stat_cache{$_[1]}} = stat($_[1]));
7158 return 0 if (!@stat1 || !@stat2);
7159 return $stat1[0] == $stat2[0] && $stat1[1] == $stat2[1];
7162 =head2 flush_webmin_caches
7164 Clears all in-memory and on-disk caches used by Webmin.
7167 sub flush_webmin_caches
7169 undef(%main::read_file_cache);
7170 undef(%main::acl_hash_cache);
7171 undef(%main::acl_array_cache);
7172 undef(%main::has_command_cache);
7173 undef(@main::list_languages_cache);
7174 undef($main::got_list_usermods_cache);
7175 undef(@main::list_usermods_cache);
7176 undef(%main::foreign_installed_cache);
7177 unlink("$config_directory/module.infos.cache");
7178 &get_all_module_infos();
7181 =head2 list_usermods
7183 Returns a list of additional module restrictions. For internal use in
7189 if (!$main::got_list_usermods_cache) {
7190 @main::list_usermods_cache = ( );
7192 open(USERMODS, "$config_directory/usermin.mods");
7194 if (/^([^:]+):(\+|-|):(.*)/) {
7195 push(@main::list_usermods_cache,
7196 [ $1, $2, [ split(/\s+/, $3) ] ]);
7200 $main::got_list_usermods_cache = 1;
7202 return @main::list_usermods_cache;
7205 =head2 available_usermods(&allmods, &usermods)
7207 Returns a list of modules that are available to the given user, based
7208 on usermod additional/subtractions. For internal use by Usermin only.
7211 sub available_usermods
7213 return @{$_[0]} if (!@{$_[1]});
7215 my %mods = map { $_->{'dir'}, 1 } @{$_[0]};
7216 my @uinfo = @remote_user_info;
7217 @uinfo = getpwnam($remote_user) if (!@uinfo);
7218 foreach my $u (@{$_[1]}) {
7220 if ($u->[0] eq "*" || $u->[0] eq $remote_user) {
7223 elsif ($u->[0] =~ /^\@(.*)$/) {
7224 # Check for group membership
7225 my @ginfo = getgrnam($1);
7226 $applies++ if (@ginfo && ($ginfo[2] == $uinfo[3] ||
7227 &indexof($remote_user, split(/\s+/, $ginfo[3])) >= 0));
7229 elsif ($u->[0] =~ /^\//) {
7230 # Check users and groups in file
7232 open(USERFILE, $u->[0]);
7235 if ($_ eq $remote_user) {
7238 elsif (/^\@(.*)$/) {
7239 my @ginfo = getgrnam($1);
7241 if (@ginfo && ($ginfo[2] == $uinfo[3] ||
7242 &indexof($remote_user,
7243 split(/\s+/, $ginfo[3])) >= 0));
7250 if ($u->[1] eq "+") {
7251 map { $mods{$_}++ } @{$u->[2]};
7253 elsif ($u->[1] eq "-") {
7254 map { delete($mods{$_}) } @{$u->[2]};
7258 map { $mods{$_}++ } @{$u->[2]};
7262 return grep { $mods{$_->{'dir'}} } @{$_[0]};
7265 =head2 get_available_module_infos(nocache)
7267 Returns a list of modules available to the current user, based on
7268 operating system support, access control and usermod restrictions. Useful
7269 in themes that need to display a list of modules the user can use.
7270 Each element of the returned array is a hash reference in the same format as
7271 returned by get_module_info.
7274 sub get_available_module_infos
7277 &read_acl(\%acl, \%uacl, [ $base_remote_user ]);
7278 my $risk = $gconfig{'risk_'.$base_remote_user};
7280 foreach my $minfo (&get_all_module_infos($_[0])) {
7281 next if (!&check_os_support($minfo));
7283 # Check module risk level
7284 next if ($risk ne 'high' && $minfo->{'risk'} &&
7285 $minfo->{'risk'} !~ /$risk/);
7289 next if (!$acl{$base_remote_user,$minfo->{'dir'}} &&
7290 !$acl{$base_remote_user,"*"});
7292 next if (&is_readonly_mode() && !$minfo->{'readonly'});
7296 # Check usermod restrictions
7297 my @usermods = &list_usermods();
7298 @rv = sort { $a->{'desc'} cmp $b->{'desc'} }
7299 &available_usermods(\@rv, \@usermods);
7301 # Check RBAC restrictions
7303 foreach my $m (@rv) {
7304 if (&supports_rbac($m->{'dir'}) &&
7305 &use_rbac_module_acl(undef, $m->{'dir'})) {
7306 local $rbacs = &get_rbac_module_acl($remote_user,
7314 # Module or system doesn't support RBAC
7315 push(@rbacrv, $m) if (!$gconfig{'rbacdeny_'.$base_remote_user});
7321 if (defined(&theme_foreign_available)) {
7322 foreach my $m (@rbacrv) {
7323 if (&theme_foreign_available($m->{'dir'})) {
7332 # Check licence module vetos
7334 if ($main::licence_module) {
7335 foreach my $m (@themerv) {
7336 if (&foreign_call($main::licence_module,
7337 "check_module_licence", $m->{'dir'})) {
7349 =head2 get_visible_module_infos(nocache)
7351 Like get_available_module_infos, but excludes hidden modules from the list.
7352 Each element of the returned array is a hash reference in the same format as
7353 returned by get_module_info.
7356 sub get_visible_module_infos
7359 my $pn = &get_product_name();
7360 return grep { !$_->{'hidden'} &&
7361 !$_->{$pn.'_hidden'} } &get_available_module_infos($nocache);
7364 =head2 get_visible_modules_categories(nocache)
7366 Returns a list of Webmin module categories, each of which is a hash ref
7367 with 'code', 'desc' and 'modules' keys. The modules value is an array ref
7368 of modules in the category, in the format returned by get_module_info.
7369 Un-used modules are automatically assigned to the 'unused' category, and
7370 those with no category are put into 'others'.
7373 sub get_visible_modules_categories
7376 my @mods = &get_visible_module_infos($nocache);
7378 if (&get_product_name() eq 'webmin') {
7379 @unmods = grep { $_->{'installed'} eq '0' } @mods;
7380 @mods = grep { $_->{'installed'} ne '0' } @mods;
7382 my %cats = &list_categories(\@mods);
7384 foreach my $c (keys %cats) {
7385 my $cat = { 'code' => $c || 'other',
7386 'desc' => $cats{$c} };
7387 $cat->{'modules'} = [ grep { $_->{'category'} eq $c } @mods ];
7390 @rv = sort { ($b->{'code'} eq "others" ? "" : $b->{'code'}) cmp
7391 ($a->{'code'} eq "others" ? "" : $a->{'code'}) } @rv;
7393 # Add un-installed modules in magic category
7394 my $cat = { 'code' => 'unused',
7395 'desc' => $text{'main_unused'},
7397 'modules' => \@unmods };
7403 =head2 is_under_directory(directory, file)
7405 Returns 1 if the given file is under the specified directory, 0 if not.
7406 Symlinks are taken into account in the file to find it's 'real' location.
7409 sub is_under_directory
7411 my ($dir, $file) = @_;
7412 return 1 if ($dir eq "/");
7413 return 0 if ($file =~ /\.\./);
7414 my $ld = &resolve_links($dir);
7416 return &is_under_directory($ld, $file);
7418 my $lp = &resolve_links($file);
7420 return &is_under_directory($dir, $lp);
7422 return 0 if (length($file) < length($dir));
7423 return 1 if ($dir eq $file);
7425 return substr($file, 0, length($dir)) eq $dir;
7428 =head2 parse_http_url(url, [basehost, baseport, basepage, basessl])
7430 Given an absolute URL, returns the host, port, page and ssl flag components.
7431 Relative URLs can also be parsed, if the base information is provided.
7436 if ($_[0] =~ /^(http|https):\/\/([^:\/]+)(:(\d+))?(\/\S*)?$/) {
7438 my $ssl = $1 eq 'https';
7439 return ($2, $3 ? $4 : $ssl ? 443 : 80, $5 || "/", $ssl);
7445 elsif ($_[0] =~ /^\/\S*$/) {
7446 # A relative to the server URL
7447 return ($_[1], $_[2], $_[0], $_[4]);
7450 # A relative to the directory URL
7452 $page =~ s/[^\/]+$//;
7453 return ($_[1], $_[2], $page.$_[0], $_[4]);
7457 =head2 check_clicks_function
7459 Returns HTML for a JavaScript function called check_clicks that returns
7460 true when first called, but false subsequently. Useful on onClick for
7461 critical buttons. Deprecated, as this method of preventing duplicate actions
7465 sub check_clicks_function
7470 function check_clicks(form)
7477 for(i=0; i<form.length; i++)
7478 form.elements[i].disabled = true;
7487 =head2 load_entities_map
7489 Returns a hash ref containing mappings between HTML entities (like ouml) and
7490 ascii values (like 246). Mainly for internal use.
7493 sub load_entities_map
7495 if (!%entities_map_cache) {
7497 open(EMAP, "$root_directory/entities_map.txt");
7499 if (/^(\d+)\s+(\S+)/) {
7500 $entities_map_cache{$2} = $1;
7505 return \%entities_map_cache;
7508 =head2 entities_to_ascii(string)
7510 Given a string containing HTML entities like ö and 7, replace them
7511 with their ASCII equivalents.
7514 sub entities_to_ascii
7517 my $emap = &load_entities_map();
7518 $str =~ s/&([a-z]+);/chr($emap->{$1})/ge;
7519 $str =~ s/&#(\d+);/chr($1)/ge;
7523 =head2 get_product_name
7525 Returns either 'webmin' or 'usermin', depending on which program the current
7526 module is in. Useful for modules that can be installed into either.
7529 sub get_product_name
7531 return $gconfig{'product'} if (defined($gconfig{'product'}));
7532 return defined($gconfig{'userconfig'}) ? 'usermin' : 'webmin';
7537 Returns the character set for the current language, such as iso-8859-1.
7542 my $charset = defined($gconfig{'charset'}) ? $gconfig{'charset'} :
7543 $current_lang_info->{'charset'} ?
7544 $current_lang_info->{'charset'} : $default_charset;
7548 =head2 get_display_hostname
7550 Returns the system's hostname for UI display purposes. This may be different
7551 from the actual hostname if you administrator has configured it so in the
7552 Webmin Configuration module.
7555 sub get_display_hostname
7557 if ($gconfig{'hostnamemode'} == 0) {
7558 return &get_system_hostname();
7560 elsif ($gconfig{'hostnamemode'} == 3) {
7561 return $gconfig{'hostnamedisplay'};
7564 my $h = $ENV{'HTTP_HOST'};
7566 if ($gconfig{'hostnamemode'} == 2) {
7567 $h =~ s/^(www|ftp|mail)\.//i;
7573 =head2 save_module_config([&config], [modulename])
7575 Saves the configuration for some module. The config parameter is an optional
7576 hash reference of names and values to save, which defaults to the global
7577 %config hash. The modulename parameter is the module to update the config
7578 file, which defaults to the current module.
7581 sub save_module_config
7583 my $c = $_[0] || { &get_module_variable('%config') };
7584 my $m = defined($_[1]) ? $_[1] : &get_module_name();
7585 &write_file("$config_directory/$m/config", $c);
7588 =head2 save_user_module_config([&config], [modulename])
7590 Saves the user's Usermin preferences for some module. The config parameter is
7591 an optional hash reference of names and values to save, which defaults to the
7592 global %userconfig hash. The modulename parameter is the module to update the
7593 config file, which defaults to the current module.
7596 sub save_user_module_config
7598 my $c = $_[0] || { &get_module_variable('%userconfig') };
7599 my $m = $_[1] || &get_module_name();
7600 my $ucd = $user_config_directory;
7602 my @uinfo = @remote_user_info ? @remote_user_info
7603 : getpwnam($remote_user);
7604 return if (!@uinfo || !$uinfo[7]);
7605 $ucd = "$uinfo[7]/$gconfig{'userconfig'}";
7607 &write_file("$ucd/$m/config", $c);
7610 =head2 nice_size(bytes, [min])
7612 Converts a number of bytes into a number followed by a suffix like GB, MB
7613 or kB. Rounding is to two decimal digits. The optional min parameter sets the
7614 smallest units to use - so you could pass 1024*1024 to never show bytes or kB.
7619 my ($units, $uname);
7620 if (abs($_[0]) > 1024*1024*1024*1024 || $_[1] >= 1024*1024*1024*1024) {
7621 $units = 1024*1024*1024*1024;
7624 elsif (abs($_[0]) > 1024*1024*1024 || $_[1] >= 1024*1024*1024) {
7625 $units = 1024*1024*1024;
7628 elsif (abs($_[0]) > 1024*1024 || $_[1] >= 1024*1024) {
7632 elsif (abs($_[0]) > 1024 || $_[1] >= 1024) {
7640 my $sz = sprintf("%.2f", ($_[0]*1.0 / $units));
7642 return $sz." ".$uname;
7645 =head2 get_perl_path
7647 Returns the path to Perl currently in use, such as /usr/bin/perl.
7652 if (open(PERL, "$config_directory/perl-path")) {
7658 return $^X if (-x $^X);
7659 return &has_command("perl");
7662 =head2 get_goto_module([&mods])
7664 Returns the details of a module that the current user should be re-directed
7665 to after logging in, or undef if none. Useful for themes.
7670 my @mods = $_[0] ? @{$_[0]} : &get_visible_module_infos();
7671 if ($gconfig{'gotomodule'}) {
7672 my ($goto) = grep { $_->{'dir'} eq $gconfig{'gotomodule'} } @mods;
7673 return $goto if ($goto);
7675 if (@mods == 1 && $gconfig{'gotoone'}) {
7681 =head2 select_all_link(field, form, [text])
7683 Returns HTML for a 'Select all' link that uses Javascript to select
7684 multiple checkboxes with the same name. The parameters are :
7686 =item field - Name of the checkbox inputs.
7688 =item form - Index of the form on the page.
7690 =item text - Message for the link, defaulting to 'Select all'.
7695 return &theme_select_all_link(@_) if (defined(&theme_select_all_link));
7696 my ($field, $form, $text) = @_;
7698 $text ||= $text{'ui_selall'};
7699 return "<a class='select_all' href='#' onClick='var ff = document.forms[$form].$field; ff.checked = true; for(i=0; i<ff.length; i++) { if (!ff[i].disabled) { ff[i].checked = true; } } return false'>$text</a>";
7702 =head2 select_invert_link(field, form, text)
7704 Returns HTML for an 'Invert selection' link that uses Javascript to invert the
7705 selection on multiple checkboxes with the same name. The parameters are :
7707 =item field - Name of the checkbox inputs.
7709 =item form - Index of the form on the page.
7711 =item text - Message for the link, defaulting to 'Invert selection'.
7714 sub select_invert_link
7716 return &theme_select_invert_link(@_) if (defined(&theme_select_invert_link));
7717 my ($field, $form, $text) = @_;
7719 $text ||= $text{'ui_selinv'};
7720 return "<a class='select_invert' href='#' onClick='var ff = document.forms[$form].$field; ff.checked = !ff.checked; for(i=0; i<ff.length; i++) { if (!ff[i].disabled) { ff[i].checked = !ff[i].checked; } } return false'>$text</a>";
7723 =head2 select_rows_link(field, form, text, &rows)
7725 Returns HTML for a link that uses Javascript to select rows with particular
7726 values for their checkboxes. The parameters are :
7728 =item field - Name of the checkbox inputs.
7730 =item form - Index of the form on the page.
7732 =item text - Message for the link, de
7734 =item rows - Reference to an array of 1 or 0 values, indicating which rows to check.
7737 sub select_rows_link
7739 return &theme_select_rows_link(@_) if (defined(&theme_select_rows_link));
7740 my ($field, $form, $text, $rows) = @_;
7742 my $js = "var sel = { ".join(",", map { "\""."e_escape($_)."\":1" } @$rows)." }; ";
7743 $js .= "for(var i=0; i<document.forms[$form].${field}.length; i++) { var r = document.forms[$form].${field}[i]; r.checked = sel[r.value]; } ";
7744 $js .= "return false;";
7745 return "<a href='#' onClick='$js'>$text</a>";
7748 =head2 check_pid_file(file)
7750 Given a pid file, returns the PID it contains if the process is running.
7755 open(PIDFILE, $_[0]) || return undef;
7756 my $pid = <PIDFILE>;
7758 $pid =~ /^\s*(\d+)/ || return undef;
7759 kill(0, $1) || return undef;
7765 Return the local os-specific library name to this module. For internal use only.
7770 my $mn = &get_module_name();
7771 my $md = &module_root_directory($mn);
7772 if (-r "$md/$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl") {
7773 return "$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl";
7775 elsif (-r "$md/$mn-$gconfig{'os_type'}-lib.pl") {
7776 return "$mn-$gconfig{'os_type'}-lib.pl";
7778 elsif (-r "$md/$mn-generic-lib.pl") {
7779 return "$mn-generic-lib.pl";
7786 =head2 module_root_directory(module)
7788 Given a module name, returns its root directory. On a typical Webmin install,
7789 all modules are under the same directory - but it is theoretically possible to
7793 sub module_root_directory
7795 my $d = ref($_[0]) ? $_[0]->{'dir'} : $_[0];
7796 if (@root_directories > 1) {
7797 foreach my $r (@root_directories) {
7803 return "$root_directories[0]/$d";
7806 =head2 list_mime_types
7808 Returns a list of all known MIME types and their extensions, as a list of hash
7809 references with keys :
7811 =item type - The MIME type, like text/plain.
7813 =item exts - A list of extensions, like .doc and .avi.
7815 =item desc - A human-readable description for the MIME type.
7820 if (!@list_mime_types_cache) {
7822 open(MIME, "$root_directory/mime.types");
7826 if (s/#\s*(.*)$//g) {
7829 my ($type, @exts) = split(/\s+/);
7831 push(@list_mime_types_cache, { 'type' => $type,
7838 return @list_mime_types_cache;
7841 =head2 guess_mime_type(filename, [default])
7843 Given a file name like xxx.gif or foo.html, returns a guessed MIME type.
7844 The optional default parameter sets a default type of use if none is found,
7845 which defaults to application/octet-stream.
7850 if ($_[0] =~ /\.([A-Za-z0-9\-]+)$/) {
7852 foreach my $t (&list_mime_types()) {
7853 foreach my $e (@{$t->{'exts'}}) {
7854 return $t->{'type'} if (lc($e) eq lc($ext));
7858 return @_ > 1 ? $_[1] : "application/octet-stream";
7861 =head2 open_tempfile([handle], file, [no-error], [no-tempfile], [safe?])
7863 Opens a file handle for writing to a temporary file, which will only be
7864 renamed over the real file when the handle is closed. This allows critical
7865 files like /etc/shadow to be updated safely, even if writing fails part way
7866 through due to lack of disk space. The parameters are :
7868 =item handle - File handle to open, as you would use in Perl's open function.
7870 =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.
7872 =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.
7874 =item no-tempfile - If set to 1, writing will be direct to the file instead of using a temporary file.
7876 =item safe - Indicates to users in read-only mode that this write is safe and non-destructive.
7882 # Just getting a temp file
7883 if (!defined($main::open_tempfiles{$_[0]})) {
7884 $_[0] =~ /^(.*)\/(.*)$/ || return $_[0];
7885 my $dir = $1 || "/";
7886 my $tmp = "$dir/$2.webmintmp.$$";
7887 $main::open_tempfiles{$_[0]} = $tmp;
7888 push(@main::temporary_files, $tmp);
7890 return $main::open_tempfiles{$_[0]};
7894 my ($fh, $file, $noerror, $notemp, $safe) = @_;
7895 $fh = &callers_package($fh);
7897 my %gaccess = &get_module_acl(undef, "");
7898 my $db = $gconfig{'debug_what_write'};
7899 if ($file =~ /\r|\n|\0/) {
7900 if ($noerror) { return 0; }
7901 else { &error("Filename contains invalid characters"); }
7903 if (&is_readonly_mode() && $file =~ />/ && !$safe) {
7904 # Read-only mode .. veto all writes
7905 print STDERR "vetoing write to $file\n";
7906 return open($fh, ">$null_file");
7908 elsif ($file =~ /^(>|>>|)nul$/i) {
7909 # Write to Windows null device
7910 &webmin_debug_log($1 eq ">" ? "WRITE" :
7911 $1 eq ">>" ? "APPEND" : "READ", "nul") if ($db);
7913 elsif ($file =~ /^(>|>>)(\/dev\/.*)/ || lc($file) eq "nul") {
7914 # Writes to /dev/null or TTYs don't need to be handled
7915 &webmin_debug_log($1 eq ">" ? "WRITE" : "APPEND", $2) if ($db);
7916 return open($fh, $file);
7918 elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && !$notemp) {
7919 &webmin_debug_log("WRITE", $1) if ($db);
7920 # Over-writing a file, via a temp file
7922 $file = &translate_filename($file);
7924 # Open the link target instead
7925 $file = &resolve_links($file);
7928 # Cannot open a directory!
7929 if ($noerror) { return 0; }
7930 else { &error("Cannot write to directory $file"); }
7932 my $tmp = &open_tempfile($file);
7933 my $ex = open($fh, ">$tmp");
7934 if (!$ex && $! =~ /permission/i) {
7935 # Could not open temp file .. try opening actual file
7937 $ex = open($fh, ">$file");
7938 delete($main::open_tempfiles{$file});
7941 $main::open_temphandles{$fh} = $file;
7944 if (!$ex && !$noerror) {
7945 &error(&text("efileopen", $file, $!));
7949 elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && $notemp) {
7950 # Just writing direct to a file
7951 &webmin_debug_log("WRITE", $1) if ($db);
7953 $file = &translate_filename($file);
7954 my @old_attributes = &get_clear_file_attributes($file);
7955 my $ex = open($fh, ">$file");
7956 &reset_file_attributes($file, \@old_attributes);
7957 $main::open_temphandles{$fh} = $file;
7958 if (!$ex && !$noerror) {
7959 &error(&text("efileopen", $file, $!));
7964 elsif ($file =~ /^>>\s*(([a-zA-Z]:)?\/.*)$/) {
7965 # Appending to a file .. nothing special to do
7966 &webmin_debug_log("APPEND", $1) if ($db);
7968 $file = &translate_filename($file);
7969 my @old_attributes = &get_clear_file_attributes($file);
7970 my $ex = open($fh, ">>$file");
7971 &reset_file_attributes($file, \@old_attributes);
7972 $main::open_temphandles{$fh} = $file;
7973 if (!$ex && !$noerror) {
7974 &error(&text("efileopen", $file, $!));
7979 elsif ($file =~ /^([a-zA-Z]:)?\//) {
7980 # Read mode .. nothing to do here
7981 &webmin_debug_log("READ", $file) if ($db);
7982 $file = &translate_filename($file);
7983 return open($fh, $file);
7985 elsif ($file eq ">" || $file eq ">>") {
7986 my ($package, $filename, $line) = caller;
7987 if ($noerror) { return 0; }
7988 else { &error("Missing file to open at ${package}::${filename} line $line"); }
7991 my ($package, $filename, $line) = caller;
7992 &error("Unsupported file or mode $file at ${package}::${filename} line $line");
7997 =head2 close_tempfile(file|handle)
7999 Copies a temp file to the actual file, assuming that all writes were
8000 successful. The handle must have been one passed to open_tempfile.
8006 my $fh = &callers_package($_[0]);
8008 if (defined($file = $main::open_temphandles{$fh})) {
8010 close($fh) || &error(&text("efileclose", $file, $!));
8011 delete($main::open_temphandles{$fh});
8012 return &close_tempfile($file);
8014 elsif (defined($main::open_tempfiles{$_[0]})) {
8016 &webmin_debug_log("CLOSE", $_[0]) if ($gconfig{'debug_what_write'});
8017 my @st = stat($_[0]);
8018 if (&is_selinux_enabled() && &has_command("chcon")) {
8019 # Set original security context
8020 system("chcon --reference=".quotemeta($_[0]).
8021 " ".quotemeta($main::open_tempfiles{$_[0]}).
8022 " >/dev/null 2>&1");
8024 my @old_attributes = &get_clear_file_attributes($_[0]);
8025 rename($main::open_tempfiles{$_[0]}, $_[0]) || &error("Failed to replace $_[0] with $main::open_tempfiles{$_[0]} : $!");
8027 # Set original permissions and ownership
8028 chmod($st[2], $_[0]);
8029 chown($st[4], $st[5], $_[0]);
8031 &reset_file_attributes($_[0], \@old_attributes);
8032 delete($main::open_tempfiles{$_[0]});
8033 @main::temporary_files = grep { $_ ne $main::open_tempfiles{$_[0]} } @main::temporary_files;
8034 if ($main::open_templocks{$_[0]}) {
8035 &unlock_file($_[0]);
8036 delete($main::open_templocks{$_[0]});
8041 # Must be closing a handle not associated with a file
8047 =head2 print_tempfile(handle, text, ...)
8049 Like the normal print function, but calls &error on failure. Useful when
8050 combined with open_tempfile, to ensure that a criticial file is never
8051 only partially written.
8056 my ($fh, @args) = @_;
8057 $fh = &callers_package($fh);
8058 (print $fh @args) || &error(&text("efilewrite",
8059 $main::open_temphandles{$fh} || $fh, $!));
8062 =head2 is_selinux_enabled
8064 Returns 1 if SElinux is supported on this system and enabled, 0 if not.
8067 sub is_selinux_enabled
8069 if (!defined($main::selinux_enabled_cache)) {
8071 if ($gconfig{'os_type'} !~ /-linux$/) {
8072 # Not on linux, so no way
8073 $main::selinux_enabled_cache = 0;
8075 elsif (&read_env_file("/etc/selinux/config", \%seconfig)) {
8076 # Use global config file
8077 $main::selinux_enabled_cache =
8078 $seconfig{'SELINUX'} eq 'disabled' ||
8079 !$seconfig{'SELINUX'} ? 0 : 1;
8082 # Use selinuxenabled command
8083 #$selinux_enabled_cache =
8084 # system("selinuxenabled >/dev/null 2>&1") ? 0 : 1;
8085 $main::selinux_enabled_cache = 0;
8088 return $main::selinux_enabled_cache;
8091 =head2 get_clear_file_attributes(file)
8093 Finds file attributes that may prevent writing, clears them and returns them
8094 as a list. May call error. Mainly for internal use by open_tempfile and
8098 sub get_clear_file_attributes
8102 if ($gconfig{'chattr'}) {
8103 # Get original immutable bit
8104 my $out = &backquote_command(
8105 "lsattr ".quotemeta($file)." 2>/dev/null");
8107 $out =~ s/\s\S+\n//;
8108 @old_attributes = grep { $_ ne '-' } split(//, $out);
8110 if (&indexof("i", @old_attributes) >= 0) {
8111 my $err = &backquote_logged(
8112 "chattr -i ".quotemeta($file)." 2>&1");
8114 &error("Failed to remove immutable bit on ".
8119 return @old_attributes;
8122 =head2 reset_file_attributes(file, &attributes)
8124 Put back cleared attributes on some file. May call error. Mainly for internal
8125 use by close_tempfile.
8128 sub reset_file_attributes
8130 my ($file, $old_attributes) = @_;
8131 if (&indexof("i", @$old_attributes) >= 0) {
8132 my $err = &backquote_logged(
8133 "chattr +i ".quotemeta($file)." 2>&1");
8135 &error("Failed to restore immutable bit on ".
8141 =head2 cleanup_tempnames
8143 Remove all temporary files generated using transname. Typically only called
8144 internally when a Webmin script exits.
8147 sub cleanup_tempnames
8149 foreach my $t (@main::temporary_files) {
8152 @main::temporary_files = ( );
8155 =head2 open_lock_tempfile([handle], file, [no-error])
8157 Returns a temporary file for writing to some actual file, and also locks it.
8158 Effectively the same as calling lock_file and open_tempfile on the same file,
8159 but calls the unlock for you automatically when it is closed.
8162 sub open_lock_tempfile
8164 my ($fh, $file, $noerror, $notemp, $safe) = @_;
8165 $fh = &callers_package($fh);
8166 my $lockfile = $file;
8167 $lockfile =~ s/^[^\/]*//;
8168 if ($lockfile =~ /^\//) {
8169 $main::open_templocks{$lockfile} = &lock_file($lockfile);
8171 return &open_tempfile($fh, $file, $noerror, $notemp, $safe);
8176 $main::end_exit_status ||= $?;
8177 if ($$ == $main::initial_process_id) {
8178 # Exiting from initial process
8179 &cleanup_tempnames();
8180 if ($gconfig{'debug_what_start'} && $main::debug_log_start_time &&
8181 $main::debug_log_start_module eq &get_module_name()) {
8182 my $len = time() - $main::debug_log_start_time;
8183 &webmin_debug_log("STOP", "runtime=$len");
8184 $main::debug_log_start_time = 0;
8186 if (!$ENV{'SCRIPT_NAME'} &&
8187 $main::initial_module_name eq &get_module_name()) {
8188 # In a command-line script - call the real exit, so that the
8189 # exit status gets properly propogated. In some cases this
8190 # was not happening.
8191 exit($main::end_exit_status);
8196 =head2 month_to_number(month)
8198 Converts a month name like feb to a number like 1.
8203 return $month_to_number_map{lc(substr($_[0], 0, 3))};
8206 =head2 number_to_month(number)
8208 Converts a number like 1 to a month name like Feb.
8213 return ucfirst($number_to_month_map{$_[0]});
8216 =head2 get_rbac_module_acl(user, module)
8218 Returns a hash reference of RBAC overrides ACLs for some user and module.
8219 May return undef if none exist (indicating access denied), or the string *
8220 if full access is granted.
8223 sub get_rbac_module_acl
8225 my ($user, $mod) = @_;
8226 eval "use Authen::SolarisRBAC";
8227 return undef if ($@);
8230 if (Authen::SolarisRBAC::chkauth("webmin.$mod.admin", $user)) {
8231 # Automagic webmin.modulename.admin authorization exists .. allow access
8233 if (!Authen::SolarisRBAC::chkauth("webmin.$mod.config", $user)) {
8234 %rv = ( 'noconfig' => 1 );
8241 open(RBAC, &module_root_directory($mod)."/rbac-mapping");
8245 my ($auths, $acls) = split(/\s+/, $_);
8246 my @auths = split(/,/, $auths);
8248 my ($merge) = ($acls =~ s/^\+//);
8250 if ($auths eq "*") {
8251 # These ACLs apply to all RBAC users.
8252 # Only if there is some that match a specific authorization
8253 # later will they be used though.
8256 # Check each of the RBAC authorizations
8257 foreach my $a (@auths) {
8258 if (!Authen::SolarisRBAC::chkauth($a, $user)) {
8263 $foundany++ if ($gotall);
8266 # Found an RBAC authorization - return the ACLs
8267 return "*" if ($acls eq "*");
8268 my %acl = map { split(/=/, $_, 2) } split(/,/, $acls);
8270 # Just add to current set
8271 foreach my $a (keys %acl) {
8282 return !$foundany ? undef : %rv ? \%rv : undef;
8285 =head2 supports_rbac([module])
8287 Returns 1 if RBAC client support is available, such as on Solaris.
8292 return 0 if ($gconfig{'os_type'} ne 'solaris');
8293 eval "use Authen::SolarisRBAC";
8296 #return 0 if (!-r &module_root_directory($_[0])."/rbac-mapping");
8301 =head2 supports_ipv6()
8303 Returns 1 if outgoing IPv6 connections can be made
8308 return $ipv6_module_error ? 0 : 1;
8311 =head2 use_rbac_module_acl(user, module)
8313 Returns 1 if some user should use RBAC to get permissions for a module
8316 sub use_rbac_module_acl
8318 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
8319 my $m = defined($_[1]) ? $_[1] : &get_module_name();
8320 return 1 if ($gconfig{'rbacdeny_'.$u}); # RBAC forced for user
8321 my %access = &get_module_acl($u, $m, 1);
8322 return $access{'rbac'} ? 1 : 0;
8325 =head2 execute_command(command, stdin, stdout, stderr, translate-files?, safe?)
8327 Runs some command, possibly feeding it input and capturing output to the
8328 give files or scalar references. The parameters are :
8330 =item command - Full command to run, possibly including shell meta-characters.
8332 =item stdin - File to read input from, or a scalar ref containing input, or undef if no input should be given.
8334 =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.
8336 =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.
8338 =item translate-files - Set to 1 to apply filename translation to any filenames. Usually has no effect.
8340 =item safe - Set to 1 if this command is safe and does not modify the state of the system.
8345 my ($cmd, $stdin, $stdout, $stderr, $trans, $safe) = @_;
8346 if (&is_readonly_mode() && !$safe) {
8347 print STDERR "Vetoing command $_[0]\n";
8351 $cmd = &translate_command($cmd);
8353 # Use ` operator where possible
8354 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
8355 if (!$stdin && ref($stdout) && !$stderr) {
8356 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8357 $$stdout = `$cmd 2>$null_file`;
8360 elsif (!$stdin && ref($stdout) && $stdout eq $stderr) {
8361 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8362 $$stdout = `$cmd 2>&1`;
8365 elsif (!$stdin && !$stdout && !$stderr) {
8366 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8367 return system("$cmd >$null_file 2>$null_file <$null_file");
8371 $| = 1; # needed on some systems to flush before forking
8372 pipe(EXECSTDINr, EXECSTDINw);
8373 pipe(EXECSTDOUTr, EXECSTDOUTw);
8374 pipe(EXECSTDERRr, EXECSTDERRw);
8376 if (!($pid = fork())) {
8380 open(STDIN, "<&EXECSTDINr");
8381 open(STDOUT, ">&EXECSTDOUTw");
8382 if (ref($stderr) && $stderr eq $stdout) {
8383 open(STDERR, ">&EXECSTDOUTw");
8386 open(STDERR, ">&EXECSTDERRw");
8393 my $fullcmd = "($cmd)";
8394 if ($stdin && !ref($stdin)) {
8395 $fullcmd .= " <$stdin";
8397 if ($stdout && !ref($stdout)) {
8398 $fullcmd .= " >$stdout";
8400 if ($stderr && !ref($stderr)) {
8401 if ($stderr eq $stdout) {
8402 $fullcmd .= " 2>&1";
8405 $fullcmd .= " 2>$stderr";
8408 if ($gconfig{'os_type'} eq 'windows') {
8412 exec("/bin/sh", "-c", $fullcmd);
8414 print "Exec failed : $!\n";
8421 # Feed input and capture output
8423 if ($stdin && ref($stdin)) {
8424 print EXECSTDINw $$stdin;
8427 if ($stdout && ref($stdout)) {
8429 while(<EXECSTDOUTr>) {
8434 if ($stderr && ref($stderr) && $stderr ne $stdout) {
8436 while(<EXECSTDERRr>) {
8447 =head2 open_readfile(handle, file)
8449 Opens some file for reading. Returns 1 on success, 0 on failure. Pretty much
8450 exactly the same as Perl's open function.
8455 my ($fh, $file) = @_;
8456 $fh = &callers_package($fh);
8457 my $realfile = &translate_filename($file);
8458 &webmin_debug_log('READ', $file) if ($gconfig{'debug_what_read'});
8459 return open($fh, "<".$realfile);
8462 =head2 open_execute_command(handle, command, output?, safe?)
8464 Runs some command, with the specified file handle set to either write to it if
8465 in-or-out is set to 0, or read to it if output is set to 1. The safe flag
8466 indicates if the command modifies the state of the system or not.
8469 sub open_execute_command
8471 my ($fh, $cmd, $mode, $safe) = @_;
8472 $fh = &callers_package($fh);
8473 my $realcmd = &translate_command($cmd);
8474 if (&is_readonly_mode() && !$safe) {
8475 # Don't actually run it
8476 print STDERR "vetoing command $cmd\n";
8479 return open($fh, ">$null_file");
8482 return open($fh, $null_file);
8486 &webmin_debug_log('CMD', "cmd=$realcmd mode=$mode")
8487 if ($gconfig{'debug_what_cmd'});
8489 return open($fh, "| $cmd");
8491 elsif ($mode == 1) {
8492 return open($fh, "$cmd 2>$null_file |");
8494 elsif ($mode == 2) {
8495 return open($fh, "$cmd 2>&1 |");
8499 =head2 translate_filename(filename)
8501 Applies all relevant registered translation functions to a filename. Mostly
8502 for internal use, and typically does nothing.
8505 sub translate_filename
8507 my ($realfile) = @_;
8508 my @funcs = grep { $_->[0] eq &get_module_name() ||
8509 !defined($_->[0]) } @main::filename_callbacks;
8510 foreach my $f (@funcs) {
8512 $realfile = &$func($realfile, @{$f->[2]});
8517 =head2 translate_command(filename)
8519 Applies all relevant registered translation functions to a command. Mostly
8520 for internal use, and typically does nothing.
8523 sub translate_command
8526 my @funcs = grep { $_->[0] eq &get_module_name() ||
8527 !defined($_->[0]) } @main::command_callbacks;
8528 foreach my $f (@funcs) {
8530 $realcmd = &$func($realcmd, @{$f->[2]});
8535 =head2 register_filename_callback(module|undef, &function, &args)
8537 Registers some function to be called when the specified module (or all
8538 modules) tries to open a file for reading and writing. The function must
8539 return the actual file to open. This allows you to override which files
8540 other code actually operates on, via the translate_filename function.
8543 sub register_filename_callback
8545 my ($mod, $func, $args) = @_;
8546 push(@main::filename_callbacks, [ $mod, $func, $args ]);
8549 =head2 register_command_callback(module|undef, &function, &args)
8551 Registers some function to be called when the specified module (or all
8552 modules) tries to execute a command. The function must return the actual
8553 command to run. This allows you to override which commands other other code
8554 actually runs, via the translate_command function.
8557 sub register_command_callback
8559 my ($mod, $func, $args) = @_;
8560 push(@main::command_callbacks, [ $mod, $func, $args ]);
8563 =head2 capture_function_output(&function, arg, ...)
8565 Captures output that some function prints to STDOUT, and returns it. Useful
8566 for functions outside your control that print data when you really want to
8567 manipulate it before output.
8570 sub capture_function_output
8572 my ($func, @args) = @_;
8573 socketpair(SOCKET2, SOCKET1, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
8574 my $old = select(SOCKET1);
8575 my @rv = &$func(@args);
8584 return wantarray ? ($out, \@rv) : $out;
8587 =head2 capture_function_output_tempfile(&function, arg, ...)
8589 Behaves the same as capture_function_output, but uses a temporary file
8590 to avoid buffer full problems.
8593 sub capture_function_output_tempfile
8595 my ($func, @args) = @_;
8596 my $temp = &transname();
8597 open(BUFFER, ">$temp");
8598 my $old = select(BUFFER);
8599 my @rv = &$func(@args);
8602 my $out = &read_file_contents($temp);
8603 &unlink_file($temp);
8604 return wantarray ? ($out, \@rv) : $out;
8607 =head2 modules_chooser_button(field, multiple, [form])
8609 Returns HTML for a button for selecting one or many Webmin modules.
8610 field - Name of the HTML field to place the module names into.
8611 multiple - Set to 1 if multiple modules can be selected.
8612 form - Index of the form on the page.
8615 sub modules_chooser_button
8617 return &theme_modules_chooser_button(@_)
8618 if (defined(&theme_modules_chooser_button));
8619 my $form = defined($_[2]) ? $_[2] : 0;
8620 my $w = $_[1] ? 700 : 500;
8622 if ($_[1] && $gconfig{'db_sizemodules'}) {
8623 ($w, $h) = split(/x/, $gconfig{'db_sizemodules'});
8625 elsif (!$_[1] && $gconfig{'db_sizemodule'}) {
8626 ($w, $h) = split(/x/, $gconfig{'db_sizemodule'});
8628 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";
8631 =head2 substitute_template(text, &hash)
8633 Given some text and a hash reference, for each ocurrance of $FOO or ${FOO} in
8634 the text replaces it with the value of the hash key foo. Also supports blocks
8635 like ${IF-FOO} ... ${ENDIF-FOO}, whose contents are only included if foo is
8636 non-zero, and ${IF-FOO} ... ${ELSE-FOO} ... ${ENDIF-FOO}.
8639 sub substitute_template
8641 # Add some extra fixed parameters to the hash
8642 my %hash = %{$_[1]};
8643 $hash{'hostname'} = &get_system_hostname();
8644 $hash{'webmin_config'} = $config_directory;
8645 $hash{'webmin_etc'} = $config_directory;
8646 $hash{'module_config'} = &get_module_variable('$module_config_directory');
8647 $hash{'webmin_var'} = $var_directory;
8649 # Add time-based parameters, for use in DNS
8650 $hash{'current_time'} = time();
8651 my @tm = localtime($hash{'current_time'});
8652 $hash{'current_year'} = $tm[5]+1900;
8653 $hash{'current_month'} = sprintf("%2.2d", $tm[4]+1);
8654 $hash{'current_day'} = sprintf("%2.2d", $tm[3]);
8655 $hash{'current_hour'} = sprintf("%2.2d", $tm[2]);
8656 $hash{'current_minute'} = sprintf("%2.2d", $tm[1]);
8657 $hash{'current_second'} = sprintf("%2.2d", $tm[0]);
8659 # Actually do the substition
8661 foreach my $s (keys %hash) {
8662 next if ($s eq ''); # Prevent just $ from being subbed
8665 $rv =~ s/\$\{\Q$us\E\}/$sv/g;
8666 $rv =~ s/\$\Q$us\E/$sv/g;
8668 # Replace ${IF}..${ELSE}..${ENDIF} block with first value,
8669 # and ${IF}..${ENDIF} with value
8670 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8671 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8673 # Replace $IF..$ELSE..$ENDIF block with first value,
8674 # and $IF..$ENDIF with value
8675 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8676 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8678 # Replace ${IFEQ}..${ENDIFEQ} block with first value if
8679 # matching, nothing if not
8680 $rv =~ s/\$\{IFEQ-\Q$us\E-\Q$sv\E\}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-\Q$sv\E\}(\n?)/$2/g;
8681 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8683 # Replace $IFEQ..$ENDIFEQ block with first value if
8684 # matching, nothing if not
8685 $rv =~ s/\$IFEQ-\Q$us\E-\Q$sv\E(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\Q$sv\E(\n?)/$2/g;
8686 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8689 # Replace ${IF}..${ELSE}..${ENDIF} block with second value,
8690 # and ${IF}..${ENDIF} with nothing
8691 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$4/g;
8692 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)//g;
8694 # Replace $IF..$ELSE..$ENDIF block with second value,
8695 # and $IF..$ENDIF with nothing
8696 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$4/g;
8697 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)//g;
8699 # Replace ${IFEQ}..${ENDIFEQ} block with nothing
8700 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8701 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8705 # Now assume any $IF blocks whose variables are not present in the hash
8706 # evaluate to false.
8707 # $IF...$ELSE x $ENDIF => x
8708 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ELSE\-\1\}(.*?)\$\{ENDIF\-\1\}/$2/gs;
8709 # $IF...x...$ENDIF => (nothing)
8710 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ENDIF\-\1\}//gs;
8711 # ${var} => (nothing)
8712 $rv =~ s/\$\{[A-Z]+\}//g;
8717 =head2 running_in_zone
8719 Returns 1 if the current Webmin instance is running in a Solaris zone. Used to
8720 disable module and features that are not appropriate, like those that modify
8721 mounted filesystems.
8726 return 0 if ($gconfig{'os_type'} ne 'solaris' ||
8727 $gconfig{'os_version'} < 10);
8728 my $zn = `zonename 2>$null_file`;
8730 return $zn && $zn ne "global";
8733 =head2 running_in_vserver
8735 Returns 1 if the current Webmin instance is running in a Linux VServer.
8736 Used to disable modules and features that are not appropriate.
8739 sub running_in_vserver
8741 return 0 if ($gconfig{'os_type'} !~ /^\*-linux$/);
8744 open(MTAB, "/etc/mtab");
8746 my ($dev, $mp) = split(/\s+/, $_);
8747 if ($mp eq "/" && $dev =~ /^\/dev\/hdv/) {
8756 =head2 running_in_xen
8758 Returns 1 if Webmin is running inside a Xen instance, by looking
8759 at /proc/xen/capabilities.
8764 return 0 if (!-r "/proc/xen/capabilities");
8765 my $cap = &read_file_contents("/proc/xen/capabilities");
8766 return $cap =~ /control_d/ ? 0 : 1;
8769 =head2 running_in_openvz
8771 Returns 1 if Webmin is running inside an OpenVZ container, by looking
8772 at /proc/vz/veinfo for a non-zero line.
8775 sub running_in_openvz
8777 return 0 if (!-r "/proc/vz/veinfo");
8778 my $lref = &read_file_lines("/proc/vz/veinfo", 1);
8779 return 0 if (!$lref || !@$lref);
8780 foreach my $l (@$lref) {
8782 my @ll = split(/\s+/, $l);
8783 return 0 if ($ll[0] eq '0');
8788 =head2 list_categories(&modules, [include-empty])
8790 Returns a hash mapping category codes to names, including any custom-defined
8791 categories. The modules parameter must be an array ref of module hash objects,
8792 as returned by get_all_module_infos.
8797 my ($mods, $empty) = @_;
8798 my (%cats, %catnames);
8799 &read_file("$config_directory/webmin.catnames", \%catnames);
8800 foreach my $o (@lang_order_list) {
8801 &read_file("$config_directory/webmin.catnames.$o", \%catnames);
8806 foreach my $m (@$mods) {
8807 my $c = $m->{'category'};
8808 next if ($cats{$c});
8809 if (defined($catnames{$c})) {
8810 $cats{$c} = $catnames{$c};
8812 elsif ($text{"category_$c"}) {
8813 $cats{$c} = $text{"category_$c"};
8816 # try to get category name from module ..
8817 my %mtext = &load_language($m->{'dir'});
8818 if ($mtext{"category_$c"}) {
8819 $cats{$c} = $mtext{"category_$c"};
8822 $c = $m->{'category'} = "";
8823 $cats{$c} = $text{"category_$c"};
8830 =head2 is_readonly_mode
8832 Returns 1 if the current user is in read-only mode, and thus all writes
8833 to files and command execution should fail.
8836 sub is_readonly_mode
8838 if (!defined($main::readonly_mode_cache)) {
8839 my %gaccess = &get_module_acl(undef, "");
8840 $main::readonly_mode_cache = $gaccess{'readonly'} ? 1 : 0;
8842 return $main::readonly_mode_cache;
8845 =head2 command_as_user(user, with-env?, command, ...)
8847 Returns a command to execute some command as the given user, using the
8848 su statement. If on Linux, the /bin/sh shell is forced in case the user
8849 does not have a valid shell. If with-env is set to 1, the -s flag is added
8850 to the su command to read the user's .profile or .bashrc file.
8855 my ($user, $env, @args) = @_;
8856 my @uinfo = getpwnam($user);
8857 if ($uinfo[8] ne "/bin/sh" && $uinfo[8] !~ /\/bash$/) {
8858 # User shell doesn't appear to be valid
8859 if ($gconfig{'os_type'} =~ /-linux$/) {
8860 # Use -s /bin/sh to force it
8861 $shellarg = " -s /bin/sh";
8863 elsif ($gconfig{'os_type'} eq 'freebsd' ||
8864 $gconfig{'os_type'} eq 'solaris' &&
8865 $gconfig{'os_version'} >= 11 ||
8866 $gconfig{'os_type'} eq 'macos') {
8867 # Use -m and force /bin/sh
8868 @args = ( "/bin/sh", "-c", quotemeta(join(" ", @args)) );
8872 my $rv = "su".($env ? " -" : "").$shellarg.
8873 " ".quotemeta($user)." -c ".quotemeta(join(" ", @args));
8877 =head2 list_osdn_mirrors(project, file)
8879 This function is now deprecated in favor of letting sourceforge just
8880 redirect to the best mirror, and now just returns their primary download URL.
8883 sub list_osdn_mirrors
8885 my ($project, $file) = @_;
8886 return ( { 'url' => "http://downloads.sourceforge.net/$project/$file",
8888 'mirror' => 'downloads' } );
8891 =head2 convert_osdn_url(url)
8893 Given a URL like http://osdn.dl.sourceforge.net/sourceforge/project/file.zip
8894 or http://prdownloads.sourceforge.net/project/file.zip , convert it
8895 to a real URL on the sourceforge download redirector.
8898 sub convert_osdn_url
8901 if ($url =~ /^http:\/\/[^\.]+.dl.sourceforge.net\/sourceforge\/([^\/]+)\/(.*)$/ ||
8902 $url =~ /^http:\/\/prdownloads.sourceforge.net\/([^\/]+)\/(.*)$/) {
8903 # Always use the Sourceforge mail download URL, which does
8904 # a location-based redirect for us
8905 my ($project, $file) = ($1, $2);
8906 $url = "http://prdownloads.sourceforge.net/sourceforge/".
8908 return wantarray ? ( $url, 0 ) : $url;
8911 # Some other source .. don't change
8912 return wantarray ? ( $url, 2 ) : $url;
8916 =head2 get_current_dir
8918 Returns the directory the current process is running in.
8924 if ($gconfig{'os_type'} eq 'windows') {
8937 =head2 supports_users
8939 Returns 1 if the current OS supports Unix user concepts and functions like
8940 su , getpw* and so on. This will be true on Linux and other Unixes, but false
8946 return $gconfig{'os_type'} ne 'windows';
8949 =head2 supports_symlinks
8951 Returns 1 if the current OS supports symbolic and hard links. This will not
8952 be the case on Windows.
8955 sub supports_symlinks
8957 return $gconfig{'os_type'} ne 'windows';
8960 =head2 quote_path(path)
8962 Returns a path with safe quoting for the current operating system.
8968 if ($gconfig{'os_type'} eq 'windows' || $path =~ /^[a-z]:/i) {
8969 # Windows only supports "" style quoting
8973 return quotemeta($path);
8977 =head2 get_windows_root
8979 Returns the base windows system directory, like c:/windows.
8982 sub get_windows_root
8984 if ($ENV{'SystemRoot'}) {
8985 my $rv = $ENV{'SystemRoot'};
8990 return -d "c:/windows" ? "c:/windows" : "c:/winnt";
8994 =head2 read_file_contents(file)
8996 Given a filename, returns its complete contents as a string. Effectively
8997 the same as the Perl construct `cat file`.
9000 sub read_file_contents
9002 &open_readfile(FILE, $_[0]) || return undef;
9009 =head2 unix_crypt(password, salt)
9011 Performs Unix encryption on a password, using the built-in crypt function or
9012 the Crypt::UnixCrypt module if the former does not work. The salt parameter
9013 must be either an already-hashed password, or a two-character alpha-numeric
9019 my ($pass, $salt) = @_;
9020 return "" if ($salt !~ /^[a-zA-Z0-9\.\/]{2}/); # same as real crypt
9021 my $rv = eval "crypt(\$pass, \$salt)";
9023 return $rv if ($rv && !$@);
9024 eval "use Crypt::UnixCrypt";
9026 return Crypt::UnixCrypt::crypt($pass, $salt);
9029 &error("Failed to encrypt password : $err");
9033 =head2 split_quoted_string(string)
9035 Given a string like I<foo "bar baz" quux>, returns the array :
9039 sub split_quoted_string
9043 while($str =~ /^"([^"]*)"\s*([\000-\377]*)$/ ||
9044 $str =~ /^'([^']*)'\s*([\000-\377]*)$/ ||
9045 $str =~ /^(\S+)\s*([\000-\377]*)$/) {
9052 =head2 write_to_http_cache(url, file|&data)
9054 Updates the Webmin cache with the contents of the given file, possibly also
9055 clearing out old data. Mainly for internal use by http_download.
9058 sub write_to_http_cache
9060 my ($url, $file) = @_;
9061 return 0 if (!$gconfig{'cache_size'});
9063 # Don't cache downloads that look dynamic
9064 if ($url =~ /cgi-bin/ || $url =~ /\?/) {
9068 # Check if the current module should do caching
9069 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
9070 # Caching all except some modules
9071 my @mods = split(/\s+/, $1);
9072 return 0 if (&indexof(&get_module_name(), @mods) != -1);
9074 elsif ($gconfig{'cache_mods'}) {
9075 # Only caching some modules
9076 my @mods = split(/\s+/, $gconfig{'cache_mods'});
9077 return 0 if (&indexof(&get_module_name(), @mods) == -1);
9083 $size = length($$file);
9086 my @st = stat($file);
9090 if ($size > $gconfig{'cache_size'}) {
9091 # Bigger than the whole cache - so don't save it
9096 $cfile = "$main::http_cache_directory/$cfile";
9098 # See how much we have cached currently, clearing old files
9100 mkdir($main::http_cache_directory, 0700) if (!-d $main::http_cache_directory);
9101 opendir(CACHEDIR, $main::http_cache_directory);
9102 foreach my $f (readdir(CACHEDIR)) {
9103 next if ($f eq "." || $f eq "..");
9104 my $path = "$main::http_cache_directory/$f";
9105 my @st = stat($path);
9106 if ($gconfig{'cache_days'} &&
9107 time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
9108 # This file is too old .. trash it
9113 push(@cached, [ $path, $st[7], $st[9] ]);
9117 @cached = sort { $a->[2] <=> $b->[2] } @cached;
9118 while($total+$size > $gconfig{'cache_size'} && @cached) {
9119 # Cache is too big .. delete some files until the new one will fit
9120 unlink($cached[0]->[0]);
9121 $total -= $cached[0]->[1];
9125 # Finally, write out the new file
9127 &open_tempfile(CACHEFILE, ">$cfile");
9128 &print_tempfile(CACHEFILE, $$file);
9129 &close_tempfile(CACHEFILE);
9132 my ($ok, $err) = ©_source_dest($file, $cfile);
9138 =head2 check_in_http_cache(url)
9140 If some URL is in the cache and valid, return the filename for it. Mainly
9141 for internal use by http_download.
9144 sub check_in_http_cache
9147 return undef if (!$gconfig{'cache_size'});
9149 # Check if the current module should do caching
9150 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
9151 # Caching all except some modules
9152 my @mods = split(/\s+/, $1);
9153 return 0 if (&indexof(&get_module_name(), @mods) != -1);
9155 elsif ($gconfig{'cache_mods'}) {
9156 # Only caching some modules
9157 my @mods = split(/\s+/, $gconfig{'cache_mods'});
9158 return 0 if (&indexof(&get_module_name(), @mods) == -1);
9163 $cfile = "$main::http_cache_directory/$cfile";
9164 my @st = stat($cfile);
9165 return undef if (!@st || !$st[7]);
9166 if ($gconfig{'cache_days'} && time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
9171 open(TOUCH, ">>$cfile"); # Update the file time, to keep it in the cache
9176 =head2 supports_javascript
9178 Returns 1 if the current browser is assumed to support javascript.
9181 sub supports_javascript
9183 if (defined(&theme_supports_javascript)) {
9184 return &theme_supports_javascript();
9186 return $ENV{'MOBILE_DEVICE'} ? 0 : 1;
9189 =head2 get_module_name
9191 Returns the name of the Webmin module that called this function. For internal
9192 use only by other API functions.
9197 return &get_module_variable('$module_name');
9200 =head2 get_module_variable(name, [ref])
9202 Returns the value of some variable which is set in the caller's context, if
9203 using the new WebminCore package. For internal use only.
9206 sub get_module_variable
9208 my ($v, $wantref) = @_;
9209 my $slash = $wantref ? "\\" : "";
9210 my $thispkg = &web_libs_package();
9211 if ($thispkg eq 'WebminCore') {
9212 my ($vt, $vn) = split('', $v, 2);
9214 for(my $i=0; ($callpkg) = caller($i); $i++) {
9215 last if ($callpkg ne $thispkg);
9217 return eval "${slash}${vt}${callpkg}::${vn}";
9219 return eval "${slash}${v}";
9222 =head2 clear_time_locale()
9224 Temporarily force the locale to C, until reset_time_locale is called. This is
9225 useful if your code is going to call C<strftime> from the POSIX package, and
9226 you want to ensure that the output is in a consistent format.
9229 sub clear_time_locale
9231 if ($main::clear_time_locale_count == 0) {
9234 $main::clear_time_locale_old = POSIX::setlocale(POSIX::LC_TIME);
9235 POSIX::setlocale(POSIX::LC_TIME, "C");
9238 $main::clear_time_locale_count++;
9241 =head2 reset_time_locale()
9243 Revert the locale to whatever it was before clear_time_locale was called
9246 sub reset_time_locale
9248 if ($main::clear_time_locale_count == 1) {
9250 POSIX::setlocale(POSIX::LC_TIME, $main::clear_time_locale_old);
9251 $main::clear_time_locale_old = undef;
9254 $main::clear_time_locale_count--;
9257 =head2 callers_package(filehandle)
9259 Convert a non-module filehandle like FOO to one qualified with the
9260 caller's caller's package, like fsdump::FOO. For internal use only.
9266 my $callpkg = (caller(1))[0];
9267 my $thispkg = &web_libs_package();
9268 if (!ref($fh) && $fh !~ /::/ &&
9269 $callpkg ne $thispkg && $thispkg eq 'WebminCore') {
9270 $fh = $callpkg."::".$fh;
9275 =head2 web_libs_package()
9277 Returns the package this code is in. We can't always trust __PACKAGE__. For
9281 sub web_libs_package
9283 if ($called_from_webmin_core) {
9284 return "WebminCore";
9289 =head2 get_userdb_string
9291 Returns the URL-style string for connecting to the users and groups database
9294 sub get_userdb_string
9296 return undef if ($main::no_miniserv_userdb);
9298 &get_miniserv_config(\%miniserv);
9299 return $miniserv{'userdb'};
9302 =head2 connect_userdb(string)
9304 Returns a handle for talking to a user database - may be a DBI or LDAP handle.
9305 On failure returns an error message string. In an array context, returns the
9312 my ($proto, $user, $pass, $host, $prefix, $args) = &split_userdb_string($str);
9313 if ($proto eq "mysql") {
9314 # Connect to MySQL with DBI
9315 my $drh = eval "use DBI; DBI->install_driver('mysql');";
9316 $drh || return $text{'sql_emysqldriver'};
9317 my ($host, $port) = split(/:/, $host);
9318 my $cstr = "database=$prefix;host=$host";
9319 $cstr .= ";port=$port" if ($port);
9320 my $dbh = $drh->connect($cstr, $user, $pass, { });
9321 $dbh || return &text('sql_emysqlconnect', $drh->errstr);
9322 return wantarray ? ($dbh, $proto, $prefix, $args) : $dbh;
9324 elsif ($proto eq "postgresql") {
9325 # Connect to PostgreSQL with DBI
9326 my $drh = eval "use DBI; DBI->install_driver('Pg');";
9327 $drh || return $text{'sql_epostgresqldriver'};
9328 my ($host, $port) = split(/:/, $host);
9329 my $cstr = "dbname=$prefix;host=$host";
9330 $cstr .= ";port=$port" if ($port);
9331 my $dbh = $drh->connect($cstr, $user, $pass);
9332 $dbh || return &text('sql_epostgresqlconnect', $drh->errstr);
9333 return wantarray ? ($dbh, $proto, $prefix, $args) : $dbh;
9335 elsif ($proto eq "ldap") {
9336 # Connect with perl LDAP module
9337 eval "use Net::LDAP";
9338 $@ && return $text{'sql_eldapdriver'};
9339 my ($host, $port) = split(/:/, $host);
9340 my $scheme = $args->{'scheme'} || 'ldap';
9342 $port = $scheme eq 'ldaps' ? 636 : 389;
9344 my $ldap = Net::LDAP->new($host,
9346 'scheme' => $scheme);
9347 $ldap || return &text('sql_eldapconnect', $host);
9349 if ($args->{'tls'}) {
9350 # Switch to TLS mode
9351 eval { $mesg = $ldap->start_tls(); };
9352 if ($@ || !$mesg || $mesg->code) {
9353 return &text('sql_eldaptls',
9354 $@ ? $@ : $mesg ? $mesg->error : "Unknown error");
9357 # Login to the server
9359 $mesg = $ldap->bind(dn => $user, password => $pass);
9362 $mesg = $ldap->bind(dn => $user, anonymous => 1);
9364 if (!$mesg || $mesg->code) {
9365 return &text('sql_eldaplogin', $user,
9366 $mesg ? $mesg->error : "Unknown error");
9368 return wantarray ? ($ldap, $proto, $prefix, $args) : $ldap;
9371 return "Unknown protocol $proto";
9375 =head2 disconnect_userdb(string, &handle)
9377 Closes a handle opened by connect_userdb
9380 sub disconnect_userdb
9383 if ($str =~ /^(mysql|postgresql):/) {
9385 if (!$h->{'AutoCommit'}) {
9390 elsif ($str =~ /^ldap:/) {
9397 =head2 split_userdb_string(string)
9399 Converts a string like mysql://user:pass@host/db into separate parts
9402 sub split_userdb_string
9405 if ($str =~ /^([a-z]+):\/\/([^:]*):([^\@]*)\@([a-z0-9\.\-\_]+)\/([^\?]+)(\?(.*))?$/) {
9406 my ($proto, $user, $pass, $host, $prefix, $argstr) =
9407 ($1, $2, $3, $4, $5, $7);
9408 my %args = map { split(/=/, $_, 2) } split(/\&/, $argstr);
9409 return ($proto, $user, $pass, $host, $prefix, \%args);
9414 $done_web_lib_funcs = 1;