minor changes according to JLint
[mir.git] / source / mircoders / localizer / basic / MirBasicAdminInterfaceLocalizer.java
index 6edb553..58f56a6 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.Arrays;
+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 java.util.Vector;
+
+import mir.entity.Entity;
+import mir.entity.adapter.EntityAdapter;
+import mir.log.LoggerWrapper;
+import mir.misc.StringUtil;
+import mir.storage.StorageObjectFailure;
+import mir.util.DateTimeFunctions;
+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.storage.DatabaseContent;
 
 
 public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocalizer {
@@ -45,21 +60,32 @@ public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocaliz
   private Vector simpleArticleOperations;
   private Map simpleCommentOperationsMap;
   private Map simpleArticleOperationsMap;
+  protected static LoggerWrapper logger = new LoggerWrapper("Localizer.AdminInterface");;
 
   public MirBasicAdminInterfaceLocalizer() throws MirLocalizerFailure, MirLocalizerExc {
+
     simpleCommentOperations = new Vector();
     simpleArticleOperations = new Vector();
     simpleCommentOperationsMap = new HashMap();
     simpleArticleOperationsMap = new HashMap();
 
-    addSimpleArticleOperation(new ChangeArticleFieldOperation("newswire", "to_article_type", "0", "1"));
-    addSimpleArticleOperation(new SetArticleFieldOperation("unhide", "is_published", "1"));
-    addSimpleArticleOperation(new SetArticleFieldOperation("hide", "is_published", "0"));
+    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));
+
+    addSimpleCommentOperation(new ModifyCommentFieldOperation("unhide", "is_published", "1"));
+    addSimpleCommentOperation(new ModifyCommentFieldOperation("hide", "is_published", "0"));
+  }
 
-    addSimpleCommentOperation(new SetCommentFieldOperation("unhide", "is_published", "1"));
-    addSimpleCommentOperation(new SetCommentFieldOperation("hide", "is_published", "0"));
+  public String makePasswordDigest(String aPassword) {
+    return aPassword;
   }
 
+  public void initializeArticle(Map anArticle) {
+    anArticle.put("is_published", "0");
+    anArticle.put("date", StringUtil.date2webdbDate(new GregorianCalendar()));
+  };
+
   public List simpleCommentOperations() {
     return simpleCommentOperations;
   };
@@ -119,18 +145,19 @@ public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocaliz
       }
     };
 
-    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);
         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 StorageObjectFailure ;
+    protected abstract void performModification(EntityAdapter aUser, Entity anEntity)  throws MirLocalizerExc, MirLocalizerFailure ;
   }
 
   public static abstract class CommentModifyingOperation extends EntityModifyingOperation {
@@ -138,35 +165,62 @@ public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocaliz
       super(aName);
     }
 
