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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
// ---------------------------------------------------------------------------80
// ICQ plugin for Miranda Instant Messenger
// ________________________________________
//
// Copyright © 2000-2001 Richard Hughes, Roland Rabien, Tristan Van de Vreede
// Copyright © 2001-2002 Jon Keating, Richard Hughes
// Copyright © 2002-2004 Martin Öberg, Sam Kothari, Robert Rainwater
// Copyright © 2004-2010 Joe Kucera
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// -----------------------------------------------------------------------------
// DESCRIPTION:
//
// Background thread for automatic update of user details
//
// -----------------------------------------------------------------------------
#include "icqoscar.h"
// Retrieve users' info
void CIcqProto::icq_InitInfoUpdate(void)
{
// Create wait objects
hInfoQueueEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
if (hInfoQueueEvent) {
// Init mutexes
infoUpdateMutex = new icq_critical_section();
// Init list
for (int i = 0; i<LISTSIZE; i++) {
m_infoUpdateList[i].dwUin = 0;
m_infoUpdateList[i].hContact = NULL;
m_infoUpdateList[i].queued = 0;
}
ForkThread(&CIcqProto::InfoUpdateThread, 0);
}
bInfoPendingUsers = 0;
dwInfoActiveRequest = 0;
}
// Returns TRUE if user was queued
// Returns FALSE if the list was full
BOOL CIcqProto::icq_QueueUser(HANDLE hContact)
{
if ( !infoUpdateMutex )
return FALSE;
if (nInfoUserCount < LISTSIZE)
{
int i, nChecked = 0, nFirstFree = -1;
BOOL bFound = FALSE;
infoUpdateMutex->Enter();
// Check if in list
for (i = 0; (i<LISTSIZE && nChecked < nInfoUserCount); i++)
{
if (m_infoUpdateList[i].hContact)
{
nChecked++;
if (m_infoUpdateList[i].hContact == hContact)
{
bFound = TRUE;
break;
}
}
else if (nFirstFree == -1)
{
nFirstFree = i;
}
}
if (nFirstFree == -1)
nFirstFree = i;
// Add to list
if (!bFound)
{
DWORD dwUin = getContactUin(hContact);
if (dwUin)
{
m_infoUpdateList[nFirstFree].dwUin = dwUin;
m_infoUpdateList[nFirstFree].hContact = hContact;
m_infoUpdateList[nFirstFree].queued = time(NULL);
nInfoUserCount++;
#ifdef _DEBUG
debugLogA("Queued user %u, place %u, count %u", dwUin, nFirstFree, nInfoUserCount);
#endif
// Notify worker thread
if (hInfoQueueEvent && bInfoUpdateEnabled)
SetEvent(hInfoQueueEvent);
}
}
infoUpdateMutex->Leave();
return TRUE;
}
return FALSE;
}
void CIcqProto::icq_DequeueUser(DWORD dwUin)
{
if (nInfoUserCount > 0)
{
int nChecked = 0;
// Check if in list
infoUpdateMutex->Enter();
for (int i = 0; (i < LISTSIZE && nChecked < nInfoUserCount); i++)
{
if (m_infoUpdateList[i].dwUin)
{
nChecked++;
// Remove from list
if (m_infoUpdateList[i].dwUin == dwUin)
{
#ifdef _DEBUG
debugLogA("Dequeued user %u", m_infoUpdateList[i].dwUin);
#endif
m_infoUpdateList[i].dwUin = 0;
m_infoUpdateList[i].hContact = NULL;
m_infoUpdateList[i].queued = 0;
nInfoUserCount--;
break;
}
}
}
infoUpdateMutex->Leave();
}
}
void CIcqProto::icq_RescanInfoUpdate()
{
bInfoPendingUsers = 0;
/* This is here, cause we do not want to emit large number of reuqest at once,
fill queue, and let thread deal with it */
bInfoUpdateEnabled = 0; // freeze thread
// Queue all outdated users
HANDLE hContact = FindFirstContact();
while (hContact != NULL)
{
if (IsMetaInfoChanged(hContact))
{ // Queue user
if (!icq_QueueUser(hContact))
{ // The queue is full, pause queuing contacts
bInfoPendingUsers = 1;
break;
}
}
hContact = FindNextContact(hContact);
}
bInfoUpdateEnabled = TRUE;
}
void CIcqProto::icq_EnableUserLookup(BOOL bEnable)
{
bInfoUpdateEnabled = bEnable;
// Notify worker thread
if (bInfoUpdateEnabled && hInfoQueueEvent)
SetEvent(hInfoQueueEvent);
}
void __cdecl CIcqProto::InfoUpdateThread( void* )
{
int i;
DWORD dwWait = WAIT_OBJECT_0;
debugLogA("%s thread starting.", "Info-Update");
bInfoUpdateRunning = TRUE;
while (bInfoUpdateRunning)
{
if (!nInfoUserCount && bInfoPendingUsers) // whole queue processed, check if more users needs updating
icq_RescanInfoUpdate();
if (!nInfoUserCount || !bInfoUpdateEnabled || !icqOnline())
{
dwWait = WAIT_TIMEOUT;
while (bInfoUpdateRunning && dwWait == WAIT_TIMEOUT)
{ // wait for new work or until we should end
dwWait = ICQWaitForSingleObject(hInfoQueueEvent, 10000);
}
}
if (!bInfoUpdateRunning) break;
switch (dwWait) {
case WAIT_IO_COMPLETION:
// Possible shutdown in progress
break;
case WAIT_OBJECT_0:
case WAIT_TIMEOUT:
// Time to check for new users
if (!bInfoUpdateEnabled) continue; // we can't send requests now
if (nInfoUserCount && icqOnline())
{
time_t now = time(NULL);
BOOL bNotReady = FALSE, bTimeOuted = FALSE;
// Check the list, take only users that were there for at least 5sec
// wait if any user is there shorter than 5sec and not a single user is there longer than 20sec
infoUpdateMutex->Enter();
for (i = 0; i<LISTSIZE; i++)
{
if (m_infoUpdateList[i].hContact)
{
if (m_infoUpdateList[i].queued + 20 < now)
{
bTimeOuted = TRUE;
break;
}
else if (m_infoUpdateList[i].queued + 5 >= now)
bNotReady = TRUE;
}
}
infoUpdateMutex->Leave();
if (!bTimeOuted && bNotReady)
{
SleepEx(1000, TRUE);
if (!bInfoUpdateRunning)
{ // need to end as fast as possible
debugLogA("%s thread ended.", "Info-Update");
goto LBL_Exit;
}
continue;
}
if (FindCookie(dwInfoActiveRequest, NULL, NULL))
{ // only send another request, when the previous is completed
#ifdef _DEBUG
debugLogA("Info-Update: Request 0x%x still in progress.", dwInfoActiveRequest);
#endif
SleepEx(1000, TRUE);
if (!bInfoUpdateRunning)
{ // need to end as fast as possible
debugLogA("%s thread ended.", "Info-Update");
goto LBL_Exit;
}
continue;
}
#ifdef _DEBUG
debugLogA("Info-Update: Users %u in queue.", nInfoUserCount);
#endif
// Either some user is waiting long enough, or all users are ready (waited at least the minimum time)
m_ratesMutex->Enter();
if (!m_rates)
{ // we cannot send info request - icq is offline
m_ratesMutex->Leave();
break;
}
WORD wGroup = m_rates->getGroupFromSNAC(ICQ_EXTENSIONS_FAMILY, ICQ_META_CLI_REQUEST);
while (m_rates->getNextRateLevel(wGroup) < m_rates->getLimitLevel(wGroup, RML_IDLE_30))
{ // we are over rate, need to wait before sending
int nDelay = m_rates->getDelayToLimitLevel(wGroup, RML_IDLE_50);
m_ratesMutex->Leave();
#ifdef _DEBUG
debugLogA("Rates: InfoUpdate delayed %dms", nDelay);
#endif
SleepEx(nDelay, TRUE); // do not keep things locked during sleep
if (!bInfoUpdateRunning)
{ // need to end as fast as possible
debugLogA("%s thread ended.", "Info-Update");
goto LBL_Exit;
}
m_ratesMutex->Enter();
if (!m_rates) // we lost connection when we slept, go away
break;
}
if (!m_rates)
{ // we cannot send info request - icq is offline
m_ratesMutex->Leave();
break;
}
m_ratesMutex->Leave();
userinfo *hContactList[LISTSIZE];
int nListIndex = 0;
BYTE *pRequestData = NULL;
int nRequestSize = 0;
infoUpdateMutex->Enter();
for (i = 0; i<LISTSIZE; i++)
{
if (m_infoUpdateList[i].hContact)
{
// check TS again, maybe it has been updated while we slept
if (IsMetaInfoChanged(m_infoUpdateList[i].hContact))
{
if (m_infoUpdateList[i].queued + 5 < now)
{
BYTE *pItem = NULL;
int nItemSize = 0;
DBVARIANT dbv = {DBVT_DELETED};
if (!getSetting(m_infoUpdateList[i].hContact, DBSETTING_METAINFO_TOKEN, &dbv))
{ // retrieve user details using privacy token
ppackTLV(&pItem, &nItemSize, 0x96, dbv.cpbVal, dbv.pbVal);
db_free(&dbv);
}
// last updated time
ppackTLVDouble(&pItem, &nItemSize, 0x64, getSettingDouble(m_infoUpdateList[i].hContact, DBSETTING_METAINFO_TIME, 0));
ppackTLVUID(&pItem, &nItemSize, 0x32, m_infoUpdateList[i].dwUin, NULL);
ppackWord(&pRequestData, &nRequestSize, (WORD)nItemSize);
ppackBuffer(&pRequestData, &nRequestSize, nItemSize, pItem);
// take a reference
SAFE_FREE((void**)&pItem);
hContactList[nListIndex++] = &m_infoUpdateList[i];
}
}
else
{
#ifdef _DEBUG
debugLogA("Dequeued absolete user %u", m_infoUpdateList[i].dwUin);
#endif
// Dequeue user and find another one
m_infoUpdateList[i].dwUin = 0;
m_infoUpdateList[i].hContact = NULL;
nInfoUserCount--;
// continue for loop
}
}
}
#ifdef _DEBUG
debugLogA("Request info for %u user(s).", nListIndex);
#endif
if (!nListIndex)
{ // no users to request info for
infoUpdateMutex->Leave();
break;
}
if (!(dwInfoActiveRequest = sendUserInfoMultiRequest(pRequestData, nRequestSize, nListIndex)))
{ // sending data packet failed
SAFE_FREE((void**)&pRequestData);
infoUpdateMutex->Leave();
break;
}
SAFE_FREE((void**)&pRequestData);
for (i = 0; i<nListIndex; i++)
{ // Dequeue users and go back to sleep
hContactList[i]->dwUin = 0;
hContactList[i]->hContact = NULL;
hContactList[i]->queued = 0;
nInfoUserCount--;
}
infoUpdateMutex->Leave();
}
break;
default:
// Something strange happened. Exit
bInfoUpdateRunning = FALSE;
break;
}
}
debugLogA("%s thread ended.", "Info-Update");
LBL_Exit:
SAFE_DELETE(&infoUpdateMutex);
CloseHandle(hInfoQueueEvent);
}
// Clean up before exit
void CIcqProto::icq_InfoUpdateCleanup(void)
{
debugLogA("%s must die.", "Info-Update");
bInfoUpdateRunning = FALSE;
if (hInfoQueueEvent)
SetEvent(hInfoQueueEvent); // break queue loop
}
|