summaryrefslogtreecommitdiff
path: root/src/Propellor/DotDir.hs
blob: bf7550d5d95b3d091f9a50d1ec292ed539371694 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
module Propellor.DotDir where

import Propellor.Message
import Propellor.Bootstrap
import Propellor.Git
import Propellor.Gpg
import Utility.UserInfo
import Utility.Monad
import Utility.Process
import Utility.SafeCommand
import Utility.Exception
import Utility.Path

import Data.Char
import Data.List
import Control.Monad
import Control.Monad.IfElse
import System.Directory
import System.FilePath
import System.Posix.Directory
import System.IO
import Control.Applicative
import Prelude

distdir :: FilePath
distdir = "/usr/src/propellor"

-- A distribution may include a bundle of propellor's git repository here.
-- If not, it will be pulled from the network when needed.
distrepo :: FilePath
distrepo = distdir </> "propellor.git"

-- File containing the head rev of the distrepo.
disthead :: FilePath
disthead = distdir </> "head"

upstreambranch :: String
upstreambranch = "upstream/master"

-- Using the github mirror of the main propellor repo because
-- it is accessible over https for better security.
netrepo :: String
netrepo = "https://github.com/joeyh/propellor.git"

dotPropellor :: IO FilePath
dotPropellor = do
	home <- myHomeDir
	return (home </> ".propellor")

interactiveInit :: IO ()
interactiveInit = ifM (doesDirectoryExist =<< dotPropellor)
	( error "~/.propellor/ already exists, not doing anything"
	, do
		welcomeBanner
		setup
	)

welcomeBanner :: IO ()
welcomeBanner = putStr $ unlines $ map prettify
	[ ""
	, ""
	, "                                 _         ______`|                       ,-.__"
	, " .---------------------------  /   ~___-=O`/|O`/__|                      (____.'"
	, "  - Welcome to              -- ~          / | /    )          _.-'-._"
	, "  -            Propellor!   --  `/-==__ _/__|/__=-|          (       ~_"
	, " `---------------------------   *             ~ | |           '--------'"
	, "                                            (o)  `"
	, ""
	, ""
	]
  where
	prettify = map (replace '~' '\\')
	replace x y c
		| c == x = y
		| otherwise = c

prompt :: String -> [(String, IO ())] -> IO ()
prompt p cs = do
	putStr (p ++ " [" ++ intercalate "|" (map fst cs) ++ "] ")
	hFlush stdout
	r <- map toLower <$> getLine
	if null r
		then snd (head cs) -- default to first choice on return
		else case filter (\(s, _) -> map toLower s == r) cs of
			[(_, a)] -> a
			_ -> do
				putStrLn "Not a valid choice, try again.. (Or ctrl-c to quit)"
				prompt p cs

section :: IO ()
section = do
	putStrLn ""
	putStrLn "------------------------------------------------------------------------------"
	putStrLn ""

setup :: IO ()
setup = do
	dotpropellor <- dotPropellor
	putStrLn "Propellor's configuration file is ~/.propellor/config.hs"
	putStrLn ""
	putStrLn "Lets get you started with a simple config that you can adapt"
	putStrLn "to your needs. You can start with:"
	putStrLn "   A: A clone of propellor's git repository    (most flexible)"
	putStrLn "   B: The bare minimum files to use propellor  (most simple)"
	prompt "Which would you prefer?"
		[ ("A", fullClone)
		, ("B", minimalConfig)
		]
	putStrLn "Ok, ~/.propellor/config.hs is set up!"
	changeWorkingDirectory dotpropellor

	section
	putStrLn "Let's try building the propellor configuration, to make sure it will work..."
	putStrLn ""
	buildPropellor Nothing
	putStrLn ""
	putStrLn "Great! Propellor is bootstrapped."
	
	section
	putStrLn "Propellor can use gpg to encrypt private data about the systems it manages,"
	putStrLn "and to sign git commits."
	gpg <- getGpgBin
	ifM (inPath gpg)
		( setupGpgKey
		, do
			putStrLn "You don't seem to have gpg installed, so skipping setting it up."
			explainManualSetupGpgKey
		)

	section
	putStrLn "Everything is set up ..."
	putStrLn "Your next step is to edit ~/.propellor/config.hs,"
	putStrLn "and run propellor again to try it out."
	putStrLn ""
	putStrLn "For docs, see https://propellor.branchable.com/"
	putStrLn "Enjoy propellor!"

