com.googlecode.l10nmavenplugin.log.L10nValidatorLogger Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2012 Romain Quinio (http://code.google.com/p/l10n-maven-plugin)
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ******************************************************************************/
package com.googlecode.l10nmavenplugin.log;

import java.util.HashMap;
import java.util.Map;

import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugin.logging.SystemStreamLog;

import com.googlecode.l10nmavenplugin.model.L10nReportItem;
import com.googlecode.l10nmavenplugin.model.L10nReportItem.Severity;

/**
 * Basic logger that ensures consistency in logging.
 * 
 * Standard maven options apply: --quiet for ERROR level, -X for DEBUG.
 * 
 * @author romain.quinio
 * 
 */
public class L10nValidatorLogger {

  /**
   * Max number of time a given type id logged
   */
  protected static final int THRESOLD = 30;

  private Log logger;

  private final Map occurences = new HashMap();

  public L10nValidatorLogger() {
    this.logger = new SystemStreamLog();
  }

  public L10nValidatorLogger(Log logger) {
    this.logger = logger;
  }

  public void debug(String propertiesName, String key, String logMessage, String message, String formattedMessage) {
    this.logger.debug(buildLogMessage(propertiesName, key, logMessage, message, formattedMessage));
  }

  public void info(String propertiesName, String key, String logMessage, String message, String formattedMessage) {
    this.logger.info(buildLogMessage(propertiesName, key, logMessage, message, formattedMessage));
  }

  public void warn(String propertiesName, String key, String logMessage, String message, String formattedMessage) {
    this.logger.warn(buildLogMessage(propertiesName, key, logMessage, message, formattedMessage));
  }

  public void error(String propertiesName, String key, String logMessage, String message, String formattedMessage) {
    this.logger.error(buildLogMessage(propertiesName, key, logMessage, message, formattedMessage));
  }

  /**
   * Log an L10nReportItem, for progressive display of validation issues.
   * 
   * To avoid too long console I/O for bundles with many validation info/warn (> 5000), use a threshold after which the item of a given type are no longer
   * logged. Errors are always logged.
   * 
   * @param reportItem
   */
  public void log(L10nReportItem reportItem) {
    Integer nbLogged = occurences.get(reportItem.getItemType());
    if (nbLogged == null) {
      nbLogged = 1;
    } else {
      nbLogged++;
    }
    occurences.put(reportItem.getItemType(), nbLogged);

    if (nbLogged == THRESOLD + 1) {
      this.logger.warn("Info/Warn of type " + reportItem.getItemType() + " exceed the threshold, items will no more be logged.");
    }

    switch (reportItem.getItemSeverity()) {
    case INFO:
      if (nbLogged <= THRESOLD) {
        this.info(reportItem.getPropertiesName(), reportItem.getPropertiesKey(), reportItem.getItemMessage(), reportItem.getPropertiesValue(),
            reportItem.getFormattedPropertiesValue());
      }
      break;
    case WARN:
      if (nbLogged <= THRESOLD) {
        this.warn(reportItem.getPropertiesName(), reportItem.getPropertiesKey(), reportItem.getItemMessage(), reportItem.getPropertiesValue(),
            reportItem.getFormattedPropertiesValue());
      }
      break;
    default:
      // Report all errors
      this.error(reportItem.getPropertiesName(), reportItem.getPropertiesKey(), reportItem.getItemMessage(), reportItem.getPropertiesValue(),
          reportItem.getFormattedPropertiesValue());
      break;
    }
  }

  /**
   * Utility to log a general message based on severity.
   * 
   * @param severity
   * @param message
   */
  public void log(Severity severity, String message) {
    switch (severity) {
    case INFO:
      logger.info(message);
      break;
    case WARN:
      logger.warn(message);
      break;
    default:
      logger.error(message);
      break;
    }
  }

  /**
   * Log a property validation issue in a consistent way for all validators.
   * 
   * @param logLevel
   * @param propertiesName
   *          the applicable properties file(s) containing the property
   * @param key
   *          optional, the key of the property
   * @param logMessage
   *          the error message with detailed cause
   * @param message
   *          optional, the original property value that failed validation
   * @param formattedMessage
   *          optional, the altered property value actually used for validation, for instance with formatting parameters replaced
   */
  private String buildLogMessage(String propertiesName, String key, String logMessage, String message, String formattedMessage) {
    StringBuffer sb = new StringBuffer();
    sb.append("<").append(propertiesName).append(">");
    if (key != null) {
      sb.append("<").append(key).append(">");
    }
    sb.append(" ").append(logMessage).append("\n");
    if (message != null) {
      sb.append("Property value was:[").append(message).append("]").append("\n");
    }
    if (formattedMessage != null) {
      sb.append("Formatted value used for validation:[").append(formattedMessage).append("]").append("\n");
    }
    return sb.toString();
  }

  public Log getLogger() {
    return logger;
  }

  public void setLogger(Log logger) {
    this.logger = logger;
  }
}