mirror of
https://github.com/BookStackApp/BookStack.git
synced 2025-06-05 18:04:33 +08:00
Made some changes to the comment system
Changed to be rendered server side along with page content. Changed deletion to fully delete comments from the database. Added 'local_id' to comments for referencing. Updated reply system to be non-nested (Incomplete) Made database comment format entity-agnostic to be more future proof. Updated designs of comment sections.
This commit is contained in:
Dan Brown
@ -1,113 +0,0 @@
|
||||
const MarkdownIt = require("markdown-it");
|
||||
const md = new MarkdownIt({ html: true });
|
||||
|
||||
var template = `
|
||||
<div class="comment-editor" v-cloak>
|
||||
<form novalidate>
|
||||
<textarea name="markdown" rows="3" v-model="comment.text" :placeholder="trans('entities.comment_placeholder')"></textarea>
|
||||
<input type="hidden" v-model="comment.pageId" name="comment.pageId" :value="pageId">
|
||||
<button type="button" v-if="isReply || isEdit" class="button muted" v-on:click="closeBox">{{ trans('entities.comment_cancel') }}</button>
|
||||
<button type="submit" class="button pos" v-on:click.prevent="saveComment">{{ trans('entities.comment_save') }}</button>
|
||||
</form>
|
||||
</div>
|
||||
`;
|
||||
|
||||
const props = {
|
||||
pageId: {},
|
||||
commentObj: {},
|
||||
isReply: {
|
||||
default: false,
|
||||
type: Boolean
|
||||
}, isEdit: {
|
||||
default: false,
|
||||
type: Boolean
|
||||
}
|
||||
};
|
||||
|
||||
function data() {
|
||||
let comment = {
|
||||
text: ''
|
||||
};
|
||||
|
||||
if (this.isReply) {
|
||||
comment.page_id = this.commentObj.page_id;
|
||||
comment.id = this.commentObj.id;
|
||||
} else if (this.isEdit) {
|
||||
comment = this.commentObj;
|
||||
}
|
||||
|
||||
return {
|
||||
comment: comment,
|
||||
trans: trans
|
||||
};
|
||||
}
|
||||
|
||||
const methods = {
|
||||
saveComment: function (event) {
|
||||
let pageId = this.comment.page_id || this.pageId;
|
||||
let commentText = this.comment.text;
|
||||
if (!commentText) {
|
||||
return this.$events.emit('error', trans('errors.empty_comment'))
|
||||
}
|
||||
let commentHTML = md.render(commentText);
|
||||
let serviceUrl = `/ajax/page/${pageId}/comment/`;
|
||||
let httpMethod = 'post';
|
||||
let reqObj = {
|
||||
text: commentText,
|
||||
html: commentHTML
|
||||
};
|
||||
|
||||
if (this.isEdit === true) {
|
||||
// this will be set when editing the comment.
|
||||
serviceUrl = `/ajax/page/${pageId}/comment/${this.comment.id}`;
|
||||
httpMethod = 'put';
|
||||
} else if (this.isReply === true) {
|
||||
// if its reply, get the parent comment id
|
||||
reqObj.parent_id = this.comment.id;
|
||||
}
|
||||
$http[httpMethod](window.baseUrl(serviceUrl), reqObj).then(resp => {
|
||||
if (!isCommentOpSuccess(resp)) {
|
||||
this.$events.emit('error', getErrorMsg(resp));
|
||||
return;
|
||||
}
|
||||
// hide the comments first, and then retrigger the refresh
|
||||
if (this.isEdit) {
|
||||
this.$emit('comment-edited', event, resp.data.comment);
|
||||
} else {
|
||||
this.comment.text = '';
|
||||
this.$emit('comment-added', event);
|
||||
if (this.isReply === true) {
|
||||
this.$emit('comment-replied', event, resp.data.comment);
|
||||
} else {
|
||||
this.$parent.$emit('new-comment', event, resp.data.comment);
|
||||
}
|
||||
}
|
||||
this.$events.emit('success', resp.data.message);
|
||||
}).catch(err => {
|
||||
this.$events.emit('error', trans('errors.comment_add'))
|
||||
});
|
||||
},
|
||||
closeBox: function (event) {
|
||||
this.$emit('editor-removed', event);
|
||||
}
|
||||
};
|
||||
|
||||
const computed = {};
|
||||
|
||||
function isCommentOpSuccess(resp) {
|
||||
if (resp && resp.data && resp.data.status === 'success') {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
function getErrorMsg(response) {
|
||||
if (response.data) {
|
||||
return response.data.message;
|
||||
} else {
|
||||
return trans('errors.comment_add');
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { name: 'comment-reply', template, data, props, methods, computed };
|
||||
|
||||
@ -1,174 +0,0 @@
|
||||
const commentReply = require('./comment-reply');
|
||||
|
||||
const template = `
|
||||
<div class="comment-box">
|
||||
<div class='page-comment' :id="commentId">
|
||||
<div class="user-image">
|
||||
<img :src="comment.created_by.avatar_url" alt="user avatar">
|
||||
</div>
|
||||
<div class="comment-container">
|
||||
<div class="comment-header">
|
||||
<a :href="comment.created_by.profile_url">{{comment.created_by.name}}</a>
|
||||
</div>
|
||||
<div v-html="comment.html" v-if="comment.active" class="comment-body" v-bind:class="{ 'comment-inactive' : !comment.active }">
|
||||
|
||||
</div>
|
||||
<div v-if="!comment.active" class="comment-body comment-inactive">
|
||||
{{ trans('entities.comment_deleted') }}
|
||||
</div>
|
||||
<div class="comment-actions">
|
||||
<ul>
|
||||
<li v-if="(level < 4 && canComment)">
|
||||
<a href="#" comment="comment" v-on:click.prevent="replyComment">{{ trans('entities.comment_reply') }}</a>
|
||||
</li>
|
||||
<li v-if="canEditOrDelete('update')">
|
||||
<a href="#" comment="comment" v-on:click.prevent="editComment">{{ trans('entities.comment_edit') }}</a>
|
||||
</li>
|
||||
<li v-if="canEditOrDelete('delete')">
|
||||
<a href="#" comment="comment" v-on:click.prevent="deleteComment">{{ trans('entities.comment_delete') }}</a>
|
||||
</li>
|
||||
<li>{{ trans('entities.comment_create') }}
|
||||
<a :title="comment.created.day_time_str" :href="commentHref">{{comment.created.diff}}</a>
|
||||
</li>
|
||||
<li v-if="comment.updated">
|
||||
<span :title="comment.updated.day_time_str">{{trans('entities.comment_updated_text', { updateDiff: comment.updated.diff }) }}
|
||||
<a :href="comment.updated_by.profile_url">{{comment.updated_by.name}}</a>
|
||||
</span>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div v-if="showEditor">
|
||||
<comment-reply :page-id="comment.page_id" :comment-obj="comment"
|
||||
v-on:editor-removed.stop.prevent="hideComment"
|
||||
v-on:comment-replied.stop="commentReplied(...arguments)"
|
||||
v-on:comment-edited.stop="commentEdited(...arguments)"
|
||||
v-on:comment-added.stop="commentAdded"
|
||||
:is-reply="isReply" :is-edit="isEdit">
|
||||
</comment-reply>
|
||||
</div>
|
||||
<comment v-for="(comment, index) in comments" :initial-comment="comment" :index="index"
|
||||
:level="nextLevel" :key="comment.id" :permissions="permissions" :current-user-id="currentUserId"
|
||||
v-on:comment-added.stop="commentAdded"></comment>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
`;
|
||||
|
||||
const props = ['initialComment', 'index', 'level', 'permissions', 'currentUserId'];
|
||||
|
||||
function data() {
|
||||
return {
|
||||
trans: trans,
|
||||
comments: [],
|
||||
showEditor: false,
|
||||
comment: this.initialComment,
|
||||
nextLevel: this.level + 1
|
||||
};
|
||||
}
|
||||
|
||||
const methods = {
|
||||
deleteComment: function () {
|
||||
var resp = window.confirm(trans('entities.comment_delete_confirm'));
|
||||
if (!resp) {
|
||||
return;
|
||||
}
|
||||
this.$http.delete(window.baseUrl(`/ajax/comment/${this.comment.id}`)).then(resp => {
|
||||
if (!isCommentOpSuccess(resp)) {
|
||||
this.$events.emit('error', trans('error.comment_delete'));
|
||||
return;
|
||||
}
|
||||
this.$events.emit('success', trans('entities.comment_deleted'));
|
||||
this.comment = resp.data.comment;
|
||||
}).catch(err => {
|
||||
this.$events.emit('error', trans('error.comment_delete'));
|
||||
});
|
||||
},
|
||||
replyComment: function () {
|
||||
this.toggleEditor(false);
|
||||
},
|
||||
editComment: function () {
|
||||
this.toggleEditor(true);
|
||||
},
|
||||
hideComment: function () {
|
||||
this.showEditor = false;
|
||||
},
|
||||
toggleEditor: function (isEdit) {
|
||||
this.showEditor = false;
|
||||
this.isEdit = isEdit;
|
||||
this.isReply = !isEdit;
|
||||
this.showEditor = true;
|
||||
},
|
||||
commentReplied: function (event, comment) {
|
||||
this.comments.push(comment);
|
||||
this.showEditor = false;
|
||||
},
|
||||
commentEdited: function (event, comment) {
|
||||
this.comment = comment;
|
||||
this.showEditor = false;
|
||||
},
|
||||
commentAdded: function (event, comment) {
|
||||
// this is to handle non-parent child relationship
|
||||
// we want to make it go up.
|
||||
this.$emit('comment-added', event);
|
||||
},
|
||||
canEditOrDelete: function (prop) {
|
||||
if (!this.comment.active) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!this.permissions) {
|
||||
return false;
|
||||
}
|
||||
|
||||
let propAll = 'comment_' + prop + '_all';
|
||||
let propOwn = 'comment_' + prop + '_own';
|
||||
|
||||
if (this.permissions[propAll]) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (this.permissions[propOwn] && this.comment.created_by.id === this.currentUserId) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
},
|
||||
canComment: function () {
|
||||
if (!this.permissions) {
|
||||
return false;
|
||||
}
|
||||
return this.permissions.comment_create === true;
|
||||
}
|
||||
};
|
||||
|
||||
const computed = {
|
||||
commentId: function () {
|
||||
return `comment-${this.comment.page_id}-${this.comment.id}`;
|
||||
},
|
||||
commentHref: function () {
|
||||
return `#?cm=${this.commentId}`;
|
||||
}
|
||||
};
|
||||
|
||||
function mounted() {
|
||||
if (this.comment.sub_comments && this.comment.sub_comments.length) {
|
||||
// set this so that we can render the next set of sub comments.
|
||||
this.comments = this.comment.sub_comments;
|
||||
}
|
||||
}
|
||||
|
||||
function isCommentOpSuccess(resp) {
|
||||
if (resp && resp.data && resp.data.status === 'success') {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
name: 'comment',
|
||||
template, data, props, methods, computed, mounted, components: {
|
||||
commentReply
|
||||
}
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user