<!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>[BuddyPress][9574] trunk/src/bp-notifications: Notifications: Wire up meta queries so they return accurate results, largely lifted from Activity component.</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://buddypress.trac.wordpress.org/changeset/9574">9574</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9574","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-03-01 20:36:34 +0000 (Sun, 01 Mar 2015)</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'>Notifications: Wire up meta queries so they return accurate results, largely lifted from Activity component. More to fine-tune here. See <a href="http://buddypress.trac.wordpress.org/ticket/6257">#6257</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpnotificationsbpnotificationstemplatephp">trunk/src/bp-notifications/bp-notifications-template.php</a></li>
<li><a href="#trunksrcbpnotificationsclassesclassbpnotificationsnotificationphp">trunk/src/bp-notifications/classes/class-bp-notifications-notification.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpnotificationsbpnotificationstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-notifications/bp-notifications-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/bp-notifications-template.php 2015-03-01 20:09:01 UTC (rev 9573)
+++ trunk/src/bp-notifications/bp-notifications-template.php 2015-03-01 20:36:34 UTC (rev 9574)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -296,6 +296,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => 25,
</span><span class="cx" style="display: block; padding: 0 10px"> 'max' => null,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'meta_query' => false,
+ 'date_query' => false
</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"> // Overrides
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -324,6 +326,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'secondary_item_id' => $r['secondary_item_id'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'component_name' => $r['component_name'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'component_action' => $r['component_action'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'meta_query' => $r['meta_query'],
+ 'date_query' => $r['date_query'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'is_new' => $this->is_new,
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => $this->search_terms,
</span><span class="cx" style="display: block; padding: 0 10px"> 'order_by' => $this->order_by,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -534,6 +538,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => isset( $_REQUEST['s'] ) ? stripslashes( $_REQUEST['s'] ) : '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'order_by' => 'date_notified',
</span><span class="cx" style="display: block; padding: 0 10px"> 'sort_order' => 'DESC',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'meta_query' => false,
+ 'date_query' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'page' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => 25,
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcbpnotificationsclassesclassbpnotificationsnotificationphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-notifications/classes/class-bp-notifications-notification.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/classes/class-bp-notifications-notification.php 2015-03-01 20:09:01 UTC (rev 9573)
+++ trunk/src/bp-notifications/classes/class-bp-notifications-notification.php 2015-03-01 20:36:34 UTC (rev 9574)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -282,10 +282,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.9.0)
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args See {@link BP_Notifications_Notification::get()}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * for more details.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * for more details.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string WHERE clause.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected static function get_where_sql( $args = array() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static function get_where_sql( $args = array(), $select_sql = '', $from_sql = '', $join_sql = '', $meta_query_sql = '' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -362,6 +362,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions['search_terms'] = $wpdb->prepare( "( component_name LIKE %s OR component_action LIKE %s )", $search_terms_like, $search_terms_like );
</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">+ // date query
+ if ( ! empty( $args['date_query'] ) ) {
+ $where_conditions['date_query'] = self::get_date_query_sql( $args['date_query'] );
+ }
+
+ // meta query
+ if ( ! empty( $meta_query_sql['where'] ) ) {
+ $where_conditions['meta_query'] = $meta_query_sql['where'];
+ }
+
+ /**
+ * Filters the MySQL WHERE conditions for the Notifications items get method.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param array $where_conditions Current conditions for MySQL WHERE statement.
+ * @param array $args Parsed arguments passed into method.
+ * @param string $select_sql Current SELECT MySQL statement at point of execution.
+ * @param string $from_sql Current FROM MySQL statement at point of execution.
+ * @param string $join_sql Current INNER JOIN MySQL statement at point of execution.
+ * @param string $meta_query_sql Current meta query WHERE statement at point of execution.
+ */
+ $where_conditions = apply_filters( 'bp_notifications_get_where_conditions', $where_conditions, $args, $select_sql, $from_sql, $join_sql, $meta_query_sql );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Custom WHERE
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $where_conditions ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $where = 'WHERE ' . implode( ' AND ', $where_conditions );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -588,7 +612,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Parse the arguments
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = wp_parse_args( $args, array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $r = wp_parse_args( $args, array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'id' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'item_id' => false,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -601,14 +625,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'sort_order' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'page' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => false,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'meta_query' => false,
+ 'date_query' => false,
+ 'update_meta_cache' => true,
+ 'count_total' => false,
</ins><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">+ // Get BuddyPress
+ $bp = buddypress();
+
+ // METADATA
+ $meta_query_sql = self::get_meta_query_sql( $r['meta_query'] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // SELECT
</span><span class="cx" style="display: block; padding: 0 10px"> $select_sql = "SELECT *";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // FROM
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $from_sql = "FROM " . buddypress()->notifications->table_name;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $from_sql = "FROM {$bp->notifications->table_name} n ";
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // JOIN
+ $join_sql = $meta_query_sql['join'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // WHERE
</span><span class="cx" style="display: block; padding: 0 10px"> $where_sql = self::get_where_sql( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => $r['id'],
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -619,7 +656,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'component_action' => $r['component_action'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'is_new' => $r['is_new'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => $r['search_terms'],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'date_query' => $r['date_query']
+ ), $select_sql, $from_sql, $join_sql, $meta_query_sql );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // ORDER BY
</span><span class="cx" style="display: block; padding: 0 10px"> $order_sql = self::get_order_by_sql( array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -633,7 +671,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => $r['per_page'],
</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">- $sql = "{$select_sql} {$from_sql} {$where_sql} {$order_sql} {$pag_sql}";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Concatenate query parts
+ $sql = "{$select_sql} {$from_sql} {$join_sql} {$where_sql} {$order_sql} {$pag_sql}";
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $wpdb->get_results( $sql );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -675,6 +714,76 @@
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get the SQL for the 'meta_query' param in BP_Notifications_Notification::get().
+ *
+ * We use WP_Meta_Query to do the heavy lifting of parsing the
+ * meta_query array and creating the necessary SQL clauses. However,
+ * since BP_Notifications_Notification::get() builds its SQL differently than
+ * WP_Query, we have to alter the return value (stripping the leading
+ * AND keyword from the 'where' clause).
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param array $meta_query An array of meta_query filters. See the
+ * documentation for WP_Meta_Query for details.
+ * @return array $sql_array 'join' and 'where' clauses.
+ */
+ public static function get_meta_query_sql( $meta_query = array() ) {
+
+ // Default array keys & empty values
+ $sql_array = array(
+ 'join' => '',
+ 'where' => '',
+ );
+
+ // Bail if no meta query
+ if ( empty( $meta_query ) ) {
+ return $sql_array;
+ }
+
+ // WP_Meta_Query expects the table name at $wpdb->notificationmeta
+ $GLOBALS['wpdb']->notificationmeta = buddypress()->notifications->table_name_meta;
+
+ $n_meta_query = new WP_Meta_Query( $meta_query );
+ $meta_sql = $n_meta_query->get_sql( 'notification', 'n', 'id' );
+
+ // Strip the leading AND - it's handled in get()
+ $sql_array['where'] = preg_replace( '/^\sAND/', '', $meta_sql['where'] );
+ $sql_array['join'] = $meta_sql['join'];
+
+ return $sql_array;
+ }
+
+ /**
+ * Get the SQL for the 'date_query' param in BP_Notifications_Notification::get().
+ *
+ * We use BP_Date_Query, which extends WP_Date_Query, to do the heavy lifting
+ * of parsing the date_query array and creating the necessary SQL clauses.
+ * However, since BP_Notifications_Notification::get() builds its SQL
+ * differently than WP_Query, we have to alter the return value (stripping
+ * the leading AND keyword from the query).
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param array $date_query An array of date_query parameters. See the
+ * documentation for the first parameter of WP_Date_Query.
+ * @return string
+ */
+ public static function get_date_query_sql( $date_query = array() ) {
+
+ // Bail if not a proper date query format
+ if ( empty( $date_query ) || ! is_array( $date_query ) || ! class_exists( 'BP_Date_Query' ) ) {
+ return '';
+ }
+
+ // Date query
+ $date_query = new BP_Date_Query( $date_query, 'date_recorded' );
+
+ // Strip the leading AND - it's handled in get()
+ return preg_replace( '/^\sAND/', '', $date_query->get_sql() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Update notifications.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.9.0)
</span></span></pre>
</div>
</div>
</body>
</html>