org.sonar.plugins.web.checks.sonar.PageWithoutTitleCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-web-plugin Show documentation
Enables scanning of HTML, and JSP/JSF files.
The newest version!
/*
 * SonarWeb :: SonarQube Plugin
 * Copyright (c) 2010-2018 SonarSource SA and Matthijs Galesloot
 * [email protected]
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.sonar.plugins.web.checks.sonar;

import org.sonar.check.Rule;
import org.sonar.plugins.web.checks.AbstractPageCheck;
import org.sonar.plugins.web.node.Node;
import org.sonar.plugins.web.node.TagNode;

import java.util.List;

@Rule(key = "PageWithoutTitleCheck")
public class PageWithoutTitleCheck extends AbstractPageCheck {

  private int currentHtmlTagLine;
  private int currentHeadTagLine;
  private boolean foundTitleTag;
  private boolean isReported;

  @Override
  public void startDocument(List nodes) {
    currentHtmlTagLine = 0;
    currentHeadTagLine = 0;
  }

  @Override
  public void startElement(TagNode node) {
    if (isHtmlTag(node)) {
      currentHtmlTagLine = node.getStartLinePosition();
      isReported = false;
      foundTitleTag = false;
    } else if (isHeadTag(node)) {
      currentHeadTagLine = node.getStartLinePosition();
      isReported = false;
      foundTitleTag = false;
    } else if (currentHeadTagLine != 0 && isTitleTag(node)) {
      foundTitleTag = true;
    }
  }

  @Override
  public void endElement(TagNode node) {
    int line = 0;

    if (isHtmlTag(node)) {
      line = currentHtmlTagLine;
      currentHtmlTagLine = 0;
      currentHeadTagLine = 0;
    } else if (isHeadTag(node)) {
      line = currentHeadTagLine;
      currentHeadTagLine = 0;
    }

    if (!foundTitleTag && line != 0 && !isReported) {
      createViolation(line, "Add a  tag to this page.");
      isReported = true;
    }
  }

  private static boolean isHtmlTag(TagNode node) {
    return "HTML".equalsIgnoreCase(node.getLocalName());
  }

  private static boolean isHeadTag(TagNode node) {
    return "HEAD".equalsIgnoreCase(node.getLocalName());
  }

  private static boolean isTitleTag(TagNode node) {
    return "TITLE".equalsIgnoreCase(node.getLocalName());
  }

}
</code></pre>    <br/>
    <br/>
<div class='clear'></div>
</main>
</div>
<br/><br/>
    <div class="align-center">© 2015 - 2024 <a href="/legal-notice.php">Weber Informatics LLC</a> | <a href="/data-protection.php">Privacy Policy</a></div>
<br/><br/><br/><br/><br/><br/>
</body>
</html>

<script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script>