Julien Castiaux
c59750d824
Maxmind offers multiple ip-geolocalization databases, historically we have been using the City database which contains records on a city-basis. Many years later it turns out we are primary using geoip to know the country of the user. Geolocalization in the City database is considered slow by our standard and we have been clever in order not to geolocate each request by saving the info in the session. On the other hand, the Country database that is offered by Maxmind is much more lightweight and geoip using that country is considered a fast operation by our standard. In this work we make Odoo compatible with both the City and the Country databases. Using multiple database at the same time, we can be smart and only query each of the two on-demand. If a user ask for its country, we'll use the fast Country db. If a user ask for its city/timezone we'll use the slower City db. By default it loads both database from the `/usr/share/GeoIP/` folder, respectively the files `GeoLite2-City.mmdb` and `GeoLite2-Country.mmdb`, you can provide alternative paths using the `--geoip-city-db` and `--geoip-country-db` CLI options. In the same mindset as #86015, geoip is still lazy. It is done on-demand and the result is cached on the current request. The different with the related PR is that as we know consider geoip to be fast, we no longer cache the result in the session. Task: 2848206 Part-of: odoo/odoo#91337
108 lines
4.4 KiB
Python
108 lines
4.4 KiB
Python
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
import geoip2.errors
|
|
import geoip2.models
|
|
from html.parser import HTMLParser
|
|
from odoo.http import FilesystemSessionStore
|
|
from odoo.tools._vendor.sessions import SessionStore
|
|
|
|
|
|
TEST_IP = '192.0.2.42' # 192.0.2.0/24 are reserved for documentation,
|
|
# they are like example.com for ip addresses
|
|
TEST_IP_GEOIP_CITY = geoip2.models.City(
|
|
{'continent': {'code': 'EU', 'geoname_id': 6255148, 'names': {'de': 'Europa', 'en': 'Europe', 'es': 'Europa', 'fr': 'Europe', 'ja': 'ヨーロッパ', 'pt-BR': 'Europa', 'ru': 'Европа', 'zh-CN': '欧洲'}},
|
|
'country': {'geoname_id': 3017382, 'is_in_european_union': True, 'iso_code': 'FR', 'names': {'de': 'Frankreich', 'en': 'France', 'es': 'Francia', 'fr': 'France', 'ja': 'フランス共和国', 'pt-BR': 'França', 'ru': 'Франция', 'zh-CN': '法国'}},
|
|
'location': {'accuracy_radius': 500, 'latitude': 48.8582, 'longitude': 2.3387, 'time_zone': 'Europe/Paris'},
|
|
'registered_country': {'geoname_id': 3017382, 'is_in_european_union': True, 'iso_code': 'FR', 'names': {'de': 'Frankreich', 'en': 'France', 'es': 'Francia', 'fr': 'France', 'ja': 'フランス共和国', 'pt-BR': 'França', 'ru': 'Франция', 'zh-CN': '法国'}},
|
|
'traits': {'ip_address': TEST_IP, 'prefix_len': 21},
|
|
}, ['en']
|
|
)
|
|
TEST_IP_GEOIP_COUNTRY = geoip2.models.Country(
|
|
{'continent': {'code': 'EU', 'geoname_id': 6255148, 'names': {'de': 'Europa', 'en': 'Europe', 'es': 'Europa', 'fr': 'Europe', 'ja': 'ヨーロッパ', 'pt-BR': 'Europa', 'ru': 'Европа', 'zh-CN': '欧洲'}},
|
|
'country': {'geoname_id': 3017382, 'is_in_european_union': True, 'iso_code': 'FR', 'names': {'de': 'Frankreich', 'en': 'France', 'es': 'Francia', 'fr': 'France', 'ja': 'フランス共和国', 'pt-BR': 'França', 'ru': 'Франция', 'zh-CN': '法国'}},
|
|
'registered_country': {'geoname_id': 3017382, 'is_in_european_union': True, 'iso_code': 'FR', 'names': {'de': 'Frankreich', 'en': 'France', 'es': 'Francia', 'fr': 'France', 'ja': 'フランス共和国', 'pt-BR': 'França', 'ru': 'Франция', 'zh-CN': '法国'}},
|
|
'traits': {'ip_address': TEST_IP, 'prefix_len': 21},
|
|
}, ['en']
|
|
)
|
|
|
|
|
|
class MemoryGeoipResolver:
|
|
def __init__(self):
|
|
self.country_db = {TEST_IP: TEST_IP_GEOIP_COUNTRY}
|
|
self.city_db = {TEST_IP: TEST_IP_GEOIP_CITY}
|
|
|
|
def country(self, ip):
|
|
record = self.country_db.get(ip)
|
|
if not record:
|
|
raise geoip2.errors.AddressNotFoundError(ip)
|
|
return record
|
|
|
|
def city(self, ip):
|
|
record = self.city_db.get(ip)
|
|
if not record:
|
|
raise geoip2.errors.AddressNotFoundError(ip)
|
|
return record
|
|
|
|
class MemorySessionStore(SessionStore):
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
self.store = {}
|
|
|
|
def get(self, sid):
|
|
session = self.store.get(sid)
|
|
if not session:
|
|
session = self.new()
|
|
return session
|
|
|
|
def save(self, session):
|
|
self.store[session.sid] = session
|
|
|
|
def delete(self, session):
|
|
self.store.pop(session.sid, None)
|
|
|
|
def rotate(self, session, env):
|
|
FilesystemSessionStore.rotate(self, session, env)
|
|
|
|
def vacuum(self):
|
|
return
|
|
|
|
|
|
# pylint: disable=W0223(abstract-method)
|
|
class HtmlTokenizer(HTMLParser):
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
self.tokens = []
|
|
|
|
@classmethod
|
|
def _attrs_to_str(cls, attrs):
|
|
out = []
|
|
for key, value in attrs:
|
|
out.append(f"{key}={value!r}" if value else key)
|
|
return " ".join(out)
|
|
|
|
def handle_starttag(self, tag, attrs):
|
|
self.tokens.append(f"<{tag} {self._attrs_to_str(attrs)}>")
|
|
|
|
def handle_endtag(self, tag):
|
|
self.tokens.append(f"</{tag}>")
|
|
|
|
def handle_startendtag(self, tag, attrs):
|
|
# HTML5 <img> instead of XHTML <img/>
|
|
self.handle_starttag(tag, attrs)
|
|
|
|
def handle_data(self, data):
|
|
data = data.strip()
|
|
if data:
|
|
self.tokens.append(data)
|
|
|
|
@classmethod
|
|
def tokenize(cls, source_str):
|
|
"""
|
|
Parse the source html into a list of tokens. Only tags and
|
|
tags data are conserved, other elements such as comments are
|
|
discarded.
|
|
"""
|
|
tokenizer = cls()
|
|
tokenizer.feed(source_str)
|
|
return tokenizer.tokens
|