New: Ability to tag series
New: Use tags to control which series use which notification channels
pull/126/merge
Mark McDowall 10 years ago
parent 0e436f371b
commit e82b29e346

@ -1,4 +1,5 @@
using System; using System;
using System.Collections.Generic;
namespace NzbDrone.Api.Notifications namespace NzbDrone.Api.Notifications
{ {
@ -9,5 +10,6 @@ namespace NzbDrone.Api.Notifications
public Boolean OnDownload { get; set; } public Boolean OnDownload { get; set; }
public Boolean OnUpgrade { get; set; } public Boolean OnUpgrade { get; set; }
public String TestCommand { get; set; } public String TestCommand { get; set; }
public HashSet<Int32> Tags { get; set; }
} }
} }

@ -212,6 +212,8 @@
<Compile Include="System\Tasks\TaskModule.cs" /> <Compile Include="System\Tasks\TaskModule.cs" />
<Compile Include="System\Tasks\TaskResource.cs" /> <Compile Include="System\Tasks\TaskResource.cs" />
<Compile Include="System\SystemModule.cs" /> <Compile Include="System\SystemModule.cs" />
<Compile Include="Tags\TagModule.cs" />
<Compile Include="Tags\TagResource.cs" />
<Compile Include="TinyIoCNancyBootstrapper.cs" /> <Compile Include="TinyIoCNancyBootstrapper.cs" />
<Compile Include="Update\UpdateModule.cs" /> <Compile Include="Update\UpdateModule.cs" />
<Compile Include="Update\UpdateResource.cs" /> <Compile Include="Update\UpdateResource.cs" />

@ -65,6 +65,7 @@ namespace NzbDrone.Api.Series
public String RootFolderPath { get; set; } public String RootFolderPath { get; set; }
public String Certification { get; set; } public String Certification { get; set; }
public List<String> Genres { get; set; } public List<String> Genres { get; set; }
public HashSet<Int32> Tags { get; set; }
//Used to support legacy consumers //Used to support legacy consumers
public Int32 QualityProfileId public Int32 QualityProfileId

@ -0,0 +1,48 @@
using System;
using System.Collections.Generic;
using NzbDrone.Api.Mapping;
using NzbDrone.Core.Tags;
namespace NzbDrone.Api.Tags
{
public class TagModule : NzbDroneRestModule<TagResource>
{
private readonly ITagService _tagService;
public TagModule(ITagService tagService)
{
_tagService = tagService;
GetResourceById = Get;
GetResourceAll = GetAll;
CreateResource = Create;
UpdateResource = Update;
DeleteResource = Delete;
}
private TagResource Get(Int32 id)
{
return _tagService.GetTag(id).InjectTo<TagResource>();
}
private List<TagResource> GetAll()
{
return ToListResource(_tagService.All);
}
private Int32 Create(TagResource resource)
{
return _tagService.Add(resource.InjectTo<Tag>()).Id;
}
private void Update(TagResource resource)
{
_tagService.Update(resource.InjectTo<Tag>());
}
private void Delete(Int32 id)
{
_tagService.Delete(id);
}
}
}

@ -0,0 +1,10 @@
using System;
using NzbDrone.Api.REST;
namespace NzbDrone.Api.Tags
{
public class TagResource : RestResource
{
public String Label { get; set; }
}
}

@ -0,0 +1,21 @@
using FluentMigrator;
using NzbDrone.Core.Datastore.Migration.Framework;
namespace NzbDrone.Core.Datastore.Migration
{
[Migration(66)]
public class add_tags : NzbDroneMigrationBase
{
protected override void MainDbUpgrade()
{
Create.TableForModel("Tags")
.WithColumn("Label").AsString().NotNullable();
Alter.Table("Series")
.AddColumn("Tags").AsString().Nullable();
Alter.Table("Notifications")
.AddColumn("Tags").AsString().Nullable();
}
}
}

