@waline/vercel 0.26.9 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waline/vercel",
-  "version": "0.26.9",
+  "version": "1.0.0",
   "description": "vercel server for waline comment system",
   "repository": "https://github.com/walinejs/waline",
   "license": "MIT",
@@ -9,12 +9,12 @@
     "@cloudbase/node-sdk": "^2.7.1",
     "@koa/cors": "^3.1.0",
     "akismet": "^2.0.6",
-    "dompurify": "^2.3.1",
+    "dompurify": "^2.3.3",
     "fast-csv": "^4.3.6",
     "jsdom": "^17.0.0",
     "jsonwebtoken": "^8.5.1",
-    "katex": "^0.13.13",
-    "leancloud-storage": "^4.11.1",
+    "katex": "^0.13.18",
+    "leancloud-storage": "^4.12.0",
     "markdown-it": "^12.2.0",
     "markdown-it-emoji": "^2.0.0",
     "markdown-it-sub": "^1.0.0",
@@ -23,7 +23,7 @@
     "nodemailer": "^6.6.3",
     "nunjucks": "^3.2.3",
     "phpass": "^0.1.1",
-    "prismjs": "^1.24.1",
+    "prismjs": "^1.25.0",
     "request": "^2.88.2",
     "request-promise-native": "^1.0.9",
     "think-logger3": "^1.2.1",

package/src/config/config.js

