<!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>[3983] sites/trunk/api.wordpress.org/public_html/dotorg/github-sync: GitHub Sync: Add support for the `application/x-www-form-urlencoded` webhook format and add documentation.</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/3983">3983</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/3983","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>2016-09-07 06:02:21 +0000 (Wed, 07 Sep 2016)</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'>GitHub Sync: Add support for the `application/x-www-form-urlencoded` webhook format and add documentation.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorggithubsyncfeaturepluginsphp">sites/trunk/api.wordpress.org/public_html/dotorg/github-sync/feature-plugins.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorggithubsyncfeaturepluginssh">sites/trunk/api.wordpress.org/public_html/dotorg/github-sync/feature-plugins.sh</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmldotorggithubsyncfeaturepluginsphp"></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/github-sync/feature-plugins.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/github-sync/feature-plugins.php 2016-09-06 21:12:07 UTC (rev 3982)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/github-sync/feature-plugins.php 2016-09-07 06:02:21 UTC (rev 3983)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,73 +1,84 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * A easy webhook to allow feature plugins to be sync'd to WordPress.org plugins SVN easier.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This webhook is very basic, but handles syncing a select few featured plugins over to plugins.svn.wordpress.org during development.
+ *
+ * To have your *feature project* handled by this sync script:
+ * - Ensure you're listed on https://make.wordpress.org/core/features-as-plugins/ if you're not, ping in #meta
+ * - Ping in #meta to get your project added to the whitelist within this file
+ * - Add `https://api.wordpress.org/dotorg/github-sync/feature-plugins.php` as a `push` webhook on github with the secret we'll provide you.
+ * - Push to github master and watch https://plugins.trac.wordpress.org/log/$plugin_slug/
+ * - Profit from all the Open Source points you're getting!
</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"> require dirname( dirname( __DIR__ ) ) . '/init.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> class GH2WORG {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- private $whitelisted_repos = array(
- // Github User/Repo => plugins.svn.wordpress.org/****/trunk/
- 'dd32/feature-plugin-testing' => 'test-plugin-3',
- 'voldemortensen/menu-customizer' => 'menu-customizer',
- 'georgestephanis/two-factor' => 'two-factor',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private $whitelisted_repos = [
+ // Github.com/{$user/repo-name} => plugins.svn.wordpress.org/{$slug}/trunk/
+ 'dd32/feature-plugin-testing' => 'test-plugin-3',
+ 'georgestephanis/two-factor' => 'two-factor',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'georgestephanis/application-passwords' => 'application-passwords',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'obenland/shiny-updates' => 'shiny-updates',
- 'pento/react' => 'react',
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'obenland/shiny-updates' => 'shiny-updates',
+ 'pento/react' => 'react',
+ ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function __construct() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->populate_post_vars();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $repo_name = $this->get_notified_repo();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $this->verify_github_signature() ) {
- die( 'Cheating, huh?' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $svn_directory = $this->whitelisted_repos[ $repo_name ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $repo_name = $_POST['repository']['full_name'];
- $repo_url = $_POST['repository']['git_url'];
-
- if ( ! $this->verify_valid_plugin( $repo_name ) ) {
- die( 'Sorry, This Github repo is not configured for WordPress.org Plugins SVN Github Sync. Please contact us.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $repo_name || ! $svn_directory ) {
+ die( 'Sorry, This Github repo is not configured for WordPress.org Plugins SVN Github Sync. Please ping in #meta on Slack for assistance.' );
</ins><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">- $svn_directory = $this->whitelisted_repos[ $repo_name ];
-
- $this->process_github_to_svn( $repo_url, $svn_directory );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->process_github_to_svn( $repo_name, $svn_directory );
</ins><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">- function populate_post_vars() {
- if ( 'application/json' == $_SERVER['HTTP_CONTENT_TYPE'] ) {
- $_POST = @json_decode( file_get_contents('php://input'), true );
- } else {
- // Assuming Magic Quotes disabled like a good host.
- $_POST = @json_decode( $_POST['payload'], true );
- }
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Determines the Github Repo (user/repo) which Github is notifying us about.
+ *
+ * - Extracts the repo from both `application/json` and `application/x-www-form-urlencoded` webhook variants.
+ * - Verifies the signature of the request
+ *
+ * @return string|bool Github repo on success, false on failure.
+ */
+ function get_notified_repo() {
+ $github_payload = file_get_contents( 'php://input' );
+ $signature_of_payload = 'sha1=' . hash_hmac( 'sha1', $github_payload, FEATURE_PLUGIN_GH_SYNC_SECRET );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function verify_github_signature() {
- if ( empty( $_SERVER['HTTP_X_HUB_SIGNATURE'] ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! hash_equals( $signature_of_payload, $_SERVER['HTTP_X_HUB_SIGNATURE'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- list( $algo, $hash ) = explode( '=', $_SERVER['HTTP_X_HUB_SIGNATURE'], 2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Extract the payload from the `php://input` stream, although this is also present in
+ * $_POST, the Github signature is of this raw data, so we'll use that data.
+ */
+ if ( 'application/x-www-form-urlencoded' === $_SERVER['HTTP_CONTENT_TYPE'] ) {
+ parse_str( $github_payload, $github_payload );
+ $github_payload = $github_payload['payload'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Todo? Doesn't handle standard $_POST, only application/json
- $hmac = hash_hmac( $algo, file_get_contents('php://input' ), FEATURE_PLUGIN_GH_SYNC_SECRET );
-
- return $hash === $hmac;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return json_decode( $github_payload, true )['repository']['full_name'];
</ins><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">- function verify_valid_plugin( $repo ) {
- return isset( $this->whitelisted_repos[ $repo ] );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Triggers the shell script to migrate the Git commit to plugins.svn
+ *
+ * @param string $github_repo The Github Repo which was modified (user/repo).
+ * @param string $svn_directory The plugins.svn directory/plugin (plugin-slug).
+ */
+ function process_github_to_svn( $github_repo, $svn_directory ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function process_github_to_svn( $github_url, $svn_directory ) {
-
- putenv( 'PHP_SVN_USER=' . FEATURE_PLUGIN_GH_SYNC_USER );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ putenv( 'PHP_SVN_USER=' . FEATURE_PLUGIN_GH_SYNC_USER );
</ins><span class="cx" style="display: block; padding: 0 10px"> putenv( 'PHP_SVN_PASSWORD=' . FEATURE_PLUGIN_GH_SYNC_PASS );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo shell_exec( __DIR__ . "/feature-plugins.sh $github_url $svn_directory 2>&1" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $github_repo = escapeshellarg( $github_repo );
+ $svn_directory = escapeshellarg( $svn_directory );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo shell_exec( __DIR__ . "/feature-plugins.sh $github_repo $svn_directory 2>&1" );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> putenv( 'PHP_SVN_USER' );
</span><span class="cx" style="display: block; padding: 0 10px"> putenv( 'PHP_SVN_PASSWORD' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmldotorggithubsyncfeaturepluginssh"></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/github-sync/feature-plugins.sh</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/dotorg/github-sync/feature-plugins.sh 2016-09-06 21:12:07 UTC (rev 3982)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/github-sync/feature-plugins.sh 2016-09-07 06:02:21 UTC (rev 3983)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,6 +1,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> #!/bin/bash
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-GITHUB_URL=$1;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+GITHUB_REPO=$1;
</ins><span class="cx" style="display: block; padding: 0 10px"> SVN_PLUGIN=$2;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> # Expect ENV vars: $PHP_SVN_USER, $PHP_SVN_PASSWORD
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,10 +15,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> fi;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> # Validate all Parameters are present
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-if [ ! $GITHUB_URL ] || [ ! $SVN_PLUGIN ] || [ ! $PHP_SVN_USER ] || [ ! $PHP_SVN_PASSWORD ]; then
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+if [ ! $GITHUB_REPO ] || [ ! $SVN_PLUGIN ] || [ ! $PHP_SVN_USER ] || [ ! $PHP_SVN_PASSWORD ]; then
</ins><span class="cx" style="display: block; padding: 0 10px"> echo "Invalid Input, missing parameter"; exit 1
</span><span class="cx" style="display: block; padding: 0 10px"> fi
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+GITHUB_URL="git://github.com/$GITHUB_REPO.git"
</ins><span class="cx" style="display: block; padding: 0 10px"> SVN_URL="https://plugins.svn.wordpress.org/$SVN_PLUGIN/trunk/"
</span><span class="cx" style="display: block; padding: 0 10px"> ASSETS_SVN_URL="https://plugins.svn.wordpress.org/$SVN_PLUGIN/assets/"
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>