command.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532
  1. package commands
  2. import (
  3. "encoding/gob"
  4. "flag"
  5. "fmt"
  6. "log"
  7. "net/url"
  8. "os"
  9. "path/filepath"
  10. "strings"
  11. "time"
  12. "bytes"
  13. "encoding/json"
  14. "net/http"
  15. "github.com/beego/beego/v2/adapter"
  16. "github.com/beego/beego/v2/adapter/orm"
  17. beegoCache "github.com/beego/beego/v2/client/cache"
  18. _ "github.com/beego/beego/v2/client/cache/memcache"
  19. "github.com/beego/beego/v2/client/cache/redis"
  20. _ "github.com/beego/beego/v2/client/cache/redis"
  21. "github.com/beego/beego/v2/core/logs"
  22. "github.com/beego/beego/v2/server/web"
  23. "github.com/howeyc/fsnotify"
  24. "github.com/lifei6671/gocaptcha"
  25. "github.com/mindoc-org/mindoc/cache"
  26. "github.com/mindoc-org/mindoc/conf"
  27. "github.com/mindoc-org/mindoc/models"
  28. "github.com/mindoc-org/mindoc/utils/filetil"
  29. )
  30. // RegisterDataBase 注册数据库
  31. func RegisterDataBase() {
  32. logs.Info("正在初始化数据库配置.")
  33. dbadapter,_ := web.AppConfig.String("db_adapter")
  34. orm.DefaultTimeLoc = time.Local
  35. orm.DefaultRowsLimit = -1
  36. if strings.EqualFold(dbadapter, "mysql") {
  37. host,_ := web.AppConfig.String("db_host")
  38. database, _ := web.AppConfig.String("db_database")
  39. username,_ := web.AppConfig.String("db_username")
  40. password,_ := web.AppConfig.String("db_password")
  41. timezone,_ := web.AppConfig.String("timezone")
  42. location, err := time.LoadLocation(timezone)
  43. if err == nil {
  44. orm.DefaultTimeLoc = location
  45. } else {
  46. logs.Error("加载时区配置信息失败,请检查是否存在 ZONEINFO 环境变量->", err)
  47. }
  48. port,_ := web.AppConfig.String("db_port")
  49. dataSource := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=true&loc=%s", username, password, host, port, database, url.QueryEscape(timezone))
  50. if err := orm.RegisterDataBase("default", "mysql", dataSource); err != nil {
  51. logs.Error("注册默认数据库失败->", err)
  52. os.Exit(1)
  53. }
  54. } else if strings.EqualFold(dbadapter, "sqlite3") {
  55. database,_ := web.AppConfig.String("db_database")
  56. if strings.HasPrefix(database, "./") {
  57. database = filepath.Join(conf.WorkingDirectory, string(database[1:]))
  58. }
  59. if p, err := filepath.Abs(database); err == nil {
  60. database = p
  61. }
  62. dbPath := filepath.Dir(database)
  63. if _, err := os.Stat(dbPath); err != nil && os.IsNotExist(err) {
  64. _ = os.MkdirAll(dbPath, 0777)
  65. }
  66. err := orm.RegisterDataBase("default", "sqlite3", database)
  67. if err != nil {
  68. logs.Error("注册默认数据库失败->", err)
  69. }
  70. } else {
  71. logs.Error("不支持的数据库类型.")
  72. os.Exit(1)
  73. }
  74. logs.Info("数据库初始化完成.")
  75. }
  76. // RegisterModel 注册Model
  77. func RegisterModel() {
  78. orm.RegisterModelWithPrefix(conf.GetDatabasePrefix(),
  79. new(models.Member),
  80. new(models.Book),
  81. new(models.Relationship),
  82. new(models.Option),
  83. new(models.Document),
  84. new(models.Attachment),
  85. new(models.Logger),
  86. new(models.MemberToken),
  87. new(models.DocumentHistory),
  88. new(models.Migration),
  89. new(models.Label),
  90. new(models.Blog),
  91. new(models.Template),
  92. new(models.Team),
  93. new(models.TeamMember),
  94. new(models.TeamRelationship),
  95. new(models.Itemsets),
  96. )
  97. gob.Register(models.Blog{})
  98. gob.Register(models.Document{})
  99. gob.Register(models.Template{})
  100. //migrate.RegisterMigration()
  101. }
  102. // RegisterLogger 注册日志
  103. func RegisterLogger(log string) {
  104. logs.SetLogFuncCall(true)
  105. _ = logs.SetLogger("console")
  106. logs.EnableFuncCallDepth(true)
  107. if web.AppConfig.DefaultBool("log_is_async", true) {
  108. logs.Async(1e3)
  109. }
  110. if log == "" {
  111. logPath, err := filepath.Abs(web.AppConfig.DefaultString("log_path", conf.WorkingDir("runtime", "logs")))
  112. if err == nil {
  113. log = logPath
  114. } else {
  115. log = conf.WorkingDir("runtime", "logs")
  116. }
  117. }
  118. logPath := filepath.Join(log, "log.log")
  119. if _, err := os.Stat(log); os.IsNotExist(err) {
  120. _ = os.MkdirAll(log, 0755)
  121. }
  122. config := make(map[string]interface{}, 1)
  123. config["filename"] = logPath
  124. config["perm"] = "0755"
  125. config["rotate"] = true
  126. if maxLines := web.AppConfig.DefaultInt("log_maxlines", 1000000); maxLines > 0 {
  127. config["maxLines"] = maxLines
  128. }
  129. if maxSize := web.AppConfig.DefaultInt("log_maxsize", 1<<28); maxSize > 0 {
  130. config["maxsize"] = maxSize
  131. }
  132. if !web.AppConfig.DefaultBool("log_daily", true) {
  133. config["daily"] = false
  134. }
  135. if maxDays := web.AppConfig.DefaultInt("log_maxdays", 7); maxDays > 0 {
  136. config["maxdays"] = maxDays
  137. }
  138. if level := web.AppConfig.DefaultString("log_level", "Trace"); level != "" {
  139. switch level {
  140. case "Emergency":
  141. config["level"] = logs.LevelEmergency
  142. break
  143. case "Alert":
  144. config["level"] = logs.LevelAlert
  145. break
  146. case "Critical":
  147. config["level"] = logs.LevelCritical
  148. break
  149. case "Error":
  150. config["level"] = logs.LevelError
  151. break
  152. case "Warning":
  153. config["level"] = logs.LevelWarning
  154. break
  155. case "Notice":
  156. config["level"] = logs.LevelNotice
  157. break
  158. case "Informational":
  159. config["level"] = logs.LevelInformational
  160. break
  161. case "Debug":
  162. config["level"] = logs.LevelDebug
  163. break
  164. }
  165. }
  166. b, err := json.Marshal(config)
  167. if err != nil {
  168. logs.Error("初始化文件日志时出错 ->", err)
  169. _ = logs.SetLogger("file", `{"filename":"`+logPath+`"}`)
  170. } else {
  171. _ = logs.SetLogger(logs.AdapterFile, string(b))
  172. }
  173. logs.SetLogFuncCall(true)
  174. }
  175. // RunCommand 注册orm命令行工具
  176. func RegisterCommand() {
  177. if len(os.Args) >= 2 && os.Args[1] == "install" {
  178. ResolveCommand(os.Args[2:])
  179. Install()
  180. } else if len(os.Args) >= 2 && os.Args[1] == "version" {
  181. CheckUpdate()
  182. os.Exit(0)
  183. }
  184. }
  185. //注册模板函数
  186. func RegisterFunction() {
  187. err := adapter.AddFuncMap("config", models.GetOptionValue)
  188. if err != nil {
  189. logs.Error("注册函数 config 出错 ->", err)
  190. os.Exit(-1)
  191. }
  192. err = adapter.AddFuncMap("cdn", func(p string) string {
  193. cdn := web.AppConfig.DefaultString("cdn", "")
  194. if strings.HasPrefix(p, "http://") || strings.HasPrefix(p, "https://") {
  195. return p
  196. }
  197. //如果没有设置cdn,则使用baseURL拼接
  198. if cdn == "" {
  199. baseUrl := web.AppConfig.DefaultString("baseurl", "")
  200. if strings.HasPrefix(p, "/") && strings.HasSuffix(baseUrl, "/") {
  201. return baseUrl + p[1:]
  202. }
  203. if !strings.HasPrefix(p, "/") && !strings.HasSuffix(baseUrl, "/") {
  204. return baseUrl + "/" + p
  205. }
  206. return baseUrl + p
  207. }
  208. if strings.HasPrefix(p, "/") && strings.HasSuffix(cdn, "/") {
  209. return cdn + string(p[1:])
  210. }
  211. if !strings.HasPrefix(p, "/") && !strings.HasSuffix(cdn, "/") {
  212. return cdn + "/" + p
  213. }
  214. return cdn + p
  215. })
  216. if err != nil {
  217. logs.Error("注册函数 cdn 出错 ->", err)
  218. os.Exit(-1)
  219. }
  220. err = adapter.AddFuncMap("cdnjs", conf.URLForWithCdnJs)
  221. if err != nil {
  222. logs.Error("注册函数 cdnjs 出错 ->", err)
  223. os.Exit(-1)
  224. }
  225. err = adapter.AddFuncMap("cdncss", conf.URLForWithCdnCss)
  226. if err != nil {
  227. logs.Error("注册函数 cdncss 出错 ->", err)
  228. os.Exit(-1)
  229. }
  230. err = adapter.AddFuncMap("cdnimg", conf.URLForWithCdnImage)
  231. if err != nil {
  232. logs.Error("注册函数 cdnimg 出错 ->", err)
  233. os.Exit(-1)
  234. }
  235. //重写url生成,支持配置域名以及域名前缀
  236. err = adapter.AddFuncMap("urlfor", conf.URLFor)
  237. if err != nil {
  238. logs.Error("注册函数 urlfor 出错 ->", err)
  239. os.Exit(-1)
  240. }
  241. err = adapter.AddFuncMap("date_format", func(t time.Time, format string) string {
  242. return t.Local().Format(format)
  243. })
  244. if err != nil {
  245. logs.Error("注册函数 date_format 出错 ->", err)
  246. os.Exit(-1)
  247. }
  248. }
  249. //解析命令
  250. func ResolveCommand(args []string) {
  251. flagSet := flag.NewFlagSet("MinDoc command: ", flag.ExitOnError)
  252. flagSet.StringVar(&conf.ConfigurationFile, "config", "", "MinDoc configuration file.")
  253. flagSet.StringVar(&conf.WorkingDirectory, "dir", "", "MinDoc working directory.")
  254. flagSet.StringVar(&conf.LogFile, "log", "", "MinDoc log file path.")
  255. if err := flagSet.Parse(args); err != nil {
  256. log.Fatal("解析命令失败 ->", err)
  257. }
  258. if conf.WorkingDirectory == "" {
  259. if p, err := filepath.Abs(os.Args[0]); err == nil {
  260. conf.WorkingDirectory = filepath.Dir(p)
  261. }
  262. }
  263. if conf.ConfigurationFile == "" {
  264. conf.ConfigurationFile = conf.WorkingDir("conf", "app.conf")
  265. config := conf.WorkingDir("conf", "app.conf.example")
  266. if !filetil.FileExists(conf.ConfigurationFile) && filetil.FileExists(config) {
  267. _ = filetil.CopyFile(conf.ConfigurationFile, config)
  268. }
  269. }
  270. if err := gocaptcha.ReadFonts(conf.WorkingDir("static", "fonts"), ".ttf"); err != nil {
  271. log.Fatal("读取字体文件时出错 -> ", err)
  272. }
  273. if err := adapter.LoadAppConfig("ini", conf.ConfigurationFile); err != nil {
  274. log.Fatal("An error occurred:", err)
  275. }
  276. if conf.LogFile == "" {
  277. logPath, err := filepath.Abs(web.AppConfig.DefaultString("log_path", conf.WorkingDir("runtime", "logs")))
  278. if err == nil {
  279. conf.LogFile = logPath
  280. } else {
  281. conf.LogFile = conf.WorkingDir("runtime", "logs")
  282. }
  283. }
  284. conf.AutoLoadDelay = web.AppConfig.DefaultInt("config_auto_delay", 0)
  285. uploads := conf.WorkingDir("uploads")
  286. _ = os.MkdirAll(uploads, 0666)
  287. web.BConfig.WebConfig.StaticDir["/static"] = filepath.Join(conf.WorkingDirectory, "static")
  288. web.BConfig.WebConfig.StaticDir["/uploads"] = uploads
  289. web.BConfig.WebConfig.ViewsPath = conf.WorkingDir("views")
  290. fonts := conf.WorkingDir("static", "fonts")
  291. if !filetil.FileExists(fonts) {
  292. log.Fatal("Font path not exist.")
  293. }
  294. if err := gocaptcha.ReadFonts(filepath.Join(conf.WorkingDirectory, "static", "fonts"), ".ttf"); err != nil {
  295. log.Fatal("读取字体失败 ->", err)
  296. }
  297. RegisterDataBase()
  298. RegisterCache()
  299. RegisterModel()
  300. RegisterLogger(conf.LogFile)
  301. ModifyPassword()
  302. }
  303. //注册缓存管道
  304. func RegisterCache() {
  305. isOpenCache := web.AppConfig.DefaultBool("cache", false)
  306. if !isOpenCache {
  307. cache.Init(&cache.NullCache{})
  308. return
  309. }
  310. logs.Info("正常初始化缓存配置.")
  311. cacheProvider, _ := web.AppConfig.String("cache_provider")
  312. if cacheProvider == "file" {
  313. cacheFilePath := web.AppConfig.DefaultString("cache_file_path", "./runtime/cache/")
  314. if strings.HasPrefix(cacheFilePath, "./") {
  315. cacheFilePath = filepath.Join(conf.WorkingDirectory, string(cacheFilePath[1:]))
  316. }
  317. fileCache := beegoCache.NewFileCache()
  318. fileConfig := make(map[string]string, 0)
  319. fileConfig["CachePath"] = cacheFilePath
  320. fileConfig["DirectoryLevel"] = web.AppConfig.DefaultString("cache_file_dir_level", "2")
  321. fileConfig["EmbedExpiry"] = web.AppConfig.DefaultString("cache_file_expiry", "120")
  322. fileConfig["FileSuffix"] = web.AppConfig.DefaultString("cache_file_suffix", ".bin")
  323. bc, err := json.Marshal(&fileConfig)
  324. if err != nil {
  325. logs.Error("初始化file缓存失败:", err)
  326. os.Exit(1)
  327. }
  328. _ = fileCache.StartAndGC(string(bc))
  329. cache.Init(fileCache)
  330. } else if cacheProvider == "memory" {
  331. cacheInterval := web.AppConfig.DefaultInt("cache_memory_interval", 60)
  332. memory := beegoCache.NewMemoryCache()
  333. beegoCache.DefaultEvery = cacheInterval
  334. cache.Init(memory)
  335. } else if cacheProvider == "redis" {
  336. //设置Redis前缀
  337. if key := web.AppConfig.DefaultString("cache_redis_prefix", ""); key != "" {
  338. redis.DefaultKey = key
  339. }
  340. var redisConfig struct {
  341. Conn string `json:"conn"`
  342. Password string `json:"password"`
  343. DbNum int `json:"dbNum"`
  344. }
  345. redisConfig.DbNum = 0
  346. redisConfig.Conn = web.AppConfig.DefaultString("cache_redis_host", "")
  347. if pwd := web.AppConfig.DefaultString("cache_redis_password", ""); pwd != "" {
  348. redisConfig.Password = pwd
  349. }
  350. if dbNum := web.AppConfig.DefaultInt("cache_redis_db", 0); dbNum > 0 {
  351. redisConfig.DbNum = dbNum
  352. }
  353. bc, err := json.Marshal(&redisConfig)
  354. if err != nil {
  355. logs.Error("初始化Redis缓存失败:", err)
  356. os.Exit(1)
  357. }
  358. redisCache, err := beegoCache.NewCache("redis", string(bc))
  359. if err != nil {
  360. logs.Error("初始化Redis缓存失败:", err)
  361. os.Exit(1)
  362. }
  363. cache.Init(redisCache)
  364. } else if cacheProvider == "memcache" {
  365. var memcacheConfig struct {
  366. Conn string `json:"conn"`
  367. }
  368. memcacheConfig.Conn = web.AppConfig.DefaultString("cache_memcache_host", "")
  369. bc, err := json.Marshal(&memcacheConfig)
  370. if err != nil {
  371. logs.Error("初始化 Memcache 缓存失败 ->", err)
  372. os.Exit(1)
  373. }
  374. memcache, err := beegoCache.NewCache("memcache", string(bc))
  375. if err != nil {
  376. logs.Error("初始化 Memcache 缓存失败 ->", err)
  377. os.Exit(1)
  378. }
  379. cache.Init(memcache)
  380. } else {
  381. cache.Init(&cache.NullCache{})
  382. logs.Warn("不支持的缓存管道,缓存将禁用 ->", cacheProvider)
  383. return
  384. }
  385. logs.Info("缓存初始化完成.")
  386. }
  387. //自动加载配置文件.修改了监听端口号和数据库配置无法自动生效.
  388. func RegisterAutoLoadConfig() {
  389. if conf.AutoLoadDelay > 0 {
  390. watcher, err := fsnotify.NewWatcher()
  391. if err != nil {
  392. logs.Error("创建配置文件监控器失败 ->", err)
  393. }
  394. go func() {
  395. for {
  396. select {
  397. case ev := <-watcher.Event:
  398. //如果是修改了配置文件
  399. if ev.IsModify() {
  400. if err := adapter.LoadAppConfig("ini", conf.ConfigurationFile); err != nil {
  401. logs.Error("An error occurred ->", err)
  402. continue
  403. }
  404. RegisterCache()
  405. RegisterLogger("")
  406. logs.Info("配置文件已加载 ->", conf.ConfigurationFile)
  407. } else if ev.IsRename() {
  408. _ = watcher.WatchFlags(conf.ConfigurationFile, fsnotify.FSN_MODIFY|fsnotify.FSN_RENAME)
  409. }
  410. logs.Info(ev.String())
  411. case err := <-watcher.Error:
  412. logs.Error("配置文件监控器错误 ->", err)
  413. }
  414. }
  415. }()
  416. err = watcher.WatchFlags(conf.ConfigurationFile, fsnotify.FSN_MODIFY|fsnotify.FSN_RENAME)
  417. if err != nil {
  418. logs.Error("监控配置文件失败 ->", err)
  419. }
  420. }
  421. }
  422. //注册错误处理方法.
  423. func RegisterError() {
  424. web.ErrorHandler("404", func(writer http.ResponseWriter, request *http.Request) {
  425. var buf bytes.Buffer
  426. data := make(map[string]interface{})
  427. data["ErrorCode"] = 404
  428. data["ErrorMessage"] = "页面未找到或已删除"
  429. if err := adapter.ExecuteViewPathTemplate(&buf, "errors/error.tpl", web.BConfig.WebConfig.ViewsPath, data); err == nil {
  430. _, _ = fmt.Fprint(writer, buf.String())
  431. } else {
  432. _, _ = fmt.Fprint(writer, data["ErrorMessage"])
  433. }
  434. })
  435. web.ErrorHandler("401", func(writer http.ResponseWriter, request *http.Request) {
  436. var buf bytes.Buffer
  437. data := make(map[string]interface{})
  438. data["ErrorCode"] = 401
  439. data["ErrorMessage"] = "请与 Web 服务器的管理员联系,以确认您是否具有访问所请求资源的权限。"
  440. if err := adapter.ExecuteViewPathTemplate(&buf, "errors/error.tpl", web.BConfig.WebConfig.ViewsPath, data); err == nil {
  441. _, _ = fmt.Fprint(writer, buf.String())
  442. } else {
  443. _, _ = fmt.Fprint(writer, data["ErrorMessage"])
  444. }
  445. })
  446. }
  447. func init() {
  448. if configPath, err := filepath.Abs(conf.ConfigurationFile); err == nil {
  449. conf.ConfigurationFile = configPath
  450. }
  451. if err := gocaptcha.ReadFonts(conf.WorkingDir("static", "fonts"), ".ttf"); err != nil {
  452. log.Fatal("读取字体文件失败 ->", err)
  453. }
  454. gob.Register(models.Member{})
  455. if p, err := filepath.Abs(os.Args[0]); err == nil {
  456. conf.WorkingDirectory = filepath.Dir(p)
  457. }
  458. }