@ -24,6 +24,7 @@ using NzbDrone.Core.Profiles;
using NzbDrone.Core.Qualities; using NzbDrone.Core.Qualities;
using NzbDrone.Core.RootFolders; using NzbDrone.Core.RootFolders;
using NzbDrone.Core.SeriesStats; using NzbDrone.Core.SeriesStats;
using NzbDrone.Core.Tags;
using NzbDrone.Core.ThingiProvider; using NzbDrone.Core.ThingiProvider;
using NzbDrone.Core.Tv; using NzbDrone.Core.Tv;
@ -90,6 +91,7 @@ namespace NzbDrone.Core.Datastore
.Ignore(e => e.RemoteEpisode); .Ignore(e => e.RemoteEpisode);
Mapper.Entity<RemotePathMapping>().RegisterModel("RemotePathMappings"); Mapper.Entity<RemotePathMapping>().RegisterModel("RemotePathMappings");
Mapper.Entity<Tag>().RegisterModel("Tags");
} }
private static void RegisterMappers() private static void RegisterMappers()
@ -104,11 +106,12 @@ namespace NzbDrone.Core.Datastore
MapRepository.Instance.RegisterTypeConverter(typeof(Quality), new QualityIntConverter()); MapRepository.Instance.RegisterTypeConverter(typeof(Quality), new QualityIntConverter());
MapRepository.Instance.RegisterTypeConverter(typeof(List<ProfileQualityItem>), new EmbeddedDocumentConverter(new QualityIntConverter())); MapRepository.Instance.RegisterTypeConverter(typeof(List<ProfileQualityItem>), new EmbeddedDocumentConverter(new QualityIntConverter()));
MapRepository.Instance.RegisterTypeConverter(typeof(QualityModel), new EmbeddedDocumentConverter(new QualityIntConverter())); MapRepository.Instance.RegisterTypeConverter(typeof(QualityModel), new EmbeddedDocumentConverter(new QualityIntConverter()));
MapRepository.Instance.RegisterTypeConverter(typeof(Dictionary<string, string>), new EmbeddedDocumentConverter()); MapRepository.Instance.RegisterTypeConverter(typeof(Dictionary<String, String>), new EmbeddedDocumentConverter());
MapRepository.Instance.RegisterTypeConverter(typeof(List<int>), new EmbeddedDocumentConverter()); MapRepository.Instance.RegisterTypeConverter(typeof(List<Int32>), new EmbeddedDocumentConverter());
MapRepository.Instance.RegisterTypeConverter(typeof(List<string>), new EmbeddedDocumentConverter()); MapRepository.Instance.RegisterTypeConverter(typeof(List<String>), new EmbeddedDocumentConverter());
MapRepository.Instance.RegisterTypeConverter(typeof(ParsedEpisodeInfo), new EmbeddedDocumentConverter()); MapRepository.Instance.RegisterTypeConverter(typeof(ParsedEpisodeInfo), new EmbeddedDocumentConverter());
MapRepository.Instance.RegisterTypeConverter(typeof(ReleaseInfo), new EmbeddedDocumentConverter()); MapRepository.Instance.RegisterTypeConverter(typeof(ReleaseInfo), new EmbeddedDocumentConverter());
MapRepository.Instance.RegisterTypeConverter(typeof(HashSet<Int32>), new EmbeddedDocumentConverter());
} }
private static void RegisterProviderSettingConverter() private static void RegisterProviderSettingConverter()
@ -128,9 +131,11 @@ namespace NzbDrone.Core.Datastore
var embeddedConvertor = new EmbeddedDocumentConverter(); var embeddedConvertor = new EmbeddedDocumentConverter();
var genericListDefinition = typeof(List<>).GetGenericTypeDefinition(); var genericListDefinition = typeof(List<>).GetGenericTypeDefinition();
foreach (var embeddedType in embeddedTypes) foreach (var embeddedType in embeddedTypes)
{ {
var embeddedListType = genericListDefinition.MakeGenericType(embeddedType); var embeddedListType = genericListDefinition.MakeGenericType(embeddedType);
MapRepository.Instance.RegisterTypeConverter(embeddedType, embeddedConvertor); MapRepository.Instance.RegisterTypeConverter(embeddedType, embeddedConvertor);
MapRepository.Instance.RegisterTypeConverter(embeddedListType, embeddedConvertor); MapRepository.Instance.RegisterTypeConverter(embeddedListType, embeddedConvertor);
} }

