favorites.php

<?php
/*
	Question2Answer by Gideon Greenspan and contributors
	http://www.question2answer.org/

	File: qa-include/qa-app-favorites.php
	Description: Handles favoriting and unfavoriting (application level)


	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU General Public License
	as published by the Free Software Foundation; either version 2
	of the License, or (at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	More about this license: http://www.question2answer.org/license.php
*/

if (!defined('QA_VERSION')) { // don't allow this page to be requested directly from browser
	header('Location: ../');
	exit;
}


/**
 * Set an entity to be favorited or removed from favorites. Handles event reporting.
 *
 * @param int $userid ID of user assigned to the favorite
 * @param string $handle Username of user
 * @param string $cookieid Cookie ID of user
 * @param string $entitytype Entity type code (one of QA_ENTITY_* constants)
 * @param string $entityid ID of the entity being favorited (e.g. postid for questions)
 * @param bool $favorite Whether to add favorite (true) or remove favorite (false)
 */
function qa_user_favorite_set($userid, $handle, $cookieid, $entitytype, $entityid, $favorite)
{
	require_once QA_INCLUDE_DIR . 'db/favorites.php';
	require_once QA_INCLUDE_DIR . 'app/limits.php';
	require_once QA_INCLUDE_DIR . 'app/updates.php';

	// Make sure the user is not favoriting themselves
	if ($entitytype == QA_ENTITY_USER && $userid == $entityid) {
		return;
	}

	if ($favorite)
		qa_db_favorite_create($userid, $entitytype, $entityid);
	else
		qa_db_favorite_delete($userid, $entitytype, $entityid);

	switch ($entitytype) {
		case QA_ENTITY_QUESTION:
			$action = $favorite ? 'q_favorite' : 'q_unfavorite';
			$params = array('postid' => $entityid);
			break;

		case QA_ENTITY_USER:
			$action = $favorite ? 'u_favorite' : 'u_unfavorite';
			$params = array('userid' => $entityid);
			break;

		case QA_ENTITY_TAG:
			$action = $favorite ? 'tag_favorite' : 'tag_unfavorite';
			$params = array('wordid' => $entityid);
			break;

		case QA_ENTITY_CATEGORY:
			$action = $favorite ? 'cat_favorite' : 'cat_unfavorite';
			$params = array('categoryid' => $entityid);
			break;

		default:
			qa_fatal_error('Favorite type not recognized');
			break;
	}

	qa_report_event($action, $userid, $handle, $cookieid, $params);
}


/**
 * Returns content to set in $qa_content['q_list'] for a user's favorite $questions. Pre-generated
 * user HTML in $usershtml.
 * @param $questions
 * @param $usershtml
 * @return array
 */
function qa_favorite_q_list_view($questions, $usershtml)
{
	$q_list = array(
		'qs' => array(),
	);

	if (count($questions) === 0)
		return $q_list;

	$q_list['form'] = array(
		'tags' => 'method="post" action="' . qa_self_html() . '"',
		'hidden' => array(
			'code' => qa_get_form_security_code('vote'),
		),
	);

	$defaults = qa_post_html_defaults('Q');

	foreach ($questions as $question) {
		$q_list['qs'][] = qa_post_html_fields($question, qa_get_logged_in_userid(), qa_cookie_get(),
			$usershtml, null, qa_post_html_options($question, $defaults));
	}

	return $q_list;
}


/**
 * Returns content to set in $qa_content['ranking_users'] for a user's favorite $users. Pre-generated
 * user HTML in $usershtml.
 * @param $users
 * @param $usershtml
 * @return array|null
 */
function qa_favorite_users_view($users, $usershtml)
{
	if (QA_FINAL_EXTERNAL_USERS)
		return null;

	require_once QA_INCLUDE_DIR . 'app/users.php';
	require_once QA_INCLUDE_DIR . 'app/format.php';

	$ranking = array(
		'items' => array(),
		'rows' => ceil(count($users) / qa_opt('columns_users')),
		'type' => 'users',
	);

	foreach ($users as $user) {
		$avatarhtml = qa_get_user_avatar_html($user['flags'], $user['email'], $user['handle'],
			$user['avatarblobid'], $user['avatarwidth'], $user['avatarheight'], qa_opt('avatar_users_size'), true);

		$ranking['items'][] = array(
			'avatar' => $avatarhtml,
			'label' => $usershtml[$user['userid']],
			'score' => qa_html(qa_format_number($user['points'], 0, true)),
			'raw' => $user,
		);
	}

	return $ranking;
}


/**
 * Returns content to set in $qa_content['ranking_tags'] for a user's favorite $tags.
 * @param $tags
 * @return array
 */
function qa_favorite_tags_view($tags)
{
	require_once QA_INCLUDE_DIR . 'app/format.php';

	$ranking = array(
		'items' => array(),
		'rows' => ceil(count($tags) / qa_opt('columns_tags')),
		'type' => 'tags',
	);

	foreach ($tags as $tag) {
		$ranking['items'][] = array(
			'label' => qa_tag_html($tag['word'], false, true),
			'count' => qa_html(qa_format_number($tag['tagcount'], 0, true)),
		);
	}

	return $ranking;
}


/**
 * Returns content to set in $qa_content['nav_list_categories'] for a user's favorite $categories.
 * @param $categories
 * @return array
 */
function qa_favorite_categories_view($categories)
{
	require_once QA_INCLUDE_DIR . 'app/format.php';

	$nav_list_categories = array(
		'nav' => array(),
		'type' => 'browse-cat',
	);

	foreach ($categories as $category) {
		$cat_url = qa_path_html('questions/' . implode('/', array_reverse(explode('/', $category['backpath']))));
		$cat_anchor = $category['qcount'] == 1
			? qa_lang_html_sub('main/1_question', '1', '1')
			: qa_lang_html_sub('main/x_questions', qa_format_number($category['qcount'], 0, true));
		$cat_descr = strlen($category['content']) ? qa_html(' - ' . $category['content']) : '';

		$nav_list_categories['nav'][$category['categoryid']] = array(
			'label' => qa_html($category['title']),
			'state' => 'open',
			'favorited' => true,
			'note' => ' - <a href="' . $cat_url . '">' . $cat_anchor . '</a>' . $cat_descr,
		);
	}

	return $nav_list_categories;
}