github/Ombi
1
0
Fork 0
mirror of https://github.com/Ombi-app/Ombi.git synced 2025-07-29 19:18:30 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use tags and autocomplete for excluded keywords

Browse source
This commit is contained in:
Taylor Buchanan 2019-10-25 01:56:56 -05:00
parent 22d47512b6
commit 721ef47bb2
16 changed files with 223 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/Ombi.Settings/Settings/Models/External/TheMovieDbSettings.cs vendored
View file

@ -1,9 +1,11 @@
namespace Ombi.Core.Settings.Models.External
using System.Collections.Generic;
namespace Ombi.Core.Settings.Models.External
{
public sealed class TheMovieDbSettings : Ombi.Settings.Settings.Models.Settings
{
public bool ShowAdultMovies { get; set; }
public string ExcludedKeywordIds { get; set; }
public List<int> ExcludedKeywordIds { get; set; }
}
}

2
src/Ombi.TheMovieDbApi/IMovieDbApi.cs
View file

@ -21,5 +21,7 @@ namespace Ombi.Api.TheMovieDb
Task<TvInfo> GetTVInfo(string themoviedbid);
Task<TheMovieDbContainer<ActorResult>> SearchByActor(string searchTerm, string langCode);
Task<ActorCredits> GetActorMovieCredits(int actorId, string langCode);
Task<List<Keyword>> SearchKeyword(string searchTerm);
Task<Keyword> GetKeyword(int keywordId);
}
}

13
src/Ombi.TheMovieDbApi/Models/Keyword.cs Normal file
View file

@ -0,0 +1,13 @@
using System.Runtime.Serialization;
namespace Ombi.Api.TheMovieDb.Models
{
public sealed class Keyword
{
[DataMember(Name = "id")]
public int Id { get; set; }
[DataMember(Name = "name")]
public string Name { get; set; }
}
}

53
src/Ombi.TheMovieDbApi/TheMovieDbApi.cs
View file

