added:
[mir.git] / source / mircoders / localizer / basic / MirBasicAdminInterfaceLocalizer.java
index e680a6c..ccdb4a8 100755 (executable)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2001, 2002  The Mir-coders group
+ * Copyright (C) 2001, 2002 The Mir-coders group
  *
  * This file is part of Mir.
  *
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  * In addition, as a special exception, The Mir-coders gives permission to link
- * the code of this program with the com.oreilly.servlet library, any library
- * licensed under the Apache Software License, The Sun (tm) Java Advanced
- * Imaging library (JAI), The Sun JIMI library (or with modified versions of
- * the above that use the same license as the above), and distribute linked
- * combinations including the two.  You must obey the GNU General Public
- * License in all respects for all of the code used other than the above
- * mentioned libraries.  If you modify this file, you may extend this exception
- * to your version of the file, but you are not obligated to do so.  If you do
- * not wish to do so, delete this exception statement from your version.
+ * the code of this program with  any library licensed under the Apache Software License,
+ * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
+ * (or with modified versions of the above that use the same license as the above),
+ * and distribute linked combinations including the two.  You must obey the
+ * GNU General Public License in all respects for all of the code used other than
+ * the above mentioned libraries.  If you modify this file, you may extend this
+ * exception to your version of the file, but you are not obligated to do so.
+ * If you do not wish to do so, delete this exception statement from your version.
  */
 
 package mircoders.localizer.basic;
 
