mirror of
https://github.com/documize/community.git
synced 2025-07-24 07:39:43 +02:00
Make database boot process storage provider agonistic
Moved database queries into provider specific object to ensure database checking, installation, upgrade procedures are pluggable.
This commit is contained in:
Harvey Kandola
parent
4c733ce581
commit
97d90662dd
9 changed files with 524 additions and 466 deletions
|
|
@ -12,9 +12,7 @@
|
|||
package database
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/documize/community/core/env"
|
||||
|
|
@ -22,25 +20,21 @@ import (
|
|||
"github.com/documize/community/server/web"
|
||||
)
|
||||
|
||||
var dbCheckOK bool // default false
|
||||
|
||||
// Check that the database is configured correctly and that all the required tables exist.
|
||||
// It must be the first function called in this package.
|
||||
func Check(runtime *env.Runtime) bool {
|
||||
runtime.Log.Info("Database checks: started")
|
||||
runtime.Log.Info("Database: checking state")
|
||||
|
||||
csBits := strings.Split(runtime.Flags.DBConn, "/")
|
||||
if len(csBits) > 1 {
|
||||
web.SiteInfo.DBname = strings.Split(csBits[len(csBits)-1], "?")[0]
|
||||
}
|
||||
web.SiteInfo.DBname = runtime.StoreProvider.DatabaseName()
|
||||
|
||||
rows, err := runtime.Db.Query("SELECT VERSION() AS version, @@version_comment as comment, @@character_set_database AS charset, @@collation_database AS collation")
|
||||
rows, err := runtime.Db.Query(runtime.StoreProvider.QueryMeta())
|
||||
if err != nil {
|
||||
runtime.Log.Error("Can't get MySQL configuration", err)
|
||||
web.SiteInfo.Issue = "Can't get MySQL configuration: " + err.Error()
|
||||
runtime.Log.Error("Database: unable to load meta information from database provider", err)
|
||||
web.SiteInfo.Issue = "Unable to load meta information from database provider: " + err.Error()
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
|
||||
defer streamutil.Close(rows)
|
||||
var version, dbComment, charset, collation string
|
||||
if rows.Next() {
|
||||
|
|
@ -50,121 +44,70 @@ func Check(runtime *env.Runtime) bool {
|
|||
err = rows.Err() // get any error encountered during iteration
|
||||
}
|
||||
if err != nil {
|
||||
runtime.Log.Error("no MySQL configuration returned", err)
|
||||
web.SiteInfo.Issue = "no MySQL configuration return issue: " + err.Error()
|
||||
runtime.Log.Error("Database: no meta data returned by database provider", err)
|
||||
web.SiteInfo.Issue = "No meta data returned by database provider: " + err.Error()
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
// runtime.DbVariant = GetSQLVariant(runtime.Flags.DBType, dbComment)
|
||||
|
||||
runtime.Log.Info(fmt.Sprintf("Database checks: SQL variant %v", runtime.Storage.Type))
|
||||
runtime.Log.Info("Database checks: SQL version " + version)
|
||||
runtime.Log.Info(fmt.Sprintf("Database: provider name %v", runtime.StoreProvider.Type()))
|
||||
runtime.Log.Info(fmt.Sprintf("Database: provider version %s", version))
|
||||
|
||||
verNums, err := GetSQLVersion(version)
|
||||
if err != nil {
|
||||
runtime.Log.Error("Database version check failed", err)
|
||||
// Version OK?
|
||||
versionOK, minVersion := runtime.StoreProvider.VerfiyVersion(version)
|
||||
if !versionOK {
|
||||
msg := fmt.Sprintf("*** ERROR: database version needs to be %s or above ***", minVersion)
|
||||
runtime.Log.Info(msg)
|
||||
web.SiteInfo.Issue = msg
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
|
||||
// Check minimum MySQL version as we need JSON column type.
|
||||
verInts := []int{5, 7, 10} // Minimum MySQL version
|
||||
if runtime.Storage.Type == env.StoreTypeMariaDB {
|
||||
verInts = []int{10, 3, 0} // Minimum MariaDB version
|
||||
}
|
||||
|
||||
for k, v := range verInts {
|
||||
// If major release is higher then skip minor/patch checks (e.g. 8.x.x > 5.x.x)
|
||||
if k == 0 && len(verNums) > 0 && verNums[0] > verInts[0] {
|
||||
break
|
||||
}
|
||||
if verNums[k] < v {
|
||||
want := fmt.Sprintf("%d.%d.%d", verInts[0], verInts[1], verInts[2])
|
||||
runtime.Log.Error("MySQL version element "+strconv.Itoa(k+1)+" of '"+version+"' not high enough, need at least version "+want, errors.New("bad MySQL version"))
|
||||
web.SiteInfo.Issue = "MySQL version element " + strconv.Itoa(k+1) + " of '" + version + "' not high enough, need at least version " + want
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
{ // check the MySQL character set and collation
|
||||
if charset != "utf8" && charset != "utf8mb4" {
|
||||
runtime.Log.Error("MySQL character set not utf8/utf8mb4:", errors.New(charset))
|
||||
web.SiteInfo.Issue = "MySQL character set not utf8/utf8mb4: " + charset
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
if !strings.HasPrefix(collation, "utf8") {
|
||||
runtime.Log.Error("MySQL collation sequence not utf8...:", errors.New(collation))
|
||||
web.SiteInfo.Issue = "MySQL collation sequence not utf8...: " + collation
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
// Character set and collation OK?
|
||||
charOK, charRequired := runtime.StoreProvider.VerfiyCharacterCollation(charset, collation)
|
||||
if !charOK {
|
||||
msg := fmt.Sprintf("*** ERROR: %s ***", charRequired)
|
||||
runtime.Log.Info(msg)
|
||||
web.SiteInfo.Issue = msg
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
|
||||
{ // if there are no rows in the database, enter set-up mode
|
||||
var flds []string
|
||||
if err := runtime.Db.Select(&flds,
|
||||
`SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = '`+web.SiteInfo.DBname+
|
||||
`' and TABLE_TYPE='BASE TABLE'`); err != nil {
|
||||
runtime.Log.Error("Can't get MySQL number of tables", err)
|
||||
web.SiteInfo.Issue = "Can't get MySQL number of tables: " + err.Error()
|
||||
if err := runtime.Db.Select(&flds, runtime.StoreProvider.QueryTableList()); err != nil {
|
||||
msg := fmt.Sprintf("Database: unable to get database table list ")
|
||||
runtime.Log.Error(msg, err)
|
||||
web.SiteInfo.Issue = msg + err.Error()
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
|
||||
if strings.TrimSpace(flds[0]) == "0" {
|
||||
runtime.Log.Info("Entering database set-up mode because the database is empty.....")
|
||||
runtime.Log.Info("Database: starting setup mode for empty database")
|
||||
runtime.Flags.SiteMode = env.SiteModeSetup
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
{ // check all the required tables exist
|
||||
var tables = []string{`account`,
|
||||
`attachment`, `document`,
|
||||
`label`, `organization`,
|
||||
`page`, `revision`, `search`, `user`}
|
||||
// Ensure no missing tables.
|
||||
var tables = []string{"account", "attachment", "document",
|
||||
"label", "organization", "page", "revision", "search", "user"}
|
||||
|
||||
for _, table := range tables {
|
||||
var dummy []string
|
||||
if err := runtime.Db.Select(&dummy, "SELECT 1 FROM "+table+" LIMIT 1;"); err != nil {
|
||||
runtime.Log.Error("Entering bad database mode because: SELECT 1 FROM "+table+" LIMIT 1;", err)
|
||||
web.SiteInfo.Issue = "MySQL database is not empty, but does not contain table: " + table
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
for _, table := range tables {
|
||||
var result []string
|
||||
if err := runtime.Db.Select(&result, fmt.Sprintf("SELECT COUNT(*) FROM %s ;", table)); err != nil {
|
||||
msg := fmt.Sprintf("Database: missing table %s", table)
|
||||
runtime.Log.Error(msg, err)
|
||||
web.SiteInfo.Issue = msg
|
||||
runtime.Flags.SiteMode = env.SiteModeBadDB
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
runtime.Flags.SiteMode = env.SiteModeNormal // actually no need to do this (as already ""), this for documentation
|
||||
web.SiteInfo.DBname = "" // do not give this info when not in set-up mode
|
||||
dbCheckOK = true
|
||||
// We have good database, so proceed with app boot process.
|
||||
runtime.Flags.SiteMode = env.SiteModeNormal
|
||||
web.SiteInfo.DBname = ""
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
// GetSQLVersion returns SQL version as major,minor,patch numerics.
|
||||
func GetSQLVersion(v string) (ints []int, err error) {
|
||||
ints = []int{0, 0, 0}
|
||||
|
||||
pos := strings.Index(v, "-")
|
||||
if pos > 1 {
|
||||
v = v[:pos]
|
||||
}
|
||||
|
||||
vs := strings.Split(v, ".")
|
||||
|
||||
if len(vs) < 3 {
|
||||
err = errors.New("MySQL version not of the form a.b.c")
|
||||
return
|
||||
}
|
||||
|
||||
for key, val := range vs {
|
||||
num, err := strconv.Atoi(val)
|
||||
|
||||
if err != nil {
|
||||
return ints, err
|
||||
}
|
||||
|
||||
ints[key] = num
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue