Add public and private complete views to do comments

Add new manager for position model
Add templatetag to see the total number of nominations by user on a position
Add feedback receipt template 
See ietf-tools#970
 - Legacy-Id: 5554

Author: ejimenez

ietf/dbtemplate/fixtures/nomcom_templates.xml

@@ -125,6 +125,27 @@ The following comments have also been registered:
 $comments
 --------------------------------------------------------------------------
 
+Thank you,</field>
+        <field to="group.group" name="group" rel="ManyToOneRel"><None></None></field>
+    </object>
+    <object p="10" model="dbtemplate.dbtemplate">
+        <field type="CharField" name="path">/nomcom/defaults/email/feedback_receipt.txt</field>
+        <field type="CharField" name="title">Email sent to feedback author to get a confirmation mail containing feedback in cleartext</field>
+        <field type="TextField" name="variables">$nominee: Full name of the nominee
+$position: Nomination position
+$comments: Comments on this candidate</field>
+        <field to="name.dbtemplatetypename" name="type" rel="ManyToOneRel">plain</field>
+        <field type="TextField" name="content">Hi,
+
+Your input regarding $nominee for the position of
+$position has been received and registered.
+
+The following comments have been registered:
+
+--------------------------------------------------------------------------
+$comments
+--------------------------------------------------------------------------
+
 Thank you,</field>
         <field to="group.group" name="group" rel="ManyToOneRel"><None></None></field>
     </object>

ietf/nomcom/forms.py

@@ -21,7 +21,8 @@
                                Position, Feedback
 from ietf.nomcom.utils import QUESTIONNAIRE_TEMPLATE, NOMINATION_EMAIL_TEMPLATE, \
                               INEXISTENT_PERSON_TEMPLATE, NOMINEE_EMAIL_TEMPLATE, \
-                              NOMINATION_RECEIPT_TEMPLATE, get_user_email
+                              NOMINATION_RECEIPT_TEMPLATE, FEEDBACK_RECEIPT_TEMPLATE, \
+                              get_user_email
 from ietf.nomcom.decorators import member_required
 
 ROLODEX_URL = getattr(settings, 'ROLODEX_URL', None)
