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 import java.util.List;
  37 import java.util.Vector;
  38
  39 import javax.servlet.ServletContext;
  40
  41 import mir.config.MirPropertiesConfiguration;
  42 import mir.entity.Entity;
  43 import mir.log.LoggerWrapper;
  44 import mir.media.MediaExc;
  45 import mir.media.MediaFailure;
  46 import mir.media.MediaHandler;
  47 import mir.misc.FileUtil;
  48 import mir.misc.StringUtil;
  49
  50
  51 /**
  52  * This is the Generic MediaHandler. It stores the media data on
  53  * the filesystem and keeps basic metadata  (size, type...) in the
  54  * DB. Usually only representation needs to be overridden.
  55  * See the MediaHandlerAudio class to see an example of how one
  56  * could override it.
  57  * <p>
  58  * Most media handlers should override this class.
  59  * <p>
  60  * In theory, it could be used to handle miscellaneous media that
  61  * we don't have entered in the media_type table, (like RTF documents,
  62  * PS, PDF, etc..)
  63  * <p>
  64  * Of course it implements the MirMediaHandler interface.
  65  *
  66  * @see mir.media.MirMediaHandler
  67  * @author mh <mh@nadir.org>
  68  * @version $Id: MediaHandlerGeneric.java,v 1.20.2.5 2003/12/14 16:37:07 zapata Exp $
  69  */
  70
  71 public class MediaHandlerGeneric implements MediaHandler
  72 {
  73     protected static MirPropertiesConfiguration configuration;
  74     protected static String imageHost;
  75     protected static String imageRoot;
  76
  77     protected LoggerWrapper logger;
  78
  79     static {
  80       try {
  81         configuration = MirPropertiesConfiguration.instance();
  82       }
  83       catch (MirPropertiesConfiguration.PropertiesConfigExc e) {
  84       }
  85       imageHost = configuration.getString("Producer.Image.Host");
  86       imageRoot = configuration.getString("Producer.ImageRoot");
  87     }
  88
  89     public MediaHandlerGeneric() {
  90       logger = new LoggerWrapper("Media.Generic");
  91     }
  92
  93     public void store (InputStream in, Entity ent, Entity mediaTypeEnt ) throws MediaExc, MediaFailure {
  94       String ext = mediaTypeEnt.getValue("name");
  95       String mediaFname = ent.getId() + "." + ext;
  96       String date = ent.getValue("date");
  97       String datePath = StringUtil.webdbDate2path(date);
  98       try {
  99         long size = FileUtil.write(getStoragePath() + File.separator + datePath +
 100                                    File.separator + mediaFname, in);
 101         ent.setValueForProperty("publish_path", datePath + mediaFname);
 102         ent.setValueForProperty("size", new Long(size).toString());
 103         ent.update();
 104       }
 105       catch (Throwable e) {
 106         logger.error("MediaHandlerGeneric.set: " + e.toString());
 107         throw new MediaFailure(e);
 108       }
 109     }
 110
 111     public void produce (Entity ent, Entity mediaTypeEnt ) throws MediaExc, MediaFailure {
 112       //check first if the media file exist since produced
 113       //location is also the storage location
 114
 115       String date = ent.getValue("date");
 116       String datePath = StringUtil.webdbDate2path(date);
 117       String relPath = datePath+ent.getId()+"."+mediaTypeEnt.getValue("name");
 118       String fname = getStoragePath()+relPath;
 119       if(! new File(fname).exists())
 120         throw new MediaExc("error in MirMediaHandler.produce(): " + relPath + " does not exist!");
 121     }
 122
 123     public InputStream getMedia (Entity ent, Entity mediaTypeEnt) throws MediaExc, MediaFailure {
 124       String publishPath = ent.getValue("publish_path");
 125       String fname = getStoragePath()+publishPath;
 126       File f = new File(fname);
 127       if(! f.exists())
 128         throw new MediaExc("error in MirMediaHandler.getMedia(): " + fname + " does not exist!");
 129
 130       BufferedInputStream inputStream;
 131       try {
 132         inputStream = new BufferedInputStream(new FileInputStream(f));
 133       }
 134       catch (Throwable e) {
 135         throw new MediaFailure("MediaHandlerGeneric.getMedia(): " + e.toString(), e);
 136       }
 137
 138       return inputStream;
 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.getValue("name");
 148
 149       return servletContext.getMimeType(fileName);
 150     };
 151
 152     public String getStoragePath()
 153     {
 154         return configuration.getString("Producer.Media.Path");
 155     }
 156
 157     public String getIconStoragePath()
 158     {
 159         return configuration.getString("Producer.Image.IconPath");
 160     }
 161
 162     public String getPublishHost()
 163     {
 164         return StringUtil.removeSlash(configuration.getString("Producer.Media.Host"));
 165     }
 166
 167     public String getTinyIconName()
 168     {
 169         return configuration.getString("Producer.Icon.TinyText");
 170     }
 171
 172     public String getBigIconName()
 173     {
 174         return configuration.getString("Producer.Icon.BigText");
 175     }
 176
 177     public String getIconAltName()
 178     {
 179         return "Generic media";
 180     }
 181
 182     public List getURL(Entity ent, Entity mediaTypeEnt)
 183     {
 184       List theList = new Vector();
 185       theList.add(ent);
 186       return theList;
 187     }
 188
 189     public String getDescr( Entity mediaType)
 190     {
 191       return mediaType.getValue("mime_type");
 192     }
 193
 194 }
 195
 196
 197