depau/HackMD
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
HackMD/lib/models/note.js

522 lines
25 KiB
JavaScript
Raw Normal View History

Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
"use strict";
// external modules
var fs = require('fs');
var path = require('path');
var LZString = require('lz-string');
Update to change server-side pre-rendering engine from marked to markdown-it
2016-07-02 08:11:06 +00:00
var md = require('markdown-it')();
Update to support new metadata: title, description, tags and google-analytics (GA) and refactor render publish slide response function
2016-06-21 13:42:03 +00:00
var metaMarked = require('meta-marked');
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
var cheerio = require('cheerio');
var shortId = require('shortid');
var Sequelize = require("sequelize");
var async = require('async');
Update note model if doc in filesystem have newer modified will update it in db
2016-05-30 04:43:51 +00:00
var moment = require('moment');
Update to move authorship calculation code to note model and support update authorship after making revision of docs
2016-10-10 12:23:33 +00:00
var DiffMatchPatch = require('diff-match-patch');
var dmp = new DiffMatchPatch();
Workaround cheerio text method shouldn't preserve html tags on fetching note title
2016-10-10 12:38:14 +00:00
var S = require('string');
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
// core
var config = require("../config.js");
var logger = require("../logger.js");
Update to move authorship calculation code to note model and support update authorship after making revision of docs
2016-10-10 12:23:33 +00:00
//ot
var ot = require("../ot/index.js");
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
// permission types
var permissionTypes = ["freely", "editable", "locked", "private"];
module.exports = function (sequelize, DataTypes) {
var Note = sequelize.define("Note", {
id: {
type: DataTypes.UUID,
primaryKey: true,
defaultValue: Sequelize.UUIDV4
},
shortid: {
type: DataTypes.STRING,
unique: true,
allowNull: false,
defaultValue: shortId.generate
},
alias: {
type: DataTypes.STRING,
unique: true
},
permission: {
type: DataTypes.ENUM,
values: permissionTypes
},
viewcount: {
type: DataTypes.INTEGER,
allowNull: false,
defaultValue: 0
},
title: {
type: DataTypes.TEXT
},
content: {
type: DataTypes.TEXT
},
Add support of saving authors and authorship
2016-07-30 03:21:38 +00:00
authorship: {
type: DataTypes.TEXT
},
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
lastchangeAt: {
type: DataTypes.DATE
Add support of saving note revision and improve app start and stop procedure to ensure data integrity
2016-06-17 08:09:33 +00:00
},
savedAt: {
type: DataTypes.DATE
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
}
}, {
Update to support delete note
2016-10-10 13:04:24 +00:00
paranoid: true,
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
classMethods: {
associate: function (models) {
Note.belongsTo(models.User, {
foreignKey: "ownerId",
as: "owner",
constraints: false
});
Note.belongsTo(models.User, {
foreignKey: "lastchangeuserId",
as: "lastchangeuser",
constraints: false
});
Add support of saving note revision and improve app start and stop procedure to ensure data integrity
2016-06-17 08:09:33 +00:00
Note.hasMany(models.Revision, {
foreignKey: "noteId",
constraints: false
});
Add support of saving authors and authorship
2016-07-30 03:21:38 +00:00
Note.hasMany(models.Author, {
foreignKey: "noteId",
as: "authors",
constraints: false
});
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
},
checkFileExist: function (filePath) {
try {
return fs.statSync(filePath).isFile();
} catch (err) {
return false;
}
},
checkNoteIdValid: function (id) {
var uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
var result = id.match(uuidRegex);
if (result && result.length == 1)
return true;
else
return false;
},
parseNoteId: function (noteId, callback) {
async.series({
parseNoteIdByAlias: function (_callback) {
// try to parse note id by alias (e.g. doc)
Note.findOne({
where: {
alias: noteId
}
}).then(function (note) {
if (note) {
Update note model if doc in filesystem have newer modified will update it in db
2016-05-30 04:43:51 +00:00
var filePath = path.join(config.docspath, noteId + '.md');
if (Note.checkFileExist(filePath)) {
// if doc in filesystem have newer modified time than last change time
// then will update the doc in db
var fsModifiedTime = moment(fs.statSync(filePath).mtime);
var dbModifiedTime = moment(note.lastchangeAt || note.createdAt);
Update to make doc only update while the filesystem content not equals db content
2016-08-14 03:22:54 +00:00
var body = fs.readFileSync(filePath, 'utf8');
Update to move authorship calculation code to note model and support update authorship after making revision of docs
2016-10-10 12:23:33 +00:00
var contentLength = body.length;
Update to make doc only update while the filesystem content not equals db content
2016-08-14 03:22:54 +00:00
var title = Note.parseNoteTitle(body);
body = LZString.compressToBase64(body);
title = LZString.compressToBase64(title);
if (fsModifiedTime.isAfter(dbModifiedTime) && note.content !== body) {
Add support of saving note revision and improve app start and stop procedure to ensure data integrity
2016-06-17 08:09:33 +00:00
note.update({
Update to make doc only update while the filesystem content not equals db content
2016-08-14 03:22:54 +00:00
title: title,
content: body,
Add support of saving note revision and improve app start and stop procedure to ensure data integrity
2016-06-17 08:09:33 +00:00
lastchangeAt: fsModifiedTime
}).then(function (note) {
sequelize.models.Revision.saveNoteRevision(note, function (err, revision) {
if (err) return _callback(err, null);
Update to move authorship calculation code to note model and support update authorship after making revision of docs
2016-10-10 12:23:33 +00:00
// update authorship on after making revision of docs
var patch = dmp.patch_fromText(LZString.decompressFromBase64(revision.patch));
var operations = Note.transformPatchToOperations(patch, contentLength);
var authorship = note.authorship ? JSON.parse(LZString.decompressFromBase64(note.authorship)) : [];
for (var i = 0; i < operations.length; i++) {
authorship = Note.updateAuthorshipByOperation(operations[i], null, authorship);
}
note.update({
Fix doc updating revision not stringify and compress authorship before save
2016-10-10 16:55:38 +00:00
authorship: LZString.compressToBase64(JSON.stringify(authorship))
Update to move authorship calculation code to note model and support update authorship after making revision of docs
2016-10-10 12:23:33 +00:00
}).then(function (note) {
return callback(null, note.id);
}).catch(function (err) {
return _callback(err, null);
});
Add support of saving note revision and improve app start and stop procedure to ensure data integrity
2016-06-17 08:09:33 +00:00
});
Update note model if doc in filesystem have newer modified will update it in db
2016-05-30 04:43:51 +00:00
}).catch(function (err) {
return _callback(err, null);
});
} else {
return callback(null, note.id);
}
} else {
return callback(null, note.id);
}
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
} else {
var filePath = path.join(config.docspath, noteId + '.md');
if (Note.checkFileExist(filePath)) {
Note.create({
alias: noteId,
owner: null,
permission: 'locked'
}).then(function (note) {
return callback(null, note.id);
}).catch(function (err) {
return _callback(err, null);
});
} else {
return _callback(null, null);
}
}
}).catch(function (err) {
return _callback(err, null);
});
},
parseNoteIdByLZString: function (_callback) {
// try to parse note id by LZString Base64
try {
var id = LZString.decompressFromBase64(noteId);
if (id && Note.checkNoteIdValid(id))
return callback(null, id);
else
return _callback(null, null);
} catch (err) {
return _callback(err, null);
}
},
parseNoteIdByShortId: function (_callback) {
// try to parse note id by shortId
try {
if (shortId.isValid(noteId)) {
Note.findOne({
where: {
shortid: noteId
}
}).then(function (note) {
if (!note) return _callback(null, null);
return callback(null, note.id);
}).catch(function (err) {
return _callback(err, null);
});
} else {
return _callback(null, null);
}
} catch (err) {
return _callback(err, null);
}
}
}, function (err, result) {
if (err) {
logger.error(err);
return callback(err, null);
}
return callback(null, null);
});
},
Update to make note history count in server-side when user logged
2016-10-10 12:55:33 +00:00
parseNoteInfo: function (body) {
var meta = null;
try {
var obj = metaMarked(body);
body = obj.markdown;
meta = obj.meta;
} catch (err) {
//na
}
if (!meta) meta = {};
var $ = cheerio.load(md.render(body));
return {
title: Note.extractNoteTitle(meta, $),
tags: Note.extractNoteTags(meta, $)
};
},
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
parseNoteTitle: function (body) {
Update to support new metadata: title, description, tags and google-analytics (GA) and refactor render publish slide response function
2016-06-21 13:42:03 +00:00
var meta = null;
try {
var obj = metaMarked(body);
body = obj.markdown;
meta = obj.meta;
} catch (err) {
//na
}
Fix meta might be null issue
2016-08-15 02:59:40 +00:00
if (!meta) meta = {};
Update to make note history count in server-side when user logged
2016-10-10 12:55:33 +00:00
var $ = cheerio.load(md.render(body));
return Note.extractNoteTitle(meta, $);
},
extractNoteTitle: function (meta, $) {
var title = "";
Fix meta might be null issue
2016-08-15 02:59:40 +00:00
if (meta.title && (typeof meta.title == "string" || typeof meta.title == "number")) {
Update to support new metadata: title, description, tags and google-analytics (GA) and refactor render publish slide response function
2016-06-21 13:42:03 +00:00
title = meta.title;
} else {
var h1s = $("h1");
if (h1s.length > 0 && h1s.first().text().split('\n').length == 1)
Workaround cheerio text method shouldn't preserve html tags on fetching note title
2016-10-10 12:38:14 +00:00
title = S(h1s.first().text()).stripTags().s;
Update to support new metadata: title, description, tags and google-analytics (GA) and refactor render publish slide response function
2016-06-21 13:42:03 +00:00
}
if (!title) title = "Untitled";
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
return title;
},
decodeTitle: function (title) {
var decodedTitle = LZString.decompressFromBase64(title);
if (decodedTitle) title = decodedTitle;
else title = 'Untitled';
return title;
},
generateWebTitle: function (title) {
Update project title
2016-05-27 17:51:45 +00:00
title = !title || title == "Untitled" ? "HackMD - Collaborative markdown notes" : title + " - HackMD";
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
return title;
Update to support new metadata: title, description, tags and google-analytics (GA) and refactor render publish slide response function
2016-06-21 13:42:03 +00:00
},
Update to make note history count in server-side when user logged
2016-10-10 12:55:33 +00:00
extractNoteTags: function (meta, $) {
var tags = [];
var rawtags = [];
if (meta.tags && (typeof meta.tags == "string" || typeof meta.tags == "number")) {
var metaTags = ('' + meta.tags).split(',');
for (var i = 0; i < metaTags.length; i++) {
var text = metaTags[i].trim();
if (text) rawtags.push(text);
}
} else {
var h6s = $("h6");
h6s.each(function (key, value) {
if (/^tags/gmi.test($(value).text())) {
var codes = $(value).find("code");
for (var i = 0; i < codes.length; i++) {
var text = $(codes[i]).html().trim();
if (text) rawtags.push(text);
}
}
});
}
for (var i = 0; i < rawtags.length; i++) {
var found = false;
for (var j = 0; j < tags.length; j++) {
if (tags[j] == rawtags[i]) {
found = true;
break;
}
}
if (!found)
tags.push(rawtags[i]);
}
return tags;
},
Update to support new metadata: title, description, tags and google-analytics (GA) and refactor render publish slide response function
2016-06-21 13:42:03 +00:00
parseMeta: function (meta) {
var _meta = {};
if (meta) {
if (meta.title && (typeof meta.title == "string" || typeof meta.title == "number"))
_meta.title = meta.title;
if (meta.description && (typeof meta.description == "string" || typeof meta.description == "number"))
_meta.description = meta.description;
if (meta.robots && (typeof meta.robots == "string" || typeof meta.robots == "number"))
_meta.robots = meta.robots;
if (meta.GA && (typeof meta.GA == "string" || typeof meta.GA == "number"))
_meta.GA = meta.GA;
Update slide mode to show extra info and support url actions and support disqus via yaml-metadata
2016-08-15 03:25:27 +00:00
if (meta.disqus && (typeof meta.disqus == "string" || typeof meta.disqus == "number"))
_meta.disqus = meta.disqus;
Update to support slideOptions in the YAML metadata
2016-07-31 16:08:22 +00:00
if (meta.slideOptions && (typeof meta.slideOptions == "object"))
_meta.slideOptions = meta.slideOptions;
Update to support new metadata: title, description, tags and google-analytics (GA) and refactor render publish slide response function
2016-06-21 13:42:03 +00:00
}
return _meta;
Update to move authorship calculation code to note model and support update authorship after making revision of docs
2016-10-10 12:23:33 +00:00
},
updateAuthorshipByOperation: function (operation, userId, authorships) {
var index = 0;
var timestamp = Date.now();
for (var i = 0; i < operation.length; i++) {
var op = operation[i];
if (ot.TextOperation.isRetain(op)) {
index += op;
} else if (ot.TextOperation.isInsert(op)) {
var opStart = index;
var opEnd = index + op.length;
var inserted = false;
// authorship format: [userId, startPos, endPos, createdAt, updatedAt]
if (authorships.length <= 0) authorships.push([userId, opStart, opEnd, timestamp, timestamp]);
else {
for (var j = 0; j < authorships.length; j++) {
var authorship = authorships[j];
if (!inserted) {
var nextAuthorship = authorships[j + 1] || -1;
if (nextAuthorship != -1 && nextAuthorship[1] >= opEnd || j >= authorships.length - 1) {
if (authorship[1] < opStart && authorship[2] > opStart) {
// divide
var postLength = authorship[2] - opStart;
authorship[2] = opStart;
authorship[4] = timestamp;
authorships.splice(j + 1, 0, [userId, opStart, opEnd, timestamp, timestamp]);
authorships.splice(j + 2, 0, [authorship[0], opEnd, opEnd + postLength, authorship[3], timestamp]);
j += 2;
inserted = true;
} else if (authorship[1] >= opStart) {
authorships.splice(j, 0, [userId, opStart, opEnd, timestamp, timestamp]);
j += 1;
inserted = true;
} else if (authorship[2] <= opStart) {
authorships.splice(j + 1, 0, [userId, opStart, opEnd, timestamp, timestamp]);
j += 1;
inserted = true;
}
}
}
if (authorship[1] >= opStart) {
authorship[1] += op.length;
authorship[2] += op.length;
}
}
}
index += op.length;
} else if (ot.TextOperation.isDelete(op)) {
var opStart = index;
var opEnd = index - op;
if (operation.length == 1) {
authorships = [];
} else if (authorships.length > 0) {
for (var j = 0; j < authorships.length; j++) {
var authorship = authorships[j];
if (authorship[1] >= opStart && authorship[1] <= opEnd && authorship[2] >= opStart && authorship[2] <= opEnd) {
authorships.splice(j, 1);
j -= 1;
} else if (authorship[1] < opStart && authorship[1] < opEnd && authorship[2] > opStart && authorship[2] > opEnd) {
authorship[2] += op;
authorship[4] = timestamp;
} else if (authorship[2] >= opStart && authorship[2] <= opEnd) {
authorship[2] = opStart;
authorship[4] = timestamp;
} else if (authorship[1] >= opStart && authorship[1] <= opEnd) {
authorship[1] = opEnd;
authorship[4] = timestamp;
}
if (authorship[1] >= opEnd) {
authorship[1] += op;
authorship[2] += op;
}
}
}
index += op;
}
}
// merge
for (var j = 0; j < authorships.length; j++) {
var authorship = authorships[j];
for (var k = j + 1; k < authorships.length; k++) {
var nextAuthorship = authorships[k];
if (nextAuthorship && authorship[0] === nextAuthorship[0] && authorship[2] === nextAuthorship[1]) {
var minTimestamp = Math.min(authorship[3], nextAuthorship[3]);
var maxTimestamp = Math.max(authorship[3], nextAuthorship[3]);
authorships.splice(j, 1, [authorship[0], authorship[1], nextAuthorship[2], minTimestamp, maxTimestamp]);
authorships.splice(k, 1);
j -= 1;
break;
}
}
}
// clear
for (var j = 0; j < authorships.length; j++) {
var authorship = authorships[j];
if (!authorship[0]) {
authorships.splice(j, 1);
j -= 1;
}
}
return authorships;
},
transformPatchToOperations: function (patch, contentLength) {
var operations = [];
if (patch.length > 0) {
// calculate original content length
for (var j = patch.length - 1; j >= 0; j--) {
var p = patch[j];
for (var i = 0; i < p.diffs.length; i++) {
var diff = p.diffs[i];
switch(diff[0]) {
case 1: // insert
contentLength -= diff[1].length;
break;
case -1: // delete
contentLength += diff[1].length;
break;
}
}
}
// generate operations
var bias = 0;
var lengthBias = 0;
for (var j = 0; j < patch.length; j++) {
var operation = [];
var p = patch[j];
var currIndex = p.start1;
var currLength = contentLength - bias;
for (var i = 0; i < p.diffs.length; i++) {
var diff = p.diffs[i];
switch(diff[0]) {
case 0: // retain
if (i == 0) // first
operation.push(currIndex + diff[1].length);
else if (i != p.diffs.length - 1) // mid
operation.push(diff[1].length);
else // last
operation.push(currLength + lengthBias - currIndex);
currIndex += diff[1].length;
break;
case 1: // insert
operation.push(diff[1]);
lengthBias += diff[1].length;
currIndex += diff[1].length;
break;
case -1: // delete
operation.push(-diff[1].length);
bias += diff[1].length;
currIndex += diff[1].length;
break;
}
}
operations.push(operation);
}
}
return operations;
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
}
},
hooks: {
beforeCreate: function (note, options, callback) {
// if no content specified then use default note
if (!note.content) {
var body = null;
var filePath = null;
if (!note.alias) {
filePath = config.defaultnotepath;
} else {
filePath = path.join(config.docspath, note.alias + '.md');
}
if (Note.checkFileExist(filePath)) {
Update note model on create doc will use the created time of the doc in filesystem
2016-06-01 15:19:47 +00:00
var fsCreatedTime = moment(fs.statSync(filePath).ctime);
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
body = fs.readFileSync(filePath, 'utf8');
note.title = LZString.compressToBase64(Note.parseNoteTitle(body));
note.content = LZString.compressToBase64(body);
Fix create new note should not use default note created time
2016-06-17 08:28:04 +00:00
if (filePath !== config.defaultnotepath) {
note.createdAt = fsCreatedTime;
}
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
}
}
// if no permission specified and have owner then give editable permission, else default permission is freely
if (!note.permission) {
if (note.ownerId) {
note.permission = "editable";
} else {
note.permission = "freely";
}
}
return callback(null, note);
Add support of saving note revision and improve app start and stop procedure to ensure data integrity
2016-06-17 08:09:33 +00:00
},
afterCreate: function (note, options, callback) {
sequelize.models.Revision.saveNoteRevision(note, function (err, revision) {
callback(err, note);
});
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
}
}
});
return Note;
};
Reference in a new issue Copy permalink