Merge pull request #3273 from cisagov/rh/3129-domain-renewal-form

#3129 - Domain Renewal Form (Expiring Soon and Expired) - [AD]

docs/developer/registry-access.md

@@ -103,3 +103,31 @@ response = registry._client.transport.receive()
 ```
 
 This is helpful for debugging situations where epplib is not correctly or fully parsing the XML returned from the registry.
+
+### Adding in a expiring soon domain
+The below scenario is if you are NOT in org model mode (`organization_feature` waffle flag is off).
+
+1. Go to the `staging` sandbox and to `/admin`
+2. Go to Domains and find a domain that is actually expired by sorting the Expiration Date column
+3. Click into the domain to check the expiration date
+4. Click into Manage Domain to double check the expiration date as well
+5. Now hold onto that domain name, and save it for the command below
+
+6. In a terminal, run these commands:
+```
+cf ssh getgov-<your-intials>
+/tmp/lifecycle/shell
+./manage.py shell
+from registrar.models import Domain, DomainInvitation
+from registrar.models import User
+user = User.objects.filter(first_name="<your-first-name>")
+domain = Domain.objects.get_or_create(name="<that-domain-here>")
+```
+
+7. Go back to `/admin` and create Domain Information for that domain you just added in via the terminal 
+8. Go to Domain to find it 
+9. Click Manage Domain
+10. Add yourself as domain manager
+11. Go to the Registrar page and you should now see the expiring domain
+
+If you want to be in the org model mode, turn the `organization_feature` waffle flag on, and add that domain via Django Admin to a portfolio to be able to view it.

src/registrar/config/urls.py

@@ -345,6 +345,11 @@
         views.DomainSecurityEmailView.as_view(),
         name="domain-security-email",
     ),
+    path(
+        "domain/<int:pk>/renewal",
+        views.DomainRenewalView.as_view(),
+        name="domain-renewal",
+    ),
     path(
         "domain/<int:pk>/users/add",
         views.DomainAddUserView.as_view(),

src/registrar/forms/__init__.py

@@ -10,6 +10,7 @@
     DomainDsdataFormset,
     DomainDsdataForm,
     DomainSuborganizationForm,
+    DomainRenewalForm,
 )
 from .portfolio import (
     PortfolioOrgAddressForm,

src/registrar/forms/domain.py

@@ -661,3 +661,15 @@ def clean(self):
     extra=0,
     can_delete=True,
 )
+
+
+class DomainRenewalForm(forms.Form):
+    """Form making sure domain renewal ack is checked"""
+
+    is_policy_acknowledged = forms.BooleanField(
+        required=True,
+        label="I have read and agree to the requirements for operating a .gov domain.",
+        error_messages={
+            "required": "Check the box if you read and agree to the requirements for operating a .gov domain."
+        },
+    )

src/registrar/models/domain.py

@@ -326,9 +326,8 @@ def renew_domain(self, length: int = 1, unit: epp.Unit = epp.Unit.YEAR):
             exp_date = self.registry_expiration_date
         except KeyError:
             # if no expiration date from registry, set it to today
-            logger.warning("current expiration date not set; setting to today")
+            logger.warning("current expiration date not set; setting to today", exc_info=True)
             exp_date = date.today()
-
         # create RenewDomain request
         request = commands.RenewDomain(name=self.name, cur_exp_date=exp_date, period=epp.Period(length, unit))
 
@@ -338,13 +337,14 @@ def renew_domain(self, length: int = 1, unit: epp.Unit = epp.Unit.YEAR):
             self._cache["ex_date"] = registry.send(request, cleaned=True).res_data[0].ex_date
             self.expiration_date = self._cache["ex_date"]
             self.save()
+
         except RegistryError as err:
             # if registry error occurs, log the error, and raise it as well
-            logger.error(f"registry error renewing domain: {err}")
+            logger.error(f"Registry error renewing domain '{self.name}': {err}")
             raise (err)
         except Exception as e:
             # exception raised during the save to registrar
-            logger.error(f"error updating expiration date in registrar: {e}")
+            logger.error(f"Error updating expiration date for domain '{self.name}' in registrar: {e}")
             raise (e)
 
     @Cache
@@ -1575,7 +1575,7 @@ def dns_needed(self):
         logger.info("Changing to DNS_NEEDED state")
         logger.info("able to transition to DNS_NEEDED state")
 
-    def get_state_help_text(self) -> str:
+    def get_state_help_text(self, request=None) -> str:
         """Returns a str containing additional information about a given state.
         Returns custom content for when the domain itself is expired."""
 
@@ -1585,6 +1585,8 @@ def get_state_help_text(self) -> str:
             help_text = (
                 "This domain has expired, but it is still online. " "To renew this domain, contact help@get.gov."
             )
+        elif flag_is_active(request, "domain_renewal") and self.is_expiring():
+            help_text = "This domain will expire soon. Contact one of the listed domain managers to renew the domain."
         else:
             help_text = Domain.State.get_help_text(self.state)
 

src/registrar/templates/domain_base.html

@@ -1,5 +1,7 @@
 {% extends "base.html" %}
 {% load static %}
+{% load static url_helpers %}
+
 
 {% block title %}{{ domain.name }} | {% endblock %}
 
@@ -53,13 +55,16 @@ <h4 class="usa-alert__heading larger-font-sizing">Attention!</h4>
         {% endif %}
 
         {% block domain_content %}
-
+        {% if request.path|endswith:"renewal"%}
+        <h1>Renew {{domain.name}} </h1>
+        {%else%}
         <h1 class="break-word">Domain Overview</h1>
+        {% endif%}
 
         {% endblock %}  {# domain_content #}
       {% endif %}
       </main>
     </div>
   </div>
 </div>
-{% endblock %}  {# content #}
+{% endblock %}  {# content #}

src/registrar/templates/domain_detail.html

@@ -49,10 +49,18 @@ <h2 class="text-bold text-primary-dark domain-name-wrap">{{ domain.name }}</h2>
           </span>
           {% if domain.get_state_help_text %}
             <div class="padding-top-1 text-primary-darker">
-              {% if has_domain_renewal_flag and domain.is_expiring and is_domain_manager %}
-                This domain will expire soon. <a href="/not-available-yet">Renew to maintain access.</a>
+              {% if has_domain_renewal_flag and domain.is_expired and is_domain_manager %}
+                This domain has expired, but it is still online. 
+                {% url 'domain-renewal' pk=domain.id as url %}
+                <a href="{{ url }}">Renew to maintain access.</a>
+              {% elif has_domain_renewal_flag and domain.is_expiring and is_domain_manager %}
+                This domain will expire soon. 
+                {% url 'domain-renewal' pk=domain.id as url %}
+                <a href="{{ url }}">Renew to maintain access.</a>
               {% elif has_domain_renewal_flag and domain.is_expiring and is_portfolio_user %}
                 This domain will expire soon. Contact one of the listed domain managers to renew the domain.
+              {% elif has_domain_renewal_flag and domain.is_expired and is_portfolio_user %}
+                This domain has expired, but it is still online. Contact one of the listed domain managers to renew the domain.
               {% else %}
                 {{ domain.get_state_help_text }}
               {% endif %}

src/registrar/templates/domain_renewal.html

@@ -0,0 +1,140 @@
+{% extends "domain_base.html" %}
+{% load static url_helpers %}
+{% load custom_filters %}
+
+{% block domain_content %}
+  {% block breadcrumb %}
+
+  <!-- Banner for if_policy_acknowledged -->
+  {% if form.is_policy_acknowledged.errors %}
+    <div class="usa-alert usa-alert--error usa-alert--slim margin-bottom-2">
+      <div class="usa-alert__body">
+        {% for error in form.is_policy_acknowledged.errors %}
+          <p class="usa-alert__text">{{ error }}</p>
+        {% endfor %}
+      </div>
+    </div>
+  {% endif %}
+
+  {% if portfolio %}
+  <!-- Navigation breadcrumbs -->
+  <nav class="usa-breadcrumb padding-top-0" aria-label="Domain breadcrumb">
+    <ol class="usa-breadcrumb__list">
+      <li class="usa-breadcrumb__list-item">
+        <a href="{% url 'domains' %}" class="usa-breadcrumb__link"><span>Domains</span></a>
+      </li>
+      <li class="usa-breadcrumb__list-item">
+        <a href="{% url 'domain' pk=domain.id %}" class="usa-breadcrumb__link"><span>{{domain.name}}</span></a>
+      </li>
+      <li class="usa-breadcrumb__list-item usa-current" aria-current="page">
+        <span>Renewal Form</span>
+      </li>
+
+    </ol>
+  </nav>
+  {% endif %}
+  {% endblock breadcrumb %}
+
+  {{ block.super }}
+  <div class="margin-top-4 tablet:grid-col-10">
+    <h2 class="text-bold text-primary-dark domain-name-wrap">Confirm the following information for accuracy</h2>
+    <p>Review these details below. We <a href="https://get.gov/domains/requirements/#what-.gov-domain-registrants-must-do" class="usa-link">
+      require</a> that you maintain accurate information for the domain.
+      The details you provide will only be used to support the administration of .gov and won't be made public.
+    </p>
+    <p>If you would like to retire your domain instead, please <a href="https://get.gov/contact/" class="usa-link">
+      contact us</a>. </p>
+    <p><em>Required fields are marked with an asterisk (<abbr class="usa-hint usa-hint--required" title="required">*</abbr>).</em>
+    </p>
+
+
+    {% url 'user-profile' as url %}
+    {% include "includes/summary_item.html" with title='Your contact information' value=request.user edit_link=url editable=is_editable  contact='true' %}
+
+    {% if analyst_action != 'edit' or analyst_action_location != domain.pk %}
+      {% if is_portfolio_user and not is_domain_manager %}
+      <div class="usa-alert usa-alert--info usa-alert--slim">
+        <div class="usa-alert__body">
+          <p class="usa-alert__text ">
+            You don't have access to manage {{domain.name}}. If you need to make updates, contact one of the listed domain managers.
+          </p>
+        </div>
+      </div>
+      {% endif %}
+    {% endif %}
+
+    {% url 'domain-security-email' pk=domain.id as url %}
+    {% if security_email is not None and security_email not in hidden_security_emails%}
+      {% include "includes/summary_item.html" with title='Security email' value=security_email custom_text_for_value_none='We strongly recommend that you provide a security email. This email will allow the public to report observed or suspected security issues on your domain.' edit_link=url editable=is_editable %}
+    {% else %}
+      {% include "includes/summary_item.html" with title='Security email' value='None provided' custom_text_for_value_none='We strongly recommend that you provide a security email. This email will allow the public to report observed or suspected security issues on your domain.' edit_link=url editable=is_editable %}
+    {% endif %}
+
+    {% url 'domain-users' pk=domain.id as url %}
+    {% if portfolio %}
+      {% include "includes/summary_item.html" with title='Domain managers' domain_permissions=True value=domain edit_link=url editable=is_editable %}
+    {% else %}
+      {% include "includes/summary_item.html" with title='Domain managers' list=True users=True value=domain.permissions.all edit_link=url editable=is_editable %}
+    {% endif %}
+
+    <div class="border-top-1px border-primary-dark padding-top-1 margin-top-3 margin-bottom-2">
+
+      <fieldset class="usa-fieldset">
+        <legend>
+        <h3 class="summary-item__title 
+          font-sans-md 
+          text-primary-dark 
+          text-semibold 
+          margin-top-0 
+          margin-bottom-05 
+          padding-right-1">
+        Acknowledgement of .gov domain requirements </h3>          
+        </legend>
+
+        <form method="post" action="{% url 'domain-renewal' pk=domain.id %}"> 
+          {% csrf_token %}
+          <div class="usa-checkbox">
+
+            {% if form.is_policy_acknowledged.errors %}
+            {% for error in form.is_policy_acknowledged.errors %}
+            <div class="usa-error-message display-flex" role="alert">
+              <svg class="usa-icon usa-icon--large" focusable="true" role="img" aria-label="Error">
+                <use xlink:href="{%static 'img/sprite.svg'%}#error"></use>
+              </svg>
+              <span class="margin-left-05">{{ error }}</span>
+            </div>
+            {% endfor %}
+            </div>
+        {% endif %}
+
+          <input type="hidden" name="is_policy_acknowledged" value="False">
+
+          <input 
+            class="usa-checkbox__input" 
+            id="renewal-checkbox" 
+            type="checkbox" 
+            name="is_policy_acknowledged"
+            value="True"
+            {% if form.is_policy_acknowledged.value %}checked{% endif %}
+            >
+            <label class="usa-checkbox__label" for="renewal-checkbox">
+              I read and agree to the 
+              <a href="https://get.gov/domains/requirements/" class="usa-link">
+              requirements for operating a .gov domain
+              </a>.
+              <abbr class="usa-hint usa-hint--required" title="required">*</abbr>
+            </label>
+          </div>
+
+          <button
+            type="submit"
+            name="submit_button"
+            value="next"
+            class="usa-button margin-top-3"
+          > Submit
+          </button>
+        </form>
+      </fieldset>
+    </div>  <!-- End of the acknowledgement section div -->
+  </div>
+{% endblock %}  {# domain_content #}

src/registrar/templates/domain_sidebar.html

@@ -80,7 +80,16 @@
         {% include "includes/domain_sidenav_item.html" with item_text="Domain managers" %}
       {% endwith %}
 
+
+      {% if has_domain_renewal_flag and is_domain_manager%}
+       {% if domain.is_expiring or domain.is_expired %}
+          {% with url_name="domain-renewal" %}
+            {% include "includes/domain_sidenav_item.html" with item_text="Renewal form" %}
+          {% endwith %}
+        {% endif %}
+      {% endif %}
+
       {% endif %}
     </ul>
   </nav>
-</div>
+</div>

src/registrar/templates/includes/domains_table.html

@@ -172,7 +172,7 @@ <h2>Status</h2>
               >Deleted</label
             >
           </div>
-          {% if has_domain_renewal_flag and num_expiring_domains > 0 %}
+          {% if has_domain_renewal_flag %}
           <div class="usa-checkbox">
             <input
               class="usa-checkbox__input"

src/registrar/templates/includes/summary_item.html

@@ -127,15 +127,15 @@ <h4 class="h4--sm-05">Invited domain managers</h4>
           </ul>
         {% endif %}
       {% else %}
-      <p class="margin-top-0 margin-bottom-0">
+        {% if custom_text_for_value_none %}
+          <p class="margin-top-0 text-base-dark">{{ custom_text_for_value_none }}</p>
+        {% endif %}
         {% if value %}
           {{ value }}
-        {% elif custom_text_for_value_none %}
-          {{ custom_text_for_value_none }}
-        {% else %}
+        {% endif %}
+        {% if not value %}
           None
         {% endif %}
-      </p>
       {% endif %}
     </div>
 

src/registrar/templatetags/custom_filters.py

@@ -200,6 +200,7 @@ def is_domain_subpage(path):
         "domain-users-add",
         "domain-request-delete",
         "domain-user-delete",
+        "domain-renewal",
         "invitation-cancel",
     ]
     return get_url_name(path) in url_names