Make the IP Address Chooser configurable (#395)

* Make the IP address chooser configurable
* IP Chooser: Make all arguments optional, provide servertype
* Find free IP addresses by given attribute
* Standardize the choose_ip_address to full long name
* Allow for specifying networks to look for free IP addresses in

Author: TuxPowered42

adminapi/dataset.py

@@ -199,27 +199,28 @@ def _build_commit_object(self):
 
         return commit
 
-    def get_network_ip_addrs(self):
-        if self._restrict is not None and 'intern_ip' not in self._restrict:
-            raise DatasetError('"intern_ip" is not queried')
+    def get_network_ip_addrs(self, attr='intern_ip'):
+        if self._restrict is not None and attr not in self._restrict:
+            raise DatasetError(f'"{attr}" is not queried')
 
         for obj in self:
-            addr = obj['intern_ip']
+            addr = obj[attr]
             if isinstance(addr, (IPv4Network, IPv6Network)):
                 yield addr
 
-    def get_free_ip_addrs(self):
-        networks = list(self.get_network_ip_addrs())
+    def get_free_ip_addrs(self, attr='intern_ip', networks=None):
+        if networks is None:
+            networks = list(self.get_network_ip_addrs(attr))
         if not networks:
             raise DatasetError('No networks')
 
         # Index host and network addresses separately
         used_hosts = set()
         used_networks = list()
         for obj in type(self)({
-            'intern_ip': Any(*(ContainedOnlyBy(n) for n in networks)),
-        }, ['intern_ip']):
-            addr = obj['intern_ip']
+            attr: Any(*(ContainedOnlyBy(n) for n in networks)),
+        }, [attr]):
+            addr = obj[attr]
             if isinstance(addr, (IPv4Address, IPv6Address)):
                 used_hosts.add(addr)
             else:

serveradmin/servershell/static/js/servershell/choose_ip_address.js

@@ -5,14 +5,9 @@
  *
  * @param intern_ip e.g. 10.0.0.1
  */
