- old patch recovered (2009-04-23)

[packages/cvsspam.git] / cvsspam-branch.diff

Index: cvsspam.conf
===================================================================
--- cvsspam.conf	(.../tags/RELEASE-0_2_12)	(revision 275)
+++ cvsspam.conf	(.../trunk)	(revision 275)
@@ -34,11 +34,19 @@
 #
 #     When $jiraURL is given, text of the form 'project-1234' will be linked
 #   to this issue in JIRA.
+#
+#     When $xplannerStoryURL, $xplannerIterationURL and $xplannerProjectURL are
+#   given, text of the form XS1234 will be linked to XPlanner stories; text of
+#   the form XI1234 will be linked to XPlanner iterations; and text of the form
+#   XP1234 will be linked to XPlanner projects.
 
 #$bugzillaURL = "http://bugzilla.mozilla.org/show_bug.cgi?id=%s"
 
 #$jiraURL = "http://jira.atlassian.com/secure/ViewIssue.jspa?key=%s"
 
+#$xplannerStoryURL = "http://www.example.com/xplanner/do/view/userstory?oid=%s"
+#$xplannerIterationURL = "http://www.example.com/xplanner/do/view/iteration?oid=%s"
+#$xplannerProjectURL = "http://www.example.com/xplanner/do/view/project?oid=%s"
 
 # Link to Wiki systems
 # 
@@ -71,6 +79,7 @@
 
 #$cvswebURL = "http://localhost/cgi-bin/cvsweb.cgi"
 
+#$tracURL = "http://localhost/trac/project"
 
 
 # Additional SMTP Headers                                            (Optional)
@@ -119,12 +128,21 @@
 # cvsdiff keyword ignoring                  (Default: show changes in keywords)
 #
 #     Changes in CVS keywords can be distracting.  For instance, the
-#   $Revision$ keyword will change on each commit.  Set this value to true
+#   $Revision$ keyword will change on each commit.  Set this value to true
 #   to exclude changes in keyword fields (adds the -kk option to cvs diff).
 
 #$diff_ignore_keywords = true
 
 
+# cvsdiff whitespace ignoring               (Default: show whitespace-only changes)
+#
+#   Whitespace-only changes can distract from the rest of a diff. Set this
+#   value to true to exclude changes in the amount of whitespace (adds the -b
+#   option to cvs diff).
+
+$diff_ignore_whitespace = true
+
+
 # $no_removed_file_diff and $no_added_file_diff
 #
 #     Set both these options, and emails will only include diffs for files
@@ -166,14 +184,46 @@
 #     Allows the specification of a character set for all generated emails.
 #   The files CVS is dealing with should already be in the character set you
 #   specify -- no transcoding is done.
+#
+#   Note that you can override this with --charset argument per module, etc.
 
 #$charset="ISO-8859-1"
 
 
 
+# Users file                                  (Default: $CVSROOT/CVSROOT/users)
+#
+#      Specify users file to lookup From addresses for commites
+
+#$users_file = "/srv/svn/users"
+
+# Users file charset                                        (Default: $charset)
+#
+#      If the users file is encoded differently than $charset, You can override
+#   it here. Especially useful if you use --charset argument. See above.
+
+#$users_file_charset = "ISO-8859-1"
+
+
 # File names in Subject                      (Default: no filenames in Subject)
 #
 #     Some people like file names to appear in the email subject.  To make
 #   them happy, you can say $files_in_subject = true here.
 
 #$files_in_subject = false
+
+
+# Module Path email header           (Default: no X-CVSspam-Module-Path header)
+#
+#     Sets 'X-CVSspam-Module-Path' header to contain common path of files commited.
+#   Useful for server side mail filtering.
+
+#$cvsroot_email_header = true
+
+# Email size limit                                        (Default: around 2MB)
+#
+#     When large changes are committed, large CVSspam emails can result.  Here
+#   you can set the size of email that CVSspam is not allowed to append any
+#   more diffs onto.  Specify the number of bytes.
+
+#$mail_size_limit = 2097152

Property changes on: cvsspam.conf
___________________________________________________________________
Deleted: svn:executable
   - *
Modified: svn:keywords
   - Author Date Id Revision
   + Author Date Id

Index: collect_diffs.rb
===================================================================
--- collect_diffs.rb	(.../tags/RELEASE-0_2_12)	(revision 275)
+++ collect_diffs.rb	(.../trunk)	(revision 275)
@@ -27,6 +27,13 @@
 $dirtemplate = "#cvsspam.#{Process.getpgrp}.#{Process.uid}"
 
 def find_data_dir
