Skip to content

Commit

Permalink
deleted 'bbppu_forums_visits' usermetas and related functions (+ upgr…
Browse files Browse the repository at this point in the history 
…ade function)
  • Loading branch information
gordielachance authored and gordielachance committed Sep 9, 2016
1 parent baa0000 commit 8f545b4
Show file tree
Hide file tree
Showing 2 changed files with 101 additions and 110 deletions.
201 changes: 94 additions & 107 deletions bbpress-pencil-unread.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ class bbP_Pencil_Unread {
* meta keys
*/
public $options_metaname = 'bbppu_options'; // plugin's options (stored in wp_options)
public $topic_readby_metaname = 'bbppu_read_by'; // contains an array of user IDs having read that post (stored in postmeta)
public $forums_visits_metaname = 'bbppu_forums_visits'; // contains an array of the user's last visits timestamps for forums (stored in usermeta)
public $topic_readby_metaname = 'bbppu_read_by'; // contains an array of user IDs having read that post (stored in postmeta)
public $marked_forums_metaname = 'bbppu_marked_forums'; // contains an array of 'marked as read' timestamps for forums (stored in usermeta)

/**
Expand Down Expand Up @@ -154,10 +153,15 @@ function upgrade(){
$post_id = $row->post_id;
$user_ids = maybe_unserialize($row->meta_value);

foreach($user_ids as $user_id){
foreach((array)$user_ids as $user_id){
add_post_meta($post_id,$this->topic_readby_metaname,$user_id);
}
}

//remove 'bbppu_first_visit' usermetas
$wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->usermeta WHERE meta_key = %s",'bbppu_forums_visits') );


}

if ( $current_version < 105){
Expand Down Expand Up @@ -200,8 +204,6 @@ function logged_in_user_actions(){
add_filter( 'bbp_list_forums', array(&$this,"list_forums_class"),10,2);

//update forum / topic status
add_action('bbp_template_after_forums_loop',array(&$this,'update_current_forum_visit_for_user')); //single forum
add_action('bbp_template_after_topics_loop',array(&$this,'update_current_forum_visit_for_user')); //single forum
add_action('bbp_template_after_replies_loop',array(&$this,'update_current_topic_read_by')); //single topic

//save post actions
Expand All @@ -221,44 +223,7 @@ function logged_in_user_actions(){

add_action("wp", array(&$this,"process_mark_as_read")); //process "mark as read" link
}

/**
* When a user visits a single forum, save the time of that visit so we can compare later
* @param type $user_id
* @param type $forum_id
* @return boolean
*/

//TO FIX check if can be replaced by update_forum_visit_for_user(); so we can remove this function.

function update_current_forum_visit_for_user(){
global $wp_query;

/*do not be too strict in the conditions since it makes BuddyPress group forums ignore the function eg. is_single(), etc.*/

return $this->update_forum_visit_for_user();
}

function update_forum_visit_for_user($forum_id=false,$user_id=false){

//validate user
if(!$user_id) $user_id = get_current_user_id();
if (!get_userdata( $user_id )) return false;


//validate forum
$forum_id = bbp_get_forum_id($forum_id);
if (get_post_type( $forum_id )!=bbp_get_forum_post_type()) return false;

$visits = $this->get_forums_visits_for_user($user_id);
$visits[$forum_id] = current_time('timestamp');
ksort($visits);

self::debug_log("update_forum_visit_for_user: forum#".$forum_id.", user#".$user_id);

return update_user_meta( $user_id, $this->forums_visits_metaname, $visits );
}

function register_scripts_styles(){
wp_register_style('font-awesome', '//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css',false,'4.3.0');
wp_register_style('bbppu', $this->plugin_url . '_inc/css/bbppu.css',false,$this->version);
Expand Down Expand Up @@ -524,21 +489,7 @@ function forum_was_read_before_new_topic($forum_id){
function forum_was_read_before_new_reply($topic_id, $forum_id){
$this->forum_was_read_before_new_post = self::has_user_read($forum_id);
}

/**
* Runs when a new topic is posted.
* @param type $topic_id
* @param type $forum_id
* @param type $anonymous_data
* @param type $topic_author
*/

function new_topic($topic_id, $forum_id, $anonymous_data=false, $topic_author=false){
if($this->forum_was_read_before_new_post){
self::update_forum_visit_for_user($forum_id,$topic_author);
}
}


function new_topic_backend($post_id){

// Bail if doing an autosave
Expand All @@ -561,6 +512,20 @@ function new_topic_backend($post_id){

$this->new_topic($topic_id,$forum_id);
}


/**
* Runs when a new topic is posted.
* @param type $topic_id
* @param type $forum_id
* @param type $anonymous_data
* @param type $topic_author
*/

function new_topic($topic_id, $forum_id, $anonymous_data=false, $topic_author=false){
$this->update_topic_read_by($topic_id,$topic_author);
}


/**
* Runs when a new reply is posted.
Expand All @@ -575,10 +540,6 @@ function new_reply($reply_id, $topic_id, $forum_id, $anonymous_data=false, $repl
$this->reset_topic_read_by($topic_id,$reply_author);
$this->update_topic_read_by($topic_id,$reply_author);

if($this->forum_was_read_before_new_post){
self::update_forum_visit_for_user($forum_id,$reply_author);
}

}

function new_reply_backend($post_id){
Expand Down Expand Up @@ -631,41 +592,10 @@ function update_topic_read_by($topic_id=false,$user_id=false){
//check topic
if (get_post_type( $topic_id )!=bbp_get_topic_post_type()) return false;

if ( in_array($user_id,$read_by) ) return true; //already set
if ( $read_by && in_array($user_id,$read_by) ) return true; //already set

return add_post_meta( $topic_id, $this->topic_readby_metaname, $user_id );
}
/**
* Get the time of the last visit of the user for each forum.
* @param type $forum_id
* @param type $user_id
* @return boolean
*/
function get_single_forum_visit_for_user($forum_id=false,$user_id=false){

//validate user
if(!$user_id) $user_id = get_current_user_id();
if (!$user_meta = get_userdata( $user_id )) return false;

//validate forum
$forum_id = bbp_get_forum_id($forum_id);
if(!$forum_id) return false;
$visits = self::get_forums_visits_for_user($user_id);
if ((is_array($visits))&&(array_key_exists($forum_id, $visits))) {
return $visits[$forum_id];
}else{//forum has never been visited before, return registration time
return $user_meta->user_registered;
}
}
function get_forums_visits_for_user($user_id=false){
//validate user
if(!$user_id) $user_id = get_current_user_id();
if (!get_userdata( $user_id )) return false;

$visits = get_user_meta($user_id,$this->forums_visits_metaname, true );

return $visits;
}

function post_status_class($classes,$post_id){

Expand Down Expand Up @@ -759,6 +689,58 @@ function get_forum_id_for_post($post_id = null){
return bbp_get_forum_id($forum_id);

}

function has_user_read_all_forum_topics( $forum_id,$user_id=false ){

//TO FIX : use a transient to limit queries ? It could last a few seconds.

if(!$user_id) $user_id = get_current_user_id();
if(!$user_id) return true;

//count topics

$topics_args = array(
'post_type' => bbp_get_topic_post_type(),
'post_parent' => $forum_id,
'posts_per_page' => -1

);

$topics_query = new WP_Query( $topics_args );
$topics_total = $topics_query->found_posts;

//count read topics

$read_topics_args = array(
'meta_query' => array(
array(
'key' => $this->topic_readby_metaname,
'value' => $user_id,
)
)
);

$read_topics_args = array_merge($topics_args,$read_topics_args);

$read_topics_query = new WP_Query($read_topics_args);
$read_topics_total = $read_topics_query->found_posts;

$has_read = ($read_topics_total == $topics_total);
/*
if ($forum_id == 3103){
print_r($topics_query->posts);
echo"<br/>";
print_r($read_topics_query->posts);
die();
}
*/


self::debug_log('user#'.$user_id.' has_user_read_all_forum_topics#'.$forum_id.' : '.(int)$has_read);

return $has_read;

}

function has_user_read($post_id,$user_id=false){

Expand All @@ -775,12 +757,14 @@ function has_user_read($post_id,$user_id=false){
$post_type = get_post_type($post_id);
$last_active_time = bbp_convert_date(get_post_meta( $post_id, '_bbp_last_active_time', true )); //get post last activity time

//this post has been created before user's first visit
self::debug_log('user#'.$user_id.' has_user_read '.get_post_type($post_id).'#'.$post_id.' ? ');

//check user registration time : if the post was created before; consider it as read
if ( (!$has_read) && ( $this->get_options('test_registration_time') == 'on' ) && ( $first_visit = $user_meta->user_registered ) ){
$has_read = ($last_active_time <= $first_visit);
}

//this forum or its ancestor have been marked has read
//check 'mark as read' for this forum or ancestors
if ((!$has_read) && ($forum_time_marked = self::get_forum_marked_time($post_id,$user_id))){
$has_read = ($last_active_time <= $forum_time_marked);
}
Expand Down Expand Up @@ -811,33 +795,36 @@ function has_user_read($post_id,$user_id=false){
break;

}

$check_forums = array($post_id);

if ( (bbp_is_forum_category( $post_id )) && ($subforums = bbp_forum_get_subforums($post_id)) ){
//forum hierarchy
if ( $subforums = bbp_forum_get_subforums($post_id) ){

$subforums_count = count($subforums);
$subforums_read = 0;

foreach ($subforums as $subforum) {
$has_user_read_subforum = $this->has_user_read($subforum->ID);
if ($has_user_read_subforum) $subforums_read++;
$check_forums[] = $subforum->ID;
}

$has_read = ($subforums_count == $subforums_read);
break;
}

$user_last_visit = self::get_single_forum_visit_for_user($post_id,$user_id);
$has_read = ($last_active_time <= $user_last_visit);

//look for an unread forum
$has_read = true;
foreach($check_forums as $forum_id){
if ( !$this->has_user_read_all_forum_topics( $forum_id,$user_id ) ) {
$has_read = false;
break;
}
}

break;

}
}



self::debug_log('user#'.$user_id.' has_user_read '.get_post_type($post_id).'#'.$post_id.' : '.(int)$has_read);
self::debug_log('user#'.$user_id.' has_user_read '.get_post_type($post_id).'#'.$post_id.' ? ***'.(bool)$has_read);


return apply_filters('bbppu_has_user_read',$has_read,$post_id,$user_id);

Expand Down
10 changes: 7 additions & 3 deletions readme.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,16 @@ If it hasn't been done already, you can translate the plugin and send me the tra

*bbPress Pencil Unread* handles differently the way forums & topics are set as read.

* For **forums**, the time of each forum's last access by the user is stored in *bbppu_forums_visits* (usermeta) on forum visits, and compared to the forum last activity time. This means a forum will be set as "read" if the user **has visited the forum page, and even if some topics inside have not been read** (but they will remain listed as non read topics when displaying the forum).
* For **topics**, a post meta *bbppu_read_by* is attached to the topic each time a someone visits it; the meta value is the user ID.  When a new reply is added, all those metas are deleted.

* For **forums**, we compare the total count of topics with the total count of read topics for the current user. If it does not match, the forum is considered as unread.

* Marking a forum (*Mark all as read*) adds an entry with the forum ID and timestamp in *bbppu_marked_forums* (usermeta). When determining if a topic has been read, we check if the topic's forum (or ancestors) has a mark more recent than the topic time.

* Marking a forum will only set the topics from this forum as read. If there is **super sticky topics** displayed and that they belong to other forums, they will not be marked as read.

* To avoid that a forum would be set set as 'unread' after a user **posts a new topic or reply**; we check the forum status (if it was read or not) before posting the topic or reply. If the forum was set to read, we'll keep that status.

* For **topics**, the ID of each visitor having read the topic is is stored in *bbppu_read_by* (postmeta) when the topic is opened.  When a new reply is added, the IDs of the users having already read the topic are deleted.

It's working that way to avoid having too much database calls / data stored.

= How can I use those functions outside of the plugin ? =
Expand All @@ -79,6 +79,10 @@ Have a look at the file /bbppu-template.php, which contains functions you could

== Changelog ==

= XXX =
* topic_readby_metaname is now multiple (+ upgrade function)
* deleted 'bbppu_forums_visits' usermetas and related functions (+ upgrade function)

= 1.2.2 =
* Do not show 'Mark as read' link if no activity since last marked.
* fixed localization + french translation
Expand Down

0 comments on commit 8f545b4

Please sign in to comment.