rhymix/modules/comment/comment.model.php

<?php
/* Copyright (C) NAVER <http://www.navercorp.com> */

/**
 * commentModel class
 * model class of the comment module
 *
 * @author NAVER (developers@xpressengine.com)
 * @package /modules/comment
 * @version 0.1
 */
class CommentModel extends Comment
{

	/**
	 * Initialization
	 * @return void
	 */
	public function init()
	{

	}

	/**
	 * display the pop-up menu of the post
	 * Print, scrap, vote-up(recommen), vote-down(non-recommend), report features added
	 * @return void
	 */
	public function getCommentMenu()
	{
		// get the post's id number
		$comment_srl = Context::get('target_srl');
		$mid = Context::get('cur_mid');

		// array values for menu_list, "comment post, target, url"
		$menu_list = array();

		// call a trigger
		ModuleHandler::triggerCall('comment.getCommentMenu', 'before', $menu_list);

		$oCommentController = getController('comment');

		// feature that only member can do
		if($this->user->member_srl)
		{
			$columnList = array('comment_srl', 'module_srl', 'member_srl', 'ipaddress');
			$oComment = self::getComment($comment_srl, FALSE, $columnList);
			$module_srl = $oComment->get('module_srl');
			$member_srl = abs($oComment->get('member_srl'));
			if(!$module_srl) throw new Rhymix\Framework\Exceptions\InvalidRequest;

			$comment_config = ModuleModel::getModulePartConfig('comment', $module_srl);
			$oCommentisVoted = $oComment->getMyVote();
			if($comment_config->use_vote_up != 'N' && $member_srl != $this->user->member_srl)
			{
				if($oCommentisVoted === false || $oCommentisVoted < 0)
				{
					$url = sprintf("doCallModuleAction('comment','procCommentVoteUp','%s')", $comment_srl);
					$oCommentController->addCommentPopupMenu($url, 'cmd_vote', '', 'javascript');
				}
				elseif($oCommentisVoted > 0)
				{
					$url = sprintf("doCallModuleAction('comment','procCommentVoteUpCancel','%s')", $comment_srl);
					$oCommentController->addCommentPopupMenu($url, 'cmd_cancel_vote', '', 'javascript');
				}
			}

			if($comment_config->use_vote_down != 'N' && $member_srl != $this->user->member_srl)
			{
				if($oCommentisVoted === false || $oCommentisVoted > 0)
				{
					$url = sprintf("doCallModuleAction('comment','procCommentVoteDown','%s')", $comment_srl);
					$oCommentController->addCommentPopupMenu($url, 'cmd_vote_down', '', 'javascript');
				}
				else if($oCommentisVoted < 0)
				{
					$url = sprintf("doCallModuleAction('comment','procCommentVoteDownCancel','%s')", $comment_srl);
					$oCommentController->addCommentPopupMenu($url,'cmd_cancel_vote_down','','javascript');
				}
			}

			// Add the report feature against abused posts
			if($oComment->getDeclared())
			{
				$url = getUrl('', 'mid', $mid, 'act', 'dispCommentDeclare', 'target_srl', $comment_srl, 'type', 'cancel');
				$oCommentController->addCommentPopupMenu($url,'cmd_cancel_declare','','popup');
			}
			else
			{
				$url = getUrl('', 'mid', $mid, 'act', 'dispCommentDeclare', 'target_srl', $comment_srl);
				$oCommentController->addCommentPopupMenu($url,'cmd_declare','','popup');
			}
		}

		// call a trigger (after)
		ModuleHandler::triggerCall('comment.getCommentMenu', 'after', $menu_list);

		if($this->grant->manager){
			$str_confirm = lang('confirm_move');
			$url = sprintf("if(!confirm('%s')) return; var params = new Array(); params['comment_srl']='%s'; params['mid']=current_mid;params['cur_url']=current_url; exec_xml('comment', 'procCommentAdminMoveToTrash', params)", $str_confirm, $comment_srl);
			$oCommentController->addCommentPopupMenu($url,'cmd_trash','','javascript');

		}

		// find a comment by IP matching if an administrator.
		if($this->user->is_admin == 'Y')
		{
			$oComment = self::getComment($comment_srl);

			if($oComment->isExists())
			{
				// Find a post of the corresponding ip address
				$url = getUrl('', 'module', 'admin', 'act', 'dispCommentAdminList', 'search_target', 'ipaddress', 'search_keyword', $oComment->getIpAddress());
				$oCommentController->addCommentPopupMenu($url, 'cmd_search_by_ipaddress', '', 'TraceByIpaddress');

				$url = sprintf("var params = new Array(); params['ipaddress_list']='%s'; exec_xml('spamfilter', 'procSpamfilterAdminInsertDeniedIP', params, completeCallModuleAction)", $oComment->getIpAddress());
				$oCommentController->addCommentPopupMenu($url, 'cmd_add_ip_to_spamfilter', '', 'javascript');
			}
		}

		// Changing a language of pop-up menu
		$menus = Context::get('comment_popup_menu_list') ?: [];
		foreach ($menus as $menu)
		{
			$menu->str = lang($menu->str ?? '');
		}

		// get a list of final organized pop-up menus
		$this->add('menus', $menus);
	}

