From 6ee322316bcbd8c9719954b5393aad6e6967c36e Mon Sep 17 00:00:00 2001
From: buttle <chris@gatopelao.org>
Date: Sat, 17 Apr 2021 19:13:22 +0200
Subject: [PATCH] first commit

---
 LICENSE                                       | 21 +++++
 Module.php                                    | 27 ++++++
 README.md                                     | 21 +++++
 asset/css/panoramaviewer.css                  |  7 ++
 config/module.config.php                      | 40 +++++++++
 config/module.ini                             | 12 +++
 src/Form/ArchiveOrgBlockForm.php              | 51 +++++++++++
 .../Ingester/ArchiveOrgMediaIngester.php      | 49 ++++++++++
 .../Renderer/ArchiveOrgMediaRenderer.php      | 23 +++++
 src/Service/BlockLayout/ArchiveOrgFactory.php | 18 ++++
 .../Media/Ingester/ArchiveOrgMediaFactory.php | 16 ++++
 src/Site/BlockLayout/ArchiveOrg.php           | 89 +++++++++++++++++++
 view/common/block-layout/archiveOrg.phtml     | 43 +++++++++
 13 files changed, 417 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 Module.php
 create mode 100644 README.md
 create mode 100644 asset/css/panoramaviewer.css
 create mode 100644 config/module.config.php
 create mode 100644 config/module.ini
 create mode 100644 src/Form/ArchiveOrgBlockForm.php
 create mode 100644 src/Media/Ingester/ArchiveOrgMediaIngester.php
 create mode 100644 src/Media/Renderer/ArchiveOrgMediaRenderer.php
 create mode 100644 src/Service/BlockLayout/ArchiveOrgFactory.php
 create mode 100644 src/Service/Media/Ingester/ArchiveOrgMediaFactory.php
 create mode 100644 src/Site/BlockLayout/ArchiveOrg.php
 create mode 100644 view/common/block-layout/archiveOrg.phtml

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..9bd6b00
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Neo-Inspiration
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Module.php b/Module.php
new file mode 100644
index 0000000..276abe9
--- /dev/null
+++ b/Module.php
@@ -0,0 +1,27 @@
+<?php
+namespace ArchiveOrg;
+
+use Omeka\Module\AbstractModule;
+use Laminas\EventManager\SharedEventManagerInterface;
+use Laminas\Mvc\MvcEvent;
+
+class Module extends AbstractModule
+{
+	const NAMESPACE = __NAMESPACE__;
+
+	const MEDIA_TYPE = [
+		'video' => 'Video',
+		'audio' => 'Audio',
+	];
+
+	const RATIOS = [
+		'1.777' => '16:9',
+		'1.333' => '4:3',
+		'2' => '2:1',
+	];
+
+	public function getConfig()
+	{
+		return include __DIR__ . '/config/module.config.php';
+	}
+}
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..40e678d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Archive.org media for Omeka S
+
+[Archive.org media] is a module for [Omeka S] that integrates [Archive.org] media.
+
+## Install
+
+```
+cd ./modules
+https://git.hangar.org/arcHIVE-tech/ArchiveOrg/archive/main.zip
+unzip main.zip
+mv panoramaviewer/ ArchiveOrg
+```
+
+## LISENCE
+The module is released under the [MIT] License.
+
+
+[arc-hive]: https://arc-hive.zone/
+[Archive Viewer]: https://git.hangar.org/arcHIVE-tech/ArchiveOrg
+[Omeka S]: https://omeka.org/s
+[MIT]: http://opensource.org/licenses/MIT
diff --git a/asset/css/panoramaviewer.css b/asset/css/panoramaviewer.css
new file mode 100644
index 0000000..24b6e1f
--- /dev/null
+++ b/asset/css/panoramaviewer.css
@@ -0,0 +1,7 @@
+/* Panaorama viewer custom */
+@media screen {
+    .panorama-viewer {
+        /* width: 600px; */
+        /* height: 400px; */
+    }
+}
diff --git a/config/module.config.php b/config/module.config.php
new file mode 100644
index 0000000..dae5a19
--- /dev/null
+++ b/config/module.config.php
@@ -0,0 +1,40 @@
+<?php
+namespace ArchiveOrg;
+
+return [
+    'view_manager' => [
+        'template_path_stack' => [
+            dirname(__DIR__) . '/view',
+        ]
+    ],
+	'block_layouts' => [
+        'factories' => [
+            'archiveOrg' => Service\BlockLayout\ArchiveOrgFactory::class,
+        ],
+    ],
+    'form_elements' => [
+        'invokables' => [
+            Form\ArchiveOrgBlockForm::class => Form\ArchiveOrgBlockForm::class,
+        ],
+    ],
+    'media_ingesters' => [
+        'factories' => [
+            'ArchiveOrg_media' => Service\Media\Ingester\ArchiveOrgMediaFactory::class,
+        ],
+    ],
+    'media_renderers' => [
+        'invokables' => [
+            'ArchiveOrg_media' => Media\Renderer\ArchiveOrgMediaRenderer::class,
+        ],
+    ],
+    'DefaultSettings' => [
+        'ArchiveOrgBlockForm' => [
+            'media_type' => 'video',
+            'title' => '',
+            'width' => 600,
+            'ratio' => '2',
+            'autoLoad' => false,
+            'wrapStyle' => 'overflow-y: hidden;display: flex;flex-direction: column;justify-content: center;',
+        ]
+    ]
+];
diff --git a/config/module.ini b/config/module.ini
new file mode 100644
index 0000000..44925b2
--- /dev/null
+++ b/config/module.ini
@@ -0,0 +1,12 @@
+[info]
+name         = "Archive.org media viewer"
+description  = "Embed Archive.org media"
+tags         = ""
+license      = "MIT"
+author       = "Hangar.org"
+author_link  = "https://git.hangar.org/chris"
+module_link  = "https://git.hangar.org/arcHIVE-tech/ArchiveOrg"
+support_link = "https://git.hangar.org/arcHIVE-tech/ArchiveOrg/issues"
+configurable = false
+version      = "1.0.0"
+omeka_version_constraint = "^3.0.1"
diff --git a/src/Form/ArchiveOrgBlockForm.php b/src/Form/ArchiveOrgBlockForm.php
new file mode 100644
index 0000000..3e07061
--- /dev/null
+++ b/src/Form/ArchiveOrgBlockForm.php
@@ -0,0 +1,51 @@
+<?php
+namespace ArchiveOrg\Form;
+
+use ArchiveOrg\Module;
+use Laminas\Form\Element;
+use Laminas\Form\Form;
+
+class ArchiveOrgBlockForm extends Form
+{
+	public function init()
+	{
+
+		$this->add([
+			'name' => 'o:block[__blockIndex__][o:data][title]',
+			'type' => Element\Text::class,
+      'options' => [
+				'label' => 'Title (option)',
+			]
+		]);
+
+		$this->add([
+			'name' => 'o:block[__blockIndex__][o:data][media_type]',
+      'type' => Element\Select::class,
+      'options' => [
+          'label' => 'Media type',
+					'value_options' => Module::MEDIA_TYPE,
+      ],
+		]);
+
+		$this->add([
+			'name' => 'o:block[__blockIndex__][o:data][width]',
+			'type' => Element\Number::class,
+      'options' => [
+				'label' => 'Video width in pixels',
+			],
+			'attributes' => [
+				'min' => '100',
+			],
+		]);
+
+		$this->add([
+			'name' => 'o:block[__blockIndex__][o:data][ratio]',
+      'type' => Element\Select::class,
+      'options' => [
+          'label' => 'Video ratio',
+					'value_options' => Module::RATIOS,
+      ],
+		]);
+
+	}
+}
diff --git a/src/Media/Ingester/ArchiveOrgMediaIngester.php b/src/Media/Ingester/ArchiveOrgMediaIngester.php
new file mode 100644
index 0000000..8801982
--- /dev/null
+++ b/src/Media/Ingester/ArchiveOrgMediaIngester.php
@@ -0,0 +1,49 @@
+<?php
+namespace ArchiveOrg\Media\Ingester;
+
+use Omeka\Api\Request;
+use Omeka\Entity\Media;
+use Omeka\Media\Ingester\IngesterInterface;
+use Omeka\Stdlib\ErrorStore;
+use Zend\Form\Element\Text;
+use Zend\Http\Client;
+use Zend\View\Renderer\PhpRenderer;
+
+class ArchiveOrgMediaIngester implements IngesterInterface
+{
+    protected $client;
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+    public function getLabel()
+    {
+        return 'Archive.org media'; // @translate
+    }
+    public function getRenderer()
+    {
+        return 'ArchiveOrg_media';
+    }
+    public function form(PhpRenderer $view, array $options = [])
+    {
+        $input = new Text('o:media[__index__][o:identifier]');
+        $input->setOptions([
+            'label' => 'Indentifier', // @translate
+        ]);
+        $input->setAttributes([
+            'required' => true,
+        ]);
+        return $view->formRow($input);
+    }
+    public function ingest(Media $media, Request $request, ErrorStore $errorStore)
+    {
+        // Validate the request data.
+        $data = $request->getContent();
+        if (!isset($data['o:identifier'])) {
+            $errorStore->addError('o:identifier', 'No identifier specified');
+            return;
+        }
+        $url = 'https://archive.org/embed/' . $data['o:identifier'];
+        $media->setSource($url);
+    }
+}
diff --git a/src/Media/Renderer/ArchiveOrgMediaRenderer.php b/src/Media/Renderer/ArchiveOrgMediaRenderer.php
new file mode 100644
index 0000000..337c50f
--- /dev/null
+++ b/src/Media/Renderer/ArchiveOrgMediaRenderer.php
@@ -0,0 +1,23 @@
+<?php
+namespace ArchiveOrg\Media\Renderer;
+
+use Omeka\Api\Representation\MediaRepresentation;
+use Omeka\Media\Renderer\RendererInterface;
+use Zend\View\Renderer\PhpRenderer;
+
+class ArchiveOrgMediaRenderer implements RendererInterface
+{
+    public function render(PhpRenderer $view,
+                           MediaRepresentation $media,
+                           array $options = [])
+    {
+      $url = $media->source();
+      $html = '<iframe ';
+      $html .= 'src="' . $url . '" ';
+      $html .= 'frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen>';
+      $html .= '</iframe>';
+      return $html;
+
+      //return $media->mediaData()['html'];
+    }
+}
diff --git a/src/Service/BlockLayout/ArchiveOrgFactory.php b/src/Service/BlockLayout/ArchiveOrgFactory.php
new file mode 100644
index 0000000..6345ae3
--- /dev/null
+++ b/src/Service/BlockLayout/ArchiveOrgFactory.php
@@ -0,0 +1,18 @@
+<?php
+namespace ArchiveOrg\Service\BlockLayout;
+
+use Interop\Container\ContainerInterface;
+use ArchiveOrg\Site\BlockLayout\ArchiveOrg;
+use Laminas\ServiceManager\Factory\FactoryInterface;
+
+class ArchiveOrgFactory implements FactoryInterface
+{
+	public function __invoke(ContainerInterface $services, $requestedName, array $options = null)
+	{
+		return new ArchiveOrg(
+			$services->get('FormElementManager'),
+			$services->get('Config')['DefaultSettings']['ArchiveOrgBlockForm']
+		);
+	}
+}
+?>
\ No newline at end of file
diff --git a/src/Service/Media/Ingester/ArchiveOrgMediaFactory.php b/src/Service/Media/Ingester/ArchiveOrgMediaFactory.php
new file mode 100644
index 0000000..63df9a2
--- /dev/null
+++ b/src/Service/Media/Ingester/ArchiveOrgMediaFactory.php
@@ -0,0 +1,16 @@
+<?php
+namespace ArchiveOrg\Service\Media\Ingester;
+
+use ArchiveOrg\Media\Ingester\ArchiveOrgMediaIngester;
+use Zend\ServiceManager\Factory\FactoryInterface;
+use Interop\Container\ContainerInterface;
+
+class ArchiveOrgMediaFactory implements FactoryInterface
+{
+    public function __invoke(ContainerInterface $services,
+                             $requestedName,
+                             array $options = null)
+    {
+        return new ArchiveOrgMediaIngester($services->get('Omeka\HttpClient'));
+    }
+}
diff --git a/src/Site/BlockLayout/ArchiveOrg.php b/src/Site/BlockLayout/ArchiveOrg.php
new file mode 100644
index 0000000..cc879bc
--- /dev/null
+++ b/src/Site/BlockLayout/ArchiveOrg.php
@@ -0,0 +1,89 @@
+<?php
+namespace ArchiveOrg\Site\BlockLayout;
+
+use Omeka\Api\Representation\SiteRepresentation;
+use Omeka\Api\Representation\SitePageRepresentation;
+use Omeka\Api\Representation\SitePageBlockRepresentation;
+use Omeka\Site\BlockLayout\AbstractBlockLayout;
+use Laminas\View\Renderer\PhpRenderer;
+
+use Laminas\Form\FormElementManager;
+
+use ArchiveOrg\Form\ArchiveOrgBlockForm;
+
+class ArchiveOrg extends AbstractBlockLayout
+{
+	/**
+     * @var FormElementManager
+     */
+    protected $formElementManager;
+
+    /**
+     * @var array
+     */
+	protected $defaultSettings = [];
+
+    /**
+     * @param FormElementManager $formElementManager
+     * @param array $defaultSettings
+     */
+    public function __construct(FormElementManager $formElementManager, array $defaultSettings)
+    {
+        $this->formElementManager = $formElementManager;
+        $this->defaultSettings = $defaultSettings;
+    }
+
+	public function getLabel() {
+		return 'Archive.org media';
+	}
+
+	public function form(PhpRenderer $view,
+                       SiteRepresentation $site,
+                       SitePageRepresentation $page = null,
+                       SitePageBlockRepresentation $block = null
+    ) {
+		$form = $this->formElementManager->get(ArchiveOrgBlockForm::class);
+		$data = $block
+			? $block->data() + $this->defaultSettings
+			: $this->defaultSettings;
+		$form->setData([
+			'o:block[__blockIndex__][o:data][media_type]' => $data['media_type'],
+			'o:block[__blockIndex__][o:data][title]' => $data['title'],
+			'o:block[__blockIndex__][o:data][width]' => $data['width'],
+			'o:block[__blockIndex__][o:data][ratio]' => $data['ratio'],
+		]);
+		$form->prepare();
+
+		$html = '';
+		$html .= $view->blockAttachmentsForm($block);
+		$html .= '<a href="#" class="collapse" aria-label="collapse"><h4>' . $view->translate('Options'). '</h4></a>';
+		$html .= '<div class="collapsible" style="padding-top:6px;">';
+		$html .= $view->formCollection($form);
+    $html .= '</div>';
+		return $html;
+    }
+
+	public function render(PhpRenderer $view, SitePageBlockRepresentation $block)
+	{
+		$attachments = $block->attachments();
+        if (!$attachments) {
+            return '';
+		}
+
+    $thumbnails = [];
+		static $id = 0;
+
+    $media = $attachments[0]->item()->media()[0];
+    $width = $block->dataValue('width');
+    $height = $width / $block->dataValue('ratio');
+		return $view->partial('common/block-layout/archiveOrg', [
+			'media_type' => $block->dataValue('media_type'),
+			'title' => $block->dataValue('title'),
+			'width' => $width,
+			'height' => $height,
+			'url' => $media->source(),
+      'id' => 'achive_org-' . ++$id,
+      'thumbnails' => $thumbnails,
+		]);
+	}
+}
diff --git a/view/common/block-layout/archiveOrg.phtml b/view/common/block-layout/archiveOrg.phtml
new file mode 100644
index 0000000..2b5cdf2
--- /dev/null
+++ b/view/common/block-layout/archiveOrg.phtml
@@ -0,0 +1,43 @@
+<div class="pannemmul-wrap" style="position:relative;">
+
+	<?php
+		if ($title !== false && $title !== "") {
+			$title = sprintf('<p id="panorama-viewer-title">%s</p>', $title);
+		} else {
+			$title = false;
+		}
+	?>
+
+	<style>
+		#<?= $id ?> {
+			height: <?= $height ?>px;
+			width: <?= $width ?>px;
+		}
+	</style>
+
+	<div class="pannellum-wrap">
+	<?php if ($media_type == "video") { ?>
+
+		<iframe
+			id="<?= $id ?>"
+			src="<?= $url ?>"
+			frameborder="0"
+			webkitallowfullscreen="true"
+			mozallowfullscreen="true"
+			allowfullscreen >;
+		</iframe>
+
+	<?php } ?>
+	<?php if ($media_type == "audio") { ?>
+
+		<iframe
+			src="<?= $url ?>"
+			frameborder="0"
+			webkitallowfullscreen="true"
+			mozallowfullscreen="true"
+			allowfullscreen >;
+		</iframe>
+
+	<?php } ?>
+
+</div>