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(""));
103 anEntityAdapterDefinition.addCalculatedField("mediacount", new ContentMediaCountField("uploaded_media", true));
104 anEntityAdapterDefinition.addCalculatedField("fullmediacount", new ContentMediaCountField("uploaded_media", false));
106 anEntityAdapterDefinition.addCalculatedField("to_media_images", new ContentToMediaField( "image" ));
107 anEntityAdapterDefinition.addCalculatedField("to_media_audio", new ContentToMediaField( "audio" ));
108 anEntityAdapterDefinition.addCalculatedField("to_media_video", new ContentToMediaField( "video" ));
109 anEntityAdapterDefinition.addCalculatedField("to_media_other", new ContentToMediaField( "otherMedia" ));
110 anEntityAdapterDefinition.addCalculatedField("to_all_uploaded_media", new ContentToMediaField( "uploadedMedia", false));
111 anEntityAdapterDefinition.addCalculatedField("to_all_media_images", new ContentToMediaField( "image", false));
112 anEntityAdapterDefinition.addCalculatedField("to_all_media_audio", new ContentToMediaField( "audio", false));
113 anEntityAdapterDefinition.addCalculatedField("to_all_media_video", new ContentToMediaField( "video", false));
114 anEntityAdapterDefinition.addCalculatedField("to_all_media_other", new ContentToMediaField( "otherMedia", false));
115 anEntityAdapterDefinition.addCalculatedField("to_media_icon", new ContentToIconField());
117 anEntityAdapterDefinition.addCalculatedField("article_type", new ContentToArticleTypeField());
119 anEntityAdapterDefinition.addCalculatedField("description_parsed", new FilteredField("description"));
120 anEntityAdapterDefinition.addCalculatedField("content_data_parsed", new FilteredField("content_data"));
122 anEntityAdapterDefinition.addCalculatedField("children", new ContentToChildrenField());
123 anEntityAdapterDefinition.addCalculatedField("parent", new ContentToParentField());
125 anEntityAdapterDefinition.addCalculatedField("publicurl", new ExpandedField(configuration.getString("Article.PublicUrl")));
127 anEntityAdapterDefinition.addCalculatedField("operations",
128 new EntityToSimpleOperationsField(MirGlobal.localizer().adminInterface().simpleArticleOperations()));
130 catch (Throwable t) {
131 throw new MirLocalizerFailure(t.getMessage(), t);
135 protected void constructCommentAdapterDefinition(EntityAdapterDefinition anEntityAdapterDefinition) throws MirLocalizerFailure {
137 anEntityAdapterDefinition.addDBDateField("creationdate", "webdb_create", configuration.getString("Mir.DefaultTimezone"));
138 anEntityAdapterDefinition.addCalculatedField("to_content", new CommentToContentField());
139 anEntityAdapterDefinition.addCalculatedField("status", new CommentToStatusField());
141 anEntityAdapterDefinition.addCalculatedField("to_uploaded_media", new CommentToMediaField( "uploadedMedia" ));
142 anEntityAdapterDefinition.addCalculatedField("to_media_images", new CommentToMediaField( "image" ));
143 anEntityAdapterDefinition.addCalculatedField("to_media_audio", new CommentToMediaField( "audio" ));
144 anEntityAdapterDefinition.addCalculatedField("to_media_video", new CommentToMediaField( "video" ));
145 anEntityAdapterDefinition.addCalculatedField("to_media_other", new CommentToMediaField( "otherMedia" ));
146 anEntityAdapterDefinition.addCalculatedField("to_all_uploaded_media", new CommentToMediaField( "uploadedMedia", false));
147 anEntityAdapterDefinition.addCalculatedField("to_all_media_images", new CommentToMediaField( "image", false));
148 anEntityAdapterDefinition.addCalculatedField("to_all_media_audio", new CommentToMediaField( "audio", false));
149 anEntityAdapterDefinition.addCalculatedField("to_all_media_video", new CommentToMediaField( "video", false));
150 anEntityAdapterDefinition.addCalculatedField("to_all_media_other", new CommentToMediaField( "otherMedia", false));
152 anEntityAdapterDefinition.addCalculatedField("publicurl", new ExpandedField(configuration.getString("Comment.PublicUrl")));
154 anEntityAdapterDefinition.addCalculatedField("description_parsed", new FilteredField("description"));
155 anEntityAdapterDefinition.addCalculatedField("operations",
156 new EntityToSimpleOperationsField(MirGlobal.localizer().adminInterface().simpleCommentOperations()));
158 catch (Throwable t) {
159 throw new MirLocalizerFailure(t.getMessage(), t);
163 public EntityAdapterModel adapterModel() throws MirLocalizerFailure, MirLocalizerExc {
164 EntityAdapterModel result = new EntityAdapterModel();
167 EntityAdapterDefinition definition;
169 definition = new EntityAdapterDefinition();
170 constructContentAdapterDefinition( definition );
171 result.addMapping( "content", DatabaseContent.getInstance(), definition);
173 definition = new EntityAdapterDefinition();
174 constructCommentAdapterDefinition( definition );
175 result.addMapping( "comment", DatabaseComment.getInstance(), definition);
177 result.addMapping( "articleType", DatabaseArticleType.getInstance(), new EntityAdapterDefinition());
178 result.addMapping( "commentStatus", DatabaseCommentStatus.getInstance(), new EntityAdapterDefinition());
180 definition = new EntityAdapterDefinition();
181 definition.addDBDateField("creationdate", "webdb_create", configuration.getString("Mir.DefaultTimezone"));
182 result.addMapping( "breakingNews", DatabaseBreaking.getInstance(), definition);
184 definition = new EntityAdapterDefinition();
185 definition.addDBDateField("creationdate", "webdb_create", configuration.getString("Mir.DefaultTimezone"));
186 result.addMapping( "internalMessage", DatabaseMessages.getInstance(), definition);
188 definition = new EntityAdapterDefinition();
189 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
190 result.addMapping( "uploadedMedia", DatabaseUploadedMedia.getInstance(), definition);
191 definition = new EntityAdapterDefinition();
192 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
193 result.addMapping( "image", DatabaseImages.getInstance(), definition);
194 definition = new EntityAdapterDefinition();
195 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
196 result.addMapping( "audio", DatabaseAudio.getInstance(), definition);
197 definition = new EntityAdapterDefinition();
198 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
199 result.addMapping( "video", DatabaseVideo.getInstance(), definition);
200 definition = new EntityAdapterDefinition();
201 definition.addCalculatedField("mediafolder", new MediaToMediaFolderField());
202 result.addMapping( "otherMedia", DatabaseOther.getInstance(), definition);
205 result.addMapping( "mediaFolder", DatabaseMediafolder.getInstance(), new EntityAdapterDefinition());
206 result.addMapping( "imageType", DatabaseImageType.getInstance(), new EntityAdapterDefinition());
207 result.addMapping( "language", DatabaseLanguage.getInstance(), new EntityAdapterDefinition());
208 result.addMapping( "mediaType", DatabaseMediaType.getInstance(), new EntityAdapterDefinition());
209 result.addMapping( "topic", DatabaseTopics.getInstance(), new EntityAdapterDefinition());
210 result.addMapping( "user", DatabaseUsers.getInstance(), new EntityAdapterDefinition());
211 result.addMapping( "otherMedia", DatabaseOther.getInstance(), new EntityAdapterDefinition());
213 result.addMapping( "content_x_topic", DatabaseContentToTopics.getInstance(), new EntityAdapterDefinition());
216 catch (Throwable t) {
217 throw new MirLocalizerFailure(t.getMessage(), t);
223 protected class CommentToContentField implements EntityAdapterDefinition.CalculatedField {
224 public Object getValue(EntityAdapter anEntityAdapter) {
226 return anEntityAdapter.getToOneRelation(
227 "id="+anEntityAdapter.get("to_media"),
231 catch (Throwable t) {
232 throw new RuntimeException(t.getMessage());
237 protected class CommentToStatusField implements EntityAdapterDefinition.CalculatedField {
238 public Object getValue(EntityAdapter anEntityAdapter) {
240 return anEntityAdapter.getToOneRelation(
241 "id="+anEntityAdapter.get("to_comment_status"),
245 catch (Throwable t) {
246 throw new RuntimeException(t.getMessage());
251 protected class EntityToSimpleOperationsField implements EntityAdapterDefinition.CalculatedField {
252 private List operations;
254 public EntityToSimpleOperationsField(List anOperations) {
255 operations = anOperations;
258 public Object getValue(EntityAdapter anEntityAdapter) {
260 Iterator i = operations.iterator();
261 List availableOperations = new Vector();
263 while (i.hasNext()) {
264 MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation =
265 (MirAdminInterfaceLocalizer.MirSimpleEntityOperation) i.next();
267 if (operation.isAvailable(anEntityAdapter)) {
268 availableOperations.add(operation.getName());
272 return availableOperations;
274 catch (Throwable t) {
275 throw new RuntimeException(t.getMessage());
280 protected class FilteredField implements EntityAdapterDefinition.CalculatedField {
281 private String fieldName;
283 public FilteredField(String aFieldName) {
284 fieldName = aFieldName;
287 public Object getValue(EntityAdapter anEntityAdapter) {
289 if (anEntityAdapter.get("is_html")!=null && anEntityAdapter.get("is_html").equals("1")) {
290 return MirGlobal.localizer().producerAssistant().filterHTMLText((String) anEntityAdapter.get(fieldName));
293 return MirGlobal.localizer().producerAssistant().filterNonHTMLText((String) anEntityAdapter.get(fieldName));
296 catch (Throwable t) {
297 throw new RuntimeException(t.getMessage());
302 protected class StructuredContentField implements EntityAdapterDefinition.CalculatedField {
303 private String expression;
305 public StructuredContentField(String anExpression) {
306 expression = anExpression;
309 public Object getValue(EntityAdapter anEntityAdapter) {
311 return StructuredContentParser.parse(ParameterExpander.evaluateStringExpression(anEntityAdapter, expression));
313 catch (Throwable t) {
314 throw new RuntimeException(t.getMessage());
319 protected class ExpandedField implements EntityAdapterDefinition.CalculatedField {
320 private String expression;
322 public ExpandedField(String anExpression) {
323 expression = anExpression;
326 public Object getValue(EntityAdapter anEntityAdapter) {
328 return ParameterExpander.expandExpression(anEntityAdapter, expression);
330 catch (Throwable t) {
331 throw new RuntimeException(t.getMessage());
336 protected class EvaluatedField implements EntityAdapterDefinition.CalculatedField {
337 private String expression;
339 public EvaluatedField(String anExpression) {
340 expression = anExpression;
343 public Object getValue(EntityAdapter anEntityAdapter) {
345 return ParameterExpander.evaluateExpression(anEntityAdapter, expression);
347 catch (Throwable t) {
348 throw new RuntimeException(t.getMessage());
353 protected class ContentToParentField implements EntityAdapterDefinition.CalculatedField {
354 public Object getValue(EntityAdapter anEntityAdapter) {
356 logger.debug("ContentToParentField.getValue");
357 return anEntityAdapter.getToOneRelation(
358 "id="+anEntityAdapter.get("to_content"),
362 catch (Throwable t) {
363 throw new RuntimeException(t.getMessage());
368 protected class ContentToChildrenField implements EntityAdapterDefinition.CalculatedField {
369 public Object getValue(EntityAdapter anEntityAdapter) {
371 return anEntityAdapter.getRelation(
372 "to_content="+anEntityAdapter.get("id"),
376 catch (Throwable t) {
377 throw new RuntimeException(t.getMessage());
382 protected class ContentToLanguageField implements EntityAdapterDefinition.CalculatedField {
383 public Object getValue(EntityAdapter anEntityAdapter) {
385 return anEntityAdapter.getToOneRelation(
386 "id="+anEntityAdapter.get("to_language"),
390 catch (Throwable t) {
391 throw new RuntimeException(t.getMessage());
396 protected class ContentToArticleTypeField implements EntityAdapterDefinition.CalculatedField {
397 public Object getValue(EntityAdapter anEntityAdapter) {
399 return anEntityAdapter.getToOneRelation(
400 "id="+anEntityAdapter.get("to_article_type"),
404 catch (Throwable t) {
405 throw new RuntimeException(t.getMessage());
410 protected class MediaToMediaFolderField implements EntityAdapterDefinition.CalculatedField {
411 public Object getValue(EntityAdapter anEntityAdapter) {
413 return anEntityAdapter.getToOneRelation(
414 "id="+anEntityAdapter.get("to_media_folder"),
418 catch (Throwable t) {
419 throw new RuntimeException(t.getMessage());
424 protected class ContentToCommentsField implements EntityAdapterDefinition.CalculatedField {
425 private String extracondition;
426 private String order;
428 public ContentToCommentsField() {
429 this ( " and is_published='1'", "webdb_create");
432 public ContentToCommentsField(String anExtraCondition, String anOrder) {
434 extracondition = anExtraCondition;
437 public Object getValue(EntityAdapter anEntityAdapter) {
439 return anEntityAdapter.getRelation(
440 "to_media="+anEntityAdapter.get("id")+" " + extracondition,
444 catch (Throwable t) {
445 throw new RuntimeException(t.getMessage());
450 protected class ContentToTopicsField implements EntityAdapterDefinition.CalculatedField {
451 private String topicCondition;
452 private String topicOrder;
454 public ContentToTopicsField() {
458 public ContentToTopicsField(String aTopicCondition) {
459 this(aTopicCondition, "title");
462 public ContentToTopicsField(String aTopicCondition, String aTopicOrder) {
463 topicCondition = aTopicCondition;
464 topicOrder = aTopicOrder;
467 public Object getValue(EntityAdapter anEntityAdapter) {
470 Vector extraTable = new Vector();
471 extraTable.add("content_x_topic cxt");
472 String condition = "cxt.content_id="+anEntityAdapter.get("id")+
473 " and cxt.topic_id=t.id";
475 if (topicCondition!=null && topicCondition.length()>0)
476 condition = "(" + topicCondition + ") and " + condition;
478 return anEntityAdapter.getComplexRelation("t", extraTable,
479 condition, topicOrder, "topic" );
481 catch (Throwable t) {
482 throw new RuntimeException(t.getMessage());
487 protected class ContentToMediaField implements EntityAdapterDefinition.CalculatedField {
488 private String definition;
489 private boolean published;
491 public ContentToMediaField(String aDefinition, boolean anOnlyPublished) {
492 definition = aDefinition;
493 published = anOnlyPublished;
496 public ContentToMediaField(String aDefinition) {
497 this(aDefinition, true);
500 public Object getValue(EntityAdapter anEntityAdapter) {
502 String condition = "cxm.content_id="+ anEntityAdapter.get("id") +
503 " and cxm.media_id = m.id";
505 condition = "is_published='t' and " + condition;
507 List extraTables = new Vector();
508 extraTables.add("content_x_media cxm");
510 return anEntityAdapter.getComplexRelation("m", extraTables, condition, "id", definition);
512 catch (Throwable t) {
513 throw new RuntimeException(t.getMessage());
518 protected class CommentToMediaField implements EntityAdapterDefinition.CalculatedField {
519 private String definition;
520 private boolean published;
522 public CommentToMediaField(String aDefinition, boolean anOnlyPublished) {
523 definition = aDefinition;
524 published = anOnlyPublished;
527 public CommentToMediaField(String aDefinition) {
528 this(aDefinition, true);
531 public Object getValue(EntityAdapter anEntityAdapter) {
534 String condition = "cxm.comment_id="+ anEntityAdapter.get("id") +
535 " and cxm.media_id = m.id";
537 condition = "is_published='t' and " + condition;
539 List extraTables = new Vector();
540 extraTables.add("comment_x_media cxm");
541 return anEntityAdapter.getComplexRelation("m", extraTables, condition, "id", definition);
544 catch (Throwable t) {
545 throw new RuntimeException(t.getMessage());
550 protected class ContentToIconField implements EntityAdapterDefinition.CalculatedField {
551 public Object getValue(EntityAdapter anEntityAdapter) {
554 RewindableIterator iterator;
556 MirMedia mediaHandler;
561 iterator = (RewindableIterator) (anEntityAdapter.get("to_uploaded_media"));
564 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyText");
567 if (iterator.hasNext()) {
568 media = (EntityAdapter) iterator.next();
570 mediaType = ((EntityUploadedMedia) (media.getEntity())).getMediaType();
571 mediaHandler = MediaHelper.getHandler( mediaType );
573 if (mediaHandler.isVideo()) {
574 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyVideo");
577 else if (mediaHandler.isAudio()) {
578 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyAudio");
581 else if (mediaHandler.isImage()) {
582 tinyIcon = MirGlobal.config().getString("Producer.Icon.TinyImage");
586 tinyIcon = mediaHandler.getTinyIconName();
587 iconAlt = mediaHandler.getIconAltName();
592 catch (Throwable t) {
593 logger.error("ContentToIconField: " +t.getMessage());
594 throw new RuntimeException(t.getMessage());
597 result = new HashMap();
598 result.put("tiny_icon", MirGlobal.config().getString("Producer.ImageRoot") + "/" + tinyIcon);
599 result.put("icon_alt", iconAlt);
605 protected class ContentCommentCountField implements EntityAdapterDefinition.CalculatedField {
606 private String extraCondition;
608 public ContentCommentCountField(String anExtraCondition) {
611 extraCondition = anExtraCondition;
614 public Object getValue(EntityAdapter anEntityAdapter) {
616 return Integer.toString(
617 DatabaseComment.getInstance().getSize(
618 "to_media="+anEntityAdapter.get("id")+" " + extraCondition));
620 catch (Throwable t) {
621 throw new RuntimeException(t.getMessage());
626 protected class ContentMediaCountField implements EntityAdapterDefinition.CalculatedField {
627 private String table;
628 private boolean published;
630 public ContentMediaCountField(String aTable, boolean anOnlyPublished) {
632 published = anOnlyPublished;
635 public ContentMediaCountField(String aTable) {
639 public Object getValue(EntityAdapter anEntityAdapter) {
641 Vector extraTable = new Vector();
642 extraTable.add(table+" m");
643 String selectSql = "cxm.media_id=m.id";
645 selectSql+= " and m.is_published='t'";
647 return Integer.toString(
648 DatabaseContentToMedia.getInstance().getSize(
649 "cxm", extraTable, selectSql));
651 catch (Throwable t) {
652 throw new RuntimeException(t.getMessage());