jsdav-ext/lib/DAV/collection.js

jsDAV allows you to easily add WebDAV support to a NodeJS application. jsDAV is meant to cover the entire standard, and attempts to allow integration using an easy to understand API.

/*
 * @package jsDAV
 * @subpackage DAV
 * @copyright Copyright(c) 2011 Ajax.org B.V. <info AT ajax DOT org>
 * @author Mike de Boer <info AT mikedeboer DOT nl>
 * @license http://github.com/mikedeboer/jsDAV/blob/master/LICENSE MIT License
 */

"use strict";

var jsDAV_Node = require("./node");
var jsDAV_iCollection = require("./interfaces/iCollection");

var Exc = require("./../shared/exceptions");

/**
 * jsDAV_Collection class
 *
 * This is a helper class, that should aid in getting collection/ directory classes 
 * setup.
 * Most of its methods are implemented, and throw permission denied exceptions
 */
var jsDAV_Collection = module.exports = jsDAV_Node.extend(jsDAV_iCollection, {
    /**
     * Returns a child object, by its name.
     *
     * This method makes use of the getChildren method to grab all the child nodes,
     * and compares the name.
     * Generally its wise to override this, as this can usually be optimized
     *
     * @param {String} name
     * @throws Exc.FileNotFound
     * @return jsDAV_INode
     */
    getChild: function(name, cbgetchildabs) {
        this.getChildren(function(err, c) {
            var child;
            var i = 0;
            var l = c.length;
            for (; i < l; ++i) {
                child = c[i];
                if (child.getName() == name)
                    return cbgetchildabs(null, child);
            }
            cbgetchildabs(new Exc.FileNotFound("File not found: " + name));
        });
    },

    /**
     * Creates a new file in the directory
     *
     * @param {String} name Name of the file
     * @param {String} data Initial payload
     * @throws Exc.Forbidden
     * @return void
     */
    createFile: function(name, data, cbcreatefileabs) {
        cbcreatefileabs(new Exc.Forbidden(
            "Permission denied to create file (filename " + name + ")")
        );
    },

    /**
     * Creates a new subdirectory
     *
     * @param {String} name
     * @throws Exc.Forbidden
     * @return void
     */
    createDirectory: function(name, cbcreatedirabs) {
        cbcreatedirabs(
            new Exc.Forbidden("Permission denied to create directory")
        );
    }
});