org.webharvest.utils.SystemUtilities Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webharvest-core Show documentation
The newest version!
/*  Copyright (c) 2006-2007, Vladimir Nikic
    All rights reserved.

    Redistribution and use of this software 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.

    * The name of Web-Harvest may not 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 OWNER 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.

    You can contact Vladimir Nikic by sending e-mail to
    [email protected]. Please include the word "Web-Harvest" in the
    subject line.
*/
package org.webharvest.utils;

import org.webharvest.exception.BaseException;
import org.webharvest.exception.UserException;
import org.webharvest.runtime.DynamicScopeContext;
import org.webharvest.runtime.variables.NodeVariable;
import org.webharvest.runtime.variables.Variable;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * Collection of useful constants and functions that are available in each
 * scraper context.
 */
@SuppressWarnings({"UnusedDeclaration"})
public class SystemUtilities {

    public static final Variable lf = new NodeVariable("\n");
    public static final Variable tab = new NodeVariable("\t");
    public static final Variable cr = new NodeVariable("\r");
    public static final Variable space = new NodeVariable(" ");
    public static final Variable quot = new NodeVariable("\"");
    public static final Variable apos = new NodeVariable("\'");
    public static final Variable backspace = new NodeVariable("\b");

    private DynamicScopeContext context;

    public SystemUtilities(DynamicScopeContext context) {
        this.context = context;
    }

    /**
     * @param varName
     * @return True if scraper's context contain not-null variable with specified name.
     */
    public boolean isVariableDefined(String varName) {
        return context.getVar(varName) != null;
    }

    /**
     * Returns variable from scraper context
     *
     * @param varName Name of the variable
     */
    public Variable getVar(String varName) {
        return context.getVar(varName);
    }

    /**
     * Adds or/replaces variable in scraper's context. If overwrite is false
     * and variable with specified name already exists, it won't be updated.
     *
     * @param varName
     * @param varValue
     * @param overwrite
     */
    public void defineVariable(String varName, Object varValue, boolean overwrite) {
        if (overwrite || context.getVar(varName) == null) {
            context.setLocalVar(varName, CommonUtil.createVariable(varValue));
        }
    }

    /**
     * Adds or/replaces variable in scraper's context.
     *
     * @param varName
     * @param varValue
     */
    public void defineVariable(String varName, Object varValue) {
        defineVariable(varName, varValue, true);
    }

    /**
     * Returns formatted date/time for specified format string.
     *
     * @param format
     */
    public String datetime(Object format) {
        if (format != null) {
            SimpleDateFormat formatter = new SimpleDateFormat(format.toString());
            return formatter.format(new Date());
        }

        throw new BaseException("Cannot return datetime for null format!");
    }

    /**
     * Returns current date formatted as "yyyyMMdd".
     */
    public String date() {
        return datetime("yyyyMMdd");
    }

    /**
     *
     */
    public String time() {
        return datetime("HHmmss");
    }

    /**
     * Escapes XML string - special characters: &'"<> are
     * replaced with XML escape sequences: & ' " < >
     */
    public String escapeXml(Object s) {
        if (s != null) {
            return CommonUtil.escapeXml(s.toString());
        }

        throw new BaseException("Cannot escape XML for null argumant!");
    }

    /**
     * Calculates full URL for specified page URL and link
     * which could be full, absolute or relative like there can
     * be found in A or IMG tags.
     */
    public String fullUrl(Object pageUrl, Object link) {
        if (pageUrl != null && link != null) {
            return CommonUtil.fullUrl(pageUrl.toString(), link.toString());
        }

        throw new BaseException("Cannot make full url for null argumants!");
    }

    /**
     * @param path
     * @return Filename for the full path
     */
    public String getFilename(String path) {
        int index = Math.max(path.lastIndexOf("\\"), path.lastIndexOf("/"));
        return index >= 0 && index < path.length() - 1 ? path.substring(index + 1) : path;
    }

    public void error(String message) {
        throw new UserException(message);
    }

}