[mirror_edk2.git] / Tools / Java / Source / GenBuild / org / tianocore / build / global / GenBuildLogger.java

/*++\r
\r
 Copyright (c) 2006, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
\r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
 Module Name:\r
 GenBuildLogger.java\r
\r
 Abstract:\r
\r
 --*/\r
\r
package org.tianocore.build.global;\r
\r
import java.io.BufferedReader;\r
import java.io.BufferedWriter;\r
import java.io.File;\r
import java.io.FileWriter;\r
import java.io.IOException;\r
import java.io.StringReader;\r
import java.util.Iterator;\r
import java.util.LinkedHashMap;\r
import java.util.List;\r
import java.util.Map;\r
import java.util.Vector;\r
\r
import org.apache.tools.ant.BuildEvent;\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.DefaultLogger;\r
import org.apache.tools.ant.Project;\r
import org.apache.tools.ant.Task;\r
import org.apache.tools.ant.util.StringUtils;\r
\r
import org.tianocore.build.id.FpdModuleIdentification;\r
import org.tianocore.common.logger.EdkLog;\r
import org.tianocore.common.logger.LogMethod;\r
\r
public class GenBuildLogger extends DefaultLogger implements LogMethod {\r
    \r
    Project project = null;\r
	///\r
    /// Time of the start of the build \r
	/// \r
    private long startTime = System.currentTimeMillis();\r
    ///\r
    /// flag to present whether cache all msg or not\r
    /// true means to cache.\r
    ///\r
    private static boolean flag = false;\r
    \r
    private static boolean enableFlag = true;\r
\r
    private static Map<FpdModuleIdentification, List<String>> map = new LinkedHashMap<FpdModuleIdentification, List<String> >(256);\r
    \r
    private FpdModuleIdentification id = null;\r
    \r
    public GenBuildLogger () {\r
        \r
    }\r
\r
    public GenBuildLogger (Project project) {\r
        this.project = project;\r
    }\r
\r
    /**\r
      Rules: flag = false: means no cache Action: Print it to console\r
      \r
      flag = true: mean cache all msg exception some special Action: loglevel\r
      is EDK_ALWAYS -- Print but no cache loglevel is EDK_ERROR -- Print and\r
      cache the msg others -- No print and cache the msg\r
    **/\r
    public synchronized void putMessage(Object msgSource, int msgLevel, String msg) {\r
        if (this.project == null) {\r
            return;\r
        }\r
        //\r
        // If msgLevel is always print, then print it\r
        //\r
        switch (msgLevel) {\r
        case EdkLog.EDK_ALWAYS:\r
            //\r
            // Do some special\r
            //\r
            log(msgSource, msg, Project.MSG_ERR);\r
            break;\r
        case EdkLog.EDK_ERROR:\r
            log(msgSource, msg, Project.MSG_ERR);\r
            break;\r
        case EdkLog.EDK_WARNING:\r
            log(msgSource, msg, Project.MSG_WARN);\r
            break;\r
        case EdkLog.EDK_INFO:\r
            log(msgSource, msg, Project.MSG_INFO);\r
            break;\r
		case EdkLog.EDK_VERBOSE:\r
            log(msgSource, msg, Project.MSG_VERBOSE);\r
            break;\r
        case EdkLog.EDK_DEBUG:\r
            log(msgSource, msg, Project.MSG_DEBUG);\r
            break;\r
        }\r
    }\r
    \r
    public static void flushErrorModuleLog(FpdModuleIdentification errorModuleId) {\r
        List<String> errorLogs = map.get(errorModuleId);\r
        if (errorLogs != null) {\r
            EdkLog.log("ErrorLog", EdkLog.EDK_ERROR, errorModuleId + " error logs: ");\r
            for(int i = 0; i < errorLogs.size(); i++) {\r
                EdkLog.log(EdkLog.EDK_ERROR, errorLogs.get(i));\r
            }\r
        }\r
    }\r
\r
    public void flushToFile(File file) {\r
        //\r
        // Put all messages in map to file\r
        //\r
        String msg = "Writing log to file [" + file.getPath() + "]";\r
        log("Logging", msg, Project.MSG_INFO);\r
        try {\r
            BufferedWriter bw = new BufferedWriter(new FileWriter(file));\r
            Iterator<FpdModuleIdentification> iter = map.keySet().iterator();\r
            List<String> mainLogs = null;\r
            while (iter.hasNext()) {\r
                FpdModuleIdentification item = iter.next();\r
                if(item == null) {\r
                    mainLogs = map.get(item);\r
                    continue ;\r
                }\r
                bw.write(">>>>>>>>>>>>>");\r
                bw.write(" " + item + " Build Log ");\r
                bw.write(">>>>>>>>>>>>>");\r
                bw.newLine();\r
                List<String> allMessages = map.get(item);\r
                for(int i = 0; i < allMessages.size(); i++) {\r
                    bw.write(allMessages.get(i));\r
                    bw.newLine();\r
                }\r
            }\r
            if (mainLogs != null) {\r
                bw.write(">>>>>>>>>>>>>");\r
                bw.write(" Main Logs (already print to command) ");\r
                bw.write(">>>>>>>>>>>>>");\r
                bw.newLine();\r
                for(int i = 0; i < mainLogs.size(); i++) {\r
                    bw.write(mainLogs.get(i));\r
                    bw.newLine();\r
                }\r
            }\r
            bw.flush();\r
            bw.close();\r
        } catch (IOException e) {\r
            new BuildException("Writing log error. " + e.getMessage());\r
        }\r
        \r
    }\r
    \r
    private void log(Object msgSource, String msg, int level) {\r
        if (msgSource instanceof Task) {\r
            ((Task)msgSource).getProject().log((Task)msgSource, msg, level);\r
        } else if (msgSource instanceof String){\r
            //\r
            // Pad 12 space to keep message in unify format\r
            //\r
            msg = msg.replaceAll("\n", "\n            ");\r
            this.project.log(String.format("%12s", "[" + msgSource + "] ") + msg, level);\r
        } else {\r
            this.project.log(msg, level);\r
        }\r
    }\r
    public void targetStarted(BuildEvent event) {\r
        if (!flag) {\r
            super.targetStarted(event);\r
        }\r
    }\r
    \r
    public void messageLogged(BuildEvent event) {\r
		int currentLevel = event.getPriority();\r
        //\r
        // If current level is upper than Ant Level, skip it\r
        //\r
        if (currentLevel <= this.msgOutputLevel) {\r
            String originalMessage = event.getMessage();\r
\r
            StringBuffer message = new StringBuffer();\r
            if (!emacsMode && event.getTask() != null) {\r
                String label = String.format("%12s", "[" + event.getTask().getTaskName() + "] ");\r
                //\r
                // Append label first\r
                //\r
                message.append(label);\r
                \r
                //\r
                // Format all output message's line separator\r
                //\r
                try {\r
                    BufferedReader r = new BufferedReader(new StringReader(originalMessage));\r
                    boolean ifFirstLine = true;\r
                    String line = null;\r
                    while ((line = r.readLine()) != null) {\r
                        if (!ifFirstLine) {\r
                            message.append(StringUtils.LINE_SEP);\r
                        }\r
                        ifFirstLine = false;\r
                        message.append(line);\r
                    }\r
                } catch (IOException e) {\r
                    message.append(originalMessage);\r
                }\r
            } else {\r
                message.append(originalMessage);\r
            }\r
\r
            String msg = message.toString();\r
            if (currentLevel == Project.MSG_ERR) {\r
                printMessage(msg, err, currentLevel);\r
            } else if(currentLevel == Project.MSG_WARN) {\r
                printMessage(msg, out, currentLevel);\r
            } else if(!flag) {\r
                printMessage(msg, out, currentLevel);\r
            } \r
            log(msg);\r
        }\r
    }\r
    \r
    public static void setCacheEnable(boolean enable) {\r
        flag = enable;\r
    }\r
    \r
    public static void maskAllLog(boolean enable) {\r
        enableFlag = !enable;\r
    }\r
    \r
    protected synchronized void log(String message) {\r
        //\r
        // cache log\r
        //\r
        if (map.containsKey(this.id)) {\r
            map.get(this.id).add(message);\r
        } else {\r
            List<String> list = new Vector<String>(1024);\r
            list.add(message);\r
            map.put(this.id, list);\r
        }\r
    }\r
    \r
    public Object clone() {\r
        GenBuildLogger newLogger = new GenBuildLogger();\r
        //\r
        // Transfer emacs mode, out, err, level to new Logger\r
        //\r
        newLogger.setEmacsMode(this.emacsMode);\r
        newLogger.setOutputPrintStream(this.out);\r
        newLogger.setErrorPrintStream(this.err);\r
        newLogger.setMessageOutputLevel(this.msgOutputLevel);\r
        \r
        //\r
        // Transfer project\r
        //\r
        newLogger.project = this.project;\r
        return newLogger;\r
    }\r
\r
    public void setId(FpdModuleIdentification id) {\r
        this.id = id;\r
    }\r
\r
    public void buildFinished(BuildEvent event) {\r
        Throwable error = event.getException();\r
        StringBuffer message = new StringBuffer();\r
\r
        if (error == null) {\r
            message.append(StringUtils.LINE_SEP);\r
            message.append("BUILD SUCCESSFUL");\r
        } else {\r
            message.append(StringUtils.LINE_SEP);\r
            message.append("BUILD FAILED");\r
            message.append(StringUtils.LINE_SEP);\r
\r
            if (Project.MSG_DEBUG <= msgOutputLevel\r
                || !(error instanceof BuildException)) {\r
                message.append(StringUtils.getStackTrace(error));\r
            } else {\r
                if (error instanceof BuildException) {\r
                    message.append(error.toString()).append(lSep);\r
                } else {\r
                    message.append(error.getMessage()).append(lSep);\r
                }\r
            }\r
        }\r
        message.append(StringUtils.LINE_SEP);\r
        message.append("Total time: ");\r
        message.append(formatTime(System.currentTimeMillis() - startTime));\r
\r
        String msg = message.toString();\r
        if (error == null) {\r
            printMessage(msg, out, Project.MSG_VERBOSE);\r
        } else {\r
            printMessage(msg, err, Project.MSG_ERR);\r
        }\r
        log(msg);\r
    }\r
}
Commit	Line	Data
b9546cc8	1	/*++\r
b9546cc8	2	\r
c8df018e	3	Copyright (c) 2006, Intel Corporation\r
	4	All rights reserved. This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
b9546cc8	8	\r
c8df018e	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
c8df018e	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
b9546cc8	11	\r
c8df018e	12	Module Name:\r
c8df018e	13	GenBuildLogger.java\r
b9546cc8	14	\r
c8df018e	15	Abstract:\r
b9546cc8	16	\r
c8df018e	17	--*/\r
b9546cc8	18	\r
b9546cc8	19	package org.tianocore.build.global;\r
ff225cbb	20	\r
2eb7d78d	21	import java.io.BufferedReader;\r
2eb7d78d	22	import java.io.BufferedWriter;\r
c8df018e	23	import java.io.File;\r
2eb7d78d	24	import java.io.FileWriter;\r
	25	import java.io.IOException;\r
	26	import java.io.StringReader;\r
