[Mailman-Developers] syncmail - patch to handle filenames with spaces
Gregory P . Smith
greg@mad-scientist.com
Thu, 26 Apr 2001 15:27:07 -0700
--FCuugMFkClbJLl1L
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
This qualifies as a hack in my book, but it works well for our
repository. I modified an unknown version of the python syncmail
script on our CVS server to properly deal with filenames in the cvs
repository that have spaces in them. Attached are the patch against
our previous version of syncmail and an actual copy of our whole
syncmail script (since it has no obvious version numbers, etc).
Why send this here? A friend pointed me to the mailman project as
being the maintainers of the python syncmail script. I hope he's
right (i didn't see anything obvious mentioning such on the webpage).
Previously the version of syncmail we used would send emails saying
"***** Broken: Foo no such file" instead of showing the diff of the
file named 'Foo goes to the bar' (ie: a filename with evil spaces in
it). With this it works with spaces.
enjoy or ignore,
Greg
--FCuugMFkClbJLl1L
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="syncmail-filespaces.patch"
Index: syncmail
===================================================================
RCS file: /cvsroot/CVSROOT/syncmail,v
retrieving revision 1.1
retrieving revision 1.6
diff -u -C5 -r1.1 -r1.6
*** syncmail 2000/09/09 16:36:36 1.1
--- syncmail 2001/04/26 19:05:13 1.6
***************
*** 92,102 ****
elif newrev == 'NONE':
lines = ['--- %s DELETED ---\n' % file]
else:
# This /has/ to happen in the background, otherwise we'll run into CVS
# lock contention. What a crock.
! diffcmd = '/usr/bin/cvs -f diff -kk -C 2 -r %s -r %s %s' % (
oldrev, newrev, file)
fp = os.popen(diffcmd)
lines = fp.readlines()
sts = fp.close()
# ignore the error code, it always seems to be 1 :(
--- 92,102 ----
elif newrev == 'NONE':
lines = ['--- %s DELETED ---\n' % file]
else:
# This /has/ to happen in the background, otherwise we'll run into CVS
# lock contention. What a crock.
! diffcmd = '/usr/bin/cvs -f diff -kk -C 2 -r %s -r %s "%s"' % (
oldrev, newrev, file)
fp = os.popen(diffcmd)
lines = fp.readlines()
sts = fp.close()
# ignore the error code, it always seems to be 1 :(
***************
*** 166,176 ****
print 'Mailing %s...' % PEOPLE
if specs == ['-', 'Imported', 'sources']:
return
if specs[-3:] == ['-', 'New', 'directory']:
del specs[-3:]
! blast_mail(mailcmd, specs[1:])
if __name__ == '__main__':
print 'Running syncmail...'
--- 166,200 ----
print 'Mailing %s...' % PEOPLE
if specs == ['-', 'Imported', 'sources']:
return
if specs[-3:] == ['-', 'New', 'directory']:
del specs[-3:]
!
! # hack to try and deal with filenames containing spaces -greg@electricrain dot com
! files = specs[1:]
! realfiles = []
! i = 0
! while i < len(files):
! # the parameters are all 'filename,ver1,ver2' so just put ones in the realfiles list
! # that have ,s in them. (XXX this will break down if your actual names include commas
! # and spaces you bumbling mangled file name morons out there)
! if string.find(files[i], ',') == -1:
! j = i + 1
! t = files[i]
! while j < len(files):
! t = t + ' ' + files[j]
! if string.find(files[j], ',') != -1:
! realfiles.append(t)
! i = j
! break
! j = j + 1
! else:
! realfiles.append(files[i])
! i = i + 1
!
! #print 'XXX blast mail:', `realfiles`, '(being debugged)'
! blast_mail(mailcmd, realfiles)
if __name__ == '__main__':
print 'Running syncmail...'
--FCuugMFkClbJLl1L
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=syncmail
#! /usr/bin/python
# -*- Python -*-
"""Complicated notification for CVS checkins.
This script is used to provide email notifications of changes to the CVS
repository. These email changes will include context diffs of the changes.
Really big diffs will be trimmed.
This script is run from a CVS loginfo file (see $CVSROOT/CVSROOT/loginfo). To
set this up, create a loginfo entry that looks something like this:
mymodule /path/to/syncmail %%s some-email-addr@your.domain
In this example, whenever a checkin that matches `mymodule' is made, the
syncmail script is invoked, which will generate the diff containing email, and
send it to some-email-addr@your.domain.
Note: This module used to also do repository synchronizations via
rsync-over-ssh, but since the repository has been moved to SourceForge,
this is no longer necessary. The syncing functionality has been ripped
out in the 3.0, which simplifies it considerably. Access the 2.x versions
to refer to this functionality. Because of this, the script's name is
misleading.
It no longer makes sense to run this script from the command line. Doing so
will only print out this usage information.
Usage:
syncmail [options] <%%S> email-addr [email-addr ...]
Where options is:
--cvsroot=<path>
Use <path> as the environment variable CVSROOT. Otherwise this
variable must exist in the environment.
--help
-h
Print this text.
<%%S>
CVS %%s loginfo expansion. When invoked by CVS, this will be a single
string containing the directory the checkin is being made in, relative
to $CVSROOT, followed by the list of files that are changing. If the
%%s in the loginfo file is %%{sVv}, context diffs for each of the
modified files are included in any email messages that are generated.
email-addrs
At least one email address.
"""
import os
import sys
import string
import time
import getopt
# Notification command
MAILCMD = '/bin/mail -s "CVS: %(SUBJECT)s" %(PEOPLE)s 2>&1 > /dev/null'
# Diff trimming stuff
DIFF_HEAD_LINES = 20
DIFF_TAIL_LINES = 20
DIFF_TRUNCATE_IF_LARGER = 1000
def usage(errcode, msg=''):
print __doc__ % globals()
if msg: print msg
sys.exit(errorcode)
def calculate_diff(filespec):
try:
file, oldrev, newrev = string.split(filespec, ',')
except ValueError:
# No diff to report
return '***** Bogus filespec: %s' % filespec
if oldrev == 'NONE':
try:
fp = open(file)
lines = fp.readlines()
fp.close()
lines.insert(0, '--- NEW FILE ---\n')
except IOError, e:
lines = ['***** Error reading new file: ',
str(e)]
elif newrev == 'NONE':
lines = ['--- %s DELETED ---\n' % file]
else:
# This /has/ to happen in the background, otherwise we'll run into CVS
# lock contention. What a crock.
diffcmd = '/usr/bin/cvs -f diff -kk -C 2 -r %s -r %s "%s"' % (
oldrev, newrev, file)
fp = os.popen(diffcmd)
lines = fp.readlines()
sts = fp.close()
# ignore the error code, it always seems to be 1 :(
## if sts:
## return 'Error code %d occurred during diff\n' % (sts >> 8)
if len(lines) > DIFF_TRUNCATE_IF_LARGER:
removedlines = len(lines) - DIFF_HEAD_LINES - DIFF_TAIL_LINES
del lines[DIFF_HEAD_LINES:-DIFF_TAIL_LINES]
lines.insert(DIFF_HEAD_LINES,
'[...%d lines suppressed...]\n' % removedlines)
return string.join(lines, '')
def blast_mail(mailcmd, filestodiff):
# cannot wait for child process or that will cause parent to retain cvs
# lock for too long. Urg!
if not os.fork():
# in the child
# give up the lock you cvs thang!
time.sleep(2)
fp = os.popen(mailcmd, 'w')
fp.write(sys.stdin.read())
fp.write('\n')
# append the diffs if available
for file in filestodiff:
fp.write(calculate_diff(file))
fp.write('\n')
fp.close()
# doesn't matter what code we return, it isn't waited on
os._exit(0)
# scan args for options
def main():
try:
opts, args = getopt.getopt(sys.argv[1:], 'h', ['cvsroot=', 'help'])
except getopt.error, msg:
usage(1, msg)
# parse the options
for opt, arg in opts:
if opt in ('-h', '--help'):
usage(0)
elif opt == '--cvsroot':
os.environ['CVSROOT'] = arg
# What follows is the specification containing the files that were
# modified. The argument actually must be split, with the first component
# containing the directory the checkin is being made in, relative to
# $CVSROOT, followed by the list of files that are changing.
if not args:
usage(1, 'No CVS module specified')
SUBJECT = args[0]
specs = string.split(args[0])
del args[0]
# The remaining args should be the email addresses
if not args:
usage(1, 'No recipients specified')
# Now do the mail command
PEOPLE = string.join(args)
mailcmd = MAILCMD % vars()
print 'Mailing %s...' % PEOPLE
if specs == ['-', 'Imported', 'sources']:
return
if specs[-3:] == ['-', 'New', 'directory']:
del specs[-3:]
# hack to try and deal with filenames containing spaces -greg@electricrain dot com
files = specs[1:]
realfiles = []
i = 0
while i < len(files):
# the parameters are all 'filename,ver1,ver2' so just put ones in the realfiles list
# that have ,s in them. (XXX this will break down if your actual names include commas
# and spaces you bumbling mangled file name morons out there)
if string.find(files[i], ',') == -1:
j = i + 1
t = files[i]
while j < len(files):
t = t + ' ' + files[j]
if string.find(files[j], ',') != -1:
realfiles.append(t)
i = j
break
j = j + 1
else:
realfiles.append(files[i])
i = i + 1
#print 'XXX blast mail:', `realfiles`, '(being debugged)'
blast_mail(mailcmd, realfiles)
if __name__ == '__main__':
print 'Running syncmail...'
main()
print '...syncmail done.'
sys.exit(0)
--FCuugMFkClbJLl1L--