summaryrefslogtreecommitdiff
path: root/sleekxmpp/plugins/xep_0080
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2014-07-17 14:19:04 +0200
committerFlorent Le Coz <louiz@louiz.org>2014-07-17 14:19:04 +0200
commit5ab77c745270d7d5c016c1dc7ef2a82533a4b16e (patch)
tree259377cc666f8b9c7954fc4e7b8f7a912bcfe101 /sleekxmpp/plugins/xep_0080
parente5582694c07236e6830c20361840360a1dde37f3 (diff)
downloadslixmpp-5ab77c745270d7d5c016c1dc7ef2a82533a4b16e.tar.gz
slixmpp-5ab77c745270d7d5c016c1dc7ef2a82533a4b16e.tar.bz2
slixmpp-5ab77c745270d7d5c016c1dc7ef2a82533a4b16e.tar.xz
slixmpp-5ab77c745270d7d5c016c1dc7ef2a82533a4b16e.zip
Rename to slixmpp
Diffstat (limited to 'sleekxmpp/plugins/xep_0080')
-rw-r--r--sleekxmpp/plugins/xep_0080/__init__.py15
-rw-r--r--sleekxmpp/plugins/xep_0080/geoloc.py125
-rw-r--r--sleekxmpp/plugins/xep_0080/stanza.py266
3 files changed, 0 insertions, 406 deletions
diff --git a/sleekxmpp/plugins/xep_0080/__init__.py b/sleekxmpp/plugins/xep_0080/__init__.py
deleted file mode 100644
index cad23d22..00000000
--- a/sleekxmpp/plugins/xep_0080/__init__.py
+++ /dev/null
@@ -1,15 +0,0 @@
-"""
- SleekXMPP: The Sleek XMPP Library
- Copyright (C) 2010 Nathanael C. Fritz, Erik Reuterborg Larsson
- This file is part of SleekXMPP.
-
- See the file LICENSE for copying permission.
-"""
-
-from sleekxmpp.plugins.base import register_plugin
-
-from sleekxmpp.plugins.xep_0080.stanza import Geoloc
-from sleekxmpp.plugins.xep_0080.geoloc import XEP_0080
-
-
-register_plugin(XEP_0080)
diff --git a/sleekxmpp/plugins/xep_0080/geoloc.py b/sleekxmpp/plugins/xep_0080/geoloc.py
deleted file mode 100644
index ba594cce..00000000
--- a/sleekxmpp/plugins/xep_0080/geoloc.py
+++ /dev/null
@@ -1,125 +0,0 @@
-"""
- SleekXMPP: The Sleek XMPP Library
- Copyright (C) 2010 Nathanael C. Fritz, Erik Reuterborg Larsson
- This file is part of SleekXMPP.
-
- See the file LICENSE for copying permission.
-"""
-
-import logging
-
-import sleekxmpp
-from sleekxmpp.plugins.base import BasePlugin
-from sleekxmpp.xmlstream import register_stanza_plugin
-from sleekxmpp.plugins.xep_0080 import stanza, Geoloc
-
-
-log = logging.getLogger(__name__)
-
-
-class XEP_0080(BasePlugin):
-
- """
- XEP-0080: User Location
- """
-
- name = 'xep_0080'
- description = 'XEP-0080: User Location'
- dependencies = set(['xep_0163'])
- stanza = stanza
-
- def plugin_end(self):
- self.xmpp['xep_0163'].remove_interest(Geoloc.namespace)
- self.xmpp['xep_0030'].del_feature(feature=Geoloc.namespace)
-
- def session_bind(self, jid):
- self.xmpp['xep_0163'].register_pep('user_location', Geoloc)
-
- def publish_location(self, **kwargs):
- """
- Publish the user's current location.
-
- Arguments:
- accuracy -- Horizontal GPS error in meters.
- alt -- Altitude in meters above or below sea level.
- area -- A named area such as a campus or neighborhood.
- bearing -- GPS bearing (direction in which the entity is
- heading to reach its next waypoint), measured in
- decimal degrees relative to true north.
- building -- A specific building on a street or in an area.
- country -- The nation where the user is located.
- countrycode -- The ISO 3166 two-letter country code.
- datum -- GPS datum.
- description -- A natural-language name for or description of
- the location.
- error -- Horizontal GPS error in arc minutes. Obsoleted by
- the accuracy parameter.
- floor -- A particular floor in a building.
- lat -- Latitude in decimal degrees North.
- locality -- A locality within the administrative region, such
- as a town or city.
- lon -- Longitude in decimal degrees East.
- postalcode -- A code used for postal delivery.
- region -- An administrative region of the nation, such
- as a state or province.
- room -- A particular room in a building.
- speed -- The speed at which the entity is moving,
- in meters per second.
- street -- A thoroughfare within the locality, or a crossing
- of two thoroughfares.
- text -- A catch-all element that captures any other
- information about the location.
- timestamp -- UTC timestamp specifying the moment when the
- reading was taken.
- uri -- A URI or URL pointing to information about
- the location.
-
- options -- Optional form of publish options.
- ifrom -- Specify the sender's JID.
- block -- Specify if the send call will block until a response
- is received, or a timeout occurs. Defaults to True.
- timeout -- The length of time (in seconds) to wait for a response
- before exiting the send call if blocking is used.
- Defaults to sleekxmpp.xmlstream.RESPONSE_TIMEOUT
- callback -- Optional reference to a stream handler function. Will
- be executed when a reply stanza is received.
- """
- options = kwargs.get('options', None)
- ifrom = kwargs.get('ifrom', None)
- block = kwargs.get('block', None)
- callback = kwargs.get('callback', None)
- timeout = kwargs.get('timeout', None)
- for param in ('ifrom', 'block', 'callback', 'timeout', 'options'):
- if param in kwargs:
- del kwargs[param]
-
- geoloc = Geoloc()
- geoloc.values = kwargs
-
- return self.xmpp['xep_0163'].publish(geoloc,
- options=options,
- ifrom=ifrom,
- block=block,
- callback=callback,
- timeout=timeout)
-
- def stop(self, ifrom=None, block=True, callback=None, timeout=None):
- """
- Clear existing user location information to stop notifications.
-
- Arguments:
- ifrom -- Specify the sender's JID.
- block -- Specify if the send call will block until a response
- is received, or a timeout occurs. Defaults to True.
- timeout -- The length of time (in seconds) to wait for a response
- before exiting the send call if blocking is used.
- Defaults to sleekxmpp.xmlstream.RESPONSE_TIMEOUT
- callback -- Optional reference to a stream handler function. Will
- be executed when a reply stanza is received.
- """
- geoloc = Geoloc()
- return self.xmpp['xep_0163'].publish(geoloc,
- ifrom=ifrom,
- block=block,
- callback=callback,
- timeout=timeout)
diff --git a/sleekxmpp/plugins/xep_0080/stanza.py b/sleekxmpp/plugins/xep_0080/stanza.py
deleted file mode 100644
index 8f466516..00000000
--- a/sleekxmpp/plugins/xep_0080/stanza.py
+++ /dev/null
@@ -1,266 +0,0 @@
-"""
- SleekXMPP: The Sleek XMPP Library
- Copyright (C) 2010 Nathanael C. Fritz
- This file is part of SleekXMPP.
-
- See the file LICENSE for copying permission.
-"""
-
-from sleekxmpp.xmlstream import ElementBase
-from sleekxmpp.plugins import xep_0082
-
-
-class Geoloc(ElementBase):
-
- """
- XMPP's <geoloc> stanza allows entities to know the current
- geographical or physical location of an entity. (XEP-0080: User Location)
-
- Example <geoloc> stanzas:
- <geoloc xmlns='http://jabber.org/protocol/geoloc'/>
-
- <geoloc xmlns='http://jabber.org/protocol/geoloc' xml:lang='en'>
- <accuracy>20</accuracy>
- <country>Italy</country>
- <lat>45.44</lat>
- <locality>Venice</locality>
- <lon>12.33</lon>
- </geoloc>
-
- Stanza Interface:
- accuracy -- Horizontal GPS error in meters.
- alt -- Altitude in meters above or below sea level.
- area -- A named area such as a campus or neighborhood.
- bearing -- GPS bearing (direction in which the entity is
- heading to reach its next waypoint), measured in
- decimal degrees relative to true north.
- building -- A specific building on a street or in an area.
- country -- The nation where the user is located.
- countrycode -- The ISO 3166 two-letter country code.
- datum -- GPS datum.
- description -- A natural-language name for or description of
- the location.
- error -- Horizontal GPS error in arc minutes. Obsoleted by
- the accuracy parameter.
- floor -- A particular floor in a building.
- lat -- Latitude in decimal degrees North.
- locality -- A locality within the administrative region, such
- as a town or city.
- lon -- Longitude in decimal degrees East.
- postalcode -- A code used for postal delivery.
- region -- An administrative region of the nation, such
- as a state or province.
- room -- A particular room in a building.
- speed -- The speed at which the entity is moving,
- in meters per second.
- street -- A thoroughfare within the locality, or a crossing
- of two thoroughfares.
- text -- A catch-all element that captures any other
- information about the location.
- timestamp -- UTC timestamp specifying the moment when the
- reading was taken.
- uri -- A URI or URL pointing to information about
- the location.
- """
-
- namespace = 'http://jabber.org/protocol/geoloc'
- name = 'geoloc'
- interfaces = set(('accuracy', 'alt', 'area', 'bearing', 'building',
- 'country', 'countrycode', 'datum', 'dscription',
- 'error', 'floor', 'lat', 'locality', 'lon',
- 'postalcode', 'region', 'room', 'speed', 'street',
- 'text', 'timestamp', 'uri'))
- sub_interfaces = interfaces
- plugin_attrib = name
-
- def exception(self, e):
- """
- Override exception passback for presence.
- """
- pass
-
- def set_accuracy(self, accuracy):
- """
- Set the value of the <accuracy> element.
-
- Arguments:
- accuracy -- Horizontal GPS error in meters
- """
- self._set_sub_text('accuracy', text=str(accuracy))
- return self
-
- def get_accuracy(self):
- """
- Return the value of the <accuracy> element as an integer.
- """
- p = self._get_sub_text('accuracy')
- if not p:
- return None
- else:
- try:
- return int(p)
- except ValueError:
- return None
-
- def set_alt(self, alt):
- """
- Set the value of the <alt> element.
-
- Arguments:
- alt -- Altitude in meters above or below sea level
- """
- self._set_sub_text('alt', text=str(alt))
- return self
-
- def get_alt(self):
- """
- Return the value of the <alt> element as an integer.
- """
- p = self._get_sub_text('alt')
- if not p:
- return None
- else:
- try:
- return int(p)
- except ValueError:
- return None
-
- def set_bearing(self, bearing):
- """
- Set the value of the <bearing> element.
-
- Arguments:
- bearing -- GPS bearing (direction in which the entity is heading
- to reach its next waypoint), measured in decimal
- degrees relative to true north
- """
- self._set_sub_text('bearing', text=str(bearing))
- return self
-
- def get_bearing(self):
- """
- Return the value of the <bearing> element as a float.
- """
- p = self._get_sub_text('bearing')
- if not p:
- return None
- else:
- try:
- return float(p)
- except ValueError:
- return None
-
- def set_error(self, error):
- """
- Set the value of the <error> element.
-
- Arguments:
- error -- Horizontal GPS error in arc minutes; this
- element is deprecated in favor of <accuracy/>
- """
- self._set_sub_text('error', text=str(error))
- return self
-
- def get_error(self):
- """
- Return the value of the <error> element as a float.
- """
- p = self._get_sub_text('error')
- if not p:
- return None
- else:
- try:
- return float(p)
- except ValueError:
- return None
-
- def set_lat(self, lat):
- """
- Set the value of the <lat> element.
-
- Arguments:
- lat -- Latitude in decimal degrees North
- """
- self._set_sub_text('lat', text=str(lat))
- return self
-
- def get_lat(self):
- """
- Return the value of the <lat> element as a float.
- """
- p = self._get_sub_text('lat')
- if not p:
- return None
- else:
- try:
- return float(p)
- except ValueError:
- return None
-
- def set_lon(self, lon):
- """
- Set the value of the <lon> element.
-
- Arguments:
- lon -- Longitude in decimal degrees East
- """
- self._set_sub_text('lon', text=str(lon))
- return self
-
- def get_lon(self):
- """
- Return the value of the <lon> element as a float.
- """
- p = self._get_sub_text('lon')
- if not p:
- return None
- else:
- try:
- return float(p)
- except ValueError:
- return None
-
- def set_speed(self, speed):
- """
- Set the value of the <speed> element.
-
- Arguments:
- speed -- The speed at which the entity is moving,
- in meters per second
- """
- self._set_sub_text('speed', text=str(speed))
- return self
-
- def get_speed(self):
- """
- Return the value of the <speed> element as a float.
- """
- p = self._get_sub_text('speed')
- if not p:
- return None
- else:
- try:
- return float(p)
- except ValueError:
- return None
-
- def set_timestamp(self, timestamp):
- """
- Set the value of the <timestamp> element.
-
- Arguments:
- timestamp -- UTC timestamp specifying the moment when
- the reading was taken
- """
- self._set_sub_text('timestamp', text=str(xep_0082.datetime(timestamp)))
- return self
-
- def get_timestamp(self):
- """
- Return the value of the <timestamp> element as a DateTime.
- """
- p = self._get_sub_text('timestamp')
- if not p:
- return None
- else:
- return xep_0082.datetime(p)