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