@ -1,13 +1,20 @@
using System; using System;
using System.Collections.Generic;
using NzbDrone.Core.ThingiProvider; using NzbDrone.Core.ThingiProvider;
namespace NzbDrone.Core.Notifications namespace NzbDrone.Core.Notifications
{ {
public class NotificationDefinition : ProviderDefinition public class NotificationDefinition : ProviderDefinition
{ {
public NotificationDefinition()
{
Tags = new HashSet<Int32>();
}
public Boolean OnGrab { get; set; } public Boolean OnGrab { get; set; }
public Boolean OnDownload { get; set; } public Boolean OnDownload { get; set; }
public Boolean OnUpgrade { get; set; } public Boolean OnUpgrade { get; set; }
public HashSet<Int32> Tags { get; set; }
public override Boolean Enable public override Boolean Enable
{ {

@ -2,10 +2,12 @@
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using System.Linq;
using NLog; using NLog;
using NzbDrone.Common;
using NzbDrone.Core.Download; using NzbDrone.Core.Download;
using NzbDrone.Core.MediaFiles.Events; using NzbDrone.Core.MediaFiles.Events;
using NzbDrone.Core.Messaging.Events; using NzbDrone.Core.Messaging.Events;
using NzbDrone.Core.Qualities; using NzbDrone.Core.Qualities;
using NzbDrone.Core.ThingiProvider;
using NzbDrone.Core.Tv; using NzbDrone.Core.Tv;
namespace NzbDrone.Core.Notifications namespace NzbDrone.Core.Notifications
@ -65,6 +67,27 @@ namespace NzbDrone.Core.Notifications
qualityString); qualityString);
} }
private bool ShouldHandleSeries(ProviderDefinition definition, Series series)
{
var notificationDefinition = (NotificationDefinition) definition;
if (notificationDefinition.Tags.Empty())
{
_logger.Debug("No tags set for this notification.");
return true;
}
if (notificationDefinition.Tags.Intersect(series.Tags).Any())
{
_logger.Debug("Notification and series have one or more matching tags.");
return true;
}
//TODO: this message could be more clear
_logger.Debug("{0} does not have any tags that match {1}'s tags", notificationDefinition.Name, series.Title);
return false;
}
public void Handle(EpisodeGrabbedEvent message) public void Handle(EpisodeGrabbedEvent message)
{ {
var messageBody = GetMessage(message.Episode.Series, message.Episode.Episodes, message.Episode.ParsedEpisodeInfo.Quality); var messageBody = GetMessage(message.Episode.Series, message.Episode.Episodes, message.Episode.ParsedEpisodeInfo.Quality);
@ -73,6 +96,7 @@ namespace NzbDrone.Core.Notifications
{ {
try try
{ {
if (!ShouldHandleSeries(notification.Definition, message.Episode.Series)) continue;
notification.OnGrab(messageBody); notification.OnGrab(messageBody);
} }
@ -95,12 +119,13 @@ namespace NzbDrone.Core.Notifications
{ {
try try
{ {
if (downloadMessage.OldFiles.Any() && !((NotificationDefinition) notification.Definition).OnUpgrade) if (ShouldHandleSeries(notification.Definition, message.Episode.Series))
{ {
continue; if (downloadMessage.OldFiles.Empty() || ((NotificationDefinition)notification.Definition).OnUpgrade)
{
notification.OnDownload(downloadMessage);
}
} }
notification.OnDownload(downloadMessage);
} }
catch (Exception ex) catch (Exception ex)
@ -116,7 +141,10 @@ namespace NzbDrone.Core.Notifications
{ {
try try
{ {
notification.AfterRename(message.Series); if (ShouldHandleSeries(notification.Definition, message.Series))
{
notification.AfterRename(message.Series);
}
} }
catch (Exception ex) catch (Exception ex)

@ -230,6 +230,7 @@
<Compile Include="Datastore\Migration\060_remove_enable_from_indexers.cs" /> <Compile Include="Datastore\Migration\060_remove_enable_from_indexers.cs" />
<Compile Include="Datastore\Migration\062_convert_quality_models.cs" /> <Compile Include="Datastore\Migration\062_convert_quality_models.cs" />
<Compile Include="Datastore\Migration\065_make_scene_numbering_nullable.cs" /> <Compile Include="Datastore\Migration\065_make_scene_numbering_nullable.cs" />
<Compile Include="Datastore\Migration\066_add_tags.cs" />
<Compile Include="Datastore\Migration\Framework\MigrationContext.cs" /> <Compile Include="Datastore\Migration\Framework\MigrationContext.cs" />
<Compile Include="Datastore\Migration\Framework\MigrationController.cs" /> <Compile Include="Datastore\Migration\Framework\MigrationController.cs" />
<Compile Include="Datastore\Migration\Framework\MigrationExtension.cs" /> <Compile Include="Datastore\Migration\Framework\MigrationExtension.cs" />
@ -720,6 +721,9 @@
<Compile Include="SeriesStats\SeriesStatistics.cs" /> <Compile Include="SeriesStats\SeriesStatistics.cs" />
<Compile Include="SeriesStats\SeriesStatisticsRepository.cs" /> <Compile Include="SeriesStats\SeriesStatisticsRepository.cs" />
<Compile Include="SeriesStats\SeriesStatisticsService.cs" /> <Compile Include="SeriesStats\SeriesStatisticsService.cs" />
<Compile Include="Tags\Tag.cs" />
<Compile Include="Tags\TagRepository.cs" />
<Compile Include="Tags\TagService.cs" />
<Compile Include="ThingiProvider\ConfigContractNotFoundException.cs" /> <Compile Include="ThingiProvider\ConfigContractNotFoundException.cs" />
<Compile Include="ThingiProvider\Events\ProviderUpdatedEvent.cs" /> <Compile Include="ThingiProvider\Events\ProviderUpdatedEvent.cs" />
<Compile Include="ThingiProvider\IProvider.cs" /> <Compile Include="ThingiProvider\IProvider.cs" />

@ -0,0 +1,10 @@
using System;
using NzbDrone.Core.Datastore;
namespace NzbDrone.Core.Tags
{
public class Tag : ModelBase
{
public String Label { get; set; }
}
}

@ -0,0 +1,18 @@
using NzbDrone.Core.Datastore;
using NzbDrone.Core.Messaging.Events;
namespace NzbDrone.Core.Tags
{
public interface ITagRepository : IBasicRepository<Tag>
{
}
public class TagRepository : BasicRepository<Tag>, ITagRepository
{
public TagRepository(IDatabase database, IEventAggregator eventAggregator)
: base(database, eventAggregator)
{
}
}
}

@ -0,0 +1,50 @@
using System;
using System.Collections.Generic;
using System.Linq;
namespace NzbDrone.Core.Tags
{
public interface ITagService
{
Tag GetTag(Int32 tagId);
List<Tag> All();
Tag Add(Tag tag);
Tag Update(Tag tag);
void Delete(Int32 tagId);
}
public class TagService : ITagService
{
private readonly ITagRepository _tagRepository;
public TagService(ITagRepository tagRepository)
{
_tagRepository = tagRepository;
}
public Tag GetTag(Int32 tagId)
{
return _tagRepository.Get(tagId);
}
public List<Tag> All()
{
return _tagRepository.All().ToList();
}
public Tag Add(Tag tag)
{
return _tagRepository.Insert(tag);
}
public Tag Update(Tag tag)
{
return _tagRepository.Update(tag);
}
public void Delete(Int32 tagId)
{
_tagRepository.Delete(tagId);
}
}
}

@ -5,7 +5,6 @@ using NzbDrone.Core.Datastore;
using NzbDrone.Core.Profiles; using NzbDrone.Core.Profiles;
using NzbDrone.Common; using NzbDrone.Common;
namespace NzbDrone.Core.Tv namespace NzbDrone.Core.Tv
{ {
public class Series : ModelBase public class Series : ModelBase
@ -15,6 +14,7 @@ namespace NzbDrone.Core.Tv
Images = new List<MediaCover.MediaCover>(); Images = new List<MediaCover.MediaCover>();
Genres = new List<String>(); Genres = new List<String>();
Actors = new List<Actor>(); Actors = new List<Actor>();
Tags = new HashSet<Int32>();
} }
public int TvdbId { get; set; } public int TvdbId { get; set; }
@ -49,6 +49,7 @@ namespace NzbDrone.Core.Tv
public LazyLoaded<Profile> Profile { get; set; } public LazyLoaded<Profile> Profile { get; set; }
public List<Season> Seasons { get; set; } public List<Season> Seasons { get; set; }
public HashSet<Int32> Tags { get; set; }
public override string ToString() public override string ToString()
{ {

@ -0,0 +1,35 @@
@import "../Bootstrap/variables";
.bootstrap-tagsinput {
width : 100%;
.twitter-typeahead {
width : auto;
}
.tag {
margin-right: 0px;
[data-role="remove"] {
&:hover {
color: @brand-danger;
}
}
}
.tt-dropdown-menu {
.opacity(0.95);
.tt-suggestion {
color: #222222;
cursor: pointer;
//selected item
&.tt-cursor {
background-color: @droneTeal;
color: #ffffff;
}
}
}
}

@ -1,2 +1,3 @@
@import "./Bootstrap/bootstrap"; @import "./Bootstrap/bootstrap";
@import "./Overrides/bootstrap"; @import "./Overrides/bootstrap";
@import "./bootstrap.tagsinput.less";

@ -0,0 +1,50 @@
.bootstrap-tagsinput {
background-color: #fff;
border: 1px solid #ccc;
box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
display: inline-block;
padding: 4px 6px;
margin-bottom: 10px;
color: #555;
vertical-align: middle;
border-radius: 4px;
max-width: 100%;
line-height: 22px;
cursor: text;
input {
border: none;
box-shadow: none;
outline: none;
background-color: transparent;
padding: 0;
margin: 0;
width: auto !important;
max-width: inherit;
&:focus {
border: none;
box-shadow: none;
}
}
.tag {
margin-right: 2px;
color: white;
[data-role="remove"] {
margin-left:8px;
cursor:pointer;
&:after{
content: "x";
padding:0px 2px;
}
&:hover {
box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05);
&:active {
box-shadow: inset 0 3px 5px rgba(0,0,0,0.125);
}
}
}
}
}

@ -1,5 +1,6 @@
@import "Overrides/bootstrap"; @import "Overrides/bootstrap";
@import "Overrides/browser"; @import "Overrides/browser";
@import "Overrides/bootstrap.toggle-switch"; @import "Overrides/bootstrap.toggle-switch";
@import "Overrides/bootstrap.tagsinput.less";
@import "Overrides/fullcalendar"; @import "Overrides/fullcalendar";
@import "Overrides/messenger"; @import "Overrides/messenger";

@ -0,0 +1,617 @@
(function ($) {
"use strict";
var defaultOptions = {
tagClass: function(item) {
return 'label label-info';
},
itemValue: function(item) {
return item ? item.toString() : item;
},
itemText: function(item) {
return this.itemValue(item);
},
freeInput: true,
addOnBlur: true,
maxTags: undefined,
maxChars: undefined,
confirmKeys: [13, 44],
onTagExists: function(item, $tag) {
$tag.hide().fadeIn();
},
trimValue: false,
allowDuplicates: false
};
/**
* Constructor function
*/
function TagsInput(element, options) {
this.itemsArray = [];
this.$element = $(element);
this.$element.hide();
this.isSelect = (element.tagName === 'SELECT');
this.multiple = (this.isSelect && element.hasAttribute('multiple'));
this.objectItems = options && options.itemValue;
this.placeholderText = element.hasAttribute('placeholder') ? this.$element.attr('placeholder') : '';
this.inputSize = Math.max(1, this.placeholderText.length);
this.$container = $('<div class="bootstrap-tagsinput"></div>');
this.$input = $('<input type="text" placeholder="' + this.placeholderText + '"/>').appendTo(this.$container);
this.$element.after(this.$container);
// var inputWidth = (this.inputSize < 3 ? 3 : this.inputSize) + "em";
// this.$input.get(0).style.cssText = "width: " + inputWidth + " !important;";
this.build(options);
}
TagsInput.prototype = {
constructor: TagsInput,
/**
* Adds the given item as a new tag. Pass true to dontPushVal to prevent
* updating the elements val()
*/
add: function(item, dontPushVal) {
var self = this;
if (self.options.maxTags && self.itemsArray.length >= self.options.maxTags)
return;
// Ignore falsey values, except false
if (item !== false && !item)
return;
// Trim value
if (typeof item === "string" && self.options.trimValue) {
item = $.trim(item);
}
// Throw an error when trying to add an object while the itemValue option was not set
if (typeof item === "object" && !self.objectItems)
throw("Can't add objects when itemValue option is not set");
// Ignore strings only containg whitespace
if (item.toString().match(/^\s*$/))
return;
// If SELECT but not multiple, remove current tag
if (self.isSelect && !self.multiple && self.itemsArray.length > 0)
self.remove(self.itemsArray[0]);
if (typeof item === "string" && this.$element[0].tagName === 'INPUT') {
var items = item.split(',');
if (items.length > 1) {
for (var i = 0; i < items.length; i++) {
this.add(items[i], true);
}
if (!dontPushVal)
self.pushVal();
return;
}
}
var itemValue = self.options.itemValue(item),
itemText = self.options.itemText(item),
tagClass = self.options.tagClass(item);
// Ignore items allready added
var existing = $.grep(self.itemsArray, function(item) { return self.options.itemValue(item) === itemValue; } )[0];
if (existing && !self.options.allowDuplicates) {
// Invoke onTagExists
if (self.options.onTagExists) {
var $existingTag = $(".tag", self.$container).filter(function() { return $(this).data("item") === existing; });
self.options.onTagExists(item, $existingTag);
}
return;
}
// if length greater than limit
if (self.items().toString().length + item.length + 1 > self.options.maxInputLength)
return;
// raise beforeItemAdd arg
var beforeItemAddEvent = $.Event('beforeItemAdd', { item: item, cancel: false });
self.$element.trigger(beforeItemAddEvent);
if (beforeItemAddEvent.cancel)
return;
// register item in internal array and map
self.itemsArray.push(item);
// add a tag element
var $tag = $('<span class="tag ' + htmlEncode(tagClass) + '">' + htmlEncode(itemText) + '<span data-role="remove"></span></span>');
$tag.data('item', item);
self.findInputWrapper().before($tag);
$tag.after(' ');
// add <option /> if item represents a value not present in one of the <select />'s options
if (self.isSelect && !$('option[value="' + encodeURIComponent(itemValue) + '"]',self.$element)[0]) {
var $option = $('<option selected>' + htmlEncode(itemText) + '</option>');
$option.data('item', item);
$option.attr('value', itemValue);
self.$element.append($option);
}
if (!dontPushVal)
self.pushVal();
// Add class when reached maxTags
if (self.options.maxTags === self.itemsArray.length || self.items().toString().length === self.options.maxInputLength)
self.$container.addClass('bootstrap-tagsinput-max');
self.$element.trigger($.Event('itemAdded', { item: item }));
},
/**
* Removes the given item. Pass true to dontPushVal to prevent updating the
* elements val()
*/
remove: function(item, dontPushVal) {
var self = this;
if (self.objectItems) {
if (typeof item === "object")
item = $.grep(self.itemsArray, function(other) { return self.options.itemValue(other) == self.options.itemValue(item); } );
else
item = $.grep(self.itemsArray, function(other) { return self.options.itemValue(other) == item; } );
item = item[item.length-1];
}
if (item) {
var beforeItemRemoveEvent = $.Event('beforeItemRemove', { item: item, cancel: false });
self.$element.trigger(beforeItemRemoveEvent);
if (beforeItemRemoveEvent.cancel)
return;
$('.tag', self.$container).filter(function() { return $(this).data('item') === item; }).remove();
$('option', self.$element).filter(function() { return $(this).data('item') === item; }).remove();
if($.inArray(item, self.itemsArray) !== -1)
self.itemsArray.splice($.inArray(item, self.itemsArray), 1);
}
if (!dontPushVal)
self.pushVal();
// Remove class when reached maxTags
if (self.options.maxTags > self.itemsArray.length)
self.$container.removeClass('bootstrap-tagsinput-max');
self.$element.trigger($.Event('itemRemoved', { item: item }));
},
/**
* Removes all items
*/
removeAll: function() {
var self = this;
$('.tag', self.$container).remove();
$('option', self.$element).remove();
while(self.itemsArray.length > 0)
self.itemsArray.pop();
self.pushVal();
},
/**
* Refreshes the tags so they match the text/value of their corresponding
* item.
*/
refresh: function() {
var self = this;
$('.tag', self.$container).each(function() {
var $tag = $(this),
item = $tag.data('item'),
itemValue = self.options.itemValue(item),
itemText = self.options.itemText(item),
tagClass = self.options.tagClass(item);
// Update tag's class and inner text
$tag.attr('class', null);
$tag.addClass('tag ' + htmlEncode(tagClass));
$tag.contents().filter(function() {
return this.nodeType == 3;
})[0].nodeValue = htmlEncode(itemText);
if (self.isSelect) {
var option = $('option', self.$element).filter(function() { return $(this).data('item') === item; });
option.attr('value', itemValue);
}
});
},
/**
* Returns the items added as tags
*/
items: function() {
return this.itemsArray;
},
/**
* Assembly value by retrieving the value of each item, and set it on the
* element.
*/
pushVal: function() {
var self = this,
val = $.map(self.items(), function(item) {
return self.options.itemValue(item).toString();
});
self.$element.val(val, true).trigger('change');
},
/**
* Initializes the tags input behaviour on the element
*/
build: function(options) {
var self = this;
self.options = $.extend({}, defaultOptions, options);
// When itemValue is set, freeInput should always be false
if (self.objectItems)
self.options.freeInput = false;
makeOptionItemFunction(self.options, 'itemValue');
makeOptionItemFunction(self.options, 'itemText');
makeOptionFunction(self.options, 'tagClass');
// Typeahead Bootstrap version 2.3.2
if (self.options.typeahead) {
var typeahead = self.options.typeahead || {};
makeOptionFunction(typeahead, 'source');
self.$input.typeahead($.extend({}, typeahead, {
source: function (query, process) {
function processItems(items) {
var texts = [];
for (var i = 0; i < items.length; i++) {
var text = self.options.itemText(items[i]);
map[text] = items[i];
texts.push(text);
}
process(texts);
}
this.map = {};
var map = this.map,
data = typeahead.source(query);
if ($.isFunction(data.success)) {
// support for Angular callbacks
data.success(processItems);
} else if ($.isFunction(data.then)) {
// support for Angular promises
data.then(processItems);
} else {
// support for functions and jquery promises
$.when(data)
.then(processItems);
}
},
updater: function (text) {
self.add(this.map[text]);
},
matcher: function (text) {
return (text.toLowerCase().indexOf(this.query.trim().toLowerCase()) !== -1);
},
sorter: function (texts) {
return texts.sort();
},
highlighter: function (text) {
var regex = new RegExp( '(' + this.query + ')', 'gi' );
return text.replace( regex, "<strong>$1</strong>" );
}
}));
}
// typeahead.js
if (self.options.typeaheadjs) {
var typeaheadjs = self.options.typeaheadjs || {};
self.$input.typeahead(null, typeaheadjs).on('typeahead:selected', $.proxy(function (obj, datum) {
if (typeaheadjs.valueKey)
self.add(datum[typeaheadjs.valueKey]);
else
self.add(datum);
self.$input.typeahead('val', '');
}, self));
}
self.$container.on('click', $.proxy(function(event) {
if (! self.$element.attr('disabled')) {
self.$input.removeAttr('disabled');
}
self.$input.focus();
}, self));
if (self.options.addOnBlur && self.options.freeInput) {
self.$input.on('focusout', $.proxy(function(event) {
// HACK: only process on focusout when no typeahead opened, to
// avoid adding the typeahead text as tag
if ($('.typeahead, .twitter-typeahead', self.$container).length === 0) {
self.add(self.$input.val());
self.$input.val('');
}
}, self));
}
self.$container.on('keydown', 'input', $.proxy(function(event) {
var $input = $(event.target),
$inputWrapper = self.findInputWrapper();
if (self.$element.attr('disabled')) {
self.$input.attr('disabled', 'disabled');
return;
}
switch (event.which) {
// BACKSPACE
case 8:
if (doGetCaretPosition($input[0]) === 0) {
var prev = $inputWrapper.prev();
if (prev) {
self.remove(prev.data('item'));
}
}
break;
// DELETE
case 46:
if (doGetCaretPosition($input[0]) === 0) {
var next = $inputWrapper.next();
if (next) {
self.remove(next.data('item'));
}
}
break;
// LEFT ARROW
case 37:
// Try to move the input before the previous tag
var $prevTag = $inputWrapper.prev();
if ($input.val().length === 0 && $prevTag[0]) {
$prevTag.before($inputWrapper);
$input.focus();
}
break;
// RIGHT ARROW
case 39:
// Try to move the input after the next tag
var $nextTag = $inputWrapper.next();
if ($input.val().length === 0 && $nextTag[0]) {
$nextTag.after($inputWrapper);
$input.focus();
}
break;
default:
// ignore
}
// Reset internal input's size
var textLength = $input.val().length,
wordSpace = Math.ceil(textLength / 5),
size = textLength + wordSpace + 1;
$input.attr('size', Math.max(this.inputSize, $input.val().length));
}, self));
self.$container.on('keypress', 'input', $.proxy(function(event) {
var $input = $(event.target);
if (self.$element.attr('disabled')) {
self.$input.attr('disabled', 'disabled');
return;
}
var text = $input.val(),
maxLengthReached = self.options.maxChars && text.length >= self.options.maxChars;
if (self.options.freeInput && (keyCombinationInList(event, self.options.confirmKeys) || maxLengthReached)) {
self.add(maxLengthReached ? text.substr(0, self.options.maxChars) : text);
$input.val('');
event.preventDefault();
}
// Reset internal input's size
var textLength = $input.val().length,
wordSpace = Math.ceil(textLength / 5),
size = textLength + wordSpace + 1;
$input.attr('size', Math.max(this.inputSize, $input.val().length));
}, self));
// Remove icon clicked
self.$container.on('click', '[data-role=remove]', $.proxy(function(event) {
if (self.$element.attr('disabled')) {
return;
}
self.remove($(event.target).closest('.tag').data('item'));
}, self));
// Only add existing value as tags when using strings as tags
if (self.options.itemValue === defaultOptions.itemValue) {
if (self.$element[0].tagName === 'INPUT') {
self.add(self.$element.val());
} else {
$('option', self.$element).each(function() {
self.add($(this).attr('value'), true);
});
}
}
},
/**
* Removes all tagsinput behaviour and unregsiter all event handlers
*/
destroy: function() {
var self = this;
// Unbind events
self.$container.off('keypress', 'input');
self.$container.off('click', '[role=remove]');
self.$container.remove();
self.$element.removeData('tagsinput');
self.$element.show();
},
/**
* Sets focus on the tagsinput
*/
focus: function() {
this.$input.focus();
},
/**
* Returns the internal input element
*/
input: function() {
return this.$input;
},
/**
* Returns the element which is wrapped around the internal input. This
* is normally the $container, but typeahead.js moves the $input element.
*/
findInputWrapper: function() {
var elt = this.$input[0],
container = this.$container[0];
while(elt && elt.parentNode !== container)
elt = elt.parentNode;
return $(elt);
}
};
/**
* Register JQuery plugin
*/
$.fn.tagsinput = function(arg1, arg2) {
var results = [];
this.each(function() {
var tagsinput = $(this).data('tagsinput');
// Initialize a new tags input
if (!tagsinput) {
tagsinput = new TagsInput(this, arg1);
$(this).data('tagsinput', tagsinput);
results.push(tagsinput);
if (this.tagName === 'SELECT') {
$('option', $(this)).attr('selected', 'selected');
}
// Init tags from $(this).val()
$(this).val($(this).val());
} else if (!arg1 && !arg2) {
// tagsinput already exists
// no function, trying to init
results.push(tagsinput);
} else if(tagsinput[arg1] !== undefined) {
// Invoke function on existing tags input
var retVal = tagsinput[arg1](arg2);
if (retVal !== undefined)
results.push(retVal);
}
});
if ( typeof arg1 == 'string') {
// Return the results from the invoked function calls
return results.length > 1 ? results : results[0];
} else {
return results;
}
};
$.fn.tagsinput.Constructor = TagsInput;
/**
* Most options support both a string or number as well as a function as
* option value. This function makes sure that the option with the given
* key in the given options is wrapped in a function
*/
function makeOptionItemFunction(options, key) {
if (typeof options[key] !== 'function') {
var propertyName = options[key];
options[key] = function(item) { return item[propertyName]; };
}
}
function makeOptionFunction(options, key) {
if (typeof options[key] !== 'function') {
var value = options[key];
options[key] = function() { return value; };
}
}
/**
* HtmlEncodes the given value
*/
var htmlEncodeContainer = $('<div />');
function htmlEncode(value) {
if (value) {
return htmlEncodeContainer.text(value).html();
} else {
return '';
}
}
/**
* Returns the position of the caret in the given input field
* http://flightschool.acylt.com/devnotes/caret-position-woes/
*/
function doGetCaretPosition(oField) {
var iCaretPos = 0;
if (document.selection) {
oField.focus ();
var oSel = document.selection.createRange();
oSel.moveStart ('character', -oField.value.length);
iCaretPos = oSel.text.length;
} else if (oField.selectionStart || oField.selectionStart == '0') {
iCaretPos = oField.selectionStart;
}
return (iCaretPos);
}
/**
* Returns boolean indicates whether user has pressed an expected key combination.
* @param object keyPressEvent: JavaScript event object, refer
* http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html
* @param object lookupList: expected key combinations, as in:
* [13, {which: 188, shiftKey: true}]
*/
function keyCombinationInList(keyPressEvent, lookupList) {
var found = false;
$.each(lookupList, function (index, keyCombination) {
if (typeof (keyCombination) === 'number' && keyPressEvent.which === keyCombination) {
found = true;
return false;
}
if (keyPressEvent.which === keyCombination.which) {
var alt = !keyCombination.hasOwnProperty('altKey') || keyPressEvent.altKey === keyCombination.altKey,
shift = !keyCombination.hasOwnProperty('shiftKey') || keyPressEvent.shiftKey === keyCombination.shiftKey,
ctrl = !keyCombination.hasOwnProperty('ctrlKey') || keyPressEvent.ctrlKey === keyCombination.ctrlKey;
if (alt && shift && ctrl) {
found = true;
return false;
}
}
});
return found;
}
/**
* Initialize tagsinput behaviour on inputs and selects which have
* data-role=tagsinput
*/
$(function() {
$("input[data-role=tagsinput], select[multiple][data-role=tagsinput]").tagsinput();
});
})(window.jQuery);

@ -0,0 +1,110 @@
'use strict';
define(
[
'jquery',
'underscore',
'Tags/TagCollection',
'Tags/TagModel',
'bootstrap.tagsinput'
], function ($, _, TagCollection, TagModel) {
var originalAdd = $.fn.tagsinput.Constructor.prototype.add;
$.fn.tagsinput.Constructor.prototype.add = function (item, dontPushVal) {
var self = this;
var tagLimitations = new RegExp('[^-_a-z0-9]', 'i');
if (typeof item === 'string') {
if (item === null || item === '' || tagLimitations.test(item)) {
return;
}
var existing = _.find(TagCollection.toJSON(), { label: item });
if (existing) {
originalAdd.call(this, existing, dontPushVal);
return;
}
var newTag = new TagModel();
newTag.set({ label: item.toLowerCase() });
TagCollection.add(newTag);
newTag.save().done(function () {
item = newTag.toJSON();
originalAdd.call(self, item, dontPushVal);
});
}
else {
originalAdd.call(this, item, dontPushVal);
}
};
$.fn.tagInput = function (options) {
var input = this;
var model = options.model;
var property = options.property;
var tags = getExistingTags(model.get(property));
var tagInput = $(this).tagsinput({
freeInput: true,
itemValue : 'id',
itemText : 'label',
trimValue : true,
typeaheadjs : {
name: 'tags',
displayKey: 'label',
source: substringMatcher()
}
});
//Override the free input being set to false because we're using objects
$(tagInput)[0].options.freeInput = true;
//Remove any existing tags and re-add them
$(this).tagsinput('removeAll');
_.each(tags, function(tag) {
$(input).tagsinput('add', tag);
});
$(this).tagsinput('refresh');
$(this).on('itemAdded', function(event) {
var tags = model.get(property);
tags.push(event.item.id);
model.set(property, tags);
});
$(this).on('itemRemoved', function(event) {
if (!event.item) {
return;
}
var tags = _.without(model.get(property), event.item.id);
model.set(property, tags);
});
};
var substringMatcher = function() {
return function findMatches(q, cb) {
// regex used to determine if a string contains the substring `q`
var substrRegex = new RegExp(q, 'i');
var matches = _.select(TagCollection.toJSON(), function (tag) {
return substrRegex.test(tag.label);
});
cb(matches);
};
};
var getExistingTags = function(tagValues) {
return _.select(TagCollection.toJSON(), function (tag) {
return _.contains(tagValues, tag.id);
});
};
});

@ -7,7 +7,8 @@ define(
'Mixins/AsModelBoundView', 'Mixins/AsModelBoundView',
'Mixins/AsValidatedView', 'Mixins/AsValidatedView',
'Mixins/AsEditModalView', 'Mixins/AsEditModalView',
'Mixins/AutoComplete' 'Mixins/AutoComplete',
'Mixins/TagInput'
], function (vent, Marionette, Profiles, AsModelBoundView, AsValidatedView, AsEditModalView) { ], function (vent, Marionette, Profiles, AsModelBoundView, AsValidatedView, AsEditModalView) {
var view = Marionette.ItemView.extend({ var view = Marionette.ItemView.extend({
@ -15,7 +16,8 @@ define(
ui: { ui: {
profile : '.x-profile', profile : '.x-profile',
path : '.x-path' path : '.x-path',
tags : '.x-tags'
}, },
events: { events: {
@ -39,6 +41,10 @@ define(
onRender: function () { onRender: function () {
this.ui.path.autoComplete('/directories'); this.ui.path.autoComplete('/directories');
this.ui.tags.tagInput({
model : this.model,
property : 'tags'
});
}, },
_removeSeries: function () { _removeSeries: function () {

@ -82,6 +82,14 @@
<input type="text" class="form-control x-path" placeholder="Path" name="path"> <input type="text" class="form-control x-path" placeholder="Path" name="path">
</div> </div>
</div> </div>
<div class="form-group">
<label class="col-sm-4 control-label">Tags</label>
<div class="col-sm-6">
<input type="text" class="form-control x-tags">
</div>
</div>
</div> </div>
</div> </div>
</div> </div>

@ -10,7 +10,8 @@ define([
'Mixins/AsModelBoundView', 'Mixins/AsModelBoundView',
'Mixins/AsValidatedView', 'Mixins/AsValidatedView',
'Mixins/AsEditModalView', 'Mixins/AsEditModalView',
'Form/FormBuilder' 'Form/FormBuilder',
'Mixins/TagInput'
], function (_, vent, AppLayout, Marionette, DeleteView, CommandController, AsModelBoundView, AsValidatedView, AsEditModalView) { ], function (_, vent, AppLayout, Marionette, DeleteView, CommandController, AsModelBoundView, AsValidatedView, AsEditModalView) {
var view = Marionette.ItemView.extend({ var view = Marionette.ItemView.extend({
@ -18,7 +19,8 @@ define([
ui: { ui: {
onDownloadToggle : '.x-on-download', onDownloadToggle : '.x-on-download',
onUpgradeSection : '.x-on-upgrade' onUpgradeSection : '.x-on-upgrade',
tags : '.x-tags'
}, },
events: { events: {
@ -34,6 +36,11 @@ define([
onRender: function () { onRender: function () {
this._onDownloadChanged(); this._onDownloadChanged();
this.ui.tags.tagInput({
model : this.model,
property : 'tags'
});
}, },
_onAfterSave: function () { _onAfterSave: function () {

@ -83,6 +83,14 @@
</div> </div>
</div> </div>
<div class="form-group">
<label class="col-sm-3 control-label">Tags</label>
<div class="col-sm-5">
<input type="text" class="form-control x-tags">
</div>
</div>
{{formBuilder}} {{formBuilder}}
</div> </div>
</div> </div>

@ -0,0 +1,14 @@
'use strict';
define(
[
'backbone',
'Tags/TagModel',
'api!tag'
], function (Backbone, TagModel, TagData) {
var Collection = Backbone.Collection.extend({
url : window.NzbDrone.ApiRoot + '/tag',
model: TagModel
});
return new Collection(TagData);
});

@ -0,0 +1,20 @@
'use strict';
define(
[
'handlebars',
'Tags/TagCollection'
], function (Handlebars, TagCollection) {
Handlebars.registerHelper('tagInput', function () {
var unit = 'days';
var age = this.age;
if (age < 2) {
unit = 'hours';
age = parseFloat(this.ageHours).toFixed(1);
}
return new Handlebars.SafeString('<dt>Age (when grabbed):</dt><dd>{0} {1}</dd>'.format(age, unit));
});
});

@ -0,0 +1,9 @@
'use strict';
define(
[
'backbone'
], function (Backbone) {
return Backbone.Model.extend({
});
});

@ -8,6 +8,7 @@ require.config({
'handlebars' : 'Shared/Shims/handlebars', 'handlebars' : 'Shared/Shims/handlebars',
'handlebars.helpers' : 'JsLibraries/handlebars.helpers', 'handlebars.helpers' : 'JsLibraries/handlebars.helpers',
'bootstrap' : 'JsLibraries/bootstrap', 'bootstrap' : 'JsLibraries/bootstrap',
'bootstrap.tagsinput' : 'JsLibraries/bootstrap.tagsinput',
'backbone.deepmodel' : 'JsLibraries/backbone.deep.model', 'backbone.deepmodel' : 'JsLibraries/backbone.deep.model',
'backbone.pageable' : 'JsLibraries/backbone.pageable', 'backbone.pageable' : 'JsLibraries/backbone.pageable',
'backbone.validation' : 'JsLibraries/backbone.validation', 'backbone.validation' : 'JsLibraries/backbone.validation',
@ -70,6 +71,13 @@ require.config({
'jquery' 'jquery'
] ]
}, },
'bootstrap.tagsinput' : {
deps:
[
'bootstrap',
'typeahead'
]
},
backstrech : { backstrech : {
deps: deps:
[ [

Loading…
Cancel
Save