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