<!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>[3367] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api: Plugin Directory: Add an internal API for managing ZIP files on each web node.</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/3367">3367</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/3367","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-06-15 03:47:15 +0000 (Wed, 15 Jun 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'>Plugin Directory: Add an internal API for managing ZIP files on each web node.
See <a href="http://meta.trac.wordpress.org/ticket/1578">#1578</a>, <a href="http://meta.trac.wordpress.org/ticket/1720">#1720</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryapiclassbasephp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryapiroutesclasszipmanagementphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-zip-management.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryapiclassbasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php 2016-06-14 22:46:04 UTC (rev 3366)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php 2016-06-15 03:47:15 UTC (rev 3367)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,6 +16,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> new Routes\Popular_Categories();
</span><span class="cx" style="display: block; padding: 0 10px"> new Routes\Query_Plugins();
</span><span class="cx" style="display: block; padding: 0 10px"> new Routes\SVN_Access();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ new Routes\Zip_Management();
</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"> /**
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryapiroutesclasszipmanagementphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-zip-management.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-zip-management.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-zip-management.php 2016-06-15 03:47:15 UTC (rev 3367)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,148 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\Plugin_Directory\API\Routes;
+use WordPressdotorg\Plugin_Directory\Plugin_Directory;
+use WordPressdotorg\Plugin_Directory\API\Base;
+use WordPressdotorg\Plugin_Directory\ZIP;
+use WP_REST_Server;
+use Exception;
+
+/**
+ * An internal API endpoint used to manage the plugin ZIP files on the server.
+ *
+ * Each WordPress.org server manages it's own set of plugin ZIP files, this API
+ * endpoint allows a script to remotely perform commands on plugin zip files.
+ *
+ * @package WordPressdotorg_Plugin_Directory
+ */
+class Zip_Management extends Base {
+
+ const ZIP_DIR = Zip\Serve::ZIP_DIR;
+
+ function __construct() {
+ register_rest_route( 'plugins/v1', '/zip-management', array(
+ 'methods' => WP_REST_Server::CREATABLE,
+ 'callback' => array( $this, 'callback' ),
+ 'permission_callback' => array( $this, 'permission_check_internal_api_bearer' ),
+ ) );
+ }
+
+ /**
+ * Endpoint to manage plugin zip files.
+ *
+ * @param \WP_REST_Request $request The Rest API Request.
+ * @return array A formatted array of all the data for the plugin.
+ */
+ function callback( $request ) {
+
+ $results = array();
+
+ foreach ( $request['plugins'] as $plugin_slug => $actions ) {
+ $plugin_slug = preg_replace( '![^a-z0-9%+-]!i', '', $plugin_slug );
+
+ $to_invalidate = $to_rebuild = array();
+
+ if ( !empty( $actions['invalidate'] ) ) {
+ if ( 'all' == $actions['invalidate'] ) {
+ $to_invalidate = $this->get_plugin_zips( $plugin_slug );
+ } elseif ( is_array( $actions['invalidate'] ) ) {
+ $to_invalidate = $actions['invalidate'];
+ }
+ }
+
+ if ( !empty( $actions['rebuild'] ) ) {
+ if ( 'all' == $actions['rebuild'] ) {
+ $to_rebuild = $this->get_plugin_zips( $plugin_slug );
+ } elseif ( is_array( $actions['rebuild'] ) ) {
+ $to_rebuild = $actions['rebuild'];
+ }
+
+ foreach ( $to_rebuild as $zip ) {
+ if ( false !== ( $pos = array_search( $zip, $to_invalidate ) ) ) {
+ unset( $to_invalidate[ $pos ] );
+ }
+ }
+ }
+
+ foreach ( $to_rebuild as $zip ) {
+ try {
+ $this->rebuild( $plugin_slug, $zip );
+ $results['rebuild'][ $zip ] = file_get_contents( self::ZIP_DIR . '/' . $plugin_slug . '/' . $zip . '.md5' );
+ } catch( Exception $e ) {
+ $results['rebuild'][ $zip ] = array(
+ false,
+ $e->getMessage(),
+ );
+ }
+ }
+
+ foreach ( $to_invalidate as $zip ) {
+ $results['invalidate'][ $zip ] = $this->invalidate( $plugin_slug, $zip );
+ }
+ }
+
+ return $results;
+ }
+
+ /**
+ * Get a listing of ZIP files for a given plugin slug.
+ *
+ * @param string $plugin_slug The plugin slug to search for.
+ * @return array The list of ZIP files for the specified plugin slug.
+ */
+ protected function get_plugin_zips( $plugin_slug ) {
+ $files = glob( self::ZIP_DIR . '/' . $plugin_slug . '/*.zip' );
+ $files = array_map( 'basename', $files );
+
+ return $files;
+ }
+
+ /**
+ * Invalidates a specified ZIP file for a given plugin.
+ *
+ * @param string $plugin_slug The slug of the plugin to act upon.
+ * @param string $zip The name of the zip file to act upon.
+ * @return bool Whether the operation suceeded.
+ */
+ protected function invalidate( $plugin_slug, $zip ) {
+ $file = self::ZIP_DIR . '/' . $plugin_slug . '/' . $zip;
+
+ if ( file_exists( $file ) ) {
+ if ( ! unlink( $file ) ) {
+ return false;
+ }
+
+ if ( file_exists( "{$file}.md5" ) ) {
+ if ( ! unlink( "{$file}.md5" ) ) {
+ return false;
+ }
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Rebuilds a specified plugin zip.
+ *
+ * @param string $plugin_slug The slug of the plugin to act upon.
+ * @param string $zip The name of the zip file to rebuild.
+ * @return bool Whether the operation suceeded. Exceptions thrown on failure.
+ */
+ public function rebuild( $slug, $zip ) {
+ $version = preg_replace( '!^' . preg_quote( $slug, '!' ) . '(?:\.(.+))?\.zip$!i', '$1', $zip );
+ if ( $version == $slug ) {
+ throw new Exception( __METHOD__ . ': Invalid ZIP file format' );
+ }
+ if ( '' == $version ) {
+ $version = 'trunk';
+ }
+
+ $builder = new Zip\Builder( $slug, $version );
+ $builder->build();
+
+ clearstatcache();
+
+ return true;
+ }
+
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-zip-management.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>