From 3f4c2855513646fbd826d0473b6304dbad1f3b16 Mon Sep 17 00:00:00 2001 From: Ghassen Rjab Date: Sat, 8 Jul 2017 13:23:33 +0100 Subject: Add import Wekan board feature --- models/import.js | 513 ++---------------------------------------------- models/trelloCreator.js | 500 ++++++++++++++++++++++++++++++++++++++++++++++ models/wekanCreator.js | 476 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 993 insertions(+), 496 deletions(-) create mode 100644 models/trelloCreator.js create mode 100644 models/wekanCreator.js (limited to 'models') diff --git a/models/import.js b/models/import.js index 39a8835e..2e58c90f 100644 --- a/models/import.js +++ b/models/import.js @@ -1,507 +1,28 @@ -const DateString = Match.Where(function (dateAsString) { - check(dateAsString, String); - return moment(dateAsString, moment.ISO_8601).isValid(); -}); - -class TrelloCreator { - constructor(data) { - // we log current date, to use the same timestamp for all our actions. - // this helps to retrieve all elements performed by the same import. - this._nowDate = new Date(); - // The object creation dates, indexed by Trello id - // (so we only parse actions once!) - this.createdAt = { - board: null, - cards: {}, - lists: {}, - }; - // The object creator Trello Id, indexed by the object Trello id - // (so we only parse actions once!) - this.createdBy = { - cards: {}, // only cards have a field for that - }; - - // Map of labels Trello ID => Wekan ID - this.labels = {}; - // Map of lists Trello ID => Wekan ID - this.lists = {}; - // Map of cards Trello ID => Wekan ID - this.cards = {}; - // The comments, indexed by Trello card id (to map when importing cards) - this.comments = {}; - // the members, indexed by Trello member id => Wekan user ID - this.members = data.membersMapping ? data.membersMapping : {}; - - // maps a trelloCardId to an array of trelloAttachments - this.attachments = {}; - } - - /** - * If dateString is provided, - * return the Date it represents. - * If not, will return the date when it was first called. - * This is useful for us, as we want all import operations to - * have the exact same date for easier later retrieval. - * - * @param {String} dateString a properly formatted Date - */ - _now(dateString) { - if(dateString) { - return new Date(dateString); - } - if(!this._nowDate) { - this._nowDate = new Date(); - } - return this._nowDate; - } - - /** - * if trelloUserId is provided and we have a mapping, - * return it. - * Otherwise return current logged user. - * @param trelloUserId - * @private - */ - _user(trelloUserId) { - if(trelloUserId && this.members[trelloUserId]) { - return this.members[trelloUserId]; - } - return Meteor.userId(); - } - - checkActions(trelloActions) { - check(trelloActions, [Match.ObjectIncluding({ - data: Object, - date: DateString, - type: String, - })]); - // XXX we could perform more thorough checks based on action type - } - - checkBoard(trelloBoard) { - check(trelloBoard, Match.ObjectIncluding({ - closed: Boolean, - name: String, - prefs: Match.ObjectIncluding({ - // XXX refine control by validating 'background' against a list of - // allowed values (is it worth the maintenance?) - background: String, - permissionLevel: Match.Where((value) => { - return ['org', 'private', 'public'].indexOf(value)>= 0; - }), - }), - })); - } - - checkCards(trelloCards) { - check(trelloCards, [Match.ObjectIncluding({ - closed: Boolean, - dateLastActivity: DateString, - desc: String, - idLabels: [String], - idMembers: [String], - name: String, - pos: Number, - })]); - } - - checkLabels(trelloLabels) { - check(trelloLabels, [Match.ObjectIncluding({ - // XXX refine control by validating 'color' against a list of allowed - // values (is it worth the maintenance?) - color: String, - name: String, - })]); - } - - checkLists(trelloLists) { - check(trelloLists, [Match.ObjectIncluding({ - closed: Boolean, - name: String, - })]); - } - - checkChecklists(trelloChecklists) { - check(trelloChecklists, [Match.ObjectIncluding({ - idBoard: String, - idCard: String, - name: String, - checkItems: [Match.ObjectIncluding({ - state: String, - name: String, - })], - })]); - } - - // You must call parseActions before calling this one. - createBoardAndLabels(trelloBoard) { - const boardToCreate = { - archived: trelloBoard.closed, - color: this.getColor(trelloBoard.prefs.background), - // very old boards won't have a creation activity so no creation date - createdAt: this._now(this.createdAt.board), - labels: [], - members: [{ - userId: Meteor.userId(), - isAdmin: true, - isActive: true, - isCommentOnly: false, - }], - permission: this.getPermission(trelloBoard.prefs.permissionLevel), - slug: getSlug(trelloBoard.name) || 'board', - stars: 0, - title: trelloBoard.name, - }; - // now add other members - if(trelloBoard.memberships) { - trelloBoard.memberships.forEach((trelloMembership) => { - const trelloId = trelloMembership.idMember; - // do we have a mapping? - if(this.members[trelloId]) { - const wekanId = this.members[trelloId]; - // do we already have it in our list? - const wekanMember = boardToCreate.members.find((wekanMember) => wekanMember.userId === wekanId); - if(wekanMember) { - // we're already mapped, but maybe with lower rights - if(!wekanMember.isAdmin) { - wekanMember.isAdmin = this.getAdmin(trelloMembership.memberType); - } - } else { - boardToCreate.members.push({ - userId: wekanId, - isAdmin: this.getAdmin(trelloMembership.memberType), - isActive: true, - isCommentOnly: false, - }); - } - } - }); - } - trelloBoard.labels.forEach((label) => { - const labelToCreate = { - _id: Random.id(6), - color: label.color, - name: label.name, - }; - // We need to remember them by Trello ID, as this is the only ref we have - // when importing cards. - this.labels[label.id] = labelToCreate._id; - boardToCreate.labels.push(labelToCreate); - }); - const boardId = Boards.direct.insert(boardToCreate); - Boards.direct.update(boardId, {$set: {modifiedAt: this._now()}}); - // log activity - Activities.direct.insert({ - activityType: 'importBoard', - boardId, - createdAt: this._now(), - source: { - id: trelloBoard.id, - system: 'Trello', - url: trelloBoard.url, - }, - // We attribute the import to current user, - // not the author from the original object. - userId: this._user(), - }); - return boardId; - } - - /** - * Create the Wekan cards corresponding to the supplied Trello cards, - * as well as all linked data: activities, comments, and attachments - * @param trelloCards - * @param boardId - * @returns {Array} - */ - createCards(trelloCards, boardId) { - const result = []; - trelloCards.forEach((card) => { - const cardToCreate = { - archived: card.closed, - boardId, - // very old boards won't have a creation activity so no creation date - createdAt: this._now(this.createdAt.cards[card.id]), - dateLastActivity: this._now(), - description: card.desc, - listId: this.lists[card.idList], - sort: card.pos, - title: card.name, - // we attribute the card to its creator if available - userId: this._user(this.createdBy.cards[card.id]), - dueAt: card.due ? this._now(card.due) : null, - }; - // add labels - if (card.idLabels) { - cardToCreate.labelIds = card.idLabels.map((trelloId) => { - return this.labels[trelloId]; - }); - } - // add members { - if(card.idMembers) { - const wekanMembers = []; - // we can't just map, as some members may not have been mapped - card.idMembers.forEach((trelloId) => { - if(this.members[trelloId]) { - const wekanId = this.members[trelloId]; - // we may map multiple Trello members to the same wekan user - // in which case we risk adding the same user multiple times - if(!wekanMembers.find((wId) => wId === wekanId)){ - wekanMembers.push(wekanId); - } - } - return true; - }); - if(wekanMembers.length>0) { - cardToCreate.members = wekanMembers; - } - } - // insert card - const cardId = Cards.direct.insert(cardToCreate); - // keep track of Trello id => WeKan id - this.cards[card.id] = cardId; - // log activity - Activities.direct.insert({ - activityType: 'importCard', - boardId, - cardId, - createdAt: this._now(), - listId: cardToCreate.listId, - source: { - id: card.id, - system: 'Trello', - url: card.url, - }, - // we attribute the import to current user, - // not the author of the original card - userId: this._user(), - }); - // add comments - const comments = this.comments[card.id]; - if (comments) { - comments.forEach((comment) => { - const commentToCreate = { - boardId, - cardId, - createdAt: this._now(comment.date), - text: comment.data.text, - // we attribute the comment to the original author, default to current user - userId: this._user(comment.idMemberCreator), - }; - // dateLastActivity will be set from activity insert, no need to - // update it ourselves - const commentId = CardComments.direct.insert(commentToCreate); - Activities.direct.insert({ - activityType: 'addComment', - boardId: commentToCreate.boardId, - cardId: commentToCreate.cardId, - commentId, - createdAt: this._now(commentToCreate.createdAt), - // we attribute the addComment (not the import) - // to the original author - it is needed by some UI elements. - userId: commentToCreate.userId, - }); - }); - } - const attachments = this.attachments[card.id]; - const trelloCoverId = card.idAttachmentCover; - if (attachments) { - attachments.forEach((att) => { - const file = new FS.File(); - // Simulating file.attachData on the client generates multiple errors - // - HEAD returns null, which causes exception down the line - // - the template then tries to display the url to the attachment which causes other errors - // so we make it server only, and let UI catch up once it is done, forget about latency comp. - if(Meteor.isServer) { - file.attachData(att.url, function (error) { - file.boardId = boardId; - file.cardId = cardId; - if (error) { - throw(error); - } else { - const wekanAtt = Attachments.insert(file, () => { - // we do nothing - }); - // - if(trelloCoverId === att.id) { - Cards.direct.update(cardId, { $set: {coverId: wekanAtt._id}}); - } - } - }); - } - // todo XXX set cover - if need be - }); - } - result.push(cardId); - }); - return result; - } - - // Create labels if they do not exist and load this.labels. - createLabels(trelloLabels, board) { - trelloLabels.forEach((label) => { - const color = label.color; - const name = label.name; - const existingLabel = board.getLabel(name, color); - if (existingLabel) { - this.labels[label.id] = existingLabel._id; - } else { - const idLabelCreated = board.pushLabel(name, color); - this.labels[label.id] = idLabelCreated; - } - }); - } - - createLists(trelloLists, boardId) { - trelloLists.forEach((list) => { - const listToCreate = { - archived: list.closed, - boardId, - // We are being defensing here by providing a default date (now) if the - // creation date wasn't found on the action log. This happen on old - // Trello boards (eg from 2013) that didn't log the 'createList' action - // we require. - createdAt: this._now(this.createdAt.lists[list.id]), - title: list.name, - }; - const listId = Lists.direct.insert(listToCreate); - Lists.direct.update(listId, {$set: {'updatedAt': this._now()}}); - this.lists[list.id] = listId; - // log activity - Activities.direct.insert({ - activityType: 'importList', - boardId, - createdAt: this._now(), - listId, - source: { - id: list.id, - system: 'Trello', - }, - // We attribute the import to current user, - // not the creator of the original object - userId: this._user(), - }); - }); - } - - createChecklists(trelloChecklists) { - trelloChecklists.forEach((checklist) => { - // Create the checklist - const checklistToCreate = { - cardId: this.cards[checklist.idCard], - title: checklist.name, - createdAt: this._now(), - }; - const checklistId = Checklists.direct.insert(checklistToCreate); - // Now add the items to the checklist - const itemsToCreate = []; - checklist.checkItems.forEach((item) => { - itemsToCreate.push({ - _id: checklistId + itemsToCreate.length, - title: item.name, - isFinished: item.state === 'complete', - }); - }); - Checklists.direct.update(checklistId, {$set: {items: itemsToCreate}}); - }); - } - - getAdmin(trelloMemberType) { - return trelloMemberType === 'admin'; - } - - getColor(trelloColorCode) { - // trello color name => wekan color - const mapColors = { - 'blue': 'belize', - 'orange': 'pumpkin', - 'green': 'nephritis', - 'red': 'pomegranate', - 'purple': 'wisteria', - 'pink': 'pomegranate', - 'lime': 'nephritis', - 'sky': 'belize', - 'grey': 'midnight', - }; - const wekanColor = mapColors[trelloColorCode]; - return wekanColor || Boards.simpleSchema()._schema.color.allowedValues[0]; - } - - getPermission(trelloPermissionCode) { - if (trelloPermissionCode === 'public') { - return 'public'; - } - // Wekan does NOT have organization level, so we default both 'private' and - // 'org' to private. - return 'private'; - } - - parseActions(trelloActions) { - trelloActions.forEach((action) => { - if (action.type === 'addAttachmentToCard') { - // We have to be cautious, because the attachment could have been removed later. - // In that case Trello still reports its addition, but removes its 'url' field. - // So we test for that - const trelloAttachment = action.data.attachment; - if(trelloAttachment.url) { - // we cannot actually create the Wekan attachment, because we don't yet - // have the cards to attach it to, so we store it in the instance variable. - const trelloCardId = action.data.card.id; - if(!this.attachments[trelloCardId]) { - this.attachments[trelloCardId] = []; - } - this.attachments[trelloCardId].push(trelloAttachment); - } - } else if (action.type === 'commentCard') { - const id = action.data.card.id; - if (this.comments[id]) { - this.comments[id].push(action); - } else { - this.comments[id] = [action]; - } - } else if (action.type === 'createBoard') { - this.createdAt.board = action.date; - } else if (action.type === 'createCard') { - const cardId = action.data.card.id; - this.createdAt.cards[cardId] = action.date; - this.createdBy.cards[cardId] = action.idMemberCreator; - } else if (action.type === 'createList') { - const listId = action.data.list.id; - this.createdAt.lists[listId] = action.date; - } - }); - } -} +import { TrelloCreator } from './trelloCreator'; +import { WekanCreator } from './wekanCreator'; Meteor.methods({ - importTrelloBoard(trelloBoard, data) { - const trelloCreator = new TrelloCreator(data); + importBoard(board, data, importSource) { + check(board, Object); + check(data, Object); + check(importSource, String); + let creator; + switch (importSource) { + case 'trello': + creator = new TrelloCreator(data); + break; + case 'wekan': + creator = new WekanCreator(data); + break; + } // 1. check all parameters are ok from a syntax point of view - try { - check(data, { - membersMapping: Match.Optional(Object), - }); - trelloCreator.checkActions(trelloBoard.actions); - trelloCreator.checkBoard(trelloBoard); - trelloCreator.checkLabels(trelloBoard.labels); - trelloCreator.checkLists(trelloBoard.lists); - trelloCreator.checkCards(trelloBoard.cards); - trelloCreator.checkChecklists(trelloBoard.checklists); - } catch (e) { - throw new Meteor.Error('error-json-schema'); - } + creator.check(board); // 2. check parameters are ok from a business point of view (exist & // authorized) nothing to check, everyone can import boards in their account // 3. create all elements - trelloCreator.parseActions(trelloBoard.actions); - const boardId = trelloCreator.createBoardAndLabels(trelloBoard); - trelloCreator.createLists(trelloBoard.lists, boardId); - trelloCreator.createCards(trelloBoard.cards, boardId); - trelloCreator.createChecklists(trelloBoard.checklists); - // XXX add members - return boardId; + return creator.create(board); }, }); diff --git a/models/trelloCreator.js b/models/trelloCreator.js new file mode 100644 index 00000000..fbc4a878 --- /dev/null +++ b/models/trelloCreator.js @@ -0,0 +1,500 @@ +const DateString = Match.Where(function (dateAsString) { + check(dateAsString, String); + return moment(dateAsString, moment.ISO_8601).isValid(); +}); + +export class TrelloCreator { + constructor(data) { + // we log current date, to use the same timestamp for all our actions. + // this helps to retrieve all elements performed by the same import. + this._nowDate = new Date(); + // The object creation dates, indexed by Trello id + // (so we only parse actions once!) + this.createdAt = { + board: null, + cards: {}, + lists: {}, + }; + // The object creator Trello Id, indexed by the object Trello id + // (so we only parse actions once!) + this.createdBy = { + cards: {}, // only cards have a field for that + }; + + // Map of labels Trello ID => Wekan ID + this.labels = {}; + // Map of lists Trello ID => Wekan ID + this.lists = {}; + // Map of cards Trello ID => Wekan ID + this.cards = {}; + // The comments, indexed by Trello card id (to map when importing cards) + this.comments = {}; + // the members, indexed by Trello member id => Wekan user ID + this.members = data.membersMapping ? data.membersMapping : {}; + + // maps a trelloCardId to an array of trelloAttachments + this.attachments = {}; + } + + /** + * If dateString is provided, + * return the Date it represents. + * If not, will return the date when it was first called. + * This is useful for us, as we want all import operations to + * have the exact same date for easier later retrieval. + * + * @param {String} dateString a properly formatted Date + */ + _now(dateString) { + if(dateString) { + return new Date(dateString); + } + if(!this._nowDate) { + this._nowDate = new Date(); + } + return this._nowDate; + } + + /** + * if trelloUserId is provided and we have a mapping, + * return it. + * Otherwise return current logged user. + * @param trelloUserId + * @private + */ + _user(trelloUserId) { + if(trelloUserId && this.members[trelloUserId]) { + return this.members[trelloUserId]; + } + return Meteor.userId(); + } + + checkActions(trelloActions) { + check(trelloActions, [Match.ObjectIncluding({ + data: Object, + date: DateString, + type: String, + })]); + // XXX we could perform more thorough checks based on action type + } + + checkBoard(trelloBoard) { + check(trelloBoard, Match.ObjectIncluding({ + closed: Boolean, + name: String, + prefs: Match.ObjectIncluding({ + // XXX refine control by validating 'background' against a list of + // allowed values (is it worth the maintenance?) + background: String, + permissionLevel: Match.Where((value) => { + return ['org', 'private', 'public'].indexOf(value)>= 0; + }), + }), + })); + } + + checkCards(trelloCards) { + check(trelloCards, [Match.ObjectIncluding({ + closed: Boolean, + dateLastActivity: DateString, + desc: String, + idLabels: [String], + idMembers: [String], + name: String, + pos: Number, + })]); + } + + checkLabels(trelloLabels) { + check(trelloLabels, [Match.ObjectIncluding({ + // XXX refine control by validating 'color' against a list of allowed + // values (is it worth the maintenance?) + color: String, + name: String, + })]); + } + + checkLists(trelloLists) { + check(trelloLists, [Match.ObjectIncluding({ + closed: Boolean, + name: String, + })]); + } + + checkChecklists(trelloChecklists) { + check(trelloChecklists, [Match.ObjectIncluding({ + idBoard: String, + idCard: String, + name: String, + checkItems: [Match.ObjectIncluding({ + state: String, + name: String, + })], + })]); + } + + // You must call parseActions before calling this one. + createBoardAndLabels(trelloBoard) { + const boardToCreate = { + archived: trelloBoard.closed, + color: this.getColor(trelloBoard.prefs.background), + // very old boards won't have a creation activity so no creation date + createdAt: this._now(this.createdAt.board), + labels: [], + members: [{ + userId: Meteor.userId(), + isAdmin: true, + isActive: true, + isCommentOnly: false, + }], + permission: this.getPermission(trelloBoard.prefs.permissionLevel), + slug: getSlug(trelloBoard.name) || 'board', + stars: 0, + title: trelloBoard.name, + }; + // now add other members + if(trelloBoard.memberships) { + trelloBoard.memberships.forEach((trelloMembership) => { + const trelloId = trelloMembership.idMember; + // do we have a mapping? + if(this.members[trelloId]) { + const wekanId = this.members[trelloId]; + // do we already have it in our list? + const wekanMember = boardToCreate.members.find((wekanMember) => wekanMember.userId === wekanId); + if(wekanMember) { + // we're already mapped, but maybe with lower rights + if(!wekanMember.isAdmin) { + wekanMember.isAdmin = this.getAdmin(trelloMembership.memberType); + } + } else { + boardToCreate.members.push({ + userId: wekanId, + isAdmin: this.getAdmin(trelloMembership.memberType), + isActive: true, + isCommentOnly: false, + }); + } + } + }); + } + trelloBoard.labels.forEach((label) => { + const labelToCreate = { + _id: Random.id(6), + color: label.color, + name: label.name, + }; + // We need to remember them by Trello ID, as this is the only ref we have + // when importing cards. + this.labels[label.id] = labelToCreate._id; + boardToCreate.labels.push(labelToCreate); + }); + const boardId = Boards.direct.insert(boardToCreate); + Boards.direct.update(boardId, {$set: {modifiedAt: this._now()}}); + // log activity + Activities.direct.insert({ + activityType: 'importBoard', + boardId, + createdAt: this._now(), + source: { + id: trelloBoard.id, + system: 'Trello', + url: trelloBoard.url, + }, + // We attribute the import to current user, + // not the author from the original object. + userId: this._user(), + }); + return boardId; + } + + /** + * Create the Wekan cards corresponding to the supplied Trello cards, + * as well as all linked data: activities, comments, and attachments + * @param trelloCards + * @param boardId + * @returns {Array} + */ + createCards(trelloCards, boardId) { + const result = []; + trelloCards.forEach((card) => { + const cardToCreate = { + archived: card.closed, + boardId, + // very old boards won't have a creation activity so no creation date + createdAt: this._now(this.createdAt.cards[card.id]), + dateLastActivity: this._now(), + description: card.desc, + listId: this.lists[card.idList], + sort: card.pos, + title: card.name, + // we attribute the card to its creator if available + userId: this._user(this.createdBy.cards[card.id]), + dueAt: card.due ? this._now(card.due) : null, + }; + // add labels + if (card.idLabels) { + cardToCreate.labelIds = card.idLabels.map((trelloId) => { + return this.labels[trelloId]; + }); + } + // add members { + if(card.idMembers) { + const wekanMembers = []; + // we can't just map, as some members may not have been mapped + card.idMembers.forEach((trelloId) => { + if(this.members[trelloId]) { + const wekanId = this.members[trelloId]; + // we may map multiple Trello members to the same wekan user + // in which case we risk adding the same user multiple times + if(!wekanMembers.find((wId) => wId === wekanId)){ + wekanMembers.push(wekanId); + } + } + return true; + }); + if(wekanMembers.length>0) { + cardToCreate.members = wekanMembers; + } + } + // insert card + const cardId = Cards.direct.insert(cardToCreate); + // keep track of Trello id => WeKan id + this.cards[card.id] = cardId; + // log activity + Activities.direct.insert({ + activityType: 'importCard', + boardId, + cardId, + createdAt: this._now(), + listId: cardToCreate.listId, + source: { + id: card.id, + system: 'Trello', + url: card.url, + }, + // we attribute the import to current user, + // not the author of the original card + userId: this._user(), + }); + // add comments + const comments = this.comments[card.id]; + if (comments) { + comments.forEach((comment) => { + const commentToCreate = { + boardId, + cardId, + createdAt: this._now(comment.date), + text: comment.data.text, + // we attribute the comment to the original author, default to current user + userId: this._user(comment.idMemberCreator), + }; + // dateLastActivity will be set from activity insert, no need to + // update it ourselves + const commentId = CardComments.direct.insert(commentToCreate); + Activities.direct.insert({ + activityType: 'addComment', + boardId: commentToCreate.boardId, + cardId: commentToCreate.cardId, + commentId, + createdAt: this._now(commentToCreate.createdAt), + // we attribute the addComment (not the import) + // to the original author - it is needed by some UI elements. + userId: commentToCreate.userId, + }); + }); + } + const attachments = this.attachments[card.id]; + const trelloCoverId = card.idAttachmentCover; + if (attachments) { + attachments.forEach((att) => { + const file = new FS.File(); + // Simulating file.attachData on the client generates multiple errors + // - HEAD returns null, which causes exception down the line + // - the template then tries to display the url to the attachment which causes other errors + // so we make it server only, and let UI catch up once it is done, forget about latency comp. + if(Meteor.isServer) { + file.attachData(att.url, function (error) { + file.boardId = boardId; + file.cardId = cardId; + if (error) { + throw(error); + } else { + const wekanAtt = Attachments.insert(file, () => { + // we do nothing + }); + // + if(trelloCoverId === att.id) { + Cards.direct.update(cardId, { $set: {coverId: wekanAtt._id}}); + } + } + }); + } + // todo XXX set cover - if need be + }); + } + result.push(cardId); + }); + return result; + } + + // Create labels if they do not exist and load this.labels. + createLabels(trelloLabels, board) { + trelloLabels.forEach((label) => { + const color = label.color; + const name = label.name; + const existingLabel = board.getLabel(name, color); + if (existingLabel) { + this.labels[label.id] = existingLabel._id; + } else { + const idLabelCreated = board.pushLabel(name, color); + this.labels[label.id] = idLabelCreated; + } + }); + } + + createLists(trelloLists, boardId) { + trelloLists.forEach((list) => { + const listToCreate = { + archived: list.closed, + boardId, + // We are being defensing here by providing a default date (now) if the + // creation date wasn't found on the action log. This happen on old + // Trello boards (eg from 2013) that didn't log the 'createList' action + // we require. + createdAt: this._now(this.createdAt.lists[list.id]), + title: list.name, + }; + const listId = Lists.direct.insert(listToCreate); + Lists.direct.update(listId, {$set: {'updatedAt': this._now()}}); + this.lists[list.id] = listId; + // log activity + Activities.direct.insert({ + activityType: 'importList', + boardId, + createdAt: this._now(), + listId, + source: { + id: list.id, + system: 'Trello', + }, + // We attribute the import to current user, + // not the creator of the original object + userId: this._user(), + }); + }); + } + + createChecklists(trelloChecklists) { + trelloChecklists.forEach((checklist) => { + // Create the checklist + const checklistToCreate = { + cardId: this.cards[checklist.idCard], + title: checklist.name, + createdAt: this._now(), + }; + const checklistId = Checklists.direct.insert(checklistToCreate); + // Now add the items to the checklist + const itemsToCreate = []; + checklist.checkItems.forEach((item) => { + itemsToCreate.push({ + _id: checklistId + itemsToCreate.length, + title: item.name, + isFinished: item.state === 'complete', + }); + }); + Checklists.direct.update(checklistId, {$set: {items: itemsToCreate}}); + }); + } + + getAdmin(trelloMemberType) { + return trelloMemberType === 'admin'; + } + + getColor(trelloColorCode) { + // trello color name => wekan color + const mapColors = { + 'blue': 'belize', + 'orange': 'pumpkin', + 'green': 'nephritis', + 'red': 'pomegranate', + 'purple': 'wisteria', + 'pink': 'pomegranate', + 'lime': 'nephritis', + 'sky': 'belize', + 'grey': 'midnight', + }; + const wekanColor = mapColors[trelloColorCode]; + return wekanColor || Boards.simpleSchema()._schema.color.allowedValues[0]; + } + + getPermission(trelloPermissionCode) { + if (trelloPermissionCode === 'public') { + return 'public'; + } + // Wekan does NOT have organization level, so we default both 'private' and + // 'org' to private. + return 'private'; + } + + parseActions(trelloActions) { + trelloActions.forEach((action) => { + if (action.type === 'addAttachmentToCard') { + // We have to be cautious, because the attachment could have been removed later. + // In that case Trello still reports its addition, but removes its 'url' field. + // So we test for that + const trelloAttachment = action.data.attachment; + if(trelloAttachment.url) { + // we cannot actually create the Wekan attachment, because we don't yet + // have the cards to attach it to, so we store it in the instance variable. + const trelloCardId = action.data.card.id; + if(!this.attachments[trelloCardId]) { + this.attachments[trelloCardId] = []; + } + this.attachments[trelloCardId].push(trelloAttachment); + } + } else if (action.type === 'commentCard') { + const id = action.data.card.id; + if (this.comments[id]) { + this.comments[id].push(action); + } else { + this.comments[id] = [action]; + } + } else if (action.type === 'createBoard') { + this.createdAt.board = action.date; + } else if (action.type === 'createCard') { + const cardId = action.data.card.id; + this.createdAt.cards[cardId] = action.date; + this.createdBy.cards[cardId] = action.idMemberCreator; + } else if (action.type === 'createList') { + const listId = action.data.list.id; + this.createdAt.lists[listId] = action.date; + } + }); + } + + check(board) { + try { + // check(data, { + // membersMapping: Match.Optional(Object), + // }); + this.checkActions(board.actions); + this.checkBoard(board); + this.checkLabels(board.labels); + this.checkLists(board.lists); + this.checkCards(board.cards); + this.checkChecklists(board.checklists); + } catch (e) { + throw new Meteor.Error('error-json-schema'); + } + } + + create(board) { + this.parseActions(board.actions); + const boardId = this.createBoardAndLabels(board); + this.createLists(board.lists, boardId); + this.createCards(board.cards, boardId); + this.createChecklists(board.checklists); + // XXX add members + return boardId; + } +} diff --git a/models/wekanCreator.js b/models/wekanCreator.js new file mode 100644 index 00000000..b91b875a --- /dev/null +++ b/models/wekanCreator.js @@ -0,0 +1,476 @@ +const DateString = Match.Where(function (dateAsString) { + check(dateAsString, String); + return moment(dateAsString, moment.ISO_8601).isValid(); +}); + +export class WekanCreator { + constructor(data) { + // we log current date, to use the same timestamp for all our actions. + // this helps to retrieve all elements performed by the same import. + this._nowDate = new Date(); + // The object creation dates, indexed by Wekan id + // (so we only parse actions once!) + this.createdAt = { + board: null, + cards: {}, + lists: {}, + }; + // The object creator Wekan Id, indexed by the object Wekan id + // (so we only parse actions once!) + this.createdBy = { + cards: {}, // only cards have a field for that + }; + + // Map of labels Wekan ID => Wekan ID + this.labels = {}; + // Map of lists Wekan ID => Wekan ID + this.lists = {}; + // Map of cards Wekan ID => Wekan ID + this.cards = {}; + // The comments, indexed by Wekan card id (to map when importing cards) + this.comments = {}; + // the members, indexed by Wekan member id => Wekan user ID + this.members = data.membersMapping ? data.membersMapping : {}; + + // maps a wekanCardId to an array of wekanAttachments + this.attachments = {}; + } + + /** + * If dateString is provided, + * return the Date it represents. + * If not, will return the date when it was first called. + * This is useful for us, as we want all import operations to + * have the exact same date for easier later retrieval. + * + * @param {String} dateString a properly formatted Date + */ + _now(dateString) { + if(dateString) { + return new Date(dateString); + } + if(!this._nowDate) { + this._nowDate = new Date(); + } + return this._nowDate; + } + + /** + * if wekanUserId is provided and we have a mapping, + * return it. + * Otherwise return current logged user. + * @param wekanUserId + * @private + */ + _user(wekanUserId) { + if(wekanUserId && this.members[wekanUserId]) { + return this.members[wekanUserId]; + } + return Meteor.userId(); + } + + checkActivities(wekanActivities) { + check(wekanActivities, [Match.ObjectIncluding({ + userId: String, + activityType: String, + createdAt: DateString, + })]); + // XXX we could perform more thorough checks based on action type + } + + checkBoard(wekanBoard) { + check(wekanBoard, Match.ObjectIncluding({ + archived: Boolean, + title: String, + // XXX refine control by validating 'color' against a list of + // allowed values (is it worth the maintenance?) + color: String, + permission: Match.Where((value) => { + return ['private', 'public'].indexOf(value)>= 0; + }), + })); + } + + checkCards(wekanCards) { + check(wekanCards, [Match.ObjectIncluding({ + archived: Boolean, + dateLastActivity: DateString, + labelIds: [String], + members: [String], + title: String, + sort: Number, + })]); + } + + checkLabels(wekanLabels) { + check(wekanLabels, [Match.ObjectIncluding({ + // XXX refine control by validating 'color' against a list of allowed + // values (is it worth the maintenance?) + color: String, + name: String, + })]); + } + + checkLists(wekanLists) { + check(wekanLists, [Match.ObjectIncluding({ + archived: Boolean, + title: String, + })]); + } + + // checkChecklists(wekanChecklists) { + // check(wekanChecklists, [Match.ObjectIncluding({ + // idBoard: String, + // idCard: String, + // name: String, + // checkItems: [Match.ObjectIncluding({ + // state: String, + // name: String, + // })], + // })]); + // } + + // You must call parseActions before calling this one. + createBoardAndLabels(wekanBoard) { + const boardToCreate = { + archived: wekanBoard.archived, + color: wekanBoard.color, + // very old boards won't have a creation activity so no creation date + createdAt: this._now(wekanBoard.createdAt), + labels: [], + members: [{ + userId: Meteor.userId(), + isAdmin: true, + isActive: true, + isCommentOnly: false, + }], + permission: wekanBoard.permission, + slug: getSlug(wekanBoard.title) || 'board', + stars: 0, + title: wekanBoard.title, + }; + // now add other members + if(wekanBoard.members) { + wekanBoard.members.forEach((wekanMember) => { + const wekanId = wekanMember.userId; + // do we have a mapping? + if(this.members[wekanId]) { + const wekanId = this.members[wekanId]; + // do we already have it in our list? + const wekanMember = boardToCreate.members.find((wekanMember) => wekanMember.userId === wekanId); + if(!wekanMember) { + boardToCreate.members.push({ + userId: wekanId, + isAdmin: wekanMember.isAdmin, + isActive: true, + isCommentOnly: false, + }); + } + } + }); + } + wekanBoard.labels.forEach((label) => { + const labelToCreate = { + _id: Random.id(6), + color: label.color, + name: label.name, + }; + // We need to remember them by Wekan ID, as this is the only ref we have + // when importing cards. + this.labels[label._id] = labelToCreate._id; + boardToCreate.labels.push(labelToCreate); + }); + const boardId = Boards.direct.insert(boardToCreate); + Boards.direct.update(boardId, {$set: {modifiedAt: this._now()}}); + // log activity + Activities.direct.insert({ + activityType: 'importBoard', + boardId, + createdAt: this._now(), + source: { + id: wekanBoard.id, + system: 'Wekan', + }, + // We attribute the import to current user, + // not the author from the original object. + userId: this._user(), + }); + return boardId; + } + + /** + * Create the Wekan cards corresponding to the supplied Wekan cards, + * as well as all linked data: activities, comments, and attachments + * @param wekanCards + * @param boardId + * @returns {Array} + */ + createCards(wekanCards, boardId) { + const result = []; + wekanCards.forEach((card) => { + const cardToCreate = { + archived: card.archived, + boardId, + // very old boards won't have a creation activity so no creation date + createdAt: this._now(this.createdAt.cards[card._id]), + dateLastActivity: this._now(), + description: card.description, + listId: this.lists[card.listId], + sort: card.sort, + title: card.title, + // we attribute the card to its creator if available + userId: this._user(this.createdBy.cards[card._id]), + dueAt: card.dueAt ? this._now(card.dueAt) : null, + }; + // add labels + if (card.labelIds) { + cardToCreate.labelIds = card.labelIds.map((wekanId) => { + return this.labels[wekanId]; + }); + } + // add members { + if(card.members) { + const wekanMembers = []; + // we can't just map, as some members may not have been mapped + card.members.forEach((sourceMemberId) => { + if(this.members[sourceMemberId]) { + const wekanId = this.members[sourceMemberId]; + // we may map multiple Wekan members to the same wekan user + // in which case we risk adding the same user multiple times + if(!wekanMembers.find((wId) => wId === wekanId)){ + wekanMembers.push(wekanId); + } + } + return true; + }); + if(wekanMembers.length>0) { + cardToCreate.members = wekanMembers; + } + } + // insert card + const cardId = Cards.direct.insert(cardToCreate); + // keep track of Wekan id => WeKan id + this.cards[card.id] = cardId; + // log activity + Activities.direct.insert({ + activityType: 'importCard', + boardId, + cardId, + createdAt: this._now(), + listId: cardToCreate.listId, + source: { + id: card._id, + system: 'Wekan', + }, + // we attribute the import to current user, + // not the author of the original card + userId: this._user(), + }); + // add comments + const comments = this.comments[card._id]; + if (comments) { + comments.forEach((comment) => { + const commentToCreate = { + boardId, + cardId, + createdAt: this._now(comment.date), + text: comment.text, + // we attribute the comment to the original author, default to current user + userId: this._user(comment.userId), + }; + // dateLastActivity will be set from activity insert, no need to + // update it ourselves + const commentId = CardComments.direct.insert(commentToCreate); + Activities.direct.insert({ + activityType: 'addComment', + boardId: commentToCreate.boardId, + cardId: commentToCreate.cardId, + commentId, + createdAt: this._now(commentToCreate.createdAt), + // we attribute the addComment (not the import) + // to the original author - it is needed by some UI elements. + userId: commentToCreate.userId, + }); + }); + } + const attachments = this.attachments[card._id]; + const wekanCoverId = card.coverId; + if (attachments) { + attachments.forEach((att) => { + const file = new FS.File(); + // Simulating file.attachData on the client generates multiple errors + // - HEAD returns null, which causes exception down the line + // - the template then tries to display the url to the attachment which causes other errors + // so we make it server only, and let UI catch up once it is done, forget about latency comp. + if(Meteor.isServer) { + file.attachData(att.url, function (error) { + file.boardId = boardId; + file.cardId = cardId; + if (error) { + throw(error); + } else { + const wekanAtt = Attachments.insert(file, () => { + // we do nothing + }); + // + if(wekanCoverId === att._id) { + Cards.direct.update(cardId, { $set: {coverId: wekanAtt._id}}); + } + } + }); + } + // todo XXX set cover - if need be + }); + } + result.push(cardId); + }); + return result; + } + + // Create labels if they do not exist and load this.labels. + createLabels(wekanLabels, board) { + wekanLabels.forEach((label) => { + const color = label.color; + const name = label.name; + const existingLabel = board.getLabel(name, color); + if (existingLabel) { + this.labels[label.id] = existingLabel._id; + } else { + const idLabelCreated = board.pushLabel(name, color); + this.labels[label.id] = idLabelCreated; + } + }); + } + + createLists(wekanLists, boardId) { + wekanLists.forEach((list) => { + const listToCreate = { + archived: list.archived, + boardId, + // We are being defensing here by providing a default date (now) if the + // creation date wasn't found on the action log. This happen on old + // Wekan boards (eg from 2013) that didn't log the 'createList' action + // we require. + createdAt: this._now(this.createdAt.lists[list.id]), + title: list.title, + }; + const listId = Lists.direct.insert(listToCreate); + Lists.direct.update(listId, {$set: {'updatedAt': this._now()}}); + this.lists[list._id] = listId; + // log activity + Activities.direct.insert({ + activityType: 'importList', + boardId, + createdAt: this._now(), + listId, + source: { + id: list._id, + system: 'Wekan', + }, + // We attribute the import to current user, + // not the creator of the original object + userId: this._user(), + }); + }); + } + + // createChecklists(wekanChecklists) { + // wekanChecklists.forEach((checklist) => { + // // Create the checklist + // const checklistToCreate = { + // cardId: this.cards[checklist.cardId], + // title: checklist.title, + // createdAt: this._now(), + // }; + // const checklistId = Checklists.direct.insert(checklistToCreate); + // // Now add the items to the checklist + // const itemsToCreate = []; + // checklist.checkItems.forEach((item) => { + // itemsToCreate.push({ + // _id: checklistId + itemsToCreate.length, + // title: item.title, + // isFinished: item.isFinished, + // }); + // }); + // Checklists.direct.update(checklistId, {$set: {items: itemsToCreate}}); + // }); + // } + + parseActivities(wekanBoard) { + wekanBoard.activities.forEach((activity) => { + switch (activity.activityType) { + case 'addAttachment': { + // We have to be cautious, because the attachment could have been removed later. + // In that case Wekan still reports its addition, but removes its 'url' field. + // So we test for that + const wekanAttachment = wekanBoard.attachments.filter((attachment) => { + return attachment._id === activity.attachmentId; + })[0]; + if(wekanAttachment.url) { + // we cannot actually create the Wekan attachment, because we don't yet + // have the cards to attach it to, so we store it in the instance variable. + const wekanCardId = activity.cardId; + if(!this.attachments[wekanCardId]) { + this.attachments[wekanCardId] = []; + } + this.attachments[wekanCardId].push(wekanAttachment); + } + break; + } + case 'addComment': { + const wekanComment = wekanBoard.comments.filter((comment) => { + return comment._id === activity.commentId; + })[0]; + const id = activity.cardId; + if (!this.comments[id]) { + this.comments[id] = []; + } + this.comments[id].push(wekanComment); + break; + } + case 'createBoard': { + this.createdAt.board = activity.createdAt; + break; + } + case 'createCard': { + const cardId = activity.cardId; + this.createdAt.cards[cardId] = activity.createdAt; + this.createdBy.cards[cardId] = activity.userId; + break; + } + case 'createList': { + const listId = activity.listId; + this.createdAt.lists[listId] = activity.createdAt; + break; + }} + }); + } + + check(board) { + try { + // check(data, { + // membersMapping: Match.Optional(Object), + // }); + this.checkActivities(board.activities); + this.checkBoard(board); + this.checkLabels(board.labels); + this.checkLists(board.lists); + this.checkCards(board.cards); + // Checklists are not exported yet + // this.checkChecklists(board.checklists); + } catch (e) { + throw new Meteor.Error('error-json-schema'); + } + } + + create(board) { + this.parseActivities(board); + const boardId = this.createBoardAndLabels(board); + this.createLists(board.lists, boardId); + this.createCards(board.cards, boardId); + // Checklists are not exported yet + // this.createChecklists(board.checklists); + // XXX add members + return boardId; + } +} -- cgit v1.2.3-1-g7c22