+  if $from_address
+    safe_from = make_fromaddr_safe_for_filename($from_address)
+    Dir["#{$tmpdir}/#{$dirtemplate}.#{safe_from}-*"].each do |dir|
+      stat = File.stat(dir)
+      return dir if stat.owned?
+    end
+  end
   Dir["#{$tmpdir}/#{$dirtemplate}-*"].each do |dir|
     stat = File.stat(dir)
     return dir if stat.owned?
@@ -35,6 +42,14 @@
 end
 
 
+# transform any special / unexpected characters appearing in the argument to
+# --from so that they will not cause problems if the value is inserted into
+# a file or directory name
+def make_fromaddr_safe_for_filename(addr)
+  addr.gsub(/[^a-zA-Z0-1.,_-]/, "_")
+end
+
+
 def blah(msg)
   if $debug
     $stderr.puts "collect_diffs.rb: #{msg}"
@@ -129,7 +144,14 @@
   changes = Array.new
   i = 0
   while i < cvs_info.length
-    changes << ChangeInfo.new(cvs_info[i], cvs_info[i+=1], cvs_info[i+=1])
+    change_file = cvs_info[i]
+    # It's been reported,
+    # http://lists.badgers-in-foil.co.uk/pipermail/cvsspam-devel/2005-September/000380.html
+    # that sometimes the second revision number that CVS gives us contains a
+    # trailing newline character, so we strip ws from these values before use,
+    change_from = cvs_info[i+=1].strip
+    change_to = cvs_info[i+=1].strip
+    changes << ChangeInfo.new(change_file, change_from, change_to)
     i+=1
   end
   return changes
@@ -222,6 +244,7 @@
 
       diff_cmd = Array.new << $cvs_prog << "-nq" << "diff" << "-Nu"
       diff_cmd << "-kk" if $diff_ignore_keywords
+      diff_cmd << "-b" if $diff_ignore_whitespace
 
       if change.isAddition
         file.write "#A "
@@ -333,9 +356,11 @@
 end
 
 $config = nil
+$from_address = nil
 $cvs_prog = "cvs"
 $debug = false
 $diff_ignore_keywords = false
+$diff_ignore_whitespace = false
 $task_keywords = []
 
 unless ENV.has_key?('CVSROOT')
@@ -387,6 +412,7 @@
   end
   $config = arg if opt=="--config"
   $debug = true if opt == "--debug"
+  $from_address = arg if opt == "--from"
 end
 
 blah("CVSROOT is #{ENV['CVSROOT']}")
Index: record_lastdir.rb
===================================================================
--- record_lastdir.rb	(.../tags/RELEASE-0_2_12)	(revision 275)
+++ record_lastdir.rb	(.../trunk)	(revision 275)
@@ -4,7 +4,6 @@
 #   http://www.badgers-in-foil.co.uk/projects/cvsspam/
 # Copyright (c) David Holroyd
 
-$repositorydir = ARGV.shift
 
 $tmpdir = ENV["TMPDIR"] || "/tmp"
 
@@ -19,6 +18,36 @@
   nil
 end
 
+
+# transform any special / unexpected characters appearing in the argument to
+# --from so that they will not cause problems if the value is inserted into
+# a file or directory name
+def make_fromaddr_safe_for_filename(addr)
+  addr.gsub(/[^a-zA-Z0-1.,_-]/, "_")
+end
+
+# Option processing doesn't use GetoptLong (for the moment) bacause arguments
+# given to this script by CVS include the names of committed files.  It
+# seems quite possible that one of those file names could begin with a '-'
+# and therefore be treated by GetoptLong as a value which requires processing.
+# This would probably result in an error.
+#
+# [That could be worked around by placing a '--' option (which tells GetoptLong
+# to stop processing option arguments) at the very end of the arguments to
+# record_lastdir.rb in commitinfo, but that's very easily forgotten, and isn't
+# really backwards compatable with the behaviour of older CVSspam releases.]
+if ARGV.first == "--from"
+  # we could, of course, be tricked, if the first committed file in the list
+  # happened to be named '--from' :S
+
+  # drop the "--from"
+  ARGV.shift
+  # and use the value which was given following the option,
+  $dirtemplate << "." << make_fromaddr_safe_for_filename(ARGV.shift)
+end
+
+$repositorydir = ARGV.shift
+
 $datadir = find_data_dir()
 
 if $datadir==nil

Property changes on: TODO
___________________________________________________________________
Deleted: svn:executable
   - *

