From 242e2a064f6a32b22e1599bbfe72e64d7b6203b8 Mon Sep 17 00:00:00 2001
From: John MacFarlane <jgm@berkeley.edu>
Date: Wed, 21 Jun 2017 23:54:16 +0200
Subject: Change default EPUB directory structure in OCF container.

See #3720.
We now put all EPUB related content in an EPUB/ subdirectory
by default (later this will be configurable).

    mimetype
    META-INF/
      com.apple.ibooks.display-options.xml
      container.xml
    EPUB/ <<--configurable-->>
      fonts/ <<--static-->>
      font.otf
    media/ <<--static-->>
      cover.jpg
      fig1.jpg
    styles/ <<--static-->>
      stylesheet.css
    content.opf
    toc.ncx
    text/ <<--static-->>
      ch001.xhtml
---
 src/Text/Pandoc/Writers/EPUB.hs | 33 ++++++++++++++++++++++-----------
 1 file changed, 22 insertions(+), 11 deletions(-)

(limited to 'src/Text/Pandoc/Writers/EPUB.hs')

diff --git a/src/Text/Pandoc/Writers/EPUB.hs b/src/Text/Pandoc/Writers/EPUB.hs
index bd9a4c800..11ca7d168 100644
--- a/src/Text/Pandoc/Writers/EPUB.hs
+++ b/src/Text/Pandoc/Writers/EPUB.hs
@@ -80,6 +80,7 @@ data Chapter = Chapter (Maybe [Int]) [Block]
 
 data EPUBState = EPUBState {
         stMediaPaths  :: [(FilePath, (FilePath, Maybe Entry))]
+      , stEPUBSubdir  :: String
       }
 
 type E m = StateT EPUBState m
@@ -362,6 +363,7 @@ writeEPUB :: PandocMonad m
           -> m B.ByteString
 writeEPUB epubVersion opts doc =
   let initState = EPUBState { stMediaPaths = []
+                            , stEPUBSubdir = "EPUB"
                             }
   in
     evalStateT (pandocToEPUB epubVersion opts doc)
@@ -373,6 +375,7 @@ pandocToEPUB :: PandocMonad m
              -> Pandoc
              -> E m B.ByteString
 pandocToEPUB version opts doc@(Pandoc meta _) = do
+  epubSubdir <- gets stEPUBSubdir
   let epub3 = version == EPUB3
   let writeHtml o = fmap (UTF8.fromTextLazy . TL.fromStrict) .
                       writeHtmlStringForEPUB version o
@@ -383,10 +386,11 @@ pandocToEPUB version opts doc@(Pandoc meta _) = do
   -- stylesheet
   stylesheets <- case epubStylesheets metadata of
                       [] -> (\x -> [B.fromChunks [x]]) <$>
-                             P.readDataFile (writerUserDataDir opts) "epub.css"
+                             P.readDataFile (writerUserDataDir opts)
+                             "epub.css"
                       fs -> mapM P.readFileLazy fs
   let stylesheetEntries = zipWith
-        (\bs n -> mkEntry ("stylesheet" ++ show n ++ ".css") bs)
+        (\bs n -> mkEntry ("styles/stylesheet" ++ show n ++ ".css") bs)
         stylesheets [(1 :: Int)..]
 
   let vars = ("epub3", if epub3 then "true" else "false")
@@ -431,7 +435,8 @@ pandocToEPUB version opts doc@(Pandoc meta _) = do
         when (null xs) $
           report $ CouldNotFetchResource f "glob did not match any font files"
         return xs
-  let mkFontEntry f = mkEntry (takeFileName f) `fmap` (lift $ P.readFileLazy f)
+  let mkFontEntry f = mkEntry ("fonts/" ++ takeFileName f) <$>
+                        lift (P.readFileLazy f)
   fontFiles <- concat <$> mapM matchingGlob (writerEpubFonts opts')
   fontEntries <- mapM mkFontEntry fontFiles
 
@@ -728,7 +733,8 @@ pandocToEPUB version opts doc@(Pandoc meta _) = do
        unode "container" ! [("version","1.0")
               ,("xmlns","urn:oasis:names:tc:opendocument:xmlns:container")] $
          unode "rootfiles" $
-           unode "rootfile" ! [("full-path","content.opf")
+           unode "rootfile" ! [("full-path",
+               epubSubdir ++ ['/' | not (null epubSubdir)] ++ "content.opf")
                ,("media-type","application/oebps-package+xml")] $ ()
   let containerEntry = mkEntry "META-INF/container.xml" containerData
 
@@ -739,10 +745,14 @@ pandocToEPUB version opts doc@(Pandoc meta _) = do
             unode "option" ! [("name","specified-fonts")] $ "true"
   let appleEntry = mkEntry "META-INF/com.apple.ibooks.display-options.xml" apple
 
+  let addEpubSubdir :: Entry -> Entry
+      addEpubSubdir e = e{ eRelativePath =
+        epubSubdir ++ ['/' | not (null epubSubdir)] ++ eRelativePath e }
   -- construct archive
-  let archive = foldr addEntryToArchive emptyArchive
-                 (mimetypeEntry : containerEntry : appleEntry : tpEntry :
-                  contentsEntry : tocEntry : navEntry :
+  let archive = foldr addEntryToArchive emptyArchive $
+                 [mimetypeEntry, containerEntry, appleEntry] ++
+                 map addEpubSubdir
+                 (tpEntry : contentsEntry : tocEntry : navEntry :
                   (stylesheetEntries ++ picEntries ++ cpicEntry ++
                    cpgEntry ++ chapterEntries ++ fontEntries))
   return $ fromArchive archive
@@ -878,15 +888,16 @@ modifyMediaRef :: PandocMonad m
 modifyMediaRef _ "" = return ""
 modifyMediaRef opts oldsrc = do
   media <- gets stMediaPaths
+  epubSubdir <- gets stEPUBSubdir
   case lookup oldsrc media of
          Just (n,_) -> return n
          Nothing    -> catchError
            (do (img, mbMime) <- P.fetchItem (writerSourceURL opts) oldsrc
                let new = "media/file" ++ show (length media) ++
-                    fromMaybe (takeExtension (takeWhile (/='?') oldsrc))
-                      (('.':) <$> (mbMime >>= extensionFromMimeType))
+                          fromMaybe (takeExtension (takeWhile (/='?') oldsrc))
+                          (('.':) <$> (mbMime >>= extensionFromMimeType))
                epochtime <- floor `fmap` lift P.getPOSIXTime
-               let entry = toEntry new epochtime $ B.fromChunks . (:[]) $ img
+               let entry = toEntry new epochtime (B.fromChunks . (:[]) $ img)
                modify $ \st -> st{ stMediaPaths =
                             (oldsrc, (new, Just entry)):media}
                return new)
@@ -952,7 +963,7 @@ mediaTypeOf x =
 
 -- Returns filename for chapter number.
 showChapter :: Int -> String
-showChapter = printf "ch%03d.xhtml"
+showChapter = printf "text/ch%03d.xhtml"
 
 -- Add identifiers to any headers without them.
 addIdentifiers :: [Block] -> [Block]
-- 
cgit v1.2.3