	/**
	 * Check if you have a permission to comment_srl
	 * use only session information
	 * @param int $comment_srl
	 * @return bool
	 */
	public static function isGranted($comment_srl)
	{
		return $_SESSION['granted_comment'][$comment_srl];
	}

	/**
	 * Returns the number of child comments
	 * @param int $comment_srl
	 * @param array $statusList
	 * @return int
	 */
	public static function getChildCommentCount($comment_srl, $statusList = [])
	{
		$args = new stdClass();
		$args->comment_srl = $comment_srl;
		if ($statusList)
		{
			$args->statusList = $statusList;
		}
		$output = executeQuery('comment.getChildCommentCount', $args);
		return (int) $output->data->count;
	}

	/**
	 * Returns the number of child comments
	 * @param int $comment_srl
	 * @param array $statusList
	 * @return array
	 */
	public static function getChildComments($comment_srl, $statusList = [])
	{
		$args = new stdClass();
		$args->comment_srl = $comment_srl;
		if ($statusList)
		{
			$args->statusList = $statusList;
		}
		$output = executeQueryArray('comment.getChildComments', $args);
		return $output->data;
	}

	/**
	 * Get the comment
	 * @param int $comment_srl
	 * @param bool $is_admin
	 * @param array $columnList
	 * @return commentItem
	 */
	public static function getComment($comment_srl = 0, $is_admin = FALSE, $columnList = array())
	{
		$oComment = new commentItem($comment_srl, $columnList);
		if($is_admin)
		{
			trigger_error('Called CommentModel::getComment() with $is_admin = true', \E_USER_WARNING);
			$oComment->setGrant();
		}

		return $oComment;
	}

	/**
	 * Get the comment list(not paginating)
	 * @param string|array $comment_srl_list
	 * @param array $columnList
	 * @return array
	 */
	public static function getComments($comment_srl_list, $columnList = array())
	{
		if (!is_array($comment_srl_list))
		{
			$comment_srl_list = $comment_srl_list ? explode(',', $comment_srl_list) : array();
		}
		if (!count($comment_srl_list))
		{
			return array();
		}

		// fetch from a database
		$args = new stdClass();
		$args->comment_srls = $comment_srl_list;
		$output = executeQuery('comment.getComments', $args, $columnList);
		if(!$output->toBool())
		{
			return;
		}

		$comment_list = $output->data;
		if(!$comment_list)
		{
			return;
		}
		if(!is_array($comment_list))
		{
			$comment_list = array($comment_list);
		}

		foreach($comment_list as $key => $attribute)
		{
			if(!$attribute->comment_srl)
			{
				continue;
			}

			$oComment = new commentItem();
			$oComment->setAttribute($attribute);

			$result[$attribute->comment_srl] = $oComment;
		}
		return $result;
	}

	/**
	 * Get comment depth.
	 *
	 * @param int $comment_srl
	 * @return ?int
	 */
	public static function getCommentDepth(int $comment_srl): ?int
	{
		$output = executeQuery('comment.getCommentDepth', ['comment_srl' => $comment_srl]);
		return isset($output->data->depth) ? (int)$output->data->depth : null;
	}

	/**
	 * Get the total number of comments in corresponding with document_srl.
	 * @param int $document_srl
	 * @param array $statusList
	 * @return int
	 */
	public static function getCommentCount($document_srl, $statusList = [])
	{
		$args = new stdClass();
		$args->document_srl = $document_srl;

		// get the number of comments on the document module
		$columnList = array('document_srl', 'module_srl');
		$oDocument = DocumentModel::getDocument($document_srl, FALSE, TRUE, $columnList);

		// return if no doc exists.
		if(!$oDocument->isExists())
		{
			return;
		}

		// get a list of comments
		$module_srl = $oDocument->get('module_srl');

		//check if module is using validation system
		$oCommentController = getController('comment');
		$using_validation = $oCommentController->isModuleUsingPublishValidation($module_srl);
		$module_info = ModuleModel::getModuleInfoByDocumentSrl($document_srl);
		$use_comment_massage = $module_info->comment_delete_message;

		if($using_validation)
		{
			$args->status = 1;
		}
		elseif($use_comment_massage == 'Y')
		{
			$args->status = 1;
		}
		if ($statusList)
		{
			$args->statusList = $statusList;
		}

		$output = executeQuery('comment.getCommentCount', $args);
		$total_count = $output->data->count;

		return (int) $total_count;
	}

