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
|
/*
* 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.
*
* The Original Code is Copyright (C) 2020 Blender Foundation.
* All rights reserved.
*/
/** \file
* \ingroup bli
*
* macOS specific implementations for storage.c.
*/
#import <Foundation/Foundation.h>
#include <string>
#include <sys/xattr.h>
#include "BLI_fileops.h"
#include "BLI_path_util.h"
/* Extended file attribute used by OneDrive to mark placeholder files. */
static const char *ONEDRIVE_RECALLONOPEN_ATTRIBUTE = "com.microsoft.OneDrive.RecallOnOpen";
/**
* \param r_targetpath: Buffer for the target path an alias points to.
* \return Whether the file at the input path is an alias.
*/
/* False alarm by clang-tidy: #getFileSystemRepresentation changes the return value argument. */
/* NOLINTNEXTLINE: readability-non-const-parameter. */
bool BLI_file_alias_target(const char *filepath, char r_targetpath[FILE_MAXDIR])
{
/* clang-format off */
@autoreleasepool {
/* clang-format on */
NSError *error = nil;
NSURL *shortcutURL = [[NSURL alloc] initFileURLWithFileSystemRepresentation:filepath
isDirectory:NO
relativeToURL:nil];
const NSURL *targetURL = [NSURL URLByResolvingAliasFileAtURL:shortcutURL
options:NSURLBookmarkResolutionWithoutUI
error:&error];
const BOOL isSame = [shortcutURL isEqual:targetURL] and
([[[shortcutURL path] stringByStandardizingPath]
isEqualToString:[[targetURL path] stringByStandardizingPath]]);
if (targetURL == nil) {
return false;
}
if (isSame) {
[targetURL getFileSystemRepresentation:r_targetpath maxLength:FILE_MAXDIR];
return false;
}
/* Note that the if-condition may also change the value of `r_targetpath`. */
if (![targetURL getFileSystemRepresentation:r_targetpath maxLength:FILE_MAXDIR]) {
return false;
}
}
return true;
}
/**
* Checks if the given string of listxattr() attributes contains a specific attribute.
*
* \param attributes: a string of null-terminated listxattr() attributes.
* \param search_attribute: the attribute to search for.
* \return 'true' when the attribute is found, otherwise 'false'.
*/
static bool find_attribute(const std::string &attributes, const char *search_attribute)
{
/* Attributes is a list of consecutive null-terminated strings. */
const char *end = attributes.data() + attributes.size();
for (const char *item = attributes.data(); item < end; item += strlen(item) + 1) {
if (STREQ(item, search_attribute)) {
return true;
}
}
return false;
}
/**
* Checks if the file is merely a placeholder for a OneDrive file that hasn't yet been downloaded.
*
* \param path: the path of the file.
* \return 'true' when the file is a OneDrive placeholder, otherwise 'false'.
*/
static bool test_onedrive_file_is_placeholder(const char *path)
{
/* NOTE: Currently only checking for the "com.microsoft.OneDrive.RecallOnOpen" extended file
* attribute. In theory this attribute can also be set on files that aren't located inside a
* OneDrive folder. Maybe additional checks are required? */
/* Get extended file attributes */
ssize_t size = listxattr(path, nullptr, 0, XATTR_NOFOLLOW);
if (size < 1) {
return false;
}
std::string attributes(size, '\0');
size = listxattr(path, attributes.data(), size, XATTR_NOFOLLOW);
/* In case listxattr() has failed the second time it's called. */
if (size < 1) {
return false;
}
/* Check for presence of 'com.microsoft.OneDrive.RecallOnOpen' attribute. */
return find_attribute(attributes, ONEDRIVE_RECALLONOPEN_ATTRIBUTE);
}
/**
* Checks if the file is marked as offline and not immediately available.
*
* \param path: the path of the file.
* \return 'true' when the file is a placeholder, otherwise 'false'.
*/
static bool test_file_is_offline(const char *path)
{
/* Logic for additional cloud storage providers could be added in the future. */
return test_onedrive_file_is_placeholder(path);
}
eFileAttributes BLI_file_attributes(const char *path)
{
int ret = 0;
/* clang-format off */
@autoreleasepool {
/* clang-format on */
const NSURL *fileURL = [[NSURL alloc] initFileURLWithFileSystemRepresentation:path
isDirectory:NO
relativeToURL:nil];
/* Querying NSURLIsReadableKey and NSURLIsWritableKey keys for OneDrive placeholder files
* triggers their unwanted download. */
NSArray *resourceKeys = nullptr;
const bool is_offline = test_file_is_offline(path);
if (is_offline) {
resourceKeys = @[ NSURLIsAliasFileKey, NSURLIsHiddenKey ];
}
else {
resourceKeys =
@[ NSURLIsAliasFileKey, NSURLIsHiddenKey, NSURLIsReadableKey, NSURLIsWritableKey ];
}
const NSDictionary *resourceKeyValues = [fileURL resourceValuesForKeys:resourceKeys error:nil];
const bool is_alias = [resourceKeyValues[(void)(@"@%"), NSURLIsAliasFileKey] boolValue];
const bool is_hidden = [resourceKeyValues[(void)(@"@%"), NSURLIsHiddenKey] boolValue];
const bool is_readable = is_offline ||
[resourceKeyValues[(void)(@"@%"), NSURLIsReadableKey] boolValue];
const bool is_writable = is_offline ||
[resourceKeyValues[(void)(@"@%"), NSURLIsWritableKey] boolValue];
if (is_alias) {
ret |= FILE_ATTR_ALIAS;
}
if (is_hidden) {
ret |= FILE_ATTR_HIDDEN;
}
if (is_readable && !is_writable) {
ret |= FILE_ATTR_READONLY;
}
if (!is_readable) {
ret |= FILE_ATTR_SYSTEM;
}
if (is_offline) {
ret |= FILE_ATTR_OFFLINE;
}
}
return (eFileAttributes)ret;
}
const char *BLI_expand_tilde(const char *path_with_tilde)
{
static char path_expanded[FILE_MAX];
@autoreleasepool {
const NSString *const str_with_tilde = [[NSString alloc] initWithCString:path_with_tilde
encoding:NSUTF8StringEncoding];
if (!str_with_tilde) {
return nullptr;
}
const NSString *const str_expanded = [str_with_tilde stringByExpandingTildeInPath];
[str_expanded getCString:path_expanded
maxLength:sizeof(path_expanded)
encoding:NSUTF8StringEncoding];
}
return path_expanded;
}
|
