MED-110: Improve library interface

bdecentgmbh · Oct 14, 2024 · 151ecfd · 151ecfd
1 parent 3f8978d
commit 151ecfd
Show file tree

Hide file tree

Showing 11 changed files with 167 additions and 51 deletions.
diff --git a/classes/media_manager.php b/classes/media_manager.php
@@ -24,6 +24,7 @@
 
 namespace tool_mediatime;
 
+use block_contents;
 use context_system;
 use core_tag_tag;
 use core_tag_area;
@@ -104,6 +105,7 @@ public function __construct(string $source, ?stdClass $record = null, int $page
                     $this->media[] = $media;
                 }
             }
+            $this->setup_page();
 
             $rs->close();
         }
@@ -133,6 +135,7 @@ public function export_for_template(renderer_base $output): array {
         foreach ($this->media as $record) {
             $resource = new output\media_resource($record);
             $url = new moodle_url('/admin/tool/mediatime/index.php', ['id' => $record->id]);
+            $editurl = new moodle_url('/admin/tool/mediatime/index.php', ['edit' => $record->id]);
             $removeurl = new moodle_url('/admin/tool/mediatime/index.php', ['delete' => $record->id]);
             $media[] = [
                 'imageurl' => $resource->image_url($output),
@@ -141,33 +144,13 @@ public function export_for_template(renderer_base $output): array {
                 'name' => $record->name,
                 'title' => $resource->get_title(),
                 'description' => shorten_text(json_decode($record->content)->description ?? '', 80),
+                'editurl' => $editurl->out(),
                 'removeurl' => $removeurl->out(),
             ];
         }
 
-        $plugins = \core_plugin_manager::instance()->get_installed_plugins('mediatimesrc');
-
-        $options = [];
-        foreach (plugininfo\mediatimesrc::get_enabled_plugins() as $plugin) {
-            $options[$plugin] = get_string("pluginname", "mediatimesrc_$plugin");
-        }
-        if (!has_capability('tool/mediatime:manage', context_system::instance())) {
-            $action = '';
-        } else if (count($options) == 1) {
-            $button = new single_button(new moodle_url('/admin/tool/mediatime/index.php', [
-                'source' => array_keys($options)[0],
-            ]), get_string('addnewcontent', 'tool_mediatime'));
-            $action = $output->render($button);
-        } else if (count($options)) {
-            $select = new single_select(new moodle_url('/admin/tool/mediatime/index.php'), 'source', $options);
-            $action = get_string('addnewcontent', 'tool_mediatime') . ' ' . $output->render($select);
-        } else {
-            $action = '';
-        }
         return [
-            'action' => $action,
             'media' => array_values($media),
-            'search' => $this->search->render(),
         ];
     }
 
@@ -219,4 +202,45 @@ public static function search($filters = []) {
             $order
         );
     }
+
+    /**
+     * Add the search block to default region
+     *
+     * @param   stdClass    $instance   Video Time instance
+     * @param   stdClass    $cm         The course module
+     */
+    protected function setup_page() {
+        global $OUTPUT, $PAGE, $USER;
+
+        $bc = new block_contents();
+        $bc->title = get_string('sharedvideo', 'videotimeplugin_live');
+        $bc->attributes['class'] = 'block block_book_toc';
+
+        $plugins = \core_plugin_manager::instance()->get_installed_plugins('mediatimesrc');
+
+        $options = [];
+        foreach (plugininfo\mediatimesrc::get_enabled_plugins() as $plugin) {
+            $options[$plugin] = get_string("pluginname", "mediatimesrc_$plugin");
+        }
+        if (!has_capability('tool/mediatime:manage', context_system::instance())) {
+            $action = '';
+        } else if (count($options) == 1) {
+            $button = new single_button(new moodle_url('/admin/tool/mediatime/index.php', [
+                'source' => array_keys($options)[0],
+            ]), get_string('addnewcontent', 'tool_mediatime'));
+            $action = $OUTPUT->render($button);
+        } else if (count($options)) {
+            $select = new single_select(new moodle_url('/admin/tool/mediatime/index.php'), 'source', $options);
+            $action = get_string('addnewcontent', 'tool_mediatime') . ' ' . $OUTPUT->render($select);
+        } else {
+            $action = '';
+        }
+        $bc->content = $OUTPUT->render_from_template('tool_mediatime/block_content', [
+            'action' => $action,
+            'search' => $this->search->render(),
+        ]);
+
+        $defaultregion = $PAGE->blocks->get_default_region();
+        $PAGE->blocks->add_fake_block($bc, $defaultregion);
+    }
 }