	/**
	 * Get the total number of comments posted on the given date.
	 * @param string $date
	 * @param array $moduleList
	 * @param array $statusList
	 * @return int
	 */
	public static function getCommentCountByDate($date = '', $moduleList = [], $statusList = [])
	{
		$args = new stdClass();
		if($date)
		{
			$args->regDate = date('Ymd', strtotime($date));
		}

		if($moduleList)
		{
			$args->module_srl = $moduleList;
		}
		if ($statusList)
		{
			$args->statusList = $statusList;
		}

		$output = executeQuery('comment.getCommentCount', $args);
		if(!$output->toBool())
		{
			return 0;
		}

		return $output->data->count;
	}

	/**
	 * Get the total number of comments in corresponding with module_srl.
	 * @param int $module_srl
	 * @param array|bool|null $statusList (Previously $published)
	 * @return int
	 */
	public static function getCommentAllCount($module_srl, $statusList = false)
	{
		$args = new stdClass();
		$args->module_srl = $module_srl;

		if ($statusList === null)
		{
			// check if module is using comment validation system
			$oCommentController = getController("comment");
			$is_using_validation = $oCommentController->isModuleUsingPublishValidation($module_srl);
			if($is_using_validation)
			{
				$args->status = 1;
			}
		}
		elseif (is_array($statusList) && count($statusList))
		{
			$args->statusList = $statusList;
		}
		else
		{
			if($statusList === 1 || $statusList === true)
			{
				$args->status = 1;
			}
			else
			{
				$args->status = 0;
			}
		}

		$output = executeQuery('comment.getCommentCount', $args);
		$total_count = $output->data->count;

		return (int) $total_count;
	}

	/**
	 * Get the module info without duplication
	 *
	 * @deprecated
	 *
	 * @return array
	 */
	public static function getDistinctModules()
	{
		return array();

		/*
		$output = executeQueryArray('comment.getDistinctModules');
		$module_srls = $output->data;
		$result = array();
		if($module_srls)
		{
			foreach($module_srls as $module)
			{
				$module_info = ModuleModel::getModuleInfoByModuleSrl($module->module_srl);
				$result[$module->module_srl] = $module_info->mid;
			}
		}
		return $result;
		*/
	}

	/**
	 * Get the comment in corresponding with mid.
	 * @todo add commentItems to cache too
	 * @param object $obj
	 * @param array $columnList
	 * @return array
	 */
	public static function getNewestCommentList($obj, $columnList = [])
	{
		$args = new stdClass();

		if(!is_object($obj))
		{
			$obj = new stdClass();
		}

		if(isset($obj->mid) && $obj->mid)
		{
			$obj->module_srl = ModuleModel::getModuleSrlByMid($obj->mid);
			unset($obj->mid);
		}

		// check if module_srl is an arrary.
		if(isset($obj->module_srl) && is_array($obj->module_srl))
		{
			$args->module_srl = implode(',', $obj->module_srl);
		}
		else
		{
			$args->module_srl = $obj->module_srl ?? null;
		}
		if (isset($obj->statusList) && is_array($obj->statusList) && count($obj->statusList))
		{
			$args->statusList = $obj->statusList;
		}
		$args->is_secret = $obj->is_secret ?? null;
		$args->document_srl = $obj->document_srl ?? null;
		$args->list_count = $obj->list_count ?? null;

		if(is_scalar($args->module_srl) && strpos($args->module_srl, ",") === false)
		{
			if($args->module_srl)
			{
				// check if module is using comment validation system
				$oCommentController = getController("comment");
				$is_using_validation = $oCommentController->isModuleUsingPublishValidation($obj->module_srl);
				if($is_using_validation)
				{
					$args->status = 1;
				}
			}
		}

		$output = executeQueryArray('comment.getNewestCommentList', $args, $columnList);
		if(!$output->toBool())
		{
			return $output;
		}

		$result = [];
		foreach ($output->data as $key => $attribute)
		{
			if ($attribute->comment_srl)
			{
				$oComment = new CommentItem();
				$oComment->setAttribute($attribute);
				$result[$key] = $oComment;
			}
		}

		return $result;
	}

