sliver.deploymentNetwork -> deployment network
[plstackapi.git] / planetstack / core / xoslib / static / js / xoslib / xos-backbone.js
index bbf13a4..6a7b9d9 100644 (file)
@@ -6,16 +6,24 @@ if (! window.XOSLIB_LOADED ) {
     SLICEROLE_API = "/plstackapi/slice_roles/";
     NODE_API = "/plstackapi/nodes/";
     SITE_API = "/plstackapi/sites/";
+    SITEDEPLOYMENT_API = "/plstackapi/sitedeployments/";
     USER_API = "/plstackapi/users/";
     USERDEPLOYMENT_API = "/plstackapi/user_deployments/";
     DEPLOYMENT_API = "/plstackapi/deployments/";
     IMAGE_API = "/plstackapi/images/";
+    IMAGEDEPLOYMENTS_API = "/plstackapi/imagedeployments/";
     NETWORKTEMPLATE_API = "/plstackapi/networktemplates/";
     NETWORK_API = "/plstackapi/networks/";
     NETWORKSLIVER_API = "/plstackapi/networkslivers/";
     SERVICE_API = "/plstackapi/services/";
     SLICEPRIVILEGE_API = "/plstackapi/slice_privileges/";
     NETWORKDEPLOYMENT_API = "/plstackapi/networkdeployments/";
+    FLAVOR_API = "/plstackapi/flavors/";
+    CONTROLLER_API = "/plstackapi/controllers/";
+
+    /* removed
+    CONTROLLERSITEDEPLOYMENT_API = "/plstackapi/controllersitedeploymentses";
+    */
 
     /* changed as a side effect of the big rename
     SLICEDEPLOYMENT_API = "/plstackapi/slice_deployments/";
@@ -26,8 +34,16 @@ if (! window.XOSLIB_LOADED ) {
     USERDEPLOYMENT_API = "/plstackapi/userdeployments/";
 
     SLICEPLUS_API = "/xoslib/slicesplus/";
+    TENANTVIEW_API = "/xoslib/tenantview/"
 
     XOSModel = Backbone.Model.extend({
+        relatedCollections: [],
+        foreignCollections: [],
+        foreignFields: {},
+        m2mFields: {},
+        readonlyFields: [],
+        detailLinkFields: [],
+
         /* from backbone-tastypie.js */
         //idAttribute: 'resource_uri',
 
@@ -68,7 +84,64 @@ if (! window.XOSLIB_LOADED ) {
                     }\r
                 }\r
                 return res;\r
