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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
|
package lfs
import (
"bufio"
"bytes"
"fmt"
"io"
"os"
"regexp"
"sort"
"strconv"
"strings"
"github.com/git-lfs/git-lfs/v3/errors"
"github.com/git-lfs/git-lfs/v3/fs"
"github.com/git-lfs/git-lfs/v3/tr"
"github.com/git-lfs/gitobj/v2"
)
var (
v1Aliases = []string{
"http://git-media.io/v/2", // alpha
"https://hawser.github.com/spec/v1", // pre-release
"https://git-lfs.github.com/spec/v1", // public launch
}
latest = "https://git-lfs.github.com/spec/v1"
oidType = "sha256"
oidRE = regexp.MustCompile(`\A[0-9a-f]{64}\z`)
matcherRE = regexp.MustCompile("git-media|hawser|git-lfs")
extRE = regexp.MustCompile(`\Aext-\d{1}-\w+`)
pointerKeys = []string{"version", "oid", "size"}
)
type Pointer struct {
Version string
Oid string
Size int64
OidType string
Extensions []*PointerExtension
Canonical bool
}
// A PointerExtension is parsed from the Git LFS Pointer file.
type PointerExtension struct {
Name string
Priority int
Oid string
OidType string
}
type ByPriority []*PointerExtension
func (p ByPriority) Len() int { return len(p) }
func (p ByPriority) Swap(i, j int) { p[i], p[j] = p[j], p[i] }
func (p ByPriority) Less(i, j int) bool { return p[i].Priority < p[j].Priority }
func NewPointer(oid string, size int64, exts []*PointerExtension) *Pointer {
return &Pointer{latest, oid, size, oidType, exts, true}
}
func NewPointerExtension(name string, priority int, oid string) *PointerExtension {
return &PointerExtension{name, priority, oid, oidType}
}
func (p *Pointer) Encode(writer io.Writer) (int, error) {
return EncodePointer(writer, p)
}
func (p *Pointer) Encoded() string {
if p.Size == 0 {
return ""
}
var buffer bytes.Buffer
buffer.WriteString(fmt.Sprintf("version %s\n", latest))
for _, ext := range p.Extensions {
buffer.WriteString(fmt.Sprintf("ext-%d-%s %s:%s\n", ext.Priority, ext.Name, ext.OidType, ext.Oid))
}
buffer.WriteString(fmt.Sprintf("oid %s:%s\n", p.OidType, p.Oid))
buffer.WriteString(fmt.Sprintf("size %d\n", p.Size))
return buffer.String()
}
func EmptyPointer() *Pointer {
return NewPointer(fs.EmptyObjectSHA256, 0, nil)
}
func EncodePointer(writer io.Writer, pointer *Pointer) (int, error) {
return writer.Write([]byte(pointer.Encoded()))
}
func DecodePointerFromBlob(b *gitobj.Blob) (*Pointer, error) {
// Check size before reading
if b.Size >= blobSizeCutoff {
return nil, errors.NewNotAPointerError(errors.New(tr.Tr.Get("blob size exceeds Git LFS pointer size cutoff")))
}
return DecodePointer(b.Contents)
}
func DecodePointerFromFile(file string) (*Pointer, error) {
// Check size before reading
stat, err := os.Stat(file)
if err != nil {
return nil, err
}
if stat.Size() >= blobSizeCutoff {
return nil, errors.NewNotAPointerError(errors.New(tr.Tr.Get("file size exceeds Git LFS pointer size cutoff")))
}
f, err := os.OpenFile(file, os.O_RDONLY, 0644)
if err != nil {
return nil, err
}
defer f.Close()
return DecodePointer(f)
}
func DecodePointer(reader io.Reader) (*Pointer, error) {
p, _, err := DecodeFrom(reader)
return p, err
}
// DecodeFrom decodes an *lfs.Pointer from the given io.Reader, "reader".
// If the pointer encoded in the reader could successfully be read and decoded,
// it will be returned with a nil error.
//
// If the pointer could not be decoded, an io.Reader containing the entire
// blob's data will be returned, along with a parse error.
func DecodeFrom(reader io.Reader) (*Pointer, io.Reader, error) {
buf := make([]byte, blobSizeCutoff)
n, err := reader.Read(buf)
buf = buf[:n]
var contents io.Reader = bytes.NewReader(buf)
if err != io.EOF {
contents = io.MultiReader(contents, reader)
}
if err != nil && err != io.EOF {
return nil, contents, err
}
if len(buf) == 0 {
return EmptyPointer(), contents, nil
}
p, err := decodeKV(bytes.TrimSpace(buf))
if err == nil && p != nil {
p.Canonical = p.Encoded() == string(buf)
}
return p, contents, err
}
func verifyVersion(version string) error {
if len(version) == 0 {
return errors.NewNotAPointerError(errors.New(tr.Tr.Get("Missing version")))
}
for _, v := range v1Aliases {
if v == version {
return nil
}
}
return errors.New(tr.Tr.Get("Invalid version: %s", version))
}
func decodeKV(data []byte) (*Pointer, error) {
kvps, exts, err := decodeKVData(data)
if err != nil {
if errors.IsBadPointerKeyError(err) {
return nil, errors.StandardizeBadPointerError(err)
}
return nil, err
}
if err := verifyVersion(kvps["version"]); err != nil {
return nil, err
}
value, ok := kvps["oid"]
if !ok {
return nil, errors.New(tr.Tr.Get("Invalid OID"))
}
oid, err := parseOid(value)
if err != nil {
return nil, err
}
value, ok = kvps["size"]
size, err := strconv.ParseInt(value, 10, 64)
if err != nil || size < 0 {
return nil, errors.New(tr.Tr.Get("invalid size: %q", value))
}
var extensions []*PointerExtension
if exts != nil {
for key, value := range exts {
ext, err := parsePointerExtension(key, value)
if err != nil {
return nil, err
}
extensions = append(extensions, ext)
}
if err = validatePointerExtensions(extensions); err != nil {
return nil, err
}
sort.Sort(ByPriority(extensions))
}
return NewPointer(oid, size, extensions), nil
}
func parseOid(value string) (string, error) {
parts := strings.SplitN(value, ":", 2)
if len(parts) != 2 {
return "", errors.New(tr.Tr.Get("Invalid OID value: %s", value))
}
if parts[0] != oidType {
return "", errors.New(tr.Tr.Get("Invalid OID type: %s", parts[0]))
}
oid := parts[1]
if !oidRE.MatchString(oid) {
return "", errors.New(tr.Tr.Get("Invalid OID: %s", oid))
}
return oid, nil
}
func parsePointerExtension(key string, value string) (*PointerExtension, error) {
keyParts := strings.SplitN(key, "-", 3)
if len(keyParts) != 3 || keyParts[0] != "ext" {
return nil, errors.New(tr.Tr.Get("Invalid extension value: %s", value))
}
p, err := strconv.Atoi(keyParts[1])
if err != nil || p < 0 {
return nil, errors.New(tr.Tr.Get("Invalid priority: %s", keyParts[1]))
}
name := keyParts[2]
oid, err := parseOid(value)
if err != nil {
return nil, err
}
return NewPointerExtension(name, p, oid), nil
}
func validatePointerExtensions(exts []*PointerExtension) error {
m := make(map[int]struct{})
for _, ext := range exts {
if _, exist := m[ext.Priority]; exist {
return errors.New(tr.Tr.Get("duplicate priority found: %d", ext.Priority))
}
m[ext.Priority] = struct{}{}
}
return nil
}
func decodeKVData(data []byte) (kvps map[string]string, exts map[string]string, err error) {
kvps = make(map[string]string)
if !matcherRE.Match(data) {
err = errors.NewNotAPointerError(errors.New(tr.Tr.Get("invalid header")))
return
}
scanner := bufio.NewScanner(bytes.NewBuffer(data))
line := 0
numKeys := len(pointerKeys)
for scanner.Scan() {
text := scanner.Text()
if len(text) == 0 {
continue
}
parts := strings.SplitN(text, " ", 2)
if len(parts) < 2 {
err = errors.NewNotAPointerError(errors.New(tr.Tr.Get("error reading line %d: %s", line, text)))
return
}
key := parts[0]
value := parts[1]
if numKeys <= line {
err = errors.NewNotAPointerError(errors.New(tr.Tr.Get("extra line: %s", text)))
return
}
if expected := pointerKeys[line]; key != expected {
if !extRE.MatchString(key) {
err = errors.NewBadPointerKeyError(expected, key)
return
}
if exts == nil {
exts = make(map[string]string)
}
exts[key] = value
continue
}
line += 1
kvps[key] = value
}
err = scanner.Err()
return
}
|