Url.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525
  1. <?php
  2. // +----------------------------------------------------------------------
  3. // | ThinkPHP [ WE CAN DO IT JUST THINK ]
  4. // +----------------------------------------------------------------------
  5. // | Copyright (c) 2006~2021 http://thinkphp.cn All rights reserved.
  6. // +----------------------------------------------------------------------
  7. // | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
  8. // +----------------------------------------------------------------------
  9. // | Author: liu21st <liu21st@gmail.com>
  10. // +----------------------------------------------------------------------
  11. declare (strict_types = 1);
  12. namespace think\route;
  13. use think\App;
  14. use think\Route;
  15. /**
  16. * 路由地址生成
  17. */
  18. class Url
  19. {
  20. /**
  21. * 应用对象
  22. * @var App
  23. */
  24. protected $app;
  25. /**
  26. * 路由对象
  27. * @var Route
  28. */
  29. protected $route;
  30. /**
  31. * URL变量
  32. * @var array
  33. */
  34. protected $vars = [];
  35. /**
  36. * 路由URL
  37. * @var string
  38. */
  39. protected $url;
  40. /**
  41. * URL 根地址
  42. * @var string
  43. */
  44. protected $root = '';
  45. /**
  46. * HTTPS
  47. * @var bool
  48. */
  49. protected $https;
  50. /**
  51. * URL后缀
  52. * @var string|bool
  53. */
  54. protected $suffix = true;
  55. /**
  56. * URL域名
  57. * @var string|bool
  58. */
  59. protected $domain = false;
  60. /**
  61. * 架构函数
  62. * @access public
  63. * @param string $url URL地址
  64. * @param array $vars 参数
  65. */
  66. public function __construct(Route $route, App $app, string $url = '', array $vars = [])
  67. {
  68. $this->route = $route;
  69. $this->app = $app;
  70. $this->url = $url;
  71. $this->vars = $vars;
  72. }
  73. /**
  74. * 设置URL参数
  75. * @access public
  76. * @param array $vars URL参数
  77. * @return $this
  78. */
  79. public function vars(array $vars = [])
  80. {
  81. $this->vars = $vars;
  82. return $this;
  83. }
  84. /**
  85. * 设置URL后缀
  86. * @access public
  87. * @param string|bool $suffix URL后缀
  88. * @return $this
  89. */
  90. public function suffix($suffix)
  91. {
  92. $this->suffix = $suffix;
  93. return $this;
  94. }
  95. /**
  96. * 设置URL域名(或者子域名)
  97. * @access public
  98. * @param string|bool $domain URL域名
  99. * @return $this
  100. */
  101. public function domain($domain)
  102. {
  103. $this->domain = $domain;
  104. return $this;
  105. }
  106. /**
  107. * 设置URL 根地址
  108. * @access public
  109. * @param string $root URL root
  110. * @return $this
  111. */
  112. public function root(string $root)
  113. {
  114. $this->root = $root;
  115. return $this;
  116. }
  117. /**
  118. * 设置是否使用HTTPS
  119. * @access public
  120. * @param bool $https
  121. * @return $this
  122. */
  123. public function https(bool $https = true)
  124. {
  125. $this->https = $https;
  126. return $this;
  127. }
  128. /**
  129. * 检测域名
  130. * @access protected
  131. * @param string $url URL
  132. * @param string|true $domain 域名
  133. * @return string
  134. */
  135. protected function parseDomain(string &$url, $domain): string
  136. {
  137. if (!$domain) {
  138. return '';
  139. }
  140. $request = $this->app->request;
  141. $rootDomain = $request->rootDomain();
  142. if (true === $domain) {
  143. // 自动判断域名
  144. $domain = $request->host();
  145. $domains = $this->route->getDomains();
  146. if (!empty($domains)) {
  147. $routeDomain = array_keys($domains);
  148. foreach ($routeDomain as $domainPrefix) {
  149. if (0 === strpos($domainPrefix, '*.') && strpos($domain, ltrim($domainPrefix, '*.')) !== false) {
  150. foreach ($domains as $key => $rule) {
  151. $rule = is_array($rule) ? $rule[0] : $rule;
  152. if (is_string($rule) && false === strpos($key, '*') && 0 === strpos($url, $rule)) {
  153. $url = ltrim($url, $rule);
  154. $domain = $key;
  155. // 生成对应子域名
  156. if (!empty($rootDomain)) {
  157. $domain .= $rootDomain;
  158. }
  159. break;
  160. } elseif (false !== strpos($key, '*')) {
  161. if (!empty($rootDomain)) {
  162. $domain .= $rootDomain;
  163. }
  164. break;
  165. }
  166. }
  167. }
  168. }
  169. }
  170. } elseif (false === strpos($domain, '.') && 0 !== strpos($domain, $rootDomain)) {
  171. $domain .= '.' . $rootDomain;
  172. }
  173. if (false !== strpos($domain, '://')) {
  174. $scheme = '';
  175. } else {
  176. $scheme = $this->https || $request->isSsl() ? 'https://' : 'http://';
  177. }
  178. return $scheme . $domain;
  179. }
  180. /**
  181. * 解析URL后缀
  182. * @access protected
  183. * @param string|bool $suffix 后缀
  184. * @return string
  185. */
  186. protected function parseSuffix($suffix): string
  187. {
  188. if ($suffix) {
  189. $suffix = true === $suffix ? $this->route->config('url_html_suffix') : $suffix;
  190. if (is_string($suffix) && $pos = strpos($suffix, '|')) {
  191. $suffix = substr($suffix, 0, $pos);
  192. }
  193. }
  194. return (empty($suffix) || 0 === strpos($suffix, '.')) ? (string) $suffix : '.' . $suffix;
  195. }
  196. /**
  197. * 直接解析URL地址
  198. * @access protected
  199. * @param string $url URL
  200. * @param string|bool $domain Domain
  201. * @return string
  202. */
  203. protected function parseUrl(string $url, &$domain): string
  204. {
  205. $request = $this->app->request;
  206. if (0 === strpos($url, '/')) {
  207. // 直接作为路由地址解析
  208. $url = substr($url, 1);
  209. } elseif (false !== strpos($url, '\\')) {
  210. // 解析到类
  211. $url = ltrim(str_replace('\\', '/', $url), '/');
  212. } elseif (0 === strpos($url, '@')) {
  213. // 解析到控制器
  214. $url = substr($url, 1);
  215. } elseif ('' === $url) {
  216. $url = $request->controller() . '/' . $request->action();
  217. } else {
  218. $controller = $request->controller();
  219. $path = explode('/', $url);
  220. $action = array_pop($path);
  221. $controller = empty($path) ? $controller : array_pop($path);
  222. $appName = empty($path) ? $this->app->http->getName() : array_pop($path);
  223. $controller = parse_name($controller, 0);
  224. if (empty($appName)) {
  225. $url = $controller . '/' . $action;
  226. } else {
  227. $url = $appName . '/' . $controller . '/' . $action;
  228. }
  229. }
  230. return $url;
  231. }
  232. /**
  233. * 分析路由规则中的变量
  234. * @access protected
  235. * @param string $rule 路由规则
  236. * @return array
  237. */
  238. protected function parseVar(string $rule): array
  239. {
  240. // 提取路由规则中的变量
  241. $var = [];
  242. if (preg_match_all('/<\w+\??>/', $rule, $matches)) {
  243. foreach ($matches[0] as $name) {
  244. $optional = false;
  245. if (strpos($name, '?')) {
  246. $name = substr($name, 1, -2);
  247. $optional = true;
  248. } else {
  249. $name = substr($name, 1, -1);
  250. }
  251. $var[$name] = $optional ? 2 : 1;
  252. }
  253. }
  254. return $var;
  255. }
  256. /**
  257. * 匹配路由地址
  258. * @access protected
  259. * @param array $rule 路由规则
  260. * @param array $vars 路由变量
  261. * @param mixed $allowDomain 允许域名
  262. * @return array
  263. */
  264. protected function getRuleUrl(array $rule, array &$vars = [], $allowDomain = ''): array
  265. {
  266. $request = $this->app->request;
  267. if (is_string($allowDomain) && false === strpos($allowDomain, '.')) {
  268. $allowDomain .= '.' . $request->rootDomain();
  269. }
  270. $port = $request->port();
  271. foreach ($rule as $item) {
  272. $url = $item['rule'];
  273. $pattern = $this->parseVar($url);
  274. $domain = $item['domain'];
  275. $suffix = $item['suffix'];
  276. if ('-' == $domain) {
  277. $domain = is_string($allowDomain) ? $allowDomain : $request->host(true);
  278. }
  279. if (is_string($allowDomain) && $domain != $allowDomain) {
  280. continue;
  281. }
  282. if ($port && !in_array($port, [80, 443])) {
  283. $domain .= ':' . $port;
  284. }
  285. if (empty($pattern)) {
  286. return [rtrim($url, '?/-'), $domain, $suffix];
  287. }
  288. $type = $this->route->config('url_common_param');
  289. $keys = [];
  290. foreach ($pattern as $key => $val) {
  291. if (isset($vars[$key])) {
  292. $url = str_replace(['[:' . $key . ']', '<' . $key . '?>', ':' . $key, '<' . $key . '>'], $type ? (string) $vars[$key] : urlencode((string) $vars[$key]), $url);
  293. $keys[] = $key;
  294. $url = str_replace(['/?', '-?'], ['/', '-'], $url);
  295. $result = [rtrim($url, '?/-'), $domain, $suffix];
  296. } elseif (2 == $val) {
  297. $url = str_replace(['/[:' . $key . ']', '[:' . $key . ']', '<' . $key . '?>'], '', $url);
  298. $url = str_replace(['/?', '-?'], ['/', '-'], $url);
  299. $result = [rtrim($url, '?/-'), $domain, $suffix];
  300. } else {
  301. $result = null;
  302. $keys = [];
  303. break;
  304. }
  305. }
  306. $vars = array_diff_key($vars, array_flip($keys));
  307. if (isset($result)) {
  308. return $result;
  309. }
  310. }
  311. return [];
  312. }
  313. /**
  314. * 生成URL地址
  315. * @access public
  316. * @return string
  317. */
  318. public function build()
  319. {
  320. // 解析URL
  321. $url = $this->url;
  322. $suffix = $this->suffix;
  323. $domain = $this->domain;
  324. $request = $this->app->request;
  325. $vars = $this->vars;
  326. if (0 === strpos($url, '[') && $pos = strpos($url, ']')) {
  327. // [name] 表示使用路由命名标识生成URL
  328. $name = substr($url, 1, $pos - 1);
  329. $url = 'name' . substr($url, $pos + 1);
  330. }
  331. if (false === strpos($url, '://') && 0 !== strpos($url, '/')) {
  332. $info = parse_url($url);
  333. $url = !empty($info['path']) ? $info['path'] : '';
  334. if (isset($info['fragment'])) {
  335. // 解析锚点
  336. $anchor = $info['fragment'];
  337. if (false !== strpos($anchor, '?')) {
  338. // 解析参数
  339. [$anchor, $info['query']] = explode('?', $anchor, 2);
  340. }
  341. if (false !== strpos($anchor, '@')) {
  342. // 解析域名
  343. [$anchor, $domain] = explode('@', $anchor, 2);
  344. }
  345. } elseif (strpos($url, '@') && false === strpos($url, '\\')) {
  346. // 解析域名
  347. [$url, $domain] = explode('@', $url, 2);
  348. }
  349. }
  350. if ($url) {
  351. $checkName = isset($name) ? $name : $url . (isset($info['query']) ? '?' . $info['query'] : '');
  352. $checkDomain = $domain && is_string($domain) ? $domain : null;
  353. $rule = $this->route->getName($checkName, $checkDomain);
  354. if (empty($rule) && isset($info['query'])) {
  355. $rule = $this->route->getName($url, $checkDomain);
  356. // 解析地址里面参数 合并到vars
  357. parse_str($info['query'], $params);
  358. $vars = array_merge($params, $vars);
  359. unset($info['query']);
  360. }
  361. }
  362. if (!empty($rule) && $match = $this->getRuleUrl($rule, $vars, $domain)) {
  363. // 匹配路由命名标识
  364. $url = $match[0];
  365. if ($domain && !empty($match[1])) {
  366. $domain = $match[1];
  367. }
  368. if (!is_null($match[2])) {
  369. $suffix = $match[2];
  370. }
  371. } elseif (!empty($rule) && isset($name)) {
  372. throw new \InvalidArgumentException('route name not exists:' . $name);
  373. } else {
  374. // 检测URL绑定
  375. $bind = $this->route->getDomainBind($domain && is_string($domain) ? $domain : null);
  376. if ($bind && 0 === strpos($url, $bind)) {
  377. $url = substr($url, strlen($bind) + 1);
  378. } else {
  379. $binds = $this->route->getBind();
  380. foreach ($binds as $key => $val) {
  381. if (is_string($val) && 0 === strpos($url, $val) && substr_count($val, '/') > 1) {
  382. $url = substr($url, strlen($val) + 1);
  383. $domain = $key;
  384. break;
  385. }
  386. }
  387. }
  388. // 路由标识不存在 直接解析
  389. $url = $this->parseUrl($url, $domain);
  390. if (isset($info['query'])) {
  391. // 解析地址里面参数 合并到vars
  392. parse_str($info['query'], $params);
  393. $vars = array_merge($params, $vars);
  394. }
  395. }
  396. // 还原URL分隔符
  397. $depr = $this->route->config('pathinfo_depr');
  398. $url = str_replace('/', $depr, $url);
  399. $file = $request->baseFile();
  400. if ($file && 0 !== strpos($request->url(), $file)) {
  401. $file = str_replace('\\', '/', dirname($file));
  402. }
  403. $url = rtrim($file, '/') . '/' . $url;
  404. // URL后缀
  405. if ('/' == substr($url, -1) || '' == $url) {
  406. $suffix = '';
  407. } else {
  408. $suffix = $this->parseSuffix($suffix);
  409. }
  410. // 锚点
  411. $anchor = !empty($anchor) ? '#' . $anchor : '';
  412. // 参数组装
  413. if (!empty($vars)) {
  414. // 添加参数
  415. if ($this->route->config('url_common_param')) {
  416. $vars = http_build_query($vars);
  417. $url .= $suffix . ($vars ? '?' . $vars : '') . $anchor;
  418. } else {
  419. foreach ($vars as $var => $val) {
  420. $val = (string) $val;
  421. if ('' !== $val) {
  422. $url .= $depr . $var . $depr . urlencode($val);
  423. }
  424. }
  425. $url .= $suffix . $anchor;
  426. }
  427. } else {
  428. $url .= $suffix . $anchor;
  429. }
  430. // 检测域名
  431. $domain = $this->parseDomain($url, $domain);
  432. // URL组装
  433. return $domain . rtrim($this->root, '/') . '/' . ltrim($url, '/');
  434. }
  435. public function __toString()
  436. {
  437. return $this->build();
  438. }
  439. public function __debugInfo()
  440. {
  441. return [
  442. 'url' => $this->url,
  443. 'vars' => $this->vars,
  444. 'suffix' => $this->suffix,
  445. 'domain' => $this->domain,
  446. ];
  447. }
  448. }