-servershell.choose_ip_address = function(intern_ip) {
-    let data = {
-        network: intern_ip,
-        async: false,
-    };
-
+servershell.choose_ip_address = function(params) {
     spinner.enable('choose_ip_address');
-    $.get(servershell.urls.choose_ip_address, data, function(html) {
+    $.get(servershell.urls.choose_ip_address, params, function(html) {
         let modal = $('#modal_choose_ip_address');
 
         $('#modal_choose_ip_address .modal-body').html(html);

serveradmin/servershell/templates/servershell/choose_ip_addr.html renamed to serveradmin/servershell/templates/servershell/choose_ip_address.html

@@ -30,7 +30,7 @@
             </thead>
             <tbody>
                 {% for server in servers %}
-                    <tr onclick="servershell.choose_ip_address('{{ server.intern_ip }}')"
+                    <tr onclick="servershell.choose_ip_address({network:'{{ server.intern_ip }}'})"
                         data-search-values="{{ server.hostname }}, {{ server.intern_ip }}">
                         <td>{{ server.hostname }}</td>
                         <td>{{ server.intern_ip }}</td>

serveradmin/servershell/templates/servershell/edit.html

@@ -56,7 +56,7 @@ <h3>
                                        size="70" {% if field.readonly or field.type == 'related' %}disabled="disabled" {% endif %}
                                        {% if field.regexp %}data-pattern="{{ field.regexp }}"{% endif %}
                                        {% if field.required %} required {% endif %}
-                                       {% if field.key == 'intern_ip' %}readonly onclick="servershell.choose_ip_address();"{% endif %}
+                                       {% if field.key == 'intern_ip' %}readonly onclick="servershell.choose_ip_address({servertype:'{{ servertype }}'});"{% endif %}
                                 />
                             {% endif %}
                         </td>
@@ -83,17 +83,17 @@ <h3>
     </div>
 </form>
 
-{% include "servershell/modals/choose_ip_address.html" %}
+{% include choose_ip_address.include %}
 {% endblock %}
 
 {% block additional_scripts %}
 <script src="{{ STATIC_URL }}js/jquery-ui.min.js"></script>
 <script src="{{ STATIC_URL }}js/servershell.js"></script>
 <script src="{{ STATIC_URL }}js/servershell/validate.js"></script>
-<script src="{{ STATIC_URL }}js/servershell/choose_ip_address.js"></script>
+<script src="{{ STATIC_URL }}{{ choose_ip_address.js }}"></script>
 <script>
 servershell.urls = {
-    choose_ip_address: "{% url 'servershell_choose_ip_addr' %}",
+    choose_ip_address: "{{ choose_ip_address.url }}",
 };
 </script>
 {% endblock %}

serveradmin/servershell/templates/servershell/index.html

@@ -12,6 +12,8 @@
 {% endblock %}
 
 {% block content %}
+    {% include choose_ip_address.include %}
+
     <!-- Servershell JS alerts -->
     <div id="alerts">
         <div id="alert-template" class="alert" style="display: none;">
@@ -191,7 +193,7 @@
 <script src="{{ STATIC_URL }}js/servershell/result.js"></script>
 <script src="{{ STATIC_URL }}js/servershell/command.js"></script>
 <script src="{{ STATIC_URL }}js/servershell/validate.js"></script>
-<script src="{{ STATIC_URL }}js/servershell/choose_ip_address.js"></script>
+<script src="{{ STATIC_URL }}{{ choose_ip_address.js }}"></script>
 <script src="{{ STATIC_URL }}js/servershell/autocomplete/search.js"></script>
 <script src="{{ STATIC_URL }}js/servershell/autocomplete/command.js"></script>
 <script>
@@ -220,7 +222,7 @@
         // We define the URLs once here so that we can render them with
         // template engine from the backend and can access them everywhere
         servershell.urls = {
-            choose_ip_address: "{% url 'servershell_choose_ip_addr' %}",
+            choose_ip_address: "{{ choose_ip_address.url }}",
             inspect: "{% url 'servershell_inspect' %}",
             edit: "{% url 'servershell_edit' %}",
             graphite: "{% url 'graphite_graph_table' %}",

serveradmin/servershell/urls.py

@@ -15,7 +15,7 @@
     commit,
     new_object,
     clone_object,
-    choose_ip_addr,
+    choose_ip_address,
     settings, diff,
 )
 
@@ -29,7 +29,7 @@
     path('commit', commit, name='servershell_commit'),
     path('new', new_object, name='servershell_new'),
     path('clone', clone_object, name='servershell_clone'),
-    path('choose_ip_addr', choose_ip_addr, name='servershell_choose_ip_addr'),
+    path('choose_ip_address', choose_ip_address, name='servershell_choose_ip_address'),
     path('settings', settings, name='servershell_save_settings'),
     path('diff', diff, name='servershell_diff'),
     path('opensearch.xml', TemplateView.as_view(template_name='servershell/opensearch.xml'), name='opensearch.xml'),

serveradmin/servershell/views.py

@@ -8,6 +8,7 @@
 from ipaddress import IPv6Address, IPv4Address, ip_interface
 from itertools import islice, chain
 
+from django.conf import settings as django_settings
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
 from django.core.exceptions import (
@@ -31,7 +32,7 @@
 from django.views.defaults import bad_request
 
 from adminapi.datatype import DatatypeError
-from adminapi.filters import Any, ContainedOnlyBy, filter_classes, Not
+from adminapi.filters import Any, ContainedOnlyBy, filter_classes
 from adminapi.parse import parse_query
 from adminapi.request import json_encode_extra
 
@@ -109,6 +110,7 @@ def index(request):
         'filters': sorted([(f.__name__, f.__doc__) for f in filter_classes]),
         'search_settings': search_settings,
         'servershell_plugins': servershell_plugins(),
+        'choose_ip_address': django_settings.CHOOSE_IP_ADDRESS,
     })
 
 
@@ -392,6 +394,8 @@ def _edit(request: HttpRequest, server, edit_mode=False, template='edit'):  # NO
         'fields': fields,
         'base_template': 'base.html',
         'link': request.get_full_path(),
+        'choose_ip_address': django_settings.CHOOSE_IP_ADDRESS,
+        'servertype': server['servertype'],
     })
 
 
@@ -467,13 +471,13 @@ def clone_object(request):
 
 
 @login_required
-def choose_ip_addr(request):
+def choose_ip_address(request):
     if 'network' not in request.GET:
         servers = list(
             Query({'servertype': 'route_network'}, ['hostname', 'intern_ip'],
                   ['hostname']))
 
-        return TemplateResponse(request, 'servershell/choose_ip_addr.html',
+        return TemplateResponse(request, 'servershell/choose_ip_address.html',
                                 {'servers': servers})
 
     network = request.GET['network']
@@ -490,15 +494,12 @@ def choose_ip_addr(request):
     ))
 
     if servers:
-        return TemplateResponse(request, 'servershell/choose_ip_addr.html',
+        return TemplateResponse(request, 'servershell/choose_ip_address.html',
                                 {'servers': servers})
 
-    # TODO: This is specific to our data model, we should get it independent
-    network_query = Query(
-        {'intern_ip': network, 'servertype': Not('provider_network')},
-        ['intern_ip', 'servertype'])
+    network_query = Query({'intern_ip': network}, ['intern_ip'])
 
-    return TemplateResponse(request, 'servershell/choose_ip_addr.html', {
+    return TemplateResponse(request, 'servershell/choose_ip_address.html', {
         'ip_addrs': islice(network_query.get_free_ip_addrs(), 50)})
 
 

serveradmin/settings.py

@@ -196,6 +196,12 @@
     'graphOnly=true'
 )
 
+CHOOSE_IP_ADDRESS = {
+    'include': 'servershell/modals/choose_ip_address.html',
+    'url': '/servershell/choose_ip_address',
+    'js': 'js/servershell/choose_ip_address.js',
+}
+
 # Using exec certainly isn't an awesome solution but it's the best we've got.
 # The problem boils down to django configs being python files but python only
 # imports code from modules in its path.  One solution would be to generate a