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