source: main/trunk/ibisph-view/src/main/webapp/xslt/_ibis-path.xslt @ 19868

<?xml version="1.0" encoding="ISO-8859-1"?>

<xsl:stylesheet version="3.0" 
        xmlns:xsl ="http://www.w3.org/1999/XSL/Transform" 
        xmlns:xs  ="http://www.w3.org/2001/XMLSchema"
        xmlns:ibis="http://www.ibisph.org"

        exclude-result-prefixes="ibis xs xsl"
>

        <ibis:doc>
                <name>ibis-path</name>
                <summary>Library of generic/common ibis path related functions</summary>
        </ibis:doc>


        <!-- ========================= P A R A M E T E R S   and   V A R I A B L E S
                The java servlet controller code adds ALL URL query request parameters 
                to the XSLT transformation's parameters.  Other special parameters are
                added as well.  

                Many of the global type parameters are defined within this XSLT file.  
                The parameters are passed in via the Java XSLT transformation parameter 
                map (and thus are nameed according to the Java model map key value).  
                For ease of XSLT code maintenance these global XSLT parameters are 
                wrapped within an "ibis." prefix so that it is shown which XSLT file
                contains the definition.
        -->

        <!-- RESOURCE ADDRESSING: The "WebAppURLContextPrefix" parameter is used to 
                explicitly build URL addresses to site related resources.  The value is 
                typically pulled from the servlet context.  The resource's path is relative
                to the application's root.  The prefix and the relative root address are 
                then concatenated together (along with a separator) to build a complete,
                explicit path for the resource.  This value can either be hard coded as an 
                XSLT variable or in this case is set as a parameter passed in from the 
                XML/XSLT transformer.

                This full context path value is needed because relative paths do not work 
                for sites that have resources under different directory paths.  E.g. the 
                browser tries to get the resource based on the current resource's path.
                Relative paths work well with sites that deliver dynamic content using a 
                servlet call that is located at the root level of the application's context.
                Addressing anything within a site like this using a relative address path 
                works since the current resource's path is the root directory.

                The resource could also be explicitly coded for a given application context 
                (or as the default application - without any context path) but then the code 
                is context deployment dependent and would need changing based on the context 
                the app was deployed under.  So the root "/" can't be used either...

                This solution is messier from an XSLT perspective and in making sure that the 
                XML/XSLT transformer is passed the correct value and inserts the value in as
                the "WebAppURLContextPrefix" parameter.  However, this is a safe way to ensure 
                that the resources are found while remaining deployment context independent.

                OLDER SOLUTIONS:
                If the apps context is the root then this value should be '/'.  If it's
                not then it should be something like: '/ibisph-view/' 
                <xsl:variable name="webappURLContextPrefix" select="'/ibisph-view/'"/>
                <xsl:variable name="webappURLContextPrefix" select="concat('/', SystemServlet:System.getWebAppContextName(), '/')" xmlns:SystemServlet="org.ibisph.servlets.view"/>

                WORKS - should be a little faster than system properties...
                <xsl:variable name="webappURLContextPrefix" select="concat('/', SystemServlet:System.getWebAppContextName(), '/')" xmlns:SystemServlet="org.ibisph.servlet.view"/>

                ALSO WORKS:
                <xsl:variable name="webappURLContext" select="org.ibisph:SystemProperties.getProperty('WebAppContextName')" xmlns:org.ibisph="org.ibisph"/>
                <xsl:variable name="webappURLContextPrefix" select="concat('/', $webappURLContext, '/')"/>

                TRIED: 
                doesn't blow but doesn't have the correct content path either...
                select="concat(java:org.springframework.web.context.support.StaticWebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, '/')" xmlns:java="http://xml.apache.org/xslt/java"

                ONE LINE PROPERTY CALL - WORKS:
                <xsl:variable name="webappURLContextPrefix" select="concat('/', org.ibisph:SystemProperties.getProperty('WebAppContextName'), '/')" xmlns:org.ibisph="org.ibisph"/>
                <xsl:variable name="webappURLContextPrefix" select="org.ibisph:SystemProperties.getProperty('WebAppURLContextPrefix')" xmlns:org.ibisph="org.ibisph"/>
        -->


        <xsl:param name="RequestURL" 
                ibis:doc="Current HTTP request URL."
        />
        <xsl:variable name="ibis.requestURL" select="$RequestURL"/>

        <xsl:param name="WebAppContextPath" 
                ibis:doc="Prefix used/needed for referencing resources within the site."
        />
        <xsl:variable name="ibis.contextPath" select="$WebAppContextPath"
                ibis:doc="WebAppContextPath access variable that all pages should use.  
                        Has the 'ibis.' prefix to know what XSLT the variable/param is defined in.
                "
        />

        <xsl:param name="WebAppRemoteRequestPath" select="$ibis.contextPath" 
                ibis:doc="
                        Prefix used/needed for referencing this apps resources outside the 
                        site.  This value is primarily used for the site search and remote
                        email verification request.
                "
        />
        <xsl:variable name="ibis.remoteRequestPath" select="$WebAppRemoteRequestPath"
                ibis:doc="WebAppRemoteRequestPath access variable that any pages could use.  
                        Has the 'ibis.' prefix to know what XSLT the variable/param is defined in.
                "
        />

        <xsl:param name="ContentBasePath" select="'../../ibisph-content'"
                ibis:doc="Injected via the common alt model map bean def.  This allows 
                        down stream XSLT to dynamically access the 2ndardy XML files as well
                        as leaflet map and kendo json files.
                "
        />
        <xsl:function name="ibis:getContentPath" as="xs:string"
                ibis:doc="Returns the ContentBasePath param (injected via spring bean)
                        concatenated with the passed in filePath
                "
        >
                <xsl:param name="filePath" ibis:doc="Path to be appended to the ContentBasePath"/>
                <xsl:value-of select="ibis:getPath($ContentBasePath, $filePath)"/>
        </xsl:function>


        <xsl:function name="ibis:getCompleteURL" as="xs:string"
                ibis:doc="tests the supplied path/URL and if no http prefix then the 
                        webapp context is added as a prefix to the path."
        >
                <xsl:param name="path" ibis:doc="Path/URL to be tested/adjusted.  If 
                        the value begins with http then URL is returned untouched.  Else 
                        the webapp context is added as a prefix and returned."
                />
                <xsl:value-of select="if(starts-with($path,'http')) then $path else ibis:getPath($WebAppContextPath, $path)"/>
        </xsl:function>


        <xsl:function name="ibis:getPath" as="xs:string"
                ibis:doc="Returns the ContentBasePath param (injected via spring bean)
                        concatenated with the passed in filePath
                "
        >
                <xsl:param name="pathPrefix" ibis:doc="Path to be preappended"/>
                <xsl:param name="pathAndFilename" ibis:doc="Path to be appended to the pathPrefix"/>
                <xsl:value-of select="if(ends-with($pathPrefix, '/') or starts-with($pathAndFilename, '/')) then concat($pathPrefix, $pathAndFilename) else concat($pathPrefix, '/', $pathAndFilename)"/>
        </xsl:function>

</xsl:stylesheet>

<!-- ============================= End of File ============================= -->