2 * Copyright (C) 2001, 2002 The Mir-coders group
4 * This file is part of Mir.
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.
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.
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
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.
31 package mircoders.abuse;
33 import mir.entity.Entity;
34 import mir.entity.adapter.EntityAdapter;
35 import mir.entity.adapter.EntityAdapterModel;
36 import mir.entity.adapter.EntityIteratorAdapter;
37 import mir.log.LoggerWrapper;
38 import mir.session.Request;
39 import mir.storage.DatabaseExc;
40 import mir.storage.DatabaseHelper;
41 import mircoders.global.MirGlobal;
42 import mircoders.storage.DatabaseFilter;
43 import mircoders.storage.DatabaseFilterGroup;
45 import java.util.ArrayList;
46 import java.util.Collections;
47 import java.util.Date;
48 import java.util.HashMap;
49 import java.util.Iterator;
50 import java.util.List;
52 /** The FilterEngine manages a list of all filters and filter groups.
53 * Use the testPosting() method to apply all filters on an
54 * Entity (for ex. an article or a comment)
56 public class FilterEngine {
57 private final Map filterTypes = new HashMap();
58 private final List filterTypeIds = new ArrayList();
60 private final List filterGroups = new ArrayList();
61 private final Map idToFilterGroup = new HashMap();
62 private final LoggerWrapper logger = new LoggerWrapper("Global.Abuse.FilterEngine");
63 private EntityAdapterModel model;
65 public FilterEngine(EntityAdapterModel aModel) {
67 Iterator i = MirGlobal.localizer().openPostings().getAntiAbuseFilterTypes().iterator();
69 FilterType filterType = (FilterType) i.next();
71 filterTypes.put(filterType.getName(), filterType);
72 filterTypeIds.add(filterType.getName());
76 throw new RuntimeException(t.getMessage());
84 /** applies all filters from all filter groups to an Entity.
85 * The entity may be, for example, an article, or a comment.
86 * It returns a filter that matches if it finds one, null otherwise
88 public synchronized Filter testPosting(Entity anEntity, Request aRequest) {
89 Iterator i = filterGroups.iterator();
91 FilterGroup group = (FilterGroup) i.next();
93 Iterator j = group.getFilters().iterator();
95 Filter filter = (Filter) j.next();
97 if (filter.test(anEntity, aRequest)) {
101 catch (Throwable t) {
102 logger.warn("Exception thrown while testing filter " + filter.getType() + " ( " + filter.getExpression() + ") " + t.toString());
110 public List getFilterTypes() {
112 List result = new ArrayList();
114 Iterator i = filterTypeIds.iterator();
115 while (i.hasNext()) {
116 String id = (String) i.next();
118 Map action = new HashMap();
119 action.put("resource", id);
120 action.put("identifier", id);
127 catch (Throwable t) {
128 throw new RuntimeException("can't get article actions: " + t.getMessage());
131 /** This class reflects a row of the filter_group
132 * database table. Filters groups allow you to organize
133 * your filters. For example: group1=spammer ,
136 public class FilterGroup {
137 private List filters;
138 private Entity entity;
139 private Map idToFilter;
141 public FilterGroup(Entity anEntity) {
142 this (anEntity, Collections.EMPTY_LIST);
145 public FilterGroup(Entity anEntity, List aFilters) {
147 filters = new ArrayList();
148 idToFilter = new HashMap();
149 Iterator i = aFilters.iterator();
151 while (i.hasNext()) {
152 Entity entity = (Entity) i.next();
154 Filter filter = new Filter(entity);
155 introduceFilter(filter);
162 public Entity getEntity() {
166 public EntityAdapter getEntityAdapter() {
167 return model.makeEntityAdapter("filterGroup", entity);
170 public List getFilterEntityAdapterList() {
171 List result = new ArrayList();
173 Iterator i = filters.iterator();
174 while (i.hasNext()) {
175 Filter filter = (Filter) i.next();
176 result.add(filter.getEntityAdapter());
182 public List getFilters() {
186 public Filter getFilterForId(String anId) {
187 Filter result = (Filter) idToFilter.get(anId);
189 throw new NullPointerException("No such filter");
195 private void introduceFilter(Filter aFilter) {
196 filters.add(aFilter);
197 idToFilter.put(aFilter.getEntity().getId(), aFilter);
200 private void removeFilter(Filter aFilter) {
201 filters.remove(aFilter);
202 idToFilter.remove(aFilter.getEntity().getId());
205 private void deleteFilter(String anId) {
206 Filter filter = getFilterForId(anId);
207 removeFilter(filter);
208 DatabaseFilter.getInstance().delete(anId);
211 public void populateFilterEntity(Entity anEntity, String aType, String anExpression,
212 String aComments, String aTag, String anArticleAction,
213 String aCommentAction) {
215 anEntity.setFieldValue("type", aType);
216 anEntity.setFieldValue("expression", anExpression);
217 anEntity.setFieldValue("comment", aComments);
218 anEntity.setFieldValue("tag", aTag);
219 anEntity.setFieldValue("articleaction", anArticleAction);
220 anEntity.setFieldValue("commentaction", aCommentAction);
223 public String updateFilter(String anId, String aType, String anExpression,
224 String aComments, String aTag, String anArticleAction,
225 String aCommentAction) {
228 getFilterTypeForId(aType).constructFilterInstance(anExpression);
231 return e.getMessage();
234 Entity entity = getFilterForId(anId).getEntity();
235 populateFilterEntity(entity, aType, anExpression, aComments, aTag,
236 anArticleAction, aCommentAction);
242 public String createFilter(String aType, String anExpression,
243 String aComments, String aTag, String anArticleAction,
244 String aCommentAction) throws DatabaseExc {
245 FilterInstance instance;
248 instance = getFilterTypeForId(aType).constructFilterInstance(anExpression);
251 return e.getMessage();
254 Entity entity = DatabaseFilter.getInstance().createNewEntity();
255 populateFilterEntity(entity, aType, anExpression, aComments, aTag,
256 anArticleAction, aCommentAction);
257 entity.setFieldValue("priority", "1");
258 entity.setFieldValue("filter_group_id", getEntity().getId());
261 Filter filter = new Filter(entity, instance);
262 introduceFilter(filter);
267 public String getName() {
268 return entity.getFieldValue("name");
272 /** This class reflects a row of the filter database table.
273 * To actually run a filter on data, use the test() method.
274 * This class will automatically retreive and use the correct
277 public class Filter {
278 private Entity entity;
279 private FilterInstance instance;
281 public Filter(Entity anEntity) throws AbuseExc {
282 this(anEntity, getFilterTypeForId(anEntity.getFieldValue("type")).constructFilterInstance(anEntity.getFieldValue("expression")));
285 public Filter(Entity anEntity, FilterInstance anInstance) {
287 instance = anInstance;
290 public Entity getEntity() {
294 public EntityAdapter getEntityAdapter() {
295 return model.makeEntityAdapter("filter", entity);
298 public void update(String aType, String anExpression, String aComments, String aTag,
299 String anArticleAction, String aCommentAction) throws AbuseExc {
301 instance = getFilterTypeForId(aType).constructFilterInstance(anExpression);
303 entity.setFieldValue("type", aType);
304 entity.setFieldValue("expression", anExpression);
305 entity.setFieldValue("tag", aType);
306 entity.setFieldValue("comment", aComments);
307 entity.setFieldValue("articleaction", anArticleAction);
308 entity.setFieldValue("commentaction", aCommentAction);
309 entity.setFieldValue("last_hit", null);
313 public void updateLastHit(Date aDate) {
314 entity.setFieldValue("last_hit",
315 DatabaseHelper.convertDateToInternalRepresenation(
316 new Date(System.currentTimeMillis())));
320 public String getType() {
321 return entity.getFieldValue("type");
324 public String getExpression() {
325 return entity.getFieldValue("expression");
328 public String getTag() {
329 return entity.getFieldValue("tag");
332 public String getComment() {
333 return entity.getFieldValue("comment");
336 public String getArticleAction() {
337 return entity.getFieldValue("articleaction");
340 public String getCommentAction() {
341 return entity.getFieldValue("commentaction");
344 public FilterInstance getInstance() {
348 public boolean test(Entity anEntity, Request aRequest) {
349 return instance.test(anEntity, aRequest);
353 public synchronized void reload() {
354 filterGroups.clear();
355 idToFilterGroup.clear();
358 Iterator i = new EntityIteratorAdapter("", "priority asc", 100, model, "filterGroup");
359 while (i.hasNext()) {
360 EntityAdapter entityAdapter = (EntityAdapter) i.next();
361 List filters = new ArrayList();
362 Iterator j = (Iterator) entityAdapter.getIterator("to_filters");
363 while (j.hasNext()) {
364 filters.add(((EntityAdapter) j.next()).getEntity());
367 FilterGroup filterGroup = new FilterGroup(entityAdapter.getEntity(), filters);
368 introduceFilterGroup(filterGroup);
371 catch (Throwable e) {
372 logger.error("Can't load filters: " + e.getMessage());
376 public synchronized List getFilterGroups() {
377 List result = new ArrayList();
378 Iterator i = filterGroups.iterator();
379 while (i.hasNext()) {
380 result.add(((FilterGroup) i.next()).getEntityAdapter());
386 public synchronized void updateFilterGroup(String anId, String aName) {
387 FilterGroup filterGroup = getFilterGroupForId(anId);
388 filterGroup.getEntity().setFieldValue("name", aName);
389 filterGroup.getEntity().update();
392 public synchronized void addFilterGroup(String aName) throws DatabaseExc {
393 Entity entity = DatabaseFilterGroup.getInstance().createNewEntity();
394 entity.setFieldValue("name", aName);
395 entity.setFieldValue("priority", "1");
398 FilterGroup filterGroup = new FilterGroup(entity);
399 introduceFilterGroup(filterGroup);
402 public synchronized void deleteFilterGroup(String anId) {
404 FilterGroup filterGroup = getFilterGroupForId(anId);
405 removeFilterGroup(filterGroup);
406 DatabaseFilter.getInstance().deleteByWhereClause("filter_group_id = " + anId);
407 DatabaseFilterGroup.getInstance().delete(anId);
410 public synchronized void deleteFilter(String aGroupId, String anId) {
411 getFilterGroupForId(aGroupId).deleteFilter(anId);
415 public synchronized String updateFilter(String aGroupId, String anId,
416 String aType, String anExpression,
419 String anArticleAction,
420 String aCommentAction) {
421 return getFilterGroupForId(aGroupId).updateFilter(anId, aType,
422 anExpression, aComments, aTag, anArticleAction, aCommentAction);
425 public synchronized String addFilter(String aGroupId,
426 String aType, String anExpression,
429 String anArticleAction,
430 String aCommentAction) throws DatabaseExc {
431 return getFilterGroupForId(aGroupId).createFilter(aType, anExpression,
432 aComments, aTag, anArticleAction, aCommentAction);
436 public FilterGroup getFilterGroupForId(String anId) {
437 FilterGroup result = (FilterGroup) idToFilterGroup.get(anId);
438 if (result == null) {
439 throw new NullPointerException("No such filter group");
445 public Filter getFilterForId(String aGroupId, String anId) {
446 return getFilterGroupForId(aGroupId).getFilterForId(anId);
450 public List getFilters(String aFilterGroupId) {
451 return getFilterGroupForId(aFilterGroupId).getFilterEntityAdapterList();
454 private synchronized void introduceFilterGroup(FilterGroup aFilterGroup) {
455 filterGroups.add(aFilterGroup);
456 idToFilterGroup.put(aFilterGroup.getEntity().getId(), aFilterGroup);
459 private synchronized void removeFilterGroup(FilterGroup aFilterGroup) {
460 filterGroups.remove(aFilterGroup);
461 idToFilterGroup.remove(aFilterGroup.getEntity().getId());
464 private FilterType getFilterTypeForId(String anId) {
465 return (FilterType) filterTypes.get(anId);