View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.importexport.filters;
35  
36  import info.magnolia.cms.util.UnicodeNormalizer;
37  
38  import org.xml.sax.Attributes;
39  import org.xml.sax.SAXException;
40  import org.xml.sax.XMLReader;
41  import org.xml.sax.helpers.XMLFilterImpl;
42  
43  
44  public class ImportXmlRootFilter extends XMLFilterImpl {
45  
46      // this is true if it is an import of a file containing jcr:root node
47      public boolean rootNodeFound = false;
48  
49      private boolean isRootNode = false;
50  
51      private boolean isPrimaryTypeProperty = false;
52  
53      private boolean isPrimaryTypeValue = false;
54  
55      /**
56       * if != 0 we are in the middle of a filtered element.
57       */
58      private int inFilterElement;
59  
60      public ImportXmlRootFilter(XMLReader parent) {
61          super(parent);
62      }
63  
64      /**
65       * @see org.xml.sax.helpers.XMLFilterImpl#endElement(String, String, String)
66       */
67      public void endElement(String uri, String localName, String qName) throws SAXException {
68  
69          if (inFilterElement > 0) {
70              inFilterElement--;
71              return;
72          }
73  
74          super.endElement(uri, localName, qName);
75      }
76  
77      /**
78       * Root node was found should be called after parsing to check if a root node was indeed found
79       */
80      public boolean rootNodeWasFound() {
81          return rootNodeFound;
82      }
83  
84      /**
85       * @see org.xml.sax.helpers.XMLFilterImpl#characters(char[], int, int)
86       */
87      public void characters(char[] ch, int start, int length) throws SAXException {
88          // filter content
89          if (inFilterElement == 0) {
90              // change primary type of root node
91              if (this.isPrimaryTypeValue) {
92                  this.isRootNode = false;
93                  this.isPrimaryTypeProperty = false;
94                  this.isPrimaryTypeValue = false;
95  
96                  super.characters("mgnl:content".toCharArray(), 0, "mgnl:content".length());
97              }
98              else {
99                  super.characters(ch, start, length);
100             }
101         }
102     }
103 
104     /**
105      * @see org.xml.sax.helpers.XMLFilterImpl#startElement(String, String, String, Attributes)
106      */
107     /*
108      * (non-Javadoc)
109      * @see org.xml.sax.ContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String,
110      * org.xml.sax.Attributes)
111      */
112     public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
113         // filter if already in a version element
114         if (inFilterElement > 0) {
115             inFilterElement++;
116             return;
117         }
118 
119         // filter if it is the version store
120         if ("sv:node".equals(qName)) { //$NON-NLS-1$
121             String attName = atts.getValue("sv:name"); //$NON-NLS-1$
122             attName = UnicodeNormalizer.normalizeNFC(attName);
123             // remember if there was a root node presend
124             if ("jcr:root".equals(attName)) {
125                 this.rootNodeFound = true;
126                 this.isRootNode = true;
127             }
128 
129             if ("jcr:system".equals(attName)) { //$NON-NLS-1$
130                 inFilterElement++;
131                 return;
132             }
133         }
134 
135         // change the nodetype of the jcr:root node
136         if (this.isRootNode && "sv:property".equals(qName) && "jcr:primaryType".equals(atts.getValue("sv:name"))) {
137             this.isPrimaryTypeProperty = true;
138         }
139 
140         if (this.isPrimaryTypeProperty && "sv:value".equals(qName)) {
141             this.isPrimaryTypeValue = true;
142         }
143 
144         super.startElement(uri, localName, qName, atts);
145     }
146 }