{-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE TemplateHaskell #-} -- | Create new a new project directory populated with a basic working -- project. module Stack.New ( new , NewOpts(..) , defaultTemplateName , templateNameArgument , getTemplates , TemplateName , listTemplates) where import Control.Monad import Control.Monad.Catch import Control.Monad.IO.Class import Control.Monad.Logger import Control.Monad.Reader import Control.Monad.Trans.Writer.Strict import Data.Aeson import Data.Aeson.Types import qualified Data.ByteString.Lazy as LB import qualified Data.ByteString.Lazy.Char8 as L8 import Data.Conduit import Data.List import Data.Map.Strict (Map) import qualified Data.Map.Strict as M import Data.Maybe import Data.Monoid import Data.Set (Set) import qualified Data.Set as S import Data.Text (Text) import qualified Data.Text as T import qualified Data.Text.Encoding as T import qualified Data.Text.IO as T import qualified Data.Text.Lazy as LT import Data.Typeable import Network.HTTP.Client.Conduit hiding (path) import Network.HTTP.Download import Network.HTTP.Types.Status import Path import Path.IO import Stack.Constants import Stack.Types import Stack.Types.TemplateName import System.Process.Run import Text.Hastache import Text.Hastache.Context import Text.ProjectTemplate -------------------------------------------------------------------------------- -- Main project creation -- | Options for creating a new project. data NewOpts = NewOpts { newOptsProjectName :: PackageName -- ^ Name of the project to create. , newOptsTemplate :: TemplateName -- ^ Name of the template to use. } -- | Create a new project with the given options. new :: (HasConfig r, MonadReader r m, MonadLogger m, MonadCatch m, MonadThrow m, MonadIO m, HasHttpManager r) => NewOpts -> m (Path Abs Dir) new opts = do pwd <- getWorkingDir relDir <- parseRelDir (packageNameString (newOptsProjectName opts)) absDir <- liftM (pwd ) (return relDir) exists <- dirExists absDir if exists then throwM (AlreadyExists absDir) else do logUsing relDir templateText <- loadTemplate template files <- applyTemplate project absDir templateText writeTemplateFiles files runTemplateInits absDir return absDir where template = newOptsTemplate opts project = newOptsProjectName opts logUsing relDir = $logInfo ("Downloading template \"" <> templateName template <> "\" to create project \"" <> packageNameText project <> "\" in " <> T.pack (toFilePath relDir) <> " ...") -- | Download and read in a template's text content. loadTemplate :: (HasConfig r, HasHttpManager r, MonadReader r m, MonadIO m, MonadThrow m, MonadCatch m) => TemplateName -> m Text loadTemplate name = do req <- parseUrl (defaultTemplateUrl <> "/" <> toFilePath (templatePath name)) config <- asks getConfig let path = templatesDir config templatePath name _ <- catch (redownload req path) (throwM . FailedToDownloadTemplate name) exists <- fileExists path if exists then liftIO (T.readFile (toFilePath path)) else throwM (FailedToLoadTemplate name path) -- | Apply and unpack a template into a directory. applyTemplate :: (MonadIO m, MonadThrow m, MonadReader r m, HasConfig r, MonadLogger m) => PackageName -> Path Abs Dir -> Text -> m (Map (Path Abs File) LB.ByteString) applyTemplate project dir template = do config <- asks getConfig displayContext config applied <- hastacheStr defaultConfig template (mkStrContext (contextFunction config)) files :: Map FilePath LB.ByteString <- execWriterT $ yield (T.encodeUtf8 (LT.toStrict applied)) $$ unpackTemplate receiveMem id liftM M.fromList (mapM (\(fp,bytes) -> do path <- parseRelFile fp return (dir path, bytes)) (M.toList files)) where context config = [ ("name", packageNameText project) , ( authorEmailKey , fromMaybe defaultAuthorEmail (configAuthorEmail config)) , (authorNameKey, fromMaybe defaultAuthorName (configAuthorName config))] contextFunction :: Config -> String -> MuType m contextFunction config key = case lookup (T.pack key) (context config) of Nothing -> MuNothing Just value -> MuVariable value -- | Display the context being used for the template. displayContext :: MonadLogger m => Config -> m () displayContext config = do $logInfo "Using the following authorship configuration:" $logInfo (authorEmailKey <> ": " <> fromMaybe defaultAuthorEmail (configAuthorEmail config)) $logInfo (authorNameKey <> ": " <> fromMaybe defaultAuthorName (configAuthorName config)) $logInfo ("Copy these to " <> T.pack (toFilePath (globalConfigPath config)) <> " and edit to use different values.") -- | Write files to the new project directory. writeTemplateFiles :: MonadIO m => Map (Path Abs File) LB.ByteString -> m () writeTemplateFiles files = do forM_ (M.toList files) (\(fp,bytes) -> do createTree (parent fp) liftIO (LB.writeFile (toFilePath fp) bytes)) -- | Run any initialization functions, such as Git. runTemplateInits :: (MonadIO m, MonadReader r m, HasConfig r, MonadLogger m, MonadCatch m) => Path Abs Dir -> m () runTemplateInits dir = do menv <- getMinimalEnvOverride config <- asks getConfig case configScmInit config of Nothing -> return () Just Git -> do catch (callProcess (Just dir) menv "git" ["init"]) (\(_ :: ProcessExitedUnsuccessfully) -> $logInfo "git init failed to run, ignoring ...") -------------------------------------------------------------------------------- -- Getting templates list listTemplates :: (MonadIO m, MonadThrow m, MonadReader r m, HasHttpManager r, MonadCatch m, MonadLogger m) => m () listTemplates = do templates <- getTemplates mapM_ ($logInfo . templateName) (S.toList templates) -- | Get the set of templates. getTemplates :: (MonadIO m, MonadThrow m, MonadReader r m, HasHttpManager r, MonadCatch m) => m (Set TemplateName) getTemplates = do req <- liftM addHeaders (parseUrl defaultTemplatesList) resp <- catch (httpLbs req) (throwM . FailedToDownloadTemplates) case statusCode (responseStatus resp) of 200 -> case eitherDecode (responseBody resp) >>= parseEither parseTemplateSet of Left err -> throwM (BadTemplatesJSON err (responseBody resp)) Right value -> return value code -> throwM (BadTemplatesResponse code) where addHeaders req = req { requestHeaders = [ ("User-Agent", "The Haskell Stack") , ("Accept", "application/vnd.github.v3+json")] <> requestHeaders req } -- | Parser the set of templates from the JSON. parseTemplateSet :: Value -> Parser (Set TemplateName) parseTemplateSet a = do xs <- parseJSON a fmap (S.fromList . catMaybes) (mapM parseTemplate xs) where parseTemplate v = do o <- parseJSON v name <- o .: "name" if isSuffixOf ".hsfiles" name then case parseTemplateNameFromString name of Left{} -> fail ("Unable to parse template name from " <> name) Right template -> return (Just template) else return Nothing -------------------------------------------------------------------------------- -- Defaults -- | The default template name you can use if you don't have one. defaultTemplateName :: TemplateName defaultTemplateName = $(mkTemplateName "new-template") -- | Default web root URL to download from. defaultTemplateUrl :: String defaultTemplateUrl = "https://raw.githubusercontent.com/commercialhaskell/stack-templates/master" -- | Default web URL to list the repo contents. defaultTemplatesList :: String defaultTemplatesList = "https://api.github.com/repos/commercialhaskell/stack-templates/contents/" -------------------------------------------------------------------------------- -- Exceptions -- | Exception that might occur when making a new project. data NewException = FailedToLoadTemplate !TemplateName !(Path Abs File) | FailedToDownloadTemplate !TemplateName !DownloadException | FailedToDownloadTemplates !HttpException | BadTemplatesResponse !Int | BadTemplatesJSON !String !LB.ByteString | AlreadyExists !(Path Abs Dir) deriving (Typeable) instance Exception NewException instance Show NewException where show (FailedToLoadTemplate name path) = "Failed to load download template " <> T.unpack (templateName name) <> " from " <> toFilePath path show (FailedToDownloadTemplate name (RedownloadFailed _ _ resp)) = case statusCode (responseStatus resp) of 404 -> "That template doesn't exist. Run `stack templates' to see a list of available templates." code -> "Failed to download template " <> T.unpack (templateName name) <> ": unknown reason, status code was: " <> show code show (FailedToDownloadTemplate name _) = "Failed to download template " <> T.unpack (templateName name) <> ", reason unknown." show (AlreadyExists path) = "Directory " <> toFilePath path <> " already exists. Aborting." show (FailedToDownloadTemplates ex) = "Failed to download templates. The HTTP error was: " <> show ex show (BadTemplatesResponse code) = "Unexpected status code while retrieving templates list: " <> show code show (BadTemplatesJSON err bytes) = "Github returned some JSON that couldn't be parsed: " <> err <> "\n\n" <> L8.unpack bytes