app/src/main/java/org/apache/roller/weblogger/ui/rendering/util/ParsedRequest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  The ASF licenses this file to You
 * under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.  For additional information regarding
 * copyright in this work, please see the NOTICE file in the top level
 * directory of this distribution.
 */

package org.apache.roller.weblogger.ui.rendering.util;

import javax.servlet.http.HttpServletRequest;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.roller.weblogger.WebloggerException;
import org.apache.roller.weblogger.business.WebloggerFactory;
import org.apache.roller.weblogger.business.UserManager;
import org.apache.roller.weblogger.pojos.User;
import org.apache.roller.weblogger.ui.rendering.mobile.MobileDeviceRepository;


/**
 * An abstract class representing any request made to Roller that has been
 * parsed in order to extract relevant pieces of information from the url.
 *
 * NOTE: It is extremely important to mention that this class and all of its
 * subclasses are meant to be extremely light weight.  Meaning they should
 * avoid any time consuming operations at all costs, especially operations
 * which require a trip to the db.  Those operations should be used very, very
 * sparingly and should only be triggered when it's guaranteed that they are
 * needed.
 */
public abstract class ParsedRequest {
    
    private static Log log = LogFactory.getLog(ParsedRequest.class);
    
    HttpServletRequest request = null;
    
    // lightweight attributes
    private String authenticUser = null;

    private MobileDeviceRepository.DeviceType deviceType = 
			MobileDeviceRepository.DeviceType.standard;
    
    // heavyweight attributes
    private User user = null;
    
    
    ParsedRequest() {}
    
    
    /**
     * Parse the given http request and extract any information we can.
     *
     * This abstract version of the constructor gathers info likely to be
     * relevant to all requests to Roller.
     */
    public ParsedRequest(HttpServletRequest request) throws InvalidRequestException {
        
        // keep a reference to the original request
        this.request = request;
        
        // login status
        java.security.Principal prince = request.getUserPrincipal();
        if(prince != null) {
            this.authenticUser = prince.getName();
        }
        // set the detected type of the request
        deviceType = MobileDeviceRepository.getRequestType(request);
    }
    
    
    public String getAuthenticUser() {
        return this.authenticUser;
    }
    
    
    public void setAuthenticUser(String authenticUser) {
        this.authenticUser = authenticUser;
    }
    
    
    public User getUser() {
        
        if(user == null && authenticUser != null) {
            try {
                UserManager umgr = WebloggerFactory.getWeblogger().getUserManager();
                user = umgr.getUserByUserName(authenticUser);
            } catch (WebloggerException ex) {
                log.error("Error looking up user "+authenticUser, ex);
            }
        }
        
        return user;
    }
    
    
    public void setUser(User u) {
        this.user = u;
    }
    
    
    public boolean isLoggedIn() {
        return (this.authenticUser != null);
    }

    public MobileDeviceRepository.DeviceType getDeviceType() {
        return deviceType;
    }

    public void setDeviceType(MobileDeviceRepository.DeviceType type) {
        this.deviceType = type;
    }
}