artalk 2.2.8 → 2.2.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artalk",
-  "version": "2.2.8",
+  "version": "2.2.11",
   "backendMinVersion": "2.1.4",
   "license": "LGPL-3.0",
   "description": "A Selfhosted Comment System",

package/src/artalk.ts

@@ -47,6 +47,11 @@ export default class Artalk {
       this.conf.pageTitle = `${document.title}`
     }
 
+    // 列表显示模式
+    if (this.conf.nestMax && this.conf.nestMax <= 1) {
+      this.conf.flatMode = true
+    }
+
     // 装载元素
     if (!!this.conf.el && this.conf.el instanceof HTMLElement) {
       this.$root = this.conf.el
@@ -133,6 +138,7 @@ export default class Artalk {
   private initEventBind() {
     // 锚点快速跳转评论
     window.addEventListener('hashchange', () => {
+      this.list.goToCommentDelay = false
       this.list.checkGoToCommentByUrlHash()
     })
 

package/src/components/comment.ts

@@ -15,6 +15,8 @@ export default class Comment extends Component {
 
   public $main!: HTMLElement
   public $header!: HTMLElement
+  public $headerNick!: HTMLElement
+  public $headerBadge?: HTMLElement
   public $body!: HTMLElement
   public $content!: HTMLElement
   public $children!: HTMLElement|null
@@ -23,12 +25,15 @@ export default class Comment extends Component {
   public voteBtnDown?: ActionBtn
 
   public parent: Comment|null
-  public nestedNum: number
-  private maxNestingNum: number // 最多嵌套层数
-  public children: Comment[] = []
+  public nestCurt: number
+  private nestMax: number // 最大嵌套层数
+  private children: Comment[] = []
 
-  public replyTo?: CommentData // 回复对象（flatMode 用）
-  public $replyTo?: HTMLElement
+  public flatMode: boolean = false
+  public replyTo?: CommentData // 回复对象
+
+  public $replyTo?: HTMLElement // 回复评论内容 (平铺下显示)
+  public $replyAt?: HTMLElement // 回复 AT（层级嵌套下显示）
 
   public afterRender?: () => void
 
@@ -43,13 +48,13 @@ export default class Comment extends Component {
     super(ctx)
 
     // 最大嵌套数
-    this.maxNestingNum = ctx.conf.maxNesting || 3
+    this.nestMax = ctx.conf.nestMax || 3
 
     this.data = { ...data }
     this.data.date = this.data.date.replace(/-/g, '/') // 解决 Safari 日期解析 NaN 问题
 
     this.parent = null
-    this.nestedNum = 1 // 现在已嵌套 n 层
+    this.nestCurt = 1 // 现在已嵌套 n 层
   }
 
   /** 渲染 UI */
@@ -70,6 +75,7 @@ export default class Comment extends Component {
     this.renderAvatar()
     this.renderHeader()
     this.renderContent()
+    this.renderReplyAt()
     this.renderReplyTo()
     this.renderPending()
     this.renderActionBtn()
@@ -117,28 +123,29 @@ export default class Comment extends Component {
   }
 
   private renderHeader() {
-    const $nick = this.$el.querySelector<HTMLElement>('.atk-nick')!
+    this.$headerNick = this.$el.querySelector<HTMLElement>('.atk-nick')!
     if (this.data.link) {
       const $nickA = Utils.createElement<HTMLLinkElement>('<a target="_blank" rel="noreferrer noopener nofollow"></a>')
       $nickA.innerText = this.data.nick
       $nickA.href = this.data.link
-      $nick.append($nickA)
+      this.$headerNick.append($nickA)
     } else {
-      $nick.innerText = this.data.nick
+      this.$headerNick.innerText = this.data.nick
     }
 
-    const $badge = this.$el.querySelector<HTMLElement>('.atk-badge')!
+    this.$headerBadge = this.$el.querySelector<HTMLElement>('.atk-badge')!
     if (this.data.badge_name) {
-      $badge.innerText = this.data.badge_name
+      this.$headerBadge.innerText = this.data.badge_name
       if (this.data.badge_color)
-        $badge.style.backgroundColor = this.data.badge_color
+      this.$headerBadge.style.backgroundColor = this.data.badge_color
     } else {
-      $badge.remove()
+      this.$headerBadge.remove()
+      this.$headerBadge = undefined
     }
 
     if (this.data.is_pinned) {
       const $pinnedBadge = Utils.createElement(`<span class="atk-item atk-pinned-badge">置顶</span>`) // 置顶徽章
-      $nick.insertAdjacentElement('afterend', $pinnedBadge)
+      this.$headerNick.insertAdjacentElement('afterend', $pinnedBadge)
     }
 
     const $date = this.$el.querySelector<HTMLElement>('.atk-date')!
@@ -189,8 +196,23 @@ export default class Comment extends Component {
     })
   }
 
+  // 层级嵌套模式显示 At
+  private renderReplyAt() {
+    if (this.flatMode || this.data.rid === 0) return // not 平铺模式 或 根评论
+    if (this.$replyAt) return // not 关闭显示 或 已经显示
+    if (!this.replyTo) return
+
+    this.$replyAt = Utils.createElement(`<span class="atk-item atk-reply-at"><span class="atk-arrow"></span><span class="atk-nick"></span></span>`)
+    this.$replyAt.querySelector<HTMLElement>('.atk-nick')!.innerText = `${this.replyTo.nick}`
+    this.$replyAt.onclick = () => { this.goToReplyComment() }
+
+    const $after = this.$headerBadge || this.$headerNick
+    $after.insertAdjacentElement('afterend', this.$replyAt)
+  }
+
   // 回复的对象
   private renderReplyTo() {
+    if (!this.flatMode) return // 仅平铺模式显示
     if (!this.replyTo) return
 
     this.$replyTo = Utils.createElement(`
@@ -198,13 +220,23 @@ export default class Comment extends Component {
         <div class="atk-meta">回复 <span class="atk-nick"></span>:</div>
         <div class="atk-content"></div>
       </div>`)
-    this.$replyTo.querySelector<HTMLElement>('.atk-nick')!.innerText = `@${this.replyTo.nick}`
+    const $nick = this.$replyTo.querySelector<HTMLElement>('.atk-nick')!
+    $nick.innerText = `@${this.replyTo.nick}`
+    $nick.onclick = () => { this.goToReplyComment() }
     let replyContent = Utils.marked(this.ctx, this.replyTo.content)
     if (this.replyTo.is_collapsed) replyContent = '[已折叠]'
     this.$replyTo.querySelector<HTMLElement>('.atk-content')!.innerHTML = replyContent
     this.$body.prepend(this.$replyTo)
   }
 
+  public goToReplyComment() {
+    const origHash = window.location.hash
+    const modifyHash = `#atk-comment-${this.data.rid}`
+
+    window.location.hash = modifyHash
+    if (modifyHash === origHash) window.dispatchEvent(new Event('hashchange')) // 强制触发事件
+  }
+
   // 待审核状态
   private renderPending() {
     if (!this.data.is_pending) return
@@ -324,30 +356,33 @@ export default class Comment extends Component {
     return this.children
   }
 
-  putChild(childC: Comment) {
+  putChild(childC: Comment, insertMode: 'append'|'prepend' = 'append') {
     childC.parent = this
-    childC.nestedNum = this.nestedNum + 1 // 嵌套层数 +1
+    childC.nestCurt = this.nestCurt + 1 // 嵌套层数 +1
     this.children.push(childC)
 
-    this.getChildrenEl().appendChild(childC.getEl())
+    const $children = this.getChildrenEl()
+    if (insertMode === 'append') $children.append(childC.getEl())
+    else if (insertMode === 'prepend') $children.prepend(childC.getEl())
+
     childC.playFadeInAnim()
 
     // 内容限高
     childC.checkHeightLimitArea('content')
   }
 
-  getChildrenEl() {
-    if (this.$children === null) {
-      // console.log(this.nestedNum)
-      if (this.nestedNum < this.maxNestingNum) {
+  getChildrenEl(): HTMLElement {
+    if (!this.$children) {
+      // console.log(this.nestCurt)
+      if (this.nestCurt < this.nestMax) {
         this.$children = Utils.createElement('<div class="atk-comment-children"></div>')
-        this.$main.appendChild(this.$children)
+        this.$main.append(this.$children)
       } else if (this.parent) {
           this.$children = this.parent.getChildrenEl()
       }
     }
 
-    return this.$children
+    return this.$children!
   }
 
   getParent() {

package/src/components/editor.ts

@@ -85,9 +85,22 @@ export default class Editor extends Component {
       if (inputEl && inputEl instanceof HTMLInputElement) {
         inputEl.value = this.user.data[field] || ''
         // 绑定事件
-        inputEl.addEventListener('input', () => this.onHeaderInputChanged(field, inputEl))
+        inputEl.addEventListener('input', () => this.onHeaderInput(field, inputEl))
       }
     })
+
+    // Link URL 自动补全协议
+    const $linkInput = this.getInputEl('link')
+    if ($linkInput) {
+      $linkInput.addEventListener('change', () => {
+        const link = $linkInput.value.trim()
+        if (!!link && !/^(http|https):\/\//.test(link)) {
+          $linkInput.value = `https://${link}`
+          this.user.data.link = $linkInput.value
+          this.saveUser()
+        }
+      })
+    }
   }
 
   getInputEl (field: string) {
@@ -101,7 +114,7 @@ export default class Editor extends Component {
   }
 
   /** header 输入框内容变化事件 */
-  onHeaderInputChanged (field: string, inputEl: HTMLInputElement) {
+  onHeaderInput(field: string, inputEl: HTMLInputElement) {
     this.user.data[field] = inputEl.value.trim()
 
     // 若修改的是 nick or email

package/src/components/list-lite.ts

@@ -7,11 +7,14 @@ import Api from '../api'
 import Comment from './comment'
 import Pagination from './pagination'
 import ReadMoreBtn from './read-more-btn'
+import * as ListNest from './list-nest'
 import { backendMinVersion } from '../../package.json'
 
 export default class ListLite extends Component {
   protected $commentsWrap: HTMLElement
-  protected comments: Comment[] = []
+
+  protected commentList: Comment[] = [] // Note: 无层级结构 + 无须排列
+  protected get commentDataList() { return this.commentList.map(c => c.data) }
 
   protected data?: ListData
   protected isLoading: boolean = false
@@ -21,6 +24,9 @@ export default class ListLite extends Component {
   /** 平铺模式 */
   public flatMode = false
 
+  /** 嵌套模式 */
+  public nestSortBy!: ListNest.SortByType
+
   /** 分页 */
   public pageMode: 'pagination'|'read-more' = 'pagination'
   public pageSize: number = 20 // 每次请求获取量
@@ -52,6 +58,9 @@ export default class ListLite extends Component {
     // 评论为空时显示字符
     if (ctx.conf.noComment) this.noCommentText = ctx.conf.noComment
 
+    // 嵌套排序方式
+    this.nestSortBy = this.ctx.conf.nestSort || 'DATE_ASC'
+
     // 评论时间自动更新
     window.setInterval(() => {
       this.$el.querySelectorAll<HTMLElement>('[data-atk-comment-date]').forEach(el => {
@@ -265,7 +274,7 @@ export default class ListLite extends Component {
   /** 刷新界面 */
   public refreshUI() {
     // 无评论
-    const isNoComment = this.comments.length <= 0
+    const isNoComment = this.commentList.length <= 0
     let $noComment = this.$commentsWrap.querySelector<HTMLElement>('.atk-list-no-comment')
 
     if (isNoComment) {
@@ -283,8 +292,11 @@ export default class ListLite extends Component {
   }
 
   /** 创建新评论 */
-  protected createComment(data: CommentData) {
-    const comment = new Comment(this.ctx, data)
+  protected createComment(cData: CommentData, ctxData?: CommentData[]) {
+    if (!ctxData) ctxData = this.commentDataList
+
+    const comment = new Comment(this.ctx, cData)
+    comment.flatMode = this.flatMode
     comment.afterRender = () => {
       if (this.renderComment) this.renderComment(comment)
     }
@@ -293,6 +305,9 @@ export default class ListLite extends Component {
       this.refreshUI()
     }
 
+    // 子评论查找回复对象
+    comment.replyTo = (cData.rid ? ctxData.find(c => c.id === cData.rid) : undefined)
+
     return comment
   }
 
@@ -303,31 +318,16 @@ export default class ListLite extends Component {
         this.putCommentFlatMode(commentData, srcData, 'append')
       })
     } else {
-      this.importCommentsNesting(srcData)
+      this.importCommentsNest(srcData)
     }
   }
 
   // 导入评论 · 嵌套模式
-  private importCommentsNesting(srcData: CommentData[]) {
-    // 查找并导入所有子评论
-    const loadChildren = (parentC: Comment) => {
-      const children = srcData.filter(o => o.rid === parentC.data.id)
-      children.forEach((childData: CommentData) => {
-        const childC = this.createComment(childData)
-        childC.render()
-
-        // 插入到父评论中
-        parentC.putChild(childC)
-
-        // 递归加载子评论
-        loadChildren(childC)
-      })
-    }
-
+  private importCommentsNest(srcData: CommentData[]) {
     // 遍历 root 评论
-    const rootComments = srcData.filter((o) => o.rid === 0)
-    rootComments.forEach((rootData: CommentData) => {
-      const rootC = this.createComment(rootData)
+    const rootNodes = ListNest.makeNestCommentNodeList(srcData, this.nestSortBy, this.conf.nestMax)
+    rootNodes.forEach((rootNode: ListNest.CommentNode) => {
+      const rootC = this.createComment(rootNode.comment, srcData)
       rootC.render()
 
       // 显示并播放渐入动画
@@ -335,10 +335,25 @@ export default class ListLite extends Component {
       rootC.playFadeInAnim()
 
       // 评论放入 comments 总表中
-      this.comments.push(rootC)
+      this.commentList.push(rootC)
 
       // 加载子评论
-      loadChildren(rootC)
+      const that = this
+      ;(function loadChildren(parentC: Comment, parentNode: ListNest.CommentNode) {
+        parentNode.children.forEach((node: ListNest.CommentNode) => {
+          const childD = node.comment
+          const childC = that.createComment(childD, srcData)
+          childC.render()
+
+          // 插入到父评论中
+          parentC.putChild(childC)
+
+          that.commentList.push(childC)
+
+          // 递归加载子评论
+          loadChildren(childC, node)
+        })
+      })(rootC, rootNode)
 
       // 限高检测
       rootC.checkHeightLimit()
@@ -346,18 +361,13 @@ export default class ListLite extends Component {
   }
 
   /** 导入评论 · 平铺模式 */
-  private putCommentFlatMode(cData: CommentData, srcData: CommentData[], insertMode: 'append'|'prepend') {
+  private putCommentFlatMode(cData: CommentData, ctxData: CommentData[], insertMode: 'append'|'prepend') {
     if (cData.is_collapsed) cData.is_allow_reply = false
-    const comment = this.createComment(cData)
-    if (cData.rid !== 0) {
-      const rComment = srcData.find(o => o.id === cData.rid)
-      if (rComment) comment.replyTo = rComment
-    }
+    const comment = this.createComment(cData, ctxData)
     comment.render()
 
     // 将评论导入 comments 总表中
-    if (insertMode === 'append') this.comments.push(comment)
-    if (insertMode === 'prepend') this.comments.unshift(comment)
+    this.commentList.push(comment)
 
     // 可见评论添加到界面
     // 注：不可见评论用于显示 “引用内容”
@@ -378,17 +388,18 @@ export default class ListLite extends Component {
     if (!this.flatMode) {
       // 嵌套模式
       const comment = this.createComment(commentData)
-      comment.render()
 
       if (commentData.rid === 0) {
         // root评论 新增
+        comment.render()
         this.$commentsWrap.prepend(comment.getEl())
-        this.comments.unshift(comment)
+        this.commentList.push(comment)
       } else {
         // 子评论 新增
         const parent = this.findComment(commentData.rid)
         if (parent) {
-          parent.putChild(comment)
+          comment.render()
+          parent.putChild(comment, (this.nestSortBy === 'DATE_ASC' ? 'append' : 'prepend'))
 
           // 若父评论存在 “子评论部分” 限高，取消限高
           comment.getParents().forEach((p) => {
@@ -403,7 +414,7 @@ export default class ListLite extends Component {
       comment.playFadeInAnim() // 播放评论渐出动画
     } else {
       // 平铺模式
-      const comment = this.putCommentFlatMode(commentData, this.comments.map(c => c.data), 'prepend')
+      const comment = this.putCommentFlatMode(commentData, this.commentDataList, 'prepend')
       Ui.scrollIntoView(comment.getEl()) // 滚动到可见
     }
 
@@ -415,47 +426,22 @@ export default class ListLite extends Component {
     this.ctx.trigger('comments-loaded')
   }
 
-  /** 遍历操作 Comment (包括子评论) */
-  protected eachComment(commentList: Comment[], action: (comment: Comment, levelList: Comment[]) => boolean|void) {
-    if (commentList.length === 0) return
-    commentList.every((item) => {
-      if (action(item, commentList) === false) return false
-      this.eachComment(item.getChildren(), action)
-      return true
-    })
-  }
-
   /** 查找评论项 */
-  protected findComment(id: number, src?: Comment[]): Comment|null {
-    if (!src) src = this.comments
-    let comment: Comment|null = null
-    this.eachComment(src, (item) => {
-      if (item.data.id === id) {
-        comment = item
-        return false
-      }
-      return true
-    })
-
-    return comment
+  protected findComment(id: number): Comment|undefined {
+    return this.commentList.find(c => c.data.id === id)
   }
 
   /** 删除评论 */
-  public deleteComment(comment: number|Comment) {
-    let findComment: Comment|null
-    if (typeof comment === 'number') {
-      findComment = this.findComment(comment)
-      if (!findComment) throw Error(`未找到评论 ${comment}`)
-    } else findComment = comment
-
-    findComment.getEl().remove()
-    this.eachComment(this.comments, (item, levelList) => {
-      if (item === findComment) {
-        levelList.splice(levelList.indexOf(item), 1)
-        return false
-      }
-      return true
-    })
+  public deleteComment(_comment: number|Comment) {
+    let comment: Comment
+    if (typeof _comment === 'number') {
+      const findComment = this.findComment(_comment)
+      if (!findComment) throw Error(`未找到评论 ${_comment}`)
+      comment = findComment
+    } else comment = _comment
+
+    comment.getEl().remove()
+    this.commentList.splice(this.commentList.indexOf(comment), 1)
 
     if (this.data) this.data.total -= 1 // 评论数减 1
 
@@ -466,7 +452,7 @@ export default class ListLite extends Component {
   public clearAllComments() {
     this.$commentsWrap.innerHTML = ''
     this.data = undefined
-    this.comments = []
+    this.commentList = []
   }
 
   /** 更新未读数据 */
@@ -475,7 +461,7 @@ export default class ListLite extends Component {
 
     // 高亮评论
     if (this.unreadHighlight === true) {
-      this.eachComment(this.comments, (comment) => {
+      this.commentList.forEach((comment) => {
         const notify = this.unread.find(o => o.comment_id === comment.data.id)
         if (notify) {
           comment.setUnread(true)

package/src/components/list-nest.ts

@@ -0,0 +1,66 @@
+import { CommentData } from '~/types/artalk-data'
+
+export type CommentNode = {
+  id: number
+  comment: CommentData
+  children: CommentNode[]
+  parent?: CommentNode
+  level: number
+}
+
+export type SortByType = 'DATE_DESC'|'DATE_ASC'|'SRC_INDEX'|'VOTE_UP_DESC'
+
+// 构建树状结构列表
+export function makeNestCommentNodeList(srcData: CommentData[], sortBy: SortByType = 'DATE_DESC', nestMax = 2) {
+  const nodeList: CommentNode[] = []
+
+  const roots = srcData.filter((o) => o.rid === 0)
+  roots.forEach((root: CommentData) => {
+    const rootNode: CommentNode = {
+      id: root.id,
+      comment: root,
+      children: [],
+      level: 1,
+    }
+
+    rootNode.parent = rootNode
+    nodeList.push(rootNode)
+
+    ;(function loadChildren(parentNode: CommentNode) {
+      const children = srcData.filter((o) => o.rid === parentNode.id)
+      if (children.length === 0) return
+      if (parentNode.level >= nestMax) parentNode = parentNode.parent!
+      children.forEach((child: CommentData) => {
+        const childNode: CommentNode = {
+          id: child.id,
+          comment: child,
+          children: [],
+          parent: parentNode,
+          level: parentNode.level + 1,
+        }
+
+        parentNode.children.push(childNode)
+        loadChildren(childNode)
+      })
+    })(rootNode)
+  })
+
+  // 排序
+  const sortFunc = (a: CommentNode, b: CommentNode): number => {
+    let v = a.id - b.id
+    if (sortBy === 'DATE_ASC') v = +new Date(a.comment.date) - +new Date(b.comment.date)
+    else if (sortBy === 'DATE_DESC') v = +new Date(b.comment.date) - +new Date(a.comment.date)
+    else if (sortBy === 'SRC_INDEX') v = srcData.indexOf(a.comment) - srcData.indexOf(b.comment)
+    else if (sortBy === 'VOTE_UP_DESC') v = b.comment.vote_up - a.comment.vote_up
+    return v
+  }
+
+  (function sortLevels(nodes: CommentNode[]) {
+    nodes.forEach((node) => {
+      node.children = node.children.sort(sortFunc)
+      sortLevels(node.children)
+    })
+  })(nodeList)
+
+  return nodeList
+}

package/src/components/list.ts

@@ -112,11 +112,19 @@ export default class List extends ListLite {
     super.onLoad(data, offset)
 
     // 检测锚点跳转
-    this.checkGoToCommentByUrlHash()
+    if (!this.goToCommentFounded) this.checkGoToCommentByUrlHash()
+
+    // 防止评论框被吞
+    if (this.ctx.conf.editorTravel === true) {
+      this.ctx.trigger('editor-travel-back')
+    }
   }
 
+  private goToCommentFounded = false
+  public goToCommentDelay = true
+
   /** 跳到评论项位置 - 根据 `location.hash` */
-  public async checkGoToCommentByUrlHash () {
+  public checkGoToCommentByUrlHash() {
     let commentId = Number(Utils.getQueryParam('atk_comment')) // same as backend GetReplyLink()
     if (!commentId) {
       const match = window.location.hash.match(/#atk-comment-([0-9]+)/)
@@ -125,6 +133,14 @@ export default class List extends ListLite {
     }
     if (!commentId) return
 
+    const comment = this.findComment(commentId)
+    if (!comment) { // 若找不到评论
+      // 自动翻页
+      if (this.readMoreBtn) this.readMoreBtn.click()
+      else if (this.pagination) this.pagination.next()
+      return
+    }
+
     // 已阅 API
     const notifyKey = Utils.getQueryParam('atk_notify_key')
     if (notifyKey) {
@@ -137,20 +153,24 @@ export default class List extends ListLite {
         })
     }
 
-    const comment = this.findComment(commentId)
-    // TODO 若找不到评论的情况
-    // if (!comment) { // 若找不到评论
-    //   if (this.hasMoreComments) { // 阅读更多，并重试
-    //     await this.fetchComments()
-    //   }
-    // }
-
-    if (!comment) return
-
-    Ui.scrollIntoView(comment.getEl(), false)
-    window.setTimeout(() => {
-      comment.getEl().classList.add('atk-flash-once')
-    }, 800)
+    // 若父评论存在 “子评论部分” 限高，取消限高
+    comment.getParents().forEach((p) => {
+      if (p.$children) p.heightLimitRemove(p.$children)
+    })
+
+    const goTo = () => {
+      Ui.scrollIntoView(comment.getEl(), false)
+
+      comment.getEl().classList.remove('atk-flash-once')
+      window.setTimeout(() => {
+        comment.getEl().classList.add('atk-flash-once')
+      }, 150)
+    }
+
+    if (!this.goToCommentDelay) goTo()
+    else window.setTimeout(() => goTo(), 350)
+
+    this.goToCommentFounded = true
   }
 
   /** 管理员设置页面信息 */

package/src/defaults.ts

@@ -12,6 +12,10 @@ const defaults: ArtalkConfig = {
   darkMode: false,
   editorTravel: true,
 
+  flatMode: 'auto',
+  nestMax: 2,
+  nestSort: 'DATE_ASC',
+
   emoticons: "https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json",
 
   vote: true,
@@ -19,8 +23,7 @@ const defaults: ArtalkConfig = {
   uaBadge: true,
   listSort: true,
   pvEl: '#ArtalkPV',
-  flatMode: 'auto',
-  maxNesting: 3,
+
   gravatar: {
     default: 'mp',
     mirror: 'https://sdn.geekzu.org/avatar/',