	/**
	 * Get a comment list of the doc in corresponding woth document_srl.
	 * @param int $document_srl
	 * @param int $page
	 * @param int $unused (Previously $is_admin)
	 * @param int $count
	 * @param array $statusList
	 * @return object
	 */
	public static function getCommentList($document_srl, $page = 0, $unused = 0, $count = 0, $statusList = [])
	{
		if(!$document_srl)
		{
			return;
		}

		// get the number of comments on the document module
		$columnList = array('document_srl', 'module_srl', 'comment_count');
		$oDocument = DocumentModel::getDocument($document_srl, false, false, $columnList);

		// return if no doc exists.
		if(!$oDocument->isExists())
		{
			return;
		}

		// return if no comment exists
		$document_comment_count = $oDocument->getCommentCount();
		if($document_comment_count < 1)
		{
			return;
		}

		// get a list of comments
		$module_srl = $oDocument->get('module_srl');

		if(!$count)
		{
			$comment_config = self::getCommentConfig($module_srl);
			$comment_count = $comment_config->comment_count;
			$comment_page_count = $comment_config->comment_page_count;
		}
		else
		{
			$comment_count = $count;
		}

		// get a very last page if no page exists
		$total_pages = max(1, ceil($document_comment_count / $comment_count));
		if(!$page)
		{
			$page = (isset($comment_config->default_page) && $comment_config->default_page === 'first') ? 1 : $total_pages;
		}
		if($page > $total_pages)
		{
			$page = $total_pages;
		}

		// get a list of comments
		$args = new stdClass();
		$args->document_srl = $document_srl;
		$args->list_count = $comment_count;
		$args->page_count = $comment_page_count;
		$args->page = $page;

		//check if module is using validation system
		$oCommentController = getController('comment');
		$using_validation = $oCommentController->isModuleUsingPublishValidation($module_srl);
		if($using_validation)
		{
			$args->status = 1;
		}
		if($statusList)
		{
			$args->statusList = $statusList;
		}

		// Call trigger (before)
		// This trigger can be used to set an alternative output using a different search method
		unset($args->use_alternate_output);
		$trigger_output = ModuleHandler::triggerCall('comment.getCommentList', 'before', $args);
		if($trigger_output instanceof BaseObject && !$trigger_output->toBool())
		{
			return $trigger_output;
		}

		// If an alternate output is set, use it instead of running the default queries
		if (isset($args->use_alternate_output) && $args->use_alternate_output instanceof BaseObject)
		{
			$output = $args->use_alternate_output;
		}
		else
		{
			// Execute normal query
			$output = executeQueryArray('comment.getCommentPageList', $args);
			if(!$output->toBool())
			{
				return;
			}

			// insert data into CommentPageList table if the number of results is different from stored comments
			if(!$output->data)
			{
				self::fixCommentList($oDocument->get('module_srl'), $document_srl);
				$output = executeQueryArray('comment.getCommentPageList', $args);
				if(!$output->toBool())
				{
					return;
				}
			}
		}

		// Call trigger (after)
		// This trigger can be used to modify search results
		ModuleHandler::triggerCall('comment.getCommentList', 'after', $output);
		return $output;
	}

	/**
	 * Find out which page a comment is on
	 * @param int $document_srl
	 * @param int $comment_srl
	 * @param int $count
	 * @param array $statusList
	 * @return int
	 */
	public static function getCommentPage($document_srl, $comment_srl, $count = 0, $statusList = [])
	{
		// Check the document
		$columnList = array('document_srl', 'module_srl', 'comment_count');
		$oDocument = DocumentModel::getDocument($document_srl, false, false, $columnList);
		if(!$oDocument->isExists())
		{
			return 0;
		}

		// return if no comment exists
		$document_comment_count = $oDocument->getCommentCount();
		if($document_comment_count < 1)
		{
			return 0;
		}

		// Get the comment count per page
		if(!$count)
		{
			$module_srl = $oDocument->get('module_srl');
			$comment_config = self::getCommentConfig($module_srl);
			$comment_count = $comment_config->comment_count;
		}
		else
		{
			$comment_count = $count;
		}

		// Get the number of pages
		$total_pages = max(1, ceil($document_comment_count / $comment_count));
		if ($total_pages == 1)
		{
			return 1;
		}

		// Find out which page the comment is on
		$args = new stdClass();
		$args->document_srl = $document_srl;
		$args->comment_srl = $comment_srl;
		if ($statusList)
		{
			$args->statusList = $statusList;
		}
		$output = executeQuery('comment.getCommentPageItem', $args);
		if (is_object($output->data))
		{
			$item = $output->data;
			$args->head = $item->head;
			$args->arrange = $item->arrange;
			if (getController('comment')->isModuleUsingPublishValidation($module_srl))
			{
				$args->status = 1;
			}
			$output = executeQuery('comment.getCommentPage', $args);
			if ($output->toBool() && $output->data->count)
			{
				return max(1, ceil($output->data->count / $comment_count));
			}
			else
			{
				return 0;
			}
		}
		else
		{
			return 0;
		}
	}

