~azzar1/unity/add-show-desktop-key
» Revision
127
(compared to revision 201)
: www/media/common/util.js
« back to all changes in this revision
Viewing changes to www/media/common/util.js
- browse files at revision 127
- compare with another revision
- download diff
- download tarball
- view history from revision 127
- Committer: drtomc
- Date: 2008-01-02 22:05:22 UTC
- Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:127
A bit of simplification - unify the output areas and use colours to
distinguish output, return values and errors.
distinguish output, return values and errors.
- files added:
- www/media/images
- www/media/images/mime
- files removed:
- doc/dependencies.txt
- test
- test/misc
- www/apps/console
- www/apps/editor
- www/apps/fileservice
- www/apps/tutorial
- www/media/browser
- www/media/common
- www/media/images
- www/media/images/apps
- www/media/images/apps/small
- www/media/images/interface
- www/media/images/mime
- www/media/images/mime/large
- www/media/images/svn
- files modified:
- console/console.js
added
removed
www/media/common/util.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: JavaScript Utilities
19
* Author: Matt Giuca
20
* Date: 11/1/2008
21
*
22
* Defines some generic JavaScript utility functions.
23
*/
24
25
/* Expects the following variables to have been declared by JavaScript in
26
* the HTML generated by the server:
27
* - root_dir
28
* - username
29
*/
30
31
/** Removes all children of a given DOM element
32
* \param elem A DOM Element. Will be modified.
33
*/
34
function dom_removechildren(elem)
35
{
36
while (elem.lastChild != null)
37
elem.removeChild(elem.lastChild);
38
}
39
40
/** Creates a DOM element with simple text inside it.
41
* \param tagname String. Name of the element's tag (eg. "p").
42
* \param text String. Text to be placed inside the element.
43
* \param title String, optional. Tooltip for the text.
44
* (Note, title creates a span element around the text).
45
* \return DOM Element object.
46
*/
47
function dom_make_text_elem(tagname, text, title)
48
{
49
if (text == null) text = "";
50
var elem = document.createElement(tagname);
51
var textnode;
52
if (title == null)
53
textnode = document.createTextNode(text);
54
else
55
{
56
textnode = document.createElement("span");
57
textnode.setAttribute("title", title);
58
textnode.appendChild(document.createTextNode(text));
59
}
60
elem.appendChild(textnode);
61
return elem;
62
}
63
64
/** Creates a DOM element with hyperlinked text inside it.
65
* \param tagname String. Name of the element's tag (eg. "p").
66
* \param text String. Text to be placed inside the element.
67
* \param title String, optional. Sets a tooltip for the link.
68
* \param href String. URL the text will link to. This is a raw string,
69
* it will automatically be URL-encoded.
70
* \param onclick Optional string. Will be set as the "onclick" attribute
71
* of the "a" element.
72
* \return DOM Element object.
73
*/
74
function dom_make_link_elem(tagname, text, title, href, onclick)
75
{
76
if (text == null) text = "";
77
if (href == null) href = "";
78
var elem = document.createElement(tagname);
79
var link = document.createElement("a");
80
link.setAttribute("href", encodeURI(href));
81
if (title != null)
82
link.setAttribute("title", title);
83
if (onclick != null)
84
link.setAttribute("onclick", onclick);
85
link.appendChild(document.createTextNode(text));
86
elem.appendChild(link);
87
return elem;
88
}
89
90
/** Creates a DOM img element. All parameters are optional except src.
91
* If alt (compulsory in HTML) is omitted, will be set to "".
92
*/
93
function dom_make_img(src, width, height, title, alt)
94
{
95
var img = document.createElement("img");
96
img.setAttribute("src", src);
97
if (width != null)
98
img.setAttribute("width", width);
99
if (height != null)
100
img.setAttribute("height", height);
101
if (title != null)
102
img.setAttribute("title", title);
103
if (alt == null) alt = "";
104
img.setAttribute("alt", alt);
105
return img;
106
}
107
108
/** Given a number of bytes, returns a string representing the file size in a
109
* human-readable format.
110
* eg. nice_filesize(6) -> "6 bytes"
111
* nice_filesize(81275) -> "79.4 kB"
112
* nice_filesize(13498346) -> "12.9 MB"
113
* \param bytes Number of bytes. Must be an integer.
114
* \return String.
115
*/
116
function nice_filesize(bytes)
117
{
118
if (bytes == null) return "";
119
var size;
120
if (bytes < 1024)
121
return bytes.toString() + " B";
122
size = bytes / 1024;
123
if (size < 1024)
124
return size.toFixed(1) + " kB";
125
size = size / 1024;
126
if (size < 1024)
127
return size.toFixed(1) + " MB";
128
size = size / 1024;
129
return size.toFixed(1) + " GB";
130
}
131
132
/** Given a URL, returns an object containing a number of attributes
133
* describing the components of the URL, similar to CGI request variables.
134
* The object has the following attributes:
135
* - scheme
136
* - server_name
137
* - server_port
138
* - path
139
* - query_string
140
* - args
141
* The first five of these are strings, which comprise the URL as follows:
142
* <scheme> "://" <server_name> ":" <server_port> <path> "?" <query_string>
143
* Any of these strings may be set to null if not found.
144
*
145
* "args" is an object whose attributes are the query_string arguments broken
146
* up.
147
* Args values are strings for single values, arrays of strings for values
148
* whose names appear multiple times.
149
* args is never null, though it may be empty.
150
*
151
* All strings are decoded/unescaped. Reserved characters
152
* (; , / ? : @ & = + * $) are not decoded except in args.
153
*
154
* \param url String. A URL. To read from the current browser window, use
155
* window.location.href.
156
* \return The above described object.
157
*/
158
function parse_url(url)
159
{
160
var obj = {};
161
var index;
162
var serverpart;
163
var args;
164
165
url = decodeURI(url);
166
167
/* Split scheme from rest */
168
index = url.indexOf("://");
169
if (index < 0)
170
obj.scheme = null;
171
else
172
{
173
obj.scheme = url.substr(0, index);
174
url = url.substr(index+3);
175
}
176
177
/* Split server name/port from rest */
178
index = url.indexOf("/");
179
if (index < 0)
180
{
181
serverpart = url;
182
url = null;
183
}
184
else
185
{
186
serverpart = url.substr(0, index);
187
url = url.substr(index);
188
}
189
190
/* Split server name from port */
191
index = serverpart.indexOf(":");
192
if (index < 0)
193
{
194
obj.server_name = serverpart;
195
obj.server_port = null;
196
}
197
else
198
{
199
obj.server_name = serverpart.substr(0, index);
200
obj.server_port = serverpart.substr(index+1);
201
}
202
203
/* Split path from query string */
204
if (url == null)
205
{
206
obj.path = null;
207
obj.query_string = null;
208
}
209
else
210
{
211
index = url.indexOf("?");
212
if (index < 0)
213
{
214
obj.path = url;
215
obj.query_string = null;
216
}
217
else
218
{
219
obj.path = url.substr(0, index);
220
obj.query_string = url.substr(index+1);
221
}
222
}
223
224
/* Split query string into arguments */
225
args = {};
226
if (obj.query_string != null)
227
{
228
var args_strs = obj.query_string.split("&");
229
var arg_str;
230
var arg_key, arg_val;
231
for (var i=0; i<args_strs.length; i++)
232
{
233
arg_str = args_strs[i];
234
index = arg_str.indexOf("=");
235
/* Ignore malformed args */
236
if (index >= 0)
237
{
238
arg_key = decodeURIComponent(arg_str.substr(0, index));
239
arg_val = decodeURIComponent(arg_str.substr(index+1));
240
if (arg_key in args)
241
{
242
/* Collision - make an array */
243
if (args[arg_key] instanceof Array)
244
args[arg_key][args[arg_key].length] = arg_val;
245
else
246
args[arg_key] = [args[arg_key], arg_val];
247
}
248
else
249
args[arg_key] = arg_val;
250
}
251
}
252
}
253
obj.args = args;
254
255
return obj;
256
}
257
258
/** Builds a query_string from an args object. Encodes the arguments.
259
* \param args Args object as described in parse_url.
260
* \return Query string portion of a URL.
261
*/
262
function make_query_string(args)
263
{
264
var query_string = "";
265
var arg_val;
266
for (var arg_key in args)
267
{
268
arg_val = args[arg_key];
269
if (arg_val instanceof Array)
270
for (var i=0; i<arg_val.length; i++)
271
query_string += "&" + encodeURIComponent(arg_key) + "=" +
272
encodeURIComponent(arg_val[i]);
273
else
274
query_string += "&" + encodeURIComponent(arg_key) + "=" +
275
encodeURIComponent(arg_val);
276
}
277
if (query_string == "")
278
query_string = null;
279
else
280
/* Drop the first "&" */
281
query_string = query_string.substr(1);
282
283
return query_string;
284
}
285
286
/** Given an object exactly of the form described for the output of parseurl,
287
* returns a URL string built from those parameters. The URL is properly
288
* encoded.
289
* parseurl and buildurl are strict inverses of each other.
290
* Note that either query_string or args may be supplied. If both are
291
* supplied, query_string is preferred (because it keeps the argument order).
292
* If you take a url from parseurl, modify args, and pass to buildurl,
293
* you need to set query_string to null to use the new args.
294
* \param obj Object as returned by parseurl.
295
* \return String, a URL.
296
*/
297
function build_url(obj)
298
{
299
var url = "";
300
var query_string = null;
301
302
if (("scheme" in obj) && obj.scheme != null)
303
url = obj.scheme.toString() + "://";
304
if (("server_name" in obj) && obj.server_name != null)
305
url += obj.server_name.toString();
306
if (("server_port" in obj) && obj.server_port != null)
307
url += ":" + obj.server_port.toString();
308
if (("path" in obj) && obj.path != null)
309
{
310
var path = obj.path.toString();
311
if (url.length > 0 && path.length > 0 && path[0] != "/")
312
path = "/" + path;
313
url += path;
314
}
315
if (("query_string" in obj) && obj.query_string != null)
316
query_string = obj.query_string.toString();
317
else if (("args" in obj) && obj.args != null)
318
query_string = make_query_string(obj.args);
319
320
if (query_string != null)
321
url += "?" + query_string;
322
323
return encodeURI(url);
324
}
325
326
/** Given an argument map, as output in the args parameter of the return of
327
* parseurl, gets the first occurence of an argument in the URL string.
328
* If the argument was not found, returns null.
329
* If there was a single argument, returns the argument.
330
* If there were multiple arguments, returns the first.
331
* \param args Object mapping arguments to strings or arrays of strings.
332
* \param arg String. Argument name.
333
* \return String.
334
*/
335
function arg_getfirst(args, arg)
336
{
337
if (!(arg in args))
338
return null;
339
var r = args[arg];
340
if (r instanceof Array)
341
return r[0];
342
else
343
return r;
344
}
345
346
/** Given an argument map, as output in the args parameter of the return of
347
* parseurl, gets all occurences of an argument in the URL string, as an
348
* array.
349
* If the argument was not found, returns [].
350
* Otherwise, returns all occurences as an array, even if there was only one.
351
* \param args Object mapping arguments to strings or arrays of strings.
352
* \param arg String. Argument name.
353
* \return Array of strings.
354
*/
355
function arg_getlist(args, arg)
356
{
357
if (!(arg in args))
358
return [];
359
var r = args[arg];
360
if (r instanceof Array)
361
return r;
362
else
363
return [r];
364
}
365
366
/** Joins one or more paths together. Accepts 1 or more arguments.
367
*/
368
function path_join(path1 /*, path2, ... */)
369
{
370
var arg;
371
var path = "";
372
for (var i=0; i<arguments.length; i++)
373
{
374
arg = arguments[i];
375
if (arg.length == 0) continue;
376
if (arg[0] == '/')
377
path = arg;
378
else
379
{
380
if (path.length > 0 && path[path.length-1] != '/')
381
path += '/';
382
path += arg;
383
}
384
}
385
return path;
386
}
387
388
389
/** Builds a multipart_formdata string from an args object. Similar to
390
* make_query_string, but it returns data of type "multipart/form-data"
391
* instead of "application/x-www-form-urlencoded". This is good for
392
* encoding large strings such as text objects from the editor.
393
* Should be written with a Content-Type of
394
* "multipart/form-data, boundary=<boundary>".
395
* All fields are sent with a Content-Type of text/plain.
396
* \param args Args object as described in parse_url.
397
* \param boundary Random "magic" string which DOES NOT appear in any of
398
* the argument values. This should match the "boundary=" value written to
399
* the Content-Type header.
400
* \return String in multipart/form-data format.
401
*/
402
function make_multipart_formdata(args, boundary)
403
{
404
var data = "";
405
var arg_val;
406
/* Mutates data */
407
var extend_data = function(arg_key, arg_val)
408
{
409
/* FIXME: Encoding not supported here (should not matter if we
410
* only use ASCII names */
411
data += "--" + boundary + "\n"
412
+ "Content-Disposition: form-data; name=\"" + arg_key
413
+ "\"\n\n"
414
+ arg_val + "\n";
415
}
416
417
for (var arg_key in args)
418
{
419
arg_val = args[arg_key];
420
if (arg_val instanceof Array)
421
for (var i=0; i<arg_val.length; i++)
422
{
423
extend_data(arg_key, arg_val[i]);
424
}
425
else
426
extend_data(arg_key, arg_val);
427
}
428
/* End boundary */
429
data += "--" + boundary + "--\n";
430
431
return data;
432
}
433
434
/** Converts a list of directories into a path name, with a slash at the end.
435
* \param pathlist List of strings.
436
* \return String.
437
*/
438
function pathlist_to_path(pathlist)
439
{
440
ret = path_join.apply(null, pathlist);
441
if (ret[ret.length-1] != '/')
442
ret += '/';
443
return ret;
444
}
445
446
/** Given a path relative to the IVLE root, gives a path relative to
447
* the site root.
448
*/
449
function make_path(path)
450
{
451
return path_join(root_dir, path);
452
}
453
454
/** Makes an XMLHttpRequest call to the server. Waits (synchronously) for a
455
* response, and returns an XMLHttpRequest object containing the completed
456
* response.
457
*
458
* \param app IVLE app to call (such as "fileservice").
459
* \param path URL path to make the request to, within the application.
460
* \param args Argument object, as described in parse_url and friends.
461
* \param method String; "GET" or "POST"
462
* \param content_type String, optional. Only applies if method is "POST".
463
* May be "application/x-www-form-urlencoded" or "multipart/form-data".
464
* Defaults to "application/x-www-form-urlencoded".
465
* \return An XMLHttpRequest object containing the completed response.
466
*/
467
function ajax_call(app, path, args, method, content_type)
468
{
469
if (content_type != "multipart/form-data")
470
content_type = "application/x-www-form-urlencoded";
471
path = make_path(path_join(app, path));
472
var url;
473
/* A random string, for multipart/form-data
474
* (This is not checked against anywhere else, it is solely defined and
475
* used within this function) */
476
var boundary = "48234n334nu7n4n2ynonjn234t683jyh80j";
477
var xhr = new XMLHttpRequest();
478
if (method == "GET")
479
{
480
/* GET sends the args in the URL */
481
url = build_url({"path": path, "args": args});
482
/* open's 3rd argument = false -> SYNCHRONOUS (wait for response)
483
* (No need for a callback function) */
484
xhr.open(method, url, false);
485
xhr.send(null);
486
}
487
else
488
{
489
/* POST sends the args in application/x-www-form-urlencoded */
490
url = encodeURI(path);
491
xhr.open(method, url, false);
492
var message;
493
if (content_type == "multipart/form-data")
494
{
495
xhr.setRequestHeader("Content-Type",
496
"multipart/form-data, boundary=" + boundary);
497
message = make_multipart_formdata(args, boundary);
498
}
499
else
500
{
501
xhr.setRequestHeader("Content-Type", content_type);
502
message = make_query_string(args);
503
}
504
xhr.send(message);
505
}
506
return xhr;
507
}
508
Loggerhead is a web-based interface for Breezy
Version: 2.0.1