com.helger.photon.app.url.LinkHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-oton-app Show documentation
Show all versions of ph-oton-app Show documentation
ph-oton basic application stuff
/*
* Copyright (C) 2014-2023 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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.
*/
package com.helger.photon.app.url;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.GuardedBy;
import javax.annotation.concurrent.ThreadSafe;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.concurrent.SimpleReadWriteLock;
import com.helger.commons.regex.RegExHelper;
import com.helger.commons.string.StringHelper;
import com.helger.commons.url.SimpleURL;
import com.helger.commons.url.URLProtocolRegistry;
import com.helger.servlet.ServletContextPathHolder;
import com.helger.web.scope.IRequestWebScopeWithoutResponse;
import com.helger.web.scope.mgr.WebScopeManager;
/**
* Misc utilities to create link URLs.
*
* @author Philip Helger
*/
@ThreadSafe
public final class LinkHelper
{
public static final String STREAM_SERVLET_NAME_REGEX = "[a-zA-Z0-9-_]+";
/**
* The default name of the stream servlet. If this is different in you
* application you may not use the methods that refer to this path!
*/
public static final String DEFAULT_STREAM_SERVLET_NAME = "stream";
private static final Logger LOGGER = LoggerFactory.getLogger (LinkHelper.class);
private static final SimpleReadWriteLock RW_LOCK = new SimpleReadWriteLock ();
@GuardedBy ("RW_LOCK")
private static String s_sStreamServletName = DEFAULT_STREAM_SERVLET_NAME;
private LinkHelper ()
{}
public static void setStreamServletName (@Nonnull @Nonempty final String sStreamServletName)
{
ValueEnforcer.notEmpty (sStreamServletName, "StreamServletName");
if (!RegExHelper.stringMatchesPattern (STREAM_SERVLET_NAME_REGEX, sStreamServletName))
throw new IllegalArgumentException ("Invalid StreamServletName '" +
sStreamServletName +
"' passed. It must match the following rexg: " +
STREAM_SERVLET_NAME_REGEX);
RW_LOCK.writeLocked ( () -> s_sStreamServletName = sStreamServletName);
}
/**
* @return The name of the stream servlet path. Default is stream
* @see #getStreamServletPath()
*/
@Nonnull
@Nonempty
public static String getStreamServletName ()
{
return RW_LOCK.readLockedGet ( () -> s_sStreamServletName);
}
/**
* @return The relative path of the stream servlet. Default is
* /stream
* @see #getStreamServletName()
*/
@Nonnull
@Nonempty
public static String getStreamServletPath ()
{
return RW_LOCK.readLockedGet ( () -> "/" + s_sStreamServletName);
}
/**
* Special "has known protocol" version that also supports the pseudo protocol
* "//" that maps to either "http" or "https" depending on the surrounding
* setup.
*
* @param sURI
* Source URI. MAy be null.
* @return true if the URI has a known protocol or "//".
*/
public static boolean hasKnownProtocol (@Nullable final String sURI)
{
if (StringHelper.hasNoText (sURI))
return false;
return URLProtocolRegistry.getInstance ().hasKnownProtocol (sURI) || sURI.startsWith ("//");
}
@Nonnull
private static String _getURIWithContext (@Nonnull final String sContextPath, @Nonnull final String sHRef)
{
if (StringHelper.hasText (sContextPath) && sHRef.startsWith (sContextPath))
{
LOGGER.warn ("The passed href '" + sHRef + "' already contains the context path '" + sContextPath + "'!");
return sHRef;
}
// Always prefix with context path!
final StringBuilder aSB = new StringBuilder (sContextPath);
if (!StringHelper.startsWith (sHRef, '/'))
aSB.append ('/');
return aSB.append (sHRef).toString ();
}
/**
* Prefix the passed href with the relative context path in case the passed
* href has no protocol yet.
* Important: this method does not add the session ID in case cookies are
* disabled by the client!
*
* @param sHRef
* The href to be extended. May not be null.
* @return Either the original href if already absolute or
* /webapp-context/href otherwise. Never
* null.
*/
@Nonnull
public static String getURIWithContext (@Nonnull final String sHRef)
{
ValueEnforcer.notNull (sHRef, "HRef");
// If known protocol, keep it
if (hasKnownProtocol (sHRef))
return sHRef;
final String sContextPath = ServletContextPathHolder.getContextPath ();
return _getURIWithContext (sContextPath, sHRef);
}
/**
* Prefix the passed href with the relative context path in case the passed
* href has no protocol yet.
*
* @param aRequestScope
* The request web scope to be used. Required for cookie-less handling.
* May not be null.
* @param sHRef
* The href to be extended. May not be null.
* @return Either the original href if already absolute or
* /webapp-context/href otherwise. Never
* null.
*/
@Nonnull
public static String getURIWithContext (@Nonnull final IRequestWebScopeWithoutResponse aRequestScope, @Nonnull final String sHRef)
{
ValueEnforcer.notNull (aRequestScope, "RequestScope");
ValueEnforcer.notNull (sHRef, "HRef");
// If known protocol, keep it
if (hasKnownProtocol (sHRef))
return sHRef;
final String sContextPath = aRequestScope.getContextPath ();
return aRequestScope.encodeURL (_getURIWithContext (sContextPath, sHRef));
}
/**
* Prefix the passed href with the relative context path in case the passed
* href has no protocol yet.
* Important: this method does not add the session ID in case cookies are
* disabled by the client!
*
* @param sHRef
* The href to be extended. May not be null.
* @return Either the original href if already absolute or
* /webapp-context/href otherwise. Never
* null.
*/
@Nonnull
public static SimpleURL getURLWithContext (@Nonnull final String sHRef)
{
return new SimpleURL (getURIWithContext (sHRef));
}
/**
* Prefix the passed href with the relative context path in case the passed
* href has no protocol yet.
*
* @param aRequestScope
* The request web scope to be used. Required for cookie-less handling.
* May not be null.
* @param sHRef
* The href to be extended. May not be null.
* @return Either the original href if already absolute or
* /webapp-context/href otherwise. Never
* null.
*/
@Nonnull
public static SimpleURL getURLWithContext (@Nonnull final IRequestWebScopeWithoutResponse aRequestScope, @Nonnull final String sHRef)
{
return new SimpleURL (getURIWithContext (aRequestScope, sHRef));
}
/**
* Prefix the passed href with the absolute server + context path in case the
* passed href has no protocol yet.
* Important: this method does not add the session ID in case cookies are
* disabled by the client!
*
* @param sHRef
* The href to be extended. May not be null.
* @return Either the original href if already absolute or
* http://servername:8123/webapp-context/href
* otherwise. Never null.
*/
@Nonnull
public static String getURIWithServerAndContext (@Nonnull final String sHRef)
{
// If known protocol, keep it
if (hasKnownProtocol (sHRef))
return sHRef;
final IRequestWebScopeWithoutResponse aRequestScope = WebScopeManager.getRequestScope ();
final String sContextPath = aRequestScope.getContextPath ();
return aRequestScope.getFullServerPath () + _getURIWithContext (sContextPath, sHRef);
}
/**
* Prefix the passed href with the absolute server + context path in case the
* passed href has no protocol yet.
*
* @param aRequestScope
* The request web scope to be used. Required for cookie-less handling.
* May not be null.
* @param sHRef
* The href to be extended. May not be null.
* @return Either the original href if already absolute or
* http://servername:8123/webapp-context/href
* otherwise. Never null.
*/
@Nonnull
public static String getURIWithServerAndContext (@Nonnull final IRequestWebScopeWithoutResponse aRequestScope,
@Nonnull final String sHRef)
{
ValueEnforcer.notNull (aRequestScope, "RequestScope");
ValueEnforcer.notNull (sHRef, "HRef");
// If known protocol, keep it
if (hasKnownProtocol (sHRef))
return sHRef;
final String sContextPath = aRequestScope.getContextPath ();
final String sURI = aRequestScope.getFullServerPath () + _getURIWithContext (sContextPath, sHRef);
return aRequestScope.encodeURL (sURI);
}
/**
* Prefix the passed href with the absolute server + context path in case the
* passed href has no protocol yet.
* Important: this method does not add the session ID in case cookies are
* disabled by the client!
*
* @param sHRef
* The href to be extended.
* @return Either the original href if already absolute or
* http://servername:8123/webapp-context/href
* otherwise.
*/
@Nonnull
public static SimpleURL getURLWithServerAndContext (@Nonnull final String sHRef)
{
return new SimpleURL (getURIWithServerAndContext (sHRef));
}
/**
* Prefix the passed href with the absolute server + context path in case the
* passed href has no protocol yet.
*
* @param aRequestScope
* The request web scope to be used. Required for cookie-less handling.
* May not be null.
* @param sHRef
* The href to be extended.
* @return Either the original href if already absolute or
* http://servername:8123/webapp-context/href
* otherwise.
*/
@Nonnull
public static SimpleURL getURLWithServerAndContext (@Nonnull final IRequestWebScopeWithoutResponse aRequestScope,
@Nonnull final String sHRef)
{
return new SimpleURL (getURIWithServerAndContext (aRequestScope, sHRef));
}
/**
* @return A link to the start page without any session ID. Never
* null. E.g. / or /context.
* This is useful for logout links.
*/
@Nonnull
public static SimpleURL getHomeLinkWithoutSession ()
{
final String sContextPath = ServletContextPathHolder.getContextPath ();
return new SimpleURL (sContextPath.length () == 0 ? "/" : sContextPath);
}
/**
* Get the default URL to stream the passed URL. It is assumed that the
* servlet is located under the path "/stream". Because of the logic of the
* stream servlet, no parameter are assumed.
*
* @param aRequestScope
* The request web scope to be used. Required for cookie-less handling.
* May not be null.
* @param sURL
* The URL to be streamed. If it does not start with a slash ("/") one
* is prepended automatically. If the URL already has a protocol, it is
* returned unchanged. May neither be null nor empty.
* @return The URL incl. the context to be stream. E.g.
* /webapp-context/stream/URL.
*/
@Nonnull
public static SimpleURL getStreamURL (@Nonnull final IRequestWebScopeWithoutResponse aRequestScope, @Nonnull @Nonempty final String sURL)
{
ValueEnforcer.notNull (aRequestScope, "RequestScope");
ValueEnforcer.notEmpty (sURL, "URL");
// If the URL is absolute, use it
if (hasKnownProtocol (sURL))
return new SimpleURL (sURL);
final StringBuilder aPrefix = new StringBuilder (getStreamServletPath ());
if (!StringHelper.startsWith (sURL, '/'))
aPrefix.append ('/');
return getURLWithContext (aRequestScope, aPrefix.append (sURL).toString ());
}
}