File: extrameta.cpp

package info (click to toggle)
recoll 1.43.12-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,952 kB
  • sloc: cpp: 104,785; python: 9,933; xml: 7,314; ansic: 6,447; sh: 1,252; perl: 166; makefile: 72
file content (211 lines) | stat: -rw-r--r-- 6,969 bytes parent folder | download
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/* Copyright (C) 2004-2022 J.F.Dockes 
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "autoconfig.h"

#include <string>

#include <errno.h>

#include "smallut.h"
#include "rclconfig.h"
#include "pxattr.h"
#include "log.h"
#include "cstr.h"
#include "rcldoc.h"
#include "execmd.h"
#include "conftree.h"
using std::string;
using std::map;
using std::vector;

#ifdef __APPLE__
#include "transcode.h"
#include "finderxattr.h"

string decode_finder_metadata(const string& path, const string& xkey, const string& value)
{
    if (xkey == "com.apple.metadata:kMDItemFinderComment") {
        auto [v1, error] = decode_comment_plist(
            (const unsigned char *)value.c_str(), (int)value.size());
        if (!error.empty()) {
            LOGINF("reapXattrs: failed decoding finder comment for " << path << "\n");
            return string();
        } else {
            if (!v1.empty() && v1[0] == 0) {
                string v2;
                transcode(v1, v2, "UCS-2BE", cstr_utf8);
                return v2;
            } else {
                return v1;
            }
        }
    } else if (xkey == "com.apple.metadata:_kMDItemUserTags") {
        auto [v1, error] = decode_tags_plist(
            (const unsigned char *)value.c_str(), (int)value.size());
        if (!error.empty()) {
            LOGINF("reapXattrs: failed decoding finder tags for " << path << "\n");
            return string();
        } else if (v1.empty()) {
            return string();
        } else {
            // The tags have a color number at the end, which we discard as not interesting.
            string nvalue;
            for (auto& _s : v1) {
                string s;
                if (!_s.empty() && _s[0] == 0) {
                    transcode(_s, s, "UCS-2BE", cstr_utf8);
                } else {
                    _s.swap(s);
                }
                auto pos = s.find_last_of(" \t\n\r");
                if (pos != string::npos && pos < s.size() - 1) {
                    if (isdigit(s[pos+1])) {
                        s.erase(pos);
                    }
                }
                trimstring(s, " \t\r\n");
                nvalue += s + " ";
            }
            trimstring(nvalue, " \t\r\n");
            return nvalue;
        }
    }
    return string();
}
#endif // __APPLE__

static void docfieldfrommeta(RclConfig* cfg, const string& name, const string &value, Rcl::Doc& doc)
{
    string fieldname = cfg->fieldCanon(name);
    LOGDEB0("Internfile:: setting [" << fieldname << "] from cmd/xattr value [" << value << "]\n");
    if (fieldname == cstr_dj_keymd) {
        doc.dmtime = value;
    } else {
        doc.addmeta(fieldname, value);
    }
}

void reapXAttrs(const RclConfig* cfg, const string& path,  map<string, string>& xfields)
{
#ifdef _WIN32
    PRETEND_USE(cfg);
    PRETEND_USE(path);
    PRETEND_USE(xfields);
#endif
    LOGDEB2("reapXAttrs: [" << path << "]\n");
    
    // Retrieve xattrs names from files and mapping table from config
    vector<string> xnames;
    if (!pxattr::list(path, &xnames)) {
        if (errno == ENOTSUP) {
            LOGDEB("FileInterner::reapXattrs: pxattr::list: errno ENOTSUP\n");
        } else {
            LOGSYSERR("FileInterner::reapXattrs", "pxattr::list", path);
        }
        return;
    }
    const map<string, string>& xtof = cfg->getXattrToField();

    // Record the xattrs: names found in the config are either skipped or mapped depending if the
    // translation is empty. Other names are recorded as-is
    for (const auto& xkey : xnames) {
        string key = xkey;
        auto mit = xtof.find(xkey);
        if (mit != xtof.end()) {
            if (mit->second.empty()) {
                continue;
            } else {
                key = mit->second;
            }
        }
        string value;
        if (!pxattr::get(path, xkey, &value, pxattr::PXATTR_NOFOLLOW)) {
            LOGSYSERR("FileInterner::reapXattrs", "pxattr::get", path + " : " + xkey);
            continue;
        }

#ifdef __APPLE__
        static const string applemetastr("com.apple.metadata:");
        if (beginswith(xkey, applemetastr)) {
            value = decode_finder_metadata(path, xkey, value);
        }
#endif // __APPLE__

        if (value.empty())
            continue;
        // Encode should we ?
        addmeta(xfields, key, value);
        LOGDEB2("reapXAttrs: [" << key << "] -> [" << value << "]\n");
    }
}

void docFieldsFromXattrs(RclConfig *cfg, const map<string, string>& xfields, Rcl::Doc& doc)
{
    for (const auto& fld : xfields) {
        docfieldfrommeta(cfg, fld.first, fld.second, doc);
    }
}

void reapMetaCmds(RclConfig* cfg, const string& path, map<string, string>& cfields)
{
    const auto& reapers = cfg->getMDReapers();
    if (reapers.empty())
        return;
    map<char,string> smap = {{'f', path}};
    for (const auto& reaper : reapers) {
        vector<string> cmd;
        for (const auto& arg : reaper.cmdv) {
            string s;
            pcSubst(arg, s, smap);
            cmd.push_back(s);
        }
        string output;
        if (ExecCmd::backtick(cmd, output)) {
            cfields[reaper.fieldname] =  output;
        }
    }
}

// Set fields from external commands
// These override those from xattrs and can be later augmented by
// values from inside the file.
//
// This is a bit atrocious because some entry names are special:
// "modificationdate" will set mtime instead of an ordinary field,
// and the output from anything beginning with "rclmulti" will be
// interpreted as multiple fields in configuration file format...
void docFieldsFromMetaCmds(RclConfig *cfg, const map<string, string>& cfields, Rcl::Doc& doc)
{
    for (const auto& cfld : cfields) {
        if (!cfld.first.compare(0, 8, "rclmulti")) {
            ConfSimple simple(cfld.second);
            if (simple.ok()) {
                auto names = simple.getNames("");
                for (const auto& nm : names) {
                    string value;
                    if (simple.get(nm, value)) {
                        docfieldfrommeta(cfg, nm, value, doc);
                    }
                }
            }
        } else {
            docfieldfrommeta(cfg, cfld.first, cfld.second, doc);
        }
    }
}