/**
* Copyright (c) 2003-2005, David A. Czarnecki
* All rights reserved.
*
* Portions Copyright (c) 2003-2005 by Mark Lussier
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the "David A. Czarnecki" and "blojsom" nor the names of
* its contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
* Products derived from this software may not be called "blojsom",
* nor may "blojsom" appear in their name, without prior written permission of
* David A. Czarnecki.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.blojsom.plugin.excerpt;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.blojsom.blog.BlogEntry;
import org.blojsom.blog.BlogUser;
import org.blojsom.blog.BlojsomConfiguration;
import org.blojsom.plugin.BlojsomPlugin;
import org.blojsom.plugin.BlojsomPluginException;
import org.blojsom.util.BlojsomUtils;
import javax.servlet.ServletConfig;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* ExcerptPlugin
*
* @author Mark Lussier
* @version $Id: ExcerptPlugin.java,v 1.2.2.1 2005/07/21 04:30:30 johnan Exp $
* @since blojsom 2.13
*/
public class ExcerptPlugin implements BlojsomPlugin {
private static final String SHOWME_PARAM = "smm";
private static final String EXCERPT_EXPRESSION = "(^|\\s).*
(.*)
.*";
private static final String SHOWME_START = "$2 Read More";
private Log _logger = LogFactory.getLog(ExcerptPlugin.class);
/**
* Default Constructor
*/
public ExcerptPlugin() {
}
/**
* Initialize this plugin. This method only called when the plugin is instantiated.
*
* @param servletConfig Servlet config object for the plugin to retrieve any initialization parameters
* @param blojsomConfiguration {@link org.blojsom.blog.BlojsomConfiguration} information
* @throws org.blojsom.plugin.BlojsomPluginException
* If there is an error initializing the plugin
*/
public void init(ServletConfig servletConfig, BlojsomConfiguration blojsomConfiguration) throws BlojsomPluginException {
}
/**
* Process the blog entries
*
* @param httpServletRequest Request
* @param httpServletResponse Response
* @param user {@link org.blojsom.blog.BlogUser} instance
* @param context Context
* @param entries Blog entries retrieved for the particular request
* @return Modified set of blog entries
* @throws org.blojsom.plugin.BlojsomPluginException
* If there is an error processing the blog entries
*/
public BlogEntry[] process(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, BlogUser user, Map context, BlogEntry[] entries) throws BlojsomPluginException {
String showme = BlojsomUtils.getRequestValue(SHOWME_PARAM, httpServletRequest);
if (showme == null) {
_logger.debug("Processing all entries");
processEntries(entries);
} else {
_logger.debug("Not processing because request param was set");
}
return entries;
}
/**
* Process entries
*
* @param entries Array of {@link BlogEntry} objects
*/
private void processEntries(BlogEntry[] entries) {
Pattern p = Pattern.compile(EXCERPT_EXPRESSION, Pattern.DOTALL);
for (int i = 0; i < entries.length; i++) {
BlogEntry entry = entries[i];
String originalDescription = entry.getDescription();
Matcher m = p.matcher(originalDescription);
if (m.matches()) {
_logger.info("Performing excerpt on " + entry.getTitle());
StringBuffer newDescription = new StringBuffer(m.replaceAll(SHOWME_START));
newDescription.append(entry.getLink());
newDescription.append(SHOWME_FINISH);
entry.setDescription(newDescription.toString());
} else {
_logger.info("Nothing to excerpt on " + entry.getTitle());
}
}
}
/**
* Perform any cleanup for the plugin. Called after {@link #process}.
*
* @throws org.blojsom.plugin.BlojsomPluginException
* If there is an error performing cleanup for this plugin
*/
public void cleanup() throws BlojsomPluginException {
}
/**
* Called when BlojsomServlet is taken out of service
*
* @throws org.blojsom.plugin.BlojsomPluginException
* If there is an error in finalizing this plugin
*/
public void destroy() throws BlojsomPluginException {
}
}