d56ce9fbce18faab5527b78557655dfb2a4b4170
[mir.git] / source / mircoders / localizer / basic / MirBasicDataModelLocalizer.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.localizer.basic;
31
32 import java.util.HashMap;
33 import java.util.Iterator;
34 import java.util.List;
35 import java.util.Map;
36 import java.util.Vector;
37
38 import mir.config.MirPropertiesConfiguration;
39 import mir.entity.Entity;
40 import mir.entity.adapter.EntityAdapter;
41 import mir.entity.adapter.EntityAdapterDefinition;
42 import mir.entity.adapter.EntityAdapterModel;
43 import mir.log.LoggerWrapper;
44 import mir.media.MediaHelper;
45 import mir.media.MirMedia;
46 import mir.util.ParameterExpander;
47 import mir.util.RewindableIterator;
48 import mir.util.StructuredContentParser;
49 import mircoders.entity.EntityUploadedMedia;
50 import mircoders.global.MirGlobal;
51 import mircoders.localizer.MirAdminInterfaceLocalizer;
52 import mircoders.localizer.MirDataModelLocalizer;
53 import mircoders.localizer.MirLocalizerExc;
54 import mircoders.localizer.MirLocalizerFailure;
55 import mircoders.storage.DatabaseArticleType;
56 import mircoders.storage.DatabaseAudio;
57 import mircoders.storage.DatabaseBreaking;
58 import mircoders.storage.DatabaseComment;
59 import mircoders.storage.DatabaseCommentStatus;
60 import mircoders.storage.DatabaseContent;
61 import mircoders.storage.DatabaseContentToTopics;
62 import mircoders.storage.DatabaseImageType;
63 import mircoders.storage.DatabaseImages;
64 import mircoders.storage.DatabaseLanguage;
65 import mircoders.storage.DatabaseMedia;
66 import mircoders.storage.DatabaseMediaType;
67 import mircoders.storage.DatabaseMediafolder;
68 import mircoders.storage.DatabaseMessages;
69 import mircoders.storage.DatabaseOther;
70 import mircoders.storage.DatabaseTopics;
71 import mircoders.storage.DatabaseUploadedMedia;
72 import mircoders.storage.DatabaseUsers;
73 import mircoders.storage.DatabaseVideo;
74
75 public class MirBasicDataModelLocalizer implements MirDataModelLocalizer {
76   protected LoggerWrapper logger;
77   protected MirPropertiesConfiguration configuration;
78
79   public MirBasicDataModelLocalizer() throws MirLocalizerFailure, MirLocalizerExc {
80     logger = new LoggerWrapper("Localizer.DataModel");
81
82     try {
83       configuration = MirPropertiesConfiguration.instance();
84     }
85     catch (Throwable e) {
86       throw new MirLocalizerFailure("Can't get configuration: " + e.getMessage(), e);
87     }
88   }
89
90   protected void constructContentAdapterDefinition(EntityAdapterDefinition anEntityAdapterDefinition) throws MirLocalizerFailure, MirLocalizerExc {
91     try {
92       anEntityAdapterDefinition.addDBDateField("creationdate", "webdb_create");
93       anEntityAdapterDefinition.addDBDateField("changedate", "webdb_lastchange");
94       anEntityAdapterDefinition.addMirDateField("date", "date");
95       anEntityAdapterDefinition.addCalculatedField("to_topics", new ContentToTopicsField());
96       anEntityAdapterDefinition.addCalculatedField("to_comments", new ContentToCommentsField());
97       anEntityAdapterDefinition.addCalculatedField("language", new ContentToLanguageField());
98
99       anEntityAdapterDefinition.addCalculatedField("commentcount", new ContentCommentCountField(" and is_published='1'"));
100       anEntityAdapterDefinition.addCalculatedField("fullcommentcount", new ContentCommentCountField(""));
101
102       anEntityAdapterDefinition.addCalculatedField("to_uploaded_media", new ContentToMediaField( "uploadedMedia" ));
103       anEntityAdapterDefinition.addCalculatedField("to_media_images",  new ContentToMediaField( "image" ));
104       anEntityAdapterDefinition.addCalculatedField("to_media_audio", new ContentToMediaField( "audio" ));
105       anEntityAdapterDefinition.addCalculatedField("to_media_video", new ContentToMediaField( "video" ));
106       anEntityAdapterDefinition.addCalculatedField("to_media_other", new ContentToMediaField( "otherMedia" ));
107       anEntityAdapterDefinition.addCalculatedField("to_all_uploaded_media", new ContentToMediaField( "uploadedMedia", false));
108       anEntityAdapterDefinition.addCalculatedField("to_all_media_images",  new ContentToMediaField( "image", false));
109       anEntityAdapterDefinition.addCalculatedField("to_all_media_audio", new ContentToMediaField( "audio", false));
110       anEntityAdapterDefinition.addCalculatedField("to_all_media_video", new ContentToMediaField( "video", false));
111       anEntityAdapterDefinition.addCalculatedField("to_all_media_other", new ContentToMediaField( "otherMedia", false));
112       anEntityAdapterDefinition.addCalculatedField("to_media_icon", new ContentToIconField());
113
114       anEntityAdapterDefinition.addCalculatedField("article_type", new ContentToArticleTypeField());
115
116       anEntityAdapterDefinition.addCalculatedField("description_parsed", new FilteredField("description"));
117       anEntityAdapterDefinition.addCalculatedField("content_data_parsed", new FilteredField("content_data"));
118
119       anEntityAdapterDefinition.addCalculatedField("children", new ContentToChildrenField());
120       anEntityAdapterDefinition.addCalculatedField("parent", new ContentToParentField());
121
122       anEntityAdapterDefinition.addCalculatedField("publicurl", new ExpandedField(configuration.getString("Article.PublicUrl")));
123
124       anEntityAdapterDefinition.addCalculatedField("operations",
125           new EntityToSimpleOperationsField(MirGlobal.localizer().adminInterface().simpleArticleOperations()));
126     }
127     catch (Throwable t) {
128       throw new MirLocalizerFailure(t.getMessage(), t);
129     }
130   }
131
132   protected void constructCommentAdapterDefinition(EntityAdapterDefinition anEntityAdapterDefinition) throws MirLocalizerFailure {
133     try {
134       anEntityAdapterDefinition.addDBDateField("creationdate", "webdb_create");
135       anEntityAdapterDefinition.addCalculatedField("to_content", new CommentToContentField());
136       anEntityAdapterDefinition.addCalculatedField("status", new CommentToStatusField());
137
138       anEntityAdapterDefinition.addCalculatedField("to_uploaded_media", new CommentToMediaField( "uploadedMedia" ));
139       anEntityAdapterDefinition.addCalculatedField("to_media_images",  new CommentToMediaField( "image" ));
140       anEntityAdapterDefinition.addCalculatedField("to_media_audio", new CommentToMediaField( "audio" ));
141       anEntityAdapterDefinition.addCalculatedField("to_media_video", new CommentToMediaField( "video" ));
142       anEntityAdapterDefinition.addCalculatedField("to_media_other", new CommentToMediaField( "otherMedia" ));
143       anEntityAdapterDefinition.addCalculatedField("to_all_uploaded_media", new CommentToMediaField( "uploadedMedia", false));
144       anEntityAdapterDefinition.addCalculatedField("to_all_media_images",  new CommentToMediaField( "image", false));
145       anEntityAdapterDefinition.addCalculatedField("to_all_media_audio", new CommentToMediaField( "audio", false));
146       anEntityAdapterDefinition.addCalculatedField("to_all_media_video", new CommentToMediaField( "video", false));
147       anEntityAdapterDefinition.addCalculatedField("to_all_media_other", new CommentToMediaField( "otherMedia", false));
148
149       anEntityAdapterDefinition.addCalculatedField("publicurl", new ExpandedField(configuration.getString("Comment.PublicUrl")));
150
151       anEntityAdapterDefinition.addCalculatedField("description_parsed", new FilteredField("description"));
152       anEntityAdapterDefinition.addCalculatedField("operations",
153           new EntityToSimpleOperationsField(MirGlobal.localizer().adminInterface().simpleCommentOperations()));
154     }
155     catch (Throwable t) {
156       throw new MirLocalizerFailure(t.getMessage(), t);
157     }
158   }
159
160   public EntityAdapterModel adapterModel() throws MirLocalizerFailure, MirLocalizerExc {
161     EntityAdapterModel result = new EntityAdapterModel();
162
163     try {
164       EntityAdapterDefinition definition;
165
166       definition = new EntityAdapterDefinition();
167       constructContentAdapterDefinition( definition );
168       result.addMapping( "content", DatabaseContent.getInstance(), definition);
169
170       definition = new EntityAdapterDefinition();
171       constructCommentAdapterDefinition( definition );
172       result.addMapping( "comment", DatabaseComment.getInstance(), definition);
173
174       result.addMapping( "articleType", DatabaseArticleType.getInstance(), new EntityAdapterDefinition());
175       result.addMapping( "commentStatus", DatabaseCommentStatus.getInstance(), new EntityAdapterDefinition());
176
177       definition = new EntityAdapterDefinition();
178       definition.addDBDateField("creationdate", "webdb_create");
179       result.addMapping( "breakingNews", DatabaseBreaking.getInstance(), definition);
180
181       result.addMapping( "imageType", DatabaseImageType.getInstance(), new EntityAdapterDefinition());
182       result.addMapping( "language", DatabaseLanguage.getInstance(), new EntityAdapterDefinition());
183       result.addMapping( "mediaFolder", DatabaseMediafolder.getInstance(), new EntityAdapterDefinition());
184       result.addMapping( "mediaType", DatabaseMediaType.getInstance(), new EntityAdapterDefinition());
185       result.addMapping( "internalMessage", DatabaseMessages.getInstance(), new EntityAdapterDefinition());
186       result.addMapping( "topic", DatabaseTopics.getInstance(), new EntityAdapterDefinition());
187       result.addMapping( "user", DatabaseUsers.getInstance(), new EntityAdapterDefinition());
188       result.addMapping( "media", DatabaseMedia.getInstance(), new EntityAdapterDefinition());
189       result.addMapping( "uploadedMedia", DatabaseUploadedMedia.getInstance(), new EntityAdapterDefinition());
190       result.addMapping( "image", DatabaseImages.getInstance(), new EntityAdapterDefinition());
191       result.addMapping( "audio", DatabaseAudio.getInstance(), new EntityAdapterDefinition());
192       result.addMapping( "video", DatabaseVideo.getInstance(), new EntityAdapterDefinition());
193       result.addMapping( "otherMedia", DatabaseOther.getInstance(), new EntityAdapterDefinition());
194
195       result.addMapping( "content_x_topic", DatabaseContentToTopics.getInstance(), new EntityAdapterDefinition());
196
197     }
198     catch (Throwable t) {
199       throw new MirLocalizerFailure(t.getMessage(), t);
200     }
201
202     return result;
203   }
204
205   protected class CommentToContentField implements EntityAdapterDefinition.CalculatedField {
206     public Object getValue(EntityAdapter anEntityAdapter) {
207       try {
208         return anEntityAdapter.getToOneRelation(
209                     "id="+anEntityAdapter.get("to_media"),
210                     "id",
211                     "content" );
212       }
213       catch (Throwable t) {
214         throw new RuntimeException(t.getMessage());
215       }
216     }
217   }
218
219   protected class CommentToStatusField implements EntityAdapterDefinition.CalculatedField {
220     public Object getValue(EntityAdapter anEntityAdapter) {
221       try {
222         return anEntityAdapter.getToOneRelation(
223                     "id="+anEntityAdapter.get("to_comment_status"),
224                     "id",
225                     "commentStatus" );
226       }
227       catch (Throwable t) {
228         throw new RuntimeException(t.getMessage());
229       }
230     }
231   }
232
233   protected class EntityToSimpleOperationsField implements EntityAdapterDefinition.CalculatedField {
234     private List operations;
235
236     public EntityToSimpleOperationsField(List anOperations) {
237       operations = anOperations;
238     }
239
240     public Object getValue(EntityAdapter anEntityAdapter) {
241       try {
242         Iterator i = operations.iterator();
243         List availableOperations = new Vector();
244
245         while (i.hasNext()) {
246           MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation =
247             (MirAdminInterfaceLocalizer.MirSimpleEntityOperation) i.next();
248
249           if (operation.isAvailable(anEntityAdapter)) {
250             availableOperations.add(operation.getName());
251           }
252         };
253
254         return availableOperations;
255       }
256       catch (Throwable t) {
257         throw new RuntimeException(t.getMessage());
258       }
259     }
260   }
261
262   protected class FilteredField implements EntityAdapterDefinition.CalculatedField {
263     private String fieldName;
264
265     public FilteredField(String aFieldName) {
266       fieldName = aFieldName;
267     }
268
269     public Object getValue(EntityAdapter anEntityAdapter) {
270       try {
271         if (anEntityAdapter.get("is_html")!=null && anEntityAdapter.get("is_html").equals("1")) {
272           return MirGlobal.localizer().producerAssistant().filterHTMLText((String) anEntityAdapter.get(fieldName));
273         }
274         else {
275           return MirGlobal.localizer().producerAssistant().filterNonHTMLText((String) anEntityAdapter.get(fieldName));
276         }
277       }
278       catch (Throwable t) {
279         throw new RuntimeException(t.getMessage());
280       }
281     }
282   }
283
284   protected class StructuredContentField implements EntityAdapterDefinition.CalculatedField {
285     private String expression;
286
287     public StructuredContentField(String anExpression) {
288       expression = anExpression;
289     }
290
291     public Object getValue(EntityAdapter anEntityAdapter) {
292       try {
293         return StructuredContentParser.parse(ParameterExpander.evaluateStringExpression(anEntityAdapter, expression));
294       }
295       catch (Throwable t) {
296         throw new RuntimeException(t.getMessage());
297       }
298     }
299   }
300
301   protected class ExpandedField implements EntityAdapterDefinition.CalculatedField {
302     private String expression;
303
304     public ExpandedField(String anExpression) {
305       expression = anExpression;
306     }
307
308     public Object getValue(EntityAdapter anEntityAdapter) {
309       try {
310         return ParameterExpander.expandExpression(anEntityAdapter, expression);
311       }
312       catch (Throwable t) {
313         throw new RuntimeException(t.getMessage());
314       }
315     }
316   }
317
318   protected class EvaluatedField implements EntityAdapterDefinition.CalculatedField {
319     private String expression;
320
321     public EvaluatedField(String anExpression) {
322       expression = anExpression;
323     }
324
325     public Object getValue(EntityAdapter anEntityAdapter) {
326       try {
327         return ParameterExpander.evaluateExpression(anEntityAdapter, expression);
328       }
329       catch (Throwable t) {
330         throw new RuntimeException(t.getMessage());
331       }
332     }
333   }
334
335   protected class ContentToParentField implements EntityAdapterDefinition.CalculatedField {
336     public Object getValue(EntityAdapter anEntityAdapter) {
337       try {
338         logger.debug("ContentToParentField.getValue");
339         return anEntityAdapter.getToOneRelation(
340                     "id="+anEntityAdapter.get("to_content"),
341                     "id",
342                     "content" );
343       }
344       catch (Throwable t) {
345         throw new RuntimeException(t.getMessage());
346       }
347     }
348   }
349
350   protected class ContentToChildrenField implements EntityAdapterDefinition.CalculatedField {
351     public Object getValue(EntityAdapter anEntityAdapter) {
352       try {
353         return anEntityAdapter.getRelation(
354                     "to_content="+anEntityAdapter.get("id"),
355                     "id",
356                     "content" );
357       }
358       catch (Throwable t) {
359         throw new RuntimeException(t.getMessage());
360       }
361     }
362   }
363
364   protected class ContentToLanguageField implements EntityAdapterDefinition.CalculatedField {
365     public Object getValue(EntityAdapter anEntityAdapter) {
366       try {
367         return anEntityAdapter.getToOneRelation(
368                     "id="+anEntityAdapter.get("to_language"),
369                     "id",
370                     "language" );
371       }
372       catch (Throwable t) {
373         throw new RuntimeException(t.getMessage());
374       }
375     }
376   }
377
378   protected class ContentToArticleTypeField implements EntityAdapterDefinition.CalculatedField {
379     public Object getValue(EntityAdapter anEntityAdapter) {
380       try {
381         return anEntityAdapter.getToOneRelation(
382                     "id="+anEntityAdapter.get("to_article_type"),
383                     "id",
384                     "articleType" );
385       }
386       catch (Throwable t) {
387         throw new RuntimeException(t.getMessage());
388       }
389     }
390   }
391
392   protected class ContentToCommentsField implements EntityAdapterDefinition.CalculatedField {
393     private String extracondition;
394     private String order;
395
396     public ContentToCommentsField() {
397       this ( " and is_published='1'", "webdb_create");
398     }
399
400     public ContentToCommentsField(String anExtraCondition, String anOrder) {
401       order = anOrder;
402       extracondition = anExtraCondition;
403     }
404
405     public Object getValue(EntityAdapter anEntityAdapter) {
406       try {
407         return anEntityAdapter.getRelation(
408                     "to_media="+anEntityAdapter.get("id")+" " + extracondition,
409                     order,
410                     "comment" );
411       }
412       catch (Throwable t) {
413         throw new RuntimeException(t.getMessage());
414       }
415     }
416   }
417
418   protected class ContentToTopicsField implements EntityAdapterDefinition.CalculatedField {
419     private String topicCondition;
420
421     public ContentToTopicsField() {
422       this(null);
423     }
424
425     public ContentToTopicsField(String aTopicCondition) {
426       topicCondition = aTopicCondition;
427     }
428
429     public Object getValue(EntityAdapter anEntityAdapter) {
430       try {
431         String condition = "exists (select * from content_x_topic where content_id="+anEntityAdapter.get("id")+" and topic_id=id)";
432         if (topicCondition!=null && topicCondition.length()>0)
433           condition = "(" + topicCondition + ") and " + condition;
434
435         return anEntityAdapter.getRelation(
436                     condition,
437                     "title",
438                     "topic" );
439       }
440       catch (Throwable t) {
441         throw new RuntimeException(t.getMessage());
442       }
443     }
444   }
445
446   protected class ContentToMediaField implements EntityAdapterDefinition.CalculatedField {
447     private String definition;
448     private boolean published;
449
450     public ContentToMediaField(String aDefinition, boolean anOnlyPublished) {
451       definition = aDefinition;
452       published = anOnlyPublished;
453     }
454
455     public ContentToMediaField(String aDefinition) {
456       this(aDefinition, true);
457     }
458
459     public Object getValue(EntityAdapter anEntityAdapter) {
460       try {
461         String condition = "exists (select * from content_x_media where content_id="+anEntityAdapter.get("id")+" and media_id=id)";
462         if (published)
463           condition = "is_published='t' and " + condition;
464         return anEntityAdapter.getRelation(
465            condition,
466           "id",
467           definition);
468       }
469       catch (Throwable t) {
470         throw new RuntimeException(t.getMessage());
471       }
472     }
473   }
474
475   protected class CommentToMediaField implements EntityAdapterDefinition.CalculatedField {
476     private String definition;
477     private boolean published;
478
479     public CommentToMediaField(String aDefinition, boolean anOnlyPublished) {
480       definition = aDefinition;
481       published = anOnlyPublished;
482     }
483
484     public CommentToMediaField(String aDefinition) {
485       this(aDefinition, true);
486     }
487
488     public Object getValue(EntityAdapter anEntityAdapter) {
489       try {
490         String condition = "exists (select * from comment_x_media where comment_id="+anEntityAdapter.get("id")+" and media_id=id)";
491         if (published)
492           condition = "is_published='t' and " + condition;
493         return anEntityAdapter.getRelation(
494            condition,
495           "id",
496           definition);
497       }
498       catch (Throwable t) {
499         throw new RuntimeException(t.getMessage());
500       }
501     }
502   }
503
504   protected class ContentToIconField implements EntityAdapterDefinition.CalculatedField {
505     public Object getValue(EntityAdapter anEntityAdapter) {
506       EntityAdapter media;
507       Entity mediaType;
508       RewindableIterator iterator;
509       Map result;
510       MirMedia mediaHandler;
511       String tinyIcon;
512       String iconAlt;
513
514       try {
515         iterator = (RewindableIterator) (anEntityAdapter.get("to_uploaded_media"));
516         iterator.rewind();
517
518         tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyText");
519         iconAlt = "Text";
520
521         if (iterator.hasNext()) {
522           media = (EntityAdapter) iterator.next();
523
524           mediaType = ((EntityUploadedMedia) (media.getEntity())).getMediaType();
525           mediaHandler = MediaHelper.getHandler( mediaType );
526
527           if (mediaHandler.isVideo()) {
528             tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyVideo");
529             iconAlt = "Video";
530           }
531           else if (mediaHandler.isAudio()) {
532             tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyAudio");
533             iconAlt = "Audio";
534           }
535           else if (mediaHandler.isImage()) {
536             tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyImage");
537             iconAlt = "Image";
538           }
539           else {
540             tinyIcon = mediaHandler.getTinyIconName();
541             iconAlt = mediaHandler.getIconAltName();
542           }
543
544         }
545       }
546       catch (Throwable t) {
547         logger.error("ContentToIconField: " +t.getMessage());
548         throw new RuntimeException(t.getMessage());
549       }
550
551       result = new HashMap();
552       result.put("tiny_icon", MirGlobal.config().getString("Producer.ImageRoot") + "/" + tinyIcon);
553       result.put("icon_alt", iconAlt);
554
555       return result;
556     }
557   }
558
559   protected class ContentCommentCountField implements EntityAdapterDefinition.CalculatedField {
560     private String extraCondition;
561
562     public ContentCommentCountField(String anExtraCondition) {
563       super();
564
565       extraCondition = anExtraCondition;
566     }
567
568     public Object getValue(EntityAdapter anEntityAdapter) {
569       try {
570         return Integer.toString(
571             DatabaseComment.getInstance().getSize(
572                   "to_media="+anEntityAdapter.get("id")+" " + extraCondition));
573       }
574       catch (Throwable t) {
575         throw new RuntimeException(t.getMessage());
576       }
577     }
578   }
579 }