Lines 75.00% 108 / 144
Methods 68.42% 13 / 19
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 sanitizeDownloadFilenamePart 100.00% 1 / 1 100.00% 1 / 1 1
 resolveDictionaryHeader 33.33% 2 / 6 0.00% 0 / 1 5.67
 writeRawReport 100.00% 9 / 9 100.00% 1 / 1 5
 writeFilteredExchangeReport 93.75% 15 / 16 0.00% 0 / 1 6.01
 writeInfoHeader 92.59% 25 / 27 0.00% 0 / 1 10.04
 setDateTime 75.00% 3 / 4 0.00% 0 / 1 3.14
 getFormatedDates 100.00% 9 / 9 100.00% 1 / 1 1
 [BO\Zmsstatistic\BaseController] __invoke 100.00% 5 / 5 100.00% 1 / 1 2
 [BO\Zmsstatistic\BaseController] readResponse n/a 0 / 0 n/a 0 / 0 1
 [BO\Zmsstatistic\Helper\Access] initAccessRights 100.00% 6 / 6 100.00% 1 / 1 4
 [BO\Zmsstatistic\Helper\Access] readWorkstation 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsstatistic\Helper\Access] readDepartment 100.00% 5 / 5 100.00% 1 / 1 2
 [BO\Zmsstatistic\Helper\Access] readOrganisation 100.00% 5 / 5 100.00% 1 / 1 2
 [BO\Zmsstatistic\Helper\Access] readOwner 100.00% 5 / 5 100.00% 1 / 1 2
 [BO\Zmsstatistic\Helper\Access] validateAccessRights 100.00% 3 / 3 100.00% 1 / 1 1
 [BO\Zmsstatistic\Helper\Access] validateAccess 100.00% 4 / 4 100.00% 1 / 1 7
 [BO\Zmsstatistic\Helper\Access] validateScope 66.66% 2 / 3 0.00% 0 / 1 4.59
 [BO\Zmsstatistic\Helper\Access] isPathWithoutScope 100.00% 5 / 5 100.00% 1 / 1 4
 [BO\Zmsstatistic\Helper\Access] testLogin 0.00% 0 / 27 0.00% 0 / 1 42
 [BO\Zmsstatistic\Helper\Access] exceptionTemplateExists 100.00% 2 / 2 100.00% 1 / 1 1
