New: Custom Formats

Co-Authored-By: ta264 <ta264@users.noreply.github.com>

frontend/src/Store/Actions/Settings/customFormatSpecifications.js

@@ -0,0 +1,193 @@
+import { createAction } from 'redux-actions';
+import { batchActions } from 'redux-batched-actions';
+import createFetchSchemaHandler from 'Store/Actions/Creators/createFetchSchemaHandler';
+import createClearReducer from 'Store/Actions/Creators/Reducers/createClearReducer';
+import createSetProviderFieldValueReducer from 'Store/Actions/Creators/Reducers/createSetProviderFieldValueReducer';
+import createSetSettingValueReducer from 'Store/Actions/Creators/Reducers/createSetSettingValueReducer';
+import { createThunk } from 'Store/thunks';
+import getNextId from 'Utilities/State/getNextId';
+import getProviderState from 'Utilities/State/getProviderState';
+import getSectionState from 'Utilities/State/getSectionState';
+import selectProviderSchema from 'Utilities/State/selectProviderSchema';
+import updateSectionState from 'Utilities/State/updateSectionState';
+import { removeItem, set, update, updateItem } from '../baseActions';
+
+//
+// Variables
+
+const section = 'settings.customFormatSpecifications';
+
+//
+// Actions Types
+
+export const FETCH_CUSTOM_FORMAT_SPECIFICATIONS = 'settings/customFormatSpecifications/fetchCustomFormatSpecifications';
+export const FETCH_CUSTOM_FORMAT_SPECIFICATION_SCHEMA = 'settings/customFormatSpecifications/fetchCustomFormatSpecificationSchema';
+export const SELECT_CUSTOM_FORMAT_SPECIFICATION_SCHEMA = 'settings/customFormatSpecifications/selectCustomFormatSpecificationSchema';
+export const SET_CUSTOM_FORMAT_SPECIFICATION_VALUE = 'settings/customFormatSpecifications/setCustomFormatSpecificationValue';
+export const SET_CUSTOM_FORMAT_SPECIFICATION_FIELD_VALUE = 'settings/customFormatSpecifications/setCustomFormatSpecificationFieldValue';
+export const SAVE_CUSTOM_FORMAT_SPECIFICATION = 'settings/customFormatSpecifications/saveCustomFormatSpecification';
+export const DELETE_CUSTOM_FORMAT_SPECIFICATION = 'settings/customFormatSpecifications/deleteCustomFormatSpecification';
+export const DELETE_ALL_CUSTOM_FORMAT_SPECIFICATION = 'settings/customFormatSpecifications/deleteAllCustomFormatSpecification';
+export const CLONE_CUSTOM_FORMAT_SPECIFICATION = 'settings/customFormatSpecifications/cloneCustomFormatSpecification';
+export const CLEAR_CUSTOM_FORMAT_SPECIFICATIONS = 'settings/customFormatSpecifications/clearCustomFormatSpecifications';
+export const CLEAR_CUSTOM_FORMAT_SPECIFICATION_PENDING = 'settings/customFormatSpecifications/clearCustomFormatSpecificationPending';
+//
+// Action Creators
+
+export const fetchCustomFormatSpecifications = createThunk(FETCH_CUSTOM_FORMAT_SPECIFICATIONS);
+export const fetchCustomFormatSpecificationSchema = createThunk(FETCH_CUSTOM_FORMAT_SPECIFICATION_SCHEMA);
+export const selectCustomFormatSpecificationSchema = createAction(SELECT_CUSTOM_FORMAT_SPECIFICATION_SCHEMA);
+
+export const saveCustomFormatSpecification = createThunk(SAVE_CUSTOM_FORMAT_SPECIFICATION);
+export const deleteCustomFormatSpecification = createThunk(DELETE_CUSTOM_FORMAT_SPECIFICATION);
+export const deleteAllCustomFormatSpecification = createThunk(DELETE_ALL_CUSTOM_FORMAT_SPECIFICATION);
+
+export const setCustomFormatSpecificationValue = createAction(SET_CUSTOM_FORMAT_SPECIFICATION_VALUE, (payload) => {
+  return {
+    section,
+    ...payload
+  };
+});
+
+export const setCustomFormatSpecificationFieldValue = createAction(SET_CUSTOM_FORMAT_SPECIFICATION_FIELD_VALUE, (payload) => {
+  return {
+    section,
+    ...payload
+  };
+});
+
+export const cloneCustomFormatSpecification = createAction(CLONE_CUSTOM_FORMAT_SPECIFICATION);
+
+export const clearCustomFormatSpecification = createAction(CLEAR_CUSTOM_FORMAT_SPECIFICATIONS);
+
+export const clearCustomFormatSpecificationPending = createThunk(CLEAR_CUSTOM_FORMAT_SPECIFICATION_PENDING);
+
+//
+// Details
+
+export default {
+
+  //
+  // State
+
+  defaultState: {
+    isPopulated: false,
+    error: null,
+    isSchemaFetching: false,
+    isSchemaPopulated: false,
+    schemaError: null,
+    schema: [],
+    selectedSchema: {},
+    isSaving: false,
+    saveError: null,
+    items: [],
+    pendingChanges: {}
+  },
+
+  //
+  // Action Handlers
+
+  actionHandlers: {
+    [FETCH_CUSTOM_FORMAT_SPECIFICATION_SCHEMA]: createFetchSchemaHandler(section, '/customformat/schema'),
+
+    [FETCH_CUSTOM_FORMAT_SPECIFICATIONS]: (getState, payload, dispatch) => {
+      let tags = [];
+      if (payload.id) {
+        const cfState = getSectionState(getState(), 'settings.customFormats', true);
+        const cf = cfState.items[cfState.itemMap[payload.id]];
+        tags = cf.specifications.map((tag, i) => {
+          return {
+            id: i + 1,
+            ...tag
+          };
+        });
+      }
+
+      dispatch(batchActions([
+        update({ section, data: tags }),
+        set({
+          section,
+          isPopulated: true
+        })
+      ]));
+    },
+
+    [SAVE_CUSTOM_FORMAT_SPECIFICATION]: (getState, payload, dispatch) => {
+      const {
+        id,
+        ...otherPayload
+      } = payload;
+
+      const saveData = getProviderState({ id, ...otherPayload }, getState, section, false);
+
+      // we have to set id since not actually posting to server yet
+      if (!saveData.id) {
+        saveData.id = getNextId(getState().settings.customFormatSpecifications.items);
+      }
+
+      dispatch(batchActions([
+        updateItem({ section, ...saveData }),
+        set({
+          section,
+          pendingChanges: {}
+        })
+      ]));
+    },
+
+    [DELETE_CUSTOM_FORMAT_SPECIFICATION]: (getState, payload, dispatch) => {
+      const id = payload.id;
+      return dispatch(removeItem({ section, id }));
+    },
+
+    [DELETE_ALL_CUSTOM_FORMAT_SPECIFICATION]: (getState, payload, dispatch) => {
+      return dispatch(set({
+        section,
+        items: []
+      }));
+    },
+
+    [CLEAR_CUSTOM_FORMAT_SPECIFICATION_PENDING]: (getState, payload, dispatch) => {
+      return dispatch(set({
+        section,
+        pendingChanges: {}
+      }));
+    }
+  },
+
+  //
+  // Reducers
+
+  reducers: {
+    [SET_CUSTOM_FORMAT_SPECIFICATION_VALUE]: createSetSettingValueReducer(section),
+    [SET_CUSTOM_FORMAT_SPECIFICATION_FIELD_VALUE]: createSetProviderFieldValueReducer(section),
+
+    [SELECT_CUSTOM_FORMAT_SPECIFICATION_SCHEMA]: (state, { payload }) => {
+      return selectProviderSchema(state, section, payload, (selectedSchema) => {
+        return selectedSchema;
+      });
+    },
+
+    [CLONE_CUSTOM_FORMAT_SPECIFICATION]: function(state, { payload }) {
+      const id = payload.id;
+      const newState = getSectionState(state, section);
+      const items = newState.items;
+      const item = items.find((i) => i.id === id);
+      const newId = getNextId(newState.items);
+      const newItem = {
+        ...item,
+        id: newId,
+        name: `${item.name} - Copy`
+      };
+      newState.items = [...items, newItem];
+      newState.itemMap[newId] = newState.items.length - 1;
+
+      return updateSectionState(state, section, newState);
+    },
+
+    [CLEAR_CUSTOM_FORMAT_SPECIFICATIONS]: createClearReducer(section, {
+      isPopulated: false,
+      error: null,
+      items: []
+    })
+  }
+};

