Source code for duplicity.backends.mediafirebackend

# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4; encoding:utf-8 -*-
#
# Copyright 2016 Roman Yepishev <rye@keypressure.com>
#
# This file is part of duplicity.
#
# Duplicity 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.
#
# Duplicity 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 duplicity; if not, write to the Free Software Foundation,
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

"""MediaFire Duplicity Backend"""

import os

import duplicity.backend
from duplicity.errors import BackendException

DUPLICITY_APP_ID = "45593"


class MediafireBackend(duplicity.backend.Backend):
    """Use this backend when saving to MediaFire

    URLs look like mf:/root/folder.
    """

    def __init__(self, parsed_url):
        try:
            import mediafire.client
        except ImportError as e:
            raise BackendException(
                f"""Mediafire backend requires the mediafire library.
Exception: {str(e)}"""
            )

        duplicity.backend.Backend.__init__(self, parsed_url)

        mediafire_email = parsed_url.username
        mediafire_password = self.get_password()

        self._file_res = mediafire.client.File
        self._folder_res = mediafire.client.Folder
        self._downloaderror_exc = mediafire.client.DownloadError
        self._notfound_exc = mediafire.client.ResourceNotFoundError

        self.client = mediafire.client.MediaFireClient()
        self.client.login(app_id=DUPLICITY_APP_ID, email=mediafire_email, password=mediafire_password)

        # //username:password@host/path/to/folder -> path/to/folder
        uri = f"mf:///{parsed_url.path.split('/', 3)[3]}"

        # Create folder if it does not exist and make sure it is private
        # See MediaFire Account Settings /Security and Privacy / Share Link
        # to set "Inherit from parent folder"
        try:
            folder = self.client.get_resource_by_uri(uri)
            if not isinstance(folder, self._folder_res):
                raise BackendException("target_url already exists " "and is not a folder")
        except mediafire.client.ResourceNotFoundError:
            # force folder to be private
            folder = self.client.create_folder(uri, recursive=True)
            self.client.update_folder_metadata(uri, privacy="private")

        self.folder = folder

    def _put(self, source_path, remote_filename=None):
        """Upload file"""
        # Use source file name if remote one is not defined
        if remote_filename is None:
            remote_filename = os.path.basename(source_path.name)

        uri = self._build_uri(remote_filename)

        with self.client.upload_session():
            self.client.upload_file(source_path.open("rb"), uri)

    def _get(self, filename, local_path):
        """Download file"""
        uri = self._build_uri(filename)
        try:
            self.client.download_file(uri, local_path.open("wb"))
        except self._downloaderror_exc as ex:
            raise BackendException(ex)

    def _list(self):
        """List files in backup directory"""
        uri = self._build_uri()
        filenames = []
        for item in self.client.get_folder_contents_iter(uri):
            if not isinstance(item, self._file_res):
                continue

            filenames.append(item["filename"].encode("utf-8"))

        return filenames

    def _delete(self, filename):
        """Delete single file"""
        uri = self._build_uri(filename)
        self.client.delete_file(uri, purge=config.mf_purge)

    def _delete_list(self, filename_list):
        """Delete list of files"""
        for filename in filename_list:
            self._delete(filename)

    def _query(self, filename):
        """Stat the remote file"""
        uri = self._build_uri(filename)

        try:
            resource = self.client.get_resource_by_uri(uri)
            size = int(resource["size"])
        except self._notfound_exc:
            size = -1

        return {"size": size}

    def _build_uri(self, filename=""):
        """Build relative URI"""
        return f"mf:{self.folder['folderkey']}/{os.fsdecode(filename)}"


duplicity.backend.register_backend("mf", MediafireBackend)