Advanced Forum

This link might be helpful to you in terms of ideas towards a solution:
http://drupal.org/node/59826#comment-724550

From what Miraploy said, it sounds like the issue is we're overriding the same functions. Right now my focus is the D6 port and D5 backport so everything else is on hold for that. Once things have settled down, I can take a look at OG forum and see how we can make them work together.

Michelle

I'm using both modules and so far it seems to work. What are the known problems? Perhaps I could also have a look at them.

Ok, now I can see what the problems are. Has there been any progress?

I had a look at both modules. It seems, the problem lies in three functions (because of duplication):

forum_display
forum_list
forum_topic_list

Am I right that one only has to merge those three functions to have everything work as intended?

Well, the problem is that we're both overriding those theme functions but merging them won't be simple. You're using the 5.x forum code and I'm using the 6.x forum code. I think what I'll need to do is diff your code against the core forum to find out exactly what you changed and write a template_preprocess function to make the changes. Not sure when I'm going to have time, though. I've got my hands pretty full with this module already. :( So if you're able to put anything towards that, I'd appreciate it.

Michelle

After taking a closer look, theme_og_forum_list doesn't seem to be changed from theme_forum_list despite it claiming to be "slightly modified". Using my template.php I copied the contents of phptemplate_forum_list (form advanced_forum) into my phptemplate_og_forum_list. That seems to work without problems.

If I didn't miss anything, that would bring us down to two functions that need to be merged. To be sure, a verification by rconstantine would be needed though.

I now had a look at the "forum_topic_list" part.
It seems, the only thing needed there is a way to set each topic as "public" or not.

How can I add this info to the return value?
return _phptemplate_callback("$forum_theme/advf-forum-topic-list", $variables);
It needs to get into the variables?

On my site, it isn't a real problem as we don't have public forums, but for a real solution, this would be necessary.

To be precise, we would need a way to have a variable $topic->private that could be set to "public", "private" or "" (empty). Then one could use the contents of that variable in the template. How would I set that variable before calling the callback?

Ok, for the forum_topic_list I have a solution that one can put into the template.php:

function phptemplate_og_forum_topic_list($tid, $topics, $sortby, $forum_per_page, $gid) {
  global $forum_topic_list_header, $user;

  if ($topics) {
    foreach ($topics as $topic) {
      $sql = "SELECT oa.nid, oa.is_public FROM {node} n INNER JOIN {og_ancestry} oa ON oa.nid = n.nid WHERE n.type = 'forum' AND n.nid = %d";
      $public_post = db_fetch_object(db_query($sql, $topic->nid));
      if (isset($public_post) && $public_post->is_public == 1 && !array_key_exists($gid, $user->og_groups)) {
        $topic->private = "public";
      } elseif (isset($public_post) && $public_post->is_public == 0 && !array_key_exists($gid, $user->og_groups)) {
        $topic->private = "private";
      } elseif (isset($public_post)) {//if the user is a group member, hide the public/private indicators
        $topic->private = "";
      } else { //non-group forum topics
        $topic->private = "public";
      }
    }
  }

  // Create a $variables array from the parameters
  $variables['tid'] = $tid;
  $variables['topics'] = $topics;
  $variables['sortby'] = $sortby;
  $variables['forum_per_page'] = $forum_per_page;

  // Pass the parameters into the D6 preprocess function
  template_preprocess_forum_topic_list($variables);

  // Pass the parameters into our preprocess function
  advanced_forum_preprocess_forum_topic_list($variables);

  // Look for the .tpl file in the theme. If found, use it. If not found, default
  // to the stock forum code and put up a warning.
  $forum_theme = advanced_forum_get_forum_theme_directory();
  if (file_exists(path_to_theme() . '/' . $forum_theme . "/advf-forum-topic-list.tpl.php")) {
    return _phptemplate_callback("$forum_theme/advf-forum-topic-list", $variables);
  } else {
    drupal_set_message(path_to_theme() . '/' . $forum_theme . "/advf-forum-topic-list.tpl.php not found. Defaulting to stock page.", "error");
    return theme_og_forum_topic_list($tid, $topics, $sortby, $forum_per_page, $gid);
  }
}

