~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to www/media/console/console.js

  • Committer: mattgiuca
  • Date: 2008-01-11 00:49:06 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:172
util: Added buildurl function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/* IVLE - Informatics Virtual Learning Environment
2
 
 * Copyright (C) 2007-2008 The University of Melbourne
3
 
 *
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.
8
 
 *
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.
13
 
 *
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
17
 
 *
18
 
 * Module: Console (Client-side JavaScript)
19
 
 * Author: Tom Conway, Matt Giuca
20
 
 * Date: 30/1/2008
21
 
 */
22
 
 
23
 
var server_key;
24
 
 
25
 
/* Begin religious debate (tabs vs spaces) here: */
26
 
/* (This string will be inserted in the console when the user presses the Tab
27
 
 * key) */
28
 
TAB_STRING = "    ";
29
 
 
30
 
/* Console DOM objects */
31
 
console_body = null;
32
 
console_filler = null;
33
 
 
34
 
windowpane_mode = false;
35
 
server_started = false;
36
 
 
37
 
interrupted = false;
38
 
 
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.
47
 
 *
48
 
 * \param callback Function which will be called after the server has been
49
 
 * started. No parameters are passed. May be null.
50
 
 */
51
 
function start_server(callback)
52
 
{
53
 
    if (server_started)
54
 
    {
55
 
        callback();
56
 
        return;
57
 
    }
58
 
    var callback1 = function(xhr)
59
 
        {
60
 
            var json_text = xhr.responseText;
61
 
            server_key = JSON.parse(json_text);
62
 
            server_started = true;
63
 
            if (callback != null)
64
 
                callback();
65
 
        }
66
 
 
67
 
    //var current_path;
68
 
    if((typeof(current_path) != 'undefined') && current_file)
69
 
    {
70
 
        // We have a current_path - give a suggestion to the server
71
 
        var path;
72
 
        if (current_file.isdir)
73
 
        {
74
 
            // Browser
75
 
            path = path_join("/home", current_path);
76
 
        }
77
 
        else
78
 
        {
79
 
            // Editor - need to chop off filename
80
 
            var tmp_path = current_path.split('/');
81
 
            tmp_path.pop();
82
 
            path = path_join("/home", tmp_path.join('/'));
83
 
        }
84
 
        ajax_call(callback1, "consoleservice", "start", {"startdir": path}, "POST");
85
 
    }
86
 
    else
87
 
    {
88
 
        // No current_path - let the server decide
89
 
        ajax_call(callback1, "consoleservice", "start", {}, "POST");
90
 
    }
91
 
}
92
 
 
93
 
/** Initialises the console. All apps which import console are required to
94
 
 * call this function.
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
97
 
 * over the page.
98
 
 * (Defaults to closed).
99
 
 */
100
 
function console_init(windowpane)
101
 
{
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");
108
 
    if (windowpane)
109
 
    {
110
 
        windowpane_mode = true;
111
 
        console_minimize();
112
 
    }
113
 
}
114
 
 
115
 
/** Hide the main console panel, so the console minimizes to just an input box
116
 
 *  at the page bottom. */
117
 
function console_minimize()
118
 
{
119
 
    if (!windowpane_mode) return;
120
 
    console_body.setAttribute("class", "windowpane minimal");
121
 
    console_filler.setAttribute("class", "windowpane minimal");
122
 
}
123
 
 
124
 
/** Show the main console panel, so it enlarges out to its full size.
125
 
 */
126
 
function console_maximize()
127
 
{
128
 
    if (!windowpane_mode) return;
129
 
    console_body.setAttribute("class", "windowpane maximal");
130
 
    console_filler.setAttribute("class", "windowpane maximal");
131
 
}
132
 
 
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.
135
 
 */
136
 
function historyUp(current_text)
137
 
{
138
 
    /* Remember the changes made to this item */
139
 
    this.edited[this.cursor] = current_text;
140
 
    if (this.cursor > 0)
141
 
    {
142
 
        this.cursor--;
143
 
    }
144
 
    this.earliestCursor = this.cursor;
145
 
}
146
 
 
147
 
function historyDown(current_text)
148
 
