"""POP3Proxy and SMTPProxy Web Interface Classes: ProxyUserInterface - Interface class for pop3proxy and smtpproxy Abstract: This module implements a browser based Spambayes user interface for the POP3 proxy and SMTP proxy. Users may use it to interface with the proxies. The following functions are currently included: [From the base class UserInterface] onClassify - classify a given message onWordquery - query a word from the database onTrain - train a message or mbox onSave - save the database and possibly shutdown [Here] onHome - a home page with various options onUpload - upload a message for later training (used by proxytee.py) onReview - show messages in corpii onView - view a message from one of the corpii onShowclues - show clues for a message To do: Web training interface: o Review already-trained messages, and purge them. o Add a Today button on the Review page. User interface improvements: o Can it cleanly dynamically update its status display while having a POP3 conversation? Hammering reload sucks. o Suggestions? """ # This module is part of the spambayes project, which is Copyright 2002-3 # The Python Software Foundation and is covered by the Python Software # Foundation license. # This module was once part of pop3proxy.py; if you are looking through # the history of the file, you may need to go back there. __author__ = "Richie Hindle " __credits__ = "Tim Peters, Neale Pickett, Tim Stone, all the Spambayes folk." try: True, False except NameError: # Maintain compatibility with Python 2.2 True, False = 1, 0 import re import cgi import time import types import bisect try: from sets import Set except ImportError: from compatsets import Set import tokenizer import UserInterface from spambayes.Options import options from email.Iterators import typed_subpart_iterator global state # These are the options that will be offered on the configuration page. # If the option is None, then the entry is a header and the following # options will appear in a new box on the configuration page. # These are also used to generate http request parameters and template # fields/variables. parm_ini_map = ( ('POP3 Proxy Options', None), ('pop3proxy', 'remote_servers'), ('pop3proxy', 'listen_ports'), ('SMTP Proxy Options', None), ('smtpproxy', 'remote_servers'), ('smtpproxy', 'listen_ports'), ('smtpproxy', 'ham_address'), ('smtpproxy', 'spam_address'), ('smtpproxy', 'use_cached_message'), ('Header Options', None), ('Headers', 'notate_to'), ('Headers', 'notate_subject'), ('Storage Options', None), ('Storage', 'persistent_storage_file'), ('Storage', 'messageinfo_storage_file'), ('Storage', 'cache_messages'), ('Storage', 'no_cache_bulk_ham'), ('Storage', 'no_cache_large_messages'), ('Statistics Options', None), ('Categorization', 'ham_cutoff'), ('Categorization', 'spam_cutoff'), ) # Like the above, but hese are the options that will be offered on the # advanced configuration page. adv_map = ( ('Statistics Options', None), ('Classifier', 'max_discriminators'), ('Classifier', 'minimum_prob_strength'), ('Classifier', 'unknown_word_prob'), ('Classifier', 'unknown_word_strength'), ('Header Options', None), ('Headers', 'include_score'), ('Headers', 'header_score_digits'), ('Headers', 'header_score_logarithm'), ('Headers', 'include_thermostat'), ('Headers', 'include_evidence'), ('Headers', 'clue_mailheader_cutoff'), ('Storage Options', None), ('Storage', 'persistent_use_database'), ('Storage', 'cache_expiry_days'), ('Storage', 'cache_use_gzip'), ('Storage', 'ham_cache'), ('Storage', 'spam_cache'), ('Storage', 'unknown_cache'), ('Tokenising Options', None), ('Tokenizer', 'mine_received_headers'), ('Tokenizer', 'replace_nonascii_chars'), ('Tokenizer', 'summarize_email_prefixes'), ('Tokenizer', 'summarize_email_suffixes'), ('Training Options', None), ('Hammie', 'train_on_filter'), ('Interface Options', None), ('html_ui', 'display_headers'), ('html_ui', 'display_received_time'), ('html_ui', 'display_score'), ('html_ui', 'display_adv_find'), ('html_ui', 'default_ham_action'), ('html_ui', 'default_spam_action'), ('html_ui', 'default_unsure_action'), ('html_ui', 'ham_discard_level'), ('html_ui', 'spam_discard_level'), ('html_ui', 'allow_remote_connections'), ('html_ui', 'http_authentication'), ('html_ui', 'http_user_name'), ('html_ui', 'http_password'), ('pop3proxy', 'allow_remote_connections'), ('smtpproxy', 'allow_remote_connections'), ) class ProxyUserInterface(UserInterface.UserInterface): """Serves the HTML user interface for the proxies.""" def __init__(self, proxy_state, state_recreator): global state UserInterface.UserInterface.__init__(self, proxy_state.bayes, parm_ini_map, adv_map) state = proxy_state self.state_recreator = state_recreator # ugly self.app_for_version = "POP3 Proxy" self.previous_sort = None def onHome(self): """Serve up the homepage.""" state.buildStatusStrings() stateDict = state.__dict__.copy() stateDict.update(state.bayes.__dict__) statusTable = self.html.statusTable.clone() if not state.servers: statusTable.proxyDetails = "No POP3 proxies running.
" findBox = self._buildBox('Word query', 'query.gif', self.html.wordQuery) if not options["html_ui", "display_adv_find"]: del findBox.advanced content = (self._buildBox('Status and Configuration', 'status.gif', statusTable % stateDict)+ self._buildBox('Train on proxied messages', 'train.gif', self.html.reviewText) + self._buildTrainBox() + self._buildClassifyBox() + findBox + self._buildBox('Find message', 'query.gif', self.html.findMessage) ) self._writePreamble("Home") self.write(content) self._writePostamble(help_topic="home_proxy") def onUpload(self, file): """Save a message for later training - used by Skip's proxytee.py.""" # Convert platform-specific line endings into unix-style. file = file.replace('\r\n', '\n').replace('\r', '\n') # Get a message list from the upload and write it into the cache. messages = self._convertUploadToMessageList(file) for m in messages: messageName = state.getNewMessageName() message = state.unknownCorpus.makeMessage(messageName) message.setPayload(m) state.unknownCorpus.addMessage(message) # Return a link Home. self.write("

