1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
use crate::{comp::Alignment, uid::Uid};
use hashbrown::HashMap;
use serde::{Deserialize, Serialize};
use slab::Slab;
use specs::{storage::GenericReadStorage, Component, DerefFlaggedStorage, Join, LendJoin};
use std::iter;
use tracing::{error, warn};

// Primitive group system
// Shortcomings include:
//  - no support for more complex group structures
//  - lack of npc group integration
//  - relies on careful management of groups to maintain a valid state
//  - the possession rod could probably wreck this
//  - clients don't know which pets are theirs (could be easy to solve by
//    putting owner uid in Role::Pet)

#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
pub struct Group(u32);

// TODO: Hack
// Corresponds to Alignment::Enemy
pub const ENEMY: Group = Group(u32::MAX);
// Corresponds to Alignment::Npc | Alignment::Tame
pub const NPC: Group = Group(u32::MAX - 1);

impl Component for Group {
    type Storage = DerefFlaggedStorage<Self, specs::VecStorage<Self>>;
}

#[derive(Clone, Debug)]
pub struct GroupInfo {
    // TODO: what about enemy groups, either the leader will constantly change because they have to
    // be loaded or we create a dummy entity or this needs to be optional
    pub leader: specs::Entity,
    // Number of group members (excluding pets)
    pub num_members: u32,
    // Name of the group
    pub name: String,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum Role {
    Member,
    Pet,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ChangeNotification<E> {
    // :D
    Added(E, Role),
    // :(
    Removed(E),
    NewLeader(E),
    // Use to put in a group overwriting existing group
    NewGroup { leader: E, members: Vec<(E, Role)> },
    // No longer in a group
    NoGroup,
}
// Note: now that we are dipping into uids here consider just using
// ChangeNotification<Uid> everywhere
// Also note when the same notification is sent to multiple destinations the
// mapping might be duplicated effort
impl<E> ChangeNotification<E> {
    pub fn try_map_ref<T>(&self, f: impl Fn(&E) -> Option<T>) -> Option<ChangeNotification<T>> {
        match self {
            Self::Added(e, r) => f(e).map(|t| ChangeNotification::Added(t, *r)),
            Self::Removed(e) => f(e).map(ChangeNotification::Removed),
            Self::NewLeader(e) => f(e).map(ChangeNotification::NewLeader),
            // Note just discards members that fail map
            Self::NewGroup { leader, members } => {
                f(leader).map(|leader| ChangeNotification::NewGroup {
                    leader,
                    members: members
                        .iter()
                        .filter_map(|(e, r)| f(e).map(|t| (t, *r)))
                        .collect(),
                })
            },
            Self::NoGroup => Some(ChangeNotification::NoGroup),
        }
    }
}

type GroupsMut<'a> = specs::WriteStorage<'a, Group>;
type Alignments<'a> = specs::ReadStorage<'a, Alignment>;
type Uids<'a> = specs::ReadStorage<'a, Uid>;

#[derive(Debug, Default)]
pub struct GroupManager {
    groups: Slab<GroupInfo>,
}

// Gather list of pets of the group member
// Note: iterating through all entities here could become slow at higher entity
// counts
fn pets(
    entity: specs::Entity,
    uid: Uid,
    alignments: &Alignments,
    entities: &specs::world::EntitiesRes,
) -> Vec<specs::Entity> {
    (entities, alignments)
        .join()
        .filter_map(|(e, a)| {
            matches!(a, Alignment::Owned(owner) if *owner == uid && e != entity).then_some(e)
        })
        .collect::<Vec<_>>()
}

/// Returns list of current members of a group
pub fn members<'a>(
    group: Group,
    groups: impl Join<Type = &'a Group> + 'a,
    entities: &'a specs::world::EntitiesRes,
    alignments: &'a Alignments,
    uids: &'a Uids,
) -> impl Iterator<Item = (specs::Entity, Role)> + 'a {
    (entities, groups, alignments, uids)
        .join()
        .filter(move |&(_e, g, _a, _u)| (*g == group))
        .map(|(e, _g, a, u)| {
            (
                e,
                if matches!(a, Alignment::Owned(owner) if owner != u) {
                    Role::Pet
                } else {
                    Role::Member
                },
            )
        })
}

