/*

  * Copyright 2005-2007 The Kuali Foundation

  * 

  * 

  * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php

  * 

  * 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 org.kuali.rice.core.config;

 import java.util.*;

 /**

  * Logs information about the configuration at the DEBUG level.

  *

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 public class ConfigLogger {

         private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(ConfigLogger.class);

         /**

          * List of keys to suppress the values for and the associated values to print instead.

          */

         private static final String[][] SECRET_KEYS = 

         { 

                 {"password", "Top Secret Password"}, 

                 {"encryption.key", "Top Secret Encryption Key"}

         };

         /**

          * These are a list of keys that we know we can display regardless of whether they

          * are considered "secret"

          */

         private static final String[] PUBLIC_KEYS = 

         { 

                 "cas.validate.password"

         };

         public static void logConfig(Config config) {

                 Map<String, String> safeConfig = getDisplaySafeConfig(config.getProperties());

                 String props = "";

                 for (Iterator iter = safeConfig.entrySet().iterator(); iter.hasNext();) {

                         Map.Entry property = (Map.Entry) iter.next();

                         String key = (String) property.getKey();

                         String value = (String) property.getValue();

                         props += key + "=[" + value + "],";

                 }

                 LOG.debug("Properties used " + props);

         }

         /**

          * Returns a value for a parameter that is safe for displaying on screen or in a log file.

          * @param name the name of the parameter

          * @param value the parameter value

          * @return the parameter value if the parameter is non-secret, or a replacement if the parameter is secret

          */

         public static String getDisplaySafeValue(String name, String value) {

             String safeValue = value;

             List<String> l = Arrays.asList(PUBLIC_KEYS);

         for (String[] secretKey : SECRET_KEYS) {

             if (name.contains(secretKey[0]) && !l.contains(name)) {

                 safeValue = secretKey[1];

                 break;

             }   

         }

         return safeValue;

         }

         /**

          * Returns a Map of configuration paramters that have display-safe values.  This allows for the suppression

          * of sensitive configuration paramters from being displayed (i.e. passwords).

          */

         public static Map<String, String> getDisplaySafeConfig(Map properties) {

                 Map<String, String> parameters = new HashMap<String, String>();

                 for (Iterator iter = properties.entrySet().iterator(); iter.hasNext();) {

                         Map.Entry property = (Map.Entry) iter.next();

                         String key = (String) property.getKey();

                         String value = (String) property.getValue();

                         String safeValue = getDisplaySafeValue(key, value);

                         parameters.put(key, safeValue);

                 }

                 return parameters;

         }

 }