	/**
	 * Update a list of comments in corresponding with document_srl
	 * Take care of previously used data than GA version
	 * @param int $module_srl
	 * @param int $document_srl
	 * @return void
	 */
	public static function fixCommentList($module_srl, $document_srl)
	{
		// create a lock file to prevent repeated work when performing a batch job
		$lock_file = "./files/cache/tmp/lock." . $document_srl;

		if(file_exists($lock_file) && filemtime($lock_file) + 60 * 60 * 10 < $_SERVER['REQUEST_TIME'])
		{
			return;
		}

		FileHandler::writeFile($lock_file, '');

		// get a list
		$args = new stdClass();
		$args->document_srl = $document_srl;
		$args->list_order = 'list_order';
		$output = executeQuery('comment.getCommentList', $args);
		if(!$output->toBool())
		{
			return $output;
		}

		$source_list = $output->data;
		if(!is_array($source_list))
		{
			$source_list = array($source_list);
		}

		// Sort comments by the hierarchical structure
		$comment_count = count($source_list);

		$root = new stdClass;
		$list = array();
		$comment_list = array();

		// get the log-in information for logged-in users
		$logged_info = Context::get('logged_info');

		// generate a hierarchical structure of comments for loop
		for($i = $comment_count - 1; $i >= 0; $i--)
		{
			$comment_srl = $source_list[$i]->comment_srl;
			$parent_srl = $source_list[$i]->parent_srl;
			if(!$comment_srl)
			{
				continue;
			}

			// generate a list
			$list[$comment_srl] = $source_list[$i];

			if($parent_srl && isset($list[$parent_srl]))
			{
				$list[$parent_srl]->child[] = &$list[$comment_srl];
			}
			else
			{
				$root->child[] = &$list[$comment_srl];
			}
		}
		self::_arrangeComment($comment_list, $root->child, 0, NULL);

		// insert values to the database
		if(count($comment_list))
		{
			foreach($comment_list as $comment_srl => $item)
			{
				$comment_args = new stdClass();
				$comment_args->comment_srl = $comment_srl;
				$comment_args->document_srl = $document_srl;
				$comment_args->head = $item->head;
				$comment_args->arrange = $item->arrange;
				$comment_args->module_srl = $module_srl;
				$comment_args->regdate = $item->regdate;
				$comment_args->depth = $item->depth;

				executeQuery('comment.insertCommentList', $comment_args);
			}
		}

		// remove the lock file if successful.
		FileHandler::removeFile($lock_file);
	}

	/**
	 * Relocate comments in the hierarchical structure
	 * @param array $comment_list
	 * @param array $list
	 * @param int $depth
	 * @param object $parent
	 * @return void
	 */
	public static function _arrangeComment(&$comment_list, $list, $depth, $parent = NULL)
	{
		if(!is_array($list) || !count($list))
		{
			return;
		}

		foreach($list as $key => $val)
		{
			if($parent)
			{
				$val->head = $parent->head;
			}
			else
			{
				$val->head = $val->comment_srl;
			}

			$val->arrange = count($comment_list) + 1;

			if($val->child)
			{
				$val->depth = $depth;
				$comment_list[$val->comment_srl] = $val;
				self::_arrangeComment($comment_list, $val->child, $depth + 1, $val);
				unset($val->child);
			}
			else
			{
				$val->depth = $depth;
				$comment_list[$val->comment_srl] = $val;
			}
		}
	}

