package SVN::Notify; # $Id: Notify.pm 4616 2009-03-19 16:56:09Z david $ use strict; require 5.006_000; use constant WIN32 => $^O eq 'MSWin32'; use constant PERL58 => $] > 5.007_000; require Encode if PERL58; $SVN::Notify::VERSION = '2.79'; # Make sure any output (such as from _dbpnt()) triggers no Perl warnings. if (PERL58) { # Dupe them? binmode STDOUT, ':utf8'; binmode STDERR, ':utf8'; } =begin comment Fake-out Module::Build. Delete if it ever changes to support =head1 headers other than all uppercase. =head1 NAME SVN::Notify - Subversion activity notification =end comment =head1 Name SVN::Notify - Subversion activity notification =head1 Synopsis Use F in F: svnnotify --repos-path "$1" --revision "$2" \ --to developers@example.com [options] svnnotify --repos-path "$1" --revision "$2" \ --to-cx-regex i10n@example.com=I10N [options] Use the class in a custom script: use SVN::Notify; my $notifier = SVN::Notify->new(%params); $notifier->prepare; $notifier->execute; =head1 Description This class may be used for sending email messages for Subversion repository activity. There are a number of different modes supported, and SVN::Notify is fully subclassable, to add new functionality, and offers L to easily modify the format of its messages. By default, A list of all the files affected by the commit will be assembled and listed in a single message. An additional option allows diffs to be calculated for the changes and either appended to the message or added as an attachment. See the C and C options below. =head1 Usage To use SVN::Notify, simply add a call to F to your Subversion repository's F script. This script lives in the F directory at the root of the repository directory; consult the documentation in F for details. Make sure that you specify the complete path to F, as well as to F and F in the options passed to F so that everything executes properly. And if you specify any string options, be sure that they are in the encoding specified by the C<--encoding> option, or UTF-8 if you have not specified C<--encoding>. =head2 Windows Usage To get SVN::Notify to work properly in a F script, you must set the following environment variables, as they will likely not be present inside Apache: =over =item PATH=C:\perl\bin =item OS=Windows_NT =item SystemRoot=C:\WINDOWS =back See L for more detailed information on getting SVN::Notify running on Windows. If you have issues with asynchronous execution, try using F (L) to run F. =cut # Map the svnlook changed codes to nice labels. my %map = ( U => 'Modified Paths', A => 'Added Paths', D => 'Removed Paths', _ => 'Property Changed', ); my %filters; ############################################################################## =head1 Class Interface =head2 Constructor =head3 new my $notifier = SVN::Notify->new(%params); Constructs and returns a new SVN::Notify object. This object is a handle on the whole process of collecting meta data and content for the commit email and then sending it. As such, it takes a number of parameters to affect that process. Each of these parameters has a corresponding command-line option that can be passed to F. The options have the same names as these parameters, but any underscores you see here should be replaced with dashes when passed to F. Most also have a corresponding single-character option. On Perl 5.8 and higher, If you pass parameters to C, they B be L if they have any non-ASCII characters. Supported parameters: =over =item repos_path svnnotify --repos-path "$PATH" svnnotify -p "$PATH" The path to the Subversion repository. The path is passed as the first argument when Subversion executes F. So you can simply pass C<$1> to this parameter if you like. See the documentation in F for details. Required. =item revision svnnotify --revision "$REV" svnnotify -r "$REV" The revision number for the current commit. The revision number is passed as the second argument when Subversion executes F. So you can simply pass C<$2> to this parameter if you like. See the documentation in F for details. Required. =item to svnnotify --to commiters@example.com svnnotify -t commiters@example.com --to managers@example.com The address or addresses to which to send the notification email. Can be used multiple times to specify multiple addresses. This parameter is required unless either C or C is specified. =item to_regex_map svnnotify --to-regex-map translate@example.com=L18N \ -x legal@example.com=License This parameter specifies a hash reference of email addresses to regular expression strings. SVN::Notify will compile the regular expression strings into regular expression objects, and then send notification messages if and only if the name of one or more of the directories affected by a commit matches the regular expression. This is a good way to have a notification email sent to a particular mail address (or comma-delimited list of addresses) only for certain parts of the subversion tree. This parameter is required unless C or C is specified. The command-line options, C<--to-regex_map> and C<-x>, can be specified any number of times, once for each entry in the hash to be passed to C. The value passed to the option must be in the form of the key and the value separated by an equal sign. Consult the L documentation for more information. Here's an example complements of Matt Doar of how to use C to do per-branch matching: author=`svnlook author $REPOS -r $REV` # The mail regexes should match all the top-level directories /usr/bin/svnnotify --repos-path "$REPOS" --revision "$REV" \ -x eng-bar@example.com,${EXTRAS}="^Bar" \ -x eng-foo@example.com,${EXTRAS}="^trunk/Foo|^branches/Foo|^tags/Foo" \ -x $author@example.com="^users" --subject-cx =item to_email_map svnnotify --to-email-map L18N=translate@example.com \ --to-email-map License=legal@example.com The inverse of C: The regular expression is the hash key and the email address or addresses are the value. =item from svnnotify --from somewhere@example.com svnnotify -f elsewhere@example.com The email address to use in the "From" line of the email. If not specified, SVN::Notify will use the username from the commit, as returned by C. =item user_domain svnnotify --user-domain example.com svnnotify -D example.net A domain name to append to the username for the "From" header of the email. During a Subversion commit, the username returned by C is usually something like a Unix login name. SVN::Notify will use this username in the email "From" header unless the C parameter is specified. If you wish to have the username take the form of a real email address, specify a domain name and SVN::Notify will append C<\@$domain_name> to the username in order to create a real email address. This can be useful if all of your committers have an email address that corresponds to their username at the domain specified by the C parameter. =item svnlook svnnotify --svnlook /path/to/svnlook svnnotify -l /path/to/svnlook The location of the F executable. If not specified, SVN::Notify will search through the directories in the C<$PATH> environment variable, plus in F and F, for an F executable. Specify a full path to F via this option or by setting the C<$SVNLOOK> environment variable if F isn't in your path or to avoid loading L. It's important to provide a complete path to F because the environment during the execution of F is anemic, with nary a C<$PATH> environment variable to be found. So if F appears not to be working at all (and Subversion seems loathe to log when it dies!), make sure that you have specified the complete path to a working F executable. =item sendmail svnnotify --sendmail /path/to/sendmail svnnotify -s /path/to/sendmail The location of the F executable. If neither the C nor the C parameter is specified, SVN::Notify will search through the directories in the C<$PATH> environment variable, plus in F and F, for an F executable. Specify a full path to F via this option or by setting the C<$SENDMAIL> environment variable if F isn't in your path or to avoid loading L. The same caveats as applied to the location of the F executable apply here. =item set_sender svnnotify --set-sender svnnotify -E Uses the C<-f> option to C to set the envelope sender address of the email to the same address as is used for the "From" header. If you're also using the C option, be sure to make it B an email address. Don't include any other junk in it, like a sender's name. Ignored when using C. =item smtp svnnotify --smtp smtp.example.com The address for an SMTP server through which to send the notification email. If unspecified, SVN::Notify will use F to send the message. If F is not installed locally (such as on Windows boxes!), you I specify an SMTP server. =item smtp_user svnnotify --smtp-user myuser The user name for SMTP authentication. If this option is specified, SVN::Notify will use L to send the notification message, and will of course authenticate to the SMTP server. =item smtp_pass svnnotify --smtp-pass mypassword The password for SMTP authentication. Use in parallel with C. =item smtp_authtype svnnotify --smtp-authtype authtype The authentication method to use for authenticating to the SMTP server. The available authentication types include "PLAIN", "NTLM", "CRAM_MD5", and others. Consult the L documentation for a complete list. Defaults to "PLAIN". =item encoding svnnotify --encoding UTF-8 svnnotify -c Big5 The character set typically used on the repository for log messages, file names, and file contents. Used to specify the character set in the email Content-Type headers and, when the C parameter is specified, the C<$LANG> environment variable when launching C. See L for more information. Defaults to "UTF-8". =item charset svnnotify --charset UTF-8 Deprecated. Use C instead. =item svn_encoding svnnotify --svn-encoding euc-jp The character set used in files and log messages managed in Subversion. It's useful to set this option if you store files in Subversion using one character set but want to send notification messages in a different character set. Therefore C would be used for the notification message, and C would be used to read in data from Subversion. See L for more information. Defaults to the value stored in C. =item diff_encoding svnnotify --diff-encoding iso-2022-jp The character set used by files in Subversion, and thus present in the the diff. It's useful to set this option if you store files in Subversion using one character write log messages in a different character set. Therefore C would be used to read the log message and C would be used to read the diff from Subversion. See L for more information. Defaults to the value stored in C. =item language svnnotify --language fr svnnotify -g i-klingon The language typically used on the repository for log messages, file names, and file contents. Used to specify the email Content-Language header and to set the C<$LANG> environment variable to C<< $notify->language . '.' . $notify->encoding >> before executing C and C (but not for sending data to Net::SMTP). Undefined by default, meaning that no Content-Language header is output and the C<$LANG> environment variable will not be set. See L for more information. =item with_diff svnnotify --with-diff svnnotify -d A boolean value specifying whether or not to include the output of C in the notification email. The diff will be inline at the end of the email unless the C parameter specifies a true value. =item attach_diff svnnotify --attach-diff svnnotify -a A boolean value specifying whether or not to attach the output of C to the notification email. Rather than being inline in the body of the email, this parameter causes SVN::Notify to attach the diff as a separate file, named for the user who triggered the commit and the date and time UTC at which the commit took place. Specifying this parameter to a true value implicitly sets the C parameter to a true value. =item diff_switches svnnotify --diff-switches '--no-diff-added' svnnotify -w '--no-diff-deleted' Switches to pass to C, such as C<--no-diff-deleted> and C<--no-diff-added>. And who knows, maybe someday it will support the same options as C, such as C<--diff-cmd> and C<--extensions>. Only relevant when used with C or C. =item reply_to svnnotify --reply-to devlist@example.com svnnotify -R developers@example.net The email address to use in the "Reply-To" header of the notification email. No "Reply-To" header will be added to the email if no value is specified for the C parameter. =item add_headers svnnotify --add-header X-Approve=letMeIn Add a header to the notification email message. The header name and its value must be separated by an equals sign. Specify the option multiple times in order to add multiple headers. Headers with the same names are allowed. Not to be confused with the C<--header> option, which adds introductory text to the beginning of the email body. =item subject_prefix svnnotify --subject-prefix [Devlist] svnnotify -P [%d (Our-Developers)] An optional string to prepend to the beginning of the subject line of the notification email. If it contains '%d', it will be used to place the revision number; otherwise it will simply be prepended to the subject, which will contain the revision number in brackets. =item subject_cx svnnotify --subject-cx svnnotify -C A boolean value indicating whether or not to include a the context of the commit in the subject line of the email. In a commit that affects multiple files, the context will be the name of the shortest directory affected by the commit. This should indicate up to how high up the Subversion repository tree the commit had an effect. If the commit affects a single file, then the context will simply be the name of that file. =item strip_cx_regex svnnotify --strip-cx-regex '^trunk/' svnnotify --strip-cx-regex '^trunk/' --strip-cx-regex '^branches/' svnnotify -X '^trunk' svnnotify -X '^trunk' -X '^branches' One or more regular expressions to be used to strip out parts of the subject context. This can be useful for very deep Subversion trees, where the commits you're sending will always be sent from a particular subtree, so you'd like to remove part of the tree. Used only if C is set to a true value. Pass an array reference if calling C directly. =item no_first_line svnnotify --no-first-line svnnotify -O Omits the first line of the log message from the subject. This is most useful when used in combination with the C parameter, so that just the commit context is displayed in the subject and no part of the log message. =item header svnnotify --header 'SVN::Notify is brought to you by Kineticode. Adds a specified text to each message as a header at the beginning of the body of the message. Not to be confused with the C<--add-header> option, which adds a header to the headers section of the email. =item footer svnnotify --footer 'Copyright (R) by Kineticode, Inc.' Adds a specified text to each message as a footer at the end of the body of the message. =item max_sub_length svnnotify --max-sub-length 72 svnnotify -i 76 The maximum length of the notification email subject line. SVN::Notify includes the first line of the commit log message, or the first sentence of the message (defined as any text up to the string ". "), whichever is shorter. This could potentially be quite long. To prevent the subject from being over a certain number of characters, specify a maximum length here, and SVN::Notify will truncate the subject to the last word under that length. =item max_diff_length svnnotify --max-diff-length 1024 The maximum length of the diff (attached or in the body). The diff output is truncated at the last line under the maximum character count specified and then outputs an additional line indicating that the maximum diff size was reached and output truncated. This is helpful when a large diff output could cause a message to bounce due to message size. =item handler svnnotify --handler HTML svnnotify -H HTML Specify the subclass of SVN::Notify to be constructed and returned, and therefore to handle the notification. Of course you can just use a subclass directly, but this parameter is designed to make it easy to just use C<< SVN::Notify->new >> without worrying about loading subclasses, such as in F. Be sure to read the documentation for your subclass of choice, as there may be additional parameters and existing parameters may behave differently. =item filters svnnotify --filter Trac -F My::Filter SVN::Notify->new( %params, filters => ['Markdown', 'My::Filter'] ); Specify a more module to be loaded in the expectation that it defines output filters. For example, L loads a filter that converts log messages from Trac's markup format to HTML. L, available on CPAN, does the same for Markdown format. Check CPAN for other SVN::Notify filter modules. This command-line option can be specified more than once to load multiple filters. The C parameter to C should be an array reference of modules names. If a value contains "::", it is assumed to be a complete module name. Otherwise, it is assumed to be in the SVN::Notify::Filter name space. See L for details on writing your own output filters (it's really easy, I promise!). =item author_url svnnotify --author-url 'http://svn.example.com/changelog/~author=%s/repos' svnnotify --A 'mailto:%s@example.com' If a URL is specified for this parameter, then it will be used to create a link for the current author. The URL can have the "%s" format where the author's username should be put into the URL. =item revision_url svnnotify --revision-url 'http://svn.example.com/changelog/?cs=%s' svnnotify -U 'http://svn.example.com/changelog/?cs=%s' If a URL is specified for this parameter, then it will be used to create a link to the Subversion browser URL corresponding to the current revision number. It will also be used to create links to any other revision numbers mentioned in the commit message. The URL must have the "%s" format where the Subversion revision number should be put into the URL. =item svnweb_url svnnotify --svnweb-url 'http://svn.example.com/index.cgi/revision/?rev=%s' svnnotify -S 'http://svn.example.net/index.cgi/revision/?rev=%s' Deprecated. Use C instead. =item viewcvs_url svnnotify --viewcvs-url 'http://svn.example.com/viewcvs/?rev=%s&view=rev' Deprecated. Use C instead. =item ticket_map svnnotify --ticket-map '\[?#\s*(\d+)\s*\]?=http://example.com/ticket?id=%s' \ --ticket-map 'rt=http://rt.cpan.org/NoAuth/Bugs.html?id=%s' \ --ticket-map '\b([A-Z]+-\d+)\b=http://jira/browse/%s' Specifies a mapping between a regular expression and a URL. The regular expression should return a single match to be interpolated into the URL, which should be a C format using "%s" to place the match (usually the ticket identifier) from the regex. The command-line option may be specified any number of times for different ticketing systems. To the API, it must be passed as a hash reference. The first example matches "[#1234]" or "#1234" or "[# 1234]". This regex should be as specific as possible, preferably wrapped in "\b" to match word boundaries. If you're using L, be sure to read its documentation for a different regular expression requirement! Optionally, the key value can be a placeholder for a regular expression used internally by SVN::Notify to match strings typically used for well-known ticketing systems. Those keys are: =over =item rt Matches Request Tracker (RT) ticket references of the form "Ticket # 12", "ticket 6", "RT # 52", "rt 52", "RT-Ticket # 213" or even "Ticket#1066". =item bugzilla Matches Bugzilla bug references of the form "Bug # 12" or "bug 6" or even "Bug#1066". =item jira Matches JIRA references of the form "JRA-1234". =item gnats Matches GnatsWeb references of the form "PR 1234". =back =item rt_url svnnotify --rt-url 'http://rt.cpan.org/NoAuth/Bugs.html?id=%s' svnnotify -T 'http://rt.perl.org/NoAuth/Bugs.html?id=%s' A shortcut for C<--ticket-map 'rt=$url'> provided for backwards compatibility. =item bugzilla_url svnnotify --bugzilla-url 'http://bugzilla.mozilla.org/show_bug.cgi?id=%s' svnnotify -B 'http://bugs.bricolage.cc/show_bug.cgi?id=%s' A shortcut for C<--ticket-map 'bugzilla=$url'> provided for backwards compatibility. =item jira_url svnnotify --jira-url 'http://jira.atlassian.com/secure/ViewIssue.jspa?key=%s' svnnotify -J 'http://nagoya.apache.org/jira/secure/ViewIssue.jspa?key=%s' A shortcut for C<--ticket-map 'jira=$url'> provided for backwards compatibility. =item gnats_url svnnotify --gnats-url 'http://gnatsweb.example.com/cgi-bin/gnatsweb.pl?cmd=view&pr=%s' svnnotify -G 'http://gnatsweb.example.com/cgi-bin/gnatsweb.pl?cmd=view&pr=%s' A shortcut for C<--ticket-map 'gnats=$url'> provided for backwards compatibility. =item ticket_url svnnotify --ticket-url 'http://ticket.example.com/showticket.html?id=%s' Deprecated. Use C, instead. =item ticket_regex svnnotify --ticket-regex '\[?#\s*(\d+)\s*\]?' Deprecated. Use C, instead. =item verbose svnnotify --verbose -V A value between 0 and 3 specifying how verbose SVN::Notify should be. The default is 0, meaning that SVN::Notify will be silent. A value of 1 causes SVN::Notify to output some information about what it's doing, while 2 and 3 each cause greater verbosity. To set the verbosity on the command line, simply pass the C<--verbose> or C<-V> option once for each level of verbosity, up to three times. Output from SVN::Notify is sent to C. =item boundary The boundary to use between email body text and attachments. This is normally generated by SVN::Notify. =item subject The subject of the email to be sent. This attribute is normally generated by C. =back =cut # XXX Sneakily used by SVN::Notify::HTML. Change to use class methods? our %_ticket_regexen = ( rt => '\b((?:rt|(?:rt-)?ticket:?)\s*#?\s*(\d+))\b', bugzilla => '\b(bug\s*#?\s*(\d+))\b', jira => '\b([A-Z]+-\d+)\b', gnats => '\b(PR\s*(\d+))\b', ); sub new { my ($class, %params) = @_; # Delegate to a subclass if requested. if (my $handler = delete $params{handler}) { my $subclass = __PACKAGE__ . "::$handler"; unless ($subclass eq $class) { eval "require $subclass" or die $@; return $subclass->new(%params); } } # Load any filters. $params{filters} ||= {}; if (ref $params{filters} eq 'ARRAY') { my $filts = {}; for my $pkg ( @{ $params{filters} } ) { $pkg = "SVN::Notify::Filter::$pkg" if $pkg !~ /::/; if ($filters{$pkg}) { while (my ($k, $v) = each %{ $filters{$pkg} }) { $filts->{$k} ||= []; push @{ $filts->{$k} }, $v; } } else { eval "require $pkg" or die $@; $filters{$pkg} = {}; no strict 'refs'; while ( my ($k, $v) = each %{ "$pkg\::" } ) { my $code = *{$v}{CODE} or next; $filters{$pkg}->{$k} = $code; $filts->{$k} ||= []; push @{ $filts->{$k} }, $code; } } } $params{filters} = $filts; } # Make sure that the tos are an arrayref. $params{to} = [ $params{to} || () ] unless ref $params{to}; # Check for required parameters. $class->_dbpnt( "Checking required parameters to new()") if $params{verbose}; _usage( qq{Missing required "repos_path" parameter} ) unless $params{repos_path}; _usage( qq{Missing required "revision" parameter} ) unless $params{revision}; # Set up default values. $params{svnlook} ||= $ENV{SVNLOOK} || $class->find_exe('svnlook'); $params{with_diff} ||= $params{attach_diff}; $params{verbose} ||= 0; $params{encoding} ||= $params{charset} || 'UTF-8'; $params{svn_encoding} ||= $params{encoding}; $params{diff_encoding} ||= $params{svn_encoding}; $params{smtp_authtype} ||= 'PLAIN'; $params{sendmail} ||= $ENV{SENDMAIL} || $class->find_exe('sendmail') unless $params{smtp}; _usage( qq{Cannot find sendmail and no "smtp" parameter specified} ) unless $params{sendmail} || $params{smtp}; # Set up the environment locale. if ( $params{language} && !$ENV{LANG} ) { ( my $lang_country = $params{language} ) =~ s/-/_/g; for my $p qw(encoding svn_encoding) { my $encoding = $params{$p}; $encoding =~ s/-//g if uc($encoding) ne 'UTF-8'; (my $label = $p ) =~ s/(_?)encoding/$1/; $params{"${label}env_lang"} = "$lang_country.$encoding"; } } # Set up the revision URL. $params{revision_url} ||= delete $params{svnweb_url} || delete $params{viewcvs_url}; if ($params{revision_url} && $params{revision_url} !~ /%s/) { warn "--revision-url must have '%s' format\n"; $params{revision_url} .= '/revision/?rev=%s&view=rev' } # Set up the issue tracking links. my $track = $params{ticket_map}; if ($params{ticket_regex}) { $track->{ delete $params{ticket_regex} } = delete $params{ticket_url}; } for my $system (qw(rt bugzilla jira gnats)) { my $param = $system . '_url'; if ($params{ $param }) { $track->{ $system } = delete $params{ $param }; warn "--$system-url must have '%s' format\n" unless $track->{ $system } =~ /%s/; } } $params{ticket_map} = $track if $track; # Make it so! $class->_dbpnt( "Instantiating $class object") if $params{verbose}; return bless \%params, $class; } ############################################################################## =head2 Class Methods =head3 content_type my $content_type = SVN::Notify->content_type; Returns the content type of the notification message, "text/plain". Used to set the Content-Type header for the message. =cut sub content_type { 'text/plain' } ############################################################################## =head3 register_attributes SVN::Notify::Subclass->register_attributes( foo_attr => 'foo-attr=s', bar => 'bar', bat => undef, ); This class method is used by subclasses to register new attributes. Pass in a list of key/value pairs, where the keys are the attribute names and the values are option specifications in the format required by Getopt::Long. SVN::Notify will create accessors for each attribute, and if the corresponding value is defined, it will be used by the C class method to get a command-line option value. See for an example usage of C. =cut my %OPTS; sub register_attributes { my $class = shift; my @attrs; while (@_) { push @attrs, shift; if (my $opt = shift) { $OPTS{$attrs[-1]} = $opt; } } $class->_accessors(@attrs); } ############################################################################## =head3 get_options my $options = SVN::Notify->get_options; Parses the command-line options in C<@ARGV> to a hash reference suitable for passing as the parameters to C. See L<"new"> for a complete list of the supported parameters and their corresponding command-line options. This method use Getopt::Long to parse C<@ARGV>. It then looks for any C and C options and, if it finds any, loads the appropriate classes and parses any options they requires from C<@ARGV>. Subclasses and filter classes should use C to register any attributes and options they require. After that, on Perl 5.8 and later, it decodes all of the string option from the encoding specified by the C option or UTF-8. This allows options to be passed to SVN::Notify in that encoding and end up being displayed properly in the resulting notification message. =cut sub get_options { my $class = shift; my $opts = {}; require Getopt::Long; # Enable bundling and, at the same time, case-sensitive matching of # single character options. Also enable pass-through so that subclasses # can grab more options. Getopt::Long::Configure (qw(bundling pass_through)); # Get options. Getopt::Long::GetOptions( 'repos-path|p=s' => \$opts->{repos_path}, 'revision|r=s' => \$opts->{revision}, 'to|t=s@' => \$opts->{to}, 'to-regex-map|x=s%' => \$opts->{to_regex_map}, 'to-email-map=s%' => \$opts->{to_email_map}, 'from|f=s' => \$opts->{from}, 'user-domain|D=s' => \$opts->{user_domain}, 'svnlook|l=s' => \$opts->{svnlook}, 'sendmail|s=s' => \$opts->{sendmail}, 'set-sender|E' => \$opts->{set_sender}, 'smtp=s' => \$opts->{smtp}, 'encoding|charset|c=s'=> \$opts->{encoding}, 'diff-encoding=s' => \$opts->{diff_encoding}, 'svn-encoding=s' => \$opts->{svn_encoding}, 'language|g=s' => \$opts->{language}, 'with-diff|d' => \$opts->{with_diff}, 'attach-diff|a' => \$opts->{attach_diff}, 'diff-switches|w=s' => \$opts->{diff_switches}, 'reply-to|R=s' => \$opts->{reply_to}, 'subject-prefix|P=s' => \$opts->{subject_prefix}, 'subject-cx|C' => \$opts->{subject_cx}, 'strip-cx-regex|X=s@' => \$opts->{strip_cx_regex}, 'no-first-line|O' => \$opts->{no_first_line}, 'max-sub-length|i=i' => \$opts->{max_sub_length}, 'max-diff-length|e=i' => \$opts->{max_diff_length}, 'handler|H=s' => \$opts->{handler}, 'filter|F=s@' => \$opts->{filters}, 'author-url|A=s' => \$opts->{author_url}, 'ticket-regex=s' => \$opts->{ticket_regex}, 'ticket-map=s%' => \$opts->{ticket_map}, 'verbose|V+' => \$opts->{verbose}, 'help|h' => \$opts->{help}, 'man|m' => \$opts->{man}, 'version|v' => \$opts->{version}, 'header=s' => \$opts->{header}, 'footer=s' => \$opts->{footer}, 'smtp-user=s' => \$opts->{smtp_user}, 'smtp-pass=s' => \$opts->{smtp_pass}, 'smtp-authtype=s' => \$opts->{smtp_authtype}, 'add-header=s%' => sub { shift; push @{ $opts->{add_headers}{+shift} }, shift }, 'revision-url|U|svnweb-url|S|viewcvs-url=s' => \$opts->{revision_url}, 'rt-url|T|bugzilla-url|B|jira-url|J|gnats-url|G|ticket-url=s' => \$opts->{ticket_url}, ) or return; # Load a subclass if one has been specified. if (my $hand = $opts->{handler}) { eval "require " . __PACKAGE__ . "::$hand" or die $@; if ($hand eq 'Alternative') { # Load the alternative subclasses. Getopt::Long::GetOptions( map { delete $OPTS{$_} => \$opts->{$_} } keys %OPTS ); for my $alt (@{ $opts->{alternatives} || ['HTML']}) { eval "require " . __PACKAGE__ . "::$alt" or die $@; } } } # Load any filters. if ($opts->{filters}) { for my $pkg ( @{ $opts->{filters} } ) { $pkg = "SVN::Notify::Filter::$pkg" if $pkg !~ /::/; eval "require $pkg" or die $@; } } # Disallow pass-through so that any invalid options will now fail. Getopt::Long::Configure (qw(no_pass_through)); my @to_decode; if (%OPTS) { # Get a list of string options we'll need to decode. @to_decode = map { $OPTS{$_} } grep { /=s$/ } keys %OPTS if PERL58; # Load any other options. Getopt::Long::GetOptions( map { delete $OPTS{$_} => \$opts->{$_} } keys %OPTS ); } else { # Call GetOptions() again so that invalid options will be properly # caught. Getopt::Long::GetOptions(); } if (PERL58) { # Decode all string options. my $encoding = $opts->{encoding} || 'UTF-8'; for my $opt ( qw( repos_path revision from user_domain svnlook sendmail smtp diff_switches reply_to subject_prefix handler author_url ticket_regex header footer smtp_user smtp_pass smtp_authtype revision_url ticket_url ), @to_decode ) { $opts->{$opt} = Encode::decode( $encoding, $opts->{$opt} ) if $opts->{$opt}; } } # Clear the extra options specifications and return. %OPTS = (); return $opts; } ############################################################################## =head3 file_label_map my $map = SVN::Notify->file_label_map; Returns a hash reference of the labels to be used for the lists of files. A hash reference of file lists is stored in the C attribute after C has been called. The hash keys in that list correspond to Subversion status codes, and these are mapped to their appropriate labels by the hash reference returned by this method: { U => 'Modified Paths', A => 'Added Paths', D => 'Removed Paths', _ => 'Property Changed' } =cut sub file_label_map { \%map } ############################################################################## =head3 find_exe my $exe = SVN::Notify->find_exe($exe_name); This method searches through the system path, as well as the extra directories F and F (because they're common paths for C and C for an executable file with the name C<$exe_name>. The first one it finds is returned with its full path. If none is found, C returns undef. =cut sub find_exe { my ($class, $exe) = @_; $exe .= '.exe' if WIN32; require File::Spec; require Config; for my $path ( File::Spec->path, qw(/usr/local/bin /usr/bin /usr/sbin), 'C:\\program files\\subversion\\bin', $Config::Config{installbin}, $Config::Config{installscript}, ) { my $file = File::Spec->catfile($path, $exe); return $file if -f $file && -x _; } return; } ############################################################################## =head1 Instance Interface =head2 Instance Methods =head3 prepare $notifier->prepare; Prepares the SVN::Notify object, collecting all the data it needs in preparation for sending the notification email. Really it's just a shortcut for: $notifier->prepare_recipients; $notifier->prepare_contents; $notifier->prepare_files; $notifier->prepare_subject; Only it returns after the call to C if there are no recipients (that is, as when recipients are specified solely by the C or C parameter and none of the regular expressions match any of the affected directories). =cut sub prepare { my $self = shift; $self->run_filters('pre_prepare'); _usage( qq{Missing required "to", "to_regex_map", or "to_email_map" parameter} ) unless @{$self->{to}} || $self->{to_regex_map} || $self->{to_email_map}; $self->prepare_recipients; return $self unless @{ $self->{to} }; $self->prepare_contents; $self->prepare_files; $self->prepare_subject; $self->run_filters('post_prepare'); return $self; } ############################################################################## =head3 prepare_recipients $notifier->prepare_recipients; Collects and prepares a list of the notification recipients. The recipients are a combination of the value passed to the C parameter as well as any email addresses specified as keys in the hash reference passed C parameter or values passed to the C parameter, where the corresponding regular expressions stored in the hash matches one or more of the names of the directories affected by the commit. If the F parameter to C has a true value, C also determines the directory name to use for the context. =cut sub prepare_recipients { my $self = shift; $self->_dbpnt( "Preparing recipients list") if $self->{verbose}; unless ( $self->{to_regex_map} || $self->{subject_cx} || $self->{to_email_map} ) { $self->{to} = $self->run_filters( recipients => $self->{to} ); return $self; } # Prevent duplication. my $tos = $self->{to} = [ @{ $self->{to} } ]; my $regexen = $self->{to_regex_map} && $self->{to_email_map} ? [ %{ $self->{to_regex_map} }, reverse %{ $self->{to_email_map } } ] : $self->{to_regex_map} ? [ %{ $self->{to_regex_map} } ] : $self->{to_email_map} ? [ reverse %{ $self->{to_email_map } } ] : undef; if ($regexen) { $self->_dbpnt( "Compiling regex_map regular expressions") if $self->{verbose} > 1; for (my $i = 1; $i < @$regexen; $i += 2) { $self->_dbpnt( qq{Compiling "$_"}) if $self->{verbose} > 2; # Remove initial slash and compile. $regexen->[$i] =~ s|^\^[/\\]|^|; $regexen->[$i] = qr/$regexen->[$i]/; } } else { $regexen = []; } local $ENV{LANG} = "$self->{svn_env_lang}" if $self->{svn_env_lang}; my $fh = $self->_pipe( $self->{svn_encoding}, '-|', $self->{svnlook}, 'dirs-changed', $self->{repos_path}, '-r', $self->{revision}, ); # Read in a list of the directories changed. my ($cx, %seen); while (<$fh>) { s/[\n\r\/\\]+$//; for (my $i = 0; $i < @$regexen; $i += 2) { my ($email, $rx) = @{$regexen}[$i, $i + 1]; # If the directory matches the regex, save the email. if (/$rx/) { $self->_dbpnt( qq{"$_" matched $rx}) if $self->{verbose} > 2; push @$tos, $email unless $seen{$email}++; } } # Grab the context if it's needed for the subject. if ($self->{subject_cx}) { # XXX Do we need to set utf8 here? my $l = length; $cx ||= $_; $cx =~ s{[/\\]?[^/\\]+$}{} until !$cx || m{^\Q$cx\E(?:$|/|\\)}; } } $self->_dbpnt( qq{Context is "$cx"}) if $self->{subject_cx} && $self->{verbose} > 1; close $fh or warn "Child process exited: $?\n"; $self->{cx} = $cx; $tos = $self->run_filters( recipients => $tos ); $self->_dbpnt( 'Recipients: "', join(', ', @$tos), '"') if $self->{verbose} > 1; return $self; } ############################################################################## =head3 prepare_contents $notifier->prepare_contents; Prepares the contents of the commit message, including the name of the user who triggered the commit (and therefore the contents of the "From" header to be used in the email) and the log message. =cut sub prepare_contents { my $self = shift; $self->_dbpnt( "Preparing contents") if $self->{verbose}; local $ENV{LANG} = "$self->{svn_env_lang}" if $self->{svn_env_lang}; my $lines = $self->_read_pipe($self->{svnlook}, 'info', $self->{repos_path}, '-r', $self->{revision}); $self->{user} = shift @$lines; $self->{date} = shift @$lines; $self->{message_size} = shift @$lines; $self->{message} = $lines; # Set up the from address. unless ($self->{from}) { $self->{from} = $self->{user} . ( $self->{user_domain} ? "\@$self->{user_domain}" : '' ); } $self->{from} = $self->run_filters( from => $self->{from} ); if ($self->{verbose} > 1) { $self->_dbpnt( "From: $self->{from}"); $self->_dbpnt( "Message: @$lines"); } return $self; } ############################################################################## =head3 prepare_files $notifier->prepare_files; Prepares the lists of files affected by the commit, sorting them into their categories: modified files, added files, and deleted files. It also compiles a list of files wherein a property was set, which might have some overlap with the list of modified files (if a single commit both modified a file and set a property on it). If the C parameter was specified and a single file was affected by the commit, then C will also specify that file name as the context to be used in the subject line of the commit email. =cut sub prepare_files { my $self = shift; $self->_dbpnt( "Preparing file lists") if $self->{verbose}; my %files; local $ENV{LANG} = "$self->{svn_env_lang}" if $self->{svn_env_lang}; my $fh = $self->_pipe( $self->{svn_encoding}, '-|', $self->{svnlook}, 'changed', $self->{repos_path}, '-r', $self->{revision}, ); # Read in a list of changed files. my $cx = $_ = <$fh>; do { s/[\n\r]+$//; if (s/^(.)(.)\s+//) { $self->_dbpnt( "$1,$2 => $_") if $self->{verbose} > 2; push @{$files{$1}}, $_; push @{$files{_}}, $_ if $2 ne ' ' && $1 ne '_'; } } while (<$fh>); if ($self->{subject_cx} && $. == 1) { # There's only one file; it's the context. $cx =~ s/[\n\r]+$//; ($self->{cx} = $cx) =~ s/^..\s+//; $self->_dbpnt( qq{File context is "$self->{cx}"}) if $self->{verbose} > 1; } # Wait till we get here to close the file handle, otherwise $. gets reset # to 0! close $fh or warn "Child process exited: $?\n"; $self->{files} = \%files; return $self; } ############################################################################## =head3 prepare_subject $notifier->prepare_subject; Prepares the subject line for the notification email. This method B be called after C and C, since each of those methods potentially sets up the context for use in the the subject line. The subject may have a prefix defined by the C parameter to C, it has the revision number, it might have the context if the C specified a true value, and it will have the first sentence or line of the commit, whichever is shorter. The subject may then be truncated to the maximum length specified by the C parameter. =cut sub prepare_subject { my $self = shift; $self->_dbpnt( "Preparing subject") if $self->{verbose}; $self->{subject} = ''; # Start with the optional message and revision number.. if ( defined $self->{subject_prefix} ) { if ( index($self->{subject_prefix}, '%d') > 0 ) { $self->{subject} .= sprintf $self->{subject_prefix}, $self->{revision}; } else { $self->{subject} .= $self->{subject_prefix} . "[$self->{revision}] "; } } else { $self->{subject} .= "[$self->{revision}] "; } # Add the context if there is one. if ($self->{cx}) { if (my $rx = $self->{strip_cx_regex}) { $self->{cx} =~ s/$_// for @$rx; } my $space = $self->{no_first_line} ? '' : ': '; $self->{subject} .= $self->{cx} . $space if $self->{cx}; } # Add the first sentence/line from the log message. unless ($self->{no_first_line}) { # Truncate to first period after a minimum of 10 characters. my $i = index substr($self->{message}[0], 10), '. '; $self->{subject} .= $i > 0 ? substr($self->{message}[0], 0, $i + 11) : $self->{message}[0]; } # Truncate to the last word under 72 characters. $self->{subject} =~ s/^(.{0,$self->{max_sub_length}})\s+.*$/$1/m if $self->{max_sub_length} && length $self->{subject} > $self->{max_sub_length}; # Now filter it. $self->{subject} = $self->run_filters( subject => $self->{subject} ); $self->_dbpnt( qq{Subject is "$self->{subject}"}) if $self->{verbose}; return $self; } ############################################################################## =head3 execute $notifier->execute; Sends the notification message. This involves opening a file handle to F or a tied file handle connected to an SMTP server and passing it to C. This is the main method used to send notifications or execute any other actions in response to Subversion activity. =cut sub execute { my $self = shift; $self->_dbpnt( "Sending message") if $self->{verbose}; $self->run_filters('pre_execute'); return $self unless @{ $self->{to} }; my $out = $self->{smtp} ? SVN::Notify::SMTP->get_handle($self) : do { local $ENV{LANG} = $self->{env_lang} if $self->{env_lang}; $self->_pipe( $self->{encoding}, '|-', $self->{sendmail}, '-oi', '-t', ($self->{set_sender} ? ('-f', $self->{from}) : ()) ); }; # Output the message. $self->output($out); close $out or warn "Child process exited: $?\n"; $self->_dbpnt( 'Message sent' ) if $self->{verbose}; $self->run_filters('post_execute'); return $self; } ############################################################################## =head3 output $notifier->output($file_handle); $notifier->output($file_handle, $no_headers); Called internally by C to output a complete email message. The file a file handle, so that C and its related methods can print directly to the email message. The optional second argument, if true, will suppress the output of the email headers. Really C is a simple wrapper around a number of other method calls. It is thus essentially a shortcut for: $notifier->output_headers($out) unless $no_headers; $notifier->output_content_type($out); $notifier->start_body($out); $notifier->output_metadata($out); $notifier->output_log_message($out); $notifier->output_file_lists($out); if ($notifier->with_diff) { my $diff_handle = $self->diff_handle; if ($notifier->attach_diff) { $notifier->end_body($out); $notifier->output_attached_diff($out, $diff_handle); } else { $notifier->output_diff($out, $diff_handle); $notifier->end_body($out); } } else { $notifier->end_body($out); } $notifier->end_message($out); =cut sub output { my ($self, $out, $no_headers) = @_; $self->_dbpnt( "Outputting notification message") if $self->{verbose} > 1; $self->output_headers($out) unless $no_headers; $self->output_content_type($out); $self->start_body($out); $self->output_metadata($out); $self->output_log_message($out); $self->output_file_lists($out); if ($self->{with_diff}) { # Get a handle on the diff output. my $diff = $self->diff_handle; if ($self->{attach_diff}) { $self->end_body($out); $self->output_attached_diff($out, $diff); } else { $self->output_diff($out, $diff); $self->end_body($out); } } else { $self->end_body($out); } $self->end_message($out); return $self; } ############################################################################## =head3 output_headers $notifier->output_headers($file_handle); Outputs the headers for the notification message headers. Should be called only once for a single email message. =cut sub output_headers { my ($self, $out) = @_; $self->_dbpnt( "Outputting headers") if $self->{verbose} > 2; # Q-Encoding (RFC 2047) my $subj = PERL58 ? Encode::encode( 'MIME-Q', $self->{subject} ) : $self->{subject}; my @headers = ( "MIME-Version: 1.0\n", "X-Mailer: SVN::Notify " . $self->VERSION . ": http://search.cpan.org/dist/SVN-Notify/\n", "From: $self->{from}\n", "Errors-To: $self->{from}\n", "To: " . join ( ', ', @{ $self->{to} } ) . "\n", "Subject: $subj\n" ); push @headers, "Reply-To: $self->{reply_to}\n" if $self->{reply_to}; if (my $heads = $self->{add_headers}) { while (my ($k, $v) = each %{ $heads }) { push @headers, "$k: $_\n" for ref $v ? @{ $v } : $v; } } print $out @{ $self->run_filters( headers => \@headers ) }; return $self; } ############################################################################## =head3 output_content_type $notifier->output_content_type($file_handle); Outputs the content type and transfer encoding headers. These demarcate the body of the message. If the C parameter was set to true, then a boundary string will be generated and the Content-Type set to "multipart/mixed" and stored as the C attribute. After that, this method outputs the content type returned by C, the character set specified by the C attribute, and a Content-Transfer-Encoding of "8bit". Subclasses can either rely on this functionality or override this method to provide their own content type headers. =cut sub output_content_type { my ($self, $out) = @_; $self->_dbpnt( "Outputting content type") if $self->{verbose} > 2; # Output the content type. if ($self->{attach_diff}) { # We need a boundary string. $self->{boundary} ||= join '', ('a'..'z', 'A'..'Z', 0..9)[ map { rand 62 } 0..10]; print $out qq{Content-Type: multipart/mixed; boundary="$self->{boundary}"\n\n}; } my $ctype = $self->content_type; print $out "--$self->{boundary}\n" if $self->{attach_diff}; print $out "Content-Type: $ctype; charset=$self->{encoding}\n", ($self->{language} ? "Content-Language: $self->{language}\n" : ()), "Content-Transfer-Encoding: 8bit\n\n"; return $self; } ############################################################################## =head3 start_body $notifier->start_body($file_handle); This method starts the body of the notification message, which means that it outputs the contents of the C
attribute, if there are any. Otherwise it outputs nothing, but see subclasses for other behaviors. =cut sub start_body { my ($self, $out) = @_; my $start = [ $self->{header} ? ("$self->{header}\n") : () ]; $start = $self->run_filters( start_body => $start ); print $out @$start, "\n" if $start && @$start; return $self; } ############################################################################## =head3 output_metadata $notifier->output_metadata($file_handle); This method outputs the metadata of the commit, including the revision number, author (user), and date of the revision. If the C or C attributes have been set, then the appropriate URL(s) for the revision will also be output. =cut sub output_metadata { my ($self, $out) = @_; my @lines = ("Revision: $self->{revision}\n"); if (my $url = $self->{revision_url}) { push @lines, sprintf " $url\n", $self->{revision}; } # Output the Author any any relevant URL. push @lines, "Author: $self->{user}\n"; if (my $url = $self->{author_url}) { push @lines, sprintf " $url\n", $self->{user}; } push @lines, "Date: $self->{date}\n"; print $out @{ $self->run_filters( metadata => \@lines ) }; return $self; } ############################################################################## =head3 output_log_message $notifier->output_log_message($file_handle); Outputs the commit log message, as well as the label "Log Message". =cut sub output_log_message { my ($self, $out) = @_; $self->_dbpnt( "Outputting log message") if $self->{verbose} > 1; my $msg = join "\n", @{ $self->run_filters( log_message => $self->{message} ) }; print $out "Log Message:\n-----------\n$msg\n"; # Make Revision links. if (my $url = $self->{revision_url}) { if (my @matches = $msg =~ /\b(?:(?:rev(?:ision)?\s*#?\s*|r)(\d+))\b/ig) { print $out "\nRevision Links:\n--------------\n"; printf $out " $url\n", $_ for @matches; } } # Make ticketing system links. if (my $map = $self->ticket_map) { my $has_header = 0; $self->run_ticket_map( sub { my ($regex, $url) = @_; while ($msg =~ /$regex/ig) { unless ($has_header) { print $out "\nTicket Links:\n------------\n"; $has_header = 1; } printf $out " $url\n", $2 || $1; } } ); } return $self; } ############################################################################## =head3 output_file_lists $notifier->output_file_lists($file_handle); Outputs the lists of modified, added, and deleted files, as well as the list of files for which properties were changed. The labels used for each group are pulled in from the C class method. =cut sub output_file_lists { my ($self, $out) = @_; my $files = $self->{files} or return $self; $self->_dbpnt( "Outputting file lists") if $self->{verbose} > 1; my $map = $self->file_label_map; # Create the underlines. my %dash = ( map { $_ => '-' x length($map->{$_}) } keys %$map ); foreach my $type (qw(U A D _)) { # Skip it if there's nothing to report. next unless $files->{$type}; $self->_dbpnt( " Outputting $map->{$type} file list") if $self->{verbose} > 2; # Identify the action and output each file. print $out "\n", @{ $self->run_filters( file_lists => [ "$map->{$type}:\n", "$dash{$type}\n", map { " $_\n" } @{ $files->{$type} } ] ) }; } print $out "\n"; return $self; } ############################################################################## =head3 end_body $notifier->end_body($file_handle); Closes out the body of the email by outputting the contents of the C