Refactor import

patchwork.json

@@ -0,0 +1,6 @@
+{
+  "redefinable-internals": [
+    "feof",
+    "fgetcsv"
+  ]
+}

src/Admin/Initializer.php

@@ -5,7 +5,7 @@
 use abrain\Einsatzverwaltung\Core;
 use abrain\Einsatzverwaltung\Data;
 use abrain\Einsatzverwaltung\Export\Tool as ExportTool;
-use abrain\Einsatzverwaltung\Import\Tool as ImportTool;
+use abrain\Einsatzverwaltung\Import\Page as ImportPage;
 use abrain\Einsatzverwaltung\Options;
 use abrain\Einsatzverwaltung\PermalinkController;
 use abrain\Einsatzverwaltung\Settings\MainPage;
@@ -57,8 +57,8 @@
         add_action('admin_menu', array($mainPage, 'addToSettingsMenu'));
         add_action('admin_init', array($mainPage, 'registerSettings'));
 
-        $importTool = new ImportTool($utilities, $data);
-        add_action('admin_menu', array($importTool, 'addToolToMenu'));
+        $importPage = new ImportPage();
+        add_action('admin_menu', array($importPage, 'registerAsToolPage'));
 
         $exportTool = new ExportTool();
         add_action('admin_menu', array($exportTool, 'addToolToMenu'));

src/AdminPage.php

@@ -0,0 +1,101 @@
+<?php
+namespace abrain\Einsatzverwaltung;
+
+use function add_management_page;
+use function esc_html;
+use function printf;
+
+/**
+ * Base class for pages in the admin area.
+ *
+ * @package abrain\Einsatzverwaltung
+ */
+abstract class AdminPage
+{
+    /**
+     * @var string
+     */
+    private $menuSlug;
+
+    /**
+     * @var string
+     */
+    private $pageTitle;
+
+    /**
+     * @param string $pageTitle
+     * @param string $menuSlug
+     */
+    public function __construct(string $pageTitle, string $menuSlug)
+    {
+        $this->pageTitle = $pageTitle;
+        $this->menuSlug = $menuSlug;
+    }
+
+    abstract protected function echoPageContent();
+
+    /**
+     * Prints an error message.
+     *
+     * @param string $message The message text.
+     */
+    public function printError(string $message)
+    {
+        printf('<p class="notice notice-error">%s</p>', esc_html($message));
+    }
+
+    /**
+     * Prints an informational message.
+     *
+     * @param string $message The message text.
+     */
+    public function printInfo(string $message)
+    {
+        printf('<p class="notice notice-info">%s</p>', esc_html($message));
+    }
+
+    /**
+     * Prints a success message.
+     *
+     * @param string $message The message text.
+     */
+    public function printSuccess(string $message)
+    {
+        printf('<p class="notice notice-success">%s</p>', esc_html($message));
+    }
+
+    /**
+     * Prints a warning message.
+     *
+     * @param string $message The message text.
+     */
+    public function printWarning(string $message)
+    {
+        printf('<p class="notice notice-warning">%s</p>', esc_html($message));
+    }
+
+    /**
+     * Registers this page under the Tools menu.
+     */
+    public function registerAsToolPage()
+    {
+        add_management_page(
+            $this->pageTitle,
+            esc_html($this->pageTitle),
+            'manage_options',
+            $this->menuSlug,
+            array($this, 'render')
+        );
+    }
+
+    /**
+     * Generates the output of the page.
+     */
+    public function render()
+    {
+        echo '<div class="wrap">';
+        printf("<h1>%s</h1>", esc_html($this->pageTitle));
+        $this->echoPageContent();
+        echo '</div>';
+    }
+}

src/Exceptions/FileReadException.php

@@ -0,0 +1,11 @@
+<?php
+namespace abrain\Einsatzverwaltung\Exceptions;
+
+/**
+ * Class FileReadException
+ * @package abrain\Einsatzverwaltung\Exceptions
+ */
+class FileReadException extends \Exception
+{
+
+}

