<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[1075] sites/trunk: Add the Slack commit hook.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/1075">1075</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/1075","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>nacin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-12-30 22:36:32 +0000 (Tue, 30 Dec 2014)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Add the Slack commit hook.</pre>
<h3>Added Paths</h3>
<ul>
<li>sites/trunk/svn.wordpress.org/</li>
<li>sites/trunk/svn.wordpress.org/bin/</li>
<li><a href="#sitestrunksvnwordpressorgbinslackcommithookphp">sites/trunk/svn.wordpress.org/bin/slack-commit-hook.php</a></li>
<li>sites/trunk/svn.wordpress.org/includes/</li>
<li>sites/trunk/svn.wordpress.org/includes/slack-commit-hook/</li>
<li><a href="#sitestrunksvnwordpressorgincludesslackcommithookconfigphp">sites/trunk/svn.wordpress.org/includes/slack-commit-hook/config.php</a></li>
<li><a href="#sitestrunksvnwordpressorgincludesslackcommithooksenderphp">sites/trunk/svn.wordpress.org/includes/slack-commit-hook/sender.php</a></li>
<li><a href="#sitestrunksvnwordpressorgincludesslackcommithooktracphp">sites/trunk/svn.wordpress.org/includes/slack-commit-hook/trac.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunksvnwordpressorgbinslackcommithookphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/svn.wordpress.org/bin/slack-commit-hook.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/svn.wordpress.org/bin/slack-commit-hook.php (rev 0)
+++ sites/trunk/svn.wordpress.org/bin/slack-commit-hook.php 2014-12-30 22:36:32 UTC (rev 1075)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,20 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+#!/usr/bin/env php
+<?php
+
+if ( $argc !== 4 ) {
+ echo "Usage: <trac> <repo> <rev>\n";
+ exit( 1 );
+}
+
+define( 'INC', dirname( __DIR__ ) . '/includes/slack-commit-hook/' );
+require INC . 'sender.php';
+require INC . 'trac.php';
+require INC . 'config.php';
+
+list( , $trac, $repo, $rev ) = $argv;
+
+$slack_hook = 'https://hooks.slack.com/services/...';
+$sender = new \SlackCommitHook\Sender( $trac, $repo, $rev, $slack_hook );
+// $sender->use_test_channel( true );
+// $sender->set_svnlook_executable( ... );
+$sender->run();
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/svn.wordpress.org/bin/slack-commit-hook.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunksvnwordpressorgincludesslackcommithookconfigphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/svn.wordpress.org/includes/slack-commit-hook/config.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/svn.wordpress.org/includes/slack-commit-hook/config.php (rev 0)
+++ sites/trunk/svn.wordpress.org/includes/slack-commit-hook/config.php 2014-12-30 22:36:32 UTC (rev 1075)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,65 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace SlackCommitHook;
+
+class Core_Trac extends Trac {
+ protected $channels = array( '#core', '#core-commits' );
+ protected $username = 'WordPress commit';
+ protected $ticket_range = array( 3, 5 );
+ protected $commit_range = array( 3, 5 );
+
+ /**
+ * File paths that cause commits to be piped to particular channels.
+ * Start regex matches with # as your delimiter.
+ */
+ protected $channel_matcher = array(
+ 'wp-content/themes' => '#core-themes',
+ 'customize' => '#core-customize',
+ 'editor-expand.js' => '#feature-focus',
+ 'wp-admin/css/edit.css' => '#feature-focus',
+ 'wp-admin/css/editor.css' => '#feature-focus',
+ 'press-this.php' => '#feature-pressthis',
+ );
+}
+
+class Meta_Trac extends Trac {
+ protected $channels = array( '#meta', '#meta-commits' );
+ protected $username = 'WordPress.org Meta commit';
+
+ protected $channel_matcher = array(
+ 'translate.wordpress.org/' => '#meta-i18n',
+ 'global.wordpress.org/' => '#meta-i18n',
+ 'translations' => '#meta-i18n',
+ 'developer-reference/' => '#meta-devhub',
+ 'wporg-developer/' => '#meta-devhub',
+ );
+}
+
+class bbPress_Trac extends Trac {
+ protected $channels = array( '#bbpress', '#bbpress-commits' );
+ protected $username = 'bbPress commit';
+ protected $color = '#080';
+ protected $emoji = ':bbpress:';
+}
+
+class BuddyPress_Trac extends Trac {
+ protected $channels = array( '#buddypress', '#buddypress-commits' );
+ protected $username = 'BuddyPress commit';
+ protected $color = '#d84800';
+ protected $emoji = ':buddypress:';
+}
+
+class Dotorg_Trac extends Trac {
+ protected $channels = 'dotorg';
+ protected $username = 'Private dotorg commit';
+}
+
+class Deploy_Trac extends Trac {
+ protected $channels = 'dotorg';
+ protected $username = 'Deploy commit';
+}
+
+class GlotPress_Trac extends Trac {
+ protected $channels = '#glotpress';
+ protected $username = 'GlotPress commit';
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/svn.wordpress.org/includes/slack-commit-hook/config.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunksvnwordpressorgincludesslackcommithooksenderphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/svn.wordpress.org/includes/slack-commit-hook/sender.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/svn.wordpress.org/includes/slack-commit-hook/sender.php (rev 0)
+++ sites/trunk/svn.wordpress.org/includes/slack-commit-hook/sender.php 2014-12-30 22:36:32 UTC (rev 1075)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,119 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace SlackCommitHook;
+
+class Sender {
+ protected $trac;
+ protected $repo;
+ protected $rev;
+ protected $slack_hook;
+
+ protected $test_mode = false;
+ protected $svnlook = '/usr/bin/svnlook';
+
+ public function __construct( $trac, $repo, $rev, $slack_hook ) {
+ $this->set_trac( $trac );
+ $this->repo = $repo;
+ $this->rev = $rev;
+ $this->slack_hook = $slack_hook;
+ }
+
+ public function use_test_channel( $enabled ) {
+ $this->test_mode = (bool) $enabled;
+ }
+
+ public function set_svnlook_executable( $path ) {
+ $this->svnlook = $path;
+ }
+
+ public function run() {
+ $payload = $this->generate_payload();
+ foreach ( $this->trac->get_channels( $this->svnlook( 'changed' ) ) as $channel ) {
+ $this->send( $channel, $payload );
+ }
+ }
+
+ protected function set_trac( $trac ) {
+ $class = __NAMESPACE__ . '\\' . $trac . '_Trac';
+ $this->trac = new $class;
+ }
+
+ protected function generate_payload() {
+ $author = $this->svnlook( 'author' );
+ $log = $this->format_log_for_slack( $this->svnlook( 'log' ) );
+
+ $url = $this->trac->get_commit_template( $this->rev );
+ $revision = 'r' . $this->rev;
+
+ $username = $this->trac->get_username();
+ $emoji = $this->trac->get_emoji();
+ $color = $this->trac->get_color();
+
+ $pretext = "*$username <$url|$revision>* by $author:";
+ $fallback = "$revision by $author: $log";
+
+ return array(
+ 'channel' => '#test',
+ 'username' => $username,
+ 'icon_emoji' => $emoji,
+ 'attachments' => array( array(
+ 'color' => $color,
+ 'pretext' => $pretext,
+ 'text' => $log,
+ 'fallback' => $fallback,
+ 'mrkdwn_in' => array( 'text', 'pretext' ),
+ ) ),
+ );
+ }
+
+ protected function format_log_for_slack( $log ) {
+ foreach ( $this->trac->get_log_replacements() as $find => $replace ) {
+ $log = preg_replace( $find, '<' . $replace . '|$0>', $log );
+ }
+ return $log;
+ }
+
+ protected function svnlook( $subcommand ) {
+ $args = array(
+ $subcommand,
+ '-r' . $this->rev,
+ $this->repo,
+ );
+ $args = array_map( 'escapeshellarg', $args );
+ $command = escapeshellcmd( $this->svnlook ) . ' ' . implode( ' ', $args );
+
+ if ( $subcommand === 'changed' ) {
+ $command .= ' | awk \'{print $2}\'';
+ }
+
+ exec( $command, $output, $return_var );
+ if ( $return_var === 0 ) {
+ return trim( implode( "\n", $output ) );
+ }
+ $this->error( "Error processing svnlook( $subcommand )" );
+ }
+
+ protected function error( $message ) {
+ error_log( $message . ' for ' . $this->repo . ' -r ' . $this->rev );
+ exit( 1 );
+ }
+
+ protected function send( $channel, $payload ) {
+ if ( $this->test_mode ) {
+ $payload['attachments'][0]['pretext'] = "[$channel] " . $payload['attachments'][0]['pretext'];
+ $payload['attachments'][0]['fallback'] = "[$channel] " . $payload['attachments'][0]['fallback'];
+ } else {
+ $payload['channel'] = $channel;
+ }
+
+ $context = stream_context_create( array(
+ 'http' => array(
+ 'method' => 'POST',
+ 'header' => 'Content-Type: application/x-www-form-urlencoded' . PHP_EOL,
+ 'content' => http_build_query( array( 'payload' => json_encode( $payload ) ) ),
+ ),
+ ) );
+
+ file_get_contents( $this->slack_hook, false, $context );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/svn.wordpress.org/includes/slack-commit-hook/sender.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunksvnwordpressorgincludesslackcommithooktracphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/svn.wordpress.org/includes/slack-commit-hook/trac.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/svn.wordpress.org/includes/slack-commit-hook/trac.php (rev 0)
+++ sites/trunk/svn.wordpress.org/includes/slack-commit-hook/trac.php 2014-12-30 22:36:32 UTC (rev 1075)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,77 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace SlackCommitHook;
+
+abstract class Trac {
+ protected $channels = '#test';
+ protected $username = 'Commit';
+ protected $color = '#21759b';
+ protected $emoji = ':wordpress:';
+
+ protected $ticket_template = 'https://%s.trac.wordpress.org/ticket/%s';
+ protected $commit_template = 'https://%s.trac.wordpress.org/changeset/%s';
+ protected $ticket_range = array( 1, 5 );
+ protected $commit_range = array( 1, 5 );
+
+ function __construct() {
+ $this->trac = str_replace( '_trac', '', strtolower( get_class( $this ) ) );
+ }
+
+ function get_username() {
+ return $this->username;
+ }
+
+ function get_color() {
+ return $this->color;
+ }
+
+ function get_emoji() {
+ return $this->emoji;
+ }
+
+ function get_ticket_template( $template = '%s' ) {
+ return sprintf( $this->ticket_template, $this->trac, $template );
+ }
+
+ function get_commit_template( $template = '%s' ) {
+ return sprintf( $this->commit_template, $this->trac, $template );
+ }
+
+ function get_digit_capture( $range ) {
+ $min = $range[0] - 1;
+ $max = $range[1] - 1;
+ return '[0-9]\d{' . $min . ',' . $max . '}';
+ }
+
+ function get_log_replacements() {
+ $commit_template = $this->get_commit_template( '$1' );
+ $ticket_digits = $this->get_digit_capture( $this->ticket_range );
+ $commit_digits = $this->get_digit_capture( $this->commit_range );
+
+ return array(
+ "/#($ticket_digits)\b/" => $this->get_ticket_template( '$1' ),
+ "/\[($commit_digits)\]/" => $commit_template,
+ "/\br($commit_digits)\b/" => $commit_template,
+ );
+ }
+
+ function get_channels( $changed_files = null ) {
+ $channels = (array) $this->channels;
+
+ if ( empty( $this->channel_matcher ) || empty( $changed_files ) ) {
+ return $channels;
+ }
+
+ foreach ( $this->channel_matcher as $needle => $channels_to_add ) {
+ if ( $match[0] === '#' ) {
+ // Append PCRE_MULTILINE so ^ and $ refer to individual lines.
+ if ( preg_match( $needle . 'm', $changed_files ) ) {
+ $channels = array_merge( $channels, (array) $channels_to_add );
+ }
+ } elseif ( false !== strpos( $changed_files, $needle ) ) {
+ $channels = array_merge( $channels, (array) $channels_to_add );
+ }
+ }
+ return $channels;
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/svn.wordpress.org/includes/slack-commit-hook/trac.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>