[22] | 1 | #!@PYTHON@ |
---|
| 2 | # Copyright (C) 2002 |
---|
| 3 | # |
---|
| 4 | # This file is part of the email2trac utils |
---|
| 5 | # |
---|
| 6 | # This program is free software; you can redistribute it and/or modify it |
---|
| 7 | # under the terms of the GNU General Public License as published by the |
---|
| 8 | # Free Software Foundation; either version 2, or (at your option) any |
---|
| 9 | # later version. |
---|
| 10 | # |
---|
| 11 | # This program is distributed in the hope that it will be useful, |
---|
| 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 14 | # GNU General Public License for more details. |
---|
| 15 | # |
---|
| 16 | # You should have received a copy of the GNU General Public License |
---|
| 17 | # along with this program; if not, write to the Free Software |
---|
| 18 | # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA |
---|
| 19 | # |
---|
[80] | 20 | # For vi/emacs or other use tabstop=4 (vi: set ts=4) |
---|
| 21 | # |
---|
[22] | 22 | """ |
---|
[54] | 23 | email2trac.py -- Email tickets to Trac. |
---|
[22] | 24 | |
---|
| 25 | A simple MTA filter to create Trac tickets from inbound emails. |
---|
| 26 | |
---|
| 27 | Copyright 2005, Daniel Lundin <daniel@edgewall.com> |
---|
| 28 | Copyright 2005, Edgewall Software |
---|
| 29 | |
---|
[282] | 30 | Authors: |
---|
| 31 | Bas van der Vlies <basv@sara.nl> |
---|
| 32 | Walter de Jong <walter@sara.nl> |
---|
[22] | 33 | |
---|
| 34 | The scripts reads emails from stdin and inserts directly into a Trac database. |
---|
| 35 | |
---|
| 36 | How to use |
---|
| 37 | ---------- |
---|
[282] | 38 | * See https://subtrac.sara.nl/oss/email2trac/ |
---|
| 39 | |
---|
[22] | 40 | * Create an config file: |
---|
[282] | 41 | [DEFAULT] # REQUIRED |
---|
| 42 | project : /data/trac/test # REQUIRED |
---|
| 43 | debug : 1 # OPTIONAL, if set print some DEBUG info |
---|
[297] | 44 | trac_version : 0.10 # OPTIONAL, default is 0.11 |
---|
[22] | 45 | |
---|
[282] | 46 | [jouvin] # OPTIONAL project declaration, if set both fields necessary |
---|
| 47 | project : /data/trac/jouvin # use -p|--project jouvin. |
---|
[22] | 48 | |
---|
| 49 | * default config file is : /etc/email2trac.conf |
---|
| 50 | |
---|
| 51 | * Commandline opions: |
---|
[205] | 52 | -h,--help |
---|
| 53 | -f,--file <configuration file> |
---|
| 54 | -n,--dry-run |
---|
| 55 | -p, --project <project name> |
---|
| 56 | -t, --ticket_prefix <name> |
---|
[22] | 57 | |
---|
| 58 | SVN Info: |
---|
| 59 | $Id: email2trac.py.in 344 2010-03-30 08:32:50Z bas $ |
---|
| 60 | """ |
---|
| 61 | import os |
---|
| 62 | import sys |
---|
| 63 | import string |
---|
| 64 | import getopt |
---|
| 65 | import stat |
---|
| 66 | import time |
---|
| 67 | import email |
---|
[136] | 68 | import email.Iterators |
---|
| 69 | import email.Header |
---|
[22] | 70 | import re |
---|
| 71 | import urllib |
---|
| 72 | import unicodedata |
---|
| 73 | from stat import * |
---|
| 74 | import mimetypes |
---|
[96] | 75 | import traceback |
---|
[22] | 76 | |
---|
[190] | 77 | |
---|
| 78 | # Will fail where unavailable, e.g. Windows |
---|
| 79 | # |
---|
| 80 | try: |
---|
| 81 | import syslog |
---|
| 82 | SYSLOG_AVAILABLE = True |
---|
| 83 | except ImportError: |
---|
| 84 | SYSLOG_AVAILABLE = False |
---|
| 85 | |
---|
[182] | 86 | from datetime import tzinfo, timedelta, datetime |
---|
[199] | 87 | from trac import config as trac_config |
---|
[91] | 88 | |
---|
[96] | 89 | # Some global variables |
---|
| 90 | # |
---|
[276] | 91 | trac_default_version = '0.11' |
---|
[96] | 92 | m = None |
---|
[22] | 93 | |
---|
[182] | 94 | # A UTC class needed for trac version 0.11, added by |
---|
| 95 | # tbaschak at ktc dot mb dot ca |
---|
| 96 | # |
---|
| 97 | class UTC(tzinfo): |
---|
| 98 | """UTC""" |
---|
| 99 | ZERO = timedelta(0) |
---|
| 100 | HOUR = timedelta(hours=1) |
---|
| 101 | |
---|
| 102 | def utcoffset(self, dt): |
---|
| 103 | return self.ZERO |
---|
| 104 | |
---|
| 105 | def tzname(self, dt): |
---|
| 106 | return "UTC" |
---|
| 107 | |
---|
| 108 | def dst(self, dt): |
---|
| 109 | return self.ZERO |
---|
| 110 | |
---|
| 111 | |
---|
[22] | 112 | class TicketEmailParser(object): |
---|
| 113 | env = None |
---|
| 114 | comment = '> ' |
---|
| 115 | |
---|
[206] | 116 | def __init__(self, env, parameters, version): |
---|
[22] | 117 | self.env = env |
---|
| 118 | |
---|
| 119 | # Database connection |
---|
| 120 | # |
---|
| 121 | self.db = None |
---|
| 122 | |
---|
[206] | 123 | # Save parameters |
---|
| 124 | # |
---|
| 125 | self.parameters = parameters |
---|
| 126 | |
---|
[72] | 127 | # Some useful mail constants |
---|
| 128 | # |
---|
[287] | 129 | self.email_name = None |
---|
[72] | 130 | self.email_addr = None |
---|
[183] | 131 | self.email_from = None |
---|
[288] | 132 | self.author = None |
---|
[287] | 133 | self.id = None |
---|
[294] | 134 | |
---|
| 135 | self.STRIP_CONTENT_TYPES = list() |
---|
[72] | 136 | |
---|
[22] | 137 | self.VERSION = version |
---|
[206] | 138 | self.DRY_RUN = parameters['dry_run'] |
---|
[317] | 139 | self.VERBOSE = parameters['verbose'] |
---|
[204] | 140 | |
---|
[172] | 141 | self.get_config = self.env.config.get |
---|
[22] | 142 | |
---|
| 143 | if parameters.has_key('umask'): |
---|
| 144 | os.umask(int(parameters['umask'], 8)) |
---|
| 145 | |
---|
| 146 | if parameters.has_key('debug'): |
---|
| 147 | self.DEBUG = int(parameters['debug']) |
---|
| 148 | else: |
---|
| 149 | self.DEBUG = 0 |
---|
| 150 | |
---|
| 151 | if parameters.has_key('mailto_link'): |
---|
| 152 | self.MAILTO = int(parameters['mailto_link']) |
---|
[74] | 153 | if parameters.has_key('mailto_cc'): |
---|
| 154 | self.MAILTO_CC = parameters['mailto_cc'] |
---|
| 155 | else: |
---|
| 156 | self.MAILTO_CC = '' |
---|
[22] | 157 | else: |
---|
| 158 | self.MAILTO = 0 |
---|
| 159 | |
---|
| 160 | if parameters.has_key('spam_level'): |
---|
| 161 | self.SPAM_LEVEL = int(parameters['spam_level']) |
---|
| 162 | else: |
---|
| 163 | self.SPAM_LEVEL = 0 |
---|
| 164 | |
---|
[207] | 165 | if parameters.has_key('spam_header'): |
---|
| 166 | self.SPAM_HEADER = parameters['spam_header'] |
---|
| 167 | else: |
---|
| 168 | self.SPAM_HEADER = 'X-Spam-Score' |
---|
| 169 | |
---|
[191] | 170 | if parameters.has_key('email_quote'): |
---|
| 171 | self.EMAIL_QUOTE = str(parameters['email_quote']) |
---|
| 172 | else: |
---|
| 173 | self.EMAIL_QUOTE = '> ' |
---|
[22] | 174 | |
---|
| 175 | if parameters.has_key('email_header'): |
---|
| 176 | self.EMAIL_HEADER = int(parameters['email_header']) |
---|
| 177 | else: |
---|
| 178 | self.EMAIL_HEADER = 0 |
---|
| 179 | |
---|
[42] | 180 | if parameters.has_key('alternate_notify_template'): |
---|
| 181 | self.notify_template = str(parameters['alternate_notify_template']) |
---|
| 182 | else: |
---|
| 183 | self.notify_template = None |
---|
[22] | 184 | |
---|
[222] | 185 | if parameters.has_key('alternate_notify_template_update'): |
---|
| 186 | self.notify_template_update = str(parameters['alternate_notify_template_update']) |
---|
| 187 | else: |
---|
| 188 | self.notify_template_update = None |
---|
| 189 | |
---|
[43] | 190 | if parameters.has_key('reply_all'): |
---|
| 191 | self.REPLY_ALL = int(parameters['reply_all']) |
---|
| 192 | else: |
---|
| 193 | self.REPLY_ALL = 0 |
---|
[42] | 194 | |
---|
[74] | 195 | if parameters.has_key('ticket_update'): |
---|
| 196 | self.TICKET_UPDATE = int(parameters['ticket_update']) |
---|
| 197 | else: |
---|
| 198 | self.TICKET_UPDATE = 0 |
---|
[43] | 199 | |
---|
[118] | 200 | if parameters.has_key('drop_spam'): |
---|
| 201 | self.DROP_SPAM = int(parameters['drop_spam']) |
---|
| 202 | else: |
---|
| 203 | self.DROP_SPAM = 0 |
---|
[74] | 204 | |
---|
[134] | 205 | if parameters.has_key('verbatim_format'): |
---|
| 206 | self.VERBATIM_FORMAT = int(parameters['verbatim_format']) |
---|
| 207 | else: |
---|
| 208 | self.VERBATIM_FORMAT = 1 |
---|
[118] | 209 | |
---|
[231] | 210 | if parameters.has_key('reflow'): |
---|
[256] | 211 | self.REFLOW = int(parameters['reflow']) |
---|
[231] | 212 | else: |
---|
| 213 | self.REFLOW = 1 |
---|
| 214 | |
---|
[278] | 215 | if parameters.has_key('drop_alternative_html_version'): |
---|
| 216 | self.DROP_ALTERNATIVE_HTML_VERSION = int(parameters['drop_alternative_html_version']) |
---|
| 217 | else: |
---|
| 218 | self.DROP_ALTERNATIVE_HTML_VERSION = 0 |
---|
| 219 | |
---|
[136] | 220 | if parameters.has_key('strip_signature'): |
---|
| 221 | self.STRIP_SIGNATURE = int(parameters['strip_signature']) |
---|
| 222 | else: |
---|
| 223 | self.STRIP_SIGNATURE = 0 |
---|
[134] | 224 | |
---|
[191] | 225 | if parameters.has_key('strip_quotes'): |
---|
| 226 | self.STRIP_QUOTES = int(parameters['strip_quotes']) |
---|
| 227 | else: |
---|
| 228 | self.STRIP_QUOTES = 0 |
---|
| 229 | |
---|
[309] | 230 | self.properties = dict() |
---|
| 231 | if parameters.has_key('inline_properties'): |
---|
| 232 | self.INLINE_PROPERTIES = int(parameters['inline_properties']) |
---|
| 233 | else: |
---|
| 234 | self.INLINE_PROPERTIES = 0 |
---|
| 235 | |
---|
[148] | 236 | if parameters.has_key('use_textwrap'): |
---|
| 237 | self.USE_TEXTWRAP = int(parameters['use_textwrap']) |
---|
| 238 | else: |
---|
| 239 | self.USE_TEXTWRAP = 0 |
---|
| 240 | |
---|
[238] | 241 | if parameters.has_key('binhex'): |
---|
[294] | 242 | self.STRIP_CONTENT_TYPES.append('application/mac-binhex40') |
---|
[238] | 243 | |
---|
| 244 | if parameters.has_key('applesingle'): |
---|
[294] | 245 | self.STRIP_CONTENT_TYPES.append('application/applefile') |
---|
[238] | 246 | |
---|
| 247 | if parameters.has_key('appledouble'): |
---|
[294] | 248 | self.STRIP_CONTENT_TYPES.append('application/applefile') |
---|
[238] | 249 | |
---|
[294] | 250 | if parameters.has_key('strip_content_types'): |
---|
| 251 | items = parameters['strip_content_types'].split(',') |
---|
| 252 | for item in items: |
---|
| 253 | self.STRIP_CONTENT_TYPES.append(item.strip()) |
---|
| 254 | |
---|
[257] | 255 | self.WORKFLOW = None |
---|
| 256 | if parameters.has_key('workflow'): |
---|
| 257 | self.WORKFLOW = parameters['workflow'] |
---|
| 258 | |
---|
[173] | 259 | # Use OS independend functions |
---|
| 260 | # |
---|
| 261 | self.TMPDIR = os.path.normcase('/tmp') |
---|
| 262 | if parameters.has_key('tmpdir'): |
---|
| 263 | self.TMPDIR = os.path.normcase(str(parameters['tmpdir'])) |
---|
| 264 | |
---|
[194] | 265 | if parameters.has_key('ignore_trac_user_settings'): |
---|
| 266 | self.IGNORE_TRAC_USER_SETTINGS = int(parameters['ignore_trac_user_settings']) |
---|
| 267 | else: |
---|
| 268 | self.IGNORE_TRAC_USER_SETTINGS = 0 |
---|
[191] | 269 | |
---|
[320] | 270 | if parameters.has_key('email_triggers_workflow'): |
---|
| 271 | self.EMAIL_TRIGGERS_WORKFLOW = int(parameters['email_triggers_workflow']) |
---|
| 272 | else: |
---|
| 273 | self.EMAIL_TRIGGERS_WORKFLOW = 1 |
---|
| 274 | |
---|
[297] | 275 | if parameters.has_key('subject_field_separator'): |
---|
| 276 | self.SUBJECT_FIELD_SEPARATOR = parameters['subject_field_separator'].strip() |
---|
| 277 | else: |
---|
| 278 | self.SUBJECT_FIELD_SEPARATOR = '&' |
---|
| 279 | |
---|
[305] | 280 | self.trac_smtp_from = self.get_config('notification', 'smtp_from') |
---|
| 281 | |
---|
[341] | 282 | ########## Email Header Functions ########################################################### |
---|
[339] | 283 | |
---|
[22] | 284 | def spam(self, message): |
---|
[191] | 285 | """ |
---|
| 286 | # X-Spam-Score: *** (3.255) BAYES_50,DNS_FROM_AHBL_RHSBL,HTML_ |
---|
| 287 | # Note if Spam_level then '*' are included |
---|
| 288 | """ |
---|
[194] | 289 | spam = False |
---|
[207] | 290 | if message.has_key(self.SPAM_HEADER): |
---|
| 291 | spam_l = string.split(message[self.SPAM_HEADER]) |
---|
[22] | 292 | |
---|
[207] | 293 | try: |
---|
| 294 | number = spam_l[0].count('*') |
---|
| 295 | except IndexError, detail: |
---|
| 296 | number = 0 |
---|
| 297 | |
---|
[22] | 298 | if number >= self.SPAM_LEVEL: |
---|
[194] | 299 | spam = True |
---|
| 300 | |
---|
[191] | 301 | # treat virus mails as spam |
---|
| 302 | # |
---|
| 303 | elif message.has_key('X-Virus-found'): |
---|
[194] | 304 | spam = True |
---|
| 305 | |
---|
| 306 | # How to handle SPAM messages |
---|
| 307 | # |
---|
| 308 | if self.DROP_SPAM and spam: |
---|
| 309 | if self.DEBUG > 2 : |
---|
| 310 | print 'This message is a SPAM. Automatic ticket insertion refused (SPAM level > %d' % self.SPAM_LEVEL |
---|
| 311 | |
---|
[204] | 312 | return 'drop' |
---|
[194] | 313 | |
---|
| 314 | elif spam: |
---|
| 315 | |
---|
[204] | 316 | return 'Spam' |
---|
[67] | 317 | |
---|
[194] | 318 | else: |
---|
[22] | 319 | |
---|
[204] | 320 | return False |
---|
[191] | 321 | |
---|
[221] | 322 | def email_header_acl(self, keyword, header_field, default): |
---|
[206] | 323 | """ |
---|
[221] | 324 | This function wil check if the email address is allowed or denied |
---|
| 325 | to send mail to the ticket list |
---|
| 326 | """ |
---|
[206] | 327 | try: |
---|
[221] | 328 | mail_addresses = self.parameters[keyword] |
---|
| 329 | |
---|
| 330 | # Check if we have an empty string |
---|
| 331 | # |
---|
| 332 | if not mail_addresses: |
---|
| 333 | return default |
---|
| 334 | |
---|
[206] | 335 | except KeyError, detail: |
---|
[221] | 336 | if self.DEBUG > 2 : |
---|
[250] | 337 | print 'TD: %s not defined, all messages are allowed.' %(keyword) |
---|
[206] | 338 | |
---|
[221] | 339 | return default |
---|
[206] | 340 | |
---|
[221] | 341 | mail_addresses = string.split(mail_addresses, ',') |
---|
| 342 | |
---|
| 343 | for entry in mail_addresses: |
---|
[209] | 344 | entry = entry.strip() |
---|
[221] | 345 | TO_RE = re.compile(entry, re.VERBOSE|re.IGNORECASE) |
---|
| 346 | result = TO_RE.search(header_field) |
---|
[208] | 347 | if result: |
---|
| 348 | return True |
---|
[149] | 349 | |
---|
[208] | 350 | return False |
---|
| 351 | |
---|
[22] | 352 | def email_header_txt(self, m): |
---|
[72] | 353 | """ |
---|
| 354 | Display To and CC addresses in description field |
---|
| 355 | """ |
---|
[288] | 356 | s = '' |
---|
[334] | 357 | |
---|
[213] | 358 | if m['To'] and len(m['To']) > 0: |
---|
[288] | 359 | s = "'''To:''' %s\r\n" %(m['To']) |
---|
[22] | 360 | if m['Cc'] and len(m['Cc']) > 0: |
---|
[288] | 361 | s = "%s'''Cc:''' %s\r\n" % (s, m['Cc']) |
---|
[22] | 362 | |
---|
[288] | 363 | return self.email_to_unicode(s) |
---|
[22] | 364 | |
---|
[138] | 365 | |
---|
[194] | 366 | def get_sender_info(self, message): |
---|
[45] | 367 | """ |
---|
[72] | 368 | Get the default author name and email address from the message |
---|
[226] | 369 | """ |
---|
[43] | 370 | |
---|
[226] | 371 | self.email_to = self.email_to_unicode(message['to']) |
---|
| 372 | self.to_name, self.to_email_addr = email.Utils.parseaddr (self.email_to) |
---|
| 373 | |
---|
[194] | 374 | self.email_from = self.email_to_unicode(message['from']) |
---|
[287] | 375 | self.email_name, self.email_addr = email.Utils.parseaddr(self.email_from) |
---|
[142] | 376 | |
---|
[304] | 377 | ## Trac can not handle author's name that contains spaces |
---|
| 378 | # and forbid the ticket email address as author field |
---|
[194] | 379 | |
---|
[305] | 380 | if self.email_addr == self.trac_smtp_from: |
---|
[304] | 381 | self.author = "email2trac" |
---|
| 382 | else: |
---|
| 383 | self.author = self.email_addr |
---|
| 384 | |
---|
[194] | 385 | if self.IGNORE_TRAC_USER_SETTINGS: |
---|
| 386 | return |
---|
| 387 | |
---|
| 388 | # Is this a registered user, use email address as search key: |
---|
| 389 | # result: |
---|
| 390 | # u : login name |
---|
| 391 | # n : Name that the user has set in the settings tab |
---|
| 392 | # e : email address that the user has set in the settings tab |
---|
[45] | 393 | # |
---|
[194] | 394 | users = [ (u,n,e) for (u, n, e) in self.env.get_known_users(self.db) |
---|
[250] | 395 | if e and (e.lower() == self.email_addr.lower()) ] |
---|
[43] | 396 | |
---|
[45] | 397 | if len(users) == 1: |
---|
[194] | 398 | self.email_from = users[0][0] |
---|
[250] | 399 | self.author = users[0][0] |
---|
[45] | 400 | |
---|
[72] | 401 | def set_reply_fields(self, ticket, message): |
---|
| 402 | """ |
---|
| 403 | Set all the right fields for a new ticket |
---|
| 404 | """ |
---|
[299] | 405 | if self.DEBUG: |
---|
| 406 | print 'TD: set_reply_fields' |
---|
[72] | 407 | |
---|
[270] | 408 | ## Only use name or email adress |
---|
| 409 | #ticket['reporter'] = self.email_from |
---|
| 410 | ticket['reporter'] = self.author |
---|
| 411 | |
---|
| 412 | |
---|
[45] | 413 | # Put all CC-addresses in ticket CC field |
---|
[43] | 414 | # |
---|
| 415 | if self.REPLY_ALL: |
---|
| 416 | |
---|
[299] | 417 | email_cc = '' |
---|
| 418 | |
---|
| 419 | cc_addrs = email.Utils.getaddresses( message.get_all('cc', []) ) |
---|
| 420 | |
---|
| 421 | if not cc_addrs: |
---|
[105] | 422 | return |
---|
[43] | 423 | |
---|
[299] | 424 | ## Build a list of forbidden CC addresses |
---|
| 425 | # |
---|
[300] | 426 | #to_addrs = email.Utils.getaddresses( message.get_all('to', []) ) |
---|
| 427 | #to_list = list() |
---|
| 428 | #for n,e in to_addrs: |
---|
| 429 | # to_list.append(e) |
---|
[299] | 430 | |
---|
[43] | 431 | # Remove reporter email address if notification is |
---|
| 432 | # on |
---|
| 433 | # |
---|
| 434 | if self.notification: |
---|
| 435 | try: |
---|
[299] | 436 | cc_addrs.remove((self.author, self.email_addr)) |
---|
[43] | 437 | except ValueError, detail: |
---|
| 438 | pass |
---|
| 439 | |
---|
[299] | 440 | for name,addr in cc_addrs: |
---|
| 441 | |
---|
| 442 | ## Prevent mail loop |
---|
| 443 | # |
---|
[300] | 444 | #if addr in to_list: |
---|
[304] | 445 | |
---|
| 446 | if addr == self.trac_smtp_from: |
---|
[299] | 447 | if self.DEBUG: |
---|
| 448 | print "Skipping %s mail address for CC-field" %(addr) |
---|
| 449 | continue |
---|
[43] | 450 | |
---|
[299] | 451 | if email_cc: |
---|
| 452 | email_cc = '%s, %s' %(email_cc, addr) |
---|
| 453 | else: |
---|
| 454 | email_cc = addr |
---|
[96] | 455 | |
---|
[299] | 456 | if email_cc: |
---|
| 457 | if self.DEBUG: |
---|
| 458 | print 'TD: set_reply_fields: %s' %email_cc |
---|
| 459 | |
---|
| 460 | ticket['cc'] = self.email_to_unicode(email_cc) |
---|
| 461 | |
---|
[339] | 462 | |
---|
| 463 | ########## DEBUG functions ########################################################### |
---|
| 464 | |
---|
[310] | 465 | def debug_body(self, message_body, tempfile=False): |
---|
| 466 | if tempfile: |
---|
| 467 | import tempfile |
---|
| 468 | body_file = tempfile.mktemp('.email2trac') |
---|
| 469 | else: |
---|
| 470 | body_file = os.path.join(self.TMPDIR, 'body.txt') |
---|
| 471 | |
---|
[331] | 472 | if self.DRY_RUN: |
---|
| 473 | print 'DRY-RUN: not saving body to %s' %(body_file) |
---|
| 474 | return |
---|
| 475 | |
---|
| 476 | print 'TD: writing body to %s' %(body_file) |
---|
| 477 | fx = open(body_file, 'wb') |
---|
[310] | 478 | if not message_body: |
---|
[331] | 479 | message_body = '(None)' |
---|
[310] | 480 | |
---|
| 481 | message_body = message_body.encode('utf-8') |
---|
| 482 | #message_body = unicode(message_body, 'iso-8859-15') |
---|
| 483 | |
---|
| 484 | fx.write(message_body) |
---|
| 485 | fx.close() |
---|
| 486 | try: |
---|
| 487 | os.chmod(body_file,S_IRWXU|S_IRWXG|S_IRWXO) |
---|
| 488 | except OSError: |
---|
| 489 | pass |
---|
| 490 | |
---|
| 491 | def debug_attachments(self, message_parts): |
---|
[317] | 492 | """ |
---|
| 493 | """ |
---|
| 494 | if self.VERBOSE: |
---|
| 495 | print "VB: debug_attachments" |
---|
| 496 | |
---|
[310] | 497 | n = 0 |
---|
[331] | 498 | for item in message_parts: |
---|
[310] | 499 | # Skip inline text parts |
---|
[331] | 500 | if not isinstance(item, tuple): |
---|
[310] | 501 | continue |
---|
| 502 | |
---|
[331] | 503 | (original, filename, part) = item |
---|
[310] | 504 | |
---|
| 505 | n = n + 1 |
---|
| 506 | print 'TD: part%d: Content-Type: %s' % (n, part.get_content_type()) |
---|
| 507 | print 'TD: part%d: filename: %s' % (n, part.get_filename()) |
---|
| 508 | |
---|
[331] | 509 | part_file = os.path.join(self.TMPDIR, part.get_filename()) |
---|
[310] | 510 | print 'TD: writing part%d (%s)' % (n,part_file) |
---|
[331] | 511 | |
---|
| 512 | if self.DRY_RUN: |
---|
| 513 | print 'DRY_RUN: NOT saving attachments' |
---|
| 514 | continue |
---|
| 515 | |
---|
[310] | 516 | fx = open(part_file, 'wb') |
---|
| 517 | text = part.get_payload(decode=1) |
---|
[331] | 518 | |
---|
[310] | 519 | if not text: |
---|
| 520 | text = '(None)' |
---|
[331] | 521 | |
---|
[310] | 522 | fx.write(text) |
---|
| 523 | fx.close() |
---|
[331] | 524 | |
---|
[310] | 525 | try: |
---|
| 526 | os.chmod(part_file,S_IRWXU|S_IRWXG|S_IRWXO) |
---|
| 527 | except OSError: |
---|
| 528 | pass |
---|
| 529 | |
---|
[96] | 530 | def save_email_for_debug(self, message, tempfile=False): |
---|
[309] | 531 | |
---|
[96] | 532 | if tempfile: |
---|
| 533 | import tempfile |
---|
| 534 | msg_file = tempfile.mktemp('.email2trac') |
---|
| 535 | else: |
---|
[173] | 536 | #msg_file = '/var/tmp/msg.txt' |
---|
| 537 | msg_file = os.path.join(self.TMPDIR, 'msg.txt') |
---|
| 538 | |
---|
[331] | 539 | if self.DRY_RUN: |
---|
| 540 | print 'DRY_RUN: NOT saving email message to %s' %(msg_file) |
---|
| 541 | else: |
---|
| 542 | print 'TD: saving email to %s' %(msg_file) |
---|
[44] | 543 | |
---|
[331] | 544 | fx = open(msg_file, 'wb') |
---|
| 545 | fx.write('%s' % message) |
---|
| 546 | fx.close() |
---|
| 547 | |
---|
| 548 | try: |
---|
| 549 | os.chmod(msg_file,S_IRWXU|S_IRWXG|S_IRWXO) |
---|
| 550 | except OSError: |
---|
| 551 | pass |
---|
| 552 | |
---|
[309] | 553 | message_parts = self.get_message_parts(message) |
---|
| 554 | message_parts = self.unique_attachment_names(message_parts) |
---|
| 555 | body_text = self.body_text(message_parts) |
---|
| 556 | self.debug_body(body_text, True) |
---|
| 557 | self.debug_attachments(message_parts) |
---|
| 558 | |
---|
[339] | 559 | ########## Conversion functions ########################################################### |
---|
| 560 | |
---|
[341] | 561 | def email_to_unicode(self, message_str): |
---|
| 562 | """ |
---|
| 563 | Email has 7 bit ASCII code, convert it to unicode with the charset |
---|
| 564 | that is encoded in 7-bit ASCII code and encode it as utf-8 so Trac |
---|
| 565 | understands it. |
---|
| 566 | """ |
---|
| 567 | if self.VERBOSE: |
---|
| 568 | print "VB: email_to_unicode" |
---|
| 569 | |
---|
| 570 | results = email.Header.decode_header(message_str) |
---|
| 571 | |
---|
| 572 | s = None |
---|
| 573 | for text,format in results: |
---|
| 574 | if format: |
---|
| 575 | try: |
---|
| 576 | temp = unicode(text, format) |
---|
| 577 | except UnicodeError, detail: |
---|
| 578 | # This always works |
---|
| 579 | # |
---|
| 580 | temp = unicode(text, 'iso-8859-15') |
---|
| 581 | except LookupError, detail: |
---|
| 582 | #text = 'ERROR: Could not find charset: %s, please install' %format |
---|
| 583 | #temp = unicode(text, 'iso-8859-15') |
---|
| 584 | temp = message_str |
---|
| 585 | |
---|
| 586 | else: |
---|
| 587 | temp = string.strip(text) |
---|
| 588 | temp = unicode(text, 'iso-8859-15') |
---|
| 589 | |
---|
| 590 | if s: |
---|
| 591 | s = '%s %s' %(s, temp) |
---|
| 592 | else: |
---|
| 593 | s = '%s' %temp |
---|
| 594 | |
---|
| 595 | #s = s.encode('utf-8') |
---|
| 596 | return s |
---|
| 597 | |
---|
[288] | 598 | def str_to_dict(self, s): |
---|
[164] | 599 | """ |
---|
[288] | 600 | Transfrom a string of the form [<key>=<value>]+ to dict[<key>] = <value> |
---|
[164] | 601 | """ |
---|
| 602 | |
---|
[297] | 603 | fields = string.split(s, self.SUBJECT_FIELD_SEPARATOR) |
---|
[262] | 604 | |
---|
[164] | 605 | result = dict() |
---|
| 606 | for field in fields: |
---|
| 607 | try: |
---|
[262] | 608 | index, value = string.split(field, '=') |
---|
[169] | 609 | |
---|
| 610 | # We can not change the description of a ticket via the subject |
---|
| 611 | # line. The description is the body of the email |
---|
| 612 | # |
---|
| 613 | if index.lower() in ['description']: |
---|
| 614 | continue |
---|
| 615 | |
---|
[164] | 616 | if value: |
---|
[165] | 617 | result[index.lower()] = value |
---|
[169] | 618 | |
---|
[164] | 619 | except ValueError: |
---|
| 620 | pass |
---|
[165] | 621 | return result |
---|
[167] | 622 | |
---|
[339] | 623 | ########## TRAC ticket functions ########################################################### |
---|
| 624 | |
---|
[202] | 625 | def update_ticket_fields(self, ticket, user_dict, use_default=None): |
---|
| 626 | """ |
---|
| 627 | This will update the ticket fields. It will check if the |
---|
| 628 | given fields are known and if the right values are specified |
---|
| 629 | It will only update the ticket field value: |
---|
[169] | 630 | - If the field is known |
---|
[202] | 631 | - If the value supplied is valid for the ticket field. |
---|
| 632 | If not then there are two options: |
---|
| 633 | 1) Skip the value (use_default=None) |
---|
| 634 | 2) Set default value for field (use_default=1) |
---|
[169] | 635 | """ |
---|
[334] | 636 | if self.VERBOSE: |
---|
| 637 | print "VB: update_ticket_fields" |
---|
[169] | 638 | |
---|
| 639 | # Build a system dictionary from the ticket fields |
---|
| 640 | # with field as index and option as value |
---|
| 641 | # |
---|
| 642 | sys_dict = dict() |
---|
| 643 | for field in ticket.fields: |
---|
[167] | 644 | try: |
---|
[169] | 645 | sys_dict[field['name']] = field['options'] |
---|
| 646 | |
---|
[167] | 647 | except KeyError: |
---|
[169] | 648 | sys_dict[field['name']] = None |
---|
[167] | 649 | pass |
---|
[169] | 650 | |
---|
[301] | 651 | ## Check user supplied fields an compare them with the |
---|
[169] | 652 | # system one's |
---|
| 653 | # |
---|
| 654 | for field,value in user_dict.items(): |
---|
[202] | 655 | if self.DEBUG >= 10: |
---|
| 656 | print 'user_field\t %s = %s' %(field,value) |
---|
[169] | 657 | |
---|
[301] | 658 | ## To prevent mail loop |
---|
| 659 | # |
---|
| 660 | if field == 'cc': |
---|
| 661 | |
---|
| 662 | cc_list = user_dict['cc'].split(',') |
---|
| 663 | |
---|
[304] | 664 | if self.trac_smtp_from in cc_list: |
---|
[301] | 665 | if self.DEBUG > 10: |
---|
[304] | 666 | print 'TD: MAIL LOOP: %s is not allowed as CC address' %(self.trac_smtp_from) |
---|
| 667 | cc_list.remove(self.trac_smtp_from) |
---|
[301] | 668 | |
---|
| 669 | value = ','.join(cc_list) |
---|
| 670 | |
---|
| 671 | |
---|
[169] | 672 | if sys_dict.has_key(field): |
---|
| 673 | |
---|
| 674 | # Check if value is an allowed system option, if TypeError then |
---|
| 675 | # every value is allowed |
---|
| 676 | # |
---|
| 677 | try: |
---|
| 678 | if value in sys_dict[field]: |
---|
| 679 | ticket[field] = value |
---|
[202] | 680 | else: |
---|
| 681 | # Must we set a default if value is not allowed |
---|
| 682 | # |
---|
| 683 | if use_default: |
---|
| 684 | value = self.get_config('ticket', 'default_%s' %(field) ) |
---|
| 685 | ticket[field] = value |
---|
[169] | 686 | |
---|
| 687 | except TypeError: |
---|
| 688 | ticket[field] = value |
---|
[202] | 689 | |
---|
| 690 | if self.DEBUG >= 10: |
---|
| 691 | print 'ticket_field\t %s = %s' %(field, ticket[field]) |
---|
[169] | 692 | |
---|
[260] | 693 | def ticket_update(self, m, id, spam): |
---|
[78] | 694 | """ |
---|
[79] | 695 | If the current email is a reply to an existing ticket, this function |
---|
| 696 | will append the contents of this email to that ticket, instead of |
---|
| 697 | creating a new one. |
---|
[78] | 698 | """ |
---|
[334] | 699 | if self.VERBOSE: |
---|
| 700 | print "VB: ticket_update: %s" %id |
---|
[202] | 701 | |
---|
[164] | 702 | # Must we update ticket fields |
---|
| 703 | # |
---|
[220] | 704 | update_fields = dict() |
---|
[165] | 705 | try: |
---|
[260] | 706 | id, keywords = string.split(id, '?') |
---|
[262] | 707 | |
---|
| 708 | # Skip the last ':' character |
---|
| 709 | # |
---|
| 710 | keywords = keywords[:-1] |
---|
[220] | 711 | update_fields = self.str_to_dict(keywords) |
---|
[165] | 712 | |
---|
| 713 | # Strip '#' |
---|
| 714 | # |
---|
[260] | 715 | self.id = int(id[1:]) |
---|
[165] | 716 | |
---|
[260] | 717 | except ValueError: |
---|
[165] | 718 | # Strip '#' and ':' |
---|
| 719 | # |
---|
[260] | 720 | self.id = int(id[1:-1]) |
---|
[164] | 721 | |
---|
[71] | 722 | |
---|
[194] | 723 | # When is the change committed |
---|
| 724 | # |
---|
| 725 | if self.VERSION == 0.11: |
---|
| 726 | utc = UTC() |
---|
| 727 | when = datetime.now(utc) |
---|
| 728 | else: |
---|
| 729 | when = int(time.time()) |
---|
[77] | 730 | |
---|
[172] | 731 | try: |
---|
[253] | 732 | tkt = Ticket(self.env, self.id, self.db) |
---|
[172] | 733 | except util.TracError, detail: |
---|
[253] | 734 | # Not a valid ticket |
---|
| 735 | self.id = None |
---|
[172] | 736 | return False |
---|
[126] | 737 | |
---|
[288] | 738 | # How many changes has this ticket |
---|
| 739 | cnum = len(tkt.get_changelog()) |
---|
| 740 | |
---|
| 741 | |
---|
[220] | 742 | # reopen the ticket if it is was closed |
---|
| 743 | # We must use the ticket workflow framework |
---|
| 744 | # |
---|
[320] | 745 | if tkt['status'] in ['closed'] and self.EMAIL_TRIGGERS_WORKFLOW: |
---|
[220] | 746 | |
---|
[257] | 747 | #print controller.actions['reopen'] |
---|
| 748 | # |
---|
| 749 | # As reference |
---|
| 750 | # req = Mock(href=Href('/'), abs_href=Href('http://www.example.com/'), authname='anonymous', perm=MockPerm(), args={}) |
---|
| 751 | # |
---|
| 752 | #a = controller.render_ticket_action_control(req, tkt, 'reopen') |
---|
| 753 | #print 'controller : ', a |
---|
| 754 | # |
---|
| 755 | #b = controller.get_all_status() |
---|
| 756 | #print 'get all status: ', b |
---|
| 757 | # |
---|
| 758 | #b = controller.get_ticket_changes(req, tkt, 'reopen') |
---|
| 759 | #print 'get_ticket_changes :', b |
---|
| 760 | |
---|
[288] | 761 | if self.WORKFLOW and (self.VERSION in [0.11]) : |
---|
[257] | 762 | from trac.ticket.default_workflow import ConfigurableTicketWorkflow |
---|
| 763 | from trac.test import Mock, MockPerm |
---|
| 764 | |
---|
| 765 | req = Mock(authname='anonymous', perm=MockPerm(), args={}) |
---|
| 766 | |
---|
| 767 | controller = ConfigurableTicketWorkflow(self.env) |
---|
| 768 | fields = controller.get_ticket_changes(req, tkt, self.WORKFLOW) |
---|
| 769 | |
---|
| 770 | if self.DEBUG: |
---|
| 771 | print 'TD: Workflow ticket update fields: ', fields |
---|
| 772 | |
---|
| 773 | for key in fields.keys(): |
---|
| 774 | tkt[key] = fields[key] |
---|
| 775 | |
---|
| 776 | else: |
---|
| 777 | tkt['status'] = 'reopened' |
---|
| 778 | tkt['resolution'] = '' |
---|
| 779 | |
---|
[309] | 780 | # Must we update some ticket fields properties via subjectline |
---|
[172] | 781 | # |
---|
[220] | 782 | if update_fields: |
---|
| 783 | self.update_ticket_fields(tkt, update_fields) |
---|
[166] | 784 | |
---|
[236] | 785 | message_parts = self.get_message_parts(m) |
---|
[253] | 786 | message_parts = self.unique_attachment_names(message_parts) |
---|
[210] | 787 | |
---|
[309] | 788 | # Must we update some ticket fields properties via body_text |
---|
| 789 | # |
---|
| 790 | if self.properties: |
---|
| 791 | self.update_ticket_fields(tkt, self.properties) |
---|
| 792 | |
---|
[177] | 793 | if self.EMAIL_HEADER: |
---|
[236] | 794 | message_parts.insert(0, self.email_header_txt(m)) |
---|
[76] | 795 | |
---|
[236] | 796 | body_text = self.body_text(message_parts) |
---|
| 797 | |
---|
[309] | 798 | if body_text.strip() or update_fields or self.properties: |
---|
[250] | 799 | if self.DRY_RUN: |
---|
[288] | 800 | print 'DRY_RUN: tkt.save_changes(self.author, body_text, ticket_change_number) ', self.author, cnum |
---|
[250] | 801 | else: |
---|
[288] | 802 | tkt.save_changes(self.author, body_text, when, None, str(cnum)) |
---|
| 803 | |
---|
[219] | 804 | |
---|
[129] | 805 | if self.VERSION == 0.9: |
---|
[340] | 806 | error_with_attachments = self.attach_attachments(message_parts, True) |
---|
[129] | 807 | else: |
---|
[340] | 808 | error_with_attachments = self.attach_attachments(message_parts) |
---|
[76] | 809 | |
---|
[204] | 810 | if self.notification and not spam: |
---|
[253] | 811 | self.notify(tkt, False, when) |
---|
[72] | 812 | |
---|
[71] | 813 | return True |
---|
| 814 | |
---|
[202] | 815 | def set_ticket_fields(self, ticket): |
---|
[77] | 816 | """ |
---|
[202] | 817 | set the ticket fields to value specified |
---|
| 818 | - /etc/email2trac.conf with <prefix>_<field> |
---|
| 819 | - trac default values, trac.ini |
---|
| 820 | """ |
---|
| 821 | user_dict = dict() |
---|
| 822 | |
---|
| 823 | for field in ticket.fields: |
---|
| 824 | |
---|
| 825 | name = field['name'] |
---|
| 826 | |
---|
[335] | 827 | ## skip some fields like resolution |
---|
[215] | 828 | # |
---|
| 829 | if name in [ 'resolution' ]: |
---|
| 830 | continue |
---|
| 831 | |
---|
[335] | 832 | ## default trac value |
---|
[202] | 833 | # |
---|
[233] | 834 | if not field.get('custom'): |
---|
| 835 | value = self.get_config('ticket', 'default_%s' %(name) ) |
---|
| 836 | else: |
---|
| 837 | value = field.get('value') |
---|
| 838 | options = field.get('options') |
---|
[335] | 839 | if value and options and (value not in options): |
---|
[233] | 840 | value = options[int(value)] |
---|
| 841 | |
---|
[202] | 842 | if self.DEBUG > 10: |
---|
| 843 | print 'trac.ini name %s = %s' %(name, value) |
---|
| 844 | |
---|
[335] | 845 | ## email2trac.conf settings |
---|
| 846 | # |
---|
[206] | 847 | prefix = self.parameters['ticket_prefix'] |
---|
[202] | 848 | try: |
---|
[206] | 849 | value = self.parameters['%s_%s' %(prefix, name)] |
---|
[202] | 850 | if self.DEBUG > 10: |
---|
| 851 | print 'email2trac.conf %s = %s ' %(name, value) |
---|
| 852 | |
---|
| 853 | except KeyError, detail: |
---|
| 854 | pass |
---|
| 855 | |
---|
| 856 | if self.DEBUG: |
---|
| 857 | print 'user_dict[%s] = %s' %(name, value) |
---|
| 858 | |
---|
| 859 | user_dict[name] = value |
---|
| 860 | |
---|
| 861 | self.update_ticket_fields(ticket, user_dict, use_default=1) |
---|
| 862 | |
---|
[335] | 863 | ## Set status ticket |
---|
| 864 | # |
---|
[202] | 865 | ticket['status'] = 'new' |
---|
| 866 | |
---|
| 867 | |
---|
| 868 | |
---|
[262] | 869 | def new_ticket(self, msg, subject, spam, set_fields = None): |
---|
[202] | 870 | """ |
---|
[77] | 871 | Create a new ticket |
---|
| 872 | """ |
---|
[250] | 873 | if self.DEBUG: |
---|
| 874 | print "TD: new_ticket" |
---|
| 875 | |
---|
[41] | 876 | tkt = Ticket(self.env) |
---|
[326] | 877 | |
---|
| 878 | self.set_reply_fields(tkt, msg) |
---|
| 879 | |
---|
[202] | 880 | self.set_ticket_fields(tkt) |
---|
| 881 | |
---|
| 882 | # Old style setting for component, will be removed |
---|
| 883 | # |
---|
[204] | 884 | if spam: |
---|
| 885 | tkt['component'] = 'Spam' |
---|
| 886 | |
---|
[206] | 887 | elif self.parameters.has_key('component'): |
---|
| 888 | tkt['component'] = self.parameters['component'] |
---|
[201] | 889 | |
---|
[22] | 890 | if not msg['Subject']: |
---|
[151] | 891 | tkt['summary'] = u'(No subject)' |
---|
[22] | 892 | else: |
---|
[264] | 893 | tkt['summary'] = subject |
---|
[22] | 894 | |
---|
| 895 | |
---|
[262] | 896 | if set_fields: |
---|
| 897 | rest, keywords = string.split(set_fields, '?') |
---|
| 898 | |
---|
| 899 | if keywords: |
---|
| 900 | update_fields = self.str_to_dict(keywords) |
---|
| 901 | self.update_ticket_fields(tkt, update_fields) |
---|
| 902 | |
---|
[45] | 903 | # produce e-mail like header |
---|
| 904 | # |
---|
[22] | 905 | head = '' |
---|
| 906 | if self.EMAIL_HEADER > 0: |
---|
| 907 | head = self.email_header_txt(msg) |
---|
[296] | 908 | |
---|
[236] | 909 | message_parts = self.get_message_parts(msg) |
---|
[309] | 910 | |
---|
| 911 | # Must we update some ticket fields properties via body_text |
---|
| 912 | # |
---|
| 913 | if self.properties: |
---|
| 914 | self.update_ticket_fields(tkt, self.properties) |
---|
| 915 | |
---|
[296] | 916 | if self.DEBUG: |
---|
| 917 | print 'TD: self.get_message_parts ', |
---|
| 918 | print message_parts |
---|
| 919 | |
---|
[236] | 920 | message_parts = self.unique_attachment_names(message_parts) |
---|
[296] | 921 | if self.DEBUG: |
---|
| 922 | print 'TD: self.unique_attachment_names', |
---|
| 923 | print message_parts |
---|
[236] | 924 | |
---|
| 925 | if self.EMAIL_HEADER > 0: |
---|
| 926 | message_parts.insert(0, self.email_header_txt(msg)) |
---|
| 927 | |
---|
| 928 | body_text = self.body_text(message_parts) |
---|
[45] | 929 | |
---|
[236] | 930 | tkt['description'] = body_text |
---|
[90] | 931 | |
---|
[182] | 932 | #when = int(time.time()) |
---|
[192] | 933 | # |
---|
[182] | 934 | utc = UTC() |
---|
| 935 | when = datetime.now(utc) |
---|
[45] | 936 | |
---|
[253] | 937 | if not self.DRY_RUN: |
---|
| 938 | self.id = tkt.insert() |
---|
[273] | 939 | |
---|
[90] | 940 | changed = False |
---|
| 941 | comment = '' |
---|
[77] | 942 | |
---|
[273] | 943 | # some routines in trac are dependend on ticket id |
---|
| 944 | # like alternate notify template |
---|
| 945 | # |
---|
| 946 | if self.notify_template: |
---|
[274] | 947 | tkt['id'] = self.id |
---|
[273] | 948 | changed = True |
---|
| 949 | |
---|
[295] | 950 | ## Rewrite the description if we have mailto enabled |
---|
[45] | 951 | # |
---|
[72] | 952 | if self.MAILTO: |
---|
[100] | 953 | changed = True |
---|
[142] | 954 | comment = u'\nadded mailto line\n' |
---|
[343] | 955 | mailto = self.html_mailto_link( m['Subject']) |
---|
[253] | 956 | |
---|
[213] | 957 | tkt['description'] = u'%s\r\n%s%s\r\n' \ |
---|
[142] | 958 | %(head, mailto, body_text) |
---|
[295] | 959 | |
---|
| 960 | ## Save the attachments to the ticket |
---|
| 961 | # |
---|
[340] | 962 | error_with_attachments = self.attach_attachments(message_parts) |
---|
[295] | 963 | |
---|
[319] | 964 | if error_with_attachments: |
---|
| 965 | changed = True |
---|
| 966 | comment = '%s\n%s\n' %(comment, error_with_attachments) |
---|
[45] | 967 | |
---|
[90] | 968 | if changed: |
---|
[204] | 969 | if self.DRY_RUN: |
---|
[344] | 970 | print 'DRY_RUN: tkt.save_changes(%s, comment) real reporter = %s' %( tkt['reporter'], self.author) |
---|
[201] | 971 | else: |
---|
[344] | 972 | tkt.save_changes(tkt['reporter'], comment) |
---|
[201] | 973 | #print tkt.get_changelog(self.db, when) |
---|
[90] | 974 | |
---|
[250] | 975 | if self.notification and not spam: |
---|
[253] | 976 | self.notify(tkt, True) |
---|
[45] | 977 | |
---|
[260] | 978 | |
---|
[342] | 979 | def attach_attachments(self, message_parts, update=False): |
---|
| 980 | ''' |
---|
| 981 | save any attachments as files in the ticket's directory |
---|
| 982 | ''' |
---|
| 983 | if self.VERBOSE: |
---|
| 984 | print "VB: attach_attachments()" |
---|
| 985 | |
---|
| 986 | if self.DRY_RUN: |
---|
| 987 | print "DRY_RUN: no attachments attached to tickets" |
---|
| 988 | return '' |
---|
| 989 | |
---|
| 990 | count = 0 |
---|
| 991 | |
---|
| 992 | # Get Maxium attachment size |
---|
| 993 | # |
---|
| 994 | max_size = int(self.get_config('attachment', 'max_size')) |
---|
| 995 | status = None |
---|
| 996 | |
---|
| 997 | for item in message_parts: |
---|
| 998 | # Skip body parts |
---|
| 999 | if not isinstance(item, tuple): |
---|
| 1000 | continue |
---|
| 1001 | |
---|
| 1002 | (original, filename, part) = item |
---|
| 1003 | # |
---|
| 1004 | # Must be tuneables HvB |
---|
| 1005 | # |
---|
| 1006 | path, fd = util.create_unique_file(os.path.join(self.TMPDIR, filename)) |
---|
| 1007 | text = part.get_payload(decode=1) |
---|
| 1008 | if not text: |
---|
| 1009 | text = '(None)' |
---|
| 1010 | fd.write(text) |
---|
| 1011 | fd.close() |
---|
| 1012 | |
---|
| 1013 | # get the file_size |
---|
| 1014 | # |
---|
| 1015 | stats = os.lstat(path) |
---|
| 1016 | file_size = stats[stat.ST_SIZE] |
---|
| 1017 | |
---|
| 1018 | # Check if the attachment size is allowed |
---|
| 1019 | # |
---|
| 1020 | if (max_size != -1) and (file_size > max_size): |
---|
| 1021 | status = '%s\nFile %s is larger then allowed attachment size (%d > %d)\n\n' \ |
---|
| 1022 | %(status, original, file_size, max_size) |
---|
| 1023 | |
---|
| 1024 | os.unlink(path) |
---|
| 1025 | continue |
---|
| 1026 | else: |
---|
| 1027 | count = count + 1 |
---|
| 1028 | |
---|
| 1029 | # Insert the attachment |
---|
| 1030 | # |
---|
| 1031 | fd = open(path, 'rb') |
---|
| 1032 | att = attachment.Attachment(self.env, 'ticket', self.id) |
---|
| 1033 | |
---|
| 1034 | # This will break the ticket_update system, the body_text is vaporized |
---|
| 1035 | # ;-( |
---|
| 1036 | # |
---|
| 1037 | if not update: |
---|
| 1038 | att.author = self.author |
---|
| 1039 | att.description = self.email_to_unicode('Added by email2trac') |
---|
| 1040 | |
---|
| 1041 | att.insert(filename, fd, file_size) |
---|
| 1042 | |
---|
| 1043 | #except util.TracError, detail: |
---|
| 1044 | # print detail |
---|
| 1045 | |
---|
| 1046 | # Remove the created temporary filename |
---|
| 1047 | # |
---|
| 1048 | fd.close() |
---|
| 1049 | os.unlink(path) |
---|
| 1050 | |
---|
| 1051 | ## return error |
---|
| 1052 | # |
---|
| 1053 | return status |
---|
| 1054 | |
---|
[339] | 1055 | ########## Fullblog functions ########################################################### |
---|
| 1056 | |
---|
[260] | 1057 | def blog(self, id): |
---|
| 1058 | """ |
---|
| 1059 | The blog create/update function |
---|
| 1060 | """ |
---|
| 1061 | # import the modules |
---|
| 1062 | # |
---|
| 1063 | from tracfullblog.core import FullBlogCore |
---|
[312] | 1064 | from tracfullblog.model import BlogPost, BlogComment |
---|
| 1065 | from trac.test import Mock, MockPerm |
---|
[260] | 1066 | |
---|
| 1067 | # instantiate blog core |
---|
| 1068 | blog = FullBlogCore(self.env) |
---|
[312] | 1069 | req = Mock(authname='anonymous', perm=MockPerm(), args={}) |
---|
| 1070 | |
---|
[260] | 1071 | if id: |
---|
| 1072 | |
---|
| 1073 | # update blog |
---|
| 1074 | # |
---|
[268] | 1075 | comment = BlogComment(self.env, id) |
---|
[260] | 1076 | comment.author = self.author |
---|
[312] | 1077 | |
---|
| 1078 | message_parts = self.get_message_parts(m) |
---|
| 1079 | comment.comment = self.body_text(message_parts) |
---|
| 1080 | |
---|
[260] | 1081 | blog.create_comment(req, comment) |
---|
| 1082 | |
---|
| 1083 | else: |
---|
| 1084 | # create blog |
---|
| 1085 | # |
---|
| 1086 | import time |
---|
| 1087 | post = BlogPost(self.env, 'blog_'+time.strftime("%Y%m%d%H%M%S", time.gmtime())) |
---|
| 1088 | |
---|
| 1089 | #post = BlogPost(self.env, blog._get_default_postname(self.env)) |
---|
| 1090 | |
---|
| 1091 | post.author = self.author |
---|
| 1092 | post.title = self.email_to_unicode(m['Subject']) |
---|
[312] | 1093 | |
---|
| 1094 | message_parts = self.get_message_parts(m) |
---|
| 1095 | post.body = self.body_text(message_parts) |
---|
[260] | 1096 | |
---|
| 1097 | blog.create_post(req, post, self.author, u'Created by email2trac', False) |
---|
| 1098 | |
---|
| 1099 | |
---|
[342] | 1100 | |
---|
| 1101 | ########## MAIN function ########################################################### |
---|
| 1102 | |
---|
[77] | 1103 | def parse(self, fp): |
---|
[96] | 1104 | global m |
---|
| 1105 | |
---|
[77] | 1106 | m = email.message_from_file(fp) |
---|
[239] | 1107 | |
---|
[77] | 1108 | if not m: |
---|
[221] | 1109 | if self.DEBUG: |
---|
[250] | 1110 | print "TD: This is not a valid email message format" |
---|
[77] | 1111 | return |
---|
[239] | 1112 | |
---|
| 1113 | # Work around lack of header folding in Python; see http://bugs.python.org/issue4696 |
---|
[316] | 1114 | try: |
---|
| 1115 | m.replace_header('Subject', m['Subject'].replace('\r', '').replace('\n', '')) |
---|
| 1116 | except AttributeError, detail: |
---|
| 1117 | pass |
---|
[239] | 1118 | |
---|
[77] | 1119 | if self.DEBUG > 1: # save the entire e-mail message text |
---|
[219] | 1120 | self.save_email_for_debug(m, True) |
---|
[77] | 1121 | |
---|
| 1122 | self.db = self.env.get_db_cnx() |
---|
[194] | 1123 | self.get_sender_info(m) |
---|
[152] | 1124 | |
---|
[221] | 1125 | if not self.email_header_acl('white_list', self.email_addr, True): |
---|
| 1126 | if self.DEBUG > 1 : |
---|
| 1127 | print 'Message rejected : %s not in white list' %(self.email_addr) |
---|
| 1128 | return False |
---|
[77] | 1129 | |
---|
[221] | 1130 | if self.email_header_acl('black_list', self.email_addr, False): |
---|
| 1131 | if self.DEBUG > 1 : |
---|
| 1132 | print 'Message rejected : %s in black list' %(self.email_addr) |
---|
| 1133 | return False |
---|
| 1134 | |
---|
[227] | 1135 | if not self.email_header_acl('recipient_list', self.to_email_addr, True): |
---|
[226] | 1136 | if self.DEBUG > 1 : |
---|
| 1137 | print 'Message rejected : %s not in recipient list' %(self.to_email_addr) |
---|
| 1138 | return False |
---|
| 1139 | |
---|
[204] | 1140 | # If drop the message |
---|
[194] | 1141 | # |
---|
[204] | 1142 | if self.spam(m) == 'drop': |
---|
[194] | 1143 | return False |
---|
| 1144 | |
---|
[204] | 1145 | elif self.spam(m) == 'spam': |
---|
| 1146 | spam_msg = True |
---|
| 1147 | else: |
---|
| 1148 | spam_msg = False |
---|
| 1149 | |
---|
[77] | 1150 | if self.get_config('notification', 'smtp_enabled') in ['true']: |
---|
| 1151 | self.notification = 1 |
---|
| 1152 | else: |
---|
| 1153 | self.notification = 0 |
---|
| 1154 | |
---|
[304] | 1155 | |
---|
[260] | 1156 | # Check if FullBlogPlugin is installed |
---|
[77] | 1157 | # |
---|
[260] | 1158 | blog_enabled = None |
---|
| 1159 | if self.get_config('components', 'tracfullblog.*') in ['enabled']: |
---|
| 1160 | blog_enabled = True |
---|
[329] | 1161 | |
---|
[260] | 1162 | if not m['Subject']: |
---|
[329] | 1163 | subject = 'No Subject' |
---|
[260] | 1164 | else: |
---|
| 1165 | subject = self.email_to_unicode(m['Subject']) |
---|
[77] | 1166 | |
---|
[260] | 1167 | # |
---|
| 1168 | # [hic] #1529: Re: LRZ |
---|
| 1169 | # [hic] #1529?owner=bas,priority=medium: Re: LRZ |
---|
| 1170 | # |
---|
| 1171 | TICKET_RE = re.compile(r""" |
---|
| 1172 | (?P<blog>blog:(?P<blog_id>\w*)) |
---|
[262] | 1173 | |(?P<new_fields>[#][?].*) |
---|
| 1174 | |(?P<reply>[#][\d]+:) |
---|
| 1175 | |(?P<reply_fields>[#][\d]+\?.*?:) |
---|
[260] | 1176 | """, re.VERBOSE) |
---|
[77] | 1177 | |
---|
[265] | 1178 | # Find out if this is a ticket or a blog |
---|
| 1179 | # |
---|
[260] | 1180 | result = TICKET_RE.search(subject) |
---|
| 1181 | |
---|
| 1182 | if result: |
---|
[309] | 1183 | if result.group('blog'): |
---|
| 1184 | if blog_enabled: |
---|
| 1185 | self.blog(result.group('blog_id')) |
---|
| 1186 | else: |
---|
| 1187 | if self.DEBUG: |
---|
| 1188 | print "Fullblog plugin is not installed" |
---|
| 1189 | return |
---|
[260] | 1190 | |
---|
| 1191 | # update ticket + fields |
---|
| 1192 | # |
---|
[262] | 1193 | if result.group('reply_fields') and self.TICKET_UPDATE: |
---|
| 1194 | self.ticket_update(m, result.group('reply_fields'), spam_msg) |
---|
[260] | 1195 | |
---|
| 1196 | # Update ticket |
---|
| 1197 | # |
---|
[262] | 1198 | elif result.group('reply') and self.TICKET_UPDATE: |
---|
| 1199 | self.ticket_update(m, result.group('reply'), spam_msg) |
---|
[260] | 1200 | |
---|
[262] | 1201 | # New ticket + fields |
---|
| 1202 | # |
---|
| 1203 | elif result.group('new_fields'): |
---|
| 1204 | self.new_ticket(m, subject[:result.start('new_fields')], spam_msg, result.group('new_fields')) |
---|
| 1205 | |
---|
[260] | 1206 | # Create ticket |
---|
| 1207 | # |
---|
| 1208 | else: |
---|
[262] | 1209 | self.new_ticket(m, subject, spam_msg) |
---|
[260] | 1210 | |
---|
[343] | 1211 | ########## BODY TEXT functions ########################################################### |
---|
| 1212 | |
---|
[136] | 1213 | def strip_signature(self, text): |
---|
| 1214 | """ |
---|
| 1215 | Strip signature from message, inspired by Mailman software |
---|
| 1216 | """ |
---|
| 1217 | body = [] |
---|
| 1218 | for line in text.splitlines(): |
---|
| 1219 | if line == '-- ': |
---|
| 1220 | break |
---|
| 1221 | body.append(line) |
---|
| 1222 | |
---|
| 1223 | return ('\n'.join(body)) |
---|
| 1224 | |
---|
[231] | 1225 | def reflow(self, text, delsp = 0): |
---|
| 1226 | """ |
---|
| 1227 | Reflow the message based on the format="flowed" specification (RFC 3676) |
---|
| 1228 | """ |
---|
| 1229 | flowedlines = [] |
---|
| 1230 | quotelevel = 0 |
---|
| 1231 | prevflowed = 0 |
---|
| 1232 | |
---|
| 1233 | for line in text.splitlines(): |
---|
| 1234 | from re import match |
---|
| 1235 | |
---|
| 1236 | # Figure out the quote level and the content of the current line |
---|
| 1237 | m = match('(>*)( ?)(.*)', line) |
---|
| 1238 | linequotelevel = len(m.group(1)) |
---|
| 1239 | line = m.group(3) |
---|
| 1240 | |
---|
| 1241 | # Determine whether this line is flowed |
---|
| 1242 | if line and line != '-- ' and line[-1] == ' ': |
---|
| 1243 | flowed = 1 |
---|
| 1244 | else: |
---|
| 1245 | flowed = 0 |
---|
| 1246 | |
---|
| 1247 | if flowed and delsp and line and line[-1] == ' ': |
---|
| 1248 | line = line[:-1] |
---|
| 1249 | |
---|
| 1250 | # If the previous line is flowed, append this line to it |
---|
| 1251 | if prevflowed and line != '-- ' and linequotelevel == quotelevel: |
---|
| 1252 | flowedlines[-1] += line |
---|
| 1253 | # Otherwise, start a new line |
---|
| 1254 | else: |
---|
| 1255 | flowedlines.append('>' * linequotelevel + line) |
---|
| 1256 | |
---|
| 1257 | prevflowed = flowed |
---|
| 1258 | |
---|
| 1259 | |
---|
| 1260 | return '\n'.join(flowedlines) |
---|
| 1261 | |
---|
[191] | 1262 | def strip_quotes(self, text): |
---|
[193] | 1263 | """ |
---|
| 1264 | Strip quotes from message by Nicolas Mendoza |
---|
| 1265 | """ |
---|
| 1266 | body = [] |
---|
| 1267 | for line in text.splitlines(): |
---|
| 1268 | if line.startswith(self.EMAIL_QUOTE): |
---|
| 1269 | continue |
---|
| 1270 | body.append(line) |
---|
[151] | 1271 | |
---|
[193] | 1272 | return ('\n'.join(body)) |
---|
[191] | 1273 | |
---|
[309] | 1274 | def inline_properties(self, text): |
---|
| 1275 | """ |
---|
| 1276 | Parse text if we use inline keywords to set ticket fields |
---|
| 1277 | """ |
---|
| 1278 | if self.DEBUG: |
---|
| 1279 | print 'TD: inline_properties function' |
---|
| 1280 | |
---|
| 1281 | properties = dict() |
---|
| 1282 | body = list() |
---|
| 1283 | |
---|
| 1284 | INLINE_EXP = re.compile('\s*[@]\s*([a-zA-Z]+)\s*:(.*)$') |
---|
| 1285 | |
---|
| 1286 | for line in text.splitlines(): |
---|
| 1287 | match = INLINE_EXP.match(line) |
---|
| 1288 | if match: |
---|
| 1289 | keyword, value = match.groups() |
---|
| 1290 | self.properties[keyword] = value.strip() |
---|
[311] | 1291 | if self.DEBUG: |
---|
| 1292 | print "TD: inline properties: %s : %s" %(keyword,value) |
---|
[309] | 1293 | else: |
---|
| 1294 | body.append(line) |
---|
| 1295 | |
---|
| 1296 | return '\n'.join(body) |
---|
| 1297 | |
---|
| 1298 | |
---|
[154] | 1299 | def wrap_text(self, text, replace_whitespace = False): |
---|
[151] | 1300 | """ |
---|
[191] | 1301 | Will break a lines longer then given length into several small |
---|
| 1302 | lines of size given length |
---|
[151] | 1303 | """ |
---|
| 1304 | import textwrap |
---|
[154] | 1305 | |
---|
[151] | 1306 | LINESEPARATOR = '\n' |
---|
[153] | 1307 | reformat = '' |
---|
[151] | 1308 | |
---|
[154] | 1309 | for s in text.split(LINESEPARATOR): |
---|
| 1310 | tmp = textwrap.fill(s,self.USE_TEXTWRAP) |
---|
| 1311 | if tmp: |
---|
| 1312 | reformat = '%s\n%s' %(reformat,tmp) |
---|
| 1313 | else: |
---|
| 1314 | reformat = '%s\n' %reformat |
---|
[153] | 1315 | |
---|
| 1316 | return reformat |
---|
| 1317 | |
---|
[154] | 1318 | # Python2.4 and higher |
---|
| 1319 | # |
---|
| 1320 | #return LINESEPARATOR.join(textwrap.fill(s,width) for s in str.split(LINESEPARATOR)) |
---|
| 1321 | # |
---|
| 1322 | |
---|
[343] | 1323 | ########## EMAIL attachements functions ########################################################### |
---|
| 1324 | |
---|
[340] | 1325 | def inline_part(self, part): |
---|
| 1326 | """ |
---|
| 1327 | """ |
---|
| 1328 | if self.VERBOSE: |
---|
| 1329 | print "VB: inline_part()" |
---|
[154] | 1330 | |
---|
[340] | 1331 | return part.get_param('inline', None, 'Content-Disposition') == '' or not part.has_key('Content-Disposition') |
---|
| 1332 | |
---|
[236] | 1333 | def get_message_parts(self, msg): |
---|
[45] | 1334 | """ |
---|
[236] | 1335 | parses the email message and returns a list of body parts and attachments |
---|
| 1336 | body parts are returned as strings, attachments are returned as tuples of (filename, Message object) |
---|
[45] | 1337 | """ |
---|
[317] | 1338 | if self.VERBOSE: |
---|
| 1339 | print "VB: get_message_parts()" |
---|
| 1340 | |
---|
[309] | 1341 | message_parts = list() |
---|
[294] | 1342 | |
---|
[278] | 1343 | ALTERNATIVE_MULTIPART = False |
---|
| 1344 | |
---|
[22] | 1345 | for part in msg.walk(): |
---|
[236] | 1346 | if self.DEBUG: |
---|
[278] | 1347 | print 'TD: Message part: Main-Type: %s' % part.get_content_maintype() |
---|
[236] | 1348 | print 'TD: Message part: Content-Type: %s' % part.get_content_type() |
---|
[278] | 1349 | |
---|
| 1350 | ## Check content type |
---|
[294] | 1351 | # |
---|
| 1352 | if part.get_content_type() in self.STRIP_CONTENT_TYPES: |
---|
[238] | 1353 | |
---|
[294] | 1354 | if self.DEBUG: |
---|
| 1355 | print "TD: A %s attachment named '%s' was skipped" %(part.get_content_type(), part.get_filename()) |
---|
[238] | 1356 | |
---|
| 1357 | continue |
---|
| 1358 | |
---|
[294] | 1359 | ## Catch some mulitpart execptions |
---|
| 1360 | # |
---|
| 1361 | if part.get_content_type() == 'multipart/alternative': |
---|
[278] | 1362 | ALTERNATIVE_MULTIPART = True |
---|
| 1363 | continue |
---|
| 1364 | |
---|
[294] | 1365 | ## Skip multipart containers |
---|
[278] | 1366 | # |
---|
[45] | 1367 | if part.get_content_maintype() == 'multipart': |
---|
[278] | 1368 | if self.DEBUG: |
---|
| 1369 | print "TD: Skipping multipart container" |
---|
[22] | 1370 | continue |
---|
[278] | 1371 | |
---|
[294] | 1372 | ## Check if this is an inline part. It's inline if there is co Cont-Disp header, or if there is one and it says "inline" |
---|
| 1373 | # |
---|
[236] | 1374 | inline = self.inline_part(part) |
---|
| 1375 | |
---|
[294] | 1376 | ## Drop HTML message |
---|
| 1377 | # |
---|
[278] | 1378 | if ALTERNATIVE_MULTIPART and self.DROP_ALTERNATIVE_HTML_VERSION: |
---|
| 1379 | if part.get_content_type() == 'text/html': |
---|
| 1380 | if self.DEBUG: |
---|
| 1381 | print "TD: Skipping alternative HTML message" |
---|
| 1382 | |
---|
| 1383 | ALTERNATIVE_MULTIPART = False |
---|
| 1384 | continue |
---|
| 1385 | |
---|
[294] | 1386 | ## Inline text parts are where the body is |
---|
| 1387 | # |
---|
[236] | 1388 | if part.get_content_type() == 'text/plain' and inline: |
---|
| 1389 | if self.DEBUG: |
---|
| 1390 | print 'TD: Inline body part' |
---|
| 1391 | |
---|
[45] | 1392 | # Try to decode, if fails then do not decode |
---|
| 1393 | # |
---|
[90] | 1394 | body_text = part.get_payload(decode=1) |
---|
[45] | 1395 | if not body_text: |
---|
[90] | 1396 | body_text = part.get_payload(decode=0) |
---|
[231] | 1397 | |
---|
[232] | 1398 | format = email.Utils.collapse_rfc2231_value(part.get_param('Format', 'fixed')).lower() |
---|
| 1399 | delsp = email.Utils.collapse_rfc2231_value(part.get_param('DelSp', 'no')).lower() |
---|
[231] | 1400 | |
---|
| 1401 | if self.REFLOW and not self.VERBATIM_FORMAT and format == 'flowed': |
---|
| 1402 | body_text = self.reflow(body_text, delsp == 'yes') |
---|
[154] | 1403 | |
---|
[136] | 1404 | if self.STRIP_SIGNATURE: |
---|
| 1405 | body_text = self.strip_signature(body_text) |
---|
[22] | 1406 | |
---|
[191] | 1407 | if self.STRIP_QUOTES: |
---|
| 1408 | body_text = self.strip_quotes(body_text) |
---|
| 1409 | |
---|
[309] | 1410 | if self.INLINE_PROPERTIES: |
---|
| 1411 | body_text = self.inline_properties(body_text) |
---|
| 1412 | |
---|
[148] | 1413 | if self.USE_TEXTWRAP: |
---|
[151] | 1414 | body_text = self.wrap_text(body_text) |
---|
[148] | 1415 | |
---|
[294] | 1416 | ## Get contents charset (iso-8859-15 if not defined in mail headers) |
---|
[45] | 1417 | # |
---|
[100] | 1418 | charset = part.get_content_charset() |
---|
[102] | 1419 | if not charset: |
---|
| 1420 | charset = 'iso-8859-15' |
---|
| 1421 | |
---|
[89] | 1422 | try: |
---|
[96] | 1423 | ubody_text = unicode(body_text, charset) |
---|
[100] | 1424 | |
---|
| 1425 | except UnicodeError, detail: |
---|
[96] | 1426 | ubody_text = unicode(body_text, 'iso-8859-15') |
---|
[89] | 1427 | |
---|
[100] | 1428 | except LookupError, detail: |
---|
[139] | 1429 | ubody_text = 'ERROR: Could not find charset: %s, please install' %(charset) |
---|
[100] | 1430 | |
---|
[236] | 1431 | if self.VERBATIM_FORMAT: |
---|
| 1432 | message_parts.append('{{{\r\n%s\r\n}}}' %ubody_text) |
---|
| 1433 | else: |
---|
| 1434 | message_parts.append('%s' %ubody_text) |
---|
| 1435 | else: |
---|
| 1436 | if self.DEBUG: |
---|
[315] | 1437 | try: |
---|
| 1438 | print 'TD: Filename: %s' % part.get_filename() |
---|
| 1439 | except UnicodeEncodeError, detail: |
---|
[331] | 1440 | print 'TD: Filename: Can not be printed due to non-ascii characters' |
---|
[22] | 1441 | |
---|
[317] | 1442 | ## Convert 7-bit filename to 8 bits value |
---|
| 1443 | # |
---|
| 1444 | filename = self.email_to_unicode(part.get_filename()) |
---|
| 1445 | message_parts.append((filename, part)) |
---|
[236] | 1446 | |
---|
| 1447 | return message_parts |
---|
| 1448 | |
---|
[253] | 1449 | def unique_attachment_names(self, message_parts): |
---|
[296] | 1450 | """ |
---|
| 1451 | """ |
---|
[236] | 1452 | renamed_parts = [] |
---|
| 1453 | attachment_names = set() |
---|
[296] | 1454 | |
---|
[331] | 1455 | for item in message_parts: |
---|
[236] | 1456 | |
---|
[296] | 1457 | ## If not an attachment, leave it alone |
---|
| 1458 | # |
---|
[331] | 1459 | if not isinstance(item, tuple): |
---|
| 1460 | renamed_parts.append(item) |
---|
[236] | 1461 | continue |
---|
| 1462 | |
---|
[331] | 1463 | (filename, part) = item |
---|
[295] | 1464 | |
---|
[296] | 1465 | ## If no filename, use a default one |
---|
| 1466 | # |
---|
| 1467 | if not filename: |
---|
[236] | 1468 | filename = 'untitled-part' |
---|
[22] | 1469 | |
---|
[242] | 1470 | # Guess the extension from the content type, use non strict mode |
---|
| 1471 | # some additional non-standard but commonly used MIME types |
---|
| 1472 | # are also recognized |
---|
| 1473 | # |
---|
| 1474 | ext = mimetypes.guess_extension(part.get_content_type(), False) |
---|
[236] | 1475 | if not ext: |
---|
| 1476 | ext = '.bin' |
---|
[22] | 1477 | |
---|
[236] | 1478 | filename = '%s%s' % (filename, ext) |
---|
[22] | 1479 | |
---|
[296] | 1480 | # We now use the attachment insert function |
---|
| 1481 | # |
---|
| 1482 | ## Discard relative paths in attachment names |
---|
| 1483 | # |
---|
| 1484 | #filename = filename.replace('\\', '/').replace(':', '/') |
---|
| 1485 | #filename = os.path.basename(filename) |
---|
| 1486 | # |
---|
[236] | 1487 | # We try to normalize the filename to utf-8 NFC if we can. |
---|
| 1488 | # Files uploaded from OS X might be in NFD. |
---|
| 1489 | # Check python version and then try it |
---|
| 1490 | # |
---|
[296] | 1491 | #if sys.version_info[0] > 2 or (sys.version_info[0] == 2 and sys.version_info[1] >= 3): |
---|
| 1492 | # try: |
---|
| 1493 | # filename = unicodedata.normalize('NFC', unicode(filename, 'utf-8')).encode('utf-8') |
---|
| 1494 | # except TypeError: |
---|
| 1495 | # pass |
---|
[100] | 1496 | |
---|
[236] | 1497 | # Make the filename unique for this ticket |
---|
| 1498 | num = 0 |
---|
| 1499 | unique_filename = filename |
---|
[296] | 1500 | dummy_filename, ext = os.path.splitext(filename) |
---|
[134] | 1501 | |
---|
[339] | 1502 | while (unique_filename in attachment_names) or self.attachment_exists(unique_filename): |
---|
[236] | 1503 | num += 1 |
---|
[296] | 1504 | unique_filename = "%s-%s%s" % (dummy_filename, num, ext) |
---|
[236] | 1505 | |
---|
| 1506 | if self.DEBUG: |
---|
[331] | 1507 | try: |
---|
| 1508 | print 'TD: Attachment with filename %s will be saved as %s' % (filename, unique_filename) |
---|
| 1509 | except UnicodeEncodeError, detail: |
---|
| 1510 | print 'Filename can not be printed due to non-ascii characters' |
---|
[100] | 1511 | |
---|
[236] | 1512 | attachment_names.add(unique_filename) |
---|
| 1513 | |
---|
| 1514 | renamed_parts.append((filename, unique_filename, part)) |
---|
[296] | 1515 | |
---|
[236] | 1516 | return renamed_parts |
---|
| 1517 | |
---|
| 1518 | |
---|
[253] | 1519 | def attachment_exists(self, filename): |
---|
[250] | 1520 | |
---|
| 1521 | if self.DEBUG: |
---|
[331] | 1522 | s = 'TD: attachment already exists: Ticket id : ' |
---|
| 1523 | try: |
---|
| 1524 | print "%s%s, Filename : %s" %(s, self.id, filename) |
---|
| 1525 | except UnicodeEncodeError, detail: |
---|
| 1526 | print "%s%s, Filename : Can not be printed due to non-ascii characters" %(s, self.id) |
---|
[250] | 1527 | |
---|
| 1528 | # We have no valid ticket id |
---|
| 1529 | # |
---|
[253] | 1530 | if not self.id: |
---|
[236] | 1531 | return False |
---|
[250] | 1532 | |
---|
[236] | 1533 | try: |
---|
[253] | 1534 | att = attachment.Attachment(self.env, 'ticket', self.id, filename) |
---|
[236] | 1535 | return True |
---|
[250] | 1536 | except attachment.ResourceNotFound: |
---|
[236] | 1537 | return False |
---|
[343] | 1538 | |
---|
| 1539 | ########## TRAC Ticket Text ########################################################### |
---|
[236] | 1540 | |
---|
| 1541 | def body_text(self, message_parts): |
---|
| 1542 | body_text = [] |
---|
| 1543 | |
---|
| 1544 | for part in message_parts: |
---|
| 1545 | # Plain text part, append it |
---|
| 1546 | if not isinstance(part, tuple): |
---|
| 1547 | body_text.extend(part.strip().splitlines()) |
---|
| 1548 | body_text.append("") |
---|
| 1549 | continue |
---|
| 1550 | |
---|
| 1551 | (original, filename, part) = part |
---|
| 1552 | inline = self.inline_part(part) |
---|
| 1553 | |
---|
| 1554 | if part.get_content_maintype() == 'image' and inline: |
---|
| 1555 | body_text.append('[[Image(%s)]]' % filename) |
---|
| 1556 | body_text.append("") |
---|
| 1557 | else: |
---|
| 1558 | body_text.append('[attachment:"%s"]' % filename) |
---|
| 1559 | body_text.append("") |
---|
| 1560 | |
---|
| 1561 | body_text = '\r\n'.join(body_text) |
---|
| 1562 | return body_text |
---|
| 1563 | |
---|
[343] | 1564 | def html_mailto_link(self, subject): |
---|
| 1565 | """ |
---|
| 1566 | This function returns a HTML mailto tag with the ticket id and author email address |
---|
| 1567 | """ |
---|
| 1568 | if not self.author: |
---|
| 1569 | author = self.email_addr |
---|
| 1570 | else: |
---|
| 1571 | author = self.author |
---|
| 1572 | |
---|
| 1573 | # use urllib to escape the chars |
---|
| 1574 | # |
---|
| 1575 | s = 'mailto:%s?Subject=%s&Cc=%s' %( |
---|
| 1576 | urllib.quote(self.email_addr), |
---|
| 1577 | urllib.quote('Re: #%s: %s' %(self.id, subject)), |
---|
| 1578 | urllib.quote(self.MAILTO_CC) |
---|
| 1579 | ) |
---|
| 1580 | |
---|
| 1581 | s = '\r\n{{{\r\n#!html\r\n<a\r\n href="%s">Reply to: %s\r\n</a>\r\n}}}\r\n' %(s, author) |
---|
| 1582 | return s |
---|
| 1583 | |
---|
| 1584 | ########## TRAC notify section ########################################################### |
---|
| 1585 | |
---|
[253] | 1586 | def notify(self, tkt, new=True, modtime=0): |
---|
[79] | 1587 | """ |
---|
| 1588 | A wrapper for the TRAC notify function. So we can use templates |
---|
| 1589 | """ |
---|
[250] | 1590 | if self.DRY_RUN: |
---|
[344] | 1591 | print 'DRY_RUN: self.notify(tkt, True) reporter = %s' %tkt['reporter'] |
---|
[250] | 1592 | return |
---|
[41] | 1593 | try: |
---|
| 1594 | # create false {abs_}href properties, to trick Notify() |
---|
| 1595 | # |
---|
[193] | 1596 | if not self.VERSION == 0.11: |
---|
[192] | 1597 | self.env.abs_href = Href(self.get_config('project', 'url')) |
---|
| 1598 | self.env.href = Href(self.get_config('project', 'url')) |
---|
[22] | 1599 | |
---|
[41] | 1600 | tn = TicketNotifyEmail(self.env) |
---|
[213] | 1601 | |
---|
[42] | 1602 | if self.notify_template: |
---|
[222] | 1603 | |
---|
[221] | 1604 | if self.VERSION == 0.11: |
---|
[222] | 1605 | |
---|
[221] | 1606 | from trac.web.chrome import Chrome |
---|
[222] | 1607 | |
---|
| 1608 | if self.notify_template_update and not new: |
---|
| 1609 | tn.template_name = self.notify_template_update |
---|
| 1610 | else: |
---|
| 1611 | tn.template_name = self.notify_template |
---|
| 1612 | |
---|
[221] | 1613 | tn.template = Chrome(tn.env).load_template(tn.template_name, method='text') |
---|
| 1614 | |
---|
| 1615 | else: |
---|
[222] | 1616 | |
---|
[221] | 1617 | tn.template_name = self.notify_template; |
---|
[42] | 1618 | |
---|
[77] | 1619 | tn.notify(tkt, new, modtime) |
---|
[41] | 1620 | |
---|
| 1621 | except Exception, e: |
---|
[253] | 1622 | print 'TD: Failure sending notification on creation of ticket #%s: %s' %(self.id, e) |
---|
[41] | 1623 | |
---|
[22] | 1624 | |
---|
[74] | 1625 | |
---|
[343] | 1626 | ########## Parse Config File ########################################################### |
---|
[22] | 1627 | |
---|
| 1628 | def ReadConfig(file, name): |
---|
| 1629 | """ |
---|
| 1630 | Parse the config file |
---|
| 1631 | """ |
---|
| 1632 | if not os.path.isfile(file): |
---|
[79] | 1633 | print 'File %s does not exist' %file |
---|
[22] | 1634 | sys.exit(1) |
---|
| 1635 | |
---|
[199] | 1636 | config = trac_config.Configuration(file) |
---|
[22] | 1637 | |
---|
| 1638 | # Use given project name else use defaults |
---|
| 1639 | # |
---|
| 1640 | if name: |
---|
[199] | 1641 | sections = config.sections() |
---|
| 1642 | if not name in sections: |
---|
[79] | 1643 | print "Not a valid project name: %s" %name |
---|
[199] | 1644 | print "Valid names: %s" %sections |
---|
[22] | 1645 | sys.exit(1) |
---|
| 1646 | |
---|
| 1647 | project = dict() |
---|
[199] | 1648 | for option, value in config.options(name): |
---|
| 1649 | project[option] = value |
---|
[22] | 1650 | |
---|
| 1651 | else: |
---|
[270] | 1652 | # use some trac internals to get the defaults |
---|
[217] | 1653 | # |
---|
| 1654 | project = config.parser.defaults() |
---|
[22] | 1655 | |
---|
| 1656 | return project |
---|
| 1657 | |
---|
[87] | 1658 | |
---|
[22] | 1659 | if __name__ == '__main__': |
---|
| 1660 | # Default config file |
---|
| 1661 | # |
---|
[24] | 1662 | configfile = '@email2trac_conf@' |
---|
[22] | 1663 | project = '' |
---|
| 1664 | component = '' |
---|
[202] | 1665 | ticket_prefix = 'default' |
---|
[204] | 1666 | dry_run = None |
---|
[317] | 1667 | verbose = None |
---|
[202] | 1668 | |
---|
[87] | 1669 | ENABLE_SYSLOG = 0 |
---|
[201] | 1670 | |
---|
[204] | 1671 | |
---|
[317] | 1672 | SHORT_OPT = 'chf:np:t:v' |
---|
| 1673 | LONG_OPT = ['component=', 'dry-run', 'help', 'file=', 'project=', 'ticket_prefix=', 'verbose'] |
---|
[201] | 1674 | |
---|
[22] | 1675 | try: |
---|
[201] | 1676 | opts, args = getopt.getopt(sys.argv[1:], SHORT_OPT, LONG_OPT) |
---|
[22] | 1677 | except getopt.error,detail: |
---|
| 1678 | print __doc__ |
---|
| 1679 | print detail |
---|
| 1680 | sys.exit(1) |
---|
[87] | 1681 | |
---|
[22] | 1682 | project_name = None |
---|
| 1683 | for opt,value in opts: |
---|
| 1684 | if opt in [ '-h', '--help']: |
---|
| 1685 | print __doc__ |
---|
| 1686 | sys.exit(0) |
---|
| 1687 | elif opt in ['-c', '--component']: |
---|
| 1688 | component = value |
---|
| 1689 | elif opt in ['-f', '--file']: |
---|
| 1690 | configfile = value |
---|
[201] | 1691 | elif opt in ['-n', '--dry-run']: |
---|
[204] | 1692 | dry_run = True |
---|
[22] | 1693 | elif opt in ['-p', '--project']: |
---|
| 1694 | project_name = value |
---|
[202] | 1695 | elif opt in ['-t', '--ticket_prefix']: |
---|
| 1696 | ticket_prefix = value |
---|
[317] | 1697 | elif opt in ['-v', '--version']: |
---|
| 1698 | verbose = True |
---|
[87] | 1699 | |
---|
[22] | 1700 | settings = ReadConfig(configfile, project_name) |
---|
| 1701 | if not settings.has_key('project'): |
---|
| 1702 | print __doc__ |
---|
[79] | 1703 | print 'No Trac project is defined in the email2trac config file.' |
---|
[22] | 1704 | sys.exit(1) |
---|
[87] | 1705 | |
---|
[22] | 1706 | if component: |
---|
| 1707 | settings['component'] = component |
---|
[202] | 1708 | |
---|
| 1709 | # The default prefix for ticket values in email2trac.conf |
---|
| 1710 | # |
---|
| 1711 | settings['ticket_prefix'] = ticket_prefix |
---|
[206] | 1712 | settings['dry_run'] = dry_run |
---|
[317] | 1713 | settings['verbose'] = verbose |
---|
[87] | 1714 | |
---|
[22] | 1715 | if settings.has_key('trac_version'): |
---|
[189] | 1716 | version = settings['trac_version'] |
---|
[22] | 1717 | else: |
---|
| 1718 | version = trac_default_version |
---|
| 1719 | |
---|
[189] | 1720 | |
---|
[22] | 1721 | #debug HvB |
---|
| 1722 | #print settings |
---|
[189] | 1723 | |
---|
[87] | 1724 | try: |
---|
[189] | 1725 | if version == '0.9': |
---|
[87] | 1726 | from trac import attachment |
---|
| 1727 | from trac.env import Environment |
---|
| 1728 | from trac.ticket import Ticket |
---|
| 1729 | from trac.web.href import Href |
---|
| 1730 | from trac import util |
---|
| 1731 | from trac.Notify import TicketNotifyEmail |
---|
[189] | 1732 | elif version == '0.10': |
---|
[87] | 1733 | from trac import attachment |
---|
| 1734 | from trac.env import Environment |
---|
| 1735 | from trac.ticket import Ticket |
---|
| 1736 | from trac.web.href import Href |
---|
| 1737 | from trac import util |
---|
[139] | 1738 | # |
---|
| 1739 | # return util.text.to_unicode(str) |
---|
| 1740 | # |
---|
[87] | 1741 | # see http://projects.edgewall.com/trac/changeset/2799 |
---|
| 1742 | from trac.ticket.notification import TicketNotifyEmail |
---|
[199] | 1743 | from trac import config as trac_config |
---|
[189] | 1744 | elif version == '0.11': |
---|
[182] | 1745 | from trac import attachment |
---|
| 1746 | from trac.env import Environment |
---|
| 1747 | from trac.ticket import Ticket |
---|
| 1748 | from trac.web.href import Href |
---|
[199] | 1749 | from trac import config as trac_config |
---|
[182] | 1750 | from trac import util |
---|
[260] | 1751 | |
---|
| 1752 | |
---|
[182] | 1753 | # |
---|
| 1754 | # return util.text.to_unicode(str) |
---|
| 1755 | # |
---|
| 1756 | # see http://projects.edgewall.com/trac/changeset/2799 |
---|
| 1757 | from trac.ticket.notification import TicketNotifyEmail |
---|
[189] | 1758 | else: |
---|
| 1759 | print 'TRAC version %s is not supported' %version |
---|
| 1760 | sys.exit(1) |
---|
| 1761 | |
---|
| 1762 | if settings.has_key('enable_syslog'): |
---|
[190] | 1763 | if SYSLOG_AVAILABLE: |
---|
| 1764 | ENABLE_SYSLOG = float(settings['enable_syslog']) |
---|
[182] | 1765 | |
---|
[291] | 1766 | |
---|
| 1767 | # Must be set before environment is created |
---|
| 1768 | # |
---|
| 1769 | if settings.has_key('python_egg_cache'): |
---|
| 1770 | python_egg_cache = str(settings['python_egg_cache']) |
---|
| 1771 | os.environ['PYTHON_EGG_CACHE'] = python_egg_cache |
---|
| 1772 | |
---|
[87] | 1773 | env = Environment(settings['project'], create=0) |
---|
[333] | 1774 | |
---|
[206] | 1775 | tktparser = TicketEmailParser(env, settings, float(version)) |
---|
[87] | 1776 | tktparser.parse(sys.stdin) |
---|
[22] | 1777 | |
---|
[87] | 1778 | # Catch all errors ans log to SYSLOG if we have enabled this |
---|
| 1779 | # else stdout |
---|
| 1780 | # |
---|
| 1781 | except Exception, error: |
---|
| 1782 | if ENABLE_SYSLOG: |
---|
| 1783 | syslog.openlog('email2trac', syslog.LOG_NOWAIT) |
---|
[187] | 1784 | |
---|
[87] | 1785 | etype, evalue, etb = sys.exc_info() |
---|
| 1786 | for e in traceback.format_exception(etype, evalue, etb): |
---|
| 1787 | syslog.syslog(e) |
---|
[187] | 1788 | |
---|
[87] | 1789 | syslog.closelog() |
---|
| 1790 | else: |
---|
| 1791 | traceback.print_exc() |
---|
[22] | 1792 | |
---|
[97] | 1793 | if m: |
---|
[98] | 1794 | tktparser.save_email_for_debug(m, True) |
---|
[97] | 1795 | |
---|
[249] | 1796 | sys.exit(1) |
---|
[22] | 1797 | # EOB |
---|