mirror of
https://github.com/go-gitea/gitea
synced 2024-11-09 11:44:27 +00:00
d34f3a2213
Fix #22270. Related to #18407. The old code treated both sitemap and sitemap index as the format like: ```xml ... <url> <loc>http://localhost:3000/explore/users/sitemap-1.xml</loc> </url> ... ``` Actually, it's incorrect for sitemap index, it should be: ```xml ... <sitemap> <loc>http://localhost:3000/explore/users/sitemap-1.xml</loc> </sitemap> ... ``` See https://www.sitemaps.org/protocol.html Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: delvh <dev.lh@web.de>
83 lines
1.9 KiB
Go
83 lines
1.9 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package sitemap
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/xml"
|
|
"fmt"
|
|
"io"
|
|
"time"
|
|
)
|
|
|
|
const (
|
|
sitemapFileLimit = 50 * 1024 * 1024 // the maximum size of a sitemap file
|
|
urlsLimit = 50000
|
|
|
|
schemaURL = "http://www.sitemaps.org/schemas/sitemap/0.9"
|
|
urlsetName = "urlset"
|
|
sitemapindexName = "sitemapindex"
|
|
)
|
|
|
|
// URL represents a single sitemap entry
|
|
type URL struct {
|
|
URL string `xml:"loc"`
|
|
LastMod *time.Time `xml:"lastmod,omitempty"`
|
|
}
|
|
|
|
// Sitemap represents a sitemap
|
|
type Sitemap struct {
|
|
XMLName xml.Name
|
|
Namespace string `xml:"xmlns,attr"`
|
|
|
|
URLs []URL `xml:"url"`
|
|
Sitemaps []URL `xml:"sitemap"`
|
|
}
|
|
|
|
// NewSitemap creates a sitemap
|
|
func NewSitemap() *Sitemap {
|
|
return &Sitemap{
|
|
XMLName: xml.Name{Local: urlsetName},
|
|
Namespace: schemaURL,
|
|
}
|
|
}
|
|
|
|
// NewSitemapIndex creates a sitemap index.
|
|
func NewSitemapIndex() *Sitemap {
|
|
return &Sitemap{
|
|
XMLName: xml.Name{Local: sitemapindexName},
|
|
Namespace: schemaURL,
|
|
}
|
|
}
|
|
|
|
// Add adds a URL to the sitemap
|
|
func (s *Sitemap) Add(u URL) {
|
|
if s.XMLName.Local == sitemapindexName {
|
|
s.Sitemaps = append(s.Sitemaps, u)
|
|
} else {
|
|
s.URLs = append(s.URLs, u)
|
|
}
|
|
}
|
|
|
|
// WriteTo writes the sitemap to a response
|
|
func (s *Sitemap) WriteTo(w io.Writer) (int64, error) {
|
|
if l := len(s.URLs); l > urlsLimit {
|
|
return 0, fmt.Errorf("The sitemap contains %d URLs, but only %d are allowed", l, urlsLimit)
|
|
}
|
|
if l := len(s.Sitemaps); l > urlsLimit {
|
|
return 0, fmt.Errorf("The sitemap contains %d sub-sitemaps, but only %d are allowed", l, urlsLimit)
|
|
}
|
|
buf := bytes.NewBufferString(xml.Header)
|
|
if err := xml.NewEncoder(buf).Encode(s); err != nil {
|
|
return 0, err
|
|
}
|
|
if err := buf.WriteByte('\n'); err != nil {
|
|
return 0, err
|
|
}
|
|
if buf.Len() > sitemapFileLimit {
|
|
return 0, fmt.Errorf("The sitemap has %d bytes, but only %d are allowed", buf.Len(), sitemapFileLimit)
|
|
}
|
|
return buf.WriteTo(w)
|
|
}
|