001: /**
002: * Copyright (c) 2003-2007, David A. Czarnecki
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
009: * following disclaimer.
010: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
011: * following disclaimer in the documentation and/or other materials provided with the distribution.
012: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
013: * endorse or promote products derived from this software without specific prior written permission.
014: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
015: * without prior written permission of David A. Czarnecki.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
018: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
019: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
021: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
022: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
025: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
029: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030: */package org.blojsom.plugin.statistics;
031:
032: import org.apache.commons.logging.Log;
033: import org.apache.commons.logging.LogFactory;
034: import org.blojsom.blog.Blog;
035: import org.blojsom.blog.Entry;
036: import org.blojsom.plugin.Plugin;
037: import org.blojsom.plugin.PluginException;
038: import org.blojsom.util.BlojsomUtils;
039:
040: import javax.servlet.http.HttpServletRequest;
041: import javax.servlet.http.HttpServletResponse;
042: import java.util.Date;
043: import java.util.Map;
044:
045: /**
046: * Days since posted plugin
047: *
048: * @author David Czarnecki
049: * @since blojsom 3.0
050: * @version $Id: DaysSincePostedPlugin.java,v 1.3 2007/01/17 02:35:14 czarneckid Exp $
051: */
052: public class DaysSincePostedPlugin implements Plugin {
053:
054: private Log _logger = LogFactory
055: .getLog(DaysSincePostedPlugin.class);
056:
057: public static final String DAYS_SINCE_POSTED_PLUGIN_HELPER = "DAYS_SINCE_POSTED_PLUGIN_HELPER";
058: public static final String BLOJSOM_PLUGIN_DAYS_SINCE_POSTED_METADATA = "blojsom-plugin-days-since-posted";
059:
060: /**
061: * Default constructor.
062: */
063: public DaysSincePostedPlugin() {
064: }
065:
066: /**
067: * Initialize this plugin. This method only called when the plugin is instantiated.
068: *
069: * @throws org.blojsom.plugin.PluginException
070: * If there is an error initializing the plugin
071: */
072: public void init() throws PluginException {
073: }
074:
075: /**
076: * Process the blog entries
077: *
078: * @param httpServletRequest Request
079: * @param httpServletResponse Response
080: * @param blog {@link Blog} instance
081: * @param context Context
082: * @param entries Blog entries retrieved for the particular request
083: * @return Modified set of blog entries
084: * @throws PluginException If there is an error processing the blog entries
085: */
086: public Entry[] process(HttpServletRequest httpServletRequest,
087: HttpServletResponse httpServletResponse, Blog blog,
088: Map context, Entry[] entries) throws PluginException {
089: Date today = new Date();
090:
091: for (int i = 0; i < entries.length; i++) {
092: Entry entry = entries[i];
093: Map metaData = entry.getMetaData();
094: Integer daysSincePosted = new Integer(BlojsomUtils
095: .daysBetweenDates(entry.getDate(), today));
096: metaData.put(BLOJSOM_PLUGIN_DAYS_SINCE_POSTED_METADATA,
097: daysSincePosted);
098: entry.setMetaData(metaData);
099: }
100:
101: context.put(DAYS_SINCE_POSTED_PLUGIN_HELPER,
102: new DaysSincePostedHelper());
103:
104: return entries;
105: }
106:
107: /**
108: * Perform any cleanup for the plugin. Called after {@link #process}.
109: *
110: * @throws org.blojsom.plugin.PluginException
111: * If there is an error performing cleanup for this plugin
112: */
113: public void cleanup() throws PluginException {
114: }
115:
116: /**
117: * Called when BlojsomServlet is taken out of service
118: *
119: * @throws org.blojsom.plugin.PluginException
120: * If there is an error in finalizing this plugin
121: */
122: public void destroy() throws PluginException {
123: }
124:
125: /**
126: * Class to handle days since posted calculation in templates
127: */
128: public class DaysSincePostedHelper {
129:
130: /**
131: * Determine number of days between current date and date passed to the method
132: *
133: * @param date Date
134: * @return Number of days between dates
135: */
136: public Integer daysSincePosted(Date date) {
137: return new Integer(BlojsomUtils.daysBetweenDates(date,
138: new Date()));
139: }
140: }
141: }
|