← Back
Editing: spam-lib.pl
# spam-lib.pl # Common functions for parsing and editing the spamassassin config file BEGIN { push(@INC, ".."); }; use WebminCore; use Fcntl; &init_config(); $warn_procmail = $config{'warn_procmail'}; if ($module_info{'usermin'}) { # Running under Usermin, editing user's personal config file &switch_to_remote_user(); &create_user_config_dirs(); if ($config{'local_cf'} !~ /^\//) { # Path is relative to home dir &set_config_file("$remote_user_info[7]/$config{'local_cf'}"); if ($local_cf =~ /^(.*)\// && !-d $1) { mkdir($1, 0700); } } else { &set_config_file($config{'local_cf'}); } $database_userpref_name = $remote_user; $include_config_files = !$config{'mode'} || $config{'readfiles'}; $add_to_db = 1; $max_awl_keys = $userconfig{'max_awl'} || 200; } else { # Running under Webmin, typically editing global config file %access = &get_module_acl(); if ($access{'file'}) { &set_config_file($access{'file'}); } else { if (!-r $config{'local_cf'} && -r $config{'alt_local_cf'}) { # Copy in default config file ©_source_dest($config{'alt_local_cf'}, $config{'local_cf'}); } &set_config_file($config{'local_cf'}); } if ($access{'nocheck'}) { $warn_procmail = 0; } $database_userpref_name = $config{'dbglobal'} || '@GLOBAL'; $include_config_files = 1; $add_to_db = $config{'addto'}; $max_awl_keys = $config{'max_awl'} || 200; } $ldap_spamassassin_attr = $config{'attr'} || 'spamassassin'; $ldap_username_attr = $config{'uid'} || 'uid'; # set_config_file(file) # Change the default file read by get_config. Under Webmin, checks if this file # is accessible to the current user sub set_config_file { local ($file) = @_; if (!$module_info{'usermin'}) { # Check for valid file local %cans; $cans{$access{'file'}} = 1 if ($access{'file'}); foreach my $f (split(/\s+/, $access{'files'})) { $cans{$f} = 1; } if (keys %cans) { $cans{$file} || &error(&text('index_ecannot', "<tt>".&html_escape($file)."</tt>")); } } $local_cf = $file; $add_cf = !-d $local_cf ? $local_cf : $module_info{'usermin'} ? "$local_cf/user_prefs" : "$local_cf/local.cf"; } sub set_config_file_in { local ($in) = @_; $header_subtext = undef; $redirect_url = ""; $form_hiddens = ""; if (!$module_info{'usermin'} && $in{'file'}) { &set_config_file($in{'file'}); $header_subtext = $in{'title'} || "<tt>$in{'file'}</tt>"; $redirect_url = "index.cgi?file=".&urlize($in{'file'}). "&title=".&urlize($in{'title'}); $form_hiddens = &ui_hidden("file", $in{'file'}). &ui_hidden("title", $in{'title'}); $module_index_link = $redirect_url; } } # get_config([file], [for-global]) # Return a structure containing the contents of the spamassassin config file sub get_config { local $forglobal = $_[1]; local @rv; if ($include_config_files || $forglobal) { # Reading from file(s) local $lnum = 0; local $file = $_[0] || $local_cf; if (-d $file) { # A directory of files - read them all opendir(DIR, $file); local @files = sort { $a cmp $b } readdir(DIR); closedir(DIR); local $f; foreach $f (@files) { if ($f =~ /\.(cf|pre)$/) { local $add = &get_config("$file/$f",$forglobal); map { $_->{'index'} += scalar(@rv) } @$add; push(@rv, @$add); } } } else { # A single file that can be read right here open(FILE, "<".$file); while(<FILE>) { s/\r|\n//g; s/^#.*$//; if (/^(\S+)\s*(.*)$/) { local $dir = { 'name' => $1, 'value' => $2, 'index' => scalar(@rv), 'file' => $file, 'mode' => 0, 'line' => $lnum }; $dir->{'words'} = [ split(/\s+/, $dir->{'value'}) ]; push(@rv, $dir); } $lnum++; } close(FILE); } } if ($config{'mode'} == 1 || $config{'mode'} == 2) { # Add from SQL database local $dbh = &connect_spamassasin_db(); &error($dbh) if (!ref($dbh)); local $cmd = $dbh->prepare("select preference,value from userpref where username = ?"); $cmd->execute(!$forglobal ? $database_userpref_name : $config{'dbglobal'} ? $config{'dbglobal'} : '@GLOBAL'); while(my ($name, $value) = $cmd->fetchrow()) { local $dir = { 'name' => $name, 'value' => $value, 'index' => scalar(@rv), 'mode' => $config{'mode'} }; $dir->{'words'} = [ split(/\s+/, $dir->{'value'}) ]; push(@rv, $dir); } $cmd->finish(); } elsif ($config{'mode'} == 3 && !$forglobal) { # From LDAP local $ldap = &connect_spamassassin_ldap(); &error($ldap) if (!ref($ldap)); local $uinfo = &get_ldap_user($ldap); if ($uinfo) { local $aindex = 0; foreach my $a ($uinfo->get_value($ldap_spamassassin_attr)) { local ($name, $value) = split(/\s+/, $a, 2); local $dir = { 'name' => $name, 'value' => $value, 'index' => scalar(@rv), 'aindex' => $aindex++, 'oldattr' => $a, 'mode' => $config{'mode'} }; $dir->{'words'} = [ split(/\s+/, $dir->{'value'}) ]; push(@rv, $dir); } } } return \@rv; } # alt_name(name, &config) # Returns an alternate directive name if the current one is obsoleted sub alt_name { my ($name, $conf) = @_; my $newname = $name; if ($newname =~ s/whitelist/welcomelist/ || $newname =~ s/blacklist/blocklist/) { # Is the new directive being used? my @olduse = &find($name, $conf, 1); my @newuse = &find($newname, $conf, 1); if (@newuse) { # New name exists in config, so use it $name = $newname; } elsif (!@olduse && &version_atleast("4.0")) { # Neither exists, but use the new name is later versions $name = $newname; } } return $name; } # find(name, &config, [no-alt]) sub find { my ($name, $conf, $noalt) = @_; my @rv; $name = &alt_name($name, $conf) if (!$noalt); foreach my $c (@$conf) { push(@rv, $c) if (lc($c->{'name'}) eq lc($name)); } return wantarray ? @rv : $rv[0]; } # find_value(name, &config, [no-alt]) sub find_value { my @rv = map { $_->{'value'} } &find(@_); return wantarray ? @rv : $rv[0]; } # save_directives(&config, name|&old, &new, valuesonly) # Update the config file with some directives sub save_directives { my ($conf, $nameold, $newv, $vonly) = @_; if ($module_info{'usermin'} && $local_cf =~ /^(.*)\/([^\/]+)$/) { # Under Usermin, make sure .spamassassin exists local $spamdir = $1; if (!-d $spamdir) { &make_dir($spamdir, 0755); } } if (!ref($nameold)) { $nameold = &alt_name($nameold, $conf); } my @old = ref($nameold) ? @$nameold : &find($nameold, $conf); my @new = $vonly ? &make_directives($nameold, $newv) : @$newv; for(my $i=0; $i<@old || $i<@new; $i++) { my $line; if ($new[$i]) { $line = $new[$i]->{'name'}; $line .= " ".$new[$i]->{'value'} if ($new[$i]->{'value'} ne ''); } if ($old[$i] && $new[$i]) { # Replacing a directive if ($old[$i]->{'name'} eq $new[$i]->{'name'} && $old[$i]->{'value'} eq $new[$i]->{'value'}) { # Nothing to do! next; } if ($old[$i]->{'mode'} == 0) { # In a file local $lref = &read_file_lines($old[$i]->{'file'}); $lref->[$old[$i]->{'line'}] = $line; } elsif ($old[$i]->{'mode'} == 1 || $old[$i]->{'mode'} == 2) { # In an SQL DB local $dbh = &connect_spamassasin_db(); &error($dbh) if (!ref($dbh)); local $cmd = $dbh->prepare("update userpref set value = ? where username = ? and preference = ? and value = ?"); $cmd->execute($new[$i]->{'value'}, $database_userpref_name, $old[$i]->{'name'}, $old[$i]->{'value'}); $cmd->finish(); } elsif ($old[$i]->{'mode'} == 3) { # In LDAP - modify the attribute local $ldap = &connect_spamassassin_ldap(); &error($ldap) if (!ref($ldap)); local $uinfo = &get_ldap_user($ldap); $uinfo || &error(&text('ldap_euser', $database_userpref_name)); local @values = $uinfo->get_value( $ldap_spamassassin_attr); $values[$old[$i]->{'aindex'}] = $new[$i]->{'name'}." ". $new[$i]->{'value'}; local $rv = $ldap->modify( $uinfo->dn(), replace => { $ldap_spamassassin_attr => \@values }); if (!$rv || $rv->code) { &error(&text('eldap', $rv ? $rv->error : "Unknown modify error")); } } $conf->[$old[$i]->{'index'}] = $new[$i]; } elsif ($old[$i]) { # Deleting a directive if ($old[$i]->{'mode'} == 0) { # From a file local $lref = &read_file_lines($old[$i]->{'file'}); splice(@$lref, $old[$i]->{'line'}, 1); foreach $c (@$conf) { if ($c->{'line'} > $old[$i]->{'line'} && $c->{'file'} eq $old[$i]->{'file'}) { $c->{'line'}--; } } } elsif ($old[$i]->{'mode'} == 1 || $old[$i]->{'mode'} == 2) { # From an SQL DB local $dbh = &connect_spamassasin_db(); &error($dbh) if (!ref($dbh)); local $cmd = $dbh->prepare("delete from userpref where username = ? and preference = ? and value = ?"); $cmd->execute($database_userpref_name, $old[$i]->{'name'}, $old[$i]->{'value'}); $cmd->finish(); } elsif ($old[$i]->{'mode'} == 3) { # From LDAP .. get current values, and remove this one local $ldap = &connect_spamassassin_ldap(); &error($ldap) if (!ref($ldap)); local $uinfo = &get_ldap_user($ldap); $uinfo || &error(&text('ldap_euser', $database_userpref_name)); local @values = $uinfo->get_value( $ldap_spamassassin_attr); splice(@values, $old[$i]->{'aindex'}, 1); local $rv = $ldap->modify( $uinfo->dn(), replace => { $ldap_spamassassin_attr => \@values }); if (!$rv || $rv->code) { &error(&text('eldap', $rv ? $rv->error : "Unknown delete error")); } } # Fix up indexes splice(@$conf, $old[$i]->{'index'}, 1); foreach $c (@$conf) { if ($c->{'index'} > $old[$i]->{'index'}) { $c->{'index'}--; } } } elsif ($new[$i]) { # Adding a directive local $addmode = scalar(@old) ? $old[0]->{'mode'} : $new[$i]->{'name'} =~ /^user_scores_/ ? 0 : $add_to_db ? $config{'mode'} : 0; if ($addmode == 0) { # To a file local $lref = &read_file_lines($add_cf); $new[$i]->{'line'} = @$lref; push(@$lref, $line); } elsif ($addmode == 1 || $addmode == 2) { # To an SQL DB local $dbh = &connect_spamassasin_db(); &error($dbh) if (!ref($dbh)); local $cmd = $dbh->prepare("insert into userpref (username, preference, value) values (?, ?, ?)"); $cmd->execute($database_userpref_name, $new[$i]->{'name'}, $new[$i]->{'value'}); $cmd->finish(); } elsif ($addmode == 3) { # To LDAP local $ldap = &connect_spamassassin_ldap(); &error($ldap) if (!ref($ldap)); local $uinfo = &get_ldap_user($ldap); $uinfo || &error(&text('ldap_euser', $database_userpref_name)); local $rv = $ldap->modify( $uinfo->dn(), add => { $ldap_spamassassin_attr => $new[$i]->{'name'}." ".$new[$i]->{'value'} }); if (!$rv || $rv->code) { &error(&text('eldap', $rv ? $rv->error : "Unknown add error")); } } $new[$i]->{'mode'} = $addmode; $new[$i]->{'index'} = @$conf; push(@$conf, $new[$i]); } } } # make_directives(name, &values) # Converts a list of values into a list of directive objects sub make_directives { my ($name, $vals) = @_; return map { { 'name' => $name, 'value' => $_ } } @$vals; } ### UI functions ### # edit_table(name, &headings, &&values, &sizes, [&convfunc], blankrows) # Display a table of values for editing, with one blank row sub edit_table { local ($h, $v); local $rv = &ui_columns_start($_[1]); local $i = 0; local $cfunc = $_[4] || \&default_convfunc; local $blanks = $_[5] || 1; foreach $v (@{$_[2]}, map { [ ] } (1 .. $blanks)) { local @cols; for($j=0; $j<@{$_[1]}; $j++) { push(@cols, &$cfunc($j, "$_[0]_${i}_${j}", $_[3]->[$j], $v->[$j], $v)); } $rv .= &ui_columns_row(\@cols); $i++; } $rv .= &ui_columns_end(); return $rv; } # default_convfunc(column, name, size, value) sub default_convfunc { return "<input name=$_[1] size=$_[2] value='".&html_escape($_[3])."'>"; } # parse_table(name, &parser) # Parse the inputs from a table and return an array of results sub parse_table { local ($i, @rv); local $pfunc = $_[1] || \&default_parsefunc; for($i=0; defined($in{"$_[0]_${i}_0"}); $i++) { local ($j, $v, @vals); for($j=0; defined($v = $in{"$_[0]_${i}_${j}"}); $j++) { push(@vals, $v); } local $p = &$pfunc("$_[0]_${i}", @vals); push(@rv, $p) if (defined($p)); } return @rv; } # default_parsefunc(rowname, value, ...) # Returns a value or undef if empty, or calls &error if invalid sub default_parsefunc { return $_[1] ? join(" ", @_[1..$#_]) : undef; } # start_form(cgi, header, [right-header]) sub start_form { local ($cgi, $header, $right) = @_; print &ui_form_start($cgi, "post"); print &ui_table_start($header, "width=100%", 2, undef, $right); print $form_hiddens; } # end_form(buttonname, buttonvalue, ...) sub end_form { print &ui_table_end(); local @buts; for(my $i=0; $i<@_; $i+=2 ) { local $al = $i == 0 ? "align=left" : $i == @_-2 ? "align=right" : "align=center"; push(@buts, [ $_[$i], $_[$i+1] ]); } print &ui_form_end(\@buts); } # yes_no_field(name, value, default) sub yes_no_field { local $v = !$_[1] ? -1 : $_[1]->{'value'}; local $def = &find_default($_[0], $_[2]) ? $text{'yes'} : $text{'no'}; return &ui_radio($_[0], $v, [ [ 1, $text{'yes'} ], [ 0, $text{'no'} ], [ -1, $text{'default'}." (".$def.")" ] ]); } # parse_yes_no(&config, name) sub parse_yes_no { &save_directives($_[0], $_[1], $in{$_[1]} == 1 ? [ 1 ] : $in{$_[1]} == 0 ? [ 0 ] : [ ], 1); } # option_field(name, value, default, &opts) sub option_field { local $v = !$_[1] ? -1 : $_[1]->{'value'}; local $def = &find_default($_[0], $_[2]); local ($defopt) = grep { $_->[0] eq $def } @{$_[3]}; return &ui_radio($_[0], $v, [ @{$_[3]}, [ -1, "$text{'default'} ($defopt->[1])" ] ]); } sub parse_option { &save_directives($_[0], $_[1], $in{$_[1]} == -1 ? [ ] : [ $in{$_[1]} ], 1); } # opt_field(name, value, size, default) sub opt_field { local $def = &find_default($_[0], $_[3]) if ($_[3]); return &ui_opt_textbox($_[0], !$_[1] ? undef : ref($_[1]) ? $_[1]->{'value'} : $_[1], $_[2], $text{'default'}.($_[3] ? " ($def)" : "")); } # parse_opt(&config, name, [&checkfunc]) sub parse_opt { if (defined($in{"$_[1]_default"}) && $in{"$_[1]_default"} eq $in{$_[1]} || !defined($in{"$_[1]_default"}) && $in{"$_[1]_def"}) { &save_directives($_[0], $_[1], [ ], 1); } else { &{$_[2]}($in{$_[1]}) if ($_[2]); &save_directives($_[0], $_[1], [ $in{$_[1]} ], 1); } } # edit_textbox(name, &values, width, height, [disabled]) sub edit_textbox { return &ui_textarea($_[0], join("\n", @{$_[1]}), $_[3], $_[2], undef, $_[4]); } # parse_textbox(&config, name) sub parse_textbox { $in{$_[1]} =~ s/^\s+//; $in{$_[1]} =~ s/\s+$//; local @v = split(/\s+/, $in{$_[1]}); &save_directives($_[0], $_[1], \@v, 1); } # get_procmailrc() # Returns the full paths to the procmail config files in use, the last one # being the user's config sub get_procmailrc { if ($module_info{'usermin'}) { local @rv; push(@rv, $config{'global_procmailrc'}); push(@rv, $config{'procmailrc'} || $procmail::procmailrc); return @rv; } else { return ( $access{'procmailrc'} || $config{'procmailrc'} || $procmail::procmailrc ); } } # find_default(name, compiled-in-default) sub find_default { if ($config{'global_cf'}) { if (!defined($global_config_cache)) { $global_config_cache = &get_config($config{'global_cf'}, 1); } local $v = &find_value($_[0], $global_config_cache); return $v if (defined($v)); } return $_[1]; } # can_use_page(page) # Returns 1 if some page can be used, 0 if not sub can_use_page { local %avail_icons; if ($module_info{'usermin'}) { %avail_icons = map { $_, 1 } split(/,/, $config{'avail_icons'}); } else { %avail_icons = map { $_, 1 } split(/,/, $access{'avail'}); } local $p = $_[0] eq "simple" ? "header" : $_[0]; return $avail_icons{$p}; } # can_use_check(page) # Calls error if some page cannot be used sub can_use_check { &can_use_page($_[0]) || &error($text{'ecannot'}); } # get_spamassassin_version(&out) sub get_spamassassin_version { local $out; &execute_command("$config{'spamassassin'} -V", undef, \$out, \$out, 0, 1); ${$_[0]} = $out if ($_[0]); return $out =~ /(version|Version:)\s+(\S+)/ ? $2 : undef; } # version_atleast(num) sub version_atleast { if (!$version_cache) { $version_cache = &get_spamassassin_version(); } return &compare_version_numbers($version_cache, '>=', $_[0]); } # spam_file_folder() sub spam_file_folder { &foreign_require("mailbox", "mailbox-lib.pl"); local ($sf) = grep { $_->{'spam'} } &mailbox::list_folders(); return $sf; } # disable_indexing(&folder) sub disable_indexing { if (!$config{'index_spam'}) { $mailbox::config{'index_min'} = 1000000000; unlink(&mailbox::user_index_file($_[0]->{'file'})); } } # get_process_pids() # Returns the PIDs and names of SpamAssassin daemon processes like spamd sub get_process_pids { local ($pn, @pids); foreach $pn (split(/\s+/, $config{'processes'})) { push(@pids, map { [ $_, $pn ] } &find_byname($pn)); } return @pids; } sub lock_spam_files { local $conf = &get_config(); @spam_files = &unique(map { $_->{'file'} } @$conf); local $f; foreach $f (@spam_files) { &lock_file($f); } } sub unlock_spam_files { local $f; foreach $f (@spam_files) { &unlock_file($f); } } # show_buttons(number) sub show_buttons { print "<table width=100%> <tr>\n"; local $onclick = "onClick='return check_clicks(form)'" if (defined(&check_clicks_function)); print "<td align=left><input type=submit name=inbox value=\"$text{'mail_inbox'}\" $onclick></td>\n"; print "<td align=left><input type=submit name=whitelist value=\"$text{'mail_whitelist2'}\" $onclick></td>\n"; if (&has_command($config{'sa_learn'})) { print "<td align=center><input type=submit name=ham value=\"$text{'mail_ham'}\" $onclick></td>\n"; } print "<td align=right><input type=submit name=delete value=\"$text{'mail_delete'}\" $onclick></td>\n"; print "<td align=right><input type=submit name=razor value=\"$text{'mail_razor'}\" $onclick></td>\n"; print "</tr></table>\n"; } # restart_spamd() # Re-start all SpamAssassin processes, or return an error message sub restart_spamd { if ($config{'restart_cmd'}) { local $out = &backquote_logged( "$config{'restart_cmd'} 2>&1 </dev/null"); if ($? || $out =~ /error|failed/i) { return "<pre>$out</pre>"; } } else { local @pids = &get_process_pids(); @pids || return $text{'apply_none'}; local $p; foreach $p (@pids) { &kill_logged("HUP", $p->[0]); } } return undef; } # find_spam_recipe(&recipes) # Returns the recipe that runs spamassassin sub find_spam_recipe { local $r; foreach $r (@{$_[0]}) { if ($r->{'action'} =~ /spamassassin/i || $r->{'action'} =~ /spamc/i) { return $r; } } return undef; } # find_file_recipe(&recipes) # returns the recipe for delivering mail based on the x-spam-status header sub find_file_recipe { local ($r, $c); foreach $r (@{$_[0]}) { foreach $c (@{$r->{'conds'}}) { if ($c->[1] =~ /x-spam-status/i) { return $r; } } } return undef; } # find_delete_recipe(&recipes) # returns the recipe for delete mail based on the x-spam-level header, and # the level it deletes at. sub find_delete_recipe { local ($r, $c); foreach $r (grep { $_->{'action'} eq '/dev/null' } @{$_[0]}) { foreach $c (@{$r->{'conds'}}) { if ($c->[1] =~ /x-spam-level:\s+((\\\*)+)/i) { return ($r, length($1)/2); } } } return ( ); } # find_virtualmin_recipe(&recipes) # Returns the recipe that runs the Virtualmin lookup command sub find_virtualmin_recipe { local ($r, $c); foreach $r (@{$_[0]}) { if ($r->{'action'} =~ /^VIRTUALMIN=/) { return $r; } } return undef; } # find_force_default_receipe(&recipes) # Returns the recipe that forces delivery to $DEFAULT, used by Virtualmin and # others to prevent per-user .procmailrc settings sub find_force_default_receipe { local ($r, $c); foreach $r (@{$_[0]}) { if ($r->{'action'} eq '$DEFAULT' && !@{$r->{'conds'}}) { return $r; } } return undef; } # get_simple_tests(&conf) sub get_simple_tests { local ($conf) = @_; local (@simple, %simple); foreach my $h (&find("header", $conf)) { if ($h->{'value'} =~ /^(\S+)\s+(\S+)\s+=~\s+\/(.*)\/(\S*)\s*$/) { push(@simples, { 'header_dir' => $h, 'name' => $1, 'header' => lc($2), 'regexp' => $3, 'flags' => $4, }); $simples{$1} = $simples[$#simples]; } } foreach my $b (&find("body", $conf), &find("full", $conf), &find("uri", $conf)) { if ($b->{'value'} =~ /^(\S+)\s+\/(.*)\/(\S*)\s*$/) { push(@simples, { $b->{'name'}.'_dir' => $b, 'name' => $1, 'header' => $b->{'name'}, 'regexp' => $2, 'flags' => $3, }); $simples{$1} = $simples[$#simples]; } } foreach my $s (&find("score", $conf)) { if ($s->{'value'} =~ /^(\S+)\s+(\S+)/ && $simples{$1}) { $simples{$1}->{'score_dir'} = $s; $simples{$1}->{'score'} = $2; } } foreach my $d (&find("describe", $conf)) { if ($d->{'value'} =~ /^(\S+)\s+(\S.*)/ && $simples{$1}) { $simples{$1}->{'describe_dir'} = $d; $simples{$1}->{'describe'} = $2; } } return @simples; } # get_procmail_command() # Returns the command that should be used in /etc/procmailrc to call # spamassassin, such as spamc or the full spamassassin path sub get_procmail_command { if ($config{'procmail_cmd'} eq '*') { # Is spamd running? if (&get_process_pids()) { local $spamc = &has_command("spamc"); return $spamc if ($spamc); } return &has_command($config{'spamassassin'}); } elsif ($config{'procmail_cmd'}) { return $config{'procmail_cmd'}; } else { return &has_command($config{'spamassassin'}); } } # execute_before(section) # If a before-change command is configured, run it. If it fails, call error sub execute_before { local ($section) = @_; if ($config{'before_cmd'}) { $ENV{'SPAM_SECTION'} = $section; local $out; local $rv = &execute_command( $config{'before_cmd'}, undef, \$out, \$out); $rv && &error(&text('before_ecmd', "<pre>".&html_escape($out)."</pre>")); } } # execute_after(section) # If a after-change command is configured, run it. If it fails, call error sub execute_after { local ($section) = @_; if ($config{'after_cmd'}) { $ENV{'SPAM_SECTION'} = $section; local $out; local $rv = &execute_command( $config{'after_cmd'}, undef, \$out, \$out); $rv && &error(&text('after_ecmd', "<pre>".&html_escape($out)."</pre>")); } } # check_spamassassin_db() # Checks if the LDAP or MySQL backend can be contacted, and if not returns # an error message. sub check_spamassassin_db { if ($config{'mode'} == 0) { return undef; # Local files always work } elsif ($config{'mode'} == 1 || $config{'mode'} == 2) { # Connect to a database local $dbh = &connect_spamassasin_db(); return $dbh if (!ref($dbh)); local $testcmd = $dbh->prepare("select * from userpref limit 1"); if (!$testcmd || !$testcmd->execute()) { undef($connect_spamassasin_db_cache); $dbh->disconnect(); return &text('connect_equery', "<tt>$config{'db'}</tt>", "<tt>userpref</tt>"); } $testcmd->finish(); undef($connect_spamassasin_db_cache); $dbh->disconnect(); return undef; } elsif ($config{'mode'} == 3) { # Connect to LDAP local $ldap = &connect_spamassassin_ldap(); return $ldap if (!ref($ldap)); local $rv = $ldap->search(base => $config{'base'}, filter => "(uid=$remote_user)", sizelimit => 1); if (!$rv || $rv->code) { return &text('connect_ebase', "<tt>$config{'base'}</tt>", $rv ? $rv->error : "Unknown search error"); } return undef; } else { return "Unknown config mode $config{'mode'} !"; } } # connect_spamassasin_db() # Attempts to connect to the SpamAssasin MySQL or PostgreSQL database. Returns # a driver handle on success, or an error message string on failure. sub connect_spamassasin_db { if (defined($connect_spamassasin_db_cache)) { return $connect_spamassasin_db_cache; } local $driver = $config{'mode'} == 1 ? "mysql" : "Pg"; local $drh; eval <<EOF; use DBI; \$drh = DBI->install_driver(\$driver); EOF if ($@) { return &text('connect_edriver', "<tt>DBD::$driver</tt>"); } local $dbistr = &make_dbistr($driver, $config{'db'}, $config{'server'}); local $dbh = $drh->connect($dbistr, $config{'user'}, $config{'pass'}, { }); $dbh || return &text('connect_elogin', "<tt>$config{'db'}</tt>", $drh->errstr)."\n"; $connect_spamassasin_db_cache = $dbh; return $dbh; } # connect_spamassassin_ldap() # Attempts to connect to the configured LDAP DB, and returns the handle on # success, or an error message on failure. sub connect_spamassassin_ldap { if (defined($connect_spamassasin_ldap_cache)) { return $connect_spamassasin_ldap_cache; } eval "use Net::LDAP"; if ($@) { return &text('connect_eldapmod', "<tt>Net::LDAP</tt>"); } local $port = $config{'port'} || 389; local $inet6 = !&to_ipaddress($config{'server'}) && &to_ip6address($config{'server'}); local $ldap = Net::LDAP->new($config{'server'}, port => $port, inet6 => $inet6); if (!$ldap) { return &text('connect_eldap', "<tt>$config{'server'}</tt>", $port); } local $mesg = $ldap->bind(dn => $config{'user'}, password => $config{'pass'}); if (!$mesg || $mesg->code) { return &text('connect_eldaplogin', "<tt>$config{'server'}</tt>", "<tt>$config{'user'}</tt>", $mesg ? $mesg->error : "Unknown error"); } $connect_spamassasin_ldap_cache = $ldap; return $ldap; } sub make_dbistr { local ($driver, $db, $host) = @_; local $rv; if ($driver eq "mysql") { $rv = "database=$db"; } elsif ($driver eq "Pg") { $rv = "dbname=$db"; } else { $rv = $db; } if ($host) { $rv .= ";host=$host"; } return $rv; } # get_ldap_user(&ldap, [username]) # Returns the LDAP object for a user, or undef if not found sub get_ldap_user { local ($ldap, $user) = @_; $user ||= $database_userpref_name; #if (exists($get_ldap_user_cache{$user})) { # return $get_ldap_user_cache{$user}; # } local $rv = $ldap->search(base => $config{'base'}, filter => "($ldap_username_attr=$user)", ); if (!$rv || $rv->code) { &error(&text('eldap', $rv ? $rv->error : "Search failed")); } local ($uinfo) = $rv->all_entries; $get_ldap_user_cache{$user} = $uinfo; return $uinfo; } # get_auto_whitelist_file([user]) # Returns the base path to the auto whitelist DBM, if any. sub get_auto_whitelist_file { local ($user) = @_; local @uinfo = $module_info{'usermin'} ? @remote_user_info : $user ? getpwnam($user) : ( ); local $conf = &get_config(); local $awp = &find("auto_whitelist_path", $conf); if (!$awp) { $awp = &find_default("auto_whitelist_path"); } $awp ||= "~/.spamassassin/auto-whitelist"; if ($awp !~ /^\//) { # Make absolute return undef if (scalar(@uinfo) == 0); $awp =~ s/^(\~|\$HOME)\//$uinfo[7]\//; if ($awp !~ /^\//) { $awp = "$uinfo[7]/$awp"; } } # Does it exist? if (!-r $awp) { local @real = glob("$awp.*"); $awp = undef if (!@real); } # Is it under the user's home? if (!&is_under_directory($uinfo[7], $awp)) { $awp = undef; } return $awp; } # open_auto_whitelist_dbm([user]) # Ties the %awl hash to the autowhitelist DBM file. Returns 1 if successful, or # 0 if it could not be opened, or -1 if empty. sub open_auto_whitelist_dbm { local ($user) = @_; local $awp = &get_auto_whitelist_file($user); return 0 if (!$awp); local $anyok; foreach my $cls ('DB_File', 'GDBM_File', 'SDBM_File') { $@ = undef; eval "use $cls"; next if ($@); tie(%awl, $cls, $awp, O_RDWR, 0755) || next; if (scalar(keys %awl)) { return 1; } $anyok = 1; } return $anyok ? -1 : 0; } # close_auto_whitelist_dbm() # Disconnects the global %awl hash from the DBM file, flushing changes to disk sub close_auto_whitelist_dbm { untie(%awl); } # supports_auto_whitelist() # Returns 1 if SpamAssassin is doing auto-whitelisting for the current user, # 2 if for multiple users. sub supports_auto_whitelist { if ($module_info{'usermin'}) { return &get_auto_whitelist_file() ? 1 : 0; } else { return 2; } } sub can_edit_awl { local ($user) = @_; return 1 if ($module_info{'usermin'}); # Only one user anyway if ($access{'awl_users'}) { # Check if on user list return &indexof($user, split(/\s+/, $access{'awl_users'})) >= 0; } elsif ($access{'awl_groups'}) { # Check if the user is a member of any of the allowed groups local %ugroups; local @uinfo = getpwnam($user); return 0 if (!scalar(@uinfo)); local @ginfo = getgrgid($uinfo[3]); $ugroups{$ginfo[0]}++ if (scalar(@ginfo)); foreach my $o (&other_groups($user)) { $ugroups{$o}++; } local @can = grep { $ugroups{$_} } split(/\s+/, $access{'awl_groups'}); return @can ? 1 : 0; } else { # No restrictions return 1; } } # list_spamassassin_languages() # Returns a list of language codes and descriptions sub list_spamassassin_languages { local @rv; open(LANGS, "<$module_root_directory/langs"); while(<LANGS>) { if (/^(\S+)\s+(.*)/) { push(@rv, [ $1, $2 ]); } } close(LANGS); return @rv; } # list_spamassassin_locales() # Returns a list of locale codes and descriptions sub list_spamassassin_locales { local @rv; open(LANGS, "<$module_root_directory/locales"); while(<LANGS>) { if (/^(\S+)\s+(.*)/) { push(@rv, [ $1, $2 ]); } } close(LANGS); return @rv; } # list_spamassassin_plugins() # Returns a list of plugins enabled, both globally and for this user sub list_spamassassin_plugins { my @rv; if ($config{'global_cf'}) { my $gconf = &get_config($config{'global_cf'}, 1); push(@rv, &find_value("loadplugin", $gconf)); } my $conf = &get_config(); push(@rv, &find_value("loadplugin", $conf)); return @rv; } # get_procmail_status() # Returns flags indicating if spamassassin is called, and if delivery based # on the headers it adds are enabled, based on the procmail config. sub get_procmail_status { if (!$warn_procmail || !&foreign_check("procmail")) { # Don't know, or checking disabled return (-1, -1); } &foreign_require("procmail"); my $spam_enabled = 0; # Found call to spamassassin my $delivery_enabled = 0; # Found X-Spam: header rule my @pmrcs = &get_procmailrc(); foreach my $pmrc (@pmrcs) { my @recipes = &procmail::parse_procmail_file($pmrc); my $isglobal = $pmrc eq $config{'global_procmailrc'} || $pmrc eq $config{'procmailrc'} || $pmrc eq $procmail::procmailrc; if (&find_spam_recipe(\@recipes)) { $spam_enabled ||= 1; } if (&find_file_recipe(\@recipes)) { if ($isglobal) { # Enabled globally, and so # cannot be changed by user $delivery_enabled ||= -2; } else { $delivery_enabled ||= 1; } } if (&find_virtualmin_recipe(\@recipes) || &foreign_installed("virtual-server")) { # Controlled by Virtualmin if ($isglobal && &find_force_default_receipe( \@recipes)) { # User .procmailrc files are # prevented $spam_enabled ||= -2; $delivery_enabled ||= -2; } else { # Users can have a .procmailrc $spam_enabled ||= -2; $delivery_enabled ||= 1; } } } return ($spam_enabled, $delivery_enabled); } 1;
Save File
Cancel