1 /**
2 * This file Copyright (c) 2017 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 java.util.Arrays;
37
38 import org.xml.sax.SAXException;
39 import org.xml.sax.helpers.XMLFilterImpl;
40
41 /**
42 * This filter allows skipping "unwanted" name spaces, by giving an explicit white-list of allowed namespaces.
43 *
44 * <p>This is particularly useful for JCR exports, as we don't want to pollute bootstrap files,
45 * which could in turn pollute the namespace registries of other instances, or cause conflicts there.<br>
46 * Magnolia's JCR export typically white-lists only <code>sv</code> and <code>xsi</code> namespaces.
47 *
48 * @see <a href="https://jira.magnolia-cms.com/browse/MAGNOLIA-2960">MAGNOLIA-2960</a>
49 * @see <a href="https://jira.magnolia-cms.com/browse/MAGNOLIA-7022">MAGNOLIA-7022</a>
50 */
51 public class NamespaceFilter extends XMLFilterImpl {
52 private final String[] whitelistedNamespaces;
53
54 public NamespaceFilter(String... whitelistedNamespaces) {
55 this.whitelistedNamespaces = whitelistedNamespaces;
56 }
57
58 private boolean inSkippedNs;
59
60 @Override
61 public void startPrefixMapping(String prefix, String uri) throws SAXException {
62 if (Arrays.asList(whitelistedNamespaces).contains(prefix)) {
63 super.startPrefixMapping(prefix, uri);
64 } else {
65 inSkippedNs = true;
66 }
67 }
68
69 @Override
70 public void endPrefixMapping(String prefix) throws SAXException {
71 if (!inSkippedNs) {
72 super.endPrefixMapping(prefix);
73 }
74 inSkippedNs = false;
75 }
76 }