From ac3f1941bc6d82b12838e2ff2a4b3652b05bc248 Mon Sep 17 00:00:00 2001 From: tidusjar Date: Mon, 14 Jun 2021 13:10:04 +0100 Subject: [PATCH] Added the ability to unsubscribe from the newsletter #2137 --- .../INewsletterTemplate.cs | 2 +- .../NewsletterTemplate.cs | 6 +- .../Templates/NewsletterTemplate.html | 5 ++ .../NewsletterUnsubscribeTests.cs | 35 ++++++++++++ src/Ombi.Schedule/Jobs/Ombi/NewsletterJob.cs | 55 +++++++++++++------ src/Ombi/ClientApp/src/app/app.module.ts | 1 + .../src/app/services/identity.service.ts | 4 ++ .../unsubscribe-confirm.component.html | 3 + .../unsubscribe-confirm.component.ts | 28 ++++++++++ .../src/app/unsubscribe/unsubscribe.module.ts | 27 +++++++++ src/Ombi/Controllers/V1/IdentityController.cs | 16 ++++++ 11 files changed, 161 insertions(+), 21 deletions(-) create mode 100644 src/Ombi.Schedule.Tests/NewsletterUnsubscribeTests.cs create mode 100644 src/Ombi/ClientApp/src/app/unsubscribe/components/confirm-component/unsubscribe-confirm.component.html create mode 100644 src/Ombi/ClientApp/src/app/unsubscribe/components/confirm-component/unsubscribe-confirm.component.ts create mode 100644 src/Ombi/ClientApp/src/app/unsubscribe/unsubscribe.module.ts diff --git a/src/Ombi.Notifications.Templates/INewsletterTemplate.cs b/src/Ombi.Notifications.Templates/INewsletterTemplate.cs index e3302710d..620cf3999 100644 --- a/src/Ombi.Notifications.Templates/INewsletterTemplate.cs +++ b/src/Ombi.Notifications.Templates/INewsletterTemplate.cs @@ -2,6 +2,6 @@ { public interface INewsletterTemplate { - string LoadTemplate(string subject, string intro, string tableHtml, string logo); + string LoadTemplate(string subject, string intro, string tableHtml, string logo, string unsubscribeLink); } } \ No newline at end of file diff --git a/src/Ombi.Notifications.Templates/NewsletterTemplate.cs b/src/Ombi.Notifications.Templates/NewsletterTemplate.cs index 84d92c21c..f2f0cbf12 100644 --- a/src/Ombi.Notifications.Templates/NewsletterTemplate.cs +++ b/src/Ombi.Notifications.Templates/NewsletterTemplate.cs @@ -13,7 +13,7 @@ namespace Ombi.Notifications.Templates if (string.IsNullOrEmpty(_templateLocation)) { #if DEBUG - _templateLocation = Path.Combine(Directory.GetCurrentDirectory(), "bin", "Debug", "netcoreapp3.0", "Templates", "NewsletterTemplate.html"); + _templateLocation = Path.Combine(Directory.GetCurrentDirectory(), "bin", "Debug", "net5.0", "Templates", "NewsletterTemplate.html"); #else _templateLocation = Path.Combine(Directory.GetCurrentDirectory(), "Templates", "NewsletterTemplate.html"); #endif @@ -29,9 +29,10 @@ namespace Ombi.Notifications.Templates private const string Logo = "{@LOGO}"; private const string TableLocation = "{@RECENTLYADDED}"; private const string IntroText = "{@INTRO}"; + private const string Unsubscribe = "{@UNSUBSCRIBE}"; - public string LoadTemplate(string subject, string intro, string tableHtml, string logo) + public string LoadTemplate(string subject, string intro, string tableHtml, string logo, string unsubscribeLink) { var sb = new StringBuilder(File.ReadAllText(TemplateLocation)); sb.Replace(SubjectKey, subject); @@ -39,6 +40,7 @@ namespace Ombi.Notifications.Templates sb.Replace(IntroText, intro); sb.Replace(DateKey, DateTime.Now.ToString("f")); sb.Replace(Logo, string.IsNullOrEmpty(logo) ? OmbiLogo : logo); + sb.Replace(Unsubscribe, string.IsNullOrEmpty(unsubscribeLink) ? string.Empty : unsubscribeLink); return sb.ToString(); } diff --git a/src/Ombi.Notifications.Templates/Templates/NewsletterTemplate.html b/src/Ombi.Notifications.Templates/Templates/NewsletterTemplate.html index 10b76dd30..71666ba67 100644 --- a/src/Ombi.Notifications.Templates/Templates/NewsletterTemplate.html +++ b/src/Ombi.Notifications.Templates/Templates/NewsletterTemplate.html @@ -451,6 +451,11 @@
+ + +
+ Unsubscribe +
Powered by Ombi diff --git a/src/Ombi.Schedule.Tests/NewsletterUnsubscribeTests.cs b/src/Ombi.Schedule.Tests/NewsletterUnsubscribeTests.cs new file mode 100644 index 000000000..0fc961058 --- /dev/null +++ b/src/Ombi.Schedule.Tests/NewsletterUnsubscribeTests.cs @@ -0,0 +1,35 @@ +using NUnit.Framework; +using Ombi.Schedule.Jobs.Ombi; +using System.Collections.Generic; + +namespace Ombi.Schedule.Tests +{ + [TestFixture] + public class NewsletterUnsubscribeTests + { + [TestCaseSource(nameof(Data))] + public string GenerateUnsubscribeLinkTest(string appUrl, string id) + { + return NewsletterJob.GenerateUnsubscribeLink(appUrl, id); + } + + private static IEnumerable Data + { + get + { + yield return new TestCaseData("https://google.com/", "1").Returns("https://google.com:443/unsubscribe/1").SetName("Fully Qualified"); + yield return new TestCaseData("https://google.com", "1").Returns("https://google.com:443/unsubscribe/1").SetName("Missing Slash"); + yield return new TestCaseData("google.com", "1").Returns("http://google.com:80/unsubscribe/1").SetName("Missing scheme"); + yield return new TestCaseData("ombi.google.com", "1").Returns("http://ombi.google.com:80/unsubscribe/1").SetName("Sub domain missing scheme"); + yield return new TestCaseData("https://ombi.google.com", "1").Returns("https://ombi.google.com:443/unsubscribe/1").SetName("Sub domain"); + yield return new TestCaseData("https://ombi.google.com/", "1").Returns("https://ombi.google.com:443/unsubscribe/1").SetName("Sub domain with slash"); + yield return new TestCaseData("https://google.com/ombi/", "1").Returns("https://google.com:443/ombi/unsubscribe/1").SetName("RP"); + yield return new TestCaseData("https://google.com/ombi", "1").Returns("https://google.com:443/ombi/unsubscribe/1").SetName("RP missing slash"); + yield return new TestCaseData("https://google.com:3577", "1").Returns("https://google.com:3577/unsubscribe/1").SetName("Port"); + yield return new TestCaseData("https://google.com:3577/", "1").Returns("https://google.com:3577/unsubscribe/1").SetName("Port With Slash"); + yield return new TestCaseData("", "1").Returns(string.Empty).SetName("Missing App URL empty"); + yield return new TestCaseData(null, "1").Returns(string.Empty).SetName("Missing App URL null"); + } + } + } +} diff --git a/src/Ombi.Schedule/Jobs/Ombi/NewsletterJob.cs b/src/Ombi.Schedule/Jobs/Ombi/NewsletterJob.cs index 4ff3c543e..d7942f495 100644 --- a/src/Ombi.Schedule/Jobs/Ombi/NewsletterJob.cs +++ b/src/Ombi.Schedule/Jobs/Ombi/NewsletterJob.cs @@ -228,32 +228,33 @@ namespace Ombi.Schedule.Jobs.Ombi var messageContent = ParseTemplate(template, customization); var email = new NewsletterTemplate(); - var html = email.LoadTemplate(messageContent.Subject, messageContent.Message, body, customization.Logo); - - var bodyBuilder = new BodyBuilder + foreach (var user in users) { - HtmlBody = html, - }; + var url = GenerateUnsubscribeLink(customization.ApplicationUrl, user.Id); + var html = email.LoadTemplate(messageContent.Subject, messageContent.Message, body, customization.Logo, url); - var message = new MimeMessage - { - Body = bodyBuilder.ToMessageBody(), - Subject = messageContent.Subject - }; + var bodyBuilder = new BodyBuilder + { + HtmlBody = html, + }; + + var message = new MimeMessage + { + Body = bodyBuilder.ToMessageBody(), + Subject = messageContent.Subject + }; - foreach (var user in users) - { // Get the users to send it to if (user.Email.IsNullOrEmpty()) { continue; } - // BCC the messages - message.Bcc.Add(new MailboxAddress(user.Email.Trim(), user.Email.Trim())); - } + // Send the message to the user + message.To.Add(new MailboxAddress(user.Email.Trim(), user.Email.Trim())); - // Send the email - await _email.Send(message, emailSettings); + // Send the email + await _email.Send(message, emailSettings); + } // Now add all of this to the Recently Added log var recentlyAddedLog = new HashSet(); @@ -346,11 +347,14 @@ namespace Ombi.Schedule.Jobs.Ombi { continue; } + + var unsubscribeLink = GenerateUnsubscribeLink(customization.ApplicationUrl, a.Id); + var messageContent = ParseTemplate(template, customization); var email = new NewsletterTemplate(); - var html = email.LoadTemplate(messageContent.Subject, messageContent.Message, body, customization.Logo); + var html = email.LoadTemplate(messageContent.Subject, messageContent.Message, body, customization.Logo, unsubscribeLink); await _email.Send( new NotificationMessage { Message = html, Subject = messageContent.Subject, To = a.Email }, @@ -371,6 +375,21 @@ namespace Ombi.Schedule.Jobs.Ombi .SendAsync(NotificationHub.NotificationEvent, "Newsletter Finished"); } + public static string GenerateUnsubscribeLink(string applicationUrl, string id) + { + if (!applicationUrl.HasValue()) + { + return string.Empty; + } + + if (!applicationUrl.EndsWith('/')) + { + applicationUrl += '/'; + } + var b = new UriBuilder($"{applicationUrl}unsubscribe/{id}"); + return b.ToString(); + } + private async Task> GetMoviesWithoutId(HashSet addedMovieLogIds, HashSet needsMovieDbPlex) { foreach (var movie in needsMovieDbPlex) diff --git a/src/Ombi/ClientApp/src/app/app.module.ts b/src/Ombi/ClientApp/src/app/app.module.ts index 4de2c9f9f..8e44d59bd 100644 --- a/src/Ombi/ClientApp/src/app/app.module.ts +++ b/src/Ombi/ClientApp/src/app/app.module.ts @@ -91,6 +91,7 @@ const routes: Routes = [ { loadChildren: () => import("./vote/vote.module").then(m => m.VoteModule), path: "vote" }, { loadChildren: () => import("./media-details/media-details.module").then(m => m.MediaDetailsModule), path: "details" }, { loadChildren: () => import("./user-preferences/user-preferences.module").then(m => m.UserPreferencesModule), path: "user-preferences" }, + { loadChildren: () => import("./unsubscribe/unsubscribe.module").then(m => m.UnsubscribeModule), path: "unsubscribe" }, ]; diff --git a/src/Ombi/ClientApp/src/app/services/identity.service.ts b/src/Ombi/ClientApp/src/app/services/identity.service.ts index 27f777e51..1b0f6d8c4 100644 --- a/src/Ombi/ClientApp/src/app/services/identity.service.ts +++ b/src/Ombi/ClientApp/src/app/services/identity.service.ts @@ -95,4 +95,8 @@ export class IdentityService extends ServiceHelpers { public updateStreamingCountry(code: string): Observable { return this.http.post(`${this.url}streamingcountry`, {code: code}, {headers: this.headers}); } + + public unsubscribeNewsletter(userId: string): Observable{ + return this.http.get(`${this.url}newsletter/unsubscribe/${userId}`, {headers: this.headers}); + } } diff --git a/src/Ombi/ClientApp/src/app/unsubscribe/components/confirm-component/unsubscribe-confirm.component.html b/src/Ombi/ClientApp/src/app/unsubscribe/components/confirm-component/unsubscribe-confirm.component.html new file mode 100644 index 000000000..64bc89b22 --- /dev/null +++ b/src/Ombi/ClientApp/src/app/unsubscribe/components/confirm-component/unsubscribe-confirm.component.html @@ -0,0 +1,3 @@ +
+

Unsubscribed!

+
\ No newline at end of file diff --git a/src/Ombi/ClientApp/src/app/unsubscribe/components/confirm-component/unsubscribe-confirm.component.ts b/src/Ombi/ClientApp/src/app/unsubscribe/components/confirm-component/unsubscribe-confirm.component.ts new file mode 100644 index 000000000..8551bf5ad --- /dev/null +++ b/src/Ombi/ClientApp/src/app/unsubscribe/components/confirm-component/unsubscribe-confirm.component.ts @@ -0,0 +1,28 @@ +import { Component, OnInit } from "@angular/core"; +import { IdentityService, SettingsService } from "../../../services"; + +import { ActivatedRoute } from "@angular/router"; +import { AuthService } from "../../../auth/auth.service"; + +@Component({ + templateUrl: "./unsubscribe-confirm.component.html", +}) +export class UnsubscribeConfirmComponent implements OnInit { + + private userId: string; + + constructor(private authService: AuthService, + private readonly identityService: IdentityService, + private readonly settingsService: SettingsService, + private route: ActivatedRoute) { + this.route.params.subscribe(async (params: any) => { + if (typeof params.id === 'string' || params.id instanceof String) { + this.userId = params.id; + } + }); + } + + public async ngOnInit() { + this.identityService.unsubscribeNewsletter(this.userId).subscribe() + } +} \ No newline at end of file diff --git a/src/Ombi/ClientApp/src/app/unsubscribe/unsubscribe.module.ts b/src/Ombi/ClientApp/src/app/unsubscribe/unsubscribe.module.ts new file mode 100644 index 000000000..1ca1fffee --- /dev/null +++ b/src/Ombi/ClientApp/src/app/unsubscribe/unsubscribe.module.ts @@ -0,0 +1,27 @@ +import { FormsModule, ReactiveFormsModule } from "@angular/forms"; +import { RouterModule, Routes } from "@angular/router"; + +import { CommonModule } from "@angular/common"; +import { NgModule } from "@angular/core"; +import { SharedModule } from "../shared/shared.module"; +import { UnsubscribeConfirmComponent } from "./components/confirm-component/unsubscribe-confirm.component"; + +const routes: Routes = [ + { path: ":id", component: UnsubscribeConfirmComponent}, +]; +@NgModule({ + imports: [ + CommonModule, + FormsModule, + ReactiveFormsModule, + SharedModule, + RouterModule.forChild(routes), + ], + declarations: [ + UnsubscribeConfirmComponent, + ], + providers: [ + ], + +}) +export class UnsubscribeModule { } diff --git a/src/Ombi/Controllers/V1/IdentityController.cs b/src/Ombi/Controllers/V1/IdentityController.cs index bf1173d70..70cb73e74 100644 --- a/src/Ombi/Controllers/V1/IdentityController.cs +++ b/src/Ombi/Controllers/V1/IdentityController.cs @@ -1032,6 +1032,22 @@ namespace Ombi.Controllers.V1 return Json(true); } + + [HttpGet("newsletter/unsubscribe/{userId}")] + [AllowAnonymous] + public async Task UnsubscribeUser(string userId) + { + // lookup user + var user = await UserManager.Users.FirstOrDefaultAsync(x => x.Id == userId); + if (user == null) + { + return Ok(); + } + + await UserManager.RemoveFromRoleAsync(user, OmbiRoles.ReceivesNewsletter); + return Ok(); + } + private async Task> AddRoles(IEnumerable roles, OmbiUser ombiUser) { var roleResult = new List();