", label, " ", totalTime, "ms (+", elapsedTime, ") ", localTime, ": ", "
", sourceAndDetail, ":
", msg, "
"] : ["", label, " ", totalTime, "ms (+", elapsedTime, ") ", localTime, ": ", sourceAndDetail, ": ", msg,"
"]; return output.join(""); }; /** * Converts input chars "<", ">", and "&" to HTML entities. * * @method html2Text * @param sHtml {String} String to convert. * @private */ YAHOO.widget.LogReader.prototype.html2Text = function(sHtml) { if(sHtml) { sHtml += ""; return sHtml.replace(/&/g, "&").replace(//g, ">"); } return ""; }; ///////////////////////////////////////////////////////////////////////////// // // Private member variables // ///////////////////////////////////////////////////////////////////////////// /** * Internal class member to index multiple log reader instances. * * @property _memberName * @static * @type Number * @default 0 * @private */ YAHOO.widget.LogReader._index = 0; /** * Name of LogReader instance. * * @property _sName * @type String * @private */ YAHOO.widget.LogReader.prototype._sName = null; /** * A class member shared by all log readers if a container needs to be * created during instantiation. Will be null if a container element never needs to * be created on the fly, such as when the implementer passes in their own element. * * @property _elDefaultContainer * @type HTMLElement * @private */ YAHOO.widget.LogReader._elDefaultContainer = null; /** * Buffer of log message objects for batch output. * * @property _buffer * @type Object[] * @private */ YAHOO.widget.LogReader.prototype._buffer = null; /** * Number of log messages output to console. * * @property _consoleMsgCount * @type Number * @default 0 * @private */ YAHOO.widget.LogReader.prototype._consoleMsgCount = 0; /** * Date of last output log message. * * @property _lastTime * @type Date * @private */ YAHOO.widget.LogReader.prototype._lastTime = null; /** * Batched output timeout ID. * * @property _timeout * @type Number * @private */ YAHOO.widget.LogReader.prototype._timeout = null; /** * Array of filters for log message categories. * * @property _categoryFilters * @type String[] * @private */ YAHOO.widget.LogReader.prototype._categoryFilters = null; /** * Array of filters for log message sources. * * @property _sourceFilters * @type String[] * @private */ YAHOO.widget.LogReader.prototype._sourceFilters = null; /** * Log reader container element. * * @property _elContainer * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._elContainer = null; /** * Log reader header element. * * @property _elHd * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._elHd = null; /** * Log reader collapse element. * * @property _elCollapse * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._elCollapse = null; /** * Log reader collapse button element. * * @property _btnCollapse * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._btnCollapse = null; /** * Log reader title header element. * * @property _title * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._title = null; /** * Log reader console element. * * @property _elConsole * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._elConsole = null; /** * Log reader footer element. * * @property _elFt * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._elFt = null; /** * Log reader buttons container element. * * @property _elBtns * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._elBtns = null; /** * Container element for log reader category filter checkboxes. * * @property _elCategoryFilters * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._elCategoryFilters = null; /** * Container element for log reader source filter checkboxes. * * @property _elSourceFilters * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._elSourceFilters = null; /** * Log reader pause button element. * * @property _btnPause * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._btnPause = null; /** * Clear button element. * * @property _btnClear * @type HTMLElement * @private */ YAHOO.widget.LogReader.prototype._btnClear = null; ///////////////////////////////////////////////////////////////////////////// // // Private methods // ///////////////////////////////////////////////////////////////////////////// /** * Creates the UI for a category filter in the log reader footer element. * * @method _createCategoryCheckbox * @param sCategory {String} Category name. * @private */ YAHOO.widget.LogReader.prototype._createCategoryCheckbox = function(sCategory) { var oSelf = this; if(this._elFt) { var elParent = this._elCategoryFilters; var filters = this._categoryFilters; var elFilter = elParent.appendChild(document.createElement("span")); elFilter.className = "yui-log-filtergrp"; // Append el at the end so IE 5.5 can set "type" attribute // and THEN set checked property var chkCategory = document.createElement("input"); chkCategory.id = "yui-log-filter-" + sCategory + this._sName; chkCategory.className = "yui-log-filter-" + sCategory; chkCategory.type = "checkbox"; chkCategory.category = sCategory; chkCategory = elFilter.appendChild(chkCategory); chkCategory.checked = true; // Add this checked filter to the internal array of filters filters.push(sCategory); // Subscribe to the click event YAHOO.util.Event.addListener(chkCategory,'click',oSelf._onCheckCategory,oSelf); // Create and class the text label var lblCategory = elFilter.appendChild(document.createElement("label")); lblCategory.htmlFor = chkCategory.id; lblCategory.className = sCategory; lblCategory.innerHTML = sCategory; } }; /** * Creates a checkbox in the log reader footer element to filter by source. * * @method _createSourceCheckbox * @param sSource {String} Source name. * @private */ YAHOO.widget.LogReader.prototype._createSourceCheckbox = function(sSource) { var oSelf = this; if(this._elFt) { var elParent = this._elSourceFilters; var filters = this._sourceFilters; var elFilter = elParent.appendChild(document.createElement("span")); elFilter.className = "yui-log-filtergrp"; // Append el at the end so IE 5.5 can set "type" attribute // and THEN set checked property var chkSource = document.createElement("input"); chkSource.id = "yui-log-filter" + sSource + this._sName; chkSource.className = "yui-log-filter" + sSource; chkSource.type = "checkbox"; chkSource.source = sSource; chkSource = elFilter.appendChild(chkSource); chkSource.checked = true; // Add this checked filter to the internal array of filters filters.push(sSource); // Subscribe to the click event YAHOO.util.Event.addListener(chkSource,'click',oSelf._onCheckSource,oSelf); // Create and class the text label var lblSource = elFilter.appendChild(document.createElement("label")); lblSource.htmlFor = chkSource.id; lblSource.className = sSource; lblSource.innerHTML = sSource; } }; /** * Reprints all log messages in the stack through filters. * * @method _filterLogs * @private */ YAHOO.widget.LogReader.prototype._filterLogs = function() { // Reprint stack with new filters if (this._elConsole !== null) { this._clearConsole(); this._printToConsole(YAHOO.widget.Logger.getStack()); } }; /** * Clears all outputted log messages from the console and resets the time of the * last output log message. * * @method _clearConsole * @private */ YAHOO.widget.LogReader.prototype._clearConsole = function() { // Clear the buffer of any pending messages this._timeout = null; this._buffer = []; this._consoleMsgCount = 0; // Reset the rolling timer this._lastTime = YAHOO.widget.Logger.getStartTime(); var elConsole = this._elConsole; while(elConsole.hasChildNodes()) { elConsole.removeChild(elConsole.firstChild); } }; /** * Sends buffer of log messages to output and clears buffer. * * @method _printBuffer * @private */ YAHOO.widget.LogReader.prototype._printBuffer = function() { this._timeout = null; if(this._elConsole !== null) { var thresholdMax = this.thresholdMax; thresholdMax = (thresholdMax && !isNaN(thresholdMax)) ? thresholdMax : 500; if(this._consoleMsgCount < thresholdMax) { var entries = []; for (var i=0; i tag (for wrapping)
var container = (this.verboseOutput) ? "CODE" : "PRE";
var oNewElement = (this.newestOnTop) ?
this._elConsole.insertBefore(
document.createElement(container),this._elConsole.firstChild):
this._elConsole.appendChild(document.createElement(container));
oNewElement.innerHTML = output;
this._consoleMsgCount++;
this._lastTime = entry.time.getTime();
}
}
};
/////////////////////////////////////////////////////////////////////////////
//
// Private event handlers
//
/////////////////////////////////////////////////////////////////////////////
/**
* Handles Logger's categoryCreateEvent.
*
* @method _onCategoryCreate
* @param sType {String} The event.
* @param aArgs {Object[]} Data passed from event firer.
* @param oSelf {Object} The LogReader instance.
* @private
*/
YAHOO.widget.LogReader.prototype._onCategoryCreate = function(sType, aArgs, oSelf) {
var category = aArgs[0];
if(oSelf._elFt) {
oSelf._createCategoryCheckbox(category);
}
};
/**
* Handles Logger's sourceCreateEvent.
*
* @method _onSourceCreate
* @param sType {String} The event.
* @param aArgs {Object[]} Data passed from event firer.
* @param oSelf {Object} The LogReader instance.
* @private
*/
YAHOO.widget.LogReader.prototype._onSourceCreate = function(sType, aArgs, oSelf) {
var source = aArgs[0];
if(oSelf._elFt) {
oSelf._createSourceCheckbox(source);
}
};
/**
* Handles check events on the category filter checkboxes.
*
* @method _onCheckCategory
* @param v {HTMLEvent} The click event.
* @param oSelf {Object} The LogReader instance.
* @private
*/
YAHOO.widget.LogReader.prototype._onCheckCategory = function(v, oSelf) {
var newFilter = this.category;
var filtersArray = oSelf._categoryFilters;
if(!this.checked) { // Remove category from filters
for(var i=0; i 0) {
// Substring until first space
sClass = sSource.substring(0,spaceIndex);
// The rest of the source
sDetail = sSource.substring(spaceIndex,sSource.length);
}
else {
sClass = sSource;
}
if(this._isNewSource(sClass)) {
this._createNewSource(sClass);
}
}
var timestamp = new Date();
var logEntry = new YAHOO.widget.LogMsg({
msg: sMsg,
time: timestamp,
category: sCategory,
source: sClass,
sourceDetail: sDetail
});
var stack = this._stack;
var maxStackEntries = this.maxStackEntries;
if(maxStackEntries && !isNaN(maxStackEntries) &&
(stack.length >= maxStackEntries)) {
stack.shift();
}
stack.push(logEntry);
this.newLogEvent.fire(logEntry);
if(this._browserConsoleEnabled) {
this._printToBrowserConsole(logEntry);
}
return true;
}
else {
return false;
}
};
/**
* Resets internal stack and startTime, enables Logger, and fires logResetEvent.
*
* @method reset
*/
YAHOO.widget.Logger.reset = function() {
this._stack = [];
this._startTime = new Date().getTime();
this.loggerEnabled = true;
this.log("Logger reset");
this.logResetEvent.fire();
};
/**
* Public accessor to internal stack of log message objects.
*
* @method getStack
* @return {Object[]} Array of log message objects.
*/
YAHOO.widget.Logger.getStack = function() {
return this._stack;
};
/**
* Public accessor to internal start time.
*
* @method getStartTime
* @return {Date} Internal date of when Logger singleton was initialized.
*/
YAHOO.widget.Logger.getStartTime = function() {
return this._startTime;
};
/**
* Disables output to the browser's global console.log() function, which is used
* by the Firebug extension to Firefox as well as Safari.
*
* @method disableBrowserConsole
*/
YAHOO.widget.Logger.disableBrowserConsole = function() {
YAHOO.log("Logger output to the function console.log() has been disabled.");
this._browserConsoleEnabled = false;
};
/**
* Enables output to the browser's global console.log() function, which is used
* by the Firebug extension to Firefox as well as Safari.
*
* @method enableBrowserConsole
*/
YAHOO.widget.Logger.enableBrowserConsole = function() {
this._browserConsoleEnabled = true;
YAHOO.log("Logger output to the function console.log() has been enabled.");
};
/////////////////////////////////////////////////////////////////////////////
//
// Public events
//
/////////////////////////////////////////////////////////////////////////////
/**
* Fired when a new category has been created.
*
* @event categoryCreateEvent
* @param sCategory {String} Category name.
*/
YAHOO.widget.Logger.categoryCreateEvent =
new YAHOO.util.CustomEvent("categoryCreate", this, true);
/**
* Fired when a new source has been named.
*
* @event sourceCreateEvent
* @param sSource {String} Source name.
*/
YAHOO.widget.Logger.sourceCreateEvent =
new YAHOO.util.CustomEvent("sourceCreate", this, true);
/**
* Fired when a new log message has been created.
*
* @event newLogEvent
* @param sMsg {String} Log message.
*/
YAHOO.widget.Logger.newLogEvent = new YAHOO.util.CustomEvent("newLog", this, true);
/**
* Fired when the Logger has been reset has been created.
*
* @event logResetEvent
*/
YAHOO.widget.Logger.logResetEvent = new YAHOO.util.CustomEvent("logReset", this, true);
/////////////////////////////////////////////////////////////////////////////
//
// Private methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Creates a new category of log messages and fires categoryCreateEvent.
*
* @method _createNewCategory
* @param sCategory {String} Category name.
* @private
*/
YAHOO.widget.Logger._createNewCategory = function(sCategory) {
this.categories.push(sCategory);
this.categoryCreateEvent.fire(sCategory);
};
/**
* Checks to see if a category has already been created.
*
* @method _isNewCategory
* @param sCategory {String} Category name.
* @return {Boolean} Returns true if category is unknown, else returns false.
* @private
*/
YAHOO.widget.Logger._isNewCategory = function(sCategory) {
for(var i=0; i < this.categories.length; i++) {
if(sCategory == this.categories[i]) {
return false;
}
}
return true;
};
/**
* Creates a new source of log messages and fires sourceCreateEvent.
*
* @method _createNewSource
* @param sSource {String} Source name.
* @private
*/
YAHOO.widget.Logger._createNewSource = function(sSource) {
this.sources.push(sSource);
this.sourceCreateEvent.fire(sSource);
};
/**
* Checks to see if a source already exists.
*
* @method _isNewSource
* @param sSource {String} Source name.
* @return {Boolean} Returns true if source is unknown, else returns false.
* @private
*/
YAHOO.widget.Logger._isNewSource = function(sSource) {
if(sSource) {
for(var i=0; i < this.sources.length; i++) {
if(sSource == this.sources[i]) {
return false;
}
}
return true;
}
};
/**
* Outputs a log message to global console.log() function.
*
* @method _printToBrowserConsole
* @param oEntry {Object} Log entry object.
* @private
*/
YAHOO.widget.Logger._printToBrowserConsole = function(oEntry) {
if(window.console && console.log) {
var category = oEntry.category;
var label = oEntry.category.substring(0,4).toUpperCase();
var time = oEntry.time;
if (time.toLocaleTimeString) {
var localTime = time.toLocaleTimeString();
}
else {
localTime = time.toString();
}
var msecs = time.getTime();
var elapsedTime = (YAHOO.widget.Logger._lastTime) ?
(msecs - YAHOO.widget.Logger._lastTime) : 0;
YAHOO.widget.Logger._lastTime = msecs;
var output =
localTime + " (" +
elapsedTime + "ms): " +
oEntry.source + ": " +
oEntry.msg;
console.log(output);
}
};
/////////////////////////////////////////////////////////////////////////////
//
// Private event handlers
//
/////////////////////////////////////////////////////////////////////////////
/**
* Handles logging of messages due to window error events.
*
* @method _onWindowError
* @param sMsg {String} The error message.
* @param sUrl {String} URL of the error.
* @param sLine {String} Line number of the error.
* @private
*/
YAHOO.widget.Logger._onWindowError = function(sMsg,sUrl,sLine) {
// Logger is not in scope of this event handler
try {
YAHOO.widget.Logger.log(sMsg+' ('+sUrl+', line '+sLine+')', "window");
if(YAHOO.widget.Logger._origOnWindowError) {
YAHOO.widget.Logger._origOnWindowError();
}
}
catch(e) {
return false;
}
};
/////////////////////////////////////////////////////////////////////////////
//
// Enable handling of native JavaScript errors
// NB: Not all browsers support the window.onerror event
//
/////////////////////////////////////////////////////////////////////////////
if(window.onerror) {
// Save any previously defined handler to call
YAHOO.widget.Logger._origOnWindowError = window.onerror;
}
window.onerror = YAHOO.widget.Logger._onWindowError;
/////////////////////////////////////////////////////////////////////////////
//
// First log
//
/////////////////////////////////////////////////////////////////////////////
YAHOO.widget.Logger.log("Logger initialized");