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

« back to all changes in this revision

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

  • Committer: wagrant
  • Date: 2008-08-07 05:24:56 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:987
editor: Use HTML highlighting for XML by default.

Show diffs side-by-side

added added

removed removed

Lines of Context:
22
22
 * Defines some generic JavaScript utility functions.
23
23
 */
24
24
 
 
25
/* Expects the following variables to have been declared by JavaScript in
 
26
 * the HTML generated by the server:
 
27
 * - root_dir
 
28
 * - public_host
 
29
 * - username
 
30
 */
 
31
 
25
32
/** Removes all children of a given DOM element
26
33
 * \param elem A DOM Element. Will be modified.
27
34
 */
34
41
/** Creates a DOM element with simple text inside it.
35
42
 * \param tagname String. Name of the element's tag (eg. "p").
36
43
 * \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).
37
46
 * \return DOM Element object.
38
47
 */
39
 
function dom_make_text_elem(tagname, text)
 
48
function dom_make_text_elem(tagname, text, title)
40
49
{
 
50
    if (text == null) text = "";
41
51
    var elem = document.createElement(tagname);
42
 
    elem.appendChild(document.createTextNode(text));
 
52
    var textnode;
 
53
    if (title == null)
 
54
        textnode = document.createTextNode(text);
 
55
    else
 
56
    {
 
57
        textnode = document.createElement("span");
 
58
        textnode.setAttribute("title", title);
 
59
        textnode.appendChild(document.createTextNode(text));
 
60
    }
 
61
    elem.appendChild(textnode);
43
62
    return elem;
44
63
}
45
64
 
46
65
/** Creates a DOM element with hyperlinked text inside it.
47
66
 * \param tagname String. Name of the element's tag (eg. "p").
48
67
 * \param text String. Text to be placed inside the element.
 
68
 * \param title String, optional. Sets a tooltip for the link.
49
69
 * \param href String. URL the text will link to. This is a raw string,
50
70
 *  it will automatically be URL-encoded.
51
71
 * \param onclick Optional string. Will be set as the "onclick" attribute
52
72
 *  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.
53
76
 * \return DOM Element object.
54
77
 */
55
 
function dom_make_link_elem(tagname, text, href, onclick)
 
78
function dom_make_link_elem(tagname, text, title, href, onclick, dontencode)
56
79
{
 
80
    if (text == null) text = "";
 
81
    if (href == null) href = "";
57
82
    var elem = document.createElement(tagname);
58
83
    var link = document.createElement("a");
59
 
    link.setAttribute("href", encodeURI(href));
 
84
    if (dontencode != true)
 
85
        href = urlencode_path(href);
 
86
    link.setAttribute("href", href);
 
87
    if (title != null)
 
88
        link.setAttribute("title", title);
60
89
    if (onclick != null)
61
90
        link.setAttribute("onclick", onclick);
62
91
    link.appendChild(document.createTextNode(text));
64
93
    return elem;
65
94
}
66
95
 
 
96
/** Creates a DOM img element. All parameters are optional except src.
 
97
 * If alt (compulsory in HTML) is omitted, will be set to "".
 
98
 */
 
99
function dom_make_img(src, width, height, title, alt)
 
100
{
 
101
    var img = document.createElement("img");
 
102
    img.setAttribute("src", urlencode_path(src));
 
103
    if (width != null)
 
104
        img.setAttribute("width", width);
 
105
    if (height != null)
 
106
        img.setAttribute("height", height);
 
107
    if (title != null)
 
108
        img.setAttribute("title", title);
 
109
    if (alt == null) alt = "";
 
110
    img.setAttribute("alt", alt);
 
111
    return img;
 
112
}
 
113
 
67
114
/** Given a number of bytes, returns a string representing the file size in a
68
115
 * human-readable format.
69
116
 * eg. nice_filesize(6) -> "6 bytes"
74
121
 */
