192
vendor/github.com/mholt/caddy/caddyhttp/markdown/markdown.go
generated
vendored
Normal file
192
vendor/github.com/mholt/caddy/caddyhttp/markdown/markdown.go
generated
vendored
Normal file
@@ -0,0 +1,192 @@
|
||||
// Copyright 2015 Light Code Labs, LLC
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
// Package markdown is middleware to render markdown files as HTML
|
||||
// on-the-fly.
|
||||
package markdown
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"os"
|
||||
"path"
|
||||
"strconv"
|
||||
"strings"
|
||||
"text/template"
|
||||
"time"
|
||||
|
||||
"github.com/mholt/caddy/caddyhttp/httpserver"
|
||||
"github.com/russross/blackfriday"
|
||||
)
|
||||
|
||||
// Markdown implements a layer of middleware that serves
|
||||
// markdown as HTML.
|
||||
type Markdown struct {
|
||||
// Server root
|
||||
Root string
|
||||
|
||||
// Jail the requests to site root with a mock file system
|
||||
FileSys http.FileSystem
|
||||
|
||||
// Next HTTP handler in the chain
|
||||
Next httpserver.Handler
|
||||
|
||||
// The list of markdown configurations
|
||||
Configs []*Config
|
||||
}
|
||||
|
||||
// Config stores markdown middleware configurations.
|
||||
type Config struct {
|
||||
// Markdown renderer
|
||||
Renderer blackfriday.Renderer
|
||||
|
||||
// Base path to match
|
||||
PathScope string
|
||||
|
||||
// List of extensions to consider as markdown files
|
||||
Extensions map[string]struct{}
|
||||
|
||||
// List of style sheets to load for each markdown file
|
||||
Styles []string
|
||||
|
||||
// List of JavaScript files to load for each markdown file
|
||||
Scripts []string
|
||||
|
||||
// The list of index files to try
|
||||
IndexFiles []string
|
||||
|
||||
// Template(s) to render with
|
||||
Template *template.Template
|
||||
|
||||
// a pair of template's name and its underlying file information
|
||||
TemplateFiles map[string]*cachedFileInfo
|
||||
}
|
||||
|
||||
type cachedFileInfo struct {
|
||||
path string
|
||||
fi os.FileInfo
|
||||
}
|
||||
|
||||
// ServeHTTP implements the http.Handler interface.
|
||||
func (md Markdown) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error) {
|
||||
var cfg *Config
|
||||
for _, c := range md.Configs {
|
||||
if httpserver.Path(r.URL.Path).Matches(c.PathScope) { // not negated
|
||||
cfg = c
|
||||
break // or goto
|
||||
}
|
||||
}
|
||||
if cfg == nil {
|
||||
return md.Next.ServeHTTP(w, r) // exit early
|
||||
}
|
||||
|
||||
// We only deal with HEAD/GET
|
||||
switch r.Method {
|
||||
case http.MethodGet, http.MethodHead:
|
||||
default:
|
||||
return http.StatusMethodNotAllowed, nil
|
||||
}
|
||||
|
||||
var dirents []os.FileInfo
|
||||
var lastModTime time.Time
|
||||
fpath := r.URL.Path
|
||||
if idx, ok := httpserver.IndexFile(md.FileSys, fpath, cfg.IndexFiles); ok {
|
||||
// We're serving a directory index file, which may be a markdown
|
||||
// file with a template. Let's grab a list of files this directory
|
||||
// URL points to, and pass that in to any possible template invocations,
|
||||
// so that templates can customize the look and feel of a directory.
|
||||
fdp, err := md.FileSys.Open(fpath)
|
||||
switch {
|
||||
case err == nil: // nop
|
||||
case os.IsPermission(err):
|
||||
return http.StatusForbidden, err
|
||||
case os.IsExist(err):
|
||||
return http.StatusNotFound, nil
|
||||
default: // did we run out of FD?
|
||||
return http.StatusInternalServerError, err
|
||||
}
|
||||
defer fdp.Close()
|
||||
|
||||
// Grab a possible set of directory entries. Note, we do not check
|
||||
// for errors here (unreadable directory, for example). It may
|
||||
// still be useful to have a directory template file, without the
|
||||
// directory contents being present. Note, the directory's last
|
||||
// modification is also present here (entry ".").
|
||||
dirents, _ = fdp.Readdir(-1)
|
||||
for _, d := range dirents {
|
||||
lastModTime = latest(lastModTime, d.ModTime())
|
||||
}
|
||||
|
||||
// Set path to found index file
|
||||
fpath = idx
|
||||
}
|
||||
|
||||
// If not supported extension, pass on it
|
||||
if _, ok := cfg.Extensions[path.Ext(fpath)]; !ok {
|
||||
return md.Next.ServeHTTP(w, r)
|
||||
}
|
||||
|
||||
// At this point we have a supported extension/markdown
|
||||
f, err := md.FileSys.Open(fpath)
|
||||
switch {
|
||||
case err == nil: // nop
|
||||
case os.IsPermission(err):
|
||||
return http.StatusForbidden, err
|
||||
case os.IsNotExist(err):
|
||||
return http.StatusNotFound, nil
|
||||
default: // did we run out of FD?
|
||||
return http.StatusInternalServerError, err
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
fs, err := f.Stat()
|
||||
if err != nil {
|
||||
return http.StatusGone, nil
|
||||
}
|
||||
lastModTime = latest(lastModTime, fs.ModTime())
|
||||
|
||||
ctx := httpserver.NewContextWithHeader(w.Header())
|
||||
ctx.Root = md.FileSys
|
||||
ctx.Req = r
|
||||
ctx.URL = r.URL
|
||||
html, err := cfg.Markdown(title(fpath), f, dirents, ctx)
|
||||
if err != nil {
|
||||
return http.StatusInternalServerError, err
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||
w.Header().Set("Content-Length", strconv.Itoa(len(html)))
|
||||
httpserver.SetLastModifiedHeader(w, lastModTime)
|
||||
if r.Method == http.MethodGet {
|
||||
w.Write(html)
|
||||
}
|
||||
return http.StatusOK, nil
|
||||
}
|
||||
|
||||
// latest returns the latest time.Time
|
||||
func latest(t ...time.Time) time.Time {
|
||||
var last time.Time
|
||||
|
||||
for _, tt := range t {
|
||||
if tt.After(last) {
|
||||
last = tt
|
||||
}
|
||||
}
|
||||
|
||||
return last
|
||||
}
|
||||
|
||||
// title gives a backup generated title for a page
|
||||
func title(p string) string {
|
||||
return strings.TrimSuffix(path.Base(p), path.Ext(p))
|
||||
}
|
||||
Reference in New Issue
Block a user