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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
//! A unit of work. Does a single thing and DOES IT WELL.

use crate::{
    git::GitSystem, hierarchy::Data, os, packages, packages::PackageManager, state::State,
    FileSystem, Timestamp,
};
use anyhow::{anyhow, Context as _, Error};
use std::collections::BTreeSet;
use std::fmt;
use std::path::{Path, PathBuf};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::SystemTime;
use thiserror::Error;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Dependency {
    /// Someone providing a file.
    /// The file is aliased by FileSystem.
    File(UnitId),
    /// Someone providing a directory.
    /// The file is aliased by FileSystem.
    Dir(UnitId),
    /// Direct dependency on other unit.
    Unit(UnitId),
}

#[derive(Error, Debug)]
pub struct RenderError(PathBuf);

impl fmt::Display for RenderError {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(fmt, "failed to render: {}", self.0.display())
    }
}

pub type UnitId = usize;

#[derive(Debug, Default)]
pub struct UnitAllocator {
    current: AtomicUsize,
}

impl UnitAllocator {
    /// Create a new system unit.
    pub fn unit(&self, unit: impl Into<Unit>) -> SystemUnit {
        let id = self.allocate();
        SystemUnit::new(id, unit)
    }

    /// Allocate a new unit id.
    pub fn allocate(&self) -> UnitId {
        self.current.fetch_add(1, Ordering::Relaxed)
    }
}

/// All inputs for a system.
pub struct UnitInput<'a, 's> {
    /// Primary package manager.
    pub packages: &'a packages::Provider,
    /// Data loaded from the hierarchy.
    pub data: &'a Data,
    /// Read-only state.
    /// If none, the read state is the mutated state.
    pub read_state: &'a State<'s>,
    /// Unit-local state that can be mutated.
    pub state: &'a mut State<'s>,
    /// Current timestamp.
    pub now: Timestamp,
    /// Current git system.
    pub git_system: &'a dyn GitSystem,
}

/// Declare unit enum.
macro_rules! unit {
    ($($name:ident,)*) => {
        /// A single unit of work.
        #[derive(Debug)]
        pub enum Unit {
            System,
            $($name($name),)*
        }

        impl Unit {
            pub fn apply(&self, input: UnitInput) -> Result<(), Error> {
                use self::Unit::*;

                let res = match *self {
                    // do nothing.
                    System => Ok(()),
                    // do something.
                    $($name(ref unit) => unit.apply(input),)*
                };

                res.with_context(|| anyhow!("Failed to run unit: {:?}", self))
            }
        }

        impl fmt::Display for Unit {
            fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
                use self::Unit::*;

                match *self {
                    System => write!(fmt, "system unit"),
                    $($name(ref unit) => unit.fmt(fmt),)*
                }
            }
        }
    }
}

unit![
    FromDb,
    CopyFile,
    CopyTemplate,
    Symlink,
    CreateDir,
    Install,
    Download,
    AddMode,
    RunOnce,
    GitClone,
    GitUpdate,
];

/// A system unit, which is a unit coupled with a set of dependencies.
#[derive(Debug)]
pub struct SystemUnit {
    /// The ID of this unit.
    pub id: UnitId,
    /// Dependencies of this unit.
    pub dependencies: Vec<Dependency>,
    /// Dependencies that this unit provides.
    pub provides: Vec<Dependency>,
    /// Whether the unit needs access to the main thread. For example, for user input.
    pub thread_local: bool,
    /// The unit of work.
    /// Note: box to make it cheaper to move.
    unit: Box<Unit>,
}

impl fmt::Display for SystemUnit {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(
            fmt,
            "unit({:03}): {} (depends: {:?})",
            self.id, self.unit, self.dependencies
        )
    }
}

impl SystemUnit {
    /// Create a new system unit.
    pub fn new(id: UnitId, unit: impl Into<Unit>) -> Self {
        SystemUnit {
            id,
            dependencies: Vec::new(),
            provides: Vec::new(),
            thread_local: false,
            unit: Box::new(unit.into()),
        }
    }

