/**
* Adds a local function.
*
* @param fun function instance
* @param ii input info
* @return function id
* @throws QueryException query exception
*/
public int add(final UserFunc fun, final InputInfo ii) throws QueryException {
final QNm name = fun.name;
final byte[] uri = name.uri();
if (uri.length == 0) FUNNONS.thrw(ii, name.string());
if (NSGlobal.reserved(uri)) {
if (fun.declared) NAMERES.thrw(ii, name.string());
funError(name, ii);
}
final byte[] ln = name.local();
for (int l = 0; l < funcs.length; ++l) {
final QNm qn = funcs[l].name;
final byte[] u = qn.uri();
final byte[] nm = qn.local();
if (eq(ln, nm) && eq(uri, u) && fun.args.length == funcs[l].args.length) {
// declare function that has been called before
if (!funcs[l].declared) {
funcs[l] = fun;
return l;
}
// duplicate declaration
FUNCDEFINED.thrw(ii, fun.name.string());
}
}
// add function skeleton
funcs = Array.add(funcs, fun);
calls = Array.add(calls, new UserFuncCall[0]);
return funcs.length - 1;
}
/**
* Returns the specified function.
*
* @param name function qname
* @param args optional arguments
* @param ii input info
* @return function instance
* @throws QueryException query exception
*/
public StandardFunc get(final QNm name, final Expr[] args, final InputInfo ii)
throws QueryException {
final int id = id(name.id());
if (id == 0) return null;
// create function
final Function fl = funcs[id];
if (!eq(fl.uri(), name.uri())) return null;
final StandardFunc f = fl.get(ii, args);
// check number of arguments
if (args.length < fl.min || args.length > fl.max) XPARGS.thrw(ii, fl);
return f;
}
/**
* Throws an error if one of the pre-defined functions is similar to the specified function name.
*
* @param name function name
* @param ii input info
* @throws QueryException query exception
*/
public void error(final QNm name, final InputInfo ii) throws QueryException {
// compare specified name with names of predefined functions
final byte[] ln = name.local();
final Levenshtein ls = new Levenshtein();
for (int k = 1; k < size; ++k) {
final int i = indexOf(keys[k], '}');
final byte[] u = substring(keys[k], 2, i);
final byte[] l = substring(keys[k], i + 1);
if (eq(ln, l)) {
final byte[] ur = name.uri();
FUNSIMILAR.thrw(
ii,
new TokenBuilder(NSGlobal.prefix(ur)).add(':').add(l),
new TokenBuilder(NSGlobal.prefix(u)).add(':').add(l));
} else if (ls.similar(ln, l, 0)) {
FUNSIMILAR.thrw(ii, name.string(), l);
}
}
}
/**
* Returns a new Java function instance.
*
* @param name function name
* @param args arguments
* @param qc query context
* @param sc static context
* @param ii input info
* @return Java function or {@code null}
* @throws QueryException query exception
*/
static JavaMapping get(
final QNm name,
final Expr[] args,
final QueryContext qc,
final StaticContext sc,
final InputInfo ii)
throws QueryException {
final byte[] uri = name.uri();
// check if URI starts with "java:" prefix (if yes, module must be Java code)
final boolean java = startsWith(uri, JAVAPREF);
// rewrite function name: convert dashes to upper-case initials
final String local = camelCase(string(name.local()));
// check imported Java modules
final String path = camelCase(toPath(java ? substring(uri, JAVAPREF.length) : uri));
final ModuleLoader modules = qc.resources.modules();
final Object jm = modules.findImport(path);
if (jm != null) {
final Method meth = getModMethod(jm, path, local, args.length, qc, ii);
if (meth != null) return new JavaModuleFunc(sc, ii, jm, meth, args);
}
// only allowed with administrator permissions
if (!qc.context.user.has(Perm.ADMIN)) return null;
// check addressed class
try {
return new JavaFunc(sc, ii, modules.findClass(path), local, args);
} catch (final ClassNotFoundException ex) {
// only throw exception if "java:" prefix was explicitly specified
if (java) throw FUNCJAVA_X.get(ii, path);
} catch (final Throwable th) {
throw JAVAINIT_X.get(ii, th);
}
// no function found
return null;
}
/**
* Returns an instance of a with the specified name and number of arguments, or {@code null}.
*
* @param name name of the function
* @param args optional arguments
* @param dyn compile-/run-time flag
* @param ctx query context
* @param ii input info
* @return function instance
* @throws QueryException query exception
*/
public static TypedFunc get(
final QNm name,
final Expr[] args,
final boolean dyn,
final QueryContext ctx,
final InputInfo ii)
throws QueryException {
// get namespace and local name
// parse data type constructors
if (eq(name.uri(), XSURI)) {
final byte[] ln = name.local();
final AtomType type = AtomType.find(name, false);
if (type == null) {
final Levenshtein ls = new Levenshtein();
for (final AtomType t : AtomType.values()) {
if (t.par != null
&& t != AtomType.NOT
&& t != AtomType.AAT
&& t != AtomType.BIN
&& ls.similar(lc(ln), lc(t.string()), 0))
FUNSIMILAR.thrw(ii, name.string(), t.string());
}
}
// no constructor function found, or abstract type specified
if (type == null || type == AtomType.NOT || type == AtomType.AAT) {
FUNCUNKNOWN.thrw(ii, name.string());
}
if (args.length != 1) FUNCTYPE.thrw(ii, name.string());
final SeqType to = SeqType.get(type, Occ.ZERO_ONE);
return TypedFunc.constr(new Cast(ii, args[0], to), to);
}
// pre-defined functions
final StandardFunc fun = Functions.get().get(name, args, ii);
if (fun != null) {
if (!ctx.sc.xquery3 && fun.xquery3()) FEATURE30.thrw(ii);
for (final Function f : Function.UPDATING) {
if (fun.sig == f) {
ctx.updating(true);
break;
}
}
return new TypedFunc(fun, fun.sig.type(args.length));
}
// user-defined function
final TypedFunc tf = ctx.funcs.get(name, args, ii);
if (tf != null) return tf;
// Java function (only allowed with administrator permissions)
final JavaMapping jf = JavaMapping.get(name, args, ctx, ii);
if (jf != null) return TypedFunc.java(jf);
// add user-defined function that has not been declared yet
if (!dyn && FuncType.find(name) == null) return ctx.funcs.add(name, args, ii, ctx);
// no function found
return null;
}
@Override
public Item item(final QueryContext qc, final InputInfo ii) throws QueryException {
final ANode node = toEmptyNode(arg(0, qc), qc);
final QNm qname = node != null ? node.qname() : null;
return qname != null ? Uri.uri(qname.uri(), false) : Uri.EMPTY;
}
/**
* Returns the module namespace URI.
*
* @return URI
*/
public byte[] uri() {
return name.uri();
}
/**
* Checks a function for RESTFful annotations.
*
* @return {@code true} if module contains relevant annotations
* @throws QueryException query exception
*/
boolean analyze() throws QueryException {
// parse all annotations
final EnumSet<HTTPMethod> mth = EnumSet.noneOf(HTTPMethod.class);
final boolean[] declared = new boolean[function.args.length];
boolean found = false;
final int as = function.ann.size();
for (int a = 0; a < as; a++) {
final QNm name = function.ann.names[a];
final Value value = function.ann.values[a];
final byte[] local = name.local();
final byte[] uri = name.uri();
final boolean rexq = eq(uri, QueryText.RESTXQURI);
if (rexq) {
if (eq(PATH, local)) {
// annotation "path"
if (path != null) error(ANN_TWICE, "%", name.string());
path = new RestXqPath(toString(value, name));
for (final String s : path) {
if (s.trim().startsWith("{")) checkVariable(s, AtomType.AAT, declared);
}
} else if (eq(CONSUMES, local)) {
// annotation "consumes"
strings(value, name, consumes);
} else if (eq(PRODUCES, local)) {
// annotation "produces"
strings(value, name, produces);
} else if (eq(QUERY_PARAM, local)) {
// annotation "query-param"
queryParams.add(param(value, name, declared));
} else if (eq(FORM_PARAM, local)) {
// annotation "form-param"
formParams.add(param(value, name, declared));
} else if (eq(HEADER_PARAM, local)) {
// annotation "header-param"
headerParams.add(param(value, name, declared));
} else if (eq(COOKIE_PARAM, local)) {
// annotation "cookie-param"
cookieParams.add(param(value, name, declared));
} else {
// method annotations
final HTTPMethod m = HTTPMethod.get(string(local));
if (m == null) error(ANN_UNKNOWN, "%", name.string());
if (!value.isEmpty()) {
// remember post/put variable
if (requestBody != null) error(ANN_TWICE, "%", name.string());
if (m != POST && m != PUT) error(METHOD_VALUE, m);
requestBody = checkVariable(toString(value, name), declared);
}
if (mth.contains(m)) error(ANN_TWICE, "%", name.string());
mth.add(m);
}
} else if (eq(uri, QueryText.OUTPUTURI)) {
// serialization parameters
final String key = string(local);
final String val = toString(value, name);
if (output.get(key) == null) error(UNKNOWN_SER, key);
output.set(key, val);
}
found |= rexq;
}
if (!mth.isEmpty()) methods = mth;
if (found) {
if (path == null) error(ANN_MISSING, PATH);
for (int i = 0; i < declared.length; i++)
if (!declared[i]) error(VAR_UNDEFINED, function.args[i].name.string());
}
return found;
}