Coverage Report - net.sourceforge.pebble.logging.UserAgentConsolidator
 
Classes in this File Line Coverage Branch Coverage Complexity
UserAgentConsolidator
87%
7/8
100%
4/4
3
 
 1  
 /*
 2  
  * Copyright (c) 2003-2011, 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  
 
 33  
 package net.sourceforge.pebble.logging;
 34  
 
 35  
 
 36  
 /**
 37  
  * Consolidate UserAgent String to a short name. This explicitly checks for a
 38  
  * few known snippets from the UserAgent that a browser reports. There's a
 39  
  * number of them missing - these are some of the most common as well as some
 40  
  * ancient ones.
 41  
  * 
 42  
  * Extracted from {@link net.sourceforge.pebble.web.action.ViewUserAgentsAction}
 43  
  */
 44  0
 public class UserAgentConsolidator {
 45  
 
 46  
   /**
 47  
    * UserAgent identifications that are known. Be careful when you add more: they are 
 48  
    * supposed to be checked for matches in the order they appear here. So place more 
 49  
    * specific names (e.g. containing a version number) at the beginning, more generic 
 50  
    * ones at the end. 
 51  
    */
 52  4
   private static final String[] KNOWN_AGENTS = new String[] { "MSIE 5.0",
 53  
       "MSIE 6.0", "MSIE 7.0", "MSIE 8.0", "MSIE 9.0", "Firefox/1.",
 54  
       "Firefox/2.", "Firefox/3.0", "Firefox/3.5", "Firefox/3.6", "Safari",
 55  
       "Opera", "Chrome", "Bloglines", "Googlebot", "Feedfetcher-Google",
 56  
       "Yahoo! Slurp", "Bing"};  // Are all of these real? Should we remove old ones?
 57  
 
 58  
   /**
 59  
    * Consolidate given user agent to a short name if the agent is recognized,
 60  
    * UserAgentConsolidator.OTHER otherwise.
 61  
    * 
 62  
    * @param userAgent
 63  
    *          Name that the useragent identifies as
 64  
    * @return short name or UserAgentConsolidator.OTHER
 65  
    */
 66  
   public static String consolidate(String userAgent) {
 67  44
     String consolidatedUserAgent = "Other"; // not localized...
 68  528
     for(String knownAgent : KNOWN_AGENTS) {
 69  516
       if (userAgent.contains(knownAgent)) {
 70  32
         consolidatedUserAgent = knownAgent;
 71  32
         break;
 72  
       } 
 73  
     }
 74  44
     return consolidatedUserAgent;
 75  
   }
 76  
 
 77  
 }