001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/db/CmsExportPointDriver.java,v $
003: * Date : $Date: 2008-02-27 12:05:43 $
004: * Version: $Revision: 1.24 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.db;
033:
034: import org.opencms.main.CmsLog;
035:
036: import java.io.File;
037: import java.io.FileOutputStream;
038: import java.io.OutputStream;
039: import java.util.HashMap;
040: import java.util.Iterator;
041: import java.util.Set;
042:
043: import org.apache.commons.logging.Log;
044:
045: /**
046: * Provides methods to write export points to the "real" file system.<p>
047: *
048: * @author Alexander Kandzior
049: *
050: * @version $Revision: 1.24 $
051: *
052: * @since 6.0.0
053: */
054: public class CmsExportPointDriver {
055:
056: /** The log object for this class. */
057: private static final Log LOG = CmsLog
058: .getLog(CmsExportPointDriver.class);
059:
060: /** The export points resolved to a lookup map. */
061: private HashMap m_exportpointLookupMap;
062:
063: /** The configured export points. */
064: private Set m_exportpoints;
065:
066: /**
067: * Constructor for a CmsExportPointDriver.<p>
068: *
069: * @param exportpoints the list of export points
070: */
071: public CmsExportPointDriver(Set exportpoints) {
072:
073: m_exportpoints = exportpoints;
074: m_exportpointLookupMap = new HashMap();
075: Iterator i = m_exportpoints.iterator();
076: while (i.hasNext()) {
077: CmsExportPoint point = (CmsExportPoint) i.next();
078: if (point.getDestinationPath() != null) {
079: // otherwise this point is not valid, but must be kept for serializing the configuration
080: m_exportpointLookupMap.put(point.getUri(), point
081: .getDestinationPath());
082: }
083: }
084: }
085:
086: /**
087: * If required, creates the folder with the given root path in the real file system.<p>
088: *
089: * @param resourceName the root path of the folder to create
090: * @param exportpoint the export point to create the folder in
091: */
092: public void createFolder(String resourceName, String exportpoint) {
093:
094: writeResource(resourceName, exportpoint, null);
095: }
096:
097: /**
098: * Deletes a file or a folder in the real file sytem.<p>
099: *
100: * If the given resource name points to a folder, then this folder is only deleted if it is empty.
101: * This is required since the same export point RFS target folder may be used by multiple export points.
102: * For example, this is usually the case with the <code>/WEB-INF/classes/</code> and
103: * <code>/WEB-INF/lib/</code> folders which are export point for multiple modules.
104: * If all resources in the RFS target folder where deleted, uninstalling one module would delete the
105: * export <code>classes</code> and <code>lib</code> resources of all other modules.<p>
106: *
107: * @param resourceName the root path of the resource to be deleted
108: * @param exportpoint the name of the export point
109: */
110: public void deleteResource(String resourceName, String exportpoint) {
111:
112: File file = getExportPointFile(resourceName, exportpoint);
113: if (file.exists() && file.canWrite()) {
114: // delete the file (or folder)
115: file.delete();
116: // also delete empty parent directories
117: File parent = file.getParentFile();
118: if (parent.canWrite()) {
119: parent.delete();
120: }
121: }
122: }
123:
124: /**
125: * Returns the export point path for the given resource root path,
126: * or <code>null</code> if the resource is not contained in
127: * any export point.<p>
128: *
129: * @param rootPath the root path of a resource in the OpenCms VFS
130: * @return the export point path for the given resource, or <code>null</code> if the resource is not contained in
131: * any export point
132: */
133: public String getExportPoint(String rootPath) {
134:
135: Iterator i = getExportPointPaths().iterator();
136: while (i.hasNext()) {
137: String point = (String) i.next();
138: if (rootPath.startsWith(point)) {
139: return point;
140: }
141: }
142: return null;
143: }
144:
145: /**
146: * Returns the set of all VFS paths that are exported as an export point.<p>
147: *
148: * @return the set of all VFS paths that are exported as an export point
149: */
150: public Set getExportPointPaths() {
151:
152: return m_exportpointLookupMap.keySet();
153: }
154:
155: /**
156: * Writes the file with the given root path to the real file system.<p>
157: *
158: * If required, missing parent folders in the real file system are automatically created.<p>
159: *
160: * @param resourceName the root path of the file to write
161: * @param exportpoint the export point to write file to
162: * @param content the contents of the file to write
163: */
164: public void writeFile(String resourceName, String exportpoint,
165: byte[] content) {
166:
167: writeResource(resourceName, exportpoint, content);
168: }
169:
170: /**
171: * Returns the File for the given export point resource.<p>
172: *
173: * @param rootPath name of a file in the VFS
174: * @param exportpoint the name of the export point
175: * @return the File for the given export point resource
176: */
177: private File getExportPointFile(String rootPath, String exportpoint) {
178:
179: StringBuffer exportpath = new StringBuffer(128);
180: exportpath.append((String) m_exportpointLookupMap
181: .get(exportpoint));
182: exportpath.append(rootPath.substring(exportpoint.length()));
183: return new File(exportpath.toString());
184: }
185:
186: /**
187: * Writes (if required creates) a resource with the given name to the real file system.<p>
188: *
189: * @param resourceName the root path of the resource to write
190: * @param exportpoint the name of the export point
191: * @param content the contents of the file to write
192: */
193: private void writeResource(String resourceName, String exportpoint,
194: byte[] content) {
195:
196: File file = getExportPointFile(resourceName, exportpoint);
197: try {
198: File folder;
199: if (content == null) {
200: // a folder is to be created
201: folder = file;
202: } else {
203: // a file is to be written
204: folder = file.getParentFile();
205: }
206: // make sure the parent folder exists
207: if (!folder.exists()) {
208: boolean success = folder.mkdirs();
209: if (!success) {
210: LOG.error(Messages.get().getBundle().key(
211: Messages.LOG_CREATE_FOLDER_FAILED_1,
212: folder.getAbsolutePath()));
213: }
214: }
215: if (content != null) {
216: // now write the file to the real file system
217: OutputStream s = new FileOutputStream(file);
218: s.write(content);
219: s.close();
220: }
221: } catch (Exception e) {
222: LOG.error(Messages.get().getBundle().key(
223: Messages.LOG_WRITE_EXPORT_POINT_FAILED_1,
224: file.getAbsolutePath()), e);
225: }
226: }
227: }
|