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