/**
    * This file Copyright (c) 2008-2012 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.module.templatingkit.badge;
  
  import info.magnolia.context.MgnlContext;
  
  import java.text.MessageFormat;
  import java.util.Random;
  
  import org.apache.commons.lang.BooleanUtils;
  
  
  /**
   * Info Badge Support used by the RenderingModel implementation class.
   * @author pbracher
   * @version $Id$
   *
   */
  public final class BadgeSupport {
  
      private static final String BADGE_TEMPLATE = "<p id=\"copyright-magnolia\"><span>Powered by</span> <a href=\"http://www.magnolia-cms.com\"><strong>Magnolia</strong> - {0}</a></p>";
  
      private static final String HAS_BEEN_CALLED_ATTRIBUTE = BadgeSupport.class.getName() + ".hasBeenCalled";
  
      private static final String EMPTY_BADGE = "";
  
      /**
       * Not configured.
       */
      private static BadgeSupport instance = new BadgeSupport();
  
      private String[] badges = {
          "based on Java Content Repository",
          "based on JSR-170",
          "Intuitive CMS Software",
          "Intuitive CMS System",
          "intuitive Content Management Software",
          "Intuitive Content Management Solutions",
          "Intuitive Content Management Tool",
          "Intuitive Opensource CMS",
          "Intuitive Web CMS",
          "Intuitive Web Content Management System",
          "Intuitive Website CMS",
          "Intuitive Website Content Management System",
          "Java Content Management System",
          "Java Open-Source CMS",
          "Open-Source Content Management System",
          "Open-Source Enterprise Content Management",
          "Open-Source Java CMS",
          "Open-Source Java Content Management",
          "SEO-friendly CMS",
          "Simple Open-Source CMS",
          "Simple Open-Source Content Management",
          "Web-Site Content Management System",
          "Website Content Management"
      };
  
      private MessageFormat template = new MessageFormat(BADGE_TEMPLATE);
  
      private Random numberGenerator = new Random();
  
      public String renderBadge(){
          MgnlContext.setAttribute(HAS_BEEN_CALLED_ATTRIBUTE, Boolean.TRUE);
          final int randomIndex = numberGenerator.nextInt(badges.length);
          final String badge = badges[randomIndex];
          return template.format(new Object[] { badge });
      }
  
     public boolean hasBeenCalled(){
         Boolean value = (Boolean) MgnlContext.getAttribute(HAS_BEEN_CALLED_ATTRIBUTE);
         return BooleanUtils.toBoolean(value);
     }
 
     public static BadgeSupport getInstance() {
         return instance;
     }
 
 }