1 /**
2 * This file Copyright (c) 2003-2015 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 /**
45 * XML Filter for cleaning up version store from imported root node files.
46 */
47 public class ImportXmlRootFilter extends XMLFilterImpl {
48
49 // this is true if it is an import of a file containing jcr:root node
50 public boolean rootNodeFound = false;
51
52 private boolean isRootNode = false;
53
54 private boolean isPrimaryTypeProperty = false;
55
56 private boolean isPrimaryTypeValue = false;
57
58 /**
59 * if != 0 we are in the middle of a filtered element.
60 */
61 private int inFilterElement;
62
63 public ImportXmlRootFilter(XMLReader parent) {
64 super(parent);
65 }
66
67 /**
68 * @see org.xml.sax.helpers.XMLFilterImpl#endElement(String, String, String)
69 */
70 @Override
71 public void endElement(String uri, String localName, String qName) throws SAXException {
72
73 if (inFilterElement > 0) {
74 inFilterElement--;
75 return;
76 }
77
78 super.endElement(uri, localName, qName);
79 }
80
81 /**
82 * Root node was found should be called after parsing to check if a root node was indeed found.
83 */
84 public boolean rootNodeWasFound() {
85 return rootNodeFound;
86 }
87
88 /**
89 * @see org.xml.sax.helpers.XMLFilterImpl#characters(char[], int, int)
90 */
91 @Override
92 public void characters(char[] ch, int start, int length) throws SAXException {
93 // filter content
94 if (inFilterElement == 0) {
95 // change primary type of root node
96 if (this.isPrimaryTypeValue) {
97 this.isRootNode = false;
98 this.isPrimaryTypeProperty = false;
99 this.isPrimaryTypeValue = false;
100
101 super.characters("mgnl:content".toCharArray(), 0, "mgnl:content".length());
102 } else {
103 super.characters(ch, start, length);
104 }
105 }
106 }
107
108 /**
109 * @see org.xml.sax.helpers.XMLFilterImpl#startElement(String, String, String, Attributes)
110 */
111 /*
112 * (non-Javadoc)
113 * @see org.xml.sax.ContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String,
114 * org.xml.sax.Attributes)
115 */
116 @Override
117 public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
118 // filter if already in a version element
119 if (inFilterElement > 0) {
120 inFilterElement++;
121 return;
122 }
123
124 // filter if it is the version store
125 if ("sv:node".equals(qName)) {
126 String attName = atts.getValue("sv:name");
127 attName = UnicodeNormalizer.normalizeNFC(attName);
128 // remember if there was a root node present
129 if ("jcr:root".equals(attName)) {
130 this.rootNodeFound = true;
131 this.isRootNode = true;
132 }
133
134 if ("jcr:system".equals(attName)) {
135 inFilterElement++;
136 return;
137 }
138 }
139
140 // change the nodetype of the jcr:root node
141 if (this.isRootNode && "sv:property".equals(qName) && "jcr:primaryType".equals(atts.getValue("sv:name"))) {
142 this.isPrimaryTypeProperty = true;
143 }
144
145 if (this.isPrimaryTypeProperty && "sv:value".equals(qName)) {
146 this.isPrimaryTypeValue = true;
147 }
148
149 super.startElement(uri, localName, qName, atts);
150 }
151 }