← Back to branch summary

~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-03-01 01:59:10 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:630
subjects: Added subjects/subjects.css to correctly style the iframe.
    Added "sample" subject home page with minimal instructions on how to make
    a subject home page.
    Link to subjects.css.
Set svn:ignore on apps/subjects and apps/home (*.pyc).

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/media/console/console.js
 
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
    ajax_call(callback1, "consoleservice", "start", {}, "POST");
 
67
}
 
68
 
 
69
/** Initialises the console. All apps which import console are required to
 
70
 * call this function.
 
71
 * Optional "windowpane" (bool), if true, will cause the console to go into
 
72
 * "window pane" mode which will allow it to be opened and closed, and float
 
73
 * over the page.
 
74
 * (Defaults to closed).
 
75
 */
 
76
function console_init(windowpane)
 
77
{
 
78
    /* Set up the console as a floating pane */
 
79
    console_body = document.getElementById("console_body");
 
80
    /* If there is no console body, don't worry.
 
81
     * (This lets us import console.js even on pages without a console box */
 
82
    if (console_body == null) return;
 
83
    console_filler = document.getElementById("console_filler");
 
84
    if (windowpane)
 
85
    {
 
86
        windowpane_mode = true;
 
87
        console_minimize();
 
88
    }
 
89
    /* TEMP: Start the server now.
 
90
     * Ultimately we want the server to start only when a line is typed, but
 
91
     * it currently does it asynchronously and doesn't start in time for the
 
92
     * first line. */
 
93
    start_server();
 
94
}
 
95
 
 
96
/** Hide the main console panel, so the console minimizes to just an input box
 
97
 *  at the page bottom. */
 
98
function console_minimize()
 
99
{
 
100
    if (!windowpane_mode) return;
 
101
    console_body.setAttribute("class", "windowpane minimal");
 
102
    console_filler.setAttribute("class", "windowpane minimal");
 
103
}
 
104
 
 
105
/** Show the main console panel, so it enlarges out to its full size.
 
106
 */
 
107
function console_maximize()
 
108
{
 
109
    if (!windowpane_mode) return;
 
110
    console_body.setAttribute("class", "windowpane maximal");
 
111
    console_filler.setAttribute("class", "windowpane maximal");
 
112
}
 
113
 
 
114
/* current_text is the string currently on the command line.
 
115
 * If non-empty, it will be stored at the bottom of the history.
 
116
 */
 
117
function historyUp(current_text)
 
118
{
 
119
    /* Remember the changes made to this item */
 
120
    this.edited[this.cursor] = current_text;
 
121
    if (this.cursor > 0)
 
122
    {
 
123
        this.cursor--;
 
124
    }
 
125
    this.earliestCursor = this.cursor;
 
126
}
 
127
 
 
128
function historyDown(current_text)
 
129
{
 
130
    /* Remember the changes made to this item */
 
131
    this.edited[this.cursor] = current_text;
 
132
    if (this.cursor < this.items.length - 1)
 
133
    {
 
134
        this.cursor++;
 
135
    }
 
136
}
 
137
 
 
138
function historyCurr()
 
139
{
 
140
    return this.edited[this.cursor];
 
141
}
 
142
 
 
143
function historySubmit(text)
 
144
{
 
145
    /* Copy the selected item's "edited" version over the permanent version of
 
146
     * the last item. */
 
147
    this.items[this.items.length-1] = text;
 
148
    /* Add a new blank item */
 
149
    this.items[this.items.length] = "";
 
150
    this.cursor = this.items.length-1;
 
151
    /* Blow away all the edited versions, replacing them with the existing
 
152
     * items set.
 
153
     * Not the whole history - just start from the earliest edited one.
 
154
     * (This avoids slowdown over extended usage time).
 
155
     */
 
156
    for (var i=this.earliestCursor; i<=this.cursor; i++)
 
157
        this.edited[i] = this.items[i];
 
158
    this.earliestCursor = this.cursor;
 
159
}
 
160
 
 
161
function historyShow()
 
162
{
 
163
    var res = "";
 
164
    for (var i = 0; i < this.items.length; i++)
 
165
    {
 
166
        if (i == this.cursor)
 
167
        {
 
168
            res += "["
 
169
        }
 
170
        res += this.items[i].toString();
 
171
        if (i == this.cursor)
 
172
        {
 
173
            res += "]"
 
174
        }
 
175
        res += " "
 
176
    }
 
177
    if (this.cursor == this.items.length)
 
178
    {
 
179
        res += "[]";
 
180
    }
 
181
    return res;
 
182
}
 