OK. Return Home.

") def _keyToTimestamp(self, key): """Given a message key (as seen in a Corpus), returns the timestamp for that message. This is the time that the message was received, not the Date header.""" return long(key[:10]) def _getTimeRange(self, timestamp): """Given a unix timestamp, returns a 3-tuple: the start timestamp of the given day, the end timestamp of the given day, and the formatted date of the given day.""" # This probably works on Summertime-shift days; time will tell. 8-) this = time.localtime(timestamp) start = (this[0], this[1], this[2], 0, 0, 0, this[6], this[7], this[8]) end = time.localtime(time.mktime(start) + 36*60*60) end = (end[0], end[1], end[2], 0, 0, 0, end[6], end[7], end[8]) date = time.strftime("%A, %B %d, %Y", start) return time.mktime(start), time.mktime(end), date def _buildReviewKeys(self, timestamp): """Builds an ordered list of untrained message keys, ready for output in the Review list. Returns a 5-tuple: the keys, the formatted date for the list (eg. "Friday, November 15, 2002"), the start of the prior page or zero if there isn't one, likewise the start of the given page, and likewise the start of the next page.""" # Fetch all the message keys allKeys = state.unknownCorpus.keys() # We have to sort here to split into days. # Later on, we also sort the messages that will be on the page # (by whatever column we wish). allKeys.sort() # The default start timestamp is derived from the most recent message, # or the system time if there are no messages (not that it gets used). if not timestamp: if allKeys: timestamp = self._keyToTimestamp(allKeys[-1]) else: timestamp = time.time() start, end, date = self._getTimeRange(timestamp) # Find the subset of the keys within this range. startKeyIndex = bisect.bisect(allKeys, "%d" % long(start)) endKeyIndex = bisect.bisect(allKeys, "%d" % long(end)) keys = allKeys[startKeyIndex:endKeyIndex] keys.reverse() # What timestamps to use for the prior and next days? If there any # messages before/after this day's range, use the timestamps of those # messages - this will skip empty days. prior = end = 0 if startKeyIndex != 0: prior = self._keyToTimestamp(allKeys[startKeyIndex-1]) if endKeyIndex != len(allKeys): end = self._keyToTimestamp(allKeys[endKeyIndex]) # Return the keys and their date. return keys, date, prior, start, end def _sortMessages(self, messages, sort_order): """Sorts the message by the appropriate attribute. If this was the previous sort order, then reverse it.""" if sort_order is None or sort_order == "received": # Default sorting, which is in reverse order of appearance. # This is complicated because the 'received' info is the key. messages.sort() if self.previous_sort == sort_order: messages.reverse() self.previous_sort = None else: self.previous_sort = 'received' return messages else: tmplist = [(getattr(x[1], sort_order), x) for x in messages] tmplist.sort() if self.previous_sort == sort_order: tmplist.reverse() self.previous_sort = None else: self.previous_sort = sort_order return [x for (key, x) in tmplist] def _appendMessages(self, table, keyedMessageInfo, label, sort_order): """Appends the rows of a table of messages to 'table'.""" stripe = 0 keyedMessageInfo = self._sortMessages(keyedMessageInfo, sort_order) nrows = options["html_ui", "rows_per_section"] for key, messageInfo in keyedMessageInfo[:nrows]: unused, unused, messageInfo.received = \ self._getTimeRange(self._keyToTimestamp(key)) row = self.html.reviewRow.clone() try: score = float(messageInfo.score.rstrip('%')) except ValueError: score = None if label == 'Spam': if score is not None \ and score > options["html_ui", "spam_discard_level"]: r_att = getattr(row, 'discard') else: r_att = getattr(row, options["html_ui", "default_spam_action"]) elif label == 'Ham': if score is not None \ and score < options["html_ui", "ham_discard_level"]: r_att = getattr(row, 'discard') else: r_att = getattr(row, options["html_ui", "default_ham_action"]) else: r_att = getattr(row, options["html_ui", "default_unsure_action"]) setattr(r_att, "checked", 1) row.optionalHeadersValues = '' # make way for real list for header in options["html_ui", "display_headers"]: header = header.lower() text = getattr(messageInfo, "%sHeader" % (header,)) if header == "subject": # Subject is special, because it links to the body. # If the user doesn't display the subject, then there # is no link to the body. h = self.html.reviewRow.linkedHeaderValue.clone() h.text.title = messageInfo.bodySummary h.text.href = "view?key=%s&corpus=%s" % (key, label) else: h = self.html.reviewRow.headerValue.clone() h.text = text row.optionalHeadersValues += h # Apart from any message headers, we may also wish to display # the message score, and the time the message was received. if options["html_ui", "display_score"]: row.score_ = messageInfo.score else: del row.score_ if options["html_ui", "display_received_time"]: row.received_ = messageInfo.received else: del row.received_ # Many characters can't go in the URL or they cause problems # (&, ;, ?, etc). So we use the hex values for them all. subj_list = [] for c in messageInfo.subjectHeader: subj_list.append("%%%s" % (hex(ord(c))[2:],)) subj = "".join(subj_list) row.classify.href="showclues?key=%s&subject=%s" % (key, subj) row.tokens.href="showclues?key=%s&subject=%s&tokens=1" % (key, subj) setattr(row, 'class', ['stripe_on', 'stripe_off'][stripe]) # Grr! row = str(row).replace('TYPE', label).replace('KEY', key) table += row stripe = stripe ^ 1 def onReview(self, **params): """Present a list of message for (re)training.""" # Train/discard sumbitted messages. self._writePreamble("Review") id = '' numTrained = 0 numDeferred = 0 if params.get('go') != 'Refresh': for key, value in params.items(): if key.startswith('classify:'): id = key.split(':')[2] if value == 'spam': targetCorpus = state.spamCorpus elif value == 'ham': targetCorpus = state.hamCorpus elif value == 'discard': targetCorpus = None try: state.unknownCorpus.removeMessage(\ state.unknownCorpus[id]) except KeyError: pass # Must be a reload. else: # defer targetCorpus = None numDeferred += 1 if targetCorpus: sourceCorpus = None if state.unknownCorpus.get(id) is not None: sourceCorpus = state.unknownCorpus elif state.hamCorpus.get(id) is not None: sourceCorpus = state.hamCorpus elif state.spamCorpus.get(id) is not None: sourceCorpus = state.spamCorpus if sourceCorpus is not None: try: # fromCache is a fix for sf #851785. # See the comments in Corpus.py targetCorpus.takeMessage(id, sourceCorpus, fromCache=True) if numTrained == 0: self.write("

