github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/lib/http/api.go

package http

import (
	"fmt"
	"net/http"
	"strings"

	"github.com/qri-io/qri/dsref"
)

// APIEndpoint is a simple alias to have a consistent definition
// of our API endpoints
type APIEndpoint string

// String allows for less casting in general code
func (ae APIEndpoint) String() string {
	return string(ae)
}

// NoTrailingSlash returns the path without a traling slash
func (ae APIEndpoint) NoTrailingSlash() string {
	s := string(ae)
	s = strings.TrimSuffix(s, "/")
	return s
}

// WithSuffix returns a new endpoint with added path suffix
func (ae APIEndpoint) WithSuffix(suffix string) APIEndpoint {
	return APIEndpoint(fmt.Sprintf("%s/%s", ae, suffix))
}

const (
	// aggregate endpoints

	// AEList lists all datasets in your collection
	AEList APIEndpoint = "/list"
	// AECollectionGet returns info on a head dataset in your collection
	AECollectionGet APIEndpoint = "/collection/get"
	// AEDiff is an endpoint for generating dataset diffs
	AEDiff APIEndpoint = "/diff"
	// AEChanges is an endpoint for generating dataset change reports
	AEChanges APIEndpoint = "/changes"

	// auth endpoints

	// AECreateAuthToken creates an auth token for a user
	AECreateAuthToken APIEndpoint = "/access/token"

	// automation endpoints

	// AEApply invokes a transform apply
	AEApply APIEndpoint = "/auto/apply"
	// AEDeploy creates, updates, or deploys a workflow
	AEDeploy APIEndpoint = "/auto/deploy"
	// AERun manually runs a workflow
	AERun APIEndpoint = "/auto/run"
	// AERunInfo fetches the full run info for a workflow run
	AERunInfo APIEndpoint = "/auto/runinfo"
	// AECancel cancels a run
	AECancel APIEndpoint = "/auto/cancel"
	// AEWorkflow fetches a workflow
	AEWorkflow APIEndpoint = "/auto/workflow"
	// AERemoveWorkflow removes a workflow
	AERemoveWorkflow APIEndpoint = "/auto/remove"
	// AEAnalyzeTransform performs static analysis on a starlark transform script
	AEAnalyzeTransform APIEndpoint = "/auto/analyze-transform"

	// dataset endpoints

	// AEGet is an endpoint for fetch individual dataset components
	AEGet APIEndpoint = "/ds/get"
	// AEActivity is an endpoint that returns a dataset activity list
	AEActivity APIEndpoint = "/ds/activity"
	// AERename is an endpoint for renaming datasets
	AERename APIEndpoint = "/ds/rename"
	// AESave is an endpoint for saving a dataset
	AESave APIEndpoint = "/ds/save"
	// AEPull facilittates dataset pull requests from a remote
	AEPull APIEndpoint = "/ds/pull"
	// AEPush facilitates dataset push requests to a remote
	AEPush APIEndpoint = "/ds/push"
	// AERender renders the current dataset ref
	AERender APIEndpoint = "/ds/render"
	// AERemove exposes the dataset remove mechanics
	AERemove APIEndpoint = "/ds/remove"
	// AEValidate is an endpoint for validating datasets
	AEValidate APIEndpoint = "/ds/validate"
	// AEManifest generates a manifest for a dataset path
	AEManifest APIEndpoint = "/ds/manifest"
	// AEManifestMissing generates a manifest of blocks that are not present on this repo for a given manifest
	AEManifestMissing APIEndpoint = "/ds/manifest/missing"
	// AEDAGInfo generates a dag.Info for a dataset path
	AEDAGInfo APIEndpoint = "/ds/daginfo"
	// AEWhatChanged gets what changed at a specific version in history
	AEWhatChanged APIEndpoint = "/ds/whatchanged"

	// peer endpoints

	// AEPeer fetches a specific peer
	AEPeer APIEndpoint = "/peer"
	// AEConnect initiates an explicit connection to a peer
	AEConnect APIEndpoint = "/peer/connect"
	// AEDisconnect closes an explicit connection to a peer
	AEDisconnect APIEndpoint = "/peer/disconnect"
	// AEPeers fetches all the peers
	AEPeers APIEndpoint = "/peer/list"

	// profile endpoints

	// AEGetProfile is an alias for the me endpoint
	AEGetProfile APIEndpoint = "/profile"
	// AESetProfile is an endpoint to set the profile
	AESetProfile APIEndpoint = "/profile/set"
	// AESetProfilePhoto is an endpoint to set the profile photo
	AESetProfilePhoto APIEndpoint = "/profile/photo"
	// AESetPosterPhoto is an endpoint to set the profile poster
	AESetPosterPhoto APIEndpoint = "/profile/poster"

	// remote client endpoints

	// AEFeeds fetches and index of named feeds
	AEFeeds APIEndpoint = "/remote/feeds"
	// AEPreview fetches a dataset preview from the registry
	AEPreview APIEndpoint = "/remote/preview"
	// AERemoteRemove removes a dataset from a given remote
	AERemoteRemove APIEndpoint = "/remote/remove"
	// AERegistryNew creates a new user on the registry
	AERegistryNew APIEndpoint = "/remote/registry/profile/new"
	// AERegistryProve links an the current peer with an existing
	// user on the registry
	AERegistryProve APIEndpoint = "/remote/registry/profile/prove"
	// AESearch returns a list of dataset search results
	AESearch APIEndpoint = "/registry/search"
	// AERegistryGetFollowing returns a list of datasets a user follows
	AERegistryGetFollowing APIEndpoint = "/registry/follow/list"
	// AERegistryFollow updates the follow status of the current user for a given dataset
	AERegistryFollow APIEndpoint = "/registry/follow"

	// sync endpoints

	// AERemoteDSync exposes the dsync mechanics
	AERemoteDSync APIEndpoint = "/remote/dsync"
	// AERemoteLogSync exposes the logsync mechanics
	AERemoteLogSync APIEndpoint = "/remote/logsync"
	// AERemoteRefs exposes the remote ref resolution mechanics
	AERemoteRefs APIEndpoint = "/remote/refs"

	// other endpoints

	// AEConnections lists qri & IPFS connections
	AEConnections APIEndpoint = "/connections"
	// AEConnectedQriProfiles lists qri profile connections
	AEConnectedQriProfiles APIEndpoint = "/connections/qri"

	// DenyHTTP will disable HTTP access to a method
	DenyHTTP = APIEndpoint("")
)

// DsRefFromPath parses a path and returns a dsref.Ref
func DsRefFromPath(prefix, path string) (dsref.Ref, error) {
	refstr := PathToQriPath(prefix, path)
	return dsref.ParsePeerRef(refstr)
}

// PathToQriPath converts a http path to a
// qri path
func PathToQriPath(prefix, path string) string {
	path = strings.TrimPrefix(path, prefix)
	paramIndex := strings.Index(path, "?")
	if paramIndex != -1 {
		path = path[:paramIndex]
	}
	// TODO(dustmop): If a user has a dataset named "at", this breaks
	path = strings.Replace(path, "/at/", "@/", 1)
	path = strings.TrimPrefix(path, "/")
	return path
}

// DatasetRefFromReq examines the path element of a request URL
// to
func DatasetRefFromReq(prefix string, r *http.Request) (dsref.Ref, error) {
	if r.URL.String() == "" || r.URL.Path == "" {
		return dsref.Ref{}, nil
	}
	return DsRefFromPath(prefix, r.URL.Path)
}