SitemapXmlCrawl.java

/**
 * Copyright (c) 2016-2017, Mihai Emil Andronache
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * * Neither the name of charles nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.amihaiemil.charles;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

import org.openqa.selenium.WebDriver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.amihaiemil.charles.sitemap.SitemapXml;
import com.amihaiemil.charles.sitemap.SitemapXmlLocation;
import com.amihaiemil.charles.sitemap.Url;

/**
 * Crawl a website based on the given sitemap xml.
 * @author Mihai Andronache (amihaiemil@gmail.com)
 */
public final class SitemapXmlCrawl extends AbstractWebCrawl {

    /**
     * Class logger.
     */
    private static final Logger LOG = LoggerFactory.getLogger(SitemapXmlCrawl.class);

    /**
     * URLs to be crawled.
     */
    private Set<Url> urlset;

    /**
     * Start a new sitemap.xml crawl using the specified driver.
     * @param drv Specified driver (e.g. chrome, firefox etc).
     * @param sitemapLoc Location of the sitemap.xml file.
     * @param repo Repository to export the pages to.
     * @throws IOException If something goes wrong.
     */
    public SitemapXmlCrawl(WebDriver drv, SitemapXmlLocation sitemapLoc, Repository repo) throws IOException {
        this(drv, sitemapLoc, new IgnoredPatterns(), repo, 20);
    }

    /**
     * Start a new sitemap.xml crawl using the specified driver.
     * @param drv Specified driver (e.g. chrome, firefox etc).
     * @param sitemapLoc Location of the sitemap.xml file.
     * @param repo Repository to export the pages to.
     * @param batch Size of the batch to export.
     * @throws IOException If something goes wrong.
     */
    public SitemapXmlCrawl(WebDriver drv, SitemapXmlLocation sitemapLoc, Repository repo, int batch) throws IOException {
        this(drv, sitemapLoc, new IgnoredPatterns(), repo, batch);
    }

    /**
     * Start a new sitemap.xml crawl using the specified driver.
     * @param drv Specified driver (e.g. chrome, firefox etc).
     * @param sitemapLoc Location of the sitemap.xml file.
     * @param ignored Patterns of the ignored pages.
     * @param repo Repository to export the pages to.
     * @throws IOException If something goes wrong.
     */
    public SitemapXmlCrawl(WebDriver drv, SitemapXmlLocation sitemapLoc, IgnoredPatterns ignored, Repository repo) throws IOException {
        this(drv, sitemapLoc, ignored, repo, 20);
    }

    /**
     * Start a new sitemap.xml crawl using the specified driver.
     * @param drv Specified driver (e.g. chrome, firefox etc).
     * @param sitemapLoc Location of the sitemap.xml file.
     * @param ignored Ignored pages patterns.
     * @param repo Repository where the crawled pages are exported.
     * @param batch Size of the batch to export.
     * @throws IOException If something goes wrong.
     */
    public SitemapXmlCrawl(
        WebDriver drv, SitemapXmlLocation sitemapLoc,
        IgnoredPatterns ignored, Repository repo, int batch
    ) throws IOException {
        super(drv, ignored, repo, batch);
        this.urlset = new SitemapXml(sitemapLoc.getStream()).read().getUrls();
    }

    @Override
    public void crawl() throws DataExportException {
        List<WebPage> pages = new ArrayList<WebPage>();
        LOG.info("Started crawling the sitemap.xml...");
        for(Url url : this.urlset) {
            if(this.ignoredPatterns().contains(url.getLoc())) {
                continue;
            }
            LOG.info("Crawling page " + url.getLoc() + "... ");
            this.driver().get(url.getLoc());
            pages.add(new LiveWebPage(this.driver()).snapshot());
            LOG.info("Done crawling page " + url.getLoc() + "!");
            if(pages.size() == this.batchSize()) {
                try {
                    this.repo().export(pages);
                    pages.clear();
                } catch (DataExportException e) {
                    e.printStackTrace();
                }
            }
        }
        LOG.info("Finished crawling the sitemap.xml!");
        this.repo().export(pages);
        this.driver().quit();
    }
    
}