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 org.apache.commons.lang3.ArrayUtils;
37 import org.xml.sax.Attributes;
38 import org.xml.sax.SAXException;
39 import org.xml.sax.XMLReader;
40 import org.xml.sax.helpers.XMLFilterImpl;
41
42
43 /**
44 * SAX filter, strips version information from a JCR XML (system view).
45 */
46 public class VersionFilter extends XMLFilterImpl {
47
48 /**
49 * if != 0 we are in the middle of a filtered element.
50 */
51 private int inVersionElement;
52
53 /**
54 * Instantiates a new version filter.
55 *
56 * @param parent wrapped XMLReader
57 */
58 public VersionFilter(XMLReader parent) {
59 super(parent);
60 }
61
62 public static String[] FILTERED_PROPERTIES = new String[]{//
63 "jcr:predecessors", // version
64 "jcr:baseVersion", // version
65 "jcr:versionHistory", // version
66 "jcr:isCheckedOut", // useless
67 "jcr:created", // useless
68 "mgnl:sequenceposition" // old
69 };
70
71 public static String[] FILTERED_NODES = new String[]{//
72 "jcr:system", // jcr system
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 (inVersionElement > 0) {
82 inVersionElement--;
83 return;
84 }
85
86 super.endElement(uri, localName, qName);
87 }
88
89 /**
90 * @see org.xml.sax.helpers.XMLFilterImpl#characters(char[], int, int)
91 */
92 @Override
93 public void characters(char[] ch, int start, int length) throws SAXException {
94 // filter content
95 if (inVersionElement == 0) {
96 super.characters(ch, start, length);
97 }
98 }
99
100 /**
101 * @see org.xml.sax.helpers.XMLFilterImpl#startElement(String, String, String, Attributes)
102 */
103 @Override
104 public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
105
106 if (inVersionElement > 0) {
107 inVersionElement++;
108 return;
109 }
110 if ("sv:node".equals(qName)) {
111 String attName = atts.getValue("sv:name");
112 if (attName != null && ArrayUtils.contains(FILTERED_NODES, attName)) {
113 inVersionElement++;
114 return;
115 }
116 } else if ("sv:property".equals(qName)) {
117 String attName = atts.getValue("sv:name");
118 if (attName != null && ArrayUtils.contains(FILTERED_PROPERTIES, attName)) {
119 inVersionElement++;
120 return;
121 }
122 }
123
124 super.startElement(uri, localName, qName, atts);
125 }
126
127 }