Moderate Group Activity

<?php
/**
 * Plugin Name:BuddyPress Activity Moderator
 * Plugin URI:
 * Author: Dan Brellis
 * Author URI:
 * Description:
 * Version:
 * License: GPL
 * Site Wide Only: true
 * Network: true
 * Date Updated: October 05, 2011
 *
 */
/**
 * Special desclaimer: BuddyPress does not allows multiple items from same component with similar action(It is grouped by buddypress before delivering to the notfication formatting function), so I have hacked the component_action to be unique per item, because we want update for individual action items
 * Most important: It is just for fun :) hope you would like it
 */

// we are not much concerned with the slug, it is not visible
define("BP_ACTIVITY_MODERATOR_SLUG","mod");

//register a dummy notifier component, I don't want to do it, but bp has no other mechanism for passing the notification data to function, so we need the format_notification_function
function mod_setup_globals() {
    global $bp, $current_blog;

    $bp->mod->id = 'mod';//I asume others are not going to use this is
    $bp->mod->slug = BP_ACTIVITY_MODERATOR_SLUG;
    $bp->mod->format_notification_function = 'mod_format_notifications';//show the notification
    /* Register this in the active components array */
    $bp->active_components[$bp->mod->slug] = $bp->mod->id;

    do_action( 'mod_setup_globals' );
}
add_action( 'bp_setup_globals', 'mod_setup_globals' );









//Check if current user is a group moderator or super user
function mod_user_is_mod ($group_id=false) {
    global $bp;
    $user_id = $bp->loggedin_user->id;

    if ( $bp->loggedin_user->is_super_admin || groups_is_user_mod( $user_id, $group_id ) || groups_is_user_admin( $user_id, $group_id ) ) return true;
    else return false;
}

