← 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-02-18 00:32:43 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:487
setup.py: Added code to convert usrmgt_port into an int before writing to conf
    (and checking). Same as db_port.
userservice: Now uses config'd values for usrmgt settings instead of
    hard-coded.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/media/console/console.js
1
 
digest_constant = "hello";
2
 
 
3
 
var server_host;
4
 
var server_port;
5
 
var server_magic;
6
 
 
7
 
/* Starts the console server.
8
 
 * Returns an object with fields "host", "port", "magic" describing the
9
 
 * server.
 
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
/* Starts the console server, if it isn't already.
 
38
 * This can be called any number of times - it only starts the one server.
 
39
 * This is a separate step from console_init, as the server is only to be
 
40
 * started once the first command is entered.
 
41
 * Does not return a value. Writes to global variables
 
42
 * server_host, and server_port.
10
43
 */
11
44
function start_server()
12
45
{
 
46
    if (server_started) return;
13
47
    var xhr = ajax_call("consoleservice", "start", {}, "POST");
14
48
    var json_text = xhr.responseText;
15
 
    return JSON.parse(json_text);
16
 
}
17
 
 
18
 
function onload()
19
 
{
20
 
    /* Start the server */
21
 
    var server_info = start_server();
22
 
    server_host = server_info.host;
23
 
    server_port = server_info.port;
24
 
    server_magic = server_info.magic;
25
 
}
26
 
 
27
 
/* Below here imported from trunk/console/console.js
28
 
 * (Tom Conway)
29
 
 */
30
 
 
31
 
var magic = 'xyzzy';
32
 
 
33
 
function historyUp()
34
 
{
35
 
    if (this.cursor >= 0)
 
49
    server_key = JSON.parse(json_text);
 
50
    server_started = true;
 
51
}
 
52
 
 
53
/** Initialises the console. All apps which import console are required to
 
54
 * call this function.
 
55
 * Optional "windowpane" (bool), if true, will cause the console to go into
 
56
 * "window pane" mode which will allow it to be opened and closed, and float
 
57
 * over the page.
 
58
 * (Defaults to closed).
 
59
 */
 
60
function console_init(windowpane)
 
61
{
 
62
    /* Set up the console as a floating pane */
 
63
    console_body = document.getElementById("console_body");
 
64
    /* If there is no console body, don't worry.
 
65
     * (This lets us import console.js even on pages without a console box */
 
66
    if (console_body == null) return;
 
67
    console_filler = document.getElementById("console_filler");
 
68
    if (windowpane)
 
69
    {
 
70
        windowpane_mode = true;
 
71
        console_minimize();
 
72
    }
 
73
    /* TEMP: Start the server now.
 
74
     * Ultimately we want the server to start only when a line is typed, but
 
75
     * it currently does it asynchronously and doesn't start in time for the
 
76
     * first line. */
 
77
    start_server();
 
78
}
 
79
 
 
80
/** Hide the main console panel, so the console minimizes to just an input box
 
81
 *  at the page bottom. */
 
82
function console_minimize()
 
83
{
 
84
    if (!windowpane_mode) return;
 
85
    console_body.setAttribute("class", "windowpane minimal");
 
86
    console_filler.setAttribute("class", "windowpane minimal");
 
87
}
 
88
 
 
89
/** Show the main console panel, so it enlarges out to its full size.
 
90
 */
 
91
function console_maximize()
 
92
{
 
93
    if (!windowpane_mode) return;
 
94
    console_body.setAttribute("class", "windowpane maximal");
 
95
    console_filler.setAttribute("class", "windowpane maximal");
 
96
    /* Focus the input box by default */
 
97
    document.getElementById("console_inputText").focus()
 
98
}
 
99
 
 
100
/* current_text is the string currently on the command line.
 
101
 * If non-empty, it will be stored at the bottom of the history.
 
102
 */
 
103
function historyUp(current_text)
 
104
{
 
105
    /* Remember the changes made to this item */
 
106
    this.edited[this.cursor] = current_text;
 
107
    if (this.cursor > 0)
36
108
    {
37
109
        this.cursor--;
38
110
    }
 
111
    this.earliestCursor = this.cursor;
39
112
}
40
113
 
41
 
function historyDown()
 