183
 
 
184
/* How history works
 
185
 * This is a fairly complex mechanism due to complications when editing
 
186
 * history items. We store two arrays. "items" is the permanent history of
 
187
 * each item. "edited" is a "volatile" version of items - the edits made to
 
188
 * the history between now and last time you hit "enter".
 
189
 * This is because the user can go back and edit any of the previous items,
 
190
 * and the edits are remembered until they hit enter.
 
191
 *
 
192
 * When hitting enter, the "edited" version of the currently selected item
 
193
 * replaces the "item" version of the last item in the list.
 
194
 * Then a new blank item is created, for the new line of input.
 
195
 * Lastly, all the "edited" versions are replaced with their stable versions.
 
196
 *
 
197
 * Cursor never points to an invalid location.
 
198
 */
 
199
function History()
 
200
{
 
201
    this.items = new Array("");
 
202
    this.edited = new Array("");
 
203
    this.cursor = 0;
 
204
    this.earliestCursor = 0;
 
205
    this.up = historyUp;
 
206
    this.down = historyDown;
 
207
    this.curr = historyCurr;
 
208
    this.submit = historySubmit;
 
209
    this.show = historyShow;
 
210
}
 
211
 
 
212
var hist = new History();
 
213
 
 
214
function set_interrupt()
 
215
{
 
216
    interrupted = true;
 
217
}
 
218
 
 
219
function clear_output()
 
220
{
 
221
    var output = document.getElementById("console_output");
 
222
    while (output.firstChild)
 
223
    {
 
224
        output.removeChild(output.firstChild);
 
225
    }
 
226
}
 
227
 
 
228
/** Send a line of text to the Python server, wait for its return, and react
 
229
 * to its response by writing to the output box.
 
230
 * Also maximize the console window if not already.
 
231
 */
 
232
function console_enter_line(inputbox, which)
 
233
{
 
234
    interrupted = false;
 
235
 
 
236
    if (typeof(inputbox) == "string")
 
237
    {
 
238
        var inputline = inputbox;
 
239
        inputbox = null;
 
240
        var graytimer = null;
 
241
    }
 
242
    else
 
243
    {
 
244
        GLOBAL_inputbox = inputbox;     /* For timer */
 
245
        var inputline = inputbox.value;
 
246
        var graytimer = setTimeout("GLOBAL_inputbox.setAttribute(\"class\", "
 
247
            + "\"disabled\");", 100);
 
248
    }
 
249
    var output = document.getElementById("console_output");
 
250
    {
 
251
        var span = document.createElement("span");
 
252
        span.setAttribute("class", "inputMsg");
 
253
        span.appendChild(document.createTextNode(inputline + "\n"));
 
254
        output.appendChild(span);
 
255
    }
 
256
    var args = {"key": server_key, "text":inputline};
 
257
    var callback = function(xhr)
 
258
        {
 
259
            console_response(inputbox, graytimer, inputline, xhr.responseText);
 
260
        }
 
261
    /* Disable the text box */
 
262
    if (inputbox != null)
 
263
        inputbox.setAttribute("disabled", "disabled");
 
264
    ajax_call(callback, "consoleservice", which, args, "POST");
 
265
}
 
266
 
 
267
function console_response(inputbox, graytimer, inputline, responseText)
 
268
{
 
269
    var res = JSON.parse(responseText);
 
270
    var output = document.getElementById("console_output");
 
271
    if (res.hasOwnProperty('okay'))
 
272
    {
 
273
        // Success!
 
274
        if (res.okay)
 
275
        {
 
276
            output.appendChild(document.createTextNode(res.okay + "\n"));
 
277
            output.appendChild(span);
 
278
        }
 
279
        // set the prompt to >>>
 
280
        var prompt = document.getElementById("console_prompt");
 
281
        prompt.replaceChild(document.createTextNode(">>> "), prompt.firstChild);
 
282
    }
 
283
    else if (res.hasOwnProperty('exc'))
 
284
    {
 
285
        // Failure!
 
286
        // print out the error message (res.exc)
 
287
        var span = document.createElement("span");
 
288
        span.setAttribute("class", "errorMsg");
 
289
        span.appendChild(document.createTextNode(res.exc + "\n"));
 
290
        output.appendChild(span);
 
291
    }
 
292
    else if (res.hasOwnProperty('more'))
 
293
    {
 
294
        // Need more input, so set the prompt to ...
 
295
        var prompt = document.getElementById("console_prompt");
 
296
        prompt.replaceChild(document.createTextNode("... "), prompt.firstChild);
 
297
    }
 
298
    else if (res.hasOwnProperty('output'))
 
299
    {
 
300
        if (res.output.length > 0)
 
301
        {
 
302
            output.appendChild(document.createTextNode(res.output));
 
303
        }
 
304
        var callback = function(xhr)
 
305
            {
 
306
                console_response(inputbox, graytimer,
 
307
                                 null, xhr.responseText);
 
308
            }
 
309
        if (interrupted)
 
310
        {
 
311
            var kind = "interrupt";
 
312
        }
 
313
        else
 
314
        {
 
315
            var kind = "chat";
 
316
        }
 
317
        var args = {"key": server_key, "text":''};
 
318
        ajax_call(callback, "consoleservice", kind, args, "POST");
 
319
 
 
320
        // Open up the console so we can see the output
 
321
        // FIXME: do we need to maximize here?
 
322
        console_maximize();
 
323
 
 
324
        /* Auto-scrolling */
 
325
        divScroll.activeScroll();
 
326
 
 
327
        // Return early, so we don't re-enable the input box.
 
328
        return;
 
329
    }
 
330
    else {
 
331
        // assert res.hasOwnProperty('input')
 
332
        var prompt = document.getElementById("console_prompt");
 
333
        prompt.replaceChild(document.createTextNode("+++ "), prompt.firstChild);
 
334
    }
 
335
 
 
336
    if (inputbox != null)
 
337
    {
 
338
        /* Re-enable the text box */
 
339
        clearTimeout(graytimer);
 
340
        inputbox.removeAttribute("disabled");
 
341
        inputbox.removeAttribute("class");
 
342
        interrupted = false;
 
343
    }
 
344
 
 
345
    /* Open up the console so we can see the output */
 
346
    console_maximize();
 
347
    /* Auto-scrolling */
 
348
    divScroll.activeScroll();
 
349
 
 
350
    // Focus the input box by default
 
351
    // document.getElementById("console_inputText").focus()
 
352
}
 
