Admin.php 13 KB

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