From 7030578bbe9e11c18b5becaf8b06e670e3c2e3cd Mon Sep 17 00:00:00 2001
From: Nils Adermann <naderman@naderman.de>
Date: Sun, 14 Jul 2013 01:32:34 -0400
Subject: [ticket/11698] Moving all autoloadable files to phpbb/

PHPBB3-11698
---
 phpBB/phpbb/feed/base.php | 261 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 261 insertions(+)
 create mode 100644 phpBB/phpbb/feed/base.php

(limited to 'phpBB/phpbb/feed/base.php')

diff --git a/phpBB/phpbb/feed/base.php b/phpBB/phpbb/feed/base.php
new file mode 100644
index 0000000000..296d830932
--- /dev/null
+++ b/phpBB/phpbb/feed/base.php
@@ -0,0 +1,261 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Base class with some generic functions and settings.
+*
+* @package phpBB3
+*/
+abstract class phpbb_feed_base
+{
+	/**
+	* Feed helper object
+	* @var phpbb_feed_helper
+	*/
+	protected $helper;
+
+	/** @var phpbb_config */
+	protected $config;
+
+	/** @var phpbb_db_driver */
+	protected $db;
+
+	/** @var phpbb_cache_driver_interface */
+	protected $cache;
+
+	/** @var phpbb_user */
+	protected $user;
+
+	/** @var phpbb_auth */
+	protected $auth;
+
+	/** @var string */
+	protected $phpEx;
+
+	/**
+	* SQL Query to be executed to get feed items
+	*/
+	var $sql = array();
+
+	/**
+	* Keys specified for retrieval of title, content, etc.
+	*/
+	var $keys = array();
+
+	/**
+	* Number of items to fetch. Usually overwritten by $config['feed_something']
+	*/
+	var $num_items = 15;
+
+	/**
+	* Separator for title elements to separate items (for example forum / topic)
+	*/
+	var $separator = "\xE2\x80\xA2"; // &bull;
+
+	/**
+	* Separator for the statistics row (Posted by, post date, replies, etc.)
+	*/
+	var $separator_stats = "\xE2\x80\x94"; // &mdash;
+
+	/**
+	* Constructor
+	*
+	* @param phpbb_feed_helper $helper Feed helper
+	* @param phpbb_config		$config		Config object
+	* @param phpbb_db_driver	$db			Database connection
+	* @param phpbb_cache_driver_interface	$cache			Cache object
+	* @param phpbb_user			$user		User object
+	* @param phpbb_auth			$auth		Auth object
+	* @param phpbb_content_visibility	$content_visibility		Auth object
+	* @param string				$phpEx		php file extension
+	* @return	null
+	*/
+	function __construct(phpbb_feed_helper $helper, phpbb_config $config, phpbb_db_driver $db, phpbb_cache_driver_interface $cache, phpbb_user $user, phpbb_auth $auth, phpbb_content_visibility $content_visibility, $phpEx)
+	{
+		$this->config = $config;
+		$this->helper = $helper;
+		$this->db = $db;
+		$this->cache = $cache;
+		$this->user = $user;
+		$this->auth = $auth;
+		$this->content_visibility = $content_visibility;
+		$this->phpEx = $phpEx;
+
+		$this->set_keys();
+
+		// Allow num_items to be string
+		if (is_string($this->num_items))
+		{
+			$this->num_items = (int) $this->config[$this->num_items];
+
+			// A precaution
+			if (!$this->num_items)
+			{
+				$this->num_items = 10;
+			}
+		}
+	}
+
+	/**
+	* Set keys.
+	*/
+	function set_keys()
+	{
+	}
+
+	/**
+	* Open feed
+	*/
+	function open()
+	{
+	}
+
+	/**
+	* Close feed
+	*/
+	function close()
+	{
+		if (!empty($this->result))
+		{
+			$this->db->sql_freeresult($this->result);
+		}
+	}
+
+	/**
+	* Set key
+	*/
+	function set($key, $value)
+	{
+		$this->keys[$key] = $value;
+	}
+
+	/**
+	* Get key
+	*/
+	function get($key)
+	{
+		return (isset($this->keys[$key])) ? $this->keys[$key] : NULL;
+	}
+
+	function get_readable_forums()
+	{
+		static $forum_ids;
+
+		if (!isset($forum_ids))
+		{
+			$forum_ids = array_keys($this->auth->acl_getf('f_read', true));
+		}
+
+		return $forum_ids;
+	}
+
+	function get_moderator_approve_forums()
+	{
+		static $forum_ids;
+
+		if (!isset($forum_ids))
+		{
+			$forum_ids = array_keys($this->auth->acl_getf('m_approve', true));
+		}
+
+		return $forum_ids;
+	}
+
+	function is_moderator_approve_forum($forum_id)
+	{
+		static $forum_ids;
+
+		if (!isset($forum_ids))
+		{
+			$forum_ids = array_flip($this->get_moderator_approve_forums());
+		}
+
+		return (isset($forum_ids[$forum_id])) ? true : false;
+	}
+
+	function get_excluded_forums()
+	{
+		static $forum_ids;
+
+		// Matches acp/acp_board.php
+		$cache_name	= 'feed_excluded_forum_ids';
+
+		if (!isset($forum_ids) && ($forum_ids = $this->cache->get('_' . $cache_name)) === false)
+		{
+			$sql = 'SELECT forum_id
+				FROM ' . FORUMS_TABLE . '
+				WHERE ' . $this->db->sql_bit_and('forum_options', FORUM_OPTION_FEED_EXCLUDE, '<> 0');
+			$result = $this->db->sql_query($sql);
+
+			$forum_ids = array();
+			while ($forum_id = (int) $this->db->sql_fetchfield('forum_id'))
+			{
+				$forum_ids[$forum_id] = $forum_id;
+			}
+			$this->db->sql_freeresult($result);
+
+			$this->cache->put('_' . $cache_name, $forum_ids);
+		}
+
+		return $forum_ids;
+	}
+
+	function is_excluded_forum($forum_id)
+	{
+		$forum_ids = $this->get_excluded_forums();
+
+		return isset($forum_ids[$forum_id]) ? true : false;
+	}
+
+	function get_passworded_forums()
+	{
+		return $this->user->get_passworded_forums();
+	}
+
+	function get_item()
+	{
+		static $result;
+
+		if (!isset($result))
+		{
+			if (!$this->get_sql())
+			{
+				return false;
+			}
+
+			// Query database
+			$sql = $this->db->sql_build_query('SELECT', $this->sql);
+			$result = $this->db->sql_query_limit($sql, $this->num_items);
+		}
+
+		return $this->db->sql_fetchrow($result);
+	}
+
+	function user_viewprofile($row)
+	{
+		$author_id = (int) $row[$this->get('author_id')];
+
+		if ($author_id == ANONYMOUS)
+		{
+			// Since we cannot link to a profile, we just return GUEST
+			// instead of $row['username']
+			return $this->user->lang['GUEST'];
+		}
+
+		return '<a href="' . $this->helper->append_sid('memberlist.' . $this->phpEx, 'mode=viewprofile&amp;u=' . $author_id) . '">' . $row[$this->get('creator')] . '</a>';
+	}
+}
-- 
cgit v1.2.1