code.gitea.io/gitea@v1.19.3/modules/git/repo_language_stats_nogogit.go (about)

     1  // Copyright 2020 The Gitea Authors. All rights reserved.
     2  // SPDX-License-Identifier: MIT
     3  
     4  //go:build !gogit
     5  
     6  package git
     7  
     8  import (
     9  	"bufio"
    10  	"bytes"
    11  	"io"
    12  	"math"
    13  	"strings"
    14  
    15  	"code.gitea.io/gitea/modules/analyze"
    16  	"code.gitea.io/gitea/modules/log"
    17  
    18  	"github.com/go-enry/go-enry/v2"
    19  )
    20  
    21  // GetLanguageStats calculates language stats for git repository at specified commit
    22  func (repo *Repository) GetLanguageStats(commitID string) (map[string]int64, error) {
    23  	// We will feed the commit IDs in order into cat-file --batch, followed by blobs as necessary.
    24  	// so let's create a batch stdin and stdout
    25  	batchStdinWriter, batchReader, cancel := repo.CatFileBatch(repo.Ctx)
    26  	defer cancel()
    27  
    28  	writeID := func(id string) error {
    29  		_, err := batchStdinWriter.Write([]byte(id + "\n"))
    30  		return err
    31  	}
    32  
    33  	if err := writeID(commitID); err != nil {
    34  		return nil, err
    35  	}
    36  	shaBytes, typ, size, err := ReadBatchLine(batchReader)
    37  	if typ != "commit" {
    38  		log.Debug("Unable to get commit for: %s. Err: %v", commitID, err)
    39  		return nil, ErrNotExist{commitID, ""}
    40  	}
    41  
    42  	sha, err := NewIDFromString(string(shaBytes))
    43  	if err != nil {
    44  		log.Debug("Unable to get commit for: %s. Err: %v", commitID, err)
    45  		return nil, ErrNotExist{commitID, ""}
    46  	}
    47  
    48  	commit, err := CommitFromReader(repo, sha, io.LimitReader(batchReader, size))
    49  	if err != nil {
    50  		log.Debug("Unable to get commit for: %s. Err: %v", commitID, err)
    51  		return nil, err
    52  	}
    53  	if _, err = batchReader.Discard(1); err != nil {
    54  		return nil, err
    55  	}
    56  
    57  	tree := commit.Tree
    58  
    59  	entries, err := tree.ListEntriesRecursiveWithSize()
    60  	if err != nil {
    61  		return nil, err
    62  	}
    63  
    64  	checker, deferable := repo.CheckAttributeReader(commitID)
    65  	defer deferable()
    66  
    67  	contentBuf := bytes.Buffer{}
    68  	var content []byte
    69  
    70  	// sizes contains the current calculated size of all files by language
    71  	sizes := make(map[string]int64)
    72  	// by default we will only count the sizes of programming languages or markup languages
    73  	// unless they are explicitly set using linguist-language
    74  	includedLanguage := map[string]bool{}
    75  	// or if there's only one language in the repository
    76  	firstExcludedLanguage := ""
    77  	firstExcludedLanguageSize := int64(0)
    78  
    79  	for _, f := range entries {
    80  		select {
    81  		case <-repo.Ctx.Done():
    82  			return sizes, repo.Ctx.Err()
    83  		default:
    84  		}
    85  
    86  		contentBuf.Reset()
    87  		content = contentBuf.Bytes()
    88  
    89  		if f.Size() == 0 {
    90  			continue
    91  		}
    92  
    93  		notVendored := false
    94  		notGenerated := false
    95  
    96  		if checker != nil {
    97  			attrs, err := checker.CheckPath(f.Name())
    98  			if err == nil {
    99  				if vendored, has := attrs["linguist-vendored"]; has {
   100  					if vendored == "set" || vendored == "true" {
   101  						continue
   102  					}
   103  					notVendored = vendored == "false"
   104  				}
   105  				if generated, has := attrs["linguist-generated"]; has {
   106  					if generated == "set" || generated == "true" {
   107  						continue
   108  					}
   109  					notGenerated = generated == "false"
   110  				}
   111  				if language, has := attrs["linguist-language"]; has && language != "unspecified" && language != "" {
   112  					// group languages, such as Pug -> HTML; SCSS -> CSS
   113  					group := enry.GetLanguageGroup(language)
   114  					if len(group) != 0 {
   115  						language = group
   116  					}
   117  
   118  					// this language will always be added to the size
   119  					sizes[language] += f.Size()
   120  					continue
   121  				} else if language, has := attrs["gitlab-language"]; has && language != "unspecified" && language != "" {
   122  					// strip off a ? if present
   123  					if idx := strings.IndexByte(language, '?'); idx >= 0 {
   124  						language = language[:idx]
   125  					}
   126  					if len(language) != 0 {
   127  						// group languages, such as Pug -> HTML; SCSS -> CSS
   128  						group := enry.GetLanguageGroup(language)
   129  						if len(group) != 0 {
   130  							language = group
   131  						}
   132  
   133  						// this language will always be added to the size
   134  						sizes[language] += f.Size()
   135  						continue
   136  					}
   137  				}
   138  
   139  			}
   140  		}
   141  
   142  		if (!notVendored && analyze.IsVendor(f.Name())) || enry.IsDotFile(f.Name()) ||
   143  			enry.IsDocumentation(f.Name()) || enry.IsConfiguration(f.Name()) {
   144  			continue
   145  		}
   146  
   147  		// If content can not be read or file is too big just do detection by filename
   148  
   149  		if f.Size() <= bigFileSize {
   150  			if err := writeID(f.ID.String()); err != nil {
   151  				return nil, err
   152  			}
   153  			_, _, size, err := ReadBatchLine(batchReader)
   154  			if err != nil {
   155  				log.Debug("Error reading blob: %s Err: %v", f.ID.String(), err)
   156  				return nil, err
   157  			}
   158  
   159  			sizeToRead := size
   160  			discard := int64(1)
   161  			if size > fileSizeLimit {
   162  				sizeToRead = fileSizeLimit
   163  				discard = size - fileSizeLimit + 1
   164  			}
   165  
   166  			_, err = contentBuf.ReadFrom(io.LimitReader(batchReader, sizeToRead))
   167  			if err != nil {
   168  				return nil, err
   169  			}
   170  			content = contentBuf.Bytes()
   171  			err = discardFull(batchReader, discard)
   172  			if err != nil {
   173  				return nil, err
   174  			}
   175  		}
   176  		if !notGenerated && enry.IsGenerated(f.Name(), content) {
   177  			continue
   178  		}
   179  
   180  		// FIXME: Why can't we split this and the IsGenerated tests to avoid reading the blob unless absolutely necessary?
   181  		// - eg. do the all the detection tests using filename first before reading content.
   182  		language := analyze.GetCodeLanguage(f.Name(), content)
   183  		if language == enry.OtherLanguage || language == "" {
   184  			continue
   185  		}
   186  
   187  		// group languages, such as Pug -> HTML; SCSS -> CSS
   188  		group := enry.GetLanguageGroup(language)
   189  		if group != "" {
   190  			language = group
   191  		}
   192  
   193  		included, checked := includedLanguage[language]
   194  		if !checked {
   195  			langtype := enry.GetLanguageType(language)
   196  			included = langtype == enry.Programming || langtype == enry.Markup
   197  			includedLanguage[language] = included
   198  		}
   199  		if included {
   200  			sizes[language] += f.Size()
   201  		} else if len(sizes) == 0 && (firstExcludedLanguage == "" || firstExcludedLanguage == language) {
   202  			firstExcludedLanguage = language
   203  			firstExcludedLanguageSize += f.Size()
   204  		}
   205  		continue
   206  	}
   207  
   208  	// If there are no included languages add the first excluded language
   209  	if len(sizes) == 0 && firstExcludedLanguage != "" {
   210  		sizes[firstExcludedLanguage] = firstExcludedLanguageSize
   211  	}
   212  
   213  	return sizes, nil
   214  }
   215  
   216  func discardFull(rd *bufio.Reader, discard int64) error {
   217  	if discard > math.MaxInt32 {
   218  		n, err := rd.Discard(math.MaxInt32)
   219  		discard -= int64(n)
   220  		if err != nil {
   221  			return err
   222  		}
   223  	}
   224  	for discard > 0 {
   225  		n, err := rd.Discard(int(discard))
   226  		discard -= int64(n)
   227  		if err != nil {
   228  			return err
   229  		}
   230  	}
   231  	return nil
   232  }