frontend/src/Store/Actions/Settings/customFormats.js

@@ -0,0 +1,108 @@
+import { createAction } from 'redux-actions';
+import createFetchHandler from 'Store/Actions/Creators/createFetchHandler';
+import createRemoveItemHandler from 'Store/Actions/Creators/createRemoveItemHandler';
+import createSaveProviderHandler from 'Store/Actions/Creators/createSaveProviderHandler';
+import createSetSettingValueReducer from 'Store/Actions/Creators/Reducers/createSetSettingValueReducer';
+import { createThunk } from 'Store/thunks';
+import getSectionState from 'Utilities/State/getSectionState';
+import updateSectionState from 'Utilities/State/updateSectionState';
+import { set } from '../baseActions';
+
+//
+// Variables
+
+const section = 'settings.customFormats';
+
+//
+// Actions Types
+
+export const FETCH_CUSTOM_FORMATS = 'settings/customFormats/fetchCustomFormats';
+export const SAVE_CUSTOM_FORMAT = 'settings/customFormats/saveCustomFormat';
+export const DELETE_CUSTOM_FORMAT = 'settings/customFormats/deleteCustomFormat';
+export const SET_CUSTOM_FORMAT_VALUE = 'settings/customFormats/setCustomFormatValue';
+export const CLONE_CUSTOM_FORMAT = 'settings/customFormats/cloneCustomFormat';
+
+//
+// Action Creators
+
+export const fetchCustomFormats = createThunk(FETCH_CUSTOM_FORMATS);
+export const saveCustomFormat = createThunk(SAVE_CUSTOM_FORMAT);
+export const deleteCustomFormat = createThunk(DELETE_CUSTOM_FORMAT);
+
+export const setCustomFormatValue = createAction(SET_CUSTOM_FORMAT_VALUE, (payload) => {
+  return {
+    section,
+    ...payload
+  };
+});
+
+export const cloneCustomFormat = createAction(CLONE_CUSTOM_FORMAT);
+
+//
+// Details
+
+export default {
+
+  //
+  // State
+
+  defaultState: {
+    isSchemaFetching: false,
+    isSchemaPopulated: false,
+    isFetching: false,
+    isPopulated: false,
+    schema: {
+      includeCustomFormatWhenRenaming: false
+    },
+    error: null,
+    isDeleting: false,
+    deleteError: null,
+    isSaving: false,
+    saveError: null,
+    items: [],
+    pendingChanges: {}
+  },
+
+  //
+  // Action Handlers
+
+  actionHandlers: {
+    [FETCH_CUSTOM_FORMATS]: createFetchHandler(section, '/customformat'),
+
+    [DELETE_CUSTOM_FORMAT]: createRemoveItemHandler(section, '/customformat'),
+
+    [SAVE_CUSTOM_FORMAT]: (getState, payload, dispatch) => {
+      // move the format tags in as a pending change
+      const state = getState();
+      const pendingChanges = state.settings.customFormats.pendingChanges;
+      pendingChanges.specifications = state.settings.customFormatSpecifications.items;
+      dispatch(set({
+        section,
+        pendingChanges
+      }));
+
+      createSaveProviderHandler(section, '/customformat')(getState, payload, dispatch);
+    }
+  },
+
+  //
+  // Reducers
+
+  reducers: {
+    [SET_CUSTOM_FORMAT_VALUE]: createSetSettingValueReducer(section),
+
+    [CLONE_CUSTOM_FORMAT]: function(state, { payload }) {
+      const id = payload.id;
+      const newState = getSectionState(state, section);
+      const item = newState.items.find((i) => i.id === id);
+      const pendingChanges = { ...item, id: 0 };
+      delete pendingChanges.id;
+
+      pendingChanges.name = `${pendingChanges.name} - Copy`;
+      newState.pendingChanges = pendingChanges;
+
+      return updateSectionState(state, section, newState);
+    }
+  }
+
+};

