Files
phpbb_board3-portal_tlw/portal/fetch_posts.php
2014-08-17 22:36:45 +02:00

549 lines
15 KiB
PHP

<?php
/**
*
* @package Board3 Portal v2.1
* @copyright (c) 2014 Board3 Group ( www.board3.de )
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/
namespace board3\portal\portal;
class fetch_posts
{
/**
* phpBB auth
* @var \phpbb\auth\auth
*/
protected $auth;
/**
* phpBB cache
* @var \phpbb\cache\driver
*/
protected $cache;
/**
* phpBB config
* @var \phpbb\config\config
*/
protected $config;
/**
* phpBB db driver
* @var \phpbb\db\driver_interface
*/
protected $db;
/**
* Modules helper
* @var \board3\portal\includes\modules_helper
*/
protected $modules_helper;
/**
* phpBB user
* @var \phpbb\user
*/
protected $user;
/**
* SQL Query where constraint
* @var string
*/
protected $where_string = '';
/**
* SQL topic type constraint
* @var string
*/
protected $topic_type = '';
/**
* SQL user link constraint
* @var string
*/
protected $user_link = '';
/**
* SQL post link constraint
* @var string
*/
protected $post_link = '';
/**
* SQL topic order constraint
* @var string
*/
protected $topic_order = '';
/**
* Module ID
* @var int
*/
protected $module_id;
/**
* Forum ID to use for global topics
* @var int
*/
protected $global_id;
/**
* Type of posts to fetch
* @var string
*/
protected $type;
/**
* Constructor
* NOTE: The parameters of this method must match in order and type with
* the dependencies defined in the services.yml file for this service.
* @param \phpbb\auth\auth $auth phpBB auth object
* @param \phpbb\cache\driver $cache phpBB cache driver
* @param \phpbb\config\config $config phpBB config
* @param \phpbb\db\driver_interface $db phpBB database driver
* @param \board3\portal\includes\modules_helper $modules_helper Board3 modules helper
* @param \phpbb\user $user phpBB user object
*/
public function __construct($auth, $cache, $config, $db, $modules_helper, $user)
{
$this->auth = $auth;
$this->cache = $cache;
$this->config = $config;
$this->db = $db;
$this->modules_helper = $modules_helper;
$this->user = $user;
}
/**
* Get posts defined by type and other settings
*
* @param string $forum_from Forums from which the posts should be retrieved
* @param bool $permissions Whether permissions should be taken into account
* during retrieval
* @param int $number_of_posts Number of posts to get
* @param int $text_length Length the text should be shortened to
* @param int $time The amount of days ago the posts could have been posted
* @param string $type Type of posts to get
* @param int $start At which position the query should start
* @param bool $invert Whether the permissions should be inverted
*
* @return array An array containing the posts that were retrieved from the database
*/
public function get_posts($forum_from, $permissions, $number_of_posts, $text_length, $time, $type, $start = 0, $invert = false)
{
$posts = $update_count = array();
$post_time = ($time == 0) ? '' : 'AND t.topic_time > ' . (time() - $time * 86400);
$forum_from = (strpos($forum_from, ',') !== false) ? explode(',', $forum_from) : (($forum_from != '') ? array($forum_from) : array());
$topic_icons = array(0);
$have_icons = 0;
$this->global_id = 0;
$this->type = $type;
$this->reset_constraints();
// Get disallowed forums
$disallow_access = $this->modules_helper->get_disallowed_forums($permissions);
// Set forums that should be excluded or included
if (!$this->set_forum_constraints($forum_from, $disallow_access, $invert))
{
return array();
}
// Get SQL constraints
$this->get_type_constraints();
// Get global forum ID for announcements
if (!$this->get_global_id())
{
return array();
}
$result = $this->run_sql_query($post_time, $number_of_posts, $start);
$i = 0;
while ($row = $this->db->sql_fetchrow($result))
{
$attachments = array();
if (($this->auth->acl_get('u_download') && ($this->auth->acl_get('f_download', $row['forum_id']) || $row['forum_id'] == 0)) && $this->config['allow_attachments'] && $row['post_id'] && $row['post_attachment'])
{
// Pull attachment data
$sql2 = 'SELECT *
FROM ' . ATTACHMENTS_TABLE . '
WHERE post_msg_id = '. $row['post_id'] .'
AND in_message = 0
ORDER BY filetime DESC';
$result2 = $this->db->sql_query($sql2);
while ($row2 = $this->db->sql_fetchrow($result2))
{
$attachments[] = $row2;
}
$this->db->sql_freeresult($result2);
}
$posts[$i]['bbcode_uid'] = $row['bbcode_uid'];
$len_check = $row['post_text'];
$maxlen = $text_length;
if (($text_length != 0) && (strlen($len_check) > $text_length))
{
$message = str_replace(array("\n", "\r"), array('<br />', "\n"), $row['post_text']);
$message = get_sub_taged_string($message, $row['bbcode_uid'], $maxlen);
$posts[$i]['striped'] = true;
}
else
{
$message = str_replace("\n", '<br/> ', $row['post_text']);
}
$row['bbcode_options'] = (($row['enable_bbcode']) ? OPTION_FLAG_BBCODE : 0) + (($row['enable_smilies']) ? OPTION_FLAG_SMILIES : 0) + (($row['enable_magic_url']) ? OPTION_FLAG_LINKS : 0);
$message = generate_text_for_display($message, $row['bbcode_uid'], $row['bbcode_bitfield'], $row['bbcode_options']);
if (!empty($attachments))
{
parse_attachments($row['forum_id'], $message, $attachments, $update_count);
}
if ($this->global_id < 1)
{
$this->global_id = $row['forum_id'];
}
$topic_icons[] = $row['enable_icons'];
$have_icons = ($row['icon_id'] > 0) ? 1 : $have_icons;
$posts[$i] = array_merge($posts[$i], array(
'post_text' => ap_validate($message),
'topic_id' => $row['topic_id'],
'topic_last_post_id' => $row['topic_last_post_id'],
'topic_type' => $row['topic_type'],
'topic_posted' => (isset($row['topic_posted']) && $row['topic_posted']) ? true : false,
'icon_id' => $row['icon_id'],
'topic_status' => $row['topic_status'],
'forum_id' => $row['forum_id'],
'topic_replies' => $row['topic_posts_approved'] + $row['topic_posts_unapproved'] + $row['topic_posts_softdeleted'],
'topic_replies_real' => $row['topic_posts_approved'],
'topic_time' => $this->user->format_date($row['post_time']),
'topic_last_post_time' => $row['topic_last_post_time'],
'topic_title' => $row['topic_title'],
'username' => $row['username'],
'username_full' => get_username_string('full', $row['user_id'], $row['username'], $row['user_colour'], $row['post_username']),
'username_full_last' => get_username_string('full', $row['topic_last_poster_id'], $row['topic_last_poster_name'], $row['topic_last_poster_colour'], $row['topic_last_poster_name']),
'user_id' => $row['user_id'],
'user_type' => $row['user_type'],
'user_colour' => $row['user_colour'],
'poll' => ($row['poll_title']) ? true : false,
'attachment' => ($row['topic_attachment']) ? true : false,
'topic_views' => $row['topic_views'],
'forum_name' => $row['forum_name'],
'attachments' => (!empty($attachments)) ? $attachments : array(),
));
$posts['global_id'] = $this->global_id;
++$i;
}
$this->db->sql_freeresult($result);
$posts['topic_icons'] = ((max($topic_icons) > 0) && $have_icons) ? true : false;
$posts['topic_count'] = $i;
if ($this->global_id < 1)
{
return array();
}
else
{
return $posts;
}
}
/**
* Run SQL query for fetching posts from database
*
* @param int $post_time Post time
* @param int $number_of_posts Number of posts to fetch
* @param int $start Start of query
*
* @return int Result pointer
*/
protected function run_sql_query($post_time, $number_of_posts, $start)
{
$sql_array = array(
'SELECT' => 't.forum_id,
t.topic_id,
t.topic_last_post_id,
t.topic_last_post_time,
t.topic_time,
t.topic_title,
t.topic_attachment,
t.topic_views,
t.poll_title,
t.topic_posts_approved,
t.topic_posts_unapproved,
t.topic_posts_softdeleted,
t.topic_poster,
t.topic_type,
t.topic_status,
t.topic_last_poster_name,
t.topic_last_poster_id,
t.topic_last_poster_colour,
t.icon_id,
u.username,
u.user_id,
u.user_type,
u.user_colour,
p.post_id,
p.poster_id,
p.post_time,
p.post_text,
p.post_attachment,
p.post_username,
p.enable_smilies,
p.enable_bbcode,
p.enable_magic_url,
p.bbcode_bitfield,
p.bbcode_uid,
f.forum_name,
f.enable_icons',
'FROM' => array(
TOPICS_TABLE => 't',
),
'LEFT_JOIN' => array(
array(
'FROM' => array(USERS_TABLE => 'u'),
'ON' => $this->user_link,
),
array(
'FROM' => array(FORUMS_TABLE => 'f'),
'ON' => 't.forum_id=f.forum_id',
),
array(
'FROM' => array(POSTS_TABLE => 'p'),
'ON' => $this->post_link,
),
),
'WHERE' => $this->topic_type . '
' . $post_time . '
AND t.topic_status <> ' . ITEM_MOVED . '
AND t.topic_visibility = 1
AND t.topic_moved_id = 0
' . $this->where_string,
'ORDER_BY' => $this->topic_order,
);
$sql_array['LEFT_JOIN'][] = array('FROM' => array(TOPICS_POSTED_TABLE => 'tp'), 'ON' => 'tp.topic_id = t.topic_id AND tp.user_id = ' . $this->user->data['user_id']);
$sql_array['SELECT'] .= ', tp.topic_posted';
$sql = $this->db->sql_build_query('SELECT', $sql_array);
if ($number_of_posts != 0)
{
$result = $this->db->sql_query_limit($sql, $number_of_posts, $start);
}
else
{
$result = $this->db->sql_query($sql);
}
return $result;
}
/**
* Get type constraints for database query
*
* @return null
* @throws \InvalidArgumentexception If unknown type is used
*/
protected function get_type_constraints()
{
switch($this->type)
{
case "announcements":
$this->get_announcements_constraints();
break;
case "news":
$this->get_news_constraints();
break;
case "news_all":
$this->get_news_all_constraints();
break;
default:
// Method was called with unsupported type
throw new \InvalidArgumentexception($this->user->lang('B3P_WRONG_METHOD_CALL', __FUNCTION__));
}
}
/**
* Get type constraints for announcements
*
* @return null
*/
protected function get_announcements_constraints()
{
$this->topic_type = '((t.topic_type = ' . POST_ANNOUNCE . ') OR (t.topic_type = ' . POST_GLOBAL . '))';
$this->where_string = (strlen($this->where_string) > 0) ? 'AND (t.forum_id = 0 OR (' . trim(substr($this->where_string, 0, -4)) . '))' : '';
$this->user_link = 't.topic_poster = u.user_id';
$this->post_link = 't.topic_first_post_id = p.post_id';
$this->topic_order = 't.topic_time DESC';
}
/**
* Get type constraints for news
*
* @return null
*/
protected function get_news_constraints()
{
$this->topic_type = 't.topic_type = ' . POST_NORMAL;
$this->where_string = (strlen($this->where_string) > 0) ? 'AND (' . trim(substr($this->where_string, 0, -4)) . ')' : '';
$this->user_link = ($this->config['board3_news_style_' . $this->module_id]) ? 't.topic_poster = u.user_id' : (($this->config['board3_news_show_last_' . $this->module_id]) ? 't.topic_last_poster_id = u.user_id' : 't.topic_poster = u.user_id' ) ;
$this->post_link = ($this->config['board3_news_style_' . $this->module_id]) ? 't.topic_first_post_id = p.post_id' : (($this->config['board3_news_show_last_' . $this->module_id]) ? 't.topic_last_post_id = p.post_id' : 't.topic_first_post_id = p.post_id' ) ;
$this->topic_order = ($this->config['board3_news_show_last_' . $this->module_id]) ? 't.topic_last_post_time DESC' : 't.topic_time DESC' ;
}
/**
* Get additional type constraints for all news
* Overwrites topic type of get_news_constraints().
*
* @return null
*/
protected function get_news_all_constraints()
{
$this->get_news_constraints();
$this->topic_type = '(t.topic_type <> ' . POST_ANNOUNCE . ') AND (t.topic_type <> ' . POST_GLOBAL . ')';
}
/**
* Set module id
*
* @param int $module_id Module ID
* @return null
*/
public function set_module_id($module_id)
{
$this->module_id = $module_id;
}
/**
* Set forums to exclude or include
*
* @param array $forum_from Forums that should be shown or
* excluded from being shown
* @param array $disallowed_forums Forums that user is not
* allowed to see
* @param bool $invert Whether forum IDs in forum_from
* should be used for excluding or
* including forums
* @return bool True if valid constraints were generated, false if not
*/
protected function set_forum_constraints($forum_from, $disallowed_forums, $invert = false)
{
if ($invert == true)
{
$access_list = array_merge($disallowed_forums, $forum_from);
$sql_operator = '<>';
$sql_append = 'AND';
}
else
{
$access_list = array_diff($forum_from, $disallowed_forums);
$sql_operator = '=';
$sql_append = 'OR';
if (empty($access_list) && !empty($forum_from))
{
return false;
}
}
// Generate where string
$this->generate_where_string($access_list, $sql_operator, $sql_append);
return true;
}
/**
* Generate where string for database query
*
* @param array $access_list Array containing the forum IDs
* the user has access to
* @param string $sql_operator The sql operator to use
* @param string $sql_append The sql append type to use.
* Should be either AND or OR
* @return null
*/
protected function generate_where_string($access_list, $sql_operator, $sql_append)
{
foreach ($access_list as $acc_id)
{
$acc_id = (int) $acc_id;
$this->where_string .= 't.forum_id ' . $sql_operator . " $acc_id $sql_append ";
if ($sql_operator === '=' && $this->type == 'announcements' && $this->global_id < 1 && $acc_id > 0)
{
$this->global_id = $acc_id;
}
}
}
/**
* Gets the a global forum ID for global announcements
*
* @return bool True if proper ID was selected, false if not
*/
protected function get_global_id()
{
if ($this->type == 'announcements' && $this->global_id < 1)
{
if (!empty($this->where_string) || ($row = $this->cache->get('_forum_id_first_forum_post')) === false)
{
$row = $this->get_first_forum_id();
}
if (empty($row))
{
return false;
}
$this->global_id = $row['forum_id'];
}
return true;
}
/**
* Gets the first forum_id of FORUM_POST type forums
*
* @return array Database row of query
*/
protected function get_first_forum_id()
{
$sql = 'SELECT forum_id
FROM ' . FORUMS_TABLE . '
WHERE forum_type = ' . FORUM_POST . '
' . str_replace('t.', '', $this->where_string) . '
ORDER BY forum_id';
$result = $this->db->sql_query_limit($sql, 1);
$row = $this->db->sql_fetchrow($result);
$this->db->sql_freeresult($result);
if (empty($this->where_string))
{
// Cache first forum ID for one day = 86400 s
$this->cache->put('_forum_id_first_forum_post', $row, 86400);
}
return $row;
}
/**
* Resets constraints that might have been set before
*
* @return null
*/
protected function reset_constraints()
{
$this->where_string = '';
}
}