498e9021	27	import java.util.Iterator;\r
498e9021	28	import java.util.LinkedHashMap;\r
c8df018e	29	import java.util.List;\r
2eb7d78d	30	import java.util.Map;\r
c8df018e	31	import java.util.Vector;\r
c8df018e	32	\r
2eb7d78d	33	import org.apache.tools.ant.BuildEvent;\r
	34	import org.apache.tools.ant.BuildException;\r
	35	import org.apache.tools.ant.DefaultLogger;\r
b9546cc8	36	import org.apache.tools.ant.Project;\r
91f7d582	37	import org.apache.tools.ant.Task;\r
2eb7d78d	38	import org.apache.tools.ant.util.StringUtils;\r
ff225cbb	39	\r
498e9021	40	import org.tianocore.build.id.FpdModuleIdentification;\r
c8df018e	41	import org.tianocore.common.logger.EdkLog;\r
ff225cbb	42	import org.tianocore.common.logger.LogMethod;\r
b9546cc8	43	\r
2eb7d78d	44	public class GenBuildLogger extends DefaultLogger implements LogMethod {\r
2eb7d78d	45	\r
498e9021	46	Project project = null;\r
a06a5417	47	///\r
	48	/// Time of the start of the build \r
	49	/// \r
	50	private long startTime = System.currentTimeMillis();\r
c8df018e	51	///\r
c8df018e	52	/// flag to present whether cache all msg or not\r
2eb7d78d	53	/// true means to cache.\r
c8df018e	54	///\r
2eb7d78d	55	private static boolean flag = false;\r
3067c4b0	56	\r
3067c4b0	57	private static boolean enableFlag = true;\r
c8df018e	58	\r
498e9021	59	private static Map<FpdModuleIdentification, List<String>> map = new LinkedHashMap<FpdModuleIdentification, List<String> >(256);\r
2eb7d78d	60	\r
498e9021	61	private FpdModuleIdentification id = null;\r
2eb7d78d	62	\r
	63	public GenBuildLogger () {\r
	64	\r
	65	}\r
c8df018e	66	\r
	67	public GenBuildLogger (Project project) {\r
	68	this.project = project;\r
	69	}\r
	70	\r
c8df018e	71	/**\r
2eb7d78d	72	Rules: flag = false: means no cache Action: Print it to console\r
c8df018e	73	\r
2eb7d78d	74	flag = true: mean cache all msg exception some special Action: loglevel\r
c8df018e	75	is EDK_ALWAYS -- Print but no cache loglevel is EDK_ERROR -- Print and\r
	76	cache the msg others -- No print and cache the msg\r
	77	**/\r
2eb7d78d	78	public synchronized void putMessage(Object msgSource, int msgLevel, String msg) {\r
c8df018e	79	if (this.project == null) {\r
	80	return;\r
	81	}\r
c8df018e	82	//\r
	83	// If msgLevel is always print, then print it\r
	84	//\r
	85	switch (msgLevel) {\r
	86	case EdkLog.EDK_ALWAYS:\r
2eb7d78d	87	//\r
	88	// Do some special\r
	89	//\r
	90	log(msgSource, msg, Project.MSG_ERR);\r
c8df018e	91	break;\r
c8df018e	92	case EdkLog.EDK_ERROR:\r
2eb7d78d	93	log(msgSource, msg, Project.MSG_ERR);\r
c8df018e	94	break;\r
c8df018e	95	case EdkLog.EDK_WARNING:\r
2eb7d78d	96	log(msgSource, msg, Project.MSG_WARN);\r
c8df018e	97	break;\r
c8df018e	98	case EdkLog.EDK_INFO:\r
2eb7d78d	99	log(msgSource, msg, Project.MSG_INFO);\r
c8df018e	100	break;\r
a06a5417	101	case EdkLog.EDK_VERBOSE:\r
2eb7d78d	102	log(msgSource, msg, Project.MSG_VERBOSE);\r
c8df018e	103	break;\r
c8df018e	104	case EdkLog.EDK_DEBUG:\r
2eb7d78d	105	log(msgSource, msg, Project.MSG_DEBUG);\r
c8df018e	106	break;\r
b9546cc8	107	}\r
c8df018e	108	}\r
498e9021	109	\r
	110	public static void flushErrorModuleLog(FpdModuleIdentification errorModuleId) {\r
	111	List<String> errorLogs = map.get(errorModuleId);\r
	112	if (errorLogs != null) {\r
	113	EdkLog.log("ErrorLog", EdkLog.EDK_ERROR, errorModuleId + " error logs: ");\r
	114	for(int i = 0; i < errorLogs.size(); i++) {\r
	115	EdkLog.log(EdkLog.EDK_ERROR, errorLogs.get(i));\r
	116	}\r
	117	}\r
	118	}\r
c8df018e	119	\r
	120	public void flushToFile(File file) {\r
	121	//\r
2eb7d78d	122	// Put all messages in map to file\r
c8df018e	123	//\r
2eb7d78d	124	String msg = "Writing log to file [" + file.getPath() + "]";\r
	125	log("Logging", msg, Project.MSG_INFO);\r
	126	try {\r
	127	BufferedWriter bw = new BufferedWriter(new FileWriter(file));\r
498e9021	128	Iterator<FpdModuleIdentification> iter = map.keySet().iterator();\r
	129	List<String> mainLogs = null;\r
	130	while (iter.hasNext()) {\r
	131	FpdModuleIdentification item = iter.next();\r
	132	if(item == null) {\r
	133	mainLogs = map.get(item);\r
	134	continue ;\r
	135	}\r
	136	bw.write(">>>>>>>>>>>>>");\r
	137	bw.write(" " + item + " Build Log ");\r
	138	bw.write(">>>>>>>>>>>>>");\r
	139	bw.newLine();\r
	140	List<String> allMessages = map.get(item);\r
	141	for(int i = 0; i < allMessages.size(); i++) {\r
	142	bw.write(allMessages.get(i));\r
	143	bw.newLine();\r
	144	}\r
	145	}\r
	146	if (mainLogs != null) {\r
	147	bw.write(">>>>>>>>>>>>>");\r
	148	bw.write(" Main Logs (already print to command) ");\r
	149	bw.write(">>>>>>>>>>>>>");\r
2eb7d78d	150	bw.newLine();\r
498e9021	151	for(int i = 0; i < mainLogs.size(); i++) {\r
	152	bw.write(mainLogs.get(i));\r
	153	bw.newLine();\r
	154	}\r
2eb7d78d	155	}\r
	156	bw.flush();\r
	157	bw.close();\r
	158	} catch (IOException e) {\r
	159	new BuildException("Writing log error. " + e.getMessage());\r
	160	}\r
	161	\r
b9546cc8	162	}\r
91f7d582	163	\r
	164	private void log(Object msgSource, String msg, int level) {\r
	165	if (msgSource instanceof Task) {\r
d965d1f6	166	((Task)msgSource).getProject().log((Task)msgSource, msg, level);\r
2619585a	167	} else if (msgSource instanceof String){\r
2619585a	168	//\r
2eb7d78d	169	// Pad 12 space to keep message in unify format\r
2619585a	170	//\r
	171	msg = msg.replaceAll("\n", "\n ");\r
	172	this.project.log(String.format("%12s", "[" + msgSource + "] ") + msg, level);\r
91f7d582	173	} else {\r
	174	this.project.log(msg, level);\r
	175	}\r
	176	}\r
2eb7d78d	177	public void targetStarted(BuildEvent event) {\r
	178	if (!flag) {\r
	179	super.targetStarted(event);\r
	180	}\r
	181	}\r
	182	\r
	183	public void messageLogged(BuildEvent event) {\r
a06a5417	184	int currentLevel = event.getPriority();\r
2eb7d78d	185	//\r
	186	// If current level is upper than Ant Level, skip it\r
	187	//\r
	188	if (currentLevel <= this.msgOutputLevel) {\r
	189	String originalMessage = event.getMessage();\r
	190	\r
	191	StringBuffer message = new StringBuffer();\r
	192	if (!emacsMode && event.getTask() != null) {\r
	193	String label = String.format("%12s", "[" + event.getTask().getTaskName() + "] ");\r
	194	//\r
	195	// Append label first\r
	196	//\r
	197	message.append(label);\r
	198	\r
	199	//\r
	200	// Format all output message's line separator\r
	201	//\r
	202	try {\r
	203	BufferedReader r = new BufferedReader(new StringReader(originalMessage));\r
	204	boolean ifFirstLine = true;\r
	205	String line = null;\r
	206	while ((line = r.readLine()) != null) {\r
	207	if (!ifFirstLine) {\r
	208	message.append(StringUtils.LINE_SEP);\r
	209	}\r
	210	ifFirstLine = false;\r
	211	message.append(line);\r
	212	}\r
	213	} catch (IOException e) {\r
	214	message.append(originalMessage);\r
	215	}\r
	216	} else {\r
	217	message.append(originalMessage);\r
	218	}\r
	219	\r
	220	String msg = message.toString();\r
	221	if (currentLevel == Project.MSG_ERR) {\r
	222	printMessage(msg, err, currentLevel);\r
	223	} else if(currentLevel == Project.MSG_WARN) {\r
	224	printMessage(msg, out, currentLevel);\r
	225	} else if(!flag) {\r
	226	printMessage(msg, out, currentLevel);\r
	227	} \r
2eb7d78d	228	log(msg);\r
	229	}\r
	230	}\r
	231	\r
	232	public static void setCacheEnable(boolean enable) {\r
	233	flag = enable;\r
	234	}\r
	235	\r
3067c4b0	236	public static void maskAllLog(boolean enable) {\r
	237	enableFlag = !enable;\r
	238	}\r
	239	\r
2eb7d78d	240	protected synchronized void log(String message) {\r
	241	//\r
	242	// cache log\r
	243	//\r
	244	if (map.containsKey(this.id)) {\r
	245	map.get(this.id).add(message);\r
	246	} else {\r
	247	List<String> list = new Vector<String>(1024);\r
	248	list.add(message);\r
	249	map.put(this.id, list);\r
	250	}\r
	251	}\r
498e9021	252	\r
	253	public Object clone() {\r
	254	GenBuildLogger newLogger = new GenBuildLogger();\r
	255	//\r
	256	// Transfer emacs mode, out, err, level to new Logger\r
	257	//\r
	258	newLogger.setEmacsMode(this.emacsMode);\r
	259	newLogger.setOutputPrintStream(this.out);\r
	260	newLogger.setErrorPrintStream(this.err);\r
	261	newLogger.setMessageOutputLevel(this.msgOutputLevel);\r
	262	\r
	263	//\r
	264	// Transfer project\r
	265	//\r
	266	newLogger.project = this.project;\r
	267	return newLogger;\r
	268	}\r
	269	\r
	270	public void setId(FpdModuleIdentification id) {\r
	271	this.id = id;\r
	272	}\r
a06a5417	273	\r
	274	public void buildFinished(BuildEvent event) {\r
	275	Throwable error = event.getException();\r
	276	StringBuffer message = new StringBuffer();\r
	277	\r
	278	if (error == null) {\r
	279	message.append(StringUtils.LINE_SEP);\r
	280	message.append("BUILD SUCCESSFUL");\r
	281	} else {\r
	282	message.append(StringUtils.LINE_SEP);\r
	283	message.append("BUILD FAILED");\r
	284	message.append(StringUtils.LINE_SEP);\r
	285	\r
	286	if (Project.MSG_DEBUG <= msgOutputLevel\r
	287	\|\| !(error instanceof BuildException)) {\r
	288	message.append(StringUtils.getStackTrace(error));\r
	289	} else {\r
	290	if (error instanceof BuildException) {\r
	291	message.append(error.toString()).append(lSep);\r
	292	} else {\r
	293	message.append(error.getMessage()).append(lSep);\r
	294	}\r
	295	}\r
	296	}\r
	297	message.append(StringUtils.LINE_SEP);\r
	298	message.append("Total time: ");\r
	299	message.append(formatTime(System.currentTimeMillis() - startTime));\r
	300	\r
	301	String msg = message.toString();\r
	302	if (error == null) {\r
	303	printMessage(msg, out, Project.MSG_VERBOSE);\r
	304	} else {\r
	305	printMessage(msg, err, Project.MSG_ERR);\r
	306	}\r
	307	log(msg);\r
	308	}\r
b9546cc8	309	}