NP_ModComments.php

<?php
/**
NP_ModComments:
 * 
 *                       ** PHP 5.x ONLY ** 
 * Now caches data for added speed and less SQL socket use 
 * New mean average scores option
 
Allows you to add a comment moderation system (like the one on /. to your site).
This plugin offers the core functionality, later on I (or other people) can make
plugins that depend on this one (like: calculating a member's score, hiding troll comments, ...)
 
You are free to use this code but it is provided as is. I (Tim) will try to support it but
I'm a student and I often just don't have the time.

I hope you enjoy this plugin!
 
Tim

Changes released after Tim's edition are released by me, Matt under the GNU GPL v3.  
*/
 
if (!function_exists('sql_table'))
{
	function sql_table($name) {
		return 'nucleus_' . $name;
	}
}
 
class NP_ModComments extends NucleusPlugin {
 
	protected $mod;
        
        protected $commentCache = array();
 
	public function getName() {
		return 'ModComments'; 
	}
 
	public function getAuthor()  { 
		return 'Lord Matt based on work by Tim Broddin'; 
	}
 
	public function getURL()	{
		return 'https://github.com/Lord-Matt-NucleusCMS-Stuff/NP_ModComments'; 
	}
 
	public function getVersion() {
		return '2.1.1'; 
	}
 
	public function getDescription() { 
		return 'Meta-Moderation for comments plugin. A plugin that 
                    allows logged in users to moderate comments. Now even faster 
                    and with mean average';
	}
        
        /**
         * Default method to access tables used/owned in DB
         * @return array (of table names)
         */
        public function getTableList() { 
            return array( 
                    sql_table('plugin_modcomments')
            ); 
        }
        
        /**
         * Installs the table needed. 
         * NOTE: If the table already exists the table will need to be updaated
         * to have a recordID as autoincriment primary key
         */
	public function install() {
		sql_query ('CREATE TABLE IF NOT EXISTS `' . sql_table('plugin_modcomments') . '` (
                `recordID` int(11) NOT NULL AUTO_INCREMENT,
                `commentid` int(11) DEFAULT NULL,
                `modid` int(11) DEFAULT NULL,
                `score` int(4) DEFAULT NULL,
                PRIMARY KEY (`recordID`),
                KEY `comment` (`commentid`),
                KEY `mod` (`modid`)
                )'); 
                /*
                 * UPDATE TABLE IF NOT EXISTS ... (?)
                 */

                $this->createOption(
                        "NMM",
                        "Message to show to non members, leave blank for none",
                        'textarea', 
                        ''
                );
                $this->createOption('Version', 'Version', 'textarea', '2.1', 'access=hidden');
        }            
 
 
        /**
         *
         * @param string $what
         * @return int (sudo bool)
         */
	public function supportsFeature($what) {
		switch($what) {
		case 'HelpPage':
			return 1;
			break;
		case 'SqlTablePrefix':
			return 1;
			break;
		  default:
			return 0;
		}
	}  
   
        /**
         * Plugins have the init function called when they are first started. 
         * This function provides hard coded values which should be moved to
         * enable user editing.
         */
        public function init() {

            // Possibly move this to function getEventList() as this is only run
            // when updates are needed.
            /*
             * Now for upgrades
             */
            if($this->getOption('Version')=='2.1'){
                // anyupdate?
                // setOption('Version','2.2')
            }
            
            
            #Old presets- edit these yourself for now.
            
                $this->mod[0]['name'] = 'Insulting';
                $this->mod[0]['score'] = -4;

                $this->mod[1]['name'] = 'Off Topic';
                $this->mod[1]['score'] = -3;

                $this->mod[2]['name'] = 'Unhelpful';
                $this->mod[2]['score'] = -2;

                $this->mod[3]['name'] = 'Bland';
                $this->mod[3]['score'] = -1;

                $this->mod[4]['name'] = 'Funny';
                $this->mod[4]['score'] = 1;

                $this->mod[5]['name'] = 'Helpful';
                $this->mod[5]['score'] = 2;

                $this->mod[6]['name'] = 'Informative';
                $this->mod[6]['score'] = 3;

                $this->mod[7]['name'] = 'Insightful';
                $this->mod[7]['score'] = 4;

                parent::init();

        }

        
        public function doTemplateVar($item, $type='', $param1 = 'default value'){
            echo "<p><b>Error</b> The tempalte tag does not go here.</p>";
        }
        /**
         * This function remains largely unedited.
         * @global array $CONF
         * @global object $member
         * @param object $item
         * @param object $comment
         * @param string $param1 
         */
	public function doTemplateCommentsVar($item, $comment, $param1){
		global $CONF, $member;
                
		switch ($param1) {
			case 'form':
				if ($member->isLoggedIn()) {
					echo '<form name="modcomments' . $comment['commentid'] . '" action="' .$CONF['IndexURL'] . 'action.php" method="POST">' . "\n";
					echo '<select class="moderationselect" name="modcommentsselect" onchange="document.modcomments' . $comment['commentid'] . '.submit()">' . "\n";
					echo '<option value="-1">Moderation Menu</option>' . "\n";
					echo '<option value="-1">---------------</option>' . "\n";		
					for ($i=0; $i < count($this->mod);$i++) {
						echo '<option value="'. $i . '">' . $this->mod[$i]['name'] . '</option>' . "\n";
					}
					echo '</select>' . "\n";
    				echo '<input type="hidden" name="action" value="plugin" />';
    				echo '<input type="hidden" name="name" value="ModComments" />';
    				echo '<input type="hidden" name="type" value="moderate" />';
    				echo '<input type="hidden" name="commentid" value="' . $comment['commentid'] . '" />';		
					echo '<input type="hidden" name="memberid" value="' . $comment['memberid'] . '" />';
					echo '</form>' . "\n";
 
				} else {
					echo $this->getOption("NMM");
				}
				break;
			case 'top':
				echo $this->ModGetTop($comment['commentid']);
				break;			
			case 'score':
				echo $this->ModGetScore($comment['commentid']);
				break;
			case 'votes':
				echo $this->ModGetVotes($comment['commentid']);
				break;
			case 'mean':
				echo $this->ModGetMean($comment['commentid']);
				break;
                            default :
                                echo "<!-- ModComments($param1) was not recognised -->";
		}
	}
 
