litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

NIHVIVO-1575 Collapse page and body template data models into one map

Browse source
This commit is contained in:
rjy7 2010-12-22 16:19:38 +00:00
parent 769637111d
commit 714feec254
4 changed files with 54 additions and 94 deletions
Download patch file Download diff file Expand all files Collapse all files

16
webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerComponentGenerator.java
View file

@ -33,16 +33,14 @@ public class FreemarkerComponentGenerator extends FreemarkerHttpServlet {
VitroRequest vreq = new VitroRequest(request); VitroRequest vreq = new VitroRequest(request);
Configuration config = getConfig(vreq); Configuration config = getConfig(vreq);
// root is the map used to create the page shell - header, footer, menus, etc. Map<String, Object> map = getPageTemplateValues(vreq);
Map<String, Object> root = getSharedVariables(vreq, new HashMap<String, Object>());
root.putAll(getPageTemplateValues(vreq));
request.setAttribute("ftl_head", getHead("head", root, config, vreq)); request.setAttribute("ftl_head", getHead("head", map, config, vreq));
request.setAttribute("ftl_identity", get("identity", root, config, vreq)); request.setAttribute("ftl_identity", get("identity", map, config, vreq));
request.setAttribute("ftl_menu", get("menu", root, config, vreq)); request.setAttribute("ftl_menu", get("menu", map, config, vreq));
request.setAttribute("ftl_search", get("search", root, config, vreq)); request.setAttribute("ftl_search", get("search", map, config, vreq));
request.setAttribute("ftl_footer", get("footer", root, config, vreq)); request.setAttribute("ftl_footer", get("footer", map, config, vreq));
request.setAttribute("ftl_googleAnalytics", get("googleAnalytics", root, config, vreq)); request.setAttribute("ftl_googleAnalytics", get("googleAnalytics", map, config, vreq));
} }
private String get(String templateName, Map<String, Object> root, Configuration config, HttpServletRequest request) { private String get(String templateName, Map<String, Object> root, Configuration config, HttpServletRequest request) {

116
webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java
View file

@ -165,43 +165,32 @@ public class FreemarkerHttpServlet extends VitroHttpServlet {
protected void doTemplate(VitroRequest vreq, HttpServletResponse response, ResponseValues values) { protected void doTemplate(VitroRequest vreq, HttpServletResponse response, ResponseValues values) {
Configuration config = getConfig(vreq); Configuration config = getConfig(vreq);
Map<String, Object> bodyMap = values.getMap();
TemplateProcessingHelper helper = new TemplateProcessingHelper(config, vreq, getServletContext());
// We can't use shared variables in the Freemarker configuration to store anything Map<String, Object> templateDataModel = new HashMap<String, Object>();
// except theme-specific data, because multiple portals or apps might share the same theme. So instead templateDataModel.putAll(getPageTemplateValues(vreq));
// just put the shared variables in both root and body.
Map<String, Object> sharedVariables = getSharedVariables(vreq, bodyMap);
//helper.processSetupTemplate(config, vreq, sharedVariables); // Add the values that we got from the subcontroller processRequest() method, and merge to the template.
// Subcontroller values (for example, for page title) will override what's already been set at the page
// level.
templateDataModel.putAll(values.getMap());
// root is the map used to create the page shell - header, footer, menus, etc. // If a body template is specified, merge it with the template data model.
Map<String, Object> root = new HashMap<String, Object>(sharedVariables);
root.putAll(getPageTemplateValues(vreq));
// Tell the template and any directives it uses that we're processing a page template.
root.put("templateType", PAGE_TEMPLATE_TYPE);
// Add the values that we got, and merge to the template.
String bodyTemplate = values.getTemplateName();
String bodyString; String bodyString;
String bodyTemplate = values.getTemplateName();
if (bodyTemplate != null) { if (bodyTemplate != null) {
// body is the map used to create the page body
// Adding sharedVariables before bodyMap values is important. If the body
// processing has changed a shared value such as title, we want to get that
// value.
Map<String, Object> body = new HashMap<String, Object>(sharedVariables);
body.putAll(bodyMap);
// Tell the template and any directives it uses that we're processing a body template. // Tell the template and any directives it uses that we're processing a body template.
body.put("templateType", BODY_TEMPLATE_TYPE); templateDataModel.put("templateType", BODY_TEMPLATE_TYPE);
bodyString = processTemplateToString(bodyTemplate, body, config, vreq); bodyString = processTemplateToString(bodyTemplate, templateDataModel, config, vreq);
} else { } else {
// The subcontroller has not defined a body template. All markup for the page // The subcontroller has not defined a body template. All markup for the page
// is specified in the main page template. // is specified in the main page template.
bodyString = ""; bodyString = "";
} }
root.put("body", bodyString); templateDataModel.put("body", bodyString);
writePage(root, config, vreq, response); // Tell the template and any directives it uses that we're processing a page template.
templateDataModel.put("templateType", PAGE_TEMPLATE_TYPE);
writePage(templateDataModel, config, vreq, response);
} }
protected void doRedirect(HttpServletRequest request, HttpServletResponse response, ResponseValues values) protected void doRedirect(HttpServletRequest request, HttpServletResponse response, ResponseValues values)
@ -247,52 +236,6 @@ public class FreemarkerHttpServlet extends VitroHttpServlet {
doTemplate(vreq, response, trv); doTemplate(vreq, response, trv);
} }
// We can't use shared variables in the Freemarker configuration to store anything
// except theme-specific data, because multiple portals or apps might share the same theme. So instead
// we'll get all the shared variables here, and put them in both root and body maps.
// If we can eliminate this use case and use shared variables, it would simplify the implementation greatly.
// See also directives, where since there are no shared variables we have to manually put elements
// of the data model into the directive template model.
public Map<String, Object> getSharedVariables(VitroRequest vreq, Map<String, Object> bodyMap) {
Map<String, Object> map = new HashMap<String, Object>();
Portal portal = vreq.getPortal();
// Ideally, templates wouldn't need portal id. Currently used as a hidden input value
// in the site search box, so needed for now.
map.put("portalId", portal.getPortalId());
String siteName = portal.getAppName();
map.put("siteName", siteName);
// In some cases the title is determined during the subclass processRequest() method; e.g.,
// for an Individual profile page, the title should be the Individual's label. In that case,
// put that title in the sharedVariables map because it's needed by the page root map as well
// to generate the <title> element. Otherwise, use the getTitle() method to generate the title.
String title = (String) bodyMap.get("title");
if (StringUtils.isEmpty(title)) {
title = getTitle(siteName);
}
map.put("title", title);
String themeDir = getThemeDir(portal);
UrlBuilder urlBuilder = new UrlBuilder(portal);
map.put("urls", getUrls(themeDir, urlBuilder));
map.put("themeDir", themeDir);
map.put("stylesheets", getStylesheetList(themeDir));
map.put("scripts", getScriptList(themeDir));
map.put("headScripts", getScriptList(themeDir));
map.put("currentPage", vreq.getServletPath().replaceFirst("/", ""));
map.putAll(getDirectives());
return map;
}
public String getThemeDir(Portal portal) { public String getThemeDir(Portal portal) {
return portal.getThemeDir().replaceAll("/$", ""); return portal.getThemeDir().replaceAll("/$", "");
} }
@ -388,10 +331,34 @@ public class FreemarkerHttpServlet extends VitroHttpServlet {
protected Map<String, Object> getPageTemplateValues(VitroRequest vreq) { protected Map<String, Object> getPageTemplateValues(VitroRequest vreq) {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put("tabMenu", getTabMenu(vreq));
map.put("menu", getDisplayModelMenu(vreq));
Portal portal = vreq.getPortal(); Portal portal = vreq.getPortal();
// Ideally, templates wouldn't need portal id. Currently used as a hidden input value
// in the site search box, so needed for now.
map.put("portalId", portal.getPortalId());
String siteName = portal.getAppName();
map.put("siteName", siteName);
// This may be overridden by the body data model received from the subcontroller.
map.put("title", getTitle(siteName));
String themeDir = getThemeDir(portal);
UrlBuilder urlBuilder = new UrlBuilder(portal);
map.put("urls", getUrls(themeDir, urlBuilder));
map.put("themeDir", themeDir);
map.put("stylesheets", getStylesheetList(themeDir));
map.put("scripts", getScriptList(themeDir));
map.put("headScripts", getScriptList(themeDir));
map.put("currentPage", vreq.getServletPath().replaceFirst("/", ""));
map.putAll(getDirectives());
map.put("tabMenu", getTabMenu(vreq));
map.put("menu", getDisplayModelMenu(vreq));
ApplicationBean appBean = vreq.getAppBean(); ApplicationBean appBean = vreq.getAppBean();
PortalWebUtil.populateSearchOptions(portal, appBean, vreq.getWebappDaoFactory().getPortalDao()); PortalWebUtil.populateSearchOptions(portal, appBean, vreq.getWebappDaoFactory().getPortalDao());
@ -399,15 +366,12 @@ public class FreemarkerHttpServlet extends VitroHttpServlet {
map.put("user", new User(vreq)); map.put("user", new User(vreq));
UrlBuilder urlBuilder = new UrlBuilder(portal);
map.put("version", getRevisionInfo(urlBuilder)); map.put("version", getRevisionInfo(urlBuilder));
map.put("copyright", getCopyrightInfo(portal)); map.put("copyright", getCopyrightInfo(portal));
map.put("siteTagline", portal.getShortHand()); map.put("siteTagline", portal.getShortHand());
map.put("breadcrumbs", BreadCrumbsUtil.getBreadCrumbsDiv(vreq)); map.put("breadcrumbs", BreadCrumbsUtil.getBreadCrumbsDiv(vreq));
String themeDir = getThemeDir(portal);
// This value is used only in stylesheets.ftl and already contains the context path. // This value is used only in stylesheets.ftl and already contains the context path.
map.put("stylesheetPath", UrlBuilder.getUrl(themeDir + "/css")); map.put("stylesheetPath", UrlBuilder.getUrl(themeDir + "/css"));

12
webapp/src/edu/cornell/mannlib/vitro/webapp/controller/login/LoginTemplateHelper.java
View file

@ -156,14 +156,12 @@ public class LoginTemplateHelper extends LoginTemplateHelperBase {
private String doTemplate(VitroRequest vreq, TemplateResponseValues values) { private String doTemplate(VitroRequest vreq, TemplateResponseValues values) {
// Set it up like FreeMarkerHttpServlet.doGet() would do. // Set it up like FreeMarkerHttpServlet.doGet() would do.
Configuration config = getConfig(vreq); Configuration config = getConfig(vreq);
Map<String, Object> sharedVariables = getSharedVariables(vreq, new HashMap<String, Object>());
Map<String, Object> root = new HashMap<String, Object>(sharedVariables);
Map<String, Object> body = new HashMap<String, Object>(sharedVariables);
root.putAll(getPageTemplateValues(vreq));
// Add the values that we got, and merge to the template. Map<String, Object> map = new HashMap<String, Object>();
body.putAll(values.getMap()); map.putAll(getPageTemplateValues(vreq));
return processTemplateToString(values.getTemplateName(), body, config, vreq); map.putAll(values.getMap());
return processTemplateToString(values.getTemplateName(), map, config, vreq);
} }
/** /**

2
webapp/src/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/CollatedObjectPropertyTemplateModel.java
View file

@ -39,7 +39,7 @@ public class CollatedObjectPropertyTemplateModel extends ObjectPropertyTemplateM
// RY Temporarily throw an error because collation hasn't been implemented yet. // RY Temporarily throw an error because collation hasn't been implemented yet.
boolean error = true; boolean error = true;
if (error) { if (error) {
throw new Exception("No collation target specified for collated object property " + getName()); throw new Exception("Collated object property not implemented yet");
} }
WebappDaoFactory wdf = vreq.getWebappDaoFactory(); WebappDaoFactory wdf = vreq.getWebappDaoFactory();