Feat/upgrade to h5p core 1.28

sourcecode/apis/contentauthor/.gitignore

@@ -42,3 +42,8 @@ buildid
 test-storage-volume/
 /storage/framework/testing/
 /tools/vapor-cli/vendor
+
+.junie
+.ai
+boost.json
+AGENTS.md

sourcecode/apis/contentauthor/app/Console/Commands/H5PClearCachedAssets.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Console\Commands;
+
+use App\H5PLibrariesCachedAssets;
+use App\Libraries\DataObjects\ContentStorageSettings;
+use H5PFileStorage;
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Console\Isolatable;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Storage;
+use Symfony\Component\Console\Command\Command as SymfonyCommand;
+
+class H5PClearCachedAssets extends Command implements Isolatable
+{
+    public const string CACHE_KEY_RUNNING = 'h5p_clearing_cached_assets';
+    public const int CACHE_KEY_RUNNING_TTL = 1 * 60;
+
+    /**
+     * Clear the running cache key and command isolation mutex.
+     */
+    public static function clearLock(): void
+    {
+        Cache::forget(self::CACHE_KEY_RUNNING);
+
+        try {
+            $mutex = resolve(\Illuminate\Console\CommandMutex::class);
+            $command = resolve(self::class);
+            $mutex->forget($command);
+        } catch (\Throwable) {
+        }
+    }
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'h5p:clear-cached-assets {--unlock : Remove the running lock without deleting assets}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Delete aggregated library assets, they will be regenerated on demand';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(H5PFileStorage $storage): int
+    {
+        if ($this->option('unlock')) {
+            self::clearLock();
+            $this->info('Deletion lock has been removed.');
+
+            return SymfonyCommand::SUCCESS;
+        }
+
+        Cache::put(self::CACHE_KEY_RUNNING, true, now()->addMinutes(self::CACHE_KEY_RUNNING_TTL));
+
+        try {
+            $hashes = H5PLibrariesCachedAssets::distinct()->pluck('hash')->all();
+            $storage->deleteCachedAssets($hashes);
+            H5PLibrariesCachedAssets::query()->delete();
+
+            // Files without a matching row will never be regenerated, so get rid of
+            // those as well.
+            $disk = Storage::disk();
+            $orphans = 0;
+            foreach ($disk->files(ContentStorageSettings::CACHEDASSETS_DIR) as $file) {
+                $disk->delete($file);
+                $orphans++;
+            }
+
+            $this->line(sprintf(
+                'Deleted <fg=yellow>%d</> cached asset bundle(s), <fg=yellow>%d</> file(s) removed.',
+                count($hashes),
+                $orphans,
+            ));
+        } finally {
+            Cache::forget(self::CACHE_KEY_RUNNING);
+        }
+
+        return SymfonyCommand::SUCCESS;
+    }
+}

sourcecode/apis/contentauthor/app/H5PContent.php

@@ -39,6 +39,8 @@
  * @property string $language_iso_639_3
  * @property ?int $max_score
  * @property int $bulk_calculated
+ * @property bool $modify_css
+ * @property bool $modifyCss
  *
  * @property Collection<Collaborator> $collaborators
  * @property H5PLibrary $library