@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;
@ -142,10 +143,7 @@ namespace Ombi.Api.TheMovieDb
request.AddQueryString("api_key", ApiToken);
request.AddQueryString("language", langCode);
request.AddQueryString("sort_by", "popularity.desc");
var settings = await Settings;
request.AddQueryString("include_adult", settings.ShowAdultMovies.ToString().ToLower());
request.AddQueryString("without_keywords", settings.ExcludedKeywordIds);
await AddDiscoverMovieSettings(request);
AddRetry(request);
var result = await Api.Request<TheMovieDbContainer<SearchResult>>(request);
return Mapper.Map<List<MovieSearchResult>>(result.results);
@ -166,10 +164,7 @@ namespace Ombi.Api.TheMovieDb
// to filter out extremely high-rated movies due to very little votes
request.AddQueryString("vote_count.gte", "250");
var settings = await Settings;
request.AddQueryString("include_adult", settings.ShowAdultMovies.ToString().ToLower());
request.AddQueryString("without_keywords", settings.ExcludedKeywordIds);
await AddDiscoverMovieSettings(request);
AddRetry(request);
var result = await Api.Request<TheMovieDbContainer<SearchResult>>(request);
return Mapper.Map<List<MovieSearchResult>>(result.results);
@ -193,10 +188,7 @@ namespace Ombi.Api.TheMovieDb
request.AddQueryString("release_date.gte", startDate.ToString("yyyy-MM-dd"));
request.AddQueryString("release_date.lte", startDate.AddDays(17).ToString("yyyy-MM-dd"));
var settings = await Settings;
request.AddQueryString("include_adult", settings.ShowAdultMovies.ToString().ToLower());
request.AddQueryString("without_keywords", settings.ExcludedKeywordIds);
await AddDiscoverMovieSettings(request);
AddRetry(request);
var result = await Api.Request<TheMovieDbContainer<SearchResult>>(request);
return Mapper.Map<List<MovieSearchResult>>(result.results);
@ -220,10 +212,7 @@ namespace Ombi.Api.TheMovieDb
request.AddQueryString("release_date.gte", today.AddDays(-42).ToString("yyyy-MM-dd"));
request.AddQueryString("release_date.lte", today.AddDays(6).ToString("yyyy-MM-dd"));
var settings = await Settings;
request.AddQueryString("include_adult", settings.ShowAdultMovies.ToString().ToLower());
request.AddQueryString("without_keywords", settings.ExcludedKeywordIds);
await AddDiscoverMovieSettings(request);
AddRetry(request);
var result = await Api.Request<TheMovieDbContainer<SearchResult>>(request);
return Mapper.Map<List<MovieSearchResult>>(result.results);
@ -237,6 +226,38 @@ namespace Ombi.Api.TheMovieDb
return await Api.Request<TvInfo>(request);
}
public async Task<List<Keyword>> SearchKeyword(string searchTerm)
{
var request = new Request("search/keyword", BaseUri, HttpMethod.Get);
request.AddQueryString("api_key", ApiToken);
request.AddQueryString("query", searchTerm);
AddRetry(request);
var result = await Api.Request<TheMovieDbContainer<Keyword>>(request);
return result.results ?? new List<Keyword>();
}
public async Task<Keyword> GetKeyword(int keywordId)
{
var request = new Request($"keyword/{keywordId}", BaseUri, HttpMethod.Get);
request.AddQueryString("api_key", ApiToken);
AddRetry(request);
var keyword = await Api.Request<Keyword>(request);
return keyword == null || keyword.Id == 0 ? null : keyword;
}
private async Task AddDiscoverMovieSettings(Request request)
{
var settings = await Settings;
request.AddQueryString("include_adult", settings.ShowAdultMovies.ToString().ToLower());
if (settings.ExcludedKeywordIds?.Any() == true)
{
request.AddQueryString("without_keywords", string.Join(",", settings.ExcludedKeywordIds));
}
}
private static void AddRetry(Request request)
{
request.Retry = true;

4
src/Ombi/ClientApp/app/interfaces/IMovieDb.ts Normal file
View file

@ -0,0 +1,4 @@
export interface IMovieDbKeyword {
id: number;
name: string;
}

2
src/Ombi/ClientApp/app/interfaces/ISettings.ts
View file

@ -248,5 +248,5 @@ export interface IVoteSettings extends ISettings {
export interface ITheMovieDbSettings extends ISettings {
showAdultMovies: boolean;
excludedKeywordIds: string;
excludedKeywordIds: number[];
}

1
src/Ombi/ClientApp/app/interfaces/index.ts
View file

@ -3,6 +3,7 @@ export * from "./ICouchPotato";
export * from "./IImages";
export * from "./IMediaServerStatus";
export * from "./INotificationSettings";
export * from "./IMovieDb";
export * from "./IPlex";
export * from "./IRadarr";
export * from "./IRequestEngineResult";

1
src/Ombi/ClientApp/app/services/applications/index.ts
View file

@ -7,3 +7,4 @@ export * from "./tester.service";
export * from "./plexoauth.service";
export * from "./plextv.service";
export * from "./lidarr.service";
export * from "./themoviedb.service";

25
src/Ombi/ClientApp/app/services/applications/themoviedb.service.ts Normal file
View file

@ -0,0 +1,25 @@
import { PlatformLocation } from "@angular/common";
import { HttpClient, HttpErrorResponse, HttpParams } from "@angular/common/http";
import { Injectable } from "@angular/core";
import { empty, Observable, throwError } from "rxjs";
import { catchError } from "rxjs/operators";
import { IMovieDbKeyword } from "../../interfaces";
import { ServiceHelpers } from "../service.helpers";
@Injectable()
export class TheMovieDbService extends ServiceHelpers {
constructor(http: HttpClient, public platformLocation: PlatformLocation) {
super(http, "/api/v1/TheMovieDb", platformLocation);
}
public getKeywords(searchTerm: string): Observable<IMovieDbKeyword[]> {
const params = new HttpParams().set("searchTerm", searchTerm);
return this.http.get<IMovieDbKeyword[]>(`${this.url}/Keywords`, {headers: this.headers, params});
}
public getKeyword(keywordId: number): Observable<IMovieDbKeyword> {
return this.http.get<IMovieDbKeyword>(`${this.url}/Keywords/${keywordId}`, { headers: this.headers })
.pipe(catchError((error: HttpErrorResponse) => error.status === 404 ? empty() : throwError(error)));
}
}

5
src/Ombi/ClientApp/app/settings/settings.module.ts
View file

@ -3,13 +3,14 @@ import { NgModule } from "@angular/core";
import { FormsModule, ReactiveFormsModule } from "@angular/forms";
import { RouterModule, Routes } from "@angular/router";
import { NgbAccordionModule, NgbModule } from "@ng-bootstrap/ng-bootstrap";
import { TagInputModule } from "ngx-chips";
import { ClipboardModule } from "ngx-clipboard";
import { AuthGuard } from "../auth/auth.guard";
import { AuthService } from "../auth/auth.service";
import {
CouchPotatoService, EmbyService, IssuesService, JobService, LidarrService, MobileService, NotificationMessageService, PlexService, RadarrService,
RequestRetryService, SonarrService, TesterService, ValidationService,
RequestRetryService, SonarrService, TesterService, TheMovieDbService, ValidationService,
} from "../services";
import { PipeModule } from "../pipes/pipe.module";
@ -99,6 +100,7 @@ const routes: Routes = [
NgbAccordionModule,
AutoCompleteModule,
CalendarModule,
TagInputModule,
ClipboardModule,
PipeModule,
RadioButtonModule,
@ -159,6 +161,7 @@ const routes: Routes = [
NotificationMessageService,
LidarrService,
RequestRetryService,
TheMovieDbService,
],
})

31
src/Ombi/ClientApp/app/settings/themoviedb/themoviedb.component.html
View file

@ -11,13 +11,34 @@
</div>
<div class="form-group">
<label for="excludedKeywordIds" class="control-label" pTooltip="Prevent movies with certain keywords from being suggested. May require a restart to take effect.">
<label class="control-label" pTooltip="Prevent movies with certain keywords from being suggested. May require a restart to take effect.">
Excluded Keyword IDs for Movie Suggestions
</label>
<div>
<input type="text" [(ngModel)]="settings.excludedKeywordIds" class="form-control form-control-custom " id="excludedKeywordIds"
name="excludedKeywordIds" placeholder="155477,190370,250773" value="{{settings.excludedKeywordIds}}">
</div>
<tag-input #input
[(ngModel)]="excludedKeywords"
[identifyBy]="'id'" [displayBy]="'name'"
[placeholder]="'Search by keyword'"
[secondaryPlaceholder]="'Search by keyword'"
[theme]="'dark'"
[onTextChangeDebounce]="500"
[onAdding]="onAddingKeyword"
(onSelect)="onKeywordSelect($event)">
<ng-template item-template let-item="item" let-index="index">
<span class="fa fa-cloud-download" *ngIf="item.initial"></span>
<span>{{item.id}}</span>
<span *ngIf="!item.initial">&nbsp;({{item.name}})</span>
<delete-icon aria-label="Remove tag" role="button"
(click)="input.removeItem(item, index)">
</delete-icon>
</ng-template>
<tag-input-dropdown [autocompleteObservable]="autocompleteKeyword"
[identifyBy]="'id'" [displayBy]="'name'"
[limitItemsTo]="6"
[minimumTextLength]="1"
[showDropdownIfEmpty]="false"
[keepOpen]="false">
</tag-input-dropdown>
</tag-input>
</div>
<div class="form-group">

47
src/Ombi/ClientApp/app/settings/themoviedb/themoviedb.component.ts
View file

@ -1,8 +1,16 @@
import { Component, OnInit } from "@angular/core";
import { empty, of } from "rxjs";
import { ITheMovieDbSettings } from "../../interfaces";
import { NotificationService } from "../../services";
import { SettingsService } from "../../services";
import { TheMovieDbService } from "../../services";
interface IKeywordTag {
id: number;
name: string;
initial: boolean;
}
@Component({
templateUrl: "./themoviedb.component.html",
@ -10,17 +18,48 @@ import { SettingsService } from "../../services";
export class TheMovieDbComponent implements OnInit {
public settings: ITheMovieDbSettings;
public advanced: boolean;
public excludedKeywords: IKeywordTag[];
constructor(private settingsService: SettingsService, private notificationService: NotificationService) { }
constructor(private settingsService: SettingsService,
private notificationService: NotificationService,
private tmdbService: TheMovieDbService) { }
public ngOnInit() {
this.settingsService.getTheMovieDbSettings().subscribe(x => {
this.settings = x;
this.settingsService.getTheMovieDbSettings().subscribe(settings => {
this.settings = settings;
this.excludedKeywords = settings.excludedKeywordIds
? settings.excludedKeywordIds.map(id => ({
id,
name: "",
initial: true,
}))
: [];
});
}
public autocompleteKeyword = (text: string) => this.tmdbService.getKeywords(text);
public onAddingKeyword = (tag: string | IKeywordTag) => {
if (typeof tag === "string") {
const id = Number(tag);
return isNaN(id) ? empty() : this.tmdbService.getKeyword(id);
} else {
return of(tag);
}
}
public onKeywordSelect = (keyword: IKeywordTag) => {
if (keyword.initial) {
this.tmdbService.getKeyword(keyword.id)
.subscribe(k => {
keyword.name = k.name;
keyword.initial = false;
});
}
}
public save() {
this.settings.excludedKeywordIds = this.excludedKeywords.map(k => k.id);
this.settingsService.saveTheMovieDbSettings(this.settings).subscribe(x => {
if (x) {
this.notificationService.success("Successfully saved The Movie Database settings");

8
src/Ombi/ClientApp/styles/base.scss
View file

@ -1010,6 +1010,14 @@ a > h4:hover {
width:300px;
}
.ng2-tag-input.dark input {
background: transparent;
color: white;
}
.ng2-tag-input .fa-cloud-download {
margin-right: 5px;
}
::ng-deep ngb-accordion > div.card > div.card-header {
padding:0px;

38
src/Ombi/Controllers/External/TheMovieDbController.cs vendored Normal file
View file

@ -0,0 +1,38 @@
using Microsoft.AspNetCore.Mvc;
using Ombi.Api.TheMovieDb;
using Ombi.Api.TheMovieDb.Models;
using Ombi.Attributes;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace Ombi.Controllers.External
{
[Admin]
[ApiV1]
[Produces("application/json")]
public sealed class TheMovieDbController : Controller
{
public TheMovieDbController(IMovieDbApi tmdbApi) => TmdbApi = tmdbApi;
private IMovieDbApi TmdbApi { get; }
/// <summary>
/// Searches for keywords matching the specified term.
/// </summary>
/// <param name="searchTerm">The search term.</param>
[HttpGet("Keywords")]
public async Task<IEnumerable<Keyword>> GetKeywords([FromQuery]string searchTerm) =>
await TmdbApi.SearchKeyword(searchTerm);
/// <summary>
/// Gets the keyword matching the specified ID.
/// </summary>
/// <param name="keywordId">The keyword ID.</param>
[HttpGet("Keywords/{keywordId}")]
public async Task<IActionResult> GetKeywords(int keywordId)
{
var keyword = await TmdbApi.GetKeyword(keywordId);
return keyword == null ? NotFound() : (IActionResult)Ok(keyword);
}
}
}

1
src/Ombi/package.json
View file

@ -63,6 +63,7 @@
"natives": "1.1.6",
"ng2-cookies": "^1.0.12",
"ngx-bootstrap": "^3.1.4",
"ngx-chips": "^2.1.0",
"ngx-clipboard": "^11.1.1",
"ngx-editor": "^4.1.0",
"ngx-infinite-scroll": "^6.0.1",

15
src/Ombi/yarn.lock
View file

@ -4183,10 +4183,25 @@ ng2-cookies@^1.0.12:
version "1.0.12"
resolved "https://registry.yarnpkg.com/ng2-cookies/-/ng2-cookies-1.0.12.tgz#3f3e613e0137b0649b705c678074b4bd08149ccc"
ng2-material-dropdown@0.11.0:
version "0.11.0"
resolved "https://registry.yarnpkg.com/ng2-material-dropdown/-/ng2-material-dropdown-0.11.0.tgz#27a402ef3cbdcaf6791ef4cfd4b257e31db7546f"
integrity sha512-wptBo09qKecY0QPTProAThrc4A3ajJTcHE9LTpCG5XZZUhXLBzhnGK8OW33TN8A+K/jqcs7OB74ppYJiqs3nhQ==
dependencies:
tslib "^1.9.0"
ngx-bootstrap@^3.1.4:
version "3.1.4"
resolved "https://registry.yarnpkg.com/ngx-bootstrap/-/ngx-bootstrap-3.1.4.tgz#5105c0227da3b51a1972d04efa1504a79474fd57"
ngx-chips@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/ngx-chips/-/ngx-chips-2.1.0.tgz#aa299bcf40dc3e1f6288bf1d29e2fdfe9a132ed3"
integrity sha512-OQV4dTfD3nXm5d2mGKUSgwOtJOaMnZ4F+lwXOtd7DWRSUne0JQWwoZNHdOpuS6saBGhqCPDAwq6KxdR5XSgZUQ==
dependencies:
ng2-material-dropdown "0.11.0"
tslib "^1.9.0"
ngx-clipboard@^11.1.1:
version "11.1.9"
resolved "https://registry.yarnpkg.com/ngx-clipboard/-/ngx-clipboard-11.1.9.tgz#a391853dc49e436de407260863a2c814d73a9332"