Basic support for Atom feeds

[Shrine-XSLT] / transform.xslt

diff --git a/transform.xslt b/transform.xslt
index 2e3c7bd3e45f51b41d7dcfe128ac3e7354d2b74e..20fe4c29b354fa5166cba66c9a17e9c3647f2829 100644 (file)
--- a/transform.xslt
+++ b/transform.xslt
@@ -23,12 +23,41 @@ This Source Code Form is subject to the terms of the Mozilla Public License, v.
 If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
 -->
 <xslt:transform
 If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
 -->
 <xslt:transform

-       xmlns="http://www.w3.org/1999/xhtml"
-       xmlns:exslt="http://exslt.org/common"
+       xmlns:atom="http://www.w3.org/2005/Atom"

        xmlns:html="http://www.w3.org/1999/xhtml"
        xmlns:xslt="http://www.w3.org/1999/XSL/Transform"
        version="1.0"
 >
        xmlns:html="http://www.w3.org/1999/xhtml"
        xmlns:xslt="http://www.w3.org/1999/XSL/Transform"
        version="1.0"
 >

+       <xslt:param name="BASEIRI" select="'http://example.com'"/>
+       <xslt:param name="DATETIME" select="'1972-12-31T00:00:00Z'"/>
+       <xslt:param name="OUTPUTPATH" select="'/unknown'"/>
+       <xslt:variable name="baseiri">
+               <xslt:choose>
+                       <xslt:when test="contains($BASEIRI, '://')"> <!-- there is an authority -->
+                               <xslt:variable name="noscheme" select="substring-after($BASEIRI, '://')"/>
+                               <xslt:value-of select="substring-before($BASEIRI, '://')"/>
+                               <xslt:text>://</xslt:text>
+                               <xslt:choose>
+                                       <xslt:when test="contains($noscheme, '/')">
+                                               <xslt:value-of select="substring-before($noscheme, '/')"/>
+                                       </xslt:when>
+                                       <xslt:otherwise>
+                                               <xslt:value-of select="$noscheme"/>
+                                       </xslt:otherwise>
+                               </xslt:choose>
+                       </xslt:when>
+                       <xslt:otherwise>
+                               <xslt:value-of select="substring-before($BASEIRI, ':')"/>
+                       </xslt:otherwise>
+               </xslt:choose>
+       </xslt:variable>
+       <xslt:variable name="datetime" select="string($DATETIME)"/>
+       <xslt:variable name="outputpath">
+               <xslt:if test="not(starts-with($OUTPUTPATH, '/'))">
+                       <xslt:text>/</xslt:text>
+               </xslt:if>
+               <xslt:value-of select="$OUTPUTPATH"/>
+       </xslt:variable>

        <xslt:variable name="source" select="current()"/>
        <xslt:variable name="template" select="document('./template.xml')"/>
 
        <xslt:variable name="source" select="current()"/>
        <xslt:variable name="template" select="document('./template.xml')"/>
 


@@ -36,7 +65,14 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                Instead of actually processing the root node, process the template in `template` mode.
        -->
        <xslt:template match="/">
                Instead of actually processing the root node, process the template in `template` mode.
        -->
        <xslt:template match="/">

-               <xslt:apply-templates select="exslt:node-set($template)" mode="template"/>
+               <xslt:choose>
+                       <xslt:when test="atom:feed">
+                               <xslt:apply-templates mode="feed"/>
+                       </xslt:when>
+                       <xslt:otherwise>
+                               <xslt:apply-templates select="$template" mode="template"/>
+                       </xslt:otherwise>
+               </xslt:choose>

        </xslt:template>
 
        <!--
        </xslt:template>
 
        <!--


@@ -44,8 +80,8 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                By default, just copy the element, but remove any `@data-shrine-*` attribuets or `@slot` attributes with a value that begins with `shrine-`.
                Some elements may have special treatment.
        -->
                By default, just copy the element, but remove any `@data-shrine-*` attribuets or `@slot` attributes with a value that begins with `shrine-`.
                Some elements may have special treatment.
        -->

-       <xslt:template match="*|text()" mode="content">
-               <xslt:copy>
+       <xslt:template match="*" mode="content">
+               <xslt:element name="{local-name()}">

                        <xslt:for-each select="@*[not(starts-with(name(), 'data-shrine-')) and not(name()='slot' and starts-with(., 'shrine-'))]">
                                <xslt:copy/>
                        </xslt:for-each>
                        <xslt:for-each select="@*[not(starts-with(name(), 'data-shrine-')) and not(name()='slot' and starts-with(., 'shrine-'))]">
                                <xslt:copy/>
                        </xslt:for-each>


