Changeset 5484

Timestamp:

12/10/2011 06:19:44 PM (13 years ago)

Author:

djpaul

Message:

Activity admin iteration. See #3660.

• Add remaining activity properties to the edit screen.
• Add new contextual help to the edit screen.
• Add support for 2 columns to the edit screen.
• Fix a typo (props fanquake, see #3822).
• Update BP_Activity_Activity::save() method to fix a bug where an update operation with no changes was reported as an error.
• Update activity admin CSS, bump version number.

Location:

trunk/bp-activity

Files:

• admin/css/admin.css (modified) (1 diff)
• admin/css/admin.dev.css (modified) (1 diff)
• bp-activity-admin.php (modified) (13 diffs)
• bp-activity-classes.php (modified) (1 diff)

trunk/bp-activity/admin/css/admin.css

@@ -1 @@
-#wp-bp-activities-wrap{padding:5px 0;}#bp-activities{height:120px;}#bp-replyhead{font-size:1em;line-height:1.4em;margin:0;}#bp-replysubmit{margin:0;padding:0 0 3px;text-align:center;}#bp-replysubmit .error{color:red;line-height:21px;text-align:center;vertical-align:center;}#bp-replysubmit img.waiting{float:right;padding:4px 10px 0;vertical-align:top;}#bp-activities-form .column-response img{float:left;margin-right:10px;margin-top:1px;}#wp-bp-activities-content-wrap{margin-top:20px;}#post-body #bp-activities-action_resize,#post-body #bp-activities-content_resize{position:inherit;margin-top:-2px;}
+#wp-bp-activities-wrap{padding:5px 0;}#bp-activities{height:120px;}#bp-replyhead{font-size:1em;line-height:1.4em;margin:0;}#bp-replysubmit{margin:0;padding:0 0 3px;text-align:center;}#bp-replysubmit .error{color:red;line-height:21px;text-align:center;vertical-align:center;}#bp-replysubmit img.waiting{float:right;padding:4px 10px 0;vertical-align:top;}#bp-activities-form .column-response img{float:left;margin-right:10px;margin-top:1px;}#wp-bp-activities-content-wrap{margin-top:20px;}#post-body #bp-activities-action_resize,#post-body #bp-activities-content_resize{position:inherit;margin-top:-2px;}#bp_activity_link input{width:99%;}#bp-activities-primaryid{margin-bottom:1em;}

trunk/bp-activity/admin/css/admin.dev.css

@@ -40 +40 @@
     margin-top: -2px;
 }
+#bp_activity_link input {
+    width: 99%;
+}
+#bp-activities-primaryid {
+    margin-bottom: 1em;
+}

trunk/bp-activity/bp-activity-admin.php

