/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.SavePluginsAction__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.BlogServiceException;
    36  import net.sourceforge.pebble.domain.Blog;
    37  import net.sourceforge.pebble.plugins.PluginConfigType;
    38  import net.sourceforge.pebble.web.security.RequireSecurityToken;
    39  import net.sourceforge.pebble.web.view.ForwardView;
    40  import net.sourceforge.pebble.web.view.View;
    41  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.SavePluginsAction()
          */
    42  import javax.servlet.ServletException;
    43  import javax.servlet.http.HttpServletRequest;
    44  import javax.servlet.http.HttpServletResponse;
    45  import java.util.Enumeration;
    46  import java.util.Properties;
    47  
    48  /**
    49   * Saves the plugins associated with the current blog.
    50   *
    51   * @author    Simon Brown
    52   */
    53  @RequireSecurityToken
    54  public class SavePluginsAction extends SecureAction {
    55  
    56    /**
    57     * Peforms the processing associated with this action.
    58     *
    59     * @param request  the HttpServletRequest instance
    60     * @param response the HttpServletResponse instance
    61     * @return the name of the next view
    62     */
    63    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.Enumeration:nextElement(...)@71 != null
              *    java.util.HashMap:get(...)@63 != null
              *    javax.servlet.http.HttpServletRequest:getParameterNames(...)@69 != null
              *    javax.servlet.http.HttpServletRequest:getParameterValues(...).length@76 >= 1
              *    javax.servlet.http.HttpServletRequest:getParameterValues(...)@76 != null
              *    ...
              * 
              *  Postconditions:
              *    return_value == &new ForwardView(process#3)
              *    new ForwardView(process#3) num objects == 1
              *    new ForwardView(process#3).uri == &".reloadBlog.secureaction?redirectUrl=.aboutBlog.secureaction"
              * 
              *  Test Vectors:
              *    java.lang.String:equals(...)@73: {1}, {0}
              *    java.lang.String:length(...)@67: {0}, {1..232-1}
              *    java.lang.String:length(...)@78: {1..232-1}, {0}
              *    java.lang.String:startsWith(...)@75: {0}, {1}
              *    java.util.Enumeration:hasMoreElements(...)@70: {1}, {0}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@66: Addr_Set{null}, Inverse{null}
              *    javax.servlet.http.HttpServletRequest:getParameterValues(...)@88: Addr_Set{null}, Inverse{null}
              *    javax.servlet.http.HttpServletRequest:getParameterValues(...)[0]@76: Addr_Set{null}, Inverse{null}
              *    values.length@88: {1..232-1}, {0}
              */
    64      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
    65  
    66      String submit = request.getParameter("submit");
    67      if (submit != null && submit.length() > 0) {
    68        Properties pluginProperties = blog.getPluginProperties().getProperties();
    69        Enumeration params = request.getParameterNames();
    70        while (params.hasMoreElements()) {
    71          String key = (String)params.nextElement();
    72  
    73          if (key.equals("submit")) {
    74            // this is the parameter representing the submit button - do nothing
    75          } else if (key.startsWith(PluginConfigType.PLUGIN_PROPERTY_NAME_PREFIX)) {
    76            String value = request.getParameterValues(key)[0];
    77            String property = key.substring(PluginConfigType.PLUGIN_PROPERTY_NAME_PREFIX.length());
    78            if (value == null || value.length() == 0)
    79            {
    80              pluginProperties.remove(property);
    81            }
    82            else
    83            {
    84              pluginProperties.setProperty(property, value);
    85            }
    86          } else {
    87            // this is an existing parameter - save or remove it
    88            String[] values = request.getParameterValues(key);
    89            if (values == null || values.length == 0) {
    90              blog.removeProperty(key);
    91            } else {
    92              StringBuilder builder = new StringBuilder();
    93              String separator = "";
    94              for (String value : values)
    95              {
    96                builder.append(separator).append(value);
    97                separator = "\n";
    98              }
    99              blog.setProperty(key, builder.toString());
   100            }
   101          }
   102        }
   103  
   104        try {
   105          blog.storeProperties();
   106          blog.getPluginProperties().store();
   107        } catch (BlogServiceException e) {
   108          throw new ServletException(e);
   109        }
   110      }
   111  
   112      return new ForwardView("/reloadBlog.secureaction?redirectUrl=/aboutBlog.secureaction");
   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)
              * 
              *  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])
              */
   122      return new String[]{
   123          Constants.BLOG_ADMIN_ROLE,
   124          Constants.BLOG_OWNER_ROLE
   125      };
   126    }
   127  
   128  }