← Back to branch summary

~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-07-27 11:44:59 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:955
browser: Restyled "special home" page. Now much more in-line with the existing
    file browser interface.
    Includes changes to JavaScript (the DOM layout).
    Reduced h1s -> h2s, h2s -> h3s (since H1 is the full IVLE heading).
    Added colours, borders and padding to reduce space usage on the page.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/media/common/util.js
25
25
/* Expects the following variables to have been declared by JavaScript in
26
26
 * the HTML generated by the server:
27
27
 * - root_dir
 
28
 * - public_host
28
29
 * - username
29
30
 */
30
31
 
310
311
    if (("path" in obj) && obj.path != null)
311
312
    {
312
313
        var path = urlencode_path(obj.path.toString());
313
 
        if (url.length > 0 && path.length > 0 && path[0] != "/")
 
314
        if (url.length > 0 && path.length > 0 && path.charAt(0) != "/")
314
315
            path = "/" + path;
315
316
        url += path;
316
317
    }
341
342
    return path;
342
343
}
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
    }
 
377
}
 
378
 
344
379
/** Given an argument map, as output in the args parameter of the return of
345
380
 * parseurl, gets the first occurence of an argument in the URL string.
346
381
 * If the argument was not found, returns null.
391
426
    {
392
427
        arg = arguments[i];
393
428
        if (arg.length == 0) continue;
394
 
        if (arg[0] == '/')
 
429
        if (arg.charAt(0) == '/')
395
430
            path = arg;
396
431
        else
397
432
        {
398
 
            if (path.length > 0 && path[path.length-1] != '/')
 
433
            if (path.length > 0 && path.charAt(path.length-1) != '/')
399
434
                path += '/';
400
435
            path += arg;
401
436
        }
456
491
function pathlist_to_path(pathlist)
457
492
{
458
493
    ret = path_join.apply(null, pathlist);
459
 
    if (ret[ret.length-1] != '/')
 
494
    if (ret.charAt(ret.length-1) != '/')
460
495
        ret += '/';
461
496
    return ret;
462
497
}
477
512
    return make_path(path_join.apply(null, arguments));
478
513
}
479
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
 
480
523
/** Given a path, gets the "basename" (the last path segment).
481
524
 */
482
525
function path_basename(path)
519
562
    arr.splice(j, i-j);
520
563
}
521
564
 
522
 
/** Makes an XMLHttpRequest call to the server. Waits (synchronously) for a
523
 
 * response, and returns an XMLHttpRequest object containing the completed
524
 
 * response.
 
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.
525
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.
526
631
 * \param app IVLE app to call (such as "fileservice").
527
632
 * \param path URL path to make the request to, within the application.
528
633
 * \param args Argument object, as described in parse_url and friends.
530
635
 * \param content_type String, optional. Only applies if method is "POST".
531
636
 *      May be "application/x-www-form-urlencoded" or "multipart/form-data".
532
637
 *      Defaults to "application/x-www-form-urlencoded".
533
 
 * \return An XMLHttpRequest object containing the completed response.
534
638
 */
535
 
function ajax_call(app, path, args, method, content_type)
 
639
function ajax_call(callback, app, path, args, method, content_type)
536
640
{
537
641
    if (content_type != "multipart/form-data")
538
642
        content_type = "application/x-www-form-urlencoded";
541
645
    /* A random string, for multipart/form-data
542
646
     * (This is not checked against anywhere else, it is solely defined and
543
647
     * used within this function) */
544
 
    var boundary = "48234n334nu7n4n2ynonjn234t683jyh80j";
545
 
    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
    }
546
661
    if (method == "GET")
547
662
    {
548
663
        /* GET sends the args in the URL */
549
664
        url = build_url({"path": path, "args": args});
550
 
        /* open's 3rd argument = false -> SYNCHRONOUS (wait for response)
551
 
         * (No need for a callback function) */
552
 
        xhr.open(method, url, false);
 
665
        /* open's 3rd argument = true -> asynchronous */
 
666
        xhr.open(method, url, asyncronous);
553
667
        xhr.send(null);
554
668
    }
555
669
    else
556
670
    {
557
671
        /* POST sends the args in application/x-www-form-urlencoded */
558
672
        url = encodeURI(path);
559
 
        xhr.open(method, url, false);
 
673
        xhr.open(method, url, asyncronous);
560
674
        var message;
561
675
        if (content_type == "multipart/form-data")
562
676
        {
563
677
            xhr.setRequestHeader("Content-Type",
564
 
                "multipart/form-data, boundary=" + boundary);
 
678
                "multipart/form-data; boundary=" + boundary);
565
679
            message = make_multipart_formdata(args, boundary);
566
680
        }
567
681
        else
569
683
            xhr.setRequestHeader("Content-Type", content_type);
570
684
            message = make_query_string(args);
571
685
        }
572
 
        xhr.setRequestHeader("Content-Length", message.length);
573
686
        xhr.send(message);
574
687
    }
575
 
    return xhr;
 
688
    /* Only return the XHR for syncronous requests */
 
689
    if (!asyncronous)
 
690
    { 
 
691
        return xhr;
 
692
    }
576
693
}
577
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
}