diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 2014 SumAll.com + + 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. 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/canteven-parsedate.cabal b/canteven-parsedate.cabal new file mode 100644 --- /dev/null +++ b/canteven-parsedate.cabal @@ -0,0 +1,44 @@ +name: canteven-parsedate +version: 1.0.1.2 +synopsis: Date / time parsing utilities that try to guess the date / time format. +-- description: +license: Apache-2.0 +license-file: LICENSE +author: Rick Owens, Alex Babkin +maintainer: rowens@sumall.com, ababkin@sumall.com +-- copyright: +-- category: +build-type: Simple +-- extra-source-files: +cabal-version: >=1.10 + +library + exposed-modules: + Canteven.ParseDate, + Canteven.ParseDate.Types + -- other-modules: + -- other-extensions: + build-depends: + base >=4.7 && <4.9, + time >=1.5 && < 1.6, + timezone-series, + tz + hs-source-dirs: src + default-language: Haskell2010 + ghc-options: -Wall + +Test-Suite test-parsedate + type: detailed-0.9 + hs-source-dirs: test + test-module: Canteven.TestParseDate + -- FIXME. WTF is going on with the time library + build-depends: + Cabal>=1.20, + base, + canteven-parsedate, + old-locale, + time >=1.4.2 && < 1.6, + timezone-series, + tz + default-language: Haskell2010 + ghc-options: -Wall diff --git a/src/Canteven/ParseDate.hs b/src/Canteven/ParseDate.hs new file mode 100644 --- /dev/null +++ b/src/Canteven/ParseDate.hs @@ -0,0 +1,61 @@ +{- | +This module wraps `Date.Time.Format` and provides a handy way to parse a date +string who's format is unknown, but which may be one of several "supported" +date formats. +-} +module Canteven.ParseDate ( + parseDate, + supportedDateFormats, + iso8601UtcDateFormats, + twitterDateFormat +) where + +import Data.Maybe (listToMaybe, mapMaybe) +import Data.Time.Format (rfc822DateFormat, ParseTime, parseTimeM, defaultTimeLocale) + +{- | + Parses a date string. Returns `Nothing` if the string cannot be parsed. The + specific set of date formats known is defined below by + `supportedDateFormats` +-} +parseDate :: (ParseTime t) => String -> Maybe t +parseDate str = + parseAll supportedDateFormats + where + parseAll fmts = listToMaybe (mapMaybe parse fmts) + parse fmt = parseTimeM True defaultTimeLocale fmt str + +{- | + The list of supported date formats. + currently: + + > rfc822DateFormat:iso8601UtcDateFormats + + See also 'rfc822DateFormat'. +-} +supportedDateFormats :: [String] +supportedDateFormats = + rfc822DateFormat:twitterDateFormat:epochFormat:iso8601UtcDateFormats + + +iso8601UtcDateFormats :: [String] +iso8601UtcDateFormats = + [ + "%Y-%m-%dT%H:%M:%S%Q%Z", -- 2014-07-18T12:01:57-0800 + "%Y-%m-%dT%H:%M:%S%Q", + "%Y-%m-%dT%H:%M", + "%Y-%m-%dT%H", + "%Y-%m-%d", + "%Y-%m" + ] + +twitterDateFormat :: String +twitterDateFormat = "%a %b %d %T %Z %Y" + +{- | + In seconds since Jan 1, 1970 +-} +epochFormat :: String +epochFormat = "%s" + + diff --git a/src/Canteven/ParseDate/Types.hs b/src/Canteven/ParseDate/Types.hs new file mode 100644 --- /dev/null +++ b/src/Canteven/ParseDate/Types.hs @@ -0,0 +1,55 @@ +{-# LANGUAGE NamedFieldPuns #-} + +module Canteven.ParseDate.Types ( + LocalTimeAndOffset(..), + ltaoInTimeZone, + ltaoInTimeZoneTZ +) where + +import Data.Time (UTCTime, ParseTime (buildTime)) +import Data.Time.LocalTime (LocalTime, TimeZone, localTimeToUTC) +import Data.Time.LocalTime.TimeZone.Series (TimeZoneSeries, utcToLocalTime') +import Data.Time.Zones (TZ, utcToLocalTimeTZ) + + +-- | A data type for parsing ISO8601 and distinguishing between with-offset or +-- without-offset formats. +data LocalTimeAndOffset = LocalTimeAndOffset { + ltaoLocalTime :: LocalTime + , ltaoOffset :: Maybe TimeZone + } deriving (Read, Show, Eq) + +instance ParseTime LocalTimeAndOffset where + buildTime l xs = + LocalTimeAndOffset (buildTime l $ filter (not . isZoneInfo) xs) + maybeZone + where + -- Apparently "%Z" matches even the empty string and parses it as 00:00. + -- "%z" might do this too but I haven't tested it. + isZoneInfo ('z',_) = True + isZoneInfo ('Z',"") = False + isZoneInfo ('Z',_) = True + isZoneInfo _ = False + zoneLetters = filter isZoneInfo xs + maybeZone | null zoneLetters = Nothing + | otherwise = Just $ buildTime l zoneLetters + +-- | Get the localtime represented by this LTAO in the given timezone. +ltaoInTimeZone :: TimeZoneSeries -> LocalTimeAndOffset -> LocalTime +ltaoInTimeZone = ltaoInTimeZoneConvert utcToLocalTime' + +-- | same as @ltaoInTimeZone@ but for TZ +ltaoInTimeZoneTZ :: TZ -> LocalTimeAndOffset -> LocalTime +ltaoInTimeZoneTZ = ltaoInTimeZoneConvert utcToLocalTimeTZ + + + +ltaoInTimeZoneConvert :: (a -> UTCTime -> LocalTime) -> a -> LocalTimeAndOffset -> LocalTime +-- If the LTAO doesn't specify an offset, it must be local time, so just use it +-- directly. +ltaoInTimeZoneConvert _ _ (LocalTimeAndOffset lTime Nothing) = lTime +-- Otherwise, this LTAO specifies a UTCTime, so convert that UTCTime to LocalTime. +ltaoInTimeZoneConvert convert tz (LocalTimeAndOffset lTime (Just off)) = + convert tz utc + where + utc = localTimeToUTC off lTime diff --git a/test/Canteven/TestParseDate.hs b/test/Canteven/TestParseDate.hs new file mode 100644 --- /dev/null +++ b/test/Canteven/TestParseDate.hs @@ -0,0 +1,75 @@ +module Canteven.TestParseDate ( tests ) where + +import Canteven.ParseDate (parseDate) +import Data.Time.Clock (UTCTime) +import Data.Time.Format (defaultTimeLocale, formatTime) +import Distribution.TestSuite (Progress (..), Result (..), Test (..), + TestInstance (..)) +import System.Locale (iso8601DateFormat) + +tests :: IO [Test] +tests = return [Group "timezone tests for ISO8601 format" True [testZulu, testFourDigitTZ, test8601StyleTz], + Group "Twitter format tests" True [testTwitterBasic, testTwitterWithTZ], + Group "fractional second tests" True [testFracSecond], + Group "epoch time tests" True [testEpochTime]] + +testZulu :: Test +testZulu = Test $ defaultTest { + run = return $ Finished $ "2014-10-01T21:13:00Z" `parseEquals` "2014-10-01T21:13:00", + name = "parsing with Zulu suffix (\"Z\")" + } + +testFourDigitTZ :: Test +testFourDigitTZ = Test $ defaultTest { + run = return $ Finished $ "2014-10-01T21:13:00+0400" `parseEquals` "2014-10-01T17:13:00", + name = "parsing with RFC822-style four-digit tz (\"+0400\")" + } + +test8601StyleTz :: Test +test8601StyleTz = Test $ defaultTest { + run = return $ Finished $ "2014-10-01T21:13:00+04:00" `parseEquals` "2014-10-01T17:13:00", + name = "parsing with ISO8601-style hh:mm tz (\"+04:00\")" + } + +testFracSecond :: Test +testFracSecond = Test $ defaultTest { + run = return $ Finished $ "2014-10-01T21:13:00.000Z" `parseEquals` "2014-10-01T21:13:00", + name = "parsing fractional seconds" + } + +testTwitterBasic :: Test +testTwitterBasic = Test $ defaultTest { + run = return $ Finished $ "Fri Aug 21 21:48:25 +0000 2009" `parseEquals` "2009-08-21T21:48:25", + name = "parsing Twitter's basic format" + } + +testTwitterWithTZ :: Test +testTwitterWithTZ = Test $ defaultTest { + run = return $ Finished $ "Fri Aug 21 21:48:25 -0200 2009" `parseEquals` "2009-08-21T23:48:25", + name = "parsing Twitter with a tz" + } + +testEpochTime :: Test +testEpochTime = Test $ defaultTest { + run = return $ Finished $ "1414180021" `parseEquals` "2014-10-24T19:47:01", + name = "parsing epoch time" + } + +defaultTest :: TestInstance +defaultTest = TestInstance { + run = return $ Finished $ Pass, + name = "", + tags = [], + options = [], + setOption = \_ _ -> Right defaultTest -- FIXME + } + +parseEquals :: String -> String -> Result +parseEquals src dest = case parseDate src of + Nothing -> Fail $ "couldn't parse " ++ show src + Just t -> case renderDate t == dest of + False -> Fail $ "parsed string " ++ show src ++ " wasn't the same as " ++ show dest ++ ": got " ++ show (renderDate t) + True -> Pass + +renderDate :: UTCTime -> String +renderDate = formatTime defaultTimeLocale $ iso8601DateFormat $ Just "%H:%M:%S"