	/**
	 * Get all the comments in time decending order(for administrators)
	 * @param object $obj
	 * @param array $columnList
	 * @return object
	 */
	public static function getTotalCommentList($obj, $columnList = array())
	{
		$query_id = 'comment.getTotalCommentList';

		// Variables
		$args = new stdClass();
		$args->sort_index = 'comments.list_order';
		$args->page = $obj->page ?? 1;
		$args->list_count = $obj->list_count ?? 20;
		$args->page_count = $obj->page_count ?? 10;
		$args->s_member_srl = $obj->member_srl ?? null;
		$args->s_module_srl = $obj->module_srl ?? null;
		$args->exclude_module_srl = $obj->exclude_module_srl ?? null;
		$args->statusList = $obj->statusList ?? null;
		$args->document_statusList = $obj->document_statusList ?? null;
		if (isset($obj->is_secret) && $obj->is_secret)
		{
			$args->s_is_secret = $obj->is_secret;
		}

		// check if module is using comment validation system
		$oCommentController = CommentController::getInstance();
		$is_using_validation = $oCommentController->isModuleUsingPublishValidation($args->s_module_srl);
		if($is_using_validation)
		{
			$args->s_is_published = 1;
		}

		// Search options
		$search_target = (isset($obj->search_target) && $obj->search_target) ? $obj->search_target : trim(Context::get('search_target') ?? '');
		$search_keyword = (isset($obj->search_keyword) && $obj->search_keyword) ? $obj->search_keyword : trim(Context::get('search_keyword') ?? '');
		if($search_target && $search_keyword)
		{
			switch($search_target)
			{
				case 'content' :
					if($search_keyword)
					{
						$search_keyword = trim(utf8_normalize_spaces($search_keyword));
					}

					$args->s_content = $search_keyword;
					break;

				case 'user_id' :
					if($search_keyword)
					{
						$search_keyword = trim($search_keyword);
					}

					$args->s_user_id = $search_keyword;
					$query_id = 'comment.getTotalCommentListWithinMember';
					break;

				case 'user_name' :
					if($search_keyword)
					{
						$search_keyword = trim($search_keyword);
					}

					$args->s_user_name = $search_keyword;
					break;

				case 'nick_name' :
					if($search_keyword)
					{
						$search_keyword = trim($search_keyword);
					}

					$args->s_nick_name = $search_keyword;
					break;

				case 'email_address' :
					if($search_keyword)
					{
						$search_keyword = str_replace(' ', '%', $search_keyword);
					}

					$args->s_email_address = $search_keyword;
					break;

				case 'homepage' :
					if($search_keyword)
					{
						$search_keyword = str_replace(' ', '%', $search_keyword);
					}

					$args->s_homepage = $search_keyword;
					break;

				case 'regdate' :
					$args->s_regdate = $search_keyword;
					break;

				case 'last_update' :
					$args->s_last_upate = $search_keyword;
					break;

				case 'ipaddress' :
					$args->s_ipaddress = $search_keyword;
					break;

				case 'is_secret' :
					$args->s_is_secret = $search_keyword;
					break;

				case 'is_published' :
					if($search_keyword == 'Y')
					{
						$args->s_is_published = 1;
					}

					if($search_keyword == 'N')
					{
						$args->s_is_published = 0;
					}

					break;

				case 'module':
					$args->s_module_srl = (int) $search_keyword;
					break;

				case 'member_srl' :
					$args->{"s_" . $search_target} = (int) $search_keyword;
					break;
			}
		}

		// Call trigger (before)
		// This trigger can be used to set an alternative output using a different search method
		unset($args->use_alternate_output);
		$output = ModuleHandler::triggerCall('comment.getTotalCommentList', 'before', $args);
		if($output instanceof BaseObject && !$output->toBool())
		{
			return $output;
		}

		// Use simple query without JOIN if there are no document-related conditions.
		if ($query_id === 'comment.getTotalCommentList')
		{
			if (!$args->s_module_srl && !$args->exclude_module_srl && !$args->document_statusList)
			{
				$query_id = 'comment.getTotalCommentListWithoutJoin';
			}
		}

		// If an alternate output is set, use it instead of running the default queries
		if (isset($args->use_alternate_output) && $args->use_alternate_output instanceof BaseObject)
		{
			$output = $args->use_alternate_output;
		}
		// Execute normal query
		else
		{
			$output = executeQueryArray($query_id, $args, $columnList);
		}

		// return when no result or error occurance
		if(!$output->toBool() || !count($output->data))
		{
			return $output;
		}

		// Fill in document-related fields if a simple query was used.
		if ($query_id === 'comment.getTotalCommentListWithoutJoin')
		{
			$document_srl_list = [];
			foreach ($output->data as $val)
			{
				$document_srl_list[$val->document_srl] = true;
			}
			if (count($document_srl_list))
			{
				$document_list = DocumentModel::getDocuments(array_keys($document_srl_list), false, false, [
					'document_srl', 'module_srl', 'member_srl', 'user_id', 'user_name', 'nick_name', 'title',
				]);
				foreach ($document_list as $val)
				{
					$document_srl_list[$val->document_srl] = $val;
				}
				foreach ($output->data as $val)
				{
					if (isset($document_srl_list[$val->document_srl]) && is_object($document_srl_list[$val->document_srl]))
					{
						$val->module_srl = $document_srl_list[$val->document_srl]->get('module_srl');
						$val->document_member_srl = $document_srl_list[$val->document_srl]->get('member_srl');
						$val->document_user_id = $document_srl_list[$val->document_srl]->get('user_id');
						$val->document_user_name = $document_srl_list[$val->document_srl]->get('user_name');
						$val->document_nick_name = $document_srl_list[$val->document_srl]->get('nick_name');
						$val->document_title = $document_srl_list[$val->document_srl]->get('title');
					}
				}
			}
		}

		foreach($output->data as $key => $val)
		{
			$_oComment = new CommentItem(0);
			$_oComment->setAttribute($val);
			$output->data[$key] = $_oComment;
		}

		// Call trigger (after)
		// This trigger can be used to modify search results
		ModuleHandler::triggerCall('comment.getTotalCommentList', 'after', $output);
		return $output;
	}