    /// Apply the unit of work.
    pub fn apply(&self, input: UnitInput) -> Result<(), Error> {
        self.unit.apply(input)
    }
}

/// The configuration for a unit to copy a single file.
#[derive(Debug, Hash)]
pub struct FromDb {
    pub(crate) system: String,
    pub(crate) key: String,
}

impl fmt::Display for FromDb {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(
            fmt,
            "unit `{}` from database key `{}`",
            self.system, self.key
        )
    }
}

impl FromDb {
    fn apply(&self, _: UnitInput) -> Result<(), Error> {
        Ok(())
    }
}

impl From<FromDb> for Unit {
    fn from(value: FromDb) -> Unit {
        Unit::FromDb(value)
    }
}

/// The configuration to create a single directory.
#[derive(Debug)]
pub struct CreateDir(pub PathBuf);

impl fmt::Display for CreateDir {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(fmt, "create directory {}", self.0.display())
    }
}

impl CreateDir {
    fn apply(&self, _: UnitInput) -> Result<(), Error> {
        use std::fs;
        let CreateDir(ref dir) = self;
        log::info!("creating dir: {}", dir.display());
        fs::create_dir(dir)?;
        Ok(())
    }
}

impl From<CreateDir> for Unit {
    fn from(value: CreateDir) -> Unit {
        Unit::CreateDir(value)
    }
}

/// The configuration for a unit to copy a single file.
#[derive(Debug, Hash)]
pub struct CopyFile {
    /// The source file.
    pub from: PathBuf,
    /// Source file modification time.
    pub from_modified: SystemTime,
    /// The destination file.
    pub to: PathBuf,
}

impl fmt::Display for CopyFile {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(
            fmt,
            "copy file {} -> {}",
            self.from.display(),
            self.to.display()
        )
    }
}

impl CopyFile {
    fn apply(&self, _: UnitInput) -> Result<(), Error> {
        use std::fs::File;
        use std::io;

        let CopyFile {
            ref from,
            ref from_modified,
            ref to,
        } = *self;

        log::info!("{} -> {}", from.display(), to.display());
        io::copy(&mut File::open(from)?, &mut File::create(to)?)?;
        // make sure timestamp is in sync.
        FileSystem::touch(to, from_modified)
    }
}

impl From<CopyFile> for Unit {
    fn from(value: CopyFile) -> Unit {
        Unit::CopyFile(value)
    }
}

/// The configuration for a unit to copy a single file.
#[derive(Debug, Hash)]
pub struct CopyTemplate {
    /// The source file.
    pub from: PathBuf,
    /// Source file modification time.
    pub from_modified: SystemTime,
    /// The destination file.
    pub to: PathBuf,
    /// If the destination file exists, we assume that its content is the same.
    pub to_exists: bool,
}

impl fmt::Display for CopyTemplate {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(
            fmt,
            "template file {} -> {}",
            self.from.display(),
            self.to.display()
        )
    }
}

impl CopyTemplate {
    /// Construct the ID for this unit.
    fn id(&self) -> String {
        use std::hash::{Hash, Hasher};

        let mut state = fxhash::FxHasher64::default();
        self.hash(&mut state);

        format!("copy-template/{:x}", state.finish())
    }

