Mir goes GPL
[mir.git] / source / mircoders / media / MediaHandlerImages.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
33 package mircoders.media;
34
35 import java.lang.*;
36 import java.io.*;
37 import java.util.*;
38 import java.lang.reflect.*;
39
40 import freemarker.template.SimpleList;
41
42 import mir.media.*;
43 import mir.misc.*;
44 import mir.entity.*;
45 import mir.storage.StorageObjectException;
46 import mircoders.entity.EntityImages;
47
48 /**
49  * This class handles saving, fetching creating representations
50  * for all images. The image content is stored in the DB. The content is
51  * written out to a file at the ProducerImages level.
52  * Remember that Handlers for specific image types, Gif, Jpeg, etc..
53  * should override it.
54  * It implements the MirMedia interface.
55  * <p>
56  * slowly starting to look better, a next step would be to have the
57  * representation stuff (WebdbImage) happen here.
58  * -mh 01.03.2002
59  *
60  * @see mir.media.MirMedia
61  * @author mh
62  * @version 24.09.2001
63  */
64
65
66 public abstract class MediaHandlerImages implements MirMedia
67 {
68   static Logfile theLog = Logfile.getInstance(MirConfig.getProp("Home")+
69                                                 "log/media.log");
70   static final String PNG = "PNG"; 
71   static final String JPEG = "JPEG"; 
72
73   abstract String getType();
74
75         public byte[] get(Entity ent, Entity mediaTypeEnt)
76     throws MirMediaException
77         {
78     byte[] image_data = null;
79
80     try {
81       image_data = ((EntityImages)ent).getImage();
82     } catch ( StorageObjectException e) {
83       theLog.printDebugInfo("MediaHandlerImages.get: "+e.toString()); 
84       throw new MirMediaException(e.toString());
85     }
86
87     return image_data;
88   }
89
90         public boolean set(byte[] uploadData, Entity ent, Entity mediaTypeEnt)
91     throws MirMediaException {
92
93     try {
94       ((EntityImages)ent).setImage(uploadData, getType());
95     } catch ( StorageObjectException e) {
96       theLog.printError("MediaHandlerImages.set: "+e.toString()); 
97       throw new MirMediaException(e.toString());
98     }
99     //deref. -mh
100     uploadData=null;
101
102     return true;
103         }
104
105   public void produce(Entity ent, Entity mediaTypeEnt) throws MirMediaException
106   {
107     String date = ent.getValue("date");
108     String datePath = StringUtil.webdbDate2path(date);
109     String ext = "."+mediaTypeEnt.getValue("name");
110     String filepath = datePath+ent.getId()+ext;
111     String iconFilePath = MirConfig.getProp("Producer.StorageRoot")
112                           +getIconStoragePath() + filepath;
113     String productionFilePath = getStoragePath() + "/" + filepath;
114
115
116     if (ent.getValue("icon_data")!= null &&
117         ent.getValue("image_data")!= null) {
118       // make icon
119       try {
120         FileUtil.write(iconFilePath,((EntityImages)ent).getIcon());
121         FileUtil.write(productionFilePath,((EntityImages)ent).getImage());
122         ent.setValueForProperty("icon_path",getIconStoragePath()+filepath);
123         ent.setValueForProperty("publish_path",filepath);
124         ent.update();
125       } catch ( Exception e) {
126         String msg = "MediaHandlerImages.produce - Error: " + e.toString();
127         theLog.printError(msg);
128         throw new MirMediaException(msg);
129       }
130     } else {
131       String msg="MediaHandlerImages.produce - missing image or icon OID for: "+
132                   ent.getId();
133       theLog.printError(msg);
134       throw new MirMediaException(msg);
135     }
136   }
137                         
138
139         public byte[] getIcon(Entity ent) throws MirMediaException
140         {
141     byte[] icon_data = null;
142
143     try {
144       icon_data = ((EntityImages)ent).getIcon();
145     } catch ( StorageObjectException e) {
146       theLog.printDebugInfo("MediaHandlerImages.getIcon: "+e.toString()); 
147       throw new MirMediaException(e.toString());
148     }
149
150     return icon_data;
151   }
152
153   public SimpleList getURL(Entity ent, Entity mediaTypeEnt)
154   {
155     SimpleList theList = new SimpleList();
156     theList.add(ent);
157     return theList;
158   }
159
160   public String getStoragePath()
161   {
162     return MirConfig.getProp("Producer.Image.Path");
163   }
164
165   public String getIconStoragePath()
166   {
167     return MirConfig.getProp("Producer.Image.IconPath");
168   }
169
170   public String getPublishHost()
171   {
172     return MirConfig.getProp("Producer.Image.Host");
173   }
174
175   public String getTinyIcon ()
176   {
177     return MirConfig.getProp("Producer.Icon.TinyImage");
178   } 
179
180   public String getBigIcon ()
181   {
182     return MirConfig.getProp("Producer.Icon.BigImage");
183   } 
184
185   public String getIconAlt ()
186   {
187     return "Image";
188   } 
189
190   public boolean isVideo ()
191   {
192     return false;
193   } 
194
195   public boolean isAudio ()
196   {
197     return false;
198   } 
199
200   public boolean isImage ()
201   {
202     return true;
203   } 
204
205   public String getDescr(Entity mediaType)
206   {
207     return "";
208   }
209
210 }