// TODO: optimize add/remove for massive NPC groups
impl GroupManager {
    pub fn group_info(&self, group: Group) -> Option<&GroupInfo> {
        self.groups.get(group.0 as usize)
    }

    fn group_info_mut(&mut self, group: Group) -> Option<&mut GroupInfo> {
        self.groups.get_mut(group.0 as usize)
    }

    fn create_group(&mut self, leader: specs::Entity, num_members: u32) -> Group {
        Group(self.groups.insert(GroupInfo {
            leader,
            num_members,
            name: "Group".into(),
        }) as u32)
    }

    fn remove_group(&mut self, group: Group) { self.groups.remove(group.0 as usize); }

    // Add someone to a group
    // Also used to create new groups
    pub fn add_group_member(
        &mut self,
        leader: specs::Entity,
        new_member: specs::Entity,
        entities: &specs::Entities,
        groups: &mut GroupsMut,
        alignments: &Alignments,
        uids: &Uids,
        mut notifier: impl FnMut(specs::Entity, ChangeNotification<specs::Entity>),
    ) {
        // Ensure leader is not inviting themselves
        if leader == new_member {
            warn!("Attempt to form group with leader as the only member (this is disallowed)");
            return;
        }

        // Get uid
        let new_member_uid = if let Some(uid) = uids.get(new_member) {
            *uid
        } else {
            error!("Failed to retrieve uid for the new group member");
            return;
        };

        // If new member is a member of a different group remove that
        if groups
            .get(new_member)
            .and_then(|g| self.group_info(*g))
            .is_some()
        {
            self.leave_group(
                new_member,
                groups,
                alignments,
                uids,
                entities,
                &mut notifier,
            )
        }

        let group = match groups.get(leader).copied() {
            Some(id)
                if self
                    .group_info(id)
                    .map(|info| info.leader == leader)
                    .unwrap_or(false) =>
            {
                Some(id)
            },
            // Member of an existing group can't be a leader
            // If the lead is a member of another group leave that group first
            Some(_) => {
                self.leave_group(leader, groups, alignments, uids, entities, &mut notifier);
                None
            },
            None => None,
        };

        let group = if let Some(group) = group {
            // Increment group size
            // Note: unwrap won't fail since we just retrieved the group successfully above
            self.group_info_mut(group).unwrap().num_members += 1;
            group
        } else {
            let new_group = self.create_group(leader, 2);
            // Unwrap should not fail since we just found these entities and they should
            // still exist Note: if there is an issue replace with a warn
            groups.insert(leader, new_group).unwrap();
            // Inform
            notifier(leader, ChangeNotification::NewLeader(leader));
            new_group
        };

        let new_pets = pets(new_member, new_member_uid, alignments, entities);

        // Inform
        members(group, &*groups, entities, alignments, uids).for_each(|(e, role)| match role {
            Role::Member => {
                notifier(e, ChangeNotification::Added(new_member, Role::Member));
                notifier(new_member, ChangeNotification::Added(e, Role::Member));

                new_pets.iter().for_each(|p| {
                    notifier(e, ChangeNotification::Added(*p, Role::Pet));
                })
            },
            Role::Pet => {
                notifier(new_member, ChangeNotification::Added(e, Role::Pet));
            },
        });
        notifier(new_member, ChangeNotification::NewLeader(leader));

        // Add group id for new member and pets
        // Unwrap should not fail since we just found these entities and they should
        // still exist
        // Note: if there is an issue replace with a warn
        let _ = groups.insert(new_member, group).unwrap();
        new_pets.iter().for_each(|e| {
            let _ = groups.insert(*e, group).unwrap();
        });
    }

    pub fn new_pet(
        &mut self,
        pet: specs::Entity,
        owner: specs::Entity,
        groups: &mut GroupsMut,
        entities: &specs::Entities,
        alignments: &Alignments,
        uids: &Uids,
        notifier: &mut impl FnMut(specs::Entity, ChangeNotification<specs::Entity>),
    ) {
        if !entities.is_alive(owner) {
            warn!("Tried to create new pet for non-existent owner {owner:?}");
        } else if !entities.is_alive(pet) {
            warn!("Tried to create new pet for non-existent pet {pet:?}");
        } else {
            let group = match groups.get(owner).copied() {
                Some(group) => group,
                None => {
                    let new_group = self.create_group(owner, 1);
                    // Unwrap can't fail, we checked that `owner` is alive above
                    groups.insert(owner, new_group).unwrap();
                    // Inform
                    notifier(owner, ChangeNotification::NewLeader(owner));
                    new_group
                },
            };

            // Inform
            members(group, &*groups, entities, alignments, uids).for_each(|(e, role)| match role {
                Role::Member => {
                    notifier(e, ChangeNotification::Added(pet, Role::Pet));
                },
                Role::Pet => {},
            });

            // Add
            // Unwrap can't fail, we checked that `pet` is alive above
            groups.insert(pet, group).unwrap();
        }
    }