114
function historyDown(current_text)
42
115
{
43
 
    if (this.cursor < this.items.length)
 
116
    /* Remember the changes made to this item */
 
117
    this.edited[this.cursor] = current_text;
 
118
    if (this.cursor < this.items.length - 1)
44
119
    {
45
120
        this.cursor++;
46
121
    }
48
123
 
49
124
function historyCurr()
50
125
{
51
 
    if (this.cursor < 0 || this.cursor >= this.items.length)
52
 
    {
53
 
        return "";
54
 
    }
55
 
    return this.items[this.cursor];
 
126
    return this.edited[this.cursor];
56
127
}
57
128
 
58
 
function historyAdd(text)
 
129
function historySubmit(text)
59
130
{
60
 
    this.items[this.items.length] = text;
61
 
    this.cursor = this.items.length;
 
131
    /* Copy the selected item's "edited" version over the permanent version of
 
132
     * the last item. */
 
133
    this.items[this.items.length-1] = text;
 
134
    /* Add a new blank item */
 
135
    this.items[this.items.length] = "";
 
136
    this.cursor = this.items.length-1;
 
137
    /* Blow away all the edited versions, replacing them with the existing
 
138
     * items set.
 
139
     * Not the whole history - just start from the earliest edited one.
 
140
     * (This avoids slowdown over extended usage time).
 
141
     */
 
142
    for (var i=this.earliestCursor; i<=this.cursor; i++)
 
143
        this.edited[i] = this.items[i];
 
144
    this.earliestCursor = this.cursor;
62
145
}
63
146
 
64
147
function historyShow()
65
148
{
66
149
    var res = "";
67
 
    if (this.cursor == -1)
68
 
    {
69
 
        res += "[]";
70
 
    }
71
150
    for (var i = 0; i < this.items.length; i++)
72
151
    {
73
152
        if (i == this.cursor)
88
167
    return res;
89
168
}
90
169
 
 
170
/* How history works
 
171
 * This is a fairly complex mechanism due to complications when editing
 
172
 * history items. We store two arrays. "items" is the permanent history of
 
173
 * each item. "edited" is a "volatile" version of items - the edits made to
 
174
 * the history between now and last time you hit "enter".
 
175
 * This is because the user can go back and edit any of the previous items,
 
176
 * and the edits are remembered until they hit enter.
 
177
 *
 
178
 * When hitting enter, the "edited" version of the currently selected item
 
179
 * replaces the "item" version of the last item in the list.
 
180
 * Then a new blank item is created, for the new line of input.
 
181
 * Lastly, all the "edited" versions are replaced with their stable versions.
 
182
 *
 
183
 * Cursor never points to an invalid location.
 
184
 */
91
185
function History()
92
186
{
93
 
    this.items = new Array();
94
 
    this.cursor = -1;
 
187
    this.items = new Array("");
 
188
    this.edited = new Array("");
 
189
    this.cursor = 0;
 
190
    this.earliestCursor = 0;
95
191
    this.up = historyUp;
96
192
    this.down = historyDown;
97
193
    this.curr = historyCurr;
98
 
    this.add = historyAdd;
 
194
    this.submit = historySubmit;
99
195
    this.show = historyShow;
100
196
}
101
197
 
102
198
var hist = new History();
103
199
 
104
 
function enter_line()
 
200
/** Send a line of text to the Python server, wait for its return, and react
 
201
 * to its response by writing to the output box.
 
202
 * Also maximize the console window if not already.
 
203
 */
 
204
function console_enter_line(inputline, which)
105
205
{
106
 
    var inp = document.getElementById('inputText');
107
 
    var digest = hex_md5(inp.value + magic);
108
 
    var args = {"host": server_host, "port": server_port,
109
 
                    "digest":digest, "text":inp.value};
110
 
    var xmlhttp = ajax_call("consoleservice", "chat", args, "POST");
 
206
    /* Start the server if it hasn't already been started */
 
207
    start_server();
 
208
    var args = {"key": server_key, "text":inputline};
 
209
    var xmlhttp = ajax_call("consoleservice", which, args, "POST");
111
210
 
112
211
    var res = JSON.parse(xmlhttp.responseText);
113
 
    var output = document.getElementById("output");
 
212
    var output = document.getElementById("console_output");
114
213
    {
115
214
        var pre = document.createElement("pre");
116
215
        pre.setAttribute("class", "inputMsg");
117
 
        pre.appendChild(document.createTextNode(inp.value + "\n"));
 
216
        pre.appendChild(document.createTextNode(inputline + "\n"));
118
217
        output.appendChild(pre);
119
218
    }
120
219
    if (res.hasOwnProperty('okay'))
134
233
            output.appendChild(pre);
135
234
        }
136
235
        // set the prompt to >>>
137
 
        var prompt = document.getElementById("prompt");
 
236
        var prompt = document.getElementById("console_prompt");
138
237
        prompt.replaceChild(document.createTextNode(">>> "), prompt.firstChild);
139
238
    }
140
239
    else if (res.hasOwnProperty('exc'))
141
240
    {
142
241
        // Failure!
 
242
        // print out any output that came before the error
 
243
        if (res.exc[0].length > 0)
 
244
        {
 
245
            var pre = document.createElement("pre");
 
246
            pre.setAttribute("class", "outputMsg");
 
247
            pre.appendChild(document.createTextNode(res.exc[0]));
 
248
            output.appendChild(pre);
 
249
        }
 
250
 
143
251
        // print out the error message (res.exc)
144
252
        var pre = document.createElement("pre");
145
253
        pre.setAttribute("class", "errorMsg");
146
 
        pre.appendChild(document.createTextNode(res.exc));
 
254
        pre.appendChild(document.createTextNode(res.exc[1]));
147
255
        output.appendChild(pre);
148
256
    }
149
257
    else if (res.hasOwnProperty('more'))
150
258
    {
151
259
        // Need more input, so set the prompt to ...
152
 
        var prompt = document.getElementById("prompt");
 
260
        var prompt = document.getElementById("console_prompt");
153
261
        prompt.replaceChild(document.createTextNode("... "), prompt.firstChild);
154
262
    }
155
263
    else {
156
264
        // assert res.hasOwnProperty('input')
157
 
        var prompt = document.getElementById("prompt");
 
265
        var prompt = document.getElementById("console_prompt");
158
266
        prompt.replaceChild(document.createTextNode("+++ "), prompt.firstChild);
159
267
    }
 
268
    /* Open up the console so we can see the output */
 
269
    console_maximize();
160
270
}
161
271
 
