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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
#
# (C) Copyright 2003-2010 Jacek Konieczny <jajcus@jajcus.net>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License Version
# 2.1 as published by the Free Software Foundation.
#
# 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
"""Delayed delivery mark (jabber:x:delay) handling.
Normative reference:
- `JEP 91 <http://www.jabber.org/jeps/jep-0091.html>`__
"""
__docformat__="restructuredtext en"
import libxml2
import time
import datetime
from pyxmpp.jid import JID
from pyxmpp.utils import to_utf8,from_utf8
from pyxmpp.xmlextra import get_node_ns_uri
from pyxmpp.utils import datetime_utc_to_local,datetime_local_to_utc
from pyxmpp.objects import StanzaPayloadObject
from pyxmpp.exceptions import BadRequestProtocolError, JIDMalformedProtocolError, JIDError
DELAY_NS="jabber:x:delay"
class Delay(StanzaPayloadObject):
"""
Delayed delivery tag.
Represents 'jabber:x:delay' (JEP-0091) element of a Jabber stanza.
:Ivariables:
- `delay_from`: the "from" value of the delay element
- `reason`: the "reason" (content) of the delay element
- `timestamp`: the UTC timestamp as naive datetime object
"""
xml_element_name = "x"
xml_element_namespace = DELAY_NS
def __init__(self,node_or_datetime,delay_from=None,reason=None,utc=True):
"""
Initialize the Delay object.
:Parameters:
- `node_or_datetime`: an XML node to parse or the timestamp.
- `delay_from`: JID of the entity which adds the delay mark
(when `node_or_datetime` is a timestamp).
- `reason`: reason of the delay (when `node_or_datetime` is a
timestamp).
- `utc`: if `True` then the timestamp is assumed to be UTC,
otherwise it is assumed to be local time.
:Types:
- `node_or_datetime`: `libxml2.xmlNode` or `datetime.datetime`
- `delay_from`: `pyxmpp.JID`
- `reason`: `unicode`
- `utc`: `bool`"""
if isinstance(node_or_datetime,libxml2.xmlNode):
self.from_xml(node_or_datetime)
else:
if utc:
self.timestamp=node_or_datetime
else:
self.timestamp=datetime_local_to_utc(node_or_datetime)
self.delay_from=JID(delay_from)
self.reason=unicode(reason)
def from_xml(self,xmlnode):
"""Initialize Delay object from an XML node.
:Parameters:
- `xmlnode`: the jabber:x:delay XML element.
:Types:
- `xmlnode`: `libxml2.xmlNode`"""
if xmlnode.type!="element":
raise ValueError,"XML node is not a jabber:x:delay element (not an element)"
ns=get_node_ns_uri(xmlnode)
if ns and ns!=DELAY_NS or xmlnode.name!="x":
raise ValueError,"XML node is not a jabber:x:delay element"
stamp=xmlnode.prop("stamp")
if stamp.endswith("Z"):
stamp=stamp[:-1]
if "-" in stamp:
stamp=stamp.split("-",1)[0]
try:
tm = time.strptime(stamp, "%Y%m%dT%H:%M:%S")
except ValueError:
raise BadRequestProtocolError, "Bad timestamp"
tm=tm[0:8]+(0,)
self.timestamp=datetime.datetime.fromtimestamp(time.mktime(tm))
delay_from=from_utf8(xmlnode.prop("from"))
if delay_from:
try:
self.delay_from = JID(delay_from)
except JIDError:
raise JIDMalformedProtocolError, "Bad JID in the jabber:x:delay 'from' attribute"
else:
self.delay_from = None
self.reason = from_utf8(xmlnode.getContent())
def complete_xml_element(self, xmlnode, _unused):
"""Complete the XML node with `self` content.
Should be overriden in classes derived from `StanzaPayloadObject`.
:Parameters:
- `xmlnode`: XML node with the element being built. It has already
right name and namespace, but no attributes or content.
- `_unused`: document to which the element belongs.
:Types:
- `xmlnode`: `libxml2.xmlNode`
- `_unused`: `libxml2.xmlDoc`"""
tm=self.timestamp.strftime("%Y%m%dT%H:%M:%S")
xmlnode.setProp("stamp",tm)
if self.delay_from:
xmlnode.setProp("from",self.delay_from.as_utf8())
if self.reason:
xmlnode.setContent(to_utf8(self.reason))
def get_datetime_local(self):
"""Get the timestamp as a local time.
:return: the timestamp of the delay element represented in the local
timezone.
:returntype: `datetime.datetime`"""
r=datetime_utc_to_local(self.timestamp)
return r
def get_datetime_utc(self):
"""Get the timestamp as a UTC.
:return: the timestamp of the delay element represented in UTC.
:returntype: `datetime.datetime`"""
return self.timestamp
def __str__(self):
n=self.as_xml()
r=n.serialize()
n.freeNode()
return r
def __cmp__(self,other):
return cmp(timestamp, other.timestamp)
def get_delays(stanza):
"""Get jabber:x:delay elements from the stanza.
:Parameters:
- `stanza`: a, probably delayed, stanza.
:Types:
- `stanza`: `pyxmpp.stanza.Stanza`
:return: list of delay tags sorted by the timestamp.
:returntype: `list` of `Delay`"""
delays=[]
n=stanza.xmlnode.children
while n:
if n.type=="element" and get_node_ns_uri(n)==DELAY_NS and n.name=="x":
delays.append(Delay(n))
n=n.next
delays.sort()
return delays
def get_delay(stanza):
"""Get the oldest jabber:x:delay elements from the stanza.
:Parameters:
- `stanza`: a, probably delayed, stanza.
:Types:
- `stanza`: `pyxmpp.stanza.Stanza`
The return value, if not `None`, contains a quite reliable
timestamp of a delayed (e.g. from offline storage) message.
:return: the oldest delay tag of the stanza or `None`.
:returntype: `Delay`"""
delays=get_delays(stanza)
if not delays:
return None
return get_delays(stanza)[0]
# vi: sts=4 et sw=4
|
