41
34
/** Creates a DOM element with simple text inside it.
42
35
* \param tagname String. Name of the element's tag (eg. "p").
43
36
* \param text String. Text to be placed inside the element.
44
* \param title String, optional. Tooltip for the text.
45
* (Note, title creates a span element around the text).
46
37
* \return DOM Element object.
48
function dom_make_text_elem(tagname, text, title)
39
function dom_make_text_elem(tagname, text)
50
if (text == null) text = "";
51
41
var elem = document.createElement(tagname);
54
textnode = document.createTextNode(text);
57
textnode = document.createElement("span");
58
textnode.setAttribute("title", title);
59
textnode.appendChild(document.createTextNode(text));
61
elem.appendChild(textnode);
42
elem.appendChild(document.createTextNode(text));
65
46
/** Creates a DOM element with hyperlinked text inside it.
66
47
* \param tagname String. Name of the element's tag (eg. "p").
67
48
* \param text String. Text to be placed inside the element.
68
* \param title String, optional. Sets a tooltip for the link.
69
49
* \param href String. URL the text will link to. This is a raw string,
70
50
* it will automatically be URL-encoded.
71
51
* \param onclick Optional string. Will be set as the "onclick" attribute
72
52
* of the "a" element.
73
* \param dontencode Optional boolean. If true, will not encode the href.
74
* if including query strings, you must set this to true and use build_url
75
* to escape the URI correctly.
76
53
* \return DOM Element object.
78
function dom_make_link_elem(tagname, text, title, href, onclick, dontencode)
55
function dom_make_link_elem(tagname, text, href, onclick)
80
if (text == null) text = "";
81
if (href == null) href = "";
82
57
var elem = document.createElement(tagname);
83
58
var link = document.createElement("a");
84
if (dontencode != true)
85
href = urlencode_path(href);
86
link.setAttribute("href", href);
88
link.setAttribute("title", title);
59
link.setAttribute("href", encodeURI(href));
89
60
if (onclick != null)
90
61
link.setAttribute("onclick", onclick);
91
62
link.appendChild(document.createTextNode(text));
96
/** Creates a DOM img element. All parameters are optional except src.
97
* If alt (compulsory in HTML) is omitted, will be set to "".
99
function dom_make_img(src, width, height, title, alt)
101
var img = document.createElement("img");
102
img.setAttribute("src", urlencode_path(src));
104
img.setAttribute("width", width);
106
img.setAttribute("height", height);
108
img.setAttribute("title", title);
109
if (alt == null) alt = "";
110
img.setAttribute("alt", alt);
114
/** Given a number of bytes, returns a string representing the file size in a
115
* human-readable format.
116
* eg. nice_filesize(6) -> "6 bytes"
117
* nice_filesize(81275) -> "79.4 kB"
118
* nice_filesize(13498346) -> "12.9 MB"
119
* \param bytes Number of bytes. Must be an integer.
67
/** Converts a list of directories into a path name, with a slash at the end.
68
* \param pathlist List of strings.
122
function nice_filesize(bytes)
71
function pathlist_to_path(pathlist)
124
if (bytes == null) return "";
127
return bytes.toString() + " B";
130
return size.toFixed(1) + " kB";
133
return size.toFixed(1) + " MB";
135
return size.toFixed(1) + " GB";
74
for (var i=0; i<pathlist.length; i++)
76
ret += pathlist[i] + "/";
138
81
/** Given a URL, returns an object containing a number of attributes
297
212
* \param obj Object as returned by parseurl.
298
213
* \return String, a URL.
300
function build_url(obj)
215
function buildurl(obj)
303
218
var query_string = null;
305
if (("scheme" in obj) && obj.scheme != null)
220
if (!("scheme" in obj) || obj.scheme != null)
306
221
url = obj.scheme.toString() + "://";
307
if (("server_name" in obj) && obj.server_name != null)
222
if (!("server_name" in obj) || obj.server_name != null)
308
223
url += obj.server_name.toString();
309
if (("server_port" in obj) && obj.server_port != null)
224
if (!("server_port" in obj) || obj.server_port != null)
310
225
url += ":" + obj.server_port.toString();
311
if (("path" in obj) && obj.path != null)
226
if (!("path" in obj) || obj.path != null)
313
var path = urlencode_path(obj.path.toString());
314
if (url.length > 0 && path.length > 0 && path.charAt(0) != "/")
228
var path = obj.path.toString();
229
if (path.length > 0 && path[0] != "/")
315
230
path = "/" + path;
318
if (("query_string" in obj) && obj.query_string != null)
319
query_string = encodeURI(obj.query_string.toString());
320
else if (("args" in obj) && obj.args != null)
321
query_string = make_query_string(obj.args);
233
if (!("query_string" in obj) || obj.query_string != null)
234
query_string = obj.query_string.toString();
235
else if (!("args" in obj) || obj.args != null)
239
for (var arg_key in obj.args)
241
arg_val = obj.args[arg_key];
242
if (arg_val instanceof Array)
243
for (var i=0; i<arg_val.length; i++)
244
query_string += "&" + encodeURI(arg_key) + "=" +
245
encodeURI(arg_val[i]);
247
query_string += "&" + encodeURI(arg_key) + "=" +
251
if (query_string == "")
254
/* Drop the first "&" */
255
query_string = query_string.substr(1);
323
if (query_string != "" && query_string != null)
258
if (query_string != null)
324
259
url += "?" + query_string;
329
/** URL-encodes a path. This is a special case of URL encoding as all
330
* characters *except* the slash must be encoded.
332
function urlencode_path(path)
334
/* Split up the path, URLEncode each segment with encodeURIComponent,
337
var split = path.split('/');
338
for (var i=0; i<split.length; i++)
339
split[i] = encodeURIComponent(split[i]);
340
path = path_join.apply(null, split);
341
if (split[0] == "" && split.length > 1) path = "/" + path;
345
/** Writes a JSONable object to the cookie under a particular key
346
* (JSON encoded and URL encoded).
348
function write_cookie(key, value)
350
var sendstr = encodeURIComponent(key) + "="
351
+ encodeURIComponent(JSON.stringify(value))
352
+ "; path=" + urlencode_path(root_dir);
353
/* This actually just assigns to the key, not replacing the whole cookie
354
* as it appears to. */
355
document.cookie = sendstr;
357
/** Reads a cookie which has a JSONable object encoded as its value.
358
* Returns the object, parsed from JSON.
360
function read_cookie(key)
362
var cookies = document.cookie.split(";");
363
var checkstart = encodeURIComponent(key) + "=";
364
var checklen = checkstart.length;
365
for (var i=0; i<cookies.length; i++)
367
var cookie = cookies[i];
368
while (cookie[0] == ' ')
369
cookie = cookie.substr(1);
370
if (cookie.substr(0, checklen) == checkstart)
372
var valstr = cookie.substr(checklen);
373
valstr = decodeURIComponent(valstr);
374
return JSON.parse(valstr);
379
264
/** Given an argument map, as output in the args parameter of the return of
380
265
* parseurl, gets the first occurence of an argument in the URL string.
381
266
* If the argument was not found, returns null.
419
/** Joins one or more paths together. Accepts 1 or more arguments.
421
function path_join(path1 /*, path2, ... */)
425
for (var i=0; i<arguments.length; i++)
428
if (arg.length == 0) continue;
429
if (arg.charAt(0) == '/')
433
if (path.length > 0 && path.charAt(path.length-1) != '/')
442
/** Builds a multipart_formdata string from an args object. Similar to
443
* make_query_string, but it returns data of type "multipart/form-data"
444
* instead of "application/x-www-form-urlencoded". This is good for
445
* encoding large strings such as text objects from the editor.
446
* Should be written with a Content-Type of
447
* "multipart/form-data, boundary=<boundary>".
448
* All fields are sent with a Content-Type of text/plain.
449
* \param args Args object as described in parse_url.
450
* \param boundary Random "magic" string which DOES NOT appear in any of
451
* the argument values. This should match the "boundary=" value written to
452
* the Content-Type header.
453
* \return String in multipart/form-data format.
455
function make_multipart_formdata(args, boundary)
460
var extend_data = function(arg_key, arg_val)
462
/* FIXME: Encoding not supported here (should not matter if we
463
* only use ASCII names */
464
data += "--" + boundary + "\r\n"
465
+ "Content-Disposition: form-data; name=\"" + arg_key
470
for (var arg_key in args)
472
arg_val = args[arg_key];
473
if (arg_val instanceof Array)
474
for (var i=0; i<arg_val.length; i++)
476
extend_data(arg_key, arg_val[i]);
479
extend_data(arg_key, arg_val);
482
data += "--" + boundary + "--\r\n";
487
/** Converts a list of directories into a path name, with a slash at the end.
488
* \param pathlist List of strings.
491
function pathlist_to_path(pathlist)
493
ret = path_join.apply(null, pathlist);
494
if (ret.charAt(ret.length-1) != '/')
499
/** Given a path relative to the IVLE root, gives a path relative to
502
function make_path(path)
504
return path_join(root_dir, path);
507
/** Shorthand for make_path(path_join(app, ...))
508
* Creates an absolute path for a given path within a given app.
510
function app_path(app /*,...*/)
512
return make_path(path_join.apply(null, arguments));
515
/** Same as app_path but creates a properly-escaped site-relative URL.
517
function app_url(app /*,...*/)
519
return urlencode_path(app_path.apply(null, arguments));
522
/** Generates an absolute URL to a public application
524
function public_app_url(app /*,...*/)
526
return "http://" + public_host + app_url.apply(null, arguments);
529
/** Given a path, gets the "basename" (the last path segment).
531
function path_basename(path)
533
segments = path.split("/");
534
if (segments[segments.length-1].length == 0)
535
return segments[segments.length-2];
537
return segments[segments.length-1];
540
/** Given a string str, determines whether it ends with substr */
541
function endswith(str, substring)
543
if (str.length < substring.length) return false;
544
return str.substr(str.length - substring.length) == substring;
547
/** Removes all occurences of a value from an array.
549
Array.prototype.removeall = function(val)
554
for (i=0; i<arr.length; i++)
557
if (arr[i] != val) j++;
562
/** Shallow-clones an object */
563
function shallow_clone_object(obj)
571
/** Returns a new XMLHttpRequest object, in a somewhat browser-agnostic
574
function new_xmlhttprequest()
579
return new XMLHttpRequest();
583
/* Internet Explorer */
586
return new ActiveXObject("Msxml2.XMLHTTP");
592
return new ActiveXObject("Microsoft.XMLHTTP");
596
throw("Your browser does not support AJAX. "
597
+ "IVLE requires a modern browser.");
603
/** Creates a random string of length length,
604
* consisting of alphanumeric characters.
606
var rand_chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXTZ"
607
+ "abcdefghiklmnopqrstuvwxyz";
608
function random_string(length)
610
var str = Array(length);
612
for (var i=0; i<length; i++)
614
v = Math.floor(Math.random() * rand_chars.length);
615
str[i] = rand_chars.charAt(v);
620
/** Makes an XMLHttpRequest call to the server.
621
* Sends the XMLHttpRequest object containing the completed response to a
622
* specified callback function.
624
* \param callback A callback function. Will be called when the response is
625
* complete. Passed 1 parameter, an XMLHttpRequest object containing the
626
* completed response. If callback is null this is a syncronous request
627
* otherwise this is an asynchronous request.
628
* \param app IVLE app to call (such as "fileservice").
629
* \param path URL path to make the request to, within the application.
630
* \param args Argument object, as described in parse_url and friends.
631
* \param method String; "GET", "POST", "PUT", or "PATCH"
632
* \param content_type String, optional.
633
* Defaults to "application/x-www-form-urlencoded".
635
function ajax_call(callback, app, path, args, method, content_type)
638
content_type = "application/x-www-form-urlencoded";
639
path = app_path(app, path);
641
/* A random string, for multipart/form-data
642
* (This is not checked against anywhere else, it is solely defined and
643
* used within this function) */
644
var boundary = random_string(20);
645
var xhr = new_xmlhttprequest();
646
var asyncronous = callback != null;
649
xhr.onreadystatechange = function()
651
if (xhr.readyState == 4)
659
/* GET sends the args in the URL */
660
url = build_url({"path": path, "args": args});
661
/* open's 3rd argument = true -> asynchronous */
662
xhr.open(method, url, asyncronous);
667
/* POST & PUT & PATCH sends the args in the request body */
668
url = urlencode_path(path);
669
xhr.open(method, url, asyncronous);
671
if (content_type == "multipart/form-data")
673
xhr.setRequestHeader("Content-Type",
674
"multipart/form-data; boundary=" + boundary);
675
message = make_multipart_formdata(args, boundary);
677
else if (content_type == "application/x-www-form-urlencoded")
679
xhr.setRequestHeader("Content-Type", content_type);
680
message = make_query_string(args);
682
else if (content_type == "application/json")
684
xhr.setRequestHeader("Content-Type", content_type);
685
message = JSON.stringify(args);
689
xhr.setRequestHeader("Content-Type", content_type);
694
/* Only return the XHR for syncronous requests */
701
/** Attempts to JSON decodes a response object
702
* If a non-200 response or the JSON decode fails then returns null
704
function decode_response(response)
706
if (response.status == 200)
710
var responseText = response.responseText;
711
return JSON.parse(responseText);
added
removed
www/media/common/util.js
