gitea/modules/git/languagestats/language_stats_get.go

// Copyright 2020 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package languagestats

import (
	"bytes"
	"context"
	"io"

	"gitea.dev/modules/analyze"
	"gitea.dev/modules/git"
	"gitea.dev/modules/git/attribute"
	"gitea.dev/modules/log"
	"gitea.dev/modules/optional"

	"github.com/go-enry/go-enry/v2"
)

// GetLanguageStats calculates language stats for git repository at specified commit
func GetLanguageStats(ctx context.Context, repo *git.Repository, commitID string) (map[string]int64, error) {
	// We will feed the commit IDs in order into cat-file --batch, followed by blobs as necessary.
	// so let's create a batch stdin and stdout
	batch, cancel, err := repo.CatFileBatch(ctx)
	if err != nil {
		return nil, err
	}
	defer cancel()

	commitInfo, batchReader, err := batch.QueryContent(commitID)
	if err != nil {
		return nil, err
	}
	if commitInfo.Type != "commit" {
		log.Debug("Unable to get commit for: %s. Err: %v", commitID, err)
		return nil, git.ErrNotExist{ID: commitID}
	}

	sha, err := git.NewIDFromString(commitInfo.ID)
	if err != nil {
		log.Debug("Unable to get commit for: %s. Err: %v", commitID, err)
		return nil, git.ErrNotExist{ID: commitID}
	}

	commit, err := git.CommitFromReader(sha, io.LimitReader(batchReader, commitInfo.Size))
	if err != nil {
		log.Debug("Unable to get commit for: %s. Err: %v", commitID, err)
		return nil, err
	}
	if _, err = batchReader.Discard(1); err != nil {
		return nil, err
	}

	entries, err := commit.Tree().ListEntriesRecursiveWithSize(ctx, repo)
	if err != nil {
		return nil, err
	}

	checker, err := attribute.NewBatchChecker(ctx, repo, commitID, attribute.LinguistAttributes)
	if err != nil {
		return nil, err
	}
	defer checker.Close()

	contentBuf := bytes.Buffer{}
	var content []byte

	// sizes contains the current calculated size of all files by language
	sizes := make(map[string]int64)
	// by default we will only count the sizes of programming languages or markup languages
	// unless they are explicitly set using linguist-language
	includedLanguage := map[string]bool{}
	// or if there's only one language in the repository
	firstExcludedLanguage := ""
	firstExcludedLanguageSize := int64(0)

	for _, f := range entries {
		select {
		case <-ctx.Done():
			return sizes, ctx.Err()
		default:
		}

		contentBuf.Reset()
		content = contentBuf.Bytes()

		if f.GetSize(ctx, repo) == 0 {
			continue
		}

		isVendored := optional.None[bool]()
		isDocumentation := optional.None[bool]()
		isDetectable := optional.None[bool]()

		attrs, err := checker.CheckPath(f.Name())
		attrLinguistGenerated := optional.None[bool]()
		if err == nil {
			if isVendored = attrs.GetVendored(); isVendored.ValueOrDefault(false) {
				continue
			}

			if attrLinguistGenerated = attrs.GetGenerated(); attrLinguistGenerated.ValueOrDefault(false) {
				continue
			}

			if isDocumentation = attrs.GetDocumentation(); isDocumentation.ValueOrDefault(false) {
				continue
			}

			if isDetectable = attrs.GetDetectable(); !isDetectable.ValueOrDefault(true) {
				continue
			}

			if hasLanguage := attrs.GetLanguage(); hasLanguage.Value() != "" {
				language := hasLanguage.Value()

				// group languages, such as Pug -> HTML; SCSS -> CSS
				group := enry.GetLanguageGroup(language)
				if len(group) != 0 {
					language = group
				}

				// this language will always be added to the size
				sizes[language] += f.GetSize(ctx, repo)
				continue
			}
		}

		if (!isVendored.Has() && analyze.IsVendor(f.Name())) ||
			enry.IsDotFile(f.Name()) ||
			(!isDocumentation.Has() && enry.IsDocumentation(f.Name())) ||
			(!isDetectable.Has() && enry.IsConfiguration(f.Name())) {
			continue
		}

		// If content can not be read or file is too big just do detection by filename

		if f.GetSize(ctx, repo) <= bigFileSize {
			info, _, err := batch.QueryContent(f.ID.String())
			if err != nil {
				return nil, err
			}

			sizeToRead := info.Size
			discard := int64(1)
			if info.Size > fileSizeLimit {
				sizeToRead = fileSizeLimit
				discard = info.Size - fileSizeLimit + 1
			}

			_, err = contentBuf.ReadFrom(io.LimitReader(batchReader, sizeToRead))
			if err != nil {
				return nil, err
			}
			content = contentBuf.Bytes()
			if err := git.DiscardFull(batchReader, discard); err != nil {
				return nil, err
			}
		}

		// if "generated" attribute is set, use it, otherwise use enry.IsGenerated to guess
		var isGenerated bool
		if attrLinguistGenerated.Has() {
			isGenerated = attrLinguistGenerated.Value()
		} else {
			isGenerated = enry.IsGenerated(f.Name(), content)
		}
		if isGenerated {
			continue
		}

		// FIXME: Why can't we split this and the IsGenerated tests to avoid reading the blob unless absolutely necessary?
		// - eg. do the all the detection tests using filename first before reading content.
		language := analyze.GetCodeLanguage(f.Name(), content)
		if language == "" {
			continue
		}

		// group languages, such as Pug -> HTML; SCSS -> CSS
		group := enry.GetLanguageGroup(language)
		if group != "" {
			language = group
		}

		included, checked := includedLanguage[language]
		if !checked {
			langType := enry.GetLanguageType(language)
			included = langType == enry.Programming || langType == enry.Markup
			includedLanguage[language] = included
		}
		if included || isDetectable.ValueOrDefault(false) {
			sizes[language] += f.GetSize(ctx, repo)
		} else if len(sizes) == 0 && (firstExcludedLanguage == "" || firstExcludedLanguage == language) {
			firstExcludedLanguage = language
			firstExcludedLanguageSize += f.GetSize(ctx, repo)
		}
	}

	// If there are no included languages add the first excluded language
	if len(sizes) == 0 && firstExcludedLanguage != "" {
		sizes[firstExcludedLanguage] = firstExcludedLanguageSize
	}

	return mergeLanguageStats(sizes), nil
}