@@ -61,7 +97,14 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                                        </xslt:otherwise>
                                </xslt:choose>
                        </xslt:for-each>
                                        </xslt:otherwise>
                                </xslt:choose>
                        </xslt:for-each>

-               </xslt:copy>
+               </xslt:element>
+       </xslt:template>
+
+       <!--
+               Process text content; just make a copy.
+       -->
+       <xslt:template match="text()" mode="content">
+               <xslt:copy/>

        </xslt:template>
 
        <!--
        </xslt:template>
 
        <!--


@@ -69,13 +112,20 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                By default, just copy the element.
                This behaviour will be overridden for certain elements to insert the page content.
        -->
                By default, just copy the element.
                This behaviour will be overridden for certain elements to insert the page content.
        -->

-       <xslt:template match="*|text()" mode="template">
-               <xslt:copy>
+       <xslt:template match="*" mode="template">
+               <xslt:element name="{local-name()}">

                        <xslt:for-each select="@*">
                                <xslt:copy/>
                        </xslt:for-each>
                        <xslt:apply-templates mode="template"/>
                        <xslt:for-each select="@*">
                                <xslt:copy/>
                        </xslt:for-each>
                        <xslt:apply-templates mode="template"/>

-               </xslt:copy>
+               </xslt:element>
+       </xslt:template>
+
+       <!--
+               Process template text; just make a copy.
+       -->
+       <xslt:template match="text()" mode="content">
+               <xslt:copy/>

        </xslt:template>
 
        <!--
        </xslt:template>
 
        <!--


@@ -83,17 +133,17 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                This copies over `@lang` and non‐shrine `@data-*` attributes from the root node.
        -->
        <xslt:template match="html:html" mode="template">
                This copies over `@lang` and non‐shrine `@data-*` attributes from the root node.
        -->
        <xslt:template match="html:html" mode="template">

-               <xslt:copy>
-                       <xslt:for-each select="@*">
+               <html>
+                       <xslt:for-each select="@*[not(starts-with(name(), 'xmlns'))]">

                                <xslt:copy/>
                        </xslt:for-each>
                                <xslt:copy/>
                        </xslt:for-each>

-                       <xslt:for-each select="exslt:node-set($source)/*/@*[name()='lang' or name()='xml:lang' or starts-with(name(), 'data-') and not(starts-with(name(), 'data-shrine-'))]">
-                               <xslt:if test="not(exslt:node-set($template)/*/@*[name()=name(current())])">
+                       <xslt:for-each select="$source/*/@*[name()='lang' or starts-with(name(), 'data-') and not(starts-with(name(), 'data-shrine-'))]">
+                               <xslt:if test="not($template/*/@*[name()=name(current())])">

                                        <xslt:copy/>
                                </xslt:if>
                        </xslt:for-each>
                        <xslt:apply-templates mode="template"/>
                                        <xslt:copy/>
                                </xslt:if>
                        </xslt:for-each>
                        <xslt:apply-templates mode="template"/>

-               </xslt:copy>
+               </html>

        </xslt:template>
 
        <!--
        </xslt:template>
 
        <!--


@@ -101,22 +151,21 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                This inserts appropriate metadata based on the document.
        -->
        <xslt:template match="html:head" mode="template">
                This inserts appropriate metadata based on the document.
        -->
        <xslt:template match="html:head" mode="template">

-               <xslt:copy>
+               <head>

                        <xslt:for-each select="@*">
                                <xslt:copy/>
                        </xslt:for-each>
                        <xslt:for-each select="@*">
                                <xslt:copy/>
                        </xslt:for-each>

-                       <xslt:if test="not(exslt:node-set($source)//html:title[@slot='shrine-head'])">
-                               <xslt:text>&#x0A;</xslt:text>
+                       <xslt:if test="not($source//html:title[@slot='shrine-head'])">

                                <title>
                                <title>

-                                       <xslt:apply-templates select="exslt:node-set($source)//html:h1" mode="text"/>
+                                       <xslt:apply-templates select="$source//html:h1" mode="text"/>

                                </title>
                        </xslt:if>
                                </title>
                        </xslt:if>

+                       <meta name="generator" content="https://github.com/marrus-sh/shrine-xslt"/>

                        <xslt:apply-templates mode="template"/>
                        <xslt:apply-templates mode="template"/>

