Files
node-metaverse/lib/classes/EventQueueClient.ts
2025-06-19 17:49:02 +01:00

637 lines
37 KiB
TypeScript

import type { ClientEvents } from './ClientEvents';
import type { Agent } from './Agent';
import type { Caps } from './Caps';
import { EventQueueStateChangeEvent } from '../events/EventQueueStateChangeEvent';
import { ParcelPropertiesEvent } from '../events/ParcelPropertiesEvent';
import { Vector3 } from './Vector3';
import { UUID } from './UUID';
import { TeleportEvent } from '../events/TeleportEvent';
import { TeleportEventType } from '../enums/TeleportEventType';
import { GroupChatSessionJoinEvent } from '../events/GroupChatSessionJoinEvent';
import { GroupChatEvent } from '../events/GroupChatEvent';
import { GroupChatSessionAgentListEvent } from '../events/GroupChatSessionAgentListEvent';
import { ObjectPhysicsDataEvent } from '../events/ObjectPhysicsDataEvent';
import { IPAddress } from './IPAddress';
import { BulkUpdateInventoryEvent } from '../events/BulkUpdateInventoryEvent';
import { InventoryFolder } from './InventoryFolder';
import { InventoryItem } from './InventoryItem';
import { Utils } from './Utils';
import { InventoryLibrary } from '../enums/InventoryLibrary';
import { LandStatsEvent } from '../events/LandStatsEvent';
import * as LLSD from '@caspertech/llsd';
import type { CancelableRequest, Response as GotResponse } from 'got';
import got from 'got';
import * as Long from 'long';
export class EventQueueClient
{
public caps: Caps;
public ack?: number;
public done = false;
private currentRequest?: CancelableRequest<GotResponse<string>> = undefined;
private readonly clientEvents: ClientEvents;
private readonly agent: Agent;
public constructor(agent: Agent, caps: Caps, clientEvents: ClientEvents)
{
this.agent = agent;
this.clientEvents = clientEvents;
this.caps = caps;
this.Get();
const state = new EventQueueStateChangeEvent();
state.active = true;
this.clientEvents.onEventQueueStateChange.next(state);
}
public async shutdown(): Promise<void>
{
// We must ACK any outstanding events
this.done = true;
if (this.currentRequest)
{
this.currentRequest.cancel();
delete this.currentRequest;
}
const req = {
'ack': this.ack,
'done': true
};
await this.capsPostXML('EventQueueGet', req);
const state = new EventQueueStateChangeEvent();
state.active = false;
this.clientEvents.onEventQueueStateChange.next(state);
}
public Get(): void
{
const req = {
'ack': this.ack,
'done': this.done
};
const startTime = new Date().getTime();
this.capsPostXML('EventQueueGet', req).then((data) =>
{
if (data.id)
{
this.ack = data.id;
}
else
{
this.ack = undefined;
}
try
{
if (data.events)
{
for (const event of data.events)
{
try
{
if (event.message)
{
// noinspection TsLint
switch (event.message)
{
case 'EnableSimulator':
/*
{
"body": {
"SimulatorInfo": [
{
"Handle": "AALoAAAECwA=",
"IP": "2FIqRA==",
"Port": 13029
}
]
},
"message": "EnableSimulator"
}
*/
break;
case 'BulkUpdateInventory':
{
const body = event.body;
const buie = new BulkUpdateInventoryEvent();
if (body.FolderData)
{
for (const f of body.FolderData)
{
const folderID = new UUID(f.FolderID);
if (!folderID.isZero())
{
const folder = new InventoryFolder(InventoryLibrary.Main, this.agent.inventory.main, this.agent);
folder.folderID = folderID;
folder.name = f.Name;
folder.parentID = new UUID(f.ParentID);
folder.typeDefault = parseInt(f.Type, 10);
buie.folderData.push(folder);
}
}
}
if (body.ItemData)
{
for (const i of body.ItemData)
{
const itemID = new UUID(i.ItemID);
if (!itemID.isZero())
{
const folder = this.agent.inventory.findFolder(new UUID(i.FolderID));
const item = new InventoryItem(folder ?? undefined, this.agent);
item.assetID = new UUID(i.AssetID);
item.permissions.baseMask = Utils.OctetsToUInt32BE(i.BaseMask.octets);
item.permissions.everyoneMask = Utils.OctetsToUInt32BE(i.EveryoneMask.octets);
item.permissions.groupMask = Utils.OctetsToUInt32BE(i.GroupMask.octets);
item.permissions.nextOwnerMask = Utils.OctetsToUInt32BE(i.NextOwnerMask.octets);
item.permissions.ownerMask = Utils.OctetsToUInt32BE(i.OwnerMask.octets);
item.permissions.groupOwned = i.GroupOwned;
item.permissions.creator = new UUID(i.CreatorID);
item.permissions.group = new UUID(i.GroupID);
item.permissions.owner = new UUID(i.OwnerID);
item.flags = Utils.OctetsToUInt32BE(i.Flags.octets);
item.callbackID = Utils.OctetsToUInt32BE(i.CallbackID.octets);
item.created = new Date(parseInt(i.CreationDate, 10) * 1000);
item.description = i.Description;
item.parentID = new UUID(i.FolderID);
item.inventoryType = parseInt(i.InvType, 10);
item.salePrice = parseInt(i.SalePrice, 10);
item.saleType = parseInt(i.SaleType, 10);
item.type = parseInt(i.Type, 10);
item.itemID = itemID;
item.name = i.Name;
buie.itemData.push(item);
}
}
}
this.clientEvents.onBulkUpdateInventoryEvent.next(buie);
break;
}
case 'ParcelProperties':
{
const body = event.body;
const pprop = new ParcelPropertiesEvent();
pprop.RegionDenyAgeUnverified = body.AgeVerificationBlock[0].RegionDenyAgeUnverified;
pprop.MediaDesc = body.MediaData[0].MediaDesc;
pprop.MediaHeight = body.MediaData[0].MediaHeight;
pprop.MediaLoop = body.MediaData[0].MediaLoop;
pprop.MediaType = body.MediaData[0].MediaType;
pprop.MediaWidth = body.MediaData[0].MediaWidth;
pprop.ObscureMedia = body.MediaData[0].ObscureMedia;
pprop.ObscureMusic = body.MediaData[0].ObscureMusic;
pprop.AABBMax = new Vector3([parseInt(body.ParcelData[0].AABBMax[0], 10), parseInt( body.ParcelData[0].AABBMax[1], 10), parseInt(body.ParcelData[0].AABBMax[2], 10)]);
pprop.AABBMin = new Vector3([parseInt(body.ParcelData[0].AABBMin[0], 10), parseInt(body.ParcelData[0].AABBMin[1], 10), parseInt( body.ParcelData[0].AABBMin[2], 10)]);
pprop.AnyAVSounds = body.ParcelData[0].AnyAVSounds;
pprop.Area = body.ParcelData[0].Area;
try
{
pprop.AuctionID = Buffer.from(body.ParcelData[0].AuctionID.toArray()).readUInt32BE(0);
}
catch (_ignore: unknown)
{
// TODO: Opensim glitch
}
pprop.AuthBuyerID = new UUID(String(body.ParcelData[0].AuthBuyerID));
pprop.Bitmap = Buffer.from(body.ParcelData[0].Bitmap.toArray());
pprop.Category = body.ParcelData[0].Category;
pprop.ClaimDate = body.ParcelData[0].ClaimDate;
pprop.ClaimPrice = body.ParcelData[0].ClaimPrice;
pprop.Desc = body.ParcelData[0].Desc;
pprop.GroupAVSounds = body.ParcelData[0].GroupAVSounds;
pprop.GroupID = new UUID(String(body.ParcelData[0].GroupID));
pprop.GroupPrims = body.ParcelData[0].GroupPrims;
pprop.IsGroupOwned = body.ParcelData[0].IsGroupOwned;
pprop.LandingType = body.ParcelData[0].LandingType;
pprop.LocalID = body.ParcelData[0].LocalID;
pprop.MaxPrims = body.ParcelData[0].MaxPrims;
pprop.MediaAutoScale = body.ParcelData[0].MediaAutoScale;
pprop.MediaID = new UUID(String(body.ParcelData[0].MediaID));
pprop.MediaURL = body.ParcelData[0].MediaURL;
pprop.MusicURL = body.ParcelData[0].MusicURL;
pprop.Name = body.ParcelData[0].Name;
pprop.OtherCleanTime = body.ParcelData[0].OtherCleanTime;
pprop.OtherCount = body.ParcelData[0].OtherCount;
pprop.OtherPrims = body.ParcelData[0].OtherPrims;
pprop.OwnerID = body.ParcelData[0].OwnerID;
pprop.OwnerPrims = body.ParcelData[0].OwnerPrims;
pprop.ParcelFlags = Buffer.from(body.ParcelData[0].ParcelFlags.toArray()).readUInt32BE(0);
pprop.ParcelPrimBonus = body.ParcelData[0].ParcelPrimBonus;
pprop.PassHours = body.ParcelData[0].PassHours;
pprop.PassPrice = body.ParcelData[0].PassPrice;
pprop.PublicCount = body.ParcelData[0].PublicCount;
pprop.RegionDenyAnonymous = body.ParcelData[0].RegionDenyAnonymous;
pprop.RegionDenyIdentified = body.ParcelData[0].RegionDenyIdentified;
pprop.RegionPushOverride = body.ParcelData[0].RegionPushOverride;
pprop.RegionDenyTransacted = body.ParcelData[0].RegionDenyTransacted;
pprop.RentPrice = body.ParcelData[0].RentPrice;
pprop.RequestResult = body.ParcelData[0].RequestResult;
pprop.SalePrice = body.ParcelData[0].SalePrice;
pprop.SeeAvs = body.ParcelData[0].SeeAVs;
pprop.SelectedPrims = body.ParcelData[0].SelectedPrims;
pprop.SelfCount = body.ParcelData[0].SelfCount;
pprop.SequenceID = body.ParcelData[0].SequenceID;
pprop.SimWideMaxPrims = body.ParcelData[0].SimWideMaxPrims;
pprop.SimWideTotalPrims = body.ParcelData[0].SimWideTotalPrims;
pprop.SnapSelection = body.ParcelData[0].SnapSelection;
pprop.SnapshotID = new UUID(body.ParcelData[0].SnapshotID.toString());
pprop.Status = body.ParcelData[0].Status;
pprop.TotalPrims = body.ParcelData[0].TotalPrims;
pprop.UserLocation = new Vector3([parseInt(body.ParcelData[0].UserLocation[0], 10), parseInt(body.ParcelData[0].UserLocation[1], 10), parseInt(body.ParcelData[0].UserLocation[2], 10)]);
pprop.UserLookAt = new Vector3([parseInt(body.ParcelData[0].UserLookAt[0], 10), parseInt(body.ParcelData[0].UserLookAt[1], 10), parseInt(body.ParcelData[0].UserLookAt[2], 10)]);
if (body.RegionAllowAccessBlock !== undefined && body.RegionAllowAccessBlock.length > 0)
{
// TODO: OpenSim glitch
pprop.RegionAllowAccessOverride = body.RegionAllowAccessBlock[0].RegionAllowAccessOverride;
}
this.clientEvents.onParcelPropertiesEvent.next(pprop);
break;
}
case 'AgentGroupDataUpdate':
/*
{
"body": {
"AgentData": [
{
"AgentID": "49cc9041-5c53-4c1c-8490-e6bb84cdbacd"
}
],
"GroupData": [
{
"AcceptNotices": true,
"Contribution": 0,
"GroupID": "06459c46-069f-4de1-c297-c966bd55ab91",
"GroupInsigniaID": "8dacb5c9-80bc-aae4-6a12-d792b6eb7dc4",
"GroupName": "Jez Ember Estates",
"GroupPowers": "AAAgAAQAAAA="
},
{
"AcceptNotices": true,
"Contribution": 0,
"GroupID": "539b5be0-bb18-d0ef-6c07-3326e0130aaf",
"GroupInsigniaID": "7d7d0b4a-bf5b-dc51-3869-5e0eaa6ad41d",
"GroupName": "**BOY BEARS MALL**",
"GroupPowers": "AAAIABgBAAA="
}
],
"NewGroupData": [
{
"ListInProfile": true
},
{
"ListInProfile": true
}
]
},
"message": "AgentGroupDataUpdate"
}
*/
break;
case 'AgentStateUpdate':
/*
{
"body": {
"can_modify_navmesh": true,
"has_modified_navmesh": true,
"preferences": {
"access_prefs": {
"max": "PG"
},
"default_object_perm_masks": {
"Everyone": 0,
"Group": 0,
"NextOwner": 532480
},
"god_level": 0,
"hover_height": 0,
"language": "",
"language_is_public": true
}
},
"message": "AgentStateUpdate"
}
*/
break;
case 'TeleportFailed':
{
const tpEvent = new TeleportEvent();
tpEvent.message = event.body.Info[0].Reason;
tpEvent.eventType = TeleportEventType.TeleportFailed;
tpEvent.simIP = '';
tpEvent.simPort = 0;
tpEvent.seedCapability = '';
this.clientEvents.onTeleportEvent.next(tpEvent);
break;
}
case 'ChatterBoxSessionStartReply':
{
if (event.body)
{
const gcsje = new GroupChatSessionJoinEvent();
gcsje.success = event.body.success;
if (gcsje.success)
{
gcsje.sessionID = new UUID(event.body.session_id.toString());
const added = this.agent.addChatSession(gcsje.sessionID, true);
if (!added)
{
return;
}
}
this.clientEvents.onGroupChatSessionJoin.next(gcsje);
}
break;
}
case 'ChatterBoxInvitation':
{
if (event.body?.instantmessage?.message_params?.id)
{
const messageParams = event.body.instantmessage.message_params;
const imSessionID = messageParams.id;
const groupChatEvent = new GroupChatEvent();
groupChatEvent.from = new UUID(messageParams.from_id.toString());
groupChatEvent.fromName = messageParams.from_name;
groupChatEvent.groupID = new UUID(messageParams.id.toString());
groupChatEvent.message = messageParams.message;
const requested = {
'method': 'accept invitation',
'session-id': imSessionID
};
this.caps.capsPostXML('ChatSessionRequest', requested).then((_ignore: unknown) =>
{
this.agent.addChatSession(groupChatEvent.groupID, true);
const gcsje = new GroupChatSessionJoinEvent();
gcsje.sessionID = groupChatEvent.groupID;
gcsje.success = true;
this.clientEvents.onGroupChatSessionJoin.next(gcsje);
this.clientEvents.onGroupChat.next(groupChatEvent);
this.agent.updateLastMessage(groupChatEvent.groupID);
}).catch((err: unknown) =>
{
console.error(err);
});
}
break;
}
case 'ChatterBoxSessionAgentListUpdates':
{
if (event.body)
{
if (event.body.agent_updates)
{
for (const agentUpdate of Object.keys(event.body.agent_updates))
{
const updObj = event.body.agent_updates[agentUpdate];
const gcsale = new GroupChatSessionAgentListEvent();
gcsale.agentID = new UUID(agentUpdate);
gcsale.groupID = new UUID(event.body.session_id.toString());
gcsale.canVoiceChat = false;
gcsale.isModerator = false;
gcsale.entered = (updObj.transition === 'ENTER');
if (gcsale.entered && updObj.info)
{
if (updObj.info.can_voice_chat === true)
{
gcsale.canVoiceChat = true;
}
if (updObj.info.is_moderator === true)
{
gcsale.isModerator = true;
}
}
this.clientEvents.onGroupChatAgentListUpdate.next(gcsale);
}
}
}
break;
}
case 'ObjectPhysicsProperties':
{
const objData = event.body.ObjectData;
for (const obj of objData)
{
const objPhysEvent = new ObjectPhysicsDataEvent();
objPhysEvent.localID = obj.LocalID;
objPhysEvent.density = obj.Density;
objPhysEvent.friction = obj.Friction;
objPhysEvent.gravityMultiplier = obj.GravityMultiplier;
objPhysEvent.physicsShapeType = obj.PhysicsShapeType;
objPhysEvent.restitution = obj.Restitution;
this.clientEvents.onPhysicsDataEvent.next(objPhysEvent);
}
break;
}
case 'TeleportFinish':
{
const info = event.body.Info[0];
if (info.LocationID)
{
info.LocationID = Buffer.from(info.LocationID.toArray()).readUInt32BE(0);
const regionHandleBuf = Buffer.from(info.RegionHandle.toArray());
info.RegionHandle = new Long(regionHandleBuf.readUInt32LE(0), regionHandleBuf.readUInt32LE(4), true);
info.SimIP = new IPAddress(Buffer.from(info.SimIP.toArray()), 0).toString();
info.TeleportFlags = Buffer.from(info.TeleportFlags.toArray()).readUInt32BE(0);
const tpEvent = new TeleportEvent();
tpEvent.message = '';
tpEvent.eventType = TeleportEventType.TeleportCompleted;
tpEvent.simIP = info.SimIP;
tpEvent.simPort = info.SimPort;
tpEvent.seedCapability = info.SeedCapability;
this.clientEvents.onTeleportEvent.next(tpEvent);
}
break;
}
case 'ScriptRunningReply':
{
const body = event.body.Script as {
ItemID: any,
Mono: boolean,
ObjectID: any,
Running: boolean
}[];
for(const it of body)
{
this.clientEvents.onScriptRunningReply.next({
ItemID: new UUID(it.ItemID.toString()),
Mono: it.Mono,
ObjectID: new UUID(it.ObjectID.toString()),
Running: it.Running
});
}
break;
}
case 'LandStatReply':
{
let requestData = event.body.RequestData;
if (requestData.length < 1)
{
console.error('LandStatReply invalid RequestData length');
return;
}
requestData = requestData[0];
const evt = new LandStatsEvent();
evt.totalObjects = Utils.OctetsToUInt32BE(requestData.TotalObjectCount.octets);
evt.reportType = Utils.OctetsToUInt32BE(requestData.ReportType.octets);
evt.requestFlags = Utils.OctetsToUInt32BE(requestData.RequestFlags.octets);
if (event.body.ReportData.length !== evt.totalObjects || event.body.DataExtended.length !== evt.totalObjects)
{
console.error('LandStatReply: Invalid Reportdata or DataExtended block length');
return;
}
for (let x = 0; x < evt.totalObjects; x++)
{
const report = event.body.ReportData[x];
const extended = event.body.DataExtended[x];
evt.objects.push({
position: new Vector3([report.LocationX, report.LocationY, report.LocationZ]),
ownerName: report.OwnerName,
score: report.score,
objectID: new UUID(report.TaskID.toString()),
localID: Utils.OctetsToUInt32BE(report.TaskLocalID.octets),
objectName: report.TaskName,
monoScore: extended.MonoScore,
ownerID: new UUID(extended.OwnerID.toString()),
parcelName: extended.ParcelName,
publicURLs: extended.PublicURLs,
size: extended.Size,
timestamp: Utils.OctetsToUInt32BE(extended.TimeStamp.octets)
});
}
this.clientEvents.onLandStatReplyEvent.next(evt);
break;
}
default:
console.log('Unhandled event:');
console.log(JSON.stringify(event, null, 4));
}
}
}
catch (erro)
{
console.error('Error handling cap');
console.error(erro);
}
}
}
}
catch (error)
{
console.error(error);
}
if (!this.done)
{
this.Get();
}
}).catch(() =>
{
const time = (new Date().getTime()) - startTime;
if (time > 30000)
{
// This is the normal request timeout, so reconnect immediately
if (!this.done)
{
this.Get();
}
}
else
{
if (!this.done)
{
console.error('Event queue aborted after ' + time + 'ms. Reconnecting in 5 seconds');
// Wait 5 seconds before retrying
setTimeout(() =>
{
if (!this.done)
{
this.Get();
}
}, 5000);
}
}
});
}
public async request(url: string, data: string, contentType: string): Promise<string>
{
let req: CancelableRequest<GotResponse<string>> | undefined = undefined;
try
{
req = got.post(url, {
headers: {
'Content-Length': Buffer.byteLength(data).toString(),
'Content-Type': contentType
},
body: data,
https: {
rejectUnauthorized: false,
},
timeout: 1800000 // Super long timeout
});
this.currentRequest = req;
const response = await this.currentRequest;
return response.body;
}
finally
{
if (this.currentRequest === req)
{
delete this.currentRequest;
}
}
}
public async capsPostXML(capability: string, data: any, attempt = 0): Promise<any>
{
const url = await this.caps.getCapability(capability);
const serializedData = LLSD.LLSD.formatXML(data);
const body = await this.request(url, serializedData, 'application/llsd+xml');
if (body.includes('<llsd>'))
{
return LLSD.LLSD.parseXML(body);
}
else
{
// Retry caps request three times before giving up
if (attempt < 3 && capability !== 'EventQueueGet')
{
this.capsPostXML(capability, data, ++attempt).catch((_e: unknown) =>
{
// ignore
});
return '';
}
else
{
throw new Error('Not an LLSD response, capability: ' + capability);
}
}
}
}