source/mircoders/servlet/ServletModuleOpenIndy.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
  31 package mircoders.servlet;
  32
  33 import java.io.ByteArrayOutputStream;
  34 import java.io.File;
  35 import java.io.FileNotFoundException;
  36 import java.io.FileReader;
  37 import java.io.IOException;
  38 import java.io.PrintWriter;
  39 import java.io.StringWriter;
  40 import java.util.ArrayList;
  41 import java.util.Arrays;
  42 import java.util.Collections;
  43 import java.util.Enumeration;
  44 import java.util.GregorianCalendar;
  45 import java.util.HashMap;
  46 import java.util.Iterator;
  47 import java.util.List;
  48 import java.util.ListIterator;
  49 import java.util.Locale;
  50 import java.util.Map;
  51 import java.util.Random;
  52 import java.util.Set;
  53 import java.util.Vector;
  54 import javax.servlet.http.HttpServletRequest;
  55 import javax.servlet.http.HttpServletResponse;
  56 import javax.servlet.http.HttpSession;
  57 import javax.servlet.http.HttpUtils;
  58
  59 import org.apache.commons.fileupload.FileItem;
  60 import org.apache.commons.net.smtp.SMTPClient;
  61 import org.apache.commons.net.smtp.SMTPReply;
  62 import org.apache.lucene.analysis.standard.StandardAnalyzer;
  63 import org.apache.lucene.document.Document;
  64 import org.apache.lucene.queryParser.QueryParser;
  65 import org.apache.lucene.search.Hits;
  66 import org.apache.lucene.search.IndexSearcher;
  67 import org.apache.lucene.search.Query;
  68 import org.apache.lucene.search.Searcher;
  69 import org.apache.struts.util.MessageResources;
  70 import gnu.regexp.RE;
  71 import gnu.regexp.REMatch;
  72
  73 import mir.entity.Entity;
  74 import mir.generator.Generator;
  75 import mir.log.LoggerWrapper;
  76 import mir.misc.StringUtil;
  77 import mir.servlet.ServletModule;
  78 import mir.servlet.ServletModuleExc;
  79 import mir.servlet.ServletModuleFailure;
  80 import mir.servlet.ServletModuleUserExc;
  81 import mir.session.HTTPAdapters;
  82 import mir.session.Request;
  83 import mir.session.Session;
  84 import mir.session.SessionHandler;
  85 import mir.session.SimpleResponse;
  86 import mir.session.UploadedFile;
  87 import mir.storage.StorageObjectFailure;
  88 import mir.util.ExceptionFunctions;
  89 import mir.util.HTTPParsedRequest;
  90 import mir.util.HTTPRequestParser;
  91 import mir.util.StringRoutines;
  92 import mircoders.entity.EntityComment;
  93 import mircoders.entity.EntityContent;
  94 import mircoders.global.CacheKey;
  95 import mircoders.global.MirGlobal;
  96 import mircoders.media.MediaUploadProcessor;
  97 import mircoders.module.ModuleComment;
  98 import mircoders.module.ModuleContent;
  99 import mircoders.module.ModuleImages;
 100 import mircoders.module.ModuleMediaType;
 101 import mircoders.module.ModuleTopics;
 102 import mircoders.pdf.PDFGenerator;
 103 import mircoders.search.AudioSearchTerm;
 104 import mircoders.search.ContentSearchTerm;
 105 import mircoders.search.ImagesSearchTerm;
 106 import mircoders.search.KeywordSearchTerm;
 107 import mircoders.search.TextSearchTerm;
 108 import mircoders.search.TopicSearchTerm;
 109 import mircoders.search.UnIndexedSearchTerm;
 110 import mircoders.search.VideoSearchTerm;
 111 import mircoders.storage.DatabaseComment;
 112 import mircoders.storage.DatabaseContent;
 113 import mircoders.storage.DatabaseContentToMedia;
 114 import mircoders.storage.DatabaseContentToTopics;
 115 import mircoders.storage.DatabaseImages;
 116 import mircoders.storage.DatabaseLanguage;
 117 import mircoders.storage.DatabaseTopics;
 118
 119 /*
 120  *  ServletModuleOpenIndy -
 121  *   is the open-access-servlet, which is responsible for
 122  *    adding comments to articles &
 123  *    open-postings to the newswire
 124  *
 125  * @author mir-coders group
 126  * @version $Id: ServletModuleOpenIndy.java,v 1.86 2003/05/04 12:56:33 john Exp $
 127  *
 128  */
 129
 130 public class ServletModuleOpenIndy extends ServletModule
 131 {
 132
 133   private String        commentFormTemplate, commentFormDoneTemplate, commentFormDupeTemplate;
 134   private String        postingFormTemplate, postingFormDoneTemplate, postingFormDupeTemplate;
 135   private String        searchResultsTemplate;
 136   private String        prepareMailTemplate,sentMailTemplate,emailAnArticleTemplate;
 137   private ModuleContent contentModule;
 138   private ModuleComment commentModule;
 139   private ModuleImages  imageModule;
 140   private ModuleTopics  topicsModule;
 141   private String        directOp ="yes";
 142   // Singelton / Kontruktor
 143   private static ServletModuleOpenIndy instance = new ServletModuleOpenIndy();
 144   public static ServletModule getInstance() { return instance; }
 145
 146   private ServletModuleOpenIndy() {
 147     super();
 148     try {
 149       logger = new LoggerWrapper("ServletModule.OpenIndy");
 150
 151       commentFormTemplate = configuration.getString("ServletModule.OpenIndy.CommentTemplate");
 152       commentFormDoneTemplate = configuration.getString("ServletModule.OpenIndy.CommentDoneTemplate");
 153       commentFormDupeTemplate = configuration.getString("ServletModule.OpenIndy.CommentDupeTemplate");
 154
 155       postingFormTemplate = configuration.getString("ServletModule.OpenIndy.PostingTemplate");
 156       postingFormDoneTemplate = configuration.getString("ServletModule.OpenIndy.PostingDoneTemplate");
 157       postingFormDupeTemplate = configuration.getString("ServletModule.OpenIndy.PostingDupeTemplate");
 158
 159       searchResultsTemplate = configuration.getString("ServletModule.OpenIndy.SearchResultsTemplate");
 160       prepareMailTemplate = configuration.getString("ServletModule.OpenIndy.PrepareMailTemplate");
 161       emailAnArticleTemplate = configuration.getString("ServletModule.OpenIndy.MailableArticleTemplate");
 162       sentMailTemplate = configuration.getString("ServletModule.OpenIndy.SentMailTemplate");
 163       directOp = configuration.getString("DirectOpenposting").toLowerCase();
 164       commentModule = new ModuleComment(DatabaseComment.getInstance());
 165       mainModule = commentModule;
 166       contentModule = new ModuleContent(DatabaseContent.getInstance());
 167       topicsModule = new ModuleTopics(DatabaseTopics.getInstance());
 168       imageModule = new ModuleImages(DatabaseImages.getInstance());
 169       defaultAction="addposting";
 170     }
 171     catch (StorageObjectFailure e) {
 172       logger.error("servletmoduleopenindy could not be initialized: " + e.getMessage());
 173     }
 174   }
 175
 176   /**
 177    * Method to return an "apology" when open postings are disabled
 178    *
 179    * @param aRequest
 180    * @param aResponse
 181    * @throws ServletModuleExc
 182    * @throws ServletModuleUserExc
 183    * @throws ServletModuleFailure
 184    */
 185   public void openPostingDisabled(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
 186     deliver(aRequest, aResponse, (Map) null, null,
 187        configuration.getString("ServletModule.OpenIndy.PostingDisabledTemplate"));
 188   }
 189
 190   /**
 191    *  Method for making a comment
 192    */
 193
 194   public void addcomment(HttpServletRequest req, HttpServletResponse res) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
 195     if (MirGlobal.abuse().getOpenPostingDisabled()) {
 196       openPostingDisabled(req, res);
 197
 198       return;
 199     }
 200
 201     String aid = req.getParameter("aid"); // the article id the comment will belong to
 202
 203     if (aid != null && !aid.equals("")) {
 204       try {
 205         Map mergeData = new HashMap();
 206
 207         // onetimepasswd
 208         if (MirGlobal.abuse().getOpenPostingPassword()) {
 209           String passwd = this.createOneTimePasswd();
 210           HttpSession session = req.getSession(false);
 211           session.setAttribute("passwd", passwd);
 212           mergeData.put("passwd", passwd);
 213         }
 214         else {
 215           mergeData.put("passwd", (String)null);
 216         }
 217         mergeData.put("aid", aid);
 218
 219         Map extraInfo = new HashMap();
 220         extraInfo.put("languagePopUpData", DatabaseLanguage.getInstance().getPopupData());
 221
 222         deliver(req, res, mergeData, extraInfo, commentFormTemplate);
 223       }
 224       catch (Throwable t) {
 225         throw new ServletModuleFailure("ServletModuleOpenIndy.addcomment: " + t.getMessage(), t);
 226       }
 227     }
 228     else
 229       throw new ServletModuleExc("aid not set!");
 230   }
 231
 232   /**
 233    *  Method for inserting a comment into the Database and delivering
 234    *  the commentDone Page
 235    */
 236
 237   public void inscomment(HttpServletRequest req, HttpServletResponse res) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
 238     if (MirGlobal.abuse().getOpenPostingDisabled()) {
 239       openPostingDisabled(req, res);
 240
 241       return;
 242     }
 243
 244     String aid = req.getParameter("to_media"); // the article id the comment will belong to
 245     if (aid != null && !aid.equals("")) {
 246       // ok, collecting data from form
 247       try {
 248         Map withValues = getIntersectingValues(req, DatabaseComment.getInstance());
 249
 250         //no html in comments(for now)
 251         for (Iterator i = withValues.keySet().iterator(); i.hasNext(); ) {
 252           String k = (String) i.next();
 253           String v = (String) withValues.get(k);
 254
 255           withValues.put(k, StringUtil.removeHTMLTags(v));
 256         }
 257         withValues.put("is_published", "1");
 258         withValues.put("to_comment_status", "1");
 259         withValues.put("is_html", "0");
 260
 261         //checking the onetimepasswd
 262         HttpSession session = req.getSession(false);
 263         String sessionPasswd = (String) session.getAttribute("passwd");
 264         if (sessionPasswd != null) {
 265           String passwd = req.getParameter("passwd");
 266           if (passwd == null || passwd.length() == 0) {
 267             throw new ServletModuleUserExc("comment.error.missingpassword", new String[] {});
 268           }
 269           if (!sessionPasswd.equals(passwd)) {
 270             throw new ServletModuleUserExc("comment.error.invalidpassword", new String[] {});
 271           }
 272           session.invalidate();
 273         }
 274
 275         String id = mainModule.add(withValues);
 276
 277         SimpleResponse response = new SimpleResponse();
 278         response.setResponseGenerator(commentFormDoneTemplate);
 279
 280         if (id == null) {
 281           deliver(req, res, (Map)null, null, commentFormDupeTemplate);
 282         }
 283         else {
 284           DatabaseContent.getInstance().setUnproduced("id=" + aid);
 285
 286           try {
 287             EntityComment comment = (EntityComment) DatabaseComment.getInstance().selectById(id);
 288             MirGlobal.localizer().openPostings().afterCommentPosting(comment);
 289             MirGlobal.abuse().checkComment(
 290                 comment, new HTTPAdapters.HTTPRequestAdapter(req), res);
 291           }
 292           catch (Throwable t) {
 293             throw new ServletModuleExc(t.getMessage());
 294           }
 295         }
 296
 297         // redirecting to url
 298         // should implement back to article
 299         deliver(req, res, response.getResponseValues(), null, response.getResponseGenerator());
 300       }
 301       catch (Throwable e) {
 302         throw new ServletModuleFailure(e);
 303       }
 304     }
 305     else
 306       throw new ServletModuleExc("aid not set!");
 307
 308   }
 309
 310   /**
 311    *  Method for delivering the form-Page for open posting
 312    */
 313
 314   public void addposting(HttpServletRequest req, HttpServletResponse res)
 315       throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure
 316   {
 317     try {
 318       if (MirGlobal.abuse().getOpenPostingDisabled()) {
 319         openPostingDisabled(req, res);
 320
 321         return;
 322       }
 323
 324       Map mergeData = new HashMap();
 325
 326       // onetimepasswd
 327       if (MirGlobal.abuse().getOpenPostingPassword()) {
 328         String passwd = generateOnetimePassword();
 329         HttpSession session = req.getSession(false);
 330         session.setAttribute("passwd", passwd);
 331         mergeData.put("passwd", passwd);
 332       }
 333       else {
 334         mergeData.put("passwd", (String)null);
 335       }
 336
 337       String maxMedia = configuration.getString("ServletModule.OpenIndy.MaxMediaUploadItems");
 338       String defaultMedia = configuration.getString("ServletModule.OpenIndy.DefaultMediaUploadItems");
 339       String numOfMedia = req.getParameter("medianum");
 340
 341       if (numOfMedia == null || numOfMedia.equals("")) {
 342         numOfMedia = defaultMedia;
 343       }
 344       else if (Integer.parseInt(numOfMedia) > Integer.parseInt(maxMedia)) {
 345         numOfMedia = maxMedia;
 346       }
 347
 348       int mediaNum = Integer.parseInt(numOfMedia);
 349       List mediaFields = new Vector();
 350       for (int i = 0; i < mediaNum; i++) {
 351         Integer mNum = new Integer(i + 1);
 352         mediaFields.add(mNum.toString());
 353       }
 354       mergeData.put("medianum", numOfMedia);
 355       mergeData.put("mediafields", mediaFields);
 356       mergeData.put("to_topic", null);
 357
 358       Map extraInfo = new HashMap();
 359       extraInfo.put("languagePopUpData", DatabaseLanguage.getInstance().getPopupData());
 360       extraInfo.put("themenPopupData", topicsModule.getTopicsAsSimpleList());
 361
 362       extraInfo.put("topics", topicsModule.getTopicsList());
 363       deliver(req, res, mergeData, extraInfo, postingFormTemplate);
 364     }
 365     catch (Throwable t) {
 366       throw new ServletModuleFailure(t);
 367     }
 368   }
 369
 370   /**
 371    *  Method for inserting an open posting into the Database and delivering
 372    *  the postingDone Page
 373    */
 374
 375   public void insposting(HttpServletRequest aRequest, HttpServletResponse aResponse) throws
 376       ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
 377     if (MirGlobal.abuse().getOpenPostingDisabled()) {
 378       openPostingDisabled(aRequest, aResponse);
 379
 380       return;
 381     }
 382
 383     try {
 384       HTTPParsedRequest parsedRequest = new HTTPParsedRequest(
 385           aRequest,
 386           configuration.getString("Mir.DefaultEncoding"),
 387           configuration.getInt("MaxMediaUploadSize")*1024,
 388           configuration.getString("TempDir"));
 389
 390       Map mergeData = new HashMap();
 391
 392       HttpSession session = aRequest.getSession(false);
 393       String sessionPasswd = (String) session.getAttribute("passwd");
 394       if (sessionPasswd != null) {
 395         String passwd = (String) parsedRequest.getParameter("passwd");
 396
 397         if (passwd == null || passwd.length() == 0) {
 398           throw new ServletModuleUserExc("posting.error.missingpassword", new String[] {});
 399         }
 400         if (!sessionPasswd.equals(passwd)) {
 401           throw new ServletModuleUserExc("posting.error.invalidpassword", new String[] {});
 402         }
 403         session.invalidate();
 404       }
 405
 406       if ((((String) parsedRequest.getParameter("title")).length() == 0) ||
 407           (((String) parsedRequest.getParameter("description")).length() == 0) ||
 408           (((String) parsedRequest.getParameter("content_data")).length() == 0))
 409         throw new ServletModuleUserExc("posting.error.missingfield", new String[] {});
 410
 411       List mediaList = new Vector();
 412       Iterator i = parsedRequest.getFiles().iterator();
 413
 414       while (i.hasNext()) {
 415         UploadedFile file = new mir.session.CommonsUploadedFileAdapter((FileItem) i.next());
 416         Map mediaValues = new HashMap();
 417
 418         String suffix = file.getFieldName().substring(5); // media${m}
 419         logger.debug("media_title" + suffix);
 420         String title = parsedRequest.getParameter("media_title" + suffix);
 421
 422         mediaValues.put("title", StringUtil.removeHTMLTags(title));
 423         mediaValues.put("creator", StringUtil.removeHTMLTags(parsedRequest.getParameter("creator")));
 424         mediaValues.put("to_publisher", "0");
 425         mediaValues.put("is_published", "1");
 426         mediaValues.put("to_media_folder", "7");
 427
 428         mediaList.add(MediaUploadProcessor.processMediaUpload(file, mediaValues));
 429       }
 430
 431       Map withValues = new HashMap();
 432       i = DatabaseContent.getInstance().getFields().iterator();
 433       while (i.hasNext()) {
 434         String field = (String) i.next();
 435         String value = parsedRequest.getParameter(field);
 436         if (value!=null)
 437           withValues.put(field, value);
 438       }
 439
 440
 441       for (i = withValues.keySet().iterator(); i.hasNext(); ) {
 442         String k = (String) i.next();
 443         String v = (String) withValues.get(k);
 444
 445         if (k.equals("content_data")) {
 446           //this doesn't quite work yet, so for now, all html goes
 447           //withValues.put(k,StringUtil.approveHTMLTags(v));
 448           withValues.put(k, StringUtil.deleteForbiddenTags(v));
 449         }
 450         else if (k.equals("description")) {
 451           String tmp = StringUtil.deleteForbiddenTags(v);
 452           withValues.put(k, StringUtil.deleteHTMLTableTags(tmp));
 453         }
 454         else {
 455           withValues.put(k, StringUtil.removeHTMLTags(v));
 456         }
 457       }
 458
 459       withValues.put("date", StringUtil.date2webdbDate(new GregorianCalendar()));
 460       withValues.put("publish_path",
 461                      StringUtil.webdbDate2path( (String) withValues.get("date")));
 462       withValues.put("is_produced", "0");
 463       withValues.put("is_published", "1");
 464       if (directOp.equals("yes"))
 465         withValues.put("to_article_type", "1");
 466
 467       withValues.put("to_publisher", "1");
 468
 469       // inserting  content into database
 470       String cid = contentModule.add(withValues);
 471       logger.debug("id: " + cid);
 472       //insert was not successfull
 473       if (cid == null) {
 474         deliver(aRequest, aResponse, mergeData, null, postingFormDupeTemplate);
 475         return;
 476       }
 477
 478       List topics = parsedRequest.getParameterList("to_topic");
 479       if (topics.size() > 0) {
 480         try {
 481           DatabaseContentToTopics.getInstance().setTopics(cid, topics);
 482         }
 483         catch (Throwable e) {
 484           logger.error("setting content_x_topic failed");
 485           contentModule.deleteById(cid);
 486           throw new ServletModuleFailure(
 487               "smod - openindy :: insposting: setting content_x_topic failed: " +
 488               e.toString(), e);
 489         }
 490       }
 491
 492       i = mediaList.iterator();
 493       while (i.hasNext()) {
 494         Entity mediaEnt = (Entity) i.next();
 495         DatabaseContentToMedia.getInstance().addMedia(cid, mediaEnt.getId());
 496       }
 497
 498       EntityContent article = (EntityContent) contentModule.getById(cid);
 499       try {
 500         MirGlobal.abuse().checkArticle(
 501             article, new HTTPAdapters.HTTPRequestAdapter(aRequest), aResponse);
 502         MirGlobal.localizer().openPostings().afterContentPosting(article);
 503       }
 504       catch (Throwable t) {
 505         logger.error("Error while post-processing article: " + t.getMessage());
 506       }
 507       deliver(aRequest, aResponse, mergeData, null, postingFormDoneTemplate);
 508     }
 509     catch (Throwable e) {
 510       e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
 511       Throwable cause = ExceptionFunctions.traceCauseException(e);
 512
 513       if (cause instanceof ModuleMediaType.UnsupportedMimeTypeExc) {
 514         throw new ServletModuleUserExc("media.unsupportedformat", new String[] {});
 515       }
 516       throw new ServletModuleFailure(e);
 517     }
 518   }
 519
 520   /**
 521    * Due to a serious shortcoming of Tomcat 3.3, an extra sessionid parameter is
 522    *   generated into open session urls. Tomcat 3.3 makes it impossible to
 523    *   distinguish between sessions that are identified using a url and those
 524    *   that are identified using cookies: if both a sessionid cookie and a sessionid
 525    *   url are available, tomcat 3.3 pretends the url wasn't there...
 526    */
 527   private static final String SESSION_REQUEST_KEY="sessionid";
 528
 529   /**
 530    * Dispatch method for open sessions: a flexible extensible and customizable way
 531    *   for open access. Can be used for postings, but also for lots of other stuff.
 532    *
 533    * @param aRequest
 534    * @param aResponse
 535    * @throws ServletModuleExc
 536    * @throws ServletModuleUserExc
 537    * @throws ServletModuleFailure
 538    */
 539
 540   public void opensession(HttpServletRequest aRequest, HttpServletResponse aResponse)
 541       throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
 542
 543     try {
 544       Request request =
 545           new HTTPAdapters.HTTPParsedRequestAdapter(new HTTPParsedRequest(aRequest,
 546               configuration.getString("Mir.DefaultEncoding"),
 547               configuration.getInt("MaxMediaUploadSize")*1024,
 548               configuration.getString("TempDir")));
 549
 550       if (aRequest.isRequestedSessionIdValid() && !aRequest.isRequestedSessionIdFromURL() &&
 551           !aRequest.getRequestedSessionId().equals(aRequest.getParameter(SESSION_REQUEST_KEY)))
 552         aRequest.getSession().invalidate();
 553
 554       Session session = new HTTPAdapters.HTTPSessionAdapter(aRequest.getSession());
 555
 556       SimpleResponse response = new SimpleResponse(
 557           ServletHelper.makeGenerationData(new Locale[] {getLocale(aRequest), getFallbackLocale(aRequest)},
 558              "bundles.open"));
 559
 560       response.setResponseValue("actionURL", aResponse.encodeURL(HttpUtils.getRequestURL(aRequest).toString())+"?"+SESSION_REQUEST_KEY+"="+aRequest.getSession().getId());
 561
 562       SessionHandler handler = MirGlobal.localizer().openPostings().getOpenSessionHandler(request, session);
 563
 564       handler.processRequest(request, session, response);
 565       ServletHelper.generateOpenPostingResponse(aResponse.getWriter(), response.getResponseValues(), response.getResponseGenerator());
 566     }
 567     catch (Throwable t) {
 568       logger.error(t.toString());
 569       t.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
 570
 571       throw new ServletModuleFailure(t);
 572     }
 573   }
 574
 575   /**
 576    * Method for preparing and sending a content as an email message
 577    */
 578
 579   public void mail(HttpServletRequest req, HttpServletResponse res)
 580       throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure
 581   {
 582     String aid = req.getParameter("mail_aid");
 583     if (aid == null){
 584       throw new ServletModuleExc("An article id must be specified in requests to email an article.  Something therefore went badly wrong....");
 585     }
 586
 587     String to = req.getParameter("mail_to");
 588     String from = req.getParameter("mail_from");
 589     String from_name = req.getParameter("mail_from_name");
 590     String comment = req.getParameter("mail_comment");
 591     String mail_language = req.getParameter("mail_language");
 592
 593     Map mergeData = new HashMap();
 594
 595     if (to == null || from == null || from_name == null|| to.equals("") || from.equals("") || from_name.equals("") || mail_language == null || mail_language.equals("")){
 596
 597       for (Enumeration theParams = req.getParameterNames(); theParams.hasMoreElements() ;) {
 598         String pName=(String)theParams.nextElement();
 599         if (pName.startsWith("mail_")){
 600           mergeData.put( pName,req.getParameter(pName) );
 601         }
 602       }
 603
 604       deliver(req, res, mergeData, null, prepareMailTemplate);
 605     }
 606     else {
 607       //run checks on to and from and mail_language to make sure no monkey business occurring
 608       if (mail_language.indexOf('.') != -1 || mail_language.indexOf('/') != -1 ) {
 609         throw new ServletModuleExc("Invalid language");
 610       }
 611       if (to.indexOf('\n') != -1
 612           || to.indexOf('\r') != -1
 613           || to.indexOf(',') != -1) {
 614         throw new ServletModuleUserExc("email.error.invalidtoaddress", new String[] {to});
 615       }
 616       if (from.indexOf('\n') != -1 || from.indexOf('\r') != -1 || from.indexOf(',') != -1 ) {
 617         throw new ServletModuleUserExc("email.error.invalidfromaddress", new String[] {from});
 618       }
 619
 620       CacheKey theCacheKey=new CacheKey("email",aid+mail_language);
 621       String theEmailText;
 622
 623       if (MirGlobal.mruCache().hasObject(theCacheKey)){
 624         logger.info("fetching email text for article "+aid+" from cache");
 625         theEmailText = (String) MirGlobal.mruCache().getObject(theCacheKey);
 626       }
 627       else {
 628         EntityContent contentEnt;
 629         try{
 630           contentEnt = (EntityContent)contentModule.getById(aid);
 631           StringWriter theEMailTextWriter=new StringWriter();
 632           PrintWriter dest = new PrintWriter(theEMailTextWriter);
 633           Map articleData = new HashMap();
 634           articleData.put("article",mir.generator.FreemarkerGenerator.makeAdapter(contentEnt));
 635           articleData.put("languagecode",mail_language);
 636           deliver(dest,req, res, articleData, null, emailAnArticleTemplate,mail_language);
 637           theEmailText=theEMailTextWriter.toString();
 638           MirGlobal.mruCache().storeObject(theCacheKey,theEmailText);
 639         }
 640         catch (Throwable e){
 641           throw new ServletModuleFailure("Couldn't get content for article "+aid + mail_language + ": " + e.getMessage(), e);
 642         }
 643       }
 644
 645       String content = theEmailText;
 646
 647
 648       // add some headers
 649       content = "To: " + to + "\nReply-To: "+ from + "\n" + content;
 650       // put in the comment where it should go
 651       if (comment != null) {
 652         String commentTextToInsert = "\n\nAttached comment from " + from_name + ":\n" + comment;
 653         try {
 654           content=StringRoutines.performRegularExpressionReplacement(content,"!COMMENT!",commentTextToInsert);
 655         }
 656         catch (Throwable e){
 657           throw new ServletModuleFailure("Problem doing regular expression replacement " + e.toString(), e);
 658         }
 659       }
 660       else{
 661         try {
 662           content=StringRoutines.performRegularExpressionReplacement(content,"!COMMENT!","");
 663         }
 664         catch (Throwable e){
 665           throw new ServletModuleFailure("Problem doing regular expression replacement " + e.toString(), e);
 666         }
 667       }
 668
 669       SMTPClient client=new SMTPClient();
 670       try {
 671         int reply;
 672         client.connect(configuration.getString("ServletModule.OpenIndy.SMTPServer"));
 673
 674         reply = client.getReplyCode();
 675
 676         if (!SMTPReply.isPositiveCompletion(reply)) {
 677           client.disconnect();
 678           throw new ServletModuleExc("SMTP server refused connection.");
 679         }
 680
 681         client.sendSimpleMessage(configuration.getString("ServletModule.OpenIndy.EmailIsFrom"), to, content);
 682
 683         client.disconnect();
 684         //mission accomplished
 685         deliver(req, res, mergeData, null, sentMailTemplate);
 686       }
 687       catch(IOException e) {
 688         if(client.isConnected()) {
 689           try {
 690             client.disconnect();
 691           } catch(IOException f) {
 692             // do nothing
 693           }
 694         }
 695         throw new ServletModuleFailure(e);
 696       }
 697     }
 698   }
 699
 700
 701
 702   /**
 703    * Method for querying a lucene index
 704    *
 705    * @param req
 706    * @param res
 707    * @throws ServletModuleExc
 708    * @throws ServletModuleUserExc
 709    * @throws ServletModuleFailure
 710    */
 711
 712   public void search(HttpServletRequest req, HttpServletResponse res) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
 713     try {
 714       final String[] search_variables = {
 715           "search_content", "search_boolean", "search_creator",
 716           "search_topic", "search_hasImages", "search_hasAudio", "search_hasVideo", "search_sort",
 717           "search_submit", "search_back", "search_forward"};
 718       HTTPRequestParser requestParser = new HTTPRequestParser(req);
 719
 720       int increment = 10;
 721
 722       HttpSession session = req.getSession(false);
 723
 724       String queryString = "";
 725
 726       Map mergeData = new HashMap();
 727
 728       KeywordSearchTerm dateTerm = new KeywordSearchTerm("date_formatted", "search_date", "webdb_create_formatted", "webdb_create_formatted", "webdb_create_formatted");
 729       UnIndexedSearchTerm whereTerm = new UnIndexedSearchTerm("", "", "", "where", "where");
 730       TextSearchTerm creatorTerm = new TextSearchTerm("creator", "search_creator", "creator", "creator", "creator");
 731       TextSearchTerm titleTerm = new TextSearchTerm("title", "search_content", "title", "title", "title");
 732       TextSearchTerm descriptionTerm = new TextSearchTerm("description", "search_content", "description", "description", "description");
 733       ContentSearchTerm contentTerm = new ContentSearchTerm("content_data", "search_content", "content", "", "");
 734       TopicSearchTerm topicTerm = new TopicSearchTerm();
 735       ImagesSearchTerm imagesTerm = new ImagesSearchTerm();
 736       AudioSearchTerm audioTerm = new AudioSearchTerm();
 737       VideoSearchTerm videoTerm = new VideoSearchTerm();
 738
 739       //make the query available to subsequent iterations
 740
 741       Iterator j = Arrays.asList(search_variables).iterator();
 742       while (j.hasNext()) {
 743         String variable = (String) j.next();
 744
 745         mergeData.put(variable, requestParser.getParameter(variable));
 746       }
 747
 748       try {
 749         mergeData.put("topics", topicsModule.getTopicsAsSimpleList());
 750       }
 751       catch (Throwable e) {
 752         logger.debug("Can't get topics: " + e.toString());
 753       }
 754
 755       String searchBackValue = req.getParameter("search_back");
 756       String searchForwardValue = req.getParameter("search_forward");
 757
 758       if (searchBackValue != null) {
 759         int totalHits = ( (Integer) session.getAttribute("numberOfHits")).intValue();
 760         int newPosition = ( (Integer) session.getAttribute("positionInResults")).intValue() - increment;
 761         if (newPosition < 0)
 762           newPosition = 0;
 763         if (newPosition >= totalHits)
 764           newPosition = totalHits - 1;
 765         session.setAttribute("positionInResults", new Integer(newPosition));
 766       }
 767       else {
 768         if (searchForwardValue != null) {
 769           int totalHits = ( (Integer) session.getAttribute("numberOfHits")).intValue();
 770           int newPosition = ( (Integer) session.getAttribute("positionInResults")).intValue() + increment;
 771           if (newPosition < 0)
 772             newPosition = 0;
 773           if (newPosition >= totalHits)
 774             newPosition = totalHits - 1;
 775
 776           session.setAttribute("positionInResults", new Integer(newPosition));
 777         }
 778         else {
 779           String indexPath = configuration.getString("IndexPath");
 780
 781           String creatorFragment = creatorTerm.makeTerm(req);
 782           if (creatorFragment != null) {
 783             queryString = queryString + " +" + creatorFragment;
 784           }
 785
 786           // search title, description, and content for something
 787           // the contentTerm uses param "search_boolean" to combine its terms
 788           String contentFragment = contentTerm.makeTerm(req);
 789           if (contentFragment != null) {
 790             logger.debug("contentFragment: " + contentFragment);
 791             queryString = queryString + " +" + contentFragment;
 792           }
 793
 794           String topicFragment = topicTerm.makeTerm(req);
 795           if (topicFragment != null) {
 796             queryString = queryString + " +" + topicFragment;
 797           }
 798
 799           String imagesFragment = imagesTerm.makeTerm(req);
 800           if (imagesFragment != null) {
 801             queryString = queryString + " +" + imagesFragment;
 802           }
 803
 804           String audioFragment = audioTerm.makeTerm(req);
 805           if (audioFragment != null) {
 806             queryString = queryString + " +" + audioFragment;
 807           }
 808
 809           String videoFragment = videoTerm.makeTerm(req);
 810           if (videoFragment != null) {
 811             queryString = queryString + " +" + videoFragment;
 812           }
 813
 814           if (queryString == null || queryString == "") {
 815             queryString = "";
 816           }
 817           else {
 818             try {
 819               Searcher searcher = null;
 820               try {
 821                 searcher = new IndexSearcher(indexPath);
 822               }
 823               catch (IOException e) {
 824                 logger.debug("Can't open indexPath: " + indexPath);
 825                 throw new ServletModuleExc("Problem with Search Index! : " + e.toString());
 826               }
 827
 828               Query query = null;
 829               try {
 830                 query = QueryParser.parse(queryString, "content", new StandardAnalyzer());
 831               }
 832               catch (Exception e) {
 833                 searcher.close();
 834                 logger.debug("Query don't parse: " + queryString);
 835                 throw new ServletModuleExc("Problem with Query String! (was '" + queryString + "')");
 836               }
 837
 838               Hits hits = null;
 839               try {
 840                 hits = searcher.search(query);
 841               }
 842               catch (IOException e) {
 843                 searcher.close();
 844                 logger.debug("Can't get hits: " + e.toString());
 845                 throw new ServletModuleExc("Problem getting hits!");
 846               }
 847
 848               int start = 0;
 849               int end = hits.length();
 850
 851               String sortBy = req.getParameter("search_sort");
 852               if (sortBy == null || sortBy.equals("")) {
 853                 throw new ServletModuleExc("Please let me sort by something!(missing search_sort)");
 854               }
 855
 856               // here is where the documents will go for storage across sessions
 857               ArrayList theDocumentsSorted = new ArrayList();
 858
 859               if (sortBy.equals("score")) {
 860                 for (int i = start; i < end; i++) {
 861                   theDocumentsSorted.add(hits.doc(i));
 862                 }
 863               }
 864               else {
 865                 // then we'll sort by date!
 866                 Map dateToPosition = new HashMap(end, 1.0F); //we know how big it will be
 867                 for (int i = start; i < end; i++) {
 868                   String creationDate = (hits.doc(i)).get("creationDate");
 869                   // do a little dance in case two contents created at the same second!
 870                   if (dateToPosition.containsKey(creationDate)) {
 871                     ( (ArrayList) (dateToPosition.get(creationDate))).add(new Integer(i));
 872                   }
 873                   else {
 874                     ArrayList thePositions = new ArrayList();
 875                     thePositions.add(new Integer(i));
 876                     dateToPosition.put(creationDate, thePositions);
 877                   }
 878                 }
 879                 Set keys = dateToPosition.keySet();
 880                 ArrayList keyList = new ArrayList(keys);
 881                 Collections.sort(keyList);
 882                 if (sortBy.equals("date_desc")) {
 883                   Collections.reverse(keyList);
 884                 }
 885                 else {
 886                   if (!sortBy.equals("date_asc")) {
 887                     throw new ServletModuleExc("don't know how to sort by: " + sortBy);
 888                   }
 889                 }
 890                 ListIterator keyTraverser = keyList.listIterator();
 891                 while (keyTraverser.hasNext()) {
 892                   ArrayList positions = (ArrayList) dateToPosition.get( (keyTraverser.next()));
 893                   ListIterator positionsTraverser = positions.listIterator();
 894                   while (positionsTraverser.hasNext()) {
 895                     theDocumentsSorted.add(hits.doc( ( (Integer) (positionsTraverser.next())).intValue()));
 896                   }
 897                 }
 898               }
 899
 900               try {
 901                 searcher.close();
 902               }
 903               catch (IOException e) {
 904                 logger.debug("Can't close searcher: " + e.toString());
 905                 throw new ServletModuleFailure("Problem closing searcher(normal):" + e.getMessage(), e);
 906               }
 907
 908               session.removeAttribute("numberOfHits");
 909               session.removeAttribute("theDocumentsSorted");
 910               session.removeAttribute("positionInResults");
 911
 912               session.setAttribute("numberOfHits", new Integer(end));
 913               session.setAttribute("theDocumentsSorted", theDocumentsSorted);
 914               session.setAttribute("positionInResults", new Integer(0));
 915
 916             }
 917             catch (IOException e) {
 918               logger.debug("Can't close searcher: " + e.toString());
 919               throw new ServletModuleFailure("Problem closing searcher: " + e.getMessage(), e);
 920             }
 921           }
 922         }
 923       }
 924
 925       try {
 926         ArrayList theDocs = (ArrayList) session.getAttribute("theDocumentsSorted");
 927         if (theDocs != null) {
 928
 929           mergeData.put("numberOfHits", ( (Integer) session.getAttribute("numberOfHits")).toString());
 930           List theHits = new Vector();
 931           int pIR = ( (Integer) session.getAttribute("positionInResults")).intValue();
 932           int terminus;
 933           int numHits = ( (Integer) session.getAttribute("numberOfHits")).intValue();
 934
 935           if (! (pIR + increment >= numHits)) {
 936             mergeData.put("hasNext", "y");
 937           }
 938           else {
 939             mergeData.put("hasNext", null);
 940           }
 941           if (pIR > 0) {
 942             mergeData.put("hasPrevious", "y");
 943           }
 944           else {
 945             mergeData.put("hasPrevious", null);
 946           }
 947
 948           if ( (pIR + increment) > numHits) {
 949             terminus = numHits;
 950           }
 951           else {
 952             terminus = pIR + increment;
 953           }
 954           for (int i = pIR; i < terminus; i++) {
 955             Map h = new HashMap();
 956             Document theHit = (Document) theDocs.get(i);
 957             whereTerm.returnMeta(h, theHit);
 958             creatorTerm.returnMeta(h, theHit);
 959             titleTerm.returnMeta(h, theHit);
 960             descriptionTerm.returnMeta(h, theHit);
 961             dateTerm.returnMeta(h, theHit);
 962             imagesTerm.returnMeta(h, theHit);
 963             audioTerm.returnMeta(h, theHit);
 964             videoTerm.returnMeta(h, theHit);
 965             theHits.add(h);
 966           }
 967           mergeData.put("hits", theHits);
 968         }
 969       }
 970       catch (Throwable e) {
 971         logger.error("Can't iterate over hits: " + e.toString());
 972
 973         throw new ServletModuleFailure("Problem getting hits: " + e.getMessage(), e);
 974       }
 975
 976       mergeData.put("queryString", queryString);
 977
 978       deliver(req, res, mergeData, null, searchResultsTemplate);
 979     }
 980     catch (NullPointerException n) {
 981       throw new ServletModuleFailure("Null Pointer: " + n.toString(), n);
 982     }
 983   }
 984
 985   /*
 986    * Method for dynamically generating a pdf using iText
 987    */
 988
 989   public void getpdf(HttpServletRequest req, HttpServletResponse res)
 990     throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
 991     long starttime=System.currentTimeMillis();
 992     String ID_REQUEST_PARAM = "id";
 993     int maxArticlesInNewsleter = 15; // it is nice not to be dos'ed
 994     try {
 995       String idParam = req.getParameter(ID_REQUEST_PARAM);
 996       if (idParam != null) {
 997
 998
 999         RE re = new RE("[0-9]+");
1000
1001
1002         REMatch[] idMatches=re.getAllMatches(idParam);
1003
1004         String cacheSelector="";
1005
1006         for (int i = 0; i < idMatches.length; i++){
1007           cacheSelector=   cacheSelector + "," + idMatches[i].toString();
1008         }
1009
1010         String cacheType="pdf";
1011
1012         CacheKey theCacheKey = new CacheKey(cacheType,cacheSelector);
1013
1014         byte[] thePDF;
1015
1016         if (MirGlobal.mruCache().hasObject(theCacheKey)){
1017           logger.info("fetching pdf from cache");
1018           thePDF = (byte[]) MirGlobal.mruCache().getObject(theCacheKey);
1019         }
1020         else {
1021           logger.info("generating pdf and caching it");
1022           ByteArrayOutputStream out = new ByteArrayOutputStream();
1023           PDFGenerator pdfMaker = new PDFGenerator(out);
1024
1025           if (idMatches.length > 1){
1026             pdfMaker.addLine();
1027             for (int i = 0; i < idMatches.length  && i < maxArticlesInNewsleter; i++){
1028               REMatch aMatch = idMatches[i];
1029               String id=aMatch.toString();
1030               EntityContent contentEnt = (EntityContent)contentModule.getById(id);
1031               pdfMaker.addIndexItem(contentEnt);
1032             }
1033           }
1034
1035           for (int i = 0; i < idMatches.length; i++){
1036             REMatch aMatch = idMatches[i];
1037             String id=aMatch.toString();
1038             EntityContent contentEnt = (EntityContent)contentModule.getById(id);
1039
1040             pdfMaker.add(contentEnt);
1041           }
1042
1043           pdfMaker.stop();
1044           thePDF  = out.toByteArray();
1045
1046           //and save all our hard work!
1047           MirGlobal.mruCache().storeObject(theCacheKey,thePDF);
1048         }
1049
1050         res.setContentType("application/pdf");
1051         res.setContentLength(thePDF.length);
1052         res.getOutputStream().write(thePDF);
1053         res.getOutputStream().flush();
1054         String elapsedtime=(new Long(System.currentTimeMillis()-starttime)).toString();
1055         logger.info("pdf retireval took "+elapsedtime + " milliseconds"  );
1056
1057       }
1058       else {
1059         throw new ServletModuleExc("Missing id.");
1060       }
1061     }
1062     catch (Throwable t) {
1063       logger.error(t.toString());
1064       throw new ServletModuleFailure(t);
1065     }
1066
1067   }
1068
1069
1070   public String generateOnetimePassword() {
1071     Random r = new Random();
1072     int random = r.nextInt();
1073
1074     long l = System.currentTimeMillis();
1075
1076     l = (l * l * l * l) / random;
1077     if (l < 0)
1078       l = l * -1;
1079
1080     String returnString = "" + l;
1081
1082     return returnString.substring(5);
1083   }
1084
1085   public void deliver(HttpServletRequest aRequest, HttpServletResponse aResponse, Map aData, Map anExtra, String aGenerator) throws ServletModuleFailure {
1086     try {
1087       deliver(aResponse.getWriter(), aRequest, aResponse, aData, anExtra, aGenerator);
1088     }
1089     catch (Throwable t) {
1090       throw new ServletModuleFailure(t);
1091     }
1092   }
1093
1094   public void deliver(PrintWriter anOutputWriter, HttpServletRequest aRequest, HttpServletResponse aResponse, Map aData, Map anExtra, String aGenerator)
1095       throws ServletModuleFailure {
1096     try {
1097       Map responseData = ServletHelper.makeGenerationData(new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)}, "bundles.open");
1098       responseData.put("data", aData);
1099       responseData.put("extra", anExtra);
1100
1101
1102       Generator generator = MirGlobal.localizer().generators().makeOpenPostingGeneratorLibrary().makeGenerator(aGenerator);
1103       generator.generate(anOutputWriter, responseData, logger);
1104
1105       anOutputWriter.close();
1106     }
1107     catch (Throwable e) {
1108       logger.error("Error while generating " + aGenerator + ": " + e.getMessage());
1109
1110       throw new ServletModuleFailure(e);
1111     }
1112   }
1113
1114   public void deliver(PrintWriter anOutputWriter, HttpServletRequest aRequest, HttpServletResponse aResponse, Map aData, Map anExtra, String aGenerator,String aLocaleString)
1115       throws ServletModuleFailure {
1116     try {
1117       Map responseData = ServletHelper.makeGenerationData(new Locale[] { new Locale(aLocaleString,""), getFallbackLocale(aRequest)}, "bundles.open");
1118       responseData.put("data", aData);
1119       responseData.put("extra", anExtra);
1120
1121
1122       Generator generator = MirGlobal.localizer().generators().makeOpenPostingGeneratorLibrary().makeGenerator(aGenerator);
1123       generator.generate(anOutputWriter, responseData, logger);
1124
1125       anOutputWriter.close();
1126     }
1127     catch (Throwable e) {
1128       logger.error("Error while generating " + aGenerator + ": " + e.getMessage());
1129
1130       throw new ServletModuleFailure(e);
1131     }
1132   }
1133
1134
1135   public void handleError(HttpServletRequest aRequest, HttpServletResponse aResponse,PrintWriter out, Throwable anException) {
1136     try {
1137       logger.error("error: " + anException);
1138       Map data = new HashMap();
1139
1140       data.put("errorstring", anException.getMessage());
1141       data.put("date", StringUtil.date2readableDateTime(new GregorianCalendar()));
1142
1143       deliver(out, aRequest, aResponse, data, null, configuration.getString("ServletModule.OpenIndy.ErrorTemplate"));
1144     }
1145     catch (Throwable e) {
1146       throw new ServletModuleFailure(e);
1147     }
1148   }
1149
1150   public void handleUserError(HttpServletRequest aRequest, HttpServletResponse aResponse,
1151                                PrintWriter out, ServletModuleUserExc anException) {
1152     try {
1153       logger.warn("user error: " + anException.getMessage());
1154       Map data = new HashMap();
1155
1156       MessageResources messages = MessageResources.getMessageResources("bundles.open");
1157       data.put("errorstring", messages.getMessage(getLocale(aRequest), anException.getMessage(), anException.getParameters()));
1158       data.put("date", StringUtil.date2readableDateTime(new GregorianCalendar()));
1159
1160       deliver(out, aRequest, aResponse, data, null, configuration.getString("ServletModule.OpenIndy.UserErrorTemplate"));
1161     }
1162     catch (Throwable e) {
1163       throw new ServletModuleFailure(e);
1164     }
1165   }
1166
1167   private String createOneTimePasswd() {
1168     return "";
1169   }
1170 }