local_menu can behave inconsistently if links exist in multiple menus

Here's a fix which should give a precedence order to the menu trees, which produces more consistent behaviour for pages with multiple menu entries.

The only major change is that we add ORDER BY menu_name = $active DESC, menu_name = $primary DESC, menu_name = $secondary DESC to the query which looks for which menu to use.

There may be a better way to decide this (perhaps menu item depth?) but this seems a step in the right direction.

Using menu_get_active_menu_name() as the preferred selection means that we're

    // for consistency, we will order these results to match against primary, secondary, active menus,
    // with preference for the active menu, then primary, then secondary
    $active_menu_name    = menu_get_active_menu_name() ;
    $primary_menu_name   = variable_get('menu_primary_links_source', 'primary-links') ;
    $secondary_menu_name = variable_get('menu_secondary_links_source', 'secondary-links') ;

    // Get the menu link and set the active menu to the menu it's in, so Drupal can find its way and make correct breadcrumbs at the same time
    $sql = "
  SELECT mlid
    FROM {menu_links}
   WHERE link_path = '%s'
     AND hidden <> 1
     AND menu_name NOT IN ('admin_menu', 'devel')
ORDER BY menu_name = '%s' DESC, menu_name = '%s' DESC, menu_name = '%s' DESC
" ;
    $result = db_query($sql, $item['href'], $active_menu_name, $primary_menu_name, $secondary_menu_name);
    // In case there are multiple, let's find the most appropriate one
    while ($link = menu_link_load(db_result($result))) {
      if (in_array($link['menu_name'], array(
            $active_menu,
            $primary_menu_name,
            $secondary_menu_name,
          ))) {
        break;
      }
    }
 

Patch is against HEAD.

I have to write myself a userscript that detects when I've attached a .patch file, and reminds me to change the issue status.

Also of interest: implementation of menu weighting @ http://drupal.org/node/595282