	/**
	 * Get all the comment count in time decending order(for administrators)
	 * @param object $obj
	 * @return int
	 */
	public static function getTotalCommentCount($obj)
	{
		$query_id = 'comment.getTotalCommentCountByGroupStatus';

		// Variables
		$args = new stdClass();
		$args->s_module_srl = $obj->module_srl ?? null;
		$args->exclude_module_srl = $obj->exclude_module_srl ?? null;
		$args->statusList = $obj->statusList ?? null;
		if (isset($obj->is_secret) && $obj->is_secret)
		{
			$args->s_is_secret = $obj->is_secret;
		}

		// Search options
		$search_target = $obj->search_target ? $obj->search_target : trim(Context::get('search_target'));
		$search_keyword = $obj->search_keyword ? $obj->search_keyword : trim(Context::get('search_keyword'));

		if($search_target && $search_keyword)
		{
			switch($search_target)
			{
				case 'content' :
					if($search_keyword)
					{
						$search_keyword = trim(utf8_normalize_spaces($search_keyword));
					}

					$args->s_content = $search_keyword;
					break;

				case 'user_id' :
					if($search_keyword)
					{
						$search_keyword = trim($search_keyword);
					}

					$args->s_user_id = $search_keyword;
					$query_id = 'comment.getTotalCommentCountWithinMemberByGroupStatus';
					break;

				case 'user_name' :
					if($search_keyword)
					{
						$search_keyword = trim($search_keyword);
					}
					$args->s_user_name = $search_keyword;

					break;

				case 'nick_name' :
					if($search_keyword)
					{
						$search_keyword = trim($search_keyword);
					}

					$args->s_nick_name = $search_keyword;
					break;

				case 'email_address' :
					if($search_keyword)
					{
						$search_keyword = str_replace(' ', '%', $search_keyword);
					}

					$args->s_email_address = $search_keyword;
					break;

				case 'homepage' :
					if($search_keyword)
					{
						$search_keyword = str_replace(' ', '%', $search_keyword);
					}

					$args->s_homepage = $search_keyword;
					break;

				case 'regdate' :
					$args->s_regdate = $search_keyword;
					break;

				case 'last_update' :
					$args->s_last_upate = $search_keyword;
					break;

				case 'ipaddress' :
					$args->s_ipaddress = $search_keyword;
					break;

				case 'is_secret' :
					$args->s_is_secret = $search_keyword;
					break;

				case 'member_srl' :
					$args->{"s_" . $search_target} = (int) $search_keyword;
					break;
			}
		}

		$output = executeQueryArray($query_id, $args);

		// return when no result or error occurance
		if(!$output->toBool() || !count($output->data))
		{
			return $output;
		}

		return $output->data;
	}

	/**
	 * Return a configuration of comments for each module
	 * @param int $module_srl
	 * @return object
	 */
	public static function getCommentConfig($module_srl)
	{
		$comment_config = ModuleModel::getModulePartConfig('comment', $module_srl);
		if(!is_object($comment_config))
		{
			$comment_config = new stdClass();
		}

		if(!isset($comment_config->comment_count) || !$comment_config->comment_count)
		{
			$comment_config->comment_count = 50;
		}
		if(!isset($comment_config->comment_page_count) || !$comment_config->comment_page_count)
		{
			$comment_config->comment_page_count = 10;
		}

		return $comment_config;
	}

