/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.ExportBlogAction__static_init
          */
     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.comparator.BlogEntryComparator;
    36  import net.sourceforge.pebble.domain.Blog;
    37  import net.sourceforge.pebble.web.view.ForwardView;
    38  import net.sourceforge.pebble.web.view.View;
    39  import net.sourceforge.pebble.web.view.impl.AtomView;
    40  import net.sourceforge.pebble.web.view.impl.RdfView;
    41  import net.sourceforge.pebble.web.view.impl.RssView;
    42  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.ExportBlogAction()
          */
    43  import javax.servlet.ServletException;
    44  import javax.servlet.http.HttpServletRequest;
    45  import javax.servlet.http.HttpServletResponse;
    46  import java.util.Collections;
    47  import java.util.List;
    48  import java.util.Locale;
    49  
    50  /**
    51   * Exports an entire blog as RSS/RDF/Atom.
    52   *
    53   * @author    Simon Brown
    54   */
    55  public class ExportBlogAction extends SecureAction {
    56  
    57    /**
    58     * Peforms the processing associated with this action.
    59     *
    60     * @param request  the HttpServletRequest instance
    61     * @param response the HttpServletResponse instance
    62     * @return the name of the next view
    63     */
    64    public View process(HttpServletRequest request, HttpServletResponse response) throws ServletException {
             /* 
    P/P       *  Method: View process(HttpServletRequest, HttpServletResponse)
              * 
              *  Preconditions:
              *    request != null
              *    (soft) response != null
              *    (soft) this.model != null
              *    (soft) this.model.data != null
              * 
              *  Presumptions:
              *    java.util.HashMap:get(...)@63 != null
              *    init'ed(java.util.Locale.ENGLISH)
              * 
              *  Postconditions:
              *    return_value in Addr_Set{&new ForwardView(process#1),&new AtomView(process#4),&new RdfView(process#5),&new RssView(process#6)}
              *    new AtomView(process#4) num objects <= 1
              *    new ForwardView(process#1) num objects <= 1
              *    new ForwardView(process#1).uri == &".zipDirectory.secureaction?type=blogData"
              *    new RdfView(process#5) num objects <= 1
              *    new RssView(process#6) num objects <= 1
              * 
              *  Test Vectors:
              *    java.lang.String:equalsIgnoreCase(...)@67: {0}, {1}
              *    java.lang.String:equalsIgnoreCase(...)@85: {0}, {1}
              *    java.lang.String:equalsIgnoreCase(...)@87: {0}, {1}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@65: Addr_Set{null}, Inverse{null}
              */
    65      String flavor = request.getParameter("flavor");
    66  
    67      if (flavor != null && flavor.equalsIgnoreCase("zip")) {
    68        return new ForwardView("/zipDirectory.secureaction?type=blogData");
    69      }
    70  
    71      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
    72  
    73      response.setContentType("application/xml; charset=" + blog.getCharacterEncoding());
    74  
    75      List blogEntries = blog.getBlogEntries();
    76      Collections.sort(blogEntries, new BlogEntryComparator());
    77      getModel().put(Constants.BLOG_ENTRIES, blogEntries);
    78  
    79      // set the locale of this feed request to be English
    80      javax.servlet.jsp.jstl.core.Config.set(
    81          request,
    82          javax.servlet.jsp.jstl.core.Config.FMT_LOCALE,
    83          Locale.ENGLISH);
    84  
    85      if (flavor != null && flavor.equalsIgnoreCase("atom")) {
    86        return new AtomView();
    87      } else if (flavor != null && flavor.equalsIgnoreCase("rdf")) {
    88        return new RdfView();
    89      } else {
    90        return new RssView();
    91      }
    92    }
    93  
    94    /**
    95     * Gets a list of all roles that are allowed to access this action.
    96     *
    97     * @return  an array of Strings representing role names
    98     * @param request
    99     */
   100    public String[] getRoles(HttpServletRequest request) {
             /* 
    P/P       *  Method: String[] getRoles(HttpServletRequest)
              * 
              *  Presumptions:
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_ADMIN_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_OWNER_ROLE)
              * 
              *  Postconditions:
              *    return_value == &new String[](getRoles#1)
              *    new String[](getRoles#1) num objects == 1
              *    return_value.length == 2
              *    return_value[0] == net.sourceforge.pebble.Constants.BLOG_ADMIN_ROLE
              *    (soft) init'ed(return_value[0])
              *    return_value[1] == net.sourceforge.pebble.Constants.BLOG_OWNER_ROLE
              *    (soft) init'ed(return_value[1])
              */
   101      return new String[]{Constants.BLOG_ADMIN_ROLE, Constants.BLOG_OWNER_ROLE};
   102    }
   103  
   104  }