2 * Copyright (C) 2001, 2002 The Mir-coders group
4 * This file is part of Mir.
6 * Mir is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * Mir is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with Mir; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * In addition, as a special exception, The Mir-coders gives permission to link
21 * the code of this program with any library licensed under the Apache Software License,
22 * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
23 * (or with modified versions of the above that use the same license as the above),
24 * and distribute linked combinations including the two. You must obey the
25 * GNU General Public License in all respects for all of the code used other than
26 * the above mentioned libraries. If you modify this file, you may extend this
27 * exception to your version of the file, but you are not obligated to do so.
28 * If you do not wish to do so, delete this exception statement from your version.
31 package mircoders.servlet;
34 import java.io.FileReader;
35 import java.io.FileWriter;
36 import java.io.FilenameFilter;
37 import java.io.StringReader;
38 import java.io.StringWriter;
39 import java.util.HashMap;
40 import java.util.List;
41 import java.util.Locale;
43 import java.util.Vector;
44 import javax.servlet.http.HttpServletRequest;
45 import javax.servlet.http.HttpServletResponse;
47 import mir.log.LoggerWrapper;
48 import mir.servlet.ServletModule;
49 import mir.servlet.ServletModuleExc;
50 import mir.servlet.ServletModuleFailure;
51 import mir.util.FileFunctions;
52 import mir.util.HTTPRequestParser;
53 import mir.util.StringRoutines;
54 import mir.util.URLBuilder;
57 * ServletModuleFileEdit -
58 * Allows one to do a basic edit of a file in a directory specified
61 * @author $Author: zapata $
62 * @version $Revision: 1.13.2.3 $ $Date: 2003/09/19 02:54:51 $
66 public class ServletModuleFileEdit extends ServletModule
68 private static ServletModuleFileEdit instance = new ServletModuleFileEdit();
69 public static ServletModule getInstance() { return instance; }
71 private Map directories;
72 private List directoryNames;
74 private FilenameFilter dirFilter;
76 private class FileEditDirectory {
78 private FileFunctions.RegExpFileFilter filter;
79 private File rootDirectory;
80 private boolean recursive;
82 public FileEditDirectory(String aName, String aRootDirectory, String aFilter, boolean aRecursive) {
84 rootDirectory = new File(aRootDirectory);
85 filter = new FileFunctions.RegExpFileFilter(aFilter);
86 recursive = aRecursive;
89 public String getName() {
93 public FileFunctions.RegExpFileFilter getFilter() {
97 public File getRootDirectory() {
101 public boolean getRecursive() {
106 private ServletModuleFileEdit() {
109 logger = new LoggerWrapper("ServletModule.FileEdit");
111 directories = new HashMap();
112 directoryNames = new Vector();
114 String settings[] = configuration.getStringArray("ServletModule.FileEdit.Configuration");
116 if (settings!=null) {
117 for (int i = 0; i < settings.length; i++) {
118 String setting = settings[i].trim();
120 if (setting.length() > 0) {
121 List parts = StringRoutines.splitString(setting, ":");
122 if (parts.size() != 4) {
123 logger.error("config error: " + settings[i] + ", 4 parts expected");
126 String name = (String) parts.get(0);
127 String directory = (String) parts.get(1);
128 String filter = (String) parts.get(2);
129 String recursive = (String) parts.get(3);
131 directories.put(name, new FileEditDirectory(name, directory, filter,
132 recursive.equals("1") || recursive.toLowerCase().equals("y")));
133 directoryNames.add(name);
139 dirFilter = new FileFunctions.DirectoryFilter();
142 public List getEntries() {
143 return directoryNames;
146 public FileEditDirectory getDirectory(HttpServletRequest aRequest) throws ServletModuleExc {
147 FileEditDirectory result = (FileEditDirectory) directories.get(aRequest.getParameter("entry"));
149 throw new ServletModuleExc("Unknown entry: " + aRequest.getParameter("entry"));
154 public void list(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
156 listSubDirectory(getDirectory(aRequest), "/", aRequest, aResponse);
159 public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
162 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
164 String filename = requestParser.getParameter("filename");
165 String subDirectory = requestParser.getParameterWithDefault("subdirectory", "");
167 if (filename == null)
168 throw new ServletModuleExc("No filename specified");
170 editFile(getDirectory(aRequest), filename, subDirectory, aRequest, aResponse);
172 catch (Throwable e) {
173 throw new ServletModuleFailure(e);
177 public void enter(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
180 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
182 String directoryName = requestParser.getParameter("directory");
183 String subDirectoryName = requestParser.getParameter("subdirectory");
185 if (directoryName==null | subDirectoryName==null)
186 throw new ServletModuleExc("No directory/subDirectory specified");
188 listSubDirectory(getDirectory(aRequest), subDirectoryName+File.separator+directoryName, aRequest, aResponse);
190 catch (Throwable e) {
191 throw new ServletModuleFailure(e);
195 public void update(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
197 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
198 String filename = requestParser.getParameter("filename");
199 String subDirectory = requestParser.getParameter("subdirectory");
200 String text = requestParser.getParameter("text");
201 FileEditDirectory directory = getDirectory(aRequest);
204 File f = new File(new File(directory.getRootDirectory(), subDirectory), filename);
206 if (validateDirectory(directory, f)) {
207 StringReader in = new StringReader(text);
208 FileWriter out = new FileWriter(f);
211 while ( (c = in.read()) != -1)
216 logAdminUsage(aRequest, f.getAbsolutePath(), "object modified");
219 editFile(directory, filename, subDirectory, aRequest, aResponse);
222 catch (Throwable e) {
223 throw new ServletModuleFailure(e);
227 public void listSubDirectory(FileEditDirectory aDirectory, String aSubDirectory, HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
230 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});
231 File dir = new File(aDirectory.getRootDirectory(), aSubDirectory);
233 if (!validateDirectory(aDirectory, dir) || !dir.isDirectory()) {
234 dir = aDirectory.getRootDirectory();
238 responseData.put("filelist", FileFunctions.getDirectoryContentsAsList(dir, aDirectory.getFilter()));
240 if (aDirectory.getRecursive()) {
241 List dirs = new Vector();
242 if (!dir.getCanonicalPath().equals(aDirectory.getRootDirectory().getCanonicalPath()))
243 responseData.put("updir", new File(aSubDirectory).getParent());
245 dirs.addAll(FileFunctions.getDirectoryContentsAsList(dir, dirFilter));
247 responseData.put("dirlist", dirs);
250 responseData.put("dirlist", null);
251 responseData.put("updir", null);
254 responseData.put("subdirectory", aSubDirectory);
255 responseData.put("entry", aDirectory.getName());
257 ServletHelper.generateResponse(aResponse.getWriter(), responseData, listGenerator);
259 catch (Throwable e) {
260 throw new ServletModuleFailure(e);
264 public void editFile(FileEditDirectory aDirectory, String aFileName, String aSubDirectory, HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
267 File f = new File(new File(aDirectory.getRootDirectory(), aSubDirectory), aFileName);
269 if (!validateDirectory(aDirectory, f) || f.isDirectory() || !validateFile(aDirectory, f)) {
270 listSubDirectory(aDirectory, "", aRequest, aResponse);
273 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});
274 URLBuilder urlBuilder = new URLBuilder();
276 urlBuilder.setValue("module", "FileEdit");
277 urlBuilder.setValue("do", "enter");
278 urlBuilder.setValue("entry", aDirectory.getName());
279 urlBuilder.setValue("directory", "");
280 urlBuilder.setValue("subdirectory", aSubDirectory);
282 FileReader in = new FileReader(f);
283 StringWriter out = new StringWriter();
286 while ( (c = in.read()) != -1)
291 responseData.put("entry", aDirectory.getName());
292 responseData.put("text", out.toString());
293 responseData.put("filename", aFileName);
294 responseData.put("subdirectory", aSubDirectory);
295 responseData.put("returnurl", urlBuilder.getQuery());
297 ServletHelper.generateResponse(aResponse.getWriter(), responseData, editGenerator);
300 catch (Throwable e) {
301 throw new ServletModuleFailure(e);
305 protected boolean validateDirectory(FileEditDirectory aDirectory, File aFile) {
307 return (aFile.getCanonicalPath().startsWith(aDirectory.getRootDirectory().getCanonicalPath()));
309 catch (Throwable t) {
314 protected boolean validateFile(FileEditDirectory aDirectory, File aFile) {
316 return aDirectory.getFilter().accept(aFile.getParentFile(), aFile.getName());
318 catch (Throwable t) {