    fn apply(&self, input: UnitInput) -> Result<(), Error> {
        use handlebars::{Context, Handlebars, Output, RenderContext, Renderable, Template};
        use std::fs::{self, File};
        use std::io::{self, Cursor, Write};

        let CopyTemplate {
            ref from,
            ref from_modified,
            ref to,
            to_exists,
        } = *self;

        let UnitInput {
            data,
            read_state,
            state,
            ..
        } = input;

        // We do some extra work in here that we would usually split up into more units.
        // The reason is that we can't efficiently determine if that work should be done without
        // doing a lot of it up front.
        //
        // This includes:
        // * Reading the template file to determine which database variables to use.

        let content = fs::read_to_string(from)
            .map_err(|e| anyhow!("failed to read path: {}: {}", from.display(), e))?;

        let data = data.load_from_spec(&content).map_err(|e| {
            anyhow!(
                "failed to load hierarchy for path: {}: {}",
                from.display(),
                e
            )
        })?;

        let id = self.id();
        let hash = (&data, &content);

        if to_exists && read_state.is_hash_fresh(&id, hash)? {
            // Nothing about the template would change, only update the modified time of the file.
            log::info!("touching {}", to.display());
            // only need to update timestamp.
            return FileSystem::touch(to, from_modified);
        }

        let reg = Handlebars::new();

        let mut out = Vec::<u8>::new();

        let mut tpl = Template::compile(&content)?;
        tpl.name = Some(from.display().to_string());

        tpl.render(
            &reg,
            &Context::wraps(&data)?,
            &mut RenderContext::new(None),
            &mut WriteOutput::new(Cursor::new(&mut out)),
        )?;

        log::info!("{} -> {} (template)", from.display(), to.display());
        File::create(to)?.write_all(&out)?;
        state.touch_hash(&id, hash)?;
        return FileSystem::touch(to, from_modified);

        pub struct WriteOutput<W: Write> {
            write: W,
        }

        impl<W: Write> Output for WriteOutput<W> {
            fn write(&mut self, seg: &str) -> Result<(), io::Error> {
                self.write.write_all(seg.as_bytes())
            }
        }

        impl<W: Write> WriteOutput<W> {
            pub fn new(write: W) -> WriteOutput<W> {
                WriteOutput { write }
            }
        }
    }
}

impl From<CopyTemplate> for Unit {
    fn from(value: CopyTemplate) -> Unit {
        Unit::CopyTemplate(value)
    }
}

/// The configuration for a unit to create a symlink.
#[derive(Debug)]
pub struct Symlink {
    /// `true` if the destination file needs to be removed.
    pub remove: bool,
    /// destination file to create.
    pub path: PathBuf,
    /// link to set up.
    pub link: PathBuf,
}

impl fmt::Display for Symlink {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(
            fmt,
            "link file {} to {}",
            self.path.display(),
            self.link.display()
        )
    }
}

impl Symlink {
    fn apply(&self, _: UnitInput) -> Result<(), Error> {
        os::create_symlink(self)
    }
}

impl From<Symlink> for Unit {
    fn from(value: Symlink) -> Unit {
        Unit::Symlink(value)
    }
}

/// Install a number of packages.
#[derive(Debug)]
pub struct Install {
    pub package_manager: Arc<dyn PackageManager>,
    pub all_packages: BTreeSet<String>,
    pub to_install: Vec<String>,
    pub id: String,
}

impl fmt::Display for Install {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        if self.to_install.is_empty() {
            return write!(fmt, "install packages");
        }

        let names = self.to_install.join(", ");
        write!(fmt, "{}: install packages: {}", self.id, names)
    }
}

impl Install {
    fn apply(&self, input: UnitInput) -> Result<(), Error> {
        let UnitInput { state, .. } = input;

        let Install {
            ref package_manager,
            ref all_packages,
            ref to_install,
            ref id,
        } = *self;

        if !to_install.is_empty() {
            let names = to_install.join(", ");
            log::info!("Installing packages for `{}`: {}", id, names);
            package_manager.install_packages(to_install)?;
        }

        state.touch_hash(id, all_packages)?;
        Ok(())
    }
}

impl From<Install> for Unit {
    fn from(value: Install) -> Unit {
        Unit::Install(value)
    }
}

/// Download the given URL as an executable and write to the given path.
#[derive(Debug)]
pub struct Download {
    pub url: reqwest::Url,
    pub path: PathBuf,
    pub id: Option<Box<str>>,
}