Training... ") self.flush() numTrained += 1 except KeyError: pass # Must be a reload. # Report on any training, and save the database if there was any. if numTrained > 0: plural = '' if numTrained != 1: plural = 's' self._doSave() self.write("Trained on %d message%s. " % (numTrained, plural)) self.write("
 ") title = "" keys = [] sourceCorpus = state.unknownCorpus # If any messages were deferred, show the same page again. if numDeferred > 0: start = self._keyToTimestamp(id) # Else after submitting a whole page, display the prior page or the # next one. Derive the day of the submitted page from the ID of the # last processed message. elif id: start = self._keyToTimestamp(id) unused, unused, prior, unused, next = self._buildReviewKeys(start) if prior: start = prior else: start = next # Else if they've hit Previous or Next, display that page. elif params.get('go') == 'Next day': start = self._keyToTimestamp(params['next']) elif params.get('go') == 'Previous day': start = self._keyToTimestamp(params['prior']) # Else if an id has been specified, just show that message # Else if search criteria have been specified, show the messages # that match those criteria. elif params.get('find') is not None: prior = next = 0 keys = Set() # so we don't end up with duplicates push = keys.add try: max_results = int(params['max_results']) except ValueError: max_results = 1 key = params['find'] if params.has_key('ignore_case'): ic = True else: ic = False error = False if key == "": error = True page = "

