adding doc on search framework
[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 java.util.ArrayList;
33 import java.util.HashMap;
34 import java.util.Iterator;
35 import java.util.List;
36 import java.util.Map;
37 import java.util.Random;
38
39 import mir.config.MirPropertiesConfiguration;
40 import mir.log.LoggerWrapper;
41 import mir.session.Request;
42 import mir.session.Session;
43 import mir.session.SessionHandler;
44 import mircoders.abuse.FilterType;
45 import mircoders.abuse.IPFilterType;
46 import mircoders.abuse.RegularExpressionFilterType;
47 import mircoders.abuse.ThrottleFilter;
48 import mircoders.entity.EntityComment;
49 import mircoders.entity.EntityContent;
50 import mircoders.global.MirGlobal;
51 import mircoders.global.ProducerEngine;
52 import mircoders.localizer.MirLocalizerExc;
53 import mircoders.localizer.MirLocalizerFailure;
54 import mircoders.localizer.MirOpenPostingLocalizer;
55
56 public class MirBasicOpenPostingLocalizer implements MirOpenPostingLocalizer {
57   private List afterContentProducerTasks;
58   private List afterCommentProducerTasks;
59   private List filterTypes;
60   private Map filterTypesMap;
61   protected LoggerWrapper logger;
62   protected MirPropertiesConfiguration configuration;
63
64   public MirBasicOpenPostingLocalizer() throws MirLocalizerExc, MirLocalizerFailure {
65     logger = new LoggerWrapper("Localizer.Basic.OpenPosting");
66
67     try {
68       configuration = MirPropertiesConfiguration.instance();
69     }
70     catch (Throwable e) {
71       throw new MirLocalizerFailure("Can't get configuration: " + e.getMessage(), e);
72     }
73
74     try {
75       String contentProducers = MirGlobal.config().getString("Mir.Localizer.OpenPosting.ContentProducers");
76       String commentProducers = MirGlobal.config().getString("Mir.Localizer.OpenPosting.CommentProducers");
77
78       afterContentProducerTasks = ProducerEngine.ProducerTask.parseProducerTaskList(contentProducers);
79       afterCommentProducerTasks = ProducerEngine.ProducerTask.parseProducerTaskList(commentProducers);
80     }
81     catch (Throwable t) {
82       logger.error("Setting up MirBasicOpenPostingLocalizer failed: " + t.getMessage());
83
84       throw new MirLocalizerFailure(t);
85     }
86
87     filterTypes = new ArrayList();
88     filterTypesMap = new HashMap();
89
90     addSimpleAntiAbuseFilterType(new RegularExpressionFilterType("regexp"));
91     addSimpleAntiAbuseFilterType(new RegularExpressionFilterType("useragent", false, false,
92         RegularExpressionFilterType.REQUEST_HEADERS, new String[] {"User-Agent"}));
93     addSimpleAntiAbuseFilterType(new IPFilterType("ip"));
94     addSimpleAntiAbuseFilterType(new RegularExpressionFilterType("hostname", false, false,
95         RegularExpressionFilterType.REQUEST_HEADERS, new String[] {"hostname"}));
96     addSimpleAntiAbuseFilterType(new ThrottleFilter("throttle"));
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 afterContentPosting(EntityContent aContent) {
137     afterContentPosting();
138   }
139
140   public void afterCommentPosting(EntityComment aComment) {
141     afterCommentPosting();
142   }
143
144   public void afterCommentPosting() {
145     Iterator i = afterCommentProducerTasks.iterator();
146
147     while (i.hasNext()) {
148       ProducerEngine.ProducerTask task = (ProducerEngine.ProducerTask) i.next();
149
150       try {
151         MirGlobal.getProducerEngine().addTask(task);
152       }
153       catch (Throwable t) {
154         logger.error("Error adding comment task "+task.getProducer()+"::"+task.getVerb()+": " + t.toString());
155       }
156     }
157   }
158
159   public String generateOnetimePassword() {
160     Random r = new Random();
161     int random = r.nextInt();
162
163     long l = System.currentTimeMillis();
164
165     l = (l*l*l*l)/random;
166     if (l<0)
167       l = l * -1;
168
169     String returnString = ""+l;
170
171     return returnString.substring(5);
172   }
173
174   public List getAntiAbuseFilterTypes() {
175     return filterTypes;
176   }
177
178   public void removeSimpleAntiAbuseFilterType(String aName) {
179     filterTypes.remove(filterTypesMap.get(aName));
180     filterTypesMap.remove(aName);
181   }
182
183   public void addSimpleAntiAbuseFilterType(FilterType aFilterType) {
184     removeSimpleAntiAbuseFilterType(aFilterType.getName());
185     filterTypesMap.put(aFilterType.getName(), aFilterType);
186     filterTypes.add(aFilterType);
187   }
188 }