Context Navigation

source: trunk/email2trac.py.in @ 564

Last change on this file since 564 was 564, checked in by bas, 13 years ago
Only use repr() in subject logging, still convert subject to unicode, see #267
Property svn:executable set to ``* Property svn:keywords set to `Id`
File size: 80.4 KB

Line
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	#
20	# For vi/emacs or other use tabstop=4 (vi: set ts=4)
21	#
22	"""
23	email2trac.py -- Email -> TRAC tickets
24
25	A MTA filter to create Trac tickets from inbound emails.
26
27	first proof of concept from:
28	Copyright 2005, Daniel Lundin <daniel@edgewall.com>
29	Copyright 2005, Edgewall Software
30
31	Authors:
32	Bas van der Vlies <basv@sara.nl>
33	Walter de Jong <walter@sara.nl>
34
35	How to use
36	----------
37	* See https://subtrac.sara.nl/oss/email2trac/
38
39	* Commandline opions:
40	-h,--help
41	-d, --debug
42	-f,--file <configuration file>
43	-n,--dry-run
44	-p, --project <project name>
45	-t, --ticket_prefix <name>
46
47	SVN Info:
48	$Id: email2trac.py.in 564 2011-08-22 08:54:04Z bas $
49	"""
50	import os
51	import sys
52	import string
53	import getopt
54	import time
55	import email
56	import email.Iterators
57	import email.Header
58	import re
59	import urllib
60	import unicodedata
61	import mimetypes
62	import traceback
63	import logging
64	import logging.handlers
65	import UserDict
66	import tempfile
67
68	from datetime import timedelta, datetime
69	from stat import *
70
71
72	from trac import __version__ as trac_version
73	from trac import config as trac_config
74
75	## Some global variables
76	#
77	m = None
78
79	# This is to for the function AlwaysNotifyReporter
80	sender_email = None
81
82	class SaraDict(UserDict.UserDict):
83	def __init__(self, dictin = None):
84	UserDict.UserDict.__init__(self)
85	self.name = None
86
87	if dictin:
88	if dictin.has_key('name'):
89	self.name = dictin['name']
90	del dictin['name']
91	self.data = dictin
92
93	def get_value(self, name):
94	if self.has_key(name):
95	return self[name]
96	else:
97	return None
98
99	def __repr__(self):
100	return repr(self.data)
101
102	def __str__(self):
103	return str(self.data)
104
105	def __getattr__(self, name):
106	"""
107	override the class attribute get method. Return the value
108	from the dictionary
109	"""
110	if self.data.has_key(name):
111	return self.data[name]
112	else:
113	return None
114
115	def __setattr__(self, name, value):
116	"""
117	override the class attribute set method only when the UserDict
118	has set its class attribute
119	"""
120	if self.__dict__.has_key('data'):
121	self.data[name] = value
122	else:
123	self.__dict__[name] = value
124
125	def __iter__(self):
126	return iter(self.data.keys())
127
128	class TicketEmailParser(object):
129	env = None
130	comment = '> '
131
132	def __init__(self, env, parameters, logger, version):
133	self.env = env
134
135	# Database connection
136	#
137	self.db = None
138
139	# Save parameters
140	#
141	self.parameters = parameters
142	self.logger = logger
143
144	# Some useful mail constants
145	#
146	self.email_name = None
147	self.email_addr = None
148	self.email_from = None
149	self.author = None
150	self.id = None
151
152	self.STRIP_CONTENT_TYPES = list()
153
154	## fields properties via body_text
155	#
156	self.properties = dict()
157
158	self.VERSION = version
159
160	self.get_config = self.env.config.get
161
162	## init function ##
163	#
164	self.setup_parameters()
165
166	def setup_parameters(self):
167	if self.parameters.umask:
168	os.umask(self.parameters.umask)
169
170	if not self.parameters.spam_level:
171	self.parameters.spam_level = 0
172
173	if not self.parameters.spam_header:
174	self.parameters.spam_header = 'X-Spam-Score'
175
176	if not self.parameters.email_quote:
177	self.parameters.email_quote = '> '
178
179	if not self.parameters.ticket_update_by_subject_lookback:
180	self.parameters.ticket_update_by_subject_lookback = 30
181
182	if self.parameters.verbatim_format == None:
183	self.parameters.verbatim_format = 1
184
185	if self.parameters.reflow == None:
186	self.parameters.reflow = 1
187
188	if self.parameters.binhex:
189	self.STRIP_CONTENT_TYPES.append('application/mac-binhex40')
190
191	if self.parameters.applesingle:
192	self.STRIP_CONTENT_TYPES.append('application/applefile')
193
194	if self.parameters.appledouble:
195	self.STRIP_CONTENT_TYPES.append('application/applefile')
196
197	if self.parameters.strip_content_types:
198	items = self.parameters.strip_content_types.split(',')
199	for item in items:
200	self.STRIP_CONTENT_TYPES.append(item.strip())
201
202	if self.parameters.tmpdir:
203	self.parameters.tmpdir = os.path.normcase(str(self.parameters['tmpdir']))
204	else:
205	self.parameters.tmpdir = os.path.normcase('/tmp')
206
207	if self.parameters.email_triggers_workflow == None:
208	self.parameters.email_triggers_workflow = 1
209
210	if not self.parameters.subject_field_separator:
211	self.parameters.subject_field_separator = '&'
212	else:
213	self.parameters.subject_field_separator = self.parameters.subject_field_separator.strip()
214
215	self.trac_smtp_from = self.get_config('notification', 'smtp_from')
216	self.smtp_default_domain = self.get_config('notification', 'smtp_default_domain')
217
218
219	self.system = None
220
221	########## Email Header Functions ###########################################################
222
223	def spam(self, message):
224	"""
225	# X-Spam-Score: *** (3.255) BAYES_50,DNS_FROM_AHBL_RHSBL,HTML_
226	# Note if Spam_level then '*' are included
227	"""
228	spam = False
229	if message.has_key(self.parameters.spam_header):
230	spam_l = string.split(message[self.parameters.spam_header])
231
232	try:
233	number = spam_l[0].count('*')
234	except IndexError, detail:
235	number = 0
236
237	if number >= self.parameters.spam_level:
238	spam = True
239
240	# treat virus mails as spam
241	#
242	elif message.has_key('X-Virus-found'):
243	spam = True
244
245	# How to handle SPAM messages
246	#
247	if self.parameters.drop_spam and spam:
248
249	self.logger.info('Message is a SPAM. Automatic ticket insertion refused (SPAM level > %d)' %self.parameters.spam_level)
250	return 'drop'
251
252	elif spam:
253
254	return 'Spam'
255	else:
256
257	return False
258
259	def email_header_acl(self, keyword, header_field, default):
260	"""
261	This function wil check if the email address is allowed or denied
262	to send mail to the ticket list
263	"""
264	self.logger.debug('function email_header_acl: %s' %keyword)
265
266	try:
267	mail_addresses = self.parameters[keyword]
268
269	# Check if we have an empty string
270	#
271	if not mail_addresses:
272	return default
273
274	except KeyError, detail:
275	self.logger.debug('%s not defined, all messages are allowed.' %(keyword))
276
277	return default
278
279	mail_addresses = string.split(mail_addresses, ',')
280
281	for entry in mail_addresses:
282	entry = entry.strip()
283	TO_RE = re.compile(entry, re.VERBOSE\|re.IGNORECASE)
284	result = TO_RE.search(header_field)
285	if result:
286	return True
287
288	return False
289
290	def email_header_txt(self, m):
291	"""
292	Display To and CC addresses in description field
293	"""
294	s = ''
295
296	if m['To'] and len(m['To']) > 0:
297	s = "'''To:''' %s\r\n" %(m['To'])
298	if m['Cc'] and len(m['Cc']) > 0:
299	s = "%s'''Cc:''' %s\r\n" % (s, m['Cc'])
300
301	return self.email_to_unicode(s)
302
303
304	def get_sender_info(self, message):
305	"""
306	Get the default author name and email address from the message
307	"""
308
309	self.email_to = self.email_to_unicode(message['to'])
310	self.to_name, self.to_email_addr = email.Utils.parseaddr (self.email_to)
311
312	self.email_from = self.email_to_unicode(message['from'])
313	self.email_name, self.email_addr = email.Utils.parseaddr(self.email_from)
314
315	## Trac can not handle author's name that contains spaces
316	#
317	if self.email_addr.lower() == self.trac_smtp_from.lower():
318	if self.email_name:
319	self.author = self.email_name
320	else:
321	self.author = "email2trac"
322	else:
323	self.author = self.email_addr
324
325	if self.parameters.ignore_trac_user_settings:
326	return
327
328	# Is this a registered user, use email address as search key:
329	# result:
330	# u : login name
331	# n : Name that the user has set in the settings tab
332	# e : email address that the user has set in the settings tab
333	#
334	users = [ (u,n,e) for (u, n, e) in self.env.get_known_users(self.db)
335	if (
336	(e and (e.lower() == self.email_addr.lower())) or
337	(u.lower() + '@' + self.smtp_default_domain.lower() == self.email_addr.lower())
338	)
339	]
340
341	if len(users) >= 1:
342	self.email_from = users[0][0]
343	self.author = users[0][0]
344
345	def set_reply_fields(self, ticket, message):
346	"""
347	Set all the right fields for a new ticket
348	"""
349	self.logger.debug('function set_reply_fields')
350
351	## Only use name or email adress
352	#
353	ticket['reporter'] = self.author
354
355
356	# Put all CC-addresses in ticket CC field
357	#
358	if self.parameters.reply_all:
359
360	email_cc = ''
361
362	cc_addrs = email.Utils.getaddresses( message.get_all('cc', []) )
363
364	if not cc_addrs:
365	return
366
367	## Build a list of forbidden CC addresses
368	#
369	#to_addrs = email.Utils.getaddresses( message.get_all('to', []) )
370	#to_list = list()
371	#for n,e in to_addrs:
372	# to_list.append(e)
373
374	## Always Remove reporter email address from cc-list
375	#
376	try:
377	cc_addrs.remove((self.author, self.email_addr))
378	except ValueError, detail:
379	pass
380
381	for name,addr in cc_addrs:
382
383	## Prevent mail loop
384	#
385	if addr == self.trac_smtp_from:
386	self.logger.debug("Skipping %s mail address for CC-field" %(addr))
387	continue
388
389	if email_cc:
390	email_cc = '%s, %s' %(email_cc, addr)
391	else:
392	email_cc = addr
393
394	if email_cc:
395	self.logger.debug('set_reply_fields: %s' %email_cc)
396
397	ticket['cc'] = self.email_to_unicode(email_cc)
398
399
400	########## DEBUG functions ###########################################################
401
402	def debug_body(self, message_body, temp_file):
403	"""
404	"""
405	self.logger.debug('function debug_body:')
406
407	body_file = "%s.body" %(temp_file)
408	fx = open(body_file, 'wb')
409
410	if self.parameters.dry_run:
411	self.logger.info('DRY-RUN: not saving body to %s' %(body_file))
412	return
413
414	self.logger.debug('writing body to %s' %(body_file))
415	if not message_body:
416	message_body = '(None)'
417
418	message_body = message_body.encode('utf-8')
419
420	fx.write(message_body)
421	fx.close()
422	try:
423	os.chmod(body_file,S_IRWXU\|S_IRWXG\|S_IRWXO)
424	except OSError:
425	pass
426
427	def debug_attachments(self, message_parts, temp_file):
428	"""
429	"""
430	self.logger.debug('function debug_attachments')
431
432	n = 0
433	for item in message_parts:
434
435	## Skip inline text parts
436	#
437	if not isinstance(item, tuple):
438	continue
439
440	(original, filename, part) = item
441	self.logger.debug('\t part%d: Content-Type: %s' % (n, part.get_content_type()) )
442
443	dummy_filename, ext = os.path.splitext(filename)
444
445	n = n + 1
446	part_name = 'part%d%s' %(n, ext)
447	part_file = "%s.%s" %(temp_file, part_name)
448
449	s = 'writing %s: filename: %s' %(part_file, filename)
450	self.print_unicode(s)
451
452	## Forbidden chars, just write part files instead of names
453	#
454	#filename = filename.replace('\\', '_')
455	#filename = filename.replace('/', '_')
456	#filename = filename + '.att_email2trac'
457	# part_file = os.path.join(self.parameters.tmpdir, filename)
458	#part_file = util.text.unicode_quote(part_file)
459	#self.print_unicode(part_file)
460
461	if self.parameters.dry_run:
462	self.logger.info('DRY_RUN: NOT saving attachments')
463	continue
464
465	fx = open(part_file, 'wb')
466	text = part.get_payload(decode=1)
467
468	if not text:
469	text = '(None)'
470
471	fx.write(text)
472	fx.close()
473
474	try:
475	os.chmod(part_file,S_IRWXU\|S_IRWXG\|S_IRWXO)
476	except OSError:
477	pass
478
479	def save_email_for_debug(self, message, project_name, create_tempfile=False):
480
481	if self.parameters.dry_run:
482	self.logger.debug('DRY_RUN: NOT saving email message')
483	return
484
485	if create_tempfile:
486	(fd, tmp_file) = tempfile.mkstemp('.%s.email2trac' %project_name)
487	fx = os.fdopen(fd, 'wb')
488	else:
489	tmp_file = os.path.join(self.parameters.tmpdir, 'msg.%s.email2trac' %project_name)
490	fx = open(tmp_file, 'wb')
491
492
493	self.logger.debug('saving email to %s' %(tmp_file))
494	fx.write('%s' % message)
495	fx.close()
496
497	try:
498	os.chmod(tmp_file, S_IRWXU\|S_IRWXG\|S_IRWXO)
499	except OSError:
500	pass
501
502	message_parts = self.get_message_parts(message)
503	message_parts = self.unique_attachment_names(message_parts)
504	body_text = self.get_body_text(message_parts)
505	self.debug_body(body_text, tmp_file)
506	self.debug_attachments(message_parts, tmp_file)
507
508	########## Conversion functions ###########################################################
509
510	def email_to_unicode(self, message_str):
511	"""
512	Email has 7 bit ASCII code, convert it to unicode with the charset
513	that is encoded in 7-bit ASCII code and encode it as utf-8 so Trac
514	understands it.
515	"""
516	self.logger.debug("function email_to_unicode")
517
518	results = email.Header.decode_header(message_str)
519
520	s = None
521	for text,format in results:
522	if format:
523	try:
524	temp = unicode(text, format)
525	except UnicodeError, detail:
526	# This always works
527	#
528	msg = 'ERROR: Could not find charset: %s, please install' %format
529	self.logger.error(msg)
530	temp = unicode(text, 'iso-8859-15')
531	except LookupError, detail:
532	msg = 'ERROR: Could not find charset: %s, please install' %format
533	self.logger.error(msg)
534	#temp = unicode(text, 'iso-8859-15')
535	temp = message_str
536
537	else:
538	temp = string.strip(text)
539	temp = unicode(text, 'iso-8859-15')
540
541	if s:
542	s = '%s %s' %(s, temp)
543	else:
544	s = '%s' %temp
545
546	return s
547
548	def str_to_dict(self, s):
549	"""
550	Transfrom a string of the form [<key>=<value>]+ to dict[<key>] = <value>
551	"""
552	self.logger.debug("function str_to_dict")
553
554	fields = string.split(s, self.parameters.subject_field_separator)
555
556	result = dict()
557	for field in fields:
558	try:
559	index, value = string.split(field, '=')
560
561	# We can not change the description of a ticket via the subject
562	# line. The description is the body of the email
563	#
564	if index.lower() in ['description']:
565	continue
566
567	if value:
568	result[index.lower()] = value
569
570	except ValueError:
571	pass
572	return result
573
574	def print_unicode(self,s):
575	"""
576	This function prints unicode strings if possible else it will quote it
577	"""
578	try:
579	self.logger.debug(s)
580	except UnicodeEncodeError, detail:
581	self.logger.debug(util.text.unicode_quote(s))
582
583
584	def html_2_txt(self, data):
585	"""
586	Various routines to convert html syntax to valid trac wiki syntax
587	"""
588	self.logger.debug('function html_2_txt')
589
590	## This routine make an safe html that can be include
591	# in trac, but no further text processing can be done
592	#
593	# try:
594	# from lxml.html.clean import Cleaner
595	# tags_rm = list()
596	# tags_rm.append('body')
597	#
598	# cleaner = Cleaner(remove_tags=tags_rm )
599	# parsed_data = cleaner.clean_html(data)
600	# parsed_data = '\n{{{\n#!html\n' + parsed_data + '\n}}}\n'
601	#
602	# return parsed_data
603	#
604	# except ImportError::
605	# pass
606
607	parsed_data = None
608	if self.parameters.html2text_cmd:
609	(fd, tmp_file) = tempfile.mkstemp('email2trac.html')
610	f = os.fdopen(fd, 'w')
611
612	cmd = '%s %s' %(self.parameters.html2text_cmd, tmp_file)
613	self.logger.debug('\t html2text conversion %s'%(cmd))
614
615	if self.parameters.dry_run:
616	self.logger.info('DRY_RUN: html2text conversion command: %s\n' %(cmd))
617
618	else:
619	f.write(data)
620	f.close()
621
622	lines = os.popen(cmd).readlines()
623	parsed_data = ''.join(lines)
624
625	os.unlink(tmp_file)
626
627	else:
628	self.logger.debug('\t No html2text conversion tool specified in email2trac.conf')
629
630	return parsed_data
631
632	def check_filename_length(self, name):
633	"""
634	To bypass a bug in Trac
635	check if the filename lenght is not larger then OS limit.
636	yes : return truncated filename
637	no : return unmodified filename
638	"""
639	self.logger.debug('function check_filename_length: ')
640
641	if not name:
642	return 'None'
643
644	dummy_filename, ext = os.path.splitext(name)
645
646	## Trac uses this format
647	#
648	quote_format = util.text.unicode_quote(dummy_filename)
649
650	## Determine max filename lenght
651	#
652	filemax_length = os.pathconf('/', os.pathconf_names['PC_NAME_MAX'])
653
654	if len(quote_format) <= filemax_length:
655	return name
656
657	else:
658	## Truncate file to filemax_length and reserve room for extension
659	# We must break on a boundry
660	#
661	length = filemax_length - 6
662
663	for i in range(0,10):
664
665	truncated = quote_format[ : (length - i)]
666
667	try:
668	unqoute_truncated = util.text.unicode_unquote(truncated)
669	unqoute_truncated = unqoute_truncated + ext
670
671	self.print_unicode('\t ' + unqoute_truncated)
672
673	break
674
675	except UnicodeDecodeError, detail:
676	continue
677
678
679	return unqoute_truncated
680
681	########## TRAC ticket functions ###########################################################
682
683	def mail_workflow(self, tkt):
684	"""
685	"""
686	self.logger.debug('function mail_workflow: ')
687
688	req = Mock(authname=self.author, perm=MockPerm(), args={})
689	ticket_system = TicketSystem(self.env)
690
691	try:
692	workflow = self.parameters['workflow_%s' %tkt['status'].lower()]
693
694	except KeyError:
695	## fallback for compability (Will be deprecated)
696	# workflow can be none.
697	#
698	workflow = None
699	if tkt['status'] in ['closed']:
700	workflow = self.parameters.workflow
701
702	if workflow:
703
704	## process all workflow implementations
705	#
706	tkt_module = TicketModule(self.env)
707	field_changes, problems = tkt_module.get_ticket_changes(req, tkt, workflow)
708
709	for field in field_changes.keys():
710
711	## We have already processed these fields
712	#
713	if not field in ['summary', 'description']:
714	s = 'workflow : %s, field %s : %s, by %s' \
715	%(workflow, field, field_changes[field]['new'],field_changes[field]['by'] )
716	self.logger.debug(s)
717
718	tkt[field] = field_changes[field]['new']
719
720	return True
721
722	else:
723	return False
724
725	def check_permission_participants(self, tkt, action):
726	"""
727	Check if the mailer is allowed to update the ticket
728	"""
729	self.logger.debug('function check_permission_participants %s')
730
731	if tkt['reporter'].lower() in [self.author.lower(), self.email_addr.lower()]:
732	self.logger.debug('ALLOW, %s is the ticket reporter' %(self.email_addr))
733
734	return True
735
736	perm = PermissionSystem(self.env)
737	if perm.check_permission(action, self.author):
738	self.logger.debug('ALLOW, %s has trac permission to update the ticket' %(self.author))
739
740	return True
741
742	# Is the updater in the CC?
743	try:
744	cc_list = tkt['cc'].split(',')
745	for cc in cc_list:
746	if self.email_addr.lower() in cc.lower.strip():
747	self.logger.debug('ALLOW, %s is in the CC' %(self.email_addr))
748
749	return True
750
751	except KeyError:
752	pass
753
754	return False
755
756	def check_permission(self, tkt, action):
757	"""
758	check if the reporter has the right permission for the action:
759	- TICKET_CREATE
760	- TICKET_MODIFY
761	- TICKET_APPEND
762	- TICKET_CHGPROP
763
764	There are three models:
765	- None : no checking at all
766	- trac : check the permission via trac permission model
767	- email2trac: ....
768	"""
769	self.logger.debug("function check_permission: %s" %(action))
770
771	if self.parameters.ticket_permission_system in ['trac']:
772
773	perm = PermissionCache(self.env, self.author)
774	if perm.has_permission(action):
775	return True
776	else:
777	return False
778
779	elif self.parameters.ticket_permission_system in ['update_restricted_to_participants']:
780	return (self.check_permission_participants(tkt, action))
781
782	## Default is to allow everybody ticket updates and ticket creation
783	#
784	else:
785	return True
786
787
788	def update_ticket_fields(self, ticket, user_dict, new=None):
789	"""
790	This will update the ticket fields. It will check if the
791	given fields are known and if the right values are specified
792	It will only update the ticket field value:
793	- If the field is known
794	- If the value supplied is valid for the ticket field.
795	If not then there are two options:
796	1) Skip the value (new=None)
797	2) Set default value for field (new=1)
798	"""
799	self.logger.debug("function update_ticket_fields")
800
801	## Check only permission model on ticket updates
802	#
803	if not new:
804	if self.parameters.ticket_permission_system:
805	if not self.check_permission(ticket, 'TICKET_CHGPROP'):
806	self.logger.info('Reporter: %s has no permission to change ticket properties' %self.author)
807	return False
808
809	## Build a system dictionary from the ticket fields
810	# with field as index and option as value
811	#
812	sys_dict = dict()
813
814	for field in ticket.fields:
815
816	try:
817	sys_dict[field['name']] = field['options']
818
819	except KeyError:
820	sys_dict[field['name']] = None
821	pass
822
823	## Check user supplied fields an compare them with the
824	# system one's
825	#
826	for field,value in user_dict.items():
827
828	s = 'user_field\t %s = %s' %(field,value)
829	self.print_unicode(s)
830
831	if not field in sys_dict.keys():
832	self.logger.debug('%s is not a valid field for tickets' %(field))
833	continue
834
835	## To prevent mail loop
836	#
837	if field == 'cc':
838
839	cc_list = user_dict['cc'].split(',')
840
841	if self.trac_smtp_from in cc_list:
842	self.logger.debug('MAIL LOOP: %s is not allowed as CC address' %(self.trac_smtp_from))
843
844	cc_list.remove(self.trac_smtp_from)
845
846	value = ','.join(cc_list)
847
848
849	## Check if every value is allowed for this field
850	#
851	if sys_dict[field]:
852
853	if value in sys_dict[field]:
854	ticket[field] = value
855	else:
856	## Must we set a default if value is not allowed
857	#
858	if new:
859	value = self.get_config('ticket', 'default_%s' %(field) )
860
861	else:
862
863	ticket[field] = value
864
865	s = 'ticket_field\t %s = %s' %(field, ticket[field])
866	self.print_unicode(s)
867
868	def ticket_update(self, m, id, spam):
869	"""
870	If the current email is a reply to an existing ticket, this function
871	will append the contents of this email to that ticket, instead of
872	creating a new one.
873	"""
874	self.logger.debug("function ticket_update")
875
876	if not self.parameters.ticket_update:
877	self.logger.debug("ticket_update disabled")
878	return False
879
880	## Must we update ticket fields
881	#
882	update_fields = dict()
883	try:
884	id, keywords = string.split(id, '?')
885
886	update_fields = self.str_to_dict(keywords)
887
888	## Strip '#'
889	#
890	self.id = int(id[1:])
891
892	except ValueError:
893
894	## Strip '#'
895	#
896	self.id = int(id[1:])
897
898	self.logger.debug("ticket_update id %s" %id)
899
900	## When is the change committed
901	#
902	if self.VERSION < 0.11:
903	when = int(time.time())
904	else:
905	when = datetime.now(util.datefmt.utc)
906
907	try:
908	tkt = Ticket(self.env, self.id, self.db)
909
910	except util.TracError, detail:
911
912	## Not a valid ticket
913	#
914	self.id = None
915	return False
916
917	## Check the permission of the reporter
918	#
919	if self.parameters.ticket_permission_system:
920	if not self.check_permission(tkt, 'TICKET_APPEND'):
921	self.logger.info('Reporter: %s has no permission to add comments or attachments to tickets' %self.author)
922	return False
923
924	## How many changes has this ticket
925	#
926	grouped = TicketModule(self.env).grouped_changelog_entries(tkt, self.db)
927	cnum = sum(1 for e in grouped) + 1
928
929
930	## reopen the ticket if it is was closed
931	# We must use the ticket workflow framework
932	#
933	if self.parameters.email_triggers_workflow and (self.VERSION >= 0.11):
934
935	if not self.mail_workflow(tkt):
936
937	if tkt['status'] in ['closed']:
938	tkt['status'] = 'reopened'
939	tkt['resolution'] = ''
940
941	## Old pre 0.11 situation
942	#
943	elif self.parameters.email_triggers_workflow:
944
945	self.logger.debug('email triggers workflow pre trac 0.11')
946
947	if tkt['status'] in ['closed']:
948	tkt['status'] = 'reopened'
949	tkt['resolution'] = ''
950
951	else:
952	self.logger.debug('email triggers workflow disabled')
953
954	## Must we update some ticket fields properties via subject line
955	#
956	if update_fields:
957	self.update_ticket_fields(tkt, update_fields)
958
959	message_parts = self.get_message_parts(m)
960	message_parts = self.unique_attachment_names(message_parts)
961
962	## Must we update some ticket fields properties via body_text
963	#
964	if self.properties:
965	self.update_ticket_fields(tkt, self.properties)
966
967	if self.parameters.email_header:
968	message_parts.insert(0, self.email_header_txt(m))
969
970	body_text = self.get_body_text(message_parts)
971
972	error_with_attachments = self.attach_attachments(message_parts)
973
974	if body_text.strip() or update_fields or self.properties:
975
976	if self.parameters.dry_run:
977	s = 'DRY_RUN: tkt.save_changes(self.author, body_text, ticket_change_number) %s %s' %(self.author, cnum)
978	self.logger.info(s)
979
980	else:
981	if error_with_attachments:
982	body_text = '%s\\%s' %(error_with_attachments, body_text)
983
984	self.logger.debug('tkt.save_changes(%s, %d)' %(self.author, cnum))
985	tkt.save_changes(self.author, body_text, when, None, str(cnum))
986
987	if not spam:
988	self.notify(tkt, False, when)
989
990	return True
991
992	def set_ticket_fields(self, ticket):
993	"""
994	set the ticket fields to value specified
995	- /etc/email2trac.conf with <prefix>_<field>
996	- trac default values, trac.ini
997	"""
998	self.logger.debug('function set_ticket_fields')
999
1000	user_dict = dict()
1001
1002	for field in ticket.fields:
1003
1004	name = field['name']
1005
1006	## default trac value
1007	#
1008	if not field.get('custom'):
1009	value = self.get_config('ticket', 'default_%s' %(name) )
1010	if (name in ['resolution']) and (value in ['fixed']):
1011	value = None
1012	else:
1013	## Else get the default value for reporter
1014	#
1015	value = field.get('value')
1016	options = field.get('options')
1017
1018	if value and options and (value not in options):
1019	value = options[int(value)]
1020
1021	s = 'trac[%s] = %s' %(name, value)
1022	self.print_unicode(s)
1023
1024	## email2trac.conf settings
1025	#
1026	prefix = self.parameters.ticket_prefix
1027	try:
1028	value = self.parameters['%s_%s' %(prefix, name)]
1029
1030	s = 'email2trac[%s] = %s ' %(name, value)
1031	self.print_unicode(s)
1032
1033	except KeyError, detail:
1034	pass
1035
1036	if value:
1037	user_dict[name] = value
1038
1039	s = 'used %s = %s' %(name, value)
1040	self.print_unicode(s)
1041
1042	self.update_ticket_fields(ticket, user_dict, new=1)
1043
1044	if 'status' not in user_dict.keys():
1045	ticket['status'] = 'new'
1046
1047
1048	def ticket_update_by_subject(self, subject):
1049	"""
1050	This list of Re: prefixes is probably incomplete. Taken from
1051	wikipedia. Here is how the subject is matched
1052	- Re: <subject>
1053	- Re: (<Mail list label>:)+ <subject>
1054
1055	So we must have the last column
1056	"""
1057	self.logger.debug('function ticket_update_by_subject')
1058
1059	found_id = None
1060	if self.parameters.ticket_update and self.parameters.ticket_update_by_subject:
1061
1062	SUBJECT_RE = re.compile(r'^(?:(?:RE\|AW\|VS\|SV\|FW\|FWD):\s)+(.)', re.IGNORECASE)
1063	result = SUBJECT_RE.search(subject)
1064
1065	if result:
1066	## This is a reply
1067	#
1068	orig_subject = result.group(1)
1069
1070	self.logger.debug('subject search string: %s' %(orig_subject))
1071
1072	cursor = self.db.cursor()
1073	summaries = [orig_subject, '%%: %s' % orig_subject]
1074
1075	## Time resolution is in micoseconds
1076	#
1077	search_date = datetime.now(util.datefmt.utc) - timedelta(days=self.parameters.ticket_update_by_subject_lookback)
1078
1079	if self.VERSION < 0.12:
1080	lookback = util.datefmt.to_timestamp(search_date)
1081	else:
1082	lookback = util.datefmt.to_utimestamp(search_date)
1083
1084	for summary in summaries:
1085	self.logger.debug('Looking for summary matching: "%s"' % summary)
1086
1087	sql = """SELECT id, reporter FROM ticket
1088	WHERE changetime >= %s AND summary LIKE %s
1089	ORDER BY changetime DESC"""
1090
1091	cursor.execute(sql, [lookback, summary.strip()])
1092
1093	for row in cursor:
1094
1095	(matched_id, sql_reporter) = row
1096
1097	## Save first entry.
1098	#
1099	if not found_id:
1100	found_id = matched_id
1101
1102	## If subject and reporter are the same. The we certainly have found the right ticket
1103	#
1104	if sql_reporter == self.author:
1105	self.logger.debug('Found matching reporter: %s with ticket id: %d' %(sql_reporter, matched_id))
1106	found_id = matched_id
1107	break
1108
1109	if found_id:
1110	self.logger.debug('Found matching ticket id: %d' % found_id)
1111	found_id = '#%d' % found_id
1112	return (found_id, orig_subject)
1113
1114	# obsolete !?? 12 Aug 2011
1115	#subject = orig_subject
1116
1117	return (found_id, subject)
1118
1119
1120	def new_ticket(self, msg, subject, spam, set_fields = None):
1121	"""
1122	Create a new ticket
1123	"""
1124	self.logger.debug('function new_ticket')
1125
1126	tkt = Ticket(self.env)
1127
1128	self.set_reply_fields(tkt, msg)
1129
1130	self.set_ticket_fields(tkt)
1131
1132	## Check the permission of the reporter
1133	#
1134	if self.parameters.ticket_permission_system:
1135	if not self.check_permission(tkt, 'TICKET_CREATE'):
1136	self.logger.info('Reporter: %s has no permission to create tickets' %self.author)
1137	return False
1138
1139	## Old style setting for component, will be removed
1140	#
1141	if spam:
1142	tkt['component'] = 'Spam'
1143
1144	elif self.parameters.has_key('component'):
1145	tkt['component'] = self.parameters['component']
1146
1147	if not msg['Subject']:
1148	tkt['summary'] = u'(No subject)'
1149	else:
1150	tkt['summary'] = subject
1151
1152
1153	if set_fields:
1154	rest, keywords = string.split(set_fields, '?')
1155
1156	if keywords:
1157	update_fields = self.str_to_dict(keywords)
1158	self.update_ticket_fields(tkt, update_fields)
1159
1160
1161	message_parts = self.get_message_parts(msg)
1162
1163	## Must we update some ticket fields properties via body_text
1164	#
1165	if self.properties:
1166	self.update_ticket_fields(tkt, self.properties)
1167
1168	message_parts = self.unique_attachment_names(message_parts)
1169
1170	## produce e-mail like header
1171	#
1172	head = ''
1173	if self.parameters.email_header:
1174	head = self.email_header_txt(msg)
1175	message_parts.insert(0, head)
1176
1177	body_text = self.get_body_text(message_parts)
1178
1179	tkt['description'] = body_text
1180
1181	## When is the change committed
1182	#
1183	if self.VERSION < 0.11:
1184	when = int(time.time())
1185	else:
1186	when = datetime.now(util.datefmt.utc)
1187
1188	if self.parameters.dry_run:
1189	self.logger.info('DRY_RUN: tkt.insert()')
1190	else:
1191	self.id = tkt.insert()
1192
1193	changed = False
1194	comment = ''
1195
1196	## some routines in trac are dependend on ticket id
1197	# like alternate notify template
1198	#
1199	if self.parameters.alternate_notify_template:
1200	tkt['id'] = self.id
1201	changed = True
1202
1203	## Rewrite the description if we have mailto enabled
1204	#
1205	if self.parameters.mailto_link:
1206	changed = True
1207	comment = u'\nadded mailto line\n'
1208	mailto = self.html_mailto_link( m['Subject'])
1209
1210	tkt['description'] = u'%s\r\n%s%s\r\n' \
1211	%(head, mailto, body_text)
1212
1213	## Save the attachments to the ticket
1214	#
1215	error_with_attachments = self.attach_attachments(message_parts)
1216
1217	if error_with_attachments:
1218	changed = True
1219	comment = '%s\n%s\n' %(comment, error_with_attachments)
1220
1221	if self.parameters.email_triggers_workflow and (self.VERSION >= 0.11):
1222	if self.mail_workflow(tkt):
1223	changed = True
1224
1225	if changed:
1226	if self.parameters.dry_run:
1227	s = 'DRY_RUN: tkt.save_changes(%s, comment) real reporter = %s' %( tkt['reporter'], self.author)
1228	self.logger.info(s)
1229
1230	else:
1231	tkt.save_changes(tkt['reporter'], comment)
1232
1233	if not spam:
1234	self.notify(tkt, True)
1235
1236
1237	def attach_attachments(self, message_parts, update=False):
1238	'''
1239	save any attachments as files in the ticket's directory
1240	'''
1241	self.logger.debug('function attach_attachments()')
1242
1243	if self.parameters.dry_run:
1244	self.logger.debug("DRY_RUN: no attachments attached to tickets")
1245	return ''
1246
1247	count = 0
1248
1249	## Get Maxium attachment size
1250	#
1251	max_size = int(self.get_config('attachment', 'max_size'))
1252	status = None
1253
1254	for item in message_parts:
1255	## Skip body parts
1256	#
1257	if not isinstance(item, tuple):
1258	continue
1259
1260	(original, filename, part) = item
1261
1262	## We have to determine the size so we use this temporary solution.
1263	#
1264	path, fd = util.create_unique_file(os.path.join(self.parameters.tmpdir, 'email2trac_tmp.att'))
1265	text = part.get_payload(decode=1)
1266	if not text:
1267	text = '(None)'
1268	fd.write(text)
1269	fd.close()
1270
1271	## get the file_size
1272	#
1273	stats = os.lstat(path)
1274	file_size = stats[ST_SIZE]
1275
1276	## Check if the attachment size is allowed
1277	#
1278	if (max_size != -1) and (file_size > max_size):
1279	status = '%s\nFile %s is larger then allowed attachment size (%d > %d)\n\n' \
1280	%(status, original, file_size, max_size)
1281
1282	os.unlink(path)
1283	continue
1284	else:
1285	count = count + 1
1286
1287	## Insert the attachment
1288	#
1289	fd = open(path, 'rb')
1290	if self.system == 'discussion':
1291	att = attachment.Attachment(self.env, 'discussion', 'topic/%s' % (self.id,))
1292	else:
1293	s = 'Attach %s to ticket %d' %(filename, self.id)
1294	self.print_unicode(s)
1295	att = attachment.Attachment(self.env, 'ticket', self.id)
1296
1297	## This will break the ticket_update system, the body_text is vaporized
1298	# ;-(
1299	#
1300	if not update:
1301	att.author = self.author
1302	att.description = self.email_to_unicode('Added by email2trac')
1303
1304	try:
1305
1306	self.logger.debug('Insert atachment')
1307	att.insert(filename, fd, file_size)
1308
1309	except OSError, detail:
1310
1311	self.logger.info('%s\nFilename %s could not be saved, problem: %s' %(status, filename, detail))
1312	status = '%s\nFilename %s could not be saved, problem: %s' %(status, filename, detail)
1313
1314	## Remove the created temporary filename
1315	#
1316	fd.close()
1317	os.unlink(path)
1318
1319	## return error
1320	#
1321	return status
1322
1323	########## Fullblog functions #################################################
1324
1325	def blog(self, id):
1326	"""
1327	The blog create/update function
1328	"""
1329	## import the modules
1330	#
1331	from tracfullblog.core import FullBlogCore
1332	from tracfullblog.model import BlogPost, BlogComment
1333
1334	## instantiate blog core
1335	#
1336	blog = FullBlogCore(self.env)
1337	req = Mock(authname='anonymous', perm=MockPerm(), args={})
1338
1339	if id:
1340
1341	## update blog
1342	#
1343	comment = BlogComment(self.env, id)
1344	comment.author = self.author
1345
1346	message_parts = self.get_message_parts(m)
1347	comment.comment = self.get_body_text(message_parts)
1348
1349	blog.create_comment(req, comment)
1350
1351	else:
1352	## create blog
1353	#
1354	import time
1355	post = BlogPost(self.env, 'blog_'+time.strftime("%Y%m%d%H%M%S", time.gmtime()))
1356
1357	#post = BlogPost(self.env, blog._get_default_postname(self.env))
1358
1359	post.author = self.author
1360	post.title = self.email_to_unicode(m['Subject'])
1361
1362	message_parts = self.get_message_parts(m)
1363	post.body = self.get_body_text(message_parts)
1364
1365	blog.create_post(req, post, self.author, u'Created by email2trac', False)
1366
1367
1368	########## Discussion functions ##############################################
1369
1370	def discussion_topic(self, content, subject):
1371
1372	## Import modules.
1373	#
1374	from tracdiscussion.api import DiscussionApi
1375	from trac.util.datefmt import to_timestamp, utc
1376
1377	self.logger.debug('Creating a new topic in forum:', self.id)
1378
1379	## Get dissussion API component.
1380	#
1381	api = self.env[DiscussionApi]
1382	context = self._create_context(content, subject)
1383
1384	## Get forum for new topic.
1385	#
1386	forum = api.get_forum(context, self.id)
1387
1388	if not forum:
1389	self.logger.error("ERROR: Replied forum doesn't exist")
1390
1391	## Prepare topic.
1392	#
1393	topic = {'forum' : forum['id'],
1394	'subject' : context.subject,
1395	'time': to_timestamp(datetime.now(utc)),
1396	'author' : self.author,
1397	'subscribers' : [self.email_addr],
1398	'body' : self.get_body_text(context.content_parts)}
1399
1400	## Add topic to DB and commit it.
1401	#
1402	self._add_topic(api, context, topic)
1403	self.db.commit()
1404
1405	def discussion_topic_reply(self, content, subject):
1406
1407	## Import modules.
1408	#
1409	from tracdiscussion.api import DiscussionApi
1410	from trac.util.datefmt import to_timestamp, utc
1411
1412	self.logger.debug('Replying to discussion topic', self.id)
1413
1414	## Get dissussion API component.
1415	#
1416	api = self.env[DiscussionApi]
1417	context = self._create_context(content, subject)
1418
1419	## Get replied topic.
1420	#
1421	topic = api.get_topic(context, self.id)
1422
1423	if not topic:
1424	self.logger.error("ERROR: Replied topic doesn't exist")
1425
1426	## Prepare message.
1427	#
1428	message = {'forum' : topic['forum'],
1429	'topic' : topic['id'],
1430	'replyto' : -1,
1431	'time' : to_timestamp(datetime.now(utc)),
1432	'author' : self.author,
1433	'body' : self.get_body_text(context.content_parts)}
1434
1435	## Add message to DB and commit it.
1436	#
1437	self._add_message(api, context, message)
1438	self.db.commit()
1439
1440	def discussion_message_reply(self, content, subject):
1441
1442	## Import modules.
1443	#
1444	from tracdiscussion.api import DiscussionApi
1445	from trac.util.datefmt import to_timestamp, utc
1446
1447	self.logger.debug('Replying to discussion message', self.id)
1448
1449	## Get dissussion API component.
1450	#
1451	api = self.env[DiscussionApi]
1452	context = self._create_context(content, subject)
1453
1454	## Get replied message.
1455	#
1456	message = api.get_message(context, self.id)
1457
1458	if not message:
1459	self.logger.error("ERROR: Replied message doesn't exist")
1460
1461	## Prepare message.
1462	#
1463	message = {'forum' : message['forum'],
1464	'topic' : message['topic'],
1465	'replyto' : message['id'],
1466	'time' : to_timestamp(datetime.now(utc)),
1467	'author' : self.author,
1468	'body' : self.get_body_text(context.content_parts)}
1469
1470	## Add message to DB and commit it.
1471	#
1472	self._add_message(api, context, message)
1473	self.db.commit()
1474
1475	def _create_context(self, content, subject):
1476
1477	## Import modules.
1478	#
1479	from trac.mimeview import Context
1480	from trac.web.api import Request
1481	from trac.perm import PermissionCache
1482
1483	## TODO: Read server base URL from config.
1484	# Create request object to mockup context creation.
1485	#
1486	environ = {'SERVER_PORT' : 80,
1487	'SERVER_NAME' : 'test',
1488	'REQUEST_METHOD' : 'POST',
1489	'wsgi.url_scheme' : 'http',
1490	'wsgi.input' : sys.stdin}
1491	chrome = {'links': {},
1492	'scripts': [],
1493	'ctxtnav': [],
1494	'warnings': [],
1495	'notices': []}
1496
1497	if self.env.base_url_for_redirect:
1498	environ['trac.base_url'] = self.env.base_url
1499
1500	req = Request(environ, None)
1501	req.chrome = chrome
1502	req.tz = 'missing'
1503	req.authname = self.author
1504	req.perm = PermissionCache(self.env, self.author)
1505	req.locale = None
1506
1507	## Create and return context.
1508	#
1509	context = Context.from_request(req)
1510	context.realm = 'discussion-email2trac'
1511	context.cursor = self.db.cursor()
1512	context.content = content
1513	context.subject = subject
1514
1515	## Read content parts from content.
1516	#
1517	context.content_parts = self.get_message_parts(content)
1518	context.content_parts = self.unique_attachment_names(
1519	context.content_parts)
1520
1521	return context
1522
1523	def _add_topic(self, api, context, topic):
1524	context.req.perm.assert_permission('DISCUSSION_APPEND')
1525
1526	## Filter topic.
1527	#
1528	for discussion_filter in api.discussion_filters:
1529	accept, topic_or_error = discussion_filter.filter_topic(
1530	context, topic)
1531	if accept:
1532	topic = topic_or_error
1533	else:
1534	raise TracError(topic_or_error)
1535
1536	## Add a new topic.
1537	#
1538	api.add_topic(context, topic)
1539
1540	## Get inserted topic with new ID.
1541	#
1542	topic = api.get_topic_by_time(context, topic['time'])
1543
1544	## Attach attachments.
1545	#
1546	self.id = topic['id']
1547	self.attach_attachments(context.content_parts, True)
1548
1549	## Notify change listeners.
1550	#
1551	for listener in api.topic_change_listeners:
1552	listener.topic_created(context, topic)
1553
1554	def _add_message(self, api, context, message):
1555	context.req.perm.assert_permission('DISCUSSION_APPEND')
1556
1557	## Filter message.
1558	#
1559	for discussion_filter in api.discussion_filters:
1560	accept, message_or_error = discussion_filter.filter_message(
1561	context, message)
1562	if accept:
1563	message = message_or_error
1564	else:
1565	raise TracError(message_or_error)
1566
1567	## Add message.
1568	#
1569	api.add_message(context, message)
1570
1571	## Get inserted message with new ID.
1572	#
1573	message = api.get_message_by_time(context, message['time'])
1574
1575	## Attach attachments.
1576	#
1577
1578	self.attach_attachments(context.content_parts, True)
1579
1580	## Notify change listeners.
1581	#
1582	for listener in api.message_change_listeners:
1583	listener.message_created(context, message)
1584
1585	########## MAIN function ######################################################
1586
1587	def parse(self, fp):
1588	"""
1589	"""
1590	self.logger.debug('Main function parse')
1591	global m
1592
1593	m = email.message_from_file(fp)
1594
1595	if not m:
1596	self.logger.debug('This is not a valid email message format')
1597	return
1598
1599	## Work around lack of header folding in Python; see http://bugs.python.org/issue4696
1600	#
1601	try:
1602	m.replace_header('Subject', m['Subject'].replace('\r', '').replace('\n', ''))
1603	except AttributeError, detail:
1604	pass
1605
1606	if self.parameters.debug: # save the entire e-mail message text
1607	self.save_email_for_debug(m, self.parameters.project_name, True)
1608
1609	self.db = self.env.get_db_cnx()
1610	self.get_sender_info(m)
1611
1612	if not self.email_header_acl('white_list', self.email_addr, True):
1613	self.logger.info('Message rejected : %s not in white list' %(self.email_addr))
1614	return False
1615
1616	if self.email_header_acl('black_list', self.email_addr, False):
1617	self.logger.info('Message rejected : %s in black list' %(self.email_addr))
1618	return False
1619
1620	if not self.email_header_acl('recipient_list', self.to_email_addr, True):
1621	self.logger.info('Message rejected : %s not in recipient list' %(self.to_email_addr))
1622	return False
1623
1624	## If spam drop the message
1625	#
1626	if self.spam(m) == 'drop':
1627	return False
1628
1629	elif self.spam(m) == 'spam':
1630	spam_msg = True
1631	else:
1632	spam_msg = False
1633
1634	if not m['Subject']:
1635	subject = 'No Subject'
1636	else:
1637	subject = self.email_to_unicode(m['Subject'])
1638
1639	## Bug in python logging module <2.6
1640	#
1641	self.logger.info('subject: %s' %repr(subject))
1642
1643	## [hic] #1529: Re: LRZ
1644	# [hic] #1529?owner=bas,priority=medium: Re: LRZ
1645	#
1646	ticket_regex = r'''
1647	(?P<new_fields>[#][?].*)
1648	\|(?P<reply>(?P<id>[#][\d]+)(?P<fields>\?.*)?:)
1649	'''
1650	## Check if FullBlogPlugin is installed
1651	#
1652	blog_enabled = None
1653	blog_regex = ''
1654	if self.get_config('components', 'tracfullblog.*') in ['enabled']:
1655	self.logger.debug('Trac BLOG support enabled')
1656	blog_enabled = True
1657	blog_regex = '''\|(?P<blog>blog:(?P<blog_id>\w*))'''
1658
1659
1660	## Check if DiscussionPlugin is installed
1661	#
1662	discussion_enabled = None
1663	discussion_regex = ''
1664	if self.get_config('components', 'tracdiscussion.api.discussionapi') in ['enabled']:
1665	self.logger.debug('Trac Discussion support enabled')
1666	discussion_enabled = True
1667	discussion_regex = r'''
1668	\|(?P<forum>Forum[ ][#](?P<forum_id>\d+)[ ]-[ ]?)
1669	\|(?P<topic>Topic[ ][#](?P<topic_id>\d+)[ ]-[ ]?)
1670	\|(?P<message>Message[ ][#](?P<message_id>\d+)[ ]-[ ]?)
1671	'''
1672
1673
1674	regex_str = ticket_regex + blog_regex + discussion_regex
1675	SYSTEM_RE = re.compile(regex_str, re.VERBOSE)
1676
1677	## Find out if this is a ticket, a blog or a discussion
1678	#
1679	result = SYSTEM_RE.search(subject)
1680
1681	if result:
1682	## update ticket + fields
1683	#
1684	if result.group('reply'):
1685	self.system = 'ticket'
1686
1687	## Skip the last ':' character
1688	#
1689	if not self.ticket_update(m, result.group('reply')[:-1], spam_msg):
1690	self.new_ticket(m, subject, spam_msg)
1691
1692	## New ticket + fields
1693	#
1694	elif result.group('new_fields'):
1695	self.system = 'ticket'
1696	self.new_ticket(m, subject[:result.start('new_fields')], spam_msg, result.group('new_fields'))
1697
1698	if blog_enabled:
1699	if result.group('blog'):
1700	self.system = 'blog'
1701	self.blog(result.group('blog_id'))
1702
1703	if discussion_enabled:
1704	## New topic.
1705	#
1706	if result.group('forum'):
1707	self.system = 'discussion'
1708	self.id = int(result.group('forum_id'))
1709	self.discussion_topic(m, subject[result.end('forum'):])
1710
1711	## Reply to topic.
1712	#
1713	elif result.group('topic'):
1714	self.system = 'discussion'
1715	self.id = int(result.group('topic_id'))
1716	self.discussion_topic_reply(m, subject[result.end('topic'):])
1717
1718	## Reply to topic message.
1719	#
1720	elif result.group('message'):
1721	self.system = 'discussion'
1722	self.id = int(result.group('message_id'))
1723	self.discussion_message_reply(m, subject[result.end('message'):])
1724
1725	else:
1726
1727	self.system = 'ticket'
1728	(matched_id, subject) = self.ticket_update_by_subject(subject)
1729
1730	if matched_id:
1731
1732	if not self.ticket_update(m, matched_id, spam_msg):
1733	self.new_ticket(m, subject, spam_msg)
1734
1735	else:
1736	## No update by subject, so just create a new ticket
1737	#
1738	self.new_ticket(m, subject, spam_msg)
1739
1740
1741	########## BODY TEXT functions ###########################################################
1742
1743	def strip_signature(self, text):
1744	"""
1745	Strip signature from message, inspired by Mailman software
1746	"""
1747	self.logger.debug('function strip_signature')
1748
1749	body = []
1750	for line in text.splitlines():
1751	if line == '-- ':
1752	break
1753	body.append(line)
1754
1755	return ('\n'.join(body))
1756
1757	def reflow(self, text, delsp = 0):
1758	"""
1759	Reflow the message based on the format="flowed" specification (RFC 3676)
1760	"""
1761	flowedlines = []
1762	quotelevel = 0
1763	prevflowed = 0
1764
1765	for line in text.splitlines():
1766	from re import match
1767
1768	## Figure out the quote level and the content of the current line
1769	#
1770	m = match('(>)( ?)(.)', line)
1771	linequotelevel = len(m.group(1))
1772	line = m.group(3)
1773
1774	## Determine whether this line is flowed
1775	#
1776	if line and line != '-- ' and line[-1] == ' ':
1777	flowed = 1
1778	else:
1779	flowed = 0
1780
1781	if flowed and delsp and line and line[-1] == ' ':
1782	line = line[:-1]
1783
1784	## If the previous line is flowed, append this line to it
1785	#
1786	if prevflowed and line != '-- ' and linequotelevel == quotelevel:
1787	flowedlines[-1] += line
1788
1789	## Otherwise, start a new line
1790	#
1791	else:
1792	flowedlines.append('>' * linequotelevel + line)
1793
1794	prevflowed = flowed
1795
1796
1797	return '\n'.join(flowedlines)
1798
1799	def strip_quotes(self, text):
1800	"""
1801	Strip quotes from message by Nicolas Mendoza
1802	"""
1803	self.logger.debug('function strip_quotes')
1804
1805	body = []
1806	for line in text.splitlines():
1807	try:
1808
1809	if line.startswith(self.parameters.email_quote):
1810	continue
1811
1812	except UnicodeDecodeError:
1813
1814	tmp_line = self.email_to_unicode(line)
1815	if tmp_line.startswith(self.parameters.email_quote):
1816	continue
1817
1818	body.append(line)
1819
1820	return ('\n'.join(body))
1821
1822	def inline_properties(self, text):
1823	"""
1824	Parse text if we use inline keywords to set ticket fields
1825	"""
1826	self.logger.debug('function inline_properties')
1827
1828	properties = dict()
1829	body = list()
1830
1831	INLINE_EXP = re.compile('\s[@]\s(\w+)\s:(.)$')
1832
1833	for line in text.splitlines():
1834	match = INLINE_EXP.match(line)
1835	if match:
1836	keyword, value = match.groups()
1837
1838	if self.parameters.inline_properties_first_wins:
1839	if keyword in self.properties.keys():
1840	continue
1841
1842	self.properties[keyword] = value.strip()
1843	self.logger.debug('\tinline properties: %s : %s' %(keyword,value))
1844
1845	else:
1846	body.append(line)
1847
1848	return '\n'.join(body)
1849
1850
1851	def wrap_text(self, text, replace_whitespace = False):
1852	"""
1853	Will break a lines longer then given length into several small
1854	lines of size given length
1855	"""
1856	import textwrap
1857
1858	LINESEPARATOR = '\n'
1859	reformat = ''
1860
1861	for s in text.split(LINESEPARATOR):
1862	tmp = textwrap.fill(s, self.parameters.use_textwrap)
1863	if tmp:
1864	reformat = '%s\n%s' %(reformat,tmp)
1865	else:
1866	reformat = '%s\n' %reformat
1867
1868	return reformat
1869
1870	# Python2.4 and higher
1871	#
1872	#return LINESEPARATOR.join(textwrap.fill(s,width) for s in str.split(LINESEPARATOR))
1873	#
1874
1875	########## EMAIL attachements functions ###########################################################
1876
1877	def inline_part(self, part):
1878	"""
1879	"""
1880	self.logger.debug('function inline_part()')
1881
1882	return part.get_param('inline', None, 'Content-Disposition') == '' or not part.has_key('Content-Disposition')
1883
1884	def get_message_parts(self, msg):
1885	"""
1886	parses the email message and returns a list of body parts and attachments
1887	body parts are returned as strings, attachments are returned as tuples of (filename, Message object)
1888	"""
1889	self.logger.debug('function get_message_parts()')
1890
1891	message_parts = list()
1892
1893	ALTERNATIVE_MULTIPART = False
1894
1895	for part in msg.walk():
1896	content_maintype = part.get_content_maintype()
1897	content_type = part.get_content_type()
1898
1899	self.logger.debug('\t Message part: Main-Type: %s' % content_maintype)
1900	self.logger.debug('\t Message part: Content-Type: %s' % content_type)
1901
1902	## Check content type
1903	#
1904	if content_type in self.STRIP_CONTENT_TYPES:
1905	self.logger.debug("\t A %s attachment named '%s' was skipped" %(content_type, part.get_filename()))
1906	continue
1907
1908	## Catch some mulitpart execptions
1909	#
1910	if content_type == 'multipart/alternative':
1911	ALTERNATIVE_MULTIPART = True
1912	continue
1913
1914	## Skip multipart containers
1915	#
1916	if content_maintype == 'multipart':
1917	self.logger.debug("\t Skipping multipart container")
1918	continue
1919
1920	## 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"
1921	#
1922	inline = self.inline_part(part)
1923
1924	## Drop HTML message
1925	#
1926	if ALTERNATIVE_MULTIPART and self.parameters.drop_alternative_html_version:
1927
1928	if content_type == 'text/html':
1929	self.logger.debug('\t Skipping alternative HTML message')
1930	ALTERNATIVE_MULTIPART = False
1931	continue
1932
1933
1934	## Save all non plain text message as attachment
1935	#
1936	if not content_type in ['text/plain']:
1937
1938	filename = part.get_filename()
1939
1940	s = '\t unicode filename: %s' %(filename)
1941	self.print_unicode(s)
1942	self.logger.debug('\t raw filename: %s' %repr(filename))
1943
1944	# 11 Aug 2011 -> Obsolete code
1945	## First try to use email header function to convert filename.
1946	# If this fails the use the plain filename
1947	#
1948	#name = part.get_filename()
1949	#try:
1950	# print repr(name), len(name)
1951	# filename = self.email_to_unicode(part.get_filename())
1952	# print "Bas: ", repr(filename), len(filename)
1953	#except UnicodeEncodeError, detail:
1954	# print "Bas", repr(detail)
1955	# filename = part.get_filename()
1956
1957	message_parts.append( (self.check_filename_length(filename), part) )
1958
1959	## We van only convert html messages
1960	#
1961	if not content_type == 'text/html':
1962	self.logger.debug('\t Appending content_type = %s' %(content_type))
1963	continue
1964
1965	if not inline:
1966	self.logger.debug('\t Skipping %s, not an inline messsage part' %(content_type))
1967	continue
1968
1969	## Try to decode message part. We have a html or plain text messafe
1970	#
1971	body_text = part.get_payload(decode=1)
1972	if not body_text:
1973	body_text = part.get_payload(decode=0)
1974
1975	## Try to convert html message
1976	#
1977	if content_type == 'text/html':
1978
1979	body_text = self.html_2_txt(body_text)
1980	if not body_text:
1981	continue
1982
1983	format = email.Utils.collapse_rfc2231_value(part.get_param('Format', 'fixed')).lower()
1984	delsp = email.Utils.collapse_rfc2231_value(part.get_param('DelSp', 'no')).lower()
1985
1986	if self.parameters.reflow and not self.parameters.verbatim_format and format == 'flowed':
1987	body_text = self.reflow(body_text, delsp == 'yes')
1988
1989	if self.parameters.strip_signature:
1990	body_text = self.strip_signature(body_text)
1991
1992	if self.parameters.strip_quotes:
1993	body_text = self.strip_quotes(body_text)
1994
1995	if self.parameters.inline_properties:
1996	body_text = self.inline_properties(body_text)
1997
1998	if self.parameters.use_textwrap:
1999	body_text = self.wrap_text(body_text)
2000
2001	## Get contents charset (iso-8859-15 if not defined in mail headers)
2002	#
2003	charset = part.get_content_charset()
2004	if not charset:
2005	charset = 'iso-8859-15'
2006
2007	try:
2008	ubody_text = unicode(body_text, charset)
2009
2010	except UnicodeError, detail:
2011	ubody_text = unicode(body_text, 'iso-8859-15')
2012
2013	except LookupError, detail:
2014	ubody_text = 'ERROR: Could not find charset: %s, please install' %(charset)
2015
2016	if self.parameters.verbatim_format:
2017	message_parts.append('{{{\r\n%s\r\n}}}' %ubody_text)
2018	else:
2019	message_parts.append('%s' %ubody_text)
2020
2021	return message_parts
2022
2023	def unique_attachment_names(self, message_parts):
2024	"""
2025	Make sure we have unique names attachments:
2026	- check if it contains illegal characters
2027	- Rename "None" filenames to "untitled-part"
2028	"""
2029	self.logger.debug('function unique_attachment_names()')
2030	renamed_parts = []
2031	attachment_names = set()
2032
2033	for item in message_parts:
2034
2035	## If not an attachment, leave it alone
2036	#
2037	if not isinstance(item, tuple):
2038	renamed_parts.append(item)
2039	continue
2040
2041	(filename, part) = item
2042
2043	## If filename = None, use a default one
2044	#
2045	if filename in [ 'None']:
2046	filename = 'untitled-part'
2047	self.logger.info('\t Rename filename "None" to: %s' %filename)
2048
2049	## Guess the extension from the content type, use non strict mode
2050	# some additional non-standard but commonly used MIME types
2051	# are also recognized
2052	#
2053	ext = mimetypes.guess_extension(part.get_content_type(), False)
2054	if not ext:
2055	ext = '.bin'
2056
2057	filename = '%s%s' % (filename, ext)
2058
2059	## Discard relative paths for windows/unix in attachment names
2060	#
2061	filename = filename.replace('\\', '_')
2062	filename = filename.replace('/', '_')
2063
2064	## remove linefeed char
2065	#
2066	for forbidden_char in ['\r', '\n']:
2067	filename = filename.replace(forbidden_char,'')
2068
2069	## We try to normalize the filename to utf-8 NFC if we can.
2070	# Files uploaded from OS X might be in NFD.
2071	# Check python version and then try it
2072	#
2073	#if sys.version_info[0] > 2 or (sys.version_info[0] == 2 and sys.version_info[1] >= 3):
2074	# try:
2075	# filename = unicodedata.normalize('NFC', unicode(filename, 'utf-8')).encode('utf-8')
2076	# except TypeError:
2077	# pass
2078
2079	## Make the filename unique for this ticket
2080	#
2081	num = 0
2082	unique_filename = filename
2083	dummy_filename, ext = os.path.splitext(filename)
2084
2085	while (unique_filename in attachment_names) or self.attachment_exists(unique_filename):
2086	num += 1
2087	unique_filename = "%s-%s%s" % (dummy_filename, num, ext)
2088
2089	s = '\t Attachment with filename %s will be saved as %s' % (filename, unique_filename)
2090	self.print_unicode(s)
2091
2092	attachment_names.add(unique_filename)
2093
2094	renamed_parts.append((filename, unique_filename, part))
2095
2096	return renamed_parts
2097
2098
2099	def attachment_exists(self, filename):
2100
2101	self.logger.debug("function attachment_exists")
2102
2103	s = '\t check if attachment already exists: Id : %s, Filename : %s' %(self.id, filename)
2104	self.print_unicode(s)
2105
2106	## Do we have a valid ticket id
2107	#
2108	if not self.id:
2109	return False
2110
2111	try:
2112	if self.system == 'discussion':
2113
2114	att = attachment.Attachment(self.env, 'discussion', 'ticket/%s' % (self.id,), filename)
2115
2116	else:
2117
2118	att = attachment.Attachment(self.env, 'ticket', self.id, filename)
2119
2120	return True
2121
2122	except attachment.ResourceNotFound:
2123
2124	return False
2125
2126	########## TRAC Ticket Text ###########################################################
2127
2128	def get_body_text(self, message_parts):
2129	"""
2130	"""
2131	self.logger.debug('function get_body_text()')
2132
2133	body_text = []
2134
2135	for part in message_parts:
2136
2137	## Plain text part, append it
2138	#
2139	if not isinstance(part, tuple):
2140	body_text.extend(part.strip().splitlines())
2141	body_text.append("")
2142	continue
2143
2144	(original, filename, part) = part
2145	inline = self.inline_part(part)
2146
2147	## Skip generation of attachment link if html is converted to text
2148	#
2149	if part.get_content_type() == 'text/html' and self.parameters.html2text_cmd and inline:
2150	s = 'Skipping attachment link for html part: %s' %(filename)
2151	self.print_unicode(s)
2152	continue
2153
2154	if part.get_content_maintype() == 'image' and inline:
2155
2156	if self.system != 'discussion':
2157	s = 'wiki image link for: %s' %(filename)
2158	self.print_unicode(s)
2159	body_text.append('[[Image(%s)]]' % filename)
2160
2161	body_text.append("")
2162
2163	else:
2164
2165	if self.system != 'discussion':
2166
2167	s = 'wiki attachment link for: %s' %(filename)
2168	self.print_unicode(s)
2169	body_text.append('[attachment:"%s"]' % filename)
2170
2171	body_text.append("")
2172
2173	## Convert list body_texts to string
2174	#
2175	body_text = '\r\n'.join(body_text)
2176	return body_text
2177
2178	def html_mailto_link(self, subject):
2179	"""
2180	This function returns a HTML mailto tag with the ticket id and author email address
2181	"""
2182	self.logger.debug("function html_mailto_link")
2183	if not self.author:
2184	author = self.email_addr
2185	else:
2186	author = self.author
2187
2188	if not self.parameters.mailto_cc:
2189	self.parameters.mailto_cc = ''
2190
2191	## use urllib to escape the chars
2192	#
2193	s = '%s?Subject=%s&cc=%s' %(
2194	urllib.quote(self.email_addr),
2195	urllib.quote('Re: #%s: %s' %(self.id, subject)),
2196	urllib.quote(self.parameters.mailto_cc)
2197	)
2198
2199	if self.VERSION in [ 0.10 ]:
2200	s = '\r\n{{{\r\n#!html\r\n<a\r\n href="mailto:%s">Reply to: %s\r\n</a>\r\n}}}\r\n' %(s, author)
2201	else:
2202	s = '[mailto:"%s" Reply to: %s]' %(s, author)
2203
2204	self.logger.debug("\tmailto link %s" %s)
2205	return s
2206
2207	########## TRAC notify section ###########################################################
2208
2209	def notify(self, tkt, new=True, modtime=0):
2210	"""
2211	A wrapper for the TRAC notify function. So we can use templates
2212	"""
2213	self.logger.debug('function notify()')
2214
2215	if self.parameters.notify_reporter:
2216	self.logger.debug('\t Notify reporter set')
2217	global sender_email
2218	sender_email = self.email_addr
2219
2220	self.logger.debug('\t Using Email2TracNotification function AlwaysNotifyReporter')
2221	import trac.notification as Email2TracNotification
2222	Email2TracNotification.Notify.notify = AlwaysNotifyReporter
2223
2224	if self.parameters.dry_run :
2225	self.logger.info('DRY_RUN: self.notify(tkt, True) reporter = %s' %tkt['reporter'])
2226	return
2227	try:
2228
2229	#from trac.ticket.notification import TicketNotificationSystem
2230	#tn_sys = TicketNotificationSystem(self.env)
2231	#print tn_sys
2232	#print tn_sys.__dict__
2233	#sys.exit(0)
2234
2235	## create false {abs_}href properties, to trick Notify()
2236	#
2237	if self.VERSION in [0.10]:
2238	self.env.abs_href = Href(self.get_config('project', 'url'))
2239	self.env.href = Href(self.get_config('project', 'url'))
2240
2241	tn = TicketNotifyEmail(self.env)
2242
2243	if self.parameters.alternate_notify_template:
2244
2245	if self.VERSION >= 0.11:
2246
2247	from trac.web.chrome import Chrome
2248
2249	if self.parameters.alternate_notify_template_update and not new:
2250	tn.template_name = self.parameters.alternate_notify_template_update
2251	else:
2252	tn.template_name = self.parameters.alternate_notify_template
2253
2254	tn.template = Chrome(tn.env).load_template(tn.template_name, method='text')
2255
2256	else:
2257
2258	tn.template_name = self.parameters.alternate_notify_template
2259
2260	tn.notify(tkt, new, modtime)
2261
2262	except Exception, e:
2263	self.logger.error('Failure sending notification on creation of ticket #%s: %s' %(self.id, e))
2264
2265	########## END Class Definition ########################################################
2266
2267	########## Global Notificaition Function ################################################
2268	def AlwaysNotifyReporter(self, resid):
2269	"""
2270	Copy of def notify() to manipulate recipents to always include reporter for the
2271	notification.
2272	"""
2273	(torcpts, ccrcpts) = self.get_recipients(resid)
2274
2275	print torcpts, ccrcpts, sender_email
2276
2277	if not tktparser.email_header_acl('notify_reporter_black_list', sender_email, False):
2278	## additionally append sender (regardeless of settings in trac.ini)
2279	#
2280	if not sender_email in torcpts:
2281	torcpts.append(sender_email)
2282
2283	self.begin_send()
2284	self.send(torcpts, ccrcpts)
2285	self.finish_send()
2286
2287	########## Parse Config File ###########################################################
2288
2289	def ReadConfig(file, name):
2290	"""
2291	Parse the config file
2292	"""
2293	if not os.path.isfile(file):
2294	print 'File %s does not exist' %file
2295	sys.exit(1)
2296
2297	config = trac_config.Configuration(file)
2298
2299	parentdir = config.get('DEFAULT', 'parentdir')
2300	sections = config.sections()
2301
2302	## use some trac internals to get the defaults
2303	#
2304	tmp = config.parser.defaults()
2305	project = SaraDict()
2306
2307	for option, value in tmp.items():
2308	try:
2309	project[option] = int(value)
2310	except ValueError:
2311	project[option] = value
2312
2313	if name:
2314	if name in sections:
2315	project = SaraDict()
2316	for option, value in config.options(name):
2317	try:
2318	project[option] = int(value)
2319	except ValueError:
2320	project[option] = value
2321
2322	elif not parentdir:
2323	print "Not a valid project name: %s, valid names are: %s" %(name, sections)
2324	print "or set parentdir in the [DEFAULT] section"
2325	sys.exit(1)
2326
2327	## If parentdir then set project dir to parentdir + name
2328	#
2329	if not project.has_key('project'):
2330	if not parentdir:
2331	print "You must set project or parentdir in your configuration file"
2332	sys.exit(1)
2333	elif not name:
2334	print "You must configure a project section in your configuration file"
2335	else:
2336	project['project'] = os.path.join(parentdir, name)
2337
2338	##
2339	# Save the project name
2340	#
2341	project['project_name'] = os.path.basename(project['project'])
2342
2343	return project
2344
2345	########## Setup Logging ###############################################################
2346
2347	def setup_log(parameters, project_name, interactive=None):
2348	"""
2349	Setup logging
2350
2351	Note for log format the usage of `$(...)s` instead of `%(...)s` as the latter form
2352	would be interpreted by the ConfigParser itself.
2353	"""
2354	logger = logging.getLogger('email2trac %s' %project_name)
2355
2356	if interactive:
2357	parameters.log_type = 'stderr'
2358
2359	if not parameters.log_type:
2360	if sys.platform in ['win32', 'cygwin']:
2361	parameters.log_type = 'eventlog'
2362	else:
2363	parameters.log_type = 'syslog'
2364
2365	if parameters.log_type == 'file':
2366
2367	if not parameters.log_file:
2368	parameters.log_file = 'email2trac.log'
2369
2370	if not os.path.isabs(parameters.log_file):
2371	parameters.log_file = os.path.join(tempfile.gettempdir(), parameters.log_file)
2372
2373	log_handler = logging.FileHandler(parameters.log_file)
2374
2375	elif parameters.log_type in ('winlog', 'eventlog', 'nteventlog'):
2376	## Requires win32 extensions
2377	#
2378	logid = "email2trac"
2379	log_handler = logging.handlers.NTEventLogHandler(logid, logtype='Application')
2380
2381	elif parameters.log_type in ('syslog', 'unix'):
2382	log_handler = logging.handlers.SysLogHandler('/dev/log')
2383
2384	elif parameters.log_type in ('stderr'):
2385	log_handler = logging.StreamHandler(sys.stderr)
2386
2387	else:
2388	log_handler = logging.handlers.BufferingHandler(0)
2389
2390	if parameters.log_format:
2391	parameters.log_format = parameters.log_format.replace('$(', '%(')
2392	else:
2393	parameters.log_format = '%(name)s: %(message)s'
2394	if parameters.log_type in ('file', 'stderr'):
2395	parameters.log_format = '%(asctime)s ' + parameters.log_format
2396
2397	log_formatter = logging.Formatter(parameters.log_format)
2398	log_handler.setFormatter(log_formatter)
2399	logger.addHandler(log_handler)
2400
2401	if (parameters.log_level in ['DEBUG', 'ALL']) or (parameters.debug > 0):
2402	logger.setLevel(logging.DEBUG)
2403	parameters.debug = 1
2404
2405	elif parameters.log_level in ['INFO'] or parameters.verbose:
2406	logger.setLevel(logging.INFO)
2407
2408	elif parameters.log_level in ['WARNING']:
2409	logger.setLevel(logging.WARNING)
2410
2411	elif parameters.log_level in ['ERROR']:
2412	logger.setLevel(logging.ERROR)
2413
2414	elif parameters.log_level in ['CRITICAL']:
2415	logger.setLevel(logging.CRITICAL)
2416
2417	else:
2418	logger.setLevel(logging.INFO)
2419
2420	return logger
2421
2422
2423	if __name__ == '__main__':
2424	## Default config file
2425	#
2426	configfile = '@email2trac_conf@'
2427	project = ''
2428	component = ''
2429	ticket_prefix = 'default'
2430	dry_run = None
2431	verbose = None
2432	debug_interactive = None
2433
2434	SHORT_OPT = 'cdhf:np:t:v'
2435	LONG_OPT = ['component=', 'debug', 'dry-run', 'help', 'file=', 'project=', 'ticket_prefix=', 'verbose']
2436
2437	try:
2438	opts, args = getopt.getopt(sys.argv[1:], SHORT_OPT, LONG_OPT)
2439	except getopt.error,detail:
2440	print __doc__
2441	print detail
2442	sys.exit(1)
2443
2444	project_name = None
2445	for opt,value in opts:
2446	if opt in [ '-h', '--help']:
2447	print __doc__
2448	sys.exit(0)
2449	elif opt in ['-c', '--component']:
2450	component = value
2451	elif opt in ['-d', '--debug']:
2452	debug_interactive = 1
2453	elif opt in ['-f', '--file']:
2454	configfile = value
2455	elif opt in ['-n', '--dry-run']:
2456	dry_run = True
2457	elif opt in ['-p', '--project']:
2458	project_name = value
2459	elif opt in ['-t', '--ticket_prefix']:
2460	ticket_prefix = value
2461	elif opt in ['-v', '--verbose']:
2462	verbose = True
2463
2464	settings = ReadConfig(configfile, project_name)
2465
2466	## The default prefix for ticket values in email2trac.conf
2467	#
2468	settings.ticket_prefix = ticket_prefix
2469	settings.dry_run = dry_run
2470	settings.verbose = verbose
2471
2472	if not settings.debug and debug_interactive:
2473	settings.debug = debug_interactive
2474
2475	if not settings.project:
2476	print __doc__
2477	print 'No Trac project is defined in the email2trac config file.'
2478	sys.exit(1)
2479
2480	logger = setup_log(settings, os.path.basename(settings.project), debug_interactive)
2481
2482	if component:
2483	settings['component'] = component
2484
2485	## Determine major trac version used to be in email2trac.conf
2486	# Quick hack for 0.12
2487	#
2488	version = '0.%s' %(trac_version.split('.')[1])
2489	if version.startswith('0.12'):
2490	version = '0.12'
2491	elif version.startswith('0.13'):
2492	version = '0.13'
2493
2494	logger.debug("Found trac version: %s" %(version))
2495
2496	try:
2497	if version == '0.10':
2498	from trac import attachment
2499	from trac.env import Environment
2500	from trac.ticket import Ticket
2501	from trac.web.href import Href
2502	from trac import util
2503	from trac.ticket.web_ui import TicketModule
2504
2505	#
2506	# return util.text.to_unicode(str)
2507	#
2508	# see http://projects.edgewall.com/trac/changeset/2799
2509	from trac.ticket.notification import TicketNotifyEmail
2510	from trac import config as trac_config
2511	from trac.core import TracError
2512
2513	elif version in ['0.11', '0.12', '0.13']:
2514	from trac import attachment
2515	from trac import config as trac_config
2516	from trac import util
2517	from trac.core import TracError
2518	from trac.env import Environment
2519	from trac.perm import PermissionSystem
2520	from trac.perm import PermissionCache
2521	from trac.test import Mock, MockPerm
2522	from trac.ticket import Ticket
2523	from trac.ticket.api import TicketSystem
2524	from trac.ticket.web_ui import TicketModule
2525	from trac.web.href import Href
2526
2527	#
2528	# return util.text.to_unicode(str)
2529	#
2530	# see http://projects.edgewall.com/trac/changeset/2799
2531	from trac.ticket.notification import TicketNotifyEmail
2532
2533	else:
2534	logger.error('TRAC version %s is not supported' %version)
2535	sys.exit(0)
2536
2537	## Must be set before environment is created
2538	#
2539	if settings.has_key('python_egg_cache'):
2540	python_egg_cache = str(settings['python_egg_cache'])
2541	os.environ['PYTHON_EGG_CACHE'] = python_egg_cache
2542
2543	if settings.debug > 0:
2544	logger.debug('Loading environment %s', settings.project)
2545
2546	try:
2547	env = Environment(settings['project'], create=0)
2548	except IOError, detail:
2549	logger.error("trac error: %s" %detail)
2550	sys.exit(0)
2551
2552	tktparser = TicketEmailParser(env, settings, logger, float(version))
2553	tktparser.parse(sys.stdin)
2554
2555	## Catch all errors and use the logging module
2556	#
2557	except Exception, error:
2558
2559	etype, evalue, etb = sys.exc_info()
2560	for e in traceback.format_exception(etype, evalue, etb):
2561	logger.critical(e)
2562
2563	if m:
2564	tktparser.save_email_for_debug(m, settings.project_name, True)
2565
2566	sys.exit(1)
2567	# EOB

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format