// ---------------------------------------------------------------------------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 // Copyright © 2012-2018 Miranda NG team // // 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: // // Manages Avatar connection, provides internal service for handling avatars // ----------------------------------------------------------------------------- #include "stdafx.h" #include "m_folders.h" BYTE hashEmptyAvatar[9] = {0x00, 0x01, 0x00, 0x05, 0x02, 0x01, 0xD2, 0x04, 0x72}; avatars_request::avatars_request(int type) { this->type = type; } avatars_request::~avatars_request() { if (this) { switch (type) { case ART_UPLOAD: SAFE_FREE((void**)&pData); break; case ART_GET: SAFE_FREE((void**)&hash); SAFE_FREE(&szFile); break; case ART_BLOCK: break; } } } wchar_t* CIcqProto::GetOwnAvatarFileName() { DBVARIANT dbvFile = {DBVT_DELETED}; if (getWString(NULL, "AvatarFile", &dbvFile)) return nullptr; wchar_t tmp[MAX_PATH * 2]; PathToAbsoluteW(dbvFile.ptszVal, tmp); db_free(&dbvFile); return null_strdup(tmp); } void CIcqProto::GetFullAvatarFileName(int dwUin, const char *szUid, int dwFormat, wchar_t *pszDest, size_t cbLen) { GetAvatarFileName(dwUin, szUid, pszDest, cbLen); AddAvatarExt(dwFormat, pszDest); } void CIcqProto::GetAvatarFileName(int dwUin, const char *szUid, wchar_t *pszDest, size_t cbLen) { wchar_t szPath[MAX_PATH * 2]; mir_snwprintf(szPath, L"%s\\%S\\", VARSW(L"%miranda_avatarcache%"), m_szModuleName); FOLDERSGETDATA fgd = { sizeof(fgd) }; fgd.nMaxPathSize = _countof(szPath); fgd.szPathT = szPath; fgd.flags = FF_TCHAR; // fill the destination mir_wstrncpy(pszDest, szPath, cbLen - 1); size_t tPathLen = mir_wstrlen(pszDest); // make sure the avatar cache directory exists CreateDirectoryTreeW(szPath); if (dwUin != 0) _ltow(dwUin, pszDest + tPathLen, 10); else if (szUid) { wchar_t* p = mir_a2u(szUid); mir_wstrcpy(pszDest + tPathLen, p); mir_free(p); } else { wchar_t szBuf[MAX_PATH]; if (Profile_GetNameW(MAX_PATH, szBuf)) mir_wstrcpy(pszDest + tPathLen, L"avatar"); else { wchar_t *szLastDot = wcsrchr(szBuf, '.'); if (szLastDot) szLastDot[0] = '\0'; mir_wstrcpy(pszDest + tPathLen, szBuf); mir_wstrcat(pszDest + tPathLen, L"_avt"); } } } void AddAvatarExt(int dwFormat, wchar_t *pszDest) { const wchar_t *ext = ProtoGetAvatarExtension(dwFormat); mir_wstrcat(pszDest, (*ext == 0) ? L".dat" : ext); } #define MD5_BLOCK_SIZE 1024*1024 /* use 1MB blocks */ BYTE* calcMD5HashOfFile(const wchar_t *tszFile) { BYTE *res = nullptr; HANDLE hFile = nullptr, hMap = nullptr; if ((hFile = CreateFile(tszFile, GENERIC_READ, FILE_SHARE_READ, nullptr, OPEN_EXISTING, 0, nullptr)) != INVALID_HANDLE_VALUE) { if ((hMap = CreateFileMapping(hFile, nullptr, PAGE_READONLY, 0, 0, nullptr)) != nullptr) { long cbFileSize = GetFileSize(hFile, nullptr); res = (BYTE*)SAFE_MALLOC(16 * sizeof(BYTE)); if (cbFileSize != 0 && res) { mir_md5_state_t state; BYTE digest[16]; int dwOffset = 0; mir_md5_init(&state); while (dwOffset < cbFileSize) { BYTE *ppMap = nullptr; int dwBlockSize = min(MD5_BLOCK_SIZE, cbFileSize - dwOffset); if (!(ppMap = (BYTE*)MapViewOfFile(hMap, FILE_MAP_READ, 0, dwOffset, dwBlockSize))) break; mir_md5_append(&state, (const BYTE *)ppMap, dwBlockSize); UnmapViewOfFile(ppMap); dwOffset += dwBlockSize; } mir_md5_finish(&state, digest); memcpy(res, digest, 16 * sizeof(BYTE)); } } if (hMap != nullptr) CloseHandle(hMap); if (hFile != nullptr) CloseHandle(hFile); } return res; } int CIcqProto::IsAvatarChanged(MCONTACT hContact, const BYTE *pHash, size_t nHashLen) { DBVARIANT dbvSaved = { 0 }; if (getSetting(hContact, "AvatarSaved", &dbvSaved)) return 1; // saved Avatar hash is missing // are the hashes different? int ret = (dbvSaved.cpbVal != nHashLen || memcmp(dbvSaved.pbVal, pHash, nHashLen)) ? 2 : 0; db_free(&dbvSaved); return ret; } void CIcqProto::StartAvatarThread(HNETLIBCONN hConn, char *cookie, size_t cookieLen) // called from event { if (!hConn) { mir_cslock l(m_avatarsMutex); // place avatars lock if (m_avatarsConnection && m_avatarsConnection->isPending()) { debugLogA("Avatar, Multiple start thread attempt, ignored."); SAFE_FREE((void**)&cookie); return; } debugLogA("Avatars: Connection failed"); m_avatarsConnectionPending = FALSE; // check if any upload request are waiting in the queue int bYet = 0; auto T = m_arAvatars.rev_iter(); for (auto &it : T) { if (it->type == ART_UPLOAD) { // we found it, return error if (!bYet) { icq_LogMessage(LOG_WARNING, LPGEN("Error uploading avatar to server, server temporarily unavailable.")); bYet = 1; } // remove upload request from queue delete it; m_arAvatars.remove(T.indexOf(&it)); } } SAFE_FREE((void**)&cookie); return; } mir_cslock l(m_avatarsMutex); if (m_avatarsConnection && m_avatarsConnection->isPending()) { debugLogA("Avatar, Multiple start thread attempt, ignored."); NetLib_CloseConnection(&hConn, false); SAFE_FREE((void**)&cookie); return; } if (m_avatarsConnection) m_avatarsConnection->closeConnection(); m_avatarsConnection = new avatars_server_connection(this, hConn, cookie, cookieLen); // the old connection should not be used anymore // connection object created, remove the connection request pending flag m_avatarsConnectionPending = false; } void CIcqProto::StopAvatarThread() { mir_cslock l(m_avatarsMutex); // the connection is about to close if (m_avatarsConnection) m_avatarsConnection->shutdownConnection(); // make the thread stop } // handle Owner's avatar hash changes void CIcqProto::handleAvatarOwnerHash(BYTE bFlags, BYTE *pData, size_t nDataLen) { if (nDataLen < 0x14 || !m_bAvatarsEnabled) return; switch (bFlags) { case 1: // our avatar is on the server setSettingBlob(NULL, "AvatarHash", pData, 0x14); /// TODO: properly handle multiple avatar items (more formats) setUserInfo(); { // here we need to find a file, check its hash, if invalid get avatar from server wchar_t *file = GetOwnAvatarFileName(); if (!file) { // we have no avatar file, download from server debugLogA("We have no avatar, requesting from server."); wchar_t szFile[MAX_PATH * 2 + 4]; GetAvatarFileName(0, nullptr, szFile, MAX_PATH * 2); GetAvatarData(NULL, m_dwLocalUIN, nullptr, pData, 0x14, szFile); } else { // we know avatar filename BYTE *hash = calcMD5HashOfFile(file); if (!hash) { // hash could not be calculated - probably missing file, get avatar from server debugLogA("We have no avatar, requesting from server."); wchar_t szFile[MAX_PATH * 2 + 4]; GetAvatarFileName(0, nullptr, szFile, MAX_PATH * 2); GetAvatarData(NULL, m_dwLocalUIN, nullptr, pData, 0x14, szFile); } // check if we had set any avatar if yes set our, if not download from server else if (memcmp(hash, pData + 4, 0x10)) { // we have different avatar, sync that if (m_bSsiEnabled && getByte("ForceOurAvatar", 1)) { // we want our avatar, update hash DWORD dwPaFormat = ::ProtoGetAvatarFileFormat(file); BYTE pHash[0x14]; debugLogA("Our avatar is different, setting our new hash."); pHash[0] = 0; pHash[1] = dwPaFormat == PA_FORMAT_XML ? AVATAR_HASH_FLASH : AVATAR_HASH_STATIC; pHash[2] = 1; // state of the hash pHash[3] = 0x10; // len of the hash memcpy((pHash + 4), hash, 0x10); updateServAvatarHash(pHash, 0x14); } else { // get avatar from server debugLogA("We have different avatar, requesting new from server."); wchar_t tszFile[MAX_PATH * 2 + 4]; GetAvatarFileName(0, nullptr, tszFile, MAX_PATH * 2); GetAvatarData(NULL, m_dwLocalUIN, nullptr, pData, 0x14, tszFile); } } SAFE_FREE((void**)&hash); SAFE_FREE(&file); } } break; case 0x41: // request to upload avatar data case 0x81: // request to re-upload avatar data if (m_bSsiEnabled) { // we could not change serv-list if it is disabled... wchar_t *file = GetOwnAvatarFileName(); if (!file) { // we have no file to upload, remove hash from server debugLogA("We do not have avatar, removing hash."); SetMyAvatar(0, 0); break; } DWORD dwPaFormat = ::ProtoGetAvatarFileFormat(file); BYTE *hash = calcMD5HashOfFile(file); if (!hash) { // the hash could not be calculated, remove from server debugLogA("We could not obtain hash, removing hash."); SetMyAvatar(0, 0); } else if (!memcmp(hash, pData + 4, 0x10)) { // we have the right file HANDLE hFile = nullptr, hMap = nullptr; BYTE *ppMap = nullptr; long cbFileSize = 0; debugLogA("Uploading our avatar data."); if ((hFile = CreateFile(file, GENERIC_READ, FILE_SHARE_READ, nullptr, OPEN_EXISTING, 0, nullptr)) != INVALID_HANDLE_VALUE) if ((hMap = CreateFileMapping(hFile, nullptr, PAGE_READONLY, 0, 0, nullptr)) != nullptr) if ((ppMap = (BYTE*)MapViewOfFile(hMap, FILE_MAP_READ, 0, 0, 0)) != nullptr) cbFileSize = GetFileSize(hFile, nullptr); if (cbFileSize != 0) SetAvatarData(NULL, (WORD)(dwPaFormat == PA_FORMAT_XML ? AVATAR_HASH_FLASH : AVATAR_HASH_STATIC), ppMap, cbFileSize); if (ppMap != nullptr) UnmapViewOfFile(ppMap); if (hMap != nullptr) CloseHandle(hMap); if (hFile != nullptr) CloseHandle(hFile); SAFE_FREE((void**)&hash); } else { BYTE pHash[0x14]; debugLogA("Our file is different, set our new hash."); pHash[0] = 0; pHash[1] = dwPaFormat == PA_FORMAT_XML ? AVATAR_HASH_FLASH : AVATAR_HASH_STATIC; pHash[2] = 1; // state of the hash pHash[3] = 0x10; // len of the hash memcpy((pHash + 4), hash, 0x10); updateServAvatarHash(pHash, 0x14); SAFE_FREE((void**)&hash); } SAFE_FREE(&file); } break; default: debugLogA("Received UNKNOWN Avatar Status."); } } // handle Contact's avatar hash void CIcqProto::handleAvatarContactHash(DWORD dwUIN, char *szUID, MCONTACT hContact, BYTE *pHash, size_t nHashLen) { int bJob = FALSE; BOOL avatarInfoPresent = FALSE; int avatarType = -1; BYTE *pAvatarHash = nullptr; size_t cbAvatarHash = 0; BYTE emptyItem[0x10] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }; if (!m_bAvatarsEnabled || nHashLen < 4) return; // only if enabled while (nHashLen >= 4) { // parse online message items one by one WORD itemType = pHash[0] << 8 | pHash[1]; size_t itemLen = pHash[3]; // just some validity check if (itemLen + 4 > nHashLen) itemLen = nHashLen - 4; if (itemLen && memcmp(pHash + 4, emptyItem, itemLen > 0x10 ? 0x10 : itemLen)) { // Item types // 0000: AIM mini avatar // 0001: AIM/ICQ avatar ID/hash (len 5 or 16 bytes) // 0002: iChat online message // 0008: ICQ Flash avatar hash (16 bytes) // 0009: iTunes music store link // 000C: ICQ contact photo (16 bytes) // 000D: Last update time of online message // 000E: Status mood if (itemType == AVATAR_HASH_MINI && itemLen == 0x05 && avatarType == -1) { // mini avatar pAvatarHash = pHash; cbAvatarHash = itemLen + 4; avatarType = itemType; } else if (itemType == AVATAR_HASH_STATIC && (itemLen == 0x05 || itemLen == 0x10) && (avatarType == -1 || avatarType == AVATAR_HASH_MINI)) { // normal avatar pAvatarHash = pHash; cbAvatarHash = itemLen + 4; avatarType = itemType; } else if (itemType == AVATAR_HASH_FLASH && itemLen == 0x10 && (avatarType == -1 || avatarType == AVATAR_HASH_MINI || avatarType == AVATAR_HASH_STATIC)) { // flash avatar pAvatarHash = pHash; cbAvatarHash = itemLen + 4; avatarType = itemType; } else if (itemType == AVATAR_HASH_PHOTO && itemLen == 0x10) { // big avatar (ICQ 6+) pAvatarHash = pHash; cbAvatarHash = itemLen + 4; avatarType = itemType; } } else if ((itemLen == 0) && (itemType == AVATAR_HASH_MINI || itemType == AVATAR_HASH_STATIC || itemType == AVATAR_HASH_FLASH || itemType == AVATAR_HASH_PHOTO)) // empty item - indicating that avatar of that type was removed avatarInfoPresent = TRUE; pHash += itemLen + 4; nHashLen -= itemLen + 4; } if (avatarType != -1) { // check settings, should we request avatar immediatelly? DBVARIANT dbv = { DBVT_DELETED }; wchar_t tszAvatar[MAX_PATH * 2 + 4]; BYTE bAutoLoad = getByte("AvatarsAutoLoad", DEFAULT_LOAD_AVATARS); if ((avatarType == AVATAR_HASH_STATIC || avatarType == AVATAR_HASH_MINI) && cbAvatarHash == 0x09 && !memcmp(pAvatarHash + 4, hashEmptyAvatar + 4, 0x05)) { // empty avatar - unlink image, clear hash if (!getSetting(hContact, "AvatarHash", &dbv)) { // contact had avatar, clear hash, notify UI db_free(&dbv); debugLogA("%s has removed Avatar.", strUID(dwUIN, szUID)); delSetting(hContact, "AvatarHash"); ProtoBroadcastAck(hContact, ACKTYPE_AVATAR, ACKRESULT_STATUS, nullptr, 0); } else debugLogA("%s has empty Avatar.", strUID(dwUIN, szUID)); return; } if (getSetting(hContact, "AvatarHash", &dbv)) { // we did not find old avatar hash, i.e. get new avatar int avatarState = IsAvatarChanged(hContact, pAvatarHash, cbAvatarHash); // check saved hash and file, if equal only store hash if (!avatarState) { // hashes are the same int dwPaFormat = getByte(hContact, "AvatarType", PA_FORMAT_UNKNOWN); GetFullAvatarFileName(dwUIN, szUID, dwPaFormat, tszAvatar, MAX_PATH * 2); if (_waccess(tszAvatar, 0) == 0) { // the file is there, link to contactphoto, save hash debugLogA("%s has published Avatar. Image was found in the cache.", strUID(dwUIN, szUID)); setSettingBlob(hContact, "AvatarHash", pAvatarHash, cbAvatarHash); ProtoBroadcastAck(hContact, ACKTYPE_AVATAR, ACKRESULT_STATUS, nullptr, 0); } else { // the file was lost, request avatar again debugLogA("%s has published Avatar.", strUID(dwUIN, szUID)); bJob = TRUE; } } else { // the hash is not the one we want, request avatar debugLogA("%s has published a new Avatar.", strUID(dwUIN, szUID)); bJob = TRUE; } } else { // we found hash check if it changed or not if ((dbv.cpbVal != cbAvatarHash) || memcmp(dbv.pbVal, pAvatarHash, cbAvatarHash)) { // the hash is different, request new avatar debugLogA("%s has changed Avatar.", strUID(dwUIN, szUID)); bJob = TRUE; } else { // the hash was not changed, check if we have the correct file int avatarState = IsAvatarChanged(hContact, pAvatarHash, cbAvatarHash); // we should have file, check if the file really exists if (!avatarState) { int dwPaFormat = getByte(hContact, "AvatarType", PA_FORMAT_UNKNOWN); if (dwPaFormat == PA_FORMAT_UNKNOWN) { // we do not know the format, get avatar again debugLogA("%s has Avatar. Image is missing.", strUID(dwUIN, szUID)); bJob = 2; } else { GetFullAvatarFileName(dwUIN, szUID, dwPaFormat, tszAvatar, MAX_PATH * 2); if (_waccess(tszAvatar, 0) != 0) { // the file was lost, get it again debugLogA("%s has Avatar. Image is missing.", strUID(dwUIN, szUID)); bJob = 2; } else debugLogA("%s has Avatar. Image was found in the cache.", strUID(dwUIN, szUID)); } } else { // the hash is not the one we want, request avatar debugLogA("%s has Avatar. Image was not retrieved yet.", strUID(dwUIN, szUID)); bJob = 2; } } db_free(&dbv); } if (bJob) { if (bJob == TRUE) { // Remove possible block - hash changed, try again. mir_cslock l(m_avatarsMutex); for (auto &it : m_arAvatars) { if (it->hContact == hContact && it->type == ART_BLOCK) { // found one, remove delete it; m_arAvatars.removeItem(&it); break; } } } setSettingBlob(hContact, "AvatarHash", pAvatarHash, cbAvatarHash); ProtoBroadcastAck(hContact, ACKTYPE_AVATAR, ACKRESULT_STATUS, nullptr, 0); if (bAutoLoad) { // auto-load is on, so request the avatar now, otherwise we are done GetAvatarFileName(dwUIN, szUID, tszAvatar, MAX_PATH * 2); GetAvatarData(hContact, dwUIN, szUID, pAvatarHash, cbAvatarHash, tszAvatar); } // avatar request sent or added to queue } } else if (avatarInfoPresent) { // hash was not found, clear the hash DBVARIANT dbv = { DBVT_DELETED }; if (!getSetting(hContact, "AvatarHash", &dbv)) { // contact had avatar, clear hash, notify UI db_free(&dbv); debugLogA("%s has removed Avatar.", strUID(dwUIN, szUID)); delSetting(hContact, "AvatarHash"); ProtoBroadcastAck(hContact, ACKTYPE_AVATAR, ACKRESULT_STATUS, nullptr, 0); } else debugLogA("%s has no Avatar.", strUID(dwUIN, szUID)); } } // request avatar data from server int CIcqProto::GetAvatarData(MCONTACT hContact, DWORD dwUin, const char *szUid, const BYTE *hash, size_t hashlen, const wchar_t *file) { uid_str szUidData; char *pszUid = nullptr; if (!dwUin && szUid) { // create a copy in local writable buffer mir_strcpy(szUidData, szUid); pszUid = szUidData; } mir_cslockfull alck(m_avatarsMutex); if (m_avatarsConnection && m_avatarsConnection->isReady()) { // check if we are ready // check if requests for this user are not blocked auto T = m_arAvatars.rev_iter(); for (auto &ar : T) { if (ar->hContact == hContact && ar->type == ART_BLOCK) { // found a block item if (GetTickCount() > ar->timeOut) { // remove timeouted block delete ar; m_arAvatars.remove(T.indexOf(&ar)); continue; } debugLogA("Avatars: Requests for %s avatar are blocked.", strUID(dwUin, pszUid)); return 0; } } mir_cslock l(m_avatarsConnection->getLock()); alck.unlock(); DWORD dwCookie = m_avatarsConnection->sendGetAvatarRequest(hContact, dwUin, pszUid, hash, hashlen, file); if (dwCookie) // return now if the request was sent successfully return dwCookie; alck.lock(); } // we failed to send request, or avatar thread not ready // check if any request for this user is not already in the queue auto T = m_arAvatars.rev_iter(); for (auto &ar : T) { if (ar->hContact == hContact) { // we found it, return error if (ar->type == ART_BLOCK && GetTickCount() > ar->timeOut) { // remove timeouted block delete ar; m_arAvatars.remove(T.indexOf(&ar)); continue; } alck.unlock(); debugLogA("Avatars: Ignoring duplicate get %s avatar request.", strUID(dwUin, pszUid)); // make sure avatar connection is in progress requestAvatarConnection(); return 0; } } // add request to queue, processed after successful login avatars_request *ar = new avatars_request(ART_GET); // get avatar ar->hContact = hContact; ar->dwUin = dwUin; if (!dwUin) mir_strcpy(ar->szUid, szUid); ar->hash = (BYTE*)SAFE_MALLOC(hashlen); if (!ar->hash) { // alloc failed delete ar; return 0; } memcpy(ar->hash, hash, hashlen); // copy the data ar->hashlen = hashlen; ar->szFile = null_strdup(file); // duplicate the string m_arAvatars.insert(ar); alck.unlock(); debugLogA("Avatars: Request to get %s image added to queue.", strUID(dwUin, pszUid)); // make sure avatar connection is in progress requestAvatarConnection(); return -1; // we added to queue } // upload avatar data to server int CIcqProto::SetAvatarData(MCONTACT hContact, WORD wRef, const BYTE *data, size_t datalen) { mir_cslockfull alck(m_avatarsMutex); if (m_avatarsConnection && m_avatarsConnection->isReady()) { // check if we are ready mir_cslock l(m_avatarsConnection->getLock()); alck.unlock(); DWORD dwCookie = m_avatarsConnection->sendUploadAvatarRequest(hContact, wRef, data, datalen); if (dwCookie) // return now if the request was sent successfully return dwCookie; alck.lock(); } // we failed to send request, or avatar thread not ready // check if any request for this user is not already in the queue for (auto ar : m_arAvatars) { if (ar->hContact == hContact && ar->type == ART_UPLOAD) { // we found it, return error alck.unlock(); debugLogA("Avatars: Ignoring duplicate upload avatar request."); // make sure avatar connection is in progress requestAvatarConnection(); return 0; } } // add request to queue, processed after successful login avatars_request *ar = new avatars_request(ART_UPLOAD); // upload avatar ar->hContact = hContact; ar->pData = (BYTE*)SAFE_MALLOC(datalen); if (!ar->pData) { // alloc failed delete ar; return 0; } memcpy(ar->pData, data, datalen); // copy the data ar->cbData = datalen; ar->wRef = wRef; m_arAvatars.insert(ar); alck.unlock(); debugLogA("Avatars: Request to upload image added to queue."); // make sure avatar connection is in progress requestAvatarConnection(); return -1; // we added to queue } void CIcqProto::requestAvatarConnection() { mir_cslockfull alck(m_avatarsMutex); if (!m_avatarsConnectionPending && (!m_avatarsConnection || (!m_avatarsConnection->isPending() && !m_avatarsConnection->isReady()))) { // avatar connection is not pending, request new one m_avatarsConnectionPending = TRUE; alck.unlock(); icq_requestnewfamily(ICQ_AVATAR_FAMILY, &CIcqProto::StartAvatarThread); } } void __cdecl CIcqProto::AvatarThread(avatars_server_connection *pInfo) { debugLogA("%s thread started.", "Avatar"); Thread_SetName("ICQ: AvatarThread"); // Execute connection handler pInfo->connectionThread(); { // Remove connection reference mir_cslock l(m_avatarsMutex); if (m_avatarsConnection == pInfo) m_avatarsConnection = nullptr; // Release connection handler delete pInfo; } debugLogA("%s thread ended.", "Avatar"); } avatars_server_connection::avatars_server_connection(CIcqProto *_ppro, HNETLIBCONN _hConnection, char *_pCookie, size_t _wCookieLen) : isLoggedIn(false), stopThread(false), isActive(false), ppro(_ppro), pCookie(_pCookie), wCookieLen(_wCookieLen), hConnection(_hConnection) { // Initialize packet sequence wLocalSequence = generate_flap_sequence(); // Create connection thread ppro->ForkThread((CIcqProto::MyThreadFunc)&CIcqProto::AvatarThread, this); } avatars_server_connection::~avatars_server_connection() { delete m_rates; } void avatars_server_connection::closeConnection() { stopThread = TRUE; mir_cslock l(localSeqMutex); if (hConnection) { Netlib_CloseHandle(hConnection); hConnection = nullptr; } } void avatars_server_connection::shutdownConnection() { stopThread = TRUE; mir_cslock l(localSeqMutex); if (hConnection) Netlib_Shutdown(hConnection); } DWORD avatars_server_connection::sendGetAvatarRequest(MCONTACT hContact, DWORD dwUin, char *szUid, const BYTE *hash, size_t hashlen, const wchar_t *file) { DWORD dwNow = GetTickCount(); mir_cslockfull alck(ppro->m_avatarsMutex); for (int i = 0; i < runCount;) { // look for timeouted requests if (runTime[i] < dwNow) { // found outdated, remove runContact[i] = runContact[runCount - 1]; runTime[i] = runTime[runCount - 1]; runCount--; } else i++; } for (int i = 0; i < runCount; i++) { if (runContact[i] == hContact) { ppro->debugLogA("Ignoring duplicate get %s image request.", strUID(dwUin, szUid)); return -1; // Success: request ignored } } if (runCount < 4) { // 4 concurent requests at most int bSendNow = TRUE; { // rate management mir_cslock l(m_ratesMutex); WORD wGroup = m_rates->getGroupFromSNAC(ICQ_AVATAR_FAMILY, ICQ_AVATAR_GET_REQUEST); if (m_rates->getNextRateLevel(wGroup) < m_rates->getLimitLevel(wGroup, RML_ALERT)) { // we will be over quota if we send the request now, add to queue instead bSendNow = FALSE; ppro->debugLogA("Rates: Delay avatar request."); } } if (bSendNow) { runContact[runCount] = hContact; runTime[runCount] = GetTickCount() + 30000; // 30sec to complete request runCount++; alck.unlock(); int nUinLen = getUIDLen(dwUin, szUid); cookie_avatar *ack = (cookie_avatar*)SAFE_MALLOC(sizeof(cookie_avatar)); if (!ack) return 0; // Failure: out of memory ack->dwUin = 1; //dwUin; // I should be damned for this - only to identify get request ack->hContact = hContact; ack->hash = (BYTE*)SAFE_MALLOC(hashlen); memcpy(ack->hash, hash, hashlen); // copy the data ack->hashlen = hashlen; ack->szFile = null_strdup(file); // duplicate the string DWORD dwCookie = ppro->AllocateCookie(CKT_AVATAR, ICQ_AVATAR_GET_REQUEST, hContact, ack); icq_packet packet; serverPacketInit(&packet, 12 + nUinLen + hashlen); packFNACHeader(&packet, ICQ_AVATAR_FAMILY, ICQ_AVATAR_GET_REQUEST, 0, dwCookie); packUID(&packet, dwUin, szUid); packByte(&packet, 1); // unknown, probably type of request: 1 = get icon :) packBuffer(&packet, hash, hashlen); if (sendServerPacket(&packet)) { ppro->debugLogA("Request to get %s image sent.", strUID(dwUin, szUid)); return dwCookie; } ppro->FreeCookie(dwCookie); // sending failed, free resources SAFE_FREE(&ack->szFile); SAFE_FREE((void**)&ack->hash); SAFE_FREE((void**)&ack); } } return 0; // Failure } DWORD avatars_server_connection::sendUploadAvatarRequest(MCONTACT hContact, WORD wRef, const BYTE *data, size_t datalen) { cookie_avatar *ack = (cookie_avatar*)SAFE_MALLOC(sizeof(cookie_avatar)); if (!ack) return 0; // Failure: out of memory ack->hContact = hContact; DWORD dwCookie = ppro->AllocateCookie(CKT_AVATAR, ICQ_AVATAR_UPLOAD_REQUEST, 0, ack); icq_packet packet; serverPacketInit(&packet, 14 + datalen); packFNACHeader(&packet, ICQ_AVATAR_FAMILY, ICQ_AVATAR_UPLOAD_REQUEST, 0, dwCookie); packWord(&packet, wRef); // unknown, probably reference packWord(&packet, (WORD)datalen); packBuffer(&packet, data, datalen); if (sendServerPacket(&packet)) { ppro->debugLogA("Upload image packet sent."); return dwCookie; } ppro->ReleaseCookie(dwCookie); // failed to send, free resources return 0; } void avatars_server_connection::checkRequestQueue() { mir_cslockfull alck(ppro->m_avatarsMutex); while (ppro->m_arAvatars.getCount() && runCount < 3) { // pick up an request and send it - happens immediatelly after login // do not fill queue to top, leave one place free avatars_request *pRequest = ppro->m_arAvatars[0]; { // rate management mir_cslock l(m_ratesMutex); WORD wGroup = m_rates->getGroupFromSNAC(ICQ_AVATAR_FAMILY, (WORD)(pRequest->type == ART_UPLOAD ? ICQ_AVATAR_GET_REQUEST : ICQ_AVATAR_UPLOAD_REQUEST)); // we are over rate, leave queue and wait if (m_rates->getNextRateLevel(wGroup) < m_rates->getLimitLevel(wGroup, RML_ALERT)) break; } if (pRequest->type == ART_BLOCK) { // block contact processing auto T = ppro->m_arAvatars.rev_iter(); for (auto &ar : T) { if (GetTickCount() > ar->timeOut) { // expired contact block, remove delete ar; ppro->m_arAvatars.remove(T.indexOf(&ar)); } } return; // end processing } ppro->m_arAvatars.remove(int(0)); alck.unlock(); switch (pRequest->type) { case ART_GET: // get avatar sendGetAvatarRequest(pRequest->hContact, pRequest->dwUin, pRequest->szUid, pRequest->hash, pRequest->hashlen, pRequest->szFile); break; case ART_UPLOAD: // set avatar sendUploadAvatarRequest(pRequest->hContact, pRequest->wRef, pRequest->pData, pRequest->cbData); break; } delete pRequest; alck.lock(); } } void avatars_server_connection::connectionThread() { // This is the "infinite" loop that receives the packets from the ICQ avatar server DWORD dwLastKeepAlive = time(nullptr) + KEEPALIVE_INTERVAL; hPacketRecver = Netlib_CreatePacketReceiver(hConnection, 65536); NETLIBPACKETRECVER packetRecv = {}; packetRecv.dwTimeout = 1000; // timeout - for stopThread to work while (!stopThread) { int recvResult = Netlib_GetMorePackets(hPacketRecver, &packetRecv); if (recvResult == 0) { ppro->debugLogA("Clean closure of avatar socket"); break; } if (recvResult == SOCKET_ERROR) { if (GetLastError() == ERROR_TIMEOUT) { // timeout, check if we should be still running if (Miranda_IsTerminated()) break; if (time(nullptr) >= dwLastKeepAlive) { // limit frequency (HACK: on some systems select() does not work well) if (!ppro->m_bGatewayMode && ppro->getByte("KeepAlive", DEFAULT_KEEPALIVE_ENABLED)) { // send keep-alive packet icq_packet packet; packet.wLen = 0; write_flap(&packet, ICQ_PING_CHAN); sendServerPacket(&packet); } dwLastKeepAlive = time(nullptr) + KEEPALIVE_INTERVAL; } // check if we got something to request checkRequestQueue(); continue; } if (!stopThread) ppro->debugLogA("Avatar socket closed abortively, error: %d", GetLastError()); else ppro->debugLogA("Avatar socket gracefully closed."); break; } // Deal with the packet packetRecv.bytesUsed = handleServerPackets(packetRecv.buffer, packetRecv.bytesAvailable); if (isActive && (packetRecv.bytesAvailable == packetRecv.bytesUsed)) // no packets pending checkRequestQueue(); // process request queue } { // release connection mir_cslock l(localSeqMutex); NetLib_SafeCloseHandle(&hPacketRecver); // Close the packet receiver NetLib_CloseConnection(&hConnection, FALSE); // Close the connection } { // release rates mir_cslock l(m_ratesMutex); delete m_rates; m_rates = nullptr; } SAFE_FREE((void**)&pCookie); } int avatars_server_connection::sendServerPacket(icq_packet *pPacket) { int lResult = 0; // This critsec makes sure that the sequence order doesn't get screwed up mir_cslock l(localSeqMutex); if (hConnection) { // :IMPORTANT: // The FLAP sequence must be a WORD. When it reaches 0xFFFF it should wrap to // 0x0000, otherwise we'll get kicked by server. wLocalSequence++; // Pack sequence number pPacket->pData[2] = ((wLocalSequence & 0xff00) >> 8); pPacket->pData[3] = (wLocalSequence & 0x00ff); int nSendResult; for (int nRetries = 3; nRetries >= 0; nRetries--) { nSendResult = Netlib_Send(hConnection, (const char*)pPacket->pData, (int)pPacket->wLen, 0); if (nSendResult != SOCKET_ERROR) break; Sleep(1000); } // Send error if (nSendResult == SOCKET_ERROR) // thread stops automatically ppro->debugLogA("Your connection with the ICQ avatar server was abortively closed"); else { lResult = 1; // packet sent successfully mir_cslock rlck(m_ratesMutex); if (m_rates) m_rates->packetSent(pPacket); } } else ppro->debugLogA("Error: Failed to send packet (no connection)"); SAFE_FREE((void**)&pPacket->pData); return lResult; } int avatars_server_connection::handleServerPackets(BYTE *buf, size_t buflen) { BYTE channel; WORD sequence; size_t datalen, bytesUsed = 0; while (buflen > 0) { // All FLAPS begin with 0x2a if (*buf++ != FLAP_MARKER) break; if (buflen < 6) break; unpackByte(&buf, &channel); unpackWord(&buf, &sequence); unpackWord(&buf, &datalen); if (buflen < 6 + datalen) break; ppro->debugLogA("Server FLAP: Channel %u, Seq %u, Length %u bytes", channel, sequence, datalen); switch (channel) { case ICQ_LOGIN_CHAN: handleLoginChannel(buf); break; case ICQ_DATA_CHAN: handleDataChannel(buf, datalen); break; default: ppro->debugLogA("Warning: Unhandled Server FLAP Channel: Channel %u, Seq %u, Length %u bytes", channel, sequence, datalen); break; } /* Increase pointers so we can check for more FLAPs */ buf += datalen; buflen -= (datalen + 6); bytesUsed += (datalen + 6); } return (int)bytesUsed; } void avatars_server_connection::handleLoginChannel(BYTE *buf) { if (*(DWORD*)buf == 0x1000000) { // here check if we received SRV_HELLO wLocalSequence = generate_flap_sequence(); icq_packet packet; serverCookieInit(&packet, (LPBYTE)pCookie, wCookieLen); sendServerPacket(&packet); ppro->debugLogA("Sent CLI_IDENT to %s", "avatar server"); SAFE_FREE((void**)&pCookie); wCookieLen = 0; } else ppro->debugLogA("Invalid Server response, Channel 1."); } void avatars_server_connection::handleDataChannel(BYTE *buf, size_t datalen) { snac_header snacHeader = {0}; if (!unpackSnacHeader(&snacHeader, &buf, &datalen) || !snacHeader.bValid) ppro->debugLogA("Error: Failed to parse SNAC header"); else { if (snacHeader.wFlags & 0x8000) ppro->debugLogA(" Received SNAC(x%02X,x%02X), version %u", snacHeader.wFamily, snacHeader.wSubtype, snacHeader.wVersion); else ppro->debugLogA(" Received SNAC(x%02X,x%02X)", snacHeader.wFamily, snacHeader.wSubtype); switch (snacHeader.wFamily) { case ICQ_SERVICE_FAMILY: handleServiceFam(buf, datalen, &snacHeader); break; case ICQ_AVATAR_FAMILY: handleAvatarFam(buf, datalen, &snacHeader); break; default: ppro->debugLogA("Ignoring SNAC(x%02X,x%02X) - FAMILYx%02X not implemented", snacHeader.wFamily, snacHeader.wSubtype, snacHeader.wFamily); break; } } } void avatars_server_connection::handleServiceFam(BYTE *pBuffer, size_t wBufferLength, snac_header *pSnacHeader) { icq_packet packet; switch (pSnacHeader->wSubtype) { case ICQ_SERVER_READY: ppro->debugLogA("Server is ready and is requesting my Family versions"); ppro->debugLogA("Sending my Families"); // Miranda mimics the behaviour of Icq5 serverPacketInit(&packet, 18); packFNACHeader(&packet, ICQ_SERVICE_FAMILY, ICQ_CLIENT_FAMILIES); packDWord(&packet, 0x00010004); packDWord(&packet, 0x00100001); sendServerPacket(&packet); break; case ICQ_SERVER_FAMILIES2: /* This is a reply to CLI_FAMILIES and it tells the client which families and their versions that this server understands. * We send a rate request packet */ ppro->debugLogA("Server told me his Family versions"); ppro->debugLogA("Requesting Rate Information"); serverPacketInit(&packet, 10); packFNACHeader(&packet, ICQ_SERVICE_FAMILY, ICQ_CLIENT_REQ_RATE_INFO); sendServerPacket(&packet); break; case ICQ_SERVER_RATE_INFO: ppro->debugLogA("Server sent Rate Info"); /* init rates management */ m_rates = new rates(ppro, pBuffer, wBufferLength); /* ack rate levels */ ppro->debugLogA("Sending Rate Info Ack"); m_rates->initAckPacket(&packet); sendServerPacket(&packet); // send cli_ready serverPacketInit(&packet, 26); packFNACHeader(&packet, ICQ_SERVICE_FAMILY, ICQ_CLIENT_READY); packDWord(&packet, 0x00010004); // mimic ICQ 6 packDWord(&packet, 0x0010164f); packDWord(&packet, 0x00100001); packDWord(&packet, 0x0010164f); sendServerPacket(&packet); isActive = TRUE; // we are ready to process requests isLoggedIn = TRUE; ppro->debugLogA(" *** Yeehah, login sequence complete"); break; default: ppro->debugLogA("Warning: Ignoring SNAC(x%02x,x%02x) - Unknown SNAC (Flags: %u, Ref: %u)", ICQ_SERVICE_FAMILY, pSnacHeader->wSubtype, pSnacHeader->wFlags, pSnacHeader->dwRef); break; } } void avatars_server_connection::handleAvatarFam(BYTE *pBuffer, size_t wBufferLength, snac_header *pSnacHeader) { cookie_avatar *pCookieData; switch (pSnacHeader->wSubtype) { case ICQ_AVATAR_GET_REPLY: // received avatar data, store to file // handle new avatar, notify if (ppro->FindCookie(pSnacHeader->dwRef, nullptr, (void**)&pCookieData)) { BYTE bResult; { // remove from active request list mir_cslock l(ppro->m_avatarsMutex); for (int i = 0; i < runCount; i++) { // look for our record if (runContact[i] == pCookieData->hContact) { // found, remove runContact[i] = runContact[runCount - 1]; runTime[i] = runTime[runCount - 1]; runCount--; break; } } } PROTO_AVATAR_INFORMATION ai = { 0 }; ai.format = PA_FORMAT_JPEG; // this is for error only ai.hContact = pCookieData->hContact; mir_wstrncpy(ai.filename, pCookieData->szFile, _countof(ai.filename)); AddAvatarExt(PA_FORMAT_JPEG, ai.filename); ppro->FreeCookie(pSnacHeader->dwRef); BYTE len; unpackByte(&pBuffer, &len); if (wBufferLength < ((pCookieData->hashlen) << 1) + 4 + len) { ppro->debugLogA("Received invalid avatar reply."); ppro->ProtoBroadcastAck(pCookieData->hContact, ACKTYPE_AVATAR, ACKRESULT_FAILED, (HANDLE)&ai, 0); SAFE_FREE(&pCookieData->szFile); SAFE_FREE((void**)&pCookieData->hash); SAFE_FREE((void**)&pCookieData); break; } pBuffer += len; pBuffer += pCookieData->hashlen; unpackByte(&pBuffer, &bResult); pBuffer += pCookieData->hashlen; size_t datalen; unpackWord(&pBuffer, &datalen); wBufferLength -= 4 + len + (pCookieData->hashlen << 1); if (datalen > wBufferLength) { datalen = wBufferLength; ppro->debugLogA("Avatar reply broken, trying to do my best."); } if (datalen > 4) { // store to file... int aValid = 1; if (pCookieData->hashlen == 0x14 && pCookieData->hash[3] == 0x10 && ppro->getByte("StrictAvatarCheck", DEFAULT_AVATARS_CHECK)) { // check only standard hashes mir_md5_state_t state; BYTE digest[16]; mir_md5_init(&state); mir_md5_append(&state, (const BYTE *)pBuffer, (int)datalen); mir_md5_finish(&state, digest); // check if received data corresponds to specified hash if (memcmp(pCookieData->hash + 4, digest, 0x10)) aValid = 0; } if (aValid) { ppro->debugLogA("Received user avatar, storing (%d bytes).", datalen); const wchar_t *ptszExt; int dwPaFormat = ProtoGetBufferFormat(pBuffer, &ptszExt); wchar_t tszImageFile[MAX_PATH]; mir_snwprintf(tszImageFile, L"%s%s", pCookieData->szFile, ptszExt); ppro->setByte(pCookieData->hContact, "AvatarType", (BYTE)dwPaFormat); ai.format = dwPaFormat; // set the format mir_wstrncpy(ai.filename, tszImageFile, _countof(ai.filename)); int out = _wopen(tszImageFile, _O_BINARY | _O_CREAT | _O_TRUNC | _O_WRONLY, _S_IREAD | _S_IWRITE); if (out != -1) { _write(out, pBuffer, (int)datalen); _close(out); if (!pCookieData->hContact) { // our avatar, set filename wchar_t tmp[MAX_PATH * 2]; PathToRelativeW(tszImageFile, tmp); ppro->setWString(NULL, "AvatarFile", tmp); } else { // contact's avatar set hash DBVARIANT dbv = { DBVT_DELETED }; if (!ppro->getSetting(pCookieData->hContact, "AvatarHash", &dbv)) { if (ppro->setSettingBlob(pCookieData->hContact, "AvatarSaved", dbv.pbVal, dbv.cpbVal)) ppro->debugLogA("Failed to set file hash."); db_free(&dbv); } else { ppro->debugLogA("Warning: DB error (no hash in DB)."); // the hash was lost, try to fix that if (ppro->setSettingBlob(pCookieData->hContact, "AvatarSaved", pCookieData->hash, (int)pCookieData->hashlen) || ppro->setSettingBlob(pCookieData->hContact, "AvatarHash", pCookieData->hash, (int)pCookieData->hashlen)) { ppro->debugLogA("Failed to save avatar hash to DB"); } } } ppro->ProtoBroadcastAck(pCookieData->hContact, ACKTYPE_AVATAR, ACKRESULT_SUCCESS, (HANDLE)&ai, 0); } } else { // avatar is broken ppro->debugLogA("Error: Avatar data does not match avatar hash, ignoring."); if (pCookieData->hContact) { avatars_request *ar = new avatars_request(ART_BLOCK); ar->hContact = pCookieData->hContact; ar->timeOut = GetTickCount() + 14400000; // do not allow re-request four hours mir_cslock l(ppro->m_avatarsMutex); ppro->m_arAvatars.insert(ar); } ppro->ProtoBroadcastAck(pCookieData->hContact, ACKTYPE_AVATAR, ACKRESULT_FAILED, (HANDLE)&ai, 0); } } else { // the avatar is empty ppro->debugLogA("Received empty avatar, nothing written (error 0x%x).", bResult); ppro->ProtoBroadcastAck(pCookieData->hContact, ACKTYPE_AVATAR, ACKRESULT_FAILED, (HANDLE)&ai, 0); } SAFE_FREE(&pCookieData->szFile); SAFE_FREE((void**)&pCookieData->hash); SAFE_FREE((void**)&pCookieData); } else ppro->debugLogA("Warning: Received unexpected Avatar Reply SNAC(x10,x07)."); break; case ICQ_AVATAR_UPLOAD_ACK: // upload completed, notify BYTE res; unpackByte(&pBuffer, &res); if (!res && (wBufferLength == 0x15)) { if (ppro->FindCookie(pSnacHeader->dwRef, nullptr, (void**)&pCookieData)) // here we store the local hash ppro->ReleaseCookie(pSnacHeader->dwRef); else ppro->debugLogA("Warning: Received unexpected Upload Avatar Reply SNAC(x10,x03)."); } else if (res) { ppro->debugLogA("Error uploading avatar to server, #%d", res); ppro->icq_LogMessage(LOG_WARNING, LPGEN("Error uploading avatar to server, server refused to accept the image.")); } else ppro->debugLogA("Received invalid upload avatar ack."); break; case ICQ_ERROR: if (ppro->FindCookie(pSnacHeader->dwRef, nullptr, (void**)&pCookieData)) { if (pCookieData->dwUin) { ppro->debugLogA("Error: Avatar request failed"); SAFE_FREE(&pCookieData->szFile); SAFE_FREE((void**)&pCookieData->hash); } else ppro->debugLogA("Error: Avatar upload failed"); ppro->ReleaseCookie(pSnacHeader->dwRef); } WORD wError; if (wBufferLength >= 2) unpackWord(&pBuffer, &wError); else wError = 0; ppro->LogFamilyError(ICQ_AVATAR_FAMILY, wError); break; default: ppro->debugLogA("Warning: Ignoring SNAC(x%02x,x%02x) - Unknown SNAC (Flags: %u, Ref: %u)", ICQ_AVATAR_FAMILY, pSnacHeader->wSubtype, pSnacHeader->wFlags, pSnacHeader->dwRef); break; } }