Index: Makefile ================================================================== --- Makefile +++ Makefile @@ -5,15 +5,18 @@ ## ## Zettelstore is licensed under the latest version of the EUPL (European Union ## Public License). Please see file LICENSE.txt for your rights and obligations ## under this license. -.PHONY: check build release clean +.PHONY: check api build release clean check: go run tools/build.go check +api: + go run tools/build.go testapi + version: @echo $(shell go run tools/build.go version) build: go run tools/build.go build Index: VERSION ================================================================== --- VERSION +++ VERSION @@ -1,1 +1,1 @@ -0.0.13 +0.0.14 ADDED api/api.go Index: api/api.go ================================================================== --- api/api.go +++ api/api.go @@ -0,0 +1,90 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package api contains common definition used for client and server. +package api + +// AuthJSON contains the result of an authentication call. +type AuthJSON struct { + Token string `json:"token"` + Type string `json:"token_type"` + Expires int `json:"expires_in"` +} + +// ZidJSON contains the identifier data of a zettel. +type ZidJSON struct { + ID string `json:"id"` + URL string `json:"url"` +} + +// ZidMetaJSON contains the identifier and the metadata of a zettel. +type ZidMetaJSON struct { + ID string `json:"id"` + URL string `json:"url"` + Meta map[string]string `json:"meta"` +} + +// ZidMetaRelatedList contains identifier/metadata of a zettel and the same for related zettel +type ZidMetaRelatedList struct { + ID string `json:"id"` + URL string `json:"url"` + Meta map[string]string `json:"meta"` + List []ZidMetaJSON `json:"list"` +} + +// ZettelLinksJSON store all links / connections from one zettel to other. +type ZettelLinksJSON struct { + ID string `json:"id"` + URL string `json:"url"` + Links struct { + Incoming []ZidJSON `json:"incoming,omitempty"` + Outgoing []ZidJSON `json:"outgoing,omitempty"` + Local []string `json:"local,omitempty"` + External []string `json:"external,omitempty"` + Meta []string `json:"meta,omitempty"` + } `json:"links"` + Images struct { + Outgoing []ZidJSON `json:"outgoing,omitempty"` + Local []string `json:"local,omitempty"` + External []string `json:"external,omitempty"` + } `json:"images,omitempty"` + Cites []string `json:"cites,omitempty"` +} + +// ZettelDataJSON contains all data for a zettel. +type ZettelDataJSON struct { + Meta map[string]string `json:"meta"` + Encoding string `json:"encoding"` + Content string `json:"content"` +} + +// ZettelJSON contains all data for a zettel, the identifier, the metadata, and the content. +type ZettelJSON struct { + ID string `json:"id"` + URL string `json:"url"` + Meta map[string]string `json:"meta"` + Encoding string `json:"encoding"` + Content string `json:"content"` +} + +// ZettelListJSON contains data for a zettel list. +type ZettelListJSON struct { + List []ZettelJSON `json:"list"` +} + +// TagListJSON specifies the list/map of tags +type TagListJSON struct { + Tags map[string][]string `json:"tags"` +} + +// RoleListJSON specifies the list of roles. +type RoleListJSON struct { + Roles []string `json:"role-list"` +} ADDED api/const.go Index: api/const.go ================================================================== --- api/const.go +++ api/const.go @@ -0,0 +1,108 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package api contains common definition used for client and server. +package api + +import ( + "fmt" +) + +// Additional HTTP constants used. +const ( + MethodMove = "MOVE" // HTTP method for renaming a zettel + + HeaderAccept = "Accept" + HeaderContentType = "Content-Type" + HeaderDestination = "Destination" + HeaderLocation = "Location" +) + +// Values for HTTP query parameter. +const ( + QueryKeyDepth = "depth" + QueryKeyDir = "dir" + QueryKeyFormat = "_format" + QueryKeyLimit = "limit" + QueryKeyPart = "_part" +) + +// Supported dir values. +const ( + DirBackward = "backward" + DirForward = "forward" +) + +// Supported format values. +const ( + FormatDJSON = "djson" + FormatHTML = "html" + FormatJSON = "json" + FormatNative = "native" + FormatRaw = "raw" + FormatText = "text" + FormatZMK = "zmk" +) + +var formatEncoder = map[string]EncodingEnum{ + FormatDJSON: EncoderDJSON, + FormatHTML: EncoderHTML, + FormatJSON: EncoderJSON, + FormatNative: EncoderNative, + FormatRaw: EncoderRaw, + FormatText: EncoderText, + FormatZMK: EncoderZmk, +} +var encoderFormat = map[EncodingEnum]string{} + +func init() { + for k, v := range formatEncoder { + encoderFormat[v] = k + } +} + +// Encoder returns the internal encoder code for the given format string. +func Encoder(format string) EncodingEnum { + if e, ok := formatEncoder[format]; ok { + return e + } + return EncoderUnknown +} + +// EncodingEnum lists all valid encoder keys. +type EncodingEnum uint8 + +// Values for EncoderEnum +const ( + EncoderUnknown EncodingEnum = iota + EncoderDJSON + EncoderHTML + EncoderJSON + EncoderNative + EncoderRaw + EncoderText + EncoderZmk +) + +// String representation of an encoder key. +func (e EncodingEnum) String() string { + if f, ok := encoderFormat[e]; ok { + return f + } + return fmt.Sprintf("*Unknown*(%d)", e) +} + +// Supported part values. +const ( + PartID = "id" + PartMeta = "meta" + PartContent = "content" + PartZettel = "zettel" +) ADDED api/urlbuilder.go Index: api/urlbuilder.go ================================================================== --- api/urlbuilder.go +++ api/urlbuilder.go @@ -0,0 +1,114 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package api contains common definition used for client and server. +package api + +import ( + "net/url" + "strings" + + "zettelstore.de/z/domain/id" +) + +type urlQuery struct{ key, val string } + +// URLBuilder should be used to create zettelstore URLs. +type URLBuilder struct { + prefix string + key byte + path []string + query []urlQuery + fragment string +} + +// NewURLBuilder creates a new URL builder with the given prefix and key. +func NewURLBuilder(prefix string, key byte) *URLBuilder { + return &URLBuilder{prefix: prefix, key: key} +} + +// Clone an URLBuilder +func (ub *URLBuilder) Clone() *URLBuilder { + cpy := new(URLBuilder) + cpy.key = ub.key + if len(ub.path) > 0 { + cpy.path = make([]string, 0, len(ub.path)) + cpy.path = append(cpy.path, ub.path...) + } + if len(ub.query) > 0 { + cpy.query = make([]urlQuery, 0, len(ub.query)) + cpy.query = append(cpy.query, ub.query...) + } + cpy.fragment = ub.fragment + return cpy +} + +// SetZid sets the zettel identifier. +func (ub *URLBuilder) SetZid(zid id.Zid) *URLBuilder { + if len(ub.path) > 0 { + panic("Cannot add Zid") + } + ub.path = append(ub.path, zid.String()) + return ub +} + +// AppendPath adds a new path element +func (ub *URLBuilder) AppendPath(p string) *URLBuilder { + ub.path = append(ub.path, p) + return ub +} + +// AppendQuery adds a new query parameter +func (ub *URLBuilder) AppendQuery(key, value string) *URLBuilder { + ub.query = append(ub.query, urlQuery{key, value}) + return ub +} + +// ClearQuery removes all query parameters. +func (ub *URLBuilder) ClearQuery() *URLBuilder { + ub.query = nil + ub.fragment = "" + return ub +} + +// SetFragment stores the fragment +func (ub *URLBuilder) SetFragment(s string) *URLBuilder { + ub.fragment = s + return ub +} + +// String produces a string value. +func (ub *URLBuilder) String() string { + var sb strings.Builder + + sb.WriteString(ub.prefix) + if ub.key != '/' { + sb.WriteByte(ub.key) + } + for _, p := range ub.path { + sb.WriteByte('/') + sb.WriteString(url.PathEscape(p)) + } + if len(ub.fragment) > 0 { + sb.WriteByte('#') + sb.WriteString(ub.fragment) + } + for i, q := range ub.query { + if i == 0 { + sb.WriteByte('?') + } else { + sb.WriteByte('&') + } + sb.WriteString(q.key) + sb.WriteByte('=') + sb.WriteString(url.QueryEscape(q.val)) + } + return sb.String() +} Index: ast/ast.go ================================================================== --- ast/ast.go +++ ast/ast.go @@ -30,11 +30,11 @@ Ast BlockSlice // Zettel abstract syntax tree is a sequence of block nodes. } // Node is the interface, all nodes must implement. type Node interface { - Accept(v Visitor) + WalkChildren(v Visitor) } // BlockNode is the interface that all block nodes must implement. type BlockNode interface { Node Index: ast/attr_test.go ================================================================== --- ast/attr_test.go +++ ast/attr_test.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2020 Detlef Stern +// Copyright (c) 2020-2021 Detlef Stern // // This file is part of zettelstore. // // Zettelstore is licensed under the latest version of the EUPL (European Union // Public License). Please see file LICENSE.txt for your rights and obligations @@ -16,10 +16,11 @@ "zettelstore.de/z/ast" ) func TestHasDefault(t *testing.T) { + t.Parallel() attr := &ast.Attributes{} if attr.HasDefault() { t.Error("Should not have default attr") } attr = &ast.Attributes{Attrs: map[string]string{"-": "value"}} @@ -27,10 +28,11 @@ t.Error("Should have default attr") } } func TestAttrClone(t *testing.T) { + t.Parallel() orig := &ast.Attributes{} clone := orig.Clone() if len(clone.Attrs) > 0 { t.Error("Attrs must be empty") } Index: ast/block.go ================================================================== --- ast/block.go +++ ast/block.go @@ -17,69 +17,74 @@ // Another name is "paragraph". type ParaNode struct { Inlines InlineSlice } -func (pn *ParaNode) blockNode() {} -func (pn *ParaNode) itemNode() {} -func (pn *ParaNode) descriptionNode() {} +func (pn *ParaNode) blockNode() { /* Just a marker */ } +func (pn *ParaNode) itemNode() { /* Just a marker */ } +func (pn *ParaNode) descriptionNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (pn *ParaNode) Accept(v Visitor) { v.VisitPara(pn) } +// WalkChildren walks down the inline elements. +func (pn *ParaNode) WalkChildren(v Visitor) { + WalkInlineSlice(v, pn.Inlines) +} //-------------------------------------------------------------------------- // VerbatimNode contains lines of uninterpreted text type VerbatimNode struct { - Code VerbatimCode + Kind VerbatimKind Attrs *Attributes Lines []string } -// VerbatimCode specifies the format that is applied to code inline nodes. -type VerbatimCode int +// VerbatimKind specifies the format that is applied to code inline nodes. +type VerbatimKind uint8 // Constants for VerbatimCode const ( - _ VerbatimCode = iota + _ VerbatimKind = iota VerbatimProg // Program code. VerbatimComment // Block comment VerbatimHTML // Block HTML, e.g. for Markdown ) -func (vn *VerbatimNode) blockNode() {} -func (vn *VerbatimNode) itemNode() {} +func (vn *VerbatimNode) blockNode() { /* Just a marker */ } +func (vn *VerbatimNode) itemNode() { /* Just a marker */ } -// Accept a visitor an visit the node. -func (vn *VerbatimNode) Accept(v Visitor) { v.VisitVerbatim(vn) } +// WalkChildren does nothing. +func (vn *VerbatimNode) WalkChildren(v Visitor) { /* No children*/ } //-------------------------------------------------------------------------- // RegionNode encapsulates a region of block nodes. type RegionNode struct { - Code RegionCode + Kind RegionKind Attrs *Attributes Blocks BlockSlice Inlines InlineSlice // Additional text at the end of the region } -// RegionCode specifies the actual region type. -type RegionCode int +// RegionKind specifies the actual region type. +type RegionKind uint8 // Values for RegionCode const ( - _ RegionCode = iota + _ RegionKind = iota RegionSpan // Just a span of blocks RegionQuote // A longer quotation RegionVerse // Line breaks matter ) -func (rn *RegionNode) blockNode() {} -func (rn *RegionNode) itemNode() {} +func (rn *RegionNode) blockNode() { /* Just a marker */ } +func (rn *RegionNode) itemNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (rn *RegionNode) Accept(v Visitor) { v.VisitRegion(rn) } +// WalkChildren walks down the blocks and the text. +func (rn *RegionNode) WalkChildren(v Visitor) { + WalkBlockSlice(v, rn.Blocks) + WalkInlineSlice(v, rn.Inlines) +} //-------------------------------------------------------------------------- // HeadingNode stores the heading text and level. type HeadingNode struct { @@ -87,54 +92,60 @@ Inlines InlineSlice // Heading text, possibly formatted Slug string // Heading text, suitable to be used as an URL fragment Attrs *Attributes } -func (hn *HeadingNode) blockNode() {} -func (hn *HeadingNode) itemNode() {} +func (hn *HeadingNode) blockNode() { /* Just a marker */ } +func (hn *HeadingNode) itemNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (hn *HeadingNode) Accept(v Visitor) { v.VisitHeading(hn) } +// WalkChildren walks the heading text. +func (hn *HeadingNode) WalkChildren(v Visitor) { + WalkInlineSlice(v, hn.Inlines) +} //-------------------------------------------------------------------------- // HRuleNode specifies a horizontal rule. type HRuleNode struct { Attrs *Attributes } -func (hn *HRuleNode) blockNode() {} -func (hn *HRuleNode) itemNode() {} +func (hn *HRuleNode) blockNode() { /* Just a marker */ } +func (hn *HRuleNode) itemNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (hn *HRuleNode) Accept(v Visitor) { v.VisitHRule(hn) } +// WalkChildren does nothing. +func (hn *HRuleNode) WalkChildren(v Visitor) { /* No children*/ } //-------------------------------------------------------------------------- // NestedListNode specifies a nestable list, either ordered or unordered. type NestedListNode struct { - Code NestedListCode + Kind NestedListKind Items []ItemSlice Attrs *Attributes } -// NestedListCode specifies the actual list type. -type NestedListCode int +// NestedListKind specifies the actual list type. +type NestedListKind uint8 // Values for ListCode const ( - _ NestedListCode = iota + _ NestedListKind = iota NestedListOrdered // Ordered list. NestedListUnordered // Unordered list. NestedListQuote // Quote list. ) -func (ln *NestedListNode) blockNode() {} -func (ln *NestedListNode) itemNode() {} +func (ln *NestedListNode) blockNode() { /* Just a marker */ } +func (ln *NestedListNode) itemNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (ln *NestedListNode) Accept(v Visitor) { v.VisitNestedList(ln) } +// WalkChildren walks down the items. +func (ln *NestedListNode) WalkChildren(v Visitor) { + for _, item := range ln.Items { + WalkItemSlice(v, item) + } +} //-------------------------------------------------------------------------- // DescriptionListNode specifies a description list. type DescriptionListNode struct { @@ -147,12 +158,19 @@ Descriptions []DescriptionSlice } func (dn *DescriptionListNode) blockNode() {} -// Accept a visitor and visit the node. -func (dn *DescriptionListNode) Accept(v Visitor) { v.VisitDescriptionList(dn) } +// WalkChildren walks down to the descriptions. +func (dn *DescriptionListNode) WalkChildren(v Visitor) { + for _, desc := range dn.Descriptions { + WalkInlineSlice(v, desc.Term) + for _, dns := range desc.Descriptions { + WalkDescriptionSlice(v, dns) + } + } +} //-------------------------------------------------------------------------- // TableNode specifies a full table type TableNode struct { @@ -181,14 +199,23 @@ AlignLeft // Left alignment AlignCenter // Center the content AlignRight // Right alignment ) -func (tn *TableNode) blockNode() {} +func (tn *TableNode) blockNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (tn *TableNode) Accept(v Visitor) { v.VisitTable(tn) } +// WalkChildren walks down to the cells. +func (tn *TableNode) WalkChildren(v Visitor) { + for _, cell := range tn.Header { + WalkInlineSlice(v, cell.Inlines) + } + for _, row := range tn.Rows { + for _, cell := range row { + WalkInlineSlice(v, cell.Inlines) + } + } +} //-------------------------------------------------------------------------- // BLOBNode contains just binary data that must be interpreted according to // a syntax. @@ -196,9 +223,9 @@ Title string Syntax string Blob []byte } -func (bn *BLOBNode) blockNode() {} +func (bn *BLOBNode) blockNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (bn *BLOBNode) Accept(v Visitor) { v.VisitBLOB(bn) } +// WalkChildren does nothing. +func (bn *BLOBNode) WalkChildren(v Visitor) { /* No children*/ } Index: ast/inline.go ================================================================== --- ast/inline.go +++ ast/inline.go @@ -16,50 +16,50 @@ // TextNode just contains some text. type TextNode struct { Text string // The text itself. } -func (tn *TextNode) inlineNode() {} +func (tn *TextNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (tn *TextNode) Accept(v Visitor) { v.VisitText(tn) } +// WalkChildren does nothing. +func (tn *TextNode) WalkChildren(v Visitor) { /* No children*/ } // -------------------------------------------------------------------------- // TagNode contains a tag. type TagNode struct { Tag string // The text itself. } -func (tn *TagNode) inlineNode() {} +func (tn *TagNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (tn *TagNode) Accept(v Visitor) { v.VisitTag(tn) } +// WalkChildren does nothing. +func (tn *TagNode) WalkChildren(v Visitor) { /* No children*/ } // -------------------------------------------------------------------------- // SpaceNode tracks inter-word space characters. type SpaceNode struct { Lexeme string } -func (sn *SpaceNode) inlineNode() {} +func (sn *SpaceNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (sn *SpaceNode) Accept(v Visitor) { v.VisitSpace(sn) } +// WalkChildren does nothing. +func (sn *SpaceNode) WalkChildren(v Visitor) { /* No children*/ } // -------------------------------------------------------------------------- // BreakNode signals a new line that must / should be interpreted as a new line break. type BreakNode struct { Hard bool // Hard line break? } -func (bn *BreakNode) inlineNode() {} +func (bn *BreakNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (bn *BreakNode) Accept(v Visitor) { v.VisitBreak(bn) } +// WalkChildren does nothing. +func (bn *BreakNode) WalkChildren(v Visitor) { /* No children*/ } // -------------------------------------------------------------------------- // LinkNode contains the specified link. type LinkNode struct { @@ -67,14 +67,16 @@ Inlines InlineSlice // The text associated with the link. OnlyRef bool // True if no text was specified. Attrs *Attributes // Optional attributes } -func (ln *LinkNode) inlineNode() {} +func (ln *LinkNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (ln *LinkNode) Accept(v Visitor) { v.VisitLink(ln) } +// WalkChildren walks to the link text. +func (ln *LinkNode) WalkChildren(v Visitor) { + WalkInlineSlice(v, ln.Inlines) +} // -------------------------------------------------------------------------- // ImageNode contains the specified image reference. type ImageNode struct { @@ -83,14 +85,16 @@ Syntax string // Syntax of Blob Inlines InlineSlice // The text associated with the image. Attrs *Attributes // Optional attributes } -func (in *ImageNode) inlineNode() {} +func (in *ImageNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (in *ImageNode) Accept(v Visitor) { v.VisitImage(in) } +// WalkChildren walks to the image text. +func (in *ImageNode) WalkChildren(v Visitor) { + WalkInlineSlice(v, in.Inlines) +} // -------------------------------------------------------------------------- // CiteNode contains the specified citation. type CiteNode struct { @@ -97,14 +101,16 @@ Key string // The citation key Inlines InlineSlice // The text associated with the citation. Attrs *Attributes // Optional attributes } -func (cn *CiteNode) inlineNode() {} +func (cn *CiteNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (cn *CiteNode) Accept(v Visitor) { v.VisitCite(cn) } +// WalkChildren walks to the cite text. +func (cn *CiteNode) WalkChildren(v Visitor) { + WalkInlineSlice(v, cn.Inlines) +} // -------------------------------------------------------------------------- // MarkNode contains the specified merked position. // It is a BlockNode too, because although it is typically parsed during inline @@ -111,43 +117,45 @@ // mode, it is moved into block mode afterwards. type MarkNode struct { Text string } -func (mn *MarkNode) inlineNode() {} +func (mn *MarkNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (mn *MarkNode) Accept(v Visitor) { v.VisitMark(mn) } +// WalkChildren does nothing. +func (mn *MarkNode) WalkChildren(v Visitor) { /* No children*/ } // -------------------------------------------------------------------------- // FootnoteNode contains the specified footnote. type FootnoteNode struct { Inlines InlineSlice // The footnote text. Attrs *Attributes // Optional attributes } -func (fn *FootnoteNode) inlineNode() {} +func (fn *FootnoteNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (fn *FootnoteNode) Accept(v Visitor) { v.VisitFootnote(fn) } +// WalkChildren walks to the footnote text. +func (fn *FootnoteNode) WalkChildren(v Visitor) { + WalkInlineSlice(v, fn.Inlines) +} // -------------------------------------------------------------------------- // FormatNode specifies some inline formatting. type FormatNode struct { - Code FormatCode + Kind FormatKind Attrs *Attributes // Optional attributes. Inlines InlineSlice } -// FormatCode specifies the format that is applied to the inline nodes. -type FormatCode int +// FormatKind specifies the format that is applied to the inline nodes. +type FormatKind uint8 // Constants for FormatCode const ( - _ FormatCode = iota + _ FormatKind = iota FormatItalic // Italic text. FormatEmph // Semantically emphasized text. FormatBold // Bold text. FormatStrong // Semantically strongly emphasized text. FormatUnder // Underlined text. @@ -161,36 +169,38 @@ FormatSmall // Smaller text. FormatSpan // Generic inline container. FormatMonospace // Monospaced text. ) -func (fn *FormatNode) inlineNode() {} +func (fn *FormatNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (fn *FormatNode) Accept(v Visitor) { v.VisitFormat(fn) } +// WalkChildren walks to the formatted text. +func (fn *FormatNode) WalkChildren(v Visitor) { + WalkInlineSlice(v, fn.Inlines) +} // -------------------------------------------------------------------------- // LiteralNode specifies some uninterpreted text. type LiteralNode struct { - Code LiteralCode + Kind LiteralKind Attrs *Attributes // Optional attributes. Text string } -// LiteralCode specifies the format that is applied to code inline nodes. -type LiteralCode int +// LiteralKind specifies the format that is applied to code inline nodes. +type LiteralKind uint8 // Constants for LiteralCode const ( - _ LiteralCode = iota + _ LiteralKind = iota LiteralProg // Inline program code. LiteralKeyb // Keyboard strokes. LiteralOutput // Sample output. LiteralComment // Inline comment LiteralHTML // Inline HTML, e.g. for Markdown ) -func (rn *LiteralNode) inlineNode() {} +func (ln *LiteralNode) inlineNode() { /* Just a marker */ } -// Accept a visitor and visit the node. -func (rn *LiteralNode) Accept(v Visitor) { v.VisitLiteral(rn) } +// WalkChildren does nothing. +func (ln *LiteralNode) WalkChildren(v Visitor) { /* No children*/ } Index: ast/ref_test.go ================================================================== --- ast/ref_test.go +++ ast/ref_test.go @@ -16,10 +16,11 @@ "zettelstore.de/z/ast" ) func TestParseReference(t *testing.T) { + t.Parallel() testcases := []struct { link string err bool exp string }{ @@ -39,10 +40,11 @@ } } } func TestReferenceIsZettelMaterial(t *testing.T) { + t.Parallel() testcases := []struct { link string isZettel bool isExternal bool isLocal bool DELETED ast/traverser.go Index: ast/traverser.go ================================================================== --- ast/traverser.go +++ ast/traverser.go @@ -1,161 +0,0 @@ -//----------------------------------------------------------------------------- -// Copyright (c) 2020-2021 Detlef Stern -// -// This file is part of zettelstore. -// -// Zettelstore is licensed under the latest version of the EUPL (European Union -// Public License). Please see file LICENSE.txt for your rights and obligations -// under this license. -//----------------------------------------------------------------------------- - -// Package ast provides the abstract syntax tree. -package ast - -// A traverser is a Visitor that just traverses the AST and delegates node -// spacific actions to a Visitor. This Visitor should not traverse the AST. - -// TopDownTraverser visits first the node and then the children nodes. -type TopDownTraverser struct { - v Visitor -} - -// NewTopDownTraverser creates a new traverser. -func NewTopDownTraverser(visitor Visitor) TopDownTraverser { - return TopDownTraverser{visitor} -} - -// VisitVerbatim has nothing to traverse. -func (t TopDownTraverser) VisitVerbatim(vn *VerbatimNode) { t.v.VisitVerbatim(vn) } - -// VisitRegion traverses the content and the additional text. -func (t TopDownTraverser) VisitRegion(rn *RegionNode) { - t.v.VisitRegion(rn) - t.VisitBlockSlice(rn.Blocks) - t.VisitInlineSlice(rn.Inlines) -} - -// VisitHeading traverses the heading. -func (t TopDownTraverser) VisitHeading(hn *HeadingNode) { - t.v.VisitHeading(hn) - t.VisitInlineSlice(hn.Inlines) -} - -// VisitHRule traverses nothing. -func (t TopDownTraverser) VisitHRule(hn *HRuleNode) { t.v.VisitHRule(hn) } - -// VisitNestedList traverses all nested list elements. -func (t TopDownTraverser) VisitNestedList(ln *NestedListNode) { - t.v.VisitNestedList(ln) - for _, item := range ln.Items { - t.visitItemSlice(item) - } -} - -// VisitDescriptionList traverses all description terms and their associated -// descriptions. -func (t TopDownTraverser) VisitDescriptionList(dn *DescriptionListNode) { - t.v.VisitDescriptionList(dn) - for _, defs := range dn.Descriptions { - t.VisitInlineSlice(defs.Term) - for _, descr := range defs.Descriptions { - t.visitDescriptionSlice(descr) - } - } -} - -// VisitPara traverses the inlines of a paragraph. -func (t TopDownTraverser) VisitPara(pn *ParaNode) { - t.v.VisitPara(pn) - t.VisitInlineSlice(pn.Inlines) -} - -// VisitTable traverses all cells of the header and then row-wise all cells of -// the table body. -func (t TopDownTraverser) VisitTable(tn *TableNode) { - t.v.VisitTable(tn) - for _, col := range tn.Header { - t.VisitInlineSlice(col.Inlines) - } - for _, row := range tn.Rows { - for _, col := range row { - t.VisitInlineSlice(col.Inlines) - } - } -} - -// VisitBLOB traverses nothing. -func (t TopDownTraverser) VisitBLOB(bn *BLOBNode) { t.v.VisitBLOB(bn) } - -// VisitText traverses nothing. -func (t TopDownTraverser) VisitText(tn *TextNode) { t.v.VisitText(tn) } - -// VisitTag traverses nothing. -func (t TopDownTraverser) VisitTag(tn *TagNode) { t.v.VisitTag(tn) } - -// VisitSpace traverses nothing. -func (t TopDownTraverser) VisitSpace(sn *SpaceNode) { t.v.VisitSpace(sn) } - -// VisitBreak traverses nothing. -func (t TopDownTraverser) VisitBreak(bn *BreakNode) { t.v.VisitBreak(bn) } - -// VisitLink traverses the link text. -func (t TopDownTraverser) VisitLink(ln *LinkNode) { - t.v.VisitLink(ln) - t.VisitInlineSlice(ln.Inlines) -} - -// VisitImage traverses the image text. -func (t TopDownTraverser) VisitImage(in *ImageNode) { - t.v.VisitImage(in) - t.VisitInlineSlice(in.Inlines) -} - -// VisitCite traverses the cite text. -func (t TopDownTraverser) VisitCite(cn *CiteNode) { - t.v.VisitCite(cn) - t.VisitInlineSlice(cn.Inlines) -} - -// VisitFootnote traverses the footnote text. -func (t TopDownTraverser) VisitFootnote(fn *FootnoteNode) { - t.v.VisitFootnote(fn) - t.VisitInlineSlice(fn.Inlines) -} - -// VisitMark traverses nothing. -func (t TopDownTraverser) VisitMark(mn *MarkNode) { t.v.VisitMark(mn) } - -// VisitFormat traverses the formatted text. -func (t TopDownTraverser) VisitFormat(fn *FormatNode) { - t.v.VisitFormat(fn) - t.VisitInlineSlice(fn.Inlines) -} - -// VisitLiteral traverses nothing. -func (t TopDownTraverser) VisitLiteral(ln *LiteralNode) { t.v.VisitLiteral(ln) } - -// VisitBlockSlice traverses a block slice. -func (t TopDownTraverser) VisitBlockSlice(bns BlockSlice) { - for _, bn := range bns { - bn.Accept(t) - } -} - -func (t TopDownTraverser) visitItemSlice(ins ItemSlice) { - for _, in := range ins { - in.Accept(t) - } -} - -func (t TopDownTraverser) visitDescriptionSlice(dns DescriptionSlice) { - for _, dn := range dns { - dn.Accept(t) - } -} - -// VisitInlineSlice traverses a block slice. -func (t TopDownTraverser) VisitInlineSlice(ins InlineSlice) { - for _, in := range ins { - in.Accept(t) - } -} DELETED ast/visitor.go Index: ast/visitor.go ================================================================== --- ast/visitor.go +++ ast/visitor.go @@ -1,39 +0,0 @@ -//----------------------------------------------------------------------------- -// Copyright (c) 2020 Detlef Stern -// -// This file is part of zettelstore. -// -// Zettelstore is licensed under the latest version of the EUPL (European Union -// Public License). Please see file LICENSE.txt for your rights and obligations -// under this license. -//----------------------------------------------------------------------------- - -// Package ast provides the abstract syntax tree. -package ast - -// Visitor is the interface all visitors must implement. -type Visitor interface { - // Block nodes - VisitVerbatim(vn *VerbatimNode) - VisitRegion(rn *RegionNode) - VisitHeading(hn *HeadingNode) - VisitHRule(hn *HRuleNode) - VisitNestedList(ln *NestedListNode) - VisitDescriptionList(dn *DescriptionListNode) - VisitPara(pn *ParaNode) - VisitTable(tn *TableNode) - VisitBLOB(bn *BLOBNode) - - // Inline nodes - VisitText(tn *TextNode) - VisitTag(tn *TagNode) - VisitSpace(sn *SpaceNode) - VisitBreak(bn *BreakNode) - VisitLink(ln *LinkNode) - VisitImage(in *ImageNode) - VisitCite(cn *CiteNode) - VisitFootnote(fn *FootnoteNode) - VisitMark(mn *MarkNode) - VisitFormat(fn *FormatNode) - VisitLiteral(ln *LiteralNode) -} ADDED ast/walk.go Index: ast/walk.go ================================================================== --- ast/walk.go +++ ast/walk.go @@ -0,0 +1,54 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package ast provides the abstract syntax tree. +package ast + +// Visitor is a visitor for walking the AST. +type Visitor interface { + Visit(node Node) Visitor +} + +// Walk traverses the AST. +func Walk(v Visitor, node Node) { + if v = v.Visit(node); v == nil { + return + } + node.WalkChildren(v) + v.Visit(nil) +} + +// WalkBlockSlice traverse a block slice. +func WalkBlockSlice(v Visitor, bns BlockSlice) { + for _, bn := range bns { + Walk(v, bn) + } +} + +// WalkInlineSlice traverses an inline slice. +func WalkInlineSlice(v Visitor, ins InlineSlice) { + for _, in := range ins { + Walk(v, in) + } +} + +// WalkItemSlice traverses an item slice. +func WalkItemSlice(v Visitor, ins ItemSlice) { + for _, in := range ins { + Walk(v, in) + } +} + +// WalkDescriptionSlice traverses an item slice. +func WalkDescriptionSlice(v Visitor, dns DescriptionSlice) { + for _, dn := range dns { + Walk(v, dn) + } +} Index: auth/auth.go ================================================================== --- auth/auth.go +++ auth/auth.go @@ -12,14 +12,14 @@ package auth import ( "time" + "zettelstore.de/z/box" "zettelstore.de/z/config" "zettelstore.de/z/domain/id" "zettelstore.de/z/domain/meta" - "zettelstore.de/z/place" "zettelstore.de/z/web/server" ) // BaseManager allows to check some base auth modes. type BaseManager interface { @@ -77,11 +77,11 @@ // Manager is the main interface for providing the service. type Manager interface { TokenManager AuthzManager - PlaceWithPolicy(auth server.Auth, unprotectedPlace place.Place, rtConfig config.Config) (place.Place, Policy) + BoxWithPolicy(auth server.Auth, unprotectedBox box.Box, rtConfig config.Config) (box.Box, Policy) } // Policy is an interface for checking access authorization. type Policy interface { // User is allowed to create a new zettel. Index: auth/impl/impl.go ================================================================== --- auth/impl/impl.go +++ auth/impl/impl.go @@ -19,15 +19,15 @@ "github.com/pascaldekloe/jwt" "zettelstore.de/z/auth" "zettelstore.de/z/auth/policy" + "zettelstore.de/z/box" "zettelstore.de/z/config" "zettelstore.de/z/domain/id" "zettelstore.de/z/domain/meta" "zettelstore.de/z/kernel" - "zettelstore.de/z/place" "zettelstore.de/z/web/server" ) type myAuth struct { readonly bool @@ -177,8 +177,8 @@ } } return meta.UserRoleReader } -func (a *myAuth) PlaceWithPolicy(auth server.Auth, unprotectedPlace place.Place, rtConfig config.Config) (place.Place, auth.Policy) { - return policy.PlaceWithPolicy(auth, a, unprotectedPlace, rtConfig) +func (a *myAuth) BoxWithPolicy(auth server.Auth, unprotectedBox box.Box, rtConfig config.Config) (box.Box, auth.Policy) { + return policy.BoxWithPolicy(auth, a, unprotectedBox, rtConfig) } ADDED auth/policy/box.go Index: auth/policy/box.go ================================================================== --- auth/policy/box.go +++ auth/policy/box.go @@ -0,0 +1,164 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package policy provides some interfaces and implementation for authorizsation policies. +package policy + +import ( + "context" + + "zettelstore.de/z/auth" + "zettelstore.de/z/box" + "zettelstore.de/z/config" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/search" + "zettelstore.de/z/web/server" +) + +// BoxWithPolicy wraps the given box inside a policy box. +func BoxWithPolicy( + auth server.Auth, + manager auth.AuthzManager, + box box.Box, + authConfig config.AuthConfig, +) (box.Box, auth.Policy) { + pol := newPolicy(manager, authConfig) + return newBox(auth, box, pol), pol +} + +// polBox implements a policy box. +type polBox struct { + auth server.Auth + box box.Box + policy auth.Policy +} + +// newBox creates a new policy box. +func newBox(auth server.Auth, box box.Box, policy auth.Policy) box.Box { + return &polBox{ + auth: auth, + box: box, + policy: policy, + } +} + +func (pp *polBox) Location() string { + return pp.box.Location() +} + +func (pp *polBox) CanCreateZettel(ctx context.Context) bool { + return pp.box.CanCreateZettel(ctx) +} + +func (pp *polBox) CreateZettel(ctx context.Context, zettel domain.Zettel) (id.Zid, error) { + user := pp.auth.GetUser(ctx) + if pp.policy.CanCreate(user, zettel.Meta) { + return pp.box.CreateZettel(ctx, zettel) + } + return id.Invalid, box.NewErrNotAllowed("Create", user, id.Invalid) +} + +func (pp *polBox) GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) { + zettel, err := pp.box.GetZettel(ctx, zid) + if err != nil { + return domain.Zettel{}, err + } + user := pp.auth.GetUser(ctx) + if pp.policy.CanRead(user, zettel.Meta) { + return zettel, nil + } + return domain.Zettel{}, box.NewErrNotAllowed("GetZettel", user, zid) +} + +func (pp *polBox) GetAllZettel(ctx context.Context, zid id.Zid) ([]domain.Zettel, error) { + return pp.box.GetAllZettel(ctx, zid) +} + +func (pp *polBox) GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) { + m, err := pp.box.GetMeta(ctx, zid) + if err != nil { + return nil, err + } + user := pp.auth.GetUser(ctx) + if pp.policy.CanRead(user, m) { + return m, nil + } + return nil, box.NewErrNotAllowed("GetMeta", user, zid) +} + +func (pp *polBox) GetAllMeta(ctx context.Context, zid id.Zid) ([]*meta.Meta, error) { + return pp.box.GetAllMeta(ctx, zid) +} + +func (pp *polBox) FetchZids(ctx context.Context) (id.Set, error) { + return nil, box.NewErrNotAllowed("fetch-zids", pp.auth.GetUser(ctx), id.Invalid) +} + +func (pp *polBox) SelectMeta(ctx context.Context, s *search.Search) ([]*meta.Meta, error) { + user := pp.auth.GetUser(ctx) + canRead := pp.policy.CanRead + s = s.AddPreMatch(func(m *meta.Meta) bool { return canRead(user, m) }) + return pp.box.SelectMeta(ctx, s) +} + +func (pp *polBox) CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool { + return pp.box.CanUpdateZettel(ctx, zettel) +} + +func (pp *polBox) UpdateZettel(ctx context.Context, zettel domain.Zettel) error { + zid := zettel.Meta.Zid + user := pp.auth.GetUser(ctx) + if !zid.IsValid() { + return &box.ErrInvalidID{Zid: zid} + } + // Write existing zettel + oldMeta, err := pp.box.GetMeta(ctx, zid) + if err != nil { + return err + } + if pp.policy.CanWrite(user, oldMeta, zettel.Meta) { + return pp.box.UpdateZettel(ctx, zettel) + } + return box.NewErrNotAllowed("Write", user, zid) +} + +func (pp *polBox) AllowRenameZettel(ctx context.Context, zid id.Zid) bool { + return pp.box.AllowRenameZettel(ctx, zid) +} + +func (pp *polBox) RenameZettel(ctx context.Context, curZid, newZid id.Zid) error { + meta, err := pp.box.GetMeta(ctx, curZid) + if err != nil { + return err + } + user := pp.auth.GetUser(ctx) + if pp.policy.CanRename(user, meta) { + return pp.box.RenameZettel(ctx, curZid, newZid) + } + return box.NewErrNotAllowed("Rename", user, curZid) +} + +func (pp *polBox) CanDeleteZettel(ctx context.Context, zid id.Zid) bool { + return pp.box.CanDeleteZettel(ctx, zid) +} + +func (pp *polBox) DeleteZettel(ctx context.Context, zid id.Zid) error { + meta, err := pp.box.GetMeta(ctx, zid) + if err != nil { + return err + } + user := pp.auth.GetUser(ctx) + if pp.policy.CanDelete(user, meta) { + return pp.box.DeleteZettel(ctx, zid) + } + return box.NewErrNotAllowed("Delete", user, zid) +} Index: auth/policy/owner.go ================================================================== --- auth/policy/owner.go +++ auth/policy/owner.go @@ -62,11 +62,18 @@ } if role, ok := m.Get(meta.KeyRole); ok && role == meta.ValueRoleUser { // Only the user can read its own zettel return user.Zid == m.Zid } - return true + switch o.manager.GetUserRole(user) { + case meta.UserRoleReader, meta.UserRoleWriter, meta.UserRoleOwner: + return true + case meta.UserRoleCreator: + return vis == meta.VisibilityCreator + default: + return false + } } var noChangeUser = []string{ meta.KeyID, meta.KeyRole, @@ -96,11 +103,12 @@ return false } } return true } - if o.manager.GetUserRole(user) == meta.UserRoleReader { + switch userRole := o.manager.GetUserRole(user); userRole { + case meta.UserRoleReader, meta.UserRoleCreator: return false } return o.userCanCreate(user, newMeta) } DELETED auth/policy/place.go Index: auth/policy/place.go ================================================================== --- auth/policy/place.go +++ auth/policy/place.go @@ -1,165 +0,0 @@ -//----------------------------------------------------------------------------- -// Copyright (c) 2020-2021 Detlef Stern -// -// This file is part of zettelstore. -// -// Zettelstore is licensed under the latest version of the EUPL (European Union -// Public License). Please see file LICENSE.txt for your rights and obligations -// under this license. -//----------------------------------------------------------------------------- - -// Package policy provides some interfaces and implementation for authorizsation policies. -package policy - -import ( - "context" - "io" - - "zettelstore.de/z/auth" - "zettelstore.de/z/config" - "zettelstore.de/z/domain" - "zettelstore.de/z/domain/id" - "zettelstore.de/z/domain/meta" - "zettelstore.de/z/place" - "zettelstore.de/z/search" - "zettelstore.de/z/web/server" -) - -// PlaceWithPolicy wraps the given place inside a policy place. -func PlaceWithPolicy( - auth server.Auth, - manager auth.AuthzManager, - place place.Place, - authConfig config.AuthConfig, -) (place.Place, auth.Policy) { - pol := newPolicy(manager, authConfig) - return newPlace(auth, place, pol), pol -} - -// polPlace implements a policy place. -type polPlace struct { - auth server.Auth - place place.Place - policy auth.Policy -} - -// newPlace creates a new policy place. -func newPlace(auth server.Auth, place place.Place, policy auth.Policy) place.Place { - return &polPlace{ - auth: auth, - place: place, - policy: policy, - } -} - -func (pp *polPlace) Location() string { - return pp.place.Location() -} - -func (pp *polPlace) CanCreateZettel(ctx context.Context) bool { - return pp.place.CanCreateZettel(ctx) -} - -func (pp *polPlace) CreateZettel(ctx context.Context, zettel domain.Zettel) (id.Zid, error) { - user := pp.auth.GetUser(ctx) - if pp.policy.CanCreate(user, zettel.Meta) { - return pp.place.CreateZettel(ctx, zettel) - } - return id.Invalid, place.NewErrNotAllowed("Create", user, id.Invalid) -} - -func (pp *polPlace) GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) { - zettel, err := pp.place.GetZettel(ctx, zid) - if err != nil { - return domain.Zettel{}, err - } - user := pp.auth.GetUser(ctx) - if pp.policy.CanRead(user, zettel.Meta) { - return zettel, nil - } - return domain.Zettel{}, place.NewErrNotAllowed("GetZettel", user, zid) -} - -func (pp *polPlace) GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) { - m, err := pp.place.GetMeta(ctx, zid) - if err != nil { - return nil, err - } - user := pp.auth.GetUser(ctx) - if pp.policy.CanRead(user, m) { - return m, nil - } - return nil, place.NewErrNotAllowed("GetMeta", user, zid) -} - -func (pp *polPlace) FetchZids(ctx context.Context) (id.Set, error) { - return nil, place.NewErrNotAllowed("fetch-zids", pp.auth.GetUser(ctx), id.Invalid) -} - -func (pp *polPlace) SelectMeta(ctx context.Context, s *search.Search) ([]*meta.Meta, error) { - user := pp.auth.GetUser(ctx) - canRead := pp.policy.CanRead - s = s.AddPreMatch(func(m *meta.Meta) bool { return canRead(user, m) }) - return pp.place.SelectMeta(ctx, s) -} - -func (pp *polPlace) CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool { - return pp.place.CanUpdateZettel(ctx, zettel) -} - -func (pp *polPlace) UpdateZettel(ctx context.Context, zettel domain.Zettel) error { - zid := zettel.Meta.Zid - user := pp.auth.GetUser(ctx) - if !zid.IsValid() { - return &place.ErrInvalidID{Zid: zid} - } - // Write existing zettel - oldMeta, err := pp.place.GetMeta(ctx, zid) - if err != nil { - return err - } - if pp.policy.CanWrite(user, oldMeta, zettel.Meta) { - return pp.place.UpdateZettel(ctx, zettel) - } - return place.NewErrNotAllowed("Write", user, zid) -} - -func (pp *polPlace) AllowRenameZettel(ctx context.Context, zid id.Zid) bool { - return pp.place.AllowRenameZettel(ctx, zid) -} - -func (pp *polPlace) RenameZettel(ctx context.Context, curZid, newZid id.Zid) error { - meta, err := pp.place.GetMeta(ctx, curZid) - if err != nil { - return err - } - user := pp.auth.GetUser(ctx) - if pp.policy.CanRename(user, meta) { - return pp.place.RenameZettel(ctx, curZid, newZid) - } - return place.NewErrNotAllowed("Rename", user, curZid) -} - -func (pp *polPlace) CanDeleteZettel(ctx context.Context, zid id.Zid) bool { - return pp.place.CanDeleteZettel(ctx, zid) -} - -func (pp *polPlace) DeleteZettel(ctx context.Context, zid id.Zid) error { - meta, err := pp.place.GetMeta(ctx, zid) - if err != nil { - return err - } - user := pp.auth.GetUser(ctx) - if pp.policy.CanDelete(user, meta) { - return pp.place.DeleteZettel(ctx, zid) - } - return place.NewErrNotAllowed("Delete", user, zid) -} - -func (pp *polPlace) ReadStats(st *place.Stats) { - pp.place.ReadStats(st) -} - -func (pp *polPlace) Dump(w io.Writer) { - pp.place.Dump(w) -} Index: auth/policy/policy_test.go ================================================================== --- auth/policy/policy_test.go +++ auth/policy/policy_test.go @@ -19,10 +19,11 @@ "zettelstore.de/z/domain/id" "zettelstore.de/z/domain/meta" ) func TestPolicies(t *testing.T) { + t.Parallel() testScene := []struct { readonly bool withAuth bool expert bool }{ @@ -86,25 +87,19 @@ func (ac *authConfig) GetExpertMode() bool { return ac.expert } func (ac *authConfig) GetVisibility(m *meta.Meta) meta.Visibility { if vis, ok := m.Get(meta.KeyVisibility); ok { - switch vis { - case meta.ValueVisibilityPublic: - return meta.VisibilityPublic - case meta.ValueVisibilityOwner: - return meta.VisibilityOwner - case meta.ValueVisibilityExpert: - return meta.VisibilityExpert - } + return meta.GetVisibility(vis) } return meta.VisibilityLogin } func testCreate(t *testing.T, pol auth.Policy, withAuth, readonly, isExpert bool) { t.Helper() anonUser := newAnon() + creator := newCreator() reader := newReader() writer := newWriter() owner := newOwner() owner2 := newOwner2() zettel := newZettel() @@ -114,22 +109,25 @@ meta *meta.Meta exp bool }{ // No meta {anonUser, nil, false}, + {creator, nil, false}, {reader, nil, false}, {writer, nil, false}, {owner, nil, false}, {owner2, nil, false}, // Ordinary zettel {anonUser, zettel, !withAuth && !readonly}, + {creator, zettel, !readonly}, {reader, zettel, !withAuth && !readonly}, {writer, zettel, !readonly}, {owner, zettel, !readonly}, {owner2, zettel, !readonly}, // User zettel {anonUser, userZettel, !withAuth && !readonly}, + {creator, userZettel, !withAuth && !readonly}, {reader, userZettel, !withAuth && !readonly}, {writer, userZettel, !withAuth && !readonly}, {owner, userZettel, !readonly}, {owner2, userZettel, !readonly}, } @@ -144,16 +142,18 @@ } func testRead(t *testing.T, pol auth.Policy, withAuth, readonly, expert bool) { t.Helper() anonUser := newAnon() + creator := newCreator() reader := newReader() writer := newWriter() owner := newOwner() owner2 := newOwner2() zettel := newZettel() publicZettel := newPublicZettel() + creatorZettel := newCreatorZettel() loginZettel := newLoginZettel() ownerZettel := newOwnerZettel() expertZettel := newExpertZettel() userZettel := newUserZettel() testCases := []struct { @@ -161,51 +161,66 @@ meta *meta.Meta exp bool }{ // No meta {anonUser, nil, false}, + {creator, nil, false}, {reader, nil, false}, {writer, nil, false}, {owner, nil, false}, {owner2, nil, false}, // Ordinary zettel {anonUser, zettel, !withAuth}, + {creator, zettel, !withAuth}, {reader, zettel, true}, {writer, zettel, true}, {owner, zettel, true}, {owner2, zettel, true}, // Public zettel {anonUser, publicZettel, true}, + {creator, publicZettel, true}, {reader, publicZettel, true}, {writer, publicZettel, true}, {owner, publicZettel, true}, {owner2, publicZettel, true}, + // Creator zettel + {anonUser, creatorZettel, !withAuth}, + {creator, creatorZettel, true}, + {reader, creatorZettel, true}, + {writer, creatorZettel, true}, + {owner, creatorZettel, true}, + {owner2, creatorZettel, true}, // Login zettel {anonUser, loginZettel, !withAuth}, + {creator, loginZettel, !withAuth}, {reader, loginZettel, true}, {writer, loginZettel, true}, {owner, loginZettel, true}, {owner2, loginZettel, true}, // Owner zettel {anonUser, ownerZettel, !withAuth}, + {creator, ownerZettel, !withAuth}, {reader, ownerZettel, !withAuth}, {writer, ownerZettel, !withAuth}, {owner, ownerZettel, true}, {owner2, ownerZettel, true}, // Expert zettel {anonUser, expertZettel, !withAuth && expert}, + {creator, expertZettel, !withAuth && expert}, {reader, expertZettel, !withAuth && expert}, {writer, expertZettel, !withAuth && expert}, {owner, expertZettel, expert}, {owner2, expertZettel, expert}, // Other user zettel {anonUser, userZettel, !withAuth}, + {creator, userZettel, !withAuth}, {reader, userZettel, !withAuth}, {writer, userZettel, !withAuth}, {owner, userZettel, true}, {owner2, userZettel, true}, // Own user zettel + {creator, creator, true}, {reader, reader, true}, {writer, writer, true}, {owner, owner, true}, {owner, owner2, true}, {owner2, owner, true}, @@ -222,10 +237,11 @@ } func testWrite(t *testing.T, pol auth.Policy, withAuth, readonly, expert bool) { t.Helper() anonUser := newAnon() + creator := newCreator() reader := newReader() writer := newWriter() owner := newOwner() owner2 := newOwner2() zettel := newZettel() @@ -248,101 +264,117 @@ new *meta.Meta exp bool }{ // No old and new meta {anonUser, nil, nil, false}, + {creator, nil, nil, false}, {reader, nil, nil, false}, {writer, nil, nil, false}, {owner, nil, nil, false}, {owner2, nil, nil, false}, // No old meta {anonUser, nil, zettel, false}, + {creator, nil, zettel, false}, {reader, nil, zettel, false}, {writer, nil, zettel, false}, {owner, nil, zettel, false}, {owner2, nil, zettel, false}, // No new meta {anonUser, zettel, nil, false}, + {creator, zettel, nil, false}, {reader, zettel, nil, false}, {writer, zettel, nil, false}, {owner, zettel, nil, false}, {owner2, zettel, nil, false}, // Old an new zettel have different zettel identifier {anonUser, zettel, publicZettel, false}, + {creator, zettel, publicZettel, false}, {reader, zettel, publicZettel, false}, {writer, zettel, publicZettel, false}, {owner, zettel, publicZettel, false}, {owner2, zettel, publicZettel, false}, // Overwrite a normal zettel {anonUser, zettel, zettel, notAuthNotReadonly}, + {creator, zettel, zettel, notAuthNotReadonly}, {reader, zettel, zettel, notAuthNotReadonly}, {writer, zettel, zettel, !readonly}, {owner, zettel, zettel, !readonly}, {owner2, zettel, zettel, !readonly}, // Public zettel {anonUser, publicZettel, publicZettel, notAuthNotReadonly}, + {creator, publicZettel, publicZettel, notAuthNotReadonly}, {reader, publicZettel, publicZettel, notAuthNotReadonly}, {writer, publicZettel, publicZettel, !readonly}, {owner, publicZettel, publicZettel, !readonly}, {owner2, publicZettel, publicZettel, !readonly}, // Login zettel {anonUser, loginZettel, loginZettel, notAuthNotReadonly}, + {creator, loginZettel, loginZettel, notAuthNotReadonly}, {reader, loginZettel, loginZettel, notAuthNotReadonly}, {writer, loginZettel, loginZettel, !readonly}, {owner, loginZettel, loginZettel, !readonly}, {owner2, loginZettel, loginZettel, !readonly}, // Owner zettel {anonUser, ownerZettel, ownerZettel, notAuthNotReadonly}, + {creator, ownerZettel, ownerZettel, notAuthNotReadonly}, {reader, ownerZettel, ownerZettel, notAuthNotReadonly}, {writer, ownerZettel, ownerZettel, notAuthNotReadonly}, {owner, ownerZettel, ownerZettel, !readonly}, {owner2, ownerZettel, ownerZettel, !readonly}, // Expert zettel {anonUser, expertZettel, expertZettel, notAuthNotReadonly && expert}, + {creator, expertZettel, expertZettel, notAuthNotReadonly && expert}, {reader, expertZettel, expertZettel, notAuthNotReadonly && expert}, {writer, expertZettel, expertZettel, notAuthNotReadonly && expert}, {owner, expertZettel, expertZettel, !readonly && expert}, {owner2, expertZettel, expertZettel, !readonly && expert}, // Other user zettel {anonUser, userZettel, userZettel, notAuthNotReadonly}, + {creator, userZettel, userZettel, notAuthNotReadonly}, {reader, userZettel, userZettel, notAuthNotReadonly}, {writer, userZettel, userZettel, notAuthNotReadonly}, {owner, userZettel, userZettel, !readonly}, {owner2, userZettel, userZettel, !readonly}, // Own user zettel + {creator, creator, creator, !readonly}, {reader, reader, reader, !readonly}, {writer, writer, writer, !readonly}, {owner, owner, owner, !readonly}, {owner2, owner2, owner2, !readonly}, // Writer cannot change importand metadata of its own user zettel {writer, writer, writerNew, notAuthNotReadonly}, // No r/o zettel {anonUser, roFalse, roFalse, notAuthNotReadonly}, + {creator, roFalse, roFalse, notAuthNotReadonly}, {reader, roFalse, roFalse, notAuthNotReadonly}, {writer, roFalse, roFalse, !readonly}, {owner, roFalse, roFalse, !readonly}, {owner2, roFalse, roFalse, !readonly}, // Reader r/o zettel {anonUser, roReader, roReader, false}, + {creator, roReader, roReader, false}, {reader, roReader, roReader, false}, {writer, roReader, roReader, !readonly}, {owner, roReader, roReader, !readonly}, {owner2, roReader, roReader, !readonly}, // Writer r/o zettel {anonUser, roWriter, roWriter, false}, + {creator, roWriter, roWriter, false}, {reader, roWriter, roWriter, false}, {writer, roWriter, roWriter, false}, {owner, roWriter, roWriter, !readonly}, {owner2, roWriter, roWriter, !readonly}, // Owner r/o zettel {anonUser, roOwner, roOwner, false}, + {creator, roOwner, roOwner, false}, {reader, roOwner, roOwner, false}, {writer, roOwner, roOwner, false}, {owner, roOwner, roOwner, false}, {owner2, roOwner, roOwner, false}, // r/o = true zettel {anonUser, roTrue, roTrue, false}, + {creator, roTrue, roTrue, false}, {reader, roTrue, roTrue, false}, {writer, roTrue, roTrue, false}, {owner, roTrue, roTrue, false}, {owner2, roTrue, roTrue, false}, } @@ -357,10 +389,11 @@ } func testRename(t *testing.T, pol auth.Policy, withAuth, readonly, expert bool) { t.Helper() anonUser := newAnon() + creator := newCreator() reader := newReader() writer := newWriter() owner := newOwner() owner2 := newOwner2() zettel := newZettel() @@ -376,52 +409,60 @@ meta *meta.Meta exp bool }{ // No meta {anonUser, nil, false}, + {creator, nil, false}, {reader, nil, false}, {writer, nil, false}, {owner, nil, false}, {owner2, nil, false}, // Any zettel {anonUser, zettel, notAuthNotReadonly}, + {creator, zettel, notAuthNotReadonly}, {reader, zettel, notAuthNotReadonly}, {writer, zettel, notAuthNotReadonly}, {owner, zettel, !readonly}, {owner2, zettel, !readonly}, // Expert zettel {anonUser, expertZettel, notAuthNotReadonly && expert}, + {creator, expertZettel, notAuthNotReadonly && expert}, {reader, expertZettel, notAuthNotReadonly && expert}, {writer, expertZettel, notAuthNotReadonly && expert}, {owner, expertZettel, !readonly && expert}, {owner2, expertZettel, !readonly && expert}, // No r/o zettel {anonUser, roFalse, notAuthNotReadonly}, + {creator, roFalse, notAuthNotReadonly}, {reader, roFalse, notAuthNotReadonly}, {writer, roFalse, notAuthNotReadonly}, {owner, roFalse, !readonly}, {owner2, roFalse, !readonly}, // Reader r/o zettel {anonUser, roReader, false}, + {creator, roReader, false}, {reader, roReader, false}, {writer, roReader, notAuthNotReadonly}, {owner, roReader, !readonly}, {owner2, roReader, !readonly}, // Writer r/o zettel {anonUser, roWriter, false}, + {creator, roWriter, false}, {reader, roWriter, false}, {writer, roWriter, false}, {owner, roWriter, !readonly}, {owner2, roWriter, !readonly}, // Owner r/o zettel {anonUser, roOwner, false}, + {creator, roOwner, false}, {reader, roOwner, false}, {writer, roOwner, false}, {owner, roOwner, false}, {owner2, roOwner, false}, // r/o = true zettel {anonUser, roTrue, false}, + {creator, roTrue, false}, {reader, roTrue, false}, {writer, roTrue, false}, {owner, roTrue, false}, {owner2, roTrue, false}, } @@ -436,10 +477,11 @@ } func testDelete(t *testing.T, pol auth.Policy, withAuth, readonly, expert bool) { t.Helper() anonUser := newAnon() + creator := newCreator() reader := newReader() writer := newWriter() owner := newOwner() owner2 := newOwner2() zettel := newZettel() @@ -455,52 +497,60 @@ meta *meta.Meta exp bool }{ // No meta {anonUser, nil, false}, + {creator, nil, false}, {reader, nil, false}, {writer, nil, false}, {owner, nil, false}, {owner2, nil, false}, // Any zettel {anonUser, zettel, notAuthNotReadonly}, + {creator, zettel, notAuthNotReadonly}, {reader, zettel, notAuthNotReadonly}, {writer, zettel, notAuthNotReadonly}, {owner, zettel, !readonly}, {owner2, zettel, !readonly}, // Expert zettel {anonUser, expertZettel, notAuthNotReadonly && expert}, + {creator, expertZettel, notAuthNotReadonly && expert}, {reader, expertZettel, notAuthNotReadonly && expert}, {writer, expertZettel, notAuthNotReadonly && expert}, {owner, expertZettel, !readonly && expert}, {owner2, expertZettel, !readonly && expert}, // No r/o zettel {anonUser, roFalse, notAuthNotReadonly}, + {creator, roFalse, notAuthNotReadonly}, {reader, roFalse, notAuthNotReadonly}, {writer, roFalse, notAuthNotReadonly}, {owner, roFalse, !readonly}, {owner2, roFalse, !readonly}, // Reader r/o zettel {anonUser, roReader, false}, + {creator, roReader, false}, {reader, roReader, false}, {writer, roReader, notAuthNotReadonly}, {owner, roReader, !readonly}, {owner2, roReader, !readonly}, // Writer r/o zettel {anonUser, roWriter, false}, + {creator, roWriter, false}, {reader, roWriter, false}, {writer, roWriter, false}, {owner, roWriter, !readonly}, {owner2, roWriter, !readonly}, // Owner r/o zettel {anonUser, roOwner, false}, + {creator, roOwner, false}, {reader, roOwner, false}, {writer, roOwner, false}, {owner, roOwner, false}, {owner2, roOwner, false}, // r/o = true zettel {anonUser, roTrue, false}, + {creator, roTrue, false}, {reader, roTrue, false}, {writer, roTrue, false}, {owner, roTrue, false}, {owner2, roTrue, false}, } @@ -513,20 +563,28 @@ }) } } const ( - readerZid = id.Zid(1013) - writerZid = id.Zid(1015) - ownerZid = id.Zid(1017) - owner2Zid = id.Zid(1019) - zettelZid = id.Zid(1021) - visZid = id.Zid(1023) - userZid = id.Zid(1025) + creatorZid = id.Zid(1013) + readerZid = id.Zid(1013) + writerZid = id.Zid(1015) + ownerZid = id.Zid(1017) + owner2Zid = id.Zid(1019) + zettelZid = id.Zid(1021) + visZid = id.Zid(1023) + userZid = id.Zid(1025) ) func newAnon() *meta.Meta { return nil } +func newCreator() *meta.Meta { + user := meta.New(creatorZid) + user.Set(meta.KeyTitle, "Creator") + user.Set(meta.KeyRole, meta.ValueRoleUser) + user.Set(meta.KeyUserRole, meta.ValueUserRoleCreator) + return user +} func newReader() *meta.Meta { user := meta.New(readerZid) user.Set(meta.KeyTitle, "Reader") user.Set(meta.KeyRole, meta.ValueRoleUser) user.Set(meta.KeyUserRole, meta.ValueUserRoleReader) @@ -561,10 +619,16 @@ func newPublicZettel() *meta.Meta { m := meta.New(visZid) m.Set(meta.KeyTitle, "Public Zettel") m.Set(meta.KeyVisibility, meta.ValueVisibilityPublic) return m +} +func newCreatorZettel() *meta.Meta { + m := meta.New(visZid) + m.Set(meta.KeyTitle, "Creator Zettel") + m.Set(meta.KeyVisibility, meta.ValueVisibilityCreator) + return m } func newLoginZettel() *meta.Meta { m := meta.New(visZid) m.Set(meta.KeyTitle, "Login Zettel") m.Set(meta.KeyVisibility, meta.ValueVisibilityLogin) ADDED box/box.go Index: box/box.go ================================================================== --- box/box.go +++ box/box.go @@ -0,0 +1,274 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package box provides a generic interface to zettel boxes. +package box + +import ( + "context" + "errors" + "fmt" + "io" + "time" + + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/search" +) + +// BaseBox is implemented by all Zettel boxes. +type BaseBox interface { + // Location returns some information where the box is located. + // Format is dependent of the box. + Location() string + + // CanCreateZettel returns true, if box could possibly create a new zettel. + CanCreateZettel(ctx context.Context) bool + + // CreateZettel creates a new zettel. + // Returns the new zettel id (and an error indication). + CreateZettel(ctx context.Context, zettel domain.Zettel) (id.Zid, error) + + // GetZettel retrieves a specific zettel. + GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) + + // GetMeta retrieves just the meta data of a specific zettel. + GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) + + // FetchZids returns the set of all zettel identifer managed by the box. + FetchZids(ctx context.Context) (id.Set, error) + + // CanUpdateZettel returns true, if box could possibly update the given zettel. + CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool + + // UpdateZettel updates an existing zettel. + UpdateZettel(ctx context.Context, zettel domain.Zettel) error + + // AllowRenameZettel returns true, if box will not disallow renaming the zettel. + AllowRenameZettel(ctx context.Context, zid id.Zid) bool + + // RenameZettel changes the current Zid to a new Zid. + RenameZettel(ctx context.Context, curZid, newZid id.Zid) error + + // CanDeleteZettel returns true, if box could possibly delete the given zettel. + CanDeleteZettel(ctx context.Context, zid id.Zid) bool + + // DeleteZettel removes the zettel from the box. + DeleteZettel(ctx context.Context, zid id.Zid) error +} + +// ManagedBox is the interface of managed boxes. +type ManagedBox interface { + BaseBox + + // SelectMeta returns all zettel meta data that match the selection criteria. + SelectMeta(ctx context.Context, match search.MetaMatchFunc) ([]*meta.Meta, error) + + // ReadStats populates st with box statistics + ReadStats(st *ManagedBoxStats) +} + +// ManagedBoxStats records statistics about the box. +type ManagedBoxStats struct { + // ReadOnly indicates that the content of a box cannot change. + ReadOnly bool + + // Zettel is the number of zettel managed by the box. + Zettel int +} + +// StartStopper performs simple lifecycle management. +type StartStopper interface { + // Start the box. Now all other functions of the box are allowed. + // Starting an already started box is not allowed. + Start(ctx context.Context) error + + // Stop the started box. Now only the Start() function is allowed. + Stop(ctx context.Context) error +} + +// Box is to be used outside the box package and its descendants. +type Box interface { + BaseBox + + // SelectMeta returns a list of metadata that comply to the given selection criteria. + SelectMeta(ctx context.Context, s *search.Search) ([]*meta.Meta, error) + + // GetAllZettel retrieves a specific zettel from all managed boxes. + GetAllZettel(ctx context.Context, zid id.Zid) ([]domain.Zettel, error) + + // GetAllMeta retrieves the meta data of a specific zettel from all managed boxes. + GetAllMeta(ctx context.Context, zid id.Zid) ([]*meta.Meta, error) +} + +// Stats record stattistics about a box. +type Stats struct { + // ReadOnly indicates that boxes cannot be modified. + ReadOnly bool + + // NumManagedBoxes is the number of boxes managed. + NumManagedBoxes int + + // Zettel is the number of zettel managed by the box, including + // duplicates across managed boxes. + ZettelTotal int + + // LastReload stores the timestamp when a full re-index was done. + LastReload time.Time + + // DurLastReload is the duration of the last full re-index run. + DurLastReload time.Duration + + // IndexesSinceReload counts indexing a zettel since the full re-index. + IndexesSinceReload uint64 + + // ZettelIndexed is the number of zettel managed by the indexer. + ZettelIndexed int + + // IndexUpdates count the number of metadata updates. + IndexUpdates uint64 + + // IndexedWords count the different words indexed. + IndexedWords uint64 + + // IndexedUrls count the different URLs indexed. + IndexedUrls uint64 +} + +// Manager is a box-managing box. +type Manager interface { + Box + StartStopper + Subject + + // ReadStats populates st with box statistics + ReadStats(st *Stats) + + // Dump internal data to a Writer. + Dump(w io.Writer) +} + +// UpdateReason gives an indication, why the ObserverFunc was called. +type UpdateReason uint8 + +// Values for Reason +const ( + _ UpdateReason = iota + OnReload // Box was reloaded + OnUpdate // A zettel was created or changed + OnDelete // A zettel was removed +) + +// UpdateInfo contains all the data about a changed zettel. +type UpdateInfo struct { + Box Box + Reason UpdateReason + Zid id.Zid +} + +// UpdateFunc is a function to be called when a change is detected. +type UpdateFunc func(UpdateInfo) + +// Subject is a box that notifies observers about changes. +type Subject interface { + // RegisterObserver registers an observer that will be notified + // if one or all zettel are found to be changed. + RegisterObserver(UpdateFunc) +} + +// Enricher is used to update metadata by adding new properties. +type Enricher interface { + // Enrich computes additional properties and updates the given metadata. + // It is typically called by zettel reading methods. + Enrich(ctx context.Context, m *meta.Meta, boxNumber int) +} + +// NoEnrichContext will signal an enricher that nothing has to be done. +// This is useful for an Indexer, but also for some box.Box calls, when +// just the plain metadata is needed. +func NoEnrichContext(ctx context.Context) context.Context { + return context.WithValue(ctx, ctxNoEnrichKey, &ctxNoEnrichKey) +} + +type ctxNoEnrichType struct{} + +var ctxNoEnrichKey ctxNoEnrichType + +// DoNotEnrich determines if the context is marked to not enrich metadata. +func DoNotEnrich(ctx context.Context) bool { + _, ok := ctx.Value(ctxNoEnrichKey).(*ctxNoEnrichType) + return ok +} + +// ErrNotAllowed is returned if the caller is not allowed to perform the operation. +type ErrNotAllowed struct { + Op string + User *meta.Meta + Zid id.Zid +} + +// NewErrNotAllowed creates an new authorization error. +func NewErrNotAllowed(op string, user *meta.Meta, zid id.Zid) error { + return &ErrNotAllowed{ + Op: op, + User: user, + Zid: zid, + } +} + +func (err *ErrNotAllowed) Error() string { + if err.User == nil { + if err.Zid.IsValid() { + return fmt.Sprintf( + "operation %q on zettel %v not allowed for not authorized user", + err.Op, + err.Zid.String()) + } + return fmt.Sprintf("operation %q not allowed for not authorized user", err.Op) + } + if err.Zid.IsValid() { + return fmt.Sprintf( + "operation %q on zettel %v not allowed for user %v/%v", + err.Op, + err.Zid.String(), + err.User.GetDefault(meta.KeyUserID, "?"), + err.User.Zid.String()) + } + return fmt.Sprintf( + "operation %q not allowed for user %v/%v", + err.Op, + err.User.GetDefault(meta.KeyUserID, "?"), + err.User.Zid.String()) +} + +// Is return true, if the error is of type ErrNotAllowed. +func (err *ErrNotAllowed) Is(target error) bool { return true } + +// ErrStarted is returned when trying to start an already started box. +var ErrStarted = errors.New("box is already started") + +// ErrStopped is returned if calling methods on a box that was not started. +var ErrStopped = errors.New("box is stopped") + +// ErrReadOnly is returned if there is an attepmt to write to a read-only box. +var ErrReadOnly = errors.New("read-only box") + +// ErrNotFound is returned if a zettel was not found in the box. +var ErrNotFound = errors.New("zettel not found") + +// ErrConflict is returned if a box operation detected a conflict.. +// One example: if calculating a new zettel identifier takes too long. +var ErrConflict = errors.New("conflict") + +// ErrInvalidID is returned if the zettel id is not appropriate for the box operation. +type ErrInvalidID struct{ Zid id.Zid } + +func (err *ErrInvalidID) Error() string { return "invalid Zettel id: " + err.Zid.String() } ADDED box/compbox/compbox.go Index: box/compbox/compbox.go ================================================================== --- box/compbox/compbox.go +++ box/compbox/compbox.go @@ -0,0 +1,167 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package compbox provides zettel that have computed content. +package compbox + +import ( + "context" + "net/url" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/manager" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/search" +) + +func init() { + manager.Register( + " comp", + func(u *url.URL, cdata *manager.ConnectData) (box.ManagedBox, error) { + return getCompBox(cdata.Number, cdata.Enricher), nil + }) +} + +type compBox struct { + number int + enricher box.Enricher +} + +var myConfig *meta.Meta +var myZettel = map[id.Zid]struct { + meta func(id.Zid) *meta.Meta + content func(*meta.Meta) string +}{ + id.VersionZid: {genVersionBuildM, genVersionBuildC}, + id.HostZid: {genVersionHostM, genVersionHostC}, + id.OperatingSystemZid: {genVersionOSM, genVersionOSC}, + id.BoxManagerZid: {genManagerM, genManagerC}, + id.MetadataKeyZid: {genKeysM, genKeysC}, + id.StartupConfigurationZid: {genConfigZettelM, genConfigZettelC}, +} + +// Get returns the one program box. +func getCompBox(boxNumber int, mf box.Enricher) box.ManagedBox { + return &compBox{number: boxNumber, enricher: mf} +} + +// Setup remembers important values. +func Setup(cfg *meta.Meta) { myConfig = cfg.Clone() } + +func (pp *compBox) Location() string { return "" } + +func (pp *compBox) CanCreateZettel(ctx context.Context) bool { return false } + +func (pp *compBox) CreateZettel( + ctx context.Context, zettel domain.Zettel) (id.Zid, error) { + return id.Invalid, box.ErrReadOnly +} + +func (pp *compBox) GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) { + if gen, ok := myZettel[zid]; ok && gen.meta != nil { + if m := gen.meta(zid); m != nil { + updateMeta(m) + if genContent := gen.content; genContent != nil { + return domain.Zettel{ + Meta: m, + Content: domain.NewContent(genContent(m)), + }, nil + } + return domain.Zettel{Meta: m}, nil + } + } + return domain.Zettel{}, box.ErrNotFound +} + +func (pp *compBox) GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) { + if gen, ok := myZettel[zid]; ok { + if genMeta := gen.meta; genMeta != nil { + if m := genMeta(zid); m != nil { + updateMeta(m) + return m, nil + } + } + } + return nil, box.ErrNotFound +} + +func (pp *compBox) FetchZids(ctx context.Context) (id.Set, error) { + result := id.NewSetCap(len(myZettel)) + for zid, gen := range myZettel { + if genMeta := gen.meta; genMeta != nil { + if genMeta(zid) != nil { + result[zid] = true + } + } + } + return result, nil +} + +func (pp *compBox) SelectMeta(ctx context.Context, match search.MetaMatchFunc) (res []*meta.Meta, err error) { + for zid, gen := range myZettel { + if genMeta := gen.meta; genMeta != nil { + if m := genMeta(zid); m != nil { + updateMeta(m) + pp.enricher.Enrich(ctx, m, pp.number) + if match(m) { + res = append(res, m) + } + } + } + } + return res, nil +} + +func (pp *compBox) CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool { + return false +} + +func (pp *compBox) UpdateZettel(ctx context.Context, zettel domain.Zettel) error { + return box.ErrReadOnly +} + +func (pp *compBox) AllowRenameZettel(ctx context.Context, zid id.Zid) bool { + _, ok := myZettel[zid] + return !ok +} + +func (pp *compBox) RenameZettel(ctx context.Context, curZid, newZid id.Zid) error { + if _, ok := myZettel[curZid]; ok { + return box.ErrReadOnly + } + return box.ErrNotFound +} + +func (pp *compBox) CanDeleteZettel(ctx context.Context, zid id.Zid) bool { return false } + +func (pp *compBox) DeleteZettel(ctx context.Context, zid id.Zid) error { + if _, ok := myZettel[zid]; ok { + return box.ErrReadOnly + } + return box.ErrNotFound +} + +func (pp *compBox) ReadStats(st *box.ManagedBoxStats) { + st.ReadOnly = true + st.Zettel = len(myZettel) +} + +func updateMeta(m *meta.Meta) { + m.Set(meta.KeyNoIndex, meta.ValueTrue) + m.Set(meta.KeySyntax, meta.ValueSyntaxZmk) + m.Set(meta.KeyRole, meta.ValueRoleConfiguration) + m.Set(meta.KeyLang, meta.ValueLangEN) + m.Set(meta.KeyReadOnly, meta.ValueTrue) + if _, ok := m.Get(meta.KeyVisibility); !ok { + m.Set(meta.KeyVisibility, meta.ValueVisibilityExpert) + } +} ADDED box/compbox/config.go Index: box/compbox/config.go ================================================================== --- box/compbox/config.go +++ box/compbox/config.go @@ -0,0 +1,52 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package compbox provides zettel that have computed content. +package compbox + +import ( + "strings" + + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" +) + +func genConfigZettelM(zid id.Zid) *meta.Meta { + if myConfig == nil { + return nil + } + m := meta.New(zid) + m.Set(meta.KeyTitle, "Zettelstore Startup Configuration") + m.Set(meta.KeyVisibility, meta.ValueVisibilityExpert) + return m +} + +func genConfigZettelC(m *meta.Meta) string { + var sb strings.Builder + for i, p := range myConfig.Pairs(false) { + if i > 0 { + sb.WriteByte('\n') + } + sb.WriteString("; ''") + sb.WriteString(p.Key) + sb.WriteString("''") + if p.Value != "" { + sb.WriteString("\n: ``") + for _, r := range p.Value { + if r == '`' { + sb.WriteByte('\\') + } + sb.WriteRune(r) + } + sb.WriteString("``") + } + } + return sb.String() +} ADDED box/compbox/keys.go Index: box/compbox/keys.go ================================================================== --- box/compbox/keys.go +++ box/compbox/keys.go @@ -0,0 +1,38 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package compbox provides zettel that have computed content. +package compbox + +import ( + "fmt" + "strings" + + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" +) + +func genKeysM(zid id.Zid) *meta.Meta { + m := meta.New(zid) + m.Set(meta.KeyTitle, "Zettelstore Supported Metadata Keys") + m.Set(meta.KeyVisibility, meta.ValueVisibilityLogin) + return m +} + +func genKeysC(*meta.Meta) string { + keys := meta.GetSortedKeyDescriptions() + var sb strings.Builder + sb.WriteString("|=Name<|=Type<|=Computed?:|=Property?:\n") + for _, kd := range keys { + fmt.Fprintf(&sb, + "|%v|%v|%v|%v\n", kd.Name, kd.Type.Name, kd.IsComputed(), kd.IsProperty()) + } + return sb.String() +} ADDED box/compbox/manager.go Index: box/compbox/manager.go ================================================================== --- box/compbox/manager.go +++ box/compbox/manager.go @@ -0,0 +1,40 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package compbox provides zettel that have computed content. +package compbox + +import ( + "fmt" + "strings" + + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/kernel" +) + +func genManagerM(zid id.Zid) *meta.Meta { + m := meta.New(zid) + m.Set(meta.KeyTitle, "Zettelstore Box Manager") + return m +} + +func genManagerC(*meta.Meta) string { + kvl := kernel.Main.GetServiceStatistics(kernel.BoxService) + if len(kvl) == 0 { + return "No statistics available" + } + var sb strings.Builder + sb.WriteString("|=Name|=Value>\n") + for _, kv := range kvl { + fmt.Fprintf(&sb, "| %v | %v\n", kv.Key, kv.Value) + } + return sb.String() +} ADDED box/compbox/version.go Index: box/compbox/version.go ================================================================== --- box/compbox/version.go +++ box/compbox/version.go @@ -0,0 +1,54 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package compbox provides zettel that have computed content. +package compbox + +import ( + "fmt" + + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/kernel" +) + +func getVersionMeta(zid id.Zid, title string) *meta.Meta { + m := meta.New(zid) + m.Set(meta.KeyTitle, title) + m.Set(meta.KeyVisibility, meta.ValueVisibilityExpert) + return m +} + +func genVersionBuildM(zid id.Zid) *meta.Meta { + m := getVersionMeta(zid, "Zettelstore Version") + m.Set(meta.KeyVisibility, meta.ValueVisibilityPublic) + return m +} +func genVersionBuildC(*meta.Meta) string { + return kernel.Main.GetConfig(kernel.CoreService, kernel.CoreVersion).(string) +} + +func genVersionHostM(zid id.Zid) *meta.Meta { + return getVersionMeta(zid, "Zettelstore Host") +} +func genVersionHostC(*meta.Meta) string { + return kernel.Main.GetConfig(kernel.CoreService, kernel.CoreHostname).(string) +} + +func genVersionOSM(zid id.Zid) *meta.Meta { + return getVersionMeta(zid, "Zettelstore Operating System") +} +func genVersionOSC(*meta.Meta) string { + return fmt.Sprintf( + "%v/%v", + kernel.Main.GetConfig(kernel.CoreService, kernel.CoreGoOS).(string), + kernel.Main.GetConfig(kernel.CoreService, kernel.CoreGoArch).(string), + ) +} ADDED box/constbox/base.css Index: box/constbox/base.css ================================================================== --- box/constbox/base.css +++ box/constbox/base.css @@ -0,0 +1,279 @@ +*,*::before,*::after { + box-sizing: border-box; + } + html { + font-size: 1rem; + font-family: serif; + scroll-behavior: smooth; + height: 100%; + } + body { + margin: 0; + min-height: 100vh; + text-rendering: optimizeSpeed; + line-height: 1.4; + overflow-x: hidden; + background-color: #f8f8f8 ; + height: 100%; + } + nav.zs-menu { + background-color: hsl(210, 28%, 90%); + overflow: auto; + white-space: nowrap; + font-family: sans-serif; + padding-left: .5rem; + } + nav.zs-menu > a { + float:left; + display: block; + text-align: center; + padding:.41rem .5rem; + text-decoration: none; + color:black; + } + nav.zs-menu > a:hover, .zs-dropdown:hover button { + background-color: hsl(210, 28%, 80%); + } + nav.zs-menu form { + float: right; + } + nav.zs-menu form input[type=text] { + padding: .12rem; + border: none; + margin-top: .25rem; + margin-right: .5rem; + } + .zs-dropdown { + float: left; + overflow: hidden; + } + .zs-dropdown > button { + font-size: 16px; + border: none; + outline: none; + color: black; + padding:.41rem .5rem; + background-color: inherit; + font-family: inherit; + margin: 0; + } + .zs-dropdown-content { + display: none; + position: absolute; + background-color: #f9f9f9; + min-width: 160px; + box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2); + z-index: 1; + } + .zs-dropdown-content > a { + float: none; + color: black; + padding:.41rem .5rem; + text-decoration: none; + display: block; + text-align: left; + } + .zs-dropdown-content > a:hover { + background-color: hsl(210, 28%, 75%); + } + .zs-dropdown:hover > .zs-dropdown-content { + display: block; + } + main { + padding: 0 1rem; + } + article > * + * { + margin-top: .5rem; + } + article header { + padding: 0; + margin: 0; + } + h1,h2,h3,h4,h5,h6 { font-family:sans-serif; font-weight:normal } + h1 { font-size:1.5rem; margin:.65rem 0 } + h2 { font-size:1.25rem; margin:.70rem 0 } + h3 { font-size:1.15rem; margin:.75rem 0 } + h4 { font-size:1.05rem; margin:.8rem 0; font-weight: bold } + h5 { font-size:1.05rem; margin:.8rem 0 } + h6 { font-size:1.05rem; margin:.8rem 0; font-weight: lighter } + p { + margin: .5rem 0 0 0; + } + ol,ul { + padding-left: 1.1rem; + } + li,figure,figcaption,dl { + margin: 0; + } + dt { + margin: .5rem 0 0 0; + } + dt+dd { + margin-top: 0; + } + dd { + margin: .5rem 0 0 2rem; + } + dd > p:first-child { + margin: 0 0 0 0; + } + blockquote { + border-left: 0.5rem solid lightgray; + padding-left: 1rem; + margin-left: 1rem; + margin-right: 2rem; + font-style: italic; + } + blockquote p { + margin-bottom: .5rem; + } + blockquote cite { + font-style: normal; + } + table { + border-collapse: collapse; + border-spacing: 0; + max-width: 100%; + } + th,td { + text-align: left; + padding: .25rem .5rem; + } + td { border-bottom: 1px solid hsl(0, 0%, 85%); } + thead th { border-bottom: 2px solid hsl(0, 0%, 70%); } + tfoot th { border-top: 2px solid hsl(0, 0%, 70%); } + main form { + padding: 0 .5em; + margin: .5em 0 0 0; + } + main form:after { + content: "."; + display: block; + height: 0; + clear: both; + visibility: hidden; + } + main form div { + margin: .5em 0 0 0 + } + input { + font-family: monospace; + } + input[type="submit"],button,select { + font: inherit; + } + label { font-family: sans-serif; font-size:.9rem } + label::after { content:":" } + textarea { + font-family: monospace; + resize: vertical; + width: 100%; + } + .zs-input { + padding: .5em; + display:block; + border:none; + border-bottom:1px solid #ccc; + width:100%; + } + .zs-button { + float:right; + margin: .5em 0 .5em 1em; + } + a:not([class]) { + text-decoration-skip-ink: auto; + } + .zs-broken { + text-decoration: line-through; + } + img { + max-width: 100%; + } + .zs-endnotes { + padding-top: .5rem; + border-top: 1px solid; + } + code,pre,kbd { + font-family: monospace; + font-size: 85%; + } + code { + padding: .1rem .2rem; + background: #f0f0f0; + border: 1px solid #ccc; + border-radius: .25rem; + } + pre { + padding: .5rem .7rem; + max-width: 100%; + overflow: auto; + border: 1px solid #ccc; + border-radius: .5rem; + background: #f0f0f0; + } + pre code { + font-size: 95%; + position: relative; + padding: 0; + border: none; + } + div.zs-indication { + padding: .5rem .7rem; + max-width: 100%; + border-radius: .5rem; + border: 1px solid black; + } + div.zs-indication p:first-child { + margin-top: 0; + } + span.zs-indication { + border: 1px solid black; + border-radius: .25rem; + padding: .1rem .2rem; + font-size: 95%; + } + .zs-example { border-style: dotted !important } + .zs-error { + background-color: lightpink; + border-style: none !important; + font-weight: bold; + } + kbd { + background: hsl(210, 5%, 100%); + border: 1px solid hsl(210, 5%, 70%); + border-radius: .25rem; + padding: .1rem .2rem; + font-size: 75%; + } + .zs-meta { + font-size:.75rem; + color:#444; + margin-bottom:1rem; + } + .zs-meta a { + color:#444; + } + h1+.zs-meta { + margin-top:-1rem; + } + details > summary { + width: 100%; + background-color: #eee; + font-family:sans-serif; + } + details > ul { + margin-top:0; + padding-left:2rem; + background-color: #eee; + } + footer { + padding: 0 1rem; + } + @media (prefers-reduced-motion: reduce) { + * { + animation-duration: 0.01ms !important; + animation-iteration-count: 1 !important; + transition-duration: 0.01ms !important; + scroll-behavior: auto !important; + } + } ADDED box/constbox/base.mustache Index: box/constbox/base.mustache ================================================================== --- box/constbox/base.mustache +++ box/constbox/base.mustache @@ -0,0 +1,66 @@ + + + + + + + + +{{{MetaHeader}}} + + +{{Title}} + + + +
+{{{Content}}} +
+{{#FooterHTML}} + +{{/FooterHTML}} + + ADDED box/constbox/constbox.go Index: box/constbox/constbox.go ================================================================== --- box/constbox/constbox.go +++ box/constbox/constbox.go @@ -0,0 +1,405 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package constbox puts zettel inside the executable. +package constbox + +import ( + "context" + _ "embed" // Allow to embed file content + "net/url" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/manager" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/search" +) + +func init() { + manager.Register( + " const", + func(u *url.URL, cdata *manager.ConnectData) (box.ManagedBox, error) { + return &constBox{ + number: cdata.Number, + zettel: constZettelMap, + enricher: cdata.Enricher, + }, nil + }) +} + +type constHeader map[string]string + +func makeMeta(zid id.Zid, h constHeader) *meta.Meta { + m := meta.New(zid) + for k, v := range h { + m.Set(k, v) + } + return m +} + +type constZettel struct { + header constHeader + content domain.Content +} + +type constBox struct { + number int + zettel map[id.Zid]constZettel + enricher box.Enricher +} + +func (cp *constBox) Location() string { + return "const:" +} + +func (cp *constBox) CanCreateZettel(ctx context.Context) bool { return false } + +func (cp *constBox) CreateZettel(ctx context.Context, zettel domain.Zettel) (id.Zid, error) { + return id.Invalid, box.ErrReadOnly +} + +func (cp *constBox) GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) { + if z, ok := cp.zettel[zid]; ok { + return domain.Zettel{Meta: makeMeta(zid, z.header), Content: z.content}, nil + } + return domain.Zettel{}, box.ErrNotFound +} + +func (cp *constBox) GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) { + if z, ok := cp.zettel[zid]; ok { + return makeMeta(zid, z.header), nil + } + return nil, box.ErrNotFound +} + +func (cp *constBox) FetchZids(ctx context.Context) (id.Set, error) { + result := id.NewSetCap(len(cp.zettel)) + for zid := range cp.zettel { + result[zid] = true + } + return result, nil +} + +func (cp *constBox) SelectMeta(ctx context.Context, match search.MetaMatchFunc) (res []*meta.Meta, err error) { + for zid, zettel := range cp.zettel { + m := makeMeta(zid, zettel.header) + cp.enricher.Enrich(ctx, m, cp.number) + if match(m) { + res = append(res, m) + } + } + return res, nil +} + +func (cp *constBox) CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool { + return false +} + +func (cp *constBox) UpdateZettel(ctx context.Context, zettel domain.Zettel) error { + return box.ErrReadOnly +} + +func (cp *constBox) AllowRenameZettel(ctx context.Context, zid id.Zid) bool { + _, ok := cp.zettel[zid] + return !ok +} + +func (cp *constBox) RenameZettel(ctx context.Context, curZid, newZid id.Zid) error { + if _, ok := cp.zettel[curZid]; ok { + return box.ErrReadOnly + } + return box.ErrNotFound +} +func (cp *constBox) CanDeleteZettel(ctx context.Context, zid id.Zid) bool { return false } + +func (cp *constBox) DeleteZettel(ctx context.Context, zid id.Zid) error { + if _, ok := cp.zettel[zid]; ok { + return box.ErrReadOnly + } + return box.ErrNotFound +} + +func (cp *constBox) ReadStats(st *box.ManagedBoxStats) { + st.ReadOnly = true + st.Zettel = len(cp.zettel) +} + +const syntaxTemplate = "mustache" + +var constZettelMap = map[id.Zid]constZettel{ + id.ConfigurationZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Runtime Configuration", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: meta.ValueSyntaxNone, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityOwner, + }, + domain.NewContent("")}, + id.LicenseZid: { + constHeader{ + meta.KeyTitle: "Zettelstore License", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: meta.ValueSyntaxText, + meta.KeyLang: meta.ValueLangEN, + meta.KeyReadOnly: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityPublic, + }, + domain.NewContent(contentLicense)}, + id.AuthorsZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Contributors", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: meta.ValueSyntaxZmk, + meta.KeyLang: meta.ValueLangEN, + meta.KeyReadOnly: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityPublic, + }, + domain.NewContent(contentContributors)}, + id.DependenciesZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Dependencies", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: meta.ValueSyntaxZmk, + meta.KeyLang: meta.ValueLangEN, + meta.KeyReadOnly: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityPublic, + }, + domain.NewContent(contentDependencies)}, + id.BaseTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Base HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentBaseMustache)}, + id.LoginTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Login Form HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentLoginMustache)}, + id.ZettelTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Zettel HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentZettelMustache)}, + id.InfoTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Info HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentInfoMustache)}, + id.ContextTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Context HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentContextMustache)}, + id.FormTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Form HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentFormMustache)}, + id.RenameTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Rename Form HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentRenameMustache)}, + id.DeleteTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Delete HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentDeleteMustache)}, + id.ListTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore List Zettel HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentListZettelMustache)}, + id.RolesTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore List Roles HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentListRolesMustache)}, + id.TagsTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore List Tags HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentListTagsMustache)}, + id.ErrorTemplateZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Error HTML Template", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: syntaxTemplate, + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityExpert, + }, + domain.NewContent(contentErrorMustache)}, + id.BaseCSSZid: { + constHeader{ + meta.KeyTitle: "Zettelstore Base CSS", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: "css", + meta.KeyNoIndex: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityPublic, + }, + domain.NewContent(contentBaseCSS)}, + id.UserCSSZid: { + constHeader{ + meta.KeyTitle: "Zettelstore User CSS", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: "css", + meta.KeyVisibility: meta.ValueVisibilityPublic, + }, + domain.NewContent("/* User-defined CSS */")}, + id.EmojiZid: { + constHeader{ + meta.KeyTitle: "Generic Emoji", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: meta.ValueSyntaxGif, + meta.KeyReadOnly: meta.ValueTrue, + meta.KeyVisibility: meta.ValueVisibilityPublic, + }, + domain.NewContent(contentEmoji)}, + id.TOCNewTemplateZid: { + constHeader{ + meta.KeyTitle: "New Menu", + meta.KeyRole: meta.ValueRoleConfiguration, + meta.KeySyntax: meta.ValueSyntaxZmk, + meta.KeyLang: meta.ValueLangEN, + meta.KeyVisibility: meta.ValueVisibilityCreator, + }, + domain.NewContent(contentNewTOCZettel)}, + id.TemplateNewZettelZid: { + constHeader{ + meta.KeyTitle: "New Zettel", + meta.KeyRole: meta.ValueRoleZettel, + meta.KeySyntax: meta.ValueSyntaxZmk, + meta.KeyVisibility: meta.ValueVisibilityCreator, + }, + domain.NewContent("")}, + id.TemplateNewUserZid: { + constHeader{ + meta.KeyTitle: "New User", + meta.KeyRole: meta.ValueRoleUser, + meta.KeySyntax: meta.ValueSyntaxNone, + meta.NewPrefix + meta.KeyCredential: "", + meta.NewPrefix + meta.KeyUserID: "", + meta.NewPrefix + meta.KeyUserRole: meta.ValueUserRoleReader, + meta.KeyVisibility: meta.ValueVisibilityOwner, + }, + domain.NewContent("")}, + id.DefaultHomeZid: { + constHeader{ + meta.KeyTitle: "Home", + meta.KeyRole: meta.ValueRoleZettel, + meta.KeySyntax: meta.ValueSyntaxZmk, + meta.KeyLang: meta.ValueLangEN, + }, + domain.NewContent(contentHomeZettel)}, +} + +//go:embed license.txt +var contentLicense string + +//go:embed contributors.zettel +var contentContributors string + +//go:embed dependencies.zettel +var contentDependencies string + +//go:embed base.mustache +var contentBaseMustache string + +//go:embed login.mustache +var contentLoginMustache string + +//go:embed zettel.mustache +var contentZettelMustache string + +//go:embed info.mustache +var contentInfoMustache string + +//go:embed context.mustache +var contentContextMustache string + +//go:embed form.mustache +var contentFormMustache string + +//go:embed rename.mustache +var contentRenameMustache string + +//go:embed delete.mustache +var contentDeleteMustache string + +//go:embed listzettel.mustache +var contentListZettelMustache string + +//go:embed listroles.mustache +var contentListRolesMustache string + +//go:embed listtags.mustache +var contentListTagsMustache string + +//go:embed error.mustache +var contentErrorMustache string + +//go:embed base.css +var contentBaseCSS string + +//go:embed emoji_spin.gif +var contentEmoji string + +//go:embed newtoc.zettel +var contentNewTOCZettel string + +//go:embed home.zettel +var contentHomeZettel string ADDED box/constbox/context.mustache Index: box/constbox/context.mustache ================================================================== --- box/constbox/context.mustache +++ box/constbox/context.mustache @@ -0,0 +1,16 @@ + ADDED box/constbox/contributors.zettel Index: box/constbox/contributors.zettel ================================================================== --- box/constbox/contributors.zettel +++ box/constbox/contributors.zettel @@ -0,0 +1,8 @@ +Zettelstore is a software for humans made from humans. + +=== Licensor(s) +* Detlef Stern [[mailto:ds@zettelstore.de]] +** Main author +** Maintainer + +=== Contributors ADDED box/constbox/delete.mustache Index: box/constbox/delete.mustache ================================================================== --- box/constbox/delete.mustache +++ box/constbox/delete.mustache @@ -0,0 +1,15 @@ +
+
+

Delete Zettel {{Zid}}

+
+

Do you really want to delete this zettel?

+
+{{#MetaPairs}} +
{{Key}}:
{{Value}}
+{{/MetaPairs}} +
+
+ +
+
+{{end}} ADDED box/constbox/dependencies.zettel Index: box/constbox/dependencies.zettel ================================================================== --- box/constbox/dependencies.zettel +++ box/constbox/dependencies.zettel @@ -0,0 +1,149 @@ +Zettelstore is made with the help of other software and other artifacts. +Thank you very much! + +This zettel lists all of them, together with their license. + +=== Go runtime and associated libraries +; License +: BSD 3-Clause "New" or "Revised" License +``` +Copyright (c) 2009 The Go Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +``` + +=== Fsnotify +; URL +: [[https://fsnotify.org/]] +; License +: BSD 3-Clause "New" or "Revised" License +; Source +: [[https://github.com/fsnotify/fsnotify]] +``` +Copyright (c) 2012 The Go Authors. All rights reserved. +Copyright (c) 2012-2019 fsnotify Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +``` + +=== hoisie/mustache / cbroglie/mustache +; URL & Source +: [[https://github.com/hoisie/mustache]] / [[https://github.com/cbroglie/mustache]] +; License +: MIT License +; Remarks +: cbroglie/mustache is a fork from hoisie/mustache (starting with commit [f9b4cbf]). + cbroglie/mustache does not claim a copyright and includes just the license file from hoisie/mustache. + cbroglie/mustache obviously continues with the original license. + +``` +Copyright (c) 2009 Michael Hoisie + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. +``` + +=== pascaldekloe/jwt +; URL & Source +: [[https://github.com/pascaldekloe/jwt]] +; License +: [[CC0 1.0 Universal|https://creativecommons.org/publicdomain/zero/1.0/legalcode]] +``` +To the extent possible under law, Pascal S. de Kloe has waived all +copyright and related or neighboring rights to JWT. This work is +published from The Netherlands. + +https://creativecommons.org/publicdomain/zero/1.0/legalcode +``` + +=== yuin/goldmark +; URL & Source +: [[https://github.com/yuin/goldmark]] +; License +: MIT License +``` +MIT License + +Copyright (c) 2019 Yusuke Inuzuka + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` ADDED box/constbox/emoji_spin.gif Index: box/constbox/emoji_spin.gif ================================================================== --- box/constbox/emoji_spin.gif +++ box/constbox/emoji_spin.gif cannot compute difference between binary files ADDED box/constbox/error.mustache Index: box/constbox/error.mustache ================================================================== --- box/constbox/error.mustache +++ box/constbox/error.mustache @@ -0,0 +1,6 @@ +
+
+

{{ErrorTitle}}

+
+{{ErrorText}} +
ADDED box/constbox/form.mustache Index: box/constbox/form.mustache ================================================================== --- box/constbox/form.mustache +++ box/constbox/form.mustache @@ -0,0 +1,38 @@ +
+
+

{{Heading}}

+
+
+
+ + +
+
+
+ + +
+ + +
+
+ + +
+
+ + +
+
+{{#IsTextContent}} + + +{{/IsTextContent}} +
+ +
+
ADDED box/constbox/home.zettel Index: box/constbox/home.zettel ================================================================== --- box/constbox/home.zettel +++ box/constbox/home.zettel @@ -0,0 +1,44 @@ +=== Thank you for using Zettelstore! + +You will find the lastest information about Zettelstore at [[https://zettelstore.de]]. +Check that website regulary for [[upgrades|https://zettelstore.de/home/doc/trunk/www/download.wiki]] to the latest version. +You should consult the [[change log|https://zettelstore.de/home/doc/trunk/www/changes.wiki]] before upgrading. +Sometimes, you have to edit some of your Zettelstore-related zettel before upgrading. +Since Zettelstore is currently in a development state, every upgrade might fix some of your problems. +To check for versions, there is a zettel with the [[current version|00000000000001]] of your Zettelstore. + +If you have problems concerning Zettelstore, +do not hesitate to get in [[contact with the main developer|mailto:ds@zettelstore.de]]. + +=== Reporting errors +If you have encountered an error, please include the content of the following zettel in your mail (if possible): +* [[Zettelstore Version|00000000000001]] +* [[Zettelstore Operating System|00000000000003]] +* [[Zettelstore Startup Configuration|00000000000096]] +* [[Zettelstore Runtime Configuration|00000000000100]] + +Additionally, you have to describe, what you have done before that error occurs +and what you have expected instead. +Please do not forget to include the error message, if there is one. + +Some of above Zettelstore zettel can only be retrieved if you enabled ""expert mode"". +Otherwise, only some zettel are linked. +To enable expert mode, edit the zettel [[Zettelstore Runtime Configuration|00000000000100]]: +please set the metadata value of the key ''expert-mode'' to true. +To do you, enter the string ''expert-mode:true'' inside the edit view of the metadata. + +=== Information about this zettel +This zettel is your home zettel. +It is part of the Zettelstore software itself. +Every time you click on the [[Home|//]] link in the menu bar, you will be redirected to this zettel. + +You can change the content of this zettel by clicking on ""Edit"" above. +This allows you to customize your home zettel. + +Alternatively, you can designate another zettel as your home zettel. +Edit the [[Zettelstore Runtime Configuration|00000000000100]] by adding the metadata key ''home-zettel''. +Its value is the identifier of the zettel that should act as the new home zettel. +You will find the identifier of each zettel between their ""Edit"" and the ""Info"" link above. +The identifier of this zettel is ''00010000000000''. +If you provide a wrong identifier, this zettel will be shown as the home zettel. +Take a look inside the manual for further details. ADDED box/constbox/info.mustache Index: box/constbox/info.mustache ================================================================== --- box/constbox/info.mustache +++ box/constbox/info.mustache @@ -0,0 +1,48 @@ +
+
+

Information for Zettel {{Zid}}

+Web +· Context +{{#CanWrite}} · Edit{{/CanWrite}} +{{#CanFolge}} · Folge{{/CanFolge}} +{{#CanCopy}} · Copy{{/CanCopy}} +{{#CanRename}}· Rename{{/CanRename}} +{{#CanDelete}}· Delete{{/CanDelete}} +
+

Interpreted Metadata

+{{#MetaData}}{{/MetaData}}
{{Key}}{{{Value}}}
+{{#HasLinks}} +

References

+{{#HasLocLinks}} +

Local

+ +{{/HasLocLinks}} +{{#HasExtLinks}} +

External

+ +{{/HasExtLinks}} +{{/HasLinks}} +

Parts and format

+ +{{#Matrix}} + +{{#Elements}}{{#HasURL}}{{/HasURL}}{{^HasURL}}{{/HasURL}} +{{/Elements}} + +{{/Matrix}} +
{{Text}}{{Text}}
+{{#HasShadowLinks}} +

Shadowed Boxes

+ +{{/HasShadowLinks}} +{{#Endnotes}}{{{Endnotes}}}{{/Endnotes}} +
ADDED box/constbox/license.txt Index: box/constbox/license.txt ================================================================== --- box/constbox/license.txt +++ box/constbox/license.txt @@ -0,0 +1,295 @@ +Copyright (c) 2020-2021 Detlef Stern + + Licensed under the EUPL + +Zettelstore is licensed under the European Union Public License, version 1.2 or +later (EUPL v. 1.2). The license is available in the official languages of the +EU. The English version is included here. Please see +https://joinup.ec.europa.eu/community/eupl/og_page/eupl for official +translations of the other languages. + + +------------------------------------------------------------------------------- + + +EUROPEAN UNION PUBLIC LICENCE v. 1.2 +EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined +below) which is provided under the terms of this Licence. Any use of the Work, +other than as authorised under this Licence is prohibited (to the extent such +use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the +copyright notice for the Work: + + Licensed under the EUPL + +or has expressed by any other means his willingness to license under the EUPL. + +1. Definitions + +In this Licence, the following terms have the following meaning: + +— ‘The Licence’: this Licence. +— ‘The Original Work’: the work or software distributed or communicated by the + Licensor under this Licence, available as Source Code and also as Executable + Code as the case may be. +— ‘Derivative Works’: the works or software that could be created by the + Licensee, based upon the Original Work or modifications thereof. This Licence + does not define the extent of modification or dependence on the Original Work + required in order to classify a work as a Derivative Work; this extent is + determined by copyright law applicable in the country mentioned in Article + 15. +— ‘The Work’: the Original Work or its Derivative Works. +— ‘The Source Code’: the human-readable form of the Work which is the most + convenient for people to study and modify. +— ‘The Executable Code’: any code which has generally been compiled and which + is meant to be interpreted by a computer as a program. +— ‘The Licensor’: the natural or legal person that distributes or communicates + the Work under the Licence. +— ‘Contributor(s)’: any natural or legal person who modifies the Work under the + Licence, or otherwise contributes to the creation of a Derivative Work. +— ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of + the Work under the terms of the Licence. +— ‘Distribution’ or ‘Communication’: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, online or offline, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +sublicensable licence to do the following, for the duration of copyright vested +in the Original Work: + +— use the Work in any circumstance and for all usage, +— reproduce the Work, +— modify the Work, and make Derivative Works based upon the Work, +— communicate to the public, including the right to make available or display + the Work or copies thereof to the public and perform publicly, as the case + may be, the Work, +— distribute the Work or copies thereof, +— lend and rent the Work or copies thereof, +— sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make +effective the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to +any patents held by the Licensor, to the extent necessary to make use of the +rights granted on the Work under this Licence. + +3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, in +a notice following the copyright notice attached to the Work, a repository +where the Source Code is easily and freely accessible for as long as the +Licensor continues to distribute or communicate the Work. + +4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits +from any exception or limitation to the exclusive rights of the rights owners +in the Work, of the exhaustion of those rights or of other applicable +limitations thereto. + +5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and +a copy of the Licence with every copy of the Work he/she distributes or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will be +done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version of +the Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions +on the Work or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed +under a Compatible Licence, this Distribution or Communication can be done +under the terms of this Compatible Licence. For the sake of this clause, +‘Compatible Licence’ refers to the licences listed in the appendix attached to +this Licence. Should the Licensee's obligations under the Compatible Licence +conflict with his/her obligations under this Licence, the obligations of the +Compatible Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the +Work, the Licensee will provide a machine-readable copy of the Source Code or +indicate a repository where this Source will be easily and freely available for +as long as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade +names, trademarks, service marks, or names of the Licensor, except as required +for reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + +6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects or +‘bugs’ inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an ‘as is’ +basis and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of +defects or errors, accuracy, non-infringement of intellectual property rights +other than copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + +8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the +use of the Work, including without limitation, damages for loss of goodwill, +work stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such +damage. However, the Licensor will be liable under statutory product liability +laws as far such laws apply to the Work. + +9. Additional agreements + +While distributing the Work, You may choose to conclude an additional +agreement, defining obligations or services consistent with this Licence. +However, if accepting obligations, You may act only on your own behalf and on +your sole responsibility, not on behalf of the original Licensor or any other +Contributor, and only if You agree to indemnify, defend, and hold each +Contributor harmless for any liability incurred by, or claims asserted against +such Contributor by the fact You have accepted any warranty or additional +liability. + +10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ +placed under the bottom of a window displaying the text of this Licence or by +affirming consent in any other similar way, in accordance with the rules of +applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this +Licence, such as the use of the Work, the creation by You of a Derivative Work +or the Distribution or Communication by You of the Work or copies thereof. + +11. Information to the public + +In case of any Distribution or Communication of the Work by means of electronic +communication by You (for example, by offering to download the Work from +a remote location) the distribution channel or media (for example, a website) +must at least provide to the public the information requested by the applicable +law regarding the Licensor, the Licence and the way it may be accessible, +concluded, stored and reproduced by the Licensee. + +12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has +received the Work from the Licensee under the Licence, provided such persons +remain in full compliance with the Licence. + +13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as +a whole. Such provision will be construed or reformed so as necessary to make +it valid and enforceable. + +The European Commission may publish other linguistic versions or new versions +of this Licence or updated versions of the Appendix, so far this is required +and reasonable, without reducing the scope of the rights granted by the +Licence. New versions of the Licence will be published with a unique version +number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +14. Jurisdiction + +Without prejudice to specific agreement between parties, + +— any litigation resulting from the interpretation of this License, arising + between the European Union institutions, bodies, offices or agencies, as + a Licensor, and any Licensee, will be subject to the jurisdiction of the + Court of Justice of the European Union, as laid down in article 272 of the + Treaty on the Functioning of the European Union, +— any litigation arising between other parties and resulting from the + interpretation of this License, will be subject to the exclusive jurisdiction + of the competent court where the Licensor resides or conducts its primary + business. + +15. Applicable Law + +Without prejudice to specific agreement between parties, + +— this Licence shall be governed by the law of the European Union Member State + where the Licensor has his seat, resides or has his registered office, +— this licence shall be governed by Belgian law if the Licensor has no seat, + residence or registered office inside a European Union Member State. + + + Appendix + + +‘Compatible Licences’ according to Article 5 EUPL are: + +— GNU General Public License (GPL) v. 2, v. 3 +— GNU Affero General Public License (AGPL) v. 3 +— Open Software License (OSL) v. 2.1, v. 3.0 +— Eclipse Public License (EPL) v. 1.0 +— CeCILL v. 2.0, v. 2.1 +— Mozilla Public Licence (MPL) v. 2 +— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 +— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for + works other than software +— European Union Public Licence (EUPL) v. 1.1, v. 1.2 +— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong + Reciprocity (LiLiQ-R+) + +The European Commission may update this Appendix to later versions of the above +licences without producing a new version of the EUPL, as long as they provide +the rights granted in Article 2 of this Licence and protect the covered Source +Code from exclusive appropriation. + +All other changes or additions to this Appendix require the production of a new +EUPL version. ADDED box/constbox/listroles.mustache Index: box/constbox/listroles.mustache ================================================================== --- box/constbox/listroles.mustache +++ box/constbox/listroles.mustache @@ -0,0 +1,8 @@ + ADDED box/constbox/listtags.mustache Index: box/constbox/listtags.mustache ================================================================== --- box/constbox/listtags.mustache +++ box/constbox/listtags.mustache @@ -0,0 +1,10 @@ + ADDED box/constbox/listzettel.mustache Index: box/constbox/listzettel.mustache ================================================================== --- box/constbox/listzettel.mustache +++ box/constbox/listzettel.mustache @@ -0,0 +1,6 @@ +
+

{{Title}}

+
+ ADDED box/constbox/login.mustache Index: box/constbox/login.mustache ================================================================== --- box/constbox/login.mustache +++ box/constbox/login.mustache @@ -0,0 +1,19 @@ +
+
+

{{Title}}

+
+{{#Retry}} +
Wrong user name / password. Try again.
+{{/Retry}} +
+
+ + +
+
+ + +
+ +
+
ADDED box/constbox/newtoc.zettel Index: box/constbox/newtoc.zettel ================================================================== --- box/constbox/newtoc.zettel +++ box/constbox/newtoc.zettel @@ -0,0 +1,4 @@ +This zettel lists all zettel that should act as a template for new zettel. +These zettel will be included in the ""New"" menu of the WebUI. +* [[New Zettel|00000000090001]] +* [[New User|00000000090002]] ADDED box/constbox/rename.mustache Index: box/constbox/rename.mustache ================================================================== --- box/constbox/rename.mustache +++ box/constbox/rename.mustache @@ -0,0 +1,19 @@ +
+
+

Rename Zettel {{.Zid}}

+
+

Do you really want to rename this zettel?

+
+
+ + +
+ + +
+
+{{#MetaPairs}} +
{{Key}}:
{{Value}}
+{{/MetaPairs}} +
+
ADDED box/constbox/zettel.mustache Index: box/constbox/zettel.mustache ================================================================== --- box/constbox/zettel.mustache +++ box/constbox/zettel.mustache @@ -0,0 +1,28 @@ +
+
+

{{{HTMLTitle}}}

+
+{{#CanWrite}}Edit ·{{/CanWrite}} +{{Zid}} · +Info · +({{RoleText}}) +{{#HasTags}}· {{#Tags}} {{Text}}{{/Tags}}{{/HasTags}} +{{#CanCopy}}· Copy{{/CanCopy}} +{{#CanFolge}}· Folge{{/CanFolge}} +{{#FolgeRefs}}
Folge: {{{FolgeRefs}}}{{/FolgeRefs}} +{{#PrecursorRefs}}
Precursor: {{{PrecursorRefs}}}{{/PrecursorRefs}} +{{#HasExtURL}}
URL: {{ExtURL}}{{/HasExtURL}} +
+
+{{{Content}}} +{{#HasBackLinks}} +
+Additional links to this zettel +
    +{{#BackLinks}} +
  • {{Text}}
    • +{{/BackLinks}} +
+
+{{/HasBackLinks}} +
ADDED box/dirbox/dirbox.go Index: box/dirbox/dirbox.go ================================================================== --- box/dirbox/dirbox.go +++ box/dirbox/dirbox.go @@ -0,0 +1,420 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package dirbox provides a directory-based zettel box. +package dirbox + +import ( + "context" + "errors" + "net/url" + "os" + "path/filepath" + "strconv" + "strings" + "sync" + "time" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/dirbox/directory" + "zettelstore.de/z/box/filebox" + "zettelstore.de/z/box/manager" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/search" +) + +func init() { + manager.Register("dir", func(u *url.URL, cdata *manager.ConnectData) (box.ManagedBox, error) { + path := getDirPath(u) + if _, err := os.Stat(path); errors.Is(err, os.ErrNotExist) { + return nil, err + } + dirSrvSpec, defWorker, maxWorker := getDirSrvInfo(u.Query().Get("type")) + dp := dirBox{ + number: cdata.Number, + location: u.String(), + readonly: getQueryBool(u, "readonly"), + cdata: *cdata, + dir: path, + dirRescan: time.Duration(getQueryInt(u, "rescan", 60, 3600, 30*24*60*60)) * time.Second, + dirSrvSpec: dirSrvSpec, + fSrvs: uint32(getQueryInt(u, "worker", 1, defWorker, maxWorker)), + } + return &dp, nil + }) +} + +type directoryServiceSpec int + +const ( + _ directoryServiceSpec = iota + dirSrvAny + dirSrvSimple + dirSrvNotify +) + +func getDirPath(u *url.URL) string { + if u.Opaque != "" { + return filepath.Clean(u.Opaque) + } + return filepath.Clean(u.Path) +} + +func getQueryBool(u *url.URL, key string) bool { + _, ok := u.Query()[key] + return ok +} + +func getQueryInt(u *url.URL, key string, min, def, max int) int { + sVal := u.Query().Get(key) + if sVal == "" { + return def + } + iVal, err := strconv.Atoi(sVal) + if err != nil { + return def + } + if iVal < min { + return min + } + if iVal > max { + return max + } + return iVal +} + +// dirBox uses a directory to store zettel as files. +type dirBox struct { + number int + location string + readonly bool + cdata manager.ConnectData + dir string + dirRescan time.Duration + dirSrvSpec directoryServiceSpec + dirSrv directory.Service + mustNotify bool + fSrvs uint32 + fCmds []chan fileCmd + mxCmds sync.RWMutex +} + +func (dp *dirBox) Location() string { + return dp.location +} + +func (dp *dirBox) Start(ctx context.Context) error { + dp.mxCmds.Lock() + dp.fCmds = make([]chan fileCmd, 0, dp.fSrvs) + for i := uint32(0); i < dp.fSrvs; i++ { + cc := make(chan fileCmd) + go fileService(i, cc) + dp.fCmds = append(dp.fCmds, cc) + } + dp.setupDirService() + dp.mxCmds.Unlock() + if dp.dirSrv == nil { + panic("No directory service") + } + return dp.dirSrv.Start() +} + +func (dp *dirBox) Stop(ctx context.Context) error { + dirSrv := dp.dirSrv + dp.dirSrv = nil + err := dirSrv.Stop() + for _, c := range dp.fCmds { + close(c) + } + return err +} + +func (dp *dirBox) notifyChanged(reason box.UpdateReason, zid id.Zid) { + if dp.mustNotify { + if chci := dp.cdata.Notify; chci != nil { + chci <- box.UpdateInfo{Reason: reason, Zid: zid} + } + } +} + +func (dp *dirBox) getFileChan(zid id.Zid) chan fileCmd { + // Based on https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function + sum := 2166136261 ^ uint32(zid) + sum *= 16777619 + sum ^= uint32(zid >> 32) + sum *= 16777619 + + dp.mxCmds.RLock() + defer dp.mxCmds.RUnlock() + return dp.fCmds[sum%dp.fSrvs] +} + +func (dp *dirBox) CanCreateZettel(ctx context.Context) bool { + return !dp.readonly +} + +func (dp *dirBox) CreateZettel(ctx context.Context, zettel domain.Zettel) (id.Zid, error) { + if dp.readonly { + return id.Invalid, box.ErrReadOnly + } + + entry, err := dp.dirSrv.GetNew() + if err != nil { + return id.Invalid, err + } + meta := zettel.Meta + meta.Zid = entry.Zid + dp.updateEntryFromMeta(entry, meta) + + err = setZettel(dp, entry, zettel) + if err == nil { + dp.dirSrv.UpdateEntry(entry) + } + dp.notifyChanged(box.OnUpdate, meta.Zid) + return meta.Zid, err +} + +func (dp *dirBox) GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) { + entry, err := dp.dirSrv.GetEntry(zid) + if err != nil || !entry.IsValid() { + return domain.Zettel{}, box.ErrNotFound + } + m, c, err := getMetaContent(dp, entry, zid) + if err != nil { + return domain.Zettel{}, err + } + dp.cleanupMeta(ctx, m) + zettel := domain.Zettel{Meta: m, Content: domain.NewContent(c)} + return zettel, nil +} + +func (dp *dirBox) GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) { + entry, err := dp.dirSrv.GetEntry(zid) + if err != nil || !entry.IsValid() { + return nil, box.ErrNotFound + } + m, err := getMeta(dp, entry, zid) + if err != nil { + return nil, err + } + dp.cleanupMeta(ctx, m) + return m, nil +} + +func (dp *dirBox) FetchZids(ctx context.Context) (id.Set, error) { + entries, err := dp.dirSrv.GetEntries() + if err != nil { + return nil, err + } + result := id.NewSetCap(len(entries)) + for _, entry := range entries { + result[entry.Zid] = true + } + return result, nil +} + +func (dp *dirBox) SelectMeta(ctx context.Context, match search.MetaMatchFunc) (res []*meta.Meta, err error) { + entries, err := dp.dirSrv.GetEntries() + if err != nil { + return nil, err + } + res = make([]*meta.Meta, 0, len(entries)) + // The following loop could be parallelized if needed for performance. + for _, entry := range entries { + m, err1 := getMeta(dp, entry, entry.Zid) + err = err1 + if err != nil { + continue + } + dp.cleanupMeta(ctx, m) + dp.cdata.Enricher.Enrich(ctx, m, dp.number) + + if match(m) { + res = append(res, m) + } + } + if err != nil { + return nil, err + } + return res, nil +} + +func (dp *dirBox) CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool { + return !dp.readonly +} + +func (dp *dirBox) UpdateZettel(ctx context.Context, zettel domain.Zettel) error { + if dp.readonly { + return box.ErrReadOnly + } + + meta := zettel.Meta + if !meta.Zid.IsValid() { + return &box.ErrInvalidID{Zid: meta.Zid} + } + entry, err := dp.dirSrv.GetEntry(meta.Zid) + if err != nil { + return err + } + if !entry.IsValid() { + // Existing zettel, but new in this box. + entry = &directory.Entry{Zid: meta.Zid} + dp.updateEntryFromMeta(entry, meta) + } else if entry.MetaSpec == directory.MetaSpecNone { + defaultMeta := filebox.CalcDefaultMeta(entry.Zid, entry.ContentExt) + if !meta.Equal(defaultMeta, true) { + dp.updateEntryFromMeta(entry, meta) + dp.dirSrv.UpdateEntry(entry) + } + } + err = setZettel(dp, entry, zettel) + if err == nil { + dp.notifyChanged(box.OnUpdate, meta.Zid) + } + return err +} + +func (dp *dirBox) updateEntryFromMeta(entry *directory.Entry, meta *meta.Meta) { + entry.MetaSpec, entry.ContentExt = dp.calcSpecExt(meta) + basePath := dp.calcBasePath(entry) + if entry.MetaSpec == directory.MetaSpecFile { + entry.MetaPath = basePath + ".meta" + } + entry.ContentPath = basePath + "." + entry.ContentExt + entry.Duplicates = false +} + +func (dp *dirBox) calcBasePath(entry *directory.Entry) string { + p := entry.ContentPath + if p == "" { + return filepath.Join(dp.dir, entry.Zid.String()) + } + // ContentPath w/o the file extension + return p[0 : len(p)-len(filepath.Ext(p))] +} + +func (dp *dirBox) calcSpecExt(m *meta.Meta) (directory.MetaSpec, string) { + if m.YamlSep { + return directory.MetaSpecHeader, "zettel" + } + syntax := m.GetDefault(meta.KeySyntax, "bin") + switch syntax { + case meta.ValueSyntaxNone, meta.ValueSyntaxZmk: + return directory.MetaSpecHeader, "zettel" + } + for _, s := range dp.cdata.Config.GetZettelFileSyntax() { + if s == syntax { + return directory.MetaSpecHeader, "zettel" + } + } + return directory.MetaSpecFile, syntax +} + +func (dp *dirBox) AllowRenameZettel(ctx context.Context, zid id.Zid) bool { + return !dp.readonly +} + +func (dp *dirBox) RenameZettel(ctx context.Context, curZid, newZid id.Zid) error { + if curZid == newZid { + return nil + } + curEntry, err := dp.dirSrv.GetEntry(curZid) + if err != nil || !curEntry.IsValid() { + return box.ErrNotFound + } + if dp.readonly { + return box.ErrReadOnly + } + + // Check whether zettel with new ID already exists in this box. + if _, err = dp.GetMeta(ctx, newZid); err == nil { + return &box.ErrInvalidID{Zid: newZid} + } + + oldMeta, oldContent, err := getMetaContent(dp, curEntry, curZid) + if err != nil { + return err + } + + newEntry := directory.Entry{ + Zid: newZid, + MetaSpec: curEntry.MetaSpec, + MetaPath: renamePath(curEntry.MetaPath, curZid, newZid), + ContentPath: renamePath(curEntry.ContentPath, curZid, newZid), + ContentExt: curEntry.ContentExt, + } + + if err = dp.dirSrv.RenameEntry(curEntry, &newEntry); err != nil { + return err + } + oldMeta.Zid = newZid + newZettel := domain.Zettel{Meta: oldMeta, Content: domain.NewContent(oldContent)} + if err = setZettel(dp, &newEntry, newZettel); err != nil { + // "Rollback" rename. No error checking... + dp.dirSrv.RenameEntry(&newEntry, curEntry) + return err + } + err = deleteZettel(dp, curEntry, curZid) + if err == nil { + dp.notifyChanged(box.OnDelete, curZid) + dp.notifyChanged(box.OnUpdate, newZid) + } + return err +} + +func (dp *dirBox) CanDeleteZettel(ctx context.Context, zid id.Zid) bool { + if dp.readonly { + return false + } + entry, err := dp.dirSrv.GetEntry(zid) + return err == nil && entry.IsValid() +} + +func (dp *dirBox) DeleteZettel(ctx context.Context, zid id.Zid) error { + if dp.readonly { + return box.ErrReadOnly + } + + entry, err := dp.dirSrv.GetEntry(zid) + if err != nil || !entry.IsValid() { + return box.ErrNotFound + } + dp.dirSrv.DeleteEntry(zid) + err = deleteZettel(dp, entry, zid) + if err == nil { + dp.notifyChanged(box.OnDelete, zid) + } + return err +} + +func (dp *dirBox) ReadStats(st *box.ManagedBoxStats) { + st.ReadOnly = dp.readonly + st.Zettel, _ = dp.dirSrv.NumEntries() +} + +func (dp *dirBox) cleanupMeta(ctx context.Context, m *meta.Meta) { + if role, ok := m.Get(meta.KeyRole); !ok || role == "" { + m.Set(meta.KeyRole, dp.cdata.Config.GetDefaultRole()) + } + if syntax, ok := m.Get(meta.KeySyntax); !ok || syntax == "" { + m.Set(meta.KeySyntax, dp.cdata.Config.GetDefaultSyntax()) + } +} + +func renamePath(path string, curID, newID id.Zid) string { + dir, file := filepath.Split(path) + if cur := curID.String(); strings.HasPrefix(file, cur) { + file = newID.String() + file[len(cur):] + return filepath.Join(dir, file) + } + return path +} ADDED box/dirbox/directory/directory.go Index: box/dirbox/directory/directory.go ================================================================== --- box/dirbox/directory/directory.go +++ box/dirbox/directory/directory.go @@ -0,0 +1,53 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package directory manages the directory interface of a dirstore. +package directory + +import "zettelstore.de/z/domain/id" + +// Service is the interface of a directory service. +type Service interface { + Start() error + Stop() error + NumEntries() (int, error) + GetEntries() ([]*Entry, error) + GetEntry(zid id.Zid) (*Entry, error) + GetNew() (*Entry, error) + UpdateEntry(entry *Entry) error + RenameEntry(curEntry, newEntry *Entry) error + DeleteEntry(zid id.Zid) error +} + +// MetaSpec defines all possibilities where meta data can be stored. +type MetaSpec int + +// Constants for MetaSpec +const ( + _ MetaSpec = iota + MetaSpecNone // no meta information + MetaSpecFile // meta information is in meta file + MetaSpecHeader // meta information is in header +) + +// Entry stores everything for a directory entry. +type Entry struct { + Zid id.Zid + MetaSpec MetaSpec // location of meta information + MetaPath string // file path of meta information + ContentPath string // file path of zettel content + ContentExt string // (normalized) file extension of zettel content + Duplicates bool // multiple content files +} + +// IsValid checks whether the entry is valid. +func (e *Entry) IsValid() bool { + return e != nil && e.Zid.IsValid() +} ADDED box/dirbox/makedir.go Index: box/dirbox/makedir.go ================================================================== --- box/dirbox/makedir.go +++ box/dirbox/makedir.go @@ -0,0 +1,43 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package dirbox provides a directory-based zettel box. +package dirbox + +import ( + "zettelstore.de/z/box/dirbox/notifydir" + "zettelstore.de/z/box/dirbox/simpledir" + "zettelstore.de/z/kernel" +) + +func getDirSrvInfo(dirType string) (directoryServiceSpec, int, int) { + for count := 0; count < 2; count++ { + switch dirType { + case kernel.BoxDirTypeNotify: + return dirSrvNotify, 7, 1499 + case kernel.BoxDirTypeSimple: + return dirSrvSimple, 1, 1 + default: + dirType = kernel.Main.GetConfig(kernel.BoxService, kernel.BoxDefaultDirType).(string) + } + } + panic("unable to set default dir box type: " + dirType) +} + +func (dp *dirBox) setupDirService() { + switch dp.dirSrvSpec { + case dirSrvSimple: + dp.dirSrv = simpledir.NewService(dp.dir) + dp.mustNotify = true + default: + dp.dirSrv = notifydir.NewService(dp.dir, dp.dirRescan, dp.cdata.Notify) + dp.mustNotify = false + } +} ADDED box/dirbox/notifydir/notifydir.go Index: box/dirbox/notifydir/notifydir.go ================================================================== --- box/dirbox/notifydir/notifydir.go +++ box/dirbox/notifydir/notifydir.go @@ -0,0 +1,126 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package notifydir manages the notified directory part of a dirstore. +package notifydir + +import ( + "time" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/dirbox/directory" + "zettelstore.de/z/domain/id" +) + +// notifyService specifies a directory scan service. +type notifyService struct { + dirPath string + rescanTime time.Duration + done chan struct{} + cmds chan dirCmd + infos chan<- box.UpdateInfo +} + +// NewService creates a new directory service. +func NewService(directoryPath string, rescanTime time.Duration, chci chan<- box.UpdateInfo) directory.Service { + srv := ¬ifyService{ + dirPath: directoryPath, + rescanTime: rescanTime, + cmds: make(chan dirCmd), + infos: chci, + } + return srv +} + +// Start makes the directory service operational. +func (srv *notifyService) Start() error { + tick := make(chan struct{}) + rawEvents := make(chan *fileEvent) + events := make(chan *fileEvent) + + ready := make(chan int) + go srv.directoryService(events, ready) + go collectEvents(events, rawEvents) + go watchDirectory(srv.dirPath, rawEvents, tick) + + if srv.done != nil { + panic("src.done already set") + } + srv.done = make(chan struct{}) + go ping(tick, srv.rescanTime, srv.done) + <-ready + return nil +} + +// Stop stops the directory service. +func (srv *notifyService) Stop() error { + close(srv.done) + srv.done = nil + return nil +} + +func (srv *notifyService) notifyChange(reason box.UpdateReason, zid id.Zid) { + if chci := srv.infos; chci != nil { + chci <- box.UpdateInfo{Reason: reason, Zid: zid} + } +} + +// NumEntries returns the number of managed zettel. +func (srv *notifyService) NumEntries() (int, error) { + resChan := make(chan resNumEntries) + srv.cmds <- &cmdNumEntries{resChan} + return <-resChan, nil +} + +// GetEntries returns an unsorted list of all current directory entries. +func (srv *notifyService) GetEntries() ([]*directory.Entry, error) { + resChan := make(chan resGetEntries) + srv.cmds <- &cmdGetEntries{resChan} + return <-resChan, nil +} + +// GetEntry returns the entry with the specified zettel id. If there is no such +// zettel id, an empty entry is returned. +func (srv *notifyService) GetEntry(zid id.Zid) (*directory.Entry, error) { + resChan := make(chan resGetEntry) + srv.cmds <- &cmdGetEntry{zid, resChan} + return <-resChan, nil +} + +// GetNew returns an entry with a new zettel id. +func (srv *notifyService) GetNew() (*directory.Entry, error) { + resChan := make(chan resNewEntry) + srv.cmds <- &cmdNewEntry{resChan} + result := <-resChan + return result.entry, result.err +} + +// UpdateEntry notifies the directory of an updated entry. +func (srv *notifyService) UpdateEntry(entry *directory.Entry) error { + resChan := make(chan struct{}) + srv.cmds <- &cmdUpdateEntry{entry, resChan} + <-resChan + return nil +} + +// RenameEntry notifies the directory of an renamed entry. +func (srv *notifyService) RenameEntry(curEntry, newEntry *directory.Entry) error { + resChan := make(chan resRenameEntry) + srv.cmds <- &cmdRenameEntry{curEntry, newEntry, resChan} + return <-resChan +} + +// DeleteEntry removes a zettel id from the directory of entries. +func (srv *notifyService) DeleteEntry(zid id.Zid) error { + resChan := make(chan struct{}) + srv.cmds <- &cmdDeleteEntry{zid, resChan} + <-resChan + return nil +} ADDED box/dirbox/notifydir/service.go Index: box/dirbox/notifydir/service.go ================================================================== --- box/dirbox/notifydir/service.go +++ box/dirbox/notifydir/service.go @@ -0,0 +1,255 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package notifydir manages the notified directory part of a dirstore. +package notifydir + +import ( + "log" + "time" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/dirbox/directory" + "zettelstore.de/z/domain/id" +) + +// ping sends every tick a signal to reload the directory list +func ping(tick chan<- struct{}, rescanTime time.Duration, done <-chan struct{}) { + ticker := time.NewTicker(rescanTime) + defer close(tick) + for { + select { + case _, ok := <-ticker.C: + if !ok { + return + } + tick <- struct{}{} + case _, ok := <-done: + if !ok { + ticker.Stop() + return + } + } + } +} + +func newEntry(ev *fileEvent) *directory.Entry { + de := new(directory.Entry) + de.Zid = ev.zid + updateEntry(de, ev) + return de +} + +func updateEntry(de *directory.Entry, ev *fileEvent) { + if ev.ext == "meta" { + de.MetaSpec = directory.MetaSpecFile + de.MetaPath = ev.path + return + } + if de.ContentExt != "" && de.ContentExt != ev.ext { + de.Duplicates = true + return + } + if de.MetaSpec != directory.MetaSpecFile { + if ev.ext == "zettel" { + de.MetaSpec = directory.MetaSpecHeader + } else { + de.MetaSpec = directory.MetaSpecNone + } + } + de.ContentPath = ev.path + de.ContentExt = ev.ext +} + +type dirMap map[id.Zid]*directory.Entry + +func dirMapUpdate(dm dirMap, ev *fileEvent) { + de := dm[ev.zid] + if de == nil { + dm[ev.zid] = newEntry(ev) + return + } + updateEntry(de, ev) +} + +func deleteFromMap(dm dirMap, ev *fileEvent) { + if ev.ext == "meta" { + if entry, ok := dm[ev.zid]; ok { + if entry.MetaSpec == directory.MetaSpecFile { + entry.MetaSpec = directory.MetaSpecNone + return + } + } + } + delete(dm, ev.zid) +} + +// directoryService is the main service. +func (srv *notifyService) directoryService(events <-chan *fileEvent, ready chan<- int) { + curMap := make(dirMap) + var newMap dirMap + for { + select { + case ev, ok := <-events: + if !ok { + return + } + switch ev.status { + case fileStatusReloadStart: + newMap = make(dirMap) + case fileStatusReloadEnd: + curMap = newMap + newMap = nil + if ready != nil { + ready <- len(curMap) + close(ready) + ready = nil + } + srv.notifyChange(box.OnReload, id.Invalid) + case fileStatusError: + log.Println("DIRBOX", "ERROR", ev.err) + case fileStatusUpdate: + srv.processFileUpdateEvent(ev, curMap, newMap) + case fileStatusDelete: + srv.processFileDeleteEvent(ev, curMap, newMap) + } + case cmd, ok := <-srv.cmds: + if ok { + cmd.run(curMap) + } + } + } +} + +func (srv *notifyService) processFileUpdateEvent(ev *fileEvent, curMap, newMap dirMap) { + if newMap != nil { + dirMapUpdate(newMap, ev) + } else { + dirMapUpdate(curMap, ev) + srv.notifyChange(box.OnUpdate, ev.zid) + } +} + +func (srv *notifyService) processFileDeleteEvent(ev *fileEvent, curMap, newMap dirMap) { + if newMap != nil { + deleteFromMap(newMap, ev) + } else { + deleteFromMap(curMap, ev) + srv.notifyChange(box.OnDelete, ev.zid) + } +} + +type dirCmd interface { + run(m dirMap) +} + +type cmdNumEntries struct { + result chan<- resNumEntries +} +type resNumEntries = int + +func (cmd *cmdNumEntries) run(m dirMap) { + cmd.result <- len(m) +} + +type cmdGetEntries struct { + result chan<- resGetEntries +} +type resGetEntries []*directory.Entry + +func (cmd *cmdGetEntries) run(m dirMap) { + res := make([]*directory.Entry, len(m)) + i := 0 + for _, de := range m { + entry := *de + res[i] = &entry + i++ + } + cmd.result <- res +} + +type cmdGetEntry struct { + zid id.Zid + result chan<- resGetEntry +} +type resGetEntry = *directory.Entry + +func (cmd *cmdGetEntry) run(m dirMap) { + entry := m[cmd.zid] + if entry == nil { + cmd.result <- nil + } else { + result := *entry + cmd.result <- &result + } +} + +type cmdNewEntry struct { + result chan<- resNewEntry +} +type resNewEntry struct { + entry *directory.Entry + err error +} + +func (cmd *cmdNewEntry) run(m dirMap) { + zid, err := box.GetNewZid(func(zid id.Zid) (bool, error) { + _, ok := m[zid] + return !ok, nil + }) + if err != nil { + cmd.result <- resNewEntry{nil, err} + return + } + entry := &directory.Entry{Zid: zid} + m[zid] = entry + cmd.result <- resNewEntry{&directory.Entry{Zid: zid}, nil} +} + +type cmdUpdateEntry struct { + entry *directory.Entry + result chan<- struct{} +} + +func (cmd *cmdUpdateEntry) run(m dirMap) { + entry := *cmd.entry + m[entry.Zid] = &entry + cmd.result <- struct{}{} +} + +type cmdRenameEntry struct { + curEntry *directory.Entry + newEntry *directory.Entry + result chan<- resRenameEntry +} + +type resRenameEntry = error + +func (cmd *cmdRenameEntry) run(m dirMap) { + newEntry := *cmd.newEntry + newZid := newEntry.Zid + if _, found := m[newZid]; found { + cmd.result <- &box.ErrInvalidID{Zid: newZid} + return + } + delete(m, cmd.curEntry.Zid) + m[newZid] = &newEntry + cmd.result <- nil +} + +type cmdDeleteEntry struct { + zid id.Zid + result chan<- struct{} +} + +func (cmd *cmdDeleteEntry) run(m dirMap) { + delete(m, cmd.zid) + cmd.result <- struct{}{} +} ADDED box/dirbox/notifydir/watch.go Index: box/dirbox/notifydir/watch.go ================================================================== --- box/dirbox/notifydir/watch.go +++ box/dirbox/notifydir/watch.go @@ -0,0 +1,300 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package notifydir manages the notified directory part of a dirstore. +package notifydir + +import ( + "os" + "path/filepath" + "regexp" + "time" + + "github.com/fsnotify/fsnotify" + + "zettelstore.de/z/domain/id" +) + +var validFileName = regexp.MustCompile(`^(\d{14}).*(\.(.+))$`) + +func matchValidFileName(name string) []string { + return validFileName.FindStringSubmatch(name) +} + +type fileStatus int + +const ( + fileStatusNone fileStatus = iota + fileStatusReloadStart + fileStatusReloadEnd + fileStatusError + fileStatusUpdate + fileStatusDelete +) + +type fileEvent struct { + status fileStatus + path string // Full file path + zid id.Zid + ext string // File extension + err error // Error if Status == fileStatusError +} + +type sendResult int + +const ( + sendDone sendResult = iota + sendReload + sendExit +) + +func watchDirectory(directory string, events chan<- *fileEvent, tick <-chan struct{}) { + defer close(events) + + var watcher *fsnotify.Watcher + defer func() { + if watcher != nil { + watcher.Close() + } + }() + + sendEvent := func(ev *fileEvent) sendResult { + select { + case events <- ev: + case _, ok := <-tick: + if ok { + return sendReload + } + return sendExit + } + return sendDone + } + + sendError := func(err error) sendResult { + return sendEvent(&fileEvent{status: fileStatusError, err: err}) + } + + sendFileEvent := func(status fileStatus, path string, match []string) sendResult { + zid, err := id.Parse(match[1]) + if err != nil { + return sendDone + } + event := &fileEvent{ + status: status, + path: path, + zid: zid, + ext: match[3], + } + return sendEvent(event) + } + + reloadStartEvent := &fileEvent{status: fileStatusReloadStart} + reloadEndEvent := &fileEvent{status: fileStatusReloadEnd} + reloadFiles := func() bool { + entries, err := os.ReadDir(directory) + if err != nil { + if res := sendError(err); res != sendDone { + return res == sendReload + } + return true + } + + if res := sendEvent(reloadStartEvent); res != sendDone { + return res == sendReload + } + + if watcher != nil { + watcher.Close() + } + watcher, err = fsnotify.NewWatcher() + if err != nil { + if res := sendError(err); res != sendDone { + return res == sendReload + } + } + + for _, entry := range entries { + if entry.IsDir() { + continue + } + if info, err1 := entry.Info(); err1 != nil || !info.Mode().IsRegular() { + continue + } + name := entry.Name() + match := matchValidFileName(name) + if len(match) > 0 { + path := filepath.Join(directory, name) + if res := sendFileEvent(fileStatusUpdate, path, match); res != sendDone { + return res == sendReload + } + } + } + + if watcher != nil { + err = watcher.Add(directory) + if err != nil { + if res := sendError(err); res != sendDone { + return res == sendReload + } + } + } + if res := sendEvent(reloadEndEvent); res != sendDone { + return res == sendReload + } + return true + } + + handleEvents := func() bool { + const createOps = fsnotify.Create | fsnotify.Write + const deleteOps = fsnotify.Remove | fsnotify.Rename + + for { + select { + case wevent, ok := <-watcher.Events: + if !ok { + return false + } + path := filepath.Clean(wevent.Name) + match := matchValidFileName(filepath.Base(path)) + if len(match) == 0 { + continue + } + if wevent.Op&createOps != 0 { + if fi, err := os.Lstat(path); err != nil || !fi.Mode().IsRegular() { + continue + } + if res := sendFileEvent( + fileStatusUpdate, path, match); res != sendDone { + return res == sendReload + } + } + if wevent.Op&deleteOps != 0 { + if res := sendFileEvent( + fileStatusDelete, path, match); res != sendDone { + return res == sendReload + } + } + case err, ok := <-watcher.Errors: + if !ok { + return false + } + if res := sendError(err); res != sendDone { + return res == sendReload + } + case _, ok := <-tick: + return ok + } + } + } + + for { + if !reloadFiles() { + return + } + if watcher == nil { + if _, ok := <-tick; !ok { + return + } + } else { + if !handleEvents() { + return + } + } + } +} + +func sendCollectedEvents(out chan<- *fileEvent, events []*fileEvent) { + for _, ev := range events { + if ev.status != fileStatusNone { + out <- ev + } + } +} + +func addEvent(events []*fileEvent, ev *fileEvent) []*fileEvent { + switch ev.status { + case fileStatusNone: + return events + case fileStatusReloadStart: + events = events[0:0] + case fileStatusUpdate, fileStatusDelete: + if len(events) > 0 && mergeEvents(events, ev) { + return events + } + } + return append(events, ev) +} + +func mergeEvents(events []*fileEvent, ev *fileEvent) bool { + for i := len(events) - 1; i >= 0; i-- { + oev := events[i] + switch oev.status { + case fileStatusReloadStart, fileStatusReloadEnd: + return false + case fileStatusUpdate, fileStatusDelete: + if ev.path == oev.path { + if ev.status == oev.status { + return true + } + oev.status = fileStatusNone + return false + } + } + } + return false +} + +func collectEvents(out chan<- *fileEvent, in <-chan *fileEvent) { + defer close(out) + + var sendTime time.Time + sendTimeSet := false + ticker := time.NewTicker(500 * time.Millisecond) + defer ticker.Stop() + + events := make([]*fileEvent, 0, 32) + buffer := false + for { + select { + case ev, ok := <-in: + if !ok { + sendCollectedEvents(out, events) + return + } + if ev.status == fileStatusReloadStart { + buffer = false + events = events[0:0] + } + if buffer { + if !sendTimeSet { + sendTime = time.Now().Add(1500 * time.Millisecond) + sendTimeSet = true + } + events = addEvent(events, ev) + if len(events) > 1024 { + sendCollectedEvents(out, events) + events = events[0:0] + sendTimeSet = false + } + continue + } + out <- ev + if ev.status == fileStatusReloadEnd { + buffer = true + } + case now := <-ticker.C: + if sendTimeSet && now.After(sendTime) { + sendCollectedEvents(out, events) + events = events[0:0] + sendTimeSet = false + } + } + } +} ADDED box/dirbox/notifydir/watch_test.go Index: box/dirbox/notifydir/watch_test.go ================================================================== --- box/dirbox/notifydir/watch_test.go +++ box/dirbox/notifydir/watch_test.go @@ -0,0 +1,56 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package notifydir manages the notified directory part of a dirstore. +package notifydir + +import "testing" + +func sameStringSlices(sl1, sl2 []string) bool { + if len(sl1) != len(sl2) { + return false + } + for i := 0; i < len(sl1); i++ { + if sl1[i] != sl2[i] { + return false + } + } + return true +} + +func TestMatchValidFileName(t *testing.T) { + t.Parallel() + testcases := []struct { + name string + exp []string + }{ + {"", []string{}}, + {".txt", []string{}}, + {"12345678901234.txt", []string{"12345678901234", ".txt", "txt"}}, + {"12345678901234abc.txt", []string{"12345678901234", ".txt", "txt"}}, + {"12345678901234.abc.txt", []string{"12345678901234", ".txt", "txt"}}, + } + + for i, tc := range testcases { + got := matchValidFileName(tc.name) + if len(got) == 0 { + if len(tc.exp) > 0 { + t.Errorf("TC=%d, name=%q, exp=%v, got=%v", i, tc.name, tc.exp, got) + } + } else { + if got[0] != tc.name { + t.Errorf("TC=%d, name=%q, got=%v", i, tc.name, got) + } + if !sameStringSlices(got[1:], tc.exp) { + t.Errorf("TC=%d, name=%q, exp=%v, got=%v", i, tc.name, tc.exp, got) + } + } + } +} ADDED box/dirbox/service.go Index: box/dirbox/service.go ================================================================== --- box/dirbox/service.go +++ box/dirbox/service.go @@ -0,0 +1,290 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package dirbox provides a directory-based zettel box. +package dirbox + +import ( + "os" + + "zettelstore.de/z/box/dirbox/directory" + "zettelstore.de/z/box/filebox" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/input" +) + +func fileService(num uint32, cmds <-chan fileCmd) { + for cmd := range cmds { + cmd.run() + } +} + +type fileCmd interface { + run() +} + +// COMMAND: getMeta ---------------------------------------- +// +// Retrieves the meta data from a zettel. + +func getMeta(dp *dirBox, entry *directory.Entry, zid id.Zid) (*meta.Meta, error) { + rc := make(chan resGetMeta) + dp.getFileChan(zid) <- &fileGetMeta{entry, rc} + res := <-rc + close(rc) + return res.meta, res.err +} + +type fileGetMeta struct { + entry *directory.Entry + rc chan<- resGetMeta +} +type resGetMeta struct { + meta *meta.Meta + err error +} + +func (cmd *fileGetMeta) run() { + entry := cmd.entry + var m *meta.Meta + var err error + switch entry.MetaSpec { + case directory.MetaSpecFile: + m, err = parseMetaFile(entry.Zid, entry.MetaPath) + case directory.MetaSpecHeader: + m, _, err = parseMetaContentFile(entry.Zid, entry.ContentPath) + default: + m = filebox.CalcDefaultMeta(entry.Zid, entry.ContentExt) + } + if err == nil { + cmdCleanupMeta(m, entry) + } + cmd.rc <- resGetMeta{m, err} +} + +// COMMAND: getMetaContent ---------------------------------------- +// +// Retrieves the meta data and the content of a zettel. + +func getMetaContent(dp *dirBox, entry *directory.Entry, zid id.Zid) (*meta.Meta, string, error) { + rc := make(chan resGetMetaContent) + dp.getFileChan(zid) <- &fileGetMetaContent{entry, rc} + res := <-rc + close(rc) + return res.meta, res.content, res.err +} + +type fileGetMetaContent struct { + entry *directory.Entry + rc chan<- resGetMetaContent +} +type resGetMetaContent struct { + meta *meta.Meta + content string + err error +} + +func (cmd *fileGetMetaContent) run() { + var m *meta.Meta + var content string + var err error + + entry := cmd.entry + switch entry.MetaSpec { + case directory.MetaSpecFile: + m, err = parseMetaFile(entry.Zid, entry.MetaPath) + if err == nil { + content, err = readFileContent(entry.ContentPath) + } + case directory.MetaSpecHeader: + m, content, err = parseMetaContentFile(entry.Zid, entry.ContentPath) + default: + m = filebox.CalcDefaultMeta(entry.Zid, entry.ContentExt) + content, err = readFileContent(entry.ContentPath) + } + if err == nil { + cmdCleanupMeta(m, entry) + } + cmd.rc <- resGetMetaContent{m, content, err} +} + +// COMMAND: setZettel ---------------------------------------- +// +// Writes a new or exsting zettel. + +func setZettel(dp *dirBox, entry *directory.Entry, zettel domain.Zettel) error { + rc := make(chan resSetZettel) + dp.getFileChan(zettel.Meta.Zid) <- &fileSetZettel{entry, zettel, rc} + err := <-rc + close(rc) + return err +} + +type fileSetZettel struct { + entry *directory.Entry + zettel domain.Zettel + rc chan<- resSetZettel +} +type resSetZettel = error + +func (cmd *fileSetZettel) run() { + var err error + switch cmd.entry.MetaSpec { + case directory.MetaSpecFile: + err = cmd.runMetaSpecFile() + case directory.MetaSpecHeader: + err = cmd.runMetaSpecHeader() + case directory.MetaSpecNone: + // TODO: if meta has some additional infos: write meta to new .meta; + // update entry in dir + err = writeFileContent(cmd.entry.ContentPath, cmd.zettel.Content.AsString()) + default: + panic("TODO: ???") + } + cmd.rc <- err +} + +func (cmd *fileSetZettel) runMetaSpecFile() error { + f, err := openFileWrite(cmd.entry.MetaPath) + if err == nil { + err = writeFileZid(f, cmd.zettel.Meta.Zid) + if err == nil { + _, err = cmd.zettel.Meta.Write(f, true) + if err1 := f.Close(); err == nil { + err = err1 + } + if err == nil { + err = writeFileContent(cmd.entry.ContentPath, cmd.zettel.Content.AsString()) + } + } + } + return err +} + +func (cmd *fileSetZettel) runMetaSpecHeader() error { + f, err := openFileWrite(cmd.entry.ContentPath) + if err == nil { + err = writeFileZid(f, cmd.zettel.Meta.Zid) + if err == nil { + _, err = cmd.zettel.Meta.WriteAsHeader(f, true) + if err == nil { + _, err = f.WriteString(cmd.zettel.Content.AsString()) + if err1 := f.Close(); err == nil { + err = err1 + } + } + } + } + return err +} + +// COMMAND: deleteZettel ---------------------------------------- +// +// Deletes an existing zettel. + +func deleteZettel(dp *dirBox, entry *directory.Entry, zid id.Zid) error { + rc := make(chan resDeleteZettel) + dp.getFileChan(zid) <- &fileDeleteZettel{entry, rc} + err := <-rc + close(rc) + return err +} + +type fileDeleteZettel struct { + entry *directory.Entry + rc chan<- resDeleteZettel +} +type resDeleteZettel = error + +func (cmd *fileDeleteZettel) run() { + var err error + + switch cmd.entry.MetaSpec { + case directory.MetaSpecFile: + err1 := os.Remove(cmd.entry.MetaPath) + err = os.Remove(cmd.entry.ContentPath) + if err == nil { + err = err1 + } + case directory.MetaSpecHeader: + err = os.Remove(cmd.entry.ContentPath) + case directory.MetaSpecNone: + err = os.Remove(cmd.entry.ContentPath) + default: + panic("TODO: ???") + } + cmd.rc <- err +} + +// Utility functions ---------------------------------------- + +func readFileContent(path string) (string, error) { + data, err := os.ReadFile(path) + if err != nil { + return "", err + } + return string(data), nil +} + +func parseMetaFile(zid id.Zid, path string) (*meta.Meta, error) { + src, err := readFileContent(path) + if err != nil { + return nil, err + } + inp := input.NewInput(src) + return meta.NewFromInput(zid, inp), nil +} + +func parseMetaContentFile(zid id.Zid, path string) (*meta.Meta, string, error) { + src, err := readFileContent(path) + if err != nil { + return nil, "", err + } + inp := input.NewInput(src) + meta := meta.NewFromInput(zid, inp) + return meta, src[inp.Pos:], nil +} + +func cmdCleanupMeta(m *meta.Meta, entry *directory.Entry) { + filebox.CleanupMeta( + m, + entry.Zid, entry.ContentExt, + entry.MetaSpec == directory.MetaSpecFile, + entry.Duplicates, + ) +} + +func openFileWrite(path string) (*os.File, error) { + return os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600) +} + +func writeFileZid(f *os.File, zid id.Zid) error { + _, err := f.WriteString("id: ") + if err == nil { + _, err = f.Write(zid.Bytes()) + if err == nil { + _, err = f.WriteString("\n") + } + } + return err +} + +func writeFileContent(path, content string) error { + f, err := openFileWrite(path) + if err == nil { + _, err = f.WriteString(content) + if err1 := f.Close(); err == nil { + err = err1 + } + } + return err +} ADDED box/dirbox/simpledir/simpledir.go Index: box/dirbox/simpledir/simpledir.go ================================================================== --- box/dirbox/simpledir/simpledir.go +++ box/dirbox/simpledir/simpledir.go @@ -0,0 +1,185 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package simpledir manages the directory part of a dirstore. +package simpledir + +import ( + "os" + "path/filepath" + "regexp" + "sync" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/dirbox/directory" + "zettelstore.de/z/domain/id" +) + +// simpleService specifies a directory service without scanning. +type simpleService struct { + dirPath string + mx sync.Mutex +} + +// NewService creates a new directory service. +func NewService(directoryPath string) directory.Service { + return &simpleService{ + dirPath: directoryPath, + } +} + +func (ss *simpleService) Start() error { + ss.mx.Lock() + defer ss.mx.Unlock() + _, err := os.ReadDir(ss.dirPath) + return err +} + +func (ss *simpleService) Stop() error { + return nil +} + +func (ss *simpleService) NumEntries() (int, error) { + ss.mx.Lock() + defer ss.mx.Unlock() + entries, err := ss.getEntries() + if err == nil { + return len(entries), nil + } + return 0, err +} + +func (ss *simpleService) GetEntries() ([]*directory.Entry, error) { + ss.mx.Lock() + defer ss.mx.Unlock() + entrySet, err := ss.getEntries() + if err != nil { + return nil, err + } + result := make([]*directory.Entry, 0, len(entrySet)) + for _, entry := range entrySet { + result = append(result, entry) + } + return result, nil +} +func (ss *simpleService) getEntries() (map[id.Zid]*directory.Entry, error) { + dirEntries, err := os.ReadDir(ss.dirPath) + if err != nil { + return nil, err + } + entrySet := make(map[id.Zid]*directory.Entry) + for _, dirEntry := range dirEntries { + if dirEntry.IsDir() { + continue + } + if info, err1 := dirEntry.Info(); err1 != nil || !info.Mode().IsRegular() { + continue + } + name := dirEntry.Name() + match := matchValidFileName(name) + if len(match) == 0 { + continue + } + zid, err := id.Parse(match[1]) + if err != nil { + continue + } + var entry *directory.Entry + if e, ok := entrySet[zid]; ok { + entry = e + } else { + entry = &directory.Entry{Zid: zid} + entrySet[zid] = entry + } + updateEntry(entry, filepath.Join(ss.dirPath, name), match[3]) + } + return entrySet, nil +} + +var validFileName = regexp.MustCompile(`^(\d{14}).*(\.(.+))$`) + +func matchValidFileName(name string) []string { + return validFileName.FindStringSubmatch(name) +} + +func updateEntry(entry *directory.Entry, path, ext string) { + if ext == "meta" { + entry.MetaSpec = directory.MetaSpecFile + entry.MetaPath = path + } else if entry.ContentExt != "" && entry.ContentExt != ext { + entry.Duplicates = true + } else { + if entry.MetaSpec != directory.MetaSpecFile { + if ext == "zettel" { + entry.MetaSpec = directory.MetaSpecHeader + } else { + entry.MetaSpec = directory.MetaSpecNone + } + } + entry.ContentPath = path + entry.ContentExt = ext + } +} + +func (ss *simpleService) GetEntry(zid id.Zid) (*directory.Entry, error) { + ss.mx.Lock() + defer ss.mx.Unlock() + return ss.getEntry(zid) +} +func (ss *simpleService) getEntry(zid id.Zid) (*directory.Entry, error) { + pattern := filepath.Join(ss.dirPath, zid.String()) + "*.*" + paths, err := filepath.Glob(pattern) + if err != nil { + return nil, err + } + if len(paths) == 0 { + return nil, nil + } + entry := &directory.Entry{Zid: zid} + for _, path := range paths { + ext := filepath.Ext(path) + if len(ext) > 0 && ext[0] == '.' { + ext = ext[1:] + } + updateEntry(entry, path, ext) + } + return entry, nil +} + +func (ss *simpleService) GetNew() (*directory.Entry, error) { + ss.mx.Lock() + defer ss.mx.Unlock() + zid, err := box.GetNewZid(func(zid id.Zid) (bool, error) { + entry, err := ss.getEntry(zid) + if err != nil { + return false, nil + } + return !entry.IsValid(), nil + }) + if err != nil { + return nil, err + } + return &directory.Entry{Zid: zid}, nil +} + +func (ss *simpleService) UpdateEntry(entry *directory.Entry) error { + // Nothing to to, since the actual file update is done by dirbox. + return nil +} + +func (ss *simpleService) RenameEntry(curEntry, newEntry *directory.Entry) error { + // Nothing to to, since the actual file rename is done by dirbox. + return nil +} + +func (ss *simpleService) DeleteEntry(zid id.Zid) error { + // Nothing to to, since the actual file delete is done by dirbox. + return nil +} ADDED box/filebox/filebox.go Index: box/filebox/filebox.go ================================================================== --- box/filebox/filebox.go +++ box/filebox/filebox.go @@ -0,0 +1,94 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package filebox provides boxes that are stored in a file. +package filebox + +import ( + "errors" + "net/url" + "path/filepath" + "strings" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/manager" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" +) + +func init() { + manager.Register("file", func(u *url.URL, cdata *manager.ConnectData) (box.ManagedBox, error) { + path := getFilepathFromURL(u) + ext := strings.ToLower(filepath.Ext(path)) + if ext != ".zip" { + return nil, errors.New("unknown extension '" + ext + "' in box URL: " + u.String()) + } + return &zipBox{ + number: cdata.Number, + name: path, + enricher: cdata.Enricher, + }, nil + }) +} + +func getFilepathFromURL(u *url.URL) string { + name := u.Opaque + if name == "" { + name = u.Path + } + components := strings.Split(name, "/") + fileName := filepath.Join(components...) + if len(components) > 0 && components[0] == "" { + return "/" + fileName + } + return fileName +} + +var alternativeSyntax = map[string]string{ + "htm": "html", +} + +func calculateSyntax(ext string) string { + ext = strings.ToLower(ext) + if syntax, ok := alternativeSyntax[ext]; ok { + return syntax + } + return ext +} + +// CalcDefaultMeta returns metadata with default values for the given entry. +func CalcDefaultMeta(zid id.Zid, ext string) *meta.Meta { + m := meta.New(zid) + m.Set(meta.KeyTitle, zid.String()) + m.Set(meta.KeySyntax, calculateSyntax(ext)) + return m +} + +// CleanupMeta enhances the given metadata. +func CleanupMeta(m *meta.Meta, zid id.Zid, ext string, inMeta, duplicates bool) { + if title, ok := m.Get(meta.KeyTitle); !ok || title == "" { + m.Set(meta.KeyTitle, zid.String()) + } + + if inMeta { + if syntax, ok := m.Get(meta.KeySyntax); !ok || syntax == "" { + dm := CalcDefaultMeta(zid, ext) + syntax, ok = dm.Get(meta.KeySyntax) + if !ok { + panic("Default meta must contain syntax") + } + m.Set(meta.KeySyntax, syntax) + } + } + + if duplicates { + m.Set(meta.KeyDuplicates, meta.ValueTrue) + } +} ADDED box/filebox/zipbox.go Index: box/filebox/zipbox.go ================================================================== --- box/filebox/zipbox.go +++ box/filebox/zipbox.go @@ -0,0 +1,261 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package filebox provides boxes that are stored in a file. +package filebox + +import ( + "archive/zip" + "context" + "io" + "regexp" + "strings" + + "zettelstore.de/z/box" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/input" + "zettelstore.de/z/search" +) + +var validFileName = regexp.MustCompile(`^(\d{14}).*(\.(.+))$`) + +func matchValidFileName(name string) []string { + return validFileName.FindStringSubmatch(name) +} + +type zipEntry struct { + metaName string + contentName string + contentExt string // (normalized) file extension of zettel content + metaInHeader bool +} + +type zipBox struct { + number int + name string + enricher box.Enricher + zettel map[id.Zid]*zipEntry // no lock needed, because read-only after creation +} + +func (zp *zipBox) Location() string { + if strings.HasPrefix(zp.name, "/") { + return "file://" + zp.name + } + return "file:" + zp.name +} + +func (zp *zipBox) Start(ctx context.Context) error { + reader, err := zip.OpenReader(zp.name) + if err != nil { + return err + } + defer reader.Close() + zp.zettel = make(map[id.Zid]*zipEntry) + for _, f := range reader.File { + match := matchValidFileName(f.Name) + if len(match) < 1 { + continue + } + zid, err := id.Parse(match[1]) + if err != nil { + continue + } + zp.addFile(zid, f.Name, match[3]) + } + return nil +} + +func (zp *zipBox) addFile(zid id.Zid, name, ext string) { + entry := zp.zettel[zid] + if entry == nil { + entry = &zipEntry{} + zp.zettel[zid] = entry + } + switch ext { + case "zettel": + if entry.contentExt == "" { + entry.contentName = name + entry.contentExt = ext + entry.metaInHeader = true + } + case "meta": + entry.metaName = name + entry.metaInHeader = false + default: + if entry.contentExt == "" { + entry.contentExt = ext + entry.contentName = name + } + } +} + +func (zp *zipBox) Stop(ctx context.Context) error { + zp.zettel = nil + return nil +} + +func (zp *zipBox) CanCreateZettel(ctx context.Context) bool { return false } + +func (zp *zipBox) CreateZettel(ctx context.Context, zettel domain.Zettel) (id.Zid, error) { + return id.Invalid, box.ErrReadOnly +} + +func (zp *zipBox) GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) { + entry, ok := zp.zettel[zid] + if !ok { + return domain.Zettel{}, box.ErrNotFound + } + reader, err := zip.OpenReader(zp.name) + if err != nil { + return domain.Zettel{}, err + } + defer reader.Close() + + var m *meta.Meta + var src string + var inMeta bool + if entry.metaInHeader { + src, err = readZipFileContent(reader, entry.contentName) + if err != nil { + return domain.Zettel{}, err + } + inp := input.NewInput(src) + m = meta.NewFromInput(zid, inp) + src = src[inp.Pos:] + } else if metaName := entry.metaName; metaName != "" { + m, err = readZipMetaFile(reader, zid, metaName) + if err != nil { + return domain.Zettel{}, err + } + src, err = readZipFileContent(reader, entry.contentName) + if err != nil { + return domain.Zettel{}, err + } + inMeta = true + } else { + m = CalcDefaultMeta(zid, entry.contentExt) + } + CleanupMeta(m, zid, entry.contentExt, inMeta, false) + return domain.Zettel{Meta: m, Content: domain.NewContent(src)}, nil +} + +func (zp *zipBox) GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) { + entry, ok := zp.zettel[zid] + if !ok { + return nil, box.ErrNotFound + } + reader, err := zip.OpenReader(zp.name) + if err != nil { + return nil, err + } + defer reader.Close() + return readZipMeta(reader, zid, entry) +} + +func (zp *zipBox) FetchZids(ctx context.Context) (id.Set, error) { + result := id.NewSetCap(len(zp.zettel)) + for zid := range zp.zettel { + result[zid] = true + } + return result, nil +} + +func (zp *zipBox) SelectMeta(ctx context.Context, match search.MetaMatchFunc) (res []*meta.Meta, err error) { + reader, err := zip.OpenReader(zp.name) + if err != nil { + return nil, err + } + defer reader.Close() + for zid, entry := range zp.zettel { + m, err := readZipMeta(reader, zid, entry) + if err != nil { + continue + } + zp.enricher.Enrich(ctx, m, zp.number) + if match(m) { + res = append(res, m) + } + } + return res, nil +} + +func (zp *zipBox) CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool { + return false +} + +func (zp *zipBox) UpdateZettel(ctx context.Context, zettel domain.Zettel) error { + return box.ErrReadOnly +} + +func (zp *zipBox) AllowRenameZettel(ctx context.Context, zid id.Zid) bool { + _, ok := zp.zettel[zid] + return !ok +} + +func (zp *zipBox) RenameZettel(ctx context.Context, curZid, newZid id.Zid) error { + if _, ok := zp.zettel[curZid]; ok { + return box.ErrReadOnly + } + return box.ErrNotFound +} + +func (zp *zipBox) CanDeleteZettel(ctx context.Context, zid id.Zid) bool { return false } + +func (zp *zipBox) DeleteZettel(ctx context.Context, zid id.Zid) error { + if _, ok := zp.zettel[zid]; ok { + return box.ErrReadOnly + } + return box.ErrNotFound +} + +func (zp *zipBox) ReadStats(st *box.ManagedBoxStats) { + st.ReadOnly = true + st.Zettel = len(zp.zettel) +} + +func readZipMeta(reader *zip.ReadCloser, zid id.Zid, entry *zipEntry) (m *meta.Meta, err error) { + var inMeta bool + if entry.metaInHeader { + m, err = readZipMetaFile(reader, zid, entry.contentName) + } else if metaName := entry.metaName; metaName != "" { + m, err = readZipMetaFile(reader, zid, entry.metaName) + inMeta = true + } else { + m = CalcDefaultMeta(zid, entry.contentExt) + } + if err == nil { + CleanupMeta(m, zid, entry.contentExt, inMeta, false) + } + return m, err +} + +func readZipMetaFile(reader *zip.ReadCloser, zid id.Zid, name string) (*meta.Meta, error) { + src, err := readZipFileContent(reader, name) + if err != nil { + return nil, err + } + inp := input.NewInput(src) + return meta.NewFromInput(zid, inp), nil +} + +func readZipFileContent(reader *zip.ReadCloser, name string) (string, error) { + f, err := reader.Open(name) + if err != nil { + return "", err + } + defer f.Close() + buf, err := io.ReadAll(f) + if err != nil { + return "", err + } + return string(buf), nil +} ADDED box/helper.go Index: box/helper.go ================================================================== --- box/helper.go +++ box/helper.go @@ -0,0 +1,37 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package box provides a generic interface to zettel boxes. +package box + +import ( + "time" + + "zettelstore.de/z/domain/id" +) + +// GetNewZid calculates a new and unused zettel identifier, based on the current date and time. +func GetNewZid(testZid func(id.Zid) (bool, error)) (id.Zid, error) { + withSeconds := false + for i := 0; i < 90; i++ { // Must be completed within 9 seconds (less than web/server.writeTimeout) + zid := id.New(withSeconds) + found, err := testZid(zid) + if err != nil { + return id.Invalid, err + } + if found { + return zid, nil + } + // TODO: do not wait here unconditionally. + time.Sleep(100 * time.Millisecond) + withSeconds = true + } + return id.Invalid, ErrConflict +} ADDED box/manager/anteroom.go Index: box/manager/anteroom.go ================================================================== --- box/manager/anteroom.go +++ box/manager/anteroom.go @@ -0,0 +1,165 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package manager coordinates the various boxes and indexes of a Zettelstore. +package manager + +import ( + "sync" + + "zettelstore.de/z/domain/id" +) + +type arAction int + +const ( + arNothing arAction = iota + arReload + arUpdate + arDelete +) + +type anteroom struct { + num uint64 + next *anteroom + waiting map[id.Zid]arAction + curLoad int + reload bool +} + +type anterooms struct { + mx sync.Mutex + nextNum uint64 + first *anteroom + last *anteroom + maxLoad int +} + +func newAnterooms(maxLoad int) *anterooms { + return &anterooms{maxLoad: maxLoad} +} + +func (ar *anterooms) Enqueue(zid id.Zid, action arAction) { + if !zid.IsValid() || action == arNothing || action == arReload { + return + } + ar.mx.Lock() + defer ar.mx.Unlock() + if ar.first == nil { + ar.first = ar.makeAnteroom(zid, action) + ar.last = ar.first + return + } + for room := ar.first; room != nil; room = room.next { + if room.reload { + continue // Do not put zettel in reload room + } + a, ok := room.waiting[zid] + if !ok { + continue + } + switch action { + case a: + return + case arUpdate: + room.waiting[zid] = action + case arDelete: + room.waiting[zid] = action + } + return + } + if room := ar.last; !room.reload && (ar.maxLoad == 0 || room.curLoad < ar.maxLoad) { + room.waiting[zid] = action + room.curLoad++ + return + } + room := ar.makeAnteroom(zid, action) + ar.last.next = room + ar.last = room +} + +func (ar *anterooms) makeAnteroom(zid id.Zid, action arAction) *anteroom { + c := ar.maxLoad + if c == 0 { + c = 100 + } + waiting := make(map[id.Zid]arAction, c) + waiting[zid] = action + ar.nextNum++ + return &anteroom{num: ar.nextNum, next: nil, waiting: waiting, curLoad: 1, reload: false} +} + +func (ar *anterooms) Reset() { + ar.mx.Lock() + defer ar.mx.Unlock() + ar.first = ar.makeAnteroom(id.Invalid, arReload) + ar.last = ar.first +} + +func (ar *anterooms) Reload(newZids id.Set) uint64 { + ar.mx.Lock() + defer ar.mx.Unlock() + newWaiting := createWaitingSet(newZids, arUpdate) + ar.deleteReloadedRooms() + + if ns := len(newWaiting); ns > 0 { + ar.nextNum++ + ar.first = &anteroom{num: ar.nextNum, next: ar.first, waiting: newWaiting, curLoad: ns} + if ar.first.next == nil { + ar.last = ar.first + } + return ar.nextNum + } + + ar.first = nil + ar.last = nil + return 0 +} + +func createWaitingSet(zids id.Set, action arAction) map[id.Zid]arAction { + waitingSet := make(map[id.Zid]arAction, len(zids)) + for zid := range zids { + if zid.IsValid() { + waitingSet[zid] = action + } + } + return waitingSet +} + +func (ar *anterooms) deleteReloadedRooms() { + room := ar.first + for room != nil && room.reload { + room = room.next + } + ar.first = room + if room == nil { + ar.last = nil + } +} + +func (ar *anterooms) Dequeue() (arAction, id.Zid, uint64) { + ar.mx.Lock() + defer ar.mx.Unlock() + if ar.first == nil { + return arNothing, id.Invalid, 0 + } + for zid, action := range ar.first.waiting { + roomNo := ar.first.num + delete(ar.first.waiting, zid) + if len(ar.first.waiting) == 0 { + ar.first = ar.first.next + if ar.first == nil { + ar.last = nil + } + } + return action, zid, roomNo + } + return arNothing, id.Invalid, 0 +} ADDED box/manager/anteroom_test.go Index: box/manager/anteroom_test.go ================================================================== --- box/manager/anteroom_test.go +++ box/manager/anteroom_test.go @@ -0,0 +1,109 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package manager coordinates the various boxes and indexes of a Zettelstore. +package manager + +import ( + "testing" + + "zettelstore.de/z/domain/id" +) + +func TestSimple(t *testing.T) { + t.Parallel() + ar := newAnterooms(2) + ar.Enqueue(id.Zid(1), arUpdate) + action, zid, rno := ar.Dequeue() + if zid != id.Zid(1) || action != arUpdate || rno != 1 { + t.Errorf("Expected arUpdate/1/1, but got %v/%v/%v", action, zid, rno) + } + action, zid, _ = ar.Dequeue() + if zid != id.Invalid && action != arDelete { + t.Errorf("Expected invalid Zid, but got %v", zid) + } + ar.Enqueue(id.Zid(1), arUpdate) + ar.Enqueue(id.Zid(2), arUpdate) + if ar.first != ar.last { + t.Errorf("Expected one room, but got more") + } + ar.Enqueue(id.Zid(3), arUpdate) + if ar.first == ar.last { + t.Errorf("Expected more than one room, but got only one") + } + + count := 0 + for ; count < 1000; count++ { + action, _, _ := ar.Dequeue() + if action == arNothing { + break + } + } + if count != 3 { + t.Errorf("Expected 3 dequeues, but got %v", count) + } +} + +func TestReset(t *testing.T) { + t.Parallel() + ar := newAnterooms(1) + ar.Enqueue(id.Zid(1), arUpdate) + ar.Reset() + action, zid, _ := ar.Dequeue() + if action != arReload || zid != id.Invalid { + t.Errorf("Expected reload & invalid Zid, but got %v/%v", action, zid) + } + ar.Reload(id.NewSet(3, 4)) + ar.Enqueue(id.Zid(5), arUpdate) + ar.Enqueue(id.Zid(5), arDelete) + ar.Enqueue(id.Zid(5), arDelete) + ar.Enqueue(id.Zid(5), arUpdate) + if ar.first == ar.last || ar.first.next != ar.last /*|| ar.first.next.next != ar.last*/ { + t.Errorf("Expected 2 rooms") + } + action, zid1, _ := ar.Dequeue() + if action != arUpdate { + t.Errorf("Expected arUpdate, but got %v", action) + } + action, zid2, _ := ar.Dequeue() + if action != arUpdate { + t.Errorf("Expected arUpdate, but got %v", action) + } + if !(zid1 == id.Zid(3) && zid2 == id.Zid(4) || zid1 == id.Zid(4) && zid2 == id.Zid(3)) { + t.Errorf("Zids must be 3 or 4, but got %v/%v", zid1, zid2) + } + action, zid, _ = ar.Dequeue() + if zid != id.Zid(5) || action != arUpdate { + t.Errorf("Expected 5/arUpdate, but got %v/%v", zid, action) + } + action, zid, _ = ar.Dequeue() + if action != arNothing || zid != id.Invalid { + t.Errorf("Expected nothing & invalid Zid, but got %v/%v", action, zid) + } + + ar = newAnterooms(1) + ar.Reload(id.NewSet(id.Zid(6))) + action, zid, _ = ar.Dequeue() + if zid != id.Zid(6) || action != arUpdate { + t.Errorf("Expected 6/arUpdate, but got %v/%v", zid, action) + } + action, zid, _ = ar.Dequeue() + if action != arNothing || zid != id.Invalid { + t.Errorf("Expected nothing & invalid Zid, but got %v/%v", action, zid) + } + + ar = newAnterooms(1) + ar.Enqueue(id.Zid(8), arUpdate) + ar.Reload(nil) + action, zid, _ = ar.Dequeue() + if action != arNothing || zid != id.Invalid { + t.Errorf("Expected nothing & invalid Zid, but got %v/%v", action, zid) + } +} ADDED box/manager/box.go Index: box/manager/box.go ================================================================== --- box/manager/box.go +++ box/manager/box.go @@ -0,0 +1,277 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package manager coordinates the various boxes and indexes of a Zettelstore. +package manager + +import ( + "context" + "errors" + "sort" + "strings" + + "zettelstore.de/z/box" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/search" +) + +// Conatains all box.Box related functions + +// Location returns some information where the box is located. +func (mgr *Manager) Location() string { + if len(mgr.boxes) <= 2 { + return "NONE" + } + var sb strings.Builder + for i := 0; i < len(mgr.boxes)-2; i++ { + if i > 0 { + sb.WriteString(", ") + } + sb.WriteString(mgr.boxes[i].Location()) + } + return sb.String() +} + +// CanCreateZettel returns true, if box could possibly create a new zettel. +func (mgr *Manager) CanCreateZettel(ctx context.Context) bool { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + return mgr.started && mgr.boxes[0].CanCreateZettel(ctx) +} + +// CreateZettel creates a new zettel. +func (mgr *Manager) CreateZettel(ctx context.Context, zettel domain.Zettel) (id.Zid, error) { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return id.Invalid, box.ErrStopped + } + return mgr.boxes[0].CreateZettel(ctx, zettel) +} + +// GetZettel retrieves a specific zettel. +func (mgr *Manager) GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return domain.Zettel{}, box.ErrStopped + } + for i, p := range mgr.boxes { + if z, err := p.GetZettel(ctx, zid); err != box.ErrNotFound { + if err == nil { + mgr.Enrich(ctx, z.Meta, i+1) + } + return z, err + } + } + return domain.Zettel{}, box.ErrNotFound +} + +// GetAllZettel retrieves a specific zettel from all managed boxes. +func (mgr *Manager) GetAllZettel(ctx context.Context, zid id.Zid) ([]domain.Zettel, error) { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return nil, box.ErrStopped + } + var result []domain.Zettel + for i, p := range mgr.boxes { + if z, err := p.GetZettel(ctx, zid); err == nil { + mgr.Enrich(ctx, z.Meta, i+1) + result = append(result, z) + } + } + return result, nil +} + +// GetMeta retrieves just the meta data of a specific zettel. +func (mgr *Manager) GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return nil, box.ErrStopped + } + for i, p := range mgr.boxes { + if m, err := p.GetMeta(ctx, zid); err != box.ErrNotFound { + if err == nil { + mgr.Enrich(ctx, m, i+1) + } + return m, err + } + } + return nil, box.ErrNotFound +} + +// GetAllMeta retrieves the meta data of a specific zettel from all managed boxes. +func (mgr *Manager) GetAllMeta(ctx context.Context, zid id.Zid) ([]*meta.Meta, error) { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return nil, box.ErrStopped + } + var result []*meta.Meta + for i, p := range mgr.boxes { + if m, err := p.GetMeta(ctx, zid); err == nil { + mgr.Enrich(ctx, m, i+1) + result = append(result, m) + } + } + return result, nil +} + +// FetchZids returns the set of all zettel identifer managed by the box. +func (mgr *Manager) FetchZids(ctx context.Context) (result id.Set, err error) { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return nil, box.ErrStopped + } + for _, p := range mgr.boxes { + zids, err := p.FetchZids(ctx) + if err != nil { + return nil, err + } + if result == nil { + result = zids + } else if len(result) <= len(zids) { + for zid := range result { + zids[zid] = true + } + result = zids + } else { + for zid := range zids { + result[zid] = true + } + } + } + return result, nil +} + +// SelectMeta returns all zettel meta data that match the selection +// criteria. The result is ordered by descending zettel id. +func (mgr *Manager) SelectMeta(ctx context.Context, s *search.Search) ([]*meta.Meta, error) { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return nil, box.ErrStopped + } + var result []*meta.Meta + match := s.CompileMatch(mgr) + for _, p := range mgr.boxes { + selected, err := p.SelectMeta(ctx, match) + if err != nil { + return nil, err + } + sort.Slice(selected, func(i, j int) bool { return selected[i].Zid > selected[j].Zid }) + if len(result) == 0 { + result = selected + } else { + result = box.MergeSorted(result, selected) + } + } + if s == nil { + return result, nil + } + return s.Sort(result), nil +} + +// CanUpdateZettel returns true, if box could possibly update the given zettel. +func (mgr *Manager) CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + return mgr.started && mgr.boxes[0].CanUpdateZettel(ctx, zettel) +} + +// UpdateZettel updates an existing zettel. +func (mgr *Manager) UpdateZettel(ctx context.Context, zettel domain.Zettel) error { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return box.ErrStopped + } + // Remove all (computed) properties from metadata before storing the zettel. + zettel.Meta = zettel.Meta.Clone() + for _, p := range zettel.Meta.PairsRest(true) { + if mgr.propertyKeys[p.Key] { + zettel.Meta.Delete(p.Key) + } + } + return mgr.boxes[0].UpdateZettel(ctx, zettel) +} + +// AllowRenameZettel returns true, if box will not disallow renaming the zettel. +func (mgr *Manager) AllowRenameZettel(ctx context.Context, zid id.Zid) bool { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return false + } + for _, p := range mgr.boxes { + if !p.AllowRenameZettel(ctx, zid) { + return false + } + } + return true +} + +// RenameZettel changes the current zid to a new zid. +func (mgr *Manager) RenameZettel(ctx context.Context, curZid, newZid id.Zid) error { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return box.ErrStopped + } + for i, p := range mgr.boxes { + err := p.RenameZettel(ctx, curZid, newZid) + if err != nil && !errors.Is(err, box.ErrNotFound) { + for j := 0; j < i; j++ { + mgr.boxes[j].RenameZettel(ctx, newZid, curZid) + } + return err + } + } + return nil +} + +// CanDeleteZettel returns true, if box could possibly delete the given zettel. +func (mgr *Manager) CanDeleteZettel(ctx context.Context, zid id.Zid) bool { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return false + } + for _, p := range mgr.boxes { + if p.CanDeleteZettel(ctx, zid) { + return true + } + } + return false +} + +// DeleteZettel removes the zettel from the box. +func (mgr *Manager) DeleteZettel(ctx context.Context, zid id.Zid) error { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + if !mgr.started { + return box.ErrStopped + } + for _, p := range mgr.boxes { + err := p.DeleteZettel(ctx, zid) + if err == nil { + return nil + } + if !errors.Is(err, box.ErrNotFound) && !errors.Is(err, box.ErrReadOnly) { + return err + } + } + return box.ErrNotFound +} ADDED box/manager/collect.go Index: box/manager/collect.go ================================================================== --- box/manager/collect.go +++ box/manager/collect.go @@ -0,0 +1,82 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package manager coordinates the various boxes and indexes of a Zettelstore. +package manager + +import ( + "strings" + + "zettelstore.de/z/ast" + "zettelstore.de/z/box/manager/store" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/strfun" +) + +type collectData struct { + refs id.Set + words store.WordSet + urls store.WordSet +} + +func (data *collectData) initialize() { + data.refs = id.NewSet() + data.words = store.NewWordSet() + data.urls = store.NewWordSet() +} + +func collectZettelIndexData(zn *ast.ZettelNode, data *collectData) { + ast.WalkBlockSlice(data, zn.Ast) +} + +func collectInlineIndexData(ins ast.InlineSlice, data *collectData) { + ast.WalkInlineSlice(data, ins) +} + +func (data *collectData) Visit(node ast.Node) ast.Visitor { + switch n := node.(type) { + case *ast.VerbatimNode: + for _, line := range n.Lines { + data.addText(line) + } + case *ast.TextNode: + data.addText(n.Text) + case *ast.TagNode: + data.addText(n.Tag) + case *ast.LinkNode: + data.addRef(n.Ref) + case *ast.ImageNode: + data.addRef(n.Ref) + case *ast.LiteralNode: + data.addText(n.Text) + } + return data +} + +func (data *collectData) addText(s string) { + for _, word := range strfun.NormalizeWords(s) { + data.words.Add(word) + } +} + +func (data *collectData) addRef(ref *ast.Reference) { + if ref == nil { + return + } + if ref.IsExternal() { + data.urls.Add(strings.ToLower(ref.Value)) + } + if !ref.IsZettel() { + return + } + if zid, err := id.Parse(ref.URL.Path); err == nil { + data.refs[zid] = true + } +} ADDED box/manager/enrich.go Index: box/manager/enrich.go ================================================================== --- box/manager/enrich.go +++ box/manager/enrich.go @@ -0,0 +1,52 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package manager coordinates the various boxes and indexes of a Zettelstore. +package manager + +import ( + "context" + "strconv" + + "zettelstore.de/z/box" + "zettelstore.de/z/domain/meta" +) + +// Enrich computes additional properties and updates the given metadata. +func (mgr *Manager) Enrich(ctx context.Context, m *meta.Meta, boxNumber int) { + if box.DoNotEnrich(ctx) { + // Enrich is called indirectly via indexer or enrichment is not requested + // because of other reasons -> ignore this call, do not update meta data + return + } + m.Set(meta.KeyBoxNumber, strconv.Itoa(boxNumber)) + computePublished(m) + mgr.idxStore.Enrich(ctx, m) +} + +func computePublished(m *meta.Meta) { + if _, ok := m.Get(meta.KeyPublished); ok { + return + } + if modified, ok := m.Get(meta.KeyModified); ok { + if _, ok = meta.TimeValue(modified); ok { + m.Set(meta.KeyPublished, modified) + return + } + } + zid := m.Zid.String() + if _, ok := meta.TimeValue(zid); ok { + m.Set(meta.KeyPublished, zid) + return + } + + // Neither the zettel was modified nor the zettel identifer contains a valid + // timestamp. In this case do not set the "published" property. +} ADDED box/manager/indexer.go Index: box/manager/indexer.go ================================================================== --- box/manager/indexer.go +++ box/manager/indexer.go @@ -0,0 +1,227 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package manager coordinates the various boxes and indexes of a Zettelstore. +package manager + +import ( + "context" + "net/url" + "time" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/manager/store" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/kernel" + "zettelstore.de/z/parser" + "zettelstore.de/z/strfun" +) + +// SearchEqual returns all zettel that contains the given exact word. +// The word must be normalized through Unicode NKFD, trimmed and not empty. +func (mgr *Manager) SearchEqual(word string) id.Set { + return mgr.idxStore.SearchEqual(word) +} + +// SearchPrefix returns all zettel that have a word with the given prefix. +// The prefix must be normalized through Unicode NKFD, trimmed and not empty. +func (mgr *Manager) SearchPrefix(prefix string) id.Set { + return mgr.idxStore.SearchPrefix(prefix) +} + +// SearchSuffix returns all zettel that have a word with the given suffix. +// The suffix must be normalized through Unicode NKFD, trimmed and not empty. +func (mgr *Manager) SearchSuffix(suffix string) id.Set { + return mgr.idxStore.SearchSuffix(suffix) +} + +// SearchContains returns all zettel that contains the given string. +// The string must be normalized through Unicode NKFD, trimmed and not empty. +func (mgr *Manager) SearchContains(s string) id.Set { + return mgr.idxStore.SearchContains(s) +} + +// idxIndexer runs in the background and updates the index data structures. +// This is the main service of the idxIndexer. +func (mgr *Manager) idxIndexer() { + // Something may panic. Ensure a running indexer. + defer func() { + if r := recover(); r != nil { + kernel.Main.LogRecover("Indexer", r) + go mgr.idxIndexer() + } + }() + + timerDuration := 15 * time.Second + timer := time.NewTimer(timerDuration) + ctx := box.NoEnrichContext(context.Background()) + for { + mgr.idxWorkService(ctx) + if !mgr.idxSleepService(timer, timerDuration) { + return + } + } +} + +func (mgr *Manager) idxWorkService(ctx context.Context) { + var roomNum uint64 + var start time.Time + for { + switch action, zid, arRoomNum := mgr.idxAr.Dequeue(); action { + case arNothing: + return + case arReload: + roomNum = 0 + zids, err := mgr.FetchZids(ctx) + if err == nil { + start = time.Now() + if rno := mgr.idxAr.Reload(zids); rno > 0 { + roomNum = rno + } + mgr.idxMx.Lock() + mgr.idxLastReload = time.Now() + mgr.idxSinceReload = 0 + mgr.idxMx.Unlock() + } + case arUpdate: + zettel, err := mgr.GetZettel(ctx, zid) + if err != nil { + // TODO: on some errors put the zid into a "try later" set + continue + } + mgr.idxMx.Lock() + if arRoomNum == roomNum { + mgr.idxDurReload = time.Since(start) + } + mgr.idxSinceReload++ + mgr.idxMx.Unlock() + mgr.idxUpdateZettel(ctx, zettel) + case arDelete: + if _, err := mgr.GetMeta(ctx, zid); err == nil { + // Zettel was not deleted. This might occur, if zettel was + // deleted in secondary dirbox, but is still present in + // first dirbox (or vice versa). Re-index zettel in case + // a hidden zettel was recovered + mgr.idxAr.Enqueue(zid, arUpdate) + } + mgr.idxMx.Lock() + mgr.idxSinceReload++ + mgr.idxMx.Unlock() + mgr.idxDeleteZettel(zid) + } + } +} + +func (mgr *Manager) idxSleepService(timer *time.Timer, timerDuration time.Duration) bool { + select { + case _, ok := <-mgr.idxReady: + if !ok { + return false + } + case _, ok := <-timer.C: + if !ok { + return false + } + timer.Reset(timerDuration) + case <-mgr.done: + if !timer.Stop() { + <-timer.C + } + return false + } + return true +} + +func (mgr *Manager) idxUpdateZettel(ctx context.Context, zettel domain.Zettel) { + m := zettel.Meta + if m.GetBool(meta.KeyNoIndex) { + // Zettel maybe in index + toCheck := mgr.idxStore.DeleteZettel(ctx, m.Zid) + mgr.idxCheckZettel(toCheck) + return + } + + var cData collectData + cData.initialize() + collectZettelIndexData(parser.ParseZettel(zettel, "", mgr.rtConfig), &cData) + zi := store.NewZettelIndex(m.Zid) + mgr.idxCollectFromMeta(ctx, m, zi, &cData) + mgr.idxProcessData(ctx, zi, &cData) + toCheck := mgr.idxStore.UpdateReferences(ctx, zi) + mgr.idxCheckZettel(toCheck) +} + +func (mgr *Manager) idxCollectFromMeta(ctx context.Context, m *meta.Meta, zi *store.ZettelIndex, cData *collectData) { + for _, pair := range m.Pairs(false) { + descr := meta.GetDescription(pair.Key) + if descr.IsComputed() { + continue + } + switch descr.Type { + case meta.TypeID: + mgr.idxUpdateValue(ctx, descr.Inverse, pair.Value, zi) + case meta.TypeIDSet: + for _, val := range meta.ListFromValue(pair.Value) { + mgr.idxUpdateValue(ctx, descr.Inverse, val, zi) + } + case meta.TypeZettelmarkup: + collectInlineIndexData(parser.ParseMetadata(pair.Value), cData) + case meta.TypeURL: + if _, err := url.Parse(pair.Value); err == nil { + cData.urls.Add(pair.Value) + } + default: + for _, word := range strfun.NormalizeWords(pair.Value) { + cData.words.Add(word) + } + } + } +} + +func (mgr *Manager) idxProcessData(ctx context.Context, zi *store.ZettelIndex, cData *collectData) { + for ref := range cData.refs { + if _, err := mgr.GetMeta(ctx, ref); err == nil { + zi.AddBackRef(ref) + } else { + zi.AddDeadRef(ref) + } + } + zi.SetWords(cData.words) + zi.SetUrls(cData.urls) +} + +func (mgr *Manager) idxUpdateValue(ctx context.Context, inverseKey, value string, zi *store.ZettelIndex) { + zid, err := id.Parse(value) + if err != nil { + return + } + if _, err := mgr.GetMeta(ctx, zid); err != nil { + zi.AddDeadRef(zid) + return + } + if inverseKey == "" { + zi.AddBackRef(zid) + return + } + zi.AddMetaRef(inverseKey, zid) +} + +func (mgr *Manager) idxDeleteZettel(zid id.Zid) { + toCheck := mgr.idxStore.DeleteZettel(context.Background(), zid) + mgr.idxCheckZettel(toCheck) +} + +func (mgr *Manager) idxCheckZettel(s id.Set) { + for zid := range s { + mgr.idxAr.Enqueue(zid, arUpdate) + } +} ADDED box/manager/manager.go Index: box/manager/manager.go ================================================================== --- box/manager/manager.go +++ box/manager/manager.go @@ -0,0 +1,314 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package manager coordinates the various boxes and indexes of a Zettelstore. +package manager + +import ( + "context" + "io" + "log" + "net/url" + "sort" + "sync" + "time" + + "zettelstore.de/z/auth" + "zettelstore.de/z/box" + "zettelstore.de/z/box/manager/memstore" + "zettelstore.de/z/box/manager/store" + "zettelstore.de/z/config" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/kernel" +) + +// ConnectData contains all administration related values. +type ConnectData struct { + Number int // number of the box, starting with 1. + Config config.Config + Enricher box.Enricher + Notify chan<- box.UpdateInfo +} + +// Connect returns a handle to the specified box. +func Connect(u *url.URL, authManager auth.BaseManager, cdata *ConnectData) (box.ManagedBox, error) { + if authManager.IsReadonly() { + rawURL := u.String() + // TODO: the following is wrong under some circumstances: + // 1. fragment is set + if q := u.Query(); len(q) == 0 { + rawURL += "?readonly" + } else if _, ok := q["readonly"]; !ok { + rawURL += "&readonly" + } + var err error + if u, err = url.Parse(rawURL); err != nil { + return nil, err + } + } + + if create, ok := registry[u.Scheme]; ok { + return create(u, cdata) + } + return nil, &ErrInvalidScheme{u.Scheme} +} + +// ErrInvalidScheme is returned if there is no box with the given scheme. +type ErrInvalidScheme struct{ Scheme string } + +func (err *ErrInvalidScheme) Error() string { return "Invalid scheme: " + err.Scheme } + +type createFunc func(*url.URL, *ConnectData) (box.ManagedBox, error) + +var registry = map[string]createFunc{} + +// Register the encoder for later retrieval. +func Register(scheme string, create createFunc) { + if _, ok := registry[scheme]; ok { + log.Fatalf("Box with scheme %q already registered", scheme) + } + registry[scheme] = create +} + +// GetSchemes returns all registered scheme, ordered by scheme string. +func GetSchemes() []string { + result := make([]string, 0, len(registry)) + for scheme := range registry { + result = append(result, scheme) + } + sort.Strings(result) + return result +} + +// Manager is a coordinating box. +type Manager struct { + mgrMx sync.RWMutex + started bool + rtConfig config.Config + boxes []box.ManagedBox + observers []box.UpdateFunc + mxObserver sync.RWMutex + done chan struct{} + infos chan box.UpdateInfo + propertyKeys map[string]bool // Set of property key names + + // Indexer data + idxStore store.Store + idxAr *anterooms + idxReady chan struct{} // Signal a non-empty anteroom to background task + + // Indexer stats data + idxMx sync.RWMutex + idxLastReload time.Time + idxDurReload time.Duration + idxSinceReload uint64 +} + +// New creates a new managing box. +func New(boxURIs []*url.URL, authManager auth.BaseManager, rtConfig config.Config) (*Manager, error) { + propertyKeys := make(map[string]bool) + for _, kd := range meta.GetSortedKeyDescriptions() { + if kd.IsProperty() { + propertyKeys[kd.Name] = true + } + } + mgr := &Manager{ + rtConfig: rtConfig, + infos: make(chan box.UpdateInfo, len(boxURIs)*10), + propertyKeys: propertyKeys, + + idxStore: memstore.New(), + idxAr: newAnterooms(10), + idxReady: make(chan struct{}, 1), + } + cdata := ConnectData{Number: 1, Config: rtConfig, Enricher: mgr, Notify: mgr.infos} + boxes := make([]box.ManagedBox, 0, len(boxURIs)+2) + for _, uri := range boxURIs { + p, err := Connect(uri, authManager, &cdata) + if err != nil { + return nil, err + } + if p != nil { + boxes = append(boxes, p) + cdata.Number++ + } + } + constbox, err := registry[" const"](nil, &cdata) + if err != nil { + return nil, err + } + cdata.Number++ + compbox, err := registry[" comp"](nil, &cdata) + if err != nil { + return nil, err + } + cdata.Number++ + boxes = append(boxes, constbox, compbox) + mgr.boxes = boxes + return mgr, nil +} + +// RegisterObserver registers an observer that will be notified +// if a zettel was found to be changed. +func (mgr *Manager) RegisterObserver(f box.UpdateFunc) { + if f != nil { + mgr.mxObserver.Lock() + mgr.observers = append(mgr.observers, f) + mgr.mxObserver.Unlock() + } +} + +func (mgr *Manager) notifyObserver(ci *box.UpdateInfo) { + mgr.mxObserver.RLock() + observers := mgr.observers + mgr.mxObserver.RUnlock() + for _, ob := range observers { + ob(*ci) + } +} + +func (mgr *Manager) notifier() { + // The call to notify may panic. Ensure a running notifier. + defer func() { + if r := recover(); r != nil { + kernel.Main.LogRecover("Notifier", r) + go mgr.notifier() + } + }() + + for { + select { + case ci, ok := <-mgr.infos: + if ok { + mgr.idxEnqueue(ci.Reason, ci.Zid) + if ci.Box == nil { + ci.Box = mgr + } + mgr.notifyObserver(&ci) + } + case <-mgr.done: + return + } + } +} + +func (mgr *Manager) idxEnqueue(reason box.UpdateReason, zid id.Zid) { + switch reason { + case box.OnReload: + mgr.idxAr.Reset() + case box.OnUpdate: + mgr.idxAr.Enqueue(zid, arUpdate) + case box.OnDelete: + mgr.idxAr.Enqueue(zid, arDelete) + default: + return + } + select { + case mgr.idxReady <- struct{}{}: + default: + } +} + +// Start the box. Now all other functions of the box are allowed. +// Starting an already started box is not allowed. +func (mgr *Manager) Start(ctx context.Context) error { + mgr.mgrMx.Lock() + if mgr.started { + mgr.mgrMx.Unlock() + return box.ErrStarted + } + for i := len(mgr.boxes) - 1; i >= 0; i-- { + ssi, ok := mgr.boxes[i].(box.StartStopper) + if !ok { + continue + } + err := ssi.Start(ctx) + if err == nil { + continue + } + for j := i + 1; j < len(mgr.boxes); j++ { + if ssj, ok := mgr.boxes[j].(box.StartStopper); ok { + ssj.Stop(ctx) + } + } + mgr.mgrMx.Unlock() + return err + } + mgr.idxAr.Reset() // Ensure an initial index run + mgr.done = make(chan struct{}) + go mgr.notifier() + go mgr.idxIndexer() + + // mgr.startIndexer(mgr) + mgr.started = true + mgr.mgrMx.Unlock() + mgr.infos <- box.UpdateInfo{Reason: box.OnReload, Zid: id.Invalid} + return nil +} + +// Stop the started box. Now only the Start() function is allowed. +func (mgr *Manager) Stop(ctx context.Context) error { + mgr.mgrMx.Lock() + defer mgr.mgrMx.Unlock() + if !mgr.started { + return box.ErrStopped + } + close(mgr.done) + var err error + for _, p := range mgr.boxes { + if ss, ok := p.(box.StartStopper); ok { + if err1 := ss.Stop(ctx); err1 != nil && err == nil { + err = err1 + } + } + } + mgr.started = false + return err +} + +// ReadStats populates st with box statistics. +func (mgr *Manager) ReadStats(st *box.Stats) { + mgr.mgrMx.RLock() + defer mgr.mgrMx.RUnlock() + subStats := make([]box.ManagedBoxStats, len(mgr.boxes)) + for i, p := range mgr.boxes { + p.ReadStats(&subStats[i]) + } + + st.ReadOnly = true + sumZettel := 0 + for _, sst := range subStats { + if !sst.ReadOnly { + st.ReadOnly = false + } + sumZettel += sst.Zettel + } + st.NumManagedBoxes = len(mgr.boxes) + st.ZettelTotal = sumZettel + + var storeSt store.Stats + mgr.idxMx.RLock() + defer mgr.idxMx.RUnlock() + mgr.idxStore.ReadStats(&storeSt) + + st.LastReload = mgr.idxLastReload + st.IndexesSinceReload = mgr.idxSinceReload + st.DurLastReload = mgr.idxDurReload + st.ZettelIndexed = storeSt.Zettel + st.IndexUpdates = storeSt.Updates + st.IndexedWords = storeSt.Words + st.IndexedUrls = storeSt.Urls +} + +// Dump internal data structures to a Writer. +func (mgr *Manager) Dump(w io.Writer) { + mgr.idxStore.Dump(w) +} ADDED box/manager/memstore/memstore.go Index: box/manager/memstore/memstore.go ================================================================== --- box/manager/memstore/memstore.go +++ box/manager/memstore/memstore.go @@ -0,0 +1,580 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package memstore stored the index in main memory. +package memstore + +import ( + "context" + "fmt" + "io" + "sort" + "strings" + "sync" + + "zettelstore.de/z/box/manager/store" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" +) + +type metaRefs struct { + forward id.Slice + backward id.Slice +} + +type zettelIndex struct { + dead id.Slice + forward id.Slice + backward id.Slice + meta map[string]metaRefs + words []string + urls []string +} + +func (zi *zettelIndex) isEmpty() bool { + if len(zi.forward) > 0 || len(zi.backward) > 0 || len(zi.dead) > 0 || len(zi.words) > 0 { + return false + } + return zi.meta == nil || len(zi.meta) == 0 +} + +type stringRefs map[string]id.Slice + +type memStore struct { + mx sync.RWMutex + idx map[id.Zid]*zettelIndex + dead map[id.Zid]id.Slice // map dead refs where they occur + words stringRefs + urls stringRefs + + // Stats + updates uint64 +} + +// New returns a new memory-based index store. +func New() store.Store { + return &memStore{ + idx: make(map[id.Zid]*zettelIndex), + dead: make(map[id.Zid]id.Slice), + words: make(stringRefs), + urls: make(stringRefs), + } +} + +func (ms *memStore) Enrich(ctx context.Context, m *meta.Meta) { + if ms.doEnrich(ctx, m) { + ms.mx.Lock() + ms.updates++ + ms.mx.Unlock() + } +} + +func (ms *memStore) doEnrich(ctx context.Context, m *meta.Meta) bool { + ms.mx.RLock() + defer ms.mx.RUnlock() + zi, ok := ms.idx[m.Zid] + if !ok { + return false + } + var updated bool + if len(zi.dead) > 0 { + m.Set(meta.KeyDead, zi.dead.String()) + updated = true + } + back := removeOtherMetaRefs(m, zi.backward.Copy()) + if len(zi.backward) > 0 { + m.Set(meta.KeyBackward, zi.backward.String()) + updated = true + } + if len(zi.forward) > 0 { + m.Set(meta.KeyForward, zi.forward.String()) + back = remRefs(back, zi.forward) + updated = true + } + if len(zi.meta) > 0 { + for k, refs := range zi.meta { + if len(refs.backward) > 0 { + m.Set(k, refs.backward.String()) + back = remRefs(back, refs.backward) + updated = true + } + } + } + if len(back) > 0 { + m.Set(meta.KeyBack, back.String()) + updated = true + } + return updated +} + +// SearchEqual returns all zettel that contains the given exact word. +// The word must be normalized through Unicode NKFD, trimmed and not empty. +func (ms *memStore) SearchEqual(word string) id.Set { + ms.mx.RLock() + defer ms.mx.RUnlock() + result := id.NewSet() + if refs, ok := ms.words[word]; ok { + result.AddSlice(refs) + } + if refs, ok := ms.urls[word]; ok { + result.AddSlice(refs) + } + zid, err := id.Parse(word) + if err != nil { + return result + } + zi, ok := ms.idx[zid] + if !ok { + return result + } + + addBackwardZids(result, zid, zi) + return result +} + +// SearchPrefix returns all zettel that have a word with the given prefix. +// The prefix must be normalized through Unicode NKFD, trimmed and not empty. +func (ms *memStore) SearchPrefix(prefix string) id.Set { + ms.mx.RLock() + defer ms.mx.RUnlock() + result := ms.selectWithPred(prefix, strings.HasPrefix) + l := len(prefix) + if l > 14 { + return result + } + minZid, err := id.Parse(prefix + "00000000000000"[:14-l]) + if err != nil { + return result + } + maxZid, err := id.Parse(prefix + "99999999999999"[:14-l]) + if err != nil { + return result + } + for zid, zi := range ms.idx { + if minZid <= zid && zid <= maxZid { + addBackwardZids(result, zid, zi) + } + } + return result +} + +// SearchSuffix returns all zettel that have a word with the given suffix. +// The suffix must be normalized through Unicode NKFD, trimmed and not empty. +func (ms *memStore) SearchSuffix(suffix string) id.Set { + ms.mx.RLock() + defer ms.mx.RUnlock() + result := ms.selectWithPred(suffix, strings.HasSuffix) + l := len(suffix) + if l > 14 { + return result + } + val, err := id.ParseUint(suffix) + if err != nil { + return result + } + modulo := uint64(1) + for i := 0; i < l; i++ { + modulo *= 10 + } + for zid, zi := range ms.idx { + if uint64(zid)%modulo == val { + addBackwardZids(result, zid, zi) + } + } + return result +} + +// SearchContains returns all zettel that contains the given string. +// The string must be normalized through Unicode NKFD, trimmed and not empty. +func (ms *memStore) SearchContains(s string) id.Set { + ms.mx.RLock() + defer ms.mx.RUnlock() + result := ms.selectWithPred(s, strings.Contains) + if len(s) > 14 { + return result + } + if _, err := id.ParseUint(s); err != nil { + return result + } + for zid, zi := range ms.idx { + if strings.Contains(zid.String(), s) { + addBackwardZids(result, zid, zi) + } + } + return result +} + +func (ms *memStore) selectWithPred(s string, pred func(string, string) bool) id.Set { + // Must only be called if ms.mx is read-locked! + result := id.NewSet() + for word, refs := range ms.words { + if !pred(word, s) { + continue + } + result.AddSlice(refs) + } + for u, refs := range ms.urls { + if !pred(u, s) { + continue + } + result.AddSlice(refs) + } + return result +} + +func addBackwardZids(result id.Set, zid id.Zid, zi *zettelIndex) { + // Must only be called if ms.mx is read-locked! + result[zid] = true + result.AddSlice(zi.backward) + for _, mref := range zi.meta { + result.AddSlice(mref.backward) + } +} + +func removeOtherMetaRefs(m *meta.Meta, back id.Slice) id.Slice { + for _, p := range m.PairsRest(false) { + switch meta.Type(p.Key) { + case meta.TypeID: + if zid, err := id.Parse(p.Value); err == nil { + back = remRef(back, zid) + } + case meta.TypeIDSet: + for _, val := range meta.ListFromValue(p.Value) { + if zid, err := id.Parse(val); err == nil { + back = remRef(back, zid) + } + } + } + } + return back +} + +func (ms *memStore) UpdateReferences(ctx context.Context, zidx *store.ZettelIndex) id.Set { + ms.mx.Lock() + defer ms.mx.Unlock() + zi, ziExist := ms.idx[zidx.Zid] + if !ziExist || zi == nil { + zi = &zettelIndex{} + ziExist = false + } + + // Is this zettel an old dead reference mentioned in other zettel? + var toCheck id.Set + if refs, ok := ms.dead[zidx.Zid]; ok { + // These must be checked later again + toCheck = id.NewSet(refs...) + delete(ms.dead, zidx.Zid) + } + + ms.updateDeadReferences(zidx, zi) + ms.updateForwardBackwardReferences(zidx, zi) + ms.updateMetadataReferences(zidx, zi) + zi.words = updateWordSet(zidx.Zid, ms.words, zi.words, zidx.GetWords()) + zi.urls = updateWordSet(zidx.Zid, ms.urls, zi.urls, zidx.GetUrls()) + + // Check if zi must be inserted into ms.idx + if !ziExist && !zi.isEmpty() { + ms.idx[zidx.Zid] = zi + } + + return toCheck +} + +func (ms *memStore) updateDeadReferences(zidx *store.ZettelIndex, zi *zettelIndex) { + // Must only be called if ms.mx is write-locked! + drefs := zidx.GetDeadRefs() + newRefs, remRefs := refsDiff(drefs, zi.dead) + zi.dead = drefs + for _, ref := range remRefs { + ms.dead[ref] = remRef(ms.dead[ref], zidx.Zid) + } + for _, ref := range newRefs { + ms.dead[ref] = addRef(ms.dead[ref], zidx.Zid) + } +} + +func (ms *memStore) updateForwardBackwardReferences(zidx *store.ZettelIndex, zi *zettelIndex) { + // Must only be called if ms.mx is write-locked! + brefs := zidx.GetBackRefs() + newRefs, remRefs := refsDiff(brefs, zi.forward) + zi.forward = brefs + for _, ref := range remRefs { + bzi := ms.getEntry(ref) + bzi.backward = remRef(bzi.backward, zidx.Zid) + } + for _, ref := range newRefs { + bzi := ms.getEntry(ref) + bzi.backward = addRef(bzi.backward, zidx.Zid) + } +} + +func (ms *memStore) updateMetadataReferences(zidx *store.ZettelIndex, zi *zettelIndex) { + // Must only be called if ms.mx is write-locked! + metarefs := zidx.GetMetaRefs() + for key, mr := range zi.meta { + if _, ok := metarefs[key]; ok { + continue + } + ms.removeInverseMeta(zidx.Zid, key, mr.forward) + } + if zi.meta == nil { + zi.meta = make(map[string]metaRefs) + } + for key, mrefs := range metarefs { + mr := zi.meta[key] + newRefs, remRefs := refsDiff(mrefs, mr.forward) + mr.forward = mrefs + zi.meta[key] = mr + + for _, ref := range newRefs { + bzi := ms.getEntry(ref) + if bzi.meta == nil { + bzi.meta = make(map[string]metaRefs) + } + bmr := bzi.meta[key] + bmr.backward = addRef(bmr.backward, zidx.Zid) + bzi.meta[key] = bmr + } + ms.removeInverseMeta(zidx.Zid, key, remRefs) + } +} + +func updateWordSet(zid id.Zid, srefs stringRefs, prev []string, next store.WordSet) []string { + // Must only be called if ms.mx is write-locked! + newWords, removeWords := next.Diff(prev) + for _, word := range newWords { + if refs, ok := srefs[word]; ok { + srefs[word] = addRef(refs, zid) + continue + } + srefs[word] = id.Slice{zid} + } + for _, word := range removeWords { + refs, ok := srefs[word] + if !ok { + continue + } + refs2 := remRef(refs, zid) + if len(refs2) == 0 { + delete(srefs, word) + continue + } + srefs[word] = refs2 + } + return next.Words() +} + +func (ms *memStore) getEntry(zid id.Zid) *zettelIndex { + // Must only be called if ms.mx is write-locked! + if zi, ok := ms.idx[zid]; ok { + return zi + } + zi := &zettelIndex{} + ms.idx[zid] = zi + return zi +} + +func (ms *memStore) DeleteZettel(ctx context.Context, zid id.Zid) id.Set { + ms.mx.Lock() + defer ms.mx.Unlock() + + zi, ok := ms.idx[zid] + if !ok { + return nil + } + + ms.deleteDeadSources(zid, zi) + toCheck := ms.deleteForwardBackward(zid, zi) + if len(zi.meta) > 0 { + for key, mrefs := range zi.meta { + ms.removeInverseMeta(zid, key, mrefs.forward) + } + } + ms.deleteWords(zid, zi.words) + delete(ms.idx, zid) + return toCheck +} + +func (ms *memStore) deleteDeadSources(zid id.Zid, zi *zettelIndex) { + // Must only be called if ms.mx is write-locked! + for _, ref := range zi.dead { + if drefs, ok := ms.dead[ref]; ok { + drefs = remRef(drefs, zid) + if len(drefs) > 0 { + ms.dead[ref] = drefs + } else { + delete(ms.dead, ref) + } + } + } +} + +func (ms *memStore) deleteForwardBackward(zid id.Zid, zi *zettelIndex) id.Set { + // Must only be called if ms.mx is write-locked! + var toCheck id.Set + for _, ref := range zi.forward { + if fzi, ok := ms.idx[ref]; ok { + fzi.backward = remRef(fzi.backward, zid) + } + } + for _, ref := range zi.backward { + if bzi, ok := ms.idx[ref]; ok { + bzi.forward = remRef(bzi.forward, zid) + if toCheck == nil { + toCheck = id.NewSet() + } + toCheck[ref] = true + } + } + return toCheck +} + +func (ms *memStore) removeInverseMeta(zid id.Zid, key string, forward id.Slice) { + // Must only be called if ms.mx is write-locked! + for _, ref := range forward { + bzi, ok := ms.idx[ref] + if !ok || bzi.meta == nil { + continue + } + bmr, ok := bzi.meta[key] + if !ok { + continue + } + bmr.backward = remRef(bmr.backward, zid) + if len(bmr.backward) > 0 || len(bmr.forward) > 0 { + bzi.meta[key] = bmr + } else { + delete(bzi.meta, key) + if len(bzi.meta) == 0 { + bzi.meta = nil + } + } + } +} + +func (ms *memStore) deleteWords(zid id.Zid, words []string) { + // Must only be called if ms.mx is write-locked! + for _, word := range words { + refs, ok := ms.words[word] + if !ok { + continue + } + refs2 := remRef(refs, zid) + if len(refs2) == 0 { + delete(ms.words, word) + continue + } + ms.words[word] = refs2 + } +} + +func (ms *memStore) ReadStats(st *store.Stats) { + ms.mx.RLock() + st.Zettel = len(ms.idx) + st.Updates = ms.updates + st.Words = uint64(len(ms.words)) + st.Urls = uint64(len(ms.urls)) + ms.mx.RUnlock() +} + +func (ms *memStore) Dump(w io.Writer) { + ms.mx.RLock() + defer ms.mx.RUnlock() + + io.WriteString(w, "=== Dump\n") + ms.dumpIndex(w) + ms.dumpDead(w) + dumpStringRefs(w, "Words", "", "", ms.words) + dumpStringRefs(w, "URLs", "[[", "]]", ms.urls) +} + +func (ms *memStore) dumpIndex(w io.Writer) { + if len(ms.idx) == 0 { + return + } + io.WriteString(w, "==== Zettel Index\n") + zids := make(id.Slice, 0, len(ms.idx)) + for id := range ms.idx { + zids = append(zids, id) + } + zids.Sort() + for _, id := range zids { + fmt.Fprintln(w, "=====", id) + zi := ms.idx[id] + if len(zi.dead) > 0 { + fmt.Fprintln(w, "* Dead:", zi.dead) + } + dumpZids(w, "* Forward:", zi.forward) + dumpZids(w, "* Backward:", zi.backward) + for k, fb := range zi.meta { + fmt.Fprintln(w, "* Meta", k) + dumpZids(w, "** Forward:", fb.forward) + dumpZids(w, "** Backward:", fb.backward) + } + dumpStrings(w, "* Words", "", "", zi.words) + dumpStrings(w, "* URLs", "[[", "]]", zi.urls) + } +} + +func (ms *memStore) dumpDead(w io.Writer) { + if len(ms.dead) == 0 { + return + } + fmt.Fprintf(w, "==== Dead References\n") + zids := make(id.Slice, 0, len(ms.dead)) + for id := range ms.dead { + zids = append(zids, id) + } + zids.Sort() + for _, id := range zids { + fmt.Fprintln(w, ";", id) + fmt.Fprintln(w, ":", ms.dead[id]) + } +} + +func dumpZids(w io.Writer, prefix string, zids id.Slice) { + if len(zids) > 0 { + io.WriteString(w, prefix) + for _, zid := range zids { + io.WriteString(w, " ") + w.Write(zid.Bytes()) + } + fmt.Fprintln(w) + } +} + +func dumpStrings(w io.Writer, title, preString, postString string, slice []string) { + if len(slice) > 0 { + sl := make([]string, len(slice)) + copy(sl, slice) + sort.Strings(sl) + fmt.Fprintln(w, title) + for _, s := range sl { + fmt.Fprintf(w, "** %s%s%s\n", preString, s, postString) + } + } + +} + +func dumpStringRefs(w io.Writer, title, preString, postString string, srefs stringRefs) { + if len(srefs) == 0 { + return + } + fmt.Fprintln(w, "====", title) + slice := make([]string, 0, len(srefs)) + for s := range srefs { + slice = append(slice, s) + } + sort.Strings(slice) + for _, s := range slice { + fmt.Fprintf(w, "; %s%s%s\n", preString, s, postString) + fmt.Fprintln(w, ":", srefs[s]) + } +} ADDED box/manager/memstore/refs.go Index: box/manager/memstore/refs.go ================================================================== --- box/manager/memstore/refs.go +++ box/manager/memstore/refs.go @@ -0,0 +1,101 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package memstore stored the index in main memory. +package memstore + +import "zettelstore.de/z/domain/id" + +func refsDiff(refsN, refsO id.Slice) (newRefs, remRefs id.Slice) { + npos, opos := 0, 0 + for npos < len(refsN) && opos < len(refsO) { + rn, ro := refsN[npos], refsO[opos] + if rn == ro { + npos++ + opos++ + continue + } + if rn < ro { + newRefs = append(newRefs, rn) + npos++ + continue + } + remRefs = append(remRefs, ro) + opos++ + } + if npos < len(refsN) { + newRefs = append(newRefs, refsN[npos:]...) + } + if opos < len(refsO) { + remRefs = append(remRefs, refsO[opos:]...) + } + return newRefs, remRefs +} + +func addRef(refs id.Slice, ref id.Zid) id.Slice { + hi := len(refs) + for lo := 0; lo < hi; { + m := lo + (hi-lo)/2 + if r := refs[m]; r == ref { + return refs + } else if r < ref { + lo = m + 1 + } else { + hi = m + } + } + refs = append(refs, id.Invalid) + copy(refs[hi+1:], refs[hi:]) + refs[hi] = ref + return refs +} + +func remRefs(refs, rem id.Slice) id.Slice { + if len(refs) == 0 || len(rem) == 0 { + return refs + } + result := make(id.Slice, 0, len(refs)) + rpos, dpos := 0, 0 + for rpos < len(refs) && dpos < len(rem) { + rr, dr := refs[rpos], rem[dpos] + if rr < dr { + result = append(result, rr) + rpos++ + continue + } + if dr < rr { + dpos++ + continue + } + rpos++ + dpos++ + } + if rpos < len(refs) { + result = append(result, refs[rpos:]...) + } + return result +} + +func remRef(refs id.Slice, ref id.Zid) id.Slice { + hi := len(refs) + for lo := 0; lo < hi; { + m := lo + (hi-lo)/2 + if r := refs[m]; r == ref { + copy(refs[m:], refs[m+1:]) + refs = refs[:len(refs)-1] + return refs + } else if r < ref { + lo = m + 1 + } else { + hi = m + } + } + return refs +} ADDED box/manager/memstore/refs_test.go Index: box/manager/memstore/refs_test.go ================================================================== --- box/manager/memstore/refs_test.go +++ box/manager/memstore/refs_test.go @@ -0,0 +1,138 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package memstore stored the index in main memory. +package memstore + +import ( + "testing" + + "zettelstore.de/z/domain/id" +) + +func assertRefs(t *testing.T, i int, got, exp id.Slice) { + t.Helper() + if got == nil && exp != nil { + t.Errorf("%d: got nil, but expected %v", i, exp) + return + } + if got != nil && exp == nil { + t.Errorf("%d: expected nil, but got %v", i, got) + return + } + if len(got) != len(exp) { + t.Errorf("%d: expected len(%v)==%d, but got len(%v)==%d", i, exp, len(exp), got, len(got)) + return + } + for p, n := range exp { + if got := got[p]; got != id.Zid(n) { + t.Errorf("%d: pos %d: expected %d, but got %d", i, p, n, got) + } + } +} + +func TestRefsDiff(t *testing.T) { + t.Parallel() + testcases := []struct { + in1, in2 id.Slice + exp1, exp2 id.Slice + }{ + {nil, nil, nil, nil}, + {id.Slice{1}, nil, id.Slice{1}, nil}, + {nil, id.Slice{1}, nil, id.Slice{1}}, + {id.Slice{1}, id.Slice{1}, nil, nil}, + {id.Slice{1, 2}, id.Slice{1}, id.Slice{2}, nil}, + {id.Slice{1, 2}, id.Slice{1, 3}, id.Slice{2}, id.Slice{3}}, + {id.Slice{1, 4}, id.Slice{1, 3}, id.Slice{4}, id.Slice{3}}, + } + for i, tc := range testcases { + got1, got2 := refsDiff(tc.in1, tc.in2) + assertRefs(t, i, got1, tc.exp1) + assertRefs(t, i, got2, tc.exp2) + } +} + +func TestAddRef(t *testing.T) { + t.Parallel() + testcases := []struct { + ref id.Slice + zid uint + exp id.Slice + }{ + {nil, 5, id.Slice{5}}, + {id.Slice{1}, 5, id.Slice{1, 5}}, + {id.Slice{10}, 5, id.Slice{5, 10}}, + {id.Slice{5}, 5, id.Slice{5}}, + {id.Slice{1, 10}, 5, id.Slice{1, 5, 10}}, + {id.Slice{1, 5, 10}, 5, id.Slice{1, 5, 10}}, + } + for i, tc := range testcases { + got := addRef(tc.ref, id.Zid(tc.zid)) + assertRefs(t, i, got, tc.exp) + } +} + +func TestRemRefs(t *testing.T) { + t.Parallel() + testcases := []struct { + in1, in2 id.Slice + exp id.Slice + }{ + {nil, nil, nil}, + {nil, id.Slice{}, nil}, + {id.Slice{}, nil, id.Slice{}}, + {id.Slice{}, id.Slice{}, id.Slice{}}, + {id.Slice{1}, id.Slice{5}, id.Slice{1}}, + {id.Slice{10}, id.Slice{5}, id.Slice{10}}, + {id.Slice{1, 5}, id.Slice{5}, id.Slice{1}}, + {id.Slice{5, 10}, id.Slice{5}, id.Slice{10}}, + {id.Slice{1, 10}, id.Slice{5}, id.Slice{1, 10}}, + {id.Slice{1}, id.Slice{2, 5}, id.Slice{1}}, + {id.Slice{10}, id.Slice{2, 5}, id.Slice{10}}, + {id.Slice{1, 5}, id.Slice{2, 5}, id.Slice{1}}, + {id.Slice{5, 10}, id.Slice{2, 5}, id.Slice{10}}, + {id.Slice{1, 2, 5}, id.Slice{2, 5}, id.Slice{1}}, + {id.Slice{2, 5, 10}, id.Slice{2, 5}, id.Slice{10}}, + {id.Slice{1, 10}, id.Slice{2, 5}, id.Slice{1, 10}}, + {id.Slice{1}, id.Slice{5, 9}, id.Slice{1}}, + {id.Slice{10}, id.Slice{5, 9}, id.Slice{10}}, + {id.Slice{1, 5}, id.Slice{5, 9}, id.Slice{1}}, + {id.Slice{5, 10}, id.Slice{5, 9}, id.Slice{10}}, + {id.Slice{1, 5, 9}, id.Slice{5, 9}, id.Slice{1}}, + {id.Slice{5, 9, 10}, id.Slice{5, 9}, id.Slice{10}}, + {id.Slice{1, 10}, id.Slice{5, 9}, id.Slice{1, 10}}, + } + for i, tc := range testcases { + got := remRefs(tc.in1, tc.in2) + assertRefs(t, i, got, tc.exp) + } +} + +func TestRemRef(t *testing.T) { + t.Parallel() + testcases := []struct { + ref id.Slice + zid uint + exp id.Slice + }{ + {nil, 5, nil}, + {id.Slice{}, 5, id.Slice{}}, + {id.Slice{5}, 5, id.Slice{}}, + {id.Slice{1}, 5, id.Slice{1}}, + {id.Slice{10}, 5, id.Slice{10}}, + {id.Slice{1, 5}, 5, id.Slice{1}}, + {id.Slice{5, 10}, 5, id.Slice{10}}, + {id.Slice{1, 5, 10}, 5, id.Slice{1, 10}}, + } + for i, tc := range testcases { + got := remRef(tc.ref, id.Zid(tc.zid)) + assertRefs(t, i, got, tc.exp) + } +} ADDED box/manager/store/store.go Index: box/manager/store/store.go ================================================================== --- box/manager/store/store.go +++ box/manager/store/store.go @@ -0,0 +1,59 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package store contains general index data for storing a zettel index. +package store + +import ( + "context" + "io" + + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/search" +) + +// Stats records statistics about the store. +type Stats struct { + // Zettel is the number of zettel managed by the indexer. + Zettel int + + // Updates count the number of metadata updates. + Updates uint64 + + // Words count the different words stored in the store. + Words uint64 + + // Urls count the different URLs stored in the store. + Urls uint64 +} + +// Store all relevant zettel data. There may be multiple implementations, i.e. +// memory-based, file-based, based on SQLite, ... +type Store interface { + search.Searcher + + // Entrich metadata with data from store. + Enrich(ctx context.Context, m *meta.Meta) + + // UpdateReferences for a specific zettel. + // Returns set of zettel identifier that must also be checked for changes. + UpdateReferences(context.Context, *ZettelIndex) id.Set + + // DeleteZettel removes index data for given zettel. + // Returns set of zettel identifier that must also be checked for changes. + DeleteZettel(context.Context, id.Zid) id.Set + + // ReadStats populates st with store statistics. + ReadStats(st *Stats) + + // Dump the content to a Writer. + Dump(io.Writer) +} ADDED box/manager/store/wordset.go Index: box/manager/store/wordset.go ================================================================== --- box/manager/store/wordset.go +++ box/manager/store/wordset.go @@ -0,0 +1,61 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package store contains general index data for storing a zettel index. +package store + +// WordSet contains the set of all words, with the count of their occurrences. +type WordSet map[string]int + +// NewWordSet returns a new WordSet. +func NewWordSet() WordSet { return make(WordSet) } + +// Add one word to the set +func (ws WordSet) Add(s string) { + ws[s] = ws[s] + 1 +} + +// Words gives the slice of all words in the set. +func (ws WordSet) Words() []string { + if len(ws) == 0 { + return nil + } + words := make([]string, 0, len(ws)) + for w := range ws { + words = append(words, w) + } + return words +} + +// Diff calculates the word slice to be added and to be removed from oldWords +// to get the given word set. +func (ws WordSet) Diff(oldWords []string) (newWords, removeWords []string) { + if len(ws) == 0 { + return nil, oldWords + } + if len(oldWords) == 0 { + return ws.Words(), nil + } + oldSet := make(WordSet, len(oldWords)) + for _, ow := range oldWords { + if _, ok := ws[ow]; ok { + oldSet[ow] = 1 + continue + } + removeWords = append(removeWords, ow) + } + for w := range ws { + if _, ok := oldSet[w]; ok { + continue + } + newWords = append(newWords, w) + } + return newWords, removeWords +} ADDED box/manager/store/wordset_test.go Index: box/manager/store/wordset_test.go ================================================================== --- box/manager/store/wordset_test.go +++ box/manager/store/wordset_test.go @@ -0,0 +1,78 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package store contains general index data for storing a zettel index. +package store_test + +import ( + "sort" + "testing" + + "zettelstore.de/z/box/manager/store" +) + +func equalWordList(exp, got []string) bool { + if len(exp) != len(got) { + return false + } + if len(got) == 0 { + return len(exp) == 0 + } + sort.Strings(got) + for i, w := range exp { + if w != got[i] { + return false + } + } + return true +} + +func TestWordsWords(t *testing.T) { + t.Parallel() + testcases := []struct { + words store.WordSet + exp []string + }{ + {nil, nil}, + {store.WordSet{}, nil}, + {store.WordSet{"a": 1, "b": 2}, []string{"a", "b"}}, + } + for i, tc := range testcases { + got := tc.words.Words() + if !equalWordList(tc.exp, got) { + t.Errorf("%d: %v.Words() == %v, but got %v", i, tc.words, tc.exp, got) + } + } +} + +func TestWordsDiff(t *testing.T) { + t.Parallel() + testcases := []struct { + cur store.WordSet + old []string + expN, expR []string + }{ + {nil, nil, nil, nil}, + {store.WordSet{}, []string{}, nil, nil}, + {store.WordSet{"a": 1}, []string{}, []string{"a"}, nil}, + {store.WordSet{"a": 1}, []string{"b"}, []string{"a"}, []string{"b"}}, + {store.WordSet{}, []string{"b"}, nil, []string{"b"}}, + {store.WordSet{"a": 1}, []string{"a"}, nil, nil}, + } + for i, tc := range testcases { + gotN, gotR := tc.cur.Diff(tc.old) + if !equalWordList(tc.expN, gotN) { + t.Errorf("%d: %v.Diff(%v)->new %v, but got %v", i, tc.cur, tc.old, tc.expN, gotN) + } + if !equalWordList(tc.expR, gotR) { + t.Errorf("%d: %v.Diff(%v)->rem %v, but got %v", i, tc.cur, tc.old, tc.expR, gotR) + } + } +} ADDED box/manager/store/zettel.go Index: box/manager/store/zettel.go ================================================================== --- box/manager/store/zettel.go +++ box/manager/store/zettel.go @@ -0,0 +1,89 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package store contains general index data for storing a zettel index. +package store + +import "zettelstore.de/z/domain/id" + +// ZettelIndex contains all index data of a zettel. +type ZettelIndex struct { + Zid id.Zid // zid of the indexed zettel + backrefs id.Set // set of back references + metarefs map[string]id.Set // references to inverse keys + deadrefs id.Set // set of dead references + words WordSet + urls WordSet +} + +// NewZettelIndex creates a new zettel index. +func NewZettelIndex(zid id.Zid) *ZettelIndex { + return &ZettelIndex{ + Zid: zid, + backrefs: id.NewSet(), + metarefs: make(map[string]id.Set), + deadrefs: id.NewSet(), + } +} + +// AddBackRef adds a reference to a zettel where the current zettel links to +// without any more information. +func (zi *ZettelIndex) AddBackRef(zid id.Zid) { + zi.backrefs[zid] = true +} + +// AddMetaRef adds a named reference to a zettel. On that zettel, the given +// metadata key should point back to the current zettel. +func (zi *ZettelIndex) AddMetaRef(key string, zid id.Zid) { + if zids, ok := zi.metarefs[key]; ok { + zids[zid] = true + return + } + zi.metarefs[key] = id.NewSet(zid) +} + +// AddDeadRef adds a dead reference to a zettel. +func (zi *ZettelIndex) AddDeadRef(zid id.Zid) { + zi.deadrefs[zid] = true +} + +// SetWords sets the words to the given value. +func (zi *ZettelIndex) SetWords(words WordSet) { zi.words = words } + +// SetUrls sets the words to the given value. +func (zi *ZettelIndex) SetUrls(urls WordSet) { zi.urls = urls } + +// GetDeadRefs returns all dead references as a sorted list. +func (zi *ZettelIndex) GetDeadRefs() id.Slice { + return zi.deadrefs.Sorted() +} + +// GetBackRefs returns all back references as a sorted list. +func (zi *ZettelIndex) GetBackRefs() id.Slice { + return zi.backrefs.Sorted() +} + +// GetMetaRefs returns all meta references as a map of strings to a sorted list of references +func (zi *ZettelIndex) GetMetaRefs() map[string]id.Slice { + if len(zi.metarefs) == 0 { + return nil + } + result := make(map[string]id.Slice, len(zi.metarefs)) + for key, refs := range zi.metarefs { + result[key] = refs.Sorted() + } + return result +} + +// GetWords returns a reference to the set of words. It must not be modified. +func (zi *ZettelIndex) GetWords() WordSet { return zi.words } + +// GetUrls returns a reference to the set of URLs. It must not be modified. +func (zi *ZettelIndex) GetUrls() WordSet { return zi.urls } ADDED box/membox/membox.go Index: box/membox/membox.go ================================================================== --- box/membox/membox.go +++ box/membox/membox.go @@ -0,0 +1,200 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package membox stores zettel volatile in main memory. +package membox + +import ( + "context" + "net/url" + "sync" + + "zettelstore.de/z/box" + "zettelstore.de/z/box/manager" + "zettelstore.de/z/domain" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" + "zettelstore.de/z/search" +) + +func init() { + manager.Register( + "mem", + func(u *url.URL, cdata *manager.ConnectData) (box.ManagedBox, error) { + return &memBox{u: u, cdata: *cdata}, nil + }) +} + +type memBox struct { + u *url.URL + cdata manager.ConnectData + zettel map[id.Zid]domain.Zettel + mx sync.RWMutex +} + +func (mp *memBox) notifyChanged(reason box.UpdateReason, zid id.Zid) { + if chci := mp.cdata.Notify; chci != nil { + chci <- box.UpdateInfo{Reason: reason, Zid: zid} + } +} + +func (mp *memBox) Location() string { + return mp.u.String() +} + +func (mp *memBox) Start(ctx context.Context) error { + mp.mx.Lock() + mp.zettel = make(map[id.Zid]domain.Zettel) + mp.mx.Unlock() + return nil +} + +func (mp *memBox) Stop(ctx context.Context) error { + mp.mx.Lock() + mp.zettel = nil + mp.mx.Unlock() + return nil +} + +func (mp *memBox) CanCreateZettel(ctx context.Context) bool { return true } + +func (mp *memBox) CreateZettel(ctx context.Context, zettel domain.Zettel) (id.Zid, error) { + mp.mx.Lock() + zid, err := box.GetNewZid(func(zid id.Zid) (bool, error) { + _, ok := mp.zettel[zid] + return !ok, nil + }) + if err != nil { + mp.mx.Unlock() + return id.Invalid, err + } + meta := zettel.Meta.Clone() + meta.Zid = zid + zettel.Meta = meta + mp.zettel[zid] = zettel + mp.mx.Unlock() + mp.notifyChanged(box.OnUpdate, zid) + return zid, nil +} + +func (mp *memBox) GetZettel(ctx context.Context, zid id.Zid) (domain.Zettel, error) { + mp.mx.RLock() + zettel, ok := mp.zettel[zid] + mp.mx.RUnlock() + if !ok { + return domain.Zettel{}, box.ErrNotFound + } + zettel.Meta = zettel.Meta.Clone() + return zettel, nil +} + +func (mp *memBox) GetMeta(ctx context.Context, zid id.Zid) (*meta.Meta, error) { + mp.mx.RLock() + zettel, ok := mp.zettel[zid] + mp.mx.RUnlock() + if !ok { + return nil, box.ErrNotFound + } + return zettel.Meta.Clone(), nil +} + +func (mp *memBox) FetchZids(ctx context.Context) (id.Set, error) { + mp.mx.RLock() + result := id.NewSetCap(len(mp.zettel)) + for zid := range mp.zettel { + result[zid] = true + } + mp.mx.RUnlock() + return result, nil +} + +func (mp *memBox) SelectMeta(ctx context.Context, match search.MetaMatchFunc) ([]*meta.Meta, error) { + result := make([]*meta.Meta, 0, len(mp.zettel)) + mp.mx.RLock() + for _, zettel := range mp.zettel { + m := zettel.Meta.Clone() + mp.cdata.Enricher.Enrich(ctx, m, mp.cdata.Number) + if match(m) { + result = append(result, m) + } + } + mp.mx.RUnlock() + return result, nil +} + +func (mp *memBox) CanUpdateZettel(ctx context.Context, zettel domain.Zettel) bool { + return true +} + +func (mp *memBox) UpdateZettel(ctx context.Context, zettel domain.Zettel) error { + mp.mx.Lock() + meta := zettel.Meta.Clone() + if !meta.Zid.IsValid() { + return &box.ErrInvalidID{Zid: meta.Zid} + } + zettel.Meta = meta + mp.zettel[meta.Zid] = zettel + mp.mx.Unlock() + mp.notifyChanged(box.OnUpdate, meta.Zid) + return nil +} + +func (mp *memBox) AllowRenameZettel(ctx context.Context, zid id.Zid) bool { return true } + +func (mp *memBox) RenameZettel(ctx context.Context, curZid, newZid id.Zid) error { + mp.mx.Lock() + zettel, ok := mp.zettel[curZid] + if !ok { + mp.mx.Unlock() + return box.ErrNotFound + } + + // Check that there is no zettel with newZid + if _, ok = mp.zettel[newZid]; ok { + mp.mx.Unlock() + return &box.ErrInvalidID{Zid: newZid} + } + + meta := zettel.Meta.Clone() + meta.Zid = newZid + zettel.Meta = meta + mp.zettel[newZid] = zettel + delete(mp.zettel, curZid) + mp.mx.Unlock() + mp.notifyChanged(box.OnDelete, curZid) + mp.notifyChanged(box.OnUpdate, newZid) + return nil +} + +func (mp *memBox) CanDeleteZettel(ctx context.Context, zid id.Zid) bool { + mp.mx.RLock() + _, ok := mp.zettel[zid] + mp.mx.RUnlock() + return ok +} + +func (mp *memBox) DeleteZettel(ctx context.Context, zid id.Zid) error { + mp.mx.Lock() + if _, ok := mp.zettel[zid]; !ok { + mp.mx.Unlock() + return box.ErrNotFound + } + delete(mp.zettel, zid) + mp.mx.Unlock() + mp.notifyChanged(box.OnDelete, zid) + return nil +} + +func (mp *memBox) ReadStats(st *box.ManagedBoxStats) { + st.ReadOnly = false + mp.mx.RLock() + st.Zettel = len(mp.zettel) + mp.mx.RUnlock() +} ADDED box/merge.go Index: box/merge.go ================================================================== --- box/merge.go +++ box/merge.go @@ -0,0 +1,46 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2020-2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package box provides a generic interface to zettel boxes. +package box + +import "zettelstore.de/z/domain/meta" + +// MergeSorted returns a merged sequence of metadata, sorted by Zid. +// The lists first and second must be sorted descending by Zid. +func MergeSorted(first, second []*meta.Meta) []*meta.Meta { + lenFirst := len(first) + lenSecond := len(second) + result := make([]*meta.Meta, 0, lenFirst+lenSecond) + iFirst := 0 + iSecond := 0 + for iFirst < lenFirst && iSecond < lenSecond { + zidFirst := first[iFirst].Zid + zidSecond := second[iSecond].Zid + if zidFirst > zidSecond { + result = append(result, first[iFirst]) + iFirst++ + } else if zidFirst < zidSecond { + result = append(result, second[iSecond]) + iSecond++ + } else { // zidFirst == zidSecond + result = append(result, first[iFirst]) + iFirst++ + iSecond++ + } + } + if iFirst < lenFirst { + result = append(result, first[iFirst:]...) + } else { + result = append(result, second[iSecond:]...) + } + + return result +} ADDED client/client.go Index: client/client.go ================================================================== --- client/client.go +++ client/client.go @@ -0,0 +1,443 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package client provides a client for accessing the Zettelstore via its API. +package client + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "io" + "net/http" + "net/url" + "strconv" + "strings" + "time" + + "zettelstore.de/z/api" + "zettelstore.de/z/domain/id" +) + +// Client contains all data to execute requests. +type Client struct { + baseURL string + username string + password string + token string + tokenType string + expires time.Time +} + +// NewClient create a new client. +func NewClient(baseURL string) *Client { + if !strings.HasSuffix(baseURL, "/") { + baseURL += "/" + } + c := Client{baseURL: baseURL} + return &c +} + +func (c *Client) newURLBuilder(key byte) *api.URLBuilder { + return api.NewURLBuilder(c.baseURL, key) +} +func (c *Client) newRequest(ctx context.Context, method string, ub *api.URLBuilder, body io.Reader) (*http.Request, error) { + return http.NewRequestWithContext(ctx, method, ub.String(), body) +} + +func (c *Client) executeRequest(req *http.Request) (*http.Response, error) { + if c.token != "" { + req.Header.Add("Authorization", c.tokenType+" "+c.token) + } + client := http.Client{} + resp, err := client.Do(req) + if err != nil { + if resp != nil && resp.Body != nil { + resp.Body.Close() + } + return nil, err + } + return resp, err +} + +func (c *Client) buildAndExecuteRequest( + ctx context.Context, method string, ub *api.URLBuilder, body io.Reader, h http.Header) (*http.Response, error) { + req, err := c.newRequest(ctx, method, ub, body) + if err != nil { + return nil, err + } + err = c.updateToken(ctx) + if err != nil { + return nil, err + } + for key, val := range h { + req.Header[key] = append(req.Header[key], val...) + } + return c.executeRequest(req) +} + +// SetAuth sets authentication data. +func (c *Client) SetAuth(username, password string) { + c.username = username + c.password = password + c.token = "" + c.tokenType = "" + c.expires = time.Time{} +} + +func (c *Client) executeAuthRequest(req *http.Request) error { + resp, err := c.executeRequest(req) + if err != nil { + return err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var tinfo api.AuthJSON + err = dec.Decode(&tinfo) + if err != nil { + return err + } + c.token = tinfo.Token + c.tokenType = tinfo.Type + c.expires = time.Now().Add(time.Duration(tinfo.Expires*10/9) * time.Second) + return nil +} + +func (c *Client) updateToken(ctx context.Context) error { + if c.username == "" { + return nil + } + if time.Now().After(c.expires) { + return c.Authenticate(ctx) + } + return c.RefreshToken(ctx) +} + +// Authenticate sets a new token by sending user name and password. +func (c *Client) Authenticate(ctx context.Context) error { + authData := url.Values{"username": {c.username}, "password": {c.password}} + req, err := c.newRequest(ctx, http.MethodPost, c.newURLBuilder('v'), strings.NewReader(authData.Encode())) + if err != nil { + return err + } + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") + return c.executeAuthRequest(req) +} + +// RefreshToken updates the access token +func (c *Client) RefreshToken(ctx context.Context) error { + req, err := c.newRequest(ctx, http.MethodPut, c.newURLBuilder('v'), nil) + if err != nil { + return err + } + return c.executeAuthRequest(req) +} + +// CreateZettel creates a new zettel and returns its URL. +func (c *Client) CreateZettel(ctx context.Context, data *api.ZettelDataJSON) (id.Zid, error) { + var buf bytes.Buffer + if err := encodeZettelData(&buf, data); err != nil { + return id.Invalid, err + } + ub := c.jsonZettelURLBuilder(nil) + resp, err := c.buildAndExecuteRequest(ctx, http.MethodPost, ub, &buf, nil) + if err != nil { + return id.Invalid, err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusCreated { + return id.Invalid, errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var newZid api.ZidJSON + err = dec.Decode(&newZid) + if err != nil { + return id.Invalid, err + } + zid, err := id.Parse(newZid.ID) + if err != nil { + return id.Invalid, err + } + return zid, nil +} + +func encodeZettelData(buf *bytes.Buffer, data *api.ZettelDataJSON) error { + enc := json.NewEncoder(buf) + enc.SetEscapeHTML(false) + return enc.Encode(&data) +} + +// ListZettel returns a list of all Zettel. +func (c *Client) ListZettel(ctx context.Context, query url.Values) ([]api.ZettelJSON, error) { + ub := c.jsonZettelURLBuilder(query) + resp, err := c.buildAndExecuteRequest(ctx, http.MethodGet, ub, nil, nil) + if err != nil { + return nil, err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return nil, errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var zl api.ZettelListJSON + err = dec.Decode(&zl) + if err != nil { + return nil, err + } + return zl.List, nil +} + +// GetZettelJSON returns a zettel as a JSON struct. +func (c *Client) GetZettelJSON(ctx context.Context, zid id.Zid, query url.Values) (*api.ZettelDataJSON, error) { + ub := c.jsonZettelURLBuilder(query).SetZid(zid) + resp, err := c.buildAndExecuteRequest(ctx, http.MethodGet, ub, nil, nil) + if err != nil { + return nil, err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return nil, errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var out api.ZettelDataJSON + err = dec.Decode(&out) + if err != nil { + return nil, err + } + return &out, nil +} + +// GetEvaluatedZettel return a zettel in a defined encoding. +func (c *Client) GetEvaluatedZettel(ctx context.Context, zid id.Zid, enc api.EncodingEnum) (string, error) { + ub := c.jsonZettelURLBuilder(nil).SetZid(zid) + ub.AppendQuery(api.QueryKeyFormat, enc.String()) + ub.AppendQuery(api.QueryKeyPart, api.PartContent) + resp, err := c.buildAndExecuteRequest(ctx, http.MethodGet, ub, nil, nil) + if err != nil { + return "", err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return "", errors.New(resp.Status) + } + content, err := io.ReadAll(resp.Body) + if err != nil { + return "", err + } + return string(content), nil +} + +// GetZettelOrder returns metadata of the given zettel and, more important, +// metadata of zettel that are referenced in a list within the first zettel. +func (c *Client) GetZettelOrder(ctx context.Context, zid id.Zid) (*api.ZidMetaRelatedList, error) { + ub := c.newURLBuilder('o').SetZid(zid) + resp, err := c.buildAndExecuteRequest(ctx, http.MethodGet, ub, nil, nil) + if err != nil { + return nil, err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return nil, errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var out api.ZidMetaRelatedList + err = dec.Decode(&out) + if err != nil { + return nil, err + } + return &out, nil +} + +// ContextDirection specifies how the context should be calculated. +type ContextDirection uint8 + +// Allowed values for ContextDirection +const ( + _ ContextDirection = iota + DirBoth + DirBackward + DirForward +) + +// GetZettelContext returns metadata of the given zettel and, more important, +// metadata of zettel that for the context of the first zettel. +func (c *Client) GetZettelContext( + ctx context.Context, zid id.Zid, dir ContextDirection, depth, limit int) ( + *api.ZidMetaRelatedList, error, +) { + ub := c.newURLBuilder('x').SetZid(zid) + switch dir { + case DirBackward: + ub.AppendQuery(api.QueryKeyDir, api.DirBackward) + case DirForward: + ub.AppendQuery(api.QueryKeyDir, api.DirForward) + } + if depth > 0 { + ub.AppendQuery(api.QueryKeyDepth, strconv.Itoa(depth)) + } + if limit > 0 { + ub.AppendQuery(api.QueryKeyLimit, strconv.Itoa(limit)) + } + resp, err := c.buildAndExecuteRequest(ctx, http.MethodGet, ub, nil, nil) + if err != nil { + return nil, err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return nil, errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var out api.ZidMetaRelatedList + err = dec.Decode(&out) + if err != nil { + return nil, err + } + return &out, nil +} + +// GetZettelLinks returns connections to ohter zettel, images, externals URLs. +func (c *Client) GetZettelLinks(ctx context.Context, zid id.Zid) (*api.ZettelLinksJSON, error) { + ub := c.newURLBuilder('l').SetZid(zid) + resp, err := c.buildAndExecuteRequest(ctx, http.MethodGet, ub, nil, nil) + if err != nil { + return nil, err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return nil, errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var out api.ZettelLinksJSON + err = dec.Decode(&out) + if err != nil { + return nil, err + } + return &out, nil +} + +// UpdateZettel updates an existing zettel. +func (c *Client) UpdateZettel(ctx context.Context, zid id.Zid, data *api.ZettelDataJSON) error { + var buf bytes.Buffer + if err := encodeZettelData(&buf, data); err != nil { + return err + } + ub := c.jsonZettelURLBuilder(nil).SetZid(zid) + resp, err := c.buildAndExecuteRequest(ctx, http.MethodPut, ub, &buf, nil) + if err != nil { + return err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusNoContent { + return errors.New(resp.Status) + } + return nil +} + +// RenameZettel renames a zettel. +func (c *Client) RenameZettel(ctx context.Context, oldZid, newZid id.Zid) error { + ub := c.jsonZettelURLBuilder(nil).SetZid(oldZid) + h := http.Header{ + api.HeaderDestination: {c.jsonZettelURLBuilder(nil).SetZid(newZid).String()}, + } + resp, err := c.buildAndExecuteRequest(ctx, api.MethodMove, ub, nil, h) + if err != nil { + return err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusNoContent { + return errors.New(resp.Status) + } + return nil +} + +// DeleteZettel deletes a zettel with the given identifier. +func (c *Client) DeleteZettel(ctx context.Context, zid id.Zid) error { + ub := c.jsonZettelURLBuilder(nil).SetZid(zid) + resp, err := c.buildAndExecuteRequest(ctx, http.MethodDelete, ub, nil, nil) + if err != nil { + return err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusNoContent { + return errors.New(resp.Status) + } + return nil +} + +func (c *Client) jsonZettelURLBuilder(query url.Values) *api.URLBuilder { + ub := c.newURLBuilder('z') + for key, values := range query { + if key == api.QueryKeyFormat { + continue + } + for _, val := range values { + ub.AppendQuery(key, val) + } + } + return ub +} + +// ListTags returns a map of all tags, together with the associated zettel containing this tag. +func (c *Client) ListTags(ctx context.Context) (map[string][]string, error) { + err := c.updateToken(ctx) + if err != nil { + return nil, err + } + req, err := c.newRequest(ctx, http.MethodGet, c.newURLBuilder('t'), nil) + if err != nil { + return nil, err + } + resp, err := c.executeRequest(req) + if err != nil { + return nil, err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return nil, errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var tl api.TagListJSON + err = dec.Decode(&tl) + if err != nil { + return nil, err + } + return tl.Tags, nil +} + +// ListRoles returns a list of all roles. +func (c *Client) ListRoles(ctx context.Context) ([]string, error) { + err := c.updateToken(ctx) + if err != nil { + return nil, err + } + req, err := c.newRequest(ctx, http.MethodGet, c.newURLBuilder('r'), nil) + if err != nil { + return nil, err + } + resp, err := c.executeRequest(req) + if err != nil { + return nil, err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return nil, errors.New(resp.Status) + } + dec := json.NewDecoder(resp.Body) + var rl api.RoleListJSON + err = dec.Decode(&rl) + if err != nil { + return nil, err + } + return rl.Roles, nil +} ADDED client/client_test.go Index: client/client_test.go ================================================================== --- client/client_test.go +++ client/client_test.go @@ -0,0 +1,334 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package client provides a client for accessing the Zettelstore via its API. +package client_test + +import ( + "context" + "flag" + "fmt" + "net/url" + "testing" + + "zettelstore.de/z/api" + "zettelstore.de/z/client" + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" +) + +func TestCreateRenameDeleteZettel(t *testing.T) { + // Is not to be allowed to run in parallel with other tests. + c := getClient() + c.SetAuth("creator", "creator") + zid, err := c.CreateZettel(context.Background(), &api.ZettelDataJSON{ + Meta: nil, + Encoding: "", + Content: "Example", + }) + if err != nil { + t.Error("Cannot create zettel:", err) + return + } + if !zid.IsValid() { + t.Error("Invalid zettel ID", zid) + return + } + newZid := zid + 1 + c.SetAuth("owner", "owner") + err = c.RenameZettel(context.Background(), zid, newZid) + if err != nil { + t.Error("Cannot rename", zid, ":", err) + newZid = zid + } + err = c.DeleteZettel(context.Background(), newZid) + if err != nil { + t.Error("Cannot delete", zid, ":", err) + return + } +} + +func TestUpdateZettel(t *testing.T) { + t.Parallel() + c := getClient() + c.SetAuth("writer", "writer") + z, err := c.GetZettelJSON(context.Background(), id.DefaultHomeZid, nil) + if err != nil { + t.Error(err) + return + } + if got := z.Meta[meta.KeyTitle]; got != "Home" { + t.Errorf("Title of zettel is not \"Home\", but %q", got) + return + } + newTitle := "New Home" + z.Meta[meta.KeyTitle] = newTitle + err = c.UpdateZettel(context.Background(), id.DefaultHomeZid, z) + if err != nil { + t.Error(err) + return + } + zt, err := c.GetZettelJSON(context.Background(), id.DefaultHomeZid, nil) + if err != nil { + t.Error(err) + return + } + if got := zt.Meta[meta.KeyTitle]; got != newTitle { + t.Errorf("Title of zettel is not %q, but %q", newTitle, got) + } +} + +func TestList(t *testing.T) { + testdata := []struct { + user string + exp int + }{ + {"", 7}, + {"creator", 10}, + {"reader", 12}, + {"writer", 12}, + {"owner", 34}, + } + + t.Parallel() + c := getClient() + query := url.Values{api.QueryKeyFormat: {"html"}} // Client must remove "html" + for i, tc := range testdata { + t.Run(fmt.Sprintf("User %d/%q", i, tc.user), func(tt *testing.T) { + c.SetAuth(tc.user, tc.user) + l, err := c.ListZettel(context.Background(), query) + if err != nil { + tt.Error(err) + return + } + got := len(l) + if got != tc.exp { + tt.Errorf("List of length %d expected, but got %d\n%v", tc.exp, got, l) + } + }) + } + l, err := c.ListZettel(context.Background(), url.Values{meta.KeyRole: {meta.ValueRoleConfiguration}}) + if err != nil { + t.Error(err) + return + } + got := len(l) + if got != 27 { + t.Errorf("List of length %d expected, but got %d\n%v", 27, got, l) + } +} +func TestGetZettel(t *testing.T) { + t.Parallel() + c := getClient() + c.SetAuth("owner", "owner") + z, err := c.GetZettelJSON(context.Background(), id.DefaultHomeZid, url.Values{api.QueryKeyPart: {api.PartContent}}) + if err != nil { + t.Error(err) + return + } + if m := z.Meta; len(m) > 0 { + t.Errorf("Exptected empty meta, but got %v", z.Meta) + } + if z.Content == "" || z.Encoding != "" { + t.Errorf("Expect non-empty content, but empty encoding (got %q)", z.Encoding) + } +} + +func TestGetEvaluatedZettel(t *testing.T) { + t.Parallel() + c := getClient() + c.SetAuth("owner", "owner") + encodings := []api.EncodingEnum{ + api.EncoderDJSON, + api.EncoderHTML, + api.EncoderNative, + api.EncoderText, + } + for _, enc := range encodings { + content, err := c.GetEvaluatedZettel(context.Background(), id.DefaultHomeZid, enc) + if err != nil { + t.Error(err) + continue + } + if len(content) == 0 { + t.Errorf("Empty content for encoding %v", enc) + } + } +} + +func TestGetZettelOrder(t *testing.T) { + t.Parallel() + c := getClient() + c.SetAuth("owner", "owner") + rl, err := c.GetZettelOrder(context.Background(), id.TOCNewTemplateZid) + if err != nil { + t.Error(err) + return + } + if rl.ID != id.TOCNewTemplateZid.String() { + t.Errorf("Expected an Zid %v, but got %v", id.TOCNewTemplateZid, rl.ID) + return + } + l := rl.List + if got := len(l); got != 2 { + t.Errorf("Expected list fo length 2, got %d", got) + return + } + if got := l[0].ID; got != id.TemplateNewZettelZid.String() { + t.Errorf("Expected result[0]=%v, but got %v", id.TemplateNewZettelZid, got) + } + if got := l[1].ID; got != id.TemplateNewUserZid.String() { + t.Errorf("Expected result[1]=%v, but got %v", id.TemplateNewUserZid, got) + } +} + +func TestGetZettelContext(t *testing.T) { + t.Parallel() + c := getClient() + c.SetAuth("owner", "owner") + rl, err := c.GetZettelContext(context.Background(), id.VersionZid, client.DirBoth, 0, 3) + if err != nil { + t.Error(err) + return + } + if rl.ID != id.VersionZid.String() { + t.Errorf("Expected an Zid %v, but got %v", id.VersionZid, rl.ID) + return + } + l := rl.List + if got := len(l); got != 3 { + t.Errorf("Expected list fo length 3, got %d", got) + return + } + if got := l[0].ID; got != id.DefaultHomeZid.String() { + t.Errorf("Expected result[0]=%v, but got %v", id.DefaultHomeZid, got) + } + if got := l[1].ID; got != id.OperatingSystemZid.String() { + t.Errorf("Expected result[1]=%v, but got %v", id.OperatingSystemZid, got) + } + if got := l[2].ID; got != id.StartupConfigurationZid.String() { + t.Errorf("Expected result[2]=%v, but got %v", id.StartupConfigurationZid, got) + } + + rl, err = c.GetZettelContext(context.Background(), id.VersionZid, client.DirBackward, 0, 0) + if err != nil { + t.Error(err) + return + } + if rl.ID != id.VersionZid.String() { + t.Errorf("Expected an Zid %v, but got %v", id.VersionZid, rl.ID) + return + } + l = rl.List + if got := len(l); got != 1 { + t.Errorf("Expected list fo length 1, got %d", got) + return + } + if got := l[0].ID; got != id.DefaultHomeZid.String() { + t.Errorf("Expected result[0]=%v, but got %v", id.DefaultHomeZid, got) + } +} + +func TestGetZettelLinks(t *testing.T) { + t.Parallel() + c := getClient() + c.SetAuth("owner", "owner") + zl, err := c.GetZettelLinks(context.Background(), id.DefaultHomeZid) + if err != nil { + t.Error(err) + return + } + if zl.ID != id.DefaultHomeZid.String() { + t.Errorf("Expected an Zid %v, but got %v", id.DefaultHomeZid, zl.ID) + return + } + if len(zl.Links.Incoming) != 0 { + t.Error("No incomings expected", zl.Links.Incoming) + } + if got := len(zl.Links.Outgoing); got != 4 { + t.Errorf("Expected 4 outgoing links, got %d", got) + } + if got := len(zl.Links.Local); got != 1 { + t.Errorf("Expected 1 local link, got %d", got) + } + if got := len(zl.Links.External); got != 4 { + t.Errorf("Expected 4 external link, got %d", got) + } +} + +func TestListTags(t *testing.T) { + t.Parallel() + c := getClient() + c.SetAuth("owner", "owner") + tm, err := c.ListTags(context.Background()) + if err != nil { + t.Error(err) + return + } + tags := []struct { + key string + size int + }{ + {"#invisible", 1}, + {"#user", 4}, + {"#test", 4}, + } + if len(tm) != len(tags) { + t.Errorf("Expected %d different tags, but got only %d (%v)", len(tags), len(tm), tm) + } + for _, tag := range tags { + if zl, ok := tm[tag.key]; !ok { + t.Errorf("No tag %v: %v", tag.key, tm) + } else if len(zl) != tag.size { + t.Errorf("Expected %d zettel with tag %v, but got %v", tag.size, tag.key, zl) + } + } + for i, id := range tm["#user"] { + if id != tm["#test"][i] { + t.Errorf("Tags #user and #test have different content: %v vs %v", tm["#user"], tm["#test"]) + } + } +} + +func TestListRoles(t *testing.T) { + t.Parallel() + c := getClient() + c.SetAuth("owner", "owner") + rl, err := c.ListRoles(context.Background()) + if err != nil { + t.Error(err) + return + } + exp := []string{"configuration", "user", "zettel"} + if len(rl) != len(exp) { + t.Errorf("Expected %d different tags, but got only %d (%v)", len(exp), len(rl), rl) + } + for i, id := range exp { + if id != rl[i] { + t.Errorf("Role list pos %d: expected %q, got %q", i, id, rl[i]) + } + } +} + +var baseURL string + +func init() { + flag.StringVar(&baseURL, "base-url", "", "Base URL") +} + +func getClient() *client.Client { return client.NewClient(baseURL) } + +// TestMain controls whether client API tests should run or not. +func TestMain(m *testing.M) { + flag.Parse() + if baseURL != "" { + m.Run() + } +} Index: cmd/cmd_file.go ================================================================== --- cmd/cmd_file.go +++ cmd/cmd_file.go @@ -14,10 +14,11 @@ "flag" "fmt" "io" "os" + "zettelstore.de/z/api" "zettelstore.de/z/domain" "zettelstore.de/z/domain/id" "zettelstore.de/z/domain/meta" "zettelstore.de/z/encoder" "zettelstore.de/z/input" @@ -38,11 +39,11 @@ Content: domain.NewContent(inp.Src[inp.Pos:]), }, m.GetDefault(meta.KeySyntax, meta.ValueSyntaxZmk), nil, ) - enc := encoder.Create(format, &encoder.Environment{Lang: m.GetDefault(meta.KeyLang, meta.ValueLangEN)}) + enc := encoder.Create(api.Encoder(format), &encoder.Environment{Lang: m.GetDefault(meta.KeyLang, meta.ValueLangEN)}) if enc == nil { fmt.Fprintf(os.Stderr, "Unknown format %q\n", format) return 2, nil } _, err = enc.WriteZettel(os.Stdout, z, format != "raw") Index: cmd/cmd_run.go ================================================================== --- cmd/cmd_run.go +++ cmd/cmd_run.go @@ -12,17 +12,17 @@ import ( "flag" "net/http" + zsapi "zettelstore.de/z/api" "zettelstore.de/z/auth" + "zettelstore.de/z/box" "zettelstore.de/z/config" "zettelstore.de/z/domain/meta" "zettelstore.de/z/kernel" - "zettelstore.de/z/place" "zettelstore.de/z/usecase" - "zettelstore.de/z/web/adapter" "zettelstore.de/z/web/adapter/api" "zettelstore.de/z/web/adapter/webui" "zettelstore.de/z/web/server" ) @@ -56,71 +56,81 @@ return 1, err } return 0, nil } -func setupRouting(webSrv server.Server, placeManager place.Manager, authManager auth.Manager, rtConfig config.Config) { - protectedPlaceManager, authPolicy := authManager.PlaceWithPolicy(webSrv, placeManager, rtConfig) - api := api.New(webSrv, authManager, authManager, webSrv, rtConfig) - wui := webui.New(webSrv, authManager, rtConfig, authManager, placeManager, authPolicy) - - ucAuthenticate := usecase.NewAuthenticate(authManager, authManager, placeManager) - ucCreateZettel := usecase.NewCreateZettel(rtConfig, protectedPlaceManager) - ucGetMeta := usecase.NewGetMeta(protectedPlaceManager) - ucGetZettel := usecase.NewGetZettel(protectedPlaceManager) +func setupRouting(webSrv server.Server, boxManager box.Manager, authManager auth.Manager, rtConfig config.Config) { + protectedBoxManager, authPolicy := authManager.BoxWithPolicy(webSrv, boxManager, rtConfig) + api := api.New(webSrv, authManager, authManager, webSrv, rtConfig) + wui := webui.New(webSrv, authManager, rtConfig, authManager, boxManager, authPolicy) + + ucAuthenticate := usecase.NewAuthenticate(authManager, authManager, boxManager) + ucCreateZettel := usecase.NewCreateZettel(rtConfig, protectedBoxManager) + ucGetMeta := usecase.NewGetMeta(protectedBoxManager) + ucGetAllMeta := usecase.NewGetAllMeta(protectedBoxManager) + ucGetZettel := usecase.NewGetZettel(protectedBoxManager) ucParseZettel := usecase.NewParseZettel(rtConfig, ucGetZettel) - ucListMeta := usecase.NewListMeta(protectedPlaceManager) - ucListRoles := usecase.NewListRole(protectedPlaceManager) - ucListTags := usecase.NewListTags(protectedPlaceManager) - ucZettelContext := usecase.NewZettelContext(protectedPlaceManager) - - webSrv.Handle("/", wui.MakeGetRootHandler(protectedPlaceManager)) - webSrv.AddListRoute('a', http.MethodGet, wui.MakeGetLoginHandler()) - webSrv.AddListRoute('a', http.MethodPost, adapter.MakePostLoginHandler( - api.MakePostLoginHandlerAPI(ucAuthenticate), - wui.MakePostLoginHandlerHTML(ucAuthenticate))) - webSrv.AddListRoute('a', http.MethodPut, api.MakeRenewAuthHandler()) + ucListMeta := usecase.NewListMeta(protectedBoxManager) + ucListRoles := usecase.NewListRole(protectedBoxManager) + ucListTags := usecase.NewListTags(protectedBoxManager) + ucZettelContext := usecase.NewZettelContext(protectedBoxManager) + ucDelete := usecase.NewDeleteZettel(protectedBoxManager) + ucUpdate := usecase.NewUpdateZettel(protectedBoxManager) + ucRename := usecase.NewRenameZettel(protectedBoxManager) + + webSrv.Handle("/", wui.MakeGetRootHandler(protectedBoxManager)) + + // Web user interface + webSrv.AddListRoute('a', http.MethodGet, wui.MakeGetLoginHandler()) + webSrv.AddListRoute('a', http.MethodPost, wui.MakePostLoginHandler(ucAuthenticate)) webSrv.AddZettelRoute('a', http.MethodGet, wui.MakeGetLogoutHandler()) if !authManager.IsReadonly() { webSrv.AddZettelRoute('b', http.MethodGet, wui.MakeGetRenameZettelHandler(ucGetMeta)) - webSrv.AddZettelRoute('b', http.MethodPost, wui.MakePostRenameZettelHandler( - usecase.NewRenameZettel(protectedPlaceManager))) + webSrv.AddZettelRoute('b', http.MethodPost, wui.MakePostRenameZettelHandler(ucRename)) webSrv.AddZettelRoute('c', http.MethodGet, wui.MakeGetCopyZettelHandler( ucGetZettel, usecase.NewCopyZettel())) webSrv.AddZettelRoute('c', http.MethodPost, wui.MakePostCreateZettelHandler(ucCreateZettel)) webSrv.AddZettelRoute('d', http.MethodGet, wui.MakeGetDeleteZettelHandler(ucGetZettel)) - webSrv.AddZettelRoute('d', http.MethodPost, wui.MakePostDeleteZettelHandler( - usecase.NewDeleteZettel(protectedPlaceManager))) + webSrv.AddZettelRoute('d', http.MethodPost, wui.MakePostDeleteZettelHandler(ucDelete)) webSrv.AddZettelRoute('e', http.MethodGet, wui.MakeEditGetZettelHandler(ucGetZettel)) - webSrv.AddZettelRoute('e', http.MethodPost, wui.MakeEditSetZettelHandler( - usecase.NewUpdateZettel(protectedPlaceManager))) + webSrv.AddZettelRoute('e', http.MethodPost, wui.MakeEditSetZettelHandler(ucUpdate)) webSrv.AddZettelRoute('f', http.MethodGet, wui.MakeGetFolgeZettelHandler( ucGetZettel, usecase.NewFolgeZettel(rtConfig))) webSrv.AddZettelRoute('f', http.MethodPost, wui.MakePostCreateZettelHandler(ucCreateZettel)) webSrv.AddZettelRoute('g', http.MethodGet, wui.MakeGetNewZettelHandler( ucGetZettel, usecase.NewNewZettel())) webSrv.AddZettelRoute('g', http.MethodPost, wui.MakePostCreateZettelHandler(ucCreateZettel)) } webSrv.AddListRoute('f', http.MethodGet, wui.MakeSearchHandler( - usecase.NewSearch(protectedPlaceManager), ucGetMeta, ucGetZettel)) + usecase.NewSearch(protectedBoxManager), ucGetMeta, ucGetZettel)) webSrv.AddListRoute('h', http.MethodGet, wui.MakeListHTMLMetaHandler( ucListMeta, ucListRoles, ucListTags)) webSrv.AddZettelRoute('h', http.MethodGet, wui.MakeGetHTMLZettelHandler( ucParseZettel, ucGetMeta)) - webSrv.AddZettelRoute('i', http.MethodGet, wui.MakeGetInfoHandler(ucParseZettel, ucGetMeta)) + webSrv.AddZettelRoute('i', http.MethodGet, wui.MakeGetInfoHandler( + ucParseZettel, ucGetMeta, ucGetAllMeta)) webSrv.AddZettelRoute('j', http.MethodGet, wui.MakeZettelContextHandler(ucZettelContext)) + // API webSrv.AddZettelRoute('l', http.MethodGet, api.MakeGetLinksHandler(ucParseZettel)) webSrv.AddZettelRoute('o', http.MethodGet, api.MakeGetOrderHandler( - usecase.NewZettelOrder(protectedPlaceManager, ucParseZettel))) + usecase.NewZettelOrder(protectedBoxManager, ucParseZettel))) webSrv.AddListRoute('r', http.MethodGet, api.MakeListRoleHandler(ucListRoles)) webSrv.AddListRoute('t', http.MethodGet, api.MakeListTagsHandler(ucListTags)) - webSrv.AddZettelRoute('y', http.MethodGet, api.MakeZettelContextHandler(ucZettelContext)) + webSrv.AddListRoute('v', http.MethodPost, api.MakePostLoginHandler(ucAuthenticate)) + webSrv.AddListRoute('v', http.MethodPut, api.MakeRenewAuthHandler()) + webSrv.AddZettelRoute('x', http.MethodGet, api.MakeZettelContextHandler(ucZettelContext)) webSrv.AddListRoute('z', http.MethodGet, api.MakeListMetaHandler( - usecase.NewListMeta(protectedPlaceManager), ucGetMeta, ucParseZettel)) + usecase.NewListMeta(protectedBoxManager), ucGetMeta, ucParseZettel)) webSrv.AddZettelRoute('z', http.MethodGet, api.MakeGetZettelHandler( ucParseZettel, ucGetMeta)) + if !authManager.IsReadonly() { + webSrv.AddListRoute('z', http.MethodPost, api.MakePostCreateZettelHandler(ucCreateZettel)) + webSrv.AddZettelRoute('z', http.MethodDelete, api.MakeDeleteZettelHandler(ucDelete)) + webSrv.AddZettelRoute('z', http.MethodPut, api.MakeUpdateZettelHandler(ucUpdate)) + webSrv.AddZettelRoute('z', zsapi.MethodMove, api.MakeRenameZettelHandler(ucRename)) + } if authManager.WithAuth() { - webSrv.SetUserRetriever(usecase.NewGetUserByZid(placeManager)) + webSrv.SetUserRetriever(usecase.NewGetUserByZid(boxManager)) } } Index: cmd/command.go ================================================================== --- cmd/command.go +++ cmd/command.go @@ -17,16 +17,17 @@ "zettelstore.de/z/domain/meta" ) // Command stores information about commands / sub-commands. type Command struct { - Name string // command name as it appears on the command line - Func CommandFunc // function that executes a command - Places bool // if true then places will be set up - Header bool // Print a heading on startup - Flags func(*flag.FlagSet) // function to set up flag.FlagSet - flags *flag.FlagSet // flags that belong to the command + Name string // command name as it appears on the command line + Func CommandFunc // function that executes a command + Boxes bool // if true then boxes will be set up + Header bool // Print a heading on startup + LineServer bool // Start admin line server + Flags func(*flag.FlagSet) // function to set up flag.FlagSet + flags *flag.FlagSet // flags that belong to the command } // CommandFunc is the function that executes the command. // It accepts the parsed command line parameters. Index: cmd/fd_limit_raise.go ================================================================== --- cmd/fd_limit_raise.go +++ cmd/fd_limit_raise.go @@ -39,9 +39,9 @@ err = syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) if err != nil { return err } if rLimit.Cur < minFiles { - log.Printf("Make sure you have no more than %d files in all your places if you enabled notification\n", rLimit.Cur) + log.Printf("Make sure you have no more than %d files in all your boxes if you enabled notification\n", rLimit.Cur) } return nil } Index: cmd/main.go ================================================================== --- cmd/main.go +++ cmd/main.go @@ -20,18 +20,18 @@ "strconv" "strings" "zettelstore.de/z/auth" "zettelstore.de/z/auth/impl" + "zettelstore.de/z/box" + "zettelstore.de/z/box/compbox" + "zettelstore.de/z/box/manager" "zettelstore.de/z/config" "zettelstore.de/z/domain/id" "zettelstore.de/z/domain/meta" "zettelstore.de/z/input" "zettelstore.de/z/kernel" - "zettelstore.de/z/place" - "zettelstore.de/z/place/manager" - "zettelstore.de/z/place/progplace" "zettelstore.de/z/web/server" ) const ( defConfigfile = ".zscfg" @@ -52,20 +52,21 @@ Name: "version", Func: func(*flag.FlagSet, *meta.Meta) (int, error) { return 0, nil }, Header: true, }) RegisterCommand(Command{ - Name: "run", - Func: runFunc, - Places: true, - Header: true, - Flags: flgRun, + Name: "run", + Func: runFunc, + Boxes: true, + Header: true, + LineServer: true, + Flags: flgRun, }) RegisterCommand(Command{ Name: "run-simple", Func: runSimpleFunc, - Places: true, + Boxes: true, Header: true, Flags: flgSimpleRun, }) RegisterCommand(Command{ Name: "file", @@ -111,11 +112,11 @@ if strings.HasPrefix(val, "/") { val = "dir://" + val } else { val = "dir:" + val } - cfg.Set(keyPlaceOneURI, val) + cfg.Set(keyBoxOneURI, val) case "r": cfg.Set(keyReadOnly, flg.Value.String()) case "v": cfg.Set(keyVerbose, flg.Value.String()) } @@ -131,22 +132,22 @@ } return strconv.Itoa(port), nil } const ( - keyAdminPort = "admin-port" - keyDefaultDirPlaceType = "default-dir-place-type" - keyInsecureCookie = "insecure-cookie" - keyListenAddr = "listen-addr" - keyOwner = "owner" - keyPersistentCookie = "persistent-cookie" - keyPlaceOneURI = kernel.PlaceURIs + "1" - keyReadOnly = "read-only-mode" - keyTokenLifetimeHTML = "token-lifetime-html" - keyTokenLifetimeAPI = "token-lifetime-api" - keyURLPrefix = "url-prefix" - keyVerbose = "verbose" + keyAdminPort = "admin-port" + keyDefaultDirBoxType = "default-dir-box-type" + keyInsecureCookie = "insecure-cookie" + keyListenAddr = "listen-addr" + keyOwner = "owner" + keyPersistentCookie = "persistent-cookie" + keyBoxOneURI = kernel.BoxURIs + "1" + keyReadOnly = "read-only-mode" + keyTokenLifetimeHTML = "token-lifetime-html" + keyTokenLifetimeAPI = "token-lifetime-api" + keyURLPrefix = "url-prefix" + keyVerbose = "verbose" ) func setServiceConfig(cfg *meta.Meta) error { ok := setConfigValue(true, kernel.CoreService, kernel.CoreVerbose, cfg.GetBool(keyVerbose)) if val, found := cfg.Get(keyAdminPort); found { @@ -155,21 +156,21 @@ ok = setConfigValue(ok, kernel.AuthService, kernel.AuthOwner, cfg.GetDefault(keyOwner, "")) ok = setConfigValue(ok, kernel.AuthService, kernel.AuthReadonly, cfg.GetBool(keyReadOnly)) ok = setConfigValue( - ok, kernel.PlaceService, kernel.PlaceDefaultDirType, - cfg.GetDefault(keyDefaultDirPlaceType, kernel.PlaceDirTypeNotify)) - ok = setConfigValue(ok, kernel.PlaceService, kernel.PlaceURIs+"1", "dir:./zettel") - format := kernel.PlaceURIs + "%v" + ok, kernel.BoxService, kernel.BoxDefaultDirType, + cfg.GetDefault(keyDefaultDirBoxType, kernel.BoxDirTypeNotify)) + ok = setConfigValue(ok, kernel.BoxService, kernel.BoxURIs+"1", "dir:./zettel") + format := kernel.BoxURIs + "%v" for i := 1; ; i++ { key := fmt.Sprintf(format, i) val, found := cfg.Get(key) if !found { break } - ok = setConfigValue(ok, kernel.PlaceService, key, val) + ok = setConfigValue(ok, kernel.BoxService, key, val) } ok = setConfigValue( ok, kernel.WebService, kernel.WebListenAddress, cfg.GetDefault(keyListenAddr, "127.0.0.1:23123")) @@ -193,34 +194,34 @@ kernel.Main.Log("unable to set configuration:", key, val) } return ok && done } -func setupOperations(cfg *meta.Meta, withPlaces bool) { - var createManager kernel.CreatePlaceManagerFunc - if withPlaces { +func setupOperations(cfg *meta.Meta, withBoxes bool) { + var createManager kernel.CreateBoxManagerFunc + if withBoxes { err := raiseFdLimit() if err != nil { srvm := kernel.Main srvm.Log("Raising some limitions did not work:", err) srvm.Log("Prepare to encounter errors. Most of them can be mitigated. See the manual for details") - srvm.SetConfig(kernel.PlaceService, kernel.PlaceDefaultDirType, kernel.PlaceDirTypeSimple) + srvm.SetConfig(kernel.BoxService, kernel.BoxDefaultDirType, kernel.BoxDirTypeSimple) } - createManager = func(placeURIs []*url.URL, authManager auth.Manager, rtConfig config.Config) (place.Manager, error) { - progplace.Setup(cfg) - return manager.New(placeURIs, authManager, rtConfig) + createManager = func(boxURIs []*url.URL, authManager auth.Manager, rtConfig config.Config) (box.Manager, error) { + compbox.Setup(cfg) + return manager.New(boxURIs, authManager, rtConfig) } } else { - createManager = func([]*url.URL, auth.Manager, config.Config) (place.Manager, error) { return nil, nil } + createManager = func([]*url.URL, auth.Manager, config.Config) (box.Manager, error) { return nil, nil } } kernel.Main.SetCreators( func(readonly bool, owner id.Zid) (auth.Manager, error) { return impl.New(readonly, owner, cfg.GetDefault("secret", "")), nil }, createManager, - func(srv server.Server, plMgr place.Manager, authMgr auth.Manager, rtConfig config.Config) error { + func(srv server.Server, plMgr box.Manager, authMgr auth.Manager, rtConfig config.Config) error { setupRouting(srv, plMgr, authMgr, rtConfig) return nil }, ) } @@ -239,12 +240,12 @@ cfg := getConfig(fs) if err := setServiceConfig(cfg); err != nil { fmt.Fprintf(os.Stderr, "%s: %v\n", name, err) return 2 } - setupOperations(cfg, command.Places) - kernel.Main.Start(command.Header) + setupOperations(cfg, command.Boxes) + kernel.Main.Start(command.Header, command.LineServer) exitCode, err := command.Func(fs, cfg) if err != nil { fmt.Fprintf(os.Stderr, "%s: %v\n", name, err) } kernel.Main.Shutdown(true) Index: cmd/register.go ================================================================== --- cmd/register.go +++ cmd/register.go @@ -11,10 +11,15 @@ // Package cmd provides command generic functions. package cmd // Mention all needed encoders, parsers and stores to have them registered. import ( + _ "zettelstore.de/z/box/compbox" // Allow to use computed box. + _ "zettelstore.de/z/box/constbox" // Allow to use global internal box. + _ "zettelstore.de/z/box/dirbox" // Allow to use directory box. + _ "zettelstore.de/z/box/filebox" // Allow to use file box. + _ "zettelstore.de/z/box/membox" // Allow to use in-memory box. _ "zettelstore.de/z/encoder/htmlenc" // Allow to use HTML encoder. _ "zettelstore.de/z/encoder/jsonenc" // Allow to use JSON encoder. _ "zettelstore.de/z/encoder/nativeenc" // Allow to use native encoder. _ "zettelstore.de/z/encoder/rawenc" // Allow to use raw encoder. _ "zettelstore.de/z/encoder/textenc" // Allow to use text encoder. @@ -23,11 +28,6 @@ _ "zettelstore.de/z/parser/blob" // Allow to use BLOB parser. _ "zettelstore.de/z/parser/markdown" // Allow to use markdown parser. _ "zettelstore.de/z/parser/none" // Allow to use none parser. _ "zettelstore.de/z/parser/plain" // Allow to use plain parser. _ "zettelstore.de/z/parser/zettelmark" // Allow to use zettelmark parser. - _ "zettelstore.de/z/place/constplace" // Allow to use global internal place. - _ "zettelstore.de/z/place/dirplace" // Allow to use directory place. - _ "zettelstore.de/z/place/fileplace" // Allow to use file place. - _ "zettelstore.de/z/place/memplace" // Allow to use memory place. - _ "zettelstore.de/z/place/progplace" // Allow to use computed place. ) Index: collect/collect.go ================================================================== --- collect/collect.go +++ collect/collect.go @@ -9,13 +9,11 @@ //----------------------------------------------------------------------------- // Package collect provides functions to collect items from a syntax tree. package collect -import ( - "zettelstore.de/z/ast" -) +import "zettelstore.de/z/ast" // Summary stores the relevant parts of the syntax tree type Summary struct { Links []*ast.Reference // list of all referenced links Images []*ast.Reference // list of all referenced images @@ -22,82 +20,24 @@ Cites []*ast.CiteNode // list of all referenced citations } // References returns all references mentioned in the given zettel. This also // includes references to images. -func References(zn *ast.ZettelNode) Summary { - lv := linkVisitor{} - ast.NewTopDownTraverser(&lv).VisitBlockSlice(zn.Ast) - return lv.summary -} - -type linkVisitor struct { - summary Summary -} - -// VisitVerbatim does nothing. -func (lv *linkVisitor) VisitVerbatim(vn *ast.VerbatimNode) {} - -// VisitRegion does nothing. -func (lv *linkVisitor) VisitRegion(rn *ast.RegionNode) {} - -// VisitHeading does nothing. -func (lv *linkVisitor) VisitHeading(hn *ast.HeadingNode) {} - -// VisitHRule does nothing. -func (lv *linkVisitor) VisitHRule(hn *ast.HRuleNode) {} - -// VisitList does nothing. -func (lv *linkVisitor) VisitNestedList(ln *ast.NestedListNode) {} - -// VisitDescriptionList does nothing. -func (lv *linkVisitor) VisitDescriptionList(dn *ast.DescriptionListNode) {} - -// VisitPara does nothing. -func (lv *linkVisitor) VisitPara(pn *ast.ParaNode) {} - -// VisitTable does nothing. -func (lv *linkVisitor) VisitTable(tn *ast.TableNode) {} - -// VisitBLOB does nothing. -func (lv *linkVisitor) VisitBLOB(bn *ast.BLOBNode) {} - -// VisitText does nothing. -func (lv *linkVisitor) VisitText(tn *ast.TextNode) {} - -// VisitTag does nothing. -func (lv *linkVisitor) VisitTag(tn *ast.TagNode) {} - -// VisitSpace does nothing. -func (lv *linkVisitor) VisitSpace(sn *ast.SpaceNode) {} - -// VisitBreak does nothing. -func (lv *linkVisitor) VisitBreak(bn *ast.BreakNode) {} - -// VisitLink collects the given link as a reference. -func (lv *linkVisitor) VisitLink(ln *ast.LinkNode) { - lv.summary.Links = append(lv.summary.Links, ln.Ref) -} - -// VisitImage collects the image links as a reference. -func (lv *linkVisitor) VisitImage(in *ast.ImageNode) { - if in.Ref != nil { - lv.summary.Images = append(lv.summary.Images, in.Ref) - } -} - -// VisitCite collects the citation. -func (lv *linkVisitor) VisitCite(cn *ast.CiteNode) { - lv.summary.Cites = append(lv.summary.Cites, cn) -} - -// VisitFootnote does nothing. -func (lv *linkVisitor) VisitFootnote(fn *ast.FootnoteNode) {} - -// VisitMark does nothing. -func (lv *linkVisitor) VisitMark(mn *ast.MarkNode) {} - -// VisitFormat does nothing. -func (lv *linkVisitor) VisitFormat(fn *ast.FormatNode) {} - -// VisitLiteral does nothing. -func (lv *linkVisitor) VisitLiteral(ln *ast.LiteralNode) {} +func References(zn *ast.ZettelNode) (s Summary) { + ast.WalkBlockSlice(&s, zn.Ast) + return s +} + +// Visit all node to collect data for the summary. +func (s *Summary) Visit(node ast.Node) ast.Visitor { + switch n := node.(type) { + case *ast.LinkNode: + s.Links = append(s.Links, n.Ref) + case *ast.ImageNode: + if n.Ref != nil { + s.Images = append(s.Images, n.Ref) + } + case *ast.CiteNode: + s.Cites = append(s.Cites, n) + } + return s +} Index: collect/collect_test.go ================================================================== --- collect/collect_test.go +++ collect/collect_test.go @@ -25,10 +25,11 @@ } return r } func TestLinks(t *testing.T) { + t.Parallel() zn := &ast.ZettelNode{} summary := collect.References(zn) if summary.Links != nil || summary.Images != nil { t.Error("No links/images expected, but got:", summary.Links, "and", summary.Images) } @@ -52,10 +53,11 @@ t.Error("Link count does not work. Expected: 3, got", summary.Links) } } func TestImage(t *testing.T) { + t.Parallel() zn := &ast.ZettelNode{ Ast: ast.BlockSlice{ &ast.ParaNode{ Inlines: ast.InlineSlice{ &ast.ImageNode{Ref: parseRef("12345678901234")}, Index: collect/order.go ================================================================== --- collect/order.go +++ collect/order.go @@ -15,11 +15,11 @@ // Order of internal reference within the given zettel. func Order(zn *ast.ZettelNode) (result []*ast.Reference) { for _, bn := range zn.Ast { if ln, ok := bn.(*ast.NestedListNode); ok { - switch ln.Code { + switch ln.Kind { case ast.NestedListOrdered, ast.NestedListUnordered: for _, is := range ln.Items { if ref := firstItemZettelReference(is); ref != nil { result = append(result, ref) } Index: config/config.go ================================================================== --- config/config.go +++ config/config.go @@ -54,14 +54,10 @@ GetMarkerExternal() string // GetFooterHTML returns HTML code that should be embedded into the footer // of each WebUI page. GetFooterHTML() string - - // GetListPageSize returns the maximum length of a list to be returned in WebUI. - // A value less or equal to zero signals no limit. - GetListPageSize() int } // AuthConfig are relevant configuration values for authentication. type AuthConfig interface { // GetExpertMode returns the current value of the "expert-mode" key Index: docs/manual/00001002000000.zettel ================================================================== --- docs/manual/00001002000000.zettel +++ docs/manual/00001002000000.zettel @@ -13,14 +13,14 @@ : All zettel belong to you, only to you. Zettelstore provides its services only to one person: you. If your device is securely configured, there should be no risk that others are able to read or update your zettel. : If you want, you can customize Zettelstore in a way that some specific or all persons are able to read some of your zettel. ; Ease of installation -: If you want to use the Zettelstore software, all you need is to copy the executable to an appropriate place and start working. +: If you want to use the Zettelstore software, all you need is to copy the executable to an appropriate file directory and start working. : Upgrading the software is done just by replacing the executable with a newer one. ; Ease of operation -: There is only one executable for Zettelstore and one directory, where your zettel are placed. +: There is only one executable for Zettelstore and one directory, where your zettel are stored. : If you decide to use multiple directories, you are free to configure Zettelstore appropriately. ; Multiple modes of operation : You can use Zettelstore as a standalone software on your device, but you are not restricted to it. : You can install the software on a central server, or you can install it on all your devices with no restrictions how to synchronize your zettel. ; Multiple user interfaces Index: docs/manual/00001003000000.zettel ================================================================== --- docs/manual/00001003000000.zettel +++ docs/manual/00001003000000.zettel @@ -7,11 +7,11 @@ === The curious user You just want to check out the Zettelstore software * Grab the appropriate executable and copy it into any directory * Start the Zettelstore software, e.g. with a double click -* A sub-directory ""zettel"" will be created in the directory where you placed the executable. +* A sub-directory ""zettel"" will be created in the directory where you put the executable. It will contain your future zettel. * Open the URI [[http://localhost:23123]] with your web browser. It will present you a mostly empty Zettelstore. There will be a zettel titled ""[[Home|00010000000000]]"" that contains some helpful information. * Please read the instructions for the web-based user interface and learn about the various ways to write zettel. @@ -41,11 +41,11 @@ --create-home --home-dir /var/lib/zettelstore \ --shell /usr/sbin/nologin \ --comment "Zettelstore server" \ zettelstore ``` -Create a systemd service file and place it into ''/etc/systemd/system/zettelstore.service'': +Create a systemd service file and store it into ''/etc/systemd/system/zettelstore.service'': ```ini [Unit] Description=Zettelstore After=network.target Index: docs/manual/00001004010000.zettel ================================================================== --- docs/manual/00001004010000.zettel +++ docs/manual/00001004010000.zettel @@ -1,15 +1,15 @@ id: 00001004010000 title: Zettelstore startup configuration role: manual tags: #configuration #manual #zettelstore syntax: zmk -modified: 20210525121644 +modified: 20210712234656 The configuration file, as specified by the ''-c CONFIGFILE'' [[command line option|00001004051000]], allows you to specify some startup options. These options cannot be stored in a [[configuration zettel|00001004020000]] because either they are needed before Zettelstore can start or because of security reasons. -For example, Zettelstore need to know in advance, on which network address is must listen or where zettel are placed. +For example, Zettelstore need to know in advance, on which network address is must listen or where zettel are stored. An attacker that is able to change the owner can do anything. Therefore only the owner of the computer on which Zettelstore runs can change this information. The file for startup configuration must be created via a text editor in advance. @@ -16,18 +16,26 @@ The syntax of the configuration file is the same as for any zettel metadata. The following keys are supported: ; [!admin-port]''admin-port'' : Specifies the TCP port through which you can reach the [[administrator console|00001004100000]]. - A value of ''0'' (the default) disables the administrators console. + A value of ''0'' (the default) disables the administrator console. + The administrator console will only be enabled if Zettelstore is started with the [[''run'' sub-command|00001004051000]]. On most operating systems, the value must be greater than ''1024'' unless you start Zettelstore with the full privileges of a system administrator (which is not recommended). Default: ''0'' -; [!default-dir-place-type]''default-dir-place-type'' -: Specifies the default value for the (sub-) type of [[directory places|00001004011400#type]]. - Zettel are typically stored in such places. +; [!box-uri-x]''box-uri-//X//'', where //X// is a number greater or equal to one +: Specifies a [[box|00001004011200]] where zettel are stored. + During startup //X// is counted up, starting with one, until no key is found. + This allows to configure more than one box. + + If no ''box-uri-1'' key is given, the overall effect will be the same as if only ''box-uri-1'' was specified with the value ''dir://.zettel''. + In this case, even a key ''box-uri-2'' will be ignored. +; [!default-dir-box-type]''default-dir-box-type'' +: Specifies the default value for the (sub-) type of [[directory boxes|00001004011400#type]]. + Zettel are typically stored in such boxes. Default: ''notify'' ; [!insecure-cookie]''insecure-cookie'' : Must be set to ''true'', if authentication is enabled and Zettelstore is not accessible not via HTTPS (but via HTTP). Otherwise web browser are free to ignore the authentication cookie. @@ -50,17 +58,10 @@ If ''true'', a persistent cookie is used. Its lifetime exceeds the lifetime of the authentication token (see option ''token-lifetime-html'') by 30 seconds. Default: ''false'' -; [!place-uri-X]''place-uri-//X//'', where //X// is a number greater or equal to one -: Specifies a [[place|00001004011200]] where zettel are stored. - During startup //X// is counted up, starting with one, until no key is found. - This allows to configure more than one place. - - If no ''place-uri-1'' key is given, the overall effect will be the same as if only ''place-uri-1'' was specified with the value ''dir://.zettel''. - In this case, even a key ''place-uri-2'' will be ignored. ; [!read-only-mode]''read-only-mode'' : Puts the Zettelstore web service into a read-only mode. No changes are possible. Default: false. ; [!token-lifetime-api]''token-lifetime-api'', [!token-lifetime-html]''token-lifetime-html'' @@ -80,7 +81,5 @@ This allows to use a forwarding proxy [[server|00001010090100]] in front of the Zettelstore. ; ''verbose'' : Be more verbose inf logging data. Default: false - -Other keys will be ignored. Index: docs/manual/00001004011200.zettel ================================================================== --- docs/manual/00001004011200.zettel +++ docs/manual/00001004011200.zettel @@ -1,46 +1,46 @@ id: 00001004011200 -title: Zettelstore places +title: Zettelstore boxes role: manual tags: #configuration #manual #zettelstore syntax: zmk modified: 20210525121452 A Zettelstore must store its zettel somehow and somewhere. In most cases you want to store your zettel as files in a directory. -Under certain circumstances you may want to store your zettel in other places. +Under certain circumstances you may want to store your zettel elsewhere. An example are the [[predefined zettel|00001005090000]] that come with a Zettelstore. They are stored within the software itself. In another situation you may want to store your zettel volatile, e.g. if you want to provide a sandbox for experimenting. -To cope with these (and more) situations, you configure Zettelstore to use one or more places. -This is done via the ''place-uri-X'' keys of the [[startup configuration|00001004010000#place-uri-X]] (X is a number). -Places are specified using special [[URIs|https://en.wikipedia.org/wiki/Uniform_Resource_Identifier]], somehow similar to web addresses. +To cope with these (and more) situations, you configure Zettelstore to use one or more //boxes//{-}. +This is done via the ''box-uri-X'' keys of the [[startup configuration|00001004010000#box-uri-X]] (X is a number). +Boxes are specified using special [[URIs|https://en.wikipedia.org/wiki/Uniform_Resource_Identifier]], somehow similar to web addresses. -The following place URIs are supported: +The following box URIs are supported: ; ''dir:\//DIR'' : Specifies a directory where zettel files are stored. ''DIR'' is the file path. Although it is possible to use relative file paths, such as ''./zettel'' (→ URI is ''dir:\//.zettel''), it is preferable to use absolute file paths, e.g. ''/home/user/zettel''. The directory must exist before starting the Zettelstore[^There is one exception: when Zettelstore is [[started without any parameter|00001004050000]], e.g. via double-clicking its icon, an directory called ''./zettel'' will be created.]. - It is possible to [[configure|00001004011400]] a directory place. + It is possible to [[configure|00001004011400]] a directory box. ; ''file:FILE.zip'' oder ''file:/\//path/to/file.zip'' : Specifies a ZIP file which contains files that store zettel. You can create such a ZIP file, if you zip a directory full of zettel files. - This place is always read-only. + This box is always read-only. ; ''mem:'' : Stores all its zettel in volatile memory. If you stop the Zettelstore, all changes are lost. -All places that you configure via the ''store-uri-X'' keys form a chain of places. -If a zettel should be retrieved, a search starts in the place specified with the ''place-uri-2'' key, then ''place-uri-3'' and so on. -If a zettel is created or changed, it is always stored in the place specified with the ''place-uri-1'' key. -This allows to overwrite zettel from other places, e.g. the predefined zettel. +All boxes that you configure via the ''box-uri-X'' keys form a chain of boxes. +If a zettel should be retrieved, a search starts in the box specified with the ''box-uri-2'' key, then ''box-uri-3'' and so on. +If a zettel is created or changed, it is always stored in the box specified with the ''box-uri-1'' key. +This allows to overwrite zettel from other boxes, e.g. the predefined zettel. -If you use the ''mem:'' place, where zettel are stored in volatile memory, it makes only sense if you configure it as ''place-uri-1''. -Such a place will be empty when Zettelstore starts and only the first place will receive updates. +If you use the ''mem:'' box, where zettel are stored in volatile memory, it makes only sense if you configure it as ''box-uri-1''. +Such a box will be empty when Zettelstore starts and only the first box will receive updates. You must make sure that your computer has enough RAM to store all zettel. Index: docs/manual/00001004011400.zettel ================================================================== --- docs/manual/00001004011400.zettel +++ docs/manual/00001004011400.zettel @@ -1,29 +1,29 @@ id: 00001004011400 -title: Configure file directory places +title: Configure file directory boxes role: manual tags: #configuration #manual #zettelstore syntax: zmk modified: 20210525121232 -Under certain circumstances, it is preferable to further configure a file directory place. -This is done by appending query parameters after the base place URI ''dir:\//DIR''. +Under certain circumstances, it is preferable to further configure a file directory box. +This is done by appending query parameters after the base box URI ''dir:\//DIR''. The following parameters are supported: |= Parameter:|Description|Default value:| -|type|(Sub-) Type of the directory service|(value of ''[[default-dir-place-type|00001004010000#default-dir-place-type]]'') +|type|(Sub-) Type of the directory service|(value of ''[[default-dir-box-type|00001004010000#default-dir-box-type]]'') |rescan|Time (in seconds) after which the directory should be scanned fully|600 |worker|Number of worker that can access the directory in parallel|(depends on type) |readonly|Allow only operations that do not change a zettel or create a new zettel|n/a === Type On some operating systems, Zettelstore tries to detect changes to zettel files outside of Zettelstore's control[^This includes Linux, Windows, and macOS.]. On other operating systems, this may be not possible, due to technical limitations. -Automatic detection of external changes is also not possible, if zettel files are placed on an external service, such as a file server accessed via SMD/CIFS or NFS. +Automatic detection of external changes is also not possible, if zettel files are put on an external service, such as a file server accessed via SMD/CIFS or NFS. -To cope with this uncertainty, Zettelstore provides various internal implementations of a directory place. +To cope with this uncertainty, Zettelstore provides various internal implementations of a directory box. The default values should match the needs of different users, as explained in the [[installation part|00001003000000]] of this manual. The following values are supported: ; simple : Is not able to detect external changes. @@ -39,44 +39,44 @@ Under certain circumstances it is possible that Zettelstore does not detect a change done by another software. To cope with this unlikely, but still possible event, Zettelstore re-scans periodically the file directory. The time interval is configured by the ''rescan'' parameter, e.g. ``` -place-uri-1: dir:///home/zettel?rescan=300 +box-uri-1: dir:///home/zettel?rescan=300 ``` This makes Zettelstore to re-scan the directory ''/home/zettel/'' every 300 seconds, i.e. 5 minutes. For a Zettelstore with many zettel, re-scanning the directory may take a while, especially if it is stored on a remote computer (e.g. via CIFS/SMB or NFS). In this case, you should adjust the parameter value. Please note that a directory re-scan invalidates all internal data of a Zettelstore. It might trigger a re-build of the backlink database (and other internal databases). -Therefore a large value if preferred. +Therefore a large value is preferred. -This value is ignored for other directory place type, such as ""simple"". +This value is ignored for other directory box types, such as ""simple"". === Worker Internally, Zettelstore parallels concurrent requests for a zettel or its metadata. The number of parallel activities is configured by the ''worker'' parameter. A computer contains a limited number of internal processing units (CPU). Its number ranges from 1 to (currently) 128, e.g. in bigger server environments. Zettelstore typically runs on a system with 1 to 8 CPUs. Access to zettel file is ultimately managed by the underlying operating system. -Depending on the hardware and on the type of the directory place, only a limited number of parallel accesses are desirable. +Depending on the hardware and on the type of the directory box, only a limited number of parallel accesses are desirable. On smaller hardware[^In comparison to a normal desktop or laptop computer], such as the [[Raspberry Zero|https://www.raspberrypi.org/products/raspberry-pi-zero/]], a smaller value might be appropriate. Every worker needs some amount of main memory (RAM) and some amount of processing power. On bigger hardware, with some fast file services, a bigger value could result in higher performance, if needed. -For a directory place of type ""notify"", the default value is: 7. -The directory place type ""simple"" limits the value to a maximum of 1, i.e. no concurrency is possible with this type of directory place. +For a directory box of type ""notify"", the default value is: 7. +The directory box type ""simple"" limits the value to a maximum of 1, i.e. no concurrency is possible with this type of directory box. For various reasons, the value should be a prime number, with a maximum value of 1499. === Readonly -Sometimes you may want to provide zettel from a file directory place, but you want to disallow any changes. -If you provide the query parameter ''readonly'' (with or without a corresponding value), the place will disallow any changes. +Sometimes you may want to provide zettel from a file directory box, but you want to disallow any changes. +If you provide the query parameter ''readonly'' (with or without a corresponding value), the box will disallow any changes. ``` -place-uri-1: dir:///home/zettel?readonly +box-uri-1: dir:///home/zettel?readonly ``` -If you put the whole Zettelstore in [[read-only|00001004010000]] [[mode|00001004051000]], all configured file directory places will be in read-only mode too, even if not explicitly configured. +If you put the whole Zettelstore in [[read-only|00001004010000]] [[mode|00001004051000]], all configured file directory boxes will be in read-only mode too, even if not explicitly configured. Index: docs/manual/00001004020000.zettel ================================================================== --- docs/manual/00001004020000.zettel +++ docs/manual/00001004020000.zettel @@ -1,10 +1,11 @@ id: 00001004020000 title: Configure the running Zettelstore role: manual tags: #configuration #manual #zettelstore syntax: zmk +modified: 20210611213730 You can configure a running Zettelstore by modifying the special zettel with the ID [[00000000000100]]. This zettel is called ""configuration zettel"". The following metadata keys change the appearance / behavior of Zettelstore: @@ -52,14 +53,10 @@ : Specifies the identifier of the zettel, that should be presented for the default view / home view. If not given or if the identifier does not identify a zettel, the zettel with the identifier ''00010000000000'' is shown. ; [!marker-external]''marker-external'' : Some HTML code that is displayed after a reference to external material. Default: ''&\#10138;'', to display a ""➚"" sign. -; [!list-page-size]''list-page-size'' -: If set to a value greater than zero, specifies the number of items shown in WebUI lists. - Basically, this is the list of all zettel (possibly restricted) and the list of search results. - Default: ''0''. ; [!site-name]''site-name'' : Name of the Zettelstore instance. Will be used when displaying some lists. Default: ''Zettelstore''. ; [!yaml-header]''yaml-header'' Index: docs/manual/00001004050200.zettel ================================================================== --- docs/manual/00001004050200.zettel +++ docs/manual/00001004050200.zettel @@ -1,21 +1,20 @@ id: 00001004050200 title: The ''help'' sub-command role: manual tags: #command #configuration #manual #zettelstore syntax: zmk -precursor: 00001004050000 +modified: 20210712233414 Lists all implemented sub-commands. Example: ``` # zettelstore help Available commands: -- "config" - "file" - "help" - "password" - "run" - "run-simple" - "version" ``` Index: docs/manual/00001004050400.zettel ================================================================== --- docs/manual/00001004050400.zettel +++ docs/manual/00001004050400.zettel @@ -1,28 +1,27 @@ id: 00001004050400 title: The ''version'' sub-command role: manual tags: #command #configuration #manual #zettelstore syntax: zmk -precursor: 00001004050000 +modified: 20210712234031 Emits some information about the Zettelstore's version. This allows you to check, whether your installed Zettelstore is -The name of the software (""Zettelstore"") and the build version information is given, as well as the compiler version, the name of the computer running the Zettelstore, and an indication about the operating system and the processor architecture of that computer. - -The build version information is a string like ''v1.0.2-34-gf567a3''. -The part ""v1.0.2"" is the release version. -The string ""34"" specifies the number of internal patches, after the release was published. -""gf567a3"" is a code uniquely identify the version to the developer. - -Everything after the release version is optional, eg. ""v1.4.3"" is a valid build version information too. +The name of the software (""Zettelstore"") and the build version information is given, as well as the compiler version, and an indication about the operating system and the processor architecture of that computer. + +The build version information is a string like ''1.0.2+351ae138b4''. +The part ""1.0.2"" is the release version. +""+351ae138b4"" is a code uniquely identifying the version to the developer. + +Everything after the release version is optional, eg. ""1.4.3"" is a valid build version information too. Example: ``` # zettelstore version -Zettelstore (v0.0.4/go1.15) running on mycomputer (linux/amd64) +Zettelstore 1.0.2+351ae138b4 (go1.16.5@linux/amd64) +Licensed under the latest version of the EUPL (European Union Public License) ``` -In this example, Zettelstore is running in the released version ""v.0.0.4"" and was compiled using [[Go, version 1.15|https://golang.org/doc/go1.15]]. -It runs on a computer named ""mycomputer"". +In this example, Zettelstore is running in the released version ""1.0.2"" and was compiled using [[Go, version 1.16.5|https://golang.org/doc/go1.16]]. The software was build for running under a Linux operating system with an ""amd64"" processor. Index: docs/manual/00001004051000.zettel ================================================================== --- docs/manual/00001004051000.zettel +++ docs/manual/00001004051000.zettel @@ -1,18 +1,17 @@ id: 00001004051000 title: The ''run'' sub-command role: manual tags: #command #configuration #manual #zettelstore syntax: zmk -modified: 20210510153318 -precursor: 00001004050000 +modified: 20210712234419 === ``zettelstore run`` This starts the web service. ``` -zettelstore run [-c CONFIGFILE] [-d DIR] [-p PORT] [-r] [-v] +zettelstore run [-a PORT] [-c CONFIGFILE] [-d DIR] [-debug] [-p PORT] [-r] [-v] ``` ; [!a]''-a PORT'' : Specifies the TCP port through which you can reach the [[administrator console|00001004100000]]. See the explanation of [[''admin-port''|00001004010000#admin-port]] for more details. Index: docs/manual/00001004051100.zettel ================================================================== --- docs/manual/00001004051100.zettel +++ docs/manual/00001004051100.zettel @@ -1,23 +1,24 @@ id: 00001004051100 title: The ''run-simple'' sub-command role: manual tags: #command #configuration #manual #zettelstore syntax: zmk -precursor: 00001004050000 +modified: 20210712234203 === ``zettelstore run-simple`` This sub-command is implicitly called, when an user starts Zettelstore by double-clicking on its GUI icon. It is s simplified variant of the [[''run'' sub-command|00001004051000]]. It allows only to specify a zettel directory. The directory will be created automatically, if it does not exist. -This is the only difference to the ''run'' sub-command, where the directory must exists. +This is a difference to the ''run'' sub-command, where the directory must exists. +In contrast to the ''run'' sub-command, other command line parameter are not allowed. ``` zettelstore run-simple [-d DIR] ``` ; [!d]''-d DIR'' : Specifies ''DIR'' as the directory that contains all zettel. Default is ''./zettel'' (''.\\zettel'' on Windows), where ''.'' denotes the ""current directory"". Index: docs/manual/00001004051200.zettel ================================================================== --- docs/manual/00001004051200.zettel +++ docs/manual/00001004051200.zettel @@ -1,11 +1,11 @@ id: 00001004051200 title: The ''file'' sub-command role: manual tags: #command #configuration #manual #zettelstore syntax: zmk -precursor: 00001004050000 +modified: 20210712234222 Reads zettel data from a file (or from standard input / stdin) and renders it to standard output / stdout. This allows Zettelstore to render files manually. ``` zettelstore file [-t FORMAT] [file-1 [file-2]] Index: docs/manual/00001004051400.zettel ================================================================== --- docs/manual/00001004051400.zettel +++ docs/manual/00001004051400.zettel @@ -1,11 +1,11 @@ id: 00001004051400 title: The ''password'' sub-command role: manual tags: #command #configuration #manual #zettelstore syntax: zmk -precursor: 00001004050000 +modified: 20210712234305 This sub-command is used to create a hashed password for to be authenticated users. It reads a password from standard input (two times, both must be equal) and writes the hashed password to standard output. @@ -15,11 +15,11 @@ ``` ``IDENT`` is the identification for the user that should be authenticated. ``ZETTEL-ID`` is the [[identifier of the zettel|00001006050000]] that later acts as a user zettel. -See [[Creating an user zettel|00001010040200]] for background. +See [[Creating an user zettel|00001010040200]] for some background information. An example: ``` # zettelstore password bob 20200911115600 Index: docs/manual/00001004101000.zettel ================================================================== --- docs/manual/00001004101000.zettel +++ docs/manual/00001004101000.zettel @@ -58,14 +58,14 @@ : Sets a single configuration value for the next configuration of a given service. It will become effective if the service is restarted. If the key specifies a list value, all other list values with a number greater than the given key are deleted. You can use the special number ""0"" to delete all values. - E.g. ``set-config place place-uri-0 any_text`` will remove all values of the list //place-uri-//. + E.g. ``set-config box box-uri-0 any_text`` will remove all values of the list //box-uri-//. ; ''shutdown'' : Terminate the Zettelstore itself (and closes the connection to the administrator console). ; ''start SERVICE'' : Start the given bservice and all dependent services. ; ''stat SERVICE'' : Display some statistical values for the given service. ; ''stop SERVICE'' : Stop the given service and all other that depend on this. Index: docs/manual/00001005000000.zettel ================================================================== --- docs/manual/00001005000000.zettel +++ docs/manual/00001005000000.zettel @@ -1,10 +1,11 @@ id: 00001005000000 title: Structure of Zettelstore role: manual tags: #design #manual #zettelstore syntax: zmk +modified: 20210614165848 Zettelstore is a software that manages your zettel. Since every zettel must be readable without any special tool, most zettel has to be stored as ordinary files within specific directories. Typically, file names and file content must comply to specific rules so that Zettelstore can manage them. If you add, delete, or change zettel files with other tools, e.g. a text editor, Zettelstore will monitor these actions. @@ -18,11 +19,11 @@ Zettelstore becomes extensible by external software. For example, a more sophisticated web interface could be build, or an application for your mobile device that allows you to send content to your Zettelstore as new zettel. === Where zettel are stored -Your zettel are stored as files in a specific directory. +Your zettel are stored typically as files in a specific directory. If you have not explicitly specified the directory, a default directory will be used. The directory has to be specified at [[startup time|00001004010000]]. Nested directories are not supported (yet). Every file in this directory that should be monitored by Zettelstore must have a file name that begins with 14 digits (0-9), the [[zettel identifier|00001006050000]]. @@ -46,24 +47,24 @@ The solution is a ''.meta'' file with the same zettel identifier. Zettelstore recognizes this situation and reads in both files for the one zettel containing the figure. It maintains this relationship as long as theses files exists. In case of some textual zettel content you do not want to store the metadata and the zettel content in two different files. -Here the ''.zettel'' extension will signal that the metadata and the zettel content will be placed in the same file, separated by an empty line or a line with three dashes (""''-\-\-''"", also known as ""YAML separator""). +Here the ''.zettel'' extension will signal that the metadata and the zettel content will be put in the same file, separated by an empty line or a line with three dashes (""''-\-\-''"", also known as ""YAML separator""). === Predefined zettel Zettelstore contains some [[predefined zettel|00001005090000]] to work properly. The [[configuration zettel|00001004020000]] is one example. To render the builtin web interface, some templates are used, as well as a layout specification in CSS. -The icon that visualizes an external link is a predefined SVG image. +The icon that visualizes a broken image is a predefined GIF image. All of these are visible to the Zettelstore as zettel. One reason for this is to allow you to modify these zettel to adapt Zettelstore to your needs and visual preferences. Where are these zettel stored? -They are stored within the Zettelstore software itself, because one design goal was to have just one file to use Zettelstore. +They are stored within the Zettelstore software itself, because one design goal was to have just one executable file to use Zettelstore. But data stored within an executable programm cannot be changed later[^Well, it can, but it is a very bad idea to allow this. Mostly for security reasons.]. To allow changing predefined zettel, both the file store and the internal zettel store are internally chained together. If you change a zettel, it will be always stored as a file. If a zettel is requested, Zettelstore will first try to read that zettel from a file. @@ -72,5 +73,17 @@ Therefore, the file store ""shadows"" the internal zettel store. If you want to read the original zettel, you either have to delete the zettel (which removes it from the file directory), or you have to rename it to another zettel identifier. Now we have two places where zettel are stored: in the specific directory and within the Zettelstore software. * [[List of predefined zettel|00001005090000]] + +=== Boxes: other ways to store zettel +As described above, a zettel may be stored as a file inside a directory or inside the Zettelstore software itself. +Zettelstore allows other ways to store zettel by providing an abstraction called //box//.[^Formerly, zettel were stored physically in boxes, often made of wood.] + +A file directory which stores zettel is called a ""directory box"". +But zettel may be also stored in a ZIP file, which is called ""file box"". +For testing purposes, zettel may be stored in volatile memeory (called //RAM//). +This way is called ""memory box"". + +Other types of boxes could be added to Zettelstore. +What about a ""remote Zettelstore box""? Index: docs/manual/00001005090000.zettel ================================================================== --- docs/manual/00001005090000.zettel +++ docs/manual/00001005090000.zettel @@ -1,11 +1,11 @@ id: 00001005090000 title: List of predefined zettel role: manual tags: #manual #reference #zettelstore syntax: zmk -modified: 20210511180816 +modified: 20210622124647 The following table lists all predefined zettel with their purpose. |= Identifier :|= Title | Purpose | [[00000000000001]] | Zettelstore Version | Contains the version string of the running Zettelstore @@ -12,11 +12,11 @@ | [[00000000000002]] | Zettelstore Host | Contains the name of the computer running the Zettelstore | [[00000000000003]] | Zettelstore Operating System | Contains the operating system and CPU architecture of the computer running the Zettelstore | [[00000000000004]] | Zettelstore License | Lists the license of Zettelstore | [[00000000000005]] | Zettelstore Contributors | Lists all contributors of Zettelstore | [[00000000000006]] | Zettelstore Dependencies | Lists all licensed content -| [[00000000000020]] | Zettelstore Place Manager | Contains some statistics about zettel places and the the index process +| [[00000000000020]] | Zettelstore Box Manager | Contains some statistics about zettel boxes and the the index process | [[00000000000090]] | Zettelstore Supported Metadata Keys | Contains all supported metadata keys, their [[types|00001006030000]], and more | [[00000000000096]] | Zettelstore Startup Configuration | Contains the effective values of the [[startup configuration|00001004010000]] | [[00000000000100]] | Zettelstore Runtime Configuration | Allows to [[configure Zettelstore at runtime|00001004020000]] | [[00000000010100]] | Zettelstore Base HTML Template | Contains the general layout of the HTML view | [[00000000010200]] | Zettelstore Login Form HTML Template | Layout of the login form, when authentication is [[enabled|00001010040100]] @@ -26,15 +26,16 @@ | [[00000000010403]] | Zettelstore Form HTML Template | Form that is used to create a new or to change an existing zettel that contains text | [[00000000010404]] | Zettelstore Rename Form HTML Template | View that is displayed to change the [[zettel identifier|00001006050000]] | [[00000000010405]] | Zettelstore Delete HTML Template | View to confirm the deletion of a zettel | [[00000000010500]] | Zettelstore List Roles HTML Template | Layout for listing all roles | [[00000000010600]] | Zettelstore List Tags HTML Template | Layout of tags lists -| [[00000000020001]] | Zettelstore Base CSS | CSS file that is included by the [[Base HTML Template|00000000010100]] +| [[00000000020001]] | Zettelstore Base CSS | System-defined CSS file that is included by the [[Base HTML Template|00000000010100]] +| [[00000000025001]] | Zettelstore User CSS | User-defined CSS file that is included by the [[Base HTML Template|00000000010100]] | [[00000000040001]] | Generic Emoji | Image that is shown if original image reference is invalid | [[00000000090000]] | New Menu | Contains items that should contain in the zettel template menu | [[00000000090001]] | New Zettel | Template for a new zettel with role ""[[zettel|00001006020100]]"" | [[00000000090002]] | New User | Template for a new zettel with role ""[[user|00001006020100#user]]"" | [[00010000000000]] | Home | Default home zettel, contains some welcome information If a zettel is not linked, it is not accessible for the current user. **Important:** All identifier may change until a stable version of the software is released. Index: docs/manual/00001006020000.zettel ================================================================== --- docs/manual/00001006020000.zettel +++ docs/manual/00001006020000.zettel @@ -1,10 +1,11 @@ id: 00001006020000 title: Supported Metadata Keys role: manual tags: #manual #meta #reference #zettel #zettelstore syntax: zmk +modified: 20210709162756 Although you are free to define your own metadata, by using any key (according to the [[syntax|00001006010000]]), some keys have a special meaning that is enforced by Zettelstore. See the [[computed list of supported metadata keys|00000000000090]] for details. Most keys conform to a [[type|00001006030000]]. @@ -46,20 +47,23 @@ This is a computed value. There is no need to set it via Zettelstore. ; [!no-index]''no-index'' : If set to true, the zettel will not be indexed and therefore not be found in full-text searches. +; [!box-number]''box-number'' +: Is a computed value and contains the number of the box where the zettel was found. + For all but the [[predefined zettel|00001005090000]], this number is equal to the number //X// specified in startup configuration key [[''box-uri-//X//''|00001004010000#box-uri-x]]. ; [!precursor]''precursor'' : References zettel for which this zettel is a ""Folgezettel"" / follow-up zettel. Basically the inverse of key [[''folge''|#folge]]. ; [!published]''published'' : This property contains the timestamp of the mast modification / creation of the zettel. - If [[''modified''|#modified]]is set, it contains the same value. + If [[''modified''|#modified]] is set, it contains the same value. Otherwise, if the zettel identifier contains a valid timestamp, the identifier is used. In all other cases, this property is not set. - It can be used for [[sorting|00001012051800#sort]] zettel based on their publication date. + It can be used for [[sorting|00001012052000]] zettel based on their publication date. It is a computed value. There is no need to set it via Zettelstore. ; [!read-only]''read-only'' : Marks a zettel as read-only. Index: docs/manual/00001006020400.zettel ================================================================== --- docs/manual/00001006020400.zettel +++ docs/manual/00001006020400.zettel @@ -14,11 +14,11 @@ If there is no metadata value for key ''read-only'' or if its [[boolean value|00001006030500]] is interpreted as ""false"", anybody can modify the zettel. If the metadata value is something else (the value ""true"" is recommended), the user cannot modify the zettel through the web interface. -However, if the zettel is stored as a file in a [[directory place|00001004011400]], +However, if the zettel is stored as a file in a [[directory box|00001004011400]], the zettel could be modified using an external editor. === Authentication enabled If there is no metadata value for key ''read-only'' or if its [[boolean value|00001006030500]] is interpreted as ""false"", anybody can modify the zettel. @@ -33,8 +33,8 @@ : Neither an unauthenticated user, nor users with roles ""reader"" or ""writer"" are allowed to modify the zettel. Only the owner of the Zettelstore can modify the zettel. If the metadata value is something else (one of the values ""true"" or ""owner"" is recommended), no user is allowed modify the zettel through the web interface. -However, if the zettel is accessible as a file in a [[directory place|00001004011400]], +However, if the zettel is accessible as a file in a [[directory box|00001004011400]], the zettel could be modified using an external editor. Typically the owner of a Zettelstore have such an access. Index: docs/manual/00001006030000.zettel ================================================================== --- docs/manual/00001006030000.zettel +++ docs/manual/00001006030000.zettel @@ -1,15 +1,21 @@ id: 00001006030000 title: Supported Key Types role: manual tags: #manual #meta #reference #zettel #zettelstore syntax: zmk +modified: 20210627170437 -Most [[supported metadata keys|00001006020000]] conform to a type. +All [[supported metadata keys|00001006020000]] conform to a type. -Every metadata key should conform to a type. -User-defined metadata keys are of type EString. +User-defined metadata keys conform also to a type, based on the suffix of the key. +|=Suffix|Type +| ''-number'' | [[Number|00001006033000]] +| ''-url'' | [[URL|00001006035000]] +| ''-zid'' | [[Identifier|00001006032000]] +| any other suffix | [[EString|00001006031500]] + The name of the metadata key is bound to the key type Every key type has an associated validation rule to check values of the given type. There is also a rule how values are matched, e.g. against a search term when selecting some zettel. And there is a rule, how values compare for sorting. Index: docs/manual/00001006050000.zettel ================================================================== --- docs/manual/00001006050000.zettel +++ docs/manual/00001006050000.zettel @@ -1,10 +1,11 @@ id: 00001006050000 title: Zettel identifier +role: manual tags: #design #manual #zettelstore syntax: zmk -role: manual +modified: 20210721123222 Each zettel is given a unique identifier. To some degree, the zettel identifier is part of the metadata. Basically, the identifier is given by the [[Zettelstore|00001005000000]] software. @@ -17,11 +18,12 @@ In most cases the zettel identifier is the timestamp when the zettel was created. However, the Zettelstore software just checks for exactly 14 digits. Anybody is free to assign a ""non-timestamp"" identifier to a zettel, e.g. with a month part of ""35"" or with ""99"" as the last two digits. -In fact, all identifiers of zettel initially provided by an empty Zettelstore -begin with ""000000"", except the home zettel ''00010000000000''. + +Some zettel identifier are [[reserved|00001006055000]] and should not be used otherwise. +All identifiers of zettel initially provided by an empty Zettelstore begin with ""000000"", except the home zettel ''00010000000000''. Zettel identifier of this manual have be chosen to begin with ""000010"". A zettel can have any identifier that contains 14 digits and that is not in use by another zettel managed by the same Zettelstore. ADDED docs/manual/00001006055000.zettel Index: docs/manual/00001006055000.zettel ================================================================== --- docs/manual/00001006055000.zettel +++ docs/manual/00001006055000.zettel @@ -0,0 +1,43 @@ +id: 00001006055000 +title: Reserved zettel identifier +role: manual +tags: #design #manual #zettelstore +syntax: zmk +modified: 20210721125518 + +[[Zettel identifier|00001006050000]] are typically created by examine the current date and time. +By renaming a zettel, you are able to provide any sequence of 14 digits. +If no other zettel has the same identifier, you are allowed to rename a zettel. + +To make things easier, you normally should not use zettel identifier that begin with four zeroes (''0000''). + +All zettel provided by an empty zettelstore begin with six zeroes[^Exception: the predefined home zettel ''00010000000000''. But you can [[configure|00001004020000#home-zettel]] another zettel with another identifier as the new home zettel.]. +Zettel identifier of this manual have be chosen to begin with ''000010''. + +However, some external applications may need a range of specific zettel identifier to work properly. +Identifier that begin with ''00009'' can be used for such purpose. +To request a reservation, please send an email to the maintainer of Zettelstore. +The request must include the following data: +; Title +: Title of you application +; Description +: A brief description what the application is used for and why you need to reserve some zettel identifier +; Number +: Specify the amount of zettel identifier you are planning to use. + Minimum size is 100. + If you need more than 10.000, your justification will contain more words. + +=== Reserved Zettel Identifier + +|= From | To | Description +| 00000000000000 | 0000000000000 | This is an invalid zettel identifier +| 00000000000001 | 0000009999999 | [[Predefined zettel|00001005090000]] +| 00000100000000 | 0000019999999 | Zettelstore manual +| 00000200000000 | 0000899999999 | Reserved for future use +| 00009000000000 | 0000999999999 | Reserved for applications + +This list may change in the future. + +==== External Applications +|= From | To | Description +| 00009000001000 | 00009000001000 | ZS Slides, an application to display zettel as a HTML-based slideshow Index: docs/manual/00001007010000.zettel ================================================================== --- docs/manual/00001007010000.zettel +++ docs/manual/00001007010000.zettel @@ -22,28 +22,28 @@ With some exceptions, two identical non-space characters begins a formatting range that is ended with the same two characters. Exceptions are: links, images, edits, comments, and both the ""en-dash"" and the ""horizontal ellipsis"". A link is given with ``[[...]]``{=zmk}, an images with ``{{...}}``{=zmk}, and an edit formatting with ``((...))``{=zmk}. An inline comment, beginning with the sequence ``%%``{=zmk}, always ends at the end of the line where it begins. -The ""en-dash"" (""--"") is specified as ``--``{=zmk}, the ""horizontal ellipsis"" (""..."") as ``...``{=zmk}[^If placed at the end of non-space text.]. +The ""en-dash"" (""--"") is specified as ``--``{=zmk}, the ""horizontal ellipsis"" (""..."") as ``...``{=zmk}[^If put at the end of non-space text.]. Some inline elements do not follow the rule of two identical character, especially to specify footnotes, citation keys, and local marks. These elements begin with one opening square bracket (""``[``""), use a character for specifying the kind of the inline, typically allow to specify some content, and end with one closing square bracket (""``]``""). One inline element that does not begin with two characters is the ""entity"". It allows to specify any Unicode character. -The specification of that character is placed between an ampersand character and a semicolon: ``&...;``{=zmk}. +The specification of that character is put between an ampersand character and a semicolon: ``&...;``{=zmk}. For exmple, an ""n-dash"" could also be specified as ``–``{==zmk}. The backslash character (""``\\``"") possibly gives the next character a special meaning. This allows to resolve some left ambiguities. For example, a list of depth 2 will begin a line with ``** Item 2.2``{=zmk}. An inline element to strongly emphasize some text begin with a space will be specified as ``** Text**``{=zmk}. To force the inline element formatting at the beginning of a line, ``**\\ Text**``{=zmk} should better be specified. Many block and inline elements can be refined by additional attributes. -Attributes resemble roughly HTML attributes and are placed near the corresponding elements by using the syntax ``{...}``{=zmk}. +Attributes resemble roughly HTML attributes and are put near the corresponding elements by using the syntax ``{...}``{=zmk}. One example is to make space characters visible inside a inline literal element: ``1 + 2 = 3``{-} was specified by using the default attribute: ``\`\`1 + 2 = 3\`\`{-}``. To summarize: * With some exceptions, blocks-structural elements begins at the for position of a line with three identical characters. Index: docs/manual/00001007030200.zettel ================================================================== --- docs/manual/00001007030200.zettel +++ docs/manual/00001007030200.zettel @@ -88,11 +88,11 @@ * C ::: Please note that two lists cannot be separated by an empty line. -Instead you should place a horizonal rule (""thematic break"") between them. +Instead you should put a horizonal rule (""thematic break"") between them. You could also use a mark element or a hard line break to separate the two lists: ```zmk # One # Two [!sep] Index: docs/manual/00001007031000.zettel ================================================================== --- docs/manual/00001007031000.zettel +++ docs/manual/00001007031000.zettel @@ -91,17 +91,17 @@ === Rows to be ignored A line that begins with the sequence ''|%'' (vertical bar character (""''|''"", ''U+007C''), followed by a percent sign character (“%”, U+0025)) will be ignored. This allows to specify a horizontal rule that is not rendered. Such tables are emitted by some commands of the [[administrator console|00001004100000]]. -For example, the command ``get-config place`` will emit +For example, the command ``get-config box`` will emit ``` |=Key | Value | Description -|%-----------+--------+----------------------------- -| defdirtype | notify | Default directory place type +|%-----------+--------+--------------------------- +| defdirtype | notify | Default directory box type ``` This is rendered in HTML as: :::example |=Key | Value | Description -|%-----------+--------+----------------------------- -| defdirtype | notify | Default directory place type +|%-----------+--------+--------------------------- +| defdirtype | notify | Default directory box type ::: Index: docs/manual/00001007040000.zettel ================================================================== --- docs/manual/00001007040000.zettel +++ docs/manual/00001007040000.zettel @@ -45,17 +45,17 @@ ==== Entities & more Sometimes it is not easy to enter special characters. If you know the Unicode code point of that character, or its name according to the [[HTML standard|https://html.spec.whatwg.org/multipage/named-characters.html]], you can enter it by number or by name. Regardless which method you use, an entity always begins with an ampersand character (""''&''"", ''U+0026'') and ends with a semicolon character (""'';''"", ''U+003B''). -If you know the HTML name of the character you want to enter, place it between these two character. +If you know the HTML name of the character you want to enter, put it between these two character. Example: ``&`` is rendered as ::&::{=example}. If you want to enter its numeric code point, a number sign character must follow the ampersand character, followed by digits to base 10. Example: ``&`` is rendered in HTML as ::&::{=example}. -You also can enter its numeric code point as a hex number, if you place the letter ""x"" after the numeric sign character. +You also can enter its numeric code point as a hex number, if you put the letter ""x"" after the numeric sign character. Example: ``&`` is rendered in HTML as ::&::{=example}. Since some Unicode character are used quite often, a special notation is introduced for them: * Two consecutive hyphen-minus characters result in an //en-dash// character. Index: docs/manual/00001008000000.zettel ================================================================== --- docs/manual/00001008000000.zettel +++ docs/manual/00001008000000.zettel @@ -1,11 +1,11 @@ id: 00001008000000 title: Other Markup Languages role: manual tags: #manual #zettelstore syntax: zmk -modified: 20210523194915 +modified: 20210705111758 [[Zettelmarkup|00001007000000]] is not the only markup language you can use to define your content. Zettelstore is quite agnostic with respect to markup languages. Of course, Zettelmarkup plays an important role. However, with the exception of zettel titles, you can use any (markup) language that is supported: @@ -23,16 +23,22 @@ ; [!css]''css'' : A [[Cascading Style Sheet|https://www.w3.org/Style/CSS/]], to be used when rendering a zettel as HTML. ; [!gif]''gif''; [!jpeg]''jpeg''; [!jpg]''jpg''; [!png]''png'' : The formats for pixel graphics. Typically the data is stored in a separate file and the syntax is given in the ''.meta'' file. +; [!html]''html'' +: Hypertext Markup Language, will not be parsed further. + Instead, it is treated as [[text|#text]], but will be encoded differently for [[HTML format|00001012920510]] (same for the [[web user interface|00001014000000]]). + + For security reasons, equivocal elements will not be encoded in the HTML format / web user interface, e.g. the ``\nokay\n", "html": "\n

okay

\n", - "example": 140, - "start_line": 2411, - "end_line": 2425, + "example": 170, + "start_line": 2756, + "end_line": 2770, + "section": "HTML blocks" + }, + { + "markdown": "\n", + "html": "\n", + "example": 171, + "start_line": 2775, + "end_line": 2791, "section": "HTML blocks" }, { "markdown": "\nh1 {color:red;}\n\np {color:blue;}\n\nokay\n", "html": "\nh1 {color:red;}\n\np {color:blue;}\n\n

okay

\n", - "example": 141, - "start_line": 2430, - "end_line": 2446, + "example": 172, + "start_line": 2795, + "end_line": 2811, "section": "HTML blocks" }, { "markdown": "\n\nfoo\n", "html": "\n\nfoo\n", - "example": 142, - "start_line": 2453, - "end_line": 2463, + "example": 173, + "start_line": 2818, + "end_line": 2828, "section": "HTML blocks" }, { "markdown": ">
\n> foo\n\nbar\n", "html": "
\n
\nfoo\n
\n

bar

\n", - "example": 143, - "start_line": 2466, - "end_line": 2477, + "example": 174, + "start_line": 2831, + "end_line": 2842, "section": "HTML blocks" }, { "markdown": "-
\n- foo\n", "html": "
    \n
  • \n
    \n
    • \n
  • foo
    • \n
\n", - "example": 144, - "start_line": 2480, - "end_line": 2490, + "example": 175, + "start_line": 2845, + "end_line": 2855, "section": "HTML blocks" }, { "markdown": "\n*foo*\n", "html": "\n

foo

\n", - "example": 145, - "start_line": 2495, - "end_line": 2501, + "example": 176, + "start_line": 2860, + "end_line": 2866, "section": "HTML blocks" }, { "markdown": "*bar*\n*baz*\n", "html": "*bar*\n

baz

\n", - "example": 146, - "start_line": 2504, - "end_line": 2510, + "example": 177, + "start_line": 2869, + "end_line": 2875, "section": "HTML blocks" }, { "markdown": "1. *bar*\n", "html": "1. *bar*\n", - "example": 147, - "start_line": 2516, - "end_line": 2524, + "example": 178, + "start_line": 2881, + "end_line": 2889, "section": "HTML blocks" }, { "markdown": "\nokay\n", "html": "\n

okay

\n", - "example": 148, - "start_line": 2529, - "end_line": 2541, + "example": 179, + "start_line": 2894, + "end_line": 2906, "section": "HTML blocks" }, { "markdown": "';\n\n?>\nokay\n", "html": "';\n\n?>\n

okay

\n", - "example": 149, - "start_line": 2547, - "end_line": 2561, + "example": 180, + "start_line": 2912, + "end_line": 2926, "section": "HTML blocks" }, { "markdown": "\n", "html": "\n", - "example": 150, - "start_line": 2566, - "end_line": 2570, + "example": 181, + "start_line": 2931, + "end_line": 2935, "section": "HTML blocks" }, { "markdown": "\nokay\n", "html": "\n

okay

\n", - "example": 151, - "start_line": 2575, - "end_line": 2603, + "example": 182, + "start_line": 2940, + "end_line": 2968, "section": "HTML blocks" }, { "markdown": " \n\n \n", "html": " \n
<!-- foo -->\n
\n", - "example": 152, - "start_line": 2608, - "end_line": 2616, + "example": 183, + "start_line": 2974, + "end_line": 2982, "section": "HTML blocks" }, { "markdown": "
\n\n
\n", "html": "
\n
<div>\n
\n", - "example": 153, - "start_line": 2619, - "end_line": 2627, + "example": 184, + "start_line": 2985, + "end_line": 2993, "section": "HTML blocks" }, { "markdown": "Foo\n
\nbar\n
\n", "html": "

Foo

\n
\nbar\n
\n", - "example": 154, - "start_line": 2633, - "end_line": 2643, + "example": 185, + "start_line": 2999, + "end_line": 3009, "section": "HTML blocks" }, { "markdown": "
\nbar\n
\n*foo*\n", "html": "
\nbar\n
\n*foo*\n", - "example": 155, - "start_line": 2650, - "end_line": 2660, + "example": 186, + "start_line": 3016, + "end_line": 3026, "section": "HTML blocks" }, { "markdown": "Foo\n\nbaz\n", "html": "

Foo\n\nbaz

\n", - "example": 156, - "start_line": 2665, - "end_line": 2673, + "example": 187, + "start_line": 3031, + "end_line": 3039, "section": "HTML blocks" }, { "markdown": "
\n\n*Emphasized* text.\n\n
\n", "html": "
\n

Emphasized text.

\n
\n", - "example": 157, - "start_line": 2706, - "end_line": 2716, + "example": 188, + "start_line": 3072, + "end_line": 3082, "section": "HTML blocks" }, { "markdown": "
\n*Emphasized* text.\n
\n", "html": "
\n*Emphasized* text.\n
\n", - "example": 158, - "start_line": 2719, - "end_line": 2727, + "example": 189, + "start_line": 3085, + "end_line": 3093, "section": "HTML blocks" }, { "markdown": "\n\n\n\n\n\n\n\n
\nHi\n
\n", "html": "\n\n\n\n
\nHi\n
\n", - "example": 159, - "start_line": 2741, - "end_line": 2761, + "example": 190, + "start_line": 3107, + "end_line": 3127, "section": "HTML blocks" }, { "markdown": "\n\n \n\n \n\n \n\n
\n Hi\n
\n", "html": "\n \n
<td>\n  Hi\n</td>\n
\n \n
\n", - "example": 160, - "start_line": 2768, - "end_line": 2789, + "example": 191, + "start_line": 3134, + "end_line": 3155, "section": "HTML blocks" }, { "markdown": "[foo]: /url \"title\"\n\n[foo]\n", "html": "

foo

\n", - "example": 161, - "start_line": 2816, - "end_line": 2822, + "example": 192, + "start_line": 3183, + "end_line": 3189, "section": "Link reference definitions" }, { "markdown": " [foo]: \n /url \n 'the title' \n\n[foo]\n", "html": "

foo

\n", - "example": 162, - "start_line": 2825, - "end_line": 2833, + "example": 193, + "start_line": 3192, + "end_line": 3200, "section": "Link reference definitions" }, { "markdown": "[Foo*bar\\]]:my_(url) 'title (with parens)'\n\n[Foo*bar\\]]\n", "html": "

Foo*bar]

\n", - "example": 163, - "start_line": 2836, - "end_line": 2842, + "example": 194, + "start_line": 3203, + "end_line": 3209, "section": "Link reference definitions" }, { "markdown": "[Foo bar]:\n\n'title'\n\n[Foo bar]\n", "html": "

Foo bar

\n", - "example": 164, - "start_line": 2845, - "end_line": 2853, + "example": 195, + "start_line": 3212, + "end_line": 3220, "section": "Link reference definitions" }, { "markdown": "[foo]: /url '\ntitle\nline1\nline2\n'\n\n[foo]\n", "html": "

foo

\n", - "example": 165, - "start_line": 2858, - "end_line": 2872, + "example": 196, + "start_line": 3225, + "end_line": 3239, "section": "Link reference definitions" }, { "markdown": "[foo]: /url 'title\n\nwith blank line'\n\n[foo]\n", "html": "

[foo]: /url 'title

\n

with blank line'

\n

[foo]

\n", - "example": 166, - "start_line": 2877, - "end_line": 2887, + "example": 197, + "start_line": 3244, + "end_line": 3254, "section": "Link reference definitions" }, { "markdown": "[foo]:\n/url\n\n[foo]\n", "html": "

foo

\n", - "example": 167, - "start_line": 2892, - "end_line": 2899, + "example": 198, + "start_line": 3259, + "end_line": 3266, "section": "Link reference definitions" }, { "markdown": "[foo]:\n\n[foo]\n", "html": "

[foo]:

\n

[foo]

\n", - "example": 168, - "start_line": 2904, - "end_line": 2911, + "example": 199, + "start_line": 3271, + "end_line": 3278, "section": "Link reference definitions" }, { "markdown": "[foo]: <>\n\n[foo]\n", "html": "

foo

\n", - "example": 169, - "start_line": 2916, - "end_line": 2922, + "example": 200, + "start_line": 3283, + "end_line": 3289, "section": "Link reference definitions" }, { "markdown": "[foo]: (baz)\n\n[foo]\n", "html": "

[foo]: (baz)

\n

[foo]

\n", - "example": 170, - "start_line": 2927, - "end_line": 2934, + "example": 201, + "start_line": 3294, + "end_line": 3301, "section": "Link reference definitions" }, { "markdown": "[foo]: /url\\bar\\*baz \"foo\\\"bar\\baz\"\n\n[foo]\n", "html": "

foo

\n", - "example": 171, - "start_line": 2940, - "end_line": 2946, + "example": 202, + "start_line": 3307, + "end_line": 3313, "section": "Link reference definitions" }, { "markdown": "[foo]\n\n[foo]: url\n", "html": "

foo

\n", - "example": 172, - "start_line": 2951, - "end_line": 2957, + "example": 203, + "start_line": 3318, + "end_line": 3324, "section": "Link reference definitions" }, { "markdown": "[foo]\n\n[foo]: first\n[foo]: second\n", "html": "

foo

\n", - "example": 173, - "start_line": 2963, - "end_line": 2970, + "example": 204, + "start_line": 3330, + "end_line": 3337, "section": "Link reference definitions" }, { "markdown": "[FOO]: /url\n\n[Foo]\n", "html": "

Foo

\n", - "example": 174, - "start_line": 2976, - "end_line": 2982, + "example": 205, + "start_line": 3343, + "end_line": 3349, "section": "Link reference definitions" }, { "markdown": "[ΑΓΩ]: /φου\n\n[αγω]\n", "html": "

αγω

\n", - "example": 175, - "start_line": 2985, - "end_line": 2991, + "example": 206, + "start_line": 3352, + "end_line": 3358, "section": "Link reference definitions" }, { "markdown": "[foo]: /url\n", "html": "", - "example": 176, - "start_line": 2997, - "end_line": 3000, + "example": 207, + "start_line": 3367, + "end_line": 3370, "section": "Link reference definitions" }, { "markdown": "[\nfoo\n]: /url\nbar\n", "html": "

bar

\n", - "example": 177, - "start_line": 3005, - "end_line": 3012, + "example": 208, + "start_line": 3375, + "end_line": 3382, "section": "Link reference definitions" }, { "markdown": "[foo]: /url \"title\" ok\n", "html": "

[foo]: /url "title" ok

\n", - "example": 178, - "start_line": 3018, - "end_line": 3022, + "example": 209, + "start_line": 3388, + "end_line": 3392, "section": "Link reference definitions" }, { "markdown": "[foo]: /url\n\"title\" ok\n", "html": "

"title" ok

\n", - "example": 179, - "start_line": 3027, - "end_line": 3032, + "example": 210, + "start_line": 3397, + "end_line": 3402, "section": "Link reference definitions" }, { "markdown": " [foo]: /url \"title\"\n\n[foo]\n", "html": "
[foo]: /url "title"\n
\n

[foo]

\n", - "example": 180, - "start_line": 3038, - "end_line": 3046, + "example": 211, + "start_line": 3408, + "end_line": 3416, "section": "Link reference definitions" }, { "markdown": "```\n[foo]: /url\n```\n\n[foo]\n", "html": "
[foo]: /url\n
\n

[foo]

\n", - "example": 181, - "start_line": 3052, - "end_line": 3062, + "example": 212, + "start_line": 3422, + "end_line": 3432, "section": "Link reference definitions" }, { "markdown": "Foo\n[bar]: /baz\n\n[bar]\n", "html": "

Foo\n[bar]: /baz

\n

[bar]

\n", - "example": 182, - "start_line": 3067, - "end_line": 3076, + "example": 213, + "start_line": 3437, + "end_line": 3446, "section": "Link reference definitions" }, { "markdown": "# [Foo]\n[foo]: /url\n> bar\n", "html": "

Foo

\n
\n

bar

\n
\n", - "example": 183, - "start_line": 3082, - "end_line": 3091, + "example": 214, + "start_line": 3452, + "end_line": 3461, "section": "Link reference definitions" }, { "markdown": "[foo]: /url\nbar\n===\n[foo]\n", "html": "

bar

\n

foo

\n", - "example": 184, - "start_line": 3093, - "end_line": 3101, + "example": 215, + "start_line": 3463, + "end_line": 3471, "section": "Link reference definitions" }, { "markdown": "[foo]: /url\n===\n[foo]\n", "html": "

===\nfoo

\n", - "example": 185, - "start_line": 3103, - "end_line": 3110, + "example": 216, + "start_line": 3473, + "end_line": 3480, "section": "Link reference definitions" }, { "markdown": "[foo]: /foo-url \"foo\"\n[bar]: /bar-url\n \"bar\"\n[baz]: /baz-url\n\n[foo],\n[bar],\n[baz]\n", "html": "

foo,\nbar,\nbaz

\n", - "example": 186, - "start_line": 3116, - "end_line": 3129, + "example": 217, + "start_line": 3486, + "end_line": 3499, "section": "Link reference definitions" }, { "markdown": "[foo]\n\n> [foo]: /url\n", "html": "

foo

\n
\n
\n", - "example": 187, - "start_line": 3137, - "end_line": 3145, - "section": "Link reference definitions" - }, - { - "markdown": "[foo]: /url\n", - "html": "", - "example": 188, - "start_line": 3154, - "end_line": 3157, + "example": 218, + "start_line": 3507, + "end_line": 3515, "section": "Link reference definitions" }, { "markdown": "aaa\n\nbbb\n", "html": "

aaa

\n

bbb

\n", - "example": 189, - "start_line": 3171, - "end_line": 3178, + "example": 219, + "start_line": 3529, + "end_line": 3536, "section": "Paragraphs" }, { "markdown": "aaa\nbbb\n\nccc\nddd\n", "html": "

aaa\nbbb

\n

ccc\nddd

\n", - "example": 190, - "start_line": 3183, - "end_line": 3194, + "example": 220, + "start_line": 3541, + "end_line": 3552, "section": "Paragraphs" }, { "markdown": "aaa\n\n\nbbb\n", "html": "

aaa

\n

bbb

\n", - "example": 191, - "start_line": 3199, - "end_line": 3207, + "example": 221, + "start_line": 3557, + "end_line": 3565, "section": "Paragraphs" }, { "markdown": " aaa\n bbb\n", "html": "

aaa\nbbb

\n", - "example": 192, - "start_line": 3212, - "end_line": 3218, + "example": 222, + "start_line": 3570, + "end_line": 3576, "section": "Paragraphs" }, { "markdown": "aaa\n bbb\n ccc\n", "html": "

aaa\nbbb\nccc

\n", - "example": 193, - "start_line": 3224, - "end_line": 3232, + "example": 223, + "start_line": 3582, + "end_line": 3590, "section": "Paragraphs" }, { "markdown": " aaa\nbbb\n", "html": "

aaa\nbbb

\n", - "example": 194, - "start_line": 3238, - "end_line": 3244, + "example": 224, + "start_line": 3596, + "end_line": 3602, "section": "Paragraphs" }, { "markdown": " aaa\nbbb\n", "html": "
aaa\n
\n

bbb

\n", - "example": 195, - "start_line": 3247, - "end_line": 3254, + "example": 225, + "start_line": 3605, + "end_line": 3612, "section": "Paragraphs" }, { "markdown": "aaa \nbbb \n", "html": "

aaa
\nbbb

\n", - "example": 196, - "start_line": 3261, - "end_line": 3267, + "example": 226, + "start_line": 3619, + "end_line": 3625, "section": "Paragraphs" }, { "markdown": " \n\naaa\n \n\n# aaa\n\n \n", "html": "

aaa

\n

aaa

\n", - "example": 197, - "start_line": 3278, - "end_line": 3290, + "example": 227, + "start_line": 3636, + "end_line": 3648, "section": "Blank lines" }, { "markdown": "> # Foo\n> bar\n> baz\n", "html": "
\n

Foo

\n

bar\nbaz

\n
\n", - "example": 198, - "start_line": 3344, - "end_line": 3354, + "example": 228, + "start_line": 3704, + "end_line": 3714, "section": "Block quotes" }, { "markdown": "># Foo\n>bar\n> baz\n", "html": "
\n

Foo

\n

bar\nbaz

\n
\n", - "example": 199, - "start_line": 3359, - "end_line": 3369, + "example": 229, + "start_line": 3719, + "end_line": 3729, "section": "Block quotes" }, { "markdown": " > # Foo\n > bar\n > baz\n", "html": "
\n

Foo

\n

bar\nbaz

\n
\n", - "example": 200, - "start_line": 3374, - "end_line": 3384, + "example": 230, + "start_line": 3734, + "end_line": 3744, "section": "Block quotes" }, { "markdown": " > # Foo\n > bar\n > baz\n", "html": "
> # Foo\n> bar\n> baz\n
\n", - "example": 201, - "start_line": 3389, - "end_line": 3398, + "example": 231, + "start_line": 3749, + "end_line": 3758, "section": "Block quotes" }, { "markdown": "> # Foo\n> bar\nbaz\n", "html": "
\n

Foo

\n

bar\nbaz

\n
\n", - "example": 202, - "start_line": 3404, - "end_line": 3414, + "example": 232, + "start_line": 3764, + "end_line": 3774, "section": "Block quotes" }, { "markdown": "> bar\nbaz\n> foo\n", "html": "
\n

bar\nbaz\nfoo

\n
\n", - "example": 203, - "start_line": 3420, - "end_line": 3430, + "example": 233, + "start_line": 3780, + "end_line": 3790, "section": "Block quotes" }, { "markdown": "> foo\n---\n", "html": "
\n

foo

\n
\n
\n", - "example": 204, - "start_line": 3444, - "end_line": 3452, + "example": 234, + "start_line": 3804, + "end_line": 3812, "section": "Block quotes" }, { "markdown": "> - foo\n- bar\n", "html": "
\n
    \n
  • foo
    • \n
\n
\n
    \n
  • bar
    • \n
\n", - "example": 205, - "start_line": 3464, - "end_line": 3476, + "example": 235, + "start_line": 3824, + "end_line": 3836, "section": "Block quotes" }, { "markdown": "> foo\n bar\n", "html": "
\n
foo\n
\n
\n
bar\n
\n", - "example": 206, - "start_line": 3482, - "end_line": 3492, + "example": 236, + "start_line": 3842, + "end_line": 3852, "section": "Block quotes" }, { "markdown": "> ```\nfoo\n```\n", "html": "
\n
\n
\n

foo

\n
\n", - "example": 207, - "start_line": 3495, - "end_line": 3505, + "example": 237, + "start_line": 3855, + "end_line": 3865, "section": "Block quotes" }, { "markdown": "> foo\n - bar\n", "html": "
\n

foo\n- bar

\n
\n", - "example": 208, - "start_line": 3511, - "end_line": 3519, + "example": 238, + "start_line": 3871, + "end_line": 3879, "section": "Block quotes" }, { "markdown": ">\n", "html": "
\n
\n", - "example": 209, - "start_line": 3535, - "end_line": 3540, + "example": 239, + "start_line": 3895, + "end_line": 3900, "section": "Block quotes" }, { "markdown": ">\n> \n> \n", "html": "
\n
\n", - "example": 210, - "start_line": 3543, - "end_line": 3550, + "example": 240, + "start_line": 3903, + "end_line": 3910, "section": "Block quotes" }, { "markdown": ">\n> foo\n> \n", "html": "
\n

foo

\n
\n", - "example": 211, - "start_line": 3555, - "end_line": 3563, + "example": 241, + "start_line": 3915, + "end_line": 3923, "section": "Block quotes" }, { "markdown": "> foo\n\n> bar\n", "html": "
\n

foo

\n
\n
\n

bar

\n
\n", - "example": 212, - "start_line": 3568, - "end_line": 3579, + "example": 242, + "start_line": 3928, + "end_line": 3939, "section": "Block quotes" }, { "markdown": "> foo\n> bar\n", "html": "
\n

foo\nbar

\n
\n", - "example": 213, - "start_line": 3590, - "end_line": 3598, + "example": 243, + "start_line": 3950, + "end_line": 3958, "section": "Block quotes" }, { "markdown": "> foo\n>\n> bar\n", "html": "
\n

foo

\n

bar

\n
\n", - "example": 214, - "start_line": 3603, - "end_line": 3612, + "example": 244, + "start_line": 3963, + "end_line": 3972, "section": "Block quotes" }, { "markdown": "foo\n> bar\n", "html": "

foo

\n
\n

bar

\n
\n", - "example": 215, - "start_line": 3617, - "end_line": 3625, + "example": 245, + "start_line": 3977, + "end_line": 3985, "section": "Block quotes" }, { "markdown": "> aaa\n***\n> bbb\n", "html": "
\n

aaa

\n
\n
\n
\n

bbb

\n
\n", - "example": 216, - "start_line": 3631, - "end_line": 3643, + "example": 246, + "start_line": 3991, + "end_line": 4003, "section": "Block quotes" }, { "markdown": "> bar\nbaz\n", "html": "
\n

bar\nbaz

\n
\n", - "example": 217, - "start_line": 3649, - "end_line": 3657, + "example": 247, + "start_line": 4009, + "end_line": 4017, "section": "Block quotes" }, { "markdown": "> bar\n\nbaz\n", "html": "
\n

bar

\n
\n

baz

\n", - "example": 218, - "start_line": 3660, - "end_line": 3669, + "example": 248, + "start_line": 4020, + "end_line": 4029, "section": "Block quotes" }, { "markdown": "> bar\n>\nbaz\n", "html": "
\n

bar

\n
\n

baz

\n", - "example": 219, - "start_line": 3672, - "end_line": 3681, + "example": 249, + "start_line": 4032, + "end_line": 4041, "section": "Block quotes" }, { "markdown": "> > > foo\nbar\n", "html": "
\n
\n
\n

foo\nbar

\n
\n
\n
\n", - "example": 220, - "start_line": 3688, - "end_line": 3700, + "example": 250, + "start_line": 4048, + "end_line": 4060, "section": "Block quotes" }, { "markdown": ">>> foo\n> bar\n>>baz\n", "html": "
\n
\n
\n

foo\nbar\nbaz

\n
\n
\n
\n", - "example": 221, - "start_line": 3703, - "end_line": 3717, + "example": 251, + "start_line": 4063, + "end_line": 4077, "section": "Block quotes" }, { "markdown": "> code\n\n> not code\n", "html": "
\n
code\n
\n
\n
\n

not code

\n
\n", - "example": 222, - "start_line": 3725, - "end_line": 3737, + "example": 252, + "start_line": 4085, + "end_line": 4097, "section": "Block quotes" }, { "markdown": "A paragraph\nwith two lines.\n\n indented code\n\n> A block quote.\n", "html": "

A paragraph\nwith two lines.

\n
indented code\n
\n
\n

A block quote.

\n
\n", - "example": 223, - "start_line": 3779, - "end_line": 3794, + "example": 253, + "start_line": 4139, + "end_line": 4154, "section": "List items" }, { "markdown": "1. A paragraph\n with two lines.\n\n indented code\n\n > A block quote.\n", "html": "
    \n
  1. \n

    A paragraph\nwith two lines.

    \n
    indented code\n
    \n
    \n

    A block quote.

    \n
    \n
    2. \n
\n", - "example": 224, - "start_line": 3801, - "end_line": 3820, + "example": 254, + "start_line": 4161, + "end_line": 4180, "section": "List items" }, { "markdown": "- one\n\n two\n", "html": "
    \n
  • one
    • \n
\n

two

\n", - "example": 225, - "start_line": 3834, - "end_line": 3843, + "example": 255, + "start_line": 4194, + "end_line": 4203, "section": "List items" }, { "markdown": "- one\n\n two\n", "html": "
    \n
  • \n

    one

    \n

    two

    \n
    • \n
\n", - "example": 226, - "start_line": 3846, - "end_line": 3857, + "example": 256, + "start_line": 4206, + "end_line": 4217, "section": "List items" }, { "markdown": " - one\n\n two\n", "html": "
    \n
  • one
    • \n
\n
 two\n
\n", - "example": 227, - "start_line": 3860, - "end_line": 3870, + "example": 257, + "start_line": 4220, + "end_line": 4230, "section": "List items" }, { "markdown": " - one\n\n two\n", "html": "
    \n
  • \n

    one

    \n

    two

    \n
    • \n
\n", - "example": 228, - "start_line": 3873, - "end_line": 3884, + "example": 258, + "start_line": 4233, + "end_line": 4244, "section": "List items" }, { "markdown": " > > 1. one\n>>\n>> two\n", "html": "
\n
\n
    \n
  1. \n

    one

    \n

    two

    \n
    2. \n
\n
\n
\n", - "example": 229, - "start_line": 3895, - "end_line": 3910, + "example": 259, + "start_line": 4255, + "end_line": 4270, "section": "List items" }, { "markdown": ">>- one\n>>\n > > two\n", "html": "
\n
\n
    \n
  • one
    • \n
\n

two

\n
\n
\n", - "example": 230, - "start_line": 3922, - "end_line": 3935, + "example": 260, + "start_line": 4282, + "end_line": 4295, "section": "List items" }, { "markdown": "-one\n\n2.two\n", "html": "

-one

\n

2.two

\n", - "example": 231, - "start_line": 3941, - "end_line": 3948, + "example": 261, + "start_line": 4301, + "end_line": 4308, "section": "List items" }, { "markdown": "- foo\n\n\n bar\n", "html": "
    \n
  • \n

    foo

    \n

    bar

    \n
    • \n
\n", - "example": 232, - "start_line": 3954, - "end_line": 3966, + "example": 262, + "start_line": 4314, + "end_line": 4326, "section": "List items" }, { "markdown": "1. foo\n\n ```\n bar\n ```\n\n baz\n\n > bam\n", "html": "
    \n
  1. \n

    foo

    \n
    bar\n
    \n

    baz

    \n
    \n

    bam

    \n
    \n
    2. \n
\n", - "example": 233, - "start_line": 3971, - "end_line": 3993, + "example": 263, + "start_line": 4331, + "end_line": 4353, "section": "List items" }, { "markdown": "- Foo\n\n bar\n\n\n baz\n", "html": "
    \n
  • \n

    Foo

    \n
    bar\n\n\nbaz\n
    \n
    • \n
\n", - "example": 234, - "start_line": 3999, - "end_line": 4017, + "example": 264, + "start_line": 4359, + "end_line": 4377, "section": "List items" }, { "markdown": "123456789. ok\n", "html": "
    \n
  1. ok
    2. \n
\n", - "example": 235, - "start_line": 4021, - "end_line": 4027, + "example": 265, + "start_line": 4381, + "end_line": 4387, "section": "List items" }, { "markdown": "1234567890. not ok\n", "html": "

1234567890. not ok

\n", - "example": 236, - "start_line": 4030, - "end_line": 4034, + "example": 266, + "start_line": 4390, + "end_line": 4394, "section": "List items" }, { "markdown": "0. ok\n", "html": "
    \n
  1. ok
    2. \n
\n", - "example": 237, - "start_line": 4039, - "end_line": 4045, + "example": 267, + "start_line": 4399, + "end_line": 4405, "section": "List items" }, { "markdown": "003. ok\n", "html": "
    \n
  1. ok
    2. \n
\n", - "example": 238, - "start_line": 4048, - "end_line": 4054, + "example": 268, + "start_line": 4408, + "end_line": 4414, "section": "List items" }, { "markdown": "-1. not ok\n", "html": "

-1. not ok

\n", - "example": 239, - "start_line": 4059, - "end_line": 4063, + "example": 269, + "start_line": 4419, + "end_line": 4423, "section": "List items" }, { "markdown": "- foo\n\n bar\n", "html": "
    \n
  • \n

    foo

    \n
    bar\n
    \n
    • \n
\n", - "example": 240, - "start_line": 4082, - "end_line": 4094, + "example": 270, + "start_line": 4442, + "end_line": 4454, "section": "List items" }, { "markdown": " 10. foo\n\n bar\n", "html": "
    \n
  1. \n

    foo

    \n
    bar\n
    \n
    2. \n
\n", - "example": 241, - "start_line": 4099, - "end_line": 4111, + "example": 271, + "start_line": 4459, + "end_line": 4471, "section": "List items" }, { "markdown": " indented code\n\nparagraph\n\n more code\n", "html": "
indented code\n
\n

paragraph

\n
more code\n
\n", - "example": 242, - "start_line": 4118, - "end_line": 4130, + "example": 272, + "start_line": 4478, + "end_line": 4490, "section": "List items" }, { "markdown": "1. indented code\n\n paragraph\n\n more code\n", "html": "
    \n
  1. \n
    indented code\n
    \n

    paragraph

    \n
    more code\n
    \n
    2. \n
\n", - "example": 243, - "start_line": 4133, - "end_line": 4149, + "example": 273, + "start_line": 4493, + "end_line": 4509, "section": "List items" }, { "markdown": "1. indented code\n\n paragraph\n\n more code\n", "html": "
    \n
  1. \n
     indented code\n
    \n

    paragraph

    \n
    more code\n
    \n
    2. \n
\n", - "example": 244, - "start_line": 4155, - "end_line": 4171, + "example": 274, + "start_line": 4515, + "end_line": 4531, "section": "List items" }, { "markdown": " foo\n\nbar\n", "html": "

foo

\n

bar

\n", - "example": 245, - "start_line": 4182, - "end_line": 4189, + "example": 275, + "start_line": 4542, + "end_line": 4549, "section": "List items" }, { "markdown": "- foo\n\n bar\n", "html": "
    \n
  • foo
    • \n
\n

bar

\n", - "example": 246, - "start_line": 4192, - "end_line": 4201, + "example": 276, + "start_line": 4552, + "end_line": 4561, "section": "List items" }, { "markdown": "- foo\n\n bar\n", "html": "
    \n
  • \n

    foo

    \n

    bar

    \n
    • \n
\n", - "example": 247, - "start_line": 4209, - "end_line": 4220, + "example": 277, + "start_line": 4569, + "end_line": 4580, "section": "List items" }, { "markdown": "-\n foo\n-\n ```\n bar\n ```\n-\n baz\n", "html": "
    \n
  • foo
    • \n
  • \n
    bar\n
    \n
    • \n
  • \n
    baz\n
    \n
    • \n
\n", - "example": 248, - "start_line": 4237, - "end_line": 4258, + "example": 278, + "start_line": 4596, + "end_line": 4617, "section": "List items" }, { "markdown": "- \n foo\n", "html": "
    \n
  • foo
    • \n
\n", - "example": 249, - "start_line": 4263, - "end_line": 4270, + "example": 279, + "start_line": 4622, + "end_line": 4629, "section": "List items" }, { "markdown": "-\n\n foo\n", "html": "
    \n
  • \n
\n

foo

\n", - "example": 250, - "start_line": 4277, - "end_line": 4286, + "example": 280, + "start_line": 4636, + "end_line": 4645, "section": "List items" }, { "markdown": "- foo\n-\n- bar\n", "html": "
    \n
  • foo
    • \n
  • \n
  • bar
    • \n
\n", - "example": 251, - "start_line": 4291, - "end_line": 4301, + "example": 281, + "start_line": 4650, + "end_line": 4660, "section": "List items" }, { "markdown": "- foo\n- \n- bar\n", "html": "
    \n
  • foo
    • \n
  • \n
  • bar
    • \n
\n", - "example": 252, - "start_line": 4306, - "end_line": 4316, + "example": 282, + "start_line": 4665, + "end_line": 4675, "section": "List items" }, { "markdown": "1. foo\n2.\n3. bar\n", "html": "
    \n
  1. foo
    2. \n
  2. \n
  3. bar
    4. \n
\n", - "example": 253, - "start_line": 4321, - "end_line": 4331, + "example": 283, + "start_line": 4680, + "end_line": 4690, "section": "List items" }, { "markdown": "*\n", "html": "
    \n
  • \n
\n", - "example": 254, - "start_line": 4336, - "end_line": 4342, + "example": 284, + "start_line": 4695, + "end_line": 4701, "section": "List items" }, { "markdown": "foo\n*\n\nfoo\n1.\n", "html": "

foo\n*

\n

foo\n1.

\n", - "example": 255, - "start_line": 4346, - "end_line": 4357, + "example": 285, + "start_line": 4705, + "end_line": 4716, "section": "List items" }, { "markdown": " 1. A paragraph\n with two lines.\n\n indented code\n\n > A block quote.\n", "html": "
    \n
  1. \n

    A paragraph\nwith two lines.

    \n
    indented code\n
    \n
    \n

    A block quote.

    \n
    \n
    2. \n
\n", - "example": 256, - "start_line": 4368, - "end_line": 4387, + "example": 286, + "start_line": 4727, + "end_line": 4746, "section": "List items" }, { "markdown": " 1. A paragraph\n with two lines.\n\n indented code\n\n > A block quote.\n", "html": "
    \n
  1. \n

    A paragraph\nwith two lines.

    \n
    indented code\n
    \n
    \n

    A block quote.

    \n
    \n
    2. \n
\n", - "example": 257, - "start_line": 4392, - "end_line": 4411, + "example": 287, + "start_line": 4751, + "end_line": 4770, "section": "List items" }, { "markdown": " 1. A paragraph\n with two lines.\n\n indented code\n\n > A block quote.\n", "html": "
    \n
  1. \n

    A paragraph\nwith two lines.

    \n
    indented code\n
    \n
    \n

    A block quote.

    \n
    \n
    2. \n
\n", - "example": 258, - "start_line": 4416, - "end_line": 4435, + "example": 288, + "start_line": 4775, + "end_line": 4794, "section": "List items" }, { "markdown": " 1. A paragraph\n with two lines.\n\n indented code\n\n > A block quote.\n", "html": "
1.  A paragraph\n    with two lines.\n\n        indented code\n\n    > A block quote.\n
\n", - "example": 259, - "start_line": 4440, - "end_line": 4455, + "example": 289, + "start_line": 4799, + "end_line": 4814, "section": "List items" }, { "markdown": " 1. A paragraph\nwith two lines.\n\n indented code\n\n > A block quote.\n", "html": "
    \n
  1. \n

    A paragraph\nwith two lines.

    \n
    indented code\n
    \n
    \n

    A block quote.

    \n
    \n
    2. \n
\n", - "example": 260, - "start_line": 4470, - "end_line": 4489, + "example": 290, + "start_line": 4829, + "end_line": 4848, "section": "List items" }, { "markdown": " 1. A paragraph\n with two lines.\n", "html": "
    \n
  1. A paragraph\nwith two lines.
    2. \n
\n", - "example": 261, - "start_line": 4494, - "end_line": 4502, + "example": 291, + "start_line": 4853, + "end_line": 4861, "section": "List items" }, { "markdown": "> 1. > Blockquote\ncontinued here.\n", "html": "
\n
    \n
  1. \n
    \n

    Blockquote\ncontinued here.

    \n
    \n
    2. \n
\n
\n", - "example": 262, - "start_line": 4507, - "end_line": 4521, + "example": 292, + "start_line": 4866, + "end_line": 4880, "section": "List items" }, { "markdown": "> 1. > Blockquote\n> continued here.\n", "html": "
\n
    \n
  1. \n
    \n

    Blockquote\ncontinued here.

    \n
    \n
    2. \n
\n
\n", - "example": 263, - "start_line": 4524, - "end_line": 4538, + "example": 293, + "start_line": 4883, + "end_line": 4897, "section": "List items" }, { "markdown": "- foo\n - bar\n - baz\n - boo\n", "html": "
    \n
  • foo\n
      \n
    • bar\n
        \n
      • baz\n
          \n
        • boo
          • \n
        \n
        • \n
      \n
      • \n
    \n
    • \n
\n", - "example": 264, - "start_line": 4552, - "end_line": 4573, + "example": 294, + "start_line": 4911, + "end_line": 4932, "section": "List items" }, { "markdown": "- foo\n - bar\n - baz\n - boo\n", "html": "
    \n
  • foo
    • \n
  • bar
    • \n
  • baz
    • \n
  • boo
    • \n
\n", - "example": 265, - "start_line": 4578, - "end_line": 4590, + "example": 295, + "start_line": 4937, + "end_line": 4949, "section": "List items" }, { "markdown": "10) foo\n - bar\n", "html": "
    \n
  1. foo\n
      \n
    • bar
      • \n
    \n
    2. \n
\n", - "example": 266, - "start_line": 4595, - "end_line": 4606, + "example": 296, + "start_line": 4954, + "end_line": 4965, "section": "List items" }, { "markdown": "10) foo\n - bar\n", "html": "
    \n
  1. foo
    2. \n
\n
    \n
  • bar
    • \n
\n", - "example": 267, - "start_line": 4611, - "end_line": 4621, + "example": 297, + "start_line": 4970, + "end_line": 4980, "section": "List items" }, { "markdown": "- - foo\n", "html": "
    \n
  • \n
      \n
    • foo
      • \n
    \n
    • \n
\n", - "example": 268, - "start_line": 4626, - "end_line": 4636, + "example": 298, + "start_line": 4985, + "end_line": 4995, "section": "List items" }, { "markdown": "1. - 2. foo\n", "html": "
    \n
  1. \n
      \n
    • \n
        \n
      1. foo
        2. \n
      \n
      • \n
    \n
    2. \n
\n", - "example": 269, - "start_line": 4639, - "end_line": 4653, + "example": 299, + "start_line": 4998, + "end_line": 5012, "section": "List items" }, { "markdown": "- # Foo\n- Bar\n ---\n baz\n", "html": "
    \n
  • \n

    Foo

    \n
    • \n
  • \n

    Bar

    \nbaz
    • \n
\n", - "example": 270, - "start_line": 4658, - "end_line": 4672, + "example": 300, + "start_line": 5017, + "end_line": 5031, "section": "List items" }, { "markdown": "- foo\n- bar\n+ baz\n", "html": "
    \n
  • foo
    • \n
  • bar
    • \n
\n
    \n
  • baz
    • \n
\n", - "example": 271, - "start_line": 4894, - "end_line": 4906, + "example": 301, + "start_line": 5253, + "end_line": 5265, "section": "Lists" }, { "markdown": "1. foo\n2. bar\n3) baz\n", "html": "
    \n
  1. foo
    2. \n
  2. bar
    3. \n
\n
    \n
  1. baz
    2. \n
\n", - "example": 272, - "start_line": 4909, - "end_line": 4921, + "example": 302, + "start_line": 5268, + "end_line": 5280, "section": "Lists" }, { "markdown": "Foo\n- bar\n- baz\n", "html": "

Foo

\n
    \n
  • bar
    • \n
  • baz
    • \n
\n", - "example": 273, - "start_line": 4928, - "end_line": 4938, + "example": 303, + "start_line": 5287, + "end_line": 5297, "section": "Lists" }, { "markdown": "The number of windows in my house is\n14. The number of doors is 6.\n", "html": "

The number of windows in my house is\n14. The number of doors is 6.

\n", - "example": 274, - "start_line": 5005, - "end_line": 5011, + "example": 304, + "start_line": 5364, + "end_line": 5370, "section": "Lists" }, { "markdown": "The number of windows in my house is\n1. The number of doors is 6.\n", "html": "

The number of windows in my house is

\n
    \n
  1. The number of doors is 6.
    2. \n
\n", - "example": 275, - "start_line": 5015, - "end_line": 5023, + "example": 305, + "start_line": 5374, + "end_line": 5382, "section": "Lists" }, { "markdown": "- foo\n\n- bar\n\n\n- baz\n", "html": "
    \n
  • \n

    foo

    \n
    • \n
  • \n

    bar

    \n
    • \n
  • \n

    baz

    \n
    • \n
\n", - "example": 276, - "start_line": 5029, - "end_line": 5048, + "example": 306, + "start_line": 5388, + "end_line": 5407, "section": "Lists" }, { "markdown": "- foo\n - bar\n - baz\n\n\n bim\n", "html": "
    \n
  • foo\n
      \n
    • bar\n
        \n
      • \n

        baz

        \n

        bim

        \n
        • \n
      \n
      • \n
    \n
    • \n
\n", - "example": 277, - "start_line": 5050, - "end_line": 5072, + "example": 307, + "start_line": 5409, + "end_line": 5431, "section": "Lists" }, { "markdown": "- foo\n- bar\n\n\n\n- baz\n- bim\n", "html": "
    \n
  • foo
    • \n
  • bar
    • \n
\n\n
    \n
  • baz
    • \n
  • bim
    • \n
\n", - "example": 278, - "start_line": 5080, - "end_line": 5098, + "example": 308, + "start_line": 5439, + "end_line": 5457, "section": "Lists" }, { "markdown": "- foo\n\n notcode\n\n- foo\n\n\n\n code\n", "html": "
    \n
  • \n

    foo

    \n

    notcode

    \n
    • \n
  • \n

    foo

    \n
    • \n
\n\n
code\n
\n", - "example": 279, - "start_line": 5101, - "end_line": 5124, + "example": 309, + "start_line": 5460, + "end_line": 5483, "section": "Lists" }, { "markdown": "- a\n - b\n - c\n - d\n - e\n - f\n- g\n", "html": "
    \n
  • a
    • \n
  • b
    • \n
  • c
    • \n
  • d
    • \n
  • e
    • \n
  • f
    • \n
  • g
    • \n
\n", - "example": 280, - "start_line": 5132, - "end_line": 5150, + "example": 310, + "start_line": 5491, + "end_line": 5509, "section": "Lists" }, { "markdown": "1. a\n\n 2. b\n\n 3. c\n", "html": "
    \n
  1. \n

    a

    \n
    2. \n
  2. \n

    b

    \n
    3. \n
  3. \n

    c

    \n
    4. \n
\n", - "example": 281, - "start_line": 5153, - "end_line": 5171, + "example": 311, + "start_line": 5512, + "end_line": 5530, "section": "Lists" }, { "markdown": "- a\n - b\n - c\n - d\n - e\n", "html": "
    \n
  • a
    • \n
  • b
    • \n
  • c
    • \n
  • d\n- e
    • \n
\n", - "example": 282, - "start_line": 5177, - "end_line": 5191, + "example": 312, + "start_line": 5536, + "end_line": 5550, "section": "Lists" }, { "markdown": "1. a\n\n 2. b\n\n 3. c\n", "html": "
    \n
  1. \n

    a

    \n
    2. \n
  2. \n

    b

    \n
    3. \n
\n
3. c\n
\n", - "example": 283, - "start_line": 5197, - "end_line": 5214, + "example": 313, + "start_line": 5556, + "end_line": 5573, "section": "Lists" }, { "markdown": "- a\n- b\n\n- c\n", "html": "
    \n
  • \n

    a

    \n
    • \n
  • \n

    b

    \n
    • \n
  • \n

    c

    \n
    • \n
\n", - "example": 284, - "start_line": 5220, - "end_line": 5237, + "example": 314, + "start_line": 5579, + "end_line": 5596, "section": "Lists" }, { "markdown": "* a\n*\n\n* c\n", "html": "
    \n
  • \n

    a

    \n
    • \n
  • \n
  • \n

    c

    \n
    • \n
\n", - "example": 285, - "start_line": 5242, - "end_line": 5257, + "example": 315, + "start_line": 5601, + "end_line": 5616, "section": "Lists" }, { "markdown": "- a\n- b\n\n c\n- d\n", "html": "
    \n
  • \n

    a

    \n
    • \n
  • \n

    b

    \n

    c

    \n
    • \n
  • \n

    d

    \n
    • \n
\n", - "example": 286, - "start_line": 5264, - "end_line": 5283, + "example": 316, + "start_line": 5623, + "end_line": 5642, "section": "Lists" }, { "markdown": "- a\n- b\n\n [ref]: /url\n- d\n", "html": "
    \n
  • \n

    a

    \n
    • \n
  • \n

    b

    \n
    • \n
  • \n

    d

    \n
    • \n
\n", - "example": 287, - "start_line": 5286, - "end_line": 5304, + "example": 317, + "start_line": 5645, + "end_line": 5663, "section": "Lists" }, { "markdown": "- a\n- ```\n b\n\n\n ```\n- c\n", "html": "
    \n
  • a
    • \n
  • \n
    b\n\n\n
    \n
    • \n
  • c
    • \n
\n", - "example": 288, - "start_line": 5309, - "end_line": 5328, + "example": 318, + "start_line": 5668, + "end_line": 5687, "section": "Lists" }, { "markdown": "- a\n - b\n\n c\n- d\n", "html": "
    \n
  • a\n
      \n
    • \n

      b

      \n

      c

      \n
      • \n
    \n
    • \n
  • d
    • \n
\n", - "example": 289, - "start_line": 5335, - "end_line": 5353, + "example": 319, + "start_line": 5694, + "end_line": 5712, "section": "Lists" }, { "markdown": "* a\n > b\n >\n* c\n", "html": "
    \n
  • a\n
    \n

    b

    \n
    \n
    • \n
  • c
    • \n
\n", - "example": 290, - "start_line": 5359, - "end_line": 5373, + "example": 320, + "start_line": 5718, + "end_line": 5732, "section": "Lists" }, { "markdown": "- a\n > b\n ```\n c\n ```\n- d\n", "html": "
    \n
  • a\n
    \n

    b

    \n
    \n
    c\n
    \n
    • \n
  • d
    • \n
\n", - "example": 291, - "start_line": 5379, - "end_line": 5397, + "example": 321, + "start_line": 5738, + "end_line": 5756, "section": "Lists" }, { "markdown": "- a\n", "html": "
    \n
  • a
    • \n
\n", - "example": 292, - "start_line": 5402, - "end_line": 5408, + "example": 322, + "start_line": 5761, + "end_line": 5767, "section": "Lists" }, { "markdown": "- a\n - b\n", "html": "
    \n
  • a\n
      \n
    • b
      • \n
    \n
    • \n
\n", - "example": 293, - "start_line": 5411, - "end_line": 5422, + "example": 323, + "start_line": 5770, + "end_line": 5781, "section": "Lists" }, { "markdown": "1. ```\n foo\n ```\n\n bar\n", "html": "
    \n
  1. \n
    foo\n
    \n

    bar

    \n
    2. \n
\n", - "example": 294, - "start_line": 5428, - "end_line": 5442, + "example": 324, + "start_line": 5787, + "end_line": 5801, "section": "Lists" }, { "markdown": "* foo\n * bar\n\n baz\n", "html": "
    \n
  • \n

    foo

    \n
      \n
    • bar
      • \n
    \n

    baz

    \n
    • \n
\n", - "example": 295, - "start_line": 5447, - "end_line": 5462, + "example": 325, + "start_line": 5806, + "end_line": 5821, "section": "Lists" }, { "markdown": "- a\n - b\n - c\n\n- d\n - e\n - f\n", "html": "
    \n
  • \n

    a

    \n
      \n
    • b
      • \n
    • c
      • \n
    \n
    • \n
  • \n

    d

    \n
      \n
    • e
      • \n
    • f
      • \n
    \n
    • \n
\n", - "example": 296, - "start_line": 5465, - "end_line": 5490, + "example": 326, + "start_line": 5824, + "end_line": 5849, "section": "Lists" }, { "markdown": "`hi`lo`\n", "html": "

hilo`

\n", - "example": 297, - "start_line": 5499, - "end_line": 5503, - "section": "Inlines" - }, - { - "markdown": "\\!\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\?\\@\\[\\\\\\]\\^\\_\\`\\{\\|\\}\\~\n", - "html": "

!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~

\n", - "example": 298, - "start_line": 5513, - "end_line": 5517, - "section": "Backslash escapes" - }, - { - "markdown": "\\\t\\A\\a\\ \\3\\φ\\«\n", - "html": "

\\\t\\A\\a\\ \\3\\φ\\«

\n", - "example": 299, - "start_line": 5523, - "end_line": 5527, - "section": "Backslash escapes" - }, - { - "markdown": "\\*not emphasized*\n\\
not a tag\n\\[not a link](/foo)\n\\`not code`\n1\\. not a list\n\\* not a list\n\\# not a heading\n\\[foo]: /url \"not a reference\"\n\\ö not a character entity\n", - "html": "

*not emphasized*\n<br/> not a tag\n[not a link](/foo)\n`not code`\n1. not a list\n* not a list\n# not a heading\n[foo]: /url "not a reference"\n&ouml; not a character entity

\n", - "example": 300, - "start_line": 5533, - "end_line": 5553, - "section": "Backslash escapes" - }, - { - "markdown": "\\\\*emphasis*\n", - "html": "

\\emphasis

\n", - "example": 301, - "start_line": 5558, - "end_line": 5562, - "section": "Backslash escapes" - }, - { - "markdown": "foo\\\nbar\n", - "html": "

foo
\nbar

\n", - "example": 302, - "start_line": 5567, - "end_line": 5573, - "section": "Backslash escapes" - }, - { - "markdown": "`` \\[\\` ``\n", - "html": "

\\[\\`

\n", - "example": 303, - "start_line": 5579, - "end_line": 5583, - "section": "Backslash escapes" - }, - { - "markdown": " \\[\\]\n", - "html": "
\\[\\]\n
\n", - "example": 304, - "start_line": 5586, - "end_line": 5591, - "section": "Backslash escapes" - }, - { - "markdown": "~~~\n\\[\\]\n~~~\n", - "html": "
\\[\\]\n
\n", - "example": 305, - "start_line": 5594, - "end_line": 5601, - "section": "Backslash escapes" - }, - { - "markdown": "\n", - "html": "

http://example.com?find=\\*

\n", - "example": 306, - "start_line": 5604, - "end_line": 5608, - "section": "Backslash escapes" - }, - { - "markdown": "\n", - "html": "\n", - "example": 307, - "start_line": 5611, - "end_line": 5615, - "section": "Backslash escapes" - }, - { - "markdown": "[foo](/bar\\* \"ti\\*tle\")\n", - "html": "

foo

\n", - "example": 308, - "start_line": 5621, - "end_line": 5625, - "section": "Backslash escapes" - }, - { - "markdown": "[foo]\n\n[foo]: /bar\\* \"ti\\*tle\"\n", - "html": "

foo

\n", - "example": 309, - "start_line": 5628, - "end_line": 5634, - "section": "Backslash escapes" - }, - { - "markdown": "``` foo\\+bar\nfoo\n```\n", - "html": "
foo\n
\n", - "example": 310, - "start_line": 5637, - "end_line": 5644, - "section": "Backslash escapes" - }, - { - "markdown": "  & © Æ Ď\n¾ ℋ ⅆ\n∲ ≧̸\n", - "html": "

  & © Æ Ď\n¾ ℋ ⅆ\n∲ ≧̸

\n", - "example": 311, - "start_line": 5674, - "end_line": 5682, - "section": "Entity and numeric character references" - }, - { - "markdown": "# Ӓ Ϡ �\n", - "html": "

# Ӓ Ϡ �

\n", - "example": 312, - "start_line": 5693, - "end_line": 5697, - "section": "Entity and numeric character references" - }, - { - "markdown": "" ആ ಫ\n", - "html": "

" ആ ಫ

\n", - "example": 313, - "start_line": 5706, - "end_line": 5710, - "section": "Entity and numeric character references" - }, - { - "markdown": "  &x; &#; &#x;\n�\n&#abcdef0;\n&ThisIsNotDefined; &hi?;\n", - "html": "

&nbsp &x; &#; &#x;\n&#987654321;\n&#abcdef0;\n&ThisIsNotDefined; &hi?;

\n", - "example": 314, - "start_line": 5715, - "end_line": 5725, - "section": "Entity and numeric character references" - }, - { - "markdown": "©\n", - "html": "

&copy

\n", - "example": 315, - "start_line": 5732, - "end_line": 5736, - "section": "Entity and numeric character references" - }, - { - "markdown": "&MadeUpEntity;\n", - "html": "

&MadeUpEntity;

\n", - "example": 316, - "start_line": 5742, - "end_line": 5746, - "section": "Entity and numeric character references" - }, - { - "markdown": "\n", - "html": "\n", - "example": 317, - "start_line": 5753, - "end_line": 5757, - "section": "Entity and numeric character references" - }, - { - "markdown": "[foo](/föö \"föö\")\n", - "html": "

foo

\n", - "example": 318, - "start_line": 5760, - "end_line": 5764, - "section": "Entity and numeric character references" - }, - { - "markdown": "[foo]\n\n[foo]: /föö \"föö\"\n", - "html": "

foo

\n", - "example": 319, - "start_line": 5767, - "end_line": 5773, - "section": "Entity and numeric character references" - }, - { - "markdown": "``` föö\nfoo\n```\n", - "html": "
foo\n
\n", - "example": 320, - "start_line": 5776, - "end_line": 5783, - "section": "Entity and numeric character references" - }, - { - "markdown": "`föö`\n", - "html": "

f&ouml;&ouml;

\n", - "example": 321, - "start_line": 5789, - "end_line": 5793, - "section": "Entity and numeric character references" - }, - { - "markdown": " föfö\n", - "html": "
f&ouml;f&ouml;\n
\n", - "example": 322, - "start_line": 5796, - "end_line": 5801, - "section": "Entity and numeric character references" - }, - { - "markdown": "*foo*\n*foo*\n", - "html": "

*foo*\nfoo

\n", - "example": 323, - "start_line": 5808, - "end_line": 5814, - "section": "Entity and numeric character references" - }, - { - "markdown": "* foo\n\n* foo\n", - "html": "

* foo

\n
    \n
  • foo
    • \n
\n", - "example": 324, - "start_line": 5816, - "end_line": 5825, - "section": "Entity and numeric character references" - }, - { - "markdown": "foo bar\n", - "html": "

foo\n\nbar

\n", - "example": 325, - "start_line": 5827, - "end_line": 5833, - "section": "Entity and numeric character references" - }, - { - "markdown": " foo\n", - "html": "

\tfoo

\n", - "example": 326, - "start_line": 5835, - "end_line": 5839, - "section": "Entity and numeric character references" - }, - { - "markdown": "[a](url "tit")\n", - "html": "

[a](url "tit")

\n", "example": 327, - "start_line": 5842, - "end_line": 5846, - "section": "Entity and numeric character references" + "start_line": 5858, + "end_line": 5862, + "section": "Inlines" }, { "markdown": "`foo`\n", "html": "

foo

\n", "example": 328, - "start_line": 5870, - "end_line": 5874, + "start_line": 5890, + "end_line": 5894, "section": "Code spans" }, { "markdown": "`` foo ` bar ``\n", "html": "

foo ` bar

\n", "example": 329, - "start_line": 5881, - "end_line": 5885, + "start_line": 5901, + "end_line": 5905, "section": "Code spans" }, { "markdown": "` `` `\n", "html": "

``

\n", "example": 330, - "start_line": 5891, - "end_line": 5895, + "start_line": 5911, + "end_line": 5915, "section": "Code spans" }, { "markdown": "` `` `\n", "html": "

``

\n", "example": 331, - "start_line": 5899, - "end_line": 5903, + "start_line": 5919, + "end_line": 5923, "section": "Code spans" }, { "markdown": "` a`\n", "html": "

a

\n", "example": 332, - "start_line": 5908, - "end_line": 5912, + "start_line": 5928, + "end_line": 5932, "section": "Code spans" }, { "markdown": "` b `\n", "html": "

 b 

\n", "example": 333, - "start_line": 5917, - "end_line": 5921, + "start_line": 5937, + "end_line": 5941, "section": "Code spans" }, { "markdown": "` `\n` `\n", "html": "

 \n

\n", "example": 334, - "start_line": 5925, - "end_line": 5931, + "start_line": 5945, + "end_line": 5951, "section": "Code spans" }, { "markdown": "``\nfoo\nbar \nbaz\n``\n", "html": "

foo bar baz

\n", "example": 335, - "start_line": 5936, - "end_line": 5944, + "start_line": 5956, + "end_line": 5964, "section": "Code spans" }, { "markdown": "``\nfoo \n``\n", "html": "

foo

\n", "example": 336, - "start_line": 5946, - "end_line": 5952, + "start_line": 5966, + "end_line": 5972, "section": "Code spans" }, { "markdown": "`foo bar \nbaz`\n", "html": "

foo bar baz

\n", "example": 337, - "start_line": 5957, - "end_line": 5962, + "start_line": 5977, + "end_line": 5982, "section": "Code spans" }, { "markdown": "`foo\\`bar`\n", "html": "

foo\\bar`

\n", "example": 338, - "start_line": 5974, - "end_line": 5978, + "start_line": 5994, + "end_line": 5998, "section": "Code spans" }, { "markdown": "``foo`bar``\n", "html": "

foo`bar

\n", "example": 339, - "start_line": 5985, - "end_line": 5989, + "start_line": 6005, + "end_line": 6009, "section": "Code spans" }, { "markdown": "` foo `` bar `\n", "html": "

foo `` bar

\n", "example": 340, - "start_line": 5991, - "end_line": 5995, + "start_line": 6011, + "end_line": 6015, "section": "Code spans" }, { "markdown": "*foo`*`\n", "html": "

*foo*

\n", "example": 341, - "start_line": 6003, - "end_line": 6007, + "start_line": 6023, + "end_line": 6027, "section": "Code spans" }, { "markdown": "[not a `link](/foo`)\n", "html": "

[not a link](/foo)

\n", "example": 342, - "start_line": 6012, - "end_line": 6016, + "start_line": 6032, + "end_line": 6036, "section": "Code spans" }, { "markdown": "``\n", "html": "

<a href="">`

\n", "example": 343, - "start_line": 6022, - "end_line": 6026, + "start_line": 6042, + "end_line": 6046, "section": "Code spans" }, { "markdown": "`\n", "html": "

`

\n", "example": 344, - "start_line": 6031, - "end_line": 6035, + "start_line": 6051, + "end_line": 6055, "section": "Code spans" }, { "markdown": "``\n", "html": "

<http://foo.bar.baz>`

\n", "example": 345, - "start_line": 6040, - "end_line": 6044, + "start_line": 6060, + "end_line": 6064, "section": "Code spans" }, { "markdown": "`\n", "html": "

http://foo.bar.`baz`

\n", "example": 346, - "start_line": 6049, - "end_line": 6053, + "start_line": 6069, + "end_line": 6073, "section": "Code spans" }, { "markdown": "```foo``\n", "html": "

```foo``

\n", "example": 347, - "start_line": 6059, - "end_line": 6063, + "start_line": 6079, + "end_line": 6083, "section": "Code spans" }, { "markdown": "`foo\n", "html": "

`foo

\n", "example": 348, - "start_line": 6066, - "end_line": 6070, + "start_line": 6086, + "end_line": 6090, "section": "Code spans" }, { "markdown": "`foo``bar``\n", "html": "

`foobar

\n", "example": 349, - "start_line": 6075, - "end_line": 6079, + "start_line": 6095, + "end_line": 6099, "section": "Code spans" }, { "markdown": "*foo bar*\n", "html": "

foo bar

\n", "example": 350, - "start_line": 6292, - "end_line": 6296, + "start_line": 6312, + "end_line": 6316, "section": "Emphasis and strong emphasis" }, { "markdown": "a * foo bar*\n", "html": "

a * foo bar*

\n", "example": 351, - "start_line": 6302, - "end_line": 6306, + "start_line": 6322, + "end_line": 6326, "section": "Emphasis and strong emphasis" }, { "markdown": "a*\"foo\"*\n", "html": "

a*"foo"*

\n", "example": 352, - "start_line": 6313, - "end_line": 6317, + "start_line": 6333, + "end_line": 6337, "section": "Emphasis and strong emphasis" }, { "markdown": "* a *\n", "html": "

* a *

\n", "example": 353, - "start_line": 6322, - "end_line": 6326, + "start_line": 6342, + "end_line": 6346, "section": "Emphasis and strong emphasis" }, { "markdown": "foo*bar*\n", "html": "

foobar

\n", "example": 354, - "start_line": 6331, - "end_line": 6335, + "start_line": 6351, + "end_line": 6355, "section": "Emphasis and strong emphasis" }, { "markdown": "5*6*78\n", "html": "

5678

\n", "example": 355, - "start_line": 6338, - "end_line": 6342, + "start_line": 6358, + "end_line": 6362, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo bar_\n", "html": "

foo bar

\n", "example": 356, - "start_line": 6347, - "end_line": 6351, + "start_line": 6367, + "end_line": 6371, "section": "Emphasis and strong emphasis" }, { "markdown": "_ foo bar_\n", "html": "

_ foo bar_

\n", "example": 357, - "start_line": 6357, - "end_line": 6361, + "start_line": 6377, + "end_line": 6381, "section": "Emphasis and strong emphasis" }, { "markdown": "a_\"foo\"_\n", "html": "

a_"foo"_

\n", "example": 358, - "start_line": 6367, - "end_line": 6371, + "start_line": 6387, + "end_line": 6391, "section": "Emphasis and strong emphasis" }, { "markdown": "foo_bar_\n", "html": "

foo_bar_

\n", "example": 359, - "start_line": 6376, - "end_line": 6380, + "start_line": 6396, + "end_line": 6400, "section": "Emphasis and strong emphasis" }, { "markdown": "5_6_78\n", "html": "

5_6_78

\n", "example": 360, - "start_line": 6383, - "end_line": 6387, + "start_line": 6403, + "end_line": 6407, "section": "Emphasis and strong emphasis" }, { "markdown": "пристаням_стремятся_\n", "html": "

пристаням_стремятся_

\n", "example": 361, - "start_line": 6390, - "end_line": 6394, + "start_line": 6410, + "end_line": 6414, "section": "Emphasis and strong emphasis" }, { "markdown": "aa_\"bb\"_cc\n", "html": "

aa_"bb"_cc

\n", "example": 362, - "start_line": 6400, - "end_line": 6404, + "start_line": 6420, + "end_line": 6424, "section": "Emphasis and strong emphasis" }, { "markdown": "foo-_(bar)_\n", "html": "

foo-(bar)

\n", "example": 363, - "start_line": 6411, - "end_line": 6415, + "start_line": 6431, + "end_line": 6435, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo*\n", "html": "

_foo*

\n", "example": 364, - "start_line": 6423, - "end_line": 6427, + "start_line": 6443, + "end_line": 6447, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo bar *\n", "html": "

*foo bar *

\n", "example": 365, - "start_line": 6433, - "end_line": 6437, + "start_line": 6453, + "end_line": 6457, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo bar\n*\n", "html": "

*foo bar\n*

\n", "example": 366, - "start_line": 6442, - "end_line": 6448, + "start_line": 6462, + "end_line": 6468, "section": "Emphasis and strong emphasis" }, { "markdown": "*(*foo)\n", "html": "

*(*foo)

\n", "example": 367, - "start_line": 6455, - "end_line": 6459, + "start_line": 6475, + "end_line": 6479, "section": "Emphasis and strong emphasis" }, { "markdown": "*(*foo*)*\n", "html": "

(foo)

\n", "example": 368, - "start_line": 6465, - "end_line": 6469, + "start_line": 6485, + "end_line": 6489, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo*bar\n", "html": "

foobar

\n", "example": 369, - "start_line": 6474, - "end_line": 6478, + "start_line": 6494, + "end_line": 6498, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo bar _\n", "html": "

_foo bar _

\n", "example": 370, - "start_line": 6487, - "end_line": 6491, + "start_line": 6507, + "end_line": 6511, "section": "Emphasis and strong emphasis" }, { "markdown": "_(_foo)\n", "html": "

_(_foo)

\n", "example": 371, - "start_line": 6497, - "end_line": 6501, + "start_line": 6517, + "end_line": 6521, "section": "Emphasis and strong emphasis" }, { "markdown": "_(_foo_)_\n", "html": "

(foo)

\n", "example": 372, - "start_line": 6506, - "end_line": 6510, + "start_line": 6526, + "end_line": 6530, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo_bar\n", "html": "

_foo_bar

\n", "example": 373, - "start_line": 6515, - "end_line": 6519, + "start_line": 6535, + "end_line": 6539, "section": "Emphasis and strong emphasis" }, { "markdown": "_пристаням_стремятся\n", "html": "

_пристаням_стремятся

\n", "example": 374, - "start_line": 6522, - "end_line": 6526, + "start_line": 6542, + "end_line": 6546, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo_bar_baz_\n", "html": "

foo_bar_baz

\n", "example": 375, - "start_line": 6529, - "end_line": 6533, + "start_line": 6549, + "end_line": 6553, "section": "Emphasis and strong emphasis" }, { "markdown": "_(bar)_.\n", "html": "

(bar).

\n", "example": 376, - "start_line": 6540, - "end_line": 6544, + "start_line": 6560, + "end_line": 6564, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo bar**\n", "html": "

foo bar

\n", "example": 377, - "start_line": 6549, - "end_line": 6553, + "start_line": 6569, + "end_line": 6573, "section": "Emphasis and strong emphasis" }, { "markdown": "** foo bar**\n", "html": "

** foo bar**

\n", "example": 378, - "start_line": 6559, - "end_line": 6563, + "start_line": 6579, + "end_line": 6583, "section": "Emphasis and strong emphasis" }, { "markdown": "a**\"foo\"**\n", "html": "

a**"foo"**

\n", "example": 379, - "start_line": 6570, - "end_line": 6574, + "start_line": 6590, + "end_line": 6594, "section": "Emphasis and strong emphasis" }, { "markdown": "foo**bar**\n", "html": "

foobar

\n", "example": 380, - "start_line": 6579, - "end_line": 6583, + "start_line": 6599, + "end_line": 6603, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo bar__\n", "html": "

foo bar

\n", "example": 381, - "start_line": 6588, - "end_line": 6592, + "start_line": 6608, + "end_line": 6612, "section": "Emphasis and strong emphasis" }, { "markdown": "__ foo bar__\n", "html": "

__ foo bar__

\n", "example": 382, - "start_line": 6598, - "end_line": 6602, + "start_line": 6618, + "end_line": 6622, "section": "Emphasis and strong emphasis" }, { "markdown": "__\nfoo bar__\n", "html": "

__\nfoo bar__

\n", "example": 383, - "start_line": 6606, - "end_line": 6612, + "start_line": 6626, + "end_line": 6632, "section": "Emphasis and strong emphasis" }, { "markdown": "a__\"foo\"__\n", "html": "

a__"foo"__

\n", "example": 384, - "start_line": 6618, - "end_line": 6622, + "start_line": 6638, + "end_line": 6642, "section": "Emphasis and strong emphasis" }, { "markdown": "foo__bar__\n", "html": "

foo__bar__

\n", "example": 385, - "start_line": 6627, - "end_line": 6631, + "start_line": 6647, + "end_line": 6651, "section": "Emphasis and strong emphasis" }, { "markdown": "5__6__78\n", "html": "

5__6__78

\n", "example": 386, - "start_line": 6634, - "end_line": 6638, + "start_line": 6654, + "end_line": 6658, "section": "Emphasis and strong emphasis" }, { "markdown": "пристаням__стремятся__\n", "html": "

пристаням__стремятся__

\n", "example": 387, - "start_line": 6641, - "end_line": 6645, + "start_line": 6661, + "end_line": 6665, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo, __bar__, baz__\n", "html": "

foo, bar, baz

\n", "example": 388, - "start_line": 6648, - "end_line": 6652, + "start_line": 6668, + "end_line": 6672, "section": "Emphasis and strong emphasis" }, { "markdown": "foo-__(bar)__\n", "html": "

foo-(bar)

\n", "example": 389, - "start_line": 6659, - "end_line": 6663, + "start_line": 6679, + "end_line": 6683, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo bar **\n", "html": "

**foo bar **

\n", "example": 390, - "start_line": 6672, - "end_line": 6676, + "start_line": 6692, + "end_line": 6696, "section": "Emphasis and strong emphasis" }, { "markdown": "**(**foo)\n", "html": "

**(**foo)

\n", "example": 391, - "start_line": 6685, - "end_line": 6689, + "start_line": 6705, + "end_line": 6709, "section": "Emphasis and strong emphasis" }, { "markdown": "*(**foo**)*\n", "html": "

(foo)

\n", "example": 392, - "start_line": 6695, - "end_line": 6699, + "start_line": 6715, + "end_line": 6719, "section": "Emphasis and strong emphasis" }, { "markdown": "**Gomphocarpus (*Gomphocarpus physocarpus*, syn.\n*Asclepias physocarpa*)**\n", "html": "

Gomphocarpus (Gomphocarpus physocarpus, syn.\nAsclepias physocarpa)

\n", "example": 393, - "start_line": 6702, - "end_line": 6708, + "start_line": 6722, + "end_line": 6728, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo \"*bar*\" foo**\n", "html": "

foo "bar" foo

\n", "example": 394, - "start_line": 6711, - "end_line": 6715, + "start_line": 6731, + "end_line": 6735, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo**bar\n", "html": "

foobar

\n", "example": 395, - "start_line": 6720, - "end_line": 6724, + "start_line": 6740, + "end_line": 6744, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo bar __\n", "html": "

__foo bar __

\n", "example": 396, - "start_line": 6732, - "end_line": 6736, + "start_line": 6752, + "end_line": 6756, "section": "Emphasis and strong emphasis" }, { "markdown": "__(__foo)\n", "html": "

__(__foo)

\n", "example": 397, - "start_line": 6742, - "end_line": 6746, + "start_line": 6762, + "end_line": 6766, "section": "Emphasis and strong emphasis" }, { "markdown": "_(__foo__)_\n", "html": "

(foo)

\n", "example": 398, - "start_line": 6752, - "end_line": 6756, + "start_line": 6772, + "end_line": 6776, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo__bar\n", "html": "

__foo__bar

\n", "example": 399, - "start_line": 6761, - "end_line": 6765, + "start_line": 6781, + "end_line": 6785, "section": "Emphasis and strong emphasis" }, { "markdown": "__пристаням__стремятся\n", "html": "

__пристаням__стремятся

\n", "example": 400, - "start_line": 6768, - "end_line": 6772, + "start_line": 6788, + "end_line": 6792, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo__bar__baz__\n", "html": "

foo__bar__baz

\n", "example": 401, - "start_line": 6775, - "end_line": 6779, + "start_line": 6795, + "end_line": 6799, "section": "Emphasis and strong emphasis" }, { "markdown": "__(bar)__.\n", "html": "

(bar).

\n", "example": 402, - "start_line": 6786, - "end_line": 6790, + "start_line": 6806, + "end_line": 6810, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo [bar](/url)*\n", "html": "

foo bar

\n", "example": 403, - "start_line": 6798, - "end_line": 6802, + "start_line": 6818, + "end_line": 6822, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo\nbar*\n", "html": "

foo\nbar

\n", "example": 404, - "start_line": 6805, - "end_line": 6811, + "start_line": 6825, + "end_line": 6831, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo __bar__ baz_\n", "html": "

foo bar baz

\n", "example": 405, - "start_line": 6817, - "end_line": 6821, + "start_line": 6837, + "end_line": 6841, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo _bar_ baz_\n", "html": "

foo bar baz

\n", "example": 406, - "start_line": 6824, - "end_line": 6828, + "start_line": 6844, + "end_line": 6848, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo_ bar_\n", "html": "

foo bar

\n", "example": 407, - "start_line": 6831, - "end_line": 6835, + "start_line": 6851, + "end_line": 6855, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo *bar**\n", "html": "

foo bar

\n", "example": 408, - "start_line": 6838, - "end_line": 6842, + "start_line": 6858, + "end_line": 6862, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo **bar** baz*\n", "html": "

foo bar baz

\n", "example": 409, - "start_line": 6845, - "end_line": 6849, + "start_line": 6865, + "end_line": 6869, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo**bar**baz*\n", "html": "

foobarbaz

\n", "example": 410, - "start_line": 6851, - "end_line": 6855, + "start_line": 6871, + "end_line": 6875, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo**bar*\n", "html": "

foo**bar

\n", "example": 411, - "start_line": 6875, - "end_line": 6879, + "start_line": 6895, + "end_line": 6899, "section": "Emphasis and strong emphasis" }, { "markdown": "***foo** bar*\n", "html": "

foo bar

\n", "example": 412, - "start_line": 6888, - "end_line": 6892, + "start_line": 6908, + "end_line": 6912, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo **bar***\n", "html": "

foo bar

\n", "example": 413, - "start_line": 6895, - "end_line": 6899, + "start_line": 6915, + "end_line": 6919, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo**bar***\n", "html": "

foobar

\n", "example": 414, - "start_line": 6902, - "end_line": 6906, + "start_line": 6922, + "end_line": 6926, "section": "Emphasis and strong emphasis" }, { "markdown": "foo***bar***baz\n", "html": "

foobarbaz

\n", "example": 415, - "start_line": 6913, - "end_line": 6917, + "start_line": 6933, + "end_line": 6937, "section": "Emphasis and strong emphasis" }, { "markdown": "foo******bar*********baz\n", "html": "

foobar***baz

\n", "example": 416, - "start_line": 6919, - "end_line": 6923, + "start_line": 6939, + "end_line": 6943, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo **bar *baz* bim** bop*\n", "html": "

foo bar baz bim bop

\n", "example": 417, - "start_line": 6928, - "end_line": 6932, + "start_line": 6948, + "end_line": 6952, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo [*bar*](/url)*\n", "html": "

foo bar

\n", "example": 418, - "start_line": 6935, - "end_line": 6939, + "start_line": 6955, + "end_line": 6959, "section": "Emphasis and strong emphasis" }, { "markdown": "** is not an empty emphasis\n", "html": "

** is not an empty emphasis

\n", "example": 419, - "start_line": 6944, - "end_line": 6948, + "start_line": 6964, + "end_line": 6968, "section": "Emphasis and strong emphasis" }, { "markdown": "**** is not an empty strong emphasis\n", "html": "

**** is not an empty strong emphasis

\n", "example": 420, - "start_line": 6951, - "end_line": 6955, + "start_line": 6971, + "end_line": 6975, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo [bar](/url)**\n", "html": "

foo bar

\n", "example": 421, - "start_line": 6964, - "end_line": 6968, + "start_line": 6984, + "end_line": 6988, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo\nbar**\n", "html": "

foo\nbar

\n", "example": 422, - "start_line": 6971, - "end_line": 6977, + "start_line": 6991, + "end_line": 6997, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo _bar_ baz__\n", "html": "

foo bar baz

\n", "example": 423, - "start_line": 6983, - "end_line": 6987, + "start_line": 7003, + "end_line": 7007, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo __bar__ baz__\n", "html": "

foo bar baz

\n", "example": 424, - "start_line": 6990, - "end_line": 6994, + "start_line": 7010, + "end_line": 7014, "section": "Emphasis and strong emphasis" }, { "markdown": "____foo__ bar__\n", "html": "

foo bar

\n", "example": 425, - "start_line": 6997, - "end_line": 7001, + "start_line": 7017, + "end_line": 7021, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo **bar****\n", "html": "

foo bar

\n", "example": 426, - "start_line": 7004, - "end_line": 7008, + "start_line": 7024, + "end_line": 7028, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo *bar* baz**\n", "html": "

foo bar baz

\n", "example": 427, - "start_line": 7011, - "end_line": 7015, + "start_line": 7031, + "end_line": 7035, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo*bar*baz**\n", "html": "

foobarbaz

\n", "example": 428, - "start_line": 7018, - "end_line": 7022, + "start_line": 7038, + "end_line": 7042, "section": "Emphasis and strong emphasis" }, { "markdown": "***foo* bar**\n", "html": "

foo bar

\n", "example": 429, - "start_line": 7025, - "end_line": 7029, + "start_line": 7045, + "end_line": 7049, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo *bar***\n", "html": "

foo bar

\n", "example": 430, - "start_line": 7032, - "end_line": 7036, + "start_line": 7052, + "end_line": 7056, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo *bar **baz**\nbim* bop**\n", "html": "

foo bar baz\nbim bop

\n", "example": 431, - "start_line": 7041, - "end_line": 7047, + "start_line": 7061, + "end_line": 7067, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo [*bar*](/url)**\n", "html": "

foo bar

\n", "example": 432, - "start_line": 7050, - "end_line": 7054, + "start_line": 7070, + "end_line": 7074, "section": "Emphasis and strong emphasis" }, { "markdown": "__ is not an empty emphasis\n", "html": "

__ is not an empty emphasis

\n", "example": 433, - "start_line": 7059, - "end_line": 7063, + "start_line": 7079, + "end_line": 7083, "section": "Emphasis and strong emphasis" }, { "markdown": "____ is not an empty strong emphasis\n", "html": "

____ is not an empty strong emphasis

\n", "example": 434, - "start_line": 7066, - "end_line": 7070, + "start_line": 7086, + "end_line": 7090, "section": "Emphasis and strong emphasis" }, { "markdown": "foo ***\n", "html": "

foo ***

\n", "example": 435, - "start_line": 7076, - "end_line": 7080, + "start_line": 7096, + "end_line": 7100, "section": "Emphasis and strong emphasis" }, { "markdown": "foo *\\**\n", "html": "

foo *

\n", "example": 436, - "start_line": 7083, - "end_line": 7087, + "start_line": 7103, + "end_line": 7107, "section": "Emphasis and strong emphasis" }, { "markdown": "foo *_*\n", "html": "

foo _

\n", "example": 437, - "start_line": 7090, - "end_line": 7094, + "start_line": 7110, + "end_line": 7114, "section": "Emphasis and strong emphasis" }, { "markdown": "foo *****\n", "html": "

foo *****

\n", "example": 438, - "start_line": 7097, - "end_line": 7101, + "start_line": 7117, + "end_line": 7121, "section": "Emphasis and strong emphasis" }, { "markdown": "foo **\\***\n", "html": "

foo *

\n", "example": 439, - "start_line": 7104, - "end_line": 7108, + "start_line": 7124, + "end_line": 7128, "section": "Emphasis and strong emphasis" }, { "markdown": "foo **_**\n", "html": "

foo _

\n", "example": 440, - "start_line": 7111, - "end_line": 7115, + "start_line": 7131, + "end_line": 7135, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo*\n", "html": "

*foo

\n", "example": 441, - "start_line": 7122, - "end_line": 7126, + "start_line": 7142, + "end_line": 7146, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo**\n", "html": "

foo*

\n", "example": 442, - "start_line": 7129, - "end_line": 7133, + "start_line": 7149, + "end_line": 7153, "section": "Emphasis and strong emphasis" }, { "markdown": "***foo**\n", "html": "

*foo

\n", "example": 443, - "start_line": 7136, - "end_line": 7140, + "start_line": 7156, + "end_line": 7160, "section": "Emphasis and strong emphasis" }, { "markdown": "****foo*\n", "html": "

***foo

\n", "example": 444, - "start_line": 7143, - "end_line": 7147, + "start_line": 7163, + "end_line": 7167, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo***\n", "html": "

foo*

\n", "example": 445, - "start_line": 7150, - "end_line": 7154, + "start_line": 7170, + "end_line": 7174, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo****\n", "html": "

foo***

\n", "example": 446, - "start_line": 7157, - "end_line": 7161, + "start_line": 7177, + "end_line": 7181, "section": "Emphasis and strong emphasis" }, { "markdown": "foo ___\n", "html": "

foo ___

\n", "example": 447, - "start_line": 7167, - "end_line": 7171, + "start_line": 7187, + "end_line": 7191, "section": "Emphasis and strong emphasis" }, { "markdown": "foo _\\__\n", "html": "

foo _

\n", "example": 448, - "start_line": 7174, - "end_line": 7178, + "start_line": 7194, + "end_line": 7198, "section": "Emphasis and strong emphasis" }, { "markdown": "foo _*_\n", "html": "

foo *

\n", "example": 449, - "start_line": 7181, - "end_line": 7185, + "start_line": 7201, + "end_line": 7205, "section": "Emphasis and strong emphasis" }, { "markdown": "foo _____\n", "html": "

foo _____

\n", "example": 450, - "start_line": 7188, - "end_line": 7192, + "start_line": 7208, + "end_line": 7212, "section": "Emphasis and strong emphasis" }, { "markdown": "foo __\\___\n", "html": "

foo _

\n", "example": 451, - "start_line": 7195, - "end_line": 7199, + "start_line": 7215, + "end_line": 7219, "section": "Emphasis and strong emphasis" }, { "markdown": "foo __*__\n", "html": "

foo *

\n", "example": 452, - "start_line": 7202, - "end_line": 7206, + "start_line": 7222, + "end_line": 7226, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo_\n", "html": "

_foo

\n", "example": 453, - "start_line": 7209, - "end_line": 7213, + "start_line": 7229, + "end_line": 7233, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo__\n", "html": "

foo_

\n", "example": 454, - "start_line": 7220, - "end_line": 7224, + "start_line": 7240, + "end_line": 7244, "section": "Emphasis and strong emphasis" }, { "markdown": "___foo__\n", "html": "

_foo

\n", "example": 455, - "start_line": 7227, - "end_line": 7231, + "start_line": 7247, + "end_line": 7251, "section": "Emphasis and strong emphasis" }, { "markdown": "____foo_\n", "html": "

___foo

\n", "example": 456, - "start_line": 7234, - "end_line": 7238, + "start_line": 7254, + "end_line": 7258, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo___\n", "html": "

foo_

\n", "example": 457, - "start_line": 7241, - "end_line": 7245, + "start_line": 7261, + "end_line": 7265, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo____\n", "html": "

foo___

\n", "example": 458, - "start_line": 7248, - "end_line": 7252, + "start_line": 7268, + "end_line": 7272, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo**\n", "html": "

foo

\n", "example": 459, - "start_line": 7258, - "end_line": 7262, + "start_line": 7278, + "end_line": 7282, "section": "Emphasis and strong emphasis" }, { "markdown": "*_foo_*\n", "html": "

foo

\n", "example": 460, - "start_line": 7265, - "end_line": 7269, + "start_line": 7285, + "end_line": 7289, "section": "Emphasis and strong emphasis" }, { "markdown": "__foo__\n", "html": "

foo

\n", "example": 461, - "start_line": 7272, - "end_line": 7276, + "start_line": 7292, + "end_line": 7296, "section": "Emphasis and strong emphasis" }, { "markdown": "_*foo*_\n", "html": "

foo

\n", "example": 462, - "start_line": 7279, - "end_line": 7283, + "start_line": 7299, + "end_line": 7303, "section": "Emphasis and strong emphasis" }, { "markdown": "****foo****\n", "html": "

foo

\n", "example": 463, - "start_line": 7289, - "end_line": 7293, + "start_line": 7309, + "end_line": 7313, "section": "Emphasis and strong emphasis" }, { "markdown": "____foo____\n", "html": "

foo

\n", "example": 464, - "start_line": 7296, - "end_line": 7300, + "start_line": 7316, + "end_line": 7320, "section": "Emphasis and strong emphasis" }, { "markdown": "******foo******\n", "html": "

foo

\n", "example": 465, - "start_line": 7307, - "end_line": 7311, + "start_line": 7327, + "end_line": 7331, "section": "Emphasis and strong emphasis" }, { "markdown": "***foo***\n", "html": "

foo

\n", "example": 466, - "start_line": 7316, - "end_line": 7320, + "start_line": 7336, + "end_line": 7340, "section": "Emphasis and strong emphasis" }, { "markdown": "_____foo_____\n", "html": "

foo

\n", "example": 467, - "start_line": 7323, - "end_line": 7327, + "start_line": 7343, + "end_line": 7347, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo _bar* baz_\n", "html": "

foo _bar baz_

\n", "example": 468, - "start_line": 7332, - "end_line": 7336, + "start_line": 7352, + "end_line": 7356, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo __bar *baz bim__ bam*\n", "html": "

foo bar *baz bim bam

\n", "example": 469, - "start_line": 7339, - "end_line": 7343, + "start_line": 7359, + "end_line": 7363, "section": "Emphasis and strong emphasis" }, { "markdown": "**foo **bar baz**\n", "html": "

**foo bar baz

\n", "example": 470, - "start_line": 7348, - "end_line": 7352, + "start_line": 7368, + "end_line": 7372, "section": "Emphasis and strong emphasis" }, { "markdown": "*foo *bar baz*\n", "html": "

*foo bar baz

\n", "example": 471, - "start_line": 7355, - "end_line": 7359, + "start_line": 7375, + "end_line": 7379, "section": "Emphasis and strong emphasis" }, { "markdown": "*[bar*](/url)\n", "html": "

*bar*

\n", "example": 472, - "start_line": 7364, - "end_line": 7368, + "start_line": 7384, + "end_line": 7388, "section": "Emphasis and strong emphasis" }, { "markdown": "_foo [bar_](/url)\n", "html": "

_foo bar_

\n", "example": 473, - "start_line": 7371, - "end_line": 7375, + "start_line": 7391, + "end_line": 7395, "section": "Emphasis and strong emphasis" }, { "markdown": "*\n", "html": "

*

\n", "example": 474, - "start_line": 7378, - "end_line": 7382, + "start_line": 7398, + "end_line": 7402, "section": "Emphasis and strong emphasis" }, { "markdown": "**\n", "html": "

**

\n", "example": 475, - "start_line": 7385, - "end_line": 7389, + "start_line": 7405, + "end_line": 7409, "section": "Emphasis and strong emphasis" }, { "markdown": "__\n", "html": "

__

\n", "example": 476, - "start_line": 7392, - "end_line": 7396, + "start_line": 7412, + "end_line": 7416, "section": "Emphasis and strong emphasis" }, { "markdown": "*a `*`*\n", "html": "

a *

\n", "example": 477, - "start_line": 7399, - "end_line": 7403, + "start_line": 7419, + "end_line": 7423, "section": "Emphasis and strong emphasis" }, { "markdown": "_a `_`_\n", "html": "

a _

\n", "example": 478, - "start_line": 7406, - "end_line": 7410, + "start_line": 7426, + "end_line": 7430, "section": "Emphasis and strong emphasis" }, { "markdown": "**a\n", "html": "

**ahttp://foo.bar/?q=**

\n", "example": 479, - "start_line": 7413, - "end_line": 7417, + "start_line": 7433, + "end_line": 7437, "section": "Emphasis and strong emphasis" }, { "markdown": "__a\n", "html": "

__ahttp://foo.bar/?q=__

\n", "example": 480, - "start_line": 7420, - "end_line": 7424, + "start_line": 7440, + "end_line": 7444, "section": "Emphasis and strong emphasis" }, { "markdown": "[link](/uri \"title\")\n", "html": "

link

\n", "example": 481, - "start_line": 7503, - "end_line": 7507, + "start_line": 7528, + "end_line": 7532, "section": "Links" }, { "markdown": "[link](/uri)\n", "html": "

link

\n", "example": 482, - "start_line": 7512, - "end_line": 7516, + "start_line": 7538, + "end_line": 7542, + "section": "Links" + }, + { + "markdown": "[](./target.md)\n", + "html": "

\n", + "example": 483, + "start_line": 7544, + "end_line": 7548, "section": "Links" }, { "markdown": "[link]()\n", "html": "

link

\n", - "example": 483, - "start_line": 7521, - "end_line": 7525, + "example": 484, + "start_line": 7551, + "end_line": 7555, "section": "Links" }, { "markdown": "[link](<>)\n", "html": "

link

\n", - "example": 484, - "start_line": 7528, - "end_line": 7532, + "example": 485, + "start_line": 7558, + "end_line": 7562, + "section": "Links" + }, + { + "markdown": "[]()\n", + "html": "

\n", + "example": 486, + "start_line": 7565, + "end_line": 7569, "section": "Links" }, { "markdown": "[link](/my uri)\n", "html": "

[link](/my uri)

\n", - "example": 485, - "start_line": 7537, - "end_line": 7541, + "example": 487, + "start_line": 7574, + "end_line": 7578, "section": "Links" }, { "markdown": "[link]()\n", "html": "

link

\n", - "example": 486, - "start_line": 7543, - "end_line": 7547, + "example": 488, + "start_line": 7580, + "end_line": 7584, "section": "Links" }, { "markdown": "[link](foo\nbar)\n", "html": "

[link](foo\nbar)

\n", - "example": 487, - "start_line": 7552, - "end_line": 7558, + "example": 489, + "start_line": 7589, + "end_line": 7595, "section": "Links" }, { "markdown": "[link]()\n", "html": "

[link]()

\n", - "example": 488, - "start_line": 7560, - "end_line": 7566, + "example": 490, + "start_line": 7597, + "end_line": 7603, "section": "Links" }, { "markdown": "[a]()\n", "html": "

a

\n", - "example": 489, - "start_line": 7571, - "end_line": 7575, + "example": 491, + "start_line": 7608, + "end_line": 7612, "section": "Links" }, { "markdown": "[link]()\n", "html": "

[link](<foo>)

\n", - "example": 490, - "start_line": 7579, - "end_line": 7583, + "example": 492, + "start_line": 7616, + "end_line": 7620, "section": "Links" }, { "markdown": "[a](\n[a](c)\n", "html": "

[a](<b)c\n[a](<b)c>\n[a](c)

\n", - "example": 491, - "start_line": 7588, - "end_line": 7596, + "example": 493, + "start_line": 7625, + "end_line": 7633, "section": "Links" }, { "markdown": "[link](\\(foo\\))\n", "html": "

link

\n", - "example": 492, - "start_line": 7600, - "end_line": 7604, + "example": 494, + "start_line": 7637, + "end_line": 7641, "section": "Links" }, { "markdown": "[link](foo(and(bar)))\n", "html": "

link

\n", - "example": 493, - "start_line": 7609, - "end_line": 7613, + "example": 495, + "start_line": 7646, + "end_line": 7650, + "section": "Links" + }, + { + "markdown": "[link](foo(and(bar))\n", + "html": "

[link](foo(and(bar))

\n", + "example": 496, + "start_line": 7655, + "end_line": 7659, "section": "Links" }, { "markdown": "[link](foo\\(and\\(bar\\))\n", "html": "

link

\n", - "example": 494, - "start_line": 7618, - "end_line": 7622, + "example": 497, + "start_line": 7662, + "end_line": 7666, "section": "Links" }, { "markdown": "[link]()\n", "html": "

link

\n", - "example": 495, - "start_line": 7625, - "end_line": 7629, + "example": 498, + "start_line": 7669, + "end_line": 7673, "section": "Links" }, { "markdown": "[link](foo\\)\\:)\n", "html": "

link

\n", - "example": 496, - "start_line": 7635, - "end_line": 7639, + "example": 499, + "start_line": 7679, + "end_line": 7683, "section": "Links" }, { "markdown": "[link](#fragment)\n\n[link](http://example.com#fragment)\n\n[link](http://example.com?foo=3#frag)\n", "html": "

link

\n

link

\n

link

\n", - "example": 497, - "start_line": 7644, - "end_line": 7654, + "example": 500, + "start_line": 7688, + "end_line": 7698, "section": "Links" }, { "markdown": "[link](foo\\bar)\n", "html": "

link

\n", - "example": 498, - "start_line": 7660, - "end_line": 7664, + "example": 501, + "start_line": 7704, + "end_line": 7708, "section": "Links" }, { "markdown": "[link](foo%20bä)\n", "html": "

link

\n", - "example": 499, - "start_line": 7676, - "end_line": 7680, + "example": 502, + "start_line": 7720, + "end_line": 7724, "section": "Links" }, { "markdown": "[link](\"title\")\n", "html": "

link

\n", - "example": 500, - "start_line": 7687, - "end_line": 7691, + "example": 503, + "start_line": 7731, + "end_line": 7735, "section": "Links" }, { "markdown": "[link](/url \"title\")\n[link](/url 'title')\n[link](/url (title))\n", "html": "

link\nlink\nlink

\n", - "example": 501, - "start_line": 7696, - "end_line": 7704, + "example": 504, + "start_line": 7740, + "end_line": 7748, "section": "Links" }, { "markdown": "[link](/url \"title \\\""\")\n", "html": "

link

\n", - "example": 502, - "start_line": 7710, - "end_line": 7714, + "example": 505, + "start_line": 7754, + "end_line": 7758, "section": "Links" }, { "markdown": "[link](/url \"title\")\n", "html": "

link

\n", - "example": 503, - "start_line": 7720, - "end_line": 7724, + "example": 506, + "start_line": 7765, + "end_line": 7769, "section": "Links" }, { "markdown": "[link](/url \"title \"and\" title\")\n", "html": "

[link](/url "title "and" title")

\n", - "example": 504, - "start_line": 7729, - "end_line": 7733, + "example": 507, + "start_line": 7774, + "end_line": 7778, "section": "Links" }, { "markdown": "[link](/url 'title \"and\" title')\n", "html": "

link

\n", - "example": 505, - "start_line": 7738, - "end_line": 7742, - "section": "Links" - }, - { - "markdown": "[link]( /uri\n \"title\" )\n", - "html": "

link

\n", - "example": 506, - "start_line": 7762, - "end_line": 7767, - "section": "Links" - }, - { - "markdown": "[link] (/uri)\n", - "html": "

[link] (/uri)

\n", - "example": 507, - "start_line": 7773, - "end_line": 7777, - "section": "Links" - }, - { - "markdown": "[link [foo [bar]]](/uri)\n", - "html": "

link [foo [bar]]

\n", "example": 508, "start_line": 7783, "end_line": 7787, "section": "Links" }, + { + "markdown": "[link]( /uri\n \"title\" )\n", + "html": "

link

\n", + "example": 509, + "start_line": 7808, + "end_line": 7813, + "section": "Links" + }, + { + "markdown": "[link] (/uri)\n", + "html": "

[link] (/uri)

\n", + "example": 510, + "start_line": 7819, + "end_line": 7823, + "section": "Links" + }, + { + "markdown": "[link [foo [bar]]](/uri)\n", + "html": "

link [foo [bar]]

\n", + "example": 511, + "start_line": 7829, + "end_line": 7833, + "section": "Links" + }, { "markdown": "[link] bar](/uri)\n", "html": "

[link] bar](/uri)

\n", - "example": 509, - "start_line": 7790, - "end_line": 7794, + "example": 512, + "start_line": 7836, + "end_line": 7840, "section": "Links" }, { "markdown": "[link [bar](/uri)\n", "html": "

[link bar

\n", - "example": 510, - "start_line": 7797, - "end_line": 7801, + "example": 513, + "start_line": 7843, + "end_line": 7847, "section": "Links" }, { "markdown": "[link \\[bar](/uri)\n", "html": "

link [bar

\n", - "example": 511, - "start_line": 7804, - "end_line": 7808, + "example": 514, + "start_line": 7850, + "end_line": 7854, "section": "Links" }, { "markdown": "[link *foo **bar** `#`*](/uri)\n", "html": "

link foo bar #

\n", - "example": 512, - "start_line": 7813, - "end_line": 7817, + "example": 515, + "start_line": 7859, + "end_line": 7863, "section": "Links" }, { "markdown": "[![moon](moon.jpg)](/uri)\n", "html": "

\"moon\"

\n", - "example": 513, - "start_line": 7820, - "end_line": 7824, + "example": 516, + "start_line": 7866, + "end_line": 7870, "section": "Links" }, { "markdown": "[foo [bar](/uri)](/uri)\n", "html": "

[foo bar](/uri)

\n", - "example": 514, - "start_line": 7829, - "end_line": 7833, + "example": 517, + "start_line": 7875, + "end_line": 7879, "section": "Links" }, { "markdown": "[foo *[bar [baz](/uri)](/uri)*](/uri)\n", "html": "

[foo [bar baz](/uri)](/uri)

\n", - "example": 515, - "start_line": 7836, - "end_line": 7840, + "example": 518, + "start_line": 7882, + "end_line": 7886, "section": "Links" }, { "markdown": "![[[foo](uri1)](uri2)](uri3)\n", "html": "

\"[foo](uri2)\"

\n", - "example": 516, - "start_line": 7843, - "end_line": 7847, + "example": 519, + "start_line": 7889, + "end_line": 7893, "section": "Links" }, { "markdown": "*[foo*](/uri)\n", "html": "

*foo*

\n", - "example": 517, - "start_line": 7853, - "end_line": 7857, + "example": 520, + "start_line": 7899, + "end_line": 7903, "section": "Links" }, { "markdown": "[foo *bar](baz*)\n", "html": "

foo *bar

\n", - "example": 518, - "start_line": 7860, - "end_line": 7864, + "example": 521, + "start_line": 7906, + "end_line": 7910, "section": "Links" }, { "markdown": "*foo [bar* baz]\n", "html": "

foo [bar baz]

\n", - "example": 519, - "start_line": 7870, - "end_line": 7874, + "example": 522, + "start_line": 7916, + "end_line": 7920, "section": "Links" }, { "markdown": "[foo \n", "html": "

[foo

\n", - "example": 520, - "start_line": 7880, - "end_line": 7884, + "example": 523, + "start_line": 7926, + "end_line": 7930, "section": "Links" }, { "markdown": "[foo`](/uri)`\n", "html": "

[foo](/uri)

\n", - "example": 521, - "start_line": 7887, - "end_line": 7891, + "example": 524, + "start_line": 7933, + "end_line": 7937, "section": "Links" }, { "markdown": "[foo\n", "html": "

[foohttp://example.com/?search=](uri)

\n", - "example": 522, - "start_line": 7894, - "end_line": 7898, + "example": 525, + "start_line": 7940, + "end_line": 7944, "section": "Links" }, { "markdown": "[foo][bar]\n\n[bar]: /url \"title\"\n", "html": "

foo

\n", - "example": 523, - "start_line": 7932, - "end_line": 7938, + "example": 526, + "start_line": 7978, + "end_line": 7984, "section": "Links" }, { "markdown": "[link [foo [bar]]][ref]\n\n[ref]: /uri\n", "html": "

link [foo [bar]]

\n", - "example": 524, - "start_line": 7947, - "end_line": 7953, + "example": 527, + "start_line": 7993, + "end_line": 7999, "section": "Links" }, { "markdown": "[link \\[bar][ref]\n\n[ref]: /uri\n", "html": "

link [bar

\n", - "example": 525, - "start_line": 7956, - "end_line": 7962, + "example": 528, + "start_line": 8002, + "end_line": 8008, "section": "Links" }, { "markdown": "[link *foo **bar** `#`*][ref]\n\n[ref]: /uri\n", "html": "

link foo bar #

\n", - "example": 526, - "start_line": 7967, - "end_line": 7973, + "example": 529, + "start_line": 8013, + "end_line": 8019, "section": "Links" }, { "markdown": "[![moon](moon.jpg)][ref]\n\n[ref]: /uri\n", "html": "

\"moon\"

\n", - "example": 527, - "start_line": 7976, - "end_line": 7982, + "example": 530, + "start_line": 8022, + "end_line": 8028, "section": "Links" }, { "markdown": "[foo [bar](/uri)][ref]\n\n[ref]: /uri\n", "html": "

[foo bar]ref

\n", - "example": 528, - "start_line": 7987, - "end_line": 7993, + "example": 531, + "start_line": 8033, + "end_line": 8039, "section": "Links" }, { "markdown": "[foo *bar [baz][ref]*][ref]\n\n[ref]: /uri\n", "html": "

[foo bar baz]ref

\n", - "example": 529, - "start_line": 7996, - "end_line": 8002, + "example": 532, + "start_line": 8042, + "end_line": 8048, "section": "Links" }, { "markdown": "*[foo*][ref]\n\n[ref]: /uri\n", "html": "

*foo*

\n", - "example": 530, - "start_line": 8011, - "end_line": 8017, + "example": 533, + "start_line": 8057, + "end_line": 8063, "section": "Links" }, { - "markdown": "[foo *bar][ref]\n\n[ref]: /uri\n", - "html": "

foo *bar

\n", - "example": 531, - "start_line": 8020, - "end_line": 8026, + "markdown": "[foo *bar][ref]*\n\n[ref]: /uri\n", + "html": "

foo *bar*

\n", + "example": 534, + "start_line": 8066, + "end_line": 8072, "section": "Links" }, { "markdown": "[foo \n\n[ref]: /uri\n", "html": "

[foo

\n", - "example": 532, - "start_line": 8032, - "end_line": 8038, + "example": 535, + "start_line": 8078, + "end_line": 8084, "section": "Links" }, { "markdown": "[foo`][ref]`\n\n[ref]: /uri\n", "html": "

[foo][ref]

\n", - "example": 533, - "start_line": 8041, - "end_line": 8047, + "example": 536, + "start_line": 8087, + "end_line": 8093, "section": "Links" }, { "markdown": "[foo\n\n[ref]: /uri\n", "html": "

[foohttp://example.com/?search=][ref]

\n", - "example": 534, - "start_line": 8050, - "end_line": 8056, + "example": 537, + "start_line": 8096, + "end_line": 8102, "section": "Links" }, { "markdown": "[foo][BaR]\n\n[bar]: /url \"title\"\n", "html": "

foo

\n", - "example": 535, - "start_line": 8061, - "end_line": 8067, + "example": 538, + "start_line": 8107, + "end_line": 8113, "section": "Links" }, { - "markdown": "[Толпой][Толпой] is a Russian word.\n\n[ТОЛПОЙ]: /url\n", - "html": "

Толпой is a Russian word.

\n", - "example": 536, - "start_line": 8072, - "end_line": 8078, + "markdown": "[ẞ]\n\n[SS]: /url\n", + "html": "

ẞ

\n", + "example": 539, + "start_line": 8118, + "end_line": 8124, "section": "Links" }, { "markdown": "[Foo\n bar]: /url\n\n[Baz][Foo bar]\n", "html": "

Baz

\n", - "example": 537, - "start_line": 8084, - "end_line": 8091, + "example": 540, + "start_line": 8130, + "end_line": 8137, "section": "Links" }, { "markdown": "[foo] [bar]\n\n[bar]: /url \"title\"\n", "html": "

[foo] bar

\n", - "example": 538, - "start_line": 8097, - "end_line": 8103, + "example": 541, + "start_line": 8143, + "end_line": 8149, "section": "Links" }, { "markdown": "[foo]\n[bar]\n\n[bar]: /url \"title\"\n", "html": "

[foo]\nbar

\n", - "example": 539, - "start_line": 8106, - "end_line": 8114, + "example": 542, + "start_line": 8152, + "end_line": 8160, "section": "Links" }, { "markdown": "[foo]: /url1\n\n[foo]: /url2\n\n[bar][foo]\n", "html": "

bar

\n", - "example": 540, - "start_line": 8147, - "end_line": 8155, + "example": 543, + "start_line": 8193, + "end_line": 8201, "section": "Links" }, { "markdown": "[bar][foo\\!]\n\n[foo!]: /url\n", "html": "

[bar][foo!]

\n", - "example": 541, - "start_line": 8162, - "end_line": 8168, + "example": 544, + "start_line": 8208, + "end_line": 8214, "section": "Links" }, { "markdown": "[foo][ref[]\n\n[ref[]: /uri\n", "html": "

[foo][ref[]

\n

[ref[]: /uri

\n", - "example": 542, - "start_line": 8174, - "end_line": 8181, + "example": 545, + "start_line": 8220, + "end_line": 8227, "section": "Links" }, { "markdown": "[foo][ref[bar]]\n\n[ref[bar]]: /uri\n", "html": "

[foo][ref[bar]]

\n

[ref[bar]]: /uri

\n", - "example": 543, - "start_line": 8184, - "end_line": 8191, + "example": 546, + "start_line": 8230, + "end_line": 8237, "section": "Links" }, { "markdown": "[[[foo]]]\n\n[[[foo]]]: /url\n", "html": "

[[[foo]]]

\n

[[[foo]]]: /url

\n", - "example": 544, - "start_line": 8194, - "end_line": 8201, + "example": 547, + "start_line": 8240, + "end_line": 8247, "section": "Links" }, { "markdown": "[foo][ref\\[]\n\n[ref\\[]: /uri\n", "html": "

foo

\n", - "example": 545, - "start_line": 8204, - "end_line": 8210, + "example": 548, + "start_line": 8250, + "end_line": 8256, "section": "Links" }, { "markdown": "[bar\\\\]: /uri\n\n[bar\\\\]\n", "html": "

bar\\

\n", - "example": 546, - "start_line": 8215, - "end_line": 8221, + "example": 549, + "start_line": 8261, + "end_line": 8267, "section": "Links" }, { "markdown": "[]\n\n[]: /uri\n", "html": "

[]

\n

[]: /uri

\n", - "example": 547, - "start_line": 8226, - "end_line": 8233, + "example": 550, + "start_line": 8273, + "end_line": 8280, "section": "Links" }, { "markdown": "[\n ]\n\n[\n ]: /uri\n", "html": "

[\n]

\n

[\n]: /uri

\n", - "example": 548, - "start_line": 8236, - "end_line": 8247, + "example": 551, + "start_line": 8283, + "end_line": 8294, "section": "Links" }, { "markdown": "[foo][]\n\n[foo]: /url \"title\"\n", "html": "

foo

\n", - "example": 549, - "start_line": 8259, - "end_line": 8265, + "example": 552, + "start_line": 8306, + "end_line": 8312, "section": "Links" }, { "markdown": "[*foo* bar][]\n\n[*foo* bar]: /url \"title\"\n", "html": "

foo bar

\n", - "example": 550, - "start_line": 8268, - "end_line": 8274, + "example": 553, + "start_line": 8315, + "end_line": 8321, "section": "Links" }, { "markdown": "[Foo][]\n\n[foo]: /url \"title\"\n", "html": "

Foo

\n", - "example": 551, - "start_line": 8279, - "end_line": 8285, + "example": 554, + "start_line": 8326, + "end_line": 8332, "section": "Links" }, { "markdown": "[foo] \n[]\n\n[foo]: /url \"title\"\n", "html": "

foo\n[]

\n", - "example": 552, - "start_line": 8292, - "end_line": 8300, + "example": 555, + "start_line": 8339, + "end_line": 8347, "section": "Links" }, { "markdown": "[foo]\n\n[foo]: /url \"title\"\n", "html": "

foo

\n", - "example": 553, - "start_line": 8312, - "end_line": 8318, + "example": 556, + "start_line": 8359, + "end_line": 8365, "section": "Links" }, { "markdown": "[*foo* bar]\n\n[*foo* bar]: /url \"title\"\n", "html": "

foo bar

\n", - "example": 554, - "start_line": 8321, - "end_line": 8327, + "example": 557, + "start_line": 8368, + "end_line": 8374, "section": "Links" }, { "markdown": "[[*foo* bar]]\n\n[*foo* bar]: /url \"title\"\n", "html": "

[foo bar]

\n", - "example": 555, - "start_line": 8330, - "end_line": 8336, + "example": 558, + "start_line": 8377, + "end_line": 8383, "section": "Links" }, { "markdown": "[[bar [foo]\n\n[foo]: /url\n", "html": "

[[bar foo

\n", - "example": 556, - "start_line": 8339, - "end_line": 8345, + "example": 559, + "start_line": 8386, + "end_line": 8392, "section": "Links" }, { "markdown": "[Foo]\n\n[foo]: /url \"title\"\n", "html": "

Foo

\n", - "example": 557, - "start_line": 8350, - "end_line": 8356, + "example": 560, + "start_line": 8397, + "end_line": 8403, "section": "Links" }, { "markdown": "[foo] bar\n\n[foo]: /url\n", "html": "

foo bar

\n", - "example": 558, - "start_line": 8361, - "end_line": 8367, + "example": 561, + "start_line": 8408, + "end_line": 8414, "section": "Links" }, { "markdown": "\\[foo]\n\n[foo]: /url \"title\"\n", "html": "

[foo]

\n", - "example": 559, - "start_line": 8373, - "end_line": 8379, + "example": 562, + "start_line": 8420, + "end_line": 8426, "section": "Links" }, { "markdown": "[foo*]: /url\n\n*[foo*]\n", "html": "

*foo*

\n", - "example": 560, - "start_line": 8385, - "end_line": 8391, + "example": 563, + "start_line": 8432, + "end_line": 8438, "section": "Links" }, { "markdown": "[foo][bar]\n\n[foo]: /url1\n[bar]: /url2\n", "html": "

foo

\n", - "example": 561, - "start_line": 8397, - "end_line": 8404, + "example": 564, + "start_line": 8444, + "end_line": 8451, "section": "Links" }, { "markdown": "[foo][]\n\n[foo]: /url1\n", "html": "

foo

\n", - "example": 562, - "start_line": 8406, - "end_line": 8412, + "example": 565, + "start_line": 8453, + "end_line": 8459, "section": "Links" }, { "markdown": "[foo]()\n\n[foo]: /url1\n", "html": "

foo

\n", - "example": 563, - "start_line": 8416, - "end_line": 8422, + "example": 566, + "start_line": 8463, + "end_line": 8469, "section": "Links" }, { "markdown": "[foo](not a link)\n\n[foo]: /url1\n", "html": "

foo(not a link)

\n", - "example": 564, - "start_line": 8424, - "end_line": 8430, + "example": 567, + "start_line": 8471, + "end_line": 8477, "section": "Links" }, { "markdown": "[foo][bar][baz]\n\n[baz]: /url\n", "html": "

[foo]bar

\n", - "example": 565, - "start_line": 8435, - "end_line": 8441, + "example": 568, + "start_line": 8482, + "end_line": 8488, "section": "Links" }, { "markdown": "[foo][bar][baz]\n\n[baz]: /url1\n[bar]: /url2\n", "html": "

foobaz

\n", - "example": 566, - "start_line": 8447, - "end_line": 8454, + "example": 569, + "start_line": 8494, + "end_line": 8501, "section": "Links" }, { "markdown": "[foo][bar][baz]\n\n[baz]: /url1\n[foo]: /url2\n", "html": "

[foo]bar

\n", - "example": 567, - "start_line": 8460, - "end_line": 8467, + "example": 570, + "start_line": 8507, + "end_line": 8514, "section": "Links" }, { "markdown": "![foo](/url \"title\")\n", "html": "

\"foo\"

\n", - "example": 568, - "start_line": 8483, - "end_line": 8487, + "example": 571, + "start_line": 8530, + "end_line": 8534, "section": "Images" }, { "markdown": "![foo *bar*]\n\n[foo *bar*]: train.jpg \"train & tracks\"\n", "html": "

\"foo

\n", - "example": 569, - "start_line": 8490, - "end_line": 8496, + "example": 572, + "start_line": 8537, + "end_line": 8543, "section": "Images" }, { "markdown": "![foo ![bar](/url)](/url2)\n", "html": "

\"foo

\n", - "example": 570, - "start_line": 8499, - "end_line": 8503, + "example": 573, + "start_line": 8546, + "end_line": 8550, "section": "Images" }, { "markdown": "![foo [bar](/url)](/url2)\n", "html": "

\"foo

\n", - "example": 571, - "start_line": 8506, - "end_line": 8510, + "example": 574, + "start_line": 8553, + "end_line": 8557, "section": "Images" }, { "markdown": "![foo *bar*][]\n\n[foo *bar*]: train.jpg \"train & tracks\"\n", "html": "

\"foo

\n", - "example": 572, - "start_line": 8520, - "end_line": 8526, + "example": 575, + "start_line": 8567, + "end_line": 8573, "section": "Images" }, { "markdown": "![foo *bar*][foobar]\n\n[FOOBAR]: train.jpg \"train & tracks\"\n", "html": "

\"foo

\n", - "example": 573, - "start_line": 8529, - "end_line": 8535, + "example": 576, + "start_line": 8576, + "end_line": 8582, "section": "Images" }, { "markdown": "![foo](train.jpg)\n", "html": "

\"foo\"

\n", - "example": 574, - "start_line": 8538, - "end_line": 8542, + "example": 577, + "start_line": 8585, + "end_line": 8589, "section": "Images" }, { "markdown": "My ![foo bar](/path/to/train.jpg \"title\" )\n", "html": "

My \"foo

\n", - "example": 575, - "start_line": 8545, - "end_line": 8549, + "example": 578, + "start_line": 8592, + "end_line": 8596, "section": "Images" }, { "markdown": "![foo]()\n", "html": "

\"foo\"

\n", - "example": 576, - "start_line": 8552, - "end_line": 8556, + "example": 579, + "start_line": 8599, + "end_line": 8603, "section": "Images" }, { "markdown": "![](/url)\n", "html": "

\"\"

\n", - "example": 577, - "start_line": 8559, - "end_line": 8563, + "example": 580, + "start_line": 8606, + "end_line": 8610, "section": "Images" }, { "markdown": "![foo][bar]\n\n[bar]: /url\n", "html": "

\"foo\"

\n", - "example": 578, - "start_line": 8568, - "end_line": 8574, + "example": 581, + "start_line": 8615, + "end_line": 8621, "section": "Images" }, { "markdown": "![foo][bar]\n\n[BAR]: /url\n", "html": "

\"foo\"

\n", - "example": 579, - "start_line": 8577, - "end_line": 8583, + "example": 582, + "start_line": 8624, + "end_line": 8630, "section": "Images" }, { "markdown": "![foo][]\n\n[foo]: /url \"title\"\n", "html": "

\"foo\"

\n", - "example": 580, - "start_line": 8588, - "end_line": 8594, + "example": 583, + "start_line": 8635, + "end_line": 8641, "section": "Images" }, { "markdown": "![*foo* bar][]\n\n[*foo* bar]: /url \"title\"\n", "html": "

\"foo

\n", - "example": 581, - "start_line": 8597, - "end_line": 8603, + "example": 584, + "start_line": 8644, + "end_line": 8650, "section": "Images" }, { "markdown": "![Foo][]\n\n[foo]: /url \"title\"\n", "html": "

\"Foo\"

\n", - "example": 582, - "start_line": 8608, - "end_line": 8614, + "example": 585, + "start_line": 8655, + "end_line": 8661, "section": "Images" }, { "markdown": "![foo] \n[]\n\n[foo]: /url \"title\"\n", "html": "

\"foo\"\n[]

\n", - "example": 583, - "start_line": 8620, - "end_line": 8628, + "example": 586, + "start_line": 8667, + "end_line": 8675, "section": "Images" }, { "markdown": "![foo]\n\n[foo]: /url \"title\"\n", "html": "

\"foo\"

\n", - "example": 584, - "start_line": 8633, - "end_line": 8639, + "example": 587, + "start_line": 8680, + "end_line": 8686, "section": "Images" }, { "markdown": "![*foo* bar]\n\n[*foo* bar]: /url \"title\"\n", "html": "

\"foo

\n", - "example": 585, - "start_line": 8642, - "end_line": 8648, + "example": 588, + "start_line": 8689, + "end_line": 8695, "section": "Images" }, { "markdown": "![[foo]]\n\n[[foo]]: /url \"title\"\n", "html": "

![[foo]]

\n

[[foo]]: /url "title"

\n", - "example": 586, - "start_line": 8653, - "end_line": 8660, + "example": 589, + "start_line": 8700, + "end_line": 8707, "section": "Images" }, { "markdown": "![Foo]\n\n[foo]: /url \"title\"\n", "html": "

\"Foo\"

\n", - "example": 587, - "start_line": 8665, - "end_line": 8671, + "example": 590, + "start_line": 8712, + "end_line": 8718, "section": "Images" }, { "markdown": "!\\[foo]\n\n[foo]: /url \"title\"\n", "html": "

![foo]

\n", - "example": 588, - "start_line": 8677, - "end_line": 8683, + "example": 591, + "start_line": 8724, + "end_line": 8730, "section": "Images" }, { "markdown": "\\![foo]\n\n[foo]: /url \"title\"\n", "html": "

!foo

\n", - "example": 589, - "start_line": 8689, - "end_line": 8695, + "example": 592, + "start_line": 8736, + "end_line": 8742, "section": "Images" }, { "markdown": "\n", "html": "

http://foo.bar.baz

\n", - "example": 590, - "start_line": 8722, - "end_line": 8726, + "example": 593, + "start_line": 8769, + "end_line": 8773, "section": "Autolinks" }, { "markdown": "\n", "html": "

http://foo.bar.baz/test?q=hello&id=22&boolean

\n", - "example": 591, - "start_line": 8729, - "end_line": 8733, + "example": 594, + "start_line": 8776, + "end_line": 8780, "section": "Autolinks" }, { "markdown": "\n", "html": "

irc://foo.bar:2233/baz

\n", - "example": 592, - "start_line": 8736, - "end_line": 8740, + "example": 595, + "start_line": 8783, + "end_line": 8787, "section": "Autolinks" }, { "markdown": "\n", "html": "

MAILTO:FOO@BAR.BAZ

\n", - "example": 593, - "start_line": 8745, - "end_line": 8749, + "example": 596, + "start_line": 8792, + "end_line": 8796, "section": "Autolinks" }, { "markdown": "\n", "html": "

a+b+c:d

\n", - "example": 594, - "start_line": 8757, - "end_line": 8761, + "example": 597, + "start_line": 8804, + "end_line": 8808, "section": "Autolinks" }, { "markdown": "\n", "html": "

made-up-scheme://foo,bar

\n", - "example": 595, - "start_line": 8764, - "end_line": 8768, + "example": 598, + "start_line": 8811, + "end_line": 8815, "section": "Autolinks" }, { "markdown": "\n", "html": "

http://../

\n", - "example": 596, - "start_line": 8771, - "end_line": 8775, + "example": 599, + "start_line": 8818, + "end_line": 8822, "section": "Autolinks" }, { "markdown": "\n", "html": "

localhost:5001/foo

\n", - "example": 597, - "start_line": 8778, - "end_line": 8782, + "example": 600, + "start_line": 8825, + "end_line": 8829, "section": "Autolinks" }, { "markdown": "\n", "html": "

<http://foo.bar/baz bim>

\n", - "example": 598, - "start_line": 8787, - "end_line": 8791, + "example": 601, + "start_line": 8834, + "end_line": 8838, "section": "Autolinks" }, { "markdown": "\n", "html": "

http://example.com/\\[\\

\n", - "example": 599, - "start_line": 8796, - "end_line": 8800, + "example": 602, + "start_line": 8843, + "end_line": 8847, "section": "Autolinks" }, { "markdown": "\n", "html": "

foo@bar.example.com

\n", - "example": 600, - "start_line": 8818, - "end_line": 8822, + "example": 603, + "start_line": 8865, + "end_line": 8869, "section": "Autolinks" }, { "markdown": "\n", "html": "

foo+special@Bar.baz-bar0.com

\n", - "example": 601, - "start_line": 8825, - "end_line": 8829, + "example": 604, + "start_line": 8872, + "end_line": 8876, "section": "Autolinks" }, { "markdown": "\n", "html": "

<foo+@bar.example.com>

\n", - "example": 602, - "start_line": 8834, - "end_line": 8838, + "example": 605, + "start_line": 8881, + "end_line": 8885, "section": "Autolinks" }, { "markdown": "<>\n", "html": "

<>

\n", - "example": 603, - "start_line": 8843, - "end_line": 8847, + "example": 606, + "start_line": 8890, + "end_line": 8894, "section": "Autolinks" }, { "markdown": "< http://foo.bar >\n", "html": "

< http://foo.bar >

\n", - "example": 604, - "start_line": 8850, - "end_line": 8854, + "example": 607, + "start_line": 8897, + "end_line": 8901, "section": "Autolinks" }, { "markdown": "\n", "html": "

<m:abc>

\n", - "example": 605, - "start_line": 8857, - "end_line": 8861, + "example": 608, + "start_line": 8904, + "end_line": 8908, "section": "Autolinks" }, { "markdown": "\n", "html": "

<foo.bar.baz>

\n", - "example": 606, - "start_line": 8864, - "end_line": 8868, + "example": 609, + "start_line": 8911, + "end_line": 8915, "section": "Autolinks" }, { "markdown": "http://example.com\n", "html": "

http://example.com

\n", - "example": 607, - "start_line": 8871, - "end_line": 8875, + "example": 610, + "start_line": 8918, + "end_line": 8922, "section": "Autolinks" }, { "markdown": "foo@bar.example.com\n", "html": "

foo@bar.example.com

\n", - "example": 608, - "start_line": 8878, - "end_line": 8882, + "example": 611, + "start_line": 8925, + "end_line": 8929, "section": "Autolinks" }, { "markdown": "\n", "html": "

\n", - "example": 609, - "start_line": 8960, - "end_line": 8964, + "example": 612, + "start_line": 9006, + "end_line": 9010, "section": "Raw HTML" }, { "markdown": "\n", "html": "

\n", - "example": 610, - "start_line": 8969, - "end_line": 8973, + "example": 613, + "start_line": 9015, + "end_line": 9019, "section": "Raw HTML" }, { "markdown": "\n", "html": "

\n", - "example": 611, - "start_line": 8978, - "end_line": 8984, + "example": 614, + "start_line": 9024, + "end_line": 9030, "section": "Raw HTML" }, { "markdown": "\n", "html": "

\n", - "example": 612, - "start_line": 8989, - "end_line": 8995, + "example": 615, + "start_line": 9035, + "end_line": 9041, "section": "Raw HTML" }, { "markdown": "Foo \n", "html": "

Foo

\n", - "example": 613, - "start_line": 9000, - "end_line": 9004, + "example": 616, + "start_line": 9046, + "end_line": 9050, "section": "Raw HTML" }, { "markdown": "<33> <__>\n", "html": "

<33> <__>

\n", - "example": 614, - "start_line": 9009, - "end_line": 9013, + "example": 617, + "start_line": 9055, + "end_line": 9059, "section": "Raw HTML" }, { "markdown": "\n", "html": "

<a h*#ref="hi">

\n", - "example": 615, - "start_line": 9018, - "end_line": 9022, + "example": 618, + "start_line": 9064, + "end_line": 9068, "section": "Raw HTML" }, { "markdown": " \n", "html": "

<a href="hi'> <a href=hi'>

\n", - "example": 616, - "start_line": 9027, - "end_line": 9031, + "example": 619, + "start_line": 9073, + "end_line": 9077, "section": "Raw HTML" }, { "markdown": "< a><\nfoo>\n\n", "html": "

< a><\nfoo><bar/ >\n<foo bar=baz\nbim!bop />

\n", - "example": 617, - "start_line": 9036, - "end_line": 9046, + "example": 620, + "start_line": 9082, + "end_line": 9092, "section": "Raw HTML" }, { "markdown": "\n", "html": "

<a href='bar'title=title>

\n", - "example": 618, - "start_line": 9051, - "end_line": 9055, + "example": 621, + "start_line": 9097, + "end_line": 9101, "section": "Raw HTML" }, { "markdown": "\n", "html": "

\n", - "example": 619, - "start_line": 9060, - "end_line": 9064, + "example": 622, + "start_line": 9106, + "end_line": 9110, "section": "Raw HTML" }, { "markdown": "\n", "html": "

</a href="foo">

\n", - "example": 620, - "start_line": 9069, - "end_line": 9073, + "example": 623, + "start_line": 9115, + "end_line": 9119, "section": "Raw HTML" }, { "markdown": "foo \n", "html": "

foo

\n", - "example": 621, - "start_line": 9078, - "end_line": 9084, + "example": 624, + "start_line": 9124, + "end_line": 9130, "section": "Raw HTML" }, { "markdown": "foo \n", "html": "

foo <!-- not a comment -- two hyphens -->

\n", - "example": 622, - "start_line": 9087, - "end_line": 9091, + "example": 625, + "start_line": 9133, + "end_line": 9137, "section": "Raw HTML" }, { "markdown": "foo foo -->\n\nfoo \n", "html": "

foo <!--> foo -->

\n

foo <!-- foo--->

\n", - "example": 623, - "start_line": 9096, - "end_line": 9103, + "example": 626, + "start_line": 9142, + "end_line": 9149, "section": "Raw HTML" }, { "markdown": "foo \n", "html": "

foo

\n", - "example": 624, - "start_line": 9108, - "end_line": 9112, + "example": 627, + "start_line": 9154, + "end_line": 9158, "section": "Raw HTML" }, { "markdown": "foo \n", "html": "

foo

\n", - "example": 625, - "start_line": 9117, - "end_line": 9121, + "example": 628, + "start_line": 9163, + "end_line": 9167, "section": "Raw HTML" }, { "markdown": "foo &<]]>\n", "html": "

foo &<]]>

\n", - "example": 626, - "start_line": 9126, - "end_line": 9130, + "example": 629, + "start_line": 9172, + "end_line": 9176, "section": "Raw HTML" }, { "markdown": "foo \n", "html": "

foo

\n", - "example": 627, - "start_line": 9136, - "end_line": 9140, + "example": 630, + "start_line": 9182, + "end_line": 9186, "section": "Raw HTML" }, { "markdown": "foo \n", "html": "

foo

\n", - "example": 628, - "start_line": 9145, - "end_line": 9149, + "example": 631, + "start_line": 9191, + "end_line": 9195, "section": "Raw HTML" }, { "markdown": "\n", "html": "

<a href=""">

\n", - "example": 629, - "start_line": 9152, - "end_line": 9156, + "example": 632, + "start_line": 9198, + "end_line": 9202, "section": "Raw HTML" }, { "markdown": "foo \nbaz\n", "html": "

foo
\nbaz

\n", - "example": 630, - "start_line": 9166, - "end_line": 9172, + "example": 633, + "start_line": 9212, + "end_line": 9218, "section": "Hard line breaks" }, { "markdown": "foo\\\nbaz\n", "html": "

foo
\nbaz

\n", - "example": 631, - "start_line": 9178, - "end_line": 9184, + "example": 634, + "start_line": 9224, + "end_line": 9230, "section": "Hard line breaks" }, { "markdown": "foo \nbaz\n", "html": "

foo
\nbaz

\n", - "example": 632, - "start_line": 9189, - "end_line": 9195, + "example": 635, + "start_line": 9235, + "end_line": 9241, "section": "Hard line breaks" }, { "markdown": "foo \n bar\n", "html": "

foo
\nbar

\n", - "example": 633, - "start_line": 9200, - "end_line": 9206, + "example": 636, + "start_line": 9246, + "end_line": 9252, "section": "Hard line breaks" }, { "markdown": "foo\\\n bar\n", "html": "

foo
\nbar

\n", - "example": 634, - "start_line": 9209, - "end_line": 9215, + "example": 637, + "start_line": 9255, + "end_line": 9261, "section": "Hard line breaks" }, { "markdown": "*foo \nbar*\n", "html": "

foo
\nbar

\n", - "example": 635, - "start_line": 9221, - "end_line": 9227, + "example": 638, + "start_line": 9267, + "end_line": 9273, "section": "Hard line breaks" }, { "markdown": "*foo\\\nbar*\n", "html": "

foo
\nbar

\n", - "example": 636, - "start_line": 9230, - "end_line": 9236, + "example": 639, + "start_line": 9276, + "end_line": 9282, "section": "Hard line breaks" }, { - "markdown": "`code \nspan`\n", - "html": "

code span

\n", - "example": 637, - "start_line": 9241, - "end_line": 9246, + "markdown": "`code \nspan`\n", + "html": "

code span

\n", + "example": 640, + "start_line": 9287, + "end_line": 9292, "section": "Hard line breaks" }, { "markdown": "`code\\\nspan`\n", "html": "

code\\ span

\n", - "example": 638, - "start_line": 9249, - "end_line": 9254, + "example": 641, + "start_line": 9295, + "end_line": 9300, "section": "Hard line breaks" }, { "markdown": "\n", "html": "

\n", - "example": 639, - "start_line": 9259, - "end_line": 9265, + "example": 642, + "start_line": 9305, + "end_line": 9311, "section": "Hard line breaks" }, { "markdown": "\n", "html": "

\n", - "example": 640, - "start_line": 9268, - "end_line": 9274, + "example": 643, + "start_line": 9314, + "end_line": 9320, "section": "Hard line breaks" }, { "markdown": "foo\\\n", "html": "

foo\\

\n", - "example": 641, - "start_line": 9281, - "end_line": 9285, + "example": 644, + "start_line": 9327, + "end_line": 9331, "section": "Hard line breaks" }, { "markdown": "foo \n", "html": "

foo

\n", - "example": 642, - "start_line": 9288, - "end_line": 9292, + "example": 645, + "start_line": 9334, + "end_line": 9338, "section": "Hard line breaks" }, { "markdown": "### foo\\\n", "html": "

foo\\

\n", - "example": 643, - "start_line": 9295, - "end_line": 9299, + "example": 646, + "start_line": 9341, + "end_line": 9345, "section": "Hard line breaks" }, { "markdown": "### foo \n", "html": "

foo

\n", - "example": 644, - "start_line": 9302, - "end_line": 9306, + "example": 647, + "start_line": 9348, + "end_line": 9352, "section": "Hard line breaks" }, { "markdown": "foo\nbaz\n", "html": "

foo\nbaz

\n", - "example": 645, - "start_line": 9317, - "end_line": 9323, + "example": 648, + "start_line": 9363, + "end_line": 9369, "section": "Soft line breaks" }, { "markdown": "foo \n baz\n", "html": "

foo\nbaz

\n", - "example": 646, - "start_line": 9329, - "end_line": 9335, + "example": 649, + "start_line": 9375, + "end_line": 9381, "section": "Soft line breaks" }, { "markdown": "hello $.;'there\n", "html": "

hello $.;'there

\n", - "example": 647, - "start_line": 9349, - "end_line": 9353, + "example": 650, + "start_line": 9395, + "end_line": 9399, "section": "Textual content" }, { "markdown": "Foo χρῆν\n", "html": "

Foo χρῆν

\n", - "example": 648, - "start_line": 9356, - "end_line": 9360, + "example": 651, + "start_line": 9402, + "end_line": 9406, "section": "Textual content" }, { "markdown": "Multiple spaces\n", "html": "

Multiple spaces

\n", - "example": 649, - "start_line": 9365, - "end_line": 9369, + "example": 652, + "start_line": 9411, + "end_line": 9415, "section": "Textual content" } ] ADDED testdata/testbox/00000000000100.zettel Index: testdata/testbox/00000000000100.zettel ================================================================== --- testdata/testbox/00000000000100.zettel +++ testdata/testbox/00000000000100.zettel @@ -0,0 +1,9 @@ +id: 00000000000100 +title: Zettelstore Runtime Configuration +role: configuration +syntax: none +expert-mode: true +modified: 20210629174242 +no-index: true +visibility: owner + ADDED testdata/testbox/19700101000000.zettel Index: testdata/testbox/19700101000000.zettel ================================================================== --- testdata/testbox/19700101000000.zettel +++ testdata/testbox/19700101000000.zettel @@ -0,0 +1,11 @@ +id: 19700101000000 +title: Startup Configuration +role: configuration +tags: #invisible +syntax: none +box-uri-1: mem: +box-uri-2: dir:testdata/testbox?readonly +modified: 20210629174022 +owner: 20210629163300 +token-lifetime-api: 1 +visibility: owner ADDED testdata/testbox/20210629163300.zettel Index: testdata/testbox/20210629163300.zettel ================================================================== --- testdata/testbox/20210629163300.zettel +++ testdata/testbox/20210629163300.zettel @@ -0,0 +1,8 @@ +id: 20210629163300 +title: owner +role: user +tags: #test #user +syntax: none +credential: $2a$10$gcKyVmQ50fwgpOjyiiCm4eba/ILrNXoxTUCopgTEnYTa4yuceHMC6 +modified: 20210629173617 +user-id: owner ADDED testdata/testbox/20210629165000.zettel Index: testdata/testbox/20210629165000.zettel ================================================================== --- testdata/testbox/20210629165000.zettel +++ testdata/testbox/20210629165000.zettel @@ -0,0 +1,9 @@ +id: 20210629165000 +title: writer +role: user +tags: #test #user +syntax: none +credential: $2a$10$VmHPyXa0Bm8DE4MJ.pQnbuuQmweWtyGya0L/bFA4nIuCn1EvPQflK +modified: 20210629173536 +user-id: writer +user-role: writer ADDED testdata/testbox/20210629165024.zettel Index: testdata/testbox/20210629165024.zettel ================================================================== --- testdata/testbox/20210629165024.zettel +++ testdata/testbox/20210629165024.zettel @@ -0,0 +1,9 @@ +id: 20210629165024 +title: reader +role: user +tags: #test #user +syntax: none +credential: $2a$10$uC7LV2JdFhasw2HqSWZbSOihvFpwtaEXjXp98yzGfE3FHudq.vg.u +modified: 20210629173459 +user-id: reader +user-role: reader ADDED testdata/testbox/20210629165050.zettel Index: testdata/testbox/20210629165050.zettel ================================================================== --- testdata/testbox/20210629165050.zettel +++ testdata/testbox/20210629165050.zettel @@ -0,0 +1,9 @@ +id: 20210629165050 +title: creator +role: user +tags: #test #user +syntax: none +credential: $2a$10$z85253tqhbHlXPZpt0hJpughLR4WXY8iYJbm1LlBhrKsL1YfkRy2q +modified: 20210629173424 +user-id: creator +user-role: creator Index: tests/markdown_test.go ================================================================== --- tests/markdown_test.go +++ tests/markdown_test.go @@ -17,10 +17,11 @@ "os" "regexp" "strings" "testing" + "zettelstore.de/z/api" "zettelstore.de/z/ast" "zettelstore.de/z/encoder" _ "zettelstore.de/z/encoder/htmlenc" _ "zettelstore.de/z/encoder/jsonenc" _ "zettelstore.de/z/encoder/nativeenc" @@ -42,36 +43,37 @@ } // exceptions lists all CommonMark tests that should not be tested for identical HTML output var exceptions = []string{ " - foo\n - bar\n\t - baz\n", // 9 - "\nokay\n", // 140 - "1. *bar*\n", // 147 - "- foo\n - bar\n - baz\n - boo\n", // 264 - "10) foo\n - bar\n", // 266 - "- # Foo\n- Bar\n ---\n baz\n", // 270 - "- foo\n\n- bar\n\n\n- baz\n", // 276 - "- foo\n - bar\n - baz\n\n\n bim\n", // 277 - "1. a\n\n 2. b\n\n 3. c\n", // 281 - "1. a\n\n 2. b\n\n 3. c\n", // 283 - "- a\n- b\n\n- c\n", // 284 - "* a\n*\n\n* c\n", // 285 - "- a\n- b\n\n [ref]: /url\n- d\n", // 287 - "- a\n - b\n\n c\n- d\n", // 289 - "* a\n > b\n >\n* c\n", // 290 - "- a\n > b\n ```\n c\n ```\n- d\n", // 291 - "- a\n - b\n", // 293 - "\n", // 306 - "`\n", // 346 - "[foo\n", // 522 - "[foo\n\n[ref]: /uri\n", // 534 - "\n", // 591 + "\nokay\n", // 170 + "1. *bar*\n", // 178 + "- foo\n - bar\n - baz\n - boo\n", // 294 + "10) foo\n - bar\n", // 296 + "- # Foo\n- Bar\n ---\n baz\n", // 300 + "- foo\n\n- bar\n\n\n- baz\n", // 306 + "- foo\n - bar\n - baz\n\n\n bim\n", // 307 + "1. a\n\n 2. b\n\n 3. c\n", // 311 + "1. a\n\n 2. b\n\n 3. c\n", // 313 + "- a\n- b\n\n- c\n", // 314 + "* a\n*\n\n* c\n", // 315 + "- a\n- b\n\n [ref]: /url\n- d\n", // 317 + "- a\n - b\n\n c\n- d\n", // 319 + "* a\n > b\n >\n* c\n", // 320 + "- a\n > b\n ```\n c\n ```\n- d\n", // 321 + "- a\n - b\n", // 323 + "`\n", // 345 + "[foo\n", // 525 + "[foo\n\n[ref]: /uri\n", // 537 + "\n", // 581 + "\n", // 594 } var reHeadingID = regexp.MustCompile(` id="[^"]*"`) func TestEncoderAvailability(t *testing.T) { + t.Parallel() encoderMissing := false for _, format := range formats { enc := encoder.Create(format, nil) if enc == nil { t.Errorf("No encoder for %q found", format) @@ -82,10 +84,11 @@ panic("At least one encoder is missing. See test log") } } func TestMarkdownSpec(t *testing.T) { + t.Parallel() content, err := os.ReadFile("../testdata/markdown/spec.json") if err != nil { panic(err) } var testcases []markdownTestCase @@ -116,11 +119,11 @@ }) } } func testHTMLEncoding(t *testing.T, tc markdownTestCase, ast ast.BlockSlice) { - htmlEncoder := encoder.Create("html", &encoder.Environment{Xhtml: true}) + htmlEncoder := encoder.Create(api.EncoderHTML, &encoder.Environment{Xhtml: true}) var sb strings.Builder testID := tc.Example*100 + 1 t.Run(fmt.Sprintf("Encode md html %v", testID), func(st *testing.T) { htmlEncoder.WriteBlocks(&sb, ast) gotHTML := sb.String() @@ -141,11 +144,11 @@ } }) } func testZmkEncoding(t *testing.T, tc markdownTestCase, ast ast.BlockSlice) { - zmkEncoder := encoder.Create("zmk", nil) + zmkEncoder := encoder.Create(api.EncoderZmk, nil) var sb strings.Builder testID := tc.Example*100 + 1 t.Run(fmt.Sprintf("Encode zmk %14d", testID), func(st *testing.T) { zmkEncoder.WriteBlocks(&sb, ast) gotFirst := sb.String() Index: tests/regression_test.go ================================================================== --- tests/regression_test.go +++ tests/regression_test.go @@ -19,60 +19,66 @@ "os" "path/filepath" "strings" "testing" + "zettelstore.de/z/api" "zettelstore.de/z/ast" + "zettelstore.de/z/box" + "zettelstore.de/z/box/manager" "zettelstore.de/z/domain" "zettelstore.de/z/domain/id" "zettelstore.de/z/domain/meta" "zettelstore.de/z/encoder" "zettelstore.de/z/kernel" "zettelstore.de/z/parser" - "zettelstore.de/z/place" - "zettelstore.de/z/place/manager" + _ "zettelstore.de/z/box/dirbox" _ "zettelstore.de/z/encoder/htmlenc" _ "zettelstore.de/z/encoder/jsonenc" _ "zettelstore.de/z/encoder/nativeenc" _ "zettelstore.de/z/encoder/textenc" _ "zettelstore.de/z/encoder/zmkenc" _ "zettelstore.de/z/parser/blob" _ "zettelstore.de/z/parser/zettelmark" - _ "zettelstore.de/z/place/dirplace" ) -var formats = []string{"html", "djson", "native", "text"} +var formats = []api.EncodingEnum{ + api.EncoderHTML, + api.EncoderDJSON, + api.EncoderNative, + api.EncoderText, +} -func getFilePlaces(wd string, kind string) (root string, places []place.ManagedPlace) { +func getFileBoxes(wd, kind string) (root string, boxes []box.ManagedBox) { root = filepath.Clean(filepath.Join(wd, "..", "testdata", kind)) entries, err := os.ReadDir(root) if err != nil { panic(err) } cdata := manager.ConnectData{Config: testConfig, Enricher: &noEnrich{}, Notify: nil} for _, entry := range entries { if entry.IsDir() { - u, err := url.Parse("dir://" + filepath.Join(root, entry.Name()) + "?type=" + kernel.PlaceDirTypeSimple) + u, err := url.Parse("dir://" + filepath.Join(root, entry.Name()) + "?type=" + kernel.BoxDirTypeSimple) if err != nil { panic(err) } - place, err := manager.Connect(u, &noAuth{}, &cdata) + box, err := manager.Connect(u, &noAuth{}, &cdata) if err != nil { panic(err) } - places = append(places, place) + boxes = append(boxes, box) } } - return root, places + return root, boxes } type noEnrich struct{} -func (nf *noEnrich) Enrich(ctx context.Context, m *meta.Meta) {} -func (nf *noEnrich) Remove(ctx context.Context, m *meta.Meta) {} +func (nf *noEnrich) Enrich(context.Context, *meta.Meta, int) {} +func (nf *noEnrich) Remove(context.Context, *meta.Meta) {} type noAuth struct{} func (na *noAuth) IsReadonly() bool { return false } @@ -91,11 +97,11 @@ defer f.Close() src, err := io.ReadAll(f) return string(src), err } -func checkFileContent(t *testing.T, filename string, gotContent string) { +func checkFileContent(t *testing.T, filename, gotContent string) { t.Helper() wantContent, err := resultFile(filename) if err != nil { t.Error(err) return @@ -105,11 +111,11 @@ if gotContent != wantContent { t.Errorf("\nWant: %q\nGot: %q", wantContent, gotContent) } } -func checkBlocksFile(t *testing.T, resultName string, zn *ast.ZettelNode, format string) { +func checkBlocksFile(t *testing.T, resultName string, zn *ast.ZettelNode, format api.EncodingEnum) { t.Helper() var env encoder.Environment if enc := encoder.Create(format, &env); enc != nil { var sb strings.Builder enc.WriteBlocks(&sb, zn.Ast) @@ -118,11 +124,11 @@ } panic(fmt.Sprintf("Unknown writer format %q", format)) } func checkZmkEncoder(t *testing.T, zn *ast.ZettelNode) { - zmkEncoder := encoder.Create("zmk", nil) + zmkEncoder := encoder.Create(api.EncoderZmk, nil) var sb strings.Builder zmkEncoder.WriteBlocks(&sb, zn.Ast) gotFirst := sb.String() sb.Reset() @@ -135,22 +141,22 @@ if gotFirst != gotSecond { t.Errorf("\n1st: %q\n2nd: %q", gotFirst, gotSecond) } } -func getPlaceName(p place.ManagedPlace, root string) string { +func getBoxName(p box.ManagedBox, root string) string { u, err := url.Parse(p.Location()) if err != nil { panic("Unable to parse URL '" + p.Location() + "': " + err.Error()) } return u.Path[len(root):] } func match(*meta.Meta) bool { return true } -func checkContentPlace(t *testing.T, p place.ManagedPlace, wd, placeName string) { - ss := p.(place.StartStopper) +func checkContentBox(t *testing.T, p box.ManagedBox, wd, boxName string) { + ss := p.(box.StartStopper) if err := ss.Start(context.Background()); err != nil { panic(err) } metaList, err := p.SelectMeta(context.Background(), match) if err != nil { @@ -162,11 +168,11 @@ panic(err) } z := parser.ParseZettel(zettel, "", testConfig) for _, format := range formats { t.Run(fmt.Sprintf("%s::%d(%s)", p.Location(), meta.Zid, format), func(st *testing.T) { - resultName := filepath.Join(wd, "result", "content", placeName, z.Zid.String()+"."+format) + resultName := filepath.Join(wd, "result", "content", boxName, z.Zid.String()+"."+format.String()) checkBlocksFile(st, resultName, z, format) }) } t.Run(fmt.Sprintf("%s::%d", p.Location(), meta.Zid), func(st *testing.T) { checkZmkEncoder(st, z) @@ -176,21 +182,22 @@ panic(err) } } func TestContentRegression(t *testing.T) { + t.Parallel() wd, err := os.Getwd() if err != nil { panic(err) } - root, places := getFilePlaces(wd, "content") - for _, p := range places { - checkContentPlace(t, p, wd, getPlaceName(p, root)) + root, boxes := getFileBoxes(wd, "content") + for _, p := range boxes { + checkContentBox(t, p, wd, getBoxName(p, root)) } } -func checkMetaFile(t *testing.T, resultName string, zn *ast.ZettelNode, format string) { +func checkMetaFile(t *testing.T, resultName string, zn *ast.ZettelNode, format api.EncodingEnum) { t.Helper() if enc := encoder.Create(format, nil); enc != nil { var sb strings.Builder enc.WriteMeta(&sb, zn.Meta) @@ -198,12 +205,12 @@ return } panic(fmt.Sprintf("Unknown writer format %q", format)) } -func checkMetaPlace(t *testing.T, p place.ManagedPlace, wd, placeName string) { - ss := p.(place.StartStopper) +func checkMetaBox(t *testing.T, p box.ManagedBox, wd, boxName string) { + ss := p.(box.StartStopper) if err := ss.Start(context.Background()); err != nil { panic(err) } metaList, err := p.SelectMeta(context.Background(), match) if err != nil { @@ -215,11 +222,11 @@ panic(err) } z := parser.ParseZettel(zettel, "", testConfig) for _, format := range formats { t.Run(fmt.Sprintf("%s::%d(%s)", p.Location(), meta.Zid, format), func(st *testing.T) { - resultName := filepath.Join(wd, "result", "meta", placeName, z.Zid.String()+"."+format) + resultName := filepath.Join(wd, "result", "meta", boxName, z.Zid.String()+"."+format.String()) checkMetaFile(st, resultName, z, format) }) } } if err := ss.Stop(context.Background()); err != nil { @@ -247,14 +254,15 @@ func (cfg *myConfig) GetVisibility(*meta.Meta) meta.Visibility { return cfg.GetDefaultVisibility() } var testConfig = &myConfig{} func TestMetaRegression(t *testing.T) { + t.Parallel() wd, err := os.Getwd() if err != nil { panic(err) } - root, places := getFilePlaces(wd, "meta") - for _, p := range places { - checkMetaPlace(t, p, wd, getPlaceName(p, root)) + root, boxes := getFileBoxes(wd, "meta") + for _, p := range boxes { + checkMetaBox(t, p, wd, getBoxName(p, root)) } } Index: tools/build.go ================================================================== --- tools/build.go +++ tools/build.go @@ -12,14 +12,16 @@ package main import ( "archive/zip" "bytes" + "errors" "flag" "fmt" "io" "io/fs" + "net" "os" "os/exec" "path/filepath" "regexp" "strings" @@ -27,29 +29,38 @@ "zettelstore.de/z/strfun" ) func executeCommand(env []string, name string, arg ...string) (string, error) { + logCommand("EXEC", env, name, arg) + var out bytes.Buffer + cmd := prepareCommand(env, name, arg, &out) + err := cmd.Run() + return out.String(), err +} + +func prepareCommand(env []string, name string, arg []string, out io.Writer) *exec.Cmd { + if len(env) > 0 { + env = append(env, os.Environ()...) + } + cmd := exec.Command(name, arg...) + cmd.Env = env + cmd.Stdin = nil + cmd.Stdout = out + cmd.Stderr = os.Stderr + return cmd +} + +func logCommand(exec string, env []string, name string, arg []string) { if verbose { if len(env) > 0 { for i, e := range env { fmt.Fprintf(os.Stderr, "ENV%d %v\n", i+1, e) } } - fmt.Fprintln(os.Stderr, "EXEC", name, arg) - } - if len(env) > 0 { - env = append(env, os.Environ()...) - } - var out bytes.Buffer - cmd := exec.Command(name, arg...) - cmd.Env = env - cmd.Stdin = nil - cmd.Stdout = &out - cmd.Stderr = os.Stderr - err := cmd.Run() - return out.String(), err + fmt.Fprintln(os.Stderr, exec, name, arg) + } } func readVersionFile() (string, error) { content, err := os.ReadFile("VERSION") if err != nil { @@ -122,11 +133,11 @@ } return "" } func cmdCheck() error { - if err := checkGoTest(); err != nil { + if err := checkGoTest("./..."); err != nil { return err } if err := checkGoVet(); err != nil { return err } @@ -140,12 +151,14 @@ return err } return checkFossilExtra() } -func checkGoTest() error { - out, err := executeCommand(nil, "go", "test", "./...") +func checkGoTest(pkg string, testParams ...string) error { + args := []string{"test", pkg} + args = append(args, testParams...) + out, err := executeCommand(nil, "go", args...) if err != nil { for _, line := range strfun.SplitLines(out) { if strings.HasPrefix(line, "ok") || strings.HasPrefix(line, "?") { continue } @@ -216,10 +229,78 @@ } fmt.Fprintln(os.Stderr) } return nil } + +type zsInfo struct { + cmd *exec.Cmd + out bytes.Buffer + adminAddress string +} + +func cmdTestAPI() error { + var err error + var info zsInfo + needServer := !addressInUse(":23123") + if needServer { + err = startZettelstore(&info) + } + if err != nil { + return err + } + err = checkGoTest("zettelstore.de/z/client", "-base-url", "http://127.0.0.1:23123") + if needServer { + err1 := stopZettelstore(&info) + if err == nil { + err = err1 + } + } + return err +} + +func startZettelstore(info *zsInfo) error { + info.adminAddress = ":2323" + name, arg := "go", []string{ + "run", "cmd/zettelstore/main.go", "run", + "-c", "./testdata/testbox/19700101000000.zettel", "-a", info.adminAddress[1:]} + logCommand("FORK", nil, name, arg) + cmd := prepareCommand(nil, name, arg, &info.out) + if !verbose { + cmd.Stderr = nil + } + err := cmd.Start() + for i := 0; i < 100; i++ { + time.Sleep(time.Millisecond * 100) + if addressInUse(info.adminAddress) { + info.cmd = cmd + return err + } + } + return errors.New("zettelstore did not start") +} + +func stopZettelstore(i *zsInfo) error { + conn, err := net.Dial("tcp", i.adminAddress) + if err != nil { + fmt.Println("Unable to stop Zettelstore") + return err + } + io.WriteString(conn, "shutdown\n") + conn.Close() + err = i.cmd.Wait() + return err +} + +func addressInUse(address string) bool { + conn, err := net.Dial("tcp", address) + if err != nil { + return false + } + conn.Close() + return true +} func cmdBuild() error { return doBuild(nil, getVersion(), "bin/zettelstore") } @@ -408,10 +489,11 @@ clean Remove all build and release directories. help Outputs this text. manual Create a ZIP file with all manual zettel release Create the software for various platforms and put them in appropriate named ZIP files. + testapi Starts a Zettelstore and execute API tests. version Print the current version of the software. All commands can be abbreviated as long as they remain unique.`) } @@ -438,10 +520,12 @@ err = cmdClean() case "v", "ve", "ver", "vers", "versi", "versio", "version": fmt.Print(getVersion()) case "ch", "che", "chec", "check": err = cmdCheck() + case "t", "te", "tes", "test", "testa", "testap", "testapi": + cmdTestAPI() case "h", "he", "hel", "help": cmdHelp() default: fmt.Fprintf(os.Stderr, "Unknown command %q\n", args[0]) cmdHelp() Index: usecase/context.go ================================================================== --- usecase/context.go +++ usecase/context.go @@ -43,21 +43,10 @@ ZettelContextForward // Traverse all forwarding links ZettelContextBackward // Traverse all backwaring links ZettelContextBoth // Traverse both directions ) -// ParseZCDirection returns a direction value for a given string. -func ParseZCDirection(s string) ZettelContextDirection { - switch s { - case "backward": - return ZettelContextBackward - case "forward": - return ZettelContextForward - } - return ZettelContextBoth -} - // Run executes the use case. func (uc ZettelContext) Run(ctx context.Context, zid id.Zid, dir ZettelContextDirection, depth, limit int) (result []*meta.Meta, err error) { start, err := uc.port.GetMeta(ctx, zid) if err != nil { return nil, err Index: usecase/copy_zettel.go ================================================================== --- usecase/copy_zettel.go +++ usecase/copy_zettel.go @@ -12,11 +12,10 @@ package usecase import ( "zettelstore.de/z/domain" "zettelstore.de/z/domain/meta" - "zettelstore.de/z/strfun" ) // CopyZettel is the data for this use case. type CopyZettel struct{} @@ -34,8 +33,9 @@ } else { title = "Copy" } m.Set(meta.KeyTitle, title) } - content := strfun.TrimSpaceRight(origZettel.Content.AsString()) - return domain.Zettel{Meta: m, Content: domain.Content(content)} + content := origZettel.Content + content.TrimSpace() + return domain.Zettel{Meta: m, Content: content} } Index: usecase/create_zettel.go ================================================================== --- usecase/create_zettel.go +++ usecase/create_zettel.go @@ -16,11 +16,10 @@ "zettelstore.de/z/config" "zettelstore.de/z/domain" "zettelstore.de/z/domain/id" "zettelstore.de/z/domain/meta" - "zettelstore.de/z/strfun" ) // CreateZettelPort is the interface used by this use case. type CreateZettelPort interface { // CreateZettel creates a new zettel. @@ -57,8 +56,8 @@ if syntax, ok := m.Get(meta.KeySyntax); !ok || syntax == "" { m.Set(meta.KeySyntax, uc.rtConfig.GetDefaultSyntax()) } m.YamlSep = uc.rtConfig.GetYAMLHeader() - zettel.Content = domain.Content(strfun.TrimSpaceRight(zettel.Content.AsString())) + zettel.Content.TrimSpace() return uc.port.CreateZettel(ctx, zettel) } Index: usecase/delete_zettel.go ================================================================== --- usecase/delete_zettel.go +++ usecase/delete_zettel.go @@ -17,11 +17,11 @@ "zettelstore.de/z/domain/id" ) // DeleteZettelPort is the interface used by this use case. type DeleteZettelPort interface { - // DeleteZettel removes the zettel from the place. + // DeleteZettel removes the zettel from the box. DeleteZettel(ctx context.Context, zid id.Zid) error } // DeleteZettel is the data for this use case. type DeleteZettel struct { Index: usecase/folge_zettel.go ================================================================== --- usecase/folge_zettel.go +++ usecase/folge_zettel.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2020 Detlef Stern +// Copyright (c) 2020-2021 Detlef Stern // // This file is part of zettelstore. // // Zettelstore is licensed under the latest version of the EUPL (European Union // Public License). Please see file LICENSE.txt for your rights and obligations @@ -42,7 +42,7 @@ } m.Set(meta.KeyRole, config.GetRole(origMeta, uc.rtConfig)) m.Set(meta.KeyTags, origMeta.GetDefault(meta.KeyTags, "")) m.Set(meta.KeySyntax, uc.rtConfig.GetDefaultSyntax()) m.Set(meta.KeyPrecursor, origMeta.Zid.String()) - return domain.Zettel{Meta: m, Content: ""} + return domain.Zettel{Meta: m, Content: domain.NewContent("")} } ADDED usecase/get_all_meta.go Index: usecase/get_all_meta.go ================================================================== --- usecase/get_all_meta.go +++ usecase/get_all_meta.go @@ -0,0 +1,40 @@ +//----------------------------------------------------------------------------- +// Copyright (c) 2021 Detlef Stern +// +// This file is part of zettelstore. +// +// Zettelstore is licensed under the latest version of the EUPL (European Union +// Public License). Please see file LICENSE.txt for your rights and obligations +// under this license. +//----------------------------------------------------------------------------- + +// Package usecase provides (business) use cases for the zettelstore. +package usecase + +import ( + "context" + + "zettelstore.de/z/domain/id" + "zettelstore.de/z/domain/meta" +) + +// GetAllMetaPort is the interface used by this use case. +type GetAllMetaPort interface { + // GetAllMeta retrieves just the meta data of a specific zettel. + GetAllMeta(ctx context.Context, zid id.Zid) ([]*meta.Meta, error) +} + +// GetAllMeta is the data for this use case. +type GetAllMeta struct { + port GetAllMetaPort +} + +// NewGetAllMeta creates a new use case. +func NewGetAllMeta(port GetAllMetaPort) GetAllMeta { + return GetAllMeta{port: port} +} + +// Run executes the use case. +func (uc GetAllMeta) Run(ctx context.Context, zid id.Zid) ([]*meta.Meta, error) { + return uc.port.GetAllMeta(ctx, zid) +} Index: usecase/get_user.go ================================================================== --- usecase/get_user.go +++ usecase/get_user.go @@ -13,13 +13,13 @@ import ( "context" "zettelstore.de/z/auth" + "zettelstore.de/z/box" "zettelstore.de/z/domain/id" "zettelstore.de/z/domain/meta" - "zettelstore.de/z/place" "zettelstore.de/z/search" ) // Use case: return user identified by meta key ident. // --------------------------------------------------- @@ -41,11 +41,11 @@ return GetUser{authz: authz, port: port} } // Run executes the use case. func (uc GetUser) Run(ctx context.Context, ident string) (*meta.Meta, error) { - ctx = place.NoEnrichContext(ctx) + ctx = box.NoEnrichContext(ctx) // It is important to try first with the owner. First, because another user // could give herself the same ''ident''. Second, in most cases the owner // will authenticate. identMeta, err := uc.port.GetMeta(ctx, uc.authz.Owner()) @@ -88,15 +88,15 @@ return GetUserByZid{port: port} } // GetUser executes the use case. func (uc GetUserByZid) GetUser(ctx context.Context, zid id.Zid, ident string) (*meta.Meta, error) { - userMeta, err := uc.port.GetMeta(place.NoEnrichContext(ctx), zid) + userMeta, err := uc.port.GetMeta(box.NoEnrichContext(ctx), zid) if err != nil { return nil, err } if val, ok := userMeta.Get(meta.KeyUserID); !ok || val != ident { return nil, nil } return userMeta, nil } Index: usecase/list_role.go ================================================================== --- usecase/list_role.go +++ usecase/list_role.go @@ -13,12 +13,12 @@ import ( "context" "sort" + "zettelstore.de/z/box" "zettelstore.de/z/domain/meta" - "zettelstore.de/z/place" "zettelstore.de/z/search" ) // ListRolePort is the interface used by this use case. type ListRolePort interface { @@ -36,11 +36,11 @@ return ListRole{port: port} } // Run executes the use case. func (uc ListRole) Run(ctx context.Context) ([]string, error) { - metas, err := uc.port.SelectMeta(place.NoEnrichContext(ctx), nil) + metas, err := uc.port.SelectMeta(box.NoEnrichContext(ctx), nil) if err != nil { return nil, err } roles := make(map[string]bool, 8) for _, m := range metas { Index: usecase/list_tags.go ================================================================== --- usecase/list_tags.go +++ usecase/list_tags.go @@ -12,12 +12,12 @@ package usecase import ( "context" + "zettelstore.de/z/box" "zettelstore.de/z/domain/meta" - "zettelstore.de/z/place" "zettelstore.de/z/search" ) // ListTagsPort is the interface used by this use case. type ListTagsPort interface { @@