<!--
  A pipeline that converts mathdox documents into XHTML+MathML.
-->
<p:config 
  xmlns:c='jelly:core'
  xmlns:context='java:org.orbeon.oxf.pipeline.StaticExternalContext'
  xmlns:ev='http://www.w3.org/2001/xml-events'
  xmlns:mathdox='http://www.mathdox.org/MathDox'
  xmlns:om='http://www.openmath.org/OpenMath'
  xmlns:oxf='http://www.orbeon.com/oxf/processors'
  xmlns:p='http://www.orbeon.com/oxf/pipeline'
  xmlns:widget='http://orbeon.org/oxf/xml/widget'
  xmlns:x='jelly:xml'
  xmlns:xforms='http://www.w3.org/2002/xforms'
  xmlns:xhtml='http://www.w3.org/1999/xhtml' 
  xmlns:xsl='http://www.w3.org/1999/XSL/Transform'
  xmlns:xu='http://www.xmldb.org/xupdate'
>

  <!-- 
    The input is a mathdox document.
  -->
  <p:param name='data' type='input'/>
  
  <!--
    The output is an XHTML+MathML document.
  -->
  <p:param name='data' type='output'/>

  <!--
    The context is (possibly) altered by the execution of the mathdox document.
  -->
  <p:param name='instance' type='input'/>
  <p:param name='instance' type='output'/>

  <!--
    Process any xinclude directives.
  -->
  <p:processor name='oxf:pipeline'>
    <p:input name='config' href='oxf:/util/xinclude.xpl'/>
    <p:input name='data' href='#data'/>
    <p:output name='data' id='xincluded'/>
  </p:processor>

  <!--
    In case of a submitted form, put the data in $formdata
  -->
  <p:choose href="#instance">
    <p:when test="/*/formdata/*">
      <p:processor name='oxf:identity'>
        <p:input name="data" href="#instance#xpointer(/*/formdata/*)"/>
        <p:output name="data" id="formdata"/>
      </p:processor>
      <p:processor name='oxf:xslt'>
        <p:input name='config'>
          <xsl:transform version="2.0">
    
            <xsl:import href='oxf:/oxf/xslt/utils/copy.xsl'/>
    
            <xsl:variable name='formdata' select='doc("input:formdata")'/>
    
            <xsl:template match='/*'>
              <xsl:copy>
                <xsl:apply-templates select='@*'/>
                <x:parse var='formdata'>
                  <!-- store the submitted values in $formdata -->
                  <xsl:copy-of select='$formdata'/>
                </x:parse>
                <xsl:apply-templates select="*"/>
              </xsl:copy>
            </xsl:template>
    
          </xsl:transform>
        </p:input>
        <p:input name='data' href='#xincluded'/>
        <p:input name='formdata' href='#formdata'/>
        <p:output name='data' id='with-form-data'/>
      </p:processor>
    </p:when>
    <p:otherwise>
      <p:processor name='oxf:identity'>
        <p:input name="data" href="#xincluded"/>
        <p:output name="data" id="with-form-data"/>
      </p:processor>
    </p:otherwise>
  </p:choose>

  <!--
    Transform any MONET queries to Jelly scripts.
  -->
  <p:processor name='oxf:xslt'>
    <p:input name='config' href='monet2jelly.xsl'/>
    <p:input name='data' href='#with-form-data'/>
    <p:output name='data' id='monet-transformed'/>
  </p:processor>


  <p:processor name='oxf:pipeline'>
    <p:input name='config' href='oxf:/context/mathdoxcontext.xpl'/>
    <p:input name='data' href='#data'/>
    <p:output name='mathdoxcontext' id='mathdoxcontext'/>
  </p:processor>


  <!--
    Execute Jelly scripts.
  -->
  <p:processor name='oxf:pipeline'>
    <p:input name='config' href='oxf:/util/jelly.xpl'/>
    <p:input name='data' href='#monet-transformed'/>
    <p:input name='instance' href='#instance'/>
    <p:input name='mathdoxcontext' href='#mathdoxcontext'/>
    <p:output name='data' id='jelly-data'/>
    <p:output name='instance' id='jelly-instance'/>
  </p:processor>

  <p:processor name='oxf:pipeline'>
    <p:input name='config' href='hook-docbook.xpl'/>
    <p:input name='data' href='#jelly-data'/>
    <p:input name='instance' href='#jelly-instance'/>
    <p:output name='data' id='docbook-data'/>
    <p:output name='instance' id='docbook-instance'/>
  </p:processor>

  <!--
    Split all xforms elements to ensure that they do not interfere with the
    docbook xsl stylesheets.
  -->
  <p:processor name='oxf:xslt'>
    <p:input name='config'>
      <xsl:transform version='2.0'>
        <xsl:import href='oxf:/oxf/xslt/utils/copy.xsl'/>
        <xsl:import href='oxf:/util/split-element.xsl'/>
        <xsl:template match='xforms:*[not(self::xforms:instance)]'>
          <xsl:call-template name='split-element'>
            <xsl:with-param name='element' select='.'/>
          </xsl:call-template>
        </xsl:template>
        <xsl:template match='widget:*'>
          <xsl:call-template name='split-element'>
            <xsl:with-param name='element' select='.'/>
          </xsl:call-template>
        </xsl:template>

        <!--
          TODO: remove this once the LMS stuff has been moved into a separate
          plugin/module/thingamabob
        -->
        <xsl:template match='xhtml:*'>
          <xsl:call-template name='split-element'>
            <xsl:with-param name='element' select='.'/>
          </xsl:call-template>
        </xsl:template>

      </xsl:transform>
    </p:input>
    <p:input name='data' href='#docbook-data'/>
    <p:output name='data' id='xforms-split'/>
  </p:processor>

  <!--
    Fix partial OpenMath objects
  -->
  <p:processor name='oxf:xslt'>
    <p:input name='config'>
      <xsl:transform version='2.0'>
        <xsl:import href='oxf:/oxf/xslt/utils/copy.xsl'/>

	<!-- 
	  put OMOBJ around all loose OM* elements and copy the contents
	-->
        <xsl:template match='OMS|OMV|OMI|OMB|OMSTR|OMF|OMA|OMBIND|OME|OMATTR|
	  OMR'
	>
	  <OMOBJ>
	     <xsl:copy-of select='.'/>
	  </OMOBJ>
	</xsl:template>

	<!-- 
	  don't change OMOBJ tags that are already correct
	-->
	<xsl:template match='OMOBJ'>
	  <xsl:copy-of select='.'/>
	</xsl:template>
	
	<!-- 
	  put om:OMOBJ around all loose om:* elements and copy the contents
	  NOTE: om:OMOBJ will not match this rule
	-->
	<xsl:template match='om:*'>
	  <om:OMOBJ>
	     <xsl:copy-of select='.'/>
	  </om:OMOBJ>
	</xsl:template>

	<!-- 
	  don't change om:OMOBJ tags that are already correct
	-->
	<xsl:template match='om:OMOBJ' priority='1'>
	  <xsl:copy-of select='.'/>
	</xsl:template>
      </xsl:transform>
    </p:input>
    <p:input name='data' href='#xforms-split'/>
    <p:output name='data' id='openmath-fix-data'/>
  </p:processor>


  <p:choose href="#docbook-instance">
    <p:when test='string(/wrapper/media)="pdf"'>
      <!--
        convert the docbook to fo
      -->
      <p:processor name='oxf:pipeline'>
        <p:input name='config' href='mathdox2fo-xslt.xpl'/>
        <p:input name='data' href='#openmath-fix-data'/>
        <p:input name='instance' href='#docbook-instance'/>
        <p:output name='data' id='data-after-xsl'/>
      </p:processor>
    </p:when>
    <p:otherwise>
      <!--
        TODO 
    
        This should be done as UNSAFE-XSLT, however that creates an error for the 
        applets in the webalt subpackages. We should fix this properly. The big 
        issue is that class attributes are not inherited into other elements, as
        a consequence the applets in the webalt packages are missing their hook
        identified by a class id.
      -->
      <p:processor name='oxf:pipeline'>
        <p:input name='config' href='mathdox2html-xslt.xpl'/>
        <p:input name='data' href='#openmath-fix-data'/>
        <p:input name='instance' href='#docbook-instance'/>
        <p:output name='data' id='data-after-xsl'/>
      </p:processor>
    </p:otherwise>
  </p:choose>

  <!--
    Combine previously split xforms elements.
  -->
  <p:processor name='oxf:xslt'>
    <p:input name='config' href='oxf:/util/combine-elements.xsl'/>
    <p:input name='data' href='#data-after-xsl'/>
    <p:output name='data' id='xforms-combined'/>
  </p:processor>

  <p:choose href="#docbook-instance">
    <p:when test='string(/wrapper/media)="pdf"'>
      <p:processor name='oxf:pipeline'>
        <p:input name='config' href='hook-fo.xpl'/>
        <p:input name='data' href='#xforms-combined'/>
        <p:input name='instance' href='#docbook-instance'/>
        <p:output name='data' id='xhtml-data'/>
      </p:processor>
    </p:when>
    <p:otherwise>
      <p:processor name='oxf:pipeline'>
        <p:input name='config' href='hook-xhtml.xpl'/>
        <p:input name='data' href='#xforms-combined'/>
        <p:input name='instance' href='#docbook-instance'/>
        <p:output name='data' id='xhtml-data'/>
      </p:processor>
    </p:otherwise>
  </p:choose>

  <!-- 
    check whether caching is enabled 
  -->
  <p:processor name='oxf:xslt'>
    <p:input name='config'>
      <wrapper xsl:version='2.0' value='{document("oxf:/config/properties.xml")
          /*/*[@name="org.mathdox.cacheable.enabled"]/@value}'
      />
    </p:input>
    <p:input name='data'>
      <empty/>
    </p:input>
    <p:output name='data' id='cacheable-enabled'/>
  </p:processor>

  <!-- 
    if caching is not enabled, serve the file, otherwise do some more checking
  -->
  <p:choose href='#cacheable-enabled'>
    <p:when test='/*[@value="false"]'>
      <!--
        caching is not enabled
      -->
      <p:processor name='oxf:identity'>
        <p:input name="data" href="#xhtml-data"/>
        <p:output name="data" ref="data"/>
      </p:processor>
      <p:processor name='oxf:identity'>
        <p:input name="data" href="#docbook-instance"/>
        <p:output name="data" ref="instance"/>
      </p:processor>
    </p:when>
    <p:otherwise>
      <!--
        if the file is cacheable, check for cache, if it doesn't exist create it
      -->
      <p:choose href="#data">
        <p:when test="/*[@mathdox:cacheable='true']">
          <!--
            create a modified instance for the cache file
          -->
          <p:processor name='oxf:xslt'>
            <p:input name='config'>
              <xsl:stylesheet version='2.0'>
                <xsl:import href='oxf:/oxf/xslt/utils/copy.xsl'/>

                <xsl:template match='resource'>
                  <resource>
                    <xsl:value-of select="."/>
		    <xsl:if test='/wrapper/media'>
		      <xsl:text>.</xsl:text>
		      <xsl:value-of select='/wrapper/media'/>
		    </xsl:if>
                    <xsl:text>.cache</xsl:text>
                  </resource>
                </xsl:template>
              </xsl:stylesheet>
            </p:input>
            <p:input name='data' href='#instance'/>
            <p:output name='data' id='instance-cache'/>
          </p:processor>
          <!--
            check if the cache file exists
          -->
          <p:processor name='oxf:pipeline'>
            <p:input name='config' href='oxf:/storage/load-try.xpl'/>
            <p:input name='instance' href='#instance-cache'/>
            <p:output name='data' id='cache-data'/>
          </p:processor>

          <p:choose href='#cache-data'>
            <p:when test='/nonexistent'>
              <!--
                generate the instance to save
              -->
              <p:processor name='oxf:xslt'>
                <p:input name='config'>
                  <wrapper xsl:version='2.0'>
                    <xsl:copy-of select='document("input:resource")'/>
                    <document>
                      <xsl:copy-of select='document("input:document")'/>
                    </document>
                  </wrapper>
                </p:input>
                <p:input name='data'>
                  <empty/>
                </p:input>
                <p:input name='resource' href='#instance-cache#xpointer(/*/resource)'/>
                <p:input name='document' href='#xhtml-data'/>
                <p:output name='data' id='save-instance'/>
              </p:processor>
              <!--
                save the generated file as cache
              -->
              <p:processor name='oxf:pipeline'>
                <p:input name='config' href='oxf:/storage/save.xpl'/>
                <p:input name='instance' href='#save-instance'/>
              </p:processor>
              <!--
                and return the generated file
              -->
              <p:processor name='oxf:identity'>
                <p:input name="data" href="#xhtml-data"/>
                <p:output name="data" ref="data"/>
              </p:processor>
	      <!--
	        return the generated instance
	      -->
	      <p:processor name='oxf:identity'>
		<p:input name="data" href="#docbook-instance"/>
		<p:output name="data" ref="instance"/>
	      </p:processor>
            </p:when>
            <p:otherwise>
              <!--
                output the cached file
              -->
              <p:processor name='oxf:identity'>
                <p:input name="data" href="#cache-data"/>
                <p:output name="data" ref="data"/>
              </p:processor>
	      <!--
	        return the original instance
	      -->
	      <p:processor name='oxf:identity'>
		<p:input name="data" href="#instance"/>
		<p:output name="data" ref="instance"/>
	      </p:processor>
            </p:otherwise>
          </p:choose>
        </p:when>
        <p:otherwise>
          <p:processor name='oxf:identity'>
            <p:input name="data" href="#docbook-instance"/>
            <p:output name="data" ref="instance"/>
          </p:processor>
          <p:processor name='oxf:identity'>
            <p:input name="data" href="#xhtml-data"/>
            <p:output name="data" ref="data"/>
          </p:processor>
        </p:otherwise>
      </p:choose>
    </p:otherwise>
  </p:choose>

</p:config>