//// AvatarMixerClientData.cpp// assignment-client/src/avatars//// Created by Stephen Birarda on 2/4/2014.// Copyright 2014 High Fidelity, Inc.//// Distributed under the Apache License, Version 2.0.// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html// #include "AvatarMixerClientData.h" #include <algorithm>#include <udt/PacketHeaders.h> #include <DependencyManager.h>#include <NodeList.h>#include <EntityTree.h>#include <ZoneEntityItem.h> #include "AvatarLogging.h" #include "AvatarMixerWorker.h" AvatarMixerClientData::AvatarMixerClientData(const QUuid& nodeID, Node::LocalID nodeLocalID) : NodeData(nodeID, nodeLocalID) { // in case somebody calls getSessionUUID on the AvatarData instance, make sure it has the right ID _avatar->setID(nodeID);} uint64_t AvatarMixerClientData::getLastOtherAvatarEncodeTime(NLPacket::LocalID otherAvatar) const { const auto itr = _lastOtherAvatarEncodeTime.find(otherAvatar); if (itr != _lastOtherAvatarEncodeTime.end()) { return itr->second; } return 0;} void AvatarMixerClientData::setLastOtherAvatarEncodeTime(NLPacket::LocalID otherAvatar, uint64_t time) { auto itr = _lastOtherAvatarEncodeTime.find(otherAvatar); if (itr != _lastOtherAvatarEncodeTime.end()) { itr->second = time; } else { _lastOtherAvatarEncodeTime.emplace(std::pair<NLPacket::LocalID, uint64_t>(otherAvatar, time)); }} void AvatarMixerClientData::queuePacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer node) { if (!_packetQueue.node) { _packetQueue.node = node; } _packetQueue.push(message);} int AvatarMixerClientData::processPackets(const WorkerSharedData& workerSharedData) { int packetsProcessed = 0; SharedNodePointer node = _packetQueue.node; assert(_packetQueue.empty() || node); _packetQueue.node.clear(); while (!_packetQueue.empty()) { auto& packet = _packetQueue.front(); packetsProcessed++; switch (packet->getType()) { case PacketType::AvatarData: parseData(*packet, workerSharedData); break; case PacketType::SetAvatarTraits: processSetTraitsMessage(*packet, workerSharedData, *node); break; case PacketType::BulkAvatarTraitsAck: processBulkAvatarTraitsAckMessage(*packet); break; default: Q_UNREACHABLE(); } _packetQueue.pop(); } assert(_packetQueue.empty()); return packetsProcessed;} namespace {using std::static_pointer_cast; // Operator to find if a point is within an avatar-priority (hero) Zone Entity.struct FindContainingZone { glm::vec3 position; bool isInPriorityZone { false }; float priorityZoneVolume { std::numeric_limits<float>::max() }; static bool operation(const OctreeElementPointer& element, void* extraData) { auto findContainingZone = static_cast<FindContainingZone*>(extraData); if (element->getAACube().contains(findContainingZone->position)) { const EntityTreeElementPointer entityTreeElement = static_pointer_cast<EntityTreeElement>(element); entityTreeElement->forEachEntity([&findContainingZone](EntityItemPointer item) { if (item->getType() == EntityTypes::Zone && item->contains(findContainingZone->position)) { auto zoneItem = static_pointer_cast<ZoneEntityItem>(item); auto avatarPriorityProperty = zoneItem->getAvatarPriority(); float volume = zoneItem->getVolumeEstimate(); if (avatarPriorityProperty != COMPONENT_MODE_INHERIT && volume < findContainingZone->priorityZoneVolume) { // Smaller volume wins findContainingZone->isInPriorityZone = avatarPriorityProperty == COMPONENT_MODE_ENABLED; findContainingZone->priorityZoneVolume = volume; } } }); return true; // Keep recursing } else { // Position isn't within this subspace, so end recursion. return false; } }}; } // namespace int AvatarMixerClientData::parseData(ReceivedMessage& message, const WorkerSharedData& workerSharedData) { // pull the sequence number from the data first uint16_t sequenceNumber; message.readPrimitive(&sequenceNumber); if (sequenceNumber < _lastReceivedSequenceNumber && _lastReceivedSequenceNumber != UINT16_MAX) { incrementNumOutOfOrderSends(); } _lastReceivedSequenceNumber = sequenceNumber; glm::vec3 oldPosition = _avatar->getClientGlobalPosition(); bool oldHasPriority = _avatar->getHasPriority(); // compute the offset to the data payload if (!_avatar->parseDataFromBuffer(message.readWithoutCopy(message.getBytesLeftToRead()))) { return false; } // Regardless of what the client says, restore the priority as we know it without triggering any update. _avatar->setHasPriorityWithoutTimestampReset(oldHasPriority); auto newPosition = _avatar->getClientGlobalPosition(); if (newPosition != oldPosition || _avatar->getNeedsHeroCheck()) { EntityTree& entityTree = *workerSharedData.entityTree; FindContainingZone findContainingZone{ newPosition }; entityTree.recurseTreeWithOperation(&FindContainingZone::operation, &findContainingZone); bool currentlyHasPriority = findContainingZone.isInPriorityZone; if (currentlyHasPriority != _avatar->getHasPriority()) { _avatar->setHasPriority(currentlyHasPriority); } _avatar->setNeedsHeroCheck(false); } return true;} void AvatarMixerClientData::processSetTraitsMessage(ReceivedMessage& message, const WorkerSharedData& workerSharedData, Node& sendingNode) { // Trying to read more bytes than available, bail if (message.getBytesLeftToRead() < qint64(sizeof(AvatarTraits::TraitVersion))) { qWarning() << "Refusing to process malformed traits packet from" << message.getSenderSockAddr(); return; } // pull the trait version from the message AvatarTraits::TraitVersion packetTraitVersion; message.readPrimitive(&packetTraitVersion); bool anyTraitsChanged = false; while (message.getBytesLeftToRead() > 0) { // for each trait in the packet, apply it if the trait version is newer than what we have // Trying to read more bytes than available, bail if (message.getBytesLeftToRead() < qint64(sizeof(AvatarTraits::TraitType))) { qWarning() << "Refusing to process malformed traits packet from" << message.getSenderSockAddr(); return; } AvatarTraits::TraitType traitType; message.readPrimitive(&traitType); if (AvatarTraits::isSimpleTrait(traitType)) { // Trying to read more bytes than available, bail if (message.getBytesLeftToRead() < qint64(sizeof(AvatarTraits::TraitWireSize))) { qWarning() << "Refusing to process malformed traits packet from" << message.getSenderSockAddr(); return; } AvatarTraits::TraitWireSize traitSize; message.readPrimitive(&traitSize); if (traitSize < -1 || traitSize > message.getBytesLeftToRead()) { qWarning() << "Refusing to process simple trait of size" << traitSize << "from" << message.getSenderSockAddr(); break; } if (packetTraitVersion > _lastReceivedTraitVersions[traitType]) { _avatar->processTrait(traitType, message.read(traitSize)); _lastReceivedTraitVersions[traitType] = packetTraitVersion; if (traitType == AvatarTraits::SkeletonModelURL) { // special handling for skeleton model URL, since we need to make sure it is in the allowlist checkSkeletonURLAgainstAllowlist(workerSharedData, sendingNode, packetTraitVersion); } anyTraitsChanged = true; } else { message.seek(message.getPosition() + traitSize); } } else { // Trying to read more bytes than available, bail if (message.getBytesLeftToRead() < qint64(NUM_BYTES_RFC4122_UUID + sizeof(AvatarTraits::TraitWireSize))) { qWarning() << "Refusing to process malformed traits packet from" << message.getSenderSockAddr(); return; } AvatarTraits::TraitInstanceID instanceID = QUuid::fromRfc4122(message.readWithoutCopy(NUM_BYTES_RFC4122_UUID)); AvatarTraits::TraitWireSize traitSize; message.readPrimitive(&traitSize); if (traitSize < -1 || traitSize > message.getBytesLeftToRead()) { qWarning() << "Refusing to process instanced trait of size" << traitSize << "from" << message.getSenderSockAddr(); break; } if (traitType == AvatarTraits::AvatarEntity || traitType == AvatarTraits::Grab) { auto& instanceVersionRef = _lastReceivedTraitVersions.getInstanceValueRef(traitType, instanceID); if (packetTraitVersion > instanceVersionRef) { if (traitSize == AvatarTraits::DELETED_TRAIT_SIZE) { _avatar->processDeletedTraitInstance(traitType, instanceID); // Mixer doesn't need deleted IDs. _avatar->getAndClearRecentlyRemovedIDs(); // to track a deleted instance but keep version information // the avatar mixer uses the negative value of the sent version instanceVersionRef = -packetTraitVersion; } else { // Don't accept avatar entity data for distribution unless sender has rez permissions on the domain. // The sender shouldn't be sending avatar entity data, however this provides a back-up. auto trait = message.read(traitSize); if (sendingNode.getCanRezAvatarEntities()) { _avatar->processTraitInstance(traitType, instanceID, trait); } instanceVersionRef = packetTraitVersion; } anyTraitsChanged = true; } else { message.seek(message.getPosition() + traitSize); } } else { qWarning() << "Refusing to process traits packet with instanced trait of unprocessable type from" << message.getSenderSockAddr(); break; } } } if (anyTraitsChanged) { _lastReceivedTraitsChange = std::chrono::steady_clock::now(); }} void AvatarMixerClientData::emulateDeleteEntitiesTraitsMessage(const QList<QUuid>& avatarEntityIDs) { // Emulates processSetTraitsMessage() actions on behalf of an avatar whose canRezAvatarEntities permission has been removed. // The source avatar should be removing its avatar entities. However, using this method provides a back-up. auto traitType = AvatarTraits::AvatarEntity; for (const auto& entityID : avatarEntityIDs) { auto& instanceVersionRef = _lastReceivedTraitVersions.getInstanceValueRef(traitType, entityID); _avatar->processDeletedTraitInstance(traitType, entityID); // Mixer doesn't need deleted IDs. _avatar->getAndClearRecentlyRemovedIDs(); // to track a deleted instance but keep version information // the avatar mixer uses the negative value of the sent version // Because there is no originating message from an avatar we enlarge the magnitude by 1. // If a user subsequently has canRezAvatarEntities permission granted, they will have to relog in order for their // avatar entities to be visible to others. instanceVersionRef = -instanceVersionRef - 1; } _lastReceivedTraitsChange = std::chrono::steady_clock::now();} void AvatarMixerClientData::processBulkAvatarTraitsAckMessage(ReceivedMessage& message) { // Avatar Traits flow control marks each outgoing avatar traits packet with a // sequence number. The mixer caches the traits sent in the traits packet. // Until an ack with the sequence number comes back, all updates to _traits // in that packet_ are ignored. Updates to traits not in that packet will // be sent. // Look up the avatar/trait data associated with this ack and update the 'last ack' list // with it. AvatarTraits::TraitMessageSequence seq; message.readPrimitive(&seq); auto sentAvatarTraitVersions = _perNodePendingTraitVersions.find(seq); if (sentAvatarTraitVersions != _perNodePendingTraitVersions.end()) { for (auto& perNodeTraitVersions : sentAvatarTraitVersions->second) { auto& nodeId = perNodeTraitVersions.first; auto& traitVersions = perNodeTraitVersions.second; // For each trait that was sent in the traits packet, // update the 'acked' trait version. Traits not // sent in the traits packet keep their version. // process simple traits auto simpleReceivedIt = traitVersions.simpleCBegin(); while (simpleReceivedIt != traitVersions.simpleCEnd()) { if (*simpleReceivedIt != AvatarTraits::DEFAULT_TRAIT_VERSION) { auto traitType = static_cast<AvatarTraits::TraitType>(std::distance(traitVersions.simpleCBegin(), simpleReceivedIt)); _perNodeAckedTraitVersions[nodeId][traitType] = *simpleReceivedIt; } simpleReceivedIt++; } // process instanced traits auto instancedSentIt = traitVersions.instancedCBegin(); while (instancedSentIt != traitVersions.instancedCEnd()) { auto traitType = instancedSentIt->traitType; for (auto& sentInstance : instancedSentIt->instances) { auto instanceID = sentInstance.id; const auto sentVersion = sentInstance.value; _perNodeAckedTraitVersions[nodeId].instanceInsert(traitType, instanceID, sentVersion); } instancedSentIt++; } } _perNodePendingTraitVersions.erase(sentAvatarTraitVersions); } else { // This can happen either the BulkAvatarTraits was sent with no simple traits, // or if the avatar mixer restarts while there are pending // BulkAvatarTraits messages in-flight. if (seq > getTraitsMessageSequence()) { qWarning() << "Received BulkAvatarTraitsAck with future seq (potential avatar mixer restart) " << seq << " from " << message.getSenderSockAddr(); } }} void AvatarMixerClientData::checkSkeletonURLAgainstAllowlist(const WorkerSharedData& workerSharedData, Node& sendingNode, AvatarTraits::TraitVersion traitVersion) { const auto& allowlist = workerSharedData.skeletonURLAllowlist; if (!allowlist.isEmpty()) { bool inAllowlist = false; auto avatarURL = _avatar->getSkeletonModelURL(); // The avatar is in the allowlist if: // 1. The avatar's URL's host matches one of the hosts of the URLs in the allowlist AND // 2. The avatar's URL's path starts with the path of that same URL in the allowlist for (const auto& allowListedPrefix : allowlist) { auto allowListURL = QUrl::fromUserInput(allowListedPrefix); // check if this script URL matches the allowlist domain and, optionally, is beneath the path if (avatarURL.host().compare(allowListURL.host(), Qt::CaseInsensitive) == 0 && avatarURL.path().startsWith(allowListURL.path(), Qt::CaseInsensitive)) { inAllowlist = true; break; } } if (!inAllowlist) { // make sure we're not unecessarily overriding the default avatar with the default avatar if (_avatar->getWireSafeSkeletonModelURL() != workerSharedData.skeletonReplacementURL) { // we need to change this avatar's skeleton URL, and send them a traits packet informing them of the change qDebug() << "Overwriting avatar URL" << _avatar->getWireSafeSkeletonModelURL() << "to replacement" << workerSharedData.skeletonReplacementURL << "for" << sendingNode.getUUID(); _avatar->setSkeletonModelURL(workerSharedData.skeletonReplacementURL); auto packet = NLPacket::create(PacketType::SetAvatarTraits, -1, true); // the returned set traits packet uses the trait version from the incoming packet // so the client knows they should not overwrite if they have since changed the trait AvatarTraits::packVersionedTrait(AvatarTraits::SkeletonModelURL, *packet, traitVersion, *_avatar); auto nodeList = DependencyManager::get<NodeList>(); nodeList->sendPacket(std::move(packet), sendingNode); } } }} uint64_t AvatarMixerClientData::getLastBroadcastTime(NLPacket::LocalID nodeUUID) const { // return the matching PacketSequenceNumber, or the default if we don't have it auto nodeMatch = _lastBroadcastTimes.find(nodeUUID); if (nodeMatch != _lastBroadcastTimes.end()) { return nodeMatch->second; } return 0;} uint16_t AvatarMixerClientData::getLastBroadcastSequenceNumber(NLPacket::LocalID nodeID) const { // return the matching PacketSequenceNumber, or the default if we don't have it auto nodeMatch = _lastBroadcastSequenceNumbers.find(nodeID); if (nodeMatch != _lastBroadcastSequenceNumbers.end()) { return nodeMatch->second; } return 0;} void AvatarMixerClientData::ignoreOther(SharedNodePointer self, SharedNodePointer other) { ignoreOther(self.data(), other.data());} void AvatarMixerClientData::ignoreOther(const Node* self, const Node* other) { if (!isRadiusIgnoring(other->getUUID())) { addToRadiusIgnoringSet(other->getUUID()); auto killPacket = NLPacket::create(PacketType::KillAvatar, NUM_BYTES_RFC4122_UUID + sizeof(KillAvatarReason), true); killPacket->write(other->getUUID().toRfc4122()); if (_isIgnoreRadiusEnabled) { killPacket->writePrimitive(KillAvatarReason::TheirAvatarEnteredYourBubble); } else { killPacket->writePrimitive(KillAvatarReason::YourAvatarEnteredTheirBubble); } setLastBroadcastTime(other->getLocalID(), 0); resetSentTraitData(other->getLocalID()); DependencyManager::get<NodeList>()->sendPacket(std::move(killPacket), *self); }} bool AvatarMixerClientData::isRadiusIgnoring(const QUuid& other) const { return std::find(_radiusIgnoredOthers.cbegin(), _radiusIgnoredOthers.cend(), other) != _radiusIgnoredOthers.cend();} void AvatarMixerClientData::addToRadiusIgnoringSet(const QUuid& other) { if (!isRadiusIgnoring(other)) { _radiusIgnoredOthers.push_back(other); }} void AvatarMixerClientData::removeFromRadiusIgnoringSet(const QUuid& other) { auto ignoredOtherIter = std::find(_radiusIgnoredOthers.cbegin(), _radiusIgnoredOthers.cend(), other); if (ignoredOtherIter != _radiusIgnoredOthers.cend()) { _radiusIgnoredOthers.erase(ignoredOtherIter); }} void AvatarMixerClientData::resetSentTraitData(Node::LocalID nodeLocalID) { _lastSentTraitsTimestamps[nodeLocalID] = TraitsCheckTimestamp(); _perNodeSentTraitVersions[nodeLocalID].reset(); _perNodeAckedTraitVersions[nodeLocalID].reset(); for (auto&& pendingTraitVersions : _perNodePendingTraitVersions) { pendingTraitVersions.second[nodeLocalID].reset(); }} void AvatarMixerClientData::readViewFrustumPacket(const QByteArray& message) { _currentViewFrustums.clear(); auto sourceBuffer = reinterpret_cast<const unsigned char*>(message.constData()); uint8_t numFrustums = 0; memcpy(&numFrustums, sourceBuffer, sizeof(numFrustums)); sourceBuffer += sizeof(numFrustums); for (uint8_t i = 0; i < numFrustums; ++i) { ConicalViewFrustum frustum; sourceBuffer += frustum.deserialize(sourceBuffer); _currentViewFrustums.push_back(frustum); }} bool AvatarMixerClientData::otherAvatarInView(const AABox& otherAvatarBox) { return std::any_of(std::begin(_currentViewFrustums), std::end(_currentViewFrustums), [&](const ConicalViewFrustum& viewFrustum) { return viewFrustum.intersects(otherAvatarBox); });} void AvatarMixerClientData::loadJSONStats(QJsonObject& jsonObject) const { jsonObject["display_name"] = _avatar->getDisplayName(); jsonObject["num_avs_sent_last_frame"] = _numAvatarsSentLastFrame; jsonObject["avg_other_av_starves_per_second"] = getAvgNumOtherAvatarStarvesPerSecond(); jsonObject["avg_other_av_skips_per_second"] = getAvgNumOtherAvatarSkipsPerSecond(); jsonObject["total_num_out_of_order_sends"] = _numOutOfOrderSends; jsonObject[OUTBOUND_AVATAR_DATA_STATS_KEY] = getOutboundAvatarDataKbps(); jsonObject[OUTBOUND_AVATAR_TRAITS_STATS_KEY] = getOutboundAvatarTraitsKbps(); jsonObject[INBOUND_AVATAR_DATA_STATS_KEY] = _avatar->getAverageBytesReceivedPerSecond() / (float)BYTES_PER_KILOBIT; jsonObject["av_data_receive_rate"] = _avatar->getReceiveRate(); jsonObject["recent_other_av_in_view"] = _recentOtherAvatarsInView; jsonObject["recent_other_av_out_of_view"] = _recentOtherAvatarsOutOfView;} AvatarMixerClientData::TraitsCheckTimestamp AvatarMixerClientData::getLastOtherAvatarTraitsSendPoint( Node::LocalID otherAvatar) const { auto it = _lastSentTraitsTimestamps.find(otherAvatar); if (it != _lastSentTraitsTimestamps.end()) { return it->second;Lines 1–500 of 515. Load more
// // AvatarMixerClientData.cpp // assignment-client/src/avatars // // Created by Stephen Birarda on 2/4/2014. // Copyright 2014 High Fidelity, Inc. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html // #include "AvatarMixerClientData.h" #include <algorithm> #include <udt/PacketHeaders.h> #include <DependencyManager.h> #include <NodeList.h> #include <EntityTree.h> #include <ZoneEntityItem.h> #include "AvatarLogging.h" #include "AvatarMixerWorker.h" AvatarMixerClientData::AvatarMixerClientData(const QUuid& nodeID, Node::LocalID nodeLocalID) : NodeData(nodeID, nodeLocalID) { // in case somebody calls getSessionUUID on the AvatarData instance, make sure it has the right ID _avatar->setID(nodeID); } uint64_t AvatarMixerClientData::getLastOtherAvatarEncodeTime(NLPacket::LocalID otherAvatar) const { const auto itr = _lastOtherAvatarEncodeTime.find(otherAvatar); if (itr != _lastOtherAvatarEncodeTime.end()) { return itr->second; } return 0; } void AvatarMixerClientData::setLastOtherAvatarEncodeTime(NLPacket::LocalID otherAvatar, uint64_t time) { auto itr = _lastOtherAvatarEncodeTime.find(otherAvatar); if (itr != _lastOtherAvatarEncodeTime.end()) { itr->second = time; } else { _lastOtherAvatarEncodeTime.emplace(std::pair<NLPacket::LocalID, uint64_t>(otherAvatar, time)); } } void AvatarMixerClientData::queuePacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer node) { if (!_packetQueue.node) { _packetQueue.node = node; } _packetQueue.push(message); } int AvatarMixerClientData::processPackets(const WorkerSharedData& workerSharedData) { int packetsProcessed = 0; SharedNodePointer node = _packetQueue.node; assert(_packetQueue.empty() || node); _packetQueue.node.clear(); while (!_packetQueue.empty()) { auto& packet = _packetQueue.front(); packetsProcessed++; switch (packet->getType()) { case PacketType::AvatarData: parseData(*packet, workerSharedData); break; case PacketType::SetAvatarTraits: processSetTraitsMessage(*packet, workerSharedData, *node); break; case PacketType::BulkAvatarTraitsAck: processBulkAvatarTraitsAckMessage(*packet); break; default: Q_UNREACHABLE(); } _packetQueue.pop(); } assert(_packetQueue.empty()); return packetsProcessed; } namespace { using std::static_pointer_cast; // Operator to find if a point is within an avatar-priority (hero) Zone Entity. struct FindContainingZone { glm::vec3 position; bool isInPriorityZone { false }; float priorityZoneVolume { std::numeric_limits<float>::max() }; static bool operation(const OctreeElementPointer& element, void* extraData) { auto findContainingZone = static_cast<FindContainingZone*>(extraData); if (element->getAACube().contains(findContainingZone->position)) { const EntityTreeElementPointer entityTreeElement = static_pointer_cast<EntityTreeElement>(element); entityTreeElement->forEachEntity([&findContainingZone](EntityItemPointer item) { if (item->getType() == EntityTypes::Zone && item->contains(findContainingZone->position)) { auto zoneItem = static_pointer_cast<ZoneEntityItem>(item); auto avatarPriorityProperty = zoneItem->getAvatarPriority(); float volume = zoneItem->getVolumeEstimate(); if (avatarPriorityProperty != COMPONENT_MODE_INHERIT && volume < findContainingZone->priorityZoneVolume) { // Smaller volume wins findContainingZone->isInPriorityZone = avatarPriorityProperty == COMPONENT_MODE_ENABLED; findContainingZone->priorityZoneVolume = volume; } } }); return true; // Keep recursing } else { // Position isn't within this subspace, so end recursion. return false; } } }; } // namespace int AvatarMixerClientData::parseData(ReceivedMessage& message, const WorkerSharedData& workerSharedData) { // pull the sequence number from the data first uint16_t sequenceNumber; message.readPrimitive(&sequenceNumber); if (sequenceNumber < _lastReceivedSequenceNumber && _lastReceivedSequenceNumber != UINT16_MAX) { incrementNumOutOfOrderSends(); } _lastReceivedSequenceNumber = sequenceNumber; glm::vec3 oldPosition = _avatar->getClientGlobalPosition(); bool oldHasPriority = _avatar->getHasPriority(); // compute the offset to the data payload if (!_avatar->parseDataFromBuffer(message.readWithoutCopy(message.getBytesLeftToRead()))) { return false; } // Regardless of what the client says, restore the priority as we know it without triggering any update. _avatar->setHasPriorityWithoutTimestampReset(oldHasPriority); auto newPosition = _avatar->getClientGlobalPosition(); if (newPosition != oldPosition || _avatar->getNeedsHeroCheck()) { EntityTree& entityTree = *workerSharedData.entityTree; FindContainingZone findContainingZone{ newPosition }; entityTree.recurseTreeWithOperation(&FindContainingZone::operation, &findContainingZone); bool currentlyHasPriority = findContainingZone.isInPriorityZone; if (currentlyHasPriority != _avatar->getHasPriority()) { _avatar->setHasPriority(currentlyHasPriority); } _avatar->setNeedsHeroCheck(false); } return true; } void AvatarMixerClientData::processSetTraitsMessage(ReceivedMessage& message, const WorkerSharedData& workerSharedData, Node& sendingNode) { // Trying to read more bytes than available, bail if (message.getBytesLeftToRead() < qint64(sizeof(AvatarTraits::TraitVersion))) { qWarning() << "Refusing to process malformed traits packet from" << message.getSenderSockAddr(); return; } // pull the trait version from the message AvatarTraits::TraitVersion packetTraitVersion; message.readPrimitive(&packetTraitVersion); bool anyTraitsChanged = false; while (message.getBytesLeftToRead() > 0) { // for each trait in the packet, apply it if the trait version is newer than what we have // Trying to read more bytes than available, bail if (message.getBytesLeftToRead() < qint64(sizeof(AvatarTraits::TraitType))) { qWarning() << "Refusing to process malformed traits packet from" << message.getSenderSockAddr(); return; } AvatarTraits::TraitType traitType; message.readPrimitive(&traitType); if (AvatarTraits::isSimpleTrait(traitType)) { // Trying to read more bytes than available, bail if (message.getBytesLeftToRead() < qint64(sizeof(AvatarTraits::TraitWireSize))) { qWarning() << "Refusing to process malformed traits packet from" << message.getSenderSockAddr(); return; } AvatarTraits::TraitWireSize traitSize; message.readPrimitive(&traitSize); if (traitSize < -1 || traitSize > message.getBytesLeftToRead()) { qWarning() << "Refusing to process simple trait of size" << traitSize << "from" << message.getSenderSockAddr(); break; } if (packetTraitVersion > _lastReceivedTraitVersions[traitType]) { _avatar->processTrait(traitType, message.read(traitSize)); _lastReceivedTraitVersions[traitType] = packetTraitVersion; if (traitType == AvatarTraits::SkeletonModelURL) { // special handling for skeleton model URL, since we need to make sure it is in the allowlist checkSkeletonURLAgainstAllowlist(workerSharedData, sendingNode, packetTraitVersion); } anyTraitsChanged = true; } else { message.seek(message.getPosition() + traitSize); } } else { // Trying to read more bytes than available, bail if (message.getBytesLeftToRead() < qint64(NUM_BYTES_RFC4122_UUID + sizeof(AvatarTraits::TraitWireSize))) { qWarning() << "Refusing to process malformed traits packet from" << message.getSenderSockAddr(); return; } AvatarTraits::TraitInstanceID instanceID = QUuid::fromRfc4122(message.readWithoutCopy(NUM_BYTES_RFC4122_UUID)); AvatarTraits::TraitWireSize traitSize; message.readPrimitive(&traitSize); if (traitSize < -1 || traitSize > message.getBytesLeftToRead()) { qWarning() << "Refusing to process instanced trait of size" << traitSize << "from" << message.getSenderSockAddr(); break; } if (traitType == AvatarTraits::AvatarEntity || traitType == AvatarTraits::Grab) { auto& instanceVersionRef = _lastReceivedTraitVersions.getInstanceValueRef(traitType, instanceID); if (packetTraitVersion > instanceVersionRef) { if (traitSize == AvatarTraits::DELETED_TRAIT_SIZE) { _avatar->processDeletedTraitInstance(traitType, instanceID); // Mixer doesn't need deleted IDs. _avatar->getAndClearRecentlyRemovedIDs(); // to track a deleted instance but keep version information // the avatar mixer uses the negative value of the sent version instanceVersionRef = -packetTraitVersion; } else { // Don't accept avatar entity data for distribution unless sender has rez permissions on the domain. // The sender shouldn't be sending avatar entity data, however this provides a back-up. auto trait = message.read(traitSize); if (sendingNode.getCanRezAvatarEntities()) { _avatar->processTraitInstance(traitType, instanceID, trait); } instanceVersionRef = packetTraitVersion; } anyTraitsChanged = true; } else { message.seek(message.getPosition() + traitSize); } } else { qWarning() << "Refusing to process traits packet with instanced trait of unprocessable type from" << message.getSenderSockAddr(); break; } } } if (anyTraitsChanged) { _lastReceivedTraitsChange = std::chrono::steady_clock::now(); } } void AvatarMixerClientData::emulateDeleteEntitiesTraitsMessage(const QList<QUuid>& avatarEntityIDs) { // Emulates processSetTraitsMessage() actions on behalf of an avatar whose canRezAvatarEntities permission has been removed. // The source avatar should be removing its avatar entities. However, using this method provides a back-up. auto traitType = AvatarTraits::AvatarEntity; for (const auto& entityID : avatarEntityIDs) { auto& instanceVersionRef = _lastReceivedTraitVersions.getInstanceValueRef(traitType, entityID); _avatar->processDeletedTraitInstance(traitType, entityID); // Mixer doesn't need deleted IDs. _avatar->getAndClearRecentlyRemovedIDs(); // to track a deleted instance but keep version information // the avatar mixer uses the negative value of the sent version // Because there is no originating message from an avatar we enlarge the magnitude by 1. // If a user subsequently has canRezAvatarEntities permission granted, they will have to relog in order for their // avatar entities to be visible to others. instanceVersionRef = -instanceVersionRef - 1; } _lastReceivedTraitsChange = std::chrono::steady_clock::now(); } void AvatarMixerClientData::processBulkAvatarTraitsAckMessage(ReceivedMessage& message) { // Avatar Traits flow control marks each outgoing avatar traits packet with a // sequence number. The mixer caches the traits sent in the traits packet. // Until an ack with the sequence number comes back, all updates to _traits // in that packet_ are ignored. Updates to traits not in that packet will // be sent. // Look up the avatar/trait data associated with this ack and update the 'last ack' list // with it. AvatarTraits::TraitMessageSequence seq; message.readPrimitive(&seq); auto sentAvatarTraitVersions = _perNodePendingTraitVersions.find(seq); if (sentAvatarTraitVersions != _perNodePendingTraitVersions.end()) { for (auto& perNodeTraitVersions : sentAvatarTraitVersions->second) { auto& nodeId = perNodeTraitVersions.first; auto& traitVersions = perNodeTraitVersions.second; // For each trait that was sent in the traits packet, // update the 'acked' trait version. Traits not // sent in the traits packet keep their version. // process simple traits auto simpleReceivedIt = traitVersions.simpleCBegin(); while (simpleReceivedIt != traitVersions.simpleCEnd()) { if (*simpleReceivedIt != AvatarTraits::DEFAULT_TRAIT_VERSION) { auto traitType = static_cast<AvatarTraits::TraitType>(std::distance(traitVersions.simpleCBegin(), simpleReceivedIt)); _perNodeAckedTraitVersions[nodeId][traitType] = *simpleReceivedIt; } simpleReceivedIt++; } // process instanced traits auto instancedSentIt = traitVersions.instancedCBegin(); while (instancedSentIt != traitVersions.instancedCEnd()) { auto traitType = instancedSentIt->traitType; for (auto& sentInstance : instancedSentIt->instances) { auto instanceID = sentInstance.id; const auto sentVersion = sentInstance.value; _perNodeAckedTraitVersions[nodeId].instanceInsert(traitType, instanceID, sentVersion); } instancedSentIt++; } } _perNodePendingTraitVersions.erase(sentAvatarTraitVersions); } else { // This can happen either the BulkAvatarTraits was sent with no simple traits, // or if the avatar mixer restarts while there are pending // BulkAvatarTraits messages in-flight. if (seq > getTraitsMessageSequence()) { qWarning() << "Received BulkAvatarTraitsAck with future seq (potential avatar mixer restart) " << seq << " from " << message.getSenderSockAddr(); } } } void AvatarMixerClientData::checkSkeletonURLAgainstAllowlist(const WorkerSharedData& workerSharedData, Node& sendingNode, AvatarTraits::TraitVersion traitVersion) { const auto& allowlist = workerSharedData.skeletonURLAllowlist; if (!allowlist.isEmpty()) { bool inAllowlist = false; auto avatarURL = _avatar->getSkeletonModelURL(); // The avatar is in the allowlist if: // 1. The avatar's URL's host matches one of the hosts of the URLs in the allowlist AND // 2. The avatar's URL's path starts with the path of that same URL in the allowlist for (const auto& allowListedPrefix : allowlist) { auto allowListURL = QUrl::fromUserInput(allowListedPrefix); // check if this script URL matches the allowlist domain and, optionally, is beneath the path if (avatarURL.host().compare(allowListURL.host(), Qt::CaseInsensitive) == 0 && avatarURL.path().startsWith(allowListURL.path(), Qt::CaseInsensitive)) { inAllowlist = true; break; } } if (!inAllowlist) { // make sure we're not unecessarily overriding the default avatar with the default avatar if (_avatar->getWireSafeSkeletonModelURL() != workerSharedData.skeletonReplacementURL) { // we need to change this avatar's skeleton URL, and send them a traits packet informing them of the change qDebug() << "Overwriting avatar URL" << _avatar->getWireSafeSkeletonModelURL() << "to replacement" << workerSharedData.skeletonReplacementURL << "for" << sendingNode.getUUID(); _avatar->setSkeletonModelURL(workerSharedData.skeletonReplacementURL); auto packet = NLPacket::create(PacketType::SetAvatarTraits, -1, true); // the returned set traits packet uses the trait version from the incoming packet // so the client knows they should not overwrite if they have since changed the trait AvatarTraits::packVersionedTrait(AvatarTraits::SkeletonModelURL, *packet, traitVersion, *_avatar); auto nodeList = DependencyManager::get<NodeList>(); nodeList->sendPacket(std::move(packet), sendingNode); } } } } uint64_t AvatarMixerClientData::getLastBroadcastTime(NLPacket::LocalID nodeUUID) const { // return the matching PacketSequenceNumber, or the default if we don't have it auto nodeMatch = _lastBroadcastTimes.find(nodeUUID); if (nodeMatch != _lastBroadcastTimes.end()) { return nodeMatch->second; } return 0; } uint16_t AvatarMixerClientData::getLastBroadcastSequenceNumber(NLPacket::LocalID nodeID) const { // return the matching PacketSequenceNumber, or the default if we don't have it auto nodeMatch = _lastBroadcastSequenceNumbers.find(nodeID); if (nodeMatch != _lastBroadcastSequenceNumbers.end()) { return nodeMatch->second; } return 0; } void AvatarMixerClientData::ignoreOther(SharedNodePointer self, SharedNodePointer other) { ignoreOther(self.data(), other.data()); } void AvatarMixerClientData::ignoreOther(const Node* self, const Node* other) { if (!isRadiusIgnoring(other->getUUID())) { addToRadiusIgnoringSet(other->getUUID()); auto killPacket = NLPacket::create(PacketType::KillAvatar, NUM_BYTES_RFC4122_UUID + sizeof(KillAvatarReason), true); killPacket->write(other->getUUID().toRfc4122()); if (_isIgnoreRadiusEnabled) { killPacket->writePrimitive(KillAvatarReason::TheirAvatarEnteredYourBubble); } else { killPacket->writePrimitive(KillAvatarReason::YourAvatarEnteredTheirBubble); } setLastBroadcastTime(other->getLocalID(), 0); resetSentTraitData(other->getLocalID()); DependencyManager::get<NodeList>()->sendPacket(std::move(killPacket), *self); } } bool AvatarMixerClientData::isRadiusIgnoring(const QUuid& other) const { return std::find(_radiusIgnoredOthers.cbegin(), _radiusIgnoredOthers.cend(), other) != _radiusIgnoredOthers.cend(); } void AvatarMixerClientData::addToRadiusIgnoringSet(const QUuid& other) { if (!isRadiusIgnoring(other)) { _radiusIgnoredOthers.push_back(other); } } void AvatarMixerClientData::removeFromRadiusIgnoringSet(const QUuid& other) { auto ignoredOtherIter = std::find(_radiusIgnoredOthers.cbegin(), _radiusIgnoredOthers.cend(), other); if (ignoredOtherIter != _radiusIgnoredOthers.cend()) { _radiusIgnoredOthers.erase(ignoredOtherIter); } } void AvatarMixerClientData::resetSentTraitData(Node::LocalID nodeLocalID) { _lastSentTraitsTimestamps[nodeLocalID] = TraitsCheckTimestamp(); _perNodeSentTraitVersions[nodeLocalID].reset(); _perNodeAckedTraitVersions[nodeLocalID].reset(); for (auto&& pendingTraitVersions : _perNodePendingTraitVersions) { pendingTraitVersions.second[nodeLocalID].reset(); } } void AvatarMixerClientData::readViewFrustumPacket(const QByteArray& message) { _currentViewFrustums.clear(); auto sourceBuffer = reinterpret_cast<const unsigned char*>(message.constData()); uint8_t numFrustums = 0; memcpy(&numFrustums, sourceBuffer, sizeof(numFrustums)); sourceBuffer += sizeof(numFrustums); for (uint8_t i = 0; i < numFrustums; ++i) { ConicalViewFrustum frustum; sourceBuffer += frustum.deserialize(sourceBuffer); _currentViewFrustums.push_back(frustum); } } bool AvatarMixerClientData::otherAvatarInView(const AABox& otherAvatarBox) { return std::any_of(std::begin(_currentViewFrustums), std::end(_currentViewFrustums), [&](const ConicalViewFrustum& viewFrustum) { return viewFrustum.intersects(otherAvatarBox); }); } void AvatarMixerClientData::loadJSONStats(QJsonObject& jsonObject) const { jsonObject["display_name"] = _avatar->getDisplayName(); jsonObject["num_avs_sent_last_frame"] = _numAvatarsSentLastFrame; jsonObject["avg_other_av_starves_per_second"] = getAvgNumOtherAvatarStarvesPerSecond(); jsonObject["avg_other_av_skips_per_second"] = getAvgNumOtherAvatarSkipsPerSecond(); jsonObject["total_num_out_of_order_sends"] = _numOutOfOrderSends; jsonObject[OUTBOUND_AVATAR_DATA_STATS_KEY] = getOutboundAvatarDataKbps(); jsonObject[OUTBOUND_AVATAR_TRAITS_STATS_KEY] = getOutboundAvatarTraitsKbps(); jsonObject[INBOUND_AVATAR_DATA_STATS_KEY] = _avatar->getAverageBytesReceivedPerSecond() / (float)BYTES_PER_KILOBIT; jsonObject["av_data_receive_rate"] = _avatar->getReceiveRate(); jsonObject["recent_other_av_in_view"] = _recentOtherAvatarsInView; jsonObject["recent_other_av_out_of_view"] = _recentOtherAvatarsOutOfView; } AvatarMixerClientData::TraitsCheckTimestamp AvatarMixerClientData::getLastOtherAvatarTraitsSendPoint( Node::LocalID otherAvatar) const { auto it = _lastSentTraitsTimestamps.find(otherAvatar); if (it != _lastSentTraitsTimestamps.end()) { return it->second;