| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.sling.jcr.classloader.internal; |
| |
| import java.io.ByteArrayInputStream; |
| import java.io.ByteArrayOutputStream; |
| import java.io.FileNotFoundException; |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.io.OutputStream; |
| import java.util.Dictionary; |
| |
| import javax.jcr.Item; |
| import javax.jcr.Node; |
| import javax.jcr.Property; |
| import javax.jcr.RepositoryException; |
| import javax.jcr.Session; |
| import javax.jcr.SimpleCredentials; |
| |
| import org.apache.sling.commons.classloader.ClassLoaderWriter; |
| import org.apache.sling.commons.classloader.DynamicClassLoaderProvider; |
| import org.apache.sling.commons.mime.MimeTypeService; |
| import org.apache.sling.jcr.api.SlingRepository; |
| import org.osgi.service.component.ComponentContext; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| /** |
| * The <code>DynamicClassLoaderProviderImpl</code> provides |
| * a class loader which loads classes from configured paths |
| * in the repository. |
| * In addition it implements {@link ClassLoaderWriter} and |
| * supports writing class files to the repository. |
| * |
| * @scr.component label="%loader.name" |
| * description="%loader.description" |
| * @scr.property name="service.vendor" value="The Apache Software Foundation" |
| * @scr.property name="service.description" |
| * value="Provides Repository ClassLoaders" |
| * @scr.service interface="DynamicClassLoaderProvider" |
| * @scr.service interface="ClassLoaderWriter" |
| */ |
| public class DynamicClassLoaderProviderImpl |
| implements DynamicClassLoaderProvider, ClassLoaderWriter { |
| |
| /** default log */ |
| private final Logger log = LoggerFactory.getLogger(DynamicClassLoaderProviderImpl.class); |
| |
| /** |
| * @scr.property valueRefs0="CLASS_PATH_DEFAULT" |
| */ |
| public static final String CLASS_PATH_PROP = "classpath"; |
| |
| public static final String CLASS_PATH_DEFAULT = "/var/classes"; |
| |
| /** Node type for packages/folders. */ |
| private static final String NT_FOLDER = "nt:folder"; |
| |
| /** |
| * @scr.property valueRef="OWNER_DEFAULT" |
| */ |
| public static final String OWNER_PROP = "owner"; |
| |
| /** Default class loader owner. */ |
| public static final String OWNER_DEFAULT = "admin"; |
| |
| /** The owner of the class loader / jcr user. */ |
| private String classLoaderOwner; |
| |
| |
| /** JSP Class Loader class path will be injected to the class loader. */ |
| private static final String[] CLASS_PATH_EMPTY = { }; |
| |
| /** |
| * @scr.reference |
| */ |
| private SlingRepository repository; |
| |
| /** The configured class paths. */ |
| private String[] classPath; |
| |
| /** @scr.reference policy="dynamic" */ |
| private MimeTypeService mimeTypeService; |
| |
| /** The read session. */ |
| private Session readSession; |
| |
| /** |
| * Return a new session (for writing). |
| */ |
| Session getSession() throws RepositoryException { |
| // get an administrative session for potentiall impersonation |
| final Session admin = this.repository.loginAdministrative(null); |
| |
| // do use the admin session, if the admin's user id is the same as owner |
| if (admin.getUserID().equals(this.getOwnerId())) { |
| return admin; |
| } |
| |
| // else impersonate as the owner and logout the admin session again |
| try { |
| return admin.impersonate(new SimpleCredentials(this.getOwnerId(), new char[0])); |
| } finally { |
| admin.logout(); |
| } |
| } |
| |
| /** |
| * @see org.apache.sling.commons.classloader.DynamicClassLoaderProvider#getClassLoader(ClassLoader) |
| */ |
| public ClassLoader getClassLoader(final ClassLoader parent) { |
| return new RepositoryClassLoaderFacade(this, parent, this.getClassPaths()); |
| } |
| |
| /** |
| * @see org.apache.sling.commons.classloader.DynamicClassLoaderProvider#release(java.lang.ClassLoader) |
| */ |
| public void release(ClassLoader classLoader) { |
| if ( classLoader instanceof RepositoryClassLoaderFacade ) { |
| ((RepositoryClassLoaderFacade)classLoader).destroy(); |
| } |
| } |
| //---------- SCR Integration ---------------------------------------------- |
| |
| |
| /** |
| * @see org.apache.sling.commons.classloader.ClassLoaderWriter#delete(java.lang.String) |
| */ |
| public boolean delete(String name) { |
| name = cleanPath(name); |
| Session session = null; |
| try { |
| session = getSession(); |
| if (session.itemExists(name)) { |
| Item fileItem = session.getItem(name); |
| fileItem.remove(); |
| session.save(); |
| return true; |
| } |
| } catch (RepositoryException re) { |
| log.error("Cannot remove " + name, re); |
| } finally { |
| if ( session != null ) { |
| session.logout(); |
| } |
| } |
| |
| // fall back to false if item does not exist or in case of error |
| return false; |
| } |
| |
| /** |
| * @see org.apache.sling.commons.classloader.ClassLoaderWriter#getOutputStream(java.lang.String) |
| */ |
| public OutputStream getOutputStream(String name) { |
| final String path = cleanPath(name); |
| return new RepositoryOutputStream(this, path); |
| } |
| |
| /** |
| * @see org.apache.sling.commons.classloader.ClassLoaderWriter#rename(java.lang.String, java.lang.String) |
| */ |
| public boolean rename(String oldName, String newName) { |
| Session session = null; |
| try { |
| oldName = cleanPath(oldName); |
| newName = cleanPath(newName); |
| |
| session = this.getSession(); |
| session.move(oldName, newName); |
| session.save(); |
| return true; |
| } catch (RepositoryException re) { |
| log.error("Cannot rename " + oldName + " to " + newName, re); |
| } finally { |
| if ( session != null ) { |
| session.logout(); |
| } |
| } |
| |
| // fallback to false in case of error or non-existence of oldFileName |
| return false; |
| } |
| |
| /** |
| * Creates a folder hierarchy in the repository. |
| * We synchronize this method to reduce potential conflics. |
| * Although each write uses its own session it might occur |
| * that more than one session tries to create the same path |
| * (or parent path) at the same time. By synchronizing this |
| * we avoid this situation - however this method is written |
| * in a failsafe manner anyway. |
| */ |
| private synchronized boolean mkdirs(final Session session, String path) { |
| try { |
| // quick test |
| if (session.itemExists(path) && session.getItem(path).isNode()) { |
| return true; |
| } |
| |
| // check path walking it down |
| Node current = session.getRootNode(); |
| String[] names = path.split("/"); |
| for (int i = 0; i < names.length; i++) { |
| if (names[i] == null || names[i].length() == 0) { |
| continue; |
| } else if (current.hasNode(names[i])) { |
| current = current.getNode(names[i]); |
| } else { |
| final Node parentNode = current; |
| try { |
| // adding the node could cause an exception |
| // for example if another thread tries to |
| // create the node "at the same time" |
| current = parentNode.addNode(names[i], NT_FOLDER); |
| session.save(); |
| } catch (RepositoryException re) { |
| // let's first refresh the session |
| // we don't catch an exception here, because if |
| // session refresh fails, we might have a serious problem! |
| session.refresh(false); |
| // let's check if the node is available now |
| if ( parentNode.hasNode(names[i]) ) { |
| current = parentNode.getNode(names[i]); |
| } else { |
| // we try it one more time to create the node - and fail otherwise |
| current = parentNode.addNode(names[i], NT_FOLDER); |
| session.save(); |
| } |
| } |
| } |
| } |
| |
| return true; |
| |
| } catch (RepositoryException re) { |
| log.error("Cannot create folder path:" + path, re); |
| // discard changes |
| try { |
| session.refresh(false); |
| } catch (RepositoryException e) { |
| // we simply ignore this |
| } |
| } |
| |
| // false in case of error or no need to create |
| return false; |
| } |
| |
| /** |
| * Helper method to clean the path. |
| * It replaces backslashes with slashes and cuts off trailing spaces. |
| * It uses the first configured class path to access the path. |
| */ |
| private String cleanPath(String path) { |
| // replace backslash by slash |
| path = path.replace('\\', '/'); |
| |
| // cut off trailing slash |
| while (path.endsWith("/")) { |
| path = path.substring(0, path.length() - 1); |
| } |
| |
| if ( this.classPath == null || this.classPath.length == 0 ) { |
| return path; |
| } |
| return this.classPath[0] + path; |
| } |
| |
| private static class RepositoryOutputStream extends ByteArrayOutputStream { |
| |
| private final DynamicClassLoaderProviderImpl repositoryOutputProvider; |
| |
| private final String fileName; |
| |
| RepositoryOutputStream(DynamicClassLoaderProviderImpl repositoryOutputProvider, |
| String fileName) { |
| this.repositoryOutputProvider = repositoryOutputProvider; |
| this.fileName = fileName; |
| } |
| |
| /** |
| * @see java.io.ByteArrayOutputStream#close() |
| */ |
| public void close() throws IOException { |
| super.close(); |
| |
| Session session = null; |
| try { |
| // get an own session for writing |
| session = repositoryOutputProvider.getSession(); |
| final int lastPos = fileName.lastIndexOf('/'); |
| final String path = (lastPos == -1 ? null : fileName.substring(0, lastPos)); |
| final String name = (lastPos == -1 ? fileName : fileName.substring(lastPos + 1)); |
| if ( lastPos != -1 ) { |
| if ( !repositoryOutputProvider.mkdirs(session, path) ) { |
| throw new IOException("Unable to create path for " + path); |
| } |
| } |
| Node fileNode = null; |
| Node contentNode = null; |
| Node parentNode = null; |
| if (session.itemExists(fileName)) { |
| final Item item = session.getItem(fileName); |
| if (item.isNode()) { |
| final Node node = item.isNode() ? (Node) item : item.getParent(); |
| if ("jcr:content".equals(node.getName())) { |
| // replace the content properties of the jcr:content |
| // node |
| parentNode = node; |
| contentNode = node; |
| } else if (node.isNodeType("nt:file")) { |
| // try to set the content properties of jcr:content |
| // node |
| parentNode = node; |
| contentNode = node.getNode("jcr:content"); |
| } else { // fileName is a node |
| // try to set the content properties of the node |
| parentNode = node; |
| contentNode = node; |
| } |
| } else { |
| // replace property with an nt:file node (if possible) |
| parentNode = item.getParent(); |
| item.remove(); |
| session.save(); |
| fileNode = parentNode.addNode(name, "nt:file"); |
| } |
| } else { |
| if (lastPos <= 0) { |
| parentNode = session.getRootNode(); |
| } else { |
| Item parent = session.getItem(path); |
| if (!parent.isNode()) { |
| throw new IOException("Parent at " + path + " is not a node."); |
| } |
| parentNode = (Node) parent; |
| } |
| fileNode = parentNode.addNode(name, "nt:file"); |
| } |
| |
| // if we have a file node, create the contentNode |
| if (fileNode != null) { |
| contentNode = fileNode.addNode("jcr:content", "nt:resource"); |
| } |
| |
| final MimeTypeService mtService = this.repositoryOutputProvider.mimeTypeService; |
| |
| String mimeType = (mtService == null ? null : mtService.getMimeType(fileName)); |
| if (mimeType == null) { |
| mimeType = "application/octet-stream"; |
| } |
| |
| contentNode.setProperty("jcr:lastModified", System.currentTimeMillis()); |
| contentNode.setProperty("jcr:data", new ByteArrayInputStream(buf, 0, size())); |
| contentNode.setProperty("jcr:mimeType", mimeType); |
| |
| session.save(); |
| } catch (RepositoryException re) { |
| throw (IOException)new IOException("Cannot write file " + fileName + ", reason: " + re.toString()).initCause(re); |
| } finally { |
| if ( session != null ) { |
| session.logout(); |
| } |
| } |
| } |
| } |
| |
| /** |
| * @see org.apache.sling.commons.classloader.ClassLoaderWriter#getInputStream(java.lang.String) |
| */ |
| public InputStream getInputStream(String fileName) |
| throws IOException { |
| final String path = cleanPath(fileName) + "/jcr:content/jcr:data"; |
| Session session = null; |
| try { |
| session = this.getReadSession(); |
| if ( session.itemExists(path) ) { |
| final Property prop = (Property)session.getItem(path); |
| return prop.getStream(); |
| } |
| throw new FileNotFoundException("Unable to find " + fileName); |
| } catch (RepositoryException re) { |
| throw (IOException) new IOException( |
| "Failed to get InputStream for " + fileName).initCause(re); |
| } |
| } |
| |
| /** |
| * @see org.apache.sling.commons.classloader.ClassLoaderWriter#getLastModified(java.lang.String) |
| */ |
| public long getLastModified(String fileName) { |
| final String path = cleanPath(fileName) + "/jcr:content/jcr:lastModified"; |
| Session session = null; |
| try { |
| session = this.getReadSession(); |
| if ( session.itemExists(path) ) { |
| final Property prop = (Property)session.getItem(path); |
| return prop.getLong(); |
| } |
| } catch (RepositoryException se) { |
| log.error("Cannot get last modification time for " + fileName, se); |
| } |
| |
| // fallback to "non-existant" in case of problems |
| return -1; |
| } |
| |
| /** |
| * Activate this component. |
| * @param componentContext The component context. |
| */ |
| protected void activate(final ComponentContext componentContext) { |
| @SuppressWarnings("unchecked") |
| Dictionary properties = componentContext.getProperties(); |
| |
| Object prop = properties.get(CLASS_PATH_PROP); |
| this.classPath = (prop instanceof String[]) ? (String[]) prop : CLASS_PATH_EMPTY; |
| |
| prop = properties.get(OWNER_PROP); |
| this.classLoaderOwner = (prop instanceof String)? (String) prop : OWNER_DEFAULT; |
| } |
| |
| /** |
| * Deactivate this component |
| * @param componentContext The component context. |
| */ |
| protected void deactivate(final ComponentContext componentContext) { |
| if ( this.readSession != null ) { |
| this.readSession.logout(); |
| this.readSession = null; |
| } |
| } |
| |
| /** |
| * Return the owner id |
| */ |
| protected String getOwnerId() { |
| return this.classLoaderOwner; |
| } |
| |
| /** |
| * Return the configured class paths |
| */ |
| protected String[] getClassPaths() { |
| return this.classPath; |
| } |
| |
| /** |
| * Return the read session. |
| */ |
| public synchronized Session getReadSession() throws RepositoryException { |
| // check current session |
| if (this.readSession != null) { |
| if (this.readSession.isLive()) { |
| return this.readSession; |
| } |
| |
| // current session is not live anymore, drop |
| this.readSession.logout(); |
| this.readSession = null; |
| } |
| |
| // no session currently, acquire and return |
| this.readSession = this.getSession(); |
| return this.readSession; |
| } |
| } |