~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to www/media/common/util.js

  • Committer: mattgiuca
  • Date: 2008-01-11 00:49:06 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:172
util: Added buildurl function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
38
38
 */
39
39
function dom_make_text_elem(tagname, text)
40
40
{
41
 
    if (text == null) text = "";
42
41
    var elem = document.createElement(tagname);
43
42
    elem.appendChild(document.createTextNode(text));
44
43
    return elem;
55
54
 */
56
55
function dom_make_link_elem(tagname, text, href, onclick)
57
56
{
58
 
    if (text == null) text = "";
59
 
    if (href == null) href = "";
60
57
    var elem = document.createElement(tagname);
61
58
    var link = document.createElement("a");
62
59
    link.setAttribute("href", encodeURI(href));
67
64
    return elem;
68
65
}
69
66
 
70
 
/** Creates a DOM img element. All parameters are optional except src.
71
 
 * If alt (compulsory in HTML) is omitted, will be set to "".
72
 
 */
73
 
function dom_make_img(src, width, height, title, alt)
74
 
{
75
 
    var img = document.createElement("img");
76
 
    img.setAttribute("src", src);
77
 
    if (width != null)
78
 
        img.setAttribute("width", width);
79
 
    if (height != null)
80
 
        img.setAttribute("height", height);
81
 
    if (title != null)
82
 
        img.setAttribute("title", title);
83
 
    if (alt == null) alt = "";
84
 
    img.setAttribute("alt", alt);
85
 
    return img;
86
 
}
87
 
 
88
 
/** Given a number of bytes, returns a string representing the file size in a
89
 
 * human-readable format.
90
 
 * eg. nice_filesize(6) -> "6 bytes"
91
 
 *     nice_filesize(81275) -> "79.4 kB"
92
 
 *     nice_filesize(13498346) -> "12.9 MB"
93
 
 * \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.
94
69
 * \return String.
95
70
 */
96
 
function nice_filesize(bytes)
 
71
function pathlist_to_path(pathlist)
97
72
{
98
 
    if (bytes == null) return "";
99
 
    var size;
100
 
    if (bytes < 1024)
101
 
        return bytes.toString() + " B";
102
 
    size = bytes / 1024;
103
 
    if (size < 1024)
104
 
        return size.toFixed(1) + " kB";
105
 
    size = size / 1024;
106
 
    if (size < 1024)
107
 
        return size.toFixed(1) + " MB";
108
 
    size = size / 1024;
109
 
    return size.toFixed(1) + " GB";
 
73
    ret = "";
 
74
    for (var i=0; i<pathlist.length; i++)
 
75
    {
 
76
        ret += pathlist[i] + "/";
 
77
    }
 
78
    return ret;
110
79
}
111
80
 
112
81
/** Given a URL, returns an object containing a number of attributes
128
97
 * whose names appear multiple times.
129
98
 * args is never null, though it may be empty.
130
99
 *
131
 
 * All strings are decoded/unescaped. Reserved characters
132
 
 * (; , / ? : @ & = + * $) are not decoded except in args.
 
100
 * The args strings are decoded from URL encoding form. Other strings are left
 
101
 * in raw URL form.
133
102
 *
134
103
 * \param url String. A URL. To read from the current browser window, use
135
104
 *  window.location.href.
142
111
    var serverpart;
143
112
    var args;
144
113
 
145
 
    url = decodeURI(url);
146
 
 
147
114
    /* Split scheme from rest */
148
115
    index = url.indexOf("://");
149
116
    if (index < 0)
164
131
    else
165
132
    {
166
133
        serverpart = url.substr(0, index);
167
 
        url = url.substr(index);
 
134
        url = url.substr(index+1);
168
135
    }
169
136
 
170
137
    /* Split server name from port */
215
182
            /* Ignore malformed args */
216
183
            if (index >= 0)
217
184
            {
218
 
                arg_key = decodeURIComponent(arg_str.substr(0, index));
219
 
                arg_val = decodeURIComponent(arg_str.substr(index+1));
 
185
                arg_key = decodeURI(arg_str.substr(0, index));
 
186
                arg_val = decodeURI(arg_str.substr(index+1));
220
187
                if (arg_key in args)
221
188
                {
222
189
                    /* Collision - make an array */
235
202
    return obj;
236
203
}
237
204
 
238
 
/** Builds a query_string from an args object. Encodes the arguments.
239
 
 * \param args Args object as described in parse_url.
240
 
 * \return Query string portion of a URL.
241
 
 */
242
 
function make_query_string(args)
243
 
{
244
 
    var query_string = "";
245
 
    var arg_val;
246
 
    for (var arg_key in args)
247
 
    {
248
 
        arg_val = args[arg_key];
249
 
        if (arg_val instanceof Array)
250
 
            for (var i=0; i<arg_val.length; i++)
251
 
                query_string += "&" + encodeURIComponent(arg_key) + "=" +
252
 
                    encodeURIComponent(arg_val[i]);
253
 
        else
254
 
            query_string += "&" + encodeURIComponent(arg_key) + "=" +
255
 
                encodeURIComponent(arg_val);
256
 
    }
257
 
    if (query_string == "")
258
 
        query_string = null;
259
 
    else
260
 
        /* Drop the first "&" */
261
 
        query_string = query_string.substr(1);
262
 
 
263
 
    return query_string;
264
 
}
265
 
 
266
205
/** Given an object exactly of the form described for the output of parseurl,
267
 
 * returns a URL string built from those parameters. The URL is properly
268
 
 * encoded.
 
206
 * returns a URL string built from those parameters.
269
207
 * parseurl and buildurl are strict inverses of each other.
270
208
 * Note that either query_string or args may be supplied. If both are
271
209
 * supplied, query_string is preferred (because it keeps the argument order).
274
212
 * \param obj Object as returned by parseurl.
275
213
 * \return String, a URL.
276
214
 */
277
 
function build_url(obj)
 
215
function buildurl(obj)
278
216
{
279
217
    var url = "";
280
218
    var query_string = null;
281
219
 
282
 
    if (("scheme" in obj) && obj.scheme != null)
 
220
    if (!("scheme" in obj) || obj.scheme != null)
283
221
        url = obj.scheme.toString() + "://";
284
 
    if (("server_name" in obj) && obj.server_name != null)
 
222
    if (!("server_name" in obj) || obj.server_name != null)
285
223
        url += obj.server_name.toString();
286
 
    if (("server_port" in obj) && obj.server_port != null)
 
224
    if (!("server_port" in obj) || obj.server_port != null)
287
225
        url += ":" + obj.server_port.toString();
288
 
    if (("path" in obj) && obj.path != null)
 
226
    if (!("path" in obj) || obj.path != null)
289
227
    {
290
228
        var path = obj.path.toString();
291
 
        if (url.length > 0 && path.length > 0 && path[0] != "/")
 
229
        if (path.length > 0 && path[0] != "/")
292
230
            path = "/" + path;
293
231
        url += path;
294
232
    }
295
 
    if (("query_string" in obj) && obj.query_string != null)
 
233
    if (!("query_string" in obj) || obj.query_string != null)
296
234
        query_string = obj.query_string.toString();
297
 
    else if (("args" in obj) && obj.args != null)
298
 
        query_string = make_query_string(obj.args);
 
235
    else if (!("args" in obj) || obj.args != null)
 
236
    {
 
237
        query_string = "";
 
238
        var arg_val;
 
239
        for (var arg_key in obj.args)
 
240
        {
 
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]);
 
246
            else
 
247
                query_string += "&" + encodeURI(arg_key) + "=" +
 
248
                    encodeURI(arg_val);
 
249
   
 
250
        }
 
251
        if (query_string == "")
 
252
            query_string = null;
 
253
        else
 
254
            /* Drop the first "&" */
 
255
            query_string = query_string.substr(1);
 
256
    }
299
257
 
300
258
    if (query_string != null)
301
259
        url += "?" + query_string;
302
260
 
303
 
    return encodeURI(url);
 
261
    return url;
304
262
}
305
263
 
