001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.jsp.util;
029
030import org.opencms.util.CmsRequestUtil;
031
032import java.util.Arrays;
033import java.util.List;
034
035import javax.servlet.http.HttpServletRequest;
036
037/**
038 * This class provides the detection for different devices, so that the
039 * <code>&lt;cms:device type="..."&gt;</code>-Tag can detect which device sends the HTTP request.<p>
040 *
041 * @since 8.0.0
042 */
043public class CmsJspDeviceSelector implements I_CmsJspDeviceSelector {
044
045    /** Constant for desktop detection. */
046    public static final String C_DESKTOP = "desktop";
047
048    /** Constant for mobile detection. */
049    public static final String C_MOBILE = "mobile";
050
051    /** The list of types supported by this device selector implementation. */
052    public static final List<String> TYPES = Arrays.asList(new String[] {C_MOBILE, C_DESKTOP});
053
054    /** The user agent info. */
055    private UAgentInfo m_userAgentInfo;
056
057    /**
058     * @see org.opencms.jsp.util.I_CmsJspDeviceSelector#getDeviceType(javax.servlet.http.HttpServletRequest)
059     */
060    public String getDeviceType(HttpServletRequest req) {
061
062        m_userAgentInfo = new UAgentInfo(
063            req.getHeader(CmsRequestUtil.HEADER_USER_AGENT),
064            req.getHeader(CmsRequestUtil.HEADER_ACCEPT));
065        if (m_userAgentInfo.detectMobileQuick()) {
066            return C_MOBILE;
067        }
068        return C_DESKTOP;
069    }
070
071    /**
072     * @see org.opencms.jsp.util.I_CmsJspDeviceSelector#getDeviceTypes()
073     */
074    public List<String> getDeviceTypes() {
075
076        return TYPES;
077    }
078
079    /**
080     * Returns the User Agent info.<p>
081     *
082     * @return the information about the user agent
083     */
084    public UAgentInfo getUserAgentInfo() {
085
086        return m_userAgentInfo;
087    }
088}