impl fmt::Display for Download {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(fmt, "download {} to {}", self.url, self.path.display())
    }
}

impl Download {
    fn apply(&self, input: UnitInput) -> Result<(), Error> {
        use std::fs::File;
        let UnitInput { state, .. } = input;
        let Download { url, path, id } = self;

        if !path.is_file() {
            let mut out =
                File::create(path).with_context(|| anyhow!("open file: {}", path.display()))?;

            let mut response = reqwest::blocking::get(url.clone())
                .with_context(|| anyhow!("download url: {}", url))?;

            response.copy_to(&mut out)?;
        }

        if let Some(id) = id {
            state.touch_once(id);
        }

        Ok(())
    }
}

impl From<Download> for Unit {
    fn from(value: Download) -> Unit {
        Unit::Download(value)
    }
}

/// Mode modifications to apply.
#[repr(u32)]
pub enum Mode {
    Execute = 1,
    Read = 2,
    Write = 4,
}

/// Change the permissions of the given file.
#[derive(Debug)]
pub struct AddMode {
    pub path: PathBuf,
    user: u32,
    group: u32,
    other: u32,
}

impl AddMode {
    /// Create a new add mode unit.
    pub fn new<P>(path: &P) -> Self
    where
        P: ?Sized + AsRef<Path>,
    {
        Self {
            path: path.as_ref().to_owned(),
            user: 0,
            group: 0,
            other: 0,
        }
    }

    /// If the added mode is executable.
    pub fn is_executable(&self) -> bool {
        if self.user & (Mode::Execute as u32) != 0 {
            return true;
        }

        if self.group & (Mode::Execute as u32) != 0 {
            return true;
        }

        if self.other & (Mode::Execute as u32) != 0 {
            return true;
        }

        false
    }

    /// Modify user mode.
    pub fn user(mut self, mode: Mode) -> Self {
        self.user |= mode as u32;
        self
    }

    /// Modify group mode.
    pub fn group(mut self, mode: Mode) -> Self {
        self.group |= mode as u32;
        self
    }

    /// Modify other mode.
    pub fn other(mut self, mode: Mode) -> Self {
        self.other |= mode as u32;
        self
    }
}

impl AddMode {
    /// Convert into a unix mode.
    pub fn unix_mode(&self) -> u32 {
        let AddMode {
            user, group, other, ..
        } = *self;

        (user << (3 * 2)) + (group << 3) + other
    }
}

impl fmt::Display for AddMode {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(
            fmt,
            "add mode {:o} to {}",
            self.unix_mode(),
            self.path.display()
        )
    }
}

impl AddMode {
    fn apply(&self, _: UnitInput) -> Result<(), Error> {
        os::add_mode(self)
    }
}

impl From<AddMode> for Unit {
    fn from(value: AddMode) -> Unit {
        Unit::AddMode(value)
    }
}

/// Run the given executable once.
#[derive(Debug)]
pub struct RunOnce {
    /// ID to mark once run.
    pub id: String,
    /// Path to run.
    pub path: PathBuf,
    /// Run using a shell.
    pub shell: bool,
    /// Run as root or super user.
    pub root: bool,
    /// Arguments to add when running the command.
    pub args: Vec<String>,
}

impl fmt::Display for RunOnce {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(fmt, "run `{}` once as `{}`", self.path.display(), self.id)
    }
}

impl RunOnce {
    /// Construct a new RunOnce.
    pub fn new(id: String, path: PathBuf) -> RunOnce {
        RunOnce {
            id,
            path,
            shell: false,
            root: false,
            args: Vec::new(),
        }
    }

