Merge lp:~pressflow/pressflow/menu-tng into lp:pressflow

[David Strauss]

Unmerged revisions

65. By David Strauss on 2009-11-30

Initial (seemingly working) Menu-TNG system.

=== modified file 'includes/menu.inc'
--- includes/menu.inc	2009-04-30 00:36:53 +0000
+++ includes/menu.inc	2009-11-30 19:05:26 +0000
@@ -285,7 +285,7 @@
 }
 
 /**
- * Get a router item.
+ * Get a router item. Pressflow-optimized.
  *
  * @param $path
  *   The path, for example node/5. The function will find the corresponding
@@ -293,13 +293,14 @@
  * @param $router_item
  *   Internal use only.
  * @return
- *   The router item, an associate array corresponding to one row in the
- *   menu_router table. The value of key map holds the loaded objects. The
- *   value of key access is TRUE if the current user can access this page.
- *   The values for key title, page_arguments, access_arguments will be
- *   filled in based on the database values and the objects loaded.
+ *   The router item, an associative array corresponding to one menu item.
+ *   The value of key map holds the loaded objects. The value of key access
+ *   is TRUE if the current user can access this page.
  */
 function menu_get_item($path = NULL, $router_item = NULL) {
+  static $tree = NULL;
+
+  $start = microtime(TRUE);
   static $router_items;
   if (!isset($path)) {
     $path = $_GET['q'];
@@ -310,28 +311,63 @@
   if (!isset($router_items[$path])) {
     $original_map = arg(NULL, $path);
     $parts = array_slice($original_map, 0, MENU_MAX_PARTS);
-    list($ancestors, $placeholders) = menu_get_ancestors($parts);
-
-    if ($router_item = db_fetch_array(db_query_range('SELECT * FROM {menu_router} WHERE path IN ('. implode (',', $placeholders) .') ORDER BY fit DESC', $ancestors, 0, 1))) {
-      $map = _menu_translate($router_item, $original_map);
-      if ($map === FALSE) {
+    
+    if (!$tree) {
+      $tree = menu_get_tree();
+    }
+    $cursor =& $tree;
+    
+    foreach ($parts as $element) {
+      // Try the best fit first.
+      if (isset($cursor[$element])) {
+        $cursor =& $cursor[$element];
+      }
+      // Then try a placeholder fit.
+      else if (isset($cursor['%'])) {
+        $cursor =& $cursor['%'];
+      }
+      // Check if there's a leaf available.
+      else if (isset($cursor['#leaf'])) {
+        break;
+      }
+      // If there's no fit, there's no matching item.
+      else {
         $router_items[$path] = FALSE;
         return FALSE;
       }
-      if ($router_item['access']) {
-        $router_item['map'] = $map;
-        $router_item['page_arguments'] = array_merge(menu_unserialize($router_item['page_arguments'], $map), array_slice($map, $router_item['number_parts']));
-      }
-    }
+    }
+    
+    // At this point, there should be a leaf.
+    if (!isset($cursor['#leaf'])) {
+      $router_items[$path] = FALSE;
+      return FALSE;
+    }
+    
+    $router_item = $cursor['#leaf'];
+    
+    //echo "router_item:\n";
+    //print_r($router_item);
+
+    $map = _menu_translate($router_item, $original_map);
+    if ($map === FALSE) {
+      $router_items[$path] = FALSE;
+      return FALSE;
+    }
+    if ($router_item['access']) {
+      $router_item['map'] = $map;
+      $router_item['page_arguments'] = array_merge(menu_unserialize($router_item['page_arguments'], $map), array_slice($map, $router_item['number_parts']));
+    }
+    
     $router_items[$path] = $router_item;
   }
+  header('X-Profile-' . str_replace('/', '-', $path) . ': ' . number_format(microtime(TRUE) - $start, 10));
   return $router_items[$path];
 }
 
 /**
  * Execute the page callback associated with the current path
  */
-function menu_execute_active_handler($path = NULL) {
+function menu_execute_active_handler($path = NULL, $old = FALSE) {
   if (_menu_site_is_offline()) {
     return MENU_SITE_OFFLINE;
   }
@@ -340,7 +376,8 @@
   if (variable_get('menu_rebuild_needed', FALSE) || !variable_get('menu_masks', array())) {
     menu_rebuild();
   }
-  if ($router_item = menu_get_item($path)) {
+
+  if ((!$old && $router_item = menu_get_item($path)) || ($old && $router_item = menu_get_item_old($path))) {
     if ($router_item['access']) {
       if ($router_item['file']) {
         require_once($router_item['file']);
@@ -434,6 +471,7 @@
  *   $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
  */
 function _menu_check_access(&$item, $map) {
+  //print_r($item);
   // Determine access callback, which will decide whether or not the current
   // user has access to this path.
   $callback = empty($item['access_callback']) ? 0 : trim($item['access_callback']);
@@ -443,6 +481,9 @@
   }
   else {
     $arguments = menu_unserialize($item['access_arguments'], $map);
+    
+    //print_r($arguments);
+    
     // As call_user_func_array is quite slow and user_access is a very common
     // callback, it is worth making a special case for it.
     if ($callback == 'user_access') {
@@ -823,12 +864,11 @@
         $parents = array();
       }
       array_unshift($args, $menu_name);
-      // Select the links from the table, and recursively build the tree.  We
-      // LEFT JOIN since there is no match in {menu_router} for an external
-      // link.
+      // Select the links from the table, and recursively build the tree. Loading data for
+      // internal links (formerly from {menu_router}) has moved to _menu_tree_data() in Pressflow.
       $data['tree'] = menu_tree_data(db_query("
-        SELECT m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments, m.page_callback, m.page_arguments, m.title, m.title_callback, m.title_arguments, m.type, m.description, ml.*
-        FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path
+        SELECT ml.*
+        FROM {menu_links} ml
         WHERE ml.menu_name = '%s'". $where ."
         ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC, p6 ASC, p7 ASC, p8 ASC, p9 ASC", $args), $parents);
       $data['node_links'] = array();
@@ -930,12 +970,10 @@
           $placeholders = '%d';
           $parents = array();
         }
-        // Select the links from the table, and recursively build the tree. We
-        // LEFT JOIN since there is no match in {menu_router} for an external
-        // link.
+        // Select the links from the table, and recursively build the tree.
         $data['tree'] = menu_tree_data(db_query("
-          SELECT m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments, m.page_callback, m.page_arguments, m.title, m.title_callback, m.title_arguments, m.type, m.description, ml.*
-          FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path
+          SELECT ml.*
+          FROM {menu_links} ml
           WHERE ml.menu_name = '%s' AND ml.plid IN (". $placeholders .")
           ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC, p6 ASC, p7 ASC, p8 ASC, p9 ASC", $args), $parents);
         $data['node_links'] = array();
@@ -1067,6 +1105,26 @@
   $remnant = NULL;
   $tree = array();
   while ($item = db_fetch_array($result)) {
+  
+    // Load additional data for the menu item.
+    $menu_item = menu_get_item($item['router_path']);
+    if ($menu_item) {
+      $menu_item_filter_keys = array(
+        'load_functions',
+        'to_arg_functions',
+        'access_callback',
+        'access_arguments',
+        'page_callback',
+        'page_arguments',
+        'title',
+        'title_callback',
+        'title_arguments',
+        'type',
+        'description',
+      );
+      $item += array_intersect_key($menu_item, array_fill_keys($menu_item_filter_keys, TRUE));
+    }
+
     // We need to determine if we're on the path to root so we can later build
     // the correct active trail and breadcrumb.
     $item['in_active_trail'] = in_array($item['mlid'], $parents);
@@ -1297,6 +1355,14 @@
   return $links;
 }
 
+function _menu_sort_callback($item1, $item2) {
+  if ($item1['weight'] != $item2['weight']) {
+    return ($item1['weight'] < $item2['weight']) ? -1 : 1;
+  }
+  
+  return ($item1['title'] < $item2['title']) ? -1 : 1;
+}
+
 /**
  * Collects the local tasks (tabs) for a given level.
  *
@@ -1321,13 +1387,34 @@
       return '';
     }
     // Get all tabs and the root page.
-    $result = db_query("SELECT * FROM {menu_router} WHERE tab_root = '%s' ORDER BY weight, title", $router_item['tab_root']);
+    $menu_tree =& menu_get_tree();
+    $items = array();
+    $cursor =& $menu_tree;
+    $parts = explode('/', $router_item['tab_root']);
+    foreach ($parts as $part) {
+      if (isset($cursor[$part])) {
+        $cursor = $cursor[$part];
+      }
+      else if (isset($cursor['%'])) {
+        $cursor = $cursor['%'];
+      }
+      else {
+        $cursor = array();
+      }
+    }
+    foreach ($cursor as $key => $item) {
+      if ($key != '#leaf') {
+        $items[] = $item;
+      }
+    }
+    usort($items, '_menu_sort_callback');
+    
     $map = arg();
     $children = array();
     $tasks = array();
     $root_path = $router_item['path'];
 
-    while ($item = db_fetch_array($result)) {
+    foreach ($items as $item) {
       _menu_translate($item, $map, TRUE);
       if ($item['tab_parent']) {
         // All tabs, but not the root page.
@@ -1627,7 +1714,11 @@
  *   rendering.
  */
 function menu_link_load($mlid) {
-  if (is_numeric($mlid) && $item = db_fetch_array(db_query("SELECT m.*, ml.* FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.mlid = %d", $mlid))) {
+  if (is_numeric($mlid) && $item = db_fetch_array(db_query("SELECT ml.* FROM {menu_links} ml WHERE ml.mlid = %d", $mlid))) {
+    $menu_item = menu_get_item($item['router_path']);
+    if ($menu_item) {
+      $item += $menu_item;
+    }
     _menu_link_translate($item);
     return $item;
   }
@@ -1648,6 +1739,7 @@
     register_shutdown_function('cache_clear_all', 'links:'. $menu_name .':', 'cache_menu', TRUE);
     $cache_cleared[$menu_name] = 2;
   }
+  menu_rebuild();
 }
 
 /**
@@ -1656,12 +1748,13 @@
  */
 function menu_cache_clear_all() {
   cache_clear_all('*', 'cache_menu', TRUE);
+  menu_rebuild();
 }
 
 /**
- * (Re)populate the database tables used by various menu functions.
+ * (Re)populate the data used by various menu functions.
  *
- * This function will clear and populate the {menu_router} table, add entries
+ * This function will clear and populate the menu tree, add entries
  * to {menu_links} for new router items, then remove stale items from
  * {menu_links}. If called from update.php or install.php, it will also
  * schedule a call to itself on the first real page load from
@@ -1669,15 +1762,9 @@
  * is different and leaves stale data in the menu tables.
  */
 function menu_rebuild() {
-  variable_del('menu_rebuild_needed');
-  $menu = menu_router_build(TRUE);
-  _menu_navigation_links_rebuild($menu);
-  // Clear the menu, page and block caches.
-  menu_cache_clear_all();
-  _menu_clear_page_cache();
-  if (defined('MAINTENANCE_MODE')) {
-    variable_set('menu_rebuild_needed', TRUE);
-  }
+  // Note the current time of the rebuild request. This timestamp is guaranteed consistent across the cluster.
+  // The rebuild request is stored for up to a day.
+  cache_set('menu_tree_rebuild', $_SERVER['REQUEST_TIME'], 'cache', $_SERVER['REQUEST_TIME'] + 86400);
 }
 
 /**
@@ -1730,7 +1817,7 @@
     $item['hidden'] = 1;
   }
   // Note, we set this as 'system', so that we can be sure to distinguish all
-  // the menu links generated automatically from entries in {menu_router}.
+  // the menu links generated automatically from entries in the menu tree.
   $item['module'] = 'system';
   $item += array(
     'menu_name' => 'navigation',
@@ -2056,15 +2143,16 @@
   // $menu will only have data during a menu rebuild.
   $menu = _menu_router_cache();
 
-  $router_path = $link_path;
-  $parts = explode('/', $link_path, MENU_MAX_PARTS);
-  list($ancestors, $placeholders) = menu_get_ancestors($parts);
-
   if (empty($menu)) {
     // Not during a menu rebuild, so look up in the database.
-    $router_path = (string)db_result(db_query_range('SELECT path FROM {menu_router} WHERE path IN ('. implode (',', $placeholders) .') ORDER BY fit DESC', $ancestors, 0, 1));
+    $menu_item = menu_get_item($link_path);
+    $router_path = $menu_item['path'];
   }
   elseif (!isset($menu[$router_path])) {
+    $router_path = $link_path;
+    $parts = explode('/', $link_path, MENU_MAX_PARTS);
+    list($ancestors, $placeholders) = menu_get_ancestors($parts);
+
     // Add an empty path as a fallback.
     $ancestors[] = '';
     foreach ($ancestors as $key => $router_path) {
@@ -2231,7 +2319,7 @@
   }
 }
 
-/**
+ /**
  * Helper function to build the router table based on the data from hook_menu.
  */
 function _menu_router_build($callbacks) {
@@ -2492,7 +2580,7 @@
   }
   elseif (preg_match('/\/\%/', $path)) {
     // Path is dynamic (ie 'user/%'), so check directly against menu_router table.
-    if ($item = db_fetch_array(db_query("SELECT * FROM {menu_router} where path = '%s' ", $path))) {
+    if ($item = menu_get_item($path)) {
       $item['link_path']  = $form_item['link_path'];
       $item['link_title'] = $form_item['link_title'];
       $item['external']   = FALSE;
@@ -2507,6 +2595,170 @@
   return $item && $item['access'];
 }
 
+/*
+ * Returns a structured array with all menu items. Pressflow-specific.
+ *
+ * @returns A structured array with all menu items.
+ */
+function menu_get_tree() {
+  // Attempt to load the tree from cache.
+  $cache_hit = FALSE;
+  $rebuild = FALSE;
+  $write_to_cache = TRUE;
+  if (function_exists('apc_fetch')) {
+    $cache_item = apc_fetch('menu_tree', $cache_hit);
+    
+    if ($cache_hit) {
+      // Check if there is a recent rebuild request.
+      $rebuild_request = cache_get('menu_tree_rebuild');
+      
+      // Check if the rebuild request postdates the locally cached menu tree.
+      if ($rebuild_request && $rebuild_request->data > $cache_item->created) {
+        // We need to rebuild the locally cached menu tree. Attempt to grab a semaphore.
+        $rebuild = apc_add('menu_tree_semaphore', TRUE, 86400);
+        
+        if (!$rebuild) {
+          // If the semaphore grab was unsuccessful, return the current (slightly stale) menu tree.
+          $tree =& $cache_item->data;
+        }
+      }
+      else {
+        $tree =& $cache_item->data;
+      }
+      
+      header('X-APC-Menu-Cache: HIT');
+    }
+    else {
+      header('X-APC-Menu-Cache: MISS');
+    }
+  }
+  else {
+    $cache_item = cache_get('menu_tree', 'cache');
+    if ($cache_item) {
+      $cache_hit = TRUE;
+      $tree = $cache_item->data;
+    }
+  }
+  
+  // On miss, rebuild the tree.
+  if (!$cache_hit || $rebuild) {
+    // Build a fresh menu.
+    $menu = menu_router_build(TRUE);
+
+    // Run the rest of the legacy menu_rebuild().
+    // TODO: Obsolete this code and anything relying on {menu_*} tables.
+    _menu_navigation_links_rebuild($menu);
+    menu_cache_clear_all();
+    _menu_clear_page_cache();
+    
+    // Return to the Pressflow rebuild.
+    $tree = array();
+    foreach ($menu as $path => $item) {
+
+      $item = array(
+        'path' => $item['path'],
+        'load_functions' => $item['load_functions'],
+        'to_arg_functions' => $item['to_arg_functions'],
+        'access_callback' => $item['access callback'],
+        'access_arguments' => serialize($item['access arguments']),
+        'page_callback' => $item['page callback'],
+        'page_arguments' => serialize($item['page arguments']),
+        'fit' => $item['_fit'],
+        'number_parts' => count($item['_parts']),
+        'tab_parent' => $item['tab_parent'],
+        'tab_root' => $item['tab_root'],
+        'title' => $item['title'],
+        'title_callback' => $item['title callback'],
+        'title_arguments' => $item['title arguments'] ? serialize($item['title arguments']) : '',
+        'type' => $item['type'],
+        'block_callback' => $item['block callback'],
+        'description' => $item['description'],
+        'position' => $item['position'],
+        'weight' => $item['weight'],
+        'file' => $item['include file'],
+        'href' => $item['href'],
+        'options' => $item['options'],
+      );
+
+      $path = explode('/', $path);
+
+      // Ensure the route to the item is initialized.
+      $cursor =& $tree;
+      foreach ($path as $element) {
+        if (!isset($cursor[$element])) {
+          $cursor[$element] = array();
+        }
+        $cursor =& $cursor[$element];
+      }
+      
+      $cursor['#leaf'] = $item;
+    }
+
+    if ($write_to_cache) {
+      // Use APC if possible.
+      if (function_exists('apc_store')) {
+        $cache_item = new stdClass();
+        $cache_item->data = $tree;
+        $cache_item->created = $_SERVER['REQUEST_TIME'];
+        
+        // TODO: Make the maximum age a variable or constant.
+        apc_store('menu_tree', $cache_item, 86400);
+        header('X-APC-Menu-Cache-Write: DONE');
+        apc_delete('menu_tree_semaphore');
+        if (defined('MAINTENANCE_MODE')) {
+          apc_add('menu_tree_rebuild', TRUE);
+        }
+        else {
+          apc_delete('menu_tree_rebuild');
+        }
+      }
+      // Otherwise use the internal cache.
+      else {
+        cache_set('menu_tree', $tree, 'cache', $_SERVER['REQUEST_TIME'] + 86400);
+        if (defined('MAINTENANCE_MODE')) {
+          cache_set('menu_tree_rebuild', TRUE, 'cache');
+        }
+        else {
+          cache_clear_all('menu_tree_rebuild', 'cache');
+        }
+      }
+    }
+  }
+  
+  return $tree;
+}
+
+function menu_get_item_old($path = NULL, $router_item = NULL) {
+  static $router_items;
+  if (!isset($path)) {
+    $path = $_GET['q'];
+  }
+  if (isset($router_item)) {
+    $router_items[$path] = $router_item;
+  }
+  if (!isset($router_items[$path])) {
+    $original_map = arg(NULL, $path);
+    $parts = array_slice($original_map, 0, MENU_MAX_PARTS);
+    list($ancestors, $placeholders) = menu_get_ancestors($parts);
+
+    if ($router_item = db_fetch_array(db_query_range('SELECT * FROM {menu_router} WHERE path IN ('. implode (',', $placeholders) .') ORDER BY fit DESC', $ancestors, 0, 1))) {
+      //echo "old router_item:\n";
+      //print_r($router_item);
+      $map = _menu_translate($router_item, $original_map);
+      if ($map === FALSE) {
+        $router_items[$path] = FALSE;
+        return FALSE;
+      }
+      if ($router_item['access']) {
+        $router_item['map'] = $map;
+        $router_item['page_arguments'] = array_merge(menu_unserialize($router_item['page_arguments'], $map), array_slice($map, $router_item['number_parts']));
+      }
+    }
+    $router_items[$path] = $router_item;
+  }
+  return $router_items[$path];
+}
+
 /**
  * @} End of "defgroup menu".
  */
 
=== modified file 'modules/book/book.module'
--- modules/book/book.module	2009-02-25 22:33:09 +0000
+++ modules/book/book.module	2009-11-30 19:05:26 +0000
@@ -1068,8 +1068,8 @@
         $i++;
       }
       $sql = "
-        SELECT b.*, m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments, m.page_callback, m.page_arguments, m.title, m.title_callback, m.title_arguments, m.type, ml.*
-        FROM {menu_links} ml INNER JOIN {menu_router} m ON m.path = ml.router_path
+        SELECT b.*, ml.*
+        FROM {menu_links} ml
         INNER JOIN {book} b ON ml.mlid = b.mlid
         WHERE ". implode(' AND ', $match) ."
         ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC, p6 ASC, p7 ASC, p8 ASC, p9 ASC";