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.IORoutines;
41 import javax.servlet.ServletContext;
42 import java.io.FileInputStream;
43 import java.io.FileOutputStream;
44 import java.io.InputStream;
48 * This is the Generic MediaHandler. It stores the media data on
49 * the filesystem and keeps basic metadata (size, type...) in the
50 * DB. Usually only representation needs to be overridden.
51 * See the MediaHandlerAudio class to see an example of how one
54 * Most media handlers should override this class.
56 * In theory, it could be used to handle miscellaneous media that
57 * we don't have entered in the media_type table, (like RTF documents,
60 * Of course it implements the MirMediaHandler interface.
62 * @see mir.media.MediaHandler
63 * @author mh <mh@nadir.org>
64 * @version $Id: MediaHandlerGeneric.java,v 1.20.2.10 2006/11/12 21:32:13 yossarian Exp $
67 public class MediaHandlerGeneric extends AbstractMediaHandler {
68 protected static MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
70 protected LoggerWrapper logger = new LoggerWrapper("Media.Generic");
73 public void store(UploadedFile anUploadedFile, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
75 anUploadedFile.writeToFile(getMediaStorageFile(aMedia, aMediaType));
76 aMedia.setFieldValue("publish_path", getRelativeMediaStoragePath(aMedia, aMediaType));
77 aMedia.setFieldValue("size", Long.toString(getMediaStorageFile(aMedia, aMediaType).length()));
79 reportChange(getMediaStorageFile(aMedia, aMediaType).getAbsolutePath());
82 logger.error("MediaHandlerGeneric.set: " + e.toString());
83 throw new MediaFailure(e);
88 public void store(InputStream anInputStream, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
90 IORoutines.copyStream(anInputStream, new FileOutputStream(getMediaStorageFile(aMedia, aMediaType)));
92 aMedia.setFieldValue("publish_path", getRelativeMediaStoragePath(aMedia, aMediaType));
93 aMedia.setFieldValue("size", Long.toString(getMediaStorageFile(aMedia, aMediaType).length()));
95 reportChange(getMediaStorageFile(aMedia, aMediaType).getAbsolutePath());
98 logger.error("MediaHandlerGeneric.set: " + e.toString());
99 throw new MediaFailure(e);
104 public void produce(Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
105 if (!getMediaStorageFile(aMedia, aMediaType).exists()) {
106 throw new MediaExc("error in producing media:: " + getMediaStorageFile(aMedia, aMediaType) + " does not exist!");
111 public InputStream getMedia(Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
113 return new FileInputStream(getMediaStorageFile(aMedia, aMediaType));
115 catch (Throwable e) {
116 throw new MediaFailure("MediaHandlerGeneric.getMedia(): " + e.toString(), e);
120 public InputStream getThumbnail(Entity ent) throws MediaExc, MediaFailure {
124 public String getThumbnailMimeType(Entity aMediaEntity, Entity aMediaType) throws MediaExc, MediaFailure {
125 ServletContext servletContext = MirPropertiesConfiguration.getContext();
126 String fileName = aMediaEntity.getId() + "." + aMediaType.getFieldValue("name");
128 return servletContext.getMimeType(fileName);
131 public String getBaseStoragePath() {
132 return configuration.getString("Producer.Media.Path");
135 public String getBaseIconStoragePath() {
136 return configuration.getString("Producer.Image.IconPath");
139 public String getPublishHost() {
140 return StringUtil.removeSlash(configuration.getString("Producer.Media.Host"));
143 public String getTinyIconName() {
144 return configuration.getString("Producer.Icon.TinyText");
147 public String getBigIconName() {
148 return configuration.getString("Producer.Icon.BigText");
151 public String getIconAltName() {
152 return "Generic media";
155 public String getDescr(Entity mediaType) {
156 return mediaType.getFieldValue("mime_type");