<!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>[42009] trunk: Embeds: Improve consistency of update and refresh logic for oEmbed caching between `oembed_cache` and post meta.</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="https://core.trac.wordpress.org/changeset/42009">42009</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/42009","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-24 23:09:43 +0000 (Tue, 24 Oct 2017)</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'>Embeds: Improve consistency of update and refresh logic for oEmbed caching between `oembed_cache` and post meta.
* Allow updating oEmbed cache during `parse-embed` requests for non-post editors (such as widgets).
* Update any existing `oembed_cache` post when `usecache` and TTL has passed.
* Do not overwrite a previously valid cache with `{{unknown}}`.
Props dlh.
See <a href="https://core.trac.wordpress.org/ticket/34115">#34115</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/42310">#42310</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
<li><a href="#trunksrcwpincludesclasswpembedphp">trunk/src/wp-includes/class-wp-embed.php</a></li>
<li><a href="#trunktestsphpunittestsoembedWpEmbedphp">trunk/tests/phpunit/tests/oembed/WpEmbed.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesajaxactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/ajax-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ajax-actions.php 2017-10-24 23:00:01 UTC (rev 42008)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2017-10-24 23:09:43 UTC (rev 42009)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3027,6 +3027,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $parsed = false;
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_embed->return_false_on_fail = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 0 === $post_id ) {
+ /*
+ * Refresh oEmbeds cached outside of posts that are past their TTL.
+ * Posts are excluded because they have separate logic for refreshing
+ * their post meta caches. See WP_Embed::cache_oembed().
+ */
+ $wp_embed->usecache = false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_ssl() && 0 === strpos( $url, 'http://' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Admin is ssl and the user pasted non-ssl URL.
</span><span class="cx" style="display: block; padding: 0 10px"> // Check if the provider supports ssl embeds and use that for the preview.
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpembedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-embed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-embed.php 2017-10-24 23:00:01 UTC (rev 42008)
+++ trunk/src/wp-includes/class-wp-embed.php 2017-10-24 23:09:43 UTC (rev 42009)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -284,13 +284,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> kses_remove_filters();
</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">- wp_insert_post( wp_slash( array(
- 'post_name' => $key_suffix,
- 'post_content' => $html ? $html : '{{unknown}}',
- 'post_status' => 'publish',
- 'post_type' => 'oembed_cache',
- ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $insert_post_args = array(
+ 'post_name' => $key_suffix,
+ 'post_status' => 'publish',
+ 'post_type' => 'oembed_cache',
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $html ) {
+ if ( $cached_post_id ) {
+ wp_update_post( wp_slash( array(
+ 'ID' => $cached_post_id,
+ 'post_content' => $html,
+ ) ) );
+ } else {
+ wp_insert_post( wp_slash( array_merge(
+ $insert_post_args,
+ array(
+ 'post_content' => $html,
+ )
+ ) ) );
+ }
+ } elseif ( ! $cache ) {
+ wp_insert_post( wp_slash( array_merge(
+ $insert_post_args,
+ array(
+ 'post_content' => '{{unknown}}',
+ )
+ ) ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $has_kses ) {
</span><span class="cx" style="display: block; padding: 0 10px"> kses_init_filters();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsoembedWpEmbedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/oembed/WpEmbed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/oembed/WpEmbed.php 2017-10-24 23:00:01 UTC (rev 42008)
+++ trunk/tests/phpunit/tests/oembed/WpEmbed.php 2017-10-24 23:09:43 UTC (rev 42009)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -272,6 +272,40 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '{{unknown}}', $post_content );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Test that parsing an embed shortcode should cause oembed_cache to be updated.
+ *
+ * @ticket 42310
+ */
+ public function test_shortcode_should_update_custom_post() {
+ add_filter( 'oembed_ttl', '__return_zero' );
+
+ $url = 'https://example.com/';
+ $embedded = '<b>Embedded content</b>';
+ $key_suffix = md5( $url . serialize( wp_embed_defaults( $url ) ) );
+
+ add_filter( 'pre_oembed_result', '__return_empty_string' );
+ $this->wp_embed->shortcode( array(), $url );
+ remove_filter( 'pre_oembed_result', '__return_empty_string' );
+
+ $oembed_post_id = $this->wp_embed->find_oembed_post_id( $key_suffix );
+
+ $this->assertSame( '{{unknown}}', get_post( $oembed_post_id )->post_content );
+
+ $previous_usecache = $this->wp_embed->usecache;
+ $this->wp_embed->usecache = false;
+
+ // The update cannot be empty because empty responses won't overwrite the cache.
+ add_filter( 'pre_oembed_result', array( $this, '_pre_oembed_result_callback' ) );
+ $this->wp_embed->shortcode( array(), $url );
+ remove_filter( 'pre_oembed_result', array( $this, '_pre_oembed_result_callback' ) );
+
+ $this->assertSame( $embedded, get_post( $oembed_post_id )->post_content );
+
+ $this->wp_embed->usecache = $previous_usecache;
+ remove_filter( 'oembed_ttl', '__return_zero' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_shortcode_should_get_url_from_src_attribute() {
</span><span class="cx" style="display: block; padding: 0 10px"> $url = 'http://example.com/embed/foo';
</span><span class="cx" style="display: block; padding: 0 10px"> $actual = $this->wp_embed->shortcode( array( 'src' => $url ) );
</span></span></pre>
</div>
</div>
</body>
</html>