Logger.java

/*******************************************************************************
 * Copyright (c) 2009, 2010 Sven Kiera
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/

package org.phpsrc.eclipse.pti.ui;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.ui.console.ConsolePlugin;
import org.eclipse.ui.console.IConsole;
import org.eclipse.ui.console.IConsoleManager;
import org.eclipse.ui.console.MessageConsole;
import org.eclipse.ui.console.MessageConsoleStream;
import org.osgi.framework.Bundle;
import org.phpsrc.eclipse.pti.core.PHPToolCorePlugin;

public class Logger {
	private static final String PLUGIN_ID = PHPToolCorePlugin.PLUGIN_ID; //$NON-NLS-1$

	private static final String CONSOLE_NAME = "PHP Tools Output";

	public static final int OK = IStatus.OK; // 0
	public static final int INFO = IStatus.INFO; // 1
	public static final int WARNING = IStatus.WARNING; // 2
	public static final int ERROR = IStatus.ERROR; // 4

	protected static void _log(int level, String message, Throwable exception) {
		int severity = IStatus.OK;
		switch (level) {
		case INFO:
			severity = IStatus.INFO;
			break;
		case WARNING:
			severity = IStatus.WARNING;
			break;
		case ERROR:
			severity = IStatus.ERROR;
		}

		message = (message != null) ? message : "null"; //$NON-NLS-1$
		Status statusObj = new Status(severity, PLUGIN_ID, severity, message, exception);
		Bundle bundle = Platform.getBundle(PLUGIN_ID);
		if (bundle != null)
			Platform.getLog(bundle).log(statusObj);
	}

	protected static void _trace(String message, Throwable exception) {
		message = (message != null) ? message : "null"; //$NON-NLS-1$
		Status statusObj = new Status(IStatus.OK, PLUGIN_ID, IStatus.OK, message, exception);
		Bundle bundle = Platform.getBundle(PLUGIN_ID);
		if (bundle != null)
			Platform.getLog(bundle).log(statusObj);
	}

	protected static void _logToConsole(String output, boolean toTop) {
		MessageConsole myConsole = findConsole(CONSOLE_NAME, toTop);

		MessageConsoleStream out = myConsole.newMessageStream();
		out.print(output);
	}

	public static void log(int level, String message) {
		_log(level, message, null);
	}

	public static void log(int level, String message, Throwable exception) {
		_log(level, message, exception);
	}

	public static void logException(Throwable exception) {
		_log(ERROR, exception.getMessage(), exception);
	}

	public static void logException(String message, Throwable exception) {
		_log(ERROR, message, exception);
	}

	public static void traceException(String message, Throwable exception) {
		_trace(message, exception);
	}

	public static void traceException(Throwable exception) {
		_trace(exception.getMessage(), exception);
	}

	public static void trace(String message) {
		_trace(message, null);
	}

	public static void logToConsole(String message) {
		logToConsole(message + "\n", false);
	}

	public static void logToConsole(String message, boolean toTop) {
		_logToConsole(message + "\n", toTop);
	}

	public static void logToConsoleWithoutBreak(String message) {
		_logToConsole(message, false);
	}

	private static MessageConsole findConsole(String name, boolean toTop) {
		ConsolePlugin plugin = ConsolePlugin.getDefault();
		IConsoleManager conMan = plugin.getConsoleManager();
		IConsole[] existing = conMan.getConsoles();

		MessageConsole myConsole = null;
		for (int i = 0; i < existing.length; i++) {
			if (name.equals(existing[i].getName())) {
				myConsole = (MessageConsole) existing[i];
				break;
			}
		}

		if (myConsole == null) {
			// no console found, so create a new one
			myConsole = new MessageConsole(name, PHPToolCorePlugin.getDefault().getImageRegistry().getDescriptor(
					PHPToolCorePlugin.IMG_PHPSRC));
			conMan.addConsoles(new IConsole[] { myConsole });
		}

		// if (toTop)
		// conMan.showConsoleView(myConsole);

		return myConsole;
	}
}