diff --git a/classes/output/media_resource.php b/classes/output/media_resource.php
@@ -64,10 +64,14 @@ public function __construct(stdClass $record) {
     public function export_for_template(renderer_base $output) {
         global $DB, $USER;
         $context = \context_system::instance();
+        $editurl = new moodle_url('/admin/tool/mediatime/index.php', ['edit' => $this->record->id]);
+        $removeurl = new moodle_url('/admin/tool/mediatime/index.php', ['delete' => $this->record->id]);
 
         return [
             'canedit' => has_capability('tool/mediatime:manage', $context) || ($USER->id == $this->record->usermodified),
             'id' => $this->record->id,
+            'editurl' => $editurl->out(),
+            'removeurl' => $removeurl->out(),
             'libraryhome' => new moodle_url('/admin/tool/mediatime/index.php'),
             'resource' => $output->render($this->resource),
             'tags' => $this->tags($output),

diff --git a/lang/en/tool_mediatime.php b/lang/en/tool_mediatime.php
@@ -26,12 +26,14 @@
 defined('MOODLE_INTERNAL') || die();
 
 $string['addnewcontent'] = 'Add new content';
+$string['editresource'] = 'Edit resource';
 $string['event_resource_created'] = 'Resource created';
 $string['event_resource_deleted'] = 'Resource deleted';
 $string['event_resource_updated'] = 'Resource updated';
 $string['filelinks'] = 'File links';
 $string['keyword'] = 'Keyword';
 $string['library'] = 'Library';
+$string['libraryhome'] = 'Back to library';
 $string['managemediatimesrcplugins'] = 'Manage source plugins';
 $string['mediatime:create'] = 'Create media in library';
 $string['mediatime:manage'] = 'Manage media in library';
@@ -43,6 +45,8 @@
 $string['privacy:metadata:tool_mediatime:timecreated'] = 'Time created';
 $string['privacy:metadata:tool_mediatime:timemodified'] = 'Time modified';
 $string['privacy:metadata:tool_mediatime:usermodified'] = 'User modified';
+$string['removeresource'] = 'Remove resource';
+$string['resourcemanagementoptions'] = 'Resource management options';
 $string['resourcename'] = 'Resource name';
 $string['resourcename_help'] = 'The name for a resource is used internally in the library to identify the resource, but not displayed when it is used.';
 $string['subplugintype_mediatimesrc'] = 'Media Time source';

diff --git a/source/streamio/classes/output/media_resource.php b/source/streamio/classes/output/media_resource.php
@@ -68,6 +68,8 @@ public function export_for_template(renderer_base $output) {
         global $DB, $USER;
         $context = \context_system::instance();
         $videourl = $this->video_url($output);
+        $editurl = new moodle_url('/admin/tool/mediatime/index.php', ['edit' => $this->record->id]);
+        $removeurl = new moodle_url('/admin/tool/mediatime/index.php', ['delete' => $this->record->id]);
 
         $content = [
             'elementid' => 'video-' . uniqid(),
@@ -87,6 +89,8 @@ public function export_for_template(renderer_base $output) {
         return [
             'canedit' => has_capability('tool/mediatime:manage', $context) || ($USER->id == $this->record->usermodified),
             'id' => $this->record->id,
+            'editurl' => $editurl->out(),
+            'removeurl' => $removeurl->out(),
             'libraryhome' => new moodle_url('/admin/tool/mediatime/index.php'),
             'resource' => $this->content,
             'video' => $output->render_from_template('mediatimesrc_streamio/video', $content),

diff --git a/source/streamio/templates/media_resource.mustache b/source/streamio/templates/media_resource.mustache
@@ -35,21 +35,4 @@
     }
 
 }}
-<div class="library-resource">
-    <form action="." method="post">
-       {{# canedit }}
-           <input type="hidden" name="source" value="streamio">
-           <button type="submit" name="edit" value="{{ id }}">{{# str }} edit {{/ str }}</button>
-           <button type="submit" name="delete" value="{{ id }}">{{# str }} delete {{/ str }}</button>
-       {{/ canedit }}
-       {{# libraryhome }}
-       <a href="{{ libraryhome }}">{{# str }}library, tool_mediatime {{/ str }}</a>
-       {{/ libraryhome }}
-    </form>
-    <div class="container-fluid">
-        <h3>{{ resource.name }}</h3>
-        <h4>{{ resource.title }}</h4>
-            {{{ video }}}
-        <p>{{ resource.description }}</p>
-    </div>
-</div>
+{{> tool_mediatime/media_resource }}
diff --git a/source/vimeo/classes/external/create_token.php b/source/vimeo/classes/external/create_token.php
@@ -107,7 +107,7 @@ public static function execute($description, $filesize, $name, $tags, $title): a
                 'tool_mediatime',
                 $id,
                 $context,
-                json_decode(htmlspecialchars_decode($params['tags']))
+                json_decode(htmlspecialchars_decode($params['tags'], ENT_COMPAT))
             );
         }
 

diff --git a/source/vimeo/classes/manager.php b/source/vimeo/classes/manager.php
@@ -266,7 +266,7 @@ public function export_for_template(renderer_base $output) {
                     'name' => json_encode($data->name),
                     'description' => json_encode($data->description),
                     'title' => json_encode($data->title),
-                    'tags' => htmlspecialchars(json_encode($data->tags)),
+                    'tags' => htmlspecialchars(json_encode($data->tags), ENT_COMPAT),
                 ]),
             ];
         }

diff --git a/templates/block_content.mustache b/templates/block_content.mustache
@@ -0,0 +1,40 @@
+{{!
+    This file is part of Moodle - http://moodle.org/
+
+    Moodle 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.
+
+    Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+}}
+{{!
+    @template tool_mediatime/media_manager
+
+    This template will render the Media manager for media time
+
+    Variables required for this template:
+
+    Variables optional for this template:
+
+    Example context (json):
+    {
+    }
+
+}}
+<div class="container-fluid">
+    <div class="row">
+        <div class="col col-12 col-lg-3">
+            {{{ action }}}
+        </div>
+        <div class="col col-12{{# action }} col-lg-9{{/ action }}">
+            {{{ search }}}
+        </div>
+    </div>
+</div>
diff --git a/templates/dropdown.mustache b/templates/dropdown.mustache
@@ -0,0 +1,40 @@
+{{!
+    This file is part of Moodle - http://moodle.org/
+
+    Moodle 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.
+
+    Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+}}
+{{!
+    @template tool_mediatime/dropdown
+
+    Simple dropdown for the tool_mediatime library page
+
+    Example context (json):
+    {
+        "editurl": "https://moodle.test/tool/admin/mediatime/index.php?edit=1",
+        "removeurl": "https://moodle.test/tool/admin/mediatime/index.php?delete=1"
+    }
+}}
+<div class="btn-group float-right">
+    <a href="#" class="btn btn-link btn-icon icon-size-3 rounded-circle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false" title="{{# str }} resourcemanagementoptions, tool_mediatime {{/ str }}">
+        <i class="fa fa-ellipsis-v text-dark  py-2" aria-hidden="true"></i>
+    </a>
+    <div class="dropdown-menu dropdown-menu-right">
+        {{# editurl }}
+            <a class="dropdown-item" href="{{ editurl }}">{{#str}} editresource , tool_mediatime {{/str}}</a>
+        {{/ editurl }}
+        {{# removeurl }}
+            <a class="dropdown-item" href="{{ removeurl }}">{{#str}} removeresource, tool_mediatime {{/str}}</a>
+        {{/ removeurl }}
+    </div>
+</div>
diff --git a/templates/media_manager.mustache b/templates/media_manager.mustache
@@ -53,12 +53,14 @@
                     </div>
                     <div class="card-footer">
                         {{# name }}
-                            {{ name }}
+                            <a href="{{ url }}" class="btn">
+                                <i class="fa fa-play"></i> {{ name }}
+                            </a>
                         {{/ name }}
                         {{^ name }}
                             {{ title }}
                         {{/ name }}
-                        <a href="{{ removeurl }}" class="float-right"><i class="icon fa fa-trash"></i></a>
+                        {{> tool_mediatime/dropdown }}
                     </div>
                 </div>
             </div>

diff --git a/templates/media_resource.mustache b/templates/media_resource.mustache
@@ -25,16 +25,31 @@
 
     Example context (json):
     {
+       "canedit": true,
+       "id": 2,
+       "resource": {
+           "title": "title",
+           "name": "name",
+           "description": "big and blue"
+       }
     }
 
 }}
-<form action='.' method="post">
-   {{# canedit }}
-       <button type="submit" name="edit" value="{{ id }}">{{# str }} edit {{/ str }}</button>
-       <button type="submit" name="delete" value="{{ id }}">{{# str }} delete {{/ str }}</button>
-   {{/ canedit }}
-   <a href="{{ libraryhome }}">{{# str }}library, tool_mediatime {{/ str }}</a>
-</form>
 <div class="library-resource">
-    {{{ resource }}}
+    <form action="." method="post">
+       {{# canedit }}
+           {{> tool_mediatime/dropdown }}
+       {{/ canedit }}
+       {{# libraryhome }}
+       <button action="{{ libraryhome }}" class="float-right"><i class="fa fa-angle-double-left"></i>{{# str }}libraryhome, tool_mediatime {{/ str }}</button>
+       {{/ libraryhome }}
+    </form>
+    <div class="container-fluid">
+        {{$ resourcecontent }}
+        <h3>{{ resource.name }}</h3>
+        <h4>{{ resource.title }}</h4>
+            {{{ video }}}
+        <p>{{ resource.description }}</p>
+        {{/ resourcecontent }}
+    </div>
 </div>