-            }
+            },
+
+            save: function(attributes, options) {
+                if (this.preSave) {
+                    this.preSave();
+                }
+                return Backbone.Model.prototype.save.call(this, attributes, options);
+            },
+
+            getChoices: function(fieldName, excludeChosen) {
+                choices=[];
+                if (fieldName in this.m2mFields) {
+                    for (index in xos[this.m2mFields[fieldName]].models) {
+                        candidate = xos[this.m2mFields[fieldName]].models[index];
+                        if (excludeChosen && idInArray(candidate.id, this.attributes[fieldName])) {
+                            continue;
+                        }
+                        choices.push(candidate.id);
+                    }
+                }
+                return choices;
+            },
+
+            /* If a 'validate' method is supplied, then it will be called
+               automatically on save. Unfortunately, save calls neither the
+               'error' nor the 'success' callback if the validator fails.
+
+               For now, we're calling our validator 'xosValidate' so this
+               autoamtic validation doesn't occur.
+            */
+
+            xosValidate: function(attrs, options) {
+                errors = {};
+                foundErrors = false;
+                _.each(this.validators, function(validatorList, fieldName) {
+                    _.each(validatorList, function(validator) {
+                        if (fieldName in attrs) {
+                            validatorResult = validateField(validator, attrs[fieldName], this)
+                            if (validatorResult != true) {
+                                errors[fieldName] = validatorResult;
+                                foundErrors = true;
+                            }
+                        }
+                    });
+                });
+                if (foundErrors) {
+                    return errors;
+                }
+                // backbone.js semantics -- on successful validate, return nothing
+            },
+
+            /* uncommenting this would make validate() call xosValidate()
+            validate: function(attrs, options) {
+                r = this.xosValidate(attrs, options);
+                console.log("validate");
+                console.log(r);
+                return r;
+            }, */
     });
 
     XOSCollection = Backbone.Collection.extend({
@@ -87,6 +160,10 @@ if (! window.XOSLIB_LOADED ) {
 \r
         relatedCollections: [],\r
         foreignCollections: [],\r
+        foreignFields: {},\r
+        m2mFields: {},
+        readonlyFields: [],
+        detailLinkFields: [],\r
 \r
         sorted: function() {\r
             //console.log("sorted " + this.modelName);\r
@@ -222,6 +299,14 @@ if (! window.XOSLIB_LOADED ) {
             model.fetch(options);
         },
 
+        /* filterBy: note that this yields a new collection. If you pass that
+              collection to a CompositeView, then the CompositeView won't get
+              any events that trigger on the original collection.
+
+              Using this function is probably wrong, and I wrote
+              FilteredCompositeView() to replace it.
+        */
+
         filterBy: function(fieldName, value) {
              filtered = this.filter(function(obj) {
                  return obj.get(fieldName) == value;
@@ -234,18 +319,12 @@ if (! window.XOSLIB_LOADED ) {
                     var url = this.urlRoot || ( models && models.length && models[0].urlRoot );
                     url && ( url += ( url.length > 0 && url.charAt( url.length - 1 ) === '/' ) ? '' : '/' );
 
-                    // Build a url to retrieve a set of models. This assume the last part of each model's idAttribute
-                    // (set to 'resource_uri') contains the model's id.
-                    if ( models && models.length ) {
-                            var ids = _.map( models, function( model ) {
-                                            var parts = _.compact( model.id.split('/') );
-                                            return parts[ parts.length - 1 ];
-                                    });
-                            url += 'set/' + ids.join(';') + '/';
-                    }
-
                     url && ( url += "?no_hyperlinks=1" );
 
+                    if (this.currentUserCanSee) {
+                        url && ( url += "&current_user_can_see=1" );
+                    }
+
                     return url;
             },
 
@@ -260,11 +339,38 @@ if (! window.XOSLIB_LOADED ) {
             },
     });
 
+    function get_defaults(modelName) {
+        if ((typeof xosdefaults !== "undefined") && xosdefaults[modelName]) {
+            return xosdefaults[modelName];
+        }
+        return undefined;
+    }
+
+    function extend_defaults(modelName, stuff) {
+        defaults = get_defaults(modelName);
+        if (defaults) {
+            return $.extend({}, defaults, stuff);
+        } else {
+            return stuff;
+        }
+    }
+
     function define_model(lib, attrs) {
         modelName = attrs.modelName;
         modelClassName = modelName;
+        collectionClass = attrs.collectionClass || XOSCollection;
         collectionClassName = modelName + "Collection";
 
+        if (!attrs.addFields) {
+            attrs.addFields = attrs.detailFields;
+        }
+
+        attrs.inputType = attrs.inputType || {};
+        attrs.foreignFields = attrs.foreignFields || {};
+        attrs.m2mFields = attrs.m2mFields || {};
+        attrs.readOnlyFields = attrs.readOnlyFields || [];
+        attrs.detailLinkFields = attrs.detailLinkFields || ["id","name"];
+
         if (!attrs.collectionName) {
             attrs.collectionName = modelName + "s";
         }
@@ -275,23 +381,36 @@ if (! window.XOSLIB_LOADED ) {
 
         for (key in attrs) {
             value = attrs[key];
-            if ($.inArray(key, ["urlRoot", "modelName"])>=0) {
+            if ($.inArray(key, ["urlRoot", "modelName", "collectionName", "listFields", "addFields", "detailFields", "detailLinkFields", "foreignFields", "inputType", "relatedCollections", "foreignCollections", "defaults"])>=0) {
                 modelAttrs[key] = value;
-            }
-            if ($.inArray(key, ["urlRoot", "modelName", "relatedCollections", "foreignCollections"])>=0) {
                 collectionAttrs[key] = value;
             }
+            if ($.inArray(key, ["validate", "preSave", "readOnlyFields"])) {
+                modelAttrs[key] = value;
+            }
         }
 
-        if (xosdefaults && xosdefaults[modelName]) {
-            modelAttrs["defaults"] = xosdefaults[modelName];
+        if (!modelAttrs.defaults) {
+            modelAttrs.defaults = get_defaults(modelName);
+        }
+
+//        if ((typeof xosdefaults !== "undefined") && xosdefaults[modelName]) {
+//            modelAttrs["defaults"] = xosdefaults[modelName];
+//        }
+
+        if ((typeof xosvalidators !== "undefined") && xosvalidators[modelName]) {
+            modelAttrs["validators"] = $.extend({}, xosvalidators[modelName], attrs["validators"] || {});
+        } else if (attrs["validators"]) {
+            modelAttrs["validators"] = attrs["validators"];
+            console.log(attrs);
+            console.log(modelAttrs);
         }
 
         lib[modelName] = XOSModel.extend(modelAttrs);
 
         collectionAttrs["model"] = lib[modelName];
 
-        lib[collectionClassName] = XOSCollection.extend(collectionAttrs);
+        lib[collectionClassName] = collectionClass.extend(collectionAttrs);
         lib[collectionName] = new lib[collectionClassName]();
 
         lib.allCollectionNames.push(collectionName);
@@ -302,74 +421,281 @@ if (! window.XOSLIB_LOADED ) {
         this.allCollectionNames = [];
         this.allCollections = [];
 
+        /* Give an id, the name of a collection, and the name of a field for models
+           within that collection, lookup the id and return the value of the field.
+        */
+
+        this.idToName = function(id, collectionName, fieldName) {
+            linkedObject = xos[collectionName].get(id);
+            if (linkedObject == undefined) {
+                return "#" + id;
+            } else {
+                return linkedObject.attributes[fieldName];
+            }
+        };
+
+        /* defining the models
+
+           modelName          - name of the model.
+
+           relatedCollections - collections which should be drawn as an inline
+                                list when the detail view is displayed.
+                                Format: <collection>:<collectionFieldName> where
+                                <collectionFieldName> is the name of the field
+                                in the collection that points back to the
+                                collection in the detail view.
+
+           foreignCollections - collections which are used in idToName() calls
+                                when presenting the data to the user. Used to
+                                create a listento event. Somewhat
+                                redundant with foreignFields.
+
+           foreignFields -      <localFieldName>:<collection>. Used to
+                                automatically map ids into humanReadableNames
+                                when presenting data to the user.
+
+           m2mfields -          <localFieldName>:<colleciton>. Used to
+                                populate choices in picker lists. Simalar to
+                                foreignFields.
+
+           listFields -         fields to display in lists
+
+           detailFields -       fields to display in detail views
+
+           addFields -          fields to display in popup add windows
+
+           inputType -          by default, "detailFields" will be displayed
+                                as text input controls. This will let you display
+                                a checkbox or a picker instead.
+        */
+
         define_model(this, {urlRoot: SLIVER_API,
                             relatedCollections: {"networkSlivers": "sliver"},
-                            foreignCollections: ["slices", "deployments", "images", "nodes", "users"],
-                            modelName: "sliver"});
+                            foreignCollections: ["slices", "deployments", "images", "nodes", "users", "flavors"],
+                            foreignFields: {"creator": "users", "image": "images", "node": "nodes", "deployment": "deployments", "slice": "slices", "flavor": "flavors"},
+                            modelName: "sliver",
+                            listFields: ["backend_status", "id", "name", "instance_id", "instance_name", "slice", "deployment", "image", "node", "flavor"],
+                            addFields: ["slice", "deployment", "flavor", "image", "node"],
+                            detailFields: ["backend_status", "name", "instance_id", "instance_name", "slice", "deployment", "flavor", "image", "node", "creator"],
+                            preSave: function() { if (!this.attributes.name && this.attributes.slice) { this.attributes.name = xos.idToName(this.attributes.slice, "slices", "name"); } },
+                            });
 
         define_model(this, {urlRoot: SLICE_API,
-                           relatedCollections: {"slivers": "slice", "sliceDeployments": "slice", "slicePrivileges": "slice", "networks": "owner"},
+                           relatedCollections: {"slivers": "slice", "slicePrivileges": "slice", "networks": "owner"},
                            foreignCollections: ["services", "sites"],
-                           modelName: "slice"});
-
-        define_model(this, {urlRoot: SLICEDEPLOYMENT_API,
-                           foreignCollections: ["slices", "deployments"],
-                           modelName: "sliceDeployment"});
+                           foreignFields: {"service": "services", "site": "sites"},
+                           listFields: ["backend_status", "id", "name", "enabled", "description", "slice_url", "site", "max_slivers", "service"],
+                           detailFields: ["backend_status", "name", "site", "enabled", "description", "slice_url", "max_slivers"],
+                           inputType: {"enabled": "checkbox"},
+                           modelName: "slice",
+                           xosValidate: function(attrs, options) {
+                               errors = XOSModel.prototype.xosValidate.call(this, attrs, options);
+                               // validate that slice.name starts with site.login_base
+                               site = attrs.site || this.site;
+                               if ((site!=undefined) && (attrs.name!=undefined)) {
+                                   site = xos.sites.get(site);
+                                   if (attrs.name.indexOf(site.attributes.login_base+"_") != 0) {
+                                        errors = errors || {};
+                                        errors["name"] = "must start with " + site.attributes.login_base + "_";
+                                   }
+                               }
+                               return errors;
+                             },
+                           });
 
         define_model(this, {urlRoot: SLICEPRIVILEGE_API,
                             foreignCollections: ["slices", "users", "sliceRoles"],
-                            modelName: "slicePrivilege"});
+                            modelName: "slicePrivilege",
+                            foreignFields: {"user": "users", "slice": "slices", "role": "sliceRoles"},
+                            listFields: ["backend_status", "id", "user", "slice", "role"],
+                            detailFields: ["backend_status", "user", "slice", "role"],
+                            });
 
         define_model(this, {urlRoot: SLICEROLE_API,
-                            modelName: "sliceRole"});
+                            modelName: "sliceRole",
+                            listFields: ["backend_status", "id", "role"],
+                            detailFields: ["backend_status", "role"],
+                            });
 
         define_model(this, {urlRoot: NODE_API,
                             foreignCollections: ["sites", "deployments"],
-                            modelName: "node"});
+                            modelName: "node",
+                            foreignFields: {"site": "sites", "deployment": "deployments"},
+                            listFields: ["backend_status", "id", "name", "site", "deployment"],
+                            detailFields: ["backend_status", "name", "site", "deployment"],
+                            });
 
         define_model(this, {urlRoot: SITE_API,
-                            relatedCollections: {"users": "site", "slices": "site", "nodes": "site"},
-                            modelName: "site"});
+                            relatedCollections: {"users": "site", "slices": "site", "nodes": "site", "siteDeployments": "site"},
+                            modelName: "site",
+                            listFields: ["backend_status", "id", "name", "site_url", "enabled", "login_base", "is_public", "abbreviated_name"],
+                            detailFields: ["backend_status", "name", "abbreviated_name", "url", "enabled", "is_public", "login_base"],
+                            inputType: {"enabled": "checkbox", "is_public": "checkbox"},
+                            });
+
+        define_model(this, {urlRoot: SITEDEPLOYMENT_API,
+                            foreignCollections: ["sites", "deployments", "controllers"],
+                            foreignFields: {"site": "sites", "deployment": "deployments", "controller": "controllers"},
+                            modelName: "siteDeployment",
+                            listFields: ["backend_status", "id", "site", "deployment", "controller", "availability_zone"],
+                            detailFields: ["backend_status", "site", "deployment", "controller", "availability_zone"],
+                            inputType: {"enabled": "checkbox", "is_public": "checkbox"},
+                            });
 
         define_model(this, {urlRoot: USER_API,
-                            relatedCollections: {"slicePrivileges": "user", "slices": "owner", "userDeployments": "user"},
+                            relatedCollections: {"slicePrivileges": "user", "slices": "owner"},
                             foreignCollections: ["sites"],
-                            modelName: "user"});
-
-        define_model(this, {urlRoot: USERDEPLOYMENT_API,
-                            foreignCollections: ["users","deployments"],
-                            modelName: "userDeployment"});
+                            modelName: "user",
+                            foreignFields: {"site": "sites"},
+                            listFields: ["backend_status", "id", "username", "firstname", "lastname", "phone", "user_url", "site"],
+                            detailFields: ["backend_status", "username", "firstname", "lastname", "phone", "user_url", "site"],
+                            });
 
         define_model(this, { urlRoot: DEPLOYMENT_API,
-                             relatedCollections: {"nodes": "deployment", "slivers": "deploymentNetwork", "networkDeployments": "deployment", "userDeployments": "deployment"},
-                             modelName: "deployment"});
+                             relatedCollections: {"nodes": "deployment", "slivers": "deployment"},
+                             m2mFields: {"flavors": "flavors", "sites": "sites", "images": "images"},
+                             modelName: "deployment",
+                             listFields: ["backend_status", "id", "name", "backend_type", "admin_tenant"],
+                             detailFields: ["backend_status", "name", "backend_type", "admin_tenant", "flavors", "sites", "images"],
+                             inputType: {"flavors": "picker", "sites": "picker", "images": "picker"},
+                             });
 
         define_model(this, {urlRoot: IMAGE_API,
                             model: this.image,
-                            modelName: "image"});
+                            modelName: "image",
+                            listFields: ["backend_status", "id", "name", "disk_format", "container_format", "path"],
+                            detailFields: ["backend_status", "name", "disk_format", "admin_tenant"],
+                            });
 
         define_model(this, {urlRoot: NETWORKTEMPLATE_API,
-                            modelName: "networkTemplate"});
+                            modelName: "networkTemplate",
+                            listFields: ["backend_status", "id", "name", "visibility", "translation", "shared_network_name", "shared_network_id"],
+                            detailFields: ["backend_status", "name", "description", "visibility", "translation", "shared_network_name", "shared_network_id"],
+                            });
 
         define_model(this, {urlRoot: NETWORK_API,
-                            relatedCollections: {"networkDeployments": "network", "networkSlivers": "network"},
+                            relatedCollections: {"networkSlivers": "network"},
                             foreignCollections: ["slices", "networkTemplates"],
-                            modelName: "network"});
+                            modelName: "network",
+                            foreignFields: {"template": "networkTemplates", "owner": "slices"},
+                            listFields: ["backend_status", "id", "name", "template", "ports", "labels", "owner"],
+                            detailFields: ["backend_status", "name", "template", "ports", "labels", "owner"],
+                            });
 
         define_model(this, {urlRoot: NETWORKSLIVER_API,
-                            modelName: "networkSliver"});
+                            modelName: "networkSliver",
+                            foreignFields: {"network": "networks", "sliver": "slivers"},
+                            listFields: ["backend_status", "id", "network", "sliver", "ip", "port_id"],
+                            detailFields: ["backend_status", "network", "sliver", "ip", "port_id"],
+                            });
+
+        define_model(this, {urlRoot: SERVICE_API,
+                            modelName: "service",
+                            listFields: ["backend_status", "id", "name", "enabled", "versionNumber", "published"],
+                            detailFields: ["backend_status", "name", "description", "versionNumber"],
+                            });
+
+        define_model(this, {urlRoot: FLAVOR_API,
+                            modelName: "flavor",
+                            m2mFields: {"deployments": "deployments"},
+                            listFields: ["backend_status", "id", "name", "flavor", "order", "default"],
+                            detailFields: ["backend_status", "name", "description", "flavor", "order", "default", "deployments"],
+                            inputType: {"default": "checkbox", "deployments": "picker"},
+                            });
+
+        define_model(this, {urlRoot: CONTROLLER_API,
+                            modelName: "controller",
+                            listFields: ["backend_status", "id", "name", "version", "backend_type"],
+                            detailFields: ["backend_status", "name", "version", "backend_type", "auth_url", "admin_user", "admin_password", "admin_tenant"],
+                            });
+
+        /* removed
+        define_model(this, {urlRoot: CONTROLLERSITEDEPLOYMENT_API,
+                            modelName: "controllerSiteDeployment",
+                            foreignCollections: ["site_deployments", "controllers"],
+                            foreignFields: {"site_deployment": "siteDeployments", "controller": "controllers"},
+                            listFields: ["backend_status", "id", "site_deployment", "controller", "tenant_id"],
+                            detailFields: ["backend_status", "site_deployment", "controller", "tenant_id"],
+                            });
+        */
+
+        /* DELETED in site-controller branch
 
         define_model(this, {urlRoot: NETWORKDEPLOYMENT_API,
-                            modelName: "networkDeployment"});
+                            modelName: "networkDeployment",
+                            foreignFields: {"network": "networks", "deployment": "deployments"},
+                            listFields: ["backend_status", "id", "network", "deployment", "net_id"],
+                            detailFields: ["backend_status", "network", "deployment", "net_id"],
+                            });
 
-        define_model(this, {urlRoot: SERVICE_API,
-                            modelName: "service"});
+        define_model(this, {urlRoot: SLICEDEPLOYMENT_API,
+                           foreignCollections: ["slices", "deployments"],
+                           modelName: "sliceDeployment",
+                           foreignFields: {"slice": "slices", "deployment": "deployments"},
+                           listFields: ["backend_status", "id", "slice", "deployment", "tenant_id"],
+                           detailFields: ["backend_status", "slice", "deployment", "tenant_id"],
+                           });
+
+        define_model(this, {urlRoot: USERDEPLOYMENT_API,
+                            foreignCollections: ["users","deployments"],
+                            modelName: "userDeployment",
+                            foreignFields: {"deployment": "deployments", "user": "users"},
+                            listFields: ["backend_status", "id", "user", "deployment", "kuser_id"],
+                            detailFields: ["backend_status", "user", "deployment", "kuser_id"],
+                            });
+
+        END stuff deleted in site-controller branch */
+
+        /* not deleted, but obsolete since it has degenerated to a ManyToMany with no other fields
+
+        define_model(this, {urlRoot: IMAGEDEPLOYMENTS_API,
+                            modelName: "imageDeployment",
+                            foreignCollections: ["images", "deployments"],
+                            listFields: ["backend_status", "id", "image", "deployment", "glance_image_id"],
+                            detailFields: ["backend_status", "image", "deployment", "glance_image_id"],
+                            });
+
+        */
 
         // enhanced REST