    /// Apply the unit.
    fn apply(&self, input: UnitInput) -> Result<(), Error> {
        use crate::command::Command;
        use std::io;

        let UnitInput { state, .. } = input;

        let RunOnce {
            ref id,
            ref path,
            shell,
            root,
            ref args,
        } = *self;

        if self.args.is_empty() {
            log::info!("running: {}", path.display());
        } else {
            log::info!("running: {} {}", path.display(), self.args.join(" "));
        }

        let status = run_command(path, root, shell, args)
            .with_context(|| anyhow!("failed to run: {}", path.display()))?;

        if status != 0 {
            return Err(anyhow!(
                "failed to run `{}`: status={}",
                path.display(),
                status
            ));
        }

        state.touch_once(id);
        return Ok(());

        #[cfg(windows)]
        fn run_command(
            path: &Path,
            root: bool,
            _shell: bool,
            args: &Vec<String>,
        ) -> io::Result<i32> {
            let mut cmd = Command::new(path);
            cmd.args(args);

            Ok(if root {
                cmd.runas()?
            } else {
                let status = cmd.status()?;
                status
                    .code()
                    .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "no status code"))?
            })
        }

        #[cfg(not(windows))]
        fn run_command(
            path: &Path,
            root: bool,
            shell: bool,
            args: &Vec<String>,
        ) -> io::Result<i32> {
            let mut cmd = if root {
                let mut cmd = Command::new("sudo");
                cmd.args(&["-p", "[sudo] password for %u to run downloaded exe: ", "--"]);

                if shell {
                    cmd.arg("/bin/sh");
                    cmd.arg("--");
                    cmd.arg(path);
                } else {
                    cmd.arg(path);
                }

                cmd
            } else if shell {
                let mut cmd = Command::new("/bin/sh");
                cmd.arg(path);
                cmd
            } else {
                Command::new(path)
            };

            cmd.args(args);
            let status = cmd.status()?;
            let code = status
                .code()
                .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "no status code"))?;
            Ok(code)
        }
    }
}

impl From<RunOnce> for Unit {
    fn from(value: RunOnce) -> Unit {
        Unit::RunOnce(value)
    }
}

/// Run the given executable once.
#[derive(Debug)]
pub struct GitClone {
    /// The ID of the thing being cloned.
    pub id: String,
    /// Remote to clone.
    pub remote: String,
    /// Git repository.
    pub path: PathBuf,
}

impl fmt::Display for GitClone {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(
            fmt,
            "git clone `{}` to `{}`",
            self.remote,
            self.path.display()
        )
    }
}

impl GitClone {
    /// Apply the unit.
    fn apply(&self, input: UnitInput) -> Result<(), Error> {
        let UnitInput {
            state, git_system, ..
        } = input;

        let GitClone {
            ref id,
            ref remote,
            ref path,
        } = *self;

        log::info!("Cloning `{}` into `{}`", remote, path.display());
        GitSystem::clone(git_system, remote, path)?;
        state.touch(id);
        Ok(())
    }
}

impl From<GitClone> for Unit {
    fn from(value: GitClone) -> Unit {
        Unit::GitClone(value)
    }
}

/// Run the given executable once.
#[derive(Debug)]
pub struct GitUpdate {
    /// The ID of the thing being cloned.
    pub id: String,
    /// Git repository.
    pub path: PathBuf,
    /// If the update should be forced.
    pub force: bool,
}

impl fmt::Display for GitUpdate {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(fmt, "git update: {}", self.path.display())
    }
}

impl GitUpdate {
    /// Apply the unit.
    fn apply(&self, input: UnitInput) -> Result<(), Error> {
        let UnitInput {
            state, git_system, ..
        } = input;

        let GitUpdate {
            ref id,
            ref path,
            force,
        } = *self;

        let git = git_system.open(path)?;

        if git.needs_update()? {
            if force {
                log::info!("Force updating `{}`", git.path().display());
                git.force_update()?;
            } else {
                log::info!("Updating `{}`", git.path().display());
                git.update()?;
            }
        }

        state.touch(id);
        Ok(())
    }
}

impl From<GitUpdate> for Unit {
    fn from(value: GitUpdate) -> Unit {
        Unit::GitUpdate(value)
    }
}