From 07f77a156d8bed850d989ef639f9e02d3fd18486 Mon Sep 17 00:00:00 2001 From: Anna Clemens Date: Thu, 18 Feb 2021 15:20:40 -0500 Subject: [PATCH] chore: initial commit --- .gitattributes | 1 + .gitignore | 365 ++++++++++++++++++ ExpandedSearchInfo.sln | 16 + ExpandedSearchInfo/DalamudPackager.targets | 11 + ExpandedSearchInfo/ExpandedSearchInfo.csproj | 36 ++ ExpandedSearchInfo/ExpandedSearchInfo.yaml | 14 + ExpandedSearchInfo/GameFunctions.cs | 47 +++ ExpandedSearchInfo/ILRepack.targets | 27 ++ ExpandedSearchInfo/Plugin.cs | 26 ++ ExpandedSearchInfo/PluginUi.cs | 94 +++++ .../Providers/BaseHtmlProvider.cs | 28 ++ ExpandedSearchInfo/Providers/CarrdProvider.cs | 67 ++++ ExpandedSearchInfo/Providers/FListProvider.cs | 110 ++++++ ExpandedSearchInfo/Providers/IProvider.cs | 40 ++ .../Providers/PastebinProvider.cs | 36 ++ .../Providers/PlainTextProvider.cs | 26 ++ .../Providers/RefsheetProvider.cs | 141 +++++++ ExpandedSearchInfo/SearchInfoRepository.cs | 190 +++++++++ ExpandedSearchInfo/Sections/FListSection.cs | 67 ++++ .../Sections/ISearchInfoSection.cs | 10 + .../Sections/RefsheetSection.cs | 42 ++ ExpandedSearchInfo/Sections/TextSection.cs | 20 + ExpandedSearchInfo/Util.cs | 36 ++ LICENCE | 287 ++++++++++++++ 24 files changed, 1737 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100755 ExpandedSearchInfo.sln create mode 100755 ExpandedSearchInfo/DalamudPackager.targets create mode 100755 ExpandedSearchInfo/ExpandedSearchInfo.csproj create mode 100755 ExpandedSearchInfo/ExpandedSearchInfo.yaml create mode 100755 ExpandedSearchInfo/GameFunctions.cs create mode 100755 ExpandedSearchInfo/ILRepack.targets create mode 100755 ExpandedSearchInfo/Plugin.cs create mode 100755 ExpandedSearchInfo/PluginUi.cs create mode 100755 ExpandedSearchInfo/Providers/BaseHtmlProvider.cs create mode 100755 ExpandedSearchInfo/Providers/CarrdProvider.cs create mode 100755 ExpandedSearchInfo/Providers/FListProvider.cs create mode 100755 ExpandedSearchInfo/Providers/IProvider.cs create mode 100755 ExpandedSearchInfo/Providers/PastebinProvider.cs create mode 100755 ExpandedSearchInfo/Providers/PlainTextProvider.cs create mode 100755 ExpandedSearchInfo/Providers/RefsheetProvider.cs create mode 100755 ExpandedSearchInfo/SearchInfoRepository.cs create mode 100755 ExpandedSearchInfo/Sections/FListSection.cs create mode 100755 ExpandedSearchInfo/Sections/ISearchInfoSection.cs create mode 100755 ExpandedSearchInfo/Sections/RefsheetSection.cs create mode 100755 ExpandedSearchInfo/Sections/TextSection.cs create mode 100755 ExpandedSearchInfo/Util.cs create mode 100644 LICENCE diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..fcadb2c --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text eol=lf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1db30bf --- /dev/null +++ b/.gitignore @@ -0,0 +1,365 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# Packaging +pack/ + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd diff --git a/ExpandedSearchInfo.sln b/ExpandedSearchInfo.sln new file mode 100755 index 0000000..8716039 --- /dev/null +++ b/ExpandedSearchInfo.sln @@ -0,0 +1,16 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExpandedSearchInfo", "ExpandedSearchInfo\ExpandedSearchInfo.csproj", "{36C03932-2820-46C7-8512-CA0EC3033C34}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {36C03932-2820-46C7-8512-CA0EC3033C34}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {36C03932-2820-46C7-8512-CA0EC3033C34}.Debug|Any CPU.Build.0 = Debug|Any CPU + {36C03932-2820-46C7-8512-CA0EC3033C34}.Release|Any CPU.ActiveCfg = Release|Any CPU + {36C03932-2820-46C7-8512-CA0EC3033C34}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/ExpandedSearchInfo/DalamudPackager.targets b/ExpandedSearchInfo/DalamudPackager.targets new file mode 100755 index 0000000..bb2ca49 --- /dev/null +++ b/ExpandedSearchInfo/DalamudPackager.targets @@ -0,0 +1,11 @@ + + + + + + diff --git a/ExpandedSearchInfo/ExpandedSearchInfo.csproj b/ExpandedSearchInfo/ExpandedSearchInfo.csproj new file mode 100755 index 0000000..9c384cb --- /dev/null +++ b/ExpandedSearchInfo/ExpandedSearchInfo.csproj @@ -0,0 +1,36 @@ + + + + net48 + 1.1.0 + latest + enable + + + + + $(AppData)\XIVLauncher\addon\Hooks\dev\Dalamud.dll + False + + + $(AppData)\XIVLauncher\addon\Hooks\dev\ImGui.NET.dll + False + + + $(AppData)\XIVLauncher\addon\Hooks\dev\ImGuiScene.dll + False + + + $(AppData)\XIVLauncher\addon\Hooks\dev\Newtonsoft.Json.dll + False + + + + + + + + + + + diff --git a/ExpandedSearchInfo/ExpandedSearchInfo.yaml b/ExpandedSearchInfo/ExpandedSearchInfo.yaml new file mode 100755 index 0000000..211058f --- /dev/null +++ b/ExpandedSearchInfo/ExpandedSearchInfo.yaml @@ -0,0 +1,14 @@ +author: ascclemens +name: Expanded Search Info +description: |- + Displays extra information pulled from search info when examining. + + Support for: + - Any plain text URL + - Pastebin.com + - carrd.co/crd.co + - F-List + - Refsheet + + Simply examine someone with a search info containing pointers to one of + these locations and the plugin will display information automatically. diff --git a/ExpandedSearchInfo/GameFunctions.cs b/ExpandedSearchInfo/GameFunctions.cs new file mode 100755 index 0000000..a581900 --- /dev/null +++ b/ExpandedSearchInfo/GameFunctions.cs @@ -0,0 +1,47 @@ +using System; +using System.Runtime.InteropServices; +using Dalamud.Hooking; +using Dalamud.Plugin; + +namespace ExpandedSearchInfo { + public class GameFunctions : IDisposable { + private Plugin Plugin { get; } + + private delegate byte SearchInfoDownloadedDelegate(IntPtr data, IntPtr a2, IntPtr searchInfoPtr, IntPtr a4); + + private readonly Hook? _searchInfoDownloadedHook; + + internal delegate void ReceiveSearchInfoEventDelegate(int actorId, string info); + + internal event ReceiveSearchInfoEventDelegate? ReceiveSearchInfo; + + internal GameFunctions(Plugin plugin) { + this.Plugin = plugin; + + var sidPtr = this.Plugin.Interface.TargetModuleScanner.ScanText("48 89 5C 24 ?? 48 89 6C 24 ?? 56 48 83 EC 20 49 8B E8 8B DA"); + this._searchInfoDownloadedHook = new Hook(sidPtr, new SearchInfoDownloadedDelegate(this.SearchInfoDownloaded)); + this._searchInfoDownloadedHook.Enable(); + } + + public void Dispose() { + this._searchInfoDownloadedHook?.Dispose(); + } + + private byte SearchInfoDownloaded(IntPtr data, IntPtr a2, IntPtr searchInfoPtr, IntPtr a4) { + var result = this._searchInfoDownloadedHook!.Original(data, a2, searchInfoPtr, a4); + + try { + var actorId = Marshal.ReadInt32(data + 48); + + // var searchInfoPtr = data + 90; + var searchInfo = Util.ReadRawString(searchInfoPtr); + + this.ReceiveSearchInfo?.Invoke(actorId, searchInfo); + } catch (Exception ex) { + PluginLog.LogError($"Error in SearchInfoDownloaded hook\n{ex}"); + } + + return result; + } + } +} diff --git a/ExpandedSearchInfo/ILRepack.targets b/ExpandedSearchInfo/ILRepack.targets new file mode 100755 index 0000000..1e681a1 --- /dev/null +++ b/ExpandedSearchInfo/ILRepack.targets @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + $([System.IO.Directory]::GetFiles("%(Directories.Identity)", "*", System.IO.SearchOption.AllDirectories).get_Length()) + + + + diff --git a/ExpandedSearchInfo/Plugin.cs b/ExpandedSearchInfo/Plugin.cs new file mode 100755 index 0000000..385b01f --- /dev/null +++ b/ExpandedSearchInfo/Plugin.cs @@ -0,0 +1,26 @@ +using Dalamud.Plugin; + +namespace ExpandedSearchInfo { + public class Plugin : IDalamudPlugin { + public string Name => "Expanded Search Info"; + + internal DalamudPluginInterface Interface { get; private set; } = null!; + internal GameFunctions Functions { get; private set; } = null!; + internal SearchInfoRepository Repository { get; private set; } = null!; + private PluginUi Ui { get; set; } = null!; + + public void Initialize(DalamudPluginInterface pluginInterface) { + this.Interface = pluginInterface; + + this.Functions = new GameFunctions(this); + this.Repository = new SearchInfoRepository(this); + this.Ui = new PluginUi(this); + } + + public void Dispose() { + this.Ui.Dispose(); + this.Repository.Dispose(); + this.Functions.Dispose(); + } + } +} diff --git a/ExpandedSearchInfo/PluginUi.cs b/ExpandedSearchInfo/PluginUi.cs new file mode 100755 index 0000000..2c40bec --- /dev/null +++ b/ExpandedSearchInfo/PluginUi.cs @@ -0,0 +1,94 @@ +using System; +using System.Diagnostics; +using System.Numerics; +using ImGuiNET; + +namespace ExpandedSearchInfo { + public class PluginUi : IDisposable { + private Plugin Plugin { get; } + + internal PluginUi(Plugin plugin) { + this.Plugin = plugin; + + this.Plugin.Interface.UiBuilder.OnBuildUi += this.Draw; + } + + public void Dispose() { + this.Plugin.Interface.UiBuilder.OnBuildUi -= this.Draw; + } + + private void Draw() { + // check if the examine window is open + var addon = this.Plugin.Interface.Framework.Gui.GetAddonByName("CharacterInspect", 1); + if (addon == null || !addon.Visible) { + return; + } + + // get examine window info + float width; + float height; + short x; + short y; + + try { + width = addon.Width; + height = addon.Height; + x = addon.X; + y = addon.Y; + } catch (Exception) { + return; + } + + // check the last actor id recorded (should be who the examine window is showing) + var actorId = this.Plugin.Repository.LastActorId; + if (actorId == 0 || !this.Plugin.Repository.SearchInfos.TryGetValue(actorId, out var expanded)) { + return; + } + + // set window size + ImGui.SetNextWindowSizeConstraints( + new Vector2(0, 0), + new Vector2(ImGui.GetIO().DisplaySize.X / 4, height) + ); + ImGui.SetNextWindowSize(new Vector2(-1, -1)); + + if (!ImGui.Begin(this.Plugin.Name, ImGuiWindowFlags.NoTitleBar)) { + return; + } + + ImGui.PushTextWrapPos(ImGui.GetIO().DisplaySize.X / 4 - 24); + + // show a section for each extracted section + for (var i = 0; i < expanded.Sections.Count; i++) { + var section = expanded.Sections[i]; + + if (!ImGui.CollapsingHeader($"{section.Name}##{i}", ImGuiTreeNodeFlags.DefaultOpen)) { + continue; + } + + ImGui.TreePush(); + + if (ImGui.Button($"Open in browser##{i}")) { + Process.Start(section.Uri.ToString()); + } + + section.Draw(); + + ImGui.TreePop(); + } + + ImGui.PopTextWrapPos(); + + // determine whether to show on the left or right of the examine window based on space available + var display = ImGui.GetIO().DisplaySize; + var actualWidth = ImGui.GetWindowWidth(); + + var xPos = x + width + actualWidth > display.X + ? x - actualWidth + : x + width; + ImGui.SetWindowPos(new Vector2(xPos, y)); + + ImGui.End(); + } + } +} diff --git a/ExpandedSearchInfo/Providers/BaseHtmlProvider.cs b/ExpandedSearchInfo/Providers/BaseHtmlProvider.cs new file mode 100755 index 0000000..a612f48 --- /dev/null +++ b/ExpandedSearchInfo/Providers/BaseHtmlProvider.cs @@ -0,0 +1,28 @@ +using System; +using System.Collections.Generic; +using System.Net.Http; +using System.Threading.Tasks; +using AngleSharp; +using AngleSharp.Html.Dom; +using AngleSharp.Html.Parser; +using ExpandedSearchInfo.Sections; + +namespace ExpandedSearchInfo.Providers { + public abstract class BaseHtmlProvider : IProvider { + private IBrowsingContext Context { get; } = BrowsingContext.New(); + + public abstract bool ExtractsUris { get; } + + public abstract bool Matches(Uri uri); + + public abstract IEnumerable? ExtractUris(int actorId, string info); + + public abstract Task ExtractInfo(HttpResponseMessage response); + + protected async Task DownloadDocument(HttpResponseMessage response) { + var html = await response.Content.ReadAsStringAsync(); + var parser = this.Context.GetService(); + return await parser.ParseDocumentAsync(html); + } + } +} diff --git a/ExpandedSearchInfo/Providers/CarrdProvider.cs b/ExpandedSearchInfo/Providers/CarrdProvider.cs new file mode 100755 index 0000000..ddc1cae --- /dev/null +++ b/ExpandedSearchInfo/Providers/CarrdProvider.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.Net.Http; +using System.Threading.Tasks; +using AngleSharp.Dom; +using ExpandedSearchInfo.Sections; + +namespace ExpandedSearchInfo.Providers { + public class CarrdProvider : BaseHtmlProvider { + public override bool ExtractsUris => false; + + public override bool Matches(Uri uri) => uri.Host.EndsWith(".carrd.co") || uri.Host.EndsWith(".crd.co"); + + public override IEnumerable? ExtractUris(int actorId, string info) => null; + + public override async Task ExtractInfo(HttpResponseMessage response) { + var document = await this.DownloadDocument(response); + + var text = string.Empty; + + IElement? lastList = null; + var listNum = 1; + + foreach (var element in document.QuerySelectorAll("p, [id ^= 'text']")) { + // check if this element is in an li + var inLi = element.ParentElement?.TagName == "LI"; + // if the first element in a li, we need to prefix it + if (inLi && element.PreviousSibling == null) { + // check if this element is in the same list as the last list element we checked + if (element.ParentElement != lastList) { + // if not, update the last list and reset the counter + lastList = element.ParentElement; + listNum = 1; + } + + // check if this list is an ol or ul + var isOl = element.ParentElement?.ParentElement?.TagName == "OL"; + if (isOl) { + // use the list number for ol + text += $"{listNum++}. "; + } else { + // use a dash for ul + text += "- "; + } + } + + // add the text from each child node + foreach (var node in element.ChildNodes) { + text += node.Text(); + // add an extra newline if the node is a br + if (node is IElement {TagName: "BR"}) { + text += '\n'; + } + } + + // add a newline after every element + text += '\n'; + } + + return new TextSection( + $"{document.Title} (carrd.co)", + response.RequestMessage.RequestUri, + text + ); + } + } +} diff --git a/ExpandedSearchInfo/Providers/FListProvider.cs b/ExpandedSearchInfo/Providers/FListProvider.cs new file mode 100755 index 0000000..9713fff --- /dev/null +++ b/ExpandedSearchInfo/Providers/FListProvider.cs @@ -0,0 +1,110 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Net.Http; +using System.Text; +using System.Threading.Tasks; +using AngleSharp; +using AngleSharp.Dom; +using Dalamud.Plugin; +using ExpandedSearchInfo.Sections; + +namespace ExpandedSearchInfo.Providers { + public class FListProvider : BaseHtmlProvider { + + private Plugin Plugin { get; } + + public override bool ExtractsUris => true; + + internal FListProvider(Plugin plugin) { + this.Plugin = plugin; + } + + public override bool Matches(Uri uri) => (uri.Host == "www.f-list.net" || uri.Host == "f-list.net") && uri.AbsolutePath.StartsWith("/c/"); + + public override IEnumerable? ExtractUris(int actorId, string info) { + if (!info.ToLowerInvariant().Contains("c/")) { + return null; + } + + var actor = this.Plugin.Interface.ClientState.Actors.FirstOrDefault(actor => actor.ActorId == actorId); + if (actor == null) { + return null; + } + + var safeName = actor.Name.Replace("'", ""); + + return new[] { + new Uri($"https://www.f-list.net/c/{Uri.EscapeUriString(safeName)}"), + }; + } + + public override async Task ExtractInfo(HttpResponseMessage response) { + var document = await this.DownloadDocument(response); + + var error = document.QuerySelector("#DisplayedMessage"); + if (error != null) { + if (error.Text().Contains("No such character exists")) { + return null; + } + } + + var stats = new List>(); + var statBox = document.QuerySelector(".statbox"); + if (statBox != null) { + foreach (var stat in statBox.Children) { + if (!stat.Matches(".taglabel")) { + continue; + } + + var name = stat.Text().Trim().Trim(' ', '\r', '\n', '\t', ':'); + var value = stat.NextSibling.Text().Trim(' ', '\r', '\n', '\t', ':'); + stats.Add(new Tuple(name, value)); + } + } + + var info = string.Empty; + var formatted = document.QuerySelector("#tabs-1 > .FormattedBlock"); + if (formatted != null) { + foreach (var child in formatted.ChildNodes) { + info += child.Text(); + if (child is IElement childElem && childElem.TagName != "BR") { + info += "\n"; + } + } + } + + // remove bbcode and turn special characters into normal ascii + info = Util.StripBbCode(info).Normalize(NormalizationForm.FormKD); + + var fave = KinkSection(document, "Character_FetishlistFave"); + var yes = KinkSection(document, "Character_FetishlistYes"); + var maybe = KinkSection(document, "Character_FetishlistMaybe"); + var no = KinkSection(document, "Character_FetishlistNo"); + + var charName = document.Title.Split('-')[2].Trim(); + return new FListSection( + $"{charName} (F-List)", + response.RequestMessage.RequestUri, + info, + stats, + fave, + yes, + maybe, + no + ); + } + + private static List> KinkSection(IParentNode document, string id) { + var kinks = new List>(); + var kinkElems = document.QuerySelectorAll($"#{id} > a"); + foreach (var kink in kinkElems) { + var name = kink.Text().Trim(); + var value = kink.Attributes.GetNamedItem("rel")?.Value ?? ""; + kinks.Add(new Tuple(name, value)); + } + + return kinks; + } + } +} diff --git a/ExpandedSearchInfo/Providers/IProvider.cs b/ExpandedSearchInfo/Providers/IProvider.cs new file mode 100755 index 0000000..9a32e24 --- /dev/null +++ b/ExpandedSearchInfo/Providers/IProvider.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.Net.Http; +using System.Threading.Tasks; +using ExpandedSearchInfo.Sections; + +namespace ExpandedSearchInfo.Providers { + public interface IProvider { + /// + /// If this provider is capable of parsing the search info for custom Uris, this should be true. + /// + /// Note that normal Uris are parsed by the plugin itself, so this can remain false for providers + /// that only handle normal Uris. + /// + bool ExtractsUris { get; } + + /// + /// Determine if this provider should run on the given Uri. + /// + /// Uri to test + /// true if this provider's Extract method should be run for the HTTP response from this Uri + bool Matches(Uri uri); + + /// + /// For providers that require Uris, this can return null. + /// For providers that don't require Uris, this must return a Uri extracted from the given search info. + /// + /// The actor ID associated with the search info + /// A character's full search info + /// null for providers that require Uris, a Uri for providers that don't + IEnumerable? ExtractUris(int actorId, string info); + + /// + /// Extract the search info to be displayed given the HTTP response from a Uri. + /// + /// HTTP response from a Uri + /// null if search info could not be extracted or the search info as a string if it could + Task ExtractInfo(HttpResponseMessage response); + } +} diff --git a/ExpandedSearchInfo/Providers/PastebinProvider.cs b/ExpandedSearchInfo/Providers/PastebinProvider.cs new file mode 100755 index 0000000..58f1238 --- /dev/null +++ b/ExpandedSearchInfo/Providers/PastebinProvider.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Net.Http; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using ExpandedSearchInfo.Sections; + +namespace ExpandedSearchInfo.Providers { + public class PastebinProvider : IProvider { + private static readonly Regex Matcher = new(@"pb:(\S+)", RegexOptions.Compiled | RegexOptions.IgnoreCase); + + public bool ExtractsUris => true; + + public bool Matches(Uri uri) => uri.Host == "pastebin.com" && uri.AbsolutePath.Length > 1; + + public IEnumerable? ExtractUris(int actorId, string info) { + var matches = Matcher.Matches(info); + return matches.Count == 0 + ? null + : from Match match in matches select match.Groups[1].Value into id select new Uri($"https://pastebin.com/raw/{id}"); + } + + public async Task ExtractInfo(HttpResponseMessage response) { + if (response.Content.Headers.ContentType.MediaType != "text/plain") { + return null; + } + + var id = response.RequestMessage.RequestUri.AbsolutePath.Split('/').LastOrDefault(); + + var info = await response.Content.ReadAsStringAsync(); + + return new TextSection($"Pastebin ({id})", response.RequestMessage.RequestUri, info); + } + } +} diff --git a/ExpandedSearchInfo/Providers/PlainTextProvider.cs b/ExpandedSearchInfo/Providers/PlainTextProvider.cs new file mode 100755 index 0000000..1626268 --- /dev/null +++ b/ExpandedSearchInfo/Providers/PlainTextProvider.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.Net.Http; +using System.Threading.Tasks; +using ExpandedSearchInfo.Sections; + +namespace ExpandedSearchInfo.Providers { + public class PlainTextProvider : IProvider { + public bool ExtractsUris => false; + + public bool Matches(Uri uri) => true; + + public IEnumerable? ExtractUris(int actorId, string info) => null; + + public async Task ExtractInfo(HttpResponseMessage response) { + if (response.Content.Headers.ContentType.MediaType != "text/plain") { + return null; + } + + var info = await response.Content.ReadAsStringAsync(); + + var uri = response.RequestMessage.RequestUri; + return new TextSection($"Text##{uri}", response.RequestMessage.RequestUri, info); + } + } +} diff --git a/ExpandedSearchInfo/Providers/RefsheetProvider.cs b/ExpandedSearchInfo/Providers/RefsheetProvider.cs new file mode 100755 index 0000000..05ced3d --- /dev/null +++ b/ExpandedSearchInfo/Providers/RefsheetProvider.cs @@ -0,0 +1,141 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Net.Http; +using System.Threading.Tasks; +using ExpandedSearchInfo.Sections; +using Newtonsoft.Json; +using Newtonsoft.Json.Serialization; + +namespace ExpandedSearchInfo.Providers { + public class RefsheetProvider : BaseHtmlProvider { + private const string JsonLineStart = "var props = "; + + public override bool ExtractsUris => false; + + public override bool Matches(Uri uri) => uri.Host == "refsheet.net" || uri.Host == "ref.st"; + + public override IEnumerable? ExtractUris(int actorId, string info) => null; + + public override async Task ExtractInfo(HttpResponseMessage response) { + var document = await this.DownloadDocument(response); + + // refsheet provides all the content but... uses js to display it? + // find the script containing the json and use it + var script = document.QuerySelectorAll("script[type = 'text/javascript']").LastOrDefault(); + if (script == null) { + return null; + } + + var jsonLine = script.InnerHtml.Split('\n') + .Select(line => line.Trim()) + .FirstOrDefault(line => line.StartsWith(JsonLineStart)); + if (jsonLine == null) { + return null; + } + + var json = jsonLine.Substring(JsonLineStart.Length, jsonLine.Length - JsonLineStart.Length - 1); + var parsed = JsonConvert.DeserializeObject(json); + var character = parsed.EagerLoad.Character; + + // get character name + var name = character.Name; + + // get all attributes + var attributes = new List>(); + + // handle built-in attributes first + if (!string.IsNullOrWhiteSpace(character.Gender)) { + attributes.Add(new Tuple("Gender", character.Gender)); + } + + if (!string.IsNullOrWhiteSpace(character.Species)) { + attributes.Add(new Tuple("Species", character.Species)); + } + + if (!string.IsNullOrWhiteSpace(character.Height)) { + attributes.Add(new Tuple("Height", character.Height)); + } + + if (!string.IsNullOrWhiteSpace(character.Weight)) { + attributes.Add(new Tuple("Weight", character.Weight)); + } + + if (!string.IsNullOrWhiteSpace(character.BodyType)) { + attributes.Add(new Tuple("Body type", character.BodyType)); + } + + if (!string.IsNullOrWhiteSpace(character.Personality)) { + attributes.Add(new Tuple("Personality", character.Personality)); + } + + // then look for custom attributes + foreach (var attr in character.CustomAttributes) { + attributes.Add(new Tuple(attr.Name, attr.Value)); + } + + // get important notes + var notes = character.SpecialNotes; + + // get cards + var cards = new List>(); + + // get about card + if (!string.IsNullOrWhiteSpace(character.Profile)) { + cards.Add(new Tuple($"About {character.Name}", character.Profile)); + } + + // get likes/dislikes cards + if (!string.IsNullOrWhiteSpace(character.Likes)) { + cards.Add(new Tuple("Likes", character.Likes)); + } + + if (!string.IsNullOrWhiteSpace(character.Dislikes)) { + cards.Add(new Tuple("Dislikes", character.Dislikes)); + } + + return new RefsheetSection( + $"{name} (Refsheet)", + response.RequestMessage.RequestUri, + attributes, + notes, + cards + ); + } + + #pragma warning disable 8618 + [JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))] + private class RefsheetData { + public RefsheetEagerLoad EagerLoad { get; set; } + } + + [JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))] + private class RefsheetEagerLoad { + public RefsheetCharacter Character { get; set; } + } + + [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))] + private class RefsheetCharacter { + public string Name { get; set; } + public string Profile { get; set; } + public string Gender { get; set; } + public string Species { get; set; } + public string Height { get; set; } + public string Weight { get; set; } + public string BodyType { get; set; } + public string Personality { get; set; } + public string SpecialNotes { get; set; } + public string Likes { get; set; } + public string Dislikes { get; set; } + public List CustomAttributes { get; set; } + } + + [JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))] + private class RefsheetCustomAttribute { + public string Name { get; set; } + public string Value { get; set; } + public string Id { get; set; } + } + #pragma warning restore 8618 + } +} diff --git a/ExpandedSearchInfo/SearchInfoRepository.cs b/ExpandedSearchInfo/SearchInfoRepository.cs new file mode 100755 index 0000000..8590c0b --- /dev/null +++ b/ExpandedSearchInfo/SearchInfoRepository.cs @@ -0,0 +1,190 @@ +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Threading; +using System.Threading.Tasks; +using Dalamud.Plugin; +using ExpandedSearchInfo.Providers; +using ExpandedSearchInfo.Sections; +using Nager.PublicSuffix; + +namespace ExpandedSearchInfo { + public class ExpandedSearchInfo { + public string Info { get; } + public List Sections { get; } + + public ExpandedSearchInfo(string info, List sections) { + this.Info = info; + this.Sections = sections; + } + } + + public class SearchInfoRepository : IDisposable { + private Plugin Plugin { get; } + private DomainParser Parser { get; } + internal ConcurrentDictionary SearchInfos { get; } = new(); + internal int LastActorId { get; private set; } + + private List Providers { get; } = new(); + + internal SearchInfoRepository(Plugin plugin) { + this.Plugin = plugin; + + // create the public suffix list parser + var provider = new WebTldRuleProvider(); + if (!provider.CacheProvider.IsCacheValid()) { + provider.BuildAsync().GetAwaiter().GetResult(); + } + + this.Parser = new DomainParser(provider); + + // add providers + this.AddProviders(); + + // listen for search info + this.Plugin.Functions.ReceiveSearchInfo += this.ProcessSearchInfo; + } + + public void Dispose() { + this.Plugin.Functions.ReceiveSearchInfo -= this.ProcessSearchInfo; + } + + private void AddProviders() { + this.Providers.Add(new PastebinProvider()); + this.Providers.Add(new CarrdProvider()); + this.Providers.Add(new FListProvider(this.Plugin)); + this.Providers.Add(new RefsheetProvider()); + this.Providers.Add(new PlainTextProvider()); + } + + private void ProcessSearchInfo(int actorId, string info) { + this.LastActorId = actorId; + + // if empty search info, short circuit + if (string.IsNullOrWhiteSpace(info)) { + // remove any existing search info + this.SearchInfos.TryRemove(actorId, out _); + return; + } + + // check to see if info has changed + #if RELEASE + if (this.SearchInfos.TryGetValue(actorId, out var existing)) { + if (existing.Info == info) { + return; + } + } + #endif + + new Thread(async () => { + try { + await this.DoExtraction(actorId, info); + } catch (Exception ex) { + PluginLog.LogError($"Error in extraction thread:\n{ex}"); + } + }).Start(); + } + + private async Task DoExtraction(int actorId, string info) { + var downloadUris = new List(); + + // extract uris from the search info with providers + var extractedUris = this.Providers + .Where(provider => provider.ExtractsUris) + .Select(provider => provider.ExtractUris(actorId, info)) + .Where(uris => uris != null) + .SelectMany(uris => uris); + + // add the extracted uris to the list + downloadUris.AddRange(extractedUris!); + + // go word-by-word and try to parse a uri + foreach (var word in info.Split(' ', '\n', '\r')) { + Uri found; + try { + found = new UriBuilder(word.Trim()).Uri; + } catch (UriFormatException) { + continue; + } + + // make sure the hostname is a valid domain + try { + if (!this.Parser.IsValidDomain(found.Host)) { + continue; + } + } catch (ParseException) { + continue; + } + + downloadUris.Add(found); + } + + // if there were no uris found or extracted, remove existing search info and stop + if (downloadUris.Count == 0) { + this.SearchInfos.TryRemove(actorId, out _); + return; + } + + // do the downloads + await this.DownloadAndExtract(actorId, info, downloadUris); + } + + private async Task DownloadAndExtract(int actorId, string info, IEnumerable uris) { + var handler = new HttpClientHandler { + UseCookies = true, + AllowAutoRedirect = true, + MaxAutomaticRedirections = 5, + }; + handler.CookieContainer.Add(new Cookie("warning", "1", "/", "www.f-list.net")); + var client = new HttpClient(handler); + + var sections = new List(); + + // run through each extracted uri + foreach (var uri in uris) { + if (uri.Scheme != "http" && uri.Scheme != "https") { + continue; + } + + // find the providers that run on this uri + var matching = this.Providers + .Where(provider => provider.Matches(uri)) + .ToList(); + + // skip the uri if no providers + if (matching.Count == 0) { + continue; + } + + // get the http response from the uri and make sure it's ok + var resp = await client.GetAsync(uri, HttpCompletionOption.ResponseHeadersRead); + if (resp.StatusCode != HttpStatusCode.OK) { + continue; + } + + // go through each provider in order and take the first one that provides info + foreach (var provider in matching) { + var extracted = await provider.ExtractInfo(resp); + if (extracted == null) { + continue; + } + + sections.Add(extracted); + break; + } + } + + // remove expanded search info if no sections resulted + if (sections.Count == 0) { + this.SearchInfos.TryRemove(actorId, out _); + return; + } + + // otherwise set the expanded search info for this actor id + this.SearchInfos[actorId] = new ExpandedSearchInfo(info, sections); + } + } +} diff --git a/ExpandedSearchInfo/Sections/FListSection.cs b/ExpandedSearchInfo/Sections/FListSection.cs new file mode 100755 index 0000000..e2ba151 --- /dev/null +++ b/ExpandedSearchInfo/Sections/FListSection.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using ImGuiNET; + +namespace ExpandedSearchInfo.Sections { + public class FListSection : ISearchInfoSection { + public string Name { get; } + public Uri Uri { get; } + + private string Info { get; } + private List> Stats { get; } + private List> Fave { get; } + private List> Yes { get; } + private List> Maybe { get; } + private List> No { get; } + + internal FListSection(string name, Uri uri, string info, List> stats, List> fave, List> yes, List> maybe, List> no) { + this.Name = name; + this.Uri = uri; + + this.Info = info; + this.Stats = stats; + this.Fave = fave; + this.Yes = yes; + this.Maybe = maybe; + this.No = no; + } + + public void Draw() { + if (ImGui.CollapsingHeader($"Stats##{this.Name}")) { + var stats = string.Join("\n", this.Stats.Select(entry => $"{entry.Item1}: {entry.Item2}")); + ImGui.TextUnformatted(stats); + } + + if (ImGui.CollapsingHeader($"Info##{this.Name}", ImGuiTreeNodeFlags.DefaultOpen)) { + Util.DrawLines(this.Info); + } + + this.DrawKinkSection("Fave", this.Fave); + this.DrawKinkSection("Yes", this.Yes); + this.DrawKinkSection("Maybe", this.Maybe); + this.DrawKinkSection("No", this.No); + } + + private void DrawKinkSection(string sectionName, IEnumerable> kinks) { + if (!ImGui.CollapsingHeader($"{sectionName}##{this.Name}")) { + return; + } + + foreach (var (name, description) in kinks) { + ImGui.TextUnformatted(name); + if (!ImGui.IsItemHovered()) { + continue; + } + + ImGui.BeginTooltip(); + + ImGui.PushTextWrapPos(ImGui.GetIO().DisplaySize.X / 8); + ImGui.TextUnformatted(description); + ImGui.PopTextWrapPos(); + + ImGui.EndTooltip(); + } + } + } +} diff --git a/ExpandedSearchInfo/Sections/ISearchInfoSection.cs b/ExpandedSearchInfo/Sections/ISearchInfoSection.cs new file mode 100755 index 0000000..835dcdd --- /dev/null +++ b/ExpandedSearchInfo/Sections/ISearchInfoSection.cs @@ -0,0 +1,10 @@ +using System; + +namespace ExpandedSearchInfo.Sections { + public interface ISearchInfoSection { + string Name { get; } + Uri Uri { get; } + + void Draw(); + } +} diff --git a/ExpandedSearchInfo/Sections/RefsheetSection.cs b/ExpandedSearchInfo/Sections/RefsheetSection.cs new file mode 100755 index 0000000..8ae7027 --- /dev/null +++ b/ExpandedSearchInfo/Sections/RefsheetSection.cs @@ -0,0 +1,42 @@ +using System; +using System.Collections.Generic; +using ImGuiNET; + +namespace ExpandedSearchInfo.Sections { + public class RefsheetSection : ISearchInfoSection { + public string Name { get; } + public Uri Uri { get; } + + private List> Attributes { get; } + private string Notes { get; } + private List> Cards { get; } + + internal RefsheetSection(string name, Uri uri, List> attributes, string notes, List> cards) { + this.Name = name; + this.Uri = uri; + this.Attributes = attributes; + this.Notes = notes; + this.Cards = cards; + } + + public void Draw() { + if (ImGui.CollapsingHeader($"Attributes##{this.Name}")) { + foreach (var (key, value) in this.Attributes) { + ImGui.TextUnformatted($"{key}: {value}"); + } + } + + if (ImGui.CollapsingHeader($"Notes##{this.Name}")) { + Util.DrawLines(this.Notes); + } + + foreach (var (cardName, cardContent) in this.Cards) { + if (!ImGui.CollapsingHeader($"{cardName}##{this.Name}")) { + continue; + } + + Util.DrawLines(cardContent); + } + } + } +} diff --git a/ExpandedSearchInfo/Sections/TextSection.cs b/ExpandedSearchInfo/Sections/TextSection.cs new file mode 100755 index 0000000..0e9369e --- /dev/null +++ b/ExpandedSearchInfo/Sections/TextSection.cs @@ -0,0 +1,20 @@ +using System; +using ImGuiNET; + +namespace ExpandedSearchInfo.Sections { + public class TextSection : ISearchInfoSection { + private string Info { get; } + public string Name { get; } + public Uri Uri { get; } + + internal TextSection(string name, Uri uri, string info) { + this.Name = name; + this.Uri = uri; + this.Info = info; + } + + public void Draw() { + Util.DrawLines(this.Info); + } + } +} diff --git a/ExpandedSearchInfo/Util.cs b/ExpandedSearchInfo/Util.cs new file mode 100755 index 0000000..0e2d304 --- /dev/null +++ b/ExpandedSearchInfo/Util.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.Runtime.InteropServices; +using System.Text; +using System.Text.RegularExpressions; +using ImGuiNET; + +namespace ExpandedSearchInfo { + internal static class Util { + private static readonly Regex BbCodeTag = new(@"\[/?\w+(?:=.+?)?\]", RegexOptions.Compiled | RegexOptions.IgnoreCase); + + internal static string ReadRawString(IntPtr data) { + var bytes = new List(); + + for (var i = 0;; i++) { + var b = Marshal.ReadByte(data, i); + if (b == 0) { + break; + } + + bytes.Add(b); + } + + return Encoding.UTF8.GetString(bytes.ToArray()); + } + + internal static string StripBbCode(string input) => BbCodeTag.Replace(input, ""); + + internal static void DrawLines(string input) { + // FIXME: this is a workaround for imgui breaking on extremely long strings + foreach (var line in input.Split(new[] {"\n", "\r", "\r\n"}, StringSplitOptions.None)) { + ImGui.TextUnformatted(line); + } + } + } +} diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..4153cd3 --- /dev/null +++ b/LICENCE @@ -0,0 +1,287 @@ + EUROPEAN UNION PUBLIC LICENCE v. 1.2 + EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined +below) which is provided under the terms of this Licence. Any use of the Work, +other than as authorised under this Licence is prohibited (to the extent such +use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the +copyright notice for the Work: + + Licensed under the EUPL + +or has expressed by any other means his willingness to license under the EUPL. + +1. Definitions + +In this Licence, the following terms have the following meaning: + +- ‘The Licence’: this Licence. + +- ‘The Original Work’: the work or software distributed or communicated by the + Licensor under this Licence, available as Source Code and also as Executable + Code as the case may be. + +- ‘Derivative Works’: the works or software that could be created by the + Licensee, based upon the Original Work or modifications thereof. This Licence + does not define the extent of modification or dependence on the Original Work + required in order to classify a work as a Derivative Work; this extent is + determined by copyright law applicable in the country mentioned in Article 15. + +- ‘The Work’: the Original Work or its Derivative Works. + +- ‘The Source Code’: the human-readable form of the Work which is the most + convenient for people to study and modify. + +- ‘The Executable Code’: any code which has generally been compiled and which is + meant to be interpreted by a computer as a program. + +- ‘The Licensor’: the natural or legal person that distributes or communicates + the Work under the Licence. + +- ‘Contributor(s)’: any natural or legal person who modifies the Work under the + Licence, or otherwise contributes to the creation of a Derivative Work. + +- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of + the Work under the terms of the Licence. + +- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, online or offline, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +sublicensable licence to do the following, for the duration of copyright vested +in the Original Work: + +- use the Work in any circumstance and for all usage, +- reproduce the Work, +- modify the Work, and make Derivative Works based upon the Work, +- communicate to the public, including the right to make available or display + the Work or copies thereof to the public and perform publicly, as the case may + be, the Work, +- distribute the Work or copies thereof, +- lend and rent the Work or copies thereof, +- sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make effective +the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to +any patents held by the Licensor, to the extent necessary to make use of the +rights granted on the Work under this Licence. + +3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, in +a notice following the copyright notice attached to the Work, a repository where +the Source Code is easily and freely accessible for as long as the Licensor +continues to distribute or communicate the Work. + +4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits from +any exception or limitation to the exclusive rights of the rights owners in the +Work, of the exhaustion of those rights or of other applicable limitations +thereto. + +5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and a +copy of the Licence with every copy of the Work he/she distributes or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will be +done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version of the +Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions on +the Work or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed under +a Compatible Licence, this Distribution or Communication can be done under the +terms of this Compatible Licence. For the sake of this clause, ‘Compatible +Licence’ refers to the licences listed in the appendix attached to this Licence. +Should the Licensee's obligations under the Compatible Licence conflict with +his/her obligations under this Licence, the obligations of the Compatible +Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the Work, +the Licensee will provide a machine-readable copy of the Source Code or indicate +a repository where this Source will be easily and freely available for as long +as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade names, +trademarks, service marks, or names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + +6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects or +‘bugs’ inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an ‘as is’ basis +and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of defects +or errors, accuracy, non-infringement of intellectual property rights other than +copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + +8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the use +of the Work, including without limitation, damages for loss of goodwill, work +stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such damage. +However, the Licensor will be liable under statutory product liability laws as +far such laws apply to the Work. + +9. Additional agreements + +While distributing the Work, You may choose to conclude an additional agreement, +defining obligations or services consistent with this Licence. However, if +accepting obligations, You may act only on your own behalf and on your sole +responsibility, not on behalf of the original Licensor or any other Contributor, +and only if You agree to indemnify, defend, and hold each Contributor harmless +for any liability incurred by, or claims asserted against such Contributor by +the fact You have accepted any warranty or additional liability. + +10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ +placed under the bottom of a window displaying the text of this Licence or by +affirming consent in any other similar way, in accordance with the rules of +applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this Licence, +such as the use of the Work, the creation by You of a Derivative Work or the +Distribution or Communication by You of the Work or copies thereof. + +11. Information to the public + +In case of any Distribution or Communication of the Work by means of electronic +communication by You (for example, by offering to download the Work from a +remote location) the distribution channel or media (for example, a website) must +at least provide to the public the information requested by the applicable law +regarding the Licensor, the Licence and the way it may be accessible, concluded, +stored and reproduced by the Licensee. + +12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has +received the Work from the Licensee under the Licence, provided such persons +remain in full compliance with the Licence. + +13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed or reformed so as necessary to make it +valid and enforceable. + +The European Commission may publish other linguistic versions or new versions of +this Licence or updated versions of the Appendix, so far this is required and +reasonable, without reducing the scope of the rights granted by the Licence. New +versions of the Licence will be published with a unique version number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +14. Jurisdiction + +Without prejudice to specific agreement between parties, + +- any litigation resulting from the interpretation of this License, arising + between the European Union institutions, bodies, offices or agencies, as a + Licensor, and any Licensee, will be subject to the jurisdiction of the Court + of Justice of the European Union, as laid down in article 272 of the Treaty on + the Functioning of the European Union, + +- any litigation arising between other parties and resulting from the + interpretation of this License, will be subject to the exclusive jurisdiction + of the competent court where the Licensor resides or conducts its primary + business. + +15. Applicable Law + +Without prejudice to specific agreement between parties, + +- this Licence shall be governed by the law of the European Union Member State + where the Licensor has his seat, resides or has his registered office, + +- this licence shall be governed by Belgian law if the Licensor has no seat, + residence or registered office inside a European Union Member State. + +Appendix + +‘Compatible Licences’ according to Article 5 EUPL are: + +- GNU General Public License (GPL) v. 2, v. 3 +- GNU Affero General Public License (AGPL) v. 3 +- Open Software License (OSL) v. 2.1, v. 3.0 +- Eclipse Public License (EPL) v. 1.0 +- CeCILL v. 2.0, v. 2.1 +- Mozilla Public Licence (MPL) v. 2 +- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 +- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for + works other than software +- European Union Public Licence (EUPL) v. 1.1, v. 1.2 +- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong + Reciprocity (LiLiQ-R+). + +The European Commission may update this Appendix to later versions of the above +licences without producing a new version of the EUPL, as long as they provide +the rights granted in Article 2 of this Licence and protect the covered Source +Code from exclusive appropriation. + +All other changes or additions to this Appendix require the production of a new +EUPL version.