UVconfig.pm

   1 # UVconfig: Reads config files and tests configuration
   2 # Used by all components
   3
   4 package UVconfig;
   5
   6 use strict;
   7 use Net::Domain qw(hostname hostfqdn hostdomain);
   8 use UVmessage;
   9 use vars qw(@ISA @EXPORT $VERSION $usevote_version %config %messages
  10             @rules @groups $bdsg_regexp $bdsg2_regexp %ids %functions);
  11
  12 require Exporter;
  13 @ISA = qw(Exporter);
  14 @EXPORT = qw($usevote_version %config %messages @rules @groups
  15              $bdsg_regexp $bdsg2_regexp %ids %functions);
  16
  17 # Module version
  18 $VERSION = "0.18";
  19
  20 # Usevote version
  21 $usevote_version = "UseVoteGer 4.12";
  22
  23 sub read_config {
  24
  25   my ($cfgfile, $redir_errors) = @_;
  26
  27   # Default configuration options (overwritten in usevote.cfg)
  28   %config = (votefile             => "votes",
  29              votename             => "unkonfiguriertes Usevote",
  30              sampleballotfile     => "ballot.sample",
  31              resultfile           => "ergebnis.alle",
  32              rulefile             => "usevote.rul",
  33              badaddrfile          => "mailpatterns.cfg",
  34              messagefile          => "messages.cfg",
  35              idfile               => "scheinkennungen",
  36              requestfile          => "anforderung",
  37              errorfile            => "errors.log",
  38              lockfile             => "usevote.lock",
  39              replyto              => 0,
  40              personal             => 0,
  41              proportional         => 0,
  42              bdsg                 => 0,
  43              onestep              => 0,
  44              multigroup           => 0,
  45              voteack              => 1,
  46              voteaccount          => "<> (unkonfiguriertes Usevote)",
  47              mailfrom             => "<> (unkonfiguriertes Usevote)",
  48              envelopefrom         => "<>",
  49              mailboxtype          => "mbox",
  50              mailstart            => "^From ",
  51              archivedir           => "fertig",
  52              tmpdir               => "tmp",
  53              templatedir          => "templates",
  54              formats              => "UVformats.pm",
  55              domailfile           => "tmp/domail",
  56              controlfile          => "tmp/ack.control",
  57              mailcmd              => "sendmail -oi -oem",
  58              mailcc               => "",
  59              sleepcmd             => "sleep 1",
  60              clearcmd             => "clear",
  61              diff                 => "diff",
  62              pager                => "less",
  63              pop3                 => 0,
  64              pop3server           => "localhost",
  65              pop3port             => 110,
  66              pop3user             => "default",
  67              pop3pass             => "default",
  68              pop3delete           => 0,
  69              pop3uidlcache        => "uidlcache",
  70              pop3server_req       => "localhost",
  71              pop3port_req         => 110,
  72              pop3user_req         => "default",
  73              pop3pass_req         => "default",
  74              pop3delete_req       => 0,
  75              pop3uidlcache_req    => "uidlcache_req",
  76              pop3server_bounce    => "localhost",
  77              pop3port_bounce      => 110,
  78              pop3user_bounce      => "default",
  79              pop3pass_bounce      => "default",
  80              pop3delete_bounce    => 0,
  81              pop3uidlcache_bounce => 'uidlcache_bounce',
  82              smtp                 => 0,
  83              smtpserver           => 'localhost',
  84              smtpport             => 25,
  85              smtphelo             => hostfqdn(),
  86              fqdn                 => hostfqdn(),
  87              smtpauth             => 0,
  88              smtpuser             => '',
  89              smtppass             => '',
  90              name_re              => '[a-zA-ZäöüÄÖÜß-]{2,} +.*[a-zA-ZäöüÄÖÜß]{2,}',
  91              ja_stimme            => '(J\s*A|J|(D\s*A\s*)?F\s*U\s*E\s*R)',
  92              nein_stimme          => '(N\s*E\s*I\s*N|N|(D\s*A\s*)?G\s*E\s*G\s*E\s*N)',
  93              enth_stimme          => '(E|E\s*N\s*T\s*H\s*A\s*L\s*T\s*U\s*N\s*G)',
  94              ann_stimme           => 'A\s*N\s*N\s*U\s*L\s*L\s*I\s*E\s*R\s*U\s*N\s*G',
  95              bdsg_confirm         => 'JA',
  96              condition1           => '$yes>=2*$no', # twice as many yes as no
  97              condition2           => '$yes>=60',    # min 60 yes votes
  98              prop_formula         => '$yes/$no',
  99              tpl_ack_mail         => 'ack-mail',
 100              tpl_bouncelist       => 'bouncelist',
 101              tpl_mailheader       => 'mailheader',
 102              tpl_result_multi     => 'result-multi',
 103              tpl_result_single    => 'result-single',
 104              tpl_result_prop      => 'result-proportional',
 105              tpl_votes_multi      => 'votes-multi',
 106              tpl_votes_single     => 'votes-single',
 107              tpl_voterlist        => 'voterlist',
 108              tpl_ballot           => 'ballot',
 109              tpl_ballot_request   => 'ballot-request',
 110              tpl_ballot_personal  => 'ballot-personal',
 111              tpl_addr_reg         => 'address-not-registered',
 112              tpl_no_ballotid      => 'no-ballotid',
 113              tpl_wrong_ballotid   => 'wrong-ballotid',
 114              tpl_bdsg_error       => 'bdsg-error',
 115              tpl_cancelled        => 'cancelled',
 116              tpl_invalid_account  => 'invalid-account',
 117              tpl_invalid_name     => 'invalid-name',
 118              tpl_multiple_votes   => 'multiple-votes',
 119              tpl_no_ballot        => 'no-ballot',
 120              tpl_no_votes         => 'no-votes',
 121              tpl_rule_violated    => 'rule-violated',
 122              begin_divider        => 'Alles vor dieser Zeile bitte loeschen',
 123              end_divider          => 'Alles nach dieser Zeile bitte loeschen',
 124              nametext             => 'Dein Realname, falls nicht im FROM-Header:',
 125              nametext2            => 'Waehlername:',
 126              addresstext          => 'Waehleradresse:',
 127              ballotidtext         => 'Wahlscheinkennung:',
 128              bdsgtext             => 'Datenschutzklausel - Zustimmung',
 129              bdsgfile             => 'bdsgtext.cfg',
 130              rightmargin          => 72,
 131              usevote_version      => $usevote_version); # needed for use in templates
 132
 133   # read config
 134   read_file($cfgfile);
 135
 136   # read message file
 137   open (RES, "<$config{messagefile}")
 138      or die "Could not read message file $config{messagefile}!\n\n";
 139   my @lines = <RES>;
 140   close(RES);
 141
 142   foreach my $line (@lines) {
 143     chomp($line);
 144     $line =~ s/^#.*//;        # Delete comments
 145     if ($line =~ m/^\s*([A-Za-z0-9_-]+)\s*=\s*(.+)\s*$/){
 146       $messages{$1} = $2;
 147     }
 148   }
 149
 150   # missing "groupX =" lines in config file?
 151   die UVmessage::get("CONF_NOGROUPS", CONFIGFILE=>$cfgfile) . "\n\n" unless (@groups);
 152
 153   # redirect errors to a file if desired by calling script
 154   open (STDERR, ">$config{errorfile}") if ($redir_errors);
 155
 156   # check for data protection law? read text for ballot
 157   parse_bdsgtext() if ($config{bdsg});
 158
 159   # personalized ballots? read ballot IDs
 160   read_ballot_ids() if ($config{personal});
 161
 162   load_formats() if ($config{formats});
 163
 164 }
 165
 166
 167 ##############################################################################
 168 # read config file                                                           #
 169 ##############################################################################
 170
 171 sub read_file {
 172
 173   my $cfgfile = shift;
 174   my $CONFIG;
 175   open ($CONFIG, "<$cfgfile") or die "Could not find config file $cfgfile!\n\n";
 176
 177   while (<$CONFIG>) {
 178     next if (/^#/);     # line is a comment
 179     chomp;              # delete \n
 180     s/\r//;             # delete \r if present
 181     s/([^\\])#.*$/$1/;  # Remove comments not starting at beginning of line.
 182                         # (ignore escaped comment sign \#)
 183
 184
 185     if (/^include (\S+)$/) {
 186       # include other config file
 187       read_file($1);
 188
 189     } elsif (my($key, $value) = split (/\s*=\s*/, $_, 2)) {
 190       # delete trailing spaces
 191       $value =~ s/\s*$//;
 192
 193       # evaluate quotation marks
 194       $value =~ s/^\"([^\"]+[^\\\"])\".*$/$1/;
 195       $value =~ s/\\"/"/g;
 196
 197       if ($key =~ /^group(\d+)$/) {
 198         my $num = $1;
 199         $groups[$num-1] = $value;    # internal index starts at 0
 200       } else {
 201         $config{$key} = $value;
 202       }
 203     }
 204   }
 205
 206   close ($CONFIG);
 207
 208 }
 209
 210
 211 ##############################################################################
 212 # parse data protection law texts                                            #
 213 ##############################################################################
 214
 215 sub parse_bdsgtext {
 216
 217   open (BDSG, "<$config{bdsgfile}") or die UVmessage::get("CONF_NOBDSGFILE",
 218                             ('BDSGFILE' => "$config{bdsgfile}")) . "\n\n";
 219   my @bdsg = <BDSG>;
 220   close BDSG;
 221
 222   $config{bdsginfo} = '';
 223
 224   foreach my $line (@bdsg) {
 225     $config{bdsginfo} .= $line unless ($line =~ /^\s*#/);
 226   }
 227
 228   my $bdsgtmp = $config{bdsginfo};
 229   $bdsgtmp =~ s/\"/\\\"/g;
 230   $bdsgtmp =~ s/\'/\\\'/g;
 231   $bdsgtmp =~ s/\(/\\\(/g;
 232   $bdsgtmp =~ s/\)/\\\)/g;
 233   $bdsgtmp =~ s/\[/\\\[/g;
 234   $bdsgtmp =~ s/\]/\\\]/g;
 235   $bdsgtmp =~ s/\./\\\./g;
 236   $bdsgtmp =~ s/\!/\\\!/g;
 237   my @bdsgtext = split(' ', $bdsgtmp);
 238
 239   # Build Regular Expression from single words.
 240   # There has to be at least a space between two words, additional characters
 241   # are allowed, e.g. quotation marks (but no letters)
 242   $bdsg_regexp = join('\s\W*?', @bdsgtext);
 243
 244   # Build Regular Expression from $config{bdsgtext}
 245   $bdsg2_regexp = join('\s\W*?', split(' ', $config{bdsgtext}));
 246 }
 247
 248
 249 ##############################################################################
 250 # Read suspicious mail addresses (normally mailpatterns.cfg)                 #
 251 ##############################################################################
 252
 253 sub read_badaddr {
 254
 255   my @bad_addr = ();
 256
 257   open (BADADDR, "<$config{badaddrfile}") or die
 258     UVmessage::get("CONF_NOBADADDR",(BADADDRFILE => $config{badaddrfile})) . "\n\n";
 259
 260   while (<BADADDR>) {
 261     chomp;
 262     # Comment line? Not only whitespaces?
 263     if (/^[^#]/ && /[^\s]/) {
 264       push(@bad_addr, $_);
 265     }
 266   }
 267
 268   close (BADADDR);
 269   return @bad_addr;
 270 }
 271
 272
 273 ##############################################################################
 274 # Read ballot IDs                                                            #
 275 ##############################################################################
 276
 277 sub read_ballot_ids {
 278   # open file with ballot ids
 279   open(FILE, "<$config{idfile}") or return 1;
 280   while (<FILE>) {
 281     chomp;
 282     # Format: mailaddress (whitespace) ballot ID
 283     if (/^(.+@.+)\s+([a-z0-9]+)/) {
 284       # $1=mailadresse, $2=ballot ID
 285       $ids{$1} = $2;
 286     }
 287   }
 288   close(FILE);
 289   return 0;
 290 }
 291
 292
 293 ##############################################################################
 294 # Funktionen für Templates laden                                             #
 295 ##############################################################################
 296
 297 sub load_formats {
 298   my $modules = $config{formats};
 299
 300   my @modules = split(/\s*,\s*/, $modules);
 301
 302   foreach my $module (@modules){
 303     if (-r $module){
 304       require $module;
 305     }
 306   }
 307 }
 308
 309
 310 ##############################################################################
 311 # config test                                                                #
 312 ##############################################################################
 313
 314 sub test_config {
 315   print UVmessage::get("CONF_CONFIG"), "\n\n";
 316   foreach my $option (keys %config) {
 317     print "$option = $config{$option}\n";
 318   }
 319
 320   print "\n", UVmessage::get("CONF_TEST_RULES");
 321   if (@rules) {
 322     print "\n\n";
 323     for (my $n=0; $n<@rules; $n++) {
 324       my $text = UVrules::rule_print($n);
 325       print $text;
 326     }
 327     print "\n";
 328   } else {
 329     print UVmessage::get("CONF_NO_RULES"), "\n\n";
 330   }
 331 }
 332
 333 1;