slackbuilder/lib/SlackBuilder/Package.hs

86 lines
2.6 KiB
Haskell
Raw Normal View History

2023-12-23 22:15:10 +01:00
{- This Source Code Form is subject to the terms of the Mozilla Public License,
v. 2.0. If a copy of the MPL was not distributed with this file, You can
obtain one at https://mozilla.org/MPL/2.0/. -}
-- | Contains data describing packages and how they are should be updated,
2023-08-28 21:05:47 +02:00
module SlackBuilder.Package
( DownloadPlaceholder(..)
, Download(..)
2023-09-03 10:26:43 +02:00
, DownloadTemplate(..)
, PackageDescription(..)
, PackageUpdateData(..)
2023-08-28 21:05:47 +02:00
, Maintainer(..)
, Updater(..)
2023-09-03 10:26:43 +02:00
, renderDownloadWithVersion
2023-08-28 21:05:47 +02:00
) where
2023-09-03 10:26:43 +02:00
import Data.List.NonEmpty (NonEmpty(..))
2023-08-28 21:05:47 +02:00
import Data.Text (Text)
import qualified Data.Text as Text
import Text.URI (URI(..))
import qualified Text.URI as URI
import Crypto.Hash (Digest, MD5)
import SlackBuilder.Trans
2023-09-03 10:26:43 +02:00
import Control.Monad.Catch (MonadThrow)
import Data.Map (Map)
2023-08-28 21:05:47 +02:00
2023-10-05 19:24:42 +02:00
-- | Contains information how a package can be updated.
data PackageDescription = PackageDescription
2023-10-05 19:24:42 +02:00
{ latest :: Updater
, downloaders :: Map Text Updater
2023-10-05 19:24:42 +02:00
, name :: Text
}
data PackageUpdateData = PackageUpdateData
{ description :: PackageDescription
, category :: Text
, version :: Text
}
2023-08-28 21:05:47 +02:00
-- | Download URI with the MD5 checksum of the target.
data Download = Download
{ download :: URI
, md5sum :: Digest MD5
} deriving (Eq, Show)
-- | Package maintainer information.
data Maintainer = Maintainer
{ name :: Text
, email :: Text
} deriving (Eq, Show)
-- | Appears in the download URI template and specifies which part of the URI
-- should be replaced with the package version.
data DownloadPlaceholder
= StaticPlaceholder Text
| VersionPlaceholder
deriving Eq
instance Show DownloadPlaceholder
where
show (StaticPlaceholder staticPlaceholder) = Text.unpack staticPlaceholder
show VersionPlaceholder = "{version}"
-- | List of URI components, including version placeholders.
newtype DownloadTemplate = DownloadTemplate (NonEmpty DownloadPlaceholder)
deriving Eq
instance Show DownloadTemplate
where
show (DownloadTemplate components) = concatMap show components
-- | Replaces placeholders in the URL template with the given version.
2023-09-03 10:26:43 +02:00
renderDownloadWithVersion :: MonadThrow m => DownloadTemplate -> Text -> m URI
renderDownloadWithVersion (DownloadTemplate components) version =
URI.mkURI $ foldr f "" components
where
f (StaticPlaceholder staticPlaceholder) = (staticPlaceholder <>)
f VersionPlaceholder = (version <>)
2023-09-03 10:26:43 +02:00
2023-08-28 21:05:47 +02:00
-- | Function used to get the latest version of a source.
data Updater = Updater
{ detectLatest :: SlackBuilderT (Maybe Text)
2024-01-19 09:57:58 +01:00
, is64 :: Bool
, getVersion :: Text -> Text -> SlackBuilderT Download
}