@@ -66,6 +68,7 @@ class H5PContent extends Content implements VersionableObject
     protected $casts = [
         'library_id' => "int",
         'is_draft' => 'boolean',
+        'modify_css' => 'boolean',
     ];
 
     protected $dispatchesEvents = [

sourcecode/apis/contentauthor/app/H5PLibrary.php

@@ -5,14 +5,15 @@
 use App\Observers\H5PLibraryObserver;
 use H5PFrameworkInterface;
 use Illuminate\Database\Eloquent\Attributes\ObservedBy;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\DB;
-use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Storage;
 
 /**
@@ -40,6 +41,7 @@
  * @property int $major_version
  * @property int $minor_version
  * @property int $patch_version
+ * @property string $version
  * @property int $runnable
  * @property int $restricted
  * @property int $fullscreen
@@ -337,7 +339,7 @@ public function getAddons()
             ->whereNotNull('l1.add_to')
             ->get()
             ->map(function ($addon) {
-                return (array) $addon;
+                return (array)$addon;
             })
             ->toArray();
     }
@@ -383,4 +385,16 @@ public static function canBeDeleted(int $libraryId, int|null $usageCount = null)
 
         return $usageCount === 0 && H5PContentLibrary::where('library_id', $libraryId)->doesntExist();
     }
+
+    protected function version(): Attribute
+    {
+        return Attribute::make(
+            get: fn(mixed $value, array $attributes) => $attributes['major_version'] . '.' . $attributes['minor_version'] . '.' . $attributes['patch_version'],
+        );
+    }
+
+    public function versionCompare(string $version, string $operation = '>='): bool
+    {
+        return version_compare($this->version, $version, $operation);
+    }
 }

sourcecode/apis/contentauthor/app/Http/Controllers/Admin/CachedFilesController.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Controllers\Admin;
+
+use App\Console\Commands\H5PClearCachedAssets;
+use App\H5PLibrariesCachedAssets;
+use App\Libraries\DataObjects\ContentStorageSettings;
+use Illuminate\Contracts\View\View;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Storage;
+
+final class CachedFilesController
+{
+    public function index(): View
+    {
+        $disk = Storage::disk();
+        $cachedFiles = $disk->files(ContentStorageSettings::CACHEDASSETS_DIR);
+        $cachedAssetRowsCount = H5PLibrariesCachedAssets::count();
+        $isJobRunning = Cache::has(H5PClearCachedAssets::CACHE_KEY_RUNNING);
+
+        return view('admin.cached-files.index', [
+            'cachedFilesCount' => count($cachedFiles),
+            'cachedAssetRowsCount' => $cachedAssetRowsCount,
+            'isJobRunning' => $isJobRunning,
+        ]);
+    }
+
+    public function delete(): RedirectResponse
+    {
+        Cache::put(H5PClearCachedAssets::CACHE_KEY_RUNNING, true, now()->addMinutes(H5PClearCachedAssets::CACHE_KEY_RUNNING_TTL));
+
+        Artisan::queue('h5p:clear-cached-assets');
+
+        return redirect(route('admin.cached-files.index'))
+            ->with('message', 'Cached files deletion has been queued.');
+    }
+
+    public function status(): JsonResponse
+    {
+        return response()->json([
+            'isRunning' => Cache::has(H5PClearCachedAssets::CACHE_KEY_RUNNING),
+        ]);
+    }
+
+    public function unlock(): RedirectResponse
+    {
+        H5PClearCachedAssets::clearLock();
+
+        return redirect(route('admin.cached-files.index'))
+            ->with('message', 'The deletion lock has been removed.');
+    }
+}

sourcecode/apis/contentauthor/app/Http/Controllers/H5PController.php

@@ -59,7 +59,6 @@
 use stdClass;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Throwable;
-
 use function app;
 use function config;
 use function request;
@@ -71,10 +70,11 @@ class H5PController extends Controller
     private string $viewDataCacheName = 'viewData-';
 
     public function __construct(
-        private Lti $lti,
-        private h5p $h5p,
+        private Lti             $lti,
+        private h5p             $h5p,
         private H5PLibraryAdmin $h5pLibraryAdmin,
-    ) {
+    )
+    {
         $this->middleware('adaptermode', ['only' => ['show', 'edit', 'update', 'store', 'create']]);
         $this->middleware('core.return', ['only' => ['create', 'edit']]);
         $this->middleware('core.locale', ['only' => ['create', 'edit', 'store']]);
@@ -168,7 +168,8 @@ public function create(Request $request, H5PCore $core, $contenttype = null): Vi
         $editorSetup = H5PEditorConfigObject::create([
             'canList' => true,
             'showDisplayOptions' => config('h5p.showDisplayOptions'),
-            'useLicense' => config('feature.licensing') === true || config('feature.licensing') === '1',
+            'showModifyCss' => false, // New content always uses the default css
+            'modifyCss' => false,
             'adapterName' => config('feature.allow-mode-switch') === true ? $adapter->getAdapterName() : null,
             'adapterList' => $adapter::getAllAdapters(),
             'h5pLanguage' => Iso639p3::code2letters($language),
@@ -178,15 +179,15 @@ public function create(Request $request, H5PCore $core, $contenttype = null): Vi
         ]);
 
         $state = H5PStateDataObject::create($displayOptions + [
-            'library' => $contenttype,
-            'license' => License::getDefaultLicense(),
-            'isPublished' => $ltiRequest?->getPublished() ?? false,
-            'isShared' => $ltiRequest?->getShared() ?? false,
-            'language_iso_639_3' => $language,
-            'redirectToken' => $request->get('redirectToken'),
-            'route' => route('h5p.store'),
-            '_method' => "POST",
-        ])->toJson();
+                'library' => $contenttype,
+                'license' => License::getDefaultLicense(),
+                'isPublished' => $ltiRequest?->getPublished() ?? false,
+                'isShared' => $ltiRequest?->getShared() ?? false,
+                'language_iso_639_3' => $language,
+                'redirectToken' => $request->get('redirectToken'),
+                'route' => route('h5p.store'),
+                '_method' => "POST",
+            ])->toJson();
 
         return view(
             'h5p.create',
@@ -264,6 +265,8 @@ public function edit(Request $request, int $id): View
         $editorSetup = H5PEditorConfigObject::create([
             'canList' => $h5pContent->canList($request),
             'showDisplayOptions' => config('h5p.showDisplayOptions'),
+            'showModifyCss' => $adapter->showCustomCssForNewContentTypes($h5pContent),
+            'modifyCss' => $h5pContent->modify_css,
             'useLicense' => config('feature.licensing') === true || config('feature.licensing') === '1',
             'h5pLanguage' => $h5pLanguage,
             'editorLanguage' => Session::get('locale', config('app.fallback_locale')),
@@ -286,29 +289,29 @@ public function edit(Request $request, int $id): View
         $displayOptions['download'] = $displayOptions['export'];
 
         $editorSetup->setContentProperties(ResourceInfoDataObject::create([
-            'id' => (string) $content['id'],
+            'id' => (string)$content['id'],
             'createdAt' => $h5pContent->created_at->toIso8601String(),
             'type' => $library->getTitleAndVersionString(),
             'maxScore' => $library->supportsMaxScore() ? $h5pContent->max_score : null,
             'ownerName' => null,
         ]));
 
         $state = H5PStateDataObject::create($displayOptions + [
-            'id' => $h5pContent->id,
-            'library' => $library->getLibraryString(false),
-            'libraryid' => $h5pContent->library_id,
-            'parameters' => $params,
-            'language_iso_639_3' => $contentLanguage,
-            'title' => $h5pContent->title,
-            'license' => $h5pContent->license ?: License::getDefaultLicense(),
-            'isPublished' => $ltiRequest?->getPublished() ?? false,
-            'isDraft' => $h5pContent->isDraft(),
-            'isShared' => $ltiRequest?->getShared() ?? false,
-            'redirectToken' => $request->get('redirectToken'),
-            'route' => route('h5p.update', ['h5p' => $id]),
-            'max_score' => $h5pContent->max_score,
-            '_method' => "PUT",
-        ])->toJson();
+                'id' => $h5pContent->id,
+                'library' => $library->getLibraryString(false),
+                'libraryid' => $h5pContent->library_id,
+                'parameters' => $params,
+                'language_iso_639_3' => $contentLanguage,
+                'title' => $h5pContent->title,
+                'license' => $h5pContent->license ?: License::getDefaultLicense(),
+                'isPublished' => $ltiRequest?->getPublished() ?? false,
+                'isDraft' => $h5pContent->isDraft(),
+                'isShared' => $ltiRequest?->getShared() ?? false,
+                'redirectToken' => $request->get('redirectToken'),
+                'route' => route('h5p.update', ['h5p' => $id]),
+                'max_score' => $h5pContent->max_score,
+                '_method' => "PUT",
+            ])->toJson();
 
         return view(
             'h5p.edit',

sourcecode/apis/contentauthor/app/Http/Requests/H5PStorageRequest.php

@@ -7,7 +7,6 @@
 use App\H5PContent;
 use App\Rules\LicenseContent;
 use Illuminate\Foundation\Http\FormRequest;
-
 use function assert;
 
 class H5PStorageRequest extends FormRequest
@@ -25,6 +24,16 @@ protected function prepareForValidation(): void
                 'isShared' => $this->boolean('isShared'),
             ]);
         }
+
+        if ($this->has('modifyCss')) {
+            $this->merge([
+                'modifyCss' => $this->boolean('modifyCss'),
+            ]);
+        } else {
+            $this->merge([
+                'modifyCss' => false,
+            ]);
+        }
     }
 
     public function rules(): array
@@ -47,6 +56,7 @@ public function rules(): array
                 config('app.enable_licensing') ? 'string' : 'nullable',
                 new LicenseContent(),
             ],
+            'modifyCss' => ['sometimes', 'boolean'],
         ];
     }
 }

sourcecode/apis/contentauthor/app/Libraries/DataObjects/EditorConfigObject.php

@@ -13,6 +13,8 @@ class EditorConfigObject
 
     public $canList;
     public $useLicense = false;
+    public $showModifyCss = false;
+    public $modifyCss = false;
 
     protected $contentProperties;
 

sourcecode/apis/contentauthor/app/Libraries/H5P/Adapters/CerpusH5PAdapter.php

@@ -2,6 +2,7 @@
 
 namespace App\Libraries\H5P\Adapters;
 
+use App\H5PContent;
 use App\Libraries\H5P\Dataobjects\H5PAlterParametersSettingsDataObject;
 use App\Libraries\H5P\Interfaces\H5PAdapterInterface;
 use App\Libraries\H5P\Interfaces\H5PAudioInterface;
@@ -173,4 +174,9 @@ public function filterEditorScripts(): array
     {
         return [];
     }
+
+    public function showCustomCssForNewContentTypes(?H5PContent $h5pContent = null): bool
+    {
+        return false;
+    }
 }