diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,340 +1,26 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program 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 General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. - , 1 April 1989 - Ty Coon, President of Vice + * The names of its contributors may not be used to endorse or promote + products derived from this software without specific prior written + permission. -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS +IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER +OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README b/README new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,51 @@ +Parsers for the Internet Message Standard +========================================= + +:Latest Release: hsemail-1.2.tar.gz_ +:Darcs: darcs_ get --partial http://cryp.to/hsemail/ + +Synopsis +-------- + + This package contains Parsec_ combinators for the syntax of + Internet messages, such as e-mail, news articles, namely + RFC2234, RFC2821, and RFC2822. + + The ``example`` directory contains two small programs that can + be run as follows:: + + $ runhaskell message-test.hs . All rights + reserved. This software is released under `BSD-style license + `_. + +----------------------------------------------------------------- + +`[Homepage] `_ + +.. _Parsec: http://www.cs.uu.nl/people/daan/parsec.html + +.. _darcs: http://abridgegame.org/darcs/ + +.. _hsemail-1.2.tar.gz: http://cryp.to/hsemail/hsemail-1.2.tar.gz + +.. _Reference Documentation: docs/index.html + +.. _librfc2822: http://cryp.to/librfc2822/ diff --git a/Setup.hs b/Setup.hs deleted file mode 100644 --- a/Setup.hs +++ /dev/null @@ -1,5 +0,0 @@ -#!/usr/bin/runhaskell - -import Distribution.Simple - -main = defaultMainWithHooks defaultUserHooks diff --git a/Setup.lhs b/Setup.lhs new file mode 100644 --- /dev/null +++ b/Setup.lhs @@ -0,0 +1,8 @@ +#!/usr/bin/env runhaskell + +> module Main (main) where +> +> import Distribution.Simple +> +> main :: IO () +> main = defaultMain diff --git a/Text/ParserCombinators/Parsec/Rfc2234.hs b/Text/ParserCombinators/Parsec/Rfc2234.hs --- a/Text/ParserCombinators/Parsec/Rfc2234.hs +++ b/Text/ParserCombinators/Parsec/Rfc2234.hs @@ -1,7 +1,7 @@ {- | Module : Text.ParserCombinators.Parsec.Rfc2234 - Copyright : (c) 2005-02-10 by Peter Simons - License : GPL2 + Copyright : (c) 2008 Peter Simons + License : BSD3 Maintainer : simons@cryp.to Stability : provisional diff --git a/Text/ParserCombinators/Parsec/Rfc2821.hs b/Text/ParserCombinators/Parsec/Rfc2821.hs --- a/Text/ParserCombinators/Parsec/Rfc2821.hs +++ b/Text/ParserCombinators/Parsec/Rfc2821.hs @@ -1,12 +1,11 @@ -{-# OPTIONS -fglasgow-exts #-} {- | Module : Text.ParserCombinators.Parsec.Rfc2821 - Copyright : (c) 2005-04-29 by Peter Simons - License : GPL2 + Copyright : (c) 2008 Peter Simons + License : BSD3 Maintainer : simons@cryp.to Stability : provisional - Portability : Haskell 2-pre + Portability : portable This module exports parser combinators for the grammar described in RFC2821, \"Simple Mail Transfer Protocol\", @@ -21,7 +20,6 @@ import Text.ParserCombinators.Parsec.Error import Data.List ( intersperse ) import Data.Char ( toLower ) -import Data.Typeable import Text.ParserCombinators.Parsec.Rfc2234 ---------------------------------------------------------------------- @@ -35,7 +33,7 @@ | HaveRcptTo | HaveData | HaveQuit - deriving (Enum, Bounded, Eq, Ord, Show, Typeable) + deriving (Enum, Bounded, Eq, Ord, Show) data Event = Greeting -- ^ reserved for the user @@ -186,7 +184,6 @@ -- two mailboxes for equality, the hostname is case-insensitive. data Mailbox = Mailbox [String] String String - deriving (Typeable) instance Eq Mailbox where lhs == rhs = (norm lhs) == (norm rhs) diff --git a/Text/ParserCombinators/Parsec/Rfc2822.hs b/Text/ParserCombinators/Parsec/Rfc2822.hs --- a/Text/ParserCombinators/Parsec/Rfc2822.hs +++ b/Text/ParserCombinators/Parsec/Rfc2822.hs @@ -1,7 +1,7 @@ {- | Module : Text.ParserCombinators.Parsec.Rfc2822 - Copyright : (c) 2005-02-10 by Peter Simons - License : GPL2 + Copyright : (c) 2008 Peter Simons + License : BSD3 Maintainer : simons@cryp.to Stability : provisional @@ -11,23 +11,27 @@ RFC2822, \"Internet Message Format\", . - /Please note:/ The module is a mess. I keep it around as - a reminder that it needs to be rewritten, mostly. - Nevertheless, some parsers -- like 'date_time', for - example -- are genuinely useful. + /Please note:/ The module is not particularly well tested. -} module Text.ParserCombinators.Parsec.Rfc2822 where -import Text.ParserCombinators.Parsec +import System.Time import Data.Char ( ord ) import Data.List ( intersperse ) -import System.Time -import Text.ParserCombinators.Parsec.Rfc2234 - hiding ( quoted_pair, quoted_string ) +import Control.Monad ( liftM ) +import Text.ParserCombinators.Parsec +import Text.ParserCombinators.Parsec.Rfc2234 hiding ( quoted_pair, quoted_string ) -- * Useful parser combinators +-- |Return @Nothing@ if the given parser doesn't match. This +-- combinator is included in the latest parsec distribution as +-- @optionMaybe@, but ghc-6.6.1 apparently doesn't have it. + +maybeOption :: GenParser tok st a -> GenParser tok st (Maybe a) +maybeOption p = option Nothing (liftM Just p) + -- |@unfold@ @=@ @between (optional cfws) (optional cfws)@ unfold :: CharParser a b -> CharParser a b @@ -395,26 +399,35 @@ -- * Address Specification (section 3.4) +-- |A NameAddr is composed of an optional realname a mandatory +-- e-mail 'address'. + +data NameAddr = NameAddr { nameAddr_name :: Maybe String + , nameAddr_addr :: String + } + deriving (Show,Eq) + -- |Parse a single 'mailbox' or an address 'group' and return the -- address(es). -address :: CharParser a [String] +address :: CharParser a [NameAddr] address = try (do { r <- mailbox; return [r] }) <|> group "address" -- |Parse a 'name_addr' or an 'addr_spec' and return the -- address. -mailbox :: CharParser a String -mailbox = try name_addr <|> addr_spec +mailbox :: CharParser a NameAddr +mailbox = try name_addr <|> (addr_spec >>= return . NameAddr Nothing) "mailbox" -- |Parse an 'angle_addr', optionally prefaced with a 'display_name', -- and return the address. -name_addr :: CharParser a String -name_addr = do optional display_name - angle_addr +name_addr :: CharParser a NameAddr +name_addr = do name <- maybeOption display_name + addr <- angle_addr + return (NameAddr name addr) "name address" -- |Parse an 'angle_addr' or an 'obs_angle_addr' and return the address. @@ -439,7 +452,7 @@ -- -- > Right ["user1@example.org","user2@example.org"] -group :: CharParser a [String] +group :: CharParser a [NameAddr] group = do display_name char ':' r <- option [] mailbox_list @@ -449,19 +462,20 @@ -- |Parse and return a 'phrase'. -display_name :: CharParser a [String] -display_name = phrase "display name" +display_name :: CharParser a String +display_name = phrase >>= return . concat . intersperse " " + "display name" -- |Parse a list of 'mailbox' addresses, every two addresses being -- separated by a comma, and return the list of found address(es). -mailbox_list :: CharParser a [String] +mailbox_list :: CharParser a [NameAddr] mailbox_list = sepBy mailbox (char ',') "mailbox list" -- |Parse a list of 'address' addresses, every two addresses being -- separated by a comma, and return the list of found address(es). -address_list :: CharParser a [String] +address_list :: CharParser a [NameAddr] address_list = do { r <-sepBy address (char ','); return (concat r) } "address list" @@ -574,13 +588,13 @@ -- of the corresponding parser. data Field = OptionalField String String - | From [String] - | Sender String + | From [NameAddr] + | Sender NameAddr | ReturnPath String - | ReplyTo [String] - | To [String] - | Cc [String] - | Bcc [String] + | ReplyTo [NameAddr] + | To [NameAddr] + | Cc [NameAddr] + | Bcc [NameAddr] | MessageID String | InReplyTo [String] | References [String] @@ -589,13 +603,13 @@ | Keywords [[String]] | Date CalendarTime | ResentDate CalendarTime - | ResentFrom [String] - | ResentSender String - | ResentTo [String] - | ResentCc [String] - | ResentBcc [String] + | ResentFrom [NameAddr] + | ResentSender NameAddr + | ResentTo [NameAddr] + | ResentCc [NameAddr] + | ResentBcc [NameAddr] | ResentMessageID String - | ResentReplyTo [String] + | ResentReplyTo [NameAddr] | Received ([(String,String)], CalendarTime) | ObsReceived [(String,String)] deriving (Show) @@ -654,19 +668,19 @@ -- |Parse a \"@From:@\" header line and return the 'mailbox_list' -- address(es) contained in it. -from :: CharParser a [String] +from :: CharParser a [NameAddr] from = header "From" mailbox_list -- |Parse a \"@Sender:@\" header line and return the 'mailbox' address -- contained in it. -sender :: CharParser a String +sender :: CharParser a NameAddr sender = header "Sender" mailbox -- |Parse a \"@Reply-To:@\" header line and return the 'address_list' -- address(es) contained in it. -reply_to :: CharParser a [String] +reply_to :: CharParser a [NameAddr] reply_to = header "Reply-To" address_list @@ -675,19 +689,19 @@ -- |Parse a \"@To:@\" header line and return the 'address_list' -- address(es) contained in it. -to :: CharParser a [String] +to :: CharParser a [NameAddr] to = header "To" address_list -- |Parse a \"@Cc:@\" header line and return the 'address_list' -- address(es) contained in it. -cc :: CharParser a [String] +cc :: CharParser a [NameAddr] cc = header "Cc" address_list -- |Parse a \"@Bcc:@\" header line and return the 'address_list' -- address(es) contained in it. -bcc :: CharParser a [String] +bcc :: CharParser a [NameAddr] bcc = header "Bcc" (try address_list <|> do { optional cfws; return [] }) -- ** Identification fields (section 3.6.4) @@ -798,33 +812,33 @@ -- |Parse a \"@Resent-From:@\" header line and return the 'mailbox_list' -- address(es) contained in it. -resent_from :: CharParser a [String] +resent_from :: CharParser a [NameAddr] resent_from = header "Resent-From" mailbox_list -- |Parse a \"@Resent-Sender:@\" header line and return the 'mailbox_list' -- address(es) contained in it. -resent_sender :: CharParser a String +resent_sender :: CharParser a NameAddr resent_sender = header "Resent-Sender" mailbox -- |Parse a \"@Resent-To:@\" header line and return the 'mailbox' -- address contained in it. -resent_to :: CharParser a [String] +resent_to :: CharParser a [NameAddr] resent_to = header "Resent-To" address_list -- |Parse a \"@Resent-Cc:@\" header line and return the 'address_list' -- address(es) contained in it. -resent_cc :: CharParser a [String] +resent_cc :: CharParser a [NameAddr] resent_cc = header "Resent-Cc" address_list -- |Parse a \"@Resent-Bcc:@\" header line and return the 'address_list' -- address(es) contained in it. (This list may be empty.) -resent_bcc :: CharParser a [String] +resent_bcc :: CharParser a [NameAddr] resent_bcc = header "Resent-Bcc" ( try address_list <|> do optional cfws return [] @@ -1154,12 +1168,12 @@ -- -- Strange, isn't it? -obs_mbox_list :: CharParser a [String] -obs_mbox_list = do r1 <- many1 (try (do r <- option [] mailbox +obs_mbox_list :: CharParser a [NameAddr] +obs_mbox_list = do r1 <- many1 (try (do r <- maybeOption mailbox unfold $ char ',' return r)) - r2 <- option [] mailbox - return (filter (/=[]) (r1 ++ [r2])) + r2 <- maybeOption mailbox + return [x | Just x <- r1 ++ [r2]] "obsolete syntax for a list of mailboxes" -- |This parser is identical to 'obs_mbox_list' but parses a list of @@ -1168,14 +1182,14 @@ -- parser will return a simple list of addresses; the grouping -- information is lost. -obs_addr_list :: CharParser a [String] -obs_addr_list = do r1 <- many1 (try (do r <- option [] address +obs_addr_list :: CharParser a [NameAddr] +obs_addr_list = do r1 <- many1 (try (do r <- maybeOption address optional cfws char ',' optional cfws - return (concat r))) - r2 <- option [] address - return (filter (/=[]) (r1 ++ r2)) + return r)) + r2 <- maybeOption address + return (concat [x | Just x <- r1 ++ [r2]]) "obsolete syntax for a list of addresses" @@ -1224,19 +1238,19 @@ -- |Parse a 'from' header line but allow for the obsolete -- folding syntax. -obs_from :: CharParser a [String] +obs_from :: CharParser a [NameAddr] obs_from = obs_header "From" mailbox_list -- |Parse a 'sender' header line but allow for the obsolete -- folding syntax. -obs_sender :: CharParser a String +obs_sender :: CharParser a NameAddr obs_sender = obs_header "Sender" mailbox -- |Parse a 'reply_to' header line but allow for the obsolete -- folding syntax. -obs_reply_to :: CharParser a [String] +obs_reply_to :: CharParser a [NameAddr] obs_reply_to = obs_header "Reply-To" mailbox_list @@ -1245,19 +1259,19 @@ -- |Parse a 'to' header line but allow for the obsolete -- folding syntax. -obs_to :: CharParser a [String] +obs_to :: CharParser a [NameAddr] obs_to = obs_header "To" address_list -- |Parse a 'cc' header line but allow for the obsolete -- folding syntax. -obs_cc :: CharParser a [String] +obs_cc :: CharParser a [NameAddr] obs_cc = obs_header "Cc" address_list -- |Parse a 'bcc' header line but allow for the obsolete -- folding syntax. -obs_bcc :: CharParser a [String] +obs_bcc :: CharParser a [NameAddr] obs_bcc = header "Bcc" ( try address_list <|> do { optional cfws; return [] } ) @@ -1329,13 +1343,13 @@ -- |Parse a 'resent_from' header line but allow for the obsolete -- folding syntax. -obs_resent_from :: CharParser a [String] +obs_resent_from :: CharParser a [NameAddr] obs_resent_from = obs_header "Resent-From" mailbox_list -- |Parse a 'resent_sender' header line but allow for the obsolete -- folding syntax. -obs_resent_send :: CharParser a String +obs_resent_send :: CharParser a NameAddr obs_resent_send = obs_header "Resent-Sender" mailbox -- |Parse a 'resent_date' header line but allow for the obsolete @@ -1347,19 +1361,19 @@ -- |Parse a 'resent_to' header line but allow for the obsolete -- folding syntax. -obs_resent_to :: CharParser a [String] +obs_resent_to :: CharParser a [NameAddr] obs_resent_to = obs_header "Resent-To" mailbox_list -- |Parse a 'resent_cc' header line but allow for the obsolete -- folding syntax. -obs_resent_cc :: CharParser a [String] +obs_resent_cc :: CharParser a [NameAddr] obs_resent_cc = obs_header "Resent-Cc" mailbox_list -- |Parse a 'resent_bcc' header line but allow for the obsolete -- folding syntax. -obs_resent_bcc :: CharParser a [String] +obs_resent_bcc :: CharParser a [NameAddr] obs_resent_bcc = obs_header "Bcc" ( try address_list <|> do { optional cfws; return [] } ) @@ -1373,7 +1387,7 @@ -- |Parse a @Resent-Reply-To@ header line but allow for the -- obsolete folding syntax. -obs_resent_reply :: CharParser a [String] +obs_resent_reply :: CharParser a [NameAddr] obs_resent_reply = obs_header "Resent-Reply-To" address_list diff --git a/example/message-test.hs b/example/message-test.hs new file mode 100644 --- /dev/null +++ b/example/message-test.hs @@ -0,0 +1,21 @@ +module Main (main) where + +import Text.ParserCombinators.Parsec ( parse ) +import Text.ParserCombinators.Parsec.Rfc2822 + +-- Read an Internet message from standard input, parse it, +-- and return the result. + +main :: IO () +main = do + input <- getContents + print $ parse message "" (fixEol input) + return () + +-- Make sure all lines are terminated by CRLF. + +fixEol :: String -> String +fixEol ('\r':'\n':xs) = '\r' : '\n' : (fixEol xs) +fixEol ('\n':xs) = '\r' : '\n' : (fixEol xs) +fixEol (x:xs) = x : (fixEol xs) +fixEol [] = [] diff --git a/example/message-test.input b/example/message-test.input new file mode 100644 --- /dev/null +++ b/example/message-test.input @@ -0,0 +1,20 @@ +X-From-Line: rtMj@example.org Tue Jun 22 15:11:15 2004 +Return-Path: +Received: from example.org ([127.0.0.1]) + by peti.cryp.to with SMTP id i5MDBAW8014197 for ; + Tue, 22 Jun 2004 15:11:12 +0200 +Received: (qmail 076 invoked from network); Tue, 22 Jun 2004 09:09:16 -0400 +Message-ID: +From: "virtual shop" +To: simons@cryp.to +Subject: PROTECT your Computer from tampering ! 315683 +Date: Tue, 22 Jun 2004 09:09:16 -0400 +Mime-Version: 1.0 +Content-Type: multipart/alternative; + boundary="----=_NextPart_013_7A25_1AC67A25.1AC67A25" +X-Priority: 3 +X-MSMail-Priority: Normal +X-Mailer: Microsoft Outlook Express 6.00.2800.1409 +X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2800.1409 + +This is a spam message. diff --git a/example/smtp-test.hs b/example/smtp-test.hs new file mode 100644 --- /dev/null +++ b/example/smtp-test.hs @@ -0,0 +1,13 @@ +module Main (main) where + +import Text.ParserCombinators.Parsec ( parse ) +import Text.ParserCombinators.Parsec.Rfc2821 + +-- Read an SMTP command from standard input, parse it, +-- return the result, and loop until EOF. + +main :: IO () +main = do + input <- getContents + mapM (print . parse smtpCmd "") [ l ++ "\r\n" | l <- lines input ] + return () diff --git a/example/smtp-test.input b/example/smtp-test.input new file mode 100644 --- /dev/null +++ b/example/smtp-test.input @@ -0,0 +1,7 @@ +helo smtp.example.org +mail from: +rcpt to: +RCPT to:<@example.org,@example.com:joe.doe@example.net> +VrFy localuser +data +quit diff --git a/hsemail.cabal b/hsemail.cabal --- a/hsemail.cabal +++ b/hsemail.cabal @@ -1,19 +1,24 @@ -Name: hsemail -Version: 1.1 -Author: Peter Simons -License: GPL -License-File: LICENSE -Maintainer: simons@cryp.to -Homepage: http://cryp.to/hsemail/ -Category: Network -Description: Internet Message Parsers -Build-Depends: base, mtl, parsec, old-time +Name: hsemail +Version: 1.2 +Author: Peter Simons +License: BSD3 +License-file: LICENSE +Maintainer: simons@cryp.to +Homepage: http://cryp.to/hsemail/ +Synopsis: Internet Message Parsers +Description: Parsers for the syntax defined in RFC2821 and 2822 +Category: Parsing +Build-Depends: base, mtl, parsec, old-time +Build-Type: Simple +GHC-Options: -Wall Exposed-Modules: Text.ParserCombinators.Parsec.Rfc2234, Text.ParserCombinators.Parsec.Rfc2821, Text.ParserCombinators.Parsec.Rfc2822 - - -Build-Type: Simple -Tested-With: GHC==6.8.2 -ghc-options: -Wall -O2 +Data-files: + README, + prologue.txt, + example/message-test.hs, + example/message-test.input, + example/smtp-test.hs, + example/smtp-test.input diff --git a/prologue.txt b/prologue.txt new file mode 100644 --- /dev/null +++ b/prologue.txt @@ -0,0 +1,3 @@ +This package provides a myriad parsers for Internet messages +as defined in RFC2234, RFC2821, and RFC2822. That would be +e-mail, mostly.