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 the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package  mircoders.media;
  33
  34 import java.util.*;
  35 import java.io.*;
  36
  37 import freemarker.template.SimpleList;
  38
  39 import mir.media.*;
  40 import mir.entity.*;
  41 import mir.misc.*;
  42 import mir.storage.*;
  43
  44
  45 /**
  46  * This is the Generic MediaHandler. It stores the media data on
  47  * the filesystem and keeps basic metadata  (size, type...) in the
  48  * DB. Usually only representation needs to be overridden.
  49  * See the MediaHandlerAudio class to see an example of how one
  50  * could override it.
  51  * <p>
  52  * Most media handlers should override this class.
  53  * <p>
  54  * In theory, it could be used to handle miscellaneous media that
  55  * we don't have entered in the media_type table, (like RTF documents,
  56  * PS, PDF, etc..)
  57  * <p>
  58  * Of course it implements the MirMedia interface.
  59  *
  60  * @see mir.media.MirMedia
  61  * @author mh <mh@nadir.org>
  62  * @version $Id: MediaHandlerGeneric.java,v 1.7.2.4 2002/11/27 06:52:47 mh Exp $
  63  */
  64
  65 public class MediaHandlerGeneric implements MirMedia
  66 {
  67     protected static String imageHost = MirConfig.getProp("Producer.Image.Host");
  68     protected static String imageRoot = MirConfig.getProp("Producer.ImageRoot");
  69     protected static Logfile theLog = Logfile.getInstance(
  70                                                   MirConfig.getProp("Home")+
  71                                                   "log/media.log");
  72     private final String sepChar = File.separator;
  73
  74     public void set (InputStream in, Entity ent, Entity mediaTypeEnt )
  75         throws MirMediaException {
  76
  77         String ext = mediaTypeEnt.getValue("name");
  78         String mediaFname = ent.getId()+"."+ext;
  79         String date = ent.getValue("date");
  80         String datePath = StringUtil.webdbDate2path(date);
  81         try {
  82             long size = FileUtil.write(getStoragePath()+sepChar+datePath+
  83                                       sepChar+mediaFname, in);
  84             ent.setValueForProperty("publish_path",datePath+mediaFname);
  85             ent.setValueForProperty("size", new Long(size).toString());
  86             ent.update();
  87         } catch (Exception e) {
  88             theLog.printError(e.toString());
  89             throw new MirMediaException(e.toString());
  90         }
  91
  92     }
  93
  94     public void produce (Entity ent, Entity mediaTypeEnt )
  95       throws MirMediaException {
  96
  97       //check first if the media file exist since produced
  98       //location is also the storage location
  99       String date = ent.getValue("date");
 100       String datePath = StringUtil.webdbDate2path(date);
 101       String relPath = datePath+ent.getId()+"."+mediaTypeEnt.getValue("name");
 102       String fname = getStoragePath()+relPath;
 103       if(! new File(fname).exists())
 104         throw new MirMediaException("error in MirMedia.produce(): "+relPath+
 105                                     "does not exist!");
 106     }
 107
 108
 109     public InputStream getMedia (Entity ent, Entity mediaTypeEnt)
 110       throws MirMediaException {
 111       String publishPath = ent.getValue("publish_path");
 112       String fname = getStoragePath()+publishPath;
 113       File f = new File(fname);
 114       if(! f.exists())
 115         throw new MirMediaException("error in MirMedia.getMedia(): "+fname+
 116                                     " does not exist!");
 117       FileInputStream in;
 118       try {
 119         in = new FileInputStream(f);
 120       } catch (IOException e) {
 121         throw new MirMediaException("getMedia(): "+e.toString());
 122       }
 123       return in;
 124     }
 125
 126     public InputStream getIcon (Entity ent) {
 127         return null;
 128     }
 129
 130     public String getStoragePath()
 131     {
 132         return MirConfig.getProp("Producer.Media.Path");
 133     }
 134
 135     public String getIconStoragePath()
 136     {
 137         return MirConfig.getProp("Producer.Image.IconPath");
 138     }
 139
 140     public String getPublishHost()
 141     {
 142         return StringUtil.removeSlash(MirConfig.getProp("Producer.Media.Host"));
 143     }
 144
 145     public String getTinyIconName()
 146     {
 147         return MirConfig.getProp("Producer.Icon.TinyText");
 148     }
 149
 150     public String getBigIconName()
 151     {
 152         return MirConfig.getProp("Producer.Icon.BigText");
 153     }
 154
 155     public String getIconAltName()
 156     {
 157         return "Generic media";
 158     }
 159
 160     public SimpleList getURL(Entity ent, Entity mediaTypeEnt)
 161     {
 162       SimpleList theList = new SimpleList();
 163       theList.add(ent);
 164       return theList;
 165     }
 166
 167     public boolean isVideo()
 168     {
 169       return false;
 170     }
 171
 172     public boolean isAudio()
 173     {
 174       return false;
 175     }
 176
 177     public boolean isImage()
 178     {
 179       return false;
 180     }
 181
 182     public String getDescr( Entity mediaType)
 183     {
 184       return mediaType.getValue("mime_type");
 185     }
 186
 187 }
 188
 189
 190