planetstack/core/xoslib/static/js/xoslib/xosHelper.js

   1 function assert(outcome, description) {
   2     if (!outcome) {
   3         console.log(description);
   4     }
   5 }
   6
   7 function templateFromId(id) {
   8     return _.template($(id).html());
   9 }
  10
  11 function firstCharUpper(s) {
  12     return s.charAt(0).toUpperCase() + s.slice(1);
  13 }
  14
  15 HTMLView = Marionette.ItemView.extend({
  16   render: function() {
  17       this.$el.append(this.options.html);
  18   },
  19 });
  20
  21 XOSApplication = Marionette.Application.extend({
  22     detailBoxId: "#detailBox",
  23     errorBoxId: "#errorBox",
  24     errorCloseButtonId: "#close-error-box",
  25     successBoxId: "#successBox",
  26     successCloseButtonId: "#close-success-box",
  27     errorTemplate: "#xos-error-template",
  28     successTemplate: "#xos-success-template",
  29     logMessageCount: 0,
  30
  31     hideError: function() {
  32         if (this.logWindowId) {
  33         } else {
  34             $(this.errorBoxId).hide();
  35             $(this.successBoxId).hide();
  36         }
  37     },
  38
  39     showSuccess: function(result) {
  40          result["success"] = "success";
  41          if (this.logTableId) {
  42              this.appendLogWindow(result);
  43          } else {
  44              $(this.successBoxId).show();
  45              $(this.successBoxId).html(_.template($(this.successTemplate).html())(result));
  46              var that=this;
  47              $(this.successCloseButtonId).unbind().bind('click', function() {
  48                  $(that.successBoxId).hide();
  49              });
  50          }
  51     },
  52
  53     showError: function(result) {
  54          result["success"] = "failure";
  55          if (this.logTableId) {
  56              this.appendLogWindow(result);
  57          } else {
  58              $(this.errorBoxId).show();
  59              $(this.errorBoxId).html(_.template($(this.errorTemplate).html())(result));
  60              var that=this;
  61              $(this.errorCloseButtonId).unbind().bind('click', function() {
  62                  $(that.errorBoxId).hide();
  63              });
  64          }
  65     },
  66
  67     showInformational: function(result) {
  68          result["success"] = "information";
  69          if (this.logTableId) {
  70              return this.appendLogWindow(result);
  71          } else {
  72              return undefined;
  73          }
  74     },
  75
  76     appendLogWindow: function(result) {
  77         // compute a new logMessageId for this log message
  78         logMessageId = "logMessage" + this.logMessageCount;
  79         this.logMessageCount = this.logMessageCount + 1;
  80         result["logMessageId"] = logMessageId;
  81
  82         logMessageTemplate=$("#xos-log-template").html();
  83         assert(logMessageTemplate != undefined, "logMessageTemplate is undefined");
  84         newRow = _.template(logMessageTemplate, result);
  85         assert(newRow != undefined, "newRow is undefined");
  86
  87         if (result["infoMsgId"] != undefined) {
  88             // We were passed the logMessageId of an informational message,
  89             // and the caller wants us to replace that message with our own.
  90             // i.e. replace an informational message with a success or an error.
  91             $("#"+result["infoMsgId"]).replaceWith(newRow);
  92         } else {
  93             // Create a brand new log message rather than replacing one.
  94             logTableBody = $(this.logTableId + " tbody");
  95             logTableBody.prepend(newRow);
  96         }
  97
  98         if (this.statusMsgId) {
  99             $(this.statusMsgId).html( templateFromId("#xos-status-template")(result) );
 100         }
 101
 102         return logMessageId;
 103     },
 104
 105     hideLinkedItems: function(result) {
 106         var index=0;
 107         while (index<4) {\r
 108             this["linkedObjs" + (index+1)].empty();\r
 109             index = index + 1;\r
 110         }\r
 111     },\r
 112 \r
 113     listViewShower: function(listViewName, collection_name, regionName, title) {\r
 114         var app=this;\r
 115         return function() {\r
 116             app[regionName].show(new app[listViewName]);\r
 117             app.hideLinkedItems();\r
 118             $("#contentTitle").html(templateFromId("#xos-title-list")({"title": title}));\r
 119             $("#detail").show();\r
 120             $("#xos-listview-button-box").show();\r
 121             $("#tabs").hide();\r
 122             $("#xos-detail-button-box").hide();\r
 123         }\r
 124     },\r
 125 \r
 126     addShower: function(detailName, collection_name, regionName, title) {\r
 127         var app=this;\r
 128         return function() {\r
 129             detailViewClass = app[detailName];\r
 130             detailView = new detailViewClass();\r
 131             app[regionName].show(detailView);\r
 132         }\r
 133     },\r
 134 \r
 135     detailShower: function(detailName, collection_name, regionName, title) {\r
 136         var app=this;\r
 137         showModelId = function(model_id) {\r
 138             showModel = function(model) {\r
 139                 detailViewClass = app[detailName];\r
 140                 detailView = new detailViewClass({model: model});\r
 141                 app[regionName].show(detailView);\r
 142                 detailView.showLinkedItems();\r
 143                 $("#xos-detail-button-box").show();\r
 144                 $("#xos-listview-button-box").hide();\r
 145             }\r
 146 \r
 147             $("#contentTitle").html(templateFromId("#xos-title-detail")({"title": title}));\r
 148 \r
 149             collection = xos[collection_name];\r
 150             model = collection.get(model_id);\r
 151             if (model == undefined) {\r
 152                 if (!collection.isLoaded) {\r
 153                     // If the model cannot be found, then maybe it's because\r
 154                     // we haven't finished loading the collection yet. So wait for\r
 155                     // the sort event to complete, then try again.\r
 156                     collection.once("sort", function() {\r
 157                         collection = xos[collection_name];\r
 158                         model = collection.get(model_id);\r
 159                         if (model == undefined) {\r
 160                             // We tried. It's not here. Complain to the user.\r
 161                             app[regionName].show(new HTMLView({html: "failed to load object " + model_id + " from collection " + collection_name}));\r
 162                         } else {\r
 163                             showModel(model);\r
 164                         }\r
 165                     });\r
 166                 } else {\r
 167                     // The collection was loaded, the user must just be asking for something we don't have.\r
 168                     app[regionName].show(new HTMLView({html: "failed to load object " + model_id + " from collection " + collection_name}));\r
 169                 }\r
 170             } else {\r
 171                 showModel(model);\r
 172             }\r
 173         }\r
 174         return showModelId;\r
 175     },\r
 176 });
 177
 178 /* XOSDetailView
 179       extend with:
 180          app - MarionetteApplication
 181          template - template (See XOSHelper.html)
 182 */
 183
 184 XOSDetailView = Marionette.ItemView.extend({
 185             tagName: "div",
 186
 187             events: {"click button.btn-xos-save-continue": "submitContinueClicked",
 188                      "click button.btn-xos-save-leave": "submitLeaveClicked",
 189                      "click button.btn-xos-save-another": "submitAddAnotherClicked",
 190                      "change input": "inputChanged"},
 191
 192             /* inputChanged is watching the onChange events of the input controls. We
 193                do this to track when this view is 'dirty', so we can throw up a warning\r
 194                if the user tries to change his slices without saving first.\r
 195             */\r
 196 \r
 197             inputChanged: function(e) {\r
 198                 this.dirty = true;\r
 199             },\r
 200 \r
 201             saveError: function(model, result, xhr, infoMsgId) {\r
 202                 result["what"] = "save " + model.__proto__.modelName;\r
 203                 result["infoMsgId"] = infoMsgId;\r
 204                 this.app.showError(result);\r
 205             },\r
 206 \r
 207             saveSuccess: function(model, result, xhr, infoMsgId) {\r
 208                 result = {status: xhr.xhr.status, statusText: xhr.xhr.statusText};\r
 209                 result["what"] = "save " + model.__proto__.modelName;\r
 210                 result["infoMsgId"] = infoMsgId;\r
 211                 this.app.showSuccess(result);\r
 212             },
 213
 214             submitContinueClicked: function(e) {
 215                 console.log("saveContinue");
 216                 e.preventDefault();
 217                 this.save();
 218             },
 219
 220             submitLeaveClicked: function(e) {
 221                 console.log("saveLeave");
 222                 e.preventDefault();
 223                 this.save();
 224             },
 225
 226             submitAddAnotherClicked: function(e) {
 227                 console.log("saveAnother");
 228                 e.preventDefault();
 229                 this.save();
 230             },
 231
 232             save: function() {
 233                 this.app.hideError();
 234                 var infoMsgId = this.app.showInformational( {what: "save " + this.model.__proto__.modelName, status: "", statusText: "in progress..."} );\r
 235                 var data = Backbone.Syphon.serialize(this);\r
 236                 var that = this;\r
 237                 this.model.save(data, {error: function(model, result, xhr) { that.saveError(model,result,xhr,infoMsgId);},\r
 238                                        success: function(model, result, xhr) { that.saveSuccess(model,result,xhr,infoMsgId);}});\r
 239                 this.dirty = false;\r
 240             },
 241
 242             tabClick: function(tabId, regionName) {
 243                     region = this.app[regionName];\r
 244                     if (this.currentTabRegion != undefined) {\r
 245                         this.currentTabRegion.$el.hide();\r
 246                     }\r
 247                     if (this.currentTabId != undefined) {\r
 248                         $(this.currentTabId).removeClass('active');\r
 249                     }\r
 250                     this.currentTabRegion = region;\r
 251                     this.currentTabRegion.$el.show();\r
 252 \r
 253                     this.currentTabId = tabId;\r
 254                     $(tabId).addClass('active');\r
 255             },
 256
 257             showTabs: function(tabs) {
 258                 template = templateFromId("#xos-tabs-template", {tabs: tabs});
 259                 $("#tabs").html(template(tabs));
 260                 var that = this;
 261
 262                 _.each(tabs, function(tab) {
 263                     var regionName = tab["region"];
 264                     var tabId = '#xos-nav-'+regionName;
 265                     $(tabId).bind('click', function() { that.tabClick(tabId, regionName); });
 266                 });
 267
 268                 $("#tabs").show();
 269             },
 270
 271             showLinkedItems: function() {
 272                     tabs=[];
 273
 274                     tabs.push({name: "details", region: "detail"});
 275
 276                     var index=0;
 277                     for (relatedName in this.model.collection.relatedCollections) {\r
 278                         relatedField = this.model.collection.relatedCollections[relatedName];\r
 279                         regionName = "linkedObjs" + (index+1);\r
 280 \r
 281                         relatedListViewClassName = relatedName + "ListView";\r
 282                         assert(this.app[relatedListViewClassName] != undefined, relatedListViewClassName + " not found");\r
 283                         relatedListViewClass = this.app[relatedListViewClassName].extend({collection: xos[relatedName].filterBy(relatedField,this.model.id)});\r
 284                         this.app[regionName].show(new relatedListViewClass());\r
 285                         if (this.app.hideTabsByDefault) {\r
 286                             this.app[regionName].$el.hide();\r
 287                         }\r
 288                         tabs.push({name: relatedName, region: regionName});\r
 289                         index = index + 1;\r
 290                     }\r
 291 \r
 292                     while (index<4) {\r
 293                         this.app["linkedObjs" + (index+1)].empty();\r
 294                         index = index + 1;\r
 295                     }\r
 296 \r
 297                     this.showTabs(tabs);\r
 298                     this.tabClick('#xos-nav-detail', 'detail');\r
 299               },\r
 300 \r
 301 });\r
 302
 303 /* XOSItemView
 304       This is for items that will be displayed as table rows.
 305       extend with:
 306          app - MarionetteApplication
 307          template - template (See XOSHelper.html)
 308          detailClass - class of detail view, probably an XOSDetailView
 309 */
 310
 311 XOSItemView = Marionette.ItemView.extend({
 312              tagName: 'tr',
 313              className: 'test-tablerow',
 314
 315              events: {"click": "changeItem"},
 316
 317              changeItem: function(e) {\r
 318                     this.app.hideError();\r
 319                     e.preventDefault();\r
 320                     e.stopPropagation();\r
 321 \r
 322                     this.app.navigateToModel(this.app, this.detailClass, this.detailNavLink, this.model);\r
 323              },\r
 324 });
 325
 326 /* XOSListView:
 327       extend with:
 328          app - MarionetteApplication
 329          childView - class of ItemView, probably an XOSItemView
 330          template - template (see xosHelper.html)
 331          collection - collection that holds these objects
 332          title - title to display in template
 333 */
 334
 335 XOSListView = Marionette.CompositeView.extend({
 336              childViewContainer: 'tbody',\r
 337 \r
 338              events: {"click button.btn-xos-add": "addClicked",\r
 339                      },
 340
 341              addClicked: function(e) {
 342                 console.log("add");
 343                 e.preventDefault();
 344                 this.app.Router.navigate("add" + firstCharUpper(this.collection.modelName));
 345              },
 346 \r
 347              initialize: function() {\r
 348                  this.listenTo(this.collection, 'change', this._renderChildren)
 349
 350                  // Because many of the templates use idToName(), we need to
 351                  // listen to the collections that hold the names for the ids
 352                  // that we want to display.
 353                  for (i in this.collection.foreignCollections) {
 354                      foreignName = this.collection.foreignCollections[i];
 355                      if (xos[foreignName] == undefined) {
 356                          console.log("Failed to find xos class " + foreignName);
 357                      }
 358                      this.listenTo(xos[foreignName], 'change', this._renderChildren);
 359                      this.listenTo(xos[foreignName], 'sort', this._renderChildren);
 360                  }
 361              },
 362
 363              templateHelpers: function() {
 364                 return { title: this.title };
 365              },\r
 366 });
 367
 368 /* Give an id, the name of a collection, and the name of a field for models
 369    within that collection, lookup the id and return the value of the field.
 370 */
 371
 372 idToName = function(id, collectionName, fieldName) {
 373     linkedObject = xos[collectionName].get(id);
 374     if (linkedObject == undefined) {
 375         return "#" + id;
 376     } else {
 377         return linkedObject.attributes[fieldName];
 378     }
 379 };
 380
 381 /* Constructs lists of <option> html blocks for items in a collection.
 382
 383    selectedId = the id of an object that should be selected, if any
 384    collectionName = name of collection
 385    fieldName = name of field within models of collection that will be displayed
 386 */
 387
 388 idToOptions = function(selectedId, collectionName, fieldName) {
 389     result=""
 390     for (index in xos[collectionName].models) {
 391         linkedObject = xos[collectionName].models[index];
 392         linkedId = linkedObject["id"];
 393         linkedName = linkedObject.attributes[fieldName];
 394         if (linkedId == selectedId) {
 395             selected = " selected";
 396         } else {
 397             selected = "";
 398         }
 399         result = result + '<option value="' + linkedId + '"' + selected + '>' + linkedName + '</option>';
 400     }
 401     return result;
 402 };
 403
 404 /* Constructs an html <select> and the <option>s to go with it.
 405
 406    variable = variable name to return to form
 407    selectedId = the id of an object that should be selected, if any
 408    collectionName = name of collection
 409    fieldName = name of field within models of collection that will be displayed
 410 */
 411
 412 idToSelect = function(variable, selectedId, collectionName, fieldName) {
 413     result = '<select name="' + variable + '">' +
 414              idToOptions(selectedId, collectionName, fieldName) +
 415              '</select>';
 416     return result;
 417 }
 418