-                       <xslt:for-each select="exslt:node-set($source)//*[@slot='shrine-head']">
-                               <xslt:text>&#x0A;</xslt:text>
+                       <xslt:for-each select="$source//*[@slot='shrine-head']">

                                <xslt:apply-templates select="." mode="content"/>
                        </xslt:for-each>
                                <xslt:apply-templates select="." mode="content"/>
                        </xslt:for-each>

-               </xslt:copy>
+               </head>

        </xslt:template>
 
        <!--
        </xslt:template>
 
        <!--


@@ -125,7 +174,7 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                If no `@data-header` attribute is provided, no header is rendered.
        -->
        <xslt:template match="html:shrine-header" mode="template">
                If no `@data-header` attribute is provided, no header is rendered.
        -->
        <xslt:template match="html:shrine-header" mode="template">

-               <xslt:for-each select="exslt:node-set($source)/*/@data-shrine-header">
+               <xslt:for-each select="$source/*/@data-shrine-header">

                        <xslt:apply-templates select="document(concat('./', ., '-header.xml'), $template)/*" mode="content"/>
                </xslt:for-each>
        </xslt:template>
                        <xslt:apply-templates select="document(concat('./', ., '-header.xml'), $template)/*" mode="content"/>
                </xslt:for-each>
        </xslt:template>


@@ -136,7 +185,7 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                If no `@data-footer` attribute is provided, no footer is rendered.
        -->
        <xslt:template match="html:shrine-footer" mode="template">
                If no `@data-footer` attribute is provided, no footer is rendered.
        -->
        <xslt:template match="html:shrine-footer" mode="template">

-               <xslt:for-each select="exslt:node-set($source)/*/@data-shrine-footer">
+               <xslt:for-each select="$source/*/@data-shrine-footer">

                        <xslt:apply-templates select="document(concat('./', ., '-footer.xml'), $template)/*" mode="content"/>
                </xslt:for-each>
        </xslt:template>
                        <xslt:apply-templates select="document(concat('./', ., '-footer.xml'), $template)/*" mode="content"/>
                </xslt:for-each>
        </xslt:template>


@@ -145,7 +194,136 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                Process the content.
        -->
        <xslt:template match="html:shrine-content" mode="template">
                Process the content.
        -->
        <xslt:template match="html:shrine-content" mode="template">

