added optional logging for article operations in admin
authorzapata <zapata>
Mon, 23 Dec 2002 16:19:38 +0000 (16:19 +0000)
committerzapata <zapata>
Mon, 23 Dec 2002 16:19:38 +0000 (16:19 +0000)
source/mircoders/localizer/MirAdminInterfaceLocalizer.java
source/mircoders/localizer/basic/MirBasicAdminInterfaceLocalizer.java
source/mircoders/servlet/ServletModuleLocalizer.java

index 841e1df..7c38165 100755 (executable)
@@ -48,6 +48,6 @@ public interface MirAdminInterfaceLocalizer {
   public interface MirSimpleEntityOperation {
     public String getName();
     public boolean isAvailable(EntityAdapter anEntity);
-    public void perform(EntityAdapter anEntity);
+    public void perform(EntityAdapter aUser, EntityAdapter anEntity);
   }
 }
\ No newline at end of file
index 6edb553..d7abc87 100755 (executable)
-/*
- * Copyright (C) 2001, 2002  The Mir-coders group
- *
- * This file is part of Mir.
- *
- * Mir is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * Mir is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Mir; if not, write to the Free Software
- * 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.
- */
-
-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.*;
-
-
-public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocalizer {
-  private Vector simpleCommentOperations;
-  private Vector simpleArticleOperations;
-  private Map simpleCommentOperationsMap;
-  private Map simpleArticleOperationsMap;
-
-  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"));
-
-    addSimpleCommentOperation(new SetCommentFieldOperation("unhide", "is_published", "1"));
-    addSimpleCommentOperation(new SetCommentFieldOperation("hide", "is_published", "0"));
-  }
-
-  public List simpleCommentOperations() {
-    return simpleCommentOperations;
-  };
-
-  public List simpleArticleOperations() {
-    return simpleArticleOperations;
-  };
-
-  public MirSimpleEntityOperation simpleArticleOperationForName(String aName) {
-    return (MirSimpleEntityOperation) simpleArticleOperationsMap.get(aName);
-  };
-
-  public MirSimpleEntityOperation simpleCommentOperationForName(String aName) {
-    return (MirSimpleEntityOperation) simpleCommentOperationsMap.get(aName);
-  };
-
-  public void removeSimpleArticleOperation(String aName) {
-    simpleArticleOperations.remove(simpleArticleOperationsMap.get(aName));
-    simpleArticleOperationsMap.remove(aName);
-  }
-
-  public void addSimpleArticleOperation(MirSimpleEntityOperation 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(MirSimpleEntityOperation anOperation) {
-    removeSimpleCommentOperation(anOperation.getName());
-    simpleCommentOperationsMap.put(anOperation.getName(), anOperation);
-    simpleCommentOperations.add(anOperation);
-  }
-
-  protected abstract static class EntityModifyingOperation implements MirSimpleEntityOperation {
-    private String name;
-
-    protected EntityModifyingOperation(String aName) {
-      name = aName;
-    }
-
-    public String getName() {
-      return name;
-    };
-
-    public boolean isAvailable(EntityAdapter anEntity) {
-      try {
-        Entity entity = anEntity.getEntity();
-        return isAvailable(entity);
-      }
-      catch (Throwable t) {
-        return false;
-      }
-    };
-
-    public void perform(EntityAdapter anEntity) {
-      Entity entity = anEntity.getEntity();
-      try {
-        performModification(entity);
-        entity.update();
-      }
-      catch (Throwable t) {
-      }
-    };
-
-    protected abstract boolean isAvailable(Entity anEntity) throws StorageObjectException ;
-    protected abstract void performModification(Entity anEntity) throws StorageObjectException ;
-  }
-
-  public static abstract class CommentModifyingOperation extends EntityModifyingOperation {
-    public CommentModifyingOperation(String aName) {
-      super(aName);
-    }
-
-    protected boolean isAvailable(Entity anEntity) throws StorageObjectException {
-      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 abstract boolean isAvailable(EntityComment aComment) throws StorageObjectException ;
-    protected abstract void performModification(EntityComment aComment) throws StorageObjectException ;
-  }
-
-  public static abstract class ArticleModifyingOperation extends EntityModifyingOperation {
-    public ArticleModifyingOperation(String aName) {
-      super(aName);
-    }
-
-    protected boolean isAvailable(Entity anEntity) throws StorageObjectException {
-      return anEntity instanceof EntityContent && isAvailable((EntityContent) anEntity);
-    }
-
-    protected void performModification(Entity anEntity) throws StorageObjectException {
-      performModification((EntityContent) anEntity);
-      anEntity.setValueForProperty("is_produced", "0");
-    };
-
-    protected abstract boolean isAvailable(EntityContent anArticle) throws StorageObjectException ;
-    protected abstract void performModification(EntityContent anArticle) throws StorageObjectException ;
-  }
-
-  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(field) == null || !aComment.getValue(field).equals(value);
-    }
-
-    protected void performModification(EntityComment aComment) throws StorageObjectException {
-      aComment.setValueForProperty(field, value);
-    }
-  }
-
-  protected static class SetArticleFieldOperation extends ArticleModifyingOperation {
-    private String field;
-    private String value;
-
-    public SetArticleFieldOperation(String aName, String aField, String aValue) {
-      super(aName);
-
-      field = aField;
-      value = aValue;
-    }
-
-    protected boolean isAvailable(EntityContent anArticle) {
-      return anArticle.getValue(field) == null || !anArticle.getValue(field).equals(value);
-    }
-
-    protected void performModification(EntityContent anArticle) throws StorageObjectException {
-      anArticle.setValueForProperty(field, value);
-    }
-  }
-
-  protected static class ChangeArticleFieldOperation extends ArticleModifyingOperation {
-    private String field;
-    private String oldValue;
-    private String newValue;
-
-    public ChangeArticleFieldOperation(String aName, String aField, String anOldValue, String aNewValue) {
-      super(aName);
-
-      field = aField;
-      newValue = aNewValue;
-      oldValue = anOldValue;
-    }
-
-    protected boolean isAvailable(EntityContent anArticle) {
-      return anArticle.getValue(field) != null && anArticle.getValue(field).equals(oldValue);
-    }
-
-    protected void performModification(EntityContent anArticle) throws StorageObjectException {
-      anArticle.setValueForProperty(field, newValue);
-    }
-  }
+/*\r
+ * Copyright (C) 2001, 2002  The Mir-coders group\r
+ *\r
+ * This file is part of Mir.\r
+ *\r
+ * Mir is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation; either version 2 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * Mir is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with Mir; if not, write to the Free Software\r
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
+ *\r
+ * In addition, as a special exception, The Mir-coders gives permission to link\r
+ * the code of this program with the com.oreilly.servlet library, any library\r
+ * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
+ * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
+ * the above that use the same license as the above), and distribute linked\r
+ * combinations including the two.  You must obey the GNU General Public\r
+ * License in all respects for all of the code used other than the above\r
+ * mentioned libraries.  If you modify this file, you may extend this exception\r
+ * to your version of the file, but you are not obligated to do so.  If you do\r
+ * not wish to do so, delete this exception statement from your version.\r
+ */\r
+\r
+package mircoders.localizer.basic;\r
+\r
+import java.util.*;\r
+import java.text.*;\r
+\r
+import mir.entity.adapter.*;\r
+import mir.storage.*;\r
+import mir.entity.*;\r
+import mir.util.*;\r
+\r
+import mircoders.localizer.*;\r
+import mircoders.entity.*;\r
+import mircoders.storage.*;\r
+\r
+\r
+public class MirBasicAdminInterfaceLocalizer implements MirAdminInterfaceLocalizer {\r
+  private Vector simpleCommentOperations;\r
+  private Vector simpleArticleOperations;\r
+  private Map simpleCommentOperationsMap;\r
+  private Map simpleArticleOperationsMap;\r
+  private static SimpleDateFormat dateFormatter = new SimpleDateFormat("dd.MM.yyyy HH:mm");\r
+\r
+  public MirBasicAdminInterfaceLocalizer() throws MirLocalizerFailure, MirLocalizerExc {\r
+    simpleCommentOperations = new Vector();\r
+    simpleArticleOperations = new Vector();\r
+    simpleCommentOperationsMap = new HashMap();\r
+    simpleArticleOperationsMap = new HashMap();\r
+\r
+    addSimpleArticleOperation(new ChangeArticleFieldOperation("newswire", "to_article_type", "0", "1", false));\r
+    addSimpleArticleOperation(new SetArticleFieldOperation("unhide", "is_published", "1", false));\r
+    addSimpleArticleOperation(new SetArticleFieldOperation("hide", "is_published", "0", false));\r
+\r
+    addSimpleCommentOperation(new SetCommentFieldOperation("unhide", "is_published", "1"));\r
+    addSimpleCommentOperation(new SetCommentFieldOperation("hide", "is_published", "0"));\r
+  }\r
+\r
+  public List simpleCommentOperations() {\r
+    return simpleCommentOperations;\r
+  };\r
+\r
+  public List simpleArticleOperations() {\r
+    return simpleArticleOperations;\r
+  };\r
+\r
+  public MirSimpleEntityOperation simpleArticleOperationForName(String aName) {\r
+    return (MirSimpleEntityOperation) simpleArticleOperationsMap.get(aName);\r
+  };\r
+\r
+  public MirSimpleEntityOperation simpleCommentOperationForName(String aName) {\r
+    return (MirSimpleEntityOperation) simpleCommentOperationsMap.get(aName);\r
+  };\r
+\r
+  public void removeSimpleArticleOperation(String aName) {\r
+    simpleArticleOperations.remove(simpleArticleOperationsMap.get(aName));\r
+    simpleArticleOperationsMap.remove(aName);\r
+  }\r
+\r
+  public void addSimpleArticleOperation(MirSimpleEntityOperation anOperation) {\r
+    removeSimpleArticleOperation(anOperation.getName());\r
+    simpleArticleOperationsMap.put(anOperation.getName(), anOperation);\r
+    simpleArticleOperations.add(anOperation);\r
+  }\r
+\r
+  public void removeSimpleCommentOperation(String aName) {\r
+    simpleCommentOperations.remove(simpleCommentOperationsMap.get(aName));\r
+    simpleCommentOperationsMap.remove(aName);\r
+  }\r
+\r
+  public void addSimpleCommentOperation(MirSimpleEntityOperation anOperation) {\r
+    removeSimpleCommentOperation(anOperation.getName());\r
+    simpleCommentOperationsMap.put(anOperation.getName(), anOperation);\r
+    simpleCommentOperations.add(anOperation);\r
+  }\r
+\r
+  protected abstract static class EntityModifyingOperation implements MirSimpleEntityOperation {\r
+    private String name;\r
+\r
+    protected EntityModifyingOperation(String aName) {\r
+      name = aName;\r
+    }\r
+\r
+    public String getName() {\r
+      return name;\r
+    };\r
+\r
+    public boolean isAvailable(EntityAdapter anEntity) {\r
+      try {\r
+        Entity entity = anEntity.getEntity();\r
+        return isAvailable(entity);\r
+      }\r
+      catch (Throwable t) {\r
+        return false;\r
+      }\r
+    };\r
+\r
+    public void perform(EntityAdapter aUser, EntityAdapter anEntity) {\r
+      Entity entity = anEntity.getEntity();\r
+      try {\r
+        performModification(aUser, entity);\r
+        entity.update();\r
+      }\r
+      catch (Throwable t) {\r
+      }\r
+    };\r
+\r
+    protected abstract boolean isAvailable(Entity anEntity) throws StorageObjectException ;\r
+    protected abstract void performModification(EntityAdapter aUser, Entity anEntity) throws StorageObjectException ;\r
+  }\r
+\r
+  public static abstract class CommentModifyingOperation extends EntityModifyingOperation {\r
+    public CommentModifyingOperation(String aName) {\r
+      super(aName);\r
+    }\r
+\r
+    protected boolean isAvailable(Entity anEntity) throws StorageObjectException {\r
+      return anEntity instanceof EntityComment && isAvailable((EntityComment) anEntity);\r
+    }\r
+\r
+    protected void performModification(EntityAdapter aUser, Entity anEntity) throws StorageObjectException {\r
+      performModification(aUser, (EntityComment) anEntity);\r
+      DatabaseContent.getInstance().setUnproduced("id="+anEntity.getValue("to_media"));\r
+    };\r
+\r
+    protected abstract boolean isAvailable(EntityComment aComment) throws StorageObjectException ;\r
+    protected abstract void performModification(EntityAdapter aUser, EntityComment aComment) throws StorageObjectException ;\r
+  }\r
+\r
+  public static abstract class ArticleModifyingOperation extends EntityModifyingOperation {\r
+    private boolean logOperation;\r
+\r
+    public ArticleModifyingOperation(String aName, boolean aLogOperation) {\r
+      super(aName);\r
+\r
+      logOperation = aLogOperation;\r
+    }\r
+\r
+    protected boolean isAvailable(Entity anEntity) throws StorageObjectException {\r
+      return anEntity instanceof EntityContent && isAvailable((EntityContent) anEntity);\r
+    }\r
+\r
+    protected void performModification(EntityAdapter aUser, Entity anEntity) throws StorageObjectException {\r
+      performModification(aUser, (EntityContent) anEntity);\r
+      anEntity.setValueForProperty("is_produced", "0");\r
+\r
+      if (logOperation) {\r
+        StringBuffer comment = new StringBuffer(anEntity.getValue("comment"));\r
+        if (comment.length()>0 && comment.charAt(comment.length()-1)!='\n') {\r
+          comment.append('\n');\r
+        }\r
+        comment.append(dateFormatter.format((new GregorianCalendar()).getTime()));\r
+        comment.append(" ");\r
+        try {\r
+          comment.append(StringRoutines.interpretAsString(aUser.get("login")));\r
+        }\r
+        catch (Throwable t) {\r
+        }\r
+        comment.append(" ");\r
+        comment.append(getName());\r
+        anEntity.setValueForProperty("comment", comment.toString());\r
+      }\r
+    };\r
+\r
+    protected abstract boolean isAvailable(EntityContent anArticle) throws StorageObjectException ;\r
+    protected abstract void performModification(EntityAdapter aUser, EntityContent anArticle) throws StorageObjectException ;\r
+  }\r
+\r
+  protected static class SetCommentFieldOperation extends CommentModifyingOperation {\r
+    private String field;\r
+    private String value;\r
+\r
+    public SetCommentFieldOperation(String aName, String aField, String aValue) {\r
+      super(aName);\r
+\r
+      field = aField;\r
+      value = aValue;\r
+    }\r
+\r
+    protected boolean isAvailable(EntityComment aComment) {\r
+      return aComment.getValue(field) == null || !aComment.getValue(field).equals(value);\r
+    }\r
+\r
+    protected void performModification(EntityAdapter aUser, EntityComment aComment) throws StorageObjectException {\r
+      aComment.setValueForProperty(field, value);\r
+    }\r
+  }\r
+\r
+  protected static class SetArticleFieldOperation extends ArticleModifyingOperation {\r
+    private String field;\r
+    private String value;\r
+\r
+    public SetArticleFieldOperation(String aName, String aField, String aValue, boolean aLogOperation) {\r
+      super(aName, aLogOperation);\r
+\r
+      field = aField;\r
+      value = aValue;\r
+    }\r
+\r
+    protected boolean isAvailable(EntityContent anArticle) {\r
+      return anArticle.getValue(field) == null || !anArticle.getValue(field).equals(value);\r
+    }\r
+\r
+    protected void performModification(EntityAdapter aUser, EntityContent anArticle) throws StorageObjectException {\r
+      anArticle.setValueForProperty(field, value);\r
+    }\r
+  }\r
+\r
+  protected static class ChangeArticleFieldOperation extends ArticleModifyingOperation {\r
+    private String field;\r
+    private String oldValue;\r
+    private String newValue;\r
+\r
+    public ChangeArticleFieldOperation(String aName, String aField, String anOldValue, String aNewValue, boolean aLogOperation) {\r
+      super(aName, aLogOperation);\r
+\r
+      field = aField;\r
+      newValue = aNewValue;\r
+      oldValue = anOldValue;\r
+    }\r
+\r
+    protected boolean isAvailable(EntityContent anArticle) {\r
+      return anArticle.getValue(field) != null && anArticle.getValue(field).equals(oldValue);\r
+    }\r
+\r
+    protected void performModification(EntityAdapter aUser, EntityContent anArticle) throws StorageObjectException {\r
+      anArticle.setValueForProperty(field, newValue);\r
+    }\r
+  }\r
 }
