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 <heckmann@hbe.ca>
  62  * @version 24.09.2001
  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(MirConfig.getProp("Home")+
  70                                                   "log/media.log");
  71     public void set (InputStream in, Entity ent, Entity mediaTypeEnt )
  72         throws MirMediaException {
  73
  74         String ext = mediaTypeEnt.getValue("name");
  75         String mediaFname = ent.getId()+"."+ext;
  76         String date = ent.getValue("date");
  77         String datePath = StringUtil.webdbDate2path(date);
  78         try {
  79             long size = FileUtil.write(getStoragePath()+"/"+datePath+"/"+
  80                                       mediaFname, in);
  81             ent.setValueForProperty("publish_path",datePath+"/"+mediaFname);
  82             ent.setValueForProperty("size", new Long(size).toString());
  83             ent.update();
  84         } catch (Exception e) {
  85             theLog.printError(e.toString());
  86             throw new MirMediaException(e.toString());
  87         }
  88
  89     }
  90
  91     public void produce (Entity ent, Entity mediaTypeEnt )
  92       throws MirMediaException {
  93
  94       //check first if the media file exist since produced
  95       //location is also the storage location
  96       String date = ent.getValue("date");
  97       String datePath = StringUtil.webdbDate2path(date);
  98       String relPath = datePath+ent.getId()+"."+mediaTypeEnt.getValue("name");
  99       String fname = getStoragePath()+relPath;
 100       if(! new File(fname).exists())
 101         throw new MirMediaException("error in MirMedia.produce(): "+relPath+
 102                                     "does not exist!");
 103     }
 104
 105
 106     public InputStream getMedia (Entity ent, Entity mediaTypeEnt)
 107       throws MirMediaException {
 108       String publishPath = mediaTypeEnt.getValue("publish_path");
 109       String fname = getStoragePath()+publishPath;
 110       File f = new File(fname);
 111       if(! f.exists())
 112         throw new MirMediaException("error in MirMedia.getMedia(): "+fname+
 113                                     "does not exist!");
 114       FileInputStream in;
 115       try {
 116         in = new FileInputStream(f);
 117       } catch (IOException e) {
 118         throw new MirMediaException("getMedia(): "+e.toString());
 119       }
 120       return in;
 121     }
 122
 123     public InputStream getIcon (Entity ent) {
 124         return null;
 125     }
 126
 127     public String getStoragePath()
 128     {
 129         return MirConfig.getProp("Producer.Media.Path");
 130     }
 131
 132     public String getIconStoragePath()
 133     {
 134         return MirConfig.getProp("Producer.Image.IconPath");
 135     }
 136
 137     public String getPublishHost()
 138     {
 139         return MirConfig.getProp("Producer.Media.Host");
 140     }
 141
 142     public String getTinyIconName()
 143     {
 144         return MirConfig.getProp("Producer.Icon.TinyText");
 145     }
 146
 147     public String getBigIconName()
 148     {
 149         return MirConfig.getProp("Producer.Icon.BigText");
 150     }
 151
 152     public String getIconAltName()
 153     {
 154         return "Generic media";
 155     }
 156
 157     public SimpleList getURL(Entity ent, Entity mediaTypeEnt)
 158     {
 159       SimpleList theList = new SimpleList();
 160       theList.add(ent);
 161       return theList;
 162     }
 163
 164     public boolean isVideo()
 165     {
 166       return false;
 167     }
 168
 169     public boolean isAudio()
 170     {
 171       return false;
 172     }
 173
 174     public boolean isImage()
 175     {
 176       return false;
 177     }
 178
 179     public String getDescr( Entity mediaType)
 180     {
 181       return mediaType.getValue("mime_type");
 182     }
 183
 184 }
 185
 186
 187