        /**
         * Carries out the voting
         * @global object $member
         * @global type $HTTP_REFERER
         * @param type $actionType 
         */
	public function doAction($actionType) {
		global $member, $HTTP_REFERER;;
                
		$modvalue = requestVar('modcommentsselect');
		$modvalue = mysql_real_escape_string($modvalue);
 
		$commentid = requestVar('commentid');
		$commentid = mysql_real_escape_string($commentid);
 
		$memberid = requestVar('memberid');
		// This vlaue is not used in SQL
                //$memberid = mysql_real_escape_string($memberid);
 
		$modid = $member->id;
 
 
		if ($modvalue != -1) {
			$modscore = $this->mod[$modvalue]['score'];
                        $sql ="SELECT * FROM `" . sql_table('plugin_modcomments') . "` WHERE `commentid`='$commentid' AND `modid`='$modid';";
			// Check to see if member has already moderated the given comment
                        
                        //echo $sql;
			$result = sql_query($sql);
			if (mysql_num_rows($result) == 0) {	
				// Also check to see if a user doesn't try to vote on his own comments
				if ($memberid != $modid) {
                                        $sql = 'INSERT INTO `' . sql_table('plugin_modcomments') . "` (`commentid`, `modid`, `score`) VALUES ('$commentid', '$modid', '$modscore');";
                                        //echo $sql;
					sql_query($sql);
				}
			}
		}
		header("Location: " . $_SERVER['HTTP_REFERER']);
                exit();
 
	}	
 
        /**
         * API to get the most voted reason
         * @param type $commentid
         * @return boolean 
         */
        public function ModGetTop($commentid){
            
            if( isset($this->commentCache[$commentid]['top']) ){
                return $this->commentCache[$commentid]['top'];
            }
            
            $sql = 'SELECT `score`, count(`score`) as count FROM `' . 
                    sql_table('plugin_modcomments') . 
                    '` WHERE `commentid`=' . 
                    $commentid .
                    ' GROUP BY `score` ORDER BY `count` DESC;';
            $result = sql_query($sql);
 
            if (mysql_num_rows($result) > 0) {
                    $score = mysql_result($result,0,'score');
            } else {
                    return false;
            }

            for($i=0;$i<count($this->mod);$i++) {
                    if ($this->mod[$i]['score'] == $score) {
                        $this->commentCache[$commentid]['top']=$this->mod[$i]['name'];
                        return $this->commentCache[$commentid]['top'];
                    }
            }
            
            return false;
        } 
       
        /** 
         * API to get the number of votes
         * @param type $commentid 
         */
        public function ModGetVotes($commentid){
            
            if( isset($this->commentCache[$commentid]['votes']) ){
                return $this->commentCache[$commentid]['votes'];
            }
            
            $sql = 'SELECT count(*) as `votes` FROM `' . 
                    sql_table('plugin_modcomments') . 
                    '` WHERE `commentid`=' . 
                    $commentid;
            $result = sql_query($sql);
            $this->commentCache[$commentid]['votes']=mysql_result($result, 0, 'votes');
            return $this->commentCache[$commentid]['votes'];
        }

        /**
         * API to get the score
         * @param type $commentid
         * @return int 
         */
        public function ModGetScore($commentid){

            if( isset($this->commentCache[$commentid]['score']) ){
                return $this->commentCache[$commentid]['score'];
            }
            
            $sql ='SELECT sum(`score`) as `score` FROM `' . 
                    sql_table('plugin_modcomments') . 
                    '` WHERE `commentid`=' . $commentid;
            $result = sql_query($sql);
            if(mysql_num_rows($result)>0){
                $score = mysql_result($result,0,'score');
            } else {
                $score=0;// will never be used
            }
            // add score to zero to be sure that no votes gives a value
            $this->commentCache[$commentid]['score'] = 0+$score;
            return $this->commentCache[$commentid]['score'];
        }
        
        /**
         * API to get the mean average
         * @param type $commentid
         * @return type 
         */
        public function ModGetMean($commentid){
                       
            if( isset($this->commentCache[$commentid]['mean']) ){
                return $this->commentCache[$commentid]['mean'];
            }
            
            $votes = $this->ModGetVotes($commentid);
            $score = $this->ModGetScore($commentid);
            if($votes!=0 && $score!=0){
                $this->commentCache[$commentid]['mean'] = number_format($score/$votes, 2, '.', '');
            }
        }
}