@@ -288,7 +289,7 @@ class NominateForm(BaseNomcomForm, forms.ModelForm):
                                widget=forms.Textarea())
     confirmation = forms.BooleanField(label='Email comments back to me as confirmation',
                                       help_text="If you want to get a confirmation mail containing your feedback in cleartext, \
-                                                 please check the 'email comments back to me as confirmation' box below.",
+                                                 please check the 'email comments back to me as confirmation'",
                                       required=False)
 
     fieldsets = [('Candidate Nomination', ('position', 'candidate_name',
@@ -300,8 +301,16 @@ def __init__(self, *args, **kwargs):
         self.public = kwargs.pop('public', None)
 
         super(NominateForm, self).__init__(*args, **kwargs)
+
+        fieldset = ['nominator_email',
+                    'position',
+                    'candidate_name',
+                    'candidate_email', 'candidate_phone',
+                    'comments']
+
         if self.nomcom:
-            self.fields['position'].queryset = Position.objects.filter(nomcom=self.nomcom)
+            self.fields['position'].queryset = Position.objects.get_by_nomcom(self.nomcom).opened()
+
         if not self.public:
             author = get_user_email(self.user)
             if author:
@@ -310,11 +319,10 @@ def __init__(self, *args, **kwargs):
                                nomination wishes to be anonymous. The confirmation email will be sent to the address given here,
                                and the address will also be captured as part of the registered nomination.)"""
                 self.fields['nominator_email'].help_text = help_text
-            self.fieldsets = [('Candidate Nomination', ('nominator_email',
-                              'position',
-                              'candidate_name',
-                              'candidate_email', 'candidate_phone',
-                              'comments'))]
+        else:
+            fieldset.append('confirmation')
+
+        self.fieldsets = [('Candidate Nomination', fieldset)]
 
     def save(self, commit=True):
         # Create nomination
@@ -413,6 +421,7 @@ def save(self, commit=True):
         path = nomcom_template_path + NOMINATION_EMAIL_TEMPLATE
         send_mail(None, to_email, from_email, subject, path, context)
 
+        # send receipt email to nominator
         if confirmation or not self.public:
             if author:
                 subject = 'Nomination Receipt'
@@ -437,39 +446,130 @@ class Media:
 
 
 class FeedbackForm(BaseNomcomForm, forms.ModelForm):
-    position = forms.CharField(label='position')
-    nominee_name = forms.CharField(label='nominee name')
-    nominee_email = forms.CharField(label='nominee email')
+    position_name = forms.CharField(label='position',
+                                    widget=forms.TextInput(attrs={'size': '40'}))
+    nominee_name = forms.CharField(label='your name',
+                                   widget=forms.TextInput(attrs={'size': '40'}))
+    nominee_email = forms.CharField(label='your email',
+                                    widget=forms.TextInput(attrs={'size': '40'}))
     nominator_name = forms.CharField(label='nominator name')
     nominator_email = forms.CharField(label='nominator email')
 
-    comments = forms.CharField(label='Comments on this candidate', widget=forms.Textarea())
-
-    fieldsets = [('Provide comments', ('position',
-                                       'nominee_name',
-                                       'nominee_email',
-                                       'nominator_name',
-                                       'nominator_email',
-                                       'comments'))]
+    comments = forms.CharField(label='Comments on this candidate',
+                               widget=forms.Textarea())
+    confirmation = forms.BooleanField(label='Email comments back to me as confirmation',
+                                      help_text="If you want to get a confirmation mail containing your feedback in cleartext, \
+                                                 please check the 'email comments back to me as confirmation'",
+                                      required=False)
 
     def __init__(self, *args, **kwargs):
         self.nomcom = kwargs.pop('nomcom', None)
         self.user = kwargs.pop('user', None)
         self.public = kwargs.pop('public', None)
+        self.position = kwargs.pop('position', None)
+        self.nominee = kwargs.pop('nominee', None)
 
         super(FeedbackForm, self).__init__(*args, **kwargs)
 
+        readonly_fields = ['position_name',
+                           'nominee_name',
+                           'nominee_email']
+
+        fieldset = ['position_name',
+                    'nominee_name',
+                    'nominee_email',
+                    'nominator_name',
+                    'nominator_email',
+                    'comments',
+                    'position',
+                    'type',
+                    'nominee']
+
+        if self.public:
+            readonly_fields += ['nominator_name', 'nominator_email']
+            fieldset.append('confirmation')
+        else:
+            help_text = """(Nomcom Chair/Member: please fill this in. Use your own email address if the person making the
+                            comments wishes to be anonymous. The confirmation email will be sent to the address given here,
+                            and the address will also be captured as part of the registered nomination.)"""
+            self.fields['nominator_email'].help_text = help_text
+
+        hidden_fields = ['position', 'type', 'nominee']
+
+        author = get_user_email(self.user)
+        if author:
+            self.fields['nominator_email'].initial = author.address
+            self.fields['nominator_name'].initial = author.person.name
+
+        if self.position and self.nominee:
+            self.fields['type'].initial = "comment"
+            self.fields['position'].initial = self.position
+            self.fields['position_name'].initial = self.position.name
+            self.fields['nominee'].initial = self.nominee
+            self.fields['nominee_name'].initial = self.nominee.email.person.name
+            self.fields['nominee_email'].initial = self.nominee.email.address
+        else:
+            help_text = "Please pick a name on the nominees list"
+            self.fields['position_name'].initial = help_text
+            self.fields['nominee_name'].initial = help_text
+            self.fields['nominee_email'].initial = help_text
+            self.fields['comments'].initial = help_text
+            readonly_fields += ['comments']
+            self.fields['confirmation'].widget.attrs['disabled'] = "disabled"
+
+        for field in readonly_fields:
+            self.fields[field].widget.attrs['readonly'] = True
+
+        for field in hidden_fields:
+            self.fields[field].widget = forms.HiddenInput()
+
+        self.fieldsets = [('Provide comments', fieldset)]
+
     def save(self, commit=True):
-        pass
+        feedback = super(FeedbackForm, self).save(commit=False)
+        confirmation = self.cleaned_data['confirmation']
+        nominee = self.cleaned_data['nominee']
+        position = self.cleaned_data['position']
+        comments = self.cleaned_data['comments']
+        nominator_email = self.cleaned_data['nominator_email']
+        nomcom_template_path = '/nomcom/%s/' % self.nomcom.group.acronym
+
+        author = None
+        if self.public:
+            author = get_user_email(self.user)
+        else:
+            if nominator_email:
+                emails = Email.objects.filter(address=nominator_email)
+                author = emails and emails[0] or None
+
+        if author:
+            feedback.author = author
+            feedback.save()
+
+        # send receipt email to feedback author
+        if confirmation or not self.public:
+            if author:
+                subject = "NomCom comment confirmation"
+                from_email = settings.NOMCOM_FROM_EMAIL
+                to_email = author.address
+                context = {'nominee': nominee.email.person.name,
+                           'comments': comments,
+                           'position': position.name}
+                path = nomcom_template_path + FEEDBACK_RECEIPT_TEMPLATE
+                send_mail(None, to_email, from_email, subject, path, context)
 
     class Meta:
         model = Feedback
-        fields = ('position',
+        fields = ('author',
+                  'position',
+                  'nominee',
                   'nominee_name',
                   'nominee_email',
                   'nominator_name',
                   'nominator_email',
-                  'comments')
+                  'confirmation',
+                  'comments',
+                  'type')
 
     class Media:
         js = ("/js/jquery-1.5.1.min.js",

ietf/nomcom/managers.py

@@ -37,3 +37,28 @@ def __getattr__(self, attr, *args):
 class NomineeManager(models.Manager):
     def get_by_nomcom(self, nomcom):
         return self.filter(nominee_position__nomcom=nomcom)
+
+
+class PositionQuerySet(QuerySet):
+
+    def get_by_nomcom(self, nomcom):
+        return self.filter(nomcom=nomcom)
+
+    def opened(self):
+        """ only opened positions """
+        return self.filter(is_open=True)
+
+    def closed(self):
+        """ only closed positions """
+        return self.filter(is_open=False)
+
+
+class PositionManager(models.Manager):
+    def get_query_set(self):
+        return PositionQuerySet(self.model)
+
+    def __getattr__(self, attr, *args):
+        try:
+            return getattr(self.__class__, attr, *args)
+        except AttributeError:
+            return getattr(self.get_query_set(), attr, *args)

ietf/nomcom/models.py

@@ -12,7 +12,7 @@
 from ietf.name.models import NomineePositionState, FeedbackType
 from ietf.dbtemplate.models import DBTemplate
 
-from ietf.nomcom.managers import NomineePositionManager, NomineeManager
+from ietf.nomcom.managers import NomineePositionManager, NomineeManager, PositionManager
 from ietf.nomcom.utils import (initialize_templates_for_group,
                                initialize_questionnaire_for_position,
                                initialize_requirements_for_position)
@@ -114,6 +114,8 @@ class Position(models.Model):
     is_open = models.BooleanField(verbose_name='Is open')
     incumbent = models.ForeignKey(Email)
 
+    objects = PositionManager()
+
     class Meta:
         verbose_name_plural = 'Positions'
 

ietf/nomcom/templatetags/nomcom_tags.py

@@ -4,9 +4,12 @@
 from django import template
 from django.conf import settings
 
-from ietf.ietfauth.decorators import has_role
-from ietf.nomcom.utils import get_nomcom_by_year
 from ietf.utils.pipe import pipe
+from ietf.ietfauth.decorators import has_role
+
+from ietf.nomcom.models import Feedback
+from ietf.nomcom.utils import get_nomcom_by_year, get_user_email
+
 
 register = template.Library()
 
@@ -21,6 +24,21 @@ def is_chair(user, year):
     return nomcom.group.is_chair(user)
 
 
+@register.simple_tag
+def add_num_nominations(user, position, nominee):
+    author = get_user_email(user)
+    count = Feedback.objects.filter(position=position,
+                                    nominee=nominee,
+                                    author=author,
+                                    type='comment').count()
+    if count:
+        mark = """<span style="white-space: pre; color: red;">*</span>"""
+    else:
+        mark = """<span style="white-space: pre;"> </span> """
+
+    return '<span title="%d earlier comments from you on %s as %s">%s</span>&nbsp;' % (count, nominee, position, mark)
+
+
 @register.filter
 def decrypt(string, key=None):
     if not key:
@@ -34,7 +52,6 @@ def decrypt(string, key=None):
     code, out, error = pipe(command % (settings.OPENSSL_COMMAND,
                             encrypted_file.name), key)
 
-    
     os.unlink(encrypted_file.name)
 
     if error:

ietf/nomcom/utils.py

@@ -16,12 +16,15 @@
 NOMINATION_EMAIL_TEMPLATE = 'email/new_nomination.txt'
 NOMINEE_REMINDER_TEMPLATE = 'email/nomination_reminder.txt'
 NOMINATION_RECEIPT_TEMPLATE = 'email/nomination_receipt.txt'
+FEEDBACK_RECEIPT_TEMPLATE = 'email/feedback_receipt.txt'
+
 DEFAULT_NOMCOM_TEMPLATES = [HOME_TEMPLATE,
                             INEXISTENT_PERSON_TEMPLATE,
                             NOMINEE_EMAIL_TEMPLATE,
                             NOMINATION_EMAIL_TEMPLATE,
                             NOMINEE_REMINDER_TEMPLATE,
-                            NOMINATION_RECEIPT_TEMPLATE]
+                            NOMINATION_RECEIPT_TEMPLATE,
+                            FEEDBACK_RECEIPT_TEMPLATE]
 
 
 def get_nomcom_by_year(year):

ietf/nomcom/views.py

@@ -14,6 +14,7 @@
 from ietf.dbtemplate.models import DBTemplate
 from ietf.dbtemplate.views import template_edit
 from ietf.name.models import NomineePositionState
+
 from ietf.nomcom.decorators import member_required, private_key_required
 from ietf.nomcom.forms import (EditPublicKeyForm, NominateForm, FeedbackForm, MergeForm,
                                NomComTemplateForm, PositionForm, PrivateKeyForm)
@@ -252,6 +253,18 @@ def private_feedback(request, year):
 def feedback(request, year, public):
     nomcom = get_nomcom_by_year(year)
     has_publickey = nomcom.public_key and True or False
+    submit_disabled = True
+    nominee = None
+    position = None
+    selected_nominee = request.GET.get('nominee')
+    selected_position = request.GET.get('position')
+    if selected_nominee and selected_position:
+        nominee = Nominee.objects.get(id=selected_nominee)
+        position = Position.objects.get(id=selected_position)
+        submit_disabled = False
+
+    positions = Position.objects.get_by_nomcom(nomcom=nomcom).opened()
+
     if public:
         template = 'nomcom/public_feedback.html'
     else:
@@ -268,19 +281,23 @@ def feedback(request, year, public):
 
     message = None
     if request.method == 'POST':
-        form = FeedbackForm(data=request.POST, nomcom=nomcom, user=request.user, public=public)
+        form = FeedbackForm(data=request.POST, nomcom=nomcom, user=request.user,
+                            public=public, position=position, nominee=nominee)
         if form.is_valid():
             form.save()
-            message = ('success', 'Your nomination has been registered. Thank you for the nomination.')
+            message = ('success', 'Your feedback has been registered.')
     else:
-        form = FeedbackForm(nomcom=nomcom, user=request.user, public=public)
+        form = FeedbackForm(nomcom=nomcom, user=request.user, public=public,
+                            position=position, nominee=nominee)
 
     return render_to_response(template,
                               {'has_publickey': has_publickey,
                                'form': form,
                                'message': message,
                                'nomcom': nomcom,
                                'year': year,
+                               'positions': positions,
+                               'submit_disabled': submit_disabled,
                                'selected': 'feedback'}, RequestContext(request))