75
122
function nice_filesize(bytes)
76
123
{
 
124
    if (bytes == null) return "";
77
125
    var size;
78
126
    if (bytes < 1024)
79
 
        return bytes.toString() + " bytes";
 
127
        return bytes.toString() + " B";
80
128
    size = bytes / 1024;
81
129
    if (size < 1024)
82
130
        return size.toFixed(1) + " kB";
107
155
 * args is never null, though it may be empty.
108
156
 *
109
157
 * All strings are decoded/unescaped. Reserved characters
110
 
 * (; , / ? : @ & = + * $) are not decoded except in args.
 
158
 * (; , / ? : @ & = + * $) are not decoded except in args and path.
111
159
 *
112
160
 * \param url String. A URL. To read from the current browser window, use
113
161
 *  window.location.href.
120
168
    var serverpart;
121
169
    var args;
122
170
 
123
 
    url = decodeURI(url);
124
 
 
125
171
    /* Split scheme from rest */
126
172
    index = url.indexOf("://");
127
173
    if (index < 0)
142
188
    else
143
189
    {
144
190
        serverpart = url.substr(0, index);
145
 
        url = url.substr(index+1);
 
191
        url = url.substr(index);
146
192
    }
147
193
 
148
194
    /* Split server name from port */
178
224
            obj.query_string = url.substr(index+1);
179
225
        }
180
226
    }
 
227
    obj.path = decodeURIComponent(obj.path);
181
228
 
182
229
    /* Split query string into arguments */
183
230
    args = {};
232
279
            query_string += "&" + encodeURIComponent(arg_key) + "=" +
233
280
                encodeURIComponent(arg_val);
234
281
    }
235
 
    if (query_string == "")
236
 
        query_string = null;
237
 
    else
 
282
    if (query_string != "")
238
283
        /* Drop the first "&" */
239
284
        query_string = query_string.substr(1);
240
285
 
265
310
        url += ":" + obj.server_port.toString();
266
311
    if (("path" in obj) && obj.path != null)
267
312
    {
268
 
        var path = obj.path.toString();
269
 
        if (url.length > 0 && path.length > 0 && path[0] != "/")
 
313
        var path = urlencode_path(obj.path.toString());
 
314
        if (url.length > 0 && path.length > 0 && path.charAt(0) != "/")
270
315
            path = "/" + path;
271
316
        url += path;
272
317
    }
273
318
    if (("query_string" in obj) && obj.query_string != null)
274
 
        query_string = obj.query_string.toString();
 
319
        query_string = encodeURI(obj.query_string.toString());
275
320
    else if (("args" in obj) && obj.args != null)
276
321
        query_string = make_query_string(obj.args);
277
322
 
278
 
    if (query_string != null)
 
323
    if (query_string != "" && query_string != null)
279
324
        url += "?" + query_string;
280
325
 
281
 
    return encodeURI(url);
 
326
    return url;
 
327
}
 
328
 
 
329
/** URL-encodes a path. This is a special case of URL encoding as all
 
330
 * characters *except* the slash must be encoded.
 
331
 */
 
332
function urlencode_path(path)
 
333
{
 
334
    /* Split up the path, URLEncode each segment with encodeURIComponent,
 
335
     * and rejoin.
 
336
     */
 
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;
 
342
    return path;
 
343
}
 
344
 
 
345
/** Writes a JSONable object to the cookie under a particular key
 
346
 * (JSON encoded and URL encoded).
 
347
 */
 
348
function write_cookie(key, value)
 
349
{
 
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;
 
356
}
 
357
/** Reads a cookie which has a JSONable object encoded as its value.
 
358
 * Returns the object, parsed from JSON.
 
359
 */
 
360
function read_cookie(key)
 
361
{
 
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++)
 
366
    {
 
367
        var cookie = cookies[i];
 
368
        while (cookie[0] == ' ')
 
369
            cookie = cookie.substr(1);
 
370
        if (cookie.substr(0, checklen) == checkstart)
 
371
        {
 
372
            var valstr = cookie.substr(checklen);
 
373
            valstr = decodeURIComponent(valstr);
 
374
            return JSON.parse(valstr);
 
375
        }
 
376
    }
282
377
}
283
378
 