For a "forum_display" that combines og_foum with advanced_forum, it seems we need to change the "d6_compat.inc", that advanced_forum provides.
It's the function template_preprocess_forums(&$variables) that needs to be expanded. I will post the changed function, when I got it working. For an inclusion into advanced_forum, it would be necessary to check for the existence of og_forums and react accordingly.

You need to make your own preprocess function. The d6compat file is just that: for D6 compatability. Other than a few minor changes to make it work in D5, that is unchanged from core.

What needs to happen is og_forum needs an og_forum_preprocess_* for each function that it needs to modify the variables. Then we need to decide how we will handle who calls what when both modules are installed. Either I will wrap mine in an "if (!module_exists("og_forum"))" and let og_forum handle all the function calls, or they need to do that for advforum and let me handle the forum theming when people have advforum installed.

I've looked at the og_forum code and it's pretty complicated. It's not something I'm going to have time to dig through in the near future. I'll take a look at what you come up with, but I'm going to be pretty picky with how much I add to advanced forum. Supporting another module should be limited to function calls and checking if the other module exists to avoid conflicts.

Michelle

I'm simply trying to get both modules working together for our site. Posting the results here is just so that other people having the same problem have an easier time nd to provide some hints on where the conflicts are. I succeeded by adding some small changes to the mentioned function in the compatibility file. I know that this is not the clean way to do it but it was the easiest way.

If I'm right with #8 and forum_list isn't changed in og_forums after all, that function could be removed from og_forums thus allowing most of advanced_forums to work
The changes to forum_topic_list are just cosmetical if I'm not mistaken. They allow for different icons for public and private forums. In addition, that change is easy to implement for everyone by putting the posted function into the template.php.

The real complicated thing is forum_display as it deals with the access rights. I think I got it right with my changes to d6_compat.inc but I'm not sure how to do it with an additional preprocess function. That would be something for you two to figure out.

Anyway, this is the function as I use it now:

function template_preprocess_forums(&$variables) {
  global $user;

$sidebar = variable_get('forum_list_sidebar', 0);

  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
  $title = !empty($vocabulary->name) ? $vocabulary->name : '';

  // Breadcrumb navigation:
  $breadcrumb[] = l(t('Home'), NULL);
  if ($gid !== NULL) {
    $breadcrumb[] = l(t('Groups'), 'og');
    $breadcrumb[] = l($node->og_groups_names[0], 'node/'. $node->og_groups[0]);
  }
  if ($variables['tid']) {
    $breadcrumb[] = l($vocabulary->name, 'forum');
  }
  if ($variables['parents']) {
    $variables['parents'] = array_reverse($variables['parents']);
    foreach ($variables['parents'] as $p) {
      if ($p->tid == $variables['tid']) {
        $title = $p->name;
      }
      else {
        $breadcrumb[] = l($p->name, 'forum/'. $p->tid);
      }
    }
  }
  drupal_set_breadcrumb($breadcrumb);
  drupal_set_title(check_plain($title));

  if ($variables['forums_defined'] = count($variables['forums']) || count($variables['parents'])) {
    // Format the "post new content" links listing.
    $forum_types = array();

    // Loop through all node types for forum vocabulary.
    foreach ($vocabulary->nodes as $type) {
      // Check if the current user has the 'create' permission for this node type.
      // Also check for OG
      if (node_access('create', $type) && !in_array($variables['tid'], variable_get('forum_containers', array())) && ($variables['tid'] != 0)) {
        og_forum_set_og_group_context_from_tid($variables['tid']);
        $gid = og_forum_gid_from_tid($variables['tid']);
        // group forum link with group selected
        if (!empty($gid) && array_key_exists($gid, $user->og_groups)) {
          // only group members are shown this link
          $forum_types[$type] = array('title' => t('Post new @node_type', array('@node_type' => node_get_types('name', $type))), 'href' => 'node/add/'. str_replace('_', '-', $type) .'/'. $variables['tid']. "?gids[]=$gid");
        }
        elseif (empty($gid)) {
          // not in group
          // Fetch the "General" name of the content type;
          // Push the link with title and url to the array.
          $forum_types[$type] = array('title' => t('Post new @node_type', array('@node_type' => node_get_types('name', $type))), 'href' => 'node/add/'. str_replace('_', '-', $type) .'/'. $variables['tid']);
        }
      }
   }

    if (empty($forum_types)) {
      // The user is logged-in; but denied access to create any new forum content type.
      if ($user->uid) {
        $forum_types['disallowed'] = array('title' => t('You are not allowed to post new content in forum.'));
      }
      // The user is not logged-in; and denied access to create any new forum content type.
      else {
        $title = t('<a href="@login">Login to post a new forum topic</a>',array('@login' => url('user/login', drupal_get_destination())));
        $forum_types['login'] = array('title' => $title, 'html' => TRUE);

      }
    }

    $variables['links'] = $forum_types;
    if (!empty($variables['forums'])) {
      $variables['forums'] = theme('og_forum_list', $variables['forums'], $variables['parents'], $variables['tid']);
    }
    else {
      $variables['forums'] = '';
    }

    if ($variables['tid'] && !in_array($variables['tid'], variable_get('forum_containers', array()))) {
      $variables['topics'] = theme('og_forum_topic_list', $variables['tid'], $variables['topics'], $variables['sortby'], $variables['forum_per_page'],$gid);
      drupal_add_feed(url('taxonomy/term/'. $variables['tid'] .'/0/feed'), 'RSS - '. $title);
    }
    else {
      $variables['topics'] = '';
    }
    // Provide separate template suggestions based on what's being output. Topic id is also accounted for.
    // Check both variables to be safe then the inverse. Forums with topic ID's take precedence.
    if ($variables['forums'] && !$variables['topics']) {
      $variables['template_files'][] = 'forums-containers';
      $variables['template_files'][] = 'forums-'. $variables['tid'];
      $variables['template_files'][] = 'forums-containers-'. $variables['tid'];
    }
    elseif (!$variables['forums'] && $variables['topics']) {
      $variables['template_files'][] = 'forums-topics';
      $variables['template_files'][] = 'forums-'. $variables['tid'];
      $variables['template_files'][] = 'forums-topics-'. $variables['tid'];
    }
    else {
      $variables['template_files'][] = 'forums-'. $variables['tid'];
    }
  }
  else {
    drupal_set_title(t('No forums defined or you don\'t have permission to view them.'));
    $variables['links'] = array();
    $variables['forums'] = '';
    $variables['topics'] = '';
  }
}

