How to set up custom middleware in Django

by

First: The path structure

If you don’t have it you need to create the middleware folder within your app following the structure:

yourproject/yourapp/middleware

The folder middleware should be placed in the same folder as settings.py, urls, templates…

Important: Don’t forget to create the init.py empty file inside the middleware folder so your app recognizes this folder

Second: Create the middleware

Now we should create a file for our custom middleware, in this example let’s suppose we want a middleware that filter the users based on their IP, we create a file called filter_ip_middleware.py inside the middleware folder with this code:

class FilterIPMiddleware(object):
    # Check if client IP is allowed
    def process_request(self, request):
        allowed_ips = ['192.168.1.1', '123.123.123.123', etc...] # Authorized ip's
        ip = request.META.get('REMOTE_ADDR') # Get client IP
        if ip not in allowed_ips:
            raise Http403 # If user is not allowed raise Error
 
       # If IP is allowed we don't do anything
       return None

Third: Add the middleware in our ‘settings.py’

We need to look for:

  • MIDDLEWARE_CLASSES (django < 1.10)
  • MIDDLEWARE (django >= 1.10)

Inside the settings.py we need to add our middleware (Add it in the last position). It should look like:

MIDDLEWARE = ( #  Before Django 1.10 the setting name was 'MIDDLEWARE_CLASSES'
    'django.middleware.common.CommonMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
     # Above are django standard middlewares

     # Now we add here our custom middleware
     'yourapp.middleware.filter_ip_middleware.FilterIPMiddleware'
)

Done! Now every request from every client will call your custom middleware and process your custom code!

More Related Contents:

  1. django.core.exceptions.ImproperlyConfigured: Requested setting INSTALLED_APPS, but settings are not configured. plz help me out plz
  2. Django optional url parameters
  3. Django reverse lookup of foreign keys
  4. Where to put Django startup code?
  5. How to receive json data using HTTP POST request in Django 1.6?
  6. Django: CSRF token missing or incorrect
  7. is there a way to loop over two lists simultaneously in django?
  8. ValueError: Missing staticfiles manifest entry for ‘favicon.ico’
  9. Using request.user with Django ModelForm
  10. Class has no objects member
  11. Django class-based view: How do I pass additional parameters to the as_view method?
  12. How to change the file name of an uploaded file in Django?
  13. matching query does not exist Error in Django
  14. How to expire Django session in 5minutes?
  15. The view didn’t return an HttpResponse object. It returned None instead
  16. Django – form.save() is not creating ModelForm
  17. Class Based Views VS Function Based Views
  18. How does the order of mixins affect the derived class?
  19. Django 1.11 TypeError context must be a dict rather than Context
  20. Unable to import path from django.urls
  21. Override a form in Django admin
  22. How do I call a Django function on button click?
  23. Django Passing data between views
  24. QuerySet, Object has no attribute id – Django
  25. Django DoesNotExist
  26. Can I make STATICFILES_DIR same as STATIC_ROOT in Django 1.3?
  27. Django 2.1.3 Error: __init__() takes 1 positional argument but 2 were given
  28. How to redirect from a view to another view In Django
  29. Django — Conditional Login Redirect
  30. How to annotate Count with a condition in a Django queryset

Leave a Comment