/
ownership.ts
391 lines (335 loc) · 10.6 KB
/
ownership.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
import * as alt from 'alt-server';
import * as Athena from '@AthenaServer/api';
import Database from '@stuyk/ezmongodb';
/**
* A catch all handler for vehicle ownership.
*
* This checks if a player is the true owner of a vehicle.
*
* Options can be specified to check if a passenger has keys and so on and so forth.
*
* @param {alt.Player} player An alt:V Player Entity
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @param {{ includePermissions?: boolean; includeKeys?: boolean; includeAdminOverride?: boolean; preventWhileAttached?: boolean; }}
* @return {boolean}
*/
export function isOwner(
player: alt.Player,
vehicle: alt.Vehicle,
options: {
includePermissions?: boolean;
includeKeys?: boolean;
includeAdminOverride?: boolean;
includeGroupPermissions?: boolean;
preventWhileAttached?: boolean;
} = {},
): boolean {
if (Overrides.isOwner) {
return Overrides.isOwner(player, vehicle, options);
}
if (options.preventWhileAttached && vehicle.attached) {
return false;
}
if (Athena.vehicle.tempVehicles.has(vehicle)) {
return Athena.vehicle.tempVehicles.isOwner(player, vehicle);
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return false;
}
const playerData = Athena.document.character.get(player);
if (typeof playerData === 'undefined') {
return false;
}
if (options.includeAdminOverride && Athena.systems.permission.has('account', player, 'admin')) {
return true;
}
if (options.includePermissions && Athena.vehicle.ownership.hasPermission(player, vehicle)) {
console.log('has perm I guess');
return true;
}
if (options.includeKeys && Athena.vehicle.ownership.hasKeys(player, vehicle)) {
return true;
}
if (options.includeGroupPermissions && Athena.vehicle.ownership.hasGroupPermission(player, vehicle)) {
return true;
}
return data.owner === playerData._id;
}
/**
* Checks if a player's character has a matching permission for a vehicle.
*
* @param {alt.Player} player An alt:V Player Entity
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @return {boolean}
*/
export function hasPermission(player: alt.Player, vehicle: alt.Vehicle): boolean {
if (Overrides.hasPermission) {
return Overrides.hasPermission(player, vehicle);
}
if (Athena.vehicle.tempVehicles.has(vehicle)) {
return false;
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return false;
}
return Athena.systems.permission.hasOne('character', player, data.permissions);
}
/**
* It's checking if the player has a group permission for the vehicle.
*
* If both the player and the vehicle are in the same group and have at least one matching perm, vehicle access is allowed.
*
* @name hasGroupPermission
* @param {alt.Player} player
* @param {alt.Vehicle} vehicle
* @returns {boolean}
* @exports
*/
export function hasGroupPermission(player: alt.Player, vehicle: alt.Vehicle): boolean {
if (Overrides.hasGroupPermission) {
return Overrides.hasGroupPermission(player, vehicle);
}
if (Athena.vehicle.tempVehicles.has(vehicle)) {
return false;
}
const playerData = Athena.document.character.get(player);
if (typeof playerData === 'undefined') {
return false;
}
if (typeof playerData.groups === 'undefined') {
return false;
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return false;
}
if (typeof data.groups === 'undefined') {
return false;
}
const vehicleGroupNames = Object.keys(data.groups);
for (let groupName of vehicleGroupNames) {
if (!playerData.groups[groupName]) {
continue;
}
const intersections = [
...new Set(playerData.groups[groupName].filter((element) => data.groups[groupName].includes(element))),
];
if (intersections.length <= 0) {
continue;
}
return true;
}
return false;
}
/**
* Checks if a player's character has a matching permission for a vehicle.
*
*
* @param {alt.Player} player An alt:V Player Entity
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @return {boolean}
*/
export function hasKeys(player: alt.Player, vehicle: alt.Vehicle): boolean {
if (Overrides.hasKeys) {
return Overrides.hasKeys(player, vehicle);
}
if (Athena.vehicle.tempVehicles.has(vehicle)) {
return false;
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return false;
}
const playerData = Athena.document.character.get(player);
if (typeof playerData === 'undefined') {
return false;
}
return data.keys.findIndex((x) => x === playerData._id) >= 0;
}
/**
* Return the owner of a vehicle's database identifier
*
*
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @return {(string | undefined)}
*/
export function get(vehicle: alt.Vehicle): string | undefined {
if (Overrides.get) {
return Overrides.get(vehicle);
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return undefined;
}
return data.owner;
}
/**
* Return the owner of a vehicle based on player
*
*
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @return {(alt.Player | undefined)}
*/
export function getAsPlayer(vehicle: alt.Vehicle): alt.Player | undefined {
if (Overrides.getAsPlayer) {
return Overrides.getAsPlayer(vehicle);
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return undefined;
}
return Athena.getters.player.byDatabaseID(data.owner);
}
/**
* Add a character to the owned vehicle
*
*
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @param {alt.Player} player An alt:V Player Entity
* @returns {Promise<boolean>}
*/
export async function addCharacter(vehicle: alt.Vehicle, player: alt.Player): Promise<boolean>;
/**
* Add a character to the owned vehicle
*
*
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @param {string} id
* @returns {Promise<boolean>}
*/
export async function addCharacter(vehicle: alt.Vehicle, id: string): Promise<boolean>;
/**
* Add a character or player to the owned vehicle
*
*
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @param {(alt.Player | string)} playerOrId
* @returns {Promise<boolean>}
*/
export async function addCharacter(vehicle: alt.Vehicle, playerOrId: alt.Player | string): Promise<boolean> {
if (Overrides.addCharacter) {
if (playerOrId instanceof alt.Player) {
return await Overrides.addCharacter(vehicle, playerOrId);
}
return await Overrides.addCharacter(vehicle, playerOrId);
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return false;
}
let _id: string;
if (playerOrId instanceof alt.Player) {
const playerData = Athena.document.character.get(playerOrId);
if (typeof playerData === 'undefined') {
return false;
}
_id = playerData._id.toString();
}
if (typeof playerOrId === 'string') {
_id = playerOrId;
}
if (!data.keys) {
data.keys = [];
}
const index = data.keys.findIndex((x) => x === _id);
if (index <= -1) {
data.keys.push(_id);
}
return await Database.updatePartialData(
data._id.toString(),
{ keys: data.keys },
Athena.database.collections.Vehicles,
);
}
/**
* Remove a character from the owned vehicle keys.
*
*
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @param {(alt.Player | string)} playerOrId
* @returns {Promise<boolean>}
*/
export async function removeCharacter(vehicle: alt.Vehicle, _id: string): Promise<boolean> {
if (Overrides.removeCharacter) {
return Overrides.removeCharacter(vehicle, _id);
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return false;
}
if (!data.keys) {
data.keys = [];
}
const index = data.keys.findIndex((x) => x === _id);
if (index <= -1) {
return false;
}
data.keys.splice(index, 1);
return await Database.updatePartialData(
data._id.toString(),
{ keys: data.keys },
Athena.database.collections.Vehicles,
);
}
/**
* Transfer ownership of a vehicle.
*
* Assign a vehicle to a specific character id.
*
* Automatically wipes keys on transfer.
*
* Returns true if successfully transferred.
*
*
* @param {alt.Vehicle} vehicle An alt:V Vehicle Entity
* @param {string} _id
* @return {void}
*/
export async function transfer(vehicle: alt.Vehicle, _id: string): Promise<boolean> {
if (Overrides.transfer) {
return Overrides.transfer(vehicle, _id);
}
const data = Athena.document.vehicle.get(vehicle);
if (typeof data === 'undefined') {
return false;
}
data.owner = _id;
data.keys = [];
return await Database.updatePartialData(
data._id.toString(),
{ owner: data.owner, keys: data.keys },
Athena.database.collections.Vehicles,
);
}
interface VehicleOwnershipFuncs {
isOwner: typeof isOwner;
hasPermission: typeof hasPermission;
hasGroupPermission: typeof hasGroupPermission;
hasKeys: typeof hasKeys;
get: typeof get;
getAsPlayer: typeof getAsPlayer;
addCharacter: typeof addCharacter;
removeCharacter: typeof removeCharacter;
transfer: typeof transfer;
}
const Overrides: Partial<VehicleOwnershipFuncs> = {};
export function override(functionName: 'isOwner', callback: typeof isOwner);
export function override(functionName: 'hasPermission', callback: typeof hasPermission);
export function override(functionName: 'hasKeys', callback: typeof hasKeys);
export function override(functionName: 'get', callback: typeof get);
export function override(functionName: 'getAsPlayer', callback: typeof getAsPlayer);
export function override(functionName: 'addCharacter', callback: typeof addCharacter);
export function override(functionName: 'removeCharacter', callback: typeof removeCharacter);
export function override(functionName: 'transfer', callback: typeof transfer);
/**
* Used to override vehicle ownership functionality
*
*
* @param {keyof VehicleOwnershipFuncs} functionName
* @param {*} callback
*/
export function override(functionName: keyof VehicleOwnershipFuncs, callback: any): void {
Overrides[functionName] = callback;
}