pkg/desktop/desktop.go

Rama main · réplica de lectura del repositorio original.

// Package desktop opens files and folders through the desktop environment of the
// machine the Encore daemon runs on.
//
// It exists for the developer dashboard's "open" and "reveal in file manager"
// actions.
package desktop

import (
	"os"
	"path/filepath"

	"github.com/cockroachdb/errors"
)

// ErrNoDesktop reports that this machine has no desktop environment.
var ErrNoDesktop = errors.New("this machine has no desktop environment to open files in")

// Supported reports whether Open and Reveal can do anything on this machine.
func Supported() bool {
	return supported()
}

// Open launches path with the program the operating system has registered for it.
//
// The program is detached from the daemon, so it outlives it.
func Open(path string) error {
	if err := check(path); err != nil {
		return err
	}
	return open(path)
}

// Reveal opens the file manager showing the directory holding path, with path
// selected. It accepts both files and directories.
//
// Selecting the item isn't possible on every platform; see the platform files.
func Reveal(path string) error {
	if err := check(path); err != nil {
		return err
	}
	return reveal(path)
}

// check rejects a request this machine can't carry out.
func check(path string) error {
	if !supported() {
		return ErrNoDesktop
	}
	return checkPath(path)
}

// checkPath rejects a path no platform could act on.
func checkPath(path string) error {
	if !filepath.IsAbs(path) {
		return errors.Newf("path must be absolute, got %q", path)
	}

	// Stat so that a path which has since been deleted is reported as such: opening
	// one silently does nothing on some platforms, and opens an unrelated window on
	// others. The Windows reveal also relies on this having run.
	if _, err := os.Stat(path); err != nil {
		return err
	}
	return nil
}