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