306
264
/** Given an argument map, as output in the args parameter of the return of
342
300
    else
343
301
        return [r];
344
302
}
345
 
 
346
 
/** Joins one or more paths together. Accepts 1 or more arguments.
347
 
 */
348
 
function path_join(path1 /*, path2, ... */)
349
 
{
350
 
    var arg;
351
 
    path = path1;
352
 
    for (var i=1; i<arguments.length; i++)
353
 
    {
354
 
        arg = arguments[i];
355
 
        if (arg.length == 0) continue;
356
 
        if (arg[0] == '/')
357
 
            path = arg;
358
 
        else
359
 
        {
360
 
            if (path[path.length-1] != '/')
361
 
                path += '/';
362
 
            path += arg;
363
 
        }
364
 
    }
365
 
    return path;
366
 
}
367
 
 
368
 
 
369
 
/** Builds a multipart_formdata string from an args object. Similar to
370
 
 * make_query_string, but it returns data of type "multipart/form-data"
371
 
 * instead of "application/x-www-form-urlencoded". This is good for
372
 
 * encoding large strings such as text objects from the editor.
373
 
 * Should be written with a Content-Type of
374
 
 * "multipart/form-data, boundary=<boundary>".
375
 
 * All fields are sent with a Content-Type of text/plain.
376
 
 * \param args Args object as described in parse_url.
377
 
 * \param boundary Random "magic" string which DOES NOT appear in any of
378
 
 *  the argument values. This should match the "boundary=" value written to
379
 
 *  the Content-Type header.
380
 
 * \return String in multipart/form-data format.
381
 
 */
