Ghost/ghost/admin/app/mixins/editor-base-route.js
Kevin Ansfield e01ffa3620 Always call _super when using Ember hooks
no issue
- review use of Ember core hooks and add a call to `this._super` if missing
- fix a few occurrences of using the wrong component lifecycle hooks that could result in multiple/duplicate event handlers being attached

`_super` should always be called when overriding Ember's base hooks so that core functionality or app functionality added through extensions, mixins or addons is not lost. This is important as it guards against issues arising from later refactorings or core changes.

As example of lost functionality, there were a number of routes that extended from `AuthenticatedRoute` but then overrode the `beforeModel` hook without calling `_super` which meant that the route was no longer treated as authenticated.
2015-11-30 12:45:37 +00:00

141 lines
5.1 KiB
JavaScript

import Ember from 'ember';
import ShortcutsRoute from 'ghost/mixins/shortcuts-route';
import styleBody from 'ghost/mixins/style-body';
import editorShortcuts from 'ghost/utils/editor-shortcuts';
const {Mixin, RSVP, run} = Ember;
export default Mixin.create(styleBody, ShortcutsRoute, {
classNames: ['editor'],
actions: {
save() {
this.get('controller').send('save');
},
publish() {
let controller = this.get('controller');
controller.send('setSaveType', 'publish');
controller.send('save');
},
toggleZenMode() {
Ember.$('body').toggleClass('zen');
},
// The actual functionality is implemented in utils/ed-editor-shortcuts
editorShortcut(options) {
// Only fire editor shortcuts when the editor has focus.
if (this.get('controller.editor').$().is(':focus')) {
this.get('controller.editor').shortcut(options.type);
}
},
willTransition(transition) {
let controller = this.get('controller');
let scratch = controller.get('model.scratch');
let controllerIsDirty = controller.get('hasDirtyAttributes');
let model = controller.get('model');
let state = model.getProperties('isDeleted', 'isSaving', 'hasDirtyAttributes', 'isNew');
let deletedWithoutChanges,
fromNewToEdit;
// if a save is in-flight we don't know whether or not it's safe to leave
// so we abort the transition and retry after the save has completed.
if (state.isSaving) {
transition.abort();
return run.later(this, function () {
RSVP.resolve(controller.get('lastPromise')).then(() => {
transition.retry();
});
}, 100);
}
fromNewToEdit = this.get('routeName') === 'editor.new' &&
transition.targetName === 'editor.edit' &&
transition.intent.contexts &&
transition.intent.contexts[0] &&
transition.intent.contexts[0].id === model.get('id');
deletedWithoutChanges = state.isDeleted &&
(state.isSaving || !state.hasDirtyAttributes);
if (!fromNewToEdit && !deletedWithoutChanges && controllerIsDirty) {
transition.abort();
this.send('openModal', 'leave-editor', [controller, transition]);
return;
}
// The controller may hold model state that will be lost in the transition,
// so we need to apply it now.
if (fromNewToEdit && controllerIsDirty) {
if (scratch !== model.get('markdown')) {
model.set('markdown', scratch);
}
}
if (state.isNew) {
model.deleteRecord();
}
// since the transition is now certain to complete..
window.onbeforeunload = null;
// remove model-related listeners created in editor-base-route
this.detachModelHooks(controller, model);
}
},
renderTemplate(controller, model) {
this._super(controller, model);
this.render('post-settings-menu', {
model,
into: 'application',
outlet: 'settings-menu'
});
},
shortcuts: editorShortcuts,
attachModelHooks(controller, model) {
// this will allow us to track when the model is saved and update the controller
// so that we can be sure controller.hasDirtyAttributes is correct, without having to update the
// controller on each instance of `model.save()`.
//
// another reason we can't do this on `model.save().then()` is because the post-settings-menu
// also saves the model, and passing messages is difficult because we have two
// types of editor controllers, and the PSM also exists on the posts.post route.
//
// The reason we can't just keep this functionality in the editor controller is
// because we need to remove these handlers on `willTransition` in the editor route.
model.on('didCreate', controller, controller.get('modelSaved'));
model.on('didUpdate', controller, controller.get('modelSaved'));
},
detachModelHooks(controller, model) {
model.off('didCreate', controller, controller.get('modelSaved'));
model.off('didUpdate', controller, controller.get('modelSaved'));
},
setupController(controller, model) {
let tags = model.get('tags');
model.set('scratch', model.get('markdown'));
model.set('titleScratch', model.get('title'));
this._super(...arguments);
if (tags) {
// used to check if anything has changed in the editor
controller.set('previousTagNames', tags.mapBy('name'));
} else {
controller.set('previousTagNames', []);
}
// attach model-related listeners created in editor-base-route
this.attachModelHooks(controller, model);
}
});