-               <xslt:apply-templates select="exslt:node-set($source)/*" mode="content"/>
+               <xslt:apply-templates select="$source/*" mode="content"/>
+       </xslt:template>
+
+       <!--
+               Process feed elements and text.
+               By default, just make a copy.
+               This behaviour will be overridden for certain elements to generate feed metadata.
+       -->
+       <xslt:template match="*|text()" mode="feed">
+               <xslt:copy>
+                       <xslt:for-each select="@*">
+                               <xslt:copy/>
+                       </xslt:for-each>
+                       <xslt:apply-templates mode="feed"/>
+               </xslt:copy>
+       </xslt:template>
+
+       <!--
+               Process the root feed element.
+               This adds required metadata when it has not been provided in the source X·M·L.
+       -->
+       <xslt:template match="atom:feed" mode="feed">
+               <xslt:text>&#x0A;</xslt:text> <!-- ensure a newline between the doctype and the feed element -->
+               <feed xmlns="http://www.w3.org/2005/Atom">
+                       <xslt:for-each select="@*">
+                               <xslt:copy/>
+                       </xslt:for-each>
+                       <xslt:apply-templates select="text()[following-sibling::*[not(self::atom:entry)]]|*[not(self::atom:entry)]" mode="feed"/>
+                       <xslt:if test="not(atom:id)">
+                               <xslt:text>&#x0A;&#x09;</xslt:text>
+                               <id>
+                                       <xslt:choose>
+                                               <xslt:when test="contains($baseiri, '://')">
+                                                       <xslt:text>oai:</xslt:text>
+                                                       <xslt:value-of select="substring-after($baseiri, '://')"/>
+                                                       <xslt:text>:</xslt:text>
+                                               </xslt:when>
+                                               <xslt:otherwise>
+                                                       <xslt:value-of select="$baseiri"/>
+                                                       <xslt:text>/</xslt:text>
+                                               </xslt:otherwise>
+                                       </xslt:choose>
+                                       <xslt:value-of select="$outputpath"/>
+                               </id>
+                       </xslt:if>
+                       <xslt:if test="not(atom:title)">
+                               <xslt:text>&#x0A;&#x09;</xslt:text>
+                               <title xml:lang="en">Untitled</title>
+                       </xslt:if>
+                       <xslt:if test="not(atom:author)">
+                               <xslt:text>&#x0A;&#x09;</xslt:text>
+                               <author>
+                                       <name xml:lang="en">Anonymous</name>
+                               </author>
+                       </xslt:if>
+                       <xslt:if test="not(atom:link[@rel='alternate'][@type='text/html'])">
+                               <xslt:text>&#x0A;&#x09;</xslt:text>
+                               <link rel="alternate" type="text/html" href="{$baseiri}/"/>
+                       </xslt:if>
+                       <xslt:if test="not(atom:link[@rel='self'])">
+                               <xslt:text>&#x0A;&#x09;</xslt:text>
+                               <link rel="self" type="application/atom+xml" href="{$baseiri}{$outputpath}"/>
+                       </xslt:if>
+                       <xslt:if test="not(atom:updated)">
+                               <xslt:text>&#x0A;&#x09;</xslt:text>
+                               <updated>
+                                       <xslt:value-of select="$datetime"/>
+                               </updated>
+                       </xslt:if>
+                       <xslt:if test="not(atom:generator)">
+                               <xslt:text>&#x0A;&#x09;</xslt:text>
+                               <generator uri="https://github.com/marrus-sh/shrine-xslt">shrine-xslt</generator>
+                       </xslt:if>
+                       <xslt:apply-templates select="atom:entry" mode="feed"/>
+                       <xslt:text>&#x0A;</xslt:text> <!-- newline before close tag -->
+               </feed>
+       </xslt:template>
+
+       <!--
+               Process feed entry elements.
+       -->
+       <xslt:template match="atom:entry[atom:link[@rel='alternate'][starts-with(@href, '/')][@type='text/html']]" mode="feed">
+               <xslt:variable name="entryhref" select="atom:link[@rel='alternate'][starts-with(@href, '/')][@type='text/html'][1]/@href"/>
+               <xslt:text>&#x0A;&#x09;</xslt:text>
+               <entry xmlns="http://www.w3.org/2005/Atom">
+                       <xslt:for-each select="@*">
+                               <xslt:copy/>
+                       </xslt:for-each>
+                       <xslt:apply-templates select="text()[following-sibling::*]|*" mode="feed"/>
+                       <xslt:if test="not(atom:id)">
+                               <xslt:text>&#x0A;&#x09;&#x09;</xslt:text>
+                               <id>
+                                       <xslt:choose>
+                                               <xslt:when test="contains($baseiri, '://')">
+                                                       <xslt:text>oai:</xslt:text>
+                                                       <xslt:value-of select="substring-after($baseiri, '://')"/>
+                                                       <xslt:text>:</xslt:text>
+                                               </xslt:when>
+                                               <xslt:otherwise>
+                                                       <xslt:value-of select="$baseiri"/>
+                                                       <xslt:text>/</xslt:text>
+                                               </xslt:otherwise>
+                                       </xslt:choose>
+                                       <xslt:value-of select="$entryhref"/>
+                               </id>
+                       </xslt:if>
+                       <xslt:if test="not(atom:title)">
+                               <xslt:text>&#x0A;&#x09;&#x09;</xslt:text>
+                               <title xml:lang="en">Untitled</title>
+                       </xslt:if>
+                       <xslt:if test="not(atom:updated)">
+                               <xslt:text>&#x0A;&#x09;&#x09;</xslt:text>
+                               <updated>
+                                       <xslt:value-of select="$datetime"/>
+                               </updated>
+                       </xslt:if>
+                       <xslt:text>&#x0A;&#x09;</xslt:text> <!-- newline before close tag -->
+               </entry>
+       </xslt:template>
+
+       <!--
+               Process feed link elements.
+               This simply rewrites absolute links to be relative.
+       -->
+       <xslt:template match="atom:link[starts-with(@href, '/')]" mode="feed">
+               <link xmlns="http://www.w3.org/2005/Atom" rel="{@rel}" href="{$baseiri}{@href}">
+                       <xslt:for-each select="@*[local-name()!='rel' and local-name()!='href']">
+                               <xslt:copy/>
+                       </xslt:for-each>
+               </link>

        </xslt:template>
 
        <!--
        </xslt:template>
 
        <!--


@@ -161,4 +339,11 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
                        </xslt:when>
                </xslt:choose>
        </xslt:template>
                        </xslt:when>
                </xslt:choose>
        </xslt:template>

+
+       <!--
+               Set up output.
+               Note that this relies on “default” output method detection specified in X·S·L·T in order to work.
+               The `about:legacy-compat` system doctype is for H·T·M·L compatibility but is harmless in X·M·L.
+       -->
+       <xslt:output charset="UTF-8" doctype-system="about:legacy-compat" indent="no"/>

 </xslt:transform>
 </xslt:transform>