Api.php 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  1. <?php
  2. namespace app\admin\command;
  3. use app\admin\command\Api\library\Builder;
  4. use think\Config;
  5. use think\console\Command;
  6. use think\console\Input;
  7. use think\console\input\Option;
  8. use think\console\Output;
  9. use think\Exception;
  10. class Api extends Command
  11. {
  12. protected function configure()
  13. {
  14. $site = Config::get('site');
  15. $this
  16. ->setName('api')
  17. ->addOption('url', 'u', Option::VALUE_OPTIONAL, 'default api url', '')
  18. ->addOption('module', 'm', Option::VALUE_OPTIONAL, 'module name(admin/index/api)', 'api')
  19. ->addOption('output', 'o', Option::VALUE_OPTIONAL, 'output index file name', 'api.html')
  20. ->addOption('template', 'e', Option::VALUE_OPTIONAL, '', 'index.html')
  21. ->addOption('force', 'f', Option::VALUE_OPTIONAL, 'force override general file', false)
  22. ->addOption('title', 't', Option::VALUE_OPTIONAL, 'document title', $site['name'])
  23. ->addOption('class', 'c', Option::VALUE_OPTIONAL | Option::VALUE_IS_ARRAY, 'extend class', null)
  24. ->addOption('language', 'l', Option::VALUE_OPTIONAL, 'language', 'zh-cn')
  25. ->addOption('addon', 'a', Option::VALUE_OPTIONAL, 'addon name', null)
  26. ->addOption('controller', 'r', Option::VALUE_REQUIRED | Option::VALUE_IS_ARRAY, 'controller name', null)
  27. ->setDescription('Build Api document from controller');
  28. }
  29. protected function execute(Input $input, Output $output)
  30. {
  31. $apiDir = __DIR__ . DS . 'Api' . DS;
  32. $force = $input->getOption('force');
  33. $url = $input->getOption('url');
  34. $language = $input->getOption('language');
  35. $template = $input->getOption('template');
  36. if (!preg_match("/^([a-z0-9]+)\.html\$/i", $template)) {
  37. throw new Exception('template file not correct');
  38. }
  39. $language = $language ? $language : 'zh-cn';
  40. $langFile = $apiDir . 'lang' . DS . $language . '.php';
  41. if (!is_file($langFile)) {
  42. throw new Exception('language file not found');
  43. }
  44. $lang = include_once $langFile;
  45. // 目标目录
  46. $output_dir = ROOT_PATH . 'public' . DS;
  47. $output_file = $output_dir . $input->getOption('output');
  48. if (is_file($output_file) && !$force) {
  49. throw new Exception("api index file already exists!\nIf you need to rebuild again, use the parameter --force=true ");
  50. }
  51. // 模板文件
  52. $template_dir = $apiDir . 'template' . DS;
  53. $template_file = $template_dir . $template;
  54. if (!is_file($template_file)) {
  55. throw new Exception('template file not found');
  56. }
  57. // 额外的类
  58. $classes = $input->getOption('class');
  59. // 标题
  60. $title = $input->getOption('title');
  61. // 模块
  62. $module = $input->getOption('module');
  63. // 插件
  64. $addon = $input->getOption('addon');
  65. $moduleDir = $addonDir = '';
  66. if ($addon) {
  67. $addonInfo = get_addon_info($addon);
  68. if (!$addonInfo) {
  69. throw new Exception('addon not found');
  70. }
  71. $moduleDir = ADDON_PATH . $addon . DS;
  72. } else {
  73. $moduleDir = APP_PATH . $module . DS;
  74. }
  75. if (!is_dir($moduleDir)) {
  76. throw new Exception('module not found');
  77. }
  78. if (version_compare(PHP_VERSION, '7.0.0', '<')) {
  79. if (extension_loaded('Zend OPcache')) {
  80. $configuration = opcache_get_configuration();
  81. $directives = $configuration['directives'];
  82. $configName = request()->isCli() ? 'opcache.enable_cli' : 'opcache.enable';
  83. if (!$directives[$configName]) {
  84. throw new Exception("Please make sure {$configName} is turned on, Get help:https://forum.fastadmin.net/d/1321");
  85. }
  86. } else {
  87. throw new Exception("Please make sure opcache already enabled, Get help:https://forum.fastadmin.net/d/1321");
  88. }
  89. }
  90. //控制器名
  91. $controller = $input->getOption('controller') ?: [];
  92. if (!$controller) {
  93. $controllerDir = $moduleDir . Config::get('url_controller_layer') . DS;
  94. $files = new \RecursiveIteratorIterator(
  95. new \RecursiveDirectoryIterator($controllerDir),
  96. \RecursiveIteratorIterator::LEAVES_ONLY
  97. );
  98. foreach ($files as $name => $file) {
  99. if (!$file->isDir() && $file->getExtension() == 'php') {
  100. $filePath = $file->getRealPath();
  101. $classes[] = $this->get_class_from_file($filePath);
  102. }
  103. }
  104. } else {
  105. foreach ($controller as $index => $item) {
  106. $filePath = $moduleDir . Config::get('url_controller_layer') . DS . $item . '.php';
  107. $classes[] = $this->get_class_from_file($filePath);
  108. }
  109. }
  110. $classes = array_unique(array_filter($classes));
  111. $config = [
  112. 'sitename' => config('site.name'),
  113. 'title' => $title,
  114. 'author' => config('site.name'),
  115. 'description' => '',
  116. 'apiurl' => $url,
  117. 'language' => $language,
  118. ];
  119. try {
  120. $builder = new Builder($classes);
  121. $content = $builder->render($template_file, ['config' => $config, 'lang' => $lang]);
  122. } catch (\Exception $e) {
  123. print_r($e);
  124. }
  125. if (!file_put_contents($output_file, $content)) {
  126. throw new Exception('Cannot save the content to ' . $output_file);
  127. }
  128. $output->info("Build Successed!");
  129. }
  130. /**
  131. * get full qualified class name
  132. *
  133. * @param string $path_to_file
  134. * @return string
  135. * @author JBYRNE http://jarretbyrne.com/2015/06/197/
  136. */
  137. protected function get_class_from_file($path_to_file)
  138. {
  139. //Grab the contents of the file
  140. $contents = file_get_contents($path_to_file);
  141. //Start with a blank namespace and class
  142. $namespace = $class = "";
  143. //Set helper values to know that we have found the namespace/class token and need to collect the string values after them
  144. $getting_namespace = $getting_class = false;
  145. //Go through each token and evaluate it as necessary
  146. foreach (token_get_all($contents) as $token) {
  147. //If this token is the namespace declaring, then flag that the next tokens will be the namespace name
  148. if (is_array($token) && $token[0] == T_NAMESPACE) {
  149. $getting_namespace = true;
  150. }
  151. //If this token is the class declaring, then flag that the next tokens will be the class name
  152. if (is_array($token) && $token[0] == T_CLASS) {
  153. $getting_class = true;
  154. }
  155. //While we're grabbing the namespace name...
  156. if ($getting_namespace === true) {
  157. //If the token is a string or the namespace separator...
  158. if (is_array($token) && in_array($token[0], [T_STRING, T_NS_SEPARATOR])) {
  159. //Append the token's value to the name of the namespace
  160. $namespace .= $token[1];
  161. } elseif ($token === ';') {
  162. //If the token is the semicolon, then we're done with the namespace declaration
  163. $getting_namespace = false;
  164. }
  165. }
  166. //While we're grabbing the class name...
  167. if ($getting_class === true) {
  168. //If the token is a string, it's the name of the class
  169. if (is_array($token) && $token[0] == T_STRING) {
  170. //Store the token's value as the class name
  171. $class = $token[1];
  172. //Got what we need, stope here
  173. break;
  174. }
  175. }
  176. }
  177. //Build the fully-qualified class name and return it
  178. return $namespace ? $namespace . '\\' . $class : $class;
  179. }
  180. }