Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
89.44% covered (warning)
89.44%
127 / 142
88.89% covered (warning)
88.89%
16 / 18
CRAP
0.00% covered (danger)
0.00%
0 / 1
MembersUtils
89.44% covered (warning)
89.44%
127 / 142
88.89% covered (warning)
88.89%
16 / 18
49.60
0.00% covered (danger)
0.00%
0 / 1
 parseCsv
71.43% covered (warning)
71.43%
30 / 42
0.00% covered (danger)
0.00%
0 / 1
13.82
 convertMemberCsvEncoding
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
4
 getMemberIdent
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMemberUsername
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMemberFirstName
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMemberLastName
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMemberCompany
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMemberStatus
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMemberJoinedOn
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMemberLeftOn
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMemberStatusEnabled
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 parseMemberDate
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
3
 getMemberData
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
 update
84.21% covered (warning)
84.21%
16 / 19
0.00% covered (danger)
0.00%
0 / 1
7.19
 isMemberActiveAt
100.00% covered (success)
100.00%
9 / 9
100.00% covered (success)
100.00%
1 / 1
6
 updateUserMembershipDates
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
3
 isSameDate
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getUserData
100.00% covered (success)
100.00%
38 / 38
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3namespace Olz\Apps\Members\Utils;
4
5use Olz\Common\Utils\WithUtilsTrait;
6use Olz\Entity\Members\Member;
7use Olz\Entity\Users\User;
8
9/**
10 * @phpstan-type MemberCsvColumn 'ident'|'username'|'first_name'|'last_name'|'company'|'status'|'joined_on'|'left_on'
11 */
12class MembersUtils {
13    use WithUtilsTrait;
14
15    private int $first_data_row = 1;
16
17    /** @var array<MemberCsvColumn, string> */
18    private array $csv_columns = [
19        'ident' => '[Id]',
20        'username' => 'Benutzer-Id',
21        'first_name' => 'Vorname',
22        'last_name' => 'Nachname',
23        'company' => 'Firma',
24        'status' => 'Status',
25        'joined_on' => 'Eintritt',
26        'left_on' => 'Austritt',
27    ];
28
29    /** @var array<string, bool> */
30    private array $is_enabled_by_status = [
31        'Kein Mitglied' => false,
32        'Aktivmitglied' => true,
33        'Passivmitglied' => true,
34        'Ehrenmitglied' => true,
35        'Ehemaliges Mitglied' => false,
36        'Verstorben' => false,
37        'Sp' => true,
38        'A' => true,
39        'V' => false,
40        'E' => true,
41    ];
42
43    /** @return array<array<string, string>> */
44    public function parseCsv(string $csv_content): array {
45        $utf8_csv_content = $this->convertMemberCsvEncoding($csv_content);
46        $stream = new \SplTempFileObject();
47        $stream->fwrite($utf8_csv_content);
48        $stream->rewind();
49        $stream->setFlags(\SplFileObject::READ_CSV | \SplFileObject::SKIP_EMPTY);
50        $stream->setCsvControl(";", "\"", "\\");
51        $header = $stream->current();
52        if (!is_array($header)) {
53            throw new \Exception("Invalid CSV header: {$header}");
54        }
55        $has_column_by_value = [];
56        foreach ($header as $value) {
57            $has_column_by_value[$value] = true;
58        }
59        /** @var array<MemberCsvColumn> */
60        $missing_columns = [];
61        foreach ($this->csv_columns as $key => $value) {
62            if (!($has_column_by_value[$value] ?? false)) {
63                $missing_columns[] = $key;
64            }
65        }
66        if (count($missing_columns) > 0) {
67            $pretty_columns = [];
68            foreach ($missing_columns as $key) {
69                $value = $this->csv_columns[$key];
70                $pretty_columns[] = "{$key} ({$value})";
71            }
72            $pretty_columns_str = implode(', ', $pretty_columns);
73            throw new \InvalidArgumentException("Missing columns in CSV: {$pretty_columns_str}");
74        }
75        $num_columns = count($header);
76        $stream->next();
77
78        $rows = [];
79        $i = $this->first_data_row;
80        while ($raw_row = $stream->current()) {
81            if (!is_array($raw_row)) {
82                throw new \Exception("Invalid CSV row[{$i}]: {$raw_row}");
83            }
84            $raw_row_count = count($raw_row);
85            if ($raw_row_count !== $num_columns) {
86                $enc_raw_row = json_encode($raw_row);
87                $this->log()->notice("Member CSV parse: Row[{$i}] = '{$enc_raw_row}' length ({$raw_row_count}) is not {$num_columns}");
88                continue;
89            }
90            $row = [];
91            for ($j = 0; $j < $num_columns; $j++) {
92                $row[$header[$j]] = "{$raw_row[$j]}";
93            }
94            $rows[] = $row;
95            $i++;
96            $stream->next();
97        }
98        return $rows;
99    }
100
101    protected function convertMemberCsvEncoding(string $csv_content): string {
102        if (strpos($csv_content, "Ge\x8andert") !== false) {
103            $converted = @iconv('macintosh', 'UTF-8', $csv_content);
104            if ($converted) {
105                return $converted;
106            }
107        }
108        $encoding = mb_detect_encoding($csv_content, ['UTF-8', 'ISO-8859-1', 'Windows-1252'], true);
109        $utf8_csv_content = mb_convert_encoding($csv_content, 'UTF-8', $encoding ?: 'ISO-8859-1');
110        $this->generalUtils()->checkNotFalse($utf8_csv_content, 'Could not convert to UTF-8');
111        return $utf8_csv_content;
112    }
113
114    /** @param array<string, string> $member */
115    public function getMemberIdent(array $member): ?string {
116        return $member[$this->csv_columns['ident']] ?? null;
117    }
118
119    /** @param array<string, string> $member */
120    public function getMemberUsername(array $member): ?string {
121        return $member[$this->csv_columns['username']] ?? null;
122    }
123
124    /** @param array<string, string> $member */
125    public function getMemberFirstName(array $member): ?string {
126        return $member[$this->csv_columns['first_name']] ?? null;
127    }
128
129    /** @param array<string, string> $member */
130    public function getMemberLastName(array $member): ?string {
131        return $member[$this->csv_columns['last_name']] ?? null;
132    }
133
134    /** @param array<string, string> $member */
135    public function getMemberCompany(array $member): ?string {
136        return $member[$this->csv_columns['company']] ?? null;
137    }
138
139    /** @param array<string, string> $member */
140    public function getMemberStatus(array $member): ?string {
141        return $member[$this->csv_columns['status']] ?? null;
142    }
143
144    /** @param array<string, string> $member */
145    public function getMemberJoinedOn(array $member): ?\DateTime {
146        return $this->parseMemberDate($member[$this->csv_columns['joined_on']] ?? '');
147    }
148
149    /** @param array<string, string> $member */
150    public function getMemberLeftOn(array $member): ?\DateTime {
151        return $this->parseMemberDate($member[$this->csv_columns['left_on']] ?? '');
152    }
153
154    /** @param array<string, string> $member */
155    public function getMemberStatusEnabled(array $member): bool {
156        $status = $this->getMemberStatus($member);
157        return $this->is_enabled_by_status[$status ?? ''] ?? false;
158    }
159
160    private function parseMemberDate(string $value): ?\DateTime {
161        $trimmed = trim($value);
162        if ($trimmed === '') {
163            return null;
164        }
165        $range = $this->dateUtils()->parseDateTimeRange($trimmed);
166        return $range !== null ? $range['start'] : null;
167    }
168
169    /** @return array<string, string> */
170    public function getMemberData(Member $member): array {
171        $decoded_member_data = json_decode($member->getData(), true);
172        return is_array($decoded_member_data) ? $decoded_member_data : [];
173    }
174
175    public function update(Member $member, ?User $user): void {
176        if (!$user) {
177            return;
178        }
179        if ($member->getUser()?->getId() !== $user->getId()) {
180            $this->log()->error("Update requested for member {$member->getIdent()} ({$member->getUser()?->getId()} !== {$user->getId()})");
181            return;
182        }
183        $member_data = $this->getMemberData($member);
184        $this->updateUserMembershipDates($user, $member_data);
185        $user_data = $this->getUserData($user);
186        $update = [];
187        foreach ($user_data as $key => $user_value) {
188            $member_value = $member_data[$key] ?? '';
189            if ($member_value !== $user_value && $user_value !== '') {
190                $this->log()->info("Field {$key} was updated.");
191                $update[$key] = $user_value;
192            }
193        }
194        if ($update) {
195            $enc_update = json_encode($update);
196            $this->generalUtils()->checkNotFalse($enc_update, 'JSON encode failed');
197            $member->setUpdates($enc_update);
198        } else {
199            $member->setUpdates(null);
200        }
201    }
202
203    /**
204     * Whether the member was (counted as) a member at the given point in time.
205     */
206    public function isMemberActiveAt(Member $member, \DateTime $at): bool {
207        $member_data = $this->getMemberData($member);
208        $joined_on = $this->getMemberJoinedOn($member_data);
209        if ($joined_on !== null && $joined_on > $at) {
210            return false; // Not yet joined
211        }
212        $left_on = $this->getMemberLeftOn($member_data);
213        if ($left_on !== null && $left_on < $at) {
214            return false; // Already left
215        }
216        // The record was removed from the club (soft-deleted) before `$at`. Deliberately
217        // not `$member->exists($at)`, because `created_at` only says when the record was
218        // imported, not since when the person is a member.
219        $deleted_at = $member->getDeletedAt();
220        return $deleted_at === null || $deleted_at >= $at;
221    }
222
223    /**
224     * The membership period is stored on the user as well, so that e.g. measurements
225     * of members with a user account can be calculated from the users table.
226     *
227     * @param array<string, string> $member
228     */
229    protected function updateUserMembershipDates(User $user, array $member): void {
230        $joined_on = $this->getMemberJoinedOn($member);
231        if (!$this->isSameDate($user->getJoinedOn(), $joined_on)) {
232            $this->log()->info("User {$user->getUsername()}: joined_on was updated.");
233            $user->setJoinedOn($joined_on);
234        }
235        $left_on = $this->getMemberLeftOn($member);
236        if (!$this->isSameDate($user->getLeftOn(), $left_on)) {
237            $this->log()->info("User {$user->getUsername()}: left_on was updated.");
238            $user->setLeftOn($left_on);
239        }
240    }
241
242    private function isSameDate(?\DateTime $existing, ?\DateTime $new): bool {
243        return $existing?->format('Y-m-d') === $new?->format('Y-m-d');
244    }
245
246    /** @return array<string, string> */
247    protected function getUserData(User $user): array {
248        return [
249            'Nachname' => $user->getLastName(),
250            'Vorname' => $user->getFirstName(),
251            'Adresse' => $user->getStreet() ?? '',
252            'PLZ' => $user->getPostalCode() ?? '',
253            'Ort' => $user->getCity() ?? '',
254            'Benutzer-Id' => $user->getUsername(),
255            // 'Land' => $user->getCountryCode() ?? '',
256            // 'E-Mail' => $user->getEmail() ?? '',
257            // 'Geschlecht' => $user->getGender() ?? '',
258            // 'Geburtsdatum' => $user->getBirthdate()?->format('Y-m-d') ?? '',
259            // 'SOLV NR' => $user->getSolvNumber() ?? '',
260            // 'Badge Nummer' => $user->getSiCardNumber() ?? '',
261            // 'Rechnungsversand' => 'E-Mail', // All online accounts get invoices by email
262
263            // TODO: Think about the other fields:
264            // "Telefon Privat" => $user->getPhone(),
265            // "Telefon Mobil"
266            // "Anrede"
267            // "Titel"
268            // "Briefanrede"
269            // "Adress-Zusatz"
270            // "Nationalität"
271            // "[Gruppen]"
272            // "Status"
273            // "[Rolle]"
274            // "Eintritt"
275            // "Mitgliedsjahre"
276            // "Austritt"
277            // "Zivilstand"
278            // "Jahrgang"
279            // "Alter"
280            // "Nie mahnen"
281            // "IBAN"
282            // "Kontoinhaber"
283            // "Mail-MV"
284            // "Werbegrund"
285            // "Geburtsjahr"
286        ];
287    }
288}