    pub fn leave_group(
        &mut self,
        member: specs::Entity,
        groups: &mut GroupsMut,
        alignments: &Alignments,
        uids: &Uids,
        entities: &specs::Entities,
        notifier: &mut impl FnMut(specs::Entity, ChangeNotification<specs::Entity>),
    ) {
        // Pets can't leave
        if matches!(alignments.get(member), Some(Alignment::Owned(uid)) if uids.get(member).map_or(true, |u| u != uid))
        {
            return;
        }
        self.remove_from_group(member, groups, alignments, uids, entities, notifier, false);
    }

    pub fn entity_deleted(
        &mut self,
        member: specs::Entity,
        groups: &mut GroupsMut,
        alignments: &Alignments,
        uids: &Uids,
        entities: &specs::world::EntitiesRes,
        notifier: &mut impl FnMut(specs::Entity, ChangeNotification<specs::Entity>),
    ) {
        self.remove_from_group(member, groups, alignments, uids, entities, notifier, true);
    }

    // Remove someone from a group if they are in one
    // Don't need to check if they are in a group before calling this
    // Also removes pets (ie call this if the pet no longer exists)
    fn remove_from_group(
        &mut self,
        member: specs::Entity,
        groups: &mut GroupsMut,
        alignments: &Alignments,
        uids: &Uids,
        entities: &specs::world::EntitiesRes,
        notifier: &mut impl FnMut(specs::Entity, ChangeNotification<specs::Entity>),
        to_be_deleted: bool,
    ) {
        let group = match groups.get(member) {
            Some(group) => *group,
            None => return,
        };

        // If leaving entity was the leader disband the group
        if self
            .group_info(group)
            .map(|info| info.leader == member)
            .unwrap_or(false)
        {
            // Remove group
            self.remove_group(group);

            (entities, uids, &*groups, alignments.maybe())
                .join()
                .filter(|(e, _, g, _)| **g == group && !(to_be_deleted && *e == member))
                .fold(
                    HashMap::<Uid, (Option<specs::Entity>, Option<Alignment>, Vec<specs::Entity>)>::new(),
                    |mut acc, (e, uid, _, alignment)| {
                        if let Some(owner) = alignment.and_then(|a| match a {
                            Alignment::Owned(owner) if uid != owner => Some(owner),
                            _ => None,
                        }) {
                            // A pet
                            // Assumes owner will be in the group
                            acc.entry(*owner).or_default().2.push(e);
                        } else {
                            // Not a pet
                            //
                            // Entry may already exist from inserting pets
                            let entry = acc.entry(*uid).or_default();
                            entry.0 = Some(e);
                            entry.1 = alignment.copied();
                        }

                        acc
                    },
                )
                .into_iter()
                .map(|(_, v)| v)
                .for_each(|(owner, alignment, pets)| {
                    if let Some(owner) = owner {
                        if let Some(special_group) = alignment.and_then(|a| a.group()) {
                            // Set NPC and pets back to their special alignment based group
                            for entity in iter::once(owner).chain(pets) {
                                groups.insert(entity, special_group)
                                    .expect("entity from join above so it must exist");
                            }
                        } else if !pets.is_empty() {
                            let mut members =
                                pets.iter().map(|e| (*e, Role::Pet)).collect::<Vec<_>>();
                            members.push((owner, Role::Member));

                            // New group
                            let new_group = self.create_group(owner, 1);
                            for (member, _) in &members {
                                groups.insert(*member, new_group).unwrap();
                            }

                            notifier(owner, ChangeNotification::NewGroup {
                                leader: owner,
                                members,
                            });
                        } else {
                            // If no pets just remove group
                            groups.remove(owner);
                            notifier(owner, ChangeNotification::NoGroup)
                        }
                    } else {
                        // Owner not found, potentially the were removed from the world
                        pets.into_iter().for_each(|pet| {
                            groups.remove(pet);
                        });
                    }
                });
        // Not leader
        } else {
            let leaving_member_uid = if let Some(uid) = uids.get(member) {
                *uid
            } else {
                error!("Failed to retrieve uid for the leaving member");
                return;
            };

            let leaving_pets = pets(member, leaving_member_uid, alignments, entities);

            // Handle updates for the leaving group member and their pets.
            if let Some(special_group) = alignments.get(member).and_then(|a| a.group())
                && !to_be_deleted
            {
                // Set NPC and pets back to their the special alignment based group
                for entity in iter::once(member).chain(leaving_pets.iter().copied()) {
                    groups
                        .insert(entity, special_group)
                        .expect("entity from join above so it must exist");
                }
            // Form new group if these conditions are met:
            // * Alignment not for a special npc group (handled above)
            // * The entity has pets.
            // * The entity isn't about to be deleted.
            } else if !leaving_pets.is_empty()
                && !to_be_deleted
                && alignments.get(member).and_then(Alignment::group).is_none()
            {
                let new_group = self.create_group(member, 1);

                notifier(member, ChangeNotification::NewGroup {
                    leader: member,
                    members: leaving_pets
                        .iter()
                        .map(|p| (*p, Role::Pet))
                        .chain(iter::once((member, Role::Member)))
                        .collect(),
                });

                let _ = groups.insert(member, new_group).unwrap();
                leaving_pets.iter().for_each(|&e| {
                    let _ = groups.insert(e, new_group).unwrap();
                });
            } else {
                let _ = groups.remove(member);
                notifier(member, ChangeNotification::NoGroup);
                leaving_pets.iter().for_each(|&e| {
                    let _ = groups.remove(e);
                });
            }

            // Handle updates for the rest of the group, potentially disbanding it if there
            // is now only one member left.
            if let Some(info) = self.group_info_mut(group) {
                // If not pet, decrement number of members
                if !matches!(alignments.get(member), Some(Alignment::Owned(owner)) if uids.get(member).map_or(true, |uid| uid != owner))
                {
                    if info.num_members > 0 {
                        info.num_members -= 1;
                    } else {
                        error!("Group with invalid number of members")
                    }
                }

                let mut remaining_count = 0; // includes pets
                // Inform remaining members
                members(group, &*groups, entities, alignments, uids).for_each(|(e, role)| {
                    remaining_count += 1;
                    match role {
                        Role::Member => {
                            notifier(e, ChangeNotification::Removed(member));
                            leaving_pets.iter().for_each(|p| {
                                notifier(e, ChangeNotification::Removed(*p));
                            })
                        },
                        Role::Pet => {},
                    }
                });
                // If leader is the last one left then disband the group
                // Assumes last member is the leader
                if remaining_count == 1 {
                    let leader = info.leader;
                    self.remove_group(group);
                    groups.remove(leader);
                    notifier(leader, ChangeNotification::NoGroup);
                } else if remaining_count == 0 {
                    error!("Somehow group has no members")
                }
            }
        }
    }

    // Assign new group leader
    // Does nothing if new leader is not part of a group
    pub fn assign_leader<'a>(
        &mut self,
        new_leader: specs::Entity,
        groups: impl GenericReadStorage<Component = Group> + Join<Type = &'a Group> + 'a,
        entities: &'a specs::Entities,
        alignments: &'a Alignments,
        uids: &'a Uids,
        mut notifier: impl FnMut(specs::Entity, ChangeNotification<specs::Entity>),
    ) {
        let group = match groups.get(new_leader) {
            Some(group) => *group,
            None => return,
        };

        // Set new leader
        self.groups[group.0 as usize].leader = new_leader;

        // Point to new leader
        members(group, groups, entities, alignments, uids).for_each(|(e, role)| match role {
            Role::Member => notifier(e, ChangeNotification::NewLeader(new_leader)),
            Role::Pet => {},
        });
    }
}

impl Group {
    /// Returns whether this is one of the special npc or enemy groups
    // FIXME: These groups are a HACK
    pub fn is_special(&self) -> bool { *self == NPC || *self == ENEMY }
}