github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

Add Hugo generator tag to home page if not present

Browse source 
Fixes #2182
This commit is contained in:
Bjørn Erik Pedersen 2016-06-04 13:45:56 +02:00 committed by Steve Francia
parent 80ebe0578a
commit a7f51703c4
3 changed files with 111 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
hugolib/site.go
View file

@ -1960,6 +1960,13 @@ func (s *Site) renderAndWritePage(name string, dest string, d interface{}, layou
transformLinks = append(transformLinks, transform.LiveReloadInject) transformLinks = append(transformLinks, transform.LiveReloadInject)
} }
// For performance reasons we only inject the Hugo generator tag on the home page.
if n, ok := d.(*Node); ok && n.IsHome {
if !viper.GetBool("DisableHugoGeneratorInject") {
transformLinks = append(transformLinks, transform.HugoGeneratorInject)
}
}
var path []byte var path []byte
if viper.GetBool("RelativeURLs") { if viper.GetBool("RelativeURLs") {

44
transform/hugogeneratorinject.go Normal file
View file

@ -0,0 +1,44 @@
// Copyright 2016 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 transform
import (
"bytes"
"fmt"
"regexp"
"github.com/spf13/hugo/helpers"
)
var metaTagsCheck = regexp.MustCompile(`(?i)<meta\s+name=['|"]?generator['|"]?`)
var hugoGeneratorTag = fmt.Sprintf(`<meta name="generator" content="Hugo %s" />`, helpers.HugoVersion())
func HugoGeneratorInject(ct contentTransformer) {
if metaTagsCheck.Match(ct.Content()) {
ct.Write(ct.Content())
return
}
head := "<head>"
replace := []byte(fmt.Sprintf("%s\n\t%s", head, hugoGeneratorTag))
newcontent := bytes.Replace(ct.Content(), []byte(head), replace, 1)
if len(newcontent) == len(ct.Content()) {
head := "<HEAD>"
replace := []byte(fmt.Sprintf("%s\n\t%s", head, hugoGeneratorTag))
newcontent = bytes.Replace(ct.Content(), []byte(head), replace, 1)
}
ct.Write(newcontent)
}

60
transform/hugogeneratorinject_test.go Normal file
View file

@ -0,0 +1,60 @@
// Copyright 2016 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 transform
import (
"bytes"
"testing"
"github.com/spf13/hugo/helpers"
)
func TestHugoGeneratorInject(t *testing.T) {
hugoGeneratorTag = "META"
for i, this := range []struct {
in string
expect string
}{
{`<head>
<foo />
</head>`, `<head>
META
<foo />
</head>`},
{`<HEAD>
<foo />
</HEAD>`, `<HEAD>
META
<foo />
</HEAD>`},
{`<head><meta name="generator" content="Jekyll" /></head>`, `<head><meta name="generator" content="Jekyll" /></head>`},
{`<head><meta name='generator' content='Jekyll' /></head>`, `<head><meta name='generator' content='Jekyll' /></head>`},
{`<head><meta name=generator content=Jekyll /></head>`, `<head><meta name=generator content=Jekyll /></head>`},
{`<head><META NAME="GENERATOR" content="Jekyll" /></head>`, `<head><META NAME="GENERATOR" content="Jekyll" /></head>`},
{"", ""},
{"</head>", "</head>"},
{"<head>", "<head>\n\tMETA"},
} {
in := helpers.StringToReader(this.in)
out := new(bytes.Buffer)
tr := NewChain(HugoGeneratorInject)
tr.Apply(out, in, []byte(""))
if out.String() != this.expect {
t.Errorf("[%d] Expected \n%q got \n%q", i, this.expect, out.String())
}
}
}