#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=3adde132c90bf41558460c150be32d3accfcf325'>root</a>/<a href='/guix/log/gnu?id=3adde132c90bf41558460c150be32d3accfcf325'>gnu</a>/<a href='/guix/log/gnu/build?id=3adde132c90bf41558460c150be32d3accfcf325'>build</a>/<a href='/guix/log/gnu/build/activation.scm?id=3adde132c90bf41558460c150be32d3accfcf325'>activation.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/build/activation.scm?id=3adde132c90bf41558460c150be32d3accfcf325&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2024-11-03 23:10:44 +0100'>2024-11-03</span></td><td><a href='/guix/commit/gnu/build/activation.scm?id=4e6df8040e539e4635420eef1a2a26af209b614d'>activation: Create directory with specified perms in ‘mkdir-p/perms’.</a><span class='msg-avail'>...<span class='msg-tooltip'>There is currently a window of time between when the desired directory is
created and when its permissions are changed.  During this time, its
permissions are restricted only by the umask.

Of course, in the "directory already exists" case, this doesn't matter, but if
the directory has been specifically deleted ahead of time so that it is
created afresh, this is an unnecessary window.

We can avoid this by passing the caller-provided BITS to 'mkdirat' when
attempting to create the last directory.

* gnu/build/activation.scm (mkdir-p/perms): Create target directory with BITS
  permissions.

Change-Id: I03d2c620872e86b6f591abe0f1c8317aa1245383
Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>Reepca Russelstein</td></tr>
<tr><td><span title='2024-09-06 11:46:26 +0200'>2024-09-06</span></td><td><a href='/guix/commit/gnu/build/activation.scm?id=c1283e203995c8d84584e701b965efe086d1d666'>activation: Fix TOCTTOU in mkdir-p/perms.</a><span class='msg-avail'>...<span class='msg-tooltip'>Fixes &lt;https://issues.guix.gnu.org/47584&gt;.

I removed the 'Based upon mkdir-p from (guix build utils)'
comment because it's quite a bit different now.

* gnu/build/activation.scm (verify-not-symbolic): Delete.
(mkdir-p/perms): Rewrite in terms of 'openat'.

Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
Change-Id: Id2f5bcbb903283afd45f6109190210d02eb383c7
</span></span></td><td>Maxime Devos</td></tr>
<tr><td><span title='2024-08-11 02:00:00 +0200'>2024-08-11</span></td><td><a href='/guix/commit/gnu/build/activation.scm?id=71f0676a295841e2cc662eec0d3e9b7e69726035'>privilege: Add POSIX capabilities(7) support.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/system/privilege.scm (&lt;privileged-program&gt;): Add a field
representing the program's POSIX capabilities.
(privileged-program-capabilities): New public procedure.
* doc/guix.texi (Privileged Programs): Document it.
* gnu/build/activation.scm (activate-privileged-programs): Take a LIBCAP
package argument providing setcap(8) to apply said capabilities.
* gnu/services.scm (privileged-program-&gt;activation-gexp): Pass said
package argument where supported.  Include privileged-program-capabilities
in the compatibility hack.
</span></span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2024-08-11 02:00:00 +0200'>2024-08-11</span></td><td><a href='/guix/commit/gnu/build/activation.scm?id=f3b84be52dd8397abceb46219a15d5d78c982115'>build: Rename activate-setuid-programs.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/build/activation.scm (activate-setuid-programs): Rename this…
(activate-privileged-programs): …to this.
Operate on a list of &lt;privileged-program&gt; records.
* gnu/services.scm (setuid-program-&gt;activation-gexp): Adjust caller.
</span></span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2024-08-11 02:00:00 +0200'>2024-08-11</span></td><td><a href='/guix/commit/gnu/build/activation.scm?id=d6c9754c568588929c3350da8f7b17ae92d2b801'>services: setuid-program: Populate /run/privileged/bin.</a><span class='msg-avail'>...<span class='msg-tooltip'>Create /run/setuid-programs compatibility symlinks so that we can
migrate all users (both package and human) piecemeal at our leisure.

Apart from being symlinks, this should be a user-invisible change.

* gnu/build/activation.scm (%privileged-program-directory): New variable.
[activate-setuid-programs]: Put privileged copies in
%PRIVILEGED-PROGRAM-DIRECTORY, with compatibility symlinks to each in
%SETUID-DIRECTORY.
* gnu/services.scm (setuid-program-service-type): Update docstring.
* doc/guix.texi (Setuid Programs): Update @file{} name accordingly.
</span></span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2024-02-19 18:42:12 +0100'>2024-02-19</span></td><td><a href='/guix/commit/gnu/build/activation.scm?id=27ee6f06d0ecab58ca3b739c911bacefda440177'>services: activation: Ensure /run existence.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/build/activation.scm (activation-script): Ensure /var/run existence.
* gnu/build/install.scm (evaluate-populate-directive)
[directives]: Remove directory /run.

Change-Id: I19ca8e7605c0cff598ab89077a94e20390ba27b0
Signed-off-by: Ludovic Courtès &lt;ludo@gnu.org&gt;
</span></span></td><td>Nicolas Graves</td></tr>