summaryrefslogtreecommitdiffstats
path: root/commands/convert.go
blob: 8de155e9b5b4a9e798686b1cda4bbaa55f535351 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
// Copyright 2015 The Hugo Authors. All rights reserved.
//
// 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 commands

import (
	"fmt"
	"time"

	src "github.com/gohugoio/hugo/source"

	"github.com/gohugoio/hugo/hugolib"

	"path/filepath"

	"github.com/gohugoio/hugo/parser"
	"github.com/spf13/cast"
	"github.com/spf13/cobra"
)

var (
	_ cmder = (*convertCmd)(nil)
)

type convertCmd struct {
	hugoBuilderCommon

	outputDir string
	unsafe    bool

	*baseCmd
}

func newConvertCmd() *convertCmd {
	cc := &convertCmd{}

	cc.baseCmd = newBaseCmd(&cobra.Command{
		Use:   "convert",
		Short: "Convert your content to different formats",
		Long: `Convert your content (e.g. front matter) to different formats.

See convert's subcommands toJSON, toTOML and toYAML for more information.`,
		RunE: nil,
	})

	cc.cmd.AddCommand(
		&cobra.Command{
			Use:   "toJSON",
			Short: "Convert front matter to JSON",
			Long: `toJSON converts all front matter in the content directory
to use JSON for the front matter.`,
			RunE: func(cmd *cobra.Command, args []string) error {
				return cc.convertContents(rune([]byte(parser.JSONLead)[0]))
			},
		},
		&cobra.Command{
			Use:   "toTOML",
			Short: "Convert front matter to TOML",
			Long: `toTOML converts all front matter in the content directory
to use TOML for the front matter.`,
			RunE: func(cmd *cobra.Command, args []string) error {
				return cc.convertContents(rune([]byte(parser.TOMLLead)[0]))
			},
		},
		&cobra.Command{
			Use:   "toYAML",
			Short: "Convert front matter to YAML",
			Long: `toYAML converts all front matter in the content directory
to use YAML for the front matter.`,
			RunE: func(cmd *cobra.Command, args []string) error {
				return cc.convertContents(rune([]byte(parser.YAMLLead)[0]))
			},
		},
	)

	cc.cmd.PersistentFlags().StringVarP(&cc.outputDir, "output", "o", "", "filesystem path to write files to")
	cc.cmd.PersistentFlags().StringVarP(&cc.source, "source", "s", "", "filesystem path to read files relative from")
	cc.cmd.PersistentFlags().BoolVar(&cc.unsafe, "unsafe", false, "enable less safe operations, please backup first")
	cc.cmd.PersistentFlags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{})

	return cc
}

func (cc *convertCmd) convertContents(mark rune) error {
	if cc.outputDir == "" && !cc.unsafe {
		return newUserError("Unsafe operation not allowed, use --unsafe or set a different output path")
	}

	c, err := initializeConfig(true, false, &cc.hugoBuilderCommon, cc, nil)
	if err != nil {
		return err
	}

	h, err := hugolib.NewHugoSites(*c.DepsCfg)
	if err != nil {
		return err
	}

	if err := h.Build(hugolib.BuildCfg{SkipRender: true}); err != nil {
		return err
	}

	site := h.Sites[0]

	site.Log.FEEDBACK.Println("processing", len(site.AllPages), "content files")
	for _, p := range site.AllPages {
		if err := cc.convertAndSavePage(p, site, mark); err != nil {
			return err
		}
	}
	return nil
}

func (cc *convertCmd) convertAndSavePage(p *hugolib.Page, site *hugolib.Site, mark rune) error {
	// The resources are not in .Site.AllPages.
	for _, r := range p.Resources.ByType("page") {
		if err := cc.convertAndSavePage(r.(*hugolib.Page), site, mark); err != nil {
			return err
		}
	}

	if p.Filename() == "" {
		// No content file.
		return nil
	}

	site.Log.INFO.Println("Attempting to convert", p.LogicalName())
	newPage, err := site.NewPage(p.LogicalName())
	if err != nil {
		return err
	}

	f, _ := p.File.(src.ReadableFile)
	file, err := f.Open()
	if err != nil {
		site.Log.ERROR.Println("Error reading file:", p.Path())
		file.Close()
		return nil
	}

	psr, err := parser.ReadFrom(file)
	if err != nil {
		site.Log.ERROR.Println("Error processing file:", p.Path())
		file.Close()
		return err
	}

	file.Close()

	metadata, err := psr.Metadata()
	if err != nil {
		site.Log.ERROR.Println("Error processing file:", p.Path())
		return err
	}

	// better handling of dates in formats that don't have support for them
	if mark == parser.FormatToLeadRune("json") || mark == parser.FormatToLeadRune("yaml") || mark == parser.FormatToLeadRune("toml") {
		newMetadata := cast.ToStringMap(metadata)
		for k, v := range newMetadata {
			switch vv := v.(type) {
			case time.Time:
				newMetadata[k] = vv.Format(time.RFC3339)
			}
		}
		metadata = newMetadata
	}

	newPage.SetSourceContent(psr.Content())
	if err = newPage.SetSourceMetaData(metadata, mark); err != nil {
		site.Log.ERROR.Printf("Failed to set source metadata for file %q: %s. For more info see For more info see https://github.com/gohugoio/hugo/issues/2458", newPage.FullFilePath(), err)
		return nil
	}

	newFilename := p.Filename()
	if cc.outputDir != "" {
		newFilename = filepath.Join(cc.outputDir, p.Dir(), newPage.LogicalName())
	}

	if err = newPage.SaveSourceAs(newFilename); err != nil {
		return fmt.Errorf("Failed to save file %q: %s", newFilename, err)
	}

	return nil
}