package fr.ifremer.quadrige2.core.config;
   
   /*-
    * #%L
    * Quadrige2 Core :: Quadrige2 Core Shared
    * $Id:$
    * $HeadURL:$
    * %%
    * Copyright (C) 2017 Ifremer
   * %%
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Affero General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  
  
  
  import com.google.common.collect.Lists;
  import fr.ifremer.quadrige2.core.dao.technical.Quadrige2EnumerationDef;
  import org.apache.commons.io.IOUtils;
  import org.apache.commons.lang3.ArrayUtils;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.nuiton.config.ApplicationConfig;
  import org.nuiton.util.RecursiveProperties;
  import org.reflections.Reflections;
  import org.springframework.core.io.Resource;
  
  import java.io.IOException;
  import java.io.InputStreamReader;
  import java.nio.charset.StandardCharsets;
  import java.util.List;
  import java.util.Properties;
  import java.util.Set;
  
  /**
   * Classe utilitaire pour vérifier que les valeurs d'énumération sont correctement configurées.
   *
   * @author Lionel Touseau <lionel.touseau@e-is.pro>
   */
  public class Quadrige2EnumerationHelper {
      
      /**
       * Logger.
       */
      private static final Log log = LogFactory.getLog(Quadrige2EnumerationHelper.class);
  
      private static final String MODEL_PACKAGE_NAME = "fr.ifremer.quadrige2.core.dao";
  
      private static List<Quadrige2EnumerationDef<?>> cachedModelEnumsAsConfigOptions = null;
  
      /**
       * <p>getAllModelEnumerations.</p>
       *
       * @return a {@link java.util.List} object.
       */
      @SuppressWarnings("rawtypes")
      public static List<Quadrige2EnumerationDef<?>> getAllModelEnumerations() {
          if (cachedModelEnumsAsConfigOptions != null) {
              return cachedModelEnumsAsConfigOptions;
          }
  
          // Retrieve enumerations classes used in quadrige2
          Reflections reflections = Reflections.collect();
          if (reflections == null) {
              reflections = new Reflections(MODEL_PACKAGE_NAME);
          }
          Set<Class<? extends Quadrige2EnumerationDef>> enumerationClasses
              = reflections.getSubTypesOf(Quadrige2EnumerationDef.class);
          if (log.isDebugEnabled()) {
              log.debug(String.format("%s enumeration classes detected in package [%s]", enumerationClasses.size(), MODEL_PACKAGE_NAME));
          }
  
          List<Quadrige2EnumerationDef<?>> options = Lists.newArrayList();
          for (Class<? extends Quadrige2EnumerationDef> enumClass : enumerationClasses) {
              Quadrige2EnumerationDef<?>[] enums = enumClass.getEnumConstants();
              if (ArrayUtils.isEmpty(enums)) {
                  log.warn(String.format("Enumeration class [%s] has no value. Skipped.", enumClass.getName()));
              }
              else {
                  for (Quadrige2EnumerationDef<?> aEnum : enums) {
                      Quadrige2EnumerationDef<?> configOption = (Quadrige2EnumerationDef<?>) aEnum;
                      options.add(configOption);
                  }
              }
          }
  
          cachedModelEnumsAsConfigOptions = options;
          if (log.isDebugEnabled()) {
             log.debug(String.format("%s enumeration values detected in package [%s]", options.size(), MODEL_PACKAGE_NAME));
         }
 
         return cachedModelEnumsAsConfigOptions;
     }
 
     /**
      * <p>reload.</p>
      *
      * @param applicationConfig a {@link org.nuiton.config.ApplicationConfig} object.
      * @param resources a {@link java.util.List} object.
      */
     @SuppressWarnings({"rawtypes", "unchecked"})
     public static void reload(ApplicationConfig applicationConfig, List<org.springframework.core.io.Resource> resources) {
 
         Properties enumerationProperties = new RecursiveProperties();
         if (log.isDebugEnabled()) {
             log.debug(String.format("Starting to load enumeration values..."));
         }
 
         for (Resource resource : resources) {
             InputStreamReader isr = null;
             try {
                 if (log.isDebugEnabled()) {
                     log.debug("Load enumeration file: "
                         + resource.getURI().toString());
                 }
                 isr = new InputStreamReader(resource.getInputStream(), StandardCharsets.UTF_8);
                 enumerationProperties.load(isr);
             } catch (IOException e) {
                 log.warn(String.format("Could not load enumeration file: %s. File skipped.", resource.getFilename()));
             } finally {
                 IOUtils.closeQuietly(isr);
             }
         }
 
         // Set each property as a default option for enumeration
         for (Object key : enumerationProperties.keySet()) {
             String value = enumerationProperties.getProperty((String) key);
             applicationConfig.setDefaultOption(Quadrige2EnumerationDef.CONFIG_OPTION_PREFIX + (String) key, value);
             if (log.isTraceEnabled()) {
                 log.trace(String.format(" %s%s (%s)", Quadrige2EnumerationDef.CONFIG_OPTION_PREFIX, (String) key, value));
             }
         }
 
         // Refresh enumeration values
         List<Quadrige2EnumerationDef<?>> modelOptions = getAllModelEnumerations();
         for (Quadrige2EnumerationDef enumDef : modelOptions) {
             Class clazz = enumDef.getType();
             String key = enumDef.getKey();
             String stringValue = applicationConfig.getOption(key);
 
             Object value = applicationConfig.getOption(clazz, key);
             if (value != null
                 && !enumDef.getValue().equals(value)) {
 
                 // Check for conversion error
                 if (!stringValue.equals(value.toString())) {
                     log.warn(String.format("Incompatible value '%s' for property '%s' (%s expected): Value skipped.", stringValue, key, enumDef.getType().getSimpleName()));
                 }
                 else {
                     Object oldValue = enumDef.getValue();
                     try {
                         enumDef.setValue(value);
                     } catch (ClassCastException cce) {
                         log.warn(String.format("Could not set %s with value %s", key, value));
                     }
                     if (log.isTraceEnabled()) {
                         log.trace(String.format(" %s (%s -> %s)", key, oldValue, value));
                     }
                 }
             }
         }
     }
     
 }