ReviewPanelController.js 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232
  1. /* eslint-disable
  2. camelcase,
  3. max-len,
  4. no-return-assign,
  5. no-unused-vars,
  6. */
  7. // TODO: This file was created by bulk-decaffeinate.
  8. // Fix any style issues and re-enable lint.
  9. /*
  10. * decaffeinate suggestions:
  11. * DS101: Remove unnecessary use of Array.from
  12. * DS102: Remove unnecessary code created because of implicit returns
  13. * DS205: Consider reworking code to avoid use of IIFEs
  14. * DS207: Consider shorter variations of null checks
  15. * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
  16. */
  17. import App from '../../../base'
  18. import EventEmitter from '../../../utils/EventEmitter'
  19. import ColorManager from '../../colors/ColorManager'
  20. import RangesTracker from '../RangesTracker'
  21. export default App.controller(
  22. 'ReviewPanelController',
  23. function (
  24. $scope,
  25. $element,
  26. ide,
  27. $timeout,
  28. $http,
  29. $modal,
  30. eventTracking,
  31. localStorage
  32. ) {
  33. let UserTCSyncState
  34. const $reviewPanelEl = $element.find('#review-panel')
  35. const UserTypes = {
  36. MEMBER: 'member', // Invited, listed in project.members
  37. GUEST: 'guest', // Not invited, but logged in so has a user_id
  38. ANONYMOUS: 'anonymous', // No user_id
  39. }
  40. const currentUserType = function () {
  41. if ((ide.$scope.user != null ? ide.$scope.user.id : undefined) == null) {
  42. return UserTypes.ANONYMOUS
  43. } else {
  44. const user_id = ide.$scope.user.id
  45. const { project } = ide.$scope
  46. if (
  47. (project.owner != null ? project.owner.id : undefined) === user_id
  48. ) {
  49. return UserTypes.MEMBER
  50. }
  51. for (const member of Array.from(project.members)) {
  52. if (member._id === user_id) {
  53. return UserTypes.MEMBER
  54. }
  55. }
  56. return UserTypes.GUEST
  57. }
  58. }
  59. $scope.SubViews = {
  60. CUR_FILE: 'cur_file',
  61. OVERVIEW: 'overview',
  62. }
  63. $scope.UserTCSyncState = UserTCSyncState = {
  64. SYNCED: 'synced',
  65. PENDING: 'pending',
  66. }
  67. $scope.reviewPanel = {
  68. trackChangesState: {},
  69. trackChangesOnForEveryone: false,
  70. trackChangesOnForGuests: false,
  71. trackChangesForGuestsAvailable: false,
  72. entries: {},
  73. resolvedComments: {},
  74. hasEntries: false,
  75. subView: $scope.SubViews.CUR_FILE,
  76. openSubView: $scope.SubViews.CUR_FILE,
  77. overview: {
  78. loading: false,
  79. docsCollapsedState:
  80. JSON.parse(
  81. localStorage(`docs_collapsed_state:${$scope.project_id}`)
  82. ) || {},
  83. },
  84. dropdown: {
  85. loading: false,
  86. },
  87. commentThreads: {},
  88. resolvedThreadIds: {},
  89. rendererData: {},
  90. formattedProjectMembers: {},
  91. fullTCStateCollapsed: true,
  92. loadingThreads: false,
  93. // All selected changes. If a aggregated change (insertion + deletion) is selection, the two ids
  94. // will be present. The length of this array will differ from the count below (see explanation).
  95. selectedEntryIds: [],
  96. // A count of user-facing selected changes. An aggregated change (insertion + deletion) will count
  97. // as only one.
  98. nVisibleSelectedChanges: 0,
  99. }
  100. window.addEventListener('beforeunload', function () {
  101. const collapsedStates = {}
  102. for (const doc in $scope.reviewPanel.overview.docsCollapsedState) {
  103. const state = $scope.reviewPanel.overview.docsCollapsedState[doc]
  104. if (state) {
  105. collapsedStates[doc] = state
  106. }
  107. }
  108. const valToStore =
  109. Object.keys(collapsedStates).length > 0
  110. ? JSON.stringify(collapsedStates)
  111. : null
  112. return localStorage(
  113. `docs_collapsed_state:${$scope.project_id}`,
  114. valToStore
  115. )
  116. })
  117. $scope.$on('layout:pdf:linked', (event, state) =>
  118. $scope.$broadcast('review-panel:layout')
  119. )
  120. $scope.$on('layout:pdf:resize', (event, state) =>
  121. $scope.$broadcast('review-panel:layout', false)
  122. )
  123. $scope.$on('expandable-text-area:resize', event =>
  124. $timeout(() => $scope.$broadcast('review-panel:layout'))
  125. )
  126. $scope.$on('review-panel:sizes', (e, sizes) =>
  127. $scope.$broadcast('editor:set-scroll-size', sizes)
  128. )
  129. $scope.$watch('project.features.trackChangesVisible', function (visible) {
  130. if (visible == null) {
  131. return
  132. }
  133. if (!visible) {
  134. return ($scope.ui.reviewPanelOpen = false)
  135. }
  136. })
  137. $scope.$watch('project.members', function (members) {
  138. $scope.reviewPanel.formattedProjectMembers = {}
  139. if (($scope.project != null ? $scope.project.owner : undefined) != null) {
  140. $scope.reviewPanel.formattedProjectMembers[$scope.project.owner._id] =
  141. formatUser($scope.project.owner)
  142. }
  143. if (
  144. ($scope.project != null ? $scope.project.members : undefined) != null
  145. ) {
  146. return (() => {
  147. const result = []
  148. for (const member of Array.from(members)) {
  149. if (member.privileges === 'readAndWrite') {
  150. if ($scope.reviewPanel.trackChangesState[member._id] == null) {
  151. // An added member will have track changes enabled if track changes is on for everyone
  152. _setUserTCState(
  153. member._id,
  154. $scope.reviewPanel.trackChangesOnForEveryone,
  155. true
  156. )
  157. }
  158. result.push(
  159. ($scope.reviewPanel.formattedProjectMembers[member._id] =
  160. formatUser(member))
  161. )
  162. } else {
  163. result.push(undefined)
  164. }
  165. }
  166. return result
  167. })()
  168. }
  169. })
  170. $scope.commentState = {
  171. adding: false,
  172. content: '',
  173. }
  174. $scope.users = {}
  175. $scope.reviewPanelEventsBridge = new EventEmitter()
  176. ide.socket.on('new-comment', function (thread_id, comment) {
  177. const thread = getThread(thread_id)
  178. delete thread.submitting
  179. thread.messages.push(formatComment(comment))
  180. $scope.$apply()
  181. return $timeout(() => $scope.$broadcast('review-panel:layout'))
  182. })
  183. ide.socket.on('accept-changes', function (doc_id, change_ids) {
  184. if (doc_id !== $scope.editor.open_doc_id) {
  185. getChangeTracker(doc_id).removeChangeIds(change_ids)
  186. } else {
  187. $scope.$broadcast('changes:accept', change_ids)
  188. }
  189. updateEntries(doc_id)
  190. return $scope.$apply(function () {})
  191. })
  192. ide.socket.on('resolve-thread', (thread_id, user) =>
  193. _onCommentResolved(thread_id, user)
  194. )
  195. ide.socket.on('reopen-thread', thread_id => _onCommentReopened(thread_id))
  196. ide.socket.on('delete-thread', function (thread_id) {
  197. _onThreadDeleted(thread_id)
  198. return $scope.$apply(function () {})
  199. })
  200. ide.socket.on('edit-message', function (thread_id, message_id, content) {
  201. _onCommentEdited(thread_id, message_id, content)
  202. return $scope.$apply(function () {})
  203. })
  204. ide.socket.on('delete-message', function (thread_id, message_id) {
  205. _onCommentDeleted(thread_id, message_id)
  206. return $scope.$apply(function () {})
  207. })
  208. const rangesTrackers = {}
  209. const getDocEntries = function (doc_id) {
  210. if ($scope.reviewPanel.entries[doc_id] == null) {
  211. $scope.reviewPanel.entries[doc_id] = {}
  212. }
  213. return $scope.reviewPanel.entries[doc_id]
  214. }
  215. const getDocResolvedComments = function (doc_id) {
  216. if ($scope.reviewPanel.resolvedComments[doc_id] == null) {
  217. $scope.reviewPanel.resolvedComments[doc_id] = {}
  218. }
  219. return $scope.reviewPanel.resolvedComments[doc_id]
  220. }
  221. function getThread(thread_id) {
  222. if ($scope.reviewPanel.commentThreads[thread_id] == null) {
  223. $scope.reviewPanel.commentThreads[thread_id] = { messages: [] }
  224. }
  225. return $scope.reviewPanel.commentThreads[thread_id]
  226. }
  227. function getChangeTracker(doc_id) {
  228. if (rangesTrackers[doc_id] == null) {
  229. rangesTrackers[doc_id] = new RangesTracker()
  230. rangesTrackers[doc_id].resolvedThreadIds =
  231. $scope.reviewPanel.resolvedThreadIds
  232. }
  233. return rangesTrackers[doc_id]
  234. }
  235. let scrollbar = {}
  236. $scope.reviewPanelEventsBridge.on(
  237. 'aceScrollbarVisibilityChanged',
  238. function (isVisible, scrollbarWidth) {
  239. scrollbar = { isVisible, scrollbarWidth }
  240. return updateScrollbar()
  241. }
  242. )
  243. function updateScrollbar() {
  244. if (
  245. scrollbar.isVisible &&
  246. $scope.reviewPanel.subView === $scope.SubViews.CUR_FILE &&
  247. !$scope.editor.showRichText
  248. ) {
  249. return $reviewPanelEl.css('right', `${scrollbar.scrollbarWidth}px`)
  250. } else {
  251. return $reviewPanelEl.css('right', '0')
  252. }
  253. }
  254. $scope.$watch(
  255. '!ui.reviewPanelOpen && reviewPanel.hasEntries',
  256. function (open, prevVal) {
  257. if (open == null) {
  258. return
  259. }
  260. $scope.ui.miniReviewPanelVisible = open
  261. if (open !== prevVal) {
  262. return $timeout(() => $scope.$broadcast('review-panel:toggle'))
  263. }
  264. }
  265. )
  266. $scope.$watch('ui.reviewPanelOpen', function (open) {
  267. if (open == null) {
  268. return
  269. }
  270. if (!open) {
  271. // Always show current file when not open, but save current state
  272. $scope.reviewPanel.openSubView = $scope.reviewPanel.subView
  273. $scope.reviewPanel.subView = $scope.SubViews.CUR_FILE
  274. } else {
  275. // Reset back to what we had when previously open
  276. $scope.reviewPanel.subView = $scope.reviewPanel.openSubView
  277. }
  278. return $timeout(function () {
  279. $scope.$broadcast('review-panel:toggle')
  280. return $scope.$broadcast('review-panel:layout', false)
  281. })
  282. })
  283. $scope.$watch('reviewPanel.subView', function (view) {
  284. if (view == null) {
  285. return
  286. }
  287. updateScrollbar()
  288. if (view === $scope.SubViews.OVERVIEW) {
  289. return refreshOverviewPanel()
  290. }
  291. })
  292. $scope.$watch('editor.sharejs_doc', function (doc, old_doc) {
  293. if (doc == null) {
  294. return
  295. }
  296. // The open doc range tracker is kept up to date in real-time so
  297. // replace any outdated info with this
  298. rangesTrackers[doc.doc_id] = doc.ranges
  299. rangesTrackers[doc.doc_id].resolvedThreadIds =
  300. $scope.reviewPanel.resolvedThreadIds
  301. $scope.reviewPanel.rangesTracker = rangesTrackers[doc.doc_id]
  302. if (old_doc != null) {
  303. old_doc.off('flipped_pending_to_inflight')
  304. }
  305. doc.on('flipped_pending_to_inflight', () => regenerateTrackChangesId(doc))
  306. return regenerateTrackChangesId(doc)
  307. })
  308. $scope.$watch(
  309. function () {
  310. const entries =
  311. $scope.reviewPanel.entries[$scope.editor.open_doc_id] || {}
  312. const permEntries = {}
  313. for (const entry in entries) {
  314. const entryData = entries[entry]
  315. if (!['add-comment', 'bulk-actions'].includes(entry)) {
  316. permEntries[entry] = entryData
  317. }
  318. }
  319. return Object.keys(permEntries).length
  320. },
  321. nEntries =>
  322. ($scope.reviewPanel.hasEntries =
  323. nEntries > 0 && $scope.project.features.trackChangesVisible)
  324. )
  325. function regenerateTrackChangesId(doc) {
  326. const old_id = getChangeTracker(doc.doc_id).getIdSeed()
  327. const new_id = RangesTracker.generateIdSeed()
  328. getChangeTracker(doc.doc_id).setIdSeed(new_id)
  329. return doc.setTrackChangesIdSeeds({ pending: new_id, inflight: old_id })
  330. }
  331. const refreshRanges = () =>
  332. $http
  333. .get(`/project/${$scope.project_id}/ranges`)
  334. .then(function (response) {
  335. const docs = response.data
  336. return (() => {
  337. const result = []
  338. for (const doc of Array.from(docs)) {
  339. if (
  340. $scope.reviewPanel.overview.docsCollapsedState[doc.id] == null
  341. ) {
  342. $scope.reviewPanel.overview.docsCollapsedState[doc.id] = false
  343. }
  344. if (doc.id !== $scope.editor.open_doc_id) {
  345. // this is kept up to date in real-time, don't overwrite
  346. const rangesTracker = getChangeTracker(doc.id)
  347. rangesTracker.comments =
  348. (doc.ranges != null ? doc.ranges.comments : undefined) || []
  349. rangesTracker.changes =
  350. (doc.ranges != null ? doc.ranges.changes : undefined) || []
  351. }
  352. result.push(updateEntries(doc.id))
  353. }
  354. return result
  355. })()
  356. })
  357. function refreshOverviewPanel() {
  358. $scope.reviewPanel.overview.loading = true
  359. return refreshRanges()
  360. .then(() => ($scope.reviewPanel.overview.loading = false))
  361. .catch(() => ($scope.reviewPanel.overview.loading = false))
  362. }
  363. $scope.refreshResolvedCommentsDropdown = function () {
  364. $scope.reviewPanel.dropdown.loading = true
  365. const q = refreshRanges()
  366. q.then(() => ($scope.reviewPanel.dropdown.loading = false))
  367. q.catch(() => ($scope.reviewPanel.dropdown.loading = false))
  368. return q
  369. }
  370. function updateEntries(doc_id) {
  371. const rangesTracker = getChangeTracker(doc_id)
  372. const entries = getDocEntries(doc_id)
  373. const resolvedComments = getDocResolvedComments(doc_id)
  374. let changed = false
  375. // Assume we'll delete everything until we see it, then we'll remove it from this object
  376. const delete_changes = {}
  377. for (const id in entries) {
  378. const change = entries[id]
  379. if (!['add-comment', 'bulk-actions'].includes(id)) {
  380. for (const entry_id of Array.from(change.entry_ids)) {
  381. delete_changes[entry_id] = true
  382. }
  383. }
  384. }
  385. for (const id in resolvedComments) {
  386. const change = resolvedComments[id]
  387. for (const entry_id of Array.from(change.entry_ids)) {
  388. delete_changes[entry_id] = true
  389. }
  390. }
  391. let potential_aggregate = false
  392. let prev_insertion = null
  393. for (const change of Array.from(rangesTracker.changes)) {
  394. changed = true
  395. if (
  396. potential_aggregate &&
  397. change.op.d &&
  398. change.op.p === prev_insertion.op.p + prev_insertion.op.i.length &&
  399. change.metadata.user_id === prev_insertion.metadata.user_id
  400. ) {
  401. // An actual aggregate op.
  402. entries[prev_insertion.id].type = 'aggregate-change'
  403. entries[prev_insertion.id].metadata.replaced_content = change.op.d
  404. entries[prev_insertion.id].entry_ids.push(change.id)
  405. } else {
  406. if (entries[change.id] == null) {
  407. entries[change.id] = {}
  408. }
  409. delete delete_changes[change.id]
  410. const new_entry = {
  411. type: change.op.i ? 'insert' : 'delete',
  412. entry_ids: [change.id],
  413. content: change.op.i || change.op.d,
  414. offset: change.op.p,
  415. metadata: change.metadata,
  416. }
  417. for (const key in new_entry) {
  418. entries[change.id][key] = new_entry[key]
  419. }
  420. }
  421. if (change.op.i) {
  422. potential_aggregate = true
  423. prev_insertion = change
  424. } else {
  425. potential_aggregate = false
  426. prev_insertion = null
  427. }
  428. if ($scope.users[change.metadata.user_id] == null) {
  429. refreshChangeUsers(change.metadata.user_id)
  430. }
  431. }
  432. if (rangesTracker.comments.length > 0) {
  433. ensureThreadsAreLoaded()
  434. }
  435. for (const comment of Array.from(rangesTracker.comments)) {
  436. let new_comment
  437. changed = true
  438. delete delete_changes[comment.id]
  439. if ($scope.reviewPanel.resolvedThreadIds[comment.op.t]) {
  440. new_comment =
  441. resolvedComments[comment.id] != null
  442. ? resolvedComments[comment.id]
  443. : (resolvedComments[comment.id] = {})
  444. delete entries[comment.id]
  445. } else {
  446. new_comment =
  447. entries[comment.id] != null
  448. ? entries[comment.id]
  449. : (entries[comment.id] = {})
  450. delete resolvedComments[comment.id]
  451. }
  452. const new_entry = {
  453. type: 'comment',
  454. thread_id: comment.op.t,
  455. entry_ids: [comment.id],
  456. content: comment.op.c,
  457. offset: comment.op.p,
  458. }
  459. for (const key in new_entry) {
  460. new_comment[key] = new_entry[key]
  461. }
  462. }
  463. for (const change_id in delete_changes) {
  464. const _ = delete_changes[change_id]
  465. changed = true
  466. delete entries[change_id]
  467. delete resolvedComments[change_id]
  468. }
  469. if (changed) {
  470. return $scope.$broadcast('entries:changed')
  471. }
  472. }
  473. $scope.$on('editor:track-changes:changed', function () {
  474. const doc_id = $scope.editor.open_doc_id
  475. updateEntries(doc_id)
  476. // For now, not worrying about entry panels for rich text
  477. if (!$scope.editor.showRichText) {
  478. $scope.$broadcast('review-panel:recalculate-screen-positions')
  479. return $scope.$broadcast('review-panel:layout')
  480. }
  481. })
  482. $scope.$on('editor:track-changes:visibility_changed', () =>
  483. $timeout(() => $scope.$broadcast('review-panel:layout', false))
  484. )
  485. $scope.$on(
  486. 'editor:focus:changed',
  487. function (e, selection_offset_start, selection_offset_end, selection) {
  488. const doc_id = $scope.editor.open_doc_id
  489. const entries = getDocEntries(doc_id)
  490. // All selected changes will be added to this array.
  491. $scope.reviewPanel.selectedEntryIds = []
  492. // Count of user-visible changes, i.e. an aggregated change will count as one.
  493. $scope.reviewPanel.nVisibleSelectedChanges = 0
  494. delete entries['add-comment']
  495. delete entries['bulk-actions']
  496. if (selection) {
  497. entries['add-comment'] = {
  498. type: 'add-comment',
  499. offset: selection_offset_start,
  500. length: selection_offset_end - selection_offset_start,
  501. }
  502. entries['bulk-actions'] = {
  503. type: 'bulk-actions',
  504. offset: selection_offset_start,
  505. length: selection_offset_end - selection_offset_start,
  506. }
  507. }
  508. for (const id in entries) {
  509. const entry = entries[id]
  510. let isChangeEntryAndWithinSelection = false
  511. if (
  512. entry.type === 'comment' &&
  513. !$scope.reviewPanel.resolvedThreadIds[entry.thread_id]
  514. ) {
  515. entry.focused =
  516. entry.offset <= selection_offset_start &&
  517. selection_offset_start <= entry.offset + entry.content.length
  518. } else if (entry.type === 'insert') {
  519. isChangeEntryAndWithinSelection =
  520. entry.offset >= selection_offset_start &&
  521. entry.offset + entry.content.length <= selection_offset_end
  522. entry.focused =
  523. entry.offset <= selection_offset_start &&
  524. selection_offset_start <= entry.offset + entry.content.length
  525. } else if (entry.type === 'delete') {
  526. isChangeEntryAndWithinSelection =
  527. selection_offset_start <= entry.offset &&
  528. entry.offset <= selection_offset_end
  529. entry.focused = entry.offset === selection_offset_start
  530. } else if (entry.type === 'aggregate-change') {
  531. isChangeEntryAndWithinSelection =
  532. entry.offset >= selection_offset_start &&
  533. entry.offset + entry.content.length <= selection_offset_end
  534. entry.focused =
  535. entry.offset <= selection_offset_start &&
  536. selection_offset_start <= entry.offset + entry.content.length
  537. } else if (
  538. ['add-comment', 'bulk-actions'].includes(entry.type) &&
  539. selection
  540. ) {
  541. entry.focused = true
  542. }
  543. if (isChangeEntryAndWithinSelection) {
  544. for (const entry_id of Array.from(entry.entry_ids)) {
  545. $scope.reviewPanel.selectedEntryIds.push(entry_id)
  546. }
  547. $scope.reviewPanel.nVisibleSelectedChanges++
  548. }
  549. }
  550. $scope.$broadcast('review-panel:recalculate-screen-positions')
  551. return $scope.$broadcast('review-panel:layout')
  552. }
  553. )
  554. $scope.acceptChanges = function (change_ids) {
  555. _doAcceptChanges(change_ids)
  556. eventTracking.sendMB('rp-changes-accepted', {
  557. view: $scope.ui.reviewPanelOpen ? $scope.reviewPanel.subView : 'mini',
  558. })
  559. }
  560. $scope.rejectChanges = function (change_ids) {
  561. _doRejectChanges(change_ids)
  562. eventTracking.sendMB('rp-changes-rejected', {
  563. view: $scope.ui.reviewPanelOpen ? $scope.reviewPanel.subView : 'mini',
  564. })
  565. }
  566. function _doAcceptChanges(change_ids) {
  567. $http.post(
  568. `/project/${$scope.project_id}/doc/${$scope.editor.open_doc_id}/changes/accept`,
  569. { change_ids, _csrf: window.csrfToken }
  570. )
  571. return $scope.$broadcast('changes:accept', change_ids)
  572. }
  573. const _doRejectChanges = change_ids =>
  574. $scope.$broadcast('changes:reject', change_ids)
  575. const bulkAccept = function () {
  576. _doAcceptChanges($scope.reviewPanel.selectedEntryIds.slice())
  577. eventTracking.sendMB('rp-bulk-accept', {
  578. view: $scope.ui.reviewPanelOpen ? $scope.reviewPanel.subView : 'mini',
  579. nEntries: $scope.reviewPanel.nVisibleSelectedChanges,
  580. })
  581. }
  582. const bulkReject = function () {
  583. _doRejectChanges($scope.reviewPanel.selectedEntryIds.slice())
  584. eventTracking.sendMB('rp-bulk-reject', {
  585. view: $scope.ui.reviewPanelOpen ? $scope.reviewPanel.subView : 'mini',
  586. nEntries: $scope.reviewPanel.nVisibleSelectedChanges,
  587. })
  588. }
  589. $scope.showBulkAcceptDialog = () => showBulkActionsDialog(true)
  590. $scope.showBulkRejectDialog = () => showBulkActionsDialog(false)
  591. const showBulkActionsDialog = isAccept =>
  592. $modal
  593. .open({
  594. templateUrl: 'bulkActionsModalTemplate',
  595. controller: 'BulkActionsModalController',
  596. resolve: {
  597. isAccept() {
  598. return isAccept
  599. },
  600. nChanges() {
  601. return $scope.reviewPanel.nVisibleSelectedChanges
  602. },
  603. },
  604. scope: $scope.$new(),
  605. })
  606. .result.then(function (isAccept) {
  607. if (isAccept) {
  608. return bulkAccept()
  609. } else {
  610. return bulkReject()
  611. }
  612. })
  613. $scope.handleTogglerClick = function (e) {
  614. e.target.blur()
  615. return $scope.toggleReviewPanel()
  616. }
  617. $scope.addNewComment = function () {
  618. $scope.$broadcast('comment:start_adding')
  619. return $scope.toggleReviewPanel()
  620. }
  621. $scope.addNewCommentFromKbdShortcut = function () {
  622. if (!$scope.project.features.trackChangesVisible) {
  623. return
  624. }
  625. $scope.$broadcast('comment:select_line')
  626. if (!$scope.ui.reviewPanelOpen) {
  627. $scope.toggleReviewPanel()
  628. }
  629. return $timeout(function () {
  630. $scope.$broadcast('review-panel:layout')
  631. return $scope.$broadcast('comment:start_adding')
  632. })
  633. }
  634. $scope.startNewComment = function () {
  635. $scope.$broadcast('comment:select_line')
  636. return $timeout(() => $scope.$broadcast('review-panel:layout'))
  637. }
  638. $scope.submitNewComment = function (content) {
  639. if (content == null || content === '') {
  640. return
  641. }
  642. const doc_id = $scope.editor.open_doc_id
  643. const entries = getDocEntries(doc_id)
  644. if (entries['add-comment'] == null) {
  645. return
  646. }
  647. const { offset, length } = entries['add-comment']
  648. const thread_id = RangesTracker.generateId()
  649. const thread = getThread(thread_id)
  650. thread.submitting = true
  651. $scope.$broadcast('comment:add', thread_id, offset, length)
  652. $http
  653. .post(`/project/${$scope.project_id}/thread/${thread_id}/messages`, {
  654. content,
  655. _csrf: window.csrfToken,
  656. })
  657. .catch(() =>
  658. ide.showGenericMessageModal(
  659. 'Error submitting comment',
  660. 'Sorry, there was a problem submitting your comment'
  661. )
  662. )
  663. $scope.$broadcast('editor:clearSelection')
  664. $timeout(() => $scope.$broadcast('review-panel:layout'))
  665. eventTracking.sendMB('rp-new-comment', { size: content.length })
  666. }
  667. $scope.cancelNewComment = entry =>
  668. $timeout(() => $scope.$broadcast('review-panel:layout'))
  669. $scope.startReply = function (entry) {
  670. entry.replying = true
  671. return $timeout(() => $scope.$broadcast('review-panel:layout'))
  672. }
  673. $scope.submitReply = function (entry, entry_id) {
  674. const { thread_id } = entry
  675. const content = entry.replyContent
  676. $http
  677. .post(`/project/${$scope.project_id}/thread/${thread_id}/messages`, {
  678. content,
  679. _csrf: window.csrfToken,
  680. })
  681. .catch(() =>
  682. ide.showGenericMessageModal(
  683. 'Error submitting comment',
  684. 'Sorry, there was a problem submitting your comment'
  685. )
  686. )
  687. const trackingMetadata = {
  688. view: $scope.ui.reviewPanelOpen ? $scope.reviewPanel.subView : 'mini',
  689. size: entry.replyContent.length,
  690. thread: thread_id,
  691. }
  692. const thread = getThread(thread_id)
  693. thread.submitting = true
  694. entry.replyContent = ''
  695. entry.replying = false
  696. $timeout(() => $scope.$broadcast('review-panel:layout'))
  697. eventTracking.sendMB('rp-comment-reply', trackingMetadata)
  698. }
  699. $scope.cancelReply = function (entry) {
  700. entry.replying = false
  701. entry.replyContent = ''
  702. return $scope.$broadcast('review-panel:layout')
  703. }
  704. $scope.resolveComment = function (entry, entry_id) {
  705. entry.focused = false
  706. $http.post(
  707. `/project/${$scope.project_id}/thread/${entry.thread_id}/resolve`,
  708. { _csrf: window.csrfToken }
  709. )
  710. _onCommentResolved(entry.thread_id, ide.$scope.user)
  711. eventTracking.sendMB('rp-comment-resolve', {
  712. view: $scope.ui.reviewPanelOpen ? $scope.reviewPanel.subView : 'mini',
  713. })
  714. }
  715. $scope.unresolveComment = function (thread_id) {
  716. _onCommentReopened(thread_id)
  717. $http.post(`/project/${$scope.project_id}/thread/${thread_id}/reopen`, {
  718. _csrf: window.csrfToken,
  719. })
  720. eventTracking.sendMB('rp-comment-reopen')
  721. }
  722. function _onCommentResolved(thread_id, user) {
  723. const thread = getThread(thread_id)
  724. if (thread == null) {
  725. return
  726. }
  727. thread.resolved = true
  728. thread.resolved_by_user = formatUser(user)
  729. thread.resolved_at = new Date().toISOString()
  730. $scope.reviewPanel.resolvedThreadIds[thread_id] = true
  731. return $scope.$broadcast('comment:resolve_threads', [thread_id])
  732. }
  733. function _onCommentReopened(thread_id) {
  734. const thread = getThread(thread_id)
  735. if (thread == null) {
  736. return
  737. }
  738. delete thread.resolved
  739. delete thread.resolved_by_user
  740. delete thread.resolved_at
  741. delete $scope.reviewPanel.resolvedThreadIds[thread_id]
  742. return $scope.$broadcast('comment:unresolve_thread', thread_id)
  743. }
  744. function _onThreadDeleted(thread_id) {
  745. delete $scope.reviewPanel.resolvedThreadIds[thread_id]
  746. delete $scope.reviewPanel.commentThreads[thread_id]
  747. return $scope.$broadcast('comment:remove', thread_id)
  748. }
  749. function _onCommentEdited(thread_id, comment_id, content) {
  750. const thread = getThread(thread_id)
  751. if (thread == null) {
  752. return
  753. }
  754. for (const message of Array.from(thread.messages)) {
  755. if (message.id === comment_id) {
  756. message.content = content
  757. }
  758. }
  759. return updateEntries()
  760. }
  761. function _onCommentDeleted(thread_id, comment_id) {
  762. const thread = getThread(thread_id)
  763. if (thread == null) {
  764. return
  765. }
  766. thread.messages = thread.messages.filter(m => m.id !== comment_id)
  767. return updateEntries()
  768. }
  769. $scope.deleteThread = function (entry_id, doc_id, thread_id) {
  770. _onThreadDeleted(thread_id)
  771. $http({
  772. method: 'DELETE',
  773. url: `/project/${$scope.project_id}/doc/${doc_id}/thread/${thread_id}`,
  774. headers: {
  775. 'X-CSRF-Token': window.csrfToken,
  776. },
  777. })
  778. eventTracking.sendMB('rp-comment-delete')
  779. }
  780. $scope.saveEdit = function (thread_id, comment) {
  781. $http.post(
  782. `/project/${$scope.project_id}/thread/${thread_id}/messages/${comment.id}/edit`,
  783. {
  784. content: comment.content,
  785. _csrf: window.csrfToken,
  786. }
  787. )
  788. return $timeout(() => $scope.$broadcast('review-panel:layout'))
  789. }
  790. $scope.deleteComment = function (thread_id, comment) {
  791. _onCommentDeleted(thread_id, comment.id)
  792. $http({
  793. method: 'DELETE',
  794. url: `/project/${$scope.project_id}/thread/${thread_id}/messages/${comment.id}`,
  795. headers: {
  796. 'X-CSRF-Token': window.csrfToken,
  797. },
  798. })
  799. return $timeout(() => $scope.$broadcast('review-panel:layout'))
  800. }
  801. $scope.setSubView = function (subView) {
  802. $scope.reviewPanel.subView = subView
  803. eventTracking.sendMB('rp-subview-change', { subView })
  804. }
  805. $scope.gotoEntry = (doc_id, entry) =>
  806. ide.editorManager.openDocId(doc_id, { gotoOffset: entry.offset })
  807. $scope.toggleFullTCStateCollapse = function () {
  808. if ($scope.project.features.trackChanges) {
  809. return ($scope.reviewPanel.fullTCStateCollapsed =
  810. !$scope.reviewPanel.fullTCStateCollapsed)
  811. } else {
  812. _sendAnalytics()
  813. return $scope.openTrackChangesUpgradeModal()
  814. }
  815. }
  816. const _sendAnalytics = () => {
  817. eventTracking.send(
  818. 'subscription-funnel',
  819. 'editor-click-feature',
  820. 'real-time-track-changes'
  821. )
  822. eventTracking.sendMB('paywall-prompt', {
  823. 'paywall-type': 'track-changes',
  824. })
  825. }
  826. const _setUserTCState = function (userId, newValue, isLocal) {
  827. if (isLocal == null) {
  828. isLocal = false
  829. }
  830. if ($scope.reviewPanel.trackChangesState[userId] == null) {
  831. $scope.reviewPanel.trackChangesState[userId] = {}
  832. }
  833. const state = $scope.reviewPanel.trackChangesState[userId]
  834. if (
  835. state.syncState == null ||
  836. state.syncState === UserTCSyncState.SYNCED
  837. ) {
  838. state.value = newValue
  839. state.syncState = UserTCSyncState.SYNCED
  840. } else if (
  841. state.syncState === UserTCSyncState.PENDING &&
  842. state.value === newValue
  843. ) {
  844. state.syncState = UserTCSyncState.SYNCED
  845. } else if (isLocal) {
  846. state.value = newValue
  847. state.syncState = UserTCSyncState.PENDING
  848. }
  849. if (userId === ide.$scope.user.id) {
  850. return ($scope.editor.wantTrackChanges = newValue)
  851. }
  852. }
  853. const _setEveryoneTCState = function (newValue, isLocal) {
  854. if (isLocal == null) {
  855. isLocal = false
  856. }
  857. $scope.reviewPanel.trackChangesOnForEveryone = newValue
  858. const { project } = $scope
  859. for (const member of Array.from(project.members)) {
  860. _setUserTCState(member._id, newValue, isLocal)
  861. }
  862. _setGuestsTCState(newValue, isLocal)
  863. return _setUserTCState(project.owner._id, newValue, isLocal)
  864. }
  865. function _setGuestsTCState(newValue, isLocal) {
  866. if (isLocal == null) {
  867. isLocal = false
  868. }
  869. $scope.reviewPanel.trackChangesOnForGuests = newValue
  870. if (
  871. currentUserType() === UserTypes.GUEST ||
  872. currentUserType() === UserTypes.ANONYMOUS
  873. ) {
  874. return ($scope.editor.wantTrackChanges = newValue)
  875. }
  876. }
  877. const applyClientTrackChangesStateToServer = function () {
  878. const data = {}
  879. if ($scope.reviewPanel.trackChangesOnForEveryone) {
  880. data.on = true
  881. } else {
  882. data.on_for = {}
  883. for (const userId in $scope.reviewPanel.trackChangesState) {
  884. const userState = $scope.reviewPanel.trackChangesState[userId]
  885. data.on_for[userId] = userState.value
  886. }
  887. if ($scope.reviewPanel.trackChangesOnForGuests) {
  888. data.on_for_guests = true
  889. }
  890. }
  891. data._csrf = window.csrfToken
  892. return $http.post(`/project/${$scope.project_id}/track_changes`, data)
  893. }
  894. const applyTrackChangesStateToClient = function (state) {
  895. if (typeof state === 'boolean') {
  896. _setEveryoneTCState(state)
  897. return _setGuestsTCState(state)
  898. } else {
  899. const { project } = $scope
  900. $scope.reviewPanel.trackChangesOnForEveryone = false
  901. _setGuestsTCState(state.__guests__ === true)
  902. for (const member of Array.from(project.members)) {
  903. _setUserTCState(
  904. member._id,
  905. state[member._id] != null ? state[member._id] : false
  906. )
  907. }
  908. return _setUserTCState(
  909. $scope.project.owner._id,
  910. state[$scope.project.owner._id] != null
  911. ? state[$scope.project.owner._id]
  912. : false
  913. )
  914. }
  915. }
  916. $scope.toggleTrackChangesForEveryone = function (onForEveryone) {
  917. _setEveryoneTCState(onForEveryone, true)
  918. _setGuestsTCState(onForEveryone, true)
  919. return applyClientTrackChangesStateToServer()
  920. }
  921. $scope.toggleTrackChangesForGuests = function (onForGuests) {
  922. _setGuestsTCState(onForGuests, true)
  923. return applyClientTrackChangesStateToServer()
  924. }
  925. $scope.toggleTrackChangesForUser = function (onForUser, userId) {
  926. _setUserTCState(userId, onForUser, true)
  927. return applyClientTrackChangesStateToServer()
  928. }
  929. ide.socket.on('toggle-track-changes', state =>
  930. $scope.$apply(() => applyTrackChangesStateToClient(state))
  931. )
  932. $scope.toggleTrackChangesFromKbdShortcut = function () {
  933. if (
  934. !(
  935. $scope.project.features.trackChangesVisible &&
  936. $scope.project.features.trackChanges
  937. )
  938. ) {
  939. return
  940. }
  941. return $scope.toggleTrackChangesForUser(
  942. !$scope.reviewPanel.trackChangesState[ide.$scope.user.id].value,
  943. ide.$scope.user.id
  944. )
  945. }
  946. const setGuestFeatureBasedOnProjectAccessLevel = projectPublicAccessLevel =>
  947. ($scope.reviewPanel.trackChangesForGuestsAvailable =
  948. projectPublicAccessLevel === 'tokenBased')
  949. const onToggleTrackChangesForGuestsAvailability = function (available) {
  950. // If the feature is no longer available we need to turn off the guest flag
  951. if (available) {
  952. return
  953. }
  954. if (!$scope.reviewPanel.trackChangesOnForGuests) {
  955. return
  956. } // Already turned off
  957. if ($scope.reviewPanel.trackChangesOnForEveryone) {
  958. return
  959. } // Overrides guest setting
  960. return $scope.toggleTrackChangesForGuests(false)
  961. }
  962. $scope.$watch(
  963. 'project.publicAccesLevel',
  964. setGuestFeatureBasedOnProjectAccessLevel
  965. )
  966. $scope.$watch(
  967. 'reviewPanel.trackChangesForGuestsAvailable',
  968. function (available) {
  969. if (available != null) {
  970. return onToggleTrackChangesForGuestsAvailability(available)
  971. }
  972. }
  973. )
  974. let _inited = false
  975. ide.$scope.$on('project:joined', function () {
  976. if (_inited) {
  977. return
  978. }
  979. const { project } = ide.$scope
  980. if (project.features.trackChanges) {
  981. applyTrackChangesStateToClient(project.trackChangesState)
  982. } else {
  983. applyTrackChangesStateToClient(false)
  984. }
  985. setGuestFeatureBasedOnProjectAccessLevel(project.publicAccesLevel)
  986. return (_inited = true)
  987. })
  988. let _refreshingRangeUsers = false
  989. const _refreshedForUserIds = {}
  990. function refreshChangeUsers(refresh_for_user_id) {
  991. if (refresh_for_user_id != null) {
  992. if (_refreshedForUserIds[refresh_for_user_id] != null) {
  993. // We've already tried to refresh to get this user id, so stop it looping
  994. return
  995. }
  996. _refreshedForUserIds[refresh_for_user_id] = true
  997. }
  998. // Only do one refresh at once
  999. if (_refreshingRangeUsers) {
  1000. return
  1001. }
  1002. _refreshingRangeUsers = true
  1003. return $http
  1004. .get(`/project/${$scope.project_id}/changes/users`)
  1005. .then(function (response) {
  1006. const users = response.data
  1007. _refreshingRangeUsers = false
  1008. $scope.users = {}
  1009. // Always include ourself, since if we submit an op, we might need to display info
  1010. // about it locally before it has been flushed through the server
  1011. if (
  1012. (ide.$scope.user != null ? ide.$scope.user.id : undefined) != null
  1013. ) {
  1014. $scope.users[ide.$scope.user.id] = formatUser(ide.$scope.user)
  1015. }
  1016. return (() => {
  1017. const result = []
  1018. for (const user of Array.from(users)) {
  1019. if (user.id != null) {
  1020. result.push(($scope.users[user.id] = formatUser(user)))
  1021. } else {
  1022. result.push(undefined)
  1023. }
  1024. }
  1025. return result
  1026. })()
  1027. })
  1028. .catch(() => (_refreshingRangeUsers = false))
  1029. }
  1030. let _threadsLoaded = false
  1031. function ensureThreadsAreLoaded() {
  1032. if (_threadsLoaded) {
  1033. // We get any updates in real time so only need to load them once.
  1034. return
  1035. }
  1036. _threadsLoaded = true
  1037. $scope.reviewPanel.loadingThreads = true
  1038. return $http
  1039. .get(`/project/${$scope.project_id}/threads`)
  1040. .then(function (response) {
  1041. const threads = response.data
  1042. $scope.reviewPanel.loadingThreads = false
  1043. for (const thread_id in $scope.reviewPanel.resolvedThreadIds) {
  1044. const _ = $scope.reviewPanel.resolvedThreadIds[thread_id]
  1045. delete $scope.reviewPanel.resolvedThreadIds[thread_id]
  1046. }
  1047. for (const thread_id in threads) {
  1048. const thread = threads[thread_id]
  1049. for (const comment of Array.from(thread.messages)) {
  1050. formatComment(comment)
  1051. }
  1052. if (thread.resolved_by_user != null) {
  1053. thread.resolved_by_user = formatUser(thread.resolved_by_user)
  1054. $scope.reviewPanel.resolvedThreadIds[thread_id] = true
  1055. $scope.$broadcast('comment:resolve_threads', [thread_id])
  1056. }
  1057. }
  1058. $scope.reviewPanel.commentThreads = threads
  1059. return $timeout(() => $scope.$broadcast('review-panel:layout'))
  1060. })
  1061. }
  1062. function formatComment(comment) {
  1063. comment.user = formatUser(comment.user)
  1064. comment.timestamp = new Date(comment.timestamp)
  1065. return comment
  1066. }
  1067. function formatUser(user) {
  1068. let isSelf, name
  1069. const id =
  1070. (user != null ? user._id : undefined) ||
  1071. (user != null ? user.id : undefined)
  1072. if (id == null) {
  1073. return {
  1074. email: null,
  1075. name: 'Anonymous',
  1076. isSelf: false,
  1077. hue: ColorManager.ANONYMOUS_HUE,
  1078. avatar_text: 'A',
  1079. }
  1080. }
  1081. if (id === window.user_id) {
  1082. name = 'You'
  1083. isSelf = true
  1084. } else {
  1085. name = [user.first_name, user.last_name]
  1086. .filter(n => n != null && n !== '')
  1087. .join(' ')
  1088. if (name === '') {
  1089. name =
  1090. (user.email != null ? user.email.split('@')[0] : undefined) ||
  1091. 'Unknown'
  1092. }
  1093. isSelf = false
  1094. }
  1095. return {
  1096. id,
  1097. email: user.email,
  1098. name,
  1099. isSelf,
  1100. hue: ColorManager.getHueForUserId(id),
  1101. avatar_text: [user.first_name, user.last_name]
  1102. .filter(n => n != null)
  1103. .map(n => n[0])
  1104. .join(''),
  1105. }
  1106. }
  1107. $scope.openTrackChangesUpgradeModal = () =>
  1108. $modal.open({
  1109. templateUrl: 'trackChangesUpgradeModalTemplate',
  1110. controller: 'TrackChangesUpgradeModalController',
  1111. scope: $scope.$new(),
  1112. })
  1113. }
  1114. )