//Return a string of comma seperate activity ids that are pending for specific group
function mod_get_pending_ids ($group_id) {
    global $wpdb;

    $activity_table = $wpdb->prefix . 'bp_activity';
    $activity_meta_table = $wpdb->prefix . 'bp_activity_meta';

    $sql = "
        SELECT id
        FROM $activity_table WHERE";
        if(isset($group_id)) $sql .= " item_id = $group_id AND";
        $sql .= " id IN (
            SELECT activity_id
            FROM $activity_meta_table
            WHERE meta_key = 'status'
            AND meta_value = 'pending')
        ORDER BY date_recorded DESC";

    $activity_ids = $wpdb->get_col($wpdb->prepare($sql));
    $activity_ids = array_map(create_function('$value', 'return (int)$value;'),$activity_ids);

    $all_activities = $wpdb->get_col($wpdb->prepare( "SELECT id FROM $activity_table WHERE item_id = $group_id" ));
    $all_activities = array_map(create_function('$value', 'return (int)$value;'),$all_activities);

    foreach ($all_activities as $activity_id) {
        $comment_ids_ar = array();
        $comment_ids_ar[] = $wpdb->get_col ($wpdb->prepare( "
            SELECT id
            FROM $activity_table
            WHERE item_id = $activity_id
            AND id IN (
                SELECT activity_id
                FROM $activity_meta_table
                WHERE meta_key = 'status'
                AND meta_value = 'pending')
            ORDER BY date_recorded DESC"));
        foreach($comment_ids_ar as $val) {
            $comment_ids .= implode(',',$val);
        }
        unset($comment_ids_ar);
    }

    if(isset($comment_ids))
        return rtrim( (implode(',',$activity_ids) . ',' . $comment_ids) , ',' );
    else  return rtrim( (implode(',',$activity_ids)) , ',' );
}

//Add the list of ids to the bp_has_activities query_string
/* abandoned for mod_exclude_pending_activities */
function mod_exclude_pending_activity ( $query_string, $object, $filter, $scope, $page, $search_terms, $extras ) {
    global $bp, $activities_template;

    $group = $bp->groups->current_group->id;

    if ( $object != 'activity' )
        return $query_string;

    //For viewing 'Activity'
    //if user is not a moderator, get all id's except for pending
    if (mod_user_is_mod ($group) == false )
    {
        $ids = mod_get_published_ids ($group);
        //add the filter
        $query_string .= "&include=" . $ids;
        var_dump($query_string);
        return $query_string;
    }
    else return $query_string;
}
//add_filter( 'bp_dtheme_ajax_querystring', 'mod_exclude_pending_activity', 1, 7 );



//Add the list of ids to the bp_has_activities query_string
/* Abandoned the above function for this one, still not working 100% */
function mod_exclude_pending_activities ( $has_activities ) {
    global $bp, $activities_template;

    $group = $bp->groups->current_group->id;

    //For viewing 'Activity'
    //if user is not a moderator, get all id's except for pending
    if (mod_user_is_mod ($group) == false )
    {
        $ids= mod_get_pending_ids ($group);
        $exclude_ids = explode(',', mod_get_pending_ids ($group));
        //add the filter

        foreach( $activities_template->activities as $activity_key => $activity ) {
            //var_dump( $activity->id );
            if ( in_array($activity->id, $exclude_ids ) ) {
                // need comment support here
                unset( $activities_template->activities[$activity_key] );

                $activities_template->activity_count--;
                $activities_template->total_activity_count--;
            }
        }

        // Reset indexes
        $activities_template->activities = array_values( $activities_template->activities );

        return $has_activities;
    }
    else return $has_activities;


}
add_filter( 'bp_has_activities', 'mod_exclude_pending_activities');




//Check if activity ID is one of those in the list of IDs that don't have a meta_value of pending
function mod_needs_approval($acivity_id=false) {
    global $bp, $activities_template;

    $group = $bp->groups->current_group->id;
    if (!isset($group))
    {
        $group = $bp->activity->item_id;
    }
    if(!isset($activity_id)) $activity_id = bp_get_activity_id();

    $published_ids = explode( ",", mod_get_pending_ids($group));

    if ( !in_array($activity_id, $published_ids ) ) return false;
    else return true;
}





//Apply filters for moderators to approve pending activity
function mod_add_pending_class_to_activity ($class )
{
    global $bp, $activities_template;

    $activity_id = bp_get_activity_id();

    if ( mod_needs_approval($activity_id) == false ){
        return $activities_template->activity->component . ' ' . $activities_template->activity->type . $class;
    }
    else return $activities_template->activity->component . ' ' . $activities_template->activity->type . $class . ' pending';
}
add_filter ('bp_get_activity_css_class', 'mod_add_pending_class_to_activity' );

//Construct the link for the mod to approve
function mod_get_activity_approve_link() {
    global $activities_template;
    return apply_filters( 'mod_get_activity_approve_link', wp_nonce_url( site_url( BP_ACTIVITY_SLUG . '/approve/' . $activities_template->activity->id . '/' ), 'status_publish' ) );
}





/* AJAX mark an activity as published */
function mod_mark_activity_publish() {
    global $bp;

    mod_activity_add_status_publish( $_POST['id'] );
}
add_action( 'wp_ajax_activity_mark_publish', 'mod_mark_activity_publish' );


//Add meta to activity that it is published!
function mod_activity_add_status_publish( $activity_id ) {
    global $bp, $wpdb;

    $activity_table = $wpdb->prefix . 'bp_ativity';

    //$activity = $wpdb->get_row($wpdb->prepare('SELECT * FROM $activity_table WHERE id = ' . $activity_id), 'OBJECT');
    $activity = new BP_Activity_Activity( $activity_id );

    if (bp_activity_update_meta( $activity_id, 'status', 'publish' ) ) {
        do_action( 'custom_after_activity_approved', $activity );
        return true;
    }
    else return false;
}










//When the approval action is called, run the function to approve it
function mod_activity_action_approve() {
    global $bp, $wpdb;

    if ( !is_user_logged_in() || $bp->current_component != $bp->activity->slug || $bp->current_action != 'approve' )
        return false;

    /* Check the nonce */
    check_admin_referer( 'status_publish' );

    if ( mod_activity_add_status_publish( $bp->action_variables[0] ) )
        bp_core_add_message( __( 'Activity approved.', 'buddypress' ) );
    else
        bp_core_add_message( __( 'There was an error approving that message, please try again.', 'buddypress' ), 'error' );

    bp_core_redirect( wp_get_referer() . '#activity-' . $bp->action_variables[0] );
}
add_action( 'wp', 'mod_activity_action_approve', 3 );


//Add a link for the mod to approve an activity
function mod_add_approval_link() {
    global $bp, $activities_template;
    if( mod_user_is_mod() !== true ) return;
    if (mod_needs_approval() == true){
        echo '<div class="moderation">
                <a href="' . mod_get_activity_approve_link() . '" class="moderate-this">Approve</a>
              </div>
              <div class="clear"></div>';
    }
}
add_action( 'bp_activity_entry_meta', 'mod_add_approval_link');

//Add some text to let the user know their post is awaiting moderation
function mod_inform_user_activity_is_pending () {
    global $bp, $activities_template;
    if( mod_user_is_mod() == true ) return;

    if(mod_get_group_activity_moderation() !== 'yes') return;
    if (mod_needs_approval() == true){
        echo '<div id="message">Your post is awaiting approval.</div>';
    }
}
add_action( 'bp_activity_entry_meta', 'mod_inform_user_activity_is_pending');


// Get the moderation settings for the group
function mod_get_group_activity_moderation($group_id=false) {
    global $bp;
    if(!$group_id)
        $group_id = $bp->groups->current_group->id;

    $default_subscription = groups_get_groupmeta( $group_id, 'activity_moderation' );
    return $default_subscription;
}









//Add publish or pending option for group activity
function mod_group_activity_moderation_form() {
    ?>
    <hr />
    <h4>Moderate Group Member Posts</h4>
    <p>Should new posts from group members to this group be moderated?</p>
    <div class="radio">
        <label><input type="radio" name="group_activity_moderation" value="no" <?php mod_group_activity_moderation( 'no' ) ?> />
            No moderation (any group member can post to the rest of the group freely)</label>
        <label><input type="radio" name="group_activity_moderation" value="yes" <?php mod_group_activity_moderation( 'yes' ) ?> />
            Yes, moderate group member posts (this will require a group admin to moderate each post)</label>
    </div>
    <hr />
    <?php
}
add_action ( 'bp_after_group_settings_admin' ,'mod_group_activity_moderation_form' );
add_action ( 'bp_after_group_settings_creation_step' ,'mod_group_activity_moderation_form' );


// echo subscription default checked setting for the group admin settings - default to 'unsubscribed' in group creation
function mod_group_activity_moderation( $setting ) {
    $stored_setting = mod_get_group_activity_moderation();
    if ( $setting == $stored_setting )
        echo ' checked="checked"';
    else if ( $setting == 'no' && !$stored_setting )
        echo ' checked="checked"';
}


// Save the group activity moderation setting in the group meta, if no, delete it
function mod_save_group_activity_moderation_seting( $group ) {
    global $bp, $_POST;

    if ( isset( $_POST['group_activity_moderation'] ) && $postval = $_POST['group_activity_moderation'] ) {
        if ( $postval && $postval != 'no' )
            groups_update_groupmeta( $group->id, 'activity_moderation', $postval );
        elseif ( $postval == 'no' )
            groups_delete_groupmeta( $group->id, 'activity_moderation' );
    }
}
add_action( 'groups_group_after_save', 'mod_save_group_activity_moderation_seting' );


//If group activity is moderated, set new activity posts to pending
function mod_add_activity_meta_pending($content, $user_id, $group_id, $activity_id) {
    global $bp;

    if(mod_get_group_activity_moderation($group_id) == 'yes') {
        if( bp_activity_update_meta( $activity_id, 'status', 'pending' ) )
        {
            bp_core_add_message( __( 'Update Was Submitted for Approval!', 'buddypress' ) );

            //Send notification to group admins
            $admins = groups_get_group_admins( $group_id );

            require_once ( BP_PLUGIN_DIR . '/bp-groups/bp-groups-notifications.php' );

            for ( $i = 0; $i < count( $admins ); $i++ ) {
                mod_groups_notification_new_approval( $user_id, $admins[$i]->user_id, $group_id, $activity_id );
            }
            return;
        }
    }
    return;
}
add_action( 'bp_groups_posted_update', 'mod_add_activity_meta_pending', 10, 4);
add_action( 'postie_activity_meta_pending', 'mod_add_activity_meta_pending', 9, 4);

function mod_intercept_pending_comment($comment_id, $params=array()) {
    global $bp;

    extract( $params );

    $parent_activity = new BP_Activity_Activity( $activity_id );
    $group_id = $parent_activity->item_id;

    if(mod_get_group_activity_moderation($group_id) == 'yes') {
        if( bp_activity_update_meta( $comment_id, 'status', 'pending' ) )
        {
            bp_core_add_message( __( 'Update Was Submitted for Approval!', 'buddypress' ) );

            //Send notification to group admins
            $admins = groups_get_group_admins( $group_id );

            require_once ( BP_PLUGIN_DIR . '/bp-groups/bp-groups-notifications.php' );

            for ( $i = 0; $i < count( $admins ); $i++ ) {
                mod_groups_notification_new_approval( $user_id, $admins[$i]->user_id, $group_id, $comment_id );
            }
            return;
        }
    }
    return;
}
add_action( 'bp_activity_comment_posted', 'mod_intercept_pending_comment', 10, 2);

//Post notice in group header that the group is moderated.
function mod_show_group_moderation_settings() {
    global $bp, $activities_template;
    if(mod_get_group_activity_moderation() !== 'yes') return;

    $notice = '<div><span>';
    if( mod_user_is_mod() == true ) {
        $notice .= 'All activity posted in this group must be approved by the group moderator. Please click approve or delete for highlighted posts.';
    }
    else $notice .= 'All activity posted in this group must be approved. Please allow some time for the moderator to review your post before it is publicly viewable.';

    $notice .= '</span></div>';

    echo $notice;

}
add_action('bp_group_header_meta', 'mod_show_group_moderation_settings', 100);






// Add options for receiving these notifications via email
function mod_group_approval_screen_notification_settings() {
    global $current_user; ?>
            <tr>
                <td></td>
                <td><?php _e( 'A message is posted in a moderated group for which you are an admin', 'buddypress' ) ?></td>
                <td class="yes"><input type="radio" id="notification_approval_yes" name="notifications[notification_group_approval]" value="yes" <?php if ( !get_user_meta( $current_user->id, 'notification_group_approval', true ) || 'yes' == get_user_meta( $current_user->id, 'notification_group_approval', true ) ) { ?>checked="checked" <?php } ?> /></td>
                <td class="no"><input type="radio" id="notification_approval_no" name="notifications[notification_group_approval]" value="no" <?php if ( 'no' == get_user_meta( $current_user->id, 'notification_group_approval', true ) ) { ?>checked="checked" <?php } ?> />
                </td>
            </tr>
<?php
}
add_action( 'groups_screen_notification_settings', 'mod_group_approval_screen_notification_settings' );




















/**************************************************************
 *Add a notification in the admin bar when a user's group has items to be approved
 */

//Send group admins an email & add notification to database for each admin of group
function mod_groups_notification_new_approval( $requesting_user_id, $admin_id, $group_id, $activity_id ) {
    global $bp;

    //bp_core_add_notification( $requesting_user_id, $admin_id, 'groups', 'new_activity_needs_approval', $group_id );
    bp_core_add_notification( $activity_id, $admin_id, $bp->mod->id, 'new_activity_needs_approval_'.$activity_id, $group_id );

    if ( 'no' == get_user_meta( $admin_id, 'notification_group_approval', true ) )
        return false;

    $requesting_user_name = bp_core_get_user_displayname( $requesting_user_id );
    $group = new BP_Groups_Group( $group_id );

    $ud = bp_core_get_core_userdata($admin_id);
    $requesting_ud = bp_core_get_core_userdata($requesting_user_id);

    $group_requests = bp_get_group_permalink( $group );
    $profile_link = bp_core_get_user_domain( $requesting_user_id );
    $settings_link = bp_core_get_user_domain( $requesting_user_id ) .  BP_SETTINGS_SLUG . '/notifications/';

    $activity = new BP_Activity_Activity( $activity_id );
    $activity_subject = bp_activity_get_meta($activity_id, 'subject');
    if (!$activity_subject) $activity_subject = '<em>None</em>';
    $activity_content = $activity->content;

    // Set up and send the message
    $to       = $ud->user_email;
    $sitename = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
    $subject  = '[' . $sitename . '] ' . sprintf( __( 'Message Approval for group: %s', 'buddypress' ), $group->name );
    $headers = 'Content-Type: text/html' . "\r\n";

$message = sprintf( __(
'%s has posted a new item in "%s".

Because you are the administrator of this group, you must either approve or delete the message.

To view all pending messages for this group, please visit:
%s

To view %s\'s profile: %s

---------------------

The message awaiting approval is below:

Subject: %s

%s

---------------------

', 'buddypress' ), $requesting_user_name, $group->name, $group_requests, $requesting_user_name, $profile_link, $activity_subject, $activity_content );

    $message .= sprintf( __( 'To disable these notifications please log in and go to: %s', 'buddypress' ), $settings_link );

    /* Send the message */
    $to = apply_filters( 'mod_groups_notification_new_approval_to', $to );
    $subject = apply_filters( 'mod_groups_notification_new_approval_subject', $subject, &$group );
    $message = apply_filters( 'mod_groups_notification_new_approval_message', $message, &$group, $requesting_user_name, $profile_link, $group_requests );


    wp_mail( $to, $subject, $message );
}






/** our notification format function which shows notification to user
 *
 * @global  $bp
 * @param <type> $action
 * @param <type> $activity_id
 * @param <type> $secondary_item_id
 * @param <type> $total_items
 * @return <type>
 * @since 1.0.2
 * @desc format and show the notification to the user
 */
function mod_format_notifications( $action, $activity_id, $secondary_item_id, $total_items ) {

    global $bp;
    $activity = new BP_Activity_Activity( $activity_id );
    $link = mod_activity_get_permalink( $activity_id );


    $ac_action='new_activity_needs_approval_'.$activity_id;

    $group_id = $secondary_item_id;

    $user_id_to_be_moderated = mod_get_requesting_user_id($activity_id);
    $user_fullname = bp_core_get_user_displayname( $user_id_to_be_moderated );

    $group = new BP_Groups_Group( $group_id );

    $group_link = bp_get_group_permalink( $group );

    if($action==$ac_action){
      return apply_filters( 'mod_single_new_activity_needs_approval_notification', '<a href="' . $link . '">' . sprintf( __( '%s has a message awaiting moderation in "%s"', 'buddypress' ), $user_fullname, $group->name ) . '</a>' );
   }
   do_action( 'mod_format_notifications', $action, $activity_id, $secondary_item_id, $total_items );
return false;
}

/**
 *  This section deals with removing notification when a notified item is viewed
 */

/*
 * For single activity view, we will remove the notification associated with current user and current activity item
 */


function mod_remove_notification($activity,$has_access){
    global $bp;
    if($has_access)//if user can view this activity, remove notification(just a safeguard for hidden activity)
        bp_core_delete_notifications_for_user_by_item_id(  $bp->loggedin_user->id, $activity->id, $bp->mod->id,  'new_activity_needs_approval_'.$activity->id);

}
add_action("bp_activity_screen_single_activity_permalink","mod_remove_notification",10,2);


/**
 * @since v 1.0.2
 * @desc delete notification when an activity is deleted, thanks to @kat_uk for pointing the issue
 * @param ac_ids:we get an arry of activity ids
 */

function bp_mod_clear_notification_on_activity_delete($ac_ids){
    global $bp;

    //bp_core_delete_notifications_for_user_by_item_id(  $bp->loggedin_user->id, $activity->id, $bp->activity->id,  'new_activity_comment_'.$activity->id);
    foreach((array)$ac_ids as $activity_id)
        bp_core_delete_all_notifications_by_type( $activity_id, $bp->ac_notifier->id, 'new_activity_needs_approval_'.$activity_id, $secondary_item_id = false );
}
add_action("bp_activity_deleted_activities","bp_mod_clear_notification_on_activity_delete");












/************************************ HELPER FUNCTIONS ********************************************************/
/**
  * @desc: find all the unique user_ids who have commented on this activity
 */

function mod_find_involved_persons($activity_id){
    global $bp,$wpdb;
   return $wpdb->get_col($wpdb->prepare("select DISTINCT(user_id) from {$bp->activity->table_name} where item_id=%d and user_id!=%d ",$activity_id,$bp->loggedin_user->id));//it finds all uses who commted on the activity
 }

/**
  * @desc: find all the unique user_ids who have commented on this activity
 */

function mod_get_requesting_user_id($activity_id){
    global $bp,$wpdb;
   return $wpdb->get_var($wpdb->prepare("select DISTINCT(user_id) from {$bp->activity->table_name} where id=%d",$activity_id));//it finds all uses who commted on the activity
 }




//get the thread permalink for activity
function mod_activity_get_permalink( $activity_id, $activity_obj = false ) {
    global $bp;

    if ( !$activity_obj )
        $activity_obj = new BP_Activity_Activity( $activity_id );


        if ( 'activity_comment' == $activity_obj->type )
            $link = $bp->root_domain . '/' . BP_ACTIVITY_SLUG . '/p/' . $activity_obj->item_id . '/';
        else
            $link = $bp->root_domain . '/' . BP_ACTIVITY_SLUG . '/p/' . $activity_obj->id . '/';


    return apply_filters( 'mod_activity_get_permalink', $link );
}
?>