if the directory the file should be written is not existing, it is created now
[mir.git] / source / mircoders / servlet / ServletModuleUploadedMedia.java
index d304d6e..fd66221 100755 (executable)
@@ -1,29 +1,35 @@
 package mircoders.servlet;
 
-import java.io.*;
-import java.lang.*;
-import java.sql.*;
-import java.util.*;
-import java.net.*;
-import java.lang.reflect.*;
-import javax.servlet.*;
-import javax.servlet.http.*;
-
-import freemarker.template.*;
-import com.oreilly.servlet.multipart.*;
-import com.oreilly.servlet.*;
-
-import mir.servlet.*;
-import mir.module.*;
-import mir.misc.*;
-import mir.entity.*;
-import mir.storage.*;
-import mir.media.*;
-
-import mircoders.entity.*;
-import mircoders.storage.*;
-import mircoders.module.*;
-import mircoders.producer.*;
+import freemarker.template.SimpleHash;
+import mir.entity.Entity;
+import mir.entity.EntityList;
+import mir.media.MediaHelper;
+import mir.media.MirMedia;
+import mir.media.MirMediaException;
+import mir.media.MirMediaUserException;
+import mir.misc.MirConfig;
+import mir.misc.MpRequest;
+import mir.misc.StringUtil;
+import mir.misc.WebdbMultipartRequest;
+import mir.module.ModuleException;
+import mir.servlet.ServletModule;
+import mir.servlet.ServletModuleException;
+import mir.servlet.ServletModuleUserException;
+import mir.storage.Database;
+import mir.storage.StorageObjectException;
+import mircoders.entity.EntityUsers;
+import mircoders.storage.DatabaseMediaType;
+import mircoders.storage.DatabaseMediafolder;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpSession;
+import javax.servlet.ServletContext;
+
+import java.io.IOException;
+import java.net.URLEncoder;
+import java.util.GregorianCalendar;
+import java.util.HashMap;
 
 /*
  *  ServletModuleBilder -
@@ -34,22 +40,22 @@ import mircoders.producer.*;
  */
 
 public abstract class ServletModuleUploadedMedia
