documize/edition/boot/runtime.go

// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
//
// This software (Documize Community Edition) is licensed under
// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
//
// You can operate outside the AGPL restrictions by purchasing
// Documize Enterprise Edition and obtaining a commercial license
// by contacting <sales@documize.com>.
//
// https://documize.com

// Package boot prepares runtime environment.
package boot

import (
	"os"
	"time"

	"github.com/documize/community/core/database"
	"github.com/documize/community/core/env"
	"github.com/documize/community/core/secrets"
	"github.com/documize/community/domain/store"
	"github.com/documize/community/edition/storage"
	"github.com/jmoiron/sqlx"
)

// InitRuntime prepares runtime using command line and environment variables.
func InitRuntime(r *env.Runtime, s *store.Store) bool {
	// TODO: remove this line when Go1.13 is released.
	os.Setenv("GODEBUG", os.Getenv("GODEBUG")+",tls13=1")

	// We need SALT to hash auth JWT tokens.
	if r.Flags.Salt == "" {
		r.Flags.Salt = secrets.RandSalt()

		if r.Flags.Salt == "" {
			return false
		}

		r.Log.Info("please set DOCUMIZESALT environment variable or use -salt switch with this value: " + r.Flags.Salt)
	}

	// We can use either or both HTTP and HTTPS ports.
	if r.Flags.SSLCertFile == "" && r.Flags.SSLKeyFile == "" {
		if r.Flags.HTTPPort == "" {
			r.Flags.HTTPPort = "80"
		}
	} else {
		if r.Flags.HTTPPort == "" {
			r.Flags.HTTPPort = "443"
		}
	}

	// Set up required storage provider.
	switch r.Flags.DBType {
	case "mysql":
		storage.SetMySQLProvider(r, s)
	case "mariadb":
		storage.SetMySQLProvider(r, s)
	case "percona":
		storage.SetMySQLProvider(r, s)
	case "postgresql":
		storage.SetPostgreSQLProvider(r, s)
	case "sqlserver":
		storage.SetSQLServerProvider(r, s)
	default:
		r.Log.Infof("Unsupported database type: %s", r.Flags.DBType)
		r.Log.Info("Documize supports the following database types: mysql mariadb percona postgresql sqlserver")
		os.Exit(1)
		return false
	}

	// Open connection to database.
	db, err := sqlx.Open(r.StoreProvider.DriverName(), r.StoreProvider.MakeConnectionString())
	if err != nil {
		r.Log.Error("Unable to open database", err)
		os.Exit(1)
		return false
	}

	// Set the database handle.
	r.Db = db

	// Set connection defaults.
	r.Db.SetMaxIdleConns(30)
	r.Db.SetMaxOpenConns(100)
	r.Db.SetConnMaxLifetime(time.Second * 14400)

	// Ping verifies a connection to the database is still alive, establishing a connection if necessary.
	err = r.Db.Ping()
	if err != nil {
		r.Log.Error("Unable to connect to database", err)
		r.Log.Info(r.StoreProvider.Example())
		os.Exit(1)
		return false
	}

	// Check database and upgrade if required.
	if r.Flags.SiteMode != env.SiteModeOffline {
		if database.Check(r) {
			if err := database.InstallUpgrade(r, true); err != nil {
				r.Log.Error("unable to run database migration", err)
				return false
			}
		}
	}

	return true
}