@@ -135 +135 @@
 
 /**
+ * Hide the advanced edit meta boxes by default, so we don't clutter the scren.
+ *
+ * @param WP_Screen $screen Screen identifier
+ * @return array Hidden Meta Boxes
+ * @since 1.0
+ */
+function bp_activity_admin_edit_hidden_metaboxes( $hidden, $screen ) {
+    if ( empty( $screen->id ) || 'toplevel_page_bp-activity' != $screen->id )
+        return $hidden;
+
+    // Hide the primary link meta box by default
+    $hidden  = array_merge( (array) $hidden, array( 'bp_activity_itemids', 'bp_activity_link', 'bp_activity_type', 'bp_activity_userid', ) );
+
+    return apply_filters( 'bp_hide_meta_boxes', array_unique( $hidden ), $screen );
+}
+add_filter( 'default_hidden_meta_boxes', 'bp_activity_admin_edit_hidden_metaboxes', 10, 2 );
+
+
+/**
  * Set up the admin page before any output is sent. Register contextual help and screen options for this admin page.
  *
+ * @global object $bp BuddyPress global settings
  * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table
  * @since 1.6
  */
 function bp_activity_admin_load() {
-    global $bp_activity_list_table;
+    global $bp, $bp_activity_list_table;
 
     // Decide whether to load the dev version of the CSS and JavaScript
@@ -151 +171 @@
     // Edit screen
     if ( 'edit' == $doaction && ! empty( $_GET['aid'] ) ) {
+        // columns screen option
+        add_screen_option( 'layout_columns', array( 'default' => 2, 'max' => 2, ) );
+
         get_current_screen()->add_help_tab( array(
             'id'      => 'bp-activity-edit-overview',
             'title'   => __( 'Overview', 'buddypress' ),
             'content' =>
-                '<p>' . __( 'You can edit activities made on your site similar to the way you edit a comment. This is useful if you need to change which page the activity links to, or when you notice that the author has made a typographical error.', 'buddypress' ) . '</p>' .
+                '<p>' . __( 'You edit activities made on your site similar to the way you edit a comment. This is useful if you need to change which page the activity links to, or when you notice that the author has made a typographical error.', 'buddypress' ) . '</p>' .
+                '<p>' . __( 'The two big editing areas for the activity title and content are fixed in place, but you can reposition all the other boxes using drag and drop, and can minimize or expand them by clicking the title bar of each box. Use the Screen Options tab to unhide more boxes (Primary Item/Secondary Item, Link, Type, Author ID) or to choose a 1- or 2-column layout for this screen.', 'buddypress' ) . '</p>' .
                 '<p>' . __( 'You can also moderate the activity from this screen using the Status box, where you can also change the timestamp of the activity.', 'buddypress' ) . '</p>'
         ) );
 
+        get_current_screen()->add_help_tab( array(
+            'id'      => 'bp-activity-edit-advanced',
+            'title'   => __( 'Item, Link, Type', 'buddypress' ),
+            'content' =>
+                '<p>' . __( '<strong>Primary Item/Secondary Item</strong> - These identify the object that created the activity. For example, the fields could reference a comment left on a specific site. Some types of activity may only use one, or none, of these fields.', 'buddypress' ) . '</p>' .
+                '<p>' . __( '<strong>Link</strong> - Activity generated by blog posts and comments, forum topics and replies, and some plugins, uses the link field for a permalink back to the content item. Some types of activity may not use this field, even if it has been set.', 'buddypress' ) . '</p>' .
+                '<p>' . __( '<strong>Type</strong> - Each distinct kind of activity has its own type. For example, <code>created_group</code> is used when a group is created and <code>joined_group</code> is used when a user joins a group.', 'buddypress' ) . '</p>' .
+                '<p>' . __( 'For information about when and how BuddyPress uses all of these settings, see the Managing Activity link in the panel to the side.', 'buddypress' ) . '</p>'
+        ) );
+
+        // Help panel - sidebar links
+        get_current_screen()->set_help_sidebar(
+            '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
+            '<p>' . __( '<a href="http://codex.buddypress.org/buddypress-site-administration/managing-activity/">Managing Activity</a>', 'buddypress' ) . '</p>' .
+            '<p>' . __( '<a href="http://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
+        );
+
         // Register metaboxes for the edit screen.
-        add_meta_box( 'submitdiv', _x( 'Status', 'activity admin edit screen', 'buddypress' ), 'bp_activity_admin_edit_metabox_status', 'toplevel_page_bp-activity', 'side', 'core' );
+        add_meta_box( 'submitdiv',           _x( 'Status', 'activity admin edit screen', 'buddypress' ), 'bp_activity_admin_edit_metabox_status', 'toplevel_page_bp-activity', 'side', 'core' );
+        add_meta_box( 'bp_activity_itemids', _x( 'Primary Item/Secondary Item', 'activity admin edit screen', 'buddypress' ), 'bp_activity_admin_edit_metabox_itemids', 'toplevel_page_bp-activity', 'advanced', 'core' );
+        add_meta_box( 'bp_activity_link',    _x( 'Link', 'activity admin edit screen', 'buddypress' ), 'bp_activity_admin_edit_metabox_link', 'toplevel_page_bp-activity', 'advanced', 'core' );
+        add_meta_box( 'bp_activity_type',    _x( 'Type', 'activity admin edit screen', 'buddypress' ), 'bp_activity_admin_edit_metabox_type', 'toplevel_page_bp-activity', 'advanced', 'core' );
+        add_meta_box( 'bp_activity_userid',  _x( 'Author ID', 'activity admin edit screen', 'buddypress' ), 'bp_activity_admin_edit_metabox_userid', 'toplevel_page_bp-activity', 'advanced', 'core' );
 
         // Enqueue javascripts
@@ -168 +213 @@
 
         // Enqueue CSS
-        wp_enqueue_style( 'bp_activity_admin_css', BP_PLUGIN_URL . "bp-activity/admin/css/admin.{$dev}css", array(), '20111203' );
+        wp_enqueue_style( 'bp_activity_admin_css', BP_PLUGIN_URL . "bp-activity/admin/css/admin.{$dev}css", array(), '20111210' );
 
     // Index screen
@@ -192 +237 @@
             'title'     => __( 'Moderating Activity', 'buddypress' ),
             'content'   =>
-                '<ul>' .
-                    '<li>' . __( 'In the <strong>Activity</strong> column, above each activity it says &#8220;Submitted on,&#8221; followed by the date and time the activity item was generated on your site. Clicking on the date/time link will take you to that activity on your live site. Hovering over any activity gives you options to reply, edit, spam mark, or delete that activity.', 'buddypress' ) . '</li>' .
-                    '<li>' . __( "In the <strong>In Response To</strong> column, if the activity was in reply to another activity, it shows that activity's author's picture and name, and a link to that activity on your live site. If there is a small bubble, the number in it shows how many other activities are related to this one; these are usually comments. Clicking the bubble will filter the activity screen to show only related activity items.", 'buddypress' ) . '</li>' .
-                '</ul>'
+                '<p>' . __( 'In the <strong>Activity</strong> column, above each activity it says &#8220;Submitted on,&#8221; followed by the date and time the activity item was generated on your site. Clicking on the date/time link will take you to that activity on your live site. Hovering over any activity gives you options to reply, edit, spam mark, or delete that activity.', 'buddypress' ) . '</p>' .
+                '<p>' . __( "In the <strong>In Response To</strong> column, if the activity was in reply to another activity, it shows that activity's author's picture and name, and a link to that activity on your live site. If there is a small bubble, the number in it shows how many other activities are related to this one; these are usually comments. Clicking the bubble will filter the activity screen to show only related activity items.", 'buddypress' ) . '</p>'
         ) );
+
+        // Help panel - sidebar links
+        get_current_screen()->set_help_sidebar(
+            '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
+            '<p>' . __( '<a href="http://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
+        );
 
         // Enqueue CSS and JavaScript
@@ -202 +251 @@
         wp_enqueue_style( 'bp_activity_admin_css', BP_PLUGIN_URL . "bp-activity/admin/css/admin.{$dev}css", array(), '20111203' );
     }
-
-    // Help panel - sidebar links
-    get_current_screen()->set_help_sidebar(
-        '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
-        '<p>' . __( '<a href="http://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
-    );
 
     // Handle spam/un-spam/delete of activities
@@ -343 +386 @@
         $error = 0;
 
-        // Set tainted if a new form value is different from the object's old value
-        $tainted = false;
-        
         // Activity spam status
+        $prev_spam_status = $new_spam_status = false;
         if ( ! empty( $_REQUEST['activity_status'] ) ) {
             $prev_spam_status = $activity->is_spam;
-            $new_spam_status  = ( 'spam' == $_REQUEST['activity_status'] ) ? 1 : 0;
+            $new_spam_status  = ( 'spam' == $_REQUEST['activity_status'] ) ? true : false;
         }
 
         // Activity action
-        if ( ! empty( $_REQUEST['bp-activities-action'] ) && stripslashes( $activity->action ) != stripslashes( $_REQUEST['bp-activities-action'] ) ) {
+        if ( ! empty( $_REQUEST['bp-activities-action'] ) )
             $activity->action = $_REQUEST['bp-activities-action'];
-            $tainted = true;
-        }
 
         // Activity content
-        if ( ! empty( $_REQUEST['bp-activities-content'] ) && stripslashes( $activity->content ) != stripslashes( $_REQUEST['bp-activities-content'] ) ) {
+        if ( ! empty( $_REQUEST['bp-activities-content'] ) )
             $activity->content = $_REQUEST['bp-activities-content'];
-            $tainted = true;
+
+        // Activity primary link
+        if ( ! empty( $_REQUEST['bp-activities-link'] ) )
+            $activity->primary_link = $_REQUEST['bp-activities-link'];
+
+        // Activity user ID
+        if ( ! empty( $_REQUEST['bp-activities-userid'] ) )
+            $activity->user_id = (int) $_REQUEST['bp-activities-userid'];
+
+        // Activity item primary ID
+        if ( ! empty( $_REQUEST['bp-activities-primaryid'] ) )
+            $activity->item_id = (int) $_REQUEST['bp-activities-primaryid'];
+
+        // Activity item secondary ID
+        if ( ! empty( $_REQUEST['bp-activities-secondaryid'] ) )
+            $activity->secondary_item_id = (int) $_REQUEST['bp-activities-secondaryid'];
+
+        // Activity type
+        if ( ! empty( $_REQUEST['bp-activities-type'] ) ) {
+            $actions  = array();
+
+            // Walk through the registered actions, and build an array of actions/values.
+            foreach ( $bp->activity->actions as $action ) {
+                $action = array_values( (array) $action );
+
+                for ( $i = 0, $i_count = count( $action ); $i < $i_count; $i++ )
+                    $actions[] = $action[$i]['key'];
+            }
+
+            // This was a mis-named activity type from before BP 1.6
+            unset( $actions['friends_register_activity_action'] );
+
+            // Check that the new type is a registered activity type
+            if ( in_array( $_REQUEST['bp-activities-type'], $actions ) )
+                $activity->type = $_REQUEST['bp-activities-type'];
         }
 
@@ -383 +456 @@
             $gmt_date = get_gmt_from_date( sprintf( "%04d-%02d-%02d %02d:%02d:%02d", $aa, $mm, $jj, $hh, $mn, $ss ) );
 
-            if ( $activity->date_recorded != $gmt_date ) {
-                $activity->date_recorded = $gmt_date;
-                $tainted = true;
-            }
+            $activity->date_recorded = $gmt_date;
         }
 
         // Has the spam status has changed?
-        if ( $prev_spam_status != $new_spam_status ) {
-            if ( 1 == $new_spam_status)
+        if ( $new_spam_status != $prev_spam_status ) {
+            if ( $new_spam_status )
                 bp_activity_mark_as_spam( $activity );
             else
                 bp_activity_mark_as_ham( $activity );
-
-            $tainted = true;
         }
 
@@ -406 +474 @@
 
         // Check for any error during activity save
-        if ( ! $result && $tainted )
+        if ( false === $result )
             $error = $activity->id;
 
@@ -448 +516 @@
  * Display the single activity edit screen
  *
+ * @global int $screen_layout_columns Number of columns shown on this admin page
  * @since 1.6
  */
 function bp_activity_admin_edit() {
+    global $screen_layout_columns;
+
     // @todo: Check if user is allowed to edit activity items
     // if ( ! current_user_can( 'bp_edit_activity' ) )
@@ -486 +557 @@
 
             <form action="<?php echo esc_attr( $form_url ); ?>" id="bp-activities-edit-form" method="post">
-                <div id="poststuff" class="metabox-holder has-right-sidebar">
+                <div id="poststuff" class="metabox-holder<?php echo 2 == $screen_layout_columns ? ' has-right-sidebar' : ''; ?>">
                     <div id="side-info-column" class="inner-sidebar">
                         <?php do_meta_boxes( 'toplevel_page_bp-activity', 'side', $activity ); ?>
@@ -574 +645 @@
 
 /**
+ * Primary link metabox for the Activity admin edit screen
+ *
+ * @param object $item Activity item
+ * @since 1.6
+ */
+function bp_activity_admin_edit_metabox_link( $item ) {
+?>
+
+    <label class="screen-reader-text" for="bp-activities-link"><?php _e( 'Link', 'buddypress' ); ?></label>
+    <input type="url" name="bp-activities-link" value="<?php echo esc_url( $item->primary_link ); ?>" />
+    <p><?php _e( 'Activity generated by blog posts and comments, forum topics and replies, and some plugins, uses the link field for a permalink back to the content item.', 'buddypress' ); ?></p>
+
+<?php
+}
+
+/**
+ * User ID metabox for the Activity admin edit screen
+ *
+ * @param object $item Activity item
+ * @since 1.6
+ */
+function bp_activity_admin_edit_metabox_userid( $item ) {
+?>
+
+    <label class="screen-reader-text" for="bp-activities-userid"><?php _e( 'Author ID', 'buddypress' ); ?></label>
+    <input type="number" name="bp-activities-userid" value="<?php echo esc_attr( $item->user_id ); ?>" min="1" />
+
+<?php
+}
+
+/**
+ * Activity type metabox for the Activity admin edit screen
+ *
+ * @global object $bp BuddyPress global settings
+ * @param object $item Activity item
+ * @since 1.6
+ */
+function bp_activity_admin_edit_metabox_type( $item ) {
+    global $bp;
+
+    $actions  = array();
+    $selected = $item->type;
+
+    // Walk through the registered actions, and build an array of actions/values.
+    foreach ( $bp->activity->actions as $action ) {
+        $action = array_values( (array) $action );
+
+        for ( $i = 0, $i_count = count( $action ); $i < $i_count; $i++ )
+            $actions[ $action[$i]['key'] ] = $action[$i]['value'];
+    }
+
+    // This was a mis-named activity type from before BP 1.6
+    unset( $actions['friends_register_activity_action'] );
+
+    // Sort array by the human-readable value
+    natsort( $actions );
+?>
+
+    <select name="bp-activities-type">
+        <?php foreach ( $actions as $k => $v ) : ?>
+            <option value="<?php echo esc_attr( $k ); ?>" <?php selected( $k,  $selected ); ?>><?php echo esc_html( $v ); ?></option>
+        <?php endforeach; ?>
+    </select>
+
+<?php
+}
+
+/**
+ * Primary item ID/Secondary item ID metabox for the Activity admin edit screen
+ *
+ * @param object $item Activity item
+ * @since 1.6
+ */
+function bp_activity_admin_edit_metabox_itemids( $item ) {
+?>
+
+    <label for="bp-activities-primaryid"><?php _e( 'Primary Item ID', 'buddypress' ); ?></label>
+    <input type="number" name="bp-activities-primaryid" id="bp-activities-primaryid" value="<?php echo esc_attr( $item->item_id ); ?>" />
+    <br />
+
+    <label for="bp-activities-secondaryid"><?php _e( 'Secondary Item ID', 'buddypress' ); ?></label>
+    <input type="number" name="bp-activities-secondaryid" id="bp-activities-secondaryid" value="<?php echo esc_attr( $item->secondary_item_id ); ?>" />
+
+    <p><?php _e( 'These identify the object that created this activity. For example, the fields could reference a pair of site and comment IDs.', 'buddypress' ); ?></p>
+
+<?php
+}
+
+/**
  * Display the Activity admin index screen, which contains a list of all the activities.
  *
@@ -591 +751 @@
         $spammed   = !empty( $_REQUEST['spammed']   ) ? (int) $_REQUEST['spammed']   : 0;
         $unspammed = !empty( $_REQUEST['unspammed'] ) ? (int) $_REQUEST['unspammed'] : 0;
-        $updated   = !empty( $_REQUEST['updated'] )   ? (int) $_REQUEST['updated']   : 0;
+        $updated   = !empty( $_REQUEST['updated']   ) ? (int) $_REQUEST['updated']   : 0;
 
         if ( $deleted > 0 )
@@ -597 +757 @@
 
         if ( $error > 0 )
-            $messages[] = sprintf( __( 'An error occured when updating Activity ID #%s.', 'buddypress' ), number_format_i18n( $error ) );
+            $messages[] = sprintf( __( 'An error occurred when updating Activity ID #%s.', 'buddypress' ), number_format_i18n( $error ) );
 
         if ( $spammed > 0 )

trunk/bp-activity/bp-activity-classes.php

@@ -87 +87 @@
             $q = $wpdb->prepare( "INSERT INTO {$bp->activity->table_name} ( user_id, component, type, action, content, primary_link, date_recorded, item_id, secondary_item_id, hide_sitewide, is_spam ) VALUES ( %d, %s, %s, %s, %s, %s, %s, %s, %s, %d, %d )", $this->user_id, $this->component, $this->type, $this->action, $this->content, $this->primary_link, $this->date_recorded, $this->item_id, $this->secondary_item_id, $this->hide_sitewide, $this->is_spam );
 
-        if ( !$wpdb->query( $q ) )
+        if ( false === $wpdb->query( $q ) )
             return false;