explainManualSetupGpgKey :: IO ()
explainManualSetupGpgKey = do
	putStrLn "Propellor can still be used without gpg, but it won't be able to"
	putStrLn "manage private data. You can set this up later:"
	putStrLn " 1. gpg --gen-key"
	putStrLn " 2. propellor --add-key (pass it the key ID generated in step 1)"

setupGpgKey :: IO ()
setupGpgKey = do
	ks <- listSecretKeys
	putStrLn ""
	case ks of
		[] -> makeGpgKey
		[(k, d)] -> do
			putStrLn $ "You have one gpg key: " ++ desckey k d
			prompt "Should propellor use that key?" 
				[ ("Y", propellorAddKey k)
				, ("N", putStrLn $ "Skipping gpg setup. If you change your mind, run: propellor --add-key " ++ k)
				]
		_ -> do
			let nks = zip ks (map show ([1..] :: [Integer]))
			putStrLn "I see you have several gpg keys:"
			forM_ nks $ \((k, d), n) ->
				putStrLn $ "   " ++ n ++ "   " ++ desckey k d
			prompt "Which of your gpg keys should propellor use?"
				(map (\((k, _), n) -> (n, propellorAddKey k)) nks)
  where
	desckey k d = d ++ "  (keyid " ++ k ++ ")"

makeGpgKey :: IO ()
makeGpgKey = do
	putStrLn "You seem to not have any gpg secret keys."
	prompt "Would you like to create one now?"
		[("Y", rungpg), ("N", nope)]
  where
	nope = do
		putStrLn "No problem."
		explainManualSetupGpgKey
	rungpg = do
		putStrLn "Running gpg --gen-key ..."
		gpg <- getGpgBin
		void $ boolSystem gpg [Param "--gen-key"]
		ks <- listSecretKeys
		case ks of
			[] -> do
				putStrLn "Hmm, gpg seemed to not set up a secret key."
				prompt "Want to try running gpg again?"
					[("Y", rungpg), ("N", nope)]
			((k, _):_) -> propellorAddKey k

propellorAddKey :: String -> IO ()
propellorAddKey keyid = do
	putStrLn ""
	putStrLn $ "Telling propellor to use your gpg key by running: propellor --add-key " ++ keyid
	d <- dotPropellor
	unlessM (boolSystem (d </> "propellor") [Param "--add-key", Param keyid]) $ do
		putStrLn "Oops, that didn't work! You can retry the same command later."
		putStrLn "Continuing onward ..."

minimalConfig :: IO ()
minimalConfig = do
	d <- dotPropellor
	createDirectoryIfMissing True d
	let cabalfile = d </> "config.cabal"
	let configfile = d </> "config.hs"
	writeFile cabalfile (unlines cabalcontent)
	writeFile configfile (unlines configcontent)
	changeWorkingDirectory d
	void $ boolSystem "git" [Param "init"]
	void $ boolSystem "git" [Param "add" , File cabalfile, File configfile]
  where
	cabalcontent =
		[ "-- This is a cabal file to use to build your propellor configuration."
		, "-- https://propellor.branchable.com/"
		, ""
		, "Name: config"
		, "Cabal-Version: >= 1.6"
		, "Build-Type: Simple"
		, "Version: 0"
		, ""
		, "Executable propellor-config"
		, "  Main-Is: config.hs"
		, "  GHC-Options: -threaded -Wall -fno-warn-tabs -O0"
		, "  Extensions: TypeOperators"
		, "  Build-Depends: propellor >= 3.0, base >= 3"
		]
	configcontent = 
		[ "-- This is the main configuration file for Propellor, and is used to build"
		, "-- the propellor program."
		, ""
		, "import Propellor"
		, "import qualified Propellor.Property.File as File"
		, "import qualified Propellor.Property.Apt as Apt"
		, "import qualified Propellor.Property.Cron as Cron"
		, "import qualified Propellor.Property.User as User"
		, ""
		, "main :: IO ()"
		, "main = defaultMain hosts"
		, ""
		, "-- The hosts propellor knows about."
		, "hosts :: [Host]"
		, "hosts ="
		, "        [ mybox"
		, "        ]"
		, ""
		, "-- An example host."
		, "mybox :: Host"
		, "mybox = host \"mybox.example.com\" $ props"
		, "        & osDebian Unstable \"amd64\""
		, "        & Apt.stdSourcesList"
		, "        & Apt.unattendedUpgrades"
		, "        & Apt.installed [\"etckeeper\"]"
		, "        & Apt.installed [\"ssh\"]"
		, "        & User.hasSomePassword (User \"root\")"
		, "        & File.dirExists \"/var/www\""
		, "        & Cron.runPropellor (Cron.Times \"30 * * * *\")"
		, ""
		]

