/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.SaveBlogPropertiesAction__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.domain.BlogServiceException;
    37  import net.sourceforge.pebble.web.security.RequireSecurityToken;
    38  import net.sourceforge.pebble.web.view.ForwardView;
    39  import net.sourceforge.pebble.web.view.RedirectView;
    40  import net.sourceforge.pebble.web.view.View;
    41  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.SaveBlogPropertiesAction()
          */
    42  import javax.servlet.ServletException;
    43  import javax.servlet.http.HttpServletRequest;
    44  import javax.servlet.http.HttpServletResponse;
    45  import java.util.Enumeration;
    46  
    47  /**
    48   * Saves the properties associated with the current Blog.
    49   *
    50   * @author    Simon Brown
    51   */
    52  @RequireSecurityToken
    53  public class SaveBlogPropertiesAction 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:
              *    java.util.Enumeration:nextElement(...)@71 != null
              *    java.util.HashMap:get(...)@63 != null
              *    javax.servlet.http.HttpServletRequest:getParameterNames(...)@69 != null
              *    net.sourceforge.pebble.domain.Blog:getProperty(...)@67 != null
              * 
              *  Postconditions:
              *    return_value in Addr_Set{&new ForwardView(process#2),&new RedirectView(process#3)}
              *    new ForwardView(process#2) num objects <= 1
              *    new ForwardView(process#2).uri == &".reindexBlog.secureaction"
              *    new RedirectView(process#3) num objects <= 1
              * 
              *  Test Vectors:
              *    java.lang.String:equals(...)@114: {1}, {0}
              *    java.lang.String:equals(...)@74: {1}, {0}
              *    java.lang.String:length(...)@66: {0}, {1..232-1}
              *    java.lang.String:length(...)@78: {1..232-1}, {0}
              *    java.util.Enumeration:hasMoreElements(...)@70: {1}, {0}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@65: Addr_Set{null}, Inverse{null}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@72: Addr_Set{null}, Inverse{null}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@88: Inverse{null}, Addr_Set{null}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@93: Inverse{null}, Addr_Set{null}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@98: Inverse{null}, Addr_Set{null}
              */
    63      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
    64  
    65      String submit = request.getParameter("submit");
    66      if (submit != null && submit.length() > 0) {
    67        String currentTimeZone = blog.getProperty(Blog.TIMEZONE_KEY);
    68  
    69        Enumeration params = request.getParameterNames();
    70        while (params.hasMoreElements()) {
    71          String key = (String)params.nextElement();
    72          String value = request.getParameter(key);
    73  
    74          if (key.equals("submit")) {
    75            // this is the parameter representing the submit button - do nothing
    76          } else {
    77            // this is an existing parameter - save or remove it
    78            if (value == null || value.length() == 0) {
    79              blog.removeProperty(key);
    80            } else {
    81              blog.setProperty(key, value);
    82            }
    83          }
    84        }
    85  
    86        // and now the checkboxes
    87        String name = "richTextEditorForBlogEntriesEnabled";
    88        String checkbox = request.getParameter(name);
    89        if (checkbox == null) {
    90          blog.setProperty(name, "false");
    91        }
    92        name = "richTextEditorForStaticPagesEnabled";
    93        checkbox = request.getParameter(name);
    94        if (checkbox == null) {
    95          blog.setProperty(name, "false");
    96        }
    97        name = "richTextEditorForCommentsEnabled";
    98        checkbox = request.getParameter(name);
    99        if (checkbox == null) {
   100          blog.setProperty(name, "false");
   101        }
   102  
   103        try {
   104          blog.storeProperties();
   105          blog.info("Blog properties saved.");
   106        } catch (BlogServiceException e) {
   107          throw new ServletException(e);
   108        }
   109  
   110        // if the following properties have changed, reload the blog
   111        //  - timezone
   112        String newTimeZone = blog.getProperty(Blog.TIMEZONE_KEY);
   113  
   114        if (!currentTimeZone.equals(newTimeZone)) {
   115          return new ForwardView("/reindexBlog.secureaction");
   116        }
   117  
   118      }
   119  
   120      return new RedirectView(blog.getUrl() + "viewBlogProperties.secureaction");
   121    }
   122  
   123    /**
   124     * Gets a list of all roles that are allowed to access this action.
   125     *
   126     * @return  an array of Strings representing role names
   127     * @param request
   128     */
   129    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])
              */
   130      return new String[]{
   131          Constants.BLOG_ADMIN_ROLE,
   132          Constants.BLOG_OWNER_ROLE
   133      };
   134    }
   135  
   136  }