blob: a417e3fb5d458a59c9b51388c69fc1c626fb277c [file] [log] [blame]
/**
* @license
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '../../../scripts/bundled-polymer.js';
import '@polymer/iron-autogrow-textarea/iron-autogrow-textarea.js';
import '../../../behaviors/fire-behavior/fire-behavior.js';
import '../../../styles/shared-styles.js';
import '../gr-storage/gr-storage.js';
import '../gr-button/gr-button.js';
import {mixinBehaviors} from '@polymer/polymer/lib/legacy/class.js';
import {GestureEventListeners} from '@polymer/polymer/lib/mixins/gesture-event-listeners.js';
import {LegacyElementMixin} from '@polymer/polymer/lib/legacy/legacy-element-mixin.js';
import {PolymerElement} from '@polymer/polymer/polymer-element.js';
import {htmlTemplate} from './gr-editable-content_html.js';
const RESTORED_MESSAGE = 'Content restored from a previous edit.';
const STORAGE_DEBOUNCE_INTERVAL_MS = 400;
/**
* @appliesMixin Gerrit.FireMixin
* @extends Polymer.Element
*/
class GrEditableContent extends mixinBehaviors( [
Gerrit.FireBehavior,
], GestureEventListeners(
LegacyElementMixin(
PolymerElement))) {
static get template() { return htmlTemplate; }
static get is() { return 'gr-editable-content'; }
/**
* Fired when the save button is pressed.
*
* @event editable-content-save
*/
/**
* Fired when the cancel button is pressed.
*
* @event editable-content-cancel
*/
/**
* Fired when content is restored from storage.
*
* @event show-alert
*/
static get properties() {
return {
content: {
notify: true,
type: String,
},
disabled: {
reflectToAttribute: true,
type: Boolean,
value: false,
},
editing: {
observer: '_editingChanged',
type: Boolean,
value: false,
},
removeZeroWidthSpace: Boolean,
// If no storage key is provided, content is not stored.
storageKey: String,
_saveDisabled: {
computed: '_computeSaveDisabled(disabled, content, _newContent)',
type: Boolean,
value: true,
},
_newContent: {
type: String,
observer: '_newContentChanged',
},
};
}
focusTextarea() {
this.shadowRoot.querySelector('iron-autogrow-textarea').textarea.focus();
}
_newContentChanged(newContent, oldContent) {
if (!this.storageKey) { return; }
this.debounce('store', () => {
if (newContent.length) {
this.$.storage.setEditableContentItem(this.storageKey, newContent);
} else {
// This does not really happen, because we don't clear newContent
// after saving (see below). So this only occurs when the user clears
// all the content in the editable textarea. But <gr-storage> cleans
// up itself after one day, so we are not so concerned about leaving
// some garbage behind.
this.$.storage.eraseEditableContentItem(this.storageKey);
}
}, STORAGE_DEBOUNCE_INTERVAL_MS);
}
_editingChanged(editing) {
// This method is for initializing _newContent when you start editing.
// Restoring content from local storage is not perfect and has
// some issues:
//
// 1. When you start editing in multiple tabs, then we are vulnerable to
// race conditions between the tabs.
// 2. The stored content is keyed by revision, so when you upload a new
// patchset and click "reload" and then click "cancel" on the content-
// editable, then you won't be able to recover the content anymore.
//
// Because of these issues we believe that it is better to only recover
// content from local storage when you enter editing mode for the first
// time. Otherwise it is better to just keep the last editing state from
// the same session.
if (!editing || this._newContent) {
return;
}
let content;
if (this.storageKey) {
const storedContent =
this.$.storage.getEditableContentItem(this.storageKey);
if (storedContent && storedContent.message) {
content = storedContent.message;
this.dispatchEvent(new CustomEvent('show-alert', {
detail: {message: RESTORED_MESSAGE},
bubbles: true,
composed: true,
}));
}
}
if (!content) {
content = this.content || '';
}
// TODO(wyatta) switch linkify sequence, see issue 5526.
this._newContent = this.removeZeroWidthSpace ?
content.replace(/^R=\u200B/gm, 'R=') :
content;
}
_computeSaveDisabled(disabled, content, newContent) {
return disabled || !newContent || content === newContent;
}
_handleSave(e) {
e.preventDefault();
this.fire('editable-content-save', {content: this._newContent});
// It would be nice, if we would set this._newContent = undefined here,
// but we can only do that when we are sure that the save operation has
// succeeded.
}
_handleCancel(e) {
e.preventDefault();
this.editing = false;
this.fire('editable-content-cancel');
}
}
customElements.define(GrEditableContent.is, GrEditableContent);