-    protected boolean isAvailable(Entity anEntity) throws StorageObjectException {
+    protected boolean isAvailable(Entity anEntity) throws StorageObjectFailure {
       return anEntity instanceof EntityComment && isAvailable((EntityComment) anEntity);
     }
 
-    protected void performModification(Entity anEntity) throws StorageObjectException {
-      performModification((EntityComment) anEntity);
+    protected void performModification(EntityAdapter aUser, Entity anEntity) throws StorageObjectFailure {
+      performModification(aUser, (EntityComment) anEntity);
       DatabaseContent.getInstance().setUnproduced("id="+anEntity.getValue("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 StorageObjectFailure ;
+    protected abstract void performModification(EntityAdapter aUser, EntityComment aComment) throws StorageObjectFailure ;
   }
 
   public static abstract class ArticleModifyingOperation extends EntityModifyingOperation {
-    public ArticleModifyingOperation(String aName) {
+    private boolean logOperation;
+
+    public ArticleModifyingOperation(String aName, boolean aLogOperation) {
       super(aName);
+
+      logOperation = aLogOperation;
     }
 
-    protected boolean isAvailable(Entity anEntity) throws StorageObjectException {
+    protected boolean isAvailable(Entity anEntity) throws StorageObjectFailure {
       return anEntity instanceof EntityContent && isAvailable((EntityContent) anEntity);
     }
 
-    protected void performModification(Entity anEntity) throws StorageObjectException {
-      performModification((EntityContent) anEntity);
+    protected void performModification(EntityAdapter aUser, Entity anEntity) throws StorageObjectFailure {
+      performModification(aUser, (EntityContent) anEntity);
       anEntity.setValueForProperty("is_produced", "0");
+
+      if (logOperation) {
+        try {
+          StringBuffer line = new StringBuffer();
+
+          line.append(DateTimeFunctions.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());
+          ( (EntityContent) anEntity).appendToComments(line.toString());
+        }
+        catch (Throwable t) {
+          logger.error("Error while trying to log an article operation: " + t.toString());
+        }
+      }
     };
 
-    protected abstract boolean isAvailable(EntityContent anArticle) throws StorageObjectException ;
-    protected abstract void performModification(EntityContent anArticle) throws StorageObjectException ;
+    protected abstract boolean isAvailable(EntityContent anArticle) throws StorageObjectFailure ;
+    protected abstract void performModification(EntityAdapter aUser, EntityContent anArticle) throws StorageObjectFailure ;
   }
 
   protected static class SetCommentFieldOperation extends CommentModifyingOperation {
@@ -181,10 +235,57 @@ public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocaliz
     }
 
     protected boolean isAvailable(EntityComment aComment) {
+      return true;
+    }
+
+    protected void performModification(EntityAdapter aUser, EntityComment aComment) throws StorageObjectFailure {
+      aComment.setValueForProperty(field, value);
+    }
+  }
+
+  protected static class SetCommentFieldsOperation extends CommentModifyingOperation {
+    private Map values;
+
+    public SetCommentFieldsOperation(String aName, String aFields[], String aValues[]) throws MirLocalizerExc {
+      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 true;
+    }
+
+    protected void performModification(EntityAdapter aUser, EntityComment aComment) throws StorageObjectFailure {
+      Iterator i = values.entrySet().iterator();
+
+      while (i.hasNext()) {
+        Map.Entry entry = (Map.Entry) i.next();
+        aComment.setValueForProperty((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.getValue(field) == null || !aComment.getValue(field).equals(value);
     }
 
-    protected void performModification(EntityComment aComment) throws StorageObjectException {
+    protected void performModification(EntityAdapter aUser, EntityComment aComment) throws StorageObjectFailure {
       aComment.setValueForProperty(field, value);
     }
   }
@@ -193,8 +294,28 @@ public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocaliz
     private String field;
     private String value;
 
-    public SetArticleFieldOperation(String aName, String aField, String aValue) {
-      super(aName);
+    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(EntityAdapter aUser, EntityContent anArticle) throws StorageObjectFailure {
+      anArticle.setValueForProperty(field, value);
+    }
+  }
+
+  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;
@@ -204,30 +325,33 @@ public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocaliz
       return anArticle.getValue(field) == null || !anArticle.getValue(field).equals(value);
     }
 
-    protected void performModification(EntityContent anArticle) throws StorageObjectException {
+    protected void performModification(EntityAdapter aUser, EntityContent anArticle) throws StorageObjectFailure {
       anArticle.setValueForProperty(field, value);
     }
   }
 
   protected static class ChangeArticleFieldOperation extends ArticleModifyingOperation {
     private String field;
-    private String oldValue;
+    private Set oldValues;
     private String newValue;
 
-    public ChangeArticleFieldOperation(String aName, String aField, String anOldValue, String aNewValue) {
-      super(aName);
+    public ChangeArticleFieldOperation(String aName, String aField, String anOldValues[], String aNewValue, boolean aLogOperation) {
+      super(aName, aLogOperation);
 
       field = aField;
       newValue = aNewValue;
-      oldValue = anOldValue;
+      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(field) != null && anArticle.getValue(field).equals(oldValue);
+      return anArticle.getValue(field) != null && oldValues.contains(anArticle.getValue(field));
     }
 
-    protected void performModification(EntityContent anArticle) throws StorageObjectException {
+    protected void performModification(EntityAdapter aUser, EntityContent anArticle) throws StorageObjectFailure {
       anArticle.setValueForProperty(field, newValue);
     }
   }
-}
\ No newline at end of file
+}