From 561d80f2e590eb21d78bbf9b29ad21a4dcd9a181 Mon Sep 17 00:00:00 2001
From: "Abdulmhsen B. A. A." <admin@arabcoders.org>
Date: Fri, 7 Jun 2024 18:28:04 +0300
Subject: [PATCH] Add warning to history view if some backends aren't reporting
 the same item.

---
 frontend/pages/history/[id]/index.vue |  86 +++++++++++++++++---
 frontend/pages/history/index.vue      |  14 +++-
 frontend/utils/index.js               |  23 +++++-
 src/API/History/Index.php             | 113 ++++++++++++++++++++------
 4 files changed, 193 insertions(+), 43 deletions(-)

diff --git a/frontend/pages/history/[id]/index.vue b/frontend/pages/history/[id]/index.vue
index b107e87f..0943c234 100644
--- a/frontend/pages/history/[id]/index.vue
+++ b/frontend/pages/history/[id]/index.vue
@@ -35,6 +35,31 @@
       </Message>
     </div>
 
+    <div class="column is-12" v-if="data?.not_reported_by && data.not_reported_by.length>0">
+      <Message message_class="has-background-warning-80 has-text-dark" title="Warning!">
+        <div class="content">
+          <p>
+            <span class="icon"><i class="fas fa-exclamation"></i></span>
+            There are no metadata regarding this <strong>{{ data.type }}</strong> from (
+            <span class="tag mr-1" v-for="backend in data.not_reported_by" :key="`nr-${backend}`">
+              <NuxtLink :to="`/backend/${backend}`" v-text="backend"/>
+            </span>).
+          </p>
+          <h5>Possible reasons:</h5>
+          <ul>
+            <li>Delayed import operation. Might be yet to be imported due to webhooks not being used, or the backend
+              doesn't support webhooks.
+            </li>
+            <li>Item mismatched at the source backend.</li>
+            <li>
+              There are no matching <code>{{ 'episode' === data.type ? 'Series GUIDs' : 'GUIDs' }}</code> in common
+              being reported, And thus it was treated as separate item.
+            </li>
+          </ul>
+        </div>
+      </Message>
+    </div>
+
     <div class="column is-12" v-if="data?.via">
       <div class="card" :class="{ 'is-success': parseInt(data.watched), 'is-danger': !data.watched }">
         <header class="card-header">
@@ -106,8 +131,8 @@
                 <span class="icon" v-if="'episode' === data.type"><i class="fas fa-tv"></i></span>
                 <span class="icon" v-else><i class="fas fa-film"></i></span>
                 <span>
-                  <span class="is-hidden-mobile">Type:</span>
-                  {{ ucFirst(data.type) }}
+                  <span class="is-hidden-mobile">Type:&nbsp;</span>
+                  <NuxtLink :to="makeSearchLink('type',data.type)" v-text="ucFirst(data.type)"/>
                 </span>
               </span>
             </div>
@@ -115,14 +140,18 @@
             <div class="column is-6 has-text-left" v-if="'episode' === data.type">
               <span class="icon-text">
                 <span class="icon"><i class="fas fa-tv"></i></span>
-                <span><span class="is-hidden-mobile">Season:</span> {{ data.season }}</span>
+                <span><span class="is-hidden-mobile">Season:&nbsp;</span>
+                  <NuxtLink :to="makeSearchLink('season',data.season)" v-text="data.season"/>
+                </span>
               </span>
             </div>
 
             <div class="column is-6 has-text-right" v-if="'episode' === data.type">
               <span class="icon-text">
                 <span class="icon"><i class="fas fa-tv"></i></span>
-                <span><span class="is-hidden-mobile">Episode:</span> {{ data.episode }}</span>
+                <span><span class="is-hidden-mobile">Episode:&nbsp;</span>
+                  <NuxtLink :to="makeSearchLink('episode',data.episode)" v-text="data.episode"/>
+                </span>
               </span>
             </div>
 
@@ -138,6 +167,18 @@
               </span>
             </div>
 
