Admin.php 15 KB

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