diff --git a/AUTHORS b/AUTHORS new file mode 100644 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,1 @@ +fr33domlover diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/ChangeLog b/ChangeLog new file mode 100644 --- /dev/null +++ b/ChangeLog @@ -0,0 +1,17 @@ +The changes are recorded by the version control system, Darcs. To see a log +quickly from the terminal, run: + + $ darcs changes --repo http://hub.darcs.net/fr33domlover/monad-connect + +There is also a web interface at which, among other +things, can display the history log. + +To see the log in a local clone, first get a copy of the repository if you +haven't yet: + + $ darcs get http://hub.darcs.net/fr33domlover/monad-connect + +Then move into the newly created directory and run darcs: + + $ cd monad-connect + $ darcs changes diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,12 @@ +Install from Hackage/Stackage: + + $ stack install monad-connect + +Install from unpacked release tarball or source repo: + + $ cd monad-connect + $ stack install + +Just play with it without installing: + + $ stack repl diff --git a/NEWS.md b/NEWS.md new file mode 100644 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,23 @@ +This file lists the user-visible interesting changes between releases. For a +full list of changes to the source, see the ChangeLog. + + + +monad-connect 0.1 2016-03-16 +=================================== + +General, build and documentation changes: + +* (This is the first release, so everything is new) + +New APIs, features and enhancements: + +* (This is the first release, so everything is a new feature) + +Bug fixes: + +* (This is just the first release, many bugs haven't been discovered yet) + +Dependency changes: + +* (This is the first release) diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +See the .cabal file for more info and link to project website the version +control. + +The official download location is Hackage: + + + +This library is free software, and is committed to software freedom. It is +released to the public domain using the CC0 Public Domain Dedication. For the +boring "legal" details see the file 'COPYING'. + +See the file 'INSTALL' for hints on installation. The file 'ChangeLog' explains +how to see the history log of the changes done in the code. 'NEWS' provides a +friendly overview of the changes for each release. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/monad-connect.cabal b/monad-connect.cabal new file mode 100644 --- /dev/null +++ b/monad-connect.cabal @@ -0,0 +1,47 @@ +name: monad-connect +version: 0.1 +cabal-version: >=1.10 +build-type: Simple +license: PublicDomain +license-file: COPYING +copyright: ♡ Copying is an act of love. Please copy, reuse and share. +maintainer: fr33domlover@riseup.net +homepage: http://hub.darcs.net/fr33domlover/monad-connect +bug-reports: mailto:fr33domlover@riseup.net +synopsis: Transformer for TCP connection with TLS and SOCKS support +description: + This library is a basic monadic wrapper over the @connection@ package. It + provides a monad transformer which gives your monad stack the ability to + maintain a single TCP connection, possibly over TLS and/or SOCKS. + . + This is very convenient for simple client applications which connect to a + single server, but it is /not/ enough for robust applications which want to + automatically reconnect on errors. In the latter case, a reconnection and + error handling layer can be added on top of the simple transformer provided + here. +category: Control, Monad, Network +author: fr33domlover +extra-source-files: + AUTHORS + ChangeLog + COPYING + INSTALL.md + NEWS.md + README.md + +source-repository head + type: darcs + location: http://hub.darcs.net/fr33domlover/monad-connect + +library + exposed-modules: + Control.Monad.Trans.Connect + build-depends: + base >=4.8 && <5, + bytestring >=0.10.6.0, + connection >=0.2.5, + exceptions >=0.8.2.1, + transformers >=0.4.2.0 + default-language: Haskell2010 + hs-source-dirs: src + diff --git a/src/Control/Monad/Trans/Connect.hs b/src/Control/Monad/Trans/Connect.hs new file mode 100644 --- /dev/null +++ b/src/Control/Monad/Trans/Connect.hs @@ -0,0 +1,189 @@ +{- This file is part of monad-connect. + - + - Written in 2016 by fr33domlover . + - + - ♡ Copying is an act of love. Please copy, reuse and share. + - + - The author(s) have dedicated all copyright and related and neighboring + - rights to this software to the public domain worldwide. This software is + - distributed without any warranty. + - + - You should have received a copy of the CC0 Public Domain Dedication along + - with this software. If not, see + - . + -} + +{-# LANGUAGE GeneralizedNewtypeDeriving #-} + +-- | Simple monad transformer allowing your monad stack to manage a single TCP +-- connection, optionally over TLS and\/or SOCKS. +module Control.Monad.Trans.Connect + ( -- * Connect and disconnect + ConnectT () + , runConnectT + , runConnectTWithCtx + , connClose + -- * Receive data + , connGetSome + , connGetChunk + , connGetChunk' + , connGetLine + -- * Send data + , connPut + -- * TLS + , connSetSecure + , connSetSecureWithCtx + , connIsSecure + ) +where + +import Control.Monad.Catch +import Control.Monad.Fix (MonadFix) +import Control.Monad.IO.Class +import Control.Monad.Trans.Class (MonadTrans) +import Control.Monad.Trans.Reader +import Data.ByteString (ByteString) + +import qualified Network.Connection as NC + +--------------TODO TODO TODO careful exception handling, especially to allow +--------------continuing with the same monadic computation after recovery + + +-- | Monad transformer allowing your monad stack to manage a single TCP +-- connection, optionally over TLS and\/or SOCKS. A single 'ConnectT' +-- computation sequence opens a connection, possibly sends and receives data, +-- and finally closes it. +newtype ConnectT m a = ConnectT + { unCT :: ReaderT (NC.ConnectionContext, NC.Connection) m a + } + deriving + ( -- Basics + Functor + , Applicative + , Monad + -- Extra monads from base + , MonadFix + -- Network operations are IO + , MonadIO + -- This is a transformer after all + , MonadTrans + -- Exceptions + , MonadCatch + , MonadThrow + , MonadMask + ) + +-- | Execute a computation which has a network connection available to it. If +-- an exception is thrown (e.g. due to network error) and the computation +-- doesn't catch it, the connection is closed and the exception is rethrown. +runConnectT + :: (MonadIO m, MonadMask m) + => ConnectT m a + -- ^ The computation + -> NC.ConnectionParams + -- ^ Network connection details + -> Bool + -- ^ Whether to close the connection if the computation finishes without + -- errors (the connection is always closed in case of error unless you + -- catch the error and handle it your way). + -> m a +runConnectT act params close = do + ctx <- liftIO NC.initConnectionContext + runConnectTWithCtx act ctx params close + +-- | A variant of 'runConnectT' which takes an existing 'NC.ConnectionContext' +-- instead of initializing a new one. This is useful if you want to start +-- several connections (in which case you can share a single context between +-- them). +runConnectTWithCtx + :: (MonadIO m, MonadMask m) + => ConnectT m a + -> NC.ConnectionContext + -> NC.ConnectionParams + -> Bool + -> m a +runConnectTWithCtx act ctx params close = + (if close then bracket else bracketOnError) + (liftIO $ NC.connectTo ctx params) + (liftIO . NC.connectionClose) + (\ conn -> runReaderT (unCT act) (ctx, conn)) + +askConn :: Monad m => ConnectT m NC.Connection +askConn = snd <$> ConnectT ask + +askCtx :: Monad m => ConnectT m NC.ConnectionContext +askCtx = fst <$> ConnectT ask + +-- | Close a connection. After you do that, don't use the connection. If the +-- connection is already closed, for a plain TCP connection this currently does +-- nothing. But when using TLS, it assumes the connection is still open. So to +-- be safe, don't use this more than once. +-- +-- If you asked for the connection to be closed after a succesful computation +-- (i.e. passed 'True' to 'runConnectT'), then the connection will be closed +-- for you and calling this function is unnecessary (and possibly unsafe). +connClose :: MonadIO m => ConnectT m () +connClose = askConn >>= liftIO . NC.connectionClose + +-- | Wait until there is data to read from the connection, and return it. The +-- parameter specifies the maximal number of bytes to read. Less than that can +-- be returned, depending on how much data was available. +-- +-- On end of input, an empty bytestring is returned, but subsequent calls will +-- throw an @isEOFError@ exception. +connGetSome :: MonadIO m => Int -> ConnectT m ByteString +connGetSome maxlen = askConn >>= liftIO . flip NC.connectionGet maxlen + +-- | Get the next block of data from the connection. +connGetChunk :: MonadIO m => ConnectT m ByteString +connGetChunk = askConn >>= liftIO . NC.connectionGetChunk + +-- | Like 'connGetChunk', but return the unused portion to the buffer, where it +-- will be the next chunk read. +connGetChunk' :: MonadIO m => (ByteString -> (a, ByteString)) -> ConnectT m a +connGetChunk' f = askConn >>= liftIO . flip NC.connectionGetChunk' f + +-- | Get the next line, using ASCII LF (@'\n'@) as the line terminator. +-- +-- This throws an @isEOFError@ exception on end of input, and 'NC.LineTooLong' +-- when the number of bytes gathered is over the limit without a line +-- terminator. +-- +-- The actual line returned can be bigger than the limit specified, provided +-- that the last chunk returned by the underlaying backend contains a LF. +-- +-- An end of file will be considered as a line terminator too, if the line is +-- not empty. +connGetLine :: MonadIO m => Int -> ConnectT m ByteString +connGetLine maxlen = askConn >>= liftIO . NC.connectionGetLine maxlen + +-- | Send a block of data over the connection. +connPut :: MonadIO m => ByteString -> ConnectT m () +connPut s = askConn >>= liftIO . flip NC.connectionPut s + +-- | Activate secure layer using the parameters specified. +-- +-- This is typically used to negociate a TLS channel on an already establish +-- channel, e.g. supporting a STARTTLS command. It also flushes the received +-- buffer to prevent application from confusing received data before and after +-- the setSecure call. +-- +-- If the connection is already using TLS, nothing else happens. +connSetSecure :: MonadIO m => NC.TLSSettings -> ConnectT m () +connSetSecure tlss = askCtx >>= flip connSetSecureWithCtx tlss + +-- | Like 'connSetSecure', but uses the supplied 'NC.ConnectionContext' instead +-- of using the same one which was used when opening the connection. +connSetSecureWithCtx + :: MonadIO m + => NC.ConnectionContext + -> NC.TLSSettings + -> ConnectT m () +connSetSecureWithCtx ctx tlss = do + conn <- askConn + liftIO $ NC.connectionSetSecure ctx conn tlss + +-- | Check whether the connection is established securely (using TLS). +connIsSecure :: MonadIO m => ConnectT m Bool +connIsSecure = askConn >>= liftIO . NC.connectionIsSecure