-import java.util.*;
-import mir.entity.adapter.*;
-import mir.storage.*;
-import mir.entity.*;
-import mircoders.localizer.*;
-import mircoders.entity.*;
-import mircoders.storage.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.GregorianCalendar;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import mir.bundle.Bundle;
+import mir.config.MirPropertiesConfiguration;
+import mir.entity.Entity;
+import mir.entity.adapter.EntityAdapter;
+import mir.entity.adapter.EntityAdapterFailure;
+import mir.generator.Generator;
+import mir.generator.GeneratorExc;
+import mir.log.LoggerWrapper;
+import mir.misc.StringUtil;
+import mir.module.ModuleExc;
+import mir.storage.DatabaseFailure;
+import mir.util.DateTimeRoutines;
+import mir.util.EntityUtility;
+import mir.util.StringRoutines;
+import mir.util.generator.BundleGeneratorFunction;
+import mircoders.entity.EntityComment;
+import mircoders.entity.EntityContent;
+import mircoders.global.MirGlobal;
+import mircoders.localizer.MirAdminInterfaceLocalizer;
+import mircoders.localizer.MirLocalizerExc;
+import mircoders.localizer.MirLocalizerFailure;
+import mircoders.module.ModuleLanguage;
+import mircoders.module.ModuleContent;
+import mircoders.module.ModuleComment;
+import mircoders.storage.DatabaseContent;
 
 
 public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocalizer {
-  private Map simpleCommentOperations;
-  private Map simpleArticleOperations;
+  /** preview page name (String) -> generator name (String) */
+  private Map previewPages;
+  private List previewPageNames;
+
+  private List simpleCommentOperations;
+  private List simpleArticleOperations;
+  private Map simpleCommentOperationsMap;
+  private Map simpleArticleOperationsMap;
+
+  protected static LoggerWrapper logger = new LoggerWrapper("Localizer.AdminInterface");
+  protected MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
+
+  public MirBasicAdminInterfaceLocalizer() throws MirLocalizerFailure {
+    simpleCommentOperations = new ArrayList();
+    simpleArticleOperations = new ArrayList();
+    simpleCommentOperationsMap = new HashMap();
+    simpleArticleOperationsMap = new HashMap();
+
+    previewPages = new HashMap();
+    previewPageNames = new ArrayList();
+
+    String[] previewConfiguration = configuration.getStringArray("Mir.Localizer.Admin.ArticlePreview");
+
+    for (int i = 0; i<previewConfiguration.length; i++) {
+      try {
+        List parts = StringRoutines.separateString(previewConfiguration[i], "=");
+        if (parts.size() == 2) {
+          String key = ((String) parts.get(0)).trim();
+          previewPages.put(key,((String) parts.get(1)).trim());
+          previewPageNames.add(key);
+        }
+        else {
+          throw new Exception("'=' expected");
+        }
+      }
+      catch (Exception e) {
+        logger.error("Error while processing preview configuration '" + previewConfiguration[i] + "': " + e.toString());
+      }
+    }
 
-  public MirBasicAdminInterfaceLocalizer() throws MirLocalizerFailure, MirLocalizerException {
-    simpleCommentOperations = new HashMap();
-    simpleArticleOperations = new HashMap();
+    addSimpleArticleOperation(new ChangeArticleFieldOperation("newswire", "to_article_type", "0", "1", false));
+    addSimpleArticleOperation(new ModifyArticleFieldOperation("unhide", "is_published", "1", false));
+    addSimpleArticleOperation(new ModifyArticleFieldOperation("hide", "is_published", "0", false));
+    addSimpleArticleOperation(new DeleteEntityOperation("delete"));
 
-    buildSimpleCommentOperations(simpleCommentOperations);
-    buildSimpleArticleOperations(simpleArticleOperations);
+    addSimpleCommentOperation(new ModifyCommentFieldOperation("unhide", "is_published", "1"));
+    addSimpleCommentOperation(new ModifyCommentFieldOperation("hide", "is_published", "0"));
+    addSimpleCommentOperation(new DeleteEntityOperation("delete"));
   }
 
-  public Map simpleCommentOperations() {
-    return simpleCommentOperations;
-  };
+  /** {@inheritDoc} */
+  public String getAdminPageGenerator(String aPage, Map aTemplateData, EntityAdapter aUser,
+                                      String aDefault) throws MirLocalizerExc {
+    return aDefault;
+  }
 
-  public Map simpleArticleOperations() {
-    return simpleArticleOperations;
-  };
+  /** {@inheritDoc} */
+  public Generator prepareArticlePreview(String aPreviewPage, EntityAdapter anArticle,
+                                         Map aContext) throws MirLocalizerExc {
+    MirGlobal.localizer().producerAssistant().initializeGenerationValueSet(aContext);
+    aContext.put("article", anArticle);
 
-  public void buildSimpleCommentOperations(Map anOperations) throws MirLocalizerFailure, MirLocalizerException {
-    anOperations.put("hide", new HideCommentOperation());
-    anOperations.put("unhide", new UnhideCommentOperation());
-  };
+    try {
+      aContext.put(
+          "language",
+          MirGlobal.localizer().dataModel().adapterModel().makeEntityAdapter("language",
+              new ModuleLanguage().languageForCode(configuration.getString("Mir.Localizer.Admin.ArticlePreviewLanguage"))));
+    }
+    catch (EntityAdapterFailure e) {
+      throw new MirLocalizerFailure("Can't create entity adapter", e);
+    }
+    catch (ModuleExc e) {
+      throw new MirLocalizerFailure("Can't find language", e);
+    }
+    aContext.put("pathprefix", configuration.getString("Mir.Localizer.Admin.ArticlePreviewLanguage")); 
 
-  public void buildSimpleArticleOperations(Map anOperations)  throws MirLocalizerFailure, MirLocalizerException {
-    anOperations.put("hide", new HideArticleOperation());
-    anOperations.put("unhide", new UnhideArticleOperation());
-  };
+    aContext.put("lang",
+        new BundleGeneratorFunction(
+            new Bundle[] {
+              MirGlobal.getBundleFactory().getBundle(
+                  "etc/bundles/producer",
+                  new String[] {
+                    configuration.getString("Mir.Localizer.Admin.ArticlePreviewLanguage") }) }));
 
-  protected abstract static class EntityModifyingOperation implements MirSimpleEntityOperation {
-    public boolean isAvailable(EntityAdapter anEntity) {
+
+    if (previewPages.containsKey(aPreviewPage)) {
       try {
+        return MirGlobal.localizer().generators().makeAdminGeneratorLibrary().
+            makeGenerator((String) previewPages.get(aPreviewPage), null);
+      }
+      catch (GeneratorExc e) {
+        throw new MirLocalizerFailure(e);
+      }
+    }
+               throw new MirLocalizerExc("Unknown preview: " + aPreviewPage);
+  }
+
+  /** {@inheritDoc} */
+  public List getPreviewPages(EntityAdapter anArticle) throws MirLocalizerExc{
+    return Collections.unmodifiableList(previewPageNames);
+  }
+
+  /** {@inheritDoc} */
+  public String makePasswordDigest(String aPassword) {
+    
+
+    return aPassword;
+  }
+
+  /** {@inheritDoc} */
+  public void initializeArticle(Map anArticle) {
+    anArticle.put("is_published", "0");
+    anArticle.put("date", StringUtil.date2webdbDate(new GregorianCalendar()));
+  }
+
+  public List simpleCommentOperations() {
+    return Collections.unmodifiableList(simpleCommentOperations);
+  }
+
+  public List simpleArticleOperations() {
+    return Collections.unmodifiableList(simpleArticleOperations);
+  }
+
+  public EntityOperation simpleArticleOperationForName(String aName) {
+    return (EntityOperation) simpleArticleOperationsMap.get(aName);
+  }
+
+  public EntityOperation simpleCommentOperationForName(String aName) {
+    return (EntityOperation) simpleCommentOperationsMap.get(aName);
+  }
+
+  public void removeSimpleArticleOperation(String aName) {
+    simpleArticleOperations.remove(simpleArticleOperationsMap.get(aName));
+    simpleArticleOperationsMap.remove(aName);
+  }
+
+  public void addSimpleArticleOperation(EntityOperation anOperation) {
+    removeSimpleArticleOperation(anOperation.getName());
+    simpleArticleOperationsMap.put(anOperation.getName(), anOperation);
+    simpleArticleOperations.add(anOperation);
+  }
+
+  public void removeSimpleCommentOperation(String aName) {
+    simpleCommentOperations.remove(simpleCommentOperationsMap.get(aName));
+    simpleCommentOperationsMap.remove(aName);
+  }
+
+  public void addSimpleCommentOperation(EntityOperation anOperation) {
+    removeSimpleCommentOperation(anOperation.getName());
+    simpleCommentOperationsMap.put(anOperation.getName(), anOperation);
+    simpleCommentOperations.add(anOperation);
+  }
+
+  protected abstract static class EntityModifyingOperation implements EntityOperation {
+    private String name;
+    private boolean logOperation;
+
+    protected EntityModifyingOperation(String aName, boolean aLogOperation) {
+      name = aName;
+      logOperation = aLogOperation;
+    }
 
+    public String getName() {
+      return name;
+    }
+
+    public boolean isAvailable(EntityAdapter anEntity) {
+      try {
         Entity entity = anEntity.getEntity();
-        return (entity instanceof EntityComment) && isAvailable((EntityComment) entity);
+        return isAvailable(entity);
       }
       catch (Throwable t) {
         return false;
       }
-    };
+    }
 
-    public void perform(EntityAdapter anEntity) {
+    public void perform(EntityAdapter aUser, EntityAdapter anEntity) throws MirLocalizerExc, MirLocalizerFailure {
       Entity entity = anEntity.getEntity();
       try {
-        performModification(entity);
+        performModification(aUser, entity);
+
+        if (logOperation) {
+          try {
+            StringBuffer line = new StringBuffer();
+
+            line.append(DateTimeRoutines.advancedDateFormat(
+                MirGlobal.config().getString("Mir.DefaultDateTimeFormat"),
+                (new GregorianCalendar()).getTime(),
+                MirGlobal.config().getString("Mir.DefaultTimezone")));
+            line.append(" ");
+            if (aUser != null)
+              line.append(aUser.get("login"));
+            else
+              line.append("unknown");
+
+            line.append(" ");
+            line.append(getName());
+            EntityUtility.appendLineToField(entity, "comment", line.toString());
+          }
+          catch (Throwable t) {
+            logger.error("Error while trying to log an article operation: " + t.toString());
+          }
+        }
+
         entity.update();
       }
       catch (Throwable t) {
+        throw new MirLocalizerFailure(t);
       }
-    };
+    }
 
-    protected abstract boolean isAvailable(Entity anEntity) throws StorageObjectException ;
-    protected abstract void performModification(Entity anEntity) throws StorageObjectException ;
+    protected abstract boolean isAvailable(Entity anEntity) throws DatabaseFailure ;
+    protected abstract void performModification(EntityAdapter aUser, Entity anEntity)  throws MirLocalizerExc, MirLocalizerFailure ;
   }
 
   public static abstract class CommentModifyingOperation extends EntityModifyingOperation {
-    protected boolean isAvailable(Entity anEntity) throws StorageObjectException {
+    public CommentModifyingOperation(String aName, boolean aLogOperation) {
+      super(aName, aLogOperation);
+    }
+
+    public CommentModifyingOperation(String aName) {
+      this(aName, true);
+    }
+
+    protected boolean isAvailable(Entity anEntity) throws DatabaseFailure {
       return anEntity instanceof EntityComment && isAvailable((EntityComment) anEntity);
     }
 
-    protected void performModification(Entity anEntity) throws StorageObjectException {
-      performModification((EntityComment) anEntity);
-      DatabaseContent.getInstance().setUnproduced("id="+anEntity.getValue("to_media"));
-    };
+    protected void performModification(EntityAdapter aUser, Entity anEntity) throws DatabaseFailure {
+      performModification(aUser, (EntityComment) anEntity);
+      DatabaseContent.getInstance().setUnproduced("id="+anEntity.getFieldValue("to_media"));
+    }
 
-    protected abstract boolean isAvailable(EntityComment aComment) throws StorageObjectException ;
-    protected abstract void performModification(EntityComment aComment) throws StorageObjectException ;
+    protected abstract boolean isAvailable(EntityComment aComment) throws DatabaseFailure ;
+    protected abstract void performModification(EntityAdapter aUser, EntityComment aComment) throws DatabaseFailure ;
   }
 
   public static abstract class ArticleModifyingOperation extends EntityModifyingOperation {
-    protected boolean isAvailable(Entity anEntity) throws StorageObjectException {
-      return anEntity instanceof EntityContent && isAvailable((EntityComment) anEntity);
+    public ArticleModifyingOperation(String aName, boolean aLogOperation) {
+      super(aName, aLogOperation);
     }
 
-    protected void performModification(Entity anEntity) throws StorageObjectException {
-      performModification((EntityContent) anEntity);
-      anEntity.setValueForProperty("is_produced", "0");
-    };
+    protected boolean isAvailable(Entity anEntity) throws DatabaseFailure {
+      return anEntity instanceof EntityContent && isAvailable((EntityContent) anEntity);
+    }
+
+    protected void performModification(EntityAdapter aUser, Entity anEntity) throws DatabaseFailure {
+      performModification(aUser, (EntityContent) anEntity);
+      anEntity.setFieldValue("is_produced", "0");
+    }
 
-    protected abstract boolean isAvailable(EntityContent anArticle) throws StorageObjectException ;
-    protected abstract void performModification(EntityContent anArticle) throws StorageObjectException ;
+    protected abstract boolean isAvailable(EntityContent anArticle) throws DatabaseFailure ;
+    protected abstract void performModification(EntityAdapter aUser, EntityContent anArticle) throws DatabaseFailure ;
   }
 
-  private static class HideCommentOperation extends CommentModifyingOperation {
+  protected static class SetCommentFieldOperation extends CommentModifyingOperation {
+    private String field;
+    private String value;
+
+    public SetCommentFieldOperation(String aName, String aField, String aValue) {
+      super(aName);
+
+      field = aField;
+      value = aValue;
+    }
+
     protected boolean isAvailable(EntityComment aComment) {
-      return aComment.getValue("is_published").equals("1");
+      return true;
     }
-    protected void performModification(EntityComment aComment) throws StorageObjectException {
-      aComment.setValueForProperty("is_published", "0");
+
+    protected void performModification(EntityAdapter aUser, EntityComment aComment) throws DatabaseFailure {
+      aComment.setFieldValue(field, value);
     }
   }
 
-  private static class UnhideCommentOperation extends CommentModifyingOperation {
+  protected static class SetCommentFieldsOperation extends CommentModifyingOperation {
+    private Map values;
+
+    public SetCommentFieldsOperation(String aName, String aFields[], String aValues[]) {
+      super(aName);
+
+      values = new HashMap();
+
+      for (int i=0; i<aFields.length; i++)
+        values.put(aFields[i], aValues[i]);
+    }
+
     protected boolean isAvailable(EntityComment aComment) {
-      return aComment.getValue("is_published").equals("0");
+      return true;
+    }
+
+    protected void performModification(EntityAdapter aUser, EntityComment aComment) throws DatabaseFailure {
+      Iterator i = values.entrySet().iterator();
+
+      while (i.hasNext()) {
+        Map.Entry entry = (Map.Entry) i.next();
+        aComment.setFieldValue((String) entry.getKey(), (String) entry.getValue());
+      }
+    }
+  }
+
+
+  protected static class ModifyCommentFieldOperation extends CommentModifyingOperation {
+    private String field;
+    private String value;
+
+    public ModifyCommentFieldOperation(String aName, String aField, String aValue) {
+      super(aName);
+
+      field = aField;
+      value = aValue;
+    }
+
+    protected boolean isAvailable(EntityComment aComment) {
+      return aComment.getFieldValue(field) == null || !aComment.getFieldValue(field).equals(value);
+    }
+
+    protected void performModification(EntityAdapter aUser, EntityComment aComment) throws DatabaseFailure {
+      aComment.setFieldValue(field, value);
+    }
+  }
+
+  protected static class SetArticleFieldOperation extends ArticleModifyingOperation {
+    private String field;
+    private String value;
+
+    public SetArticleFieldOperation(String aName, String aField, String aValue, boolean aLogOperation) {
+      super(aName, aLogOperation);
+
+      field = aField;
+      value = aValue;
+    }
+
+    protected boolean isAvailable(EntityContent anArticle) {
+      return true;
     }
-    protected void performModification(EntityComment aComment) throws StorageObjectException {
-      aComment.setValueForProperty("is_published", "1");
+
+    protected void performModification(EntityAdapter aUser, EntityContent anArticle) throws DatabaseFailure {
+      anArticle.setFieldValue(field, value);
     }
   }
 
-  private static class HideArticleOperation extends ArticleModifyingOperation {
+  protected static class ModifyArticleFieldOperation extends ArticleModifyingOperation {
+    private String field;
+    private String value;
+
+    public ModifyArticleFieldOperation(String aName, String aField, String aValue, boolean aLogOperation) {
+      super(aName, aLogOperation);
+
+      field = aField;
+      value = aValue;
+    }
+
     protected boolean isAvailable(EntityContent anArticle) {
-      return anArticle.getValue("is_published").equals("1");
+      return anArticle.getFieldValue(field) == null || !anArticle.getFieldValue(field).equals(value);
     }
-    protected void performModification(EntityContent anArticle) throws StorageObjectException {
-      anArticle.setValueForProperty("is_published", "0");
+
+    protected void performModification(EntityAdapter aUser, EntityContent anArticle) throws DatabaseFailure {
+      anArticle.setFieldValue(field, value);
     }
   }
 
-  private static class UnhideArticleOperation extends ArticleModifyingOperation {
+  protected static class ChangeArticleFieldOperation extends ArticleModifyingOperation {
+    private String field;
+    private Set oldValues;
+    private String newValue;
+
+    public ChangeArticleFieldOperation(String aName, String aField, String anOldValues[], String aNewValue, boolean aLogOperation) {
+      super(aName, aLogOperation);
+
+      field = aField;
+      newValue = aNewValue;
+      oldValues = new HashSet(Arrays.asList(anOldValues));
+    }
+    public ChangeArticleFieldOperation(String aName, String aField, String anOldValue, String aNewValue, boolean aLogOperation) {
+      this(aName, aField, new String[] {anOldValue}, aNewValue, aLogOperation);
+    }
+
     protected boolean isAvailable(EntityContent anArticle) {
-      return anArticle.getValue("is_published").equals("0");
+      return anArticle.getFieldValue(field) != null && oldValues.contains(anArticle.getFieldValue(field));
     }
-    protected void performModification(EntityContent anArticle) throws StorageObjectException {
-      anArticle.setValueForProperty("is_published", "1");
+
+    protected void performModification(EntityAdapter aUser, EntityContent anArticle) throws DatabaseFailure {
+      anArticle.setFieldValue(field, newValue);
+    }
+  }
+
+  public static class DeleteEntityOperation implements EntityOperation {
+    private String name;
+    private ModuleContent content;
+    private ModuleComment comment;
+
+    public DeleteEntityOperation(String aName) {
+      name = aName;
+      comment = new ModuleComment();
+      content = new ModuleContent();
+    }
+
+    public String getName() {
+      return "delete";
+    }
+
+    public boolean isAvailable(EntityAdapter anEntity) throws MirLocalizerExc, MirLocalizerFailure {
+      return false;
+    }
+
+    public void perform(EntityAdapter aUser, EntityAdapter anEntity) throws MirLocalizerExc, MirLocalizerFailure {
+      Entity entity = anEntity.getEntity();
+      try {
+        if (entity instanceof EntityContent) {
+          content.deleteById(entity.getId());
+        }
+        else if (entity instanceof EntityComment) {
+          comment.deleteById(entity.getId());
+        }
+      }
+      catch (ModuleExc e) {
+        throw new MirLocalizerFailure(e);
+      }
     }
   }
-}
\ No newline at end of file
+}