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