/usr/lib/python2.7/dist-packages/spambayes/XMLRPCPlugin.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 | """
XML-RPC plugin for SpamBayes core server.
This plugin opens an XML-RPC server in a separate thread listening to the
given host and port (default localhost:5001). In Python 2.5 and later it
also enforces a path (default /sbrpc).
SECURITY NOTE: The XML-RPC plugin provide *NO SECURITY*. It would be
unwise to listen to anything besides 'localhost'. Similarly, when
running the core_server configured with the XML-RPC plugin it's quite
likely that the main core_server interface will have to listen to
something other than localhost to allow administrators to administer
it remotely. Access to that URL should only be available to a set of
trusted administrators, probably by proxy through some other webserver
which provides the necessary authentication support.
The XML-RPC server exposes the following methods:
score(form_dict, extra_tokens) -> (score, evidence)
Scores a dictionary representing the contents of a web
submission form and a list of any extra tokens provided
by the caller. The return value is a list containing
the spam probability of the input and a set of (token,
probability) pairs for the most significant tokens.
score_mime(msg, encoding) -> (score, evidence)
Scores a MIME message (a string encoded using encoding).
The return value is as for the score method.
The following options are available in the Plugin section of the options.
xmlrpc_host - host to listen to (default: localhost)
xmlrpc_port - port to listen to (default: 8001)
xmlrpc_path - path to support (default: /sbrpc)
"""
__author__ = "Skip Montanaro <skip@pobox.com>"
__credits__ = "All the Spambayes folk."
# 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.
import threading
import xmlrpclib
import time
from email import Message, message_from_string
from SimpleXMLRPCServer import SimpleXMLRPCServer
from spambayes.CorePlugin import Plugin, PluginUI
from spambayes.Options import _, options
from spambayes.tokenizer import tokenize
import spambayes.message
from spambayes import storage
from spambayes import FileCorpus
class XMLRPCUI(PluginUI):
plugin_map = (
(_('XML-RPC Options'), None),
('Plugin', 'xmlrpc_path'),
('Plugin', 'xmlrpc_host'),
('Plugin', 'xmlrpc_port'),
)
class XMLRPCPlugin(Plugin):
def __init__(self, name, ui):
Plugin.__init__(self, name, ui)
host = options["Plugin", "xmlrpc_host"]
port = options["Plugin", "xmlrpc_port"]
path = options["Plugin", "xmlrpc_path"]
self.server = SimpleXMLRPCServer((host, port))
# Path is only enforced in Python 2.5 and later but we set it anyway.
self.server.RequestHandlerClass.rpc_paths = (path,)
self.server.register_instance(self)
self.thread = threading.Thread(target=self.server.serve_forever)
self.thread.setDaemon(True)
self.thread.start()
def _dispatch(self, method, params):
if method in ("score", "score_mime", "train", "train_mime"):
return getattr(self, method)(*params)
else:
raise xmlrpclib.Fault(404, '"%s" is not supported' % method)
def train(self, form_dict, extra_tokens, attachments, is_spam=True):
newdict = {}
for (i, k) in form_dict.items():
if isinstance(k, unicode):
k = k.encode("utf-8")
newdict[i] = k
mime_message = form_to_mime(newdict, extra_tokens, attachments)
mime_message = unicode(mime_message.as_string(), "utf-8").encode("utf-8")
self.train_mime(mime_message, "utf-8", is_spam)
return ""
def train_mime(self, msg_text, encoding, is_spam):
if self.state.bayes is None:
self.state.create_workers()
# Get msg_text into canonical string representation.
# Make sure we have a unicode object...
if isinstance(msg_text, str):
msg_text = unicode(msg_text, encoding)
# ... then encode it as utf-8.
if isinstance(msg_text, unicode):
msg_text = msg_text.encode("utf-8")
msg = message_from_string(msg_text,
_class=spambayes.message.SBHeaderMessage)
if is_spam:
desired_corpus = "spamCorpus"
else:
desired_corpus = "hamCorpus"
if hasattr(self, desired_corpus):
corpus = getattr(self, desired_corpus)
else:
if hasattr(self, "state"):
corpus = getattr(self.state, desired_corpus)
setattr(self, desired_corpus, corpus)
self.msg_name_func = self.state.getNewMessageName
else:
if is_spam:
fn = storage.get_pathname_option("Storage",
"spam_cache")
else:
fn = storage.get_pathname_option("Storage",
"ham_cache")
storage.ensureDir(fn)
if options["Storage", "cache_use_gzip"]:
factory = FileCorpus.GzipFileMessageFactory()
else:
factory = FileCorpus.FileMessageFactory()
age = options["Storage", "cache_expiry_days"]*24*60*60
corpus = FileCorpus.ExpiryFileCorpus(age, factory, fn,
'[0123456789\-]*',
cacheSize=20)
setattr(self, desired_corpus, corpus)
class UniqueNamer(object):
count = -1
def generate_name(self):
self.count += 1
return "%10.10d-%d" % (long(time.time()), self.count)
Namer = UniqueNamer()
self.msg_name_func = Namer.generate_name
key = self.msg_name_func()
mime_message = unicode(msg.as_string(), "utf-8").encode("utf-8")
msg = corpus.makeMessage(key, mime_message)
msg.setId(key)
corpus.addMessage(msg)
msg.RememberTrained(is_spam)
#self.stats.RecordTraining(not is_spam)
#if is_spam:
# self.state.bayes.nspam += 1
#else:
# self.state.bayes.nham += 1
def train_spam(self, form_dict, extra_tokens, attachments):
pass
def train_ham(self, form_dict, extra_tokens, attachments):
pass
def score(self, form_dict, extra_tokens, attachments):
"""Score a dictionary + extra tokens."""
newdict = {}
for (i, k) in form_dict.items():
if isinstance(k, unicode):
k = k.encode("utf-8")
newdict[i] = k
mime_message = form_to_mime(newdict, extra_tokens, attachments)
mime_message = unicode(mime_message.as_string(), "utf-8").encode("utf-8")
return self.score_mime(mime_message, "utf-8")
def score_mime(self, msg_text, encoding):
"""Score a message representing a MIME document.
The msg argument will be a string in the given encoding.
"""
# XXX Much of this probably belongs in the core server...
if self.state.bayes is None:
self.state.create_workers()
# Get msg_text into canonical string representation.
# Make sure we have a unicode object...
if isinstance(msg_text, str):
msg_text = unicode(msg_text, encoding)
# ... then encode it as utf-8.
if isinstance(msg_text, unicode):
msg_text = msg_text.encode("utf-8")
msg = message_from_string(msg_text,
_class=spambayes.message.SBHeaderMessage)
tokens = tokenize(msg)
# XXX Maybe from here on down...
prob, clues = self.state.bayes.spamprob(tokens, evidence=True)
msg.addSBHeaders(prob, clues)
self.state.record_classification(msg.GetClassification(), prob)
# Cache the message.
if not self.state.is_test and options["Storage", "cache_messages"]:
msg.setId(self.state.getNewMessageName())
# Write the message into the Unknown cache.
makeMessage = self.state.unknownCorpus.makeMessage
message = makeMessage(msg.getId(), msg.as_string())
self.state.unknownCorpus.addMessage(message)
return prob
def form_to_mime(form, extra_tokens, attachments):
"""Encode submission form bits as a MIME message.
form - a dictionary of key/value pairs representing the form's contents
extra_tokens - a sequence of synthetic tokens generated by the caller.
For example, if you include a honeypot hidden field in your form, you
might generate a synthetic token which tells if it was filled in or not.
You might also generate tokens which indicate how long a submitting
username has existed or how many successful posts that username has
submitted.
attachments - list of dictionaries describing an attachment.
The 'payload' key is required. If there is no 'content-type' key
'application/octet-stream' is assumed. If 'content-transfer-encoding'
is given it will be added to the headers of the attachment. Note that
the keys are case-sensitive and must be lower case.
"""
msg = Message.Message()
msg.set_type("multipart/digest")
msg.add_header("Subject", "Form submission")
msg.add_header("From", "SpamBayes XMLRPC Plugin <webmaster@localhost>")
main = Message.Message()
main.set_type("text/plain")
main.set_payload("\n".join(["%s:%s" % (k, v) for (k, v) in form.items()]))
msg.attach(main)
# Always add the extra tokens payload so we can reliably reverse the
# conversion.
extra = Message.Message()
extra.set_type("text/plain")
extra.set_payload("\n".join(extra_tokens))
msg.attach(extra)
# Any further payloads are for the attachments.
for content in attachments:
mime_type = content.get("content-type") or "application/octet-stream"
attachment = Message.Message()
if "content-transfer-encoding" in content:
attachment.add_header("Content-Transfer-Encoding",
content["content-transfer-encoding"])
attachment.set_type(mime_type)
attachment.set_payload(content["payload"])
msg.attach(attachment)
return msg
def register():
return XMLRPCPlugin("XMLRPC", XMLRPCUI())
|