com.redfin.sitemapgenerator.SitemapValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sitemapgen4j Show documentation
SitemapGen4j is an XML sitemap generator written in Java.
The newest version!
package com.redfin.sitemapgenerator;

import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;

import javax.xml.XMLConstants;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;

import org.xml.sax.InputSource;
import org.xml.sax.SAXException;

/** Validates sitemaps and sitemap indexes
 * 
 * @author Dan Fabulich
 *
 */
public class SitemapValidator {
	
	//TODO support gzip
	//TODO confirm < 10MB
	//TODO confirm single host
	//TODO confirm correct host
	//TODO confirm UTF-8
	
	//TODO support Mobile/Geo/Video/Code/News (sitemap.xsd doesn't support them)
		//TODO confirm mobile restrictions: no non-mobile urls
		//TODO confirm news restrictions: 3 days, 1000 URLs
		//TODO video restrictions: title, player_loc/content_loc, no non-video urls
		//IMO news should have no non-news urls, geo should have no non-geo urls, code should have no non-code urls
	
	private static Schema sitemapSchema, sitemapIndexSchema;
	
	private synchronized static void lazyLoad() {
		if (sitemapSchema != null)  return;
		SchemaFactory factory =
            SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
		try {
			InputStream stream = SitemapValidator.class.getResourceAsStream("sitemap.xsd");
			if (stream == null) throw new RuntimeException("BUG Couldn't load sitemap.xsd");
			StreamSource source = new StreamSource(stream);
			sitemapSchema = factory.newSchema(source);
			
			stream = SitemapValidator.class.getResourceAsStream("siteindex.xsd");
			if (stream == null) throw new RuntimeException("BUG Couldn't load siteindex.xsd");
			source = new StreamSource(stream);
			sitemapIndexSchema = factory.newSchema(source);
		} catch (SAXException e) {
			throw new RuntimeException("BUG", e);
		}
	}
	
	/** Validates an ordinary web sitemap file (NOT a Google-specific sitemap) */
	public static void validateWebSitemap(File sitemap) throws SAXException {
		lazyLoad();
		validateXml(sitemap, sitemapSchema);
	}
	
	/** Validates a sitemap index file  */
	public static void validateSitemapIndex(File sitemap) throws SAXException {
		lazyLoad();
		validateXml(sitemap, sitemapIndexSchema);
	}

	private static void validateXml(File sitemap, Schema schema) throws SAXException {
		Validator validator = schema.newValidator();
		try {
			FileReader reader = new FileReader(sitemap);
			SAXSource source = new SAXSource(new InputSource(reader));
			validator.validate(source);
		} catch (IOException e) {
			throw new RuntimeException(e);
		}
	}

}