Sonar Fixes, Formatting
[aaf/authz.git] / auth / auth-gui / src / main / java / org / onap / aaf / auth / gui / Page.java
index 243e66b..1d797aa 100644 (file)
@@ -7,9 +7,9 @@
  * 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.
@@ -63,8 +63,8 @@ import org.onap.aaf.misc.xgen.html.HTMLGen;
 import org.onap.aaf.misc.xgen.html.Imports;
 
 /**
- * A Base "Mobile First" Page 
- * 
+ * A Base "Mobile First" Page
+ *
  * @author Jonathan
  *
  */
@@ -93,18 +93,35 @@ public class Page extends HTMLCacheGen {
     // Note: Only access is synchronized in "getPerm"
     private final static Map<String,Map<String,Permission>> 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];
@@ -118,7 +135,7 @@ public class Page extends HTMLCacheGen {
         // Mark which fields must be "no_cache"
         boolean no_cacheTemp=false;
         for (NamedCode nc : content) {
-            if (nc.no_cache()) { 
+            if (nc.no_cache()) {
                 no_cacheTemp=true;
                 break;
             }
@@ -128,7 +145,7 @@ public class Page extends HTMLCacheGen {
     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) {
@@ -141,26 +158,26 @@ public class Page extends HTMLCacheGen {
         // Mark which fields must be "no_cache"
         boolean no_cacheTemp=false;
         for (NamedCode nc : content) {
-            if (nc.no_cache()) { 
+            if (nc.no_cache()) {
                 no_cacheTemp=true;
                 break;
             }
         }
         no_cache=no_cacheTemp;
     }
-    
-    
+
+
     private static class PageCode implements Code<HTMLGen> {
-                       private static final String AAF_GUI_THEME = "aaf.gui.theme";
-                       private static final String AAF_GUI_TITLE = "aaf_gui_title";
-            
+            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<String,List<String>> themes;
-               private static Map<String,Properties> themeProps;
+            private static Map<String,List<String>> themes;
+            private static Map<String,Properties> themeProps;
 
             public PageCode(AuthzEnv env, int backdots, final ContentCode[] content) {
                 this.content = content;
@@ -168,83 +185,83 @@ public class Page extends HTMLCacheGen {
                 browserSlot = env.slot(BROWSER_TYPE);
                 sTheme = env.staticSlot(AAF_GUI.AAF_GUI_THEME);
                 this.env = env;
-                       getThemeFiles(env,""); //
+                   getThemeFiles(env,""); //
             }
 
             private static synchronized List<String> getThemeFiles(Env env, String theme) {
-               if(themes==null) {
-                       themes = new TreeMap<>();
+                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<String> 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);
-                               }
-                       }
+                        for (File t : themeD.listFiles()) {
+                            if(t.isDirectory()) {
+                                List<String> 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);
+                }
+                return themes.get(theme);
             }
-            
+
             protected Imports getImports(Env env, String theme, int backdots, BROWSER browser) {
-               List<String> 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;
+                List<String> 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<HTMLGen> 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 
+                // 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<HTMLGen,AAF_GUI,AuthzTrans>() {
                     @Override
@@ -260,43 +277,47 @@ public class Page extends HTMLCacheGen {
                 });
                 hgen.html();
                 final String title = env.getProperty(AAF_GUI_TITLE,"Authentication/Authorization Framework");
-                final String defaultTheme = env.get(sTheme,"onap"); 
-              
+                final String defaultTheme = env.get(sTheme,"onap");
+
                 Mark head = hgen.head();
                     hgen.leaf(TITLE).text(title).end();
                     cache.dynamic(hgen, new DynamicCode<HTMLGen,AAF_GUI,AuthzTrans>() {
                         @Override
                         public void code(AAF_GUI state, AuthzTrans trans, final Cache<HTMLGen> 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;
-                                       }
-                                       Cookie cookie = new Cookie(AAF_GUI_THEME,theme);
-                                       cookie.setMaxAge(604_800); // one week
-                                       trans.hresp().addCookie(cookie);
-                               }
-                               trans.setProperty(Page.AAF_THEME, theme);
+                            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<String> 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) {
@@ -308,11 +329,11 @@ public class Page extends HTMLCacheGen {
                                     break;
                                 default:
                             }
-                            
+
                         }
                     });
                     hgen.end(head);
-                    
+
                 Mark body = hgen.body();
                     Mark header = hgen.header();
                     cache.dynamic(hgen, new DynamicCode<HTMLGen,AAF_GUI,AuthzTrans>() {
@@ -324,7 +345,7 @@ public class Page extends HTMLCacheGen {
                             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,secured;
@@ -340,11 +361,11 @@ public class Page extends HTMLCacheGen {
                                 .text("<sup>")
                                 .text(secured)
                                 .text("</sup>").end();
-                            
+
                             switch(browser(trans,browserSlot)) {
                                 case ieOld:
                                 case ie:
-                                    xgen.incr("h5").text("This app is Mobile First HTML5.  Internet Explorer " 
+                                    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();
@@ -353,9 +374,9 @@ public class Page extends HTMLCacheGen {
                             }
                         }
                     });
-                    
+
                     hgen.hr();
-                    
+
                     int cIdx;
                     ContentCode nc;
                     // If BreadCrumbs, put here
@@ -368,7 +389,7 @@ public class Page extends HTMLCacheGen {
                     } else {
                         cIdx = 0;
                     }
-                    
+
                     hgen.end(header);
 
                     hgen.divID("pageContent");
@@ -381,23 +402,23 @@ public class Page extends HTMLCacheGen {
                             hgen.end(ctnt);
                         }
 
-                    hgen.end(inner);    
+                    hgen.end(inner);
+
 
-                    
                     cache.dynamic(hgen, new DynamicCode<HTMLGen,AAF_GUI,AuthzTrans>() {
                         @Override
                         public void code(AAF_GUI state, AuthzTrans trans,Cache<HTMLGen> 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();
-                               }
+                            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"
@@ -406,64 +427,64 @@ public class Page extends HTMLCacheGen {
                     cache.dynamic(hgen, new DynamicCode<HTMLGen,AAF_GUI,AuthzTrans>() {
                         @Override
                         public void code(AAF_GUI state, AuthzTrans trans,Cache<HTMLGen> 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) {
-                                       if("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);
-                                                       //trans.path().endsWith("home");
-                                       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 : Home.MENU_ITEMS) {
-                                               //selected = trans.path().endsWith(mi[0]);
-                                               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);
-                                       }
-                               }
+                            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) {
+                                if("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);
+                                            //trans.path().endsWith("home");
+                                    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) {
+                                        //selected = trans.path().endsWith(mi[0]);
+                                        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;
-                                               }
+                        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);
@@ -495,15 +516,15 @@ public class Page extends HTMLCacheGen {
                         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();
         }
@@ -512,27 +533,27 @@ public class Page extends HTMLCacheGen {
     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; 
+     *         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; 
+     *         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; 
+     *         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; 
+     *         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
      */
@@ -540,7 +561,7 @@ public class Page extends HTMLCacheGen {
         BROWSER br = trans.get(slot, null);
         if (br==null) {
             String agent = trans.agent();
-            int msie; 
+            int msie;
             if (agent.contains("iPhone") /* other phones? */) {
                 br=BROWSER.iPhone;
             } else if ((msie = agent.indexOf("MSIE"))>=0) {
@@ -560,7 +581,7 @@ public class Page extends HTMLCacheGen {
         }
         return br;
     }
-    
+
     /*
      * Get, rather than create each time, permissions for validations
      */