{
149
 
    /* Remember the changes made to this item */
150
 
    this.edited[this.cursor] = current_text;
151
 
    if (this.cursor < this.items.length - 1)
152
 
    {
153
 
        this.cursor++;
154
 
    }
155
 
}
156
 
 
157
 
function historyCurr()
158
 
{
159
 
    return this.edited[this.cursor];
160
 
}
161
 
 
162
 
function historySubmit(text)
163
 
{
164
 
    /* Copy the selected item's "edited" version over the permanent version of
165
 
     * the last item. */
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
171
 
     * items set.
172
 
     * Not the whole history - just start from the earliest edited one.
173
 
     * (This avoids slowdown over extended usage time).
174
 
     */
175
 
    for (var i=this.earliestCursor; i<=this.cursor; i++)
176
 
        this.edited[i] = this.items[i];
177
 
    this.earliestCursor = this.cursor;
178
 
}
179
 
 
180
 
function historyShow()
181
 
{
182
 
    var res = "";
183
 
    for (var i = 0; i < this.items.length; i++)
184
 
    {
185
 
        if (i == this.cursor)
186
 
        {
187
 
            res += "["
188
 
        }
189
 
        res += this.items[i].toString();
190
 
        if (i == this.cursor)
191
 
        {
192
 
            res += "]"
193
 
        }
194
 
        res += " "
195
 
    }
196
 
    if (this.cursor == this.items.length)
197
 
    {
198
 
        res += "[]";
199
 
    }
200
 
    return res;
201
 
}
202
 
 
203
 
/* How history works
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.
210
 
 *
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.
215
 
 *
216
 
 * Cursor never points to an invalid location.
217
 
 */
218
 
function History()
219
 
{
220
 
    this.items = new Array("");
221
 
    this.edited = new Array("");
222
 
    this.cursor = 0;
223
 
    this.earliestCursor = 0;
224
 
    this.up = historyUp;
225
 
    this.down = historyDown;
226
 
    this.curr = historyCurr;
227
 
    this.submit = historySubmit;
228
 
    this.show = historyShow;
229
 
}
230
 
 
231
 
var hist = new History();
232
 
 
233
 
function set_interrupt()
234
 
{
235
 
    interrupted = true;
236
 
}
237
 
 
238
 
function clear_output()
239
 
{
240
 
    var output = document.getElementById("console_output");
241
 
    while (output.firstChild)
242
 
    {
243
 
        output.removeChild(output.firstChild);
244
 
    }
245
 
}
246
 
 
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.
250
 
 */
251
 
function console_enter_line(inputbox, which)
252
 
{
253
 
    interrupted = false;
254
 
 
255
 
    if (typeof(inputbox) == "string")
256
 
    {
257
 
        var inputline = inputbox;
258
 
        inputbox = null;
259
 
        var graytimer = null;
260
 
    }
261
 
    else
262
 
    {
263
 
        GLOBAL_inputbox = inputbox;     /* For timer */
264
 
        var inputline = inputbox.value;
265
 
        var graytimer = setTimeout("GLOBAL_inputbox.setAttribute(\"class\", "
266
 
            + "\"disabled\");", 100);
267
 
    }
268
 
    var output = document.getElementById("console_output");
269
 
    {
270
 
        // Print ">>>" span
271
 
        var span = document.createElement("span");
272
 
        span.setAttribute("class", "inputPrompt");
273
 
        span.appendChild(document.createTextNode(">>> "));
274
 
        output.appendChild(span);
275
 
        // Print input line itself in a span
276
 
        var span = document.createElement("span");
277
 
        span.setAttribute("class", "inputMsg");
278
 
        span.appendChild(document.createTextNode(inputline + "\n"));
279
 
        output.appendChild(span);
280
 
    }
281
 
    var args = {"key": server_key, "text":inputline};
282
 
    var callback = function(xhr)
283
 
        {
284
 
            console_response(inputbox, graytimer, inputline, xhr.responseText);
285
 
        }
286
 
    /* Disable the text box */
287
 
    if (inputbox != null)
288
 
        inputbox.setAttribute("disabled", "disabled");
289
 
    ajax_call(callback, "consoleservice", which, args, "POST");
290
 
}
291
 
 
292
 
function console_response(inputbox, graytimer, inputline, responseText)
293
 
