1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     3   * All rights reserved.
     4   *
     5   * Redistribution and use in source and binary forms, with or without
     6   * modification, are permitted provided that the following conditions are met:
     7   *
     8   *   - Redistributions of source code must retain the above copyright
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.decorator;
    33  
    34  import net.sourceforge.pebble.api.decorator.ContentDecoratorContext;
    35  import net.sourceforge.pebble.domain.BlogEntry;
    36  import net.sourceforge.pebble.domain.StaticPage;
    37  import net.sourceforge.pebble.util.StringUtils;
    38  import net.sourceforge.pebble.PluginProperties;
    39  import org.apache.commons.logging.Log;
    40  import org.apache.commons.logging.LogFactory;
    41  
    42  /**
    43   * Automatically creates an excerpt for blog entries if one doesn't already
    44   * exist.
    45   *
    46   * @author Simon Brown
    47   */
         /* 
    P/P   *  Method: void net.sourceforge.pebble.decorator.ExcerptDecorator()
          */
    48  public class ExcerptDecorator extends ContentDecoratorSupport {
    49  
           /* 
    P/P     *  Method: net.sourceforge.pebble.decorator.ExcerptDecorator__static_init
            * 
            *  Postconditions:
            *    init'ed(log)
            */
    50    private static final Log log = LogFactory.getLog(ExcerptDecorator.class);
    51  
    52    /** the name of the maxLength property */
    53    public static final String MAX_LENGTH_KEY = "ExcerptDecorator.maxLength";
    54  
    55    /**
    56     * Decorates the specified blog entry.
    57     *
    58     * @param context   the context in which the decoration is running
    59     * @param blogEntry the blog entry to be decorated
    60     */
    61    public void decorate(ContentDecoratorContext context, BlogEntry blogEntry) {
             /* 
    P/P       *  Method: void decorate(ContentDecoratorContext, BlogEntry)
              * 
              *  Preconditions:
              *    blogEntry != null
              * 
              *  Presumptions:
              *    org.apache.commons.logging.LogFactory:getLog(...)@50 != null
              * 
              *  Test Vectors:
              *    java.lang.String:length(...)@73: {1..232-1}, {0}
              * 
              *  Preconditions:
              *    blogEntry.blog.pluginProperties != null
              *    blogEntry.blog != null
              *    init'ed(blogEntry.excerpt)
              *    (soft) init'ed(blogEntry.body)
              *    (soft) blogEntry.propertyChangeSupport != null
              * 
              *  Postconditions:
              *    init'ed(blogEntry.excerpt)
              * 
              *  Test Vectors:
              *    net.sourceforge.pebble.PluginProperties:hasProperty(...)@64: {0}, {1}
              *    blogEntry.excerpt: Addr_Set{null}, Inverse{null}
              */
    62      PluginProperties props = blogEntry.getBlog().getPluginProperties();
    63      int maxLength = StringUtils.MAX_CONTENT_LENGTH;
    64      if (props.hasProperty(MAX_LENGTH_KEY)) {
    65        try {
    66          maxLength = Integer.parseInt(props.getProperty(MAX_LENGTH_KEY));
    67        } catch (NumberFormatException nfe) {
    68          log.error(nfe.getMessage());
    69          // do nothing, the value has already been defaulted
    70        }
    71      }
    72  
    73      if (blogEntry.getExcerpt() == null || blogEntry.getExcerpt().length() == 0) {
    74        blogEntry.setExcerpt(StringUtils.truncate(blogEntry.getBody(), maxLength));
    75      }
    76    }
    77  
    78    /**
    79     * Decorates the specified static page.
    80     *
    81     * @param context    the context in which the decoration is running
    82     * @param staticPage the static page to be decorated
    83     */
    84    public void decorate(ContentDecoratorContext context, StaticPage staticPage) {
           /* 
    P/P     *  Method: void decorate(ContentDecoratorContext, StaticPage)
            */
    85    }
    86  
    87  }