src/XattrAttributeFinder.h
author František Kučera <franta-hg@frantovo.cz>
Sun, 25 Apr 2021 18:47:57 +0200
branchv_0
changeset 89 25a11859975b
parent 44 dc5c210295d0
permissions -rw-r--r--
streamlet examples: QR: rename qr to qr-decode + simplify Makefile
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     1
/**
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     2
 * Relational pipes
4
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
     3
 * Copyright © 2019 František Kučera (Frantovo.cz, GlobalCode.info)
0
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     4
 *
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     5
 * This program is free software: you can redistribute it and/or modify
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License as published by
24
4353cd19a6b5 fix license version: GNU GPLv3
František Kučera <franta-hg@frantovo.cz>
parents: 13
diff changeset
     7
 * the Free Software Foundation, version 3 of the License.
0
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     8
 *
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    12
 * GNU General Public License for more details.
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    13
 *
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    15
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    16
 */
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    17
#pragma once
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    18
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    19
#include <vector>
2
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    20
#include <filesystem>
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    21
4
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    22
#include <relpipe/writer/typedefs.h>
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    23
#include <relpipe/writer/AttributeMetadata.h>
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    24
#include <relpipe/writer/RelationalWriter.h>
2
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    25
4
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    26
#include "RequestedField.h"
0
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    27
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    28
namespace relpipe {
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    29
namespace in {
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    30
namespace filesystem {
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    31
2
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    32
namespace fs = std::filesystem;
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    33
using namespace relpipe::writer;
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    34
4
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    35
class XattrAttributeFinder : public AttributeFinder {
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    36
private:
2
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    37
	std::wstring_convert<codecvt_utf8<wchar_t>> convertor; // TODO: support also other encodings.
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    38
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    39
	string_t getXattr(const fs::path& file, const string_t& attributeName) {
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    40
		// TODO: review, test on multiple platforms
3
62eac7ab4cf4 xattr: comments
František Kučera <franta-hg@frantovo.cz>
parents: 2
diff changeset
    41
		// TODO: improve documentation in xattr.h in glibc
62eac7ab4cf4 xattr: comments
František Kučera <franta-hg@frantovo.cz>
parents: 2
diff changeset
    42
		// TODO: check XATTR_NAME_MAX in limits.h and if it is reasonably small on our system, allocate buffer for it instead of reading twice
62eac7ab4cf4 xattr: comments
František Kučera <franta-hg@frantovo.cz>
parents: 2
diff changeset
    43
		// TODO: avoid race condition (another process might change the attribute between reading its length and its value)
2
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    44
		ssize_t length = getxattr(file.c_str(), convertor.to_bytes(attributeName).c_str(), nullptr, 0);
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    45
		if (length > 0) {
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    46
			std::vector<char> buffer(length + 1);
3
62eac7ab4cf4 xattr: comments
František Kučera <franta-hg@frantovo.cz>
parents: 2
diff changeset
    47
			getxattr(file.c_str(), convertor.to_bytes(attributeName).c_str(), buffer.data(), buffer.size());
2
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    48
			return convertor.from_bytes(buffer.data());
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    49
		} else {
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    50
			return L"";
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    51
		}
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    52
	}
9
b4f29fb16159 process also links to non-existent files and non-readable links
František Kučera <franta-hg@frantovo.cz>
parents: 8
diff changeset
    53
protected:
b4f29fb16159 process also links to non-existent files and non-readable links
František Kučera <franta-hg@frantovo.cz>
parents: 8
diff changeset
    54
32
bccda5688d71 propagate the relation name to the finders and streamlets
František Kučera <franta-hg@frantovo.cz>
parents: 29
diff changeset
    55
	virtual void writeFieldOfExistingFile(RelationalWriter* writer, const string_t& relationName, const RequestedField& field) override {
44
dc5c210295d0 do not force the name as the alias (allow different default in the finder/streamlet)
František Kučera <franta-hg@frantovo.cz>
parents: 32
diff changeset
    56
		for (string_t alias : field.getAliasesOrName()) {
13
b0fabeceb18a xattr: detault namespace is: user.
František Kučera <franta-hg@frantovo.cz>
parents: 9
diff changeset
    57
			// TODO: support also other namespaces through CLI --option namespace someOtherNS
b0fabeceb18a xattr: detault namespace is: user.
František Kučera <franta-hg@frantovo.cz>
parents: 9
diff changeset
    58
			string_t xattrName = L"user." + field.name;
b0fabeceb18a xattr: detault namespace is: user.
František Kučera <franta-hg@frantovo.cz>
parents: 9
diff changeset
    59
			if (field.group == RequestedField::GROUP_XATTR) writer->writeAttribute(getXattr(currentFile, xattrName));
9
b4f29fb16159 process also links to non-existent files and non-readable links
František Kučera <franta-hg@frantovo.cz>
parents: 8
diff changeset
    60
		}
b4f29fb16159 process also links to non-existent files and non-readable links
František Kučera <franta-hg@frantovo.cz>
parents: 8
diff changeset
    61
	}
b4f29fb16159 process also links to non-existent files and non-readable links
František Kučera <franta-hg@frantovo.cz>
parents: 8
diff changeset
    62
0
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    63
public:
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    64
32
bccda5688d71 propagate the relation name to the finders and streamlets
František Kučera <franta-hg@frantovo.cz>
parents: 29
diff changeset
    65
	virtual vector<AttributeMetadata> toMetadata(RelationalWriter* writer, const string_t& relationName, const RequestedField& field) override {
5
ec661baf433a support field aliases
František Kučera <franta-hg@frantovo.cz>
parents: 4
diff changeset
    66
		if (field.group == RequestedField::GROUP_XATTR) {
ec661baf433a support field aliases
František Kučera <franta-hg@frantovo.cz>
parents: 4
diff changeset
    67
			vector<AttributeMetadata> metadata;
44
dc5c210295d0 do not force the name as the alias (allow different default in the finder/streamlet)
František Kučera <franta-hg@frantovo.cz>
parents: 32
diff changeset
    68
			for (string_t alias : field.getAliasesOrName()) metadata.push_back(AttributeMetadata{alias, TypeId::STRING});
5
ec661baf433a support field aliases
František Kučera <franta-hg@frantovo.cz>
parents: 4
diff changeset
    69
			return metadata;
ec661baf433a support field aliases
František Kučera <franta-hg@frantovo.cz>
parents: 4
diff changeset
    70
		} else {
ec661baf433a support field aliases
František Kučera <franta-hg@frantovo.cz>
parents: 4
diff changeset
    71
			return {};
ec661baf433a support field aliases
František Kučera <franta-hg@frantovo.cz>
parents: 4
diff changeset
    72
		}
4
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    73
	}
2
f07ed604a0ab read filenames separated by a null-byte; fetch their size, owner, group… and some xattr (extended attribute); a preview version
František Kučera <franta-hg@frantovo.cz>
parents: 0
diff changeset
    74
4
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    75
	virtual ~XattrAttributeFinder() override {
0
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    76
	}
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    77
};
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    78
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    79
}
467d09b62a12 project skeleton
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    80
}
4
d44ed75822e7 modular design
František Kučera <franta-hg@frantovo.cz>
parents: 3
diff changeset
    81
}