internal-comments-class.php

<?php
! defined( 'ABSPATH' ) AND exit;
/*
Plugin Name: Private Comments for CPT
Plugin URI: https://github.com/baden03/Private-Comments-in-CPT
Description: Enables internal comments for a given Custom Post Type when Editing Draft or Pending posts.
Author: Rodolfo Buaiz, Twinpictures
Author URI: https://rodbuaiz.com/
Version: 2023.01.25.01
License: GPL
*/

class InternalComments {    
	private $cpt_include = array( 'draft', 'pending' ); // Where to enable the comments
    
    private $cpt_exclude = array( 'trash' ); // Deny only if cpt comment in trash
    
    private $other_exclude = array('draft','pending','trash'); // Deny to the rest of post_types
    
	private $row_id = 'inner_msgs';

	public function __construct() {
		add_action( 'admin_init', array( $this, 'text_domain' ) );
        add_action( 'admin_init', array( $this, 'init_admin') );
		/*
		if (!is_admin()) {
			add_action( 'init', array( $this, 'init_front') );
		}
		*/
        	
	}
	

    function init_admin(){
        add_action( 'current_screen', array(  $this, 'exclude_lazy_hook' ), 10, 2 );
		add_action( 'wp_ajax_replyto-comment', array( $this, 'ajax_replyto_comment' ), 0 );

		if( isset( $_GET['post'] ) ){
			$this->add_comment_metabox();
		}
		add_action( 'admin_footer-edit-comments.php', array( $this, 'karma_row_bg_color' ) );
		add_action( 'load-edit-comments.php', array( $this, 'wpse_64973_load' ) );
		add_action( 'manage_comments_custom_column', array( $this, 'wpse_64973_column_cb' ), 10, 2 );
    }

	function is_iccpt( $comment_post_id = null ){
		// Allow cpts to be filtered
		$cpt = apply_filters( 'internal_comments_cpt', array( 'portfolio' ) );
		return in_array( get_post_type($comment_post_id), $cpt, true );
	}

    function init_front() {
		add_filter( 'comments_array', array( $this, 'remove_karmic_comments' ), 20, 2 );
	}

	function text_domain(){
		load_plugin_textdomain( 
				'iccpt', 
				FALSE, 
				dirname( plugin_basename(__FILE__) ) . '/languages/' 
		);
	}
	
	/**
	 * Delay hooking our clauses filter to ensure it's only applied when needed. 
	 *
	 * @param object $screen
	 * @return void
	 **/
	function exclude_lazy_hook( $screen ){
		if ($screen->id != 'edit-comments') {
			return;
		}
		// Check if our Query Var is defined	
		if (isset($_GET['internal_messages'])) {
			add_action( 'pre_get_comments', array( $this, 'list_only_internal_messages' ), 10, 1 );
		}
		add_filter( 'comment_status_links', array( $this, 'link_to_internal_messages' ) );
	}
	
    /**
	 * Only display comments of specific karma
	 *
	 * @param integer $cols
	 * @return object WP_Comment_Query
	 **/
	function list_only_internal_messages( $clauses ){
		$clauses->query_vars['karma'] = 3;
		return $clauses;
	}


