1 # -*- coding: utf-8 -*-
3 # Copyright 2018 Telefonica S.A.
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
22 from http
import HTTPStatus
23 from shutil
import rmtree
24 from osm_common
.fsbase
import FsBase
, FsException
26 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
29 class FsLocal(FsBase
):
30 def __init__(self
, logger_name
="fs", lock
=False):
31 super().__init
__(logger_name
, lock
)
35 return {"fs": "local", "path": self
.path
}
37 def fs_connect(self
, config
):
39 if "logger_name" in config
:
40 self
.logger
= logging
.getLogger(config
["logger_name"])
41 self
.path
= config
["path"]
42 if not self
.path
.endswith("/"):
44 if not os
.path
.exists(self
.path
):
46 "Invalid configuration param at '[storage]': path '{}' does not exist".format(
52 except Exception as e
: # TODO refine
53 raise FsException(str(e
))
55 def fs_disconnect(self
):
58 def mkdir(self
, folder
):
60 Creates a folder or parent object location
62 :return: None or raises and exception
65 os
.mkdir(self
.path
+ folder
)
66 except FileExistsError
: # make it idempotent
68 except Exception as e
:
69 raise FsException(str(e
), http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
71 def dir_rename(self
, src
, dst
):
73 Rename one directory name. If dst exist, it replaces (deletes) existing directory
74 :param src: source directory
75 :param dst: destination directory
76 :return: None or raises and exception
79 if os
.path
.exists(self
.path
+ dst
):
80 rmtree(self
.path
+ dst
)
82 os
.rename(self
.path
+ src
, self
.path
+ dst
)
84 except Exception as e
:
85 raise FsException(str(e
), http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
87 def file_exists(self
, storage
, mode
=None):
89 Indicates if "storage" file exist
90 :param storage: can be a str or a str list
91 :param mode: can be 'file' exist as a regular file; 'dir' exists as a directory or; 'None' just exists
94 if isinstance(storage
, str):
98 if os
.path
.exists(self
.path
+ f
):
101 if mode
== "file" and os
.path
.isfile(self
.path
+ f
):
103 if mode
== "dir" and os
.path
.isdir(self
.path
+ f
):
107 def file_size(self
, storage
):
110 :param storage: can be a str or a str list
113 if isinstance(storage
, str):
116 f
= "/".join(storage
)
117 return os
.path
.getsize(self
.path
+ f
)
119 def file_extract(self
, tar_object
, path
):
122 :param tar_object: object of type tar
123 :param path: can be a str or a str list, or a tar object where to extract the tar_object
126 if isinstance(path
, str):
129 f
= self
.path
+ "/".join(path
)
130 tar_object
.extractall(path
=f
)
132 def file_open(self
, storage
, mode
):
135 :param storage: can be a str or list of str
136 :param mode: file mode
140 if isinstance(storage
, str):
143 f
= "/".join(storage
)
144 return open(self
.path
+ f
, mode
)
145 except FileNotFoundError
:
147 "File {} does not exist".format(f
), http_code
=HTTPStatus
.NOT_FOUND
151 "File {} cannot be opened".format(f
), http_code
=HTTPStatus
.BAD_REQUEST
154 def dir_ls(self
, storage
):
156 return folder content
157 :param storage: can be a str or list of str
158 :return: folder content
161 if isinstance(storage
, str):
164 f
= "/".join(storage
)
165 return os
.listdir(self
.path
+ f
)
166 except NotADirectoryError
:
168 "File {} does not exist".format(f
), http_code
=HTTPStatus
.NOT_FOUND
172 "File {} cannot be opened".format(f
), http_code
=HTTPStatus
.BAD_REQUEST
175 def file_delete(self
, storage
, ignore_non_exist
=False):
177 Delete storage content recursively
178 :param storage: can be a str or list of str
179 :param ignore_non_exist: not raise exception if storage does not exist
183 if isinstance(storage
, str):
184 f
= self
.path
+ storage
186 f
= self
.path
+ "/".join(storage
)
187 if os
.path
.exists(f
):
189 elif not ignore_non_exist
:
191 "File {} does not exist".format(storage
),
192 http_code
=HTTPStatus
.NOT_FOUND
,
194 except (IOError, PermissionError
) as e
:
196 "File {} cannot be deleted: {}".format(f
, e
),
197 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
,
200 def sync(self
, from_path
=None):
201 pass # Not needed in fslocal
203 def reverse_sync(self
, from_path
):
204 pass # Not needed in fslocal