feat(frontend): plex library scan

2025-09-17 17:24:35 +02:00 · 2020-10-30 14:38:19 +00:00
parent 97e30367fb
commit 1bc3f7be4b
7 changed files with 271 additions and 52 deletions
--- a/overseerr-api.yml
+++ b/overseerr-api.yml
@@ -816,6 +816,11 @@ paths:
          schema:
            type: boolean
            example: false
+        - in: query
+          name: start
+          schema:
+            type: boolean
+            example: false
      responses:
        '200':
          description: Status of Plex Sync
--- a/server/job/plexsync.ts
+++ b/server/job/plexsync.ts
@@ -13,6 +13,14 @@ const imdbRegex = new RegExp(/imdb:\/\/(tt[0-9]+)/);
 const tmdbRegex = new RegExp(/tmdb:\/\/([0-9]+)/);
 const plexRegex = new RegExp(/plex:\/\//);

+export interface SyncStatus {
+  running: boolean;
+  progress: number;
+  total: number;
+  currentLibrary: Library;
+  libraries: Library[];
+}
+
 class JobPlexSync {
  private tmdb: TheMovieDb;
  private plexClient: PlexAPI;
@@ -161,7 +169,7 @@ class JobPlexSync {
    }
  }

-  public status() {
+  public status(): SyncStatus {
    return {
      running: this.running,
      progress: this.progress,
--- a/server/routes/settings.ts
+++ b/server/routes/settings.ts
@@ -106,7 +106,7 @@ settingsRoutes.get('/plex/library', async (req, res) => {
 settingsRoutes.get('/plex/sync', (req, res) => {
  if (req.query.cancel) {
    jobPlexSync.cancel();
-  } else {
+  } else if (req.query.start) {
    jobPlexSync.run();
  }

--- a/src/components/Settings/SettingsLayout.tsx
+++ b/src/components/Settings/SettingsLayout.tsx
@@ -45,7 +45,7 @@ const SettingsLayout: React.FC = ({ children }) => {
                regex: /^\/settings(\/main)?$/,
              })}
              {settingsLink({
-                text: 'Plex Settings',
+                text: 'Plex',
                route: '/settings/plex',
                regex: /^\/settings\/plex/,
              })}
--- a/src/components/Settings/SettingsPlex.tsx
+++ b/src/components/Settings/SettingsPlex.tsx
@@ -1,16 +1,51 @@
 import React, { useState } from 'react';
 import LoadingSpinner from '../Common/LoadingSpinner';
 import type { PlexSettings } from '../../../server/lib/settings';
+import type { SyncStatus } from '../../../server/job/plexsync';
 import useSWR from 'swr';
 import { useFormik } from 'formik';
 import Button from '../Common/Button';
 import axios from 'axios';
 import LibraryItem from './LibraryItem';
+import Badge from '../Common/Badge';
+import { defineMessages, FormattedMessage, useIntl } from 'react-intl';
+
+const messages = defineMessages({
+  plexsettings: 'Plex Settings',
+  plexsettingsDescription:
+    'Configure the settings for your Plex server. Overseerr uses your Plex server to scan your library at an interval and see what content is available.',
+  servername: 'Server Name (Automatically Set)',
+  servernamePlaceholder: 'Plex Server Name',
+  hostname: 'Hostname/IP',
+  port: 'Port',
+  save: 'Save Changes',
+  saving: 'Saving...',
+  plexlibraries: 'Plex Libraries',
+  plexlibrariesDescription:
+    'These are the libraries Overseerr will scan for titles. If you see no libraries listed, you will need to run at least one sync by clicking the button below. You must first configure and save your plex connection settings before you will be able to retrieve your libraries.',
+  syncing: 'Syncing',
+  sync: 'Sync Plex Libraries',
+  manualscan: 'Manual Library Scan',
+  manualscanDescription:
+    "Normally, this will only be run once every 6 hours. Overseerr will check your Plex server's recently added more aggressively. If this is your first time configuring Plex, a one time full manual library scan is recommended!",
+  notrunning: 'Not Running',
+  currentlibrary: 'Current Library: {name}',
+  librariesRemaining: 'Libraries Remaining: {count}',
+  startscan: 'Start Scan',
+  cancelscan: 'Cancel Scan',
+});

 const SettingsPlex: React.FC = () => {
+  const intl = useIntl();
  const { data, error, revalidate } = useSWR<PlexSettings>(
    '/api/v1/settings/plex'
  );
+  const { data: dataSync, revalidate: revalidateSync } = useSWR<SyncStatus>(
+    '/api/v1/settings/plex/sync',
+    {
+      refreshInterval: 1000,
+    }
+  );
  const [isSyncing, setIsSyncing] = useState(false);
  const [isUpdating, setIsUpdating] = useState(false);
  const [submitError, setSubmitError] = useState<string | null>(null);
@@ -21,6 +56,7 @@ const SettingsPlex: React.FC = () => {
    },
    enableReinitialize: true,
    onSubmit: async (values) => {
+      setSubmitError(null);
      setIsUpdating(true);
      try {
        await axios.post('/api/v1/settings/plex', {
@@ -30,7 +66,7 @@ const SettingsPlex: React.FC = () => {

        revalidate();
      } catch (e) {
-        setSubmitError(e.message);
+        setSubmitError(e.response.data.message);
      } finally {
        setIsUpdating(false);
      }
@@ -55,6 +91,24 @@ const SettingsPlex: React.FC = () => {
    revalidate();
  };

+  const startScan = async () => {
+    await axios.get('/api/v1/settings/plex/sync', {
+      params: {
+        start: true,
+      },
+    });
+    revalidateSync();
+  };
+
+  const cancelScan = async () => {
+    await axios.get('/api/v1/settings/plex/sync', {
+      params: {
+        cancel: true,
+      },
+    });
+    revalidateSync();
+  };
+
  const toggleLibrary = async (libraryId: string) => {
    setIsSyncing(true);
    if (activeLibraries.includes(libraryId)) {
@@ -84,29 +138,34 @@ const SettingsPlex: React.FC = () => {
    <>
      <div>
        <h3 className="text-lg leading-6 font-medium text-cool-gray-200">
-          Plex Settings
+          <FormattedMessage {...messages.plexsettings} />
        </h3>
        <p className="mt-1 max-w-2xl text-sm leading-5 text-cool-gray-500">
-          Configure the settings for your Plex server. Overseerr uses your Plex
-          server to scan your library at an interval and see what content is
-          available.
+          <FormattedMessage {...messages.plexsettingsDescription} />
        </p>
      </div>
      <form onSubmit={formik.handleSubmit}>
        <div className="mt-6 sm:mt-5">
+          {submitError && (
+            <div className="bg-red-700 text-white p-4 rounded-md mb-6">
+              {submitError}
+            </div>
+          )}
          <div className="sm:grid sm:grid-cols-3 sm:gap-4 sm:items-start sm:border-t sm:border-gray-800 sm:pt-5">
            <label
              htmlFor="name"
              className="block text-sm font-medium leading-5 text-cool-gray-400 sm:mt-px sm:pt-2"
            >
-              Server Name (Automatically set)
+              <FormattedMessage {...messages.servername} />
            </label>
            <div className="mt-1 sm:mt-0 sm:col-span-2">
              <div className="max-w-lg flex rounded-md shadow-sm">
                <input
                  id="name"
                  name="name"
-                  placeholder="Plex Server Name (will be set automatically)"
+                  placeholder={intl.formatMessage(
+                    messages.servernamePlaceholder
+                  )}
                  value={data?.name}
                  readOnly
                  className="flex-1 form-input block w-full min-w-0 rounded-md transition duration-150 ease-in-out sm:text-sm sm:leading-5 bg-cool-gray-700 border border-cool-gray-500"
@@ -119,7 +178,7 @@ const SettingsPlex: React.FC = () => {
              htmlFor="hostname"
              className="block text-sm font-medium leading-5 text-cool-gray-400 sm:mt-px sm:pt-2"
            >
-              Hostname/IP
+              <FormattedMessage {...messages.hostname} />
            </label>
            <div className="mt-1 sm:mt-0 sm:col-span-2">
              <div className="max-w-lg flex rounded-md shadow-sm">
@@ -139,7 +198,7 @@ const SettingsPlex: React.FC = () => {
              htmlFor="port"
              className="block text-sm font-medium leading-5 text-cool-gray-400 sm:mt-px sm:pt-2"
            >
-              Port
+              <FormattedMessage {...messages.port} />
            </label>
            <div className="mt-1 sm:mt-0 sm:col-span-2">
              <div className="max-w-lg rounded-md shadow-sm sm:max-w-xs">
@@ -159,51 +218,152 @@ const SettingsPlex: React.FC = () => {
          <div className="flex justify-end">
            <span className="ml-3 inline-flex rounded-md shadow-sm">
              <Button buttonType="primary" type="submit" disabled={isUpdating}>
-                {isUpdating ? 'Saving...' : 'Save Changes'}
+                {isUpdating
+                  ? intl.formatMessage(messages.saving)
+                  : intl.formatMessage(messages.save)}
              </Button>
            </span>
          </div>
        </div>
-        <div className="mt-10">
-          <h3 className="text-lg leading-6 font-medium text-cool-gray-200">
-            Plex Libraries
-          </h3>
-          <p className="mt-1 max-w-2xl text-sm leading-5 text-cool-gray-500">
-            These are the libraries Overseerr will scan for titles. If you see
-            no libraries listed, you will need to run at least one sync by
-            clicking the button below. You must first configure and save your
-            plex connection settings before you will be able to retrieve your
-            libraries.
-          </p>
-          <div className="mt-6">
-            <Button onClick={() => syncLibraries()} disabled={isSyncing}>
-              <svg
-                className={`${isSyncing ? 'animate-spin' : ''} w-5 h-5 mr-1`}
-                fill="currentColor"
-                viewBox="0 0 20 20"
-                xmlns="http://www.w3.org/2000/svg"
-              >
-                <path
-                  fillRule="evenodd"
-                  d="M4 2a1 1 0 011 1v2.101a7.002 7.002 0 0111.601 2.566 1 1 0 11-1.885.666A5.002 5.002 0 005.999 7H9a1 1 0 010 2H4a1 1 0 01-1-1V3a1 1 0 011-1zm.008 9.057a1 1 0 011.276.61A5.002 5.002 0 0014.001 13H11a1 1 0 110-2h5a1 1 0 011 1v5a1 1 0 11-2 0v-2.101a7.002 7.002 0 01-11.601-2.566 1 1 0 01.61-1.276z"
-                  clipRule="evenodd"
-                />
-              </svg>
-              {isSyncing ? 'Syncing...' : 'Sync Plex Libraries'}
-            </Button>
-          </div>
-          <ul className="mt-6 grid grid-cols-1 gap-5 sm:gap-6 sm:grid-cols-2 lg:grid-cols-4">
-            {data?.libraries.map((library) => (
-              <LibraryItem
-                name={library.name}
-                isEnabled={library.enabled}
-                key={`setting-library-${library.id}`}
-                onToggle={() => toggleLibrary(library.id)}
-              />
-            ))}
-          </ul>
-        </div>
      </form>
+      <div className="mt-10">
+        <h3 className="text-lg leading-6 font-medium text-cool-gray-200">
+          <FormattedMessage {...messages.plexlibraries} />
+        </h3>
+        <p className="mt-1 max-w-2xl text-sm leading-5 text-cool-gray-500">
+          <FormattedMessage {...messages.plexlibrariesDescription} />
+        </p>
+        <div className="mt-6">
+          <Button onClick={() => syncLibraries()} disabled={isSyncing}>
+            <svg
+              className={`${isSyncing ? 'animate-spin' : ''} w-5 h-5 mr-1`}
+              fill="currentColor"
+              viewBox="0 0 20 20"
+              xmlns="http://www.w3.org/2000/svg"
+            >
+              <path
+                fillRule="evenodd"
+                d="M4 2a1 1 0 011 1v2.101a7.002 7.002 0 0111.601 2.566 1 1 0 11-1.885.666A5.002 5.002 0 005.999 7H9a1 1 0 010 2H4a1 1 0 01-1-1V3a1 1 0 011-1zm.008 9.057a1 1 0 011.276.61A5.002 5.002 0 0014.001 13H11a1 1 0 110-2h5a1 1 0 011 1v5a1 1 0 11-2 0v-2.101a7.002 7.002 0 01-11.601-2.566 1 1 0 01.61-1.276z"
+                clipRule="evenodd"
+              />
+            </svg>
+            {isSyncing
+              ? intl.formatMessage(messages.syncing)
+              : intl.formatMessage(messages.sync)}
+          </Button>
+        </div>
+        <ul className="mt-6 grid grid-cols-1 gap-5 sm:gap-6 sm:grid-cols-2 lg:grid-cols-4">
+          {data?.libraries.map((library) => (
+            <LibraryItem
+              name={library.name}
+              isEnabled={library.enabled}
+              key={`setting-library-${library.id}`}
+              onToggle={() => toggleLibrary(library.id)}
+            />
+          ))}
+        </ul>
+      </div>
+      <div className="mt-10">
+        <h3 className="text-lg leading-6 font-medium text-cool-gray-200">
+          <FormattedMessage {...messages.manualscan} />
+        </h3>
+        <p className="mt-1 max-w-2xl text-sm leading-5 text-cool-gray-500">
+          <FormattedMessage {...messages.manualscanDescription} />
+        </p>
+        <div className="mt-6">
+          <div className="bg-cool-gray-800 p-4 rounded-md">
+            <div className="w-full h-8 rounded-full bg-cool-gray-600 mb-6 relative">
+              {dataSync?.running && (
+                <div
+                  className="h-8 rounded-full bg-indigo-600 transition-all ease-in-out duration-200"
+                  style={{
+                    width: `${Math.round(
+                      (dataSync.progress / dataSync.total) * 100
+                    )}%`,
+                  }}
+                />
+              )}
+              <div className="absolute inset-0 text-sm w-full h-8 flex items-center justify-center">
+                <span>
+                  {dataSync?.running
+                    ? `${dataSync.progress} of ${dataSync.total}`
+                    : 'Not running'}
+                </span>
+              </div>
+            </div>
+            <div className="flex w-full flex-col sm:flex-row">
+              {dataSync?.running && (
+                <>
+                  <div className="flex items-center mr-0 mb-2 sm:mb-0 sm:mr-2">
+                    <Badge>
+                      <FormattedMessage
+                        {...messages.currentlibrary}
+                        values={{ name: dataSync.currentLibrary.name }}
+                      />
+                    </Badge>
+                  </div>
+                  <div className="flex items-center">
+                    <Badge badgeType="warning">
+                      <FormattedMessage
+                        {...messages.librariesRemaining}
+                        values={{
+                          count: dataSync.libraries.slice(
+                            dataSync.libraries.findIndex(
+                              (library) =>
+                                library.id === dataSync.currentLibrary.id
+                            ) + 1
+                          ).length,
+                        }}
+                      />
+                    </Badge>
+                  </div>
+                </>
+              )}
+              <div className="flex-1 text-right">
+                {!dataSync?.running && (
+                  <Button buttonType="warning" onClick={() => startScan()}>
+                    <svg
+                      className="w-5 h-5 mr-1"
+                      fill="none"
+                      stroke="currentColor"
+                      viewBox="0 0 24 24"
+                      xmlns="http://www.w3.org/2000/svg"
+                    >
+                      <path
+                        strokeLinecap="round"
+                        strokeLinejoin="round"
+                        strokeWidth={2}
+                        d="M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z"
+                      />
+                    </svg>
+                    <FormattedMessage {...messages.startscan} />
+                  </Button>
+                )}
+
+                {dataSync?.running && (
+                  <Button buttonType="danger" onClick={() => cancelScan()}>
+                    <svg
+                      className="w-5 h-5 mr-1"
+                      fill="none"
+                      stroke="currentColor"
+                      viewBox="0 0 24 24"
+                      xmlns="http://www.w3.org/2000/svg"
+                    >
+                      <path
+                        strokeLinecap="round"
+                        strokeLinejoin="round"
+                        strokeWidth={2}
+                        d="M6 18L18 6M6 6l12 12"
+                      />
+                    </svg>
+                    <FormattedMessage {...messages.cancelscan} />
+                  </Button>
+                )}
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
    </>
  );
 };
--- a/src/i18n/locale/en.json
+++ b/src/i18n/locale/en.json
@@ -26,21 +26,44 @@
  "components.MovieDetails.status": "Status",
  "components.MovieDetails.unavailable": "Unavailable",
  "components.MovieDetails.userrating": "User Rating",
+  "components.MovieDetails.viewrequest": "View Request",
  "components.PendingRequest.approve": "Approve",
  "components.PendingRequest.decline": "Decline",
  "components.PendingRequest.pendingdescription": "This title was requested by {username} ({email}) on {date}",
  "components.PendingRequest.pendingtitle": "Pending Request",
  "components.RequestModal.cancelrequest": "This will remove your request. Are you sure you want to continue?",
  "components.RequestModal.requestadmin": "Your request will be immediately approved.",
+  "components.Settings.cancelscan": "Cancel Scan",
+  "components.Settings.currentlibrary": "Current Library: {name}",
+  "components.Settings.hostname": "Hostname/IP",
+  "components.Settings.librariesRemaining": "Libraries Remaining: {count}",
+  "components.Settings.manualscan": "Manual Library Scan",
+  "components.Settings.manualscanDescription": "Normally, this will only be run once every 6 hours. Overseerr will check your Plex server's recently added more aggressively. If this is your first time configuring Plex, a one time full manual library scan is recommended!",
+  "components.Settings.notrunning": "Not Running",
+  "components.Settings.plexlibraries": "Plex Libraries",
+  "components.Settings.plexlibrariesDescription": "These are the libraries Overseerr will scan for titles. If you see no libraries listed, you will need to run at least one sync by clicking the button below. You must first configure and save your plex connection settings before you will be able to retrieve your libraries.",
+  "components.Settings.plexsettings": "Plex Settings",
+  "components.Settings.plexsettingsDescription": "Configure the settings for your Plex server. Overseerr uses your Plex server to scan your library at an interval and see what content is available.",
+  "components.Settings.port": "Port",
+  "components.Settings.save": "Save Changes",
+  "components.Settings.saving": "Saving...",
+  "components.Settings.servername": "Server Name (Automatically Set)",
+  "components.Settings.servernamePlaceholder": "Plex Server Name",
+  "components.Settings.startscan": "Start Scan",
+  "components.Settings.sync": "Sync Plex Libraries",
+  "components.Settings.syncing": "Syncing",
+  "components.TvDetails.approverequests": "Approve {requestCount} {requestCount, plural, one {Request} other {Requests}}",
  "components.TvDetails.available": "Available",
  "components.TvDetails.cancelrequest": "Cancel Request",
  "components.TvDetails.cast": "Cast",
+  "components.TvDetails.declinerequests": "Decline {requestCount} {requestCount, plural, one {Request} other {Requests}}",
  "components.TvDetails.originallanguage": "Original Language",
  "components.TvDetails.overview": "Overview",
  "components.TvDetails.overviewunavailable": "Overview unavailable",
  "components.TvDetails.pending": "Pending",
  "components.TvDetails.recommendations": "Recommendations",
  "components.TvDetails.request": "Request",
+  "components.TvDetails.requestmore": "Request More",
  "components.TvDetails.similar": "Similar Series",
  "components.TvDetails.status": "Status",
  "components.TvDetails.unavailable": "Unavailable",
--- a/src/i18n/locale/ja.json
+++ b/src/i18n/locale/ja.json
@@ -26,21 +26,44 @@
  "components.MovieDetails.status": "状態",
  "components.MovieDetails.unavailable": "",
  "components.MovieDetails.userrating": "ユーザー評価",
+  "components.MovieDetails.viewrequest": "",
  "components.PendingRequest.approve": "",
  "components.PendingRequest.decline": "",
  "components.PendingRequest.pendingdescription": "",
  "components.PendingRequest.pendingtitle": "",
  "components.RequestModal.cancelrequest": "このリクエストをキャンセルしてよろしいですか？",
  "components.RequestModal.requestadmin": "このリクエストが今すぐ承認致します。よろしいですか？",
+  "components.Settings.cancelscan": "",
+  "components.Settings.currentlibrary": "",
+  "components.Settings.hostname": "",
+  "components.Settings.librariesRemaining": "",
+  "components.Settings.manualscan": "",
+  "components.Settings.manualscanDescription": "",
+  "components.Settings.notrunning": "",
+  "components.Settings.plexlibraries": "",
+  "components.Settings.plexlibrariesDescription": "",
+  "components.Settings.plexsettings": "",
+  "components.Settings.plexsettingsDescription": "",
+  "components.Settings.port": "",
+  "components.Settings.save": "",
+  "components.Settings.saving": "",
+  "components.Settings.servername": "",
+  "components.Settings.servernamePlaceholder": "",
+  "components.Settings.startscan": "",
+  "components.Settings.sync": "",
+  "components.Settings.syncing": "",
+  "components.TvDetails.approverequests": "",
  "components.TvDetails.available": "",
  "components.TvDetails.cancelrequest": "",
  "components.TvDetails.cast": "",
+  "components.TvDetails.declinerequests": "",
  "components.TvDetails.originallanguage": "",
  "components.TvDetails.overview": "",
  "components.TvDetails.overviewunavailable": "",
  "components.TvDetails.pending": "",
  "components.TvDetails.recommendations": "",
  "components.TvDetails.request": "",
+  "components.TvDetails.requestmore": "",
  "components.TvDetails.similar": "",
  "components.TvDetails.status": "",
  "components.TvDetails.unavailable": "",