org.structr.core.parser.function.EscapeJavascriptFunction.java Source code

Introduction

Here is the source code for org.structr.core.parser.function.EscapeJavascriptFunction.java

Source

/**
 * Copyright (C) 2010-2016 Structr GmbH
 *
 * This file is part of Structr <http://structr.org>.
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Structr.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.structr.core.parser.function;

import org.apache.commons.lang3.StringEscapeUtils;
import org.structr.common.error.FrameworkException;
import org.structr.core.GraphObject;
import org.structr.schema.action.ActionContext;
import org.structr.schema.action.Function;

/**
 *
 */
public class EscapeJavascriptFunction extends Function<Object, Object> {

    public static final String ERROR_MESSAGE_ESCAPE_JS = "Usage: ${escape_javascript(string)}. Example: ${escape_javascript(this.name)}";

    @Override
    public String getName() {
        return "escape_javascript()";
    }

    @Override
    public Object apply(final ActionContext ctx, final GraphObject entity, final Object[] sources)
            throws FrameworkException {

        return (arrayHasMinLengthAndAllElementsNotNull(sources, 1))
                ? StringEscapeUtils.escapeEcmaScript(sources[0].toString())
                : "";
    }

    @Override
    public String usage(boolean inJavaScriptContext) {
        return ERROR_MESSAGE_ESCAPE_JS;
    }

    @Override
    public String shortDescription() {
        return "Escapes the given string for use with Javascript";
    }

}