##// END OF EJS Templates
sanitize untrusted HTML output...
MinRK -
Show More
@@ -1,872 +1,872 b''
1 1 //----------------------------------------------------------------------------
2 2 // Copyright (C) 2008 The IPython Development Team
3 3 //
4 4 // Distributed under the terms of the BSD License. The full license is in
5 5 // the file COPYING, distributed as part of this software.
6 6 //----------------------------------------------------------------------------
7 7
8 8 //============================================================================
9 9 // OutputArea
10 10 //============================================================================
11 11
12 12 /**
13 13 * @module IPython
14 14 * @namespace IPython
15 15 * @submodule OutputArea
16 16 */
17 17 var IPython = (function (IPython) {
18 18 "use strict";
19 19
20 20 var utils = IPython.utils;
21 21
22 22 /**
23 23 * @class OutputArea
24 24 *
25 25 * @constructor
26 26 */
27 27
28 28 var OutputArea = function (selector, prompt_area) {
29 29 this.selector = selector;
30 30 this.wrapper = $(selector);
31 31 this.outputs = [];
32 32 this.collapsed = false;
33 33 this.scrolled = false;
34 34 this.trusted = true;
35 35 this.clear_queued = null;
36 36 if (prompt_area === undefined) {
37 37 this.prompt_area = true;
38 38 } else {
39 39 this.prompt_area = prompt_area;
40 40 }
41 41 this.create_elements();
42 42 this.style();
43 43 this.bind_events();
44 44 };
45 45
46 46
47 47 /**
48 48 * Class prototypes
49 49 **/
50 50
51 51 OutputArea.prototype.create_elements = function () {
52 52 this.element = $("<div/>");
53 53 this.collapse_button = $("<div/>");
54 54 this.prompt_overlay = $("<div/>");
55 55 this.wrapper.append(this.prompt_overlay);
56 56 this.wrapper.append(this.element);
57 57 this.wrapper.append(this.collapse_button);
58 58 };
59 59
60 60
61 61 OutputArea.prototype.style = function () {
62 62 this.collapse_button.hide();
63 63 this.prompt_overlay.hide();
64 64
65 65 this.wrapper.addClass('output_wrapper');
66 66 this.element.addClass('output');
67 67
68 68 this.collapse_button.addClass("btn output_collapsed");
69 69 this.collapse_button.attr('title', 'click to expand output');
70 70 this.collapse_button.text('. . .');
71 71
72 72 this.prompt_overlay.addClass('out_prompt_overlay prompt');
73 73 this.prompt_overlay.attr('title', 'click to expand output; double click to hide output');
74 74
75 75 this.collapse();
76 76 };
77 77
78 78 /**
79 79 * Should the OutputArea scroll?
80 80 * Returns whether the height (in lines) exceeds a threshold.
81 81 *
82 82 * @private
83 83 * @method _should_scroll
84 84 * @param [lines=100]{Integer}
85 85 * @return {Bool}
86 86 *
87 87 */
88 88 OutputArea.prototype._should_scroll = function (lines) {
89 89 if (lines <=0 ){ return }
90 90 if (!lines) {
91 91 lines = 100;
92 92 }
93 93 // line-height from http://stackoverflow.com/questions/1185151
94 94 var fontSize = this.element.css('font-size');
95 95 var lineHeight = Math.floor(parseInt(fontSize.replace('px','')) * 1.5);
96 96
97 97 return (this.element.height() > lines * lineHeight);
98 98 };
99 99
100 100
101 101 OutputArea.prototype.bind_events = function () {
102 102 var that = this;
103 103 this.prompt_overlay.dblclick(function () { that.toggle_output(); });
104 104 this.prompt_overlay.click(function () { that.toggle_scroll(); });
105 105
106 106 this.element.resize(function () {
107 107 // FIXME: Firefox on Linux misbehaves, so automatic scrolling is disabled
108 108 if ( IPython.utils.browser[0] === "Firefox" ) {
109 109 return;
110 110 }
111 111 // maybe scroll output,
112 112 // if it's grown large enough and hasn't already been scrolled.
113 113 if ( !that.scrolled && that._should_scroll(OutputArea.auto_scroll_threshold)) {
114 114 that.scroll_area();
115 115 }
116 116 });
117 117 this.collapse_button.click(function () {
118 118 that.expand();
119 119 });
120 120 };
121 121
122 122
123 123 OutputArea.prototype.collapse = function () {
124 124 if (!this.collapsed) {
125 125 this.element.hide();
126 126 this.prompt_overlay.hide();
127 127 if (this.element.html()){
128 128 this.collapse_button.show();
129 129 }
130 130 this.collapsed = true;
131 131 }
132 132 };
133 133
134 134
135 135 OutputArea.prototype.expand = function () {
136 136 if (this.collapsed) {
137 137 this.collapse_button.hide();
138 138 this.element.show();
139 139 this.prompt_overlay.show();
140 140 this.collapsed = false;
141 141 }
142 142 };
143 143
144 144
145 145 OutputArea.prototype.toggle_output = function () {
146 146 if (this.collapsed) {
147 147 this.expand();
148 148 } else {
149 149 this.collapse();
150 150 }
151 151 };
152 152
153 153
154 154 OutputArea.prototype.scroll_area = function () {
155 155 this.element.addClass('output_scroll');
156 156 this.prompt_overlay.attr('title', 'click to unscroll output; double click to hide');
157 157 this.scrolled = true;
158 158 };
159 159
160 160
161 161 OutputArea.prototype.unscroll_area = function () {
162 162 this.element.removeClass('output_scroll');
163 163 this.prompt_overlay.attr('title', 'click to scroll output; double click to hide');
164 164 this.scrolled = false;
165 165 };
166 166
167 167 /**
168 168 *
169 169 * Scroll OutputArea if height supperior than a threshold (in lines).
170 170 *
171 171 * Threshold is a maximum number of lines. If unspecified, defaults to
172 172 * OutputArea.minimum_scroll_threshold.
173 173 *
174 174 * Negative threshold will prevent the OutputArea from ever scrolling.
175 175 *
176 176 * @method scroll_if_long
177 177 *
178 178 * @param [lines=20]{Number} Default to 20 if not set,
179 179 * behavior undefined for value of `0`.
180 180 *
181 181 **/
182 182 OutputArea.prototype.scroll_if_long = function (lines) {
183 183 var n = lines | OutputArea.minimum_scroll_threshold;
184 184 if(n <= 0){
185 185 return
186 186 }
187 187
188 188 if (this._should_scroll(n)) {
189 189 // only allow scrolling long-enough output
190 190 this.scroll_area();
191 191 }
192 192 };
193 193
194 194
195 195 OutputArea.prototype.toggle_scroll = function () {
196 196 if (this.scrolled) {
197 197 this.unscroll_area();
198 198 } else {
199 199 // only allow scrolling long-enough output
200 200 this.scroll_if_long();
201 201 }
202 202 };
203 203
204 204
205 205 // typeset with MathJax if MathJax is available
206 206 OutputArea.prototype.typeset = function () {
207 207 if (window.MathJax){
208 208 MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
209 209 }
210 210 };
211 211
212 212
213 213 OutputArea.prototype.handle_output = function (msg) {
214 214 var json = {};
215 215 var msg_type = json.output_type = msg.header.msg_type;
216 216 var content = msg.content;
217 217 if (msg_type === "stream") {
218 218 json.text = content.data;
219 219 json.stream = content.name;
220 220 } else if (msg_type === "display_data") {
221 221 json = content.data;
222 222 json.output_type = msg_type;
223 223 json.metadata = content.metadata;
224 224 } else if (msg_type === "pyout") {
225 225 json = content.data;
226 226 json.output_type = msg_type;
227 227 json.metadata = content.metadata;
228 228 json.prompt_number = content.execution_count;
229 229 } else if (msg_type === "pyerr") {
230 230 json.ename = content.ename;
231 231 json.evalue = content.evalue;
232 232 json.traceback = content.traceback;
233 233 }
234 234 this.append_output(json);
235 235 };
236 236
237 237
238 238 OutputArea.prototype.rename_keys = function (data, key_map) {
239 239 var remapped = {};
240 240 for (var key in data) {
241 241 var new_key = key_map[key] || key;
242 242 remapped[new_key] = data[key];
243 243 }
244 244 return remapped;
245 245 };
246 246
247 247
248 248 OutputArea.output_types = [
249 249 'application/javascript',
250 250 'text/html',
251 251 'text/latex',
252 252 'image/svg+xml',
253 253 'image/png',
254 254 'image/jpeg',
255 255 'application/pdf',
256 256 'text/plain'
257 257 ];
258 258
259 259 OutputArea.prototype.validate_output = function (json) {
260 260 // scrub invalid outputs
261 261 // TODO: right now everything is a string, but JSON really shouldn't be.
262 262 // nbformat 4 will fix that.
263 263 $.map(OutputArea.output_types, function(key){
264 264 if (json[key] !== undefined && typeof json[key] !== 'string') {
265 265 console.log("Invalid type for " + key, json[key]);
266 266 delete json[key];
267 267 }
268 268 });
269 269 return json;
270 270 };
271 271
272 272 OutputArea.prototype.append_output = function (json) {
273 273 this.expand();
274 274 // Clear the output if clear is queued.
275 275 var needs_height_reset = false;
276 276 if (this.clear_queued) {
277 277 this.clear_output(false);
278 278 needs_height_reset = true;
279 279 }
280 280
281 281 // validate output data types
282 282 json = this.validate_output(json);
283 283
284 284 if (json.output_type === 'pyout') {
285 285 this.append_pyout(json);
286 286 } else if (json.output_type === 'pyerr') {
287 287 this.append_pyerr(json);
288 288 } else if (json.output_type === 'display_data') {
289 289 this.append_display_data(json);
290 290 } else if (json.output_type === 'stream') {
291 291 this.append_stream(json);
292 292 }
293 293
294 294 this.outputs.push(json);
295 295
296 296 // Only reset the height to automatic if the height is currently
297 297 // fixed (done by wait=True flag on clear_output).
298 298 if (needs_height_reset) {
299 299 this.element.height('');
300 300 }
301 301
302 302 var that = this;
303 303 setTimeout(function(){that.element.trigger('resize');}, 100);
304 304 };
305 305
306 306
307 307 OutputArea.prototype.create_output_area = function () {
308 308 var oa = $("<div/>").addClass("output_area");
309 309 if (this.prompt_area) {
310 310 oa.append($('<div/>').addClass('prompt'));
311 311 }
312 312 return oa;
313 313 };
314 314
315 315
316 316 function _get_metadata_key(metadata, key, mime) {
317 317 var mime_md = metadata[mime];
318 318 // mime-specific higher priority
319 319 if (mime_md && mime_md[key] !== undefined) {
320 320 return mime_md[key];
321 321 }
322 322 // fallback on global
323 323 return metadata[key];
324 324 }
325 325
326 326 OutputArea.prototype.create_output_subarea = function(md, classes, mime) {
327 327 var subarea = $('<div/>').addClass('output_subarea').addClass(classes);
328 328 if (_get_metadata_key(md, 'isolated', mime)) {
329 329 // Create an iframe to isolate the subarea from the rest of the
330 330 // document
331 331 var iframe = $('<iframe/>').addClass('box-flex1');
332 332 iframe.css({'height':1, 'width':'100%', 'display':'block'});
333 333 iframe.attr('frameborder', 0);
334 334 iframe.attr('scrolling', 'auto');
335 335
336 336 // Once the iframe is loaded, the subarea is dynamically inserted
337 337 iframe.on('load', function() {
338 338 // Workaround needed by Firefox, to properly render svg inside
339 339 // iframes, see http://stackoverflow.com/questions/10177190/
340 340 // svg-dynamically-added-to-iframe-does-not-render-correctly
341 341 this.contentDocument.open();
342 342
343 343 // Insert the subarea into the iframe
344 344 // We must directly write the html. When using Jquery's append
345 345 // method, javascript is evaluated in the parent document and
346 346 // not in the iframe document. At this point, subarea doesn't
347 347 // contain any user content.
348 348 this.contentDocument.write(subarea.html());
349 349
350 350 this.contentDocument.close();
351 351
352 352 var body = this.contentDocument.body;
353 353 // Adjust the iframe height automatically
354 354 iframe.height(body.scrollHeight + 'px');
355 355 });
356 356
357 357 // Elements should be appended to the inner subarea and not to the
358 358 // iframe
359 359 iframe.append = function(that) {
360 360 subarea.append(that);
361 361 };
362 362
363 363 return iframe;
364 364 } else {
365 365 return subarea;
366 366 }
367 367 }
368 368
369 369
370 370 OutputArea.prototype._append_javascript_error = function (err, element) {
371 371 // display a message when a javascript error occurs in display output
372 372 var msg = "Javascript error adding output!"
373 373 if ( element === undefined ) return;
374 374 element
375 375 .append($('<div/>').text(msg).addClass('js-error'))
376 376 .append($('<div/>').text(err.toString()).addClass('js-error'))
377 377 .append($('<div/>').text('See your browser Javascript console for more details.').addClass('js-error'));
378 378 };
379 379
380 380 OutputArea.prototype._safe_append = function (toinsert) {
381 381 // safely append an item to the document
382 382 // this is an object created by user code,
383 383 // and may have errors, which should not be raised
384 384 // under any circumstances.
385 385 try {
386 386 this.element.append(toinsert);
387 387 } catch(err) {
388 388 console.log(err);
389 389 // Create an actual output_area and output_subarea, which creates
390 390 // the prompt area and the proper indentation.
391 391 var toinsert = this.create_output_area();
392 392 var subarea = $('<div/>').addClass('output_subarea');
393 393 toinsert.append(subarea);
394 394 this._append_javascript_error(err, subarea);
395 395 this.element.append(toinsert);
396 396 }
397 397 };
398 398
399 399
400 400 OutputArea.prototype.append_pyout = function (json) {
401 401 var n = json.prompt_number || ' ';
402 402 var toinsert = this.create_output_area();
403 403 if (this.prompt_area) {
404 404 toinsert.find('div.prompt').addClass('output_prompt').text('Out[' + n + ']:');
405 405 }
406 406 this.append_mime_type(json, toinsert);
407 407 this._safe_append(toinsert);
408 408 // If we just output latex, typeset it.
409 409 if ((json['text/latex'] !== undefined) || (json['text/html'] !== undefined)) {
410 410 this.typeset();
411 411 }
412 412 };
413 413
414 414
415 415 OutputArea.prototype.append_pyerr = function (json) {
416 416 var tb = json.traceback;
417 417 if (tb !== undefined && tb.length > 0) {
418 418 var s = '';
419 419 var len = tb.length;
420 420 for (var i=0; i<len; i++) {
421 421 s = s + tb[i] + '\n';
422 422 }
423 423 s = s + '\n';
424 424 var toinsert = this.create_output_area();
425 425 this.append_text(s, {}, toinsert);
426 426 this._safe_append(toinsert);
427 427 }
428 428 };
429 429
430 430
431 431 OutputArea.prototype.append_stream = function (json) {
432 432 // temporary fix: if stream undefined (json file written prior to this patch),
433 433 // default to most likely stdout:
434 434 if (json.stream == undefined){
435 435 json.stream = 'stdout';
436 436 }
437 437 var text = json.text;
438 438 var subclass = "output_"+json.stream;
439 439 if (this.outputs.length > 0){
440 440 // have at least one output to consider
441 441 var last = this.outputs[this.outputs.length-1];
442 442 if (last.output_type == 'stream' && json.stream == last.stream){
443 443 // latest output was in the same stream,
444 444 // so append directly into its pre tag
445 445 // escape ANSI & HTML specials:
446 446 var pre = this.element.find('div.'+subclass).last().find('pre');
447 447 var html = utils.fixCarriageReturn(
448 448 pre.html() + utils.fixConsole(text));
449 449 // The only user content injected with this HTML call is
450 450 // escaped by the fixConsole() method.
451 451 pre.html(html);
452 452 return;
453 453 }
454 454 }
455 455
456 456 if (!text.replace("\r", "")) {
457 457 // text is nothing (empty string, \r, etc.)
458 458 // so don't append any elements, which might add undesirable space
459 459 return;
460 460 }
461 461
462 462 // If we got here, attach a new div
463 463 var toinsert = this.create_output_area();
464 464 this.append_text(text, {}, toinsert, "output_stream "+subclass);
465 465 this._safe_append(toinsert);
466 466 };
467 467
468 468
469 469 OutputArea.prototype.append_display_data = function (json) {
470 470 var toinsert = this.create_output_area();
471 471 if (this.append_mime_type(json, toinsert)) {
472 472 this._safe_append(toinsert);
473 473 // If we just output latex, typeset it.
474 474 if ((json['text/latex'] !== undefined) || (json['text/html'] !== undefined)) {
475 475 this.typeset();
476 476 }
477 477 }
478 478 };
479 479
480 480
481 481 OutputArea.safe_outputs = {
482 482 'text/plain' : true,
483 483 'text/latex' : true,
484 484 'image/png' : true,
485 485 'image/jpeg' : true
486 486 };
487 487
488 488 OutputArea.prototype.append_mime_type = function (json, element) {
489 489 for (var type_i in OutputArea.display_order) {
490 490 var type = OutputArea.display_order[type_i];
491 491 var append = OutputArea.append_map[type];
492 492 if ((json[type] !== undefined) && append) {
493 var value = json[type];
493 494 if (!this.trusted && !OutputArea.safe_outputs[type]) {
494 // not trusted show warning and do not display
495 var is_safe = false;
495 // not trusted, sanitize HTML
496 496 if (type==='text/html' || type==='text/svg') {
497 is_safe = IPython.security.is_safe(json[type]);
498 }
499 if (!is_safe) {
497 value = IPython.security.sanitize_html(value);
498 } else {
499 // warn and don't display if we don't know how to sanitize it
500 500 var content = {
501 501 text : "Untrusted " + type + " output ignored.",
502 502 stream : "stderr"
503 503 }
504 504 this.append_stream(content);
505 505 continue;
506 506 }
507 507 }
508 508 var md = json.metadata || {};
509 var toinsert = append.apply(this, [json[type], md, element]);
510 $([IPython.events]).trigger('output_appended.OutputArea', [type, json[type], md, toinsert]);
509 var toinsert = append.apply(this, [value, md, element]);
510 $([IPython.events]).trigger('output_appended.OutputArea', [type, value, md, toinsert]);
511 511 return true;
512 512 }
513 513 }
514 514 return false;
515 515 };
516 516
517 517
518 518 OutputArea.prototype.append_html = function (html, md, element) {
519 519 var type = 'text/html';
520 520 var toinsert = this.create_output_subarea(md, "output_html rendered_html", type);
521 521 IPython.keyboard_manager.register_events(toinsert);
522 522 toinsert.append(html);
523 523 element.append(toinsert);
524 524 return toinsert;
525 525 };
526 526
527 527
528 528 OutputArea.prototype.append_javascript = function (js, md, element) {
529 529 // We just eval the JS code, element appears in the local scope.
530 530 var type = 'application/javascript';
531 531 var toinsert = this.create_output_subarea(md, "output_javascript", type);
532 532 IPython.keyboard_manager.register_events(toinsert);
533 533 element.append(toinsert);
534 534 // FIXME TODO : remove `container element for 3.0`
535 535 //backward compat, js should be eval'ed in a context where `container` is defined.
536 536 var container = element;
537 537 container.show = function(){console.log('Warning "container.show()" is deprecated.')};
538 538 // end backward compat
539 539 try {
540 540 eval(js);
541 541 } catch(err) {
542 542 console.log(err);
543 543 this._append_javascript_error(err, toinsert);
544 544 }
545 545 return toinsert;
546 546 };
547 547
548 548
549 549 OutputArea.prototype.append_text = function (data, md, element, extra_class) {
550 550 var type = 'text/plain';
551 551 var toinsert = this.create_output_subarea(md, "output_text", type);
552 552 // escape ANSI & HTML specials in plaintext:
553 553 data = utils.fixConsole(data);
554 554 data = utils.fixCarriageReturn(data);
555 555 data = utils.autoLinkUrls(data);
556 556 if (extra_class){
557 557 toinsert.addClass(extra_class);
558 558 }
559 559 // The only user content injected with this HTML call is
560 560 // escaped by the fixConsole() method.
561 561 toinsert.append($("<pre/>").html(data));
562 562 element.append(toinsert);
563 563 return toinsert;
564 564 };
565 565
566 566
567 567 OutputArea.prototype.append_svg = function (svg, md, element) {
568 568 var type = 'image/svg+xml';
569 569 var toinsert = this.create_output_subarea(md, "output_svg", type);
570 570 toinsert.append(svg);
571 571 element.append(toinsert);
572 572 return toinsert;
573 573 };
574 574
575 575
576 576 OutputArea.prototype._dblclick_to_reset_size = function (img) {
577 577 // wrap image after it's loaded on the page,
578 578 // otherwise the measured initial size will be incorrect
579 579 img.on("load", function (){
580 580 var h0 = img.height();
581 581 var w0 = img.width();
582 582 if (!(h0 && w0)) {
583 583 // zero size, don't make it resizable
584 584 return;
585 585 }
586 586 img.resizable({
587 587 aspectRatio: true,
588 588 autoHide: true
589 589 });
590 590 img.dblclick(function () {
591 591 // resize wrapper & image together for some reason:
592 592 img.parent().height(h0);
593 593 img.height(h0);
594 594 img.parent().width(w0);
595 595 img.width(w0);
596 596 });
597 597 });
598 598 };
599 599
600 600 var set_width_height = function (img, md, mime) {
601 601 // set width and height of an img element from metadata
602 602 var height = _get_metadata_key(md, 'height', mime);
603 603 if (height !== undefined) img.attr('height', height);
604 604 var width = _get_metadata_key(md, 'width', mime);
605 605 if (width !== undefined) img.attr('width', width);
606 606 };
607 607
608 608 OutputArea.prototype.append_png = function (png, md, element) {
609 609 var type = 'image/png';
610 610 var toinsert = this.create_output_subarea(md, "output_png", type);
611 611 var img = $("<img/>").attr('src','data:image/png;base64,'+png);
612 612 set_width_height(img, md, 'image/png');
613 613 this._dblclick_to_reset_size(img);
614 614 toinsert.append(img);
615 615 element.append(toinsert);
616 616 return toinsert;
617 617 };
618 618
619 619
620 620 OutputArea.prototype.append_jpeg = function (jpeg, md, element) {
621 621 var type = 'image/jpeg';
622 622 var toinsert = this.create_output_subarea(md, "output_jpeg", type);
623 623 var img = $("<img/>").attr('src','data:image/jpeg;base64,'+jpeg);
624 624 set_width_height(img, md, 'image/jpeg');
625 625 this._dblclick_to_reset_size(img);
626 626 toinsert.append(img);
627 627 element.append(toinsert);
628 628 return toinsert;
629 629 };
630 630
631 631
632 632 OutputArea.prototype.append_pdf = function (pdf, md, element) {
633 633 var type = 'application/pdf';
634 634 var toinsert = this.create_output_subarea(md, "output_pdf", type);
635 635 var a = $('<a/>').attr('href', 'data:application/pdf;base64,'+pdf);
636 636 a.attr('target', '_blank');
637 637 a.text('View PDF')
638 638 toinsert.append(a);
639 639 element.append(toinsert);
640 640 return toinsert;
641 641 }
642 642
643 643 OutputArea.prototype.append_latex = function (latex, md, element) {
644 644 // This method cannot do the typesetting because the latex first has to
645 645 // be on the page.
646 646 var type = 'text/latex';
647 647 var toinsert = this.create_output_subarea(md, "output_latex", type);
648 648 toinsert.append(latex);
649 649 element.append(toinsert);
650 650 return toinsert;
651 651 };
652 652
653 653
654 654 OutputArea.prototype.append_raw_input = function (msg) {
655 655 var that = this;
656 656 this.expand();
657 657 var content = msg.content;
658 658 var area = this.create_output_area();
659 659
660 660 // disable any other raw_inputs, if they are left around
661 661 $("div.output_subarea.raw_input").remove();
662 662
663 663 area.append(
664 664 $("<div/>")
665 665 .addClass("box-flex1 output_subarea raw_input")
666 666 .append(
667 667 $("<span/>")
668 668 .addClass("input_prompt")
669 669 .text(content.prompt)
670 670 )
671 671 .append(
672 672 $("<input/>")
673 673 .addClass("raw_input")
674 674 .attr('type', 'text')
675 675 .attr("size", 47)
676 676 .keydown(function (event, ui) {
677 677 // make sure we submit on enter,
678 678 // and don't re-execute the *cell* on shift-enter
679 679 if (event.which === IPython.keyboard.keycodes.enter) {
680 680 that._submit_raw_input();
681 681 return false;
682 682 }
683 683 })
684 684 )
685 685 );
686 686
687 687 this.element.append(area);
688 688 var raw_input = area.find('input.raw_input');
689 689 // Register events that enable/disable the keyboard manager while raw
690 690 // input is focused.
691 691 IPython.keyboard_manager.register_events(raw_input);
692 692 // Note, the following line used to read raw_input.focus().focus().
693 693 // This seemed to be needed otherwise only the cell would be focused.
694 694 // But with the modal UI, this seems to work fine with one call to focus().
695 695 raw_input.focus();
696 696 }
697 697
698 698 OutputArea.prototype._submit_raw_input = function (evt) {
699 699 var container = this.element.find("div.raw_input");
700 700 var theprompt = container.find("span.input_prompt");
701 701 var theinput = container.find("input.raw_input");
702 702 var value = theinput.val();
703 703 var content = {
704 704 output_type : 'stream',
705 705 name : 'stdout',
706 706 text : theprompt.text() + value + '\n'
707 707 }
708 708 // remove form container
709 709 container.parent().remove();
710 710 // replace with plaintext version in stdout
711 711 this.append_output(content, false);
712 712 $([IPython.events]).trigger('send_input_reply.Kernel', value);
713 713 }
714 714
715 715
716 716 OutputArea.prototype.handle_clear_output = function (msg) {
717 717 // msg spec v4 had stdout, stderr, display keys
718 718 // v4.1 replaced these with just wait
719 719 // The default behavior is the same (stdout=stderr=display=True, wait=False),
720 720 // so v4 messages will still be properly handled,
721 721 // except for the rarely used clearing less than all output.
722 722 this.clear_output(msg.content.wait || false);
723 723 };
724 724
725 725
726 726 OutputArea.prototype.clear_output = function(wait) {
727 727 if (wait) {
728 728
729 729 // If a clear is queued, clear before adding another to the queue.
730 730 if (this.clear_queued) {
731 731 this.clear_output(false);
732 732 };
733 733
734 734 this.clear_queued = true;
735 735 } else {
736 736
737 737 // Fix the output div's height if the clear_output is waiting for
738 738 // new output (it is being used in an animation).
739 739 if (this.clear_queued) {
740 740 var height = this.element.height();
741 741 this.element.height(height);
742 742 this.clear_queued = false;
743 743 }
744 744
745 745 // clear all, no need for logic
746 746 this.element.html("");
747 747 this.outputs = [];
748 748 this.trusted = true;
749 749 this.unscroll_area();
750 750 return;
751 751 };
752 752 };
753 753
754 754
755 755 // JSON serialization
756 756
757 757 OutputArea.prototype.fromJSON = function (outputs) {
758 758 var len = outputs.length;
759 759 var data;
760 760
761 761 for (var i=0; i<len; i++) {
762 762 data = outputs[i];
763 763 var msg_type = data.output_type;
764 764 if (msg_type === "display_data" || msg_type === "pyout") {
765 765 // convert short keys to mime keys
766 766 // TODO: remove mapping of short keys when we update to nbformat 4
767 767 data = this.rename_keys(data, OutputArea.mime_map_r);
768 768 data.metadata = this.rename_keys(data.metadata, OutputArea.mime_map_r);
769 769 }
770 770
771 771 this.append_output(data);
772 772 }
773 773 };
774 774
775 775
776 776 OutputArea.prototype.toJSON = function () {
777 777 var outputs = [];
778 778 var len = this.outputs.length;
779 779 var data;
780 780 for (var i=0; i<len; i++) {
781 781 data = this.outputs[i];
782 782 var msg_type = data.output_type;
783 783 if (msg_type === "display_data" || msg_type === "pyout") {
784 784 // convert mime keys to short keys
785 785 data = this.rename_keys(data, OutputArea.mime_map);
786 786 data.metadata = this.rename_keys(data.metadata, OutputArea.mime_map);
787 787 }
788 788 outputs[i] = data;
789 789 }
790 790 return outputs;
791 791 };
792 792
793 793 /**
794 794 * Class properties
795 795 **/
796 796
797 797 /**
798 798 * Threshold to trigger autoscroll when the OutputArea is resized,
799 799 * typically when new outputs are added.
800 800 *
801 801 * Behavior is undefined if autoscroll is lower than minimum_scroll_threshold,
802 802 * unless it is < 0, in which case autoscroll will never be triggered
803 803 *
804 804 * @property auto_scroll_threshold
805 805 * @type Number
806 806 * @default 100
807 807 *
808 808 **/
809 809 OutputArea.auto_scroll_threshold = 100;
810 810
811 811 /**
812 812 * Lower limit (in lines) for OutputArea to be made scrollable. OutputAreas
813 813 * shorter than this are never scrolled.
814 814 *
815 815 * @property minimum_scroll_threshold
816 816 * @type Number
817 817 * @default 20
818 818 *
819 819 **/
820 820 OutputArea.minimum_scroll_threshold = 20;
821 821
822 822
823 823
824 824 OutputArea.mime_map = {
825 825 "text/plain" : "text",
826 826 "text/html" : "html",
827 827 "image/svg+xml" : "svg",
828 828 "image/png" : "png",
829 829 "image/jpeg" : "jpeg",
830 830 "text/latex" : "latex",
831 831 "application/json" : "json",
832 832 "application/javascript" : "javascript",
833 833 };
834 834
835 835 OutputArea.mime_map_r = {
836 836 "text" : "text/plain",
837 837 "html" : "text/html",
838 838 "svg" : "image/svg+xml",
839 839 "png" : "image/png",
840 840 "jpeg" : "image/jpeg",
841 841 "latex" : "text/latex",
842 842 "json" : "application/json",
843 843 "javascript" : "application/javascript",
844 844 };
845 845
846 846 OutputArea.display_order = [
847 847 'application/javascript',
848 848 'text/html',
849 849 'text/latex',
850 850 'image/svg+xml',
851 851 'image/png',
852 852 'image/jpeg',
853 853 'application/pdf',
854 854 'text/plain'
855 855 ];
856 856
857 857 OutputArea.append_map = {
858 858 "text/plain" : OutputArea.prototype.append_text,
859 859 "text/html" : OutputArea.prototype.append_html,
860 860 "image/svg+xml" : OutputArea.prototype.append_svg,
861 861 "image/png" : OutputArea.prototype.append_png,
862 862 "image/jpeg" : OutputArea.prototype.append_jpeg,
863 863 "text/latex" : OutputArea.prototype.append_latex,
864 864 "application/javascript" : OutputArea.prototype.append_javascript,
865 865 "application/pdf" : OutputArea.prototype.append_pdf
866 866 };
867 867
868 868 IPython.OutputArea = OutputArea;
869 869
870 870 return IPython;
871 871
872 872 }(IPython));
General Comments 0
You need to be logged in to leave comments. Login now