Java tutorial
/** * Copyright (C) 2010-2016 Structr GmbH * * This file is part of Structr <http://structr.org>. * * Structr is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * Structr is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with Structr. If not, see <http://www.gnu.org/licenses/>. */ package org.structr.function; import java.io.IOException; import java.nio.charset.Charset; import java.util.List; import java.util.logging.Level; import java.util.logging.Logger; import org.apache.commons.io.IOUtils; import org.apache.commons.lang3.StringUtils; import org.structr.common.SecurityContext; import org.structr.common.error.FrameworkException; import org.structr.core.GraphObject; import org.structr.core.app.App; import org.structr.core.app.StructrApp; import org.structr.core.graph.NodeInterface; import org.structr.schema.action.ActionContext; import org.structr.schema.action.Function; import org.structr.web.common.RenderContext; import org.structr.web.entity.FileBase; import org.structr.web.entity.dom.DOMNode; /** * Convenience method to render named nodes. If more than one node is found, an error message is returned that informs the user that this is not allowed and can result in unexpected * behavior (instead of including the node). */ public class IncludeFunction extends Function<Object, Object> { private static final Logger logger = Logger.getLogger(IncludeFunction.class.getName()); public static final String ERROR_MESSAGE_INCLUDE = "Usage: ${include(name)}. Example: ${include(\"Main Template\")}"; public static final String ERROR_MESSAGE_INCLUDE_JS = "Usage: ${{Structr.include(name)}}. Example: ${{Structr.include(\"Main Template\")}}"; @Override public String getName() { return "include()"; } @Override public Object apply(final ActionContext ctx, final GraphObject entity, final Object[] sources) throws FrameworkException { if (arrayHasLengthAndAllElementsNotNull(sources, 1) && sources[0] instanceof String) { final SecurityContext securityContext = entity != null ? entity.getSecurityContext() : ctx.getSecurityContext(); final App app = StructrApp.getInstance(securityContext); final RenderContext innerCtx = new RenderContext((RenderContext) ctx); final List<DOMNode> nodeList = app.nodeQuery(DOMNode.class).andName((String) sources[0]).getAsList(); DOMNode node = null; /** * Nodes can be included via their name property These nodes MUST: 1. be unique in name 2. NOT be in the trash => have an ownerDocument AND a parent (public * users are not allowed to see the __ShadowDocument__ ==> this check must either be made in a superuser-context OR the __ShadowDocument could be made public?) * * These nodes can be: 1. somewhere in the pages tree 2. in the shared components 3. both ==> causes a problem because we now have multiple nodes with the same * name (one shared component and multiple linking instances of that component) * * INFOS: * * - If a DOMNode has "syncedNodes" it MUST BE a shared component - If a DOMNodes "sharedComponent" is set it MUST BE AN INSTANCE of a shared component => Can * we safely ignore these? I THINK SO! */ for (final DOMNode n : nodeList) { // Ignore nodes in trash if (n.getProperty(DOMNode.parent) == null && n.getOwnerDocumentAsSuperUser() == null) { continue; } // IGNORE everything that REFERENCES a shared component! if (n.getProperty(DOMNode.sharedComponent) == null) { // the DOMNode is either a shared component OR a named node in the pages tree if (node == null) { node = n; } else { // ERROR: we have found multiple DOMNodes with the same name // TODO: Do we need to remove the nodes from the nodeList which can be ignored? (references to a shared component) return "Ambiguous node name \"" + ((String) sources[0]) + "\" (nodes found: " + StringUtils.join(nodeList, ", ") + ")"; } } } if (node != null) { node.render(innerCtx, 0); } else { final FileBase file = app.nodeQuery(FileBase.class).andName((String) sources[0]).getFirst(); if (file != null) { final String name = file.getProperty(NodeInterface.name); final String contentType = file.getProperty(FileBase.contentType); final String charset = StringUtils.substringAfterLast(contentType, "charset="); final String extension = StringUtils.substringAfterLast(name, "."); if (contentType == null || StringUtils.isBlank(extension)) { return "No valid file type detected. Please make sure " + name + " has a valid content type set or file extension."; } if (contentType.startsWith("text/css")) { return "<link href=\"" + file.getPath() + "\" rel=\"stylesheet\">"; } else if (contentType.contains("/javascript")) { return "<script src=\"" + file.getPath() + "\"></script>"; } else if (contentType.startsWith("image/svg")) { try { final byte[] buffer = new byte[file.getSize().intValue()]; IOUtils.read(file.getInputStream(), buffer); return StringUtils.toEncodedString(buffer, Charset.forName(charset)); } catch (IOException ex) { logger.log(Level.SEVERE, null, ex); } return "<img alt=\"" + name + "\" src=\"" + file.getPath() + "\">"; } else if (contentType.startsWith("image/")) { return "<img alt=\"" + name + "\" src=\"" + file.getPath() + "\">"; } else { return "Don't know how to render content type or extension of " + name + "."; } } } return StringUtils.join(innerCtx.getBuffer().getQueue(), ""); } return usage(ctx.isJavaScriptContext()); } @Override public String usage(boolean inJavaScriptContext) { return (inJavaScriptContext ? ERROR_MESSAGE_INCLUDE_JS : ERROR_MESSAGE_INCLUDE); } @Override public String shortDescription() { return "Includes the content of the node with the given name"; } }