Extension docs: Include sidenav in 404 pages

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 json
 import logging
 
 import compiled_file_system as compiled_fs
 from third_party.json_schema_compiler.model import UnixName
 
 class SidenavDataSource(object):
   """This class reads in and caches a JSON file representing the side navigation
   menu.
   """
   class Factory(object):
-    def __init__(self, compiled_fs_factory, json_path):
+    def __init__(self, compiled_fs_factory, json_path, base_path):
       self._cache = compiled_fs_factory.Create(self._CreateSidenavDict,
                                                SidenavDataSource)
       self._json_path = json_path
+      self._base_path = base_path
 
     def Create(self, path):
       """Create a SidenavDataSource, binding it to |path|. |path| is the url
       of the page that is being rendered. It is used to determine which item
       in the sidenav should be highlighted.
       """
-      return SidenavDataSource(self._cache, self._json_path, path)
+      return SidenavDataSource(self._cache,
+                               self._json_path,
+                               path,
+                               self._base_path)
 
     def _AddLevels(self, items, level):
       """Levels represent how deeply this item is nested in the sidenav. We
       start at 2 because the top <ul> is the only level 1 element.
       """
       for item in items:
         item['level'] = level
         if 'items' in item:
           self._AddLevels(item['items'], level + 1)
 
     def _CreateSidenavDict(self, json_path, json_str):
       items = json.loads(json_str)
       self._AddLevels(items, 2);
       return items
 
-  def __init__(self, cache, json_path, path):
+  def __init__(self, cache, json_path, path, base_path):
     self._cache = cache
     self._json_path = json_path
     self._file_name = path.split('/')[-1]
+    self._base_path = base_path
 
   def _AddSelected(self, items):
     for item in items:
       if item.get('fileName', '') == self._file_name:
         item['selected'] = True
         return True
       if 'items' in item:
         if self._AddSelected(item['items']):
           item['child_selected'] = True
           return True
     return False
 
+  def _ConvertToAbsolutePath(self, items, key):
+    for item in items:
+      fileName = item.get('fileName')

[not at google - send to devlin, 2013/05/24 16:58:29]

file_name = ...

[方觉(Fang Jue), 2013/05/25 00:08:39]

Done.

+      if fileName is not None and not fileName.startswith(('/',
+                                                           'http://',
+                                                           'https://')):
+        item['fileName'] = '%s/%s/%s' % (self._base_path, key, fileName)
+      if 'items' in item:
+        self._ConvertToAbsolutePath(item['items'], key)
+
   def get(self, key):
     sidenav = copy.deepcopy(self._cache.GetFromFile(
         '%s/%s_sidenav.json' % (self._json_path, key)))
     self._AddSelected(sidenav)
+    self._ConvertToAbsolutePath(sidenav, key)

[not at google - send to devlin, 2013/05/24 16:58:29]

it would be more correct to use the path of the request for this, not the key.
As it is, this assumes that code under foo/ will request foo.json which may not
always be the case.

in fact that might make it unnecessary to pass in the base path here at all.

[方觉(Fang Jue), 2013/05/25 00:08:39]

path here is something like 'extensions/index.html', which doesn't contain the
channel. So base path (will be /trunk for example) is necessary.

Use path here seems to be more correct. Done.

[not at google - send to devlin, 2013/05/28 14:53:37]

Why is the 'extensions/index.html' example special? I'll comment on the new
code.

     return sidenav