Compare commits
No commits in common. "master" and "v1.9.0" have entirely different histories.
@ -1 +0,0 @@
|
||||
.git
|
||||
30
.github/workflows/release.yaml
vendored
Normal file
30
.github/workflows/release.yaml
vendored
Normal file
@ -0,0 +1,30 @@
|
||||
on:
|
||||
release:
|
||||
types: [created]
|
||||
|
||||
jobs:
|
||||
releases-matrix:
|
||||
name: Release Go Binary
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
# build and publish in parallel a lot of binaries
|
||||
# https://golang.org/doc/install/source#environment See supported Go OS/Arch pairs here
|
||||
goos: [linux, darwin, freebsd, openbsd, windows]
|
||||
goarch: ["386", amd64, arm64]
|
||||
exclude:
|
||||
- goarch: "386"
|
||||
goos: darwin
|
||||
- goarch: arm64
|
||||
goos: freebsd
|
||||
- goarch: arm64
|
||||
goos: windows
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: wangyoucao577/go-release-action@v1.17
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
goos: ${{ matrix.goos }}
|
||||
goarch: ${{ matrix.goarch }}
|
||||
binary_name: "mycorrhiza"
|
||||
extra_files: LICENSE README.md
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,2 +1,2 @@
|
||||
mycorrhiza
|
||||
.idea
|
||||
config.mk
|
||||
|
||||
@ -1,85 +0,0 @@
|
||||
# Boilerplate in Mycorrhiza codebase
|
||||
|
||||
Being programmed by Go, mostly by Bouncepaw, the codebase contains a lot of boilerplate. This document is an attempt to describe how it is done.
|
||||
|
||||
## Modules
|
||||
|
||||
Mycorrhiza is arranged in quite many packages. They are thematic. For example, package `backlinks` has all things backlinks, including the storage, the views, and exported functions (not many, ideally). Such packages can be called modules, if you want.
|
||||
|
||||
## Views
|
||||
|
||||
Views are the biggest source of similar code. Before the transition from QTPL to Go's standard templates, this boilerplate energy was split differently, but was not instantly obvious. The current approach does not really introduce new boilerplate energy, but it does focus it, resulting in actual boilerplate. I hope you get the idea.
|
||||
|
||||
All related views are part of one module.
|
||||
|
||||
Views come in multiple parts.
|
||||
|
||||
The first part is the template itself. Call template files like that: `view_user_list.html`, prefixed with `view_`. The boilerplate is as follows.
|
||||
|
||||
```html
|
||||
{{define "title"}}{{end}}
|
||||
{{define "body"}}
|
||||
{{end}}
|
||||
```
|
||||
|
||||
More often than not, you will want to make template `title` a different template in the same file. See existing files for inspiration.
|
||||
|
||||
The code that makes those templates runnable lies in one file. This is the second part. It contains the following:.
|
||||
|
||||
The Russian translation is a `string` variable called `ruTranslation`; we currently have no other translations, but they are to be called like `frTranslation`, `eoTranslation`, et cetera.
|
||||
|
||||
|
||||
```go
|
||||
var (
|
||||
ruTranslation = `
|
||||
{{define "one thing"}}...{{end}}
|
||||
{{define "other thing"}}...{{end}}
|
||||
`
|
||||
...
|
||||
)
|
||||
```
|
||||
|
||||
Chains are collection of different language variants of the same template. Declare them and then assign them in a function, which you call somewhere (not just `init`!).
|
||||
|
||||
```go
|
||||
var (
|
||||
ruTranslation = `...`
|
||||
chainStuff, chainAddStuff viewutil.Chain
|
||||
)
|
||||
|
||||
func initViews() {
|
||||
chainStuff = viewutil.CopyEnRuWith(fs, "view_stuff.html", ruTranslation)
|
||||
chainAddStuff = viewutil.CopyEnRuWith(fs, "view_add_stuff.html", ruTranslation)
|
||||
}
|
||||
```
|
||||
|
||||
Then every view has a runner and its own datatype.
|
||||
|
||||
```go
|
||||
//...
|
||||
|
||||
type dataStuff struct {
|
||||
*viewutil.BaseData
|
||||
StuffName string
|
||||
}
|
||||
|
||||
func viewStuff(meta viewutil.Meta, stuffName string) {
|
||||
viewutil.ExecutePage(meta, chainStuff, dataUserList{
|
||||
BaseData: &viewutil.BaseData{},
|
||||
StuffName: stuffName,
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
Sometimes, two datatypes of different views are the same, it is ok to just share one, but name it so that it mentions both.
|
||||
|
||||
Avoid any logic in those runners. Keep them as boilerplate as they are. You rarely need to fill the `BaseData` field. Do it if you need to. If you don't, `viewutil.ExecutePage` will do its best to guess. We name the fields with capital letters.
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
* Declared the chains?
|
||||
* Assigned the chains?
|
||||
* Assigned the chains, sure?
|
||||
* Used the correct data type?
|
||||
* `*viewutil.BaseData` is there?
|
||||
* Used the correct chain?
|
||||
@ -7,9 +7,6 @@ RUN go build -o /out/mycorrhiza .
|
||||
FROM alpine/git as app
|
||||
EXPOSE 1737
|
||||
|
||||
RUN apk add --no-cache curl
|
||||
HEALTHCHECK CMD curl -Ns localhost:1737 || exit 1
|
||||
|
||||
WORKDIR /
|
||||
RUN mkdir wiki
|
||||
COPY --from=build /out/mycorrhiza /usr/bin
|
||||
|
||||
47
README.md
47
README.md
@ -2,49 +2,52 @@
|
||||
|
||||
**Mycorrhiza Wiki** is a lightweight file-system wiki engine that uses Git for keeping history. [Main wiki](https://mycorrhiza.wiki)
|
||||
|
||||
<img src="https://mycorrhiza.wiki/binary/release/1.15.1/screenshot" alt="A screenshot of mycorrhiza.wiki's home page in the Safari browser" width="700">
|
||||
<img src="https://mycorrhiza.wiki/binary/release/1.9/screenshot" alt="A screenshot of mycorrhiza.wiki's home page in the Safari browser" width="700">
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
* **No database used.** Everything is stored in plain files. It makes installation super easy, and you can modify the content directly by yourself.
|
||||
* **Everything is hyphae.** A hypha is a unit of content such as a picture, video or a text article. Hyphae can [transclude] and link each other, forming a tight network of hypertext pages.
|
||||
* **Hyphae are authored in [Mycomarkup],** a markup language that's designed to be unambiguous yet easy to use.
|
||||
* **Categories** let you organize hyphae without any hierarchy restrictions, with all the benefits of a category system.
|
||||
* **Nesting of hyphae** is also supported if you like hierarchies.
|
||||
* **History of changes.** Every change is safely stored in [Git]. Web feeds (RSS, Atom, JSON Feed) for recent changes included.
|
||||
* **No database required.** Everything is stored in plain files. It makes installation super easy, and you can modify the content directly by yourself.
|
||||
* **Everything is hyphae.** A [hypha] is a unit of content such as a picture, video or a text article. Hyphae can [transclude][transclusion] and link each other resulting in a tight network of hypertext pages.
|
||||
* **Hyphae are authored in [Mycomarkup],** a markup language that's designed to be unambigious yet easy to use.
|
||||
* **Categories.**
|
||||
* **Nesting of hyphae** is also supported.
|
||||
* **History of changes** for textual parts of hyphae. Every change is safely stored in [Git]. Web feeds for recent changes included!
|
||||
* **Keyboard-driven navigation.** Press `?` to see the list of shortcuts.
|
||||
* **Support for [authorization].** Both plain username-password pairs and [Telegram]'s login widget are supported.
|
||||
* **[Open Graph] support.** The most relevant info about a hypha is made available through OG meta tags for consumption by other software.
|
||||
* **Interwiki support.**
|
||||
* **Support for [authorization].**
|
||||
* **[Open Graph] support.**
|
||||
* **Optional [Telegram] authentication.**
|
||||
|
||||
[transclude]: https://mycorrhiza.wiki/hypha/feature/transclusion
|
||||
[hypha]: https://mycorrhiza.wiki/hypha/feature/hypha
|
||||
[transclusion]: https://mycorrhiza.wiki/hypha/feature/transclusion
|
||||
[authorization]: https://mycorrhiza.wiki/hypha/feature/authorization
|
||||
[Mycomarkup]: https://mycorrhiza.wiki/help/en/mycomarkup
|
||||
[Git]: https://mycorrhiza.wiki/hypha/integration/git
|
||||
[authorization]: https://mycorrhiza.wiki/hypha/authorization
|
||||
[Open Graph]: https://mycorrhiza.wiki/hypha/standard/opengraph
|
||||
[Telegram]: https://mycorrhiza.wiki/help/en/telegram
|
||||
[Open Graph]: https://mycorrhiza.wiki/hypha/opengraph
|
||||
|
||||
Compare Mycorrhiza Wiki with other engines on [WikiMatrix](https://www.wikimatrix.org/show/mycorrhiza).
|
||||
|
||||
|
||||
## Installing
|
||||
|
||||
See [the deployment guide](https://mycorrhiza.wiki/hypha/deployment) on the wiki. Also, Mycorrhiza might be available in your repositories. See [Repology](https://repology.org/project/mycorrhiza/versions).
|
||||
See [the deployment guide](https://mycorrhiza.wiki/hypha/guide/deployment) on the wiki.
|
||||
|
||||
|
||||
## Contributing and community
|
||||
## Contributing
|
||||
|
||||
* [GitHub](https://github.com/bouncepaw/mycorrhiza)
|
||||
* [Fediverse @mycorrhiza@floss.social](https://floss.social/@mycorrhiza)
|
||||
* Mirrors:
|
||||
* [SourceHut](https://sr.ht/~bouncepaw/mycorrhiza)
|
||||
* [Codeberg](https://codeberg.org/bouncepaw/mycorrhiza)
|
||||
* [SourceHut](https://sr.ht/~bouncepaw/mycorrhiza)
|
||||
* [#mycorrhiza on irc.libera.chat](irc://irc.libera.chat/#mycorrhiza)
|
||||
* [@mycorrhizadev (Russian) in Telegram](https://t.me/mycorrhizadev)
|
||||
|
||||
If you want to contribute with code, open a pull request on GitHub or send a patch to the [mailing list](https://lists.sr.ht/~bouncepaw/mycorrhiza-devel).
|
||||
If you want to report an issue, open an issue on GitHub or contact us directly.
|
||||
If you want to contribute with code, open a pull request on GitHub or send a
|
||||
patch to the [mailing list]. If you want to report an issue, open an issue on
|
||||
GitHub or contact us directly.
|
||||
|
||||
Consider supporting the development on [Boosty](https://boosty.to/bouncepaw).
|
||||
|
||||
Check out [Betula](https://betula.mycorrhiza.wiki) as well.
|
||||
You can view the list of planned features on the [roadmap page].
|
||||
|
||||
[mailing list]: https://lists.sr.ht/~bouncepaw/mycorrhiza-devel
|
||||
[roadmap page]: https://mycorrhiza.wiki/hypha/release/roadmap
|
||||
|
||||
@ -17,13 +17,13 @@ import (
|
||||
// See https://mycorrhiza.wiki/hypha/configuration/fields for the
|
||||
// documentation.
|
||||
var (
|
||||
WikiName string
|
||||
NaviTitleIcon string
|
||||
WikiName string
|
||||
NaviTitleIcon string
|
||||
UseSiblingHyphaeSidebar bool
|
||||
|
||||
HomeHypha string
|
||||
UserHypha string
|
||||
HeaderLinksHypha string
|
||||
RedirectionCategory string
|
||||
HomeHypha string
|
||||
UserHypha string
|
||||
HeaderLinksHypha string
|
||||
|
||||
ListenAddr string
|
||||
URL string
|
||||
@ -52,8 +52,9 @@ var WikiDir string
|
||||
// Config represents a Mycorrhiza wiki configuration file. This type is used
|
||||
// only when reading configs.
|
||||
type Config struct {
|
||||
WikiName string `comment:"This name appears in the header and on various pages."`
|
||||
NaviTitleIcon string `comment:"This icon is used in the breadcrumbs bar."`
|
||||
WikiName string `comment:"This name appears in the header and on various pages."`
|
||||
NaviTitleIcon string `comment:"This icon is used in the breadcrumbs bar."`
|
||||
UseSiblingHyphaeSidebar bool `comment:"You are discouraged from using the sibling hyphae sidebar on new wikis. Enable it on old wikis that depend on it heavily."`
|
||||
Hyphae
|
||||
Network
|
||||
Authorization
|
||||
@ -63,10 +64,9 @@ type Config struct {
|
||||
|
||||
// Hyphae is a section of Config which has fields related to special hyphae.
|
||||
type Hyphae struct {
|
||||
HomeHypha string `comment:"This hypha will be the main (index) page of your wiki, served on /."`
|
||||
UserHypha string `comment:"This hypha is used as a prefix for user hyphae."`
|
||||
HeaderLinksHypha string `comment:"You can also specify a hypha to populate your own custom header links from."`
|
||||
RedirectionCategory string `comment:"Redirection hyphae will be added to this category. Default: redirection."`
|
||||
HomeHypha string `comment:"This hypha will be the main (index) page of your wiki, served on /."`
|
||||
UserHypha string `comment:"This hypha is used as a prefix for user hyphae."`
|
||||
HeaderLinksHypha string `comment:"You can also specify a hypha to populate your own custom header links from."`
|
||||
}
|
||||
|
||||
// Network is a section of Config that has fields related to network stuff.
|
||||
@ -109,22 +109,22 @@ type Telegram struct {
|
||||
// configuration. Call it sometime during the initialization.
|
||||
func ReadConfigFile(path string) error {
|
||||
cfg := &Config{
|
||||
WikiName: "Lyxi's Vault",
|
||||
NaviTitleIcon: "🦇",
|
||||
WikiName: "Mycorrhiza Wiki",
|
||||
NaviTitleIcon: "🍄",
|
||||
UseSiblingHyphaeSidebar: false,
|
||||
Hyphae: Hyphae{
|
||||
HomeHypha: "home",
|
||||
UserHypha: "u",
|
||||
HeaderLinksHypha: "u/alyxbatte/header",
|
||||
RedirectionCategory: "redirection",
|
||||
HomeHypha: "home",
|
||||
UserHypha: "u",
|
||||
HeaderLinksHypha: "",
|
||||
},
|
||||
Network: Network{
|
||||
ListenAddr: "0.0.0.0:1737",
|
||||
ListenAddr: "127.0.0.1:1737",
|
||||
URL: "",
|
||||
},
|
||||
Authorization: Authorization{
|
||||
UseAuth: true,
|
||||
UseAuth: false,
|
||||
AllowRegistration: false,
|
||||
RegistrationLimit: 1,
|
||||
RegistrationLimit: 0,
|
||||
Locked: false,
|
||||
UseWhiteList: false,
|
||||
WhiteList: []string{},
|
||||
@ -171,10 +171,10 @@ func ReadConfigFile(path string) error {
|
||||
// Map the struct to the global variables
|
||||
WikiName = cfg.WikiName
|
||||
NaviTitleIcon = cfg.NaviTitleIcon
|
||||
UseSiblingHyphaeSidebar = cfg.UseSiblingHyphaeSidebar
|
||||
HomeHypha = cfg.HomeHypha
|
||||
UserHypha = cfg.UserHypha
|
||||
HeaderLinksHypha = cfg.HeaderLinksHypha
|
||||
RedirectionCategory = cfg.RedirectionCategory
|
||||
if ListenAddr == "" {
|
||||
ListenAddr = cfg.ListenAddr
|
||||
}
|
||||
@ -193,10 +193,8 @@ func ReadConfigFile(path string) error {
|
||||
TelegramEnabled = (TelegramBotToken != "") && (TelegramBotName != "")
|
||||
|
||||
// This URL makes much more sense. If no URL is set or the protocol is forgotten, assume HTTP.
|
||||
if URL == "" {
|
||||
if (URL == "") || (strings.Index(URL, ":") == -1) {
|
||||
URL = "http://" + ListenAddr
|
||||
} else if !strings.Contains(URL, ":") {
|
||||
URL = "http://" + URL
|
||||
}
|
||||
|
||||
return nil
|
||||
48
cfg/header_links.go
Normal file
48
cfg/header_links.go
Normal file
@ -0,0 +1,48 @@
|
||||
package cfg
|
||||
|
||||
// See https://mycorrhiza.wiki/hypha/configuration/header
|
||||
import (
|
||||
"github.com/bouncepaw/mycomarkup/v3"
|
||||
"github.com/bouncepaw/mycomarkup/v3/blocks"
|
||||
"github.com/bouncepaw/mycomarkup/v3/mycocontext"
|
||||
)
|
||||
|
||||
// HeaderLinks is a list off current header links. Feel free to iterate it directly but do not modify it by yourself. Call ParseHeaderLinks if you need to set new header links.
|
||||
var HeaderLinks []HeaderLink
|
||||
|
||||
// SetDefaultHeaderLinks sets the header links to the default list of: home hypha, recent changes, hyphae list, random hypha.
|
||||
func SetDefaultHeaderLinks() {
|
||||
HeaderLinks = []HeaderLink{
|
||||
{"/recent-changes", "Recent changes"},
|
||||
{"/list", "All hyphae"},
|
||||
{"/random", "Random"},
|
||||
{"/help", "Help"},
|
||||
{"/category", "Categories"},
|
||||
}
|
||||
}
|
||||
|
||||
// ParseHeaderLinks extracts all rocketlinks from the given text and saves them as header links.
|
||||
func ParseHeaderLinks(text string) {
|
||||
HeaderLinks = []HeaderLink{}
|
||||
ctx, _ := mycocontext.ContextFromStringInput("", text)
|
||||
// We call for side-effects
|
||||
_ = mycomarkup.BlockTree(ctx, func(block blocks.Block) {
|
||||
switch launchpad := block.(type) {
|
||||
case blocks.LaunchPad:
|
||||
for _, rocket := range launchpad.Rockets {
|
||||
HeaderLinks = append(HeaderLinks, HeaderLink{
|
||||
Href: rocket.Href(),
|
||||
Display: rocket.Display(),
|
||||
})
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// HeaderLink represents a header link. Header links are the links shown in the top gray bar.
|
||||
type HeaderLink struct {
|
||||
// Href is the URL of the link. It goes <a href="here">...</a>.
|
||||
Href string
|
||||
// Display is what is shown when the link is rendered. It goes <a href="...">here</a>.
|
||||
Display string
|
||||
}
|
||||
@ -2,12 +2,10 @@
|
||||
package files
|
||||
|
||||
import (
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/web/static"
|
||||
"github.com/bouncepaw/mycorrhiza/cfg"
|
||||
)
|
||||
|
||||
var paths struct {
|
||||
@ -18,14 +16,13 @@ var paths struct {
|
||||
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 filepath.ToSlash(paths.gitRepo) }
|
||||
func HyphaeDir() string { return paths.gitRepo }
|
||||
|
||||
// GitRepo returns the path to the Git repository of the wiki.
|
||||
func GitRepo() string { return paths.gitRepo }
|
||||
@ -48,15 +45,9 @@ 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
|
||||
}
|
||||
@ -81,43 +72,6 @@ func PrepareWikiRoot() error {
|
||||
|
||||
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
|
||||
}
|
||||
104
flag.go
104
flag.go
@ -1,21 +1,18 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
_ "embed"
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"log"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"syscall"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/version"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/files"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
"golang.org/x/term"
|
||||
)
|
||||
|
||||
@ -23,7 +20,7 @@ import (
|
||||
|
||||
// printHelp prints the help message.
|
||||
func printHelp() {
|
||||
_, _ = fmt.Fprintf(
|
||||
fmt.Fprintf(
|
||||
flag.CommandLine.Output(),
|
||||
"Usage: %s WIKI_PATH\n",
|
||||
os.Args[0],
|
||||
@ -32,94 +29,65 @@ func printHelp() {
|
||||
}
|
||||
|
||||
// parseCliArgs parses CLI options and sets several important global variables. Call it early.
|
||||
func parseCliArgs() error {
|
||||
func parseCliArgs() {
|
||||
var createAdminName string
|
||||
var versionFlag bool
|
||||
|
||||
flag.StringVar(&cfg.ListenAddr, "listen-addr", "", "Address to listen on. For example, 127.0.0.1:1737 or /run/mycorrhiza.sock.")
|
||||
flag.StringVar(&createAdminName, "create-admin", "", "Create a new admin. The password will be prompted in the terminal.")
|
||||
flag.BoolVar(&versionFlag, "version", false, "Print version information and exit.")
|
||||
flag.Usage = printHelp
|
||||
flag.Parse()
|
||||
|
||||
if versionFlag {
|
||||
slog.Info("Running Mycorrhiza Wiki", "version", version.Long)
|
||||
os.Exit(0)
|
||||
}
|
||||
|
||||
args := flag.Args()
|
||||
if len(args) == 0 {
|
||||
slog.Error("Pass a wiki directory")
|
||||
return errors.New("wiki directory not passed")
|
||||
log.Fatal("error: pass a wiki directory")
|
||||
}
|
||||
|
||||
wikiDir, err := filepath.Abs(args[0])
|
||||
if err != nil {
|
||||
slog.Error("Failed to take absolute filepath of wiki directory",
|
||||
"path", args[0], "err", err)
|
||||
return err
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
cfg.WikiDir = wikiDir
|
||||
|
||||
if createAdminName != "" {
|
||||
if err := createAdminCommand(createAdminName); err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
createAdminCommand(createAdminName)
|
||||
os.Exit(0)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func createAdminCommand(name string) error {
|
||||
func createAdminCommand(name string) {
|
||||
wr := log.Writer()
|
||||
log.SetFlags(0)
|
||||
|
||||
if err := files.PrepareWikiRoot(); err != nil {
|
||||
slog.Error("Failed to prepare wiki root", "err", err)
|
||||
return err
|
||||
log.Fatal("error: ", err)
|
||||
}
|
||||
cfg.UseAuth = true
|
||||
cfg.AllowRegistration = true
|
||||
|
||||
log.SetOutput(io.Discard)
|
||||
user.InitUserDatabase()
|
||||
log.SetOutput(wr)
|
||||
|
||||
password, err := askPass("Password")
|
||||
handle /*rug*/ := syscall.Stdin
|
||||
if !term.IsTerminal(handle) {
|
||||
log.Fatal("error: not a terminal")
|
||||
}
|
||||
|
||||
fmt.Print("Password: ")
|
||||
passwordBytes, err := term.ReadPassword(handle)
|
||||
fmt.Print("\n")
|
||||
if err != nil {
|
||||
slog.Error("Failed to prompt password", "err", err)
|
||||
return err
|
||||
log.Fatal("error: ", err)
|
||||
}
|
||||
if err := user.Register(name, password, "admin", "local", true); err != nil {
|
||||
slog.Error("Failed to register admin", "err", err)
|
||||
return err
|
||||
|
||||
password := string(passwordBytes)
|
||||
|
||||
log.SetOutput(io.Discard)
|
||||
err = user.Register(name, password, "admin", "local", true)
|
||||
log.SetOutput(wr)
|
||||
|
||||
if err != nil {
|
||||
log.Fatal("error: ", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func askPass(prompt string) (string, error) {
|
||||
var password []byte
|
||||
var err error
|
||||
fd := int(os.Stdin.Fd())
|
||||
|
||||
if term.IsTerminal(fd) {
|
||||
fmt.Printf("%s: ", prompt)
|
||||
password, err = term.ReadPassword(int(os.Stdin.Fd()))
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
fmt.Println()
|
||||
} else {
|
||||
fmt.Fprintf(os.Stderr, "Warning: Reading password from stdin.\n")
|
||||
// TODO: the buffering messes up repeated calls to readPassword
|
||||
scanner := bufio.NewScanner(os.Stdin)
|
||||
if !scanner.Scan() {
|
||||
if err := scanner.Err(); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return "", io.ErrUnexpectedEOF
|
||||
}
|
||||
password = scanner.Bytes()
|
||||
|
||||
if len(password) == 0 {
|
||||
return "", fmt.Errorf("zero length password")
|
||||
}
|
||||
}
|
||||
|
||||
return string(password), nil
|
||||
}
|
||||
|
||||
27
go.mod
27
go.mod
@ -1,22 +1,29 @@
|
||||
module github.com/bouncepaw/mycorrhiza
|
||||
|
||||
go 1.21
|
||||
go 1.18
|
||||
|
||||
require (
|
||||
git.sr.ht/~bouncepaw/mycomarkup/v5 v5.6.0
|
||||
github.com/go-ini/ini v1.67.0
|
||||
github.com/gorilla/feeds v1.2.0
|
||||
github.com/gorilla/mux v1.8.1
|
||||
golang.org/x/crypto v0.31.0
|
||||
golang.org/x/term v0.27.0
|
||||
golang.org/x/text v0.21.0
|
||||
github.com/bouncepaw/mycomarkup/v3 v3.6.3
|
||||
github.com/go-ini/ini v1.63.2
|
||||
github.com/gorilla/feeds v1.1.1
|
||||
github.com/gorilla/mux v1.8.0
|
||||
github.com/valyala/quicktemplate v1.7.0
|
||||
golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa
|
||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211
|
||||
golang.org/x/text v0.3.7
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/kr/pretty v0.2.1 // indirect
|
||||
github.com/stretchr/testify v1.7.0 // indirect
|
||||
golang.org/x/sys v0.28.0 // indirect
|
||||
github.com/valyala/bytebufferpool v1.0.0 // indirect
|
||||
golang.org/x/sys v0.0.0-20211109184856-51b60fd695b3 // indirect
|
||||
)
|
||||
|
||||
// Use this trick to test local Mycomarkup changes, replace the path with yours,
|
||||
// but do not commit the change to the path:
|
||||
// replace git.sr.ht/~bouncepaw/mycomarkup/v5 v5.6.0 => "/Users/bouncepaw/src/mycomarkup"
|
||||
// replace github.com/bouncepaw/mycomarkup/v3 v3.6.3 => "/Users/bouncepaw/GolandProjects/mycomarkup"
|
||||
|
||||
// Use this utility every time Mycomarkup gets a major update:
|
||||
// https://github.com/marwan-at-work/mod
|
||||
// Or maybe just ⌘⇧R every time, the utility is kinda weird.
|
||||
|
||||
64
go.sum
64
go.sum
@ -1,32 +1,52 @@
|
||||
git.sr.ht/~bouncepaw/mycomarkup/v5 v5.6.0 h1:zAZwMF+6x8U/nunpqPRVYoDiqVUMBHI04PG8GsDrFOk=
|
||||
git.sr.ht/~bouncepaw/mycomarkup/v5 v5.6.0/go.mod h1:TCzFBqW11En4EjLfcQtJu8C/Ro7FIFR8vZ+nM9f6Q28=
|
||||
github.com/andybalholm/brotli v1.0.2/go.mod h1:loMXtMfwqflxFJPmdbJO0a3KNoPuLBgiu3qAvBg8x/Y=
|
||||
github.com/andybalholm/brotli v1.0.3/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
|
||||
github.com/bouncepaw/mycomarkup/v3 v3.6.3 h1:FQzzCxrHAEFBjPKFF/7R9gamyeU/8Cn+cFZEgngYtjE=
|
||||
github.com/bouncepaw/mycomarkup/v3 v3.6.3/go.mod h1:BpiGUVsYCgRZCDxF0iIdc08LJokm/Ab36S/Hif0J6D0=
|
||||
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/go-ini/ini v1.67.0 h1:z6ZrTEZqSWOTyH2FlglNbNgARyHG8oLW9gMELqKr06A=
|
||||
github.com/go-ini/ini v1.67.0/go.mod h1:ByCAeIL28uOIIG0E3PJtZPDL8WnHpFKFOtgjp+3Ies8=
|
||||
github.com/gorilla/feeds v1.2.0 h1:O6pBiXJ5JHhPvqy53NsjKOThq+dNFm8+DFrxBEdzSCc=
|
||||
github.com/gorilla/feeds v1.2.0/go.mod h1:WMib8uJP3BbY+X8Szd1rA5Pzhdfh+HCCAYT2z7Fza6Y=
|
||||
github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
|
||||
github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
|
||||
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
|
||||
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
|
||||
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/go-ini/ini v1.63.2 h1:kwN3umicd2HF3Tgvap4um1ZG52/WyKT9GGdPx0CJk6Y=
|
||||
github.com/go-ini/ini v1.63.2/go.mod h1:ByCAeIL28uOIIG0E3PJtZPDL8WnHpFKFOtgjp+3Ies8=
|
||||
github.com/golang/snappy v0.0.3/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
|
||||
github.com/gorilla/feeds v1.1.1 h1:HwKXxqzcRNg9to+BbvJog4+f3s/xzvtZXICcQGutYfY=
|
||||
github.com/gorilla/feeds v1.1.1/go.mod h1:Nk0jZrvPFZX1OBe5NPiddPw7CfwF6Q9eqzaBbaightA=
|
||||
github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
|
||||
github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
|
||||
github.com/klauspost/compress v1.13.4/go.mod h1:8dP1Hq4DHOhN9w426knH3Rhby4rFm6D8eO+e+Dq5Gzg=
|
||||
github.com/klauspost/compress v1.13.5/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk=
|
||||
github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
|
||||
github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
|
||||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
|
||||
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
|
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
|
||||
github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
|
||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=
|
||||
golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
|
||||
golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
|
||||
golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/term v0.27.0 h1:WP60Sv1nlK1T6SupCHbXzSaN0b9wUmsPoRS9b61A23Q=
|
||||
golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM=
|
||||
golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
|
||||
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
|
||||
github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
|
||||
github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
|
||||
github.com/valyala/fasthttp v1.30.0/go.mod h1:2rsYD01CKFrjjsvFxx75KlEUNpWNBY9JWD3K/7o2Cus=
|
||||
github.com/valyala/quicktemplate v1.7.0 h1:LUPTJmlVcb46OOUY3IeD9DojFpAVbsG+5WFTcjMJzCM=
|
||||
github.com/valyala/quicktemplate v1.7.0/go.mod h1:sqKJnoaOF88V07vkO+9FL8fb9uZg/VPSJnLYn+LmLk8=
|
||||
github.com/valyala/tcplisten v1.0.0/go.mod h1:T0xQ8SeCZGxckz9qRXTfG43PvQ/mcWh7FwZEA7Ioqkc=
|
||||
golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
|
||||
golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa h1:idItI2DDfCokpg0N51B2VtiLdJ4vAuXC9fnCb2gACo4=
|
||||
golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
||||
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
||||
golang.org/x/net v0.0.0-20210510120150-4163338589ed/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
|
||||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210514084401-e8d321eab015/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20211109184856-51b60fd695b3 h1:T6tyxxvHMj2L1R2kZg0uNMpS8ZhB9lRa9XRGTCSA65w=
|
||||
golang.org/x/sys v0.0.0-20211109184856-51b60fd695b3/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
|
||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
|
||||
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
|
||||
11
help/en.myco
11
help/en.myco
@ -1,8 +1,11 @@
|
||||
= Help
|
||||
|
||||
This is documentation for Mycorrhiza Wiki 1.15.1. Choose a topic from the list.
|
||||
This is documentation for **Mycorrhiza Wiki** 1.9.
|
||||
|
||||
The documentation is incomplete. If you want to contribute to the documentation, open a pull request or an issue on [[https://github.com/bouncepaw/mycorrhiza | GitHub]] or [[https://lists.sr.ht/~bouncepaw/mycorrhiza-devel | send a patch]].
|
||||
//Choose a topic from the list.//
|
||||
|
||||
=> https://mycorrhiza.wiki | Official wiki
|
||||
=> https://floss.social/@mycorrhiza | Fediverse
|
||||
Currently, the documentation does not cover everything there is to cover, but it will probably change in the future.
|
||||
|
||||
If you want to contribute to the documentation, open a pull request or an issue on [[https://github.com/bouncepaw/mycorrhiza | GitHub]].
|
||||
|
||||
=> https://mycorrhiza.wiki | Official wiki
|
||||
@ -7,5 +7,3 @@ Category names follow the same rules as hypha names: case-insensitive, spaces an
|
||||
|
||||
To see the list of all categories, see:
|
||||
=> /category
|
||||
|
||||
Only trusted editors (and higher) can modify categories.
|
||||
@ -7,10 +7,10 @@ The file is generated automatically when you create a new wiki:
|
||||
|
||||
```
|
||||
# Generate a new wiki
|
||||
$ mycorrhiza best-wiki
|
||||
$ mycorrhiza bestWiki
|
||||
...
|
||||
# See what's inside
|
||||
$ ls best-wiki
|
||||
$ ls bestWiki
|
||||
cache config.ini static wiki.git
|
||||
```
|
||||
|
||||
@ -19,7 +19,7 @@ The file is written in the [[https://en.wikipedia.org/wiki/INI_file | .ini forma
|
||||
== Example configuration
|
||||
The auto-generated file is the best example (it has comments too).
|
||||
|
||||
Here's an example of a configuration file adapted from the default:
|
||||
Here's another example:
|
||||
```ini
|
||||
WikiName = My wiki
|
||||
NaviTitleIcon = 🐑
|
||||
@ -30,12 +30,12 @@ UserHypha = u
|
||||
HeaderLinksHypha = header-links
|
||||
|
||||
[Network]
|
||||
ListenAddr = 0.0.0.0:8080
|
||||
HTTPPort = 8080
|
||||
URL = https://wiki
|
||||
GeminiCertificatePath = /home/wiki/gemcerts
|
||||
|
||||
[Authorization]
|
||||
UseAuth = true
|
||||
AllowRegistration = true
|
||||
UseRegistration = true
|
||||
```
|
||||
|
||||
== Fields
|
||||
@ -46,27 +46,18 @@ AllowRegistration = true
|
||||
=== [Hyphae]
|
||||
* `HomeHypha`: //string//. The name your home hypha has. **Default:** `home`.
|
||||
* `UserHypha`: //string//. The name of the hypha that is parent of all user hyphae. **Default:** `u`.
|
||||
* `HeaderLinkHypha`: //string//. The name of the hypha where you can configure the header. See [[/help/en/top_bar]]. There is no default.
|
||||
* `HeaderLinkHypha`: //string//. The name of the hypha where you can configure the header. There is no default.
|
||||
|
||||
=== [Network]
|
||||
* `ListenAddr`: //number//. What port is used for serving the web interface of Mycorrhiza. **Default:** `1737`.
|
||||
* `HTTPPort`: //number//. What port is used for serving the web interface of Mycorrhiza. **Default:** `1737`.
|
||||
* `URL`: //url//. What URL is used for Opengraph and Web feed in the web interface. There is no default and you really should set it to something.
|
||||
|
||||
=== [Authorization]
|
||||
* `UseAuth`: //boolean//. Whether to enable authorization system. **Default:** `false`.
|
||||
* `AllowRegistration`: //boolean//. Whether you want unregistered visitors to be able to register themselves using the web form. **Default:** `false`.
|
||||
* `RegistrationLimit`: //number//. There cannot be more registered users than this number. If the number is zero, there is no limit. Makes sense only when `UseRegistration` is `true`. **Default:** `0`.
|
||||
* `Locked`: //boolean//. Whether the users have to authorize first to access the wiki. **Default:** `false`.
|
||||
* `UseWhiteList`: //boolean//. Whether to use a whitelist to allow specific users in. **Default:** `false`.
|
||||
* `WhiteList`: //list of strings//. Usernames of people to allow in, if `UseWhiteList` is turned on. **Default:** `[]`.
|
||||
* `UseRegistration`: //boolean//. Whether you want unregistered visitors to be able to register themselves using the web form. **Default:** `false`.
|
||||
* `LimitRegistration`: //number//. There cannot be more registered users than this number. If the number is zero, there is no limit. Makes sense only when `UseRegistration` is `true`. **Default:** `0`.
|
||||
|
||||
=== [CustomScripts]
|
||||
You can specify URLs of JavaScript files you want to load.
|
||||
* `CommonScripts`: //list of url//. Comma-separated list of unquoted URLs to JS files to load on //all// pages.
|
||||
* `ViewScripts`: //list of urls//. Comma-separated list of unquoted URLs to JS files to load on //view// pages: `/hypha`, `/rev`.
|
||||
* `EditScripts`: //list of urls//. Comma-separated list of unquoted URLs to JS files to load on the `/edit` page.
|
||||
|
||||
=== [Telegram]
|
||||
You can set up Telegram-based authorization. You have to define both parameters.
|
||||
* `TelegramBotToken`: //string// Token of your bot. There is no default.
|
||||
* `TelegramBotName`: //string// Username of your bot, sans @. There is no default.
|
||||
* `EditScripts`: //list of urls//. Comma-separated list of unquoted URLs to JS files to load on the `/edit` page.
|
||||
@ -1,20 +0,0 @@
|
||||
= File structure
|
||||
//This article is intended for wiki administrators.//
|
||||
|
||||
Every Mycorrhiza wiki is stored in one directory. This document explaints the structure of this directory, what files can be there, and what you should do with them.
|
||||
|
||||
You can edit all of the files manually, if you want, just do your best to not break anything.
|
||||
|
||||
* `config.ini` is the [[/help/en/config_file | configuration file]]. It has comments in it, feel free to edit it.
|
||||
* `wiki.git/` is the Git repository of the wiki, it has all hyphae in it. You can edit it directly, but do not forget to make Git commits with your changes and [[/reindex]] you wiki afterwards.
|
||||
* `static` holds static data. You can access data there from your wiki with addresses like `/static/image.png`.
|
||||
** `static/favicon.ico` is your wiki's favicon, accessed at [[/favicon.ico]] by browsers.
|
||||
** `static/default.css` redefines the engine's default style, if exists. You probably don't need to use it.
|
||||
** `static/custom.css` is loaded after the main style. If you want to make visual changes to your wiki, this is probably where you should do that.
|
||||
** `static/robots.txt` redefines default `robots.txt` file.
|
||||
* `categories.json` contains the information about all categories in your wiki.
|
||||
* `users.json` stores users' information. The passwords are not stored, only their hashes are, this is safe. Their tokens are stored in `cache/tokens.json`.
|
||||
* `interwiki.json` holds the interwiki configuration.
|
||||
* `cache/` holds cached data. If you back up your wiki, you can omit this directory.
|
||||
** `cache/tokens.json` holds users' tokens. By deleting specific tokens, you can log out users remotely.
|
||||
* Mycomarkup migration markers are hidden files prefixed with `.mycomarkup-`. You should probably not touch them.
|
||||
@ -1,66 +0,0 @@
|
||||
= Interwiki
|
||||
**Interwiki** is a means of bringing wikis together, making a federation of them. In Mycorrhiza, one aspect of interwiki is supported: the interwiki links, or the **interlinks**. Most other wiki systems support them too. Interwiki links are shown in green.
|
||||
|
||||
In Mycomarkup, you can address a different wiki by prefixing the link target with a name and a `>` character. For example:
|
||||
```myco
|
||||
[[Wikipedia>Wiki]]
|
||||
=> Mycorrhiza>deployment
|
||||
```
|
||||
|
||||
The interwiki prefixes obey the same naming rules as hyphae. In particular, they are case-insensitive, among other things. Every interwiki entry has one main name and it might have any number of aliases, which can be used interchangeably.
|
||||
|
||||
See [[/interwiki]] for the list of configured interwiki entries. Unlike the WWW, there is no distributed list of wikis similar to DNS, so each wiki administrator has to maintain their own list.
|
||||
|
||||
== Mycorrhiza interwiki
|
||||
Intermycorrhizal interwiki works the best, due to the nature of hyphae. Unlike with some other systems, you can address images from the other wikis reliably.
|
||||
|
||||
```myco
|
||||
img {
|
||||
melanocarpa>quadrat 12
|
||||
}
|
||||
```
|
||||
|
||||
== Setting the intermap
|
||||
//This section is meant for wiki administrators.//
|
||||
**Intermap**, or interwiki map, is the collection of all configured interwiki entries. To configure it, an administrator has to visit [[/interwiki]] and change the existing entries or add a new one.
|
||||
|
||||
Entries have the following fields:
|
||||
*. {
|
||||
**Name.** This is the canonical name of the wiki and one of the prefixes you can use for interlinks.
|
||||
}
|
||||
*. {
|
||||
**Aliases.** They are separated with commas. You don't have to set them up.
|
||||
|
||||
A good idea is to have the full name in the //name// field (such as `wikipedia`), and shorter names in //aliases// (such as `pedia` and `wp`).
|
||||
}
|
||||
*. {
|
||||
**URL.** The URL of the index/home/main page of the wiki. It should not end on trailing slash.
|
||||
}
|
||||
*. {
|
||||
**Engine.** This is the software the target wiki runs.
|
||||
|
||||
There are two engines supported explicitly:
|
||||
* Mycorrhiza
|
||||
* [[https://anagora.org | Agora]]
|
||||
|
||||
Choose the //Generic// option for sites running different software.
|
||||
}
|
||||
*. {
|
||||
**Formats.** Because interlinks are supported for two cases (hyperlinks and images), there has to be a way to convert a resource name to an URL of the resource. Format strings are a way to do that.
|
||||
|
||||
There are two format strings: one for hyperlinks, one for images. They directly correspond to HTML's `href` and `src` attributes of the `a` and `img` tags.
|
||||
|
||||
For Mycorrhiza wikis, you don't have to set them, they are set automatically to the following values (replace `https\:/\/example.org` with the URL of the target wiki):
|
||||
* Link: `https\:/\/example.org/hypha/{NAME}`
|
||||
* Image: `https\:/\/example.org/binary/{NAME}`
|
||||
|
||||
For Agora, they are set to:
|
||||
* Link: `https\:/\/example.org/node/{NAME}`
|
||||
* Image: `https\:/\/example.org/{NAME}`, which doesn't make a lot of sense
|
||||
|
||||
For generic sites, you will have to think of something by yourself. If you do not set it, it will default to `https\:/\/example.org/{NAME}`.
|
||||
|
||||
`{NAME}` is substituted. For example, from link `[\[Melanocarpa\>uxn]]`, `{NAME}` is replaced with `uxn`.
|
||||
}
|
||||
|
||||
You can also change `interwiki.json` directly. Reload the wiki after editing it.
|
||||
@ -23,8 +23,5 @@ https://mycorrhiza.wiki/binary/release/1.3/lock_screenshot
|
||||
|
||||
If they log in, they will be able to navigate the wiki. They are not able to register, though. [[/help/en/telegram | Telegram]] authorization is supported.
|
||||
|
||||
== Readers
|
||||
You might want to add some users to the `reader` group. Readers can log in even to locked wikis, but they cannot edit.
|
||||
|
||||
== See also
|
||||
=> /help/en/whitelist | Whitelist
|
||||
@ -6,7 +6,7 @@ You can upload any media file, but only those listed below will be displayed on
|
||||
|
||||
* **Images:** jpg, gif, png, webp, svg, ico
|
||||
* **Video:** ogg, webm, mp4
|
||||
* **Audio:** ogg, webm, mp3, flac, wav
|
||||
* **Audio:** ogg, webm, mp3
|
||||
|
||||
== How to upload media?
|
||||
For non-existent hyphae, upload a file in the //Upload media// section.
|
||||
|
||||
@ -11,7 +11,7 @@ A Mycomarkup document (which is most often a hypha's text part) consists of //bl
|
||||
=> /help/en/mycomarkup#Rocket_link | Rocket link
|
||||
=> /help/en/mycomarkup#Heading | Heading
|
||||
=> /help/en/mycomarkup#Codeblock | Codeblock
|
||||
=> /help/en/mycomarkup#Thematic_break | Thematic break
|
||||
=> /help/en/mycomarkup#Horizontal_line | Horizontal line
|
||||
=> /help/en/mycomarkup#Image_gallery | Image gallery
|
||||
=> /help/en/mycomarkup#List | List
|
||||
=> /help/en/mycomarkup#Quote | Quote
|
||||
@ -86,7 +86,7 @@ Links to [[hypha | a Hypha]] and [[https://example.org | some website]].
|
||||
```}
|
||||
* Links to [[hypha | a Hypha]] and [[https://example.org | some website]].
|
||||
|
||||
Since hypha names are case-insensitive, these links are basically the same: `[\[hypha]]`, `[\[Hypha]]`, `[\[HYPHA]]`.
|
||||
Since hypha names are case-insensitive, these links are basically the same: `[[hypha]]`, `[[Hypha]]`, `[[HYPHA]]`.
|
||||
|
||||
=== Rocket link
|
||||
**Rocket links** are special links. They take up a whole line. They are not consistent with usual inline links. They were taken from [[https://gemini.circumlunar.space/docs/gemtext.gmi | gemtext]].
|
||||
@ -132,6 +132,8 @@ There are four levels of **headings**. They consist of some equal signs followed
|
||||
|
||||
There is an invisible link that shows the § sign near every heading right after the heading text. You can reveal it with a mouse. If you click it, the URL in the browser will change to the URL leading to that very heading. Try that on headings in this article.
|
||||
|
||||
**NB.** There is the legacy syntax for headings: `# ` to `###### `, similar to Markdown. You should not use them.
|
||||
|
||||
== Codeblock
|
||||
Use **codeblocks** to show code or any other preformatted text. Codeblocks start with triple backticks on column 1 and end similarly. You can write any text after the backticks, it is ignored. Put the preformatted text between them.
|
||||
|
||||
@ -148,8 +150,8 @@ this is preformatted
|
||||
see
|
||||
```
|
||||
|
||||
== Thematic break
|
||||
Write four hyphens to insert a **thematic break**, represented by a horizontal line. Use it to break a theme.
|
||||
== Horizontal line
|
||||
Write four hyphens to insert a **horizontal line**.
|
||||
|
||||
* {```
|
||||
----
|
||||
@ -163,22 +165,22 @@ You can write a description for the image and specify its size.
|
||||
|
||||
* {```
|
||||
img {
|
||||
https://bouncepaw.com/mushroom.jpg
|
||||
https://bouncepaw.com/mushroom.jpg {
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg {
|
||||
Description //here//
|
||||
}
|
||||
https://bouncepaw.com/mushroom.jpg | 100 { Size }
|
||||
https://bouncepaw.com/mushroom.jpg | 50*50
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 100 { Size }
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 50*50
|
||||
}
|
||||
```}
|
||||
* {
|
||||
img {
|
||||
https://bouncepaw.com/mushroom.jpg
|
||||
https://bouncepaw.com/mushroom.jpg {
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg {
|
||||
Description //here//
|
||||
}
|
||||
https://bouncepaw.com/mushroom.jpg | 100 { Size }
|
||||
https://bouncepaw.com/mushroom.jpg | 50*50 { Square }
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 100 { Size }
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 50*50 { Square }
|
||||
}
|
||||
}
|
||||
|
||||
@ -205,25 +207,25 @@ Specify the layout after `img` and before `{`. If you do not write any of them,
|
||||
|
||||
```
|
||||
img grid {
|
||||
https://bouncepaw.com/mushroom.jpg
|
||||
https://bouncepaw.com/mushroom.jpg
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
|
||||
}
|
||||
|
||||
img side {
|
||||
https://bouncepaw.com/mushroom.jpg | 200
|
||||
https://bouncepaw.com/mushroom.jpg | 200
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200
|
||||
}
|
||||
|
||||
This text is wrapped.
|
||||
```
|
||||
img grid {
|
||||
https://bouncepaw.com/mushroom.jpg
|
||||
https://bouncepaw.com/mushroom.jpg
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
|
||||
}
|
||||
|
||||
img side {
|
||||
https://bouncepaw.com/mushroom.jpg | 200
|
||||
https://bouncepaw.com/mushroom.jpg | 200
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200
|
||||
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200
|
||||
}
|
||||
|
||||
This text is wrapped.
|
||||
@ -425,4 +427,4 @@ This is an actual transclusion of a hypha below. It will fail if your wiki does
|
||||
Recursive transclusion is also supported but it is limited to three iterations.
|
||||
|
||||
== See also
|
||||
=> https://mycorrhiza.wiki/hypha/why_mycomarkup | Why it was created
|
||||
=> https://mycorrhiza.wiki/hypha/essay/why_mycomarkup | Why it was created
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
= Orphaned hyphae
|
||||
Page [[/orphans]] lists **orphaned hyphae**, or orphans for short. An orphan is a hypha with no backlinks, i/e not linked anywhere. Being part of a [[/help/en/category | category]] does not de-orphan the hypha.
|
||||
|
||||
This page can be used in some workflows. For example, you may create several hyphae, and get back to linking them later. Locating them in this list might help you.
|
||||
@ -1,21 +0,0 @@
|
||||
= Renaming
|
||||
You can **rename** existing hyphae. On the bottom of the hyphae, there is a //Rename// link. Follow it to open the renaming dialog.
|
||||
|
||||
> You can also access the dialog by pressing `r` or visiting URL `/rename/<hypha name>`.
|
||||
|
||||
Set the new name there. If you don't change it, submitting the form does nothing. Two options are set by default.
|
||||
|
||||
*. **Rename subhyphae too.** If on, subhyphae will remain subhyphae after the renaming. {
|
||||
For example, if you had hyphae //Apple// and //Apple/red// and renamed //Apple// to //Malum//, //Apple/red// would also be renamed to //Malum/red//.
|
||||
}
|
||||
*. **Leave redirections.** If on, the old name will not remain empty. Rather than that, a hypha with a link to the new name is left. This hypha is called a **redirection hypha**. This option also combines with the other option, i/e subhyphae will receive their corresponding redirection hyphae.
|
||||
|
||||
== Redirection hyphae category
|
||||
All redirection hyphae are added to a specific category. By default, the category is [[/category/redirection | Redirection]]. This way, you can find all redirections and modify them.
|
||||
|
||||
=== How to change the category
|
||||
//This section is for wiki administrators only.//
|
||||
|
||||
*. Edit `config.ini`
|
||||
*. Change the `RedirectionCategory` value in the `[Hyphae]` section.
|
||||
*. Save the file, restart the wiki.
|
||||
13
help/en/sibling_hyphae_section.myco
Normal file
13
help/en/sibling_hyphae_section.myco
Normal file
@ -0,0 +1,13 @@
|
||||
= Sibling hyphae section
|
||||
On the right (or below on smaller devices) of hypha pages there is a special section that lists **sibling hyphae**.
|
||||
|
||||
> **Sibling hyphae** are hyphae that are subhyphae of the same hypha. For example, //Fruit/Apple// and //Fruit/Pear// are sibling hyphae to each other.
|
||||
|
||||
The sibling hyphae are listed alphabetically. The name of the hypha you are currently viewing is also part of the list. The rest are links that lead you to the hyphae.
|
||||
|
||||
Sometimes, there are numbers beside the links:
|
||||
* **No number.** The hypha has no subhyphae.
|
||||
* **One number.** The number indicates how many direct subhyphae it has.
|
||||
* **Two numbers.** The first number is the number of direct subhyphae. The second number in parentheses is the number of indirect subhyphae.
|
||||
|
||||
For hypha //Fruit//, hyphae //Fruit/Apple// and //Fruit/Pear// would be direct subhyphae, and hyphae //Fruit/Apple/Red// and //Fruit/Apple/Green// would be indirect subhyphae.
|
||||
@ -1,4 +0,0 @@
|
||||
= Today links
|
||||
Some people use Mycorrhiza to keep their diaries. They put each day's notes into separate hyphae, usually named in the ISO format, for example, `2024-06-01` for the 1st of June, 2024. This date format is especially handy because it aligns with the way Mycorrhiza sorts hyphae, so the days are in order.
|
||||
|
||||
Links [[/today]] and [[/edit-today]] are special links that redirect to or edit the “today” hypha. Put them on your home hypha or on [[/help/en/top_bar | the top bar]].
|
||||
@ -15,7 +15,6 @@ On big screens, the top bar is spread onto two lines.
|
||||
** All hyphae
|
||||
** Random
|
||||
** Help
|
||||
** Categories
|
||||
|
||||
On small screens, the authorization section and the most-used-links section are hidden behind a menu. Click the button to see them. If your browser does not support JavaScript, they are always shown.
|
||||
|
||||
@ -41,11 +40,9 @@ Reload the wiki.
|
||||
|
||||
----
|
||||
|
||||
Edit the hypha. You can put any markup there. Only rocket links will be used for generating the top bar:
|
||||
Edit the hypha. You can put any markup there. Rocket links will be used for generating the top bar:
|
||||
|
||||
```myco
|
||||
This paragraph is unused.
|
||||
|
||||
=> /recent-changes | Recent changes
|
||||
=> Highlights
|
||||
=> Philosophy | Our views on life
|
||||
|
||||
@ -5,12 +5,11 @@ import (
|
||||
"embed"
|
||||
)
|
||||
|
||||
//go:embed en en.myco *.html
|
||||
//go:embed en en.myco
|
||||
var fs embed.FS
|
||||
|
||||
// Get determines what help text you need and returns it. The path is a substring from URL, it follows this form:
|
||||
//
|
||||
// <language>/<topic>
|
||||
// <language>/<topic>
|
||||
func Get(path string) ([]byte, error) {
|
||||
if path == "" {
|
||||
return Get("en")
|
||||
|
||||
@ -1,52 +0,0 @@
|
||||
{{define "title"}}Help{{end}}
|
||||
{{define "body"}}
|
||||
<main class="main-width help">
|
||||
<article>
|
||||
{{if .ContentsHTML}}
|
||||
{{.ContentsHTML}}
|
||||
{{else}}
|
||||
<h1>{{block "entry not found" .}}Entry not found{{end}}</h1>
|
||||
<p>{{block "entry not found invitation" .}}If you want to write this entry by yourself, consider <a class="wikilink wikilink_external wikilink_https" href="https://github.com/bouncepaw/mycorrhiza">contributing</a> it directly.{{end}}</p>
|
||||
{{end}}
|
||||
</article>
|
||||
</main>
|
||||
<aside class="help-topics layout-card">
|
||||
<h2 class="layout-card__title">Help topics</h2>
|
||||
<ul class="help-topics__list">
|
||||
<li><a href="/help/en">Main</a></li>
|
||||
<li><a href="/help/en/hypha">Hypha</a>
|
||||
<ul>
|
||||
<li><a href="/help/en/media">Media</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="/help/en/mycomarkup">Mycomarkup</a></li>
|
||||
<li><a href="/help/en/category">Categories</a></li>
|
||||
<li><a href="/help/en/rename">Renaming</a></li>
|
||||
<li>Interface
|
||||
<ul>
|
||||
<li><a href="/help/en/prevnext">Previous/next</a></li>
|
||||
<li><a href="/help/en/top_bar">Top bar</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Special pages
|
||||
<ul>
|
||||
<li><a href="/help/en/recent_changes">Recent changes</a></li>
|
||||
<li><a href="/help/en/feeds">Feeds</a></li>
|
||||
<li><a href="/help/en/orphans">Orphaned hyphae</a></li>
|
||||
<li><a href="/help/en/today">Today links</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Configuration (for administrators)
|
||||
<ul>
|
||||
<li><a href="/help/en/config_file">Configuration file</a></li>
|
||||
<li><a href="/help/en/lock">Lock</a></li>
|
||||
<li><a href="/help/en/whitelist">Whitelist</a></li>
|
||||
<li><a href="/help/en/telegram">Telegram authentication</a></li>
|
||||
<li><a href="/help/en/interwiki">Interwiki</a></li>
|
||||
<li><a href="/help/en/file_structure">File structure</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</aside>
|
||||
{{end}}
|
||||
|
||||
106
help/web.go
106
help/web.go
@ -1,106 +0,0 @@
|
||||
package help
|
||||
|
||||
// stuff.go is used for meta stuff about the wiki or all hyphae at once.
|
||||
import (
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/mycoopts"
|
||||
"github.com/bouncepaw/mycorrhiza/web/viewutil"
|
||||
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5"
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/mycocontext"
|
||||
|
||||
"github.com/gorilla/mux"
|
||||
)
|
||||
|
||||
var (
|
||||
chain viewutil.Chain
|
||||
ruTranslation = `
|
||||
{{define "title"}}Справка{{end}}
|
||||
{{define "entry not found"}}Статья не найдена{{end}}
|
||||
{{define "entry not found invitation"}}Если вы хотите написать эту статью сами, то будем рады вашим правкам <a class="wikilink wikilink_external wikilink_https" href="https://github.com/bouncepaw/mycorrhiza">в репозитории Микоризы</a>.{{end}}
|
||||
|
||||
{{define "topics"}}Темы справки{{end}}
|
||||
{{define "main"}}Введение{{end}}
|
||||
{{define "hypha"}}Гифа{{end}}
|
||||
{{define "media"}}Медиа{{end}}
|
||||
{{define "mycomarkup"}}Микоразметка{{end}}
|
||||
{{define "category"}}Категории{{end}}
|
||||
{{define "interface"}}Интерфейс{{end}}
|
||||
{{define "prevnext"}}Пред/след{{end}}
|
||||
{{define "top_bar"}}Верхняя панель{{end}}
|
||||
{{define "rename"}}Переименовывание{{end}}
|
||||
{{define "special pages"}}Специальные страницы{{end}}
|
||||
{{define "recent_changes"}}Свежие правки{{end}}
|
||||
{{define "feeds"}}Ленты{{end}}
|
||||
{{define "orphans"}}Гифы-сироты{{end}}
|
||||
{{define "configuration"}}Конфигурация (для администраторов){{end}}
|
||||
{{define "config_file"}}Файл конфигурации{{end}}
|
||||
{{define "lock"}}Замок{{end}}
|
||||
{{define "whitelist"}}Белый список{{end}}
|
||||
{{define "telegram"}}Вход через Телеграм{{end}}
|
||||
{{define "interwiki"}}Интервики{{end}}
|
||||
{{define "file structure"}}Файловая структура{{end}}
|
||||
`
|
||||
)
|
||||
|
||||
func InitHandlers(r *mux.Router) {
|
||||
r.PathPrefix("/help").HandlerFunc(handlerHelp)
|
||||
chain = viewutil.CopyEnRuWith(fs, "view_help.html", ruTranslation)
|
||||
}
|
||||
|
||||
// handlerHelp gets the appropriate documentation or tells you where you (personally) have failed.
|
||||
func handlerHelp(w http.ResponseWriter, rq *http.Request) {
|
||||
// See the history of this file to resurrect the old algorithm that supported multiple languages
|
||||
var (
|
||||
meta = viewutil.MetaFrom(w, rq)
|
||||
articlePath = strings.TrimPrefix(strings.TrimPrefix(rq.URL.Path, "/help/"), "/help")
|
||||
lang = "en"
|
||||
)
|
||||
if articlePath == "" {
|
||||
articlePath = "en"
|
||||
}
|
||||
|
||||
if !strings.HasPrefix(articlePath, "en") {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = io.WriteString(w, "404 Not found")
|
||||
return
|
||||
}
|
||||
|
||||
content, err := Get(articlePath)
|
||||
if err != nil && strings.HasPrefix(err.Error(), "open") {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
viewHelp(meta, lang, "", articlePath)
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
viewHelp(meta, lang, err.Error(), articlePath)
|
||||
return
|
||||
}
|
||||
|
||||
// TODO: change for the function that uses byte array when there is such function in mycomarkup.
|
||||
ctx, _ := mycocontext.ContextFromStringInput(string(content), mycoopts.MarkupOptions(articlePath))
|
||||
ast := mycomarkup.BlockTree(ctx)
|
||||
result := mycomarkup.BlocksToHTML(ctx, ast)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
viewHelp(meta, lang, result, articlePath)
|
||||
}
|
||||
|
||||
type helpData struct {
|
||||
*viewutil.BaseData
|
||||
ContentsHTML string
|
||||
Lang string
|
||||
}
|
||||
|
||||
func viewHelp(meta viewutil.Meta, lang, contentsHTML, articlePath string) {
|
||||
viewutil.ExecutePage(meta, chain, helpData{
|
||||
BaseData: &viewutil.BaseData{
|
||||
Addr: "/help/" + articlePath,
|
||||
},
|
||||
ContentsHTML: contentsHTML,
|
||||
Lang: lang,
|
||||
})
|
||||
}
|
||||
@ -7,7 +7,7 @@ import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/cfg"
|
||||
|
||||
"github.com/gorilla/feeds"
|
||||
)
|
||||
@ -121,7 +121,6 @@ func (grp revisionGroup) feedItem(opts FeedOptions) feeds.Item {
|
||||
Created: grp[len(grp)-1].Time, // earliest revision
|
||||
Updated: grp[0].Time, // latest revision
|
||||
Link: &feeds.Link{Href: cfg.URL + grp[0].bestLink()},
|
||||
Content: grp.descriptionForFeed(opts.order),
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -4,12 +4,12 @@ package history
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"log"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/files"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
)
|
||||
|
||||
@ -21,14 +21,12 @@ var renameMsgPattern = regexp.MustCompile(`^Rename ‘(.*)’ to ‘.*’`)
|
||||
var gitEnv = []string{"GIT_COMMITTER_NAME=wikimind", "GIT_COMMITTER_EMAIL=wikimind@mycorrhiza"}
|
||||
|
||||
// Start finds git and initializes git credentials.
|
||||
func Start() error {
|
||||
func Start() {
|
||||
path, err := exec.LookPath("git")
|
||||
if err != nil {
|
||||
slog.Error("Could not find the Git executable. Check your $PATH.")
|
||||
return err
|
||||
log.Fatal("Could not find the git executable. Check your $PATH.")
|
||||
}
|
||||
gitpath = path
|
||||
return nil
|
||||
}
|
||||
|
||||
// InitGitRepo checks a Git repository and initializes it if necessary.
|
||||
@ -46,7 +44,7 @@ func InitGitRepo() {
|
||||
}
|
||||
}
|
||||
if !isGitRepo {
|
||||
slog.Info("Initializing Git repo", "path", files.HyphaeDir())
|
||||
log.Println("Initializing Git repo at", files.HyphaeDir())
|
||||
gitsh("init")
|
||||
gitsh("config", "core.quotePath", "false")
|
||||
}
|
||||
@ -58,11 +56,11 @@ func gitsh(args ...string) (out bytes.Buffer, err error) {
|
||||
fmt.Printf("$ %v\n", args)
|
||||
cmd := exec.Command(gitpath, args...)
|
||||
cmd.Dir = files.HyphaeDir()
|
||||
cmd.Env = append(cmd.Environ(), gitEnv...)
|
||||
cmd.Env = gitEnv
|
||||
|
||||
b, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
slog.Info("Git command failed", "err", err, "output", string(b))
|
||||
log.Println("gitsh:", err)
|
||||
}
|
||||
return *bytes.NewBuffer(b), err
|
||||
}
|
||||
@ -71,7 +69,7 @@ func gitsh(args ...string) (out bytes.Buffer, err error) {
|
||||
func silentGitsh(args ...string) (out bytes.Buffer, err error) {
|
||||
cmd := exec.Command(gitpath, args...)
|
||||
cmd.Dir = files.HyphaeDir()
|
||||
cmd.Env = append(cmd.Environ(), gitEnv...)
|
||||
cmd.Env = gitEnv
|
||||
|
||||
b, err := cmd.CombinedOutput()
|
||||
return *bytes.NewBuffer(b), err
|
||||
@ -79,9 +77,7 @@ func silentGitsh(args ...string) (out bytes.Buffer, err error) {
|
||||
|
||||
// Rename renames from `from` to `to` using `git mv`.
|
||||
func Rename(from, to string) error {
|
||||
slog.Info("Renaming file with git mv",
|
||||
"from", util.ShorterPath(from),
|
||||
"to", util.ShorterPath(to))
|
||||
log.Println(util.ShorterPath(from), util.ShorterPath(to))
|
||||
_, err := gitsh("mv", "--force", from, to)
|
||||
return err
|
||||
}
|
||||
|
||||
@ -1,227 +0,0 @@
|
||||
// Package histweb provides web stuff for history
|
||||
package histweb
|
||||
|
||||
import (
|
||||
"embed"
|
||||
"fmt"
|
||||
"html/template"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
"github.com/bouncepaw/mycorrhiza/web/viewutil"
|
||||
|
||||
"github.com/gorilla/mux"
|
||||
)
|
||||
|
||||
func InitHandlers(rtr *mux.Router) {
|
||||
rtr.PathPrefix("/primitive-diff/").HandlerFunc(handlerPrimitiveDiff)
|
||||
rtr.HandleFunc("/recent-changes/{count:[0-9]+}", handlerRecentChanges)
|
||||
rtr.HandleFunc("/recent-changes/", func(w http.ResponseWriter, rq *http.Request) {
|
||||
http.Redirect(w, rq, "/recent-changes/20", http.StatusSeeOther)
|
||||
})
|
||||
rtr.PathPrefix("/history/").HandlerFunc(handlerHistory)
|
||||
rtr.HandleFunc("/recent-changes-rss", handlerRecentChangesRSS)
|
||||
rtr.HandleFunc("/recent-changes-atom", handlerRecentChangesAtom)
|
||||
rtr.HandleFunc("/recent-changes-json", handlerRecentChangesJSON)
|
||||
|
||||
chainPrimitiveDiff = viewutil.CopyEnRuWith(fs, "view_primitive_diff.html", ruTranslation)
|
||||
chainRecentChanges = viewutil.CopyEnRuWith(fs, "view_recent_changes.html", ruTranslation)
|
||||
chainHistory = viewutil.CopyEnRuWith(fs, "view_history.html", ruTranslation)
|
||||
}
|
||||
|
||||
func handlerPrimitiveDiff(w http.ResponseWriter, rq *http.Request) {
|
||||
util.PrepareRq(rq)
|
||||
shorterURL := strings.TrimPrefix(rq.URL.Path, "/primitive-diff/")
|
||||
revHash, slug, found := strings.Cut(shorterURL, "/")
|
||||
if !found || !util.IsRevHash(revHash) || len(slug) < 1 {
|
||||
http.Error(w, "403 bad request", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
var (
|
||||
mycoFilePath string
|
||||
h = hyphae.ByName(util.CanonicalName(slug))
|
||||
)
|
||||
switch h := h.(type) {
|
||||
case hyphae.ExistingHypha:
|
||||
mycoFilePath = h.TextFilePath()
|
||||
case *hyphae.EmptyHypha:
|
||||
mycoFilePath = filepath.Join(files.HyphaeDir(), h.CanonicalName()+".myco")
|
||||
}
|
||||
text, err := history.PrimitiveDiffAtRevision(mycoFilePath, revHash)
|
||||
if err != nil {
|
||||
http.Error(w, err.Error(), http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
primitiveDiff(viewutil.MetaFrom(w, rq), h, revHash, text)
|
||||
}
|
||||
|
||||
// handlerRecentChanges displays the /recent-changes/ page.
|
||||
func handlerRecentChanges(w http.ResponseWriter, rq *http.Request) {
|
||||
// Error ignored: filtered by regex
|
||||
editCount, _ := strconv.Atoi(mux.Vars(rq)["count"])
|
||||
if editCount > 100 {
|
||||
return
|
||||
}
|
||||
recentChanges(viewutil.MetaFrom(w, rq), editCount, history.RecentChanges(editCount))
|
||||
}
|
||||
|
||||
// handlerHistory lists all revisions of a hypha.
|
||||
func handlerHistory(w http.ResponseWriter, rq *http.Request) {
|
||||
hyphaName := util.HyphaNameFromRq(rq, "history")
|
||||
var list string
|
||||
|
||||
// History can be found for files that do not exist anymore.
|
||||
revs, err := history.Revisions(hyphaName)
|
||||
if err == nil {
|
||||
list = history.WithRevisions(hyphaName, revs)
|
||||
}
|
||||
|
||||
// TODO: extra log, not needed?
|
||||
slog.Info("Found revisions", "hyphaName", hyphaName, "n", len(revs), "err", err)
|
||||
|
||||
historyView(viewutil.MetaFrom(w, rq), hyphaName, list)
|
||||
}
|
||||
|
||||
// genericHandlerOfFeeds is a helper function for the web feed handlers.
|
||||
func genericHandlerOfFeeds(w http.ResponseWriter, rq *http.Request, f func(history.FeedOptions) (string, error), name string, contentType string) {
|
||||
opts, err := history.ParseFeedOptions(rq.URL.Query())
|
||||
var content string
|
||||
if err == nil {
|
||||
content, err = f(opts)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
w.Header().Set("Content-Type", "text/plain;charset=utf-8")
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
fmt.Fprint(w, "An error while generating "+name+": "+err.Error())
|
||||
} else {
|
||||
w.Header().Set("Content-Type", fmt.Sprintf("%s;charset=utf-8", contentType))
|
||||
w.WriteHeader(http.StatusOK)
|
||||
fmt.Fprint(w, content)
|
||||
}
|
||||
}
|
||||
|
||||
func handlerRecentChangesRSS(w http.ResponseWriter, rq *http.Request) {
|
||||
genericHandlerOfFeeds(w, rq, history.RecentChangesRSS, "RSS", "application/rss+xml")
|
||||
}
|
||||
|
||||
func handlerRecentChangesAtom(w http.ResponseWriter, rq *http.Request) {
|
||||
genericHandlerOfFeeds(w, rq, history.RecentChangesAtom, "Atom", "application/atom+xml")
|
||||
}
|
||||
|
||||
func handlerRecentChangesJSON(w http.ResponseWriter, rq *http.Request) {
|
||||
genericHandlerOfFeeds(w, rq, history.RecentChangesJSON, "JSON feed", "application/feed+json")
|
||||
}
|
||||
|
||||
var (
|
||||
//go:embed *.html
|
||||
fs embed.FS
|
||||
ruTranslation = `
|
||||
{{define "history of title"}}История «{{.}}»{{end}}
|
||||
{{define "history of heading"}}История <a href="/hypha/{{.}}">{{beautifulName .}}</a>{{end}}
|
||||
|
||||
{{define "diff for at title"}}Разница для {{beautifulName .HyphaName}} для {{.Hash}}{{end}}
|
||||
{{define "diff for at heading"}}Разница для <a href="/hypha/{{.HyphaName}}">{{beautifulName .HyphaName}}</a> для {{.Hash}}{{end}}
|
||||
{{define "no text diff available"}}Нет текстовой разницы.{{end}}
|
||||
|
||||
{{define "count pre"}}Отобразить{{end}}
|
||||
{{define "count post"}}свежих правок.{{end}}
|
||||
{{define "subscribe via"}}Подписаться через <a href="/recent-changes-rss">RSS</a>, <a href="/recent-changes-atom">Atom</a> или <a href="/recent-changes-json">JSON-ленту</a>.{{end}}
|
||||
{{define "recent changes"}}Свежие правки{{end}}
|
||||
{{define "n recent changes"}}{{.}} свеж{{if eq . 1}}ая правка{{else if le . 4}}их правок{{else}}их правок{{end}}{{end}}
|
||||
{{define "recent empty"}}Правки не найдены.{{end}}
|
||||
`
|
||||
chainPrimitiveDiff, chainRecentChanges, chainHistory viewutil.Chain
|
||||
)
|
||||
|
||||
type recentChangesData struct {
|
||||
*viewutil.BaseData
|
||||
EditCount int
|
||||
Changes []history.Revision
|
||||
UserHypha string
|
||||
Stops []int
|
||||
}
|
||||
|
||||
func recentChanges(meta viewutil.Meta, editCount int, changes []history.Revision) {
|
||||
viewutil.ExecutePage(meta, chainRecentChanges, recentChangesData{
|
||||
BaseData: &viewutil.BaseData{},
|
||||
EditCount: editCount,
|
||||
Changes: changes,
|
||||
UserHypha: cfg.UserHypha,
|
||||
Stops: []int{20, 50, 100},
|
||||
})
|
||||
}
|
||||
|
||||
type primitiveDiffData struct {
|
||||
*viewutil.BaseData
|
||||
HyphaName string
|
||||
Hash string
|
||||
Text template.HTML
|
||||
}
|
||||
|
||||
func primitiveDiff(meta viewutil.Meta, h hyphae.Hypha, hash, text string) {
|
||||
hunks := history.SplitPrimitiveDiff(text)
|
||||
if len(hunks) > 0 {
|
||||
var buf strings.Builder
|
||||
for _, hunk := range hunks {
|
||||
lines := strings.Split(hunk, "\n")
|
||||
buf.WriteString(`<pre class="codeblock">`)
|
||||
for i, line := range lines {
|
||||
line = strings.Trim(line, "\r")
|
||||
var class string
|
||||
if len(line) > 0 {
|
||||
switch line[0] {
|
||||
case '+':
|
||||
class = "primitive-diff__addition"
|
||||
case '-':
|
||||
class = "primitive-diff__deletion"
|
||||
case '@':
|
||||
class = "primitive-diff__context"
|
||||
}
|
||||
}
|
||||
if i > 0 {
|
||||
buf.WriteString("\n")
|
||||
}
|
||||
line = template.HTMLEscapeString(line)
|
||||
fmt.Fprintf(&buf, `<code class="%s">%s</code>`,
|
||||
class, line)
|
||||
}
|
||||
buf.WriteString(`</pre>`)
|
||||
}
|
||||
text = buf.String()
|
||||
} else if text != "" {
|
||||
text = template.HTMLEscapeString(text)
|
||||
text = fmt.Sprintf(
|
||||
`<pre class="codeblock"><code>%s</code></pre>`, text)
|
||||
}
|
||||
viewutil.ExecutePage(meta, chainPrimitiveDiff, primitiveDiffData{
|
||||
BaseData: &viewutil.BaseData{},
|
||||
HyphaName: h.CanonicalName(),
|
||||
Hash: hash,
|
||||
Text: template.HTML(text),
|
||||
})
|
||||
}
|
||||
|
||||
type historyData struct {
|
||||
*viewutil.BaseData
|
||||
HyphaName string
|
||||
Contents string
|
||||
}
|
||||
|
||||
func historyView(meta viewutil.Meta, hyphaName, contents string) {
|
||||
viewutil.ExecutePage(meta, chainHistory, historyData{
|
||||
BaseData: &viewutil.BaseData{
|
||||
Addr: "/history/" + util.CanonicalName(hyphaName),
|
||||
},
|
||||
HyphaName: hyphaName,
|
||||
Contents: contents,
|
||||
})
|
||||
}
|
||||
@ -1,10 +0,0 @@
|
||||
{{define "history of title"}}History of {{.}}{{end}}
|
||||
{{define "title"}}{{template "history of title" .HyphaName}}{{end}}
|
||||
{{define "body"}}
|
||||
<main class="main-width">
|
||||
<article class="history">
|
||||
<h1>{{block "history of heading" .HyphaName}}History of <a href="/hypha/{{.}}">{{beautifulName .}}</a>{{end}}</h1>
|
||||
{{.Contents}}
|
||||
</article>
|
||||
</main>
|
||||
{{end}}
|
||||
@ -1,12 +0,0 @@
|
||||
{{define "diff for at title"}}Diff of {{beautifulName .HyphaName}} at {{.Hash}}{{end}}
|
||||
{{define "diff for at heading"}}Diff of <a href="/hypha/{{.HyphaName}}">{{beautifulName .HyphaName}}</a> at {{.Hash}}{{end}}
|
||||
{{define "no text diff available"}}No text diff available.{{end}}
|
||||
{{define "title"}}{{template "diff for at title" .}}{{end}}
|
||||
{{define "body"}}
|
||||
<main class="main-width">
|
||||
<article>
|
||||
<h1>{{template "diff for at heading" .}}</h1>
|
||||
{{if .Text}}{{.Text}}{{else}}{{template "no text diff available" .}}{{end}}
|
||||
</article>
|
||||
</main>
|
||||
{{end}}
|
||||
@ -1,71 +0,0 @@
|
||||
{{define "recent changes"}}Recent changes{{end}}
|
||||
{{define "n recent changes"}}{{.}} recent change{{if ne . 1}}s{{end}}{{end}}
|
||||
{{define "title"}}{{template "n recent changes" .EditCount}}{{end}}
|
||||
|
||||
{{define "body"}}
|
||||
<main class="main-width recent-changes">
|
||||
<h1>{{template "recent changes"}}</h1>
|
||||
|
||||
{{$userHypha := .UserHypha}}
|
||||
{{$year := 0}}{{$month := 0}}{{$day := 0}}
|
||||
<section class="recent-changes__list" role="feed">
|
||||
{{range $i, $entry := .Changes}}
|
||||
{{$time := $entry.Time.UTC}}
|
||||
{{$y := $time.Year}}{{$m := $time.Month}}{{$d := $time.Day}}
|
||||
{{if or (ne $d $day) (ne $m $month) (ne $y $year)}}
|
||||
<h2 class="recent-changes__heading">
|
||||
{{printf "%04d-%02d-%02d" $y $m $d}}
|
||||
</h2>
|
||||
{{$year = $y}}{{$month = $m}}{{$day = $d}}
|
||||
{{end}}
|
||||
|
||||
<div class="recent-changes__entry">
|
||||
<div>
|
||||
<time class="recent-changes__entry__time">
|
||||
{{ $time.Format "15:04 UTC" }}
|
||||
</time>
|
||||
<span class="recent-changes__entry__message">
|
||||
{{$entry.HyphaeDiffsHTML}}
|
||||
</span>
|
||||
{{ if $entry.Username | ne "anon" }}
|
||||
<span class="recent-changes__entry__author">
|
||||
— <a href="/hypha/{{$userHypha}}/{{$entry.Username}}" rel="author">{{$entry.Username}}</a>
|
||||
</span>
|
||||
{{end}}
|
||||
</div>
|
||||
<div>
|
||||
<span class="recent-changes__entry__links">
|
||||
{{$entry.HyphaeLinksHTML}}
|
||||
</span>
|
||||
<span class="recent-changes__entry__message">
|
||||
{{$entry.Message}}
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
{{else}}
|
||||
<p>{{block "recent empty" .}}No recent changes found.{{end}}</p>
|
||||
{{end}}
|
||||
</section>
|
||||
|
||||
<p class="recent-changes__count">
|
||||
{{block "count pre" .}}See{{end}}
|
||||
{{ $editCount := .EditCount }}
|
||||
{{range $i, $m := .Stops }}
|
||||
{{if gt $i 0}}
|
||||
<span aria-hidden="true">|</span>
|
||||
{{end}}
|
||||
{{if $m | eq $editCount}}
|
||||
<b>{{$m}}</b>
|
||||
{{else}}
|
||||
<a href="/recent-changes/{{$m}}">{{$m}}</a>
|
||||
{{end}}
|
||||
{{end}}
|
||||
{{block "count post" .}}recent changes{{end}}
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<img class="icon" width="20" height="20" src="/static/icon/feed.svg" aria-hidden="true" alt="RSS icon">
|
||||
{{block "subscribe via" .}}Subscribe via <a href="/recent-changes-rss">RSS</a>, <a href="/recent-changes-atom">Atom</a> or <a href="/recent-changes-json">JSON feed</a>.{{end}}
|
||||
</p>
|
||||
</main>
|
||||
{{end}}
|
||||
@ -8,7 +8,7 @@ import (
|
||||
"path/filepath"
|
||||
"sync"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
)
|
||||
|
||||
@ -118,7 +118,6 @@ func (hop *Op) Apply() *Op {
|
||||
"commit",
|
||||
"--author='"+hop.name+" <"+hop.email+">'",
|
||||
"--message="+hop.userMsg,
|
||||
"--no-gpg-sign",
|
||||
)
|
||||
gitMutex.Unlock()
|
||||
return hop
|
||||
|
||||
@ -2,72 +2,18 @@ package history
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"html"
|
||||
"log/slog"
|
||||
"net/url"
|
||||
"os"
|
||||
"log"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/files"
|
||||
)
|
||||
|
||||
// WithRevisions returns an HTML representation of `revs` that is meant to be inserted in a history page.
|
||||
func WithRevisions(hyphaName string, revs []Revision) string {
|
||||
var buf strings.Builder
|
||||
|
||||
for _, grp := range groupRevisionsByMonth(revs) {
|
||||
currentYear := grp[0].Time.Year()
|
||||
currentMonth := grp[0].Time.Month()
|
||||
sectionId := fmt.Sprintf("%04d-%02d", currentYear, currentMonth)
|
||||
|
||||
buf.WriteString(fmt.Sprintf(
|
||||
`<section class="history__month">
|
||||
<a href="#%s" class="history__month-anchor">
|
||||
<h2 id="%s" class="history__month-title">%d %s</h2>
|
||||
</a>
|
||||
<ul class="history__entries">`,
|
||||
sectionId, sectionId, currentYear, currentMonth.String(),
|
||||
))
|
||||
|
||||
for _, rev := range grp {
|
||||
buf.WriteString(fmt.Sprintf(
|
||||
`<li class="history__entry">
|
||||
<a class="history-entry" href="/rev/%s/%s">
|
||||
<time class="history-entry__time">%s</time>
|
||||
</a>
|
||||
<span class="history-entry__hash"><a href="/primitive-diff/%s/%s">%s</a></span>
|
||||
<span class="history-entry__msg">%s</span>`,
|
||||
rev.Hash, hyphaName,
|
||||
rev.timeToDisplay(),
|
||||
rev.Hash, hyphaName, rev.Hash,
|
||||
html.EscapeString(rev.Message),
|
||||
))
|
||||
|
||||
if rev.Username != "anon" {
|
||||
buf.WriteString(fmt.Sprintf(
|
||||
`<span class="history-entry__author">by <a href="/hypha/%s/%s" rel="author">%s</a></span>`,
|
||||
cfg.UserHypha, rev.Username, rev.Username,
|
||||
))
|
||||
}
|
||||
|
||||
buf.WriteString("</li>\n")
|
||||
}
|
||||
|
||||
buf.WriteString(`</ul></section>`)
|
||||
}
|
||||
|
||||
return buf.String()
|
||||
}
|
||||
|
||||
// Revision represents a revision of a hypha.
|
||||
// Revision represents a revision, duh. Hash is usually short. Username is extracted from email.
|
||||
type Revision struct {
|
||||
// Hash is usually short.
|
||||
Hash string
|
||||
// Username is extracted from email.
|
||||
Hash string
|
||||
Username string
|
||||
Time time.Time
|
||||
Message string
|
||||
@ -75,74 +21,13 @@ type Revision struct {
|
||||
hyphaeAffectedBuf []string
|
||||
}
|
||||
|
||||
// HyphaeDiffsHTML returns a comma-separated list of diffs links of current revision for every affected file as HTML string.
|
||||
func (rev Revision) HyphaeDiffsHTML() string {
|
||||
entries := rev.hyphaeAffected()
|
||||
if len(entries) == 1 {
|
||||
return fmt.Sprintf(
|
||||
`<a href="/primitive-diff/%s/%s">%s</a>`,
|
||||
rev.Hash, entries[0], rev.Hash,
|
||||
)
|
||||
}
|
||||
|
||||
var buf strings.Builder
|
||||
for i, hyphaName := range entries {
|
||||
if i > 0 {
|
||||
buf.WriteString(`<span aria-hidden="true">, </span>`)
|
||||
}
|
||||
buf.WriteString(`<a href="/primitive-diff/`)
|
||||
buf.WriteString(rev.Hash)
|
||||
buf.WriteString(`/`)
|
||||
buf.WriteString(hyphaName)
|
||||
buf.WriteString(`">`)
|
||||
if i == 0 {
|
||||
buf.WriteString(rev.Hash)
|
||||
buf.WriteString(" ")
|
||||
}
|
||||
buf.WriteString(hyphaName)
|
||||
buf.WriteString(`</a>`)
|
||||
}
|
||||
return buf.String()
|
||||
}
|
||||
|
||||
// descriptionForFeed generates a good enough HTML contents for a web feed.
|
||||
func (rev *Revision) descriptionForFeed() string {
|
||||
return fmt.Sprintf(
|
||||
`<p><b>%s</b> (by %s at %s)</p>
|
||||
<p>Hyphae affected: %s</p>
|
||||
<pre><code>%s</code></pre>`,
|
||||
rev.Message, rev.Username, rev.TimeString(),
|
||||
rev.HyphaeLinksHTML(),
|
||||
rev.textDiff(),
|
||||
)
|
||||
}
|
||||
|
||||
// HyphaeLinksHTML returns a comma-separated list of hyphae that were affected by this revision as HTML string.
|
||||
func (rev Revision) HyphaeLinksHTML() string {
|
||||
var buf strings.Builder
|
||||
for i, hyphaName := range rev.hyphaeAffected() {
|
||||
if i > 0 {
|
||||
buf.WriteString(`<span aria-hidden="true">, <span>`)
|
||||
}
|
||||
|
||||
urlSafeHyphaName := url.PathEscape(hyphaName)
|
||||
buf.WriteString(fmt.Sprintf(`<a href="/hypha/%s">%s</a>`, urlSafeHyphaName, hyphaName))
|
||||
}
|
||||
return buf.String()
|
||||
}
|
||||
|
||||
// gitLog calls `git log` and parses the results.
|
||||
func gitLog(args ...string) ([]Revision, error) {
|
||||
args = append([]string{
|
||||
"log", "--abbrev-commit", "--no-merges",
|
||||
"--pretty=format:%h\t%ae\t%at\t%s",
|
||||
}, args...)
|
||||
args = append(args, "--")
|
||||
out, err := silentGitsh(args...)
|
||||
if strings.Contains(out.String(), "bad revision 'HEAD'") {
|
||||
// Then we have no recent changes! It's a hack.
|
||||
return nil, nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@ -178,17 +63,11 @@ func (stream *recentChangesStream) next(n int) []Revision {
|
||||
// currHash is the last revision from the last call, so skip it
|
||||
args = append(args, "--skip=1", stream.currHash)
|
||||
}
|
||||
|
||||
res, err := gitLog(args...)
|
||||
if err != nil {
|
||||
// TODO: return error
|
||||
slog.Error("Failed to git log", "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
// I don't think this can fail, so ignore the error
|
||||
res, _ := gitLog(args...)
|
||||
if len(res) != 0 {
|
||||
stream.currHash = res[len(res)-1].Hash
|
||||
}
|
||||
|
||||
return res
|
||||
}
|
||||
|
||||
@ -215,14 +94,14 @@ func (stream recentChangesStream) iterator() func() (Revision, bool) {
|
||||
func RecentChanges(n int) []Revision {
|
||||
stream := newRecentChangesStream()
|
||||
revs := stream.next(n)
|
||||
slog.Info("Found recent changes", "n", len(revs))
|
||||
log.Printf("Found %d recent changes", len(revs))
|
||||
return revs
|
||||
}
|
||||
|
||||
// Revisions returns slice of revisions for the given hypha name, ordered most recent first.
|
||||
func Revisions(hyphaName string) ([]Revision, error) {
|
||||
revs, err := gitLog("--", hyphaName+".*")
|
||||
slog.Info("Found revisions", "hyphaName", hyphaName, "n", len(revs), "err", err)
|
||||
log.Printf("Found %d revisions for ‘%s’\n", len(revs), hyphaName)
|
||||
return revs, err
|
||||
}
|
||||
|
||||
@ -296,7 +175,7 @@ func (rev *Revision) hyphaeAffected() (hyphae []string) {
|
||||
filesAffected = rev.filesAffected()
|
||||
)
|
||||
for _, filename := range filesAffected {
|
||||
if strings.ContainsRune(filename, '.') {
|
||||
if strings.IndexRune(filename, '.') >= 0 {
|
||||
dotPos := strings.LastIndexByte(filename, '.')
|
||||
hyphaName := string([]byte(filename)[0:dotPos]) // is it safe?
|
||||
if isNewName(hyphaName) {
|
||||
@ -373,21 +252,3 @@ func PrimitiveDiffAtRevision(filepath, hash string) (string, error) {
|
||||
}
|
||||
return out.String(), err
|
||||
}
|
||||
|
||||
// SplitPrimitiveDiff splits a primitive diff of a single file into hunks.
|
||||
func SplitPrimitiveDiff(text string) (result []string) {
|
||||
idx := strings.Index(text, "@@ -")
|
||||
if idx < 0 {
|
||||
return
|
||||
}
|
||||
text = text[idx:]
|
||||
for {
|
||||
idx = strings.Index(text, "\n@@ -")
|
||||
if idx < 0 {
|
||||
result = append(result, text)
|
||||
return
|
||||
}
|
||||
result = append(result, text[:idx+1])
|
||||
text = text[idx+1:]
|
||||
}
|
||||
}
|
||||
|
||||
55
history/view.qtpl
Normal file
55
history/view.qtpl
Normal file
@ -0,0 +1,55 @@
|
||||
{% import "fmt" %}
|
||||
{% import "github.com/bouncepaw/mycorrhiza/cfg" %}
|
||||
|
||||
HyphaeLinksHTML returns a comma-separated list of hyphae that were affected by this revision as HTML string.
|
||||
{% func (rev Revision) HyphaeLinksHTML() %}
|
||||
{% stripspace %}
|
||||
{% for i, hyphaName := range rev.hyphaeAffected() %}
|
||||
{% if i > 0 %}
|
||||
<span aria-hidden="true">, </span>
|
||||
{% endif %}
|
||||
<a href="/hypha/{%s hyphaName %}">{%s hyphaName %}</a>
|
||||
{% endfor %}
|
||||
{% endstripspace %}
|
||||
{% endfunc %}
|
||||
|
||||
descriptionForFeed generates a good enough HTML contents for a web feed.
|
||||
{% func (rev *Revision) descriptionForFeed() %}
|
||||
<p><b>{%s rev.Message %}</b> (by {%s rev.Username %} at {%s rev.TimeString() %})</p>
|
||||
<p>Hyphae affected: {%= rev.HyphaeLinksHTML() %}</p>
|
||||
<pre><code>{%s rev.textDiff() %}</code></pre>
|
||||
{% endfunc %}
|
||||
|
||||
WithRevisions returns an html representation of `revs` that is meant to be inserted in a history page.
|
||||
{% func WithRevisions(hyphaName string, revs []Revision) %}
|
||||
{% for _, grp := range groupRevisionsByMonth(revs) %}
|
||||
{% code
|
||||
currentYear := grp[0].Time.Year()
|
||||
currentMonth := grp[0].Time.Month()
|
||||
sectionId := fmt.Sprintf("%d-%d", currentYear, currentMonth)
|
||||
%}
|
||||
<section class="history__month">
|
||||
<a href="#{%s sectionId %}" class="history__month-anchor">
|
||||
<h2 id="{%s sectionId %}" class="history__month-title">{%d currentYear %} {%s currentMonth.String() %}</h2>
|
||||
</a>
|
||||
<ul class="history__entries">
|
||||
{% for _, rev := range grp %}
|
||||
{%= rev.asHistoryEntry(hyphaName) %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</section>
|
||||
{% endfor %}
|
||||
{% endfunc %}
|
||||
|
||||
{% func (rev *Revision) asHistoryEntry(hyphaName string) %}
|
||||
<li class="history__entry">
|
||||
<a class="history-entry" href="/rev/{%s rev.Hash %}/{%s hyphaName %}">
|
||||
<time class="history-entry__time">{%s rev.timeToDisplay() %}</time>
|
||||
</a>
|
||||
<span class="history-entry__hash"><a href="/primitive-diff/{%s rev.Hash %}/{%s hyphaName %}">{%s rev.Hash %}</a></span>
|
||||
<span class="history-entry__msg">{%s rev.Message %}</span>
|
||||
{% if rev.Username != "anon" %}
|
||||
<span class="history-entry__author">by <a href="/hypha/{%s cfg.UserHypha %}/{%s rev.Username %}" rel="author">{%s rev.Username %}</a></span>
|
||||
{% endif %}
|
||||
</li>
|
||||
{% endfunc %}
|
||||
326
history/view.qtpl.go
Normal file
326
history/view.qtpl.go
Normal file
@ -0,0 +1,326 @@
|
||||
// Code generated by qtc from "view.qtpl". DO NOT EDIT.
|
||||
// See https://github.com/valyala/quicktemplate for details.
|
||||
|
||||
//line history/view.qtpl:1
|
||||
package history
|
||||
|
||||
//line history/view.qtpl:1
|
||||
import "fmt"
|
||||
|
||||
//line history/view.qtpl:2
|
||||
import "github.com/bouncepaw/mycorrhiza/cfg"
|
||||
|
||||
// HyphaeLinksHTML returns a comma-separated list of hyphae that were affected by this revision as HTML string.
|
||||
|
||||
//line history/view.qtpl:5
|
||||
import (
|
||||
qtio422016 "io"
|
||||
|
||||
qt422016 "github.com/valyala/quicktemplate"
|
||||
)
|
||||
|
||||
//line history/view.qtpl:5
|
||||
var (
|
||||
_ = qtio422016.Copy
|
||||
_ = qt422016.AcquireByteBuffer
|
||||
)
|
||||
|
||||
//line history/view.qtpl:5
|
||||
func (rev Revision) StreamHyphaeLinksHTML(qw422016 *qt422016.Writer) {
|
||||
//line history/view.qtpl:5
|
||||
qw422016.N().S(`
|
||||
`)
|
||||
//line history/view.qtpl:7
|
||||
for i, hyphaName := range rev.hyphaeAffected() {
|
||||
//line history/view.qtpl:8
|
||||
if i > 0 {
|
||||
//line history/view.qtpl:8
|
||||
qw422016.N().S(`<span aria-hidden="true">, </span>`)
|
||||
//line history/view.qtpl:10
|
||||
}
|
||||
//line history/view.qtpl:10
|
||||
qw422016.N().S(`<a href="/hypha/`)
|
||||
//line history/view.qtpl:11
|
||||
qw422016.E().S(hyphaName)
|
||||
//line history/view.qtpl:11
|
||||
qw422016.N().S(`">`)
|
||||
//line history/view.qtpl:11
|
||||
qw422016.E().S(hyphaName)
|
||||
//line history/view.qtpl:11
|
||||
qw422016.N().S(`</a>`)
|
||||
//line history/view.qtpl:12
|
||||
}
|
||||
//line history/view.qtpl:13
|
||||
qw422016.N().S(`
|
||||
`)
|
||||
//line history/view.qtpl:14
|
||||
}
|
||||
|
||||
//line history/view.qtpl:14
|
||||
func (rev Revision) WriteHyphaeLinksHTML(qq422016 qtio422016.Writer) {
|
||||
//line history/view.qtpl:14
|
||||
qw422016 := qt422016.AcquireWriter(qq422016)
|
||||
//line history/view.qtpl:14
|
||||
rev.StreamHyphaeLinksHTML(qw422016)
|
||||
//line history/view.qtpl:14
|
||||
qt422016.ReleaseWriter(qw422016)
|
||||
//line history/view.qtpl:14
|
||||
}
|
||||
|
||||
//line history/view.qtpl:14
|
||||
func (rev Revision) HyphaeLinksHTML() string {
|
||||
//line history/view.qtpl:14
|
||||
qb422016 := qt422016.AcquireByteBuffer()
|
||||
//line history/view.qtpl:14
|
||||
rev.WriteHyphaeLinksHTML(qb422016)
|
||||
//line history/view.qtpl:14
|
||||
qs422016 := string(qb422016.B)
|
||||
//line history/view.qtpl:14
|
||||
qt422016.ReleaseByteBuffer(qb422016)
|
||||
//line history/view.qtpl:14
|
||||
return qs422016
|
||||
//line history/view.qtpl:14
|
||||
}
|
||||
|
||||
// descriptionForFeed generates a good enough HTML contents for a web feed.
|
||||
|
||||
//line history/view.qtpl:17
|
||||
func (rev *Revision) streamdescriptionForFeed(qw422016 *qt422016.Writer) {
|
||||
//line history/view.qtpl:17
|
||||
qw422016.N().S(`
|
||||
<p><b>`)
|
||||
//line history/view.qtpl:18
|
||||
qw422016.E().S(rev.Message)
|
||||
//line history/view.qtpl:18
|
||||
qw422016.N().S(`</b> (by `)
|
||||
//line history/view.qtpl:18
|
||||
qw422016.E().S(rev.Username)
|
||||
//line history/view.qtpl:18
|
||||
qw422016.N().S(` at `)
|
||||
//line history/view.qtpl:18
|
||||
qw422016.E().S(rev.TimeString())
|
||||
//line history/view.qtpl:18
|
||||
qw422016.N().S(`)</p>
|
||||
<p>Hyphae affected: `)
|
||||
//line history/view.qtpl:19
|
||||
rev.StreamHyphaeLinksHTML(qw422016)
|
||||
//line history/view.qtpl:19
|
||||
qw422016.N().S(`</p>
|
||||
<pre><code>`)
|
||||
//line history/view.qtpl:20
|
||||
qw422016.E().S(rev.textDiff())
|
||||
//line history/view.qtpl:20
|
||||
qw422016.N().S(`</code></pre>
|
||||
`)
|
||||
//line history/view.qtpl:21
|
||||
}
|
||||
|
||||
//line history/view.qtpl:21
|
||||
func (rev *Revision) writedescriptionForFeed(qq422016 qtio422016.Writer) {
|
||||
//line history/view.qtpl:21
|
||||
qw422016 := qt422016.AcquireWriter(qq422016)
|
||||
//line history/view.qtpl:21
|
||||
rev.streamdescriptionForFeed(qw422016)
|
||||
//line history/view.qtpl:21
|
||||
qt422016.ReleaseWriter(qw422016)
|
||||
//line history/view.qtpl:21
|
||||
}
|
||||
|
||||
//line history/view.qtpl:21
|
||||
func (rev *Revision) descriptionForFeed() string {
|
||||
//line history/view.qtpl:21
|
||||
qb422016 := qt422016.AcquireByteBuffer()
|
||||
//line history/view.qtpl:21
|
||||
rev.writedescriptionForFeed(qb422016)
|
||||
//line history/view.qtpl:21
|
||||
qs422016 := string(qb422016.B)
|
||||
//line history/view.qtpl:21
|
||||
qt422016.ReleaseByteBuffer(qb422016)
|
||||
//line history/view.qtpl:21
|
||||
return qs422016
|
||||
//line history/view.qtpl:21
|
||||
}
|
||||
|
||||
// WithRevisions returns an html representation of `revs` that is meant to be inserted in a history page.
|
||||
|
||||
//line history/view.qtpl:24
|
||||
func StreamWithRevisions(qw422016 *qt422016.Writer, hyphaName string, revs []Revision) {
|
||||
//line history/view.qtpl:24
|
||||
qw422016.N().S(`
|
||||
`)
|
||||
//line history/view.qtpl:25
|
||||
for _, grp := range groupRevisionsByMonth(revs) {
|
||||
//line history/view.qtpl:25
|
||||
qw422016.N().S(`
|
||||
`)
|
||||
//line history/view.qtpl:27
|
||||
currentYear := grp[0].Time.Year()
|
||||
currentMonth := grp[0].Time.Month()
|
||||
sectionId := fmt.Sprintf("%d-%d", currentYear, currentMonth)
|
||||
|
||||
//line history/view.qtpl:30
|
||||
qw422016.N().S(`
|
||||
<section class="history__month">
|
||||
<a href="#`)
|
||||
//line history/view.qtpl:32
|
||||
qw422016.E().S(sectionId)
|
||||
//line history/view.qtpl:32
|
||||
qw422016.N().S(`" class="history__month-anchor">
|
||||
<h2 id="`)
|
||||
//line history/view.qtpl:33
|
||||
qw422016.E().S(sectionId)
|
||||
//line history/view.qtpl:33
|
||||
qw422016.N().S(`" class="history__month-title">`)
|
||||
//line history/view.qtpl:33
|
||||
qw422016.N().D(currentYear)
|
||||
//line history/view.qtpl:33
|
||||
qw422016.N().S(` `)
|
||||
//line history/view.qtpl:33
|
||||
qw422016.E().S(currentMonth.String())
|
||||
//line history/view.qtpl:33
|
||||
qw422016.N().S(`</h2>
|
||||
</a>
|
||||
<ul class="history__entries">
|
||||
`)
|
||||
//line history/view.qtpl:36
|
||||
for _, rev := range grp {
|
||||
//line history/view.qtpl:36
|
||||
qw422016.N().S(`
|
||||
`)
|
||||
//line history/view.qtpl:37
|
||||
rev.streamasHistoryEntry(qw422016, hyphaName)
|
||||
//line history/view.qtpl:37
|
||||
qw422016.N().S(`
|
||||
`)
|
||||
//line history/view.qtpl:38
|
||||
}
|
||||
//line history/view.qtpl:38
|
||||
qw422016.N().S(`
|
||||
</ul>
|
||||
</section>
|
||||
`)
|
||||
//line history/view.qtpl:41
|
||||
}
|
||||
//line history/view.qtpl:41
|
||||
qw422016.N().S(`
|
||||
`)
|
||||
//line history/view.qtpl:42
|
||||
}
|
||||
|
||||
//line history/view.qtpl:42
|
||||
func WriteWithRevisions(qq422016 qtio422016.Writer, hyphaName string, revs []Revision) {
|
||||
//line history/view.qtpl:42
|
||||
qw422016 := qt422016.AcquireWriter(qq422016)
|
||||
//line history/view.qtpl:42
|
||||
StreamWithRevisions(qw422016, hyphaName, revs)
|
||||
//line history/view.qtpl:42
|
||||
qt422016.ReleaseWriter(qw422016)
|
||||
//line history/view.qtpl:42
|
||||
}
|
||||
|
||||
//line history/view.qtpl:42
|
||||
func WithRevisions(hyphaName string, revs []Revision) string {
|
||||
//line history/view.qtpl:42
|
||||
qb422016 := qt422016.AcquireByteBuffer()
|
||||
//line history/view.qtpl:42
|
||||
WriteWithRevisions(qb422016, hyphaName, revs)
|
||||
//line history/view.qtpl:42
|
||||
qs422016 := string(qb422016.B)
|
||||
//line history/view.qtpl:42
|
||||
qt422016.ReleaseByteBuffer(qb422016)
|
||||
//line history/view.qtpl:42
|
||||
return qs422016
|
||||
//line history/view.qtpl:42
|
||||
}
|
||||
|
||||
//line history/view.qtpl:44
|
||||
func (rev *Revision) streamasHistoryEntry(qw422016 *qt422016.Writer, hyphaName string) {
|
||||
//line history/view.qtpl:44
|
||||
qw422016.N().S(`
|
||||
<li class="history__entry">
|
||||
<a class="history-entry" href="/rev/`)
|
||||
//line history/view.qtpl:46
|
||||
qw422016.E().S(rev.Hash)
|
||||
//line history/view.qtpl:46
|
||||
qw422016.N().S(`/`)
|
||||
//line history/view.qtpl:46
|
||||
qw422016.E().S(hyphaName)
|
||||
//line history/view.qtpl:46
|
||||
qw422016.N().S(`">
|
||||
<time class="history-entry__time">`)
|
||||
//line history/view.qtpl:47
|
||||
qw422016.E().S(rev.timeToDisplay())
|
||||
//line history/view.qtpl:47
|
||||
qw422016.N().S(`</time>
|
||||
</a>
|
||||
<span class="history-entry__hash"><a href="/primitive-diff/`)
|
||||
//line history/view.qtpl:49
|
||||
qw422016.E().S(rev.Hash)
|
||||
//line history/view.qtpl:49
|
||||
qw422016.N().S(`/`)
|
||||
//line history/view.qtpl:49
|
||||
qw422016.E().S(hyphaName)
|
||||
//line history/view.qtpl:49
|
||||
qw422016.N().S(`">`)
|
||||
//line history/view.qtpl:49
|
||||
qw422016.E().S(rev.Hash)
|
||||
//line history/view.qtpl:49
|
||||
qw422016.N().S(`</a></span>
|
||||
<span class="history-entry__msg">`)
|
||||
//line history/view.qtpl:50
|
||||
qw422016.E().S(rev.Message)
|
||||
//line history/view.qtpl:50
|
||||
qw422016.N().S(`</span>
|
||||
`)
|
||||
//line history/view.qtpl:51
|
||||
if rev.Username != "anon" {
|
||||
//line history/view.qtpl:51
|
||||
qw422016.N().S(`
|
||||
<span class="history-entry__author">by <a href="/hypha/`)
|
||||
//line history/view.qtpl:52
|
||||
qw422016.E().S(cfg.UserHypha)
|
||||
//line history/view.qtpl:52
|
||||
qw422016.N().S(`/`)
|
||||
//line history/view.qtpl:52
|
||||
qw422016.E().S(rev.Username)
|
||||
//line history/view.qtpl:52
|
||||
qw422016.N().S(`" rel="author">`)
|
||||
//line history/view.qtpl:52
|
||||
qw422016.E().S(rev.Username)
|
||||
//line history/view.qtpl:52
|
||||
qw422016.N().S(`</a></span>
|
||||
`)
|
||||
//line history/view.qtpl:53
|
||||
}
|
||||
//line history/view.qtpl:53
|
||||
qw422016.N().S(`
|
||||
</li>
|
||||
`)
|
||||
//line history/view.qtpl:55
|
||||
}
|
||||
|
||||
//line history/view.qtpl:55
|
||||
func (rev *Revision) writeasHistoryEntry(qq422016 qtio422016.Writer, hyphaName string) {
|
||||
//line history/view.qtpl:55
|
||||
qw422016 := qt422016.AcquireWriter(qq422016)
|
||||
//line history/view.qtpl:55
|
||||
rev.streamasHistoryEntry(qw422016, hyphaName)
|
||||
//line history/view.qtpl:55
|
||||
qt422016.ReleaseWriter(qw422016)
|
||||
//line history/view.qtpl:55
|
||||
}
|
||||
|
||||
//line history/view.qtpl:55
|
||||
func (rev *Revision) asHistoryEntry(hyphaName string) string {
|
||||
//line history/view.qtpl:55
|
||||
qb422016 := qt422016.AcquireByteBuffer()
|
||||
//line history/view.qtpl:55
|
||||
rev.writeasHistoryEntry(qb422016, hyphaName)
|
||||
//line history/view.qtpl:55
|
||||
qs422016 := string(qb422016.B)
|
||||
//line history/view.qtpl:55
|
||||
qt422016.ReleaseByteBuffer(qb422016)
|
||||
//line history/view.qtpl:55
|
||||
return qs422016
|
||||
//line history/view.qtpl:55
|
||||
}
|
||||
61
httpd.go
61
httpd.go
@ -1,18 +1,17 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"log/slog"
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/cfg"
|
||||
)
|
||||
|
||||
func serveHTTP(handler http.Handler) (err error) {
|
||||
func serveHTTP(handler http.Handler) {
|
||||
server := &http.Server{
|
||||
ReadTimeout: 300 * time.Second,
|
||||
WriteTimeout: 300 * time.Second,
|
||||
@ -21,51 +20,35 @@ func serveHTTP(handler http.Handler) (err error) {
|
||||
}
|
||||
|
||||
if strings.HasPrefix(cfg.ListenAddr, "/") {
|
||||
err = startUnixSocketServer(server, cfg.ListenAddr)
|
||||
startUnixSocketServer(server, cfg.ListenAddr)
|
||||
} else {
|
||||
server.Addr = cfg.ListenAddr
|
||||
err = startHTTPServer(server)
|
||||
startHTTPServer(server)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
func startUnixSocketServer(server *http.Server, socketPath string) error {
|
||||
err := os.Remove(socketPath)
|
||||
func startUnixSocketServer(server *http.Server, socketFile string) {
|
||||
os.Remove(socketFile)
|
||||
|
||||
listener, err := net.Listen("unix", socketFile)
|
||||
if err != nil {
|
||||
slog.Warn("Failed to clean up old socket", "err", err)
|
||||
log.Fatalf("Failed to start a server: %v", err)
|
||||
}
|
||||
defer listener.Close()
|
||||
|
||||
if err := os.Chmod(socketFile, 0666); err != nil {
|
||||
log.Fatalf("Failed to set socket permissions: %v", err)
|
||||
}
|
||||
|
||||
listener, err := net.Listen("unix", socketPath)
|
||||
if err != nil {
|
||||
slog.Error("Failed to start the server", "err", err)
|
||||
return err
|
||||
log.Printf("Listening on Unix socket %s", cfg.ListenAddr)
|
||||
if err := server.Serve(listener); err != http.ErrServerClosed {
|
||||
log.Fatalf("Failed to start a server: %v", err)
|
||||
}
|
||||
defer func(listener net.Listener) {
|
||||
_ = listener.Close()
|
||||
}(listener)
|
||||
|
||||
if err := os.Chmod(socketPath, 0666); err != nil {
|
||||
slog.Error("Failed to set socket permissions", "err", err)
|
||||
return err
|
||||
}
|
||||
|
||||
slog.Info("Listening Unix socket", "addr", socketPath)
|
||||
|
||||
if err := server.Serve(listener); !errors.Is(err, http.ErrServerClosed) {
|
||||
slog.Error("Failed to start the server", "err", err)
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func startHTTPServer(server *http.Server) error {
|
||||
slog.Info("Listening over HTTP", "addr", server.Addr)
|
||||
|
||||
if err := server.ListenAndServe(); !errors.Is(err, http.ErrServerClosed) {
|
||||
slog.Error("Failed to start the server", "err", err)
|
||||
return err
|
||||
func startHTTPServer(server *http.Server) {
|
||||
log.Printf("Listening on %s", server.Addr)
|
||||
if err := server.ListenAndServe(); err != http.ErrServerClosed {
|
||||
log.Fatalf("Failed to start a server: %v", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
@ -2,16 +2,15 @@
|
||||
package backlinks
|
||||
|
||||
import (
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"log/slog"
|
||||
"log"
|
||||
"os"
|
||||
"sort"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
)
|
||||
|
||||
// yieldHyphaBacklinks gets backlinks for the desired hypha, sorts and yields them one by one.
|
||||
func yieldHyphaBacklinks(hyphaName string) <-chan string {
|
||||
// YieldHyphaBacklinks gets backlinks for the desired hypha, sorts and yields them one by one.
|
||||
func YieldHyphaBacklinks(hyphaName string) <-chan string {
|
||||
hyphaName = util.CanonicalName(hyphaName)
|
||||
out := make(chan string)
|
||||
sorted := hyphae.PathographicSort(out)
|
||||
@ -54,33 +53,14 @@ func IndexBacklinks() {
|
||||
}
|
||||
}
|
||||
|
||||
// BacklinksCount returns the amount of backlinks to the hypha. Pass canonical names.
|
||||
func BacklinksCount(hyphaName string) int {
|
||||
if links, exists := backlinkIndex[hyphaName]; exists {
|
||||
// BacklinksCount returns the amount of backlinks to the hypha.
|
||||
func BacklinksCount(h hyphae.Hypha) int {
|
||||
if links, exists := backlinkIndex[h.CanonicalName()]; exists {
|
||||
return len(links)
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
func BacklinksFor(hyphaName string) []string {
|
||||
var backlinks []string
|
||||
for b := range yieldHyphaBacklinks(hyphaName) {
|
||||
backlinks = append(backlinks, b)
|
||||
}
|
||||
return backlinks
|
||||
}
|
||||
|
||||
func Orphans() []string {
|
||||
var orphans []string
|
||||
for h := range hyphae.YieldExistingHyphae() {
|
||||
if BacklinksCount(h.CanonicalName()) == 0 {
|
||||
orphans = append(orphans, h.CanonicalName())
|
||||
}
|
||||
}
|
||||
sort.Strings(orphans)
|
||||
return orphans
|
||||
}
|
||||
|
||||
// Using set here seems like the most appropriate solution
|
||||
type linkSet map[string]struct{}
|
||||
|
||||
@ -108,7 +88,7 @@ func fetchText(h hyphae.Hypha) string {
|
||||
|
||||
text, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
slog.Error("Failed to read file", "path", path, "err", err, "hyphaName", h.CanonicalName())
|
||||
log.Println(err)
|
||||
return ""
|
||||
}
|
||||
return string(text)
|
||||
@ -167,7 +147,7 @@ type backlinkIndexRenaming struct {
|
||||
links []string
|
||||
}
|
||||
|
||||
// apply changes backlink index respective to the operation data
|
||||
// Apply changes backlink index respective to the operation data
|
||||
func (op backlinkIndexRenaming) apply() {
|
||||
for _, link := range op.links {
|
||||
if lSet, exists := backlinkIndex[link]; exists {
|
||||
@ -1,13 +1,11 @@
|
||||
package backlinks
|
||||
|
||||
import (
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/mycoopts"
|
||||
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5"
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/links"
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/mycocontext"
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/tools"
|
||||
"github.com/bouncepaw/mycomarkup/v3"
|
||||
"github.com/bouncepaw/mycomarkup/v3/links"
|
||||
"github.com/bouncepaw/mycomarkup/v3/mycocontext"
|
||||
"github.com/bouncepaw/mycomarkup/v3/tools"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
)
|
||||
|
||||
// UpdateBacklinksAfterEdit is a creation/editing hook for backlinks index
|
||||
@ -36,16 +34,15 @@ func extractHyphaLinks(h hyphae.Hypha) []string {
|
||||
|
||||
// extractHyphaLinksFromContent extracts local hypha links from the provided text.
|
||||
func extractHyphaLinksFromContent(hyphaName string, contents string) []string {
|
||||
ctx, _ := mycocontext.ContextFromStringInput(contents, mycoopts.MarkupOptions(hyphaName))
|
||||
ctx, _ := mycocontext.ContextFromStringInput(hyphaName, contents)
|
||||
linkVisitor, getLinks := tools.LinkVisitor(ctx)
|
||||
// Ignore the result of BlockTree because we call it for linkVisitor.
|
||||
_ = mycomarkup.BlockTree(ctx, linkVisitor)
|
||||
foundLinks := getLinks()
|
||||
var result []string
|
||||
for _, link := range foundLinks {
|
||||
switch link := link.(type) {
|
||||
case *links.LocalLink:
|
||||
result = append(result, link.Target(ctx))
|
||||
if link.OfKind(links.LinkLocalHypha) {
|
||||
result = append(result, link.TargetHypha())
|
||||
}
|
||||
}
|
||||
return result
|
||||
89
hyphae/categories/categories.go
Normal file
89
hyphae/categories/categories.go
Normal file
@ -0,0 +1,89 @@
|
||||
// Package categories provides category management. All operations in this package are mutexed.
|
||||
//
|
||||
// As per the long pondering, this is how categories (cats for short)
|
||||
// work in Mycorrhiza:
|
||||
//
|
||||
// - Cats are not hyphae. Cats are separate entities. This is not as
|
||||
// vibeful as I would have wanted, but seems to be more practical
|
||||
// due to //the reasons//.
|
||||
// - Cats are stored outside of git. Instead, they are stored in a
|
||||
// JSON file, path to which is determined by files.CategoriesJSON.
|
||||
// - Due to not being stored in git, no cat history is tracked, and
|
||||
// cat operations are not mentioned on the recent changes page.
|
||||
// - For cat A, if there are 0 hyphae in the cat, cat A does not
|
||||
// exist. If there are 1 or more hyphae in the cat, cat A exists.
|
||||
package categories
|
||||
|
||||
import "sync"
|
||||
|
||||
// List returns names of all categories.
|
||||
func List() (categoryList []string) {
|
||||
mutex.RLock()
|
||||
for cat, _ := range categoryToHyphae {
|
||||
categoryList = append(categoryList, cat)
|
||||
}
|
||||
mutex.RUnlock()
|
||||
return categoryList
|
||||
}
|
||||
|
||||
// WithHypha returns what categories have the given hypha. The hypha name must be canonical.
|
||||
func WithHypha(hyphaName string) (categoryList []string) {
|
||||
mutex.RLock()
|
||||
defer mutex.RUnlock()
|
||||
if node, ok := hyphaToCategories[hyphaName]; ok {
|
||||
return node.categoryList
|
||||
} else {
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
// Contents returns what hyphae are in the category. If the returned slice is empty, the category does not exist, and vice versa. The category name must be canonical.
|
||||
func Contents(catName string) (hyphaList []string) {
|
||||
mutex.RLock()
|
||||
defer mutex.RUnlock()
|
||||
if node, ok := categoryToHyphae[catName]; ok {
|
||||
return node.hyphaList
|
||||
} else {
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
var mutex sync.RWMutex
|
||||
|
||||
// AddHyphaToCategory adds the hypha to the category and updates the records on the disk. If the hypha is already in the category, nothing happens. Pass canonical names.
|
||||
func AddHyphaToCategory(hyphaName, catName string) {
|
||||
mutex.Lock()
|
||||
if node, ok := hyphaToCategories[hyphaName]; ok {
|
||||
node.storeCategory(catName)
|
||||
} else {
|
||||
hyphaToCategories[hyphaName] = &hyphaNode{categoryList: []string{catName}}
|
||||
}
|
||||
|
||||
if node, ok := categoryToHyphae[catName]; ok {
|
||||
node.storeHypha(hyphaName)
|
||||
} else {
|
||||
categoryToHyphae[catName] = &categoryNode{hyphaList: []string{hyphaName}}
|
||||
}
|
||||
mutex.Unlock()
|
||||
go saveToDisk()
|
||||
}
|
||||
|
||||
// RemoveHyphaFromCategory removes the hypha from the category and updates the records on the disk. If the hypha is not in the category, nothing happens. Pass canonical names.
|
||||
func RemoveHyphaFromCategory(hyphaName, catName string) {
|
||||
mutex.Lock()
|
||||
if node, ok := hyphaToCategories[hyphaName]; ok {
|
||||
node.removeCategory(catName)
|
||||
if len(node.categoryList) == 0 {
|
||||
delete(hyphaToCategories, hyphaName)
|
||||
}
|
||||
}
|
||||
|
||||
if node, ok := categoryToHyphae[catName]; ok {
|
||||
node.removeHypha(hyphaName)
|
||||
if len(node.hyphaList) == 0 {
|
||||
delete(categoryToHyphae, catName)
|
||||
}
|
||||
}
|
||||
mutex.Unlock()
|
||||
go saveToDisk()
|
||||
}
|
||||
@ -2,25 +2,23 @@ package categories
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"log/slog"
|
||||
"os"
|
||||
"slices"
|
||||
"sort"
|
||||
"sync"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/files"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
"log"
|
||||
"os"
|
||||
"sync"
|
||||
)
|
||||
|
||||
var categoryToHyphae = map[string]*categoryNode{}
|
||||
var hyphaToCategories = map[string]*hyphaNode{}
|
||||
|
||||
// Init initializes the category system. Call it after the Structure is initialized. This function might terminate the program in case of a bad mood or filesystem faults.
|
||||
func Init() error {
|
||||
record, err := readCategoriesFromDisk()
|
||||
// InitCategories initializes the category system. Call it after the Structure is initialized. This function might terminate the program in case of a bad mood or filesystem faults.
|
||||
func InitCategories() {
|
||||
var (
|
||||
record, err = readCategoriesFromDisk()
|
||||
)
|
||||
if err != nil {
|
||||
slog.Error("Failed to read categories from disk", "err", err)
|
||||
return err
|
||||
log.Fatalln(err)
|
||||
}
|
||||
|
||||
for _, cat := range record.Categories {
|
||||
@ -31,7 +29,6 @@ func Init() error {
|
||||
for i, hyphaName := range cat.Hyphae {
|
||||
cat.Hyphae[i] = util.CanonicalName(hyphaName)
|
||||
}
|
||||
sort.Strings(cat.Hyphae)
|
||||
categoryToHyphae[cat.Name] = &categoryNode{hyphaList: cat.Hyphae}
|
||||
}
|
||||
|
||||
@ -45,49 +42,53 @@ func Init() error {
|
||||
}
|
||||
}
|
||||
|
||||
slog.Info("Indexed categories", "n", len(categoryToHyphae))
|
||||
return nil
|
||||
log.Println("Found", len(categoryToHyphae), "categories")
|
||||
}
|
||||
|
||||
type categoryNode struct {
|
||||
// TODO: ensure this is sorted
|
||||
hyphaList []string
|
||||
}
|
||||
|
||||
func (cn *categoryNode) storeHypha(hypname string) {
|
||||
i, found := slices.BinarySearch(cn.hyphaList, hypname)
|
||||
if found {
|
||||
return
|
||||
for _, hyphaName := range cn.hyphaList {
|
||||
if hyphaName == hypname {
|
||||
return
|
||||
}
|
||||
}
|
||||
cn.hyphaList = slices.Insert(cn.hyphaList, i, hypname)
|
||||
cn.hyphaList = append(cn.hyphaList, hypname)
|
||||
}
|
||||
|
||||
func (cn *categoryNode) removeHypha(hypname string) {
|
||||
i, found := slices.BinarySearch(cn.hyphaList, hypname)
|
||||
if !found {
|
||||
return
|
||||
for i, hyphaName := range cn.hyphaList {
|
||||
if hyphaName == hypname {
|
||||
cn.hyphaList[i] = cn.hyphaList[len(cn.hyphaList)-1]
|
||||
cn.hyphaList = cn.hyphaList[:len(cn.hyphaList)-1]
|
||||
}
|
||||
}
|
||||
cn.hyphaList = slices.Delete(cn.hyphaList, i, i+1)
|
||||
}
|
||||
|
||||
type hyphaNode struct {
|
||||
// TODO: ensure this is sorted
|
||||
categoryList []string
|
||||
}
|
||||
|
||||
// inserts sorted
|
||||
func (hn *hyphaNode) storeCategory(cat string) {
|
||||
i, found := slices.BinarySearch(hn.categoryList, cat)
|
||||
if found {
|
||||
return
|
||||
for _, category := range hn.categoryList {
|
||||
if category == cat {
|
||||
return
|
||||
}
|
||||
}
|
||||
hn.categoryList = slices.Insert(hn.categoryList, i, cat)
|
||||
hn.categoryList = append(hn.categoryList, cat)
|
||||
}
|
||||
|
||||
func (hn *hyphaNode) removeCategory(cat string) {
|
||||
i, found := slices.BinarySearch(hn.categoryList, cat)
|
||||
if !found {
|
||||
return
|
||||
for i, category := range hn.categoryList {
|
||||
if category == cat {
|
||||
hn.categoryList[i] = hn.categoryList[len(hn.categoryList)-1]
|
||||
hn.categoryList = hn.categoryList[:len(hn.categoryList)-1]
|
||||
}
|
||||
}
|
||||
hn.categoryList = slices.Delete(hn.categoryList, i, i+1)
|
||||
}
|
||||
|
||||
type catFileRecord struct {
|
||||
@ -123,7 +124,9 @@ func readCategoriesFromDisk() (catFileRecord, error) {
|
||||
var fileMutex sync.Mutex
|
||||
|
||||
func saveToDisk() {
|
||||
var record catFileRecord
|
||||
var (
|
||||
record catFileRecord
|
||||
)
|
||||
for name, node := range categoryToHyphae {
|
||||
record.Categories = append(record.Categories, catRecord{
|
||||
Name: name,
|
||||
@ -132,16 +135,13 @@ func saveToDisk() {
|
||||
}
|
||||
data, err := json.MarshalIndent(record, "", "\t")
|
||||
if err != nil {
|
||||
slog.Error("Failed to marshal categories record", "err", err)
|
||||
os.Exit(1) // Better fail now, than later
|
||||
log.Fatalln(err) // Better fail now, than later
|
||||
}
|
||||
|
||||
// TODO: make the data safer somehow?? Back it up before overwriting?
|
||||
fileMutex.Lock()
|
||||
err = os.WriteFile(files.CategoriesJSON(), data, 0666)
|
||||
if err != nil {
|
||||
slog.Error("Failed to write categories.json", "err", err)
|
||||
os.Exit(1)
|
||||
log.Fatalln(err)
|
||||
}
|
||||
fileMutex.Unlock()
|
||||
}
|
||||
@ -1,10 +1,9 @@
|
||||
package hyphae
|
||||
|
||||
import (
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
)
|
||||
|
||||
// ExistingHypha is not EmptyHypha. *MediaHypha and *TextualHypha implement this interface.
|
||||
@ -1,11 +1,11 @@
|
||||
package hyphae
|
||||
|
||||
import (
|
||||
"log/slog"
|
||||
"log"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/mimetype"
|
||||
"github.com/bouncepaw/mycorrhiza/mimetype"
|
||||
)
|
||||
|
||||
// Index finds all hypha files in the full `path` and saves them to the hypha storage.
|
||||
@ -27,10 +27,11 @@ func Index(path string) {
|
||||
switch foundHypha := foundHypha.(type) {
|
||||
case *TextualHypha: // conflict! overwrite
|
||||
storedHypha.mycoFilePath = foundHypha.mycoFilePath
|
||||
slog.Info("File collision",
|
||||
"hypha", foundHypha.CanonicalName(),
|
||||
"usingFile", foundHypha.TextFilePath(),
|
||||
"insteadOf", storedHypha.TextFilePath(),
|
||||
log.Printf(
|
||||
"File collision for hypha ‘%s’, using ‘%s’ rather than ‘%s’\n",
|
||||
foundHypha.CanonicalName(),
|
||||
foundHypha.TextFilePath(),
|
||||
storedHypha.TextFilePath(),
|
||||
)
|
||||
case *MediaHypha: // no conflict
|
||||
Insert(ExtendTextualToMedia(storedHypha, foundHypha.mediaFilePath))
|
||||
@ -42,16 +43,16 @@ func Index(path string) {
|
||||
storedHypha.mycoFilePath = foundHypha.mycoFilePath
|
||||
case *MediaHypha: // conflict! overwrite
|
||||
storedHypha.mediaFilePath = foundHypha.mediaFilePath
|
||||
|
||||
slog.Info("File collision",
|
||||
"hypha", foundHypha.CanonicalName(),
|
||||
"usingFile", foundHypha.MediaFilePath(),
|
||||
"insteadOf", storedHypha.MediaFilePath(),
|
||||
log.Printf(
|
||||
"File collision for hypha ‘%s’, using ‘%s’ rather than ‘%s’\n",
|
||||
foundHypha.CanonicalName(),
|
||||
foundHypha.MediaFilePath(),
|
||||
storedHypha.MediaFilePath(),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
slog.Info("Indexed hyphae", "n", Count())
|
||||
log.Println("Indexed", Count(), "hyphae")
|
||||
}
|
||||
|
||||
// indexHelper finds all hypha files in the full `path` and sends them to the
|
||||
@ -60,8 +61,7 @@ func Index(path string) {
|
||||
func indexHelper(path string, nestLevel uint, ch chan ExistingHypha) {
|
||||
nodes, err := os.ReadDir(path)
|
||||
if err != nil {
|
||||
slog.Error("Failed to read directory", "path", path, "err", err)
|
||||
os.Exit(1)
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
for _, node := range nodes {
|
||||
@ -73,7 +73,7 @@ func indexHelper(path string, nestLevel uint, ch chan ExistingHypha) {
|
||||
}
|
||||
|
||||
var (
|
||||
hyphaPartPath = filepath.ToSlash(filepath.Join(path, node.Name()))
|
||||
hyphaPartPath = filepath.Join(path, node.Name())
|
||||
hyphaName, isText, skip = mimetype.DataFromFilename(hyphaPartPath)
|
||||
)
|
||||
if !skip {
|
||||
@ -1,4 +1,3 @@
|
||||
// Package hyphae manages hypha storage and hypha types.
|
||||
package hyphae
|
||||
|
||||
import (
|
||||
@ -8,7 +7,7 @@ import (
|
||||
)
|
||||
|
||||
// hyphaNamePattern is a pattern which all hyphae names must match.
|
||||
var hyphaNamePattern = regexp.MustCompile(`^[^?!:#@><*|"'&%{}]+$`)
|
||||
var hyphaNamePattern = regexp.MustCompile(`[^?!:#@><*|"'&%{}]+`)
|
||||
|
||||
// IsValidName checks for invalid characters and path traversals.
|
||||
func IsValidName(hyphaName string) bool {
|
||||
55
hyphae/iteration/iteration.go
Normal file
55
hyphae/iteration/iteration.go
Normal file
@ -0,0 +1,55 @@
|
||||
// Package iteration provides a handy API for making multiple checks on all hyphae in one go.
|
||||
package iteration
|
||||
|
||||
import (
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// Iteration represents an iteration over all existing hyphae in the storage. Iteration is done on all existing hyphae. The order of hyphae is not specified. For all hyphae, checks are made.
|
||||
type Iteration struct {
|
||||
sync.Mutex
|
||||
checks []func(h hyphae.Hypha) CheckResult
|
||||
}
|
||||
|
||||
// NewIteration constructs an iteration without checks.
|
||||
func NewIteration() *Iteration {
|
||||
return &Iteration{
|
||||
checks: make([]func(h hyphae.Hypha) CheckResult, 0),
|
||||
}
|
||||
}
|
||||
|
||||
// AddCheck adds the check to the iteration. It is concurrent-safe. Checks are meant to have side-effects.
|
||||
func (i7n *Iteration) AddCheck(check func(h hyphae.Hypha) CheckResult) {
|
||||
i7n.Lock()
|
||||
i7n.checks = append(i7n.checks, check)
|
||||
i7n.Unlock()
|
||||
}
|
||||
|
||||
func (i7n *Iteration) removeCheck(i int) {
|
||||
i7n.checks[i] = i7n.checks[len(i7n.checks)-1]
|
||||
i7n.checks = i7n.checks[:len(i7n.checks)-1]
|
||||
}
|
||||
|
||||
// Ignite does the iteration by walking over all hyphae yielded by the iterator used and calling all checks on the hypha. Ignited iterations are not concurrent-safe.
|
||||
//
|
||||
// After ignition, you should not use the same Iteration again.
|
||||
func (i7n *Iteration) Ignite() {
|
||||
for h := range hyphae.YieldExistingHyphae() {
|
||||
for i, check := range i7n.checks {
|
||||
if res := check(h); res == CheckForgetMe {
|
||||
i7n.removeCheck(i)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// CheckResult is a result of an iteration check.
|
||||
type CheckResult int
|
||||
|
||||
const (
|
||||
// CheckContinue is returned when the check wants to be used next time too.
|
||||
CheckContinue CheckResult = iota
|
||||
// CheckForgetMe is returned when the check wants to be forgotten and not used anymore.
|
||||
CheckForgetMe
|
||||
)
|
||||
@ -1,10 +1,9 @@
|
||||
package hyphae
|
||||
|
||||
import (
|
||||
"github.com/bouncepaw/mycorrhiza/files"
|
||||
"path/filepath"
|
||||
"sync"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
)
|
||||
|
||||
type MediaHypha struct {
|
||||
@ -1,87 +0,0 @@
|
||||
package hypview
|
||||
|
||||
import (
|
||||
"embed"
|
||||
"html/template"
|
||||
"log/slog"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/backlinks"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/web/viewutil"
|
||||
)
|
||||
|
||||
var (
|
||||
//go:embed *.html
|
||||
fs embed.FS
|
||||
ruTranslation = `
|
||||
{{define "rename hypha?"}}Переименовать {{beautifulName .}}?{{end}}
|
||||
{{define "rename [[hypha]]?"}}Переименовать <a href="/hypha/{{.}}">{{beautifulName .}}</a>?{{end}}
|
||||
{{define "new name"}}Новое название:{{end}}
|
||||
{{define "rename recursively"}}Также переименовать подгифы{{end}}
|
||||
{{define "rename tip"}}Переименовывайте аккуратно. <a href="/help/en/rename">Документация на английском.</a>{{end}}
|
||||
{{define "leave redirection"}}Оставить перенаправление{{end}}
|
||||
|
||||
|
||||
`
|
||||
chainNaviTitle viewutil.Chain
|
||||
chainRenameHypha viewutil.Chain
|
||||
)
|
||||
|
||||
func Init() {
|
||||
chainNaviTitle = viewutil.CopyEnRuWith(fs, "view_navititle.html", "")
|
||||
chainRenameHypha = viewutil.CopyEnRuWith(fs, "view_rename.html", ruTranslation)
|
||||
}
|
||||
|
||||
type renameData struct {
|
||||
*viewutil.BaseData
|
||||
HyphaName string
|
||||
LeaveRedirectionDefault bool
|
||||
}
|
||||
|
||||
func RenameHypha(meta viewutil.Meta, hyphaName string) {
|
||||
viewutil.ExecutePage(meta, chainRenameHypha, renameData{
|
||||
BaseData: &viewutil.BaseData{
|
||||
Addr: "/rename/" + hyphaName,
|
||||
},
|
||||
HyphaName: hyphaName,
|
||||
LeaveRedirectionDefault: backlinks.BacklinksCount(hyphaName) != 0,
|
||||
})
|
||||
}
|
||||
|
||||
type naviTitleData struct {
|
||||
HyphaNameParts []string
|
||||
HyphaNamePartsWithParents []string
|
||||
Icon string
|
||||
HomeHypha string
|
||||
}
|
||||
|
||||
func NaviTitle(meta viewutil.Meta, hyphaName string) template.HTML {
|
||||
parts, partsWithParents := naviTitleify(hyphaName)
|
||||
var buf strings.Builder
|
||||
err := chainNaviTitle.Get(meta).ExecuteTemplate(&buf, "navititle", naviTitleData{
|
||||
HyphaNameParts: parts,
|
||||
HyphaNamePartsWithParents: partsWithParents,
|
||||
Icon: cfg.NaviTitleIcon,
|
||||
HomeHypha: cfg.HomeHypha,
|
||||
})
|
||||
if err != nil {
|
||||
slog.Error("Failed to render NaviTitle properly; using nevertheless", "err", err)
|
||||
}
|
||||
return template.HTML(buf.String())
|
||||
}
|
||||
|
||||
func naviTitleify(hyphaName string) ([]string, []string) {
|
||||
var (
|
||||
prevAcc = "/hypha"
|
||||
parts = strings.Split(hyphaName, "/")
|
||||
partsWithParents []string
|
||||
)
|
||||
|
||||
for _, part := range parts {
|
||||
prevAcc += "/" + part
|
||||
partsWithParents = append(partsWithParents, prevAcc)
|
||||
}
|
||||
|
||||
return parts, partsWithParents
|
||||
}
|
||||
@ -1,17 +0,0 @@
|
||||
{{define "navititle"}}
|
||||
<h1 class="navi-title">
|
||||
{{- $withParents := .HyphaNamePartsWithParents -}}
|
||||
{{- $parts := .HyphaNameParts -}}
|
||||
<a href="/hypha/{{.HomeHypha}}">
|
||||
{{- .Icon -}}
|
||||
<span aria-hidden="true" class="navi-title__colon">:</span></a>
|
||||
{{- range $i, $part := .HyphaNameParts -}}
|
||||
{{- if gt $i 0 -}}
|
||||
<span aria-hidden="true" class="navi-title__separator">/</span>
|
||||
{{- end -}}
|
||||
<a href="{{index $withParents $i}}" rel="{{if len $parts | eq (inc $i)}}bookmark{{else}}up{{end}}">
|
||||
{{- beautifulName $part -}}
|
||||
</a>
|
||||
{{- end}}
|
||||
</h1>
|
||||
{{end}}
|
||||
@ -1,29 +0,0 @@
|
||||
{{define "rename hypha?"}}Rename {{beautifulName .}}?{{end}}
|
||||
{{define "title"}}{{template "rename hypha?" .HyphaName}}{{end}}
|
||||
{{define "body"}}
|
||||
<main class="main-width">
|
||||
<form class="modal" action="/rename/{{.HyphaName}}" method="post" enctype="multipart/form-data">
|
||||
<fieldset class="modal__fieldset">
|
||||
<legend class="modal__title">
|
||||
{{block "rename [[hypha]]?" .HyphaName}}Rename <a href="/hypha/{{.}}">{{beautifulName .}}</a>?{{end}}
|
||||
</legend>
|
||||
<label for="new-name">{{block "new name" .}}New name:{{end}}</label>
|
||||
<input type="text" value="{{.HyphaName}}" required autofocus id="new-name" name="new-name"/>
|
||||
|
||||
<input type="checkbox" id="recursive" name="recursive" value="true" checked/>
|
||||
<label for="recursive">{{block "rename recursively" .}}Rename subhyphae too{{end}}</label>
|
||||
<br>
|
||||
<input type="checkbox" id="redirection" name="redirection" value="true" {{if .LeaveRedirectionDefault}}checked{{end}}/>
|
||||
<label for="redirection">{{block "leave redirection" .}}Leave redirection{{end}}</label>
|
||||
|
||||
<p>{{block "rename tip" .}}Rename carefully. <a href="/help/en/rename">Documentation.</a>{{end}}</p>
|
||||
<button type="submit" value="Confirm" class="btn">
|
||||
{{template "confirm"}}
|
||||
</button>
|
||||
<a href="/hypha/{{.HyphaName}}" class="btn btn_weak">
|
||||
{{template "cancel"}}
|
||||
</a>
|
||||
</fieldset>
|
||||
</form>
|
||||
</main>
|
||||
{{end}}
|
||||
@ -1,136 +0,0 @@
|
||||
// Package categories provides category management.
|
||||
//
|
||||
// As per the long pondering, this is how categories (cats for short)
|
||||
// work in Mycorrhiza:
|
||||
//
|
||||
// - Cats are not hyphae. Cats are separate entities. This is not as
|
||||
// vibeful as I would have wanted, but seems to be more practical
|
||||
// due to //the reasons//.
|
||||
// - Cats are stored outside of git. Instead, they are stored in a
|
||||
// JSON file, path to which is determined by files.CategoriesJSON.
|
||||
// - Due to not being stored in git, no cat history is tracked, and
|
||||
// cat operations are not mentioned on the recent changes page.
|
||||
// - For cat A, if there are 0 hyphae in the cat, cat A does not
|
||||
// exist. If there are 1 or more hyphae in the cat, cat A exists.
|
||||
//
|
||||
// List of things to do with categories later:
|
||||
//
|
||||
// - Forbid / in cat names.
|
||||
// - Rename categories.
|
||||
// - Delete categories.
|
||||
// - Bind hyphae.
|
||||
package categories
|
||||
|
||||
import "sync"
|
||||
|
||||
// ListOfCategories returns unsorted names of all categories.
|
||||
func ListOfCategories() (categoryList []string) {
|
||||
mutex.RLock()
|
||||
for cat, _ := range categoryToHyphae {
|
||||
categoryList = append(categoryList, cat)
|
||||
}
|
||||
mutex.RUnlock()
|
||||
return categoryList
|
||||
}
|
||||
|
||||
// CategoriesWithHypha returns what categories have the given hypha. The hypha name must be canonical.
|
||||
func CategoriesWithHypha(hyphaName string) (categoryList []string) {
|
||||
mutex.RLock()
|
||||
defer mutex.RUnlock()
|
||||
if node, ok := hyphaToCategories[hyphaName]; ok {
|
||||
return node.categoryList
|
||||
} else {
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
// HyphaeInCategory returns what hyphae are in the category. If the returned slice is empty, the category does not exist, and vice versa. The category name must be canonical.
|
||||
func HyphaeInCategory(catName string) (hyphaList []string) {
|
||||
mutex.RLock()
|
||||
defer mutex.RUnlock()
|
||||
if node, ok := categoryToHyphae[catName]; ok {
|
||||
return node.hyphaList
|
||||
} else {
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
var mutex sync.RWMutex
|
||||
|
||||
// AddHyphaToCategory adds the hypha to the category and updates the records on the disk. If the hypha is already in the category, nothing happens. Pass canonical names.
|
||||
func AddHyphaToCategory(hyphaName, catName string) {
|
||||
mutex.Lock()
|
||||
if node, ok := hyphaToCategories[hyphaName]; ok {
|
||||
node.storeCategory(catName)
|
||||
} else {
|
||||
hyphaToCategories[hyphaName] = &hyphaNode{categoryList: []string{catName}}
|
||||
}
|
||||
|
||||
if node, ok := categoryToHyphae[catName]; ok {
|
||||
node.storeHypha(hyphaName)
|
||||
} else {
|
||||
categoryToHyphae[catName] = &categoryNode{hyphaList: []string{hyphaName}}
|
||||
}
|
||||
mutex.Unlock()
|
||||
go saveToDisk()
|
||||
}
|
||||
|
||||
// RemoveHyphaFromCategory removes the hypha from the category and updates the records on the disk. If the hypha is not in the category, nothing happens. Pass canonical names.
|
||||
func RemoveHyphaFromCategory(hyphaName, catName string) {
|
||||
mutex.Lock()
|
||||
if node, ok := hyphaToCategories[hyphaName]; ok {
|
||||
node.removeCategory(catName)
|
||||
if len(node.categoryList) == 0 {
|
||||
delete(hyphaToCategories, hyphaName)
|
||||
}
|
||||
}
|
||||
|
||||
if node, ok := categoryToHyphae[catName]; ok {
|
||||
node.removeHypha(hyphaName)
|
||||
if len(node.hyphaList) == 0 {
|
||||
delete(categoryToHyphae, catName)
|
||||
}
|
||||
}
|
||||
mutex.Unlock()
|
||||
go saveToDisk()
|
||||
}
|
||||
|
||||
// RemoveHyphaFromAllCategories removes the given hypha from all the categories.
|
||||
func RemoveHyphaFromAllCategories(hyphaName string) {
|
||||
cats := CategoriesWithHypha(hyphaName)
|
||||
mutex.Lock()
|
||||
defer mutex.Unlock()
|
||||
for _, cat := range cats {
|
||||
if node, ok := hyphaToCategories[hyphaName]; ok {
|
||||
node.removeCategory(cat)
|
||||
if len(node.categoryList) == 0 {
|
||||
delete(hyphaToCategories, hyphaName)
|
||||
}
|
||||
}
|
||||
|
||||
if node, ok := categoryToHyphae[cat]; ok {
|
||||
node.removeHypha(hyphaName)
|
||||
if len(node.hyphaList) == 0 {
|
||||
delete(categoryToHyphae, cat)
|
||||
}
|
||||
}
|
||||
}
|
||||
go saveToDisk()
|
||||
}
|
||||
|
||||
// RenameHyphaInAllCategories finds all mentions of oldName and replaces them with newName. Pass canonical names. Make sure newName is not taken. If oldName is not in any category, RenameHyphaInAllCategories is a no-op.
|
||||
func RenameHyphaInAllCategories(oldName, newName string) {
|
||||
mutex.Lock()
|
||||
defer mutex.Unlock()
|
||||
if node, ok := hyphaToCategories[oldName]; ok {
|
||||
hyphaToCategories[newName] = node
|
||||
delete(hyphaToCategories, oldName) // node should still be in memory 🙏
|
||||
for _, catName := range node.categoryList {
|
||||
if catNode, ok := categoryToHyphae[catName]; ok {
|
||||
catNode.removeHypha(oldName)
|
||||
catNode.storeHypha(newName)
|
||||
}
|
||||
}
|
||||
}
|
||||
go saveToDisk()
|
||||
}
|
||||
@ -1,35 +0,0 @@
|
||||
package hyphae
|
||||
|
||||
import (
|
||||
"os"
|
||||
)
|
||||
|
||||
// FetchMycomarkupFile tries to read text file of the given hypha. If there is no file, empty string is returned.
|
||||
//
|
||||
// TODO: Get rid of this function.
|
||||
func FetchMycomarkupFile(h Hypha) (string, error) {
|
||||
switch h := h.(type) {
|
||||
case *EmptyHypha:
|
||||
return "", nil
|
||||
case *MediaHypha:
|
||||
if !h.HasTextFile() {
|
||||
return "", nil
|
||||
}
|
||||
text, err := os.ReadFile(h.TextFilePath())
|
||||
if os.IsNotExist(err) {
|
||||
return "", nil
|
||||
} else if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return string(text), nil
|
||||
case *TextualHypha:
|
||||
text, err := os.ReadFile(h.TextFilePath())
|
||||
if os.IsNotExist(err) {
|
||||
return "", nil
|
||||
} else if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return string(text), nil
|
||||
}
|
||||
panic("unreachable")
|
||||
}
|
||||
@ -1,51 +0,0 @@
|
||||
package migration
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"log/slog"
|
||||
"os"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/tools"
|
||||
)
|
||||
|
||||
var headingMarkerPath string
|
||||
|
||||
func MigrateHeadingsMaybe() {
|
||||
headingMarkerPath = files.FileInRoot(".mycomarkup-heading-migration-marker.txt")
|
||||
if !shouldMigrateHeadings() {
|
||||
return
|
||||
}
|
||||
|
||||
genericLineMigrator(
|
||||
"Migrate headings to the new syntax",
|
||||
tools.MigrateHeadings,
|
||||
"Something went wrong when commiting heading migration: ")
|
||||
createHeadingMarker()
|
||||
}
|
||||
|
||||
func shouldMigrateHeadings() bool {
|
||||
file, err := os.Open(headingMarkerPath)
|
||||
if os.IsNotExist(err) {
|
||||
return true
|
||||
}
|
||||
if err != nil {
|
||||
slog.Error("Failed to check if heading migration is needed", "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
_ = file.Close()
|
||||
return false
|
||||
}
|
||||
|
||||
func createHeadingMarker() {
|
||||
err := ioutil.WriteFile(
|
||||
headingMarkerPath,
|
||||
[]byte(`This file is used to mark that the heading migration was successful. If this file is deleted, the migration might happen again depending on the version. You should probably not touch this file at all and let it be.`),
|
||||
0766,
|
||||
)
|
||||
if err != nil {
|
||||
slog.Error("Failed to create heading migration marker", "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
@ -1,96 +0,0 @@
|
||||
// Package migration holds the utilities for migrating from older incompatible Mycomarkup versions.
|
||||
//
|
||||
// Migrations are meant to be removed couple of versions after being introduced.
|
||||
//
|
||||
// Available migrations:
|
||||
// - Rocket links
|
||||
// - Headings
|
||||
package migration
|
||||
|
||||
import (
|
||||
"io"
|
||||
"log/slog"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
)
|
||||
|
||||
func genericLineMigrator(
|
||||
commitMessage string,
|
||||
migrator func(string) string,
|
||||
commitErrorMessage string,
|
||||
) {
|
||||
var (
|
||||
hop = history.
|
||||
Operation(history.TypeMarkupMigration).
|
||||
WithMsg(commitMessage).
|
||||
WithUser(user.WikimindUser())
|
||||
mycoFiles = []string{}
|
||||
)
|
||||
|
||||
for hypha := range hyphae.FilterHyphaeWithText(hyphae.YieldExistingHyphae()) {
|
||||
/// Open file, read from file, modify file. If anything goes wrong, scream and shout.
|
||||
|
||||
file, err := os.OpenFile(hypha.TextFilePath(), os.O_RDWR, 0766)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
slog.Error("Failed to open text part file", "path", hypha.TextFilePath(), "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
var buf strings.Builder
|
||||
_, err = io.Copy(&buf, file)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
_ = file.Close()
|
||||
slog.Error("Failed to read text part file", "path", hypha.TextFilePath(), "err", err)
|
||||
}
|
||||
|
||||
var (
|
||||
oldText = buf.String()
|
||||
newText = migrator(oldText)
|
||||
)
|
||||
if oldText != newText { // This file right here is being migrated for real.
|
||||
mycoFiles = append(mycoFiles, hypha.TextFilePath())
|
||||
|
||||
err = file.Truncate(0)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
_ = file.Close()
|
||||
slog.Error("Failed to truncate text part file", "path", hypha.TextFilePath(), "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
_, err = file.Seek(0, 0)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
_ = file.Close()
|
||||
slog.Error("Failed to seek in text part file", "path", hypha.TextFilePath(), "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
_, err = file.WriteString(newText)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
_ = file.Close()
|
||||
slog.Error("Failed to write to text part file", "path", hypha.TextFilePath(), "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
_ = file.Close()
|
||||
}
|
||||
|
||||
if len(mycoFiles) == 0 {
|
||||
hop.Abort()
|
||||
return
|
||||
}
|
||||
|
||||
if hop.WithFiles(mycoFiles...).Apply().HasErrors() {
|
||||
slog.Error(commitErrorMessage + hop.FirstErrorText())
|
||||
}
|
||||
|
||||
slog.Info("Migrated Mycomarkup documents", "n", len(mycoFiles))
|
||||
}
|
||||
@ -1,55 +0,0 @@
|
||||
package migration
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"log/slog"
|
||||
"os"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/tools"
|
||||
)
|
||||
|
||||
var rocketMarkerPath string
|
||||
|
||||
// MigrateRocketsMaybe checks if the rocket link migration marker exists. If it exists, nothing is done. If it does not, the migration takes place.
|
||||
//
|
||||
// This function writes logs and might terminate the program. Tons of side-effects, stay safe.
|
||||
func MigrateRocketsMaybe() {
|
||||
rocketMarkerPath = files.FileInRoot(".mycomarkup-rocket-link-migration-marker.txt")
|
||||
if !shouldMigrateRockets() {
|
||||
return
|
||||
}
|
||||
|
||||
genericLineMigrator(
|
||||
"Migrate rocket links to the new syntax",
|
||||
tools.MigrateRocketLinks,
|
||||
"Something went wrong when commiting rocket link migration: ",
|
||||
)
|
||||
createRocketLinkMarker()
|
||||
}
|
||||
|
||||
func shouldMigrateRockets() bool {
|
||||
file, err := os.Open(rocketMarkerPath)
|
||||
if os.IsNotExist(err) {
|
||||
return true
|
||||
}
|
||||
if err != nil {
|
||||
slog.Error("Failed to check if rocket migration is needed", "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
_ = file.Close()
|
||||
return false
|
||||
}
|
||||
|
||||
func createRocketLinkMarker() {
|
||||
err := ioutil.WriteFile(
|
||||
rocketMarkerPath,
|
||||
[]byte(`This file is used to mark that the rocket link migration was made successfully. If this file is deleted, the migration might happen again depending on the version. You should probably not touch this file at all and let it be.`),
|
||||
0766,
|
||||
)
|
||||
if err != nil {
|
||||
slog.Error("Failed to create rocket link migration marker")
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
@ -1,59 +0,0 @@
|
||||
package shroom
|
||||
|
||||
import (
|
||||
"os"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/mycoopts"
|
||||
"github.com/bouncepaw/mycorrhiza/web/viewutil"
|
||||
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5"
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/blocks"
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/mycocontext"
|
||||
)
|
||||
|
||||
// SetHeaderLinks initializes header links by reading the configured hypha, if there is any, or resorting to default values.
|
||||
func SetHeaderLinks() {
|
||||
switch userLinksHypha := hyphae.ByName(cfg.HeaderLinksHypha).(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
setDefaultHeaderLinks()
|
||||
case hyphae.ExistingHypha:
|
||||
contents, err := os.ReadFile(userLinksHypha.TextFilePath())
|
||||
if err != nil || len(contents) == 0 {
|
||||
setDefaultHeaderLinks()
|
||||
} else {
|
||||
text := string(contents)
|
||||
parseHeaderLinks(text)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// setDefaultHeaderLinks sets the header links to the default list of: home hypha, recent changes, hyphae list, random hypha.
|
||||
func setDefaultHeaderLinks() {
|
||||
viewutil.HeaderLinks = []viewutil.HeaderLink{
|
||||
{"/recent-changes", "Recent changes"},
|
||||
{"/list", "All hyphae"},
|
||||
{"/random", "Random"},
|
||||
{"/help", "Help"},
|
||||
{"/category", "Categories"},
|
||||
}
|
||||
}
|
||||
|
||||
// parseHeaderLinks extracts all rocketlinks from the given text and saves them as header links.
|
||||
func parseHeaderLinks(text string) {
|
||||
viewutil.HeaderLinks = []viewutil.HeaderLink{}
|
||||
ctx, _ := mycocontext.ContextFromStringInput(text, mycoopts.MarkupOptions(""))
|
||||
// We call for side-effects
|
||||
_ = mycomarkup.BlockTree(ctx, func(block blocks.Block) {
|
||||
switch launchpad := block.(type) {
|
||||
case blocks.LaunchPad:
|
||||
for _, rocket := range launchpad.Rockets {
|
||||
viewutil.HeaderLinks = append(viewutil.HeaderLinks, viewutil.HeaderLink{
|
||||
Href: rocket.LinkHref(ctx),
|
||||
Display: rocket.DisplayedText(),
|
||||
})
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
@ -1,36 +0,0 @@
|
||||
package shroom
|
||||
|
||||
import (
|
||||
"log/slog"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
)
|
||||
|
||||
func rejectRenameLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
slog.Info("Reject rename",
|
||||
"hyphaName", h.CanonicalName(),
|
||||
"username", u.Name,
|
||||
"errmsg", errmsg)
|
||||
}
|
||||
|
||||
func rejectRemoveMediaLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
slog.Info("Reject remove media",
|
||||
"hyphaName", h.CanonicalName(),
|
||||
"username", u.Name,
|
||||
"errmsg", errmsg)
|
||||
}
|
||||
|
||||
func rejectEditLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
slog.Info("Reject edit",
|
||||
"hyphaName", h.CanonicalName(),
|
||||
"username", u.Name,
|
||||
"errmsg", errmsg)
|
||||
}
|
||||
|
||||
func rejectUploadMediaLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
slog.Info("Reject upload media",
|
||||
"hyphaName", h.CanonicalName(),
|
||||
"username", u.Name,
|
||||
"errmsg", errmsg)
|
||||
}
|
||||
@ -1,4 +0,0 @@
|
||||
// Package shroom provides utilities for hypha manipulation.
|
||||
//
|
||||
// Some of them are wrappers around functions provided by package hyphae. They manage history for you.
|
||||
package shroom
|
||||
@ -1,130 +0,0 @@
|
||||
package tree
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"html/template"
|
||||
"io"
|
||||
"path"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
)
|
||||
|
||||
// Tree returns the subhypha matrix as HTML and names of the next and previous hyphae (or empty strings).
|
||||
func Tree(hyphaName string) (childrenHTML template.HTML, prev, next string) {
|
||||
var (
|
||||
root = child{hyphaName, true, make([]child, 0)}
|
||||
descendantPrefix = hyphaName + "/"
|
||||
parent = path.Dir(hyphaName) // Beware, it might be . and whatnot.
|
||||
slashCount = strings.Count(hyphaName, "/")
|
||||
)
|
||||
for h := range hyphae.YieldExistingHyphae() {
|
||||
name := h.CanonicalName()
|
||||
if strings.HasPrefix(name, descendantPrefix) {
|
||||
var subPath = strings.TrimPrefix(name, descendantPrefix)
|
||||
addHyphaToChild(name, subPath, &root)
|
||||
// A child is not a sibling, so we skip the rest.
|
||||
continue
|
||||
}
|
||||
|
||||
// Skipping non-siblings.
|
||||
if !(path.Dir(name) == parent && slashCount == strings.Count(name, "/")) {
|
||||
continue
|
||||
}
|
||||
|
||||
if (name < hyphaName) && (name > prev) {
|
||||
prev = name
|
||||
} else if (name > hyphaName) && (name < next || next == "") {
|
||||
next = name
|
||||
}
|
||||
}
|
||||
return subhyphaeMatrix(root.children), prev, next
|
||||
}
|
||||
|
||||
type child struct {
|
||||
name string
|
||||
exists bool
|
||||
children []child
|
||||
}
|
||||
|
||||
/*
|
||||
Subhyphae links are recursive. It may end up looking like that if drawn with
|
||||
pseudographics:
|
||||
╔══════════════╗
|
||||
║Foo ║ The presented hyphae are ./foo and ./foo/bar
|
||||
║╔════════════╗║
|
||||
║║Bar ║║
|
||||
║╚════════════╝║
|
||||
╚══════════════╝
|
||||
*/
|
||||
func childHTML(c *child, w io.Writer) {
|
||||
sort.Slice(c.children, func(i, j int) bool {
|
||||
return c.children[i].name < c.children[j].name
|
||||
})
|
||||
|
||||
_, _ = io.WriteString(w, "<li class=\"subhyphae__entry\">\n<a class=\"subhyphae__link")
|
||||
if !c.exists {
|
||||
_, _ = io.WriteString(w, " wikilink_new")
|
||||
}
|
||||
_, _ = io.WriteString(w, fmt.Sprintf(
|
||||
"\" href=\"/hypha/%s\">%s</a>\n",
|
||||
c.name,
|
||||
util.BeautifulName(path.Base(c.name)),
|
||||
))
|
||||
|
||||
if len(c.children) > 0 {
|
||||
_, _ = io.WriteString(w, "<ul>\n")
|
||||
for _, child := range c.children {
|
||||
childHTML(&child, w)
|
||||
}
|
||||
_, _ = io.WriteString(w, "</ul>\n")
|
||||
}
|
||||
_, _ = io.WriteString(w, "</li>\n")
|
||||
}
|
||||
|
||||
func addHyphaToChild(hyphaName, subPath string, child *child) {
|
||||
// when hyphaName = "root/a/b", subPath = "a/b", and child.name = "root"
|
||||
// addHyphaToChild("root/a/b", "b", child{"root/a"})
|
||||
// when hyphaName = "root/a/b", subPath = "b", and child.name = "root/a"
|
||||
// set .exists=true for "root/a/b", and create it if it isn't there already
|
||||
var exists = !strings.Contains(subPath, "/")
|
||||
if exists {
|
||||
var subchild = findOrCreateSubchild(subPath, child)
|
||||
subchild.exists = true
|
||||
} else {
|
||||
var (
|
||||
firstSlash = strings.IndexRune(subPath, '/')
|
||||
firstDir = subPath[:firstSlash]
|
||||
restOfPath = subPath[firstSlash+1:]
|
||||
subchild = findOrCreateSubchild(firstDir, child)
|
||||
)
|
||||
addHyphaToChild(hyphaName, restOfPath, subchild)
|
||||
}
|
||||
}
|
||||
|
||||
func findOrCreateSubchild(name string, baseChild *child) *child {
|
||||
// when name = "a", and baseChild.name = "root"
|
||||
// if baseChild.children contains "root/a", return it
|
||||
// else create it and return that
|
||||
var fullName = baseChild.name + "/" + name
|
||||
for i := range baseChild.children {
|
||||
if baseChild.children[i].name == fullName {
|
||||
return &baseChild.children[i]
|
||||
}
|
||||
}
|
||||
baseChild.children = append(baseChild.children, child{fullName, false, make([]child, 0)})
|
||||
return &baseChild.children[len(baseChild.children)-1]
|
||||
}
|
||||
|
||||
func subhyphaeMatrix(children []child) template.HTML {
|
||||
sort.Slice(children, func(i, j int) bool {
|
||||
return children[i].name < children[j].name
|
||||
})
|
||||
var buf strings.Builder
|
||||
for _, child := range children {
|
||||
childHTML(&child, &buf)
|
||||
}
|
||||
return template.HTML(buf.String())
|
||||
}
|
||||
@ -1,46 +0,0 @@
|
||||
package version
|
||||
|
||||
import (
|
||||
"regexp"
|
||||
"runtime/debug"
|
||||
"strconv"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/help"
|
||||
)
|
||||
|
||||
// Long is the full version string, including VCS information, that looks like
|
||||
// x.y.z+hash-dirty.
|
||||
var Long string
|
||||
|
||||
// Short is the human-friendly x.y.z part of the long version string.
|
||||
var Short string
|
||||
|
||||
var versionRegexp = regexp.MustCompile(`This is documentation for Mycorrhiza Wiki (.*)\. `)
|
||||
|
||||
func init() {
|
||||
if b, err := help.Get("en"); err == nil {
|
||||
matches := versionRegexp.FindSubmatch(b)
|
||||
if matches != nil {
|
||||
Short = string(matches[1])
|
||||
}
|
||||
}
|
||||
|
||||
Long = Short
|
||||
info, ok := debug.ReadBuildInfo()
|
||||
if ok {
|
||||
for _, setting := range info.Settings {
|
||||
if setting.Key == "vcs.revision" {
|
||||
val := setting.Value
|
||||
if len(val) > 7 {
|
||||
val = val[:7]
|
||||
}
|
||||
Long += "+" + val
|
||||
} else if setting.Key == "vcs.modified" {
|
||||
modified, err := strconv.ParseBool(setting.Value)
|
||||
if err == nil && modified {
|
||||
Long += "-dirty"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,195 +0,0 @@
|
||||
// Package interwiki provides interwiki capabilities. Most of them, at least.
|
||||
package interwiki
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"log/slog"
|
||||
"os"
|
||||
"sync"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/options"
|
||||
)
|
||||
|
||||
func Init() error {
|
||||
record, err := readInterwiki()
|
||||
if err != nil {
|
||||
slog.Error("Failed to read interwiki", "err", err)
|
||||
return err
|
||||
}
|
||||
|
||||
for _, wiki := range record {
|
||||
wiki := wiki // This line is required
|
||||
if err := wiki.canonize(); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := addEntry(&wiki); err != nil {
|
||||
slog.Error("Failed to add interwiki entry", "err", err)
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
slog.Info("Indexed interwiki map", "n", len(listOfEntries))
|
||||
return nil
|
||||
}
|
||||
|
||||
func dropEmptyStrings(ss []string) (clean []string) {
|
||||
for _, s := range ss {
|
||||
if s != "" {
|
||||
clean = append(clean, s)
|
||||
}
|
||||
}
|
||||
return clean
|
||||
}
|
||||
|
||||
// difference returns the elements in `a` that aren't in `b`.
|
||||
// Taken from https://stackoverflow.com/a/45428032
|
||||
// CC BY-SA 4.0, no changes made
|
||||
func difference(a, b []string) []string {
|
||||
mb := make(map[string]struct{}, len(b))
|
||||
for _, x := range b {
|
||||
mb[x] = struct{}{}
|
||||
}
|
||||
var diff []string
|
||||
for _, x := range a {
|
||||
if _, found := mb[x]; !found {
|
||||
diff = append(diff, x)
|
||||
}
|
||||
}
|
||||
return diff
|
||||
}
|
||||
|
||||
func areNamesFree(names []string) (bool, string) {
|
||||
for _, name := range names {
|
||||
if _, found := entriesByName[name]; found {
|
||||
return false, name
|
||||
}
|
||||
}
|
||||
return true, ""
|
||||
}
|
||||
|
||||
var mutex sync.Mutex
|
||||
|
||||
func replaceEntry(oldWiki *Wiki, newWiki *Wiki) error {
|
||||
diff := difference(
|
||||
append(newWiki.Aliases, newWiki.Name),
|
||||
append(oldWiki.Aliases, oldWiki.Name),
|
||||
)
|
||||
if ok, name := areNamesFree(diff); !ok {
|
||||
return errors.New(name)
|
||||
}
|
||||
deleteEntry(oldWiki)
|
||||
return addEntry(newWiki)
|
||||
}
|
||||
|
||||
func deleteEntry(wiki *Wiki) {
|
||||
mutex.Lock()
|
||||
defer mutex.Unlock()
|
||||
|
||||
// I'm being fancy here. Come on, the code here is already a mess.
|
||||
// Let me have some fun.
|
||||
var wg sync.WaitGroup
|
||||
|
||||
wg.Add(2)
|
||||
go func() {
|
||||
names := append(wiki.Aliases, wiki.Name)
|
||||
for _, name := range names {
|
||||
name := name // I guess we need that
|
||||
delete(entriesByName, name)
|
||||
}
|
||||
wg.Done()
|
||||
}()
|
||||
|
||||
go func() {
|
||||
for i, w := range listOfEntries {
|
||||
i, w := i, w
|
||||
if w.Name == wiki.Name {
|
||||
// Drop ith element.
|
||||
listOfEntries[i] = listOfEntries[len(listOfEntries)-1]
|
||||
listOfEntries = listOfEntries[:len(listOfEntries)-1]
|
||||
break
|
||||
}
|
||||
}
|
||||
wg.Done()
|
||||
}()
|
||||
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
// TODO: There is something clearly wrong with error-returning in this function.
|
||||
func addEntry(wiki *Wiki) error {
|
||||
mutex.Lock()
|
||||
defer mutex.Unlock()
|
||||
wiki.Aliases = dropEmptyStrings(wiki.Aliases)
|
||||
|
||||
var (
|
||||
names = append(wiki.Aliases, wiki.Name)
|
||||
ok, name = areNamesFree(names)
|
||||
)
|
||||
switch {
|
||||
case !ok:
|
||||
slog.Error("There are multiple uses of the same name", "name", name)
|
||||
return errors.New(name)
|
||||
case len(names) == 0:
|
||||
slog.Error("No names passed for a new interwiki entry")
|
||||
return errors.New("")
|
||||
}
|
||||
|
||||
listOfEntries = append(listOfEntries, wiki)
|
||||
for _, name := range names {
|
||||
entriesByName[name] = wiki
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func HrefLinkFormatFor(prefix string) (string, options.InterwikiError) {
|
||||
prefix = util.CanonicalName(prefix)
|
||||
if wiki, ok := entriesByName[prefix]; ok {
|
||||
return wiki.LinkHrefFormat, options.Ok
|
||||
}
|
||||
return "", options.UnknownPrefix
|
||||
}
|
||||
|
||||
func ImgSrcFormatFor(prefix string) (string, options.InterwikiError) {
|
||||
prefix = util.CanonicalName(prefix)
|
||||
if wiki, ok := entriesByName[prefix]; ok {
|
||||
return wiki.ImgSrcFormat, options.Ok
|
||||
}
|
||||
return "", options.UnknownPrefix
|
||||
}
|
||||
|
||||
func readInterwiki() ([]Wiki, error) {
|
||||
var (
|
||||
record []Wiki
|
||||
fileContents, err = os.ReadFile(files.InterwikiJSON())
|
||||
)
|
||||
if os.IsNotExist(err) {
|
||||
return record, nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
err = json.Unmarshal(fileContents, &record)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return record, nil
|
||||
}
|
||||
|
||||
func saveInterwikiJson() {
|
||||
// Trust me, wiki crashing when an admin takes an administrative action totally makes sense.
|
||||
if data, err := json.MarshalIndent(listOfEntries, "", "\t"); err != nil {
|
||||
slog.Error("Failed to marshal interwiki entries", "err", err)
|
||||
os.Exit(1)
|
||||
} else if err = os.WriteFile(files.InterwikiJSON(), data, 0666); err != nil {
|
||||
slog.Error("Failed to write interwiki.json", "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
slog.Info("Saved interwiki.json")
|
||||
|
||||
}
|
||||
@ -1,11 +0,0 @@
|
||||
package interwiki
|
||||
|
||||
var (
|
||||
listOfEntries []*Wiki
|
||||
entriesByName map[string]*Wiki
|
||||
)
|
||||
|
||||
func init() {
|
||||
listOfEntries = []*Wiki{}
|
||||
entriesByName = map[string]*Wiki{}
|
||||
}
|
||||
@ -1,147 +0,0 @@
|
||||
{{define "interwiki map"}}Intermap{{end}}
|
||||
{{define "title"}}{{template "interwiki map"}}{{end}}
|
||||
{{define "name"}}Name:{{end}}
|
||||
{{define "aliases"}}Aliases:{{end}}
|
||||
{{define "aliases (,)"}}Aliases (separated by commas):{{end}}
|
||||
{{define "engine"}}Engine:{{end}}
|
||||
{{define "engine/mycorrhiza"}}Mycorrhiza{{end}}
|
||||
{{define "engine/betula"}}Betula{{end}}
|
||||
{{define "engine/agora"}}Agora{{end}}
|
||||
{{define "engine/generic"}}Generic (any website){{end}}
|
||||
{{define "url"}}URL{{end}}
|
||||
{{define "link href format"}}Link href attribute format string:{{end}}
|
||||
{{define "img src format"}}Image src attribute format string:{{end}}
|
||||
{{define "unset map"}}No interwiki map set.{{end}}
|
||||
{{define "add interwiki entry"}}Add interwiki entry{{end}}
|
||||
|
||||
{{define "static map"}}
|
||||
{{if len .Entries}}
|
||||
<ul>
|
||||
{{range $i, $wiki := .Entries}}
|
||||
<li>
|
||||
<dl>
|
||||
<dt>{{template "name"}}</dt>
|
||||
<dd>{{.Name}}</dd>
|
||||
|
||||
<dt>{{template "aliases"}}</dt>
|
||||
{{range .Aliases}}<dd>{{.}}</dd>{{end}}
|
||||
|
||||
<dt>{{template "engine"}}</dt>
|
||||
<dd>{{.Engine}}</dd>
|
||||
|
||||
<dt>{{template "url"}}</dt>
|
||||
<dd><a href="{{.URL}}">{{.URL}}</a></dd>
|
||||
|
||||
<dt>{{template "link href format"}}</dt>
|
||||
<dd>{{.LinkHrefFormat}}</dd>
|
||||
|
||||
<dt>{{template "img src format"}}</dt>
|
||||
<dd>{{.ImgSrcFormat}}</dd>
|
||||
</dl>
|
||||
</li>
|
||||
{{end}}
|
||||
</ul>
|
||||
{{else}}
|
||||
<p>{{template "unset map"}}</p>
|
||||
{{end}}
|
||||
{{end}}
|
||||
|
||||
{{define "authorized map"}}
|
||||
{{if .Error}}
|
||||
<p class="error">{{.Error}}</p>
|
||||
{{end}}
|
||||
{{if len .Entries}}
|
||||
{{range $i, $wiki := .Entries}}
|
||||
<form method="post" action="/interwiki/modify-entry/{{.Name}}">
|
||||
<p>
|
||||
<label for="name{{$i}}" class="required-field">{{template "name"}}</label>
|
||||
<input type="text" id="name{{$i}}" name="name" required
|
||||
value="{{.Name}}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="aliases{{$i}}">{{template "aliases (,)"}}</label>
|
||||
<input type="text" id="aliases{{$i}}" name="aliases"
|
||||
value="{{range $j, $alias := .Aliases}}{{if gt $j 0}}, {{end}}{{.}}{{end}}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="url{{$i}}" class="required-field">{{template "url"}}</label>
|
||||
<input type="url" id="url{{$i}}" name="url" required
|
||||
value="{{.URL}}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="engine{{$i}}" class="required-field">{{template "engine"}}</label>
|
||||
<select name="engine" id="engine{{$i}}" required>
|
||||
<option value="mycorrhiza" {{if eq .Engine "mycorrhiza"}}selected{{end}}>{{template "engine/mycorrhiza"}} 🍄</option>
|
||||
<option value="betula" {{if eq .Engine "betula"}}selected{{end}}>{{template "engine/betula"}} 🌳</option>
|
||||
<option value="agora" {{if eq .Engine "agora"}}selected{{end}}>{{template "engine/agora"}} ἀ</option>
|
||||
<option value="generic" {{if eq .Engine "generic"}}selected{{end}}>{{template "engine/generic"}}</option>
|
||||
</select>
|
||||
</p>
|
||||
<p>
|
||||
<label for="link-href-format{{$i}}">{{template "link href format"}}</label>
|
||||
<input type="url" id="link-href-format{{$i}}" name="link-href-format"
|
||||
value="{{.LinkHrefFormat}}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="img-src-format{{$i}}">{{template "img src format"}}</label>
|
||||
<input type="url" id="img-src-format{{$i}}" name="img-src-format"
|
||||
value="{{.ImgSrcFormat}}">
|
||||
</p>
|
||||
<input type="submit" class="btn" value="{{template `save`}}">
|
||||
</form>
|
||||
{{end}}
|
||||
{{end}}
|
||||
<form method="post" action="/interwiki/add-entry">
|
||||
<h2>{{template "add interwiki entry"}}</h2>
|
||||
<p>
|
||||
<label for="name" class="required-field">{{template "name"}}</label>
|
||||
<input type="text" id="name" name="name" required
|
||||
placeholder="home_wiki">
|
||||
</p>
|
||||
<p>
|
||||
<label for="aliases">{{template "aliases (,)"}}</label>
|
||||
<input type="text" id="aliases" name="aliases"
|
||||
placeholder="homewiki, hw">
|
||||
</p>
|
||||
<p>
|
||||
<label for="url" class="required-field">{{template "url"}}</label>
|
||||
<input type="url" id="url" name="url" required
|
||||
placeholder="https://wiki.example.org">
|
||||
</p>
|
||||
<p>
|
||||
<label for="engine" class="required-field">{{template "engine"}}</label>
|
||||
<select name="engine" id="engine" required>
|
||||
<option value="mycorrhiza">{{template "engine/mycorrhiza"}} 🍄</option>
|
||||
<option value="betula">{{template "engine/betula"}} 🌳</option>
|
||||
<option value="agora">{{template "engine/agora"}} ἀ</option>
|
||||
<option value="generic">{{template "engine/generic"}}</option>
|
||||
</select>
|
||||
</p>
|
||||
<p>
|
||||
<label for="link-href-format">{{template "link href format"}}</label>
|
||||
<input type="url" id="link-href-format" name="link-href-format"
|
||||
placeholder="https://wiki.example.org/view/{NAME}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="img-src-format">{{template "img src format"}}</label>
|
||||
<input type="url" id="img-src-format" name="img-src-format"
|
||||
placeholder="https://wiki.example.org/media/{NAME}">
|
||||
</p>
|
||||
<input type="submit" class="btn" value="Add entry">
|
||||
</form>
|
||||
{{end}}
|
||||
|
||||
{{define "documentation."}}Documentation.{{end}}
|
||||
{{define "edit separately."}}Edit and save every the entry separately.{{end}}
|
||||
{{define "body"}}
|
||||
<main class="main-width">
|
||||
<h1>{{template "interwiki map"}}</h1>
|
||||
{{if .CanEdit}}
|
||||
<p><a href="/help/en/interwiki">{{template "documentation."}}</a> {{template "edit separately."}}</p>
|
||||
{{template "authorized map" .}}
|
||||
{{else}}
|
||||
<p><a href="/help/en/interwiki">{{template "documentation."}}</a></p>
|
||||
{{template "static map" .}}
|
||||
{{end}}
|
||||
</main>
|
||||
{{end}}
|
||||
@ -1,44 +0,0 @@
|
||||
{{define "body"}}
|
||||
<main class="main-width">
|
||||
<h1>{{block "heading" .}}Name taken{{end}}</h1>
|
||||
<p>{{block "tip" .TakenName}}Name <kbd>{{.}}</kbd> is already taken, please choose a different one.{{end}}</p>
|
||||
<form method="post" action="/interwiki/{{.Action}}">
|
||||
<p>
|
||||
<label for="name" class="required-field">Name:</label>
|
||||
<input type="text" id="name" name="name" required
|
||||
value="{{.Name}}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="aliases">Aliases (separated by commas):</label>
|
||||
<input type="text" id="aliases" name="aliases"
|
||||
value="{{range $j, $alias := .Aliases}}{{if gt $j 0}}, {{end}}{{.}}{{end}}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="url" class="required-field">URL:</label>
|
||||
<input type="url" id="url" name="url" required
|
||||
value="{{.URL}}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="engine" class="required-field">Engine:</label>
|
||||
<select name="engine" id="engine" required>
|
||||
<option value="mycorrhiza" {{if eq .Engine "mycorrhiza"}}selected{{end}}>Mycorrhiza 🍄</option>
|
||||
<option value="betula" {{if eq .Engine "betula"}}selected{{end}}>Betula 🌳</option>
|
||||
<option value="agora" {{if eq .Engine "agora"}}selected{{end}}>Agora ἀ</option>
|
||||
<option value="generic" {{if eq .Engine "generic"}}selected{{end}}>Generic (any website)</option>
|
||||
</select>
|
||||
</p>
|
||||
<p>
|
||||
<label for="link-href-format">Link href attribute format string:</label>
|
||||
<input type="url" id="link-href-format" name="link-href-format"
|
||||
value="{{.LinkHrefFormat}}">
|
||||
</p>
|
||||
<p>
|
||||
<label for="img-src-format">Image src attribute format string:</label>
|
||||
<input type="url" id="img-src-format" name="img-src-format"
|
||||
value="{{.ImgSrcFormat}}">
|
||||
</p>
|
||||
<input type="submit" class="btn" value="Save">
|
||||
<a class="btn btn_weak" href="/interwiki">{{template "cancel"}}</a>
|
||||
</form>
|
||||
</main>
|
||||
{{end}}
|
||||
133
interwiki/web.go
133
interwiki/web.go
@ -1,133 +0,0 @@
|
||||
package interwiki
|
||||
|
||||
import (
|
||||
"embed"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/web/viewutil"
|
||||
|
||||
"github.com/gorilla/mux"
|
||||
)
|
||||
|
||||
var (
|
||||
//go:embed *html
|
||||
fs embed.FS
|
||||
ruTranslation = `
|
||||
{{define "interwiki map"}}Интеркарта{{end}}
|
||||
{{define "name"}}Название:{{end}}
|
||||
{{define "aliases"}}Псевдонимы:{{end}}
|
||||
{{define "aliases (,)"}}Псевдонимы (разделённые запятыми):{{end}}
|
||||
{{define "engine"}}Движок:{{end}}
|
||||
{{define "engine/mycorrhiza"}}Микориза{{end}}
|
||||
{{define "engine/betula"}}Бетула{{end}}
|
||||
{{define "engine/agora"}}Агора{{end}}
|
||||
{{define "engine/generic"}}Любой сайт{{end}}
|
||||
{{define "link href format"}}Строка форматирования атрибута href ссылки:{{end}}
|
||||
{{define "img src format"}}Строка форматирования атрибута src изображения:{{end}}
|
||||
{{define "unset map"}}Интеркарта не задана.{{end}}
|
||||
{{define "documentation."}}Документация.{{end}}
|
||||
{{define "edit separately."}}Изменяйте записи по отдельности.{{end}}
|
||||
{{define "add interwiki entry"}}Добавить запись в интеркарту{{end}}
|
||||
`
|
||||
chainInterwiki viewutil.Chain
|
||||
chainNameTaken viewutil.Chain
|
||||
)
|
||||
|
||||
func InitHandlers(rtr *mux.Router) {
|
||||
chainInterwiki = viewutil.CopyEnRuWith(fs, "view_interwiki.html", ruTranslation)
|
||||
chainNameTaken = viewutil.CopyEnRuWith(fs, "view_name_taken.html", ruTranslation)
|
||||
rtr.HandleFunc("/interwiki", handlerInterwiki)
|
||||
rtr.HandleFunc("/interwiki/add-entry", handlerAddEntry).Methods(http.MethodPost)
|
||||
rtr.HandleFunc("/interwiki/modify-entry/{target}", handlerModifyEntry).Methods(http.MethodPost)
|
||||
}
|
||||
|
||||
func readInterwikiEntryFromRequest(rq *http.Request) Wiki {
|
||||
wiki := Wiki{
|
||||
Name: rq.PostFormValue("name"),
|
||||
Aliases: strings.Split(rq.PostFormValue("aliases"), ","),
|
||||
URL: rq.PostFormValue("url"),
|
||||
LinkHrefFormat: rq.PostFormValue("link-href-format"),
|
||||
ImgSrcFormat: rq.PostFormValue("img-src-format"),
|
||||
Engine: WikiEngine(rq.PostFormValue("engine")),
|
||||
}
|
||||
wiki.canonize()
|
||||
return wiki
|
||||
}
|
||||
|
||||
func handlerModifyEntry(w http.ResponseWriter, rq *http.Request) {
|
||||
var (
|
||||
oldData *Wiki
|
||||
ok bool
|
||||
name = mux.Vars(rq)["target"]
|
||||
newData = readInterwikiEntryFromRequest(rq)
|
||||
)
|
||||
|
||||
if oldData, ok = entriesByName[name]; !ok {
|
||||
slog.Info("Could not modify entry",
|
||||
"name", name,
|
||||
"reason", "does not exist")
|
||||
viewutil.HandlerNotFound(w, rq)
|
||||
return
|
||||
}
|
||||
|
||||
if err := replaceEntry(oldData, &newData); err != nil {
|
||||
slog.Info("Could not modify entry",
|
||||
"name", name,
|
||||
"reason", "one of the proposed aliases or the name is taken",
|
||||
"err", err)
|
||||
viewNameTaken(viewutil.MetaFrom(w, rq), oldData, err.Error(), "modify-entry/"+name)
|
||||
return
|
||||
}
|
||||
|
||||
saveInterwikiJson()
|
||||
slog.Info("Modified entry", "name", name)
|
||||
http.Redirect(w, rq, "/interwiki", http.StatusSeeOther)
|
||||
}
|
||||
|
||||
func handlerAddEntry(w http.ResponseWriter, rq *http.Request) {
|
||||
wiki := readInterwikiEntryFromRequest(rq)
|
||||
if err := addEntry(&wiki); err != nil {
|
||||
viewNameTaken(viewutil.MetaFrom(w, rq), &wiki, err.Error(), "add-entry")
|
||||
return
|
||||
}
|
||||
saveInterwikiJson()
|
||||
http.Redirect(w, rq, "/interwiki", http.StatusSeeOther)
|
||||
}
|
||||
|
||||
type nameTakenData struct {
|
||||
*viewutil.BaseData
|
||||
*Wiki
|
||||
TakenName string
|
||||
Action string
|
||||
}
|
||||
|
||||
func viewNameTaken(meta viewutil.Meta, wiki *Wiki, takenName, action string) {
|
||||
viewutil.ExecutePage(meta, chainNameTaken, nameTakenData{
|
||||
BaseData: &viewutil.BaseData{},
|
||||
Wiki: wiki,
|
||||
TakenName: takenName,
|
||||
Action: action,
|
||||
})
|
||||
}
|
||||
|
||||
func handlerInterwiki(w http.ResponseWriter, rq *http.Request) {
|
||||
viewInterwiki(viewutil.MetaFrom(w, rq))
|
||||
}
|
||||
|
||||
type interwikiData struct {
|
||||
*viewutil.BaseData
|
||||
Entries []*Wiki
|
||||
CanEdit bool
|
||||
Error string
|
||||
}
|
||||
|
||||
func viewInterwiki(meta viewutil.Meta) {
|
||||
viewutil.ExecutePage(meta, chainInterwiki, interwikiData{
|
||||
BaseData: &viewutil.BaseData{},
|
||||
Entries: listOfEntries,
|
||||
CanEdit: meta.U.Group == "admin",
|
||||
Error: "",
|
||||
})
|
||||
}
|
||||
@ -1,96 +0,0 @@
|
||||
package interwiki
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
)
|
||||
|
||||
// WikiEngine is an enumeration of supported interwiki targets.
|
||||
type WikiEngine string
|
||||
|
||||
const (
|
||||
Mycorrhiza WikiEngine = "mycorrhiza"
|
||||
Betula WikiEngine = "betula"
|
||||
Agora WikiEngine = "agora"
|
||||
// Generic is any website.
|
||||
Generic WikiEngine = "generic"
|
||||
)
|
||||
|
||||
func (we WikiEngine) Valid() bool {
|
||||
switch we {
|
||||
case Mycorrhiza, Betula, Agora, Generic:
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// Wiki is an entry in the interwiki map.
|
||||
type Wiki struct {
|
||||
// Name is the name of the wiki, and is also one of the possible prefices.
|
||||
Name string `json:"name"`
|
||||
|
||||
// Aliases are alternative prefices you can use instead of Name. This slice can be empty.
|
||||
Aliases []string `json:"aliases,omitempty"`
|
||||
|
||||
// URL is the address of the wiki.
|
||||
URL string `json:"url"`
|
||||
|
||||
// LinkHrefFormat is a format string for interwiki links. See Mycomarkup internal docs hidden deep inside for more information.
|
||||
//
|
||||
// This field is optional. If it is not set, it is derived from other data. See the code.
|
||||
LinkHrefFormat string `json:"link_href_format"`
|
||||
|
||||
ImgSrcFormat string `json:"img_src_format"`
|
||||
|
||||
// Engine is the engine of the wiki. Invalid values will result in a start-up error.
|
||||
Engine WikiEngine `json:"engine"`
|
||||
}
|
||||
|
||||
func (w *Wiki) canonize() error {
|
||||
switch {
|
||||
case w.Name == "":
|
||||
slog.Error("A site in the interwiki map has no name")
|
||||
return errors.New("site with no name")
|
||||
case w.URL == "":
|
||||
slog.Error("Site in the interwiki map has no URL", "name", w.Name)
|
||||
return errors.New("site with no URL")
|
||||
case !w.Engine.Valid():
|
||||
slog.Error("Site in the interwiki map has an unknown engine",
|
||||
"siteName", w.Name,
|
||||
"engine", w.Engine,
|
||||
)
|
||||
return errors.New("unknown engine")
|
||||
}
|
||||
|
||||
w.Name = util.CanonicalName(w.Name)
|
||||
for i, alias := range w.Aliases {
|
||||
w.Aliases[i] = util.CanonicalName(alias)
|
||||
}
|
||||
|
||||
if w.LinkHrefFormat == "" {
|
||||
switch w.Engine {
|
||||
case Mycorrhiza:
|
||||
w.LinkHrefFormat = fmt.Sprintf("%s/hypha/{NAME}", w.URL)
|
||||
case Betula:
|
||||
w.LinkHrefFormat = fmt.Sprintf("%s/{BETULA-NAME}", w.URL)
|
||||
case Agora:
|
||||
w.LinkHrefFormat = fmt.Sprintf("%s/node/{NAME}", w.URL)
|
||||
default:
|
||||
w.LinkHrefFormat = fmt.Sprintf("%s/{NAME}", w.URL)
|
||||
}
|
||||
}
|
||||
|
||||
if w.ImgSrcFormat == "" {
|
||||
switch w.Engine {
|
||||
case Mycorrhiza:
|
||||
w.ImgSrcFormat = fmt.Sprintf("%s/binary/{NAME}", w.URL)
|
||||
default:
|
||||
w.ImgSrcFormat = fmt.Sprintf("%s/{NAME}", w.URL)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
23
l18n/en/admin.json
Normal file
23
l18n/en/admin.json
Normal file
@ -0,0 +1,23 @@
|
||||
{
|
||||
"users_title": "Manage users",
|
||||
"users_create": "Create a new user",
|
||||
"users_reindex": "Reindex users",
|
||||
"users_name": "Name",
|
||||
"users_password": "Password",
|
||||
"users_group": "Group",
|
||||
"users_registered": "Registered at",
|
||||
"users_actions": "Actions",
|
||||
"users_notime": "unknown",
|
||||
"users_edit": "Edit",
|
||||
|
||||
"user_title": "User %s",
|
||||
"user_group_heading": "Change group",
|
||||
"user_update": "Update",
|
||||
"user_delete_heading": "Delete user",
|
||||
"user_delete_tip": "Remove the user from the database. Changes made by the user will be preserved. It will be possible to take this username later.",
|
||||
"user_delete_warn": "Are you sure you want to delete {{.name}} from the database? This action is irreversible.",
|
||||
"user_delete": "Delete",
|
||||
|
||||
"newuser_title": "New user",
|
||||
"newuser_create": "Create"
|
||||
}
|
||||
@ -3,29 +3,33 @@
|
||||
"password": "Password",
|
||||
|
||||
"register_title": "Register",
|
||||
"register_header": "",
|
||||
"register_header": "Register on {{.name}}",
|
||||
"register_button": "Register",
|
||||
|
||||
"login_title": "Login",
|
||||
"login_header": "Log in to {{.name}}",
|
||||
"login_button": "Log in",
|
||||
|
||||
"logout_title": "",
|
||||
"logout_title": "Logout?",
|
||||
"logout_header": "Log out?",
|
||||
"logout_button": "Confirm",
|
||||
"logout_anon": "",
|
||||
"logout_anon": "You cannot log out because you are not logged in.",
|
||||
|
||||
"lock_title": "Locked",
|
||||
|
||||
"password_tip": "",
|
||||
"cookie_tip": "",
|
||||
"telegram_tip": "",
|
||||
"password_tip": "The server stores your password in an encrypted form; even administrators cannot read it.",
|
||||
"cookie_tip": "By submitting this form you give this wiki a permission to store cookies in your browser. It lets the engine associate your edits with you. You will stay logged in until you log out.",
|
||||
"telegram_tip": "You can log in using Telegram. It only works if you have set your @username in Telegram and this username is free on this wiki.",
|
||||
|
||||
"noauth": "",
|
||||
"noauth": "Authentication is disabled. You can make edits anonymously.",
|
||||
"noregister": "Registrations are currently closed. Administrators can make an account for you by hand; contact them.",
|
||||
|
||||
"error_username": "",
|
||||
"error_password": "",
|
||||
"error_telegram": "",
|
||||
"error_username": "Unknown username.",
|
||||
"error_password": "Wrong password.",
|
||||
"error_telegram": "Could not authorize using Telegram.",
|
||||
|
||||
"go_back": "Go back",
|
||||
"go_home": "",
|
||||
"go_home": "Go home",
|
||||
"go_login": "Go to the login page",
|
||||
"try_again": "Try again"
|
||||
}
|
||||
|
||||
@ -3,7 +3,33 @@
|
||||
"register": "Register",
|
||||
"title_search": "Search by title",
|
||||
"admin_panel": "Admin panel",
|
||||
|
||||
"search_results_title": "Search: {{.query}}",
|
||||
"search_results_query": "Search results for ‘{{.query}}’",
|
||||
"search_results_desc": "Every hypha name has been compared with the query. Hyphae that have matched the query are listed below.",
|
||||
|
||||
"backlinks_title": "Backlinks to {{.hypha_name}}",
|
||||
"backlinks_heading": "Backlinks to {{.hypha_link}}",
|
||||
"backlinks_desc": "Hyphae which have a link to this hypha, embed it as an image or transclude it are listed below.",
|
||||
|
||||
"list_title": "List of pages",
|
||||
"list_heading": "List of hyphae",
|
||||
"list_desc": "This wiki has {{.n}} %s.",
|
||||
"list_desc+one": "hypha",
|
||||
"list_desc+other": "hyphae",
|
||||
|
||||
"edit_link": "Edit text",
|
||||
"logout_link": "Log out",
|
||||
"history_link": "View history",
|
||||
"rename_link": "Rename",
|
||||
"delete_link": "Delete",
|
||||
"text_link": "View markup",
|
||||
"media_link": "Manage media",
|
||||
"backlinks_link": "{{.n}} backlink%s",
|
||||
"backlinks_link+one": "",
|
||||
"backlinks_link+other": "s",
|
||||
|
||||
"sibling_hyphae": "Sibling hyphae",
|
||||
"subhyphae": "Subhyphae",
|
||||
|
||||
"random_no_hyphae": "There are no hyphae",
|
||||
@ -38,16 +64,30 @@
|
||||
"act_norights_edit": "You must be an editor to edit a hypha",
|
||||
"act_norights_upload_media": "You must be an editor to upload media",
|
||||
|
||||
"ask_delete": "Delete %s?",
|
||||
"ask_delete_tip": "In this version of Mycorrhiza Wiki you cannot undelete a deleted hypha but the history can still be accessed.",
|
||||
"ask_remove_media": "Remove media from %s?",
|
||||
"ask_really": "Do you really want to {{.verb}} hypha {{.name}}?",
|
||||
"ask_delete_verb": "delete",
|
||||
"ask_remove_media_verb": "remove_media",
|
||||
|
||||
"history_title": "History of %s",
|
||||
|
||||
"recent_title": "{{.n}} recent change%s",
|
||||
"recent_title+one": "",
|
||||
"recent_title+other": "s",
|
||||
"recent_heading": "Recent Changes",
|
||||
"recent_count_pre": "See",
|
||||
"recent_count_post": "recent changes",
|
||||
"recent_subscribe": "Subscribe via {{.rss}}, {{.atom}} or {{.json}}",
|
||||
"recent_subscribe_json": "JSON feed",
|
||||
"recent_empty": "Could not find any recent changes.",
|
||||
|
||||
"diff_title": "Diff of {{.name}} at {{.rev}}",
|
||||
|
||||
"revision_title": "",
|
||||
"revision_warning": "",
|
||||
"revision_link": "",
|
||||
"revision_title": "{{.name}} at {{.rev}}",
|
||||
"revision_warning": "Please note that viewing media is not supported in history for now.",
|
||||
"revision_link": "Get Mycomarkup source of this revision",
|
||||
"revision_no_text": "This hypha had no text at this revision.",
|
||||
|
||||
"about_title": "About {{.name}}",
|
||||
@ -58,12 +98,44 @@
|
||||
"reindex_no_rights": "You must be an admin to reindex hyphae.",
|
||||
"header_no_rights": "You must be a moderator to update header links.",
|
||||
|
||||
"notexist_heading": "This hypha does not exist",
|
||||
"notexist_norights": "You are not authorized to create new hyphae. Here is what you can do:",
|
||||
"notexist_login": "Log in to your account, if you have one",
|
||||
"notexist_register": "Register a new account",
|
||||
"notexist_write": "Write a text",
|
||||
"notexist_write_tip1": "Write a note, a diary, an article, a story or anything textual using {{.myco}}. Full history of edits to the document will be saved.",
|
||||
"notexist_write_myco": "Mycomarkup",
|
||||
"notexist_write_tip2": "Make sure to follow this wiki's writing conventions if there are any.",
|
||||
"notexist_write_button": "Create",
|
||||
"notexist_media": "Upload a media",
|
||||
"notexist_media_tip1": "Upload a picture, a video or an audio. Most common formats can be accessed from the browser, others can be only downloaded afterwards. You can write a description for the media later.",
|
||||
|
||||
"media_download": "Download media",
|
||||
"media_novideo": "Your browser does not support video.",
|
||||
"media_novideo_link": "Download video",
|
||||
"media_noaudio": "Your browser does not support audio.",
|
||||
"media_noaudio_link": "Download audio",
|
||||
|
||||
"media_title": "Media of {{.name}}",
|
||||
"media_empty": "This hypha has no media, you can upload it here.",
|
||||
"media_tip": "You can manage the hypha's media on this page.",
|
||||
"media_what_is": "What is media?",
|
||||
"media_upload": "Upload",
|
||||
"media_stat": "Stat",
|
||||
"media_stat_size": "File size:",
|
||||
"media_size_value": "{{.n}} byte%s",
|
||||
"media_size_value+one": "",
|
||||
"media_size_value+other": "s",
|
||||
"media_stat_mime": "MIME type:",
|
||||
"media_include": "Include",
|
||||
"media_include_tip": "This media is an image. To include it in a hypha, use a syntax like this:",
|
||||
"media_new": "media",
|
||||
"media_new_tip": "You can upload a new media. Please do not upload too big pictures unless you need to because may not want to wait for big pictures to load.",
|
||||
"media_remove": "Remove media",
|
||||
"media_remove_tip": "Please note that you don't have to remove media before uploading a new media.",
|
||||
"media_remove_button": "Remove media",
|
||||
|
||||
"close_dialog": "Close this dialog",
|
||||
"confirm": "Confirm",
|
||||
"cancel": "Cancel"
|
||||
}
|
||||
|
||||
11
l18n/l18n.go
11
l18n/l18n.go
@ -21,7 +21,7 @@ import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"log/slog"
|
||||
"log"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
@ -40,7 +40,6 @@ type Localizer struct {
|
||||
}
|
||||
|
||||
// locales is a filesystem containing all localization files.
|
||||
//
|
||||
//go:embed en ru
|
||||
var locales embed.FS
|
||||
|
||||
@ -78,7 +77,7 @@ func init() {
|
||||
|
||||
var strings map[string]string
|
||||
if err := json.Unmarshal(contents, &strings); err != nil {
|
||||
slog.Error("Failed to unmarshal localization file", "path", path, "err", err)
|
||||
log.Fatalf("error while parsing %s: %v", path, err)
|
||||
}
|
||||
|
||||
for key, value := range strings {
|
||||
@ -119,7 +118,7 @@ func (t Localizer) GetWithLocale(locale, key string, replacements ...*Replacemen
|
||||
|
||||
// If the str doesn't have any substitutions, no need to
|
||||
// template.Execute.
|
||||
if !strings.Contains(str, "}}") {
|
||||
if strings.Index(str, "}}") == -1 {
|
||||
return str
|
||||
}
|
||||
|
||||
@ -146,7 +145,7 @@ func (t Localizer) GetPlural(key string, n int, replacements ...*Replacements) s
|
||||
|
||||
// As in the original, we skip templating if have nothing to replace
|
||||
// (however, it's strange case for plurals)
|
||||
if !strings.Contains(str, "}}") {
|
||||
if strings.Index(str, "}}") == -1 {
|
||||
return str
|
||||
}
|
||||
|
||||
@ -165,7 +164,7 @@ func (t Localizer) GetPlural64(key string, n int64, replacements ...*Replacement
|
||||
|
||||
// As in the original, we skip templating if have nothing to replace
|
||||
// (however, it's strange case for plurals)
|
||||
if !strings.Contains(str, "}}") {
|
||||
if strings.Index(str, "}}") == -1 {
|
||||
return str
|
||||
}
|
||||
|
||||
|
||||
23
l18n/ru/admin.json
Normal file
23
l18n/ru/admin.json
Normal file
@ -0,0 +1,23 @@
|
||||
{
|
||||
"users_title": "Менеджер пользователей",
|
||||
"users_create": "Создать пользователя",
|
||||
"users_reindex": "Переиндексировать пользователей",
|
||||
"users_name": "Имя",
|
||||
"users_password": "Пароль",
|
||||
"users_group": "Группа",
|
||||
"users_registered": "Время создания",
|
||||
"users_actions": "Действия",
|
||||
"users_notime": "неизвестно",
|
||||
"users_edit": "Изменить",
|
||||
|
||||
"user_title": "Пользователь %s",
|
||||
"user_group_heading": "Изменить группу",
|
||||
"user_update": "Обновить",
|
||||
"user_delete_heading": "Удалить пользователя",
|
||||
"user_delete_tip": "Удаляет пользователя из базы данных. Правки пользователя будут сохранены. Имя пользователя освободится для повторной регистрации.",
|
||||
"user_delete_warn": "Вы уверены, что хотите удалить {{.name}} из базы данных? Это действие нельзя отменить.",
|
||||
"user_delete": "Удалить",
|
||||
|
||||
"newuser_title": "Новый пользователь",
|
||||
"newuser_create": "Создать"
|
||||
}
|
||||
@ -2,31 +2,31 @@
|
||||
"username": "Логин",
|
||||
"password": "Пароль",
|
||||
|
||||
"register_title": "",
|
||||
"register_header": "",
|
||||
"register_button": "",
|
||||
"register_title": "Регистрация",
|
||||
"register_header": "Регистрация на «{{.name}}»",
|
||||
"register_button": "Зарегистрироваться",
|
||||
|
||||
"login_title": "Вход",
|
||||
"login_header": "",
|
||||
"login_button": "",
|
||||
"login_header": "Вход в «{{.name}}»",
|
||||
"login_button": "Войти",
|
||||
|
||||
"logout_title": "",
|
||||
"logout_header": "?",
|
||||
"logout_title": "Выйти?",
|
||||
"logout_header": "Выйти?",
|
||||
"logout_button": "Подтвердить",
|
||||
"logout_anon": "",
|
||||
"logout_anon": "Вы не можете выйти, потому что ещё не вошли.",
|
||||
|
||||
"lock_title": "",
|
||||
"lock_title": "Доступ закрыт",
|
||||
|
||||
"password_tip": "",
|
||||
"cookie_tip": "",
|
||||
"password_tip": "Сервер хранит ваш пароль в зашифрованном виде, даже администраторы не смогут его прочесть.",
|
||||
"cookie_tip": "Отправляя эту форму, вы разрешаете вики хранить cookie в вашем браузере. Это позволит движку связывать ваши правки с вашей учётной записью. Вы будете авторизованы, пока не выйдете из учётной записи.",
|
||||
"telegram_tip": "Вы можете войти с помощью Телеграм. Это сработает, если у вашего профиля есть @имя, и оно не занято в этой вики.",
|
||||
|
||||
"noauth": "",
|
||||
"noauth": "Аутентификация отключена. Вы можете делать правки анонимно.",
|
||||
"noregister": "Регистрация в текущее время недоступна. Администраторы могут вручную создать вам учётную запись, свяжитесь с ними.",
|
||||
|
||||
"error_username": "",
|
||||
"error_username": "Неизвестное имя пользователя.",
|
||||
"error_password": "Неверный пароль.",
|
||||
"error_telegram": "",
|
||||
"error_telegram": "Не удалось авторизоваться через Телеграм.",
|
||||
|
||||
"go_back": "Назад",
|
||||
"go_home": "Домой",
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"title": "Редактирование %s",
|
||||
"title": "Редактирование «%s»",
|
||||
|
||||
"new_hypha": "Вы создаёте новую гифу.",
|
||||
"tag": "Опишите ваши правки:",
|
||||
@ -29,7 +29,7 @@
|
||||
"bullets": "Маркир. список",
|
||||
"numbers": "Нумер. список",
|
||||
|
||||
"help": "{{.link}} о Микоразметке",
|
||||
"help": "{{.link}} о микоразметке",
|
||||
"help_link": "Подробнее",
|
||||
|
||||
"selflink": "Ссылка на вас",
|
||||
|
||||
@ -3,24 +3,35 @@
|
||||
"register": "Регистрация",
|
||||
"title_search": "Поиск по названию",
|
||||
"admin_panel": "Администрирование",
|
||||
|
||||
|
||||
"search_results_title": "Поиск: {{.query}}",
|
||||
"search_results_query": "Результаты поиска для «{{.query}}»",
|
||||
"search_results_desc": "Название каждой из существующих гиф сопоставлено с запросом. Подходящие гифы приведены ниже.",
|
||||
|
||||
"backlinks_title": "Обратные ссылки на {{.hypha_name}}",
|
||||
"backlinks_heading": "Обратные ссылки на {{.hypha_link}}",
|
||||
"backlinks_desc": "Ниже перечислены гифы, на которых есть ссылка на эту гифу, трансклюзия этой гифы или эта гифа вставлена как изображение.",
|
||||
|
||||
"list_title": "Список страниц",
|
||||
"list_heading": "Список гиф",
|
||||
"list_desc": "В этой вики {{.n}} %s.",
|
||||
"list_desc+one": "гифа",
|
||||
"list_desc+few": "гифы",
|
||||
"list_desc+many": "гиф",
|
||||
|
||||
"edit_link": "",
|
||||
"logout_link": "",
|
||||
"history_link": "",
|
||||
"rename_link": "",
|
||||
"delete_link": "",
|
||||
"text_link": "",
|
||||
"media_link": "",
|
||||
"media_link_for_textual": "",
|
||||
"edit_link": "Редактировать",
|
||||
"logout_link": "Выйти",
|
||||
"history_link": "История",
|
||||
"rename_link": "Переименовать",
|
||||
"delete_link": "Удалить",
|
||||
"text_link": "Посмотреть разметку",
|
||||
"media_link": "Медиа",
|
||||
"backlinks_link": "{{.n}} %s сюда",
|
||||
"backlinks_link+one": "ссылка",
|
||||
"backlinks_link+few": "ссылки",
|
||||
"backlinks_link+many": "ссылок",
|
||||
|
||||
|
||||
"sibling_hyphae": "Гифы-сиблинги",
|
||||
"subhyphae": "Подгифы",
|
||||
|
||||
"random_no_hyphae": "В этой вики нет гиф",
|
||||
@ -55,13 +66,31 @@
|
||||
"act_notexist_rename": "Нельзя переименовать эту гифу, потому что она не существует",
|
||||
"act_notexist_remove_media": "Нельзя убрать медиа, потому что нет такой гифы",
|
||||
|
||||
"ask_delete": "Удалить «%s»?",
|
||||
"ask_delete_tip": "В этой версии Микоризы нельзя отменить удаление гифы, но её история останется доступной.",
|
||||
"ask_remove_media": "Убрать медиа у «%s»?",
|
||||
"ask_really": "Вы действительно хотите {{.verb}} гифу «{{.name}}»?",
|
||||
"ask_delete_verb": "удалить",
|
||||
"ask_remove_media_verb": "убрать медиа",
|
||||
|
||||
"revision_title": "",
|
||||
"revision_warning": "",
|
||||
"revision_link": "",
|
||||
"history_title": "История «%s»",
|
||||
|
||||
"recent_title": "{{.n}} %s",
|
||||
"recent_title+one": "недавнее изменение",
|
||||
"recent_title+few": "недавних изменения",
|
||||
"recent_title+many": "недавних изменений",
|
||||
"recent_heading": "Недавние изменения",
|
||||
"recent_count_pre": "Отобразить",
|
||||
"recent_count_post": "недавних изменений",
|
||||
"recent_subscribe": "Подписаться через {{.rss}}, {{.atom}} или {{.json}}",
|
||||
"recent_subscribe_json": "JSON-ленту",
|
||||
"recent_empty": "Не удалось найти последние изменения.",
|
||||
|
||||
"diff_title": "Разница для «{{.name}}» из {{.rev}}",
|
||||
|
||||
"revision_title": "{{.name}} из {{.rev}}",
|
||||
"revision_warning": "Обратите внимание, просмотр медиа в истории пока что недоступен.",
|
||||
"revision_link": "Посмотреть код микоразметки для этой ревизии",
|
||||
"revision_no_text": "В этой ревизии гифы не было текста.",
|
||||
|
||||
"about_title": "О {{.name}}",
|
||||
@ -71,6 +100,18 @@
|
||||
"no_rights": "Недостаточно прав",
|
||||
"reindex_no_rights": "Вы должны быть администратором, чтобы переиндексировать гифы.",
|
||||
"header_no_rights": "Вы должны быть модератором, чтобы обновить ссылки в заголовке.",
|
||||
|
||||
"notexist_heading": "Эта гифа не существует",
|
||||
"notexist_norights": "У вас нет прав для создания новых гиф. Вы можете:",
|
||||
"notexist_login": "Войти в свою учётную запись, если она у вас есть",
|
||||
"notexist_register": "Создать новую учётную запись",
|
||||
"notexist_write": "Написать текст",
|
||||
"notexist_write_tip1": "Напишите заметку, дневник, статью, рассказ или иной текст с помощью {{.myco}}. Сохраняется полная история правок документа.",
|
||||
"notexist_write_myco": "микоразметки",
|
||||
"notexist_write_tip2": "Не забывайте следовать правилам оформления этой вики, если они имеются.",
|
||||
"notexist_write_button": "Создать",
|
||||
"notexist_media": "Загрузить медиа",
|
||||
"notexist_media_tip1": "Загрузите изображение, видео или аудио. Распространённые форматы можно просматривать из браузера, остальные – просто скачать. Позже вы можете дописать пояснение к этому медиа.",
|
||||
|
||||
"media_download": "Скачать медиа",
|
||||
"media_novideo": "Ваш браузер не поддерживает видео.",
|
||||
@ -78,6 +119,27 @@
|
||||
"media_noaudio": "Ваш браузер не поддерживает аудио.",
|
||||
"media_noaudio_link": "Скачать аудио",
|
||||
|
||||
"media_title": "Медиа «{{.name}}»",
|
||||
"media_empty": "Эта гифа не имеет медиа, здесь вы можете его загрузить.",
|
||||
"media_tip": "На этой странице вы можете управлять медиа.",
|
||||
"media_what_is": "Что такое медиа?",
|
||||
"media_upload": "Загрузить",
|
||||
"media_stat": "Свойства",
|
||||
"media_stat_size": "Размер файла:",
|
||||
"media_size_value": "{{.n}} %s",
|
||||
"media_size_value+one": "байт",
|
||||
"media_size_value+few": "байта",
|
||||
"media_size_value+many": "байт",
|
||||
"media_stat_mime": "MIME-тип:",
|
||||
"media_include": "Добавление",
|
||||
"media_include_tip": "Это медиа – изображение. Чтобы добавить его в текст гифы, используйте синтаксис ниже:",
|
||||
"media_new": "Прикрепить",
|
||||
"media_new_tip": "Вы можете загрузить новое медиа. Пожалуйста, не загружайте слишком большие изображения без необходимости, чтобы впоследствии не ждать её долгую загрузку.",
|
||||
"media_remove": "Открепить",
|
||||
"media_remove_tip": "Заметьте, чтобы заменить медиа, вам не нужно его перед этим откреплять.",
|
||||
"media_remove_button": "Открепить",
|
||||
|
||||
"close_dialog": "Закрыть этот диалог",
|
||||
"confirm": "Применить",
|
||||
"cancel": "Отмена"
|
||||
}
|
||||
|
||||
69
main.go
69
main.go
@ -1,79 +1,58 @@
|
||||
//go:generate go run github.com/valyala/quicktemplate/qtc -dir=views
|
||||
//go:generate go run github.com/valyala/quicktemplate/qtc -dir=tree
|
||||
//go:generate go run github.com/valyala/quicktemplate/qtc -dir=history
|
||||
// Command mycorrhiza is a program that runs a mycorrhiza wiki.
|
||||
package main
|
||||
|
||||
import (
|
||||
"log/slog"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae/categories"
|
||||
"github.com/bouncepaw/mycorrhiza/migration"
|
||||
"log"
|
||||
"os"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae/backlinks"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/files"
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/backlinks"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/categories"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/migration"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/shroom"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/version"
|
||||
"github.com/bouncepaw/mycorrhiza/interwiki"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/shroom"
|
||||
"github.com/bouncepaw/mycorrhiza/static"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
"github.com/bouncepaw/mycorrhiza/web"
|
||||
"github.com/bouncepaw/mycorrhiza/web/static"
|
||||
"github.com/bouncepaw/mycorrhiza/web/viewutil"
|
||||
)
|
||||
|
||||
func main() {
|
||||
if err := parseCliArgs(); err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
parseCliArgs()
|
||||
|
||||
if err := files.PrepareWikiRoot(); err != nil {
|
||||
slog.Error("Failed to prepare wiki root", "err", err)
|
||||
os.Exit(1)
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if err := cfg.ReadConfigFile(files.ConfigPath()); err != nil {
|
||||
slog.Error("Failed to read config", "err", err)
|
||||
os.Exit(1)
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
log.Println("Running Mycorrhiza Wiki 1.9.0")
|
||||
if err := os.Chdir(files.HyphaeDir()); err != nil {
|
||||
slog.Error("Failed to chdir to hyphae dir",
|
||||
"err", err, "hyphaeDir", files.HyphaeDir())
|
||||
os.Exit(1)
|
||||
log.Fatal(err)
|
||||
}
|
||||
slog.Info("Running Mycorrhiza Wiki",
|
||||
"version", version.Short, "wikiDir", cfg.WikiDir)
|
||||
log.Println("Wiki directory is", cfg.WikiDir)
|
||||
log.Println("Using Git storage at", files.HyphaeDir())
|
||||
|
||||
// Init the subsystems:
|
||||
// TODO: keep all crashes in main rather than somewhere there
|
||||
viewutil.Init()
|
||||
hyphae.Index(files.HyphaeDir())
|
||||
backlinks.IndexBacklinks()
|
||||
go backlinks.RunBacklinksConveyor()
|
||||
user.InitUserDatabase()
|
||||
if err := history.Start(); err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
history.Start()
|
||||
history.InitGitRepo()
|
||||
migration.MigrateRocketsMaybe()
|
||||
migration.MigrateHeadingsMaybe()
|
||||
shroom.SetHeaderLinks()
|
||||
if err := categories.Init(); err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
if err := interwiki.Init(); err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
categories.InitCategories()
|
||||
|
||||
// Static files:
|
||||
static.InitFS(files.StaticFiles())
|
||||
|
||||
if !user.HasAnyAdmins() {
|
||||
slog.Error("Your wiki has no admin yet. Run Mycorrhiza with -create-admin <username> option to create an admin.")
|
||||
}
|
||||
|
||||
err := serveHTTP(web.Handler())
|
||||
if err != nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
serveHTTP(web.Handler())
|
||||
}
|
||||
|
||||
122
migration/rockets.go
Normal file
122
migration/rockets.go
Normal file
@ -0,0 +1,122 @@
|
||||
// Package migration holds the utilities for migrating from older incompatible Mycomarkup versions.
|
||||
//
|
||||
// As of, there is rocket link migration only. Migrations are meant to be removed couple of versions after being introduced.
|
||||
package migration
|
||||
|
||||
import (
|
||||
"github.com/bouncepaw/mycomarkup/v3/tools"
|
||||
"io"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/files"
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
)
|
||||
|
||||
// TODO: add heading migration too.
|
||||
|
||||
var rocketMarkerPath string
|
||||
|
||||
// MigrateRocketsMaybe checks if the rocket link migration marker exists. If it exists, nothing is done. If it does not, the migration takes place.
|
||||
//
|
||||
// This function writes logs and might terminate the program. Tons of side-effects, stay safe.
|
||||
func MigrateRocketsMaybe() {
|
||||
rocketMarkerPath = files.FileInRoot(".mycomarkup-rocket-link-migration-marker.txt")
|
||||
if !shouldMigrateRockets() {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
hop = history.
|
||||
Operation(history.TypeMarkupMigration).
|
||||
WithMsg("Migrate rocket links to the new syntax").
|
||||
WithUser(user.WikimindUser())
|
||||
mycoFiles = []string{}
|
||||
)
|
||||
|
||||
for hypha := range hyphae.FilterHyphaeWithText(hyphae.YieldExistingHyphae()) {
|
||||
/// Open file, read from file, modify file. If anything goes wrong, scream and shout.
|
||||
|
||||
file, err := os.OpenFile(hypha.TextFilePath(), os.O_RDWR, 0766)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
log.Fatal("Something went wrong when opening ", hypha.TextFilePath(), ": ", err.Error())
|
||||
}
|
||||
|
||||
var buf strings.Builder
|
||||
_, err = io.Copy(&buf, file)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
_ = file.Close()
|
||||
log.Fatal("Something went wrong when reading ", hypha.TextFilePath(), ": ", err.Error())
|
||||
}
|
||||
|
||||
var (
|
||||
oldText = buf.String()
|
||||
newText = tools.MigrateRocketLinks(oldText)
|
||||
)
|
||||
if oldText != newText { // This file right here is being migrated for real.
|
||||
mycoFiles = append(mycoFiles, hypha.TextFilePath())
|
||||
|
||||
err = file.Truncate(0)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
_ = file.Close()
|
||||
log.Fatal("Something went wrong when truncating ", hypha.TextFilePath(), ": ", err.Error())
|
||||
}
|
||||
|
||||
_, err = file.Seek(0, 0)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
_ = file.Close()
|
||||
log.Fatal("Something went wrong when seeking in ", hypha.TextFilePath(), ": ", err.Error())
|
||||
}
|
||||
|
||||
_, err = file.WriteString(newText)
|
||||
if err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
_ = file.Close()
|
||||
log.Fatal("Something went wrong when writing to ", hypha.TextFilePath(), ": ", err.Error())
|
||||
}
|
||||
}
|
||||
_ = file.Close()
|
||||
}
|
||||
|
||||
if len(mycoFiles) == 0 {
|
||||
hop.Abort()
|
||||
return
|
||||
}
|
||||
|
||||
if hop.WithFiles(mycoFiles...).Apply().HasErrors() {
|
||||
log.Fatal("Something went wrong when commiting rocket link migration: ", hop.FirstErrorText())
|
||||
}
|
||||
log.Println("Migrated", len(mycoFiles), "Mycomarkup documents")
|
||||
createRocketLinkMarker()
|
||||
}
|
||||
|
||||
func shouldMigrateRockets() bool {
|
||||
file, err := os.Open(rocketMarkerPath)
|
||||
if os.IsNotExist(err) {
|
||||
return true
|
||||
}
|
||||
if err != nil {
|
||||
log.Fatalln("When checking if rocket migration is needed:", err.Error())
|
||||
}
|
||||
_ = file.Close()
|
||||
return false
|
||||
}
|
||||
|
||||
func createRocketLinkMarker() {
|
||||
err := ioutil.WriteFile(
|
||||
rocketMarkerPath,
|
||||
[]byte(`This file is used to mark that the rocket link migration was made successfully. If this file is deleted, the migration might happen again depending on the version. You should probably not touch this file at all and let it be.`),
|
||||
0766,
|
||||
)
|
||||
if err != nil {
|
||||
log.Fatalln(err)
|
||||
}
|
||||
}
|
||||
@ -40,33 +40,20 @@ func DataFromFilename(fullPath string) (name string, isText bool, skip bool) {
|
||||
|
||||
var mapMime2Ext = map[string]string{
|
||||
"application/octet-stream": "bin",
|
||||
|
||||
"image/jpeg": "jpg",
|
||||
"image/gif": "gif",
|
||||
"image/png": "png",
|
||||
"image/webp": "webp",
|
||||
"image/svg+xml": "svg",
|
||||
"image/x-icon": "ico",
|
||||
|
||||
"application/ogg": "ogg",
|
||||
"video/webm": "webm",
|
||||
"audio/mp3": "mp3",
|
||||
"audio/mpeg": "mp3",
|
||||
"audio/mpeg3": "mp3",
|
||||
"video/mp4": "mp4",
|
||||
"audio/flac": "flac",
|
||||
|
||||
"audio/wav": "wav",
|
||||
"audio/vnd.wav": "wav",
|
||||
"audio/vnd.wave": "wav",
|
||||
"audio/wave": "wav",
|
||||
"audio/x-pn-wav": "wav",
|
||||
"audio/x-wav": "wav",
|
||||
"image/jpeg": "jpg",
|
||||
"image/gif": "gif",
|
||||
"image/png": "png",
|
||||
"image/webp": "webp",
|
||||
"image/svg+xml": "svg",
|
||||
"image/x-icon": "ico",
|
||||
"application/ogg": "ogg",
|
||||
"video/webm": "webm",
|
||||
"audio/mp3": "mp3",
|
||||
"video/mp4": "mp4",
|
||||
}
|
||||
|
||||
var mapExt2Mime = map[string]string{
|
||||
".bin": "application/octet-stream",
|
||||
|
||||
".bin": "application/octet-stream",
|
||||
".jpg": "image/jpeg",
|
||||
".jpeg": "image/jpeg",
|
||||
".gif": "image/gif",
|
||||
@ -74,12 +61,8 @@ var mapExt2Mime = map[string]string{
|
||||
".webp": "image/webp",
|
||||
".svg": "image/svg+xml",
|
||||
".ico": "image/x-icon",
|
||||
|
||||
".ogg": "application/ogg",
|
||||
".webm": "video/webm",
|
||||
".mp3": "audio/mpeg",
|
||||
".mp3": "audio/mp3",
|
||||
".mp4": "video/mp4",
|
||||
".flac": "audio/flac",
|
||||
|
||||
"wav": "audio/wav",
|
||||
}
|
||||
122
misc/about.go
122
misc/about.go
@ -1,122 +0,0 @@
|
||||
package misc
|
||||
|
||||
import (
|
||||
"log/slog"
|
||||
"os"
|
||||
"strings"
|
||||
"text/template" // sic! TODO: make it html/template after the template library migration
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/version"
|
||||
"github.com/bouncepaw/mycorrhiza/l18n"
|
||||
)
|
||||
|
||||
type L10nEntry struct {
|
||||
_en string
|
||||
_ru string
|
||||
}
|
||||
|
||||
func En(v string) L10nEntry {
|
||||
return L10nEntry{_en: v}
|
||||
}
|
||||
|
||||
func (e L10nEntry) Ru(v string) L10nEntry {
|
||||
e._ru = v
|
||||
return e
|
||||
}
|
||||
|
||||
func (e L10nEntry) Get(lang string) string {
|
||||
if lang == "ru" && e._ru != "" {
|
||||
return e._ru
|
||||
}
|
||||
return e._en
|
||||
}
|
||||
|
||||
const aboutTemplateString = `
|
||||
<main class="main-width">
|
||||
<section class="about-page">
|
||||
<h1>{{ printf (get .L.Title) .Cfg.WikiName }}</h1>
|
||||
<dl>
|
||||
<dt>{{ get .L.Version }}</dt>
|
||||
<dd>{{ .Version }}</dd>
|
||||
{{ if .Cfg.UseAuth }}
|
||||
<dt>{{ get .L.HomeHypha }}</dt>
|
||||
<dd><a href="/">{{ .Cfg.HomeHypha }}</a></dd>
|
||||
|
||||
<dt>{{get .L.Auth}}</dt>
|
||||
<dd>{{ get .L.AuthOn }}</dd>
|
||||
{{if .Cfg.TelegramEnabled}}<dd>{{get .L.TelegramOn}}</dd>{{end}}
|
||||
|
||||
<dt>{{ get .L.UserCount }}</dt>
|
||||
<dd>{{ .UserCount }}</dd>
|
||||
{{if .Cfg.RegistrationLimit}}
|
||||
<dt>{{get .L.RegistrationLimit}}</dt>
|
||||
<dd>{{.RegistrationLimit}}</dd>
|
||||
{{end}}
|
||||
|
||||
<dt>{{ get .L.Admins }}</dt>
|
||||
{{$cfg := .Cfg}}{{ range $i, $username := .Admins }}
|
||||
<dd><a href="/hypha/{{ $cfg.UserHypha }}/{{ $username }}">{{ $username }}</a></dd>
|
||||
{{ end }}
|
||||
|
||||
{{ else }}
|
||||
<dt>{{get .L.Auth}}</dt>
|
||||
<dd>{{ get .L.AuthOff }}</dd>
|
||||
{{ end }}
|
||||
</dl>
|
||||
</section>
|
||||
</main>`
|
||||
|
||||
var aboutData = struct {
|
||||
L map[string]L10nEntry
|
||||
Version string
|
||||
Cfg map[string]interface{}
|
||||
Admins []string
|
||||
UserCount uint64
|
||||
RegistrationLimit uint64
|
||||
}{
|
||||
L: map[string]L10nEntry{
|
||||
"Title": En("About %s").Ru("О %s"),
|
||||
"Version": En("<a href=\"https://mycorrhiza.wiki\">Mycorrhiza Wiki</a> version").Ru("Версия <a href=\"https://mycorrhiza.wiki\">Микоризы</a>"),
|
||||
"UserCount": En("User count").Ru("Число пользователей"),
|
||||
"HomeHypha": En("Home hypha").Ru("Домашняя гифа"),
|
||||
"RegistrationLimit": En("RegistrationLimit").Ru("Максимум пользователей"),
|
||||
"Admins": En("Administrators").Ru("Администраторы"),
|
||||
|
||||
"Auth": En("Authentication").Ru("Аутентификация"),
|
||||
"AuthOn": En("Authentication is on").Ru("Аутентификация включена"),
|
||||
"AuthOff": En("Authentication is off").Ru("Аутентификация не включена"),
|
||||
"TelegramOn": En("Telegram authentication is on").Ru("Вход через Телеграм включён"),
|
||||
},
|
||||
}
|
||||
|
||||
func AboutHTML(lc *l18n.Localizer) string {
|
||||
get := func(e L10nEntry) string {
|
||||
return e.Get(lc.Locale)
|
||||
}
|
||||
temp, err := template.New("about wiki").Funcs(template.FuncMap{"get": get}).Parse(aboutTemplateString)
|
||||
if err != nil {
|
||||
slog.Error("Failed to parse About template", "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
data := aboutData
|
||||
data.Version = version.Short
|
||||
data.Admins = user.ListUsersWithGroup("admin")
|
||||
data.UserCount = user.Count()
|
||||
data.RegistrationLimit = cfg.RegistrationLimit
|
||||
data.Cfg = map[string]interface{}{
|
||||
"UseAuth": cfg.UseAuth,
|
||||
"WikiName": cfg.WikiName,
|
||||
"HomeHypha": cfg.HomeHypha,
|
||||
"TelegramEnabled": cfg.TelegramEnabled,
|
||||
"RegistrationLimit": cfg.RegistrationLimit,
|
||||
}
|
||||
var out strings.Builder
|
||||
err = temp.Execute(&out, data)
|
||||
if err != nil {
|
||||
slog.Error("Failed to execute About template", "err", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
return out.String()
|
||||
}
|
||||
186
misc/handlers.go
186
misc/handlers.go
@ -1,186 +0,0 @@
|
||||
// Package misc provides miscellaneous informative views.
|
||||
package misc
|
||||
|
||||
import (
|
||||
"io"
|
||||
"log/slog"
|
||||
"math/rand"
|
||||
"mime"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/gorilla/mux"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/backlinks"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/shroom"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/l18n"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
"github.com/bouncepaw/mycorrhiza/web/static"
|
||||
"github.com/bouncepaw/mycorrhiza/web/viewutil"
|
||||
)
|
||||
|
||||
func InitAssetHandlers(rtr *mux.Router) {
|
||||
rtr.HandleFunc("/static/style.css", handlerStyle)
|
||||
rtr.HandleFunc("/robots.txt", handlerRobotsTxt)
|
||||
rtr.PathPrefix("/static/").
|
||||
Handler(http.StripPrefix("/static/", http.FileServer(http.FS(static.FS))))
|
||||
rtr.HandleFunc("/favicon.ico", func(w http.ResponseWriter, rq *http.Request) {
|
||||
http.Redirect(w, rq, "/static/favicon.ico", http.StatusSeeOther)
|
||||
})
|
||||
}
|
||||
|
||||
func InitHandlers(rtr *mux.Router) {
|
||||
rtr.HandleFunc("/list", handlerList)
|
||||
rtr.HandleFunc("/reindex", handlerReindex)
|
||||
rtr.HandleFunc("/update-header-links", handlerUpdateHeaderLinks)
|
||||
rtr.HandleFunc("/random", handlerRandom)
|
||||
rtr.HandleFunc("/about", handlerAbout)
|
||||
rtr.HandleFunc("/title-search/", handlerTitleSearch)
|
||||
initViews()
|
||||
}
|
||||
|
||||
// handlerList shows a list of all hyphae in the wiki in random order.
|
||||
func handlerList(w http.ResponseWriter, rq *http.Request) {
|
||||
util.PrepareRq(rq)
|
||||
// TODO: make this more effective, there are too many loops and vars
|
||||
var (
|
||||
hyphaNames = make(chan string)
|
||||
sortedHypha = hyphae.PathographicSort(hyphaNames)
|
||||
entries []listDatum
|
||||
)
|
||||
for hypha := range hyphae.YieldExistingHyphae() {
|
||||
hyphaNames <- hypha.CanonicalName()
|
||||
}
|
||||
close(hyphaNames)
|
||||
for hyphaName := range sortedHypha {
|
||||
switch h := hyphae.ByName(hyphaName).(type) {
|
||||
case *hyphae.TextualHypha:
|
||||
entries = append(entries, listDatum{h.CanonicalName(), ""})
|
||||
case *hyphae.MediaHypha:
|
||||
entries = append(entries, listDatum{h.CanonicalName(), filepath.Ext(h.MediaFilePath())[1:]})
|
||||
}
|
||||
}
|
||||
viewList(viewutil.MetaFrom(w, rq), entries)
|
||||
}
|
||||
|
||||
// handlerReindex reindexes all hyphae by checking the wiki storage directory anew.
|
||||
func handlerReindex(w http.ResponseWriter, rq *http.Request) {
|
||||
util.PrepareRq(rq)
|
||||
if ok := user.CanProceed(rq, "reindex"); !ok {
|
||||
var lc = l18n.FromRequest(rq)
|
||||
viewutil.HttpErr(viewutil.MetaFrom(w, rq), http.StatusForbidden, cfg.HomeHypha, lc.Get("ui.reindex_no_rights"))
|
||||
slog.Info("No rights to reindex")
|
||||
return
|
||||
}
|
||||
hyphae.ResetCount()
|
||||
slog.Info("Reindexing hyphae", "hyphaeDir", files.HyphaeDir())
|
||||
hyphae.Index(files.HyphaeDir())
|
||||
backlinks.IndexBacklinks()
|
||||
http.Redirect(w, rq, "/", http.StatusSeeOther)
|
||||
}
|
||||
|
||||
// handlerUpdateHeaderLinks updates header links by reading the configured hypha, if there is any, or resorting to default values.
|
||||
func handlerUpdateHeaderLinks(w http.ResponseWriter, rq *http.Request) {
|
||||
util.PrepareRq(rq)
|
||||
if ok := user.CanProceed(rq, "update-header-links"); !ok {
|
||||
var lc = l18n.FromRequest(rq)
|
||||
viewutil.HttpErr(viewutil.MetaFrom(w, rq), http.StatusForbidden, cfg.HomeHypha, lc.Get("ui.header_no_rights"))
|
||||
slog.Info("No rights to update header links")
|
||||
return
|
||||
}
|
||||
slog.Info("Updated header links")
|
||||
shroom.SetHeaderLinks()
|
||||
http.Redirect(w, rq, "/", http.StatusSeeOther)
|
||||
}
|
||||
|
||||
// handlerRandom redirects to a random hypha.
|
||||
func handlerRandom(w http.ResponseWriter, rq *http.Request) {
|
||||
util.PrepareRq(rq)
|
||||
var (
|
||||
randomHyphaName string
|
||||
amountOfHyphae = hyphae.Count()
|
||||
)
|
||||
if amountOfHyphae == 0 {
|
||||
var lc = l18n.FromRequest(rq)
|
||||
viewutil.HttpErr(viewutil.MetaFrom(w, rq), http.StatusNotFound, cfg.HomeHypha, lc.Get("ui.random_no_hyphae_tip"))
|
||||
return
|
||||
}
|
||||
i := rand.Intn(amountOfHyphae)
|
||||
for h := range hyphae.YieldExistingHyphae() {
|
||||
if i == 0 {
|
||||
randomHyphaName = h.CanonicalName()
|
||||
}
|
||||
i--
|
||||
}
|
||||
http.Redirect(w, rq, "/hypha/"+randomHyphaName, http.StatusSeeOther)
|
||||
}
|
||||
|
||||
// handlerAbout shows a summary of wiki's software.
|
||||
func handlerAbout(w http.ResponseWriter, rq *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/html;charset=utf-8")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
var (
|
||||
lc = l18n.FromRequest(rq)
|
||||
title = lc.Get("ui.about_title", &l18n.Replacements{"name": cfg.WikiName})
|
||||
)
|
||||
_, err := io.WriteString(w, viewutil.Base(
|
||||
viewutil.MetaFrom(w, rq),
|
||||
title,
|
||||
AboutHTML(lc),
|
||||
map[string]string{},
|
||||
))
|
||||
if err != nil {
|
||||
slog.Error("Failed to write About template", "err", err)
|
||||
}
|
||||
}
|
||||
|
||||
var stylesheets = []string{"default.css", "custom.css"}
|
||||
|
||||
func handlerStyle(w http.ResponseWriter, rq *http.Request) {
|
||||
w.Header().Set("Content-Type", mime.TypeByExtension(".css"))
|
||||
for _, name := range stylesheets {
|
||||
file, err := static.FS.Open(name)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
_, err = io.Copy(w, file)
|
||||
if err != nil {
|
||||
slog.Error("Failed to write stylesheet; proceeding anyway", "err", err)
|
||||
}
|
||||
_ = file.Close()
|
||||
}
|
||||
}
|
||||
|
||||
func handlerRobotsTxt(w http.ResponseWriter, rq *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/plain; charset=utf-8")
|
||||
|
||||
file, err := static.FS.Open("robots.txt")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
_, err = io.Copy(w, file)
|
||||
if err != nil {
|
||||
slog.Error("Failed to write robots.txt; proceeding anyway", "err", err)
|
||||
}
|
||||
_ = file.Close()
|
||||
}
|
||||
|
||||
func handlerTitleSearch(w http.ResponseWriter, rq *http.Request) {
|
||||
util.PrepareRq(rq)
|
||||
_ = rq.ParseForm()
|
||||
var (
|
||||
query = rq.FormValue("q")
|
||||
hyphaName = util.CanonicalName(query)
|
||||
_, nameFree = hyphae.AreFreeNames(hyphaName)
|
||||
results []string
|
||||
)
|
||||
for hyphaName := range shroom.YieldHyphaNamesContainingString(query) {
|
||||
results = append(results, hyphaName)
|
||||
}
|
||||
w.WriteHeader(http.StatusOK)
|
||||
viewTitleSearch(viewutil.MetaFrom(w, rq), query, hyphaName, !nameFree, results)
|
||||
}
|
||||
@ -1,16 +0,0 @@
|
||||
{{define "list of hyphae"}}List of hyphae{{end}}
|
||||
{{define "title"}}{{template "list of hyphae"}}{{end}}
|
||||
{{define "body"}}
|
||||
<main class="main-width">
|
||||
<h1>{{template "list of hyphae"}}</h1>
|
||||
<p>{{block "x total" .HyphaCount}}{{.}} total.{{end}}</p>
|
||||
<ol>
|
||||
{{range .Entries}}
|
||||
<li>
|
||||
<a href="/hypha/{{.Name}}">{{beautifulName .Name}}</a>
|
||||
{{if .Ext}}<span class="media-type-badge">{{.Ext}}</span>{{end}}
|
||||
</li>
|
||||
{{end}}
|
||||
</ol>
|
||||
</main>
|
||||
{{end}}
|
||||
@ -1,21 +0,0 @@
|
||||
{{define "search:"}}Search: {{.}}{{end}}
|
||||
{{define "title"}}{{template "search:" .Query}}{{end}}
|
||||
{{define "body"}}
|
||||
<main class="main-width">
|
||||
<h1>{{block "search results for" .Query}}Search results for ‘{{.}}’{{end}}</h1>
|
||||
{{if .MatchedHyphaName}}
|
||||
<p>{{block "go to hypha" .}}Go to hypha <a class="wikilink{{if .HasExactMatch | not}} wikilink_new{{end}}" href="/hypha/{{.MatchedHyphaName}}">{{beautifulName .MatchedHyphaName}}</a>.{{end}}</p>
|
||||
{{end}}
|
||||
{{if len .Results}}
|
||||
<ol>
|
||||
{{range .Results}}
|
||||
<li>
|
||||
<a class="wikilink" href="/hypha/{{.}}">{{beautifulName .}}</a>
|
||||
</li>
|
||||
{{end}}
|
||||
</ol>
|
||||
{{else}}
|
||||
<p>{{block "search no results" .}}No results{{end}}</p>
|
||||
{{end}}
|
||||
</main>
|
||||
{{end}}
|
||||
@ -1,64 +0,0 @@
|
||||
package misc
|
||||
|
||||
import (
|
||||
"embed"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/web/viewutil"
|
||||
)
|
||||
|
||||
var (
|
||||
//go:embed *html
|
||||
fs embed.FS
|
||||
chainList, chainTitleSearch viewutil.Chain
|
||||
ruTranslation = `
|
||||
{{define "list of hyphae"}}Список гиф{{end}}
|
||||
{{define "search:"}}Поиск: {{.}}{{end}}
|
||||
{{define "search results for"}}Результаты поиска для «{{.}}»{{end}}
|
||||
{{define "search no results"}}Ничего не найдено.{{end}}
|
||||
{{define "x total"}}{{.}} всего.{{end}}
|
||||
{{define "go to hypha"}}Перейти к гифе <a class="wikilink{{if .HasExactMatch | not}} wikilink_new{{end}}" href="/hypha/{{.MatchedHyphaName}}">{{beautifulName .MatchedHyphaName}}</a>.{{end}}
|
||||
`
|
||||
)
|
||||
|
||||
func initViews() {
|
||||
chainList = viewutil.CopyEnRuWith(fs, "view_list.html", ruTranslation)
|
||||
chainTitleSearch = viewutil.CopyEnRuWith(fs, "view_title_search.html", ruTranslation)
|
||||
}
|
||||
|
||||
type listDatum struct {
|
||||
Name string
|
||||
Ext string
|
||||
}
|
||||
|
||||
type listData struct {
|
||||
*viewutil.BaseData
|
||||
Entries []listDatum
|
||||
HyphaCount int
|
||||
}
|
||||
|
||||
func viewList(meta viewutil.Meta, entries []listDatum) {
|
||||
viewutil.ExecutePage(meta, chainList, listData{
|
||||
BaseData: &viewutil.BaseData{},
|
||||
Entries: entries,
|
||||
HyphaCount: hyphae.Count(),
|
||||
})
|
||||
}
|
||||
|
||||
type titleSearchData struct {
|
||||
*viewutil.BaseData
|
||||
Query string
|
||||
Results []string
|
||||
MatchedHyphaName string
|
||||
HasExactMatch bool
|
||||
}
|
||||
|
||||
func viewTitleSearch(meta viewutil.Meta, query string, hyphaName string, hasExactMatch bool, results []string) {
|
||||
viewutil.ExecutePage(meta, chainTitleSearch, titleSearchData{
|
||||
BaseData: &viewutil.BaseData{},
|
||||
Query: query,
|
||||
Results: results,
|
||||
MatchedHyphaName: hyphaName,
|
||||
HasExactMatch: hasExactMatch,
|
||||
})
|
||||
}
|
||||
@ -1,115 +0,0 @@
|
||||
package mycoopts
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"html"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/interwiki"
|
||||
"github.com/bouncepaw/mycorrhiza/l18n"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
|
||||
"git.sr.ht/~bouncepaw/mycomarkup/v5/options"
|
||||
)
|
||||
|
||||
func MarkupOptions(hyphaName string) options.Options {
|
||||
return options.Options{
|
||||
HyphaName: hyphaName,
|
||||
WebSiteURL: cfg.URL,
|
||||
TransclusionSupported: true,
|
||||
RedLinksSupported: true,
|
||||
InterwikiSupported: true,
|
||||
HyphaExists: func(hyphaName string) bool {
|
||||
switch hyphae.ByName(hyphaName).(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
return false
|
||||
default:
|
||||
return true
|
||||
}
|
||||
},
|
||||
IterateHyphaNamesWith: func(λ func(string)) {
|
||||
for h := range hyphae.YieldExistingHyphae() {
|
||||
λ(h.CanonicalName())
|
||||
}
|
||||
},
|
||||
HyphaHTMLData: func(hyphaName string) (rawText, binaryBlock string, err error) {
|
||||
switch h := hyphae.ByName(hyphaName).(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
err = errors.New("Hypha " + hyphaName + " does not exist")
|
||||
case *hyphae.TextualHypha:
|
||||
rawText, err = hyphae.FetchMycomarkupFile(h)
|
||||
case *hyphae.MediaHypha:
|
||||
rawText, err = hyphae.FetchMycomarkupFile(h)
|
||||
binaryBlock = mediaRaw(h)
|
||||
}
|
||||
return
|
||||
},
|
||||
LocalTargetCanonicalName: util.CanonicalName,
|
||||
LocalLinkHref: func(hyphaName string) string {
|
||||
return "/hypha/" + util.CanonicalName(hyphaName)
|
||||
},
|
||||
LocalImgSrc: func(hyphaName string) string {
|
||||
return "/binary/" + util.CanonicalName(hyphaName)
|
||||
},
|
||||
LinkHrefFormatForInterwikiPrefix: interwiki.HrefLinkFormatFor,
|
||||
ImgSrcFormatForInterwikiPrefix: interwiki.ImgSrcFormatFor,
|
||||
}.FillTheRest()
|
||||
}
|
||||
|
||||
func mediaRaw(h *hyphae.MediaHypha) string {
|
||||
return Media(h, l18n.New("en", "en"))
|
||||
}
|
||||
|
||||
func Media(h *hyphae.MediaHypha, lc *l18n.Localizer) string {
|
||||
name := html.EscapeString(h.CanonicalName())
|
||||
|
||||
switch filepath.Ext(h.MediaFilePath()) {
|
||||
case ".jpg", ".gif", ".png", ".webp", ".svg", ".ico":
|
||||
return fmt.Sprintf(
|
||||
`<div class="binary-container binary-container_with-img">
|
||||
<a href="/binary/%s"><img src="/binary/%s"/></a>
|
||||
</div>`,
|
||||
name, name,
|
||||
)
|
||||
|
||||
case ".ogg", ".webm", ".mp4":
|
||||
return fmt.Sprintf(
|
||||
`<div class="binary-container binary-container_with-video">
|
||||
<video controls>
|
||||
<source src="/binary/%s"/>
|
||||
<p>%s <a href="/binary/%s">%s</a></p>
|
||||
</video>
|
||||
</div>`,
|
||||
name,
|
||||
html.EscapeString(lc.Get("ui.media_novideo")),
|
||||
name,
|
||||
html.EscapeString(lc.Get("ui.media_novideo_link")),
|
||||
)
|
||||
|
||||
case ".mp3", ".wav", ".flac":
|
||||
return fmt.Sprintf(
|
||||
`<div class="binary-container binary-container_with-audio">
|
||||
<audio controls>
|
||||
<source src="/binary/%s"/>
|
||||
<p>%s <a href="/binary/%s">%s</a></p>
|
||||
</audio>
|
||||
</div>`,
|
||||
name,
|
||||
html.EscapeString(lc.Get("ui.media_noaudio")),
|
||||
name,
|
||||
html.EscapeString(lc.Get("ui.media_noaudio_link")),
|
||||
)
|
||||
|
||||
default:
|
||||
return fmt.Sprintf(
|
||||
`<div class="binary-container binary-container_with-nothing">
|
||||
<p><a href="/binary/%s">%s</a></p>
|
||||
</div>`,
|
||||
name,
|
||||
html.EscapeString(lc.Get("ui.media_download")),
|
||||
)
|
||||
}
|
||||
}
|
||||
@ -3,9 +3,9 @@ package shroom
|
||||
import (
|
||||
"errors"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/l18n"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
)
|
||||
|
||||
// TODO: get rid of this abomination
|
||||
@ -2,12 +2,11 @@ package shroom
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae/backlinks"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/backlinks"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/categories"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
)
|
||||
|
||||
// Delete deletes the hypha and makes a history record about that.
|
||||
@ -17,14 +16,10 @@ func Delete(u *user.User, h hyphae.ExistingHypha) error {
|
||||
WithMsg(fmt.Sprintf("Delete ‘%s’", h.CanonicalName())).
|
||||
WithUser(u)
|
||||
|
||||
originalText, _ := hyphae.FetchMycomarkupFile(h)
|
||||
originalText, _ := FetchTextFile(h)
|
||||
switch h := h.(type) {
|
||||
case *hyphae.MediaHypha:
|
||||
if h.HasTextFile() {
|
||||
hop.WithFilesRemoved(h.MediaFilePath(), h.TextFilePath())
|
||||
} else {
|
||||
hop.WithFilesRemoved(h.MediaFilePath())
|
||||
}
|
||||
hop.WithFilesRemoved(h.MediaFilePath(), h.TextFilePath())
|
||||
case *hyphae.TextualHypha:
|
||||
hop.WithFilesRemoved(h.TextFilePath())
|
||||
}
|
||||
@ -32,7 +27,6 @@ func Delete(u *user.User, h hyphae.ExistingHypha) error {
|
||||
return hop.Errs[0]
|
||||
}
|
||||
backlinks.UpdateBacklinksAfterDelete(h, originalText)
|
||||
categories.RemoveHyphaFromAllCategories(h.CanonicalName())
|
||||
hyphae.DeleteHypha(h)
|
||||
return nil
|
||||
}
|
||||
24
shroom/log.go
Normal file
24
shroom/log.go
Normal file
@ -0,0 +1,24 @@
|
||||
package shroom
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
)
|
||||
|
||||
func rejectDeleteLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
log.Printf("Reject delete ‘%s’ by @%s: %s\n", h.CanonicalName(), u.Name, errmsg)
|
||||
}
|
||||
func rejectRenameLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
log.Printf("Reject rename ‘%s’ by @%s: %s\n", h.CanonicalName(), u.Name, errmsg)
|
||||
}
|
||||
func rejectRemoveMediaLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
log.Printf("Reject remove media ‘%s’ by @%s: %s\n", h.CanonicalName(), u.Name, errmsg)
|
||||
}
|
||||
func rejectEditLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
log.Printf("Reject edit ‘%s’ by @%s: %s\n", h.CanonicalName(), u.Name, errmsg)
|
||||
}
|
||||
func rejectUploadMediaLog(h hyphae.Hypha, u *user.User, errmsg string) {
|
||||
log.Printf("Reject upload media ‘%s’ by @%s: %s\n", h.CanonicalName(), u.Name, errmsg)
|
||||
}
|
||||
@ -3,24 +3,17 @@ package shroom
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"path"
|
||||
"path/filepath"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae/backlinks"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/backlinks"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/categories"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
)
|
||||
|
||||
// Rename renames the old hypha to the new name and makes a history record about that. Call if and only if the user has the permission to rename.
|
||||
func Rename(oldHypha hyphae.ExistingHypha, newName string, recursive bool, leaveRedirections bool, u *user.User) error {
|
||||
// * bouncepaw hates this function and related renaming functions
|
||||
func Rename(oldHypha hyphae.ExistingHypha, newName string, recursive bool, u *user.User) error {
|
||||
if newName == "" {
|
||||
rejectRenameLog(oldHypha, u, "no new name given")
|
||||
return errors.New("ui.rename_noname_tip")
|
||||
@ -43,10 +36,7 @@ func Rename(oldHypha hyphae.ExistingHypha, newName string, recursive bool, leave
|
||||
var (
|
||||
re = regexp.MustCompile(`(?i)` + oldHypha.CanonicalName())
|
||||
replaceName = func(str string) string {
|
||||
namepart := strings.TrimPrefix(str, files.HyphaeDir())
|
||||
// Can we drop that util.CanonicalName?:
|
||||
replaced := re.ReplaceAllString(util.CanonicalName(namepart), newName)
|
||||
return path.Join(files.HyphaeDir(), replaced)
|
||||
return re.ReplaceAllString(util.CanonicalName(str), newName)
|
||||
}
|
||||
hyphaeToRename = findHyphaeToRename(oldHypha, recursive)
|
||||
renameMap, err = renamingPairs(hyphaeToRename, replaceName)
|
||||
@ -70,54 +60,21 @@ func Rename(oldHypha hyphae.ExistingHypha, newName string, recursive bool, leave
|
||||
newName))
|
||||
}
|
||||
|
||||
hop.WithFilesRenamed(renameMap)
|
||||
hop.WithFilesRenamed(renameMap).Apply()
|
||||
|
||||
if len(hop.Errs) != 0 {
|
||||
return hop.Errs[0]
|
||||
}
|
||||
|
||||
for _, h := range hyphaeToRename {
|
||||
var (
|
||||
oldName = h.CanonicalName()
|
||||
newName = re.ReplaceAllString(oldName, newName)
|
||||
)
|
||||
hyphae.RenameHyphaTo(h, newName, replaceName)
|
||||
oldName := h.CanonicalName()
|
||||
hyphae.RenameHyphaTo(h, replaceName(h.CanonicalName()), replaceName)
|
||||
backlinks.UpdateBacklinksAfterRename(h, oldName)
|
||||
categories.RenameHyphaInAllCategories(oldName, newName)
|
||||
if leaveRedirections {
|
||||
if err := leaveRedirection(oldName, newName, hop); err != nil {
|
||||
hop.WithErrAbort(err)
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
hop.Apply()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
const redirectionTemplate = `=> %[1]s | 👁️➡️ %[2]s
|
||||
<= %[1]s | full
|
||||
`
|
||||
|
||||
func leaveRedirection(oldName, newName string, hop *history.Op) error {
|
||||
var (
|
||||
text = fmt.Sprintf(redirectionTemplate, newName, util.BeautifulName(newName))
|
||||
emptyHypha = hyphae.ByName(oldName)
|
||||
)
|
||||
switch emptyHypha := emptyHypha.(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
h := hyphae.ExtendEmptyToTextual(emptyHypha, filepath.Join(files.HyphaeDir(), oldName+".myco"))
|
||||
hyphae.Insert(h)
|
||||
categories.AddHyphaToCategory(oldName, cfg.RedirectionCategory)
|
||||
defer backlinks.UpdateBacklinksAfterEdit(h, "")
|
||||
return writeTextToDisk(h, []byte(text), hop)
|
||||
default:
|
||||
return errors.New("invalid state for hypha " + oldName + " renamed to " + newName)
|
||||
}
|
||||
}
|
||||
|
||||
func findHyphaeToRename(superhypha hyphae.ExistingHypha, recursive bool) []hyphae.ExistingHypha {
|
||||
hyphaList := []hyphae.ExistingHypha{superhypha}
|
||||
if recursive {
|
||||
@ -3,11 +3,11 @@ package shroom
|
||||
import (
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/util"
|
||||
)
|
||||
|
||||
// YieldHyphaNamesContainingString picks hyphae with have a string in their title, sorts and iterates over them in alphabetical order.
|
||||
// YieldHyphaNamesContainingString picks hyphae with have a string in their title, sorts and iterates over them.
|
||||
func YieldHyphaNamesContainingString(query string) <-chan string {
|
||||
query = util.CanonicalName(strings.TrimSpace(query))
|
||||
out := make(chan string)
|
||||
42
shroom/shroom.go
Normal file
42
shroom/shroom.go
Normal file
@ -0,0 +1,42 @@
|
||||
// Package shroom provides utilities for hypha manipulation.
|
||||
//
|
||||
// Some of them are wrappers around functions provided by package hyphae. They manage history for you.
|
||||
package shroom
|
||||
|
||||
import (
|
||||
"errors"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/views"
|
||||
|
||||
"github.com/bouncepaw/mycomarkup/v3/globals"
|
||||
)
|
||||
|
||||
func init() {
|
||||
// TODO: clean this complete and utter mess
|
||||
globals.HyphaExists = func(hyphaName string) bool {
|
||||
switch hyphae.ByName(hyphaName).(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
return false
|
||||
default:
|
||||
return true
|
||||
}
|
||||
}
|
||||
globals.HyphaAccess = func(hyphaName string) (rawText, binaryBlock string, err error) {
|
||||
switch h := hyphae.ByName(hyphaName).(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
err = errors.New("Hypha " + hyphaName + " does not exist")
|
||||
case *hyphae.TextualHypha:
|
||||
rawText, err = FetchTextFile(h)
|
||||
case *hyphae.MediaHypha:
|
||||
rawText, err = FetchTextFile(h)
|
||||
binaryBlock = views.MediaRaw(h)
|
||||
}
|
||||
return
|
||||
}
|
||||
globals.HyphaIterate = func(λ func(string)) {
|
||||
for h := range hyphae.YieldExistingHyphae() {
|
||||
λ(h.CanonicalName())
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -4,8 +4,8 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
)
|
||||
|
||||
// RemoveMedia removes media from the media hypha and makes a history record about that. If it only had media, the hypha will be deleted. If it also had text, the hypha will become textual.
|
||||
@ -4,19 +4,17 @@ import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"fmt"
|
||||
"github.com/bouncepaw/mycorrhiza/files"
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae/backlinks"
|
||||
"github.com/bouncepaw/mycorrhiza/mimetype"
|
||||
"github.com/bouncepaw/mycorrhiza/user"
|
||||
"io"
|
||||
"log/slog"
|
||||
"log"
|
||||
"mime/multipart"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/history"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/backlinks"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/files"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/hyphae"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/mimetype"
|
||||
"github.com/bouncepaw/mycorrhiza/internal/user"
|
||||
)
|
||||
|
||||
func historyMessageForTextUpload(h hyphae.Hypha, userMessage string) string {
|
||||
@ -64,25 +62,24 @@ func UploadText(h hyphae.Hypha, data []byte, userMessage string, u *user.User) e
|
||||
return errors.New("invalid hypha name")
|
||||
}
|
||||
|
||||
oldText, err := hyphae.FetchMycomarkupFile(h)
|
||||
if err != nil {
|
||||
hop.Abort()
|
||||
return err
|
||||
}
|
||||
|
||||
// Empty data check
|
||||
if len(bytes.TrimSpace(data)) == 0 && len(oldText) == 0 { // if nothing but whitespace
|
||||
hop.Abort()
|
||||
return nil
|
||||
if len(bytes.TrimSpace(data)) == 0 { // if nothing but whitespace
|
||||
switch h.(type) {
|
||||
case *hyphae.EmptyHypha, *hyphae.MediaHypha:
|
||||
// Writing no description, it's ok, just like cancel button.
|
||||
hop.Abort()
|
||||
return nil
|
||||
case *hyphae.TextualHypha:
|
||||
// What do you want passing nothing for a textual hypha?
|
||||
return errors.New("No data passed")
|
||||
}
|
||||
}
|
||||
|
||||
// At this point, we have a savable user-generated Mycomarkup document. Gotta save it.
|
||||
|
||||
switch h := h.(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
parts := []string{files.HyphaeDir()}
|
||||
parts = append(parts, strings.Split(h.CanonicalName()+".myco", "\\")...)
|
||||
H := hyphae.ExtendEmptyToTextual(h, filepath.Join(parts...))
|
||||
H := hyphae.ExtendEmptyToTextual(h, filepath.Join(files.HyphaeDir(), h.CanonicalName()+".myco"))
|
||||
|
||||
err := writeTextToDisk(H, data, hop)
|
||||
if err != nil {
|
||||
@ -93,8 +90,14 @@ func UploadText(h hyphae.Hypha, data []byte, userMessage string, u *user.User) e
|
||||
hyphae.Insert(H)
|
||||
backlinks.UpdateBacklinksAfterEdit(H, "")
|
||||
case *hyphae.MediaHypha:
|
||||
oldText, err := FetchTextFile(h)
|
||||
if err != nil {
|
||||
hop.Abort()
|
||||
return err
|
||||
}
|
||||
|
||||
// TODO: that []byte(...) part should be removed
|
||||
if bytes.Equal(data, []byte(oldText)) {
|
||||
if bytes.Compare(data, []byte(oldText)) == 0 {
|
||||
// No changes! Just like cancel button
|
||||
hop.Abort()
|
||||
return nil
|
||||
@ -108,14 +111,14 @@ func UploadText(h hyphae.Hypha, data []byte, userMessage string, u *user.User) e
|
||||
|
||||
backlinks.UpdateBacklinksAfterEdit(h, oldText)
|
||||
case *hyphae.TextualHypha:
|
||||
oldText, err := hyphae.FetchMycomarkupFile(h)
|
||||
oldText, err := FetchTextFile(h)
|
||||
if err != nil {
|
||||
hop.Abort()
|
||||
return err
|
||||
}
|
||||
|
||||
// TODO: that []byte(...) part should be removed
|
||||
if bytes.Equal(data, []byte(oldText)) {
|
||||
if bytes.Compare(data, []byte(oldText)) == 0 {
|
||||
// No changes! Just like cancel button
|
||||
hop.Abort()
|
||||
return nil
|
||||
@ -143,8 +146,7 @@ func writeMediaToDisk(h hyphae.Hypha, mime string, data []byte) (string, error)
|
||||
var (
|
||||
ext = mimetype.ToExtension(mime)
|
||||
// That's where the file will go
|
||||
|
||||
uploadedFilePath = filepath.Join(append([]string{files.HyphaeDir()}, strings.Split(h.CanonicalName()+ext, "\\")...)...)
|
||||
uploadedFilePath = filepath.Join(files.HyphaeDir(), h.CanonicalName()+ext)
|
||||
)
|
||||
|
||||
if err := os.MkdirAll(filepath.Dir(uploadedFilePath), 0777); err != nil {
|
||||
@ -201,7 +203,7 @@ func UploadBinary(h hyphae.Hypha, mime string, file multipart.File, u *user.User
|
||||
if err := history.Rename(prevFilePath, uploadedFilePath); err != nil {
|
||||
return err
|
||||
}
|
||||
slog.Info("Move file", "from", prevFilePath, "to", uploadedFilePath)
|
||||
log.Printf("Move ‘%s’ to ‘%s’\n", prevFilePath, uploadedFilePath)
|
||||
h.SetMediaFilePath(uploadedFilePath)
|
||||
}
|
||||
}
|
||||
53
shroom/view.go
Normal file
53
shroom/view.go
Normal file
@ -0,0 +1,53 @@
|
||||
package shroom
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"os"
|
||||
|
||||
"github.com/bouncepaw/mycorrhiza/cfg"
|
||||
"github.com/bouncepaw/mycorrhiza/hyphae"
|
||||
)
|
||||
|
||||
// FetchTextFile tries to read text file of the given hypha. If there is no file, empty string is returned.
|
||||
func FetchTextFile(h hyphae.Hypha) (string, error) {
|
||||
switch h := h.(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
return "", errors.New("empty hyphae have no text")
|
||||
case *hyphae.MediaHypha:
|
||||
if !h.HasTextFile() {
|
||||
return "", nil
|
||||
}
|
||||
text, err := os.ReadFile(h.TextFilePath())
|
||||
if os.IsNotExist(err) {
|
||||
return "", nil
|
||||
} else if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return string(text), nil
|
||||
case *hyphae.TextualHypha:
|
||||
text, err := os.ReadFile(h.TextFilePath())
|
||||
if os.IsNotExist(err) {
|
||||
return "", nil
|
||||
} else if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return string(text), nil
|
||||
}
|
||||
panic("unreachable")
|
||||
}
|
||||
|
||||
// SetHeaderLinks initializes header links by reading the configured hypha, if there is any, or resorting to default values.
|
||||
func SetHeaderLinks() {
|
||||
switch userLinksHypha := hyphae.ByName(cfg.HeaderLinksHypha).(type) {
|
||||
case *hyphae.EmptyHypha:
|
||||
cfg.SetDefaultHeaderLinks()
|
||||
case hyphae.ExistingHypha:
|
||||
contents, err := os.ReadFile(userLinksHypha.TextFilePath())
|
||||
if err != nil || len(contents) == 0 {
|
||||
cfg.SetDefaultHeaderLinks()
|
||||
} else {
|
||||
text := string(contents)
|
||||
cfg.ParseHeaderLinks(text)
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -14,20 +14,22 @@
|
||||
.modal__title_small { font-size: 1.5rem; }
|
||||
.modal__confirmation-msg { margin: 0 0 .5rem 0; }
|
||||
|
||||
ol:not(.mycomarkup-doc ol) a { text-decoration: none; display: inline-block; padding: .25rem; }
|
||||
ol:not(.mycomarkup-doc ol) a:hover { text-decoration: underline; }
|
||||
.media-type-badge { font-size: smaller; color: #999; }
|
||||
.hypha-list, .title-search__results, .backlinks__list, .category-list__entries, .category__entries { padding-left: 0; }
|
||||
.hypha-list__entry, .title-search__entry, .backlinks__entry, .category-list__entry, .category__entry { list-style-type: none; }
|
||||
.hypha-list__link, .title-search__link, .backlinks__link, .category-list__link, .category__link { text-decoration: none; display: inline-block; padding: .25rem; }
|
||||
.hypha-list__link:hover, .title-search__link:hover, .backlinks__link:hover, .category-list__link:hover, .category__link:hover { text-decoration: underline; }
|
||||
.hypha-list__amnt-type { font-size: smaller; color: #999; }
|
||||
|
||||
/* General element positions, from small to big */
|
||||
/* Phones and whatnot */
|
||||
body { display: grid; row-gap: .5rem; }
|
||||
header { width: 100%; }
|
||||
.layout { display: grid; row-gap: 1rem; }
|
||||
header { width: 100%; margin-bottom: 1rem; }
|
||||
|
||||
.layout-card li { list-style-type: none; }
|
||||
|
||||
@media screen and (max-width: 800px) {
|
||||
.amnt-grid { grid-template-columns: 1fr; }
|
||||
body { grid-template-columns: auto; grid-template-rows: auto auto auto; }
|
||||
.layout { grid-template-columns: auto; grid-template-rows: auto auto auto; }
|
||||
.main-width { width: 100%; }
|
||||
main { padding: .5rem 1rem 1rem 1rem; }
|
||||
}
|
||||
@ -55,13 +57,13 @@ header { width: 100%; }
|
||||
|
||||
/* Wide enough to fit two columns ok */
|
||||
@media screen and (min-width: 1100px) {
|
||||
body { display: grid; grid-template-columns: auto 1fr; column-gap: 1rem; margin: 0 1rem; row-gap: .5rem; }
|
||||
header { grid-column: 1 / span 2; grid-row: 1 / span 1; margin: 0; }
|
||||
main { grid-column: 1 / span 1; grid-row: 2 / span 2; }
|
||||
main.main-width { margin-left: .5rem; }
|
||||
.markup-toolbar, .help-topics, .categories-card { grid-column: 2 / span 1; grid-row: 2 / span 1; }
|
||||
.action-toolbar { grid-column: 2 / span 1; grid-row: 3 / span 1; }
|
||||
.layout-card { width: 100%; margin-left: -.5rem; }
|
||||
.layout { display: grid; grid-template-columns: auto 1fr; column-gap: 1rem; margin: 0 1rem; row-gap: 1rem; }
|
||||
.main-width { margin: 0; }
|
||||
main { grid-column: 1 / span 1; grid-row: 1 / span 2; }
|
||||
.markup-toolbar, .help-topics, .categories-card { grid-column: 2 / span 1; grid-row: 1 / span 1; }
|
||||
.sibling-hyphae { grid-column: 2 / span 1; grid-row: 2 / span 1; }
|
||||
.action-toolbar { grid-column: 2 / span 1; grid-row: 2 / span 1; }
|
||||
.layout-card { width: 100%; }
|
||||
.edit-toolbar__buttons {display: grid; }
|
||||
}
|
||||
|
||||
@ -69,15 +71,14 @@ header { width: 100%; }
|
||||
.edit-toolbar__buttons { grid-template-columns: 1fr 1fr; grid-column-gap: .125rem; }
|
||||
}
|
||||
|
||||
@media screen and (min-width: 1200px) {
|
||||
body { grid-template-columns: minmax(0, 1fr) auto minmax(0, 1fr); }
|
||||
header { grid-column: 1 / span 3; grid-row: 1 / span 1; margin: 0; }
|
||||
@media screen and (min-width: 1250px) {
|
||||
.layout { grid-template-columns: minmax(0, 1fr) auto minmax(0, 1fr); }
|
||||
.layout-card {max-width: 18rem;}
|
||||
.main-width { margin: 0 auto; }
|
||||
main.main-width { grid-column: 2 / span 1; grid-row: 2 / span 3; margin: 0; }
|
||||
.markup-toolbar, .help-topics { grid-column: 3 / span 1; margin-left: -.5rem; grid-row: 2 / span 2; }
|
||||
.markup-toolbar { grid-column: 3 / span 1; grid-row: 2 / span 2; margin-left: -.5rem; }
|
||||
.action-toolbar, .categories-card { grid-column: 1 / span 1; grid-row: 2 / span 1; margin: 0 -.5rem 0 .5rem; justify-self: end; }
|
||||
main { grid-column: 2 / span 1; grid-row: 1 / span 3; }
|
||||
.sibling-hyphae, .markup-toolbar, .help-topics { grid-column: 3 / span 1; margin-left: 0; grid-row: 1 / span 2; }
|
||||
.markup-toolbar { grid-column: 3 / span 1; grid-row: 1 / span 2; }
|
||||
.action-toolbar, .categories-card { grid-column: 1 / span 1; grid-row: 1 / span 1; }
|
||||
.edit-toolbar__buttons { grid-template-columns: 1fr; }
|
||||
}
|
||||
|
||||
@ -91,26 +92,31 @@ body { margin: 0; font-size:16px; font-family: sans-serif; color: black; }
|
||||
input, kbd { font: inherit; color: inherit; }
|
||||
textarea {font-size:16px; font-family: inherit; line-height: 150%; }
|
||||
|
||||
.edit_no-preview { height: 90vh; }
|
||||
.edit_with-preview .edit-form { height: 90vh; }
|
||||
.edit { min-height: 80vh; }
|
||||
.edit__title { margin-top: 0; }
|
||||
.edit__preview { border: 2px dashed #ddd; padding: 10px; margin: 0 -10px; }
|
||||
.edit-form__textarea { width: 100%; height: 80vh; min-height: 4rem; }
|
||||
.edit-form p { margin: .25rem 0; }
|
||||
.edit__preview { border: 2px dashed #ddd; padding: 10px; }
|
||||
.edit-form__textarea { width: 100%; height: calc(100% - 8rem); min-height: 4rem; }
|
||||
.edit-form__message { width: 100%; margin: 0.25em 0; }
|
||||
.edit-form__save { font-weight: bold; }
|
||||
.edit-toolbar__buttons, .edit-toolbar__help { margin: .5rem; }
|
||||
.edit-form { height: 100%; display: flex; flex-direction: column; }
|
||||
.edit-toolbar__buttons, .edit-toolbar__ad { margin: .5rem; }
|
||||
@media screen and (max-height: 500px) {
|
||||
.edit-form { height: 90vh; }
|
||||
}
|
||||
@media screen and (min-height: 501px) {
|
||||
.edit-form { height: 80vh; }
|
||||
}
|
||||
|
||||
.icon {margin-right: .25rem; vertical-align: bottom; }
|
||||
|
||||
main h1:not(.navi-title) {font-size:1.7rem;}
|
||||
blockquote { margin: 0; padding-left: .75rem; }
|
||||
.wikilink_external { padding-left: 1.2rem; }
|
||||
.wikilink_gopher { background: transparent left no-repeat url("/static/icon/gopher-proto.svg"); }
|
||||
.wikilink_http, .wikilink_https { background: transparent left no-repeat url("/static/icon/http-proto.svg"); }
|
||||
.wikilink_gemini { background: transparent left no-repeat url("/static/icon/gemini-proto.svg"); }
|
||||
.wikilink_mailto { background: transparent left no-repeat url("/static/icon/mailto-proto.svg"); }
|
||||
.wikilink_external::before { display: inline-block; width: 18px; height: 16px; vertical-align: sub; }
|
||||
/* .wikilink_external { padding-left: 16px; } */
|
||||
.wikilink_gopher::before { content: url("/static/icon/gopher-proto.svg"); }
|
||||
.wikilink_http::before, .wikilink_https::before { content: url("/static/icon/http-proto.svg"); }
|
||||
/* .wikilink_https { background: transparent url("/static/icon/http-proto.svg") center left no-repeat; } */
|
||||
.wikilink_gemini::before { content: url("/static/icon/gemini-proto.svg"); }
|
||||
.wikilink_mailto::before { content: url("/static/icon/mailto-proto.svg"); }
|
||||
|
||||
article { overflow-wrap: break-word; word-wrap: break-word; word-break: break-word; line-height: 150%; }
|
||||
main h1 { margin: .5rem 0 0 0; }
|
||||
@ -122,7 +128,7 @@ article p { margin: .5rem 0; }
|
||||
article ul, ol { padding-left: 1.5rem; margin: .5rem 0; }
|
||||
article code { padding: .1rem .3rem; border-radius: .25rem; font-size: 90%; font-family: 'Menlo', 'PT Mono', monospace; }
|
||||
article pre.codeblock { padding:.5rem; white-space: pre-wrap; border-radius: .25rem;}
|
||||
.codeblock code {padding:0; font-size:15px; tab-size: 3; }
|
||||
.codeblock code {padding:0; font-size:15px;}
|
||||
.transclusion { border-radius: .25rem; margin-bottom: .25rem; clear: both; }
|
||||
.transclusion_failed { padding: 0 .5rem; }
|
||||
.transclusion__content > *:not(.binary-container) {margin: 0.5rem; }
|
||||
@ -146,6 +152,24 @@ article pre.codeblock { padding:.5rem; white-space: pre-wrap; border-radius: .25
|
||||
.upload-amnt__unattach { display: block; }
|
||||
aside { clear: both; }
|
||||
|
||||
.img-gallery { text-align: center; margin-top: .25rem; margin-bottom: .25rem; }
|
||||
.img-gallery_many-images { border-radius: .25rem; padding: .5rem; }
|
||||
@media screen and (min-width: 700px) {
|
||||
.img-gallery_layout-grid {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr;
|
||||
}
|
||||
|
||||
.img-gallery_layout-side {
|
||||
float: right;
|
||||
max-width: 50%;
|
||||
margin-left: 1em;
|
||||
}
|
||||
}
|
||||
.img-gallery img { max-width: 100%; max-height: 50vh; }
|
||||
figure { margin: 0; }
|
||||
figcaption { padding-bottom: .5rem; }
|
||||
|
||||
#new-name {width:100%;}
|
||||
|
||||
.prevnext__el { display: inline-block; min-width: 40%; padding: .5rem 0; margin-bottom: .25rem; text-decoration: none; border-radius: .25rem; max-width: 49%; }
|
||||
@ -170,6 +194,12 @@ caption { caption-side: top; font-size: small; }
|
||||
.subhyphae__link { display: block; padding: .25rem; text-decoration: none; }
|
||||
.subhyphae__link:hover { background: #eee; }
|
||||
|
||||
.sibling-hyphae__list { padding: 0; margin: 0; }
|
||||
.sibling-hyphae__entry { clear: both; }
|
||||
.sibling-hyphae__count { display: inline-block; float: right; }
|
||||
.sibling-hyphae__entry_this { padding: .25rem .5rem; font-weight: bold; }
|
||||
.sibling-hyphae__link { text-decoration: none; display: block; padding: .25rem .5rem; }
|
||||
|
||||
/* Color stuff */
|
||||
/* Lighter stuff #eee */
|
||||
::-webkit-file-upload-button, .btn { background-color: #eee; color: black; }
|
||||
@ -178,6 +208,8 @@ caption { caption-side: top; font-size: small; }
|
||||
|
||||
p code,
|
||||
article .codeblock,
|
||||
.img-gallery_many-images,
|
||||
.recent-changes__entry,
|
||||
table,
|
||||
.transclusion_stand-out {
|
||||
background-color: rgba(220, 220, 220, 0.5);
|
||||
@ -199,17 +231,17 @@ main { background-color: white; }
|
||||
.shy-link { color: black; }
|
||||
|
||||
blockquote { border-left: 2px #999 solid; }
|
||||
.wikilink_interwiki {color:#080;}
|
||||
.wikilink_new {color:#a55858;}
|
||||
.transclusion code, .transclusion .codeblock {background-color:#ddd;}
|
||||
.transclusion__link { color: black; }
|
||||
.wikilink_new:visited {color:#a55858;}
|
||||
.navi-title { border-bottom: #eee 1px solid; }
|
||||
.upload-amnt { border: #eee 1px solid; }
|
||||
.prevnext { border-top: #eee 1px solid; clear: both; }
|
||||
.prevnext { border-top: #eee 1px solid; }
|
||||
td { border: #ddd 1px solid; }
|
||||
|
||||
.categories-card__link:hover { background-color: #eee; }
|
||||
.categories-card__link:hover,
|
||||
.sibling-hyphae__link:hover { background-color: #eee; }
|
||||
|
||||
/* Dark theme! */
|
||||
@media (prefers-color-scheme: dark) {
|
||||
@ -220,6 +252,12 @@ a, .wikilink_external { color: #f1fa8c; }
|
||||
a:visited, .wikilink_external:visited { color: #ffb86c; }
|
||||
.wikilink_new, .wikilink_new:visited { color: #dd4444; }
|
||||
|
||||
.categories-card__link:hover,
|
||||
.subhyphae__link:hover,
|
||||
.sibling-hyphae__link:hover,
|
||||
.category-list__link:hover,
|
||||
.category__link:hover { background-color: #444; }
|
||||
|
||||
.prevnext__el, .prevnext__el:visited { color: #ddd; }
|
||||
|
||||
.layout-card__title { background-color: #343434; }
|
||||
@ -231,6 +269,8 @@ input[type="text"], input[type="password"],
|
||||
.btn,
|
||||
article code,
|
||||
article .codeblock,
|
||||
.img-gallery_many-images,
|
||||
.recent-changes__entry,
|
||||
.history__entry,
|
||||
.upload-amnt,
|
||||
textarea,
|
||||
@ -271,28 +311,12 @@ mark { background: rgba(130, 80, 30, 5); color: inherit; }
|
||||
border: none;
|
||||
background: none;
|
||||
}
|
||||
.categories-card #_cat-input {
|
||||
.categories-card #_cat-name {
|
||||
width: 100%;
|
||||
margin: 0;
|
||||
padding: 0 .5rem;
|
||||
border: none;
|
||||
}
|
||||
h2 + .add-to-category {
|
||||
margin-top: .5rem;
|
||||
}
|
||||
.add-to-category input[type="submit"] {
|
||||
display: block;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 799px) {
|
||||
.categories-card .categories-card__btn {
|
||||
display: block;
|
||||
flex: 1;
|
||||
border: none;
|
||||
background: none;
|
||||
padding: .25rem 1.5rem;
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Shortcuts
|
||||
@ -317,7 +341,7 @@ kbd {
|
||||
top: 0;
|
||||
left: 50%;
|
||||
width: 100%;
|
||||
max-width: 1000px;
|
||||
max-width: 700px;
|
||||
margin: 96px auto;
|
||||
padding: 24px;
|
||||
transform: translate(-50%, 0);
|
||||
@ -365,16 +389,9 @@ kbd {
|
||||
}
|
||||
|
||||
.shortcuts-help .dialog__content {
|
||||
columns: 300px 2;
|
||||
column-gap: 32px;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.shortcuts-group {
|
||||
/* Don't break a shortcut group between columns */
|
||||
break-inside: avoid;
|
||||
page-break-inside: avoid;
|
||||
overflow: hidden;
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
|
||||
grid-column-gap: 32px;
|
||||
}
|
||||
|
||||
.shortcuts-group-heading {
|
||||
@ -517,8 +534,6 @@ kbd {
|
||||
border: 1px dashed #999;
|
||||
}
|
||||
|
||||
a.btn_destructive,
|
||||
a.btn_destructive:visited,
|
||||
.btn_destructive {
|
||||
border-color: #aa1818;
|
||||
background-color: #ee4343;
|
||||
@ -559,12 +574,9 @@ a.btn_destructive:visited,
|
||||
}
|
||||
|
||||
.recent-changes__entry {
|
||||
padding: 8px 16px;
|
||||
border: 2px solid #999;
|
||||
margin: 0 -16px;
|
||||
}
|
||||
.recent-changes__entry + .recent-changes__entry {
|
||||
margin-top: -2px;
|
||||
margin: 12px 0;
|
||||
padding: 8px 6px;
|
||||
border-radius: 2px;
|
||||
}
|
||||
|
||||
.recent-changes__entry * + * {
|
||||
@ -694,12 +706,8 @@ a.btn_destructive:visited,
|
||||
|
||||
.top-bar__search-bar {
|
||||
border: 0;
|
||||
vertical-align: -webkit-baseline-middle; /* You have no idea how sorry I am. This is a non-standard value. Seems to work in Safari, Opera and mobile Chrome. We need a jedi and a knight in shiny armor to replace it with something more standard. */
|
||||
width: 100%;
|
||||
padding: 4px 2px;
|
||||
}
|
||||
|
||||
.top-bar__section_search {
|
||||
align-self: center;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
@ -709,9 +717,7 @@ a.btn_destructive:visited,
|
||||
.top-bar__hamburger:hover,
|
||||
.top-bar__home-link:hover,
|
||||
.auth-links__link:hover,
|
||||
.top-bar__highlight-link:hover,
|
||||
.categories-card__link:hover,
|
||||
.subhyphae__link:hover {
|
||||
.top-bar__highlight-link:hover {
|
||||
background-color: #444;
|
||||
}
|
||||
}
|
||||
@ -800,6 +806,22 @@ a.btn_destructive:visited,
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Help badge
|
||||
*/
|
||||
.help-topic-badge {
|
||||
display: block;
|
||||
float: right;
|
||||
line-height: 2rem;
|
||||
height: 2rem;
|
||||
width: 2rem;
|
||||
text-align: center;
|
||||
color: inherit;
|
||||
text-decoration: none;
|
||||
border: 1px solid #999;
|
||||
border-radius: 1rem;
|
||||
}
|
||||
|
||||
/*
|
||||
* Buttons beside the hypha title
|
||||
*/
|
||||
@ -845,150 +867,3 @@ a.btn_destructive:visited,
|
||||
display: inline-block;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
/*
|
||||
* Definition list
|
||||
*/
|
||||
dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
dd + dt {
|
||||
margin-top: .5rem;
|
||||
}
|
||||
|
||||
/*
|
||||
* Interwiki page
|
||||
* A possible improvement: show those two fields when Generic is selected, hide otherwise
|
||||
*/
|
||||
body[data-rrh-addr^="/interwiki"] label,
|
||||
body[data-rrh-addr^="/interwiki"] input[type="text"],
|
||||
body[data-rrh-addr^="/interwiki"] input[type="url"] {
|
||||
display: block;
|
||||
width: 100%;
|
||||
max-width: 35rem;
|
||||
}
|
||||
body[data-rrh-addr^="/interwiki"] main form {
|
||||
padding: 0 16px 16px 16px;
|
||||
margin: 0 -16px 16px -16px;
|
||||
border: 2px solid #999;
|
||||
}
|
||||
body[data-rrh-addr^="/interwiki"] main form + form {
|
||||
margin-top: -18px;
|
||||
}
|
||||
.required-field::after {
|
||||
color: red;
|
||||
content: "*";
|
||||
margin-left: .25rem;
|
||||
}
|
||||
|
||||
/*
|
||||
* Admin pages
|
||||
*/
|
||||
.users-table {
|
||||
margin-top: 1rem;
|
||||
}
|
||||
|
||||
/*
|
||||
* Image galleries
|
||||
*/
|
||||
.img-gallery { margin-top: .25rem; margin-bottom: .25rem; }
|
||||
@media screen and (min-width: 700px) {
|
||||
.img-gallery_layout-grid {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr;
|
||||
}
|
||||
|
||||
.img-gallery_layout-side {
|
||||
float: right;
|
||||
max-width: 50%;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
.img-gallery_layout-normal {
|
||||
display: table;
|
||||
}
|
||||
.img-gallery_layout-normal figure {
|
||||
width: 100%;
|
||||
display: table-row;
|
||||
}
|
||||
.img-gallery_layout-normal figure > a {
|
||||
display: table-cell;
|
||||
}
|
||||
.img-gallery_layout-normal figure figcaption {
|
||||
vertical-align: top;
|
||||
display: table-cell;
|
||||
padding-left: 1rem;
|
||||
width: 300px;
|
||||
}
|
||||
}
|
||||
.img-gallery img { max-width: 100%; max-height: 50vh; }
|
||||
figure { margin: 0; }
|
||||
figcaption { padding-bottom: .5rem; }
|
||||
|
||||
/*
|
||||
* Primitive diff
|
||||
*/
|
||||
.primitive-diff__addition {
|
||||
color: green;
|
||||
}
|
||||
.primitive-diff__deletion {
|
||||
color: red;
|
||||
}
|
||||
.primitive-diff__context {
|
||||
opacity: .5;
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
.primitive-diff__addition {
|
||||
color: #4cd74c;
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Print CSS
|
||||
*/
|
||||
@media print {
|
||||
html {
|
||||
background: white;
|
||||
}
|
||||
.subhyphae,
|
||||
header,
|
||||
.btn_navititle,
|
||||
h1 a:first-of-type,
|
||||
.prevnext,
|
||||
#hypha-bottom,
|
||||
.categories-card input,
|
||||
.btn.categories-card__btn {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.categories-card h2 {
|
||||
display: inline;
|
||||
border: 0;
|
||||
margin-left: 2rem;
|
||||
padding: 0;
|
||||
}
|
||||
.categories-card h2:after {
|
||||
content: ":";
|
||||
}
|
||||
.categories-card {
|
||||
margin-top: -1rem;
|
||||
}
|
||||
.categories-card__entries {
|
||||
padding: 0;
|
||||
display: inline;
|
||||
}
|
||||
.categories-card__entry {
|
||||
display: inline-block;
|
||||
}
|
||||
.categories-card__link {
|
||||
text-decoration: underline;
|
||||
padding: 0;
|
||||
}
|
||||
.categories-card__link:after {
|
||||
content: ", ";
|
||||
}
|
||||
main {
|
||||
padding: 1rem 2rem;
|
||||
font-family: Georgia, serif;
|
||||
}
|
||||
}
|
||||
10
static/icon/README.md
Normal file
10
static/icon/README.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Icons
|
||||
|
||||
#### `{http,gemini,mailto}-proto`
|
||||
These are from https://remixicon.com/.
|
||||
|
||||
#### `gopher-proto`
|
||||
This is a modified version of https://www.svgrepo.com/svg/232085/rat.
|
||||
|
||||
#### `feed`
|
||||
This one is from https://upload.wikimedia.org/wikipedia/commons/4/46/Generic_Feed-icon.svg.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user