284
379
/** Given an argument map, as output in the args parameter of the return of
326
421
function path_join(path1 /*, path2, ... */)
327
422
{
328
423
    var arg;
329
 
    path = path1;
330
 
    for (var i=1; i<arguments.length; i++)
 
424
    var path = "";
 
425
    for (var i=0; i<arguments.length; i++)
331
426
    {
332
427
        arg = arguments[i];
333
428
        if (arg.length == 0) continue;
334
 
        if (arg[0] == '/')
 
429
        if (arg.charAt(0) == '/')
335
430
            path = arg;
336
431
        else
337
432
        {
338
 
            if (path[path.length-1] != '/')
 
433
            if (path.length > 0 && path.charAt(path.length-1) != '/')
339
434
                path += '/';
340
435
            path += arg;
341
436
        }
366
461
    {
367
462
        /* FIXME: Encoding not supported here (should not matter if we
368
463
         * only use ASCII names */
369
 
        data += "--" + boundary + "\n"
 
464
        data += "--" + boundary + "\r\n"
370
465
            + "Content-Disposition: form-data; name=\"" + arg_key
371
 
            + "\"\n\n"
372
 
            + arg_val + "\n";
 
466
            + "\"\r\n\r\n"
 
467
            + arg_val + "\r\n";
373
468
    }
374
469
 
375
470
    for (var arg_key in args)
384
479
            extend_data(arg_key, arg_val);
385
480
    }
386
481
    /* End boundary */
387
 
    data += "--" + boundary + "--\n";
 
482
    data += "--" + boundary + "--\r\n";
388
483
 
389
484
    return data;
390
485
}
396
491
function pathlist_to_path(pathlist)
397
492
{
398
493
    ret = path_join.apply(null, pathlist);
399
 
    if (ret[ret.length-1] != '/')
 
494
    if (ret.charAt(ret.length-1) != '/')
400
495
        ret += '/';
401
496
    return ret;
402
497
}
409
504
    return path_join(root_dir, path);
410
505
}
411
506
 
412
 
/** Makes an XMLHttpRequest call to the server. Waits (synchronously) for a
413
 
 * response, and returns an XMLHttpRequest object containing the completed
414
 
 * response.
 
507
/** Shorthand for make_path(path_join(app, ...))
 
508
 * Creates an absolute path for a given path within a given app.
 
509
 */
 
510
function app_path(app /*,...*/)
 
511
{
 
512
    return make_path(path_join.apply(null, arguments));
 
513
}
 
514
 
 
515
/** Generates an absolute URL to a public application
 
516
 */
 
517
function public_app_path(app /*,...*/)
 
518
{
 
519
    return location.protocol + "//" + public_host
 
520
        + make_path(path_join.apply(null, arguments));
 
521
}
 
522
 
 
523
/** Given a path, gets the "basename" (the last path segment).
 
524
 */
 
525
function path_basename(path)
 
526
{
 
527
    segments = path.split("/");
 
528
    if (segments[segments.length-1].length == 0)
 
529
        return segments[segments.length-2];
 
530
    else
 
531
        return segments[segments.length-1];
 
532
}
 
533
 
 
534
/** Given a string str, determines whether it ends with substr */
 
535
function endswith(str, substring)
 
536
{
 
537
    if (str.length < substring.length) return false;
 
538
    return str.substr(str.length - substring.length) == substring;
 
539
}
 
540
 
 
541
/** Equivalent to Python's repr.
 
542
 * Gets the JavaScript string representation.
 
543
 * Actually just calls JSON.stringify.
 
544
 */
 
545
function repr(str)
 
546
{
 
547
    return JSON.stringify(str);
 
548
}
 
549
 
 
550
/** Removes all occurences of a value from an array.
 
551
 */
 
552
Array.prototype.removeall = function(val)
 
553
{
 
554
    var i, j;
 
555
    var arr = this;
 
556
    j = 0;
 
557
    for (i=0; i<arr.length; i++)
 
558
    {
 
559
        arr[j] = arr[i];
 
560
        if (arr[i] != val) j++;
 
561
    }
 
562
    arr.splice(j, i-j);
 
563
}
 
564
 
 
565
/** Shallow-clones an object */
 
566
function shallow_clone_object(obj)
 
567
{
 
568
    o = {};
 
569
    for (k in obj)
 
570
        o[k] = obj[k];
 
571
    return o;
 
572
}
 
573
 
 
574
/** Returns a new XMLHttpRequest object, in a somewhat browser-agnostic
 
575
 * fashion.
 
576
 */
 
577
function new_xmlhttprequest()
 
578
{
 
579
    try
 
580
    {
 
581
        /* Real Browsers */
 
582
        return new XMLHttpRequest();
 
583
    }
 
584
    catch (e)
 
585
    {
 
586
        /* Internet Explorer */
 
587
        try
 
588
        {
 
589
            return new ActiveXObject("Msxml2.XMLHTTP");
 
590
        }
 
591
        catch (e)
 
592
        {
 
593
            try
 
594
            {
 
595
                return new ActiveXObject("Microsoft.XMLHTTP");
 
596
            }
 
597
            catch (e)
 
598
            {
 
599
                throw("Your browser does not support AJAX. "
 
600
                    + "IVLE requires a modern browser.");
 
601
            }
 
602
        }
 
603
    }
 
604
}
 
605
 
 
606
/** Creates a random string of length length,
 
607
 * consisting of alphanumeric characters.
 
608
 */
 
