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