	/**
	 * Add link to custom comments karma with counter
	 *
	 * @param integer $cols
	 * @return integer
	 **/
	function link_to_internal_messages( $status_links ){
		global $wpdb;
		$count = count( 
			$wpdb->get_results( 
				$wpdb->prepare( 
					"SELECT comment_ID FROM $wpdb->comments
					WHERE comment_karma = %d 
					AND comment_approved != %s",
					3,
					'trash'
				)
			) 
		);

		if( isset( $_GET['internal_messages'] ) ) {
			$status_links['all'] = 
				'<a href="edit-comments.php?comment_status=all">' 
				. __('All') 
				. '</a>';
				
			$status_links['internal_messages'] = 
				'<a href="edit-comments.php?comment_status=all&internal_messages=1" class="current" style="margin-leff:60px">' 
				. __( 'Internal Comments', 'iccpt' ) 
				. ' <span class="count">('
				. $count
				. ')</a></span>';
		} 
		else {
			$status_links['internal_messages'] = 
				'<a href="edit-comments.php?comment_status=all&internal_messages=1" style="margin-leff:60px">' 
				. __( 'Internal Comments', 'iccpt' ) 
				. '  <span class="count">('
				. $count
				. ')</span></a>';
		}

		return $status_links;
	}
	
	
	/**
	 * Modified copy of wp_ajax_replyto_comment()
	 * /wp-admin/includes/ajax-actions.php
	 *
	 * Adjust the CPT that defines $diff_status 
	 * TODO: permissions should be cpt caps and defined in a plugin settings page
	 */
	function ajax_replyto_comment( $action ) {
		global $wp_list_table, $wpdb;

		$comment_post_id = (int) $_POST['comment_post_ID'];
		if ( !current_user_can( 'edit_post', $comment_post_id ) )
			wp_die( -1 );

		if ( empty( $action ) )
			$action = 'replyto-comment';

		check_ajax_referer( $action, '_ajax_nonce-replyto-comment' );

		set_current_screen( 'edit-comments' );

		$status = $wpdb->get_var( $wpdb->prepare( "SELECT post_status FROM $wpdb->posts WHERE ID = %d", $comment_post_id ) );

		if( !empty($comment_post_id) && $this->is_iccpt($comment_post_id) )
			$diff_status = $this->cpt_exclude;
		else
			$diff_status = $this->other_exclude;


		if ( empty( $status ) )
			wp_die( 1 );
		elseif ( in_array( $status, $diff_status ) )
			wp_die( __('ERROR: you are replying to a comment on a draft post.', 'iccpt' ) );

		$user = wp_get_current_user();
		
		if ( $user->exists() ) {
			$comment_author       = wp_slash( $user->display_name );
			$comment_author_email = wp_slash( $user->user_email );
			$comment_author_url   = wp_slash( $user->user_url );
			$user_id              = $user->ID;

			$comment_content      = trim( $_POST['content'] );
			if ( current_user_can( 'unfiltered_html' ) ) {
				if ( wp_create_nonce( 'unfiltered-html-comment' ) != $_POST['_wp_unfiltered_html_comment'] ) {
					kses_remove_filters(); // start with a clean slate
					kses_init_filters(); // set up the filters
				}
			}
		}
		else {
			wp_die( __( 'Sorry, you must be logged in to reply to a comment.', 'iccpt' ) );
		}

		if ( '' == $comment_content ){
			wp_die( __( 'ERROR: please type a comment.', 'iccpt' ) );
		}	

		$comment_parent = absint($_POST['comment_ID']);
		$comment_auto_approved = false;

		//$commentdata = compact('comment_post_ID', 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content', 'comment_type', 'comment_parent', 'user_ID');
		$commentdata = array(
			'comment_post_ID' => $comment_post_id,
		);
	
		$commentdata += compact(
			'comment_author',
			'comment_author_email',
			'comment_author_url',
			'comment_content',
			'comment_type',
			'comment_parent',
			'user_id'
		);

		$commentdata['comment_karma'] = 
			( $diff_status == $this->other_exclude ) 
			? $commentdata['comment_karma'] 
			: 3;

		$comment_id = wp_new_comment( $commentdata );
		$comment = get_comment($comment_id);
		if (!$comment) {
			wp_die( 1 );
		}

		if (!in_array('draft', $diff_status)) {
			update_comment_meta( $comment_id, $this->row_id, 'yes' );
		}

		$position = ( isset($_POST['position']) && (int) $_POST['position'] ) ? (int) $_POST['position'] : '-1';

		// automatically approve parent comment
		if ( !empty($_POST['approve_parent']) ) {
			$parent = get_comment( $comment_parent );

			if ( $parent && $parent->comment_approved === '0' && $parent->comment_post_ID == $comment_post_id ) {
				if ( wp_set_comment_status( $parent->comment_ID, 'approve' ) ){
					$comment_auto_approved = true;
				}	
			}
		}

		ob_start();
			if ( 'dashboard' == $_REQUEST['mode'] ) {
				require_once( ABSPATH . 'wp-admin/includes/dashboard.php' );
				_wp_dashboard_recent_comments_row( $comment );
			} 
			else {
				if ( 'single' == $_REQUEST['mode'] ) {
					$wp_list_table = _get_list_table('WP_Post_Comments_List_Table');
				} 
				else {
					$wp_list_table = _get_list_table('WP_Comments_List_Table');
				}
				$wp_list_table->single_row( $comment );
			}
			$comment_list_item = ob_get_contents();
		ob_end_clean();

		$response =  array(
			'what' => 'comment',
			'id' => $comment->comment_ID,
			'data' => $comment_list_item,
			'position' => $position
		);

		if ($comment_auto_approved) {
			$response['supplemental'] = array( 'parent_approved' => $parent->comment_ID );
		}

		$x = new WP_Ajax_Response();
		$x->add( $response );
		$x->send();
	}

	
	/**
	 * Enables the default Comments Meta Box
	 *
	 * @return void
	 */
	function add_comment_metabox()
	{
		$post_id = absint( $_GET['post'] ); 
        $post = get_post( $post_id ); 
        if ( in_array( $post->post_status, $this->cpt_include ) )
		{
            add_meta_box(
                'commentsdiv' 
            ,   __( 'Offline Comments', 'iccpt' )
            ,   'post_comment_meta_box'
            ,   apply_filters( 'internal_comments_cpt', array( 'portfolio' ) )
            ,   'normal' 
            ,   'core'
            );
		}        
	}
	

	/**
	 * Removes comments with Karma from frontend 
	 *
	 * @param object $comments
	 * @param int	 $post_id
	 * @return object
	 **/
	function remove_karmic_comments( $comments, $post_id ){
	   foreach ( $comments as $index => $c )
	   {
	       if ( $c->comment_karma == 3 )
	           unset( $comments[ $index ] );
	   }
	   return $comments;
	}
	
