src/org/sonews/storage/DrupalMessage.java
author František Kučera <franta-hg@frantovo.cz>
Mon Oct 17 00:54:52 2011 +0200 (2011-10-17)
changeset 84 7a3514a9e4fe
parent 82 21f413541357
child 87 d4435ac082dc
permissions -rw-r--r--
Drupal: funkce pro obalování textu <html><body> značkami.
     1 /*
     2  *   SONEWS News Server
     3  *   see AUTHORS for the list of contributors
     4  *
     5  *   This program is free software: you can redistribute it and/or modify
     6  *   it under the terms of the GNU General Public License as published by
     7  *   the Free Software Foundation, either version 3 of the License, or
     8  *   (at your option) any later version.
     9  *
    10  *   This program is distributed in the hope that it will be useful,
    11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  *   GNU General Public License for more details.
    14  *
    15  *   You should have received a copy of the GNU General Public License
    16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  */
    18 package org.sonews.storage;
    19 
    20 import java.io.BufferedReader;
    21 import java.io.ByteArrayOutputStream;
    22 import java.io.IOException;
    23 import java.io.InputStream;
    24 import java.io.InputStreamReader;
    25 import java.io.PrintStream;
    26 import java.io.StringReader;
    27 import java.io.StringWriter;
    28 import java.io.UnsupportedEncodingException;
    29 import java.sql.ResultSet;
    30 import java.sql.SQLException;
    31 import java.util.ArrayList;
    32 import java.util.Date;
    33 import java.util.Enumeration;
    34 import java.util.logging.Level;
    35 import java.util.logging.Logger;
    36 import javax.mail.Header;
    37 import javax.mail.MessagingException;
    38 import javax.mail.Multipart;
    39 import javax.mail.Session;
    40 import javax.mail.internet.InternetAddress;
    41 import javax.mail.internet.MimeBodyPart;
    42 import javax.mail.internet.MimeMessage;
    43 import javax.mail.internet.MimeMultipart;
    44 import javax.xml.transform.Transformer;
    45 import javax.xml.transform.TransformerFactory;
    46 import javax.xml.transform.stream.StreamResult;
    47 import javax.xml.transform.stream.StreamSource;
    48 import org.sonews.util.io.Resource;
    49 
    50 /**
    51  * This is MimeMessage which enables custom Message-ID header
    52  * (this header will not be overwritten by the default one like in MimeMessage).
    53  * 
    54  * Also add header and body separate serialization.
    55  * 
    56  * And can be deserialized from SQL ResultSet
    57  * 
    58  * @author František Kučera (frantovo.cz)
    59  */
    60 public class DrupalMessage extends MimeMessage {
    61 
    62 	private static final Logger log = Logger.getLogger(DrupalMessage.class.getName());
    63 	private static final String MESSAGE_ID_HEADER = "Message-ID";
    64 	private static final String CRLF = "\r\n";
    65 	public static final String CHARSET = "UTF-8";
    66 	private static final String XHTML_CONTENT_TYPE = "text/html; charset=" + CHARSET;
    67 	private String messageID;
    68 
    69 	/**
    70 	 * Constructs MIME message from SQL result.
    71 	 * @param rs ResultSet containing message data. No {@link ResultSet#next()} will be called, just values from current row will be read.
    72 	 * @param constructBody true if whole message should be constructed | false if we need only message headers (body will be dummy).
    73 	 */
    74 	public DrupalMessage(ResultSet rs, String myDomain, boolean constructBody) throws SQLException, UnsupportedEncodingException, MessagingException {
    75 		super(Session.getDefaultInstance(System.getProperties()));
    76 
    77 		addHeader("Message-id", constructMessageId(rs.getInt("id"), rs.getInt("group_id"), rs.getString("group_name"), myDomain));
    78 		addHeader("Newsgroups", rs.getString("group_name"));
    79 		setFrom(new InternetAddress(rs.getString("sender_email"), rs.getString("sender_name")));
    80 		setSubject(rs.getString("subject"));
    81 		setSentDate(new Date(rs.getLong("created")));
    82 
    83 		int parentID = rs.getInt("parent_id");
    84 		if (parentID > 0) {
    85 			String parentMessageID = constructMessageId(parentID, rs.getInt("group_id"), rs.getString("group_name"), myDomain);
    86 			addHeader("In-Reply-To", parentMessageID);
    87 			addHeader("References", parentMessageID);
    88 		}
    89 
    90 		if (constructBody) {
    91 			Multipart multipart = new MimeMultipart("alternative");
    92 			setContent(multipart);
    93 
    94 			/** XHTML part */
    95 			MimeBodyPart htmlPart = new MimeBodyPart();
    96 			multipart.addBodyPart(htmlPart);
    97 			String xhtmlText = readXhtmlText(rs);
    98 			htmlPart.setContent(xhtmlText, XHTML_CONTENT_TYPE);
    99 
   100 			/** Plain text part */
   101 			MimeBodyPart textPart = new MimeBodyPart();
   102 			multipart.addBodyPart(textPart);
   103 			textPart.setText(readPlainText(rs, xhtmlText));
   104 		} else {
   105 			/** empty body, just headers */
   106 			setText("");
   107 		}
   108 	}
   109 
   110 	private String readPlainText(ResultSet rs, String xhtmlText) {
   111 		/**
   112 		 * TODO: převést na prostý text
   113 		 */
   114 		return "TODO: obyčejný text\n\n\n" + xhtmlText;
   115 	}
   116 
   117 	private String readXhtmlText(ResultSet rs) {
   118 		/**
   119 		 * TODO: 
   120 		 *		- znovupoužívat XSL transformér
   121 		 *		- používat cache, ukládat si vygenerované články
   122 		 */
   123 		try {
   124 			String inputText = makeSimpleXHTML(rs.getString("text"));
   125 
   126 			TransformerFactory tf = TransformerFactory.newInstance();
   127 			Transformer paragraphTransformer = tf.newTransformer(new StreamSource(Resource.getAsStream("helpers/mimeXhtmlPart-make-paragraphs.xsl")));
   128 
   129 			String paragraphedText;
   130 			boolean tidyWasUsed = false;
   131 			try {
   132 				StringReader input = new StringReader(inputText);
   133 				StringWriter output = new StringWriter(2 * inputText.length());
   134 				paragraphTransformer.transform(new StreamSource(input), new StreamResult(output));
   135 				paragraphedText = output.toString();
   136 			} catch (Exception e) {
   137 				log.log(Level.FINER, "HTML input was shitty – Tidy had to be called.", e);
   138 				StringReader input = new StringReader(tidyXhtml(inputText));
   139 				StringWriter output = new StringWriter(2 * inputText.length());
   140 				paragraphTransformer.transform(new StreamSource(input), new StreamResult(output));
   141 				paragraphedText = output.toString();
   142 				tidyWasUsed = true;
   143 			}
   144 
   145 			Transformer xhtmlTransformer = tf.newTransformer(new StreamSource(Resource.getAsStream("helpers/mimeXhtmlPart.xsl")));
   146 			xhtmlTransformer.setParameter("isRoot", (rs.getInt("parent_id") == 0));
   147 			xhtmlTransformer.setParameter("title", rs.getString("subject"));
   148 			xhtmlTransformer.setParameter("urlBase", rs.getString("urlBase"));
   149 			xhtmlTransformer.setParameter("wwwRead", rs.getString("wwwRead"));
   150 			xhtmlTransformer.setParameter("wwwPost", rs.getString("wwwPost"));
   151 			xhtmlTransformer.setParameter("headComment", String.format("Drupal-NNTP bridge. Transformed: %1$tc. Tidy had to be used: %2$b", new Date(), tidyWasUsed));
   152 			StringReader input = new StringReader(paragraphedText);
   153 			StringWriter output = new StringWriter(2 * paragraphedText.length());
   154 			xhtmlTransformer.transform(new StreamSource(input), new StreamResult(output));
   155 
   156 			return output.toString();
   157 		} catch (Exception e) {
   158 			/**
   159 			 * TODO: lepší ošetření chyby
   160 			 */
   161 			log.log(Level.WARNING, "Error while transforming article to XHTML", e);
   162 			return makeSimpleXHTML("<p>Při transformaci příspěvku bohužel došlo k chybě.</p>");
   163 		}
   164 	}
   165 
   166 	private static String makeSimpleXHTML(String body) {
   167 		return "<html xmlns=\"http://www.w3.org/1999/xhtml\"><body>" + body + "</body></html>";
   168 	}
   169 
   170 	/**
   171 	 * TODO: refaktorovat, přesunout
   172 	 */
   173 	private static String tidyXhtml(String inputText) throws IOException {
   174 		// https://sourceforge.net/tracker/index.php?func=detail&aid=3424437&group_id=27659&atid=390966
   175 		inputText = inputText.replaceAll("\\n", "◆\n");
   176 
   177 		Runtime r = Runtime.getRuntime();
   178 		Process p = r.exec(new String[]{"tidy", // http://tidy.sourceforge.net
   179 					"-asxml", // well formed XHTML
   180 					"-numeric", // číselné entity
   181 					"-utf8", // kódování
   182 					"--show-warnings", "false", // žádná varování nás nezajímají
   183 					"--show-errors", "0", // ani chyby
   184 					"--doctype", "omit", // doctype nepotřebujeme (doplníme si případně vlastní v XSLT)
   185 					"--logical-emphasis", "true", // em a strong místo i a b
   186 					"--literal-attributes", "true", // zachovat mezery a konce řádků v atributech
   187 					"--force-output", "true" // neznámé značky zahodíme, vložíme jen jejich obsah
   188 				});
   189 
   190 		PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
   191 		vstupProcesu.print(inputText);
   192 		vstupProcesu.close();
   193 
   194 		String outputText = streamToString(p.getInputStream());
   195 
   196 		outputText = outputText.replaceAll("◆\\n", "\n");
   197 		outputText = outputText.replaceAll("◆", "\n");
   198 
   199 		return outputText;
   200 	}
   201 
   202 	/**
   203 	 * TODO: refaktorovat, přesunout
   204 	 */
   205 	private static String streamToString(InputStream proud) throws IOException {
   206 		StringBuilder výsledek = new StringBuilder();
   207 		BufferedReader buf = new BufferedReader(new InputStreamReader(proud));
   208 		while (true) {
   209 			String radek = buf.readLine();
   210 			if (radek == null) {
   211 				break;
   212 			} else {
   213 				výsledek.append(radek);
   214 				výsledek.append("\n");
   215 			}
   216 		}
   217 		return výsledek.toString();
   218 	}
   219 
   220 	private static String constructMessageId(int articleID, int groupID, String groupName, String domainName) {
   221 		StringBuilder sb = new StringBuilder();
   222 		sb.append("<");
   223 		sb.append(articleID);
   224 		sb.append("-");
   225 		sb.append(groupID);
   226 		sb.append("-");
   227 		sb.append(groupName);
   228 		sb.append("@");
   229 		sb.append(domainName);
   230 		sb.append(">");
   231 		return sb.toString();
   232 	}
   233 
   234 	@Override
   235 	public void setHeader(String name, String value) throws MessagingException {
   236 		super.setHeader(name, value);
   237 
   238 		if (MESSAGE_ID_HEADER.equalsIgnoreCase(name)) {
   239 			messageID = value;
   240 		}
   241 	}
   242 
   243 	@Override
   244 	public final void addHeader(String name, String value) throws MessagingException {
   245 		super.addHeader(name, value);
   246 
   247 		if (MESSAGE_ID_HEADER.equalsIgnoreCase(name)) {
   248 			messageID = value;
   249 		}
   250 	}
   251 
   252 	@Override
   253 	public void removeHeader(String name) throws MessagingException {
   254 		super.removeHeader(name);
   255 
   256 		if (MESSAGE_ID_HEADER.equalsIgnoreCase(name)) {
   257 			messageID = null;
   258 		}
   259 	}
   260 
   261 	public void setMessageID(String messageID) {
   262 		this.messageID = messageID;
   263 	}
   264 
   265 	@Override
   266 	protected void updateMessageID() throws MessagingException {
   267 		if (messageID == null) {
   268 			super.updateMessageID();
   269 		} else {
   270 			setHeader(MESSAGE_ID_HEADER, messageID);
   271 		}
   272 	}
   273 
   274 	/**
   275 	 * Call {@link #saveChanges()} before this method, if you want all headers including such ones like:
   276 	 * 
   277 	 * <pre>MIME-Version: 1.0
   278 	 *Content-Type: multipart/alternative;</pre>
   279 	 * 
   280 	 * @return serialized headers
   281 	 * @throws MessagingException if getAllHeaders() fails
   282 	 */
   283 	public String getHeaders() throws MessagingException {
   284 		StringBuilder sb = new StringBuilder();
   285 		for (Enumeration eh = getAllHeaderLines(); eh.hasMoreElements();) {
   286 			sb.append(eh.nextElement());
   287 			sb.append(CRLF);
   288 		}
   289 		return sb.toString();
   290 	}
   291 
   292 	public byte[] getBody() throws IOException, MessagingException {
   293 		saveChanges();
   294 
   295 		ArrayList<String> skipHeaders = new ArrayList<String>();
   296 		for (Enumeration eh = getAllHeaders(); eh.hasMoreElements();) {
   297 			Header h = (Header) eh.nextElement();
   298 			skipHeaders.add(h.getName());
   299 		}
   300 
   301 		ByteArrayOutputStream baos = new ByteArrayOutputStream(1024);
   302 		writeTo(baos, skipHeaders.toArray(new String[skipHeaders.size()]));
   303 		return baos.toByteArray();
   304 	}
   305 }