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 org.hammurapi.InspectorBase;
026:
027: import com.pavelvlasov.config.ConfigurationException;
028: import com.pavelvlasov.config.Parameterizable;
029: import com.pavelvlasov.jsel.JselException;
030: import com.pavelvlasov.jsel.JselRuntimeException;
031: import com.pavelvlasov.jsel.LanguageElement;
032: import com.pavelvlasov.jsel.OperationInfo;
033: import com.pavelvlasov.jsel.expressions.MethodCall;
034: import com.pavelvlasov.jsel.statements.Handler;
035: import com.pavelvlasov.review.SourceMarker;
036: import com.pavelvlasov.util.Visitor;
037:
038: /**
039: * ER-120
040: * Catch-blocks should log the exeption with Log4J.fatal( "Context String" , exception )
041: * @author Pavel Vlasov
042: * @version $Revision: 1.6 $
043: */
044: public class LogExceptionsRule extends InspectorBase implements
045: Parameterizable {
046:
047: /**
048: * Reviews the exception handlers if they violate against the rule
049: *
050: * @param handler the exception handler
051: */
052: public void visit(Handler handler) {
053: class LoggedException extends com.pavelvlasov.RuntimeException {
054:
055: /**
056: * Comment for <code>serialVersionUID</code>
057: */
058: private static final long serialVersionUID = -1481467503705295388L;
059:
060: }
061: ;
062:
063: try {
064: handler.accept(new Visitor() {
065: public boolean visit(Object target) {
066: if (target instanceof MethodCall) {
067: MethodCall mc = (MethodCall) target;
068: try {
069: OperationInfo operationInfo = mc
070: .getProvider();
071: if (operationInfo == null) {
072: context
073: .warn(
074: (SourceMarker) mc,
075: "Provider is null for "
076: + mc
077: + " at "
078: + ((LanguageElement) mc)
079: .getLocation());
080: } else if (loggerMethods
081: .contains(operationInfo.getName())
082: && operationInfo.getDeclaringType()
083: .isKindOf(loggerClass)
084: && operationInfo
085: .getParameterTypes().length > 1) {
086: throw new LoggedException();
087: }
088: } catch (JselException e) {
089: context.warn((SourceMarker) mc, e);
090: } catch (JselRuntimeException e) {
091: context.warn((SourceMarker) mc, e);
092: }
093: }
094: return true;
095: }
096: });
097: context.reportViolation((SourceMarker) handler);
098: } catch (LoggedException e) {
099: // OK exception has been logged
100: }
101: }
102:
103: /**
104: * Stores the setting form the configuration for the type of the logger class
105: */
106: private String loggerClass;
107:
108: /**
109: * Stores the setting form the configuration for the logger class methods
110: */
111: private java.util.Set loggerMethods = new java.util.HashSet();
112:
113: /**
114: * Configures the rule. Reads in the values of the parameters logger_class and
115: * logger_method.
116: *
117: * @param name the name of the parameter being loaded from Hammurapi configuration
118: * @param value the value of the parameter being loaded from Hammurapi configuration
119: * @exception ConfigurationException in case of a not supported parameter
120: */
121: public boolean setParameter(String name, Object value)
122: throws ConfigurationException {
123: if ("logger_class".equals(name)) {
124: loggerClass = value.toString();
125: } else if ("logger_method".equals(name)) {
126: loggerMethods.add(value.toString());
127: } else {
128: throw new ConfigurationException("Parameter '" + name
129: + "' is not supported");
130: }
131: return true;
132: }
133:
134: /**
135: * Gives back the preconfigured values.
136: */
137: public String getConfigInfo() {
138: StringBuffer ret = new StringBuffer("Used logger class: "
139: + loggerClass + "\n");
140: java.util.Iterator iter = loggerMethods.iterator();
141: while (iter.hasNext()) {
142: ret.append("operation: " + iter.next().toString() + "\t");
143: }
144: ret.append("\n");
145: return ret.toString();
146: }
147: }
|