~launchpad-pqm/launchpad/devel

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# Copyright 2009 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

# pylint: disable-msg=E0211,E0213

from zope.interface import (
    Attribute,
    Interface,
    )


__all__ = [
    'IGeoIP',
    'IGeoIPRecord',
    'IRequestLocalLanguages',
    'IRequestPreferredLanguages',
    ]


class IGeoIP(Interface):
    """The GeoIP utility, which represents the GeoIP database."""

    def getRecordByAddress(ip_address):
        """Return the IGeoIPRecord for the given IP address, or None."""

    def getCountryByAddr(ip_address):
        """Find and return an ICountry based on the given IP address.

        :param ip_address: Must be text in the dotted-address notation,
            for example '196.131.31.25'
        """


class IGeoIPRecord(Interface):
    """A single record in the GeoIP database.

    A GeoIP record gathers together all of the relevant information for a
    single IP address or machine name in the DNS.
    """

    latitude = Attribute("The geographic latitude, in real degrees.")
    latitude = Attribute("The geographic longitude, in real degrees.")
    time_zone = Attribute("The time zone.")


class IRequestLocalLanguages(Interface):

    def getLocalLanguages():
        """Return a list of the Language objects which represent languages
        spoken in the country from which that IP address is likely to be
        coming."""


class IRequestPreferredLanguages(Interface):

    def getPreferredLanguages():
        """Return a list of the Language objects which represent languages
        listed in the HTTP_ACCEPT_LANGUAGE header."""