initial example project WiP

peppelinux · peppelinux · commit a2dc43185d51 · 2020-05-28T16:18:03.000+02:00
diff --git a/admin_adv_search_builder/__init__.py b/admin_adv_search_builder/__init__.py
diff --git a/admin_adv_search_builder/apps.py b/admin_adv_search_builder/apps.py
@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AdminAdvSearchBuilderConfig(AppConfig):
+    name = 'admin_adv_search_builder'
diff --git a/admin_adv_search_builder/filters.py b/admin_adv_search_builder/filters.py
@@ -0,0 +1,49 @@
+from django.contrib import admin
+from django.contrib import messages
+from django.utils.translation import gettext as _
+
+
+class AdvancedSearchBuilder(admin.SimpleListFilter):
+    title = _('Custom Search')
+    parameter_name = 'custom_search'
+    template = 'filters/custom_search.html'
+
+    def lookups(self, request, model_admin):
+        """ it can be overloaded as follows
+            return (('uid', 'uid'),
+                    ('mail', 'mail'),
+                    ('sn', 'sn'),
+                    ('schacPersonalUniqueID','schacPersonalUniqueID'),
+                    ('schacPersonalUniqueCode','schacPersonalUniqueCode'),
+                    )
+        """
+        l = []
+        for i in model_admin.model._meta.fields:
+            l.append((i.name, i.name))
+        return l
+
+    def queryset(self, request, queryset):
+        """?custom_search=filter,mail__exact,peppelinux%40thatmail.it||
+        """
+        if request.GET.get(self.parameter_name):
+            post = dict(request.GET)[self.parameter_name][0]
+            search_list = []
+            search_list = post.split('||')
+            for se in search_list:
+                sple = se.split(',')
+                se_dict = {'{}__{}'.format(sple[0], sple[2]): sple[3]}
+                try:
+                    queryset = getattr(queryset, sple[1])(**se_dict)
+                except Exception as e:
+                    messages.add_message(request, messages.ERROR,
+                                         _('Search filter {} failed: {}').format(se, e))
+            return queryset
+
+
+    def choices(self, changelist):
+        for lookup, title in self.lookup_choices:
+            yield {
+                'selected': self.value() == str(lookup),
+                'query_string': changelist.get_query_string({self.parameter_name: lookup}),
+                'display': title,
+            }
diff --git a/admin_adv_search_builder/migrations/__init__.py b/admin_adv_search_builder/migrations/__init__.py
diff --git a/admin_adv_search_builder/templates/filters/custom_search.html b/admin_adv_search_builder/templates/filters/custom_search.html
@@ -0,0 +1,132 @@
+{% load i18n admin_urls %}
+{% load static %}
+
+<script>
+window.addEventListener('load', function() {
+    console.log('Django ModelAdmin Filterset builder loaded');
+    qs_to_filterset();
+});
+
+function qs_to_filterset() {
+    params = getParams(location);
+    if (params.custom_search){
+        filters = params.custom_search.split('||');
+        for (var i = 0; i < filters.length; i++) {
+            var filter = filters[i].split(',');
+            filterset_dom = filterset_duplicate();
+            filterset_dom.getElementsByClassName('cs_name')[0].value = filter[0];
+            filterset_dom.getElementsByClassName('cs_action')[0].value = filter[1];
+            filterset_dom.getElementsByClassName('cs_operator')[0].value = filter[2];
+            filterset_dom.getElementsByClassName('cs_value')[0].value = filter[3];
+        }
+    }
+}
+
+/**
+ * source: https://css-tricks.com/snippets/javascript/get-url-variables/
+ * @param  {String} url The URL
+ * @return {Object}     The URL parameters
+ */
+var getParams = function (url) {
+    var params = {};
+    var parser = document.createElement('a');
+    parser.href = url;
+    var query = parser.search.substring(1);
+    var vars = query.split('&');
+    for (var i = 0; i < vars.length; i++) {
+        var pair = vars[i].split('=');
+        params[pair[0]] = decodeURIComponent(pair[1]);
+    }
+    return params;
+};
+
+function build_filter(){
+    // ?custom_search=filter,mail__exact,peppelinux%40yahoo.it
+    cs_list = []
+
+    // check if there are others params
+    params = getParams(location);
+
+    // clean preexistent custom_searches
+    if (params.custom_search){delete(params.custom_search)}
+
+    params_len = Object.keys(params).length;
+    if (params_len > 1){
+      other_filters = getParams(location)
+      url = new URL(location);
+      first_val = url.search  +'&';
+      }
+    else {first_val = '?';}
+    first_val += 'custom_search=';
+    // first_val = '?custom_search=';
+
+    for (i = 0; i < 20; i++) {
+      if (!document.getElementsByClassName('cs_name')[i]) {break;}
+      if (!document.getElementsByClassName('cs_value')[i].value) {continue;}
+      search = [document.getElementsByClassName('cs_name')[i].value,
+                document.getElementsByClassName('cs_action')[i].value,
+                document.getElementsByClassName('cs_operator')[i].value,
+                document.getElementsByClassName('cs_value')[i].value]
+      // console.log(search);
+      // alert(search);
+      cs_list.push(search.join(','));
+    }
+    params = cs_list.join('||');
+    // console.log(params);
+    window.location = first_val + params;
+}
+
+var dup_cnt = 0;
+function filterset_duplicate() {
+    filterset_node = document.getElementsByClassName('cs_container')[0];
+    clone = filterset_node.cloneNode(true); // "deep" clone
+
+    // create delete button
+    filter_delete_div = document.createElement('div');
+    filter_delete_div.innerHTML = '<button>{% trans "delete" %}</button>'.trim();
+    filter_delete_div.setAttribute('onclick', 'filterset_remove(this.parentNode);');
+    clone.append(filter_delete_div)
+    filterset_node.parentNode.appendChild(clone);
+    return clone;
+}
+
+function filterset_remove(el) {
+  el.remove();
+}
+</script>
+
+<div onload="filterset_url_qs_init">
+    <h3 id="ldap_search" style="">LDAP {% trans "Search" %}</h3>
+
+    <div div="filterset-0" class="cs_container" style="padding: 15px">
+        <select name="cs_name_0" class="cs_name" style="margin-right: 13px;">
+        {% for choice in choices %}
+            <option value="{{ choice.display }}">{{ choice.display }}</option>
+        {% endfor %}
+        </select>
+
+        <select name="cs_operator_0" class="cs_operator" required  style="margin-right: 13px;">
+          <option value="exact">exact</option>
+          <option value="iexact">iexact</option>
+          <option value="icontains">icontains</option>
+          <option value="contains">contains</option>
+          <option value="startswith">startswith</option>
+          <option value="endswith">endswith</option>
+          <option value="gte">gte</option>
+          <option value="lte">lte</option>
+          <option value="is_null">is_null</option>
+        </select>
+
+        <select name="cs_action_0" class="cs_action" style="margin-right: 13px;">
+          <option value="filter">filter</option>
+          <option value="exclude">exclude</option>
+        </select>
+
+        <input name="cs_value_0" class="cs_value" placeholder="{% trans "value" %}" type="text">
+    </div>
+</div>
+
+<div class="controls" style="padding:15px;">
+    <input type="button" onclick="filterset_duplicate()" value="{% trans 'Add' %}">
+    <input type="submit" onclick="javascript:build_filter();" value="{% trans 'Search' %}">
+</div>
diff --git a/admin_adv_search_builder/tests.py b/admin_adv_search_builder/tests.py
@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.
diff --git a/example/admin_adv_search_builder b/example/admin_adv_search_builder
@@ -0,0 +1 @@
+../admin_adv_search_builder
diff --git a/example/example/__init__.py b/example/example/__init__.py
diff --git a/example/example/asgi.py b/example/example/asgi.py
@@ -0,0 +1,16 @@
+"""
+ASGI config for example project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+
+application = get_asgi_application()
diff --git a/example/example/settings.py b/example/example/settings.py
@@ -0,0 +1,122 @@
+"""
+Django settings for example project.
+
+Generated by 'django-admin startproject' using Django 3.0.6.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.0/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'x!y_kl4ou+6*(+!t^(by6cbp3oxc@^9vnf+wc8@#@*9u@k+3m7'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+
+    'admin_adv_search_builder'
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'example.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.0/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/3.0/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.0/howto/static-files/
+
+STATIC_URL = '/static/'
diff --git a/example/example/urls.py b/example/example/urls.py
@@ -0,0 +1,21 @@
+"""example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.0/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]
diff --git a/example/example/wsgi.py b/example/example/wsgi.py
@@ -0,0 +1,16 @@
+"""
+WSGI config for example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+
+application = get_wsgi_application()
diff --git a/example/manage.py b/example/manage.py
@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+django>3,<4

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from django.test import TestCase`
	`2`	`+`
	`3`	`+# Create your tests here.`