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
197
198
199
200
201
202
|
"""
Define the TextBuffer class
A text buffer contains a list of intermediate representations of messages
(not xml stanzas, but neither the Lines used in windows.py.
Each text buffer can be linked to multiple windows, that will be rendered
independently by their TextWins.
"""
import logging
log = logging.getLogger(__name__)
from typing import (
Dict,
List,
Optional,
TYPE_CHECKING,
Tuple,
Union,
)
from datetime import datetime
from poezio.config import config
from poezio.ui.types import Message, BaseMessage
if TYPE_CHECKING:
from poezio.windows.text_win import TextWin
class CorrectionError(Exception):
pass
class AckError(Exception):
pass
class TextBuffer:
"""
This class just keep trace of messages, in a list with various
information and attributes.
"""
def __init__(self, messages_nb_limit: Optional[int] = None) -> None:
if messages_nb_limit is None:
messages_nb_limit = config.get('max_messages_in_memory')
self._messages_nb_limit = messages_nb_limit # type: int
# Message objects
self.messages = [] # type: List[BaseMessage]
# COMPAT: Correction id -> Original message id.
self.correction_ids = {} # type: Dict[str, str]
# we keep track of one or more windows
# so we can pass the new messages to them, as they are added, so
# they (the windows) can build the lines from the new message
self._windows = [] # type: List[TextWin]
def add_window(self, win) -> None:
self._windows.append(win)
@property
def last_message(self) -> Optional[BaseMessage]:
return self.messages[-1] if self.messages else None
def add_message(self, msg: BaseMessage):
"""
Create a message and add it to the text buffer
"""
self.messages.append(msg)
while len(self.messages) > self._messages_nb_limit:
self.messages.pop(0)
ret_val = 0
show_timestamps = config.get('show_timestamps')
nick_size = config.get('max_nick_length')
for window in self._windows: # make the associated windows
# build the lines from the new message
nb = window.build_new_message(
msg,
timestamp=show_timestamps,
nick_size=nick_size)
if ret_val == 0:
ret_val = nb
top = isinstance(msg, Message) and msg.top
if window.pos != 0 and top is False:
window.scroll_up(nb)
return min(ret_val, 1)
def _find_message(self, orig_id: str) -> Tuple[str, int]:
"""
Find a message in the text buffer from its message id
"""
# When looking for a message, ensure the id doesn't appear in a
# message we've removed from our message list. If so return the index
# of the corresponding id for the original message instead.
orig_id = self.correction_ids.get(orig_id, orig_id)
for i in range(len(self.messages) - 1, -1, -1):
msg = self.messages[i]
if msg.identifier == orig_id:
return (orig_id, i)
return (orig_id, -1)
def ack_message(self, old_id: str, jid: str) -> Union[None, bool, Message]:
"""Mark a message as acked"""
return self._edit_ack(1, old_id, jid)
def nack_message(self, error: str, old_id: str,
jid: str) -> Union[None, bool, Message]:
"""Mark a message as errored"""
return self._edit_ack(-1, old_id, jid, append=error)
def _edit_ack(self, value: int, old_id: str, jid: str,
append: str = '') -> Union[None, bool, Message]:
"""
Edit the ack status of a message, and optionally
append some text.
"""
_, i = self._find_message(old_id)
if i == -1:
return None
msg = self.messages[i]
if not isinstance(msg, Message):
return None
if msg.ack == 1: # Message was already acked
return False
if msg.jid != jid:
raise AckError('Wrong JID for message id %s (was %s, expected %s)'
% (old_id, msg.jid, jid))
msg.ack = value
if append:
msg.txt += append
return msg
def modify_message(self,
txt: str,
orig_id: str,
new_id: str,
highlight: bool = False,
time: Optional[datetime] = None,
user: Optional[str] = None,
jid: Optional[str] = None) -> Message:
"""
Correct a message in a text buffer.
Version 1.1.0 of Last Message Correction (0308) added clarifications
that break the way poezio handles corrections. Instead of linking
corrections to the previous correction/message as we were doing, we
are now required to link all corrections to the original messages.
"""
orig_id, i = self._find_message(orig_id)
if i == -1:
log.debug(
'Message %s not found in text_buffer, abort replacement.',
orig_id)
raise CorrectionError("nothing to replace")
msg = self.messages[i]
if not isinstance(msg, Message):
raise CorrectionError('Wrong message type')
if msg.user and msg.user is not user:
raise CorrectionError("Different users")
elif msg.delayed:
raise CorrectionError("Delayed message")
elif not msg.user and (msg.jid is None or jid is None):
raise CorrectionError('Could not check the '
'identity of the sender')
elif not msg.user and msg.jid != jid:
raise CorrectionError(
'Messages %s and %s have not been '
'sent by the same fullJID' % (orig_id, new_id))
if not time:
time = msg.time
self.correction_ids[new_id] = orig_id
message = Message(
txt=txt,
time=time,
nickname=msg.nickname,
nick_color=msg.nick_color,
user=msg.user,
identifier=orig_id,
highlight=highlight,
old_message=msg,
revisions=msg.revisions + 1,
jid=jid)
self.messages[i] = message
log.debug('Replacing message %s with %s.', orig_id, new_id)
return message
def del_window(self, win) -> None:
self._windows.remove(win)
def __del__(self):
size = len(self.messages)
log.debug('** Deleting %s messages from textbuffer', size)
|
