1
/* IVLE - Informatics Virtual Learning Environment
2
* Copyright (C) 2007-2008 The University of Melbourne
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License as published by
6
* the Free Software Foundation; either version 2 of the License, or
7
* (at your option) any later version.
9
* This program is distributed in the hope that it will be useful,
10
* but WITHOUT ANY WARRANTY; without even the implied warranty of
11
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
* GNU General Public License for more details.
14
* You should have received a copy of the GNU General Public License
15
* along with this program; if not, write to the Free Software
16
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
* Module: Console (Client-side JavaScript)
19
* Author: Tom Conway, Matt Giuca
25
/* Begin religious debate (tabs vs spaces) here: */
26
/* (This string will be inserted in the console when the user presses the Tab
30
/* Console DOM objects */
32
console_filler = null;
34
windowpane_mode = false;
35
server_started = false;
39
/* Starts the console server, if it isn't already.
40
* This can be called any number of times - it only starts the one server.
41
* Note that this is asynchronous. It will return after signalling to start
42
* the server, but there is no guarantee that it has been started yet.
43
* This is a separate step from console_init, as the server is only to be
44
* started once the first command is entered.
45
* Does not return a value. Writes to global variables
46
* server_host, and server_port.
48
* \param callback Function which will be called after the server has been
49
* started. No parameters are passed. May be null.
51
function start_server(callback)
58
var callback1 = function(xhr)
60
var json_text = xhr.responseText;
61
server_key = JSON.parse(json_text).key;
62
server_started = true;
68
if((typeof(current_path) != 'undefined') && current_file)
70
// We have a current_path - give a suggestion to the server
72
if (current_file.isdir)
75
path = path_join("/home", current_path);
79
// Editor - need to chop off filename
80
var tmp_path = current_path.split('/');
82
path = path_join("/home", tmp_path.join('/'));
84
ajax_call(callback1, "console", "service", {"ivle.op": "start", "cwd": path}, "POST");
88
// No current_path - let the server decide
89
ajax_call(callback1, "console", "service", {"ivle.op": "start"}, "POST");
93
/** Initialises the console. All apps which import console are required to
95
* Optional "windowpane" (bool), if true, will cause the console to go into
96
* "window pane" mode which will allow it to be opened and closed, and float
98
* (Defaults to closed).
100
function console_init(windowpane)
102
/* Set up the console as a floating pane */
103
console_body = document.getElementById("console_body");
104
/* If there is no console body, don't worry.
105
* (This lets us import console.js even on pages without a console box */
106
if (console_body == null) return;
107
console_filler = document.getElementById("console_filler");
110
windowpane_mode = true;
115
/** Hide the main console panel, so the console minimizes to just an input box
116
* at the page bottom. */
117
function console_minimize()
119
if (!windowpane_mode) return;
120
console_body.setAttribute("class", "windowpane minimal");
121
console_filler.setAttribute("class", "windowpane minimal");
124
/** Show the main console panel, so it enlarges out to its full size.
126
function console_maximize()
128
if (!windowpane_mode) return;
129
console_body.setAttribute("class", "windowpane maximal");
130
console_filler.setAttribute("class", "windowpane maximal");
133
/* current_text is the string currently on the command line.
134
* If non-empty, it will be stored at the bottom of the history.
136
function historyUp(current_text)
138
/* Remember the changes made to this item */
139
this.edited[this.cursor] = current_text;
144
this.earliestCursor = this.cursor;
147
function historyDown(current_text)
149
/* Remember the changes made to this item */
150
this.edited[this.cursor] = current_text;
151
if (this.cursor < this.items.length - 1)
157
function historyCurr()
159
return this.edited[this.cursor];
162
function historySubmit(text)
164
/* Copy the selected item's "edited" version over the permanent version of
166
this.items[this.items.length-1] = text;
167
/* Add a new blank item */
168
this.items[this.items.length] = "";
169
this.cursor = this.items.length-1;
170
/* Blow away all the edited versions, replacing them with the existing
172
* Not the whole history - just start from the earliest edited one.
173
* (This avoids slowdown over extended usage time).
175
for (var i=this.earliestCursor; i<=this.cursor; i++)
176
this.edited[i] = this.items[i];
177
this.earliestCursor = this.cursor;
180
function historyShow()
183
for (var i = 0; i < this.items.length; i++)
185
if (i == this.cursor)
189
res += this.items[i].toString();
190
if (i == this.cursor)
196
if (this.cursor == this.items.length)
204
* This is a fairly complex mechanism due to complications when editing
205
* history items. We store two arrays. "items" is the permanent history of
206
* each item. "edited" is a "volatile" version of items - the edits made to
207
* the history between now and last time you hit "enter".
208
* This is because the user can go back and edit any of the previous items,
209
* and the edits are remembered until they hit enter.
211
* When hitting enter, the "edited" version of the currently selected item
212
* replaces the "item" version of the last item in the list.
213
* Then a new blank item is created, for the new line of input.
214
* Lastly, all the "edited" versions are replaced with their stable versions.
216
* Cursor never points to an invalid location.
220
this.items = new Array("");
221
this.edited = new Array("");
223
this.earliestCursor = 0;
225
this.down = historyDown;
226
this.curr = historyCurr;
227
this.submit = historySubmit;
228
this.show = historyShow;
231
var hist = new History();
233
function set_interrupt()
238
function clear_output()
240
var output = document.getElementById("console_output");
241
while (output.firstChild)
243
output.removeChild(output.firstChild);
247
/** Send a line of text to the Python server, wait for its return, and react
248
* to its response by writing to the output box.
249
* Also maximize the console window if not already.
251
function console_enter_line(inputbox, which)
255
if (typeof(inputbox) == "string")
257
var inputline = inputbox + "\n";
262
/* Disable the text box */
263
inputbox.setAttribute("disabled", "disabled");
265
var inputline = inputbox.value + "\n";
267
var output = document.getElementById("console_output");
270
var span = document.createElement("span");
271
span.setAttribute("class", "inputPrompt");
272
span.appendChild(document.createTextNode(
273
document.getElementById("console_prompt").firstChild.nodeValue)
275
output.appendChild(span);
276
// Print input line itself in a span
277
var span = document.createElement("span");
278
span.setAttribute("class", "inputMsg");
279
span.appendChild(document.createTextNode(inputline));
280
output.appendChild(span);
282
var args = {"ivle.op": "chat", "kind": which, "key": server_key, "text":inputline};
283
var callback = function(xhr)
285
console_response(inputbox, inputline, xhr.responseText);
287
ajax_call(callback, "console", "service", args, "POST");
290
function console_response(inputbox, inputline, responseText)
294
var res = JSON.parse(responseText);
298
alert("An internal error occurred in the python console.");
301
var output = document.getElementById("console_output");
302
if (res.hasOwnProperty('okay'))
307
output.appendChild(document.createTextNode(res.okay + "\n"));
308
output.appendChild(span);
310
// set the prompt to >>>
313
else if (res.hasOwnProperty('exc'))
316
// print out the error message (res.exc)
317
print_error(res.exc);
319
// set the prompt to >>>
322
else if (res.hasOwnProperty('restart') && res.hasOwnProperty('key'))
324
// Server has indicated that the console should be restarted
326
// Get the new key (host, port, magic)
327
server_key = res.key;
329
// Print a reason to explain why we'd do such a horrible thing
330
// (console timeout, server error etc.)
331
print_error("Console Restart: " + res.restart);
333
// set the prompt to >>>
336
else if (res.hasOwnProperty('more'))
338
// Need more input, so set the prompt to ...
341
else if (res.hasOwnProperty('output'))
343
if (res.output.length > 0)
345
output.appendChild(document.createTextNode(res.output));
347
var callback = function(xhr)
349
console_response(inputbox, null, xhr.responseText);
353
var kind = "interrupt";
359
var args = {"ivle.op": "chat", "kind": kind, "key": server_key, "text":''};
360
ajax_call(callback, "console", "service", args, "POST");
362
// Open up the console so we can see the output
363
// FIXME: do we need to maximize here?
367
divScroll.activeScroll();
369
// Return early, so we don't re-enable the input box.
374
// assert res.hasOwnProperty('input')
378
if (inputbox != null)
380
/* Re-enable the text box */
381
inputbox.removeAttribute("disabled");
385
/* Open up the console so we can see the output */
388
divScroll.activeScroll();
390
// Focus the input box by default
391
document.getElementById("console_output").focus();
392
document.getElementById("console_inputText").focus();
395
function catch_input(key)
397
var inp = document.getElementById('console_inputText');
400
case 9: /* Tab key */
401
var selstart = inp.selectionStart;
402
var selend = inp.selectionEnd;
403
if (selstart == selend)
405
/* No selection, just a carat. Insert a tab here. */
406
inp.value = inp.value.substr(0, selstart)
407
+ TAB_STRING + inp.value.substr(selstart);
411
/* Text is selected. Just indent the whole line
412
* by inserting a tab at the start */
413
inp.value = TAB_STRING + inp.value;
415
/* Update the selection so the same characters as before are selected
417
inp.selectionStart = selstart + TAB_STRING.length;
418
inp.selectionEnd = inp.selectionStart + (selend - selstart);
419
/* Cancel the event, so the TAB key doesn't move focus away from this
422
/* Note: If it happens that some browsers don't support event
423
* cancelling properly, this hack might work instead:
425
"document.getElementById('console_inputText').focus()",
429
case 13: /* Enter key */
430
var callback = function()
432
/* Send the line of text to the server */
433
console_enter_line(inp, "chat");
434
hist.submit(inp.value);
435
inp.value = hist.curr();
437
/* Start the server if it hasn't already been started */
438
start_server(callback);
440
case 38: /* Up arrow */
442
inp.value = hist.curr();
444
case 40: /* Down arrow */
445
hist.down(inp.value);
446
inp.value = hist.curr();
451
/** Resets the console by signalling the old console to expire and starting a
454
function console_reset()
456
// FIXME: We show some feedback here - either disable input or at very
457
// least the reset button.
459
// Restart the console
466
xhr = ajax_call(null, "console", "service", {"ivle.op": "chat", "kind": "terminate", "key": server_key}, "POST");
467
console_response(null, null, xhr.responseText);
471
/** Prints an error line in the console **/
472
function print_error(error)
474
var output = document.getElementById("console_output");
477
var span = document.createElement("span");
478
span.setAttribute("class", "errorMsg");
479
span.appendChild(document.createTextNode(error + "\n"));
480
output.appendChild(span);
483
divScroll.activeScroll();
486
/** Sets the prompt text **/
487
function set_prompt(prompt_text)
489
var prompt = document.getElementById("console_prompt");
490
prompt.replaceChild(document.createTextNode(prompt_text + " "), prompt.firstChild);
493
/**** Following Code modified from ******************************************/
494
/**** http://radio.javaranch.com/pascarello/2006/08/17/1155837038219.html ***/
495
/****************************************************************************/
496
var chatscroll = new Object();
498
chatscroll.Pane = function(scrollContainerId)
500
this.scrollContainerId = scrollContainerId;
503
chatscroll.Pane.prototype.activeScroll = function()
505
var scrollDiv = document.getElementById(this.scrollContainerId);
506
var currentHeight = 0;
508
if (scrollDiv.scrollHeight > 0)
509
currentHeight = scrollDiv.scrollHeight;
510
else if (scrollDiv.offsetHeight > 0)
511
currentHeight = scrollDiv.offsetHeight;
513
scrollDiv.scrollTop = currentHeight;
518
var divScroll = new chatscroll.Pane('console_output');
added
removed
ivle/webapp/console/media/console.js
