001: /*
002: * Hammurapi
003: * Automated Java code review system.
004: * Copyright (C) 2004 Hammurapi Group
005: *
006: * This program is free software; you can redistribute it and/or modify
007: * it under the terms of the GNU General Public License as published by
008: * the Free Software Foundation; either version 2 of the License, or
009: * (at your option) any later version.
010: *
011: * This program is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014: * GNU General Public License for more details.
015: *
016: * You should have received a copy of the GNU General Public License
017: * along with this program; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
019: *
020: * URL: http://www.hammurapi.org
021: * e-Mail: support@hammurapi.biz
022: */
023: package org.hammurapi.inspectors;
024:
025: import java.util.Stack;
026:
027: import org.hammurapi.InspectorBase;
028:
029: import com.pavelvlasov.jsel.JselException;
030: import com.pavelvlasov.jsel.LanguageElement;
031: import com.pavelvlasov.jsel.Parameter;
032: import com.pavelvlasov.jsel.expressions.Dot;
033: import com.pavelvlasov.jsel.expressions.Expression;
034: import com.pavelvlasov.jsel.expressions.Ident;
035: import com.pavelvlasov.jsel.expressions.MethodCall;
036: import com.pavelvlasov.jsel.statements.Handler;
037: import com.pavelvlasov.review.SourceMarker;
038:
039: /**
040: * ER-069
041: * Do not use printStackTrace(), use logger(<Message>, <exception>) instead.
042: * @author Janos Czako
043: * @version $Revision: 1.3 $
044: */
045: public class PrintStackTraceRule extends InspectorBase {
046:
047: private static final String PRINTSTACKTRACE_NAME = "printStackTrace(";
048:
049: /*
050: * This method can give a bad result only if a block exists inside a
051: * handler clause and this block hides the exception variable for the
052: * handler block.
053: */
054:
055: private ThreadLocal handlerStack = new ThreadLocal() {
056: protected Object initialValue() {
057: return new Stack();
058: }
059: };
060:
061: private Stack getHandlerStack() {
062: return (Stack) handlerStack.get();
063: }
064:
065: /**
066: * Reviews the try blocks, if they contain calls
067: * to the method printStackTrace
068: *
069: * @param element the try block to be reviewed.
070: */
071: public void visit(Handler element) {
072: getHandlerStack().push(element.getParameter());
073: }
074:
075: public void leave(Handler element) {
076: getHandlerStack().pop();
077: }
078:
079: public void visit(MethodCall methodCall) {
080: if (methodCall.getParameters().isEmpty()
081: || methodCall.getParameters().size() == 1) {
082: Stack stack = getHandlerStack();
083: if (!stack.isEmpty()) {
084: Parameter parameter = (Parameter) stack.peek();
085: // e.printStackTrace -> Dot
086: if (methodCall.getName() instanceof Dot) {
087: Expression lastOperand = (Expression) methodCall
088: .getName().getOperand(1);
089: if ((lastOperand instanceof Ident)
090: && PRINTSTACKTRACE_NAME
091: .equals(((Ident) lastOperand)
092: .getText())) {
093:
094: Expression firstOperand = (Expression) methodCall
095: .getName().getOperand(0);
096:
097: try {
098: if ((firstOperand instanceof Ident)
099: && ((LanguageElement) methodCall)
100: .getEnclosingScope()
101: .getVariableNamespace()
102: .find(
103: ((Ident) lastOperand)
104: .getText()) == parameter) {
105: context
106: .reportViolation((SourceMarker) methodCall);
107: }
108: } catch (JselException e) {
109: context.warn(parameter, e);
110: }
111: }
112: }
113: }
114: }
115: }
116:
117: /*
118: * This way works also in standard situations, but is not so correct,
119: * like the above implemented one.
120: */
121:
122: /******************************************************************
123: public void visit(MethodCall method) {
124: String methodName = method.getName().toString();
125: if ( methodName.indexOf(".printStackTrace")>0) {
126: context.reportViolation(method);
127: }
128: }
129: *******************************************************************/
130:
131: }
|