<!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>[13253] sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory: Photo Directory, Random: Add 'random' URL endpoint to load a random photo.</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/13253">13253</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/13253","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-02-29 23:38:52 +0000 (Thu, 29 Feb 2024)</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'>Photo Directory, Random: Add 'random' URL endpoint to load a random photo.
Props desrosj, coffee2code.
Fixes <a href="http://meta.trac.wordpress.org/ticket/7500">#7500</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsphotodirectoryphotodirectoryphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory/photo-directory.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsphotodirectoryincrandomphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory/inc/random.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsphotodirectoryincrandomphp"></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/photo-directory/inc/random.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/photo-directory/inc/random.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory/inc/random.php 2024-02-29 23:38:52 UTC (rev 13253)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,140 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Random photo(s) handling.
+ *
+ * @package WordPressdotorg\Photo_Directory
+ */
+
+namespace WordPressdotorg\Photo_Directory;
+
+class Random {
+
+ /**
+ * The relative path rewrite endpoint for loading a random photo.
+ */
+ const PATH = 'random';
+
+ /**
+ * The query variable denoting a request for a random photo.
+ */
+ const QUERY_VAR_LOAD_RANDOM = 'load-random-photo';
+
+ /**
+ * The cookie denoting that the current photo was randomly chosen.
+ */
+ const COOKIE_WAS_RANDOM = 'random-photo';
+
+ /**
+ * Flag to indicate if the current request was a result of a request for a random photo.
+ *
+ * @access private
+ * @var bool
+ */
+ private static $was_photo_random = false;
+
+ /**
+ * Initializer.
+ */
+ public static function init() {
+ add_action( 'init', [ __CLASS__, 'add_rewrite_rule' ] );
+ add_filter( 'query_vars', [ __CLASS__, 'add_query_var' ] );
+ add_action( 'template_redirect', [ __CLASS__, 'detect_random_photo_cookie' ] );
+ add_action( 'template_redirect', [ __CLASS__, 'redirect_if_random' ] );
+ add_filter( 'wp_robots', [ __CLASS__, 'noindex' ] );
+ }
+
+ /**
+ * Adds the rewrite rule for the 'random' URL endpoint.
+ */
+ public static function add_rewrite_rule() {
+ add_rewrite_rule( '^' . self::PATH . '/?$', 'index.php?' . self::QUERY_VAR_LOAD_RANDOM . '=1', 'top' );
+ }
+
+ /**
+ * Adds the query variable for denoting a request for a random photo.
+ *
+ * @param string[] $query_vars Array of query variables.
+ * @return string[]
+ */
+ public static function add_query_var( $query_vars ) {
+ $query_vars[] = self::QUERY_VAR_LOAD_RANDOM;
+ return $query_vars;
+ }
+
+ /**
+ * Determines if the current query is a request for a random photo.
+ *
+ * @return bool True if the current query is a request for a random photo, else false.
+ */
+ public static function is_random_photo_query() {
+ return is_front_page() && is_main_query() && '1' === get_query_var( self::QUERY_VAR_LOAD_RANDOM );
+ }
+
+ /**
+ * Determines if the current photo was a randomly chosen photo.
+ *
+ * @param bool $and_clear Should the cookie used to record that a photo was randomly chosen be cleared? Default true.
+ * @return bool True if the current photo was a random photo, else false.
+ */
+ public static function was_photo_random( $and_clear = true ) {
+ return is_singular( Registrations::get_post_type() ) && self::$was_photo_random;
+ }
+
+ /**
+ * Handles the redirect when the random photo URL endpoint is visited.
+ */
+ public static function redirect_if_random() {
+ if ( self::is_random_photo_query() ) {
+ $args = [
+ 'fields' => 'ids',
+ 'no_found_rows' => true,
+ 'orderby' => 'rand',
+ 'post_status' => 'publish',
+ 'post_type' => Registrations::get_post_type(),
+ 'posts_per_page' => 1,
+ ];
+
+ $photo_query = new \WP_Query( $args );
+
+ if ( $photo_query->have_posts() ) {
+ // Set a simple cookie to denote the fact that the photo was loaded randomly.
+ setcookie( self::COOKIE_WAS_RANDOM, '1', time() + MINUTE_IN_SECONDS, SITECOOKIEPATH, COOKIE_DOMAIN );
+
+ wp_safe_redirect( get_permalink( $photo_query->posts[0] ), 302 );
+ exit;
+ }
+ }
+ }
+
+ /**
+ * Detects the presence of the cookie associated with denoting that a random photo
+ * was requested.
+ *
+ * If detected, it is noted and the cookie gets deleted.
+ *
+ * Use `self::was_photo_random()` to check if the loaded photo was randomly chosen.
+ */
+ public static function detect_random_photo_cookie() {
+ if ( isset( $_COOKIE[ self::COOKIE_WAS_RANDOM ] ) ) {
+ setcookie( self::COOKIE_WAS_RANDOM, '', 1, SITECOOKIEPATH, COOKIE_DOMAIN );
+ self::$was_photo_random = true;
+ }
+ }
+
+ /**
+ * Prevents indexing of the random photo URL endpoint.
+ *
+ * @param array[] $robots Associative array of directives.
+ * @return array[]
+ */
+ public static function noindex( $robots ) {
+ if ( self::is_random_photo_query() ) {
+ $robots = wp_robots_no_robots( $robots );
+ }
+
+ return $robots;
+ }
+
+}
+
+add_action( 'plugins_loaded', [ __NAMESPACE__ . '\Random', 'init' ] );
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory/inc/random.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="sitestrunkwordpressorgpublic_htmlwpcontentpluginsphotodirectoryphotodirectoryphp"></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/photo-directory/photo-directory.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/photo-directory/photo-directory.php 2024-02-29 07:11:05 UTC (rev 13252)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/photo-directory/photo-directory.php 2024-02-29 23:38:52 UTC (rev 13253)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,6 +22,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require_once __DIR__ . '/inc/moderation.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once __DIR__ . '/inc/photo.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once __DIR__ . '/inc/posts.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require_once __DIR__ . '/inc/random.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> require_once __DIR__ . '/inc/registrations.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once __DIR__ . '/inc/rejection.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require_once __DIR__ . '/inc/search.php';
</span></span></pre>
</div>
</div>
</body>
</html>