/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.ManageStaticPageAction__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.Blog;
    36  import net.sourceforge.pebble.domain.StaticPage;
    37  import net.sourceforge.pebble.service.StaticPageService;
    38  import net.sourceforge.pebble.service.StaticPageServiceException;
    39  import net.sourceforge.pebble.web.security.RequireSecurityToken;
    40  import net.sourceforge.pebble.web.view.ForwardView;
    41  import net.sourceforge.pebble.web.view.NotFoundView;
    42  import net.sourceforge.pebble.web.view.RedirectView;
    43  import net.sourceforge.pebble.web.view.View;
    44  import net.sourceforge.pebble.web.view.impl.StaticPageLockedView;
    45  import org.apache.commons.logging.Log;
    46  import org.apache.commons.logging.LogFactory;
    47  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.ManageStaticPageAction()
          */
    48  import javax.servlet.ServletException;
    49  import javax.servlet.http.HttpServletRequest;
    50  import javax.servlet.http.HttpServletResponse;
    51  
    52  /**
    53   * Allows the user to manage (edit and remove) a static page.
    54   *
    55   * @author    Simon Brown
    56   */
    57  @RequireSecurityToken
    58  public class ManageStaticPageAction extends SecureAction {
    59  
    60    /** the log used by this class */
    61    private static final Log log = LogFactory.getLog(ManageStaticPageAction.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
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@74 != null
              * 
              *  Postconditions:
              *    return_value in Addr_Set{&new StaticPageLockedView(process#7),&new RedirectView(process#8),&new RedirectView(process#12),&new RedirectView(process#14),&new ForwardView(process#4),&new NotFoundView(process#3)}
              *    new ForwardView(process#4) num objects <= 1
              *    new ForwardView(process#4).uri != null
              *    new NotFoundView(process#3) num objects <= 1
              *    new RedirectView(process#12) num objects <= 1
              *    new RedirectView(process#14) num objects <= 1
              *    new RedirectView(process#8) num objects <= 1
              *    new StaticPageLockedView(process#7) num objects <= 1
              * 
              *  Test Vectors:
              *    java.lang.String:equals(...)@105: {0}, {1}
              *    java.lang.String:equals(...)@88: {0}, {1}
              *    java.lang.String:equals(...)@90: {0}, {1}
              *    java.lang.String:equalsIgnoreCase(...)@105: {0}, {1}
              *    java.lang.String:equalsIgnoreCase(...)@90: {0}, {1}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@73: Addr_Set{null}, Inverse{null}
              */
    71      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
    72      String id = request.getParameter("page");
    73      String confirm = request.getParameter("confirm");
    74      String submit = request.getParameter("submit");
    75  
    76      StaticPageService service = new StaticPageService();
    77      StaticPage staticPage = null;
    78      try {
    79        staticPage = service.getStaticPageById(blog, id);
    80      } catch (StaticPageServiceException e) {
    81        throw new ServletException(e);
    82      }
    83  
    84      if (staticPage == null) {
    85        return new NotFoundView();
    86      }
    87  
    88      if (submit.equals("Edit")) {
    89        return new ForwardView("/editStaticPage.secureaction?page=" + id);
    90      } else if (submit.equalsIgnoreCase("Remove") && confirm != null && confirm.equals("true")) {
    91        try {
    92          if (service.lock(staticPage)) {
    93            service.removeStaticPage(staticPage);
    94            blog.info("Static page \"" + staticPage.getTitle() + "\" removed.");
    95            service.unlock(staticPage);
    96          } else {
    97            getModel().put(Constants.STATIC_PAGE_KEY, staticPage);
    98            return new StaticPageLockedView();
    99          }
   100  
   101          return new RedirectView(blog.getUrl() + "viewStaticPages.secureaction");
   102        } catch (StaticPageServiceException e) {
   103          throw new ServletException(e);
   104        }
   105      } else if (submit.equalsIgnoreCase("Unlock") && confirm != null && confirm.equals("true")) {
   106          service.unlock(staticPage);
   107          blog.info("Static page <a href=\"" + staticPage.getLocalPermalink() + "\">" + staticPage.getTitle() + "</a> unlocked.");
   108  
   109          return new RedirectView(blog.getUrl() + "viewStaticPages.secureaction");
   110      }
   111  
   112      return new RedirectView(staticPage.getLocalPermalink());
   113    }
   114  
   115    /**
   116     * Gets a list of all roles that are allowed to access this action.
   117     *
   118     * @return  an array of Strings representing role names
   119     * @param request
   120     */
   121    public String[] getRoles(HttpServletRequest request) {
             /* 
    P/P       *  Method: String[] getRoles(HttpServletRequest)
              * 
              *  Preconditions:
              *    request != null
              * 
              *  Presumptions:
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_ADMIN_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_OWNER_ROLE)
              * 
              *  Postconditions:
              *    return_value in Addr_Set{&new String[](getRoles#3),&new String[](getRoles#2),&new String[](getRoles#1),&new String[](getRoles#4)}
              *    new String[](getRoles#1) num objects <= 1
              *    new String[](getRoles#1).length == 1
              *    new String[](getRoles#1)[0] == net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE
              *    (soft) init'ed(new String[](getRoles#1)[0])
              *    new String[](getRoles#2) num objects <= 1
              *    new String[](getRoles#2).length == 1
              *    new String[](getRoles#2)[0] == net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE
              *    (soft) init'ed(new String[](getRoles#2)[0])
              *    new String[](getRoles#3) num objects <= 1
              *    ...
              * 
              *  Test Vectors:
              *    java.lang.String:equalsIgnoreCase(...)@125: {0}, {1}
              *    java.lang.String:equalsIgnoreCase(...)@127: {0}, {1}
              *    java.lang.String:equalsIgnoreCase(...)@129: {0}, {1}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@122: Addr_Set{null}, Inverse{null}
              */
   122      String submit = request.getParameter("submit");
   123  
   124      if (submit != null) {
   125        if (submit.equalsIgnoreCase("Edit")) {
   126          return new String[]{Constants.BLOG_CONTRIBUTOR_ROLE};
   127        } else if (submit.equalsIgnoreCase("Remove")) {
   128          return new String[]{Constants.BLOG_CONTRIBUTOR_ROLE};
   129        } else if (submit.equalsIgnoreCase("Unlock")) {
   130          return new String[]{Constants.BLOG_ADMIN_ROLE, Constants.BLOG_OWNER_ROLE, Constants.BLOG_CONTRIBUTOR_ROLE};
   131        }
   132      }
   133  
   134      // default back to blog owner role
   135      return new String[]{Constants.BLOG_OWNER_ROLE};
   136    }
   137  
   138  }