source/mircoders/media/MediaHandlerGeneric.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 package  mircoders.media;
  31
  32 import java.io.BufferedInputStream;
  33 import java.io.File;
  34 import java.io.FileInputStream;
  35 import java.io.InputStream;
  36
  37 import javax.servlet.ServletContext;
  38
  39 import mir.config.MirPropertiesConfiguration;
  40 import mir.entity.Entity;
  41 import mir.log.LoggerWrapper;
  42 import mir.media.MediaExc;
  43 import mir.media.MediaFailure;
  44 import mir.misc.StringUtil;
  45 import mir.session.UploadedFile;
  46 import mir.util.FileFunctions;
  47
  48
  49 /**
  50  * This is the Generic MediaHandler. It stores the media data on
  51  * the filesystem and keeps basic metadata  (size, type...) in the
  52  * DB. Usually only representation needs to be overridden.
  53  * See the MediaHandlerAudio class to see an example of how one
  54  * could override it.
  55  * <p>
  56  * Most media handlers should override this class.
  57  * <p>
  58  * In theory, it could be used to handle miscellaneous media that
  59  * we don't have entered in the media_type table, (like RTF documents,
  60  * PS, PDF, etc..)
  61  * <p>
  62  * Of course it implements the MirMediaHandler interface.
  63  *
  64  * @see mir.media.MediaHandler
  65  * @author mh <mh@nadir.org>
  66  * @version $Id: MediaHandlerGeneric.java,v 1.20.2.8 2005/02/10 16:22:23 rhindes Exp $
  67  */
  68
  69 public class MediaHandlerGeneric extends AbstractMediaHandler
  70 {
  71   protected static MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
  72
  73   protected LoggerWrapper logger = new LoggerWrapper("Media.Generic");
  74
  75   /** {@inheritDoc} */
  76   public void store(File aFile, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
  77     try {
  78       FileFunctions.move(aFile, getStorageFile(aMedia, aMediaType));
  79
  80       aMedia.setFieldValue("publish_path", getRelativeStorageFile(aMedia, aMediaType));
  81       aMedia.setFieldValue("size", Long.toString(getStorageFile(aMedia, aMediaType).length()));
  82       aMedia.update();
  83     }
  84     catch (Throwable e) {
  85       logger.error("MediaHandlerGeneric.set: " + e.toString());
  86       throw new MediaFailure(e);
  87     }
  88   }
  89
  90   /** {@inheritDoc} */
  91   public void store(UploadedFile anUploadedFile, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
  92     try {
  93       anUploadedFile.writeToFile(getStorageFile(aMedia, aMediaType));
  94
  95       aMedia.setFieldValue("publish_path", getRelativeStorageFile(aMedia, aMediaType));
  96       aMedia.setFieldValue("size", Long.toString(getStorageFile(aMedia, aMediaType).length()));
  97       aMedia.update();
  98     }
  99     catch (Throwable e) {
 100       logger.error("MediaHandlerGeneric.set: " + e.toString());
 101       throw new MediaFailure(e);
 102     }
 103   }
 104
 105   /** {@inheritDoc} */
 106   public void store(InputStream anInputStream, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
 107     try {
 108       FileFunctions.copy(anInputStream, getStorageFile(aMedia, aMediaType));
 109
 110       aMedia.setFieldValue("publish_path", getRelativeStorageFile(aMedia, aMediaType));
 111       aMedia.setFieldValue("size", Long.toString(getStorageFile(aMedia, aMediaType).length()));
 112       aMedia.update();
 113     }
 114     catch (Throwable e) {
 115       logger.error("MediaHandlerGeneric.set: " + e.toString());
 116       throw new MediaFailure(e);
 117     }
 118   }
 119
 120   public void produce(Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
 121     if (!getStorageFile(aMedia, aMediaType).exists())
 122       throw new MediaExc("error in producing media:: " + getStorageFile(aMedia, aMediaType) + " does not exist!");
 123   }
 124
 125   /**
 126    * Get access to the raw media data by an {@link InputStream}
 127    */
 128   public InputStream getMedia(Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
 129     File file = getStorageFile(aMedia, aMediaType);
 130     if (!file.exists())
 131       throw new MediaExc("error in MirMediaHandler.getMedia(): " + file + " does not exist!");
 132
 133     try {
 134       return new BufferedInputStream(new FileInputStream(file));
 135     }
 136     catch (Throwable e) {
 137       throw new MediaFailure("MediaHandlerGeneric.getMedia(): " + e.toString(), e);
 138     }
 139   }
 140
 141   public InputStream getThumbnail(Entity ent) throws MediaExc, MediaFailure {
 142     return null;
 143   }
 144
 145   public String getThumbnailMimeType(Entity aMediaEntity, Entity aMediaType) throws MediaExc, MediaFailure {
 146     ServletContext servletContext = MirPropertiesConfiguration.getContext();
 147     String fileName = aMediaEntity.getId() + "." + aMediaType.getFieldValue("name");
 148
 149     return servletContext.getMimeType(fileName);
 150   }
 151
 152   public String getStoragePath() {
 153     return configuration.getString("Producer.Media.Path");
 154   }
 155
 156   public String getIconStoragePath() {
 157     return configuration.getString("Producer.Image.IconPath");
 158   }
 159
 160   public String getPublishHost() {
 161     return StringUtil.removeSlash(configuration.getString("Producer.Media.Host"));
 162   }
 163
 164   public String getTinyIconName() {
 165     return configuration.getString("Producer.Icon.TinyText");
 166   }
 167
 168   public String getBigIconName() {
 169     return configuration.getString("Producer.Icon.BigText");
 170   }
 171
 172   public String getIconAltName() {
 173     return "Generic media";
 174   }
 175
 176   public String getDescr(Entity mediaType) {
 177     return mediaType.getFieldValue("mime_type");
 178   }
 179
 180 }
 181
 182
 183