#pragma once

#include "types.hh"
#include "serialise.hh"


namespace nix {


/* dumpPath creates a Nix archive of the specified path.  The format
   is as follows:

   IF path points to a REGULAR FILE:
     dump(path) = attrs(
       [ ("type", "regular")
       , ("contents", contents(path))
       ])

   IF path points to a DIRECTORY:
     dump(path) = attrs(
       [ ("type", "directory")
       , ("entries", concat(map(f, sort(entries(path)))))
       ])
       where f(fn) = attrs(
         [ ("name", fn)
         , ("file", dump(path + "/" + fn))
         ])

   where:

     attrs(as) = concat(map(attr, as)) + encN(0)
     attrs((a, b)) = encS(a) + encS(b)

     encS(s) = encN(len(s)) + s + (padding until next 64-bit boundary)

     encN(n) = 64-bit little-endian encoding of n.

     contents(path) = the contents of a regular file.

     sort(strings) = lexicographic sort by 8-bit value (strcmp).

     entries(path) = the entries of a directory, without `.' and
     `..'.

     `+' denotes string concatenation. */

struct PathFilter
{
    virtual ~PathFilter() { }
    virtual bool operator () (const Path & path) { return true; }
};

extern PathFilter defaultPathFilter;

void dumpPath(const Path & path, Sink & sink,
    PathFilter & filter = defaultPathFilter);

struct ParseSink
{
    virtual void createDirectory(const Path & path) { };

    virtual void createRegularFile(const Path & path) { };
    virtual void isExecutable() { };
    virtual void preallocateContents(unsigned long long size) { };
    virtual void receiveContents(unsigned char * data, unsigned int len) { };

    virtual void createSymlink(const Path & path, const string & target) { };
};

void parseDump(ParseSink & sink, Source & source);

void restorePath(const Path & path, Source & source);

}
msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/guix/log/?id=741c8efd6a85150359578610e492c6731fd34a03'>root</a>/<a href='/guix/log/gnu?id=741c8efd6a85150359578610e492c6731fd34a03'>gnu</a>/<a href='/guix/log/gnu/installer?id=741c8efd6a85150359578610e492c6731fd34a03'>installer</a>/<a href='/guix/log/gnu/installer/record.scm?id=741c8efd6a85150359578610e492c6731fd34a03'>record.scm</a></div><div class='content'><table class='list nowrap'><tr class='nohover'><th class='left'>Age</th><th class='left'>Commit message (<a href='/guix/log/gnu/installer/record.scm?id=741c8efd6a85150359578610e492c6731fd34a03&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2022-02-02 16:46:44 +0100'>2022-02-02</span></td><td><a href='/guix/commit/gnu/installer/record.scm?id=ad55ccf9b18000144a4e0f28a0f9e57132f94edc'>installer: Make dump archive creation optional and selective.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/installer.scm (installer-program): Let the installer customize
the dump archive.
* gnu/installer/dump.scm (prepare-dump, make-dump): Split make-dump in
prepare-dump, which copies the files necessary for the dump, and
make-dump which creates the archive.
* gnu/installer/record.scm (installer): Add report-page field.  Change
documented return value of exit-error.
* gnu/installer/newt.scm (exit-error): Change arguments to be a string
containing the error.  Let the user choose between exiting and
initiating a dump.
(report-page): Add new variable.
* gnu/installer/newt/page.scm (run-dump-page): New variable.
* gnu/installer/newt/dump.scm: Delete it.

Signed-off-by: Mathieu Othacehe &lt;othacehe@gnu.org&gt;
</span></span></td><td>Josselin Poiret</td></tr>
<tr><td><span title='2022-02-02 16:46:43 +0100'>2022-02-02</span></td><td><a href='/guix/commit/gnu/installer/record.scm?id=408427a36c6545115068d5f06de2ea21407374c6'>installer: Add installer-specific run command process.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/installer/record.scm (installer)[run-command]: Add field.
* gnu/installer/utils.scm (run-command-in-installer): Add parameter.
* gnu/installer.scm (installer-program): Parameterize
run-command-in-installer with current installer's run-command.
* gnu/installer/newt.scm (newt-run-command): New variable.
(newt-installer): Use it.

Signed-off-by: Mathieu Othacehe &lt;othacehe@gnu.org&gt;
</span></span></td><td>Josselin Poiret</td></tr>
<tr><td><span title='2022-02-02 16:46:42 +0100'>2022-02-02</span></td><td><a href='/guix/commit/gnu/installer/record.scm?id=0d37a5df7e709cadca97cfbbf9c680dfe54b8302'>installer: Add crash dump upload support.</a><span class='msg-avail'>...<span class='msg-tooltip'>Suggested-by: Josselin Poiret &lt;dev@jpoiret.xyz&gt;

* gnu/installer/dump.scm: New file.
* gnu/installer/newt/dump.scm: New file.
* gnu/local.mk (INSTALLER_MODULES): Add them.
* gnu/installer/record.scm (&lt;installer&gt;)[dump-page]: New field.
* gnu/installer/steps.scm (%current-result): New variable.
(run-installer-steps): Update it.
* gnu/installer.scm (installer-program): Add tar and gip to the installer
path. Add guile-webutils and gnutls to the Guile extensions. Generate and send
the crash dump report.
* gnu/installer/newt.scm (exit-error): Add a report argument. Display the
report id.
(dump-page): New procedure.
(newt-installer): Update it.
</span></span></td><td>Mathieu Othacehe</td></tr>
.scm: Ditto.
</span></span></td><td>Mathieu Othacehe</td></tr>
<tr><td><span title='2020-04-06 15:06:03 +0200'>2020-04-06</span></td><td><a href='/guix/commit/gnu/installer/record.scm?id=786c9c39bc0826737e99f0c750ea30033cdbc202'>installer: Add a help page.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/installer/newt/help.scm: New file.
* gnu/local.mk (INSTALLER_MODULES): Add it.
* po/guix/POTFILES.in: Add it.
* gnu/installer/record.scm (&lt;installer&gt;): Add 'help-menu' and 'help-page'
 fields,
 (installer-help-menu, installer-help-page): new exported procedures.
 * gnu/installer/newt.scm (init): Set the help line,
 (help-menu, help-page): new procedures used ...
 (newt-installer): ... here.
 * gnu/installer/newt/keymap.scm (run-layout-page): Add a context argument to
 differenciate the help context from the main one,
 (run-keymap-page): add a context argument and pass it to run-layout-page.
 * gnu/installer.scm (compute-keymap-step): Add a context argument and pass it
 to 'installer-keymap-page',
 (installer-steps): set the help menu and pass the appropriate context to
 compute-keymap-step calls,
 (guile-newt): update to revision 2.
</span></span></td><td>Mathieu Othacehe</td></tr>