+        // XXX this really needs to somehow be combined with Slice, to avoid duplication
         define_model(this, {urlRoot: SLICEPLUS_API,
-                            relatedCollections: {'slivers': "slice"},
-                            modelName: "slicePlus",
-                            collectionName: "slicesPlus"});
+                           relatedCollections: {"slivers": "slice", "slicePrivileges": "slice", "networks": "owner"},
+                           foreignCollections: ["services", "sites"],
+                           foreignFields: {"service": "services", "site": "sites"},
+                           listFields: ["backend_status", "id", "name", "enabled", "description", "slice_url", "site", "max_slivers", "service"],
+                           detailFields: ["backend_status", "name", "site", "enabled", "description", "slice_url", "max_slivers"],
+                           inputType: {"enabled": "checkbox"},
+                           modelName: "slicePlus",
+                           collectionName: "slicesPlus",
+                           defaults: extend_defaults("slice", {"network_ports": "", "site_allocation": []}),
+                           validators: {"network_ports": ["portspec"]},
+                           xosValidate: function(attrs, options) {
+                               errors = XOSModel.prototype.xosValidate.call(this, attrs, options);
+                               // validate that slice.name starts with site.login_base
+                               site = attrs.site || this.site;
+                               if ((site!=undefined) && (attrs.name!=undefined)) {
+                                   site = xos.sites.get(site);
+                                   if (attrs.name.indexOf(site.attributes.login_base+"_") != 0) {
+                                        errors = errors || {};
+                                        errors["name"] = "must start with " + site.attributes.login_base + "_";
+                                   }
+                               }
+                               return errors;
+                             },
+                           });
+
+        define_model(this, {urlRoot: TENANTVIEW_API,
+                            modelName: "tenantview",
+                            collectionName: "tenantview",
+                            listFields: [],
+                            detailFields: [],
+                            });
+
+        /* by default, have slicePlus only fetch the slices the user can see */
+        this.slicesPlus.currentUserCanSee = true;
+
+        this.tenant = function() { return this.tenantview.models[0].attributes; };
 
         this.listObjects = function() { return this.allCollectionNames; };