diff --git a/Network/Mom/Stompl/Parser.hs b/Network/Mom/Stompl/Parser.hs --- a/Network/Mom/Stompl/Parser.hs +++ b/Network/Mom/Stompl/Parser.hs @@ -14,8 +14,8 @@ ) where - import Data.Attoparsec hiding (take, takeWhile, takeTill) - import qualified Data.Attoparsec as A (takeWhile, takeTill) + import Data.Attoparsec.ByteString hiding (take, takeWhile, takeTill) + import qualified Data.Attoparsec.ByteString as A (takeWhile, takeTill) import qualified Data.ByteString as B import qualified Data.ByteString.UTF8 as U import Data.Word diff --git a/changelog.md b/changelog.md new file mode 100644 --- /dev/null +++ b/changelog.md @@ -0,0 +1,56 @@ +__0.3.0__ State Linkage Exception in license + +__0.2.0__ The mime package (Codec.MIME) switched from String + to Text in 0.4. We follow. Thanks, Dave! + +__0.1.1__ Dependency for bytestring set to 0.10 + + +__0.1.0__ Major changes: + + - Compliance with Stomp 1.2: + + - header keys and values are now escaped; + this, in fact, was missing for Stomp 1.1. + + - header keys and values are not trimmed or padded; + this, as well, should have been done for Stomp 1.1 already. + Be aware that Stomp 1.0-like message headers + may fail now, *e.g.*: + *message : hello world* + is not the same anymore as + *message:hello world* + + - carriage return (ascii 13) plus line feed (ascii 10) + is now accepted as end-of-line; + note that stompl never generates carriage return as end-of-line, + the standard end-of-line remains line feed. + + - the Message frame may have an *ack* header + and should have when a message is sent + through a queue that requires explicit ack. + + - the mandatory header in the Ack frame is now *id* + instead of *message-id*. It should correspond to *ack* + in the message that is ack'd. + Note that, to ease backward compatibility, + Ack frames are generated with both: + an *id* and a *message-id* header. + + - a Stomp frame was added. + The Stomp frame has exactly the same format + as the Connect frame, but it is handled differently + with respect to escaping: Connect header keys and values + are not escaped, Stomp header keys and values, however, are. + +__0.0.3__ Major changes: + + - new attribute "ClientId" in Connect frame + for compatibility with ActiveMQ; + + - all commands accept additional headers + to ease adaptations to broker-specific features. + +__0.0.2__ Minor corrections and documentation + +__0.0.1__ Initial Release diff --git a/license/lgpl-3.0.txt b/license/lgpl-3.0.txt deleted file mode 100644 --- a/license/lgpl-3.0.txt +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/license/lgpl-3.0ex.txt b/license/lgpl-3.0ex.txt new file mode 100644 --- /dev/null +++ b/license/lgpl-3.0ex.txt @@ -0,0 +1,185 @@ +These library and tools were written by and are copyrighted to + (c) copyright 2011-2015 Tobias Schoofs + +The library is licensed under the terms of the GNU Lesser +General Public Licence (LGPL), which follows below, +with the special exception ("static linking exception"): + +---- +As a relaxation of clause 4 of the LGPL, the copyright holder +adds a third option under 4d) + +2) Link the library statically. +---- + +This library and toolset is distributed in the hope that it will be +useful, but WITHOUT ANY WARRANTY; without even the implied warranty +of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Licences for more details. + + + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/stompl.cabal b/stompl.cabal --- a/stompl.cabal +++ b/stompl.cabal @@ -1,15 +1,16 @@ Name: stompl Category: Message-Oriented Middleware, Network, Stomp, Parser -Version: 0.2.0 +Version: 0.3.0 Cabal-Version: >= 1.8 -Copyright: Copyright (c) Tobias Schoofs, 2011 - 2014 +Copyright: Copyright (c) Tobias Schoofs, 2011 - 2015 License: LGPL -license-file: license/lgpl-3.0.txt +license-file: license/lgpl-3.0ex.txt Author: Tobias Schoofs Maintainer: tobias dot schoofs at gmx dot net Homepage: http://github.com/toschoo/mom Synopsis: Stomp Parser and Utilities Build-Type: Simple +extra-source-files: changelog.md Description: The Stomp Protocol specifies message-oriented interoperability. Applications connect to a message broker to send (publish) @@ -32,94 +33,6 @@ . The Stomp specification can be found at . - - . - - Release History: - - . - - [0.2.0] The mime package (Codec.MIME) switch from String - to Text in 0.4. We follow. Thanks, Dave! - - . - - [0.1.1] Dependency for bytestring set to 0.10 - - . - - [0.1.0] Major changes: - - . - - - Compliance with Stomp 1.2: - - . - - - header keys and values are now escaped; - this, in fact, was missing for Stomp 1.1. - - . - - - header keys and values are not trimmed or padded; - this, as well, should have been done for Stomp 1.1 already. - Be aware that Stomp 1.0-like message headers - may fail now, /e.g./: - /message : hello world/ - is not the same anymore as - /message:hello world/ - - . - - - carriage return (ascii 13) plus line feed (ascii 10) - is now accepted as end-of-line; - note that stompl never generates carriage return as end-of-line, - the standard end-of-line remains line feed. - - . - - - the Message frame may have an /ack/ header - and should have when a message is sent - through a queue that requires explicit ack. - - . - - - the mandatory header in the Ack frame is now /id/ - instead of /message-id/. It should correspond to /ack/ - in the message that is ack'd. - Note that, to ease backward compatibility, - Ack frames are generated with both: - an /id/ and a /message-id/ header. - - . - - - a Stomp frame was added. - The Stomp frame has exactly the same format - as the Connect frame, but it is handled differently - with respect to escaping: Connect header keys and values - are not escaped, Stomp header keys and values, however, are. - - . - - [0.0.3] Major changes: - - . - - - new attribute "ClientId" in Connect frame - for compatibility with ActiveMQ; - - . - - - all commands accept additional headers - to ease adaptations to broker-specific features. - - . - - [0.0.2] Minor corrections and documentation - - . - - [0.0.1] Initial Release Library Build-Depends: base >= 4.0 && < 5.0,