diff --git a/hakyll.cabal b/hakyll.cabal --- a/hakyll.cabal +++ b/hakyll.cabal @@ -1,5 +1,5 @@ Name: hakyll -Version: 4.9.2.0 +Version: 4.9.3.0 Synopsis: A static website compiler library Description: @@ -65,6 +65,8 @@ tests/data/example.md tests/data/example.md.metadata tests/data/images/favicon.ico + tests/data/just-meta.html + tests/data/just-meta.html.out tests/data/partial-helper.html tests/data/partial.html tests/data/partial.html.out @@ -97,6 +99,7 @@ Exposed-Modules: Hakyll + Hakyll.Commands Hakyll.Core.Compiler Hakyll.Core.Configuration Hakyll.Core.Dependencies @@ -118,6 +121,7 @@ Hakyll.Web.Pandoc Hakyll.Web.Pandoc.Biblio Hakyll.Web.Pandoc.FileType + Hakyll.Web.Redirect Hakyll.Web.Tags Hakyll.Web.Paginate Hakyll.Web.Template @@ -131,7 +135,6 @@ Data.List.Extended Data.Yaml.Extended Hakyll.Check - Hakyll.Commands Hakyll.Core.Compiler.Internal Hakyll.Core.Compiler.Require Hakyll.Core.Item.SomeItem diff --git a/src/Hakyll.hs b/src/Hakyll.hs --- a/src/Hakyll.hs +++ b/src/Hakyll.hs @@ -21,10 +21,11 @@ , module Hakyll.Web.Html , module Hakyll.Web.Html.RelativizeUrls , module Hakyll.Web.Pandoc + , module Hakyll.Web.Paginate , module Hakyll.Web.Pandoc.Biblio , module Hakyll.Web.Pandoc.FileType + , module Hakyll.Web.Redirect , module Hakyll.Web.Tags - , module Hakyll.Web.Paginate , module Hakyll.Web.Template , module Hakyll.Web.Template.Context , module Hakyll.Web.Template.List @@ -54,6 +55,7 @@ import Hakyll.Web.Pandoc import Hakyll.Web.Pandoc.Biblio import Hakyll.Web.Pandoc.FileType +import Hakyll.Web.Redirect import Hakyll.Web.Tags import Hakyll.Web.Template import Hakyll.Web.Template.Context diff --git a/src/Hakyll/Commands.hs b/src/Hakyll/Commands.hs --- a/src/Hakyll/Commands.hs +++ b/src/Hakyll/Commands.hs @@ -50,8 +50,8 @@ -------------------------------------------------------------------------------- -- | Run the checker and exit -check :: Configuration -> Logger -> Check.Check -> IO () -check config logger check' = Check.check config logger check' >>= exitWith +check :: Configuration -> Logger -> Check.Check -> IO ExitCode +check = Check.check -------------------------------------------------------------------------------- diff --git a/src/Hakyll/Main.hs b/src/Hakyll/Main.hs --- a/src/Hakyll/Main.hs +++ b/src/Hakyll/Main.hs @@ -52,7 +52,7 @@ case args'' of Build -> Commands.build conf logger rules - Check _ -> Commands.check conf logger check' >> ok + Check _ -> Commands.check conf logger check' Clean -> Commands.clean conf logger >> ok Deploy -> Commands.deploy conf Preview p -> Commands.preview conf logger rules p >> ok diff --git a/src/Hakyll/Web/Redirect.hs b/src/Hakyll/Web/Redirect.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Web/Redirect.hs @@ -0,0 +1,87 @@ +-- | Module used for generating HTML redirect pages. This allows renaming pages +-- to avoid breaking existing links without requiring server-side support for +-- formal 301 Redirect error codes +module Hakyll.Web.Redirect + ( Redirect (..) + , createRedirects + ) where + +import Control.Applicative ((<$>)) +import Control.Monad (forM_) +import Data.Binary (Binary (..)) +import Hakyll.Core.Compiler +import Hakyll.Core.Identifier +import Hakyll.Core.Routes +import Hakyll.Core.Rules +import Hakyll.Core.Writable (Writable (..)) + +-- | This function exposes a higher-level interface compared to using the +-- 'Redirect' type manually. +-- +-- This creates, using a database mapping broken URLs to working ones, HTML +-- files which will do HTML META tag redirect pages (since, as a static site, we +-- can't use web-server-level 301 redirects, and using JS is gross). +-- +-- This is useful for sending people using old URLs to renamed versions, dealing +-- with common typos etc, and will increase site traffic. Such broken URLs can +-- be found by looking at server logs or by using Google Webmaster Tools. +-- Broken URLs must be valid Haskell strings, non-URL-escaped valid POSIX +-- filenames, and relative links, since they will be defined in a @hakyll.hs@ +-- and during generation, written to disk with the filename corresponding to the +-- broken URLs. (Target URLs can be absolute or relative, but should be +-- URL-escaped.) So broken incoming links like which +-- should be cannot be fixed (since you cannot +-- create a HTML file named @"foo/"@ on disk, as that would be a directory). +-- +-- An example of a valid association list would be: +-- +-- > brokenLinks = +-- > [ ("projects.html", "http://github.com/gwern") +-- > , ("/Black-market archive", "Black-market%20archives") +-- > ] +-- +-- In which case the functionality can then be used in `main` with a line like: +-- +-- > version "redirects" $ createRedirects brokenLinks +-- +-- The 'version' is recommended to separate these items from your other pages. +-- +-- The on-disk files can then be uploaded with HTML mimetypes +-- (either explicitly by generating and uploading them separately, by +-- auto-detection of the filetype, or an upload tool defaulting to HTML +-- mimetype, such as calling @s3cmd@ with @--default-mime-type=text/html@) and +-- will redirect browsers and search engines going to the old/broken URLs. +-- +-- See also . +createRedirects :: [(Identifier, String)] -> Rules () +createRedirects redirects = + forM_ redirects $ \(ident, to) -> + create [ident] $ do + route idRoute + compile $ makeItem $! Redirect to + +-- | This datatype can be used directly if you want a lower-level interface to +-- generate redirects. For example, if you want to redirect @foo.html@ to +-- @bar.jpg@, you can use: +-- +-- > create ["foo.html"] $ do +-- > route idRoute +-- > compile $ makeItem $ Redirect "bar.jpg" +data Redirect = Redirect + { redirectTo :: String + } deriving (Eq, Ord, Show) + +instance Binary Redirect where + put (Redirect to) = put to + get = Redirect <$> get + +instance Writable Redirect where + write path = write path . fmap redirectToHtml + +redirectToHtml :: Redirect -> String +redirectToHtml (Redirect working) = + "" ++ + "Permanent Redirect

The page has moved to: this page

" diff --git a/tests/data/just-meta.html b/tests/data/just-meta.html new file mode 100644 --- /dev/null +++ b/tests/data/just-meta.html @@ -0,0 +1,7 @@ +
+external: {$external$}
+date: {$date$}
+subblog: {$subblog$}
+intfield: {$intfield$}
+numfield: {$numfield$}
+
diff --git a/tests/data/just-meta.html.out b/tests/data/just-meta.html.out new file mode 100644 --- /dev/null +++ b/tests/data/just-meta.html.out @@ -0,0 +1,7 @@ +
+external: {External data}
+date: {2012-10-22 14:35:24}
+subblog: {food}
+intfield: {42}
+numfield: {3.14}
+