View Javadoc
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;
35  
36  import info.magnolia.cms.beans.runtime.Document;
37  import info.magnolia.cms.core.Content;
38  import info.magnolia.cms.core.HierarchyManager;
39  import info.magnolia.cms.core.ItemType;
40  import info.magnolia.cms.core.SystemProperty;
41  import info.magnolia.cms.util.ContentUtil;
42  import info.magnolia.cms.util.NodeDataUtil;
43  import info.magnolia.context.MgnlContext;
44  import info.magnolia.importexport.filters.AccesscontrolNodeFilter;
45  import info.magnolia.importexport.filters.ImportXmlRootFilter;
46  import info.magnolia.importexport.filters.MagnoliaV2Filter;
47  import info.magnolia.importexport.filters.MetadataUuidFilter;
48  import info.magnolia.importexport.filters.RemoveMixversionableFilter;
49  import info.magnolia.importexport.filters.VersionFilter;
50  import info.magnolia.importexport.postprocessors.ActivationStatusImportPostProcessor;
51  import info.magnolia.importexport.postprocessors.MetaDataImportPostProcessor;
52  import info.magnolia.jcr.util.NodeUtil;
53  
54  import java.io.File;
55  import java.io.FileInputStream;
56  import java.io.FileNotFoundException;
57  import java.io.FileOutputStream;
58  import java.io.IOException;
59  import java.io.InputStream;
60  import java.io.OutputStream;
61  import java.io.UnsupportedEncodingException;
62  import java.net.URLDecoder;
63  import java.net.URLEncoder;
64  import java.text.MessageFormat;
65  import java.util.Iterator;
66  import java.util.List;
67  import java.util.Properties;
68  import java.util.regex.Matcher;
69  import java.util.regex.Pattern;
70  import java.util.zip.DeflaterOutputStream;
71  import java.util.zip.GZIPInputStream;
72  import java.util.zip.GZIPOutputStream;
73  import java.util.zip.ZipInputStream;
74  import java.util.zip.ZipOutputStream;
75  
76  import javax.jcr.ImportUUIDBehavior;
77  import javax.jcr.Node;
78  import javax.jcr.NodeIterator;
79  import javax.jcr.PathNotFoundException;
80  import javax.jcr.RepositoryException;
81  import javax.jcr.Session;
82  import javax.jcr.Workspace;
83  import javax.xml.transform.Source;
84  import javax.xml.transform.sax.SAXTransformerFactory;
85  import javax.xml.transform.stream.StreamSource;
86  
87  import org.apache.commons.io.IOUtils;
88  import org.apache.commons.lang3.StringUtils;
89  import org.apache.xml.serialize.OutputFormat;
90  import org.apache.xml.serialize.XMLSerializer;
91  import org.slf4j.Logger;
92  import org.slf4j.LoggerFactory;
93  import org.xml.sax.ContentHandler;
94  import org.xml.sax.InputSource;
95  import org.xml.sax.SAXException;
96  import org.xml.sax.XMLFilter;
97  import org.xml.sax.XMLReader;
98  import org.xml.sax.helpers.XMLReaderFactory;
99  
100 
101 /**
102  * Utility class for manipulation of XML files (mainly JCR XML).
103  */
104 public class DataTransporter {
105 
106     private static final Pattern DOT_NAME_PATTERN = Pattern.compile("[\\w\\-]*\\.*[\\w\\-]*");
107 
108     private static final int INDENT_VALUE = 2;
109 
110     private static Logger log = LoggerFactory.getLogger(DataTransporter.class.getName());
111 
112     final static int BOOTSTRAP_IMPORT_MODE = ImportUUIDBehavior.IMPORT_UUID_COLLISION_REPLACE_EXISTING;
113 
114     public static final String ZIP = ".zip";
115 
116     public static final String GZ = ".gz";
117 
118     public static final String XML = ".xml";
119 
120     public static final String PROPERTIES = ".properties";
121 
122     public static final String DOT = ".";
123 
124     public static final String SLASH = "/";
125 
126     public static final String UTF8 = "UTF-8";
127 
128     public static final String JCR_ROOT = "jcr:root";
129 
130     /**
131      * Converts a xml document into a file.
132      * @param xmlDocument uploaded file
133      * @param repositoryName selected repository
134      * @param basepath base path in repository
135      * @param keepVersionHistory if <code>false</code> version info will be stripped before importing the document
136      * @param importMode a valid value for ImportUUIDBehavior
137      *
138      * @see ImportUUIDBehavior
139      */
140     public static synchronized void importDocument(Document xmlDocument, String repositoryName, String basepath,
141                                                    boolean keepVersionHistory, int importMode, boolean saveAfterImport,
142                                                    boolean createBasepathIfNotExist)
143             throws IOException {
144         File xmlFile = xmlDocument.getFile();
145         importFile(xmlFile, repositoryName, basepath, keepVersionHistory, importMode, saveAfterImport,
146                 createBasepathIfNotExist);
147     }
148 
149     /**
150      * Creates an <code>InputStream</code> backed by the specified xml file.
151      * @param xmlFile (zipped/gzipped) XML file to import
152      * @param repositoryName selected repository
153      * @param basepath base path in repository
154      * @param keepVersionHistory if <code>false</code> version info will be stripped before importing the document
155      * @param importMode a valid value for ImportUUIDBehavior
156      *
157      * @see ImportUUIDBehavior
158      */
159     public static synchronized void importFile(File xmlFile, String repositoryName, String basepath,
160                                                boolean keepVersionHistory, int importMode, boolean saveAfterImport,
161                                                boolean createBasepathIfNotExist)
162             throws IOException {
163         String name = xmlFile.getAbsolutePath();
164 
165         InputStream xmlStream = getInputStreamForFile(xmlFile);
166         importXmlStream(xmlStream, repositoryName, basepath, name, keepVersionHistory, importMode, saveAfterImport,
167                 createBasepathIfNotExist);
168     }
169 
170     public static void executeBootstrapImport(File xmlFile, String repositoryName) throws IOException {
171         String filenameWithoutExt = StringUtils.substringBeforeLast(xmlFile.getName(), DOT);
172         if (filenameWithoutExt.endsWith(XML)) {
173             // if file ends in .xml.gz or .xml.zip
174             // need to keep the .xml to be able to view it after decompression
175             filenameWithoutExt = StringUtils.substringBeforeLast(xmlFile.getName(), DOT);
176         }
177         String pathName = StringUtils.substringAfter(StringUtils.substringBeforeLast(filenameWithoutExt, DOT), DOT);
178 
179         pathName = decodePath(pathName,  UTF8);
180 
181         String basepath = SLASH + StringUtils.replace(pathName, DOT, SLASH);
182 
183         if (xmlFile.getName().endsWith(PROPERTIES)) {
184             Properties properties = new Properties();
185             FileInputStream stream = new FileInputStream(xmlFile);
186             try {
187                 properties.load(stream);
188             } finally {
189                 IOUtils.closeQuietly(stream);
190             }
191             importProperties(properties, repositoryName);
192         } else {
193             DataTransporter.importFile(xmlFile, repositoryName, basepath, false, BOOTSTRAP_IMPORT_MODE, true, true);
194         }
195     }
196 
197     /**
198      * @deprecated since 4.0 - use the PropertiesImportExport class instead.
199      */
200     public static void importProperties(Properties properties, String repositoryName) {
201         for (Iterator iter = properties.keySet().iterator(); iter.hasNext();) {
202             String key = (String) iter.next();
203             String value = (String) properties.get(key);
204 
205             String name = StringUtils.substringAfterLast(key, ".");
206             String path = StringUtils.substringBeforeLast(key, ".").replace('.', '/');
207             Content node = ContentUtil.getContent(repositoryName, path);
208             if (node != null) {
209                 try {
210                     NodeDataUtil.getOrCreate(node, name).setValue(value);
211                     node.save();
212                 }
213                 catch (RepositoryException e) {
214                     log.error("can't set property {}", key, e);
215                 }
216             }
217         }
218 
219     }
220 
221     /**
222      * Imports XML stream into repository.
223      * XML is filtered by <code>MagnoliaV2Filter</code>, <code>VersionFilter</code> and <code>ImportXmlRootFilter</code>
224      * if <code>keepVersionHistory</code> is set to <code>false</code>
225      * @param xmlStream XML stream to import
226      * @param repositoryName selected repository
227      * @param basepath base path in repository
228      * @param name (absolute path of <code>File</code>)
229      * @param keepVersionHistory if <code>false</code> version info will be stripped before importing the document
230      * @param importMode a valid value for ImportUUIDBehavior
231      *
232      * @see ImportUUIDBehavior
233      * @see ImportXmlRootFilter
234      * @see VersionFilter
235      * @see MagnoliaV2Filter
236      */
237     public static synchronized void importXmlStream(InputStream xmlStream, String repositoryName, String basepath,
238                                                     String name, boolean keepVersionHistory, int importMode,
239                                                     boolean saveAfterImport, boolean createBasepathIfNotExist)
240             throws IOException {
241         importXmlStream(xmlStream, repositoryName, basepath, name, keepVersionHistory, false, importMode, saveAfterImport, createBasepathIfNotExist);
242 
243     }
244 
245     /**
246      * Imports XML stream into repository.
247      * XML is filtered by <code>MagnoliaV2Filter</code>, <code>VersionFilter</code> and <code>ImportXmlRootFilter</code> if <code>keepVersionHistory</code> is set to <code>false</code>
248      * 
249      * @param xmlStream XML stream to import
250      * @param repositoryName selected repository
251      * @param basepath base path in repository
252      * @param name (absolute path of <code>File</code>)
253      * @param keepVersionHistory if <code>false</code> version info will be stripped before importing the document
254      * @param forceUnpublishState if <code>true</code> then activation state of node will be change to unpublished.
255      * @param importMode a valid value for ImportUUIDBehavior
256      *
257      * @see ImportUUIDBehavior
258      * @see ImportXmlRootFilter
259      * @see VersionFilter
260      * @see MagnoliaV2Filter
261      */
262     public static synchronized void importXmlStream(InputStream xmlStream, String repositoryName, String basepath,
263             String name, boolean keepVersionHistory, boolean forceUnpublishState, int importMode,
264                                                     boolean saveAfterImport, boolean createBasepathIfNotExist)
265             throws IOException {
266 
267         // TODO hopefully this will be fixed with a more useful message with the Bootstrapper refactoring
268         if (xmlStream == null) {
269             throw new IOException("Can't import a null stream into repository: " + repositoryName + ", basepath: " + basepath + ", name: " + name);
270         }
271 
272         HierarchyManager hm = MgnlContext.getHierarchyManager(repositoryName);
273         if (hm == null) {
274             throw new IllegalStateException("Can't import " + name + " since repository " + repositoryName + " does not exist.");
275         }
276         Workspace ws = hm.getWorkspace();
277 
278         log.debug("Importing content into repository: [{}] from: [{}] into path: [{}]", repositoryName, name, basepath);
279 
280 
281         if (!hm.isExist(basepath) && createBasepathIfNotExist) {
282             try {
283                 ContentUtil.createPath(hm, basepath, ItemType.CONTENT);
284             }
285             catch (RepositoryException e) {
286                 log.error("can't create path [{}]", basepath);
287             }
288         }
289 
290         Session session = ws.getSession();
291 
292         try {
293 
294             // Collects a list with all nodes at the basepath before import so we can see exactly which nodes were imported afterwards
295             List<Node> nodesBeforeImport = NodeUtil.asList(NodeUtil.asIterable(session.getNode(basepath).getNodes()));
296 
297             if (keepVersionHistory) {
298                 // do not manipulate
299                 session.importXML(basepath, xmlStream, importMode);
300             } else {
301                 // create readers/filters and chain
302                 XMLReader initialReader = XMLReaderFactory.createXMLReader(org.apache.xerces.parsers.SAXParser.class.getName());
303                 try{
304                     initialReader.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
305                 }catch (SAXException e) {
306                     log.error("could not set parser feature");
307                 }
308 
309 
310                 XMLFilter magnoliaV2Filter = null;
311 
312                 // if stream is from regular file, test for belonging XSL file to apply XSL transformation to XML
313                 if (new File(name).isFile()) {
314                     InputStream xslStream = getXslStreamForXmlFile(new File(name));
315                     if (xslStream != null) {
316                         Source xslSource = new StreamSource(xslStream);
317                         SAXTransformerFactory saxTransformerFactory = (SAXTransformerFactory) SAXTransformerFactory.newInstance();
318                         XMLFilter xslFilter = saxTransformerFactory.newXMLFilter(xslSource);
319                         magnoliaV2Filter = new MagnoliaV2Filter(xslFilter);
320                     }
321                 }
322 
323                 if (magnoliaV2Filter == null) {
324                     magnoliaV2Filter = new MagnoliaV2Filter(initialReader);
325                 }
326 
327                 XMLFilter versionFilter = new VersionFilter(magnoliaV2Filter);
328 
329                 // enable this to strip useless "name" properties from dialogs
330                 // versionFilter = new UselessNameFilter(versionFilter);
331 
332                 // enable this to strip mix:versionable from pre 3.6 xml files
333                 versionFilter = new RemoveMixversionableFilter(versionFilter);
334 
335                 // strip rep:accesscontrol node
336                 versionFilter = new AccesscontrolNodeFilter(versionFilter);
337 
338                 XMLReader finalReader = new ImportXmlRootFilter(versionFilter);
339 
340                 ContentHandler handler = session.getImportContentHandler(basepath, importMode);
341                 finalReader.setContentHandler(handler);
342 
343                 // parse XML, import is done by handler from session
344                 try {
345                     finalReader.parse(new InputSource(xmlStream));
346                 }
347                 finally {
348                     IOUtils.closeQuietly(xmlStream);
349                 }
350 
351                 if (((ImportXmlRootFilter) finalReader).rootNodeFound) {
352                     String path = basepath;
353                     if (!path.endsWith(SLASH)) {
354                         path += SLASH;
355                     }
356 
357                     Node dummyRoot = (Node) session.getItem(path + JCR_ROOT);
358                     for (Iterator iter = dummyRoot.getNodes(); iter.hasNext();) {
359                         Node child = (Node) iter.next();
360                         // move childs to real root
361 
362                         if (session.itemExists(path + child.getName())) {
363                             session.getItem(path + child.getName()).remove();
364                         }
365 
366                         session.move(child.getPath(), path + child.getName());
367                     }
368                     // delete the dummy node
369                     dummyRoot.remove();
370                 }
371 
372                 // Post process all nodes that were imported
373                 NodeIterator nodesAfterImport = session.getNode(basepath).getNodes();
374                 while (nodesAfterImport.hasNext()) {
375                     Node nodeAfterImport = nodesAfterImport.nextNode();
376                     boolean existedBeforeImport = false;
377                     for (Node nodeBeforeImport : nodesBeforeImport) {
378                         if (NodeUtil.isSame(nodeAfterImport, nodeBeforeImport)) {
379                             existedBeforeImport = true;
380                             break;
381                         }
382                     }
383                     if (!existedBeforeImport) {
384                         postProcessAfterImport(nodeAfterImport, forceUnpublishState);
385                     }
386                 }
387             }
388         }
389         catch (Exception e) {
390             throw new RuntimeException("Error importing " + name + ": " + e.getMessage(), e);
391         }
392         finally {
393             IOUtils.closeQuietly(xmlStream);
394         }
395 
396         try {
397             if (saveAfterImport) {
398                 session.save();
399             }
400         }
401         catch (RepositoryException e) {
402             log.error(MessageFormat.format(
403                     "Unable to save changes to the [{0}] repository due to a {1} Exception: {2}.",
404                     new Object[]{repositoryName, e.getClass().getName(), e.getMessage()}), e);
405             throw new IOException(e.getMessage());
406         }
407     }
408 
409     private static void postProcessAfterImport(Node node, boolean forceUnpublishState) throws RepositoryException {
410         try {
411             new MetaDataImportPostProcessor().postProcessNode(node);
412             if (forceUnpublishState) {
413                 new ActivationStatusImportPostProcessor().postProcessNode(node);
414             }
415         } catch (RepositoryException e) {
416             throw new RepositoryException("Failed to post process imported nodes at path " + NodeUtil.getNodePathIfPossible(node) + ": " + e.getMessage(), e);
417         }
418     }
419 
420     /**
421      * @return XSL stream for Xml file or <code>null</code>
422      */
423     protected static InputStream getXslStreamForXmlFile(File file) {
424         InputStream xslStream = null;
425         String xlsFilename = StringUtils.substringBeforeLast(file.getAbsolutePath(), ".") + ".xsl";
426         File xslFile = new File(xlsFilename);
427         if (xslFile.exists()) {
428             try {
429                 xslStream = new FileInputStream(xslFile);
430                 log.info("XSL file for [{}] found ({})", file.getName(), xslFile.getName());
431             } catch (FileNotFoundException e) { // should never happen (xslFile.exists())
432                 e.printStackTrace();
433             }
434         }
435         return xslStream;
436     }
437 
438     /**
439      * Creates a stream from the (zipped/gzipped) XML file.
440      *
441      * @return stream of the file
442      */
443     private static InputStream getInputStreamForFile(File xmlFile) throws IOException {
444         InputStream xmlStream;
445         // looks like the zip one is buggy. It throws exception when trying to use it
446         if (xmlFile.getName().endsWith(ZIP)) {
447             xmlStream = new ZipInputStream((new FileInputStream(xmlFile)));
448         } else if (xmlFile.getName().endsWith(GZ)) {
449             xmlStream = new GZIPInputStream((new FileInputStream(xmlFile)));
450         } else { // if(fileName.endsWith(XML))
451             xmlStream = new FileInputStream(xmlFile);
452         }
453         return xmlStream;
454     }
455 
456     public static void executeExport(OutputStream baseOutputStream, boolean keepVersionHistory, boolean format,
457                                      Session session, String basepath, String repository, String ext) throws IOException {
458         OutputStream outputStream = baseOutputStream;
459         if (ext.endsWith(ZIP)) {
460             outputStream = new ZipOutputStream(baseOutputStream);
461         } else if (ext.endsWith(GZ)) {
462             outputStream = new GZIPOutputStream(baseOutputStream);
463         }
464 
465         try {
466             if (keepVersionHistory) {
467                 // use exportSystemView in order to preserve property types
468                 // http://issues.apache.org/jira/browse/JCR-115
469                 if (!format) {
470                     session.exportSystemView(basepath, outputStream, false, false);
471                 } else {
472                     parseAndFormat(outputStream, null, repository, basepath, session, false);
473                 }
474             } else {
475                 // use XMLSerializer and a SAXFilter in order to rewrite the
476                 // file
477                 XMLReader reader = new VersionFilter(XMLReaderFactory
478                         .createXMLReader(org.apache.xerces.parsers.SAXParser.class.getName()));
479                 reader = new AccesscontrolNodeFilter(reader);
480                 parseAndFormat(outputStream, reader, repository, basepath, session, false);
481             }
482         }
483         catch (IOException e) {
484             throw new RuntimeException(e);
485         }
486         catch (SAXException e) {
487             throw new RuntimeException(e);
488         }
489         catch (RepositoryException e) {
490             throw new RuntimeException(e);
491         }
492 
493         // finish the stream properly if zip stream
494         // this is not done by the IOUtils
495         if (outputStream instanceof DeflaterOutputStream) {
496             ((DeflaterOutputStream) outputStream).finish();
497         }
498 
499         baseOutputStream.flush();
500         IOUtils.closeQuietly(baseOutputStream);
501     }
502 
503     /**
504      * Exports the content of the repository, and format it if necessary.
505      * @param stream the stream to write the content to
506      * @param reader the reader to use to parse the xml content (so that we can perform filtering), if null instanciate
507      * a default one
508      * @param repository the repository to export
509      * @param basepath the basepath in the repository
510      * @param session the session to use to export the data from the repository
511      */
512     public static void parseAndFormat(OutputStream stream, XMLReader reader, String repository, String basepath,
513                                       Session session, boolean noRecurse)
514             throws IOException, SAXException, PathNotFoundException, RepositoryException {
515 
516         if (reader == null) {
517             reader = XMLReaderFactory.createXMLReader(org.apache.xerces.parsers.SAXParser.class.getName());
518         }
519 
520         // write to a temp file and then re-read it to remove version history
521         File tempFile = File.createTempFile("export-" + repository + session.getUserID(), ".xml");
522         OutputStream fileStream = new FileOutputStream(tempFile);
523 
524         try {
525             session.exportSystemView(basepath, fileStream, false, noRecurse);
526         }
527         finally {
528             IOUtils.closeQuietly(fileStream);
529         }
530 
531         readFormatted(reader, tempFile, stream);
532 
533         if (!tempFile.delete()) {
534             log.warn("Could not delete temporary export file {}", tempFile.getAbsolutePath());
535         }
536     }
537 
538     protected static void readFormatted(XMLReader reader, File inputFile, OutputStream outputStream)
539             throws FileNotFoundException, IOException, SAXException {
540         InputStream fileInputStream = new FileInputStream(inputFile);
541         readFormatted(reader, fileInputStream, outputStream);
542         IOUtils.closeQuietly(fileInputStream);
543     }
544 
545     protected static void readFormatted(XMLReader reader, InputStream inputStream, OutputStream outputStream)
546             throws FileNotFoundException, IOException, SAXException {
547 
548         OutputFormat outputFormat = new OutputFormat();
549 
550         outputFormat.setPreserveSpace(false); // this is ok, doesn't affect text nodes??
551         outputFormat.setIndenting(true);
552         outputFormat.setIndent(INDENT_VALUE);
553         outputFormat.setLineWidth(120); // need to be set after setIndenting()!
554 
555         final boolean removeUnwantedNamespaces = !SystemProperty.getBooleanProperty("magnolia.export.keep_extra_namespaces"); // MAGNOLIA-2960
556         MetadataUuidFilter metadataUuidFilter = new MetadataUuidFilter(reader, removeUnwantedNamespaces); // MAGNOLIA-1650
557         metadataUuidFilter.setContentHandler(new XMLSerializer(outputStream, outputFormat));
558         metadataUuidFilter.parse(new InputSource(inputStream));
559 
560         IOUtils.closeQuietly(inputStream);
561     }
562 
563     /**
564      *
565      * @param path path to encode
566      * @param separator "." (dot) or "/", it will be not encoded if found
567      * @param enc charset
568      * @return the path encoded
569      */
570     public static String encodePath(String path, String separator, String enc)
571     {
572         StringBuilder pathEncoded = new StringBuilder();
573         try
574         {
575             if (!StringUtils.contains(path, separator))
576             {
577                 return URLEncoder.encode(path, enc);
578             }
579             for(int i=0; i < path.length(); i++) {
580                 String ch = String.valueOf(path.charAt(i));
581                 if(separator.equals(ch)) {
582                     pathEncoded.append(ch);
583                 } else {
584                     pathEncoded.append(URLEncoder.encode(ch, enc));
585                 }
586             }
587         }
588         catch (UnsupportedEncodingException e)
589         {
590             return path;
591         }
592         return pathEncoded.toString();
593     }
594 
595     /**
596      * decode a path (ex. %D0%9D%D0%B0.%B2%D0%BE%D0%BB%D0%BD)
597      * @param path path to decode
598      * @param enc charset
599      * @return the path decoded
600      */
601     public static String decodePath(String path, String enc)
602     {
603         String pathEncoded = StringUtils.EMPTY;
604         try
605         {
606             pathEncoded = URLDecoder.decode(path, enc);
607         }
608         catch (UnsupportedEncodingException e)
609         {
610             return path;
611         }
612         return pathEncoded;
613     }
614 
615     /**
616      * Prior to 4.5 Magnolia used to produce export xml filenames where the / (slash) separating sub nodes was replaced by a dot.
617      * Since 4.5, Magnolia enables dots in path names, therefore dots which are part of the node name have to be escaped by doubling them.
618      * I.e. given a path like this <code>/foo/bar.baz/test../dir/baz..bar</code>, this method will produce
619      * <code>.foo.bar..baz.test.....dir.baz....bar</code>.
620      */
621     public static String createExportPath(String path) {
622         //TODO if someone is smarter than me (not an impossible thing) and can do this with one single elegant regex, please do it.
623         String newPath = path.replace(".", "..");
624         newPath = newPath.replace("/", ".");
625         return newPath;
626     }
627     /**
628      * The opposite of {@link #createExportPath(String)}.
629      * I.e. given a path like this <code>.foo.bar..baz.test.....dir.baz....bar</code>, this method will produce <code>/foo/bar.baz/test../dir/baz..bar</code>.
630      */
631     public static String revertExportPath(String exportPath) {
632         if(".".equals(exportPath)) {
633             return "/";
634         }
635 
636         //TODO I have a feeling there's a simpler way to achieve our goal.
637         Matcher matcher = DOT_NAME_PATTERN.matcher(exportPath);
638 
639         StringBuilder reversed = new StringBuilder(exportPath.length());
640 
641         while(matcher.find()){
642             String group = matcher.group();
643             int dotsNumber = StringUtils.countMatches(group, ".");
644             if(dotsNumber == 1) {
645                 reversed.append(group.replaceFirst("\\.", "/"));
646             } else {
647                  String dots = StringUtils.substringBeforeLast(group, ".").replace("..", ".");
648                  String name = StringUtils.substringAfterLast(group, ".");
649                  reversed.append(dots);
650                  //if number is odd, the last dot has to be replaced with a slash
651                  if(dotsNumber % 2 != 0) {
652                      reversed.append("/");
653                  }
654                  reversed.append(name);
655             }
656         }
657         return reversed.toString();
658     }
659 
660 }