Clean patch with DCC static content

chrome/common/extensions/docs/server2/sidenav_data_source.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import copy
 import logging
 
 from compiled_file_system import SingleFile, Unicode
 from data_source import DataSource
 from extensions_paths import JSON_TEMPLATES
@@ skipping 20 matching lines @@
     if item.get('href', '') == path:
       item['selected'] = True
       return True
     if 'items' in item:
       if _AddSelected(item['items'], path):
         item['child_selected'] = True
         return True
 
   return False
 
+def _ProcessRelated(items, path, parent=None):
+  '''Add 'selected' and 'child_selected' properties to |items| so that the
+  sidenav can be expanded to show which menu item has been selected. Returns
+  True if an item was marked 'selected'.
+  '''
+  for item in items:
+    # depth first search
+    if 'items' in item:
+      result = _ProcessRelated(item['items'], path, item) 
+      if result:
+        return result
+
+    if item.get('href', '') == path:
+      related = []
+      for sibling in items:
+        if sibling == item:
+          sibling = copy.deepcopy(sibling)
+          sibling['active'] = True
+        related.append(sibling)
+      return (related, parent)
+
+  return None
+
+
 
 class SidenavDataSource(DataSource):
   '''Provides templates with access to JSON files used to create the side
   navigation bar.
   '''
   def __init__(self, server_instance, request):
     self._cache = server_instance.compiled_fs_factory.Create(
         server_instance.host_file_system_provider.GetTrunk(),
         self._CreateSidenavDict,
         SidenavDataSource)
@@ skipping 21 matching lines @@
       href = item.get('href')
       if href is not None and not href.startswith(('http://', 'https://')):
         if not href.startswith('/'):
           logging.warn('Paths in sidenav must be qualified. %s is not.' % href)
         else:
           href = href.lstrip('/')
         item['href'] = self._server_instance.base_path + href
 
   def Cron(self):
     futures = [self._cache.GetFromFile('%s/%s_sidenav.json' %
-                                       (JSON_TEMPLATES, platform))
-               for platform in ('apps', 'extensions')]
+                                       (JSON_TEMPLATES, nav_type))
+               for nav_type in ('top', 'related')]

[not at google - send to devlin, 2013/12/13 23:05:12]

this should be just 'chrome' not ('top', 'related').

[Renato Mangini (chromium), 2013/12/17 20:32:33]

Done.

     return Future(delegate=Gettable(lambda: [f.Get() for f in futures]))
 
   def get(self, key):
-    sidenav = copy.deepcopy(self._cache.GetFromFile(
-        '%s/%s_sidenav.json' % (JSON_TEMPLATES, key)).Get())
-    _AddSelected(sidenav, self._server_instance.base_path + self._request.path)
+    sidenav = self._cache.GetFromFile(
+        '%s/chrome_sidenav.json' % JSON_TEMPLATES).Get()
+    if key == 'related':
+      (items, parent) = _ProcessRelated(sidenav, 
+                         self._server_instance.base_path + self._request.path) 

[not at google - send to devlin, 2013/12/14 02:41:05]

Also: it looks like _ProcessRelated can return None here, which will crash.

[Renato Mangini (chromium), 2013/12/17 20:32:33]

Done.

+      return {'items': items, 'parent': parent}
+    else:
+      sidenav = copy.deepcopy(sidenav)
+      _AddSelected(sidenav, self._server_instance.base_path + self._request.path)

[not at google - send to devlin, 2013/12/13 23:03:47]

The change I'd rather see to this file is that the _AddSelected becomes
_AddAnnotations, in which we both annotate the selected and the related items,
then it's up to the templates to render that correctly.

That would also make testing this easier.

If you really want to land this CL now then I don't mind you landing it, but,
please make that change asap.

[Renato Mangini (chromium), 2013/12/17 20:32:33]

Done, although the template is more complicated and slower now. Although the
related pages is a flat list, now the template has to navigate through the tree
to get the parent title and the related pages. But I agree that the server code
is simpler and more elegant.

+      
     return sidenav