BotAgentInspector.java

/**
 * Copyright (C) 2010 Asterios Raptis
 *
 * Licensed 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.
 */
package de.alpharogroup.wicket.base.util.seo;

import java.util.HashSet;
import java.util.Set;

import lombok.experimental.UtilityClass;

/**
 * The Class BotAgentInspector has on method that checks for agent strings.
 */
@UtilityClass
public class BotAgentInspector
{

	/** The Constant BOT_AGENTS. */
	private static final Set<String> BOT_AGENTS = new HashSet<String>()
	{
		private static final long serialVersionUID = 1L;
		{
			add("googlebot");
			add("msnbot");
			add("slurp");
			add("jeeves");
			add("appie");
			add("architext");
			add("ferret");
			add("harvest");
			add("htdig");
			add("linkwalker");
			add("lycos_");
			add("moget");
			add("muscatferret");
			add("myweb");
			add("nomad");
			add("scooter");
			add("yahoo!\\sslurp\\schina");
			add("antibot");
			add("bruinbot");
			add("digout4u");
			add("echo!");
			add("ia_archiver");
			add("jennybot");
			add("mercator");
			add("netcraft");
			add("petersnews");
			add("unlost_web_crawler");
			add("voila");
			add("webbase");
			add("webcollage");
			add("cfetch");
			add("zyborg");
			add("wisenutbot");
			add("robot");
			add("spider");
		}
	};

	/** The Constant NO_BOT_AGENTS. */
	private static final Set<String> NO_BOT_AGENTS = new HashSet<String>()
	{
		private static final long serialVersionUID = 1L;
		{
			add("firefox");
			add("msie");
			add("opera");
			add("netscape");
			add("safari");
			add("chrome");
		}
	};

	/**
	 * Checks if the given String object is agent over the String array BOT_AGENTS.
	 * 
	 * @param agent
	 *            String to check.
	 * @return true, if is agent
	 */
	public static boolean isAgent(final String agent)
	{
		if (agent != null)
		{
			final String lowerAgent = agent.toLowerCase();
			for (final String noBot : NO_BOT_AGENTS)
			{
				if (lowerAgent.contains(noBot))
				{
					return false;
				}
			}
			for (final String bot : BOT_AGENTS)
			{
				if (lowerAgent.contains(bot))
				{
					return true;
				}
			}
		}
		return false;
	}
}