uccser/verto

from verto.processors.GenericTagBlockProcessor import GenericTagBlockProcessor
import re

DEFAULT_THUMBNAIL = 'default'
CUSTOM_THUMBNAIL = 'custom'


class InteractiveTagBlockProcessor(GenericTagBlockProcessor):
    '''Searches a Document for interactive tags:
        e.g. {interactive slug='example' type='in-page'}
        These are then replaced with the html template.
    '''

    def __init__(self, ext, *args, **kwargs):
        '''
        Args:
            ext: An instance of the Verto Extension.
        '''
        self.processor = 'interactive-tag'
        super().__init__(self.processor, ext, *args, **kwargs)
        self.scripts = ext.required_files['page_scripts']
        self.required_interactives = ext.required_files['interactives']
        self.required_images = ext.required_files['images']
        self.text_pattern = re.compile(ext.processor_info[self.processor]['pattern'])

    def test(self, parent, block):
        ''' Tests a block to see if the run method should be applied.

        Args:
            parent: The parent node of the element tree that children
                will reside in.
            block: The block to be tested.

        Returns:
            True if there are any start or end tags within the block.
        '''
        return self.text_pattern.search(block) is None and self.pattern.search(block) is not None

    def custom_parsing(self, argument_values):
        '''Determines the file path to use for an interactive's thumbnail.

        Args:
            argument_values (dict): Dictionary of arguments and values provided in tag block.
        Returns:
            extra_args (dict): dictionary to update the agument_values dict.
        '''
        extra_args = {}
        interactive_type = argument_values['type']
        slug = argument_values['slug']

        # add to list of interactives
        self.required_interactives.add(slug)

        if interactive_type == 'in-page':
            self.scripts.add('interactive/{}/scripts.html'.format(slug))
        elif interactive_type == 'whole-page':
            argument = 'thumbnail'
            thumbnail_file_path = argument_values.get(argument, None)

            if thumbnail_file_path is not None:
                del argument_values[argument]
                thumbnail_type = CUSTOM_THUMBNAIL
            else:
                thumbnail_file_path = 'interactives/{}/img/thumbnail.png'.format(slug)
                thumbnail_type = DEFAULT_THUMBNAIL

            external_path_match = re.search(r'^http', thumbnail_file_path)
            if external_path_match is None:  # internal image
                thumbnail_file_relative = True
                add_default = self.settings['add_default_interactive_thumbnails_to_required_files']
                add_custom = self.settings['add_custom_interactive_thumbnails_to_required_files']
                if (thumbnail_type == DEFAULT_THUMBNAIL and add_default) or \
                   (thumbnail_type == CUSTOM_THUMBNAIL and add_custom):
                    self.required_images.add(thumbnail_file_path)
            else:
                thumbnail_file_relative = False

            extra_args['thumbnail_file_path'] = thumbnail_file_path
            extra_args['thumbnail_file_relative'] = thumbnail_file_relative

        return extra_args