paul@0 | 1 | # -*- coding: iso-8859-1 -*- |
paul@0 | 2 | """ |
paul@0 | 3 | MoinMoin - PostMessage Action |
paul@0 | 4 | |
paul@16 | 5 | @copyright: 2012, 2013 by Paul Boddie <paul@boddie.org.uk> |
paul@0 | 6 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@0 | 7 | """ |
paul@0 | 8 | |
paul@16 | 9 | from MoinMoin.Page import Page |
paul@0 | 10 | from MoinMoin.PageEditor import PageEditor |
paul@2 | 11 | from MoinMoin.log import getLogger |
paul@11 | 12 | from MoinMoin.user import User |
paul@20 | 13 | from MoinMoin import wikiutil |
paul@20 | 14 | from MoinSupport import ItemStore, getHeader, getMetadata, getWikiDict, writeHeaders |
paul@21 | 15 | from MoinMessage import GPG, Message, MoinMessageError, is_collection |
paul@0 | 16 | from email.parser import Parser |
paul@20 | 17 | import time |
paul@0 | 18 | |
paul@0 | 19 | try: |
paul@0 | 20 | from cStringIO import StringIO |
paul@0 | 21 | except ImportError: |
paul@0 | 22 | from StringIO import StringIO |
paul@0 | 23 | |
paul@0 | 24 | Dependencies = ['pages'] |
paul@0 | 25 | |
paul@0 | 26 | class PostMessage: |
paul@0 | 27 | |
paul@0 | 28 | "A posted message handler." |
paul@0 | 29 | |
paul@0 | 30 | def __init__(self, pagename, request): |
paul@0 | 31 | |
paul@0 | 32 | """ |
paul@0 | 33 | On the page with the given 'pagename', use the given 'request' when |
paul@0 | 34 | reading posted messages, modifying the Wiki. |
paul@0 | 35 | """ |
paul@0 | 36 | |
paul@0 | 37 | self.pagename = pagename |
paul@0 | 38 | self.request = request |
paul@0 | 39 | self.page = Page(request, pagename) |
paul@20 | 40 | self.store = ItemStore(self.page, "messages", "message-locks") |
paul@0 | 41 | |
paul@0 | 42 | def do_action(self): |
paul@0 | 43 | request = self.request |
paul@0 | 44 | content_length = getHeader(request, "Content-Length", "HTTP") |
paul@0 | 45 | if content_length: |
paul@0 | 46 | content_length = int(content_length) |
paul@0 | 47 | |
paul@5 | 48 | self.handle_message_text(request.read(content_length)) |
paul@0 | 49 | |
paul@5 | 50 | def handle_message_text(self, message_text): |
paul@1 | 51 | |
paul@1 | 52 | "Handle the given 'message_text'." |
paul@1 | 53 | |
paul@5 | 54 | message = Parser().parse(StringIO(message_text)) |
paul@5 | 55 | self.handle_message(message) |
paul@5 | 56 | |
paul@5 | 57 | def handle_message(self, message): |
paul@5 | 58 | |
paul@5 | 59 | "Handle the given 'message'." |
paul@5 | 60 | |
paul@1 | 61 | request = self.request |
paul@1 | 62 | mimetype = message.get_content_type() |
paul@1 | 63 | encoding = message.get_content_charset() |
paul@1 | 64 | |
paul@1 | 65 | # Detect PGP/GPG-encoded payloads. |
paul@1 | 66 | # See: http://tools.ietf.org/html/rfc3156 |
paul@1 | 67 | |
paul@3 | 68 | if mimetype == "multipart/signed" and \ |
paul@3 | 69 | message.get_param("protocol") == "application/pgp-signature": |
paul@1 | 70 | |
paul@5 | 71 | self.handle_signed_message(message) |
paul@2 | 72 | |
paul@5 | 73 | elif mimetype == "multipart/encrypted" and \ |
paul@5 | 74 | message.get_param("protocol") == "application/pgp-encrypted": |
paul@2 | 75 | |
paul@5 | 76 | self.handle_encrypted_message(message) |
paul@1 | 77 | |
paul@1 | 78 | # Reject unsigned payloads. |
paul@1 | 79 | |
paul@1 | 80 | else: |
paul@1 | 81 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@1 | 82 | request.write("Only PGP/GPG-signed payloads are supported.") |
paul@1 | 83 | |
paul@5 | 84 | def handle_encrypted_message(self, message): |
paul@5 | 85 | |
paul@5 | 86 | "Handle the given encrypted 'message'." |
paul@5 | 87 | |
paul@5 | 88 | request = self.request |
paul@5 | 89 | |
paul@5 | 90 | try: |
paul@5 | 91 | declaration, content = message.get_payload() |
paul@5 | 92 | except ValueError: |
paul@5 | 93 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@5 | 94 | request.write("There must be a declaration and a content part for encrypted uploads.") |
paul@5 | 95 | return |
paul@5 | 96 | |
paul@5 | 97 | # Verify the message format. |
paul@5 | 98 | |
paul@5 | 99 | if content.get_content_type() != "application/octet-stream": |
paul@5 | 100 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@5 | 101 | request.write("Encrypted data must be provided as application/octet-stream.") |
paul@5 | 102 | return |
paul@5 | 103 | |
paul@5 | 104 | homedir = self.get_homedir() |
paul@5 | 105 | if not homedir: |
paul@5 | 106 | return |
paul@5 | 107 | |
paul@8 | 108 | gpg = GPG(homedir) |
paul@1 | 109 | |
paul@8 | 110 | # Get the decrypted message text. |
paul@5 | 111 | |
paul@5 | 112 | try: |
paul@8 | 113 | text = gpg.decryptMessage(content.get_payload()) |
paul@5 | 114 | |
paul@8 | 115 | # Log non-fatal errors. |
paul@5 | 116 | |
paul@8 | 117 | if gpg.errors: |
paul@8 | 118 | getLogger(__name__).warning(gpg.errors) |
paul@5 | 119 | |
paul@8 | 120 | # Handle the embedded message. |
paul@8 | 121 | |
paul@8 | 122 | self.handle_message_text(text) |
paul@5 | 123 | |
paul@8 | 124 | # Otherwise, reject the unverified message. |
paul@5 | 125 | |
paul@8 | 126 | except MoinMessageError: |
paul@8 | 127 | writeHeaders(request, "text/plain", getMetadata(self.page), "403 Forbidden") |
paul@8 | 128 | request.write("The message could not be decrypted.") |
paul@5 | 129 | |
paul@5 | 130 | def handle_signed_message(self, message): |
paul@5 | 131 | |
paul@5 | 132 | "Handle the given signed 'message'." |
paul@5 | 133 | |
paul@5 | 134 | request = self.request |
paul@1 | 135 | |
paul@5 | 136 | # NOTE: RFC 3156 states that signed messages should employ a detached |
paul@5 | 137 | # NOTE: signature but then shows "BEGIN PGP MESSAGE" for signatures |
paul@5 | 138 | # NOTE: instead of "BEGIN PGP SIGNATURE". |
paul@5 | 139 | # NOTE: The "micalg" parameter is currently not supported. |
paul@5 | 140 | |
paul@5 | 141 | try: |
paul@5 | 142 | content, signature = message.get_payload() |
paul@5 | 143 | except ValueError: |
paul@5 | 144 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@5 | 145 | request.write("There must be a content part and a signature for signed uploads.") |
paul@5 | 146 | return |
paul@5 | 147 | |
paul@5 | 148 | # Verify the message format. |
paul@5 | 149 | |
paul@5 | 150 | if signature.get_content_type() != "application/pgp-signature": |
paul@5 | 151 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@5 | 152 | request.write("Signature data must be provided in the second part as application/pgp-signature.") |
paul@5 | 153 | return |
paul@5 | 154 | |
paul@5 | 155 | homedir = self.get_homedir() |
paul@5 | 156 | if not homedir: |
paul@5 | 157 | return |
paul@5 | 158 | |
paul@8 | 159 | gpg = GPG(homedir) |
paul@3 | 160 | |
paul@8 | 161 | # Verify the message. |
paul@8 | 162 | |
paul@5 | 163 | try: |
paul@11 | 164 | fingerprint, identity = gpg.verifyMessage(signature.get_payload(), content.as_string()) |
paul@11 | 165 | |
paul@11 | 166 | # Map the fingerprint to a Wiki user. |
paul@11 | 167 | |
paul@11 | 168 | old_user = None |
paul@11 | 169 | request = self.request |
paul@5 | 170 | |
paul@11 | 171 | try: |
paul@11 | 172 | if fingerprint: |
paul@11 | 173 | gpg_users = getWikiDict( |
paul@11 | 174 | getattr(request.cfg, "moinmessage_gpg_users_page", "MoinMessageUserDict"), |
paul@11 | 175 | request |
paul@11 | 176 | ) |
paul@11 | 177 | |
paul@11 | 178 | # With a user mapping and a fingerprint corresponding to a known |
paul@11 | 179 | # user, temporarily switch user in order to make the edit. |
paul@5 | 180 | |
paul@11 | 181 | if gpg_users and gpg_users.has_key(fingerprint): |
paul@11 | 182 | old_user = request.user |
paul@11 | 183 | request.user = User(request, auth_method="gpg", auth_username=gpg_users[fingerprint]) |
paul@11 | 184 | |
paul@11 | 185 | # Log non-fatal errors. |
paul@11 | 186 | |
paul@11 | 187 | if gpg.errors: |
paul@11 | 188 | getLogger(__name__).warning(gpg.errors) |
paul@5 | 189 | |
paul@11 | 190 | # Handle the embedded message. |
paul@11 | 191 | |
paul@11 | 192 | self.handle_message_content(content) |
paul@3 | 193 | |
paul@11 | 194 | # Restore any user identity. |
paul@11 | 195 | |
paul@11 | 196 | finally: |
paul@11 | 197 | if old_user: |
paul@11 | 198 | request.user = old_user |
paul@5 | 199 | |
paul@8 | 200 | # Otherwise, reject the unverified message. |
paul@5 | 201 | |
paul@8 | 202 | except MoinMessageError: |
paul@8 | 203 | writeHeaders(request, "text/plain", getMetadata(self.page), "403 Forbidden") |
paul@8 | 204 | request.write("The message could not be verified.") |
paul@5 | 205 | |
paul@15 | 206 | def handle_message_content(self, content): |
paul@5 | 207 | |
paul@15 | 208 | "Handle the given message 'content'." |
paul@3 | 209 | |
paul@1 | 210 | request = self.request |
paul@0 | 211 | |
paul@15 | 212 | # Interpret the content as one or more updates. |
paul@0 | 213 | |
paul@15 | 214 | message = Message() |
paul@15 | 215 | message.handle_message(content) |
paul@0 | 216 | |
paul@20 | 217 | # Test any date against the page or message store. |
paul@20 | 218 | |
paul@20 | 219 | if message.date: |
paul@20 | 220 | store_date = time.gmtime(self.store.mtime()) |
paul@20 | 221 | page_date = time.gmtime(wikiutil.version2timestamp(self.page.mtime_usecs())) |
paul@20 | 222 | last_date = max(store_date, page_date) |
paul@20 | 223 | |
paul@20 | 224 | # Reject messages older than the page date. |
paul@20 | 225 | |
paul@20 | 226 | if message.date < last_date: |
paul@20 | 227 | writeHeaders(request, "text/plain", getMetadata(self.page), "403 Forbidden") |
paul@20 | 228 | request.write("The message is too old: %s versus %s." % (message.date, last_date)) |
paul@20 | 229 | return |
paul@20 | 230 | |
paul@20 | 231 | # Reject messages without dates if so configured. |
paul@20 | 232 | |
paul@20 | 233 | elif getattr(request.cfg, "moinmessage_reject_messages_without_dates", True): |
paul@20 | 234 | writeHeaders(request, "text/plain", getMetadata(self.page), "403 Forbidden") |
paul@20 | 235 | request.write("The message has no date information.") |
paul@20 | 236 | return |
paul@20 | 237 | |
paul@20 | 238 | # Handle each update. |
paul@20 | 239 | |
paul@15 | 240 | for update in message.updates: |
paul@15 | 241 | |
paul@15 | 242 | # Handle a single part. |
paul@0 | 243 | |
paul@21 | 244 | if not is_collection(update): |
paul@16 | 245 | self.handle_message_parts([update], update) |
paul@0 | 246 | |
paul@15 | 247 | # Or a collection of alternative representations for a single |
paul@15 | 248 | # update. |
paul@0 | 249 | |
paul@15 | 250 | else: |
paul@16 | 251 | self.handle_message_parts(update.get_payload(), update) |
paul@0 | 252 | |
paul@0 | 253 | # Default output. |
paul@0 | 254 | |
paul@0 | 255 | writeHeaders(request, "text/plain", getMetadata(self.page), "204 No Content") |
paul@0 | 256 | |
paul@16 | 257 | def handle_message_parts(self, parts, update): |
paul@0 | 258 | |
paul@0 | 259 | """ |
paul@16 | 260 | Handle the given message 'parts', using the original 'update' to |
paul@16 | 261 | determine whether the content is to replace or update page content, or |
paul@16 | 262 | whether it will be placed in a message store. |
paul@0 | 263 | """ |
paul@0 | 264 | |
paul@16 | 265 | # Handle the different update actions. |
paul@16 | 266 | # Update a message store for the page. |
paul@16 | 267 | |
paul@16 | 268 | if to_store(update): |
paul@20 | 269 | self.store.append(update.as_string()) |
paul@0 | 270 | |
paul@16 | 271 | # Update the page. |
paul@16 | 272 | |
paul@16 | 273 | else: |
paul@16 | 274 | # NOTE: Should either choose preferred content types or somehow retain them |
paul@16 | 275 | # NOTE: all but present one at a time. |
paul@16 | 276 | |
paul@16 | 277 | body = [] |
paul@16 | 278 | replace = to_replace(update) |
paul@0 | 279 | |
paul@16 | 280 | for part in parts: |
paul@16 | 281 | mimetype = part.get_content_type() |
paul@16 | 282 | encoding = part.get_content_charset() |
paul@16 | 283 | if mimetype == "text/moin": |
paul@16 | 284 | body.append(part.get_payload()) |
paul@16 | 285 | if replace: |
paul@16 | 286 | break |
paul@0 | 287 | |
paul@16 | 288 | if not replace: |
paul@16 | 289 | body.append(self.page.get_raw_body()) |
paul@0 | 290 | |
paul@16 | 291 | page_editor = PageEditor(self.request, self.pagename) |
paul@16 | 292 | page_editor.saveText("\n\n".join(body), 0) |
paul@0 | 293 | |
paul@16 | 294 | # Refresh the page. |
paul@11 | 295 | |
paul@16 | 296 | self.page = Page(self.request, self.pagename) |
paul@11 | 297 | |
paul@5 | 298 | def get_homedir(self): |
paul@5 | 299 | |
paul@5 | 300 | "Locate the GPG home directory." |
paul@5 | 301 | |
paul@11 | 302 | homedir = getattr(self.request.cfg, "moinmessage_gpg_homedir") |
paul@5 | 303 | if not homedir: |
paul@5 | 304 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@5 | 305 | request.write("Encoded data cannot currently be understood. Please notify the site administrator.") |
paul@5 | 306 | return homedir |
paul@5 | 307 | |
paul@0 | 308 | def to_replace(message): |
paul@0 | 309 | return message.get("Update-Action") == "replace" |
paul@0 | 310 | |
paul@16 | 311 | def to_store(message): |
paul@16 | 312 | return message.get("Update-Action") == "store" |
paul@16 | 313 | |
paul@0 | 314 | # Action function. |
paul@0 | 315 | |
paul@0 | 316 | def execute(pagename, request): |
paul@12 | 317 | PostMessage(pagename, request).do_action() # instead of render |
paul@0 | 318 | |
paul@0 | 319 | # vim: tabstop=4 expandtab shiftwidth=4 |