353
 
 
354
function catch_input(key)
 
355
{
 
356
    var inp = document.getElementById('console_inputText');
 
357
    switch (key)
 
358
    {
 
359
    case 9:                 /* Tab key */
 
360
        var selstart = inp.selectionStart;
 
361
        var selend = inp.selectionEnd;
 
362
        if (selstart == selend)
 
363
        {
 
364
            /* No selection, just a carat. Insert a tab here. */
 
365
            inp.value = inp.value.substr(0, selstart)
 
366
                + TAB_STRING + inp.value.substr(selstart);
 
367
        }
 
368
        else
 
369
        {
 
370
            /* Text is selected. Just indent the whole line
 
371
             * by inserting a tab at the start */
 
372
            inp.value = TAB_STRING + inp.value;
 
373
        }
 
374
        /* Update the selection so the same characters as before are selected
 
375
         */
 
376
        inp.selectionStart = selstart + TAB_STRING.length;
 
377
        inp.selectionEnd = inp.selectionStart + (selend - selstart);
 
378
        /* Cancel the event, so the TAB key doesn't move focus away from this
 
379
         * box */
 
380
        return false;
 
381
        /* Note: If it happens that some browsers don't support event
 
382
         * cancelling properly, this hack might work instead:
 
383
        setTimeout(
 
384
            "document.getElementById('console_inputText').focus()",
 
385
            0);
 
386
         */
 
387
        break;
 
388
    case 13:                /* Enter key */
 
389
        var callback = function()
 
390
        {
 
391
            /* Send the line of text to the server */
 
392
            console_enter_line(inp, "chat");
 
393
            hist.submit(inp.value);
 
394
            inp.value = hist.curr();
 
395
        }
 
396
        /* Start the server if it hasn't already been started */
 
397
        start_server(callback);
 
398
        break;
 
399
    case 38:                /* Up arrow */
 
400
        hist.up(inp.value);
 
401
        inp.value = hist.curr();
 
402
        break;
 
403
    case 40:                /* Down arrow */
 
404
        hist.down(inp.value);
 
405
        inp.value = hist.curr();
 
406
        break;
 
407
    }
 
408
}
 
409
 
 
410
/**** Following Code modified from ******************************************/
 
411
/**** http://radio.javaranch.com/pascarello/2006/08/17/1155837038219.html ***/
 
412
/****************************************************************************/
 
413
var chatscroll = new Object();
 
414
 
 
415
chatscroll.Pane = function(scrollContainerId)
 
416
{
 
417
    this.scrollContainerId = scrollContainerId;
 
418
}
 
419
 
 
420
chatscroll.Pane.prototype.activeScroll = function()
 
421
{
 
422
    var scrollDiv = document.getElementById(this.scrollContainerId);
 
423
    var currentHeight = 0;
 
424
        
 
425
    if (scrollDiv.scrollHeight > 0)
 
426
        currentHeight = scrollDiv.scrollHeight;
 
427
    else 
 
428
        if (objDiv.offsetHeight > 0)
 
429
            currentHeight = scrollDiv.offsetHeight;
 
430
 
 
431
    scrollDiv.scrollTop = currentHeight;
 
432
 
 
433
    scrollDiv = null;
 
434
}
 
435
 
 
436
var divScroll = new chatscroll.Pane('console_output');