You must enter a search string.

" else: if len(keys) < max_results and \ params.has_key('id'): if state.unknownCorpus.get(key): push((key, state.unknownCorpus)) elif state.hamCorpus.get(key): push((key, state.hamCorpus)) elif state.spamCorpus.get(key): push((key, state.spamCorpus)) if params.has_key('subject') or params.has_key('body') or \ params.has_key('headers'): # This is an expensive operation, so let the user know # that something is happening. self.write('

Searching...

') for corp in [state.unknownCorpus, state.hamCorpus, state.spamCorpus]: for k in corp.keys(): if len(keys) >= max_results: break msg = corp[k] msg.load() if params.has_key('subject'): subj = str(msg['Subject']) if self._contains(subj, key, ic): push((k, corp)) if params.has_key('body'): # For [ 906581 ] Assertion failed in search # subject. Can the headers be a non-string? msg_body = msg.as_string() msg_body = msg_body[msg_body.index('\r\n\r\n'):] if self._contains(msg_body, key, ic): push((k, corp)) if params.has_key('headers'): for nm, val in msg.items(): # For [ 906581 ] Assertion failed in # search subject. Can the headers be # a non-string? nm = str(nm) val = str(val) if self._contains(nm, key, ic) or \ self._contains(val, key, ic): push((k, corp)) if len(keys): title = "Found message%s" % (['','s'][len(keys)>1],) keys = list(keys) else: page = "

Could not find any matching messages. " \ "Maybe they expired?

