hugo/commands/undraft.go

157 lines
4.3 KiB
Go
Raw Normal View History

// Copyright 2015 The Hugo Authors. All rights reserved.
2015-03-15 18:32:41 -04:00
//
2015-11-23 22:16:36 -05:00
// Licensed under the Apache License, Version 2.0 (the "License");
2015-03-15 18:32:41 -04:00
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
2015-11-23 22:16:36 -05:00
// http://www.apache.org/licenses/LICENSE-2.0
2015-03-15 18:32:41 -04:00
//
// 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.
2016-03-24 18:34:12 -04:00
2015-03-15 18:32:41 -04:00
package commands
import (
"bytes"
"errors"
2015-03-15 18:32:41 -04:00
"os"
"time"
"github.com/spf13/cobra"
"github.com/spf13/hugo/hugofs"
2015-03-15 18:32:41 -04:00
"github.com/spf13/hugo/parser"
)
var undraftCmd = &cobra.Command{
Use: "undraft path/to/content",
Short: "Undraft changes the content's draft status from 'True' to 'False'",
2015-10-12 14:47:06 -04:00
Long: `Undraft changes the content's draft status from 'True' to 'False'
and updates the date to the current date and time.
If the content's draft status is 'False', nothing is done.`,
RunE: Undraft,
2015-03-15 18:32:41 -04:00
}
2016-03-24 18:34:12 -04:00
// Undraft publishes the specified content by setting its draft status
2015-03-15 18:32:41 -04:00
// to false and setting its publish date to now. If the specified content is
// not a draft, it will log an error.
func Undraft(cmd *cobra.Command, args []string) error {
if _, err := InitializeConfig(); err != nil {
return err
}
2015-03-15 18:32:41 -04:00
if len(args) < 1 {
return newUserError("a piece of content needs to be specified")
2015-03-15 18:32:41 -04:00
}
location := args[0]
// open the file
f, err := hugofs.Source().Open(location)
2015-03-15 18:32:41 -04:00
if err != nil {
return err
2015-03-15 18:32:41 -04:00
}
// get the page from file
p, err := parser.ReadFrom(f)
f.Close()
if err != nil {
return err
2015-03-15 18:32:41 -04:00
}
w, err := undraftContent(p)
if err != nil {
return newSystemErrorF("an error occurred while undrafting %q: %s", location, err)
2015-03-15 18:32:41 -04:00
}
f, err = hugofs.Source().OpenFile(location, os.O_WRONLY|os.O_TRUNC, 0644)
2015-03-15 18:32:41 -04:00
if err != nil {
return newSystemErrorF("%q not be undrafted due to error opening file to save changes: %q\n", location, err)
2015-03-15 18:32:41 -04:00
}
defer f.Close()
_, err = w.WriteTo(f)
if err != nil {
return newSystemErrorF("%q not be undrafted due to save error: %q\n", location, err)
2015-03-15 18:32:41 -04:00
}
return nil
2015-03-15 18:32:41 -04:00
}
2015-11-16 09:15:17 -05:00
// undraftContent: if the content is a draft, change its draft status to
2015-03-15 18:32:41 -04:00
// 'false' and set the date to time.Now(). If the draft status is already
// 'false', don't do anything.
func undraftContent(p parser.Page) (bytes.Buffer, error) {
var buff bytes.Buffer
// get the metadata; easiest way to see if it's a draft
meta, err := p.Metadata()
if err != nil {
return buff, err
}
// since the metadata was obtainable, we can also get the key/value separator for
// Front Matter
fm := p.FrontMatter()
if fm == nil {
return buff, errors.New("Front Matter was found, nothing was finalized")
2015-03-15 18:32:41 -04:00
}
var isDraft, gotDate bool
var date string
L:
for k, v := range meta.(map[string]interface{}) {
switch k {
case "draft":
if !v.(bool) {
return buff, errors.New("not a Draft: nothing was done")
2015-03-15 18:32:41 -04:00
}
isDraft = true
if gotDate {
break L
}
case "date":
date = v.(string) // capture the value to make replacement easier
gotDate = true
if isDraft {
break L
}
}
}
// if draft wasn't found in FrontMatter, it isn't a draft.
if !isDraft {
return buff, errors.New("not a Draft: nothing was done")
2015-03-15 18:32:41 -04:00
}
// get the front matter as bytes and split it into lines
var lineEnding []byte
2016-03-23 09:51:16 -04:00
fmLines := bytes.Split(fm, []byte("\n"))
2015-03-15 18:32:41 -04:00
if len(fmLines) == 1 { // if the result is only 1 element, try to split on dos line endings
2016-03-23 09:51:16 -04:00
fmLines = bytes.Split(fm, []byte("\r\n"))
2015-03-15 18:32:41 -04:00
if len(fmLines) == 1 {
return buff, errors.New("unable to split FrontMatter into lines")
2015-03-15 18:32:41 -04:00
}
2016-03-23 09:51:16 -04:00
lineEnding = append(lineEnding, []byte("\r\n")...)
2015-03-15 18:32:41 -04:00
} else {
2016-03-23 09:51:16 -04:00
lineEnding = append(lineEnding, []byte("\n")...)
2015-03-15 18:32:41 -04:00
}
// Write the front matter lines to the buffer, replacing as necessary
for _, v := range fmLines {
pos := bytes.Index(v, []byte("draft"))
if pos != -1 {
v = bytes.Replace(v, []byte("true"), []byte("false"), 1)
goto write
}
pos = bytes.Index(v, []byte("date"))
if pos != -1 { // if date field wasn't found, add it
v = bytes.Replace(v, []byte(date), []byte(time.Now().Format(time.RFC3339)), 1)
}
write:
buff.Write(v)
buff.Write(lineEnding)
}
// append the actual content
2016-08-30 13:22:26 -04:00
buff.Write(p.Content())
2015-03-15 18:32:41 -04:00
return buff, nil
}