-  extends mir.servlet.ServletModule
-{
+        extends mir.servlet.ServletModule {
 
   //private static DatabaseRights dbRights;
 
-  public static ServletModule getInstance() { return null; }
+  public static ServletModule getInstance() {
+    return null;
+  }
 
   public void insert(HttpServletRequest req, HttpServletResponse res)
-    throws ServletModuleException, ServletModuleUserException
-  {
+          throws ServletModuleException, ServletModuleUserException {
     try {
       WebdbMultipartRequest mp = new WebdbMultipartRequest(req);
       HashMap parameters = mp.getParameters();
-      EntityUsers   user = _getUser(req);
-      String mediaId=null;
-      MpRequest mpReq = (MpRequest)mp.requestList.get(0);
+      EntityUsers user = _getUser(req);
+      String mediaId = null;
+      MpRequest mpReq = (MpRequest) mp.requestList.get(0);
       String mediaTypeId; //= null;
       MirMedia mediaHandler;
       Database mediaStorage;
@@ -58,37 +64,49 @@ public abstract class ServletModuleUploadedMedia
       // sends us. (the "Oreilly method")
       String contentType = mpReq.getContentType();
       String fileName = mpReq.getFilename();
-      theLog.printInfo("CONTENT-TYPE FROM BROWSER: "+contentType);
+      theLog.printInfo("CONTENT-TYPE FROM BROWSER: " + contentType);
 
       // if the client browser sent us unknown (text/plain is default)
       // or if we got application/octet-stream, it's possible that
       // the browser is in error, better check against the file extension
       if (contentType.equals("text/plain") ||
-          contentType.equals("application/octet-stream")) {
+              contentType.equals("application/octet-stream")) {
         /**
-         * This is just a temporary way to get the content-type via
-         * the .extension , we could maybe use a magic method, by looking
-         * at the header (first few bytes) of the file. (like the file(1)
-         * command).
-         * The Oreilly method  relies on the content-type that the client
-         * browser sends and that sometimes is application-octet stream with
+         * Fallback to finding the mime-type through the standard ServletApi
+         * ServletContext getMimeType() method.
+         *
+         * This is a way to get the content-type via the .extension,
+         * we could maybe use a magic method as an additional method of
+         * figuring out the content-type, by looking at the header (first
+         * few bytes) of the file. (like the file(1) command). We could 
+         * also call the "file" command through Runtime. This is an
+         * option that I almost prefer as it is already implemented and
+         * exists with an up-to-date map on most modern Unix like systems.
+         * I haven't found a really nice implementation of the magic method
+         * in pure java yet.
+         *
+         * The first method we try thought is the "Oreilly method". It
+         * relies on the content-type that the client browser sends and 
+         * that sometimes is application-octet stream with
          * broken/mis-configured browsers.
          *
-         * The map file should be Mir/content-types.properties, it's the
-         * default Sun Java file with some additional entries that it did
-         * not have. So if you support a new media type you have to make
-         * sure that it is in this file -mh
+         * The map file we use for the extensions is the standard web-app
+         * deployment descriptor file (web.xml). See Mir's web.xml or see
+         * your Servlet containers (most likely Tomcat) documentation.
+         * So if you support a new media type you have to make sure that 
+         * it is in this file -mh
          */
-        contentType = FileUtil.guessContentTypeFromName(fileName);
-        if (contentType==null)
+        ServletContext ctx =
+          (ServletContext)MirConfig.getPropAsObject("ServletContext");
+        contentType = ctx.getMimeType(fileName);
+        if (contentType == null)
           contentType = "text/plain"; // rfc1867 says this is the default
       }
-      theLog.printInfo("CONTENT TYPE IS: "+contentType);
+      theLog.printInfo("CONTENT TYPE IS: " + contentType);
 
       if (contentType.equals("text/plain") ||
-          contentType.equals("application/octet-stream")) {
-        throw new ServletModuleUserException(
-          "One or more files of unrecognized types");
+              contentType.equals("application/octet-stream")) {
+        _throwBadContentType(fileName, contentType);
       }
 
       parameters.put("date", StringUtil.date2webdbDate(new GregorianCalendar()));
@@ -99,31 +117,37 @@ public abstract class ServletModuleUploadedMedia
       // @todo this should probably be moved to DatabaseMediaType or
       // somewhere else appropriate -mh
       String[] contentTypeSplit = StringUtil.split(contentType, "/");
-      String wc = " mime_type LIKE '"+contentTypeSplit[0]+"%'";
+      String wc = " mime_type LIKE '" + contentTypeSplit[0] + "%'";
       DatabaseMediaType mediaTypeStor = DatabaseMediaType.getInstance();
       EntityList mediaTypesList = mediaTypeStor.selectByWhereClause(wc);
 
       // if we didn't find an entry matching the
       // content-type in the table.
       if (mediaTypesList.size() == 0) {
-        theLog.printDebugInfo("Wrong file type uploaded!: " + fileName);
-        throw new MirMediaUserException("One or more files of unrecognized type");
+        _throwBadContentType(fileName, contentType);
       }
       Entity mediaType = null;
-      
+      Entity mediaType2 = null;
+
       // find out if we an exact content-type match if so take it.
-      // otherwise just use the first one.
+      // otherwise try to match majortype/*
       // @todo this should probably be moved to DatabaseMediaType -mh
       for(int j=0;j<mediaTypesList.size();j++) {
         if(contentType.equals(
                         mediaTypesList.elementAt(j).getValue("mime_type")))
           mediaType = mediaTypesList.elementAt(j);
+        else if ((mediaTypesList.elementAt(j).getValue("mime_type")).equals(
+                  contentTypeSplit[0]+"/*"))
+          mediaType2= mediaTypesList.elementAt(j); 
+      }
+
+      if ( (mediaType == null) && (mediaType2 == null) ) {
+        _throwBadContentType(fileName, contentType);
       }
+      else if( (mediaType == null) && (mediaType2 != null) )
+        mediaType = mediaType2;
+
 
-      // if no exact match, whatever foo/* might match
-      if( mediaType == null )
-        mediaType = mediaTypesList.elementAt(0);
-            
       // get the class names from the media_type table.
       mediaTypeId = mediaType.getId();
       try {
@@ -132,18 +156,19 @@ public abstract class ServletModuleUploadedMedia
         // along with media_type
         mediaHandler = MediaHelper.getHandler(mediaType);
         mediaStorage = MediaHelper.getStorage(mediaType,
-                                            "mircoders.storage.Database");
-      } catch (Exception e) {
-        theLog.printError("getting media handler failed: "+e.toString());
+                                              "mircoders.storage.Database");
+      }
+      catch (Exception e) {
+        theLog.printError("getting media handler failed: " + e.toString());
         throw new MirMediaException("getting media handler failed: "
-                                        +e.toString());
+                                    e.toString());
       }
 
-      parameters.put("to_media_type",mediaTypeId);
+      parameters.put("to_media_type", mediaTypeId);
       //load the classes via reflection
       Entity mediaEnt = null;
       try {
-        mediaEnt = (Entity)mediaStorage.getEntityClass().newInstance();
+        mediaEnt = (Entity) mediaStorage.getEntityClass().newInstance();
         mediaEnt.setStorage(mediaStorage);
         mediaEnt.setValues(parameters);
         // unfortunatly we have to insert it first because of the way
@@ -154,168 +179,203 @@ public abstract class ServletModuleUploadedMedia
 
         //were done with mpReq at this point, dereference it.
         //as it contains mucho mem. -mh 01.10.2001
-        mpReq=null;
-        
+        mpReq = null;
+
         //we got this far, associate the media to the article
-        mediaEnt.setValueForProperty("is_published","1");
+        mediaEnt.setValueForProperty("is_published", "1");
         mediaEnt.update();
-      } catch (Exception e) {
+      }
+      catch (Exception e) {
         try {
           mediaStorage.delete(mediaId);
-        } catch (Exception e2) {
+        }
+        catch (Exception e2) {
           // dont't do anything here as the error was setting the media,
           // this just means that the entity may not have been inserted yet
         }
-        theLog.printError("setting media failed: "+e.toString());
-        throw new MirMediaException("setting media failed: "+e.toString());
+        theLog.printError("setting media failed: " + e.toString());
+        throw new MirMediaException("setting media failed: " + e.toString());
       }
 
       _edit(mediaId, req, res);
     }
-    catch (MirMediaException e) { throw new ServletModuleException(
-                          "upload -- media handling exception " +e.toString());}
-    catch (MirMediaUserException e) { throw new ServletModuleUserException(
-                                                  e.getMsg());}
-    catch (IOException e) { throw new ServletModuleException("upload -- ioexception " + e.toString());}
-    catch (StorageObjectException e) { throw new ServletModuleException("StorageObjectException" + e.toString());}
+    catch (MirMediaException e) {
+      throw new ServletModuleException(
+              "upload -- media handling exception " + e.toString());
+    }
+    catch (IOException e) {
+      throw new ServletModuleException("upload -- ioexception " + e.toString());
+    }
+    catch (StorageObjectException e) {
+      throw new ServletModuleException("StorageObjectException" + e.toString());
+    }
 
   }
 
-  public void update(HttpServletRequest req, HttpServletResponse res) throws ServletModuleException
-  {
+  private void _throwBadContentType (String fileName, String contentType)
+    throws ServletModuleUserException {
+
+    theLog.printDebugInfo("Wrong file type uploaded!: " + fileName+" "
+                          +contentType);
+    throw new ServletModuleUserException("The file you uploaded is of the "
+        +"following mime-type: "+contentType
+        +", we do not support this mime-type. "
+        +"Error One or more files of unrecognized type. Sorry");
+  }
+
+  public void update(HttpServletRequest req, HttpServletResponse res) throws ServletModuleException {
 
     try {
       WebdbMultipartRequest mp = new WebdbMultipartRequest(req);
       HashMap parameters = mp.getParameters();
 
-      EntityUsers   user = _getUser(req);
+      EntityUsers user = _getUser(req);
       parameters.put("to_publisher", user.getId());
       parameters.put("is_produced", "0");
       if (!parameters.containsKey("is_published"))
-        parameters.put("is_published","0");
+        parameters.put("is_published", "0");
 
       String id = mainModule.set(parameters);
-      theLog.printError("media ID"+id);
+      theLog.printError("media ID" + id);
       _edit(id, req, res);
     }
-    catch (IOException e) { throw new ServletModuleException("upload -- ioexception " + e.toString());}
-    catch (ModuleException e) { throw new ServletModuleException("upload -- moduleexception " + e.toString());}
+    catch (IOException e) {
+      throw new ServletModuleException("upload -- ioexception " + e.toString());
+    }
+    catch (ModuleException e) {
+      throw new ServletModuleException("upload -- moduleexception " + e.toString());
+    }
 
   }
 
 
   public void list(HttpServletRequest req, HttpServletResponse res)
-  throws ServletModuleException {
-      // Parameter auswerten
-      SimpleHash mergeData = new SimpleHash();
-      String query_text = req.getParameter("query_text");
-      mergeData.put("query_text",query_text);
-      if (query_text!=null) mergeData.put("query_text_encoded",URLEncoder.encode(query_text));
-      String query_field = req.getParameter("query_field");
-      mergeData.put("query_field",query_field);
-      String query_is_published = req.getParameter("query_is_published");
-      mergeData.put("query_is_published",query_is_published);
-      String query_media_folder = req.getParameter("query_media_folder");
-      mergeData.put("query_media_folder",query_media_folder);
-      String offset = req.getParameter("offset");
-      if (offset==null || offset.equals("")) offset="0";
-      mergeData.put("offset",offset);
-
-      String order = req.getParameter("order");
-      if (order==null) order="webdb_lastchange desc";
-
-      // if in connection mode to content
-      String cid = req.getParameter("cid");
-      mergeData.put("cid",cid);
-
-
-      // sql basteln
-      String whereClause=""; boolean isFirst=true;
-      if (query_text!=null && !query_text.equalsIgnoreCase("")) {
-        whereClause += "lower("+query_field+") like lower('%"+query_text+"%')"; isFirst=false;}
-      if (query_is_published != null && !query_is_published.equals("")) {
-        if (isFirst==false) whereClause+=" and ";
-        whereClause += "is_published='"+query_is_published+"'";
-        isFirst=false;
-      }
-      if (query_media_folder != null && !query_media_folder.equals("")) {
-        if (isFirst==false) whereClause+=" and ";
-        whereClause += "to_media_folder='"+query_media_folder+"'";
-      }
-      //theLog.printDebugInfo("sql-whereclause: " + whereClause + " order: " + order + " offset: " + offset);
+          throws ServletModuleException {
+    // Parameter auswerten
+    SimpleHash mergeData = new SimpleHash();
+    SimpleHash popups = new SimpleHash();
+
+    String query_text = req.getParameter("query_text");
+    mergeData.put("query_text", query_text);
+    if (query_text != null) mergeData.put("query_text_encoded", URLEncoder.encode(query_text));
+    String query_field = req.getParameter("query_field");
+    mergeData.put("query_field", query_field);
+    String query_is_published = req.getParameter("query_is_published");
+    mergeData.put("query_is_published", query_is_published);
+    String query_media_folder = req.getParameter("query_media_folder");
+    mergeData.put("query_media_folder", query_media_folder);
+    String offset = req.getParameter("offset");
+    if (offset == null || offset.equals("")) offset = "0";
+    mergeData.put("offset", offset);
+
+    String order = req.getParameter("order");
+    if (order == null) order = "webdb_lastchange desc";
+
+    // if in connection mode to content
+    String cid = req.getParameter("cid");
+    mergeData.put("cid", cid);
+
+
+    // sql basteln
+    String whereClause = "";
+    boolean isFirst = true;
+    if (query_text != null && !query_text.equalsIgnoreCase("")) {
+      whereClause += "lower(" + query_field + ") like lower('%" + query_text + "%')";
+      isFirst = false;
+    }
+    if (query_is_published != null && !query_is_published.equals("")) {
+      if (isFirst == false) whereClause += " and ";
+      whereClause += "is_published='" + query_is_published + "'";
+      isFirst = false;
+    }
+    if (query_media_folder != null && !query_media_folder.equals("")) {
+      if (isFirst == false) whereClause += " and ";
+      whereClause += "to_media_folder='" + query_media_folder + "'";
+    }
+    //theLog.printDebugInfo("sql-whereclause: " + whereClause + " order: " + order + " offset: " + offset);
 
-      // fetch und ausliefern
-      try {
-        if (query_text!=null || query_is_published!=null || query_media_folder!=null) {
-          EntityList theList = mainModule.getByWhereClause(whereClause, order, (new Integer(offset)).intValue(),10);
-          if (theList != null) {
-            mergeData.put("contentlist",theList);
-            if(theList.getOrder()!=null) {
-              mergeData.put("order", theList.getOrder());
-              mergeData.put("order_encoded", URLEncoder.encode(theList.getOrder()));
-            }
-            mergeData.put("count", (new Integer(theList.getCount())).toString());
-            mergeData.put("from", (new Integer(theList.getFrom())).toString());
-            mergeData.put("to", (new Integer(theList.getTo())).toString());
-            if (theList.hasNextBatch())
-              mergeData.put("next", (new Integer(theList.getNextBatch())).toString());
-            if (theList.hasPrevBatch())
-              mergeData.put("prev", (new Integer(theList.getPrevBatch())).toString());
+    // fetch und ausliefern
+    try {
+      if (query_text != null || query_is_published != null || query_media_folder != null) {
+        EntityList theList = mainModule.getByWhereClause(whereClause, order, (new Integer(offset)).intValue(), 10);
+        if (theList != null) {
+          mergeData.put("contentlist", theList);
+          if (theList.getOrder() != null) {
+            mergeData.put("order", theList.getOrder());
+            mergeData.put("order_encoded", URLEncoder.encode(theList.getOrder()));
           }
+          mergeData.put("count", (new Integer(theList.getCount())).toString());
+          mergeData.put("from", (new Integer(theList.getFrom())).toString());
+          mergeData.put("to", (new Integer(theList.getTo())).toString());
+          if (theList.hasNextBatch())
+            mergeData.put("next", (new Integer(theList.getNextBatch())).toString());
+          if (theList.hasPrevBatch())
+            mergeData.put("prev", (new Integer(theList.getPrevBatch())).toString());
         }
-        // raus damit
-        HTMLTemplateProcessor.process(res, templateListString, mergeData, res.getWriter(), getLocale(req));
       }
-      catch (ModuleException e) {throw new ServletModuleException(e.toString());}
-      catch (IOException e) {throw new ServletModuleException(e.toString());}
-      catch (Exception e) {throw new ServletModuleException(e.toString());}
+      //fetch the popups
+      popups.put("mediafolderPopupData", DatabaseMediafolder.getInstance().getPopupData());
+      // raus damit
+      deliver(req, res, mergeData, popups, templateListString);
+    }
+    catch (ModuleException e) {
+      throw new ServletModuleException(e.toString());
+    }
+    catch (Exception e) {
+      throw new ServletModuleException(e.toString());
+    }
   }
 
 
   public void add(HttpServletRequest req, HttpServletResponse res)
-  throws ServletModuleException
-  {
+          throws ServletModuleException {
     try {
       SimpleHash mergeData = new SimpleHash();
       mergeData.put("new", "1");
-                       SimpleHash popups = new SimpleHash();
-                       popups.put("mediafolderPopupData",DatabaseMediafolder.getInstance().getPopupData());
+      SimpleHash popups = new SimpleHash();
+      popups.put("mediafolderPopupData", DatabaseMediafolder.getInstance().getPopupData());
       deliver(req, res, mergeData, popups, templateObjektString);
     }
-    catch (Exception e) { throw new ServletModuleException(e.toString());}
+    catch (Exception e) {
+      throw new ServletModuleException(e.toString());
+    }
   }
 
   public void edit(HttpServletRequest req, HttpServletResponse res)
-       throws ServletModuleException {
+          throws ServletModuleException {
     String idParam = req.getParameter("id");
     _edit(idParam, req, res);
   }
 
   private void _edit(String idParam, HttpServletRequest req, HttpServletResponse res)
-       throws ServletModuleException {
-    if (idParam!=null && !idParam.equals("")) {
+          throws ServletModuleException {
+    if (idParam != null && !idParam.equals("")) {
       try {
-                               SimpleHash popups = new SimpleHash();
-                               popups.put("mediafolderPopupData",DatabaseMediafolder.getInstance().getPopupData());
-        deliver(req, res, mainModule.getById(idParam),popups,
-                                                               templateObjektString);
-      } catch (ModuleException e) {
-                               throw new ServletModuleException(e.toString());
-                       } catch (StorageObjectException e) {
-                               throw new ServletModuleException(e.toString());
-                       }
-    } else {
-                       throw new ServletModuleException("ServletmoduleUploadedMedia :: _edit without id");
-               }
+        SimpleHash popups = new SimpleHash();
+        popups.put("mediafolderPopupData", DatabaseMediafolder.getInstance().getPopupData());
+        deliver(req, res, mainModule.getById(idParam), popups,
+                templateObjektString);
+      }
+      catch (ModuleException e) {
+        throw new ServletModuleException(e.toString());
+      }
+      catch (StorageObjectException e) {
+        throw new ServletModuleException(e.toString());
+      }
+    }
+    else {
+      throw new ServletModuleException("ServletmoduleUploadedMedia :: _edit without id");
+    }
   }
 
 
   /** @todo should be in ServletModule.java */
-  private EntityUsers _getUser(HttpServletRequest req)
-  {
-    HttpSession session=req.getSession(false);
-    return (EntityUsers)session.getAttribute("login.uid");
+  private EntityUsers _getUser(HttpServletRequest req) {
+    HttpSession session = req.getSession(false);
+    return (EntityUsers) session.getAttribute("login.uid");
   }
 
 }
 
+