Context Navigation

source: trunk/email2trac.py.in @ 210

Last change on this file since 210 was 210, checked in by bas, 16 years ago

email2trac.py.in:

closes tickets #60, #39, #56
preparing for new release 0.30

Property svn:executable set to *
Property svn:keywords set to Id

File size: 30.2 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 tickets to Trac.
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
30	Changed By: Bas van der Vlies <basv@sara.nl>
31	Date : 13 September 2005
32	Descr. : Added config file and command line options, spam level
33	detection, reply address and mailto option. Unicode support
34
35	Changed By: Walter de Jong <walter@sara.nl>
36	Descr. : multipart-message code and trac attachments
37
38
39	The scripts reads emails from stdin and inserts directly into a Trac database.
40	MIME headers are mapped as follows:
41
42	* From: => Reporter
43	=> CC (Optional via reply_all option)
44	* Subject: => Summary
45	* Body => Description
46	* Component => Can be set to SPAM via spam_level option
47
48	How to use
49	----------
50	* Create an config file:
51	[DEFAULT] # REQUIRED
52	project : /data/trac/test # REQUIRED
53	debug : 1 # OPTIONAL, if set print some DEBUG info
54	spam_level : 4 # OPTIONAL, if set check for SPAM mail
55	reply_all : 1 # OPTIONAL, if set then fill in ticket CC field
56	umask : 022 # OPTIONAL, if set then use this umask for creation of the attachments
57	mailto_link : 1 # OPTIONAL, if set then [mailto:<>] in description
58	mailto_cc : basv@sara.nl # OPTIONAL, use this address as CC in mailto line
59	ticket_update: 1 # OPTIONAL, if set then check if this is an update for a ticket
60	trac_version : 0.9 # OPTIONAL, default is 0.10
61
62	[jouvin] # OPTIONAL project declaration, if set both fields necessary
63	project : /data/trac/jouvin # use -p\|--project jouvin.
64
65	* default config file is : /etc/email2trac.conf
66
67	* Commandline opions:
68	-h,--help
69	-f,--file <configuration file>
70	-n,--dry-run
71	-p, --project <project name>
72	-t, --ticket_prefix <name>
73
74	SVN Info:
75	$Id: email2trac.py.in 210 2008-05-30 10:43:21Z bas $
76	"""
77	import os
78	import sys
79	import string
80	import getopt
81	import stat
82	import time
83	import email
84	import email.Iterators
85	import email.Header
86	import re
87	import urllib
88	import unicodedata
89	import ConfigParser
90	from stat import *
91	import mimetypes
92	import traceback
93
94
95	# Will fail where unavailable, e.g. Windows
96	#
97	try:
98	import syslog
99	SYSLOG_AVAILABLE = True
100	except ImportError:
101	SYSLOG_AVAILABLE = False
102
103	from datetime import tzinfo, timedelta, datetime
104	from trac import config as trac_config
105
106	# Some global variables
107	#
108	trac_default_version = '0.10'
109	m = None
110
111	# A UTC class needed for trac version 0.11, added by
112	# tbaschak at ktc dot mb dot ca
113	#
114	class UTC(tzinfo):
115	"""UTC"""
116	ZERO = timedelta(0)
117	HOUR = timedelta(hours=1)
118
119	def utcoffset(self, dt):
120	return self.ZERO
121
122	def tzname(self, dt):
123	return "UTC"
124
125	def dst(self, dt):
126	return self.ZERO
127
128
129	class TicketEmailParser(object):
130	env = None
131	comment = '> '
132
133	def __init__(self, env, parameters, version):
134	self.env = env
135
136	# Database connection
137	#
138	self.db = None
139
140	# Save parameters
141	#
142	self.parameters = parameters
143
144	# Some useful mail constants
145	#
146	self.author = None
147	self.email_addr = None
148	self.email_from = None
149
150	self.VERSION = version
151	self.DRY_RUN = parameters['dry_run']
152
153	self.get_config = self.env.config.get
154
155	if parameters.has_key('umask'):
156	os.umask(int(parameters['umask'], 8))
157
158	if parameters.has_key('debug'):
159	self.DEBUG = int(parameters['debug'])
160	else:
161	self.DEBUG = 0
162
163	if parameters.has_key('mailto_link'):
164	self.MAILTO = int(parameters['mailto_link'])
165	if parameters.has_key('mailto_cc'):
166	self.MAILTO_CC = parameters['mailto_cc']
167	else:
168	self.MAILTO_CC = ''
169	else:
170	self.MAILTO = 0
171
172	if parameters.has_key('spam_level'):
173	self.SPAM_LEVEL = int(parameters['spam_level'])
174	else:
175	self.SPAM_LEVEL = 0
176
177	if parameters.has_key('spam_header'):
178	self.SPAM_HEADER = parameters['spam_header']
179	else:
180	self.SPAM_HEADER = 'X-Spam-Score'
181
182	if parameters.has_key('email_quote'):
183	self.EMAIL_QUOTE = str(parameters['email_quote'])
184	else:
185	self.EMAIL_QUOTE = '> '
186
187	if parameters.has_key('email_header'):
188	self.EMAIL_HEADER = int(parameters['email_header'])
189	else:
190	self.EMAIL_HEADER = 0
191
192	if parameters.has_key('alternate_notify_template'):
193	self.notify_template = str(parameters['alternate_notify_template'])
194	else:
195	self.notify_template = None
196
197	if parameters.has_key('reply_all'):
198	self.REPLY_ALL = int(parameters['reply_all'])
199	else:
200	self.REPLY_ALL = 0
201
202	if parameters.has_key('ticket_update'):
203	self.TICKET_UPDATE = int(parameters['ticket_update'])
204	else:
205	self.TICKET_UPDATE = 0
206
207	if parameters.has_key('drop_spam'):
208	self.DROP_SPAM = int(parameters['drop_spam'])
209	else:
210	self.DROP_SPAM = 0
211
212	if parameters.has_key('verbatim_format'):
213	self.VERBATIM_FORMAT = int(parameters['verbatim_format'])
214	else:
215	self.VERBATIM_FORMAT = 1
216
217	if parameters.has_key('strip_signature'):
218	self.STRIP_SIGNATURE = int(parameters['strip_signature'])
219	else:
220	self.STRIP_SIGNATURE = 0
221
222	if parameters.has_key('strip_quotes'):
223	self.STRIP_QUOTES = int(parameters['strip_quotes'])
224	else:
225	self.STRIP_QUOTES = 0
226
227	if parameters.has_key('use_textwrap'):
228	self.USE_TEXTWRAP = int(parameters['use_textwrap'])
229	else:
230	self.USE_TEXTWRAP = 0
231
232	if parameters.has_key('python_egg_cache'):
233	self.python_egg_cache = str(parameters['python_egg_cache'])
234	os.environ['PYTHON_EGG_CACHE'] = self.python_egg_cache
235
236	# Use OS independend functions
237	#
238	self.TMPDIR = os.path.normcase('/tmp')
239	if parameters.has_key('tmpdir'):
240	self.TMPDIR = os.path.normcase(str(parameters['tmpdir']))
241
242	if parameters.has_key('ignore_trac_user_settings'):
243	self.IGNORE_TRAC_USER_SETTINGS = int(parameters['ignore_trac_user_settings'])
244	else:
245	self.IGNORE_TRAC_USER_SETTINGS = 0
246
247	def spam(self, message):
248	"""
249	# X-Spam-Score: *** (3.255) BAYES_50,DNS_FROM_AHBL_RHSBL,HTML_
250	# Note if Spam_level then '*' are included
251	"""
252	spam = False
253	if message.has_key(self.SPAM_HEADER):
254	spam_l = string.split(message[self.SPAM_HEADER])
255
256	try:
257	number = spam_l[0].count('*')
258	except IndexError, detail:
259	number = 0
260
261	if number >= self.SPAM_LEVEL:
262	spam = True
263
264	# treat virus mails as spam
265	#
266	elif message.has_key('X-Virus-found'):
267	spam = True
268
269	# How to handle SPAM messages
270	#
271	if self.DROP_SPAM and spam:
272	if self.DEBUG > 2 :
273	print 'This message is a SPAM. Automatic ticket insertion refused (SPAM level > %d' % self.SPAM_LEVEL
274
275	return 'drop'
276
277	elif spam:
278
279	return 'Spam'
280
281	else:
282
283	return False
284
285
286	def blacklisted_from(self):
287	"""
288	This function wil check if the email address is in the black list
289	"""
290	try:
291	black_list = self.parameters['black_list']
292	except KeyError, detail:
293	black_list = 'MAILER-DAEMON@'
294
295	black_list = string.split(black_list)
296	if not black_list.count('MAILER-DAEMON@'):
297	black_list.append('MAILER-DAEMON@')
298
299	for entry in black_list:
300	entry = entry.strip()
301	FROM_RE = re.compile(entry, re.VERBOSE\|re.IGNORECASE)
302	result = FROM_RE.search(self.email_addr)
303	if result:
304	return True
305
306	return False
307
308	def email_to_unicode(self, message_str):
309	"""
310	Email has 7 bit ASCII code, convert it to unicode with the charset
311	that is encoded in 7-bit ASCII code and encode it as utf-8 so Trac
312	understands it.
313	"""
314	results = email.Header.decode_header(message_str)
315	str = None
316	for text,format in results:
317	if format:
318	try:
319	temp = unicode(text, format)
320	except UnicodeError, detail:
321	# This always works
322	#
323	temp = unicode(text, 'iso-8859-15')
324	except LookupError, detail:
325	#text = 'ERROR: Could not find charset: %s, please install' %format
326	#temp = unicode(text, 'iso-8859-15')
327	temp = message_str
328
329	else:
330	temp = string.strip(text)
331	temp = unicode(text, 'iso-8859-15')
332
333	if str:
334	str = '%s %s' %(str, temp)
335	else:
336	str = '%s' %temp
337
338	#str = str.encode('utf-8')
339	return str
340
341	def debug_attachments(self, message):
342	n = 0
343	for part in message.walk():
344	if part.get_content_maintype() == 'multipart': # multipart/* is just a container
345	print 'TD: multipart container'
346	continue
347
348	n = n + 1
349	print 'TD: part%d: Content-Type: %s' % (n, part.get_content_type())
350	print 'TD: part%d: filename: %s' % (n, part.get_filename())
351
352	if part.is_multipart():
353	print 'TD: this part is multipart'
354	payload = part.get_payload(decode=1)
355	print 'TD: payload:', payload
356	else:
357	print 'TD: this part is not multipart'
358
359	file = 'part%d' %n
360	part_file = os.path.join(self.TMPDIR, file)
361	#part_file = '/var/tmp/part%d' % n
362	print 'TD: writing part%d (%s)' % (n,part_file)
363	fx = open(part_file, 'wb')
364	text = part.get_payload(decode=1)
365	if not text:
366	text = '(None)'
367	fx.write(text)
368	fx.close()
369	try:
370	os.chmod(part_file,S_IRWXU\|S_IRWXG\|S_IRWXO)
371	except OSError:
372	pass
373
374	def email_header_txt(self, m):
375	"""
376	Display To and CC addresses in description field
377	"""
378	str = ''
379	if m['To'] and len(m['To']) > 0 and m['To'] != 'hic@sara.nl':
380	str = "'''To:''' %s [[BR]]" %(m['To'])
381	if m['Cc'] and len(m['Cc']) > 0:
382	str = "%s'''Cc:''' %s [[BR]]" % (str, m['Cc'])
383
384	return self.email_to_unicode(str)
385
386
387	def set_owner(self, ticket):
388	"""
389	Select default owner for ticket component
390	"""
391	#### return self.get_config('ticket', 'default_component')
392	cursor = self.db.cursor()
393	sql = "SELECT owner FROM component WHERE name='%s'" % ticket['component']
394	cursor.execute(sql)
395	try:
396	ticket['owner'] = cursor.fetchone()[0]
397	except TypeError, detail:
398	ticket['owner'] = None
399
400	def get_sender_info(self, message):
401	"""
402	Get the default author name and email address from the message
403	"""
404
405	self.email_from = self.email_to_unicode(message['from'])
406	self.author, self.email_addr = email.Utils.parseaddr(self.email_from)
407
408	# Maybe for later user
409	#self.email_from = self.email_to_unicode(self.email_addr)
410
411
412	if self.IGNORE_TRAC_USER_SETTINGS:
413	return
414
415	# Is this a registered user, use email address as search key:
416	# result:
417	# u : login name
418	# n : Name that the user has set in the settings tab
419	# e : email address that the user has set in the settings tab
420	#
421	users = [ (u,n,e) for (u, n, e) in self.env.get_known_users(self.db)
422	if e == self.email_addr ]
423
424	if len(users) == 1:
425	self.email_from = users[0][0]
426
427	def set_reply_fields(self, ticket, message):
428	"""
429	Set all the right fields for a new ticket
430	"""
431	ticket['reporter'] = self.email_from
432
433	# Put all CC-addresses in ticket CC field
434	#
435	if self.REPLY_ALL:
436	#tos = message.get_all('to', [])
437	ccs = message.get_all('cc', [])
438
439	addrs = email.Utils.getaddresses(ccs)
440	if not addrs:
441	return
442
443	# Remove reporter email address if notification is
444	# on
445	#
446	if self.notification:
447	try:
448	addrs.remove((self.author, self.email_addr))
449	except ValueError, detail:
450	pass
451
452	for name,mail in addrs:
453	try:
454	mail_list = '%s, %s' %(mail_list, mail)
455	except:
456	mail_list = mail
457
458	if mail_list:
459	ticket['cc'] = self.email_to_unicode(mail_list)
460
461	def save_email_for_debug(self, message, tempfile=False):
462	if tempfile:
463	import tempfile
464	msg_file = tempfile.mktemp('.email2trac')
465	else:
466	#msg_file = '/var/tmp/msg.txt'
467	msg_file = os.path.join(self.TMPDIR, 'msg.txt')
468
469	print 'TD: saving email to %s' % msg_file
470	fx = open(msg_file, 'wb')
471	fx.write('%s' % message)
472	fx.close()
473	try:
474	os.chmod(msg_file,S_IRWXU\|S_IRWXG\|S_IRWXO)
475	except OSError:
476	pass
477
478	def str_to_dict(self, str):
479	"""
480	Transfrom a str of the form [<key>=<value>]+ to dict[<key>] = <value>
481	"""
482	# Skip the last ':' character
483	#
484	fields = string.split(str[:-1], ',')
485
486	result = dict()
487	for field in fields:
488	try:
489	index, value = string.split(field,'=')
490
491	# We can not change the description of a ticket via the subject
492	# line. The description is the body of the email
493	#
494	if index.lower() in ['description']:
495	continue
496
497	if value:
498	result[index.lower()] = value
499
500	except ValueError:
501	pass
502
503	return result
504
505	def update_ticket_fields(self, ticket, user_dict, use_default=None):
506	"""
507	This will update the ticket fields. It will check if the
508	given fields are known and if the right values are specified
509	It will only update the ticket field value:
510	- If the field is known
511	- If the value supplied is valid for the ticket field.
512	If not then there are two options:
513	1) Skip the value (use_default=None)
514	2) Set default value for field (use_default=1)
515	"""
516
517	# Build a system dictionary from the ticket fields
518	# with field as index and option as value
519	#
520	sys_dict = dict()
521	for field in ticket.fields:
522	try:
523	sys_dict[field['name']] = field['options']
524
525	except KeyError:
526	sys_dict[field['name']] = None
527	pass
528
529	# Check user supplied fields an compare them with the
530	# system one's
531	#
532	for field,value in user_dict.items():
533	if self.DEBUG >= 10:
534	print 'user_field\t %s = %s' %(field,value)
535
536	if sys_dict.has_key(field):
537
538	# Check if value is an allowed system option, if TypeError then
539	# every value is allowed
540	#
541	try:
542	if value in sys_dict[field]:
543	ticket[field] = value
544	else:
545	# Must we set a default if value is not allowed
546	#
547	if use_default:
548	value = self.get_config('ticket', 'default_%s' %(field) )
549	ticket[field] = value
550
551	except TypeError:
552	ticket[field] = value
553
554	if self.DEBUG >= 10:
555	print 'ticket_field\t %s = %s' %(field, ticket[field])
556
557	def ticket_update(self, m, spam):
558	"""
559	If the current email is a reply to an existing ticket, this function
560	will append the contents of this email to that ticket, instead of
561	creating a new one.
562	"""
563
564	if not m['Subject']:
565	return False
566	else:
567	subject = self.email_to_unicode(m['Subject'])
568
569	# [hic] #1529: Re: LRZ
570	# [hic] #1529?owner=bas,priority=medium: Re: LRZ
571	#
572	TICKET_RE = re.compile(r"""
573	(?P<ticketnr>[#][0-9]+:)
574	\|(?P<ticketnr_fields>[#][\d]+\?.*?:)
575	""", re.VERBOSE)
576
577	result = TICKET_RE.search(subject)
578	if not result:
579	return False
580
581	# Must we update ticket fields
582	#
583	update_tkt_fields = dict()
584	try:
585	nr, keywords = string.split(result.group('ticketnr_fields'), '?')
586	update_tkt_fields = self.str_to_dict(keywords)
587
588	# Strip '#'
589	#
590	ticket_id = int(nr[1:])
591
592	except AttributeError:
593	# Strip '#' and ':'
594	#
595	nr = result.group('ticketnr')
596	ticket_id = int(nr[1:-1])
597
598
599	# When is the change committed
600	#
601	#
602	if self.VERSION == 0.11:
603	utc = UTC()
604	when = datetime.now(utc)
605	else:
606	when = int(time.time())
607
608	try:
609	tkt = Ticket(self.env, ticket_id, self.db)
610	except util.TracError, detail:
611	return False
612
613	# Must we update some ticket fields properties
614	#
615	if update_tkt_fields:
616	self.update_ticket_fields(tkt, update_tkt_fields)
617
618	body_text = self.get_body_text(m)
619
620	if self.EMAIL_HEADER:
621	head = self.email_header_txt(m)
622	body_text = u"\r\n%s \r\n%s" %(head, body_text)
623
624	tkt.save_changes(self.author, body_text, when)
625	tkt['id'] = ticket_id
626
627	if self.VERSION == 0.9:
628	str = self.attachments(m, tkt, True)
629	else:
630	str = self.attachments(m, tkt)
631
632	if self.notification and not spam:
633	self.notify(tkt, False, when)
634
635	return True
636
637	def set_ticket_fields(self, ticket):
638	"""
639	set the ticket fields to value specified
640	- /etc/email2trac.conf with <prefix>_<field>
641	- trac default values, trac.ini
642	"""
643	user_dict = dict()
644
645	for field in ticket.fields:
646
647	name = field['name']
648
649	# default trac value
650	#
651	value = self.get_config('ticket', 'default_%s' %(name) )
652	if self.DEBUG > 10:
653	print 'trac.ini name %s = %s' %(name, value)
654
655	prefix = self.parameters['ticket_prefix']
656	try:
657	value = self.parameters['%s_%s' %(prefix, name)]
658	if self.DEBUG > 10:
659	print 'email2trac.conf %s = %s ' %(name, value)
660
661	except KeyError, detail:
662	pass
663
664	if self.DEBUG:
665	print 'user_dict[%s] = %s' %(name, value)
666
667	user_dict[name] = value
668
669	self.update_ticket_fields(ticket, user_dict, use_default=1)
670
671	# Set status ticket
672	#`
673	ticket['status'] = 'new'
674
675
676
677	def new_ticket(self, msg, spam):
678	"""
679	Create a new ticket
680	"""
681	tkt = Ticket(self.env)
682
683	self.set_ticket_fields(tkt)
684
685	# Some defaults
686	#
687	#tkt['status'] = 'new'
688	#tkt['milestone'] = self.get_config('ticket', 'default_milestone')
689	#tkt['priority'] = self.get_config('ticket', 'default_priority')
690	#tkt['severity'] = self.get_config('ticket', 'default_severity')
691	#tkt['version'] = self.get_config('ticket', 'default_version')
692	#tkt['type'] = self.get_config('ticket', 'default_type')
693
694	# Old style setting for component, will be removed
695	#
696	if spam:
697	tkt['component'] = 'Spam'
698
699	elif self.parameters.has_key('component'):
700	tkt['component'] = self.parameters['component']
701
702	if not msg['Subject']:
703	tkt['summary'] = u'(No subject)'
704	else:
705	tkt['summary'] = self.email_to_unicode(msg['Subject'])
706
707
708	self.set_reply_fields(tkt, msg)
709
710	# produce e-mail like header
711	#
712	head = ''
713	if self.EMAIL_HEADER > 0:
714	head = self.email_header_txt(msg)
715
716	body_text = self.get_body_text(msg)
717
718	tkt['description'] = '\r\n%s\r\n%s' \
719	%(head, body_text)
720
721	#when = int(time.time())
722	#
723	utc = UTC()
724	when = datetime.now(utc)
725
726	if self.DRY_RUN:
727	ticket_id = 'DRY_RUN'
728	else:
729	ticket_id = tkt.insert()
730
731	tkt['id'] = ticket_id
732
733	changed = False
734	comment = ''
735
736	# Rewrite the description if we have mailto enabled
737	#
738	if self.MAILTO:
739	changed = True
740	comment = u'\nadded mailto line\n'
741	#mailto = self.html_mailto_link(tkt['summary'], ticket_id, body_text)
742	mailto = self.html_mailto_link( m['Subject'], ticket_id, body_text)
743	tkt['description'] = u'\r\n%s\r\n%s%s\r\n' \
744	%(head, mailto, body_text)
745
746	str = self.attachments(msg, tkt)
747	if str:
748	changed = True
749	comment = '%s\n%s\n' %(comment, str)
750
751	if changed:
752	if self.DRY_RUN:
753	print 'DRY_RUN: tkt.save_changes(self.author, comment)'
754	else:
755	tkt.save_changes(self.author, comment)
756	#print tkt.get_changelog(self.db, when)
757
758	if self.notification:
759	if self.DRY_RUN:
760	print 'DRY_RUN: self.notify(tkt, True)'
761	else:
762	if not spam:
763	self.notify(tkt, True)
764	#self.notify(tkt, False)
765
766	def parse(self, fp):
767	global m
768
769	m = email.message_from_file(fp)
770	if not m:
771	return
772
773	if self.DEBUG > 1: # save the entire e-mail message text
774	self.save_email_for_debug(m)
775	self.debug_attachments(m)
776
777	self.db = self.env.get_db_cnx()
778	self.get_sender_info(m)
779
780	if self.blacklisted_from():
781	if self.DEBUG > 1 :
782	print 'Message rejected : From: in blacklist'
783	return False
784
785	# If drop the message
786	#
787	if self.spam(m) == 'drop':
788	return False
789
790	elif self.spam(m) == 'spam':
791	spam_msg = True
792
793	else:
794	spam_msg = False
795
796	if self.get_config('notification', 'smtp_enabled') in ['true']:
797	self.notification = 1
798	else:
799	self.notification = 0
800
801	# Must we update existing tickets
802	#
803	if self.TICKET_UPDATE > 0:
804	if self.ticket_update(m, spam_msg):
805	return True
806
807	self.new_ticket(m, spam_msg)
808
809	def strip_signature(self, text):
810	"""
811	Strip signature from message, inspired by Mailman software
812	"""
813	body = []
814	for line in text.splitlines():
815	if line == '-- ':
816	break
817	body.append(line)
818
819	return ('\n'.join(body))
820
821	def strip_quotes(self, text):
822	"""
823	Strip quotes from message by Nicolas Mendoza
824	"""
825	body = []
826	for line in text.splitlines():
827	if line.startswith(self.EMAIL_QUOTE):
828	continue
829	body.append(line)
830
831	return ('\n'.join(body))
832
833	def wrap_text(self, text, replace_whitespace = False):
834	"""
835	Will break a lines longer then given length into several small
836	lines of size given length
837	"""
838	import textwrap
839
840	LINESEPARATOR = '\n'
841	reformat = ''
842
843	for s in text.split(LINESEPARATOR):
844	tmp = textwrap.fill(s,self.USE_TEXTWRAP)
845	if tmp:
846	reformat = '%s\n%s' %(reformat,tmp)
847	else:
848	reformat = '%s\n' %reformat
849
850	return reformat
851
852	# Python2.4 and higher
853	#
854	#return LINESEPARATOR.join(textwrap.fill(s,width) for s in str.split(LINESEPARATOR))
855	#
856
857
858	def get_body_text(self, msg):
859	"""
860	put the message text in the ticket description or in the changes field.
861	message text can be plain text or html or something else
862	"""
863	has_description = 0
864	encoding = True
865	ubody_text = u'No plain text message'
866	for part in msg.walk():
867
868	# 'multipart/*' is a container for multipart messages
869	#
870	if part.get_content_maintype() == 'multipart':
871	continue
872
873	if part.get_content_type() == 'text/plain':
874	# Try to decode, if fails then do not decode
875	#
876	body_text = part.get_payload(decode=1)
877	if not body_text:
878	body_text = part.get_payload(decode=0)
879
880	if self.STRIP_SIGNATURE:
881	body_text = self.strip_signature(body_text)
882
883	if self.STRIP_QUOTES:
884	body_text = self.strip_quotes(body_text)
885
886	if self.USE_TEXTWRAP:
887	body_text = self.wrap_text(body_text)
888
889	# Get contents charset (iso-8859-15 if not defined in mail headers)
890	#
891	charset = part.get_content_charset()
892	if not charset:
893	charset = 'iso-8859-15'
894
895	try:
896	ubody_text = unicode(body_text, charset)
897
898	except UnicodeError, detail:
899	ubody_text = unicode(body_text, 'iso-8859-15')
900
901	except LookupError, detail:
902	ubody_text = 'ERROR: Could not find charset: %s, please install' %(charset)
903
904	elif part.get_content_type() == 'text/html':
905	ubody_text = '(see attachment for HTML mail message)'
906
907	else:
908	ubody_text = '(see attachment for message)'
909
910	has_description = 1
911	break # we have the description, so break
912
913	if not has_description:
914	ubody_text = '(see attachment for message)'
915
916	# A patch so that the web-interface will not update the description
917	# field of a ticket
918	#
919	ubody_text = ('\r\n'.join(ubody_text.splitlines()))
920
921	# If we can unicode it try to encode it for trac
922	# else we a lot of garbage
923	#
924	#if encoding:
925	# ubody_text = ubody_text.encode('utf-8')
926
927	if self.VERBATIM_FORMAT:
928	ubody_text = '{{{\r\n%s\r\n}}}' %ubody_text
929	else:
930	ubody_text = '%s' %ubody_text
931
932	return ubody_text
933
934	def notify(self, tkt , new=True, modtime=0):
935	"""
936	A wrapper for the TRAC notify function. So we can use templates
937	"""
938	try:
939	# create false {abs_}href properties, to trick Notify()
940	#
941	if not self.VERSION == 0.11:
942	self.env.abs_href = Href(self.get_config('project', 'url'))
943	self.env.href = Href(self.get_config('project', 'url'))
944
945	tn = TicketNotifyEmail(self.env)
946	if self.notify_template:
947	tn.template_name = self.notify_template;
948
949	tn.notify(tkt, new, modtime)
950
951	except Exception, e:
952	print 'TD: Failure sending notification on creation of ticket #%s: %s' %(tkt['id'], e)
953
954	def html_mailto_link(self, subject, id, body):
955	if not self.author:
956	author = self.email_addr
957	else:
958	author = self.author
959
960	# Must find a fix
961	#
962	#arr = string.split(body, '\n')
963	#arr = map(self.mail_line, arr)
964	#body = string.join(arr, '\n')
965	#body = '%s wrote:\n%s' %(author, body)
966
967	# Temporary fix
968	#
969	str = 'mailto:%s?Subject=%s&Cc=%s' %(
970	urllib.quote(self.email_addr),
971	urllib.quote('Re: #%s: %s' %(id, subject)),
972	urllib.quote(self.MAILTO_CC)
973	)
974
975	str = '\r\n{{{\r\n#!html\r\n<a href="%s">Reply to: %s</a>\r\n}}}\r\n' %(str, author)
976	return str
977
978	def attachments(self, message, ticket, update=False):
979	'''
980	save any attachments as files in the ticket's directory
981	'''
982	count = 0
983	first = 0
984	number = 0
985
986	# Get Maxium attachment size
987	#
988	max_size = int(self.get_config('attachment', 'max_size'))
989	status = ''
990
991	for part in message.walk():
992	if part.get_content_maintype() == 'multipart': # multipart/* is just a container
993	continue
994
995	if not first: # first content is the message
996	first = 1
997	if part.get_content_type() == 'text/plain': # if first is text, is was already put in the description
998	continue
999
1000	filename = part.get_filename()
1001	if not filename:
1002	number = number + 1
1003	filename = 'part%04d' % number
1004
1005	ext = mimetypes.guess_extension(part.get_content_type())
1006	if not ext:
1007	ext = '.bin'
1008
1009	filename = '%s%s' % (filename, ext)
1010	else:
1011	filename = self.email_to_unicode(filename)
1012
1013	# From the trac code
1014	#
1015	filename = filename.replace('\\', '/').replace(':', '/')
1016	filename = os.path.basename(filename)
1017
1018	# We try to normalize the filename to utf-8 NFC if we can.
1019	# Files uploaded from OS X might be in NFD.
1020	# Check python version and then try it
1021	#
1022	if sys.version_info[0] > 2 or (sys.version_info[0] == 2 and sys.version_info[1] >= 3):
1023	try:
1024	filename = unicodedata.normalize('NFC', unicode(filename, 'utf-8')).encode('utf-8')
1025	except TypeError:
1026	pass
1027
1028	url_filename = urllib.quote(filename)
1029	#
1030	# Must be tuneables HvB
1031	#
1032	path, fd = util.create_unique_file(os.path.join(self.TMPDIR, url_filename))
1033	text = part.get_payload(decode=1)
1034	if not text:
1035	text = '(None)'
1036	fd.write(text)
1037	fd.close()
1038
1039	# get the file_size
1040	#
1041	stats = os.lstat(path)
1042	file_size = stats[stat.ST_SIZE]
1043
1044	# Check if the attachment size is allowed
1045	#
1046	if (max_size != -1) and (file_size > max_size):
1047	status = '%s\nFile %s is larger then allowed attachment size (%d > %d)\n\n' \
1048	%(status, filename, file_size, max_size)
1049
1050	os.unlink(path)
1051	continue
1052	else:
1053	count = count + 1
1054
1055	# Insert the attachment
1056	#
1057	fd = open(path)
1058	att = attachment.Attachment(self.env, 'ticket', ticket['id'])
1059
1060	# This will break the ticket_update system, the body_text is vaporized
1061	# ;-(
1062	#
1063	if not update:
1064	att.author = self.author
1065	att.description = self.email_to_unicode('Added by email2trac')
1066
1067	att.insert(url_filename, fd, file_size)
1068	#except util.TracError, detail:
1069	# print detail
1070
1071	# Remove the created temporary filename
1072	#
1073	fd.close()
1074	os.unlink(path)
1075
1076	# Return how many attachments
1077	#
1078	status = 'This message has %d attachment(s)\n%s' %(count, status)
1079	return status
1080
1081
1082	def mkdir_p(dir, mode):
1083	'''do a mkdir -p'''
1084
1085	arr = string.split(dir, '/')
1086	path = ''
1087	for part in arr:
1088	path = '%s/%s' % (path, part)
1089	try:
1090	stats = os.stat(path)
1091	except OSError:
1092	os.mkdir(path, mode)
1093
1094	def ReadConfig(file, name):
1095	"""
1096	Parse the config file
1097	"""
1098
1099	if not os.path.isfile(file):
1100	print 'File %s does not exist' %file
1101	sys.exit(1)
1102
1103	config = trac_config.Configuration(file)
1104
1105	# Use given project name else use defaults
1106	#
1107	if name:
1108	sections = config.sections()
1109	if not name in sections:
1110	print "Not a valid project name: %s" %name
1111	print "Valid names: %s" %sections
1112	sys.exit(1)
1113
1114	project = dict()
1115	for option, value in config.options(name):
1116	project[option] = value
1117
1118	else:
1119	project = config.defaults()
1120
1121	return project
1122
1123
1124	if __name__ == '__main__':
1125	# Default config file
1126	#
1127	configfile = '@email2trac_conf@'
1128	project = ''
1129	component = ''
1130	ticket_prefix = 'default'
1131	dry_run = None
1132
1133	ENABLE_SYSLOG = 0
1134
1135
1136	SHORT_OPT = 'chf:np:t:'
1137	LONG_OPT = ['component=', 'dry-run', 'help', 'file=', 'project=', 'ticket_prefix=']
1138
1139	try:
1140	opts, args = getopt.getopt(sys.argv[1:], SHORT_OPT, LONG_OPT)
1141	except getopt.error,detail:
1142	print __doc__
1143	print detail
1144	sys.exit(1)
1145
1146	project_name = None
1147	for opt,value in opts:
1148	if opt in [ '-h', '--help']:
1149	print __doc__
1150	sys.exit(0)
1151	elif opt in ['-c', '--component']:
1152	component = value
1153	elif opt in ['-f', '--file']:
1154	configfile = value
1155	elif opt in ['-n', '--dry-run']:
1156	dry_run = True
1157	elif opt in ['-p', '--project']:
1158	project_name = value
1159	elif opt in ['-t', '--ticket_prefix']:
1160	ticket_prefix = value
1161
1162	settings = ReadConfig(configfile, project_name)
1163	if not settings.has_key('project'):
1164	print __doc__
1165	print 'No Trac project is defined in the email2trac config file.'
1166	sys.exit(1)
1167
1168	if component:
1169	settings['component'] = component
1170
1171	# The default prefix for ticket values in email2trac.conf
1172	#
1173	settings['ticket_prefix'] = ticket_prefix
1174	settings['dry_run'] = dry_run
1175
1176	if settings.has_key('trac_version'):
1177	version = settings['trac_version']
1178	else:
1179	version = trac_default_version
1180
1181
1182	#debug HvB
1183	#print settings
1184
1185	try:
1186	if version == '0.9':
1187	from trac import attachment
1188	from trac.env import Environment
1189	from trac.ticket import Ticket
1190	from trac.web.href import Href
1191	from trac import util
1192	from trac.Notify import TicketNotifyEmail
1193	elif version == '0.10':
1194	from trac import attachment
1195	from trac.env import Environment
1196	from trac.ticket import Ticket
1197	from trac.web.href import Href
1198	from trac import util
1199	#
1200	# return util.text.to_unicode(str)
1201	#
1202	# see http://projects.edgewall.com/trac/changeset/2799
1203	from trac.ticket.notification import TicketNotifyEmail
1204	from trac import config as trac_config
1205	elif version == '0.11':
1206	from trac import attachment
1207	from trac.env import Environment
1208	from trac.ticket import Ticket
1209	from trac.web.href import Href
1210	from trac import config as trac_config
1211	from trac import util
1212	#
1213	# return util.text.to_unicode(str)
1214	#
1215	# see http://projects.edgewall.com/trac/changeset/2799
1216	from trac.ticket.notification import TicketNotifyEmail
1217	else:
1218	print 'TRAC version %s is not supported' %version
1219	sys.exit(1)
1220
1221	if settings.has_key('enable_syslog'):
1222	if SYSLOG_AVAILABLE:
1223	ENABLE_SYSLOG = float(settings['enable_syslog'])
1224
1225	env = Environment(settings['project'], create=0)
1226	tktparser = TicketEmailParser(env, settings, float(version))
1227	tktparser.parse(sys.stdin)
1228
1229	# Catch all errors ans log to SYSLOG if we have enabled this
1230	# else stdout
1231	#
1232	except Exception, error:
1233	if ENABLE_SYSLOG:
1234	syslog.openlog('email2trac', syslog.LOG_NOWAIT)
1235
1236	etype, evalue, etb = sys.exc_info()
1237	for e in traceback.format_exception(etype, evalue, etb):
1238	syslog.syslog(e)
1239
1240	syslog.closelog()
1241	else:
1242	traceback.print_exc()
1243
1244	if m:
1245	tktparser.save_email_for_debug(m, True)
1246
1247	# EOB

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

Download in other formats:

Original Format