import os from django.conf import settings from django.contrib.auth import get_user_model from django.contrib.postgres.fields import JSONField from django.core.exceptions import PermissionDenied from django.core.files.storage import DefaultStorage from django.core.serializers.json import DjangoJSONEncoder from django.db import models from django.db.models import ObjectDoesNotExist from django.db.models.expressions import RawSQL, OrderBy from django.dispatch import receiver from django.urls import reverse from django.utils.text import mark_safe, slugify from django_fsm import can_proceed, FSMField, transition, RETURN_VALUE from django_fsm.signals import post_transition from wagtail.core.fields import StreamField from wagtail.contrib.forms.models import AbstractFormSubmission from opentech.apply.activity.messaging import messenger, MESSAGES from opentech.apply.stream_forms.blocks import FormFieldBlock, UploadableMediaBlock from opentech.apply.stream_forms.models import BaseStreamForm from opentech.apply.utils.blocks import MustIncludeFieldBlock from .utils import LIMIT_TO_STAFF, LIMIT_TO_STAFF_AND_REVIEWERS, WorkflowHelpers from ..blocks import ApplicationCustomFormFieldsBlock, REQUIRED_BLOCK_NAMES from ..workflow import ( active_statuses, DETERMINATION_PHASES, DETERMINATION_RESPONSE_PHASES, get_review_statuses, INITIAL_STATE, review_statuses, UserPermissions, WORKFLOWS, ) storage_settings = getattr(settings, 'APPLY_STORAGE_CONFIG', {}) submission_storage = DefaultStorage(**storage_settings) class JSONOrderable(models.QuerySet): json_field = '' def order_by(self, *field_names): if not self.json_field: raise ValueError( 'json_field cannot be blank, please provide a field on which to perform the ordering' ) def build_json_order_by(field): try: if field.replace('-', '') not in REQUIRED_BLOCK_NAMES: return field except AttributeError: return field if field[0] == '-': descending = True field = field[1:] else: descending = False return OrderBy(RawSQL(f'LOWER({self.json_field}->>%s)', (field,)), descending=descending) field_ordering = [build_json_order_by(field) for field in field_names] return super().order_by(*field_ordering) class ApplicationSubmissionQueryset(JSONOrderable): json_field = 'form_data' def active(self): return self.filter(status__in=active_statuses) def inactive(self): return self.exclude(status__in=active_statuses) def in_review(self): return self.filter(status__in=review_statuses) def in_review_for(self, user, assigned=True): user_review_statuses = get_review_statuses(user) qs = self.filter(status__in=user_review_statuses).exclude(reviews__author=user) if assigned: qs = qs.filter(reviewers=user) return qs def awaiting_determination_for(self, user): return self.filter(status__in=DETERMINATION_RESPONSE_PHASES).filter(lead=user) def current(self): # Applications which have the current stage active (have not been progressed) return self.exclude(next__isnull=False) def make_permission_check(users): def can_transition(instance, user): if UserPermissions.STAFF in users and user.is_apply_staff: return True if UserPermissions.ADMIN in users and user.is_superuser: return True if UserPermissions.LEAD in users and instance.lead == user: return True if UserPermissions.APPLICANT in users and instance.user == user: return True return False return can_transition def wrap_method(func): def wrapped(*args, **kwargs): # Provides a new function that can be wrapped with the django_fsm method # Without this using the same method for multiple transitions fails as # the fsm wrapping is overwritten return func(*args, **kwargs) return wrapped def transition_id(target, phase): transition_prefix = 'transition' return '__'.join([transition_prefix, phase.stage.name.lower(), phase.name, target]) class AddTransitions(models.base.ModelBase): def __new__(cls, name, bases, attrs, **kwargs): for workflow in WORKFLOWS.values(): for phase, data in workflow.items(): for transition_name, action in data.transitions.items(): method_name = transition_id(transition_name, data) permission_name = method_name + '_permission' permission_func = make_permission_check(action['permissions']) # Get the method defined on the parent or default to a NOOP transition_state = wrap_method(attrs.get(action.get('method'), lambda *args, **kwargs: None)) # Provide a neat name for graph viz display transition_state.__name__ = slugify(action['display']) conditions = [attrs[condition] for condition in action.get('conditions', [])] # Wrap with transition decorator transition_func = transition( attrs['status'], source=phase, target=transition_name, permission=permission_func, conditions=conditions, )(transition_state) # Attach to new class attrs[method_name] = transition_func attrs[permission_name] = permission_func def get_transition(self, transition): try: return getattr(self, transition_id(transition, self.phase)) except TypeError: # Defined on the class return None except AttributeError: # For the other workflow return None attrs['get_transition'] = get_transition def get_actions_for_user(self, user): transitions = self.get_available_user_status_transitions(user) actions = [ (transition.target, self.phase.transitions[transition.target]['display']) for transition in transitions if self.get_transition(transition.target) ] yield from actions attrs['get_actions_for_user'] = get_actions_for_user def perform_transition(self, action, user, request=None): transition = self.get_transition(action) if not transition: raise PermissionDenied(f'Invalid "{ action }" transition') if not can_proceed(transition): action = self.phase.transitions[action] raise PermissionDenied(f'You do not have permission to "{ action }"') transition(by=user, request=request) self.save() attrs['perform_transition'] = perform_transition return super().__new__(cls, name, bases, attrs, **kwargs) class ApplicationSubmission( WorkflowHelpers, BaseStreamForm, AbstractFormSubmission, metaclass=ApplicationSubmissionMetaclass, ): field_template = 'funds/includes/submission_field.html' form_data = JSONField(encoder=DjangoJSONEncoder) form_fields = StreamField(ApplicationCustomFormFieldsBlock()) page = models.ForeignKey('wagtailcore.Page', on_delete=models.PROTECT) round = models.ForeignKey('wagtailcore.Page', on_delete=models.PROTECT, related_name='submissions', null=True) lead = models.ForeignKey( settings.AUTH_USER_MODEL, limit_choices_to=LIMIT_TO_STAFF, related_name='submission_lead', on_delete=models.PROTECT, ) next = models.OneToOneField('self', on_delete=models.CASCADE, related_name='previous', null=True) reviewers = models.ManyToManyField( settings.AUTH_USER_MODEL, related_name='submissions_reviewer', limit_choices_to=LIMIT_TO_STAFF_AND_REVIEWERS, blank=True, ) user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True) search_data = models.TextField() # Workflow inherited from WorkflowHelpers status = FSMField(default=INITIAL_STATE, protected=True) is_draft = False live_revision = models.OneToOneField( 'ApplicationRevision', on_delete=models.CASCADE, related_name='live', null=True, editable=False, ) draft_revision = models.OneToOneField( 'ApplicationRevision', on_delete=models.CASCADE, related_name='draft', null=True, editable=False, ) # Meta: used for migration purposes only drupal_id = models.IntegerField(null=True, blank=True, editable=False) objects = ApplicationSubmissionQueryset.as_manager() def not_progressed(self): return not self.next @transition( status, source='*', target=RETURN_VALUE(INITIAL_STATE, 'draft_proposal', 'invited_to_proposal'), permission=make_permission_check({UserPermissions.ADMIN}), ) def restart_stage(self, **kwargs): """ If running form the console please include your user using the kwarg "by" u = User.objects.get(email="<my@email.com>") for a in ApplicationSubmission.objects.all(): a.restart_stage(by=u) a.save() """ if hasattr(self, 'previous'): return 'draft_proposal' elif self.next: return 'invited_to_proposal' return INITIAL_STATE @property def stage(self): return self.phase.stage @property def phase(self): return self.workflow.get(self.status) @property def active(self): return self.status in active_statuses @property def last_edit(self): # Best estimate of last edit # TODO update when we have revisioning included return self.activities.first() def ensure_user_has_account(self): if self.user and self.user.is_authenticated: self.form_data['email'] = self.user.email self.form_data['full_name'] = self.user.get_full_name() else: # Rely on the form having the following must include fields (see blocks.py) email = self.form_data.get('email') full_name = self.form_data.get('full_name') User = get_user_model() if 'skip_account_creation_notification' in self.form_data: self.form_data.pop('skip_account_creation_notification', None) self.user, _ = User.objects.get_or_create( email=email, defaults={'full_name': full_name} ) else: self.user, _ = User.objects.get_or_create_and_notify( email=email, site=self.page.get_site(), defaults={'full_name': full_name} ) def save_path(self, file_name): file_path = os.path.join('submissions', 'user', str(self.user.id), file_name) return submission_storage.generate_filename(file_path) def handle_file(self, file): # File is potentially optional if file: try: filename = self.save_path(file.name) except AttributeError: # file is not changed, it is still the dictionary return file saved_name = submission_storage.save(filename, file) return { 'name': file.name, 'path': saved_name, 'url': submission_storage.url(saved_name), } def handle_files(self, files): if isinstance(files, list): return [self.handle_file(file) for file in files] return self.handle_file(files) def get_from_parent(self, attribute): try: return getattr(self.round.specific, attribute) except AttributeError: # We are a lab submission return getattr(self.page.specific, attribute) def progress_application(self, **kwargs): submission_in_db = ApplicationSubmission.objects.get(id=self.id) self.id = None self.form_fields = self.get_from_parent('get_defined_fields')(self.stage) self.live_revision = None self.draft_revision = None self.save() submission_in_db.next = self submission_in_db.save() def new_data(self, data): self.is_draft = False self.form_data = data return self def from_draft(self): self.is_draft = True self.form_data = self.draft_revision.form_data return self def create_revision(self, draft=False, force=False, by=None, **kwargs): self.clean_submission() current_data = ApplicationSubmission.objects.get(id=self.id).form_data if current_data != self.form_data or force: if self.live_revision == self.draft_revision: revision = ApplicationRevision.objects.create(submission=self, form_data=self.form_data, author=by) else: revision = self.draft_revision revision.form_data = self.form_data revision.author = by revision.save() if draft: self.form_data = self.live_revision.form_data else: self.live_revision = revision self.draft_revision = revision self.save() def clean_submission(self): self.process_form_data() self.ensure_user_has_account() self.process_file_data() def process_form_data(self): for field_name, field_id in self.must_include.items(): response = self.form_data.pop(field_id, None) if response: self.form_data[field_name] = response def process_file_data(self): for field in self.form_fields: if isinstance(field.block, UploadableMediaBlock): file = self.form_data.get(field.id, {}) self.form_data[field.id] = self.handle_files(file) def save(self, *args, **kwargs): if self.is_draft: raise ValueError('Cannot save with draft data') self.clean_submission() creating = not self.id if creating: # We are creating the object default to first stage self.workflow_name = self.get_from_parent('workflow_name') # Copy extra relevant information to the child self.lead = self.get_from_parent('lead') # add a denormed version of the answer for searching self.search_data = ' '.join(self.prepare_search_values()) super().save(*args, **kwargs) if creating: self.reviewers.set(self.get_from_parent('reviewers').all()) first_revision = ApplicationRevision.objects.create(submission=self, form_data=self.form_data) self.live_revision = first_revision self.draft_revision = first_revision self.save() @property def missing_reviewers(self): return self.reviewers.exclude(id__in=self.reviews.submitted().values('author')) @property def staff_not_reviewed(self): return self.missing_reviewers.staff() @property def reviewers_not_reviewed(self): return self.missing_reviewers.reviewers().exclude(id__in=self.staff_not_reviewed) def reviewed_by(self, user): return self.reviews.submitted().filter(author=user).exists() def has_permission_to_review(self, user): if user.is_apply_staff: return True if user in self.reviewers_not_reviewed: return True return False def can_review(self, user): if self.reviewed_by(user): return False return self.has_permission_to_review(user) def has_permission_to_add_determination(self, user): return user.is_superuser or self.lead == user @property def in_determination_phase(self): return self.status in DETERMINATION_PHASES @property def has_determination(self): try: return self.determination.submitted except ObjectDoesNotExist: return False @property def can_have_determination(self): return self.in_determination_phase and not self.has_determination def prepare_search_values(self): for field_id in self.question_field_ids: field = self.field(field_id) data = self.data(field_id) value = field.block.get_searchable_content(field.value, data) if value: if isinstance(value, list): yield ', '.join(value) else: yield value # Add named fields into the search index for field in ['email', 'title']: yield getattr(self, field) def get_absolute_url(self): return reverse('funds:submissions:detail', args=(self.id,)) def __getattribute__(self, item): # __getattribute__ allows correct error handling from django compared to __getattr__ # fall back to values defined on the data if item in REQUIRED_BLOCK_NAMES: return self.form_data[item] return super().__getattribute__(item) def __str__(self): return f'{self.title} from {self.full_name} for {self.page.title}' def __repr__(self): return f'<{self.__class__.__name__}: {self.user}, {self.round}, {self.page}>' # Methods for accessing data on the submission def get_data(self): # Updated for JSONField form_data = self.form_data.copy() form_data.update({ 'submit_time': self.submit_time, }) return form_data @property def raw_data(self): # Returns the data mapped by field id instead of the data stored using the must include # values data = self.form_data.copy() for field_name, field_id in self.must_include.items(): response = data.pop(field_name) data[field_id] = response return data def field(self, id): try: return self.fields[id] except KeyError as e: try: actual_id = self.must_include[id] except KeyError: raise e else: return self.fields[actual_id] def data(self, id): try: return self.form_data[id] except KeyError as e: try: transposed_must_include = {v:k for k,v in self.must_include.items()} actual_id = transposed_must_include[id] except KeyError: # We have most likely progressed application forms so the data isnt in form_data return None else: return self.form_data[actual_id] @property def question_field_ids(self): for field_id, field in self.fields.items(): if isinstance(field.block, FormFieldBlock): yield field_id @property def raw_fields(self): # Field ids to field class mapping - similar to raw_data return { field.id: field for field in self.form_fields } @property def fields(self): # ALl fields on the application fields = self.raw_fields.copy() for field_name, field_id in self.must_include.items(): response = fields.pop(field_id) fields[field_name] = response return fields @property def must_include(self): return { field.block.name: field.id for field in self.form_fields if isinstance(field.block, MustIncludeFieldBlock) } def render_answer(self, field_id): field = self.field(field_id) data = self.data(field_id) return field.render(context={'data': data}) def render_answers(self): answers = [ self.render_answer(field_id) for field_id in self.question_field_ids if field_id not in self.must_include ] return mark_safe(''.join(answers)) @receiver(post_transition, sender=ApplicationSubmission) def log_status_update(sender, **kwargs): instance = kwargs['instance'] old_phase = instance.workflow[kwargs['source']] by = kwargs['method_kwargs']['by'] request = kwargs['method_kwargs']['request'] if request: messenger( MESSAGES.TRANSITION, user=by, request=request, submission=instance, old_phase=old_phase, ) if instance.status in review_statuses: messenger( MESSAGES.READY_FOR_REVIEW, user=by, request=request, submission=instance, ) class ApplicationRevision(models.Model): submission = models.ForeignKey(ApplicationSubmission, related_name='revisions', on_delete=models.CASCADE) form_data = JSONField(encoder=DjangoJSONEncoder) timestamp = models.DateTimeField(auto_now=True) author = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True) class Meta: ordering = ['-timestamp']