<!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>[9366] sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr: Trac: Github PRs: When a PR is first detected referencing a ticket, add an inline mention to Trac.</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 { white-space: pre-line; 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/9366">9366</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/9366","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-12-19 08:23:03 +0000 (Thu, 19 Dec 2019)</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'>Trac: Github PRs: When a PR is first detected referencing a ticket, add an inline mention to Trac.
For now, this doesn't trigger email notifications.
See <a href="http://meta.trac.wordpress.org/ticket/4903">#4903</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorgtracprwebhookphp">sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/webhook.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorgtracprclasstracphp">sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/class-trac.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmldotorgtracprclasstracphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/class-trac.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/class-trac.php (rev 0)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/class-trac.php 2019-12-19 08:23:03 UTC (rev 9366)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,189 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\API\Trac\GithubPRs;
+
+class Trac {
+ protected $trac_uri = false;
+ protected $credentials = [];
+
+ public function __construct( $username, $password, $trac_uri ) {
+ $this->trac_uri = $trac_uri;
+ $this->credentials = [ $username, $password ];
+ }
+
+ /**
+ * Retrieve a Trac Ticket by ID.
+ */
+ function get( $id ) {
+ try {
+ $response = $this->api( 'ticket.get', [ $id ] );
+ } catch( \Exception $e ) {
+ return false;
+ }
+
+ return [
+ 'id' => $response[0],
+ ] + (array) $response[3];
+ }
+
+ /**
+ * Update a Trac ticket to add a comment, or alter ticket properties.
+ *
+ * To set the Author or Time of a comment, the Trac API user must have TICKET_ADMIN priv.
+ */
+ function update( $id, $comment, $attr = [], $notify = false, $author = false, $when = false ) {
+ if ( empty( $attr['_ts'] ) ) {
+ $get = $this->get( $id );
+ $attr['_ts'] = $get['_ts'];
+ }
+
+ if ( empty( $attr['action'] ) ) {
+ $attr['action'] = 'leave';
+ }
+
+ try {
+ $this->api( 'ticket.update', [ $id, $comment, $attr, (bool) $notify, $author, $when ] );
+
+ return true;
+ } catch( \Exception $e ) {
+ // Try once more.. `_ts` may have been outdated.
+ if ( isset( $get ) && $attr['_ts'] === $get['_ts'] ) {
+ $get = $this->get( $id ); // refetch the ticket.
+ $attr['_ts'] = $get['_ts'];
+ try {
+
+ $this->api( 'ticket.update', [ $id, $comment, $attr, (bool) $notify, $author, $when ] );
+ return true;
+ } catch( \Exception $e ) {
+ throw $e;
+ }
+ }
+ return false;
+ }
+ }
+
+ /**
+ * Retrieve ticket comments by Ticket ID.
+ */
+ function get_comments( $id ) {
+ try {
+ $response = $this->api( 'ticket.changeLog', [ $id ] );
+ } catch( \Exception $e ) {
+ return false;
+ }
+
+ foreach ( $response as $i => $c ) {
+ $response[ $i ] = [
+ 'time' => $c[0],
+ 'author' => $c[1],
+ 'field' => $c[2],
+ 'oldvalue' => $c[3],
+ 'newvalue' => $c[4],
+ 'permanent' => $c[5],
+ ];
+ }
+
+ return $response;
+ }
+
+ /**
+ * Fetch/POST a Trac JSONRPC endpoint.
+ */
+ public function api( $method, $params ) {
+ $context = stream_context_create( [ 'http' => [
+ 'method' => 'POST',
+ 'user_agent' => 'WordPress.org Trac; trac.WordPress.org',
+ 'max_redirects' => 0,
+ 'timeout' => 5,
+ 'ignore_errors' => true,
+ 'header' =>
+ [
+ 'Content-Type: application/json',
+ 'Authorization: Basic ' . base64_encode( $this->credentials[0] . ':' . $this->credentials[1] ),
+ ],
+ 'content' => json_encode( [
+ 'method' => $method,
+ 'params' => $this->trac_json_objectify( $params ),
+ ] ),
+ ] ] );
+
+ $json = file_get_contents(
+ $this->trac_uri,
+ false,
+ $context
+ );
+
+ $json = json_decode( $json );
+ if ( $json && $json->result ) {
+ $json = $json->result;
+ $json = $this->trac_json_deobjectify( $json );
+
+ } elseif ( $json && isset( $json->error ) ) {
+ throw new \Exception( 'JSON Error: ' . $json->error->code . ' ' . $json->error->message );
+ } elseif ( ! $json ) {
+ throw new \Exception( 'Trac API Error: Trac Unavailable.' );
+ }
+
+ return $json;
+ }
+
+ /**
+ * Encodes DateTime objects into the Trac Date JSON format.
+ */
+ protected function trac_json_objectify( $json ) {
+ foreach ( $json as $k => $v ) {
+ $value = $v;
+ if ( is_object( $v ) && $v instanceof \DateTime ) {
+ $value = (object) [
+ '__jsonclass__' => [
+ 'datetime',
+ $v->format('Y-m-d\TH:i:s')
+ ]
+ ];
+ } elseif ( is_array( $v ) || is_object( $v ) ) {
+ $value = $this->trac_json_objectify( $v );
+ }
+
+ if ( $value !== $v ) {
+ if ( is_object( $json ) ) {
+ $json->$k = $value;
+ } else {
+ $json[ $k ] = $value;
+ }
+ }
+ }
+
+ return $json;
+ }
+
+ /**
+ * Decodes a Trac JSON response into binary and DateTime objects where needed.
+ */
+ protected function trac_json_deobjectify( $json ) {
+ foreach ( $json as $k => $v ) {
+ $value = $v;
+ if ( is_object( $v ) && isset( $v->__jsonclass__ ) ) {
+ switch ( $v->__jsonclass__[0] ) {
+ case 'datetime':
+ $value = new \DateTime( $v->__jsonclass__[1] );
+ break;
+ case 'binary':
+ $value = base64_decode( $v->__jsonclass__[1] );
+ break;
+ }
+ } elseif ( is_array( $v ) || is_object( $v ) ) {
+ $value = $this->trac_json_deobjectify( $v );
+ }
+
+ if ( $value !== $v ) {
+ if ( is_object( $json ) ) {
+ $json->$k = $value;
+ } else {
+ $json[ $k ] = $value;
+ }
+ }
+ }
+
+ return $json;
+ }
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/class-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><a id="sitestrunkapiwordpressorgpublic_htmldotorgtracprwebhookphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/webhook.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/webhook.php 2019-12-19 08:21:26 UTC (rev 9365)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/trac/pr/webhook.php 2019-12-19 08:23:03 UTC (rev 9366)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5,6 +5,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require dirname( dirname( dirname( __DIR__ ) ) ) . '/includes/hyperdb/bb-10-hyper-db.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/functions.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require __DIR__ . '/class-trac.php';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function verify_signature() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Validate that the request came from GitHub.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,7 +75,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ]
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // TODO: Create a Trac ticket comment mentioning that the PR has been linked to the ticket.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add a mention to the Trac Ticket.
+ $trac_uri = 'https://' . $pr_data->trac_ticket[0] . '.trac.wordpress.org/login/rpc';
+ $trac = new Trac( GH_PRBOT_USER, GH_PRBOT_PASS, $trac_uri );
+
+ $trac->update(
+ $pr_data->trac_ticket[1],
+ "''This ticket was mentioned in [{$pr_data->html_url} PR #{$pr_number}] " .
+ "on [https://github.com/{$pr_repo}/ {$pr_repo}] " .
+ "by [{$pr_data->user->url} {$pr_data->user->name}].''"
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Step 4. Update all the instances of this PR with the new data, it may be linked to multiple tickets/tracs.
</span></span></pre>
</div>
</div>
</body>
</html>