tailbone/tailbone/views/people.py

# -*- coding: utf-8; -*-
################################################################################
#
#  Rattail -- Retail Software Framework
#  Copyright © 2010-2024 Lance Edgar
#
#  This file is part of Rattail.
#
#  Rattail is free software: you can redistribute it and/or modify it under the
#  terms of the GNU General Public License as published by the Free Software
#  Foundation, either version 3 of the License, or (at your option) any later
#  version.
#
#  Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
#  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
#  details.
#
#  You should have received a copy of the GNU General Public License along with
#  Rattail.  If not, see <http://www.gnu.org/licenses/>.
#
################################################################################
"""
Person Views
"""

import datetime
import logging
from collections import OrderedDict

import sqlalchemy as sa
from sqlalchemy import orm
import sqlalchemy_continuum as continuum

from rattail.db import api
from rattail.db.model import Person, PersonNote, MergePeopleRequest
from rattail.util import simple_error

import colander
from webhelpers2.html import HTML, tags

from tailbone import forms, grids
from tailbone.db import TrainwreckSession
from tailbone.views import MasterView
from tailbone.util import raw_datetime


log = logging.getLogger(__name__)


class PersonView(MasterView):
    """
    Master view for the Person class.
    """
    model_class = Person
    model_title_plural = "People"
    route_prefix = 'people'
    touchable = True
    has_versions = True
    bulk_deletable = True
    is_contact = True
    supports_autocomplete = True
    supports_quickie_search = True
    configurable = True

    labels = {
        'default_phone': "Phone Number",
        'default_email': "Email Address",
    }

    grid_columns = [
        'display_name',
        'first_name',
        'last_name',
        'phone',
        'email',
        'merge_requested',
    ]

    form_fields = [
        'first_name',
        'middle_name',
        'last_name',
        'display_name',
        'default_phone',
        'default_email',
        'address',
        'employee',
        'customers',
        'members',
        'users',
    ]

    mergeable = True

    def __init__(self, request):
        super().__init__(request)
        app = self.get_rattail_app()

        # always get a reference to the People Handler
        self.people_handler = app.get_people_handler()
        self.merge_handler = self.people_handler
        # TODO: deprecate / remove this
        self.handler = self.people_handler

    def make_grid_kwargs(self, **kwargs):
        kwargs = super().make_grid_kwargs(**kwargs)

        # turn on checkboxes if user can create a merge reqeust
        if self.mergeable and self.has_perm('request_merge'):
            kwargs['checkboxes'] = True

        return kwargs

    def configure_grid(self, g):
        super().configure_grid(g)
        route_prefix = self.get_route_prefix()
        model = self.model

        # email
        g.set_label('email', "Email Address")
        g.set_joiner('email', lambda q: q.outerjoin(
            model.PersonEmailAddress,
            sa.and_(
                model.PersonEmailAddress.parent_uuid == model.Person.uuid,
                model.PersonEmailAddress.preference == 1)))
        g.set_sorter('email', model.PersonEmailAddress.address)
        g.set_filter('email', model.PersonEmailAddress.address)

        # phone
        g.set_label('phone', "Phone Number")
        g.set_joiner('phone', lambda q: q.outerjoin(
            model.PersonPhoneNumber,
            sa.and_(
                model.PersonPhoneNumber.parent_uuid == model.Person.uuid,
                model.PersonPhoneNumber.preference == 1)))
        g.set_sorter('phone', model.PersonPhoneNumber.number)
        g.set_filter('phone', model.PersonPhoneNumber.number,
                     factory=grids.filters.AlchemyPhoneNumberFilter)

        Customer_ID = orm.aliased(model.Customer)
        CustomerPerson_ID = orm.aliased(model.CustomerPerson)

        Customer_Number = orm.aliased(model.Customer)
        CustomerPerson_Number = orm.aliased(model.CustomerPerson)

        g.joiners['customer_id'] = lambda q: q.outerjoin(CustomerPerson_ID).outerjoin(Customer_ID)
        g.filters['customer_id'] = g.make_filter('customer_id', Customer_ID.id)

        g.joiners['customer_number'] = lambda q: q.outerjoin(CustomerPerson_Number).outerjoin(Customer_Number)
        g.filters['customer_number'] = g.make_filter('customer_number', Customer_Number.number)

        g.filters['first_name'].default_active = True
        g.filters['first_name'].default_verb = 'contains'

        g.filters['last_name'].default_active = True
        g.filters['last_name'].default_verb = 'contains'

        g.set_joiner('employee_status', lambda q: q.outerjoin(model.Employee))
        g.set_filter('employee_status', model.Employee.status,
                     value_enum=self.enum.EMPLOYEE_STATUS)

        g.set_label('merge_requested', "MR")
        g.set_renderer('merge_requested', self.render_merge_requested)

        g.set_sort_defaults('display_name')

        g.set_label('display_name', "Full Name")
        g.set_label('customer_id', "Customer ID")

        if (self.has_perm('view_profile')
            and self.should_link_straight_to_profile()):

            # add View Raw action
            url = lambda r, i: self.request.route_url(
                f'{route_prefix}.view', **self.get_action_route_kwargs(r))
            # nb. insert to slot 1, just after normal View action
            g.main_actions.insert(1, self.make_action(
                'view_raw', url=url, icon='eye'))

        g.set_link('display_name')
        g.set_link('first_name')
        g.set_link('last_name')

    def default_view_url(self):
        if (self.has_perm('view_profile')
            and self.should_link_straight_to_profile()):
            return lambda p, i: self.get_action_url('view_profile', p)

        return super().default_view_url()

    def should_link_straight_to_profile(self):
        return self.rattail_config.getbool('rattail',
                                           'people.straight_to_profile',
                                           default=False)

    def render_merge_requested(self, person, field):
        model = self.model
        merge_request = self.Session.query(model.MergePeopleRequest)\
                                    .filter(sa.or_(
                                        model.MergePeopleRequest.removing_uuid == person.uuid,
                                        model.MergePeopleRequest.keeping_uuid == person.uuid))\
                                    .filter(model.MergePeopleRequest.merged == None)\
                                    .first()
        if merge_request:
            return HTML.tag('span',
                            class_='has-text-danger has-text-weight-bold',
                            title="A merge has been requested for this person.",
                            c="MR")

    def get_instance(self):
        model = self.model
        # TODO: I don't recall why this fallback check for a vendor contact
        # exists here, but leaving it intact for now.
        key = self.request.matchdict['uuid']
        instance = self.Session.get(model.Person, key)
        if instance:
            return instance
        instance = self.Session.get(model.VendorContact, key)
        if instance:
            return instance.person
        raise self.notfound()

    def is_person_protected(self, person):
        for user in person.users:
            if self.user_is_protected(user):
                return True
        return False

    def editable_instance(self, person):
        if self.request.is_root:
            return True
        return not self.is_person_protected(person)

    def deletable_instance(self, person):
        if self.request.is_root:
            return True
        return not self.is_person_protected(person)

    def configure_form(self, f):
        super().configure_form(f)

        # preferred_first_name
        if self.people_handler.should_use_preferred_first_name():
            f.insert_after('first_name', 'preferred_first_name')

    def objectify(self, form, data=None):
        if data is None:
            data = form.validated

        # do normal create/update
        person = super().objectify(form, data)

        # collect data from all name fields
        names = {}
        if 'first_name' in form:
            names['first'] = data['first_name']
        if self.people_handler.should_use_preferred_first_name():
            if 'preferred_first_name' in form:
                names['preferred_first'] = data['preferred_first_name']
        if 'middle_name' in form:
            names['middle'] = data['middle_name']
        if 'last_name' in form:
            names['last'] = data['last_name']
        if 'display_name' in form and 'display_name' not in form.readonly_fields:
            names['full'] = data['display_name']

        # TODO: why do we find colander.null values in data at this point?
        # ugh, for now we must convert them
        for key in names:
            if names[key] is colander.null:
                names[key] = None

        # do explicit name update w/ common handler logic
        self.handler.update_names(person, **names)

        return person

    def delete_instance(self, person):
        """
        Supplements the default logic as follows:

        Any customer associations are first deleted for the person.  Once that
        is complete, deletion continues as per usual.
        """
        session = orm.object_session(person)

        # must explicitly remove all CustomerPerson records
        for cp in list(person._customers):
            customer = cp.customer
            session.delete(cp)
            # session.flush()
            customer._people.reorder()

        # continue with normal logic
        super().delete_instance(person)

    def touch_instance(self, person):
        """
        Supplements the default logic as follows:

        In addition to "touching" the person proper, we also "touch" each
        contact info record associated with them.
        """
        model = self.model

        # touch person, as per usual
        super().touch_instance(person)

        def touch(obj):
            change = model.Change()
            change.class_name = obj.__class__.__name__
            change.instance_uuid = obj.uuid
            change.deleted = False
            self.Session.add(change)

        # phone numbers
        for phone in person.phones:
            touch(phone)

        # email addresses
        for email in person.emails:
            touch(email)

        # mailing addresses
        for address in person.addresses:
            touch(address)

    def configure_common_form(self, f):
        super().configure_common_form(f)
        person = f.model_instance

        f.set_label('display_name', "Full Name")

        # TODO: should remove this?
        f.set_readonly('phone')
        f.set_label('phone', "Phone Number")

        f.set_renderer('default_phone', self.render_default_phone)
        if not self.creating and person.phones:
            f.set_default('default_phone', person.phones[0].number)

        # TODO: should remove this?
        f.set_readonly('email')
        f.set_label('email', "Email Address")

        f.set_renderer('default_email', self.render_default_email)
        if not self.creating and person.emails:
            f.set_default('default_email', person.emails[0].address)

        f.set_readonly('address')
        f.set_label('address', "Mailing Address")

        # employee
        if self.creating:
            f.remove_field('employee')
        else:
            f.set_readonly('employee')
            f.set_renderer('employee', self.render_employee)

        # customers
        if self.creating:
            f.remove_field('customers')
        else:
            f.set_readonly('customers')
            f.set_renderer('customers', self.render_customers)

        # members
        if self.creating:
            f.remove_field('members')
        else:
            f.set_readonly('members')
            f.set_renderer('members', self.render_members)

        # users
        if self.creating:
            f.remove_field('users')
        else:
            f.set_readonly('users')
            f.set_renderer('users', self.render_users)

    def render_employee(self, person, field):
        employee = person.employee
        if not employee:
            return ""
        text = str(employee)
        url = self.request.route_url('employees.view', uuid=employee.uuid)
        return tags.link_to(text, url)

    def render_customers(self, person, field):
        app = self.get_rattail_app()
        clientele = app.get_clientele_handler()

        customers = clientele.get_customers_for_account_holder(person)
        if not customers:
            return

        items = []
        for customer in customers:
            text = str(customer)
            if customer.number:
                text = "(#{}) {}".format(customer.number, text)
            elif customer.id:
                text = "({}) {}".format(customer.id, text)
            url = self.request.route_url('customers.view', uuid=customer.uuid)
            items.append(HTML.tag('li', c=[tags.link_to(text, url)]))

        return HTML.tag('ul', c=items)

    def render_members(self, person, field):
        members = person.members
        if not members:
            return ""
        items = []
        for member in members:
            text = str(member)
            if member.number:
                text = "(#{}) {}".format(member.number, text)
            elif member.id:
                text = "({}) {}".format(member.id, text)
            url = self.request.route_url('members.view', uuid=member.uuid)
            items.append(HTML.tag('li', c=[tags.link_to(text, url)]))
        return HTML.tag('ul', c=items)

    def render_users(self, person, field):
        users = person.users
        items = []
        for user in users:
            text = user.username
            url = self.request.route_url('users.view', uuid=user.uuid)
            items.append(HTML.tag('li', c=[tags.link_to(text, url)]))
        if items:
            return HTML.tag('ul', c=items)
        elif self.viewing and self.request.has_perm('users.create'):
            return HTML.tag('b-button', type='is-primary', c="Make User",
                            **{'@click': 'clickMakeUser()'})
        else:
            return ""

    def get_version_child_classes(self):
        model = self.model
        return [
            (model.PersonPhoneNumber, 'parent_uuid'),
            (model.PersonEmailAddress, 'parent_uuid'),
            (model.PersonMailingAddress, 'parent_uuid'),
            (model.Employee, 'person_uuid'),
            (model.CustomerPerson, 'person_uuid'),
            (model.VendorContact, 'person_uuid'),
        ]

    def should_expose_quickie_search(self):
        if self.expose_quickie_search:
            return True
        app = self.get_rattail_app()
        return app.get_people_handler().should_expose_quickie_search()

    def do_quickie_lookup(self, entry):
        app = self.get_rattail_app()
        return app.get_people_handler().quickie_lookup(entry, self.Session())

    def get_quickie_placeholder(self):
        app = self.get_rattail_app()
        return app.get_people_handler().get_quickie_search_placeholder()

    def get_quickie_result_url(self, person):
        return self.get_action_url('view_profile', person)

    def view_profile(self):
        """
        View which exposes the "full profile" for a given person, i.e. all
        related customer, employee, user info etc.
        """
        self.viewing = True
        app = self.get_rattail_app()
        person = self.get_instance()

        context = {
            'person': person,
            'instance': person,
            'instance_title': self.get_instance_title(person),
            'dynamic_content_title': self.get_context_content_title(person),
            'tabchecks': self.get_context_tabchecks(person),
            'person_data': self.get_context_person(person),
            'phone_type_options': self.get_phone_type_options(),
            'email_type_options': self.get_email_type_options(),
            'max_lengths': self.get_max_lengths(),
            'expose_customer_people': self.customers_should_expose_people(),
            'expose_customer_shoppers': self.customers_should_expose_shoppers(),
            'max_one_member': app.get_membership_handler().max_one_per_person(),
            'use_preferred_first_name': self.people_handler.should_use_preferred_first_name(),
            'expose_transactions': self.should_expose_profile_transactions(),
        }

        if context['expose_transactions']:
            context['transactions_grid'] = self.profile_transactions_grid(person, empty=True)

        if self.request.has_perm('people_profile.view_versions'):
            context['revisions_grid'] = self.profile_revisions_grid(person)

        return self.render_to_response('view_profile', context)

    def should_expose_profile_transactions(self):
        return self.rattail_config.get_bool('tailbone.people.profile.expose_transactions',
                                            default=False)

    def profile_transactions_grid(self, person, empty=False):
        app = self.get_rattail_app()
        trainwreck = app.get_trainwreck_handler()
        model = trainwreck.get_model()
        route_prefix = self.get_route_prefix()
        if empty:
            # TODO: surely there is a better way to have empty data..? but so
            # much logic depends on a query, can't just pass empty list here
            data = TrainwreckSession.query(model.Transaction)\
                                    .filter(model.Transaction.uuid == 'bogus')
        else:
            data = self.profile_transactions_query(person)
        factory = self.get_grid_factory()
        g = factory(
            f'{route_prefix}.profile.transactions.{person.uuid}',
            data,
            request=self.request,
            model_class=model.Transaction,
            ajax_data_url=self.get_action_url('view_profile_transactions', person),
            columns=[
                'start_time',
                'end_time',
                'system',
                'terminal_id',
                'receipt_number',
                'cashier_name',
                'customer_id',
                'customer_name',
                'total',
            ],
            labels={
                'terminal_id': "Terminal",
                'customer_id': "Customer " + app.get_customer_key_label(),
            },
            filterable=True,
            sortable=True,
            pageable=True,
            default_sortkey='end_time',
            default_sortdir='desc',
            component='transactions-grid',
        )
        if self.request.has_perm('trainwreck.transactions.view'):
            url = lambda row, i: self.request.route_url('trainwreck.transactions.view',
                                                        uuid=row.uuid)
            g.main_actions.append(grids.GridAction('view', icon='eye', url=url))
        g.load_settings()

        g.set_enum('system', self.enum.TRAINWRECK_SYSTEM)
        g.set_type('total', 'currency')

        return g

    def profile_transactions_query(self, person):
        """
        Method which must return the base query for the profile's POS
        Transactions grid data.
        """
        app = self.get_rattail_app()
        customer = app.get_customer(person)

        key_field = app.get_customer_key_field()
        customer_key = getattr(customer, key_field)
        if customer_key is not None:
            customer_key = str(customer_key)

        trainwreck = app.get_trainwreck_handler()
        model = trainwreck.get_model()
        query = TrainwreckSession.query(model.Transaction)\
                                 .filter(model.Transaction.customer_id == customer_key)
        return query

    def profile_transactions_data(self):
        """
        AJAX view to return new sorted, filtered data for transactions
        grid within profile view.
        """
        person = self.get_instance()
        grid = self.profile_transactions_grid(person)
        return grid.get_table_data()

    def get_context_tabchecks(self, person):
        app = self.get_rattail_app()
        membership = app.get_membership_handler()
        clientele = app.get_clientele_handler()
        tabchecks = {}

        # TODO: for efficiency, should only calculate checks for tabs
        # actually in use by app..(how) should that be configurable?

        # personal
        tabchecks['personal'] = True

        # member
        if membership.max_one_per_person():
            member = app.get_member(person)
            tabchecks['member'] = bool(member and member.active)
        else:
            members = membership.get_members_for_account_holder(person)
            tabchecks['member'] = any([m.active for m in members])

        # customer
        customers = clientele.get_customers_for_account_holder(person)
        tabchecks['customer'] = bool(customers)

        # shopper
        # TODO: what a hack! surely some of this belongs in handler
        shoppers = person.customer_shoppers
        shoppers = [shopper for shopper in shoppers
                    if shopper.shopper_number != 1]
        tabchecks['shopper'] = bool(shoppers)

        # employee
        employee = app.get_employee(person)
        tabchecks['employee'] = bool(employee and employee.status == self.enum.EMPLOYEE_STATUS_CURRENT)

        # notes
        tabchecks['notes'] = bool(person.notes)

        # user
        tabchecks['user'] = bool(person.users)

        return tabchecks

    def profile_changed_response(self, person):
        """
        Return common context result for all AJAX views which may
        change the profile details.  This is enough to update the
        page-wide things, and let other tabs know they should be
        refreshed when next displayed.
        """
        return {
            'person': self.get_context_person(person),
            'tabchecks': self.get_context_tabchecks(person),
        }

    def template_kwargs_view_profile(self, **kwargs):
        """
        Stub method so subclass can call `super()` for it.
        """
        return kwargs

    def get_max_lengths(self):
        app = self.get_rattail_app()
        model = self.model
        lengths = {
            'person_first_name': app.maxlen(model.Person.first_name),
            'person_middle_name': app.maxlen(model.Person.middle_name),
            'person_last_name': app.maxlen(model.Person.last_name),
            'address_street': app.maxlen(model.PersonMailingAddress.street),
            'address_street2': app.maxlen(model.PersonMailingAddress.street2),
            'address_city': app.maxlen(model.PersonMailingAddress.city),
            'address_state': app.maxlen(model.PersonMailingAddress.state),
            'address_zipcode': app.maxlen(model.PersonMailingAddress.zipcode),
        }
        if self.people_handler.should_use_preferred_first_name():
            lengths['person_preferred_first_name'] = app.maxlen(model.Person.preferred_first_name)
        return lengths

    def get_phone_type_options(self):
        """
        Returns a list of "phone type" options, for use in dropdown.
        """
        # TODO: should probably define this list somewhere else
        phone_types = [
            "Home",
            "Mobile",
            "Work",
            "Other",
            "Fax",
        ]
        return [{'value': typ, 'label': typ}
                for typ in phone_types]

    def get_email_type_options(self):
        """
        Returns a list of "email type" options, for use in dropdown.
        """
        # TODO: should probably define this list somewhere else
        email_types = [
            "Home",
            "Work",
            "Other",
        ]
        return [{'value': typ, 'label': typ}
                for typ in email_types]

    def get_context_person(self, person):

        context = {
            'uuid': person.uuid,
            'first_name': person.first_name,
            'middle_name': person.middle_name,
            'last_name': person.last_name,
            'display_name': person.display_name,
            'view_url': self.get_action_url('view', person),
            'view_profile_url': self.get_action_url('view_profile', person),
            'phones': self.get_context_phones(person),
            'emails': self.get_context_emails(person),
            'dynamic_content_title': self.get_context_content_title(person),
        }

        if self.people_handler.should_use_preferred_first_name():
            context['preferred_first_name'] = person.preferred_first_name

        if person.address:
            context['address'] = self.get_context_address(person.address)

        return context

    def get_context_shoppers(self, shoppers):
        data = []
        for shopper in shoppers:
            data.append(self.get_context_shopper(shopper))
        return data

    def get_context_shopper(self, shopper):
        app = self.get_rattail_app()
        customer = shopper.customer
        person = shopper.person
        customer_key = self.get_customer_key_field()
        account_holder = app.get_person(customer)
        context = {
            'uuid': shopper.uuid,
            'customer_uuid': customer.uuid,
            'customer_key': getattr(customer, customer_key),
            'customer_name': customer.name,
            'account_holder_uuid': customer.account_holder_uuid,
            'person_uuid': person.uuid,
            'first_name': person.first_name,
            'middle_name': person.middle_name,
            'last_name': person.last_name,
            'display_name': person.display_name,
            'view_profile_url': self.get_action_url('view_profile', person),
            'phones': self.get_context_phones(person),
            'emails': self.get_context_emails(person),
        }

        if account_holder:
            context.update({
                'account_holder_name': account_holder.display_name,
                'account_holder_view_profile_url': self.get_action_url(
                    'view_profile', account_holder),
            })

        return context

    def get_context_content_title(self, person):
        return str(person)

    def get_context_address(self, address):
        context = {
            'uuid': address.uuid,
            'street': address.street,
            'street2': address.street2,
            'city': address.city,
            'state': address.state,
            'zipcode': address.zipcode,
            'display': str(address),
        }

        model = self.model
        if isinstance(address, model.PersonMailingAddress):
            person = address.person
            context['invalid'] = self.handler.address_is_invalid(person, address)

        return context

    def get_context_customers(self, person):
        app = self.get_rattail_app()
        clientele = app.get_clientele_handler()
        expose_shoppers = self.customers_should_expose_shoppers()
        expose_people = self.customers_should_expose_people()

        customers = clientele.get_customers_for_account_holder(person)
        key = self.get_customer_key_field()
        data = []

        for customer in customers:
            context = {
                'uuid': customer.uuid,
                '_key': getattr(customer, key),
                'id': customer.id,
                'number': customer.number,
                'name': customer.name,
                'view_url': self.request.route_url('customers.view',
                                                   uuid=customer.uuid),
                'addresses': [self.get_context_address(a)
                              for a in customer.addresses],
                'external_links': [],
            }

            if customer.account_holder:
                context['account_holder'] = self.get_context_person(
                    customer.account_holder)

            if expose_shoppers:
                context['shoppers'] = [self.get_context_shopper(s)
                                       for s in customer.shoppers]

            if expose_people:
                context['people'] = [self.get_context_person(p)
                                     for p in customer.people]

            for supp in self.iter_view_supplements():
                if hasattr(supp, 'get_context_for_customer'):
                    context = supp.get_context_for_customer(customer, context)

            data.append(context)

        return data

    # TODO: this is duplicated in customers view module
    def customers_should_expose_shoppers(self):
        return self.rattail_config.getbool('rattail',
                                           'customers.expose_shoppers',
                                           default=True)

    # TODO: this is duplicated in customers view module
    def customers_should_expose_people(self):
        return self.rattail_config.getbool('rattail',
                                           'customers.expose_people',
                                           default=True)

    def get_context_members(self, person):
        app = self.get_rattail_app()
        membership = app.get_membership_handler()

        data = OrderedDict()
        members = membership.get_members_for_account_holder(person)
        for member in members:
            context = self.get_context_member(member)

            for supp in self.iter_view_supplements():
                if hasattr(supp, 'get_context_for_member'):
                    context = supp.get_context_for_member(member, context)

            data[member.uuid] = context

        return list(data.values())

    def get_context_member(self, member):
        app = self.get_rattail_app()
        person = app.get_person(member)

        profile_url = None
        if person:
            profile_url = self.request.route_url('people.view_profile',
                                                 uuid=person.uuid)

        key = self.get_member_key_field()
        equity_total = sum([payment.amount for payment in member.equity_payments])
        data = {
            'uuid': member.uuid,
            '_key': getattr(member, key),
            'number': member.number,
            'id': member.id,
            'active': member.active,
            'joined': str(member.joined) if member.joined else None,
            'withdrew': str(member.withdrew) if member.withdrew else None,
            'customer_uuid': member.customer_uuid,
            'customer_name': member.customer.name if member.customer else None,
            'person_uuid': member.person_uuid,
            'display': str(member),
            'person_display_name': member.person.display_name if member.person else None,
            'view_url': self.request.route_url('members.view', uuid=member.uuid),
            'view_profile_url': profile_url,
            'equity_total_display': app.render_currency(equity_total),
            'external_links': [],
        }

        membership_type = member.membership_type
        if membership_type:
            data.update({
                'membership_type_uuid': membership_type.uuid,
                'membership_type_number': membership_type.number,
                'membership_type_name': membership_type.name,
                'view_membership_type_url': self.request.route_url(
                    'membership_types.view', uuid=membership_type.uuid),
            })

        return data

    def get_context_employee(self, employee):
        """
        Return a dict of context data for the given employee.
        """
        app = self.get_rattail_app()
        handler = app.get_employment_handler()
        context = handler.get_context_employee(employee)
        context.setdefault('external_links', [])

        for supp in self.iter_view_supplements():
            if hasattr(supp, 'get_context_for_employee'):
                context = supp.get_context_for_employee(employee, context)

        context['view_url'] = self.request.route_url('employees.view', uuid=employee.uuid)
        return context

    def get_context_employee_history(self, employee):
        data = []
        if employee:
            for history in employee.sorted_history(reverse=True):
                data.append({
                    'uuid': history.uuid,
                    'start_date': str(history.start_date),
                    'end_date': str(history.end_date or ''),
                })
        return data

    def get_context_notes(self, person):
        data = []
        notes = sorted(person.notes, key=lambda n: n.created, reverse=True)
        for note in notes:
            data.append(self.get_context_note(note))
        return data

    def get_context_note(self, note):
        app = self.get_rattail_app()
        return {
            'uuid': note.uuid,
            'note_type': note.type,
            'note_type_display': self.enum.PERSON_NOTE_TYPE.get(note.type, note.type),
            'subject': note.subject,
            'text': note.text,
            'created_display': raw_datetime(self.rattail_config, note.created),
            'created_by_display': str(note.created_by),
        }

    def get_note_type_options(self):
        return [{'value': k, 'label': v}
                for k, v in self.enum.PERSON_NOTE_TYPE.items()]

    def get_context_users(self, person):
        data = []
        users = person.users
        for user in users:
            data.append(self.get_context_user(user))
        return data

    def get_context_user(self, user):
        app = self.get_rattail_app()
        return {
            'uuid': user.uuid,
            'username': user.username,
            'display_name': user.display_name,
            'email_address': app.get_contact_email_address(user),
            'active': user.active,
            'view_url': self.request.route_url('users.view', uuid=user.uuid),
        }

    def ensure_customer(self, person):
        """
        Return the `Customer` record for the given person, establishing it
        first if necessary.
        """
        app = self.get_rattail_app()
        handler = app.get_clientele_handler()
        customer = handler.ensure_customer(person)
        return customer

    def profile_tab_personal(self):
        """
        Fetch personal tab data for profile view.
        """
        # TODO: no need to return primary person data, since that
        # always comes back via normal profile_changed_response()
        # ..so for now this is a no-op..

        # person = self.get_instance()
        return {
            # 'person': self.get_context_person(person),
        }

    def profile_edit_name(self):
        """
        View which allows a person's name to be updated.
        """
        person = self.get_instance()
        data = dict(self.request.json_body)

        kw = {
            'first': data['first_name'],
            'middle': data['middle_name'],
            'last': data['last_name'],
        }

        if self.people_handler.should_use_preferred_first_name():
            kw['preferred_first'] = data['preferred_first_name']

        self.handler.update_names(person, **kw)

        self.Session.flush()
        return self.profile_changed_response(person)

    def get_context_phones(self, person):
        data = []
        for phone in person.phones:
            data.append({
                'uuid': phone.uuid,
                'type': phone.type,
                'number': phone.number,
                'preferred': phone.preferred,
                'preference': phone.preference,
            })
        return data

    def profile_add_phone(self):
        """
        View which adds a new phone number for the person.
        """
        person = self.get_instance()
        data = dict(self.request.json_body)

        try:
            phone = self.handler.add_phone(person, data['phone_number'],
                                           type=data['phone_type'],
                                           preferred=data['phone_preferred'])
        except Exception as error:
            log.warning("failed to add phone", exc_info=True)
            return {'error': simple_error(error)}

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_update_phone(self):
        """
        View which updates a phone number for the person.
        """
        model = self.model
        person = self.get_instance()
        data = dict(self.request.json_body)

        phone = self.Session.get(model.PersonPhoneNumber, data['phone_uuid'])
        if not phone:
            return {'error': "Phone not found."}

        kwargs = {
            'number': data['phone_number'],
            'type': data['phone_type'],
        }
        if 'phone_preferred' in data:
            kwargs['preferred'] = data['phone_preferred']

        try:
            phone = self.handler.update_phone(person, phone, **kwargs)
        except Exception as error:
            log.warning("failed to update phone", exc_info=True)
            return {'error': simple_error(error)}

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_delete_phone(self):
        """
        View which allows a person's phone number to be deleted.
        """
        model = self.model
        person = self.get_instance()
        data = dict(self.request.json_body)

        # validate phone
        phone = self.Session.get(model.PersonPhoneNumber, data['phone_uuid'])
        if not phone:
            return {'error': "Phone not found."}
        if phone not in person.phones:
            return {'error': "Phone does not belong to this person."}

        # remove phone
        person.remove_phone(phone)

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_set_preferred_phone(self):
        """
        View which allows a person's "preferred" phone to be set.
        """
        model = self.model
        person = self.get_instance()
        data = dict(self.request.json_body)

        # validate phone
        phone = self.Session.get(model.PersonPhoneNumber, data['phone_uuid'])
        if not phone:
            return {'error': "Phone not found."}
        if phone not in person.phones:
            return {'error': "Phone does not belong to this person."}

        # update phone preference
        person.set_primary_phone(phone)

        self.Session.flush()
        return self.profile_changed_response(person)

    def get_context_emails(self, person):
        data = []
        for email in person.emails:
            data.append({
                'uuid': email.uuid,
                'type': email.type,
                'address': email.address,
                'invalid': email.invalid,
                'preferred': email.preferred,
                'preference': email.preference,
            })
        return data

    def profile_add_email(self):
        """
        View which adds a new email address for the person.
        """
        person = self.get_instance()
        data = dict(self.request.json_body)

        kwargs = {
            'type': data['email_type'],
            'invalid': False,
        }
        if 'email_preferred' in data:
            kwargs['preferred'] = data['email_preferred']

        try:
            email = self.handler.add_email(person, data['email_address'], **kwargs)
        except Exception as error:
            log.warning("failed to add email", exc_info=True)
            return {'error': simple_error(error)}

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_update_email(self):
        """
        View which updates an email address for the person.
        """
        model = self.model
        person = self.get_instance()
        data = dict(self.request.json_body)

        email = self.Session.get(model.PersonEmailAddress, data['email_uuid'])
        if not email:
            return {'error': "Email not found."}

        try:
            email = self.handler.update_email(person, email,
                                              address=data['email_address'],
                                              type=data['email_type'],
                                              invalid=data['email_invalid'])
        except Exception as error:
            log.warning("failed to add email", exc_info=True)
            return {'error': simple_error(error)}

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_delete_email(self):
        """
        View which allows a person's email address to be deleted.
        """
        model = self.model
        person = self.get_instance()
        data = dict(self.request.json_body)

        # validate email
        email = self.Session.get(model.PersonEmailAddress, data['email_uuid'])
        if not email:
            return {'error': "Email not found."}
        if email not in person.emails:
            return {'error': "Email does not belong to this person."}

        # remove email
        person.remove_email(email)

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_set_preferred_email(self):
        """
        View which allows a person's "preferred" email to be set.
        """
        model = self.model
        person = self.get_instance()
        data = dict(self.request.json_body)

        # validate email
        email = self.Session.get(model.PersonEmailAddress, data['email_uuid'])
        if not email:
            return {'error': "Email not found."}
        if email not in person.emails:
            return {'error': "Email does not belong to this person."}

        # update email preference
        person.set_primary_email(email)

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_edit_address(self):
        """
        View which allows a person's mailing address to be updated.
        """
        person = self.get_instance()
        data = dict(self.request.json_body)

        # update person address
        address = self.people_handler.ensure_address(person)
        self.people_handler.update_address(person, address, **data)

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_tab_member(self):
        """
        Fetch member tab data for profile view.
        """
        app = self.get_rattail_app()
        membership = app.get_membership_handler()
        person = self.get_instance()

        max_one_member = membership.max_one_per_person()

        context = {
            'max_one_member': max_one_member,
        }

        if max_one_member:
            member = app.get_member(person)
            context['member'] = {'exists': bool(member)}
            if member:
                context['member'].update(self.get_context_member(member))
        else:
            context['members'] = self.get_context_members(person)

        return context

    def profile_tab_customer(self):
        """
        Fetch customer tab data for profile view.
        """
        person = self.get_instance()
        return {
            'customers': self.get_context_customers(person),
        }

    def profile_tab_shopper(self):
        """
        Fetch shopper tab data for profile view.
        """
        person = self.get_instance()

        # TODO: what a hack! surely some of this belongs in handler
        shoppers = person.customer_shoppers
        shoppers = [shopper for shopper in shoppers
                    if shopper.shopper_number != 1]

        return {
            'shoppers': self.get_context_shoppers(shoppers),
        }

    def profile_tab_employee(self):
        """
        Fetch employee tab data for profile view.
        """
        app = self.get_rattail_app()
        person = self.get_instance()
        employee = app.get_employee(person)
        return {
            'employee': self.get_context_employee(employee) if employee else {},
            'employee_history': self.get_context_employee_history(employee),
        }

    def profile_start_employee(self):
        """
        View which will cause the person to start being an employee.
        """
        person = self.get_instance()
        app = self.get_rattail_app()
        handler = app.get_employment_handler()

        reason = handler.why_not_begin_employment(person)
        if reason:
            return {'error': reason}

        data = self.request.json_body
        start_date = datetime.datetime.strptime(data['start_date'], '%Y-%m-%d').date()
        employee = handler.begin_employment(person, start_date,
                                            employee_id=data['id'])
        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_end_employee(self):
        """
        View which will cause the person to stop being an employee.
        """
        person = self.get_instance()
        app = self.get_rattail_app()
        handler = app.get_employment_handler()

        reason = handler.why_not_end_employment(person)
        if reason:
            return {'error': reason}

        data = dict(self.request.json_body)
        end_date = datetime.datetime.strptime(data['end_date'], '%Y-%m-%d').date()
        employee = handler.get_employee(person)
        handler.end_employment(employee, end_date,
                               revoke_access=data.get('revoke_access'))
        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_edit_employee_history(self):
        """
        AJAX view for updating an employee history record.
        """
        model = self.model
        person = self.get_instance()
        employee = person.employee

        uuid = self.request.json_body['uuid']
        history = self.Session.get(model.EmployeeHistory, uuid)
        if not history or history not in employee.history:
            return {'error': "Must specify a valid Employee History record for this Person."}

        # all history records have a start date, so always update that
        start_date = self.request.json_body['start_date']
        start_date = datetime.datetime.strptime(start_date, '%Y-%m-%d').date()
        history.start_date = start_date

        # only update end_date if history already had one
        if history.end_date:
            end_date = self.request.json_body['end_date']
            end_date = datetime.datetime.strptime(end_date, '%Y-%m-%d').date()
            history.end_date = end_date

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_update_employee_id(self):
        """
        View to update an employee's ID value.
        """
        app = self.get_rattail_app()
        employment = app.get_employment_handler()

        person = self.get_instance()
        employee = employment.get_employee(person)

        data = self.request.json_body
        employee.id = data['employee_id']

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_tab_notes(self):
        """
        Fetch notes tab data for profile view.
        """
        person = self.get_instance()
        return {
            'notes': self.get_context_notes(person),
            'note_types': self.get_note_type_options(),
        }

    def profile_tab_user(self):
        """
        Fetch user tab data for profile view.
        """
        app = self.get_rattail_app()
        auth = app.get_auth_handler()
        person = self.get_instance()
        context = {
            'users': self.get_context_users(person),
        }

        if not context['users']:
            context['suggested_username'] = auth.generate_unique_username(self.Session(),
                                                                          person=person)

        return context

    def profile_make_user(self):
        """
        Create a new user account, presumably from the profile view.
        """
        app = self.get_rattail_app()
        model = self.model
        auth = app.get_auth_handler()

        person = self.get_instance()
        if person.users:
            return {'error': f"This person already has {len(person.users)} user accounts."}

        data = self.request.json_body
        user = auth.make_user(session=self.Session(),
                              person=person,
                              username=data['username'],
                              active=data['active'])

        self.Session.flush()
        return self.profile_changed_response(person)

    def profile_revisions_grid(self, person):
        route_prefix = self.get_route_prefix()
        factory = self.get_grid_factory()
        g = factory(
            '{}.profile.revisions'.format(route_prefix),
            [],                 # start with empty data!
            request=self.request,
            columns=[
                'changed',
                'changed_by',
                'remote_addr',
                'comment',
            ],
            labels={
                'remote_addr': "IP Address",
            },
            linked_columns=[
                'changed',
                'changed_by',
                'comment',
            ],
            main_actions=[
                self.make_action('view', icon='eye', url='#',
                                 click_handler='viewRevision(props.row)'),
            ],
        )
        return g

    def profile_revisions_collect(self, person, versions=None):
        model = self.model
        versions = versions or []

        # Person
        cls = continuum.version_class(model.Person)
        query = self.Session.query(cls)\
                            .filter(cls.uuid == person.uuid)
        versions.extend(query.all())

        # User
        cls = continuum.version_class(model.User)
        query = self.Session.query(cls)\
                            .filter(cls.person_uuid == person.uuid)
        versions.extend(query.all())

        # Member
        cls = continuum.version_class(model.Member)
        query = self.Session.query(cls)\
                            .filter(cls.person_uuid == person.uuid)
        versions.extend(query.all())

        # Employee
        cls = continuum.version_class(model.Employee)
        query = self.Session.query(cls)\
                            .filter(cls.person_uuid == person.uuid)
        versions.extend(query.all())

        # EmployeeHistory
        cls = continuum.version_class(model.EmployeeHistory)
        query = self.Session.query(cls)\
                            .join(model.Employee,
                                  model.Employee.uuid == cls.employee_uuid)\
                            .filter(model.Employee.person_uuid == person.uuid)
        versions.extend(query.all())

        # PersonPhoneNumber
        cls = continuum.version_class(model.PersonPhoneNumber)
        query = self.Session.query(cls)\
                            .filter(cls.parent_uuid == person.uuid)
        versions.extend(query.all())

        # PersonEmailAddress
        cls = continuum.version_class(model.PersonEmailAddress)
        query = self.Session.query(cls)\
                            .filter(cls.parent_uuid == person.uuid)
        versions.extend(query.all())

        # PersonMailingAddress
        cls = continuum.version_class(model.PersonMailingAddress)
        query = self.Session.query(cls)\
                            .filter(cls.parent_uuid == person.uuid)
        versions.extend(query.all())

        # Customer (account_holder)
        cls = continuum.version_class(model.Customer)
        query = self.Session.query(cls)\
                            .filter(cls.account_holder_uuid == person.uuid)
        versions.extend(query.all())

        # CustomerShopper (from Customer perspective)
        cls = continuum.version_class(model.CustomerShopper)
        query = self.Session.query(cls)\
                            .join(model.Customer, model.Customer.uuid == cls.customer_uuid)\
                            .filter(model.Customer.account_holder_uuid == person.uuid)
        versions.extend(query.all())

        # CustomerShopperHistory (from Customer perspective)
        cls = continuum.version_class(model.CustomerShopperHistory)
        standin = continuum.version_class(model.CustomerShopper)
        query = self.Session.query(cls)\
                            .join(standin, standin.uuid == cls.shopper_uuid)\
                            .join(model.Customer, model.Customer.uuid == standin.customer_uuid)\
                            .filter(model.Customer.account_holder_uuid == person.uuid)
        versions.extend(query.all())

        # CustomerShopper (from Shopper perspective)
        cls = continuum.version_class(model.CustomerShopper)
        query = self.Session.query(cls)\
                            .filter(cls.person_uuid == person.uuid)
        versions.extend(query.all())

        # CustomerShopperHistory (from Shopper perspective)
        cls = continuum.version_class(model.CustomerShopperHistory)
        standin = continuum.version_class(model.CustomerShopper)
        query = self.Session.query(cls)\
                            .join(standin, standin.uuid == cls.shopper_uuid)\
                            .filter(standin.person_uuid == person.uuid)
        versions.extend(query.all())

        # PersonNote
        cls = continuum.version_class(model.PersonNote)
        query = self.Session.query(cls)\
                            .filter(cls.parent_uuid == person.uuid)
        versions.extend(query.all())

        return versions

    def profile_revisions_data(self):
        """
        View which locates and organizes all relevant "transaction"
        (version) history data for a given Person.  Returns JSON, for
        use with the table element on the full profile view.
        """
        person = self.get_instance()
        versions = self.profile_revisions_collect(person)

        # organize final table data
        data = []
        all_txns = set([v.transaction for v in versions])
        for i, txn in enumerate(
                sorted(all_txns, key=lambda txn: txn.issued_at, reverse=True),
                1):
            data.append({
                'txnid': txn.id,
                'changed': raw_datetime(self.rattail_config, txn.issued_at),
                'changed_by': str(txn.user or '') or None,
                'remote_addr': txn.remote_addr,
                'comment': txn.meta.get('comment'),
            })
            # also stash the sequential index for this transaction, for use later
            txn._sequential_index = i

        # also organize final transaction/versions (diff) map
        vmap = {}
        for version in versions:
            fields = self.fields_for_version(version)

            old_data = {}
            new_data = {}
            for field in fields:
                if version.previous:
                    old_data[field] = getattr(version.previous, field)
                new_data[field] = getattr(version, field)
            diff = self.make_version_diff(version, old_data, new_data, fields=fields)

            if version.transaction_id not in vmap:
                txn = version.transaction
                prev_txnid = None
                next_txnid = None
                if txn._sequential_index < len(data):
                    prev_txnid = data[txn._sequential_index]['txnid']
                if txn._sequential_index > 1:
                    next_txnid = data[txn._sequential_index - 2]['txnid']
                vmap[txn.id] = {
                    'index': txn._sequential_index,
                    'txnid': txn.id,
                    'prev_txnid': prev_txnid,
                    'next_txnid': next_txnid,
                    'changed': raw_datetime(self.rattail_config, txn.issued_at,
                                            verbose=True),
                    'changed_by': str(txn.user or '') or None,
                    'remote_addr': txn.remote_addr,
                    'comment': txn.meta.get('comment'),
                    'versions': [],
                }

            vmap[version.transaction_id]['versions'].append(diff.as_struct())

        return {'data': data, 'vmap': vmap}

    def make_note_form(self, mode, person):
        schema = NoteSchema().bind(session=self.Session(),
                                   person_uuid=person.uuid)
        if mode == 'create':
            del schema['uuid']
        form = forms.Form(schema=schema, request=self.request)
        if mode != 'delete':
            form.set_validator('note_type', colander.OneOf(self.enum.PERSON_NOTE_TYPE))
        return form

    def profile_add_note(self):
        person = self.get_instance()
        form = self.make_note_form('create', person)
        if not form.validate():
            return {'error': str(form.make_deform_form().error)}

        note = self.create_note(person, form)
        self.Session.flush()
        return self.profile_changed_response(person)

    def create_note(self, person, form):
        model = self.model
        note = model.PersonNote()
        note.type = form.validated['note_type']
        note.subject = form.validated['note_subject']
        note.text = form.validated['note_text']
        note.created_by = self.request.user
        person.notes.append(note)
        return note

    def profile_edit_note(self):
        person = self.get_instance()
        form = self.make_note_form('edit', person)
        if not form.validate():
            return {'error': str(form.make_deform_form().error)}

        note = self.update_note(person, form)
        self.Session.flush()
        return self.profile_changed_response(person)

    def update_note(self, person, form):
        model = self.model
        note = self.Session.get(model.PersonNote, form.validated['uuid'])
        note.subject = form.validated['note_subject']
        note.text = form.validated['note_text']
        return note

    def profile_delete_note(self):
        person = self.get_instance()
        form = self.make_note_form('delete', person)
        if not form.validate():
            return {'error': str(form.make_deform_form().error)}

        self.delete_note(person, form)
        self.Session.flush()
        return self.profile_changed_response(person)

    def delete_note(self, person, form):
        model = self.model
        note = self.Session.get(model.PersonNote, form.validated['uuid'])
        self.Session.delete(note)

    def make_user(self):
        model = self.model
        uuid = self.request.POST['person_uuid']
        person = self.Session.get(model.Person, uuid)
        if not person:
            return self.notfound()
        if person.users:
            raise RuntimeError("person {} already has {} user accounts: ".format(
                person.uuid, len(person.users), person))
        user = model.User()
        user.username = api.make_username(person)
        user.person = person
        user.active = False
        self.Session.add(user)
        self.Session.flush()
        self.request.session.flash("User has been created: {}".format(user.username))
        return self.redirect(self.request.route_url('users.view', uuid=user.uuid))

    def request_merge(self):
        """
        Create a new merge request for the given 2 people.
        """
        self.handler.request_merge(self.request.user,
                                   self.request.POST['removing_uuid'],
                                   self.request.POST['keeping_uuid'])
        return self.redirect(self.get_index_url())

    def configure_get_simple_settings(self):
        return [

            # General
            {'section': 'rattail',
             'option': 'people.straight_to_profile',
             'type': bool},
            {'section': 'rattail',
             'option': 'people.expose_quickie_search',
             'type': bool},
            {'section': 'rattail',
             'option': 'people.handler'},


            # Profile View
            {'section': 'tailbone',
             'option': 'people.profile.expose_transactions',
             'type': bool},
        ]

    @classmethod
    def defaults(cls, config):
        cls._people_defaults(config)
        cls._defaults(config)

    @classmethod
    def _people_defaults(cls, config):
        permission_prefix = cls.get_permission_prefix()
        route_prefix = cls.get_route_prefix()
        url_prefix = cls.get_url_prefix()
        instance_url_prefix = cls.get_instance_url_prefix()
        model_key = cls.get_model_key()
        model_title = cls.get_model_title()
        model_title_plural = cls.get_model_title_plural()

        # "profile" perms
        # TODO: should let view class (or config) determine which of these are available
        config.add_tailbone_permission_group('people_profile', "People Profile View")
        config.add_tailbone_permission('people_profile', 'people_profile.toggle_employee',
                                       "Toggle the person's Employee status")
        config.add_tailbone_permission('people_profile', 'people_profile.edit_employee_history',
                                       "Edit the person's Employee History records")

        # view profile
        config.add_tailbone_permission(permission_prefix, '{}.view_profile'.format(permission_prefix),
                                       "View full \"profile\" for {}".format(model_title))
        config.add_route('{}.view_profile'.format(route_prefix), '{}/{{{}}}/profile'.format(url_prefix, model_key),
                         request_method='GET')
        config.add_view(cls, attr='view_profile', route_name='{}.view_profile'.format(route_prefix),
                        permission='{}.view_profile'.format(permission_prefix))

        # profile - refresh personal tab
        config.add_route(f'{route_prefix}.profile_tab_personal',
                         f'{instance_url_prefix}/profile/tab-personal',
                         request_method='GET')
        config.add_view(cls, attr='profile_tab_personal',
                        route_name=f'{route_prefix}.profile_tab_personal',
                        renderer='json')

        # profile - edit personal details
        config.add_tailbone_permission('people_profile',
                                       'people_profile.edit_person',
                                       "Edit the Personal details")

        # profile - edit name
        config.add_route('{}.profile_edit_name'.format(route_prefix),
                         '{}/profile/edit-name'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_edit_name',
                        route_name='{}.profile_edit_name'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - add phone
        config.add_route('{}.profile_add_phone'.format(route_prefix),
                         '{}/profile/add-phone'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_add_phone',
                        route_name='{}.profile_add_phone'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - update phone
        config.add_route('{}.profile_update_phone'.format(route_prefix),
                         '{}/profile/update-phone'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_update_phone',
                        route_name='{}.profile_update_phone'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - delete phone
        config.add_route('{}.profile_delete_phone'.format(route_prefix),
                         '{}/profile/delete-phone'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_delete_phone',
                        route_name='{}.profile_delete_phone'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - set preferred phone
        config.add_route('{}.profile_set_preferred_phone'.format(route_prefix),
                         '{}/profile/set-preferred-phone'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_set_preferred_phone',
                        route_name='{}.profile_set_preferred_phone'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - add email
        config.add_route('{}.profile_add_email'.format(route_prefix),
                         '{}/profile/add-email'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_add_email',
                        route_name='{}.profile_add_email'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - update email
        config.add_route('{}.profile_update_email'.format(route_prefix),
                         '{}/profile/update-email'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_update_email',
                        route_name='{}.profile_update_email'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - delete email
        config.add_route('{}.profile_delete_email'.format(route_prefix),
                         '{}/profile/delete-email'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_delete_email',
                        route_name='{}.profile_delete_email'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - set preferred email
        config.add_route('{}.profile_set_preferred_email'.format(route_prefix),
                         '{}/profile/set-preferred-email'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_set_preferred_email',
                        route_name='{}.profile_set_preferred_email'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - edit address
        config.add_route('{}.profile_edit_address'.format(route_prefix),
                         '{}/profile/edit-address'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_edit_address',
                        route_name='{}.profile_edit_address'.format(route_prefix),
                        renderer='json',
                        permission='people_profile.edit_person')

        # profile - refresh member tab
        config.add_route(f'{route_prefix}.profile_tab_member',
                         f'{instance_url_prefix}/profile/tab-member',
                         request_method='GET')
        config.add_view(cls, attr='profile_tab_member',
                        route_name=f'{route_prefix}.profile_tab_member',
                        renderer='json')

        # profile - refresh customer tab
        config.add_route(f'{route_prefix}.profile_tab_customer',
                         f'{instance_url_prefix}/profile/tab-customer',
                         request_method='GET')
        config.add_view(cls, attr='profile_tab_customer',
                        route_name=f'{route_prefix}.profile_tab_customer',
                        renderer='json')

        # profile - refresh shopper tab
        config.add_route(f'{route_prefix}.profile_tab_shopper',
                         f'{instance_url_prefix}/profile/tab-shopper',
                         request_method='GET')
        config.add_view(cls, attr='profile_tab_shopper',
                        route_name=f'{route_prefix}.profile_tab_shopper',
                        renderer='json')

        # profile - refresh employee tab
        config.add_route(f'{route_prefix}.profile_tab_employee',
                         f'{instance_url_prefix}/profile/tab-employee',
                         request_method='GET')
        config.add_view(cls, attr='profile_tab_employee',
                        route_name=f'{route_prefix}.profile_tab_employee',
                        renderer='json')

        # profile - start employee
        config.add_route('{}.profile_start_employee'.format(route_prefix), '{}/profile/start-employee'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_start_employee', route_name='{}.profile_start_employee'.format(route_prefix),
                        permission='people_profile.toggle_employee', renderer='json')

        # profile - end employee
        config.add_route('{}.profile_end_employee'.format(route_prefix), '{}/profile/end-employee'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_end_employee', route_name='{}.profile_end_employee'.format(route_prefix),
                        permission='people_profile.toggle_employee', renderer='json')

        # profile - edit employee history
        config.add_route('{}.profile_edit_employee_history'.format(route_prefix), '{}/profile/edit-employee-history'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_edit_employee_history', route_name='{}.profile_edit_employee_history'.format(route_prefix),
                        permission='people_profile.edit_employee_history', renderer='json')

        # profile - update employee ID
        config.add_route('{}.profile_update_employee_id'.format(route_prefix),
                         '{}/profile/update-employee-id'.format(instance_url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='profile_update_employee_id',
                        route_name='{}.profile_update_employee_id'.format(route_prefix),
                        renderer='json',
                        permission='employees.edit')

        # profile - refresh notes tab
        config.add_route(f'{route_prefix}.profile_tab_notes',
                         f'{instance_url_prefix}/profile/tab-notes',
                         request_method='GET')
        config.add_view(cls, attr='profile_tab_notes',
                        route_name=f'{route_prefix}.profile_tab_notes',
                        renderer='json')

        # profile - refresh user tab
        config.add_route(f'{route_prefix}.profile_tab_user',
                         f'{instance_url_prefix}/profile/tab-user',
                         request_method='GET')
        config.add_view(cls, attr='profile_tab_user',
                        route_name=f'{route_prefix}.profile_tab_user',
                        renderer='json')

        # profile - make user
        config.add_route(f'{route_prefix}.profile_make_user',
                         f'{instance_url_prefix}/make-user',
                         request_method='POST')
        config.add_view(cls, attr='profile_make_user',
                        route_name=f'{route_prefix}.profile_make_user',
                        permission='users.create',
                        renderer='json')

        # profile - revisions data
        config.add_tailbone_permission('people_profile',
                                       'people_profile.view_versions',
                                       "View full version history for a profile")
        config.add_route(f'{route_prefix}.view_profile_revisions',
                         f'{instance_url_prefix}/profile/revisions',
                         request_method='GET')
        config.add_view(cls, attr='profile_revisions_data',
                        route_name=f'{route_prefix}.view_profile_revisions',
                        permission='people_profile.view_versions',
                        renderer='json')

        # profile - add note
        config.add_tailbone_permission('people_profile',
                                       'people_profile.add_note',
                                       "Add new Note records")
        config.add_route(f'{route_prefix}.profile_add_note',
                         f'{instance_url_prefix}/profile/new-note',
                         request_method='POST')
        config.add_view(cls, attr='profile_add_note',
                        route_name=f'{route_prefix}.profile_add_note',
                        permission='people_profile.add_note',
                        renderer='json')

        # profile - edit note
        config.add_tailbone_permission('people_profile',
                                       'people_profile.edit_note',
                                       "Edit Note records")
        config.add_route(f'{route_prefix}.profile_edit_note',
                         f'{instance_url_prefix}/profile/edit-note',
                         request_method='POST')
        config.add_view(cls, attr='profile_edit_note',
                        route_name=f'{route_prefix}.profile_edit_note',
                        permission='people_profile.edit_note',
                        renderer='json')

        # profile - delete note
        config.add_tailbone_permission('people_profile',
                                       'people_profile.delete_note',
                                       "Delete Note records")
        config.add_route(f'{route_prefix}.profile_delete_note',
                         f'{instance_url_prefix}/profile/delete-note',
                         request_method='POST')
        config.add_view(cls, attr='profile_delete_note',
                        route_name=f'{route_prefix}.profile_delete_note',
                        permission='people_profile.delete_note',
                        renderer='json')

        # profile - transactions data
        config.add_route(f'{route_prefix}.view_profile_transactions',
                         f'{instance_url_prefix}/profile/transactions',
                         request_method='GET')
        config.add_view(cls, attr='profile_transactions_data',
                        route_name=f'{route_prefix}.view_profile_transactions',
                        permission=f'{permission_prefix}.view_profile',
                        renderer='json')

        # make user for person
        config.add_route('{}.make_user'.format(route_prefix), '{}/make-user'.format(url_prefix),
                         request_method='POST')
        config.add_view(cls, attr='make_user', route_name='{}.make_user'.format(route_prefix),
                        permission='users.create')

        # merge requests
        if cls.mergeable:
            config.add_tailbone_permission(permission_prefix, '{}.request_merge'.format(permission_prefix),
                                           "Request merge for 2 {}".format(model_title_plural))
            config.add_route('{}.request_merge'.format(route_prefix), '{}/request-merge'.format(url_prefix),
                             request_method='POST')
            config.add_view(cls, attr='request_merge', route_name='{}.request_merge'.format(route_prefix),
                            permission='{}.request_merge'.format(permission_prefix))


class PersonNoteView(MasterView):
    """
    Master view for the PersonNote class.
    """
    model_class = PersonNote
    route_prefix = 'person_notes'
    url_prefix = '/people/notes'
    has_versions = True

    grid_columns = [
        'person',
        'type',
        'subject',
        'created',
        'created_by',
    ]

    form_fields = [
        'person',
        'type',
        'subject',
        'text',
        'created',
        'created_by',
    ]

    def get_instance_title(self, note):
        return note.subject or "(no subject)"

    def configure_grid(self, g):
        super().configure_grid(g)
        model = self.model

        # person
        g.set_joiner('person', lambda q: q.join(model.Person,
                                                model.Person.uuid == model.PersonNote.parent_uuid))
        g.set_sorter('person', model.Person.display_name)
        g.set_filter('person', model.Person.display_name, label="Person Name")

        # created_by
        CreatorPerson = orm.aliased(model.Person)
        g.set_joiner('created_by', lambda q: q.join(model.User).outerjoin(CreatorPerson,
                                                                          CreatorPerson.uuid == model.User.person_uuid))
        g.set_sorter('created_by', CreatorPerson.display_name)

        g.set_sort_defaults('created', 'desc')

        g.set_link('person')
        g.set_link('subject')
        g.set_link('created')

    def configure_form(self, f):
        super().configure_form(f)

        # person
        f.set_readonly('person')
        f.set_renderer('person', self.render_person)

        # created
        f.set_readonly('created')

        # created_by
        f.set_readonly('created_by')
        f.set_renderer('created_by', self.render_user)


@colander.deferred
def valid_note_uuid(node, kw):
    session = kw['session']
    person_uuid = kw['person_uuid']
    def validate(node, value):
        note = session.get(PersonNote, value)
        if not note:
            raise colander.Invalid(node, "Note not found")
        if note.person.uuid != person_uuid:
            raise colander.Invalid(node, "Note is for the wrong person")
        return note.uuid
    return validate


class NoteSchema(colander.Schema):

    uuid = colander.SchemaNode(colander.String(),
                               validator=valid_note_uuid)

    note_type = colander.SchemaNode(colander.String())

    note_subject = colander.SchemaNode(colander.String(), missing='')

    note_text = colander.SchemaNode(colander.String(), missing='')


class MergePeopleRequestView(MasterView):
    """
    Master view for the MergePeopleRequest class.
    """
    model_class = MergePeopleRequest
    route_prefix = 'people_merge_requests'
    url_prefix = '/people/merge-requests'
    creatable = False
    editable = False

    labels = {
        'removing_uuid': "Removing",
        'keeping_uuid': "Keeping",
    }

    grid_columns = [
        'removing_uuid',
        'keeping_uuid',
        'requested',
        'requested_by',
        'merged',
        'merged_by',
    ]

    form_fields = [
        'removing_uuid',
        'keeping_uuid',
        'requested',
        'requested_by',
        'merged',
        'merged_by',
    ]

    def configure_grid(self, g):
        super().configure_grid(g)

        g.set_renderer('removing_uuid', self.render_referenced_person_name)
        g.set_renderer('keeping_uuid', self.render_referenced_person_name)

        g.filters['merged'].default_active = True
        g.filters['merged'].default_verb = 'is_null'

        g.set_sort_defaults('requested', 'desc')

        g.set_link('removing_uuid')
        g.set_link('keeping_uuid')

    def render_referenced_person_name(self, merge_request, field):
        model = self.model
        uuid = getattr(merge_request, field)
        person = self.Session.get(model.Person, uuid)
        if person:
            return str(person)
        return "(person not found)"

    def get_instance_title(self, merge_request):
        model = self.model
        removing = self.Session.get(model.Person, merge_request.removing_uuid)
        keeping = self.Session.get(model.Person, merge_request.keeping_uuid)
        return "{} -> {}".format(
            removing or "(not found)",
            keeping or "(not found)")

    def configure_form(self, f):
        super().configure_form(f)

        f.set_renderer('removing_uuid', self.render_referenced_person)
        f.set_renderer('keeping_uuid', self.render_referenced_person)

    def render_referenced_person(self, merge_request, field):
        model = self.model
        uuid = getattr(merge_request, field)
        person = self.Session.get(model.Person, uuid)
        if person:
            text = str(person)
            url = self.request.route_url('people.view', uuid=person.uuid)
            return tags.link_to(text, url)
        return "(person not found)"


def defaults(config, **kwargs):
    base = globals()

    PersonView = kwargs.get('PersonView', base['PersonView'])
    PersonView.defaults(config)

    PersonNoteView = kwargs.get('PersonNoteView', base['PersonNoteView'])
    PersonNoteView.defaults(config)

    MergePeopleRequestView = kwargs.get('MergePeopleRequestView', base['MergePeopleRequestView'])
    MergePeopleRequestView.defaults(config)


def includeme(config):
    defaults(config)