2 * Copyright (C) 2001, 2002 The Mir-coders group
4 * This file is part of Mir.
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.
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.
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
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.
30 package mircoders.media;
33 import java.io.FileInputStream;
34 import java.io.InputStream;
35 import javax.servlet.ServletContext;
37 import freemarker.template.SimpleList;
39 import mir.config.MirPropertiesConfiguration;
40 import mir.config.MirPropertiesConfiguration$PropertiesConfigExc;
41 import mir.entity.Entity;
42 import mir.log.LoggerWrapper;
43 import mir.media.MediaExc;
44 import mir.media.MediaFailure;
45 import mir.media.MirMedia;
46 import mir.misc.FileUtil;
47 import mir.misc.StringUtil;
51 * This is the Generic MediaHandler. It stores the media data on
52 * the filesystem and keeps basic metadata (size, type...) in the
53 * DB. Usually only representation needs to be overridden.
54 * See the MediaHandlerAudio class to see an example of how one
57 * Most media handlers should override this class.
59 * In theory, it could be used to handle miscellaneous media that
60 * we don't have entered in the media_type table, (like RTF documents,
63 * Of course it implements the MirMedia interface.
65 * @see mir.media.MirMedia
66 * @author mh <mh@nadir.org>
67 * @version $Id: MediaHandlerGeneric.java,v 1.20 2003/04/29 02:36:50 zapata Exp $
70 public class MediaHandlerGeneric implements MirMedia
72 protected static MirPropertiesConfiguration configuration;
73 protected static String imageHost;
74 protected static String imageRoot;
76 protected LoggerWrapper logger;
80 configuration = MirPropertiesConfiguration.instance();
82 catch (PropertiesConfigExc e) {
84 imageHost = configuration.getString("Producer.Image.Host");
85 imageRoot = configuration.getString("Producer.ImageRoot");
88 public MediaHandlerGeneric() {
89 logger = new LoggerWrapper("Media.Generic");
92 public void set (InputStream in, Entity ent, Entity mediaTypeEnt ) throws MediaExc, MediaFailure {
93 String ext = mediaTypeEnt.getValue("name");
94 String mediaFname = ent.getId() + "." + ext;
95 String date = ent.getValue("date");
96 String datePath = StringUtil.webdbDate2path(date);
98 long size = FileUtil.write(getStoragePath() + File.separator + datePath +
99 File.separator + mediaFname, in);
100 ent.setValueForProperty("publish_path", datePath + mediaFname);
101 ent.setValueForProperty("size", new Long(size).toString());
104 catch (Throwable e) {
105 logger.error("MediaHandlerGeneric.set: " + e.toString());
106 throw new MediaFailure(e);
110 public void produce (Entity ent, Entity mediaTypeEnt ) throws MediaExc, MediaFailure {
111 //check first if the media file exist since produced
112 //location is also the storage location
114 String date = ent.getValue("date");
115 String datePath = StringUtil.webdbDate2path(date);
116 String relPath = datePath+ent.getId()+"."+mediaTypeEnt.getValue("name");
117 String fname = getStoragePath()+relPath;
118 if(! new File(fname).exists())
119 throw new MediaExc("error in MirMedia.produce(): " + relPath + " does not exist!");
122 public InputStream getMedia (Entity ent, Entity mediaTypeEnt) throws MediaExc, MediaFailure {
123 String publishPath = ent.getValue("publish_path");
124 String fname = getStoragePath()+publishPath;
125 File f = new File(fname);
127 throw new MediaExc("error in MirMedia.getMedia(): " + fname + " does not exist!");
129 FileInputStream inputStream;
131 inputStream = new FileInputStream(f);
133 catch (Throwable e) {
134 throw new MediaFailure("MediaHandlerGeneric.getMedia(): " + e.toString(), e);
140 public InputStream getIcon (Entity ent) throws MediaExc, MediaFailure {
144 public String getIconMimeType (Entity aMediaEntity, Entity aMediaType) throws MediaExc, MediaFailure {
145 ServletContext servletContext = MirPropertiesConfiguration.getContext();
146 String fileName = aMediaEntity.getId()+"."+aMediaType.getValue("name");
148 return servletContext.getMimeType(fileName);
151 public String getStoragePath()
153 return configuration.getString("Producer.Media.Path");
156 public String getIconStoragePath()
158 return configuration.getString("Producer.Image.IconPath");
161 public String getPublishHost()
163 return StringUtil.removeSlash(configuration.getString("Producer.Media.Host"));
166 public String getTinyIconName()
168 return configuration.getString("Producer.Icon.TinyText");
171 public String getBigIconName()
173 return configuration.getString("Producer.Icon.BigText");
176 public String getIconAltName()
178 return "Generic media";
181 public SimpleList getURL(Entity ent, Entity mediaTypeEnt)
183 SimpleList theList = new SimpleList();
188 public boolean isVideo()
193 public boolean isAudio()
198 public boolean isImage()
203 public String getDescr( Entity mediaType)
205 return mediaType.getValue("mime_type");