adminster operation configuration now supports escape characters
[mir.git] / source / mircoders / servlet / ServletModuleLocalizer.java
index 6f122b2..1967049 100755 (executable)
-/*\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.servlet;\r
-\r
-import java.util.List;\r
-\r
-import javax.servlet.http.HttpServletRequest;\r
-import javax.servlet.http.HttpServletResponse;\r
-import javax.servlet.http.HttpSession;\r
-\r
-import mir.entity.adapter.EntityAdapter;\r
-import mir.log.LoggerWrapper;\r
-import mir.servlet.ServletModule;\r
-import mir.servlet.ServletModuleExc;\r
-import mir.servlet.ServletModuleFailure;\r
-import mir.util.StringRoutines;\r
-import mircoders.entity.EntityComment;\r
-import mircoders.entity.EntityContent;\r
-import mircoders.entity.EntityUsers;\r
-import mircoders.global.MirGlobal;\r
-import mircoders.localizer.MirAdminInterfaceLocalizer;\r
-import mircoders.module.ModuleComment;\r
-import mircoders.module.ModuleContent;\r
-import mircoders.storage.DatabaseComment;\r
-import mircoders.storage.DatabaseContent;\r
-\r
-public class ServletModuleLocalizer extends ServletModule {\r
-  private static ServletModuleLocalizer instance = new ServletModuleLocalizer();\r
-  public static ServletModule getInstance() { return instance; }\r
-\r
-  private ModuleContent contentModule;\r
-  private ModuleComment commentModule;\r
-\r
-  private ServletModuleLocalizer() {\r
-    try {\r
-      contentModule = new ModuleContent(DatabaseContent.getInstance());\r
-      commentModule = new ModuleComment(DatabaseComment.getInstance());\r
-\r
-      logger = new LoggerWrapper("ServletModule.Localizer");\r
-    }\r
-    catch (Exception e) {\r
-      logger.error("ServletModuleLocalizer could not be initialized: " + e.getMessage());\r
-    }\r
-  }\r
-\r
-  private EntityAdapter getActiveUser(HttpServletRequest aRequest) throws ServletModuleExc {\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 (Throwable e) {\r
-      throw new ServletModuleFailure("ServletModuleLocalizer.getActiveUser: " + e.getMessage(), e);\r
-    }\r
-  }\r
-\r
-  public void performCommentOperation(EntityAdapter aUser, String anId, String anOperation) {\r
-    MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation;\r
-    EntityAdapter comment;\r
-    EntityComment entity;\r
-\r
-    try {\r
-      entity = (EntityComment) commentModule.getById(anId);\r
-\r
-      if (entity != null) {\r
-        comment = MirGlobal.localizer().dataModel().adapterModel().makeEntityAdapter("comment", entity);\r
-        operation = MirGlobal.localizer().adminInterface().simpleCommentOperationForName(anOperation);\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
-    }\r
-    catch (Throwable e) {\r
-      logger.error("Error while performing " + anOperation + " on comment " + anId + ": " + e.getMessage());\r
-    }\r
-  }\r
-\r
-  public void commentoperation(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {\r
-    String commentIdString = aRequest.getParameter("id");\r
-    String operationString = aRequest.getParameter("operation");\r
-    String returnUrlString = aRequest.getParameter("returnurl");\r
-\r
-    performCommentOperation(getActiveUser(aRequest), commentIdString, operationString);\r
-\r
-    redirect(aResponse, returnUrlString);\r
-  }\r
-\r
-  public void commentoperationbatch(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {\r
-    String returnUrlString = aRequest.getParameter("returnurl");\r
-\r
-    String[] operations = aRequest.getParameterValues("operation");\r
-\r
-    for (int i=0; i<operations.length; i++) {\r
-      if (operations[i].length()>0) {\r
-        List parts = StringRoutines.splitString(operations[i], ";");\r
-\r
-        if (parts.size() != 2) {\r
-          logger.error("commentoperationbatch: operation string invalid: " +\r
-                       operations[i]);\r
-        }\r
-        else {\r
-          String commentIdString = (String) parts.get(0);\r
-          String operationString = (String) parts.get(1);\r
-\r
-          performCommentOperation(getActiveUser(aRequest), commentIdString, operationString);\r
-        }\r
-      }\r
-    }\r
-\r
-    redirect(aResponse, returnUrlString);\r
-  }\r
-\r
-  public void performArticleOperation(EntityAdapter aUser, String anId, String anOperation) {\r
-    MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation;\r
-    EntityAdapter article;\r
-    EntityContent entity;\r
-\r
-    try {\r
-      entity = (EntityContent) contentModule.getById(anId);\r
-\r
-      if (entity != null) {\r
-        article = MirGlobal.localizer().dataModel().adapterModel().\r
-            makeEntityAdapter("content", entity);\r
-        operation = MirGlobal.localizer().adminInterface().\r
-            simpleArticleOperationForName(anOperation);\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
-    }\r
-    catch (Throwable e) {\r
-      logger.error("Error while performing " + anOperation + " on article " + anId + ": " + e.getMessage());\r
-    }\r
-  }\r
-\r
-  public void articleoperation(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {\r
-    String articleIdString = aRequest.getParameter("articleid");\r
-    String operationString = aRequest.getParameter("operation");\r
-    String returnUrlString = aRequest.getParameter("returnurl");\r
-\r
-    performArticleOperation(getActiveUser(aRequest), articleIdString, operationString);\r
-    redirect(aResponse, returnUrlString);\r
-  }\r
-\r
-  public void articleoperationbatch(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {\r
-    String returnUrlString = aRequest.getParameter("returnurl");\r
-\r
-    String[] operations = aRequest.getParameterValues("operation");\r
-\r
-    for (int i=0; i<operations.length; i++) {\r
-      if (operations[i].length()>0) {\r
-        List parts = StringRoutines.splitString(operations[i], ";");\r
-\r
-        if (parts.size() != 2) {\r
-          logger.error("articleoperationbatch: operation string invalid: " +\r
-                       operations[i]);\r
-        }\r
-        else {\r
-          String articleIdString = (String) parts.get(0);\r
-          String operationString = (String) parts.get(1);\r
-\r
-          performArticleOperation(getActiveUser(aRequest), articleIdString, operationString);\r
-        }\r
-      }\r
-    }\r
-\r
-    redirect(aResponse, returnUrlString);\r
-  }\r
-\r
+/*
+ * 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  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.servlet;
+
+import mir.servlet.AdminServletModule;
+import mir.servlet.ServletModuleExc;
+import mir.util.StringRoutines;
+import mircoders.entity.EntityComment;
+import mircoders.entity.EntityContent;
+import mircoders.global.MirGlobal;
+import mircoders.module.ModuleComment;
+import mircoders.module.ModuleContent;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class ServletModuleLocalizer extends AdminServletModule {
+  private final ModuleContent contentModule = new ModuleContent();
+  private final ModuleComment commentModule = new ModuleComment();
+  private final List administerOperations = new ArrayList();
+
+  public ServletModuleLocalizer() {
+    try {
+      String settings[] = 
+          getConfiguration().getStringArray("Mir.Localizer.Admin.AdministerOperations");
+
+      if (settings!=null) {
+        for (int i = 0; i < settings.length; i++) {
+          String setting = settings[i].trim();
+
+          if (setting.length() > 0) {
+            List parts = StringRoutines.splitStringWithEscape(setting, ':', '\\');
+            if (parts.size() != 2) {
+              getLogger().error("config error: " + settings[i] + ", 2 parts expected");
+            }
+            else {
+              Map entry = new HashMap();
+              entry.put("name", parts.get(0));
+              entry.put("url", parts.get(1));
+              administerOperations.add(entry);
+            }
+          }
+        }
+      }
+    }
+    catch (Exception e) {
+      getLogger().error("ServletModuleLocalizer could not be initialized" + e.getMessage(), e);
+    }
+  }
+
+  /**
+   * Performs a localizer operation on an article.
+   *
+   * See also
+   * {@link mircoders.localizer.MirAdminInterfaceLocalizer#simpleArticleOperations()}
+   *
+   * @param aRequest       The originating request
+   * @param anId           The id of the article
+   * @param anOperation    The identifier of the operation to perform
+   */
+  public void performCommentOperation(HttpServletRequest aRequest, String anId, String anOperation) {
+    try {
+      EntityComment entity = (EntityComment) commentModule.getById(anId);
+
+      if (entity != null) {
+        MirGlobal.performCommentOperation(ServletHelper.getUser(aRequest), entity, anOperation);
+        getLogger().debug("Operation " + anOperation + " successfully performed on comment " + anId);
+        logAdminUsage(aRequest, "comment."+anId, "operation " + anOperation + " performed");
+      }
+      else {
+        getLogger().error("Error while performing " + anOperation + " on comment " + anId + ": comment is null");
+      }
+    }
+    catch (Throwable e) {
+      getLogger().error("Error while performing " + anOperation + " on comment " + anId + ": " + e.getMessage(), e);
+    }
+  }
+
+  public void commentoperation(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
+    String commentIdString = aRequest.getParameter("id");
+    String operationString = aRequest.getParameter("operation");
+    String returnUrlString = aRequest.getParameter("returnurl");
+
+    performCommentOperation(aRequest, commentIdString, operationString);
+
+    ServletHelper.redirect(aResponse, returnUrlString);
+  }
+
+  public void operation(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
+    String type = aRequest.getParameter("objecttype");
+    String id = aRequest.getParameter("id");
+    String operation = aRequest.getParameter("operation");
+    String returnUrl = aRequest.getParameter("returnurl");
+
+
+    if ("comment".equals(type)) {
+      performCommentOperation(aRequest, id, operation);
+    }
+    else {
+      performArticleOperation(aRequest, id, operation);
+    }
+
+    ServletHelper.redirect(aResponse, returnUrl);
+  }
+
+  public void commentoperationbatch(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
+    String returnUrlString = aRequest.getParameter("returnurl");
+
+    String[] operations = aRequest.getParameterValues("operation");
+
+    if (operations!=null) {
+      for (int i = 0; i < operations.length; i++) {
+        if (operations[i].length() > 0) {
+          List parts = StringRoutines.splitString(operations[i], ";");
+
+          if (parts.size() != 2) {
+            getLogger().error("commentoperationbatch: operation string invalid: " +
+                         operations[i]);
+          }
+          else {
+            String commentIdString = (String) parts.get(0);
+            String operationString = (String) parts.get(1);
+
+            performCommentOperation(aRequest, commentIdString, operationString);
+          }
+        }
+      }
+    }
+
+    ServletHelper.redirect(aResponse, returnUrlString);
+  }
+
+  public void operationbatch(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
+    String returnUrlString = aRequest.getParameter("returnurl");
+
+    String[] operations = aRequest.getParameterValues("operation");
+
+    if (operations!=null) {
+      for (int i = 0; i < operations.length; i++) {
+        if (operations[i].length() > 0) {
+          List parts = StringRoutines.splitString(operations[i], ";");
+
+          if (parts.size() != 3) {
+            getLogger().error("commentoperationbatch: operation string invalid: " +
+                         operations[i]);
+          }
+          else {
+            String type = (String) parts.get(0);
+            String id = (String) parts.get(1);
+            String operationString = (String) parts.get(2);
+
+            if ("comment".equals(type)) {
+              performCommentOperation(aRequest, id, operationString);
+            }
+            else {
+              performArticleOperation(aRequest, id, operationString);
+            }
+          }
+        }
+      }
+    }
+
+    ServletHelper.redirect(aResponse, returnUrlString);
+  }
+  public void performArticleOperation(HttpServletRequest aRequest, String anId, String anOperation) {
+    EntityContent entity;
+
+    try {
+      entity = (EntityContent) contentModule.getById(anId);
+
+      if (entity != null) {
+        MirGlobal.performArticleOperation(ServletHelper.getUser(aRequest), entity, anOperation);
+        getLogger().info("Operation " + anOperation + " successfully performed on article " + anId);
+        logAdminUsage(aRequest, "article." + anId, "operation " + anOperation + " performed");
+      }
+      else {
+        getLogger().error("Error while performing " + anOperation + " on article " + anId + ": article is null");
+      }
+    }
+    catch (Throwable e) {
+      getLogger().error("Error while performing " + anOperation + " on article " + anId + ": " + e.getMessage());
+    }
+  }
+
+  public void articleoperation(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
+    String articleIdString = aRequest.getParameter("articleid");
+    String operationString = aRequest.getParameter("operation");
+    String returnUrlString = aRequest.getParameter("returnurl");
+
+    performArticleOperation(aRequest, articleIdString, operationString);
+    ServletHelper.redirect(aResponse, returnUrlString);
+  }
+
+  public void articleoperationbatch(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
+    String returnUrlString = aRequest.getParameter("returnurl");
+
+    String[] operations = aRequest.getParameterValues("operation");
+
+    if (operations!=null) {
+
+      for (int i = 0; i < operations.length; i++) {
+        if (operations[i].length() > 0) {
+          List parts = StringRoutines.splitString(operations[i], ";");
+
+          if (parts.size() != 2) {
+            getLogger().error("articleoperationbatch: operation string invalid: " + operations[i]);
+          }
+          else {
+            String articleIdString = (String) parts.get(0);
+            String operationString = (String) parts.get(1);
+
+            performArticleOperation(aRequest, articleIdString, operationString);
+          }
+        }
+      }
+    }
+
+    ServletHelper.redirect(aResponse, returnUrlString);
+  }
+
+  public List getAdministerOperations() throws ServletModuleExc {
+    return administerOperations;
+  }
 }
\ No newline at end of file