[jira] Created: (COCOON3-3) Provide an XInclude transformer as a PipelineComponent

Provide an XInclude transformer as a PipelineComponent
------------------------------------------------------

                 Key: COCOON3-3
                 URL: https://issues.apache.org/jira/browse/COCOON3-3
             Project: Cocoon 3
          Issue Type: Improvement
          Components: cocoon-pipeline
            Reporter: Simone Tripodi
            Assignee: Cocoon Developers Team
            Priority: Minor


Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:

http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java

XPointer package's dependencies should be reduced to be imported in the new pipeline:

http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer

An alternative solution could be using xerces2 APIs:

http://xerces.apache.org/xerces2-j/faq-xinclude.html


--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/COCOON3-3?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12635407#action_12635407 ]

Simone Tripodi commented on COCOON3-3:
--------------------------------------

It seems that Xerces' implementation of XPointer is incomplete:

https://svn.apache.org/repos/asf/xerces/java/trunk/src/org/apache/xerces/xinclude/XIncludeHandler.java

Reading from the javadoc: "Currently, this implementation has only partial support for the XInclude specification. Specifically, it is missing support for XPointer document fragments.  Thus, only whole documents can be included using this component in the pipeline."

The oldest cocoon's version porting should be the best solution.

> Provide an XInclude transformer as a PipelineComponent
> ------------------------------------------------------
>
>                 Key: COCOON3-3
>                 URL: https://issues.apache.org/jira/browse/COCOON3-3
>             Project: Cocoon 3
>          Issue Type: Improvement
>          Components: cocoon-pipeline
>            Reporter: Simone Tripodi
>            Assignee: Cocoon Developers Team
>            Priority: Minor
>
> Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:
> http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
> XPointer package's dependencies should be reduced to be imported in the new pipeline:
> http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer
> An alternative solution could be using xerces2 APIs:
> http://xerces.apache.org/xerces2-j/faq-xinclude.html

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/COCOON3-3?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12636543#action_12636543 ]

Reinhard Poetz commented on COCOON3-3:
--------------------------------------

Usually the job of porting Cocoon 2.x components to Cocoon 3 is straight forward and in this case the best option IMO.

> Provide an XInclude transformer as a PipelineComponent
> ------------------------------------------------------
>
>                 Key: COCOON3-3
>                 URL: https://issues.apache.org/jira/browse/COCOON3-3
>             Project: Cocoon 3
>          Issue Type: Improvement
>          Components: cocoon-pipeline
>            Reporter: Simone Tripodi
>            Assignee: Cocoon Developers Team
>            Priority: Minor
>
> Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:
> http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
> XPointer package's dependencies should be reduced to be imported in the new pipeline:
> http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer
> An alternative solution could be using xerces2 APIs:
> http://xerces.apache.org/xerces2-j/faq-xinclude.html

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/COCOON3-3?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12636548#action_12636548 ]

Simone Tripodi commented on COCOON3-3:
--------------------------------------

I started working on it but it's not so easy (for me, at least ;) ).
I should be able to provide an initial patch in a week

> Provide an XInclude transformer as a PipelineComponent
> ------------------------------------------------------
>
>                 Key: COCOON3-3
>                 URL: https://issues.apache.org/jira/browse/COCOON3-3
>             Project: Cocoon 3
>          Issue Type: Improvement
>          Components: cocoon-pipeline
>            Reporter: Simone Tripodi
>            Assignee: Cocoon Developers Team
>            Priority: Minor
>
> Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:
> http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
> XPointer package's dependencies should be reduced to be imported in the new pipeline:
> http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer
> An alternative solution could be using xerces2 APIs:
> http://xerces.apache.org/xerces2-j/faq-xinclude.html

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/COCOON3-3?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Simone Tripodi updated COCOON3-3:
---------------------------------

    Attachment: XInclude.patch

As mentioned on http://cocoon.apache.org/3.0/roadmap.html, the XInclude support is one of the unscheduled feature for cocoon 3.0.0

The attached patch provides the porting to Cocoon3's pipeline of old XInclude Transformer already present in previous releases; some TestCase are also provided.

Just few notes:
- As described in http://www.w3.org/TR/xinclude/, I managed the 'accept' and 'accept-language' attributes that weren't previously implemented;
- I maintained the deprecated xpointer support;
- The dependencies from old Excalibur's org.apache.excalibur.xml.xpath.* have been replaced with Java5 provided javax.xml.xpath.* - they are very similar;
- The XPointer grammar has been adapted to be managed by the maven-javacc-plugin (generation + report);
- The original DOMStreamer has been simplified;
- I only adapted the existing code to the new structure and used Java5 generics, iterators where possible.

I really hope this helps! :)

> Provide an XInclude transformer as a PipelineComponent
> ------------------------------------------------------
>
>                 Key: COCOON3-3
>                 URL: https://issues.apache.org/jira/browse/COCOON3-3
>             Project: Cocoon 3
>          Issue Type: Improvement
>          Components: cocoon-pipeline
>            Reporter: Simone Tripodi
>            Assignee: Cocoon Developers Team
>            Priority: Minor
>         Attachments: XInclude.patch
>
>
> Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:
> http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
> XPointer package's dependencies should be reduced to be imported in the new pipeline:
> http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer
> An alternative solution could be using xerces2 APIs:
> http://xerces.apache.org/xerces2-j/faq-xinclude.html

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/COCOON3-3?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Reinhard Poetz updated COCOON3-3:
---------------------------------

        Fix Version/s: 3.0.0-alpha-2
    Affects Version/s: 3.0.0-alpha-2

