/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.AddRefererFiltersAction__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.domain.RefererFilter;
    36  import net.sourceforge.pebble.domain.RefererFilterManager;
    37  import net.sourceforge.pebble.domain.Blog;
    38  import net.sourceforge.pebble.web.security.RequireSecurityToken;
    39  import net.sourceforge.pebble.web.view.ForwardView;
    40  import net.sourceforge.pebble.web.view.RedirectView;
    41  import net.sourceforge.pebble.web.view.View;
    42  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.AddRefererFiltersAction()
          */
    43  import javax.servlet.ServletException;
    44  import javax.servlet.http.HttpServletRequest;
    45  import javax.servlet.http.HttpServletResponse;
    46  
    47  /**
    48   * Adds one or more referer filters.
    49   *
    50   * @author    Simon Brown
    51   */
    52  @RequireSecurityToken
    53  public class AddRefererFiltersAction extends SecureAction {
    54  
    55    /**
    56     * Peforms the processing associated with this action.
    57     *
    58     * @param request  the HttpServletRequest instance
    59     * @param response the HttpServletResponse instance
    60     * @return the name of the next view
    61     */
    62    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:
              *    expressions.length@64 <= 232-1
              *    java.util.HashMap:get(...)@63 != null
              *    net.sourceforge.pebble.domain.Blog:getRefererFilterManager(...)@69 != null
              * 
              *  Postconditions:
              *    return_value in Addr_Set{&new RedirectView(process#2),&new ForwardView(process#3)}
              *    new ForwardView(process#3) num objects <= 1
              *    new ForwardView(process#3).uri == &".viewRefererFilters.secureaction"
              *    new RedirectView(process#2) num objects <= 1
              * 
              *  Test Vectors:
              *    Local_8[Local_6]@64: Addr_Set{null}, Inverse{null}
              *    java.lang.String:length(...)@68: {0}, {1..232-1}
              *    java.lang.String:length(...)@78: {0}, {1..232-1}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@77: Addr_Set{null}, Inverse{null}
              *    javax.servlet.http.HttpServletRequest:getParameterValues(...)@64: Addr_Set{null}, Inverse{null}
              */
    63      Blog rootBlog = (Blog)getModel().get(Constants.BLOG_KEY);
    64      String expressions[] = request.getParameterValues("expression");
    65  
    66      if (expressions != null) {
    67        for (String expression : expressions) {
    68          if (expression != null && expression.trim().length() > 0) {
    69            RefererFilterManager rm = rootBlog.getRefererFilterManager();
    70            RefererFilter filter = new RefererFilter(expression);
    71            rm.addFilter(filter);
    72          }
    73        }
    74      }
    75  
    76      // is there a redirect override?
    77      String redirectUrl = request.getParameter("redirectUrl");
    78      if (redirectUrl != null && redirectUrl.length() > 0) {
    79        return new RedirectView(redirectUrl);
    80      } else {
    81        return new ForwardView("/viewRefererFilters.secureaction");
    82      }
    83    }
    84  
    85    /**
    86     * Gets a list of all roles that are allowed to access this action.
    87     *
    88     * @return  an array of Strings representing role names
    89     * @param request
    90     */
    91    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_CONTRIBUTOR_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_OWNER_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_PUBLISHER_ROLE)
              * 
              *  Postconditions:
              *    return_value == &new String[](getRoles#1)
              *    new String[](getRoles#1) num objects == 1
              *    return_value.length == 4
              *    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])
              *    return_value[2] == net.sourceforge.pebble.Constants.BLOG_PUBLISHER_ROLE
              *    (soft) init'ed(return_value[2])
              *    return_value[3] == net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE
              *    ...
              */
    92      return new String[]{Constants.BLOG_ADMIN_ROLE, Constants.BLOG_OWNER_ROLE, Constants.BLOG_PUBLISHER_ROLE, Constants.BLOG_CONTRIBUTOR_ROLE};
    93    }
    94  
    95  }