2019-01-17 19:53:03 +01:00
|
|
|
/*
|
2022-11-11 05:49:16 +01:00
|
|
|
* Copyright © 2019 Musing Studio LLC.
|
2019-01-17 19:53:03 +01:00
|
|
|
*
|
|
|
|
* This file is part of WriteFreely.
|
|
|
|
*
|
|
|
|
* WriteFreely is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License, included
|
|
|
|
* in the LICENSE file in this source code package.
|
|
|
|
*/
|
|
|
|
|
|
|
|
// Package migrations contains database migrations for WriteFreely
|
|
|
|
package migrations
|
|
|
|
|
|
|
|
import (
|
|
|
|
"database/sql"
|
2019-08-28 21:37:45 +02:00
|
|
|
|
2019-01-17 19:53:03 +01:00
|
|
|
"github.com/writeas/web-core/log"
|
|
|
|
)
|
|
|
|
|
|
|
|
// TODO: refactor to use the datastore struct from writefreely pkg
|
|
|
|
type datastore struct {
|
|
|
|
*sql.DB
|
|
|
|
driverName string
|
|
|
|
}
|
|
|
|
|
|
|
|
func NewDatastore(db *sql.DB, dn string) *datastore {
|
|
|
|
return &datastore{db, dn}
|
|
|
|
}
|
|
|
|
|
|
|
|
// TODO: use these consts from writefreely pkg
|
|
|
|
const (
|
|
|
|
driverMySQL = "mysql"
|
|
|
|
driverSQLite = "sqlite3"
|
|
|
|
)
|
|
|
|
|
|
|
|
type Migration interface {
|
|
|
|
Description() string
|
|
|
|
Migrate(db *datastore) error
|
|
|
|
}
|
|
|
|
|
|
|
|
type migration struct {
|
|
|
|
description string
|
|
|
|
migrate func(db *datastore) error
|
|
|
|
}
|
|
|
|
|
|
|
|
func New(d string, fn func(db *datastore) error) Migration {
|
|
|
|
return &migration{d, fn}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (m *migration) Description() string {
|
|
|
|
return m.description
|
|
|
|
}
|
|
|
|
|
|
|
|
func (m *migration) Migrate(db *datastore) error {
|
|
|
|
return m.migrate(db)
|
|
|
|
}
|
|
|
|
|
2019-01-18 06:05:50 +01:00
|
|
|
var migrations = []Migration{
|
2019-11-26 19:19:20 +01:00
|
|
|
New("support user invites", supportUserInvites), // -> V1 (v0.8.0)
|
|
|
|
New("support dynamic instance pages", supportInstancePages), // V1 -> V2 (v0.9.0)
|
|
|
|
New("support users suspension", supportUserStatus), // V2 -> V3 (v0.11.0)
|
2020-02-08 17:51:18 +01:00
|
|
|
New("support oauth", oauth), // V3 -> V4
|
|
|
|
New("support slack oauth", oauthSlack), // V4 -> v5
|
2020-04-09 19:49:44 +02:00
|
|
|
New("support ActivityPub mentions", supportActivityPubMentions), // V5 -> V6
|
2020-04-21 00:18:23 +02:00
|
|
|
New("support oauth attach", oauthAttach), // V6 -> V7
|
|
|
|
New("support oauth via invite", oauthInvites), // V7 -> V8 (v0.12.0)
|
2020-05-01 21:00:51 +02:00
|
|
|
New("optimize drafts retrieval", optimizeDrafts), // V8 -> V9
|
2021-06-22 00:24:40 +02:00
|
|
|
New("support post signatures", supportPostSignatures), // V9 -> V10 (v0.13.0)
|
2023-01-03 17:18:02 +01:00
|
|
|
New("Widen oauth_users.access_token", widenOauthAcceesToken), // V10 -> V11
|
2023-09-25 19:59:46 +02:00
|
|
|
New("support verifying fedi profile", fediverseVerifyProfile), // V11 -> V12 (v0.14.0)
|
|
|
|
New("support newsletters", supportLetters), // V12 -> V13
|
2023-09-26 00:48:14 +02:00
|
|
|
New("support password resetting", supportPassReset), // V13 -> V14
|
2023-09-26 20:36:34 +02:00
|
|
|
New("speed up blog post retrieval", addPostRetrievalIndex), // V14 -> V15
|
2024-10-21 17:28:35 +02:00
|
|
|
New("support ActivityPub likes", supportRemoteLikes), // V15 -> V16 (v0.16.0)
|
2019-01-18 06:05:50 +01:00
|
|
|
}
|
2019-01-17 19:53:03 +01:00
|
|
|
|
2019-01-24 23:08:08 +01:00
|
|
|
// CurrentVer returns the current migration version the application is on
|
|
|
|
func CurrentVer() int {
|
|
|
|
return len(migrations)
|
|
|
|
}
|
|
|
|
|
|
|
|
func SetInitialMigrations(db *datastore) error {
|
2019-04-15 19:48:19 +02:00
|
|
|
// Included schema files represent changes up to V1, so note that in the database
|
|
|
|
_, err := db.Exec("INSERT INTO appmigrations (version, migrated, result) VALUES (?, "+db.now()+", ?)", 1, "")
|
2019-01-24 23:08:08 +01:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2019-01-17 19:53:03 +01:00
|
|
|
func Migrate(db *datastore) error {
|
|
|
|
var version int
|
|
|
|
var err error
|
|
|
|
if db.tableExists("appmigrations") {
|
|
|
|
err = db.QueryRow("SELECT MAX(version) FROM appmigrations").Scan(&version)
|
2021-06-09 20:25:55 +02:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2019-01-17 19:53:03 +01:00
|
|
|
} else {
|
|
|
|
log.Info("Initializing appmigrations table...")
|
|
|
|
version = 0
|
|
|
|
_, err = db.Exec(`CREATE TABLE appmigrations (
|
|
|
|
version ` + db.typeInt() + ` NOT NULL,
|
|
|
|
migrated ` + db.typeDateTime() + ` NOT NULL,
|
|
|
|
result ` + db.typeText() + ` NOT NULL
|
|
|
|
) ` + db.engine() + `;`)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(migrations[version:]) > 0 {
|
|
|
|
for i, m := range migrations[version:] {
|
|
|
|
curVer := version + i + 1
|
|
|
|
log.Info("Migrating to V%d: %s", curVer, m.Description())
|
|
|
|
err = m.Migrate(db)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Update migrations table
|
|
|
|
_, err = db.Exec("INSERT INTO appmigrations (version, migrated, result) VALUES (?, "+db.now()+", ?)", curVer, "")
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
log.Info("Database up-to-date. No migrations to run.")
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (db *datastore) tableExists(t string) bool {
|
|
|
|
var dummy string
|
|
|
|
var err error
|
|
|
|
if db.driverName == driverSQLite {
|
|
|
|
err = db.QueryRow("SELECT name FROM sqlite_master WHERE type = 'table' AND name = ?", t).Scan(&dummy)
|
|
|
|
} else {
|
2019-01-18 17:26:55 +01:00
|
|
|
err = db.QueryRow("SHOW TABLES LIKE '" + t + "'").Scan(&dummy)
|
2019-01-17 19:53:03 +01:00
|
|
|
}
|
|
|
|
switch {
|
|
|
|
case err == sql.ErrNoRows:
|
|
|
|
return false
|
|
|
|
case err != nil:
|
|
|
|
log.Error("Couldn't SHOW TABLES: %v", err)
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
return true
|
|
|
|
}
|