oapenuploader.py

#!/usr/bin/env python3
"""
Retrieve and disseminate files and metadata to OAPEN
"""

import logging
import sys
from ftplib import FTP, error_perm
from io import BytesIO
from errors import DisseminationError
from uploader import Uploader


class OAPENUploader(Uploader):
    """Dissemination logic for OAPEN"""

    def upload_to_platform(self):
        """
        Upload work in required format to OAPEN.

        Only the OAPEN ONIX file is required, as OAPEN can retrieve
        content files from the links contained within it.
        """

        # Fast-fail if credentials for upload are missing
        try:
            user = self.get_variable_from_env('oapen_ftp_user', 'OAPEN')
            passwd = self.get_variable_from_env('oapen_ftp_pw', 'OAPEN')
        except DisseminationError as error:
            logging.error(error)
            sys.exit(1)

        metadata_bytes = self.get_formatted_metadata('onix_3.0::oapen')
        # Filename TBD: use work ID for now
        filename = self.work_id

        try:
            with FTP(
                host='oapen-ftpserver.org',
                user=user,
                passwd=passwd,
            ) as ftp:
                try:
                    ftp.cwd('/OAPEN')
                except FileNotFoundError:
                    logging.error(
                        'Could not find folder "OAPEN" on OAPEN FTP server')
                    sys.exit(1)
                try:
                    ftp.storbinary('STOR {}.xml'.format(
                        filename), BytesIO(metadata_bytes))
                except error_perm as error:
                    logging.error(
                        'Error uploading to OAPEN FTP server: {}'.format(error))
                    sys.exit(1)
        except error_perm as error:
            logging.error(
                'Could not connect to OAPEN FTP server: {}'.format(error))
            sys.exit(1)

        logging.info('Successfully uploaded to OAPEN FTP server')

    def parse_metadata(self):
        """Convert work metadata into OAPEN format"""
        # Not required for OAPEN - only the ONIX file is required
        pass