opt code

Author: IndexXuan

app/middleware/error_handler.js

@@ -19,7 +19,7 @@ module.exports = app => {
  // 生产环境 500 错误的详细错误内容不返回给客户端，因为可能包含敏感信息
  const error = status === 500 && ctx.app.config.env === 'prod'
  ? 'Internal Server Error'
- : `from: middleware, msg: ${err.message}, stacks ${err.stack}`
+ : `catchBy: middleware, msg: ${err.message}, stacks ${err.stack}`
  // 从 error 对象上读出各个属性，设置到响应中
  ctx.body = { error }
  // 422 Unprocessable Entity

app/service/auth.js

@@ -7,6 +7,7 @@
  * Date : Tue 14 Mar 2017 03:19:07 PM CST
  */
 
+// import parser
 const setCookieParser = require('set-cookie-parser')
 
 module.exports = app => {
@@ -15,38 +16,38 @@ module.exports = app => {
  /**
  * @constructor
  *
- * @param ctx
+ * @param {Objet} ctx - context object
  */
  constructor (ctx) {
  super(ctx)
+
  this.commonHeaders = {
  "Accept": "text/html,application/xhtml+xml,application/xml",
  "Origin": "https://www.v2ex.com",
- "Referer": "https://www.v2ex.com/mission/daily",
+ "Referer": "https://www.v2ex.com",
  "User-Agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36"
  }
 
  this.commonCookies = {
  tab: 'V2EX_TAB="2|1:0|10:1489746039|8:V2EX_TAB|8:dGVjaA==|b72b63fabe0f8faeff147ac38e26299655d713ad1880feef6679b56d8d1e9f47"',
- lang: 'V2EX_LANG=zhcn; _ga=GA1.2.1254455933.1474272858; _gat=1'
+ others: 'V2EX_LANG=zhcn; _ga=GA1.2.1254455933.1474272858; _gat=1'
  }
 
- // sessionid
+ // sessionid cookie name 
  this.sessionCookieName = 'PB3_SESSION'
 
- // token cookie name
+ // token cookie name 
  this.tokenCookieName = 'A2'
 
  // 首页url
  this.homeUrl = 'https://www.v2ex.com/'
 
- // 获取登陆签名
+ // 登陆相关
  this.loginUrl = 'https://www.v2ex.com/signin'
- this.sessionCookie = '' // 供 `login`接口放在Header里 `Set-Cookie` 使用
- // this.loginCookieArr = '' // get到的cookie暂存，供合并给最终的cookie
- this.userKey = '' // 用户名 输入框埋下的随机key
- this.passKey = '' // 密码 输入框埋下的随机key
- this.once = '' // input[type="hidden"][name="once"]的随机令牌值(5位数字目前)
+ this.sessionCookieStr = '' // 未登陆的sessionid, 供 `login` 接口放在请求Headers里的 `Set-Cookie` 项中使用
+ this.userField = '' // 用户名 输入框埋下的随机表单域
+ this.passField = '' // 密码 输入框埋下的随机表单域
+ this.once = '' // input[type="hidden"][name="once"]的随机令牌值(目前是5位数字)
 
  // 签到领金币url
  this.signinUrl = 'https://www.v2ex.com/mission/daily'
@@ -56,8 +57,8 @@ module.exports = app => {
  * request
  * 封装统一的请求方法
  *
- * @param url
- * @param opts
+ * @param {String} url - 请求地址
+ * @param {Object} opts - 请求选项
  * @returns {Promise}
  */
  async request (url, opts) {
@@ -75,14 +76,10 @@ module.exports = app => {
  * @returns {Promise}
  */
  async enterHomePage () {
- const result = await this.request(this.homeUrl, {
- method: 'GET',
- dataType: 'text',
- headers: this.commonHeaders
- }) 
+ const result = await this.request(this.homeUrl)
 
- const cs = setCookieParser(result)
- cs.forEach(c => {
+ const session = setCookieParser(result)
+ session.forEach(c => {
  this.ctx.cookies.set(c.name, c.value, {
  httpOnly: c.httpOnly,
  domain: '',
@@ -93,23 +90,28 @@ module.exports = app => {
  }
 
  /**
- * getLoginKeys
+ * getLoginFields
  * 获取登陆的各种凭证
  *
- * @param content
+ * @param {String} result - 请求登陆页返回的response，包含html字符串和Headers
  */
- getLoginKeys (content) {
- var keyRe = /class="sl" name="([0-9A-Za-z]{64})"/g
- this.userKey = keyRe.exec(content)[1]
- this.passKey = keyRe.exec(content)[1]
- var onceRe = /value="(\d+)" name="once"/
+ getLoginFields (result) {
+ const content = result.data
+
+ const keyRe = /class="sl" name="([0-9A-Za-z]{64})"/g
+ this.userField = keyRe.exec(content)[1]
+ this.passField = keyRe.exec(content)[1]
+
+ const onceRe = /value="(\d+)" name="once"/
  this.once = onceRe.exec(content)[1]
+
+ this.sessionCookieStr = result.headers['set-cookie'][0]
  }
 
  /**
  * enterLoginPage
  * login前的准备
- * 获取sessionid,获取userKey, passKey, once等
+ * 获取sessionid,获取userField, passField, once等
  *
  * @returns {Promise}
  */
@@ -120,61 +122,47 @@ module.exports = app => {
  headers: this.commonHeaders
  }) 
 
- // 供发起login的header里使用
- this.sessionCookie = result.headers['set-cookie'][0]
- console.log('================================before login', this.sessionCookie)
-
- const cs = setCookieParser(result)
-
- return this.getLoginKeys(result.data)
+ return this.getLoginFields(result)
  }
 
  /**
  * login
  * login获取签名主方法
  *
- * @param params
+ * @param {Object} params - 请求参数
  */
  async login (params) {
 
- // @step1: 获取提交的用户名密码
+ // @step1 获取提交的用户名密码
  const { username, password } = params
 
- // 进入登陆页，获取页面隐藏登陆域以及once的值
+ // @step2 进入登陆页，获取页面隐藏登陆域以及once的值
  await this.enterLoginPage()
 
- // 设置请求选项
+ // @step3 设置请求参数
  const opts = {
  method: 'POST',
- headers: Object.assign(this.commonHeaders, { Cookie: this.sessionCookie }),
+ headers: Object.assign(this.commonHeaders, { Cookie: this.sessionCookieStr }),
  data: {
- [this.userKey]: username,
- [this.passKey]: password,
+ [this.userField]: username,
+ [this.passField]: password,
  "once": this.once
  }
  }
 
- // 发起请求
+ // @step4 发起请求
  const result = await this.request(this.loginUrl, opts)
 
- // 获取cookies
+ // @step5 更新session并设置在客户端
+ await this.enterHomePage()
+ 
+ // @step6 解析获取到的cookies
  const cs = setCookieParser(result)
 
- // 更新session并设置在客户端
- const r = this.request(this.homeUrl)
- const session = setCookieParser(r)
- session.forEach(c => {
- this.ctx.cookies.set(c.name, c.value, {
- httpOnly: c.httpOnly,
- domain: '',
- path: c.path,
- expires: c.expires
- })
- })
-
- // 判断是否登陆成功并设置客户端cookies
+ // @step7 判断是否登陆成功并种下客户端cookies
  let success = false
  cs.forEach(c => {
+ // 查看是否有令牌项的cookie，有就说明登陆成功了
  if (c.name === this.tokenCookieName) success = true
  this.ctx.cookies.set(c.name, c.value, {
  httpOnly: c.httpOnly,
@@ -187,7 +175,7 @@ module.exports = app => {
  // 设置API返回结果
  return {
  result: success,
- msg: success ? 'success' : 'sorry! Not get enough token for you',
+ msg: success ? 'ok' : 'sorry! Not get enough `Token`...',
  data: {
  username: username
  }
@@ -198,14 +186,13 @@ module.exports = app => {
  * getSigninOnce
  * 获取签到的once值
  *
- * @param content
+ * @param {String} content - 签到页html字符串
  */
  getSigninOnce (content) {
- // update this.once
  try {
- const onceResult = content.match(/once=(\w*)/g)[1]
- this.once = onceResult.match(/once=(\w*)/)[1]
- console.log('once------------------------', this.once)
+ // update this.once
+ const onceRe = /redeem\?once=(\d+)/
+ this.once = onceRe.exec(content)[1]
  } catch (e) {
  throw new Error('已经签到过了')
  }
@@ -215,57 +202,58 @@ module.exports = app => {
  * enterSigninPage
  * 进入签到页面，获取once值
  *
- * @returns {undefined}
  */
  async enterSigninPage () {
- await this.enterHomePage()
 
  const token = `${this.tokenCookieName}=${this.ctx.cookies.get(this.tokenCookieName)}`
  const session = `${this.sessionCookieName}=${this.ctx.cookies.get(this.sessionCookieName)}`
  const headers = Object.assign(this.commonHeaders, { Cookie: `${session}; ${token}` })
+
  const result = await this.request(this.signinUrl, {
  method: 'GET',
  dataType: 'text',
  headers: headers
  }) 
 
- return this.getSigninOnce(result.data)
+ this.getSigninOnce(result.data)
+ return
  }
 
  /**
  * signin
  * 签到领金币
- *
- * @param params
  */
- async signin (params) {
- // 进入签到页面
+ async signin () {
+
+ // @step1 进入签到页面
  await this.enterSigninPage()
 
- // 获取客户端凭证和cookie
- const { tab, lang } = this.commonCookies
+ // @step2 获取客户端凭证和各种cookies
  const session = `${this.sessionCookieName}=${this.ctx.cookies.get(this.sessionCookieName)}`
  const token = `${this.tokenCookieName}=${this.ctx.cookies.get(this.tokenCookieName)}`
+ const { tab, others } = this.commonCookies
 
- // 设置header
- const headers = Object.assign(this.commonHeaders, { Cookie: `${session}; ${token}; ${tab}; ${lang};` })
- console.log('headers: -------------------------------', headers)
+ // @step3 设置Headers
+ const headers = Object.assign(this.commonHeaders,
+ { Referer: 'https://www.v2ex.com/mission/daily' },
+ { Cookie: `${session}; ${token}; ${tab}; ${others};` }
+ )
 
- // 设置请求选项
+ // @step4 设置请求选项
  const opts = {
  dataType: 'text',
  method: 'get'
  }
 
- // 获取请求结果，会302
+ // @step5 获取请求结果，会302
  const result = await this.request(`${this.signinUrl}/redeem`, Object.assign(opts, { 
  headers: headers,
  data: { 
  'once': this.once
  }
  }))
 
- // 重新进入签到页面，确认是否签到成功
+ // @step6 重新进入签到页面，确认是否签到成功
  const success = await this.request(`${this.signinUrl}`, Object.assign(opts, {
  headers: this.commonHeaders
  }))