utilitiesaction.java

### File Source: utilitiesaction.java

             /*
        P/P   *  Method: net.sourceforge.pebble.web.action.UtilitiesAction__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.Category;
        36  import net.sourceforge.pebble.domain.Blog;
        37  import net.sourceforge.pebble.util.Utilities;
        38  import net.sourceforge.pebble.web.security.RequireSecurityToken;
        39  import net.sourceforge.pebble.web.security.SecurityTokenValidatorCondition;
        40  import net.sourceforge.pebble.web.view.ForwardView;
        41  import net.sourceforge.pebble.web.view.View;
        42  import net.sourceforge.pebble.web.view.impl.UtilitiesView;
        43
             /*
        P/P   *  Method: void net.sourceforge.pebble.web.action.UtilitiesAction()
              */
        44  import javax.servlet.ServletException;
        45  import javax.servlet.http.HttpServletRequest;
        46  import javax.servlet.http.HttpServletResponse;
        47
        48  /**
        49   * Utilities for the current blog, such as those useful for moving
        50   * between versions of Pebble.
        51   *
        52   * @author    Simon Brown
        53   */
        54  @RequireSecurityToken(UtilitiesAction.UtilitiesCondition.class)
        55  public class UtilitiesAction 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
                  *    this.model != null
                  *    this.model.data != null
                  *
                  *  Presumptions:
                  *    java.util.HashMap:get(...)@63 != null
                  *
                  *  Postconditions:
                  *    return_value in Addr_Set{&new ForwardView(process#5),&new ForwardView(process#4),&new ForwardView(process#3),&new ForwardView(process#2),&new ForwardView(process#1),&new UtilitiesView(process#6)}
                  *    new ForwardView(process#1) num objects <= 1
                  *    new ForwardView(process#1).uri == &".reloadBlog.secureaction"
                  *    new ForwardView(process#2) num objects <= 1
                  *    new ForwardView(process#2).uri == &".reloadBlog.secureaction"
                  *    new ForwardView(process#3) num objects <= 1
                  *    new ForwardView(process#3).uri == &".reloadBlog.secureaction"
                  *    new ForwardView(process#4) num objects <= 1
                  *    new ForwardView(process#4).uri == &".reloadBlog.secureaction"
                  *    new ForwardView(process#5) num objects <= 1
                  *    ...
                  *
                  *  Test Vectors:
                  *    java.lang.String:equalsIgnoreCase(...)@69: {0}, {1}
                  *    java.lang.String:equalsIgnoreCase(...)@72: {0}, {1}
                  *    java.lang.String:equalsIgnoreCase(...)@75: {0}, {1}
                  *    java.lang.String:equalsIgnoreCase(...)@78: {0}, {1}
                  *    java.lang.String:equalsIgnoreCase(...)@81: {0}, {1}
                  *    java.lang.String:equalsIgnoreCase(...)@85: {0}, {1}
                  *    javax.servlet.http.HttpServletRequest:getParameter(...)@66: Addr_Set{null}, Inverse{null}
                  *    net.sourceforge.pebble.domain.Blog:getCategory(...)@86: Addr_Set{null}, Inverse{null}
                  *    net.sourceforge.pebble.domain.Blog:getCategory(...)@87: Addr_Set{null}, Inverse{null}
                  */
        65      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
        66      String action = request.getParameter("action");
        67      if (action == null) {
        68        // do nothing
        69      } else if (action.equalsIgnoreCase("ipAddressListener")) {
        70        Utilities.buildIpAddressLists(blog);
        71        return new ForwardView("/reloadBlog.secureaction");
        72      } else if (action.equalsIgnoreCase("fixHtmlInResponses")) {
        73        Utilities.fixHtmlInResponses(blog);
        74        return new ForwardView("/reloadBlog.secureaction");
        75      } else if (action.equalsIgnoreCase("buildIndexes")) {
        76        Utilities.buildIndexes(blog);
        77        return new ForwardView("/reloadBlog.secureaction");
        78      } else if (action.equalsIgnoreCase("convertCategories")) {
        79        Utilities.convertCategories(blog);
        80        return new ForwardView("/reloadBlog.secureaction");
        81      } else if (action.equalsIgnoreCase("restructureBlogToGMT")) {
        82        Utilities.restructureBlogToGMT(blog);
        83        Utilities.buildIndexes(blog);
        84        return new ForwardView("/reloadBlog.secureaction");
        85      } else if (action.equalsIgnoreCase("moveBlogEntriesFromCategory")) {
        86        Category from = blog.getCategory(request.getParameter("from"));
        87        Category to = blog.getCategory(request.getParameter("to"));
        88        if (from != null && to != null) {
        89          Utilities.moveBlogEntriesFromCategory(blog, from, to);
        90        }
        91      }
        92
        93      return new UtilitiesView();
        94    }
        95
        96    /**
        97     * Gets a list of all roles that are allowed to access this action.
        98     *
        99     * @return  an array of Strings representing role names
       100     * @param request
       101     */
       102    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])
                  */
       103      return new String[]{Constants.BLOG_ADMIN_ROLE, Constants.BLOG_OWNER_ROLE};
       104    }
       105
       106    public static class UtilitiesCondition implements SecurityTokenValidatorCondition {
       107      public boolean shouldValidate(HttpServletRequest request) {
       108        // Only validate if we have an action, so return true if the action is not null
                   /*
        P/P         *  Method: bool shouldValidate(HttpServletRequest)
                    *
                    *  Preconditions:
                    *    request != null
                    *
                    *  Postconditions:
                    *    init'ed(return_value)
                    *
                    *  Test Vectors:
                    *    javax.servlet.http.HttpServletRequest:getParameter(...)@109: Addr_Set{null}, Inverse{null}
                    */
       109        return request.getParameter("action") != null;
       110      }
       111    }
       112  }

SofCheck Inspector Build Version : 2.22510

utilitiesaction.java | 2010-Jun-25 19:40:34
utilitiesaction.class | 2010-Jul-19 20:23:38
utilitiesaction$utilitiescondition.class | 2010-Jul-19 20:23:38