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.localizer.basic;
32 import java.util.HashMap;
33 import java.util.Iterator;
34 import java.util.List;
36 import java.util.Vector;
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;
75 public class MirBasicDataModelLocalizer implements MirDataModelLocalizer {
76 protected LoggerWrapper logger;
77 protected MirPropertiesConfiguration configuration;
79 public MirBasicDataModelLocalizer() throws MirLocalizerFailure, MirLocalizerExc {
80 logger = new LoggerWrapper("Localizer.DataModel");
83 configuration = MirPropertiesConfiguration.instance();
86 throw new MirLocalizerFailure("Can't get configuration: " + e.getMessage(), e);
90 protected void constructContentAdapterDefinition(EntityAdapterDefinition anEntityAdapterDefinition) throws MirLocalizerFailure, MirLocalizerExc {
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());
99 anEntityAdapterDefinition.addCalculatedField("commentcount", new ContentCommentCountField(" and is_published='1'"));
100 anEntityAdapterDefinition.addCalculatedField("fullcommentcount", new ContentCommentCountField(""));
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());
114 anEntityAdapterDefinition.addCalculatedField("article_type", new ContentToArticleTypeField());
116 anEntityAdapterDefinition.addCalculatedField("description_parsed", new FilteredField("description"));
117 anEntityAdapterDefinition.addCalculatedField("content_data_parsed", new FilteredField("content_data"));
119 anEntityAdapterDefinition.addCalculatedField("children", new ContentToChildrenField());
120 anEntityAdapterDefinition.addCalculatedField("parent", new ContentToParentField());
122 anEntityAdapterDefinition.addCalculatedField("publicurl", new ExpandedField(configuration.getString("Article.PublicUrl")));
124 anEntityAdapterDefinition.addCalculatedField("operations",
125 new EntityToSimpleOperationsField(MirGlobal.localizer().adminInterface().simpleArticleOperations()));
127 catch (Throwable t) {
128 throw new MirLocalizerFailure(t.getMessage(), t);
132 protected void constructCommentAdapterDefinition(EntityAdapterDefinition anEntityAdapterDefinition) throws MirLocalizerFailure {
134 anEntityAdapterDefinition.addDBDateField("creationdate", "webdb_create");
135 anEntityAdapterDefinition.addCalculatedField("to_content", new CommentToContentField());
136 anEntityAdapterDefinition.addCalculatedField("status", new CommentToStatusField());
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));
149 anEntityAdapterDefinition.addCalculatedField("publicurl", new ExpandedField(configuration.getString("Comment.PublicUrl")));
151 anEntityAdapterDefinition.addCalculatedField("description_parsed", new FilteredField("description"));
152 anEntityAdapterDefinition.addCalculatedField("operations",
153 new EntityToSimpleOperationsField(MirGlobal.localizer().adminInterface().simpleCommentOperations()));
155 catch (Throwable t) {
156 throw new MirLocalizerFailure(t.getMessage(), t);
160 public EntityAdapterModel adapterModel() throws MirLocalizerFailure, MirLocalizerExc {
161 EntityAdapterModel result = new EntityAdapterModel();
164 EntityAdapterDefinition definition;
166 definition = new EntityAdapterDefinition();
167 constructContentAdapterDefinition( definition );
168 result.addMapping( "content", DatabaseContent.getInstance(), definition);
170 definition = new EntityAdapterDefinition();
171 constructCommentAdapterDefinition( definition );
172 result.addMapping( "comment", DatabaseComment.getInstance(), definition);
174 result.addMapping( "articleType", DatabaseArticleType.getInstance(), new EntityAdapterDefinition());
175 result.addMapping( "commentStatus", DatabaseCommentStatus.getInstance(), new EntityAdapterDefinition());
177 definition = new EntityAdapterDefinition();
178 definition.addDBDateField("creationdate", "webdb_create");
179 result.addMapping( "breakingNews", DatabaseBreaking.getInstance(), definition);
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());
195 result.addMapping( "content_x_topic", DatabaseContentToTopics.getInstance(), new EntityAdapterDefinition());
198 catch (Throwable t) {
199 throw new MirLocalizerFailure(t.getMessage(), t);
205 protected class CommentToContentField implements EntityAdapterDefinition.CalculatedField {
206 public Object getValue(EntityAdapter anEntityAdapter) {
208 return anEntityAdapter.getToOneRelation(
209 "id="+anEntityAdapter.get("to_media"),
213 catch (Throwable t) {
214 throw new RuntimeException(t.getMessage());
219 protected class CommentToStatusField implements EntityAdapterDefinition.CalculatedField {
220 public Object getValue(EntityAdapter anEntityAdapter) {
222 return anEntityAdapter.getToOneRelation(
223 "id="+anEntityAdapter.get("to_comment_status"),
227 catch (Throwable t) {
228 throw new RuntimeException(t.getMessage());
233 protected class EntityToSimpleOperationsField implements EntityAdapterDefinition.CalculatedField {
234 private List operations;
236 public EntityToSimpleOperationsField(List anOperations) {
237 operations = anOperations;
240 public Object getValue(EntityAdapter anEntityAdapter) {
242 Iterator i = operations.iterator();
243 List availableOperations = new Vector();
245 while (i.hasNext()) {
246 MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation =
247 (MirAdminInterfaceLocalizer.MirSimpleEntityOperation) i.next();
249 if (operation.isAvailable(anEntityAdapter)) {
250 availableOperations.add(operation.getName());
254 return availableOperations;
256 catch (Throwable t) {
257 throw new RuntimeException(t.getMessage());
262 protected class FilteredField implements EntityAdapterDefinition.CalculatedField {
263 private String fieldName;
265 public FilteredField(String aFieldName) {
266 fieldName = aFieldName;
269 public Object getValue(EntityAdapter anEntityAdapter) {
271 if (anEntityAdapter.get("is_html")!=null && anEntityAdapter.get("is_html").equals("1")) {
272 return MirGlobal.localizer().producerAssistant().filterHTMLText((String) anEntityAdapter.get(fieldName));
275 return MirGlobal.localizer().producerAssistant().filterNonHTMLText((String) anEntityAdapter.get(fieldName));
278 catch (Throwable t) {
279 throw new RuntimeException(t.getMessage());
284 protected class StructuredContentField implements EntityAdapterDefinition.CalculatedField {
285 private String expression;
287 public StructuredContentField(String anExpression) {
288 expression = anExpression;
291 public Object getValue(EntityAdapter anEntityAdapter) {
293 return StructuredContentParser.parse(ParameterExpander.evaluateStringExpression(anEntityAdapter, expression));
295 catch (Throwable t) {
296 throw new RuntimeException(t.getMessage());
301 protected class ExpandedField implements EntityAdapterDefinition.CalculatedField {
302 private String expression;
304 public ExpandedField(String anExpression) {
305 expression = anExpression;
308 public Object getValue(EntityAdapter anEntityAdapter) {
310 return ParameterExpander.expandExpression(anEntityAdapter, expression);
312 catch (Throwable t) {
313 throw new RuntimeException(t.getMessage());
318 protected class EvaluatedField implements EntityAdapterDefinition.CalculatedField {
319 private String expression;
321 public EvaluatedField(String anExpression) {
322 expression = anExpression;
325 public Object getValue(EntityAdapter anEntityAdapter) {
327 return ParameterExpander.evaluateExpression(anEntityAdapter, expression);
329 catch (Throwable t) {
330 throw new RuntimeException(t.getMessage());
335 protected class ContentToParentField implements EntityAdapterDefinition.CalculatedField {
336 public Object getValue(EntityAdapter anEntityAdapter) {
338 logger.debug("ContentToParentField.getValue");
339 return anEntityAdapter.getToOneRelation(
340 "id="+anEntityAdapter.get("to_content"),
344 catch (Throwable t) {
345 throw new RuntimeException(t.getMessage());
350 protected class ContentToChildrenField implements EntityAdapterDefinition.CalculatedField {
351 public Object getValue(EntityAdapter anEntityAdapter) {
353 return anEntityAdapter.getRelation(
354 "to_content="+anEntityAdapter.get("id"),
358 catch (Throwable t) {
359 throw new RuntimeException(t.getMessage());
364 protected class ContentToLanguageField implements EntityAdapterDefinition.CalculatedField {
365 public Object getValue(EntityAdapter anEntityAdapter) {
367 return anEntityAdapter.getToOneRelation(
368 "id="+anEntityAdapter.get("to_language"),
372 catch (Throwable t) {
373 throw new RuntimeException(t.getMessage());
378 protected class ContentToArticleTypeField implements EntityAdapterDefinition.CalculatedField {
379 public Object getValue(EntityAdapter anEntityAdapter) {
381 return anEntityAdapter.getToOneRelation(
382 "id="+anEntityAdapter.get("to_article_type"),
386 catch (Throwable t) {
387 throw new RuntimeException(t.getMessage());
392 protected class ContentToCommentsField implements EntityAdapterDefinition.CalculatedField {
393 private String extracondition;
394 private String order;
396 public ContentToCommentsField() {
397 this ( " and is_published='1'", "webdb_create");
400 public ContentToCommentsField(String anExtraCondition, String anOrder) {
402 extracondition = anExtraCondition;
405 public Object getValue(EntityAdapter anEntityAdapter) {
407 return anEntityAdapter.getRelation(
408 "to_media="+anEntityAdapter.get("id")+" " + extracondition,
412 catch (Throwable t) {
413 throw new RuntimeException(t.getMessage());
418 protected class ContentToTopicsField implements EntityAdapterDefinition.CalculatedField {
419 private String topicCondition;
421 public ContentToTopicsField() {
425 public ContentToTopicsField(String aTopicCondition) {
426 topicCondition = aTopicCondition;
429 public Object getValue(EntityAdapter anEntityAdapter) {
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;
435 return anEntityAdapter.getRelation(
440 catch (Throwable t) {
441 throw new RuntimeException(t.getMessage());
446 protected class ContentToMediaField implements EntityAdapterDefinition.CalculatedField {
447 private String definition;
448 private boolean published;
450 public ContentToMediaField(String aDefinition, boolean anOnlyPublished) {
451 definition = aDefinition;
452 published = anOnlyPublished;
455 public ContentToMediaField(String aDefinition) {
456 this(aDefinition, true);
459 public Object getValue(EntityAdapter anEntityAdapter) {
461 String condition = "exists (select * from content_x_media where content_id="+anEntityAdapter.get("id")+" and media_id=id)";
463 condition = "is_published='t' and " + condition;
464 return anEntityAdapter.getRelation(
469 catch (Throwable t) {
470 throw new RuntimeException(t.getMessage());
475 protected class CommentToMediaField implements EntityAdapterDefinition.CalculatedField {
476 private String definition;
477 private boolean published;
479 public CommentToMediaField(String aDefinition, boolean anOnlyPublished) {
480 definition = aDefinition;
481 published = anOnlyPublished;
484 public CommentToMediaField(String aDefinition) {
485 this(aDefinition, true);
488 public Object getValue(EntityAdapter anEntityAdapter) {
490 String condition = "exists (select * from comment_x_media where comment_id="+anEntityAdapter.get("id")+" and media_id=id)";
492 condition = "is_published='t' and " + condition;
493 return anEntityAdapter.getRelation(
498 catch (Throwable t) {
499 throw new RuntimeException(t.getMessage());
504 protected class ContentToIconField implements EntityAdapterDefinition.CalculatedField {
505 public Object getValue(EntityAdapter anEntityAdapter) {
508 RewindableIterator iterator;
510 MirMedia mediaHandler;
515 iterator = (RewindableIterator) (anEntityAdapter.get("to_uploaded_media"));
518 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyText");
521 if (iterator.hasNext()) {
522 media = (EntityAdapter) iterator.next();
524 mediaType = ((EntityUploadedMedia) (media.getEntity())).getMediaType();
525 mediaHandler = MediaHelper.getHandler( mediaType );
527 if (mediaHandler.isVideo()) {
528 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyVideo");
531 else if (mediaHandler.isAudio()) {
532 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyAudio");
535 else if (mediaHandler.isImage()) {
536 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyImage");
540 tinyIcon = mediaHandler.getTinyIconName();
541 iconAlt = mediaHandler.getIconAltName();
546 catch (Throwable t) {
547 logger.error("ContentToIconField: " +t.getMessage());
548 throw new RuntimeException(t.getMessage());
551 result = new HashMap();
552 result.put("tiny_icon", MirGlobal.config().getString("Producer.ImageRoot") + "/" + tinyIcon);
553 result.put("icon_alt", iconAlt);
559 protected class ContentCommentCountField implements EntityAdapterDefinition.CalculatedField {
560 private String extraCondition;
562 public ContentCommentCountField(String anExtraCondition) {
565 extraCondition = anExtraCondition;
568 public Object getValue(EntityAdapter anEntityAdapter) {
570 return Integer.toString(
571 DatabaseComment.getInstance().getSize(
572 "to_media="+anEntityAdapter.get("id")+" " + extraCondition));
574 catch (Throwable t) {
575 throw new RuntimeException(t.getMessage());