{-# LANGUAGE CPP #-}
{-# LANGUAGE ScopedTypeVariables #-}
#ifdef EMBED_DATA_FILES
{-# LANGUAGE TemplateHaskell #-}
#endif
module Text.Pandoc.Data ( readDefaultDataFile
, readDataFile
, getDataFileNames
, defaultUserDataDir
) where
import Text.Pandoc.Class (PandocMonad(..), getDataDirs, getTimestamp,
getPOSIXTime)
import Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds)
import qualified Data.ByteString.Lazy as BL
import qualified Data.ByteString as B
import Codec.Archive.Zip
import Data.List (sort)
import qualified Data.Text as T
import Control.Monad.Except (throwError)
import Text.Pandoc.Error (PandocError(..))
import System.FilePath
import System.Directory
import qualified Control.Exception as E
#ifdef EMBED_DATA_FILES
import Text.Pandoc.Data.BakedIn (dataFiles)
import Text.Pandoc.Shared (makeCanonical)
#else
import Paths_pandoc (getDataDir)
#endif
readDefaultDataFile :: PandocMonad m => FilePath -> m B.ByteString
readDefaultDataFile :: forall (m :: * -> *). PandocMonad m => [Char] -> m ByteString
readDefaultDataFile [Char]
fname =
case ([Char] -> m ByteString) -> [Char] -> Maybe (m Archive)
forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> [Char] -> Maybe (m Archive)
buildReferenceDoc [Char] -> m ByteString
forall (m :: * -> *). PandocMonad m => [Char] -> m ByteString
readDefaultDataFile [Char]
fname of
Just m Archive
getArchive -> Archive -> ByteString
archiveToByteString (Archive -> ByteString) -> m Archive -> m ByteString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> m Archive
getArchive
Maybe (m Archive)
Nothing -> [Char] -> m ByteString
forall (m :: * -> *). PandocMonad m => [Char] -> m ByteString
readDefaultDataFile' [Char]
fname
buildReferenceDoc :: PandocMonad m
=> (FilePath -> m B.ByteString) -> FilePath
-> Maybe (m Archive)
buildReferenceDoc :: forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> [Char] -> Maybe (m Archive)
buildReferenceDoc [Char] -> m ByteString
readComponent [Char]
fname =
case [Char]
fname of
[Char]
"reference.docx" -> m Archive -> Maybe (m Archive)
forall a. a -> Maybe a
Just (m Archive -> Maybe (m Archive)) -> m Archive -> Maybe (m Archive)
forall a b. (a -> b) -> a -> b
$ ([Char] -> m ByteString) -> m Archive
forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> m Archive
getDefaultReferenceDocx [Char] -> m ByteString
readComponent
[Char]
"reference.pptx" -> m Archive -> Maybe (m Archive)
forall a. a -> Maybe a
Just (m Archive -> Maybe (m Archive)) -> m Archive -> Maybe (m Archive)
forall a b. (a -> b) -> a -> b
$ ([Char] -> m ByteString) -> m Archive
forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> m Archive
getDefaultReferencePptx [Char] -> m ByteString
readComponent
[Char]
"reference.odt" -> m Archive -> Maybe (m Archive)
forall a. a -> Maybe a
Just (m Archive -> Maybe (m Archive)) -> m Archive -> Maybe (m Archive)
forall a b. (a -> b) -> a -> b
$ ([Char] -> m ByteString) -> m Archive
forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> m Archive
getDefaultReferenceODT [Char] -> m ByteString
readComponent
[Char]
_ -> Maybe (m Archive)
forall a. Maybe a
Nothing
archiveToByteString :: Archive -> B.ByteString
archiveToByteString :: Archive -> ByteString
archiveToByteString = [ByteString] -> ByteString
B.concat ([ByteString] -> ByteString)
-> (Archive -> [ByteString]) -> Archive -> ByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LazyByteString -> [ByteString]
BL.toChunks (LazyByteString -> [ByteString])
-> (Archive -> LazyByteString) -> Archive -> [ByteString]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Archive -> LazyByteString
fromArchive
readDefaultDataFile' :: PandocMonad m => FilePath -> m B.ByteString
readDefaultDataFile' :: forall (m :: * -> *). PandocMonad m => [Char] -> m ByteString
readDefaultDataFile' [Char]
fname =
#ifdef EMBED_DATA_FILES
case [Char] -> [([Char], ByteString)] -> Maybe ByteString
forall a b. Eq a => a -> [(a, b)] -> Maybe b
lookup ([Char] -> [Char]
makeCanonical [Char]
fname) [([Char], ByteString)]
dataFiles of
Maybe ByteString
Nothing -> PandocError -> m ByteString
forall a. PandocError -> m a
forall e (m :: * -> *) a. MonadError e m => e -> m a
throwError (PandocError -> m ByteString) -> PandocError -> m ByteString
forall a b. (a -> b) -> a -> b
$ Text -> PandocError
PandocCouldNotFindDataFileError (Text -> PandocError) -> Text -> PandocError
forall a b. (a -> b) -> a -> b
$ [Char] -> Text
T.pack [Char]
fname
Just ByteString
contents -> ByteString -> m ByteString
forall a. a -> m a
forall (m :: * -> *) a. Monad m => a -> m a
return ByteString
contents
#else
getDataFileName fname' >>= checkExistence >>= readFileStrict
where fname' = if fname == "MANUAL.txt" then fname else "data" </> fname
checkExistence :: PandocMonad m => FilePath -> m FilePath
checkExistence fn = do
exists <- fileExists fn
if exists
then return fn
else throwError $ PandocCouldNotFindDataFileError $ T.pack fn
#endif
readDataFile :: PandocMonad m => FilePath -> m B.ByteString
readDataFile :: forall (m :: * -> *). PandocMonad m => [Char] -> m ByteString
readDataFile [Char]
fname = [Char] -> m [[Char]]
forall (m :: * -> *). PandocMonad m => [Char] -> m [[Char]]
getDataDirs [Char]
fname m [[Char]] -> ([[Char]] -> m ByteString) -> m ByteString
forall a b. m a -> (a -> m b) -> m b
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= [[Char]] -> m ByteString
forall {f :: * -> *}. PandocMonad f => [[Char]] -> f ByteString
go
where
go :: [[Char]] -> f ByteString
go [] = case ([Char] -> f ByteString) -> [Char] -> Maybe (f Archive)
forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> [Char] -> Maybe (m Archive)
buildReferenceDoc [Char] -> f ByteString
forall (m :: * -> *). PandocMonad m => [Char] -> m ByteString
readDataFile [Char]
fname of
Just f Archive
getArchive -> Archive -> ByteString
archiveToByteString (Archive -> ByteString) -> f Archive -> f ByteString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> f Archive
getArchive
Maybe (f Archive)
Nothing -> [Char] -> f ByteString
forall (m :: * -> *). PandocMonad m => [Char] -> m ByteString
readDefaultDataFile' [Char]
fname
go ([Char]
d:[[Char]]
ds) = do
exists <- [Char] -> f Bool
forall (m :: * -> *). PandocMonad m => [Char] -> m Bool
fileExists ([Char]
d [Char] -> [Char] -> [Char]
</> [Char]
fname)
if exists
then readFileStrict (d </> fname)
else go ds
getDefaultReferenceDocx :: PandocMonad m
=> (FilePath -> m B.ByteString) -> m Archive
getDefaultReferenceDocx :: forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> m Archive
getDefaultReferenceDocx [Char] -> m ByteString
readComponent = do
let paths :: [[Char]]
paths = [[Char]
"[Content_Types].xml",
[Char]
"_rels/.rels",
[Char]
"docProps/app.xml",
[Char]
"docProps/core.xml",
[Char]
"docProps/custom.xml",
[Char]
"word/document.xml",
[Char]
"word/fontTable.xml",
[Char]
"word/footnotes.xml",
[Char]
"word/comments.xml",
[Char]
"word/numbering.xml",
[Char]
"word/settings.xml",
[Char]
"word/webSettings.xml",
[Char]
"word/styles.xml",
[Char]
"word/_rels/document.xml.rels",
[Char]
"word/_rels/footnotes.xml.rels",
[Char]
"word/theme/theme1.xml"]
let toLazy :: ByteString -> LazyByteString
toLazy = [ByteString] -> LazyByteString
BL.fromChunks ([ByteString] -> LazyByteString)
-> (ByteString -> [ByteString]) -> ByteString -> LazyByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (ByteString -> [ByteString] -> [ByteString]
forall a. a -> [a] -> [a]
:[])
let pathToEntry :: [Char] -> m Entry
pathToEntry [Char]
path = do
epochtime <- NominalDiffTime -> Integer
forall b. Integral b => NominalDiffTime -> b
forall a b. (RealFrac a, Integral b) => a -> b
floor (NominalDiffTime -> Integer)
-> (UTCTime -> NominalDiffTime) -> UTCTime -> Integer
forall b c a. (b -> c) -> (a -> b) -> a -> c
. UTCTime -> NominalDiffTime
utcTimeToPOSIXSeconds (UTCTime -> Integer) -> m UTCTime -> m Integer
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> m UTCTime
forall (m :: * -> *). PandocMonad m => m UTCTime
getTimestamp
contents <- toLazy <$> readComponent ("docx/" ++ path)
return $ toEntry path epochtime contents
(Entry -> Archive -> Archive) -> Archive -> [Entry] -> Archive
forall a b. (a -> b -> b) -> b -> [a] -> b
forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr Entry -> Archive -> Archive
addEntryToArchive Archive
emptyArchive ([Entry] -> Archive) -> m [Entry] -> m Archive
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ([Char] -> m Entry) -> [[Char]] -> m [Entry]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> [a] -> m [b]
mapM [Char] -> m Entry
pathToEntry [[Char]]
paths
getDefaultReferenceODT :: PandocMonad m
=> (FilePath -> m B.ByteString) -> m Archive
getDefaultReferenceODT :: forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> m Archive
getDefaultReferenceODT [Char] -> m ByteString
readComponent = do
let paths :: [[Char]]
paths = [[Char]
"mimetype",
[Char]
"manifest.rdf",
[Char]
"styles.xml",
[Char]
"content.xml",
[Char]
"meta.xml",
[Char]
"META-INF/manifest.xml"]
let pathToEntry :: [Char] -> m Entry
pathToEntry [Char]
path = do epochtime <- NominalDiffTime -> Integer
forall b. Integral b => NominalDiffTime -> b
forall a b. (RealFrac a, Integral b) => a -> b
floor (NominalDiffTime -> Integer) -> m NominalDiffTime -> m Integer
forall a b. (a -> b) -> m a -> m b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
`fmap` m NominalDiffTime
forall (m :: * -> *). PandocMonad m => m NominalDiffTime
getPOSIXTime
contents <- (BL.fromChunks . (:[])) `fmap`
readComponent ("odt/" ++ path)
return $ toEntry path epochtime contents
(Entry -> Archive -> Archive) -> Archive -> [Entry] -> Archive
forall a b. (a -> b -> b) -> b -> [a] -> b
forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr Entry -> Archive -> Archive
addEntryToArchive Archive
emptyArchive ([Entry] -> Archive) -> m [Entry] -> m Archive
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ([Char] -> m Entry) -> [[Char]] -> m [Entry]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> [a] -> m [b]
mapM [Char] -> m Entry
pathToEntry [[Char]]
paths
getDefaultReferencePptx :: PandocMonad m
=> (FilePath -> m B.ByteString) -> m Archive
getDefaultReferencePptx :: forall (m :: * -> *).
PandocMonad m =>
([Char] -> m ByteString) -> m Archive
getDefaultReferencePptx [Char] -> m ByteString
readComponent = do
let paths :: [[Char]]
paths = [ [Char]
"[Content_Types].xml"
, [Char]
"_rels/.rels"
, [Char]
"docProps/app.xml"
, [Char]
"docProps/core.xml"
, [Char]
"ppt/_rels/presentation.xml.rels"
, [Char]
"ppt/presProps.xml"
, [Char]
"ppt/presentation.xml"
, [Char]
"ppt/slideLayouts/_rels/slideLayout1.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout2.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout3.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout4.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout5.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout6.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout7.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout8.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout9.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout10.xml.rels"
, [Char]
"ppt/slideLayouts/_rels/slideLayout11.xml.rels"
, [Char]
"ppt/slideLayouts/slideLayout1.xml"
, [Char]
"ppt/slideLayouts/slideLayout10.xml"
, [Char]
"ppt/slideLayouts/slideLayout11.xml"
, [Char]
"ppt/slideLayouts/slideLayout2.xml"
, [Char]
"ppt/slideLayouts/slideLayout3.xml"
, [Char]
"ppt/slideLayouts/slideLayout4.xml"
, [Char]
"ppt/slideLayouts/slideLayout5.xml"
, [Char]
"ppt/slideLayouts/slideLayout6.xml"
, [Char]
"ppt/slideLayouts/slideLayout7.xml"
, [Char]
"ppt/slideLayouts/slideLayout8.xml"
, [Char]
"ppt/slideLayouts/slideLayout9.xml"
, [Char]
"ppt/slideMasters/_rels/slideMaster1.xml.rels"
, [Char]
"ppt/slideMasters/slideMaster1.xml"
, [Char]
"ppt/slides/_rels/slide1.xml.rels"
, [Char]
"ppt/slides/slide1.xml"
, [Char]
"ppt/slides/_rels/slide2.xml.rels"
, [Char]
"ppt/slides/slide2.xml"
, [Char]
"ppt/slides/_rels/slide3.xml.rels"
, [Char]
"ppt/slides/slide3.xml"
, [Char]
"ppt/slides/_rels/slide4.xml.rels"
, [Char]
"ppt/slides/slide4.xml"
, [Char]
"ppt/tableStyles.xml"
, [Char]
"ppt/theme/theme1.xml"
, [Char]
"ppt/viewProps.xml"
, [Char]
"ppt/notesMasters/notesMaster1.xml"
, [Char]
"ppt/notesMasters/_rels/notesMaster1.xml.rels"
, [Char]
"ppt/notesSlides/notesSlide1.xml"
, [Char]
"ppt/notesSlides/_rels/notesSlide1.xml.rels"
, [Char]
"ppt/notesSlides/notesSlide2.xml"
, [Char]
"ppt/notesSlides/_rels/notesSlide2.xml.rels"
, [Char]
"ppt/theme/theme2.xml"
]
let toLazy :: ByteString -> LazyByteString
toLazy = [ByteString] -> LazyByteString
BL.fromChunks ([ByteString] -> LazyByteString)
-> (ByteString -> [ByteString]) -> ByteString -> LazyByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (ByteString -> [ByteString] -> [ByteString]
forall a. a -> [a] -> [a]
:[])
let pathToEntry :: [Char] -> m Entry
pathToEntry [Char]
path = do
epochtime <- NominalDiffTime -> Integer
forall b. Integral b => NominalDiffTime -> b
forall a b. (RealFrac a, Integral b) => a -> b
floor (NominalDiffTime -> Integer) -> m NominalDiffTime -> m Integer
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> m NominalDiffTime
forall (m :: * -> *). PandocMonad m => m NominalDiffTime
getPOSIXTime
contents <- toLazy <$> readComponent ("pptx/" ++ path)
return $ toEntry path epochtime contents
(Entry -> Archive -> Archive) -> Archive -> [Entry] -> Archive
forall a b. (a -> b -> b) -> b -> [a] -> b
forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr Entry -> Archive -> Archive
addEntryToArchive Archive
emptyArchive ([Entry] -> Archive) -> m [Entry] -> m Archive
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ([Char] -> m Entry) -> [[Char]] -> m [Entry]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> [a] -> m [b]
mapM [Char] -> m Entry
pathToEntry [[Char]]
paths
getDataFileNames :: IO [FilePath]
getDataFileNames :: IO [[Char]]
getDataFileNames = do
#ifdef EMBED_DATA_FILES
let allDataFiles :: [[Char]]
allDataFiles = (([Char], ByteString) -> [Char])
-> [([Char], ByteString)] -> [[Char]]
forall a b. (a -> b) -> [a] -> [b]
map ([Char], ByteString) -> [Char]
forall a b. (a, b) -> a
fst [([Char], ByteString)]
dataFiles
#else
let listDirectoryRecursive d = do
xs <- listDirectory d
concat <$>
mapM (\f -> do
isdir <- doesDirectoryExist (d </> f)
if isdir
then map (f </>) <$> listDirectoryRecursive (d </> f)
else pure [f]) xs
ddir <- getDataDir
allDataFiles <- ("MANUAL.txt" :) <$>
listDirectoryRecursive (ddir </> "data")
#endif
[[Char]] -> IO [[Char]]
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ([[Char]] -> IO [[Char]]) -> [[Char]] -> IO [[Char]]
forall a b. (a -> b) -> a -> b
$ [[Char]] -> [[Char]]
forall a. Ord a => [a] -> [a]
sort ([[Char]] -> [[Char]]) -> [[Char]] -> [[Char]]
forall a b. (a -> b) -> a -> b
$
[Char]
"reference.docx" [Char] -> [[Char]] -> [[Char]]
forall a. a -> [a] -> [a]
: [Char]
"reference.odt" [Char] -> [[Char]] -> [[Char]]
forall a. a -> [a] -> [a]
: [Char]
"reference.pptx" [Char] -> [[Char]] -> [[Char]]
forall a. a -> [a] -> [a]
: [[Char]]
allDataFiles
defaultUserDataDir :: IO FilePath
defaultUserDataDir :: IO [Char]
defaultUserDataDir = do
xdgDir <- IO [Char] -> (SomeException -> IO [Char]) -> IO [Char]
forall e a. Exception e => IO a -> (e -> IO a) -> IO a
E.catch (XdgDirectory -> [Char] -> IO [Char]
getXdgDirectory XdgDirectory
XdgData [Char]
"pandoc")
(\(SomeException
_ :: E.SomeException) -> [Char] -> IO [Char]
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return [Char]
forall a. Monoid a => a
mempty)
xdgExists <- doesDirectoryExist xdgDir
legacyDir <- E.catch (getAppUserDataDirectory "pandoc")
(\(SomeException
_ :: E.SomeException) -> [Char] -> IO [Char]
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return [Char]
forall a. Monoid a => a
mempty)
legacyDirExists <- doesDirectoryExist legacyDir
if not xdgExists && legacyDirExists
then return legacyDir
else return xdgDir