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