07e932e996dd1ceff082e84fc5832b404e203700
[moodle.git] / lib / amd / src / loglevel.js
1 // The MIT License
2 //
3 // Copyright (c) 2013 Tim Perry
4 //
5 // Permission is hereby granted, free of charge, to any person obtaining
6 // a copy of this software and associated documentation files (the
7 // "Software"), to deal in the Software without restriction, including
8 // without limitation the rights to use, copy, modify, merge, publish,
9 // distribute, sublicense, and/or sell copies of the Software, and to
10 // permit persons to whom the Software is furnished to do so, subject to
11 // the following conditions:
12 //
13 // The above copyright notice and this permission notice shall be
14 // included in all copies or substantial portions of the Software.
15 //
16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 //
25 // Description of import into Moodle:
26 // Download from https://github.com/pimterry/loglevel/releases
27 // Copy loglevel.js into lib/amd/src/ in Moodle folder.
28 // Add the license as a comment to the file and these instructions.
30 /*
31  * loglevel - https://github.com/pimterry/loglevel
32  *
33  * Copyright (c) 2013 Tim Perry
34  * Licensed under the MIT license.
35  */
36 (function (root, definition) {
37     "use strict";
38     if (typeof define === 'function' && define.amd) {
39         define(definition);
40     } else if (typeof module === 'object' && module.exports) {
41         module.exports = definition();
42     } else {
43         root.log = definition();
44     }
45 }(this, function () {
46     "use strict";
48     // Slightly dubious tricks to cut down minimized file size
49     var noop = function() {};
50     var undefinedType = "undefined";
52     // Build the best logging method possible for this env
53     // Wherever possible we want to bind, not wrap, to preserve stack traces
54     function realMethod(methodName) {
55         if (typeof console === undefinedType) {
56             return false; // No method possible, for now - fixed later by enableLoggingWhenConsoleArrives
57         } else if (console[methodName] !== undefined) {
58             return bindMethod(console, methodName);
59         } else if (console.log !== undefined) {
60             return bindMethod(console, 'log');
61         } else {
62             return noop;
63         }
64     }
66     // Cross-browser bind equivalent that works at least back to IE6
67     function bindMethod(obj, methodName) {
68         var method = obj[methodName];
69         if (typeof method.bind === 'function') {
70             return method.bind(obj);
71         } else {
72             try {
73                 return Function.prototype.bind.call(method, obj);
74             } catch (e) {
75                 // Missing bind shim or IE8 + Modernizr, fallback to wrapping
76                 return function() {
77                     return Function.prototype.apply.apply(method, [obj, arguments]);
78                 };
79             }
80         }
81     }
83     // These private functions always need `this` to be set properly
85     // In old IE versions, the console isn't present until you first open it.
86     // We build realMethod() replacements here that regenerate logging methods
87     function enableLoggingWhenConsoleArrives(methodName, level, loggerName) {
88         return function () {
89             if (typeof console !== undefinedType) {
90                 replaceLoggingMethods.call(this, level, loggerName);
91                 this[methodName].apply(this, arguments);
92             }
93         };
94     }
96     function replaceLoggingMethods(level, loggerName) {
97         /*jshint validthis:true */
98         for (var i = 0; i < logMethods.length; i++) {
99             var methodName = logMethods[i];
100             this[methodName] = (i < level) ?
101                 noop :
102                 this.methodFactory(methodName, level, loggerName);
103         }
104     }
106     // By default, we use closely bound real methods wherever possible, and
107     // otherwise we wait for a console to appear, and then try again.
108     function defaultMethodFactory(methodName, level, loggerName) {
109         /*jshint validthis:true */
110         return realMethod(methodName) ||
111             enableLoggingWhenConsoleArrives.apply(this, arguments);
112     }
114     var logMethods = [
115         "trace",
116         "debug",
117         "info",
118         "warn",
119         "error"
120     ];
122     function Logger(name, defaultLevel, factory) {
123         var self = this;
124         var currentLevel;
125         var storageKey = "loglevel";
126         if (name) {
127             storageKey += ":" + name;
128         }
130         function persistLevelIfPossible(levelNum) {
131             var levelName = (logMethods[levelNum] || 'silent').toUpperCase();
133             // Use localStorage if available
134             try {
135                 window.localStorage[storageKey] = levelName;
136                 return;
137             } catch (ignore) {}
139             // Use session cookie as fallback
140             try {
141                 window.document.cookie =
142                     encodeURIComponent(storageKey) + "=" + levelName + ";";
143             } catch (ignore) {}
144         }
146         function getPersistedLevel() {
147             var storedLevel;
149             try {
150                 storedLevel = window.localStorage[storageKey];
151             } catch (ignore) {}
153             // Fallback to cookies if local storage gives us nothing
154             if (typeof storedLevel === undefinedType) {
155                 try {
156                     var cookie = window.document.cookie;
157                     var location = cookie.indexOf(
158                         encodeURIComponent(storageKey) + "=");
159                     if (location) {
160                         storedLevel = /^([^;]+)/.exec(cookie.slice(location))[1];
161                     }
162                 } catch (ignore) {}
163             }
165             // If the stored level is not valid, treat it as if nothing was stored.
166             if (self.levels[storedLevel] === undefined) {
167                 storedLevel = undefined;
168             }
170             return storedLevel;
171         }
173         /*
174          *
175          * Public logger API - see https://github.com/pimterry/loglevel for details
176          *
177          */
179         self.levels = { "TRACE": 0, "DEBUG": 1, "INFO": 2, "WARN": 3,
180             "ERROR": 4, "SILENT": 5};
182         self.methodFactory = factory || defaultMethodFactory;
184         self.getLevel = function () {
185             return currentLevel;
186         };
188         self.setLevel = function (level, persist) {
189             if (typeof level === "string" && self.levels[level.toUpperCase()] !== undefined) {
190                 level = self.levels[level.toUpperCase()];
191             }
192             if (typeof level === "number" && level >= 0 && level <= self.levels.SILENT) {
193                 currentLevel = level;
194                 if (persist !== false) {  // defaults to true
195                     persistLevelIfPossible(level);
196                 }
197                 replaceLoggingMethods.call(self, level, name);
198                 if (typeof console === undefinedType && level < self.levels.SILENT) {
199                     return "No console available for logging";
200                 }
201             } else {
202                 throw "log.setLevel() called with invalid level: " + level;
203             }
204         };
206         self.setDefaultLevel = function (level) {
207             if (!getPersistedLevel()) {
208                 self.setLevel(level, false);
209             }
210         };
212         self.enableAll = function(persist) {
213             self.setLevel(self.levels.TRACE, persist);
214         };
216         self.disableAll = function(persist) {
217             self.setLevel(self.levels.SILENT, persist);
218         };
220         // Initialize with the right level
221         var initialLevel = getPersistedLevel();
222         if (initialLevel == null) {
223             initialLevel = defaultLevel == null ? "WARN" : defaultLevel;
224         }
225         self.setLevel(initialLevel, false);
226     }
228     /*
229      *
230      * Top-level API
231      *
232      */
234     var defaultLogger = new Logger();
236     var _loggersByName = {};
237     defaultLogger.getLogger = function getLogger(name) {
238         if (typeof name !== "string" || name === "") {
239             throw new TypeError("You must supply a name when creating a logger.");
240         }
242         var logger = _loggersByName[name];
243         if (!logger) {
244             logger = _loggersByName[name] = new Logger(
245                 name, defaultLogger.getLevel(), defaultLogger.methodFactory);
246         }
247         return logger;
248     };
250     // Grab the current global log variable in case of overwrite
251     var _log = (typeof window !== undefinedType) ? window.log : undefined;
252     defaultLogger.noConflict = function() {
253         if (typeof window !== undefinedType &&
254             window.log === defaultLogger) {
255             window.log = _log;
256         }
258         return defaultLogger;
259     };
261     return defaultLogger;
262 }));