15class Base extends BaseController
16{
17    public static array $ignoreColumns = [
18        'subjectid',
19        'scopeids',
20        'max',
21        'sum',
22        'ticketprinter',
23        'ticketprintermissed'
24    ];
25    public static array $subjectTranslations = [
26        'waitingscope' => 'Wartesituation',
27        'waitingdepartment' => 'Wartesituation',
28        'waitingorganisation' => 'Wartesituation',
29        'clientscope' => 'Kundenstatistik',
30        'clientdepartment' => 'Kundenstatistik',
31        'clientorganisation' => 'Kundenstatistik',
32        'requestscope' => 'Dienstleistungsstatistik',
33        'requestdepartment' => 'Dienstleistungsstatistik',
34        'requestorganisation' => 'Dienstleistungsstatistik',
35        'raw-waitingscope' => 'Rohdaten Wartesituation',
36        'raw-waitingdepartment' => 'Rohdaten Wartesituation',
37        'raw-waitingorganisation' => 'Rohdaten Wartesituation',
38        'raw-clientscope' => 'Rohdaten Wartende',
39        'raw-clientdepartment' => 'Rohdaten Wartende',
40        'raw-clientorganisation' => 'Rohdaten Wartende',
41        'raw-requestscope' => 'Rohdaten Dienstleistungsstatistik',
42        'raw-requestdepartment' => 'Rohdaten Dienstleistungsstatistik',
43        'raw-requestorganisation' => 'Rohdaten Dienstleistungsstatistik',
44        'capacityscope' => 'Terminkapazität',
45        'raw-capacityscope' => 'Rohdaten Terminkapazität'
46    ];
47
48    public static array $headlines = [
49        'subjectid' => 'ID',
50        'scopeids' => 'Standort IDs',
51        'date' => 'Datum',
52        'clientscount' => 'Kunden Erschienen',
53        'missed' => 'Kunden Nicht Erschienen',
54        'withappointment' => 'davon Terminkunden Erschienen',
55        'missedwithappointment' => 'davon Terminkunden Nicht Erschienen',
56        'noappointment' => 'davon Spontankunden Erschienen',
57        'missednoappointment' => 'davon Spontankunden Nicht Erschienen',
58        'ticketprinter' => 'Erschienen (E-Kiosk)',
59        'ticketprintermissed' => 'Nicht Erschienen (E-Kiosk)',
60        'requestscount' => 'Dienstleistungen',
61        'organisationname' => 'Organisation',
62        'departmentname' => 'Behörde',
63        'scopename' => 'Standort',
64        'bookedcount' => 'Gebuchte Kapazität (Zeitschlitze)',
65        'plannedcount' => 'Geplante Kapazität (Zeitschlitze)',
66        'bookedminutes' => 'Gebuchte Kapazität (Minuten)',
67        'plannedminutes' => 'Geplante Kapazität (Minuten)',
68    ];
69
70    protected function sanitizeDownloadFilenamePart(string $part): string
71    {
72        return str_replace(',', '_', $part);
73    }
74
75    protected function resolveDictionaryHeader(array $item): string
76    {
77        if (!empty($item['description'])) {
78            return (string) $item['description'];
79        }
80
81        $variable = $item['variable'] ?? '';
82        if (isset(static::$headlines[$variable])) {
83            return static::$headlines[$variable];
84        }
85
86        return (string) $variable;
87    }
88
89    protected function writeRawReport(Exchange $report, Spreadsheet $spreadsheet): Spreadsheet
90    {
91        $sheet = $spreadsheet->getActiveSheet();
92        $reportData = [];
93        foreach ($report->dictionary as $item) {
94            $reportData['header'][] = $this->resolveDictionaryHeader($item);
95        }
96        foreach ($report->data as $row => $entry) {
97            foreach ($entry as $item) {
98                $reportData[$row][] = is_numeric($item) ? (string) $item : $item;
99            }
100        }
101        $sheet->fromArray($reportData, null, 'A' . ($sheet->getHighestRow()));
102
103        return $spreadsheet;
104    }
105
106    protected function writeFilteredExchangeReport(
107        Exchange $report,
108        Spreadsheet $spreadsheet,
109        array $skipVariables = [],
110        int $rowGap = 0
111    ): Spreadsheet {
112        $sheet = $spreadsheet->getActiveSheet();
113        $columnIndexes = [];
114        $reportData = [];
115
116        foreach ($report->dictionary as $index => $item) {
117            $variable = $item['variable'] ?? '';
118            if (in_array($variable, $skipVariables, true)) {
119                continue;
120            }
121            $columnIndexes[] = $index;
122            $reportData['header'][] = $this->resolveDictionaryHeader($item);
123        }
124
125        foreach ($report->data as $row => $entry) {
126            foreach ($columnIndexes as $index) {
127                $value = $entry[$index] ?? '';
128                $reportData[$row][] = is_numeric($value) ? (string) $value : $value;
129            }
130        }
131
132        $startRow = $sheet->getHighestRow() + $rowGap;
133        $sheet->fromArray($reportData, null, 'A' . $startRow);
134
135        return $spreadsheet;
136    }
137
138    protected function writeInfoHeader(array $args, Spreadsheet $spreadsheet): Spreadsheet|null
139    {
140        $sheet = $spreadsheet->getActiveSheet();
141        $infoData = [];
142        $infoData[] = static::$subjectTranslations[$args['category']];
143        if (isset($args['selectedScopes'])) {
144            try {
145                $scopesResult = \App::http()->readGetResult('/scope/')->getData();
146                $scopeMap = [];
147                foreach ($scopesResult ?? [] as $scope) {
148                    $scopeMap[$scope->id] = $scope;
149                }
150                foreach ($args['selectedScopes'] as $scopeId) {
151                    if (isset($scopeMap[$scopeId])) {
152                        $infoData[] = $scopeMap[$scopeId]->provider->name . " " . $scopeMap[$scopeId]->shortName;
153                    }
154                }
155            } catch (Exception $exception) {
156                return null;
157            }
158        } else {
159            if (isset($args['organisation'])) {
160                $infoData[] = $args['organisation']['name'] ;
161            }
162            if (isset($args['department'])) {
163                $infoData[] = $args['department']['name'];
164            }
165            if (isset($args['scope'])) {
166                $infoData[] = $args['scope']['contact']['name'] . ' ' . $args['scope']['shortName'];
167            }
168        }
169
170        $infoData = array_chunk($infoData, 1);
171        $sheet->fromArray($infoData, null, 'A' . $sheet->getHighestRow());
172
173        if (isset($args['reports'][0]->firstDay)) {
174            $firstDay = $args['reports'][0]->firstDay->toDateTime()->format('d.m.Y');
175            $lastDay = $args['reports'][0]->lastDay->toDateTime()->format('d.m.Y');
176            $range = array('Zeitraum:', $firstDay, 'bis', $lastDay);
177            $sheet->fromArray($range, null, 'A' . ($sheet->getHighestRow() + 1));
178        }
179
180        return $spreadsheet;
181    }
182
183    /** @psalm-api */
184    protected function setDateTime(string $dateString): \DateTime
185    {
186        $dateArr = explode('-', $dateString);
187        if (2 == count($dateArr)) {
188            $dateString = $dateString . '-01';
189        }
190        /* ignore because not in use now */
191        //@codeCoverageIgnoreStart
192        if (1 == count($dateArr)) {
193            $dateString = $dateString . '-01-01';
194        }
195        //@codeCoverageIgnoreEnd
196        return new \DateTime($dateString);
197    }
198
199    /**
200     * @psalm-api
201     * @return false|string
202     */
203    protected function getFormatedDates(\DateTimeInterface $date, string $pattern = 'MMMM'): string|false
204    {
205        $dateFormatter = new \IntlDateFormatter(
206            'de-DE',
207            \IntlDateFormatter::MEDIUM,
208            \IntlDateFormatter::MEDIUM,
209            \App::TIMEZONE,
210            \IntlDateFormatter::GREGORIAN,
211            $pattern
212        );
213
214        return $dateFormatter->format($date->getTimestamp());
215    }
216}