src/Exceptions/ImportCheckException.php

@@ -0,0 +1,13 @@
+<?php
+namespace abrain\Einsatzverwaltung\Exceptions;
+
+use Exception;
+
+/**
+ * Class ImportCheckException
+ * @package abrain\Einsatzverwaltung\Exceptions
+ */
+class ImportCheckException extends Exception
+{
+
+}

src/Import/CsvReader.php

@@ -0,0 +1,129 @@
+<?php
+namespace abrain\Einsatzverwaltung\Import;
+
+use abrain\Einsatzverwaltung\Exceptions\FileReadException;
+use function array_key_exists;
+use function fclose;
+use function feof;
+use function fgetcsv;
+use function fopen;
+use function is_array;
+use function sprintf;
+
+/**
+ * Makes CSV files accessible line by line
+ * @package abrain\Einsatzverwaltung\Import
+ */
+class CsvReader
+{
+    /**
+     * @var string
+     */
+    private $delimiter;
+
+    /**
+     * @var string
+     */
+    private $enclosure;
+
+    /**
+     * @var string
+     */
+    private $filePath;
+
+    /**
+     * CsvReader constructor.
+     *
+     * @param string $filePath
+     * @param string $delimiter
+     * @param string $enclosure
+     */
+    public function __construct(string $filePath, string $delimiter, string $enclosure)
+    {
+        $this->delimiter = $delimiter;
+        $this->enclosure = $enclosure;
+        $this->filePath = $filePath;
+    }
+
+    /**
+     * @param int $numLines How many lines to read.
+     * @param int[] $columns Array of 0-based column indices which should be returned. Empty array gets all columns.
+     * @param int $offset How many lines to skip before reading, default 0.
+     *
+     * @return string[][]
+     * @throws FileReadException
+     */
+    public function getLines(int $numLines, array $columns = [], int $offset = 0): array
+    {
+        $handle = fopen($this->filePath, 'r');
+        if ($handle === false) {
+            // translators: 1: file path
+            $message = sprintf(__('Could not open file %s', 'einsatzverwaltung'), $this->filePath);
+            throw new FileReadException($message);
+        }
+
+        // If an offset is defines, some lines should be skipped
+        if ($offset > 0) {
+            // The CSV parsing has to be used here as well, as line breaks could appear inside field delimiters
+            $this->readLines($handle, $offset, []);
+        }
+
+        $lines = $this->readLines($handle, $numLines, $columns);
+
+        fclose($handle);
+        return $lines;
+    }
+
+    /**
+     * @param resource $handle
+     * @param int $numLines
+     * @param array $columns
+     *
+     * @return array
+     * @throws FileReadException
+     */
+    private function readLines($handle, int $numLines, array $columns): array
+    {
+        $linesRead = 0;
+        $lines = array();
+        while ($numLines === 0 || $linesRead < $numLines) {
+            $line = fgetcsv($handle, 0, $this->delimiter, $this->enclosure);
+
+            // Error while reading, most likely EOF
+            if ($line === false) {
+                break;
+            }
+
+            $linesRead++;
+
+            // Empty line in the file, skip this
+            if ($line == [null]) {
+                continue;
+            }
+
+            // Return entire line when all columns have been requested
+            if (empty($columns)) {
+                $lines[] = $line;
+                continue;
+            }
+
+            // Return only the requested columns
+            $filteredLine = array();
+            foreach ($columns as $columnIndex) {
+                // If the line has less columns than expected, the value will be an empty string
+                $filteredLine[] = array_key_exists($columnIndex, $line) ? $line[$columnIndex] : '';
+            }
+            $lines[] = $filteredLine;
+        }
+
+        if (($numLines === 0 || $linesRead < $numLines) && feof($handle) === false) {
+            throw new FileReadException(sprintf(
+                // translators: 1: number of lines
+                _n('Reading was aborted after %d line', 'Reading was aborted after %d lines', $linesRead, 'einsatzverwaltung'),
+                $linesRead
+            ));
+        }
+
+        return $lines;
+    }
+}