/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.SaveUserPreferencesAction__static_init
          * 
          *  Postconditions:
          *    init'ed(log)
          */
     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.web.security.RequireSecurityToken;
    35  import org.apache.commons.logging.Log;
    36  import org.apache.commons.logging.LogFactory;
    37  import net.sourceforge.pebble.web.view.View;
    38  import net.sourceforge.pebble.web.view.RedirectView;
    39  import net.sourceforge.pebble.web.view.ForwardView;
    40  import net.sourceforge.pebble.web.view.impl.FourZeroThreeView;
    41  import net.sourceforge.pebble.web.validation.ValidationContext;
    42  import net.sourceforge.pebble.domain.AbstractBlog;
    43  import net.sourceforge.pebble.Constants;
    44  import net.sourceforge.pebble.PebbleContext;
    45  import net.sourceforge.pebble.util.SecurityUtils;
    46  import net.sourceforge.pebble.security.PebbleUserDetails;
    47  import net.sourceforge.pebble.security.SecurityRealm;
    48  import net.sourceforge.pebble.security.SecurityRealmException;
    49  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.SaveUserPreferencesAction()
          */
    50  import javax.servlet.http.HttpServletRequest;
    51  import javax.servlet.http.HttpServletResponse;
    52  import javax.servlet.ServletException;
    53  import java.util.Map;
    54  import java.util.HashMap;
    55  import java.util.Enumeration;
    56  
    57  /**
    58   * Saves user preferences.
    59   *
    60   * @author    Simon Brown
    61   */
    62  @RequireSecurityToken
    63  public class SaveUserPreferencesAction extends SecureAction {
    64  
    65    /** the log used by this class */
    66    private static final Log log = LogFactory.getLog(SaveUserPreferencesAction.class);
    67  
    68    private static final String PREFERENCE = "preference.";
    69  
    70    /**
    71     * Peforms the processing associated with this action.
    72     *
    73     * @param request  the HttpServletRequest instance
    74     * @param response the HttpServletResponse instance
    75     * @return the name of the next view
    76     */
    77    public View process(HttpServletRequest request, HttpServletResponse response) throws ServletException {
    78      try {
               /* 
    P/P         *  Method: View process(HttpServletRequest, HttpServletResponse)
                * 
                *  Preconditions:
                *    request != null
                *    this.model != null
                *    this.model.data != null
                *    (soft) net.sourceforge.pebble.PebbleContext__static_init.new PebbleContext(PebbleContext__static_init#1).configuration != null
                * 
                *  Presumptions:
                *    currentUserDetails.grantedAuthories.length@102 <= 232-1
                *    currentUserDetails.grantedAuthories@102 != null
                *    currentUserDetails.grantedAuthories[...]@102 != null
                *    java.io.File:exists(...)@103 == 1
                *    java.util.Enumeration:nextElement(...)@84 != null
                *    ...
                * 
                *  Postconditions:
                *    return_value in Addr_Set{&new ForwardView(process#6),&new RedirectView(process#4),&new FourZeroThreeView(process#2)}
                *    new ForwardView(process#6) num objects <= 1
                *    new ForwardView(process#6).uri == &".editUserPreferences.secureaction"
                *    new FourZeroThreeView(process#2) num objects <= 1
                *    new HashMap(PebbleUserDetails#1) num objects == 1
                *    new HashMap(getUser#3) num objects == 1
                *    new HashMap(setPreferences#1) num objects <= 1
                *    new RedirectView(process#4) num objects <= 1
                * 
                *  Test Vectors:
                *    currentUserDetails.detailsUpdateable: {1}, {0}
                *    java.lang.String:startsWith(...)@85: {0}, {1}
                *    java.util.Enumeration:hasMoreElements(...)@83: {1}, {0}
                */
    79        AbstractBlog blog = (AbstractBlog)getModel().get(Constants.BLOG_KEY);
    80  
    81        Map<String,String> preferences = new HashMap<String,String>();
    82        Enumeration parameterNames = request.getParameterNames();
    83        while (parameterNames.hasMoreElements()) {
    84          String parameterName = (String)parameterNames.nextElement();
    85          if (parameterName.startsWith(PREFERENCE)) {
    86            preferences.put(parameterName.substring(PREFERENCE.length()), request.getParameter(parameterName));
    87          }
    88        }
    89  
    90        PebbleUserDetails currentUserDetails = SecurityUtils.getUserDetails();
    91  
    92        // can the user change their user details?
+   93        if (!currentUserDetails.isDetailsUpdateable()) {
    94          return new FourZeroThreeView();
    95        }
    96  
    97        SecurityRealm realm = PebbleContext.getInstance().getConfiguration().getSecurityRealm();
    98  
    99        ValidationContext validationContext = new ValidationContext();
   100  
   101        if (!validationContext.hasErrors()) {
   102          currentUserDetails.setPreferences(preferences);
   103          realm.updateUser(currentUserDetails);
   104  
   105          return new RedirectView(blog.getUrl() + "editUserPreferences.secureaction");
   106        }
   107  
   108        getModel().put("validationContext", validationContext);
   109        return new ForwardView("/editUserPreferences.secureaction");
   110      } catch (SecurityRealmException e) {
   111        throw new ServletException(e);
   112      }
   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.ANY_ROLE)
              * 
              *  Postconditions:
              *    return_value == &new String[](getRoles#1)
              *    new String[](getRoles#1) num objects == 1
              *    return_value.length == 1
              *    return_value[0] == net.sourceforge.pebble.Constants.ANY_ROLE
              *    (soft) init'ed(return_value[0])
              */
   122      return new String[]{Constants.ANY_ROLE};
   123    }
   124  
   125  }