Admin.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567
  1. <?php
  2. namespace Dcat\Admin;
  3. use Closure;
  4. use Dcat\Admin\Contracts\ExceptionHandler;
  5. use Dcat\Admin\Contracts\Repository;
  6. use Dcat\Admin\Exception\InvalidArgumentException;
  7. use Dcat\Admin\Http\Controllers\AuthController;
  8. use Dcat\Admin\Http\JsonResponse;
  9. use Dcat\Admin\Layout\Menu;
  10. use Dcat\Admin\Layout\Navbar;
  11. use Dcat\Admin\Layout\SectionManager;
  12. use Dcat\Admin\Repositories\EloquentRepository;
  13. use Dcat\Admin\Support\Composer;
  14. use Dcat\Admin\Traits\HasAssets;
  15. use Dcat\Admin\Traits\HasHtml;
  16. use Dcat\Admin\Traits\HasPermissions;
  17. use Illuminate\Auth\GuardHelpers;
  18. use Illuminate\Contracts\Auth\Authenticatable;
  19. use Illuminate\Database\Eloquent\Builder;
  20. use Illuminate\Database\Eloquent\Model;
  21. use Illuminate\Http\Exceptions\HttpResponseException;
  22. use Illuminate\Support\Facades\Auth;
  23. use Illuminate\Support\Facades\Event;
  24. use Illuminate\Support\Str;
  25. use Symfony\Component\HttpFoundation\Response;
  26. class Admin
  27. {
  28. use HasAssets;
  29. use HasHtml;
  30. const VERSION = '2.0.16-beta';
  31. const SECTION = [
  32. // 往 <head> 标签内输入内容
  33. 'HEAD' => 'ADMIN_HEAD',
  34. // 往body标签内部输入内容
  35. 'BODY_INNER_BEFORE' => 'ADMIN_BODY_INNER_BEFORE',
  36. 'BODY_INNER_AFTER' => 'ADMIN_BODY_INNER_AFTER',
  37. // 往#app内部输入内容
  38. 'APP_INNER_BEFORE' => 'ADMIN_APP_INNER_BEFORE',
  39. 'APP_INNER_AFTER' => 'ADMIN_APP_INNER_AFTER',
  40. // 顶部导航栏用户面板
  41. 'NAVBAR_USER_PANEL' => 'ADMIN_NAVBAR_USER_PANEL',
  42. 'NAVBAR_AFTER_USER_PANEL' => 'ADMIN_NAVBAR_AFTER_USER_PANEL',
  43. // 侧边栏顶部用户信息面板
  44. 'LEFT_SIDEBAR_USER_PANEL' => 'ADMIN_LEFT_SIDEBAR_USER_PANEL',
  45. // 菜单栏
  46. 'LEFT_SIDEBAR_MENU' => 'ADMIN_LEFT_SIDEBAR_MENU',
  47. // 菜单栏顶部
  48. 'LEFT_SIDEBAR_MENU_TOP' => 'ADMIN_LEFT_SIDEBAR_MENU_TOP',
  49. // 菜单栏底部
  50. 'LEFT_SIDEBAR_MENU_BOTTOM' => 'ADMIN_LEFT_SIDEBAR_MENU_BOTTOM',
  51. ];
  52. private static $defaultPjaxContainerId = 'pjax-container';
  53. /**
  54. * 版本.
  55. *
  56. * @return string
  57. */
  58. public static function longVersion()
  59. {
  60. return sprintf('Dcat Admin <comment>version</comment> <info>%s</info>', static::VERSION);
  61. }
  62. /**
  63. * @return Color
  64. */
  65. public static function color()
  66. {
  67. return app('admin.color');
  68. }
  69. /**
  70. * 菜单管理.
  71. *
  72. * @param Closure|null $builder
  73. *
  74. * @return Menu
  75. */
  76. public static function menu(Closure $builder = null)
  77. {
  78. $menu = app('admin.menu');
  79. $builder && $builder($menu);
  80. return $menu;
  81. }
  82. /**
  83. * 设置 title.
  84. *
  85. * @return string|void
  86. */
  87. public static function title($title = null)
  88. {
  89. if ($title === null) {
  90. return static::context()->metaTitle ?: config('admin.title');
  91. }
  92. static::context()->metaTitle = $title;
  93. }
  94. /**
  95. * @param null|string $favicon
  96. *
  97. * @return string|void
  98. */
  99. public static function favicon($favicon = null)
  100. {
  101. if ($favicon === null) {
  102. return static::context()->favicon;
  103. }
  104. static::context()->favicon = $favicon;
  105. }
  106. /**
  107. * 获取登录用户模型.
  108. *
  109. * @return Model|Authenticatable|HasPermissions
  110. */
  111. public static function user()
  112. {
  113. return static::guard()->user();
  114. }
  115. /**
  116. * @return \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard|GuardHelpers
  117. */
  118. public static function guard()
  119. {
  120. return Auth::guard(config('admin.auth.guard') ?: 'admin');
  121. }
  122. /**
  123. * @param Closure|null $builder
  124. *
  125. * @return Navbar
  126. */
  127. public static function navbar(Closure $builder = null)
  128. {
  129. $navbar = app('admin.navbar');
  130. $builder && $builder($navbar);
  131. return $navbar;
  132. }
  133. /**
  134. * 禁用pjax.
  135. */
  136. public static function disablePjax()
  137. {
  138. static::context()->pjaxContainerId = false;
  139. }
  140. /**
  141. * @return string|void
  142. */
  143. public static function getPjaxContainerId()
  144. {
  145. $id = static::context()->pjaxContainerId;
  146. if ($id === false) {
  147. return;
  148. }
  149. return $id ?: static::$defaultPjaxContainerId;
  150. }
  151. /**
  152. * section.
  153. *
  154. * @param Closure|null $builder
  155. *
  156. * @return SectionManager
  157. */
  158. public static function section(Closure $builder = null)
  159. {
  160. $manager = app('admin.sections');
  161. $builder && $builder($manager);
  162. return $manager;
  163. }
  164. /**
  165. * 配置.
  166. *
  167. * @return \Dcat\Admin\Support\Setting
  168. */
  169. public static function setting()
  170. {
  171. return app('admin.setting');
  172. }
  173. /**
  174. * 创建数据仓库实例.
  175. *
  176. * @param string|Repository|Model|Builder $value
  177. * @param array $args
  178. *
  179. * @return Repository
  180. */
  181. public static function repository($repository, array $args = [])
  182. {
  183. if (is_string($repository)) {
  184. $repository = new $repository($args);
  185. }
  186. if ($repository instanceof Model || $repository instanceof Builder) {
  187. $repository = EloquentRepository::make($repository);
  188. }
  189. if (! $repository instanceof Repository) {
  190. $class = is_object($repository) ? get_class($repository) : $repository;
  191. throw new InvalidArgumentException("The class [{$class}] must be a type of [".Repository::class.'].');
  192. }
  193. return $repository;
  194. }
  195. /**
  196. * 应用管理.
  197. *
  198. * @return Application
  199. */
  200. public static function app()
  201. {
  202. return app('admin.app');
  203. }
  204. /**
  205. * 处理异常.
  206. *
  207. * @param \Throwable $e
  208. *
  209. * @return mixed
  210. */
  211. public static function handleException(\Throwable $e)
  212. {
  213. return app(ExceptionHandler::class)->handle($e);
  214. }
  215. /**
  216. * 上报异常.
  217. *
  218. * @param \Throwable $e
  219. *
  220. * @return mixed
  221. */
  222. public static function reportException(\Throwable $e)
  223. {
  224. return app(ExceptionHandler::class)->report($e);
  225. }
  226. /**
  227. * 显示异常信息.
  228. *
  229. * @param \Throwable $e
  230. *
  231. * @return mixed
  232. */
  233. public static function renderException(\Throwable $e)
  234. {
  235. return app(ExceptionHandler::class)->render($e);
  236. }
  237. /**
  238. * @param callable $callback
  239. */
  240. public static function booting($callback)
  241. {
  242. Event::listen('admin:booting', $callback);
  243. }
  244. /**
  245. * @param callable $callback
  246. */
  247. public static function booted($callback)
  248. {
  249. Event::listen('admin:booted', $callback);
  250. }
  251. /**
  252. * @return void
  253. */
  254. public static function callBooting()
  255. {
  256. Event::dispatch('admin:booting');
  257. }
  258. /**
  259. * @return void
  260. */
  261. public static function callBooted()
  262. {
  263. Event::dispatch('admin:booted');
  264. }
  265. /**
  266. * @return \Dcat\Admin\Support\Context
  267. */
  268. public static function context()
  269. {
  270. return app('admin.context');
  271. }
  272. /**
  273. * @param array|string $name
  274. *
  275. * @return void
  276. */
  277. public static function addIgnoreQueryName($name)
  278. {
  279. $context = static::context();
  280. $ignoreQueries = $context->ignoreQueries ?? [];
  281. $context->ignoreQueries = array_merge($ignoreQueries, (array) $name);
  282. }
  283. /**
  284. * @return array
  285. */
  286. public static function getIgnoreQueryNames()
  287. {
  288. return static::context()->ignoreQueries ?? [];
  289. }
  290. /**
  291. * 响应json数据.
  292. *
  293. * @param array $data
  294. *
  295. * @return JsonResponse
  296. */
  297. public static function json(array $data = [])
  298. {
  299. return JsonResponse::make($data);
  300. }
  301. /**
  302. * 插件管理.
  303. *
  304. * @param string $name
  305. *
  306. * @return \Dcat\Admin\Extend\Manager|\Dcat\Admin\Extend\ServiceProvider|null
  307. */
  308. public static function extension(?string $name = null)
  309. {
  310. if ($name) {
  311. return app('admin.extend')->get($name);
  312. }
  313. return app('admin.extend');
  314. }
  315. /**
  316. * 响应并中断后续逻辑.
  317. *
  318. * @param Response|string|array $response
  319. *
  320. * @throws HttpResponseException
  321. */
  322. public static function exit($response = '')
  323. {
  324. if (is_array($response)) {
  325. $response = response()->json($response);
  326. } elseif ($response instanceof JsonResponse) {
  327. $response = $response->send();
  328. }
  329. throw new HttpResponseException($response instanceof Response ? $response : response($response));
  330. }
  331. /**
  332. * 类自动加载器.
  333. *
  334. * @return \Composer\Autoload\ClassLoader
  335. */
  336. public static function classLoader()
  337. {
  338. return Composer::loader();
  339. }
  340. /**
  341. * 往分组插入中间件.
  342. *
  343. * @param array $mix
  344. */
  345. public static function mixMiddlewareGroup(array $mix = [])
  346. {
  347. $router = app('router');
  348. $group = $router->getMiddlewareGroups()['admin'] ?? [];
  349. if ($mix) {
  350. $finalGroup = [];
  351. foreach ($group as $i => $mid) {
  352. $next = $i + 1;
  353. $finalGroup[] = $mid;
  354. if (! isset($group[$next]) || $group[$next] !== 'admin.permission') {
  355. continue;
  356. }
  357. $finalGroup = array_merge($finalGroup, $mix);
  358. $mix = [];
  359. }
  360. if ($mix) {
  361. $finalGroup = array_merge($finalGroup, $mix);
  362. }
  363. $group = $finalGroup;
  364. }
  365. $router->middlewareGroup('admin', $group);
  366. }
  367. /**
  368. * 获取js配置.
  369. *
  370. * @param array|null $variables
  371. *
  372. * @return string
  373. */
  374. public static function jsVariables(array $variables = null)
  375. {
  376. $jsVariables = static::context()->jsVariables ?: [];
  377. if ($variables !== null) {
  378. static::context()->jsVariables = array_merge(
  379. $jsVariables,
  380. $variables
  381. );
  382. return;
  383. }
  384. $sidebarStyle = config('admin.layout.sidebar_style') ?: 'light';
  385. $jsVariables['pjax_container_selector'] = '#'.static::getPjaxContainerId();
  386. $jsVariables['token'] = csrf_token();
  387. $jsVariables['lang'] = __('admin.client') ?: [];
  388. $jsVariables['colors'] = static::color()->all();
  389. $jsVariables['dark_mode'] = Str::contains(config('admin.layout.body_class'), 'dark-mode');
  390. $jsVariables['sidebar_dark'] = config('admin.layout.sidebar_dark') || ($sidebarStyle === 'dark');
  391. $jsVariables['sidebar_light_style'] = in_array($sidebarStyle, ['dark', 'light'], true) ? 'sidebar-light-primary' : 'sidebar-primary';
  392. return admin_javascript_json($jsVariables);
  393. }
  394. /**
  395. * 注册路由.
  396. *
  397. * @return void
  398. */
  399. public static function routes()
  400. {
  401. $attributes = [
  402. 'domain' => config('admin.route.domain'),
  403. 'prefix' => config('admin.route.prefix'),
  404. 'middleware' => config('admin.route.middleware'),
  405. 'as' => static::app()->getName().'.',
  406. ];
  407. if (config('admin.auth.enable', true)) {
  408. app('router')->group($attributes, function ($router) {
  409. /* @var \Illuminate\Routing\Router $router */
  410. $router->namespace('Dcat\Admin\Http\Controllers')->group(function ($router) {
  411. /* @var \Illuminate\Routing\Router $router */
  412. $router->resource('auth/users', 'UserController');
  413. $router->resource('auth/menu', 'MenuController', ['except' => ['create', 'show']]);
  414. if (config('admin.permission.enable')) {
  415. $router->resource('auth/roles', 'RoleController');
  416. $router->resource('auth/permissions', 'PermissionController');
  417. }
  418. });
  419. $router->resource('auth/extensions', 'Dcat\Admin\Http\Controllers\ExtensionController', ['only' => ['index', 'store', 'update']]);
  420. $authController = config('admin.auth.controller', AuthController::class);
  421. $router->get('auth/login', $authController.'@getLogin');
  422. $router->post('auth/login', $authController.'@postLogin');
  423. $router->get('auth/logout', $authController.'@getLogout');
  424. $router->get('auth/setting', $authController.'@getSetting');
  425. $router->put('auth/setting', $authController.'@putSetting');
  426. });
  427. }
  428. static::registerHelperRoutes();
  429. }
  430. /**
  431. * 注册api路由.
  432. *
  433. * @param string $as
  434. *
  435. * @return void
  436. */
  437. public static function registerApiRoutes(string $as = null)
  438. {
  439. $attributes = [
  440. 'domain' => config('admin.route.domain'),
  441. 'prefix' => admin_base_path('dcat-api'),
  442. 'middleware' => config('admin.route.middleware'),
  443. 'as' => $as ?: static::app()->getApiRoutePrefix(Application::DEFAULT),
  444. 'namespace' => 'Dcat\Admin\Http\Controllers',
  445. ];
  446. app('router')->group($attributes, function ($router) {
  447. /* @var \Illuminate\Routing\Router $router */
  448. $router->post('action', 'HandleActionController@handle')->name('action');
  449. $router->post('form', 'HandleFormController@handle')->name('form');
  450. $router->post('form/upload', 'HandleFormController@uploadFile')->name('form.upload');
  451. $router->post('form/destroy-file', 'HandleFormController@destroyFile')->name('form.destroy-file');
  452. $router->post('value', 'ValueController@handle')->name('value');
  453. $router->get('render', 'RenderableController@handle')->name('render');
  454. $router->post('tinymce/upload', 'TinymceController@upload')->name('tinymce.upload');
  455. $router->post('editor-md/upload', 'EditorMDController@upload')->name('editor-md.upload');
  456. });
  457. }
  458. /**
  459. * 注册开发工具路由.
  460. *
  461. * @return void
  462. */
  463. public static function registerHelperRoutes()
  464. {
  465. if (! config('admin.helpers.enable', true) || ! config('app.debug')) {
  466. return;
  467. }
  468. $attributes = [
  469. 'domain' => config('admin.route.domain'),
  470. 'prefix' => config('admin.route.prefix'),
  471. 'middleware' => config('admin.route.middleware'),
  472. 'as' => static::app()->getName().'.',
  473. ];
  474. app('router')->group($attributes, function ($router) {
  475. /* @var \Illuminate\Routing\Router $router */
  476. $router->get('helpers/scaffold', 'Dcat\Admin\Http\Controllers\ScaffoldController@index');
  477. $router->post('helpers/scaffold', 'Dcat\Admin\Http\Controllers\ScaffoldController@store');
  478. $router->post('helpers/scaffold/table', 'Dcat\Admin\Http\Controllers\ScaffoldController@table');
  479. $router->get('helpers/icons', 'Dcat\Admin\Http\Controllers\IconController@index');
  480. });
  481. }
  482. }