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