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;
33 import mir.servlet.AdminServletModule;
34 import mir.servlet.ServletModuleExc;
35 import mir.servlet.ServletModuleFailure;
36 import mir.util.FileRoutines;
37 import mir.util.HTTPRequestParser;
38 import mir.util.StringRoutines;
39 import mir.util.URLBuilder;
40 import mircoders.global.MirGlobal;
42 import javax.servlet.http.HttpServletRequest;
43 import javax.servlet.http.HttpServletResponse;
48 * ServletModuleFileEdit -
49 * Allows one to do a basic edit of a file in a directory specified
52 * @author $Author: zapata $
53 * @version $Revision: 1.13.2.12 $ $Date: 2006/06/01 17:57:21 $
57 public class ServletModuleFileEdit extends AdminServletModule {
58 private Map directories;
59 private List directoryNames;
61 private FilenameFilter dirFilter;
63 public ServletModuleFileEdit() {
64 directories = new HashMap();
65 directoryNames = new ArrayList();
68 getConfiguration().getStringArray("ServletModule.FileEdit.Configuration");
71 for (int i = 0; i < settings.length; i++) {
72 String setting = settings[i].trim();
74 if (setting.length() > 0) {
75 List parts = StringRoutines.splitStringWithEscape(setting, ':', '\\');
76 if (parts.size() != 4) {
77 getLogger().error("config error: " + settings[i] + ", 4 parts expected");
80 String name = (String) parts.get(0);
81 String directory = (String) parts.get(1);
82 String filter = (String) parts.get(2);
83 String recursive = (String) parts.get(3);
85 directories.put(name, new FileEditDirectory(name, directory, filter,
86 "1".equals(recursive) || "y".equals(recursive.toLowerCase())));
87 directoryNames.add(name);
93 dirFilter = new FileRoutines.DirectoryFilter();
96 public List getEntries() {
97 return directoryNames;
100 public FileEditDirectory getDirectory(HttpServletRequest aRequest) throws ServletModuleExc {
101 FileEditDirectory result = (FileEditDirectory) directories.get(aRequest.getParameter("entry"));
103 throw new ServletModuleExc("Unknown entry: " + aRequest.getParameter("entry"));
108 public void list(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
110 listSubDirectory(getDirectory(aRequest), "/", aRequest, aResponse);
113 public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
116 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
118 String filename = requestParser.getParameter("filename");
119 String subDirectory = requestParser.getParameterWithDefault("subdirectory", "");
121 if (filename == null)
122 throw new ServletModuleExc("No filename specified");
124 editFile(getDirectory(aRequest), filename, subDirectory, aRequest, aResponse);
126 catch (Throwable e) {
127 throw new ServletModuleFailure(e);
131 public void enter(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
134 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
136 String directoryName = requestParser.getParameter("directory");
137 String subDirectoryName = requestParser.getParameter("subdirectory");
139 if (directoryName==null | subDirectoryName==null)
140 throw new ServletModuleExc("No directory/subDirectory specified");
142 listSubDirectory(getDirectory(aRequest), subDirectoryName+File.separator+directoryName, aRequest, aResponse);
144 catch (Throwable e) {
145 throw new ServletModuleFailure(e);
150 * Called when an edited file is saved by the user
152 public void update(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
154 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
155 String filename = requestParser.getParameter("filename");
156 String subDirectory = requestParser.getParameter("subdirectory");
158 StringRoutines.performRegularExpressionReplacement(
159 requestParser.getParameter("text"),
161 System.getProperty("line.separator"));
162 FileEditDirectory directory = getDirectory(aRequest);
165 File f = new File(new File(directory.getRootDirectory(), subDirectory), filename);
167 if (isDirectoryValid(directory, f)) {
168 FileWriter out = new FileWriter(f);
170 out.write(text.toCharArray());
176 logAdminUsage(aRequest, f.getAbsolutePath(), "object modified");
178 MirGlobal.getChangeEngine().getTracker().addChange(f.getCanonicalPath());
180 editFile(directory, filename, subDirectory, aRequest, aResponse);
183 catch (Throwable e) {
184 throw new ServletModuleFailure(e);
188 public void listSubDirectory(FileEditDirectory aDirectory, String aSubDirectory, HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
191 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});
192 File dir = new File(aDirectory.getRootDirectory(), aSubDirectory);
194 if (!isDirectoryValid(aDirectory, dir) || !dir.isDirectory()) {
195 dir = aDirectory.getRootDirectory();
199 responseData.put("filelist", FileRoutines.getDirectoryContentsAsList(dir, aDirectory.getFilter()));
201 if (aDirectory.getRecursive()) {
202 List dirs = new ArrayList();
203 if (!dir.getCanonicalPath().equals(aDirectory.getRootDirectory().getCanonicalPath()))
204 responseData.put("updir", new File(aSubDirectory).getParent());
206 dirs.addAll(FileRoutines.getDirectoryContentsAsList(dir, dirFilter));
208 responseData.put("dirlist", dirs);
211 responseData.put("dirlist", null);
212 responseData.put("updir", null);
215 responseData.put("subdirectory", aSubDirectory);
216 responseData.put("entry", aDirectory.getName());
218 ServletHelper.generateResponse(aResponse.getWriter(), responseData, listGenerator);
220 catch (Throwable e) {
221 throw new ServletModuleFailure(e);
225 public void editFile(FileEditDirectory aDirectory, String aFileName, String aSubDirectory, HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
227 File f = new File(new File(aDirectory.getRootDirectory(), aSubDirectory), aFileName);
229 if (!isDirectoryValid(aDirectory, f) || f.isDirectory() || !isFileValid(aDirectory, f)) {
230 listSubDirectory(aDirectory, "", aRequest, aResponse);
233 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});
234 URLBuilder urlBuilder = new URLBuilder();
236 urlBuilder.setValue("module", "FileEdit");
237 urlBuilder.setValue("do", "enter");
238 urlBuilder.setValue("entry", aDirectory.getName());
239 urlBuilder.setValue("directory", "");
240 urlBuilder.setValue("subdirectory", aSubDirectory);
242 BufferedReader in = new BufferedReader(new FileReader(f));
243 StringWriter textout = new StringWriter();
244 BufferedWriter out = new BufferedWriter(textout);
247 char[] c = new char[4096];
249 while ((read=in.read(c)) != -1) {
250 out.write(c, 0, read);
255 responseData.put("entry", aDirectory.getName());
256 responseData.put("text", textout.toString());
257 responseData.put("filename", aFileName);
258 responseData.put("subdirectory", aSubDirectory);
259 responseData.put("returnurl", urlBuilder.getQuery());
261 ServletHelper.generateResponse(aResponse.getWriter(), responseData, editGenerator);
264 catch (Throwable e) {
265 throw new ServletModuleFailure(e);
269 private boolean isDirectoryValid(FileEditDirectory aDirectory, File aFile) {
271 return aFile.getCanonicalPath().startsWith(aDirectory.getRootDirectory().getCanonicalPath());
273 catch (Throwable t) {
278 private boolean isFileValid(FileEditDirectory aDirectory, File aFile) {
280 return aDirectory.getFilter().accept(aFile.getParentFile(), aFile.getName());
282 catch (Throwable t) {
287 private class FileEditDirectory {
289 private FileRoutines.RegExpFileFilter filter;
290 private File rootDirectory;
291 private boolean recursive;
293 public FileEditDirectory(String aName, String aRootDirectory, String aFilter, boolean aRecursive) {
295 rootDirectory = new File(aRootDirectory);
296 filter = new FileRoutines.RegExpFileFilter(aFilter);
297 recursive = aRecursive;
300 public String getName() {
304 public FileRoutines.RegExpFileFilter getFilter() {
308 public File getRootDirectory() {
309 return rootDirectory;
312 public boolean getRecursive() {