1
0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-10-30 03:36:16 +00:00
mycorrhiza/files/files.go
opsyne 6c25ef9085
Add default favicon.ico file (#162)
* Add default favicon.ico file

* Fix typos in README.md

* Move twemoji mushroom attribution

* Unpack default favicon on first wiki startup

Might be a bit over-engineered
2022-08-22 13:31:17 +05:00

124 lines
3.5 KiB
Go

// Package files is used to get paths to different files Mycorrhiza uses. Also see cfg.
package files
import (
"io"
"os"
"path/filepath"
"github.com/bouncepaw/mycorrhiza/cfg"
"github.com/bouncepaw/mycorrhiza/static"
)
var paths struct {
gitRepo string
cacheDir string
staticFiles string
configPath string
tokensJSON string
userCredentialsJSON string
categoriesJSON string
interwikiJSON string
}
// HyphaeDir returns the path to hyphae storage.
// A separate function is needed to easily know where a general storage path is
// needed rather than a concrete Git or the whole wiki storage path, so that we
// could easily refactor things later if we'll ever support different storages.
func HyphaeDir() string { return paths.gitRepo }
// GitRepo returns the path to the Git repository of the wiki.
func GitRepo() string { return paths.gitRepo }
// StaticFiles returns the path to static files directory
func StaticFiles() string { return paths.staticFiles }
// ConfigPath returns the path to the config file.
func ConfigPath() string { return paths.configPath }
// TokensJSON returns the path to the JSON user tokens storage.
func TokensJSON() string { return paths.tokensJSON }
// UserCredentialsJSON returns the path to the JSON user credentials storage.
func UserCredentialsJSON() string { return paths.userCredentialsJSON }
// CategoriesJSON returns the path to the JSON categories storage.
func CategoriesJSON() string { return paths.categoriesJSON }
// FileInRoot returns full path for the given filename if it was placed in the root of the wiki structure.
func FileInRoot(filename string) string { return filepath.Join(cfg.WikiDir, filename) }
func InterwikiJSON() string { return paths.interwikiJSON }
// PrepareWikiRoot ensures all needed directories and files exist and have
// correct permissions.
func PrepareWikiRoot() error {
isFirstInit := false
if _, err := os.Stat(cfg.WikiDir); err != nil && os.IsNotExist(err) {
isFirstInit = true
}
if err := os.MkdirAll(cfg.WikiDir, os.ModeDir|0777); err != nil {
return err
}
paths.cacheDir = filepath.Join(cfg.WikiDir, "cache")
if err := os.MkdirAll(paths.cacheDir, os.ModeDir|0777); err != nil {
return err
}
paths.gitRepo = filepath.Join(cfg.WikiDir, "wiki.git")
if err := os.MkdirAll(paths.gitRepo, os.ModeDir|0777); err != nil {
return err
}
paths.staticFiles = filepath.Join(cfg.WikiDir, "static")
if err := os.MkdirAll(paths.staticFiles, os.ModeDir|0777); err != nil {
return err
}
paths.configPath = filepath.Join(cfg.WikiDir, "config.ini")
paths.userCredentialsJSON = filepath.Join(cfg.WikiDir, "users.json")
paths.tokensJSON = filepath.Join(paths.cacheDir, "tokens.json")
paths.categoriesJSON = filepath.Join(cfg.WikiDir, "categories.json")
paths.interwikiJSON = FileInRoot("interwiki.json")
// Are we initializing the wiki for the first time?
if isFirstInit {
err := firstTimeInit()
if err != nil {
return err
}
}
return nil
}
// firstTimeInit takes care of any tasks that only need to happen the first time the wiki is initialized
func firstTimeInit() error {
static.InitFS(StaticFiles())
defaultFavicon, err := static.FS.Open("icon/mushroom.png")
if err != nil {
return err
}
defer defaultFavicon.Close()
outputFileName := filepath.Join(cfg.WikiDir, "static", "favicon.ico")
outputFile, err := os.Create(outputFileName)
if err != nil {
return err
}
defer outputFile.Close()
_, err = io.Copy(outputFile, defaultFavicon)
if err != nil {
return err
}
return nil
}