1 // Copyright 2000-2005 the Contributors, as shown in the revision logs.
2 // Licensed under the Apache Public Source License 2.0 ("the License").
3 // You may not use this file except in compliance with the License.
9 import java.io.BufferedReader;
10 import java.io.ByteArrayInputStream;
11 import java.io.ByteArrayOutputStream;
12 import java.io.PrintStream;
13 import java.io.PrintWriter;
14 import java.io.FileOutputStream;
15 import java.io.InputStreamReader;
16 import java.io.IOException;
17 import java.net.Socket;
18 import java.net.InetAddress;
19 import java.text.SimpleDateFormat;
21 // FEATURE: logging exceptions should automatically unwrap exceptions
23 /** Easy to use logger.
25 * @author adam@ibex.org
28 private static final SimpleDateFormat formatDate = new SimpleDateFormat("EEE dd MMM yyyy");
29 private static final SimpleDateFormat formatTime = new SimpleDateFormat("[EEE HH:mm:ss] ");
30 private static final Hashtable threadAnnotations = new Hashtable();
32 public static boolean on = System.getProperty("ibex.log.on", "true").equals("true");
33 public static boolean color = System.getProperty("ibex.log.color", "true").equals("true");
34 public static boolean verbose = System.getProperty("ibex.log.verbose", "false").equals("true");
35 public static boolean logDates = System.getProperty("ibex.log.dates", "false").equals("true");
36 public static boolean notes = System.getProperty("ibex.log.notes.on", "true").equals("true");
37 public static boolean stackTraces = System.getProperty("ibex.log.stackTraces", "true").equals("true");
38 public static int maximumNoteLength = Integer.parseInt(System.getProperty("ibex.log.notes.maximumLength", (1024 * 32)+""));
39 public static boolean rpc = false;
40 public static int lastDay = -1;
42 public static PrintStream logstream = System.err;
44 public static void flush() { logstream.flush(); }
45 public static void email(String address) { throw new Error("FIXME not supported"); }
46 public static void file(String filename) throws IOException {
48 logstream = new PrintStream(new FileOutputStream(filename));
50 public static void tcp(String host, int port) throws IOException {
52 logstream = new PrintStream(new Socket(InetAddress.getByName(host), port).getOutputStream());
55 public static void setThreadAnnotation(String s) { threadAnnotations.put(Thread.currentThread(), s); }
58 * Notes can be used to attach log messages to the current thread
59 * if you're not sure you want them in the log just yet.
60 * Originally designed for retroactively logging socket-level
61 * conversations only if an error is encountered
63 public static void note(String s) {
65 StringBuffer notebuf = notebuf();
67 if (notebuf.length() > maximumNoteLength) {
69 notebuf.setLength(maximumNoteLength * 3 / 4);
73 public static void clearnotes() { if (!notes) return; notebuf().setLength(0); }
75 private static final Basket.Map notebufs = new Basket.Hash();
76 public static StringBuffer notebuf() {
77 StringBuffer ret = (StringBuffer)notebufs.get(Thread.currentThread());
79 ret = new StringBuffer(16 * 1024);
80 notebufs.put(Thread.currentThread(), ret);
85 /** true iff nothing has yet been logged */
86 public static boolean firstMessage = true;
88 /** message can be a String or a Throwable */
89 public static synchronized void echo(Object o, Object message) { log(o, message, ECHO); }
90 public static synchronized void diag(Object o, Object message) { log(o, message, DIAGNOSTIC); }
91 public static synchronized void debug(Object o, Object message) { log(o, message, DEBUG); }
92 public static synchronized void info(Object o, Object message) { log(o, message, INFO); }
93 public static synchronized void warn(Object o, Object message) { log(o, message, WARN); }
94 public static synchronized void error(Object o, Object message) { log(o, message, ERROR); }
96 // these two logging levels serve ONLY to change the color; semantically they are the same as DEBUG
97 private static final int DIAGNOSTIC = -2;
98 private static final int ECHO = -1;
100 // the usual log4j levels, minus FAIL (we just throw an Error in that case)
101 public static final int DEBUG = 0;
102 public static final int INFO = 1;
103 public static final int WARN = 2;
104 public static final int ERROR = 3;
105 public static final int SILENT = Integer.MAX_VALUE;
106 public static int level = INFO;
108 private static final int BLUE = 34;
109 private static final int GREEN = 32;
110 private static final int CYAN = 36;
111 private static final int RED = 31;
112 private static final int PURPLE = 35;
113 private static final int BROWN = 33;
114 private static final int GRAY = 37;
116 private static String colorize(int color, boolean bright, String s) {
117 if (!Log.color) return s;
119 "\033[40;" + (bright?"1;":"") + color + "m" +
124 private static String lastClassName = null;
125 private static synchronized void log(Object o, Object message, int level) {
126 if (level < Log.level) return;
127 if (firstMessage && !logDates) {
128 firstMessage = false;
129 logstream.println(colorize(GREEN, false, "==========================================================================="));
131 // FIXME later: causes problems with method pruning
132 //diag(Log.class, "Logging enabled at " + new java.util.Date());
134 if (color) diag(Log.class, "logging messages in " +
135 colorize(BLUE, true, "c") +
136 colorize(RED, true, "o") +
137 colorize(CYAN, true, "l") +
138 colorize(GREEN, true, "o") +
139 colorize(PURPLE, true, "r"));
143 if (o == null) classname = "";
144 else if (o instanceof Class) {
145 classname = ((Class)o).getName();
146 if (classname.indexOf('.') != -1) classname = classname.substring(classname.lastIndexOf('.') + 1);
148 else if (o instanceof String) classname = (String)o;
149 else classname = o.getClass().getName();
151 if (classname.equals(lastClassName)) classname = "";
152 else lastClassName = classname;
154 if (classname.length() > (logDates ? 14 : 20)) classname = classname.substring(0, (logDates ? 14 : 20));
155 while (classname.length() < (logDates ? 14 : 20)) classname = " " + classname;
156 classname = classname + (classname.trim().length() == 0 ? " " : ": ");
157 classname = colorize(GRAY, true, classname);
158 classname = classname.replace('$', '.');
161 Calendar cal = Calendar.getInstance();
162 if (lastDay < 0 || lastDay != cal.get(Calendar.DAY_OF_YEAR)) {
163 lastDay = cal.get(Calendar.DAY_OF_YEAR);
164 String now = formatDate.format(cal.getTime());
166 logstream.println(colorize(GREEN, false, "=== " + now + " =========================================================="));
168 classname = formatTime.format(cal.getTime()) + classname;
171 String annot = (String)threadAnnotations.get(Thread.currentThread());
172 if (annot != null) classname += annot;
174 if (message instanceof Throwable) {
175 if (level < ERROR) level = WARN;
176 ByteArrayOutputStream baos = new ByteArrayOutputStream();
177 ((Throwable)message).printStackTrace(new PrintStream(baos));
178 if (notes && notebuf().length() > 0) {
179 PrintWriter pw = new PrintWriter(baos);
181 pw.println("Thread notes:");
182 pw.println(notebuf().toString());
186 byte[] b = baos.toByteArray();
187 BufferedReader br = new BufferedReader(new InputStreamReader(new ByteArrayInputStream(b)));
192 while((s = br.readLine()) != null) m += s + "\n";
193 if (m.length() > 0) log(o, m.substring(0, m.length() - 1), level);
195 String m = br.readLine();
198 String s = br.readLine();
199 if (s == null) break;
200 if (s.indexOf('(') != -1) {
201 String shortened = s.substring(s.indexOf('(')+1);
202 shortened = shortened.substring(0, shortened.indexOf(')'));
203 m += " " + shortened;
204 if (ok > 1) m = m.substring(0, Math.min(m.length(), 78));
207 } while (m.length() < 78);
211 } catch (IOException e) {
212 // FEATURE: use org.ibex.io.Stream's here
213 logstream.println(colorize(RED, true, "Logger: exception thrown by ByteArrayInputStream;" +
214 " this should not happen"));
219 String str = message.toString();
220 if (str.indexOf('\n') != -1) lastClassName = "";
221 while(str.indexOf('\t') != -1)
222 str = str.substring(0, str.indexOf('\t')) + " " + str.substring(str.indexOf('\t') + 1);
224 classname = colorize(GRAY, false, classname);
225 int levelcolor = GRAY;
226 boolean bright = true;
228 case DIAGNOSTIC: levelcolor = GREEN; bright = false; break;
229 case ECHO: levelcolor = BLUE; bright = true; break;
230 case DEBUG: levelcolor = BROWN; bright = true; break;
231 case INFO: levelcolor = GRAY; bright = false; break;
232 case WARN: levelcolor = BROWN; bright = false; break;
233 case ERROR: levelcolor = RED; bright = true; break;
236 while(str.indexOf('\n') != -1) {
237 logstream.println(classname + colorize(levelcolor, bright, str.substring(0, str.indexOf('\n'))));
238 classname = logDates ? " " : " ";
239 classname = colorize(GRAY,false,classname);
240 str = str.substring(str.indexOf('\n') + 1);
242 logstream.println(classname + colorize(levelcolor, bright, str));