Merge pull request #9 from devianl2/revert-8-revert-7-main

Revert "Revert "Improve SCORM disk storage handler""

Author: devianl2

README.md

@@ -32,8 +32,42 @@ php artisan vendor:publish --provider="Peopleaps\Scorm\ScormServiceProvider"
 ```
 
 ## Step 3:
+Run config cache for update cached configuration
+```sh
+php artisan config:cache
+```
+
+## Step 4:
 Migrate file to database
 ```sh
 php artisan migrate
 ```
 
+## Step 5 (Optional):
+update SCORM config under config/scorm
+- update scorm table names.
+- update SCORM disk and configure disk @see config/filesystems.php
+```
+    'disk'  =>  'scorm-local',
+    'disk'  =>  'scorm-s3',
+
+ // @see config/filesystems.php
+     'disks' => [
+         .....
+         'scorm-local' => [
+            'driver'     => 'local',
+            'root'       =>  env('SCORM_ROOT_DIR'), // set root dir
+            'visibility' => 'public',
+        ],
+
+        's3-scorm' => [
+            'driver' => 's3',
+            'root'   => env('SCORM_ROOT_DIR'), // set root dir
+            'key'    => env('AWS_ACCESS_KEY_ID'),
+            'secret' => env('AWS_SECRET_ACCESS_KEY'),
+            'region' => env('AWS_DEFAULT_REGION'),
+            'bucket' => env('AWS_SCORM_BUCKET'),
+        ],
+        .....
+     ]
+```

config/scorm.php

@@ -3,11 +3,25 @@
 return [
 
     'table_names' =>  [
-        'user_table'   =>  'users',
+        'user_table'   =>  'users', // user table name on main LMS app.
         'scorm_table'   =>  'scorm',
         'scorm_sco_table'   =>  'scorm_sco',
         'scorm_sco_tracking_table'   =>  'scorm_sco_tracking',
     ],
-    // Scorm directory. You may create a custom path in file system
+    /**
+     * Scorm directory. You may create a custom path in file system
+     * Define Scorm disk under @see config/filesystems.php
+     * 'disk'  =>  'local',
+     * 'disk'  =>  's3-scorm',
+     * ex.
+     * 's3-scorm' => [
+     * 'driver' => 's3',
+     * 'root'   => env('SCORM_ROOT_DIR'),  // define root dir
+     * 'key'    => env('AWS_ACCESS_KEY_ID'),
+     * 'secret' => env('AWS_SECRET_ACCESS_KEY'),
+     * 'region' => env('AWS_DEFAULT_REGION'),
+     * 'bucket' => env('AWS_SCORM_BUCKET'),
+     * ],
+     */
     'disk'  =>  'local',
 ];

database/migrations/create_scorm_tables.php.stub

@@ -97,19 +97,7 @@ class CreateScormTables extends Migration
      */
     public function down()
     {
-        $tableNames = config('scorm_sco_tracking_table');
-
-        if (empty($tableNames)) {
-            throw new \Exception('Error: Table not found.');
-        }
-
-        $tableNames = config('scorm_sco_table');
-
-        if (empty($tableNames)) {
-            throw new \Exception('Error: Table not found.');
-        }
-
-        $tableNames = config('scorm_table');
+        $tableNames = config('scorm.table_names');
 
         if (empty($tableNames)) {
             throw new \Exception('Error: Table not found.');

src/Entity/Scorm.php

@@ -3,18 +3,16 @@
 
 namespace Peopleaps\Scorm\Entity;
 
-
-use Doctrine\Common\Collections\ArrayCollection;
-
 class Scorm
 {
     const SCORM_12 = 'scorm_12';
     const SCORM_2004 = 'scorm_2004';
 
     public $uuid;
     public $id;
+    public $title;
     public $version;
-    public $hashName;
+    public $entryUrl;
     public $ratio = 56.25;
     public $scos;
     public $scoSerializer;
@@ -70,17 +68,33 @@ public function setVersion($version)
     /**
      * @return string
      */
-    public function getHashName()
+    public function getTitle()
+    {
+        return $this->title;
+    }
+
+    /**
+     * @param string $title
+     */
+    public function setTitle($title)
+    {
+        $this->title = $title;
+    }
+
+    /**
+     * @return string
+     */
+    public function getEntryUrl()
     {
-        return $this->hashName;
+        return $this->entryUrl;
     }
 
     /**
-     * @param string $hashName
+     * @param string $title
      */
-    public function setHashName($hashName)
+    public function setEntryUrl($entryUrl)
     {
-        $this->hashName = $hashName;
+        $this->entryUrl = $entryUrl;
     }
 
     /**
@@ -131,7 +145,8 @@ public function serialize(Scorm $scorm)
         return [
             'id' => $scorm->getUuid(),
             'version' => $scorm->getVersion(),
-            'hashName' => $scorm->getHashName(),
+            'title' => $scorm->getTitle(),
+            'entryUrl' => $scorm->getEntryUrl(),
             'ratio' => $scorm->getRatio(),
             'scos' => $this->serializeScos($scorm),
         ];

src/Library/ScormLib.php

@@ -7,7 +7,7 @@
 use DOMDocument;
 use Peopleaps\Scorm\Entity\Sco;
 use Peopleaps\Scorm\Exception\InvalidScormArchiveException;
-use Ramsey\Uuid\Uuid;
+use Illuminate\Support\Str;
 
 class ScormLib
 {
@@ -28,16 +28,20 @@ public function parseOrganizationsNode(DOMDocument $dom)
             $organizations = $organizationsList->item(0);
             $organization = $organizations->firstChild;
 
-            if (!is_null($organizations->attributes)
-                && !is_null($organizations->attributes->getNamedItem('default'))) {
+            if (
+                !is_null($organizations->attributes)
+                && !is_null($organizations->attributes->getNamedItem('default'))
+            ) {
                 $defaultOrganization = $organizations->attributes->getNamedItem('default')->nodeValue;
             } else {
                 $defaultOrganization = null;
             }
             // No default organization is defined
             if (is_null($defaultOrganization)) {
-                while (!is_null($organization)
-                    && 'organization' !== $organization->nodeName) {
+                while (
+                    !is_null($organization)
+                    && 'organization' !== $organization->nodeName
+                ) {
                     $organization = $organization->nextSibling;
                 }
 
@@ -48,10 +52,12 @@ public function parseOrganizationsNode(DOMDocument $dom)
             // A default organization is defined
             // Look for it
             else {
-                while (!is_null($organization)
+                while (
+                    !is_null($organization)
                     && ('organization' !== $organization->nodeName
                         || is_null($organization->attributes->getNamedItem('identifier'))
-                        || $organization->attributes->getNamedItem('identifier')->nodeValue !== $defaultOrganization)) {
+                        || $organization->attributes->getNamedItem('identifier')->nodeValue !== $defaultOrganization)
+                ) {
                     $organization = $organization->nextSibling;
                 }
 
@@ -82,7 +88,7 @@ private function parseItemNodes(\DOMNode $source, \DOMNodeList $resources, Sco $
             if ('item' === $item->nodeName) {
                 $sco = new Sco();
                 $scos[] = $sco;
-                $sco->setUuid(Uuid::uuid4());
+                $sco->setUuid(Str::uuid());
                 $sco->setScoParent($parentSco);
                 $this->findAttrParams($sco, $item, $resources);
                 $this->findNodeParams($sco, $item->firstChild);
@@ -119,7 +125,7 @@ private function parseResourceNodes(\DOMNodeList $resources)
                         throw new InvalidScormArchiveException('sco_resource_without_href_message');
                     }
                     $sco = new Sco();
-                    $sco->setUuid(Uuid::uuid4());
+                    $sco->setUuid(Str::uuid());
                     $sco->setBlock(false);
                     $sco->setVisible(true);
                     $sco->setIdentifier($identifier->nodeValue);
@@ -195,10 +201,12 @@ private function findNodeParams(Sco $sco, \DOMNode $item)
                 case 'adlcp:timeLimitAction':
                     $action = strtolower($item->nodeValue);
 
-                    if ('exit,message' === $action
+                    if (
+                        'exit,message' === $action
                         || 'exit,no message' === $action
                         || 'continue,message' === $action
-                        || 'continue,no message' === $action) {
+                        || 'continue,no message' === $action
+                    ) {
                         $sco->setTimeLimitAction($action);
                     }
                     break;

src/Manager/ScormDisk.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Peopleaps\Scorm\Manager;
+
+use Illuminate\Filesystem\FilesystemAdapter;
+use Illuminate\Support\Facades\Storage;
+use Peopleaps\Scorm\Exception\StorageNotFoundException;
+use ZipArchive;
+
+class ScormDisk
+{
+    /**
+     * Extract zip file into destination directory.
+     *
+     * @param string $path Destination directory
+     * @param string $zipFilePath The path to the zip file.
+     *
+     * @return bool True on success, false on failure.
+     */
+    public function unzip($file, $path)
+    {
+        $path = $this->cleanPath($path);
+
+        $zipArchive = new ZipArchive();
+        if ($zipArchive->open($file) !== true) {
+            return false;
+        }
+
+        /** @var FilesystemAdapter $disk */
+        $disk = $this->getDisk();
+
+        for ($i = 0; $i < $zipArchive->numFiles; ++$i) {
+            $zipEntryName = $zipArchive->getNameIndex($i);
+            $destination = $path . DIRECTORY_SEPARATOR . $this->cleanPath($zipEntryName);
+            if ($this->isDirectory($zipEntryName)) {
+                $disk->createDir($destination);
+                continue;
+            }
+            $disk->putStream($destination, $zipArchive->getStream($zipEntryName));
+        }
+
+        return true;
+    }
+
+    /**
+     * @param string $directory
+     * @return bool
+     */
+    public function deleteScormFolder($folderHashedName)
+    {
+        return $this->getDisk()->deleteDirectory($folderHashedName);
+    }
+
+    private function isDirectory($zipEntryName)
+    {
+        return substr($zipEntryName, -1) ===  '/';
+    }
+
+    private function cleanPath($path)
+    {
+        return str_replace('/', DIRECTORY_SEPARATOR, $path);
+    }
+
+    /**
+     * @return FilesystemAdapter $disk
+     */
+    private function getDisk()
+    {
+        if (!config()->has('filesystems.disks.' . config('scorm.disk'))) {
+            throw new StorageNotFoundException('scorm_disk_not_define');
+        }
+        return Storage::disk(config('scorm.disk'));
+    }
+}