openequella#637,openequella#624,openequella#619 Add icon and newWindow field, ensure externals urls come through (openequella#645)

Author: doolse

Source/Plugins/Core/com.equella.core/js/src/MainUI/Template.purs

@@ -64,8 +64,9 @@ import OEQ.Utils.Interop (nullAny)
 import Partial.Unsafe (unsafePartial)
 import React (Children, ReactClass, ReactElement, ReactThis, childrenToArray, createElement)
 import React as R
-import React.DOM (div', footer, span', text)
+import React.DOM (div', footer, img, span', text)
 import React.DOM as D
+import React.DOM.Props (src)
 import React.DOM.Props as DP
 import Web.DOM.DOMTokenList as DOMTokens
 import Web.DOM.Document (documentElement)
@@ -78,7 +79,13 @@ import Web.HTML.HTMLElement as HTML
 import Web.HTML.Window (document, toEventTarget)
 
 newtype ExternalHref = ExternalHref String 
-newtype MenuItem = MenuItem {route::Either ExternalHref String, title::String, systemIcon::Maybe String}
+newtype MenuItem = MenuItem {
+  route::Either ExternalHref String, 
+  title::String, 
+  systemIcon::Maybe String, 
+  iconUrl :: Maybe String,
+  newWindow :: Boolean
+}
 
 data Command = Init | AttemptRoute Route | NavAway Boolean
   | ToggleMenu | UserMenuAnchor (Maybe HTMLElement) | MenuClick Route | GoBack | CloseError
@@ -330,15 +337,17 @@ templateClass = withStyles ourStyles $ R.component "Template" $ \this -> do
         where 
           logoSrc = logoPath
           group items = [list {component: "nav"} (navItem <$> items)]
-          navItem (MenuItem {title,systemIcon,route}) = linkProps
+          navItem (MenuItem {title,systemIcon,route,iconUrl,newWindow}) = linkProps
             [
-              listItemIcon_ $ icon {color: inherit} [ D.text $ fromMaybe "folder" $ systemIcon ],
+              listItemIcon_ $ case iconUrl of 
+                Just url -> img [src url]
+                Nothing -> icon {color: inherit} [ D.text $ fromMaybe "folder" $ systemIcon ],
               listItemText' {disableTypography: true, primary: typography {variant: subheading, component: "div"} [text title] }
             ]
             where 
               linkProps = case route of 
                 Right r | Just m <- routeHref <$> matchRoute r -> RMUI.listItem { component: "a", href: m.href, onClick: m.onClick }
-                Left (ExternalHref href) -> RMUI.listItem { component: "a", href }
+                Left (ExternalHref href) -> RMUI.listItem { component: "a", href, target: if newWindow then "_blank" else "" }
                 Right r -> RMUI.listItem {component: "a", href: show r}
 
     htmlElement :: Effect HTMLElement
@@ -561,7 +570,9 @@ instance decodeMI :: DecodeJson MenuItem where
       _ -> Right "home.do"
     title <- o .? "title"
     systemIcon <- o .?? "systemIcon"
-    pure $ MenuItem {title, route, systemIcon}
+    iconUrl <- o .?? "iconUrl"
+    newWindow <- o .? "newWindow"
+    pure $ MenuItem {title, route, systemIcon, iconUrl, newWindow}
 
 decodeCounts :: Json -> Either String Counts
 decodeCounts v = do 

Source/Plugins/Core/com.equella.core/scalasrc/com/tle/web/api/LegacyContentApi.scala

@@ -66,7 +66,8 @@ case class InternalRedirect(route: String, userUpdated: Boolean)
 
 case class ExternalRedirect(href: String)
 
-case class MenuItem(title: String, href: Option[String], systemIcon: Option[String], route: Option[String])
+case class MenuItem(title: String, href: Option[String], systemIcon: Option[String], route: Option[String],
+                    iconUrl: Option[String], newWindow: Boolean)
 
 case class LegacyContent
 (html: Map[String, String],
@@ -94,15 +95,15 @@ object LegacyContentController extends AbstractSectionsController with SectionFi
 
   import LegacyGuice.urlService
 
-  def relativeURI(uri: String): Option[String] = {
+  def relativeURI(uri: String): Option[RelativeUrl] = {
     val baseUrl = AbsoluteUrl.parse(urlService.getBaseInstitutionURI.toString)
     val Host = baseUrl.host
     val Port = baseUrl.port
     val basePaths = baseUrl.path.parts.filter(_.length > 0)
     Url.parse(uri) match {
-      case RelativeUrl(RootlessPath(_), _, _) => Some(uri)
+      case r: RelativeUrl => Some(r)
       case AbsoluteUrl(_, Authority(_, Host, Port), path, q, f) if path.parts.startsWith(basePaths) =>
-        Some(RelativeUrl(RootlessPath(path.parts.drop(basePaths.length)), q, f).toString())
+        Some(RelativeUrl(RootlessPath(path.parts.drop(basePaths.length)), q, f))
       case _ => None
     }
   }
@@ -260,12 +261,16 @@ class LegacyContentApi {
             val menuLink = mc.getLink
             val href = Option(menuLink.getBookmark).getOrElse(
               new BookmarkAndModify(context, menuLink.getHandlerMap.getHandler("click").getModifier)).getHref
-            val relativized = LegacyContentController.relativeURI(href)
-
+            val relativized = LegacyContentController.relativeURI(href).filter(_.path.parts.last.endsWith(".do"))
+            val route = Option(mc.getRoute)
+            val iconUrl = if (mc.isCustomImage) Some(mc.getBackgroundImagePath) else None
             MenuItem(menuLink.getLabelText,
-              None,
+              if (relativized.isEmpty && route.isEmpty) Some(href) else None,
               Option(mc.getSystemIcon),
-              Option(mc.getRoute).orElse(relativized))
+              route.orElse(relativized.map(_.toString)),
+              iconUrl,
+              "_blank" == menuLink.getTarget
+            )
           }
       }
     }

Source/Plugins/Core/com.equella.core/src/com/tle/web/customlinks/menu/CustomLinksMenuContributor.java

@@ -110,7 +110,9 @@ private MenuContribution newLink(String name, String url, int order, boolean new
 		link.setLabel(new TextLabel(name));
 		link.setTarget(target);
 
-		return new MenuContribution(link, iconUrl, 20, order);
+		MenuContribution mc = new MenuContribution(link, iconUrl, 20, order);
+		mc.setCustomImage(true);
+		return mc;
 	}
 
 	@Override

Source/Plugins/Core/com.equella.core/src/com/tle/web/template/section/MenuContributor.java

@@ -35,6 +35,7 @@ class MenuContribution
 		private final int linkPriority;
 		private final String systemIcon;
 		private final String route;
+		private boolean customImage;
 
 		public MenuContribution(HtmlLinkState link, String backgroundImage, int groupPriority, int linkPriority, String systemIcon,
 								String route)
@@ -72,6 +73,16 @@ public String getBackgroundImagePath()
 			return backgroundImagePath;
 		}
 
+		public boolean isCustomImage()
+		{
+			return customImage;
+		}
+
+		public void setCustomImage(boolean customImage)
+		{
+			this.customImage = customImage;
+		}
+
 		public int getGroupPriority()
 		{
 			return groupPriority;