Source code for plugin_zip_exporter

# Copyright (c) 2013, 2017, System Engineering Software Society
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of the System Engineering Software Society nor the
#       names of its contributors may be used to endorse or promote products
#       derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.
# IN NO EVENT SHALL SYSTEM ENGINEERING SOFTWARE SOCIETY BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from __future__ import (print_function, division, unicode_literals,
                        absolute_import)
import os
import zipfile
from sylib.export import datasource as exportdatasource
from sympathy.platform.exceptions import sywarn


class DataExtractZip(exportdatasource.DatasourceArchiveBase):
    """Extractor for ZIP files."""

    EXPORTER_NAME = "ZIP Extractor"
    FILENAME_EXTENSION = None

    @staticmethod
    def hide_filename():
        return True

    def export_data(self, in_datasource, directory, progress=None):
        file = in_datasource.decode_path()
        filenames = self._create_filenames(file)
        if len(filenames):
            zip_infile = zipfile.ZipFile(file)
            zip_infile.extractall(directory)
        else:
            sywarn(file + ' is either empty or not a valid ZIP file.')
        return filenames

    def create_filenames(self, input_list, filename, *args):
        filenames = []
        for path in input_list:
            filenames.extend(self._create_filenames(path.decode_path()))
        return filenames

    def _create_filenames(self, path):
        if os.path.isfile(path) and zipfile.is_zipfile(path):
            return [file for file in zipfile.ZipFile(path).namelist()
                    if not os.path.isdir(file)]
        return []

    def cardinality(self):
        return self.one_to_many