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 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
|
// Package git contains various commands that shell out to git
// NOTE: Subject to change, do not rely on this package from outside git-lfs source
package git
import (
"bufio"
"bytes"
"crypto/sha1"
"crypto/sha256"
"encoding/hex"
"errors"
"fmt"
"io"
"net/url"
"os"
"path/filepath"
"regexp"
"strconv"
"strings"
"sync"
"time"
lfserrors "github.com/git-lfs/git-lfs/v3/errors"
"github.com/git-lfs/git-lfs/v3/subprocess"
"github.com/git-lfs/git-lfs/v3/tools"
"github.com/git-lfs/git-lfs/v3/tr"
"github.com/git-lfs/gitobj/v2"
"github.com/rubyist/tracerx"
)
type RefType int
const (
RefTypeLocalBranch = RefType(iota)
RefTypeRemoteBranch = RefType(iota)
RefTypeLocalTag = RefType(iota)
RefTypeRemoteTag = RefType(iota)
RefTypeHEAD = RefType(iota) // current checkout
RefTypeOther = RefType(iota) // stash or unknown
SHA1HexSize = sha1.Size * 2
SHA256HexSize = sha256.Size * 2
)
var (
ObjectIDRegex = fmt.Sprintf("(?:[0-9a-f]{%d}(?:[0-9a-f]{%d})?)", SHA1HexSize, SHA256HexSize-SHA1HexSize)
// ObjectIDLengths is a slice of valid Git hexadecimal object ID
// lengths in increasing order.
ObjectIDLengths = []int{SHA1HexSize, SHA256HexSize}
emptyTree = ""
emptyTreeMutex = &sync.Mutex{}
)
type IndexStage int
const (
IndexStageDefault IndexStage = iota
IndexStageBase
IndexStageOurs
IndexStageTheirs
)
// Prefix returns the given RefType's prefix, "refs/heads", "ref/remotes",
// etc. It returns an additional value of either true/false, whether or not this
// given ref type has a prefix.
//
// If the RefType is unrecognized, Prefix() will panic.
func (t RefType) Prefix() (string, bool) {
switch t {
case RefTypeLocalBranch:
return "refs/heads", true
case RefTypeRemoteBranch:
return "refs/remotes", true
case RefTypeLocalTag:
return "refs/tags", true
default:
return "", false
}
}
func ParseRef(absRef, sha string) *Ref {
r := &Ref{Sha: sha}
if strings.HasPrefix(absRef, "refs/heads/") {
r.Name = absRef[11:]
r.Type = RefTypeLocalBranch
} else if strings.HasPrefix(absRef, "refs/tags/") {
r.Name = absRef[10:]
r.Type = RefTypeLocalTag
} else if strings.HasPrefix(absRef, "refs/remotes/") {
r.Name = absRef[13:]
r.Type = RefTypeRemoteBranch
} else {
r.Name = absRef
if absRef == "HEAD" {
r.Type = RefTypeHEAD
} else {
r.Type = RefTypeOther
}
}
return r
}
// A git reference (branch, tag etc)
type Ref struct {
Name string
Type RefType
Sha string
}
// Refspec returns the fully-qualified reference name (including remote), i.e.,
// for a remote branch called 'my-feature' on remote 'origin', this function
// will return:
//
// refs/remotes/origin/my-feature
func (r *Ref) Refspec() string {
if r == nil {
return ""
}
prefix, ok := r.Type.Prefix()
if ok {
return fmt.Sprintf("%s/%s", prefix, r.Name)
}
return r.Name
}
// HasValidObjectIDLength returns true if `s` has a length that is a valid
// hexadecimal Git object ID length.
func HasValidObjectIDLength(s string) bool {
for _, length := range ObjectIDLengths {
if len(s) == length {
return true
}
}
return false
}
// IsZeroObjectID returns true if the string is a valid hexadecimal Git object
// ID and represents the all-zeros object ID for some hash algorithm.
func IsZeroObjectID(s string) bool {
for _, length := range ObjectIDLengths {
if s == strings.Repeat("0", length) {
return true
}
}
return false
}
func EmptyTree() (string, error) {
emptyTreeMutex.Lock()
defer emptyTreeMutex.Unlock()
if len(emptyTree) == 0 {
cmd, err := gitNoLFS("hash-object", "-t", "tree", "/dev/null")
if err != nil {
return "", errors.New(tr.Tr.Get("failed to find `git hash-object`: %v", err))
}
cmd.Stdin = nil
out, _ := cmd.Output()
emptyTree = strings.TrimSpace(string(out))
}
return emptyTree, nil
}
// Some top level information about a commit (only first line of message)
type CommitSummary struct {
Sha string
ShortSha string
Parents []string
CommitDate time.Time
AuthorDate time.Time
AuthorName string
AuthorEmail string
CommitterName string
CommitterEmail string
Subject string
}
// Prepend Git config instructions to disable Git LFS filter
func gitConfigNoLFS(args ...string) []string {
// Before git 2.8, setting filters to blank causes lots of warnings, so use cat instead (slightly slower)
// Also pre 2.2 it failed completely. We used to use it anyway in git 2.2-2.7 and
// suppress the messages in stderr, but doing that with standard StderrPipe suppresses
// the git clone output (git thinks it's not a terminal) and makes it look like it's
// not working. You can get around that with https://github.com/kr/pty but that
// causes difficult issues with passing through Stdin for login prompts
// This way is simpler & more practical.
filterOverride := ""
if !IsGitVersionAtLeast("2.8.0") {
filterOverride = "cat"
}
return append([]string{
"-c", fmt.Sprintf("filter.lfs.smudge=%v", filterOverride),
"-c", fmt.Sprintf("filter.lfs.clean=%v", filterOverride),
"-c", "filter.lfs.process=",
"-c", "filter.lfs.required=false",
}, args...)
}
// Invoke Git with disabled LFS filters
func gitNoLFS(args ...string) (*subprocess.Cmd, error) {
return subprocess.ExecCommand("git", gitConfigNoLFS(args...)...)
}
func gitNoLFSSimple(args ...string) (string, error) {
return subprocess.SimpleExec("git", gitConfigNoLFS(args...)...)
}
func gitNoLFSBuffered(args ...string) (*subprocess.BufferedCmd, error) {
return subprocess.BufferedExec("git", gitConfigNoLFS(args...)...)
}
func gitNoLFSBufferedStdout(args ...string) (*subprocess.BufferedCmd, error) {
return subprocess.StdoutBufferedExec("git", gitConfigNoLFS(args...)...)
}
// Invoke Git with enabled LFS filters
func git(args ...string) (*subprocess.Cmd, error) {
return subprocess.ExecCommand("git", args...)
}
func gitSimple(args ...string) (string, error) {
return subprocess.SimpleExec("git", args...)
}
func gitBuffered(args ...string) (*subprocess.BufferedCmd, error) {
return subprocess.BufferedExec("git", args...)
}
func gitBufferedStdout(args ...string) (*subprocess.BufferedCmd, error) {
return subprocess.StdoutBufferedExec("git", args...)
}
func CatFile() (*subprocess.BufferedCmd, error) {
return gitNoLFSBuffered("cat-file", "--batch-check")
}
func DiffIndex(ref string, cached bool, refresh bool, workingDir string) (*bufio.Scanner, error) {
if refresh {
_, err := gitSimple("update-index", "-q", "--refresh")
if err != nil {
return nil, lfserrors.Wrap(err, tr.Tr.Get("Failed to run `git update-index`"))
}
}
args := []string{"diff-index", "-M"}
if cached {
args = append(args, "--cached")
}
args = append(args, ref)
if workingDir != "" {
args = append([]string{"-C", workingDir}, args...)
}
cmd, err := gitBufferedStdout(args...)
if err != nil {
return nil, err
}
if err = cmd.Stdin.Close(); err != nil {
return nil, err
}
return bufio.NewScanner(cmd.Stdout), nil
}
func DiffIndexWithPaths(ref string, cached bool, paths []string) (string, error) {
args := []string{"diff-index"}
if cached {
args = append(args, "--cached")
}
args = append(args, ref)
args = append(args, "--")
args = append(args, paths...)
output, err := gitSimple(args...)
if err != nil {
return "", err
}
return output, nil
}
func HashObject(r io.Reader) (string, error) {
cmd, err := gitNoLFS("hash-object", "--stdin")
if err != nil {
return "", errors.New(tr.Tr.Get("failed to find `git hash-object`: %v", err))
}
cmd.Stdin = r
out, err := cmd.Output()
if err != nil {
return "", errors.New(tr.Tr.Get("error building Git blob OID: %s", err))
}
return string(bytes.TrimSpace(out)), nil
}
func Log(args ...string) (*subprocess.BufferedCmd, error) {
logArgs := append([]string{"log"}, args...)
return gitNoLFSBuffered(logArgs...)
}
func LsRemote(remote, remoteRef string) (string, error) {
if remote == "" {
return "", errors.New(tr.Tr.Get("remote required"))
}
if remoteRef == "" {
return gitNoLFSSimple("ls-remote", remote)
}
return gitNoLFSSimple("ls-remote", remote, remoteRef)
}
func LsTree(ref string) (*subprocess.BufferedCmd, error) {
return gitNoLFSBuffered(
"ls-tree",
"-r", // recurse
"-l", // report object size (we'll need this)
"-z", // null line termination
"--full-tree", // start at the root regardless of where we are in it
ref,
)
}
func LsFilesLFS() (*subprocess.BufferedCmd, error) {
// This requires Git 2.42.0 for `--format` with `objecttype`.
return gitNoLFSBuffered(
"ls-files",
"--cached",
"--exclude-standard",
"--full-name",
"--sparse",
"-z",
"--format=%(objectmode) %(objecttype) %(objectname) %(objectsize)\t%(path)",
":(top,attr:filter=lfs)",
)
}
func ResolveRef(ref string) (*Ref, error) {
outp, err := gitNoLFSSimple("rev-parse", ref, "--symbolic-full-name", ref)
if err != nil {
return nil, errors.New(tr.Tr.Get("Git can't resolve ref: %q", ref))
}
if outp == "" {
return nil, errors.New(tr.Tr.Get("Git can't resolve ref: %q", ref))
}
lines := strings.Split(outp, "\n")
fullref := &Ref{Sha: lines[0]}
if len(lines) == 1 {
// ref is a sha1 and has no symbolic-full-name
fullref.Name = lines[0]
fullref.Sha = lines[0]
fullref.Type = RefTypeOther
return fullref, nil
}
// parse the symbolic-full-name
fullref.Type, fullref.Name = ParseRefToTypeAndName(lines[1])
return fullref, nil
}
func ResolveRefs(refnames []string) ([]*Ref, error) {
refs := make([]*Ref, len(refnames))
for i, name := range refnames {
ref, err := ResolveRef(name)
if err != nil {
return refs, err
}
refs[i] = ref
}
return refs, nil
}
func CurrentRef() (*Ref, error) {
return ResolveRef("HEAD")
}
func (c *Configuration) CurrentRemoteRef() (*Ref, error) {
remoteref, err := c.RemoteRefNameForCurrentBranch()
if err != nil {
return nil, err
}
return ResolveRef(remoteref)
}
// RemoteRefForCurrentBranch returns the full remote ref (refs/remotes/{remote}/{remotebranch})
// that the current branch is tracking.
func (c *Configuration) RemoteRefNameForCurrentBranch() (string, error) {
ref, err := CurrentRef()
if err != nil {
return "", err
}
if ref.Type == RefTypeHEAD || ref.Type == RefTypeOther {
return "", errors.New(tr.Tr.Get("not on a branch"))
}
remote := c.RemoteForBranch(ref.Name)
if remote == "" {
return "", errors.New(tr.Tr.Get("remote not found for branch %q", ref.Name))
}
remotebranch := c.RemoteBranchForLocalBranch(ref.Name)
return fmt.Sprintf("refs/remotes/%s/%s", remote, remotebranch), nil
}
// RemoteForBranch returns the remote name that a given local branch is tracking (blank if none)
func (c *Configuration) RemoteForBranch(localBranch string) string {
return c.Find(fmt.Sprintf("branch.%s.remote", localBranch))
}
// RemoteBranchForLocalBranch returns the name (only) of the remote branch that the local branch is tracking
// If no specific branch is configured, returns local branch name
func (c *Configuration) RemoteBranchForLocalBranch(localBranch string) string {
// get remote ref to track, may not be same name
merge := c.Find(fmt.Sprintf("branch.%s.merge", localBranch))
if strings.HasPrefix(merge, "refs/heads/") {
return merge[11:]
} else {
return localBranch
}
}
func RemoteList() ([]string, error) {
cmd, err := gitNoLFS("remote")
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git remote`: %v", err))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git remote`: %v", err))
}
cmd.Start()
defer cmd.Wait()
scanner := bufio.NewScanner(outp)
var ret []string
for scanner.Scan() {
ret = append(ret, strings.TrimSpace(scanner.Text()))
}
return ret, nil
}
func RemoteURLs(push bool) (map[string][]string, error) {
cmd, err := gitNoLFS("remote", "-v")
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git remote -v`: %v", err))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git remote -v`: %v", err))
}
cmd.Start()
defer cmd.Wait()
scanner := bufio.NewScanner(outp)
text := "(fetch)"
if push {
text = "(push)"
}
ret := make(map[string][]string)
for scanner.Scan() {
// [remote, urlpair-text]
pair := strings.Split(strings.TrimSpace(scanner.Text()), "\t")
if len(pair) != 2 {
continue
}
// [url, "(fetch)" | "(push)"]
urlpair := strings.Split(pair[1], " ")
if len(urlpair) != 2 || urlpair[1] != text {
continue
}
ret[pair[0]] = append(ret[pair[0]], urlpair[0])
}
return ret, nil
}
func MapRemoteURL(url string, push bool) (string, bool) {
urls, err := RemoteURLs(push)
if err != nil {
return url, false
}
for name, remotes := range urls {
if len(remotes) == 1 && url == remotes[0] {
return name, true
}
}
return url, false
}
// Refs returns all of the local and remote branches and tags for the current
// repository. Other refs (HEAD, refs/stash, git notes) are ignored.
func LocalRefs() ([]*Ref, error) {
cmd, err := gitNoLFS("show-ref")
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git show-ref`: %v", err))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git show-ref`: %v", err))
}
var refs []*Ref
if err := cmd.Start(); err != nil {
return refs, err
}
scanner := bufio.NewScanner(outp)
for scanner.Scan() {
line := strings.TrimSpace(scanner.Text())
parts := strings.SplitN(line, " ", 2)
if len(parts) != 2 || !HasValidObjectIDLength(parts[0]) || len(parts[1]) < 1 {
tracerx.Printf("Invalid line from `git show-ref`: %q", line)
continue
}
rtype, name := ParseRefToTypeAndName(parts[1])
if rtype != RefTypeLocalBranch && rtype != RefTypeLocalTag {
continue
}
refs = append(refs, &Ref{name, rtype, parts[0]})
}
return refs, cmd.Wait()
}
// UpdateRef moves the given ref to a new sha with a given reason (and creates a
// reflog entry, if a "reason" was provided). It returns an error if any were
// encountered.
func UpdateRef(ref *Ref, to []byte, reason string) error {
return UpdateRefIn("", ref, to, reason)
}
// UpdateRef moves the given ref to a new sha with a given reason (and creates a
// reflog entry, if a "reason" was provided). It operates within the given
// working directory "wd". It returns an error if any were encountered.
func UpdateRefIn(wd string, ref *Ref, to []byte, reason string) error {
args := []string{"update-ref", ref.Refspec(), hex.EncodeToString(to)}
if len(reason) > 0 {
args = append(args, "-m", reason)
}
cmd, err := gitNoLFS(args...)
if err != nil {
return errors.New(tr.Tr.Get("failed to find `git update-ref`: %v", err))
}
cmd.Dir = wd
return cmd.Run()
}
// ValidateRemote checks that a named remote is valid for use
// Mainly to check user-supplied remotes & fail more nicely
func ValidateRemote(remote string) error {
remotes, err := RemoteList()
if err != nil {
return err
}
return ValidateRemoteFromList(remotes, remote)
}
// ValidateRemote checks that a named remote is valid for use given a list from
// RemoteList. This is completely identical to ValidateRemote, except that it
// allows caching the remote list.
func ValidateRemoteFromList(remotes []string, remote string) error {
for _, r := range remotes {
if r == remote {
return nil
}
}
if err := ValidateRemoteURL(remote); err == nil {
return nil
}
return errors.New(tr.Tr.Get("invalid remote name: %q", remote))
}
// ValidateRemoteURL checks that a string is a valid Git remote URL
func ValidateRemoteURL(remote string) error {
u, _ := url.Parse(remote)
if u == nil || u.Scheme == "" {
// This is either an invalid remote name (maybe the user made a typo
// when selecting a named remote) or a bare SSH URL like
// "x@y.com:path/to/resource.git". Guess that this is a URL in the latter
// form if the string contains a colon ":", and an invalid remote if it
// does not.
if strings.Contains(remote, ":") {
return nil
} else {
return errors.New(tr.Tr.Get("invalid remote name: %q", remote))
}
}
switch u.Scheme {
case "ssh", "http", "https", "git", "file":
return nil
default:
return errors.New(tr.Tr.Get("invalid remote URL protocol %q in %q", u.Scheme, remote))
}
}
func RewriteLocalPathAsURL(path string) string {
var slash string
if abs, err := filepath.Abs(path); err == nil {
// Required for Windows paths to work.
if !strings.HasPrefix(abs, "/") {
slash = "/"
}
path = abs
}
var gitpath string
if filepath.Base(path) == ".git" {
gitpath = path
path = filepath.Dir(path)
} else {
gitpath = filepath.Join(path, ".git")
}
if _, err := os.Stat(gitpath); err == nil {
path = gitpath
} else if _, err := os.Stat(path); err != nil {
// Not a local path. We check down here because we perform
// canonicalization by stripping off the .git above.
return path
}
return fmt.Sprintf("file://%s%s", slash, filepath.ToSlash(path))
}
func UpdateIndexFromStdin() (*subprocess.Cmd, error) {
return git("update-index", "-q", "--refresh", "--stdin")
}
// RecentBranches returns branches with commit dates on or after the given date/time
// Return full Ref type for easier detection of duplicate SHAs etc
// since: refs with commits on or after this date will be included
// includeRemoteBranches: true to include refs on remote branches
// onlyRemote: set to non-blank to only include remote branches on a single remote
func RecentBranches(since time.Time, includeRemoteBranches bool, onlyRemote string) ([]*Ref, error) {
cmd, err := gitNoLFS("for-each-ref",
`--sort=-committerdate`,
`--format=%(refname) %(objectname) %(committerdate:iso)`,
"refs")
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git for-each-ref`: %v", err))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git for-each-ref`: %v", err))
}
cmd.Start()
defer cmd.Wait()
scanner := bufio.NewScanner(outp)
// Output is like this:
// refs/heads/master f03686b324b29ff480591745dbfbbfa5e5ac1bd5 2015-08-19 16:50:37 +0100
// refs/remotes/origin/master ad3b29b773e46ad6870fdf08796c33d97190fe93 2015-08-13 16:50:37 +0100
// Output is ordered by latest commit date first, so we can stop at the threshold
regex := regexp.MustCompile(fmt.Sprintf(`^(refs/[^/]+/\S+)\s+(%s)\s+(\d{4}-\d{2}-\d{2}\s+\d{2}\:\d{2}\:\d{2}\s+[\+\-]\d{4})`, ObjectIDRegex))
tracerx.Printf("RECENT: Getting refs >= %v", since)
var ret []*Ref
for scanner.Scan() {
line := scanner.Text()
if match := regex.FindStringSubmatch(line); match != nil {
fullref := match[1]
sha := match[2]
reftype, ref := ParseRefToTypeAndName(fullref)
if reftype == RefTypeRemoteBranch {
if !includeRemoteBranches {
continue
}
if onlyRemote != "" && !strings.HasPrefix(ref, onlyRemote+"/") {
continue
}
}
// This is a ref we might use
// Check the date
commitDate, err := ParseGitDate(match[3])
if err != nil {
return ret, err
}
if commitDate.Before(since) {
// the end
break
}
tracerx.Printf("RECENT: %v (%v)", ref, commitDate)
ret = append(ret, &Ref{ref, reftype, sha})
}
}
return ret, nil
}
// Get the type & name of a git reference
func ParseRefToTypeAndName(fullref string) (t RefType, name string) {
const localPrefix = "refs/heads/"
const remotePrefix = "refs/remotes/"
const localTagPrefix = "refs/tags/"
if fullref == "HEAD" {
name = fullref
t = RefTypeHEAD
} else if strings.HasPrefix(fullref, localPrefix) {
name = fullref[len(localPrefix):]
t = RefTypeLocalBranch
} else if strings.HasPrefix(fullref, remotePrefix) {
name = fullref[len(remotePrefix):]
t = RefTypeRemoteBranch
} else if strings.HasPrefix(fullref, localTagPrefix) {
name = fullref[len(localTagPrefix):]
t = RefTypeLocalTag
} else {
name = fullref
t = RefTypeOther
}
return
}
// Parse a Git date formatted in ISO 8601 format (%ci/%ai)
func ParseGitDate(str string) (time.Time, error) {
// Unfortunately Go and Git don't overlap in their builtin date formats
// Go's time.RFC1123Z and Git's %cD are ALMOST the same, except that
// when the day is < 10 Git outputs a single digit, but Go expects a leading
// zero - this is enough to break the parsing. Sigh.
// Format is for 2 Jan 2006, 15:04:05 -7 UTC as per Go
return time.Parse("2006-01-02 15:04:05 -0700", str)
}
// FormatGitDate converts a Go date into a git command line format date
func FormatGitDate(tm time.Time) string {
// Git format is "Fri Jun 21 20:26:41 2013 +0900" but no zero-leading for day
return tm.Format("Mon Jan 2 15:04:05 2006 -0700")
}
// Get summary information about a commit
func GetCommitSummary(commit string) (*CommitSummary, error) {
cmd, err := gitNoLFS("show", "-s",
`--format=%H|%h|%P|%ai|%ci|%ae|%an|%ce|%cn|%s`, commit)
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git show`: %v", err))
}
out, err := cmd.CombinedOutput()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git show`: %v %v", err, string(out)))
}
// At most 10 substrings so subject line is not split on anything
fields := strings.SplitN(string(out), "|", 10)
// Cope with the case where subject is blank
if len(fields) >= 9 {
ret := &CommitSummary{}
// Get SHAs from output, not commit input, so we can support symbolic refs
ret.Sha = fields[0]
ret.ShortSha = fields[1]
ret.Parents = strings.Split(fields[2], " ")
// %aD & %cD (RFC2822) matches Go's RFC1123Z format
ret.AuthorDate, _ = ParseGitDate(fields[3])
ret.CommitDate, _ = ParseGitDate(fields[4])
ret.AuthorEmail = fields[5]
ret.AuthorName = fields[6]
ret.CommitterEmail = fields[7]
ret.CommitterName = fields[8]
if len(fields) > 9 {
ret.Subject = strings.TrimRight(fields[9], "\n")
}
return ret, nil
} else {
msg := tr.Tr.Get("Unexpected output from `git show`: %v", string(out))
return nil, errors.New(msg)
}
}
func GitAndRootDirs() (string, string, error) {
cmd, err := gitNoLFS("rev-parse", "--git-dir", "--show-toplevel")
if err != nil {
return "", "", errors.New(tr.Tr.Get("failed to find `git rev-parse --git-dir --show-toplevel`: %v", err))
}
buf := &bytes.Buffer{}
cmd.Stderr = buf
out, err := cmd.Output()
output := string(out)
if err != nil {
// If we got a fatal error, it's possible we're on a newer
// (2.24+) Git and we're not in a worktree, so fall back to just
// looking up the repo directory.
if lfserrors.ExitStatus(err) == 128 {
absGitDir, err := GitDir()
return absGitDir, "", err
}
return "", "", errors.New(tr.Tr.Get("failed to call `git rev-parse --git-dir --show-toplevel`: %q", buf.String()))
}
paths := strings.Split(output, "\n")
pathLen := len(paths)
if pathLen == 0 {
return "", "", errors.New(tr.Tr.Get("bad `git rev-parse` output: %q", output))
}
absGitDir, err := tools.CanonicalizePath(paths[0], false)
if err != nil {
return "", "", errors.New(tr.Tr.Get("error converting %q to absolute: %s", paths[0], err))
}
if pathLen == 1 || len(paths[1]) == 0 {
return absGitDir, "", nil
}
absRootDir, err := tools.CanonicalizePath(paths[1], false)
return absGitDir, absRootDir, err
}
func RootDir() (string, error) {
cmd, err := gitNoLFS("rev-parse", "--show-toplevel")
if err != nil {
return "", errors.New(tr.Tr.Get("failed to find `git rev-parse --show-toplevel`: %v", err))
}
out, err := cmd.Output()
if err != nil {
return "", errors.New(tr.Tr.Get("failed to call `git rev-parse --show-toplevel`: %v %v", err, string(out)))
}
path := strings.TrimSpace(string(out))
path, err = tools.TranslateCygwinPath(path)
if err != nil {
return "", err
}
if len(path) == 0 {
return "", errors.New(tr.Tr.Get("no output from `git rev-parse --show-toplevel`"))
}
return tools.CanonicalizePath(path, false)
}
func GitDir() (string, error) {
cmd, err := gitNoLFS("rev-parse", "--git-dir")
if err != nil {
// The %w format specifier is unique to fmt.Errorf(), so we
// do not pass it to tr.Tr.Get().
return "", fmt.Errorf("%s: %w", tr.Tr.Get("failed to find `git rev-parse --git-dir`"), err)
}
buf := &bytes.Buffer{}
cmd.Stderr = buf
out, err := cmd.Output()
if err != nil {
// The %w format specifier is unique to fmt.Errorf(), so we
// do not pass it to tr.Tr.Get().
return "", fmt.Errorf("%s: %w %v: %v", tr.Tr.Get("failed to call `git rev-parse --git-dir`"), err, string(out), buf.String())
}
path := strings.TrimSpace(string(out))
return tools.CanonicalizePath(path, false)
}
func GitCommonDir() (string, error) {
// Versions before 2.5.0 don't have the --git-common-dir option, since
// it came in with worktrees, so just fall back to the main Git
// directory.
if !IsGitVersionAtLeast("2.5.0") {
return GitDir()
}
cmd, err := gitNoLFS("rev-parse", "--git-common-dir")
if err != nil {
return "", errors.New(tr.Tr.Get("failed to find `git rev-parse --git-common-dir`: %v", err))
}
out, err := cmd.Output()
buf := &bytes.Buffer{}
cmd.Stderr = buf
if err != nil {
return "", errors.New(tr.Tr.Get("failed to call `git rev-parse --git-common-dir`: %v %v: %v", err, string(out), buf.String()))
}
path := strings.TrimSpace(string(out))
path, err = tools.TranslateCygwinPath(path)
if err != nil {
return "", err
}
return tools.CanonicalizePath(path, false)
}
// A git worktree (ref + path + flags)
type Worktree struct {
Ref Ref
Dir string
Prunable bool
}
// GetAllWorktrees returns the refs that all worktrees are using as HEADs plus the worktree's path.
// This returns all worktrees plus the main working copy, and works even if
// working dir is actually in a worktree right now
//
// Pass in the git storage dir (parent of 'objects') to work from, in case
// we need to fall back to reading the worktree files directly.
func GetAllWorktrees(storageDir string) ([]*Worktree, error) {
// Versions before 2.7.0 don't support "git-worktree list", and
// those before 2.36.0 don't support the "-z" option, so in these
// cases we fall back to reading the .git/worktrees directory entries
// and then reading the current worktree's HEAD ref. This requires
// the contents of .git/worktrees/*/gitdir files to be absolute paths,
// which is only true for Git versions prior to 2.48.0.
if !IsGitVersionAtLeast("2.36.0") {
return getAllWorktreesFromGitDir(storageDir)
}
cmd, err := gitNoLFS(
"worktree",
"list",
"--porcelain",
"-z", // handle special chars in filenames
)
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git worktree`: %v", err))
}
stdout, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to open output pipe to `git worktree`: %v", err))
}
stderr, err := cmd.StderrPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to open error pipe to `git worktree`: %v", err))
}
if err := cmd.Start(); err != nil {
return nil, errors.New(tr.Tr.Get("failed to start `git worktree`: %v", err))
}
scanner := bufio.NewScanner(stdout)
scanner.Split(tools.SplitOnNul)
var dir string
var ref *Ref
var prunable bool
var worktrees []*Worktree
for scanner.Scan() {
line := scanner.Text()
if len(line) == 0 {
if len(dir) > 0 && ref != nil && len(ref.Sha) > 0 {
worktrees = append(worktrees, &Worktree{
Ref: *ref,
Dir: dir,
Prunable: prunable,
})
}
dir = ""
ref = nil
continue
}
parts := strings.SplitN(scanner.Text(), " ", 2)
// We ignore other attributes such as "locked" for now.
switch parts[0] {
case "worktree":
if len(parts) == 2 && len(dir) == 0 {
dir = filepath.Clean(parts[1])
ref = &Ref{Type: RefTypeOther}
prunable = false
}
case "HEAD":
if len(parts) == 2 && ref != nil {
ref.Sha = parts[1]
ref.Name = parts[1]
}
case "branch":
if len(parts) == 2 && ref != nil && len(ref.Sha) > 0 {
ref = ParseRef(parts[1], ref.Sha)
}
case "bare":
// We ignore bare worktrees.
dir = ""
ref = nil
case "prunable":
prunable = true
}
}
// We assume any error output will be short and won't block
// command completion if it isn't drained by a separate goroutine.
msg, _ := io.ReadAll(stderr)
if err := cmd.Wait(); err != nil {
return nil, errors.New(tr.Tr.Get("error in `git worktree`: %v: %s", err, msg))
}
return worktrees, nil
}
func getAllWorktreesFromGitDir(storageDir string) ([]*Worktree, error) {
worktreesdir := filepath.Join(storageDir, "worktrees")
dirf, err := os.Open(worktreesdir)
if err != nil && !os.IsNotExist(err) {
return nil, err
}
var worktrees []*Worktree
if err == nil {
// There are some worktrees
defer dirf.Close()
direntries, err := dirf.Readdir(0)
if err != nil {
return nil, err
}
for _, dirfi := range direntries {
if dirfi.IsDir() {
// to avoid having to chdir and run git commands to identify the commit
// just read the HEAD file & git rev-parse if necessary
// Since the git repo is shared the same rev-parse will work from this location
headfile := filepath.Join(worktreesdir, dirfi.Name(), "HEAD")
ref, err := parseRefFile(headfile)
if err != nil {
tracerx.Printf("Error reading %v for worktree, skipping: %v", headfile, err)
continue
}
// Read the gitdir file to get the location of the git repo
dirfile := filepath.Join(worktreesdir, dirfi.Name(), "gitdir")
dir, err := parseDirFile(dirfile)
if err != nil {
tracerx.Printf("Error reading %v for worktree, skipping: %v", dirfile, err)
continue
}
// Check if the worktree exists.
dir = filepath.Dir(dir)
var prunable bool
if _, err := os.Stat(dir); err != nil {
if os.IsNotExist(err) {
prunable = true
} else {
tracerx.Printf("Error checking worktree directory %s: %v", dir, err)
}
}
worktrees = append(worktrees, &Worktree{
Ref: *ref,
Dir: dir,
Prunable: prunable,
})
}
}
}
// This has only established the separate worktrees, not the original checkout
// If the storageDir contains a HEAD file and a RootDir then there is a main checkout
// as well; this must be resolveable whether you're in the main checkout or
// a worktree
headfile := filepath.Join(storageDir, "HEAD")
ref, err := parseRefFile(headfile)
if err == nil {
dir, err := RootDir()
if err == nil {
worktrees = append(worktrees, &Worktree{
Ref: *ref,
Dir: dir,
Prunable: false,
})
} else { // ok if not exists, probably bare repo
tracerx.Printf("Error getting toplevel for main checkout, skipping: %v", err)
}
} else if !os.IsNotExist(err) { // ok if not exists, probably bare repo
tracerx.Printf("Error reading %v for main checkout, skipping: %v", headfile, err)
}
return worktrees, nil
}
// Manually parse a reference file like HEAD and return the Ref it resolves to
func parseRefFile(filename string) (*Ref, error) {
bytes, err := os.ReadFile(filename)
if err != nil {
return nil, err
}
contents := strings.TrimSpace(string(bytes))
if strings.HasPrefix(contents, "ref:") {
contents = strings.TrimSpace(contents[4:])
}
return ResolveRef(contents)
}
func parseDirFile(filename string) (string, error) {
bytes, err := os.ReadFile(filename)
if err != nil {
return "", err
}
contents := strings.TrimSpace(string(bytes))
return contents, nil
}
// IsBare returns whether or not a repository is bare. It requires that the
// current working directory is a repository.
//
// If there was an error determining whether or not the repository is bare, it
// will be returned.
func IsBare() (bool, error) {
s, err := subprocess.SimpleExec(
"git", "rev-parse", "--is-bare-repository")
if err != nil {
return false, err
}
return strconv.ParseBool(s)
}
// For compatibility with git clone we must mirror all flags in CloneWithoutFilters
type CloneFlags struct {
// --template <template_directory>
TemplateDirectory string
// -l --local
Local bool
// -s --shared
Shared bool
// --no-hardlinks
NoHardlinks bool
// -q --quiet
Quiet bool
// -n --no-checkout
NoCheckout bool
// --progress
Progress bool
// --bare
Bare bool
// --mirror
Mirror bool
// -o <name> --origin <name>
Origin string
// -b <name> --branch <name>
Branch string
// -u <upload-pack> --upload-pack <pack>
Upload string
// --reference <repository>
Reference string
// --reference-if-able <repository>
ReferenceIfAble string
// --dissociate
Dissociate bool
// --separate-git-dir <git dir>
SeparateGit string
// --depth <depth>
Depth string
// --recursive
Recursive bool
// --recurse-submodules
RecurseSubmodules bool
// -c <value> --config <value>
Config string
// --single-branch
SingleBranch bool
// --no-single-branch
NoSingleBranch bool
// --verbose
Verbose bool
// --ipv4
Ipv4 bool
// --ipv6
Ipv6 bool
// --shallow-since <date>
ShallowSince string
// --shallow-since <date>
ShallowExclude string
// --shallow-submodules
ShallowSubmodules bool
// --no-shallow-submodules
NoShallowSubmodules bool
// jobs <n>
Jobs int64
}
// CloneWithoutFilters clones a git repo but without the smudge filter enabled
// so that files in the working copy will be pointers and not real LFS data
func CloneWithoutFilters(flags CloneFlags, args []string) error {
cmdargs := []string{"clone"}
// flags
if flags.Bare {
cmdargs = append(cmdargs, "--bare")
}
if len(flags.Branch) > 0 {
cmdargs = append(cmdargs, "--branch", flags.Branch)
}
if len(flags.Config) > 0 {
cmdargs = append(cmdargs, "--config", flags.Config)
}
if len(flags.Depth) > 0 {
cmdargs = append(cmdargs, "--depth", flags.Depth)
}
if flags.Dissociate {
cmdargs = append(cmdargs, "--dissociate")
}
if flags.Ipv4 {
cmdargs = append(cmdargs, "--ipv4")
}
if flags.Ipv6 {
cmdargs = append(cmdargs, "--ipv6")
}
if flags.Local {
cmdargs = append(cmdargs, "--local")
}
if flags.Mirror {
cmdargs = append(cmdargs, "--mirror")
}
if flags.NoCheckout {
cmdargs = append(cmdargs, "--no-checkout")
}
if flags.NoHardlinks {
cmdargs = append(cmdargs, "--no-hardlinks")
}
if flags.NoSingleBranch {
cmdargs = append(cmdargs, "--no-single-branch")
}
if len(flags.Origin) > 0 {
cmdargs = append(cmdargs, "--origin", flags.Origin)
}
if flags.Progress {
cmdargs = append(cmdargs, "--progress")
}
if flags.Quiet {
cmdargs = append(cmdargs, "--quiet")
}
if flags.Recursive {
cmdargs = append(cmdargs, "--recursive")
}
if flags.RecurseSubmodules {
cmdargs = append(cmdargs, "--recurse-submodules")
}
if len(flags.Reference) > 0 {
cmdargs = append(cmdargs, "--reference", flags.Reference)
}
if len(flags.ReferenceIfAble) > 0 {
cmdargs = append(cmdargs, "--reference-if-able", flags.ReferenceIfAble)
}
if len(flags.SeparateGit) > 0 {
cmdargs = append(cmdargs, "--separate-git-dir", flags.SeparateGit)
}
if flags.Shared {
cmdargs = append(cmdargs, "--shared")
}
if flags.SingleBranch {
cmdargs = append(cmdargs, "--single-branch")
}
if len(flags.TemplateDirectory) > 0 {
cmdargs = append(cmdargs, "--template", flags.TemplateDirectory)
}
if len(flags.Upload) > 0 {
cmdargs = append(cmdargs, "--upload-pack", flags.Upload)
}
if flags.Verbose {
cmdargs = append(cmdargs, "--verbose")
}
if len(flags.ShallowSince) > 0 {
cmdargs = append(cmdargs, "--shallow-since", flags.ShallowSince)
}
if len(flags.ShallowExclude) > 0 {
cmdargs = append(cmdargs, "--shallow-exclude", flags.ShallowExclude)
}
if flags.ShallowSubmodules {
cmdargs = append(cmdargs, "--shallow-submodules")
}
if flags.NoShallowSubmodules {
cmdargs = append(cmdargs, "--no-shallow-submodules")
}
if flags.Jobs > -1 {
cmdargs = append(cmdargs, "--jobs", strconv.FormatInt(flags.Jobs, 10))
}
// Now args
cmdargs = append(cmdargs, args...)
cmd, err := gitNoLFS(cmdargs...)
if err != nil {
return errors.New(tr.Tr.Get("failed to find `git clone`: %v", err))
}
// Assign all streams direct
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Stdin = os.Stdin
err = cmd.Start()
if err != nil {
return errors.New(tr.Tr.Get("failed to start `git clone`: %v", err))
}
err = cmd.Wait()
if err != nil {
return errors.New(tr.Tr.Get("`git clone` failed: %v", err))
}
return nil
}
// Checkout performs an invocation of `git-checkout(1)` applying the given
// treeish, paths, and force option, if given.
//
// If any error was encountered, it will be returned immediately. Otherwise, the
// checkout has occurred successfully.
func Checkout(treeish string, paths []string, force bool) error {
args := []string{"checkout"}
if force {
args = append(args, "--force")
}
if len(treeish) > 0 {
args = append(args, treeish)
}
if len(paths) > 0 {
args = append(args, append([]string{"--"}, paths...)...)
}
_, err := gitNoLFSSimple(args...)
return err
}
// CachedRemoteRefs returns the list of branches & tags for a remote which are
// currently cached locally. No remote request is made to verify them.
func CachedRemoteRefs(remoteName string) ([]*Ref, error) {
var ret []*Ref
cmd, err := gitNoLFS("show-ref")
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git show-ref`: %v", err))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git show-ref`: %v", err))
}
cmd.Start()
scanner := bufio.NewScanner(outp)
refPrefix := fmt.Sprintf("refs/remotes/%v/", remoteName)
for scanner.Scan() {
if sha, name, ok := parseShowRefLine(refPrefix, scanner.Text()); ok {
// Don't match head
if name == "HEAD" {
continue
}
ret = append(ret, &Ref{name, RefTypeRemoteBranch, sha})
}
}
return ret, cmd.Wait()
}
func parseShowRefLine(refPrefix, line string) (sha, name string, ok bool) {
// line format: <sha> <space> <ref>
space := strings.IndexByte(line, ' ')
if space < 0 {
return "", "", false
}
ref := line[space+1:]
if !strings.HasPrefix(ref, refPrefix) {
return "", "", false
}
return line[:space], strings.TrimSpace(ref[len(refPrefix):]), true
}
// Fetch performs a fetch with no arguments against the given remotes.
func Fetch(remotes ...string) error {
if len(remotes) == 0 {
return nil
}
var args []string
if len(remotes) > 1 {
args = []string{"--multiple", "--"}
}
args = append(args, remotes...)
_, err := gitNoLFSSimple(append([]string{"fetch"}, args...)...)
return err
}
// RemoteRefs returns a list of branches and, optionally, tags for a remote
// by actually accessing the remote via git ls-remote.
func RemoteRefs(remoteName string, withTags bool) ([]*Ref, error) {
var ret []*Ref
args := []string{"ls-remote", "--heads", "-q"}
if withTags {
args = append(args, "--tags")
}
args = append(args, remoteName)
cmd, err := gitNoLFS(args...)
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git ls-remote`: %v", err))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git ls-remote`: %v", err))
}
cmd.Start()
scanner := bufio.NewScanner(outp)
for scanner.Scan() {
if sha, ns, name, ok := parseLsRemoteLine(scanner.Text()); ok {
// Don't match head
if name == "HEAD" {
continue
}
typ := RefTypeRemoteBranch
if ns == "tags" {
if !withTags {
return nil, errors.New(tr.Tr.Get("unexpected tag returned by `git ls-remote --heads`: %s %s", name, sha))
}
typ = RefTypeRemoteTag
}
ret = append(ret, &Ref{name, typ, sha})
}
}
return ret, cmd.Wait()
}
func parseLsRemoteLine(line string) (sha, ns, name string, ok bool) {
const headPrefix = "refs/heads/"
const tagPrefix = "refs/tags/"
// line format: <sha> <tab> <ref>
tab := strings.IndexByte(line, '\t')
if tab < 0 {
return "", "", "", false
}
ref := line[tab+1:]
switch {
case strings.HasPrefix(ref, headPrefix):
ns = "heads"
name = ref[len(headPrefix):]
case strings.HasPrefix(ref, tagPrefix):
ns = "tags"
name = ref[len(tagPrefix):]
default:
return "", "", "", false
}
return line[:tab], ns, strings.TrimSpace(name), true
}
// AllRefs returns a slice of all references in a Git repository in the current
// working directory, or an error if those references could not be loaded.
func AllRefs() ([]*Ref, error) {
return AllRefsIn("")
}
// AllRefs returns a slice of all references in a Git repository located in a
// the given working directory "wd", or an error if those references could not
// be loaded.
func AllRefsIn(wd string) ([]*Ref, error) {
cmd, err := gitNoLFS(
"for-each-ref", "--format=%(objectname)%00%(refname)")
if err != nil {
return nil, lfserrors.Wrap(err, tr.Tr.Get("failed to find `git for-each-ref`: %v", err))
}
cmd.Dir = wd
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, lfserrors.Wrap(err, tr.Tr.Get("cannot open pipe"))
}
cmd.Start()
refs := make([]*Ref, 0)
scanner := bufio.NewScanner(outp)
for scanner.Scan() {
parts := strings.SplitN(scanner.Text(), "\x00", 2)
if len(parts) != 2 {
return nil, lfserrors.New(tr.Tr.Get(
"invalid `git for-each-ref` line: %q", scanner.Text()))
}
sha := parts[0]
typ, name := ParseRefToTypeAndName(parts[1])
refs = append(refs, &Ref{
Name: name,
Type: typ,
Sha: sha,
})
}
if err := scanner.Err(); err != nil {
return nil, err
}
return refs, nil
}
// GetTrackedFiles returns a list of files which are tracked in Git which match
// the pattern specified (standard wildcard form)
// Both pattern and the results are relative to the current working directory, not
// the root of the repository
func GetTrackedFiles(pattern string) ([]string, error) {
safePattern := sanitizePattern(pattern)
rootWildcard := len(safePattern) < len(pattern) && strings.ContainsRune(safePattern, '*')
var ret []string
cmd, err := gitNoLFS(
"ls-files",
"--ignored",
"--cached", // include things which are staged but not committed right now
"-z", // handle special chars in filenames
"-x",
safePattern)
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git ls-files`: %v", err))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git ls-files`: %v", err))
}
cmd.Start()
scanner := bufio.NewScanner(outp)
scanner.Split(tools.SplitOnNul)
for scanner.Scan() {
line := scanner.Text()
// If the given pattern is a root wildcard, skip all files which
// are not direct descendants of the repository's root.
//
// This matches the behavior of how .gitattributes performs
// filename matches.
if rootWildcard && filepath.Dir(line) != "." {
continue
}
ret = append(ret, strings.TrimSpace(line))
}
return ret, cmd.Wait()
}
func sanitizePattern(pattern string) string {
if strings.HasPrefix(pattern, "/") {
return pattern[1:]
}
return pattern
}
// GetFilesChanged returns a list of files which were changed, either between 2
// commits, or at a single commit if you only supply one argument and a blank
// string for the other
func GetFilesChanged(from, to string) ([]string, error) {
var files []string
args := []string{
"-c", "core.quotepath=false", // handle special chars in filenames
"diff-tree",
"--no-commit-id",
"--name-only",
"-r",
}
if len(from) > 0 {
args = append(args, from)
}
if len(to) > 0 {
args = append(args, to)
}
args = append(args, "--") // no ambiguous patterns
cmd, err := gitNoLFS(args...)
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to find `git diff-tree`: %v", err))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return nil, errors.New(tr.Tr.Get("failed to call `git diff-tree`: %v", err))
}
if err := cmd.Start(); err != nil {
return nil, errors.New(tr.Tr.Get("failed to start `git diff-tree`: %v", err))
}
scanner := bufio.NewScanner(outp)
for scanner.Scan() {
files = append(files, strings.TrimSpace(scanner.Text()))
}
if err := cmd.Wait(); err != nil {
return nil, errors.New(tr.Tr.Get("`git diff-tree` failed: %v", err))
}
return files, err
}
// IsFileModified returns whether the filepath specified is modified according
// to `git status`. A file is modified if it has uncommitted changes in the
// working copy or the index. This includes being untracked.
func IsFileModified(filepath string) (bool, error) {
args := []string{
"-c", "core.quotepath=false", // handle special chars in filenames
"status",
"--porcelain",
"--", // separator in case filename ambiguous
filepath,
}
cmd, err := git(args...)
if err != nil {
return false, lfserrors.Wrap(err, tr.Tr.Get("failed to find `git status`"))
}
outp, err := cmd.StdoutPipe()
if err != nil {
return false, lfserrors.Wrap(err, tr.Tr.Get("Failed to call `git status`"))
}
if err := cmd.Start(); err != nil {
return false, lfserrors.Wrap(err, tr.Tr.Get("Failed to start `git status`"))
}
matched := false
for scanner := bufio.NewScanner(outp); scanner.Scan(); {
line := scanner.Text()
// Porcelain format is "<I><W> <filename>"
// Where <I> = index status, <W> = working copy status
if len(line) > 3 {
// Double-check even though should be only match
if strings.TrimSpace(line[3:]) == filepath {
matched = true
// keep consuming output to exit cleanly
// will typically fall straight through anyway due to 1 line output
}
}
}
if err := cmd.Wait(); err != nil {
return false, lfserrors.Wrap(err, tr.Tr.Get("`git status` failed"))
}
return matched, nil
}
// IsWorkingCopyDirty returns true if and only if the working copy in which the
// command was executed is dirty as compared to the index.
//
// If the status of the working copy could not be determined, an error will be
// returned instead.
func IsWorkingCopyDirty() (bool, error) {
bare, err := IsBare()
if bare || err != nil {
return false, err
}
out, err := gitSimple("status", "--porcelain")
if err != nil {
return false, err
}
return len(out) != 0, nil
}
func ObjectDatabase(osEnv, gitEnv Environment, gitdir, tempdir string) (*gitobj.ObjectDatabase, error) {
var options []gitobj.Option
objdir, ok := osEnv.Get("GIT_OBJECT_DIRECTORY")
if !ok {
objdir = filepath.Join(gitdir, "objects")
}
alternates, _ := osEnv.Get("GIT_ALTERNATE_OBJECT_DIRECTORIES")
if alternates != "" {
options = append(options, gitobj.Alternates(alternates))
}
hashAlgo, _ := gitEnv.Get("extensions.objectformat")
if hashAlgo != "" {
options = append(options, gitobj.ObjectFormat(gitobj.ObjectFormatAlgorithm(hashAlgo)))
}
odb, err := gitobj.FromFilesystem(objdir, tempdir, options...)
if err != nil {
return nil, err
}
if odb.Hasher() == nil {
return nil, errors.New(tr.Tr.Get("unsupported repository hash algorithm %q", hashAlgo))
}
return odb, nil
}
func remotesForTreeish(treeish string) []string {
var outp string
var err error
if treeish == "" {
//Treeish is empty for sparse checkout
tracerx.Printf("git: treeish: not provided")
outp, err = gitNoLFSSimple("branch", "-r", "--contains", "HEAD")
} else {
tracerx.Printf("git: treeish: %q", treeish)
outp, err = gitNoLFSSimple("branch", "-r", "--contains", treeish)
}
if err != nil || outp == "" {
tracerx.Printf("git: symbolic name: can't resolve symbolic name for ref: %q", treeish)
return []string{}
}
return strings.Split(outp, "\n")
}
// remoteForRef will try to determine the remote from the ref name.
// This will return an empty string if any of the remote names have a slash
// because slashes introduce ambiguity. Consider two refs:
//
// 1. upstream/main
// 2. upstream/test/main
//
// Is the remote "upstream" or "upstream/test"? It could be either, or both.
// We could use git for-each-ref with %(upstream:remotename) if there were a tracking branch,
// but this is not guaranteed to exist either.
func remoteForRef(refname string) string {
tracerx.Printf("git: working ref: %s", refname)
remotes, err := RemoteList()
if err != nil {
return ""
}
parts := strings.Split(refname, "/")
if len(parts) < 2 {
return ""
}
for _, name := range remotes {
if strings.Contains(name, "/") {
tracerx.Printf("git: ref remote: cannot determine remote for ref %s since remote %s contains a slash", refname, name)
return ""
}
}
remote := parts[0]
tracerx.Printf("git: working remote %s", remote)
return remote
}
func getValidRemote(refs []string) string {
for _, ref := range refs {
if ref != "" {
return ref
}
}
return ""
}
// FirstRemoteForTreeish returns the first remote found which contains the treeish.
func FirstRemoteForTreeish(treeish string) string {
name := getValidRemote(remotesForTreeish(treeish))
if name == "" {
tracerx.Printf("git: remote treeish: no valid remote refs parsed for %q", treeish)
return ""
}
return remoteForRef(name)
}
|