View Javadoc
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 java.util.ArrayList;
37  import java.util.Iterator;
38  import java.util.List;
39  
40  import org.xml.sax.Attributes;
41  import org.xml.sax.SAXException;
42  import org.xml.sax.XMLReader;
43  import org.xml.sax.helpers.AttributesImpl;
44  import org.xml.sax.helpers.XMLFilterImpl;
45  
46  
47  /**
48   * A filter that removed "mix:versionable" from jcr:mixinTypes while importing
49   * xml files. Can be used to automatically adapt version 3.5 xml files to
50   * magnolia 3.6 during bootstrap or activation. You need
51   * to modify DataTransporter in order to disable it (see the comments in
52   * DataTransporter.importXmlStream())
53   *
54   * @deprecated since 5.4.4. Should not be needed anymore.
55   */
56  @Deprecated
57  public class RemoveMixversionableFilter extends XMLFilterImpl {
58  
59      private boolean inMixinTypes = false;
60  
61      private boolean inValue = false;
62  
63      private List values = new ArrayList();
64  
65      private String value;
66  
67      private Attributes atts;
68  
69      /**
70       * Instantiates a new MetadataUuidFilter filter.
71       *
72       * @param parent wrapped XMLReader
73       */
74      public RemoveMixversionableFilter(XMLReader parent) {
75          super(parent);
76      }
77  
78      @Override
79      public void startElement(String uri, String localName, String name, Attributes atts) throws SAXException {
80          if (name.equals("sv:property") && atts.getValue("sv:name").equals("jcr:mixinTypes")) {
81              this.atts = new AttributesImpl(atts);
82              inMixinTypes = true;
83              values.clear();
84          } else if (inMixinTypes && name.equals("sv:value")) {
85              inValue = true;
86          } else {
87              super.startElement(uri, localName, name, atts);
88          }
89      }
90  
91      @Override
92      public void characters(char[] ch, int start, int length) throws SAXException {
93          if (inValue) {
94              if (value == null) {
95                  value = new String(ch, start, length);
96              } else {
97                  value += new String(ch, start, length);
98              }
99          } else {
100             super.characters(ch, start, length);
101         }
102     }
103 
104     @Override
105     public void endElement(String uri, String localName, String name) throws SAXException {
106         if (inValue && name.equals("sv:value")) {
107             inValue = false;
108             if (!value.equals("mix:versionable")) {
109                 values.add(value);
110             }
111             value = null;
112         } else if (inMixinTypes && name.equals("sv:property")) {
113             inMixinTypes = false;
114             // process the buffer
115             if (values.size() > 0) {
116                 super.startElement(uri, "property", "sv:property", this.atts);
117                 for (Iterator iterator = values.iterator(); iterator.hasNext(); ) {
118                     String value = (String) iterator.next();
119                     super.startElement(uri, "value", "sv:value", new AttributesImpl());
120                     super.characters(value.toCharArray(), 0, value.length());
121                     super.endElement(uri, "value", "sv:value");
122                 }
123                 super.endElement(uri, "property", "sv:property");
124             }
125         } else {
126             super.endElement(uri, localName, name);
127         }
128     }
129 }