source/mircoders/servlet/ServletModuleLocalizer.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  29  */
  30 package mircoders.servlet;
  31
  32 import java.util.HashMap;
  33 import java.util.List;
  34 import java.util.Map;
  35 import java.util.Vector;
  36
  37 import javax.servlet.http.HttpServletRequest;
  38 import javax.servlet.http.HttpServletResponse;
  39
  40 import mir.entity.adapter.EntityAdapter;
  41 import mir.log.LoggerWrapper;
  42 import mir.servlet.ServletModule;
  43 import mir.servlet.ServletModuleExc;
  44 import mir.util.StringRoutines;
  45 import mircoders.entity.EntityComment;
  46 import mircoders.entity.EntityContent;
  47 import mircoders.global.MirGlobal;
  48 import mircoders.localizer.MirAdminInterfaceLocalizer;
  49 import mircoders.module.ModuleComment;
  50 import mircoders.module.ModuleContent;
  51 import mircoders.storage.DatabaseComment;
  52 import mircoders.storage.DatabaseContent;
  53
  54 public class ServletModuleLocalizer extends ServletModule {
  55   private static ServletModuleLocalizer instance = new ServletModuleLocalizer();
  56   public static ServletModule getInstance() { return instance; }
  57
  58   private ModuleContent contentModule;
  59   private ModuleComment commentModule;
  60   private List administerOperations;
  61
  62   private ServletModuleLocalizer() {
  63     try {
  64       logger = new LoggerWrapper("ServletModule.Localizer");
  65
  66       contentModule = new ModuleContent(DatabaseContent.getInstance());
  67       commentModule = new ModuleComment(DatabaseComment.getInstance());
  68
  69       administerOperations = new Vector();
  70
  71       String settings[] = configuration.getStringArray("Mir.Localizer.Admin.AdministerOperations");
  72
  73       if (settings!=null) {
  74         for (int i = 0; i < settings.length; i++) {
  75           String setting = settings[i].trim();
  76
  77           if (setting.length() > 0) {
  78             List parts = StringRoutines.splitString(setting, ":");
  79             if (parts.size() != 2) {
  80               logger.error("config error: " + settings[i] + ", 2 parts expected");
  81             }
  82             else {
  83               Map entry = new HashMap();
  84               entry.put("name", (String) parts.get(0));
  85               entry.put("url", (String) parts.get(1));
  86               administerOperations.add(entry);
  87             }
  88           }
  89         }
  90       }
  91     }
  92     catch (Exception e) {
  93       logger.error("ServletModuleLocalizer could not be initialized: " + e.getMessage());
  94     }
  95   }
  96
  97   /**
  98    * Performs a localizer operation on an article.
  99    *
 100    * See also
 101    * {@link mircoders.localizer.MirAdminInterfaceLocalizer#simpleArticleOperations()}
 102    * {@link mircoders.localizer.MirAdminInterfaceLocalizer$MirSimpleEntityOperation()}
 103    *
 104    * @param aRequest       The originating request
 105    * @param anId           The id of the article
 106    * @param anOperation    The identifier of the operation to perform
 107    */
 108   public void performCommentOperation(HttpServletRequest aRequest, String anId, String anOperation) {
 109     MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation;
 110     EntityAdapter comment;
 111     EntityComment entity;
 112
 113     try {
 114       entity = (EntityComment) commentModule.getById(anId);
 115
 116       if (entity != null) {
 117         MirGlobal.performCommentOperation(ServletHelper.getUser(aRequest), entity, anOperation);
 118         logger.info("Operation " + anOperation + " successfully performed on comment " + anId);
 119         logAdminUsage(aRequest, "comment."+anId, "operation " + anOperation + " performed");
 120       }
 121       else {
 122         logger.error("Error while performing " + anOperation + " on comment " + anId + ": comment is null");
 123       }
 124     }
 125     catch (Throwable e) {
 126       logger.error("Error while performing " + anOperation + " on comment " + anId + ": " + e.getMessage());
 127     }
 128   }
 129
 130   public void commentoperation(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 131     String commentIdString = aRequest.getParameter("id");
 132     String operationString = aRequest.getParameter("operation");
 133     String returnUrlString = aRequest.getParameter("returnurl");
 134
 135     performCommentOperation(aRequest, commentIdString, operationString);
 136
 137     redirect(aResponse, returnUrlString);
 138   }
 139
 140   public void commentoperationbatch(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 141     String returnUrlString = aRequest.getParameter("returnurl");
 142
 143     String[] operations = aRequest.getParameterValues("operation");
 144
 145     if (operations!=null) {
 146       for (int i = 0; i < operations.length; i++) {
 147         if (operations[i].length() > 0) {
 148           List parts = StringRoutines.splitString(operations[i], ";");
 149
 150           if (parts.size() != 2) {
 151             logger.error("commentoperationbatch: operation string invalid: " +
 152                          operations[i]);
 153           }
 154           else {
 155             String commentIdString = (String) parts.get(0);
 156             String operationString = (String) parts.get(1);
 157
 158             performCommentOperation(aRequest, commentIdString, operationString);
 159           }
 160         }
 161       }
 162     }
 163
 164     redirect(aResponse, returnUrlString);
 165   }
 166
 167   public void performArticleOperation(HttpServletRequest aRequest, String anId, String anOperation) {
 168     MirAdminInterfaceLocalizer.MirSimpleEntityOperation operation;
 169     EntityAdapter article;
 170     EntityContent entity;
 171
 172     try {
 173       entity = (EntityContent) contentModule.getById(anId);
 174
 175       if (entity != null) {
 176         MirGlobal.performArticleOperation(ServletHelper.getUser(aRequest), entity, anOperation);
 177         logger.info("Operation " + anOperation + " successfully performed on article " + anId);
 178         logAdminUsage(aRequest, "article." + anId, "operation " + anOperation + " performed");
 179       }
 180       else {
 181         logger.error("Error while performing " + anOperation + " on article " + anId + ": article is null");
 182       }
 183     }
 184     catch (Throwable e) {
 185       logger.error("Error while performing " + anOperation + " on article " + anId + ": " + e.getMessage());
 186     }
 187   }
 188
 189   public void articleoperation(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 190     String articleIdString = aRequest.getParameter("articleid");
 191     String operationString = aRequest.getParameter("operation");
 192     String returnUrlString = aRequest.getParameter("returnurl");
 193
 194     performArticleOperation(aRequest, articleIdString, operationString);
 195     redirect(aResponse, returnUrlString);
 196   }
 197
 198   public void articleoperationbatch(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
 199     String returnUrlString = aRequest.getParameter("returnurl");
 200
 201     String[] operations = aRequest.getParameterValues("operation");
 202
 203     if (operations!=null) {
 204
 205       for (int i = 0; i < operations.length; i++) {
 206         if (operations[i].length() > 0) {
 207           List parts = StringRoutines.splitString(operations[i], ";");
 208
 209           if (parts.size() != 2) {
 210             logger.error("articleoperationbatch: operation string invalid: " + operations[i]);
 211           }
 212           else {
 213             String articleIdString = (String) parts.get(0);
 214             String operationString = (String) parts.get(1);
 215
 216             performArticleOperation(aRequest, articleIdString, operationString);
 217           }
 218         }
 219       }
 220     }
 221
 222     redirect(aResponse, returnUrlString);
 223   }
 224
 225   public List getAdministerOperations() throws ServletModuleExc {
 226     return administerOperations;
 227   }
 228 }