summaryrefslogtreecommitdiffstats
path: root/hugolib/fileInfo.go
blob: ea3b15ef32846c960fffddeeb2aac217f9b99ceb (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
// Copyright 2017-present 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 hugolib

import (
	"strings"

	"github.com/gohugoio/hugo/helpers"
	"github.com/gohugoio/hugo/source"
)

// fileInfo implements the File and ReadableFile interface.
var (
	_ source.File         = (*fileInfo)(nil)
	_ source.ReadableFile = (*fileInfo)(nil)
	_ pathLangFile        = (*fileInfo)(nil)
)

// A partial interface to prevent ambigous compiler error.
type basePather interface {
	Filename() string
	RealName() string
	BaseDir() string
}

type fileInfo struct {
	bundleTp bundleDirType

	source.ReadableFile
	basePather

	overriddenLang string

	// Set if the content language for this file is disabled.
	disabled bool
}

func (fi *fileInfo) Lang() string {
	if fi.overriddenLang != "" {
		return fi.overriddenLang
	}
	return fi.ReadableFile.Lang()
}

func (fi *fileInfo) Filename() string {
	if fi == nil || fi.basePather == nil {
		return ""
	}
	return fi.basePather.Filename()
}

func (fi *fileInfo) String() string {
	if fi == nil || fi.ReadableFile == nil {
		return ""
	}
	return fi.Path()
}

func (fi *fileInfo) isOwner() bool {
	return fi.bundleTp > bundleNot
}

func IsContentFile(filename string) bool {
	return contentFileExtensionsSet[strings.TrimPrefix(helpers.Ext(filename), ".")]
}

func (fi *fileInfo) isContentFile() bool {
	return contentFileExtensionsSet[fi.Ext()]
}

func newFileInfo(sp *source.SourceSpec, baseDir, filename string, fi pathLangFileFi, tp bundleDirType) *fileInfo {

	baseFi := sp.NewFileInfo(baseDir, filename, tp == bundleLeaf, fi)
	f := &fileInfo{
		bundleTp:     tp,
		ReadableFile: baseFi,
		basePather:   fi,
	}

	lang := f.Lang()
	f.disabled = lang != "" && sp.DisabledLanguages[lang]

	return f

}

type bundleDirType int

const (
	bundleNot bundleDirType = iota

	// All from here are bundles in one form or another.
	bundleLeaf
	bundleBranch
)

// Returns the given file's name's bundle type and whether it is a content
// file or not.
func classifyBundledFile(name string) (bundleDirType, bool) {
	if !IsContentFile(name) {
		return bundleNot, false
	}
	if strings.HasPrefix(name, "_index.") {
		return bundleBranch, true
	}

	if strings.HasPrefix(name, "index.") {
		return bundleLeaf, true
	}

	return bundleNot, true
}

func (b bundleDirType) String() string {
	switch b {
	case bundleNot:
		return "Not a bundle"
	case bundleLeaf:
		return "Regular bundle"
	case bundleBranch:
		return "Branch bundle"
	}

	return ""
}