frontend/src/Store/Actions/blocklistActions.js

@@ -47,6 +47,12 @@ export const defaultState = {
       label: 'Quality',
       isVisible: true
     },
+    {
+      name: 'customFormats',
+      label: 'Formats',
+      isSortable: false,
+      isVisible: true
+    },
     {
       name: 'date',
       label: 'Date',

frontend/src/Store/Actions/historyActions.js

@@ -1,5 +1,7 @@
+import React from 'react';
 import { createAction } from 'redux-actions';
-import { filterTypes, sortDirections } from 'Helpers/Props';
+import Icon from 'Components/Icon';
+import { filterTypes, icons, sortDirections } from 'Helpers/Props';
 import { createThunk, handleThunks } from 'Store/thunks';
 import createAjaxRequest from 'Utilities/createAjaxRequest';
 import serverSideCollectionHandlers from 'Utilities/serverSideCollectionHandlers';
@@ -50,6 +52,12 @@ export const defaultState = {
       label: 'Quality',
       isVisible: true
     },
+    {
+      name: 'customFormats',
+      label: 'Formats',
+      isSortable: false,
+      isVisible: true
+    },
     {
       name: 'date',
       label: 'Date',
@@ -76,6 +84,20 @@ export const defaultState = {
       label: 'Source Title',
       isVisible: false
     },
+    {
+      name: 'sourceTitle',
+      label: 'Source Title',
+      isVisible: false
+    },
+    {
+      name: 'customFormatScore',
+      columnLabel: 'Custom Format Score',
+      label: React.createElement(Icon, {
+        name: icons.SCORE,
+        title: 'Custom format score'
+      }),
+      isVisible: false
+    },
     {
       name: 'details',
       columnLabel: 'Details',

frontend/src/Store/Actions/queueActions.js

@@ -87,6 +87,12 @@ export const defaultState = {
         isSortable: true,
         isVisible: true
       },
+      {
+        name: 'customFormats',
+        label: 'Formats',
+        isSortable: false,
+        isVisible: true
+      },
       {
         name: 'protocol',
         label: translate('Protocol'),

frontend/src/Store/Actions/releaseActions.js

@@ -2,6 +2,7 @@ import { createAction } from 'redux-actions';
 import { filterBuilderTypes, filterBuilderValueTypes, filterTypes, sortDirections } from 'Helpers/Props';
 import { createThunk, handleThunks } from 'Store/thunks';
 import createAjaxRequest from 'Utilities/createAjaxRequest';
+import translate from 'Utilities/String/translate';
 import createFetchHandler from './Creators/createFetchHandler';
 import createHandleActions from './Creators/createHandleActions';
 import createSetClientSideCollectionFilterReducer from './Creators/Reducers/createSetClientSideCollectionFilterReducer';
@@ -196,6 +197,11 @@ export const defaultState = {
       type: filterBuilderTypes.EXACT,
       valueType: filterBuilderValueTypes.QUALITY
     },
+    {
+      name: 'customFormatScore',
+      label: translate('CustomFormatScore'),
+      type: filterBuilderTypes.NUMBER
+    },
     {
       name: 'rejectionCount',
       label: 'Rejection Count',

frontend/src/Store/Actions/settingsActions.js

@@ -1,6 +1,8 @@
 import { createAction } from 'redux-actions';
 import { handleThunks } from 'Store/thunks';
 import createHandleActions from './Creators/createHandleActions';
+import customFormats from './Settings/customFormats';
+import customFormatSpecifications from './Settings/customFormatSpecifications';
 import delayProfiles from './Settings/delayProfiles';
 import development from './Settings/development';
 import downloadClientOptions from './Settings/downloadClientOptions';
@@ -25,6 +27,8 @@ import remotePathMappings from './Settings/remotePathMappings';
 import rootFolders from './Settings/rootFolders';
 import ui from './Settings/ui';
 
+export * from './Settings/customFormatSpecifications.js';
+export * from './Settings/customFormats';
 export * from './Settings/delayProfiles';
 export * from './Settings/downloadClients';
 export * from './Settings/downloadClientOptions';
@@ -60,6 +64,8 @@ export const section = 'settings';
 export const defaultState = {
   advancedSettings: false,
 
+  customFormatSpecifications: customFormatSpecifications.defaultState,
+  customFormats: customFormats.defaultState,
   delayProfiles: delayProfiles.defaultState,
   downloadClients: downloadClients.defaultState,
   downloadClientOptions: downloadClientOptions.defaultState,
@@ -103,6 +109,8 @@ export const toggleAdvancedSettings = createAction(TOGGLE_ADVANCED_SETTINGS);
 // Action Handlers
 
 export const actionHandlers = handleThunks({
+  ...customFormatSpecifications.actionHandlers,
+  ...customFormats.actionHandlers,
   ...delayProfiles.actionHandlers,
   ...downloadClients.actionHandlers,
   ...downloadClientOptions.actionHandlers,
@@ -137,6 +145,8 @@ export const reducers = createHandleActions({
     return Object.assign({}, state, { advancedSettings: !state.advancedSettings });
   },
 
+  ...customFormatSpecifications.reducers,
+  ...customFormats.reducers,
   ...delayProfiles.reducers,
   ...downloadClients.reducers,
   ...downloadClientOptions.reducers,