source/mircoders/servlet/ServletModuleUploadedMedia.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 mir.config.MirPropertiesConfiguration;
  34 import mir.entity.Entity;
  35 import mir.entity.adapter.EntityAdapter;
  36 import mir.entity.adapter.EntityAdapterEngine;
  37 import mir.media.MediaHandler;
  38 import mir.servlet.AdminServletModule;
  39 import mir.servlet.ServletModuleExc;
  40 import mir.servlet.ServletModuleFailure;
  41 import mir.servlet.ServletModuleUserExc;
  42 import mir.session.UploadedFile;
  43 import mir.session.CommonsUploadedFileAdapter;
  44 import mir.util.ExceptionRoutines;
  45 import mir.util.HTTPParsedRequest;
  46 import mir.util.HTTPRequestParser;
  47 import mir.util.JDBCStringRoutines;
  48 import mir.util.SQLQueryBuilder;
  49 import mir.util.URLBuilder;
  50 import mircoders.entity.EntityComment;
  51 import mircoders.entity.EntityContent;
  52 import mircoders.entity.EntityUploadedMedia;
  53 import mircoders.media.MediaHelper;
  54 import mircoders.media.MediaUploadProcessor;
  55 import mircoders.media.UnsupportedMediaTypeExc;
  56 import mircoders.storage.DatabaseComment;
  57 import mircoders.storage.DatabaseContent;
  58 import org.apache.commons.fileupload.FileItem;
  59
  60 import javax.servlet.ServletContext;
  61 import javax.servlet.ServletOutputStream;
  62 import javax.servlet.http.HttpServletRequest;
  63 import javax.servlet.http.HttpServletResponse;
  64 import java.io.InputStream;
  65 import java.util.ArrayList;
  66 import java.util.HashMap;
  67 import java.util.Iterator;
  68 import java.util.List;
  69 import java.util.Locale;
  70 import java.util.Map;
  71
  72 public abstract class ServletModuleUploadedMedia extends AdminServletModule {
  73   private String moduleName;
  74
  75   protected ServletModuleUploadedMedia(String aModuleName) {
  76     moduleName = aModuleName;
  77     definition = "uploadedMedia";
  78   }
  79
  80   public void insert(HttpServletRequest aRequest, HttpServletResponse aResponse)
  81           throws ServletModuleExc, ServletModuleUserExc {
  82
  83     try {
  84       HTTPParsedRequest parsedRequest = new HTTPParsedRequest(aRequest,
  85           getConfiguration().getString("Mir.DefaultEncoding"),
  86           getConfiguration().getInt("MaxMediaUploadSize")*1024,
  87           getConfiguration().getString("TempDir"));
  88
  89       Map mediaValues = new HashMap();
  90
  91       mediaValues.put("to_publisher", ServletHelper.getUser(aRequest).getId());
  92
  93       Iterator i = mainModule.getStorageObject().getFieldNames().iterator();
  94       while (i.hasNext()) {
  95         String field = (String) i.next();
  96         String value = parsedRequest.getParameter(field);
  97         if (value!=null)
  98           mediaValues.put(field, value);
  99       }
 100
 101       List mediaList = new ArrayList();
 102
 103       i = parsedRequest.getFiles().iterator();
 104       while (i.hasNext()) {
 105         UploadedFile file = new CommonsUploadedFileAdapter((FileItem) i.next());
 106
 107         String suffix = file.getFieldName().substring(5);
 108         mediaValues.put("title", parsedRequest.getParameter("media_title" + suffix));
 109
 110         mediaList.add(MediaUploadProcessor.processMediaUpload(file, mediaValues));
 111       }
 112
 113       String articleid = parsedRequest.getParameter("articleid");
 114       String commentid = parsedRequest.getParameter("commentid");
 115
 116       if (articleid!=null) {
 117         EntityContent entContent = (EntityContent)
 118             DatabaseContent.getInstance().selectById(articleid);
 119
 120         i = mediaList.iterator();
 121
 122         while (i.hasNext()) {
 123           String id = ((Entity) i.next()).getId();
 124
 125           entContent.attach(id);
 126           logAdminUsage(aRequest, id, "object attached to article " + articleid);
 127         }
 128
 129         ServletHelper.redirect(aResponse, "module=content&do=edit&id=" + articleid);
 130
 131         return;
 132       }
 133
 134       if (commentid!=null) {
 135         EntityComment comment = (EntityComment) DatabaseComment.getInstance().selectById(commentid);
 136
 137         i=mediaList.iterator();
 138
 139         while (i.hasNext()) {
 140           String id = ((EntityUploadedMedia) i.next()).getId();
 141
 142           comment.attach(id);
 143
 144           logAdminUsage(aRequest, id, "object attached to comment " + commentid);
 145         }
 146
 147         ServletHelper.redirect(aResponse, "module=comment&do=edit&id=" + commentid);
 148
 149         return;
 150       }
 151
 152       logAdminUsage(aRequest, "", mediaList.size() + " objects added");
 153
 154       returnUploadedMediaList(aRequest, aResponse, mediaList, 1, mediaList.size(), "", null, null);
 155     }
 156     catch (Throwable t) {
 157       Throwable cause = ExceptionRoutines.traceCauseException(t);
 158
 159       if (cause instanceof UnsupportedMediaTypeExc) {
 160         throw new ServletModuleUserExc("media.error.unsupportedformat", new String[] {});
 161       }
 162       throw new ServletModuleFailure("ServletModuleUploadedMedia.insert: " + t.toString(), t);
 163     }
 164   }
 165
 166   public void update(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 167
 168     try {
 169       HTTPParsedRequest parsedRequest = new HTTPParsedRequest(aRequest,
 170           getConfiguration().getString("Mir.DefaultEncoding"),
 171           getConfiguration().getInt("MaxMediaUploadSize")*1024,
 172           getConfiguration().getString("TempDir"));
 173
 174       Map mediaValues = new HashMap();
 175
 176       Iterator i = mainModule.getStorageObject().getFieldNames().iterator();
 177       while (i.hasNext()) {
 178         String field = (String) i.next();
 179         String value = parsedRequest.getParameter(field);
 180         if (value!=null) {
 181           mediaValues.put(field, value);
 182         }
 183       }
 184
 185       mediaValues.put("to_publisher", ServletHelper.getUser(aRequest).getId());
 186       mediaValues.put("is_produced", "0");
 187       if (!mediaValues.containsKey("is_published")) {
 188         mediaValues.put("is_published", "0");
 189       }
 190
 191       String id = mainModule.set(mediaValues);
 192       getLogger().debug("update: media ID = " + id);
 193       logAdminUsage(aRequest, id, "object modified");
 194
 195       editUploadedMediaObject(id, aRequest, aResponse);
 196     }
 197     catch (Throwable e) {
 198       throw new ServletModuleFailure("upload -- exception " + e.toString(), e);
 199     }
 200
 201   }
 202
 203   public void returnUploadedMediaList(HttpServletRequest aRequest, HttpServletResponse aResponse,
 204                                       Object aList, int aFrom, int aTo,
 205                                       String aThisUrl, String aNextUrl, String aPreviousUrl) throws ServletModuleExc {
 206
 207     try {
 208       HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 209       Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale(aRequest)});
 210
 211       responseData.put("searchfield", requestParser.getParameterWithDefault("searchfield", ""));
 212       responseData.put("searchtext", requestParser.getParameterWithDefault("searchtext", ""));
 213       responseData.put("searchispublished", requestParser.getParameterWithDefault("searchispublished", ""));
 214       responseData.put("searchmediafolder", requestParser.getParameterWithDefault("searchmediafolder", ""));
 215       responseData.put("articleid", requestParser.getParameter("articleid"));
 216       responseData.put("commentid", requestParser.getParameter("commentid"));
 217
 218       responseData.put("thisurl", aThisUrl);
 219       responseData.put("nexturl", aNextUrl);
 220       responseData.put("prevurl", aPreviousUrl);
 221       responseData.put("returnurl", requestParser.getParameter("returnurl"));
 222
 223
 224       responseData.put("from", Integer.toString(aFrom));
 225       responseData.put("to", Integer.toString(aTo));
 226
 227       responseData.put("medialist", aList);
 228
 229       addExtraData(responseData);
 230       ServletHelper.generateResponse(aResponse.getWriter(), responseData, listGenerator);
 231     }
 232     catch (Throwable t) {
 233       throw new ServletModuleFailure(t);
 234     }
 235   }
 236
 237   public void returnUploadedMediaList(HttpServletRequest aRequest, HttpServletResponse aResponse,
 238                                       String aWhereClause, String anOrderByClause, int anOffset) throws ServletModuleExc {
 239
 240     HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 241     URLBuilder urlBuilder = new URLBuilder();
 242     String nextPageUrl = null;
 243     String previousPageUrl = null;
 244     String thisUrl = null;
 245
 246     try {
 247       List list =
 248          EntityAdapterEngine.retrieveAdapterList(getModel(), definition, aWhereClause, anOrderByClause, nrEntitiesPerListPage, anOffset);
 249
 250       urlBuilder.setValue("module", moduleName);
 251       urlBuilder.setValue("do", "list");
 252       urlBuilder.setValue("where", aWhereClause);
 253       urlBuilder.setValue("order", anOrderByClause);
 254
 255       urlBuilder.setValue("articleid", requestParser.getParameter("articleid"));
 256       urlBuilder.setValue("commentid", requestParser.getParameter("commentid"));
 257       urlBuilder.setValue("searchfield", requestParser.getParameter("searchfield"));
 258       urlBuilder.setValue("searchtext", requestParser.getParameter("searchtext"));
 259       urlBuilder.setValue("searchispublished", requestParser.getParameter("searchispublished"));
 260       urlBuilder.setValue("searchmediafolder", requestParser.getParameter("searchmediafolder"));
 261       urlBuilder.setValue("returnurl", requestParser.getParameter("returnurl"));
 262       urlBuilder.setValue("where", aWhereClause);
 263       urlBuilder.setValue("order", anOrderByClause);
 264
 265       urlBuilder.setValue("offset", anOffset);
 266       thisUrl = urlBuilder.getQuery();
 267
 268       if (list.size() >= nrEntitiesPerListPage) {
 269         urlBuilder.setValue("offset", anOffset + nrEntitiesPerListPage);
 270         nextPageUrl = urlBuilder.getQuery();
 271       }
 272
 273       if (anOffset > 0) {
 274         urlBuilder.setValue("offset", Math.max(anOffset - nrEntitiesPerListPage, 0));
 275         previousPageUrl = urlBuilder.getQuery();
 276       }
 277
 278       returnUploadedMediaList(aRequest, aResponse, list,
 279               anOffset+1, anOffset+nrEntitiesPerListPage, thisUrl,
 280               nextPageUrl, previousPageUrl);
 281     }
 282     catch (Throwable e) {
 283       throw new ServletModuleFailure(e);
 284     }
 285   }
 286
 287   public void search(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 288     HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 289
 290     SQLQueryBuilder queryBuilder = new SQLQueryBuilder();
 291
 292     String searchField = requestParser.getParameter("searchfield");
 293     String searchText = requestParser.getParameter("searchtext");
 294     String searchIsPublished = requestParser.getParameter("searchispublished");
 295     String searchMediaFolder = requestParser.getParameter("searchmediafolder");
 296
 297     queryBuilder.appendDescendingOrder("webdb_create");
 298
 299     if (searchIsPublished!=null)
 300       if (searchIsPublished.equals("0")) {
 301         queryBuilder.appendAndCondition("is_published='f'");
 302       }
 303       else if (searchIsPublished.equals("1")) {
 304         queryBuilder.appendAndCondition("is_published='t'");
 305       }
 306
 307     if (searchField!=null && searchText!=null && searchText.length()>0) {
 308         queryBuilder.appendAndCondition(
 309           "lower(" + searchField + ") like " +
 310           "'%" + JDBCStringRoutines.escapeStringLiteral(searchText.toLowerCase()) + "%'");
 311     }
 312
 313     if (searchMediaFolder!=null && searchMediaFolder.length()>0) {
 314       queryBuilder.appendAndCondition("to_media_folder="+Integer.parseInt(searchMediaFolder));
 315     }
 316
 317     returnUploadedMediaList(aRequest, aResponse,
 318             queryBuilder.getWhereClause(), queryBuilder.getOrderByClause(), requestParser.getIntegerWithDefault("offset", 0));
 319   }
 320
 321   public void list(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 322     HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 323
 324     returnUploadedMediaList(aRequest, aResponse,
 325        requestParser.getParameterWithDefault("where", ""),
 326        requestParser.getParameterWithDefault("order", "webdb_create desc"),
 327        requestParser.getIntegerWithDefault("offset", 0));
 328   }
 329
 330
 331   public void add(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 332     try {
 333       HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 334       Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale(aRequest)});
 335
 336       int nrMedia = requestParser.getIntegerWithDefault("nrmedia", 1);
 337       int maxNrMedia = getConfiguration().getInt("ServletModule.OpenIndy.MaxMediaUploadItems", 20);
 338
 339       List fields = mainModule.getStorageObject().getFieldNames();
 340       Map media = new HashMap();
 341       Iterator i = fields.iterator();
 342       while (i.hasNext()) {
 343         media.put(i.next(), null);
 344       }
 345       media.put("to_media_folder", new Integer(7));
 346       responseData.put("uploadedmedia", media);
 347
 348       responseData.put("new", Boolean.TRUE);
 349       responseData.put("articleid", requestParser.getParameter("articleid"));
 350       responseData.put("commentid", requestParser.getParameter("commentid"));
 351       responseData.put("returnurl", requestParser.getParameter("returnurl"));
 352
 353       if (nrMedia<=0)
 354         nrMedia=1;
 355       if (nrMedia>maxNrMedia)
 356         nrMedia=maxNrMedia;
 357
 358       List mediaFields = new ArrayList();
 359       for (int j=0; j<nrMedia; j++)
 360         mediaFields.add(new Integer(j));
 361
 362       responseData.put("nrmedia", new Integer(nrMedia));
 363       responseData.put("mediafields", mediaFields);
 364
 365       responseData.put("edittemplate", editGenerator);
 366       responseData.put("module", moduleName);
 367
 368       addExtraData(responseData);
 369
 370       ServletHelper.generateResponse(aResponse.getWriter(), responseData, "uploadedmedia.template");
 371     }
 372     catch (Exception e) {
 373       throw new ServletModuleFailure(e);
 374     }
 375   }
 376
 377   public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 378     editUploadedMediaObject(aRequest.getParameter("id"), aRequest, aResponse);
 379   }
 380
 381   private void editUploadedMediaObject(String idParam, HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 382     if (idParam != null && !"".equals(idParam)) {
 383       try {
 384         Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale(aRequest)});
 385         EntityAdapter object =
 386             getModel().makeEntityAdapter(definition, mainModule.getById(idParam));
 387         HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
 388         responseData.put("uploadedmedia", object);
 389         responseData.put("new", Boolean.FALSE);
 390         responseData.put("articleid", null);
 391         responseData.put("commentid", null);
 392         responseData.put("returnurl", requestParser.getParameter("returnurl"));
 393         responseData.put("thisurl", null);
 394
 395         responseData.put("edittemplate", editGenerator);
 396         responseData.put("module", moduleName);
 397
 398         addExtraData(responseData);
 399
 400         ServletHelper.generateResponse(aResponse.getWriter(), responseData, "uploadedmedia.template");
 401       }
 402       catch (Throwable e) {
 403         throw new ServletModuleFailure(e);
 404       }
 405     }
 406     else {
 407       throw new ServletModuleExc("ServletmoduleUploadedMedia :: editUploadedMediaObject without id");
 408     }
 409   }
 410
 411   public void getMedia(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 412     String idParam = aRequest.getParameter("id");
 413
 414     if (idParam!=null && !idParam.equals("")) {
 415       try {
 416         EntityUploadedMedia entity = (EntityUploadedMedia) mainModule.getById(idParam);
 417         Entity mediaType = entity.getMediaType();
 418         MediaHandler mediaHandler;
 419
 420         ServletContext ctx = MirPropertiesConfiguration.getContext();
 421         String fName = entity.getId()+"."+mediaType.getFieldValue("name");
 422
 423         mediaHandler = MediaHelper.getHandler(mediaType);
 424         InputStream in = mediaHandler.getMedia(entity, mediaType);
 425
 426         aResponse.setContentType(ctx.getMimeType(fName));
 427         //important that before calling this aResponse.getWriter was not called first
 428         ServletOutputStream out = aResponse.getOutputStream();
 429
 430         int read ;
 431         byte[] buf = new byte[8 * 1024];
 432         while((read = in.read(buf)) != -1) {
 433           out.write(buf, 0, read);
 434         }
 435         in.close();
 436         out.close();
 437       }
 438       catch (Throwable e) {
 439         throw new ServletModuleFailure(e);
 440       }
 441     }
 442     else {
 443       getLogger().error("id not specified.");
 444     }
 445     // no exception allowed
 446   }
 447
 448
 449   /**
 450    * @param aRequest
 451    * @param aResponse
 452    * @throws ServletModuleExc
 453    */
 454   public void getIcon(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 455     getThumbnail(aRequest, aResponse);
 456   }
 457
 458   public void getThumbnail(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 459     String id = aRequest.getParameter("id");
 460
 461     if (id!=null && !id.equals("")) {
 462       try {
 463         EntityUploadedMedia mediaEntity = (EntityUploadedMedia) mainModule.getById(id);
 464         Entity mediaType = mediaEntity.getMediaType();
 465         MediaHandler mediaHandler;
 466
 467         mediaHandler = MediaHelper.getHandler(mediaType);
 468         InputStream thumbnailInputStream = mediaHandler.getThumbnail(mediaEntity);
 469
 470         if (thumbnailInputStream==null)
 471           throw new ServletModuleExc("no icon available");
 472
 473         aResponse.setContentType(mediaHandler.getThumbnailMimeType(mediaEntity, mediaType));
 474
 475         ServletOutputStream out = aResponse.getOutputStream();
 476         try {
 477           int read;
 478           byte[] buf = new byte[8 * 1024];
 479
 480           while ((read = thumbnailInputStream.read(buf)) != -1) {
 481             out.write(buf, 0, read);
 482           }
 483
 484           thumbnailInputStream.close();
 485         }
 486         finally {
 487           out.close();
 488         }
 489       }
 490       catch (Throwable e) {
 491         getLogger().error("getIcon: " + e.toString());
 492       }
 493     }
 494     else {
 495       getLogger().error("getIcon: id not specified.");
 496     }
 497   }
 498
 499   protected void addExtraData(Map aTarget) throws ServletModuleExc, ServletModuleFailure {
 500     try {
 501       aTarget.put("mediafolders",
 502           EntityAdapterEngine.retrieveAdapterList(getModel(), "mediaFolder", "", "", -1, 0));
 503     }
 504     catch (Throwable t) {
 505       throw new ServletModuleFailure(t);
 506     }
 507   }
 508
 509   public void showarticles(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 510     String idParam = aRequest.getParameter("id");
 511     if (idParam!=null && !idParam.equals("")) {
 512       try {
 513         // TODO rewrite as relational sql
 514         ServletHelper.getServletModuleContent().returnList(
 515             aRequest,
 516             aResponse,
 517             "exists (select * from content_x_media where content_id=content.id and media_id='" +
 518                   JDBCStringRoutines.escapeStringLiteral( idParam ) + "')", "", 0);
 519       }
 520       catch (Throwable t) {
 521         throw new ServletModuleFailure(t);
 522       }
 523     }
 524     else {
 525       getLogger().error("showarticles: id not specified.");
 526     }
 527   }
 528
 529   public void showcomments(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
 530   {
 531     String idParam = aRequest.getParameter("id");
 532     if (idParam!=null && !idParam.equals("")) {
 533       try {
 534         // TODO rewrite as relational sql
 535         ServletHelper.getServletModuleComment().returnList(
 536             aRequest,
 537             aResponse,
 538             "exists (select * from comment_x_media where comment_id=comment.id and media_id='" + JDBCStringRoutines.escapeStringLiteral( idParam ) + "')", "", 0);
 539       }
 540       catch (Throwable t) {
 541         throw new ServletModuleFailure(t);
 542       }
 543     }
 544     else {
 545       getLogger().error("showcomments: id not specified.");
 546     }
 547   }
 548 }