/** * ============LICENSE_START==================================================== * org.onap.aaf * =========================================================================== * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved. * =========================================================================== * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * ============LICENSE_END==================================================== * */ package org.onap.aaf.auth.gui; import static org.onap.aaf.misc.xgen.html.HTMLGen.A; import static org.onap.aaf.misc.xgen.html.HTMLGen.H1; import static org.onap.aaf.misc.xgen.html.HTMLGen.LI; import static org.onap.aaf.misc.xgen.html.HTMLGen.TITLE; import static org.onap.aaf.misc.xgen.html.HTMLGen.UL; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Properties; import java.util.TreeMap; import javax.servlet.http.Cookie; import javax.servlet.http.HttpServletRequest; import org.onap.aaf.auth.common.Define; import org.onap.aaf.auth.env.AuthzEnv; import org.onap.aaf.auth.env.AuthzTrans; import org.onap.aaf.auth.gui.pages.Home; import org.onap.aaf.cadi.Permission; import org.onap.aaf.cadi.aaf.AAFPermission; import org.onap.aaf.cadi.config.Config; import org.onap.aaf.cadi.principal.TaggedPrincipal; import org.onap.aaf.misc.env.APIException; import org.onap.aaf.misc.env.Env; import org.onap.aaf.misc.env.Slot; import org.onap.aaf.misc.env.StaticSlot; import org.onap.aaf.misc.env.util.Split; import org.onap.aaf.misc.xgen.Cache; import org.onap.aaf.misc.xgen.CacheGen; import org.onap.aaf.misc.xgen.Code; import org.onap.aaf.misc.xgen.DynamicCode; import org.onap.aaf.misc.xgen.Mark; import org.onap.aaf.misc.xgen.html.HTMLCacheGen; import org.onap.aaf.misc.xgen.html.HTMLGen; import org.onap.aaf.misc.xgen.html.Imports; /** * A Base "Mobile First" Page * * @author Jonathan * */ public class Page extends HTMLCacheGen { public static final String AAF_THEME = "aaf_theme"; public static final String AAFURL_TOOLS = "aaf_url.tools"; public static final String AAF_URL_TOOL_DOT = "aaf_url.tool."; public static final String AAF_URL_CUIGUI = "aaf_url.cuigui"; // link to help public static final String AAF_URL_GUI_ONBOARD = "aaf_url.gui_onboard"; public static final String AAF_URL_AAF_HELP = "aaf_url.aaf_help"; public static final String AAF_URL_CADI_HELP = "aaf_url.cadi_help"; public static final String PERM_CA_TYPE = "certman"; public static final String PERM_NS = Define.ROOT_NS(); public static final String HREF = "href="; public static final String TARGET_BLANK = "target=_blank"; public enum BROWSER {IPHONE, HTML5, IE, IEOLD}; public static final int MAX_LINE = 20; protected static final String[] NO_FIELDS = new String[0]; private static final String BROWSER_TYPE = "BROWSER_TYPE"; private final String bcName; private final String bcUrl; private final String[] fields; public final boolean noCache; // Note: Only access is synchronized in "getPerm" private static final Map> perms = new HashMap<>(); /* * Relative path, Menu Name, Full Path */ protected static final String[][] MENU_ITEMS = new String[][] { {"myperms","My Permissions","/gui/myperms"}, {"myroles","My Roles","/gui/myroles"}, {"ns","My Namespaces","/gui/ns"}, {"approve","My Approvals","/gui/approve"}, {"myrequests","My Pending Requests","/gui/myrequests"}, // Enable later //{"onboard","Onboarding"}, {"passwd","Password Management","/gui/passwd"}, {"cui","Command Prompt","/gui/cui"}, {"api","AAF API","/gui/api"}, {"clear","Clear Preferences","/gui/clear"} }; public String name() { return bcName; } public String url() { return bcUrl; } public String[] fields() { return fields; } public Page(AuthzEnv env, String name, String url, Enum[] en, final NamedCode ...content) throws APIException, IOException { super(CacheGen.PRETTY, new PageCode(env, 1, content)); fields = new String[en.length]; int i=-1; for (Enum p : en) { fields[++i]=p.name(); } bcName = name; bcUrl = url; // Mark which fields must be "no_cache" boolean noCacheTemp=false; for (NamedCode nc : content) { if (nc.noCache()) { noCacheTemp=true; break; } } noCache =noCacheTemp; } public Page(AuthzEnv env, String name, String url, String [] fields, final NamedCode ... content) throws APIException,IOException { this(env,name,url,1,fields,content); } public Page(AuthzEnv env, String name, String url, int backdots, String [] fields, final NamedCode ... content) throws APIException,IOException { super(CacheGen.PRETTY, new PageCode(env, backdots, content)); if (fields==null) { this.fields = new String[0]; } else { this.fields = fields; } bcName = name; bcUrl = url; // Mark which fields must be "no_cache" boolean noCacheTemp=false; for (NamedCode nc : content) { if (nc.noCache()) { noCacheTemp=true; break; } } noCache =noCacheTemp; } private static class PageCode implements Code { private static final String AAF_GUI_THEME = "aaf.gui.theme"; private static final String AAF_GUI_TITLE = "aaf_gui_title"; private final ContentCode[] content; private final Slot browserSlot; private final int backdots; protected AuthzEnv env; private StaticSlot sTheme; private static Map> themes; private static Map themeProps; public PageCode(AuthzEnv env, int backdots, final ContentCode[] content) { this.content = content; this.backdots = backdots; browserSlot = env.slot(BROWSER_TYPE); sTheme = env.staticSlot(AAF_GUI.AAF_GUI_THEME); this.env = env; getThemeFiles(env,""); // } private static synchronized List getThemeFiles(Env env, String theme) { if(themes==null) { themes = new TreeMap<>(); File themeD = new File("theme"); if(themeD.exists() && themeD.isDirectory()) { for (File t : themeD.listFiles()) { if(t.isDirectory()) { List la = new ArrayList<>(); for(File f : t.listFiles()) { if(f.isFile()) { if(f.getName().endsWith(".props")) { Properties props; if(themeProps == null) { themeProps = new TreeMap<>(); props = null; } else { props = themeProps.get(t.getName()); } if(props==null) { props = new Properties(); themeProps.put(t.getName(), props); } try { FileInputStream fis = new FileInputStream(f); try { props.load(fis); } finally { fis.close(); } } catch (IOException e) { env.error().log(e); } } else { la.add(f.getName()); } } } themes.put(t.getName(),la); } } } } return themes.get(theme); } protected Imports getImports(Env env, String theme, int backdots, BROWSER browser) { List ls = getThemeFiles(env,theme); Imports imp = new Imports(backdots); String prefix = "theme/" + theme + '/'; for(String f : ls) { if(f.endsWith(".js")) { imp.js(prefix + f); } else if(f.endsWith(".css")) { if(f.endsWith("iPhone.css")) { if(BROWSER.IPHONE.equals(browser)) { imp.css(prefix + f); } } else if (f.endsWith("Desktop.css")){ if(!BROWSER.IPHONE.equals(browser)) { imp.css(prefix + f); } // Make Console specific to Console page } else if (!"console.js".equals(f)) { imp.css(prefix + f); } } } return imp; } @Override public void code(final Cache cache, final HTMLGen hgen) throws APIException, IOException { // Note: I found that App Storage saves everything about the page, or not. Thus, if you declare the page uncacheable, none of the // Artifacts, like JPGs are stored, which makes this feature useless for Server driven elements cache.dynamic(hgen, new DynamicCode() { @Override public void code(AAF_GUI state, AuthzTrans trans, final Cache cache, final HTMLGen hgen) throws APIException, IOException { switch(browser(trans,browserSlot)) { case IEOLD: case IE: hgen.directive("!DOCTYPE html"); hgen.directive("meta", "http-equiv=X-UA-Compatible","content=IE=11"); default: } } }); hgen.html(); final String title = env.getProperty(AAF_GUI_TITLE,"Authentication/Authorization Framework"); final String defaultTheme = env.get(sTheme,"onap"); Mark head = hgen.head(); hgen.leaf(TITLE).text(title).end(); cache.dynamic(hgen, new DynamicCode() { @Override public void code(AAF_GUI state, AuthzTrans trans, final Cache cache, final HTMLGen hgen) throws APIException, IOException { BROWSER browser = browser(trans,browserSlot); String theme = null; Cookie[] cookies = trans.hreq().getCookies(); if(cookies!=null) { for(Cookie c : cookies) { if(AAF_GUI_THEME.equals(c.getName())) { theme=c.getValue(); if(!(themes.containsKey(theme))) { theme = defaultTheme; } break; } } } if(theme==null) { for(String t : themes.keySet()) { if(!t.equals(defaultTheme) && trans.fish(new AAFPermission(null,trans.user()+":id", AAF_GUI_THEME, t))) { theme=t; break; } } if(theme==null) { theme = defaultTheme; } List ls = getThemeFiles(trans, theme); if(ls==null) { throw new APIException("Theme " + theme + " does not exist."); } Cookie cookie = new Cookie(AAF_GUI_THEME,theme); cookie.setMaxAge(604_800); // one week trans.hresp().addCookie(cookie); } trans.setProperty(Page.AAF_THEME, theme); hgen.imports(getImports(env,theme,backdots,browser)); switch(browser) { case IE: case IEOLD: hgen.js().text("document.createElement('header');") .text("document.createElement('nav');") .done(); break; default: } } }); hgen.end(head); Mark body = hgen.body(); Mark header = hgen.header(); cache.dynamic(hgen, new DynamicCode() { @Override public void code(AAF_GUI state, AuthzTrans trans,Cache cache, HTMLGen xgen) throws APIException, IOException { // Obtain Server Info, and print // AT&T Only String env = trans.getProperty(Config.AAF_ENV,"N/A"); xgen.leaf(H1).text(title + " on " + env).end(); xgen.leaf("p","id=version").text("AAF Version: " + state.deployedVersion).end(); // Obtain User Info, and print TaggedPrincipal p = trans.getUserPrincipal(); String user; String secured; if (p==null) { user = "please choose a Login Authority"; secured = "NOT Secure!"; } else { user = p.personalName(); secured = p.tag(); } xgen.leaf("p","id=welcome").text("Welcome, ") .text(user) .text("") .text(secured) .text("").end(); switch(browser(trans,browserSlot)) { case IEOLD: case IE: xgen.incr("h5").text("This app is Mobile First HTML5. Internet Explorer " + " does not support all HTML5 standards. Old, non TSS-Standard versions may not function correctly.").br() .text(" For best results, use a highly compliant HTML5 browser like Firefox.") .end(); break; default: } } }); hgen.hr(); int cIdx; ContentCode nc; // If BreadCrumbs, put here if (content.length>0 && content[0] instanceof BreadCrumbs) { nc = content[0]; Mark ctnt = hgen.divID(nc.idattrs()); nc.code(cache, hgen); hgen.end(ctnt); cIdx = 1; } else { cIdx = 0; } hgen.end(header); hgen.divID("pageContent"); Mark inner = hgen.divID("inner"); // Content for (int i=cIdx;i() { @Override public void code(AAF_GUI state, AuthzTrans trans,Cache cache, HTMLGen xgen) throws APIException, IOException { String theme = trans.getProperty(Page.AAF_THEME); Properties props; if(theme==null) { props = null; } else { props = themeProps==null?null:themeProps.get(theme); } if(props!=null && "TRUE".equalsIgnoreCase(props.getProperty("enable_nav_btn"))) { xgen.leaf("button", "id=navBtn").end(); } } }); // Adding "nav Hamburger button" // Navigation - Using older Nav to work with decrepit IE versions Mark nav = hgen.divID("nav"); cache.dynamic(hgen, new DynamicCode() { @Override public void code(AAF_GUI state, AuthzTrans trans,Cache cache, HTMLGen xgen) throws APIException, IOException { String theme = trans.getProperty(Page.AAF_THEME); Properties props; if(theme==null) { props = null; } else { props = themeProps==null?null:themeProps.get(theme); } if((props!=null) && ("TRUE".equalsIgnoreCase(props.getProperty("main_menu_in_nav")))) { xgen.incr("h2").text("Navigation").end(); Mark mark = new Mark(); boolean selected = isSelected(trans.path(),Home.HREF); xgen.incr(mark,HTMLGen.UL) .incr(HTMLGen.LI,selected?"class=selected":"") .incr(HTMLGen.A, "href=home") .text("Home") .end(2); boolean noSelection = !selected; for(String[] mi : MENU_ITEMS) { if(noSelection) { selected = isSelected(trans.path(),mi[2]); noSelection = !selected; } else { selected = false; } xgen.incr(HTMLGen.LI,selected?"class=selected":"") .incr(HTMLGen.A, HREF+mi[2]) .text(mi[1]) .end(2); } xgen.end(mark); } } private boolean isSelected(String path, String item) { if(item.equals(path)) { return true; } else { for(ContentCode c : content) { if(c instanceof BreadCrumbs) { Page[] bc = ((BreadCrumbs)c).breadcrumbs; if(bc!=null) { for(int i = bc.length-1;i>0;--i) { if(bc[i].url().equals(item)) { return true; } } return false; } } } } return false; } }); hgen.incr("h2").text("Related Links").end(); hgen.incr(UL); String aafHelp = env.getProperty(AAF_URL_AAF_HELP,null); if (aafHelp!=null) { hgen.leaf(LI).leaf(A,HREF+env.getProperty(AAF_URL_AAF_HELP),TARGET_BLANK).text("AAF WIKI").end(2); String sub = env.getProperty(AAF_URL_AAF_HELP+".sub"); if (sub!=null) { hgen.incr(UL,"style=margin-left:5%"); for (String s : Split.splitTrim(',', sub)) { hgen.leaf(LI).leaf(A,HREF+env.getProperty(AAF_URL_AAF_HELP+".sub."+s),TARGET_BLANK).text(s.replace('+', ' ')).end(2); } hgen.end(); } } aafHelp = env.getProperty(AAF_URL_CADI_HELP,null); if (aafHelp!=null) { hgen.leaf(LI).leaf(A,HREF+aafHelp,TARGET_BLANK).text("CADI WIKI").end(2); } String tools = env.getProperty(AAFURL_TOOLS); if (tools!=null) { hgen.hr() .incr(HTMLGen.UL,"style=margin-left:5%") .leaf(HTMLGen.H3).text("Related Tools").end(); for (String tool : Split.splitTrim(',',tools)) { hgen.leaf(LI).leaf(A,HREF+env.getProperty(AAF_URL_TOOL_DOT+tool),TARGET_BLANK).text(tool.replace('+', ' ')).end(2); } hgen.end(); } hgen.end(); hgen.hr(); hgen.end(nav); // Footer - Using older Footer to work with decrepit IE versions Mark footer = hgen.divID("footer"); hgen.textCR(1, env.getProperty(AAF_GUI.AAF_GUI_COPYRIGHT)) .end(footer); hgen.end(body); hgen.endAll(); } } public static String getBrowserType() { return BROWSER_TYPE; } /** * It's IE if int >=0 * * Use int found in "ieVersion" * * Official IE 7 * Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; * .NET CLR 2.0.50727; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729) * Official IE 8 * Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; WOW64; Trident/4.0; SLCC2; * .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E; ATT) * * IE 11 Compatibility * Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; SLCC2; .NET CLR 2.0.50727; * .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET CLR 1.1.4322; .NET4.0C; .NET4.0E; InfoPath.3; HVD; ATT) * * IE 11 (not Compatiblity) * Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0; SLCC2; .NET CLR 2.0.50727; * .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET CLR 1.1.4322; .NET4.0C; .NET4.0E; InfoPath.3; HVD; ATT) * * @param trans * @return */ public static BROWSER browser(AuthzTrans trans, Slot slot) { BROWSER br = trans.get(slot, null); if (br==null) { String agent = trans.agent(); int msie; if (agent.contains("iPhone") /* other phones? */) { br=BROWSER.IPHONE; } else if ((msie = agent.indexOf("MSIE"))>=0) { msie+=5; int end = agent.indexOf(';',msie); float ver; try { ver = Float.valueOf(agent.substring(msie,end)); br = ver<8f?BROWSER.IEOLD :BROWSER.IE; } catch (Exception e) { br = BROWSER.IE; } } else { br = BROWSER.HTML5; } trans.put(slot,br); } return br; } /* * Get, rather than create each time, permissions for validations */ protected static synchronized Permission getPerm(String instance, String action) { Map msp = perms.get(instance); Permission p; if (msp==null) { msp = new HashMap<>(); perms.put(instance, msp); p=null; } else { p = msp.get(instance); } if (p==null) { p=new AAFPermission(PERM_NS, PERM_CA_TYPE,instance,action); msp.put(action, p); } return p; } protected static String getSingleParam(HttpServletRequest req, String tag) { String[] values = req.getParameterValues(tag); return values.length<1?null:values[0]; } }