+            <div class="column is-12" v-if="data.rguids && Object.keys(data.rguids).length>0">
+              <span class="icon-text is-clickable" v-tooltip="'Relative Globally unique identifier for this episode'">
+                <span class="icon"><i class="fas fa-link"></i></span>
+                <span>rGUIDs:</span>
+              </span>
+              <span class="tag mr-1" v-for="(guid,source) in data.rguids">
+                <NuxtLink :to="makeSearchLink('rguid', `${source.split('guid_')[1]}://${guid}`)">
+                  {{ source.split('guid_')[1] }}-{{ guid }}
+                </NuxtLink>
+              </span>
+            </div>
+
             <div class="column is-12" v-if="data.parent && Object.keys(data.parent).length>0">
               <span class="icon-text is-clickable" v-tooltip="'Globally unique identifier for the series'">
                 <span class="icon"><i class="fas fa-link"></i></span>
@@ -231,8 +272,8 @@
                 <span class="icon" v-if="'episode' === item.type"><i class="fas fa-tv"></i></span>
                 <span class="icon" v-else><i class="fas fa-film"></i></span>
                 <span>
-                  <span class="is-hidden-mobile">Type:</span>
-                  {{ ucFirst(item.type) }}
+                  <span class="is-hidden-mobile">Type:&nbsp;</span>
+                  <NuxtLink :to="makeSearchLink('type',item.type)" v-text="ucFirst(item.type)"/>
                 </span>
               </span>
             </div>
@@ -240,14 +281,20 @@
             <div class="column is-6" v-if="'episode' === item.type">
               <span class="icon-text">
                 <span class="icon"><i class="fas fa-tv"></i></span>
-                <span><span class="is-hidden-mobile">Season:</span> {{ item.season }}</span>
+                <span>
+                  <span class="is-hidden-mobile">Season:&nbsp;</span>
+                  <NuxtLink :to="makeSearchLink('season',item.season)" v-text="item.season"/>
+                </span>
               </span>
             </div>
 
             <div class="column is-6 has-text-right" v-if="'episode' === item.type">
               <span class="icon-text">
                 <span class="icon"><i class="fas fa-tv"></i></span>
-                <span><span class="is-hidden-mobile">Episode:</span> {{ item.episode }}</span>
+                <span>
+                  <span class="is-hidden-mobile">Episode:&nbsp;</span>
+                  <NuxtLink :to="makeSearchLink('episode',item.episode)" v-text="item.episode"/>
+                </span>
               </span>
             </div>
 
@@ -275,7 +322,7 @@
               </span>
             </div>
 
-            <div class="column is-12" v-if="item?.extra.title">
+            <div class="column is-12" v-if="item?.extra?.title">
               <span class="icon-text">
                 <span class="icon"><i class="fas fa-heading"></i></span>
                 <span><span class="is-hidden-mobile">Title:</span> {{ item.extra.title }}</span>
@@ -311,6 +358,23 @@
               backend. While clicking on the GUIDs will take you to that source link, similarly clicking on the series
               GUIDs will take you to the series link that was provided by the external source.
             </li>
+            <li>
+              <code>rGUIDSs</code> are relative globally unique identifiers for episodes based on <code>series
+              GUID</code>. They are formatted as <code>GUID://seriesID/season_number/episode_number</code>. We use
+              <code>rGUIDs</code>, to identify specific episode. This is more reliable than using episode specific
+              <code>GUID</code>, as they are often misreported in the source data.
+            </li>
+            <template v-if="data?.not_reported_by && data.not_reported_by.length > 0">
+              <li>
+                The warning on top of the page usually is accurate, and it is recommended to check the backend metadata
+                for the item.
+                <template v-if="'episode' === data.type">
+                  For episodes, we use <code>rGUIDs</code> to identify the episode, and <strong>important part</strong>
+                  of that GUID is the <code>series GUID</code>. We need at least one reported series GUIDs to match
+                  between your backends. If none are matching, it will be treated as separate series.
+                </template>
+              </li>
+            </template>
           </ul>
         </div>
       </Message>
@@ -320,7 +384,7 @@
 
 <script setup>
 import request from '~/utils/request.js'
-import {ag, formatDuration, makeGUIDLink, notification, ucFirst} from '~/utils/index.js'
+import {ag, formatDuration, makeGUIDLink, makeSearchLink, notification, ucFirst} from '~/utils/index.js'
 import moment from 'moment'
 import {useStorage} from "@vueuse/core";
 
