OLD | NEW |
1 # Copyright 2013 The Chromium Authors. All rights reserved. | 1 # Copyright 2013 The Chromium Authors. All rights reserved. |
2 # Use of this source code is governed by a BSD-style license that can be | 2 # Use of this source code is governed by a BSD-style license that can be |
3 # found in the LICENSE file. | 3 # found in the LICENSE file. |
4 | 4 |
5 import logging | 5 import logging |
6 | 6 |
7 from data_source_registry import CreateDataSources | 7 from data_source_registry import CreateDataSources |
8 from third_party.handlebar import Handlebar | 8 from third_party.handlebar import Handlebar |
9 from url_constants import GITHUB_BASE, EXTENSIONS_SAMPLES | 9 from url_constants import GITHUB_BASE, EXTENSIONS_SAMPLES |
10 | 10 |
11 | 11 |
12 class TemplateRenderer(object): | 12 class TemplateRenderer(object): |
13 '''Renders templates with the server's available data sources. | 13 '''Renders templates with the server's available data sources. |
14 ''' | 14 ''' |
15 | 15 |
16 def __init__(self, server_instance): | 16 def __init__(self, server_instance): |
17 self._server_instance = server_instance | 17 self._server_instance = server_instance |
18 | 18 |
19 def Render(self, template, request): | 19 def Render(self, template, request, data_sources=None, warn=True): |
| 20 '''Renders |template| using |request|. |
| 21 Specify |data_sources| to only include the DataSources with the given names |
| 22 when rendering the template. |
| 23 Specify |warn| whether to warn (e.g. logging.warning) if there are template |
| 24 rendering errors. It may be useful to disable this when errors are expected, |
| 25 for example when doing an initial page render to determine document title. |
| 26 ''' |
20 assert isinstance(template, Handlebar), type(template) | 27 assert isinstance(template, Handlebar), type(template) |
21 server_instance = self._server_instance | 28 render_context = self._CreateDataSources(request) |
22 render_context = { | 29 if data_sources is not None: |
23 'api_list': server_instance.api_list_data_source_factory.Create(), | 30 render_context = dict((name, d) for name, d in render_context.iteritems() |
24 'apis': server_instance.api_data_source_factory.Create(request), | 31 if name in data_sources) |
| 32 render_context.update({ |
25 'apps_samples_url': GITHUB_BASE, | 33 'apps_samples_url': GITHUB_BASE, |
26 'base_path': server_instance.base_path, | 34 'base_path': self._server_instance.base_path, |
27 'extensions_samples_url': EXTENSIONS_SAMPLES, | 35 'extensions_samples_url': EXTENSIONS_SAMPLES, |
28 'samples': server_instance.samples_data_source_factory.Create(request), | 36 'static': self._server_instance.base_path + 'static', |
29 'static': server_instance.base_path + 'static', | 37 }) |
30 } | 38 render_data = template.Render(render_context) |
31 render_context.update(CreateDataSources(server_instance, request=request)) | 39 if warn and render_data.errors: |
32 render_data = template.render(render_context) | |
33 if render_data.errors: | |
34 logging.error('Handlebar error(s) rendering %s:\n%s' % | 40 logging.error('Handlebar error(s) rendering %s:\n%s' % |
35 (template._name, ' \n'.join(render_data.errors))) | 41 (template._name, ' \n'.join(render_data.errors))) |
36 return render_data.text | 42 return render_data.text |
| 43 |
| 44 def _CreateDataSources(self, request): |
| 45 server_instance = self._server_instance |
| 46 data_sources = CreateDataSources(server_instance, request=request) |
| 47 data_sources.update({ |
| 48 'api_list': server_instance.api_list_data_source_factory.Create(), |
| 49 'apis': server_instance.api_data_source_factory.Create(request), |
| 50 'samples': server_instance.samples_data_source_factory.Create(request), |
| 51 }) |
| 52 return data_sources |
OLD | NEW |