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