/**
    * This file Copyright (c) 2016-2018 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.config.registry;
  
  import static java.util.stream.Collectors.toList;
  
  import info.magnolia.config.registry.DefinitionProvider.Problem;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.EnumMap;
  import java.util.List;
  import java.util.Map;
  import java.util.function.Function;
  import java.util.stream.Collectors;
  import java.util.stream.Stream;
  
  import org.slf4j.Logger;
  
  /**
   * Takes a {@link DefinitionProvider} instance and prints its problems to the log. Severe problems are always logged, whereas major and minor ones
   * are only printed if {@code isInDeveloperMode} is set to {@code true}, otherwise only the amounts are printed.
   *
   * Note: this class is for internal use only and is a subject to change at any time!
   */
  public final class DefinitionProviderProblemLogger {
  
      public static DefinitionProviderProblemLogger withLoggingContext(Logger log, boolean isInDeveloperMode) {
          return new DefinitionProviderProblemLogger(log, isInDeveloperMode);
      }
  
      private final Logger log;
      private final boolean isInDeveloperMode;
  
      DefinitionProviderProblemLogger(Logger log, boolean isInDeveloperMode) {
          this.log = log;
          this.isInDeveloperMode = isInDeveloperMode;
      }
  
      public <T> void logProblems(DefinitionProvider<T> definitionProvider) {
  
          final Map<Problem.SeverityType, List<Problem>> problemsByType = definitionProvider
                  .getProblems()
                  .stream()
                  .collect(Collectors.groupingBy(Problem::getSeverityType, () -> new EnumMap<>(Problem.SeverityType.class), toList()));
  
          final Function<Problem.SeverityType, List<Problem>> emptyProblemListFunction = problemType -> new ArrayList<>();
          final List<Problem> severeProblems = problemsByType.computeIfAbsent(Problem.SeverityType.SEVERE, emptyProblemListFunction);
          if (!severeProblems.isEmpty()) {
              log.error("{} severe problems have been encountered:", severeProblems.size());
              severeProblems.forEach(problem -> log.error(problem.toString(), problem.getRelatedException()));
          }
  
          final Collection<Problem> majorProblems = problemsByType.computeIfAbsent(Problem.SeverityType.MAJOR, emptyProblemListFunction);
          final Collection<Problem> minorProblems = problemsByType.computeIfAbsent(Problem.SeverityType.MINOR, emptyProblemListFunction);
  
          if (!majorProblems.isEmpty() || !minorProblems.isEmpty()) {
              log.warn("{} major and {} minor problems have been encountered", majorProblems.size(), minorProblems.size());
              if (!isInDeveloperMode) {
                  Stream.concat(majorProblems.stream(), minorProblems.stream()).map(Problem::toString).forEach(log::warn);
              }
          }
      }
  }