FM / usermin

/usr/share/usermin

Name	Size	Mode	Actions
at/	-	0755	rm
authentic-theme/	-	0755	rm
blue-theme/	-	0755	rm
changepass/	-	0755	rm
chfn/	-	0755	rm
commands/	-	0755	rm
cron/	-	0755	rm
cshrc/	-	0755	rm
fetchmail/	-	0755	rm
filemin/	-	0755	rm
filter/	-	0755	rm
forward/	-	0755	rm
gnupg/	-	0755	rm
gray-theme/	-	0755	rm
htaccess/	-	0755	rm
htaccess-htpasswd/	-	0755	rm
images/	-	0755	rm
lang/	-	0755	rm
language/	-	0755	rm
mailbox/	-	0755	rm
mailcap/	-	0755	rm
man/	-	0755	rm
mysql/	-	0755	rm
plan/	-	0755	rm
postgresql/	-	0755	rm
proc/	-	0755	rm
procmail/	-	0755	rm
quota/	-	0755	rm
schedule/	-	0755	rm
shell/	-	0755	rm
spam/	-	0755	rm
ssh/	-	0755	rm
theme/	-	0755	rm
tunnel/	-	0755	rm
twofactor/	-	0755	rm
ulang/	-	0755	rm
unauthenticated/	-	0755	rm
updown/	-	0755	rm
usermount/	-	0755	rm
vendor_perl/	-	0755	rm
xterm/	-	0755	rm
acl_security.pl	2959	0755	edit dl rm
chooser.cgi	7387	0755	edit dl rm
config-aix	227	0644	edit dl rm
config-cobalt-linux	264	0644	edit dl rm
config-coherent-linux	264	0644	edit dl rm
config-corel-linux	264	0644	edit dl rm
config-debian-linux	264	0644	edit dl rm
config-freebsd	256	0644	edit dl rm
config-generic-linux	264	0644	edit dl rm
config-gentoo-linux	264	0644	edit dl rm
config-hpux	243	0644	edit dl rm
config-irix	284	0644	edit dl rm
config-lib.pl	12120	0755	edit dl rm
config-macos	260	0644	edit dl rm
config-mandrake-linux	278	0644	edit dl rm
config-msc-linux	264	0644	edit dl rm
config-netbsd	283	0644	edit dl rm
config-open-linux	264	0644	edit dl rm
config-openbsd	241	0644	edit dl rm
config-openmamba-linux	264	0644	edit dl rm
config-openserver	236	0644	edit dl rm
config-osf1	266	0644	edit dl rm
config-redhat-linux	264	0644	edit dl rm
config-slackware-linux	280	0644	edit dl rm
config-sol-linux	264	0644	edit dl rm
config-solaris	417	0644	edit dl rm
config-suse-linux	264	0644	edit dl rm
config-trustix-linux	264	0644	edit dl rm
config-turbo-linux	264	0644	edit dl rm
config-united-linux	264	0644	edit dl rm
config-unixware	286	0644	edit dl rm
copyconfig.pl	4436	0755	edit dl rm
date_chooser.cgi	2241	0755	edit dl rm
deb-name	8	0644	edit dl rm
defaultacl	98	0644	edit dl rm
defaulttheme	16	0644	edit dl rm
entities_map.txt	1501	0644	edit dl rm
favicon.ico	15086	0644	edit dl rm
feedback.cgi	6519	0755	edit dl rm
feedback_form.cgi	3533	0755	edit dl rm
group_chooser.cgi	7690	0755	edit dl rm
help.cgi	2313	0755	edit dl rm
html-editor-lib.pl	18147	0644	edit dl rm
index.cgi	5781	0755	edit dl rm
install-module.pl	1304	0755	edit dl rm
install-type	4	0644	edit dl rm
javascript-lib.pl	15042	0755	edit dl rm
lang_list.txt	2570	0644	edit dl rm
LICENCE	1516	0644	edit dl rm
LICENCE.ja	1654	0644	edit dl rm
maketemp.pl	424	0755	edit dl rm
mime.types	12713	0644	edit dl rm
miniserv.pem	2969	0644	edit dl rm
miniserv.pl	189439	0755	edit dl rm
newmods.pl	1280	0755	edit dl rm
oschooser.pl	4655	0755	edit dl rm
os_list.txt	35825	0644	edit dl rm
pam_login.cgi	4429	0755	edit dl rm
password_change.cgi	7192	0755	edit dl rm
password_form.cgi	1327	0755	edit dl rm
perlpath.pl	571	0755	edit dl rm
README	1972	0644	edit dl rm
robots.txt	26	0644	edit dl rm
session_login.cgi	5230	0755	edit dl rm
setup.sh	26810	0755	edit dl rm
switch_user.cgi	404	0755	edit dl rm
thirdparty.pl	1774	0755	edit dl rm
uconfig.cgi	1428	0755	edit dl rm
uconfig_save.cgi	1490	0755	edit dl rm
ui-lib.pl	115945	0755	edit dl rm
update-from-repo.sh	15124	0755	edit dl rm
updateboot.pl	2429	0755	edit dl rm
uptracker.cgi	2956	0755	edit dl rm
usermin-init	1927	0755	edit dl rm
usermin-pam	101	0644	edit dl rm
usermin-pam-osx	243	0644	edit dl rm
usermin-systemd	443	0644	edit dl rm
user_chooser.cgi	7571	0755	edit dl rm
version	6	0644	edit dl rm
web-lib-funcs.pl	405160	0755	edit dl rm
web-lib.pl	907	0755	edit dl rm
webmin-search-lib.pl	9697	0755	edit dl rm
WebminCore.pm	8873	0644	edit dl rm
webmin_search.cgi	2697	0755	edit dl rm