609
var rand_chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXTZ"
 
610
               + "abcdefghiklmnopqrstuvwxyz";
 
611
function random_string(length)
 
612
{
 
613
    var str = Array(length);
 
614
    var v;
 
615
    for (var i=0; i<length; i++)
 
616
    {
 
617
        v = Math.floor(Math.random() * rand_chars.length);
 
618
        str[i] = rand_chars.charAt(v);
 
619
    }
 
620
    return str.join('');
 
621
}
 
622
 
 
623
/** Makes an XMLHttpRequest call to the server.
 
624
 * Sends the XMLHttpRequest object containing the completed response to a
 
625
 * specified callback function.
415
626
 *
 
627
 * \param callback A callback function. Will be called when the response is
 
628
 *      complete. Passed 1 parameter, an XMLHttpRequest object containing the
 
629
 *      completed response. If callback is null this is a syncronous request 
 
630
 *      otherwise this is an asynchronous request.
416
631
 * \param app IVLE app to call (such as "fileservice").
417
632
 * \param path URL path to make the request to, within the application.
418
633
 * \param args Argument object, as described in parse_url and friends.
420
635
 * \param content_type String, optional. Only applies if method is "POST".
421
636
 *      May be "application/x-www-form-urlencoded" or "multipart/form-data".
422
637
 *      Defaults to "application/x-www-form-urlencoded".
423
 
 * \return An XMLHttpRequest object containing the completed response.
424
638
 */
425
 
function ajax_call(app, path, args, method, content_type)
 
639
function ajax_call(callback, app, path, args, method, content_type)
426
640
{
427
641
    if (content_type != "multipart/form-data")
428
642
        content_type = "application/x-www-form-urlencoded";
429
 
    path = make_path(path_join(app, path));
 
643
    path = app_path(app, path);
430
644
    var url;
431
645
    /* A random string, for multipart/form-data
432
646
     * (This is not checked against anywhere else, it is solely defined and
433
647
     * used within this function) */
434
 
    var boundary = "48234n334nu7n4n2ynonjn234t683jyh80j";
435
 
    var xhr = new XMLHttpRequest();
 
648
    var boundary = random_string(20);
 
649
    var xhr = new_xmlhttprequest();
 
650
    var asyncronous = callback != null;
 
651
    if (asyncronous)
 
652
    {
 
653
        xhr.onreadystatechange = function()
 
654
            {
 
655
                if (xhr.readyState == 4)
 
656
                {
 
657
                    callback(xhr);
 
658
                }
 
659
            }
 
660
    }
436
661
    if (method == "GET")
437
662
    {
438
663
        /* GET sends the args in the URL */
439
664
        url = build_url({"path": path, "args": args});
440
 
        /* open's 3rd argument = false -> SYNCHRONOUS (wait for response)
441
 
         * (No need for a callback function) */
442
 
        xhr.open(method, url, false);
443
 
        xhr.send("");
 
665
        /* open's 3rd argument = true -> asynchronous */
 
666
        xhr.open(method, url, asyncronous);
 
667
        xhr.send(null);
444
668
    }
445
669
    else
446
670
    {
447
671
        /* POST sends the args in application/x-www-form-urlencoded */
448
672
        url = encodeURI(path);
449
 
        xhr.open(method, url, false);
 
673
        xhr.open(method, url, asyncronous);
450
674
        var message;
451
675
        if (content_type == "multipart/form-data")
452
676
        {
453
677
            xhr.setRequestHeader("Content-Type",
454
 
                "multipart/form-data, boundary=" + boundary);
 
678
                "multipart/form-data; boundary=" + boundary);
455
679
            message = make_multipart_formdata(args, boundary);
456
680
        }
457
681
        else
461
685
        }
462
686
        xhr.send(message);
463
687
    }
464
 
    return xhr;
 
688
    /* Only return the XHR for syncronous requests */
 
689
    if (!asyncronous)
 
690
    { 
 
691
        return xhr;
 
692
    }
465
693
}
466
694
 
 
695
/** Attempts to JSON decodes a response object
 
696
 * If a non-200 response or the JSON decode fails then returns null
 
697
 */
 
698
function decode_response(response)
 
699
{
 
700
    if (response.status == 200)
 
701
    {
 
702
        try
 
703
        {
 
704
            var responseText = response.responseText;
 
705
            return JSON.parse(responseText);
 
706
        }
 
707
        catch (e)
 
708
        {
 
709
            // Pass
 
710
        }
 
711
     }
 
712
    
 
713
     return null;
 
714
}