elkarte / Elkarte

sources/ElkArte/Controller/Karma.php

<?php

/**
 * Deals with the giving and taking of a users karma
 *
 * @package   ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
 *
 * This file contains code covered by:
 * copyright: 2011 Simple Machines (http://www.simplemachines.org)
 *
 * @version 2.0 dev
 *
 */

namespace ElkArte\Controller;

use ElkArte\AbstractController;
use ElkArte\Exceptions\Exception;
use ElkArte\Hooks;

/**
 * Can give good or bad karma so watch out!
 *
 * @package Karma
 */
class Karma extends AbstractController
{
	/**
	 * Pre Dispatch, called before other methods.  Loads integration hooks.
	 */
	public function pre_dispatch()
	{
		Hooks::instance()->loadIntegrationsSettings();
	}

	/**
	 * Default entry point, in case action methods are not directly
	 * called. Simply forward to applaud.
	 *
	 * @see \ElkArte\AbstractController::action_index()
	 */
	public function action_index()
	{
		// Applauds for us :P
		$this->action_applaud();
	}

	/**
	 * Modify a user's karma.
	 *
	 * What it does:
	 *
	 * - It redirects back to the referrer afterward, whether by javascript or the passed parameters.
	 * - Requires the karma_edit permission, and that the user isn't a guest.
	 * - It depends on the karmaMode, karmaWaitTime, and karmaTimeRestrictAdmins settings.
	 * - It is accessed via ?action=karma, sa=smite or sa=applaud.
	 */
	public function action_applaud(): void
	{
		$id_target = $this->_req->getQuery('uid', 'intval', 0);

		// Start off with no change in karma.
		$action = $this->_prepare_karma($id_target);

		// Applaud (if you can) and return
		$this->_give_karma($this->user->id, $id_target, $action, 1);

The property id does not exist on ElkArte\Helper\ValuesContainer. Since you implemented __get, consider adding a @property annotation.

		$this->_redirect_karma();
	}

	/**
	 * Makes sure that a user can perform the karma action
	 *
	 * @param int $id_target
	 *
	 * @return int
	 * @throws Exception feature_disabled
	 */
	private function _prepare_karma($id_target): int
	{
		global $modSettings;

		// If the mod is disabled, show an error.
		if (empty($modSettings['karmaMode']))
		{
			throw new Exception('feature_disabled', true);
		}

		// If you're a guest or can't do this, blow you off...
		is_not_guest();
		isAllowedTo('karma_edit');

		checkSession('get');

		// We hold karma here.
		require_once(SUBSDIR . '/Karma.subs.php');

		// If you don't have enough posts, tough luck.
		// @todo Should this be dropped in favor of post group permissions?
		// Should this apply to the member you are smiting/applauding?
		if ($this->user->is_admin === false && $this->user->posts < $modSettings['karmaMinPosts'])
		{
			throw new Exception('not_enough_posts_karma', true, [$modSettings['karmaMinPosts']]);
		}

		// And you can't modify your own, punk! (use the profile if you need to.)
		if (empty($id_target) || $id_target == $this->user->id)
		{
			throw new Exception('cant_change_own_karma', false);
		}

		// Delete any older items from the log so we can get the go ahead or not
		clearKarma($modSettings['karmaWaitTime']);
  if (!empty($modSettings['karmaTimeRestrictAdmins']) || !allowedTo('moderate_forum')) {
      return lastActionOn($this->user->id, $id_target);
  }

		return 0;
	}

	/**
	 * Function to move the karma needle up or down for a given user
	 *
	 * @param int $id_executor who is performing the action
	 * @param int $id_target who is getting the action
	 * @param int $action applaud or smite
	 * @param int $dir
	 *
	 * @throws Exception karma_wait_time
	 */
	private function _give_karma($id_executor, $id_target, $action, $dir): void
	{
		global $modSettings, $txt;

		// They haven't, not before now, anyhow.
		if (empty($action) || empty($modSettings['karmaWaitTime']))
		{
			addKarma($id_executor, $id_target, $dir);
		}
		else
		{
			// If you are gonna try to repeat.... don't allow it.
			if ($action === $dir)
			{
				throw new Exception('karma_wait_time', false, [$modSettings['karmaWaitTime'], ($modSettings['karmaWaitTime'] == 1 ? strtolower($txt['hour']) : $txt['hours'])]);
			}

			updateKarma($id_executor, $id_target, $dir);
		}
	}

	/**
	 * Done with the action, return to where we need to be, or make it up if we
	 * can't figure it out.
	 */
	private function _redirect_karma(): void
	{
		global $context, $topic;

		// Figure out where to go back to.... the topic?
		if (!empty($topic))
		{
			redirectexit('topic=' . $topic . '.' . $this->_req->start . '#msg' . $this->_req->get('m', 'intval'));

The property start does not exist on ElkArte\Helper\HttpReq. Since you implemented __get, consider adding a @property annotation.

		}
		// Hrm... maybe a personal message?
		elseif (isset($_REQUEST['f']))
		{
			redirectexit('action=pm;f=' . $_REQUEST['f'] . ';start=' . $this->_req->start . (isset($_REQUEST['l']) ? ';l=' . $this->_req->get('l', 'intval') : '') . (isset($_REQUEST['pm']) ? '#' . $this->_req->get('pm', 'intval') : ''));
		}
		// JavaScript as a last resort.
		else
		{
			echo '<!DOCTYPE html>
<html ', $context['right_to_left'] ? 'dir="rtl"' : '', '>
	<head>
		<title>...</title>
		<script>
			history.go(-1);
		</script>
	</head>
	<body>&laquo;</body>
</html>';

			obExit(false);
		}
	}

	/**
	 * Smite a user.
	 */
	public function action_smite(): void
	{
		global $modSettings;

		// Sometimes the community needs to chill
		if (!empty($modSettings['karmaDisableSmite']))
		{
			$this->_redirect_karma();
		}

		// The user ID _must_ be a number, no matter what.
		$id_target = $this->_req->getQuery('uid', 'intval', 0);

		// Start off with no change in karma.
		$action = $this->_prepare_karma($id_target);

		// Give em a wack and run away
		$this->_give_karma($this->user->id, $this->_req->query->uid, $action, -1);

The property id does not exist on ElkArte\Helper\ValuesContainer. Since you implemented __get, consider adding a @property annotation.

		$this->_redirect_karma();
	}
}