/*
 * Helma License Notice
 *
 * The contents of this file are subject to the Helma License
 * Version 2.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://adele.helma.org/download/helma/license.txt
 *
 * Copyright 1998-2007 Helma Software. All Rights Reserved.
 *
 * $RCSfile: Url.js,v $
 * $Author: zumbrunn $
 * $Revision: 8714 $
 * $Date: 2007-12-13 13:21:48 +0100 (Don, 13. Dez 2007) $
 */

/**
 * @fileoverview Fields and methods of the helma.Url class.
 * <br /><br />
 * To use this optional module, its repository needs to be added to the 
 * application, for example by calling app.addRepository('modules/helma/Url.js')
 */

if (!global.helma) {
    global.helma = {};
}


/**
 * Creates a helma.Url object from a provided url string.
 * 
 * @constructor
 */
helma.Url = function(str) {
    if (!str || !helma.Url.PATTERN.test(str))
        throw Error("Cannot create helma.Url: insufficient arguments");

    // filter punctuation from user-generated urls
    // FIXME: a) can this be done in helma.Url.PATTERN?
    //        b) should it be done rather in methods like activateUrls?
    str = str.replace(/[,.;:]\s/, "");

    var parts = helma.Url.PATTERN.exec(str);
    /**
     * Protocol segment of this URL
     */
    this.protocol = parts[1];

    if (!parts[2]) {
        if (parts[3])
            /**
             * User name segment of this URL
             */
            this.user = parts[3];
    } else {
        this.user = parts[2];
        if (parts[3])
            /**
             * Password segment of this URL
             */
            this.password = parts[3];
    }

    if (!parts[4])
        throw Error("Cannot create helma.Url: missing host part");

    /**
     * Fully qualified domain name segment of this URL
     */
    this.domainName = parts[4]; // actually, the fully-qualified domain name
    var fqdnParts = this.domainName.split(".");
    if (fqdnParts.length < 3)
        this.host = "";
    else {
        /**
         * Host name segment of this URL
         */
        this.host = fqdnParts[0];
        fqdnParts.splice(0, 1);
    }
    /**
     * Top level domain name segment of this URL
     */
    this.topLevelDomain = fqdnParts[fqdnParts.length-1];
    /**
     * Domain name segment of this URL
     */
    this.domain = fqdnParts.join(".");

    /**
     * Request path segment of this URL as string
     */
    this.pathString = parts[5] || "";
    if (this.pathString.indexOf("/") == 0)
        this.pathString = this.pathString.substring(1);
    /**
     * Request path segment of this URL as array
     */
    this.path = this.pathString.split("/");
    /**
     * File name segment of this URL
     */
    this.file = this.path.pop();

    if (parts[6]) {
        /**
         * Query parameter segment of this URL as string
         */
        this.queryString = parts[6];
        var pairs;
        /**
         * Query parameter segment of this URL as object
         */
        this.query = {};
        parts = parts[6].split("&");
        for (var i in parts) {
            pairs = parts[i].split("=");
            this.query[pairs[0]] = pairs[1];
        }
    }

    return this;
};


helma.Url.PATTERN = /^([^:]*):\/\/+(?:([^\/]*):)?(?:([^\/]*)@)?([\w\-_.]*[^.])(\/[^?]*)?(?:\?(.*))?$/;
