From 09de618c62e99757bf10076a59a84b8a2ba23b1e Mon Sep 17 00:00:00 2001 From: David Horwitz Date: Fri, 31 Jan 2020 20:39:13 +0200 Subject: [PATCH] SAK-43114 Deprecated Web.serverUrl => RequestFilter.serverUrl (#7835) --- .../sakaiproject/jsf/renderer/CourierRenderer.java | 2 +- .../util/SakaiBaseURLProviderFactory.java | 4 ++-- .../org/sakaiproject/login/tool/SkinnableLogin.java | 3 ++- .../portal/charon/SkinnableCharonPortal.java | 11 ++++++----- .../portal/charon/handlers/SiteHandler.java | 7 ++++--- .../portal/charon/site/PortalSiteHelperImpl.java | 3 ++- .../org/sakaiproject/presence/tool/PresenceTool.java | 3 ++- .../java/org/sakaiproject/site/tool/SiteAction.java | 3 +-- .../cheftool/VelocityPortletPaneledAction.java | 3 ++- 9 files changed, 22 insertions(+), 17 deletions(-) diff --git a/jsf/jsf-widgets/src/java/org/sakaiproject/jsf/renderer/CourierRenderer.java b/jsf/jsf-widgets/src/java/org/sakaiproject/jsf/renderer/CourierRenderer.java index c898c7b80d42..1e2eb1ab3a5a 100644 --- a/jsf/jsf-widgets/src/java/org/sakaiproject/jsf/renderer/CourierRenderer.java +++ b/jsf/jsf-widgets/src/java/org/sakaiproject/jsf/renderer/CourierRenderer.java @@ -105,7 +105,7 @@ public void encodeEnd(FacesContext context, UIComponent component) throws IOExce } /** - * This method is a duplicate of org.sakaiproject.util.web.Web.serverUrl() + * This method is a duplicate of {@link org.sakaiproject.util.RequestFilter#serverUrl(HttpServletRequest)} * Duplicated here from org.sakaiproject.util.web.Web.java so that * the JSF tag library doesn't have a direct jar dependency on more of Sakai. */ diff --git a/lessonbuilder/tool/src/java/org/sakaiproject/lessonbuildertool/util/SakaiBaseURLProviderFactory.java b/lessonbuilder/tool/src/java/org/sakaiproject/lessonbuildertool/util/SakaiBaseURLProviderFactory.java index cf25f062fe09..e30fb1cf78b7 100644 --- a/lessonbuilder/tool/src/java/org/sakaiproject/lessonbuildertool/util/SakaiBaseURLProviderFactory.java +++ b/lessonbuilder/tool/src/java/org/sakaiproject/lessonbuildertool/util/SakaiBaseURLProviderFactory.java @@ -21,7 +21,7 @@ import javax.servlet.ServletContext; import javax.servlet.http.HttpServletRequest; -import org.sakaiproject.rsf.copies.Web; +import org.sakaiproject.util.RequestFilter; import org.springframework.beans.factory.FactoryBean; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; @@ -51,7 +51,7 @@ public void setHttpServletRequest(HttpServletRequest request) { // This method adjusts the protocol and port from a "correctly" computed // URL to be closer to reality, via the hackery from Sakai "Web" utils. public static String fixSakaiURL(HttpServletRequest req, String computed) { - String serverURL = Web.serverUrl(req); + String serverURL = RequestFilter.serverUrl(req); int endprotpos = computed.indexOf("://"); int slashpos = computed.indexOf('/', endprotpos + 3); return serverURL + computed.substring(slashpos); diff --git a/login/login-tool/tool/src/java/org/sakaiproject/login/tool/SkinnableLogin.java b/login/login-tool/tool/src/java/org/sakaiproject/login/tool/SkinnableLogin.java index 48c6b3735bd2..d3e58626d53a 100644 --- a/login/login-tool/tool/src/java/org/sakaiproject/login/tool/SkinnableLogin.java +++ b/login/login-tool/tool/src/java/org/sakaiproject/login/tool/SkinnableLogin.java @@ -58,6 +58,7 @@ import org.sakaiproject.tool.cover.SessionManager; import org.sakaiproject.util.ResourceLoader; import org.sakaiproject.util.Web; +import org.sakaiproject.util.RequestFilter; @Slf4j public class SkinnableLogin extends HttpServlet implements Login { @@ -240,7 +241,7 @@ else if ("/xlogin".equals(option)) session.setAttribute(ATTR_RETURN_URL, Web.returnUrl(req, null)); String containerCheckPath = this.getServletConfig().getInitParameter("container"); - String containerCheckUrl = Web.serverUrl(req) + containerCheckPath; + String containerCheckUrl = RequestFilter.serverUrl(req) + containerCheckPath; // support query parms in url for container auth String queryString = req.getQueryString(); diff --git a/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/SkinnableCharonPortal.java b/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/SkinnableCharonPortal.java index 13b6af714706..f74e34395491 100644 --- a/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/SkinnableCharonPortal.java +++ b/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/SkinnableCharonPortal.java @@ -132,6 +132,7 @@ import org.sakaiproject.util.ResourceLoader; import org.sakaiproject.util.Validator; import org.sakaiproject.util.Web; +import org.sakaiproject.util.RequestFilter; import lombok.extern.slf4j.Slf4j; @@ -531,7 +532,7 @@ public PortalRenderContext includePortal(HttpServletRequest req, PortalRenderContext rcontext = startPageContext(siteType, title, siteSkin, req, site); // Make the top Url where the "top" url is - String portalTopUrl = Web.serverUrl(req) + String portalTopUrl = RequestFilter.serverUrl(req) + ServerConfigurationService.getString("portalPath") + "/"; if (prefix != null) portalTopUrl = portalTopUrl + prefix + "/"; @@ -673,7 +674,7 @@ public Map includeTool(HttpServletResponse res, HttpServletRequest req, // Reset is different for Portlets if (isPortletPlacement(placement)) { - resetActionUrl = Web.serverUrl(req) + resetActionUrl = RequestFilter.serverUrl(req) + ServerConfigurationService.getString("portalPath") + URLUtils.getSafePathInfo(req) + "?sakai.state.reset=true"; } @@ -724,7 +725,7 @@ public Map includeTool(HttpServletResponse res, HttpServletRequest req, if (renderResult.getJSR168HelpUrl() != null) { - toolMap.put("toolJSR168Help", Web.serverUrl(req) + renderResult.getJSR168HelpUrl()); + toolMap.put("toolJSR168Help", RequestFilter.serverUrl(req) + renderResult.getJSR168HelpUrl()); } // Must have site.upd to see the Edit button @@ -733,7 +734,7 @@ public Map includeTool(HttpServletResponse res, HttpServletRequest req, if (securityService.unlock(SiteService.SECURE_UPDATE_SITE, site .getReference())) { - String editUrl = Web.serverUrl(req) + renderResult.getJSR168EditUrl(); + String editUrl = RequestFilter.serverUrl(req) + renderResult.getJSR168EditUrl(); toolMap.put("toolJSR168Edit", editUrl); toolMap.put("toolJSR168EditEncode", URLUtils.encodeUrl(editUrl)); } @@ -1793,7 +1794,7 @@ public void includeLogin(PortalRenderContext rcontext, HttpServletRequest req, { // for the main login/out link - String logInOutUrl = Web.serverUrl(req); + String logInOutUrl = RequestFilter.serverUrl(req); String message = null; String image1 = null; diff --git a/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/handlers/SiteHandler.java b/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/handlers/SiteHandler.java index fe875c176d83..a3e266ff8612 100644 --- a/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/handlers/SiteHandler.java +++ b/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/handlers/SiteHandler.java @@ -78,6 +78,7 @@ import org.sakaiproject.util.ResourceLoader; import org.sakaiproject.util.Validator; import org.sakaiproject.util.Web; +import org.sakaiproject.util.RequestFilter; import lombok.extern.slf4j.Slf4j; @@ -577,7 +578,7 @@ public void doSite(HttpServletRequest req, HttpServletResponse res, Session sess }catch(Exception e){} //End - log the visit into SAKAI_EVENT - rcontext.put("currentUrlPath", Web.serverUrl(req) + req.getContextPath() + rcontext.put("currentUrlPath", RequestFilter.serverUrl(req) + req.getContextPath() + URLUtils.getSafePathInfo(req)); rcontext.put("usePortalSearch", ServerConfigurationService.getBoolean("portal.search.enabled", true)); @@ -943,7 +944,7 @@ public void includeTabs(PortalRenderContext rcontext, HttpServletRequest req, rcontext.put("tabsAddLogout", Boolean.valueOf(addLogout)); if (addLogout) { - String logoutUrl = Web.serverUrl(req) + String logoutUrl = RequestFilter.serverUrl(req) + ServerConfigurationService.getString("portalPath") + "/logout_gallery"; rcontext.put("tabsLogoutUrl", logoutUrl); @@ -956,7 +957,7 @@ public void includeTabs(PortalRenderContext rcontext, HttpServletRequest req, rcontext.put("tabsAddLogout", Boolean.valueOf(addLogout)); if (addLogout) { - String logoutUrl = Web.serverUrl(req) + String logoutUrl = RequestFilter.serverUrl(req) + ServerConfigurationService.getString("portalPath") + "/logout_gallery"; rcontext.put("tabsLogoutUrl", logoutUrl); diff --git a/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/site/PortalSiteHelperImpl.java b/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/site/PortalSiteHelperImpl.java index 78ee922ab96c..a1c7ab6f7fcf 100644 --- a/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/site/PortalSiteHelperImpl.java +++ b/portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/site/PortalSiteHelperImpl.java @@ -82,6 +82,7 @@ import org.sakaiproject.util.MapUtil; import org.sakaiproject.util.Validator; import org.sakaiproject.util.Web; +import org.sakaiproject.util.RequestFilter; import lombok.extern.slf4j.Slf4j; @@ -475,7 +476,7 @@ public Map convertSiteToMap(HttpServletRequest req, Site s, String prefix, m.put("shortDescription", Web.escapeHtml(shortDesc_trimmed)); } - String siteUrl = Web.serverUrl(req) + String siteUrl = RequestFilter.serverUrl(req) + ServerConfigurationService.getString("portalPath") + "/"; if (prefix != null) siteUrl = siteUrl + prefix + "/"; // siteUrl = siteUrl + Web.escapeUrl(siteHelper.getSiteEffectiveId(s)); diff --git a/presence/presence-tool/tool/src/java/org/sakaiproject/presence/tool/PresenceTool.java b/presence/presence-tool/tool/src/java/org/sakaiproject/presence/tool/PresenceTool.java index 25b492869191..b8d28a835ccc 100644 --- a/presence/presence-tool/tool/src/java/org/sakaiproject/presence/tool/PresenceTool.java +++ b/presence/presence-tool/tool/src/java/org/sakaiproject/presence/tool/PresenceTool.java @@ -49,6 +49,7 @@ import org.sakaiproject.util.PresenceObservingCourier; import org.sakaiproject.util.ResourceLoader; import org.sakaiproject.util.Web; +import org.sakaiproject.util.RequestFilter; /** *

@@ -224,7 +225,7 @@ protected void sendAutoUpdate(PrintWriter out, HttpServletRequest req, String pl int updateTime = PresenceService.getTimeout() / 2; String userId = SessionManager.getCurrentSessionUserId(); - StringBuilder url = new StringBuilder(Web.serverUrl(req)); + StringBuilder url = new StringBuilder(RequestFilter.serverUrl(req)); url.append("/courier/"); url.append(placementId); url.append("?userId="); diff --git a/site-manage/site-manage-tool/tool/src/java/org/sakaiproject/site/tool/SiteAction.java b/site-manage/site-manage-tool/tool/src/java/org/sakaiproject/site/tool/SiteAction.java index f47a4e558001..792bcb228dbf 100644 --- a/site-manage/site-manage-tool/tool/src/java/org/sakaiproject/site/tool/SiteAction.java +++ b/site-manage/site-manage-tool/tool/src/java/org/sakaiproject/site/tool/SiteAction.java @@ -174,7 +174,6 @@ import org.sakaiproject.util.ResourceLoader; import org.sakaiproject.util.SortedIterator; import org.sakaiproject.util.Validator; -import org.sakaiproject.util.Web; import org.sakaiproject.util.api.LinkMigrationHelper; import lombok.extern.slf4j.Slf4j; @@ -15102,7 +15101,7 @@ public boolean displaySiteAlias() { private void putDownloadParticipantPDFLinkIntoContext(Context context, RunData data, Site site) { // the status servlet reqest url - String url = Web.serverUrl(data.getRequest()) + "/sakai-site-manage-tool/tool/printparticipant/" + site.getId(); + String url = RequestFilter.serverUrl(data.getRequest()) + "/sakai-site-manage-tool/tool/printparticipant/" + site.getId(); context.put("downloadParticipantsPDF_URL", url); } diff --git a/velocity/tool/src/java/org/sakaiproject/cheftool/VelocityPortletPaneledAction.java b/velocity/tool/src/java/org/sakaiproject/cheftool/VelocityPortletPaneledAction.java index 7d5b0178ac6b..097c7a384cb7 100644 --- a/velocity/tool/src/java/org/sakaiproject/cheftool/VelocityPortletPaneledAction.java +++ b/velocity/tool/src/java/org/sakaiproject/cheftool/VelocityPortletPaneledAction.java @@ -63,6 +63,7 @@ import org.sakaiproject.util.ResourceLoader; import org.sakaiproject.util.Validator; import org.sakaiproject.util.Web; +import org.sakaiproject.util.RequestFilter; import org.sakaiproject.vm.ActionURL; import lombok.extern.slf4j.Slf4j; @@ -1124,7 +1125,7 @@ protected void setVmCourier(HttpServletRequest request, int refresh) if (placement != null) { String userId = SessionManager.getCurrentSessionUserId(); - StringBuilder url = new StringBuilder(Web.serverUrl(request)); + StringBuilder url = new StringBuilder(RequestFilter.serverUrl(request)); url.append("/courier/"); url.append(placement.getId()); url.append("?userId=");