Index: project.xml
===================================================================
Index: svn_post_commit_hook.rb
===================================================================
--- svn_post_commit_hook.rb	(.../tags/RELEASE-0_2_12)	(revision 0)
+++ svn_post_commit_hook.rb	(.../trunk)	(revision 275)
@@ -0,0 +1,410 @@
+#!/usr/bin/ruby -w
+
+$svnlook_exe = "svnlook"  # default assumes the program is in $PATH
+
+def usage(msg)
+  $stderr.puts(msg)
+  exit(1)
+end
+
+def blah(msg)
+  if $debug
+    $stderr.puts "svn_post_commit_hook.rb: #{msg}"
+  end
+end
+
+$debug = false
+$tmpdir = ENV["TMPDIR"] || "/tmp"
+$dirtemplate = "#svnspam.#{Process.getpgrp}.#{Process.uid}"
+# arguments to pass though to 'cvsspam.rb'
+$passthrough_args = []
+
+def make_data_dir
+  dir = "#{$tmpdir}/#{$dirtemplate}-#{rand(99999999)}"
+  Dir.mkdir(dir, 0700)
+  dir
+end
+
+def init
+  $datadir = make_data_dir
+
+  # set PWD so that svnlook can create its .svnlook directory
+  Dir.chdir($datadir)
+end
+
+def cleanup
+  unless $debug
+	  File.unlink("#{$datadir}/logfile")
+	  Dir.rmdir($datadir)
+  end
+end
+
+def send_email
+  cmd = File.dirname($0) + "/cvsspam.rb"
+  unless system(cmd,"--svn","#{$datadir}/logfile", *$passthrough_args)
+    fail "problem running '#{cmd}'"
+  end
+end
+
+# Like IO.popen, but accepts multiple arguments like Kernel.exec
+# (So no need to escape shell metacharacters)
+def safer_popen(*args)
+  IO.popen("-") do |pipe|
+    if pipe==nil
+      exec(*args)
+    else
+      yield pipe
+    end
+  end
+end
+
+
+# Process the command-line arguments in the given list
+def process_args
+  require 'getoptlong'
+
+  opts = GetoptLong.new(
+    [ "--to",     "-t", GetoptLong::REQUIRED_ARGUMENT ],
+    [ "--config", "-c", GetoptLong::REQUIRED_ARGUMENT ],
+    [ "--debug",  "-d", GetoptLong::NO_ARGUMENT ],
+    [ "--from",   "-u", GetoptLong::REQUIRED_ARGUMENT ],
+    [ "--charset",      GetoptLong::REQUIRED_ARGUMENT ]
+  )
+
+  opts.each do |opt, arg|
+    if ["--to", "--config", "--from", "--charset"].include?(opt)
+      $passthrough_args << opt << arg
+    end
+    if ["--debug"].include?(opt)
+      $passthrough_args << opt
+    end
+    $config = arg if opt=="--config"
+    $debug = true if opt == "--debug"
+  end
+
+  $repository = ARGV[0]
+  $revision = ARGV[1]
+
+  unless $revision =~ /^\d+$/
+    usage("revision must be an integer: #{revision.inspect}")
+  end
+  $revision = $revision.to_i
+
+  unless FileTest.directory?($repository)
+    usage("no such directory: #{$repository.inspect}")
+  end
+end
+
+# runs the given svnlook subcommand
+def svnlook(cmd, revision, *args)
+  rev = revision.to_s
+  safer_popen($svnlook_exe, cmd, $repository, "-r", rev, *args) do |io|
+    yield io
+  end
+end
+
+class Change
+  def initialize(filechange, propchange, path)
+    @filechange = filechange
+    @propchange = propchange
+    @path = path
+  end
+
+  attr_accessor :filechange, :propchange, :path
+
+  def property_change?
+    @propchange != " "
+  end
+
+  def file_change?
+    @filechange != "_"
+  end
+
+  def addition?
+    @filechange == "A"
+  end
+
+  def deletion?
+    @filechange == "D"
+  end
+end
+
+
+
+# Line-oriented access to an underlying IO object.  Remembers 'current' line
+# for lookahead during parsing.
+class LineReader
+  def initialize(io)
+    @io = io
+  end
+
+  def current
+    @line
+  end
+
+  def next_line
+    (@line = @io.gets) != nil
+  end
+
+  def assert_current(re)
+    raise "unexpected #{current.inspect}" unless @line =~ re
+    $~
+  end
+
+  def assert_next(re=nil)
+    raise "unexpected end of text" unless next_line
+    unless re.nil?
+      raise "unexpected #{current.inspect}" unless @line =~ re
+    end
+    $~
+  end
+end
+
+
+def read_modified_diff(out, lines, path)
+  lines.assert_next(/^=+$/)
+  lines.assert_next
+  if lines.current =~ /\(Binary files differ\)/
+    process_modified_binary_diff(out, lines, path)
+  else
+    process_modified_text_diff(out, lines, path)
+  end
+end
+
+
+def process_modified_binary_diff(out, lines, path)
+  prev_rev= $revision-1
+  next_rev= $revision
+  out.puts "#V #{prev_rev},#{next_rev}"
+  out.puts "#M #{path}"
+  out.puts "#U diff x x"
+  out.puts "#U Binary files x and y differ"
+end
+
+
+def process_modified_text_diff(out, lines, path)
+  m = lines.assert_current(/^---.*\(rev (\d+)\)$/)
+  prev_rev = m[1].to_i
+  diff1 = lines.current
+  m = lines.assert_next(/^\+\+\+.*\(rev (\d+)\)$/)
+  next_rev = m[1].to_i
+  diff2 = lines.current
+  out.puts "#V #{prev_rev},#{next_rev}"
+  out.puts "#M #{path}"
+  out.puts "#U #{diff1}"
+  out.puts "#U #{diff2}"
+  while lines.next_line && lines.current =~ /^[-\+ @\\]/
+    out.puts "#U #{lines.current}"
+  end
+end
+
+def read_added_diff(out, lines, path)
+  lines.assert_next(/^=+$/)
+  lines.assert_next
+  if lines.current =~ /\(Binary files differ\)/
+    process_added_binary_diff(out, lines, path)
+  else
+    process_added_text_diff(out, lines, path)
+  end
+end
+
+def process_added_binary_diff(out, lines, path)
+  next_rev= $revision
+  out.puts "#V NONE,#{next_rev}"
+  out.puts "#A #{path}"
+  out.puts "#U diff x x"
+  out.puts "#U Binary file x added"
+end
+
+def process_added_text_diff(out, lines, path)
+  m = lines.assert_current(/^---.*\(rev (\d+)\)$/)
+  prev_rev = m[1].to_i
+  diff1 = lines.current
+  m = lines.assert_next(/^\+\+\+.*\(rev (\d+)\)$/)
+  next_rev = m[1].to_i
+  diff2 = lines.current
+  out.puts "#V NONE,#{next_rev}"
+  out.puts "#A #{path}"
+  out.puts "#U #{diff1}"
+  out.puts "#U #{diff2}"
+  while lines.next_line && lines.current =~ /^[-\+ @\\]/
+    out.puts "#U #{lines.current}"
+  end
+end
+
+def read_deleted_diff(out, lines, path)
+  lines.assert_next(/^=+$/)
+  m = lines.assert_next(/^---.*\(rev (\d+)\)$/)
+  prev_rev = m[1].to_i
+  diff1 = lines.current
+  m = lines.assert_next(/^\+\+\+.*\(rev (\d+)\)$/)
+  next_rev = m[1].to_i
+  diff2 = lines.current
+  out.puts "#V #{prev_rev},NONE"
+  out.puts "#R #{path}"
+  out.puts "#U #{diff1}"
+  out.puts "#U #{diff2}"
+  while lines.next_line && lines.current =~ /^[-\+ @\\]/
+    out.puts "#U #{lines.current}"
+  end
+end
+
+def read_property_lines(path, prop_name, revision)
+  lines = []
+  svnlook("propget", revision, prop_name, path) do |io|
+    io.each_line do |line|
+      lines << line.chomp
+    end
+  end
+  lines
+end
+
+def assert_prop_match(a, b)
+  if !b.nil? && a != b
+    raise "property mismatch: #{a.inspect}!=#{b.inspect}"
+  end
+end
+
+# We need to read the property change from the output of svnlook, but have
+# a difficulty in that there's no unambiguous delimiter marking the end of
+# a potentially multi-line property value.  Therefore, we do a seperate
+# svn propget on the given file to get the value of the property on its own,
+# and then use that value as a guide as to how much data to read from the
+# svnlook output.
+def munch_prop_text(path, prop_name, revision, lines, line0)
+  prop = read_property_lines(path, prop_name, revision)
+  if prop.empty?
+    assert_prop_match(line0, "")
+    return
+  end
+  assert_prop_match(line0, prop.shift)
+  prop.each do |prop_line|
+    lines.assert_next
+    assert_prop_match(lines.current.chomp, prop_line)
+  end
+end
+
+def read_properties_changed(out, lines, path)
+  prev_rev= $revision-1
+  next_rev= $revision
+  lines.assert_next(/^_+$/)
+  return unless lines.next_line
+  out.puts "#V #{prev_rev},#{next_rev}"
+  out.puts "#P #{path}"
+# The first three get consumed and not highlighted
+  out.puts "#U "
+  out.puts "#U Property changes:"
+  out.puts "#U "
+
+  while true
+    break unless lines.current =~ /^(?:Name|Added|Deleted): (.+)$/
+
+    prop_name = $1
+    m = lines.assert_next(/^   ([-+]) (.*)/)
+    op = m[1]
+    line0 = m[2]
+    if op == "-"
+      munch_prop_text(path, prop_name, $revision-1, lines, line0)
+      if lines.next_line && lines.current =~ /^   \+ (.*)/
+	munch_prop_text(path, prop_name, $revision, lines, $1)
+	lines.next_line
+      end
+    else  # op == "+"
+      munch_prop_text(path, prop_name, $revision, lines, line0)
+      lines.next_line
+    end
+    out.puts "#U #{m[1]} #{prop_name}:#{m[2]}"
+  end
+  out.puts "#U "
+end
+
+def handle_copy(out, lines, path, from_ref, from_file)
+  prev_rev= $revision-1
+  next_rev= $revision
+  out.puts "#V #{from_file}:#{prev_rev},#{next_rev}"
+  out.puts "#C #{path}"
+  if lines.next_line && lines.current =~ /^=+$/
+    m = lines.assert_next(/^---.*\(rev (\d+)\)$/)
+    prev_rev = m[1].to_i
+    diff1 = lines.current
+    m = lines.assert_next(/^\+\+\+.*\(rev (\d+)\)$/)
+    next_rev = m[1].to_i
+    diff2 = lines.current
+    out.puts "#U #{diff1}"
+    out.puts "#U #{diff2}"
+    while lines.next_line && lines.current =~ /^[-\+ @\\]/
+      out.puts "#U #{lines.current}"
+    end
+  else
+    out.puts "#U "
+    out.puts "#U Copied from #{from_file}:#{from_ref}"
+    out.puts "#U "
+  end
+end
+
+def svnlook_author
+  svnlook("author", $revision) do |io|
+    return io.readline.chomp
+  end
+  nil
+end
+
+def find_author
+  return if $passthrough_args.include?("--from")
+  author = svnlook_author
+  if author
+    blah("Author from svnlook: '#{author}'")
+    $passthrough_args << "--from" << author
+  end
+end
+
+def process_svnlook_log(file)
+  svnlook("log", $revision) do |io|
+    io.each_line do |line|
+      file.puts("#> #{line}")
+    end
+  end
+end
+
+def process_svnlook_diff(file)
+  svnlook("diff", $revision) do |io|
+    lines = LineReader.new(io)
+    while lines.next_line
+      if lines.current =~ /^Modified:\s+(.*)/
+	read_modified_diff(file, lines, $1)
+      elsif lines.current =~ /^Added:\s+(.*)/
+	read_added_diff(file, lines, $1)
+      elsif lines.current =~ /^Copied:\s+(.*) \(from rev (\d+), (.*)\)$/
+	handle_copy(file, lines, $1, $2, $3)
+      elsif lines.current =~ /^Deleted:\s+(.*)/
+	read_deleted_diff(file, lines, $1)
+      elsif lines.current =~ /^Property changes on:\s+(.*)/
+	read_properties_changed(file, lines, $1)
+      elsif lines.current == "\n"
+	# ignore
+      else
+	raise "unable to parse line '#{lines.current.inspect}'"
+      end
+    end
+  end
+end
+
+def process_commit()
+  File.open("#{$datadir}/logfile", File::WRONLY|File::CREAT) do |file|
+    process_svnlook_log(file)
+    process_svnlook_diff(file)
+  end
+end
+
+
+def main
+  init()
+  process_args()
+  find_author()
+  process_commit()
+  send_email()
+  cleanup()
+end
+
+
+main

Property changes on: svn_post_commit_hook.rb
___________________________________________________________________
Added: svn:mergeinfo
Added: svn:executable
   + *


Property changes on: COPYING
___________________________________________________________________
Deleted: svn:executable
   - *

Index: CREDITS
===================================================================
--- CREDITS	(.../tags/RELEASE-0_2_12)	(revision 275)
+++ CREDITS	(.../trunk)	(revision 275)
@@ -29,3 +29,10 @@