-
Notifications
You must be signed in to change notification settings - Fork 38
/
workflow.py
1156 lines (1041 loc) · 40.4 KB
/
workflow.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import itertools
from collections import defaultdict
from enum import Enum
from django.conf import settings
from django.utils.text import slugify
from django.utils.translation import gettext as _
"""
This file defines classes which allow you to compose workflows based on the following structure:
Workflow -> Stage -> Phase -> Action
Current limitations:
* Changing the name of a phase will mean that any object which references it cannot progress. [will
be fixed when streamfield, may require intermediate fix prior to launch]
* Do not reorder without looking at workflow automations steps in form_valid() in
hypha/apply/funds/views.py and hypha/apply/review/views.py.
"""
class UserPermissions(Enum):
STAFF = 1
ADMIN = 2
LEAD = 3
APPLICANT = 4
class Workflow(dict):
def __init__(self, name, admin_name, **data):
self.name = name
self.admin_name = admin_name
super().__init__(**data)
def __str__(self):
return self.name
@property
def stages(self):
stages = []
for phase in self.values():
if phase.stage not in stages:
stages.append(phase.stage)
return stages
@property
def stepped_phases(self):
phases = defaultdict(list)
for phase in list(self.values()):
phases[phase.step].append(phase)
return phases
def phases_for(self, user=None):
# Grab the first phase for each step - visible only, the display phase
return [
phase for phase, *_ in self.stepped_phases.values()
if not user or phase.permissions.can_view(user)
]
def previous_visible(self, current, user):
"""Find the latest phase that the user has view permissions for"""
display_phase = self.stepped_phases[current.step][0]
phases = self.phases_for()
index = phases.index(display_phase)
for phase in phases[index - 1::-1]:
if phase.permissions.can_view(user):
return phase
class Phase:
"""
Phase Names:
display_name = phase name displayed to staff members in the system
public_name = phase name displayed to applicants in the system
future_name = phase_name displayed to applicants if they haven't passed this stage
"""
def __init__(self, name, display, stage, permissions, step, public=None, future=None, transitions=dict()):
self.name = name
self.display_name = display
if public and future:
raise ValueError("Cant provide both a future and a public name")
self.public_name = public or self.display_name
self.future_name_staff = future or self.display_name
self.future_name_public = future or self.public_name
self.stage = stage
self.permissions = Permissions(permissions)
self.step = step
# For building transition methods on the parent
self.transitions = {}
default_permissions = {UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN}
for transition_target, action in transitions.items():
transition = dict()
try:
transition['display'] = action.get('display')
except AttributeError:
transition['display'] = action
transition['permissions'] = default_permissions
else:
transition['method'] = action.get('method')
conditions = action.get('conditions', '')
transition['conditions'] = conditions.split(',') if conditions else []
transition['permissions'] = action.get('permissions', default_permissions)
self.transitions[transition_target] = transition
def __str__(self):
return self.display_name
def __repr__(self):
return f'<Phase: {self.display_name} ({self.public_name})>'
class Stage:
def __init__(self, name, has_external_review=False):
self.name = name
self.has_external_review = has_external_review
def __str__(self):
return self.name
def __repr__(self):
return f'<Stage: {self.name}>'
class Permissions:
def __init__(self, permissions):
self.permissions = permissions
def can_do(self, user, action):
checks = self.permissions.get(action, list())
return any(check(user) for check in checks)
def can_edit(self, user):
return self.can_do(user, 'edit')
def can_review(self, user):
return self.can_do(user, 'review')
def can_view(self, user):
return self.can_do(user, 'view')
staff_can = lambda user: user.is_apply_staff # NOQA
applicant_can = lambda user: user.is_applicant # NOQA
reviewer_can = lambda user: user.is_reviewer # NOQA
partner_can = lambda user: user.is_partner # NOQA
community_can = lambda user: user.is_community_reviewer # NOQA
def make_permissions(edit=list(), review=list(), view=[staff_can, applicant_can, reviewer_can, partner_can, ]):
return {
'edit': edit,
'review': review,
'view': view,
}
no_permissions = make_permissions()
default_permissions = make_permissions(edit=[staff_can], review=[staff_can])
hidden_from_applicant_permissions = make_permissions(edit=[staff_can], review=[staff_can], view=[staff_can, reviewer_can])
reviewer_review_permissions = make_permissions(edit=[staff_can], review=[staff_can, reviewer_can])
community_review_permissions = make_permissions(edit=[staff_can], review=[staff_can, reviewer_can, community_can])
applicant_edit_permissions = make_permissions(edit=[applicant_can, partner_can], review=[staff_can])
staff_edit_permissions = make_permissions(edit=[staff_can])
Request = Stage('Request', False)
RequestExt = Stage('RequestExt', True)
RequestCom = Stage('RequestCom', True)
Concept = Stage('Concept', False)
Proposal = Stage('Proposal', True)
DRAFT_STATE = 'draft'
INITIAL_STATE = 'in_discussion'
SingleStageDefinition = [
{
DRAFT_STATE: {
'transitions': {
INITIAL_STATE: {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT},
'method': 'create_revision',
},
},
'display': _('Draft'),
'stage': Request,
'permissions': applicant_edit_permissions,
}
},
{
INITIAL_STATE: {
'transitions': {
'more_info': _('Request More Information'),
'internal_review': _('Open Review'),
'determination': _('Ready For Determination'),
'almost': _('Accept but additional info required'),
'accepted': _('Accept'),
'rejected': _('Dismiss'),
},
'display': _('Need screening'),
'public': _('Application Received'),
'stage': Request,
'permissions': default_permissions,
},
'more_info': {
'transitions': {
INITIAL_STATE: {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
'determination': _('Ready For Determination'),
'almost': _('Accept but additional info required'),
'accepted': _('Accept'),
'rejected': _('Dismiss'),
},
'display': _('More information required'),
'stage': Request,
'permissions': applicant_edit_permissions,
},
},
{
'internal_review': {
'transitions': {
'post_review_discussion': _('Close Review'),
INITIAL_STATE: _('Need screening (revert)'),
},
'display': _('Internal Review'),
'public': _('{org_short_name} Review').format(org_short_name=settings.ORG_SHORT_NAME),
'stage': Request,
'permissions': default_permissions,
},
},
{
'post_review_discussion': {
'transitions': {
'post_review_more_info': _('Request More Information'),
'determination': _('Ready For Determination'),
'internal_review': _('Open Review (revert)'),
'almost': _('Accept but additional info required'),
'accepted': _('Accept'),
'rejected': _('Dismiss'),
},
'display': _('Ready For Discussion'),
'stage': Request,
'permissions': hidden_from_applicant_permissions,
},
'post_review_more_info': {
'transitions': {
'post_review_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
'determination': _('Ready For Determination'),
'almost': _('Accept but additional info required'),
'accepted': _('Accept'),
'rejected': _('Dismiss'),
},
'display': _('More information required'),
'stage': Request,
'permissions': applicant_edit_permissions,
},
},
{
'determination': {
'transitions': {
'post_review_discussion': _('Ready For Discussion (revert)'),
'almost': _('Accept but additional info required'),
'accepted': _('Accept'),
'rejected': _('Dismiss'),
},
'display': _('Ready for Determination'),
'permissions': hidden_from_applicant_permissions,
'stage': Request,
},
},
{
'accepted': {
'display': _('Accepted'),
'future': _('Application Outcome'),
'stage': Request,
'permissions': staff_edit_permissions,
},
'almost': {
'transitions': {
'accepted': _('Accept'),
'post_review_discussion': _('Ready For Discussion (revert)'),
},
'display': _('Accepted but additional info required'),
'stage': Request,
'permissions': applicant_edit_permissions,
},
'rejected': {
'display': _('Dismissed'),
'stage': Request,
'permissions': no_permissions,
},
},
]
SingleStageExternalDefinition = [
{
DRAFT_STATE: {
'transitions': {
INITIAL_STATE: {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT},
'method': 'create_revision',
},
},
'display': _('Draft'),
'stage': RequestExt,
'permissions': applicant_edit_permissions,
}
},
{
INITIAL_STATE: {
'transitions': {
'ext_more_info': _('Request More Information'),
'ext_internal_review': _('Open Review'),
'ext_determination': _('Ready For Determination'),
'ext_rejected': _('Dismiss'),
},
'display': _('Need screening'),
'public': _('Application Received'),
'stage': RequestExt,
'permissions': default_permissions,
},
'ext_more_info': {
'transitions': {
INITIAL_STATE: {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
},
'display': _('More information required'),
'stage': RequestExt,
'permissions': applicant_edit_permissions,
},
},
{
'ext_internal_review': {
'transitions': {
'ext_post_review_discussion': _('Close Review'),
INITIAL_STATE: _('Need screening (revert)'),
},
'display': _('Internal Review'),
'public': _('{org_short_name} Review').format(org_short_name=settings.ORG_SHORT_NAME),
'stage': RequestExt,
'permissions': default_permissions,
},
},
{
'ext_post_review_discussion': {
'transitions': {
'ext_post_review_more_info': _('Request More Information'),
'ext_external_review': _('Open External Review'),
'ext_determination': _('Ready For Determination'),
'ext_internal_review': _('Open Internal Review (revert)'),
'ext_rejected': _('Dismiss'),
},
'display': _('Ready For Discussion'),
'stage': RequestExt,
'permissions': hidden_from_applicant_permissions,
},
'ext_post_review_more_info': {
'transitions': {
'ext_post_review_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
},
'display': _('More information required'),
'stage': RequestExt,
'permissions': applicant_edit_permissions,
},
},
{
'ext_external_review': {
'transitions': {
'ext_post_external_review_discussion': _('Close Review'),
'ext_post_review_discussion': _('Ready For Discussion (revert)'),
},
'display': _('External Review'),
'stage': RequestExt,
'permissions': reviewer_review_permissions,
},
},
{
'ext_post_external_review_discussion': {
'transitions': {
'ext_post_external_review_more_info': _('Request More Information'),
'ext_determination': _('Ready For Determination'),
'ext_external_review': _('Open External Review (revert)'),
'ext_almost': _('Accept but additional info required'),
'ext_accepted': _('Accept'),
'ext_rejected': _('Dismiss'),
},
'display': _('Ready For Discussion'),
'stage': RequestExt,
'permissions': hidden_from_applicant_permissions,
},
'ext_post_external_review_more_info': {
'transitions': {
'ext_post_external_review_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
},
'display': _('More information required'),
'stage': RequestExt,
'permissions': applicant_edit_permissions,
},
},
{
'ext_determination': {
'transitions': {
'ext_post_external_review_discussion': _('Ready For Discussion (revert)'),
'ext_almost': _('Accept but additional info required'),
'ext_accepted': _('Accept'),
'ext_rejected': _('Dismiss'),
},
'display': _('Ready for Determination'),
'permissions': hidden_from_applicant_permissions,
'stage': RequestExt,
},
},
{
'ext_accepted': {
'display': _('Accepted'),
'future': _('Application Outcome'),
'stage': RequestExt,
'permissions': staff_edit_permissions,
},
'ext_almost': {
'transitions': {
'ext_accepted': _('Accept'),
'ext_post_external_review_discussion': _('Ready For Discussion (revert)'),
},
'display': _('Accepted but additional info required'),
'stage': RequestExt,
'permissions': applicant_edit_permissions,
},
'ext_rejected': {
'display': _('Dismissed'),
'stage': RequestExt,
'permissions': no_permissions,
},
},
]
SingleStageCommunityDefinition = [
{
DRAFT_STATE: {
'transitions': {
INITIAL_STATE: {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT},
'method': 'create_revision',
},
},
'display': _('Draft'),
'stage': RequestCom,
'permissions': applicant_edit_permissions,
}
},
{
INITIAL_STATE: {
'transitions': {
'com_more_info': _('Request More Information'),
'com_open_call': 'Open Call (public)',
'com_internal_review': _('Open Review'),
'com_community_review': _('Open Community Review'),
'com_determination': _('Ready For Determination'),
'com_rejected': _('Dismiss'),
},
'display': _('Need screening'),
'public': _('Application Received'),
'stage': RequestCom,
'permissions': default_permissions,
},
'com_more_info': {
'transitions': {
INITIAL_STATE: {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
},
'display': _('More information required'),
'stage': RequestCom,
'permissions': applicant_edit_permissions,
},
'com_open_call': {
'transitions': {
INITIAL_STATE: _('Need screening (revert)'),
'com_rejected': _('Dismiss'),
},
'display': 'Open Call (public)',
'stage': RequestCom,
'permissions': staff_edit_permissions,
},
},
{
'com_internal_review': {
'transitions': {
'com_community_review': _('Open Community Review'),
'com_post_review_discussion': _('Close Review'),
INITIAL_STATE: _('Need screening (revert)'),
'com_rejected': _('Dismiss'),
},
'display': _('Internal Review'),
'public': _('{org_short_name} Review').format(org_short_name=settings.ORG_SHORT_NAME),
'stage': RequestCom,
'permissions': default_permissions,
},
'com_community_review': {
'transitions': {
'com_post_review_discussion': _('Close Review'),
'com_internal_review': _('Open Internal Review (revert)'),
'com_rejected': _('Dismiss'),
},
'display': _('Community Review'),
'public': _('{org_short_name} Review').format(org_short_name=settings.ORG_SHORT_NAME),
'stage': RequestCom,
'permissions': community_review_permissions,
},
},
{
'com_post_review_discussion': {
'transitions': {
'com_post_review_more_info': _('Request More Information'),
'com_external_review': _('Open External Review'),
'com_determination': _('Ready For Determination'),
'com_internal_review': _('Open Internal Review (revert)'),
'com_rejected': _('Dismiss'),
},
'display': _('Ready For Discussion'),
'stage': RequestCom,
'permissions': hidden_from_applicant_permissions,
},
'com_post_review_more_info': {
'transitions': {
'com_post_review_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
},
'display': _('More information required'),
'stage': RequestCom,
'permissions': applicant_edit_permissions,
},
},
{
'com_external_review': {
'transitions': {
'com_post_external_review_discussion': _('Close Review'),
'com_post_review_discussion': _('Ready For Discussion (revert)'),
},
'display': _('External Review'),
'stage': RequestCom,
'permissions': reviewer_review_permissions,
},
},
{
'com_post_external_review_discussion': {
'transitions': {
'com_post_external_review_more_info': _('Request More Information'),
'com_determination': _('Ready For Determination'),
'com_external_review': _('Open External Review (revert)'),
'com_almost': _('Accept but additional info required'),
'com_accepted': _('Accept'),
'com_rejected': _('Dismiss'),
},
'display': _('Ready For Discussion'),
'stage': RequestCom,
'permissions': hidden_from_applicant_permissions,
},
'com_post_external_review_more_info': {
'transitions': {
'com_post_external_review_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
},
'display': _('More information required'),
'stage': RequestCom,
'permissions': applicant_edit_permissions,
},
},
{
'com_determination': {
'transitions': {
'com_post_external_review_discussion': _('Ready For Discussion (revert)'),
'com_almost': _('Accept but additional info required'),
'com_accepted': _('Accept'),
'com_rejected': _('Dismiss'),
},
'display': _('Ready for Determination'),
'permissions': hidden_from_applicant_permissions,
'stage': RequestCom,
},
},
{
'com_accepted': {
'display': _('Accepted'),
'future': _('Application Outcome'),
'stage': RequestCom,
'permissions': staff_edit_permissions,
},
'com_almost': {
'transitions': {
'com_accepted': _('Accept'),
'com_post_external_review_discussion': _('Ready For Discussion (revert)'),
},
'display': _('Accepted but additional info required'),
'stage': RequestCom,
'permissions': applicant_edit_permissions,
},
'com_rejected': {
'display': _('Dismissed'),
'stage': RequestCom,
'permissions': no_permissions,
},
},
]
DoubleStageDefinition = [
{
DRAFT_STATE: {
'transitions': {
INITIAL_STATE: {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT},
'method': 'create_revision',
},
},
'display': _('Draft'),
'stage': Concept,
'permissions': applicant_edit_permissions,
}
},
{
INITIAL_STATE: {
'transitions': {
'concept_more_info': _('Request More Information'),
'concept_internal_review': _('Open Review'),
'concept_determination': _('Ready For Preliminary Determination'),
'invited_to_proposal': _('Invite to Proposal'),
'concept_rejected': _('Dismiss'),
},
'display': _('Need screening'),
'public': _('Concept Note Received'),
'stage': Concept,
'permissions': default_permissions,
},
'concept_more_info': {
'transitions': {
INITIAL_STATE: {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
'concept_rejected': _('Dismiss'),
'invited_to_proposal': _('Invite to Proposal'),
'concept_determination': _('Ready For Preliminary Determination'),
},
'display': _('More information required'),
'stage': Concept,
'permissions': applicant_edit_permissions,
},
},
{
'concept_internal_review': {
'transitions': {
'concept_review_discussion': _('Close Review'),
INITIAL_STATE: _('Need screening (revert)'),
'invited_to_proposal': _('Invite to Proposal'),
},
'display': _('Internal Review'),
'public': _('{org_short_name} Review').format(org_short_name=settings.ORG_SHORT_NAME),
'stage': Concept,
'permissions': default_permissions,
},
},
{
'concept_review_discussion': {
'transitions': {
'concept_review_more_info': _('Request More Information'),
'concept_determination': _('Ready For Preliminary Determination'),
'concept_internal_review': _('Open Review (revert)'),
'invited_to_proposal': _('Invite to Proposal'),
'concept_rejected': _('Dismiss'),
},
'display': _('Ready For Discussion'),
'stage': Concept,
'permissions': hidden_from_applicant_permissions,
},
'concept_review_more_info': {
'transitions': {
'concept_review_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
'invited_to_proposal': _('Invite to Proposal'),
},
'display': _('More information required'),
'stage': Concept,
'permissions': applicant_edit_permissions,
},
},
{
'concept_determination': {
'transitions': {
'concept_review_discussion': _('Ready For Discussion (revert)'),
'invited_to_proposal': _('Invite to Proposal'),
'concept_rejected': _('Dismiss'),
},
'display': _('Ready for Preliminary Determination'),
'permissions': hidden_from_applicant_permissions,
'stage': Concept,
},
},
{
'invited_to_proposal': {
'display': _('Concept Accepted'),
'future': _('Preliminary Determination'),
'transitions': {
'draft_proposal': {
'display': _('Progress'),
'method': 'progress_application',
'permissions': {UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'conditions': 'not_progressed',
},
},
'stage': Concept,
'permissions': no_permissions,
},
'concept_rejected': {
'display': _('Dismissed'),
'stage': Concept,
'permissions': no_permissions,
},
},
{
'draft_proposal': {
'transitions': {
'proposal_discussion': {'display': _('Submit'), 'permissions': {UserPermissions.APPLICANT}, 'method': 'create_revision'},
'external_review': _('Open External Review'),
'proposal_determination': _('Ready For Final Determination'),
'proposal_rejected': _('Dismiss'),
},
'display': _('Invited for Proposal'),
'stage': Proposal,
'permissions': applicant_edit_permissions,
},
},
{
'proposal_discussion': {
'transitions': {
'proposal_more_info': _('Request More Information'),
'proposal_internal_review': _('Open Review'),
'external_review': _('Open External Review'),
'proposal_determination': _('Ready For Final Determination'),
'proposal_rejected': _('Dismiss'),
},
'display': _('Proposal Received'),
'stage': Proposal,
'permissions': default_permissions,
},
'proposal_more_info': {
'transitions': {
'proposal_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
'external_review': _('Open External Review'),
'proposal_determination': _('Ready For Final Determination'),
'proposal_rejected': _('Dismiss'),
},
'display': _('More information required'),
'stage': Proposal,
'permissions': applicant_edit_permissions,
},
},
{
'proposal_internal_review': {
'transitions': {
'post_proposal_review_discussion': _('Close Review'),
'proposal_discussion': _('Proposal Received (revert)'),
},
'display': _('Internal Review'),
'public': _('{org_short_name} Review').format(org_short_name=settings.ORG_SHORT_NAME),
'stage': Proposal,
'permissions': default_permissions,
},
},
{
'post_proposal_review_discussion': {
'transitions': {
'post_proposal_review_more_info': _('Request More Information'),
'external_review': _('Open External Review'),
'proposal_determination': _('Ready For Final Determination'),
'proposal_internal_review': _('Open Internal Review (revert)'),
'proposal_rejected': _('Dismiss'),
},
'display': _('Ready For Discussion'),
'stage': Proposal,
'permissions': hidden_from_applicant_permissions,
},
'post_proposal_review_more_info': {
'transitions': {
'post_proposal_review_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
'external_review': _('Open External Review'),
},
'display': _('More information required'),
'stage': Proposal,
'permissions': applicant_edit_permissions,
},
},
{
'external_review': {
'transitions': {
'post_external_review_discussion': _('Close Review'),
'post_proposal_review_discussion': _('Ready For Discussion (revert)'),
},
'display': _('External Review'),
'stage': Proposal,
'permissions': reviewer_review_permissions,
},
},
{
'post_external_review_discussion': {
'transitions': {
'post_external_review_more_info': _('Request More Information'),
'proposal_determination': _('Ready For Final Determination'),
'external_review': _('Open External Review (revert)'),
'proposal_almost': _('Accept but additional info required'),
'proposal_accepted': _('Accept'),
'proposal_rejected': _('Dismiss'),
},
'display': _('Ready For Discussion'),
'stage': Proposal,
'permissions': hidden_from_applicant_permissions,
},
'post_external_review_more_info': {
'transitions': {
'post_external_review_discussion': {
'display': _('Submit'),
'permissions': {UserPermissions.APPLICANT, UserPermissions.STAFF, UserPermissions.LEAD, UserPermissions.ADMIN},
'method': 'create_revision',
},
},
'display': _('More information required'),
'stage': Proposal,
'permissions': applicant_edit_permissions,
},
},
{
'proposal_determination': {
'transitions': {
'post_external_review_discussion': _('Ready For Discussion (revert)'),
'proposal_almost': _('Accept but additional info required'),
'proposal_accepted': _('Accept'),
'proposal_rejected': _('Dismiss'),
},
'display': _('Ready for Final Determination'),
'permissions': hidden_from_applicant_permissions,
'stage': Proposal,
},
},
{
'proposal_accepted': {
'display': _('Accepted'),
'future': _('Final Determination'),
'stage': Proposal,
'permissions': staff_edit_permissions,
},
'proposal_almost': {
'transitions': {
'proposal_accepted': _('Accept'),
'post_external_review_discussion': _('Ready For Discussion (revert)'),
},
'display': _('Accepted but additional info required'),
'stage': Proposal,
'permissions': applicant_edit_permissions,
},
'proposal_rejected': {
'display': _('Dismissed'),
'stage': Proposal,
'permissions': no_permissions,
},
},
]
def unpack_phases(phases):
for step, step_data in enumerate(phases):
for name, phase_data in step_data.items():
yield step, name, phase_data
def phase_data(phases):
return {
phase_name: Phase(phase_name, step=step, **phase_data)
for step, phase_name, phase_data in unpack_phases(phases)
}
Request = Workflow('Request', 'single', **phase_data(SingleStageDefinition))
RequestExternal = Workflow('Request with external review', 'single_ext', **phase_data(SingleStageExternalDefinition))
RequestCommunity = Workflow('Request with community review', 'single_com', **phase_data(SingleStageCommunityDefinition))
ConceptProposal = Workflow('Concept & Proposal', 'double', **phase_data(DoubleStageDefinition))
WORKFLOWS = {
Request.admin_name: Request,
RequestExternal.admin_name: RequestExternal,
RequestCommunity.admin_name: RequestCommunity,
ConceptProposal.admin_name: ConceptProposal,
}
# This is not a dictionary as the keys will clash for the first phase of each workflow
# We cannot find the transitions for the first stage in this instance
PHASES = list(itertools.chain.from_iterable(workflow.items() for workflow in WORKFLOWS.values()))
def get_stage_change_actions():
changes = set()
for workflow in WORKFLOWS.values():
stage = None
for phase in workflow.values():
if phase.stage != stage and stage:
changes.add(phase.name)
stage = phase.stage
return changes
STAGE_CHANGE_ACTIONS = get_stage_change_actions()
STATUSES = defaultdict(set)
for key, value in PHASES:
STATUSES[value.display_name].add(key)
active_statuses = [
status for status, _ in PHASES
if 'accepted' not in status and 'rejected' not in status and 'invited' not in status
]
def get_review_active_statuses(user=None):
reviews = set()
for phase_name, phase in PHASES:
if phase_name in active_statuses:
if user is None:
reviews.add(phase_name)
elif phase.permissions.can_review(user):
reviews.add(phase_name)