widgets.js 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589
  1. if (typeof(PhpDebugBar) == 'undefined') {
  2. // namespace
  3. var PhpDebugBar = {};
  4. PhpDebugBar.$ = jQuery;
  5. }
  6. (function($) {
  7. /**
  8. * @namespace
  9. */
  10. PhpDebugBar.Widgets = {};
  11. var csscls = PhpDebugBar.utils.makecsscls('phpdebugbar-widgets-');
  12. /**
  13. * Replaces spaces with &nbsp; and line breaks with <br>
  14. *
  15. * @param {String} text
  16. * @return {String}
  17. */
  18. var htmlize = PhpDebugBar.Widgets.htmlize = function(text) {
  19. return text.replace(/\n/g, '<br>').replace(/\s/g, "&nbsp;")
  20. };
  21. /**
  22. * Returns a string representation of value, using JSON.stringify
  23. * if it's an object.
  24. *
  25. * @param {Object} value
  26. * @param {Boolean} prettify Uses htmlize() if true
  27. * @return {String}
  28. */
  29. var renderValue = PhpDebugBar.Widgets.renderValue = function(value, prettify) {
  30. if (typeof(value) !== 'string') {
  31. if (prettify) {
  32. return htmlize(JSON.stringify(value, undefined, 2));
  33. }
  34. return JSON.stringify(value);
  35. }
  36. return value;
  37. };
  38. /**
  39. * Highlights a block of code
  40. *
  41. * @param {String} code
  42. * @param {String} lang
  43. * @return {String}
  44. */
  45. var highlight = PhpDebugBar.Widgets.highlight = function(code, lang) {
  46. if (typeof(code) === 'string') {
  47. if (typeof(hljs) === 'undefined') {
  48. return htmlize(code);
  49. }
  50. if (lang) {
  51. return hljs.highlight(lang, code).value;
  52. }
  53. return hljs.highlightAuto(code).value;
  54. }
  55. if (typeof(hljs) === 'object') {
  56. code.each(function(i, e) { hljs.highlightBlock(e); });
  57. }
  58. return code;
  59. };
  60. /**
  61. * Creates a <pre> element with a block of code
  62. *
  63. * @param {String} code
  64. * @param {String} lang
  65. * @param {Number} [firstLineNumber] If provided, shows line numbers beginning with the given value.
  66. * @param {Number} [highlightedLine] If provided, the given line number will be highlighted.
  67. * @return {String}
  68. */
  69. var createCodeBlock = PhpDebugBar.Widgets.createCodeBlock = function(code, lang, firstLineNumber, highlightedLine) {
  70. var pre = $('<pre />').addClass(csscls('code-block'));
  71. // Add a newline to prevent <code> element from vertically collapsing too far if the last
  72. // code line was empty: that creates problems with the horizontal scrollbar being
  73. // incorrectly positioned - most noticeable when line numbers are shown.
  74. var codeElement = $('<code />').text(code + '\n').appendTo(pre);
  75. // Add a span with a special class if we are supposed to highlight a line. highlight.js will
  76. // still correctly format code even with existing markup in it.
  77. if ($.isNumeric(highlightedLine)) {
  78. if ($.isNumeric(firstLineNumber)) {
  79. highlightedLine = highlightedLine - firstLineNumber + 1;
  80. }
  81. codeElement.html(function (index, html) {
  82. var currentLine = 1;
  83. return html.replace(/^.*$/gm, function(line) {
  84. if (currentLine++ == highlightedLine) {
  85. return '<span class="' + csscls('highlighted-line') + '">' + line + '</span>';
  86. } else {
  87. return line;
  88. }
  89. });
  90. });
  91. }
  92. // Format the code
  93. if (lang) {
  94. pre.addClass("language-" + lang);
  95. }
  96. highlight(pre);
  97. // Show line numbers in a list
  98. if ($.isNumeric(firstLineNumber)) {
  99. var lineCount = code.split('\n').length;
  100. var $lineNumbers = $('<ul />').prependTo(pre);
  101. pre.children().addClass(csscls('numbered-code'));
  102. for (var i = firstLineNumber; i < firstLineNumber + lineCount; i++) {
  103. $('<li />').text(i).appendTo($lineNumbers);
  104. }
  105. }
  106. return pre;
  107. };
  108. // ------------------------------------------------------------------
  109. // Generic widgets
  110. // ------------------------------------------------------------------
  111. /**
  112. * Displays array element in a <ul> list
  113. *
  114. * Options:
  115. * - data
  116. * - itemRenderer: a function used to render list items (optional)
  117. */
  118. var ListWidget = PhpDebugBar.Widgets.ListWidget = PhpDebugBar.Widget.extend({
  119. tagName: 'ul',
  120. className: csscls('list'),
  121. initialize: function(options) {
  122. if (!options['itemRenderer']) {
  123. options['itemRenderer'] = this.itemRenderer;
  124. }
  125. this.set(options);
  126. },
  127. render: function() {
  128. this.bindAttr(['itemRenderer', 'data'], function() {
  129. this.$el.empty();
  130. if (!this.has('data')) {
  131. return;
  132. }
  133. var data = this.get('data');
  134. for (var i = 0; i < data.length; i++) {
  135. var li = $('<li />').addClass(csscls('list-item')).appendTo(this.$el);
  136. this.get('itemRenderer')(li, data[i]);
  137. }
  138. });
  139. },
  140. /**
  141. * Renders the content of a <li> element
  142. *
  143. * @param {jQuery} li The <li> element as a jQuery Object
  144. * @param {Object} value An item from the data array
  145. */
  146. itemRenderer: function(li, value) {
  147. li.html(renderValue(value));
  148. }
  149. });
  150. // ------------------------------------------------------------------
  151. /**
  152. * Displays object property/value paris in a <dl> list
  153. *
  154. * Options:
  155. * - data
  156. * - itemRenderer: a function used to render list items (optional)
  157. */
  158. var KVListWidget = PhpDebugBar.Widgets.KVListWidget = ListWidget.extend({
  159. tagName: 'dl',
  160. className: csscls('kvlist'),
  161. render: function() {
  162. this.bindAttr(['itemRenderer', 'data'], function() {
  163. this.$el.empty();
  164. if (!this.has('data')) {
  165. return;
  166. }
  167. var self = this;
  168. $.each(this.get('data'), function(key, value) {
  169. var dt = $('<dt />').addClass(csscls('key')).appendTo(self.$el);
  170. var dd = $('<dd />').addClass(csscls('value')).appendTo(self.$el);
  171. self.get('itemRenderer')(dt, dd, key, value);
  172. });
  173. });
  174. },
  175. /**
  176. * Renders the content of the <dt> and <dd> elements
  177. *
  178. * @param {jQuery} dt The <dt> element as a jQuery Object
  179. * @param {jQuery} dd The <dd> element as a jQuery Object
  180. * @param {String} key Property name
  181. * @param {Object} value Property value
  182. */
  183. itemRenderer: function(dt, dd, key, value) {
  184. dt.text(key);
  185. dd.html(htmlize(value));
  186. }
  187. });
  188. // ------------------------------------------------------------------
  189. /**
  190. * An extension of KVListWidget where the data represents a list
  191. * of variables
  192. *
  193. * Options:
  194. * - data
  195. */
  196. var VariableListWidget = PhpDebugBar.Widgets.VariableListWidget = KVListWidget.extend({
  197. className: csscls('kvlist varlist'),
  198. itemRenderer: function(dt, dd, key, value) {
  199. $('<span />').attr('title', key).text(key).appendTo(dt);
  200. var v = value;
  201. if (v && v.length > 100) {
  202. v = v.substr(0, 100) + "...";
  203. }
  204. var prettyVal = null;
  205. dd.text(v).click(function() {
  206. if (dd.hasClass(csscls('pretty'))) {
  207. dd.text(v).removeClass(csscls('pretty'));
  208. } else {
  209. prettyVal = prettyVal || createCodeBlock(value);
  210. dd.addClass(csscls('pretty')).empty().append(prettyVal);
  211. }
  212. });
  213. }
  214. });
  215. // ------------------------------------------------------------------
  216. /**
  217. * An extension of KVListWidget where the data represents a list
  218. * of variables whose contents are HTML; this is useful for showing
  219. * variable output from VarDumper's HtmlDumper.
  220. *
  221. * Options:
  222. * - data
  223. */
  224. var HtmlVariableListWidget = PhpDebugBar.Widgets.HtmlVariableListWidget = KVListWidget.extend({
  225. className: csscls('kvlist htmlvarlist'),
  226. itemRenderer: function(dt, dd, key, value) {
  227. $('<span />').attr('title', key).text(key).appendTo(dt);
  228. dd.html(value);
  229. }
  230. });
  231. // ------------------------------------------------------------------
  232. /**
  233. * Iframe widget
  234. *
  235. * Options:
  236. * - data
  237. */
  238. var IFrameWidget = PhpDebugBar.Widgets.IFrameWidget = PhpDebugBar.Widget.extend({
  239. tagName: 'iframe',
  240. className: csscls('iframe'),
  241. render: function() {
  242. this.$el.attr({
  243. seamless: "seamless",
  244. border: "0",
  245. width: "100%",
  246. height: "100%"
  247. });
  248. this.bindAttr('data', function(url) { this.$el.attr('src', url); });
  249. }
  250. });
  251. // ------------------------------------------------------------------
  252. // Collector specific widgets
  253. // ------------------------------------------------------------------
  254. /**
  255. * Widget for the MessagesCollector
  256. *
  257. * Uses ListWidget under the hood
  258. *
  259. * Options:
  260. * - data
  261. */
  262. var MessagesWidget = PhpDebugBar.Widgets.MessagesWidget = PhpDebugBar.Widget.extend({
  263. className: csscls('messages'),
  264. render: function() {
  265. var self = this;
  266. this.$list = new ListWidget({ itemRenderer: function(li, value) {
  267. if (value.message_html) {
  268. var val = $('<span />').addClass(csscls('value')).html(value.message_html).appendTo(li);
  269. } else {
  270. var m = value.message;
  271. if (m.length > 100) {
  272. m = m.substr(0, 100) + "...";
  273. }
  274. var val = $('<span />').addClass(csscls('value')).text(m).appendTo(li);
  275. if (!value.is_string || value.message.length > 100) {
  276. var prettyVal = value.message;
  277. if (!value.is_string) {
  278. prettyVal = null;
  279. }
  280. li.css('cursor', 'pointer').click(function () {
  281. if (val.hasClass(csscls('pretty'))) {
  282. val.text(m).removeClass(csscls('pretty'));
  283. } else {
  284. prettyVal = prettyVal || createCodeBlock(value.message, 'php');
  285. val.addClass(csscls('pretty')).empty().append(prettyVal);
  286. }
  287. });
  288. }
  289. }
  290. if (value.collector) {
  291. $('<span />').addClass(csscls('collector')).text(value.collector).prependTo(li);
  292. }
  293. if (value.label) {
  294. val.addClass(csscls(value.label));
  295. $('<span />').addClass(csscls('label')).text(value.label).prependTo(li);
  296. }
  297. }});
  298. this.$list.$el.appendTo(this.$el);
  299. this.$toolbar = $('<div><i class="phpdebugbar-fa phpdebugbar-fa-search"></i></div>').addClass(csscls('toolbar')).appendTo(this.$el);
  300. $('<input type="text" />')
  301. .on('change', function() { self.set('search', this.value); })
  302. .appendTo(this.$toolbar);
  303. this.bindAttr('data', function(data) {
  304. this.set({ exclude: [], search: '' });
  305. this.$toolbar.find(csscls('.filter')).remove();
  306. var filters = [], self = this;
  307. for (var i = 0; i < data.length; i++) {
  308. if (!data[i].label || $.inArray(data[i].label, filters) > -1) {
  309. continue;
  310. }
  311. filters.push(data[i].label);
  312. $('<a />')
  313. .addClass(csscls('filter'))
  314. .text(data[i].label)
  315. .attr('rel', data[i].label)
  316. .on('click', function() { self.onFilterClick(this); })
  317. .appendTo(this.$toolbar);
  318. }
  319. });
  320. this.bindAttr(['exclude', 'search'], function() {
  321. var data = this.get('data'),
  322. exclude = this.get('exclude'),
  323. search = this.get('search'),
  324. caseless = false,
  325. fdata = [];
  326. if (search && search === search.toLowerCase()) {
  327. caseless = true;
  328. }
  329. for (var i = 0; i < data.length; i++) {
  330. var message = caseless ? data[i].message.toLowerCase() : data[i].message;
  331. if ((!data[i].label || $.inArray(data[i].label, exclude) === -1) && (!search || message.indexOf(search) > -1)) {
  332. fdata.push(data[i]);
  333. }
  334. }
  335. this.$list.set('data', fdata);
  336. });
  337. },
  338. onFilterClick: function(el) {
  339. $(el).toggleClass(csscls('excluded'));
  340. var excludedLabels = [];
  341. this.$toolbar.find(csscls('.filter') + csscls('.excluded')).each(function() {
  342. excludedLabels.push(this.rel);
  343. });
  344. this.set('exclude', excludedLabels);
  345. }
  346. });
  347. // ------------------------------------------------------------------
  348. /**
  349. * Widget for the TimeDataCollector
  350. *
  351. * Options:
  352. * - data
  353. */
  354. var TimelineWidget = PhpDebugBar.Widgets.TimelineWidget = PhpDebugBar.Widget.extend({
  355. tagName: 'ul',
  356. className: csscls('timeline'),
  357. render: function() {
  358. this.bindAttr('data', function(data) {
  359. // ported from php DataFormatter
  360. var formatDuration = function(seconds) {
  361. if (seconds < 0.001)
  362. return (seconds * 1000000).toFixed() + 'μs';
  363. else if (seconds < 1)
  364. return (seconds * 1000).toFixed(2) + 'ms';
  365. return (seconds).toFixed(2) + 's';
  366. };
  367. this.$el.empty();
  368. if (data.measures) {
  369. var aggregate = {};
  370. for (var i = 0; i < data.measures.length; i++) {
  371. var measure = data.measures[i];
  372. if(!aggregate[measure.label])
  373. aggregate[measure.label] = { count: 0, duration: 0 };
  374. aggregate[measure.label]['count'] += 1;
  375. aggregate[measure.label]['duration'] += measure.duration;
  376. var m = $('<div />').addClass(csscls('measure')),
  377. li = $('<li />'),
  378. left = (measure.relative_start * 100 / data.duration).toFixed(2),
  379. width = Math.min((measure.duration * 100 / data.duration).toFixed(2), 100 - left);
  380. m.append($('<span />').addClass(csscls('value')).css({
  381. left: left + "%",
  382. width: width + "%"
  383. }));
  384. m.append($('<span />').addClass(csscls('label')).text(measure.label + " (" + measure.duration_str + ")"));
  385. if (measure.collector) {
  386. $('<span />').addClass(csscls('collector')).text(measure.collector).appendTo(m);
  387. }
  388. m.appendTo(li);
  389. this.$el.append(li);
  390. if (measure.params && !$.isEmptyObject(measure.params)) {
  391. var table = $('<table><tr><th colspan="2">Params</th></tr></table>').addClass(csscls('params')).appendTo(li);
  392. for (var key in measure.params) {
  393. if (typeof measure.params[key] !== 'function') {
  394. table.append('<tr><td class="' + csscls('name') + '">' + key + '</td><td class="' + csscls('value') +
  395. '"><pre><code>' + measure.params[key] + '</code></pre></td></tr>');
  396. }
  397. }
  398. li.css('cursor', 'pointer').click(function() {
  399. var table = $(this).find('table');
  400. if (table.is(':visible')) {
  401. table.hide();
  402. } else {
  403. table.show();
  404. }
  405. });
  406. }
  407. }
  408. // convert to array and sort by duration
  409. aggregate = $.map(aggregate, function(data, label) {
  410. return {
  411. label: label,
  412. data: data
  413. }
  414. }).sort(function(a, b) {
  415. return b.data.duration - a.data.duration
  416. });
  417. // build table and add
  418. var aggregateTable = $('<table style="display: table; border: 0; width: 99%"></table>').addClass(csscls('params'));
  419. $.each(aggregate, function(i, aggregate) {
  420. width = Math.min((aggregate.data.duration * 100 / data.duration).toFixed(2), 100);
  421. aggregateTable.append('<tr><td class="' + csscls('name') + '">' + aggregate.data.count + ' x ' + aggregate.label + ' (' + width + '%)</td><td class="' + csscls('value') + '">' +
  422. '<div class="' + csscls('measure') +'">' +
  423. '<span class="' + csscls('value') + '" style="width:' + width + '%"></span>' +
  424. '<span class="' + csscls('label') + '">' + formatDuration(aggregate.data.duration) + '</span>' +
  425. '</div></td></tr>');
  426. });
  427. this.$el.append('<li/>').find('li:last').append(aggregateTable);
  428. }
  429. });
  430. }
  431. });
  432. // ------------------------------------------------------------------
  433. /**
  434. * Widget for the displaying exceptions
  435. *
  436. * Options:
  437. * - data
  438. */
  439. var ExceptionsWidget = PhpDebugBar.Widgets.ExceptionsWidget = PhpDebugBar.Widget.extend({
  440. className: csscls('exceptions'),
  441. render: function() {
  442. this.$list = new ListWidget({ itemRenderer: function(li, e) {
  443. $('<span />').addClass(csscls('message')).text(e.message).appendTo(li);
  444. if (e.file) {
  445. var header = $('<span />').addClass(csscls('filename')).text(e.file + "#" + e.line);
  446. if (e.xdebug_link) {
  447. if (e.xdebug_link.ajax) {
  448. $('<a title="' + e.xdebug_link.url + '"></a>').on('click', function () {
  449. $.ajax(e.xdebug_link.url);
  450. }).addClass(csscls('editor-link')).appendTo(header);
  451. } else {
  452. $('<a href="' + e.xdebug_link.url + '"></a>').addClass(csscls('editor-link')).appendTo(header);
  453. }
  454. }
  455. header.appendTo(li);
  456. }
  457. if (e.type) {
  458. $('<span />').addClass(csscls('type')).text(e.type).appendTo(li);
  459. }
  460. if (e.surrounding_lines) {
  461. var pre = createCodeBlock(e.surrounding_lines.join(""), 'php').addClass(csscls('file')).appendTo(li);
  462. if (!e.stack_trace_html) {
  463. // This click event makes the var-dumper hard to use.
  464. li.click(function () {
  465. if (pre.is(':visible')) {
  466. pre.hide();
  467. } else {
  468. pre.show();
  469. }
  470. });
  471. }
  472. }
  473. if (e.stack_trace_html) {
  474. var $trace = $('<span />').addClass(csscls('filename')).html(e.stack_trace_html);
  475. $trace.appendTo(li);
  476. } else if (e.stack_trace) {
  477. e.stack_trace.split("\n").forEach(function (trace) {
  478. var $traceLine = $('<div />');
  479. $('<span />').addClass(csscls('filename')).text(trace).appendTo($traceLine);
  480. $traceLine.appendTo(li);
  481. });
  482. }
  483. }});
  484. this.$list.$el.appendTo(this.$el);
  485. this.bindAttr('data', function(data) {
  486. this.$list.set('data', data);
  487. if (data.length == 1) {
  488. this.$list.$el.children().first().find(csscls('.file')).show();
  489. }
  490. });
  491. }
  492. });
  493. })(PhpDebugBar.$);