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;
32 import mir.config.MirPropertiesConfiguration;
33 import mir.entity.Entity;
34 import mir.log.LoggerWrapper;
35 import mir.media.MediaExc;
36 import mir.media.MediaFailure;
37 import mir.misc.StringUtil;
38 import mir.session.UploadedFile;
39 import mir.util.FileFunctions;
41 import javax.servlet.ServletContext;
42 import java.io.BufferedInputStream;
44 import java.io.FileInputStream;
45 import java.io.InputStream;
49 * This is the Generic MediaHandler. It stores the media data on
50 * the filesystem and keeps basic metadata (size, type...) in the
51 * DB. Usually only representation needs to be overridden.
52 * See the MediaHandlerAudio class to see an example of how one
55 * Most media handlers should override this class.
57 * In theory, it could be used to handle miscellaneous media that
58 * we don't have entered in the media_type table, (like RTF documents,
61 * Of course it implements the MirMediaHandler interface.
63 * @see mir.media.MediaHandler
64 * @author mh <mh@nadir.org>
65 * @version $Id: MediaHandlerGeneric.java,v 1.20.2.7 2004/11/21 22:07:14 zapata Exp $
68 public class MediaHandlerGeneric extends AbstractMediaHandler
70 protected static MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
72 protected LoggerWrapper logger = new LoggerWrapper("Media.Generic");
75 public void store(File aFile, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
77 FileFunctions.move(aFile, getStorageFile(aMedia, aMediaType));
79 aMedia.setFieldValue("publish_path", getRelativeStorageFile(aMedia, aMediaType));
80 aMedia.setFieldValue("size", Long.toString(getStorageFile(aMedia, aMediaType).length()));
84 logger.error("MediaHandlerGeneric.set: " + e.toString());
85 throw new MediaFailure(e);
90 public void store(UploadedFile anUploadedFile, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
92 anUploadedFile.writeToFile(getStorageFile(aMedia, aMediaType));
94 aMedia.setFieldValue("publish_path", getRelativeStorageFile(aMedia, aMediaType));
95 aMedia.setFieldValue("size", Long.toString(getStorageFile(aMedia, aMediaType).length()));
99 logger.error("MediaHandlerGeneric.set: " + e.toString());
100 throw new MediaFailure(e);
105 public void store(InputStream anInputStream, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
107 FileFunctions.copy(anInputStream, getStorageFile(aMedia, aMediaType));
109 aMedia.setFieldValue("publish_path", getRelativeStorageFile(aMedia, aMediaType));
110 aMedia.setFieldValue("size", Long.toString(getStorageFile(aMedia, aMediaType).length()));
113 catch (Throwable e) {
114 logger.error("MediaHandlerGeneric.set: " + e.toString());
115 throw new MediaFailure(e);
119 public void produce(Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
120 if (!getStorageFile(aMedia, aMediaType).exists())
121 throw new MediaExc("error in producing media:: " + getStorageFile(aMedia, aMediaType) + " does not exist!");
125 * Get access to the raw media data by an {@link InputStream}
127 public InputStream getMedia(Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
128 File file = getStorageFile(aMedia, aMediaType);
130 throw new MediaExc("error in MirMediaHandler.getMedia(): " + file + " does not exist!");
133 return new BufferedInputStream(new FileInputStream(file));
135 catch (Throwable e) {
136 throw new MediaFailure("MediaHandlerGeneric.getMedia(): " + e.toString(), e);
140 public InputStream getThumbnail(Entity ent) throws MediaExc, MediaFailure {
144 public String getThumbnailMimeType(Entity aMediaEntity, Entity aMediaType) throws MediaExc, MediaFailure {
145 ServletContext servletContext = MirPropertiesConfiguration.getContext();
146 String fileName = aMediaEntity.getId() + "." + aMediaType.getFieldValue("name");
148 return servletContext.getMimeType(fileName);
151 public String getStoragePath() {
152 return configuration.getString("Producer.Media.Path");
155 public String getIconStoragePath() {
156 return configuration.getString("Producer.Image.IconPath");
159 public String getPublishHost() {
160 return StringUtil.removeSlash(configuration.getString("Producer.Media.Host"));
163 public String getTinyIconName() {
164 return configuration.getString("Producer.Icon.TinyText");
167 public String getBigIconName() {
168 return configuration.getString("Producer.Icon.BigText");
171 public String getIconAltName() {
172 return "Generic media";
175 public String getDescr(Entity mediaType) {
176 return mediaType.getFieldValue("mime_type");