{
294
 
    try
295
 
    {
296
 
        var res = JSON.parse(responseText);
297
 
    }
298
 
    catch (e)
299
 
    {
300
 
        alert("An internal error occurred in the python console.");
301
 
        return;
302
 
    }
303
 
    var output = document.getElementById("console_output");
304
 
    if (res.hasOwnProperty('okay'))
305
 
    {
306
 
        // Success!
307
 
        if (res.okay)
308
 
        {
309
 
            output.appendChild(document.createTextNode(res.okay + "\n"));
310
 
            output.appendChild(span);
311
 
        }
312
 
        // set the prompt to >>>
313
 
        set_prompt(">>>");
314
 
    }
315
 
    else if (res.hasOwnProperty('exc'))
316
 
    {
317
 
        // Failure!
318
 
        // print out the error message (res.exc)
319
 
        print_error(res.exc);
320
 
        
321
 
        // set the prompt to >>>
322
 
        set_prompt(">>>");
323
 
    }
324
 
    else if (res.hasOwnProperty('restart') && res.hasOwnProperty('key'))
325
 
    {
326
 
        // Server has indicated that the console should be restarted
327
 
        
328
 
        // Get the new key (host, port, magic)
329
 
        server_key = res.key;
330
 
 
331
 
        // Print a reason to explain why we'd do such a horrible thing
332
 
        // (console timeout, server error etc.)
333
 
        print_error("Console Restart: " + res.restart);
334
 
        
335
 
        // set the prompt to >>>
336
 
        set_prompt(">>>");
337
 
    }
338
 
    else if (res.hasOwnProperty('more'))
339
 
    {
340
 
        // Need more input, so set the prompt to ...
341
 
        set_prompt("...");
342
 
    }
343
 
    else if (res.hasOwnProperty('output'))
344
 
    {
345
 
        if (res.output.length > 0)
346
 
        {
347
 
            output.appendChild(document.createTextNode(res.output));
348
 
        }
349
 
        var callback = function(xhr)
350
 
            {
351
 
                console_response(inputbox, graytimer,
352
 
                                 null, xhr.responseText);
353
 
            }
354
 
        if (interrupted)
355
 
        {
356
 
            var kind = "interrupt";
357
 
        }
358
 
        else
359
 
        {
360
 
            var kind = "chat";
361
 
        }
362
 
        var args = {"key": server_key, "text":''};
363
 
        ajax_call(callback, "consoleservice", kind, args, "POST");
364
 
 
365
 
        // Open up the console so we can see the output
366
 
        // FIXME: do we need to maximize here?
367
 
        console_maximize();
368
 
 
369
 
        /* Auto-scrolling */
370
 
        divScroll.activeScroll();
371
 
 
372
 
        // Return early, so we don't re-enable the input box.
373
 
        return;
374
 
    }
375
 
    else
376
 
    {
377
 
        // assert res.hasOwnProperty('input')
378
 
        set_prompt("...");
379
 
    }
380
 
 
381
 
    if (inputbox != null)
382
 
    {
383
 
        /* Re-enable the text box */
384
 
        clearTimeout(graytimer);
385
 
        inputbox.removeAttribute("disabled");
386
 
        inputbox.removeAttribute("class");
387
 
        interrupted = false;
388
 
    }
389
 
 
390
 
    /* Open up the console so we can see the output */
391
 
    console_maximize();
392
 
    /* Auto-scrolling */
393
 
    divScroll.activeScroll();
394
 
 
395
 
    // Focus the input box by default
396
 
    document.getElementById("console_output").focus();
397
 
    document.getElementById("console_inputText").focus();
398
 
}
399
 
 
400
 
function catch_input(key)
401
 
