add csv import

Author: JorisLambrechts

modules/CSVImport/LICENSE.md

@@ -0,0 +1,86 @@
+<?php
+namespace CSVImport;
+
+use Omeka\Module\AbstractModule;
+use Laminas\ModuleManager\ModuleManager;
+use Laminas\ServiceManager\ServiceLocatorInterface;
+
+class Module extends AbstractModule
+{
+    public function init(ModuleManager $moduleManager)
+    {
+        require_once __DIR__ . '/vendor/autoload.php';
+    }
+
+    public function getConfig()
+    {
+        return include __DIR__ . '/config/module.config.php';
+    }
+
+    public function install(ServiceLocatorInterface $serviceLocator)
+    {
+        $connection = $serviceLocator->get('Omeka\Connection');
+        $sql = <<<'SQL'
+CREATE TABLE csvimport_import (
+  id INT AUTO_INCREMENT NOT NULL,
+  job_id INT NOT NULL,
+  undo_job_id INT DEFAULT NULL,
+  comment VARCHAR(255) DEFAULT NULL,
+  resource_type VARCHAR(255) NOT NULL,
+  has_err TINYINT(1) NOT NULL,
+  stats LONGTEXT NOT NULL COMMENT '(DC2Type:json_array)',
+  UNIQUE INDEX UNIQ_17B50881BE04EA9 (job_id),
+  UNIQUE INDEX UNIQ_17B508814C276F75 (undo_job_id),
+  PRIMARY KEY(id)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE = InnoDB;
+CREATE TABLE csvimport_entity (
+  id INT AUTO_INCREMENT NOT NULL,
+  job_id INT NOT NULL,
+  entity_id INT NOT NULL,
+  resource_type VARCHAR(255) NOT NULL,
+  INDEX IDX_84D382F4BE04EA9 (job_id),
+  PRIMARY KEY(id)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE = InnoDB;
+ALTER TABLE csvimport_import ADD CONSTRAINT FK_17B50881BE04EA9 FOREIGN KEY (job_id) REFERENCES job (id);
+ALTER TABLE csvimport_import ADD CONSTRAINT FK_17B508814C276F75 FOREIGN KEY (undo_job_id) REFERENCES job (id);
+ALTER TABLE csvimport_entity ADD CONSTRAINT FK_84D382F4BE04EA9 FOREIGN KEY (job_id) REFERENCES job (id);
+SQL;
+        $sqls = array_filter(array_map('trim', explode(';', $sql)));
+        foreach ($sqls as $sql) {
+            $connection->exec($sql);
+        }
+    }
+
+    public function uninstall(ServiceLocatorInterface $serviceLocator)
+    {
+        $connection = $serviceLocator->get('Omeka\Connection');
+        $sql = <<<'SQL'
+ALTER TABLE csvimport_entity DROP FOREIGN KEY FK_84D382F4BE04EA9;
+ALTER TABLE csvimport_import DROP FOREIGN KEY FK_17B508814C276F75;
+ALTER TABLE csvimport_import DROP FOREIGN KEY FK_17B50881BE04EA9;
+DROP TABLE IF EXISTS csvimport_entity;
+DROP TABLE IF EXISTS csvimport_import;
+SQL;
+        $sqls = array_filter(array_map('trim', explode(';', $sql)));
+        foreach ($sqls as $sql) {
+            $connection->exec($sql);
+        }
+        // User settings are not removed here: they belong to the user.
+    }
+
+    public function upgrade($oldVersion, $newVersion, ServiceLocatorInterface $serviceLocator)
+    {
+        if (version_compare($oldVersion, '1.1.1-rc.1', '<')) {
+            $connection = $serviceLocator->get('Omeka\Connection');
+            $sql = <<<'SQL'
+ALTER TABLE csvimport_import ADD stats LONGTEXT NOT NULL COMMENT '(DC2Type:json_array)';
+UPDATE csvimport_import SET stats = CONCAT('{"processed":{"', resource_type, '":', added_count, '}}');
+ALTER TABLE csvimport_import DROP added_count;
+SQL;
+            $sqls = array_filter(array_map('trim', explode(';', $sql)));
+            foreach ($sqls as $sql) {
+                $connection->exec($sql);
+            }
+        }
+    }
+}

modules/CSVImport/Module.php

@@ -0,0 +1,76 @@
+CSV Import (module for Omeka S)
+===============================
+
+[CSV Import] is a module for [Omeka S] and will allow users to import Entities from a simple CSV (comma separated value) file, and then map the CSV column data to Entity. Each row in the file represents metadata for a single Entity.
+
+Furthermore, it’s possible to import directly files in formats [TSV] (tab separated value), a simpler and more efficient format, and [ODS] (OpenDocument Spreadsheet, the ISO standard office format for spreadsheets, managed by [LibreOffice] and a lot of other tools) directly.
+
+Most often, the import will create new Omeka S items. It is also possible to import item sets, media and users, and other modules can add other import types. It’s possible to import mixed resources in one file too.
+
+See the [Omeka S user manual](http://omeka.org/s/docs/user-manual/modules/csvimport/) for user documentation.
+
+Installation
+------------
+
+See general end user documentation for [Installing a module](http://omeka.org/s/docs/user-manual/modules/#installing-modules).
+
+To install CSV Import from the source, go to the root of the module, and run `composer install`. Users
+using the pre-packaged downloads from the Releases page or the omeka.org module directory don't need
+to worry about this step.
+
+To be able to import `ods`, the php extensions `zip` and `xml` should be installed (default in most cases).
+
+Warning
+-------
+
+Use it at your own risk.
+
+It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.
+
+Troubleshooting
+---------------
+
+See online issues on the [Omeka forum] and the [module issues] page on GitHub.
+
+License
+-------
+
+The Corporation for Digital Scholarship distributes the Omeka source code under the GNU General Public License, version 3 (GPLv3). The full text
+of this license is given in the license file.
+
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Contact
+-------
+
+Current maintainers:
+
+* Omeka Team
+* Daniel Berthereau (see [Daniel-KM] on GitHub)
+
+Copyright
+---------
+* CSVImport is Copyright © 2015-present Corporation for Digital Scholarship, Vienna, Virginia, USA http://digitalscholar.org
+
+The Omeka name is a registered trademark of the Corporation for Digital Scholarship.
+
+Third-party copyright in this distribution is noted where applicable.
+
+All rights not expressly granted are reserved.
+
+* Copyright Daniel Berthereau, 2017-2019
+
+[CSV Import]: https://github.com/Omeka-s-modules/CSVImport
+[Omeka S]: https://omeka.org/s
+[TSV]: https://en.wikipedia.org/wiki/Tab-separated_values
+[ODS]: http://opendocumentformat.org/aboutODF
+[LibreOffice]: https://www.libreoffice.org
+[Omeka forum]: https://forum.omeka.org/c/omeka-s/modules
+[module issues]: https://github.com/omeka-s-modules/CSVImport/issues
+[GNU/GPL v3]: https://www.gnu.org/licenses/gpl-3.0.html
+[Daniel-KM]: https://github.com/Daniel-KM "Daniel Berthereau"
+