	/**
	 * Return a list of voting member
	 * @return void
	 */
	public function getCommentVotedMemberList()
	{
		$comment_srl = Context::get('comment_srl');
		if(!$comment_srl)
		{
			throw new Rhymix\Framework\Exceptions\InvalidRequest;
		}

		$point = Context::get('point');
		if($point != -1)
		{
			$point = 1;
		}

		$oComment = self::getComment($comment_srl);
		$module_srl = $oComment->get('module_srl');
		if(!$module_srl)
		{
			throw new Rhymix\Framework\Exceptions\InvalidRequest;
		}

		$comment_config = ModuleModel::getModulePartConfig('comment', $module_srl);

		$args = new stdClass();

		if($point == -1)
		{
			if($comment_config->use_vote_down != 'S')
			{
				throw new Rhymix\Framework\Exceptions\FeatureDisabled;
			}

			$args->below_point = 0;
		}
		else
		{
			if($comment_config->use_vote_up != 'S')
			{
				throw new Rhymix\Framework\Exceptions\FeatureDisabled;
			}

			$args->more_point = 0;
		}

		$args->comment_srl = $comment_srl;
		$output = executeQueryArray('comment.getVotedMemberList', $args);
		if(!$output->toBool())
		{
			return $output;
		}

		if($output->data)
		{
			foreach($output->data as $k => $d)
			{
				$profile_image = MemberModel::getProfileImage($d->member_srl);
				$output->data[$k]->src = $profile_image->src;
			}
		}

		$this->add('voted_member_list', $output->data);
	}

	/**
	 * Return a secret status by secret field
	 * @return array
	 */
	public static function getSecretNameList()
	{
		global $lang;

		if(!isset($lang->secret_name_list))
		{
			return array('Y' => 'Secret', 'N' => 'Public');
		}
		else
		{
			return $lang->secret_name_list;
		}
	}

	/**
	 * Get the total number of comments in corresponding with member_srl.
	 * @param int $member_srl
	 * @param array $statusList
	 * @return int
	 */
	public static function getCommentCountByMemberSrl($member_srl, $statusList = [])
	{
		$args = new stdClass();
		$args->member_srl = $member_srl;
		if ($statusList)
		{
			$args->statusList = $statusList;
		}
		$output = executeQuery('comment.getCommentCountByMemberSrl', $args);
		return (int) $output->data->count;
	}

	/**
	 * Get the total number of comments posted on the given document by the given member.
	 *
	 * @param int $document_srl
	 * @param int $member_srl
	 * @param array $statusList
	 * @return int
	 */
	public static function getCommentCountByDocumentSrlAndMemberSrl($document_srl, $member_srl, $statusList = [])
	{
		$args = new stdClass();
		$args->document_srl = $document_srl;
		$args->member_srl = $member_srl;
		if ($statusList)
		{
			$args->statusList = $statusList;
		}
		$output = executeQuery('comment.getCommentCountByMemberSrl', $args);
		return (int) $output->data->count;
	}

	/**
	 * Get the list of comments posted by the given member.
	 *
	 * @param int $member_srl
	 * @param array $columnList
	 * @param int $unused1 (Previously $page)
	 * @param int $unused2 (Previously $is_admin)
	 * @param int $list_count
	 * @param array $statusList
	 * @return array
	 */
	public static function getCommentListByMemberSrl($member_srl, $columnList = [], $unused1 = 0, $unused2 = 0, $list_count = 0, $statusList = [])
	{
		$args = new stdClass();
		$args->member_srl = $member_srl;
		$args->list_count = $list_count;
		if ($statusList)
		{
			$args->statusList = $statusList;
		}
		$output = executeQueryArray('comment.getCommentListByMemberSrl', $args, $columnList);
		return $output->data ?? [];
	}

	/**
	 * Get the list of comments posted on the given document by the given member.
	 *
	 * @param int $document_srl
	 * @param int $member_srl
	 * @param int $list_count
	 * @param array $columnList
	 * @param array $statusList
	 * @return array
	 */
	public static function getCommentListByDocumentSrlAndMemberSrl($document_srl, $member_srl, $list_count = 0, $columnList = [], $statusList = [])
	{
		$args = new stdClass();
		$args->document_srl = $document_srl;
		$args->member_srl = $member_srl;
		$args->list_count = $list_count;
		if ($statusList)
		{
			$args->statusList = $statusList;
		}
		$output = executeQueryArray('comment.getCommentListByMemberSrl', $args, $columnList);
		return $output->data ?? [];
	}
}
/* End of file comment.model.php */
/* Location: ./modules/comment/comment.model.php */