-
Notifications
You must be signed in to change notification settings - Fork 149
/
filesystem.py
366 lines (303 loc) · 14 KB
/
filesystem.py
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
#-------------------------------------------------------------------------------
# Copyright (c) 2012-2014 by European Organization for Nuclear Research (CERN)
# Author: Justin Salmon <jsalmon@cern.ch>
#-------------------------------------------------------------------------------
# This file is part of the XRootD software suite.
#
# XRootD is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# XRootD 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 Lesser General Public License
# along with XRootD. If not, see <http://www.gnu.org/licenses/>.
#
# In applying this licence, CERN does not waive the privileges and immunities
# granted to it by virtue of its status as an Intergovernmental Organization
# or submit itself to any jurisdiction.
#-------------------------------------------------------------------------------
from __future__ import absolute_import, division, print_function
from pyxrootd import client
from XRootD.client.responses import XRootDStatus, StatInfo, StatInfoVFS
from XRootD.client.responses import LocationInfo, DirectoryList, ProtocolInfo
from XRootD.client.utils import CallbackWrapper
from XRootD.client.flags import AccessMode
class FileSystem(object):
"""Interact with an ``xrootd`` server to perform filesystem-based operations
such as copying files, creating directories, changing file permissions,
listing directories, etc.
:param url: The URL of the server to connect with
:type url: string
"""
def __init__(self, url):
self.__fs = client.FileSystem(url)
@property
def url(self):
"""The server URL object, instance of :mod:`XRootD.client.URL`"""
return self.__fs.url
def copy(self, source, target, force=False):
"""Copy a file.
.. note:: This method is less configurable than using
:mod:`XRootD.client.CopyProcess` - it is designed to be as simple
as possible by using sensible defaults for the underlying copy
job. If you need more configurability, or want to make multiple
copy jobs run at once in parallel, use
:mod:`XRootD.client.CopyProcess`.
:param source: Source file path
:type source: string
:param target: Destination file path
:type target: string
:param force: overwrite target if it exists
:type force: boolean
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
result = self.__fs.copy(source=source, target=target, force=force)[0]
return XRootDStatus(result), None
def locate(self, path, flags, timeout=0, callback=None):
"""Locate a file.
:param path: path to the file to be located
:type path: string
:param flags: An `ORed` combination of :mod:`XRootD.client.flags.OpenFlags`
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and :mod:`XRootD.client.responses.LocationInfo` object
"""
if callback:
callback = CallbackWrapper(callback, LocationInfo)
return XRootDStatus(self.__fs.locate(path, flags, timeout, callback))
status, response = self.__fs.locate(path, flags, timeout)
if response: response = LocationInfo(response)
return XRootDStatus(status), response
def deeplocate(self, path, flags, timeout=0, callback=None):
"""Locate a file, recursively locate all disk servers.
:param path: path to the file to be located
:type path: string
:param flags: An `ORed` combination of :mod:`XRootD.client.flags.OpenFlags`
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and :mod:`XRootD.client.responses.LocationInfo` object
"""
if callback:
callback = CallbackWrapper(callback, LocationInfo)
return XRootDStatus(self.__fs.deeplocate(path, flags, timeout, callback))
status, response = self.__fs.deeplocate(path, flags, timeout)
if response: response = LocationInfo(response)
return XRootDStatus(status), response
def mv(self, source, dest, timeout=0, callback=None):
"""Move a directory or a file.
:param source: the file or directory to be moved
:type source: string
:param dest: the new name
:type dest: string
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.mv(source, dest, timeout, callback))
status, response = self.__fs.mv(source, dest, timeout)
return XRootDStatus(status), None
def query(self, querycode, arg, timeout=0, callback=None):
"""Obtain server information.
:param querycode: the query code as specified in
:mod:`XRootD.client.flags.QueryCode`
:param arg: query argument
:type arg: string
:returns: the query response or None if there was an error
:rtype: string
.. note::
For more information about XRootD query codes and arguments, see
`the relevant section in the protocol reference
<http://xrootd.slac.stanford.edu/doc/prod/XRdv299.htm#_Toc337053385>`_.
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.query(querycode, arg, timeout, callback))
status, response = self.__fs.query(querycode, arg, timeout)
return XRootDStatus(status), response
def truncate(self, path, size, timeout=0, callback=None):
"""Truncate a file.
:param path: path to the file to be truncated
:type path: string
:param size: file size
:type size: integer
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.truncate(path, size, timeout, callback))
status, response = self.__fs.truncate(path, size, timeout)
return XRootDStatus(status), None
def rm(self, path, timeout=0, callback=None):
"""Remove a file.
:param path: path to the file to be removed
:type path: string
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.rm(path, timeout, callback))
status, response = self.__fs.rm(path, timeout)
return XRootDStatus(status), None
def mkdir(self, path, flags=0, mode=0, timeout=0, callback=None):
"""Create a directory.
:param path: path to the directory to create
:type path: string
:param flags: An `ORed` combination of :mod:`XRootD.client.flags.MkDirFlags`
where the default is `MkDirFlags.NONE`
:param mode: the initial file access mode, an `ORed` combination of
:mod:`XRootD.client.flags.AccessMode` where the default is
`rwxr-x---`
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if mode == 0:
mode = AccessMode.UR | AccessMode.UW | AccessMode.UX | \
AccessMode.GR | AccessMode.GX
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.mkdir(path, flags, mode, timeout, callback))
status, response = self.__fs.mkdir(path, flags, mode, timeout)
return XRootDStatus(status), None
def rmdir(self, path, timeout=0, callback=None):
"""Remove a directory.
:param path: path to the directory to remove
:type path: string
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.rmdir(path, timeout, callback))
status, response = self.__fs.rmdir(path, timeout)
return XRootDStatus(status), None
def chmod(self, path, mode, timeout=0, callback=None):
"""Change access mode on a directory or a file.
:param path: path to the file/directory to change access mode
:type path: string
:param mode: An `OR`ed` combination of :mod:`XRootD.client.flags.AccessMode`
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.chmod(path, mode, timeout, callback))
status, response = self.__fs.chmod(path, mode, timeout)
return XRootDStatus(status), None
def ping(self, timeout=0, callback=None):
"""Check if the server is alive.
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.ping(timeout, callback))
status, response = self.__fs.ping(timeout)
return XRootDStatus(status), None
def stat(self, path, timeout=0, callback=None):
"""Obtain status information for a path.
:param path: path to the file/directory to stat
:type path: string
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and :mod:`XRootD.client.responses.StatInfo` object
"""
if callback:
callback = CallbackWrapper(callback, StatInfo)
return XRootDStatus(self.__fs.stat(path, timeout, callback))
status, response = self.__fs.stat(path, timeout)
if response: response = StatInfo(response)
return XRootDStatus(status), response
def statvfs(self, path, timeout=0, callback=None):
"""Obtain status information for a Virtual File System.
:param path: path to the file/directory to stat
:type path: string
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and :mod:`XRootD.client.responses.StatInfoVFS` object
"""
if callback:
callback = CallbackWrapper(callback, StatInfoVFS)
return XRootDStatus(self.__fs.statvfs(path, timeout, callback))
status, response = self.__fs.statvfs(path, timeout)
if response: response = StatInfoVFS(response)
return XRootDStatus(status), response
def protocol(self, timeout=0, callback=None):
"""Obtain server protocol information.
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and :mod:`XRootD.client.responses.ProtocolInfo` object
"""
if callback:
callback = CallbackWrapper(callback, ProtocolInfo)
return XRootDStatus(self.__fs.protocol(timeout, callback))
status, response = self.__fs.protocol(timeout)
if response: response = ProtocolInfo(response)
return XRootDStatus(status), response
def dirlist(self, path, flags=0, timeout=0, callback=None):
"""List entries of a directory.
:param path: path to the directory to list
:type path: string
:param flags: An `ORed` combination of :mod:`XRootD.client.flags.DirListFlags`
where the default is `DirListFlags.NONE`
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and :mod:`XRootD.client.responses.DirectoryList` object
.. warning:: Currently, passing `DirListFlags.STAT` with an asynchronous
call to :mod:`XRootD.client.FileSystem.dirlist()` does not
work, due to an xrootd client limitation. So you'll get
``None`` instead of the ``StatInfo`` instance. See
`the GitHub issue <https://github.com/xrootd/xrootd/issues/2>`_
for more details.
"""
if callback:
callback = CallbackWrapper(callback, DirectoryList)
return XRootDStatus(self.__fs.dirlist(path, flags, timeout, callback))
status, response = self.__fs.dirlist(path, flags, timeout)
if response: response = DirectoryList(response)
return XRootDStatus(status), response
def sendinfo(self, info, timeout=0, callback=None):
"""Send info to the server (up to 1024 characters).
:param info: the info string to be sent
:type info: string
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.sendinfo(info, timeout, callback))
status, response = self.__fs.sendinfo(info, timeout)
return XRootDStatus(status), response
def prepare(self, files, flags, priority=0, timeout=0, callback=None):
"""Prepare one or more files for access.
:param files: list of files to be prepared
:type files: list
:param flags: An `ORed` combination of
:mod:`XRootD.client.flags.PrepareFlags`
:param priority: priority of the request 0 (lowest) - 3 (highest)
:type priority: integer
:returns: tuple containing :mod:`XRootD.client.responses.XRootDStatus`
object and None
"""
if callback:
callback = CallbackWrapper(callback, None)
return XRootDStatus(self.__fs.prepare(files, flags, priority, timeout,
callback))
status, response = self.__fs.prepare(files, flags, priority, timeout)
return XRootDStatus(status), response
def set_property(self, name, value):
"""Set file system property.
:param name: name of the property to set
:type name: string
:returns: boolean denoting if property setting was successful
:rtype: boolean
"""
return self.__fs.set_property(name, value)
def get_property(self, name):
"""Get file system property.
:param name: name of the property
:type name: string
"""
return self.__fs.get_property(name)