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