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