Hide progress module

1 files changed, 0 insertions, 155 deletions

diff --git a/src/Data/Torrent/Progress.hs b/src/Data/Torrent/Progress.hs
deleted file mode 100644
index 4719020a..00000000
--- a/src/Data/Torrent/Progress.hs
+++ /dev/null
@@ -1,155 +0,0 @@
--- |
---   Copyright   :  (c) Sam Truzjan 2013
---   License     :  BSD3
---   Maintainer  :  pxqr.sta@gmail.com
---   Stability   :  experimental
---   Portability :  portable
---
---   'Progress' used to track amount downloaded\/left\/upload bytes
---   either on per client or per torrent basis. This value is used to
---   notify the tracker and usually shown to the user. To aggregate
---   total progress you can use the Monoid instance.
---
-{-# LANGUAGE TemplateHaskell #-}
-{-# LANGUAGE ViewPatterns    #-}
-{-# OPTIONS -fno-warn-orphans #-}
-module Data.Torrent.Progress
-       ( -- * Progress
-         Progress (..)
-
-         -- * Lens
-       , left
-       , uploaded
-       , downloaded
-
-         -- * Construction
-       , startProgress
-       , downloadedProgress
-       , enqueuedProgress
-       , uploadedProgress
-       , dequeuedProgress
-
-         -- * Query
-       , canDownload
-       , canUpload
-       ) where
-
-import Control.Applicative
-import Control.Lens hiding ((%=))
-import Data.ByteString.Lazy.Builder  as BS
-import Data.ByteString.Lazy.Builder.ASCII as BS
-import Data.Default
-import Data.List as L
-import Data.Monoid
-import Data.Serialize as S
-import Data.Ratio
-import Data.Word
-import Network.HTTP.Types.QueryLike
-import Text.PrettyPrint as PP
-import Text.PrettyPrint.Class
-
-
--- | Progress data is considered as dynamic within one client
--- session. This data also should be shared across client application
--- sessions (e.g. files), otherwise use 'startProgress' to get initial
--- 'Progress' value.
---
-data Progress = Progress
-  { _downloaded :: {-# UNPACK #-} !Word64 -- ^ Total amount of bytes downloaded;
-  , _left       :: {-# UNPACK #-} !Word64 -- ^ Total amount of bytes left;
-  , _uploaded   :: {-# UNPACK #-} !Word64 -- ^ Total amount of bytes uploaded.
-  } deriving (Show, Read, Eq)
-
-$(makeLenses ''Progress)
-
--- | UDP tracker compatible encoding.
-instance Serialize Progress where
-  put Progress {..} = do
-    putWord64be $ fromIntegral _downloaded
-    putWord64be $ fromIntegral _left
-    putWord64be $ fromIntegral _uploaded
-
-  get = Progress
-    <$> (fromIntegral <$> getWord64be)
-    <*> (fromIntegral <$> getWord64be)
-    <*> (fromIntegral <$> getWord64be)
-
-instance Default Progress where
-  def = Progress 0 0 0
-  {-# INLINE def #-}
-
--- | Can be used to aggregate total progress.
-instance Monoid Progress where
-  mempty  = def
-  {-# INLINE mempty #-}
-
-  mappend (Progress da la ua) (Progress db lb ub) = Progress
-    { _downloaded = da + db
-    , _left       = la + lb
-    , _uploaded   = ua + ub
-    }
-  {-# INLINE mappend #-}
-
-instance QueryValueLike Builder where
-  toQueryValue = toQueryValue . BS.toLazyByteString
-
-instance QueryValueLike Word64 where
-  toQueryValue = toQueryValue . BS.word64Dec
-
--- | HTTP Tracker protocol compatible encoding.
-instance QueryLike Progress where
-  toQuery Progress {..} =
-    [ ("uploaded"  , toQueryValue _uploaded)
-    , ("left"      , toQueryValue _left)
-    , ("downloaded", toQueryValue _downloaded)
-    ]
-
-instance Pretty Progress where
-  pretty Progress {..} =
-    "/\\"  <+> PP.text (show _uploaded)   $$
-    "\\/"  <+> PP.text (show _downloaded) $$
-    "left" <+> PP.text (show _left)
-
--- | Initial progress is used when there are no session before.
---
--- Please note that tracker might penalize client some way if the do
--- not accumulate progress. If possible and save 'Progress' between
--- client sessions to avoid that.
---
-startProgress :: Integer -> Progress
-startProgress = Progress 0 0 . fromIntegral
-{-# INLINE startProgress #-}
-
--- | Used when the client download some data from /any/ peer.
-downloadedProgress :: Int -> Progress -> Progress
-downloadedProgress (fromIntegral -> amount)
-                 = (left         -~ amount)
-                 . (downloaded   +~ amount)
-{-# INLINE downloadedProgress #-}
-
--- | Used when the client upload some data to /any/ peer.
-uploadedProgress :: Int -> Progress -> Progress
-uploadedProgress (fromIntegral -> amount) = uploaded +~ amount
-{-# INLINE uploadedProgress #-}
-
--- | Used when leecher join client session.
-enqueuedProgress :: Integer -> Progress -> Progress
-enqueuedProgress amount = left +~ fromIntegral amount
-{-# INLINE enqueuedProgress #-}
-
--- | Used when leecher leave client session.
---   (e.g. user deletes not completed torrent)
-dequeuedProgress :: Integer -> Progress -> Progress
-dequeuedProgress amount = left -~ fromIntegral amount
-{-# INLINE dequeuedProgress #-}
-
-ri2rw64 :: Ratio Int -> Ratio Word64
-ri2rw64 x = fromIntegral (numerator x) % fromIntegral (denominator x)
-
--- | Check global /download/ limit by uploaded \/ downloaded ratio.
-canDownload :: Ratio Int -> Progress -> Bool
-canDownload limit Progress {..} = _uploaded % _downloaded > ri2rw64 limit
-
--- | Check global /upload/ limit by downloaded \/ uploaded ratio.
-canUpload :: Ratio Int -> Progress -> Bool
-canUpload limit Progress {..} = _downloaded % _uploaded > ri2rw64 limit