source/mircoders/servlet/ServletModuleFileEdit.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  29  */
  30
  31 package mircoders.servlet;
  32
  33 import java.io.BufferedReader;
  34 import java.io.BufferedWriter;
  35 import java.io.File;
  36 import java.io.FileReader;
  37 import java.io.FileWriter;
  38 import java.io.FilenameFilter;
  39 import java.io.StringReader;
  40 import java.io.StringWriter;
  41 import java.util.HashMap;
  42 import java.util.List;
  43 import java.util.Locale;
  44 import java.util.Map;
  45 import java.util.Vector;
  46
  47 import javax.servlet.http.HttpServletRequest;
  48 import javax.servlet.http.HttpServletResponse;
  49
  50 import mir.log.LoggerWrapper;
  51 import mir.servlet.ServletModule;
  52 import mir.servlet.ServletModuleExc;
  53 import mir.servlet.ServletModuleFailure;
  54 import mir.util.FileFunctions;
  55 import mir.util.HTTPRequestParser;
  56 import mir.util.StringRoutines;
  57 import mir.util.URLBuilder;
  58
  59 /*
  60  *  ServletModuleFileEdit -
  61  *  Allows one to do a basic edit of a file in a directory specified
  62  *  in the config file.
  63  *
  64  * @author $Author: zapata $
  65  * @version $Revision: 1.13.2.6 $ $Date: 2003/12/21 17:50:32 $
  66  *
  67  */
  68
  69 public class ServletModuleFileEdit extends ServletModule
  70 {
  71   private static ServletModuleFileEdit instance = new ServletModuleFileEdit();
  72   public static ServletModule getInstance() { return instance; }
  73
  74   private Map directories;
  75   private List directoryNames;
  76
  77   private FilenameFilter dirFilter;
  78
  79   private class FileEditDirectory {
  80     private String name;
  81     private FileFunctions.RegExpFileFilter filter;
  82     private File rootDirectory;
  83     private boolean recursive;
  84
  85     public FileEditDirectory(String aName, String aRootDirectory, String aFilter, boolean aRecursive) {
  86       name = aName;
  87       rootDirectory = new File(aRootDirectory);
  88       filter = new FileFunctions.RegExpFileFilter(aFilter);
  89       recursive = aRecursive;
  90     }
  91
  92     public String getName() {
  93       return name;
  94     }
  95
  96     public FileFunctions.RegExpFileFilter getFilter() {
  97       return filter;
  98     }
  99
 100     public File getRootDirectory() {
 101       return rootDirectory;
 102     }
 103
 104     public boolean getRecursive() {
 105       return recursive;
 106     }
 107   }
 108
 109   private ServletModuleFileEdit() {
 110     super();
 111
 112     logger = new LoggerWrapper("ServletModule.FileEdit");
 113
 114     directories = new HashMap();
 115     directoryNames = new Vector();
 116
 117     String settings[] = configuration.getStringArray("ServletModule.FileEdit.Configuration");
 118
 119     if (settings!=null) {
 120       for (int i = 0; i < settings.length; i++) {
 121         String setting = settings[i].trim();
 122
 123         if (setting.length() > 0) {
 124           List parts = StringRoutines.splitString(setting, ":");
 125           if (parts.size() != 4) {
 126             logger.error("config error: " + settings[i] + ", 4 parts expected");
 127           }
 128           else {
 129             String name = (String) parts.get(0);
 130             String directory = (String) parts.get(1);
 131             String filter = (String) parts.get(2);
 132             String recursive = (String) parts.get(3);
 133
 134             directories.put(name, new FileEditDirectory(name, directory, filter,
 135                 recursive.equals("1") || recursive.toLowerCase().equals("y")));
 136             directoryNames.add(name);
 137           }
 138         }
 139       }
 140     }
 141
 142     dirFilter = new FileFunctions.DirectoryFilter();
 143   }
 144
 145   public List getEntries() {
 146     return directoryNames;
 147   }
 148
 149   public FileEditDirectory getDirectory(HttpServletRequest aRequest) throws ServletModuleExc {
 150     FileEditDirectory result = (FileEditDirectory) directories.get(aRequest.getParameter("entry"));
 151     if (result == null)
 152       throw new ServletModuleExc("Unknown entry: " + aRequest.getParameter("entry"));
 153
 154     return result;
 155   }
 156
 157   public void list(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
 158   {
 159     listSubDirectory(getDirectory(aRequest), "/", aRequest, aResponse);
 160   }
 161
 162   public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
 163   {
 164     try {
 165       HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 166
 167       String filename = requestParser.getParameter("filename");
 168       String subDirectory = requestParser.getParameterWithDefault("subdirectory", "");
 169
 170       if (filename == null)
 171         throw new ServletModuleExc("No filename  specified");
 172
 173       editFile(getDirectory(aRequest), filename, subDirectory, aRequest, aResponse);
 174     }
 175     catch (Throwable e) {
 176       throw new ServletModuleFailure(e);
 177     }
 178   }
 179
 180   public void enter(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
 181   {
 182     try {
 183       HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 184
 185       String directoryName = requestParser.getParameter("directory");
 186       String subDirectoryName = requestParser.getParameter("subdirectory");
 187
 188       if (directoryName==null | subDirectoryName==null)
 189         throw new ServletModuleExc("No directory/subDirectory specified");
 190
 191       listSubDirectory(getDirectory(aRequest), subDirectoryName+File.separator+directoryName, aRequest, aResponse);
 192     }
 193     catch (Throwable e) {
 194       throw new ServletModuleFailure(e);
 195     }
 196   }
 197
 198   public void update(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
 199   {
 200     HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 201     String filename = requestParser.getParameter("filename");
 202     String subDirectory = requestParser.getParameter("subdirectory");
 203     String text = requestParser.getParameter("text");
 204     FileEditDirectory directory = getDirectory(aRequest);
 205
 206     try {
 207       File f = new File(new File(directory.getRootDirectory(), subDirectory), filename);
 208
 209       if (validateDirectory(directory, f)) {
 210         StringReader in = new StringReader(text);
 211         FileWriter out = new FileWriter(f);
 212
 213         int c;
 214         while ( (c = in.read()) != -1)
 215           out.write(c);
 216         in.close();
 217         out.close();
 218
 219         logAdminUsage(aRequest, f.getAbsolutePath(), "object modified");
 220
 221
 222         editFile(directory, filename, subDirectory, aRequest, aResponse);
 223       }
 224     }
 225     catch (Throwable e) {
 226       throw new ServletModuleFailure(e);
 227     }
 228   }
 229
 230   public void listSubDirectory(FileEditDirectory aDirectory, String aSubDirectory, HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
 231   {
 232     try {
 233       Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});
 234       File dir = new File(aDirectory.getRootDirectory(), aSubDirectory);
 235
 236       if (!validateDirectory(aDirectory, dir) || !dir.isDirectory()) {
 237         dir = aDirectory.getRootDirectory();
 238         aSubDirectory = "";
 239       }
 240
 241       responseData.put("filelist", FileFunctions.getDirectoryContentsAsList(dir, aDirectory.getFilter()));
 242
 243       if (aDirectory.getRecursive()) {
 244         List dirs = new Vector();
 245         if (!dir.getCanonicalPath().equals(aDirectory.getRootDirectory().getCanonicalPath()))
 246           responseData.put("updir", new File(aSubDirectory).getParent());
 247
 248         dirs.addAll(FileFunctions.getDirectoryContentsAsList(dir, dirFilter));
 249
 250         responseData.put("dirlist", dirs);
 251       }
 252       else {
 253         responseData.put("dirlist", null);
 254         responseData.put("updir", null);
 255       }
 256
 257       responseData.put("subdirectory", aSubDirectory);
 258       responseData.put("entry", aDirectory.getName());
 259
 260       ServletHelper.generateResponse(aResponse.getWriter(), responseData, listGenerator);
 261     }
 262     catch (Throwable e) {
 263       throw new ServletModuleFailure(e);
 264     }
 265   }
 266
 267   public void editFile(FileEditDirectory aDirectory, String aFileName, String aSubDirectory, HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
 268   {
 269     try {
 270       File f = new File(new File(aDirectory.getRootDirectory(), aSubDirectory), aFileName);
 271
 272       if (!validateDirectory(aDirectory, f) || f.isDirectory() || !validateFile(aDirectory, f)) {
 273         listSubDirectory(aDirectory, "", aRequest, aResponse);
 274       }
 275       else {
 276         Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});
 277         URLBuilder urlBuilder = new URLBuilder();
 278
 279         urlBuilder.setValue("module", "FileEdit");
 280         urlBuilder.setValue("do", "enter");
 281         urlBuilder.setValue("entry", aDirectory.getName());
 282         urlBuilder.setValue("directory", "");
 283         urlBuilder.setValue("subdirectory", aSubDirectory);
 284
 285         BufferedReader in = new BufferedReader(new FileReader(f));
 286         StringWriter textout = new StringWriter();
 287         BufferedWriter out = new BufferedWriter(textout);
 288
 289         // TODO read array
 290         char[] c = new char[4096];
 291         int read;;
 292         while ( (read=in.read(c)) != -1)
 293           out.write(c, 0, read);
 294         in.close();
 295         out.close();
 296
 297         responseData.put("entry", aDirectory.getName());
 298         responseData.put("text", textout.toString());
 299         responseData.put("filename", aFileName);
 300         responseData.put("subdirectory", aSubDirectory);
 301         responseData.put("returnurl", urlBuilder.getQuery());
 302
 303         ServletHelper.generateResponse(aResponse.getWriter(), responseData, editGenerator);
 304       }
 305     }
 306     catch (Throwable e) {
 307       throw new ServletModuleFailure(e);
 308     }
 309   }
 310
 311   protected boolean validateDirectory(FileEditDirectory aDirectory, File aFile) {
 312     try {
 313       return (aFile.getCanonicalPath().startsWith(aDirectory.getRootDirectory().getCanonicalPath()));
 314     }
 315     catch (Throwable t) {
 316       return false;
 317     }
 318   }
 319
 320   protected boolean validateFile(FileEditDirectory aDirectory, File aFile) {
 321     try {
 322       return aDirectory.getFilter().accept(aFile.getParentFile(), aFile.getName());
 323     }
 324     catch (Throwable t) {
 325       return false;
 326     }
 327   }
 328 }