Admin.php 14 KB

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