Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
92.50% covered (success)
92.50%
111 / 120
33.33% covered (danger)
33.33%
1 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 1
ImportMembersEndpoint
92.50% covered (success)
92.50%
111 / 120
33.33% covered (danger)
33.33%
1 / 3
23.22
0.00% covered (danger)
0.00%
0 / 1
 handle
92.31% covered (success)
92.31%
96 / 104
0.00% covered (danger)
0.00%
0 / 1
17.13
 getCsvContent
87.50% covered (warning)
87.50%
7 / 8
0.00% covered (danger)
0.00%
0 / 1
2.01
 getUserData
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
4
1<?php
2
3namespace Olz\Apps\Members\Endpoints;
4
5use Olz\Api\OlzTypedEndpoint;
6use Olz\Apps\Members\Utils\MembersUtilsTrait;
7use Olz\Entity\Members\Member;
8use Olz\Entity\Users\User;
9use PhpTypeScriptApi\HttpError;
10
11/**
12 * @phpstan-type OlzMemberInfo array{
13 *   ident: non-empty-string,
14 *   action: 'CREATE'|'UPDATE'|'DELETE'|'KEEP',
15 *   username?: ?string,
16 *   firstName?: ?string,
17 *   lastName?: ?string,
18 *   company?: ?string,
19 *   matchingUsername?: ?non-empty-string,
20 *   user?: ?array{
21 *     id: int,
22 *     firstName: non-empty-string,
23 *     lastName: non-empty-string,
24 *   },
25 *   updates: array<non-empty-string, array{old: string, new: string}>,
26 * }
27 *
28 * @extends OlzTypedEndpoint<
29 *   array{csvFileId: non-empty-string},
30 *   array{status: 'OK'|'ERROR', members: array<OlzMemberInfo>}
31 * >
32 */
33class ImportMembersEndpoint extends OlzTypedEndpoint {
34    use MembersUtilsTrait;
35
36    protected function handle(mixed $input): mixed {
37        if (!$this->authUtils()->hasPermission('vorstand')) {
38            throw new HttpError(403, "Kein Zugriff!");
39        }
40
41        $user = $this->authUtils()->getCurrentUser();
42        $this->log()->info("Members import by {$user?->getUsername()}.");
43
44        $member_info_by_ident = [];
45        $csv_content = $this->getCsvContent($input['csvFileId']);
46        $csv_members = $this->membersUtils()->parseCsv($csv_content);
47        $member_repo = $this->entityManager()->getRepository(Member::class);
48        $user_repo = $this->entityManager()->getRepository(User::class);
49
50        // Only active (i.e. not soft-deleted) members need to be reconciled against the CSV.
51        // Members who were removed in an earlier import stay deleted, and are therefore not
52        // reported / deleted again.
53        $existing_member_is_deleted = [];
54        foreach ($member_repo->getActiveIdents() as $existing_member_ident) {
55            // Assume deleted unless set to false later...
56            $existing_member_is_deleted[$existing_member_ident] = true;
57        }
58        foreach ($csv_members as $csv_member) {
59            $csv_member_ident = $this->membersUtils()->getMemberIdent($csv_member);
60            $csv_member_username = $this->membersUtils()->getMemberUsername($csv_member);
61            $csv_member_first_name = $this->membersUtils()->getMemberFirstName($csv_member);
62            $csv_member_last_name = $this->membersUtils()->getMemberLastName($csv_member);
63            $csv_member_company = $this->membersUtils()->getMemberCompany($csv_member);
64            $enc_csv_member = json_encode($csv_member);
65            $this->generalUtils()->checkNotFalse($enc_csv_member, "JSON encode failed");
66            if (!$csv_member_ident) {
67                $this->log()->warning("Member has no ident: {$enc_csv_member}");
68                continue;
69            }
70            $existing_member_is_deleted[$csv_member_ident] = false;
71            $user = $csv_member_username ? (
72                $user_repo->findOneBy(['username' => $csv_member_username])
73                ?? $user_repo->findOneBy(['old_username' => $csv_member_username])
74            ) : null;
75            $matching_user = $user_repo->findUserFuzzilyByName(
76                trim($csv_member_first_name ?? ''),
77                trim($csv_member_last_name ?? '')
78            );
79            $base_info = [
80                'username' => $csv_member_username,
81                'firstName' => $csv_member_first_name,
82                'lastName' => $csv_member_last_name,
83                'company' => $csv_member_company,
84                'matchingUsername' => $matching_user?->getUsername(),
85                'user' => $this->getUserData($user),
86            ];
87            $entity = $member_repo->findOneBy(['ident' => $csv_member_ident]);
88            if (!$entity) {
89                $member_info_by_ident[$csv_member_ident] = [...$base_info, 'action' => 'CREATE'];
90                $entity = new Member();
91                $this->entityUtils()->createOlzEntity($entity, []);
92                $entity->setIdent($csv_member_ident);
93                $entity->setUser($user);
94                $entity->setData($enc_csv_member);
95                $entity->setUpdates(null);
96                $this->membersUtils()->update($entity, $user);
97                $this->entityManager()->persist($entity);
98            } else {
99                if ($entity->getDeletedAt() !== null) {
100                    // The member was removed from the CSV in an earlier import and is back:
101                    // restore the record, so that the membership counts again. A re-joining
102                    // member is counted as if they had never left.
103                    $this->log()->info("Member {$csv_member_ident} was restored.");
104                    $this->entityUtils()->restoreOlzEntity($entity);
105                }
106                if ($entity->getData() === $enc_csv_member && $entity->getUser() === $user) {
107                    $member_info_by_ident[$csv_member_ident] = [...$base_info, 'action' => 'KEEP'];
108                    $this->membersUtils()->update($entity, $user);
109                } else {
110                    $member_info_by_ident[$csv_member_ident] = [...$base_info, 'action' => 'UPDATE'];
111                    $this->entityUtils()->updateOlzEntity($entity, []);
112                    $entity->setUser($user);
113                    $entity->setData($enc_csv_member);
114                    $this->membersUtils()->update($entity, $user);
115                }
116            }
117            $new_value_by_key = json_decode($entity->getUpdates() ?? '[]', true) ?: [];
118            $updates = [];
119            foreach ($new_value_by_key as $key => $new_value) {
120                $updates[$key] = ['old' => $csv_member[$key] ?? '', 'new' => $new_value];
121            }
122            $member_info_by_ident[$csv_member_ident]['updates'] = $updates;
123        }
124        foreach ($existing_member_is_deleted as $int_ident => $is_deleted) {
125            $csv_member_ident = "{$int_ident}";
126            if (!$is_deleted) {
127                continue;
128            }
129            $member = $member_repo->findOneBy(['ident' => $csv_member_ident]);
130            if ($member === null) {
131                $this->log()->warning("Cannot delete inexistent member: {$csv_member_ident}");
132                continue;
133            }
134            if ($member->getDeletedAt() !== null) {
135                // Already deleted by an earlier import: nothing to do.
136                continue;
137            }
138            $member_info_by_ident[$csv_member_ident] = [
139                'action' => 'DELETE',
140                'username' => null,
141                'matchingUsername' => null,
142                'user' => $this->getUserData($member->getUser()),
143                'updates' => [],
144            ];
145            $this->entityUtils()->deleteOlzEntity($member);
146        }
147        $this->entityManager()->flush();
148
149        $members = [];
150        foreach ($member_info_by_ident as $int_ident => $member) {
151            $member_ident = "{$int_ident}";
152            $enc_member = json_encode($member);
153            $this->generalUtils()->checkNotEmpty($member_ident, "Member ident must not be empty: {$enc_member}");
154            $this->generalUtils()->checkNotEmpty($member['matchingUsername'], "Member matchingUsername must not be empty: {$enc_member}");
155            $members[] = [
156                'ident' => "{$member_ident}",
157                'action' => $member['action'],
158                'username' => $member['username'] ?? null,
159                'firstName' => $member['firstName'] ?? null,
160                'lastName' => $member['lastName'] ?? null,
161                'company' => $member['company'] ?? null,
162                'matchingUsername' => $member['matchingUsername'] ?? null,
163                'user' => $member['user'] ?? null,
164                'updates' => $member['updates'],
165            ];
166        }
167        return ['status' => 'OK', 'members' => $members];
168    }
169
170    protected function getCsvContent(string $upload_id): string {
171        $data_path = $this->envUtils()->getDataPath();
172        $upload_path = "{$data_path}temp/{$upload_id}";
173        if (!is_file($upload_path)) {
174            throw new HttpError(400, 'Uploaded file not found!');
175        }
176        $csv_content = file_get_contents($upload_path);
177        unlink($upload_path);
178        $this->generalUtils()->checkNotFalse($csv_content, "Could not read uploaded Members CSV");
179        return $csv_content;
180    }
181
182    /** @return ?array{
183     *     id: int,
184     *     firstName: non-empty-string,
185     *     lastName: non-empty-string,
186     *   }
187     */
188    protected function getUserData(?User $user): ?array {
189        $user_id = $user?->getId();
190        if (!$user_id) {
191            return null;
192        }
193        return [
194            'id' => $user_id,
195            'firstName' => $user->getFirstName() ?: '-',
196            'lastName' => $user->getLastName() ?: '-',
197        ];
198    }
199}