mirror of
https://gitlab2.federez.net/re2o/re2o
synced 2024-11-05 01:16:27 +00:00
422 lines
14 KiB
Python
422 lines
14 KiB
Python
# Re2o est un logiciel d'administration développé initiallement au rezometz. Il
|
|
# se veut agnostique au réseau considéré, de manière à être installable en
|
|
# quelques clics.
|
|
#
|
|
# Copyright © 2017 Gabriel Détraz
|
|
# Copyright © 2017 Lara Kermarec
|
|
# Copyright © 2017 Augustin Lemesle
|
|
# Copyright © 2019 Jean-Romain Garnier
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License along
|
|
# with this program; if not, write to the Free Software Foundation, Inc.,
|
|
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
"""The views for the search app, responsible for finding the matches
|
|
Augustin lemesle, Gabriel Détraz, Lara Kermarec, Maël Kervella
|
|
Gplv2"""
|
|
|
|
|
|
from __future__ import unicode_literals
|
|
|
|
from netaddr import EUI, AddrFormatError
|
|
|
|
from django.shortcuts import render
|
|
from django.contrib.auth.decorators import login_required
|
|
|
|
from django.db.models import Q
|
|
from users.models import User, Adherent, Club, Ban, Whitelist
|
|
from machines.models import Machine
|
|
from cotisations.models import Cotisation
|
|
from topologie.models import Port, Switch, Room
|
|
from cotisations.models import Facture
|
|
from preferences.models import GeneralOption
|
|
from search.forms import (
|
|
SearchForm,
|
|
SearchFormPlus,
|
|
CHOICES_USER,
|
|
CHOICES_AFF,
|
|
initial_choices,
|
|
)
|
|
from re2o.base import SortTable, re2o_paginator
|
|
from re2o.acl import can_view_all
|
|
|
|
|
|
def is_int(variable):
|
|
""" Check if the variable can be casted to an integer """
|
|
|
|
try:
|
|
int(variable)
|
|
except ValueError:
|
|
return False
|
|
else:
|
|
return True
|
|
|
|
|
|
def finish_results(request, results, col, order):
|
|
"""Sort the results by applying filters and then limit them to the
|
|
number of max results. Finally add the info of the nmax number of results
|
|
to the dict"""
|
|
|
|
results["users"] = SortTable.sort(
|
|
results["users"], col, order, SortTable.USERS_INDEX
|
|
)
|
|
results["machines"] = SortTable.sort(
|
|
results["machines"], col, order, SortTable.MACHINES_INDEX
|
|
)
|
|
results["factures"] = SortTable.sort(
|
|
results["factures"], col, order, SortTable.COTISATIONS_INDEX
|
|
)
|
|
results["bans"] = SortTable.sort(
|
|
results["bans"], col, order, SortTable.USERS_INDEX_BAN
|
|
)
|
|
results["whitelists"] = SortTable.sort(
|
|
results["whitelists"], col, order, SortTable.USERS_INDEX_WHITE
|
|
)
|
|
results["rooms"] = SortTable.sort(
|
|
results["rooms"], col, order, SortTable.TOPOLOGIE_INDEX_ROOM
|
|
)
|
|
results["ports"] = SortTable.sort(
|
|
results["ports"], col, order, SortTable.TOPOLOGIE_INDEX_PORT
|
|
)
|
|
results["switches"] = SortTable.sort(
|
|
results["switches"], col, order, SortTable.TOPOLOGIE_INDEX
|
|
)
|
|
|
|
max_result = GeneralOption.get_cached_value("search_display_page")
|
|
for name, val in results.items():
|
|
page_arg = name + "_page"
|
|
results[name] = re2o_paginator(request, val.distinct(), max_result, page_arg=page_arg)
|
|
|
|
results.update({"max_result": max_result})
|
|
|
|
return results
|
|
|
|
|
|
def search_single_word(word, filters, user, start, end, user_state, aff):
|
|
""" Construct the correct filters to match differents fields of some models
|
|
with the given query according to the given filters.
|
|
The match field are either CharField or IntegerField that will be displayed
|
|
on the results page (else, one might not see why a result has matched the
|
|
query). IntegerField are matched against the query only if it can be casted
|
|
to an int."""
|
|
|
|
# Users
|
|
if "0" in aff:
|
|
filter_clubs = (
|
|
Q(surname__icontains=word)
|
|
| Q(pseudo__icontains=word)
|
|
| Q(room__name__icontains=word)
|
|
| Q(email__icontains=word)
|
|
| Q(telephone__icontains=word)
|
|
)
|
|
filter_users = (filter_clubs | Q(name__icontains=word))
|
|
|
|
if len(word.split(" ")) >= 2:
|
|
# Assume the room is in 1 word, and the building may be in multiple words
|
|
building = " ".join(word.split(" ")[:-1])
|
|
room = word.split(" ")[-1]
|
|
filter_users |= (Q(room__name__icontains=room) & Q(room__building__name__icontains=building))
|
|
|
|
if not User.can_view_all(user)[0]:
|
|
filter_clubs &= Q(id=user.id)
|
|
filter_users &= Q(id=user.id)
|
|
|
|
filter_clubs &= Q(state__in=user_state)
|
|
filter_users &= Q(state__in=user_state)
|
|
|
|
filters["users"] |= filter_users
|
|
filters["clubs"] |= filter_clubs
|
|
|
|
# Machines
|
|
if "1" in aff:
|
|
filter_machines = (
|
|
Q(name__icontains=word)
|
|
| (Q(user__pseudo__icontains=word) & Q(user__state__in=user_state))
|
|
| Q(interface__domain__name__icontains=word)
|
|
| Q(interface__domain__related_domain__name__icontains=word)
|
|
| Q(interface__mac_address__icontains=word)
|
|
| Q(interface__ipv4__ipv4__icontains=word)
|
|
)
|
|
try:
|
|
_mac_addr = EUI(word, 48)
|
|
filter_machines |= Q(interface__mac_address=word)
|
|
except AddrFormatError:
|
|
pass
|
|
if not Machine.can_view_all(user)[0]:
|
|
filter_machines &= Q(user__id=user.id)
|
|
filters["machines"] |= filter_machines
|
|
|
|
# Factures
|
|
if "2" in aff:
|
|
filter_factures = Q(user__pseudo__icontains=word) & Q(
|
|
user__state__in=user_state
|
|
)
|
|
if start is not None:
|
|
filter_factures &= Q(date__gte=start)
|
|
if end is not None:
|
|
filter_factures &= Q(date__lte=end)
|
|
filters["factures"] |= filter_factures
|
|
|
|
# Bans
|
|
if "3" in aff:
|
|
filter_bans = (
|
|
Q(user__pseudo__icontains=word) & Q(user__state__in=user_state)
|
|
) | Q(raison__icontains=word)
|
|
if start is not None:
|
|
filter_bans &= (
|
|
(Q(date_start__gte=start) & Q(date_end__gte=start))
|
|
| (Q(date_start__lte=start) & Q(date_end__gte=start))
|
|
| (Q(date_start__gte=start) & Q(date_end__lte=start))
|
|
)
|
|
if end is not None:
|
|
filter_bans &= (
|
|
(Q(date_start__lte=end) & Q(date_end__lte=end))
|
|
| (Q(date_start__lte=end) & Q(date_end__gte=end))
|
|
| (Q(date_start__gte=end) & Q(date_end__lte=end))
|
|
)
|
|
filters["bans"] |= filter_bans
|
|
|
|
# Whitelists
|
|
if "4" in aff:
|
|
filter_whitelists = (
|
|
Q(user__pseudo__icontains=word) & Q(user__state__in=user_state)
|
|
) | Q(raison__icontains=word)
|
|
if start is not None:
|
|
filter_whitelists &= (
|
|
(Q(date_start__gte=start) & Q(date_end__gte=start))
|
|
| (Q(date_start__lte=start) & Q(date_end__gte=start))
|
|
| (Q(date_start__gte=start) & Q(date_end__lte=start))
|
|
)
|
|
if end is not None:
|
|
filter_whitelists &= (
|
|
(Q(date_start__lte=end) & Q(date_end__lte=end))
|
|
| (Q(date_start__lte=end) & Q(date_end__gte=end))
|
|
| (Q(date_start__gte=end) & Q(date_end__lte=end))
|
|
)
|
|
filters["whitelists"] |= filter_whitelists
|
|
|
|
# Rooms
|
|
if "5" in aff and Room.can_view_all(user):
|
|
filter_rooms = (
|
|
Q(details__icontains=word) | Q(name__icontains=word) | Q(port__details=word)
|
|
)
|
|
|
|
if len(word.split(" ")) >= 2:
|
|
# Assume the room is in 1 word, and the building may be in multiple words
|
|
building = " ".join(word.split(" ")[:-1])
|
|
room = word.split(" ")[-1]
|
|
filter_rooms |= (Q(name__icontains=room) & Q(building__name__icontains=building))
|
|
|
|
filters["rooms"] |= filter_rooms
|
|
|
|
# Switch ports
|
|
if "6" in aff and User.can_view_all(user):
|
|
filter_ports = (
|
|
Q(room__name__icontains=word)
|
|
| Q(machine_interface__domain__name__icontains=word)
|
|
| Q(related__switch__interface__domain__name__icontains=word)
|
|
| Q(custom_profile__name__icontains=word)
|
|
| Q(custom_profile__profil_default__icontains=word)
|
|
| Q(details__icontains=word)
|
|
)
|
|
if is_int(word):
|
|
filter_ports |= Q(port=word)
|
|
filters["ports"] |= filter_ports
|
|
|
|
# Switches
|
|
if "7" in aff and Switch.can_view_all(user):
|
|
filter_switches = (
|
|
Q(interface__domain__name__icontains=word)
|
|
| Q(interface__ipv4__ipv4__icontains=word)
|
|
| Q(switchbay__building__name__icontains=word)
|
|
| Q(stack__name__icontains=word)
|
|
| Q(model__reference__icontains=word)
|
|
| Q(model__constructor__name__icontains=word)
|
|
| Q(interface__details__icontains=word)
|
|
)
|
|
if is_int(word):
|
|
filter_switches |= Q(number=word) | Q(stack_member_id=word)
|
|
filters["switches"] |= filter_switches
|
|
|
|
return filters
|
|
|
|
|
|
def apply_filters(filters, user, aff):
|
|
""" Apply the filters constructed by search_single_word.
|
|
It also takes into account the visual filters defined during
|
|
the search query.
|
|
"""
|
|
# Results are later filled-in depending on the display filter
|
|
results = {
|
|
"users": Adherent.objects.none(),
|
|
"clubs": Club.objects.none(),
|
|
"machines": Machine.objects.none(),
|
|
"factures": Facture.objects.none(),
|
|
"bans": Ban.objects.none(),
|
|
"whitelists": Whitelist.objects.none(),
|
|
"rooms": Room.objects.none(),
|
|
"ports": Port.objects.none(),
|
|
"switches": Switch.objects.none(),
|
|
}
|
|
|
|
# Users and clubs
|
|
if "0" in aff:
|
|
results["users"] = Adherent.objects.filter(filters["users"])
|
|
results["clubs"] = Club.objects.filter(filters["clubs"])
|
|
|
|
# Machines
|
|
if "1" in aff:
|
|
results["machines"] = Machine.objects.filter(filters["machines"])
|
|
|
|
# Factures
|
|
if "2" in aff:
|
|
results["factures"] = Facture.objects.filter(filters["factures"])
|
|
|
|
# Bans
|
|
if "3" in aff:
|
|
results["bans"] = Ban.objects.filter(filters["bans"])
|
|
|
|
# Whitelists
|
|
if "4" in aff:
|
|
results["whitelists"] = Whitelist.objects.filter(filters["whitelists"])
|
|
|
|
# Rooms
|
|
if "5" in aff and Room.can_view_all(user):
|
|
results["rooms"] = Room.objects.filter(filters["rooms"])
|
|
|
|
# Switch ports
|
|
if "6" in aff and User.can_view_all(user):
|
|
results["ports"] = Port.objects.filter(filters["ports"])
|
|
|
|
# Switches
|
|
if "7" in aff and Switch.can_view_all(user):
|
|
results["switches"] = Switch.objects.filter(filters["switches"])
|
|
|
|
return results
|
|
|
|
|
|
def get_words(query):
|
|
"""Function used to split the uery in different words to look for.
|
|
The rules are simple :
|
|
- anti-slash ('\\') is used to escape characters
|
|
- anything between quotation marks ('"') is kept intact (not
|
|
interpreted as separators) excepts anti-slashes used to escape
|
|
- spaces (' ') and commas (',') are used to separated words
|
|
"""
|
|
|
|
words = []
|
|
i = 0
|
|
keep_intact = False
|
|
escaping_char = False
|
|
for char in query:
|
|
if i >= len(words):
|
|
# We are starting a new word
|
|
words.append("")
|
|
if escaping_char:
|
|
# The last char war a \ so we escape this char
|
|
escaping_char = False
|
|
words[i] += char
|
|
continue
|
|
if char == "\\":
|
|
# We need to escape the next char
|
|
escaping_char = True
|
|
continue
|
|
if char == '"':
|
|
# Toogle the keep_intact state, if true, we are between two "
|
|
keep_intact = not keep_intact
|
|
continue
|
|
if keep_intact:
|
|
# If we are between two ", ignore separators
|
|
words[i] += char
|
|
continue
|
|
if char == "+":
|
|
# If we encouter a + outside of ", we replace it with a space
|
|
words[i] += " "
|
|
continue
|
|
if char == " " or char == ",":
|
|
# If we encouter a separator outside of ", we create a new word
|
|
if words[i] is not "":
|
|
i += 1
|
|
continue
|
|
# If we haven't encountered any special case, add the char to the word
|
|
words[i] += char
|
|
|
|
return words
|
|
|
|
|
|
def get_results(query, request, params):
|
|
"""The main function of the search procedure. It gather the filters for
|
|
each of the different words of the query and concatenate them into a
|
|
single filter. Then it calls 'finish_results' and return the queryset of
|
|
objects to display as results"""
|
|
|
|
start = params.get("s", None)
|
|
end = params.get("e", None)
|
|
user_state = params.get("u", initial_choices(CHOICES_USER))
|
|
aff = params.get("a", initial_choices(CHOICES_AFF))
|
|
|
|
filters = {
|
|
"users": Q(),
|
|
"clubs": Q(),
|
|
"machines": Q(),
|
|
"factures": Q(),
|
|
"bans": Q(),
|
|
"whitelists": Q(),
|
|
"rooms": Q(),
|
|
"ports": Q(),
|
|
"switches": Q(),
|
|
}
|
|
|
|
words = get_words(query)
|
|
for word in words:
|
|
filters = search_single_word(
|
|
word, filters, request.user, start, end, user_state, aff
|
|
)
|
|
|
|
results = apply_filters(filters, request.user, aff)
|
|
results = finish_results(request, results, request.GET.get("col"), request.GET.get("order"))
|
|
results.update({"search_term": query})
|
|
|
|
return results
|
|
|
|
|
|
@login_required
|
|
@can_view_all(User, Machine, Cotisation)
|
|
def search(request):
|
|
""" La page de recherche standard """
|
|
search_form = SearchForm(request.GET or None)
|
|
if search_form.is_valid():
|
|
return render(
|
|
request,
|
|
"search/index.html",
|
|
get_results(
|
|
search_form.cleaned_data.get("q", ""), request, search_form.cleaned_data
|
|
),
|
|
)
|
|
return render(request, "search/search.html", {"search_form": search_form})
|
|
|
|
|
|
@login_required
|
|
@can_view_all(User, Machine, Cotisation)
|
|
def searchp(request):
|
|
""" La page de recherche avancée """
|
|
search_form = SearchFormPlus(request.GET or None)
|
|
if search_form.is_valid():
|
|
return render(
|
|
request,
|
|
"search/index.html",
|
|
get_results(
|
|
search_form.cleaned_data.get("q", ""), request, search_form.cleaned_data
|
|
),
|
|
)
|
|
return render(request, "search/search.html", {"search_form": search_form})
|