Inherited from BO\Zmsstatistic\BaseController

20    public function __invoke(RequestInterface $request, ResponseInterface $response, array $args)
21    {
22        $request = $this->initRequest($request);
23        if ($this->withAccess) {
24            $this->initAccessRights($request);
25        }
26        $noCacheResponse = \BO\Slim\Render::withLastModified($response, time(), '0');
27        return $this->readResponse($request, $noCacheResponse, $args);
28    }
34    public function readResponse(RequestInterface $request, ResponseInterface $response, array $args): mixed
35    {
36        return parent::__invoke($request, $response, $args);
37    }

Inherited from BO\Zmsstatistic\Helper\Access

33    protected function initAccessRights(RequestInterface $request): void
34    {
35        $this->workstation = $this->readWorkstation();
36        if ($this->workstation && isset($this->workstation->scope['id']) && $this->workstation->scope['id'] > 0) {
37            $this->department = $this->readDepartment();
38            $this->organisation = $this->readOrganisation();
39            $this->owner = $this->readOwner();
40        }
41        $this->validateAccessRights($request);
42    }
44    protected function readWorkstation(): mixed
45    {
46        $workstation = \App::http()->readGetResult('/workstation/', ['resolveReferences' => $this->resolveLevel]);
47        return $workstation->getEntity();
48    }
50    protected function readDepartment(): mixed
51    {
52        if ($this->workstation->getUseraccount()->hasPermissions(['statistic'])) {
53            return \App::http()
54                ->readGetResult('/scope/' . $this->workstation->scope['id'] . '/department/')
55                ->getEntity();
56        }
57        return null;
58    }
60    protected function readOrganisation(): mixed
61    {
62        if ($this->workstation->getUseraccount()->isSuperUser()) {
63            return \App::http()
64                ->readGetResult('/department/' . $this->department->getId() . '/organisation/')
65                ->getEntity();
66        }
67        return null;
68    }
70    protected function readOwner(): mixed
71    {
72        if ($this->workstation->getUseraccount()->isSuperUser()) {
73            return \App::http()
74                ->readGetResult('/organisation/' . $this->organisation->getId() . '/owner/')
75                ->getEntity();
76        }
77        return null;
78    }
80    protected function validateAccessRights(RequestInterface $request): void
81    {
82        $path = $request->getUri()->getPath();
83        $this->validateAccess($path);
84        $this->validateScope($path);
85    }
87    protected function validateAccess(string $path): void
88    {
89        if (
90            (false !== strpos($path, 'owner') && ! $this->owner) ||
91            (false !== strpos($path, 'organisation') && ! $this->organisation) ||
92            (false !== strpos($path, 'department') && ! $this->department)
93        ) {
94            throw new UserAccountAccessRightsFailed();
95        }
96    }
98    protected function validateScope(string $path): void
99    {
100        if (
101            $this->isPathWithoutScope($path)
102            && (! isset($this->workstation['scope']) || ! isset($this->workstation['scope']['id']))
103        ) {
104            throw new WorkstationMissingScope();
105        }
106    }
108    protected function isPathWithoutScope(string $path): bool
109    {
110        // TODO: refactor to integrate these access rules in the controller to make them visible
111        return (false === strpos($path, 'select')
112            && false === strpos($path, 'warehouse')
113            && false === strpos($path, 'logout')
114            && false === strpos($path, 'report')
115        );
116    }
121    protected function testLogin(mixed $input): mixed
122    {
123        $userAccount = new Useraccount(array(
124            'id' => $input['loginName'],
125            'password' => $input['password'],
126            'departments' => array('id' => 0) // required in schema validation
127        ));
128        try {
129            /** @var Workstation $workstation */
130            $workstation = \App::http()->readPostResult('/workstation/login/', $userAccount)->getEntity();
131            return $workstation;
132        } catch (\BO\Zmsclient\Exception $exception) {
133            $template = TwigExceptionHandler::getExceptionTemplate($exception);
134            if ('BO\Zmsentities\Exception\SchemaValidation' == $exception->template) {
135                $exceptionData = [
136                  'template' => 'exception/bo/zmsbackend/useraccount/exception/invalidcredentials.twig'
137                ];
138                $exceptionData['data']['password']['messages'] = [
139                    'Der Nutzername oder das Passwort wurden falsch eingegeben'
140                ];
141            } elseif ('BO\Zmsbackend\Useraccount\Exception\UserAlreadyLoggedIn' == $exception->template) {
142                Auth::setKey($exception->data['authkey'], time() + \App::SESSION_DURATION);
143                throw $exception;
144            } elseif (
145                '' != $exception->template
146                && $this->exceptionTemplateExists($template)
147            ) {
148                $exceptionData = [
149                  'template' => $template,
150                  'data' => $exception->data
151                ];
152            } else {
153                throw $exception;
154            }
155        }
156        return $exceptionData;
157    }
159    protected function exceptionTemplateExists(string $template): bool
160    {
161        /** @var mixed $container */
162        $container = \App::$slim->getContainer();
163        return $container->get('view')->getLoader()->exists($template);
164    }