git.intra.tuxee.net Git - confparser-old/blob - mailfilter.py

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