2018-11-28 00:52:20 +03:00
// Copyright 2018 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2018-11-28 00:52:20 +03:00
package git
2022-09-04 13:47:56 +03:00
import (
"regexp"
"strings"
)
2020-11-08 20:21:54 +03:00
2021-12-02 10:28:08 +03:00
const (
// RemotePrefix is the base directory of the remotes information of git.
RemotePrefix = "refs/remotes/"
// PullPrefix is the base directory of the pull information of git.
PullPrefix = "refs/pull/"
pullLen = len ( PullPrefix )
)
2022-09-04 13:47:56 +03:00
// refNamePatternInvalid is regular expression with unallowed characters in git reference name
// They cannot have ASCII control characters (i.e. bytes whose values are lower than \040, or \177 DEL), space, tilde ~, caret ^, or colon : anywhere.
// They cannot have question-mark ?, asterisk *, or open bracket [ anywhere
var refNamePatternInvalid = regexp . MustCompile (
` [\000-\037\177 \\~^:?*[]| ` + // No absolutely invalid characters
` (?:^[/.])| ` + // Not HasPrefix("/") or "."
` (?:/\.)| ` + // no "/."
` (?:\.lock$)|(?:\.lock/)| ` + // No ".lock/"" or ".lock" at the end
` (?:\.\.)| ` + // no ".." anywhere
` (?://)| ` + // no "//" anywhere
` (?:@ { )| ` + // no "@{"
` (?:[/.]$)| ` + // no terminal '/' or '.'
` (?:^@$) ` ) // Not "@"
// IsValidRefPattern ensures that the provided string could be a valid reference
func IsValidRefPattern ( name string ) bool {
return ! refNamePatternInvalid . MatchString ( name )
}
func SanitizeRefPattern ( name string ) string {
return refNamePatternInvalid . ReplaceAllString ( name , "_" )
}
2018-11-28 00:52:20 +03:00
// Reference represents a Git ref.
type Reference struct {
Name string
repo * Repository
Object SHA1 // The id of this commit object
Type string
}
// Commit return the commit of the reference
func ( ref * Reference ) Commit ( ) ( * Commit , error ) {
return ref . repo . getCommit ( ref . Object )
}
2020-11-08 20:21:54 +03:00
// ShortName returns the short name of the reference
func ( ref * Reference ) ShortName ( ) string {
2022-12-01 14:56:04 +03:00
return RefName ( ref . Name ) . ShortName ( )
}
// RefGroup returns the group type of the reference
func ( ref * Reference ) RefGroup ( ) string {
return RefName ( ref . Name ) . RefGroup ( )
}
// RefName represents a git reference name
type RefName string
func ( ref RefName ) IsBranch ( ) bool {
return strings . HasPrefix ( string ( ref ) , BranchPrefix )
}
func ( ref RefName ) IsTag ( ) bool {
return strings . HasPrefix ( string ( ref ) , TagPrefix )
}
// ShortName returns the short name of the reference name
func ( ref RefName ) ShortName ( ) string {
refName := string ( ref )
if strings . HasPrefix ( refName , BranchPrefix ) {
return strings . TrimPrefix ( refName , BranchPrefix )
2020-11-08 20:21:54 +03:00
}
2022-12-01 14:56:04 +03:00
if strings . HasPrefix ( refName , TagPrefix ) {
return strings . TrimPrefix ( refName , TagPrefix )
2020-11-08 20:21:54 +03:00
}
2022-12-01 14:56:04 +03:00
if strings . HasPrefix ( refName , RemotePrefix ) {
return strings . TrimPrefix ( refName , RemotePrefix )
2020-11-08 20:21:54 +03:00
}
2022-12-01 14:56:04 +03:00
if strings . HasPrefix ( refName , PullPrefix ) && strings . IndexByte ( refName [ pullLen : ] , '/' ) > - 1 {
return refName [ pullLen : strings . IndexByte ( refName [ pullLen : ] , '/' ) + pullLen ]
2020-11-08 20:21:54 +03:00
}
2022-12-01 14:56:04 +03:00
return refName
2020-11-08 20:21:54 +03:00
}
// RefGroup returns the group type of the reference
2022-12-01 14:56:04 +03:00
func ( ref RefName ) RefGroup ( ) string {
refName := string ( ref )
if strings . HasPrefix ( refName , BranchPrefix ) {
2020-11-08 20:21:54 +03:00
return "heads"
}
2022-12-01 14:56:04 +03:00
if strings . HasPrefix ( refName , TagPrefix ) {
2020-11-08 20:21:54 +03:00
return "tags"
}
2022-12-01 14:56:04 +03:00
if strings . HasPrefix ( refName , RemotePrefix ) {
2020-11-08 20:21:54 +03:00
return "remotes"
}
2022-12-01 14:56:04 +03:00
if strings . HasPrefix ( refName , PullPrefix ) && strings . IndexByte ( refName [ pullLen : ] , '/' ) > - 1 {
2020-11-08 20:21:54 +03:00
return "pull"
}
return ""
}