1 /**
2 * This file Copyright (c) 2019 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.resources.app.data;
35
36 import info.magnolia.resourceloader.Resource;
37 import info.magnolia.resourceloader.jcr.JcrResource;
38 import info.magnolia.resourceloader.layered.LayeredResource;
39
40 import java.util.Optional;
41 import java.util.regex.Pattern;
42
43 import javax.jcr.Node;
44
45 import org.apache.tika.Tika;
46 import org.apache.tika.mime.MediaType;
47
48 /**
49 * Interface providing utilities to work with layered resources.
50 */
51 public interface ResourceHelper {
52 Pattern TEXT_TYPE_EXTENSIONS = Pattern.compile(".*/(x-)*(css|csv|html|plain|txt|javascript" +
53 "|xml|yaml|yml|ftl|json|bpmn|dtd|jocl|lsp|lst|ltx|xsb|xsd)");
54
55 Tika TIKA = new Tika();
56
57 default Optional<Resource> getFirstResource(Resource resource) {
58 if (resource instanceof LayeredResource) {
59 LayeredResource layeredResource = (LayeredResource) resource;
60 boolean hasLayeredResource = layeredResource.getLayers().size() != 0;
61 return hasLayeredResource ? Optional.of(layeredResource.getFirst()) : Optional.empty();
62 }
63 return Optional.of(resource);
64 }
65
66 default Optional<Node> getJcrNode(Resource resource) {
67 return getFirstResource(resource)
68 .filter(JcrResource.class::isInstance)
69 .map(JcrResource.class::cast)
70 .flatMap(JcrResource::getNode);
71 }
72
73 /**
74 * Checks whether the file name mimeType detected by {@link org.apache.tika.Tika#detect(String)} is one of the
75 * following.
76 * <ul>
77 * <li>Null</li>
78 * <li>Octet stream</li>
79 * <li>Has a mimetype matching the pattern {@link ResourceHelper#TEXT_TYPE_EXTENSIONS}</li>
80 * </ul>
81 *
82 * @param filename The name of the file.
83 * @return true when the filename is a text type filename, else false.
84 * @throws IllegalArgumentException if filename is null.
85 */
86 default boolean isTextMediaType(String filename) {
87 if (filename == null) {
88 throw new IllegalArgumentException("File can't be null");
89 }
90 String mimeType = ResourceHelper.TIKA.detect(filename);
91 return mimeType == null || mimeType.equals(MediaType.OCTET_STREAM.toString()) || TEXT_TYPE_EXTENSIONS.matcher(mimeType).matches();
92 }
93 }
94