# :coding: utf-8
# :copyright: Copyright (c) 2016 ftrack

# This snippet was last tested with ftrack 3.3.32 and Python API 0.16.0.

import logging
import ftrack_api
import functools

ACTION_IDENTIFIER = 'com.example.action.require_timelog_comments'
REQUIRE_COMMENTS_ATTRIBUTE = 'require_comments'

logger = logging.getLogger('require_timelog_comments')


def handle_timelog_action(session, event):
    '''Handle timelog action submission.'''
    if 'values' in event['data']:
        values = event['data']['values']
        logger.debug(u'Got action values: {0}'.format(values))

        timelog_id = event['data']['selection'][0]['entityId']
        duration = float(values['timelog_minutes'])
        comment = values['timelog_comment']

        timelog = session.get('Timelog', timelog_id);
        timelog['duration'] = duration * 60 # duration is set in seconds
        timelog['comment'] = comment
        logger.info(u'Updating timelog {0!r}: {1}'.format(timelog_id, comment))
        session.commit()

        return {
            'success': True,
            'message': 'Updated timelog successfully'
        }


def require_timelog_comments(session, event):
    '''Handle update *event*.

    Trigger an Action UI to require timelog comments if the custom attribute
    `require_comments` is set on the timelog context.
    '''
    entities = event['data'].get('entities', [])
    user_id = event['source']['user']['id']
    logger.debug(
        u'Handling event for user {0!r}, entities: {1!r}'.format(
            user_id, entities
        )
    )

    for entity in entities:
        if entity['entityType'] == 'timelog':
            if entity['action'] == 'remove':
                logger.debug('Ignoring remove timelog.')
                continue

            # load the form for adding the comment  
            timelog = session.get('Timelog', entity['entityId'])
            task = timelog['context']
            comment = timelog['comment']
            duration = float(timelog['duration']) / 60.0

            require_comments = False
            if REQUIRE_COMMENTS_ATTRIBUTE in task['custom_attributes']:
                require_comments = task['custom_attributes'][REQUIRE_COMMENTS_ATTRIBUTE]

            if not require_comments or comment != '':
                logger.debug('Comment not required or already specified.')
                continue

            items = [
                {
                    'label': 'Duration (min)',
                    'type': 'number',
                    'value': duration,
                    'name' : 'timelog_minutes'
                }, {
                    'label': 'Comment',
                    'type': 'text',
                    'value': timelog['comment'],
                    'name' : 'timelog_comment'
                }
            ]

            logger.info('Triggering user interface for comment.')
            event = ftrack_api.event.base.Event(
                topic='ftrack.action.trigger-user-interface',
                data={
                    'type': 'form',
                    'selection': [entity],
                    'actionIdentifier': ACTION_IDENTIFIER,
                    'items': items,
                    'title': 'TimeLog'
                },
                target=(
                    'applicationId=ftrack.client.web and user.id={0}'.format(user_id)
                )
            )
            session.event_hub.publish(event)


def register(session, **kw):
    '''Register event listener.'''

    # Validate that session is an instance of ftrack_api.Session. If not,
    # assume that register is being called from an incompatible API
    # and return without doing anything.
    if not isinstance(session, ftrack_api.Session):
        # Exit to avoid registering this plugin again.
        return

    # Register the event handler
    handle_event = functools.partial(
         require_timelog_comments, session
    )
    session.event_hub.subscribe('topic=ftrack.update', handle_event)

    # Register the action handler
    handle_action = functools.partial(
        handle_timelog_action, session
    )
    session.event_hub.subscribe(
        'topic=ftrack.action.launch and data.actionIdentifier={0}'.format(ACTION_IDENTIFIER),
        handle_action
    )



if __name__ == '__main__':
    logging.basicConfig(level=logging.INFO)
    logging.getLogger('ftrack_api').setLevel(level=logging.WARN)
    logging.getLogger('requests').setLevel(level=logging.WARN)
    session = ftrack_api.Session()
    register(session)

    # Wait for events.
    session.event_hub.wait()