zs/zs.go

423 lines
9.5 KiB
Go
Raw Normal View History

2014-12-05 16:59:56 +00:00
package main
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"log"
"os"
2015-09-02 15:00:14 +00:00
"os/exec"
2014-12-05 16:59:56 +00:00
"path/filepath"
"strings"
2015-08-29 16:46:05 +00:00
"text/template"
2014-12-05 16:59:56 +00:00
"time"
"github.com/eknkc/amber"
2014-12-05 16:59:56 +00:00
"github.com/russross/blackfriday"
2015-08-29 15:47:16 +00:00
"github.com/yosssi/gcss"
"gopkg.in/yaml.v2"
2014-12-05 16:59:56 +00:00
)
const (
ZSDIR = ".zs"
PUBDIR = ".pub"
)
2015-08-29 15:47:16 +00:00
type Vars map[string]string
2015-09-02 15:00:14 +00:00
// renameExt renames extension (if any) from oldext to newext
// If oldext is an empty string - extension is extracted automatically.
// If path has no extension - new extension is appended
func renameExt(path, oldext, newext string) string {
if oldext == "" {
oldext = filepath.Ext(path)
}
if oldext == "" || strings.HasSuffix(path, oldext) {
return strings.TrimSuffix(path, oldext) + newext
2015-09-02 15:00:14 +00:00
} else {
return path
}
}
// globals returns list of global OS environment variables that start
// with ZS_ prefix as Vars, so the values can be used inside templates
2015-09-02 15:00:14 +00:00
func globals() Vars {
vars := Vars{}
for _, e := range os.Environ() {
pair := strings.Split(e, "=")
if strings.HasPrefix(pair[0], "ZS_") {
vars[strings.ToLower(pair[0][3:])] = pair[1]
}
}
return vars
}
// run executes a command or a script. Vars define the command environment,
// each zs var is converted into OS environemnt variable with ZS_ prefix
// prepended. Additional variable $ZS contains path to the zs binary. Command
// stderr is printed to zs stderr, command output is returned as a string.
func run(vars Vars, cmd string, args ...string) (string, error) {
// First check if partial exists (.amber or .html)
if b, err := ioutil.ReadFile(filepath.Join(ZSDIR, cmd+".amber")); err == nil {
return string(b), nil
}
if b, err := ioutil.ReadFile(filepath.Join(ZSDIR, cmd+".html")); err == nil {
return string(b), nil
2015-09-02 15:00:14 +00:00
}
var errbuf, outbuf bytes.Buffer
2015-09-02 15:00:14 +00:00
c := exec.Command(cmd, args...)
env := []string{"ZS=" + os.Args[0], "ZS_OUTDIR=" + PUBDIR}
env = append(env, os.Environ()...)
for k, v := range vars {
env = append(env, "ZS_"+strings.ToUpper(k)+"="+v)
}
c.Env = env
c.Stdout = &outbuf
2015-09-02 15:00:14 +00:00
c.Stderr = &errbuf
err := c.Run()
if errbuf.Len() > 0 {
log.Println("ERROR:", errbuf.String())
}
if err != nil {
return "", err
2015-09-02 15:00:14 +00:00
}
return string(outbuf.Bytes()), nil
2015-09-02 15:00:14 +00:00
}
2014-12-05 16:59:56 +00:00
// getVars returns list of variables defined in a text file and actual file
// content following the variables declaration. Header is separated from
// content by an empty line. Header can be either YAML or JSON.
// If no empty newline is found - file is treated as content-only.
func getVars(path string, globals Vars) (Vars, string, error) {
2015-08-29 15:47:16 +00:00
b, err := ioutil.ReadFile(path)
if err != nil {
return nil, "", err
}
s := string(b)
// Copy globals first
v := Vars{}
for name, value := range globals {
v[name] = value
2014-12-05 18:26:15 +00:00
}
// Override them by default values extracted from file name/path
if _, err := os.Stat(filepath.Join(ZSDIR, "layout.amber")); err == nil {
v["layout"] = "layout.amber"
} else {
v["layout"] = "layout.html"
}
v["file"] = path
v["url"] = path[:len(path)-len(filepath.Ext(path))] + ".html"
v["output"] = filepath.Join(PUBDIR, v["url"])
delim := "\n---\n"
if sep := strings.Index(s, delim); sep == -1 {
return v, s, nil
} else {
header := s[:sep]
body := s[sep+len(delim):]
vars := Vars{}
if err := yaml.Unmarshal([]byte(header), &vars); err != nil {
fmt.Println("ERROR: failed to parse header", err)
return nil, "", err
} else {
for key, value := range vars {
v[key] = value
log.Println(key, value)
}
}
if strings.HasPrefix(v["url"], "./") {
v["url"] = v["url"][2:]
}
return v, body, nil
2014-12-05 17:09:10 +00:00
}
2014-12-05 16:59:56 +00:00
}
// Render expanding zs plugins and variables
2015-09-02 15:00:14 +00:00
func render(s string, vars Vars) (string, error) {
delim_open := "{{"
delim_close := "}}"
2015-08-29 16:46:05 +00:00
out := &bytes.Buffer{}
for {
if from := strings.Index(s, delim_open); from == -1 {
out.WriteString(s)
return out.String(), nil
} else {
if to := strings.Index(s, delim_close); to == -1 {
return "", fmt.Errorf("Close delim not found")
} else {
out.WriteString(s[:from])
cmd := s[from+len(delim_open) : to]
s = s[to+len(delim_close):]
m := strings.Fields(cmd)
if len(m) == 1 {
if v, ok := vars[m[0]]; ok {
out.WriteString(v)
continue
}
}
if res, err := run(vars, m[0], m[1:]...); err == nil {
out.WriteString(res)
} else {
fmt.Println(err)
}
}
}
2015-08-29 16:46:05 +00:00
}
return s, nil
2014-12-05 16:59:56 +00:00
}
2015-08-29 16:46:05 +00:00
// Renders markdown with the given layout into html expanding all the macros
2015-09-02 15:00:14 +00:00
func buildMarkdown(path string, w io.Writer, vars Vars) error {
v, body, err := getVars(path, vars)
2014-12-05 16:59:56 +00:00
if err != nil {
return err
}
2015-09-02 15:00:14 +00:00
content, err := render(body, v)
2014-12-05 16:59:56 +00:00
if err != nil {
return err
}
2015-09-02 14:54:16 +00:00
v["content"] = string(blackfriday.MarkdownCommon([]byte(content)))
if w == nil {
out, err := os.Create(filepath.Join(PUBDIR, renameExt(path, "", ".html")))
if err != nil {
return err
}
defer out.Close()
w = out
}
2015-08-29 16:46:05 +00:00
if strings.HasSuffix(v["layout"], ".amber") {
2015-09-02 15:00:14 +00:00
return buildAmber(filepath.Join(ZSDIR, v["layout"]), w, v)
2015-08-29 16:46:05 +00:00
} else {
2015-09-02 15:00:14 +00:00
return buildHTML(filepath.Join(ZSDIR, v["layout"]), w, v)
2015-08-29 16:46:05 +00:00
}
}
2015-08-29 16:46:05 +00:00
// Renders text file expanding all variable macros inside it
2015-09-02 15:00:14 +00:00
func buildHTML(path string, w io.Writer, vars Vars) error {
v, body, err := getVars(path, vars)
2014-12-05 16:59:56 +00:00
if err != nil {
return err
}
if body, err = render(body, v); err != nil {
return err
}
tmpl, err := template.New("").Delims("<%", "%>").Parse(body)
2014-12-05 16:59:56 +00:00
if err != nil {
return err
}
if w == nil {
f, err := os.Create(filepath.Join(PUBDIR, path))
if err != nil {
return err
}
defer f.Close()
w = f
2014-12-05 16:59:56 +00:00
}
return tmpl.Execute(w, vars)
2014-12-05 16:59:56 +00:00
}
2015-08-29 16:46:05 +00:00
// Renders .amber file into .html
2015-09-02 15:00:14 +00:00
func buildAmber(path string, w io.Writer, vars Vars) error {
v, body, err := getVars(path, vars)
2015-08-29 15:47:16 +00:00
if err != nil {
return err
}
a := amber.New()
if err := a.Parse(body); err != nil {
fmt.Println(body)
return err
}
2015-08-29 15:47:16 +00:00
t, err := a.Compile()
if err != nil {
return err
}
htmlBuf := &bytes.Buffer{}
if err := t.Execute(htmlBuf, v); err != nil {
return err
}
if body, err = render(string(htmlBuf.Bytes()), v); err != nil {
return err
}
if w == nil {
f, err := os.Create(filepath.Join(PUBDIR, renameExt(path, ".amber", ".html")))
if err != nil {
return err
}
defer f.Close()
w = f
2015-08-29 15:47:16 +00:00
}
_, err = io.WriteString(w, body)
return err
2015-08-29 15:47:16 +00:00
}
2015-08-29 16:46:05 +00:00
// Compiles .gcss into .css
func buildGCSS(path string, w io.Writer) error {
2015-08-29 16:46:05 +00:00
f, err := os.Open(path)
if err != nil {
return err
}
defer f.Close()
if w == nil {
s := strings.TrimSuffix(path, ".gcss") + ".css"
css, err := os.Create(filepath.Join(PUBDIR, s))
if err != nil {
return err
2014-12-05 16:59:56 +00:00
}
defer css.Close()
w = css
2014-12-05 16:59:56 +00:00
}
_, err = gcss.Compile(w, f)
return err
2014-12-05 16:59:56 +00:00
}
// Copies file as is from path to writer
func buildRaw(path string, w io.Writer) error {
in, err := os.Open(path)
if err != nil {
return err
}
defer in.Close()
if w == nil {
if out, err := os.Create(filepath.Join(PUBDIR, path)); err != nil {
return err
} else {
defer out.Close()
w = out
2015-08-29 16:46:05 +00:00
}
}
_, err = io.Copy(w, in)
return err
}
2015-09-02 15:00:14 +00:00
func build(path string, w io.Writer, vars Vars) error {
ext := filepath.Ext(path)
if ext == ".md" || ext == ".mkd" {
2015-09-02 15:00:14 +00:00
return buildMarkdown(path, w, vars)
} else if ext == ".html" || ext == ".xml" {
2015-09-02 15:00:14 +00:00
return buildHTML(path, w, vars)
} else if ext == ".amber" {
2015-09-02 15:00:14 +00:00
return buildAmber(path, w, vars)
} else if ext == ".gcss" {
return buildGCSS(path, w)
} else {
return buildRaw(path, w)
2015-08-29 16:46:05 +00:00
}
}
func buildAll(watch bool) {
lastModified := time.Unix(0, 0)
modified := false
vars := globals()
2014-12-05 16:59:56 +00:00
for {
os.Mkdir(PUBDIR, 0755)
err := filepath.Walk(".", func(path string, info os.FileInfo, err error) error {
// ignore hidden files and directories
if filepath.Base(path)[0] == '.' || strings.HasPrefix(path, ".") {
return nil
}
2015-08-30 21:16:51 +00:00
// inform user about fs walk errors, but continue iteration
if err != nil {
log.Println("ERROR:", err)
return nil
}
2014-12-05 16:59:56 +00:00
if info.IsDir() {
os.Mkdir(filepath.Join(PUBDIR, path), 0755)
return nil
} else if info.ModTime().After(lastModified) {
if !modified {
// First file in this build cycle is about to be modified
run(vars, "prehook")
modified = true
}
log.Println("build:", path)
2015-09-02 15:00:14 +00:00
return build(path, nil, vars)
2014-12-05 16:59:56 +00:00
}
return nil
})
if err != nil {
log.Println("ERROR:", err)
}
if modified {
// At least one file in this build cycle has been modified
run(vars, "posthook")
modified = false
}
if !watch {
2014-12-05 16:59:56 +00:00
break
}
lastModified = time.Now()
2014-12-05 16:59:56 +00:00
time.Sleep(1 * time.Second)
}
}
func init() {
// prepend .zs to $PATH, so plugins will be found before OS commands
p := os.Getenv("PATH")
p = ZSDIR + ":" + p
os.Setenv("PATH", p)
}
2014-12-05 16:59:56 +00:00
func main() {
if len(os.Args) == 1 {
fmt.Println(os.Args[0], "<command> [args]")
return
}
cmd := os.Args[1]
args := os.Args[2:]
switch cmd {
case "build":
if len(args) == 0 {
buildAll(false)
} else if len(args) == 1 {
2015-09-02 15:00:14 +00:00
if err := build(args[0], os.Stdout, globals()); err != nil {
fmt.Println("ERROR: " + err.Error())
}
2014-12-05 16:59:56 +00:00
} else {
fmt.Println("ERROR: too many arguments")
2014-12-05 16:59:56 +00:00
}
case "watch":
buildAll(true)
case "var":
2015-09-02 15:00:14 +00:00
if len(args) == 0 {
fmt.Println("var: filename expected")
} else {
s := ""
if vars, _, err := getVars(args[0], globals()); err != nil {
2015-09-02 15:00:14 +00:00
fmt.Println("var: " + err.Error())
} else {
if len(args) > 1 {
for _, a := range args[1:] {
s = s + vars[a] + "\n"
}
} else {
for k, v := range vars {
s = s + k + ":" + v + "\n"
}
}
}
fmt.Println(strings.TrimSpace(s))
}
2014-12-05 16:59:56 +00:00
default:
if s, err := run(globals(), cmd, args...); err != nil {
fmt.Println(err)
} else {
fmt.Println(s)
2014-12-05 16:59:56 +00:00
}
}
}