// 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. (function() { 'use strict'; Polymer({ is: 'gr-change-view', /** * Fired when the title of the page should change. * * @event title-change */ /** * Fired if an error occurs when fetching the change data. * * @event page-error */ properties: { /** * URL params passed from the router. */ params: { type: Object, observer: '_paramsChanged', }, viewState: { type: Object, notify: true, value: function() { return {}; }, }, backPage: String, serverConfig: Object, keyEventTarget: { type: Object, value: function() { return document.body; }, }, _comments: Object, _change: { type: Object, observer: '_changeChanged', }, _commitInfo: Object, _files: Object, _changeNum: String, _diffDrafts: { type: Object, value: function() { return {}; }, }, _editingCommitMessage: { type: Boolean, value: false, }, _hideEditCommitMessage: { type: Boolean, computed: '_computeHideEditCommitMessage(_loggedIn, ' + '_editingCommitMessage, _change)', }, _latestCommitMessage: { type: String, value: '', }, _patchRange: { type: Object, observer: '_updateSelected', }, _currentRevisionActions: Object, _allPatchSets: { type: Array, computed: '_computeAllPatchSets(_change)', }, _loggedIn: { type: Boolean, value: false, }, _loading: Boolean, _projectConfig: Object, _replyButtonLabel: { type: String, value: 'Reply', computed: '_computeReplyButtonLabel(_diffDrafts.*)', }, _selectedPatchSet: String, _initialLoadComplete: { type: Boolean, value: false, }, }, behaviors: [ Gerrit.KeyboardShortcutBehavior, Gerrit.PatchSetBehavior, Gerrit.RESTClientBehavior, ], observers: [ '_labelsChanged(_change.labels.*)', '_paramsAndChangeChanged(params, _change)', ], keyBindings: { 'shift+r': '_handleCapitalRKey', 'a': '_handleAKey', 'd': '_handleDKey', 'u': '_handleUKey', }, attached: function() { this._getLoggedIn().then(function(loggedIn) { this._loggedIn = loggedIn; }.bind(this)); this.addEventListener('comment-save', this._handleCommentSave.bind(this)); this.addEventListener('comment-discard', this._handleCommentDiscard.bind(this)); this.addEventListener('editable-content-save', this._handleCommitMessageSave.bind(this)); this.addEventListener('editable-content-cancel', this._handleCommitMessageCancel.bind(this)); this.listen(window, 'scroll', '_handleScroll'); }, detached: function() { this.unlisten(window, 'scroll', '_handleScroll'); }, _handleEditCommitMessage: function(e) { this._editingCommitMessage = true; this.$.commitMessageEditor.focusTextarea(); }, _handleCommitMessageSave: function(e) { var message = e.detail.content; this.$.commitMessageEditor.disabled = true; this._saveCommitMessage(message).then(function(resp) { this.$.commitMessageEditor.disabled = false; if (!resp.ok) { return; } this._latestCommitMessage = message; this._editingCommitMessage = false; this._reloadWindow(); }.bind(this)).catch(function(err) { this.$.commitMessageEditor.disabled = false; }.bind(this)); }, _reloadWindow: function() { window.location.reload(); }, _handleCommitMessageCancel: function(e) { this._editingCommitMessage = false; }, _saveCommitMessage: function(message) { return this.$.restAPI.saveChangeCommitMessageEdit( this._changeNum, message).then(function(resp) { if (!resp.ok) { return resp; } return this.$.restAPI.publishChangeEdit(this._changeNum); }.bind(this)); }, _computeHideEditCommitMessage: function(loggedIn, editing, change) { if (!loggedIn || editing || change.status === this.ChangeStatus.MERGED) { return true; } return false; }, _handleCommentSave: function(e) { if (!e.target.comment.__draft) { return; } var draft = e.target.comment; draft.patch_set = draft.patch_set || this._patchRange.patchNum; // The use of path-based notification helpers (set, push) can’t be used // because the paths could contain dots in them. A new object must be // created to satisfy Polymer’s dirty checking. // https://github.com/Polymer/polymer/issues/3127 // TODO(andybons): Polyfill for Object.assign in IE. var diffDrafts = Object.assign({}, this._diffDrafts); if (!diffDrafts[draft.path]) { diffDrafts[draft.path] = [draft]; this._diffDrafts = diffDrafts; return; } for (var i = 0; i < this._diffDrafts[draft.path].length; i++) { if (this._diffDrafts[draft.path][i].id === draft.id) { diffDrafts[draft.path][i] = draft; this._diffDrafts = diffDrafts; return; } } diffDrafts[draft.path].push(draft); diffDrafts[draft.path].sort(function(c1, c2) { // No line number means that it’s a file comment. Sort it above the // others. return (c1.line || -1) - (c2.line || -1); }); this._diffDrafts = diffDrafts; }, _handleCommentDiscard: function(e) { if (!e.target.comment.__draft) { return; } var draft = e.target.comment; if (!this._diffDrafts[draft.path]) { return; } var index = -1; for (var i = 0; i < this._diffDrafts[draft.path].length; i++) { if (this._diffDrafts[draft.path][i].id === draft.id) { index = i; break; } } if (index === -1) { // It may be a draft that hasn’t been added to _diffDrafts since it was // never saved. return; } draft.patch_set = draft.patch_set || this._patchRange.patchNum; // The use of path-based notification helpers (set, push) can’t be used // because the paths could contain dots in them. A new object must be // created to satisfy Polymer’s dirty checking. // https://github.com/Polymer/polymer/issues/3127 // TODO(andybons): Polyfill for Object.assign in IE. var diffDrafts = Object.assign({}, this._diffDrafts); diffDrafts[draft.path].splice(index, 1); if (diffDrafts[draft.path].length === 0) { delete diffDrafts[draft.path]; } this._diffDrafts = diffDrafts; }, _handlePatchChange: function(e) { this._changePatchNum(parseInt(e.target.value, 10)); }, _handleReplyTap: function(e) { e.preventDefault(); this._openReplyDialog(); }, _handleDownloadTap: function(e) { e.preventDefault(); this.$.downloadOverlay.open().then(function() { this.$.downloadOverlay .setFocusStops(this.$.downloadDialog.getFocusStops()); this.$.downloadDialog.focus(); }.bind(this)); }, _handleDownloadDialogClose: function(e) { this.$.downloadOverlay.close(); }, _handleMessageReply: function(e) { var msg = e.detail.message.message; var quoteStr = msg.split('\n').map( function(line) { return '> ' + line; }).join('\n') + '\n\n'; if (quoteStr !== this.$.replyDialog.quote) { this.$.replyDialog.draft = quoteStr; } this.$.replyDialog.quote = quoteStr; this._openReplyDialog(); }, _handleReplyOverlayOpen: function(e) { this.$.replyDialog.focus(); }, _handleReplySent: function(e) { this.$.replyOverlay.close(); this._reload(); }, _handleReplyCancel: function(e) { this.$.replyOverlay.close(); }, _handleReplyAutogrow: function(e) { this.$.replyOverlay.refit(); }, _handleShowReplyDialog: function(e) { var target = this.$.replyDialog.FocusTarget.REVIEWERS; if (e.detail.value && e.detail.value.ccsOnly) { target = this.$.replyDialog.FocusTarget.CCS; } this._openReplyDialog(target); }, _handleScroll: function() { this.debounce('scroll', function() { history.replaceState( { scrollTop: document.body.scrollTop, path: location.pathname, }, location.pathname); }, 150); }, _paramsChanged: function(value) { if (value.view !== this.tagName.toLowerCase()) { this._initialLoadComplete = false; return; } var patchChanged = this._patchRange && (value.patchNum !== undefined && value.basePatchNum !== undefined) && (this._patchRange.patchNum !== value.patchNum || this._patchRange.basePatchNum !== value.basePatchNum); if (this._changeNum !== value.changeNum) { this._initialLoadComplete = false; } var patchRange = { patchNum: value.patchNum, basePatchNum: value.basePatchNum || 'PARENT', }; if (this._initialLoadComplete && patchChanged) { if (patchRange.patchNum == null) { patchRange.patchNum = this._computeLatestPatchNum(this._allPatchSets); } this._patchRange = patchRange; this._reloadPatchNumDependentResources().then(function() { this.$.jsAPI.handleEvent(this.$.jsAPI.EventType.SHOW_CHANGE, { change: this._change, patchNum: patchRange.patchNum, }); }.bind(this)); return; } this._changeNum = value.changeNum; this._patchRange = patchRange; this._reload().then(function() { this._performPostLoadTasks(); }.bind(this)); }, _performPostLoadTasks: function() { // Allow the message list and related changes to render before scrolling. // Related changes are loaded here (after everything else) because they // take the longest and are secondary information. Because the element may // alter the total height of the page, the call to potentially scroll to // a linked message is performed after related changes is fully loaded. this.$.relatedChanges.reload().then(function() { this.async(function() { if (history.state && history.state.scrollTop) { document.documentElement.scrollTop = document.body.scrollTop = history.state.scrollTop; } else { this._maybeScrollToMessage(); } }, 1); }.bind(this)); this._maybeShowReplyDialog(); this._maybeShowRevertDialog(); this.$.jsAPI.handleEvent(this.$.jsAPI.EventType.SHOW_CHANGE, { change: this._change, patchNum: this._patchRange.patchNum, }); this._initialLoadComplete = true; }, _paramsAndChangeChanged: function(value) { // If the change number or patch range is different, then reset the // selected file index. var patchRangeState = this.viewState.patchRange; if (this.viewState.changeNum !== this._changeNum || patchRangeState.basePatchNum !== this._patchRange.basePatchNum || patchRangeState.patchNum !== this._patchRange.patchNum) { this._resetFileListViewState(); } }, _maybeScrollToMessage: function() { var msgPrefix = '#message-'; var hash = window.location.hash; if (hash.indexOf(msgPrefix) === 0) { this.$.messageList.scrollToMessage(hash.substr(msgPrefix.length)); } }, _getLocationSearch: function() { // Not inlining to make it easier to test. return window.location.search; }, _getUrlParameter: function(param) { var pageURL = this._getLocationSearch().substring(1); var vars = pageURL.split('&'); for (var i = 0; i < vars.length; i++) { var name = vars[i].split('='); if (name[0] == param) { return name[0]; } } return null; }, _maybeShowRevertDialog: function() { this._getLoggedIn().then(function(loggedIn) { if (!loggedIn || this._change.status !== this.ChangeStatus.MERGED) { // Do not display dialog if not logged-in or the change is not merged. return; } if (!!this._getUrlParameter('revert')) { this.$.actions.showRevertDialog(); } }.bind(this)); }, _maybeShowReplyDialog: function() { this._getLoggedIn().then(function(loggedIn) { if (!loggedIn) { return; } if (this.viewState.showReplyDialog) { this._openReplyDialog(); this.async(function() { this.$.replyOverlay.center(); }, 1); this.set('viewState.showReplyDialog', false); } }.bind(this)); }, _resetFileListViewState: function() { this.set('viewState.selectedFileIndex', 0); if (!!this.viewState.changeNum && this.viewState.changeNum !== this._changeNum) { // Reset the diff mode to null when navigating from one change to // another, so that the user's preference is restored. this.set('viewState.diffMode', null); } this.set('viewState.changeNum', this._changeNum); this.set('viewState.patchRange', this._patchRange); }, _changeChanged: function(change) { if (!change) { return; } this.set('_patchRange.basePatchNum', this._patchRange.basePatchNum || 'PARENT'); this.set('_patchRange.patchNum', this._patchRange.patchNum || this._computeLatestPatchNum(this._allPatchSets)); this._updateSelected(); var title = change.subject + ' (' + change.change_id.substr(0, 9) + ')'; this.fire('title-change', {title: title}); }, /** * Change active patch to the provided patch num. * @param {int} patchNum the patchn number to be viewed. */ _changePatchNum: function(patchNum) { var currentPatchNum; if (this._change.current_revision) { currentPatchNum = this._change.revisions[this._change.current_revision]._number; } else { currentPatchNum = this._computeLatestPatchNum(this._allPatchSets); } if (patchNum === currentPatchNum) { page.show(this.changePath(this._changeNum)); return; } page.show(this.changePath(this._changeNum) + '/' + patchNum); }, _computeChangePermalink: function(changeNum) { return '/' + changeNum; }, _computeChangeStatus: function(change, patchNum) { var statusString; if (change.status === this.ChangeStatus.NEW) { var rev = this.getRevisionNumber(change.revisions, patchNum); if (rev && rev.draft === true) { statusString = 'Draft'; } } else { statusString = this.changeStatusString(change); } return statusString ? ' (' + statusString + ')' : ''; }, _computeLatestPatchNum: function(allPatchSets) { return allPatchSets[allPatchSets.length - 1]; }, _computePatchInfoClass: function(patchNum, allPatchSets) { if (parseInt(patchNum, 10) === this._computeLatestPatchNum(allPatchSets)) { return ''; } return 'patchInfo--oldPatchSet'; }, _computeAllPatchSets: function(change) { var patchNums = []; for (var rev in change.revisions) { patchNums.push(change.revisions[rev]._number); } return patchNums.sort(function(a, b) { return a - b; }); }, _computeLabelNames: function(labels) { return Object.keys(labels).sort(); }, _computeLabelValues: function(labelName, labels) { var result = []; var t = labels[labelName]; if (!t) { return result; } var approvals = t.all || []; approvals.forEach(function(label) { if (label.value && label.value != labels[labelName].default_value) { var labelClassName; var labelValPrefix = ''; if (label.value > 0) { labelValPrefix = '+'; labelClassName = 'approved'; } else if (label.value < 0) { labelClassName = 'notApproved'; } result.push({ value: labelValPrefix + label.value, className: labelClassName, account: label, }); } }); return result; }, _computeReplyButtonLabel: function(changeRecord) { var drafts = (changeRecord && changeRecord.base) || {}; var draftCount = Object.keys(drafts).reduce(function(count, file) { return count + drafts[file].length; }, 0); var label = 'Reply'; if (draftCount > 0) { label += ' (' + draftCount + ')'; } return label; }, _switchToMostRecentPatchNum: function() { this._getChangeDetail().then(function() { var patchNum = this._allPatchSets[this._allPatchSets.length - 1]; if (patchNum !== this._patchRange.patchNum) { this._changePatchNum(patchNum); } }.bind(this)); }, _handleAKey: function(e) { if (this.shouldSuppressKeyboardShortcut(e)) { return; } if (!this._loggedIn || e.detail.keyboardEvent.shiftKey) { return; } e.preventDefault(); this._openReplyDialog(); }, _handleDKey: function(e) { if (this.shouldSuppressKeyboardShortcut(e)) { return; } e.preventDefault(); this.$.downloadOverlay.open(); }, _handleCapitalRKey: function(e) { if (this.shouldSuppressKeyboardShortcut(e)) { return; } e.preventDefault(); this._switchToMostRecentPatchNum(); }, _handleUKey: function(e) { if (this.shouldSuppressKeyboardShortcut(e)) { return; } e.preventDefault(); this._determinePageBack(); }, _determinePageBack: function() { // Default backPage to '/' if user came to change view page // via an email link, etc. page.show(this.backPage || '/'); }, _handleLabelRemoved: function(splices, path) { for (var i = 0; i < splices.length; i++) { var splice = splices[i]; for (var j = 0; j < splice.removed.length; j++) { var removed = splice.removed[j]; var changePath = path.split('.'); var labelPath = changePath.splice(0, changePath.length - 2); var labelDict = this.get(labelPath); if (labelDict.approved && labelDict.approved._account_id === removed._account_id) { this._reload(); return; } } } }, _labelsChanged: function(changeRecord) { if (!changeRecord) { return; } if (changeRecord.value.indexSplices) { this._handleLabelRemoved(changeRecord.value.indexSplices, changeRecord.path); } this.$.jsAPI.handleEvent(this.$.jsAPI.EventType.LABEL_CHANGE, { change: this._change, }); }, _openReplyDialog: function(opt_section) { this.$.replyOverlay.open().then(function() { this.$.replyOverlay.setFocusStops(this.$.replyDialog.getFocusStops()); this.$.replyDialog.open(opt_section); }.bind(this)); }, _handleReloadChange: function() { this._reload(); }, _handleGetChangeDetailError: function(response) { this.fire('page-error', {response: response}); }, _getDiffDrafts: function() { return this.$.restAPI.getDiffDrafts(this._changeNum).then( function(drafts) { return this._diffDrafts = drafts; }.bind(this)); }, _getLoggedIn: function() { return this.$.restAPI.getLoggedIn(); }, _getProjectConfig: function() { return this.$.restAPI.getProjectConfig(this._change.project).then( function(config) { this._projectConfig = config; }.bind(this)); }, _getChangeDetail: function() { return this.$.restAPI.getChangeDetail(this._changeNum, this._handleGetChangeDetailError.bind(this)).then( function(change) { // Issue 4190: Coalesce missing topics to null. if (!change.topic) { change.topic = null; } if (!change.reviewer_updates) { change.reviewer_updates = null; } var latestRevisionSha = this._getLatestRevisionSHA(change); var currentRevision = change.revisions[latestRevisionSha]; if (currentRevision.commit && currentRevision.commit.message) { this._latestCommitMessage = currentRevision.commit.message; } else { this._latestCommitMessage = null; } this._change = change; if (!this._patchRange || !this._patchRange.patchNum || this._patchRange.patchNum === currentRevision._number) { // CommitInfo.commit is optional, and may need patching. if (!currentRevision.commit.commit) { currentRevision.commit.commit = latestRevisionSha; } this._commitInfo = currentRevision.commit; this._currentRevisionActions = currentRevision.actions; // TODO: Fetch and process files. } }.bind(this)); }, _getComments: function() { return this.$.restAPI.getDiffComments(this._changeNum).then( function(comments) { this._comments = comments; }.bind(this)); }, _getLatestCommitMessage: function() { return this.$.restAPI.getChangeCommitInfo(this._changeNum, this._computeLatestPatchNum(this._allPatchSets)).then( function(commitInfo) { this._latestCommitMessage = commitInfo.message; }.bind(this)); }, _getLatestRevisionSHA: function(change) { if (change.current_revision) { return change.current_revision; } // current_revision may not be present in the case where the latest rev is // a draft and the user doesn’t have permission to view that rev. var latestRev = null; var latestPatchNum = -1; for (var rev in change.revisions) { if (!change.revisions.hasOwnProperty(rev)) { continue; } if (change.revisions[rev]._number > latestPatchNum) { latestRev = rev; latestPatchNum = change.revisions[rev]._number; } } return latestRev; }, _getCommitInfo: function() { return this.$.restAPI.getChangeCommitInfo( this._changeNum, this._patchRange.patchNum).then( function(commitInfo) { this._commitInfo = commitInfo; }.bind(this)); }, _reloadDiffDrafts: function() { this._diffDrafts = {}; this._getDiffDrafts().then(function() { if (this.$.replyOverlay.opened) { this.async(function() { this.$.replyOverlay.center(); }, 1); } }.bind(this)); }, _reload: function() { this._loading = true; this._getLoggedIn().then(function(loggedIn) { if (!loggedIn) { return; } this._reloadDiffDrafts(); }.bind(this)); var detailCompletes = this._getChangeDetail().then(function() { this._loading = false; this._getProjectConfig(); }.bind(this)); this._getComments(); if (this._patchRange.patchNum) { return Promise.all([ this._reloadPatchNumDependentResources(), detailCompletes, ]).then(function() { return this.$.actions.reload(); }.bind(this)); } else { // The patch number is reliant on the change detail request. return detailCompletes.then(function() { this.$.fileList.reload(); if (!this._latestCommitMessage) { this._getLatestCommitMessage(); } }.bind(this)); } }, /** * Kicks off requests for resources that rely on the patch range * (`this._patchRange`) being defined. */ _reloadPatchNumDependentResources: function() { return Promise.all([ this._getCommitInfo(), this.$.fileList.reload(), ]); }, _updateSelected: function() { this._selectedPatchSet = this._patchRange.patchNum; }, _computePatchSetDescription: function(change, patchNum) { var rev = this.getRevisionNumber(change.revisions, patchNum); return (rev && rev.description) ? rev.description : ''; }, }); })();