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