@@ -339,6 +403,8 @@ const data = ref({
   metadata: {},
   guids: {},
   parent: {},
+  rguids: {},
+  not_reported_by: [],
 });
 
 const loadContent = async (id) => {
diff --git a/frontend/pages/history/index.vue b/frontend/pages/history/index.vue
index e249b97a..39407005 100644
--- a/frontend/pages/history/index.vue
+++ b/frontend/pages/history/index.vue
@@ -119,9 +119,7 @@
             <header class="card-header">
               <p class="card-header-title is-text-overflow pr-1">
                 <span class="icon" v-if="!item.progress">
-                  <i class="fas fa-eye-slash" v-if="!item.watched"></i>
-                  <i class="fas fa-eye" v-else></i>
-                  &nbsp;
+                  <i class="fas" :class="{'fa-eye-slash': !item.watched, 'fa-eye': item.watched}"></i>
                 </span>
                 <NuxtLink :to="'/history/'+item.id" v-text="item.full_title ?? item.title"/>
               </p>
@@ -132,6 +130,12 @@
             </header>
             <div class="card-content">
               <div class="columns is-multiline is-mobile has-text-centered">
+                <div class="column is-12 has-text-left" v-if="item?.title">
+                  <div class="is-text-overflow is-clickable"
+                       @click="(e) => e.target.classList.toggle('is-text-overflow')">
+                    {{ item.title }}
+                  </div>
+                </div>
                 <div class="column is-4-tablet is-6-mobile has-text-left-mobile">
                   <span class="icon-text">
                     <span class="icon"><i class="fas fa-calendar"></i>&nbsp;</span>
@@ -262,8 +266,10 @@ const loadContent = async (pageNumber, fromPopState = false) => {
 
     const response = await request(`/history/?${search.toString()}`)
     const json = await response.json()
+    const currentUrl = window.location.pathname + '?' + (new URLSearchParams(window.location.search)).toString()
 
-    if (!fromPopState && window.location.href !== newUrl) {
+    if (!fromPopState && currentUrl !== newUrl) {
+      console.log(currentUrl, newUrl)
       window.history.pushState({
         page: pageNumber,
         query: query.value,
diff --git a/frontend/utils/index.js b/frontend/utils/index.js
index 9ef891f8..a265d47a 100644
--- a/frontend/utils/index.js
+++ b/frontend/utils/index.js
@@ -299,7 +299,25 @@ const makeConsoleCommand = (cmd) => {
     return `/console?${params.toString()}`
 }
 
-const stringToRegex = (str) => new RegExp(str.match(/\/(.+)\/.*/)[1], str.match(/\/.+\/(.*)/)[1]);
+const stringToRegex = (str) => new RegExp(str.match(/\/(.+)\/.*/)[1], str.match(/\/.+\/(.*)/)[1])
+
+
+/**
+ * Make history search link.
+ *
+ * @param {string} type
+ * @param {string} guid
+ *
+ * @returns {string}
+ */
+const makeSearchLink = (type, guid) => {
+    const params = new URLSearchParams();
+    params.append('perpage', 50);
+    params.append('page', 1);
+    params.append('q', guid);
+    params.append('key', type);
+    return `/history/?${params.toString()}`
+}
 
 export {
     ag_set,
@@ -312,5 +330,6 @@ export {
     formatDuration,
     copyText,
     stringToRegex,
-    makeConsoleCommand
+    makeConsoleCommand,
+    makeSearchLink
 }
diff --git a/src/API/History/Index.php b/src/API/History/Index.php
index 4606af9b..2e04ccb0 100644
--- a/src/API/History/Index.php
+++ b/src/API/History/Index.php
@@ -50,52 +50,76 @@ final class Index
 
         $sql[] = sprintf('FROM %s', $es('state'));
 
-        if ($data->get('id')) {
-            $where[] = $es(iState::COLUMN_ID) . ' = :id';
-            $params['id'] = $data->get('id');
-            $filters['id'] = $data->get('id');
+        // -- search relative guids.
+        if ($data->get('rguid')) {
+            $regex = '/(?<guid>\w+)\:\/\/(?<parentID>.+?)\/(?<seasonNumber>\w+)(\/(?<episodeNumber>.+))?/is';
+            if (1 !== preg_match($regex, $data->get('rguid'), $matches)) {
+                return api_error(
+                    'Invalid value for rguid query string expected value format is guid://parentID/seasonNumber[/episodeNumber].',
+                    HTTP_STATUS::HTTP_BAD_REQUEST
+                );
+            }
+
+            $data = $data->with(iState::COLUMN_PARENT, r('{guid}://{parent}', [
+                'guid' => ag($matches, 'guid'),
+                'parent' => ag($matches, 'parentID'),
+            ]));
+
+            $data = $data->with(iState::COLUMN_SEASON, ag($matches, 'seasonNumber'));
+
+            if (null !== ($episodeNumber = ag($matches, 'episodeNumber'))) {
+                $data = $data->with(iState::COLUMN_EPISODE, $episodeNumber);
+            }
+
+            $filters['rguid'] = $data->get('rguid');
         }
 
-        if ($data->get('via')) {
+        if ($data->get(iState::COLUMN_ID)) {
+            $where[] = $es(iState::COLUMN_ID) . ' = :id';
+            $params['id'] = $data->get(iState::COLUMN_ID);
+            $filters['id'] = $data->get(iState::COLUMN_ID);
+        }
+
+        if ($data->get(iState::COLUMN_VIA)) {
             $where[] = $es(iState::COLUMN_VIA) . ' = :via';
             $params['via'] = $data->get('via');
             $filters['via'] = $data->get('via');
         }
 
-        if ($data->get('year')) {
+        if ($data->get(iState::COLUMN_YEAR)) {
             $where[] = $es(iState::COLUMN_YEAR) . ' = :year';
-            $params['year'] = $data->get('year');
-            $filters['year'] = $data->get('year');
+            $params['year'] = $data->get(iState::COLUMN_YEAR);
+            $filters['year'] = $data->get(iState::COLUMN_YEAR);
         }
 
-        if ($data->get('type')) {
+        if ($data->get(iState::COLUMN_TYPE)) {
             $where[] = $es(iState::COLUMN_TYPE) . ' = :type';
-            $params['type'] = match ($data->get('type')) {
+            $params['type'] = match ($data->get(iState::COLUMN_TYPE)) {
                 iState::TYPE_MOVIE => iState::TYPE_MOVIE,
                 default => iState::TYPE_EPISODE,
             };
-            $filters['type'] = $data->get('type');
+            $filters['type'] = $data->get(iState::COLUMN_TYPE);
         }
 
-        if ($data->get('title')) {
+        if ($data->get(iState::COLUMN_TITLE)) {
             $where[] = $es(iState::COLUMN_TITLE) . ' LIKE "%" || :title || "%"';
-            $params['title'] = $data->get('title');
-            $filters['title'] = $data->get('title');
+            $params['title'] = $data->get(iState::COLUMN_TITLE);
+            $filters['title'] = $data->get(iState::COLUMN_TITLE);
         }
 
-        if (null !== $data->get('season')) {
+        if (null !== $data->get(iState::COLUMN_SEASON)) {
             $where[] = $es(iState::COLUMN_SEASON) . ' = :season';
-            $params['season'] = $data->get('season');
-            $filters['season'] = $data->get('season');
+            $params['season'] = $data->get(iState::COLUMN_SEASON);
+            $filters['season'] = $data->get(iState::COLUMN_SEASON);
         }
 
-        if (null !== $data->get('episode')) {
+        if (null !== $data->get(iState::COLUMN_EPISODE)) {
             $where[] = $es(iState::COLUMN_EPISODE) . ' = :episode';
-            $params['episode'] = $data->get('episode');
-            $filters['episode'] = $data->get('episode');
+            $params['episode'] = $data->get(iState::COLUMN_EPISODE);
+            $filters['episode'] = $data->get(iState::COLUMN_EPISODE);
         }
 
-        if (null !== ($parent = $data->get('parent'))) {
+        if (null !== ($parent = $data->get(iState::COLUMN_PARENT))) {
             $parent = after($parent, 'guid_');
             $d = Guid::fromArray(['guid_' . before($parent, '://') => after($parent, '://')]);
             $parent = array_keys($d->getAll())[0] ?? null;
@@ -109,10 +133,10 @@ final class Index
 
             $where[] = "json_extract(" . iState::COLUMN_PARENT . ",'$.{$parent}') = :parent";
             $params['parent'] = array_values($d->getAll())[0];
-            $filters['parent'] = $data->get('parent');
+            $filters['parent'] = $data->get(iState::COLUMN_PARENT);
         }
 
-        if (null !== ($guid = $data->get('guid'))) {
+        if (null !== ($guid = $data->get(iState::COLUMN_GUIDS))) {
             $guid = after($guid, 'guid_');
             $d = Guid::fromArray(['guid_' . before($guid, '://') => after($guid, '://')]);
             $guid = array_keys($d->getAll())[0] ?? null;
@@ -126,10 +150,10 @@ final class Index
 
             $where[] = "json_extract(" . iState::COLUMN_GUIDS . ",'$.{$guid}') = :guid";
             $params['guid'] = array_values($d->getAll())[0];
-            $filters['guid'] = $data->get('guid');
+            $filters['guid'] = $data->get(iState::COLUMN_GUIDS);
         }
 
-        if ($data->get('metadata')) {
+        if ($data->get(iState::COLUMN_META_DATA)) {
             $sField = $data->get('key');
             $sValue = $data->get('value');
             if (null === $sField || null === $sValue) {
@@ -160,7 +184,7 @@ final class Index
             ];
         }
 
-        if ($data->get('extra')) {
+        if ($data->get(iState::COLUMN_EXTRA)) {
             $sField = $data->get('key');
             $sValue = $data->get('value');
             if (null === $sField || null === $sValue) {
@@ -329,7 +353,7 @@ final class Index
                     'type' => 'guid://id',
                 ],
                 [
-                    'key' => 'guid',
+                    'key' => 'guids',
                     'description' => 'Search using the GUID.',
                     'type' => 'guid://id',
                 ],
@@ -343,6 +367,11 @@ final class Index
                     'description' => 'Search using the extra JSON field. Searching this field might be slow.',
                     'type' => 'backend.field://value',
                 ],
+                [
+                    'key' => 'rguid',
+                    'description' => 'Search using the rGUID.',
+                    'type' => 'guid://parentID/seasonNumber[/episodeNumber]',
+                ],
             ],
         ];
 
@@ -364,6 +393,19 @@ final class Index
             $item['full_title'] = $entity->getName();
             $item[iState::COLUMN_META_DATA_PROGRESS] = $entity->hasPlayProgress() ? $entity->getPlayProgress() : null;
             $item[iState::COLUMN_EXTRA_EVENT] = ag($entity->getExtra($entity->via), iState::COLUMN_EXTRA_EVENT, null);
+            $item[iState::COLUMN_TITLE] = $entity->isEpisode() ? ag(
+                $entity->getMetadata($entity->via),
+                iState::COLUMN_EXTRA . '.' . iState::COLUMN_TITLE,
+                null
+            ) : null;
+
+            $item['rguids'] = [];
+
+            if ($entity->isEpisode()) {
+                foreach ($entity->getRelativeGuids() as $rKey => $rGuid) {
+                    $item['rguids'][$rKey] = $rGuid;
+                }
+            }
 
             $response['history'][] = $item;
         }
@@ -390,6 +432,16 @@ final class Index
         $r[iState::COLUMN_WATCHED] = $item->isWatched();
         $r[iState::COLUMN_UPDATED] = makeDate($item->updated);
         $r[iState::COLUMN_EXTRA_EVENT] = ag($item->getExtra($item->via), iState::COLUMN_EXTRA_EVENT, null);
+        $r['rguids'] = [];
+
+        if ($item->isEpisode()) {
+            foreach ($item->getRelativeGuids() as $rKey => $rGuid) {
+                $r['rguids'][$rKey] = $rGuid;
+            }
+        }
+
+        $reportedBy = [];
+        $r['not_reported_by'] = [];
 
         if (!empty($r[iState::COLUMN_META_DATA])) {
             foreach ($r[iState::COLUMN_META_DATA] as $key => &$metadata) {
@@ -398,9 +450,16 @@ final class Index
                     ag($metadata, iState::COLUMN_TYPE),
                     ag($metadata, iState::COLUMN_ID),
                 );
+                $reportedBy[] = $key;
             }
         }
 
+        $backendsKeys = array_column($this->getBackends(), 'name');
+
+        $r['not_reported_by'] = array_values(
+            array_filter($backendsKeys, fn($key) => !in_array($key, $reportedBy))
+        );
+
         return api_response(HTTP_STATUS::HTTP_OK, $r);
     }