command.go 15 KB

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