pacifica/pacifica-metadata

#!/usr/bin/python
# -*- coding: utf-8 -*-
"""CherryPy Status Metadata projectinfo base class."""
import datetime


class QueryBase:
    """Retrieves a set of projects for a given keyword set."""

    @staticmethod
    def format_project_block(project_entry, instruments=None):
        """Construct a dictionary from a given project instance in the metadata stack."""
        _pe = project_entry
        if _pe.closed_date is not None and _pe.actual_end_date is not None:
            _pe.actual_end_date = _pe.actual_end_date if _pe.actual_end_date < _pe.closed_date else _pe.closed_date
        else:
            if _pe.closed_date is not None and _pe.actual_end_date is None:
                _pe.actual_end_date = _pe.closed_date

        now = datetime.datetime.now().date()

        project_state = 'inactive'
        currently_active = bool(_pe.actual_start_date is not None and _pe.actual_start_date < now)
        currently_closed = bool(currently_active and _pe.actual_end_date is not None and _pe.actual_end_date < now)

        if not currently_active:
            project_state = 'pre_active'
        else:
            if not currently_closed:
                project_state = 'active'
            else:
                project_state = 'closed'

        currently_active = bool(project_state == 'active' and (
            _pe.actual_end_date is None or _pe.actual_end_date >= now))
        project_state = 'invalid' if _pe.actual_start_date is None and _pe.actual_end_date is None else project_state
        title = _pe.title if _pe.title is not None else '<Title Unspecified>'
        year = _pe.actual_end_date.year if _pe.actual_end_date is not None else 'Unknown'
        return_block = {
            'id': _pe.id,
            'title': title,
            'category': year,
            'display_name': u'[Project {0}]: {1}'.format(_pe.id, _pe.title),
            'currently_active': currently_active,
            'state': project_state,
            'start_date': _pe.actual_start_date.strftime('%Y-%m-%d') if _pe.actual_start_date is not None else '---',
            'end_date': _pe.actual_end_date.strftime('%Y-%m-%d') if _pe.actual_end_date is not None else '---',
            'closed_date': _pe.closed_date.strftime('%Y-%m-%d') if _pe.closed_date is not None else '---',
            'science_theme': _pe.science_theme,
            'project_type': _pe.project_type.lower().title()
        }
        if instruments is not None:
            return_block['instruments'] = instruments

        return return_block

    @staticmethod
    def project_help_block_message():
        """Assemble a block of relevant help text to be returned with an invalid request."""
        message = 'You must supply either a project id (like "/projectinfo/<project_id>")'
        message += ' or search for one using the form "/projectinfo/search/<search_term_1>+<search_term_2>"'
        return message