support for CAPTCHAs
[mir.git] / source / mircoders / localizer / MirOpenPostingLocalizer.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;
31
32 import java.util.List;
33 import java.awt.image.BufferedImage;
34
35 import mir.session.Request;
36 import mir.session.Session;
37 import mir.session.SessionHandler;
38 import mircoders.entity.EntityComment;
39 import mircoders.entity.EntityContent;
40
41 public interface MirOpenPostingLocalizer {
42
43   /**
44    *
45    */
46   public SessionHandler getOpenSessionHandler(Request aRequest, Session aSession) throws MirLocalizerExc, MirLocalizerFailure;
47
48   /**
49    * This method will be called after a comment has been posted
50    * via the open posting interface.
51    */
52   public void afterCommentPosting(EntityComment aComment) throws MirLocalizerExc, MirLocalizerFailure;
53
54   /**
55    * This method will be called after an article is posted via the open posting interface.
56    */
57   public void afterArticlePosting(EntityContent anArticle) throws MirLocalizerExc, MirLocalizerFailure;
58
59   /**
60    *
61    */
62
63   public List getAntiAbuseFilterTypes() throws MirLocalizerExc, MirLocalizerFailure;
64
65   /**
66    * This method should return <code>true</code> if the article should be visible
67    * to "open posting" users. This method is used to determine whether the request
68    * for a pdf, or an email for the article should be allowed. It is however
69    * <emph>not</emph> used by default by the production subsystem
70    */
71   public boolean allowArticlePublication(EntityContent anArticle);
72
73
74   /**
75    * Generate a captcha with given id.
76    */
77   public Captcha generateCaptcha(String someId);
78
79   public interface Captcha {
80     BufferedImage getChallenge();
81     boolean validateAnswer(String anAnswer);
82   }
83 }