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