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 read_file_cached_with_stat(file, &hash, [&order], [lowercase], [split-char])
111 Like read_file, but reads from an in-memory cache if the file has already been
112 read in this Webmin script AND has not changed.
115 sub read_file_cached_with_stat
117 my $realfile = &translate_filename($_[0]);
118 my $t = $main::read_file_cache_time{$realfile};
119 my @st = stat($realfile);
120 if ($t && $st[9] != $t) {
121 # Changed, invalidate cache
122 delete($main::read_file_cache{$realfile});
124 my $rv = &read_file_cached(@_);
125 $main::read_file_cache_time{$realfile} = $st[9];
129 =head2 write_file(file, &hash, [join-char])
131 Write out the contents of a hash as name=value lines. The parameters are :
133 =item file - Full path to write to
135 =item hash - A hash reference containing names and values to output
137 =item join-char - If given, names and values are separated by this instead of =
143 my $join = defined($_[2]) ? $_[2] : "=";
144 my $realfile = &translate_filename($_[0]);
145 &read_file($_[0], \%old, \@order);
146 &open_tempfile(ARFILE, ">$_[0]");
147 foreach $k (@order) {
148 if (exists($_[1]->{$k})) {
149 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
150 &error(&text("efilewrite", $realfile, $!));
153 foreach $k (keys %{$_[1]}) {
154 if (!exists($old{$k})) {
155 (print ARFILE $k,$join,$_[1]->{$k},"\n") ||
156 &error(&text("efilewrite", $realfile, $!));
159 &close_tempfile(ARFILE);
160 if (defined($main::read_file_cache{$realfile})) {
161 %{$main::read_file_cache{$realfile}} = %{$_[1]};
163 if (defined($main::read_file_missing{$realfile})) {
164 $main::read_file_missing{$realfile} = 0;
168 =head2 html_escape(string)
170 Converts &, < and > codes in text to HTML entities, and returns the new string.
171 This should be used when including data read from other sources in HTML pages.
180 $tmp =~ s/\"/"/g;
181 $tmp =~ s/\'/'/g;
186 =head2 quote_escape(string, [only-quote])
188 Converts ' and " characters in a string into HTML entities, and returns it.
189 Useful for outputing HTML tag values.
194 my ($tmp, $only) = @_;
195 if ($tmp !~ /\&[a-zA-Z]+;/ && $tmp !~ /\&#/) {
196 # convert &, unless it is part of &#nnn; or &foo;
197 $tmp =~ s/&([^#])/&$1/g;
199 $tmp =~ s/&$/&/g;
200 $tmp =~ s/\"/"/g if ($only eq '' || $only eq '"');
201 $tmp =~ s/\'/'/g if ($only eq '' || $only eq "'");
205 =head2 tempname([filename])
207 Returns a mostly random temporary file name, typically under the /tmp/.webmin
208 directory. If filename is given, this will be the base name used. Otherwise
209 a unique name is selected randomly.
214 my $tmp_base = $gconfig{'tempdir_'.&get_module_name()} ?
215 $gconfig{'tempdir_'.&get_module_name()} :
216 $gconfig{'tempdir'} ? $gconfig{'tempdir'} :
217 $ENV{'TEMP'} && $ENV{'TEMP'} ne "/tmp" ? $ENV{'TEMP'} :
218 $ENV{'TMP'} && $ENV{'TMP'} ne "/tmp" ? $ENV{'TMP'} :
219 -d "c:/temp" ? "c:/temp" : "/tmp/.webmin";
220 my $tmp_dir = -d $remote_user_info[7] && !$gconfig{'nohometemp'} ?
221 "$remote_user_info[7]/.tmp" :
222 @remote_user_info ? $tmp_base."-".$remote_user :
223 $< != 0 ? $tmp_base."-".getpwuid($<) :
225 if ($gconfig{'os_type'} eq 'windows' || $tmp_dir =~ /^[a-z]:/i) {
226 # On Windows system, just create temp dir if missing
228 mkdir($tmp_dir, 0755) ||
229 &error("Failed to create temp directory $tmp_dir : $!");
233 # On Unix systems, need to make sure temp dir is valid
235 while($tries++ < 10) {
236 my @st = lstat($tmp_dir);
237 last if ($st[4] == $< && (-d _) && ($st[2] & 0777) == 0755);
239 unlink($tmp_dir) || rmdir($tmp_dir) ||
240 system("/bin/rm -rf ".quotemeta($tmp_dir));
242 mkdir($tmp_dir, 0755) || next;
243 chown($<, $(, $tmp_dir);
244 chmod(0755, $tmp_dir);
247 my @st = lstat($tmp_dir);
248 &error("Failed to create temp directory $tmp_dir : uid=$st[4] mode=$st[2]");
252 if (defined($_[0]) && $_[0] !~ /\.\./) {
253 $rv = "$tmp_dir/$_[0]";
256 $main::tempfilecount++;
258 $rv = $tmp_dir."/".int(rand(1000000))."_".
259 $main::tempfilecount."_".$scriptname;
264 =head2 transname([filename])
266 Behaves exactly like tempname, but records the temp file for deletion when the
267 current Webmin script process exits.
272 my $rv = &tempname(@_);
273 push(@main::temporary_files, $rv);
277 =head2 trunc(string, maxlen)
279 Truncates a string to the shortest whole word less than or equal to the
280 given width. Useful for word wrapping.
285 if (length($_[0]) <= $_[1]) {
288 my $str = substr($_[0],0,$_[1]);
297 =head2 indexof(string, value, ...)
299 Returns the index of some value in an array of values, or -1 if it was not
305 for(my $i=1; $i <= $#_; $i++) {
306 if ($_[$i] eq $_[0]) { return $i - 1; }
311 =head2 indexoflc(string, value, ...)
313 Like indexof, but does a case-insensitive match
318 my $str = lc(shift(@_));
319 my @arr = map { lc($_) } @_;
320 return &indexof($str, @arr);
323 =head2 sysprint(handle, [string]+)
325 Outputs some strings to a file handle, but bypassing IO buffering. Can be used
326 as a replacement for print when writing to pipes or sockets.
331 my $fh = &callers_package($_[0]);
332 my $str = join('', @_[1..$#_]);
333 syswrite $fh, $str, length($str);
336 =head2 check_ipaddress(ip)
338 Check if some IPv4 address is properly formatted, returning 1 if so or 0 if not.
343 return $_[0] =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/ &&
344 $1 >= 0 && $1 <= 255 &&
345 $2 >= 0 && $2 <= 255 &&
346 $3 >= 0 && $3 <= 255 &&
347 $4 >= 0 && $4 <= 255;
350 =head2 check_ip6address(ip)
352 Check if some IPv6 address is properly formatted, and returns 1 if so.
357 my @blocks = split(/:/, $_[0]);
358 return 0 if (@blocks == 0 || @blocks > 8);
360 # The address/netmask format is accepted. So we're looking for a "/" to isolate a possible netmask.
361 # After that, we delete the netmask to control the address only format, but we verify whether the netmask
362 # value is in [0;128].
364 my $where = index($blocks[$ib],"/");
367 my $b = substr($blocks[$ib],0,$where);
368 $m = substr($blocks[$ib],$where+1,length($blocks[$ib])-($where+1));
372 # The netmask must take its value in [0;128]
373 return 0 if ($m <0 || $m >128);
375 # Check the different blocks of the address : 16 bits block in hexa notation.
376 # Possibility of 1 empty block or 2 if the address begins with "::".
379 foreach $b (@blocks) {
380 return 0 if ($b ne "" && $b !~ /^[0-9a-f]{1,4}$/i);
381 $empty++ if ($b eq "");
383 return 0 if ($empty > 1 && !($_[0] =~ /^::/ && $empty == 2));
389 =head2 generate_icon(image, title, link, [href], [width], [height], [before-title], [after-title])
391 Prints HTML for an icon image. The parameters are :
393 =item image - URL for the image, like images/foo.gif
395 =item title - Text to appear under the icon
397 =item link - Optional destination for the icon's link
399 =item href - Other HTML attributes to be added to the <a href> for the link
401 =item width - Optional width of the icon
403 =item height - Optional height of the icon
405 =item before-title - HTML to appear before the title link, but which is not actually in the link
407 =item after-title - HTML to appear after the title link, but which is not actually in the link
412 &load_theme_library();
413 if (defined(&theme_generate_icon)) {
414 &theme_generate_icon(@_);
417 my $w = !defined($_[4]) ? "width=48" : $_[4] ? "width=$_[4]" : "";
418 my $h = !defined($_[5]) ? "height=48" : $_[5] ? "height=$_[5]" : "";
419 if ($tconfig{'noicons'}) {
421 print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
424 print "$_[6]$_[1]$_[7]\n";
428 print "<table border><tr><td width=48 height=48>\n",
429 "<a href=\"$_[2]\" $_[3]><img src=\"$_[0]\" alt=\"\" border=0 ",
430 "$w $h></a></td></tr></table>\n";
431 print "$_[6]<a href=\"$_[2]\" $_[3]>$_[1]</a>$_[7]\n";
434 print "<table border><tr><td width=48 height=48>\n",
435 "<img src=\"$_[0]\" alt=\"\" border=0 $w $h>",
436 "</td></tr></table>\n$_[6]$_[1]$_[7]\n";
442 Converts a string to a form ok for putting in a URL, using % escaping.
448 $rv =~ s/([^A-Za-z0-9])/sprintf("%%%2.2X", ord($1))/ge;
452 =head2 un_urlize(string)
454 Converts a URL-encoded string to it's original contents - the reverse of the
462 $rv =~ s/%(..)/pack("c",hex($1))/ge;
466 =head2 include(filename)
468 Read and output the contents of the given file.
474 open(INCLUDE, &translate_filename($_[0])) || return 0;
482 =head2 copydata(in-handle, out-handle)
484 Read from one file handle and write to another, until there is no more to read.
490 $in = &callers_package($in);
491 $out = &callers_package($out);
493 while(read($in, $buf, 1024) > 0) {
494 (print $out $buf) || return 0;
499 =head2 ReadParseMime([maximum], [&cbfunc, &cbargs])
501 Read data submitted via a POST request using the multipart/form-data coding,
502 and store it in the global %in hash. The optional parameters are :
504 =item maximum - If the number of bytes of input exceeds this number, stop reading and call error.
506 =item cbfunc - A function reference to call after reading each block of data.
508 =item cbargs - Additional parameters to the callback function.
513 my ($max, $cbfunc, $cbargs) = @_;
514 my ($boundary, $line, $foo, $name, $got, $file);
515 my $err = &text('readparse_max', $max);
516 $ENV{'CONTENT_TYPE'} =~ /boundary=(.*)$/ || &error($text{'readparse_enc'});
517 if ($ENV{'CONTENT_LENGTH'} && $max && $ENV{'CONTENT_LENGTH'} > $max) {
520 &$cbfunc(0, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
522 <STDIN>; # skip first boundary
525 # Read section headers
529 $got += length($line);
530 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, @$cbargs) if ($cbfunc);
531 if ($max && $got > $max) {
536 if ($line =~ /^(\S+):\s*(.*)$/) {
537 $header{$lastheader = lc($1)} = $2;
539 elsif ($line =~ /^\s+(.*)$/) {
540 $header{$lastheader} .= $line;
544 # Parse out filename and type
545 if ($header{'content-disposition'} =~ /^form-data(.*)/) {
547 while ($rest =~ /([a-zA-Z]*)=\"([^\"]*)\"(.*)/) {
552 $foo = $name . "_$1";
559 &error($text{'readparse_cdheader'});
561 if ($header{'content-type'} =~ /^([^\s;]+)/) {
562 $foo = $name . "_content_type";
565 $file = $in{$name."_filename"};
568 $in{$name} .= "\0" if (defined($in{$name}));
571 $got += length($line);
572 &$cbfunc($got, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
574 if ($max && $got > $max) {
575 #print STDERR "over limit of $max\n";
580 &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs)
585 $ptline =~ s/[^a-zA-Z0-9\-]/\./g;
586 if (index($line, $boundary) != -1) { last; }
589 chop($in{$name}); chop($in{$name});
590 if (index($line,"$boundary--") != -1) { last; }
592 &$cbfunc(-1, $ENV{'CONTENT_LENGTH'}, $file, @$cbargs) if ($cbfunc);
595 =head2 ReadParse([&hash], [method], [noplus])
597 Fills the given hash reference with CGI parameters, or uses the global hash
598 %in if none is given. Also sets the global variables $in and @in. The other
601 =item method - For use of this HTTP method, such as GET
603 =item noplus - Don't convert + in parameters to spaces.
608 my $a = $_[0] || \%in;
610 my $meth = $_[1] ? $_[1] : $ENV{'REQUEST_METHOD'};
612 if ($meth eq 'POST') {
613 my $clen = $ENV{'CONTENT_LENGTH'};
614 &read_fully(STDIN, \$in, $clen) == $clen ||
615 &error("Failed to read POST input : $!");
617 if ($ENV{'QUERY_STRING'}) {
618 if ($in) { $in .= "&".$ENV{'QUERY_STRING'}; }
619 else { $in = $ENV{'QUERY_STRING'}; }
621 @in = split(/\&/, $in);
622 foreach my $i (@in) {
623 my ($k, $v) = split(/=/, $i, 2);
628 $k =~ s/%(..)/pack("c",hex($1))/ge;
629 $v =~ s/%(..)/pack("c",hex($1))/ge;
630 $a->{$k} = defined($a->{$k}) ? $a->{$k}."\0".$v : $v;
634 =head2 read_fully(fh, &buffer, length)
636 Read data from some file handle up to the given length, even in the face
637 of partial reads. Reads the number of bytes read. Stores received data in the
638 string pointed to be the buffer reference.
643 my ($fh, $buf, $len) = @_;
644 $fh = &callers_package($fh);
647 my $r = read(STDIN, $$buf, $len-$got, $got);
654 =head2 read_parse_mime_callback(size, totalsize, upload-id)
656 Called by ReadParseMime as new data arrives from a form-data POST. Only updates
657 the file on every 1% change though. For internal use by the upload progress
661 sub read_parse_mime_callback
663 my ($size, $totalsize, $filename, $id) = @_;
664 return if ($gconfig{'no_upload_tracker'});
667 # Create the upload tracking directory - if running as non-root, this has to
668 # be under the user's home
671 my @uinfo = @remote_user_info ? @remote_user_info : getpwuid($<);
672 $vardir = "$uinfo[7]/.tmp";
675 $vardir = $ENV{'WEBMIN_VAR'};
678 &make_dir($vardir, 0755);
681 # Remove any upload.* files more than 1 hour old
682 if (!$main::read_parse_mime_callback_flushed) {
684 opendir(UPDIR, $vardir);
685 foreach my $f (readdir(UPDIR)) {
686 next if ($f !~ /^upload\./);
687 my @st = stat("$vardir/$f");
688 if ($st[9] < $now-3600) {
689 unlink("$vardir/$f");
693 $main::read_parse_mime_callback_flushed++;
696 # Only update file once per percent
697 my $upfile = "$vardir/upload.$id";
698 if ($totalsize && $size >= 0) {
699 my $pc = int(100 * $size / $totalsize);
700 if ($pc <= $main::read_parse_mime_callback_pc{$upfile}) {
703 $main::read_parse_mime_callback_pc{$upfile} = $pc;
707 &open_tempfile(UPFILE, ">$upfile");
708 print UPFILE $size,"\n";
709 print UPFILE $totalsize,"\n";
710 print UPFILE $filename,"\n";
711 &close_tempfile(UPFILE);
714 =head2 read_parse_mime_javascript(upload-id, [&fields])
716 Returns an onSubmit= Javascript statement to popup a window for tracking
717 an upload with the given ID. For internal use by the upload progress tracker.
720 sub read_parse_mime_javascript
722 my ($id, $fields) = @_;
723 return "" if ($gconfig{'no_upload_tracker'});
724 my $opener = "window.open(\"$gconfig{'webprefix'}/uptracker.cgi?id=$id&uid=$<\", \"uptracker\", \"toolbar=no,menubar=no,scrollbars=no,width=500,height=100\");";
726 my $if = join(" || ", map { "typeof($_) != \"undefined\" && $_.value != \"\"" } @$fields);
727 return "onSubmit='if ($if) { $opener }'";
730 return "onSubmit='$opener'";
734 =head2 PrintHeader(charset)
736 Outputs the HTTP headers for an HTML page. The optional charset parameter
737 can be used to set a character set. Normally this function is not called
738 directly, but is rather called by ui_print_header or header.
743 if ($pragma_no_cache || $gconfig{'pragma_no_cache'}) {
744 print "pragma: no-cache\n";
745 print "Expires: Thu, 1 Jan 1970 00:00:00 GMT\n";
746 print "Cache-Control: no-store, no-cache, must-revalidate\n";
747 print "Cache-Control: post-check=0, pre-check=0\n";
749 if (defined($_[0])) {
750 print "Content-type: text/html; Charset=$_[0]\n\n";
753 print "Content-type: text/html\n\n";
757 =head2 header(title, image, [help], [config], [nomodule], [nowebmin], [rightside], [head-stuff], [body-stuff], [below])
759 Outputs a Webmin HTML page header with a title, including HTTP headers. The
762 =item title - The text to show at the top of the page
764 =item image - An image to show instead of the title text. This is typically left blank.
766 =item help - If set, this is the name of a help page that will be linked to in the title.
768 =item config - If set to 1, the title will contain a link to the module's config page.
770 =item nomodule - If set to 1, there will be no link in the title section to the module's index.
772 =item nowebmin - If set to 1, there will be no link in the title section to the Webmin index.
774 =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.
776 =item head-stuff - HTML to be included in the <head> section of the page.
778 =item body-stuff - HTML attributes to be include in the <body> tag.
780 =item below - HTML to be displayed below the title. Typically this is used for application or server version information.
785 return if ($main::done_webmin_header++);
787 my $charset = defined($main::force_charset) ? $main::force_charset
789 &PrintHeader($charset);
790 &load_theme_library();
791 if (defined(&theme_header)) {
792 $module_name = &get_module_name();
794 $miniserv::page_capture = 1;
797 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
800 if (defined(&theme_prehead)) {
804 print "<meta http-equiv=\"Content-Type\" ",
805 "content=\"text/html; Charset="."e_escape($charset)."\">\n";
808 my $title = &get_html_title($_[0]);
809 print "<title>$title</title>\n";
810 print $_[7] if ($_[7]);
811 print &get_html_status_line(0);
813 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
814 if ($tconfig{'headinclude'}) {
815 print &read_file_contents(
816 "$theme_root_directory/$tconfig{'headinclude'}");
819 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
820 defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
821 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
822 defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
823 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
824 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
825 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
827 my $dir = $current_lang_info->{'dir'} ? "dir=\"$current_lang_info->{'dir'}\""
829 print "<body bgcolor=#$bgcolor link=#$link vlink=#$link text=#$text ",
830 "$bgimage $tconfig{'inbody'} $dir $_[8]>\n";
831 if (defined(&theme_prebody)) {
834 my $hostname = &get_display_hostname();
835 my $version = &get_webmin_version();
836 my $prebody = $tconfig{'prebody'};
838 $prebody =~ s/%HOSTNAME%/$hostname/g;
839 $prebody =~ s/%VERSION%/$version/g;
840 $prebody =~ s/%USER%/$remote_user/g;
841 $prebody =~ s/%OS%/$os_type $os_version/g;
844 if ($tconfig{'prebodyinclude'}) {
846 open(INC, "$theme_root_directory/$tconfig{'prebodyinclude'}");
853 print $tconfig{'preheader'};
854 my %this_module_info = &get_module_info(&get_module_name());
855 print "<table class='header' width=100%><tr>\n";
856 if ($gconfig{'sysinfo'} == 2 && $remote_user) {
857 print "<td id='headln1' colspan=3 align=center>\n";
858 print &get_html_status_line(1);
859 print "</td></tr> <tr>\n";
861 print "<td id='headln2l' width=15% valign=top align=left>";
862 if ($ENV{'HTTP_WEBMIN_SERVERS'} && !$tconfig{'framed'}) {
863 print "<a href='$ENV{'HTTP_WEBMIN_SERVERS'}'>",
864 "$text{'header_servers'}</a><br>\n";
866 if (!$_[5] && !$tconfig{'noindex'}) {
867 my @avail = &get_available_module_infos(1);
868 my $nolo = $ENV{'ANONYMOUS_USER'} ||
869 $ENV{'SSL_USER'} || $ENV{'LOCAL_USER'} ||
870 $ENV{'HTTP_USER_AGENT'} =~ /webmin/i;
871 if ($gconfig{'gotoone'} && $main::session_id && @avail == 1 &&
873 print "<a href='$gconfig{'webprefix'}/session_login.cgi?logout=1'>",
874 "$text{'main_logout'}</a><br>";
876 elsif ($gconfig{'gotoone'} && @avail == 1 && !$nolo) {
877 print "<a href=$gconfig{'webprefix'}/switch_user.cgi>",
878 "$text{'main_switch'}</a><br>";
880 elsif (!$gconfig{'gotoone'} || @avail > 1) {
881 print "<a href='$gconfig{'webprefix'}/?cat=",
882 $this_module_info{'category'},
883 "'>$text{'header_webmin'}</a><br>\n";
886 if (!$_[4] && !$tconfig{'nomoduleindex'}) {
887 my $idx = $this_module_info{'index_link'};
888 my $mi = $module_index_link || "/".&get_module_name()."/$idx";
889 my $mt = $module_index_name || $text{'header_module'};
890 print "<a href=\"$gconfig{'webprefix'}$mi\">$mt</a><br>\n";
892 if (ref($_[2]) eq "ARRAY" && !$ENV{'ANONYMOUS_USER'} &&
893 !$tconfig{'nohelp'}) {
894 print &hlink($text{'header_help'}, $_[2]->[0], $_[2]->[1]),
897 elsif (defined($_[2]) && !$ENV{'ANONYMOUS_USER'} &&
898 !$tconfig{'nohelp'}) {
899 print &hlink($text{'header_help'}, $_[2]),"<br>\n";
902 my %access = &get_module_acl();
903 if (!$access{'noconfig'} && !$config{'noprefs'}) {
904 my $cprog = $user_module_config_directory ?
905 "uconfig.cgi" : "config.cgi";
906 print "<a href=\"$gconfig{'webprefix'}/$cprog?",
907 &get_module_name()."\">",
908 $text{'header_config'},"</a><br>\n";
913 # Title is a single image
914 print "<td id='headln2c' align=center width=70%>",
915 "<img alt=\"$_[0]\" src=\"$_[1]\"></td>\n";
919 my $ts = defined($tconfig{'titlesize'}) ?
920 $tconfig{'titlesize'} : "+2";
921 print "<td id='headln2c' align=center width=70%>",
922 ($ts ? "<font size=$ts>" : ""),$_[0],
923 ($ts ? "</font>" : "");
924 print "<br>$_[9]\n" if ($_[9]);
927 print "<td id='headln2r' width=15% valign=top align=right>";
929 print "</td></tr></table>\n";
930 print $tconfig{'postheader'};
932 $miniserv::page_capture = 1;
935 =head2 get_html_title(title)
937 Returns the full string to appear in the HTML <title> block.
944 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
945 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
946 my $host = &get_display_hostname();
947 if ($gconfig{'sysinfo'} == 1 && $remote_user) {
948 $title = sprintf "%s : %s on %s (%s %s)\n",
949 $msg, $remote_user, $host,
950 $os_type, $os_version;
952 elsif ($gconfig{'sysinfo'} == 4 && $remote_user) {
953 $title = sprintf "%s on %s (%s %s)\n",
955 $os_type, $os_version;
960 if ($gconfig{'showlogin'} && $remote_user) {
961 $title = $remote_user.($title ? " : ".$title : "");
963 if ($gconfig{'showhost'}) {
964 $title = $host.($title ? " : ".$title : "");
969 =head2 get_html_framed_title
971 Returns the title text for a framed theme main page.
974 sub get_html_framed_title
977 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
978 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
980 if (($gconfig{'sysinfo'} == 4 || $gconfig{'sysinfo'} == 1) && $remote_user) {
981 # Alternate title mode requested
982 $title = sprintf "%s on %s (%s %s)\n",
983 $remote_user, &get_display_hostname(),
984 $os_type, $os_version;
987 # Title like 'Webmin x.yy on hostname (Linux 6)'
988 if ($os_version eq "*") {
992 $ostr = "$os_type $os_version";
994 my $host = &get_display_hostname();
995 my $ver = &get_webmin_version();
996 $title = $gconfig{'nohostname'} ? $text{'main_title2'} :
997 $gconfig{'showhost'} ? &text('main_title3', $ver, $ostr) :
998 &text('main_title', $ver, $host, $ostr);
999 if ($gconfig{'showlogin'}) {
1000 $title = $remote_user.($title ? " : ".$title : "");
1002 if ($gconfig{'showhost'}) {
1003 $title = $host.($title ? " : ".$title : "");
1009 =head2 get_html_status_line(text-only)
1011 Returns HTML for a script block that sets the status line, or if text-only
1012 is set to 1, just return the status line text.
1015 sub get_html_status_line
1017 my ($textonly) = @_;
1018 if (($gconfig{'sysinfo'} != 0 || !$remote_user) && !$textonly) {
1019 # Disabled in this mode
1022 my $os_type = $gconfig{'real_os_type'} || $gconfig{'os_type'};
1023 my $os_version = $gconfig{'real_os_version'} || $gconfig{'os_version'};
1024 my $line = &text('header_statusmsg',
1025 ($ENV{'ANONYMOUS_USER'} ? "Anonymous user"
1027 ($ENV{'SSL_USER'} ? " (SSL certified)" :
1028 $ENV{'LOCAL_USER'} ? " (Local user)" : ""),
1029 $text{'programname'},
1030 &get_webmin_version(),
1031 &get_display_hostname(),
1032 $os_type.($os_version eq "*" ? "" :" $os_version"));
1037 $line =~ s/\r|\n//g;
1038 return "<script language=JavaScript type=text/javascript>\n".
1039 "defaultStatus=\""."e_escape($line)."\";\n".
1044 =head2 popup_header([title], [head-stuff], [body-stuff], [no-body])
1046 Outputs a page header, suitable for a popup window. If no title is given,
1047 absolutely no decorations are output. Also useful in framesets. The parameters
1050 =item title - Title text for the popup window.
1052 =item head-stuff - HTML to appear in the <head> section.
1054 =item body-stuff - HTML attributes to be include in the <body> tag.
1056 =item no-body - If set to 1, don't generate a body tag
1061 return if ($main::done_webmin_header++);
1063 my $charset = defined($main::force_charset) ? $main::force_charset
1065 &PrintHeader($charset);
1066 &load_theme_library();
1067 if (defined(&theme_popup_header)) {
1068 &theme_popup_header(@_);
1069 $miniserv::page_capture = 1;
1072 print "<!doctype html public \"-//W3C//DTD HTML 3.2 Final//EN\">\n";
1075 if (defined(&theme_popup_prehead)) {
1076 &theme_popup_prehead(@_);
1078 print "<title>$_[0]</title>\n";
1080 print "$tconfig{'headhtml'}\n" if ($tconfig{'headhtml'});
1081 if ($tconfig{'headinclude'}) {
1082 print &read_file_contents(
1083 "$theme_root_directory/$tconfig{'headinclude'}");
1086 my $bgcolor = defined($tconfig{'cs_page'}) ? $tconfig{'cs_page'} :
1087 defined($gconfig{'cs_page'}) ? $gconfig{'cs_page'} : "ffffff";
1088 my $link = defined($tconfig{'cs_link'}) ? $tconfig{'cs_link'} :
1089 defined($gconfig{'cs_link'}) ? $gconfig{'cs_link'} : "0000ee";
1090 my $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
1091 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
1092 my $bgimage = defined($tconfig{'bgimage'}) ? "background=$tconfig{'bgimage'}"
1095 print "<body id='popup' bgcolor=#$bgcolor link=#$link vlink=#$link ",
1096 "text=#$text $bgimage $tconfig{'inbody'} $_[2]>\n";
1097 if (defined(&theme_popup_prebody)) {
1098 &theme_popup_prebody(@_);
1101 $miniserv::page_capture = 1;
1104 =head2 footer([page, name]+, [noendbody])
1106 Outputs the footer for a Webmin HTML page, possibly with links back to other
1107 pages. The links are specified by pairs of parameters, the first of which is
1108 a link destination, and the second the link text. For example :
1110 footer('/', 'Webmin index', '', 'Module menu');
1115 $miniserv::page_capture = 0;
1116 &load_theme_library();
1117 my %this_module_info = &get_module_info(&get_module_name());
1118 if (defined(&theme_footer)) {
1119 $module_name = &get_module_name(); # Old themes use these
1120 %module_info = %this_module_info;
1124 for(my $i=0; $i+1<@_; $i+=2) {
1126 if ($url ne '/' || !$tconfig{'noindex'}) {
1128 $url = "/?cat=$this_module_info{'category'}";
1130 elsif ($url eq '' && &get_module_name()) {
1131 $url = "/".&get_module_name()."/".
1132 $this_module_info{'index_link'};
1134 elsif ($url =~ /^\?/ && &get_module_name()) {
1135 $url = "/".&get_module_name()."/$url";
1137 $url = "$gconfig{'webprefix'}$url" if ($url =~ /^\//);
1139 print "<a href=\"$url\"><img alt=\"<-\" align=middle border=0 src=$gconfig{'webprefix'}/images/left.gif></a>\n";
1144 print " <a href=\"$url\">",&text('main_return', $_[$i+1]),"</a>\n";
1149 my $postbody = $tconfig{'postbody'};
1151 my $hostname = &get_display_hostname();
1152 my $version = &get_webmin_version();
1153 my $os_type = $gconfig{'real_os_type'} ||
1154 $gconfig{'os_type'};
1155 my $os_version = $gconfig{'real_os_version'} ||
1156 $gconfig{'os_version'};
1157 $postbody =~ s/%HOSTNAME%/$hostname/g;
1158 $postbody =~ s/%VERSION%/$version/g;
1159 $postbody =~ s/%USER%/$remote_user/g;
1160 $postbody =~ s/%OS%/$os_type $os_version/g;
1161 print "$postbody\n";
1163 if ($tconfig{'postbodyinclude'}) {
1165 open(INC, "$theme_root_directory/$tconfig{'postbodyinclude'}");
1171 if (defined(&theme_postbody)) {
1172 &theme_postbody(@_);
1174 print "</body></html>\n";
1178 =head2 popup_footer([no-body])
1180 Outputs html for a footer for a popup window, started by popup_header.
1185 $miniserv::page_capture = 0;
1186 &load_theme_library();
1187 if (defined(&theme_popup_footer)) {
1188 &theme_popup_footer(@_);
1197 =head2 load_theme_library
1199 Immediately loads the current theme's theme.pl file. Not generally useful for
1200 most module developers, as this is called automatically by the header function.
1203 sub load_theme_library
1205 return if (!$current_theme || $loaded_theme_library++);
1206 for(my $i=0; $i<@theme_root_directories; $i++) {
1207 if ($theme_configs[$i]->{'functions'}) {
1208 do $theme_root_directories[$i]."/".
1209 $theme_configs[$i]->{'functions'};
1214 =head2 redirect(url)
1216 Output HTTP headers to redirect the browser to some page. The url parameter is
1217 typically a relative URL like index.cgi or list_users.cgi.
1222 my $port = $ENV{'SERVER_PORT'} == 443 && uc($ENV{'HTTPS'}) eq "ON" ? "" :
1223 $ENV{'SERVER_PORT'} == 80 && uc($ENV{'HTTPS'}) ne "ON" ? "" :
1224 ":$ENV{'SERVER_PORT'}";
1225 my $prot = uc($ENV{'HTTPS'}) eq "ON" ? "https" : "http";
1226 my $wp = $gconfig{'webprefixnoredir'} ? undef : $gconfig{'webprefix'};
1228 if ($_[0] =~ /^(http|https|ftp|gopher):/) {
1229 # Absolute URL (like http://...)
1232 elsif ($_[0] =~ /^\//) {
1233 # Absolute path (like /foo/bar.cgi)
1234 $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$_[0]";
1236 elsif ($ENV{'SCRIPT_NAME'} =~ /^(.*)\/[^\/]*$/) {
1237 # Relative URL (like foo.cgi)
1238 $url = "$prot://$ENV{'SERVER_NAME'}$port$wp$1/$_[0]";
1241 $url = "$prot://$ENV{'SERVER_NAME'}$port/$wp$_[0]";
1243 &load_theme_library();
1244 if (defined(&theme_redirect)) {
1245 $module_name = &get_module_name(); # Old themes use these
1246 %module_info = &get_module_info($module_name);
1247 &theme_redirect($_[0], $url);
1250 print "Location: $url\n\n";
1254 =head2 kill_byname(name, signal)
1256 Finds a process whose command line contains the given name (such as httpd), and
1257 sends some signal to it. The signal can be numeric (like 9) or named
1263 my @pids = &find_byname($_[0]);
1264 return scalar(@pids) if (&is_readonly_mode());
1265 &webmin_debug_log('KILL', "signal=$_[1] name=$_[0]")
1266 if ($gconfig{'debug_what_procs'});
1267 if (@pids) { kill($_[1], @pids); return scalar(@pids); }
1271 =head2 kill_byname_logged(name, signal)
1273 Like kill_byname, but also logs the killing.
1276 sub kill_byname_logged
1278 my @pids = &find_byname($_[0]);
1279 return scalar(@pids) if (&is_readonly_mode());
1280 if (@pids) { &kill_logged($_[1], @pids); return scalar(@pids); }
1284 =head2 find_byname(name)
1286 Finds processes searching for the given name in their command lines, and
1287 returns a list of matching PIDs.
1292 if ($gconfig{'os_type'} =~ /-linux$/ && -r "/proc/$$/cmdline") {
1293 # Linux with /proc filesystem .. use cmdline files, as this is
1294 # faster than forking
1296 opendir(PROCDIR, "/proc");
1297 foreach my $f (readdir(PROCDIR)) {
1298 if ($f eq int($f) && $f != $$) {
1299 my $line = &read_file_contents("/proc/$f/cmdline");
1300 if ($line =~ /$_[0]/) {
1309 if (&foreign_check("proc")) {
1310 # Call the proc module
1311 &foreign_require("proc", "proc-lib.pl");
1312 if (defined(&proc::list_processes)) {
1313 my @procs = &proc::list_processes();
1315 foreach my $p (@procs) {
1316 if ($p->{'args'} =~ /$_[0]/) {
1317 push(@pids, $p->{'pid'});
1320 @pids = grep { $_ != $$ } @pids;
1325 # Fall back to running a command
1327 $cmd = $gconfig{'find_pid_command'};
1328 $cmd =~ s/NAME/"$_[0]"/g;
1329 $cmd = &translate_command($cmd);
1330 @pids = split(/\n/, `($cmd) <$null_file 2>$null_file`);
1331 @pids = grep { $_ != $$ } @pids;
1335 =head2 error([message]+)
1337 Display an error message and exit. This should be used by CGI scripts that
1338 encounter a fatal error or invalid user input to notify users of the problem.
1339 If error_setup has been called, the displayed error message will be prefixed
1340 by the message setup using that function.
1345 $main::no_miniserv_userdb = 1;
1346 my $msg = join("", @_);
1347 $msg =~ s/<[^>]*>//g;
1348 if (!$main::error_must_die) {
1349 print STDERR "Error: ",$msg,"\n";
1351 &load_theme_library();
1352 if ($main::error_must_die) {
1353 if ($gconfig{'error_stack'}) {
1354 print STDERR "Error: ",$msg,"\n";
1355 for(my $i=0; my @stack = caller($i); $i++) {
1356 print STDERR "File: $stack[1] Line: $stack[2] ",
1357 "Function: $stack[3]\n";
1362 elsif (!$ENV{'REQUEST_METHOD'}) {
1363 # Show text-only error
1364 print STDERR "$text{'error'}\n";
1365 print STDERR "-----\n";
1366 print STDERR ($main::whatfailed ? "$main::whatfailed : " : ""),
1368 print STDERR "-----\n";
1369 if ($gconfig{'error_stack'}) {
1371 print STDERR $text{'error_stack'},"\n";
1372 for(my $i=0; my @stack = caller($i); $i++) {
1373 print STDERR &text('error_stackline',
1374 $stack[1], $stack[2], $stack[3]),"\n";
1379 elsif (defined(&theme_error)) {
1383 &header($text{'error'}, "");
1385 print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),
1387 if ($gconfig{'error_stack'}) {
1389 print "<h3>$text{'error_stack'}</h3>\n";
1391 print "<tr> <td><b>$text{'error_file'}</b></td> ",
1392 "<td><b>$text{'error_line'}</b></td> ",
1393 "<td><b>$text{'error_sub'}</b></td> </tr>\n";
1394 for($i=0; my @stack = caller($i); $i++) {
1396 print "<td>$stack[1]</td>\n";
1397 print "<td>$stack[2]</td>\n";
1398 print "<td>$stack[3]</td>\n";
1404 if ($ENV{'HTTP_REFERER'} && $main::completed_referers_check) {
1405 &footer($ENV{'HTTP_REFERER'}, $text{'error_previous'});
1411 &unlock_all_files();
1412 &cleanup_tempnames();
1416 =head2 popup_error([message]+)
1418 This function is almost identical to error, but displays the message with HTML
1419 headers suitable for a popup window.
1424 $main::no_miniserv_userdb = 1;
1425 &load_theme_library();
1426 if ($main::error_must_die) {
1429 elsif (defined(&theme_popup_error)) {
1430 &theme_popup_error(@_);
1433 &popup_header($text{'error'}, "");
1434 print "<h3>",($main::whatfailed ? "$main::whatfailed : " : ""),@_,"</h3>\n";
1437 &unlock_all_files();
1438 &cleanup_tempnames();
1442 =head2 error_setup(message)
1444 Registers a message to be prepended to all error messages displayed by the
1450 $main::whatfailed = $_[0];
1453 =head2 wait_for(handle, regexp, regexp, ...)
1455 Reads from the input stream until one of the regexps matches, and returns the
1456 index of the matching regexp, or -1 if input ended before any matched. This is
1457 very useful for parsing the output of interactive programs, and can be used with
1458 a two-way pipe to feed input to a program in response to output matched by
1461 If the matching regexp contains bracketed sub-expressions, their values will
1462 be placed in the global array @matches, indexed starting from 1. You cannot
1463 use the Perl variables $1, $2 and so on to capture matches.
1467 $rv = wait_for($loginfh, "username:");
1469 error("Didn't get username prompt");
1471 print $loginfh "joe\n";
1472 $rv = wait_for($loginfh, "password:");
1474 error("Didn't get password prompt");
1476 print $loginfh "smeg\n";
1481 my ($c, $i, $sw, $rv, $ha);
1482 undef($wait_for_input);
1483 if ($wait_for_debug) {
1484 print STDERR "wait_for(",join(",", @_),")\n";
1486 $ha = &callers_package($_[0]);
1487 if ($wait_for_debug) {
1488 print STDERR "File handle=$ha fd=",fileno($ha),"\n";
1493 " if ((\$c = getc(\$ha)) eq \"\") { return -1; }\n".
1494 " \$wait_for_input .= \$c;\n";
1495 if ($wait_for_debug) {
1496 $codes .= "print STDERR \$wait_for_input,\"\\n\";";
1498 for($i=1; $i<@_; $i++) {
1499 $sw = $i>1 ? "elsif" : "if";
1500 $codes .= " $sw (\$wait_for_input =~ /$_[$i]/i) { \$hit = $i-1; }\n";
1503 " if (defined(\$hit)) {\n".
1504 " \@matches = (-1, \$1, \$2, \$3, \$4, \$5, \$6, \$7, \$8, \$9);\n".
1510 &error("wait_for error : $@\n");
1515 =head2 fast_wait_for(handle, string, string, ...)
1517 This function behaves very similar to wait_for (documented above), but instead
1518 of taking regular expressions as parameters, it takes strings. As soon as the
1519 input contains one of them, it will return the index of the matching string.
1520 If the input ends before any match, it returns -1.
1525 my ($inp, $maxlen, $ha, $i, $c, $inpl);
1526 for($i=1; $i<@_; $i++) {
1527 $maxlen = length($_[$i]) > $maxlen ? length($_[$i]) : $maxlen;
1531 if (($c = getc($ha)) eq "") {
1532 &error("fast_wait_for read error : $!");
1535 if (length($inp) > $maxlen) {
1536 $inp = substr($inp, length($inp)-$maxlen);
1538 $inpl = length($inp);
1539 for($i=1; $i<@_; $i++) {
1540 if ($_[$i] eq substr($inp, $inpl-length($_[$i]))) {
1547 =head2 has_command(command)
1549 Returns the full path to the executable if some command is in the path, or
1550 undef if not found. If the given command is already an absolute path and
1551 exists, then the same path will be returned.
1556 if (!$_[0]) { return undef; }
1557 if (exists($main::has_command_cache{$_[0]})) {
1558 return $main::has_command_cache{$_[0]};
1561 my $slash = $gconfig{'os_type'} eq 'windows' ? '\\' : '/';
1562 if ($_[0] =~ /^\// || $_[0] =~ /^[a-z]:[\\\/]/i) {
1563 # Absolute path given - just use it
1564 my $t = &translate_filename($_[0]);
1565 $rv = (-x $t && !-d _) ? $_[0] : undef;
1568 # Check each directory in the path
1570 foreach my $d (split($path_separator, $ENV{'PATH'})) {
1571 next if ($donedir{$d}++);
1572 $d =~ s/$slash$// if ($d ne $slash);
1573 my $t = &translate_filename("$d/$_[0]");
1574 if (-x $t && !-d _) {
1575 $rv = $d.$slash.$_[0];
1578 if ($gconfig{'os_type'} eq 'windows') {
1579 foreach my $sfx (".exe", ".com", ".bat") {
1580 my $t = &translate_filename("$d/$_[0]").$sfx;
1581 if (-r $t && !-d _) {
1582 $rv = $d.$slash.$_[0].$sfx;
1589 $main::has_command_cache{$_[0]} = $rv;
1593 =head2 make_date(seconds, [date-only], [fmt])
1595 Converts a Unix date/time in seconds to a human-readable form, by default
1596 formatted like dd/mmm/yyyy hh:mm:ss. Parameters are :
1598 =item seconds - Unix time is seconds to convert.
1600 =item date-only - If set to 1, exclude the time from the returned string.
1602 =item fmt - Optional, one of dd/mon/yyyy, dd/mm/yyyy, mm/dd/yyyy or yyyy/mm/dd
1607 my ($secs, $only, $fmt) = @_;
1608 my @tm = localtime($secs);
1611 $fmt = $gconfig{'dateformat'} || 'dd/mon/yyyy';
1613 if ($fmt eq 'dd/mon/yyyy') {
1614 $date = sprintf "%2.2d/%s/%4.4d",
1615 $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900;
1617 elsif ($fmt eq 'dd/mm/yyyy') {
1618 $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[3], $tm[4]+1, $tm[5]+1900;
1620 elsif ($fmt eq 'mm/dd/yyyy') {
1621 $date = sprintf "%2.2d/%2.2d/%4.4d", $tm[4]+1, $tm[3], $tm[5]+1900;
1623 elsif ($fmt eq 'yyyy/mm/dd') {
1624 $date = sprintf "%4.4d/%2.2d/%2.2d", $tm[5]+1900, $tm[4]+1, $tm[3];
1626 elsif ($fmt eq 'd. mon yyyy') {
1627 $date = sprintf "%d. %s %4.4d",
1628 $tm[3], $text{"smonth_".($tm[4]+1)}, $tm[5]+1900;
1630 elsif ($fmt eq 'dd.mm.yyyy') {
1631 $date = sprintf "%2.2d.%2.2d.%4.4d", $tm[3], $tm[4]+1, $tm[5]+1900;
1633 elsif ($fmt eq 'yyyy-mm-dd') {
1634 $date = sprintf "%4.4d-%2.2d-%2.2d", $tm[5]+1900, $tm[4]+1, $tm[3];
1637 $date .= sprintf " %2.2d:%2.2d", $tm[2], $tm[1];
1642 =head2 file_chooser_button(input, type, [form], [chroot], [addmode])
1644 Return HTML for a button that pops up a file chooser when clicked, and places
1645 the selected filename into another HTML field. The parameters are :
1647 =item input - Name of the form field to store the filename in.
1649 =item type - 0 for file or directory chooser, or 1 for directory only.
1651 =item form - Index of the form containing the button.
1653 =item chroot - If set to 1, the chooser will be limited to this directory.
1655 =item addmode - If set to 1, the selected filename will be appended to the text box instead of replacing it's contents.
1658 sub file_chooser_button
1660 return &theme_file_chooser_button(@_)
1661 if (defined(&theme_file_chooser_button));
1662 my $form = defined($_[2]) ? $_[2] : 0;
1663 my $chroot = defined($_[3]) ? $_[3] : "/";
1664 my $add = int($_[4]);
1665 my ($w, $h) = (400, 300);
1666 if ($gconfig{'db_sizefile'}) {
1667 ($w, $h) = split(/x/, $gconfig{'db_sizefile'});
1669 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";
1672 =head2 popup_window_button(url, width, height, scrollbars?, &field-mappings)
1674 Returns HTML for a button that will popup a chooser window of some kind. The
1677 =item url - Base URL of the popup window's contents
1679 =item width - Width of the window in pixels
1681 =item height - Height in pixels
1683 =item scrollbars - Set to 1 if the window should have scrollbars
1685 The field-mappings parameter is an array ref of array refs containing
1687 =item - Attribute to assign field to in the popup window
1689 =item - Form field name
1691 =item - CGI parameter to URL for value, if any
1694 sub popup_window_button
1696 return &theme_popup_window_button(@_) if (defined(&theme_popup_window_button));
1697 my ($url, $w, $h, $scroll, $fields) = @_;
1698 my $scrollyn = $scroll ? "yes" : "no";
1699 my $rv = "<input type=button onClick='";
1700 foreach my $m (@$fields) {
1701 $rv .= "$m->[0] = form.$m->[1]; ";
1703 my $sep = $url =~ /\?/ ? "&" : "?";
1704 $rv .= "chooser = window.open(\"$url\"";
1705 foreach my $m (@$fields) {
1707 $rv .= "+\"$sep$m->[2]=\"+escape($m->[0].value)";
1711 $rv .= ", \"chooser\", \"toolbar=no,menubar=no,scrollbars=$scrollyn,resizable=yes,width=$w,height=$h\"); ";
1712 foreach my $m (@$fields) {
1713 $rv .= "chooser.$m->[0] = $m->[0]; ";
1714 $rv .= "window.$m->[0] = $m->[0]; ";
1716 $rv .= "' value=\"...\">";
1720 =head2 read_acl(&user-module-hash, &user-list-hash, [&only-users])
1722 Reads the Webmin acl file into the given hash references. The first is indexed
1723 by a combined key of username,module , with the value being set to 1 when
1724 the user has access to that module. The second is indexed by username, with
1725 the value being an array ref of allowed modules.
1727 This function is deprecated in favour of foreign_available, which performs a
1728 more comprehensive check of module availability.
1730 If the only-users array ref parameter is given, the results may be limited to
1731 users in that list of names.
1736 my ($usermod, $userlist, $only) = @_;
1737 if (!%main::acl_hash_cache) {
1738 # Read from local files
1740 open(ACL, &acl_filename());
1742 if (/^([^:]+):\s*(.*)/) {
1744 my @mods = split(/\s+/, $2);
1745 foreach my $m (@mods) {
1746 $main::acl_hash_cache{$user,$m}++;
1748 $main::acl_array_cache{$user} = \@mods;
1753 %$usermod = %main::acl_hash_cache if ($usermod);
1754 %$userlist = %main::acl_array_cache if ($userlist);
1757 my $userdb = &get_userdb_string();
1758 my ($dbh, $proto, $prefix, $args) =
1759 $userdb ? &connect_userdb($userdb) : ( );
1761 if ($proto eq "mysql" || $proto eq "postgresql") {
1762 # Select usernames and modules from SQL DB
1763 my $cmd = $dbh->prepare(
1764 "select webmin_user.name,webmin_user_attr.value ".
1765 "from webmin_user,webmin_user_attr ".
1766 "where webmin_user.id = webmin_user_attr.id ".
1767 "and webmin_user_attr.attr = 'modules' ".
1768 ($only ? " and webmin_user.name in (".
1769 join(",", map { "'$_'" } @$only).")" : ""));
1770 if ($cmd && $cmd->execute()) {
1771 while(my ($user, $mods) = $cmd->fetchrow()) {
1772 my @mods = split(/\s+/, $mods);
1773 foreach my $m (@mods) {
1774 $usermod->{$user,$m}++ if ($usermod);
1776 $userlist->{$user} = \@mods if ($userlist);
1779 $cmd->finish() if ($cmd);
1781 elsif ($proto eq "ldap") {
1782 # Find users in LDAP
1783 my $filter = '(objectClass='.$args->{'userclass'}.')';
1786 "(|".join("", map { "(cn=$_)" } @$only).")";
1787 $filter = "(&".$filter.$ufilter.")";
1789 my $rv = $dbh->search(
1793 attrs => [ 'cn', 'webminModule' ]);
1794 if ($rv && !$rv->code) {
1795 foreach my $u ($rv->all_entries) {
1796 my $user = $u->get_value('cn');
1797 my @mods =$u->get_value('webminModule');
1798 foreach my $m (@mods) {
1799 $usermod->{$user,$m}++ if ($usermod);
1801 $userlist->{$user} = \@mods if ($userlist);
1805 &disconnect_userdb($userdb, $dbh);
1811 Returns the file containing the webmin ACL, which is usually
1812 /etc/webmin/webmin.acl.
1817 return "$config_directory/webmin.acl";
1822 Does nothing, but kept around for compatability.
1829 =head2 get_miniserv_config(&hash)
1831 Reads the Webmin webserver's (miniserv.pl) configuration file, usually located
1832 at /etc/webmin/miniserv.conf, and stores its names and values in the given
1836 sub get_miniserv_config
1838 return &read_file_cached(
1839 $ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf", $_[0]);
1842 =head2 put_miniserv_config(&hash)
1844 Writes out the Webmin webserver configuration file from the contents of
1845 the given hash ref. This should be initially populated by get_miniserv_config,
1848 get_miniserv_config(\%miniserv);
1849 $miniserv{'port'} = 10005;
1850 put_miniserv_config(\%miniserv);
1854 sub put_miniserv_config
1856 &write_file($ENV{'MINISERV_CONFIG'} || "$config_directory/miniserv.conf",
1860 =head2 restart_miniserv([nowait])
1862 Kill the old miniserv process and re-start it, then optionally waits for
1863 it to restart. This will apply all configuration settings.
1866 sub restart_miniserv
1869 return undef if (&is_readonly_mode());
1871 &get_miniserv_config(\%miniserv) || return;
1872 if ($main::webmin_script_type eq 'web' && !$ENV{"MINISERV_CONFIG"} &&
1873 !$ENV{'MINISERV_PID'}) {
1874 # Running under some web server other than miniserv, so do nothing
1879 if ($gconfig{'os_type'} ne 'windows') {
1880 # On Unix systems, we can restart with a signal
1881 my ($pid, $addr, $i);
1882 $miniserv{'inetd'} && return;
1883 my @oldst = stat($miniserv{'pidfile'});
1884 $pid = $ENV{'MINISERV_PID'};
1886 if (!open(PID, $miniserv{'pidfile'})) {
1887 print STDERR "PID file $miniserv{'pidfile'} does ",
1894 print STDERR "Invalid PID file $miniserv{'pidfile'}\n";
1897 if (!kill(0, $pid)) {
1898 print STDERR "PID $pid from file $miniserv{'pidfile'} ",
1904 # Just signal miniserv to restart
1905 &kill_logged('HUP', $pid) || &error("Incorrect Webmin PID $pid");
1907 # Wait till new PID is written, indicating a restart
1908 for($i=0; $i<60; $i++) {
1910 my @newst = stat($miniserv{'pidfile'});
1911 last if ($newst[9] != $oldst[9]);
1913 $i < 60 || &error("Webmin server did not write new PID file");
1915 ## Totally kill the process and re-run it
1916 #$SIG{'TERM'} = 'IGNORE';
1917 #&kill_logged('TERM', $pid);
1918 #&system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1921 # On Windows, we need to use the flag file
1922 open(TOUCH, ">$miniserv{'restartflag'}");
1927 # Wait for miniserv to come back up
1928 my $addr = $miniserv{'bind'} || "127.0.0.1";
1930 for($i=0; $i<20; $i++) {
1933 &open_socket($addr, $miniserv{'port'}, STEST, \$err);
1935 last if (!$err && ++$ok >= 2);
1937 $i < 20 || &error("Failed to restart Webmin server!");
1941 =head2 reload_miniserv
1943 Sends a USR1 signal to the miniserv process, telling it to read-read it's
1944 configuration files. Not all changes will be applied though, such as the
1945 IP addresses and ports to accept connections on.
1950 return undef if (&is_readonly_mode());
1952 &get_miniserv_config(\%miniserv) || return;
1953 if ($main::webmin_script_type eq 'web' && !$ENV{"MINISERV_CONFIG"} &&
1954 !$ENV{'MINISERV_PID'}) {
1955 # Running under some web server other than miniserv, so do nothing
1959 if ($gconfig{'os_type'} ne 'windows') {
1960 # Send a USR1 signal to re-read the config
1961 my ($pid, $addr, $i);
1962 $miniserv{'inetd'} && return;
1963 $pid = $ENV{'MINISERV_PID'};
1965 if (!open(PID, $miniserv{'pidfile'})) {
1966 print STDERR "PID file $miniserv{'pidfile'} does ",
1973 print STDERR "Invalid PID file $miniserv{'pidfile'}\n";
1976 if (!kill(0, $pid)) {
1977 print STDERR "PID $pid from file $miniserv{'pidfile'} ",
1982 &kill_logged('USR1', $pid) || &error("Incorrect Webmin PID $pid");
1984 # Make sure this didn't kill Webmin!
1986 if (!kill(0, $pid)) {
1987 print STDERR "USR1 signal killed Webmin - restarting\n";
1988 &system_logged("$config_directory/start >/dev/null 2>&1 </dev/null");
1992 # On Windows, we need to use the flag file
1993 open(TOUCH, ">$miniserv{'reloadflag'}");
1998 =head2 check_os_support(&minfo, [os-type, os-version], [api-only])
2000 Returns 1 if some module is supported on the current operating system, or the
2001 OS supplies as parameters. The parameters are :
2003 =item minfo - A hash ref of module information, as returned by get_module_info
2005 =item os-type - The Webmin OS code to use instead of the system's real OS, such as redhat-linux
2007 =item os-version - The Webmin OS version to use, such as 13.0
2009 =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.
2012 sub check_os_support
2014 my $oss = $_[0]->{'os_support'};
2015 if ($_[3] && $oss && $_[0]->{'api_os_support'}) {
2016 # May provide usable API
2017 $oss .= " ".$_[0]->{'api_os_support'};
2019 if ($_[0]->{'nozone'} && &running_in_zone()) {
2020 # Not supported in a Solaris Zone
2023 if ($_[0]->{'novserver'} && &running_in_vserver()) {
2024 # Not supported in a Linux Vserver
2027 if ($_[0]->{'noopenvz'} && &running_in_openvz()) {
2028 # Not supported in an OpenVZ container
2031 return 1 if (!$oss || $oss eq '*');
2032 my $osver = $_[2] || $gconfig{'os_version'};
2033 my $ostype = $_[1] || $gconfig{'os_type'};
2036 my ($os, $ver, $codes);
2037 my ($neg) = ($oss =~ s/^!//); # starts with !
2038 $anyneg++ if ($neg);
2039 if ($oss =~ /^([^\/\s]+)\/([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
2041 $os = $1; $ver = $2; $codes = $3; $oss = $4;
2043 elsif ($oss =~ /^([^\/\s]+)\/([^\/\s]+)\s*(.*)$/) {
2045 $os = $1; $ver = $2; $oss = $3;
2047 elsif ($oss =~ /^([^\{\s]+)\{([^\}]*)\}\s*(.*)$/) {
2049 $os = $1; $codes = $2; $oss = $3;
2051 elsif ($oss =~ /^\{([^\}]*)\}\s*(.*)$/) {
2053 $codes = $1; $oss = $2;
2055 elsif ($oss =~ /^(\S+)\s*(.*)$/) {
2057 $os = $1; $oss = $2;
2060 next if ($os && !($os eq $ostype ||
2061 $ostype =~ /^(\S+)-(\S+)$/ && $os eq "*-$2"));
2062 if ($ver =~ /^([0-9\.]+)\-([0-9\.]+)$/) {
2063 next if ($osver < $1 || $osver > $2);
2065 elsif ($ver =~ /^([0-9\.]+)\-\*$/) {
2066 next if ($osver < $1);
2068 elsif ($ver =~ /^\*\-([0-9\.]+)$/) {
2069 next if ($osver > $1);
2072 next if ($ver ne $osver);
2074 next if ($codes && !eval $codes);
2080 =head2 http_download(host, port, page, destfile, [&error], [&callback], [sslmode], [user, pass], [timeout], [osdn-convert], [no-cache], [&headers])
2082 Downloads data from a HTTP url to a local file or string. The parameters are :
2084 =item host - The hostname part of the URL, such as www.google.com
2086 =item port - The HTTP port number, such as 80
2088 =item page - The filename part of the URL, like /index.html
2090 =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.
2092 =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.
2094 =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.
2096 =item sslmode - If set to 1, an HTTPS connection is used instead of HTTP.
2098 =item user - If set, HTTP authentication is done with this username.
2100 =item pass - The HTTP password to use with the username above.
2102 =item timeout - A timeout in seconds to wait for the TCP connection to be established before failing.
2104 =item osdn-convert - If set to 1, URL for downloads from sourceforge are converted to use an appropriate mirror site.
2106 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
2108 =item headers - If set to a hash ref of additional HTTP headers, they will be added to the request.
2113 my ($host, $port, $page, $dest, $error, $cbfunc, $ssl, $user, $pass,
2114 $timeout, $osdn, $nocache, $headers) = @_;
2115 if ($gconfig{'debug_what_net'}) {
2116 &webmin_debug_log('HTTP', "host=$host port=$port page=$page ssl=$ssl".
2117 ($user ? " user=$user pass=$pass" : "").
2118 (ref($dest) ? "" : " dest=$dest"));
2121 # Convert OSDN URL first
2122 my $prot = $ssl ? "https://" : "http://";
2123 my $portstr = $ssl && $port == 443 ||
2124 !$ssl && $port == 80 ? "" : ":$port";
2125 ($host, $port, $page, $ssl) = &parse_http_url(
2126 &convert_osdn_url($prot.$host.$portstr.$page));
2129 # Check if we already have cached the URL
2130 my $url = ($ssl ? "https://" : "http://").$host.":".$port.$page;
2131 my $cfile = &check_in_http_cache($url);
2132 if ($cfile && !$nocache) {
2133 # Yes! Copy to dest file or variable
2134 &$cbfunc(6, $url) if ($cbfunc);
2136 &open_readfile(CACHEFILE, $cfile);
2138 $$dest = <CACHEFILE>;
2142 ©_source_dest($cfile, $dest);
2149 push(@headers, [ "Host", $host ]);
2150 push(@headers, [ "User-agent", "Webmin" ]);
2151 push(@headers, [ "Accept-language", "en" ]);
2153 my $auth = &encode_base64("$user:$pass");
2154 $auth =~ tr/\r\n//d;
2155 push(@headers, [ "Authorization", "Basic $auth" ]);
2157 foreach my $hname (keys %$headers) {
2158 push(@headers, [ $hname, $headers->{$hname} ]);
2161 # Actually download it
2162 $main::download_timed_out = undef;
2163 local $SIG{ALRM} = \&download_timeout;
2164 alarm($timeout || 60);
2165 my $h = &make_http_connection($host, $port, $ssl, "GET", $page, \@headers);
2167 $h = $main::download_timed_out if ($main::download_timed_out);
2169 if ($error) { $$error = $h; return; }
2170 else { &error($h); }
2172 &complete_http_download($h, $dest, $error, $cbfunc, $osdn, $host, $port,
2173 $headers, $ssl, $nocache);
2174 if ((!$error || !$$error) && !$nocache) {
2175 &write_to_http_cache($url, $dest);
2179 =head2 complete_http_download(handle, destfile, [&error], [&callback], [osdn], [oldhost], [oldport], [&send-headers], [old-ssl], [no-cache])
2181 Do a HTTP download, after the headers have been sent. For internal use only,
2182 typically called by http_download.
2185 sub complete_http_download
2187 local ($line, %header, @headers, $s); # Kept local so that callback funcs
2193 ($line = &read_http_connection($_[0])) =~ tr/\r\n//d;
2194 if ($line !~ /^HTTP\/1\..\s+(200|30[0-9])(\s+|$)/) {
2196 if ($_[2]) { ${$_[2]} = $line; return; }
2197 else { &error("Download failed : $line"); }
2200 &$cbfunc(1, $rcode >= 300 && $rcode < 400 ? 1 : 0)
2203 $line = &read_http_connection($_[0]);
2204 $line =~ tr/\r\n//d;
2205 $line =~ /^(\S+):\s+(.*)$/ || last;
2206 $header{lc($1)} = $2;
2207 push(@headers, [ lc($1), $2 ]);
2210 if ($main::download_timed_out) {
2211 if ($_[2]) { ${$_[2]} = $main::download_timed_out; return 0; }
2212 else { &error($main::download_timed_out); }
2214 &$cbfunc(2, $header{'content-length'}) if ($cbfunc);
2215 if ($rcode >= 300 && $rcode < 400) {
2216 # follow the redirect
2217 &$cbfunc(5, $header{'location'}) if ($cbfunc);
2218 my ($host, $port, $page, $ssl);
2219 if ($header{'location'} =~ /^(http|https):\/\/([^:]+):(\d+)(\/.*)?$/) {
2220 $ssl = $1 eq 'https' ? 1 : 0;
2225 elsif ($header{'location'} =~ /^(http|https):\/\/([^:\/]+)(\/.*)?$/) {
2226 $ssl = $1 eq 'https' ? 1 : 0;
2228 $port = $ssl ? 443 : 80;
2231 elsif ($header{'location'} =~ /^\// && $_[5]) {
2232 # Relative to same server
2236 $page = $header{'location'};
2238 elsif ($header{'location'}) {
2239 # Assume relative to same dir .. not handled
2240 if ($_[2]) { ${$_[2]} = "Invalid Location header $header{'location'}"; return; }
2241 else { &error("Invalid Location header $header{'location'}"); }
2244 if ($_[2]) { ${$_[2]} = "Missing Location header"; return; }
2245 else { &error("Missing Location header"); }
2248 ($page, $params) = split(/\?/, $page);
2250 $page .= "?".$params if (defined($params));
2251 &http_download($host, $port, $page, $_[1], $_[2], $cbfunc, $ssl,
2252 undef, undef, undef, $_[4], $_[9], $_[7]);
2257 # Append to a variable
2258 while(defined($buf = &read_http_connection($_[0], 1024))) {
2260 &$cbfunc(3, length(${$_[1]})) if ($cbfunc);
2266 if (!&open_tempfile(PFILE, ">$_[1]", 1)) {
2267 if ($_[2]) { ${$_[2]} = "Failed to write to $_[1] : $!"; return; }
2268 else { &error("Failed to write to $_[1] : $!"); }
2270 binmode(PFILE); # For windows
2271 while(defined($buf = &read_http_connection($_[0], 1024))) {
2272 &print_tempfile(PFILE, $buf);
2273 $got += length($buf);
2274 &$cbfunc(3, $got) if ($cbfunc);
2276 &close_tempfile(PFILE);
2277 if ($header{'content-length'} &&
2278 $got != $header{'content-length'}) {
2279 if ($_[2]) { ${$_[2]} = "Download incomplete"; return; }
2280 else { &error("Download incomplete"); }
2283 &$cbfunc(4) if ($cbfunc);
2285 &close_http_connection($_[0]);
2289 =head2 http_post(host, port, page, content, destfile, [&error], [&callback], [sslmode], [user, pass], [timeout], [osdn-convert], [no-cache], [&headers])
2291 Posts data to an HTTP url and downloads the response to a local file or string. The parameters are :
2293 =item host - The hostname part of the URL, such as www.google.com
2295 =item port - The HTTP port number, such as 80
2297 =item page - The filename part of the URL, like /index.html
2299 =item content - The data to post
2301 =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.
2303 =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.
2305 =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.
2307 =item sslmode - If set to 1, an HTTPS connection is used instead of HTTP.
2309 =item user - If set, HTTP authentication is done with this username.
2311 =item pass - The HTTP password to use with the username above.
2313 =item timeout - A timeout in seconds to wait for the TCP connection to be established before failing.
2315 =item osdn-convert - If set to 1, URL for downloads from sourceforge are converted to use an appropriate mirror site.
2317 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
2319 =item headers - If set to a hash ref of additional HTTP headers, they will be added to the request.
2324 my ($host, $port, $page, $content, $dest, $error, $cbfunc, $ssl, $user, $pass,
2325 $timeout, $osdn, $nocache, $headers) = @_;
2326 if ($gconfig{'debug_what_net'}) {
2327 &webmin_debug_log('HTTP', "host=$host port=$port page=$page ssl=$ssl".
2328 ($user ? " user=$user pass=$pass" : "").
2329 (ref($dest) ? "" : " dest=$dest"));
2332 # Convert OSDN URL first
2333 my $prot = $ssl ? "https://" : "http://";
2334 my $portstr = $ssl && $port == 443 ||
2335 !$ssl && $port == 80 ? "" : ":$port";
2336 ($host, $port, $page, $ssl) = &parse_http_url(
2337 &convert_osdn_url($prot.$host.$portstr.$page));
2342 push(@headers, [ "Host", $host ]);
2343 push(@headers, [ "User-agent", "Webmin" ]);
2344 push(@headers, [ "Accept-language", "en" ]);
2345 push(@headers, [ "Content-type", "application/x-www-form-urlencoded" ]);
2346 push(@headers, [ "Content-length", length($content) ]);
2348 my $auth = &encode_base64("$user:$pass");
2349 $auth =~ tr/\r\n//d;
2350 push(@headers, [ "Authorization", "Basic $auth" ]);
2352 foreach my $hname (keys %$headers) {
2353 push(@headers, [ $hname, $headers->{$hname} ]);
2356 # Actually download it
2357 $main::download_timed_out = undef;
2358 local $SIG{ALRM} = \&download_timeout;
2359 alarm($timeout || 60);
2360 my $h = &make_http_connection($host, $port, $ssl, "POST", $page, \@headers);
2362 $h = $main::download_timed_out if ($main::download_timed_out);
2364 if ($error) { $$error = $h; return; }
2365 else { &error($h); }
2367 &write_http_connection($content."\r\n");
2368 &complete_http_download($h, $dest, $error, $cbfunc, $osdn, $host, $port,
2369 $headers, $ssl, $nocache);
2370 if ((!$error || !$$error) && !$nocache) {
2371 &write_to_http_cache($url, $dest);
2375 =head2 ftp_download(host, file, destfile, [&error], [&callback], [user, pass], [port], [no-cache])
2377 Download data from an FTP site to a local file. The parameters are :
2379 =item host - FTP server hostname
2381 =item file - File on the FTP server to download
2383 =item destfile - File on the Webmin system to download data to
2385 =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.
2387 =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.
2389 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2391 =item pass - Password for the username above.
2393 =item port - FTP server port number, which defaults to 21 if not set.
2395 =item no-cache - If set to 1, Webmin's internal caching for this URL is disabled.
2400 my ($host, $file, $dest, $error, $cbfunc, $user, $pass, $port, $nocache) = @_;
2402 if ($gconfig{'debug_what_net'}) {
2403 &webmin_debug_log('FTP', "host=$host port=$port file=$file".
2404 ($user ? " user=$user pass=$pass" : "").
2405 (ref($dest) ? "" : " dest=$dest"));
2409 if (&is_readonly_mode()) {
2410 if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2412 else { &error("FTP connections not allowed in readonly mode"); }
2415 # Check if we already have cached the URL
2416 my $url = "ftp://".$host.$file;
2417 my $cfile = &check_in_http_cache($url);
2418 if ($cfile && !$nocache) {
2419 # Yes! Copy to dest file or variable
2420 &$cbfunc(6, $url) if ($cbfunc);
2422 &open_readfile(CACHEFILE, $cfile);
2424 $$dest = <CACHEFILE>;
2428 ©_source_dest($cfile, $dest);
2433 # Actually download it
2434 $main::download_timed_out = undef;
2435 local $SIG{ALRM} = \&download_timeout;
2438 if ($gconfig{'ftp_proxy'} =~ /^http:\/\/(\S+):(\d+)/ && !&no_proxy($_[0])) {
2439 # download through http-style proxy
2441 if (&open_socket($1, $2, "SOCK", \$error)) {
2443 if ($main::download_timed_out) {
2445 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2446 else { &error($main::download_timed_out); }
2448 my $esc = $_[1]; $esc =~ s/ /%20/g;
2449 my $up = "$_[5]:$_[6]\@" if ($_[5]);
2450 my $portstr = $port == 21 ? "" : ":$port";
2451 print SOCK "GET ftp://$up$_[0]$portstr$esc HTTP/1.0\r\n";
2452 print SOCK "User-agent: Webmin\r\n";
2453 if ($gconfig{'proxy_user'}) {
2454 my $auth = &encode_base64(
2455 "$gconfig{'proxy_user'}:$gconfig{'proxy_pass'}");
2456 $auth =~ tr/\r\n//d;
2457 print SOCK "Proxy-Authorization: Basic $auth\r\n";
2460 &complete_http_download({ 'fh' => "SOCK" }, $_[2], $_[3], $_[4],
2461 undef, undef, undef, undef, 0, $nocache);
2464 elsif (!$gconfig{'proxy_fallback'}) {
2466 if ($error) { $$error = $main::download_timed_out; return 0; }
2467 else { &error($main::download_timed_out); }
2472 # connect to host and login with real FTP protocol
2473 &open_socket($_[0], $port, "SOCK", $_[3]) || return 0;
2475 if ($main::download_timed_out) {
2476 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2477 else { &error($main::download_timed_out); }
2479 &ftp_command("", 2, $_[3]) || return 0;
2481 # Login as supplied user
2482 my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2484 if (int($urv[1]/100) == 3) {
2485 &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2489 # Login as anonymous
2490 my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2492 if (int($urv[1]/100) == 3) {
2493 &ftp_command("PASS root\@".&get_system_hostname(), 2,
2497 &$cbfunc(1, 0) if ($cbfunc);
2500 # get the file size and tell the callback
2501 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2502 my $size = &ftp_command("SIZE $_[1]", 2, $_[3]);
2503 defined($size) || return 0;
2505 &$cbfunc(2, int($size));
2509 my $pasv = &ftp_command("PASV", 2, $_[3]);
2510 defined($pasv) || return 0;
2511 $pasv =~ /\(([0-9,]+)\)/;
2512 @n = split(/,/ , $1);
2513 &open_socket("$n[0].$n[1].$n[2].$n[3]",
2514 $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2515 &ftp_command("RETR $_[1]", 1, $_[3]) || return 0;
2519 &open_tempfile(PFILE, ">$_[2]", 1);
2520 while(read(CON, $buf, 1024) > 0) {
2521 &print_tempfile(PFILE, $buf);
2522 $got += length($buf);
2523 &$cbfunc(3, $got) if ($cbfunc);
2525 &close_tempfile(PFILE);
2527 if ($got != $size) {
2528 if ($_[3]) { ${$_[3]} = "Download incomplete"; return 0; }
2529 else { &error("Download incomplete"); }
2531 &$cbfunc(4) if ($cbfunc);
2533 &ftp_command("", 2, $_[3]) || return 0;
2537 &ftp_command("QUIT", 2, $_[3]) || return 0;
2541 &write_to_http_cache($url, $dest);
2545 =head2 ftp_upload(host, file, srcfile, [&error], [&callback], [user, pass], [port])
2547 Upload data from a local file to an FTP site. The parameters are :
2549 =item host - FTP server hostname
2551 =item file - File on the FTP server to write to
2553 =item srcfile - File on the Webmin system to upload data from
2555 =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.
2557 =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.
2559 =item user - Username to login to the FTP server as. If missing, Webmin will login as anonymous.
2561 =item pass - Password for the username above.
2563 =item port - FTP server port number, which defaults to 21 if not set.
2570 if (&is_readonly_mode()) {
2571 if ($_[3]) { ${$_[3]} = "FTP connections not allowed in readonly mode";
2573 else { &error("FTP connections not allowed in readonly mode"); }
2576 $main::download_timed_out = undef;
2577 local $SIG{ALRM} = \&download_timeout;
2580 # connect to host and login
2581 &open_socket($_[0], $_[7] || 21, "SOCK", $_[3]) || return 0;
2583 if ($main::download_timed_out) {
2584 if ($_[3]) { ${$_[3]} = $main::download_timed_out; return 0; }
2585 else { &error($main::download_timed_out); }
2587 &ftp_command("", 2, $_[3]) || return 0;
2589 # Login as supplied user
2590 my @urv = &ftp_command("USER $_[5]", [ 2, 3 ], $_[3]);
2592 if (int($urv[1]/100) == 3) {
2593 &ftp_command("PASS $_[6]", 2, $_[3]) || return 0;
2597 # Login as anonymous
2598 my @urv = &ftp_command("USER anonymous", [ 2, 3 ], $_[3]);
2600 if (int($urv[1]/100) == 3) {
2601 &ftp_command("PASS root\@".&get_system_hostname(), 2,
2605 &$cbfunc(1, 0) if ($cbfunc);
2607 &ftp_command("TYPE I", 2, $_[3]) || return 0;
2609 # get the file size and tell the callback
2610 my @st = stat($_[2]);
2612 &$cbfunc(2, $st[7]);
2616 my $pasv = &ftp_command("PASV", 2, $_[3]);
2617 defined($pasv) || return 0;
2618 $pasv =~ /\(([0-9,]+)\)/;
2619 @n = split(/,/ , $1);
2620 &open_socket("$n[0].$n[1].$n[2].$n[3]", $n[4]*256 + $n[5], "CON", $_[3]) || return 0;
2621 &ftp_command("STOR $_[1]", 1, $_[3]) || return 0;
2626 while(read(PFILE, $buf, 1024) > 0) {
2628 $got += length($buf);
2629 &$cbfunc(3, $got) if ($cbfunc);
2633 if ($got != $st[7]) {
2634 if ($_[3]) { ${$_[3]} = "Upload incomplete"; return 0; }
2635 else { &error("Upload incomplete"); }
2637 &$cbfunc(4) if ($cbfunc);
2640 &ftp_command("", 2, $_[3]) || return 0;
2641 &ftp_command("QUIT", 2, $_[3]) || return 0;
2647 =head2 no_proxy(host)
2649 Checks if some host is on the no proxy list. For internal use by the
2650 http_download and ftp_download functions.
2655 my $ip = &to_ipaddress($_[0]);
2656 foreach my $n (split(/\s+/, $gconfig{'noproxy'})) {
2657 return 1 if ($_[0] =~ /\Q$n\E/ ||
2663 =head2 open_socket(host, port, handle, [&error])
2665 Open a TCP connection to some host and port, using a file handle. The
2668 =item host - Hostname or IP address to connect to.
2670 =item port - TCP port number.
2672 =item handle - A file handle name to use for the connection.
2674 =item error - A string reference to write any error message into. If not set, the error function is called on failure.
2679 my ($host, $port, $fh, $err) = @_;
2680 $fh = &callers_package($fh);
2682 if ($gconfig{'debug_what_net'}) {
2683 &webmin_debug_log('TCP', "host=$host port=$port");
2686 # Lookup IP address for the host. Try v4 first, and failing that v6
2688 my $proto = getprotobyname("tcp");
2689 if ($ip = &to_ipaddress($host)) {
2690 # Create IPv4 socket and connection
2691 if (!socket($fh, PF_INET(), SOCK_STREAM, $proto)) {
2692 my $msg = "Failed to create socket : $!";
2693 if ($err) { $$err = $msg; return 0; }
2694 else { &error($msg); }
2696 my $addr = inet_aton($ip);
2697 if ($gconfig{'bind_proxy'}) {
2698 # BIND to outgoing IP
2699 if (!bind($fh,pack_sockaddr_in(0, inet_aton($gconfig{'bind_proxy'})))) {
2700 my $msg = "Failed to bind to source address : $!";
2701 if ($err) { $$err = $msg; return 0; }
2702 else { &error($msg); }
2705 if (!connect($fh, pack_sockaddr_in($port, $addr))) {
2706 my $msg = "Failed to connect to $host:$port : $!";
2707 if ($err) { $$err = $msg; return 0; }
2708 else { &error($msg); }
2711 elsif ($ip = &to_ip6address($host)) {
2712 # Create IPv6 socket and connection
2713 if (!&supports_ipv6()) {
2714 $msg = "IPv6 connections are not supported";
2715 if ($err) { $$err = $msg; return 0; }
2716 else { &error($msg); }
2718 if (!socket($fh, Socket6::PF_INET6(), SOCK_STREAM, $proto)) {
2719 my $msg = "Failed to create IPv6 socket : $!";
2720 if ($err) { $$err = $msg; return 0; }
2721 else { &error($msg); }
2723 my $addr = inet_pton(Socket6::AF_INET6(), $ip);
2724 if (!connect($fh, pack_sockaddr_in6($port, $addr))) {
2725 my $msg = "Failed to IPv6 connect to $host:$port : $!";
2726 if ($err) { $$err = $msg; return 0; }
2727 else { &error($msg); }
2732 my $msg = "Failed to lookup IP address for $host";
2733 if ($err) { $$err = $msg; return 0; }
2734 else { &error($msg); }
2738 my $old = select($fh);
2744 =head2 download_timeout
2746 Called when a download times out. For internal use only.
2749 sub download_timeout
2751 $main::download_timed_out = "Download timed out";
2754 =head2 ftp_command(command, expected, [&error], [filehandle])
2756 Send an FTP command, and die if the reply is not what was expected. Mainly
2757 for internal use by the ftp_download and ftp_upload functions.
2762 my ($cmd, $expect, $err, $fh) = @_;
2764 $fh = &callers_package($fh);
2767 my $what = $cmd ne "" ? "<i>$cmd</i>" : "initial connection";
2769 print $fh "$cmd\r\n";
2772 if (!($line = <$fh>)) {
2774 if ($err) { $$err = "Failed to read reply to $what"; return undef; }
2775 else { &error("Failed to read reply to $what"); }
2777 $line =~ /^(...)(.)(.*)$/;
2780 foreach my $c (@$expect) {
2781 $found++ if (int($1/100) == $c);
2785 $found++ if (int($1/100) == $_[1]);
2789 if ($err) { $$err = "$what failed : $3"; return undef; }
2790 else { &error("$what failed : $3"); }
2795 # Need to skip extra stuff..
2797 if (!($line = <$fh>)) {
2799 if ($$err) { $$err = "Failed to read reply to $what";
2801 else { &error("Failed to read reply to $what"); }
2803 $line =~ /^(....)(.*)$/; $reply .= $2;
2804 if ($1 eq "$rcode ") { last; }
2808 return wantarray ? ($reply, $rcode) : $reply;
2811 =head2 to_ipaddress(hostname)
2813 Converts a hostname to an a.b.c.d format IP address, or returns undef if
2814 it cannot be resolved.
2819 if (&check_ipaddress($_[0])) {
2820 return $_[0]; # Already in v4 format
2822 elsif (&check_ip6address($_[0])) {
2823 return undef; # A v6 address cannot be converted to v4
2826 my $hn = gethostbyname($_[0]);
2827 return undef if (!$hn);
2828 local @ip = unpack("CCCC", $hn);
2829 return join("." , @ip);
2833 =head2 to_ip6address(hostname)
2835 Converts a hostname to IPv6 address, or returns undef if it cannot be resolved.
2840 if (&check_ip6address($_[0])) {
2841 return $_[0]; # Already in v6 format
2843 elsif (&check_ipaddress($_[0])) {
2844 return undef; # A v4 address cannot be v6
2846 elsif (!&supports_ipv6()) {
2847 return undef; # Cannot lookup
2850 # Perform IPv6 DNS lookup
2852 (undef, undef, undef, $inaddr) =
2853 getaddrinfo($_[0], undef, Socket6::AF_INET6(), SOCK_STREAM);
2854 return undef if (!$inaddr);
2856 (undef, $addr) = unpack_sockaddr_in6($inaddr);
2857 return inet_ntop(Socket6::AF_INET6(), $addr);
2861 =head2 to_hostname(ipv4|ipv6-address)
2863 Reverse-resolves an IPv4 or 6 address to a hostname
2869 if (&check_ip6address($addr) && &supports_ipv6()) {
2870 return gethostbyaddr(inet_pton(Socket6::AF_INET6(), $addr),
2871 Socket6::AF_INET6());
2874 return gethostbyaddr(inet_aton($addr), AF_INET);
2878 =head2 icons_table(&links, &titles, &icons, [columns], [href], [width], [height], &befores, &afters)
2880 Renders a 4-column table of icons. The useful parameters are :
2882 =item links - An array ref of link destination URLs for the icons.
2884 =item titles - An array ref of titles to appear under the icons.
2886 =item icons - An array ref of URLs for icon images.
2888 =item columns - Number of columns to layout the icons with. Defaults to 4.
2893 &load_theme_library();
2894 if (defined(&theme_icons_table)) {
2895 &theme_icons_table(@_);
2899 my $cols = $_[3] ? $_[3] : 4;
2900 my $per = int(100.0 / $cols);
2901 print "<table class='icons_table' width=100% cellpadding=5>\n";
2902 for(my $i=0; $i<@{$_[0]}; $i++) {
2903 if ($i%$cols == 0) { print "<tr>\n"; }
2904 print "<td width=$per% align=center valign=top>\n";
2905 &generate_icon($_[2]->[$i], $_[1]->[$i], $_[0]->[$i],
2906 ref($_[4]) ? $_[4]->[$i] : $_[4], $_[5], $_[6],
2907 $_[7]->[$i], $_[8]->[$i]);
2909 if ($i%$cols == $cols-1) { print "</tr>\n"; }
2911 while($i++%$cols) { print "<td width=$per%></td>\n"; $need_tr++; }
2912 print "</tr>\n" if ($need_tr);
2916 =head2 replace_file_line(file, line, [newline]*)
2918 Replaces one line in some file with 0 or more new lines. The parameters are :
2920 =item file - Full path to some file, like /etc/hosts.
2922 =item line - Line number to replace, starting from 0.
2924 =item newline - Zero or more lines to put into the file at the given line number. These must be newline-terminated strings.
2927 sub replace_file_line
2930 my $realfile = &translate_filename($_[0]);
2931 open(FILE, $realfile);
2934 if (@_ > 2) { splice(@lines, $_[1], 1, @_[2..$#_]); }
2935 else { splice(@lines, $_[1], 1); }
2936 &open_tempfile(FILE, ">$realfile");
2937 &print_tempfile(FILE, @lines);
2938 &close_tempfile(FILE);
2941 =head2 read_file_lines(file, [readonly])
2943 Returns a reference to an array containing the lines from some file. This
2944 array can be modified, and will be written out when flush_file_lines()
2945 is called. The parameters are :
2947 =item file - Full path to the file to read.
2949 =item readonly - Should be set 1 if the caller is only going to read the lines, and never write it out.
2953 $lref = read_file_lines("/etc/hosts");
2954 push(@$lref, "127.0.0.1 localhost");
2955 flush_file_lines("/etc/hosts");
2961 my ($package, $filename, $line) = caller;
2962 print STDERR "Missing file to read at ${package}::${filename} line $line\n";
2964 my $realfile = &translate_filename($_[0]);
2965 if (!$main::file_cache{$realfile}) {
2968 &webmin_debug_log('READ', $_[0]) if ($gconfig{'debug_what_read'});
2969 open(READFILE, $realfile);
2972 $eol = /\r\n$/ ? "\r\n" : "\n";
2978 $main::file_cache{$realfile} = \@lines;
2979 $main::file_cache_noflush{$realfile} = $_[1];
2980 $main::file_cache_eol{$realfile} = $eol || "\n";
2983 # Make read-write if currently readonly
2985 $main::file_cache_noflush{$realfile} = 0;
2988 return $main::file_cache{$realfile};
2991 =head2 flush_file_lines([file], [eol])
2993 Write out to a file previously read by read_file_lines to disk (except
2994 for those marked readonly). The parameters are :
2996 =item file - The file to flush out.
2998 =item eof - End-of-line character for each line. Defaults to \n.
3001 sub flush_file_lines
3005 local $trans = &translate_filename($_[0]);
3006 $main::file_cache{$trans} ||
3007 &error("flush_file_lines called on non-loaded file $trans");
3008 push(@files, $trans);
3011 @files = ( keys %main::file_cache );
3013 foreach my $f (@files) {
3014 my $eol = $_[1] || $main::file_cache_eol{$f} || "\n";
3015 if (!$main::file_cache_noflush{$f}) {
3016 no warnings; # XXX Bareword file handles should go away
3017 &open_tempfile(FLUSHFILE, ">$f");
3018 foreach my $line (@{$main::file_cache{$f}}) {
3019 (print FLUSHFILE $line,$eol) ||
3020 &error(&text("efilewrite", $f, $!));
3022 &close_tempfile(FLUSHFILE);
3024 delete($main::file_cache{$f});
3025 delete($main::file_cache_noflush{$f});
3029 =head2 unflush_file_lines(file)
3031 Clear the internal cache of some given file, previously read by read_file_lines.
3034 sub unflush_file_lines
3036 my $realfile = &translate_filename($_[0]);
3037 delete($main::file_cache{$realfile});
3038 delete($main::file_cache_noflush{$realfile});
3041 =head2 unix_user_input(fieldname, user, [form])
3043 Returns HTML for an input to select a Unix user. By default this is a text
3044 box with a user popup button next to it.
3049 if (defined(&theme_unix_user_input)) {
3050 return &theme_unix_user_input(@_);
3052 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
3053 &user_chooser_button($_[0], 0, $_[2] || 0)."\n";
3056 =head2 unix_group_input(fieldname, user, [form])
3058 Returns HTML for an input to select a Unix group. By default this is a text
3059 box with a group popup button next to it.
3062 sub unix_group_input
3064 if (defined(&theme_unix_group_input)) {
3065 return &theme_unix_group_input(@_);
3067 return "<input name=$_[0] size=13 value=\"$_[1]\"> ".
3068 &group_chooser_button($_[0], 0, $_[2] || 0)."\n";
3071 =head2 hlink(text, page, [module], [width], [height])
3073 Returns HTML for a link that when clicked on pops up a window for a Webmin
3074 help page. The parameters are :
3076 =item text - Text for the link.
3078 =item page - Help page code, such as 'intro'.
3080 =item module - Module the help page is in. Defaults to the current module.
3082 =item width - Width of the help popup window. Defaults to 600 pixels.
3084 =item height - Height of the help popup window. Defaults to 400 pixels.
3086 The actual help pages are in each module's help sub-directory, in files with
3092 if (defined(&theme_hlink)) {
3093 return &theme_hlink(@_);
3095 my $mod = $_[2] ? $_[2] : &get_module_name();
3096 my $width = $_[3] || $tconfig{'help_width'} || $gconfig{'help_width'} || 600;
3097 my $height = $_[4] || $tconfig{'help_height'} || $gconfig{'help_height'} || 400;
3098 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>";
3101 =head2 user_chooser_button(field, multiple, [form])
3103 Returns HTML for a javascript button for choosing a Unix user or users.
3104 The parameters are :
3106 =item field - Name of the HTML field to place the username into.
3108 =item multiple - Set to 1 if multiple users can be selected.
3110 =item form - Index of the form on the page.
3113 sub user_chooser_button
3115 return undef if (!&supports_users());
3116 return &theme_user_chooser_button(@_)
3117 if (defined(&theme_user_chooser_button));
3118 my $form = defined($_[2]) ? $_[2] : 0;
3119 my $w = $_[1] ? 500 : 300;
3121 if ($_[1] && $gconfig{'db_sizeusers'}) {
3122 ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
3124 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
3125 ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
3127 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";
3130 =head2 group_chooser_button(field, multiple, [form])
3132 Returns HTML for a javascript button for choosing a Unix group or groups
3133 The parameters are :
3135 =item field - Name of the HTML field to place the group name into.
3137 =item multiple - Set to 1 if multiple groups can be selected.
3139 =item form - Index of the form on the page.
3142 sub group_chooser_button
3144 return undef if (!&supports_users());
3145 return &theme_group_chooser_button(@_)
3146 if (defined(&theme_group_chooser_button));
3147 my $form = defined($_[2]) ? $_[2] : 0;
3148 my $w = $_[1] ? 500 : 300;
3150 if ($_[1] && $gconfig{'db_sizeusers'}) {
3151 ($w, $h) = split(/x/, $gconfig{'db_sizeusers'});
3153 elsif (!$_[1] && $gconfig{'db_sizeuser'}) {
3154 ($w, $h) = split(/x/, $gconfig{'db_sizeuser'});
3156 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";
3159 =head2 foreign_check(module, [api-only])
3161 Checks if some other module exists and is supported on this OS. The parameters
3164 =item module - Name of the module to check.
3166 =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.
3171 my ($mod, $api) = @_;
3173 my $mdir = &module_root_directory($mod);
3174 &read_file_cached("$mdir/module.info", \%minfo) || return 0;
3175 return &check_os_support(\%minfo, undef, undef, $api);
3178 =head2 foreign_exists(module)
3180 Checks if some other module exists. The module parameter is the short module
3186 my $mdir = &module_root_directory($_[0]);
3187 return -r "$mdir/module.info";
3190 =head2 foreign_available(module)
3192 Returns 1 if some module is installed, and acessible to the current user. The
3193 module parameter is the module directory name.
3196 sub foreign_available
3198 return 0 if (!&foreign_check($_[0]) &&
3199 !$gconfig{'available_even_if_no_support'});
3200 my %foreign_module_info = &get_module_info($_[0]);
3202 # Check list of allowed modules
3204 &read_acl(\%acl, undef, [ $base_remote_user ]);
3205 return 0 if (!$acl{$base_remote_user,$_[0]} &&
3206 !$acl{$base_remote_user,'*'});
3208 # Check for usermod restrictions
3209 my @usermods = &list_usermods();
3210 return 0 if (!&available_usermods( [ \%foreign_module_info ], \@usermods));
3212 if (&get_product_name() eq "webmin") {
3213 # Check if the user has any RBAC privileges in this module
3214 if (&supports_rbac($_[0]) &&
3215 &use_rbac_module_acl(undef, $_[0])) {
3216 # RBAC is enabled for this user and module - check if he
3218 my $rbacs = &get_rbac_module_acl($remote_user, $_[0]);
3219 return 0 if (!$rbacs);
3221 elsif ($gconfig{'rbacdeny_'.$base_remote_user}) {
3222 # If denying access to modules not specifically allowed by
3223 # RBAC, then prevent access
3228 # Check readonly support
3229 if (&is_readonly_mode()) {
3230 return 0 if (!$foreign_module_info{'readonly'});
3233 # Check if theme vetos
3234 if (defined(&theme_foreign_available)) {
3235 return 0 if (!&theme_foreign_available($_[0]));
3238 # Check if licence module vetos
3239 if ($main::licence_module) {
3240 return 0 if (!&foreign_call($main::licence_module,
3241 "check_module_licence", $_[0]));
3247 =head2 foreign_require(module, [file], [package])
3249 Brings in functions from another module, and places them in the Perl namespace
3250 with the same name as the module. The parameters are :
3252 =item module - The source module's directory name, like sendmail.
3254 =item file - The API file in that module, like sendmail-lib.pl. If missing, all API files are loaded.
3256 =item package - Perl package to place the module's functions and global variables in.
3258 If the original module name contains dashes, they will be replaced with _ in
3264 my ($mod, $file, $pkg) = @_;
3265 $pkg ||= $mod || "global";
3266 $pkg =~ s/[^A-Za-z0-9]/_/g;
3269 push(@files, $file);
3273 my %minfo = &get_module_info($mod);
3274 if ($minfo{'library'}) {
3275 @files = split(/\s+/, $minfo{'library'});
3278 @files = ( $mod."-lib.pl" );
3281 @files = grep { !$main::done_foreign_require{$pkg,$_} } @files;
3282 return 1 if (!@files);
3283 foreach my $f (@files) {
3284 $main::done_foreign_require{$pkg,$f}++;
3287 my $mdir = &module_root_directory($mod);
3288 @INC = &unique($mdir, @INC);
3289 -d $mdir || &error("Module $mod does not exist");
3290 if (!&get_module_name() && $mod) {
3293 my $old_fmn = $ENV{'FOREIGN_MODULE_NAME'};
3294 my $old_frd = $ENV{'FOREIGN_ROOT_DIRECTORY'};
3295 my $code = "package $pkg; ".
3296 "\$ENV{'FOREIGN_MODULE_NAME'} = '$mod'; ".
3297 "\$ENV{'FOREIGN_ROOT_DIRECTORY'} = '$root_directory'; ";
3298 foreach my $f (@files) {
3299 $code .= "do '$mdir/$f' || die \$@; ";
3302 if (defined($old_fmn)) {
3303 $ENV{'FOREIGN_MODULE_NAME'} = $old_fmn;
3306 delete($ENV{'FOREIGN_MODULE_NAME'});
3308 if (defined($old_frd)) {
3309 $ENV{'FOREIGN_ROOT_DIRECTORY'} = $old_frd;
3312 delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
3315 if ($@) { &error("Require $mod/$files[0] failed : <pre>$@</pre>"); }
3319 =head2 foreign_call(module, function, [arg]*)
3321 Call a function in another module. The module parameter is the target module
3322 directory name, function is the perl sub to call, and the remaining parameters
3323 are the arguments. However, unless you need to call a function whose name
3324 is dynamic, it is better to use Perl's cross-module function call syntax
3325 like module::function(args).
3330 my $pkg = $_[0] || "global";
3331 $pkg =~ s/[^A-Za-z0-9]/_/g;
3332 my @args = @_[2 .. @_-1];
3333 $main::foreign_args = \@args;
3334 my @rv = eval <<EOF;
3336 &$_[1](\@{\$main::foreign_args});
3338 if ($@) { &error("$_[0]::$_[1] failed : $@"); }
3339 return wantarray ? @rv : $rv[0];
3342 =head2 foreign_config(module, [user-config])
3344 Get the configuration from another module, and return it as a hash. If the
3345 user-config parameter is set to 1, returns the Usermin user-level preferences
3346 for the current user instead.
3351 my ($mod, $uc) = @_;
3354 &read_file_cached("$root_directory/$mod/defaultuconfig", \%fconfig);
3355 &read_file_cached("$config_directory/$mod/uconfig", \%fconfig);
3356 &read_file_cached("$user_config_directory/$mod/config", \%fconfig);
3359 &read_file_cached("$config_directory/$mod/config", \%fconfig);
3364 =head2 foreign_installed(module, mode)
3366 Checks if the server for some module is installed, and possibly also checks
3367 if the module has been configured by Webmin.
3368 For mode 1, returns 2 if the server is installed and configured for use by
3369 Webmin, 1 if installed but not configured, or 0 otherwise.
3370 For mode 0, returns 1 if installed, 0 if not.
3371 If the module does not provide an install_check.pl script, assumes that
3372 the server is installed.
3375 sub foreign_installed
3377 my ($mod, $configured) = @_;
3378 if (defined($main::foreign_installed_cache{$mod,$configured})) {
3380 return $main::foreign_installed_cache{$mod,$configured};
3384 if (!&foreign_check($mod)) {
3389 my $mdir = &module_root_directory($mod);
3390 if (!-r "$mdir/install_check.pl") {
3391 # Not known, assume OK
3392 $rv = $configured ? 2 : 1;
3395 # Call function to check
3396 &foreign_require($mod, "install_check.pl");
3397 $rv = &foreign_call($mod, "is_installed", $configured);
3400 $main::foreign_installed_cache{$mod,$configured} = $rv;
3405 =head2 foreign_defined(module, function)
3407 Returns 1 if some function is defined in another module. In general, it is
3408 simpler to use the syntax &defined(module::function) instead.
3414 $pkg =~ s/[^A-Za-z0-9]/_/g;
3415 my $func = "${pkg}::$_[1]";
3416 return defined(&$func);
3419 =head2 get_system_hostname([short], [skip-file])
3421 Returns the hostname of this system. If the short parameter is set to 1,
3422 then the domain name is not prepended - otherwise, Webmin will attempt to get
3423 the fully qualified hostname, like foo.example.com.
3426 sub get_system_hostname
3429 my $skipfile = $_[1];
3430 if (!$main::get_system_hostname[$m]) {
3431 if ($gconfig{'os_type'} ne 'windows') {
3432 # Try some common Linux hostname files first
3435 # Never get from file
3437 elsif ($gconfig{'os_type'} eq 'redhat-linux') {
3439 &read_env_file("/etc/sysconfig/network", \%nc);
3440 if ($nc{'HOSTNAME'}) {
3441 $fromfile = $nc{'HOSTNAME'};
3444 elsif ($gconfig{'os_type'} eq 'debian-linux') {
3445 my $hn = &read_file_contents("/etc/hostname");
3451 elsif ($gconfig{'os_type'} eq 'open-linux') {
3452 my $hn = &read_file_contents("/etc/HOSTNAME");
3458 elsif ($gconfig{'os_type'} eq 'solaris') {
3459 my $hn = &read_file_contents("/etc/nodename");
3466 # If we found a hostname in a file, use it
3467 if ($fromfile && ($m || $fromfile =~ /\./)) {
3469 $fromfile =~ s/\..*$//;
3471 $main::get_system_hostname[$m] = $fromfile;
3475 # Can use hostname command on Unix
3476 &execute_command("hostname", undef,
3477 \$main::get_system_hostname[$m], undef, 0, 1);
3478 chop($main::get_system_hostname[$m]);
3480 eval "use Sys::Hostname";
3482 $main::get_system_hostname[$m] = eval "hostname()";
3484 if ($@ || !$main::get_system_hostname[$m]) {
3485 $main::get_system_hostname[$m] = "UNKNOWN";
3488 elsif ($main::get_system_hostname[$m] !~ /\./ &&
3489 $gconfig{'os_type'} =~ /linux$/ &&
3490 !$gconfig{'no_hostname_f'} && !$_[0]) {
3491 # Try with -f flag to get fully qualified name
3493 my $ex = &execute_command("hostname -f", undef, \$flag,
3496 if ($ex || $flag eq "") {
3497 # -f not supported! We have probably set the
3498 # hostname to just '-f'. Fix the problem
3501 &execute_command("hostname ".
3502 quotemeta($main::get_system_hostname[$m]),
3503 undef, undef, undef, 0, 1);
3507 $main::get_system_hostname[$m] = $flag;
3512 # On Windows, try computername environment variable
3513 return $ENV{'computername'} if ($ENV{'computername'});
3514 return $ENV{'COMPUTERNAME'} if ($ENV{'COMPUTERNAME'});
3516 # Fall back to net name command
3517 my $out = `net name 2>&1`;
3518 if ($out =~ /\-+\r?\n(\S+)/) {
3519 $main::get_system_hostname[$m] = $1;
3522 $main::get_system_hostname[$m] = "windows";
3526 return $main::get_system_hostname[$m];
3529 =head2 get_webmin_version
3531 Returns the version of Webmin currently being run, such as 1.450.
3534 sub get_webmin_version
3536 if (!$get_webmin_version) {
3537 open(VERSION, "$root_directory/version") || return 0;
3538 ($get_webmin_version = <VERSION>) =~ tr/\r|\n//d;
3541 return $get_webmin_version;
3544 =head2 get_module_acl([user], [module], [no-rbac], [no-default])
3546 Returns a hash containing access control options for the given user and module.
3547 By default the current username and module name are used. If the no-rbac flag
3548 is given, the permissions will not be updated based on the user's RBAC role
3549 (as seen on Solaris). If the no-default flag is given, default permissions for
3550 the module will not be included.
3555 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
3556 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3557 my $mdir = &module_root_directory($m);
3560 # Read default ACL first, to be overridden by per-user settings
3561 &read_file_cached("$mdir/defaultacl", \%rv);
3563 # If this isn't a master admin user, apply the negative permissions
3564 # so that he doesn't un-expectedly gain access to new features
3566 &read_file_cached("$config_directory/$u.acl", \%gaccess);
3567 if ($gaccess{'negative'}) {
3568 &read_file_cached("$mdir/negativeacl", \%rv);
3572 if (!$_[2] && &supports_rbac($m) && &use_rbac_module_acl($u, $m)) {
3573 # RBAC overrides exist for this user in this module
3574 my $rbac = &get_rbac_module_acl(
3575 defined($_[0]) ? $_[0] : $remote_user, $m);
3576 foreach my $r (keys %$rbac) {
3577 $rv{$r} = $rbac->{$r};
3580 elsif ($gconfig{"risk_$u"} && $m) {
3581 # ACL is defined by user's risk level
3582 my $rf = $gconfig{"risk_$u"}.'.risk';
3583 &read_file_cached("$mdir/$rf", \%rv);
3585 my $sf = $gconfig{"skill_$u"}.'.skill';
3586 &read_file_cached("$mdir/$sf", \%rv);
3589 # Use normal Webmin ACL, if a user is set
3590 my $userdb = &get_userdb_string();
3592 if ($userdb && ($u ne $base_remote_user || $remote_user_proto)) {
3593 # Look for this user in the user/group DB, if one is defined
3594 # and if the user might be in the DB
3595 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3596 ref($dbh) || &error(&text('euserdbacl', $dbh));
3597 if ($proto eq "mysql" || $proto eq "postgresql") {
3598 # Find the user in the SQL DB
3599 my $cmd = $dbh->prepare(
3600 "select id from webmin_user where name = ?");
3601 $cmd && $cmd->execute($u) ||
3602 &error(&text('euserdbacl', $dbh->errstr));
3603 my ($id) = $cmd->fetchrow();
3604 $foundindb = 1 if (defined($id));
3607 # Fetch ACLs with SQL
3609 my $cmd = $dbh->prepare(
3610 "select attr,value from webmin_user_acl ".
3611 "where id = ? and module = ?");
3612 $cmd && $cmd->execute($id, $m) ||
3613 &error(&text('euserdbacl', $dbh->errstr));
3614 while(my ($a, $v) = $cmd->fetchrow()) {
3620 elsif ($proto eq "ldap") {
3622 my $rv = $dbh->search(
3624 filter => '(&(cn='.$u.')(objectClass='.
3625 $args->{'userclass'}.'))',
3627 if (!$rv || $rv->code) {
3628 &error(&text('euserdbacl',
3629 $rv ? $rv->error : "Unknown error"));
3631 my ($user) = $rv->all_entries;
3633 # Find ACL sub-object for the module
3634 my $ldapm = $m || "global";
3636 my $rv = $dbh->search(
3637 base => $user->dn(),
3638 filter => '(cn='.$ldapm.')',
3640 if (!$rv || $rv->code) {
3641 &error(&text('euserdbacl',
3642 $rv ? $rv->error : "Unknown error"));
3644 my ($acl) = $rv->all_entries;
3646 foreach my $av ($acl->get_value(
3647 'webminAclEntry')) {
3648 my ($a, $v) = split(/=/, $av,2);
3654 &disconnect_userdb($userdb, $dbh);
3658 # Read from local files
3659 &read_file_cached("$config_directory/$m/$u.acl", \%rv);
3660 if ($remote_user ne $base_remote_user && !defined($_[0])) {
3662 "$config_directory/$m/$remote_user.acl",\%rv);
3666 if ($tconfig{'preload_functions'}) {
3667 &load_theme_library();
3669 if (defined(&theme_get_module_acl)) {
3670 %rv = &theme_get_module_acl($u, $m, \%rv);
3675 =head2 get_group_module_acl(group, [module], [no-default])
3677 Returns the ACL for a Webmin group, in an optional module (which defaults to
3678 the current module).
3681 sub get_group_module_acl
3684 my $m = defined($_[1]) ? $_[1] : &get_module_name();
3685 my $mdir = &module_root_directory($m);
3688 &read_file_cached("$mdir/defaultacl", \%rv);
3691 my $userdb = &get_userdb_string();
3694 # Look for this group in the user/group DB
3695 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3696 ref($dbh) || &error(&text('egroupdbacl', $dbh));
3697 if ($proto eq "mysql" || $proto eq "postgresql") {
3698 # Find the group in the SQL DB
3699 my $cmd = $dbh->prepare(
3700 "select id from webmin_group where name = ?");
3701 $cmd && $cmd->execute($g) ||
3702 &error(&text('egroupdbacl', $dbh->errstr));
3703 my ($id) = $cmd->fetchrow();
3704 $foundindb = 1 if (defined($id));
3707 # Fetch ACLs with SQL
3709 my $cmd = $dbh->prepare(
3710 "select attr,value from webmin_group_acl ".
3711 "where id = ? and module = ?");
3712 $cmd && $cmd->execute($id, $m) ||
3713 &error(&text('egroupdbacl', $dbh->errstr));
3714 while(my ($a, $v) = $cmd->fetchrow()) {
3720 elsif ($proto eq "ldap") {
3721 # Find group in LDAP
3722 my $rv = $dbh->search(
3724 filter => '(&(cn='.$g.')(objectClass='.
3725 $args->{'groupclass'}.'))',
3727 if (!$rv || $rv->code) {
3728 &error(&text('egroupdbacl',
3729 $rv ? $rv->error : "Unknown error"));
3731 my ($group) = $rv->all_entries;
3733 # Find ACL sub-object for the module
3734 my $ldapm = $m || "global";
3736 my $rv = $dbh->search(
3737 base => $group->dn(),
3738 filter => '(cn='.$ldapm.')',
3740 if (!$rv || $rv->code) {
3741 &error(&text('egroupdbacl',
3742 $rv ? $rv->error : "Unknown error"));
3744 my ($acl) = $rv->all_entries;
3746 foreach my $av ($acl->get_value(
3747 'webminAclEntry')) {
3748 my ($a, $v) = split(/=/, $av, 2);
3754 &disconnect_userdb($userdb, $dbh);
3757 # Read from local files
3758 &read_file_cached("$config_directory/$m/$g.gacl", \%rv);
3760 if (defined(&theme_get_module_acl)) {
3761 %rv = &theme_get_module_acl($g, $m, \%rv);
3766 =head2 save_module_acl(&acl, [user], [module], [never-update-group])
3768 Updates the acl hash for some user and module. The parameters are :
3770 =item acl - Hash reference for the new access control options, or undef to clear
3772 =item user - User to update, defaulting to the current user.
3774 =item module - Module to update, defaulting to the caller.
3776 =item never-update-group - Never update the user's group's ACL
3781 my $u = defined($_[1]) ? $_[1] : $base_remote_user;
3782 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3783 if (!$_[3] && &foreign_check("acl")) {
3784 # Check if this user is a member of a group, and if he gets the
3785 # module from a group. If so, update its ACL as well
3786 &foreign_require("acl", "acl-lib.pl");
3788 foreach my $g (&acl::list_groups()) {
3789 if (&indexof($u, @{$g->{'members'}}) >= 0 &&
3790 &indexof($m, @{$g->{'modules'}}) >= 0) {
3796 &save_group_module_acl($_[0], $group->{'name'}, $m);
3800 my $userdb = &get_userdb_string();
3802 if ($userdb && ($u ne $base_remote_user || $remote_user_proto)) {
3803 # Look for this user in the user/group DB
3804 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3805 ref($dbh) || &error(&text('euserdbacl', $dbh));
3806 if ($proto eq "mysql" || $proto eq "postgresql") {
3807 # Find the user in the SQL DB
3808 my $cmd = $dbh->prepare(
3809 "select id from webmin_user where name = ?");
3810 $cmd && $cmd->execute($u) ||
3811 &error(&text('euserdbacl2', $dbh->errstr));
3812 my ($id) = $cmd->fetchrow();
3813 $foundindb = 1 if (defined($id));
3816 # Replace ACLs for user
3818 my $cmd = $dbh->prepare("delete from webmin_user_acl ".
3819 "where id = ? and module = ?");
3820 $cmd && $cmd->execute($id, $m) ||
3821 &error(&text('euserdbacl', $dbh->errstr));
3824 my $cmd = $dbh->prepare(
3825 "insert into webmin_user_acl ".
3826 "(id,module,attr,value) values (?,?,?,?)");
3827 $cmd || &error(&text('euserdbacl2',
3829 foreach my $a (keys %{$_[0]}) {
3830 $cmd->execute($id,$m,$a,$_[0]->{$a}) ||
3831 &error(&text('euserdbacl2',
3838 elsif ($proto eq "ldap") {
3839 # Find the user in LDAP
3840 my $rv = $dbh->search(
3842 filter => '(&(cn='.$u.')(objectClass='.
3843 $args->{'userclass'}.'))',
3845 if (!$rv || $rv->code) {
3846 &error(&text('euserdbacl',
3847 $rv ? $rv->error : "Unknown error"));
3849 my ($user) = $rv->all_entries;
3852 # Find the ACL sub-object for the module
3854 my $ldapm = $m || "global";
3855 my $rv = $dbh->search(
3856 base => $user->dn(),
3857 filter => '(cn='.$ldapm.')',
3859 if (!$rv || $rv->code) {
3860 &error(&text('euserdbacl',
3861 $rv ? $rv->error : "Unknown error"));
3863 my ($acl) = $rv->all_entries;
3866 foreach my $a (keys %{$_[0]}) {
3867 push(@al, $a."=".$_[0]->{$a});
3871 $rv = $dbh->modify($acl->dn(),
3872 replace => { "webminAclEntry", \@al });
3876 my @attrs = ( "cn", $ldapm,
3877 "objectClass", "webminAcl",
3878 "webminAclEntry", \@al );
3879 $rv = $dbh->add("cn=".$ldapm.",".$user->dn(),
3882 if (!$rv || $rv->code) {
3883 &error(&text('euserdbacl2',
3884 $rv ? $rv->error : "Unknown error"));
3888 &disconnect_userdb($userdb, $dbh);
3892 # Save ACL to local file
3893 if (!-d "$config_directory/$m") {
3894 mkdir("$config_directory/$m", 0755);
3897 &write_file("$config_directory/$m/$u.acl", $_[0]);
3900 &unlink_file("$config_directory/$m/$u.acl");
3905 =head2 save_group_module_acl(&acl, group, [module], [never-update-group])
3907 Updates the acl hash for some group and module. The parameters are :
3909 =item acl - Hash reference for the new access control options.
3911 =item group - Group name to update.
3913 =item module - Module to update, defaulting to the caller.
3915 =item never-update-group - Never update the parent group's ACL
3918 sub save_group_module_acl
3921 my $m = defined($_[2]) ? $_[2] : &get_module_name();
3922 if (!$_[3] && &foreign_check("acl")) {
3923 # Check if this group is a member of a group, and if it gets the
3924 # module from a group. If so, update the parent ACL as well
3925 &foreign_require("acl", "acl-lib.pl");
3927 foreach my $pg (&acl::list_groups()) {
3928 if (&indexof('@'.$g, @{$pg->{'members'}}) >= 0 &&
3929 &indexof($m, @{$pg->{'modules'}}) >= 0) {
3935 &save_group_module_acl($_[0], $group->{'name'}, $m);
3939 my $userdb = &get_userdb_string();
3942 # Look for this group in the user/group DB
3943 my ($dbh, $proto, $prefix, $args) = &connect_userdb($userdb);
3944 ref($dbh) || &error(&text('egroupdbacl', $dbh));
3945 if ($proto eq "mysql" || $proto eq "postgresql") {
3946 # Find the group in the SQL DB
3947 my $cmd = $dbh->prepare(
3948 "select id from webmin_group where name = ?");
3949 $cmd && $cmd->execute($g) ||
3950 &error(&text('egroupdbacl2', $dbh->errstr));
3951 my ($id) = $cmd->fetchrow();
3952 $foundindb = 1 if (defined($id));
3955 # Replace ACLs for group
3957 my $cmd = $dbh->prepare("delete from webmin_group_acl ".
3958 "where id = ? and module = ?");
3959 $cmd && $cmd->execute($id, $m) ||
3960 &error(&text('egroupdbacl', $dbh->errstr));
3963 my $cmd = $dbh->prepare(
3964 "insert into webmin_group_acl ".
3965 "(id,module,attr,value) values (?,?,?,?)");
3966 $cmd || &error(&text('egroupdbacl2',
3968 foreach my $a (keys %{$_[0]}) {
3969 $cmd->execute($id,$m,$a,$_[0]->{$a}) ||
3970 &error(&text('egroupdbacl2',
3977 elsif ($proto eq "ldap") {
3978 # Find the group in LDAP
3979 my $rv = $dbh->search(
3981 filter => '(&(cn='.$g.')(objectClass='.
3982 $args->{'groupclass'}.'))',
3984 if (!$rv || $rv->code) {
3985 &error(&text('egroupdbacl',
3986 $rv ? $rv->error : "Unknown error"));
3988 my ($group) = $rv->all_entries;
3990 my $ldapm = $m || "global";
3992 # Find the ACL sub-object for the module
3994 my $rv = $dbh->search(
3995 base => $group->dn(),
3996 filter => '(cn='.$ldapm.')',
3998 if (!$rv || $rv->code) {
3999 &error(&text('egroupdbacl',
4000 $rv ? $rv->error : "Unknown error"));
4002 my ($acl) = $rv->all_entries;
4005 foreach my $a (keys %{$_[0]}) {
4006 push(@al, $a."=".$_[0]->{$a});
4010 $rv = $dbh->modify($acl->dn(),
4011 replace => { "webminAclEntry", \@al });
4015 my @attrs = ( "cn", $ldapm,
4016 "objectClass", "webminAcl",
4017 "webminAclEntry", \@al );
4018 $rv = $dbh->add("cn=".$ldapm.",".$group->dn(),
4021 if (!$rv || $rv->code) {
4022 &error(&text('egroupdbacl2',
4023 $rv ? $rv->error : "Unknown error"));
4027 &disconnect_userdb($userdb, $dbh);
4031 # Save ACL to local file
4032 if (!-d "$config_directory/$m") {
4033 mkdir("$config_directory/$m", 0755);
4036 &write_file("$config_directory/$m/$g.gacl", $_[0]);
4039 &unlink_file("$config_directory/$m/$g.gacl");
4046 This function must be called by all Webmin CGI scripts, either directly or
4047 indirectly via a per-module lib.pl file. It performs a number of initialization
4048 and housekeeping tasks, such as working out the module name, checking that the
4049 current user has access to the module, and populating global variables. Some
4050 of the variables set include :
4052 =item $config_directory - Base Webmin config directory, typically /etc/webmin
4054 =item $var_directory - Base logs directory, typically /var/webmin
4056 =item %config - Per-module configuration.
4058 =item %gconfig - Global configuration.
4060 =item $scriptname - Base name of the current perl script.
4062 =item $module_name - The name of the current module.
4064 =item $module_config_directory - The config directory for this module.
4066 =item $module_config_file - The config file for this module.
4068 =item $module_root_directory - This module's code directory.
4070 =item $webmin_logfile - The detailed logfile for webmin.
4072 =item $remote_user - The actual username used to login to webmin.
4074 =item $base_remote_user - The username whose permissions are in effect.
4076 =item $current_theme - The theme currently in use.
4078 =item $root_directory - The first root directory of this webmin install.
4080 =item @root_directories - All root directories for this webmin install.
4085 # Record first process ID that called this, so we know when it exited to clean
4087 $main::initial_process_id ||= $$;
4089 # Configuration and spool directories
4090 if (!defined($ENV{'WEBMIN_CONFIG'})) {
4091 die "WEBMIN_CONFIG not set";
4093 $config_directory = $ENV{'WEBMIN_CONFIG'};
4094 if (!defined($ENV{'WEBMIN_VAR'})) {
4095 open(VARPATH, "$config_directory/var-path");
4096 chop($var_directory = <VARPATH>);
4100 $var_directory = $ENV{'WEBMIN_VAR'};
4102 $main::http_cache_directory = $ENV{'WEBMIN_VAR'}."/cache";
4103 $main::default_debug_log_file = $ENV{'WEBMIN_VAR'}."/webmin.debug";
4105 if ($ENV{'SESSION_ID'}) {
4106 # Hide this variable from called programs, but keep it for internal use
4107 $main::session_id = $ENV{'SESSION_ID'};
4108 delete($ENV{'SESSION_ID'});
4110 if ($ENV{'REMOTE_PASS'}) {
4111 # Hide the password too
4112 $main::remote_pass = $ENV{'REMOTE_PASS'};
4113 delete($ENV{'REMOTE_PASS'});
4116 if ($> == 0 && $< != 0 && !$ENV{'FOREIGN_MODULE_NAME'}) {
4117 # Looks like we are running setuid, but the real UID hasn't been set.
4118 # Do so now, so that executed programs don't get confused
4123 # Read the webmin global config file. This contains the OS type and version,
4124 # OS specific configuration and global options such as proxy servers
4125 $config_file = "$config_directory/config";
4127 &read_file_cached($config_file, \%gconfig);
4128 $gconfig{'webprefix'} = '' if (!exists($gconfig{'webprefix'}));
4129 $null_file = $gconfig{'os_type'} eq 'windows' ? "NUL" : "/dev/null";
4130 $path_separator = $gconfig{'os_type'} eq 'windows' ? ';' : ':';
4132 # Work out of this is a web, command line or cron job
4133 if (!$main::webmin_script_type) {
4134 if ($ENV{'SCRIPT_NAME'}) {
4136 $main::webmin_script_type = 'web';
4139 # Cron jobs have no TTY
4140 if ($gconfig{'os_type'} eq 'windows' ||
4141 open(DEVTTY, ">/dev/tty")) {
4142 $main::webmin_script_type = 'cmd';
4146 $main::webmin_script_type = 'cron';
4151 # If this is a cron job, suppress STDERR warnings
4152 if ($main::webmin_script_type eq 'cron') {
4153 $SIG{__WARN__} = sub { };
4156 # If debugging is enabled, open the debug log
4157 if ($gconfig{'debug_enabled'} && !$main::opened_debug_log++) {
4158 my $dlog = $gconfig{'debug_file'} || $main::default_debug_log_file;
4159 if ($gconfig{'debug_size'}) {
4160 my @st = stat($dlog);
4161 if ($st[7] > $gconfig{'debug_size'}) {
4162 rename($dlog, $dlog.".0");
4165 open(main::DEBUGLOG, ">>$dlog");
4166 $main::opened_debug_log = 1;
4168 if ($gconfig{'debug_what_start'}) {
4169 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
4170 $main::debug_log_start_time = time();
4171 &webmin_debug_log("START", "script=$script_name");
4172 $main::debug_log_start_module = $module_name;
4176 # Set PATH and LD_LIBRARY_PATH
4177 if ($gconfig{'path'}) {
4178 if ($gconfig{'syspath'}) {
4180 $ENV{'PATH'} = $gconfig{'path'};
4184 $ENV{'PATH'} = $gconfig{'path'}.$path_separator.$ENV{'PATH'};
4187 $ENV{$gconfig{'ld_env'}} = $gconfig{'ld_path'} if ($gconfig{'ld_env'});
4189 # Set http_proxy and ftp_proxy environment variables, based on Webmin settings
4190 if ($gconfig{'http_proxy'}) {
4191 $ENV{'http_proxy'} = $gconfig{'http_proxy'};
4193 if ($gconfig{'ftp_proxy'}) {
4194 $ENV{'ftp_proxy'} = $gconfig{'ftp_proxy'};
4196 if ($gconfig{'noproxy'}) {
4197 $ENV{'no_proxy'} = $gconfig{'noproxy'};
4200 # Find all root directories
4202 if (&get_miniserv_config(\%miniserv)) {
4203 @root_directories = ( $miniserv{'root'} );
4204 for($i=0; defined($miniserv{"extraroot_$i"}); $i++) {
4205 push(@root_directories, $miniserv{"extraroot_$i"});
4209 # Work out which module we are in, and read the per-module config file
4210 $0 =~ s/\\/\//g; # Force consistent path on Windows
4211 if (defined($ENV{'FOREIGN_MODULE_NAME'})) {
4212 # In a foreign call - use the module name given
4213 $root_directory = $ENV{'FOREIGN_ROOT_DIRECTORY'};
4214 $module_name = $ENV{'FOREIGN_MODULE_NAME'};
4215 @root_directories = ( $root_directory ) if (!@root_directories);
4217 elsif ($ENV{'SCRIPT_NAME'}) {
4218 my $sn = $ENV{'SCRIPT_NAME'};
4219 $sn =~ s/^$gconfig{'webprefix'}//
4220 if (!$gconfig{'webprefixnoredir'});
4221 if ($sn =~ /^\/([^\/]+)\//) {
4222 # Get module name from CGI path
4225 if ($ENV{'SERVER_ROOT'}) {
4226 $root_directory = $ENV{'SERVER_ROOT'};
4228 elsif ($ENV{'SCRIPT_FILENAME'}) {
4229 $root_directory = $ENV{'SCRIPT_FILENAME'};
4230 $root_directory =~ s/$sn$//;
4232 @root_directories = ( $root_directory ) if (!@root_directories);
4235 # Get root directory from miniserv.conf, and deduce module name from $0
4236 $root_directory = $root_directories[0];
4238 foreach my $r (@root_directories) {
4239 if ($0 =~ /^$r\/([^\/]+)\/[^\/]+$/i) {
4240 # Under a module directory
4245 elsif ($0 =~ /^$root_directory\/[^\/]+$/i) {
4251 &error("Script was not run with full path (failed to find $0 under $root_directory)") if (!$rok);
4254 # Set the umask based on config
4255 if ($gconfig{'umask'} && !$main::umask_already++) {
4256 umask(oct($gconfig{'umask'}));
4259 # If this is a cron job or other background task, set the nice level
4260 if (!$main::nice_already && $main::webmin_script_type eq 'cron') {
4262 if ($gconfig{'nice'}) {
4263 eval 'POSIX::nice($gconfig{\'nice\'});';
4266 # Set IO scheduling class and priority
4267 if ($gconfig{'sclass'} ne '' || $gconfig{'sprio'} ne '') {
4269 $cmd .= " -c ".quotemeta($gconfig{'sclass'})
4270 if ($gconfig{'sclass'} ne '');
4271 $cmd .= " -n ".quotemeta($gconfig{'sprio'})
4272 if ($gconfig{'sprio'} ne '');
4274 &execute_command("$cmd >/dev/null 2>&1");
4277 $main::nice_already++;
4280 my $u = $ENV{'BASE_REMOTE_USER'} || $ENV{'REMOTE_USER'};
4281 $base_remote_user = $u;
4282 $remote_user = $ENV{'REMOTE_USER'};
4284 # Work out if user is definitely in the DB, and if so get his attrs
4285 $remote_user_proto = $ENV{"REMOTE_USER_PROTO"};
4286 %remote_user_attrs = ( );
4287 if ($remote_user_proto) {
4288 my $userdb = &get_userdb_string();
4289 my ($dbh, $proto, $prefix, $args) =
4290 $userdb ? &connect_userdb($userdb) : ( );
4292 if ($proto eq "mysql" || $proto eq "postgresql") {
4293 # Read attrs from SQL
4294 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 = ?");
4295 if ($cmd && $cmd->execute($base_remote_user)) {
4296 while(my ($attr, $value) = $cmd->fetchrow()) {
4297 $remote_user_attrs{$attr} = $value;
4302 elsif ($proto eq "ldap") {
4303 # Read attrs from LDAP
4304 my $rv = $dbh->search(
4306 filter => '(&(cn='.$base_remote_user.')'.
4308 $args->{'userclass'}.'))',
4310 my ($u) = $rv && !$rv->code ? $rv->all_entries : ( );
4312 foreach $la ($u->get_value('webminAttr')) {
4313 my ($attr, $value) = split(/=/, $la, 2);
4314 $remote_user_attrs{$attr} = $value;
4318 &disconnect_userdb($userdb, $dbh);
4323 # Find and load the configuration file for this module
4324 my (@ruinfo, $rgroup);
4325 $module_config_directory = "$config_directory/$module_name";
4326 if (&get_product_name() eq "usermin" &&
4327 -r "$module_config_directory/config.$remote_user") {
4329 $module_config_file = "$module_config_directory/config.$remote_user";
4331 elsif (&get_product_name() eq "usermin" &&
4332 (@ruinfo = getpwnam($remote_user)) &&
4333 ($rgroup = getgrgid($ruinfo[3])) &&
4334 -r "$module_config_directory/config.\@$rgroup") {
4335 # Based on group name
4336 $module_config_file = "$module_config_directory/config.\@$rgroup";
4340 $module_config_file = "$module_config_directory/config";
4343 &read_file_cached($module_config_file, \%config);
4345 # Fix up windows-specific substitutions in values
4346 foreach my $k (keys %config) {
4347 if ($config{$k} =~ /\$\{systemroot\}/) {
4348 my $root = &get_windows_root();
4349 $config{$k} =~ s/\$\{systemroot\}/$root/g;
4354 # Record the initial module
4355 $main::initial_module_name ||= $module_name;
4357 # Set some useful variables
4359 $current_themes = $ENV{'MOBILE_DEVICE'} && defined($gconfig{'mobile_theme'}) ?
4360 $gconfig{'mobile_theme'} :
4361 defined($remote_user_attrs{'theme'}) ?
4362 $remote_user_attrs{'theme'} :
4363 defined($gconfig{'theme_'.$remote_user}) ?
4364 $gconfig{'theme_'.$remote_user} :
4365 defined($gconfig{'theme_'.$base_remote_user}) ?
4366 $gconfig{'theme_'.$base_remote_user} :
4368 @current_themes = split(/\s+/, $current_themes);
4369 $current_theme = $current_themes[0];
4370 @theme_root_directories = map { "$root_directory/$_" } @current_themes;
4371 $theme_root_directory = $theme_root_directories[0];
4372 @theme_configs = ( );
4373 foreach my $troot (@theme_root_directories) {
4375 &read_file_cached("$troot/config", \%onetconfig);
4376 &read_file_cached("$troot/config", \%tconfig);
4377 push(@theme_configs, \%onetconfig);
4379 $tb = defined($tconfig{'cs_header'}) ? "bgcolor=#$tconfig{'cs_header'}" :
4380 defined($gconfig{'cs_header'}) ? "bgcolor=#$gconfig{'cs_header'}" :
4382 $cb = defined($tconfig{'cs_table'}) ? "bgcolor=#$tconfig{'cs_table'}" :
4383 defined($gconfig{'cs_table'}) ? "bgcolor=#$gconfig{'cs_table'}" :
4385 $tb .= ' '.$tconfig{'tb'} if ($tconfig{'tb'});
4386 $cb .= ' '.$tconfig{'cb'} if ($tconfig{'cb'});
4387 if ($tconfig{'preload_functions'}) {
4388 # Force load of theme functions right now, if requested
4389 &load_theme_library();
4391 if ($tconfig{'oofunctions'} && !$main::loaded_theme_oo_library++) {
4392 # Load the theme's Webmin:: package classes
4393 do "$theme_root_directory/$tconfig{'oofunctions'}";
4398 $webmin_logfile = $gconfig{'webmin_log'} ? $gconfig{'webmin_log'}
4399 : "$var_directory/webmin.log";
4401 # Load language strings into %text
4402 my @langs = &list_languages();
4404 if ($gconfig{'acceptlang'}) {
4405 foreach my $a (split(/,/, $ENV{'HTTP_ACCEPT_LANGUAGE'})) {
4406 my ($al) = grep { $_->{'lang'} eq $a } @langs;
4408 $accepted_lang = $al->{'lang'};
4413 $current_lang = $force_lang ? $force_lang :
4414 $accepted_lang ? $accepted_lang :
4415 $remote_user_attrs{'lang'} ? $remote_user_attrs{'lang'} :
4416 $gconfig{"lang_$remote_user"} ? $gconfig{"lang_$remote_user"} :
4417 $gconfig{"lang_$base_remote_user"} ? $gconfig{"lang_$base_remote_user"} :
4418 $gconfig{"lang"} ? $gconfig{"lang"} : $default_lang;
4419 foreach my $l (@langs) {
4420 $current_lang_info = $l if ($l->{'lang'} eq $current_lang);
4422 @lang_order_list = &unique($default_lang,
4423 split(/:/, $current_lang_info->{'fallback'}),
4425 %text = &load_language($module_name);
4426 %text || &error("Failed to determine Webmin root from SERVER_ROOT, SCRIPT_FILENAME or the full command line");
4428 # Get the %module_info for this module
4430 my ($mi) = grep { $_->{'dir'} eq $module_name }
4431 &get_all_module_infos(2);
4432 %module_info = %$mi;
4433 $module_root_directory = &module_root_directory($module_name);
4436 if ($module_name && !$main::no_acl_check &&
4437 !defined($ENV{'FOREIGN_MODULE_NAME'})) {
4438 # Check if the HTTP user can access this module
4439 if (!&foreign_available($module_name)) {
4440 if (!&foreign_check($module_name)) {
4441 &error(&text('emodulecheck',
4442 "<i>$module_info{'desc'}</i>"));
4445 &error(&text('emodule', "<i>$u</i>",
4446 "<i>$module_info{'desc'}</i>"));
4449 $main::no_acl_check++;
4452 # Check the Referer: header for nasty redirects
4453 my @referers = split(/\s+/, $gconfig{'referers'});
4455 my $r = $ENV{'HTTP_REFERER'};
4456 if ($r =~ /^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?\[([^\]]+)\]/ ||
4457 $r =~ /^(http|https|ftp):\/\/([^:\/]+:[^@\/]+@)?([^\/:@]+)/) {
4460 my $http_host = $ENV{'HTTP_HOST'};
4461 $http_host =~ s/:\d+$//;
4462 $http_host =~ s/^\[(\S+)\]$/$1/;
4463 my $unsafe_index = $unsafe_index_cgi ||
4464 &get_module_variable('$unsafe_index_cgi');
4466 ($ENV{'SCRIPT_NAME'} !~ /^\/(index.cgi)?$/ || $unsafe_index) &&
4467 ($ENV{'SCRIPT_NAME'} !~ /^\/([a-z0-9\_\-]+)\/(index.cgi)?$/i ||
4469 $0 !~ /(session_login|pam_login)\.cgi$/ && !$gconfig{'referer'} &&
4470 $ENV{'MINISERV_CONFIG'} && !$main::no_referers_check &&
4471 $ENV{'HTTP_USER_AGENT'} !~ /^Webmin/i &&
4472 ($referer_site && $referer_site ne $http_host &&
4473 &indexof($referer_site, @referers) < 0 ||
4474 !$referer_site && $gconfig{'referers_none'}) &&
4475 !$trust_unknown_referers &&
4476 !&get_module_variable('$trust_unknown_referers')) {
4477 # Looks like a link from elsewhere .. show an error
4478 &header($text{'referer_title'}, "", undef, 0, 1, 1);
4480 $prot = lc($ENV{'HTTPS'}) eq 'on' ? "https" : "http";
4481 my $url = "<tt>".&html_escape("$prot://$ENV{'HTTP_HOST'}$ENV{'REQUEST_URI'}")."</tt>";
4482 if ($referer_site) {
4484 print &text('referer_warn',
4485 "<tt>".&html_escape($r)."</tt>", $url);
4487 print &text('referer_fix1', &html_escape($http_host)),"<p>\n";
4488 print &text('referer_fix2', &html_escape($http_host)),"<p>\n";
4491 # No referer info given
4492 print &text('referer_warn_unknown', $url),"<p>\n";
4493 print &text('referer_fix1u'),"<p>\n";
4494 print &text('referer_fix2u'),"<p>\n";
4498 &footer("/", $text{'index'});
4501 $main::no_referers_check++;
4502 $main::completed_referers_check++;
4504 # Call theme post-init
4505 if (defined(&theme_post_init_config)) {
4506 &theme_post_init_config(@_);
4509 # Record that we have done the calling library in this package
4510 my ($callpkg, $lib) = caller();
4512 $main::done_foreign_require{$callpkg,$lib} = 1;
4514 # If a licence checking is enabled, do it now
4515 if ($gconfig{'licence_module'} && !$main::done_licence_module_check &&
4516 &foreign_check($gconfig{'licence_module'}) &&
4517 -r "$root_directory/$gconfig{'licence_module'}/licence_check.pl") {
4518 my $oldpwd = &get_current_dir();
4519 $main::done_licence_module_check++;
4520 $main::licence_module = $gconfig{'licence_module'};
4521 &foreign_require($main::licence_module, "licence_check.pl");
4522 ($main::licence_status, $main::licence_message) =
4523 &foreign_call($main::licence_module, "check_licence");
4527 # Export global variables to caller
4528 if ($main::export_to_caller) {
4529 foreach my $v ('$config_file', '%gconfig', '$null_file',
4530 '$path_separator', '@root_directories',
4531 '$root_directory', '$module_name',
4532 '$base_remote_user', '$remote_user',
4533 '$remote_user_proto', '%remote_user_attrs',
4534 '$module_config_directory', '$module_config_file',
4535 '%config', '@current_themes', '$current_theme',
4536 '@theme_root_directories', '$theme_root_directory',
4537 '%tconfig','@theme_configs', '$tb', '$cb', '$scriptname',
4538 '$webmin_logfile', '$current_lang',
4539 '$current_lang_info', '@lang_order_list', '%text',
4540 '%module_info', '$module_root_directory') {
4541 my ($vt, $vn) = split('', $v, 2);
4542 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
4549 =head2 load_language([module], [directory])
4551 Returns a hashtable mapping text codes to strings in the appropriate language,
4552 based on the $current_lang global variable, which is in turn set based on
4553 the Webmin user's selection. The optional module parameter tells the function
4554 which module to load strings for, and defaults to the calling module. The
4555 optional directory parameter can be used to load strings from a directory
4558 In regular module development you will never need to call this function
4559 directly, as init_config calls it for you, and places the module's strings
4560 into the %text hash.
4566 my $root = $root_directory;
4567 my $ol = $gconfig{'overlang'};
4568 my ($dir) = ($_[1] || "lang");
4570 # Read global lang files
4571 foreach my $o (@lang_order_list) {
4572 my $ok = &read_file_cached_with_stat("$root/$dir/$o", \%text);
4573 return () if (!$ok && $o eq $default_lang);
4576 foreach my $o (@lang_order_list) {
4577 &read_file_cached("$root/$ol/$o", \%text);
4580 &read_file_cached("$config_directory/custom-lang", \%text);
4581 foreach my $o (@lang_order_list) {
4582 next if ($o eq "en");
4583 &read_file_cached("$config_directory/custom-lang.$o", \%text);
4585 my $norefs = $text{'__norefs'};
4588 # Read module's lang files
4589 delete($text{'__norefs'});
4590 my $mdir = &module_root_directory($_[0]);
4591 foreach my $o (@lang_order_list) {
4592 &read_file_cached_with_stat("$mdir/$dir/$o", \%text);
4595 foreach my $o (@lang_order_list) {
4596 &read_file_cached("$mdir/$ol/$o", \%text);
4599 &read_file_cached("$config_directory/$_[0]/custom-lang", \%text);
4600 foreach my $o (@lang_order_list) {
4601 next if ($o eq "en");
4602 &read_file_cached("$config_directory/$_[0]/custom-lang.$o",
4605 $norefs = $text{'__norefs'} if ($norefs);
4608 # Replace references to other strings
4610 foreach $k (keys %text) {
4611 $text{$k} =~ s/\$(\{([^\}]+)\}|([A-Za-z0-9\.\-\_]+))/text_subs($2 || $3,\%text)/ge;
4615 if (defined(&theme_load_language)) {
4616 &theme_load_language(\%text, $_[0]);
4621 =head2 text_subs(string)
4623 Used internally by load_language to expand $code substitutions in language
4629 if (substr($_[0], 0, 8) eq "include:") {
4632 open(INCLUDE, substr($_[0], 8));
4640 my $t = $_[1]->{$_[0]};
4641 return defined($t) ? $t : '$'.$_[0];
4645 =head2 text(message, [substitute]+)
4647 Returns a translated message from %text, but with $1, $2, etc.. replaced with
4648 the substitute parameters. This makes it easy to use strings with placeholders
4649 that get replaced with programmatically generated text. For example :
4651 print &text('index_hello', $remote_user),"<p>\n";
4656 my $t = &get_module_variable('%text', 1);
4657 my $rv = exists($t->{$_[0]}) ? $t->{$_[0]} : $text{$_[0]};
4658 for(my $i=1; $i<@_; $i++) {
4659 $rv =~ s/\$$i/$_[$i]/g;
4664 =head2 encode_base64(string)
4666 Encodes a string into base64 format, for use in MIME email or HTTP
4667 authorization headers.
4673 pos($_[0]) = 0; # ensure start at the beginning
4674 while ($_[0] =~ /(.{1,57})/gs) {
4675 $res .= substr(pack('u57', $1), 1)."\n";
4678 $res =~ tr|\` -_|AA-Za-z0-9+/|;
4679 my $padding = (3 - length($_[0]) % 3) % 3;
4680 $res =~ s/.{$padding}$/'=' x $padding/e if ($padding);
4684 =head2 decode_base64(string)
4686 Converts a base64-encoded string into plain text. The opposite of encode_base64.
4693 $str =~ tr|A-Za-z0-9+=/||cd; # remove non-base64 chars
4694 if (length($str) % 4) {
4697 $str =~ s/=+$//; # remove padding
4698 $str =~ tr|A-Za-z0-9+/| -_|; # convert to uuencoded format
4699 while ($str =~ /(.{1,60})/gs) {
4700 my $len = chr(32 + length($1)*3/4); # compute length byte
4701 $res .= unpack("u", $len . $1 ); # uudecode
4706 =head2 get_module_info(module, [noclone], [forcache])
4708 Returns a hash containg details of the given module. Some useful keys are :
4710 =item dir - The module directory, like sendmail.
4712 =item desc - Human-readable description, in the current users' language.
4714 =item version - Optional module version number.
4716 =item os_support - List of supported operating systems and versions.
4718 =item category - Category on Webmin's left menu, like net.
4723 return () if ($_[0] =~ /^\./);
4724 my (%rv, $clone, $o);
4725 my $mdir = &module_root_directory($_[0]);
4726 &read_file_cached("$mdir/module.info", \%rv) || return ();
4728 # A clone is a module that links to another directory under the root
4729 foreach my $r (@root_directories) {
4730 if (&is_under_directory($r, $mdir)) {
4736 foreach $o (@lang_order_list) {
4737 $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4738 $rv{"longdesc"} = $rv{"longdesc_$o"} if ($rv{"longdesc_$o"});
4740 if ($clone && !$_[1] && $config_directory) {
4741 $rv{'clone'} = $rv{'desc'};
4742 &read_file("$config_directory/$_[0]/clone", \%rv);
4745 my %module_categories;
4746 &read_file_cached("$config_directory/webmin.cats", \%module_categories);
4747 my $pn = &get_product_name();
4748 if (defined($rv{'category_'.$pn})) {
4749 # Can override category for webmin/usermin
4750 $rv{'category'} = $rv{'category_'.$pn};
4752 $rv{'realcategory'} = $rv{'category'};
4753 $rv{'category'} = $module_categories{$_[0]}
4754 if (defined($module_categories{$_[0]}));
4756 # Apply description overrides
4757 $rv{'realdesc'} = $rv{'desc'};
4759 &read_file_cached("$config_directory/webmin.descs", \%descs);
4760 if ($descs{$_[0]}) {
4761 $rv{'desc'} = $descs{$_[0]};
4763 foreach my $o (@lang_order_list) {
4764 my $ov = $descs{$_[0]." ".$o} || $descs{$_[0]."_".$o};
4765 $rv{'desc'} = $ov if ($ov);
4769 # Apply per-user description overridde
4770 my %gaccess = &get_module_acl(undef, "");
4771 if ($gaccess{'desc_'.$_[0]}) {
4772 $rv{'desc'} = $gaccess{'desc_'.$_[0]};
4776 if ($rv{'longdesc'}) {
4777 # All standard modules have an index.cgi
4778 $rv{'index_link'} = 'index.cgi';
4781 # Call theme-specific override function
4782 if (defined(&theme_get_module_info)) {
4783 %rv = &theme_get_module_info(\%rv, $_[0], $_[1], $_[2]);
4789 =head2 get_all_module_infos(cachemode)
4791 Returns a list contains the information on all modules in this webmin
4792 install, including clones. Uses caching to reduce the number of module.info
4793 files that need to be read. Each element of the array is a hash reference
4794 in the same format as returned by get_module_info. The cache mode flag can be :
4795 0 = read and write, 1 = don't read or write, 2 = read only
4798 sub get_all_module_infos
4802 # Is the cache out of date? (ie. have any of the root's changed?)
4803 my $cache_file = "$config_directory/module.infos.cache";
4805 if (&read_file_cached($cache_file, \%cache)) {
4806 foreach my $r (@root_directories) {
4808 if ($st[9] != $cache{'mtime_'.$r}) {
4818 if ($_[0] != 1 && !$changed && $cache{'lang'} eq $current_lang) {
4819 # Can use existing module.info cache
4821 foreach my $k (keys %cache) {
4822 if ($k =~ /^(\S+) (\S+)$/) {
4823 $mods{$1}->{$2} = $cache{$k};
4826 @rv = map { $mods{$_} } (keys %mods) if (%mods);
4829 # Need to rebuild cache
4831 foreach my $r (@root_directories) {
4833 foreach my $m (readdir(DIR)) {
4834 next if ($m =~ /^(config-|\.)/ || $m =~ /\.(cgi|pl)$/);
4835 my %minfo = &get_module_info($m, 0, 1);
4836 next if (!%minfo || !$minfo{'dir'});
4838 foreach $k (keys %minfo) {
4839 $cache{"${m} ${k}"} = $minfo{$k};
4844 $cache{'mtime_'.$r} = $st[9];
4846 $cache{'lang'} = $current_lang;
4847 if (!$_[0] && $< == 0 && $> == 0) {
4849 # Don't fail if cache write fails
4850 local $main::error_must_die = 1;
4851 &write_file($cache_file, \%cache);
4856 # Override descriptions for modules for current user
4857 my %gaccess = &get_module_acl(undef, "");
4858 foreach my $m (@rv) {
4859 if ($gaccess{"desc_".$m->{'dir'}}) {
4860 $m->{'desc'} = $gaccess{"desc_".$m->{'dir'}};
4864 # Apply installed flags
4866 &read_file_cached("$config_directory/installed.cache", \%installed);
4867 foreach my $m (@rv) {
4868 $m->{'installed'} = $installed{$m->{'dir'}};
4876 Returns an array of all installed themes, each of which is a hash ref
4877 corresponding to the theme.info file.
4883 opendir(DIR, $root_directory);
4884 foreach my $m (readdir(DIR)) {
4886 next if ($m =~ /^\./);
4887 next if (!&read_file_cached("$root_directory/$m/theme.info", \%tinfo));
4888 next if (!&check_os_support(\%tinfo));
4889 foreach my $o (@lang_order_list) {
4890 if ($tinfo{'desc_'.$o}) {
4891 $tinfo{'desc'} = $tinfo{'desc_'.$o};
4898 return sort { lc($a->{'desc'}) cmp lc($b->{'desc'}) } @rv;
4901 =head2 get_theme_info(theme)
4903 Returns a hash containing a theme's details, taken from it's theme.info file.
4904 Some useful keys are :
4906 =item dir - The theme directory, like blue-theme.
4908 =item desc - Human-readable description, in the current users' language.
4910 =item version - Optional module version number.
4912 =item os_support - List of supported operating systems and versions.
4917 return () if ($_[0] =~ /^\./);
4919 my $tdir = &module_root_directory($_[0]);
4920 &read_file("$tdir/theme.info", \%rv) || return ();
4921 foreach my $o (@lang_order_list) {
4922 $rv{"desc"} = $rv{"desc_$o"} if ($rv{"desc_$o"});
4928 =head2 list_languages
4930 Returns an array of supported languages, taken from Webmin's os_list.txt file.
4931 Each is a hash reference with the following keys :
4933 =item lang - The short language code, like es for Spanish.
4935 =item desc - A human-readable description, in English.
4937 =item charset - An optional character set to use when displaying the language.
4939 =item titles - Set to 1 only if Webmin has title images for the language.
4941 =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.
4946 if (!@main::list_languages_cache) {
4949 open(LANG, "$root_directory/lang_list.txt");
4951 if (/^(\S+)\s+(.*)/) {
4952 my $l = { 'desc' => $2 };
4953 foreach $o (split(/,/, $1)) {
4954 if ($o =~ /^([^=]+)=(.*)$/) {
4958 $l->{'index'} = scalar(@rv);
4959 push(@main::list_languages_cache, $l);
4963 @main::list_languages_cache = sort { $a->{'desc'} cmp $b->{'desc'} }
4964 @main::list_languages_cache;
4966 return @main::list_languages_cache;
4969 =head2 read_env_file(file, &hash, [include-commented])
4971 Similar to Webmin's read_file function, but handles files containing shell
4972 environment variables formatted like :
4977 The file parameter is the full path to the file to read, and hash a Perl hash
4978 ref to read names and values into.
4984 &open_readfile(FILE, $_[0]) || return 0;
4987 # Remove start of line comments
4991 if (/^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*"(.*)"/i ||
4992 /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*'(.*)'/i ||
4993 /^\s*(export\s*)?([A-Za-z0-9_\.]+)\s*=\s*(.*)/i) {
5001 =head2 write_env_file(file, &hash, [export])
5003 Writes out a hash to a file in name='value' format, suitable for use in a shell
5004 script. The parameters are :
5006 =item file - Full path for a file to write to
5008 =item hash - Hash reference of names and values to write.
5010 =item export - If set to 1, preceed each variable setting with the word 'export'.
5015 my $exp = $_[2] ? "export " : "";
5016 &open_tempfile(FILE, ">$_[0]");
5017 foreach my $k (keys %{$_[1]}) {
5018 my $v = $_[1]->{$k};
5019 if ($v =~ /^\S+$/) {
5020 &print_tempfile(FILE, "$exp$k=$v\n");
5023 &print_tempfile(FILE, "$exp$k=\"$v\"\n");
5026 &close_tempfile(FILE);
5029 =head2 lock_file(filename, [readonly], [forcefile])
5031 Lock a file for exclusive access. If the file is already locked, spin
5032 until it is freed. Uses a .lock file, which is not 100% reliable, but seems
5033 to work OK. The parameters are :
5035 =item filename - File or directory to lock.
5037 =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.
5039 =item forcefile - Force the file to be considered as a real file and not a symlink for Webmin actions logging purposes.
5044 my $realfile = &translate_filename($_[0]);
5045 return 0 if (!$_[0] || defined($main::locked_file_list{$realfile}));
5046 my $no_lock = !&can_lock_file($realfile);
5047 my $lock_tries_count = 0;
5050 if (!$no_lock && open(LOCKING, "$realfile.lock")) {
5055 if ($no_lock || !$pid || !kill(0, $pid) || $pid == $$) {
5058 # Create the .lock file
5059 open(LOCKING, ">$realfile.lock") || return 0;
5060 my $lck = eval "flock(LOCKING, 2+4)";
5062 # Lock of lock file failed! Wait till later
5065 print LOCKING $$,"\n";
5066 eval "flock(LOCKING, 8)";
5069 $main::locked_file_list{$realfile} = int($_[1]);
5070 push(@main::temporary_files, "$realfile.lock");
5071 if (($gconfig{'logfiles'} || $gconfig{'logfullfiles'}) &&
5072 !&get_module_variable('$no_log_file_changes') &&
5074 # Grab a copy of this file for later diffing
5076 $main::locked_file_data{$realfile} = undef;
5078 $main::locked_file_type{$realfile} = 1;
5079 $main::locked_file_data{$realfile} = '';
5081 elsif (!$_[2] && ($lnk = readlink($realfile))) {
5082 $main::locked_file_type{$realfile} = 2;
5083 $main::locked_file_data{$realfile} = $lnk;
5085 elsif (open(ORIGFILE, $realfile)) {
5086 $main::locked_file_type{$realfile} = 0;
5087 $main::locked_file_data{$realfile} = '';
5090 $main::locked_file_data{$realfile} .=$_;
5099 if ($lock_tries_count++ > 5*60) {
5100 # Give up after 5 minutes
5101 &error(&text('elock_tries', "<tt>$realfile</tt>", 5));
5107 =head2 unlock_file(filename)
5109 Release a lock on a file taken out by lock_file. If Webmin actions logging of
5110 file changes is enabled, then at unlock file a diff will be taken between the
5111 old and new contents, and stored under /var/webmin/diffs when webmin_log is
5112 called. This can then be viewed in the Webmin Actions Log module.
5117 my $realfile = &translate_filename($_[0]);
5118 return if (!$_[0] || !defined($main::locked_file_list{$realfile}));
5119 unlink("$realfile.lock") if (&can_lock_file($realfile));
5120 delete($main::locked_file_list{$realfile});
5121 if (exists($main::locked_file_data{$realfile})) {
5122 # Diff the new file with the old
5124 my $lnk = readlink($realfile);
5125 my $type = -d _ ? 1 : $lnk ? 2 : 0;
5126 my $oldtype = $main::locked_file_type{$realfile};
5127 my $new = !defined($main::locked_file_data{$realfile});
5128 if ($new && !-e _) {
5129 # file doesn't exist, and never did! do nothing ..
5131 elsif ($new && $type == 1 || !$new && $oldtype == 1) {
5132 # is (or was) a directory ..
5133 if (-d _ && !defined($main::locked_file_data{$realfile})) {
5134 push(@main::locked_file_diff,
5135 { 'type' => 'mkdir', 'object' => $realfile });
5137 elsif (!-d _ && defined($main::locked_file_data{$realfile})) {
5138 push(@main::locked_file_diff,
5139 { 'type' => 'rmdir', 'object' => $realfile });
5142 elsif ($new && $type == 2 || !$new && $oldtype == 2) {
5143 # is (or was) a symlink ..
5144 if ($lnk && !defined($main::locked_file_data{$realfile})) {
5145 push(@main::locked_file_diff,
5146 { 'type' => 'symlink', 'object' => $realfile,
5149 elsif (!$lnk && defined($main::locked_file_data{$realfile})) {
5150 push(@main::locked_file_diff,
5151 { 'type' => 'unsymlink', 'object' => $realfile,
5152 'data' => $main::locked_file_data{$realfile} });
5154 elsif ($lnk ne $main::locked_file_data{$realfile}) {
5155 push(@main::locked_file_diff,
5156 { 'type' => 'resymlink', 'object' => $realfile,
5161 # is a file, or has changed type?!
5162 my ($diff, $delete_file);
5163 my $type = "modify";
5165 open(NEWFILE, ">$realfile");
5170 if (!defined($main::locked_file_data{$realfile})) {
5173 open(ORIGFILE, ">$realfile.webminorig");
5174 print ORIGFILE $main::locked_file_data{$realfile};
5176 $diff = &backquote_command(
5177 "diff ".quotemeta("$realfile.webminorig")." ".
5178 quotemeta($realfile)." 2>/dev/null");
5179 push(@main::locked_file_diff,
5180 { 'type' => $type, 'object' => $realfile,
5181 'data' => $diff } ) if ($diff);
5182 unlink("$realfile.webminorig");
5183 unlink($realfile) if ($delete_file);
5186 if ($gconfig{'logfullfiles'}) {
5187 # Add file details to list of those to fully log
5188 $main::orig_file_data{$realfile} ||=
5189 $main::locked_file_data{$realfile};
5190 $main::orig_file_type{$realfile} ||=
5191 $main::locked_file_type{$realfile};
5194 delete($main::locked_file_data{$realfile});
5195 delete($main::locked_file_type{$realfile});
5199 =head2 test_lock(file)
5201 Returns 1 if some file is currently locked, 0 if not.
5206 my $realfile = &translate_filename($_[0]);
5207 return 0 if (!$_[0]);
5208 return 1 if (defined($main::locked_file_list{$realfile}));
5209 return 0 if (!&can_lock_file($realfile));
5211 if (open(LOCKING, "$realfile.lock")) {
5216 return $pid && kill(0, $pid);
5219 =head2 unlock_all_files
5221 Unlocks all files locked by the current script.
5224 sub unlock_all_files
5226 foreach $f (keys %main::locked_file_list) {
5231 =head2 can_lock_file(file)
5233 Returns 1 if some file should be locked, based on the settings in the
5234 Webmin Configuration module. For internal use by lock_file only.
5239 if (&is_readonly_mode()) {
5240 return 0; # never lock in read-only mode
5242 elsif ($gconfig{'lockmode'} == 0) {
5245 elsif ($gconfig{'lockmode'} == 1) {
5249 # Check if under any of the directories
5251 foreach my $d (split(/\t+/, $gconfig{'lockdirs'})) {
5252 if (&same_file($d, $_[0]) ||
5253 &is_under_directory($d, $_[0])) {
5257 return $gconfig{'lockmode'} == 2 ? $match : !$match;
5261 =head2 webmin_log(action, type, object, ¶ms, [module], [host, script-on-host, client-ip])
5263 Log some action taken by a user. This is typically called at the end of a
5264 script, once all file changes are complete and all commands run. The
5267 =item action - A short code for the action being performed, like 'create'.
5269 =item type - A code for the type of object the action is performed to, like 'user'.
5271 =item object - A short name for the object, like 'joe' if the Unix user 'joe' was just created.
5273 =item params - A hash ref of additional information about the action.
5275 =item module - Name of the module in which the action was performed, which defaults to the current module.
5277 =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.
5279 =item script-on-host - Script name like create_user.cgi on the host the action was performed on.
5281 =item client-ip - IP address of the browser that performed the action.
5286 return if (!$gconfig{'log'} || &is_readonly_mode());
5287 my $m = $_[4] ? $_[4] : &get_module_name();
5289 if ($gconfig{'logclear'}) {
5290 # check if it is time to clear the log
5291 my @st = stat("$webmin_logfile.time");
5292 my $write_logtime = 0;
5294 if ($st[9]+$gconfig{'logtime'}*60*60 < time()) {
5295 # clear logfile and all diff files
5296 &unlink_file("$ENV{'WEBMIN_VAR'}/diffs");
5297 &unlink_file("$ENV{'WEBMIN_VAR'}/files");
5298 &unlink_file("$ENV{'WEBMIN_VAR'}/annotations");
5299 unlink($webmin_logfile);
5306 if ($write_logtime) {
5307 open(LOGTIME, ">$webmin_logfile.time");
5308 print LOGTIME time(),"\n";
5313 # If an action script directory is defined, call the appropriate scripts
5314 if ($gconfig{'action_script_dir'}) {
5315 my ($action, $type, $object) = ($_[0], $_[1], $_[2]);
5316 my ($basedir) = $gconfig{'action_script_dir'};
5318 for my $dir ($basedir/$type/$action, $basedir/$type, $basedir) {
5321 opendir(DIR, $dir) or die "Can't open $dir: $!";
5322 while (defined($file = readdir(DIR))) {
5323 next if ($file =~ /^\.\.?$/); # skip '.' and '..'
5324 if (-x "$dir/$file") {
5325 # Call a script notifying it of the action
5327 $ENV{'ACTION_MODULE'} = &get_module_name();
5328 $ENV{'ACTION_ACTION'} = $_[0];
5329 $ENV{'ACTION_TYPE'} = $_[1];
5330 $ENV{'ACTION_OBJECT'} = $_[2];
5331 $ENV{'ACTION_SCRIPT'} = $script_name;
5332 foreach my $p (keys %param) {
5333 $ENV{'ACTION_PARAM_'.uc($p)} = $param{$p};
5335 system("$dir/$file", @_,
5336 "<$null_file", ">$null_file", "2>&1");
5344 # should logging be done at all?
5345 return if ($gconfig{'logusers'} && &indexof($base_remote_user,
5346 split(/\s+/, $gconfig{'logusers'})) < 0);
5347 return if ($gconfig{'logmodules'} && &indexof($m,
5348 split(/\s+/, $gconfig{'logmodules'})) < 0);
5352 my @tm = localtime($now);
5353 my $script_name = $0 =~ /([^\/]+)$/ ? $1 : '-';
5354 my $id = sprintf "%d.%d.%d", $now, $$, $main::action_id_count;
5355 my $idprefix = substr($now, 0, 5);
5356 $main::action_id_count++;
5357 my $line = sprintf "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d] %s %s %s %s %s \"%s\" \"%s\" \"%s\"",
5358 $id, $tm[3], ucfirst($number_to_month_map{$tm[4]}), $tm[5]+1900,
5359 $tm[2], $tm[1], $tm[0],
5360 $remote_user || '-',
5361 $main::session_id || '-',
5362 $_[7] || $ENV{'REMOTE_HOST'} || '-',
5363 $m, $_[5] ? "$_[5]:$_[6]" : $script_name,
5364 $_[0], $_[1] ne '' ? $_[1] : '-', $_[2] ne '' ? $_[2] : '-';
5366 foreach my $k (sort { $a cmp $b } keys %{$_[3]}) {
5367 my $v = $_[3]->{$k};
5373 elsif (ref($v) eq 'ARRAY') {
5377 $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
5378 $line .= " $k='$vv'";
5382 foreach $vv (split(/\0/, $v)) {
5384 $vv =~ s/(['"\\\r\n\t\%])/sprintf("%%%2.2X",ord($1))/ge;
5385 $line .= " $k='$vv'";
5388 $param{$k} = join(" ", @pv);
5390 open(WEBMINLOG, ">>$webmin_logfile");
5391 print WEBMINLOG $line,"\n";
5393 if ($gconfig{'logperms'}) {
5394 chmod(oct($gconfig{'logperms'}), $webmin_logfile);
5397 chmod(0600, $webmin_logfile);
5400 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
5401 # Find and record the changes made to any locked files, or commands run
5403 mkdir("$ENV{'WEBMIN_VAR'}/diffs", 0700);
5404 foreach my $d (@main::locked_file_diff) {
5405 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$idprefix", 0700);
5406 mkdir("$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id", 0700);
5407 open(DIFFLOG, ">$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i");
5408 print DIFFLOG "$d->{'type'} $d->{'object'}\n";
5409 print DIFFLOG $d->{'data'};
5411 if ($d->{'input'}) {
5413 ">$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i.input");
5414 print DIFFLOG $d->{'input'};
5417 if ($gconfig{'logperms'}) {
5418 chmod(oct($gconfig{'logperms'}),
5419 "$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i",
5420 "$ENV{'WEBMIN_VAR'}/diffs/$idprefix/$id/$i.input");
5424 @main::locked_file_diff = undef;
5427 if ($gconfig{'logfullfiles'}) {
5428 # Save the original contents of any modified files
5430 mkdir("$ENV{'WEBMIN_VAR'}/files", 0700);
5431 foreach my $f (keys %main::orig_file_data) {
5432 mkdir("$ENV{'WEBMIN_VAR'}/files/$idprefix", 0700);
5433 mkdir("$ENV{'WEBMIN_VAR'}/files/$idprefix/$id", 0700);
5434 open(ORIGLOG, ">$ENV{'WEBMIN_VAR'}/files/$idprefix/$id/$i");
5435 if (!defined($main::orig_file_type{$f})) {
5436 print ORIGLOG -1," ",$f,"\n";
5439 print ORIGLOG $main::orig_file_type{$f}," ",$f,"\n";
5441 print ORIGLOG $main::orig_file_data{$f};
5443 if ($gconfig{'logperms'}) {
5444 chmod(oct($gconfig{'logperms'}),
5445 "$ENV{'WEBMIN_VAR'}/files/$idprefix/$id.$i");
5449 %main::orig_file_data = undef;
5450 %main::orig_file_type = undef;
5453 if ($miniserv::page_capture_out) {
5454 # Save the whole page output
5455 mkdir("$ENV{'WEBMIN_VAR'}/output", 0700);
5456 mkdir("$ENV{'WEBMIN_VAR'}/output/$idprefix", 0700);
5457 open(PAGEOUT, ">$ENV{'WEBMIN_VAR'}/output/$idprefix/$id");
5458 print PAGEOUT $miniserv::page_capture_out;
5460 if ($gconfig{'logperms'}) {
5461 chmod(oct($gconfig{'logperms'}),
5462 "$ENV{'WEBMIN_VAR'}/output/$idprefix/$id");
5464 $miniserv::page_capture_out = undef;
5468 if ($gconfig{'logsyslog'}) {
5469 eval 'use Sys::Syslog qw(:DEFAULT setlogsock);
5470 openlog(&get_product_name(), "cons,pid,ndelay", "daemon");
5471 setlogsock("inet");';
5473 # Syslog module is installed .. try to convert to a
5474 # human-readable form
5476 my $mod = &get_module_name();
5477 my $mdir = module_root_directory($mod);
5478 if (-r "$mdir/log_parser.pl") {
5479 &foreign_require($mod, "log_parser.pl");
5481 foreach my $k (keys %{$_[3]}) {
5482 my $v = $_[3]->{$k};
5483 if (ref($v) eq 'ARRAY') {
5484 $params{$k} = join("\0", @$v);
5490 $msg = &foreign_call($mod, "parse_webmin_log",
5491 $remote_user, $script_name,
5492 $_[0], $_[1], $_[2], \%params);
5493 $msg =~ s/<[^>]*>//g; # Remove tags
5495 elsif ($_[0] eq "_config_") {
5496 my %wtext = &load_language("webminlog");
5497 $msg = $wtext{'search_config'};
5499 $msg ||= "$_[0] $_[1] $_[2]";
5500 my %info = &get_module_info($m);
5501 eval { syslog("info", "%s", "[$info{'desc'}] $msg"); };
5506 =head2 additional_log(type, object, data, [input])
5508 Records additional log data for an upcoming call to webmin_log, such
5509 as a command that was run or SQL that was executed. Typically you will never
5510 need to call this function directory.
5515 if ($gconfig{'logfiles'} && !&get_module_variable('$no_log_file_changes')) {
5516 push(@main::locked_file_diff,
5517 { 'type' => $_[0], 'object' => $_[1], 'data' => $_[2],
5518 'input' => $_[3] } );
5522 =head2 webmin_debug_log(type, message)
5524 Write something to the Webmin debug log. For internal use only.
5527 sub webmin_debug_log
5529 my ($type, $msg) = @_;
5530 return 0 if (!$main::opened_debug_log);
5531 return 0 if ($gconfig{'debug_no'.$main::webmin_script_type});
5532 if ($gconfig{'debug_modules'}) {
5533 my @dmods = split(/\s+/, $gconfig{'debug_modules'});
5534 return 0 if (&indexof($main::initial_module_name, @dmods) < 0);
5537 eval 'use Time::HiRes qw(gettimeofday); ($now, $ms) = gettimeofday';
5539 my @tm = localtime($now);
5541 "%s [%2.2d/%s/%4.4d %2.2d:%2.2d:%2.2d.%6.6d] %s %s %s %s \"%s\"",
5542 $$, $tm[3], ucfirst($number_to_month_map{$tm[4]}), $tm[5]+1900,
5543 $tm[2], $tm[1], $tm[0], $ms,
5544 $remote_user || "-",
5545 $ENV{'REMOTE_HOST'} || "-",
5546 &get_module_name() || "-",
5549 seek(main::DEBUGLOG, 0, 2);
5550 print main::DEBUGLOG $line."\n";
5554 =head2 system_logged(command)
5556 Just calls the Perl system() function, but also logs the command run.
5561 if (&is_readonly_mode()) {
5562 print STDERR "Vetoing command $_[0]\n";
5565 my @realcmd = ( &translate_command($_[0]), @_[1..$#_] );
5566 my $cmd = join(" ", @realcmd);
5568 if ($cmd =~ s/(\s*&\s*)$//) {
5571 while($cmd =~ s/(\d*)(<|>)((\/(tmp|dev)\S+)|&\d+)\s*$//) { }
5572 $cmd =~ s/^\((.*)\)\s*$/$1/;
5574 &additional_log('exec', undef, $cmd);
5575 return system(@realcmd);
5578 =head2 backquote_logged(command)
5580 Executes a command and returns the output (like `command`), but also logs it.
5583 sub backquote_logged
5585 if (&is_readonly_mode()) {
5587 print STDERR "Vetoing command $_[0]\n";
5590 my $realcmd = &translate_command($_[0]);
5593 if ($cmd =~ s/(\s*&\s*)$//) {
5596 while($cmd =~ s/(\d*)(<|>)((\/(tmp\/.webmin|dev)\S+)|&\d+)\s*$//) { }
5597 $cmd =~ s/^\((.*)\)\s*$/$1/;
5599 &additional_log('exec', undef, $cmd);
5600 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
5604 =head2 backquote_with_timeout(command, timeout, safe?, [maxlines])
5606 Runs some command, waiting at most the given number of seconds for it to
5607 complete, and returns the output. The maxlines parameter sets the number
5608 of lines of output to capture. The safe parameter should be set to 1 if the
5609 command is safe for read-only mode users to run.
5612 sub backquote_with_timeout
5614 my $realcmd = &translate_command($_[0]);
5615 &webmin_debug_log('CMD', "cmd=$realcmd timeout=$_[1]")
5616 if ($gconfig{'debug_what_cmd'});
5618 my $pid = &open_execute_command(OUT, "($realcmd) <$null_file", 1, $_[2]);
5623 my $elapsed = time() - $start;
5624 last if ($elapsed > $_[1]);
5626 vec($rmask, fileno(OUT), 1) = 1;
5627 my $sel = select($rmask, undef, undef, $_[1] - $elapsed);
5628 last if (!$sel || $sel < 0);
5630 last if (!defined($line));
5633 if ($_[3] && $linecount >= $_[3]) {
5638 if (kill('TERM', $pid) && time() - $start >= $_[1]) {
5642 return wantarray ? ($out, $timed_out) : $out;
5645 =head2 backquote_command(command, safe?)
5647 Executes a command and returns the output (like `command`), subject to
5648 command translation. The safe parameter should be set to 1 if the command
5649 is safe for read-only mode users to run.
5652 sub backquote_command
5654 if (&is_readonly_mode() && !$_[1]) {
5655 print STDERR "Vetoing command $_[0]\n";
5659 my $realcmd = &translate_command($_[0]);
5660 &webmin_debug_log('CMD', "cmd=$realcmd") if ($gconfig{'debug_what_cmd'});
5664 =head2 kill_logged(signal, pid, ...)
5666 Like Perl's built-in kill function, but also logs the fact that some process
5667 was killed. On Windows, falls back to calling process.exe to terminate a
5673 return scalar(@_)-1 if (&is_readonly_mode());
5674 &webmin_debug_log('KILL', "signal=$_[0] pids=".join(" ", @_[1..@_-1]))
5675 if ($gconfig{'debug_what_procs'});
5676 &additional_log('kill', $_[0], join(" ", @_[1..@_-1])) if (@_ > 1);
5677 if ($gconfig{'os_type'} eq 'windows') {
5678 # Emulate some kills with process.exe
5679 my $arg = $_[0] eq "KILL" ? "-k" :
5680 $_[0] eq "TERM" ? "-q" :
5681 $_[0] eq "STOP" ? "-s" :
5682 $_[0] eq "CONT" ? "-r" : undef;
5684 foreach my $p (@_[1..@_-1]) {
5686 $ok ||= kill($_[0], $p);
5689 &execute_command("process $arg $p");
5701 =head2 rename_logged(old, new)
5703 Re-names a file and logs the rename. If the old and new files are on different
5704 filesystems, calls mv or the Windows rename function to do the job.
5709 &additional_log('rename', $_[0], $_[1]) if ($_[0] ne $_[1]);
5710 return &rename_file($_[0], $_[1]);
5713 =head2 rename_file(old, new)
5715 Renames a file or directory. If the old and new files are on different
5716 filesystems, calls mv or the Windows rename function to do the job.
5721 if (&is_readonly_mode()) {
5722 print STDERR "Vetoing rename from $_[0] to $_[1]\n";
5725 my $src = &translate_filename($_[0]);
5726 my $dst = &translate_filename($_[1]);
5727 &webmin_debug_log('RENAME', "src=$src dst=$dst")
5728 if ($gconfig{'debug_what_ops'});
5729 my $ok = rename($src, $dst);
5730 if (!$ok && $! !~ /permission/i) {
5731 # Try the mv command, in case this is a cross-filesystem rename
5732 if ($gconfig{'os_type'} eq 'windows') {
5733 # Need to use rename
5734 my $out = &backquote_command("rename ".quotemeta($_[0]).
5735 " ".quotemeta($_[1])." 2>&1");
5737 $! = $out if (!$ok);
5741 my $out = &backquote_command("mv ".quotemeta($_[0]).
5742 " ".quotemeta($_[1])." 2>&1");
5744 $! = $out if (!$ok);
5750 =head2 symlink_logged(src, dest)
5752 Create a symlink, and logs it. Effectively does the same thing as the Perl
5759 my $rv = &symlink_file($_[0], $_[1]);
5760 &unlock_file($_[1]);
5764 =head2 symlink_file(src, dest)
5766 Creates a soft link, unless in read-only mode. Effectively does the same thing
5767 as the Perl symlink function.
5772 if (&is_readonly_mode()) {
5773 print STDERR "Vetoing symlink from $_[0] to $_[1]\n";
5776 my $src = &translate_filename($_[0]);
5777 my $dst = &translate_filename($_[1]);
5778 &webmin_debug_log('SYMLINK', "src=$src dst=$dst")
5779 if ($gconfig{'debug_what_ops'});
5780 return symlink($src, $dst);
5783 =head2 link_file(src, dest)
5785 Creates a hard link, unless in read-only mode. The existing new link file
5786 will be deleted if necessary. Effectively the same as Perl's link function.
5791 if (&is_readonly_mode()) {
5792 print STDERR "Vetoing link from $_[0] to $_[1]\n";
5795 my $src = &translate_filename($_[0]);
5796 my $dst = &translate_filename($_[1]);
5797 &webmin_debug_log('LINK', "src=$src dst=$dst")
5798 if ($gconfig{'debug_what_ops'});
5799 unlink($dst); # make sure link works
5800 return link($src, $dst);
5803 =head2 make_dir(dir, perms, recursive)
5805 Creates a directory and sets permissions on it, unless in read-only mode.
5806 The perms parameter sets the octal permissions to apply, which unlike Perl's
5807 mkdir will really get set. The recursive flag can be set to 1 to have the
5808 function create parent directories too.
5813 my ($dir, $perms, $recur) = @_;
5814 if (&is_readonly_mode()) {
5815 print STDERR "Vetoing directory $dir\n";
5818 $dir = &translate_filename($dir);
5819 my $exists = -d $dir ? 1 : 0;
5820 return 1 if ($exists && $recur); # already exists
5821 &webmin_debug_log('MKDIR', $dir) if ($gconfig{'debug_what_ops'});
5822 my $rv = mkdir($dir, $perms);
5823 if (!$rv && $recur) {
5824 # Failed .. try mkdir -p
5825 my $param = $gconfig{'os_type'} eq 'windows' ? "" : "-p";
5826 my $ex = &execute_command("mkdir $param "."e_path($dir));
5832 chmod($perms, $dir);
5837 =head2 set_ownership_permissions(user, group, perms, file, ...)
5839 Sets the user, group owner and permissions on some files. The parameters are :
5841 =item user - UID or username to change the file owner to. If undef, then the owner is not changed.
5843 =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.
5845 =item perms - Octal permissions set to set on the file. If undef, they are left alone.
5847 =item file - One or more files or directories to modify.
5850 sub set_ownership_permissions
5852 my ($user, $group, $perms, @files) = @_;
5853 if (&is_readonly_mode()) {
5854 print STDERR "Vetoing permission changes on ",join(" ", @files),"\n";
5857 @files = map { &translate_filename($_) } @files;
5858 if ($gconfig{'debug_what_ops'}) {
5859 foreach my $f (@files) {
5860 &webmin_debug_log('PERMS',
5861 "file=$f user=$user group=$group perms=$perms");
5865 if (defined($user)) {
5866 my $uid = $user !~ /^\d+$/ ? getpwnam($user) : $user;
5868 if (defined($group)) {
5869 $gid = $group !~ /^\d+$/ ? getgrnam($group) : $group;
5872 my @uinfo = getpwuid($uid);
5875 $rv = chown($uid, $gid, @files);
5877 if ($rv && defined($perms)) {
5878 $rv = chmod($perms, @files);
5883 =head2 unlink_logged(file, ...)
5885 Like Perl's unlink function, but locks the files beforehand and un-locks them
5886 after so that the deletion is logged by Webmin.
5892 foreach my $f (@_) {
5893 if (!&test_lock($f)) {
5898 my @rv = &unlink_file(@_);
5899 foreach my $f (@_) {
5904 return wantarray ? @rv : $rv[0];
5907 =head2 unlink_file(file, ...)
5909 Deletes some files or directories. Like Perl's unlink function, but also
5910 recursively deletes directories with the rm command if needed.
5915 return 1 if (&is_readonly_mode());
5918 foreach my $f (@_) {
5919 &unflush_file_lines($f);
5920 my $realf = &translate_filename($f);
5921 &webmin_debug_log('UNLINK', $realf) if ($gconfig{'debug_what_ops'});
5923 if (!rmdir($realf)) {
5925 if ($gconfig{'os_type'} eq 'windows') {
5926 # Call del and rmdir commands
5929 my $out = `del /q "$qm" 2>&1`;
5931 $out = `rmdir "$qm" 2>&1`;
5936 my $qm = quotemeta($realf);
5937 $out = `rm -rf $qm 2>&1`;
5946 if (!unlink($realf)) {
5952 return wantarray ? ($rv, $err) : $rv;
5955 =head2 copy_source_dest(source, dest)
5957 Copy some file or directory to a new location. Returns 1 on success, or 0
5958 on failure - also sets $! on failure. If the source is a directory, uses
5959 piped tar commands to copy a whole directory structure including permissions
5963 sub copy_source_dest
5965 return (1, undef) if (&is_readonly_mode());
5966 my ($src, $dst) = @_;
5969 &webmin_debug_log('COPY', "src=$src dst=$dst")
5970 if ($gconfig{'debug_what_ops'});
5971 if ($gconfig{'os_type'} eq 'windows') {
5972 # No tar or cp on windows, so need to use copy command
5976 $out = &backquote_logged("xcopy \"$src\" \"$dst\" /Y /E /I 2>&1");
5979 $out = &backquote_logged("copy /Y \"$src\" \"$dst\" 2>&1");
5987 # A directory .. need to copy with tar command
5988 my @st = stat($src);
5991 &set_ownership_permissions($st[4], $st[5], $st[2], $dst);
5992 $out = &backquote_logged("(cd ".quotemeta($src)." ; tar cf - . | (cd ".quotemeta($dst)." ; tar xf -)) 2>&1");
5999 # Can just copy with cp
6000 my $out = &backquote_logged("cp -p ".quotemeta($src).
6001 " ".quotemeta($dst)." 2>&1");
6007 return wantarray ? ($ok, $err) : $ok;
6010 =head2 remote_session_name(host|&server)
6012 Generates a session ID for some server. For this server, this will always
6013 be an empty string. For a server object it will include the hostname and
6014 port and PID. For a server name, it will include the hostname and PID. For
6018 sub remote_session_name
6020 return ref($_[0]) && $_[0]->{'host'} && $_[0]->{'port'} ?
6021 "$_[0]->{'host'}:$_[0]->{'port'}.$$" :
6022 $_[0] eq "" || ref($_[0]) && $_[0]->{'id'} == 0 ? "" :
6023 ref($_[0]) ? "" : "$_[0].$$";
6026 =head2 remote_foreign_require(server, module, file)
6028 Connects to rpc.cgi on a remote webmin server and have it open a session
6029 to a process that will actually do the require and run functions. This is the
6030 equivalent for foreign_require, but for a remote Webmin system. The server
6031 parameter can either be a hostname of a system registered in the Webmin
6032 Servers Index module, or a hash reference for a system from that module.
6035 sub remote_foreign_require
6037 my $call = { 'action' => 'require',
6040 my $sn = &remote_session_name($_[0]);
6041 if ($remote_session{$sn}) {
6042 $call->{'session'} = $remote_session{$sn};
6045 $call->{'newsession'} = 1;
6047 my $rv = &remote_rpc_call($_[0], $call);
6048 if ($rv->{'session'}) {
6049 $remote_session{$sn} = $rv->{'session'};
6050 $remote_session_server{$sn} = $_[0];
6054 =head2 remote_foreign_call(server, module, function, [arg]*)
6056 Call a function on a remote server. Must have been setup first with
6057 remote_foreign_require for the same server and module. Equivalent to
6058 foreign_call, but with the extra server parameter to specify the remote
6062 sub remote_foreign_call
6064 return undef if (&is_readonly_mode());
6065 my $sn = &remote_session_name($_[0]);
6066 return &remote_rpc_call($_[0], { 'action' => 'call',
6069 'session' => $remote_session{$sn},
6070 'args' => [ @_[3 .. $#_] ] } );
6073 =head2 remote_foreign_check(server, module, [api-only])
6075 Checks if some module is installed and supported on a remote server. Equivilant
6076 to foreign_check, but for the remote Webmin system specified by the server
6080 sub remote_foreign_check
6082 return &remote_rpc_call($_[0], { 'action' => 'check',
6087 =head2 remote_foreign_config(server, module)
6089 Gets the configuration for some module from a remote server, as a hash.
6090 Equivalent to foreign_config, but for a remote system.
6093 sub remote_foreign_config
6095 return &remote_rpc_call($_[0], { 'action' => 'config',
6096 'module' => $_[1] });
6099 =head2 remote_eval(server, module, code)
6101 Evaluates some perl code in the context of a module on a remote webmin server.
6102 The server parameter must be the hostname of a remote system, module must
6103 be a module directory name, and code a string of Perl code to run. This can
6104 only be called after remote_foreign_require for the same server and module.
6109 return undef if (&is_readonly_mode());
6110 my $sn = &remote_session_name($_[0]);
6111 return &remote_rpc_call($_[0], { 'action' => 'eval',
6114 'session' => $remote_session{$sn} });
6117 =head2 remote_write(server, localfile, [remotefile], [remotebasename])
6119 Transfers some local file to another server via Webmin's RPC protocol, and
6120 returns the resulting remote filename. If the remotefile parameter is given,
6121 that is the destination filename which will be used. Otherwise a randomly
6122 selected temporary filename will be used, and returned by the function.
6127 return undef if (&is_readonly_mode());
6129 my $sn = &remote_session_name($_[0]);
6130 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
6131 # Copy data over TCP connection
6132 my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpwrite',
6134 'name' => $_[3] } );
6136 my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
6137 &open_socket($serv || "localhost", $rv->[1], TWRITE, \$error);
6138 return &$main::remote_error_handler("Failed to transfer file : $error")
6141 while(read(FILE, $got, 1024) > 0) {
6145 shutdown(TWRITE, 1);
6147 if ($error && $error !~ /^OK/) {
6148 # Got back an error!
6149 return &$main::remote_error_handler("Failed to transfer file : $error");
6155 # Just pass file contents as parameters
6157 while(read(FILE, $got, 1024) > 0) {
6161 return &remote_rpc_call($_[0], { 'action' => 'write',
6164 'session' => $remote_session{$sn} });
6168 =head2 remote_read(server, localfile, remotefile)
6170 Transfers a file from a remote server to this system, using Webmin's RPC
6171 protocol. The server parameter must be the hostname of a system registered
6172 in the Webmin Servers Index module, localfile is the destination path on this
6173 system, and remotefile is the file to fetch from the remote server.
6178 my $sn = &remote_session_name($_[0]);
6179 if (!$_[0] || $remote_server_version{$sn} >= 0.966) {
6180 # Copy data over TCP connection
6181 my $rv = &remote_rpc_call($_[0], { 'action' => 'tcpread',
6182 'file' => $_[2] } );
6184 return &$main::remote_error_handler("Failed to transfer file : $rv->[1]");
6187 my $serv = ref($_[0]) ? $_[0]->{'host'} : $_[0];
6188 &open_socket($serv || "localhost", $rv->[1], TREAD, \$error);
6189 return &$main::remote_error_handler("Failed to transfer file : $error")
6192 open(FILE, ">$_[1]");
6193 while(read(TREAD, $got, 1024) > 0) {
6200 # Just get data as return value
6201 my $d = &remote_rpc_call($_[0], { 'action' => 'read',
6203 'session' => $remote_session{$sn} });
6204 open(FILE, ">$_[1]");
6210 =head2 remote_finished
6212 Close all remote sessions. This happens automatically after a while
6213 anyway, but this function should be called to clean things up faster.
6218 foreach my $sn (keys %remote_session) {
6219 my $server = $remote_session_server{$sn};
6220 &remote_rpc_call($server, { 'action' => 'quit',
6221 'session' => $remote_session{$sn} } );
6222 delete($remote_session{$sn});
6223 delete($remote_session_server{$sn});
6225 foreach my $fh (keys %fast_fh_cache) {
6227 delete($fast_fh_cache{$fh});
6231 =head2 remote_error_setup(&function)
6233 Sets a function to be called instead of &error when a remote RPC operation
6234 fails. Useful if you want to have more control over your remote operations.
6237 sub remote_error_setup
6239 $main::remote_error_handler = $_[0] || \&error;
6242 =head2 remote_rpc_call(server, &structure)
6244 Calls rpc.cgi on some server and passes it a perl structure (hash,array,etc)
6245 and then reads back a reply structure. This is mainly for internal use only,
6246 and is called by the other remote_* functions.
6252 my $sn = &remote_session_name($_[0]); # Will be undef for local connection
6254 # Server structure was given
6256 $serv->{'user'} || $serv->{'id'} == 0 ||
6257 return &$main::remote_error_handler(
6258 "No Webmin login set for server");
6261 # lookup the server in the webmin servers module if needed
6262 if (!%main::remote_servers_cache) {
6263 &foreign_require("servers", "servers-lib.pl");
6264 foreach $s (&foreign_call("servers", "list_servers")) {
6265 $main::remote_servers_cache{$s->{'host'}} = $s;
6266 $main::remote_servers_cache{$s->{'host'}.":".$s->{'port'}} = $s;
6269 $serv = $main::remote_servers_cache{$_[0]};
6270 $serv || return &$main::remote_error_handler(
6271 "No Webmin Servers entry for $_[0]");
6272 $serv->{'user'} || return &$main::remote_error_handler(
6273 "No login set for server $_[0]");
6275 my $ip = $serv->{'ip'} || $serv->{'host'};
6277 # Work out the username and password
6279 if ($serv->{'sameuser'}) {
6280 $user = $remote_user;
6281 defined($main::remote_pass) || return &$main::remote_error_handler(
6282 "Password for this server is not available");
6283 $pass = $main::remote_pass;
6286 $user = $serv->{'user'};
6287 $pass = $serv->{'pass'};
6290 if ($serv->{'fast'} || !$sn) {
6291 # Make TCP connection call to fastrpc.cgi
6292 if (!$fast_fh_cache{$sn} && $sn) {
6293 # Need to open the connection
6294 my $con = &make_http_connection(
6295 $ip, $serv->{'port'}, $serv->{'ssl'},
6296 "POST", "/fastrpc.cgi");
6297 return &$main::remote_error_handler(
6298 "Failed to connect to $serv->{'host'} : $con")
6300 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
6301 &write_http_connection($con, "User-agent: Webmin\r\n");
6302 my $auth = &encode_base64("$user:$pass");
6304 &write_http_connection($con, "Authorization: basic $auth\r\n");
6305 &write_http_connection($con, "Content-length: ",
6306 length($tostr),"\r\n");
6307 &write_http_connection($con, "\r\n");
6308 &write_http_connection($con, $tostr);
6310 # read back the response
6311 my $line = &read_http_connection($con);
6312 $line =~ tr/\r\n//d;
6313 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
6314 return &$main::remote_error_handler("Login to RPC server as $user rejected");
6316 $line =~ /^HTTP\/1\..\s+200\s+/ ||
6317 return &$main::remote_error_handler("HTTP error : $line");
6319 $line = &read_http_connection($con);
6320 $line =~ tr/\r\n//d;
6322 $line = &read_http_connection($con);
6323 if ($line =~ /^0\s+(.*)/) {
6324 return &$main::remote_error_handler("RPC error : $1");
6326 elsif ($line =~ /^1\s+(\S+)\s+(\S+)\s+(\S+)/ ||
6327 $line =~ /^1\s+(\S+)\s+(\S+)/) {
6328 # Started ok .. connect and save SID
6329 &close_http_connection($con);
6330 my ($port, $sid, $version, $error) = ($1, $2, $3);
6331 &open_socket($ip, $port, $sid, \$error);
6332 return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error")
6334 $fast_fh_cache{$sn} = $sid;
6335 $remote_server_version{$sn} = $version;
6338 while($stuff = &read_http_connection($con)) {
6341 return &$main::remote_error_handler("Bad response from fastrpc.cgi : $line");
6344 elsif (!$fast_fh_cache{$sn}) {
6345 # Open the connection by running fastrpc.cgi locally
6346 pipe(RPCOUTr, RPCOUTw);
6350 open(STDOUT, ">&RPCOUTw");
6354 $ENV{'REQUEST_METHOD'} = 'GET';
6355 $ENV{'SCRIPT_NAME'} = '/fastrpc.cgi';
6356 $ENV{'SERVER_ROOT'} ||= $root_directory;
6358 if ($base_remote_user ne 'root' &&
6359 $base_remote_user ne 'admin') {
6360 # Need to fake up a login for the CGI!
6361 &read_acl(undef, \%acl, [ 'root' ]);
6362 $ENV{'BASE_REMOTE_USER'} =
6363 $ENV{'REMOTE_USER'} =
6364 $acl{'root'} ? 'root' : 'admin';
6366 delete($ENV{'FOREIGN_MODULE_NAME'});
6367 delete($ENV{'FOREIGN_ROOT_DIRECTORY'});
6368 chdir($root_directory);
6369 if (!exec("$root_directory/fastrpc.cgi")) {
6370 print "exec failed : $!\n";
6377 ($line = <RPCOUTr>) =~ tr/\r\n//d;
6381 if ($line =~ /^0\s+(.*)/) {
6382 return &$main::remote_error_handler("RPC error : $2");
6384 elsif ($line =~ /^1\s+(\S+)\s+(\S+)/) {
6385 # Started ok .. connect and save SID
6387 my ($port, $sid, $error) = ($1, $2, undef);
6388 &open_socket("localhost", $port, $sid, \$error);
6389 return &$main::remote_error_handler("Failed to connect to fastrpc.cgi : $error") if ($error);
6390 $fast_fh_cache{$sn} = $sid;
6397 &error("Bad response from fastrpc.cgi : $line");
6400 # Got a connection .. send off the request
6401 my $fh = $fast_fh_cache{$sn};
6402 my $tostr = &serialise_variable($_[1]);
6403 print $fh length($tostr)," $fh\n";
6407 return &$main::remote_error_handler(
6408 "Error reading response length from fastrpc.cgi : $!")
6410 my $rlen = int($rstr);
6411 my ($fromstr, $got);
6412 while(length($fromstr) < $rlen) {
6413 return &$main::remote_error_handler(
6414 "Failed to read from fastrpc.cgi : $!")
6415 if (read($fh, $got, $rlen - length($fromstr)) <= 0);
6418 my $from = &unserialise_variable($fromstr);
6420 # No response at all
6421 return &$main::remote_error_handler("Remote Webmin error");
6423 elsif (ref($from) ne 'HASH') {
6425 return &$main::remote_error_handler(
6426 "Invalid remote Webmin response : $from");
6428 elsif (!$from->{'status'}) {
6430 $from->{'rv'} =~ s/\s+at\s+(\S+)\s+line\s+(\d+)(,\s+<\S+>\s+line\s+(\d+))?//;
6431 return &$main::remote_error_handler($from->{'rv'});
6433 if (defined($from->{'arv'})) {
6434 return @{$from->{'arv'}};
6437 return $from->{'rv'};
6441 # Call rpc.cgi on remote server
6442 my $tostr = &serialise_variable($_[1]);
6444 my $con = &make_http_connection($ip, $serv->{'port'},
6445 $serv->{'ssl'}, "POST", "/rpc.cgi");
6446 return &$main::remote_error_handler("Failed to connect to $serv->{'host'} : $con") if (!ref($con));
6448 &write_http_connection($con, "Host: $serv->{'host'}\r\n");
6449 &write_http_connection($con, "User-agent: Webmin\r\n");
6450 my $auth = &encode_base64("$user:$pass");
6452 &write_http_connection($con, "Authorization: basic $auth\r\n");
6453 &write_http_connection($con, "Content-length: ",length($tostr),"\r\n");
6454 &write_http_connection($con, "\r\n");
6455 &write_http_connection($con, $tostr);
6457 # read back the response
6458 my $line = &read_http_connection($con);
6459 $line =~ tr/\r\n//d;
6460 if ($line =~ /^HTTP\/1\..\s+401\s+/) {
6461 return &$main::remote_error_handler("Login to RPC server as $user rejected");
6463 $line =~ /^HTTP\/1\..\s+200\s+/ || return &$main::remote_error_handler("RPC HTTP error : $line");
6465 $line = &read_http_connection($con);
6466 $line =~ tr/\r\n//d;
6469 while($line = &read_http_connection($con)) {
6473 my $from = &unserialise_variable($fromstr);
6474 return &$main::remote_error_handler("Invalid RPC login to $serv->{'host'}") if (!$from->{'status'});
6475 if (defined($from->{'arv'})) {
6476 return @{$from->{'arv'}};
6479 return $from->{'rv'};
6484 =head2 remote_multi_callback(&servers, parallel, &function, arg|&args, &returns, &errors, [module, library])
6486 Executes some function in parallel on multiple servers at once. Fills in
6487 the returns and errors arrays respectively. If the module and library
6488 parameters are given, that module is remotely required on the server first,
6489 to check if it is connectable. The parameters are :
6491 =item servers - A list of Webmin system hash references.
6493 =item parallel - Number of parallel operations to perform.
6495 =item function - Reference to function to call for each system.
6497 =item args - Additional parameters to the function.
6499 =item returns - Array ref to place return values into, in same order as servers.
6501 =item errors - Array ref to place error messages into.
6503 =item module - Optional module to require on the remote system first.
6505 =item library - Optional library to require in the module.
6508 sub remote_multi_callback
6510 my ($servs, $parallel, $func, $args, $rets, $errs, $mod, $lib) = @_;
6511 &remote_error_setup(\&remote_multi_callback_error);
6513 # Call the functions
6515 foreach my $g (@$servs) {
6521 $remote_multi_callback_err = undef;
6523 # Require the remote lib
6524 &remote_foreign_require($g->{'host'}, $mod, $lib);
6525 if ($remote_multi_callback_err) {
6526 # Failed .. return error
6527 print $wh &serialise_variable(
6528 [ undef, $remote_multi_callback_err ]);
6534 my $a = ref($args) ? $args->[$p] : $args;
6535 my $rv = &$func($g, $a);
6538 print $wh &serialise_variable(
6539 [ $rv, $remote_multi_callback_err ]);
6547 # Read back the results
6549 foreach my $g (@$servs) {
6553 $errs->[$p] = "Failed to read response from $g->{'host'}";
6556 my $rv = &unserialise_variable($line);
6558 $rets->[$p] = $rv->[0];
6559 $errs->[$p] = $rv->[1];
6564 &remote_error_setup(undef);
6567 sub remote_multi_callback_error
6569 $remote_multi_callback_err = $_[0];
6572 =head2 serialise_variable(variable)
6574 Converts some variable (maybe a scalar, hash ref, array ref or scalar ref)
6575 into a url-encoded string. In the cases of arrays and hashes, it is recursively
6576 called on each member to serialize the entire object.
6579 sub serialise_variable
6581 if (!defined($_[0])) {
6587 $rv = &urlize($_[0]);
6589 elsif ($r eq 'SCALAR') {
6590 $rv = &urlize(${$_[0]});
6592 elsif ($r eq 'ARRAY') {
6593 $rv = join(",", map { &urlize(&serialise_variable($_)) } @{$_[0]});
6595 elsif ($r eq 'HASH') {
6596 $rv = join(",", map { &urlize(&serialise_variable($_)).",".
6597 &urlize(&serialise_variable($_[0]->{$_})) }
6600 elsif ($r eq 'REF') {
6601 $rv = &serialise_variable(${$_[0]});
6603 elsif ($r eq 'CODE') {
6608 # An object - treat as a hash
6609 $r = "OBJECT ".&urlize($r);
6610 $rv = join(",", map { &urlize(&serialise_variable($_)).",".
6611 &urlize(&serialise_variable($_[0]->{$_})) }
6614 return ($r ? $r : 'VAL').",".$rv;
6617 =head2 unserialise_variable(string)
6619 Converts a string created by serialise_variable() back into the original
6620 scalar, hash ref, array ref or scalar ref. If the original variable was a Perl
6621 object, the same class is used on this system, if available.
6624 sub unserialise_variable
6626 my @v = split(/,/, $_[0]);
6628 if ($v[0] eq 'VAL') {
6629 @v = split(/,/, $_[0], -1);
6630 $rv = &un_urlize($v[1]);
6632 elsif ($v[0] eq 'SCALAR') {
6633 local $r = &un_urlize($v[1]);
6636 elsif ($v[0] eq 'ARRAY') {
6638 for(my $i=1; $i<@v; $i++) {
6639 push(@$rv, &unserialise_variable(&un_urlize($v[$i])));
6642 elsif ($v[0] eq 'HASH') {
6644 for(my $i=1; $i<@v; $i+=2) {
6645 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6646 &unserialise_variable(&un_urlize($v[$i+1]));
6649 elsif ($v[0] eq 'REF') {
6650 local $r = &unserialise_variable($v[1]);
6653 elsif ($v[0] eq 'UNDEF') {
6656 elsif ($v[0] =~ /^OBJECT\s+(.*)$/) {
6657 # An object hash that we have to re-bless
6660 for(my $i=1; $i<@v; $i+=2) {
6661 $rv->{&unserialise_variable(&un_urlize($v[$i]))} =
6662 &unserialise_variable(&un_urlize($v[$i+1]));
6670 =head2 other_groups(user)
6672 Returns a list of secondary groups a user is a member of, as a list of
6681 while(my @g = getgrent()) {
6682 my @m = split(/\s+/, $g[3]);
6683 push(@rv, $g[2]) if (&indexof($user, @m) >= 0);
6685 endgrent() if ($gconfig{'os_type'} ne 'hpux');
6689 =head2 date_chooser_button(dayfield, monthfield, yearfield)
6691 Returns HTML for a button that pops up a data chooser window. The parameters
6694 =item dayfield - Name of the text field to place the day of the month into.
6696 =item monthfield - Name of the select field to select the month of the year in, indexed from 1.
6698 =item yearfield - Name of the text field to place the year into.
6701 sub date_chooser_button
6703 return &theme_date_chooser_button(@_)
6704 if (defined(&theme_date_chooser_button));
6705 my ($w, $h) = (250, 225);
6706 if ($gconfig{'db_sizedate'}) {
6707 ($w, $h) = split(/x/, $gconfig{'db_sizedate'});
6709 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";
6712 =head2 help_file(module, file)
6714 Returns the path to a module's help file of some name, typically under the
6715 help directory with a .html extension.
6720 my $mdir = &module_root_directory($_[0]);
6721 my $dir = "$mdir/help";
6722 foreach my $o (@lang_order_list) {
6723 my $lang = "$dir/$_[1].$o.html";
6724 return $lang if (-r $lang);
6726 return "$dir/$_[1].html";
6731 Seeds the random number generator, if not already done in this script. On Linux
6732 this makes use of the current time, process ID and a read from /dev/urandom.
6733 On other systems, only the current time and process ID are used.
6738 if (!$main::done_seed_random) {
6739 if (open(RANDOM, "/dev/urandom")) {
6741 read(RANDOM, $buf, 4);
6743 srand(time() ^ $$ ^ $buf);
6748 $main::done_seed_random = 1;
6752 =head2 disk_usage_kb(directory)
6754 Returns the number of kB used by some directory and all subdirs. Implemented
6755 by calling the C<du -k> command.
6760 my $dir = &translate_filename($_[0]);
6762 my $ex = &execute_command("du -sk ".quotemeta($dir), undef, \$out, undef, 0, 1);
6764 &execute_command("du -s ".quotemeta($dir), undef, \$out, undef, 0, 1);
6766 return $out =~ /^([0-9]+)/ ? $1 : "???";
6769 =head2 recursive_disk_usage(directory, [skip-regexp], [only-regexp])
6771 Returns the number of bytes taken up by all files in some directory and all
6772 sub-directories, by summing up their lengths. The disk_usage_kb is more
6773 reflective of reality, as the filesystem typically pads file sizes to 1k or
6777 sub recursive_disk_usage
6779 my $dir = &translate_filename($_[0]);
6786 my @st = stat($dir);
6792 my @files = readdir(DIR);
6794 foreach my $f (@files) {
6795 next if ($f eq "." || $f eq "..");
6796 next if ($skip && $f =~ /$skip/);
6797 next if ($only && $f !~ /$only/);
6798 $rv += &recursive_disk_usage("$dir/$f", $skip, $only);
6804 =head2 help_search_link(term, [ section, ... ] )
6806 Returns HTML for a link to the man module for searching local and online
6807 docs for various search terms. The term parameter can either be a single
6808 word like 'bind', or a space-separated list of words. This function is typically
6809 used by modules that want to refer users to additional documentation in man
6810 pages or local system doc files.
6813 sub help_search_link
6815 if (&foreign_available("man") && !$tconfig{'nosearch'}) {
6816 my $for = &urlize(shift(@_));
6817 return "<a href='$gconfig{'webprefix'}/man/search.cgi?".
6818 join("&", map { "section=$_" } @_)."&".
6819 "for=$for&exact=1&check=".&get_module_name()."'>".
6820 $text{'helpsearch'}."</a>\n";
6827 =head2 make_http_connection(host, port, ssl, method, page, [&headers])
6829 Opens a connection to some HTTP server, maybe through a proxy, and returns
6830 a handle object. The handle can then be used to send additional headers
6831 and read back a response. If anything goes wrong, returns an error string.
6832 The parameters are :
6834 =item host - Hostname or IP address of the webserver to connect to.
6836 =item port - HTTP port number to connect to.
6838 =item ssl - Set to 1 to connect in SSL mode.
6840 =item method - HTTP method, like GET or POST.
6842 =item page - Page to request on the webserver, like /foo/index.html
6844 =item headers - Array ref of additional HTTP headers, each of which is a 2-element array ref.
6847 sub make_http_connection
6849 my ($host, $port, $ssl, $method, $page, $headers) = @_;
6852 foreach my $h (@$headers) {
6853 $htxt .= $h->[0].": ".$h->[1]."\r\n";
6857 if (&is_readonly_mode()) {
6858 return "HTTP connections not allowed in readonly mode";
6860 my $rv = { 'fh' => time().$$ };
6863 eval "use Net::SSLeay";
6864 $@ && return $text{'link_essl'};
6865 eval "Net::SSLeay::SSLeay_add_ssl_algorithms()";
6866 eval "Net::SSLeay::load_error_strings()";
6867 $rv->{'ssl_ctx'} = Net::SSLeay::CTX_new() ||
6868 return "Failed to create SSL context";
6869 $rv->{'ssl_con'} = Net::SSLeay::new($rv->{'ssl_ctx'}) ||
6870 return "Failed to create SSL connection";
6872 if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6873 !&no_proxy($host)) {
6876 &open_socket($1, $2, $rv->{'fh'}, \$error);
6879 my $fh = $rv->{'fh'};
6880 print $fh "CONNECT $host:$port HTTP/1.0\r\n";
6881 if ($gconfig{'proxy_user'}) {
6882 my $auth = &encode_base64(
6883 "$gconfig{'proxy_user'}:".
6884 "$gconfig{'proxy_pass'}");
6885 $auth =~ tr/\r\n//d;
6886 print $fh "Proxy-Authorization: Basic $auth\r\n";
6890 if ($line =~ /^HTTP(\S+)\s+(\d+)\s+(.*)/) {
6891 return "Proxy error : $3" if ($2 != 200);
6894 return "Proxy error : $line";
6899 elsif (!$gconfig{'proxy_fallback'}) {
6900 # Connection to proxy failed - give up
6907 &open_socket($host, $port, $rv->{'fh'}, \$error);
6908 return $error if ($error);
6910 Net::SSLeay::set_fd($rv->{'ssl_con'}, fileno($rv->{'fh'}));
6911 Net::SSLeay::connect($rv->{'ssl_con'}) ||
6912 return "SSL connect() failed";
6913 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6914 Net::SSLeay::write($rv->{'ssl_con'}, $rtxt);
6917 # Plain HTTP request
6919 if ($gconfig{'http_proxy'} =~ /^http:\/\/(\S+):(\d+)/ &&
6920 !&no_proxy($host)) {
6923 &open_socket($1, $2, $rv->{'fh'}, \$error);
6927 my $fh = $rv->{'fh'};
6928 my $rtxt = $method." ".
6929 "http://$host:$port$page HTTP/1.0\r\n";
6930 if ($gconfig{'proxy_user'}) {
6931 my $auth = &encode_base64(
6932 "$gconfig{'proxy_user'}:".
6933 "$gconfig{'proxy_pass'}");
6934 $auth =~ tr/\r\n//d;
6935 $rtxt .= "Proxy-Authorization: Basic $auth\r\n";
6940 elsif (!$gconfig{'proxy_fallback'}) {
6945 # Connecting directly
6947 &open_socket($host, $port, $rv->{'fh'}, \$error);
6948 return $error if ($error);
6949 my $fh = $rv->{'fh'};
6950 my $rtxt = "$method $page HTTP/1.0\r\n".$htxt;
6957 =head2 read_http_connection(&handle, [bytes])
6959 Reads either one line or up to the specified number of bytes from the handle,
6960 originally supplied by make_http_connection.
6963 sub read_http_connection
6967 if ($h->{'ssl_con'}) {
6970 while(($idx = index($h->{'buffer'}, "\n")) < 0) {
6971 # need to read more..
6972 if (!($more = Net::SSLeay::read($h->{'ssl_con'}))) {
6974 $rv = $h->{'buffer'};
6975 delete($h->{'buffer'});
6978 $h->{'buffer'} .= $more;
6980 $rv = substr($h->{'buffer'}, 0, $idx+1);
6981 $h->{'buffer'} = substr($h->{'buffer'}, $idx+1);
6984 if (length($h->{'buffer'})) {
6985 $rv = $h->{'buffer'};
6986 delete($h->{'buffer'});
6989 $rv = Net::SSLeay::read($h->{'ssl_con'}, $_[1]);
6995 read($h->{'fh'}, $rv, $_[1]) > 0 || return undef;
6998 my $fh = $h->{'fh'};
7002 $rv = undef if ($rv eq "");
7006 =head2 write_http_connection(&handle, [data+])
7008 Writes the given data to the given HTTP connection handle.
7011 sub write_http_connection
7014 my $fh = $h->{'fh'};
7016 if ($h->{'ssl_ctx'}) {
7017 foreach my $s (@_) {
7018 my $ok = Net::SSLeay::write($h->{'ssl_con'}, $s);
7019 $allok = 0 if (!$ok);
7023 my $ok = (print $fh @_);
7024 $allok = 0 if (!$ok);
7029 =head2 close_http_connection(&handle)
7031 Closes a connection to an HTTP server, identified by the given handle.
7034 sub close_http_connection
7040 =head2 clean_environment
7042 Deletes any environment variables inherited from miniserv so that they
7043 won't be passed to programs started by webmin. This is useful when calling
7044 programs that check for CGI-related environment variables and modify their
7045 behaviour, and to avoid passing sensitive variables to un-trusted programs.
7048 sub clean_environment
7050 %UNCLEAN_ENV = %ENV;
7051 foreach my $k (keys %ENV) {
7052 if ($k =~ /^(HTTP|VIRTUALSERVER|QUOTA|USERADMIN)_/) {
7056 foreach my $e ('WEBMIN_CONFIG', 'SERVER_NAME', 'CONTENT_TYPE', 'REQUEST_URI',
7057 'PATH_INFO', 'WEBMIN_VAR', 'REQUEST_METHOD', 'GATEWAY_INTERFACE',
7058 'QUERY_STRING', 'REMOTE_USER', 'SERVER_SOFTWARE', 'SERVER_PROTOCOL',
7059 'REMOTE_HOST', 'SERVER_PORT', 'DOCUMENT_ROOT', 'SERVER_ROOT',
7060 'MINISERV_CONFIG', 'SCRIPT_NAME', 'SERVER_ADMIN', 'CONTENT_LENGTH',
7061 'HTTPS', 'FOREIGN_MODULE_NAME', 'FOREIGN_ROOT_DIRECTORY',
7062 'SCRIPT_FILENAME', 'PATH_TRANSLATED', 'BASE_REMOTE_USER',
7063 'DOCUMENT_REALROOT', 'MINISERV_CONFIG', 'MYSQL_PWD',
7069 =head2 reset_environment
7071 Puts the environment back how it was before clean_environment was callled.
7074 sub reset_environment
7077 foreach my $k (keys %UNCLEAN_ENV) {
7078 $ENV{$k} = $UNCLEAN_ENV{$k};
7080 undef(%UNCLEAN_ENV);
7084 =head2 progress_callback
7086 Never called directly, but useful for passing to &http_download to print
7087 out progress of an HTTP request.
7090 sub progress_callback
7092 if (defined(&theme_progress_callback)) {
7093 # Call the theme override
7094 return &theme_progress_callback(@_);
7098 print $progress_callback_prefix;
7100 $progress_size = $_[1];
7101 $progress_step = int($_[1] / 10);
7102 print &text('progress_size2', $progress_callback_url,
7103 &nice_size($progress_size)),"<br>\n";
7106 $progress_size = undef;
7107 print &text('progress_nosize', $progress_callback_url),"<br>\n";
7109 $last_progress_time = $last_progress_size = undef;
7111 elsif ($_[0] == 3) {
7113 my $sp = $progress_callback_prefix.(" " x 5);
7114 if ($progress_size) {
7115 # And we have a size to compare against
7116 my $st = int(($_[1] * 10) / $progress_size);
7117 my $time_now = time();
7118 if ($st != $progress_step ||
7119 $time_now - $last_progress_time > 60) {
7120 # Show progress every 10% or 60 seconds
7121 print $sp,&text('progress_datan', &nice_size($_[1]),
7122 int($_[1]*100/$progress_size)),"<br>\n";
7123 $last_progress_time = $time_now;
7125 $progress_step = $st;
7128 # No total size .. so only show in 100k jumps
7129 if ($_[1] > $last_progress_size+100*1024) {
7130 print $sp,&text('progress_data2n',
7131 &nice_size($_[1])),"<br>\n";
7132 $last_progress_size = $_[1];
7136 elsif ($_[0] == 4) {
7137 # All done downloading
7138 print $progress_callback_prefix,&text('progress_done'),"<br>\n";
7140 elsif ($_[0] == 5) {
7141 # Got new location after redirect
7142 $progress_callback_url = $_[1];
7144 elsif ($_[0] == 6) {
7146 $progress_callback_url = $_[1];
7147 print &text('progress_incache', $progress_callback_url),"<br>\n";
7151 =head2 switch_to_remote_user
7153 Changes the user and group of the current process to that of the unix user
7154 with the same name as the current webmin login, or fails if there is none.
7155 This should be called by Usermin module scripts that only need to run with
7156 limited permissions.
7159 sub switch_to_remote_user
7161 @remote_user_info = $remote_user ? getpwnam($remote_user) :
7163 @remote_user_info || &error(&text('switch_remote_euser', $remote_user));
7164 &create_missing_homedir(\@remote_user_info);
7166 &switch_to_unix_user(\@remote_user_info);
7167 $ENV{'USER'} = $ENV{'LOGNAME'} = $remote_user;
7168 $ENV{'HOME'} = $remote_user_info[7];
7170 # Export global variables to caller
7171 if ($main::export_to_caller) {
7172 my ($callpkg) = caller();
7173 eval "\@${callpkg}::remote_user_info = \@remote_user_info";
7177 =head2 switch_to_unix_user(&user-details)
7179 Switches the current process to the UID and group ID from the given list
7180 of user details, which must be in the format returned by getpwnam.
7183 sub switch_to_unix_user
7186 if (!defined($uinfo->[0])) {
7187 # No username given, so just use given GID
7188 ($(, $)) = ( $uinfo->[3], "$uinfo->[3] $uinfo->[3]" );
7191 # Use all groups from user
7192 ($(, $)) = ( $uinfo->[3],
7193 "$uinfo->[3] ".join(" ", $uinfo->[3],
7194 &other_groups($uinfo->[0])) );
7197 POSIX::setuid($uinfo->[2]);
7199 if ($< != $uinfo->[2] || $> != $uinfo->[2]) {
7200 ($>, $<) = ( $uinfo->[2], $uinfo->[2] );
7204 =head2 eval_as_unix_user(username, &code)
7206 Runs some code fragment with the effective UID and GID switch to that
7207 of the given Unix user, so that file IO takes place with his permissions.
7211 sub eval_as_unix_user
7213 my ($user, $code) = @_;
7214 my @uinfo = getpwnam($user);
7215 if (!scalar(@uinfo)) {
7216 &error("eval_as_unix_user called with invalid user $user");
7218 $) = $uinfo[3]." ".join(" ", $uinfo[3], &other_groups($user));
7222 local $main::error_must_die = 1;
7229 $err =~ s/\s+at\s+(\/\S+)\s+line\s+(\d+)\.?//;
7232 return wantarray ? @rv : $rv[0];
7235 =head2 create_user_config_dirs
7237 Creates per-user config directories and sets $user_config_directory and
7238 $user_module_config_directory to them. Also reads per-user module configs
7239 into %userconfig. This should be called by Usermin module scripts that need
7240 to store per-user preferences or other settings.
7243 sub create_user_config_dirs
7245 return if (!$gconfig{'userconfig'});
7246 my @uinfo = @remote_user_info ? @remote_user_info : getpwnam($remote_user);
7247 return if (!@uinfo || !$uinfo[7]);
7248 &create_missing_homedir(\@uinfo);
7249 $user_config_directory = "$uinfo[7]/$gconfig{'userconfig'}";
7250 if (!-d $user_config_directory) {
7251 mkdir($user_config_directory, 0700) ||
7252 &error("Failed to create $user_config_directory : $!");
7253 if ($< == 0 && $uinfo[2]) {
7254 chown($uinfo[2], $uinfo[3], $user_config_directory);
7257 if (&get_module_name()) {
7258 $user_module_config_directory = $user_config_directory."/".
7260 if (!-d $user_module_config_directory) {
7261 mkdir($user_module_config_directory, 0700) ||
7262 &error("Failed to create $user_module_config_directory : $!");
7263 if ($< == 0 && $uinfo[2]) {
7264 chown($uinfo[2], $uinfo[3], $user_config_directory);
7268 &read_file_cached("$module_root_directory/defaultuconfig",
7270 &read_file_cached("$module_config_directory/uconfig", \%userconfig);
7271 &read_file_cached("$user_module_config_directory/config",
7275 # Export global variables to caller
7276 if ($main::export_to_caller) {
7277 my ($callpkg) = caller();
7278 foreach my $v ('$user_config_directory',
7279 '$user_module_config_directory', '%userconfig') {
7280 my ($vt, $vn) = split('', $v, 2);
7281 eval "${vt}${callpkg}::${vn} = ${vt}${vn}";
7286 =head2 create_missing_homedir(&uinfo)
7288 If auto homedir creation is enabled, create one for this user if needed.
7289 For internal use only.
7292 sub create_missing_homedir
7295 if (!-e $uinfo->[7] && $gconfig{'create_homedir'}) {
7296 # Use has no home dir .. make one
7297 system("mkdir -p ".quotemeta($uinfo->[7]));
7298 chown($uinfo->[2], $uinfo->[3], $uinfo->[7]);
7299 if ($gconfig{'create_homedir_perms'} ne '') {
7300 chmod(oct($gconfig{'create_homedir_perms'}), $uinfo->[7]);
7305 =head2 filter_javascript(text)
7307 Disables all javascript <script>, onClick= and so on tags in the given HTML,
7308 and returns the new HTML. Useful for displaying HTML from an un-trusted source.
7311 sub filter_javascript
7314 $rv =~ s/<\s*script[^>]*>([\000-\377]*?)<\s*\/script\s*>//gi;
7315 $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;
7316 $rv =~ s/(javascript:)/x$1/gi;
7317 $rv =~ s/(vbscript:)/x$1/gi;
7321 =head2 resolve_links(path)
7323 Given a path that may contain symbolic links, returns the real path.
7329 $path =~ s/\/+/\//g;
7330 $path =~ s/\/$// if ($path ne "/");
7331 my @p = split(/\/+/, $path);
7333 for(my $i=0; $i<@p; $i++) {
7334 my $sofar = "/".join("/", @p[0..$i]);
7335 my $lnk = readlink($sofar);
7336 if ($lnk eq $sofar) {
7337 # Link to itself! Cannot do anything more really ..
7340 elsif ($lnk =~ /^\//) {
7341 # Link is absolute..
7342 return &resolve_links($lnk."/".join("/", @p[$i+1 .. $#p]));
7346 return &resolve_links("/".join("/", @p[0..$i-1])."/".$lnk."/".join("/", @p[$i+1 .. $#p]));
7352 =head2 simplify_path(path, bogus)
7354 Given a path, maybe containing elements ".." and "." , convert it to a
7355 clean, absolute form. Returns undef if this is not possible.
7363 my @bits = split(/\/+/, $dir);
7366 foreach my $b (@bits) {
7370 elsif ($b eq "..") {
7372 if (scalar(@fixedbits) == 0) {
7373 # Cannot! Already at root!
7380 push(@fixedbits, $b);
7383 return "/".join('/', @fixedbits);
7386 =head2 same_file(file1, file2)
7388 Returns 1 if two files are actually the same
7393 return 1 if ($_[0] eq $_[1]);
7394 return 0 if ($_[0] !~ /^\// || $_[1] !~ /^\//);
7395 my @stat1 = $stat_cache{$_[0]} ? @{$stat_cache{$_[0]}}
7396 : (@{$stat_cache{$_[0]}} = stat($_[0]));
7397 my @stat2 = $stat_cache{$_[1]} ? @{$stat_cache{$_[1]}}
7398 : (@{$stat_cache{$_[1]}} = stat($_[1]));
7399 return 0 if (!@stat1 || !@stat2);
7400 return $stat1[0] == $stat2[0] && $stat1[1] == $stat2[1];
7403 =head2 flush_webmin_caches
7405 Clears all in-memory and on-disk caches used by Webmin.
7408 sub flush_webmin_caches
7410 undef(%main::read_file_cache);
7411 undef(%main::acl_hash_cache);
7412 undef(%main::acl_array_cache);
7413 undef(%main::has_command_cache);
7414 undef(@main::list_languages_cache);
7415 undef($main::got_list_usermods_cache);
7416 undef(@main::list_usermods_cache);
7417 undef(%main::foreign_installed_cache);
7418 unlink("$config_directory/module.infos.cache");
7419 &get_all_module_infos();
7422 =head2 list_usermods
7424 Returns a list of additional module restrictions. For internal use in
7430 if (!$main::got_list_usermods_cache) {
7431 @main::list_usermods_cache = ( );
7433 open(USERMODS, "$config_directory/usermin.mods");
7435 if (/^([^:]+):(\+|-|):(.*)/) {
7436 push(@main::list_usermods_cache,
7437 [ $1, $2, [ split(/\s+/, $3) ] ]);
7441 $main::got_list_usermods_cache = 1;
7443 return @main::list_usermods_cache;
7446 =head2 available_usermods(&allmods, &usermods)
7448 Returns a list of modules that are available to the given user, based
7449 on usermod additional/subtractions. For internal use by Usermin only.
7452 sub available_usermods
7454 return @{$_[0]} if (!@{$_[1]});
7456 my %mods = map { $_->{'dir'}, 1 } @{$_[0]};
7457 my @uinfo = @remote_user_info;
7458 @uinfo = getpwnam($remote_user) if (!@uinfo);
7459 foreach my $u (@{$_[1]}) {
7461 if ($u->[0] eq "*" || $u->[0] eq $remote_user) {
7464 elsif ($u->[0] =~ /^\@(.*)$/) {
7465 # Check for group membership
7466 my @ginfo = getgrnam($1);
7467 $applies++ if (@ginfo && ($ginfo[2] == $uinfo[3] ||
7468 &indexof($remote_user, split(/\s+/, $ginfo[3])) >= 0));
7470 elsif ($u->[0] =~ /^\//) {
7471 # Check users and groups in file
7473 open(USERFILE, $u->[0]);
7476 if ($_ eq $remote_user) {
7479 elsif (/^\@(.*)$/) {
7480 my @ginfo = getgrnam($1);
7482 if (@ginfo && ($ginfo[2] == $uinfo[3] ||
7483 &indexof($remote_user,
7484 split(/\s+/, $ginfo[3])) >= 0));
7491 if ($u->[1] eq "+") {
7492 map { $mods{$_}++ } @{$u->[2]};
7494 elsif ($u->[1] eq "-") {
7495 map { delete($mods{$_}) } @{$u->[2]};
7499 map { $mods{$_}++ } @{$u->[2]};
7503 return grep { $mods{$_->{'dir'}} } @{$_[0]};
7506 =head2 get_available_module_infos(nocache)
7508 Returns a list of modules available to the current user, based on
7509 operating system support, access control and usermod restrictions. Useful
7510 in themes that need to display a list of modules the user can use.
7511 Each element of the returned array is a hash reference in the same format as
7512 returned by get_module_info.
7515 sub get_available_module_infos
7518 &read_acl(\%acl, \%uacl, [ $base_remote_user ]);
7519 my $risk = $gconfig{'risk_'.$base_remote_user};
7521 foreach my $minfo (&get_all_module_infos($_[0])) {
7522 next if (!&check_os_support($minfo));
7524 # Check module risk level
7525 next if ($risk ne 'high' && $minfo->{'risk'} &&
7526 $minfo->{'risk'} !~ /$risk/);
7530 next if (!$acl{$base_remote_user,$minfo->{'dir'}} &&
7531 !$acl{$base_remote_user,"*"});
7533 next if (&is_readonly_mode() && !$minfo->{'readonly'});
7537 # Check usermod restrictions
7538 my @usermods = &list_usermods();
7539 @rv = sort { $a->{'desc'} cmp $b->{'desc'} }
7540 &available_usermods(\@rv, \@usermods);
7542 # Check RBAC restrictions
7544 foreach my $m (@rv) {
7545 if (&supports_rbac($m->{'dir'}) &&
7546 &use_rbac_module_acl(undef, $m->{'dir'})) {
7547 local $rbacs = &get_rbac_module_acl($remote_user,
7555 # Module or system doesn't support RBAC
7556 push(@rbacrv, $m) if (!$gconfig{'rbacdeny_'.$base_remote_user});
7562 if (defined(&theme_foreign_available)) {
7563 foreach my $m (@rbacrv) {
7564 if (&theme_foreign_available($m->{'dir'})) {
7573 # Check licence module vetos
7575 if ($main::licence_module) {
7576 foreach my $m (@themerv) {
7577 if (&foreign_call($main::licence_module,
7578 "check_module_licence", $m->{'dir'})) {
7590 =head2 get_visible_module_infos(nocache)
7592 Like get_available_module_infos, but excludes hidden modules from the list.
7593 Each element of the returned array is a hash reference in the same format as
7594 returned by get_module_info.
7597 sub get_visible_module_infos
7600 my $pn = &get_product_name();
7601 return grep { !$_->{'hidden'} &&
7602 !$_->{$pn.'_hidden'} } &get_available_module_infos($nocache);
7605 =head2 get_visible_modules_categories(nocache)
7607 Returns a list of Webmin module categories, each of which is a hash ref
7608 with 'code', 'desc' and 'modules' keys. The modules value is an array ref
7609 of modules in the category, in the format returned by get_module_info.
7610 Un-used modules are automatically assigned to the 'unused' category, and
7611 those with no category are put into 'others'.
7614 sub get_visible_modules_categories
7617 my @mods = &get_visible_module_infos($nocache);
7619 if (&get_product_name() eq 'webmin') {
7620 @unmods = grep { $_->{'installed'} eq '0' } @mods;
7621 @mods = grep { $_->{'installed'} ne '0' } @mods;
7623 my %cats = &list_categories(\@mods);
7625 foreach my $c (keys %cats) {
7626 my $cat = { 'code' => $c || 'other',
7627 'desc' => $cats{$c} };
7628 $cat->{'modules'} = [ grep { $_->{'category'} eq $c } @mods ];
7631 @rv = sort { ($b->{'code'} eq "others" ? "" : $b->{'code'}) cmp
7632 ($a->{'code'} eq "others" ? "" : $a->{'code'}) } @rv;
7634 # Add un-installed modules in magic category
7635 my $cat = { 'code' => 'unused',
7636 'desc' => $text{'main_unused'},
7638 'modules' => \@unmods };
7644 =head2 is_under_directory(directory, file)
7646 Returns 1 if the given file is under the specified directory, 0 if not.
7647 Symlinks are taken into account in the file to find it's 'real' location.
7650 sub is_under_directory
7652 my ($dir, $file) = @_;
7653 return 1 if ($dir eq "/");
7654 return 0 if ($file =~ /\.\./);
7655 my $ld = &resolve_links($dir);
7657 return &is_under_directory($ld, $file);
7659 my $lp = &resolve_links($file);
7661 return &is_under_directory($dir, $lp);
7663 return 0 if (length($file) < length($dir));
7664 return 1 if ($dir eq $file);
7666 return substr($file, 0, length($dir)) eq $dir;
7669 =head2 parse_http_url(url, [basehost, baseport, basepage, basessl])
7671 Given an absolute URL, returns the host, port, page and ssl flag components.
7672 If a username and password are given before the hostname, return those too.
7673 Relative URLs can also be parsed, if the base information is provided.
7678 if ($_[0] =~ /^(http|https):\/\/([^\@]+\@)?\[([^\]]+)\](:(\d+))?(\/\S*)?$/ ||
7679 $_[0] =~ /^(http|https):\/\/([^\@]+\@)?([^:\/]+)(:(\d+))?(\/\S*)?$/) {
7681 my $ssl = $1 eq 'https';
7682 my @rv = ($3, $4 ? $5 : $ssl ? 443 : 80, $6 || "/", $ssl);
7683 if ($2 =~ /^([^:]+):(\S+)\@/) {
7692 elsif ($_[0] =~ /^\/\S*$/) {
7693 # A relative to the server URL
7694 return ($_[1], $_[2], $_[0], $_[4], $_[5], $_[6]);
7697 # A relative to the directory URL
7699 $page =~ s/[^\/]+$//;
7700 return ($_[1], $_[2], $page.$_[0], $_[4], $_[5], $_[6]);
7704 =head2 check_clicks_function
7706 Returns HTML for a JavaScript function called check_clicks that returns
7707 true when first called, but false subsequently. Useful on onClick for
7708 critical buttons. Deprecated, as this method of preventing duplicate actions
7712 sub check_clicks_function
7717 function check_clicks(form)
7724 for(i=0; i<form.length; i++)
7725 form.elements[i].disabled = true;
7734 =head2 load_entities_map
7736 Returns a hash ref containing mappings between HTML entities (like ouml) and
7737 ascii values (like 246). Mainly for internal use.
7740 sub load_entities_map
7742 if (!%entities_map_cache) {
7744 open(EMAP, "$root_directory/entities_map.txt");
7746 if (/^(\d+)\s+(\S+)/) {
7747 $entities_map_cache{$2} = $1;
7752 return \%entities_map_cache;
7755 =head2 entities_to_ascii(string)
7757 Given a string containing HTML entities like ö and 7, replace them
7758 with their ASCII equivalents.
7761 sub entities_to_ascii
7764 my $emap = &load_entities_map();
7765 $str =~ s/&([a-z]+);/chr($emap->{$1})/ge;
7766 $str =~ s/&#(\d+);/chr($1)/ge;
7770 =head2 get_product_name
7772 Returns either 'webmin' or 'usermin', depending on which program the current
7773 module is in. Useful for modules that can be installed into either.
7776 sub get_product_name
7778 return $gconfig{'product'} if (defined($gconfig{'product'}));
7779 return defined($gconfig{'userconfig'}) ? 'usermin' : 'webmin';
7784 Returns the character set for the current language, such as iso-8859-1.
7789 my $charset = defined($gconfig{'charset'}) ? $gconfig{'charset'} :
7790 $current_lang_info->{'charset'} ?
7791 $current_lang_info->{'charset'} : $default_charset;
7795 =head2 get_display_hostname
7797 Returns the system's hostname for UI display purposes. This may be different
7798 from the actual hostname if you administrator has configured it so in the
7799 Webmin Configuration module.
7802 sub get_display_hostname
7804 if ($gconfig{'hostnamemode'} == 0) {
7805 return &get_system_hostname();
7807 elsif ($gconfig{'hostnamemode'} == 3) {
7808 return $gconfig{'hostnamedisplay'};
7811 my $h = $ENV{'HTTP_HOST'};
7813 if ($gconfig{'hostnamemode'} == 2) {
7814 $h =~ s/^(www|ftp|mail)\.//i;
7820 =head2 save_module_config([&config], [modulename])
7822 Saves the configuration for some module. The config parameter is an optional
7823 hash reference of names and values to save, which defaults to the global
7824 %config hash. The modulename parameter is the module to update the config
7825 file, which defaults to the current module.
7828 sub save_module_config
7830 my $c = $_[0] || { &get_module_variable('%config') };
7831 my $m = defined($_[1]) ? $_[1] : &get_module_name();
7832 &write_file("$config_directory/$m/config", $c);
7835 =head2 save_user_module_config([&config], [modulename])
7837 Saves the user's Usermin preferences for some module. The config parameter is
7838 an optional hash reference of names and values to save, which defaults to the
7839 global %userconfig hash. The modulename parameter is the module to update the
7840 config file, which defaults to the current module.
7843 sub save_user_module_config
7845 my $c = $_[0] || { &get_module_variable('%userconfig') };
7846 my $m = $_[1] || &get_module_name();
7847 my $ucd = $user_config_directory;
7849 my @uinfo = @remote_user_info ? @remote_user_info
7850 : getpwnam($remote_user);
7851 return if (!@uinfo || !$uinfo[7]);
7852 $ucd = "$uinfo[7]/$gconfig{'userconfig'}";
7854 &write_file("$ucd/$m/config", $c);
7857 =head2 nice_size(bytes, [min])
7859 Converts a number of bytes into a number followed by a suffix like GB, MB
7860 or kB. Rounding is to two decimal digits. The optional min parameter sets the
7861 smallest units to use - so you could pass 1024*1024 to never show bytes or kB.
7866 my ($units, $uname);
7867 if (abs($_[0]) > 1024*1024*1024*1024 || $_[1] >= 1024*1024*1024*1024) {
7868 $units = 1024*1024*1024*1024;
7871 elsif (abs($_[0]) > 1024*1024*1024 || $_[1] >= 1024*1024*1024) {
7872 $units = 1024*1024*1024;
7875 elsif (abs($_[0]) > 1024*1024 || $_[1] >= 1024*1024) {
7879 elsif (abs($_[0]) > 1024 || $_[1] >= 1024) {
7887 my $sz = sprintf("%.2f", ($_[0]*1.0 / $units));
7889 return $sz." ".$uname;
7892 =head2 get_perl_path
7894 Returns the path to Perl currently in use, such as /usr/bin/perl.
7899 if (open(PERL, "$config_directory/perl-path")) {
7905 return $^X if (-x $^X);
7906 return &has_command("perl");
7909 =head2 get_goto_module([&mods])
7911 Returns the details of a module that the current user should be re-directed
7912 to after logging in, or undef if none. Useful for themes.
7917 my @mods = $_[0] ? @{$_[0]} : &get_visible_module_infos();
7918 if ($gconfig{'gotomodule'}) {
7919 my ($goto) = grep { $_->{'dir'} eq $gconfig{'gotomodule'} } @mods;
7920 return $goto if ($goto);
7922 if (@mods == 1 && $gconfig{'gotoone'}) {
7928 =head2 select_all_link(field, form, [text])
7930 Returns HTML for a 'Select all' link that uses Javascript to select
7931 multiple checkboxes with the same name. The parameters are :
7933 =item field - Name of the checkbox inputs.
7935 =item form - Index of the form on the page.
7937 =item text - Message for the link, defaulting to 'Select all'.
7942 return &theme_select_all_link(@_) if (defined(&theme_select_all_link));
7943 my ($field, $form, $text) = @_;
7945 $text ||= $text{'ui_selall'};
7946 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>";
7949 =head2 select_invert_link(field, form, text)
7951 Returns HTML for an 'Invert selection' link that uses Javascript to invert the
7952 selection on multiple checkboxes with the same name. The parameters are :
7954 =item field - Name of the checkbox inputs.
7956 =item form - Index of the form on the page.
7958 =item text - Message for the link, defaulting to 'Invert selection'.
7961 sub select_invert_link
7963 return &theme_select_invert_link(@_) if (defined(&theme_select_invert_link));
7964 my ($field, $form, $text) = @_;
7966 $text ||= $text{'ui_selinv'};
7967 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>";
7970 =head2 select_rows_link(field, form, text, &rows)
7972 Returns HTML for a link that uses Javascript to select rows with particular
7973 values for their checkboxes. The parameters are :
7975 =item field - Name of the checkbox inputs.
7977 =item form - Index of the form on the page.
7979 =item text - Message for the link, de
7981 =item rows - Reference to an array of 1 or 0 values, indicating which rows to check.
7984 sub select_rows_link
7986 return &theme_select_rows_link(@_) if (defined(&theme_select_rows_link));
7987 my ($field, $form, $text, $rows) = @_;
7989 my $js = "var sel = { ".join(",", map { "\""."e_escape($_)."\":1" } @$rows)." }; ";
7990 $js .= "for(var i=0; i<document.forms[$form].${field}.length; i++) { var r = document.forms[$form].${field}[i]; r.checked = sel[r.value]; } ";
7991 $js .= "return false;";
7992 return "<a href='#' onClick='$js'>$text</a>";
7995 =head2 check_pid_file(file)
7997 Given a pid file, returns the PID it contains if the process is running.
8002 open(PIDFILE, $_[0]) || return undef;
8003 my $pid = <PIDFILE>;
8005 $pid =~ /^\s*(\d+)/ || return undef;
8006 kill(0, $1) || return undef;
8012 Return the local os-specific library name to this module. For internal use only.
8017 my $mn = &get_module_name();
8018 my $md = &module_root_directory($mn);
8019 if (-r "$md/$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl") {
8020 return "$mn-$gconfig{'os_type'}-$gconfig{'os_version'}-lib.pl";
8022 elsif (-r "$md/$mn-$gconfig{'os_type'}-lib.pl") {
8023 return "$mn-$gconfig{'os_type'}-lib.pl";
8025 elsif (-r "$md/$mn-generic-lib.pl") {
8026 return "$mn-generic-lib.pl";
8033 =head2 module_root_directory(module)
8035 Given a module name, returns its root directory. On a typical Webmin install,
8036 all modules are under the same directory - but it is theoretically possible to
8040 sub module_root_directory
8042 my $d = ref($_[0]) ? $_[0]->{'dir'} : $_[0];
8043 if (@root_directories > 1) {
8044 foreach my $r (@root_directories) {
8050 return "$root_directories[0]/$d";
8053 =head2 list_mime_types
8055 Returns a list of all known MIME types and their extensions, as a list of hash
8056 references with keys :
8058 =item type - The MIME type, like text/plain.
8060 =item exts - A list of extensions, like .doc and .avi.
8062 =item desc - A human-readable description for the MIME type.
8067 if (!@list_mime_types_cache) {
8069 open(MIME, "$root_directory/mime.types");
8073 if (s/#\s*(.*)$//g) {
8076 my ($type, @exts) = split(/\s+/);
8078 push(@list_mime_types_cache, { 'type' => $type,
8085 return @list_mime_types_cache;
8088 =head2 guess_mime_type(filename, [default])
8090 Given a file name like xxx.gif or foo.html, returns a guessed MIME type.
8091 The optional default parameter sets a default type of use if none is found,
8092 which defaults to application/octet-stream.
8097 if ($_[0] =~ /\.([A-Za-z0-9\-]+)$/) {
8099 foreach my $t (&list_mime_types()) {
8100 foreach my $e (@{$t->{'exts'}}) {
8101 return $t->{'type'} if (lc($e) eq lc($ext));
8105 return @_ > 1 ? $_[1] : "application/octet-stream";
8108 =head2 open_tempfile([handle], file, [no-error], [no-tempfile], [safe?])
8110 Opens a file handle for writing to a temporary file, which will only be
8111 renamed over the real file when the handle is closed. This allows critical
8112 files like /etc/shadow to be updated safely, even if writing fails part way
8113 through due to lack of disk space. The parameters are :
8115 =item handle - File handle to open, as you would use in Perl's open function.
8117 =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.
8119 =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.
8121 =item no-tempfile - If set to 1, writing will be direct to the file instead of using a temporary file.
8123 =item safe - Indicates to users in read-only mode that this write is safe and non-destructive.
8129 # Just getting a temp file
8130 if (!defined($main::open_tempfiles{$_[0]})) {
8131 $_[0] =~ /^(.*)\/(.*)$/ || return $_[0];
8132 my $dir = $1 || "/";
8133 my $tmp = "$dir/$2.webmintmp.$$";
8134 $main::open_tempfiles{$_[0]} = $tmp;
8135 push(@main::temporary_files, $tmp);
8137 return $main::open_tempfiles{$_[0]};
8141 my ($fh, $file, $noerror, $notemp, $safe) = @_;
8142 $fh = &callers_package($fh);
8144 my %gaccess = &get_module_acl(undef, "");
8145 my $db = $gconfig{'debug_what_write'};
8146 if ($file =~ /\r|\n|\0/) {
8147 if ($noerror) { return 0; }
8148 else { &error("Filename contains invalid characters"); }
8150 if (&is_readonly_mode() && $file =~ />/ && !$safe) {
8151 # Read-only mode .. veto all writes
8152 print STDERR "vetoing write to $file\n";
8153 return open($fh, ">$null_file");
8155 elsif ($file =~ /^(>|>>|)nul$/i) {
8156 # Write to Windows null device
8157 &webmin_debug_log($1 eq ">" ? "WRITE" :
8158 $1 eq ">>" ? "APPEND" : "READ", "nul") if ($db);
8160 elsif ($file =~ /^(>|>>)(\/dev\/.*)/ || lc($file) eq "nul") {
8161 # Writes to /dev/null or TTYs don't need to be handled
8162 &webmin_debug_log($1 eq ">" ? "WRITE" : "APPEND", $2) if ($db);
8163 return open($fh, $file);
8165 elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && !$notemp) {
8166 &webmin_debug_log("WRITE", $1) if ($db);
8167 # Over-writing a file, via a temp file
8169 $file = &translate_filename($file);
8171 # Open the link target instead
8172 $file = &resolve_links($file);
8175 # Cannot open a directory!
8176 if ($noerror) { return 0; }
8177 else { &error("Cannot write to directory $file"); }
8179 my $tmp = &open_tempfile($file);
8180 my $ex = open($fh, ">$tmp");
8181 if (!$ex && $! =~ /permission/i) {
8182 # Could not open temp file .. try opening actual file
8184 $ex = open($fh, ">$file");
8185 delete($main::open_tempfiles{$file});
8188 $main::open_temphandles{$fh} = $file;
8191 if (!$ex && !$noerror) {
8192 &error(&text("efileopen", $file, $!));
8196 elsif ($file =~ /^>\s*(([a-zA-Z]:)?\/.*)$/ && $notemp) {
8197 # Just writing direct to a file
8198 &webmin_debug_log("WRITE", $1) if ($db);
8200 $file = &translate_filename($file);
8201 my @old_attributes = &get_clear_file_attributes($file);
8202 my $ex = open($fh, ">$file");
8203 &reset_file_attributes($file, \@old_attributes);
8204 $main::open_temphandles{$fh} = $file;
8205 if (!$ex && !$noerror) {
8206 &error(&text("efileopen", $file, $!));
8211 elsif ($file =~ /^>>\s*(([a-zA-Z]:)?\/.*)$/) {
8212 # Appending to a file .. nothing special to do
8213 &webmin_debug_log("APPEND", $1) if ($db);
8215 $file = &translate_filename($file);
8216 my @old_attributes = &get_clear_file_attributes($file);
8217 my $ex = open($fh, ">>$file");
8218 &reset_file_attributes($file, \@old_attributes);
8219 $main::open_temphandles{$fh} = $file;
8220 if (!$ex && !$noerror) {
8221 &error(&text("efileopen", $file, $!));
8226 elsif ($file =~ /^([a-zA-Z]:)?\//) {
8227 # Read mode .. nothing to do here
8228 &webmin_debug_log("READ", $file) if ($db);
8229 $file = &translate_filename($file);
8230 return open($fh, $file);
8232 elsif ($file eq ">" || $file eq ">>") {
8233 my ($package, $filename, $line) = caller;
8234 if ($noerror) { return 0; }
8235 else { &error("Missing file to open at ${package}::${filename} line $line"); }
8238 my ($package, $filename, $line) = caller;
8239 &error("Unsupported file or mode $file at ${package}::${filename} line $line");
8244 =head2 close_tempfile(file|handle)
8246 Copies a temp file to the actual file, assuming that all writes were
8247 successful. The handle must have been one passed to open_tempfile.
8253 my $fh = &callers_package($_[0]);
8255 if (defined($file = $main::open_temphandles{$fh})) {
8257 close($fh) || &error(&text("efileclose", $file, $!));
8258 delete($main::open_temphandles{$fh});
8259 return &close_tempfile($file);
8261 elsif (defined($main::open_tempfiles{$_[0]})) {
8263 &webmin_debug_log("CLOSE", $_[0]) if ($gconfig{'debug_what_write'});
8264 my @st = stat($_[0]);
8265 if (&is_selinux_enabled() && &has_command("chcon")) {
8266 # Set original security context
8267 system("chcon --reference=".quotemeta($_[0]).
8268 " ".quotemeta($main::open_tempfiles{$_[0]}).
8269 " >/dev/null 2>&1");
8271 my @old_attributes = &get_clear_file_attributes($_[0]);
8272 rename($main::open_tempfiles{$_[0]}, $_[0]) || &error("Failed to replace $_[0] with $main::open_tempfiles{$_[0]} : $!");
8274 # Set original permissions and ownership
8275 chmod($st[2], $_[0]);
8276 chown($st[4], $st[5], $_[0]);
8278 &reset_file_attributes($_[0], \@old_attributes);
8279 delete($main::open_tempfiles{$_[0]});
8280 @main::temporary_files = grep { $_ ne $main::open_tempfiles{$_[0]} } @main::temporary_files;
8281 if ($main::open_templocks{$_[0]}) {
8282 &unlock_file($_[0]);
8283 delete($main::open_templocks{$_[0]});
8288 # Must be closing a handle not associated with a file
8294 =head2 print_tempfile(handle, text, ...)
8296 Like the normal print function, but calls &error on failure. Useful when
8297 combined with open_tempfile, to ensure that a criticial file is never
8298 only partially written.
8303 my ($fh, @args) = @_;
8304 $fh = &callers_package($fh);
8305 (print $fh @args) || &error(&text("efilewrite",
8306 $main::open_temphandles{$fh} || $fh, $!));
8309 =head2 is_selinux_enabled
8311 Returns 1 if SElinux is supported on this system and enabled, 0 if not.
8314 sub is_selinux_enabled
8316 if (!defined($main::selinux_enabled_cache)) {
8318 if ($gconfig{'os_type'} !~ /-linux$/) {
8319 # Not on linux, so no way
8320 $main::selinux_enabled_cache = 0;
8322 elsif (&read_env_file("/etc/selinux/config", \%seconfig)) {
8323 # Use global config file
8324 $main::selinux_enabled_cache =
8325 $seconfig{'SELINUX'} eq 'disabled' ||
8326 !$seconfig{'SELINUX'} ? 0 : 1;
8329 # Use selinuxenabled command
8330 #$selinux_enabled_cache =
8331 # system("selinuxenabled >/dev/null 2>&1") ? 0 : 1;
8332 $main::selinux_enabled_cache = 0;
8335 return $main::selinux_enabled_cache;
8338 =head2 get_clear_file_attributes(file)
8340 Finds file attributes that may prevent writing, clears them and returns them
8341 as a list. May call error. Mainly for internal use by open_tempfile and
8345 sub get_clear_file_attributes
8349 if ($gconfig{'chattr'}) {
8350 # Get original immutable bit
8351 my $out = &backquote_command(
8352 "lsattr ".quotemeta($file)." 2>/dev/null");
8354 $out =~ s/\s\S+\n//;
8355 @old_attributes = grep { $_ ne '-' } split(//, $out);
8357 if (&indexof("i", @old_attributes) >= 0) {
8358 my $err = &backquote_logged(
8359 "chattr -i ".quotemeta($file)." 2>&1");
8361 &error("Failed to remove immutable bit on ".
8366 return @old_attributes;
8369 =head2 reset_file_attributes(file, &attributes)
8371 Put back cleared attributes on some file. May call error. Mainly for internal
8372 use by close_tempfile.
8375 sub reset_file_attributes
8377 my ($file, $old_attributes) = @_;
8378 if (&indexof("i", @$old_attributes) >= 0) {
8379 my $err = &backquote_logged(
8380 "chattr +i ".quotemeta($file)." 2>&1");
8382 &error("Failed to restore immutable bit on ".
8388 =head2 cleanup_tempnames
8390 Remove all temporary files generated using transname. Typically only called
8391 internally when a Webmin script exits.
8394 sub cleanup_tempnames
8396 foreach my $t (@main::temporary_files) {
8399 @main::temporary_files = ( );
8402 =head2 open_lock_tempfile([handle], file, [no-error])
8404 Returns a temporary file for writing to some actual file, and also locks it.
8405 Effectively the same as calling lock_file and open_tempfile on the same file,
8406 but calls the unlock for you automatically when it is closed.
8409 sub open_lock_tempfile
8411 my ($fh, $file, $noerror, $notemp, $safe) = @_;
8412 $fh = &callers_package($fh);
8413 my $lockfile = $file;
8414 $lockfile =~ s/^[^\/]*//;
8415 if ($lockfile =~ /^\//) {
8416 $main::open_templocks{$lockfile} = &lock_file($lockfile);
8418 return &open_tempfile($fh, $file, $noerror, $notemp, $safe);
8423 $main::end_exit_status ||= $?;
8424 if ($$ == $main::initial_process_id) {
8425 # Exiting from initial process
8426 &cleanup_tempnames();
8427 if ($gconfig{'debug_what_start'} && $main::debug_log_start_time &&
8428 $main::debug_log_start_module eq &get_module_name()) {
8429 my $len = time() - $main::debug_log_start_time;
8430 &webmin_debug_log("STOP", "runtime=$len");
8431 $main::debug_log_start_time = 0;
8433 if (!$ENV{'SCRIPT_NAME'} &&
8434 $main::initial_module_name eq &get_module_name()) {
8435 # In a command-line script - call the real exit, so that the
8436 # exit status gets properly propogated. In some cases this
8437 # was not happening.
8438 exit($main::end_exit_status);
8443 =head2 month_to_number(month)
8445 Converts a month name like feb to a number like 1.
8450 return $month_to_number_map{lc(substr($_[0], 0, 3))};
8453 =head2 number_to_month(number)
8455 Converts a number like 1 to a month name like Feb.
8460 return ucfirst($number_to_month_map{$_[0]});
8463 =head2 get_rbac_module_acl(user, module)
8465 Returns a hash reference of RBAC overrides ACLs for some user and module.
8466 May return undef if none exist (indicating access denied), or the string *
8467 if full access is granted.
8470 sub get_rbac_module_acl
8472 my ($user, $mod) = @_;
8473 eval "use Authen::SolarisRBAC";
8474 return undef if ($@);
8477 if (Authen::SolarisRBAC::chkauth("webmin.$mod.admin", $user)) {
8478 # Automagic webmin.modulename.admin authorization exists .. allow access
8480 if (!Authen::SolarisRBAC::chkauth("webmin.$mod.config", $user)) {
8481 %rv = ( 'noconfig' => 1 );
8488 open(RBAC, &module_root_directory($mod)."/rbac-mapping");
8492 my ($auths, $acls) = split(/\s+/, $_);
8493 my @auths = split(/,/, $auths);
8495 my ($merge) = ($acls =~ s/^\+//);
8497 if ($auths eq "*") {
8498 # These ACLs apply to all RBAC users.
8499 # Only if there is some that match a specific authorization
8500 # later will they be used though.
8503 # Check each of the RBAC authorizations
8504 foreach my $a (@auths) {
8505 if (!Authen::SolarisRBAC::chkauth($a, $user)) {
8510 $foundany++ if ($gotall);
8513 # Found an RBAC authorization - return the ACLs
8514 return "*" if ($acls eq "*");
8515 my %acl = map { split(/=/, $_, 2) } split(/,/, $acls);
8517 # Just add to current set
8518 foreach my $a (keys %acl) {
8529 return !$foundany ? undef : %rv ? \%rv : undef;
8532 =head2 supports_rbac([module])
8534 Returns 1 if RBAC client support is available, such as on Solaris.
8539 return 0 if ($gconfig{'os_type'} ne 'solaris');
8540 eval "use Authen::SolarisRBAC";
8543 #return 0 if (!-r &module_root_directory($_[0])."/rbac-mapping");
8548 =head2 supports_ipv6()
8550 Returns 1 if outgoing IPv6 connections can be made
8555 return $ipv6_module_error ? 0 : 1;
8558 =head2 use_rbac_module_acl(user, module)
8560 Returns 1 if some user should use RBAC to get permissions for a module
8563 sub use_rbac_module_acl
8565 my $u = defined($_[0]) ? $_[0] : $base_remote_user;
8566 my $m = defined($_[1]) ? $_[1] : &get_module_name();
8567 return 1 if ($gconfig{'rbacdeny_'.$u}); # RBAC forced for user
8568 my %access = &get_module_acl($u, $m, 1);
8569 return $access{'rbac'} ? 1 : 0;
8572 =head2 execute_command(command, stdin, stdout, stderr, translate-files?, safe?)
8574 Runs some command, possibly feeding it input and capturing output to the
8575 give files or scalar references. The parameters are :
8577 =item command - Full command to run, possibly including shell meta-characters.
8579 =item stdin - File to read input from, or a scalar ref containing input, or undef if no input should be given.
8581 =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.
8583 =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.
8585 =item translate-files - Set to 1 to apply filename translation to any filenames. Usually has no effect.
8587 =item safe - Set to 1 if this command is safe and does not modify the state of the system.
8592 my ($cmd, $stdin, $stdout, $stderr, $trans, $safe) = @_;
8593 if (&is_readonly_mode() && !$safe) {
8594 print STDERR "Vetoing command $_[0]\n";
8598 $cmd = &translate_command($cmd);
8600 # Use ` operator where possible
8601 &webmin_debug_log('CMD', "cmd=$cmd") if ($gconfig{'debug_what_cmd'});
8602 if (!$stdin && ref($stdout) && !$stderr) {
8603 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8604 $$stdout = `$cmd 2>$null_file`;
8607 elsif (!$stdin && ref($stdout) && $stdout eq $stderr) {
8608 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8609 $$stdout = `$cmd 2>&1`;
8612 elsif (!$stdin && !$stdout && !$stderr) {
8613 $cmd = "($cmd)" if ($gconfig{'os_type'} ne 'windows');
8614 return system("$cmd >$null_file 2>$null_file <$null_file");
8618 $| = 1; # needed on some systems to flush before forking
8619 pipe(EXECSTDINr, EXECSTDINw);
8620 pipe(EXECSTDOUTr, EXECSTDOUTw);
8621 pipe(EXECSTDERRr, EXECSTDERRw);
8623 if (!($pid = fork())) {
8627 open(STDIN, "<&EXECSTDINr");
8628 open(STDOUT, ">&EXECSTDOUTw");
8629 if (ref($stderr) && $stderr eq $stdout) {
8630 open(STDERR, ">&EXECSTDOUTw");
8633 open(STDERR, ">&EXECSTDERRw");
8640 my $fullcmd = "($cmd)";
8641 if ($stdin && !ref($stdin)) {
8642 $fullcmd .= " <$stdin";
8644 if ($stdout && !ref($stdout)) {
8645 $fullcmd .= " >$stdout";
8647 if ($stderr && !ref($stderr)) {
8648 if ($stderr eq $stdout) {
8649 $fullcmd .= " 2>&1";
8652 $fullcmd .= " 2>$stderr";
8655 if ($gconfig{'os_type'} eq 'windows') {
8659 exec("/bin/sh", "-c", $fullcmd);
8661 print "Exec failed : $!\n";
8668 # Feed input and capture output
8670 if ($stdin && ref($stdin)) {
8671 print EXECSTDINw $$stdin;
8674 if ($stdout && ref($stdout)) {
8676 while(<EXECSTDOUTr>) {
8681 if ($stderr && ref($stderr) && $stderr ne $stdout) {
8683 while(<EXECSTDERRr>) {
8694 =head2 open_readfile(handle, file)
8696 Opens some file for reading. Returns 1 on success, 0 on failure. Pretty much
8697 exactly the same as Perl's open function.
8702 my ($fh, $file) = @_;
8703 $fh = &callers_package($fh);
8704 my $realfile = &translate_filename($file);
8705 &webmin_debug_log('READ', $file) if ($gconfig{'debug_what_read'});
8706 return open($fh, "<".$realfile);
8709 =head2 open_execute_command(handle, command, output?, safe?)
8711 Runs some command, with the specified file handle set to either write to it if
8712 in-or-out is set to 0, or read to it if output is set to 1. The safe flag
8713 indicates if the command modifies the state of the system or not.
8716 sub open_execute_command
8718 my ($fh, $cmd, $mode, $safe) = @_;
8719 $fh = &callers_package($fh);
8720 my $realcmd = &translate_command($cmd);
8721 if (&is_readonly_mode() && !$safe) {
8722 # Don't actually run it
8723 print STDERR "vetoing command $cmd\n";
8726 return open($fh, ">$null_file");
8729 return open($fh, $null_file);
8733 &webmin_debug_log('CMD', "cmd=$realcmd mode=$mode")
8734 if ($gconfig{'debug_what_cmd'});
8736 return open($fh, "| $cmd");
8738 elsif ($mode == 1) {
8739 return open($fh, "$cmd 2>$null_file |");
8741 elsif ($mode == 2) {
8742 return open($fh, "$cmd 2>&1 |");
8746 =head2 translate_filename(filename)
8748 Applies all relevant registered translation functions to a filename. Mostly
8749 for internal use, and typically does nothing.
8752 sub translate_filename
8754 my ($realfile) = @_;
8755 my @funcs = grep { $_->[0] eq &get_module_name() ||
8756 !defined($_->[0]) } @main::filename_callbacks;
8757 foreach my $f (@funcs) {
8759 $realfile = &$func($realfile, @{$f->[2]});
8764 =head2 translate_command(filename)
8766 Applies all relevant registered translation functions to a command. Mostly
8767 for internal use, and typically does nothing.
8770 sub translate_command
8773 my @funcs = grep { $_->[0] eq &get_module_name() ||
8774 !defined($_->[0]) } @main::command_callbacks;
8775 foreach my $f (@funcs) {
8777 $realcmd = &$func($realcmd, @{$f->[2]});
8782 =head2 register_filename_callback(module|undef, &function, &args)
8784 Registers some function to be called when the specified module (or all
8785 modules) tries to open a file for reading and writing. The function must
8786 return the actual file to open. This allows you to override which files
8787 other code actually operates on, via the translate_filename function.
8790 sub register_filename_callback
8792 my ($mod, $func, $args) = @_;
8793 push(@main::filename_callbacks, [ $mod, $func, $args ]);
8796 =head2 register_command_callback(module|undef, &function, &args)
8798 Registers some function to be called when the specified module (or all
8799 modules) tries to execute a command. The function must return the actual
8800 command to run. This allows you to override which commands other other code
8801 actually runs, via the translate_command function.
8804 sub register_command_callback
8806 my ($mod, $func, $args) = @_;
8807 push(@main::command_callbacks, [ $mod, $func, $args ]);
8810 =head2 capture_function_output(&function, arg, ...)
8812 Captures output that some function prints to STDOUT, and returns it. Useful
8813 for functions outside your control that print data when you really want to
8814 manipulate it before output.
8817 sub capture_function_output
8819 my ($func, @args) = @_;
8820 socketpair(SOCKET2, SOCKET1, AF_UNIX, SOCK_STREAM, PF_UNSPEC);
8821 my $old = select(SOCKET1);
8822 my @rv = &$func(@args);
8831 return wantarray ? ($out, \@rv) : $out;
8834 =head2 capture_function_output_tempfile(&function, arg, ...)
8836 Behaves the same as capture_function_output, but uses a temporary file
8837 to avoid buffer full problems.
8840 sub capture_function_output_tempfile
8842 my ($func, @args) = @_;
8843 my $temp = &transname();
8844 open(BUFFER, ">$temp");
8845 my $old = select(BUFFER);
8846 my @rv = &$func(@args);
8849 my $out = &read_file_contents($temp);
8850 &unlink_file($temp);
8851 return wantarray ? ($out, \@rv) : $out;
8854 =head2 modules_chooser_button(field, multiple, [form])
8856 Returns HTML for a button for selecting one or many Webmin modules.
8857 field - Name of the HTML field to place the module names into.
8858 multiple - Set to 1 if multiple modules can be selected.
8859 form - Index of the form on the page.
8862 sub modules_chooser_button
8864 return &theme_modules_chooser_button(@_)
8865 if (defined(&theme_modules_chooser_button));
8866 my $form = defined($_[2]) ? $_[2] : 0;
8867 my $w = $_[1] ? 700 : 500;
8869 if ($_[1] && $gconfig{'db_sizemodules'}) {
8870 ($w, $h) = split(/x/, $gconfig{'db_sizemodules'});
8872 elsif (!$_[1] && $gconfig{'db_sizemodule'}) {
8873 ($w, $h) = split(/x/, $gconfig{'db_sizemodule'});
8875 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";
8878 =head2 substitute_template(text, &hash)
8880 Given some text and a hash reference, for each ocurrance of $FOO or ${FOO} in
8881 the text replaces it with the value of the hash key foo. Also supports blocks
8882 like ${IF-FOO} ... ${ENDIF-FOO}, whose contents are only included if foo is
8883 non-zero, and ${IF-FOO} ... ${ELSE-FOO} ... ${ENDIF-FOO}.
8886 sub substitute_template
8888 # Add some extra fixed parameters to the hash
8889 my %hash = %{$_[1]};
8890 $hash{'hostname'} = &get_system_hostname();
8891 $hash{'webmin_config'} = $config_directory;
8892 $hash{'webmin_etc'} = $config_directory;
8893 $hash{'module_config'} = &get_module_variable('$module_config_directory');
8894 $hash{'webmin_var'} = $var_directory;
8896 # Add time-based parameters, for use in DNS
8897 $hash{'current_time'} = time();
8898 my @tm = localtime($hash{'current_time'});
8899 $hash{'current_year'} = $tm[5]+1900;
8900 $hash{'current_month'} = sprintf("%2.2d", $tm[4]+1);
8901 $hash{'current_day'} = sprintf("%2.2d", $tm[3]);
8902 $hash{'current_hour'} = sprintf("%2.2d", $tm[2]);
8903 $hash{'current_minute'} = sprintf("%2.2d", $tm[1]);
8904 $hash{'current_second'} = sprintf("%2.2d", $tm[0]);
8906 # Actually do the substition
8908 foreach my $s (keys %hash) {
8909 next if ($s eq ''); # Prevent just $ from being subbed
8912 $rv =~ s/\$\{\Q$us\E\}/$sv/g;
8913 $rv =~ s/\$\Q$us\E/$sv/g;
8915 # Replace ${IF}..${ELSE}..${ENDIF} block with first value,
8916 # and ${IF}..${ENDIF} with value
8917 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8918 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$2/g;
8920 # Replace $IF..$ELSE..$ENDIF block with first value,
8921 # and $IF..$ENDIF with value
8922 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8923 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$2/g;
8925 # Replace ${IFEQ}..${ENDIFEQ} block with first value if
8926 # matching, nothing if not
8927 $rv =~ s/\$\{IFEQ-\Q$us\E-\Q$sv\E\}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-\Q$sv\E\}(\n?)/$2/g;
8928 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8930 # Replace $IFEQ..$ENDIFEQ block with first value if
8931 # matching, nothing if not
8932 $rv =~ s/\$IFEQ-\Q$us\E-\Q$sv\E(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\Q$sv\E(\n?)/$2/g;
8933 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8936 # Replace ${IF}..${ELSE}..${ENDIF} block with second value,
8937 # and ${IF}..${ENDIF} with nothing
8938 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ELSE-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)/$4/g;
8939 $rv =~ s/\$\{IF-\Q$us\E\}(\n?)([\000-\377]*?)\$\{ENDIF-\Q$us\E\}(\n?)//g;
8941 # Replace $IF..$ELSE..$ENDIF block with second value,
8942 # and $IF..$ENDIF with nothing
8943 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ELSE-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)/$4/g;
8944 $rv =~ s/\$IF-\Q$us\E(\n?)([\000-\377]*?)\$ENDIF-\Q$us\E(\n?)//g;
8946 # Replace ${IFEQ}..${ENDIFEQ} block with nothing
8947 $rv =~ s/\$\{IFEQ-\Q$us\E-[^\}]+}(\n?)([\000-\377]*?)\$\{ENDIFEQ-\Q$us\E-[^\}]+\}(\n?)//g;
8948 $rv =~ s/\$IFEQ-\Q$us\E-\S+(\n?)([\000-\377]*?)\$ENDIFEQ-\Q$us\E-\S+(\n?)//g;
8952 # Now assume any $IF blocks whose variables are not present in the hash
8953 # evaluate to false.
8954 # $IF...$ELSE x $ENDIF => x
8955 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ELSE\-\1\}(.*?)\$\{ENDIF\-\1\}/$2/gs;
8956 # $IF...x...$ENDIF => (nothing)
8957 $rv =~ s/\$\{IF\-([A-Z]+)\}.*?\$\{ENDIF\-\1\}//gs;
8958 # ${var} => (nothing)
8959 $rv =~ s/\$\{[A-Z]+\}//g;
8964 =head2 running_in_zone
8966 Returns 1 if the current Webmin instance is running in a Solaris zone. Used to
8967 disable module and features that are not appropriate, like those that modify
8968 mounted filesystems.
8973 return 0 if ($gconfig{'os_type'} ne 'solaris' ||
8974 $gconfig{'os_version'} < 10);
8975 my $zn = `zonename 2>$null_file`;
8977 return $zn && $zn ne "global";
8980 =head2 running_in_vserver
8982 Returns 1 if the current Webmin instance is running in a Linux VServer.
8983 Used to disable modules and features that are not appropriate.
8986 sub running_in_vserver
8988 return 0 if ($gconfig{'os_type'} !~ /^\*-linux$/);
8991 open(MTAB, "/etc/mtab");
8993 my ($dev, $mp) = split(/\s+/, $_);
8994 if ($mp eq "/" && $dev =~ /^\/dev\/hdv/) {
9003 =head2 running_in_xen
9005 Returns 1 if Webmin is running inside a Xen instance, by looking
9006 at /proc/xen/capabilities.
9011 return 0 if (!-r "/proc/xen/capabilities");
9012 my $cap = &read_file_contents("/proc/xen/capabilities");
9013 return $cap =~ /control_d/ ? 0 : 1;
9016 =head2 running_in_openvz
9018 Returns 1 if Webmin is running inside an OpenVZ container, by looking
9019 at /proc/vz/veinfo for a non-zero line.
9022 sub running_in_openvz
9024 return 0 if (!-r "/proc/vz/veinfo");
9025 my $lref = &read_file_lines("/proc/vz/veinfo", 1);
9026 return 0 if (!$lref || !@$lref);
9027 foreach my $l (@$lref) {
9029 my @ll = split(/\s+/, $l);
9030 return 0 if ($ll[0] eq '0');
9035 =head2 list_categories(&modules, [include-empty])
9037 Returns a hash mapping category codes to names, including any custom-defined
9038 categories. The modules parameter must be an array ref of module hash objects,
9039 as returned by get_all_module_infos.
9044 my ($mods, $empty) = @_;
9045 my (%cats, %catnames);
9046 &read_file("$config_directory/webmin.catnames", \%catnames);
9047 foreach my $o (@lang_order_list) {
9048 &read_file("$config_directory/webmin.catnames.$o", \%catnames);
9053 foreach my $m (@$mods) {
9054 my $c = $m->{'category'};
9055 next if ($cats{$c});
9056 if (defined($catnames{$c})) {
9057 $cats{$c} = $catnames{$c};
9059 elsif ($text{"category_$c"}) {
9060 $cats{$c} = $text{"category_$c"};
9063 # try to get category name from module ..
9064 my %mtext = &load_language($m->{'dir'});
9065 if ($mtext{"category_$c"}) {
9066 $cats{$c} = $mtext{"category_$c"};
9069 $c = $m->{'category'} = "";
9070 $cats{$c} = $text{"category_$c"};
9077 =head2 is_readonly_mode
9079 Returns 1 if the current user is in read-only mode, and thus all writes
9080 to files and command execution should fail.
9083 sub is_readonly_mode
9085 if (!defined($main::readonly_mode_cache)) {
9086 my %gaccess = &get_module_acl(undef, "");
9087 $main::readonly_mode_cache = $gaccess{'readonly'} ? 1 : 0;
9089 return $main::readonly_mode_cache;
9092 =head2 command_as_user(user, with-env?, command, ...)
9094 Returns a command to execute some command as the given user, using the
9095 su statement. If on Linux, the /bin/sh shell is forced in case the user
9096 does not have a valid shell. If with-env is set to 1, the -s flag is added
9097 to the su command to read the user's .profile or .bashrc file.
9102 my ($user, $env, @args) = @_;
9103 my @uinfo = getpwnam($user);
9104 if ($uinfo[8] ne "/bin/sh" && $uinfo[8] !~ /\/bash$/) {
9105 # User shell doesn't appear to be valid
9106 if ($gconfig{'os_type'} =~ /-linux$/) {
9107 # Use -s /bin/sh to force it
9108 $shellarg = " -s /bin/sh";
9110 elsif ($gconfig{'os_type'} eq 'freebsd' ||
9111 $gconfig{'os_type'} eq 'solaris' &&
9112 $gconfig{'os_version'} >= 11 ||
9113 $gconfig{'os_type'} eq 'macos') {
9114 # Use -m and force /bin/sh
9115 @args = ( "/bin/sh", "-c", quotemeta(join(" ", @args)) );
9119 my $rv = "su".($env ? " -" : "").$shellarg.
9120 " ".quotemeta($user)." -c ".quotemeta(join(" ", @args));
9124 =head2 list_osdn_mirrors(project, file)
9126 This function is now deprecated in favor of letting sourceforge just
9127 redirect to the best mirror, and now just returns their primary download URL.
9130 sub list_osdn_mirrors
9132 my ($project, $file) = @_;
9133 return ( { 'url' => "http://downloads.sourceforge.net/$project/$file",
9135 'mirror' => 'downloads' } );
9138 =head2 convert_osdn_url(url)
9140 Given a URL like http://osdn.dl.sourceforge.net/sourceforge/project/file.zip
9141 or http://prdownloads.sourceforge.net/project/file.zip , convert it
9142 to a real URL on the sourceforge download redirector.
9145 sub convert_osdn_url
9148 if ($url =~ /^http:\/\/[^\.]+.dl.sourceforge.net\/sourceforge\/([^\/]+)\/(.*)$/ ||
9149 $url =~ /^http:\/\/prdownloads.sourceforge.net\/([^\/]+)\/(.*)$/) {
9150 # Always use the Sourceforge mail download URL, which does
9151 # a location-based redirect for us
9152 my ($project, $file) = ($1, $2);
9153 $url = "http://prdownloads.sourceforge.net/sourceforge/".
9155 return wantarray ? ( $url, 0 ) : $url;
9158 # Some other source .. don't change
9159 return wantarray ? ( $url, 2 ) : $url;
9163 =head2 get_current_dir
9165 Returns the directory the current process is running in.
9171 if ($gconfig{'os_type'} eq 'windows') {
9184 =head2 supports_users
9186 Returns 1 if the current OS supports Unix user concepts and functions like
9187 su , getpw* and so on. This will be true on Linux and other Unixes, but false
9193 return $gconfig{'os_type'} ne 'windows';
9196 =head2 supports_symlinks
9198 Returns 1 if the current OS supports symbolic and hard links. This will not
9199 be the case on Windows.
9202 sub supports_symlinks
9204 return $gconfig{'os_type'} ne 'windows';
9207 =head2 quote_path(path)
9209 Returns a path with safe quoting for the current operating system.
9215 if ($gconfig{'os_type'} eq 'windows' || $path =~ /^[a-z]:/i) {
9216 # Windows only supports "" style quoting
9220 return quotemeta($path);
9224 =head2 get_windows_root
9226 Returns the base windows system directory, like c:/windows.
9229 sub get_windows_root
9231 if ($ENV{'SystemRoot'}) {
9232 my $rv = $ENV{'SystemRoot'};
9237 return -d "c:/windows" ? "c:/windows" : "c:/winnt";
9241 =head2 read_file_contents(file)
9243 Given a filename, returns its complete contents as a string. Effectively
9244 the same as the Perl construct `cat file`.
9247 sub read_file_contents
9249 &open_readfile(FILE, $_[0]) || return undef;
9256 =head2 unix_crypt(password, salt)
9258 Performs Unix encryption on a password, using the built-in crypt function or
9259 the Crypt::UnixCrypt module if the former does not work. The salt parameter
9260 must be either an already-hashed password, or a two-character alpha-numeric
9266 my ($pass, $salt) = @_;
9267 return "" if ($salt !~ /^[a-zA-Z0-9\.\/]{2}/); # same as real crypt
9268 my $rv = eval "crypt(\$pass, \$salt)";
9270 return $rv if ($rv && !$@);
9271 eval "use Crypt::UnixCrypt";
9273 return Crypt::UnixCrypt::crypt($pass, $salt);
9276 &error("Failed to encrypt password : $err");
9280 =head2 split_quoted_string(string)
9282 Given a string like I<foo "bar baz" quux>, returns the array :
9286 sub split_quoted_string
9290 while($str =~ /^"([^"]*)"\s*([\000-\377]*)$/ ||
9291 $str =~ /^'([^']*)'\s*([\000-\377]*)$/ ||
9292 $str =~ /^(\S+)\s*([\000-\377]*)$/) {
9299 =head2 write_to_http_cache(url, file|&data)
9301 Updates the Webmin cache with the contents of the given file, possibly also
9302 clearing out old data. Mainly for internal use by http_download.
9305 sub write_to_http_cache
9307 my ($url, $file) = @_;
9308 return 0 if (!$gconfig{'cache_size'});
9310 # Don't cache downloads that look dynamic
9311 if ($url =~ /cgi-bin/ || $url =~ /\?/) {
9315 # Check if the current module should do caching
9316 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
9317 # Caching all except some modules
9318 my @mods = split(/\s+/, $1);
9319 return 0 if (&indexof(&get_module_name(), @mods) != -1);
9321 elsif ($gconfig{'cache_mods'}) {
9322 # Only caching some modules
9323 my @mods = split(/\s+/, $gconfig{'cache_mods'});
9324 return 0 if (&indexof(&get_module_name(), @mods) == -1);
9330 $size = length($$file);
9333 my @st = stat($file);
9337 if ($size > $gconfig{'cache_size'}) {
9338 # Bigger than the whole cache - so don't save it
9343 $cfile = "$main::http_cache_directory/$cfile";
9345 # See how much we have cached currently, clearing old files
9347 mkdir($main::http_cache_directory, 0700) if (!-d $main::http_cache_directory);
9348 opendir(CACHEDIR, $main::http_cache_directory);
9349 foreach my $f (readdir(CACHEDIR)) {
9350 next if ($f eq "." || $f eq "..");
9351 my $path = "$main::http_cache_directory/$f";
9352 my @st = stat($path);
9353 if ($gconfig{'cache_days'} &&
9354 time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
9355 # This file is too old .. trash it
9360 push(@cached, [ $path, $st[7], $st[9] ]);
9364 @cached = sort { $a->[2] <=> $b->[2] } @cached;
9365 while($total+$size > $gconfig{'cache_size'} && @cached) {
9366 # Cache is too big .. delete some files until the new one will fit
9367 unlink($cached[0]->[0]);
9368 $total -= $cached[0]->[1];
9372 # Finally, write out the new file
9374 &open_tempfile(CACHEFILE, ">$cfile");
9375 &print_tempfile(CACHEFILE, $$file);
9376 &close_tempfile(CACHEFILE);
9379 my ($ok, $err) = ©_source_dest($file, $cfile);
9385 =head2 check_in_http_cache(url)
9387 If some URL is in the cache and valid, return the filename for it. Mainly
9388 for internal use by http_download.
9391 sub check_in_http_cache
9394 return undef if (!$gconfig{'cache_size'});
9396 # Check if the current module should do caching
9397 if ($gconfig{'cache_mods'} =~ /^\!(.*)$/) {
9398 # Caching all except some modules
9399 my @mods = split(/\s+/, $1);
9400 return 0 if (&indexof(&get_module_name(), @mods) != -1);
9402 elsif ($gconfig{'cache_mods'}) {
9403 # Only caching some modules
9404 my @mods = split(/\s+/, $gconfig{'cache_mods'});
9405 return 0 if (&indexof(&get_module_name(), @mods) == -1);
9410 $cfile = "$main::http_cache_directory/$cfile";
9411 my @st = stat($cfile);
9412 return undef if (!@st || !$st[7]);
9413 if ($gconfig{'cache_days'} && time()-$st[9] > $gconfig{'cache_days'}*24*60*60) {
9418 open(TOUCH, ">>$cfile"); # Update the file time, to keep it in the cache
9423 =head2 supports_javascript
9425 Returns 1 if the current browser is assumed to support javascript.
9428 sub supports_javascript
9430 if (defined(&theme_supports_javascript)) {
9431 return &theme_supports_javascript();
9433 return $ENV{'MOBILE_DEVICE'} ? 0 : 1;
9436 =head2 get_module_name
9438 Returns the name of the Webmin module that called this function. For internal
9439 use only by other API functions.
9444 return &get_module_variable('$module_name');
9447 =head2 get_module_variable(name, [ref])
9449 Returns the value of some variable which is set in the caller's context, if
9450 using the new WebminCore package. For internal use only.
9453 sub get_module_variable
9455 my ($v, $wantref) = @_;
9456 my $slash = $wantref ? "\\" : "";
9457 my $thispkg = &web_libs_package();
9458 if ($thispkg eq 'WebminCore') {
9459 my ($vt, $vn) = split('', $v, 2);
9461 for(my $i=0; ($callpkg) = caller($i); $i++) {
9462 last if ($callpkg ne $thispkg);
9464 return eval "${slash}${vt}${callpkg}::${vn}";
9466 return eval "${slash}${v}";
9469 =head2 clear_time_locale()
9471 Temporarily force the locale to C, until reset_time_locale is called. This is
9472 useful if your code is going to call C<strftime> from the POSIX package, and
9473 you want to ensure that the output is in a consistent format.
9476 sub clear_time_locale
9478 if ($main::clear_time_locale_count == 0) {
9481 $main::clear_time_locale_old = POSIX::setlocale(POSIX::LC_TIME);
9482 POSIX::setlocale(POSIX::LC_TIME, "C");
9485 $main::clear_time_locale_count++;
9488 =head2 reset_time_locale()
9490 Revert the locale to whatever it was before clear_time_locale was called
9493 sub reset_time_locale
9495 if ($main::clear_time_locale_count == 1) {
9497 POSIX::setlocale(POSIX::LC_TIME, $main::clear_time_locale_old);
9498 $main::clear_time_locale_old = undef;
9501 $main::clear_time_locale_count--;
9504 =head2 callers_package(filehandle)
9506 Convert a non-module filehandle like FOO to one qualified with the
9507 caller's caller's package, like fsdump::FOO. For internal use only.
9513 my $callpkg = (caller(1))[0];
9514 my $thispkg = &web_libs_package();
9515 if (!ref($fh) && $fh !~ /::/ &&
9516 $callpkg ne $thispkg && $thispkg eq 'WebminCore') {
9517 $fh = $callpkg."::".$fh;
9522 =head2 web_libs_package()
9524 Returns the package this code is in. We can't always trust __PACKAGE__. For
9528 sub web_libs_package
9530 if ($called_from_webmin_core) {
9531 return "WebminCore";
9536 =head2 get_userdb_string
9538 Returns the URL-style string for connecting to the users and groups database
9541 sub get_userdb_string
9543 return undef if ($main::no_miniserv_userdb);
9545 &get_miniserv_config(\%miniserv);
9546 return $miniserv{'userdb'};
9549 =head2 connect_userdb(string)
9551 Returns a handle for talking to a user database - may be a DBI or LDAP handle.
9552 On failure returns an error message string. In an array context, returns the
9559 my ($proto, $user, $pass, $host, $prefix, $args) = &split_userdb_string($str);
9560 if ($proto eq "mysql") {
9561 # Connect to MySQL with DBI
9562 my $drh = eval "use DBI; DBI->install_driver('mysql');";
9563 $drh || return $text{'sql_emysqldriver'};
9564 my ($host, $port) = split(/:/, $host);
9565 my $cstr = "database=$prefix;host=$host";
9566 $cstr .= ";port=$port" if ($port);
9567 my $dbh = $drh->connect($cstr, $user, $pass, { });
9568 $dbh || return &text('sql_emysqlconnect', $drh->errstr);
9569 return wantarray ? ($dbh, $proto, $prefix, $args) : $dbh;
9571 elsif ($proto eq "postgresql") {
9572 # Connect to PostgreSQL with DBI
9573 my $drh = eval "use DBI; DBI->install_driver('Pg');";
9574 $drh || return $text{'sql_epostgresqldriver'};
9575 my ($host, $port) = split(/:/, $host);
9576 my $cstr = "dbname=$prefix;host=$host";
9577 $cstr .= ";port=$port" if ($port);
9578 my $dbh = $drh->connect($cstr, $user, $pass);
9579 $dbh || return &text('sql_epostgresqlconnect', $drh->errstr);
9580 return wantarray ? ($dbh, $proto, $prefix, $args) : $dbh;
9582 elsif ($proto eq "ldap") {
9583 # Connect with perl LDAP module
9584 eval "use Net::LDAP";
9585 $@ && return $text{'sql_eldapdriver'};
9586 my ($host, $port) = split(/:/, $host);
9587 my $scheme = $args->{'scheme'} || 'ldap';
9589 $port = $scheme eq 'ldaps' ? 636 : 389;
9591 my $ldap = Net::LDAP->new($host,
9593 'scheme' => $scheme);
9594 $ldap || return &text('sql_eldapconnect', $host);
9596 if ($args->{'tls'}) {
9597 # Switch to TLS mode
9598 eval { $mesg = $ldap->start_tls(); };
9599 if ($@ || !$mesg || $mesg->code) {
9600 return &text('sql_eldaptls',
9601 $@ ? $@ : $mesg ? $mesg->error : "Unknown error");
9604 # Login to the server
9606 $mesg = $ldap->bind(dn => $user, password => $pass);
9609 $mesg = $ldap->bind(dn => $user, anonymous => 1);
9611 if (!$mesg || $mesg->code) {
9612 return &text('sql_eldaplogin', $user,
9613 $mesg ? $mesg->error : "Unknown error");
9615 return wantarray ? ($ldap, $proto, $prefix, $args) : $ldap;
9618 return "Unknown protocol $proto";
9622 =head2 disconnect_userdb(string, &handle)
9624 Closes a handle opened by connect_userdb
9627 sub disconnect_userdb
9630 if ($str =~ /^(mysql|postgresql):/) {
9632 if (!$h->{'AutoCommit'}) {
9637 elsif ($str =~ /^ldap:/) {
9644 =head2 split_userdb_string(string)
9646 Converts a string like mysql://user:pass@host/db into separate parts
9649 sub split_userdb_string
9652 if ($str =~ /^([a-z]+):\/\/([^:]*):([^\@]*)\@([a-z0-9\.\-\_]+)\/([^\?]+)(\?(.*))?$/) {
9653 my ($proto, $user, $pass, $host, $prefix, $argstr) =
9654 ($1, $2, $3, $4, $5, $7);
9655 my %args = map { split(/=/, $_, 2) } split(/\&/, $argstr);
9656 return ($proto, $user, $pass, $host, $prefix, \%args);
9661 $done_web_lib_funcs = 1;