home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 117 / PC Guia 117.iso / Software / Produtividade / Software2 / Product4 / Setup.exe / drupal-4.6.0 / modules / forum.module < prev    next >
Encoding:
Text File  |  2005-04-12  |  33.3 KB  |  983 lines
  1. <?php
  2. // $Id: forum.module,v 1.243.2.3 2005/04/12 18:56:02 dries Exp $
  3.  
  4. /**
  5.  * @file
  6.  * Enable threaded discussions about general topics.
  7.  */
  8.  
  9. /**
  10.  * Implementation of hook_help().
  11.  */
  12. function forum_help($section) {
  13.   switch ($section) {
  14.     case 'admin/forum':
  15.       return t('<p>This is a list of existing containers and forums that you can edit. Containers hold forums and, in turn, forums hold threaded discussions. Both containers and forums can be placed inside other containers and forums. By planning the structure of your containers and forums well, you make it easier for users to find a topic area of interest to them.</p>');
  16.     case 'admin/forum/add/container':
  17.       return t('<p>Containers help you organize your forums. The job of a container is to hold, or contain, other forums that are related. For example, a container named "Food" might hold two forums named "Fruit" and "Vegetables". Containers are usually placed at the top (root) level of your forum but you can also place a container within another container or forum.</p>');
  18.     case 'admin/forum/add/forum':
  19.       return t('<p>A forum holds threaded topic discussions that are related. For example, a forum named "Fruit" might contain topic discussions titled "Apples" and "Bananas". You can place a forum into a container, another forum, or at the top (root) level of your forum.</p>');
  20.     case 'admin/modules#description':
  21.       return t('Enables threaded discussions about general topics.');
  22.     case 'admin/forum/configure':
  23.       return t('This is where you can configure system-wide options for how your forums act and display.');
  24.     case 'node/add#forum':
  25.       return t('A forum is a threaded discussion, enabling users to communicate about a particular topic.');
  26.   }
  27. }
  28.  
  29. /**
  30.  * Implementation of hook_node_name().
  31.  */
  32. function forum_node_name($node) {
  33.   return t('forum topic');
  34. }
  35.  
  36. /**
  37.  * Implementation of hook_access().
  38.  */
  39. function forum_access($op, $node) {
  40.   global $user;
  41.  
  42.   if ($op == 'create') {
  43.     return user_access('create forum topics');
  44.   }
  45.  
  46.   if ($op == 'update' || $op == 'delete') {
  47.     if (user_access('edit own forum topics') && ($user->uid == $node->uid)) {
  48.       return TRUE;
  49.     }
  50.   }
  51. }
  52.  
  53. /**
  54.  * Implementation of hook_perm().
  55.  */
  56. function forum_perm() {
  57.   return array('create forum topics', 'edit own forum topics', 'administer forums');
  58. }
  59.  
  60. /**
  61.  * Administration page which allows maintaining forums
  62.  */
  63. function forum_admin() {
  64.   $op = $_POST['op'];
  65.   $edit = $_POST['edit'];
  66.  
  67.   if (empty($op)) {
  68.     $op = arg(2);
  69.   }
  70.  
  71.   switch ($op) {
  72.     case 'add':
  73.       if (arg(3) == 'forum') {
  74.         $output = forum_form_forum();
  75.       }
  76.       else if (arg(3) == 'container') {
  77.         $output = forum_form_container();
  78.       }
  79.       break;
  80.     case 'edit':
  81.       if (arg(3) == 'forum') {
  82.         $output = forum_form_forum(object2array(taxonomy_get_term(arg(4))));
  83.       }
  84.       else if (arg(3) == 'container') {
  85.          $output = forum_form_container(object2array(taxonomy_get_term(arg(4))));
  86.       }
  87.       break;
  88.     case t('Delete'):
  89.       if (!$edit['confirm']) {
  90.         $output = _forum_confirm_delete($edit['tid']);
  91.         break;
  92.       }
  93.       else {
  94.         $edit['name'] = 0;
  95.       }
  96.     case t('Submit'):
  97.       $edit = taxonomy_save_term($edit);
  98.       if (arg(3) == 'container') {
  99.         $containers = variable_get('forum_containers', array());
  100.         $containers[] = $edit['tid'];
  101.         variable_set('forum_containers', $containers);
  102.        }
  103.       drupal_goto('admin/forum');
  104.     default:
  105.       $output = forum_overview();
  106.   }
  107.  
  108.   print theme('page', $output);
  109. }
  110.  
  111. /**
  112.  * Implementation of hook_taxonomy().
  113.  */
  114. function forum_taxonomy($op, $type, $object) {
  115.   if ($op == 'delete' && $type == 'term' && $object->vid == _forum_get_vid())  {
  116.     $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $object->tid);
  117.     while ($node = db_fetch_object($results)) {
  118.       $edit['nid'] = $node->nid;
  119.       $edit['confirm'] = TRUE;
  120.       node_delete($edit);
  121.     }
  122.   }
  123. }
  124.  
  125. /**
  126.  * Returns a confirmation page for deleting a forum taxonomy term
  127.  *
  128.  * @param $tid ID of the term to be deleted
  129.  */
  130. function _forum_confirm_delete($tid) {
  131.   $term = taxonomy_get_term($tid);
  132.  
  133.   $extra = form_hidden('tid', $tid);
  134.   $output = theme('confirm',
  135.                   t('Are you sure you want to delete the forum %name?', array('%name' => '<em>'. $term->name .'</em>')),
  136.                   'admin/forums',
  137.                   t('Deleting a forum or container will delete all sub-forums as well. This action cannot be undone.'),
  138.                   t('Delete'),
  139.                   t('Cancel'),
  140.                   $extra);
  141.   return $output;
  142. }
  143.  
  144. /**
  145.  * Returns a form for adding a container to the forum vocabulary
  146.  *
  147.  * @param $edit Associative array containing a container term to be added or edited.
  148.  */
  149. function forum_form_container($edit = array()) {
  150.   $form = form_textfield(t('Container name'), 'name', $edit['name'], 50, 64, t('The container name is used on the forum listing page to identify a group of forums.'), NULL, TRUE);
  151.   $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5, t('The description can provide additional information about the forum grouping.'));
  152.  
  153.   $form .= _forum_parent_select($edit['tid'], t('Parent'), 'parent][');
  154.   $form .= form_weight(t('Weight'), 'weight', $edit['weight'], 10, t('In listings, the heavier terms (with a larger weight) will sink and the lighter terms will be positioned nearer the top.'));
  155.  
  156.   $form .= form_hidden('vid', _forum_get_vid());
  157.   $form .= form_submit(t('Submit'));
  158.   if ($edit['tid']) {
  159.     $form .= form_submit(t('Delete'));
  160.     $form .= form_hidden('tid', $edit['tid']);
  161.   }
  162.  
  163.   return form($form);
  164. }
  165.  
  166. /**
  167.  * Returns a form for adding a forum to the forum vocabulary
  168.  *
  169.  * @param $edit Associative array containing a forum term to be added or edited.
  170.  */
  171. function forum_form_forum($edit = array()) {
  172.   $form = form_textfield(t('Forum name'), 'name', $edit['name'], 50, 64, t('The name is used to identify the forum.'), NULL, TRUE);
  173.   $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5, t('The description can be used to provide more information about the forum, or further details about the topic.'));
  174.  
  175.   $form .= _forum_parent_select($edit['tid'], t('Parent'), 'parent][');
  176.   $form .= form_weight(t('Weight'), 'weight', $edit['weight'], 10, t('In listings, the heavier (with a higher weight value) terms will sink and the lighter terms will be positioned nearer the top.'));
  177.  
  178.   $form .= form_hidden('vid', _forum_get_vid());
  179.   $form .= form_submit(t('Submit'));
  180.   if ($edit['tid']) {
  181.     $form .= form_submit(t('Delete'));
  182.     $form .= form_hidden('tid', $edit['tid']);
  183.   }
  184.  
  185.   return form($form);
  186. }
  187.  
  188. /**
  189.  * Returns a select box for available parent terms
  190.  *
  191.  * @param $tid ID of the term which is being added or edited
  192.  * @param $title Title to display the select box with
  193.  * @param $name Name to use in the forum
  194.  */
  195. function _forum_parent_select($tid, $title, $name) {
  196.  
  197.   $parents = taxonomy_get_parents($tid);
  198.   if ($parents) {
  199.     $parent = array_shift($parents);
  200.     $parent = $parent->tid;
  201.   }
  202.   else {
  203.     $parent = 0;
  204.   }
  205.  
  206.   $children = taxonomy_get_tree(_forum_get_vid, $tid);
  207.  
  208.   // A term can't be the child of itself, nor of its children.
  209.   foreach ($children as $child) {
  210.     $exclude[] = $child->tid;
  211.   }
  212.   $exclude[] = $tid;
  213.  
  214.   $tree = taxonomy_get_tree(_forum_get_vid());
  215.   $options[0] = '<'. t('root') .'>';
  216.   if ($tree) {
  217.     foreach ($tree as $term) {
  218.       if (!in_array($term->tid, $exclude)) {
  219.         $options[$term->tid] = _forum_depth($term->depth).$term->name;
  220.       }
  221.     }
  222.   }
  223.  
  224.   return form_select($title, $name, $parent, $options, NULL, 0, FALSE, TRUE);
  225. }
  226.  
  227. /**
  228.  * Returns an overview list of existing forums and containers
  229.  */
  230. function forum_overview() {
  231.   $header = array(t('Name'), t('Operations'));
  232.  
  233.   $tree = taxonomy_get_tree(_forum_get_vid());
  234.   if ($tree) {
  235.     foreach ($tree as $term) {
  236.       if (in_array($term->tid, variable_get('forum_containers', array()))) {
  237.         $rows[] = array(_forum_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/forum/edit/container/$term->tid"));
  238.       }
  239.       else {
  240.         $rows[] = array(_forum_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/forum/edit/forum/$term->tid"));
  241.        }
  242.  
  243.     }
  244.   }
  245.   else {
  246.     $rows[] = array(array('data' => '<em>' . t('There are no existing containers or forums. You may add some on the <a href="%container">add container</a> or <a href="%forum">add forum</a> pages.', array('%container' => url('admin/forum/add/container'), '%forum' => url('admin/forum/add/forum'))) . '</em>', 'colspan' => 2));
  247.   }
  248.   return theme('table', $header, $rows);
  249. }
  250.  
  251. /**
  252.  * Helper function used to generate indentation for forum list
  253.  *
  254.  * @param $depth Depth of the indentation
  255.  * @param $graphic HTML text to be repeated for each stage of depth
  256.  */
  257. function _forum_depth($depth, $graphic = '--') {
  258.   for ($n = 0; $n < $depth; $n++) {
  259.     $result .= $graphic;
  260.   }
  261.   return $result;
  262. }
  263.  
  264. /**
  265.  * Returns the vocabulary id for forum navigation.
  266.  */
  267. function _forum_get_vid() {
  268.   $vid = variable_get('forum_nav_vocabulary', '');
  269.   if (empty($vid)) {
  270.     // Check to see if a forum vocabulary exists
  271.     $vid = db_result(db_query("SELECT vid FROM {vocabulary} WHERE module='%s'", 'forum'));
  272.     if (!$vid) {
  273.       $vocabulary = taxonomy_save_vocabulary(array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'nodes' => array('forum')));
  274.       $vid = $vocabulary['vid'];
  275.     }
  276.     variable_set('forum_nav_vocabulary', $vid);
  277.   }
  278.  
  279.   return $vid;
  280. }
  281.  
  282. /**
  283.  * Implementation of hook_settings
  284.  */
  285. function forum_admin_configure() {
  286.   system_settings_save();
  287.  
  288.   $output .= form_textfield(t('Forum icon path'), 'forum_icon_path', variable_get('forum_icon_path', ''), 30, 255, t('The path to the forum icons.  Leave blank to disable icons. Don\'t add a trailing slash.  Default icons are available in the "misc" directory. You may use images of whatever size you wish, but it is recommended to use 15x15 or 16x16. '));
  289.   $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000));
  290.   $output .= form_select(t('Hot topic threshold'), 'forum_hot_topic', variable_get('forum_hot_topic', 15), $number, t('The number of posts a topic must have to be considered hot.'));
  291.   $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
  292.   $output .= form_select(t('Topics per page'), 'forum_per_page', variable_get('forum_per_page', 25), $number, t('The default number of topics displayed per page; links to browse older messages are automatically being displayed.'));
  293.   $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
  294.   $output .= form_radios(t('Default order'), 'forum_order', variable_get('forum_order', '1'), $forder, t('The default display order for topics.'));
  295.  
  296.   print theme('page', system_settings_form($output));
  297. }
  298.  
  299. /**
  300.  * Implementation of hook_load().
  301.  */
  302. function forum_load($node) {
  303.   $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE nid = %d', $node->nid));
  304.  
  305.   return $forum;
  306. }
  307.  
  308. /**
  309.  * Implementation of hook_block().
  310.  *
  311.  * Generates a block containing the currently active forum topics and the
  312.  * most recently added forum topics.
  313.  */
  314. function forum_block($op = 'list', $delta = 0, $edit = array()) {
  315.   switch ($op) {
  316.     case 'list':
  317.       $blocks[0]['info'] = t('Active forum topics');
  318.       $blocks[1]['info'] = t('New forum topics');
  319.       return $blocks;
  320.  
  321.     case 'configure':
  322.       $output = form_select(t('Number of topics'), 'forum_block_num_'. $delta, variable_get('forum_block_num_'. $delta, '5'), drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
  323.       return $output;
  324.  
  325.     case 'save':
  326.       variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
  327.       break;
  328.  
  329.     case 'view':
  330.       if (user_access('access content')) {
  331.         switch ($delta) {
  332.           case 0:
  333.             $title = t('Active forum topics');
  334.             $sql = db_rewrite_sql("SELECT n.nid, n.title, l.last_comment_timestamp, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.status = 1 AND n.type='forum' ORDER BY l.last_comment_timestamp DESC");
  335.             $content = node_title_list(db_query_range($sql, 0, variable_get('forum_block_num_0', '5')));
  336.             break;
  337.  
  338.           case 1:
  339.             $title = t('New forum topics');
  340.             $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.type = 'forum' AND n.status = 1 ORDER BY n.nid DESC");
  341.             $content = node_title_list(db_query_range($sql, 0, variable_get('forum_block_num_1', '5')));
  342.             break;
  343.         }
  344.  
  345.         if ($content) {
  346.           $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
  347.         }
  348.  
  349.         $block['subject'] = $title;
  350.         $block['content'] = $content;
  351.  
  352.         return $block;
  353.       }
  354.   }
  355. }
  356.  
  357. /**
  358.  * Implementation of hook_link().
  359.  */
  360. function forum_link($type, $node = 0, $main = 0) {
  361.   global $user;
  362.  
  363.   $links = array();
  364.  
  365.   if (!$main && $type == 'node' && $node->type == 'forum') {
  366.     // get previous and next topic
  367.  
  368.     $sql = "SELECT n.nid, n.title, n.sticky, l.comment_count, l.last_comment_timestamp FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' ORDER BY n.sticky DESC, ". _forum_get_topic_order_sql(variable_get('forum_order', 1));
  369.     $sql = db_rewrite_sql($sql);
  370.     $result = db_query($sql, $node->tid);
  371.  
  372.     while ($topic = db_fetch_object($result)) {
  373.       if ($stop == 1) {
  374.         $next = new StdClass();
  375.         $next->nid = $topic->nid;
  376.         $next->title = $topic->title;
  377.         break;
  378.       }
  379.       if ($topic->nid == $node->nid) {
  380.         $stop = 1;
  381.       }
  382.       else {
  383.         $prev = new StdClass();
  384.         $prev->nid = $topic->nid;
  385.         $prev->title = $topic->title;
  386.       }
  387.     }
  388.  
  389.     if ($prev) {
  390.       $links[] = l(t('previous forum topic'), "node/$prev->nid", array('title' => check_plain($prev->title)));
  391.     }
  392.  
  393.     if ($next) {
  394.       $links[] = l(t('next forum topic'), "node/$next->nid", array('title' => check_plain($next->title)));
  395.     }
  396.   }
  397.  
  398.   return $links;
  399. }
  400.  
  401. /**
  402.  * Implementation of hook_menu().
  403.  */
  404. function forum_menu($may_cache) {
  405.   $items = array();
  406.  
  407.   if ($may_cache) {
  408.     $items[] = array('path' => 'node/add/forum', 'title' => t('forum topic'),
  409.       'access' => user_access('create forum topics'));
  410.  
  411.     $items[] = array('path' => 'forum', 'title' => t('forums'),
  412.       'callback' => 'forum_page',
  413.       'access' => user_access('access content'),
  414.       'type' => MENU_SUGGESTED_ITEM);
  415.  
  416.     $items[] = array('path' => 'admin/forum', 'title' => t('forums'),
  417.       'callback' => 'forum_admin',
  418.       'access' => user_access('administer forums'),
  419.       'type' => MENU_NORMAL_ITEM);
  420.  
  421.     $items[] = array('path' => 'admin/forum/list', 'title' => t('list'),
  422.       'access' => user_access('administer forums'),
  423.       'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
  424.     $items[] = array('path' => 'admin/forum/add/container', 'title' => t('add container'),
  425.       'access' => user_access('administer forums'),
  426.       'type' => MENU_LOCAL_TASK);
  427.     $items[] = array('path' => 'admin/forum/add/forum', 'title' => t('add forum'),
  428.       'access' => user_access('administer forums'),
  429.       'type' => MENU_LOCAL_TASK);
  430.     $items[] = array('path' => 'admin/forum/configure', 'title' => t('configure'),
  431.       'callback' => 'forum_admin_configure',
  432.       'access' => user_access('administer forums'),
  433.       'type' => MENU_LOCAL_TASK);
  434.  
  435.     $items[] = array('path' => 'admin/forum/edit/container', 'title' => t('edit container'),
  436.       'access' => user_access('administer forums'),
  437.       'type' => MENU_CALLBACK);
  438.     $items[] = array('path' => 'admin/forum/edit/forum', 'title' => t('edit forum'),
  439.       'access' => user_access('administer forums'),
  440.       'type' => MENU_CALLBACK);
  441.   }
  442.  
  443.   return $items;
  444. }
  445.  
  446. /**
  447.  * Implementation of hook_view().
  448.  */
  449. function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
  450.  
  451.   if ($page) {
  452.     $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
  453.     // Breadcrumb navigation
  454.     $breadcrumb = array();
  455.     $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
  456.     if ($parents = taxonomy_get_parents_all($node->tid)) {
  457.       $parents = array_reverse($parents);
  458.       foreach ($parents as $p) {
  459.         $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
  460.       }
  461.     }
  462.     $breadcrumb[] = array('path' => 'node/'. $node->nid);
  463.     menu_set_location($breadcrumb);
  464.   }
  465.  
  466.   $node = node_prepare($node, $teaser);
  467. }
  468.  
  469. /**
  470.  * Implementation of hook_validate().
  471.  *
  472.  * Check in particular that only a "leaf" term in the associated taxonomy
  473.  * vocabulary is selected, not a "container" term.
  474.  */
  475. function forum_validate(&$node) {
  476.   // Make sure all fields are set properly:
  477.   $node->icon = $node->icon ? $node->icon : '';
  478.  
  479.   if ($node->taxonomy) {
  480.     // Extract the node's proper topic ID.
  481.     $vocabulary = variable_get('forum_nav_vocabulary', '');
  482.     $containers = variable_get('forum_containers', array());
  483.     foreach ($node->taxonomy as $term) {
  484.       if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
  485.         if (in_array($term, $containers)) {
  486.           $term = taxonomy_get_term($term);
  487.           form_set_error('taxonomy', t('The item %forum is only a container for forums. Please select one of the forums below it.', array('%forum' => theme('placeholder', $term->name))));
  488.         }
  489.         else {
  490.           $node->tid = $term;
  491.         }
  492.       }
  493.     }
  494.     if ($node->tid && $node->shadow) {
  495.       $terms = array_keys(taxonomy_node_get_terms($node->nid));
  496.       if (!in_array($node->tid, $terms)) {
  497.         $terms[] = $node->tid;
  498.       }
  499.       $node->taxonomy = $terms;
  500.     }
  501.   }
  502. }
  503.  
  504. /**
  505.  * Implementation of hook_update().
  506.  */
  507. function forum_update($node) {
  508.   db_query('UPDATE {forum} SET tid = %d WHERE nid = %d', $node->tid, $node->nid);
  509. }
  510.  
  511. /**
  512.  * Implementation of hook_form().
  513.  */
  514. function forum_form(&$node) {
  515.   if (!$node->nid) {
  516.     // new topic
  517.     $node->taxonomy[] = arg(3);
  518.   }
  519.   else {
  520.     $node->taxonomy = array($node->tid);
  521.   }
  522.  
  523.   $output = implode('', taxonomy_node_form('forum', $node));
  524.  
  525.   if ($node->nid) {
  526.     // if editing, give option to leave shadows
  527.     $shadow = (count(taxonomy_node_get_terms($node->nid)) > 1);
  528.     $output .= form_checkbox(t('Leave shadow copy'), 'shadow', 1, $shadow, t('If you move this topic, you can leave a link in the old forum to the new forum.'));
  529.   }
  530.  
  531.   $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '');
  532.   $output .= filter_form('format', $node->format);
  533.  
  534.   return $output;
  535. }
  536.  
  537. /**
  538.  * Implementation of hook_insert().
  539.  */
  540. function forum_insert($node) {
  541.   db_query('INSERT INTO {forum} (nid, tid) VALUES (%d, %d)', $node->nid, $node->tid);
  542. }
  543.  
  544. /**
  545.  * Implementation of hook_delete().
  546.  */
  547. function forum_delete(&$node) {
  548.   db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
  549. }
  550.  
  551. /**
  552.  * Formats a topic for display
  553.  *
  554.  * @TODO Give a better description. Not sure where this function is used yet.
  555.  */
  556. function _forum_format($topic) {
  557.   if ($topic && $topic->timestamp) {
  558.     return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => format_name($topic)));
  559.   }
  560.   else {
  561.     return message_na();
  562.   }
  563. }
  564.  
  565. /**
  566.  * Returns a list of all forums for a given taxonomy id
  567.  *
  568.  * Forum objects contain the following fields
  569.  * -num_topics Number of topics in the forum
  570.  * -num_posts Total number of posts in all topics
  571.  * -last_post Most recent post for the forum
  572.  *
  573.  * @param $tid
  574.  *   Taxonomy ID of the vocabulary that holds the forum list.
  575.  * @return
  576.  *   Array of object containing the forum information.
  577.  */
  578. function forum_get_forums($tid = 0) {
  579.  
  580.   if (!$tid) {
  581.     $tid = 0;
  582.   }
  583.  
  584.   $forums = array();
  585.   $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
  586.  
  587.   if (count($_forums)) {
  588.  
  589.     $counts = array();
  590.  
  591.     $sql = "SELECT r.tid, COUNT(n.nid) AS topic_count, SUM(l.comment_count) AS comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid INNER JOIN {term_node} r ON n.nid = r.nid WHERE n.status = 1 AND n.type = 'forum' GROUP BY r.tid";
  592.     $sql = db_rewrite_sql($sql);
  593.     $_counts = db_query($sql, $forum->tid);
  594.     while ($count = db_fetch_object($_counts)) {
  595.       $counts[$count->tid] = $count;
  596.     }
  597.   }
  598.  
  599.   foreach ($_forums as $forum) {
  600.     if (in_array($forum->tid, variable_get('forum_containers', array()))) {
  601.       $forum->container = 1;
  602.     }
  603.  
  604.     if ($counts[$forum->tid]) {
  605.       $forum->num_topics = $counts[$forum->tid]->topic_count;
  606.       $forum->num_posts = $counts[$forum->tid]->topic_count + $counts[$forum->tid]->comment_count;
  607.     }
  608.     else {
  609.       $forum->num_topics = 0;
  610.       $forum->num_posts = 0;
  611.     }
  612.  
  613.     // This query does not use full ANSI syntax since MySQL 3.x does not support
  614.     // table1 INNER JOIN table2 INNER JOIN table3 ON table2_criteria ON table3_criteria
  615.     // used to join node_comment_statistics to users.
  616.     $sql = "SELECT n.nid, l.last_comment_timestamp, IF(l.last_comment_uid, cu.name, l.last_comment_name) as last_comment_name, l.last_comment_uid FROM {node} n, {node_comment_statistics} l /*! USE INDEX (node_comment_timestamp) */, {users} cu, {term_node} r WHERE  n.nid = r.nid AND r.tid = %d AND n.status = 1 AND n.type = 'forum' AND l.last_comment_uid = cu.uid AND n.nid = l.nid ORDER BY l.last_comment_timestamp DESC";
  617.     $sql = db_rewrite_sql($sql);
  618.     $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
  619.  
  620.     $last_post = new StdClass();
  621.     $last_post->timestamp = $topic->last_comment_timestamp;
  622.     $last_post->name = $topic->last_comment_name;
  623.     $last_post->uid = $topic->last_comment_uid;
  624.     $forum->last_post = $last_post;
  625.  
  626.     $forums[$forum->tid] = $forum;
  627.   }
  628.  
  629.   return $forums;
  630. }
  631.  
  632. function _forum_topics_read($term, $uid) {
  633.   // Calculate the number of topics the user has read. Assume all entries older
  634.   // than NODE_NEW_LIMIT are read, and include the recent posts that user has
  635.   // read.
  636.   $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.created <= %d AND n.status = 1 AND n.type = 'forum'";
  637.   $sql = db_rewrite_sql($sql);
  638.   $ancient = db_result(db_query($sql, $term, NODE_NEW_LIMIT));
  639.   $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {history} h ON n.nid = h.nid AND h.uid = %d INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' AND n.created > %d";
  640.   $sql = db_rewrite_sql($sql);
  641.   $recent = db_result(db_query($sql, $uid, $term, NODE_NEW_LIMIT));
  642.  
  643.   return $ancient + $recent;
  644. }
  645.  
  646. function forum_get_topics($tid, $sortby, $forum_per_page) {
  647.   global $user, $forum_topic_list_header;
  648.  
  649.   $forum_topic_list_header = array(
  650.     array('data' => ' '),
  651.     array('data' => t('Topic'), 'field' => 'n.title'),
  652.     array('data' => t('Replies'), 'field' => 'l.comment_count'),
  653.     array('data' => t('Created'), 'field' => 'n.created'),
  654.     array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
  655.   );
  656.  
  657.   $order = _forum_get_topic_order($sortby);
  658.   for ($i = 0; $i < count($forum_topic_list_header); $i++) {
  659.     if ($forum_topic_list_header[$i]['field'] == $order['field']) {
  660.       $forum_topic_list_header[$i]['sort'] = $order['sort'];
  661.     }
  662.   }
  663.  
  664.   $term = taxonomy_get_term($tid);
  665.  
  666.   $sql = db_rewrite_sql("SELECT n.nid, f.tid, n.title, n.sticky, u.name, u.uid, n.created AS timestamp, n.comment AS comment_mode, l.last_comment_timestamp, IF(l.last_comment_uid, cu.name, l.last_comment_name) AS last_comment_name, l.last_comment_uid, l.comment_count AS num_comments FROM {node} n, {node_comment_statistics} l, {users} cu, {term_node} r, {users} u, {forum} f WHERE n.status = 1 AND l.last_comment_uid = cu.uid AND n.nid = l.nid AND n.nid = r.nid AND r.tid = %d AND n.uid = u.uid AND n.nid = f.nid");
  667.   $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
  668.  
  669.   $sql_count = db_rewrite_sql("SELECT COUNT(n.nid) FROM {node} n INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum'");
  670.  
  671.   $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
  672.  
  673.   while ($topic = db_fetch_object($result)) {
  674.     if ($user->uid) {
  675.       // folder is new if topic is new or there are new comments since last visit
  676.       if ($topic->tid != $tid) {
  677.         $topic->new = 0;
  678.       }
  679.       else {
  680.         $history = _forum_user_last_visit($topic->nid);
  681.         $topic->new_replies = comment_num_new($topic->nid, $history);
  682.         $topic->new = $topic->new_replies || ($topic->timestamp > $history);
  683.       }
  684.     }
  685.     else {
  686.       // Do not track "new replies" status for topics if the user is anonymous.
  687.       $topic->new_replies = 0;
  688.       $topic->new = 0;
  689.     }
  690.  
  691.     if ($topic->num_comments > 0) {
  692.       $last_reply = new StdClass();
  693.       $last_reply->timestamp = $topic->last_comment_timestamp;
  694.       $last_reply->name = $topic->last_comment_name;
  695.       $last_reply->uid = $topic->last_comment_uid;
  696.       $topic->last_reply = $last_reply;
  697.     }
  698.     $topics[] = $topic;
  699.   }
  700.  
  701.   return $topics;
  702. }
  703.  
  704. /**
  705.  * Finds the first unread node for a given forum.
  706.  */
  707. function _forum_new($tid) {
  708.   global $user;
  709.  
  710.   $sql = "SELECT n.nid FROM {node} n LEFT JOIN {history} h ON n.nid = h.nid AND h.uid = %d INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' AND h.nid IS NULL AND n.created > %d ORDER BY created";
  711.   $sql = db_rewrite_sql($sql);
  712.   $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
  713.  
  714.   return $nid ? $nid : 0;
  715. }
  716.  
  717. /**
  718.  * Menu callback; prints a forum listing.
  719.  */
  720. function forum_page($tid = 0) {
  721.   global $user;
  722.  
  723.   if (module_exist('taxonomy')) {
  724.     $forum_per_page = variable_get('forum_per_page', 25);
  725.     $sortby = variable_get('forum_order', 1);
  726.  
  727.     $forums = forum_get_forums($tid);
  728.     $parents = taxonomy_get_parents_all($tid);
  729.     if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
  730.       $topics = forum_get_topics($tid, $sortby, $forum_per_page);
  731.     }
  732.  
  733.     print theme('page', theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page));
  734.   }
  735.   else {
  736.     drupal_set_title(t('Warning'));
  737.     print theme('page', forum_help('admin/settings/forum'));
  738.   }
  739. }
  740.  
  741. /**
  742.  * Format the forum body.
  743.  *
  744.  * @ingroup themeable
  745.  */
  746. function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
  747.   global $user;
  748.   // forum list, topics list, topic browser and 'add new topic' link
  749.  
  750.   $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
  751.   $title = $vocabulary->name;
  752.  
  753.   // Breadcrumb navigation:
  754.   $breadcrumb = array();
  755.   if ($tid) {
  756.     $breadcrumb[] = array('path' => 'forum', 'title' => $title);
  757.   }
  758.  
  759.   if ($parents) {
  760.     $parents = array_reverse($parents);
  761.     foreach ($parents as $p) {
  762.       if ($p->tid == $tid) {
  763.         $title = $p->name;
  764.       }
  765.       else {
  766.         $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
  767.       }
  768.     }
  769.   }
  770.  
  771.   drupal_set_title($title);
  772.  
  773.   $breadcrumb[] = array('path' => $_GET['q']);
  774.   menu_set_location($breadcrumb);
  775.  
  776.   if (count($forums) || count($parents)) {
  777.     $output  = '<div id="forum">';
  778.     $output .= '<ul>';
  779.  
  780.     if (module_exist('tracker')) {
  781.       if ($user->uid) {
  782.         $output .= ' <li>'. l(t('My forum discussions.'), "tracker/$user->uid") .'</li>';
  783.       }
  784.  
  785.       $output .= ' <li>'. l(t('Active forum discussions.'), 'tracker') .'</li>';
  786.     }
  787.  
  788.     if (user_access('create forum topics')) {
  789.       $output .= '<li>'. l(t('Post new forum topic.'), "node/add/forum/$tid") .'</li>';
  790.     }
  791.     else if ($user->uid) {
  792.       $output .= '<li>'. t('You are not allowed to post a new forum topic.') .'</li>';
  793.     }
  794.     else {
  795.       $output .= '<li>'. t('<a href="%login">Login</a> to post a new forum topic.', array('%login' => url('user/login'))) .'</li>';
  796.     }
  797.     $output .= '</ul>';
  798.  
  799.     $output .= theme('forum_list', $forums, $parents, $tid);
  800.  
  801.     if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
  802.       drupal_set_html_head('<link rel="alternate" type="application/rss+xml" title="RSS - '. $title .'" href="'. url('taxonomy/term/'. $tid .'/0/feed') .'" />');
  803.  
  804.       $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);
  805.       $output .= theme('xml_icon', url("taxonomy/term/$tid/0/feed"));
  806.     }
  807.     $output .= '</div>';
  808.   }
  809.   else {
  810.     drupal_set_title(t('No forums defined'));
  811.     $output = '';
  812.   }
  813.  
  814.   return $output;
  815. }
  816.  
  817. /**
  818.  * Format the forum listing.
  819.  *
  820.  * @ingroup themeable
  821.  */
  822. function theme_forum_list($forums, $parents, $tid) {
  823.   global $user;
  824.  
  825.   if ($forums) {
  826.  
  827.     $header = array(t('Forum'), t('Topics'), t('Posts'), t('Last post'));
  828.  
  829.     foreach ($forums as $forum) {
  830.       if ($forum->container) {
  831.         $description  = '<div style="margin-left: '. ($forum->depth * 30) ."px;\">\n";
  832.         $description .= ' <div class="name">'. l($forum->name, "forum/$forum->tid") ."</div>\n";
  833.  
  834.         if ($forum->description) {
  835.           $description .= " <div class=\"description\">$forum->description</div>\n";
  836.         }
  837.         $description .= "</div>\n";
  838.  
  839.         $rows[] = array(array('data' => $description, 'class' => 'container', 'colspan' => '4'));
  840.       }
  841.       else {
  842.         $forum->old_topics = _forum_topics_read($forum->tid, $user->uid);
  843.         if ($user->uid) {
  844.           $new_topics = $forum->num_topics - $forum->old_topics;
  845.         }
  846.         else {
  847.           $new_topics = 0;
  848.         }
  849.  
  850.         $description  = '<div style="margin-left: '. ($forum->depth * 30) ."px;\">\n";
  851.         $description .= ' <div class="name">'. l($forum->name, "forum/$forum->tid") ."</div>\n";
  852.  
  853.         if ($forum->description) {
  854.           $description .= " <div class=\"description\">$forum->description</div>\n";
  855.         }
  856.         $description .= "</div>\n";
  857.  
  858.         $rows[] = array(
  859.           array('data' => $description, 'class' => 'forum'),
  860.           array('data' => $forum->num_topics . ($new_topics ? '<br />'. l(t('%a new', array('%a' => $new_topics)), "forum/$forum->tid", NULL, NULL, 'new') : ''), 'class' => 'topics'),
  861.           array('data' => $forum->num_posts, 'class' => 'posts'),
  862.           array('data' => _forum_format($forum->last_post), 'class' => 'last-reply'));
  863.       }
  864.     }
  865.  
  866.     return theme('table', $header, $rows);
  867.  
  868.   }
  869.  
  870. }
  871.  
  872. /**
  873.  * Format the topic listing.
  874.  *
  875.  * @ingroup themeable
  876.  */
  877. function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page) {
  878.   global $forum_topic_list_header;
  879.  
  880.   if ($topics) {
  881.  
  882.     foreach ($topics as $topic) {
  883.       // folder is new if topic is new or there are new comments since last visit
  884.       if ($topic->tid != $tid) {
  885.         $rows[] = array(
  886.           array('data' => _forum_icon($topic->new, $topic->num_comments, $topic->comment_mode, $topic->sticky), 'class' => 'icon'),
  887.           array('data' => check_plain($topic->title), 'class' => 'title'),
  888.           array('data' => l(t('This topic has been moved'), "forum/$topic->tid"), 'colspan' => '3')
  889.         );
  890.       }
  891.       else {
  892.         $rows[] = array(
  893.           array('data' => _forum_icon($topic->new, $topic->num_comments, $topic->comment_mode, $topic->sticky), 'class' => 'icon'),
  894.           array('data' => l($topic->title, "node/$topic->nid"), 'class' => 'topic'),
  895.           array('data' => $topic->num_comments . ($topic->new_replies ? '<br />'. l(t('%a new', array('%a' => $topic->new_replies)), "node/$topic->nid", NULL, NULL, 'new') : ''), 'class' => 'replies'),
  896.           array('data' => _forum_format($topic), 'class' => 'created'),
  897.           array('data' => _forum_format($topic->last_reply), 'class' => 'last-reply')
  898.         );
  899.       }
  900.     }
  901.  
  902.     if ($pager = theme('pager', NULL, $forum_per_page, 0, tablesort_pager())) {
  903.       $rows[] = array(array('data' => $pager, 'colspan' => '5', 'class' => 'pager'));
  904.     }
  905.   }
  906.  
  907.   $output .= theme('table', $forum_topic_list_header, $rows);
  908.  
  909.   return $output;
  910. }
  911.  
  912. function _forum_icon($new_posts, $num_posts = 0, $comment_mode = 0, $sticky = 0) {
  913.  
  914.   $base_path = variable_get('forum_icon_path', '');
  915.   if ($base_path) {
  916.     if ($num_posts > variable_get('forum_hot_topic', 15)) {
  917.       $icon = $new_posts ? 'hot-new' : 'hot';
  918.     }
  919.     else {
  920.       $icon = $new_posts ? 'new' : 'default';
  921.     }
  922.  
  923.     if ($comment_mode == 1) {
  924.       $icon = 'closed';
  925.     }
  926.  
  927.     if ($sticky == 1) {
  928.       $icon = 'sticky';
  929.     }
  930.  
  931.     // default
  932.     $file = "misc/forum-$icon.png";
  933.  
  934.     $output = theme('image', $file);
  935.   }
  936.   else {
  937.     $output = ' ';
  938.   }
  939.  
  940.   if ($new_posts) {
  941.     $output = "<a name=\"new\">$output</a>";
  942.   }
  943.  
  944.   return $output;
  945. }
  946.  
  947. function _forum_user_last_visit($nid) {
  948.   global $user;
  949.   static $history = array();
  950.  
  951.   if (empty($history)) {
  952.     $result = db_query('SELECT nid, timestamp FROM {history} WHERE uid = %d', $user->uid);
  953.     while ($t = db_fetch_object($result)) {
  954.       $history[$t->nid] = $t->timestamp > NODE_NEW_LIMIT ? $t->timestamp : NODE_NEW_LIMIT;
  955.     }
  956.   }
  957.   return $history[$nid] ? $history[$nid] : NODE_NEW_LIMIT;
  958. }
  959.  
  960. function _forum_get_topic_order($sortby) {
  961.   switch ($sortby) {
  962.     case 1:
  963.       return array('field' => 'l.last_comment_timestamp', 'sort' => 'desc');
  964.       break;
  965.     case 2:
  966.       return array('field' => 'l.last_comment_timestamp', 'sort' => 'asc');
  967.       break;
  968.     case 3:
  969.       return array('field' => 'l.comment_count', 'sort' => 'desc');
  970.       break;
  971.     case 4:
  972.       return array('field' => 'l.comment_count', 'sort' => 'asc');
  973.       break;
  974.   }
  975. }
  976.  
  977. function _forum_get_topic_order_sql($sortby) {
  978.   $order = _forum_get_topic_order($sortby);
  979.   return $order['field'] .' '. $order['sort'];
  980. }
  981.  
  982. ?>
  983.