Merge remote-tracking branch 'upstream/master' into issues/600-replace-jsonfield-clean

Author: Eeshu-Yadav

.github/FUNDING.yml

@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: [openwisp]
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
             django-version: django~=4.2.0
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
@@ -56,7 +56,7 @@ jobs:
           sudo dpkg-reconfigure man-db
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"

.github/workflows/pypi.yml

@@ -17,9 +17,9 @@ jobs:
     permissions:
       id-token: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.10"
       - name: Install dependencies
@@ -29,4 +29,4 @@ jobs:
       - name: Build package
         run: python -m build
       - name: Publish package distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.12.4
+        uses: pypa/gh-action-pypi-publish@v1.13.0

docs/deploy/freeradius.rst

@@ -140,7 +140,7 @@ for the available configuration values.
         uri = "${..connect_uri}/api/v1/freeradius/authorize/"
         method = 'post'
         body = 'json'
-        data = '{"username": "%{User-Name}", "password": "%{User-Password}"}'
+        data = '{"username": "%{User-Name}", "password": "%{User-Password}", "called_station_id": "%{Called-Station-ID}", "calling_station_id": "%{Calling-Station-ID}"}'
         tls = ${..tls}
     }
 

docs/developer/installation.rst

@@ -20,8 +20,19 @@ Install the system dependencies:
 .. code-block:: shell
 
     sudo apt update
-    sudo apt install -y sqlite3 libsqlite3-dev libpq-dev
-    sudo apt install -y xmlsec1
+    sudo apt install xmlsec1 gettext \
+        sqlite3 \
+        # the dependencies below are needed
+        # to test the integration with
+        # OpenWISP Monitoring
+        fping \
+        gdal-bin \
+        libproj-dev \
+        libgeos-dev \
+        libspatialite-dev \
+        spatialite-bin \
+        libsqlite3-mod-spatialite
+    # for selenium tests
     sudo apt install -y chromium-browser
 
 Fork and clone the forked repository:
@@ -36,11 +47,12 @@ Navigate into the cloned repository:
 
     cd openwisp-radius/
 
-Launch Redis:
+Launch Redis (and InfluxDB for the :doc:`integration with OpenWISP
+Monitoring </radius/user/radius_monitoring>`):
 
 .. code-block:: shell
 
-    docker compose up -d redis
+    docker compose up -d redis influxdb
 
 Setup and activate a virtual-environment (we'll be using `virtualenv
 <https://pypi.org/project/virtualenv/>`_):
@@ -95,7 +107,7 @@ Run tests with:
 
 .. code-block:: shell
 
-    ./runtests.py --parallel
+    ./runtests
 
 Run quality assurance tests with:
 
@@ -136,7 +148,7 @@ Migrating an existing freeradius database
 -----------------------------------------
 
 If you already have a freeradius 3 database with the default schema, you
-should be able to use it with openwisp-radius (and extended apps) easily:
+should be able to use it with OpenWISP RADIUS (and extended apps) easily:
 
 1. first of all, back up your existing database;
 2. configure django to connect to your existing database;

docs/user/settings.rst

@@ -111,6 +111,18 @@ The default encryption format for storing radius check values.
 A list of disabled encryption formats, by default all formats are enabled
 in order to keep backward compatibility with legacy systems.
 
+``OPENWISP_RADIUS_BATCH_ASYNC_THRESHOLD``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Default**: ``15``
+
+When the number of users to be generated in batch user creation is greater
+than or equal to this value, the operation will be executed as a
+background task (asynchronously) using Celery. This prevents timeouts and
+keeps the user interface responsive when creating a large number of users.
+For batches smaller than the threshold, users will be created immediately
+(synchronously).
+
 ``OPENWISP_RADIUS_BATCH_DEFAULT_PASSWORD_LENGTH``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/user/simultaneous_use.rst

@@ -1,5 +1,5 @@
-Limiting concurrent sessions (``Simultaneous-Use``)
-===================================================
+Limiting concurrent sessions
+============================
 
 ``Simultaneous-Use`` is a FreeRADIUS feature that restricts how many
 sessions a user can keep active at the same time. When the maximum limit

openwisp_radius/admin.py

@@ -7,6 +7,7 @@
 from django.contrib.admin.utils import model_ngettext
 from django.contrib.auth import get_user_model
 from django.core.exceptions import PermissionDenied
+from django.http import HttpResponseRedirect
 from django.templatetags.static import static
 from django.urls import reverse
 from django.utils.safestring import mark_safe
@@ -338,13 +339,15 @@ class RadiusBatchAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin):
         "name",
         "organization",
         "strategy",
+        "status",
         "expiration_date",
         "created",
         "modified",
     ]
     fields = [
         "strategy",
         "organization",
+        "status",
         "name",
         "csvfile",
         "prefix",
@@ -393,25 +396,21 @@ def number_of_users(self, obj):
     number_of_users.short_description = _("number of users")
 
     def get_fields(self, request, obj=None):
-        fields = super().get_fields(request, obj)[:]
+        fields = super().get_fields(request, obj)
         if not obj:
+            fields = fields[:]
             fields.remove("users")
+            fields.remove("status")
         return fields
 
     def save_model(self, request, obj, form, change):
-        data = form.cleaned_data
-        strategy = data.get("strategy")
-        if not change:
-            if strategy == "csv":
-                if data.get("csvfile", False):
-                    csvfile = data.get("csvfile")
-                    obj.csvfile_upload(csvfile)
-            elif strategy == "prefix":
-                prefix = data.get("prefix")
-                n = data.get("number_of_users")
-                obj.prefix_add(prefix, n)
-        else:
-            obj.save()
+        if change:
+            super().save_model(request, obj, form, change)
+            return
+        # Save the object initially to get a PK
+        super().save_model(request, obj, form, change)
+        num_users = form.cleaned_data.get("number_of_users", 0)
+        obj.schedule_processing(number_of_users=num_users)
 
     def delete_model(self, request, obj):
         obj.users.all().delete()
@@ -466,16 +465,46 @@ def get_readonly_fields(self, request, obj=None):
         readonly_fields = super(RadiusBatchAdmin, self).get_readonly_fields(
             request, obj
         )
-        if obj:
+        if obj and obj.status != "pending":
             return (
                 "strategy",
                 "prefix",
                 "csvfile",
                 "number_of_users",
                 "users",
                 "expiration_date",
+                "name",
+                "organization",
+                "status",
             ) + readonly_fields
-        return readonly_fields
+        elif obj:
+            return ("status",) + readonly_fields
+        return ("status",) + readonly_fields
+
+    def has_delete_permission(self, request, obj=None):
+        if obj and obj.status == "processing":
+            return False
+        return super().has_delete_permission(request, obj)
+
+    def response_add(self, request, obj, post_url_continue=None):
+        if obj.status != "pending":
+            return super().response_add(request, obj, post_url_continue)
+        opts = self.model._meta
+        msg = _(
+            'The batch user creation "{obj}" was added successfully '
+            "and is now being processed in the background."
+        ).format(obj=obj)
+        if "_continue" in request.POST:
+            self.message_user(request, msg, messages.SUCCESS)
+            post_url_continue = reverse(
+                f"admin:{opts.app_label}_{opts.model_name}_change",
+                args=(obj.pk,),
+                current_app=self.admin_site.name,
+            )
+            return HttpResponseRedirect(post_url_continue)
+        else:
+            self.message_user(request, msg, messages.SUCCESS)
+            return self.response_post_save_add(request, obj)
 
 
 # Inlines for UserAdmin & OrganizationAdmin