162
272
function catch_input(key)
163
273
{
164
 
    var inp = document.getElementById('inputText');
165
 
    if (key == 13)
166
 
    {
167
 
        enter_line();
168
 
        hist.add(inp.value);
169
 
        inp.value = hist.curr();
170
 
    }
171
 
    if (key == 38)
172
 
    {
173
 
        hist.up();
174
 
        inp.value = hist.curr();
175
 
    }
176
 
    if (key == 40)
177
 
    {
178
 
        hist.down();
179
 
        inp.value = hist.curr();
 
274
    var inp = document.getElementById('console_inputText');
 
275
    switch (key)
 
276
    {
 
277
    case 9:                 /* Tab key */
 
278
        var selstart = inp.selectionStart;
 
279
        var selend = inp.selectionEnd;
 
280
        if (selstart == selend)
 
281
        {
 
282
            /* No selection, just a carat. Insert a tab here. */
 
283
            inp.value = inp.value.substr(0, selstart)
 
284
                + TAB_STRING + inp.value.substr(selstart);
 
285
        }
 
286
        else
 
287
        {
 
288
            /* Text is selected. Just indent the whole line
 
289
             * by inserting a tab at the start */
 
290
            inp.value = TAB_STRING + inp.value;
 
291
        }
 
292
        /* Update the selection so the same characters as before are selected
 
293
         */
 
294
        inp.selectionStart = selstart + TAB_STRING.length;
 
295
        inp.selectionEnd = inp.selectionStart + (selend - selstart);
 
296
        /* Cancel the event, so the TAB key doesn't move focus away from this
 
297
         * box */
 
298
        return false;
 
299
        /* Note: If it happens that some browsers don't support event
 
300
         * cancelling properly, this hack might work instead:
 
301
        setTimeout(
 
302
            "document.getElementById('console_inputText').focus()",
 
303
            0);
 
304
         */
 
305
        break;
 
306
    case 13:                /* Enter key */
 
307
        /* Send the line of text to the server */
 
308
        console_enter_line(inp.value, "chat");
 
309
        hist.submit(inp.value);
 
310
        inp.value = hist.curr();
 
311
        break;
 
312
    case 38:                /* Up arrow */
 
313
        hist.up(inp.value);
 
314
        inp.value = hist.curr();
 
315
        break;
 
316
    case 40:                /* Down arrow */
 
317
        hist.down(inp.value);
 
318
        inp.value = hist.curr();
 
319
        break;
180
320
    }
181
321
}