1 /**
2 * This file Copyright (c) 2008-2015 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.voting.voters;
35
36 import info.magnolia.context.Context;
37 import info.magnolia.context.MgnlContext;
38 import info.magnolia.context.WebContext;
39
40 import java.util.ArrayList;
41 import java.util.List;
42
43 import javax.servlet.http.HttpServletRequest;
44
45 /**
46 * A voter which checks the user agent header in <code>request</code>
47 * object against a list of allowed and/or rejected user agents.
48 */
49 public class UserAgentVoter extends AbstractBoolVoter {
50 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(UserAgentVoter.class);
51
52 private final List<String> allowed = new ArrayList<String>();
53 private final List<String> rejected = new ArrayList<String>();
54
55 public List<String> getAllowed() {
56 return allowed;
57 }
58
59 public void setAllowed(List<String> allowed) {
60 this.allowed.addAll(allowed);
61 }
62
63 public void addAllowed(String contentType) {
64 allowed.add(contentType);
65 }
66
67 public List<String> getRejected() {
68 return rejected;
69 }
70
71 public void setRejected(List<String> rejected) {
72 this.rejected.addAll(rejected);
73 }
74
75 public void addRejected(String contentType) {
76 rejected.add(contentType);
77 }
78
79 @Override
80 protected boolean boolVote(Object value) {
81 final HttpServletRequest request;
82 if (value instanceof HttpServletRequest) {
83 request = (HttpServletRequest) value;
84 } else {
85 final Context ctx = MgnlContext.getInstance();
86 if (ctx instanceof WebContext) {
87 request = ((WebContext) ctx).getRequest();
88 } else {
89 return false;
90 }
91 }
92
93 final String userAgent = request.getHeader("User-Agent");
94 // values look like:
95 // Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.0.4) Gecko/2008111317 Ubuntu/8.04 (hardy) Firefox/3.0.4
96 if (userAgent == null) {
97 log.warn("No user agent on the request, can't vote.");
98 return false;
99 }
100 if (allowed.size() > 0 && !matches(allowed, userAgent)) {
101 return false;
102 }
103 if (rejected.size() > 0 && matches(rejected, userAgent)) {
104 return false;
105 }
106 return true;
107 }
108
109 /**
110 * Matches obtained user agent against patterns in the list.
111 * @param patterns List of patterns to check.
112 * @param userAgent User Agent value from the request.
113 * @return true if at least one pattern matches the <code>userAgent</code>, false otherwise.
114 */
115 private boolean matches(List patterns, String userAgent) {
116 for (int i = 0; i < patterns.size(); i++) {
117 if (userAgent.matches((String) patterns.get(i))) {
118 return true;
119 }
120 }
121 return false;
122 }
123 }