forked-synapse/synapse/rest/media/v1/storage_provider.py

155 lines
4.8 KiB
Python
Raw Normal View History

2018-01-08 12:19:55 -05:00
# -*- coding: utf-8 -*-
# Copyright 2018 New Vector Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
2018-07-09 02:09:20 -04:00
import logging
import os
import shutil
2018-01-08 12:19:55 -05:00
from twisted.internet import defer
2018-01-08 12:19:55 -05:00
from synapse.config._base import Config
from synapse.logging.context import defer_to_thread, run_in_background
2018-01-08 12:19:55 -05:00
2018-07-09 02:09:20 -04:00
from .media_storage import FileResponder
2018-01-08 12:19:55 -05:00
logger = logging.getLogger(__name__)
class StorageProvider(object):
"""A storage provider is a service that can store uploaded media and
retrieve them.
"""
2019-06-20 05:32:02 -04:00
2018-01-08 12:19:55 -05:00
def store_file(self, path, file_info):
"""Store the file described by file_info. The actual contents can be
retrieved by reading the file in file_info.upload_path.
Args:
path (str): Relative path of file in local cache
file_info (FileInfo)
Returns:
Deferred
"""
pass
def fetch(self, path, file_info):
"""Attempt to fetch the file described by file_info and stream it
into writer.
Args:
path (str): Relative path of file in local cache
file_info (FileInfo)
Returns:
Deferred(Responder): Returns a Responder if the provider has the file,
otherwise returns None.
"""
pass
class StorageProviderWrapper(StorageProvider):
"""Wraps a storage provider and provides various config options
Args:
backend (StorageProvider)
store_local (bool): Whether to store new local files or not.
2018-01-08 12:19:55 -05:00
store_synchronous (bool): Whether to wait for file to be successfully
2019-07-12 10:29:32 -04:00
uploaded, or todo the upload in the background.
2018-01-08 12:19:55 -05:00
store_remote (bool): Whether remote media should be uploaded
"""
2019-06-20 05:32:02 -04:00
def __init__(self, backend, store_local, store_synchronous, store_remote):
2018-01-08 12:19:55 -05:00
self.backend = backend
self.store_local = store_local
2018-01-08 12:19:55 -05:00
self.store_synchronous = store_synchronous
self.store_remote = store_remote
def __str__(self):
return "StorageProviderWrapper[%s]" % (self.backend,)
2018-01-08 12:19:55 -05:00
def store_file(self, path, file_info):
if not file_info.server_name and not self.store_local:
2018-01-08 12:19:55 -05:00
return defer.succeed(None)
if file_info.server_name and not self.store_remote:
return defer.succeed(None)
if self.store_synchronous:
return self.backend.store_file(path, file_info)
else:
# TODO: Handle errors.
def store():
try:
return self.backend.store_file(path, file_info)
except Exception:
logger.exception("Error storing file")
2019-06-20 05:32:02 -04:00
run_in_background(store)
2018-01-08 12:19:55 -05:00
return defer.succeed(None)
def fetch(self, path, file_info):
return self.backend.fetch(path, file_info)
class FileStorageProviderBackend(StorageProvider):
"""A storage provider that stores files in a directory on a filesystem.
Args:
hs (HomeServer)
2018-01-18 12:11:20 -05:00
config: The config returned by `parse_config`.
2018-01-08 12:19:55 -05:00
"""
def __init__(self, hs, config):
self.hs = hs
self.cache_directory = hs.config.media_store_path
self.base_directory = config
2018-01-08 12:19:55 -05:00
def __str__(self):
return "FileStorageProviderBackend[%s]" % (self.base_directory,)
2018-01-08 12:19:55 -05:00
def store_file(self, path, file_info):
"""See StorageProvider.store_file"""
primary_fname = os.path.join(self.cache_directory, path)
backup_fname = os.path.join(self.base_directory, path)
dirname = os.path.dirname(backup_fname)
if not os.path.exists(dirname):
os.makedirs(dirname)
return defer_to_thread(
2019-06-20 05:32:02 -04:00
self.hs.get_reactor(), shutil.copyfile, primary_fname, backup_fname
2018-01-08 12:19:55 -05:00
)
def fetch(self, path, file_info):
"""See StorageProvider.fetch"""
backup_fname = os.path.join(self.base_directory, path)
if os.path.isfile(backup_fname):
return FileResponder(open(backup_fname, "rb"))
2018-01-18 12:11:45 -05:00
@staticmethod
def parse_config(config):
"""Called on startup to parse config supplied. This should parse
the config and raise if there is a problem.
The returned value is passed into the constructor.
2018-01-18 12:11:20 -05:00
In this case we only care about a single param, the directory, so let's
just pull that out.
"""
return Config.ensure_directory(config["directory"])