Admin.php 13 KB

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