Source code for plugin_zip_archiver

# Copyright (c) 2013, 2017, Combine Control Systems AB
# 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 Combine Control Systems AB 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 COMBINE CONTROL SYSTEMS AB 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 importdatasource


class DataArchiveZip(importdatasource.DatasourceArchiveBase):
    """Archiver for ZIP files. Takes all datasources in input and puts
    them in one ZIP file. Folder structure is discarded.
    """

    EXPORTER_NAME = "ZIP Compressor"
    FILENAME_EXTENSION = "zip"

    @staticmethod
    def hide_filename():
        return False

    def export_data(self, in_datasources, location, progress=None):
        if len(in_datasources):
            with zipfile.ZipFile(location, 'w') as f:
                for ds in in_datasources:
                    path = ds.decode_path()
                    f.write(path, os.path.basename(path))
        return [location]

    def create_filenames(self, input_list, filename, *args):
        return super(DataArchiveZip, self).create_filenames(
            input_list, filename, *args)

    def cardinality(self):
        return self.many_to_one