mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-29 23:57:30 +02:00
* Fix the intermittent TestGPGGit failures Reattempt to open the listener if the port is busy with a delay up to a second Switch from generating a private key each time, just use a known good key
1582 lines
43 KiB
Go
1582 lines
43 KiB
Go
// Copyright 2013 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package imports
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"go/ast"
|
|
"go/build"
|
|
"go/parser"
|
|
"go/token"
|
|
"io/ioutil"
|
|
"os"
|
|
"os/exec"
|
|
"path"
|
|
"path/filepath"
|
|
"reflect"
|
|
"sort"
|
|
"strconv"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
"unicode"
|
|
"unicode/utf8"
|
|
|
|
"golang.org/x/tools/go/ast/astutil"
|
|
"golang.org/x/tools/go/packages"
|
|
"golang.org/x/tools/internal/gopathwalk"
|
|
)
|
|
|
|
// importToGroup is a list of functions which map from an import path to
|
|
// a group number.
|
|
var importToGroup = []func(env *ProcessEnv, importPath string) (num int, ok bool){
|
|
func(env *ProcessEnv, importPath string) (num int, ok bool) {
|
|
if env.LocalPrefix == "" {
|
|
return
|
|
}
|
|
for _, p := range strings.Split(env.LocalPrefix, ",") {
|
|
if strings.HasPrefix(importPath, p) || strings.TrimSuffix(p, "/") == importPath {
|
|
return 3, true
|
|
}
|
|
}
|
|
return
|
|
},
|
|
func(_ *ProcessEnv, importPath string) (num int, ok bool) {
|
|
if strings.HasPrefix(importPath, "appengine") {
|
|
return 2, true
|
|
}
|
|
return
|
|
},
|
|
func(_ *ProcessEnv, importPath string) (num int, ok bool) {
|
|
if strings.Contains(importPath, ".") {
|
|
return 1, true
|
|
}
|
|
return
|
|
},
|
|
}
|
|
|
|
func importGroup(env *ProcessEnv, importPath string) int {
|
|
for _, fn := range importToGroup {
|
|
if n, ok := fn(env, importPath); ok {
|
|
return n
|
|
}
|
|
}
|
|
return 0
|
|
}
|
|
|
|
type ImportFixType int
|
|
|
|
const (
|
|
AddImport ImportFixType = iota
|
|
DeleteImport
|
|
SetImportName
|
|
)
|
|
|
|
type ImportFix struct {
|
|
// StmtInfo represents the import statement this fix will add, remove, or change.
|
|
StmtInfo ImportInfo
|
|
// IdentName is the identifier that this fix will add or remove.
|
|
IdentName string
|
|
// FixType is the type of fix this is (AddImport, DeleteImport, SetImportName).
|
|
FixType ImportFixType
|
|
}
|
|
|
|
// An ImportInfo represents a single import statement.
|
|
type ImportInfo struct {
|
|
ImportPath string // import path, e.g. "crypto/rand".
|
|
Name string // import name, e.g. "crand", or "" if none.
|
|
}
|
|
|
|
// A packageInfo represents what's known about a package.
|
|
type packageInfo struct {
|
|
name string // real package name, if known.
|
|
exports map[string]bool // known exports.
|
|
}
|
|
|
|
// parseOtherFiles parses all the Go files in srcDir except filename, including
|
|
// test files if filename looks like a test.
|
|
func parseOtherFiles(fset *token.FileSet, srcDir, filename string) []*ast.File {
|
|
// This could use go/packages but it doesn't buy much, and it fails
|
|
// with https://golang.org/issue/26296 in LoadFiles mode in some cases.
|
|
considerTests := strings.HasSuffix(filename, "_test.go")
|
|
|
|
fileBase := filepath.Base(filename)
|
|
packageFileInfos, err := ioutil.ReadDir(srcDir)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
|
|
var files []*ast.File
|
|
for _, fi := range packageFileInfos {
|
|
if fi.Name() == fileBase || !strings.HasSuffix(fi.Name(), ".go") {
|
|
continue
|
|
}
|
|
if !considerTests && strings.HasSuffix(fi.Name(), "_test.go") {
|
|
continue
|
|
}
|
|
|
|
f, err := parser.ParseFile(fset, filepath.Join(srcDir, fi.Name()), nil, 0)
|
|
if err != nil {
|
|
continue
|
|
}
|
|
|
|
files = append(files, f)
|
|
}
|
|
|
|
return files
|
|
}
|
|
|
|
// addGlobals puts the names of package vars into the provided map.
|
|
func addGlobals(f *ast.File, globals map[string]bool) {
|
|
for _, decl := range f.Decls {
|
|
genDecl, ok := decl.(*ast.GenDecl)
|
|
if !ok {
|
|
continue
|
|
}
|
|
|
|
for _, spec := range genDecl.Specs {
|
|
valueSpec, ok := spec.(*ast.ValueSpec)
|
|
if !ok {
|
|
continue
|
|
}
|
|
globals[valueSpec.Names[0].Name] = true
|
|
}
|
|
}
|
|
}
|
|
|
|
// collectReferences builds a map of selector expressions, from
|
|
// left hand side (X) to a set of right hand sides (Sel).
|
|
func collectReferences(f *ast.File) references {
|
|
refs := references{}
|
|
|
|
var visitor visitFn
|
|
visitor = func(node ast.Node) ast.Visitor {
|
|
if node == nil {
|
|
return visitor
|
|
}
|
|
switch v := node.(type) {
|
|
case *ast.SelectorExpr:
|
|
xident, ok := v.X.(*ast.Ident)
|
|
if !ok {
|
|
break
|
|
}
|
|
if xident.Obj != nil {
|
|
// If the parser can resolve it, it's not a package ref.
|
|
break
|
|
}
|
|
if !ast.IsExported(v.Sel.Name) {
|
|
// Whatever this is, it's not exported from a package.
|
|
break
|
|
}
|
|
pkgName := xident.Name
|
|
r := refs[pkgName]
|
|
if r == nil {
|
|
r = make(map[string]bool)
|
|
refs[pkgName] = r
|
|
}
|
|
r[v.Sel.Name] = true
|
|
}
|
|
return visitor
|
|
}
|
|
ast.Walk(visitor, f)
|
|
return refs
|
|
}
|
|
|
|
// collectImports returns all the imports in f.
|
|
// Unnamed imports (., _) and "C" are ignored.
|
|
func collectImports(f *ast.File) []*ImportInfo {
|
|
var imports []*ImportInfo
|
|
for _, imp := range f.Imports {
|
|
var name string
|
|
if imp.Name != nil {
|
|
name = imp.Name.Name
|
|
}
|
|
if imp.Path.Value == `"C"` || name == "_" || name == "." {
|
|
continue
|
|
}
|
|
path := strings.Trim(imp.Path.Value, `"`)
|
|
imports = append(imports, &ImportInfo{
|
|
Name: name,
|
|
ImportPath: path,
|
|
})
|
|
}
|
|
return imports
|
|
}
|
|
|
|
// findMissingImport searches pass's candidates for an import that provides
|
|
// pkg, containing all of syms.
|
|
func (p *pass) findMissingImport(pkg string, syms map[string]bool) *ImportInfo {
|
|
for _, candidate := range p.candidates {
|
|
pkgInfo, ok := p.knownPackages[candidate.ImportPath]
|
|
if !ok {
|
|
continue
|
|
}
|
|
if p.importIdentifier(candidate) != pkg {
|
|
continue
|
|
}
|
|
|
|
allFound := true
|
|
for right := range syms {
|
|
if !pkgInfo.exports[right] {
|
|
allFound = false
|
|
break
|
|
}
|
|
}
|
|
|
|
if allFound {
|
|
return candidate
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// references is set of references found in a Go file. The first map key is the
|
|
// left hand side of a selector expression, the second key is the right hand
|
|
// side, and the value should always be true.
|
|
type references map[string]map[string]bool
|
|
|
|
// A pass contains all the inputs and state necessary to fix a file's imports.
|
|
// It can be modified in some ways during use; see comments below.
|
|
type pass struct {
|
|
// Inputs. These must be set before a call to load, and not modified after.
|
|
fset *token.FileSet // fset used to parse f and its siblings.
|
|
f *ast.File // the file being fixed.
|
|
srcDir string // the directory containing f.
|
|
env *ProcessEnv // the environment to use for go commands, etc.
|
|
loadRealPackageNames bool // if true, load package names from disk rather than guessing them.
|
|
otherFiles []*ast.File // sibling files.
|
|
|
|
// Intermediate state, generated by load.
|
|
existingImports map[string]*ImportInfo
|
|
allRefs references
|
|
missingRefs references
|
|
|
|
// Inputs to fix. These can be augmented between successive fix calls.
|
|
lastTry bool // indicates that this is the last call and fix should clean up as best it can.
|
|
candidates []*ImportInfo // candidate imports in priority order.
|
|
knownPackages map[string]*packageInfo // information about all known packages.
|
|
}
|
|
|
|
// loadPackageNames saves the package names for everything referenced by imports.
|
|
func (p *pass) loadPackageNames(imports []*ImportInfo) error {
|
|
if p.env.Debug {
|
|
p.env.Logf("loading package names for %v packages", len(imports))
|
|
defer func() {
|
|
p.env.Logf("done loading package names for %v packages", len(imports))
|
|
}()
|
|
}
|
|
var unknown []string
|
|
for _, imp := range imports {
|
|
if _, ok := p.knownPackages[imp.ImportPath]; ok {
|
|
continue
|
|
}
|
|
unknown = append(unknown, imp.ImportPath)
|
|
}
|
|
|
|
names, err := p.env.GetResolver().loadPackageNames(unknown, p.srcDir)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for path, name := range names {
|
|
p.knownPackages[path] = &packageInfo{
|
|
name: name,
|
|
exports: map[string]bool{},
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// importIdentifier returns the identifier that imp will introduce. It will
|
|
// guess if the package name has not been loaded, e.g. because the source
|
|
// is not available.
|
|
func (p *pass) importIdentifier(imp *ImportInfo) string {
|
|
if imp.Name != "" {
|
|
return imp.Name
|
|
}
|
|
known := p.knownPackages[imp.ImportPath]
|
|
if known != nil && known.name != "" {
|
|
return known.name
|
|
}
|
|
return ImportPathToAssumedName(imp.ImportPath)
|
|
}
|
|
|
|
// load reads in everything necessary to run a pass, and reports whether the
|
|
// file already has all the imports it needs. It fills in p.missingRefs with the
|
|
// file's missing symbols, if any, or removes unused imports if not.
|
|
func (p *pass) load() ([]*ImportFix, bool) {
|
|
p.knownPackages = map[string]*packageInfo{}
|
|
p.missingRefs = references{}
|
|
p.existingImports = map[string]*ImportInfo{}
|
|
|
|
// Load basic information about the file in question.
|
|
p.allRefs = collectReferences(p.f)
|
|
|
|
// Load stuff from other files in the same package:
|
|
// global variables so we know they don't need resolving, and imports
|
|
// that we might want to mimic.
|
|
globals := map[string]bool{}
|
|
for _, otherFile := range p.otherFiles {
|
|
// Don't load globals from files that are in the same directory
|
|
// but a different package. Using them to suggest imports is OK.
|
|
if p.f.Name.Name == otherFile.Name.Name {
|
|
addGlobals(otherFile, globals)
|
|
}
|
|
p.candidates = append(p.candidates, collectImports(otherFile)...)
|
|
}
|
|
|
|
// Resolve all the import paths we've seen to package names, and store
|
|
// f's imports by the identifier they introduce.
|
|
imports := collectImports(p.f)
|
|
if p.loadRealPackageNames {
|
|
err := p.loadPackageNames(append(imports, p.candidates...))
|
|
if err != nil {
|
|
if p.env.Debug {
|
|
p.env.Logf("loading package names: %v", err)
|
|
}
|
|
return nil, false
|
|
}
|
|
}
|
|
for _, imp := range imports {
|
|
p.existingImports[p.importIdentifier(imp)] = imp
|
|
}
|
|
|
|
// Find missing references.
|
|
for left, rights := range p.allRefs {
|
|
if globals[left] {
|
|
continue
|
|
}
|
|
_, ok := p.existingImports[left]
|
|
if !ok {
|
|
p.missingRefs[left] = rights
|
|
continue
|
|
}
|
|
}
|
|
if len(p.missingRefs) != 0 {
|
|
return nil, false
|
|
}
|
|
|
|
return p.fix()
|
|
}
|
|
|
|
// fix attempts to satisfy missing imports using p.candidates. If it finds
|
|
// everything, or if p.lastTry is true, it updates fixes to add the imports it found,
|
|
// delete anything unused, and update import names, and returns true.
|
|
func (p *pass) fix() ([]*ImportFix, bool) {
|
|
// Find missing imports.
|
|
var selected []*ImportInfo
|
|
for left, rights := range p.missingRefs {
|
|
if imp := p.findMissingImport(left, rights); imp != nil {
|
|
selected = append(selected, imp)
|
|
}
|
|
}
|
|
|
|
if !p.lastTry && len(selected) != len(p.missingRefs) {
|
|
return nil, false
|
|
}
|
|
|
|
// Found everything, or giving up. Add the new imports and remove any unused.
|
|
var fixes []*ImportFix
|
|
for _, imp := range p.existingImports {
|
|
// We deliberately ignore globals here, because we can't be sure
|
|
// they're in the same package. People do things like put multiple
|
|
// main packages in the same directory, and we don't want to
|
|
// remove imports if they happen to have the same name as a var in
|
|
// a different package.
|
|
if _, ok := p.allRefs[p.importIdentifier(imp)]; !ok {
|
|
fixes = append(fixes, &ImportFix{
|
|
StmtInfo: *imp,
|
|
IdentName: p.importIdentifier(imp),
|
|
FixType: DeleteImport,
|
|
})
|
|
continue
|
|
}
|
|
|
|
// An existing import may need to update its import name to be correct.
|
|
if name := p.importSpecName(imp); name != imp.Name {
|
|
fixes = append(fixes, &ImportFix{
|
|
StmtInfo: ImportInfo{
|
|
Name: name,
|
|
ImportPath: imp.ImportPath,
|
|
},
|
|
IdentName: p.importIdentifier(imp),
|
|
FixType: SetImportName,
|
|
})
|
|
}
|
|
}
|
|
|
|
for _, imp := range selected {
|
|
fixes = append(fixes, &ImportFix{
|
|
StmtInfo: ImportInfo{
|
|
Name: p.importSpecName(imp),
|
|
ImportPath: imp.ImportPath,
|
|
},
|
|
IdentName: p.importIdentifier(imp),
|
|
FixType: AddImport,
|
|
})
|
|
}
|
|
|
|
return fixes, true
|
|
}
|
|
|
|
// importSpecName gets the import name of imp in the import spec.
|
|
//
|
|
// When the import identifier matches the assumed import name, the import name does
|
|
// not appear in the import spec.
|
|
func (p *pass) importSpecName(imp *ImportInfo) string {
|
|
// If we did not load the real package names, or the name is already set,
|
|
// we just return the existing name.
|
|
if !p.loadRealPackageNames || imp.Name != "" {
|
|
return imp.Name
|
|
}
|
|
|
|
ident := p.importIdentifier(imp)
|
|
if ident == ImportPathToAssumedName(imp.ImportPath) {
|
|
return "" // ident not needed since the assumed and real names are the same.
|
|
}
|
|
return ident
|
|
}
|
|
|
|
// apply will perform the fixes on f in order.
|
|
func apply(fset *token.FileSet, f *ast.File, fixes []*ImportFix) {
|
|
for _, fix := range fixes {
|
|
switch fix.FixType {
|
|
case DeleteImport:
|
|
astutil.DeleteNamedImport(fset, f, fix.StmtInfo.Name, fix.StmtInfo.ImportPath)
|
|
case AddImport:
|
|
astutil.AddNamedImport(fset, f, fix.StmtInfo.Name, fix.StmtInfo.ImportPath)
|
|
case SetImportName:
|
|
// Find the matching import path and change the name.
|
|
for _, spec := range f.Imports {
|
|
path := strings.Trim(spec.Path.Value, `"`)
|
|
if path == fix.StmtInfo.ImportPath {
|
|
spec.Name = &ast.Ident{
|
|
Name: fix.StmtInfo.Name,
|
|
NamePos: spec.Pos(),
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// assumeSiblingImportsValid assumes that siblings' use of packages is valid,
|
|
// adding the exports they use.
|
|
func (p *pass) assumeSiblingImportsValid() {
|
|
for _, f := range p.otherFiles {
|
|
refs := collectReferences(f)
|
|
imports := collectImports(f)
|
|
importsByName := map[string]*ImportInfo{}
|
|
for _, imp := range imports {
|
|
importsByName[p.importIdentifier(imp)] = imp
|
|
}
|
|
for left, rights := range refs {
|
|
if imp, ok := importsByName[left]; ok {
|
|
if m, ok := stdlib[imp.ImportPath]; ok {
|
|
// We have the stdlib in memory; no need to guess.
|
|
rights = copyExports(m)
|
|
}
|
|
p.addCandidate(imp, &packageInfo{
|
|
// no name; we already know it.
|
|
exports: rights,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// addCandidate adds a candidate import to p, and merges in the information
|
|
// in pkg.
|
|
func (p *pass) addCandidate(imp *ImportInfo, pkg *packageInfo) {
|
|
p.candidates = append(p.candidates, imp)
|
|
if existing, ok := p.knownPackages[imp.ImportPath]; ok {
|
|
if existing.name == "" {
|
|
existing.name = pkg.name
|
|
}
|
|
for export := range pkg.exports {
|
|
existing.exports[export] = true
|
|
}
|
|
} else {
|
|
p.knownPackages[imp.ImportPath] = pkg
|
|
}
|
|
}
|
|
|
|
// fixImports adds and removes imports from f so that all its references are
|
|
// satisfied and there are no unused imports.
|
|
//
|
|
// This is declared as a variable rather than a function so goimports can
|
|
// easily be extended by adding a file with an init function.
|
|
var fixImports = fixImportsDefault
|
|
|
|
func fixImportsDefault(fset *token.FileSet, f *ast.File, filename string, env *ProcessEnv) error {
|
|
fixes, err := getFixes(fset, f, filename, env)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
apply(fset, f, fixes)
|
|
return err
|
|
}
|
|
|
|
// getFixes gets the import fixes that need to be made to f in order to fix the imports.
|
|
// It does not modify the ast.
|
|
func getFixes(fset *token.FileSet, f *ast.File, filename string, env *ProcessEnv) ([]*ImportFix, error) {
|
|
abs, err := filepath.Abs(filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
srcDir := filepath.Dir(abs)
|
|
if env.Debug {
|
|
env.Logf("fixImports(filename=%q), abs=%q, srcDir=%q ...", filename, abs, srcDir)
|
|
}
|
|
|
|
// First pass: looking only at f, and using the naive algorithm to
|
|
// derive package names from import paths, see if the file is already
|
|
// complete. We can't add any imports yet, because we don't know
|
|
// if missing references are actually package vars.
|
|
p := &pass{fset: fset, f: f, srcDir: srcDir}
|
|
if fixes, done := p.load(); done {
|
|
return fixes, nil
|
|
}
|
|
|
|
otherFiles := parseOtherFiles(fset, srcDir, filename)
|
|
|
|
// Second pass: add information from other files in the same package,
|
|
// like their package vars and imports.
|
|
p.otherFiles = otherFiles
|
|
if fixes, done := p.load(); done {
|
|
return fixes, nil
|
|
}
|
|
|
|
// Now we can try adding imports from the stdlib.
|
|
p.assumeSiblingImportsValid()
|
|
addStdlibCandidates(p, p.missingRefs)
|
|
if fixes, done := p.fix(); done {
|
|
return fixes, nil
|
|
}
|
|
|
|
// Third pass: get real package names where we had previously used
|
|
// the naive algorithm. This is the first step that will use the
|
|
// environment, so we provide it here for the first time.
|
|
p = &pass{fset: fset, f: f, srcDir: srcDir, env: env}
|
|
p.loadRealPackageNames = true
|
|
p.otherFiles = otherFiles
|
|
if fixes, done := p.load(); done {
|
|
return fixes, nil
|
|
}
|
|
|
|
addStdlibCandidates(p, p.missingRefs)
|
|
p.assumeSiblingImportsValid()
|
|
if fixes, done := p.fix(); done {
|
|
return fixes, nil
|
|
}
|
|
|
|
// Go look for candidates in $GOPATH, etc. We don't necessarily load
|
|
// the real exports of sibling imports, so keep assuming their contents.
|
|
if err := addExternalCandidates(p, p.missingRefs, filename); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
p.lastTry = true
|
|
fixes, _ := p.fix()
|
|
return fixes, nil
|
|
}
|
|
|
|
// getCandidatePkgs returns the list of pkgs that are accessible from filename,
|
|
// optionall filtered to only packages named pkgName.
|
|
func getCandidatePkgs(pkgName, filename string, env *ProcessEnv) ([]*pkg, error) {
|
|
// TODO(heschi): filter out current package. (Don't forget x_test can import x.)
|
|
|
|
var result []*pkg
|
|
// Start off with the standard library.
|
|
for importPath := range stdlib {
|
|
if pkgName != "" && path.Base(importPath) != pkgName {
|
|
continue
|
|
}
|
|
result = append(result, &pkg{
|
|
dir: filepath.Join(env.GOROOT, "src", importPath),
|
|
importPathShort: importPath,
|
|
packageName: path.Base(importPath),
|
|
relevance: 0,
|
|
})
|
|
}
|
|
|
|
// Exclude goroot results -- getting them is relatively expensive, not cached,
|
|
// and generally redundant with the in-memory version.
|
|
exclude := []gopathwalk.RootType{gopathwalk.RootGOROOT}
|
|
// Only the go/packages resolver uses the first argument, and nobody uses that resolver.
|
|
scannedPkgs, err := env.GetResolver().scan(nil, true, exclude)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
dupCheck := map[string]struct{}{}
|
|
for _, pkg := range scannedPkgs {
|
|
if pkgName != "" && pkg.packageName != pkgName {
|
|
continue
|
|
}
|
|
if !canUse(filename, pkg.dir) {
|
|
continue
|
|
}
|
|
if _, ok := dupCheck[pkg.importPathShort]; ok {
|
|
continue
|
|
}
|
|
dupCheck[pkg.importPathShort] = struct{}{}
|
|
result = append(result, pkg)
|
|
}
|
|
|
|
// Sort first by relevance, then by package name, with import path as a tiebreaker.
|
|
sort.Slice(result, func(i, j int) bool {
|
|
pi, pj := result[i], result[j]
|
|
if pi.relevance != pj.relevance {
|
|
return pi.relevance < pj.relevance
|
|
}
|
|
if pi.packageName != pj.packageName {
|
|
return pi.packageName < pj.packageName
|
|
}
|
|
return pi.importPathShort < pj.importPathShort
|
|
})
|
|
|
|
return result, nil
|
|
}
|
|
|
|
func candidateImportName(pkg *pkg) string {
|
|
if ImportPathToAssumedName(pkg.importPathShort) != pkg.packageName {
|
|
return pkg.packageName
|
|
}
|
|
return ""
|
|
}
|
|
|
|
// getAllCandidates gets all of the candidates to be imported, regardless of if they are needed.
|
|
func getAllCandidates(filename string, env *ProcessEnv) ([]ImportFix, error) {
|
|
pkgs, err := getCandidatePkgs("", filename, env)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
result := make([]ImportFix, 0, len(pkgs))
|
|
for _, pkg := range pkgs {
|
|
result = append(result, ImportFix{
|
|
StmtInfo: ImportInfo{
|
|
ImportPath: pkg.importPathShort,
|
|
Name: candidateImportName(pkg),
|
|
},
|
|
IdentName: pkg.packageName,
|
|
FixType: AddImport,
|
|
})
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
// A PackageExport is a package and its exports.
|
|
type PackageExport struct {
|
|
Fix *ImportFix
|
|
Exports []string
|
|
}
|
|
|
|
func getPackageExports(completePackage, filename string, env *ProcessEnv) ([]PackageExport, error) {
|
|
pkgs, err := getCandidatePkgs(completePackage, filename, env)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
results := make([]PackageExport, 0, len(pkgs))
|
|
for _, pkg := range pkgs {
|
|
fix := &ImportFix{
|
|
StmtInfo: ImportInfo{
|
|
ImportPath: pkg.importPathShort,
|
|
Name: candidateImportName(pkg),
|
|
},
|
|
IdentName: pkg.packageName,
|
|
FixType: AddImport,
|
|
}
|
|
var exports []string
|
|
if e, ok := stdlib[pkg.importPathShort]; ok {
|
|
exports = e
|
|
} else {
|
|
exports, err = loadExportsForPackage(context.Background(), env, completePackage, pkg)
|
|
if err != nil {
|
|
if env.Debug {
|
|
env.Logf("while completing %q, error loading exports from %q: %v", completePackage, pkg.importPathShort, err)
|
|
}
|
|
continue
|
|
}
|
|
}
|
|
sort.Strings(exports)
|
|
results = append(results, PackageExport{
|
|
Fix: fix,
|
|
Exports: exports,
|
|
})
|
|
}
|
|
|
|
return results, nil
|
|
}
|
|
|
|
// ProcessEnv contains environment variables and settings that affect the use of
|
|
// the go command, the go/build package, etc.
|
|
type ProcessEnv struct {
|
|
LocalPrefix string
|
|
Debug bool
|
|
|
|
// If non-empty, these will be used instead of the
|
|
// process-wide values.
|
|
GOPATH, GOROOT, GO111MODULE, GOPROXY, GOFLAGS, GOSUMDB string
|
|
WorkingDir string
|
|
|
|
// If true, use go/packages regardless of the environment.
|
|
ForceGoPackages bool
|
|
|
|
// Logf is the default logger for the ProcessEnv.
|
|
Logf func(format string, args ...interface{})
|
|
|
|
resolver Resolver
|
|
}
|
|
|
|
func (e *ProcessEnv) env() []string {
|
|
env := os.Environ()
|
|
add := func(k, v string) {
|
|
if v != "" {
|
|
env = append(env, k+"="+v)
|
|
}
|
|
}
|
|
add("GOPATH", e.GOPATH)
|
|
add("GOROOT", e.GOROOT)
|
|
add("GO111MODULE", e.GO111MODULE)
|
|
add("GOPROXY", e.GOPROXY)
|
|
add("GOFLAGS", e.GOFLAGS)
|
|
add("GOSUMDB", e.GOSUMDB)
|
|
if e.WorkingDir != "" {
|
|
add("PWD", e.WorkingDir)
|
|
}
|
|
return env
|
|
}
|
|
|
|
func (e *ProcessEnv) GetResolver() Resolver {
|
|
if e.resolver != nil {
|
|
return e.resolver
|
|
}
|
|
if e.ForceGoPackages {
|
|
e.resolver = &goPackagesResolver{env: e}
|
|
return e.resolver
|
|
}
|
|
|
|
out, err := e.invokeGo("env", "GOMOD")
|
|
if err != nil || len(bytes.TrimSpace(out.Bytes())) == 0 {
|
|
e.resolver = &gopathResolver{env: e}
|
|
return e.resolver
|
|
}
|
|
e.resolver = &ModuleResolver{env: e}
|
|
return e.resolver
|
|
}
|
|
|
|
func (e *ProcessEnv) newPackagesConfig(mode packages.LoadMode) *packages.Config {
|
|
return &packages.Config{
|
|
Mode: mode,
|
|
Dir: e.WorkingDir,
|
|
Env: e.env(),
|
|
}
|
|
}
|
|
|
|
func (e *ProcessEnv) buildContext() *build.Context {
|
|
ctx := build.Default
|
|
ctx.GOROOT = e.GOROOT
|
|
ctx.GOPATH = e.GOPATH
|
|
|
|
// As of Go 1.14, build.Context has a WorkingDir field
|
|
// (see golang.org/issue/34860).
|
|
// Populate it only if present.
|
|
if wd := reflect.ValueOf(&ctx).Elem().FieldByName("WorkingDir"); wd.IsValid() && wd.Kind() == reflect.String {
|
|
wd.SetString(e.WorkingDir)
|
|
}
|
|
return &ctx
|
|
}
|
|
|
|
func (e *ProcessEnv) invokeGo(args ...string) (*bytes.Buffer, error) {
|
|
cmd := exec.Command("go", args...)
|
|
stdout := &bytes.Buffer{}
|
|
stderr := &bytes.Buffer{}
|
|
cmd.Stdout = stdout
|
|
cmd.Stderr = stderr
|
|
cmd.Env = e.env()
|
|
cmd.Dir = e.WorkingDir
|
|
|
|
if e.Debug {
|
|
defer func(start time.Time) { e.Logf("%s for %v", time.Since(start), cmdDebugStr(cmd)) }(time.Now())
|
|
}
|
|
if err := cmd.Run(); err != nil {
|
|
return nil, fmt.Errorf("running go: %v (stderr:\n%s)", err, stderr)
|
|
}
|
|
return stdout, nil
|
|
}
|
|
|
|
func cmdDebugStr(cmd *exec.Cmd) string {
|
|
env := make(map[string]string)
|
|
for _, kv := range cmd.Env {
|
|
split := strings.Split(kv, "=")
|
|
k, v := split[0], split[1]
|
|
env[k] = v
|
|
}
|
|
|
|
return fmt.Sprintf("GOROOT=%v GOPATH=%v GO111MODULE=%v GOPROXY=%v PWD=%v go %v", env["GOROOT"], env["GOPATH"], env["GO111MODULE"], env["GOPROXY"], env["PWD"], cmd.Args)
|
|
}
|
|
|
|
func addStdlibCandidates(pass *pass, refs references) {
|
|
add := func(pkg string) {
|
|
exports := copyExports(stdlib[pkg])
|
|
pass.addCandidate(
|
|
&ImportInfo{ImportPath: pkg},
|
|
&packageInfo{name: path.Base(pkg), exports: exports})
|
|
}
|
|
for left := range refs {
|
|
if left == "rand" {
|
|
// Make sure we try crypto/rand before math/rand.
|
|
add("crypto/rand")
|
|
add("math/rand")
|
|
continue
|
|
}
|
|
for importPath := range stdlib {
|
|
if path.Base(importPath) == left {
|
|
add(importPath)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// A Resolver does the build-system-specific parts of goimports.
|
|
type Resolver interface {
|
|
// loadPackageNames loads the package names in importPaths.
|
|
loadPackageNames(importPaths []string, srcDir string) (map[string]string, error)
|
|
// scan finds (at least) the packages satisfying refs. If loadNames is true,
|
|
// package names will be set on the results, and dirs whose package name
|
|
// could not be determined will be excluded.
|
|
scan(refs references, loadNames bool, exclude []gopathwalk.RootType) ([]*pkg, error)
|
|
// loadExports returns the set of exported symbols in the package at dir.
|
|
// loadExports may be called concurrently.
|
|
loadExports(ctx context.Context, pkg *pkg) (string, []string, error)
|
|
|
|
ClearForNewScan()
|
|
}
|
|
|
|
// gopackagesResolver implements resolver for GOPATH and module workspaces using go/packages.
|
|
type goPackagesResolver struct {
|
|
env *ProcessEnv
|
|
}
|
|
|
|
func (r *goPackagesResolver) ClearForNewScan() {}
|
|
|
|
func (r *goPackagesResolver) loadPackageNames(importPaths []string, srcDir string) (map[string]string, error) {
|
|
if len(importPaths) == 0 {
|
|
return nil, nil
|
|
}
|
|
cfg := r.env.newPackagesConfig(packages.LoadFiles)
|
|
pkgs, err := packages.Load(cfg, importPaths...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
names := map[string]string{}
|
|
for _, pkg := range pkgs {
|
|
names[VendorlessPath(pkg.PkgPath)] = pkg.Name
|
|
}
|
|
// We may not have found all the packages. Guess the rest.
|
|
for _, path := range importPaths {
|
|
if _, ok := names[path]; ok {
|
|
continue
|
|
}
|
|
names[path] = ImportPathToAssumedName(path)
|
|
}
|
|
return names, nil
|
|
|
|
}
|
|
|
|
func (r *goPackagesResolver) scan(refs references, _ bool, _ []gopathwalk.RootType) ([]*pkg, error) {
|
|
var loadQueries []string
|
|
for pkgName := range refs {
|
|
loadQueries = append(loadQueries, "iamashamedtousethedisabledqueryname="+pkgName)
|
|
}
|
|
sort.Strings(loadQueries)
|
|
cfg := r.env.newPackagesConfig(packages.LoadFiles)
|
|
goPackages, err := packages.Load(cfg, loadQueries...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var scan []*pkg
|
|
for _, goPackage := range goPackages {
|
|
scan = append(scan, &pkg{
|
|
dir: filepath.Dir(goPackage.CompiledGoFiles[0]),
|
|
importPathShort: VendorlessPath(goPackage.PkgPath),
|
|
goPackage: goPackage,
|
|
packageName: goPackage.Name,
|
|
})
|
|
}
|
|
return scan, nil
|
|
}
|
|
|
|
func (r *goPackagesResolver) loadExports(ctx context.Context, pkg *pkg) (string, []string, error) {
|
|
if pkg.goPackage == nil {
|
|
return "", nil, fmt.Errorf("goPackage not set")
|
|
}
|
|
var exports []string
|
|
fset := token.NewFileSet()
|
|
for _, fname := range pkg.goPackage.CompiledGoFiles {
|
|
f, err := parser.ParseFile(fset, fname, nil, 0)
|
|
if err != nil {
|
|
return "", nil, fmt.Errorf("parsing %s: %v", fname, err)
|
|
}
|
|
for name := range f.Scope.Objects {
|
|
if ast.IsExported(name) {
|
|
exports = append(exports, name)
|
|
}
|
|
}
|
|
}
|
|
return pkg.goPackage.Name, exports, nil
|
|
}
|
|
|
|
func addExternalCandidates(pass *pass, refs references, filename string) error {
|
|
dirScan, err := pass.env.GetResolver().scan(refs, false, nil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Search for imports matching potential package references.
|
|
type result struct {
|
|
imp *ImportInfo
|
|
pkg *packageInfo
|
|
}
|
|
results := make(chan result, len(refs))
|
|
|
|
ctx, cancel := context.WithCancel(context.TODO())
|
|
var wg sync.WaitGroup
|
|
defer func() {
|
|
cancel()
|
|
wg.Wait()
|
|
}()
|
|
var (
|
|
firstErr error
|
|
firstErrOnce sync.Once
|
|
)
|
|
for pkgName, symbols := range refs {
|
|
wg.Add(1)
|
|
go func(pkgName string, symbols map[string]bool) {
|
|
defer wg.Done()
|
|
|
|
found, err := findImport(ctx, pass, dirScan, pkgName, symbols, filename)
|
|
|
|
if err != nil {
|
|
firstErrOnce.Do(func() {
|
|
firstErr = err
|
|
cancel()
|
|
})
|
|
return
|
|
}
|
|
|
|
if found == nil {
|
|
return // No matching package.
|
|
}
|
|
|
|
imp := &ImportInfo{
|
|
ImportPath: found.importPathShort,
|
|
}
|
|
|
|
pkg := &packageInfo{
|
|
name: pkgName,
|
|
exports: symbols,
|
|
}
|
|
results <- result{imp, pkg}
|
|
}(pkgName, symbols)
|
|
}
|
|
go func() {
|
|
wg.Wait()
|
|
close(results)
|
|
}()
|
|
|
|
for result := range results {
|
|
pass.addCandidate(result.imp, result.pkg)
|
|
}
|
|
return firstErr
|
|
}
|
|
|
|
// notIdentifier reports whether ch is an invalid identifier character.
|
|
func notIdentifier(ch rune) bool {
|
|
return !('a' <= ch && ch <= 'z' || 'A' <= ch && ch <= 'Z' ||
|
|
'0' <= ch && ch <= '9' ||
|
|
ch == '_' ||
|
|
ch >= utf8.RuneSelf && (unicode.IsLetter(ch) || unicode.IsDigit(ch)))
|
|
}
|
|
|
|
// ImportPathToAssumedName returns the assumed package name of an import path.
|
|
// It does this using only string parsing of the import path.
|
|
// It picks the last element of the path that does not look like a major
|
|
// version, and then picks the valid identifier off the start of that element.
|
|
// It is used to determine if a local rename should be added to an import for
|
|
// clarity.
|
|
// This function could be moved to a standard package and exported if we want
|
|
// for use in other tools.
|
|
func ImportPathToAssumedName(importPath string) string {
|
|
base := path.Base(importPath)
|
|
if strings.HasPrefix(base, "v") {
|
|
if _, err := strconv.Atoi(base[1:]); err == nil {
|
|
dir := path.Dir(importPath)
|
|
if dir != "." {
|
|
base = path.Base(dir)
|
|
}
|
|
}
|
|
}
|
|
base = strings.TrimPrefix(base, "go-")
|
|
if i := strings.IndexFunc(base, notIdentifier); i >= 0 {
|
|
base = base[:i]
|
|
}
|
|
return base
|
|
}
|
|
|
|
// gopathResolver implements resolver for GOPATH workspaces.
|
|
type gopathResolver struct {
|
|
env *ProcessEnv
|
|
cache *dirInfoCache
|
|
}
|
|
|
|
func (r *gopathResolver) init() {
|
|
if r.cache == nil {
|
|
r.cache = &dirInfoCache{
|
|
dirs: map[string]*directoryPackageInfo{},
|
|
}
|
|
}
|
|
}
|
|
|
|
func (r *gopathResolver) ClearForNewScan() {
|
|
r.cache = nil
|
|
}
|
|
|
|
func (r *gopathResolver) loadPackageNames(importPaths []string, srcDir string) (map[string]string, error) {
|
|
r.init()
|
|
names := map[string]string{}
|
|
for _, path := range importPaths {
|
|
names[path] = importPathToName(r.env, path, srcDir)
|
|
}
|
|
return names, nil
|
|
}
|
|
|
|
// importPathToName finds out the actual package name, as declared in its .go files.
|
|
// If there's a problem, it returns "".
|
|
func importPathToName(env *ProcessEnv, importPath, srcDir string) (packageName string) {
|
|
// Fast path for standard library without going to disk.
|
|
if _, ok := stdlib[importPath]; ok {
|
|
return path.Base(importPath) // stdlib packages always match their paths.
|
|
}
|
|
|
|
buildPkg, err := env.buildContext().Import(importPath, srcDir, build.FindOnly)
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
pkgName, err := packageDirToName(buildPkg.Dir)
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
return pkgName
|
|
}
|
|
|
|
// packageDirToName is a faster version of build.Import if
|
|
// the only thing desired is the package name. Given a directory,
|
|
// packageDirToName then only parses one file in the package,
|
|
// trusting that the files in the directory are consistent.
|
|
func packageDirToName(dir string) (packageName string, err error) {
|
|
d, err := os.Open(dir)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
names, err := d.Readdirnames(-1)
|
|
d.Close()
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
sort.Strings(names) // to have predictable behavior
|
|
var lastErr error
|
|
var nfile int
|
|
for _, name := range names {
|
|
if !strings.HasSuffix(name, ".go") {
|
|
continue
|
|
}
|
|
if strings.HasSuffix(name, "_test.go") {
|
|
continue
|
|
}
|
|
nfile++
|
|
fullFile := filepath.Join(dir, name)
|
|
|
|
fset := token.NewFileSet()
|
|
f, err := parser.ParseFile(fset, fullFile, nil, parser.PackageClauseOnly)
|
|
if err != nil {
|
|
lastErr = err
|
|
continue
|
|
}
|
|
pkgName := f.Name.Name
|
|
if pkgName == "documentation" {
|
|
// Special case from go/build.ImportDir, not
|
|
// handled by ctx.MatchFile.
|
|
continue
|
|
}
|
|
if pkgName == "main" {
|
|
// Also skip package main, assuming it's a +build ignore generator or example.
|
|
// Since you can't import a package main anyway, there's no harm here.
|
|
continue
|
|
}
|
|
return pkgName, nil
|
|
}
|
|
if lastErr != nil {
|
|
return "", lastErr
|
|
}
|
|
return "", fmt.Errorf("no importable package found in %d Go files", nfile)
|
|
}
|
|
|
|
type pkg struct {
|
|
goPackage *packages.Package
|
|
dir string // absolute file path to pkg directory ("/usr/lib/go/src/net/http")
|
|
importPathShort string // vendorless import path ("net/http", "a/b")
|
|
packageName string // package name loaded from source if requested
|
|
relevance int // a weakly-defined score of how relevant a package is. 0 is most relevant.
|
|
}
|
|
|
|
type pkgDistance struct {
|
|
pkg *pkg
|
|
distance int // relative distance to target
|
|
}
|
|
|
|
// byDistanceOrImportPathShortLength sorts by relative distance breaking ties
|
|
// on the short import path length and then the import string itself.
|
|
type byDistanceOrImportPathShortLength []pkgDistance
|
|
|
|
func (s byDistanceOrImportPathShortLength) Len() int { return len(s) }
|
|
func (s byDistanceOrImportPathShortLength) Less(i, j int) bool {
|
|
di, dj := s[i].distance, s[j].distance
|
|
if di == -1 {
|
|
return false
|
|
}
|
|
if dj == -1 {
|
|
return true
|
|
}
|
|
if di != dj {
|
|
return di < dj
|
|
}
|
|
|
|
vi, vj := s[i].pkg.importPathShort, s[j].pkg.importPathShort
|
|
if len(vi) != len(vj) {
|
|
return len(vi) < len(vj)
|
|
}
|
|
return vi < vj
|
|
}
|
|
func (s byDistanceOrImportPathShortLength) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
|
|
|
|
func distance(basepath, targetpath string) int {
|
|
p, err := filepath.Rel(basepath, targetpath)
|
|
if err != nil {
|
|
return -1
|
|
}
|
|
if p == "." {
|
|
return 0
|
|
}
|
|
return strings.Count(p, string(filepath.Separator)) + 1
|
|
}
|
|
|
|
func (r *gopathResolver) scan(_ references, loadNames bool, exclude []gopathwalk.RootType) ([]*pkg, error) {
|
|
r.init()
|
|
add := func(root gopathwalk.Root, dir string) {
|
|
// We assume cached directories have not changed. We can skip them and their
|
|
// children.
|
|
if _, ok := r.cache.Load(dir); ok {
|
|
return
|
|
}
|
|
|
|
importpath := filepath.ToSlash(dir[len(root.Path)+len("/"):])
|
|
info := directoryPackageInfo{
|
|
status: directoryScanned,
|
|
dir: dir,
|
|
rootType: root.Type,
|
|
nonCanonicalImportPath: VendorlessPath(importpath),
|
|
}
|
|
r.cache.Store(dir, info)
|
|
}
|
|
roots := filterRoots(gopathwalk.SrcDirsRoots(r.env.buildContext()), exclude)
|
|
gopathwalk.Walk(roots, add, gopathwalk.Options{Debug: r.env.Debug, ModulesEnabled: false})
|
|
var result []*pkg
|
|
for _, dir := range r.cache.Keys() {
|
|
info, ok := r.cache.Load(dir)
|
|
if !ok {
|
|
continue
|
|
}
|
|
if loadNames {
|
|
var err error
|
|
info, err = r.cache.CachePackageName(info)
|
|
if err != nil {
|
|
continue
|
|
}
|
|
}
|
|
|
|
p := &pkg{
|
|
importPathShort: info.nonCanonicalImportPath,
|
|
dir: dir,
|
|
relevance: 1,
|
|
packageName: info.packageName,
|
|
}
|
|
if info.rootType == gopathwalk.RootGOROOT {
|
|
p.relevance = 0
|
|
}
|
|
result = append(result, p)
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
func filterRoots(roots []gopathwalk.Root, exclude []gopathwalk.RootType) []gopathwalk.Root {
|
|
var result []gopathwalk.Root
|
|
outer:
|
|
for _, root := range roots {
|
|
for _, i := range exclude {
|
|
if i == root.Type {
|
|
continue outer
|
|
}
|
|
}
|
|
result = append(result, root)
|
|
}
|
|
return result
|
|
}
|
|
|
|
func (r *gopathResolver) loadExports(ctx context.Context, pkg *pkg) (string, []string, error) {
|
|
r.init()
|
|
if info, ok := r.cache.Load(pkg.dir); ok {
|
|
return r.cache.CacheExports(ctx, r.env, info)
|
|
}
|
|
return loadExportsFromFiles(ctx, r.env, pkg.dir)
|
|
}
|
|
|
|
// VendorlessPath returns the devendorized version of the import path ipath.
|
|
// For example, VendorlessPath("foo/bar/vendor/a/b") returns "a/b".
|
|
func VendorlessPath(ipath string) string {
|
|
// Devendorize for use in import statement.
|
|
if i := strings.LastIndex(ipath, "/vendor/"); i >= 0 {
|
|
return ipath[i+len("/vendor/"):]
|
|
}
|
|
if strings.HasPrefix(ipath, "vendor/") {
|
|
return ipath[len("vendor/"):]
|
|
}
|
|
return ipath
|
|
}
|
|
|
|
func loadExportsFromFiles(ctx context.Context, env *ProcessEnv, dir string) (string, []string, error) {
|
|
var exports []string
|
|
|
|
// Look for non-test, buildable .go files which could provide exports.
|
|
all, err := ioutil.ReadDir(dir)
|
|
if err != nil {
|
|
return "", nil, err
|
|
}
|
|
var files []os.FileInfo
|
|
for _, fi := range all {
|
|
name := fi.Name()
|
|
if !strings.HasSuffix(name, ".go") || strings.HasSuffix(name, "_test.go") {
|
|
continue
|
|
}
|
|
match, err := env.buildContext().MatchFile(dir, fi.Name())
|
|
if err != nil || !match {
|
|
continue
|
|
}
|
|
files = append(files, fi)
|
|
}
|
|
|
|
if len(files) == 0 {
|
|
return "", nil, fmt.Errorf("dir %v contains no buildable, non-test .go files", dir)
|
|
}
|
|
|
|
var pkgName string
|
|
fset := token.NewFileSet()
|
|
for _, fi := range files {
|
|
select {
|
|
case <-ctx.Done():
|
|
return "", nil, ctx.Err()
|
|
default:
|
|
}
|
|
|
|
fullFile := filepath.Join(dir, fi.Name())
|
|
f, err := parser.ParseFile(fset, fullFile, nil, 0)
|
|
if err != nil {
|
|
return "", nil, fmt.Errorf("parsing %s: %v", fullFile, err)
|
|
}
|
|
if f.Name.Name == "documentation" {
|
|
// Special case from go/build.ImportDir, not
|
|
// handled by MatchFile above.
|
|
continue
|
|
}
|
|
pkgName = f.Name.Name
|
|
for name := range f.Scope.Objects {
|
|
if ast.IsExported(name) {
|
|
exports = append(exports, name)
|
|
}
|
|
}
|
|
}
|
|
|
|
if env.Debug {
|
|
sortedExports := append([]string(nil), exports...)
|
|
sort.Strings(sortedExports)
|
|
env.Logf("loaded exports in dir %v (package %v): %v", dir, pkgName, strings.Join(sortedExports, ", "))
|
|
}
|
|
return pkgName, exports, nil
|
|
}
|
|
|
|
// findImport searches for a package with the given symbols.
|
|
// If no package is found, findImport returns ("", false, nil)
|
|
func findImport(ctx context.Context, pass *pass, dirScan []*pkg, pkgName string, symbols map[string]bool, filename string) (*pkg, error) {
|
|
pkgDir, err := filepath.Abs(filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
pkgDir = filepath.Dir(pkgDir)
|
|
|
|
// Find candidate packages, looking only at their directory names first.
|
|
var candidates []pkgDistance
|
|
for _, pkg := range dirScan {
|
|
if pkg.dir == pkgDir && pass.f.Name.Name == pkgName {
|
|
// The candidate is in the same directory and has the
|
|
// same package name. Don't try to import ourselves.
|
|
continue
|
|
}
|
|
if pkgIsCandidate(filename, pkgName, pkg) {
|
|
candidates = append(candidates, pkgDistance{
|
|
pkg: pkg,
|
|
distance: distance(pkgDir, pkg.dir),
|
|
})
|
|
}
|
|
}
|
|
|
|
// Sort the candidates by their import package length,
|
|
// assuming that shorter package names are better than long
|
|
// ones. Note that this sorts by the de-vendored name, so
|
|
// there's no "penalty" for vendoring.
|
|
sort.Sort(byDistanceOrImportPathShortLength(candidates))
|
|
if pass.env.Debug {
|
|
for i, c := range candidates {
|
|
pass.env.Logf("%s candidate %d/%d: %v in %v", pkgName, i+1, len(candidates), c.pkg.importPathShort, c.pkg.dir)
|
|
}
|
|
}
|
|
|
|
// Collect exports for packages with matching names.
|
|
|
|
rescv := make([]chan *pkg, len(candidates))
|
|
for i := range candidates {
|
|
rescv[i] = make(chan *pkg, 1)
|
|
}
|
|
const maxConcurrentPackageImport = 4
|
|
loadExportsSem := make(chan struct{}, maxConcurrentPackageImport)
|
|
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
var wg sync.WaitGroup
|
|
defer func() {
|
|
cancel()
|
|
wg.Wait()
|
|
}()
|
|
|
|
wg.Add(1)
|
|
go func() {
|
|
defer wg.Done()
|
|
for i, c := range candidates {
|
|
select {
|
|
case loadExportsSem <- struct{}{}:
|
|
case <-ctx.Done():
|
|
return
|
|
}
|
|
|
|
wg.Add(1)
|
|
go func(c pkgDistance, resc chan<- *pkg) {
|
|
defer func() {
|
|
<-loadExportsSem
|
|
wg.Done()
|
|
}()
|
|
|
|
if pass.env.Debug {
|
|
pass.env.Logf("loading exports in dir %s (seeking package %s)", c.pkg.dir, pkgName)
|
|
}
|
|
exports, err := loadExportsForPackage(ctx, pass.env, pkgName, c.pkg)
|
|
if err != nil {
|
|
if pass.env.Debug {
|
|
pass.env.Logf("loading exports in dir %s (seeking package %s): %v", c.pkg.dir, pkgName, err)
|
|
}
|
|
resc <- nil
|
|
return
|
|
}
|
|
|
|
exportsMap := make(map[string]bool, len(exports))
|
|
for _, sym := range exports {
|
|
exportsMap[sym] = true
|
|
}
|
|
|
|
// If it doesn't have the right
|
|
// symbols, send nil to mean no match.
|
|
for symbol := range symbols {
|
|
if !exportsMap[symbol] {
|
|
resc <- nil
|
|
return
|
|
}
|
|
}
|
|
resc <- c.pkg
|
|
}(c, rescv[i])
|
|
}
|
|
}()
|
|
|
|
for _, resc := range rescv {
|
|
pkg := <-resc
|
|
if pkg == nil {
|
|
continue
|
|
}
|
|
return pkg, nil
|
|
}
|
|
return nil, nil
|
|
}
|
|
|
|
func loadExportsForPackage(ctx context.Context, env *ProcessEnv, expectPkg string, pkg *pkg) ([]string, error) {
|
|
pkgName, exports, err := env.GetResolver().loadExports(ctx, pkg)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if expectPkg != pkgName {
|
|
return nil, fmt.Errorf("dir %v is package %v, wanted %v", pkg.dir, pkgName, expectPkg)
|
|
}
|
|
return exports, err
|
|
}
|
|
|
|
// pkgIsCandidate reports whether pkg is a candidate for satisfying the
|
|
// finding which package pkgIdent in the file named by filename is trying
|
|
// to refer to.
|
|
//
|
|
// This check is purely lexical and is meant to be as fast as possible
|
|
// because it's run over all $GOPATH directories to filter out poor
|
|
// candidates in order to limit the CPU and I/O later parsing the
|
|
// exports in candidate packages.
|
|
//
|
|
// filename is the file being formatted.
|
|
// pkgIdent is the package being searched for, like "client" (if
|
|
// searching for "client.New")
|
|
func pkgIsCandidate(filename, pkgIdent string, pkg *pkg) bool {
|
|
// Check "internal" and "vendor" visibility:
|
|
if !canUse(filename, pkg.dir) {
|
|
return false
|
|
}
|
|
|
|
// Speed optimization to minimize disk I/O:
|
|
// the last two components on disk must contain the
|
|
// package name somewhere.
|
|
//
|
|
// This permits mismatch naming like directory
|
|
// "go-foo" being package "foo", or "pkg.v3" being "pkg",
|
|
// or directory "google.golang.org/api/cloudbilling/v1"
|
|
// being package "cloudbilling", but doesn't
|
|
// permit a directory "foo" to be package
|
|
// "bar", which is strongly discouraged
|
|
// anyway. There's no reason goimports needs
|
|
// to be slow just to accommodate that.
|
|
lastTwo := lastTwoComponents(pkg.importPathShort)
|
|
if strings.Contains(lastTwo, pkgIdent) {
|
|
return true
|
|
}
|
|
if hasHyphenOrUpperASCII(lastTwo) && !hasHyphenOrUpperASCII(pkgIdent) {
|
|
lastTwo = lowerASCIIAndRemoveHyphen(lastTwo)
|
|
if strings.Contains(lastTwo, pkgIdent) {
|
|
return true
|
|
}
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
func hasHyphenOrUpperASCII(s string) bool {
|
|
for i := 0; i < len(s); i++ {
|
|
b := s[i]
|
|
if b == '-' || ('A' <= b && b <= 'Z') {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func lowerASCIIAndRemoveHyphen(s string) (ret string) {
|
|
buf := make([]byte, 0, len(s))
|
|
for i := 0; i < len(s); i++ {
|
|
b := s[i]
|
|
switch {
|
|
case b == '-':
|
|
continue
|
|
case 'A' <= b && b <= 'Z':
|
|
buf = append(buf, b+('a'-'A'))
|
|
default:
|
|
buf = append(buf, b)
|
|
}
|
|
}
|
|
return string(buf)
|
|
}
|
|
|
|
// canUse reports whether the package in dir is usable from filename,
|
|
// respecting the Go "internal" and "vendor" visibility rules.
|
|
func canUse(filename, dir string) bool {
|
|
// Fast path check, before any allocations. If it doesn't contain vendor
|
|
// or internal, it's not tricky:
|
|
// Note that this can false-negative on directories like "notinternal",
|
|
// but we check it correctly below. This is just a fast path.
|
|
if !strings.Contains(dir, "vendor") && !strings.Contains(dir, "internal") {
|
|
return true
|
|
}
|
|
|
|
dirSlash := filepath.ToSlash(dir)
|
|
if !strings.Contains(dirSlash, "/vendor/") && !strings.Contains(dirSlash, "/internal/") && !strings.HasSuffix(dirSlash, "/internal") {
|
|
return true
|
|
}
|
|
// Vendor or internal directory only visible from children of parent.
|
|
// That means the path from the current directory to the target directory
|
|
// can contain ../vendor or ../internal but not ../foo/vendor or ../foo/internal
|
|
// or bar/vendor or bar/internal.
|
|
// After stripping all the leading ../, the only okay place to see vendor or internal
|
|
// is at the very beginning of the path.
|
|
absfile, err := filepath.Abs(filename)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
absdir, err := filepath.Abs(dir)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
rel, err := filepath.Rel(absfile, absdir)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
relSlash := filepath.ToSlash(rel)
|
|
if i := strings.LastIndex(relSlash, "../"); i >= 0 {
|
|
relSlash = relSlash[i+len("../"):]
|
|
}
|
|
return !strings.Contains(relSlash, "/vendor/") && !strings.Contains(relSlash, "/internal/") && !strings.HasSuffix(relSlash, "/internal")
|
|
}
|
|
|
|
// lastTwoComponents returns at most the last two path components
|
|
// of v, using either / or \ as the path separator.
|
|
func lastTwoComponents(v string) string {
|
|
nslash := 0
|
|
for i := len(v) - 1; i >= 0; i-- {
|
|
if v[i] == '/' || v[i] == '\\' {
|
|
nslash++
|
|
if nslash == 2 {
|
|
return v[i:]
|
|
}
|
|
}
|
|
}
|
|
return v
|
|
}
|
|
|
|
type visitFn func(node ast.Node) ast.Visitor
|
|
|
|
func (fn visitFn) Visit(node ast.Node) ast.Visitor {
|
|
return fn(node)
|
|
}
|
|
|
|
func copyExports(pkg []string) map[string]bool {
|
|
m := make(map[string]bool, len(pkg))
|
|
for _, v := range pkg {
|
|
m[v] = true
|
|
}
|
|
return m
|
|
}
|