\ No newline at end of file
index e316a14..a0d57c0 100755 (executable)
@@ -66,7 +66,18 @@ public class ServletModuleLocalizer extends ServletModule {
     }\r
   }\r
 \r
-  public void performCommentOperation(String anId, String anOperation) {\r
+  private EntityAdapter getActiveUser(HttpServletRequest aRequest) throws ServletModuleException {\r
+    try {\r
+      HttpSession session = aRequest.getSession(false);\r
+      return MirGlobal.localizer().dataModel().adapterModel().makeEntityAdapter\r
+          ("user", (EntityUsers) session.getAttribute("login.uid"));\r
+    }\r
+    catch (Exception e) {\r
+      throw new ServletModuleException("ServletModuleLocalizer.getActiveUser: " + e.getMessage());\r
+    }\r
+  }\r
+\r
+  public void performCommentOperation(EntityAdapter aUser, String anId, String anOperation) {\r
     MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation;\r
     EntityAdapter comment;\r
     EntityComment entity;\r
@@ -77,7 +88,7 @@ public class ServletModuleLocalizer extends ServletModule {
       if (entity != null) {\r
         comment = MirGlobal.localizer().dataModel().adapterModel().makeEntityAdapter("comment", entity);\r
         operation = MirGlobal.localizer().adminInterface().simpleCommentOperationForName(anOperation);\r
-        operation.perform(comment);\r
+        operation.perform(aUser, comment);\r
         logger.info("Operation " + anOperation + " successfully performed on comment " + anId);\r
       }\r
       logger.error("Error while performing " + anOperation + " on comment " + anId + ": comment is null");\r
@@ -92,7 +103,7 @@ public class ServletModuleLocalizer extends ServletModule {
     String operationString = aRequest.getParameter("operation");\r
     String returnUrlString = aRequest.getParameter("returnurl");\r
 \r
-    performCommentOperation(commentIdString, operationString);\r
+    performCommentOperation(getActiveUser(aRequest), commentIdString, operationString);\r
 \r
     redirect(aResponse, returnUrlString);\r
   }\r
@@ -114,7 +125,7 @@ public class ServletModuleLocalizer extends ServletModule {
           String commentIdString = (String) parts.get(0);\r
           String operationString = (String) parts.get(1);\r
 \r
-          performCommentOperation(commentIdString, operationString);\r
+          performCommentOperation(getActiveUser(aRequest), commentIdString, operationString);\r
         }\r
       }\r
     }\r
@@ -122,7 +133,7 @@ public class ServletModuleLocalizer extends ServletModule {
     redirect(aResponse, returnUrlString);\r
   }\r
 \r
-  public void performArticleOperation(String anId, String anOperation) {\r
+  public void performArticleOperation(EntityAdapter aUser, String anId, String anOperation) {\r
     MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation;\r
     EntityAdapter article;\r
     EntityContent entity;\r
@@ -135,7 +146,7 @@ public class ServletModuleLocalizer extends ServletModule {
             makeEntityAdapter("content", entity);\r
         operation = MirGlobal.localizer().adminInterface().\r
             simpleArticleOperationForName(anOperation);\r
-        operation.perform(article);\r
+        operation.perform(aUser, article);\r
         logger.info("Operation " + anOperation + " successfully performed on article " + anId);\r
       }\r
       logger.error("Error while performing " + anOperation + " on article " + anId + ": article is null");\r
@@ -150,7 +161,7 @@ public class ServletModuleLocalizer extends ServletModule {
     String operationString = aRequest.getParameter("operation");\r
     String returnUrlString = aRequest.getParameter("returnurl");\r
 \r
-    performArticleOperation(articleIdString, operationString);\r
+    performArticleOperation(getActiveUser(aRequest), articleIdString, operationString);\r
     redirect(aResponse, returnUrlString);\r
   }\r
 \r
@@ -171,7 +182,7 @@ public class ServletModuleLocalizer extends ServletModule {
           String articleIdString = (String) parts.get(0);\r
           String operationString = (String) parts.get(1);\r
 \r
-          performArticleOperation(articleIdString, operationString);\r
+          performArticleOperation(getActiveUser(aRequest), articleIdString, operationString);\r
         }\r
       }\r
     }\r