feat(notifications): add pushover integration (#574)
* feat(notifications): add pushover integration * refactor(pushover): group i18n translationspull/537/head
Jakob Ankarhem
4 years ago
committed by
GitHub
parent
67f2b57f00
commit
ee5d0181fc
@ -0,0 +1,122 @@
|
|||||||
|
import axios from 'axios';
|
||||||
|
import { hasNotificationType, Notification } from '..';
|
||||||
|
import logger from '../../../logger';
|
||||||
|
import { getSettings, NotificationAgentPushover } from '../../settings';
|
||||||
|
import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
|
||||||
|
|
||||||
|
interface PushoverPayload {
|
||||||
|
token: string;
|
||||||
|
user: string;
|
||||||
|
title: string;
|
||||||
|
message: string;
|
||||||
|
html: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
class PushoverAgent
|
||||||
|
extends BaseAgent<NotificationAgentPushover>
|
||||||
|
implements NotificationAgent {
|
||||||
|
protected getSettings(): NotificationAgentPushover {
|
||||||
|
if (this.settings) {
|
||||||
|
return this.settings;
|
||||||
|
}
|
||||||
|
|
||||||
|
const settings = getSettings();
|
||||||
|
|
||||||
|
return settings.notifications.agents.pushover;
|
||||||
|
}
|
||||||
|
|
||||||
|
public shouldSend(type: Notification): boolean {
|
||||||
|
if (
|
||||||
|
this.getSettings().enabled &&
|
||||||
|
this.getSettings().options.accessToken &&
|
||||||
|
this.getSettings().options.userToken &&
|
||||||
|
hasNotificationType(type, this.getSettings().types)
|
||||||
|
) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
private constructMessageDetails(
|
||||||
|
type: Notification,
|
||||||
|
payload: NotificationPayload
|
||||||
|
): { title: string; message: string } {
|
||||||
|
const settings = getSettings();
|
||||||
|
let messageTitle = '';
|
||||||
|
let message = '';
|
||||||
|
|
||||||
|
const title = payload.subject;
|
||||||
|
const plot = payload.message;
|
||||||
|
const user = payload.notifyUser.username;
|
||||||
|
|
||||||
|
switch (type) {
|
||||||
|
case Notification.MEDIA_PENDING:
|
||||||
|
messageTitle = 'New Request';
|
||||||
|
message += `${title}\n\n`;
|
||||||
|
message += `${plot}\n\n`;
|
||||||
|
message += `<b>Requested By</b>\n${user}\n\n`;
|
||||||
|
message += `<b>Status</b>\nPending Approval\n`;
|
||||||
|
break;
|
||||||
|
case Notification.MEDIA_APPROVED:
|
||||||
|
messageTitle = 'Request Approved';
|
||||||
|
message += `${title}\n\n`;
|
||||||
|
message += `${plot}\n\n`;
|
||||||
|
message += `<b>Requested By</b>\n${user}\n\n`;
|
||||||
|
message += `<b>Status</b>\nProcessing Request\n`;
|
||||||
|
break;
|
||||||
|
case Notification.MEDIA_AVAILABLE:
|
||||||
|
messageTitle = 'Now available!';
|
||||||
|
message += `${title}\n\n`;
|
||||||
|
message += `${plot}\n\n`;
|
||||||
|
message += `<b>Requested By</b>\n${user}\n\n`;
|
||||||
|
message += `<b>Status</b>\nAvailable\n`;
|
||||||
|
break;
|
||||||
|
case Notification.TEST_NOTIFICATION:
|
||||||
|
messageTitle = 'Test Notification';
|
||||||
|
message += `${title}\n\n`;
|
||||||
|
message += `${plot}\n\n`;
|
||||||
|
message += `<b>Requested By</b>\n${user}\n`;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (settings.main.applicationUrl && payload.media) {
|
||||||
|
const actionUrl = `${settings.main.applicationUrl}/${payload.media.mediaType}/${payload.media.tmdbId}`;
|
||||||
|
message += `<a href="${actionUrl}">Open in Overseerr</a>`;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { title: messageTitle, message };
|
||||||
|
}
|
||||||
|
|
||||||
|
public async send(
|
||||||
|
type: Notification,
|
||||||
|
payload: NotificationPayload
|
||||||
|
): Promise<boolean> {
|
||||||
|
logger.debug('Sending Pushover notification', { label: 'Notifications' });
|
||||||
|
try {
|
||||||
|
const endpoint = 'https://api.pushover.net/1/messages.json';
|
||||||
|
|
||||||
|
const { accessToken, userToken } = this.getSettings().options;
|
||||||
|
|
||||||
|
const { title, message } = this.constructMessageDetails(type, payload);
|
||||||
|
|
||||||
|
await axios.post(endpoint, {
|
||||||
|
token: accessToken,
|
||||||
|
user: userToken,
|
||||||
|
title: title,
|
||||||
|
message: message,
|
||||||
|
html: 1,
|
||||||
|
} as PushoverPayload);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
} catch (e) {
|
||||||
|
logger.error('Error sending Pushover notification', {
|
||||||
|
label: 'Notifications',
|
||||||
|
message: e.message,
|
||||||
|
});
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default PushoverAgent;
|
||||||
|
After Width: | Height: | Size: 3.2 KiB |
@ -0,0 +1,257 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import { Field, Form, Formik } from 'formik';
|
||||||
|
import useSWR from 'swr';
|
||||||
|
import LoadingSpinner from '../../../Common/LoadingSpinner';
|
||||||
|
import Button from '../../../Common/Button';
|
||||||
|
import { defineMessages, useIntl } from 'react-intl';
|
||||||
|
import axios from 'axios';
|
||||||
|
import * as Yup from 'yup';
|
||||||
|
import { useToasts } from 'react-toast-notifications';
|
||||||
|
import Alert from '../../../Common/Alert';
|
||||||
|
import NotificationTypeSelector from '../../../NotificationTypeSelector';
|
||||||
|
|
||||||
|
const messages = defineMessages({
|
||||||
|
save: 'Save Changes',
|
||||||
|
saving: 'Saving...',
|
||||||
|
agentenabled: 'Agent Enabled',
|
||||||
|
accessToken: 'Access Token',
|
||||||
|
userToken: 'User Token',
|
||||||
|
validationAccessTokenRequired: 'You must provide an access token.',
|
||||||
|
validationUserTokenRequired: 'You must provide a user token.',
|
||||||
|
pushoversettingssaved: 'Pushover notification settings saved!',
|
||||||
|
pushoversettingsfailed: 'Pushover notification settings failed to save.',
|
||||||
|
testsent: 'Test notification sent!',
|
||||||
|
test: 'Test',
|
||||||
|
settinguppushover: 'Setting up Pushover Notifications',
|
||||||
|
settinguppushoverDescription:
|
||||||
|
'To setup Pushover you need to <RegisterApplicationLink>register an application</RegisterApplicationLink> and get the access token.\
|
||||||
|
When setting up the application you can use one of the icons in the <IconLink>public folder</IconLink> on github.\
|
||||||
|
You also need the pushover user token which can be found on the start page when you log in.',
|
||||||
|
notificationtypes: 'Notification Types',
|
||||||
|
});
|
||||||
|
|
||||||
|
const NotificationsPushover: React.FC = () => {
|
||||||
|
const intl = useIntl();
|
||||||
|
const { addToast } = useToasts();
|
||||||
|
const { data, error, revalidate } = useSWR(
|
||||||
|
'/api/v1/settings/notifications/pushover'
|
||||||
|
);
|
||||||
|
|
||||||
|
const NotificationsPushoverSchema = Yup.object().shape({
|
||||||
|
accessToken: Yup.string().required(
|
||||||
|
intl.formatMessage(messages.validationAccessTokenRequired)
|
||||||
|
),
|
||||||
|
userToken: Yup.string().required(
|
||||||
|
intl.formatMessage(messages.validationUserTokenRequired)
|
||||||
|
),
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!data && !error) {
|
||||||
|
return <LoadingSpinner />;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Formik
|
||||||
|
initialValues={{
|
||||||
|
enabled: data?.enabled,
|
||||||
|
types: data?.types,
|
||||||
|
accessToken: data?.options.accessToken,
|
||||||
|
userToken: data?.options.userToken,
|
||||||
|
}}
|
||||||
|
validationSchema={NotificationsPushoverSchema}
|
||||||
|
onSubmit={async (values) => {
|
||||||
|
try {
|
||||||
|
await axios.post('/api/v1/settings/notifications/pushover', {
|
||||||
|
enabled: values.enabled,
|
||||||
|
types: values.types,
|
||||||
|
options: {
|
||||||
|
accessToken: values.accessToken,
|
||||||
|
userToken: values.userToken,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
addToast(intl.formatMessage(messages.pushoversettingssaved), {
|
||||||
|
appearance: 'success',
|
||||||
|
autoDismiss: true,
|
||||||
|
});
|
||||||
|
} catch (e) {
|
||||||
|
addToast(intl.formatMessage(messages.pushoversettingsfailed), {
|
||||||
|
appearance: 'error',
|
||||||
|
autoDismiss: true,
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
revalidate();
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{({ errors, touched, isSubmitting, values, isValid, setFieldValue }) => {
|
||||||
|
const testSettings = async () => {
|
||||||
|
await axios.post('/api/v1/settings/notifications/pushover/test', {
|
||||||
|
enabled: true,
|
||||||
|
types: values.types,
|
||||||
|
options: {
|
||||||
|
accessToken: values.accessToken,
|
||||||
|
userToken: values.userToken,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
addToast(intl.formatMessage(messages.testsent), {
|
||||||
|
appearance: 'info',
|
||||||
|
autoDismiss: true,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<Alert
|
||||||
|
title={intl.formatMessage(messages.settinguppushover)}
|
||||||
|
type="info"
|
||||||
|
>
|
||||||
|
{intl.formatMessage(messages.settinguppushoverDescription, {
|
||||||
|
RegisterApplicationLink: function RegisterApplicationLink(msg) {
|
||||||
|
return (
|
||||||
|
<a
|
||||||
|
href="https://pushover.net/apps/build"
|
||||||
|
className="text-indigo-100 hover:text-white hover:underline"
|
||||||
|
target="_blank"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
{msg}
|
||||||
|
</a>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
IconLink: function IconLink(msg) {
|
||||||
|
return (
|
||||||
|
<a
|
||||||
|
href="https://github.com/sct/overseerr/tree/develop/public"
|
||||||
|
className="text-indigo-100 hover:text-white hover:underline"
|
||||||
|
target="_blank"
|
||||||
|
rel="noreferrer"
|
||||||
|
>
|
||||||
|
{msg}
|
||||||
|
</a>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
})}
|
||||||
|
</Alert>
|
||||||
|
<Form>
|
||||||
|
<div className="sm:grid sm:grid-cols-3 sm:gap-4 sm:items-start sm:border-t sm:border-gray-200">
|
||||||
|
<label
|
||||||
|
htmlFor="enabled"
|
||||||
|
className="block text-sm font-medium leading-5 text-gray-400 sm:mt-px"
|
||||||
|
>
|
||||||
|
{intl.formatMessage(messages.agentenabled)}
|
||||||
|
</label>
|
||||||
|
<div className="mt-1 sm:mt-0 sm:col-span-2">
|
||||||
|
<Field
|
||||||
|
type="checkbox"
|
||||||
|
id="enabled"
|
||||||
|
name="enabled"
|
||||||
|
className="w-6 h-6 text-indigo-600 transition duration-150 ease-in-out rounded-md form-checkbox"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="mt-6 sm:mt-5 sm:grid sm:grid-cols-3 sm:gap-4 sm:items-start sm:border-t sm:border-gray-800">
|
||||||
|
<label
|
||||||
|
htmlFor="accessToken"
|
||||||
|
className="block text-sm font-medium leading-5 text-gray-400 sm:mt-px"
|
||||||
|
>
|
||||||
|
{intl.formatMessage(messages.accessToken)}
|
||||||
|
</label>
|
||||||
|
<div className="mt-1 sm:mt-0 sm:col-span-2">
|
||||||
|
<div className="flex max-w-lg rounded-md shadow-sm">
|
||||||
|
<Field
|
||||||
|
id="accessToken"
|
||||||
|
name="accessToken"
|
||||||
|
type="text"
|
||||||
|
placeholder={intl.formatMessage(messages.accessToken)}
|
||||||
|
className="flex-1 block w-full min-w-0 transition duration-150 ease-in-out bg-gray-700 border border-gray-500 rounded-md form-input sm:text-sm sm:leading-5"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
{errors.accessToken && touched.accessToken && (
|
||||||
|
<div className="mt-2 text-red-500">
|
||||||
|
{errors.accessToken}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
<label
|
||||||
|
htmlFor="userToken"
|
||||||
|
className="block text-sm font-medium leading-5 text-gray-400 sm:mt-px"
|
||||||
|
>
|
||||||
|
{intl.formatMessage(messages.userToken)}
|
||||||
|
</label>
|
||||||
|
<div className="mt-1 sm:mt-0 sm:col-span-2">
|
||||||
|
<div className="flex max-w-lg rounded-md shadow-sm">
|
||||||
|
<Field
|
||||||
|
id="userToken"
|
||||||
|
name="userToken"
|
||||||
|
type="text"
|
||||||
|
placeholder={intl.formatMessage(messages.userToken)}
|
||||||
|
className="flex-1 block w-full min-w-0 transition duration-150 ease-in-out bg-gray-700 border border-gray-500 rounded-md form-input sm:text-sm sm:leading-5"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
{errors.userToken && touched.userToken && (
|
||||||
|
<div className="mt-2 text-red-500">{errors.userToken}</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="mt-6">
|
||||||
|
<div role="group" aria-labelledby="label-permissions">
|
||||||
|
<div className="sm:grid sm:grid-cols-3 sm:gap-4 sm:items-baseline">
|
||||||
|
<div>
|
||||||
|
<div
|
||||||
|
className="text-base font-medium leading-6 text-gray-400 sm:text-sm sm:leading-5"
|
||||||
|
id="label-types"
|
||||||
|
>
|
||||||
|
{intl.formatMessage(messages.notificationtypes)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="mt-4 sm:mt-0 sm:col-span-2">
|
||||||
|
<div className="max-w-lg">
|
||||||
|
<NotificationTypeSelector
|
||||||
|
currentTypes={values.types}
|
||||||
|
onUpdate={(newTypes) =>
|
||||||
|
setFieldValue('types', newTypes)
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div className="pt-5 mt-8 border-t border-gray-700">
|
||||||
|
<div className="flex justify-end">
|
||||||
|
<span className="inline-flex ml-3 rounded-md shadow-sm">
|
||||||
|
<Button
|
||||||
|
buttonType="warning"
|
||||||
|
disabled={isSubmitting || !isValid}
|
||||||
|
onClick={(e) => {
|
||||||
|
e.preventDefault();
|
||||||
|
|
||||||
|
testSettings();
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{intl.formatMessage(messages.test)}
|
||||||
|
</Button>
|
||||||
|
</span>
|
||||||
|
<span className="inline-flex ml-3 rounded-md shadow-sm">
|
||||||
|
<Button
|
||||||
|
buttonType="primary"
|
||||||
|
type="submit"
|
||||||
|
disabled={isSubmitting || !isValid}
|
||||||
|
>
|
||||||
|
{isSubmitting
|
||||||
|
? intl.formatMessage(messages.saving)
|
||||||
|
: intl.formatMessage(messages.save)}
|
||||||
|
</Button>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</Form>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}}
|
||||||
|
</Formik>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export default NotificationsPushover;
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
import { NextPage } from 'next';
|
||||||
|
import React from 'react';
|
||||||
|
import NotificationsPushover from '../../../components/Settings/Notifications/NotificationsPushover';
|
||||||
|
import SettingsLayout from '../../../components/Settings/SettingsLayout';
|
||||||
|
import SettingsNotifications from '../../../components/Settings/SettingsNotifications';
|
||||||
|
|
||||||
|
const NotificationsPage: NextPage = () => {
|
||||||
|
return (
|
||||||
|
<SettingsLayout>
|
||||||
|
<SettingsNotifications>
|
||||||
|
<NotificationsPushover />
|
||||||
|
</SettingsNotifications>
|
||||||
|
</SettingsLayout>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export default NotificationsPage;
|
||||||
Loading…
Reference in new issue