@rconstantine: I'm willing to work with you to make the modules compatable. The problem is that my 8 month old has been barely napping and my 3 year old is just about giving them up. So I'm dealing with kids pretty much non stop from 7am to midnight. I haven't been able to get much of anything done.

One thing you might want to consider, though it's no small amount of work and I understand if you don't want to, is bring og_forum for 5.x in line with the 6.x forum code like I did for advanced forum. The initial backport was rough but now I only need to maintain one set of theme files that works for both versions. Plus I got some goodies like #new working across pages.

@nath: I understand you're making it work for your site but what you are doing is hacking the module in a way that will not be incorporated. If you want to do that, that's fine, but I want to warn everyone following along that you will need to redo the changes on every upgrade if you go that route. We'll get this worked out in a clean way but it may take a while since both of us are very busy.

Michelle

Going through some old issues in my list... This isn't something I will have time to do for D5. Once it's ported to D6, we can see if there's still any conflicts that need to be resolved.

Michelle

Ok, so I will have to write my own small module instead of using OG forums.

I was curious and took a (*very*) brief look at the code and see a couple problems:

* OG Forum is clobbering the /forum menu path. AF uses hook_menu_alter() to provide a version of that page with extra information in the query. So that page won't work right with AF.

* OG Forum is using the old 5.x style theme_* functions and not the preprocess system. I'm not sure what will happen there. Likely OG Forum will just shut out AF for those functions.

Just based on this, I would have to say that OG Forum and Advanced Forum continue to be incompatable. I don't know whether they can be made to work together. Certainly it would help if you use the preprocess system but I haven't looked at the code deeply enough to know if that is enough. Since I don't use OG forum myself, I don't know when or even if I'll have the time to investigate more. If someone that uses both has ideas, patches are welcome on my end. Up to the OGF maintainer(s) about their end.

Michelle

Any info or news about how to make both of them work together? Thanks!