382
 
function make_multipart_formdata(args, boundary)
383
 
{
384
 
    var data = "";
385
 
    var arg_val;
386
 
    /* Mutates data */
387
 
    var extend_data = function(arg_key, arg_val)
388
 
    {
389
 
        /* FIXME: Encoding not supported here (should not matter if we
390
 
         * only use ASCII names */
391
 
        data += "--" + boundary + "\n"
392
 
            + "Content-Disposition: form-data; name=\"" + arg_key
393
 
            + "\"\n\n"
394
 
            + arg_val + "\n";
395
 
    }
396
 
 
397
 
    for (var arg_key in args)
398
 
    {
399
 
        arg_val = args[arg_key];
400
 
        if (arg_val instanceof Array)
401
 
            for (var i=0; i<arg_val.length; i++)
402
 
            {
403
 
                extend_data(arg_key, arg_val[i]);
404
 
            }
405
 
        else
406
 
            extend_data(arg_key, arg_val);
407
 
    }
408
 
    /* End boundary */
409
 
    data += "--" + boundary + "--\n";
410
 
 
411
 
    return data;
412
 
}
413
 
 
414
 
/** Converts a list of directories into a path name, with a slash at the end.
415
 
 * \param pathlist List of strings.
416
 
 * \return String.
417
 
 */
418
 
function pathlist_to_path(pathlist)
419
 
{
420
 
    ret = path_join.apply(null, pathlist);
421
 
    if (ret[ret.length-1] != '/')
422
 
        ret += '/';
423
 
    return ret;
424
 
}
425
 
 
426
 
/** Given a path relative to the IVLE root, gives a path relative to
427
 
 * the site root.
428
 
 */
429
 
function make_path(path)
430
 
{
431
 
    return path_join(root_dir, path);
432
 
}
433
 
 
434
 
/** Makes an XMLHttpRequest call to the server. Waits (synchronously) for a
435
 
 * response, and returns an XMLHttpRequest object containing the completed
436
 
 * response.
437
 
 *
438
 
 * \param app IVLE app to call (such as "fileservice").
439
 
 * \param path URL path to make the request to, within the application.
440
 
 * \param args Argument object, as described in parse_url and friends.
441
 
 * \param method String; "GET" or "POST"
442
 
 * \param content_type String, optional. Only applies if method is "POST".
443
 
 *      May be "application/x-www-form-urlencoded" or "multipart/form-data".
444
 
 *      Defaults to "application/x-www-form-urlencoded".
445
 
 * \return An XMLHttpRequest object containing the completed response.
446
 
 */
447
 
function ajax_call(app, path, args, method, content_type)
448
 
{
449
 
    if (content_type != "multipart/form-data")
450
 
        content_type = "application/x-www-form-urlencoded";
451
 
    path = make_path(path_join(app, path));
452
 
    var url;
453
 
    /* A random string, for multipart/form-data
454
 
     * (This is not checked against anywhere else, it is solely defined and
455
 
     * used within this function) */
456
 
    var boundary = "48234n334nu7n4n2ynonjn234t683jyh80j";
457
 
    var xhr = new XMLHttpRequest();
458
 
    if (method == "GET")
459
 
    {
460
 
        /* GET sends the args in the URL */
461
 
        url = build_url({"path": path, "args": args});
462
 
        /* open's 3rd argument = false -> SYNCHRONOUS (wait for response)
463
 
         * (No need for a callback function) */
464
 
        xhr.open(method, url, false);
465
 
        xhr.send(null);
466
 
    }
467
 
    else
468
 
    {
469
 
        /* POST sends the args in application/x-www-form-urlencoded */
470
 
        url = encodeURI(path);
471
 
        xhr.open(method, url, false);
472
 
        var message;
473
 
        if (content_type == "multipart/form-data")
474
 
        {
475
 
            xhr.setRequestHeader("Content-Type",
476
 
                "multipart/form-data, boundary=" + boundary);
477
 
            message = make_multipart_formdata(args, boundary);
478
 
        }
479
 
        else
480
 
        {
481
 
            xhr.setRequestHeader("Content-Type", content_type);
482
 
            message = make_query_string(args);
483
 
        }
484
 
        xhr.send(message);
485
 
    }
486
 
    return xhr;
487
 
}
488