og_forums.module

Go to the documentation of this file.

<?php
// $Id: og_forums.module, v 1.0 2009/12/07 10:32:15 quiptime Exp $

/**
 * @file
 * Creates one or more forums per organic group and restricts viewing forum nodes by group membership.
 *
 * This module is the redeveloped version of <a href="http://drupal.org/project/og_forum">Paul Booker's OG Forum</a> module.
 * This module comes with the name "OG Forum Reloded" - OGFR.
 */

/**
 * Constant to define the publicity of a forum.
 */
define('PRIVATE_DEFAULT', 0);

/**
 * Constant to define the publicity of a forum.
 */
define('PRIVATE_BY_GROUP_OWNER', 1);

/**
 * Constant to define the publicity of a forum.
 */
define('PUBLIC_AUTO', 2);

/**
 * Constant to define the publicity of a forum.
 */
define('PUBLIC_BY_GROUP_OWNER', 3);

/**
 * Implementation of hook_help().
 */
function og_forums_help($path, $arg) {
  switch ($path) {
    case 'admin/modules#description':
      return t('Ties forums to organic groups.');
    case 'admin/content/taxonomy':
      return t('Managing OG forums is not supported here. Please use the <a href="@administer-forums-url">@administer-forums</a>.', array('@administer-forums-url' => url('admin/content/forum'), '@administer-forums' => t('Forum administration')));
    case 'admin/content/forum':
      $message = t('<h3>Organic groups forums</h3>
      <p>The drag-and-drop feature is not fully supported. Groups forums can be moved only within a container. Do not move a group forum from one container to another container!</p>');
      return $message;
    case 'admin/og/og_forums':
      $message = '<p>'. t('Do not change the <em>Groups forums container</em> configuration if there are already groups forums - especially on a live site. This is a warning.').'</p>';
      return $message;
    case 'admin/help#og_forums':
      $module_path = drupal_get_path('module', 'og_forums');
      return '<p>'. t('The included module documentation contains <a href="@help-url">@help</a>.', array('@help-url' => url($module_path .'/docs/html/index.html'), '@help' => t('the help'))) .'</p>';
      break;
  }
}

/**
 * Implementation of hook_perm().
 */
function og_forums_perm() {
  return array('make forums public', 'delete own groups forums', 'admin own groups forums');
}

/**
 * Implementation of hook_menu().
 */
function og_forums_menu() {
  $items = array();

  // Two path arguments.
  // First: gid
  // Second: tid

  $items['admin/og/og_forums'] = array(
    'title' => 'Organic groups forums',
    'description' => 'Configure forums for organic groups',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('og_forums_admin_settings'),
    'access arguments' => array('administer site configuration'),
    'file' => 'og_forums.admin.inc',
  );
   $items['og_forums/manage/public/%/%'] = array(
    'title' => 'Make forum public',
    'page callback' => 'og_forums_public',
    'page arguments' => array(3, 4),
    'access callback' => 'og_forums_access_privileges_1',
    'access arguments' => array(3),
    'type' => MENU_CALLBACK,
  );
  $items['og_forums/manage/private/%/%'] = array(
    'title' => 'Make forum private',
    'page callback' => 'og_forums_private',
    'page arguments' => array(3, 4),
    'access callback' => 'og_forums_access_privileges_1',
    'access arguments' => array(3),
    'type' => MENU_CALLBACK,
  );
  $items['og_forums/manage/reset/%/%'] = array(
    'title' => 'Reset forum publicity',
    'page callback' => 'og_forums_reset',
    'page arguments' => array(3, 4),
    'access callback' => 'og_forums_access_privileges_1',
    'access arguments' => array(3),
    'type' => MENU_CALLBACK,
  );

  $items['og_forums/manage/%'] = array(
    'title' => 'Manage groups forums',
    'page callback' => 'og_forums_manage',
    'page arguments' => array(2),
    'access callback' => 'og_forums_access_privileges_2',
    'access arguments' => array(2),
    'type' => MENU_CALLBACK,
  );
  $items['og_forums/manage/add/%/%'] = array(
    'title' => 'Add forum',
    'page callback' => 'og_forums_form_main',
    'page arguments' => array(2, 3, 4),
    'access callback' => 'og_forums_access_privileges_3',
    'access arguments' => array(3, 4),
    'type' => MENU_CALLBACK,
  );
  $items['og_forums/manage/edit/%/%'] = array(
    'title' => 'Edit forum',
    'page callback' => 'og_forums_form_main',
    'page arguments' => array(2, 3, 4),
    'access callback' => 'og_forums_access_privileges_2',
    'access arguments' => array(3),
    'type' => MENU_CALLBACK,
  );
  $items['node/%og_forums_group_type/forum'] = array(
    'title' => 'Forums',
    'page callback' => 'drupal_goto',
    'page arguments' => array(1),
    'access callback'   => TRUE,
    'type' => MENU_LOCAL_TASK
  );

  return $items;
}

/**
 * Implementation of hook_menu_alter().
 */
function og_forums_menu_alter(&$callbacks) {
  $callbacks['forum']['access callback'] = 'og_forums_access_forum_page';
  $callbacks['forum']['access arguments'] = array(1);

  $callbacks['node/%node/edit']['access callback'] = 'node_access';
  $callbacks['node/%node/edit']['access arguments'] = array('update', 1);
}

/**
 * Implementation of hook_form_alter().
 *
 * @see og_forums_set_og_group_context_from_tid()
 * @see og_forums_get_vid()
 * @see og_forums_is_og_forums()
 * @see og_forums_is_public()
 */
function og_forums_form_alter(&$form, &$form_state, $form_id) {
  // Auto-select group's forum when adding/editing a forum topic.
  if ($form_id == 'forum_node_form') {
    global $user;

    $group = og_get_group_context();

    // If we couldn't get the context from og, don't give up. Try getting it from the nid if we have one.
    if (empty($group)) {
      if (arg(0) == 'node' && arg(2) == 'edit' && is_numeric(arg(1))) {
        $sql = "SELECT tid FROM {forum} WHERE nid = %d";
        $result = db_fetch_object(db_query($sql, arg(1)));
        og_forums_set_og_group_context_from_tid($result->tid);
        $group = og_get_group_context();
      }
    }

    if (isset($group->nid)) {
      $forum_containers = variable_get('forum_containers', array());

      $results = db_query('SELECT ot.tid, th.parent FROM {og_terms} ot LEFT JOIN {term_hierarchy} th ON ot.tid = th.tid WHERE nid = %d ORDER BY tid ASC', $group->nid);

      while ($result = db_fetch_object($results)) {
        $all_results[$result->tid] = $result->parent;
      }

      $vid = og_forums_get_vid();
      // Set the forum selection drop down box.
      if (arg(1) == 'add' && arg(3)) {
        $term = arg(3);
        $form['taxonomy'][$vid]['#default_value'] = array($term);
      }
      elseif (arg(2) == 'edit') {
        $term = $form['taxonomy'][$vid]['#default_value'][0];
      }
      elseif (arg(1) == 'add' && !arg(3)) {
        $first = reset($all_results);
        if ($first == 0) {
          next($all_results);
        }
        $term = key($all_results);
        $form['taxonomy'][$vid]['#default_value'] = array($term);
      }

      foreach ($form['taxonomy'][$vid]['#options'] as $key => $the_rest) {
        if ($key === '') {
          continue;
        }
        reset($the_rest->option);
        $option_key = key($the_rest->option);
        if (is_array($all_results) && !array_key_exists($option_key, $all_results)) {
          unset($form['taxonomy'][$vid]['#options'][$key]);
        }

        // Make a little bit better usability.
        // Flag a term if it is a container.
        if (is_array($all_results) && array_key_exists($option_key, $all_results) && in_array($option_key, $forum_containers)) {
          $form['taxonomy'][$vid]['#options'][$key]->option[$option_key] .= ' '. t('(Container)');
        }

        // Hide term is the public status not public and user not a group member.
        if (is_array($all_results) && array_key_exists($option_key, $all_results) && !in_array($option_key, $forum_containers) ) {
          if (is_array($user->og_groups)) {
            $term_public = og_forums_is_public($option_key);
            $term_gid = og_forums_gid_from_tid($option_key);

            if ($term_public == FALSE && !array_key_exists($term_gid, $user->og_groups)) {
              unset($form['taxonomy'][$vid]['#options'][$key]->option[$option_key]);
            }
          }
        }

      }

      $form['taxonomy'][$vid]['#description'] = t('Please choose a forum. In a container can not be posted a topic.');

      // Check to see if forum is a group post type.
      if (og_is_group_post_type($form['#node']->type)) {
        $groups = array($gid => $gid);

        // Hide checkboxes if 'Audience checkboxes' is checked in OG settings.
        if (variable_get('og_audience_checkboxes', TRUE)) {
          $options = $form['og_nodeapi']['visible']['og_groups']['#options'];
          $form['og_nodeapi']['visible']['og_groups_visible'] = array(
            '#type' => 'item',
            '#title' => t('Audience'),
            '#value' => $options[$gid]
          );
          // When you make a group forum post it can only be made into the group the forum is affiliated with.
          unset($form['og_nodeapi']['visible']['og_groups']);
        }

        // This 'value' element persists the audience value during submit process.
        $form['og_nodeapi']['invisible']['og_groups'] = array(
          '#type' => 'value',
          '#value' => $groups
        );
      }
    }
    else {
      $results = db_query('SELECT ot.tid, th.parent FROM {og_terms} ot LEFT JOIN {term_hierarchy} th ON ot.tid = th.tid ORDER BY tid ASC');

      while ($result = db_fetch_object($results)) {
        $all_results[$result->tid] = $result->parent;
      }

      $vid =  og_forums_get_vid();
      $cut = FALSE;

      if (arg(1) == 'add' && arg(3)) {
        $cut = TRUE;
        $term = arg(3);
        $form['taxonomy'][$vid]['#default_value'] = array($term);
      }
      elseif (arg(2) == 'edit') {
        $cut = TRUE;
        $term = $form['taxonomy'][$vid]['#default_value'][0];
      }
      if (!user_access('administer forums') && $cut) {
        foreach ($form['taxonomy'][$vid]['#options'] as $key => $the_rest) {
          if ($key == '') {
            continue;
          }
          reset($the_rest->option);
          $option_key = key($the_rest->option);
          if (is_array($all_results) && array_key_exists($option_key, $all_results)) {
            unset($form['taxonomy'][$vid]['#options'][$key]);
          }
        }
      }

      // No group audience for sitewide forums.
      unset($form['og_nodeapi']['visible']['og_groups']);
    }
  }

  if ($form_id == 'node_delete_confirm') {
    // Add submit to manage redirect.
    $form['#submit'][] = 'og_forums_node_delete_confirm_submit';
  }

  $group_type = variable_get('og_content_type_usage_group', 'group');
  if ($form_id == $group_type .'_node_form') {
    $form['group_id'] = array(
      '#type' => 'value',
      '#value' => $form['#node']->nid,
    );
  }
}

/**
 * Wildcard loader function.
 *
 * @see og_forums_menu()
 *
 * Wildcard Loader Arguments: http://drupal.org/node/224170
 */
function og_forums_group_type_load($arg) {
  $node = node_load($arg);

  if (og_is_group_type($node->type)) {
    global $user;

    // Check group forum availability, configured by group manager.
    $group_user = user_load(array('uid' => $node->uid));
    $availability = module_invoke('og_forums', 'get_forums_availability', $node, $group_user);
    if ($availability == FALSE) {
      return FALSE;
    }

    $tid = og_forums_get_forum_container($arg);
    if ((!empty($user->og_groups) && array_key_exists($arg, $user->og_groups) && og_forums_is_public_all($node->nid)) || user_access('create forum topics')) {
      return "forum/$tid";
    }
    else {
      return FALSE;
    }
  }

  return FALSE;
}

/**
 * Implementation of hook_block().
 *
 * Creates a block to display forum information for a group.
 */
function og_forums_block($op = 'list', $delta = 0, $edit = array()) {
  if ($group_node = og_get_group_context()) {
    $nid = $group_node->nid;
  }
  switch ($op) {
    case 'list':
      $blocks[0]['info'] = t('Active forum topics in group');
      $blocks[1]['info'] = t('New forum topics in group');
      return $blocks;

    case 'configure':
      $form['og_forums_block_num_'. $delta] = array('#type' => 'select', '#title' => t('Number of topics'), '#default_value' => variable_get('og_forums_block_num_'. $delta, '5'), '#options' => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
      return $form;

    case 'save':
      variable_set('og_forums_block_num_'. $delta, $edit['og_forums_block_num_'. $delta]);
      break;

    case 'view':
      if (user_access('access content') && $nid) {
        switch ($delta) {
          case 0:
            $title = t('Active group forum topics');
            $sql = "SELECT COUNT(*) FROM {node} n
                    INNER JOIN {node_comment_statistics} l
                    INNER JOIN {og_terms} ot INNER JOIN {term_node} tn
                    WHERE ot.nid = $nid AND ot.tid = tn.tid AND tn.nid = n.nid AND n.nid = l.nid AND n.status = 1 AND n.type = 'forum' ORDER BY l.last_comment_timestamp DESC";
            $num_results = db_result(db_query($sql, $nid));

            if ($num_results) {
              $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count, l.last_comment_timestamp FROM {node} n
                                     INNER JOIN {node_comment_statistics} l
                                     INNER JOIN {og_terms} ot
                                     INNER JOIN {term_node} tn
                                     WHERE ot.nid = $nid AND ot.tid = tn.tid AND tn.nid = n.nid AND n.nid = l.nid AND n.status = 1 AND n.type = 'forum' ORDER BY l.last_comment_timestamp DESC");
              $result = db_query_range($sql, 0, variable_get('og_forums_block_num_0', '5'));

              $content = node_title_list($result);
            }
            break;

          case 1:
            $title = t('New group forum topics');
            $sql = "SELECT COUNT(*) FROM {node} n
                    INNER JOIN {node_comment_statistics} l
                    INNER JOIN {og_terms} ot INNER JOIN {term_node} tn
                    WHERE ot.nid = $nid AND ot.tid = tn.tid AND tn.nid = n.nid AND n.nid = l.nid AND n.type = 'forum' AND n.status = 1 ORDER BY n.nid DESC";
            $num_results = db_result(db_query($sql, $nid));

            if ($num_results) {
              $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n
                                     INNER JOIN {node_comment_statistics} l
                                     INNER JOIN {og_terms} ot
                                     INNER JOIN {term_node} tn
                                     WHERE ot.nid = $nid AND ot.tid = tn.tid AND tn.nid = n.nid AND n.nid = l.nid AND n.type = 'forum' AND n.status = 1 ORDER BY n.nid DESC");
              $result = db_query_range($sql, 0, variable_get('og_forums_block_num_1', '5'));

              $content = node_title_list($result);
            }
            break;
        }

        if ($content) {
          $forum  = og_forums_get_forum_container($nid);
          $content .= '<div class="more-link">'. l(t('more'), "forum/$forum") .'</div>';
        }

        $block['subject'] = $title;
        $block['content'] = $content;

        return $block;
      }
  }
}

/**
 * Access callback.
 *
 * @see og_forums_menu()
 */
function og_forums_access_privileges_1($gid) {
  $group = node_load($gid);
  $allow_public = variable_get('og_forums_allow_public', 0);

  return ((og_forums_is_admin($group) && user_access('admin own groups forums') && $allow_public) || user_access('make forums public'));
}

/**
 * Access callback.
 *
 * @see og_forums_menu()
 */
function og_forums_access_privileges_2($gid) {
  $group = node_load($gid);

  return ((og_forums_is_admin($group) && user_access('admin own groups forums')) || user_access('administer forums'));
}

/**
 * Access callback.
 *
 * @see og_forums_menu()
 */
function og_forums_access_privileges_3($gid, $tid) {
  global $user;
  $group = node_load($gid);

  $add_link_access = variable_get('og_forums_add_link', 1);

  return ((og_forums_is_admin($group) && $add_link_access == 1 && user_access('admin own groups forums') && !og_forums_forum_limit_reached($tid)) || user_access('administer forums'));
}

/**
 * Set a forum as public, and its container as well.
 *
 * @param $gid
 *   The group ID of the forum.
 * @param $tid
 *   The term ID of the forum.
 */
function og_forums_public($gid, $tid) {
  $container = og_forums_get_forum_container($gid);

  // Public status versions.
  // 0 private by default or admin
  // 1 private by group manager
  // 2 public auto
  // 3 public by group manager
  // All forums of an container have status 1, then has this container status 0.
  // Only 1 forum of an container have status 3, then has this container also status 3.

  $sql = "UPDATE {og_terms} SET public = %d WHERE tid = %d AND nid = %d";
  db_query($sql, PUBLIC_BY_GROUP_OWNER, $tid, $gid);
  db_query($sql, PUBLIC_BY_GROUP_OWNER, $container, $gid);

  if ((arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'edit' && arg(3) == '') ||
      (arg(0) == 'admin' && arg(1) == 'content' && arg(2) == 'forum')) {
    return;
  }
  else {
    return drupal_goto("og_forums/manage/$gid");
  }
}

/**
 * Set forum as private, and its container if no other forums in it are public.
 *
 * @see og_forums_menu()
 * @see og_forums_taxonomy()
 *
 * @param $gid
 *   The group ID of the forum.
 * @param $tid
 *   The term ID of the forum.
 */
function og_forums_private($gid, $tid) {
  $container = og_forums_get_forum_container($gid);

  // Public status versions.
  // 0 private by default or admin
  // 1 private by group manager
  // 2 public auto
  // 3 public by group manager
  // All forums of an container have status 1, then has this container status 0.
  // Only 1 forum of an container have status 3, then has this container also status 3.

  $sql = "UPDATE {og_terms} SET public = %d WHERE tid = %d and nid = %d";
  db_query($sql, PRIVATE_BY_GROUP_OWNER, $tid, $gid);

  // Find out if any other forums are public.
  $sql2 = "SELECT COUNT(tid) FROM {og_terms} WHERE nid = %d AND tid <> %d AND public > 1";
  $results = db_query($sql2, $gid, $container);
  $result = db_result($results);

  // If no other forums in the group are public, go ahead and make the container private.
  if (!$result) {
    db_query($sql, PRIVATE_DEFAULT, $container, $gid);
  }

  if ((arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'edit' && arg(3) == '') ||
      (arg(0) == 'admin' && arg(1) == 'content' && arg(2) == 'forum')) {
    return;
  }
  else {
    return drupal_goto("og_forums/manage/$gid");
  }
}

/**
 * Reset forum to default of PRIVATE_DEFAULT, and its container if no other forums in it are public.
 *
 * @see og_forums_menu()
 *
 * @param $gid
 *   The group ID of the forum.
 * @param $tid
 *   The term ID of the forum.
 */
function og_forums_reset($gid, $tid) {
  $container = og_forums_get_forum_container($gid);

  $sql = "UPDATE {og_terms} SET public = %d WHERE tid = %d and nid = %d";
  db_query($sql, PRIVATE_DEFAULT, $tid, $gid);

  // Find out if any other forums are public.
  $sql2 = "SELECT COUNT(tid) FROM {og_terms} WHERE nid = %d AND tid <> %d AND public > 1";
  $results = db_query($sql2, $gid, $container);
  $result = db_result($results);

  // If no other forums in the group are public, go ahead and make the container private.
  if (!$result) {
    db_query($sql, PRIVATE_DEFAULT, $container, $gid);
  }

  if ((arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'edit' && arg(3) == '') ||
      (arg(0) == 'admin' && arg(1) == 'content' && arg(2) == 'forum')) {
    return;
  }
  else {
    return drupal_goto("og_forums/manage/$gid");
  }
}

/**
 * Let group managers manage their forums.
 *
 * @see _og_forums_manage_breadcrumb()
 * @see _og_forums_ogterms()
 * @see _og_forums_no_forums_message()
 * @see og_forums_forum_get_parent()
 * @see og_forums_forum_limit_reached()
 * @see _og_forums_manage_row()
 *
 * @param $gid
 *   An group ID.
 * @return
 *   HTML formatted management content.
 */
function og_forums_manage($gid) {
  $manage['group'] = node_load($gid);
  $manage['group_user'] = user_load(array('uid' => $manage['group']->uid));

  $manage['forum_count'] = count(og_forums_get_group_forums($manage['group']->nid, 'forum'));

  $manage['allow_public'] = variable_get('og_forums_allow_public', 0);
  $manage['display_add_link'] = variable_get('og_forums_add_link', 1);
  $manage['display_quota_message'] = variable_get('og_forums_quota_message', 1);
  $manage['availability_grant'] = variable_get('og_forums_availability_grant', 1);

  og_set_theme($manage['group']->nid);
  og_set_language($manage['group']);
  og_set_group_context($manage['group']);

  // Set a nice breadcrumb.
  _og_forums_manage_breadcrumb($manage['group']);

  $manage['og_terms'] = _og_forums_ogterms($manage['group']);

  // Check group forum availability, configured by group manager.
  // If availability FALSE hide forums tables.
  if ($manage['availability_grant'] == 1 && $manage['forum_count'] > 0) {
    $content = drupal_get_form('og_forums_forum_availability');
  }

  $manage['availability'] = module_invoke('og_forums', 'get_forums_availability', $manage['group'], $manage['group_user']);

  if ($manage['availability'] == FALSE && $manage['availability_grant'] == 1) {
    $content .= '';
    return $content;
  }

  // If there are no groups forums exist show a message.
  if (count($manage['og_terms']) == 0) {
    if ((og_forums_is_admin($manage['group']) && user_access('admin own groups forums')) || user_access('administer forums')) {
      $edit_path = "node/$gid/edit";
      $message = _og_forums_no_forums_message('manager', $edit_path);
    }
    else {
      $user_path = 'user/'. $manage['group']->uid;
      $message = _og_forums_no_forums_message('member', $user_path);
    }

    drupal_set_message($message, 'status');

    $content .= '';
  }
  else {
    // Selectbox "Default container".
    $manage['default_container'] = variable_get('og_forums_default_container', -1);
    // Checkbox "Same container".
    $manage['default_container_yn'] = variable_get('og_forums_default_container_yn', TRUE);

    if ($manage['forum_count'] > 0) {
      $content .= '<p>' .t('This page shows the forums associated with the %group group.', array('%group' => $manage['group']->title)). '</p>';
    }
    else {
      $content .= '<p>' .t('There are no forums for the  %group group.', array('%group' => $manage['group']->title)). '</p>';
    }

    $header = array(t('Name'), t('Operations'));
    $sql = "SELECT public, tid FROM {og_terms} WHERE nid = %d";
    $results = db_query($sql, $manage['group']->nid);

    $manage['all_tids'] = array();
    while ($result = db_fetch_object($results)) {
      $manage['all_tids'][$result->tid] = $result->public;
    }

    // Check has one of the tids as parent the default container.
    $first = each($manage['all_tids']);
    $manage['check_default'] = og_forums_forum_get_parent($first[0]);

    // Set different limits, if needed.
    $manage['forum_limit_reached'] = NULL;
    if (isset($manage['check_default'])) {
      $manage['forum_limit_reached'] = og_forums_forum_limit_reached($manage['group']->nid, 0);
    }
    else {
      $manage['forum_limit_reached'] = og_forums_forum_limit_reached($manage['group']->nid, 0);
    }

    // Get the term tree of the given group.
    // This gives a better performance than if the entire tree (forum vocabulary) is used.
    $manage['group_tid'] = og_forums_tid_from_gid($gid);
    $manage['group_tree'] = og_forums_get_tree(og_forums_get_vid(), $manage['group_tid'], 0);

    $manage['i'] = 1;
    if ($manage['group_tree']) {
      foreach ($manage['group_tree'] as $term) {
        $manage['term'] = $term;
        $manage['term_link'] = l(check_plain($term->name), "forum/$term->tid");

        $manage['i']++;

        // We're looking at a container.
        if (in_array($term->tid, variable_get('forum_containers', array())) && !isset($term->default)) {
          // Build the container row.
          $rows[] = _og_forums_manage_row($manage, 'container');
          $manage['i']--;
        }
        // We're looking at a forum, not a container.
        elseif (!in_array($term->tid, variable_get('forum_containers', array()))) {
          // Build the forum row.
          $manage['default_container_yn'] = NULL;
          $rows[] = _og_forums_manage_row($manage, 'forum');
        }
      }
    }

    $content .= theme('table', $header, $rows);
  }

  return $content;
}

/**
 * Helper funtion to build container and forum rows.
 *
 * @see og_forums_manage()
 *
 * @param $manage
 *   An associative array contain the following parameters:
 *   - 'limit_reached'
 *     The quota status to add forums.
 *   - 'default_container_yn'
 *     Status to use groups forums default container.
 *   - 'all_tids'
 *     An associative array contains terms with their public status.
 *   - 'group'
 *     An group node object.
 *   - 'term'
 *     An term object.
 *   - 'term_link'
 *     HTML formatted link to forum.
 *   - 'i'
 *     An counter value.
 * @param $op Possible values:
 *   - 'container'
 *   - 'forum'
 * @return
 *   An array contain the table cell values of an row.
 */
function _og_forums_manage_row($manage, $op) {
  global $user;

  $public_link = l(t('make public'), 'og_forums/manage/public/'. $manage[group]->nid. '/'. $manage[term]->tid, array('attributes' => array('title' => t('Current Status: Private'))));
  $private_link = l(t('make private'), 'og_forums/manage/private/'. $manage[group]->nid .'/'. $manage[term]->tid, array('attributes' => array('title' => t('Current Status: Public'))));
  $reset_link = l(t('reset publicity'), 'og_forums/manage/reset/'. $manage[group]->nid .'/'. $manage[term]->tid, array('attributes' => array('title' => t('Reset to default'))));

  switch($op) {
    case 'container':
      if ($manage['i'] > 1) {
        // The limit for the number of forums allowed was reached.
        if ($manage['forum_limit_reached']) {
          if (isset($manage['default_container_yn'])) {
            // Hide or display the quota message.
            if ($manage['display_quota_message'] == 0) {
              $operation = array('data' => '', 'colspan' => '4');
            }
            else {
              $operation = array('data' => t('It is reached the maximum allowed number of forums for groups.'), 'colspan' => '4');
            }
          }
        }
        // The limit on the number of forums has not been reached, or there is no limit.
        else {
          if (!isset($manage['default_container_yn'])) {
            $parent = $manage['term']->parents[0];
            $operation = array('data' => '', 'colspan' => '3');
          }
          else {
            // Hide or display add forum link.
            if ($manage['display_add_link'] == 0 && !user_access('administer forums')) {
              $operation = array('data' => '', 'colspan' => '3');
            }
            else {
              $parent = $manage['term']->tid;
              $operation = array('data' => l(t('add forum'), 'og_forums/manage/add/'. $manage[group]->nid .'/'. $parent), 'colspan' => '3');
            }
          }
        }
      }
      else {
        // The limit for the number of forums allowed was reached.
        if ($manage['forum_limit_reached']) {
          if ($manage['term']->parents[0] == 0 || $manage['term']->parents[0] == $manage['default_container']) {
            // Hide or display the quota message.
            if ($manage['display_quota_message'] == 0) {
              $operation = array('data' => '', 'colspan' => '4');
            }
            else {
              $operation = array('data' => t('You have reached the maximum allowed number of forums for groups.'), 'colspan' => '4');
            }
          }
          else {
            $operation = array('data' => '', 'colspan' => '3');
          }
        }
        // The limit on the number of forums has not been reached, or there is no limit.
        else {
          if ($manage['term']->parents[0] == 0 || $manage['term']->parents[0] == $manage['default_container']) {
            // Hide or display add forum link.
            if ($manage['display_add_link'] == 0 && !user_access('administer forums')) {
              $operation = array('data' => '', 'colspan' => '3');
            }
            else {
              $parent = $manage['term']->tid;
              $operation = array('data' => l(t('add forum'), 'og_forums/manage/add/'. $manage[group]->nid .'/'. $parent), 'colspan' => '3');
            }
          }
          else {
            $operation = array('data' => '', 'colspan' => '');
          }

        }
      }

      $row = array(str_repeat('-', $manage['term']->depth) .' '. check_plain($manage['term']->name), $operation);
      break;

    case 'forum':
      // It's presently private.
      if ((user_access('make forums public') && $manage['allow_public'] == 1) && $manage['all_tids'][$manage['term']->tid] < PUBLIC_AUTO) {
        $row = array(str_repeat('-', $manage['term']->depth) .' '. $manage['term_link'], l(t('edit forum'), 'og_forums/manage/edit/'. $manage[group]->nid .'/'. $manage[term]->tid), $public_link, $reset_link);
      }
      // It's presently public.
      elseif ((user_access('make forums public') && $manage['allow_public'] = 1) && $manage['all_tids'][$manage['term']->tid] > PRIVATE_BY_GROUP_OWNER) {
        $row = array(str_repeat('-', $manage['term']->depth) .' '. $manage['term_link'], l(t('edit forum'), 'og_forums/manage/edit/'. $manage[group]->nid .'/'. $manage[term]->tid), $private_link, $reset_link);
      }
      elseif (user_access('administer forums')) {
        $row = array(str_repeat('-', $manage['term']->depth) .' '. $manage['term_link'], l(t('edit forum'), 'og_forums/manage/edit/'. $manage[group]->nid .'/'. $manage[term]->tid), $private_link, $reset_link);
      }
      else {
        $row = array(str_repeat('-', $manage['term']->depth) .' '. $manage['term_link'], l(t('edit forum'), 'og_forums/manage/edit/'. $manage[group]->nid .'/'. $manage[term]->tid));
      }
      break;
  }

  return $row;
}

/**
 * Provide the form to allow group managers toggle the forums availability.
 *
 * @see og_forums_manage()
 *
 * @return
 *   The form array.
 */
function og_forums_forum_availability($form_state) {
  global $user;

  $nid = arg(2);
  $node = node_load($nid);
  $group_user = user_load(array('uid' => $node->uid));
  if (isset($group_user->og_forums)) {
    if (array_key_exists($nid, $group_user->og_forums)) {
      $availability = $group_user->og_forums[$nid];
    }
    else {
      $availability = TRUE;
    }
  }
  else {
    $availability = TRUE;
  }

  if ($availability == TRUE) {
    $submit_value = t('Deactivate availability');
    $description = t('Here you can deactivate the forum function for this group.');
    $description .= ' '. t('Existing containers or forums and their topics will not be deleted - they are no longer reachable.');
    $collapsed = TRUE;
  }
  else {
    $submit_value = t('Activate availability');
    $description = t('Here you can activate the forum function for this group.');
    $collapsed = FALSE;
  }

  $form = array();

  $form['availability'] = array(
    '#type' => 'fieldset',
    '#title' => t('Availability of forums'),
    '#description' => $description,
    '#collapsible' => TRUE,
    '#collapsed' => $collapsed,
  );
  $form['availability']['availability_value'] = array(
    '#type' => 'value',
    '#default_value' => TRUE ? $availability == FALSE : TRUE,
  );
  $form['availability']['uid'] = array(
    '#type' => 'value',
    '#default_value' => $node->uid,
  );
  $form['availability']['nid'] = array(
    '#type' => 'value',
    '#default_value' => $node->nid,
  );
  $form['availability']['submit'] = array(
    '#type' => 'submit',
    '#value' => $submit_value,
  );
  $form['#submit'][] = 'og_forums_forum_availability_submit';

  return $form;
}

/**
 * Submit callback.
 *
 * Saves availability of the forums from a group in the user object of the group manager.
 *
 * @see og_forums_forum_availability()
 *
 * @todo
 * In place of the user object using the database table og_terms to save the groups forums availability.
 */
function og_forums_forum_availability_submit($form, &$form_state) {
  $group_user = user_load(array('uid' => $form_state['values']['uid']));
  $group_user->og_forums[$form_state['values']['nid']] = $form_state['values']['availability_value'];

  user_save($group_user, array('og_forums' => $group_user->og_forums));
}

/**
 * Select the right form to display.
 *
 * @see og_forums_forum_get_parent()
 *
 * @param $type Possible values:
 * - 'add' Add an forum.
 * - 'edit' Edit an forum.
 * @param $group_id
 *   An group ID.
 * @param $tid
 *   An term ID.
 * @return
 *   2 different forms:
 *   - Confirmation form
 *   - Add/edit form
 */
function og_forums_form_main($type, $group_id, $tid) {
  $parent_term = og_forums_forum_get_parent($tid);

  $edit = array('group_id' => $group_id, 'parent' => $parent_term->tid);

  if ($_POST['op'] == t('Delete') || $_POST['confirm']) {
    return drupal_get_form('og_forums_confirm_delete', $tid, $group_id);
  }

  switch ($type) {
    case 'add':
      $group_id = $edit['group_id'];

      return drupal_get_form('og_forums_form_forum', $edit, $group_id, $edit['tid']);

    case 'edit':
      $group_id = $edit['group_id'];
      $group = node_load($group_id);
      $term = taxonomy_get_term($tid);
      $term->parent = $parent_term->tid;
      $term->group_id = $group_id;
      $edit = (array)$term;

      return drupal_get_form('og_forums_form_forum', $edit, $group_id, $tid);
  }
}

/**
 * Using the term ID, set the group context.
 *
 * @see og_forums_nodeapi()
 * @see og_forums_comment()
 * @see og_forums_form_alter()
 * @see og_forums_access_forum_page()
 */
function og_forums_set_og_group_context_from_tid($tid = 0) {
  $sql = "SELECT nid FROM {og_terms} WHERE tid = %d";

  if ($gid = db_result(db_query($sql, $tid))) {
    $group_node = node_load($gid);
    og_set_group_context($group_node);
  }
}

/**
 * Using the term ID, get the group ID.
 *
 * @see og_forums_preprocess_forums()
 *
 * @param $tid
 *   An term ID.
 * @return
 *   An group ID or 0.
 */
function og_forums_gid_from_tid($tid = 0) {
  $sql = "SELECT nid FROM {og_terms} WHERE tid = %d";

  if ($gid = db_result(db_query($sql, $tid))) {
    return $gid;
  }
  else {
    return 0;
  }
}

/**
 * Using the group ID, get the term ID.
 *
 * The requested term id is the id of the groups name term - the container of the group.
 *
 * @see _og_forums_parent_select()
 *
 * @param $gid
 *   An group ID.
 * @return
 *   An term ID or 0.
 */
function og_forums_tid_from_gid($gid) {
  $sql = "SELECT MIN(tid) FROM {og_terms} WHERE nid = %d";

  if ($tid = db_result(db_query($sql, $gid))) {
    return $tid;
  }
  else {
    return 0;
  }
}

/**
 * Implementation of hook_db_rewrite_sql().
 */
function og_forums_db_rewrite_sql($query, $primary_table = 'n', $primary_field = 'nid', $args = array()) {
  global $user;

  if ($primary_field == 'tid') {
    if (arg(0) == 'forum') {
      if (user_access('administer forums') || (!module_exists('og_access') || variable_get('og_forums_all_public', 0))) {
        return;
        // On forum* paths, filter terms by og_forums_is_public() and the user's
        // group memberships via {og_terms} relationships.
      }
      else {
        $return['join'] = "LEFT JOIN {og_terms} ogt ON ogt.tid = t.tid";

        // Either the forum is unconfigured or public.
        $return['where'] = "ogt.public IS NULL OR ogt.public > ". PRIVATE_BY_GROUP_OWNER;

        // Or the user is member of the group associated with the forum.
        if (!empty($user->og_groups)) {
          $return['where'] .= " OR ogt.nid IN (". implode(',', array_keys($user->og_groups)) .")";
        }

        return $return;
      }
    }

    if (arg(0) == 'node' && arg(1) == 'add' && arg(2) == 'forum' && empty($_GET['gids'])) {
      $return['join'] = "LEFT JOIN {og_terms} ogt ON t.tid = ogt.tid";
      $return['where'] = "ogt.nid IS NULL";

      if ($og_forums_container = variable_get('og_forums_default_container', FALSE)) {
        $return['where'] .= " AND t.tid != $og_forums_container";
      }
      $return['distinct'] = TRUE;

      return $return;
    }
  }
}

/**
 * Implementation of hook_nodeapi().
 *
 * Automatically creates a forum container and forum each time an organic group is added.
 *
 * @ee og_forums_set_og_group_context_from_tid()
 * @see og_forums_manage_terms()
 * @see og_forums_get_group_forums()
 * @see og_forums_gid_from_tid()
 * @see og_forums_retroactively_apply()
 *
 * @warning
 * The Opera browser can not be used! If this browser adds new groups, there are mistakes: Group nodes are created double or triple.
 * In consequence of which the terms of the taxonomy created will be double or triple.
 *
 * @todo
 * Operator 'delete', action group forum availability:
 * In place of the user object using the database table og_terms to manage the groups forums availability.
 */
function og_forums_nodeapi(&$node, $op, $teaser = NULL, $page = NULL) {
  switch ($op) {
    case 'load':
      if ($node->type == 'forum' && $og_forums_nid = db_result(db_query('SELECT nid FROM {og_terms} WHERE tid = %d', $node->tid))) {
        $node->og_forums_nid = $og_forums_nid;
      }
      break;

    case 'prepare':
      if (arg(0) == 'node' && arg(1) == 'add' && arg(2) == 'forum' && arg(3)) {
        if (!og_get_group_context()) {
          og_forums_set_og_group_context_from_tid(arg(3));
          //return FALSE;
        }
      }
      break;

    case 'insert':

      if (og_is_group_type($node->type)) {
        og_clear_group_context();

        $default_container_yn = variable_get('og_forums_default_container_yn', TRUE);
        if ($default_container_yn == FALSE) {
          module_invoke('og_forums', 'manage_terms', $node, 'og_forums_default_container_yn_yes');

          cache_clear_all();
        }
        else {
          module_invoke('og_forums', 'manage_terms', $node, 'og_forums_default_container_yn_no');

          cache_clear_all();
        }
      }

      // If the node is marked public, check the 'puclicity' settings and act accordingly
      // setup variables for common operations.
      if ($node->type == 'forum') {
        $sql = "SELECT tid, public FROM {og_terms} WHERE nid = %d";
        $container = og_forums_get_forum_container($node->og_groups[0]);
        $gid = og_forums_gid_from_tid($node->tid);
        $results = db_query($sql, $gid);

        while ($result = db_fetch_object($results)) {
          $forums[$result->tid] = $result->public;
        }
        $sql2 = "UPDATE {og_terms} SET public = %d WHERE tid = %d";

        // Can we set the forum to public.
        if ($node->og_public == PRIVATE_BY_GROUP_OWNER) {
          // The container isn't locked at private by group owner, and the forum is in an auto-settable state.
          if ($forums[$node->tid] == PRIVATE_DEFAULT && $forums[$container] != PRIVATE_BY_GROUP_OWNER) {
            db_query($sql2, PUBLIC_AUTO, $node->tid);
            if ($forums[$container] == PRIVATE_DEFAULT) {
              db_query($sql2, PUBLIC_AUTO, $container);
            }
          }
        }
        // Can we set the forum private.
        elseif ($node->og_public == PRIVATE_DEFAULT) {
          // The forum is in an auto settable state.
          if ($forums[$node->tid] == PUBLIC_AUTO) {
            $should_be_public = FALSE;
            $sql3 = "SELECT DISTINCT COUNT(oap.nid) FROM {node} n
                     INNER JOIN {og_access_post} oap ON oap.nid = n.nid
                     INNER JOIN {term_node} tn ON tn.nid = oap.nid
                     WHERE n.type = 'forum' AND oap.og_public = 1 AND tn.tid = %d";

            if (!$count = db_result(db_query($sql3, $node->tid))) {
              db_query($sql2, PRIVATE_DEFAULT, $node->tid);
              foreach ($forums as $tid => $public) {
                if ($count = db_result(db_query($sql3, $tid))) {
                  $should_be_public = TRUE;
                }
              }
              // All forums' posts are private in this container and the container is in an auto-settable state.
              if (!$should_be_public && $forums[$container] == PUBLIC_AUTO) {
                db_query($sql2, PRIVATE_DEFAULT, $container);
              }
            }
          }
        }
      }
      break;

    case 'update':
      // Make sure if the group's title has changed, the title of it's root forum is updated as well.
      if (og_is_group_type($node->type)) {
        // Check group forum exists.
        $group_forums = og_forums_get_group_forums($node->nid, 'forum');
        // Does not exist a group forum, then it is now created.
        // This is the same as when creating a new group.
        if (count($group_forums) == 0) {
          $default_container_yn = variable_get('og_forums_default_container_yn', TRUE);
          if ($default_container_yn) {
            module_invoke('og_forums', 'manage_terms', $node, 'og_forums_default_container_yn_yes');
          }
          else {
            module_invoke('og_forums', 'manage_terms', $node, 'og_forums_default_container_yn_no');
          }
        }

        $tid = db_result(db_query('SELECT tid FROM {og_terms} WHERE nid = %d', $node->nid));
        if ($tid) {
          $term = taxonomy_get_term($tid);
          $term->parents = taxonomy_get_parents($tid);
          $term->parent = array_keys($term->parents);
          $term->name = $node->title;

          // Will have any other modules update the term's URL aliases.
          taxonomy_save_term($term);
        }
      }
      // If the node is marked public, check the 'puclicity' settings and act accordingly
      // setup variables for common operations.
      elseif ($node->type == 'forum') {
        $sql = "SELECT tid, public FROM {og_terms} WHERE nid = %d";
        $container = og_forums_get_forum_container($node->og_groups[0]);
        $gid = og_forums_gid_from_tid($node->tid);
        $results = db_query($sql, $gid);

        while ($result = db_fetch_object($results)) {
          $forums[$result->tid] = $result->public;
        }
        $sql2 = "UPDATE {og_terms} SET public = %d WHERE tid = %d";

        // Can we set the forum to public.
        if ($node->og_public == 1) {
          // The container isn't locked at private by group owner, and the forum is in an auto-settable state.
          if ($forums[$node->tid] == PRIVATE_DEFAULT && $forums[$container] != PRIVATE_BY_GROUP_OWNER) {
            db_query($sql2, PUBLIC_AUTO, $node->tid);
            if ($forums[$container] == PRIVATE_DEFAULT) {
              db_query($sql2, PUBLIC_AUTO, $container);
            }
          }
        }
        // Can we set the forum private.
        elseif ($node->og_public == 0) {
          // The forum is in an auto settable state.
          if ($forums[$node->tid] == PUBLIC_AUTO) {
            $should_be_public = FALSE;
            $sql3 = "SELECT DISTINCT COUNT(oap.nid) FROM {node} n
                     INNER JOIN {og_access_post} oap ON oap.nid = n.nid
                     INNER JOIN {term_node} tn ON tn.nid = oap.nid
                     WHERE n.type = 'forum' AND oap.og_public = 1 AND tn.tid = %d";
            if (!$count = db_result(db_query($sql3, $node->tid))) {
              db_query($sql2, PRIVATE_DEFAULT, $node->tid);

              foreach ($forums as $tid => $public) {
                if ($count = db_result(db_query($sql3, $tid))) {
                  $should_be_public = TRUE;
                }
              }

              // All forums' posts are private in this container and the container is in an auto-settable state.
              if (!$should_be_public && $forums[$container] == PUBLIC_AUTO) {
                db_query($sql2, PRIVATE_DEFAULT, $container);
              }
            }
          }
        }
      }
      break;

    case 'delete':
      // Delete existing terms for this og.
      if (!user_access('delete own groups forums')) {
        return;
      }

      if (og_is_group_type($node->type)) {
        $result = db_query('SELECT tid FROM {og_terms} WHERE nid = %d', $node->nid);

        // Check group forum availability, configured by group manager.
        // Delete the availability setting in the user object for the deleted group node.
        $group_user = node_load(array('uid' => $node->uid));
        if (isset($group_user->og_forums) && count($group_user->og_forums)) {
          if (array_key_exists($node->nid, $group_user->og_forums)) {
            unset($group_user->og_forums[$node->nid]);

            user_save($group_user, $group_user->og_forums);
          }
        }

        while ($term = db_fetch_object($result)) {
          taxonomy_del_term($term->tid);
        }
        db_query('DELETE FROM {og_terms} WHERE nid = %d', $node->nid);

        og_clear_group_context();

      }
      break;

    case 'view':
      // Don't do anything when handling teasers.
      if ($teaser) {
        break;
      }
      // If we're viewing a forum post in a group forum, set that
      // group as the context.
      if ($page && !empty($node->og_groups) && $node->type == 'forum') {
      //if ($page && empty($node->og_groups)) {
        og_set_group_context(node_load($node->og_groups[0]));

        if (is_numeric($node->tid)) {
          $tid = $node->tid;
        }
        // Breadcrumb navigation:
        global $_menu;
        if (og_get_group_context()) {
        _og_forums_set_breadcrumb($tid);
        }

        drupal_set_title(check_plain($node->title));
      }

      // If there are no groups forums exist show a message.
      if ($page && empty($node->og_groups) && $node->type == 'group') {
        // Check groups forums.
        $forums  = og_forums_get_group_forums($node->nid);
        // Display different messages.
        if (count($forums) == 0) {
          if ((og_forums_is_admin($node) && user_access('admin own groups forums')) || user_access('administer forums')) {
            $edit_path = "node/$node->nid/edit";
            $message = _og_forums_no_forums_message('manager', $edit_path);
          }
          else {
            $user_path = "user/$node->uid";
            $message = _og_forums_no_forums_message('member', $user_path);
          }

          drupal_set_message($message);
        }
      }
      break;

    case 'presave':
      if ($node->type == 'forum') {
        $gid = og_forums_gid_from_tid($node->tid);
        $node->og_groups = array();
        $node->og_groups[$gid] = $gid;
        $node->og_groups = array_filter($node->og_groups);
        $node->og_groups = array_keys($node->og_groups);
      }
      break;
  }
}

/**
 * Manage terms and access templates.
 * - Save taxonomy terms.
 * - Save OGFR terms.
 * - Save OGFR forum access templates.
 *
 * @see og_forums_nodeapi()
 * @see og_forums_get_vid()
 * @see _og_forums_clean_forum_names()
 *
 * @param $node
 *   An node object.
 * @param $op Possible values:
 *   - 'og_forums_default_container_yn_yes'
 *   - 'og_forums_default_container_yn_no'
 */
function og_forums_manage_terms(&$node, $op) {
  switch ($op) {
    case 'og_forums_default_container_yn_yes':

      $edit = array('name' => $node->title, 'vid' => og_forums_get_vid());
      $default_container = variable_get('og_forums_default_container', 0);
      $edit['parent'] = array($default_container);

      unset($edit['parent']);

      $status = taxonomy_save_term($edit);

      if ($edit['tid'] == 0) {
        module_invoke('og_terms', 'error', $edit['tid'], $node->nid, $edit['title']);
      }

      db_query('INSERT INTO {og_terms} (tid, nid) VALUES (%d, %d)', $edit['tid'], $node->nid);

      $containers = variable_get('forum_containers', array());
      $containers[] = $edit['tid'];
      variable_set('forum_containers', $containers);

      // Make access template when a new group is created.
      if (variable_get('og_forums_access_template', 1) == 1) {
        $tpl_settings_container = variable_get('og_forums_access_template_container', _og_forums_access_template_container_default());
        $tpl_settings_forum = variable_get('og_forums_access_template_forum', _og_forums_access_template_forum_default());
        $grant = array_merge($tpl_settings_container, $tpl_settings_forum);

        og_forums_access_template($edit['tid'], $grant, 'insert');
      }

      break;

    case 'og_forums_default_container_yn_no':
      // Get access template settings.
      if (variable_get('og_forums_access_template', 1) == 1) {
        $tpl_settings_container = variable_get('og_forums_access_template_container', _og_forums_access_template_container_default());
        $tpl_settings_forum = variable_get('og_forums_access_template_forum', _og_forums_access_template_forum_default());
        $grant = array_merge($tpl_settings_container, $tpl_settings_forum);
      }

      // Added functionality to allow for the creation of multiple forums/containers
      // when a new group is created.
      // To use, change the default forum nam in og_forums administation to a semicolon seperated entry
      // e.g. Forum 1;Forum 2;Forum 3
      // Use C for new container, P for the previous container, R to return to the root container.
      // Structure example: Forum 1;C;Container 2;Forum 2;C;Container 3;Forum 3;R;Forum 4
      //
      //  - Group Name Container
      //  - Forum 1
      //  - Container 2
      //  --- Forum 2
      //  --- Container 3
      //  ---- Forum 3
      //  - Forum 4
      //
      // NOTE: Weights are used to keep the ordering correct.
      // 2-19-2008 Josh Cohen
      // Updated 3-13-2008 - Added ability to use descriptions. Follow the container or
      // forum number by a comma, then decription. e.g. Forum 3, This is a description;Forum 4
      //

      // Setup main container.

      // Check setting for "og_forums_default_container".
      $og_forums_default_container = variable_get('og_forums_default_container', 0);
      if ($og_forums_default_container && $og_forums_default_container != -1) {
        $parent = $og_forums_default_container;
      }
      else {
        $parent = NULL;
      }

      // Check configured public status.
      $public = 0;
      $auto_public = variable_get('og_forums_auto_public', 0);
      if ($auto_public == 1) {
        $public = PUBLIC_AUTO;
      }

      $edit = array('name' => $node->title, 'vid' => og_forums_get_vid(), 'parent' => $parent);

      $status = taxonomy_save_term($edit);

      if ($edit['tid'] == 0) {
        module_invoke('og_terms', 'error', $edit['tid'], $node->nid, $edit['title']);
      }

      $containers = variable_get('forum_containers', array());
      $containers[] = $edit['tid'];
      variable_set('forum_containers', $containers);

      db_query('INSERT INTO {og_terms} (tid, nid, public) VALUES (%d, %d, %d)', $edit['tid'], $node->nid, $public);
      og_forums_access_template($edit['tid'], $grant, 'insert');

      // Start multiple forum code change.
      // 2-19-2008 Josh Cohen
      $curr_container = $edit['tid'];
      $root_container = $curr_container;

      // Taxonomy_save_term will give us new tids.
      unset($edit['tid']);
      $default_forum_names = variable_get('og_forums_default_name', 'General discussion;Other');

      // Return default forum names as an array.
      $default_forum_names = _og_forums_clean_forum_names($default_forum_names);
      $forum_names = explode(';', $default_forum_names);
      $is_container = 0;

      // To keep track of the container sequence.
      $c_order = array($root_container);
      $weight_indx = -10;

      foreach ($forum_names as $fvalue) {
        switch(strtoupper($fvalue)) {
          case 'C': // Create new container.
            $is_container = 1;
            break;

          case 'P': // Go to previous container.
            // Delete current container.
            if (end($c_order) != $root_container){
              array_pop($c_order);
            }
            // Set current container.
            $curr_container = end($c_order);
            $is_container = 0;
            break;

          case 'R': // Go to the root container.
            unset($c_order);
            $c_order = array($root_container);
            $curr_container = $root_container;
            $is_container = 0;
            break;

          default:
            if ($is_container === 1) {
              // Add new container.
              // Break out name and description.
              $forum_names = explode(',', $fvalue);
              if (count($forum_names) == 2) {
                $fname = $forum_names[0];
                $fdesc = $forum_names[1];
              }
              else {
                $fname = $forum_names[0];
                unset($fdesc);
              }

              $edit = array('name' => $fname, 'vid' => og_forums_get_vid(), 'parent' => $curr_container, 'weight' => $weight_indx, 'description' => $fdesc);

              $status = taxonomy_save_term($edit);

              if ($edit['tid'] == 0) {
                module_invoke('og_terms', 'error', $edit['tid'], $node->nid, $edit['title']);
              }

              $containers[] = $edit['tid'];

              variable_set('forum_containers', $containers);
              $curr_container = $edit['tid'];

              db_query('INSERT INTO {og_terms} (tid, nid, public) VALUES (%d, %d, %d)', $edit['tid'], $node->nid, $public);
              og_forums_access_template($edit['tid'], $grant, 'insert');

              // Add the new container to our index.
              $c_order[] = $edit['tid'];
              unset($edit['tid']);
              unset($edit['parent']);
              $is_container = 0;
              $weight_indx = $weight_indx + 1;
            }
            else {
              // Add new forum.
              // Break out name and description.
              $forum_names = explode(',', $fvalue);
              if (count($forum_names) == 2){
                $fname = $forum_names[0];
                $fdesc = $forum_names[1];
              }
              else {
                $fname = $forum_names[0];
                unset($fdesc);
              }

              $edit['name'] = $fname;
              $edit['description'] = $fdesc;
              $edit['parent'] = $curr_container;
              $edit['weight'] = $weight_indx;

              $status = taxonomy_save_term($edit);

              if ($edit['tid'] == 0) {
                module_invoke('og_terms', 'error', $edit['tid'], $node->nid, $edit['title']);
              }

              db_query('INSERT INTO {og_terms} (tid, nid, public) VALUES (%d, %d, %d)', $edit['tid'], $node->nid, $public);
              og_forums_access_template($edit['tid'], $grant, 'insert');

              // Clear term so taxonomy_save_term() will generate a new term on next iteration.
              unset($edit['tid']);
              $is_container = 0;
              $weight_indx = $weight_indx + 1;
             }
             break;
        }
      }

      // Clean up variables.
      unset($forum_names);
      unset($c_order);
      // End Multiple forum code change.
      // 2-19-2008 Josh Cohen

      break;
  }
}

/**
 * Implementation of hook_comment().
 */
function og_forums_comment(&$a1, $op) {
  $nid = $a1->nid;
  $node = node_load($nid);

  if (is_numeric($node->tid)) {
    $tid = $node->tid;
    og_forums_set_og_group_context_from_tid($tid);
    $gid = og_forums_gid_from_tid($tid);
    if ($gid) {
      og_set_theme($gid);
      $group_node = node_load($gid);
      og_set_language($group_node);
    }

    _og_forums_set_breadcrumb($tid, TRUE);
  }
}

/**
 * Retrieve container for given group.
 *
 * @param $gid
 *   Organic group ID.
 * @return
 *   Forum container's term ID.
 */
function og_forums_get_forum_container($gid) {
  // If it exists, grab the first term created for group; this will be the forum container; if not, it is a forum inside a generic container; find it
  return db_result(db_query_range('SELECT tid FROM {og_terms} WHERE nid = %d ORDER BY tid ASC', $gid, 0, 1));
}

/**
 * Check if a user is a group manager of the given group.
 *
 * @param $group
 *   The node object of a group.
 * @return
 *   TRUE or FALSE.
 */
function og_forums_is_admin($group) {
  global $user;

  $result = db_query(og_list_users_sql(0), $group->nid);
  while ($row = db_fetch_object($result)) {
    if ($user->uid == 1 && user_access('administer forums')) {
      return TRUE;
    }
    if ($row->uid == $user->uid) {
      if ($row->is_admin > 0) {
        return TRUE;
      }
    }
  }
  return FALSE;
}

/**
 * Implementation of hook_og_create_links().
 *
 * Create additional OG Forums links to display in the OG administer block.
 *
 * @return
 *   An array contains the links.
 */
function og_forums_og_create_links($group) {
  global $user;

  // Get group's forum.
  $forum  = og_forums_get_forum_container($group->nid);
  $links = array();
  if ($forum) {
    $node = node_load($group->nid);
    $group_user = user_load(array('uid' => $node->uid));

    // Check group forum availability, configured by group manager.
    $availability = module_invoke('og_forums', 'get_forums_availability', $node, $group_user);
    if ($availability == TRUE) {
      $links[] = l(t('Groups forums'), "forum/$forum", array('attributes' => array('title' => t('View group forum discussions.'))));
    }

    // Add forum manage link for the group managers.
    if ((og_forums_is_admin($group) && user_access('admin own groups forums')) || user_access('administer forums')) {
      $links[] = l(t('Manage groups forums'), "og_forums/manage/$group->nid", array('attributes' => array('title' => t('Let you create, edit or delete group\'s forums.'))));
    }
  }

  return $links;
}

/**
 * Creates forums for all groups that don't have any yet.
 *
 * @see og_forums_nodeapi()
 */
function og_forums_retroactively_apply() {
  // Obtain list of all groups.
  $result = db_query('SELECT og.nid, n.title, n.type FROM {og} og INNER JOIN {node} n on og.nid = n.nid');

  $counter = 0;
  while ($group = db_fetch_object($result)) {
    // See if terms are found for this group.
    if (!db_result(db_query('SELECT * FROM {og_terms} ogt WHERE ogt.nid = %d', $group->nid))) {
      // If not, fake a nodeapi insert.
      og_forums_nodeapi($group, 'insert');
      $counter++;
    }
  }

  drupal_set_message(t('%num groups had forums created', array('%num' => $counter)));
}

/**
 * Provide the forum creation form.
 *
 * @see _og_forums_manage_breadcrumb()
 * @see _og_forums_parent_select()
 * @see og_forums_is_public()
 * @see og_forums_get_vid()
 *
 * @return
 *   The form array.
 */
function og_forums_form_forum(&$form_state, $edit, $gid = 0, $tid = 0) {
  $node = node_load($gid);
  og_set_language($node);
  og_set_theme($gid);

  if (!$edit['tid']) {
   $tid = $edit['parent'];
  }

  $edit += array(
    'name' => '',
    'description' => '',
    'tid' => NULL,
    'weight' => 0,
  );

  $form['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Forum name'),
    '#default_value' => $edit['name'],
    '#maxlength' =>  64,
    '#description' => t('The forum name is used to identify related discussions.'),
    '#required' => TRUE,
  );
  $form['description'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => $edit['description'],
    '#description' => t('The forum description can give users more information about the discussion topics it contains.'),
  );

  $form['parent']['#tree'] = TRUE;

  if (arg(2) == 'add') {
    _og_forums_manage_breadcrumb(node_load($gid), 'add');

    $parents = taxonomy_get_parents_all($edit['tid']);

    $form['parent'][0] = _og_forums_parent_select($edit['tid'], t('Parent'), 'forum', $gid);
    $form['weight'] = array(
      '#type' => 'weight',
      '#title' => t('Weight'),
      '#default_value' => $edit['weight'],
      '#description' => t('Forums are displayed in ascending order by weight (forums with equal weights are displayed alphabetically).'),
    );
  }
  else {
    _og_forums_manage_breadcrumb(node_load($gid), 'edit');

    $parents = taxonomy_get_parents_all($edit['tid']);

    $form['parent'][0] = _og_forums_parent_select($edit['tid'], t('Parent'), 'forum', $gid);
    $form['weight'] = array(
      '#type' => 'weight',
      '#title' => t('Weight'),
      '#default_value' => $edit['weight'],
      '#description' => t('Forums are displayed in ascending order by weight (forums with equal weights are displayed alphabetically).'),
    );
  }

  $form['group_id'] = array(
    '#type' => 'value',
    '#value' => $gid,
  );
  $form['weight'] = array(
    '#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $edit['weight'],
    '#description' => t('When listing forums, those with lighter (smaller) weights get listed before containers with heavier (larger) weights. Forums with equal weights are sorted alphabetically.'),
  );

  $allow_public = variable_get('og_forums_allow_public', 0);
  if (($allow_public == 1 && (user_access('make forums public')) || user_access('administer forums'))) {
    $default_public = og_forums_is_public($tid);

    $form['make_public'] = array(
      '#type' => 'checkbox',
      '#title' => t('Make forum public'),
      '#description' => t('This will allow non-group members to <em>view</em> this forum.'),
      '#default_value' => 1 ? $default_public > 0 : 0,
    );
  }

  $form['vid'] = array(
    '#type' => 'hidden',
    '#value' => og_forums_get_vid(),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
  );

  if ($edit['tid']) {
    if (user_access('delete own groups forums') || user_access('administer forums')) {
      $form['delete'] = array(
        '#type' => 'submit',
        '#value' => t('Delete'),
      );
    }
    $form['tid'] = array(
      '#type' => 'hidden',
      '#value' => $edit['tid'],
    );
  }

  $form['#submit'][] = 'og_forums_form_submit';
  $form['#validate'][] = 'og_forums_form_validate';

  return $form;
}

/**
  * Validate group id, default container and term id values.
  *
  * @see og_forums_form_forum()
  */
function og_forums_form_validate($form, &$form_state) {
  global $user;

  $error = TRUE;

  $default_container = variable_get('og_forums_default_container', -1);

  if (is_numeric($form_state['values']['group_id'])) {
    $group = node_load($form_state['values']['group_id']);

    // Check that the user is the manager.
    // Check that an new forum is in default forum container or
    // that an new forum is in exist parent forum.
    if ($group && og_forums_is_admin($group) && (in_array($form_state['values']['parent'][0], _og_forums_ogterms($group)) || $form_state['values']['tid']) ||
        $group && og_forums_is_admin($group) && ($form_state['values']['parent'][0] == $default_container)
       ) {
      $error = FALSE;
    }
  }

  // Stop insertion if we found invalid values.
  if ($error) {
    form_set_error('name', t('Internal error processing your data. Please contact website administrators.'));
  }
}

/**
 * Store created/updated forum on the database.
 *
 * @see og_forums_form_forum()
 */
function og_forums_form_submit($form, &$form_state) {
  $gid = $form_state['values']['group_id'];

  $container = false;
  $type = t('forum');
  $status = taxonomy_save_term($form_state['values']);

  switch ($status) {
    case SAVED_NEW:
      if ($container) {
        $containers = variable_get('forum_containers', array());
        $containers[] = $form_state['values']['tid'];
        variable_set('forum_containers', $containers);
      }
      drupal_set_message(t('Created new !type %term.', array('%term' => $form_state['values']['name'], '!type' => $type)));
      break;

    case SAVED_UPDATED:
      drupal_set_message(t('The !type %term has been updated.', array('%term' => $form_state['values']['name'], '!type' => $type)));
      break;
  }

  $form_state['redirect'] = "og_forums/manage/$gid";
}

/**
 * Implementation of hook_taxonomy().
 *
 * This should replace og_forums's own management of terms which bypasses regular taxonomy. Using this function allows group
 * forums to be managed both from within the group and at the site-wide forum admin pages.
 *
 * @see og_forums_forum_limit_reached()
 * @see og_forums_forum_access_get_settings()
 * @see og_forums_access_template()
 * @see og_forums_public()
 * @see og_forums_private()
 *
 * @param $op
 *   What is being done to $array. Possible values:
 *   - 'insert'
 *   - 'update'
 *   - 'delete'
 * @param $type
 *   What manner of item $array is. Possible values:
 *   - 'term'
 *   - 'vocabulary'
 * @param $obj
 *   The item on which $op is being performed. Possible values:
 *   - 'update' op: $form_state['values'] from taxonomy_form_term_submit()
 *   - 'delete' op: $term from taxonomy_get_term() cast to an array
 */
function og_forums_taxonomy($op, $type, $obj) {
  switch ($op) {
    case 'insert':
      if (!isset($obj['group_id'])) {
        return;
      }

      $forum_limit_reached = og_forums_forum_limit_reached($obj['group_id']);
      if ($forum_limit_reached) {
        return;
      }

      if (isset($obj['parent'])) {
        $parent = (is_array($obj['parent'])) ? $obj['parent'][0] : $obj['parent'];
        $result = db_result(db_query("SELECT nid FROM {og_terms} WHERE tid = %d", $obj['tid']));

        if ($result) {
          return;
        }
        else {
          if ($obj['make_public'] == 0) {
            $public = 0;
          }
          elseif ($obj['make_public'] == 1) {
            $public = 3;
          }

          db_query('INSERT INTO {og_terms} (tid, nid, public) VALUES (%d, %d, %d)', $obj['tid'], $obj['group_id'], $public);

          // Make access template when a group manager adds a group forum.
          if (variable_get('og_forums_access_template', 1) == 1) {
            $tpl_settings_container = variable_get('og_forums_access_template_container', _og_forums_access_template_container_default());
            $tpl_settings_forum = variable_get('og_forums_access_template_forum', _og_forums_access_template_forum_default());
            $grant = array_merge($tpl_settings_container, $tpl_settings_forum);

            og_forums_access_template($obj['tid'], $grant, 'insert');
          }
        }
      }

      break;

    case 'update':
      if (isset($obj['parent'])) {
        if ($obj['make_public'] == 1) {
          og_forums_public($obj['group_id'], $obj['tid']);
        }
        if ($obj['make_public'] == 0) {
          og_forums_private($obj['group_id'], $obj['tid']);
        }
      }
      break;

    case 'delete':
      if (isset($obj['tid'])) {
        db_query("DELETE FROM {og_terms} WHERE tid = %d", $obj['tid']);
        og_forums_access_template($obj['tid'], array(), 'delete');
      }
      break;
  }
}

/**
 * Create a confirmation form for deleting a forum.
 *
 * @see og_forums_form_main()
 *
 * @param $tid
 *   The ID of the term to be deleted.
 * @param $gid
 *   An group ID.
 * @return
 *   The confirmation form.
 */
function og_forums_confirm_delete($form_state, $tid, $gid) {
  $term = taxonomy_get_term($tid);

  $form['tid'] = array(
    '#type' => 'value',
    '#value' => $tid,
  );
  $form['name'] = array(
    '#type' => 'value',
    '#value' => check_plain($term->name),
  );
  $form['group_id'] = array(
    '#type' => 'value',
    '#value' => $gid,
  );
  $form['return'] = array(
    '#type' => 'value',
    '#value' => 'og_forums/manage/'. arg(3),
  );

  $return_address = 'og_forums/manage/'. arg(3);
  $form = confirm_form($form, t('Are you sure you want to delete the forum %name?', array('%name' => $term->name)), $return_address, t('Deleting a forum or container will delete all sub-forums and associated posts as well. This action cannot be undone.'), t('Delete'), t('Cancel'));

  return $form;
}

/**
 * Implementation of forms api _submit call. Deletes a forum after confirmation.
 *
 * @see og_forums_gid_from_tid()
 */
function og_forums_confirm_delete_submit($form, &$form_state) {
  taxonomy_del_term($form_state['values']['tid']);
  //$group_id = og_forums_gid_from_tid($form_state['values']['tid']);

  drupal_set_message(t('The forum %term and all sub-forums and associated posts have been deleted.', array('%term' => $form_state['values']['name'])));
  watchdog('content', t('forum: deleted %term and all its sub-forums and associated posts.', array('%term' => $form_state['values']['name'])));

  db_query('DELETE FROM {og_terms} WHERE tid = %d', $form_state['values']['tid']);

  $form_state['redirect'] = $form_state['values']['return'];
}

/**
 * Submit callback.
 *
 * @see og_forums_form_alter()
 */
function og_forums_node_delete_confirm_submit($form, &$form_state) {
  $return = 'og';

  $group_view = views_get_view('og');
  if (empty($group_view)) {
    $return = '<front>';
  }

  $form_state['redirect'] = $return;
}

/**
 * Find out if the limit has been reached for groups forums in a particular group.
 *
 * @param $nid
 *   ID of an group.
 * @return
 *   TRUE or FALSE.
 */
function og_forums_forum_limit_reached($nid, $corrector = 1) {
  $forum_limit = variable_get('og_forums_limit_forums', 0);
  if ($forum_limit == 0) {
    return FALSE;
  }

  $forum_containers = variable_get('forum_containers', array());

  $sql = "SELECT tid FROM {og_terms} WHERE nid = %d";
  $results = db_query($sql, $nid);

  $num = 0;
  while ($result = db_fetch_object($results)) {
    if (!in_array($result->tid, $forum_containers)) {
      $num++;
    }
  }

  // Because the container is part of the query result.
  $num_forums = ($num - $corrector);

  if ($num_forums >= $forum_limit) {
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Test whether a tid (forum or container) is public and return results.
 *
 * @param $tid
 *   ID of an term.
 * @return
 *   FALSE or TRUE.
 */
function og_forums_is_public($tid) {
  // The groups forums default container has its own system variable
  // that contains the public status: 'default_container_public_value'.

  $sql = "SELECT tid, public, nid FROM {og_terms} WHERE tid = %d";
  $results = db_fetch_object(db_query($sql, $tid));

  if (!empty($results) && ($results->public <= PRIVATE_BY_GROUP_OWNER)) {
    return FALSE;
  }
  else {
    return TRUE;
  }
}

/**
 * Test whether all tids (forums or container) is public.
 *
 * @return
 *   TRUE or FALSE.
 */
function og_forums_is_public_all($nid) {
  // Public status versions.
  // 0 private by default or admin
  // 1 private by group manager
  // 2 public auto
  // 3 public by group manager

  $sql = "SELECT COUNT(public) AS count FROM {og_terms} WHERE nid = %d AND (public = %d OR public = %d)";
  $result = db_fetch_object(db_query($sql, $nid, PUBLIC_BY_GROUP_OWNER, PUBLIC_AUTO));

  if ($result > 0) {
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Test whether a tid is an OGFR forum.
 *
 * @return
 *   FALSE or TRUE.
 */
function og_forums_is_og_forums($tid) {
  $sql = "SELECT tid FROM {og_terms} WHERE tid = %d";
  $results = db_fetch_object(db_query($sql, $tid));

  if (empty($results)) {
    return FALSE;
  }
  else {
    return TRUE;
  }
}

/**
 * Get the forums vocabulary.
 *
 * @return
 * - The forums vocabulary ID if it exists.
 * - FALSE if the forums vocabulary ID not defined.
 */
function og_forums_get_vid() {
  return variable_get('forum_nav_vocabulary', FALSE);
}

/**
 * Find all ancestors of a given term ID.
 *
 * @return
 *   An array contains the parent terms as term object.
 */
function og_forums_get_parents_all($tid) {
  $parents = array();

  if ($tid) {
    $parents[] = taxonomy_get_term($tid);
    $n = 0;
    while ($parent = taxonomy_get_parents($parents[$n]->tid)) {
      $parents = array_merge($parents, $parent);
      $n++;
    }
    // Remove the given term. A term can't be the parent of itself.
    array_shift($parents);
  }

  return $parents;
}

/**
 * Insert/update/delete the forum_access database entries for the OGFR access template permissions
 * by a given term and for the two roles anonymous user and authenticated user.
 *
 * @see og_forums_taxonomy()
 *
 * @param $tid
 *   ID of an term.
 * @param $grant
 *   An array contain the permission values.
 * @param $op
 *   The item on which $op is being performed. Possible values:
 *   - 'insert'
 *   - 'update'
 *   - 'delete'
 */
function og_forums_access_template($tid, $grant, $op) {
  switch ($op) {
    case 'insert':
      $sql = "INSERT INTO {forum_access} (tid, rid, grant_view, grant_update, grant_delete, grant_create, priority) VALUES (%d, %d, %d, %d, %d, %d, %d)";
      $sql2 = "INSERT INTO {forum_access} (tid, rid, grant_view, grant_update, grant_delete, grant_create, priority) VALUES (%d, %d, %d, %d, %d, %d, %d)";
      // $grant[1] = role id 1 = Anonymous user
      db_query($sql, $tid, DRUPAL_ANONYMOUS_RID, $grant[1]['grant_view'], $grant[1]['grant_update'], $grant[1]['grant_delete'], $grant[1]['grant_create'], $grant[1]['priority']);
      // $grant[2] = role id 2 = Authenticated user
      db_query($sql2, $tid, DRUPAL_AUTHENTICATED_RID, $grant[2]['grant_view'], $grant[2]['grant_update'], $grant[2]['grant_delete'], $grant[2]['grant_create'], $grant[2]['priority']);
      break;

    case 'update':
      // The role anonymous user does not need to be updated.
      $sql = "UPDATE {forum_access} SET grant_view, grant_update, grant_delete, grant_create, priority WHERE tid = %d AND rid = %d";
      db_query($sql, $tid, $rid);
      break;

    case 'delete':
      $sql = "DELETE FROM {forum_access} WHERE tid = %d AND rid = %d";
      $sql2 = "DELETE FROM {forum_access} WHERE tid = %d AND rid = %d";
      db_query($sql, $tid, DRUPAL_ANONYMOUS_RID);
      db_query($sql2, $tid, DRUPAL_AUTHENTICATED_RID);
      break;
  }
}

/**
 * For OGFR forums content - make a correct breadcrumb.
 *
 * @see og_forums_preprocess_forums()
 * @see _og_forums_set_breadcrumb()
 */
function og_forums_preprocess_node(&$variables) {
  if ($variables['type'] == 'forum') {
    _og_forums_set_breadcrumb($variables['tid'], TRUE);
  }
}

/**
 * Check groups forums availability, configured by group manager.
 *
 * @return
 *   TRUE or FALSE.
 */
function og_forums_get_forums_availability($node, $user) {
  $return = TRUE;

  if (isset($user->og_forums)) {
    if (array_key_exists($node->nid, $user->og_forums)) {

      $return = $user->og_forums[$node->nid];
    }
    elseif (!array_key_exists($node->nid, $user->og_forums)) {
      $return = TRUE;
    }
  }

  return $return;
}

/**
 * Menu callback.
 *
 * @see og_forums_menu_alter()
 * @see og_forums_set_og_group_context_from_tid()
 * @see og_forums_gid_from_tid()
 *
 * @return
 *   FALSE or TRUE.
 */
function og_forums_access_forum_page($tid = 0) {
  if (!user_access('access content')) {
    return FALSE;
  }

  global $user;

  if ($tid != 0) {
    og_forums_set_og_group_context_from_tid($tid);
    $gid = og_forums_gid_from_tid($tid);

    if ($gid) {
      if ((!empty($user->og_groups) && !array_key_exists($gid, $user->og_groups))) {
        return FALSE;
      }
      og_set_theme($gid);
      $node = node_load($gid);

      // Check group forum availability, configured by group manager.
      $group_user = user_load(array('uid' => $node->uid));
      $availability = module_invoke('og_forums', 'get_forums_availability', $node, $group_user);
      if ($availability == FALSE) {
        return FALSE;
      }

      og_set_language($node);
    }
  }
  elseif (is_numeric(og_get_group_context())) {
    $tid = og_get_group_context();
  }

  return TRUE;
}

/**
 * Preprocess variables to format the forums.
 *
 * Alter the "Post new forum topic" link to "Post new Group forum topic".
 *
 * @see og_forums_gid_from_tid()
 * @see og_forums_forum_empty()
 * @see _og_forums_set_group_context()
 * @see _og_forums_set_breadcrumb()
 */
function og_forums_preprocess_forums(&$variables) {
  global $public_forums;

  if (isset($variables['tid']) && $variables['tid'] != 0) {
    $gid = og_forums_gid_from_tid($variables['tid']);

    if (!empty($gid)) {
      if ($public_forums == FALSE) {
        unset($variables['forums']);

        $node = node_load($gid);
        og_forums_forum_empty($node);
      }

      _og_forums_set_group_context(node_load($gid));
      _og_forums_set_breadcrumb($variables['tid']);

      if (isset($variables['links']['forum']) && $public_forums == TRUE) {
        $variables['links']['forum']['title'] = t('Post new Group forum topic');
        $variables['links']['forum']['query'] = array('gids[]' => $gid);
      }
      else {
        unset($variables['links']['forum']);
      }
    }
  }
}

/**
 * Preprocess variables to format the forum topic listing.
 *
 * Hide the table header if a forum has no topics.
 */
function og_forums_preprocess_forum_topic_list(&$variables) {
  // This fixes a bug of the forum module when the number of topics is 0.
  if (count($variables['topics']) == 0) {
    unset($variables['header']);
  }
}

/**
 * Process variables to format a forum listing.
 *
 * Hide private groups forums in the main forum list.
 * Administrators and group members can see private groups forums in the main forum list.
 *
 * @see og_forums_get_group_forums()
 * @see og_forums_gid_from_tid()
 * @see og_forums_is_public()
 */
function og_forums_preprocess_forum_list(&$variables) {
  global $user, $public_forums;

  if (!isset($variables['forums'])) {
    return;
  }

  $public_forums = TRUE;

  if (arg(0) == 'forum' && is_numeric(arg(1))) {
    // Hide containers if they do not contain a forum.
    $variables = _og_forums_forum_list_hide($variables);
    if (count($variables['forums']) == 0) {
      $public_forums = FALSE;
    }
    return;
  }

  $default_container = variable_get('og_forums_default_container', 0);
  $main_visibility = variable_get('og_forums_main_visibility', 0);
  $group_forums = og_forums_get_group_forums();

  foreach ($variables['forums'] as $tid => $forum) {
    $gid = og_forums_gid_from_tid($tid);
    $public = og_forums_is_public($tid);

    if ($main_visibility == 0 && array_key_exists($tid, $group_forums)) {
      unset($variables['forums'][$tid]);
    }
    else {
      if ($public) {
        // Do nothing.
      }
      else {
        unset($variables['forums'][$tid]);
      }
    }

    // Hide default groups forums container.
    if ($main_visibility == 0 && array_key_exists($default_container, $variables['forums'])) {
      unset($variables['forums'][$default_container]);
    }
  }
}

/**
 * Returns all group container and forums or only forums by a given group.
 *
 * If no group will be given back all group container and forums.
 *
 * @see og_forums_nodeapi()
 * @see og_forums_preprocess_forum_list()
 * @see _og_forums_parent_select()
 *
 * @param $gid
 *   ID of an group.
 * @param $op
 *   Optional; Return container and forums or only forums. Possible values:
 *   - 'all' Container and forums.
 *   - 'forum' Only forums.
 * @return
 *   An associative array contains the group container and forum terms or only the forum terms.
 */
function og_forums_get_group_forums($gid = FALSE, $op = 'all') {
  $forums = array();

  if ($gid == FALSE) {
    $sql = "SELECT tid, public FROM {og_terms}";
  }
  else {
    $sql = "SELECT tid, public FROM {og_terms} WHERE nid = %d";
  }

  $results = db_query($sql, $gid);

  switch ($op) {
    case 'all':
      while ($result = db_fetch_object($results)) {
        $forums[$result->tid] = $result->public;
      }
      break;

    case 'forum':
      $forum_containers = variable_get('forum_containers', array());

      while ($result = db_fetch_object($results)) {
        if (!in_array($result->tid, $forum_containers)) {
          $forums[$result->tid] = $result->public;
        }
      }
      break;
  }

  return $forums;
}

/**
 * Returns parent term by a given term.
 *
 * @see og_forums_manage()
 * @see og_forums_form_main()
 *
 * @param $tid
 *   ID of an term.
 * @return
 *   An object contains the parent term or FALSE.
 */
function og_forums_forum_get_parent($tid) {
  $parents = taxonomy_get_parents_all($tid);

  if (count($parents) > 1) {
    return $parents[1];
  }
  else {
    return FALSE;
  }
}

/**
 * Create a hierarchical representation of a vocabulary.
 *
 * OGFR used this function mainly to produce the tree of a group.
 *
 * @param $vid
 *   Which vocabulary to generate the tree for.
 * @param $parent
 *   The term ID under which to generate the tree. If 0, generate the tree for the entire vocabulary.
 * @param $depth
 *   Internal use only.
 * @param $max_depth
 *   The number of levels of the tree to return. Leave NULL to return all levels.
 * @return
 *   An array of all term objects in the tree.
 *   Each term object is extended to have "depth" and "parents" attributes in addition to its normal ones. Results are statically cached.
 */
function og_forums_get_tree($vid, $parent = 0, $depth = -1, $max_depth = NULL) {
  $tree = taxonomy_get_tree($vid, $parent, $depth, $max_depth);

  if ($parent > 0) {
    $parent_term = taxonomy_get_term($parent);
    $parent_term->depth = 0;
    $parent_term->parents[] = NULL;
    array_unshift($tree, $parent_term);
  }

  return $tree;
}

/**
 * Display different messages when all the forums of a group are private and if the visitor is not a member of the group.
 *
 * @see og_forums_preprocess_forums()
 */
function og_forums_forum_empty($node) {
  global $user;

  $dest = drupal_get_destination();
  if (og_is_group_member($node->nid)) {
    $msg = t('No forums in this group.');
  }
  else {
    if (!$user->uid) {
      if (variable_get('user_register', 1) == 0) {
        $msg = t('No public forums in this group. You must <a href="!login">login</a> and become a member in order to post forum topics, and view any private forums.', array('!login' => url("user/login", array('query' => $dest))));
      }
      else {
        $msg = t('No public forums in this group. You must <a href="!register">register</a> or <a href="!login">login</a> and become a member in order to post forum topics, and view any private forums.', array('!register' => url("user/register", array('query' => $dest)), '!login' => url("user/login", array('query' => $dest))));
      }
    }
    // TODOL: hide this from pending members too
    elseif ($node->og_selective < OG_INVITE_ONLY) {
      $msg = t('No public forums in this group. Consider <a href="!url">joining this group</a> in order to view its forums.', array('!url' => url("og/subscribe/$node->nid", array('query' => $dest))));
    }
    else {
      $msg = t('No public forums in this group.');
    }
  }

  drupal_set_message($msg);
}

/**
 * Retrieve the settings for a forum by an role.
 *
 * @see og_forums_taxonomy()
 *
 * @param $tid
 *   ID of an term.
 * @param $rid
 *   ID of an role.
 * @return
 *   An associative array contains access values.
 */
function og_forums_forum_access_get_settings($tid = NULL, $rid = DRUPAL_AUTHENTICATED_RID) {
  $return = array('view' => array(), 'update' => array(), 'delete' => array(), 'create' => array(), 'priority' => array());
  if (!isset($tid)) {
    // Default to logged in users can read and post.
    $return['view'] = array(DRUPAL_AUTHENTICATED_RID => 1);
    $return['create'] = array(DRUPAL_AUTHENTICATED_RID => 1);
  }
  else {
    $result = db_query("SELECT * FROM {forum_access} where tid = %d AND rid = %d", $tid, $rid);
    while ($access = db_fetch_object($result)) {
      $row_received = TRUE;

      $return['view'][$access->rid] = $access->grant_view;
      $return['update'][$access->rid] = $access->grant_update;
      $return['delete'][$access->rid] = $access->grant_delete;
      $return['create'][$access->rid] = $access->grant_create;
      $return['priority'][$access->rid] = $access->priority;
    }

    if (empty($row_received)) {
      // Return default settings if no records found in database.
      $return = og_forums_forum_access_get_settings();
    }
  }
  return $return;
}

/**
 * Log errors to watchdog.
 *
 * @see og_forums_manage_terms()
 *
 * @param $tid
 *   An term ID.
 * @param $nid
 *   An node ID.
 */
function og_forums_error($tid = NULL, $nid = NULL, $term_title = NULL) {
  if ($tid && $nid && $tid == 0) {
    $message = t('It has created a groups node and it was used a term ID 0. The term has the name %term. Please Check: The database tables og_terms and forum_access, the forum administration and the content management. Possible Cause: A user uses the Opera browser to create group nodes.', array('%term' => $term_title));
    $link = l(t('Created content'), 'node/'. $nid);

    watchdog('error', $message, array(), WATCHDOG_ALERT, $link);
  }
}

/**
 * Helper function to create the breadcrumb for OG Forums.
 *
 * @see og_forums_preprocess_node()
 * @see og_forums_preprocess_forums()
 */
function _og_forums_set_breadcrumb($tid, $is_forum_post = FALSE) {
  $vocabulary = taxonomy_vocabulary_load(variable_get('forum_nav_vocabulary', ''));
  $parents = array_reverse(taxonomy_get_parents_all($tid));
  $title = $vocabulary->name;

  // Breadcrumb navigation:
  $gid = og_forums_gid_from_tid($tid);
  $breadcrumb[] = l(t('Home'), NULL);

  if ($gid != NULL) {
    $node = node_load($gid);
    $breadcrumb[] = l(t('Groups'), 'og');
    $breadcrumb[] = l($node->title, "node/$node->nid");
  }

  if ($parents && count($parents) != 1) {
    $p = array_shift($parents);
    $title = t('Forums');
    $breadcrumb[] = l($title, "node/$node->nid/forum");

    foreach ($parents as $p) {
      if ($p->tid == $tid) {
        $title = $p->name;
        if ($is_forum_post)
          $breadcrumb[] = l(t($p->name), "forum/$p->tid");
      }
      else {
        $breadcrumb[] = l(t($p->name), "forum/$p->tid");
      }
    }
  }

  if (!$is_forum_post) {
    drupal_set_title(check_plain($title));
  }

  drupal_set_breadcrumb($breadcrumb);
}

/**
 * Set a nice breadcrumb for the manage pages.
 *
 * @see og_forums_manage()
 * @see og_forums_form_forum()
 */
function _og_forums_manage_breadcrumb($group, $op = NULL) {
  global $vocabulary;

  $breadcrumb[] = l(t('Home'), NULL);
  if ($vocabulary->name) {
    $breadcrumb[] = l($vocabulary->name, 'forum');
  }
  $breadcrumb[] = l($group->title, "node/$group->nid");

  switch ($op) {
    case 'add':
      $breadcrumb[] = l(t("Add @title forums", array('@title' => $group->title)), "og_forums/manage/$group->nid");
      break;

    case 'edit':
      $breadcrumb[] = l(t("Edit @title forums", array('@title' => $group->title)), "og_forums/manage/$group->nid");
      break;

    case 'default':
      $breadcrumb[] = l(t("Manage @title forums", array('@title' => $group->title)), "og_forums/manage/$group->nid");
      break;
  }

  drupal_set_breadcrumb($breadcrumb);
}

/**
 * Helper function to hide container if they contains no (public) forums.
 *
 * @see og_forums_preprocess_forum_list()
 */
function _og_forums_forum_list_hide(&$variables) {
  $gid = og_forums_gid_from_tid($variables['forum_id']);
  $group_forums = og_forums_get_group_forums($gid, 'all');

  foreach ($group_forums as $tid => $public) {
    $parents = taxonomy_get_parents_all($tid);
  }

  foreach ($variables['forums'] as $tid => $forum) {
    if ($forum->is_container == TRUE) {
      $tree = taxonomy_get_tree($forum->vid, $tid);

      if (count($tree) > 0) {
        if (count($tree) == 1) {
          if ($variables['forums'][$tid]->is_container == TRUE) {
            $tree_tree = taxonomy_get_tree($forum->vid, $tid);

            if (count($tree_tree) == 0) {
              unset($variables['forums'][$tid]);
            }
            elseif (count($tree_tree) > 0 && $variables['forums'][$tree_tree[0]->tid]->is_container == TRUE) {
              unset($variables['forums'][$tid]);
            }
          }
        }
      }
      else {
        unset($variables['forums'][$tid]);
      }
    }
  }

  return $variables;
}

/**
 * Returns an array containing terms associated to this og.
 *
 * @param $group
 *   An group node object.
 */
function _og_forums_ogterms($group) {
  $result = db_query('SELECT * FROM {og_terms} WHERE nid = %d', $group->nid);

  $og_terms = array();
  while ($term = db_fetch_object($result)) {
    $og_terms[] = $term->tid;
  }

  return $og_terms;
}

/**
 * Set the theme for the current request.
 * Set the language for the page based on group's language.
 * Set the group context for the current request.
 *
 * @see og_forums_preprocess_forums()
 */
function _og_forums_set_group_context($group) {
  og_set_theme($group);
  og_set_language($group);
  og_set_group_context($group);
}

/**
 * Returns a select box for available parent terms.
 *
 * @see og_forums_form_forum()
 * @see og_forums_get_group_forums()
 * @see og_forums_tid_from_gid()
 * @see og_forums_get_tree()
 *
 * @param $tid
 *   ID of the term which is being added or edited.
 * @param $title
 *   Title to display the select box with.
 * @param $child_type
 *   Whether the child is forum or container.
 * @param $gid
 *   An group ID.
 */
function _og_forums_parent_select($tid, $title, $child_type, $gid) {
  $vid = variable_get('forum_nav_vocabulary', '');
  $children = taxonomy_get_tree($vid, $tid);
  $forum_containers = variable_get('forum_containers', array());

  $parents = taxonomy_get_parents($tid);
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

  // A term can't be the child of itself, nor of its children.
  foreach ($children as $child) {
    $exclude[] = $child->tid;
  }
  $exclude[] = $tid;

  // Get the term tree of the given group.
  // This gives a better performance than if the entire tree (forum vocabulary) is used.
  $group_tid = og_forums_tid_from_gid($gid);
  $group_tree = og_forums_get_tree($vid, $group_tid, 0);

  if ($group_tree) {
    foreach ($group_tree as $term) {
      if (!in_array($term->tid, $exclude)) {
        $option = str_repeat('-', $term->depth) .' '. $term->name;
        // Make a little bit better usability.
        // Flag a term if it is a container.
        if (in_array($term->tid, $forum_containers)) {
          $option = $option .' '. t('(Container)');
        }

        $options[$term->tid] = $option;
      }
    }
  }

  if ($child_type == 'container') {
    $description = t('Containers are usually placed at the top (root) level, but may also be placed inside another container or forum.') .'<br />';
    $description .= t('Note') .':<br />';
    $description .= t('A forum to place in another forum is possible but not always a good idea. Possible problem: Poor forum and topic lists.');
  }
  elseif ($child_type == 'forum') {
    $description = t('Forums may be placed at the top (root) group forums level, or inside another container.') .'<br />';
    $description .= t('Note') .':<br />';
    $description .= t('A forum to place in another forum is possible but not always a good idea. Possible problem: Poor forum and topic lists.');
  }

  return array('#type' => 'select', '#title' => $title, '#default_value' => $parent, '#options' => $options, '#description' => $description, '#required' => TRUE);
}

/**
 * Provisioning of the default values of the system-variable og_forums_access_template_container.
 *
 * @return
 *   An associative array contains access values.
 */
function _og_forums_access_template_container_default() {
  return array(
    2 => array(
      'grant_view' => 1,
      'grant_create' => 1,
      'priority' => 0,
    ),
  );
}

/**
 * Provisioning of the default values of the system-variable og_forums_access_template_forum.
 *
 * @return
 *   An associative array contains access values.
 */
function _og_forums_access_template_forum_default() {
  return array(
    1 => array(
      'grant_view' => 0,
      'grant_update' => 0,
      'grant_delete' => 0,
      'grant_create' => 0,
      'priority' => 0,
    ),
    2 => array(
      'grant_view' => 1,
      'grant_update' => 0,
      'grant_delete' => 0,
      'grant_create' => 1,
      'priority' => 0,
    ),
  );
}

/**
 * Create an status message if no forums exists for a group.
 *
 * @see og_forums_manage()
 *
 * @param $op Possible values:
 *   - 'member' An group member.
 *   - 'manager' An group manager.
 * @return
 *   The formatted message.
 */
function _og_forums_no_forums_message($op = 'member', $path) {
  $message = '';
  switch ($op) {
    case 'user':
      $message = '<p>'. t('It has encountered a problem: No group forum exists.') .'</p>';
      $message .= t('Please inform the <a href="@manager-url">@manager</a> of the group or an administrator. They can solve this problem.', array('@manager-url' => url($path), '@manager' => t('manager')));
      break;

    case 'manager':
      $message = '<p>'. t('It has encountered a problem: No group forum exists.') .'</p>';
      $message .= t('Please update the group node to create an group forum. <a href="@edit-node-url">@edit-node</a> and resave the node simply.', array('@edit-node-url' => url($path), '@edit-node' => t('Edit this node')));
      break;
  }

  return $message;
}

/**
 * Clean form input.
 *
 * @see og_forums_manage_terms()
 *
 * $param $forum_names
 *   An forum name.
 * @return
 *   The cleaned forum name.
 */
function _og_forums_clean_forum_names($forum_names) {
  $forum_names = preg_replace("/\;+/", ';', $forum_names);
  $forum_names = preg_replace("/,+/", ',', $forum_names);

  $forum_names = preg_replace("/^\,|\,$/", '', $forum_names);
  $forum_names = preg_replace("/^\;|\;$/", '', $forum_names);

  $forum_names = preg_replace("/\;\,|\,\;/", '', $forum_names);

  return $forum_names;
}

/**
 * @todo
 * Integration of a function to migrate from "OG Forum" to "OG Forum Reloaded".
 */
function og_forum_migrate() {
  // Coming soon.
}

---