@@ -65,7 +65,8 @@ if (think.env === 'cloudbase' && storage === 'sqlite') {
 
 const forbiddenWords = FORBIDDEN_WORDS ? FORBIDDEN_WORDS.split(/\s*,\s*/) : [];
 
-const isFalse = (content) => content && content.toLowerCase() === 'false';
+const isFalse = (content) =>
+  content && ['0', 'false'].includes(content.toLowerCase());
 
 const markdown = {
   config: JSON.parse(MARKDOWN_CONFIG),
@@ -81,6 +82,11 @@ const markdown = {
 
 if (isFalse(MARKDOWN_HIGHLIGHT)) markdown.config.highlight = false;
 
+let avatarProxy = 'https://avatar.75cdn.workers.dev/';
+if (AVATAR_PROXY) {
+  avatarProxy = !isFalse(AVATAR_PROXY) ? AVATAR_PROXY : '';
+}
+
 module.exports = {
   workers: 1,
   storage,
@@ -88,13 +94,9 @@ module.exports = {
   forbiddenWords,
   disallowIPList: [],
   secureDomains: SECURE_DOMAINS ? SECURE_DOMAINS.split(/\s*,\s*/) : undefined,
-  disableUserAgent:
-    DISABLE_USERAGENT &&
-    !['0', 'false'].includes(DISABLE_USERAGENT.toLowerCase()),
-  avatarProxy: AVATAR_PROXY || 'https://avatar.75cdn.workers.dev/',
-
+  disableUserAgent: !isFalse(DISABLE_USERAGENT),
+  avatarProxy,
   markdown,
-
   mailSubject: MAIL_SUBJECT,
   mailTemplate: MAIL_TEMPLATE,
   mailSubjectAdmin: MAIL_SUBJECT_ADMIN,

package/src/controller/comment.js

@@ -18,28 +18,28 @@ async function formatCmt(
     comment.os = [ua.os.name, ua.os.version].filter((v) => v).join(' ');
   }
 
-  if (user_id) {
-    const user = users.find(({ objectId }) => user_id === objectId);
-
-    if (user) {
-      comment.nick = user.display_name;
-      comment.mail = user.email;
-      comment.link = user.url;
-      comment.type = user.type;
-
-      let { avatar } = user;
-      if (avatar) {
-        if (/(github)/i.test(avatar) && !avatar.includes(avatarProxy)) {
-          avatar = avatarProxy + '?url=' + encodeURIComponent(avatar);
-        }
-        comment.avatar = avatar;
-      }
-    }
+  const user = users.find(({ objectId }) => user_id === objectId);
+  if (user) {
+    comment.nick = user.display_name;
+    comment.mail = user.email;
+    comment.link = user.url;
+    comment.type = user.type;
   }
+
   comment.mail = helper.md5(
     comment.mail ? comment.mail.toLowerCase() : comment.mail
   );
 
+  const avatarUrl =
+    user && user.avatar
+      ? user.avatar
+      : `https://seccdn.libravatar.org/avatar/${comment.mail}`;
+
+  comment.avatar =
+    avatarProxy && !avatarUrl.includes(avatarProxy)
+      ? avatarProxy + '?url=' + encodeURIComponent(avatarUrl)
+      : avatarUrl;
+
   return comment;
 }
 
@@ -169,6 +169,7 @@ module.exports = class extends BaseRest {
               'rid',
               'ua',
               'user_id',
+              'sticky',
             ],
           }
         );
@@ -193,9 +194,10 @@ module.exports = class extends BaseRest {
 
         const rootCount = comments.filter(({ rid }) => !rid).length;
         const pageOffset = Math.max((page - 1) * pageSize, 0);
-        const rootComments = comments
-          .filter(({ rid }) => !rid)
-          .slice(pageOffset, pageOffset + pageSize);
+        const rootComments = [
+          ...comments.filter(({ rid, sticky }) => !rid && sticky),
+          ...comments.filter(({ rid, sticky }) => !rid && !sticky),
+        ].slice(pageOffset, pageOffset + pageSize);
 
         return this.json({
           page,

package/src/logic/base.js

@@ -45,16 +45,21 @@ module.exports = class extends think.Logic {
       { email: userMail },
       { field: ['email', 'url', 'display_name', 'type', 'github', 'avatar'] }
     );
-    if (!think.isEmpty(user)) {
-      const userInfo = user[0];
-      userInfo.mailMd5 = helper.md5(userInfo.email);
-      if (/(github)/i.test(userInfo.avatar)) {
-        userInfo.avatar =
-          this.config('avatarProxy') +
-          '?url=' +
-          encodeURIComponent(userInfo.avatar);
-      }
-      this.ctx.state.userInfo = userInfo;
+    if (think.isEmpty(user)) {
+      return;
+    }
+
+    const userInfo = user[0];
+    userInfo.mailMd5 = helper.md5(userInfo.mail);
+
+    let avatarUrl = userInfo.avatar
+      ? userInfo.avatar
+      : `https://seccdn.libravatar.org/avatar/${userInfo.mailMd5}`;
+    const { avatarProxy } = think.config();
+    if (avatarProxy) {
+      avatarUrl = avatarProxy + '?url=' + encodeURIComponent(avatarUrl);
     }
+    userInfo.avatar = avatarUrl;
+    this.ctx.state.userInfo = userInfo;
   }
 };

package/src/logic/comment.js

@@ -21,6 +21,96 @@ module.exports = class extends Base {
     }
   }
 
+  /**
+   * @api {GET} /comment Get comment list for client
+   * @apiGroup Comment
+   * @apiVersion  0.0.1
+   *
+   * @apiParam  {String}  path  comment url path
+   * @apiParam  {String}  page  page
+   * @apiParam  {String}  pagesize  page size
+   *
+   * @apiSuccess  (200) {Number}  page return current comments list page
+   * @apiSuccess  (200) {Number}  pageSize  to  return error message if error
+   * @apiSuccess  (200) {Object[]}  data  comments list
+   * @apiSuccess  (200) {String}  data.nick comment user nick name
+   * @apiSuccess  (200) {String}  data.mail comment user mail md5
+   * @apiSuccess  (200) {String}  data.link comment user link
+   * @apiSuccess  (200) {String}  data.objectId comment id
+   * @apiSuccess  (200) {String}  data.browser comment user browser
+   * @apiSuccess  (200) {String}  data.os comment user os
+   * @apiSuccess  (200) {String}  data.insertedAt comment created time
+   * @apiSuccess  (200) {String}  data.avatar comment user avatar
+   * @apiSuccess  (200) {String}  data.type comment login user type
+   * @apiSuccess  (200) {Object[]}  data.children children comments list
+   * @apiSuccess  (200) {String}  data.children.nick comment user nick name
+   * @apiSuccess  (200) {String}  data.children.mail comment user mail md5
+   * @apiSuccess  (200) {String}  data.children.link comment user link
+   * @apiSuccess  (200) {String}  data.children.objectId comment id
+   * @apiSuccess  (200) {String}  data.children.browser comment user browser
+   * @apiSuccess  (200) {String}  data.children.os comment user os
+   * @apiSuccess  (200) {String}  data.children.insertedAt comment created time
+   * @apiSuccess  (200) {String}  data.children.avatar comment user avatar
+   * @apiSuccess  (200) {String}  data.children.type comment login user type
+   */
+  /**
+   * @api {GET} /comment?type=list Get comment list for admin
+   * @apiGroup Comment
+   * @apiVersion  0.0.1
+   *
+   * @apiParam  {String}  page  page
+   * @apiParam  {String}  pagesize  page size
+   *
+   * @apiSuccess  (200) {Number}  errno 0
+   * @apiSuccess  (200) {String}  errmsg  return error message if error
+   * @apiSuccess  (200) {Object}  data
+   * @apiSuccess  (200) {Number}  data.page comments list current page
+   * @apiSuccess  (200) {Number}  data.pageSize comments list page size
+   * @apiSuccess  (200) {Number}  data.totalPages comments list total pages
+   * @apiSuccess  (200) {Number}  data.spamCount spam comments count
+   * @apiSuccess  (200) {Number}  data.waitingCount waiting comments count
+   * @apiSuccess  (200) {Object[]}  data.data comments list data
+   * @apiSuccess  (200) {String}  data.data.ip comment user ip address
+   * @apiSuccess  (200) {String}  data.data.nick comment user nick name
+   * @apiSuccess  (200) {String}  data.data.mail comment user mail md5
+   * @apiSuccess  (200) {String}  data.data.link comment user link
+   * @apiSuccess  (200) {String}  data.data.objectId comment id
+   * @apiSuccess  (200) {String}  data.data.status comment status, approved, waiting or spam
+   * @apiSuccess  (200) {String}  data.data.ua  comment user agent
+   * @apiSuccess  (200) {String}  data.data.insertedAt comment created time
+   * @apiSuccess  (200) {String}  data.data.avatar comment user avatar
+   * @apiSuccess  (200) {String}  data.data.url comment article link
+   */
+  /**
+   * @api {GET} /comment?type=count Get comment count for articles
+   * @apiGroup Comment
+   * @apiVersion  0.0.1
+   *
+   * @apiParam  {String}  url a array string join by comma just like `a` or `a,b`
+   *
+   * @apiSuccessExample {Number} Single Path Response:
+   * 300
+   * @apiSuccessExample {Number} Multiple Path Response:
+   * [300, 100]
+   */
+  /**
+   * @api {GET} /comment?type=recent Get recent comments
+   * @apiGroup Comment
+   * @apiVersion  0.0.1
+   *
+   * @apiParam  {String}  count return comments number, default value is 10
+   *
+   * @apiSuccess  (200) {Object[]} response
+   * @apiSuccess  (200) {String}  response.nick comment user nick name
+   * @apiSuccess  (200) {String}  response.mail comment user mail md5
+   * @apiSuccess  (200) {String}  response.link comment user link
+   * @apiSuccess  (200) {String}  response.objectId comment id
+   * @apiSuccess  (200) {String}  response.browser comment user browser
+   * @apiSuccess  (200) {String}  response.os comment user os
+   * @apiSuccess  (200) {String}  response.insertedAt comment created time
+   * @apiSuccess  (200) {String}  response.avatar comment user avatar
+   * @apiSuccess  (200) {String}  response.type comment login user type
+   */
   getAction() {
     const { type } = this.get();
     switch (type) {
@@ -79,6 +169,34 @@ module.exports = class extends Base {
     }
   }
 
+  /**
+   * @api {POST} /comment post comment
+   * @apiGroup Comment
+   * @apiVersion  0.0.1
+   *
+   * @apiParam  {String}  nick post comment user nick name
+   * @apiParam  {String}  mail  post comment user mail address
+   * @apiParam  {String}  link  post comment user link
+   * @apiParam  {String}  comment  post comment text
+   * @apiParam  {String}  url  the artcile url path of comment
+   * @apiParam  {String}  ua  browser user agent
+   * @apiParam  {String}  pid parent comment id
+   * @apiParam  {String}  rid root comment id
+   * @apiParam  {String}  at  parent comment user nick name
+   *
+   * @apiSuccess  (200) {Number}  errno 0
+   * @apiSuccess  (200) {String}  errmsg  return error message if error
+   * @apiSuccess  (200) {Object}  data  return comment data
+   * @apiSuccess  (200) {String}  data.nick comment user nick name
+   * @apiSuccess  (200) {String}  data.mail comment user mail md5
+   * @apiSuccess  (200) {String}  data.link comment user link
+   * @apiSuccess  (200) {String}  data.objectId comment id
+   * @apiSuccess  (200) {String}  data.browser comment user browser
+   * @apiSuccess  (200) {String}  data.os comment user os
+   * @apiSuccess  (200) {String}  data.insertedAt comment created time
+   * @apiSuccess  (200) {String}  data.avatar comment user avatar
+   * @apiSuccess  (200) {String}  data.type comment login user type
+   */
   postAction() {
     const { LOGIN } = process.env;
     const { userInfo } = this.ctx.state;

package/src/logic/oauth.js

@@ -1,3 +1,10 @@
 const Base = require('./base');
 
-module.exports = class extends Base {};
+module.exports = class extends Base {
+  /**
+   * @api {GET} /oauth/github  github oauth api
+   * @apiGroup  OAuth
+   * @apiVersion  0.0.1
+   */
+  githubAction() {}
+};

package/src/logic/token.js

@@ -1,3 +1,46 @@
 const Base = require('./base');
 
-module.exports = class extends Base {};
+module.exports = class extends Base {
+  /**
+   * @api {GET} /token  get login user info
+   * @apiGroup User
+   * @apiVersion  0.0.1
+   *
+   * @apiSuccess  (200) {Number}  errno 0
+   * @apiSuccess  (200) {String}  errmsg  return error message if error
+   * @apiSuccess  (200) {Object}  data user info
+   * @apiSuccess  (200) {String}  data.avatar user avatar
+   * @apiSuccess  (200) {String}  data.createdAt user register time
+   * @apiSuccess  (200) {String}  data.display_name user nick name
+   * @apiSuccess  (200) {String}  data.emal user email address
+   * @apiSuccess  (200) {String}  data.github user github account name
+   * @apiSuccess  (200) {String}  data.mailMd5 user mail md5
+   * @apiSuccess  (200) {String}  data.objectId user id
+   * @apiSuccess  (200) {String}  data.type user type, administrator or guest
+   * @apiSuccess  (200) {String}  data.url user link
+   */
+  getAction() {}
+
+  /**
+   * @api {POST} /token user login
+   * @apiGroup User
+   * @apiVersion  0.0.1
+   *
+   * @apiParam  {String}  email login user email
+   * @apiParam  {String}  password login user password
+   *
+   * @apiSuccess  (200) {Number}  errno 0
+   * @apiSuccess  (200) {String}  errmsg  return error message if error
+   */
+  postAction() {}
+
+  /**
+   * @api {DELETE} /token  user logout
+   * @apiGroup User
+   * @apiVersion  0.0.1
+   *
+   * @apiSuccess  (200) {Number}  errno 0
+   * @apiSuccess  (200) {String}  errmsg  return error message if error
+   */
+  deleteAction() {}
+};

package/src/logic/user.js

@@ -1,6 +1,34 @@
 const Base = require('./base');
 
 module.exports = class extends Base {
+  /**
+   * @api {POST} /user user register
+   * @apiGroup User
+   * @apiVersion  0.0.1
+   *
+   * @apiParam  {String}  display_name  user nick name
+   * @apiParam  {String}  email user email
+   * @apiParam  {String}  password user password
+   * @apiParam  {String}  url user link
+   *
+   * @apiSuccess  (200) {Number}  errno 0
+   * @apiSuccess  (200) {String}  errmsg  return error message if error
+   */
+  postAction() {}
+
+  /**
+   * @api {PUT} /user update user profile
+   * @apiGroup User
+   * @apiVersion  0.0.1
+   *
+   * @apiParam  {String}  display_name  user new nick name
+   * @apiParam  {String}  url user new link
+   * @apiParam  {String}  password user new password
+   * @apiParam  {String}  github user github account name
+   *
+   * @apiSuccess  (200) {Number}  errno 0
+   * @apiSuccess  (200) {String}  errmsg  return error message if error
+   */
   putAction() {
     const { userInfo } = this.ctx.state;
     if (think.isEmpty(userInfo)) {

package/src/service/notify.js

@@ -119,9 +119,6 @@ module.exports = class extends think.Service {
       `💬 {{site.name|safe}} 有新评论啦
 {{self.nick}} 评论道：
 {{self.comment}}
-邮箱：{{self.mail}}
-状态：{{self.status}} 
-评论页面：{{self.url}} 
 仅供预览评论，请前往上述页面查看完整內容。`;
 
     return request({