Method Install

configs/port_install.go:23–194

Install install a port and tell me where it was installed from.

(options InstallOptions)

// Install install a port and tell me where it was installed from.
func (p *Port) Install(options InstallOptions) (installedFrom string, retErr error) {
	// At the top-level entry, reset the installReport.
	if p.Parent == "" {
		p.installReport = newInstallReport(p.NameVersion())
	}
	defer func() {
		if retErr != nil || p.installReport == nil {
			return
		}

		finalFrom := installedFrom
		if finalFrom == "" {
			finalFrom = "preinstalled"
		}
		p.installReport.add(p, finalFrom)

		// Only top-level port writes report files.
		if p.Parent == "" {
			reportPath, err := p.installReport.write(p)
			if err != nil {
				color.PrintWarning("failed to write install report for %s: %s", p.NameVersion(), err)
				return
			}

			color.PrintPass("%s's install report is generated", p.NameVersion())
			color.PrintHint("Location: %s\n", reportPath)
		}
	}()

	installedDir := expr.If(p.DevDep || p.HostDep,
		filepath.Join(dirs.InstalledDir, p.ctx.Platform().GetHostName()+"-dev"),
		filepath.Join(dirs.InstalledDir,
			p.ctx.Platform().GetName()+"@"+p.ctx.Project().GetName()+"@"+p.ctx.BuildType()),
	)

	// There is no need to read p.Installed() if build with --force, this API may time-consuming.
	var installed bool
	if options.Force {
		installed = false
	} else {
		if result, err := p.Installed(); err != nil {
			return "", err
		} else {
			installed = result
		}
	}

	// Remvoe installed port when repo source changed.
	if p.sourceModified {
		options := RemoveOptions{
			Purge:      true,
			Recursive:  false,
			BuildCache: false,
		}
		if err := p.Remove(options); err != nil {
			return "", fmt.Errorf("failed to remove installed package -> %w", err)
		}
		installed = false // Mark as not installed.