package metadata import ( "bufio" "bytes" "fmt" "time" ) var ( // Date format YYYY-MM-DD HH:MM:SS or YYYY-MM-DD timeLayout = []string{ `2006-01-02 15:04:05`, `2006-01-02`, } ) // Metadata stores a page's metadata type Metadata struct { // Page title Title string // Page template Template string // Publish date Date time.Time // Variables to be used with Template Variables map[string]string // Flags to be used with Template Flags map[string]bool } // load loads parsed values in parsedMap into Metadata func (m *Metadata) load(parsedMap map[string]interface{}) { // Pull top level things out if title, ok := parsedMap["title"]; ok { m.Title, _ = title.(string) } if template, ok := parsedMap["template"]; ok { m.Template, _ = template.(string) } if date, ok := parsedMap["date"].(string); ok { for _, layout := range timeLayout { if t, err := time.Parse(layout, date); err == nil { m.Date = t break } } } // Store everything as a flag or variable for key, val := range parsedMap { switch v := val.(type) { case bool: m.Flags[key] = v case string: m.Variables[key] = v } } } // MetadataParser is a an interface that must be satisfied by each parser type MetadataParser interface { // Initialize a parser Init(b *bytes.Buffer) bool // Type of metadata Type() string // Opening identifier Opening() []byte // Closing identifier Closing() []byte // Parsed metadata. Metadata() Metadata // Raw markdown. Markdown() []byte } // extractMetadata separates metadata content from from markdown content in b. // It returns the metadata, the remaining bytes (markdown), and an error, if any. func extractMetadata(parser MetadataParser, b []byte) (metadata []byte, markdown []byte, err error) { b = bytes.TrimSpace(b) openingLine := parser.Opening() closingLine := parser.Closing() if !bytes.HasPrefix(b, openingLine) { return nil, b, fmt.Errorf("first line missing expected metadata identifier") } metaStart := len(openingLine) if _, ok := parser.(*JSONMetadataParser); ok { metaStart = 0 } metaEnd := bytes.Index(b[metaStart:], closingLine) if metaEnd == -1 { return nil, nil, fmt.Errorf("metadata not closed ('%s' not found)", parser.Closing()) } metaEnd += metaStart if _, ok := parser.(*JSONMetadataParser); ok { metaEnd += len(closingLine) } metadata = b[metaStart:metaEnd] markdown = b[metaEnd:] if _, ok := parser.(*JSONMetadataParser); !ok { markdown = b[metaEnd+len(closingLine):] } return metadata, markdown, nil } func GetParser(buf []byte) MetadataParser { for _, p := range parsers() { b := bytes.NewBuffer(buf) if p.Init(b) { return p } } return nil } // findParser finds the parser using line that contains opening identifier func FindParser(b []byte) MetadataParser { var line []byte // Read first line if _, err := fmt.Fscanln(bytes.NewReader(b), &line); err != nil { return nil } line = bytes.TrimSpace(line) for _, parser := range parsers() { if bytes.Equal(parser.Opening(), line) { return parser } } return nil } func NewMetadata() Metadata { return Metadata{ Variables: make(map[string]string), Flags: make(map[string]bool), } } // parsers returns all available parsers func parsers() []MetadataParser { return []MetadataParser{ &TOMLMetadataParser{}, &YAMLMetadataParser{metadata: NewMetadata()}, &JSONMetadataParser{}, &NoneMetadataParser{}, } } // Split out "normal" metadata with given delimiter func splitBuffer(b *bytes.Buffer, delim string) (*bytes.Buffer, *bytes.Buffer) { scanner := bufio.NewScanner(b) // Read and check first line if !scanner.Scan() { return nil, nil } if string(bytes.TrimSpace(scanner.Bytes())) != delim { return nil, nil } // Accumulate metadata, until delimiter meta := bytes.NewBuffer(nil) for scanner.Scan() { if string(bytes.TrimSpace(scanner.Bytes())) == delim { break } if _, err := meta.Write(scanner.Bytes()); err != nil { return nil, nil } if _, err := meta.WriteRune('\n'); err != nil { return nil, nil } } // Make sure we saw closing delimiter if string(bytes.TrimSpace(scanner.Bytes())) != delim { return nil, nil } // The rest is markdown markdown := new(bytes.Buffer) for scanner.Scan() { if _, err := markdown.Write(scanner.Bytes()); err != nil { return nil, nil } if _, err := markdown.WriteRune('\n'); err != nil { return nil, nil } } return meta, markdown }