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: JavaScript Utilities
22
* Defines some generic JavaScript utility functions.
25
/* Expects the following variables to have been declared by JavaScript in
26
* the HTML generated by the server:
31
/** Removes all children of a given DOM element
32
* \param elem A DOM Element. Will be modified.
34
function dom_removechildren(elem)
36
while (elem.lastChild != null)
37
elem.removeChild(elem.lastChild);
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.
47
function dom_make_text_elem(tagname, text, title)
49
if (text == null) text = "";
50
var elem = document.createElement(tagname);
53
textnode = document.createTextNode(text);
56
textnode = document.createElement("span");
57
textnode.setAttribute("title", title);
58
textnode.appendChild(document.createTextNode(text));
60
elem.appendChild(textnode);
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
72
* \return DOM Element object.
74
function dom_make_link_elem(tagname, text, title, href, onclick)
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));
82
link.setAttribute("title", title);
84
link.setAttribute("onclick", onclick);
85
link.appendChild(document.createTextNode(text));
86
elem.appendChild(link);
90
/** Creates a DOM img element. All parameters are optional except src.
91
* If alt (compulsory in HTML) is omitted, will be set to "".
93
function dom_make_img(src, width, height, title, alt)
95
var img = document.createElement("img");
96
img.setAttribute("src", src);
98
img.setAttribute("width", width);
100
img.setAttribute("height", height);
102
img.setAttribute("title", title);
103
if (alt == null) alt = "";
104
img.setAttribute("alt", alt);
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.
116
function nice_filesize(bytes)
118
if (bytes == null) return "";
121
return bytes.toString() + " B";
124
return size.toFixed(1) + " kB";
127
return size.toFixed(1) + " MB";
129
return size.toFixed(1) + " GB";
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:
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.
145
* "args" is an object whose attributes are the query_string arguments broken
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.
151
* All strings are decoded/unescaped. Reserved characters
152
* (; , / ? : @ & = + * $) are not decoded except in args.
154
* \param url String. A URL. To read from the current browser window, use
155
* window.location.href.
156
* \return The above described object.
158
function parse_url(url)
165
url = decodeURI(url);
167
/* Split scheme from rest */
168
index = url.indexOf("://");
173
obj.scheme = url.substr(0, index);
174
url = url.substr(index+3);
177
/* Split server name/port from rest */
178
index = url.indexOf("/");
186
serverpart = url.substr(0, index);
187
url = url.substr(index);
190
/* Split server name from port */
191
index = serverpart.indexOf(":");
194
obj.server_name = serverpart;
195
obj.server_port = null;
199
obj.server_name = serverpart.substr(0, index);
200
obj.server_port = serverpart.substr(index+1);
203
/* Split path from query string */
207
obj.query_string = null;
211
index = url.indexOf("?");
215
obj.query_string = null;
219
obj.path = url.substr(0, index);
220
obj.query_string = url.substr(index+1);
224
/* Split query string into arguments */
226
if (obj.query_string != null)
228
var args_strs = obj.query_string.split("&");
230
var arg_key, arg_val;
231
for (var i=0; i<args_strs.length; i++)
233
arg_str = args_strs[i];
234
index = arg_str.indexOf("=");
235
/* Ignore malformed args */
238
arg_key = decodeURIComponent(arg_str.substr(0, index));
239
arg_val = decodeURIComponent(arg_str.substr(index+1));
242
/* Collision - make an array */
243
if (args[arg_key] instanceof Array)
244
args[arg_key][args[arg_key].length] = arg_val;
246
args[arg_key] = [args[arg_key], arg_val];
249
args[arg_key] = arg_val;
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.
262
function make_query_string(args)
264
var query_string = "";
266
for (var arg_key in args)
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]);
274
query_string += "&" + encodeURIComponent(arg_key) + "=" +
275
encodeURIComponent(arg_val);
277
if (query_string == "")
280
/* Drop the first "&" */
281
query_string = query_string.substr(1);
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
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.
297
function build_url(obj)
300
var query_string = null;
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)
310
var path = obj.path.toString();
311
if (url.length > 0 && path.length > 0 && path[0] != "/")
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);
320
if (query_string != null)
321
url += "?" + query_string;
323
return encodeURI(url);
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.
335
function arg_getfirst(args, arg)
340
if (r instanceof Array)
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
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.
355
function arg_getlist(args, arg)
360
if (r instanceof Array)
366
/** Joins one or more paths together. Accepts 1 or more arguments.
368
function path_join(path1 /*, path2, ... */)
372
for (var i=0; i<arguments.length; i++)
375
if (arg.length == 0) continue;
380
if (path.length > 0 && path[path.length-1] != '/')
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.
402
function make_multipart_formdata(args, boundary)
407
var extend_data = function(arg_key, arg_val)
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
417
for (var arg_key in args)
419
arg_val = args[arg_key];
420
if (arg_val instanceof Array)
421
for (var i=0; i<arg_val.length; i++)
423
extend_data(arg_key, arg_val[i]);
426
extend_data(arg_key, arg_val);
429
data += "--" + boundary + "--\n";
434
/** Converts a list of directories into a path name, with a slash at the end.
435
* \param pathlist List of strings.
438
function pathlist_to_path(pathlist)
440
ret = path_join.apply(null, pathlist);
441
if (ret[ret.length-1] != '/')
446
/** Given a path relative to the IVLE root, gives a path relative to
449
function make_path(path)
451
return path_join(root_dir, path);
454
/** Given a path, gets the "basename" (the last path segment).
456
function path_basename(path)
458
segments = path.split("/");
459
if (segments[segments.length-1].length == 0)
460
return segments[segments.length-2];
462
return segments[segments.length-1];
465
/** Given a string str, determines whether it ends with substr */
466
function endswith(str, substring)
468
if (str.length < substring.length) return false;
469
return str.substr(str.length - substring.length) == substring;
472
/** Makes an XMLHttpRequest call to the server. Waits (synchronously) for a
473
* response, and returns an XMLHttpRequest object containing the completed
476
* \param app IVLE app to call (such as "fileservice").
477
* \param path URL path to make the request to, within the application.
478
* \param args Argument object, as described in parse_url and friends.
479
* \param method String; "GET" or "POST"
480
* \param content_type String, optional. Only applies if method is "POST".
481
* May be "application/x-www-form-urlencoded" or "multipart/form-data".
482
* Defaults to "application/x-www-form-urlencoded".
483
* \return An XMLHttpRequest object containing the completed response.
485
function ajax_call(app, path, args, method, content_type)
487
if (content_type != "multipart/form-data")
488
content_type = "application/x-www-form-urlencoded";
489
path = make_path(path_join(app, path));
491
/* A random string, for multipart/form-data
492
* (This is not checked against anywhere else, it is solely defined and
493
* used within this function) */
494
var boundary = "48234n334nu7n4n2ynonjn234t683jyh80j";
495
var xhr = new XMLHttpRequest();
498
/* GET sends the args in the URL */
499
url = build_url({"path": path, "args": args});
500
/* open's 3rd argument = false -> SYNCHRONOUS (wait for response)
501
* (No need for a callback function) */
502
xhr.open(method, url, false);
507
/* POST sends the args in application/x-www-form-urlencoded */
508
url = encodeURI(path);
509
xhr.open(method, url, false);
511
if (content_type == "multipart/form-data")
513
xhr.setRequestHeader("Content-Type",
514
"multipart/form-data, boundary=" + boundary);
515
message = make_multipart_formdata(args, boundary);
519
xhr.setRequestHeader("Content-Type", content_type);
520
message = make_query_string(args);
added
removed
www/media/common/util.js
