pageflow 0.11.4 → 12.0.0.rc1

data/app/assets/javascripts/pageflow/editor/collections/pages_collection.js

@@ -29,5 +29,25 @@ pageflow.PagesCollection = Backbone.Collection.extend({
 
   getByPermaId: function(permaId) {
     return this.findWhere({perma_id: parseInt(permaId, 10)});
-  }
+  },
+
+  persisted: function() {
+    if (!this._persisted) {
+      this._persisted = new pageflow.SubsetCollection({
+        parent: this,
+
+        filter: function(page) {
+          return !page.isNew();
+        },
+      });
+
+      this.listenTo(this, 'change:id', function(model) {
+        setTimeout(_.bind(function() {
+          this._persisted.add(model);
+        }, this), 0);
+      });
+    }
+
+    return this._persisted;
+  },
 });

data/app/assets/javascripts/pageflow/editor/collections/subset_collection.js

@@ -45,7 +45,8 @@ pageflow.SubsetCollection = Backbone.Collection.extend({
       this.parent.sort();
     });
 
-    Backbone.Collection.prototype.constructor.call(this, this.parent.filter(this.filter), options);
+    Backbone.Collection.prototype.constructor
+      .call(this, this.parent.filter(this.filter, this), options);
   },
 
   clear: function() {
@@ -55,5 +56,10 @@ pageflow.SubsetCollection = Backbone.Collection.extend({
 
   url: function() {
     return this.parentModel.url() + _.result(this.parent, 'url');
+  },
+
+  dispose: function() {
+    this.stopListening();
+    this.reset();
   }
-});
+});

data/app/assets/javascripts/pageflow/editor/controllers/sidebar_controller.js

@@ -11,11 +11,12 @@ pageflow.SidebarController = Backbone.Marionette.Controller.extend({
     }));
   },
 
-  files: function(collectionName, handler, payload) {
+  files: function(collectionName, handler, payload, filterName) {
     this.region.show(new pageflow.FilesView({
       model: this.entry,
       selectionHandler: handler && pageflow.editor.createFileSelectionHandler(handler, payload),
-      tabName: collectionName
+      tabName: collectionName,
+      filterName: filterName
     }));
 
     pageflow.editor.setDefaultHelpEntry('pageflow.help_entries.files');

data/app/assets/javascripts/pageflow/editor/initializers/error_listener.js

@@ -1,8 +1,13 @@
 pageflow.app.addInitializer(function() {
   pageflow.app.on('error', function(e) {
-    alert(I18n.t(e.name, {
-      scope: 'pageflow.editor.errors',
-      defaultValue: I18n.t('pageflow.editor.errors.unknown')
-    }));
+    if (e.message) {
+      alert(e.message);
+    }
+    else {
+      alert(I18n.t(e.name, {
+        scope: 'pageflow.editor.errors',
+        defaultValue: I18n.t('pageflow.editor.errors.unknown')
+      }));
+    }
   });
-});
+});

data/app/assets/javascripts/pageflow/editor/initializers/routing.js

@@ -8,10 +8,12 @@ pageflow.app.addInitializer(function() {
     });
   });
 
-  window.editor = new pageflow.SidebarRouter({
+  pageflow.editor.router = new pageflow.SidebarRouter({
     controller: new pageflow.SidebarController({
       region: pageflow.app.sidebarRegion,
       entry: pageflow.entry
     })
   });
+
+  window.editor = pageflow.editor.router;
 });

data/app/assets/javascripts/pageflow/editor/initializers/setup_collections.js

