-- SPDX-FileCopyrightText: 2026 Alexandra de Wit
--
-- SPDX-License-Identifier: MIT

-- | PyPI request paths, metadata negotiation and credentials over shared HTTP mechanics.
module Ecluse.Core.Registry.PyPI.Request (
    -- * The ecosystem's artifact hosts
    pypiArtifactHosts,

    -- * Request building
    simpleIndexRequest,
    simpleIndexRequestUnder,
    artifactRequestByFile,
    artifactRequestByUrl,

    -- * URL building
    simpleIndexUrl,
    artifactFileUrl,
    artifactPath,
) where

import Network.HTTP.Client (Request)

import Ecluse.Core.Credential (ClientCredential)
import Ecluse.Core.Package (PackageName)
import Ecluse.Core.Registry (UrlFormationError)
import Ecluse.Core.Registry.PyPI.Credential (pypiCredential)
import Ecluse.Core.Registry.PyPI.Project (canonicalName)
import Ecluse.Core.Registry.PyPI.Wire (simpleIndexMediaType)
import Ecluse.Core.Registry.Request (BaseRequest, joinPath, parseRequestEither, requestAt)
import Ecluse.Core.Registry.Request qualified as Request
import Ecluse.Core.Server.Path (encodeComponent)

-- | PyPI's files host, admitted alongside the registry host by the artifact gate.
pypiArtifactHosts :: [Text]
pypiArtifactHosts :: [Text]
pypiArtifactHosts = [Text
"https://files.pythonhosted.org"]

-- | Build the Simple-index @GET@ for a project. It fails only on an empty or unparseable base URL.
simpleIndexRequest ::
    Text ->
    Maybe ClientCredential ->
    PackageName ->
    Either UrlFormationError Request
simpleIndexRequest :: Text
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
simpleIndexRequest Text
baseUrl Maybe ClientCredential
credential PackageName
name = Maybe ClientCredential -> Request -> Request
indexGet Maybe ClientCredential
credential (Request -> Request)
-> Either UrlFormationError Request
-> Either UrlFormationError Request
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (Text -> PackageName -> Either UrlFormationError Text
simpleIndexUrl Text
baseUrl PackageName
name Either UrlFormationError Text
-> (Text -> Either UrlFormationError Request)
-> Either UrlFormationError Request
forall a b.
Either UrlFormationError a
-> (a -> Either UrlFormationError b) -> Either UrlFormationError b
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= Text -> Either UrlFormationError Request
parseRequestEither)

-- | 'simpleIndexRequest' under a base parsed once, through 'requestAt'.
simpleIndexRequestUnder ::
    BaseRequest ->
    Maybe ClientCredential ->
    PackageName ->
    Either UrlFormationError Request
simpleIndexRequestUnder :: BaseRequest
-> Maybe ClientCredential
-> PackageName
-> Either UrlFormationError Request
simpleIndexRequestUnder BaseRequest
base Maybe ClientCredential
credential PackageName
name = Maybe ClientCredential -> Request -> Request
indexGet Maybe ClientCredential
credential (Request -> Request)
-> Either UrlFormationError Request
-> Either UrlFormationError Request
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> BaseRequest -> Text -> Either UrlFormationError Request
requestAt BaseRequest
base (PackageName -> Text
indexPath PackageName
name)

indexGet :: Maybe ClientCredential -> Request -> Request
indexGet :: Maybe ClientCredential -> Request -> Request
indexGet Maybe ClientCredential
credential = CredentialMapping
-> Maybe ClientCredential -> ByteString -> Request -> Request
Request.metadataGet CredentialMapping
pypiCredential Maybe ClientCredential
credential ByteString
simpleIndexMediaType

-- | Fetch @{baseUrl}/simple/{canonical-name}/{filename}@ from a private index.
artifactRequestByFile ::
    Text ->
    Maybe ClientCredential ->
    PackageName ->
    Text ->
    Either UrlFormationError Request
artifactRequestByFile :: Text
-> Maybe ClientCredential
-> PackageName
-> Text
-> Either UrlFormationError Request
artifactRequestByFile Text
baseUrl Maybe ClientCredential
credential PackageName
name Text
filename = do
    url <- Text -> PackageName -> Text -> Either UrlFormationError Text
artifactFileUrl Text
baseUrl PackageName
name Text
filename
    artifactRequestByUrl credential url

-- | Fetch the preserved @files[].url@ under PyPI's credential presentation.
artifactRequestByUrl ::
    Maybe ClientCredential ->
    Text ->
    Either UrlFormationError Request
artifactRequestByUrl :: Maybe ClientCredential -> Text -> Either UrlFormationError Request
artifactRequestByUrl = CredentialMapping
-> Maybe ClientCredential
-> Text
-> Either UrlFormationError Request
Request.artifactRequestByUrl CredentialMapping
pypiCredential

-- | The Simple-index URL @{baseUrl}\/simple\/{canonical-name}\/@.
simpleIndexUrl :: Text -> PackageName -> Either UrlFormationError Text
simpleIndexUrl :: Text -> PackageName -> Either UrlFormationError Text
simpleIndexUrl Text
baseUrl PackageName
name = Text -> Text -> Either UrlFormationError Text
joinPath Text
baseUrl (PackageName -> Text
indexPath PackageName
name)

indexPath :: PackageName -> Text
indexPath :: PackageName -> Text
indexPath PackageName
name = Text -> Text
projectPath (PackageName -> Text
canonicalName PackageName
name) Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/"

-- | The artifact URL @{baseUrl}\/simple\/{canonical-name}\/{encoded-filename}@.
artifactFileUrl :: Text -> PackageName -> Text -> Either UrlFormationError Text
artifactFileUrl :: Text -> PackageName -> Text -> Either UrlFormationError Text
artifactFileUrl Text
baseUrl PackageName
name Text
filename = Text -> Text -> Either UrlFormationError Text
joinPath Text
baseUrl (Text -> Text -> Text
artifactPath (PackageName -> Text
canonicalName PackageName
name) Text
filename)

-- | Encode each component of @simple/{canonical-project}/{file}@ relative to the index root.
artifactPath :: Text -> Text -> Text
artifactPath :: Text -> Text -> Text
artifactPath Text
project Text
filename = Text -> Text
projectPath Text
project Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text -> Text
encodeComponent Text
filename

projectPath :: Text -> Text
projectPath :: Text -> Text
projectPath Text
project = Text
"simple/" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text -> Text
encodeComponent Text
project