/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.SendTrackBackAction__static_init
          * 
          *  Postconditions:
          *    init'ed(log)
          */
     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.web.action;
    33  
    34  import net.sourceforge.pebble.Constants;
    35  import net.sourceforge.pebble.domain.BlogEntry;
    36  import net.sourceforge.pebble.domain.Blog;
    37  import net.sourceforge.pebble.domain.BlogService;
    38  import net.sourceforge.pebble.domain.BlogServiceException;
    39  import net.sourceforge.pebble.web.view.NotFoundView;
    40  import net.sourceforge.pebble.web.view.View;
    41  import net.sourceforge.pebble.web.view.impl.TrackBackFormView;
    42  import net.sourceforge.pebble.web.view.impl.TrackBackSentView;
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.SendTrackBackAction()
          */
    43  import org.apache.commons.httpclient.HttpClient;
    44  import org.apache.commons.httpclient.NameValuePair;
    45  import org.apache.commons.httpclient.methods.PostMethod;
    46  import org.apache.commons.logging.Log;
    47  import org.apache.commons.logging.LogFactory;
    48  
    49  import javax.servlet.ServletException;
    50  import javax.servlet.http.HttpServletRequest;
    51  import javax.servlet.http.HttpServletResponse;
    52  
    53  /**
    54   * Adds a comment to an existing blog entry.
    55   *
    56   * @author    Simon Brown
    57   */
    58  public class SendTrackBackAction extends SecureAction {
    59  
    60    /** the log used by this class */
    61    private static Log log = LogFactory.getLog(SendTrackBackAction.class);
    62  
    63    /**
    64     * Peforms the processing associated with this action.
    65     *
    66     * @param request  the HttpServletRequest instance
    67     * @param response the HttpServletResponse instance
    68     * @return the name of the next view
    69     */
    70    public View process(HttpServletRequest request, HttpServletResponse response) throws ServletException {
             /* 
    P/P       *  Method: View process(HttpServletRequest, HttpServletResponse)
              * 
              *  Preconditions:
              *    request != null
              *    this.model != null
              *    this.model.data != null
              * 
              *  Presumptions:
              *    java.util.HashMap:get(...)@63 != null
              *    net.sourceforge.pebble.domain.BlogEntry:getBlog(...)@100 != null
              * 
              *  Postconditions:
              *    return_value in Addr_Set{&new TrackBackSentView(process#15),&new TrackBackFormView(process#4),&new NotFoundView(process#3)}
              *    new NotFoundView(process#3) num objects <= 1
              *    new TrackBackFormView(process#4) num objects <= 1
              *    new TrackBackSentView(process#15) num objects <= 1
              * 
              *  Test Vectors:
              *    java.lang.String:length(...)@94: {1..232-1}, {0}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@73: Addr_Set{null}, Inverse{null}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@74: Addr_Set{null}, Inverse{null}
              */
    71      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
    72  
    73      String entryId = request.getParameter("entry");
    74      String trackBackUrl = request.getParameter("url");
    75      String excerpt = request.getParameter("excerpt");
    76      String trackBackResponseMessage;
    77      Integer trackBackResponseCode;
    78  
    79      BlogService service = new BlogService();
    80      BlogEntry blogEntry = null;
    81      if (entryId != null) {
    82        try {
    83          blogEntry = service.getBlogEntry(blog, entryId);
    84        } catch (BlogServiceException e) {
    85          throw new ServletException(e);
    86        }
    87      }
    88  
    89      if (blogEntry == null) {
    90        // the entry cannot be found - it may have been removed or the
    91        // requesting URL was wrong
    92  
    93        return new NotFoundView();
    94      } else if (trackBackUrl == null || trackBackUrl.trim().length() == 0) {
    95        getModel().put(Constants.BLOG_ENTRY_KEY, blogEntry);
    96        return new TrackBackFormView();
    97      } else {
    98        // extract the information to send in the trackback
    99        String title = blogEntry.getTitle();
   100        String blogName = blogEntry.getBlog().getName();
   101        String url = blogEntry.getPermalink();
   102  
   103        // now send the trackback
   104        try {
   105          HttpClient httpClient = new HttpClient();
   106          PostMethod postMethod = new PostMethod(trackBackUrl);
   107          postMethod.addRequestHeader("Content-Type", "application/x-www-form-urlencoded; charset=" + blog.getCharacterEncoding());
   108          NameValuePair[] data = {
   109            new NameValuePair("title", title),
   110            new NameValuePair("url", url),
   111            new NameValuePair("excerpt", excerpt),
   112            new NameValuePair("blog_name", blogName)
   113          };
   114          postMethod.addParameters(data);
   115  
   116          trackBackResponseCode = new Integer(httpClient.executeMethod(postMethod));
   117          trackBackResponseMessage = postMethod.getResponseBodyAsString();
   118        } catch (Exception e) {
   119          log.error(e.getMessage(), e);
   120          throw new ServletException(e);
   121        }
   122  
   123        getModel().put(Constants.BLOG_ENTRY_KEY, blogEntry);
   124        getModel().put("trackBackUrl", trackBackUrl);
   125        getModel().put("trackBackResponseCode", trackBackResponseCode);
   126        getModel().put("trackBackResponseMessage", trackBackResponseMessage);
   127  
   128        return new TrackBackSentView();
   129      }
   130  
   131    }
   132  
   133    /**
   134     * Gets a list of all roles that are allowed to access this action.
   135     *
   136     * @return  an array of Strings representing role names
   137     * @param request
   138     */
   139    public String[] getRoles(HttpServletRequest request) {
             /* 
    P/P       *  Method: String[] getRoles(HttpServletRequest)
              * 
              *  Presumptions:
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE)
              * 
              *  Postconditions:
              *    return_value == &new String[](getRoles#1)
              *    new String[](getRoles#1) num objects == 1
              *    return_value.length == 1
              *    return_value[0] == net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE
              *    (soft) init'ed(return_value[0])
              */
   140      return new String[]{Constants.BLOG_CONTRIBUTOR_ROLE};
   141    }
   142  
   143  }