" title = "Did not find message" box = self._buildBox(title, 'status.gif', page) self.write(box) self.write(self._buildBox('Find message', 'query.gif', self.html.findMessage)) self._writePostamble() return # Else show the most recent day's page, as decided by _buildReviewKeys. else: start = 0 # Build the lists of messages: spams, hams and unsure. if len(keys) == 0: keys, date, prior, this, next = self._buildReviewKeys(start) keyedMessageInfo = {options["Headers", "header_unsure_string"]: [], options["Headers", "header_ham_string"]: [], options["Headers", "header_spam_string"]: [], } invalid_keys = [] for key in keys: if isinstance(key, types.TupleType): key, sourceCorpus = key else: sourceCorpus = state.unknownCorpus # Parse the message, get the judgement header and build a message # info object for each message. message = sourceCorpus[key] try: message.load() except IOError: # Someone has taken this file away from us. It was # probably a virus protection program, so that's ok. # Don't list it in the review, though. invalid_keys.append(key) continue judgement = message[options["Headers", "classification_header_name"]] if judgement is None: judgement = options["Headers", "header_unsure_string"] else: judgement = judgement.split(';')[0].strip() messageInfo = self._makeMessageInfo(message) keyedMessageInfo[judgement].append((key, messageInfo)) for key in invalid_keys: keys.remove(key) # Present the list of messages in their groups in reverse order of # appearance, by default, or according to the specified sort order. if keys: page = self.html.reviewtable.clone() if prior: page.prior.value = prior del page.priorButton.disabled if next: page.next.value = next del page.nextButton.disabled templateRow = page.reviewRow.clone() page.table = "" # To make way for the real rows. for header, label in ((options["Headers", "header_unsure_string"], 'Unsure'), (options["Headers", "header_ham_string"], 'Ham'), (options["Headers", "header_spam_string"], 'Spam')): messages = keyedMessageInfo[header] if messages: sh = self.html.reviewSubHeader.clone() # Setup the header row sh.optionalHeaders = '' h = self.html.headerHeader.clone() for header in options["html_ui", "display_headers"]: h.headerLink.href = 'review?sort=%sHeader' % \ (header.lower(),) h.headerName = header.title() sh.optionalHeaders += h if not options["html_ui", "display_score"]: del sh.score_header if not options["html_ui", "display_received_time"]: del sh.received_header subHeader = str(sh) subHeader = subHeader.replace('TYPE', label) page.table += self.html.blankRow page.table += subHeader self._appendMessages(page.table, messages, label, params.get('sort')) page.table += self.html.trainRow if title == "": title = "Untrained messages received on %s" % date box = self._buildBox(title, None, page) # No icon, to save space. else: page = "

There are no untrained messages to display. " page += "Return Home, or " page += "check again.

