2 ===================================================================
3 --- cvsspam.conf (.../tags/RELEASE-0_2_12) (revision 265)
4 +++ cvsspam.conf (.../trunk) (revision 265)
7 # When $jiraURL is given, text of the form 'project-1234' will be linked
8 # to this issue in JIRA.
10 +# When $xplannerStoryURL, $xplannerIterationURL and $xplannerProjectURL are
11 +# given, text of the form XS1234 will be linked to XPlanner stories; text of
12 +# the form XI1234 will be linked to XPlanner iterations; and text of the form
13 +# XP1234 will be linked to XPlanner projects.
15 #$bugzillaURL = "http://bugzilla.mozilla.org/show_bug.cgi?id=%s"
17 #$jiraURL = "http://jira.atlassian.com/secure/ViewIssue.jspa?key=%s"
19 +#$xplannerStoryURL = "http://www.example.com/xplanner/do/view/userstory?oid=%s"
20 +#$xplannerIterationURL = "http://www.example.com/xplanner/do/view/iteration?oid=%s"
21 +#$xplannerProjectURL = "http://www.example.com/xplanner/do/view/project?oid=%s"
23 # Link to Wiki systems
26 #$diff_ignore_keywords = true
29 +# cvsdiff whitespace ignoring (Default: show whitespace-only changes)
31 +# Whitespace-only changes can distract from the rest of a diff. Set this
32 +# value to true to exclude changes in the amount of whitespace (adds the -b
33 +# option to cvs diff).
35 +$diff_ignore_whitespace = true
38 # $no_removed_file_diff and $no_added_file_diff
40 # Set both these options, and emails will only include diffs for files
42 # them happy, you can say $files_in_subject = true here.
44 #$files_in_subject = false
48 +# Email size limit (Default: around 2MB)
50 +# When large changes are committed, large CVSspam emails can result. Here
51 +# you can set the size of email that CVSspam is not allowed to append any
52 +# more diffs onto. Specify the number of bytes.
54 +#$mail_size_limit = 2097152
55 Index: collect_diffs.rb
56 ===================================================================
57 --- collect_diffs.rb (.../tags/RELEASE-0_2_12) (revision 265)
58 +++ collect_diffs.rb (.../trunk) (revision 265)
60 $dirtemplate = "#cvsspam.#{Process.getpgrp}.#{Process.uid}"
64 + safe_from = make_fromaddr_safe_for_filename($from_address)
65 + Dir["#{$tmpdir}/#{$dirtemplate}.#{safe_from}-*"].each do |dir|
66 + stat = File.stat(dir)
67 + return dir if stat.owned?
70 Dir["#{$tmpdir}/#{$dirtemplate}-*"].each do |dir|
72 return dir if stat.owned?
77 +# transform any special / unexpected characters appearing in the argument to
78 +# --from so that they will not cause problems if the value is inserted into
79 +# a file or directory name
80 +def make_fromaddr_safe_for_filename(addr)
81 + addr.gsub(/[^a-zA-Z0-1.,_-]/, "_")
87 $stderr.puts "collect_diffs.rb: #{msg}"
91 while i < cvs_info.length
92 - changes << ChangeInfo.new(cvs_info[i], cvs_info[i+=1], cvs_info[i+=1])
93 + change_file = cvs_info[i]
94 + # It's been reported,
95 + # http://lists.badgers-in-foil.co.uk/pipermail/cvsspam-devel/2005-September/000380.html
96 + # that sometimes the second revision number that CVS gives us contains a
97 + # trailing newline character, so we strip ws from these values before use,
98 + change_from = cvs_info[i+=1].strip
99 + change_to = cvs_info[i+=1].strip
100 + changes << ChangeInfo.new(change_file, change_from, change_to)
106 diff_cmd = Array.new << $cvs_prog << "-nq" << "diff" << "-Nu"
107 diff_cmd << "-kk" if $diff_ignore_keywords
108 + diff_cmd << "-b" if $diff_ignore_whitespace
119 $diff_ignore_keywords = false
120 +$diff_ignore_whitespace = false
123 unless ENV.has_key?('CVSROOT')
126 $config = arg if opt=="--config"
127 $debug = true if opt == "--debug"
128 + $from_address = arg if opt == "--from"
131 blah("CVSROOT is #{ENV['CVSROOT']}")
132 Index: record_lastdir.rb
133 ===================================================================
134 --- record_lastdir.rb (.../tags/RELEASE-0_2_12) (revision 265)
135 +++ record_lastdir.rb (.../trunk) (revision 265)
137 # http://www.badgers-in-foil.co.uk/projects/cvsspam/
138 # Copyright (c) David Holroyd
140 -$repositorydir = ARGV.shift
142 $tmpdir = ENV["TMPDIR"] || "/tmp"
149 +# transform any special / unexpected characters appearing in the argument to
150 +# --from so that they will not cause problems if the value is inserted into
151 +# a file or directory name
152 +def make_fromaddr_safe_for_filename(addr)
153 + addr.gsub(/[^a-zA-Z0-1.,_-]/, "_")
156 +# Option processing doesn't use GetoptLong (for the moment) bacause arguments
157 +# given to this script by CVS include the names of committed files. It
158 +# seems quite possible that one of those file names could begin with a '-'
159 +# and therefore be treated by GetoptLong as a value which requires processing.
160 +# This would probably result in an error.
162 +# [That could be worked around by placing a '--' option (which tells GetoptLong
163 +# to stop processing option arguments) at the very end of the arguments to
164 +# record_lastdir.rb in commitinfo, but that's very easily forgotten, and isn't
165 +# really backwards compatable with the behaviour of older CVSspam releases.]
166 +if ARGV.first == "--from"
167 + # we could, of course, be tricked, if the first committed file in the list
168 + # happened to be named '--from' :S
170 + # drop the "--from"
172 + # and use the value which was given following the option,
173 + $dirtemplate << "." << make_fromaddr_safe_for_filename(ARGV.shift)
176 +$repositorydir = ARGV.shift
178 $datadir = find_data_dir()
182 ===================================================================
184 ===================================================================
185 --- CREDITS (.../tags/RELEASE-0_2_12) (revision 265)
186 +++ CREDITS (.../trunk) (revision 265)
198 Index: cvsspam-doc.xml
199 ===================================================================
200 --- cvsspam-doc.xml (.../tags/RELEASE-0_2_12) (revision 265)
201 +++ cvsspam-doc.xml (.../trunk) (revision 265)
203 </screen></informalexample>
210 + <para>For Gforge, when a CVS log comment contains text like <userinput>Fix
211 + for Bug [#123]</userinput>, or <userinput>Task [T456] ...</userinput>, the
212 + text "[#123]" or "[T456]" will become a hyper-link to that Gforge page in
213 + the generated email. The format [#<replaceable>nnn</replaceable>] and
214 + [T<replaceable>nnn</replaceable>] is taken from the existing plugin for
215 + Gforge called cvstracker.</para>
217 + <para>To enable, give your Gforge's URL in CVSspam's configuration file:
218 +<informalexample><screen>$gforgeBugURL = "http://gforge.org/tracker/index.php?func=detail&aid=%s"
219 +$gforgeTaskURL = "http://gforge.org/pm/task.php?func=detailtask&project_task_id=%s"</screen></informalexample>
220 + The marker %s tells CVSspam where in the URL to put the bugId from the
221 + log message.</para>
225 <section><title>CVS Web Frontends</title>
227 ===================================================================
228 --- cvsspam.rb (.../tags/RELEASE-0_2_12) (revision 265)
229 +++ cvsspam.rb (.../trunk) (revision 265)
236 $maxSubjectLength = 200
237 $maxLinesPerDiff = 1000
242 -# NB must ensure the time is UTC
243 -# (the Ruby Time object's strftime() doesn't supply a numeric timezone)
244 -DATE_HEADER_FORMAT = "%a, %d %b %Y %H:%M:%S +0000"
246 # Perform (possibly) multiple global substitutions on a string.
247 # the regexps given as keys must not use capturing subexpressions '(...)'
252 hash.each do |key,val|
253 - if expr == nil ; expr="(" else expr<<"|(" end
254 + if expr == nil ; expr="(" else expr << "|(" end
259 UNDERSCORE = chr("_")
265 # encode a header value according to the RFC-2047 quoted-printable spec,
266 # allowing non-ASCII characters to appear in header values, and wrapping
268 # return a string representing the given character-code in quoted-printable
270 def quoted_encode_char(b)
271 - if b>126 || b==UNDERSCORE || b==TAB
272 - sprintf("=%02x", b)
273 + if b>126 || b==UNDERSCORE || b==TAB || b==HOOK || b==EQUALS
274 + sprintf("=%02X", b)
280 # gives a string starting "=?", and including a charset specification, that
281 # marks the start of a quoted-printable character sequence
282 - def marker_start_quoted
283 - "=?#{@charset}?#{@encoding}?"
284 + def marker_start_quoted(charset=nil)
285 + charset = @charset if charset.nil?
286 + "=?#{charset}?#{@encoding}?"
289 # test to see of the given string contains non-ASCII characters
294 + @fromVer = @toVer = nil
295 @lineAdditions = @lineRemovals = 0
296 @repository = Repository.get(path)
297 @repository.merge_common_prefix(basedir())
299 # TODO: consolidate these into a nicer framework,
300 mailSub = proc { |match| "<a href=\"mailto:#{match}\">#{match}</a>" }
301 urlSub = proc { |match| "<a href=\"#{match}\">#{match}</a>" }
302 +gforgeTaskSub = proc { |match|
303 + match =~ /([0-9]+)/
304 + "<a href=\"#{$gforgeTaskURL.sub(/%s/, $1)}\">#{match}</a>"
306 +gforgeBugSub = proc { |match|
307 + match =~ /([0-9]+)/
308 + "<a href=\"#{$gforgeBugURL.sub(/%s/, $1)}\">#{match}</a>"
310 bugzillaSub = proc { |match|
312 "<a href=\"#{$bugzillaURL.sub(/%s/, $1)}\">#{match}</a>"
313 @@ -544,11 +553,27 @@
315 "<a href=\"#{$ticketURL.sub(/%s/, $1)}\">#{match}</a>"
317 +issueSub = proc { |match|
318 + match =~ /([0-9]+)/
319 + "<a href=\"#{$issueURL.sub(/%s/, $1)}\">#{match}</a>"
321 wikiSub = proc { |match|
322 - match =~ /\[\[(.*)\]\]/
323 + match =~ /\[\[(.*?)\]\]/
325 "<a href=\"#{$wikiURL.sub(/%s/, urlEncode(raw))}\">[[#{raw}]]</a>"
327 +xplannerIterationSub = proc { |match|
328 + match =~ /([0-9]+)/
329 + "<a href=\"#{$xplannerIterationURL.sub(/%s/, $1)}\">#{match}</a>"
331 +xplannerProjectSub = proc { |match|
332 + match =~ /([0-9]+)/
333 + "<a href=\"#{$xplannerProjectURL.sub(/%s/, $1)}\">#{match}</a>"
335 +xplannerStorySub = proc { |match|
336 + match =~ /([0-9]+)/
337 + "<a href=\"#{$xplannerStoryURL.sub(/%s/, $1)}\">#{match}</a>"
339 commentSubstitutions = {
340 '(?:mailto:)?[\w\.\-\+\=]+\@[\w\-]+(?:\.[\w\-]+)+\b' => mailSub,
341 '\b(?:http|https|ftp):[^ \t\n<>"]+[\w/]' => urlSub
347 + # may be overridden by subclasses that are able to make a hyperlink to a
348 + # history log for a file
354 # Superclass for objects that can link to CVS frontends on the web (ViewCVS,
356 "<a href=\"#{diff_url(file)}\">#{super(file)}</a>"
360 + link = log_url(file)
362 + return "<span id=\"info\">(<a href=\"#{link}\">log</a>)</span>"
383 add_repo("#{@base_url}#{urlEncode(file.path)}.diff?r1=#{file.fromVer}&r2=#{file.toVer}")
388 + log_anchor = "#rev#{file.toVer}"
392 + add_repo("#{@base_url}#{urlEncode(file.path)}#{log_anchor}")
396 # Link to Chora, from the Horde framework
398 class CVSwebFrontend < WebFrontend
399 def path_url(path, tag)
401 - add_repo(@base_url + urlEncode(path))
402 + add_repo(@base_url + urlEncode(path) + "/")
404 - add_repo("#{@base_url}#{urlEncode(path)}?only_with_tag=#{urlEncode(tag)}")
405 + add_repo("#{@base_url}#{urlEncode(path)}/?only_with_tag=#{urlEncode(tag)}")
411 add_repo("#{@base_url}#{urlEncode(file.path)}.diff?r1=text&tr1=#{file.fromVer}&r2=text&tr2=#{file.toVer}&f=h")
418 + log_anchor = "#rev#{file.toVer}"
422 + add_repo("#{@base_url}#{urlEncode(file.path)}#{log_anchor}")
427 +class TracFrontend < WebFrontend
428 + def path_url(path, tag)
429 + add_repo("#{@base_url}browser/#{urlEncode(path)}")
432 + def version_url(path, version)
433 + add_repo("#{@base_url}browser/#{urlEncode(path)}?rev=#{version}")
437 + add_repo("#{@base_url}changeset/#{file.toVer}")
444 + log_anchor = "?rev=#{file.toVer}"
448 + add_repo("#{@base_url}log/#{urlEncode(file.path)}#{log_anchor}")
452 # in need of refactoring...
454 # Note when LogReader finds record of a file that was added in this commit
458 if @truncatedLineCount>0
459 - println("<strong class=\"error\" title=\"#{@truncatedLineCount} lines truncated at column #{$maxDiffLineLength}\">[Note: Some over-long lines of diff output only partialy shown]</strong>")
460 + println("<strong class=\"error\" title=\"#{@truncatedLineCount} lines truncated at column #{$maxDiffLineLength}\">[Note: Some over-long lines of diff output only partially shown]</strong>")
464 @@ -1181,7 +1269,7 @@
466 # an RFC 822 email address
468 - def initialize(text)
469 + def initialize(text, charset=nil)
470 if text =~ /^\s*([^<]+?)\s*<\s*([^>]+?)\s*>\s*$/
473 @@ -1189,9 +1277,10 @@
480 - attr_accessor :personal_name, :address
481 + attr_accessor :personal_name, :address, :charset
483 def has_personal_name?
484 return !@personal_name.nil?
485 @@ -1222,7 +1311,7 @@
486 # rfc2047 encode the word, if it contains non-ASCII characters
487 def encode_word(word)
488 if $encoder.requires_rfc2047?(word)
489 - encoded = $encoder.marker_start_quoted
490 + encoded = $encoder.marker_start_quoted(@charset)
491 $encoder.each_char_encoded(word) do |code|
494 @@ -1237,6 +1326,7 @@
495 cvsroot_dir = "#{ENV['CVSROOT']}/CVSROOT"
496 $config = "#{cvsroot_dir}/cvsspam.conf"
497 $users_file = "#{cvsroot_dir}/users"
498 +$users_file_charset = nil
501 $recipients = Array.new
502 @@ -1245,14 +1335,21 @@
503 $no_removed_file_diff = false
504 $no_added_file_diff = false
506 -$task_keywords = ['TODO', 'FIXME']
507 +$task_keywords = ['TODO', 'FIXME', 'FIXIT', 'todo']
510 +$gforgeTaskURL = nil
516 +$xplannerIterationURL = nil
517 +$xplannerProjectURL = nil
518 +$xplannerStoryURL = nil
524 $files_in_subject = false;
525 @@ -1261,6 +1358,7 @@
526 # 2MiB limit on attached diffs,
527 $mail_size_limit = 1024 * 1024 * 2
529 +$cvsroot_email_header = false
533 @@ -1321,6 +1419,8 @@
534 blah("Config file '#{$config}' not found, ignoring")
537 +blah("Users file: '#{$users_file}'")
539 unless $arg_charset.nil?
540 $charset = $arg_charset
542 @@ -1337,6 +1437,9 @@
543 elsif $cvswebURL !=nil
544 $cvswebURL << "/" unless $cvswebURL =~ /\/$/
545 $frontend = CVSwebFrontend.new($cvswebURL)
546 +elsif $tracURL !=nil
547 + $tracURL << "/" unless $tracURL =~ /\/$/
548 + $frontend = TracFrontend.new($tracURL)
550 $frontend = NoFrontend.new
552 @@ -1353,17 +1456,35 @@
555 if $bugzillaURL != nil
556 - commentSubstitutions['\b[Bb][Uu][Gg]\s*#?[0-9]+'] = bugzillaSub
557 + commentSubstitutions['\b[Bb](?:[Uu][Gg])?\s*[#:]?\s*\[?[0-9]+\]?'] = bugzillaSub
559 +if $gforgeBugURL != nil
560 + commentSubstitutions['\B\[#[0-9]+\]'] = gforgeBugSub
562 +if $gforgeTaskURL != nil
563 + commentSubstitutions['\B\[[Tt][0-9]+\]'] = gforgeTaskSub
566 commentSubstitutions['\b[a-zA-Z]+-[0-9]+\b'] = jiraSub
569 commentSubstitutions['\b[Tt][Ii][Cc][Kk][Ee][Tt]\s*#?[0-9]+\b'] = ticketSub
572 + commentSubstitutions['\b[Ii][Ss][Ss][Uu][Ee]\s*#?[0-9]+\b'] = issueSub
575 commentSubstitutions['\[\[.+\]\]'] = wikiSub
577 +if $xplannerIterationURL != nil
578 + commentSubstitutions['\bXI\[?[0-9]+\]?'] = xplannerIterationSub
580 +if $xplannerProjectURL != nil
581 + commentSubstitutions['\bXP\[?[0-9]+\]?'] = xplannerProjectSub
583 +if $xplannerStoryURL != nil
584 + commentSubstitutions['\bXS\[?[0-9]+\]?'] = xplannerStorySub
586 $commentEncoder = MultiSub.new(commentSubstitutions)
589 @@ -1546,11 +1667,14 @@
591 name = "<span id=\"removed\">#{name}</span>"
595 - mail.print("<td><tt>#{prefix}<a href=\"#file#{file_count}\">#{name}</a></tt></td>")
596 + mail.print("<tt>#{prefix}<a href=\"#file#{file_count}\">#{name}</a></tt>")
598 - mail.print("<td><tt>#{prefix}#{name}</tt></td>")
599 + mail.print("<tt>#{prefix}#{name}</tt>")
601 + mail.print(" #{$frontend.log(file)}")
602 + mail.print("</td>")
604 mail.print("<td colspan=\"2\" align=\"center\"><small id=\"info\">[empty]</small></td>")
606 @@ -1667,12 +1791,13 @@
607 # CVSROOT/users file, if the file exists. The argument is returned unchanged
608 # if no alias is found.
609 def sender_alias(email)
610 + blah("Lookup '#{email}' from users file")
611 if File.exists?($users_file)
612 File.open($users_file) do |io|
613 io.each_line do |line|
614 if line =~ /^([^:]+)\s*:\s*(['"]?)([^\n\r]+)(\2)/
615 if email.address == $1
616 - return EmailAddress.new($3)
617 + return EmailAddress.new($3, $users_file_charset)
621 @@ -1686,6 +1811,8 @@
622 # sensible header formatting, and for ensuring that the body is seperated
623 # from the message headers by a blank line (as it is required to be).
625 + ENCODE_HEADERS = ["Subject", "X-CVSspam-Module-Path"]
628 @done_headers = false
630 @@ -1695,8 +1822,8 @@
632 def header(name, value)
633 raise "headers already commited" if @done_headers
634 - if name == "Subject"
635 - $encoder.encode_header(@io, "Subject", value)
636 + if ENCODE_HEADERS.include?(name)
637 + $encoder.encode_header(@io, name, value)
639 @io.puts("#{name}: #{value}")
641 @@ -1769,7 +1896,7 @@
642 ctx.header("To", recipients.map{|addr| addr.encoded}.join(','))
643 blah("Mail From: <#{from}>")
644 ctx.header("From", from.encoded) if from
645 - ctx.header("Date", Time.now.utc.strftime(DATE_HEADER_FORMAT))
646 + ctx.header("Date", Time.now.rfc2822)
650 @@ -1800,10 +1927,10 @@
651 return unless $fileEntries.length == 1
652 file = $fileEntries[0]
653 name = zap_header_special_chars(file.path)
654 - unless file.fromVer == "NONE"
656 mail.header("References", make_msg_id("#{name}.#{file.fromVer}", $hostname))
658 - unless file.toVer == "NONE"
660 mail.header("Message-ID", make_msg_id("#{name}.#{file.toVer}", $hostname))
663 @@ -1834,6 +1961,14 @@
666 mail.header("X-Mailer", "CVSspam #{$version} <http://www.badgers-in-foil.co.uk/projects/cvsspam/>")
667 + if $cvsroot_email_header
669 + if Repository.count == 1
670 + rep = Repository.array.first
671 + mod << rep.common_prefix
673 + mail.header("X-CVSspam-Module-Path", mod)
677 make_html_email(body)