support for CAPTCHAs
[mir.git] / source / mircoders / localizer / basic / MirBasicOpenPostingLocalizer.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.localizer.basic;
31
32 import mir.config.MirPropertiesConfiguration;
33 import mir.log.LoggerWrapper;
34 import mir.session.Request;
35 import mir.session.Session;
36 import mir.session.SessionHandler;
37 import mircoders.abuse.*;
38 import mircoders.entity.EntityComment;
39 import mircoders.entity.EntityContent;
40 import mircoders.global.MirGlobal;
41 import mircoders.global.ProducerEngine;
42 import mircoders.localizer.MirLocalizerExc;
43 import mircoders.localizer.MirLocalizerFailure;
44 import mircoders.localizer.MirOpenPostingLocalizer;
45
46 import java.util.*;
47 import java.awt.image.BufferedImage;
48
49 import com.octo.captcha.service.image.DefaultManageableImageCaptchaService;
50 import com.octo.captcha.service.image.ImageCaptchaService;
51
52 public class MirBasicOpenPostingLocalizer implements MirOpenPostingLocalizer {
53   private List afterContentProducerTasks;
54   private List afterCommentProducerTasks;
55   private List filterTypes;
56   private Map filterTypesMap;
57   protected LoggerWrapper logger;
58   protected MirPropertiesConfiguration configuration;
59   private static ImageCaptchaService captchaService = new DefaultManageableImageCaptchaService();
60
61   public MirBasicOpenPostingLocalizer() throws MirLocalizerFailure {
62     logger = new LoggerWrapper("Localizer.Basic.OpenPosting");
63
64     try {
65       configuration = MirPropertiesConfiguration.instance();
66     }
67     catch (Throwable e) {
68       throw new MirLocalizerFailure("Can't get configuration: " + e.getMessage(), e);
69     }
70
71     try {
72       String contentProducers = MirGlobal.config().getString("Mir.Localizer.OpenPosting.ContentProducers");
73       String commentProducers = MirGlobal.config().getString("Mir.Localizer.OpenPosting.CommentProducers");
74
75       afterContentProducerTasks = ProducerEngine.ProducerTask.parseProducerTaskList(contentProducers);
76       afterCommentProducerTasks = ProducerEngine.ProducerTask.parseProducerTaskList(commentProducers);
77     }
78     catch (Throwable t) {
79       logger.error("Setting up MirBasicOpenPostingLocalizer failed: " + t.getMessage());
80
81       throw new MirLocalizerFailure(t);
82     }
83
84     filterTypes = new ArrayList();
85     filterTypesMap = new HashMap();
86
87     addSimpleAntiAbuseFilterType(new RegularExpressionFilterType("regexp"));
88     addSimpleAntiAbuseFilterType(new SubStringFilterType("useragent", false, false,
89         SubStringFilterType.REQUEST_HEADERS, new String[] {"User-Agent"}));
90     addSimpleAntiAbuseFilterType(new IPFilterType("ip"));
91     addSimpleAntiAbuseFilterType(new RegularExpressionFilterType("hostname", false, false,
92         RegularExpressionFilterType.REQUEST_HEADERS, new String[] {"hostname"}));
93     addSimpleAntiAbuseFilterType(new ThrottleFilter("throttle"));
94     addSimpleAntiAbuseFilterType(new PostingSizeFilterType("size"));
95     addSimpleAntiAbuseFilterType(new URLBlacklistFilterType("urlblacklist",
96         Arrays.asList(MirGlobal.config().getStringArray("Mir.URLBlacklistFilter.WhiteList"))));
97   }
98
99   public SessionHandler getOpenSessionHandler(String aSessionType) throws MirLocalizerExc, MirLocalizerFailure  {
100     if ("email".equals(aSessionType))
101       return new MirBasicEmailArticleHandler();
102
103     if ("comment".equals(aSessionType))
104       return new MirBasicCommentPostingHandler(configuration.getBoolean("Localizer.OpenSession.PersistentUploadedFiles"));
105
106     if ("translation".equals(aSessionType))
107       return new MirBasicTranslationPostingHandler();
108
109     return new MirBasicArticlePostingHandler(configuration.getBoolean("Localizer.OpenSession.PersistentUploadedFiles"));
110   }
111
112   public SessionHandler getOpenSessionHandler(Request aRequest, Session aSession) throws MirLocalizerExc, MirLocalizerFailure {
113     if (aSession.getAttribute("handler")==null)
114     {
115       aSession.setAttribute("handler", getOpenSessionHandler(aRequest.getParameter("sessiontype")));
116     }
117
118     return (SessionHandler) aSession.getAttribute("handler");
119   }
120
121   public void afterContentPosting() {
122     Iterator i = afterContentProducerTasks.iterator();
123
124     while (i.hasNext()) {
125       ProducerEngine.ProducerTask task = (ProducerEngine.ProducerTask) i.next();
126
127       try {
128         MirGlobal.getProducerEngine().addTask(task);
129       }
130       catch (Throwable t) {
131         logger.error("Error adding content task "+task.getProducer()+"::"+task.getVerb()+": " + t.toString());
132       }
133     }
134   }
135
136   public void afterArticlePosting() {
137     afterContentPosting();
138   }
139
140   public void afterArticlePosting(EntityContent anArticle) {
141     afterContentPosting(anArticle);
142   }
143
144   public void afterContentPosting(EntityContent anArticle) {
145     afterArticlePosting();
146   }
147
148   public void afterCommentPosting(EntityComment aComment) {
149     afterCommentPosting();
150   }
151
152   public void afterCommentPosting() {
153     Iterator i = afterCommentProducerTasks.iterator();
154
155     while (i.hasNext()) {
156       ProducerEngine.ProducerTask task = (ProducerEngine.ProducerTask) i.next();
157
158       try {
159         MirGlobal.getProducerEngine().addTask(task);
160       }
161       catch (Throwable t) {
162         logger.error("Error adding comment task "+task.getProducer()+"::"+task.getVerb()+": " + t.toString());
163       }
164     }
165   }
166
167   public List getAntiAbuseFilterTypes() {
168     return Collections.unmodifiableList(filterTypes);
169   }
170
171   public boolean allowArticlePublication(EntityContent anArticle){
172     return anArticle != null && "1".equals(anArticle.getFieldValue("is_published"));
173   }
174
175   public void removeSimpleAntiAbuseFilterType(String aName) {
176     filterTypes.remove(filterTypesMap.get(aName));
177     filterTypesMap.remove(aName);
178   }
179
180   public void addSimpleAntiAbuseFilterType(FilterType aFilterType) {
181     removeSimpleAntiAbuseFilterType(aFilterType.getName());
182     filterTypesMap.put(aFilterType.getName(), aFilterType);
183     filterTypes.add(aFilterType);
184   }
185
186   public Captcha generateCaptcha(final String aSessionId) {
187     final BufferedImage challenge = captchaService.getImageChallengeForID(aSessionId);
188
189     return new Captcha() {
190
191       public BufferedImage getChallenge() {
192         return challenge;
193       }
194
195       public boolean validateAnswer(String anAnswer) {
196         return captchaService.validateResponseForID(aSessionId, anAnswer).booleanValue();
197       }
198     };
199   }
200
201 }