" title = "No untrained messages" box = self._buildBox(title, 'status.gif', page) self.write(box) self._writePostamble(help_topic="review") def _contains(self, a, b, ignore_case=False): """Return true if substring b is part of string a.""" assert(isinstance(a, types.StringTypes)) assert(isinstance(b, types.StringTypes)) if ignore_case: a = a.lower() b = b.lower() return a.find(b) >= 0 def onView(self, key, corpus): """View a message - linked from the Review page.""" self._writePreamble("View message", parent=('review', 'Review')) sourceCorpus = None message = None if state.unknownCorpus.get(key) is not None: sourceCorpus = state.unknownCorpus elif state.hamCorpus.get(key) is not None: sourceCorpus = state.hamCorpus elif state.spamCorpus.get(key) is not None: sourceCorpus = state.spamCorpus if sourceCorpus is not None: message = sourceCorpus.get(key) if message is not None: self.write("
%s
" % cgi.escape(message.as_string())) else: self.write("

Can't find message %r. Maybe it expired.

" % key) self._writePostamble() def onShowclues(self, key, subject, tokens='0'): """Show clues for a message - linked from the Review page.""" tokens = bool(int(tokens)) # needs the int, as bool('0') is True self._writePreamble("Message clues", parent=('review', 'Review')) sourceCorpus = None message = None if state.unknownCorpus.get(key) is not None: sourceCorpus = state.unknownCorpus elif state.hamCorpus.get(key) is not None: sourceCorpus = state.hamCorpus elif state.spamCorpus.get(key) is not None: sourceCorpus = state.spamCorpus if sourceCorpus is not None: message = sourceCorpus.get(key).as_string() if message is not None: message = message.replace('\r\n', '\n').replace('\r', '\n') # For Macs results = self._buildCluesTable(message, subject, tokens) del results.classifyAnother self.write(results) else: self.write("

Can't find message %r. Maybe it expired.

" % key) self._writePostamble() def _makeMessageInfo(self, message): """Given an email.Message, return an object with subjectHeader, bodySummary and other header (as needed) attributes. These objects are passed into appendMessages by onReview - passing email.Message objects directly uses too much memory.""" subjectHeader = message["Subject"] or "(none)" headers = {"subject" : subjectHeader} for header in options["html_ui", "display_headers"]: headers[header.lower()] = (message[header] or "(none)") score = message[options["Headers", "score_header_name"]] if score: # the score might have the log info at the end op = score.find('(') if op >= 0: score = score[:op] try: score = "%.2f%%" % (float(score)*100,) except ValueError: # Hmm. The score header should only contain a floating # point number. What's going on here, then? score = "Err" # Let the user know something is wrong. else: # If the lookup fails, this means that the "include_score" # option isn't activated. We have the choice here to either # calculate it now, which is pretty inefficient, since we have # already done so, or to admit that we don't know what it is. # We'll go with the latter. score = "?" try: part = typed_subpart_iterator(message, 'text', 'plain').next() text = part.get_payload() except StopIteration: try: part = typed_subpart_iterator(message, 'text', 'html').next() text = part.get_payload() text, unused = tokenizer.crack_html_style(text) text, unused = tokenizer.crack_html_comment(text) text = tokenizer.html_re.sub(' ', text) text = '(this message only has an HTML body)\n' + text except StopIteration: text = '(this message has no text body)' if type(text) == type([]): # gotta be a 'right' way to do this text = "(this message is a digest of %s messages)" % (len(text)) elif text is None: text = "(this message has no body)" else: text = text.replace(' ', ' ') # Else they'll be quoted text = re.sub(r'(\s)\s+', r'\1', text) # Eg. multiple blank lines text = text.strip() class _MessageInfo: pass messageInfo = _MessageInfo() for headerName, headerValue in headers.items(): headerValue = self._trimHeader(headerValue, 45, True) setattr(messageInfo, "%sHeader" % (headerName,), headerValue) messageInfo.score = score messageInfo.bodySummary = self._trimHeader(text, 200) return messageInfo def reReadOptions(self): """Called by the config page when the user saves some new options, or restores the defaults.""" # Re-read the options. global state import Options Options.load_options() global options from Options import options # Recreate the state. state = self.state_recreator() self.classifier = state.bayes def verifyInput(self, parms, pmap): '''Check that the given input is valid.''' # Most of the work here is done by the parent class, but # we have a few extra checks errmsg = UserInterface.UserInterface.verifyInput(self, parms, pmap) if pmap != parm_ini_map: return errmsg # check for equal number of pop3servers and ports slist = list(parms['pop3proxy_remote_servers']) plist = list(parms['pop3proxy_listen_ports']) if len(slist) != len(plist): errmsg += '
  • The number of POP3 proxy ports specified ' + \ 'must match the number of servers specified
  • \n' # check for duplicate ports plist.sort() for p in range(len(plist)-1): try: if plist[p] == plist[p+1]: errmsg += '
  • All POP3 port numbers must be unique
  • ' break except IndexError: pass # check for equal number of smtpservers and ports slist = list(parms['smtpproxy_remote_servers']) plist = list(parms['smtpproxy_listen_ports']) if len(slist) != len(plist): errmsg += '
  • The number of SMTP proxy ports specified ' + \ 'must match the number of servers specified
  • \n' # check for duplicate ports plist.sort() for p in range(len(plist)-1): try: if plist[p] == plist[p+1]: errmsg += '
  • All SMTP port numbers must be unique
  • ' break except IndexError: pass return errmsg