#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);


// FIXME: global variables are bad m'kay.
extern bool useCaseHack;


}
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=58b98edb186a3626eba24ee7b8a019b31709340b'>root</a>/<a href='/guix/log/po?id=58b98edb186a3626eba24ee7b8a019b31709340b'>po</a>/<a href='/guix/log/po/packages?id=58b98edb186a3626eba24ee7b8a019b31709340b'>packages</a>/<a href='/guix/log/po/packages/fi.po?id=58b98edb186a3626eba24ee7b8a019b31709340b'>fi.po</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/po/packages/fi.po?id=58b98edb186a3626eba24ee7b8a019b31709340b&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2023-05-31 17:23:21 +0200'>2023-05-31</span></td><td><a href='/guix/commit/po/packages/fi.po?id=8e9e6a6482f3ba98d1cdcad344ee488e8751fee7'>nls: Update translations.</a><span class='msg-avail'>...<span class='msg-tooltip'>* doc/guix-cookbook.texi (Top): Mention Slovak.
</span></span></td><td>Florian Pelz</td></tr>
<tr><td><span title='2023-03-07 21:14:57 +0100'>2023-03-07</span></td><td><a href='/guix/commit/po/packages/fi.po?id=d333958763b0840c4cd895601b079b68358a6a46'>nls: Update translations.</a></td><td>Julien Lepiller</td></tr>
 Services)[openntpd-service-type]: Remove
"allow-large-adjustment?" field from sample configuration.
[openntpd-configuration]: Remove description of "allow-large-adjustment?"
field.

Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>Simon South</td></tr>
<tr><td><span title='2019-10-30 18:15:54 -0400'>2019-10-30</span></td><td><a href='/guix/commit/tests/networking.scm?id=97bc3cbea5fc281a299c03eaaa3be5baf21ea673'>services: ntp: Ensure no double quotes are output to config file.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/services/networking.scm (ntp-server-&gt;string): Use the textual
representation of the values as printed by 'display' rather than 'write', to
avoid inserting double quotes in the generated config.
* tests/networking.scm (%ntp-server-sample): Add a comment and make one of the
options a string, to exercise the fix.
("ntp-server-&gt;string"): Move the expected value to the first argument.
("ntp configuration servers deprecated form"): Likewise.
("openntpd generated config string ends with a newline"): Likewise.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2019-09-08 23:15:32 +0900'>2019-09-08</span></td><td><a href='/guix/commit/tests/networking.scm?id=2625abc6aa5df66a6503e906b7592691452954f5'>services: openntpd: Add test for issue #3731.</a><span class='msg-avail'>...<span class='msg-tooltip'>See http://debbugs.gnu.org/cgi/bugreport.cgi?bug=37318.

* gnu/services/networking.scm (openntpd-configuration-&gt;string): New procedure,
extracted from top of the `openntpd-shepherd-service' to make it testable.
(openntpd-shepherd-service): Adapt following the move of the code to the above
procedure.
* tests/networking.scm: Add a test for the `openntpd-configuration-&gt;string'
procedure.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2019-09-08 23:15:31 +0900'>2019-09-08</span></td><td><a href='/guix/commit/tests/networking.scm?id=5658ae8a0ad5d988765944b7e783b2bdc23a7f48'>services: ntp: Support different NTP server types and options.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/services/networking.scm (ntp-server-types): New enum.
(&lt;ntp-server&gt;): New record type.
(ntp-server-&gt;string): New procedure.
(%ntp-servers): Define in terms of &lt;htp-server&gt; records.  Use the first
entrypoint server as a pool instead of a list of static servers.  This is more
resilient since a new server of the pool can be interrogated on every
request.  Add the 'iburst' options.
(ntp-configuration-servers): Define a custom accessor that warns but honors
the now deprecated server format.
(&lt;ntp-configuration&gt;): Use it.
(%openntpd-servers): New variable,
(&lt;openntpd-configuration&gt;): Use it, as a pool ('servers' field) instead of a
regular server.
* tests/networking.scm: New file.
* Makefile.am (SCM_TESTS): Register it.
* doc/guix.texi: Update documentation.
</span></span></td><td>Maxim Cournoyer</td></tr>