node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/task/util/file/MakeDirectory.java


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

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.node.admin.task.util.file;

import com.yahoo.vespa.hosted.node.admin.component.TaskContext;

import java.io.UncheckedIOException;
import java.nio.file.NotDirectoryException;
import java.nio.file.Path;
import java.util.Optional;
import java.util.logging.Logger;

/**
 * Class to ensure a directory exists with the correct owner, group, and permissions.
 *
 * @author hakonhall
 */
public class MakeDirectory {
    private static final Logger logger = Logger.getLogger(MakeDirectory.class.getName());

    private final UnixPath path;
    private final AttributeSync attributeSync;
    private final FileAttributesCache attributesCache;

    private boolean createParents = false;

    public MakeDirectory(Path path) {
        this.path = new UnixPath(path);
        this.attributeSync = new AttributeSync(path);
        this.attributesCache = new FileAttributesCache(this.path);
    }

    /**
     * Warning: The owner, group, and permissions of any created parent directories are NOT modified
     */
    public MakeDirectory createParents() { this.createParents = true; return this; }

    public MakeDirectory withOwnerId(int ownerId) { attributeSync.withOwnerId(ownerId); return this; }
    public MakeDirectory withGroupId(int groupId) { attributeSync.withGroupId(groupId); return this; }
    public MakeDirectory withPermissions(String permissions) {
        attributeSync.withPermissions(permissions);
        return this;
    }

    public boolean converge(TaskContext context) {
        boolean systemModified = false;

        Optional<FileAttributes> attributes = attributesCache.forceGet();
        if (attributes.isPresent()) {
            if (!attributes.get().isDirectory()) {
                throw new UncheckedIOException(new NotDirectoryException(path.toString()));
            }
        } else {
            Optional<String> permissions = attributeSync.getPermissions();
            if (createParents) {
                // We'll skip logging system modification here, as we'll log about the creation
                // of the directory next.
                permissions.ifPresentOrElse(path::createParents, path::createParents);
            }

            context.recordSystemModification(logger, "Creating directory " + path);
            systemModified = true;

            permissions.ifPresentOrElse(path::createDirectory, path::createDirectory);
        }

        systemModified |= attributeSync.converge(context, attributesCache);

        return systemModified;
    }
}