oauth.py 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. # -*- coding: utf-8 -*-
  2. """
  3. wechatpy.oauth
  4. ~~~~~~~~~~~~~~~
  5. This module provides OAuth2 library for WeChat
  6. :copyright: (c) 2014 by messense.
  7. :license: MIT, see LICENSE for more details.
  8. """
  9. from __future__ import absolute_import, unicode_literals
  10. import requests
  11. from six.moves.urllib.parse import quote
  12. from wechatpy.exceptions import WeChatOAuthException
  13. from wechatpy.utils import json
  14. class WeChatOAuth(object):
  15. """ 微信公众平台 OAuth 网页授权
  16. 详情请参考
  17. https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1419316505
  18. """
  19. API_BASE_URL = 'https://api.weixin.qq.com/'
  20. OAUTH_BASE_URL = 'https://open.weixin.qq.com/connect/'
  21. def __init__(self, app_id, secret, redirect_uri, scope='snsapi_base', state=''):
  22. """
  23. :param app_id: 微信公众号 app_id
  24. :param secret: 微信公众号 secret
  25. :param redirect_uri: OAuth2 redirect URI
  26. :param scope: 可选,微信公众号 OAuth2 scope,默认为 ``snsapi_base``
  27. :param state: 可选,微信公众号 OAuth2 state
  28. """
  29. self.app_id = app_id
  30. self.secret = secret
  31. self.redirect_uri = redirect_uri
  32. self.scope = scope
  33. self.state = state
  34. self._http = requests.Session()
  35. def _request(self, method, url_or_endpoint, **kwargs):
  36. if not url_or_endpoint.startswith(('http://', 'https://')):
  37. url = '{base}{endpoint}'.format(
  38. base=self.API_BASE_URL,
  39. endpoint=url_or_endpoint
  40. )
  41. else:
  42. url = url_or_endpoint
  43. if isinstance(kwargs.get('data', ''), dict):
  44. body = json.dumps(kwargs['data'], ensure_ascii=False)
  45. body = body.encode('utf-8')
  46. kwargs['data'] = body
  47. res = self._http.request(
  48. method=method,
  49. url=url,
  50. **kwargs
  51. )
  52. try:
  53. res.raise_for_status()
  54. except requests.RequestException as reqe:
  55. raise WeChatOAuthException(
  56. errcode=None,
  57. errmsg=None,
  58. client=self,
  59. request=reqe.request,
  60. response=reqe.response
  61. )
  62. result = json.loads(res.content.decode('utf-8', 'ignore'), strict=False)
  63. if 'errcode' in result and result['errcode'] != 0:
  64. errcode = result['errcode']
  65. errmsg = result['errmsg']
  66. raise WeChatOAuthException(
  67. errcode,
  68. errmsg,
  69. client=self,
  70. request=res.request,
  71. response=res
  72. )
  73. return result
  74. def _get(self, url, **kwargs):
  75. return self._request(
  76. method='get',
  77. url_or_endpoint=url,
  78. **kwargs
  79. )
  80. @property
  81. def authorize_url(self):
  82. """获取授权跳转地址
  83. :return: URL 地址
  84. """
  85. redirect_uri = quote(self.redirect_uri, safe=b'')
  86. url_list = [
  87. self.OAUTH_BASE_URL,
  88. 'oauth2/authorize?appid=',
  89. self.app_id,
  90. '&redirect_uri=',
  91. redirect_uri,
  92. '&response_type=code&scope=',
  93. self.scope
  94. ]
  95. if self.state:
  96. url_list.extend(['&state=', self.state])
  97. url_list.append('#wechat_redirect')
  98. return ''.join(url_list)
  99. @property
  100. def qrconnect_url(self):
  101. """生成扫码登录地址
  102. :return: URL 地址
  103. """
  104. redirect_uri = quote(self.redirect_uri, safe=b'')
  105. url_list = [
  106. self.OAUTH_BASE_URL,
  107. 'qrconnect?appid=',
  108. self.app_id,
  109. '&redirect_uri=',
  110. redirect_uri,
  111. '&response_type=code&scope=',
  112. 'snsapi_login' # scope
  113. ]
  114. if self.state:
  115. url_list.extend(['&state=', self.state])
  116. url_list.append('#wechat_redirect')
  117. return ''.join(url_list)
  118. def fetch_access_token(self, code):
  119. """获取 access_token
  120. :param code: 授权完成跳转回来后 URL 中的 code 参数
  121. :return: JSON 数据包
  122. """
  123. res = self._get(
  124. 'sns/oauth2/access_token',
  125. params={
  126. 'appid': self.app_id,
  127. 'secret': self.secret,
  128. 'code': code,
  129. 'grant_type': 'authorization_code'
  130. }
  131. )
  132. self.access_token = res['access_token']
  133. self.open_id = res['openid']
  134. self.refresh_token = res['refresh_token']
  135. self.expires_in = res['expires_in']
  136. return res
  137. def refresh_access_token(self, refresh_token):
  138. """刷新 access token
  139. :param refresh_token: OAuth2 refresh token
  140. :return: JSON 数据包
  141. """
  142. res = self._get(
  143. 'sns/oauth2/refresh_token',
  144. params={
  145. 'appid': self.app_id,
  146. 'grant_type': 'refresh_token',
  147. 'refresh_token': refresh_token
  148. }
  149. )
  150. self.access_token = res['access_token']
  151. self.open_id = res['openid']
  152. self.refresh_token = res['refresh_token']
  153. self.expires_in = res['expires_in']
  154. return res
  155. def get_user_info(self, openid=None, access_token=None, lang='zh_CN'):
  156. """获取用户信息
  157. :param openid: 可选,微信 openid,默认获取当前授权用户信息
  158. :param access_token: 可选,access_token,默认使用当前授权用户的 access_token
  159. :param lang: 可选,语言偏好, 默认为 ``zh_CN``
  160. :return: JSON 数据包
  161. """
  162. openid = openid or self.open_id
  163. access_token = access_token or self.access_token
  164. return self._get(
  165. 'sns/userinfo',
  166. params={
  167. 'access_token': access_token,
  168. 'openid': openid,
  169. 'lang': lang
  170. }
  171. )
  172. def check_access_token(self, openid=None, access_token=None):
  173. """检查 access_token 有效性
  174. :param openid: 可选,微信 openid,默认获取当前授权用户信息
  175. :param access_token: 可选,access_token,默认使用当前授权用户的 access_token
  176. :return: 有效返回 True,否则 False
  177. """
  178. openid = openid or self.open_id
  179. access_token = access_token or self.access_token
  180. res = self._get(
  181. 'sns/auth',
  182. params={
  183. 'access_token': access_token,
  184. 'openid': openid
  185. }
  186. )
  187. if res['errcode'] == 0:
  188. return True
  189. return False