@@ -4,6 +4,7 @@ pageflow.app.addInitializer(function(options) {
   pageflow.imageFiles = pageflow.files.image_files;
   pageflow.videoFiles = pageflow.files.video_files;
   pageflow.audioFiles = pageflow.files.audio_files;
+  pageflow.textTrackFiles = pageflow.files.text_track_files;
 
   pageflow.pages = new pageflow.PagesCollection(options.pages);
   pageflow.chapters = new pageflow.ChaptersCollection(options.chapters);
@@ -37,4 +38,6 @@ pageflow.app.addInitializer(function(options) {
   pageflow.savingRecords = new pageflow.SavingRecordsCollection();
   pageflow.savingRecords.watch(pageflow.pages);
   pageflow.savingRecords.watch(pageflow.chapters);
+
+  pageflow.events.trigger('seed:loaded');
 });

data/app/assets/javascripts/pageflow/editor/initializers/setup_file_types.js

@@ -1,20 +1,150 @@
 pageflow.app.addInitializer(function(options) {
+  var textTracksMetaDataAttribute = {
+    name: 'text_tracks',
+    valueView: pageflow.TextTracksFileMetaDataItemValueView,
+    valueViewOptions: {
+      settingsDialogTabLink: 'text_tracks',
+    }
+  };
+
+  var textTracksSettingsDialogTab = {
+    name: 'text_tracks',
+    view: pageflow.TextTracksView,
+    viewOptions: {
+      supersetCollection: function() {
+        return pageflow.textTrackFiles;
+      }
+    }
+  };
+
+  var altMetaDataAttribute = {
+    name: 'alt',
+    valueView: pageflow.TextFileMetaDataItemValueView,
+    valueViewOptions: {
+      fromConfiguration: true,
+      settingsDialogTabLink: 'general'
+    }
+  };
+
   pageflow.editor.fileTypes.register('image_files', {
     model: pageflow.ImageFile,
-    metaDataAttributes: ['dimensions'],
-    matchUpload: /^image/
+    metaDataAttributes: [
+      'dimensions',
+      altMetaDataAttribute
+    ],
+    matchUpload: /^image/,
+    configurationEditorInputs: [
+      {
+        name: 'alt',
+        inputView: pageflow.TextInputView
+      }
+    ]
   });
 
   pageflow.editor.fileTypes.register('video_files', {
     model: pageflow.VideoFile,
-    metaDataAttributes: ['format', 'dimensions', 'duration'],
-    matchUpload: /^video/
+    metaDataAttributes: [
+      'format',
+      'dimensions',
+      'duration',
+      textTracksMetaDataAttribute,
+      altMetaDataAttribute
+    ],
+    matchUpload: /^video/,
+    configurationEditorInputs: [
+      {
+        name: 'alt',
+        inputView: pageflow.TextInputView
+      }
+    ],
+    settingsDialogTabs: [
+      textTracksSettingsDialogTab
+    ]
   });
 
   pageflow.editor.fileTypes.register('audio_files', {
     model: pageflow.AudioFile,
-    metaDataAttributes: ['format', 'duration'],
-    matchUpload: /^audio/
+    metaDataAttributes: [
+      'format',
+      'duration',
+      textTracksMetaDataAttribute,
+      altMetaDataAttribute
+    ],
+    matchUpload: /^audio/,
+    configurationEditorInputs: [
+      {
+        name: 'alt',
+        inputView: pageflow.TextInputView
+      }
+    ],
+    settingsDialogTabs: [
+      textTracksSettingsDialogTab
+    ]
+  });
+
+  pageflow.editor.fileTypes.register('text_track_files', {
+    model: pageflow.TextTrackFile,
+    matchUpload: function(upload) {
+      return upload.type.match(/\/vtt$/) ||
+        upload.name.match(/\.srt$/);
+    },
+    skipUploadConfirmation: true,
+    configurationEditorInputs: [
+      {
+        name: 'label',
+        inputView: pageflow.TextInputView,
+        inputViewOptions: {
+          placeholder: function(configuration) {
+            var textTrackFile = configuration.parent;
+            return textTrackFile.inferredLabel();
+          },
+          placeholderBinding: pageflow.TextTrackFile.displayLabelBinding
+        }
+      },
+      {
+        name: 'kind',
+        inputView: pageflow.SelectInputView,
+        inputViewOptions: {
+          values: pageflow.config.availableTextTrackKinds,
+          translationKeyPrefix: 'pageflow.config.text_track_kind'
+        }
+      },
+      {
+        name: 'srclang',
+        inputView: pageflow.TextInputView,
+        inputViewOptions: {
+          required: true
+        }
+      }
+    ],
+    nestedFileTableColumns: [
+      {
+        name: 'label',
+        cellView: pageflow.TextTableCellView,
+        value: function(textTrackFile) {
+          return textTrackFile.displayLabel();
+        },
+        contentBinding: pageflow.TextTrackFile.displayLabelBinding
+      },
+      {
+        name: 'srclang',
+        cellView: pageflow.TextTableCellView,
+        default: I18n.t('pageflow.editor.text_track_files.srclang_missing')
+      },
+      {
+        name: 'kind',
+        cellView: pageflow.IconTableCellView,
+        cellViewOptions: {
+          icons: pageflow.config.availableTextTrackKinds
+        }
+      },
+    ],
+    nestedFilesOrder: {
+      comparator: function(textTrackFile) {
+        return textTrackFile.displayLabel().toLowerCase();
+      },
+      binding: 'label'
+    }
   });
 
   pageflow.editor.fileTypes.setup(options.config.fileTypes);

data/app/assets/javascripts/pageflow/editor/initializers/setup_file_uploader.js

@@ -0,0 +1,10 @@
+pageflow.app.addInitializer(function(options) {
+  pageflow.fileUploader = new pageflow.FileUploader({
+    entry: pageflow.entry,
+    fileTypes: pageflow.editor.fileTypes
+  });
+
+  pageflow.ConfirmUploadView.watch(pageflow.fileUploader,
+                                   pageflow.editor.fileTypes,
+                                   pageflow.files);
+});

data/app/assets/javascripts/pageflow/editor/initializers/setup_hotkeys.js

@@ -4,13 +4,11 @@ pageflow.app.addInitializer(function(options) {
 
   $(document).on('keydown', function(event) {
     if (event.altKey && event.which === KEY_A) {
-      if (pageflow.features.isEnabled('atmo')) {
-        if (pageflow.atmo.disabled) {
-          pageflow.atmo.enable();
-        }
-        else {
-          pageflow.atmo.disable();
-        }
+      if (pageflow.atmo.disabled) {
+        pageflow.atmo.enable();
+      }
+      else {
+        pageflow.atmo.disable();
       }
     }
     else if (event.altKey && event.which === KEY_X) {

data/app/assets/javascripts/pageflow/editor/initializers/stylesheet_reloading.js

@@ -5,7 +5,7 @@ pageflow.app.addInitializer(function(options) {
     }
   });
 
-  pageflow.entry.on('use:file', function() {
+  pageflow.entry.on('use:files', function() {
     pageflow.reloadStylesheet('entry');
   });
 });

data/app/assets/javascripts/pageflow/editor/models/configuration.js

@@ -17,6 +17,7 @@ pageflow.Configuration = Backbone.Model.extend({
   /**
    * Used by views (i.e. FileInputView) to get id which can be used in
    * routes to lookup configuration via its page.
+   * @private
    */
   getRoutableId: function() {
     return this.parent.id;

data/app/assets/javascripts/pageflow/editor/models/entry.js

@@ -19,6 +19,7 @@ pageflow.Entry = Backbone.Model.extend({
     this.configuration.parent = this;
 
     this.files = options.files || pageflow.files;
+    this.fileTypes = options.fileTypes || pageflow.editor.fileTypes;
     this.storylines = options.storylines || pageflow.storylines;
     this.storylines.parentModel = this;
     this.chapters = options.chapters || pageflow.chapters;
@@ -29,7 +30,7 @@ pageflow.Entry = Backbone.Model.extend({
     this.videoFiles = pageflow.videoFiles;
     this.audioFiles = pageflow.audioFiles;
 
-    pageflow.editor.fileTypes.each(function(fileType) {
+    this.fileTypes.each(function(fileType) {
       this.watchFileCollection(fileType.collectionName, this.getFileCollection(fileType));
     }, this);
 
@@ -85,29 +86,17 @@ pageflow.Entry = Backbone.Model.extend({
     return this.scaffoldStoryline(_.extend({depth: 'page'}, options)).page;
   },
 
-  addFileUpload: function(upload) {
-    var fileType = pageflow.editor.fileTypes.findByUpload(upload);
-    var file = new fileType.model({
-      state: 'uploading',
-      file_name: upload.name
-    });
-
-    this.getFileCollection(fileType).add(file);
+  reuseFile: function(otherEntry, file) {
+    var entry = this;
 
-    return file;
-  },
+    pageflow.FileReuse.submit(otherEntry, file, {
+      entry: entry,
 
-  addFileUsage: function(file) {
-    var fileUsages = new pageflow.FileUsagesCollection([], {
-      entry: this
+      success: function(model, response) {
+        entry._setFiles(response, {merge: false, remove: false});
+        entry.trigger('use:files');
+      }
     });
-
-    fileUsages.createForFile(file, { success: function(usage) {
-      file.set('usage_id', usage.get('id'));
-      this.getFileCollection(file.fileType()).add(file);
-
-      this.trigger('use:file', file);
-    }.bind(this)});
   },
 
   getFileCollection: function(fileType) {
@@ -125,16 +114,35 @@ pageflow.Entry = Backbone.Model.extend({
   parse: function(response, options) {
     if (response) {
       this.set(_.pick(response, 'published', 'published_until', 'password_protected'));
-
-      pageflow.editor.fileTypes.each(function(fileType) {
-        this.getFileCollection(fileType).set(response[fileType.collectionName], {add: false, remove: false});
-        delete response[fileType.collectionName];
-      }, this);
+      this._setFiles(response, {
+        add: false,
+        remove: false,
+        applyConfigurationUpdaters: true
+      });
     }
 
     return response;
   },
 
+  _setFiles: function(response, options) {
+    this.fileTypes.each(function(fileType) {
+      var filesAttributes = response[fileType.collectionName];
+
+      // Temporary solution until rights attributes is moved to
+      // configuration hash. If we are polling, prevent overwriting
+      // the rights attribute.
+      if (options.merge !== false) {
+        filesAttributes = _.map(filesAttributes, function(fileAttributes) {
+          return _.omit(fileAttributes, 'rights');
+        });
+      }
+
+      this.getFileCollection(fileType).set(filesAttributes,
+                                           _.extend({fileType: fileType}, options));
+      delete response[fileType.collectionName];
+    }, this);
+  },
+
   toJSON: function() {
     return this.configuration.toJSON();
   }

data/app/assets/javascripts/pageflow/editor/models/file_configuration.js

@@ -0,0 +1,10 @@
+pageflow.FileConfiguration = pageflow.Configuration.extend({
+  defaults: {
+  },
+
+  applyUpdaters: function(updaters, newAttributes) {
+    _(updaters).each(function(updater) {
+      updater(this, newAttributes);
+    }, this);
+  }
+});

data/app/assets/javascripts/pageflow/editor/models/file_reuse.js

@@ -0,0 +1,23 @@
+pageflow.FileReuse = Backbone.Model.extend({
+  modelName: 'file_reuse',
+  paramRoot: 'file_reuse',
+
+  initialize: function(attributes, options) {
+    this.entry = options.entry;
+    this.collectionName = options.fileType.collectionName;
+  },
+
+  url: function() {
+    return '/editor/entries/' + this.entry.get('id') + '/files/' + this.collectionName + '/reuse';
+  }
+});
+
+pageflow.FileReuse.submit = function(otherEntry, file, options) {
+  new pageflow.FileReuse({
+    other_entry_id: otherEntry.get('id'),
+    file_id: file.get('id')
+  }, {
+    entry: options.entry,
+    fileType: file.fileType()
+  }).save(null, options);
+};