> Provide an XInclude transformer as a PipelineComponent
> ------------------------------------------------------
>
>                 Key: COCOON3-3
>                 URL: https://issues.apache.org/jira/browse/COCOON3-3
>             Project: Cocoon 3
>          Issue Type: Improvement
>          Components: cocoon-pipeline
>    Affects Versions: 3.0.0-alpha-2
>            Reporter: Simone Tripodi
>            Assignee: Cocoon Developers Team
>            Priority: Minor
>             Fix For: 3.0.0-alpha-2
>
>         Attachments: XInclude.patch
>
>
> Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:
> http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
> XPointer package's dependencies should be reduced to be imported in the new pipeline:
> http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer
> An alternative solution could be using xerces2 APIs:
> http://xerces.apache.org/xerces2-j/faq-xinclude.html

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/COCOON3-3?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12640562#action_12640562 ]

Reinhard Poetz commented on COCOON3-3:
--------------------------------------

I tried to apply your patch but the DOMUtils.stream() method is missing. Can you please add it to your patch? Thanks!

> Provide an XInclude transformer as a PipelineComponent
> ------------------------------------------------------
>
>                 Key: COCOON3-3
>                 URL: https://issues.apache.org/jira/browse/COCOON3-3
>             Project: Cocoon 3
>          Issue Type: Improvement
>          Components: cocoon-pipeline
>    Affects Versions: 3.0.0-alpha-2
>            Reporter: Simone Tripodi
>            Assignee: Cocoon Developers Team
>            Priority: Minor
>             Fix For: 3.0.0-alpha-2
>
>         Attachments: XInclude.patch
>
>
> Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:
> http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
> XPointer package's dependencies should be reduced to be imported in the new pipeline:
> http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer
> An alternative solution could be using xerces2 APIs:
> http://xerces.apache.org/xerces2-j/faq-xinclude.html

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/COCOON3-3?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12640564#action_12640564 ]

Reinhard Poetz commented on COCOON3-3:
--------------------------------------

I forgot this to mention in my previous comment: Please make sure that _all_ files that you add have the Apache License 2.0 header. Thank you very much in advance!

> Provide an XInclude transformer as a PipelineComponent
> ------------------------------------------------------
>
>                 Key: COCOON3-3
>                 URL: https://issues.apache.org/jira/browse/COCOON3-3
>             Project: Cocoon 3
>          Issue Type: Improvement
>          Components: cocoon-pipeline
>    Affects Versions: 3.0.0-alpha-2
>            Reporter: Simone Tripodi
>            Assignee: Cocoon Developers Team
>            Priority: Minor
>             Fix For: 3.0.0-alpha-2
>
>         Attachments: XInclude.patch
>
>
> Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:
> http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
> XPointer package's dependencies should be reduced to be imported in the new pipeline:
> http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer
> An alternative solution could be using xerces2 APIs:
> http://xerces.apache.org/xerces2-j/faq-xinclude.html

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/COCOON3-3?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Simone Tripodi updated COCOON3-3:
---------------------------------

    Attachment: XIncludeTransformerFixedAndApacheHeaders.patch

Hi!!!!
I'm really sorry to have provided a corrupted patch.
The new patch, named XIncludeTransformerFixedAndApacheHeaders.patch fixes the missing method, creates an XInclude unit test for JUnit4, and adds the right header.

Sorry if I've never attached the header, but not being an Apache committer I thought I didn't have the right to apply it.

I also modified a little the previous XIncludeTransformer in way to be ready to be reused in the sitemap.

The XPointerFrameworkParser is generated using javacc; this justify the pom's modifications: the javacc plugin compiles the grammar in java sources, hat are managed through the build-helper plugin. So, only the .jj file should be committed, not also generated files.

I really hope this helps, don't hesitate if some help is needed.

> Provide an XInclude transformer as a PipelineComponent
> ------------------------------------------------------
>
>                 Key: COCOON3-3
>                 URL: https://issues.apache.org/jira/browse/COCOON3-3
>             Project: Cocoon 3
>          Issue Type: Improvement
>          Components: cocoon-pipeline
>    Affects Versions: 3.0.0-alpha-2
>            Reporter: Simone Tripodi
>            Assignee: Cocoon Developers Team
>            Priority: Minor
>             Fix For: 3.0.0-alpha-2
>
>         Attachments: XInclude.patch, XIncludeTransformerFixedAndApacheHeaders.patch
>
>
> Oldest versions of cocoon already contain an XInclude transformer, it could be a good starting point:
> http://svn.eu.apache.org/repos/asf/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
> XPointer package's dependencies should be reduced to be imported in the new pipeline:
> http://svn.eu.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/xpointer
> An alternative solution could be using xerces2 APIs:
> http://xerces.apache.org/xerces2-j/faq-xinclude.html

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.