Api.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
  1. <?php
  2. namespace app\common\controller;
  3. use app\common\library\Auth;
  4. use app\common\library\Token;
  5. use think\Config;
  6. use think\Db;
  7. use think\exception\HttpResponseException;
  8. use think\exception\ValidateException;
  9. use think\Hook;
  10. use think\Lang;
  11. use think\Loader;
  12. use think\Request;
  13. use think\Response;
  14. use think\Route;
  15. use think\Validate;
  16. /**
  17. * API控制器基类
  18. */
  19. class Api
  20. {
  21. /**
  22. * @var Request Request 实例
  23. */
  24. protected $request;
  25. /**
  26. * @var bool 验证失败是否抛出异常
  27. */
  28. protected $failException = false;
  29. /**
  30. * @var bool 是否批量验证
  31. */
  32. protected $batchValidate = false;
  33. /**
  34. * @var array 前置操作方法列表
  35. */
  36. protected $beforeActionList = [];
  37. /**
  38. * 无需登录的方法,同时也就不需要鉴权了
  39. * @var array
  40. */
  41. protected $noNeedLogin = [];
  42. /**
  43. * 无需鉴权的方法,但需要登录
  44. * @var array
  45. */
  46. protected $noNeedRight = [];
  47. /**
  48. * 权限Auth
  49. * @var Auth
  50. */
  51. protected $auth = null;
  52. /**
  53. * 默认响应输出类型,支持json/xml
  54. * @var string
  55. */
  56. protected $responseType = 'json';
  57. //分页
  58. protected $page;
  59. //每页展示数量
  60. protected $pagenum;
  61. /**
  62. * 构造方法
  63. * @access public
  64. * @param Request $request Request 对象
  65. */
  66. public function __construct(Request $request = null)
  67. {
  68. $this->request = is_null($request) ? Request::instance() : $request;
  69. $this->page = input('page', 1, 'intval');
  70. $this->pagenum = input('pagenum', 10, 'intval');
  71. // 控制器初始化
  72. $this->_initialize();
  73. // 前置操作方法
  74. if ($this->beforeActionList) {
  75. foreach ($this->beforeActionList as $method => $options) {
  76. is_numeric($method) ?
  77. $this->beforeAction($options) :
  78. $this->beforeAction($method, $options);
  79. }
  80. }
  81. }
  82. /**
  83. * 初始化操作
  84. * @access protected
  85. */
  86. protected function _initialize()
  87. {
  88. //跨域请求检测
  89. check_cors_request();
  90. // 检测IP是否允许
  91. check_ip_allowed();
  92. //移除HTML标签
  93. $this->request->filter('trim,strip_tags,htmlspecialchars');
  94. $this->auth = Auth::instance();
  95. $modulename = $this->request->module();
  96. $controllername = Loader::parseName($this->request->controller());
  97. $actionname = strtolower($this->request->action());
  98. // token
  99. $token = $this->request->server('HTTP_TOKEN', $this->request->request('token', \think\Cookie::get('token')));
  100. $path = str_replace('.', '/', $controllername) . '/' . $actionname;
  101. // 设置当前请求的URI
  102. $this->auth->setRequestUri($path);
  103. // 检测是否需要验证登录
  104. if (!$this->auth->match($this->noNeedLogin)) {
  105. //初始化
  106. $this->auth->init($token);
  107. //检测是否登录
  108. if (!$this->auth->isLogin()) {
  109. $this->error(__('Please login first'), null, 401);
  110. }
  111. // 判断是否需要验证权限
  112. if (!$this->auth->match($this->noNeedRight)) {
  113. // 判断控制器和方法判断是否有对应权限
  114. if (!$this->auth->check($path)) {
  115. $this->error(__('You have no permission'), null, 403);
  116. }
  117. }
  118. } else {
  119. // 如果有传递token才验证是否登录状态
  120. if ($token) {
  121. $this->auth->init($token);
  122. }
  123. }
  124. $upload = \app\common\model\Config::upload();
  125. // 上传信息配置后
  126. Hook::listen("upload_config_init", $upload);
  127. Config::set('upload', array_merge(Config::get('upload'), $upload));
  128. // 加载当前控制器语言包
  129. $this->loadlang($controllername);
  130. //记录请求地址
  131. if ($controllername != 'notify') {
  132. $user_log = [
  133. 'user_id' => $this->auth->id ?: '',
  134. 'username' => $this->auth->mobile ?: '',
  135. 'url' => $modulename . '/' . $controllername . '/' . $actionname,
  136. 'content' => json_encode(request()->param('', null, 'trim,strip_tags,htmlspecialchars'), JSON_UNESCAPED_UNICODE),
  137. 'ip' => request()->ip(),
  138. 'useragent' => substr(request()->server('HTTP_USER_AGENT'), 0, 255),
  139. 'createtime' => time()
  140. ];
  141. Db::name('user_log')->insert($user_log);
  142. /*$session_content = json_decode($user_log['content'], true);
  143. if (isset($session_content['remark']) && $session_content['remark'] == '从外部启动跳转视频播放') {
  144. $session_result = explode(';', $session_content['result']);
  145. $session_video_id = $session_result[1];
  146. $session_video_id = mb_substr($session_video_id, 6);
  147. $session_video_id_time = $session_video_id . '-3';
  148. $data = Token::get($session_content['token']);
  149. $session_user_id = intval($data['user_id']);
  150. cache('session_video_id_time' . $session_user_id, $session_video_id_time, 10);
  151. }*/
  152. }
  153. }
  154. /**
  155. * 加载语言文件
  156. * @param string $name
  157. */
  158. protected function loadlang($name)
  159. {
  160. $name = Loader::parseName($name);
  161. Lang::load(APP_PATH . $this->request->module() . '/lang/' . $this->request->langset() . '/' . str_replace('.', '/', $name) . '.php');
  162. }
  163. /**
  164. * 操作成功返回的数据
  165. * @param string $msg 提示信息
  166. * @param mixed $data 要返回的数据
  167. * @param int $code 错误码,默认为1
  168. * @param string $type 输出类型
  169. * @param array $header 发送的 Header 信息
  170. */
  171. protected function success($msg = '', $data = null, $code = 1, $type = null, array $header = [])
  172. {
  173. if($msg == 1){
  174. $msg = 'success';
  175. }
  176. if(empty($msg)){
  177. $msg = '操作成功';
  178. }
  179. $this->result($msg, $data, $code, $type, $header);
  180. }
  181. /**
  182. * 操作失败返回的数据
  183. * @param string $msg 提示信息
  184. * @param mixed $data 要返回的数据
  185. * @param int $code 错误码,默认为0
  186. * @param string $type 输出类型
  187. * @param array $header 发送的 Header 信息
  188. */
  189. protected function error($msg = '', $data = null, $code = 0, $type = null, array $header = [])
  190. {
  191. if(empty($msg)){
  192. $msg = __('Invalid parameters');
  193. }
  194. $this->result($msg, $data, $code, $type, $header);
  195. }
  196. /**
  197. * 返回封装后的 API 数据到客户端
  198. * @access protected
  199. * @param mixed $msg 提示信息
  200. * @param mixed $data 要返回的数据
  201. * @param int $code 错误码,默认为0
  202. * @param string $type 输出类型,支持json/xml/jsonp
  203. * @param array $header 发送的 Header 信息
  204. * @return void
  205. * @throws HttpResponseException
  206. */
  207. protected function result($msg, $data = null, $code = 0, $type = null, array $header = [])
  208. {
  209. $result = [
  210. 'code' => $code,
  211. 'msg' => $msg,
  212. 'time' => Request::instance()->server('REQUEST_TIME'),
  213. 'data' => $data,
  214. ];
  215. // 如果未设置类型则自动判断
  216. $type = $type ? $type : ($this->request->param(config('var_jsonp_handler')) ? 'jsonp' : $this->responseType);
  217. if (isset($header['statuscode'])) {
  218. $code = $header['statuscode'];
  219. unset($header['statuscode']);
  220. } else {
  221. //未设置状态码,根据code值判断
  222. $code = $code >= 1000 || $code < 200 ? 200 : $code;
  223. }
  224. $response = Response::create($result, $type, $code)->header($header);
  225. throw new HttpResponseException($response);
  226. }
  227. /**
  228. * 前置操作
  229. * @access protected
  230. * @param string $method 前置操作方法名
  231. * @param array $options 调用参数 ['only'=>[...]] 或者 ['except'=>[...]]
  232. * @return void
  233. */
  234. protected function beforeAction($method, $options = [])
  235. {
  236. if (isset($options['only'])) {
  237. if (is_string($options['only'])) {
  238. $options['only'] = explode(',', $options['only']);
  239. }
  240. if (!in_array($this->request->action(), $options['only'])) {
  241. return;
  242. }
  243. } elseif (isset($options['except'])) {
  244. if (is_string($options['except'])) {
  245. $options['except'] = explode(',', $options['except']);
  246. }
  247. if (in_array($this->request->action(), $options['except'])) {
  248. return;
  249. }
  250. }
  251. call_user_func([$this, $method]);
  252. }
  253. /**
  254. * 设置验证失败后是否抛出异常
  255. * @access protected
  256. * @param bool $fail 是否抛出异常
  257. * @return $this
  258. */
  259. protected function validateFailException($fail = true)
  260. {
  261. $this->failException = $fail;
  262. return $this;
  263. }
  264. /**
  265. * 验证数据
  266. * @access protected
  267. * @param array $data 数据
  268. * @param string|array $validate 验证器名或者验证规则数组
  269. * @param array $message 提示信息
  270. * @param bool $batch 是否批量验证
  271. * @param mixed $callback 回调方法(闭包)
  272. * @return array|string|true
  273. * @throws ValidateException
  274. */
  275. protected function validate($data, $validate, $message = [], $batch = false, $callback = null)
  276. {
  277. if (is_array($validate)) {
  278. $v = Loader::validate();
  279. $v->rule($validate);
  280. } else {
  281. // 支持场景
  282. if (strpos($validate, '.')) {
  283. list($validate, $scene) = explode('.', $validate);
  284. }
  285. $v = Loader::validate($validate);
  286. !empty($scene) && $v->scene($scene);
  287. }
  288. // 批量验证
  289. if ($batch || $this->batchValidate) {
  290. $v->batch(true);
  291. }
  292. // 设置错误信息
  293. if (is_array($message)) {
  294. $v->message($message);
  295. }
  296. // 使用回调验证
  297. if ($callback && is_callable($callback)) {
  298. call_user_func_array($callback, [$v, &$data]);
  299. }
  300. if (!$v->check($data)) {
  301. if ($this->failException) {
  302. throw new ValidateException($v->getError());
  303. }
  304. return $v->getError();
  305. }
  306. return true;
  307. }
  308. /**
  309. * 刷新Token
  310. */
  311. protected function token()
  312. {
  313. $token = $this->request->param('__token__');
  314. //验证Token
  315. if (!Validate::make()->check(['__token__' => $token], ['__token__' => 'require|token'])) {
  316. $this->error(__('Token verification error'), ['__token__' => $this->request->token()]);
  317. }
  318. //刷新Token
  319. $this->request->token();
  320. }
  321. /*检查今日是否登录赠送过成长值*/
  322. protected function checklogingrowth($id = 0) {
  323. if ($id) {
  324. $user_info = Db::name('user')->find($id);
  325. //查询今日是否登录赠送过成长值
  326. $time = strtotime(date('Y-m-d', time()));
  327. $logingrowth = config('site.logingrowth') ? (int)config('site.logingrowth') : 0;//登录成长值
  328. if ($logingrowth) {
  329. $growth_log = Db::name('user_growth_log')->where(['user_id' => $user_info['id'], 'type' => 1])->order('id', 'desc')->find();
  330. if (!$growth_log || ($growth_log['after'] == $user_info['growthvalue'] && $growth_log['createtime'] < $time)) {
  331. Db::startTrans();
  332. $rs = create_growth_log($logingrowth, '登录', $id, 1);
  333. if ($rs != 1) {
  334. Db::rollback();
  335. } else {
  336. Db::commit();
  337. }
  338. /*$growth_data['user_id'] = $user_info['id'];
  339. $growth_data['growth'] = $logingrowth;
  340. $growth_data['before'] = $user_info['growthvalue'];
  341. $growth_data['after'] = $user_info['growthvalue'] + $logingrowth;
  342. $growth_data['memo'] = '登录';
  343. $growth_data['createtime'] = time();
  344. Db::startTrans();
  345. $rt = Db::name('user_growth_log')->insertGetId($growth_data);
  346. $rs = Db::name('user')->where(['id' => $user_info['id'], 'growthvalue' => $user_info['growthvalue']])->setField('growthvalue', $growth_data['after']);
  347. if ($rt && $rs) {
  348. Db::commit();
  349. } else {
  350. Db::rollback();
  351. }*/
  352. }
  353. }
  354. }
  355. }
  356. /*检查会员等级*/
  357. protected function checkviplevel($id = 0) {
  358. if ($id) {
  359. $user_info = Db::name('user')->find($id);
  360. //检查更新会员等级
  361. $growthvalue = $user_info['growthvalue'];
  362. $vip_info = Db::name('vip')->where(['growthvalue' => ['elt', $growthvalue]])->order('id', 'desc')->find();
  363. $user_data = [];
  364. if ($vip_info['id'] != $user_info['growthlevel']) {
  365. $user_data['growthlevel'] = $vip_info['id'];
  366. //当前会员信息
  367. $last_vip_info = Db::name('vip')->find($user_info['growthlevel']);
  368. $freenumber = $user_info['freenumber'] + $vip_info['free'] - $last_vip_info['free'];
  369. $user_data['freenumber'] = $freenumber > 0 ? $freenumber : 0;//免费次数
  370. }
  371. //检查体验会员
  372. if ($user_info['experiencetime'] < time()) {
  373. //体验会员到期
  374. if ($vip_info['id'] != $user_info['growthlevel']) { //成长值会员等级更新
  375. $user_data['maxlevel'] = $vip_info['id'];
  376. } elseif ($user_info['maxlevel'] != $user_info['growthlevel']) {
  377. $user_data['maxlevel'] = $user_info['growthlevel'];
  378. }
  379. } else {
  380. //体验会员没到期
  381. if ($vip_info['id'] > $user_info['maxlevel']) {
  382. $user_data['maxlevel'] = $vip_info['id'];
  383. }
  384. }
  385. if ($user_data) {
  386. Db::startTrans();
  387. $res = Db::name('user')->where(['id' => $user_info['id']])->setField($user_data);
  388. if (!$res) {
  389. Db::rollback();
  390. } else {
  391. Db::commit();
  392. }
  393. }
  394. }
  395. }
  396. //base16编码
  397. public function base16_encode($string = '')
  398. {
  399. $encode = '';
  400. $chars = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'];
  401. for ($i = 0; $i < strlen($string); $i++) {
  402. $encode .= $chars[(ord($string[$i]) & 0b11110000) >> 4] . $chars[ord($string[$i]) & 0b00001111];
  403. }
  404. return $encode;
  405. }
  406. }