CheckErrorAlgorithm033.java

/*
 *  WPCleaner: A tool to help on Wikipedia maintenance tasks.
 *  Copyright (C) 2013  Nicolas Vervelle
 *
 *  See README.txt file for licensing information.
 */

package org.wikipediacleaner.api.check.algorithm;

import java.util.Collection;
import java.util.List;
import java.util.Map;

import org.wikipediacleaner.api.check.CheckErrorResult;
import org.wikipediacleaner.api.constants.WPCConfiguration;
import org.wikipediacleaner.api.data.PageAnalysis;
import org.wikipediacleaner.api.data.PageElementTag;
import org.wikipediacleaner.i18n.GT;


/**
 * Algorithm for analyzing error 33 of check wikipedia project.
 * Error 33: HTML text style element <u>
 */
public class CheckErrorAlgorithm033 extends CheckErrorAlgorithmBase {

  public CheckErrorAlgorithm033() {
    super("HTML text style element <u>");
  }

  /**
   * Analyze a page to check if errors are present.
   * 
   * @param analysis Page analysis.
   * @param errors Errors found in the page.
   * @param onlyAutomatic True if analysis could be restricted to errors automatically fixed.
   * @return Flag indicating if the error was found.
   */
  @Override
  public boolean analyze(
      PageAnalysis analysis,
      Collection<CheckErrorResult> errors, boolean onlyAutomatic) {
    if (analysis == null) {
      return false;
    }

    // List of templates for replacement
    List<String> replacements = null;
    String tmp = getSpecificProperty("templates", true, true, false);
    if (tmp != null) {
      replacements = WPCConfiguration.convertPropertyToStringList(tmp);
    }

    // Analyze each tag
    boolean result = false;
    Collection<PageElementTag> tags = analysis.getTags(PageElementTag.TAG_HTML_U);
    String contents = analysis.getContents();
    for (PageElementTag tag : tags) {
      boolean shouldCount = true;

      // Only take the first tag in a pair
      if (shouldCount) {
        if (!tag.isFullTag() && tag.isEndTag() && tag.isComplete()) {
          shouldCount = false;
        }
      }

      // Check that error should be reported
      if (shouldCount) {
        int index = tag.getBeginIndex();
        if ((analysis.getSurroundingTag(PageElementTag.TAG_WIKI_NOWIKI, index) != null) ||
            (analysis.getSurroundingTag(PageElementTag.TAG_WIKI_PRE, index) != null) ||
            (analysis.getSurroundingTag(PageElementTag.TAG_WIKI_SOURCE, index) != null) ||
            (analysis.getSurroundingTag(PageElementTag.TAG_WIKI_SYNTAXHIGHLIGHT, index) != null)) {
          shouldCount = false;
        }
      }

      // Report error
      if (shouldCount) {
        if (errors == null) {
          return true;
        }
        result = true;
        CheckErrorResult errorResult = createCheckErrorResult(
            analysis,
            tag.getCompleteBeginIndex(), tag.getCompleteEndIndex());
        if (tag.isFullTag()) {
          errorResult.addReplacement("");
        } else if (tag.isComplete()) {
          String value = contents.substring(tag.getValueBeginIndex(), tag.getValueEndIndex());
          errorResult.addReplacement(value);
          if (replacements != null) {
            for (String replacement : replacements) {
              errorResult.addReplacement("{{" + replacement + "|" + value + "}}");
            }
          }
          errorResult.addReplacement("''" + value + "''");
          errorResult.addReplacement("'''" + value + "'''");
        }
        errors.add(errorResult);
      }
    }
    return result;
  }

  /**
   * Return the parameters used to configure the algorithm.
   * 
   * @return Map of parameters (Name -> description).
   */
  @Override
  public Map<String, String> getParameters() {
    Map<String, String> parameters = super.getParameters();
    parameters.put(
        "templates",
        GT._("Templates that can be used to replace {0} tags", "<u>"));
    return parameters;
  }
}