Edit: /usr/share/usermin/webmin-search-lib.pl (9697B)

# Functions for searching the webmin docs and UI

=head2 search_webmin(phrase, [callback-function], [&modules])

Searches all Webmin help pages, UI text, module names and config.info files
for entries matching the given phrase or word. Returns them sorted by relevance
order, each as a hash ref with the following keys :

=item mod - A module hash reference for the module the search result was in

=item rank - A result ranking, higher being better

=item type - One of mod (for module name), dir (for module directory), config (configuration setting), help (help page) or text (UI text)

=item text - The text that matched

=items cgis - An array ref of pages on which the text appears, each formatted like module/script.cgi

=cut
sub search_webmin
{
my ($re, $cbfunc, $onlymods) = @_;

# Work out this Webmin's URL base
my $urlhost = $ENV{'HTTP_HOST'};
if ($urlhost !~ /:/) {
	$urlhost .= ":".$ENV{'SERVER_PORT'};
	}
my $urlbase = ($ENV{'HTTPS'} eq 'ON' ? 'https://' : 'http://').$urlhost;

# Search module names and add to results list
my @rv = ( );
my $pn = &get_product_name();
my @mods;
if ($onlymods) {
	# Modules specified by caller
	@mods = grep { &foreign_available($_->{'dir'}) } @$onlymods;
	}
else {
	# All reasonable modules
	@mods = &get_available_module_infos();
	}
@mods = grep { !($_->{clone} || $_->{noui} || ($pn && $_->{"${pn}_noui"})) &&
	       (($_->{hidden} // 0) != 1) } @mods;
@mods = sort { $b->{'longdesc'} cmp $a->{'longdesc'} } @mods;
foreach my $m (@mods) {
	if ($m->{'desc'} =~ /\Q$re\E/i) {
		# Module description match
		push(@rv, { 'mod' => $m,
			    'rank' => 10,
			    'type' => 'mod',
			    'link' => $m->{'dir'}.'/',
			    'text' => $m->{'desc'} });
		}
	elsif ($m->{'longdesc'} =~ /\Q$re\E/i) {
		# Module long description match
		push(@rv, { 'mod' => $m,
			    'rank' => 9.5,
			    'type' => 'mod',
			    'link' => $m->{'dir'}.'/',
			    'text' => $m->{'longdesc'} });
		}
	elsif ($m->{'dir'} =~ /\Q$re\E/i) {
		# Module directory match
		push(@rv, { 'mod' => $m,
			    'rank' => 9,
			    'type' => 'dir',
			    'link' => $m->{'dir'}.'/',
			    'text' => $urlbase."/".$m->{'dir'}."/" });
		}
	&$cbfunc() if ($cbfunc);
	}

# Extract zipped help files to temp dir
my $helpbase = &transname();
&make_dir($helpbase, 0700);
my %helpmap;
foreach my $m (@mods) {
	my $helpzip = &module_root_directory($m)."/help/help.zip";
	if (-r $helpzip) {
		my $helpdir = $helpbase."/".$m->{'dir'};
		&make_dir($helpdir, 0700);
		&execute_command("cd ".quotemeta($helpdir)." && unzip ".quotemeta($helpzip));
		if (!$?) {
			$helpmap{$m->{'dir'}} = $helpdir;
			}
		}
	}

# Search module configs and their help pages
foreach my $m (@mods) {
	my %access = &get_module_acl(undef, $m);
	next if ($access{'noconfig'});
	my $file = $prod eq 'webmin' ? "$root_directory/$m->{'dir'}/config.info"
				     : "$root_directory/$m->{'dir'}/uconfig.info";
	my %info = ( );
	my @info_order = ( );
	&read_file($file, \%info, \@info_order);
	foreach my $o (@lang_order_list) {
		&read_file("$file.$o", \%info);
		}
	my $section = undef;
	my $helpdir = $helpmap{$m->{'dir'}};
	foreach my $c (@info_order) {
		my @p = split(/,/, $info{$c});
		if ($p[1] == 11) {
			$section = $c;
			}
		if ($p[0] =~ /\Q$re\E/i) {
			# Config description matches
			push(@rv, { 'mod' => $m,
				    'rank' => 8,
				    'type' => 'config',
				    'link' => "/config.cgi?module=$m->{'dir'}&".
					     "section=".&urlize($section)."#$c",
				    'text' => $p[0],
				  });
			}
		my $hfl = &help_file($mod->{'dir'}, "config_".$c, $helpdir);
		my ($title, $help) = &help_file_match($hfl);
		if ($help) {
			# Config help matches
			push(@rv, { 'mod' => $m,
                                    'rank' => 6,
				    'type' => 'help',
				    'link' => "/help.cgi/$m->{'dir'}/config_".$c,
				    'desc' => &text('wsearch_helpfor', $p[0]),
				    'text' => $help,
				    'cgis' => [ "/config.cgi?".
					        "module=$m->{'dir'}&section=".
						&urlize($section)."#$c" ],
				   });
			}
		}
	&$cbfunc() if ($cbfunc);
	}

# Search other help pages
my %lang_order_list = map { $_, 1 } @lang_order_list;
foreach my $m (@mods) {
	my $helpdir = $helpmap{$m->{'dir'}} ||
		      &module_root_directory($m)."/help";
	my %donepage = ( );
	opendir(DIR, $helpdir);
	foreach my $f (sort { length($b) <=> length($a) } readdir(DIR)) {
		next if ($f =~ /^config_/);	# For config help, already done

# Work out if we should grep this help page - don't do the same
		# page twice for different languages
		my $grep = 0;
		my ($page, $lang);
		if ($f =~ /^(\S+)\.([^\.]+)\.html$/) {
			($page, $lang) = ($1, $2);
			if ($lang_order_list{$lang} && !$donepage{$page}++) {
				$grep = 1;
				}
			}
		elsif ($f =~ /^(\S+)\.html$/) {
			$page = $1;
			if (!$donepage{$page}++) {
				$grep = 1;
				}
			}

# If yes, search it
		if ($grep) {
			my ($title, $help) = &help_file_match("$helpdir/$f");
			if ($title) {
				my @cgis = &find_cgi_text(
					[ "hlink\\(.*'$page'",
					  "hlink\\(.*\"$page\"",
					  "header\\([^,]+,[^,]+,[^,]+,\\s*\"$page\"",
					  "header\\([^,]+,[^,]+,[^,]+,\\s*'$page'",
					], $m, 1);
				push(@rv, { 'mod' => $m,
					    'rank' => 6,
					    'type' => 'help',
					    'link' => "/help.cgi/$m->{'dir'}/$page",
					    'desc' => $title,
					    'text' => $help,
					    'cgis' => \@cgis });
				}
			}
		&$cbfunc() if ($cbfunc);
		}
	closedir(DIR);
	}

# Then do text strings
my %gtext = &load_language("");
MODULE: foreach my $m (@mods) {
	my %mtext = &load_language($m->{'dir'});
	foreach my $k (keys %mtext) {
		next if ($gtext{$k});	# Skip repeated global strings
		$mtext{$k} =~ s/\$[0-9]//g;
		if ($mtext{$k} =~ /\Q$re\E/i) {
			# Find CGIs that use this text
			my @cgis = &find_cgi_text(
				[ "\$text{'$k'}",
				  "\$text{\"$k\"}",
				  "\$text{$k}",
				  "&text('$k'",
				  "&text(\"$k\"" ], $m);
			if (@cgis) {
				push(@rv, { 'mod' => $m,
					    'rank' => 4,
					    'type' => 'text',
					    'text' => $mtext{$k},
					    'cgis' => \@cgis });
				}
			}
		}
	&$cbfunc() if ($cbfunc);
	}

# Sort results by relevancy
# XXX can do better?
@rv = sort { $b->{'rank'} <=> $a->{'rank'} ||
	     lc($a->{'mod'}->{'desc'}) cmp lc($b->{'mod'}->{'desc'}) } @rv;
return @rv;
}

# highlight_text(text, [length])
# Returns text with the search term bolded, and truncated to 50 characters
sub highlight_text
{
local ($str, $len) = @_;
$len ||= 50;
local $hlen = $len / 2;
$str =~ s/<[^>]*>//g;
if ($str =~ /(.*)(\Q$re\E)(.*)/i) {
	local ($before, $match, $after) = ($1, $2, $3);
	if (length($before) > $hlen) {
		$before = "...".substr($before, length($before)-$hlen);
		}
	if (length($after) > $hlen) {
		$after = substr($after, 0, $hlen)."...";
		}
	$str = $before."<b>".&html_escape($match)."</b>".$after;
	}
return $str;
}

# find_cgi_text(&regexps, module, re-mode)
# Returns the relative URLs of CGIs that matches some regexps, in the given
# module. Does not include those that don't call some header function, as
# they cannot be linked to normally
sub find_cgi_text
{
local ($res, $m, $remode) = @_;
local $mdir = &module_root_directory($m);
local @rv;
foreach my $f (glob("$mdir/*.cgi")) {
	local $found = 0;
	local $header = 0;
	open(CGI, "<".$f);
	LINE: while(my $line = <CGI>) {
		if ($line =~ /(header|ui_print_header|ui_print_unbuffered_header)\(/) {
			$header++;
			}
		foreach my $r (@$res) {
			if (!$remode && index($line, $r) >= 0 ||
			    $remode && $line =~ /$r/) {
				$found++;
				last LINE;
				}
			}
		}
	close(CGI);
	if ($found && $header) {
		local $url = $f;
		$url =~ s/^\Q$root_directory\E\///;
		push(@rv, $url);
		}
	}
return @rv;
}

# help_file_match(file)
# Returns the title if some help file matches the current search
sub help_file_match
{
local ($f) = @_;
local $data = &read_file_contents($f);
local $title;
if ($data =~ /<header>([^<]*)<\/header>/) {
	$title = $1;
	}
$data =~ s/\s+/ /g;
$data =~ s/<p>/\n\n/gi;
$data =~ s/<br>/\n/gi;
$data =~ s/<[^>]+>//g;
if ($data =~ /\Q$re\E/i) {
	return ($title, $data);
	}
return ( );
}

# cgi_page_title(module, cgi)
# Given a CGI, return the text for its page title, if possible
sub cgi_page_title
{
local ($m, $cgi) = @_;
local $data = &read_file_contents(&module_root_directory($m)."/".$cgi);
local $rv;
if ($data =~ /(ui_print_header|ui_print_unbuffered_header)\([^,]+,[^,]*(\$text\{'([^']+)'|\$text\{"([^"]+)"|\&text\('([^']+)'|\&text\("([^"]+)")/) {
	# New header function, with arg before title
	local $msg = $3 || $4 || $5 || $6;
	local %mtext = &load_language($m);
	$rv = $mtext{$msg};
	}
elsif ($data =~ /(^|\s|mail_page_)header\(\s*(\$text\{'([^']+)'|\$text\{"([^"]+)"|\&text\('([^']+)'|\&text\("([^"]+)")/) {
	# Old header function
	local $msg = $3 || $4 || $5 || $6;
	local %mtext = &load_language($m);
	$rv = $mtext{$msg};
	}
if ($cgi eq "index.cgi" && !$rv) {
	# If no title was found for an index.cgi, use module title
	local %minfo = &get_module_info($m);
	$rv = $minfo{'desc'};
	}
return $rv;
}

# cgi_page_args(module, cgi)
# Given a module and CGI name, returns a string of URL parameters that can be
# used for linking to it. Returns "none" if parameters are needed, but cannot
# be determined.
sub cgi_page_args
{
local ($m, $cgi) = @_;
local $mroot = &module_root_directory($m);
if (-r "$mroot/cgi_args.pl") {
	# Module can tell us what args to use
	&foreign_require($m, "cgi_args.pl");
	$args = &foreign_call($m, "cgi_args", $cgi);
	if (defined($args)) {
		return $args;
		}
	}
if ($cgi eq "index.cgi") {
	# Index page is always safe to link to
	return undef;
	}
# Otherwise check if it appears to parse any args
local $data = &read_file_contents($mroot."/".$cgi);
if ($data =~ /(ReadParse|ReadParseMime)\(/) {
	return "none";
	}
return undef;
}

cmd: