/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.ViewPluginsAction__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.Blog;
    36  import net.sourceforge.pebble.plugins.PluginLocator;
    37  import net.sourceforge.pebble.web.view.View;
    38  import net.sourceforge.pebble.web.view.impl.PluginsView;
    39  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.ViewPluginsAction()
          */
    40  import javax.servlet.ServletException;
    41  import javax.servlet.http.HttpServletRequest;
    42  import javax.servlet.http.HttpServletResponse;
    43  
    44  /**
    45   * Views the plugins associated with the current blog.
    46   *
    47   * @author    Simon Brown
    48   */
    49  public class ViewPluginsAction extends SecureAction {
    50  
    51    /**
    52     * Peforms the processing associated with this action.
    53     *
    54     * @param request  the HttpServletRequest instance
    55     * @param response the HttpServletResponse instance
    56     * @return the name of the next view
    57     */
    58    public View process(HttpServletRequest request, HttpServletResponse response) throws ServletException {
             /* 
    P/P       *  Method: View process(HttpServletRequest, HttpServletResponse)
              * 
              *  Preconditions:
              *    init'ed(net/sourceforge/pebble/plugins/PluginLocator.availablePlugins)
              *    this.model != null
              *    this.model.data != null
              * 
              *  Presumptions:
              *    java.util.HashMap:get(...)@63 != null
              *    net.sourceforge.pebble.domain.Blog:getPluginProperties(...).properties@61 != null
              *    net.sourceforge.pebble.domain.Blog:getPluginProperties(...)@60 != null
              *    net.sourceforge.pebble.domain.Blog:getPluginProperties(...)@61 != null
              * 
              *  Postconditions:
              *    net/sourceforge/pebble/plugins/PluginLocator.availablePlugins == One-of{old net/sourceforge/pebble/plugins/PluginLocator.availablePlugins, &new AvailablePlugins(locateAvailablePlugins#3)}
              *    net/sourceforge/pebble/plugins/PluginLocator.availablePlugins != null
              *    return_value == &new PluginsView(process#1)
              *    new AvailablePlugins(locateAvailablePlugins#3) num objects <= 1
              *    new HashMap(locateAvailablePlugins#1) num objects == new AvailablePlugins(locateAvailablePlugins#3) num objects
              *    new AvailablePlugins(locateAvailablePlugins#3).plugins == &new HashMap(locateAvailablePlugins#1)
              *    new PluginsView(process#1) num objects == 1
              */
    59      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
    60      getModel().put("pluginProperties", blog.getPluginProperties().getProperties());
    61      getModel().put("pluginPropertiesAsString", blog.getPluginProperties().getPropertiesAsString());
    62      getModel().put("availablePlugins", PluginLocator.getAvailablePluginsSortedForBlog(blog));
    63  
    64      return new PluginsView();
    65    }
    66  
    67    /**
    68     * Gets a list of all roles that are allowed to access this action.
    69     *
    70     * @return  an array of Strings representing role names
    71     * @param request
    72     */
    73    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])
              */
    74      return new String[]{
    75          Constants.BLOG_ADMIN_ROLE,
    76          Constants.BLOG_OWNER_ROLE
    77      };
    78    }
    79  
    80  }