<!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][7334] trunk: Introduces bp_*_user_last_activity() functions</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7334">7334</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-08-02 18:29:06 +0000 (Fri, 02 Aug 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduces bp_*_user_last_activity() functions
User last activity data is currently stored as usermeta, with BuddyPress
making multiple calls directly to the usermeta table to get that data. These
new functions provide a central, standardized way to update and fetch
last_activity information. This makes it easier for plugins to update user
activity programatically in a future-compatible way.
Having this set of functions will facilitate any changes associated with <a href="http://buddypress.trac.wordpress.org/ticket/5128">#5128</a>,
whose goal is to move last_activity data out of usermeta altogether.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcoreclassesphp">trunk/bp-core/bp-core-classes.php</a></li>
<li><a href="#trunkbpcorebpcorefunctionsphp">trunk/bp-core/bp-core-functions.php</a></li>
<li><a href="#trunkbpmembersbpmembersfunctionsphp">trunk/bp-members/bp-members-functions.php</a></li>
<li><a href="#trunkbpmembersbpmemberstemplatephp">trunk/bp-members/bp-members-template.php</a></li>
<li><a href="#trunkbpmessagesbpmessagesclassesphp">trunk/bp-messages/bp-messages-classes.php</a></li>
<li><a href="#trunktestsincludestestcasephp">trunk/tests/includes/testcase.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcoreclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-classes.php (7333 => 7334)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-classes.php 2013-08-01 00:06:38 UTC (rev 7333)
+++ trunk/bp-core/bp-core-classes.php 2013-08-02 18:29:06 UTC (rev 7334)
</span><span class="lines">@@ -777,7 +777,7 @@
</span><span class="cx"> $this->avatar = bp_core_fetch_avatar( array( 'item_id' => $this->id, 'type' => 'full', 'alt' => sprintf( __( 'Avatar of %s', 'buddypress' ), $this->fullname ) ) );
</span><span class="cx"> $this->avatar_thumb = bp_core_fetch_avatar( array( 'item_id' => $this->id, 'type' => 'thumb', 'alt' => sprintf( __( 'Avatar of %s', 'buddypress' ), $this->fullname ) ) );
</span><span class="cx"> $this->avatar_mini = bp_core_fetch_avatar( array( 'item_id' => $this->id, 'type' => 'thumb', 'alt' => sprintf( __( 'Avatar of %s', 'buddypress' ), $this->fullname ), 'width' => 30, 'height' => 30 ) );
</span><del>- $this->last_active = bp_core_get_last_activity( bp_get_user_meta( $this->id, 'last_activity', true ), __( 'active %s', 'buddypress' ) );
</del><ins>+ $this->last_active = bp_core_get_last_activity( bp_get_user_last_activity( $this->id ), __( 'active %s', 'buddypress' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkbpcorebpcorefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-functions.php (7333 => 7334)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-functions.php 2013-08-01 00:06:38 UTC (rev 7333)
+++ trunk/bp-core/bp-core-functions.php 2013-08-02 18:29:06 UTC (rev 7334)
</span><span class="lines">@@ -834,7 +834,7 @@
</span><span class="cx"> if ( bp_is_user_inactive( $user_id ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- $activity = bp_get_user_meta( $user_id, 'last_activity', true );
</del><ins>+ $activity = bp_get_user_last_activity( $user_id );
</ins><span class="cx">
</span><span class="cx"> if ( !is_numeric( $activity ) )
</span><span class="cx"> $activity = strtotime( $activity );
</span><span class="lines">@@ -847,8 +847,9 @@
</span><span class="cx"> do_action( 'bp_first_activity_for_member', $user_id );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( empty( $activity ) || strtotime( $current_time ) >= strtotime( '+5 minutes', $activity ) )
- bp_update_user_meta( $user_id, 'last_activity', $current_time );
</del><ins>+ if ( empty( $activity ) || strtotime( $current_time ) >= strtotime( '+5 minutes', $activity ) ) {
+ bp_update_user_last_activity( $user_id, $current_time );
+ }
</ins><span class="cx"> }
</span><span class="cx"> add_action( 'wp_head', 'bp_core_record_activity' );
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-functions.php (7333 => 7334)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-functions.php 2013-08-01 00:06:38 UTC (rev 7333)
+++ trunk/bp-members/bp-members-functions.php 2013-08-02 18:29:06 UTC (rev 7334)
</span><span class="lines">@@ -808,6 +808,51 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Update a user's last activity
+ *
+ * @since BuddyPress (1.9)
+ * @param int $user_id ID of the user being updated
+ * @param string $time Time of last activity, in 'Y-m-d H:i:s' format
+ * @return bool True on success
+ */
+function bp_update_user_last_activity( $user_id = 0, $time = '' ) {
+ // Fall back on current user
+ if ( empty( $user_id ) ) {
+ $user_id = bp_loggedin_user_id();
+ }
+
+ // Bail if the user id is 0, as there's nothing to update
+ if ( empty( $user_id ) ) {
+ return false;
+ }
+
+ // Fall back on current time
+ if ( empty( $time ) ) {
+ $time = bp_core_current_time();
+ }
+
+ return bp_update_user_meta( $user_id, 'last_activity', $time );
+}
+
+/**
+ * Get the last activity for a given user
+ *
+ * @param int $user_id The ID of the user
+ * @return string Time of last activity, in 'Y-m-d H:i:s' format, or an empty
+ * string if none is found
+ */
+function bp_get_user_last_activity( $user_id = 0 ) {
+ // Fall back on current user
+ if ( empty( $user_id ) ) {
+ $user_id = bp_loggedin_user_id();
+ }
+
+ $activity = bp_get_user_meta( $user_id, 'last_activity', true );
+
+ return apply_filters( 'bp_get_user_last_activity', $activity, $user_id );
+}
+
+/**
</ins><span class="cx"> * Fetch every post that is authored by the given user for the current blog.
</span><span class="cx"> *
</span><span class="cx"> * @package BuddyPress Core
</span><span class="lines">@@ -1513,4 +1558,4 @@
</span><span class="cx"> // shake shake shake!
</span><span class="cx"> add_action( 'login_head', 'wp_shake_js', 12 );
</span><span class="cx"> }
</span><del>-add_action( 'login_form_bp-spam', 'bp_live_spammer_login_error' );
</del><ins>+add_action( 'login_form_bp-spam', 'bp_live_spammer_login_error' );
</ins></span></pre></div>
<a id="trunkbpmembersbpmemberstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-template.php (7333 => 7334)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-template.php 2013-08-01 00:06:38 UTC (rev 7333)
+++ trunk/bp-members/bp-members-template.php 2013-08-02 18:29:06 UTC (rev 7334)
</span><span class="lines">@@ -868,7 +868,7 @@
</span><span class="cx"> if ( empty( $user_id ) )
</span><span class="cx"> $user_id = bp_displayed_user_id();
</span><span class="cx">
</span><del>- $last_activity = bp_core_get_last_activity( bp_get_user_meta( $user_id, 'last_activity', true ), __('active %s', 'buddypress') );
</del><ins>+ $last_activity = bp_core_get_last_activity( bp_get_user_last_activity( $user_id ), __('active %s', 'buddypress') );
</ins><span class="cx">
</span><span class="cx"> return apply_filters( 'bp_get_last_activity', $last_activity );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkbpmessagesbpmessagesclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-messages/bp-messages-classes.php (7333 => 7334)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-classes.php 2013-08-01 00:06:38 UTC (rev 7333)
+++ trunk/bp-messages/bp-messages-classes.php 2013-08-02 18:29:06 UTC (rev 7334)
</span><span class="lines">@@ -478,7 +478,7 @@
</span><span class="cx"> // Now deactivate all notices apart from the new one.
</span><span class="cx"> $wpdb->query( $wpdb->prepare( "UPDATE {$bp->messages->table_name_notices} SET is_active = 0 WHERE id != %d", $id ) );
</span><span class="cx">
</span><del>- bp_update_user_meta( bp_loggedin_user_id(), 'last_activity', bp_core_current_time() );
</del><ins>+ bp_update_user_last_activity( bp_loggedin_user_id(), bp_core_current_time() );
</ins><span class="cx">
</span><span class="cx"> do_action_ref_array( 'messages_notice_after_save', array( &$this ) );
</span><span class="cx">
</span></span></pre></div>
<a id="trunktestsincludestestcasephp"></a>
<div class="modfile"><h4>Modified: trunk/tests/includes/testcase.php (7333 => 7334)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/includes/testcase.php 2013-08-01 00:06:38 UTC (rev 7333)
+++ trunk/tests/includes/testcase.php 2013-08-02 18:29:06 UTC (rev 7334)
</span><span class="lines">@@ -213,7 +213,7 @@
</span><span class="cx">
</span><span class="cx"> $user_id = $this->factory->user->create( $args );
</span><span class="cx">
</span><del>- update_user_meta( $user_id, 'last_activity', $last_activity );
</del><ins>+ bp_update_user_last_activity( $user_id, $last_activity );
</ins><span class="cx">
</span><span class="cx"> if ( bp_is_active( 'xprofile' ) ) {
</span><span class="cx"> $user = new WP_User( $user_id );
</span></span></pre>
</div>
</div>
</body>
</html>