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.DatabaseContentToMedia;
62 import mircoders.storage.DatabaseContentToTopics;
63 import mircoders.storage.DatabaseImageType;
64 import mircoders.storage.DatabaseImages;
65 import mircoders.storage.DatabaseLanguage;
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", configuration.getString("Mir.DefaultTimezone"));
93 anEntityAdapterDefinition.addDBDateField("changedate", "webdb_lastchange", configuration.getString("Mir.DefaultTimezone"));
94 anEntityAdapterDefinition.addMirDateField("date", "date", configuration.getString("Mir.DefaultTimezone"));
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", configuration.getString("Mir.DefaultTimezone"));
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", configuration.getString("Mir.DefaultTimezone"));
179 result.addMapping( "breakingNews", DatabaseBreaking.getInstance(), definition);
181 definition = new EntityAdapterDefinition();
182 definition.addDBDateField("creationdate", "webdb_create", configuration.getString("Mir.DefaultTimezone"));
183 result.addMapping( "internalMessage", DatabaseMessages.getInstance(), definition);
185 definition = new EntityAdapterDefinition();
186 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
187 result.addMapping( "uploadedMedia", DatabaseUploadedMedia.getInstance(), definition);
188 definition = new EntityAdapterDefinition();
189 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
190 result.addMapping( "image", DatabaseImages.getInstance(), definition);
191 definition = new EntityAdapterDefinition();
192 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
193 result.addMapping( "audio", DatabaseAudio.getInstance(), definition);
194 definition = new EntityAdapterDefinition();
195 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
196 result.addMapping( "video", DatabaseVideo.getInstance(), definition);
197 definition = new EntityAdapterDefinition();
198 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
199 result.addMapping( "otherMedia", DatabaseOther.getInstance(), definition);
202 result.addMapping( "mediaFolder", DatabaseMediafolder.getInstance(), new EntityAdapterDefinition());
203 result.addMapping( "imageType", DatabaseImageType.getInstance(), new EntityAdapterDefinition());
204 result.addMapping( "language", DatabaseLanguage.getInstance(), new EntityAdapterDefinition());
205 result.addMapping( "mediaType", DatabaseMediaType.getInstance(), new EntityAdapterDefinition());
206 result.addMapping( "topic", DatabaseTopics.getInstance(), new EntityAdapterDefinition());
207 result.addMapping( "user", DatabaseUsers.getInstance(), new EntityAdapterDefinition());
208 result.addMapping( "otherMedia", DatabaseOther.getInstance(), new EntityAdapterDefinition());
210 result.addMapping( "content_x_topic", DatabaseContentToTopics.getInstance(), new EntityAdapterDefinition());
213 catch (Throwable t) {
214 throw new MirLocalizerFailure(t.getMessage(), t);
220 protected class CommentToContentField implements EntityAdapterDefinition.CalculatedField {
221 public Object getValue(EntityAdapter anEntityAdapter) {
223 return anEntityAdapter.getToOneRelation(
224 "id="+anEntityAdapter.get("to_media"),
228 catch (Throwable t) {
229 throw new RuntimeException(t.getMessage());
234 protected class CommentToStatusField implements EntityAdapterDefinition.CalculatedField {
235 public Object getValue(EntityAdapter anEntityAdapter) {
237 return anEntityAdapter.getToOneRelation(
238 "id="+anEntityAdapter.get("to_comment_status"),
242 catch (Throwable t) {
243 throw new RuntimeException(t.getMessage());
248 protected class EntityToSimpleOperationsField implements EntityAdapterDefinition.CalculatedField {
249 private List operations;
251 public EntityToSimpleOperationsField(List anOperations) {
252 operations = anOperations;
255 public Object getValue(EntityAdapter anEntityAdapter) {
257 Iterator i = operations.iterator();
258 List availableOperations = new Vector();
260 while (i.hasNext()) {
261 MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation =
262 (MirAdminInterfaceLocalizer.MirSimpleEntityOperation) i.next();
264 if (operation.isAvailable(anEntityAdapter)) {
265 availableOperations.add(operation.getName());
269 return availableOperations;
271 catch (Throwable t) {
272 throw new RuntimeException(t.getMessage());
277 protected class FilteredField implements EntityAdapterDefinition.CalculatedField {
278 private String fieldName;
280 public FilteredField(String aFieldName) {
281 fieldName = aFieldName;
284 public Object getValue(EntityAdapter anEntityAdapter) {
286 if (anEntityAdapter.get("is_html")!=null && anEntityAdapter.get("is_html").equals("1")) {
287 return MirGlobal.localizer().producerAssistant().filterHTMLText((String) anEntityAdapter.get(fieldName));
290 return MirGlobal.localizer().producerAssistant().filterNonHTMLText((String) anEntityAdapter.get(fieldName));
293 catch (Throwable t) {
294 throw new RuntimeException(t.getMessage());
299 protected class StructuredContentField implements EntityAdapterDefinition.CalculatedField {
300 private String expression;
302 public StructuredContentField(String anExpression) {
303 expression = anExpression;
306 public Object getValue(EntityAdapter anEntityAdapter) {
308 return StructuredContentParser.parse(ParameterExpander.evaluateStringExpression(anEntityAdapter, expression));
310 catch (Throwable t) {
311 throw new RuntimeException(t.getMessage());
316 protected class ExpandedField implements EntityAdapterDefinition.CalculatedField {
317 private String expression;
319 public ExpandedField(String anExpression) {
320 expression = anExpression;
323 public Object getValue(EntityAdapter anEntityAdapter) {
325 return ParameterExpander.expandExpression(anEntityAdapter, expression);
327 catch (Throwable t) {
328 throw new RuntimeException(t.getMessage());
333 protected class EvaluatedField implements EntityAdapterDefinition.CalculatedField {
334 private String expression;
336 public EvaluatedField(String anExpression) {
337 expression = anExpression;
340 public Object getValue(EntityAdapter anEntityAdapter) {
342 return ParameterExpander.evaluateExpression(anEntityAdapter, expression);
344 catch (Throwable t) {
345 throw new RuntimeException(t.getMessage());
350 protected class ContentToParentField implements EntityAdapterDefinition.CalculatedField {
351 public Object getValue(EntityAdapter anEntityAdapter) {
353 logger.debug("ContentToParentField.getValue");
354 return anEntityAdapter.getToOneRelation(
355 "id="+anEntityAdapter.get("to_content"),
359 catch (Throwable t) {
360 throw new RuntimeException(t.getMessage());
365 protected class ContentToChildrenField implements EntityAdapterDefinition.CalculatedField {
366 public Object getValue(EntityAdapter anEntityAdapter) {
368 return anEntityAdapter.getRelation(
369 "to_content="+anEntityAdapter.get("id"),
373 catch (Throwable t) {
374 throw new RuntimeException(t.getMessage());
379 protected class ContentToLanguageField implements EntityAdapterDefinition.CalculatedField {
380 public Object getValue(EntityAdapter anEntityAdapter) {
382 return anEntityAdapter.getToOneRelation(
383 "id="+anEntityAdapter.get("to_language"),
387 catch (Throwable t) {
388 throw new RuntimeException(t.getMessage());
393 protected class ContentToArticleTypeField implements EntityAdapterDefinition.CalculatedField {
394 public Object getValue(EntityAdapter anEntityAdapter) {
396 return anEntityAdapter.getToOneRelation(
397 "id="+anEntityAdapter.get("to_article_type"),
401 catch (Throwable t) {
402 throw new RuntimeException(t.getMessage());
407 protected class MediaToMediaFolderField implements EntityAdapterDefinition.CalculatedField {
408 public Object getValue(EntityAdapter anEntityAdapter) {
410 return anEntityAdapter.getToOneRelation(
411 "id="+anEntityAdapter.get("to_media_folder"),
415 catch (Throwable t) {
416 throw new RuntimeException(t.getMessage());
421 protected class ContentToCommentsField implements EntityAdapterDefinition.CalculatedField {
422 private String extracondition;
423 private String order;
425 public ContentToCommentsField() {
426 this ( " and is_published='1'", "webdb_create");
429 public ContentToCommentsField(String anExtraCondition, String anOrder) {
431 extracondition = anExtraCondition;
434 public Object getValue(EntityAdapter anEntityAdapter) {
436 return anEntityAdapter.getRelation(
437 "to_media="+anEntityAdapter.get("id")+" " + extracondition,
441 catch (Throwable t) {
442 throw new RuntimeException(t.getMessage());
447 protected class ContentToTopicsField implements EntityAdapterDefinition.CalculatedField {
448 private String topicCondition;
449 private String topicOrder;
451 public ContentToTopicsField() {
455 public ContentToTopicsField(String aTopicCondition) {
456 this(aTopicCondition, "title");
459 public ContentToTopicsField(String aTopicCondition, String aTopicOrder) {
460 topicCondition = aTopicCondition;
461 topicOrder = aTopicOrder;
464 // TODO rewrite as relational select
465 public Object getValue(EntityAdapter anEntityAdapter) {
467 String condition = "exists (select * from content_x_topic where content_id="+anEntityAdapter.get("id")+" and topic_id=id)";
468 if (topicCondition!=null && topicCondition.length()>0)
469 condition = "(" + topicCondition + ") and " + condition;
471 return anEntityAdapter.getRelation(
476 catch (Throwable t) {
477 throw new RuntimeException(t.getMessage());
482 protected class ContentToMediaField implements EntityAdapterDefinition.CalculatedField {
483 private String definition;
484 private boolean published;
486 public ContentToMediaField(String aDefinition, boolean anOnlyPublished) {
487 definition = aDefinition;
488 published = anOnlyPublished;
491 public ContentToMediaField(String aDefinition) {
492 this(aDefinition, true);
495 public Object getValue(EntityAdapter anEntityAdapter) {
497 // TODO rewrite as relational select
498 String condition = "exists (select * from content_x_media where content_id="+anEntityAdapter.get("id")+" and media_id=id)";
500 condition = "is_published='t' and " + condition;
501 return anEntityAdapter.getRelation(
506 catch (Throwable t) {
507 throw new RuntimeException(t.getMessage());
512 protected class CommentToMediaField implements EntityAdapterDefinition.CalculatedField {
513 private String definition;
514 private boolean published;
516 public CommentToMediaField(String aDefinition, boolean anOnlyPublished) {
517 definition = aDefinition;
518 published = anOnlyPublished;
521 public CommentToMediaField(String aDefinition) {
522 this(aDefinition, true);
525 public Object getValue(EntityAdapter anEntityAdapter) {
527 // TODO rewrite as relational select
528 String condition = "exists (select * from comment_x_media where comment_id="+anEntityAdapter.get("id")+" and media_id=id)";
530 condition = "is_published='t' and " + condition;
531 return anEntityAdapter.getRelation(
536 catch (Throwable t) {
537 throw new RuntimeException(t.getMessage());
542 protected class ContentToIconField implements EntityAdapterDefinition.CalculatedField {
543 public Object getValue(EntityAdapter anEntityAdapter) {
546 RewindableIterator iterator;
548 MirMedia mediaHandler;
553 iterator = (RewindableIterator) (anEntityAdapter.get("to_uploaded_media"));
556 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyText");
559 if (iterator.hasNext()) {
560 media = (EntityAdapter) iterator.next();
562 mediaType = ((EntityUploadedMedia) (media.getEntity())).getMediaType();
563 mediaHandler = MediaHelper.getHandler( mediaType );
565 if (mediaHandler.isVideo()) {
566 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyVideo");
569 else if (mediaHandler.isAudio()) {
570 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyAudio");
573 else if (mediaHandler.isImage()) {
574 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyImage");
578 tinyIcon = mediaHandler.getTinyIconName();
579 iconAlt = mediaHandler.getIconAltName();
584 catch (Throwable t) {
585 logger.error("ContentToIconField: " +t.getMessage());
586 throw new RuntimeException(t.getMessage());
589 result = new HashMap();
590 result.put("tiny_icon", MirGlobal.config().getString("Producer.ImageRoot") + "/" + tinyIcon);
591 result.put("icon_alt", iconAlt);
597 protected class ContentCommentCountField implements EntityAdapterDefinition.CalculatedField {
598 private String extraCondition;
600 public ContentCommentCountField(String anExtraCondition) {
603 extraCondition = anExtraCondition;
606 public Object getValue(EntityAdapter anEntityAdapter) {
608 return Integer.toString(
609 DatabaseComment.getInstance().getSize(
610 "to_media="+anEntityAdapter.get("id")+" " + extraCondition));
612 catch (Throwable t) {
613 throw new RuntimeException(t.getMessage());
618 protected class ContentMediaCountField implements EntityAdapterDefinition.CalculatedField {
619 private String table;
620 private boolean published;
622 public ContentMediaCountField(String aTable, boolean anOnlyPublished) {
624 published = anOnlyPublished;
627 public ContentMediaCountField(String aTable) {
631 public Object getValue(EntityAdapter anEntityAdapter) {
633 String subQuery = "select * from "+table+" where id = media_id";
635 subQuery = subQuery + " and is_published='t'";
637 return Integer.toString(
638 DatabaseContentToMedia.getInstance().getSize(
639 "exists ("+subQuery+")"));
641 catch (Throwable t) {
642 throw new RuntimeException(t.getMessage());