/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-2015 The eXist Project
* http://exist-db.org
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.exist.xquery;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.exist.source.Source;
import org.exist.xquery.ErrorCodes.ErrorCode;
import org.exist.xquery.parser.XQueryAST;
import org.exist.xquery.value.Sequence;
/**
* Class for representing a generic XPath exception.
*/
public class XPathException extends Exception {
private static final long serialVersionUID = 212844692232650666L;
private int line = 0;
private int column = 0;
private ErrorCode errorCode = ErrorCodes.ERROR;
private String message = null;
private Sequence errorVal;
private List<FunctionStackElement> callStack = null;
private Source source = null;
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(String message) {
super();
this.message = message;
}
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(int line, int column, String message) {
super();
this.message = message;
this.line = line;
this.column = column;
}
public XPathException(ErrorCode errorCode, int line, int column) {
super();
this.errorCode = errorCode;
this.line = line;
this.column = column;
}
public XPathException(int line, int column, ErrorCode errorCode, String message) {
super();
this.errorCode = errorCode;
this.message = message;
this.line = line;
this.column = column;
}
/**
* @param expr XPath expression
* @param message Exception message
*
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(Expression expr, String message) {
super();
this.message = message;
this.line = expr.getLine();
this.column = expr.getColumn();
this.source = expr.getSource();
}
public XPathException(Expression expr, ErrorCode errorCode, String errorDesc) {
super();
this.errorCode = errorCode;
this.message = errorDesc;
this.line = expr.getLine();
this.column = expr.getColumn();
this.source = expr.getSource();
}
public XPathException(Expression expr, ErrorCode errorCode, String errorDesc, Sequence errorVal) {
super();
this.errorCode = errorCode;
this.message = errorDesc;
this.errorVal = errorVal;
this.line = expr.getLine();
this.column = expr.getColumn();
this.source = expr.getSource();
}
public XPathException(Expression expr, ErrorCode errorCode, Throwable cause) {
super(cause);
this.errorCode = errorCode;
this.message = cause.getMessage();
this.line = expr.getLine();
this.column = expr.getColumn();
this.source = expr.getSource();
}
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(XQueryAST ast, String message) {
super();
this.message = message;
if(ast != null) {
this.line = ast.getLine();
this.column = ast.getColumn();
}
}
public XPathException(XQueryAST ast, ErrorCode errorCode, String message) {
super();
this.errorCode=errorCode;
this.message = message;
if(ast != null) {
this.line = ast.getLine();
this.column = ast.getColumn();
}
}
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(Throwable cause) {
super(cause);
}
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(String message, Throwable cause) {
super(cause);
this.message = message;
}
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(Expression expr, Throwable cause) {
this(expr, ErrorCodes.ERROR, cause.getMessage(), null, cause);
}
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(Expression expr, String message, Throwable cause) {
this(expr, ErrorCodes.ERROR, message, null, cause);
}
public XPathException(Expression expr, ErrorCode errorCode, String errorDesc, Sequence errorVal, Throwable cause) {
this(expr.getLine(), expr.getColumn(), errorDesc, cause);
this.errorCode = errorCode;
this.errorVal = errorVal;
}
public XPathException(ErrorCode errorCode, String errorDesc, Sequence errorVal) {
this(errorCode, errorDesc);
this.errorVal = errorVal;
}
/**
* Constructor.
*
* @param errorCode Xquery errorcode
* @param errorDesc Error code. When Null the ErrorCode text will be used.
*
*/
public XPathException(ErrorCode errorCode, String errorDesc) {
this.errorCode = errorCode;
if(errorDesc == null){
this.message = errorCode.toString();
} else {
this.message = errorDesc;
}
}
public XPathException(ErrorCode errorCode, String errorDesc, Sequence errorVal, Throwable cause) {
this(errorCode, errorDesc, cause);
this.errorVal = errorVal;
}
public XPathException(ErrorCode errorCode, String errorDesc, Throwable cause) {
super(cause);
this.errorCode = errorCode;
if(errorDesc == null){
this.message = errorCode.toString();
} else {
this.message = errorDesc;
}
}
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
protected XPathException(int line, int column, String message, Throwable cause) {
super(cause);
this.message = message;
this.line = line;
this.column = column;
}
/**
* @deprecated Use a constructor with errorCode
*/
@Deprecated
public XPathException(int line, int column, Throwable cause) {
super(cause);
this.line = line;
this.column = column;
}
public void setLocation(int line, int column) {
this.line = line;
this.column = column;
}
public void setLocation(int line, int column, Source source) {
this.line = line;
this.column = column;
this.source = source;
}
public int getLine() {
return line;
}
public int getColumn() {
return column;
}
/**
* Get the xquery error code. Use getErroCode instead.
*
* @return The error code or ErrorCode#Error when not available.
*/
@Deprecated
public ErrorCode getCode() {
return errorCode;
}
public Source getSource() {
return source;
}
public void addFunctionCall(UserDefinedFunction def, Expression call) {
if(callStack == null) {
callStack = new ArrayList<>();
}
callStack.add(new FunctionStackElement(def, def.getSource().path(), call.getLine(), call.getColumn()));
}
public List<FunctionStackElement> getCallStack() {
return callStack;
}
public void prependMessage(String msg) {
message = msg + message;
}
public void prependMessage(ErrorCode errorCode, String msg) {
this.errorCode = errorCode;
message = msg + message;
}
/* (non-Javadoc)
* @see java.lang.Throwable#getMessage()
*/
@Override
public String getMessage() {
final StringBuilder buf = new StringBuilder();
if(message == null) {
message = "";
}
if(errorCode != null) {
buf.append(errorCode.getErrorQName()); //TODO consider also displaying the W3C message by calling errorCode.toString()
buf.append(" ");
if(message.isEmpty()) {
message = errorCode.getDescription();
}
}
buf.append(message);
// Append location details
if(getLine() > 0 || source != null) {
buf.append(" [");
if(getLine() > 0) {
buf.append("at line ");
buf.append(getLine());
buf.append(", column ");
buf.append(getColumn());
if(source != null) {
buf.append(", ");
}
}
if(source != null) {
buf.append("source: ").append(source.getKey());
}
buf.append("]");
}
// Append function stack trace
if(callStack != null) {
buf.append("\nIn function:\n");
for(final Iterator<FunctionStackElement> i = callStack.iterator(); i.hasNext();) {
final FunctionStackElement stack = i.next();
buf.append('\t').append(stack);
if(i.hasNext()) {
buf.append('\n');
}
}
}
return buf.toString();
}
/**
* Returns just the error message, not including
* line numbers or the call stack.
*
* @return error message
*/
public String getDetailMessage() {
return message;
}
public String getMessageAsHTML() {
final StringBuilder buf = new StringBuilder();
if (message == null) {
message = "";
}
message = message.replaceAll("\r?\n", "<br/>");
buf.append("<h2>").append(message);
if (getLine() > 0) {
buf.append(" [at line ");
buf.append(getLine());
buf.append(", column ");
buf.append(getColumn());
buf.append("]");
}
buf.append("</h2>");
if (callStack != null) {
buf.append("<table id=\"xquerytrace\">");
buf.append("<caption>XQuery Stack Trace</caption>");
for (final FunctionStackElement e : callStack) {
buf.append("<tr><td class=\"func\">").append(e.function).append("</td>");
buf.append("<td class=\"lineinfo\">").append(e.line).append(':').append(e.column).append("</td>");
buf.append("</tr>");
}
buf.append("</table>");
}
return buf.toString();
}
/**
* Get the xquery error code.
*
* @return The errorcode or ErrorCode#Error when not available.
*/
public ErrorCode getErrorCode() {
return errorCode;
}
/**
* Get the xquery error value.
*
* @return Error value as sequence
*/
public Sequence getErrorVal() {
return errorVal;
}
public static class FunctionStackElement {
private final String function;
private final String file;
private final int line;
private final int column;
public FunctionStackElement(UserDefinedFunction func, String file, int line, int column) {
this.function = func.toString();
this.file = file;
this.line = line;
this.column = column;
}
public int getColumn() {
return column;
}
public String getFile() {
return file;
}
public String getFunction() {
return function;
}
public int getLine() {
return line;
}
@Override
public String toString() {
return function + " [" + line + ":" + column + ":" + file + ']';
}
}
}