addToStore to S3 and local binary cache

cabal.project

@@ -1 +1 @@
-packages: ./hnix-store-core/*.cabal ./hnix-store-remote/*.cabal
+packages: ./hnix-store-core/*.cabal ./hnix-store-remote/*.cabal ./hnix-store-binary/*.cabal ./hnix-store-s3/*.cabal

hnix-store-binary/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Brian McKenna.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hnix-store-binary/Setup.hs

@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain

hnix-store-binary/hnix-store-binary.cabal

@@ -0,0 +1,33 @@
+name:                hnix-store-binary
+version:             0.1.0.0
+synopsis:            Binary hnix store API
+description:
+homepage:            https://github.com/haskell-nix/hnix-store
+license:             Apache-2.0
+license-file:        LICENSE
+author:              Brian McKenna
+maintainer:          [email protected]
+copyright:           2019 Brian McKenna
+category:            System
+build-type:          Simple
+extra-source-files:  ChangeLog.md, README.md
+cabal-version:       >=1.10
+
+library
+  exposed-modules:     System.Nix.Store.Binary
+                     , System.Nix.Store.Binary.Local
+
+  build-depends:       base >=4.10 && <4.12
+                     , binary
+                     , bytestring
+                     , directory
+                     , filepath
+                     , lzma
+                     , mtl
+                     , text
+                     , time
+                     , unordered-containers
+                     , hnix-store-core
+  hs-source-dirs:      src
+  default-language:    Haskell2010
+  ghc-options:         -Wall

hnix-store-binary/shell.nix

@@ -0,0 +1 @@
+(import ../shell.nix).hnix-store-binary

hnix-store-binary/src/System/Nix/Store/Binary.hs

@@ -0,0 +1,93 @@
+{-|
+Description : Interact with a binary Nix store.
+Maintainer  : Brian McKenna <[email protected]>
+-}
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TypeApplications #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+module System.Nix.Store.Binary (
+  BinaryStoreEffects(..)
+, addToStore
+) where
+
+import Codec.Compression.Lzma (compress)
+import Control.Monad.Trans (MonadIO(..))
+import Data.Text (Text)
+import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
+import System.Nix.Hash
+import System.Nix.Nar
+import System.Nix.StorePath
+import System.Nix.StorePathMetadata
+import qualified Data.Binary.Put as B
+import qualified Data.ByteString as BS
+import qualified Data.ByteString.Lazy as LBS
+import qualified Data.HashSet as HS
+import qualified Data.Text.Encoding as E
+import System.Nix.ReadonlyStore
+
+data BinaryStoreEffects m =
+  BinaryStoreEffects
+    { upsertFile :: Text -> BS.ByteString -> Text -> m ()
+    }
+
+narInfoFileFor
+  :: StorePath storeDir
+  -> Text
+narInfoFileFor p =
+  encodeBase32 (storePathHash p) <> ".narinfo"
+
+addToStore
+  :: forall storeDir m. (MonadIO m, KnownStoreDir storeDir)
+  => StorePathName
+  -> FilePath
+  -> NarHashMode
+  -> BinaryStoreEffects m
+  -> m (StorePath storeDir)
+addToStore name pth narHashMode bse = do
+  let
+    dump = LBS.toStrict . B.runPut . putNar
+    dumpString s = dump . Nar $ Regular NonExecutable (fromIntegral $ LBS.length s) s
+    dumpPath = liftIO . (dump <$>) . localPackNar narEffectsIO
+
+  (nar, h) <-
+    case narHashMode of
+      Recursive -> do
+        bs <- dumpPath pth
+        let h = hash @'SHA256 bs
+        pure (bs, h)
+      RegularFile -> do
+        s <- liftIO $ LBS.readFile pth
+        let
+          bs = dumpString s
+          h = hash @'SHA256 bs
+        pure (bs, h)
+
+  let
+    pth' = makeFixedOutputPath @storeDir narHashMode h name
+    narCompressed = LBS.toStrict . compress $ LBS.fromStrict nar
+    fileHash' = hash @'SHA256 narCompressed
+    url = "nar/" <> encodeBase32 fileHash' <> ".nar.xz"
+    storePathMetadata =
+      StorePathMetadata
+        pth'
+        Nothing
+        (SomeDigest $ hash @'SHA256 nar)
+        HS.empty
+        (posixSecondsToUTCTime 0)
+        (Just . fromIntegral $ BS.length nar)
+        BuiltElsewhere
+        mempty
+        (Just . Fixed narHashMode $ SomeDigest h)
+    narInfo =
+      NarInfo
+        url
+        "xz"
+        (SomeDigest fileHash')
+        (Just . fromIntegral $ BS.length narCompressed)
+
+  upsertFile bse url narCompressed "application/x-nix-nar"
+  upsertFile bse (narInfoFileFor pth') (E.encodeUtf8 $ encodeNarInfo storePathMetadata narInfo) "text/x-nix-narinfo"
+
+  pure pth'

hnix-store-binary/src/System/Nix/Store/Binary/Local.hs

@@ -0,0 +1,26 @@
+{-|
+Description : Interact with a local binary Nix store.
+Maintainer  : Brian McKenna <[email protected]>
+-}
+module System.Nix.Store.Binary.Local (
+  localBinaryStoreEffects
+) where
+
+import Control.Monad.Trans (MonadIO(..))
+import System.Directory
+import System.FilePath
+import System.Nix.Store.Binary
+import qualified Data.ByteString as BS
+import qualified Data.Text as T
+
+localBinaryStoreEffects
+  :: (MonadIO m)
+  => FilePath
+  -> BinaryStoreEffects m
+localBinaryStoreEffects cacheDir =
+  BinaryStoreEffects upsertFile'
+  where
+    upsertFile' pth d _ = liftIO $ do
+      let pth' = cacheDir </> T.unpack pth
+      createDirectoryIfMissing True $ takeDirectory pth'
+      BS.writeFile pth' d

hnix-store-core/src/System/Nix/Hash.hs

@@ -13,6 +13,7 @@ module System.Nix.Hash (
 
   , HNix.encodeBase32
   , HNix.encodeBase16
+  , HNix.encodeSomeDigest
   ) where
 
 import qualified System.Nix.Internal.Hash as HNix

hnix-store-core/src/System/Nix/Internal/Hash.hs

@@ -103,6 +103,16 @@ encodeBase32 (Digest bs) = Base32.encode bs
 encodeBase16 :: Digest a -> T.Text
 encodeBase16 (Digest bs) = T.decodeUtf8 (Base16.encode bs)
 
+-- | Encode a 'Digest' in algorithm:hash format.
+encodeDigest :: forall a. NamedAlgo a => Digest a -> Text
+encodeDigest d =
+  algoName @a <> ":" <> encodeBase16 d
+
+-- | Encode a 'Digest' in algorithm:hash format.
+encodeSomeDigest :: SomeNamedDigest -> Text
+encodeSomeDigest (SomeDigest d) =
+  encodeDigest d
+
 -- | Uses "Crypto.Hash.MD5" from cryptohash-md5.
 instance ValidAlgo 'MD5 where
   type AlgoCtx 'MD5 = MD5.Ctx