	//TODO: this should be moved to external files / plugin options page
	function karma_row_bg_color(){
		if( isset( $_GET['internal_messages'] ) )
			return;
	    ?>
	        <script type="text/javascript">
	            jQuery(document).ready( function($) {
	                //$('.inner-msgs-span').parent().parent().css('background-color','#858585').fadeTo('slow', 1);
					$('.inner-msgs-span').parent().parent().fadeTo('fast', .3, function()
					{
					    $(this).css('background-color', '#E3E3E3');
					}).fadeTo('slow', 1);
	            });     
	        </script>
	    <?php
	}
	
	
	/*
	Plugin Name. Add Extra Comment Columns for Comment_Meta
	Author URI. http://pmg.co/people/chris
	License. MIT
	*/
	function wpse_64973_load(){
		if (isset($_GET['internal_messages'])) {
			return;
		}
	    $screen = get_current_screen();
	    add_filter( "manage_{$screen->id}_columns", array( $this, 'wpse_64973_add_columns' ) );
	}
	function wpse_64973_add_columns( $cols ){
	    $cols[$this->row_id] = __( 'Internal Comments', 'iccpt' );
	    return $cols;
	}
	function wpse_64973_column_cb( $col, $comment_id ){
	    switch( $col ){
	        case $this->row_id:
	            if( 'yes' == get_comment_meta( $comment_id, $this->row_id, true ) )
	            {
	                echo '<span style="color:#f00;font-size:7em;line-height:.5em;margin-left:15%" class="inner-msgs-span"><sub>&#149;</sub></span>';
	            }
	            break;
	    }
	} /* end plugin */
	
} /* end class */
$WP_InternalComments = new InternalComments;


// http://wordpress.stackexchange.com/questions/25910
if ( ! class_exists('InternalCommentsInit' ) ) :
/**
 * This class triggers functions that run during activation/deactivation & uninstallation
 */
class InternalCommentsInit
{
    // Set this to true to get the state of origin, so you don't need to always uninstall during development.
    const STATE_OF_ORIGIN = false;


    function __construct( $case = false )
    {
        if ( ! $case )
            wp_die( 'Busted! You should not call this class directly', 'Doing it wrong!' );

        switch( $case )
        {
            case 'activate' :
                add_action( 'init', array( &$this, 'activate_cb' ) );
                break;

            case 'deactivate' : 
                add_action( 'init', array( &$this, 'deactivate_cb' ) );
                break;

            case 'uninstall' : 
                add_action( 'init', array( &$this, 'uninstall_cb' ) );
                break;
        }
    }

    /**
     * Set up tables, add options, etc. - All preparation that only needs to be done once
     */
    function on_activate()
    {
        new InternalCommentsInit( 'activate' );
    }

    /**
     * Do nothing like removing settings, etc. 
     * The user could reactivate the plugin and wants everything in the state before activation.
     * Take a constant to remove everything, so you can develop & test easier.
     */
    function on_deactivate()
    {
        $case = 'deactivate';
        if ( STATE_OF_ORIGIN )
            $case = 'uninstall';

        new InternalCommentsInit( $case );
    }

    /**
     * Remove/Delete everything - If the user wants to uninstall, then he wants the state of origin.
     * 
     * Will be called when the user clicks on the uninstall link that calls for the plugin to uninstall itself
     */
    function on_uninstall()
    {
        // important: check if the file is the one that was registered with the uninstall hook (function)
        if ( __FILE__ != WP_UNINSTALL_PLUGIN )
            return;

        new InternalCommentsInit( 'uninstall' );
    }

    function activate_cb()
    {
        // Stuff like adding default option values to the DB
        wp_die( '<h1>This is run on <code>init</code> during activation.</h1>', 'Activation hook example' );
    }

    function deactivate_cb()
    {
        // if you need to output messages in the 'admin_notices' field, do it like this:
        $this->error( "Some message.<br />" );
        // if you need to output messages in the 'admin_notices' field AND stop further processing, do it like this:
        $this->error( "Some message.<br />", TRUE );
        // Stuff like remove_option(); etc.
        wp_die( '<h1>This is run on <code>init</code> during deactivation.</h1>', 'Deactivation hook example' );
    }

    function uninstall_cb()
    {
        // Stuff like delete tables, etc.
        wp_die( '<h1>This is run on <code>init</code> during uninstallation</h1>', 'Uninstallation hook example' );
    }
    /**
     * trigger_error()
     * 
     * @param (string) $error_msg
     * @param (boolean) $fatal_error | catched a fatal error - when we exit, then we can't go further than this point
     * @param unknown_type $error_type
     * @return void
     */
    function error( $error_msg, $fatal_error = false, $error_type = E_USER_ERROR )
    {
        if( isset( $_GET['action'] ) && 'error_scrape' == $_GET['action'] ) 
        {
            echo "{$error_msg}\n";
            if ( $fatal_error )
                exit;
        }
        else 
        {
            trigger_error( $error_msg, $error_type );
        }
    }
}
endif;