/usr/lib/python2.7/dist-packages/spambayes/ProxyUI.py is in spambayes 1.1b1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 | """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, IMAP4 SMTP proxies. 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-2007
# 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 <richie@entrian.com>"
__credits__ = "Tim Peters, Neale Pickett, Tim Stone, all the Spambayes folk."
import cgi
import time
import types
import bisect
from spambayes import UserInterface
from spambayes.Options import options, _
state = None
# 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'),
# ('IMAP4 Proxy Options', None),
# ('imap4proxy', 'remote_servers'),
# ('imap4proxy', '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 these 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'),
('Classifier', 'use_bigrams'),
(_('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'),
('globals', 'language'),
(_('POP3 Proxy Options'), None),
('pop3proxy', 'retrieval_timeout'),
)
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,
proxy_state.lang_manager,
proxy_state.stats)
state = proxy_state
self.state_recreator = state_recreator # ugly
self.app_for_version = "SpamBayes Proxy"
if not proxy_state.can_stop:
self.html._readonly = False
self.html.shutdownTableCell = " "
self.html._readonly = True
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.<br/>")
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, m)
state.unknownCorpus.addMessage(message)
# Return a link Home.
self.write(_("<p>OK. Return <a href='home'>Home</a>.</p>"))
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 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:'):
old_class, id = key.split(':')[1:3]
if value == _('spam'):
targetCorpus = state.spamCorpus
stats_as_ham = False
elif value == _('ham'):
targetCorpus = state.hamCorpus
stats_as_ham = True
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(_("<p><b>Training... "))
self.flush()
numTrained += 1
self.stats.RecordTraining(\
stats_as_ham, old_class=old_class)
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:
response = "Trained on one message. "
else:
response = "Trained on %d messages. " % (numTrained,)
self._doSave()
self.write(response)
self.write("<br> ")
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 = _("<p>You must enter a search string.</p>")
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(_('<p>Searching...</p>'))
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):
if len(keys) == 1:
title = _("Found message")
else:
title = _("Found messages")
keys = list(keys)
else:
page = _("<p>Could not find any matching messages. " \
"Maybe they expired?</p>")
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()
# The decision about whether to reverse the sort
# order has to go here, because _sortMessages gets called
# thrice, and so the ham list would end up sorted backwards.
sort_order = params.get('sort')
if self.previous_sort == sort_order:
reverse = True
self.previous_sort = None
else:
reverse = False
self.previous_sort = sort_order
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 disp_header in options["html_ui", "display_headers"]:
h.headerLink.href = 'review?sort=%sHeader' % \
(disp_header.lower(),)
h.headerName = disp_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,
sort_order, reverse)
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 = _("<p>There are no untrained messages to display. " \
"Return <a href='home'>Home</a>, or " \
"<a href='review'>check again</a>.</p>")
title = _("No untrained messages")
box = self._buildBox(title, 'status.gif', page)
self.write(box)
self._writePostamble(help_topic="review")
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("<pre>%s</pre>" % cgi.escape(message.as_string()))
else:
self.write(_("<p>Can't find message %r. Maybe it expired.</p>") % 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(_("<p>Can't find message %r. Maybe it expired.</p>") % key)
self._writePostamble()
def close_database(self):
state.close()
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 += _('<li>The number of POP3 proxy ports specified ' \
'must match the number of servers specified</li>\n')
# check for duplicate ports
plist.sort()
for p in range(len(plist)-1):
try:
if plist[p] == plist[p+1]:
errmsg += _('<li>All POP3 port numbers must be unique</li>')
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 += _('<li>The number of SMTP proxy ports specified ' \
'must match the number of servers specified</li>\n')
# check for duplicate ports
plist.sort()
for p in range(len(plist)-1):
try:
if plist[p] == plist[p+1]:
errmsg += _('<li>All SMTP port numbers must be unique</li>')
break
except IndexError:
pass
return errmsg
|