<!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>[12848] sites/trunk: Theme Directory: API: Cache a theme not existing, and perform some sanitization on the slug before querying for that theme.</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/12848">12848</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/12848","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>2023-08-17 07:43:02 +0000 (Thu, 17 Aug 2023)</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'>Theme Directory: API: Cache a theme not existing, and perform some sanitization on the slug before querying for that theme.
This should have no backwards compatibility issues.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlthemesinfo10indexphp">sites/trunk/api.wordpress.org/public_html/themes/info/1.0/index.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsthemedirectorythemesapiphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/themes-api.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlthemesinfo10indexphp"></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/themes/info/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/themes/info/1.0/index.php 2023-08-17 05:28:09 UTC (rev 12847)
+++ sites/trunk/api.wordpress.org/public_html/themes/info/1.0/index.php 2023-08-17 07:43:02 UTC (rev 12848)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,13 +1,72 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+namespace WordPressdotorg\API\Themes\Info;
+use function WordPressdotorg\API\load_wordpress;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// This exposes the `load_wordpress()` function mentioned below.
+require dirname( dirname( dirname( __DIR__ ) ) ) . '/wp-init-ondemand.php';
+
+// wp_cache_switch_to_blog( WPORG_THEME_DIRECTORY_BLOGID ); // Uses is_multisite() which is unavailable.
+$wp_object_cache->blog_prefix = WPORG_THEME_DIRECTORY_BLOGID;
+
+// Helper methods
+function wp_unslash( $value ) {
+ if ( is_string( $value ) ) {
+ return stripslashes( $value );
+ }
+ if ( is_array( $value ) ) {
+ return array_map( __FUNCTION__, $value );
+ }
+
+ return $value;
+}
+
+/**
+ * Bails out with an error message.
+ *
+ * @param string $error Error message.
+ * @param int $code HTTP status code.
+ */
+function send_error( $error, $code = 404 ) {
+ global $format;
+
+ header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' ' . $code, true, $code );
+
+ $response = (object) [
+ 'error' => $error
+ ];
+
+ // Browsers get a nicer action not implemented error.
+ if (
+ 'GET' === $_SERVER['REQUEST_METHOD'] &&
+ false === strpos( $_SERVER['HTTP_USER_AGENT'] ?? '', 'WordPress/' ) &&
+ false !== strpos( $error, 'Action not implemented.' )
+ ) {
+ header( 'Content-Type: text/html; charset=utf-8' );
+ die( "<p>{$error}</p>" );
+ }
+
+ // Back-compat behaviour for the 1.0/1.1 API's
+ if (
+ defined( 'THEMES_API_VERSION' ) && THEMES_API_VERSION < 1.2 &&
+ 'Theme not found' == $response->error
+ ) {
+ $response = false;
+ }
+
+ if ( 'php' === $format ) {
+ echo serialize( $response );
+ } else {
+ // JSON format
+ echo json_encode( $response );
+ }
+
+ die();
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! defined( 'THEMES_API_VERSION' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> define( 'THEMES_API_VERSION', '1.0' );
</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">-// Load WordPress as the Theme Directory in order to avoid having to switch sites after loading.
-$wp_init_host = 'https://wordpress.org/themes/';
-require dirname( dirname( dirname( __DIR__ ) ) ) . '/wp-init.php';
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Set up action and request information.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( defined( 'JSON_RESPONSE' ) && JSON_RESPONSE ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $request = isset( $_REQUEST['request'] ) ? (object) wp_unslash( $_REQUEST['request'] ) : '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,8 +82,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $format = 'php';
</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">-$action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$action = $_REQUEST['action'] ?? '';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Validate the request.
+switch ( $action ) {
+ case 'theme_information':
+ // Validate the slug provided is valid.
+ $slug = $request->slug ?? '';
+ if ( ! $slug ) {
+ send_error( 'Slug not provided' );
+ }
+ if ( ! is_string( $slug ) || ! preg_match( '/^[a-z0-9-]+$/', $slug ) ) {
+ send_error( 'Invalid slug provided' );
+ }
+
+ // Check to see if this theme has been specified as not existing.
+ if ( 'not_found' === wp_cache_get( $slug, 'theme_information_error' ) ) {
+ send_error( 'Theme not found' );
+ }
+ break;
+ case 'query_themes':
+ case 'hot_tags':
+ case 'feature_list':
+ case 'get_commercial_shops':
+ // No validation for now, but valid endpoints.
+ break;
+ default:
+ send_error( 'Action not implemented. <a href="https://codex.wordpress.org/WordPress.org_API">API Docs</a>' );
+ die();
+}
+
+/**
+ * Load WordPress, to serve this request.
+ *
+ * TODO: This causes a significant CPU load for the server, this should be cached in Memcache in addition to the existing caching.
+ */
+load_wordpress( 'https://wordpress.org/themes/' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Serve an API request.
</span><span class="cx" style="display: block; padding: 0 10px"> $api = wporg_themes_query_api( $action, $request, 'api_object' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,3 +125,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $api->set_status_header();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> echo $api->get_result( $format );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+// Cache when a theme doesn't exist. See the validation handler above.
+if ( 'theme_information' == $action && 404 == http_response_code() ) {
+ wp_cache_set( $slug, 'not_found', 'theme_information_error', WEEK_IN_SECONDS );
+}
</ins></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsthemedirectorythemesapiphp"></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/theme-directory/themes-api.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/theme-directory/themes-api.php 2023-08-17 05:28:09 UTC (rev 12847)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/themes-api.php 2023-08-17 07:43:02 UTC (rev 12848)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,5 +21,8 @@
</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"> wp_cache_set( $slug, $theme_meta, $cache_group );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Delete the error cache if this theme is new.
+ wp_cache_delete( $slug, 'theme_information_error' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wporg_themes_update_version_live', 'wporg_themes_update_check', 10, 2 );
</span></span></pre>
</div>
</div>
</body>
</html>