Subs-BoardIndex.php 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. <?php
  2. /**
  3. * This file currently only contains one function to collect the data needed to
  4. * show a list of boards for the board index and the message index.
  5. *
  6. * Simple Machines Forum (SMF)
  7. *
  8. * @package SMF
  9. * @author Simple Machines http://www.simplemachines.org
  10. * @copyright 2011 Simple Machines
  11. * @license http://www.simplemachines.org/about/smf/license.php BSD
  12. *
  13. * @version 2.1 Alpha 1
  14. */
  15. if (!defined('SMF'))
  16. die('Hacking attempt...');
  17. /**
  18. * Fetches a list of boards and (optional) categories including
  19. * statistical information, child boards and moderators.
  20. * - Used by both the board index (main data) and the message index (child
  21. * boards).
  22. * - Depending on the include_categories setting returns an associative
  23. * array with categories->boards->child_boards or an associative array
  24. * with boards->child_boards.
  25. * @param array $boardIndexOptions
  26. * @return array
  27. */
  28. function getBoardIndex($boardIndexOptions)
  29. {
  30. global $smcFunc, $scripturl, $user_info, $modSettings, $txt;
  31. global $settings, $context;
  32. // For performance, track the latest post while going through the boards.
  33. if (!empty($boardIndexOptions['set_latest_post']))
  34. $latest_post = array(
  35. 'timestamp' => 0,
  36. 'ref' => 0,
  37. );
  38. // Find all boards and categories, as well as related information. This will be sorted by the natural order of boards and categories, which we control.
  39. $result_boards = $smcFunc['db_query']('boardindex_fetch_boards', '
  40. SELECT' . ($boardIndexOptions['include_categories'] ? '
  41. c.id_cat, c.name AS cat_name,' : '') . '
  42. b.id_board, b.name AS board_name, b.description,
  43. CASE WHEN b.redirect != {string:blank_string} THEN 1 ELSE 0 END AS is_redirect,
  44. b.num_posts, b.num_topics, b.unapproved_posts, b.unapproved_topics, b.id_parent,
  45. IFNULL(m.poster_time, 0) AS poster_time, IFNULL(mem.member_name, m.poster_name) AS poster_name,
  46. m.subject, m.id_topic, IFNULL(mem.real_name, m.poster_name) AS real_name,
  47. ' . ($user_info['is_guest'] ? ' 1 AS is_read, 0 AS new_from,' : '
  48. (IFNULL(lb.id_msg, 0) >= b.id_msg_updated) AS is_read, IFNULL(lb.id_msg, -1) + 1 AS new_from,' . ($boardIndexOptions['include_categories'] ? '
  49. c.can_collapse, IFNULL(cc.id_member, 0) AS is_collapsed,' : '')) . '
  50. IFNULL(mem.id_member, 0) AS id_member, m.id_msg,
  51. IFNULL(mods_mem.id_member, 0) AS id_moderator, mods_mem.real_name AS mod_real_name
  52. FROM {db_prefix}boards AS b' . ($boardIndexOptions['include_categories'] ? '
  53. LEFT JOIN {db_prefix}categories AS c ON (c.id_cat = b.id_cat)' : '') . '
  54. LEFT JOIN {db_prefix}messages AS m ON (m.id_msg = b.id_last_msg)
  55. LEFT JOIN {db_prefix}members AS mem ON (mem.id_member = m.id_member)' . ($user_info['is_guest'] ? '' : '
  56. LEFT JOIN {db_prefix}log_boards AS lb ON (lb.id_board = b.id_board AND lb.id_member = {int:current_member})' . ($boardIndexOptions['include_categories'] ? '
  57. LEFT JOIN {db_prefix}collapsed_categories AS cc ON (cc.id_cat = c.id_cat AND cc.id_member = {int:current_member})' : '')) . '
  58. LEFT JOIN {db_prefix}moderators AS mods ON (mods.id_board = b.id_board)
  59. LEFT JOIN {db_prefix}members AS mods_mem ON (mods_mem.id_member = mods.id_member)
  60. WHERE {query_see_board}' . (empty($boardIndexOptions['countChildPosts']) ? (empty($boardIndexOptions['base_level']) ? '' : '
  61. AND b.child_level >= {int:child_level}') : '
  62. AND b.child_level BETWEEN ' . $boardIndexOptions['base_level'] . ' AND ' . ($boardIndexOptions['base_level'] + 1)),
  63. array(
  64. 'current_member' => $user_info['id'],
  65. 'child_level' => $boardIndexOptions['base_level'],
  66. 'blank_string' => '',
  67. )
  68. );
  69. // Start with an empty array.
  70. if ($boardIndexOptions['include_categories'])
  71. $categories = array();
  72. else
  73. $this_category = array();
  74. // Run through the categories and boards (or only boards)....
  75. while ($row_board = $smcFunc['db_fetch_assoc']($result_boards))
  76. {
  77. // Perhaps we are ignoring this board?
  78. $ignoreThisBoard = in_array($row_board['id_board'], $user_info['ignoreboards']);
  79. $row_board['is_read'] = !empty($row_board['is_read']) || $ignoreThisBoard ? '1' : '0';
  80. if ($boardIndexOptions['include_categories'])
  81. {
  82. // Haven't set this category yet.
  83. if (empty($categories[$row_board['id_cat']]))
  84. {
  85. $categories[$row_board['id_cat']] = array(
  86. 'id' => $row_board['id_cat'],
  87. 'name' => $row_board['cat_name'],
  88. 'is_collapsed' => isset($row_board['can_collapse']) && $row_board['can_collapse'] == 1 && $row_board['is_collapsed'] > 0,
  89. 'can_collapse' => isset($row_board['can_collapse']) && $row_board['can_collapse'] == 1,
  90. 'collapse_href' => isset($row_board['can_collapse']) ? $scripturl . '?action=collapse;c=' . $row_board['id_cat'] . ';sa=' . ($row_board['is_collapsed'] > 0 ? 'expand;' : 'collapse;') . $context['session_var'] . '=' . $context['session_id'] . '#c' . $row_board['id_cat'] : '',
  91. 'collapse_image' => isset($row_board['can_collapse']) ? '<img src="' . $settings['images_url'] . '/' . $context['theme_variant_url'] . ($row_board['is_collapsed'] > 0 ? 'expand.gif" alt="+"' : 'collapse.gif" alt="-"') . ' />' : '',
  92. 'href' => $scripturl . '#c' . $row_board['id_cat'],
  93. 'boards' => array(),
  94. 'new' => false
  95. );
  96. $categories[$row_board['id_cat']]['link'] = '<a id="c' . $row_board['id_cat'] . '"></a>' . ($categories[$row_board['id_cat']]['can_collapse'] ? '<a href="' . $categories[$row_board['id_cat']]['collapse_href'] . '">' . $row_board['cat_name'] . '</a>' : $row_board['cat_name']);
  97. }
  98. // If this board has new posts in it (and isn't the recycle bin!) then the category is new.
  99. if (empty($modSettings['recycle_enable']) || $modSettings['recycle_board'] != $row_board['id_board'])
  100. $categories[$row_board['id_cat']]['new'] |= empty($row_board['is_read']) && $row_board['poster_name'] != '';
  101. // Avoid showing category unread link where it only has redirection boards.
  102. $categories[$row_board['id_cat']]['show_unread'] = !empty($categories[$row_board['id_cat']]['show_unread']) ? 1 : !$row_board['is_redirect'];
  103. // Collapsed category - don't do any of this.
  104. if ($categories[$row_board['id_cat']]['is_collapsed'])
  105. continue;
  106. // Let's save some typing. Climbing the array might be slower, anyhow.
  107. $this_category = &$categories[$row_board['id_cat']]['boards'];
  108. }
  109. // This is a parent board.
  110. if ($row_board['id_parent'] == $boardIndexOptions['parent_id'])
  111. {
  112. // Is this a new board, or just another moderator?
  113. if (!isset($this_category[$row_board['id_board']]))
  114. {
  115. // Not a child.
  116. $isChild = false;
  117. $this_category[$row_board['id_board']] = array(
  118. 'new' => empty($row_board['is_read']),
  119. 'id' => $row_board['id_board'],
  120. 'name' => $row_board['board_name'],
  121. 'description' => $row_board['description'],
  122. 'moderators' => array(),
  123. 'link_moderators' => array(),
  124. 'children' => array(),
  125. 'link_children' => array(),
  126. 'children_new' => false,
  127. 'topics' => $row_board['num_topics'],
  128. 'posts' => $row_board['num_posts'],
  129. 'is_redirect' => $row_board['is_redirect'],
  130. 'unapproved_topics' => $row_board['unapproved_topics'],
  131. 'unapproved_posts' => $row_board['unapproved_posts'] - $row_board['unapproved_topics'],
  132. 'can_approve_posts' => !empty($user_info['mod_cache']['ap']) && ($user_info['mod_cache']['ap'] == array(0) || in_array($row_board['id_board'], $user_info['mod_cache']['ap'])),
  133. 'href' => $scripturl . '?board=' . $row_board['id_board'] . '.0',
  134. 'link' => '<a href="' . $scripturl . '?board=' . $row_board['id_board'] . '.0">' . $row_board['board_name'] . '</a>'
  135. );
  136. }
  137. if (!empty($row_board['id_moderator']))
  138. {
  139. $this_category[$row_board['id_board']]['moderators'][$row_board['id_moderator']] = array(
  140. 'id' => $row_board['id_moderator'],
  141. 'name' => $row_board['mod_real_name'],
  142. 'href' => $scripturl . '?action=profile;u=' . $row_board['id_moderator'],
  143. 'link' => '<a href="' . $scripturl . '?action=profile;u=' . $row_board['id_moderator'] . '" title="' . $txt['board_moderator'] . '">' . $row_board['mod_real_name'] . '</a>'
  144. );
  145. $this_category[$row_board['id_board']]['link_moderators'][] = '<a href="' . $scripturl . '?action=profile;u=' . $row_board['id_moderator'] . '" title="' . $txt['board_moderator'] . '">' . $row_board['mod_real_name'] . '</a>';
  146. }
  147. }
  148. // Found a child board.... make sure we've found its parent and the child hasn't been set already.
  149. elseif (isset($this_category[$row_board['id_parent']]['children']) && !isset($this_category[$row_board['id_parent']]['children'][$row_board['id_board']]))
  150. {
  151. // A valid child!
  152. $isChild = true;
  153. $this_category[$row_board['id_parent']]['children'][$row_board['id_board']] = array(
  154. 'id' => $row_board['id_board'],
  155. 'name' => $row_board['board_name'],
  156. 'description' => $row_board['description'],
  157. 'new' => empty($row_board['is_read']) && $row_board['poster_name'] != '',
  158. 'topics' => $row_board['num_topics'],
  159. 'posts' => $row_board['num_posts'],
  160. 'is_redirect' => $row_board['is_redirect'],
  161. 'unapproved_topics' => $row_board['unapproved_topics'],
  162. 'unapproved_posts' => $row_board['unapproved_posts'] - $row_board['unapproved_topics'],
  163. 'can_approve_posts' => !empty($user_info['mod_cache']['ap']) && ($user_info['mod_cache']['ap'] == array(0) || in_array($row_board['id_board'], $user_info['mod_cache']['ap'])),
  164. 'href' => $scripturl . '?board=' . $row_board['id_board'] . '.0',
  165. 'link' => '<a href="' . $scripturl . '?board=' . $row_board['id_board'] . '.0">' . $row_board['board_name'] . '</a>'
  166. );
  167. // Counting child board posts is... slow :/.
  168. if (!empty($boardIndexOptions['countChildPosts']) && !$row_board['is_redirect'])
  169. {
  170. $this_category[$row_board['id_parent']]['posts'] += $row_board['num_posts'];
  171. $this_category[$row_board['id_parent']]['topics'] += $row_board['num_topics'];
  172. }
  173. // Does this board contain new boards?
  174. $this_category[$row_board['id_parent']]['children_new'] |= empty($row_board['is_read']);
  175. // This is easier to use in many cases for the theme....
  176. $this_category[$row_board['id_parent']]['link_children'][] = &$this_category[$row_board['id_parent']]['children'][$row_board['id_board']]['link'];
  177. }
  178. // Child of a child... just add it on...
  179. elseif (!empty($boardIndexOptions['countChildPosts']))
  180. {
  181. if (!isset($parent_map))
  182. $parent_map = array();
  183. if (!isset($parent_map[$row_board['id_parent']]))
  184. foreach ($this_category as $id => $board)
  185. {
  186. if (!isset($board['children'][$row_board['id_parent']]))
  187. continue;
  188. $parent_map[$row_board['id_parent']] = array(&$this_category[$id], &$this_category[$id]['children'][$row_board['id_parent']]);
  189. $parent_map[$row_board['id_board']] = array(&$this_category[$id], &$this_category[$id]['children'][$row_board['id_parent']]);
  190. break;
  191. }
  192. if (isset($parent_map[$row_board['id_parent']]) && !$row_board['is_redirect'])
  193. {
  194. $parent_map[$row_board['id_parent']][0]['posts'] += $row_board['num_posts'];
  195. $parent_map[$row_board['id_parent']][0]['topics'] += $row_board['num_topics'];
  196. $parent_map[$row_board['id_parent']][1]['posts'] += $row_board['num_posts'];
  197. $parent_map[$row_board['id_parent']][1]['topics'] += $row_board['num_topics'];
  198. continue;
  199. }
  200. continue;
  201. }
  202. // Found a child of a child - skip.
  203. else
  204. continue;
  205. // Prepare the subject, and make sure it's not too long.
  206. censorText($row_board['subject']);
  207. $row_board['short_subject'] = shorten_subject($row_board['subject'], 24);
  208. $this_last_post = array(
  209. 'id' => $row_board['id_msg'],
  210. 'time' => $row_board['poster_time'] > 0 ? timeformat($row_board['poster_time']) : $txt['not_applicable'],
  211. 'timestamp' => forum_time(true, $row_board['poster_time']),
  212. 'subject' => $row_board['short_subject'],
  213. 'member' => array(
  214. 'id' => $row_board['id_member'],
  215. 'username' => $row_board['poster_name'] != '' ? $row_board['poster_name'] : $txt['not_applicable'],
  216. 'name' => $row_board['real_name'],
  217. 'href' => $row_board['poster_name'] != '' && !empty($row_board['id_member']) ? $scripturl . '?action=profile;u=' . $row_board['id_member'] : '',
  218. 'link' => $row_board['poster_name'] != '' ? (!empty($row_board['id_member']) ? '<a href="' . $scripturl . '?action=profile;u=' . $row_board['id_member'] . '">' . $row_board['real_name'] . '</a>' : $row_board['real_name']) : $txt['not_applicable'],
  219. ),
  220. 'start' => 'msg' . $row_board['new_from'],
  221. 'topic' => $row_board['id_topic']
  222. );
  223. // Provide the href and link.
  224. if ($row_board['subject'] != '')
  225. {
  226. $this_last_post['href'] = $scripturl . '?topic=' . $row_board['id_topic'] . '.msg' . ($user_info['is_guest'] ? $row_board['id_msg'] : $row_board['new_from']) . (empty($row_board['is_read']) ? ';boardseen' : '') . '#new';
  227. $this_last_post['link'] = '<a href="' . $this_last_post['href'] . '" title="' . $row_board['subject'] . '">' . $row_board['short_subject'] . '</a>';
  228. }
  229. else
  230. {
  231. $this_last_post['href'] = '';
  232. $this_last_post['link'] = $txt['not_applicable'];
  233. }
  234. // Set the last post in the parent board.
  235. if ($row_board['id_parent'] == $boardIndexOptions['parent_id'] || ($isChild && !empty($row_board['poster_time']) && $this_category[$row_board['id_parent']]['last_post']['timestamp'] < forum_time(true, $row_board['poster_time'])))
  236. $this_category[$isChild ? $row_board['id_parent'] : $row_board['id_board']]['last_post'] = $this_last_post;
  237. // Just in the child...?
  238. if ($isChild)
  239. {
  240. $this_category[$row_board['id_parent']]['children'][$row_board['id_board']]['last_post'] = $this_last_post;
  241. // If there are no posts in this board, it really can't be new...
  242. $this_category[$row_board['id_parent']]['children'][$row_board['id_board']]['new'] &= $row_board['poster_name'] != '';
  243. }
  244. // No last post for this board? It's not new then, is it..?
  245. elseif ($row_board['poster_name'] == '')
  246. $this_category[$row_board['id_board']]['new'] = false;
  247. // Determine a global most recent topic.
  248. if (!empty($boardIndexOptions['set_latest_post']) && !empty($row_board['poster_time']) && $row_board['poster_time'] > $latest_post['timestamp'] && !$ignoreThisBoard)
  249. $latest_post = array(
  250. 'timestamp' => $row_board['poster_time'],
  251. 'ref' => &$this_category[$isChild ? $row_board['id_parent'] : $row_board['id_board']]['last_post'],
  252. );
  253. }
  254. $smcFunc['db_free_result']($result_boards);
  255. // By now we should know the most recent post...if we wanna know it that is.
  256. if (!empty($boardIndexOptions['set_latest_post']) && !empty($latest_post['ref']))
  257. $context['latest_post'] = $latest_post['ref'];
  258. return $boardIndexOptions['include_categories'] ? $categories : $this_category;
  259. }
  260. ?>