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  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.
  29  */
  30 package  mircoders.media;
  31
  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;
  40
  41 import javax.servlet.ServletContext;
  42 import java.io.FileInputStream;
  43 import java.io.FileOutputStream;
  44 import java.io.InputStream;
  45
  46
  47 /**
  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
  52  * could override it.
  53  * <p>
  54  * Most media handlers should override this class.
  55  * <p>
  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,
  58  * PS, PDF, etc..)
  59  * <p>
  60  * Of course it implements the MirMediaHandler interface.
  61  *
  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 $
  65  */
  66
  67 public class MediaHandlerGeneric extends AbstractMediaHandler {
  68   protected static MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
  69
  70   protected LoggerWrapper logger = new LoggerWrapper("Media.Generic");
  71
  72   /** {@inheritDoc} */
  73   public void store(UploadedFile anUploadedFile, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
  74     try {
  75       anUploadedFile.writeToFile(getMediaStorageFile(aMedia, aMediaType));
  76       aMedia.setFieldValue("publish_path", getRelativeMediaStoragePath(aMedia, aMediaType));
  77       aMedia.setFieldValue("size", Long.toString(getMediaStorageFile(aMedia, aMediaType).length()));
  78       aMedia.update();
  79       reportChange(getMediaStorageFile(aMedia, aMediaType).getAbsolutePath());
  80     }
  81     catch (Throwable e) {
  82       logger.error("MediaHandlerGeneric.set: " + e.toString());
  83       throw new MediaFailure(e);
  84     }
  85   }
  86
  87   /** {@inheritDoc} */
  88   public void store(InputStream anInputStream, Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
  89     try {
  90       IORoutines.copyStream(anInputStream, new FileOutputStream(getMediaStorageFile(aMedia, aMediaType)));
  91
  92       aMedia.setFieldValue("publish_path", getRelativeMediaStoragePath(aMedia, aMediaType));
  93       aMedia.setFieldValue("size", Long.toString(getMediaStorageFile(aMedia, aMediaType).length()));
  94       aMedia.update();
  95       reportChange(getMediaStorageFile(aMedia, aMediaType).getAbsolutePath());
  96     }
  97     catch (Throwable e) {
  98       logger.error("MediaHandlerGeneric.set: " + e.toString());
  99       throw new MediaFailure(e);
 100     }
 101   }
 102
 103   /** {@inheritDoc} */
 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!");
 107     }
 108   }
 109
 110   /** {@inheritDoc} */
 111   public InputStream getMedia(Entity aMedia, Entity aMediaType) throws MediaExc, MediaFailure {
 112     try {
 113       return new FileInputStream(getMediaStorageFile(aMedia, aMediaType));
 114     }
 115     catch (Throwable e) {
 116       throw new MediaFailure("MediaHandlerGeneric.getMedia(): " + e.toString(), e);
 117     }
 118   }
 119
 120   public InputStream getThumbnail(Entity ent) throws MediaExc, MediaFailure {
 121     return null;
 122   }
 123
 124   public String getThumbnailMimeType(Entity aMediaEntity, Entity aMediaType) throws MediaExc, MediaFailure {
 125     ServletContext servletContext = MirPropertiesConfiguration.getContext();
 126     String fileName = aMediaEntity.getId() + "." + aMediaType.getFieldValue("name");
 127
 128     return servletContext.getMimeType(fileName);
 129   }
 130
 131   public String getBaseStoragePath() {
 132     return configuration.getString("Producer.Media.Path");
 133   }
 134
 135   public String getBaseIconStoragePath() {
 136     return configuration.getString("Producer.Image.IconPath");
 137   }
 138
 139   public String getPublishHost() {
 140     return StringUtil.removeSlash(configuration.getString("Producer.Media.Host"));
 141   }
 142
 143   public String getTinyIconName() {
 144     return configuration.getString("Producer.Icon.TinyText");
 145   }
 146
 147   public String getBigIconName() {
 148     return configuration.getString("Producer.Icon.BigText");
 149   }
 150
 151   public String getIconAltName() {
 152     return "Generic media";
 153   }
 154
 155   public String getDescr(Entity mediaType) {
 156     return mediaType.getFieldValue("mime_type");
 157   }
 158
 159 }
 160
 161
 162