Major changes for reading/parsing/validating configuration files.
[confparser-old] / mail.filter
1 #!/usr/bin/python
2 # -*- coding: iso-8859-1 -*-
3
4 #
5 # MailFilter - Mail filter to replace procmail.
6 # Copyright (C) 2004  Frédéric Jolliton <frederic@jolliton.com>
7 #
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21 #
22
23 #
24 # Policy when error are encountered:
25 #
26 # We backup the mail in a special directory. It will be
27 # at the admin discretion to feed it again to this program
28 # (or may be script that.)
29 #
30
31 #
32 # TODO:
33 #
34 #   [ ] Define precisely what return code use for each possible case.
35 #
36
37 import sys
38 import os
39 import time
40 import email
41 import types
42 import re
43
44 import confparser
45
46 from os import EX_USAGE, EX_OK, EX_NOUSER, EX_TEMPFAIL, EX_DATAERR
47 # EX_OK           0       ok
48 # EX_USAGE        64      command line usage error
49 # EX_DATAERR      65      data format error
50 # EX_NOINPUT      66      cannot open input
51 # EX_NOUSER       67      addressee unknown
52 # EX_NOHOST       68      host name unknown
53 # EX_UNAVAILABLE  69      service unavailable
54 # EX_SOFTWARE     70      internal software error
55 # EX_OSERR        71      system error (e.g., can't fork)
56 # EX_OSFILE       72      critical OS file missing
57 # EX_CANTCREAT    73      can't create (user) output file
58 # EX_IOERR        74      input/output error
59 # EX_TEMPFAIL     75      temp failure; user is invited to retry
60 # EX_PROTOCOL     76      remote error in protocol
61 # EX_NOPERM       77      permission denied
62 # EX_CONFIG       78      configuration error
63
64 #
65 # Path to subprocess module. Ideally not needed if subprocess
66 # (formerly popen5) is installed into /site-packages/ directory.
67 #
68 #sys.path.insert( 0 , '/usr/local/lib/python/' )
69
70 #
71 # subprocess (formerly popen5) - See PEP 324
72 # http://www.lysator.liu.se/~astrand/popen5/
73 #
74 # >>> cat = subprocess.Popen( 'cat' , stdin = subprocess.PIPE , stdout = subprocess.PIPE )
75 # >>> cat.communicate( 'bla' )
76 # ('bla', None)
77 # >>> cat.returncode
78 # 0
79 #
80 try :
81         import subprocess
82 except ImportError :
83         try :
84                 import popen5 as subprocess
85         except ImportError :
86                 print 'Please install subprocess module.'
87                 print 'See http://www.lysator.liu.se/~astrand/popen5/.'
88                 sys.exit( 1 )
89
90 #--[ Configuration variables ]------------------------------------------------
91
92 #
93 # Filename where to put log.
94 #
95 g_pathLog          = '/var/log/mail.filter.log'
96
97 #
98 # For which users receiving a mail should we send a UDP packet.
99 #
100 g_userNotificationFilter = [ 'fred' ]
101
102 #
103 # For which IP address should we send the notification.
104 # (Can include broadcast address.)
105 #
106 g_notificationAddresses = [ '192.168.1.255' ]
107
108 #
109 # On which port should we send the notification.
110 #
111 g_notificationPort = 23978
112
113 #
114 # Max mail size to be processed by this script.
115 #
116 # Larger mail are just not filtered.
117 #
118 g_maxMailSize = 2 * 1024 * 1024
119
120 #
121 # Where to save copy of mail in case of error.
122 #
123 g_directoryBackup  = '/var/mail.filter/recovery/'
124
125 #
126 # Where to find rules about each user.
127
128 # Filename for user 'joe' will be named 'joe.mf' in that
129 # directory. If the file doesn't exist, no filtering is
130 # done (not even spam/virus filtering.)
131 #
132 g_directoryRules   = '/var/mail.filter/rules/'
133
134 #--[ External commands ]------------------------------------------------------
135
136 #
137 # Path to Cyrus's deliver binary.
138 #
139 g_pathCyrusDeliver = '/usr/cyrus/bin/deliver'
140
141 #
142 # Path to spamprobe binary.
143 #
144 g_pathSpamProbe    = '/usr/bin/spamprobe'
145
146 g_pathSpamProbeDb  = '/var/spamprobe/db'
147
148 #
149 # Path to ClamAV binary.
150 #
151 # Could point either to 'clamdscan' or 'clamscan'.
152 #
153 # The first one is *HIGHLY* recommended since
154 # it will use the ClamAV daemon.
155 #
156 g_pathClamdscan    = '/usr/bin/clamdscan'
157
158 #--[ Global variables ]-------------------------------------------------------
159
160 #
161 # Should the log be also printed on stdout ?
162 #
163 g_copyLogToStdout = False
164
165 #
166 # Don't actually feed the mail to Cyrus.
167 #
168 g_testMode = False
169
170 #
171 # The user name of the recipient.
172 #
173 g_user = None
174
175 #
176 # The current mail as string (as read from stdin.)
177 #
178 g_mailText = None
179
180 #
181 # The current mail as email.Message.Message object.
182 #
183 g_mail = None
184
185 #-----------------------------------------------------------------------------
186
187 #
188 # check if predicate is True for all items in list 'lst'.
189 #
190 def all( lst , predicate ) :
191
192         for item in lst :
193                 if not predicate( item ) :
194                         return False
195         return True
196
197 #
198 # check if predicate is True for at least one item in list 'lst'.
199 #
200 def some( lst , predicate ) :
201
202         for item in lst :
203                 if predicate( item ) :
204                         return True
205         return False
206
207 #
208 # Remove leading and trailing blank, and replace any
209 # blank character sequence by one space character.
210 #
211 def normalizeBlank( s ) :
212
213         return ' '.join( s.split() )
214
215 #-----------------------------------------------------------------------------
216
217 #
218 # Utility function to return traceback as string from most recent
219 # exception.
220 #
221 def getTraceBack() : 
222  
223         import traceback, sys 
224         return ''.join( traceback.format_exception( *sys.exc_info() ) )
225
226 #
227 # Return (returnCode, stdout, stderr)
228 #
229 def pipe( cmd , input ) :
230
231         p = subprocess.Popen( cmd ,
232                 stdin = subprocess.PIPE ,
233                 stdout = subprocess.PIPE ,
234                 stderr = subprocess.PIPE )
235         try :
236                 # much faster than passing 'input' to communicate directly..
237                 p.stdin.write( input )
238         except IOError :
239                 pass
240         r = p.communicate()
241         return p.returncode , r[ 0 ] , r[ 1 ]
242
243 #
244 # Return an ISO-8661 date representation for the UTC
245 # timezone.
246 #
247 # timestamp( 0 ) => 1970-01-01T00:00:00Z
248 #
249 def timestamp() :
250
251         t = time.gmtime()
252         return '%04d-%02d-%02dT%02d:%02d:%02dZ' % t[ : 6 ]
253
254 #
255 # Log message 'msg'.
256 #
257 def logMessage( msg ) :
258
259         if not logMessage.logFile and not g_testMode :
260                 #
261                 # If log file is not yet open, try to open it.
262                 #
263                 try :
264                         logMessage.logFile = open( g_pathLog , 'a+' )
265                 except :
266                         return
267
268         msg = msg.splitlines()
269         prefix = timestamp() + ' [%s] ' % os.getpid()
270
271         #
272         # Output to log file.
273         #
274         if logMessage.logFile :
275
276                 for line in msg :
277                         line = prefix + line
278                         try :
279                                 logMessage.logFile.write( line + '\n' )
280                                 logMessage.logFile.flush()
281                         except :
282                                 pass
283
284         #
285         # Output to standard output.
286         #
287         if g_copyLogToStdout :
288
289                 for line in msg :
290                         line = prefix + line
291                         sys.stdout.write( line + '\n' )
292                         sys.stdout.flush()
293
294 logMessage.logFile = None
295
296 #
297 # Make a backup of the mail (in case it's impossible
298 # to store the mail to Cyrus.)
299 #
300 def backup( filenamePrefix = None ) :
301
302         if g_testMode :
303                 logMessage( 'TEST MODE: Backup of the mail requested.' )
304                 return
305
306         try :
307                 # Ensure directory exist
308                 import os
309                 os.makedirs( g_directoryBackup )
310         except :
311                 pass
312
313         basename = ''
314         if filenamePrefix :
315                 basename += filenamePrefix + '-'
316         #
317         # Append current unix time as suffix
318         #
319         basename += '%.3f' % time.time()
320
321         fn = g_directoryBackup + '/' + basename
322         try :
323                 f = open( fn , 'a+' )
324                 f.write( g_mailText )
325                 f.close()
326         except :
327                 logMessage( 'Error saving backup copy.' )
328         else :
329                 logMessage( 'Message appended to backup directory as `%s\'.' % basename )
330
331 #-----------------------------------------------------------------------------
332
333 class Action : pass
334
335 class NullAction( Action ) :
336
337         def __repr__( self ) :
338
339                 return '<NullAction>'
340
341 class FileToFolderAction( Action ) :
342
343         def __init__( self , folder ) :
344
345                 self.folder = folder
346
347         def __repr__( self ) :
348
349                 return '<FileToFolderAction %r>' % ( self.folder , )
350
351 class CustomErrorCodeAction( Action ) :
352
353         def __init__( self , code ) :
354
355                 self.code = code
356
357         def __repr__( self ) :
358
359                 return '<NullAction %r>' % ( self.code , )
360
361 #-----------------------------------------------------------------------------
362
363 #
364 # Experimental !
365 #
366 # Packet payload contains:
367 #
368 # <username> + char( 0 ) + <foldername> + char( 0 )
369 #
370 def notifyDeliver( user , folder ) :
371
372         if user not in g_userNotificationFilter :
373                 return
374         try :
375                 import socket
376                 s = socket.socket( socket.AF_INET , socket.SOCK_DGRAM )
377                 msg = user + chr( 0 ) + folder + chr( 0 )
378                 for address in g_notificationAddresses :
379                         s.sendto( msg , ( address , g_notificationPort ) )
380         except :
381                 pass
382
383 #
384 # Deliver a mail to Cyrus for user 'username' in
385 # folder 'folderName' (or default folder if not
386 # specified.)
387 #
388 def deliverTo( username , folderName = None ) :
389
390         if not folderName :
391                 pseudoFolderName = 'INBOX'
392                 folderName = 'user.' + username
393         else :
394                 pseudoFolderName = 'INBOX.' + folderName
395                 folderName = 'user.' + username + '.' + folderName
396
397         #
398         # Build the command line for running deliver.
399         #
400         cmd = [ g_pathCyrusDeliver ]
401         cmd += [ '-a' , username ]
402         cmd += [ '-m' , folderName ]
403
404         if g_testMode :
405                 logMessage( 'TEST MODE: Delivering mail in `%s\' requested.' % ( folderName , ) )
406                 logMessage( 'TEST MODE: Command: %r.' % cmd )
407                 return EX_OK
408
409         try :
410                 rc , stdout , stderr = pipe( cmd , g_mailText )
411         except OSError , e :
412                 logMessage( 'Error running `%s\': %s.' % ( cmd[ 0 ] , e[ 1 ] ) )
413                 return EX_TEMPFAIL
414
415         if rc == EX_OK :
416                 logMessage( 'Message delivered in folder `%s\'.' % folderName )
417                 notifyDeliver( username , pseudoFolderName )
418         else :
419                 errorMessage = stdout.rstrip()
420                 #
421                 # Extract raw error message
422                 #
423                 # Example of output:
424                 #
425                 #   +user.fred: Message contains invalid header
426                 #
427                 m = errorMessage.split( ': ' , 1 )
428                 if len( m ) == 2 :
429                         m = m[ 1 ]
430                 else :
431                         m = None
432                 rcMsg = '%d' % rc
433                 if m == 'Message contains invalid header' :
434                         rc = EX_DATAERR
435                         rcMsg += '->%d' % rc
436                 elif m == 'Mailbox does not exist' :
437                         rc = EX_NOUSER
438                         rcMsg += '->%d' % rc
439                 else :
440                         # FIXME: DATAERR ok here ?
441                         rc = EX_DATAERR
442                 logMessage( 'Refused by Cyrus: [%s] `%s\'.' % ( rcMsg , errorMessage ) )
443         return rc
444
445 #--[ Antivirus ]--------------------------------------------------------------
446
447 #
448 # Return virus list from the output of ClamAV.
449 #
450 def extractVirusList( clamdOutput ) :
451
452         res = []
453         for line in clamdOutput.splitlines() :
454                 r = extractVirusList.reClamdVirus.search( line.rstrip() )
455                 if r == None : continue
456                 res.append( r.group( 1 ) )
457         return res
458
459 extractVirusList.reClamdVirus = re.compile( r'^[^:]+: (\S+) FOUND$' )
460
461 #
462 # Check for virus.
463 #
464 # Return True if mail is clean.
465 #
466 def antivirusScan() :
467
468         cmd = [ g_pathClamdscan , '-' ]
469
470         if g_testMode :
471                 logMessage( 'TEST MODE: Virus scan requested.' )
472                 logMessage( 'TEST MODE: Command: %r.' % cmd )
473                 return True
474
475         rc , stdout , stderr = pipe( cmd , g_mailText )
476         output = stderr or ''
477         #logMessage( 'clamdscan returned %s' % rc )
478         if rc == 2 :
479                 raise 'Unable to scan for viruses (%s)' % cmd
480         ok = not rc
481         if not ok :
482                 msg = 'Virus found.'
483                 viruses = extractVirusList( output )
484                 if viruses :
485                         msg += ' [%s]' % ' '.join( viruses )
486                 logMessage( msg )
487         return ok
488
489 #--[ Antispam ]---------------------------------------------------------------
490
491 #
492 # Check for spam.
493 #
494 # Return True if mail is correct.
495 #
496 def spamScan() :
497
498         if not g_user : return True
499
500         cmd = [ g_pathSpamProbe ]
501         cmd += [ '-d' , g_pathSpamProbeDb + '/' + g_user + '/' ]
502         cmd += [ 'receive' ]
503
504         if g_testMode :
505                 logMessage( 'TEST MODE: Spam scan requested.' )
506                 logMessage( 'TEST MODE: Command: %r.' % cmd )
507                 return True
508
509         rc , stdout , stderr = pipe( cmd , g_mailText )
510         r = ( stdout or '' ).split()
511         return r[ 0 ] != 'SPAM'
512
513 #-----------------------------------------------------------------------------
514
515 def errorNameToErrorCode( code ) :
516
517         code = code.lower()
518         if code == 'nouser' :
519                 return EX_NOUSER
520         elif code == 'tempfail' :
521                 return EX_TEMPFAIL
522         elif code == 'dataerr' :
523                 return EX_DATAERR
524         else :
525                 try :
526                         return int( code )
527                 except :
528                         return 0
529
530 #-----------------------------------------------------------------------------
531
532 #
533 # FIXME: I think it could be better to cache the parsed
534 # configuration, and also to cache the result of the validator
535 # so that we don't run the test each time this script is run !
536 #
537 def readUserRules( user ) :
538
539         filename = g_directoryRules + '/' + user + '.mf'
540
541         #
542         # Read the configuration.
543         #
544         try :
545                 return confparser.readConfiguration( filename )
546         except Exception , e :
547                 print e
548
549 #-----------------------------------------------------------------------------
550
551 #
552 # Test a match rule against a particular header.
553 #
554 def ruleMatch( header , matchType , text ) :
555
556         if matchType == 'match' :
557                 try :
558                         return re.search( text , header , re.I ) != None
559                 except :
560                         logMessage( 'Error with regex `%s\' from %s\'s user configuration.' % ( text , g_user ) )
561                         return False
562         elif matchType == 'is' :
563                 return header.strip().lower() == text.strip().lower()
564         elif matchType == 'contains' :
565                 return header.lower().find( text.strip().lower() ) != -1
566         else :
567                 logMessage( 'Unknown match type `%s\' from %s\'s user configuration.' % ( matchType , g_user ) )
568         return False
569                         
570 #
571 # Test rule 'rule' against the mail.
572 #
573 def testRule( rule ) :
574
575         cmd = rule[ 0 ]
576
577         if cmd == 'and' :
578                 return all( rule[ 2 ] , testRule )
579
580         if cmd == 'or' :
581                 return some( rule[ 2 ] , testRule )
582
583         if cmd == 'not' :
584                 return not some( rule[ 2 ] , testRule )
585
586         #
587         # Matching a header
588         #
589         if cmd == 'header' :
590                 if g_mail == None :
591                         return False
592                 args = rule[ 1 ]
593                 headerName , matchType , text = args
594                 headers = map( normalizeBlank , g_mail.get_all( headerName ) or [] )
595                 return some( headers , lambda header : ruleMatch( header , matchType , text ) )
596
597         #
598         # Broken mail
599         #
600         if cmd == 'broken' :
601                 return g_mail == None
602
603         #
604         # Infected mail
605         #
606         if cmd == 'infected' :
607                 return g_mail != None and not antivirusScan()
608
609         #
610         # Spam mail
611         #
612         if cmd == 'spam' :
613                 return g_mail != None and not spamScan()
614
615         #
616         # Unknown rule
617         #
618         logMessage( 'Unknown rule name `%s\'.' % ( cmd , ) )
619         return False
620
621 #-----------------------------------------------------------------------------
622
623 #
624 # Find the destination folder for user 'user' according to rules defined for
625 # him/her against the current mail.
626 #
627 # Return an Action.
628 #
629 def checkUserRules( user ) :
630
631         action = FileToFolderAction( None )
632
633         conf = readUserRules( user )
634
635         if not conf :
636
637                 logMessage( 'No rules defined for user `%s\'.' % user )
638
639         elif not conf[ 2 ] :
640
641                 logMessage( 'Empty rules set or syntax error encountered for user `%s\'.' % user )
642
643         else :
644
645                 for item in conf[ 2 ] :
646                         actionName , args , subs = item[ : 3 ]
647
648                         if some( subs , testRule ) :
649                                 if actionName == 'folder' :
650                                         action = FileToFolderAction( args[ 0 ] )
651                                 elif actionName == 'reject' :
652                                         action = CustomErrorCodeAction( errorNameToErrorCode( args[ 0 ] ) )
653                                 else :
654                                         logMessage( 'Unknown action `%s\'.' % actionName )
655                                 break
656
657         return action
658
659 #-----------------------------------------------------------------------------
660
661 #
662 # Read mail from standard input.
663 #
664 def readMail() :
665
666         global g_mailText
667
668         #
669         # FIXME: Should we be reading the mail by block, so that
670         # we can at least read and backup a part of the standard input
671         # in case an error occur ? (broken pipe for example)
672         #
673         # If error occur, and since we can't backup the mail,
674         # we ask sendmail to retry later.
675         #
676         try :
677                 g_mailText = sys.stdin.read()
678         except :
679                 logMessage( getTraceBack() )
680                 sys.exit( EX_TEMPFAIL )
681
682 #
683 # Check if the mail is bigger than a predefined amount.
684 #
685 def checkForLargeMail() :
686
687         if len( g_mailText ) > g_maxMailSize :
688                 logMessage( 'Message too big (%s bytes). Not filtering it.' % len( g_mailText ) )
689                 rc = None
690                 if g_user :
691                         rc = deliverTo( g_user )
692                         if rc != EX_OK :
693                                 logMessage( 'Unable to deliver it to user `%s\'.' % g_user )
694                 if rc != EX_OK :
695                         backup( g_user )
696                 sys.exit( EX_OK )
697
698 #
699 # Check if user was specified of command line.
700 #
701 def checkForUser() :
702
703         #
704         # No user specified.
705         #
706         if not g_user :
707                 logMessage( 'No user specified.' )
708                 backup()
709                 sys.exit( EX_OK )
710
711 #
712 # Parse the mail using email python standard module.
713 #
714 def parseMail() :
715
716         global g_mail
717
718         #
719         # Parsing the mail.
720         #
721         try :
722                 g_mail = email.message_from_string( g_mailText , strict = False )
723         except :
724                 logMessage( getTraceBack() )
725
726 #
727 # Dispatch the mail to the correct folder (deduced from rules.)
728 #
729 # Return an error code.
730 #
731 def dispatchMail() :
732
733         action = checkUserRules( g_user )
734
735         #
736         # If custom error code is returned, stop processing
737         # here (mail is not saved.)
738         #
739         if isinstance( action , CustomErrorCodeAction ) :
740                 logMessage( 'Custom exit code is %d.' % r.code )
741                 return action.code
742
743         #
744         # File the mail into the specified folder.
745         #
746         if isinstance( action , FileToFolderAction ) :
747                 #
748                 # We got a folder name (or None for default folder.)
749                 #
750                 folder = action.folder
751                 pseudoName = 'INBOX'
752                 if folder : pseudoName += '.' + folder
753
754                 #
755                 # Try to deliver in the named folder
756                 #
757                 rc = deliverTo( g_user , folder )
758                 #
759                 # If we get an error code, then we deliver the mail to default folder,
760                 # except if the error was "data error" or if we already tried to deliver
761                 # it to default folder.
762                 #
763                 if rc not in [ EX_OK , EX_DATAERR ] and folder != None :
764                         logMessage( 'Error delivering to folder %s of user `%s\'.' % ( pseudoName , g_user ) )
765                         logMessage( 'Mail will go into default folder.' )
766                         rc = deliverTo( g_user )
767                 #
768                 # Check again.
769                 #
770                 # Here we also handle the case of EX_DATAERR not handled above.
771                 #
772                 if rc != EX_OK :
773                         logMessage( 'Error delivering to default folder of user `%s\'.' % ( g_user , ) )
774                         #
775                         # Since it's still not ok, backup the mail.
776                         #
777                         backup( g_user )
778                         #
779                         # All errors code different from "data error" are translated to
780                         # "no user" error code.
781                         #
782                         # FIXME: Why?!
783                         #
784                         if rc != EX_DATAERR :
785                                 rc = EX_NOUSER
786
787                 #
788                 # FIXME: !!!!!
789                 #
790                 rc = EX_OK
791
792                 return rc
793         
794         raise Exception( 'Unknown action type' )
795
796 #
797 #
798 #
799 def process() :
800
801         readMail()
802         try :
803                 checkForUser()
804                 checkForLargeMail()
805                 parseMail()
806                 return dispatchMail()
807         except :
808                 logMessage( getTraceBack() )
809                 return EX_DATAERR
810
811 #-----------------------------------------------------------------------------
812
813 def checkConfiguration( filename ) :
814
815         try :
816                 confparser.readConfiguration( filename )
817         except Exception , e :
818                 print e
819
820 #-----------------------------------------------------------------------------
821
822 def usage() :
823
824         print '''Usage: mail.filter [OPTIONS] username < EMAIL
825
826  -h, --help                Print this help.
827  -v, --verbose             Verbose mode, output log to stdout.
828  -t, --test                Test mode. Don't feed the mail to Cyrus, don't
829                            do backup, and don't write anything into log file.
830  -l, --log=FILENAME        Set log filename.
831  -r, --rules=DIRECTORY     Directory where are located users rules.
832  -c, --check-config=FILENAME
833                            Check syntax and structure of configuration file
834                            FILENAME.
835 '''
836
837         print 'Current paths are:\n'
838         print '    spamprobe  : %s' % g_pathSpamProbe
839         print '    clamd      : %s' % g_pathClamdscan
840         print '    deliver    : %s' % g_pathCyrusDeliver
841         print '    log        : %s' % g_pathLog
842         print
843         print 'Current directories are:\n'
844         print '    spamprobedb: %s' % g_pathSpamProbeDb
845         print '    rules      : %s' % g_directoryRules
846         print '''
847 Latest version is available from:
848
849     arch://arch.intra.tuxee.net/2004/mail-filter
850
851 Report bugs to <fj@tuxee.net>.'''
852
853 def main() :
854
855         global g_user, g_mail, g_mailText, g_copyLogToStdout, g_pathLog, g_directoryRules , g_testMode
856
857         #--[ Command line ]-------------------------------------------------------
858
859         import getopt
860         try :
861                 _getopt = getopt.gnu_getopt
862         except :
863                 _getopt = getopt.getopt
864
865         try :
866                 options , parameters = \
867                         _getopt( sys.argv[ 1 : ] ,
868                                 'hvtl:r:c:' ,
869                                 ( 'help' , 'verbose' , 'test' , 'log=' , 'rules=' , 'check-config=' ) )
870         except getopt.GetoptError , e :
871                 myName = sys.argv[ 0 ].split( '/' )[ -1 ]
872                 print '%s: %s' % ( myName , e[ 0 ] )
873                 print 'Try `%s --help\' for more information.' % myName
874                 sys.exit( 1 )
875
876         for option , argument in options :
877                 if option in [ '-h' , '--help' ] :
878                         usage()
879                         sys.exit( 0 )
880                 elif option in [ '-v' , '--verbose' ] :
881                         g_copyLogToStdout = True
882                 elif option in [ '-t' , '--test' ] :
883                         g_testMode = True
884                 elif option in [ '-l' , '--log' ] :
885                         g_pathLog = argument
886                 elif option in [ '-r' , '--rules' ] :
887                         g_directoryRules = argument
888                 elif option in [ '-c' , '--check-config' ] :
889                         checkConfiguration( argument )
890                         sys.exit( 0 )
891
892         #
893         # At most one parameter expected.
894         #
895         if len( parameters ) > 1 :
896                 #
897                 # We just log a error message. We continue to proceed
898                 # to not lost the mail !
899                 #
900                 logMessage( 'Warning: Expected only one user name.' )
901
902         if parameters :
903                 g_user = parameters[ 0 ]
904
905         #--[ Core ]---------------------------------------------------------------
906
907         logMessage( 'Running mail.filter for user `%s\'.' % g_user )
908
909         return process()
910
911 if __name__ == '__main__' :
912         sys.exit( main() )