fullClone :: IO ()
fullClone = do
	d <- dotPropellor
	ifM (doesFileExist distrepo <||> doesDirectoryExist distrepo)
		( do			
			void $ boolSystem "git" [Param "clone", File distrepo, File d]
			fetchUpstreamBranch distrepo
			changeWorkingDirectory d
			void $ boolSystem "git" [Param "remote", Param "rm", Param "origin"]
		, do
			void $ boolSystem "git" [Param "clone", Param netrepo, File d]
			changeWorkingDirectory d
			-- Rename origin to upstream and avoid
			-- git push to that read-only repo.
			void $ boolSystem "git" [Param "remote", Param "rename", Param "origin", Param "upstream"]
			void $ boolSystem "git" [Param "config", Param "--unset", Param "branch.master.remote", Param "upstream"]
		)

fetchUpstreamBranch :: FilePath -> IO ()
fetchUpstreamBranch repo = do
	changeWorkingDirectory =<< dotPropellor
	void $ boolSystem "git"
		[ Param "fetch"
		, File repo
		, Param ("+refs/heads/master:refs/remotes/" ++ upstreambranch)
		, Param "--quiet"
		]

checkRepoUpToDate :: IO ()
checkRepoUpToDate = whenM (gitbundleavail <&&> dotpropellorpopulated) $ do
	headrev <- takeWhile (/= '\n') <$> readFile disthead
	changeWorkingDirectory =<< dotPropellor
	headknown <- catchMaybeIO $ 
		withQuietOutput createProcessSuccess $
			proc "git" ["log", headrev]
	if (headknown == Nothing)
		then setupUpstreamMaster headrev
		else do
			theirhead <- getCurrentGitSha1 =<< getCurrentBranchRef
			when (theirhead /= headrev) $ do
				merged <- not . null <$>
					readProcess "git" ["log", headrev ++ "..HEAD", "--ancestry-path"]
				unless merged $
					warnoutofdate True
  where
	gitbundleavail = doesFileExist disthead
	dotpropellorpopulated = do
		d <- dotPropellor
		doesFileExist (d </> "propellor.cabal")

-- Passed the user's dotpropellor repository, makes upstream/master
-- be a usefully mergeable branch.
--
-- We cannot just use origin/master, because in the case of a distrepo,
-- it only contains 1 commit. So, trying to merge with it will result
-- in lots of merge conflicts, since git cannot find a common parent
-- commit.
--
-- Instead, the upstream/master branch is created by taking the
-- upstream/master branch (which must be an old version of propellor,
-- as distributed), and diffing from it to the current origin/master,
-- and committing the result. This is done in a temporary clone of the
-- repository, giving it a new master branch. That new branch is fetched
-- into the user's repository, as if fetching from a upstream remote,
-- yielding a new upstream/master branch.
setupUpstreamMaster :: String -> IO ()
setupUpstreamMaster newref = do
	changeWorkingDirectory =<< dotPropellor
	go =<< catchMaybeIO getoldrev
  where
	go Nothing = warnoutofdate False
	go (Just oldref) = do
		let tmprepo = ".git/propellordisttmp"
		let cleantmprepo = void $ catchMaybeIO $ removeDirectoryRecursive tmprepo
		cleantmprepo
		git ["clone", "--quiet", ".", tmprepo]
	
		changeWorkingDirectory tmprepo
		git ["fetch", distrepo, "--quiet"]
		git ["reset", "--hard", oldref, "--quiet"]
		git ["merge", newref, "-s", "recursive", "-Xtheirs", "--quiet", "-m", "merging upstream version"]
	
		fetchUpstreamBranch tmprepo
		cleantmprepo
		warnoutofdate True

	getoldrev = takeWhile (/= '\n')
		<$> readProcess "git" ["show-ref", upstreambranch, "--hash"]
	
	git = run "git"
	run cmd ps = unlessM (boolSystem cmd (map Param ps)) $
		error $ "Failed to run " ++ cmd ++ " " ++ show ps

warnoutofdate :: Bool -> IO ()
warnoutofdate havebranch = do
	warningMessage ("** Your ~/.propellor/ is out of date..")
	let also s = hPutStrLn stderr ("   " ++ s)
	also ("A newer upstream version is available in " ++ distrepo)
	if havebranch
		then also ("To merge it, run: git merge " ++ upstreambranch)
		else also ("To merge it, find the most recent commit in your repository's history that corresponds to an upstream release of propellor, and set refs/remotes/" ++ upstreambranch ++ " to it. Then run propellor again.")
	also ""