<!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>[3014] sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc: Translate: Add a REST API endpoint to manage jobs via WP's cron API.</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/3014">3014</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/3014","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-04-26 18:49:17 +0000 (Tue, 26 Apr 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'>Translate: Add a REST API endpoint to manage jobs via WP's cron API.
See <a href="http://meta.trac.wordpress.org/ticket/1636">#1636</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpcustomizationsincclasspluginphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/class-plugin.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/rest-api/</li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpcustomizationsincrestapiclassbasephp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/rest-api/class-base.php</a></li>
<li>sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/rest-api/endpoints/</li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpcustomizationsincrestapiendpointsclassjobscontrollerphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/rest-api/endpoints/class-jobs-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpcustomizationsincclasspluginphp"></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/wporg-gp-customizations/inc/class-plugin.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/wporg-gp-customizations/inc/class-plugin.php 2016-04-26 14:23:48 UTC (rev 3013)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/class-plugin.php 2016-04-26 18:49:17 UTC (rev 3014)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -41,6 +41,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'pre_handle_404', array( $this, 'short_circuit_handle_404' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_default_scripts', array( $this, 'bump_script_versions' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Load the API endpoints.
+ add_action( 'rest_api_init', array( __NAMESPACE__ . '\REST_API\Base', 'load_endpoints' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( defined( 'WP_CLI' ) && WP_CLI ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->register_cli_commands();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpcustomizationsincrestapiclassbasephp"></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/wporg-gp-customizations/inc/rest-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/wporg-gp-customizations/inc/rest-api/class-base.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/rest-api/class-base.php 2016-04-26 18:49:17 UTC (rev 3014)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,45 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace WordPressdotorg\GlotPress\Customizations\REST_API;
+
+use WP_Error;
+use WP_Http;
+
+class Base {
+
+ /**
+ * Namespace of the API routes.
+ *
+ * @var string
+ */
+ protected $namespace = 'translate/v1';
+
+ /**
+ * Initialises each API endpoint we offer.
+ */
+ public static function load_endpoints() {
+ $jobs = new Endpoints\Jobs_Controller();
+ $jobs->register_routes();
+ }
+
+ /**
+ * A permission check callback which validates the request with a Bearer token.
+ *
+ * @param \WP_REST_Request $request The Rest API Request.
+ * @return bool|\WP_Error True if the token exists, WP_Error upon failure.
+ */
+ public function permission_check_internal_api_bearer( $request ) {
+ $authorization_header = $request->get_header( 'authorization' );
+ $authorization_header = trim( str_ireplace( 'bearer', '', $authorization_header ) );
+
+ if (
+ ! $authorization_header ||
+ ! defined( 'TRANSLATE_API_INTERNAL_BEARER_TOKEN' ) ||
+ ! hash_equals( TRANSLATE_API_INTERNAL_BEARER_TOKEN, $authorization_header )
+ ) {
+ return false;
+ }
+
+ return true;
+ }
+}
</ins></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggpcustomizationsincrestapiendpointsclassjobscontrollerphp"></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/wporg-gp-customizations/inc/rest-api/endpoints/class-jobs-controller.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/wporg-gp-customizations/inc/rest-api/endpoints/class-jobs-controller.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/rest-api/endpoints/class-jobs-controller.php 2016-04-26 18:49:17 UTC (rev 3014)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,139 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace WordPressdotorg\GlotPress\Customizations\REST_API\Endpoints;
+
+use WordPressdotorg\GlotPress\Customizations\REST_API\Base;
+use WP_Error;
+use WP_REST_Server;
+
+class Jobs_Controller extends Base {
+
+ /**
+ * Register the routes for the objects of the controller.
+ */
+ public function register_routes() {
+ register_rest_route( $this->namespace, '/jobs', [
+ [
+ 'methods' => WP_REST_Server::READABLE,
+ 'callback' => [ $this, 'get_items' ],
+ ],
+ [
+ 'methods' => WP_REST_Server::CREATABLE,
+ 'callback' => [ $this, 'create_item' ],
+ 'permission_callback' => [ $this, 'permission_check_internal_api_bearer' ],
+ 'args' => [
+ 'timestamp' => [
+ 'required' => true,
+ 'sanitize_callback' => 'absint',
+ 'validate_callback' => [ $this, 'validate_timestamp' ],
+ ],
+ 'recurrence' => [
+ 'required' => true,
+ 'sanitize_callback' => 'sanitize_text_field',
+ 'validate_callback' => [ $this, 'validate_recurrence' ],
+ ],
+ 'hook' => [
+ 'required' => true,
+ 'sanitize_callback' => 'sanitize_text_field',
+ ],
+ 'args' => [
+ 'default' => [],
+ 'validate_callback' => [ $this, 'validate_args' ],
+ ],
+ ],
+ ],
+ ] );
+ }
+
+ /**
+ * Get a collection of jobs.
+ *
+ * @return \WP_REST_Response
+ */
+ public function get_items() {
+ $cron_array = _get_cron_array();
+ return rest_ensure_response( $cron_array );
+ }
+
+ /**
+ * Creates a new job.
+ *
+ * @param \WP_REST_Request $request Full data about the request.
+ * @return \WP_Error|\WP_REST_Response WP_Error on failure, WP_REST_Response on success.
+ */
+ public function create_item( $request ) {
+ if ( 'once' === $request['recurrence'] ) {
+ $result = wp_schedule_single_event( $request['timestamp'], $request['hook'], $request['args'] );
+ if ( false === $result ) {
+ return new WP_Error( 'insert_failed' );
+ }
+
+ $next_scheduled = wp_next_scheduled( $request['hook'], $request['args'] );
+ $data = [
+ 'hook' => $request['hook'],
+ 'start' => $request['timestamp'],
+ 'nextrun' => (int) $next_scheduled,
+ 'args' => $request['args'],
+ ];
+ return rest_ensure_response( $data );
+ }
+
+ $result = wp_schedule_event( $request['timestamp'], $request['recurrence'], $request['hook'], $request['args'] );
+ if ( false === $result ) {
+ return new WP_Error( 'insert_failed' );
+ }
+
+ $next_scheduled = wp_next_scheduled( $request['hook'], $request['args'] );
+ $data = [
+ 'hook' => $request['hook'],
+ 'start' => $request['timestamp'],
+ 'nextrun' => (int) $next_scheduled,
+ 'args' => $request['args'],
+ ];
+ return rest_ensure_response( $data );
+ }
+
+ /**
+ * Validates a timestamp.
+ *
+ * @param int $timestamp The timestamp to validate.
+ * @return bool True if valid, false if not.
+ */
+ public function validate_timestamp( $timestamp ) {
+ if ( is_numeric( $timestamp ) && $timestamp > 0 ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Validates a recurrence value.
+ *
+ * @param string $recurrence The recurrence value to validate.
+ * @return bool True if valid, false if not.
+ */
+ public function validate_recurrence( $recurrence ) {
+ if ( 'once' === $recurrence ) {
+ return true;
+ }
+
+ $schedules = wp_get_schedules();
+
+ if ( isset( $schedules[ $recurrence ] ) ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Validates the args parameter for a job.
+ *
+ * @param array $args The args parameter to validate.
+ * @return bool True if valid, false if not.
+ */
+ public function validate_args( $args ) {
+ return is_array( $args );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>