{
402
 
    var inp = document.getElementById('console_inputText');
403
 
    switch (key)
404
 
    {
405
 
    case 9:                 /* Tab key */
406
 
        var selstart = inp.selectionStart;
407
 
        var selend = inp.selectionEnd;
408
 
        if (selstart == selend)
409
 
        {
410
 
            /* No selection, just a carat. Insert a tab here. */
411
 
            inp.value = inp.value.substr(0, selstart)
412
 
                + TAB_STRING + inp.value.substr(selstart);
413
 
        }
414
 
        else
415
 
        {
416
 
            /* Text is selected. Just indent the whole line
417
 
             * by inserting a tab at the start */
418
 
            inp.value = TAB_STRING + inp.value;
419
 
        }
420
 
        /* Update the selection so the same characters as before are selected
421
 
         */
422
 
        inp.selectionStart = selstart + TAB_STRING.length;
423
 
        inp.selectionEnd = inp.selectionStart + (selend - selstart);
424
 
        /* Cancel the event, so the TAB key doesn't move focus away from this
425
 
         * box */
426
 
        return false;
427
 
        /* Note: If it happens that some browsers don't support event
428
 
         * cancelling properly, this hack might work instead:
429
 
        setTimeout(
430
 
            "document.getElementById('console_inputText').focus()",
431
 
            0);
432
 
         */
433
 
        break;
434
 
    case 13:                /* Enter key */
435
 
        var callback = function()
436
 
        {
437
 
            /* Send the line of text to the server */
438
 
            console_enter_line(inp, "chat");
439
 
            hist.submit(inp.value);
440
 
            inp.value = hist.curr();
441
 
        }
442
 
        /* Start the server if it hasn't already been started */
443
 
        start_server(callback);
444
 
        break;
445
 
    case 38:                /* Up arrow */
446
 
        hist.up(inp.value);
447
 
        inp.value = hist.curr();
448
 
        break;
449
 
    case 40:                /* Down arrow */
450
 
        hist.down(inp.value);
451
 
        inp.value = hist.curr();
452
 
        break;
453
 
    }
454
 
}
455
 
 
456
 
/** Resets the console by signalling the old console to expire and starting a 
457
 
 * new one.
458
 
 */
459
 
function console_reset()
460
 
{
461
 
    // FIXME: We show some feedback here - either disable input or at very 
462
 
    // least the reset button.
463
 
 
464
 
    // Restart the console
465
 
    if(!server_started)
466
 
    {
467
 
        start_server(null);
468
 
    }
469
 
    else
470
 
    {
471
 
        xhr = ajax_call(null, "consoleservice", "restart", {"key": server_key}, "POST");
472
 
        console_response(null, null, null, xhr.responseText);
473
 
    }
474
 
}
475
 
 
476
 
/** Prints an error line in the console **/
477
 
function print_error(error)
478
 
479
 
    var output = document.getElementById("console_output");
480
 
  
481
 
    // Create text block
482
 
    var span = document.createElement("span");
483
 
    span.setAttribute("class", "errorMsg");
484
 
    span.appendChild(document.createTextNode(error + "\n"));
485
 
    output.appendChild(span);
486
 
 
487
 
    // Autoscroll
488
 
    divScroll.activeScroll();
489
 
}
490
 
 
491
 
/** Sets the prompt text **/
492
 
function set_prompt(prompt_text)
493
 
{
494
 
    var prompt = document.getElementById("console_prompt");
495
 
    prompt.replaceChild(document.createTextNode(prompt_text + " "), prompt.firstChild);
496
 
}
497
 
 
498
 
/**** Following Code modified from ******************************************/
499
 
/**** http://radio.javaranch.com/pascarello/2006/08/17/1155837038219.html ***/
500
 
/****************************************************************************/
501
 
var chatscroll = new Object();
502
 
 
503
 
chatscroll.Pane = function(scrollContainerId)
504
 
{
505
 
    this.scrollContainerId = scrollContainerId;
506
 
}
507
 
 
508
 
chatscroll.Pane.prototype.activeScroll = function()
509
 
{
510
 
    var scrollDiv = document.getElementById(this.scrollContainerId);
511
 
    var currentHeight = 0;
512
 
        
513
 
    if (scrollDiv.scrollHeight > 0)
514
 
        currentHeight = scrollDiv.scrollHeight;
515
 
    else if (scrollDiv.offsetHeight > 0)
516
 
        currentHeight = scrollDiv.offsetHeight;
517
 
 
518
 
    scrollDiv.scrollTop = currentHeight;
519
 
 
520
 
    scrollDiv = null;
521
 
}
522
 
 
523
 
var divScroll = new chatscroll.Pane('console_output');