From 52645b724834e669788a45edb9d135f243432540 Mon Sep 17 00:00:00 2001 From: vnugent Date: Fri, 2 Feb 2024 21:14:19 -0500 Subject: download file formats, button tweaks, more cache infra --- back-end/src/Cache/MemPackCacheSerializer.cs | 34 +++++++ back-end/src/Cache/ResultCacheEntry.cs | 44 ++++++++ back-end/src/Cache/SearchResultCache.cs | 111 +++++++++++++++++++++ back-end/src/Cache/UserSettingsStore.cs | 16 +-- back-end/src/Endpoints/BookmarkEndpoint.cs | 44 ++++++-- back-end/src/ImportExportUtil.cs | 67 +++++++++++++ back-end/src/SimpleBookmarkEntry.cs | 45 ++++++++- front-end/src/buttons.scss | 2 +- front-end/src/components/Settings/Bookmarks.vue | 86 +++++++++++++--- front-end/src/components/Settings/PkiSettings.vue | 2 +- front-end/src/components/Settings/TotpSettings.vue | 2 +- front-end/src/store/bookmarks.ts | 8 +- front-end/src/store/index.ts | 2 + 13 files changed, 416 insertions(+), 47 deletions(-) create mode 100644 back-end/src/Cache/MemPackCacheSerializer.cs create mode 100644 back-end/src/Cache/ResultCacheEntry.cs create mode 100644 back-end/src/Cache/SearchResultCache.cs diff --git a/back-end/src/Cache/MemPackCacheSerializer.cs b/back-end/src/Cache/MemPackCacheSerializer.cs new file mode 100644 index 0000000..f1ffa88 --- /dev/null +++ b/back-end/src/Cache/MemPackCacheSerializer.cs @@ -0,0 +1,34 @@ +// Copyright (C) 2024 Vaughn Nugent +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + + +using System; +using System.Buffers; + +using MemoryPack; + +using VNLib.Data.Caching; + +namespace SimpleBookmark.Cache +{ + internal sealed class MemPackCacheSerializer(MemoryPackSerializerOptions? options) : ICacheObjectSerializer, ICacheObjectDeserializer + { + /// + public T? Deserialize(ReadOnlySpan objectData) => MemoryPackSerializer.Deserialize(objectData, options); + + /// + public void Serialize(T obj, IBufferWriter finiteWriter) => MemoryPackSerializer.Serialize(finiteWriter, obj, options); + } +} diff --git a/back-end/src/Cache/ResultCacheEntry.cs b/back-end/src/Cache/ResultCacheEntry.cs new file mode 100644 index 0000000..3e23042 --- /dev/null +++ b/back-end/src/Cache/ResultCacheEntry.cs @@ -0,0 +1,44 @@ +// Copyright (C) 2024 Vaughn Nugent +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +using System; +using System.Buffers; +using System.Runtime.InteropServices; +using System.Text.Json.Serialization; + +using MemoryPack; + +namespace SimpleBookmark.Cache +{ + [MemoryPackable] + internal partial class ResultCacheEntry : IDisposable + { + [MemoryPoolFormatter] + public Memory Payload { get; set; } + + [JsonPropertyName("created")] + public DateTime Created { get; set; } + + public void Dispose() + { + //Return the array back to the pool + if (MemoryMarshal.TryGetArray(Payload, out ArraySegment segment) && segment.Array is { Length: > 0 }) + { + ArrayPool.Shared.Return(segment.Array); + Payload = default; + } + } + } +} diff --git a/back-end/src/Cache/SearchResultCache.cs b/back-end/src/Cache/SearchResultCache.cs new file mode 100644 index 0000000..c7a263a --- /dev/null +++ b/back-end/src/Cache/SearchResultCache.cs @@ -0,0 +1,111 @@ +// Copyright (C) 2024 Vaughn Nugent +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +using System; +using System.Threading; +using System.Threading.Tasks; + +using VNLib.Net.Http; +using VNLib.Data.Caching; +using VNLib.Plugins; +using VNLib.Plugins.Extensions.Loading; +using VNLib.Plugins.Extensions.VNCache; +using VNLib.Plugins.Extensions.VNCache.DataModel; + +namespace SimpleBookmark.Cache +{ + [ConfigurationName("search_cache", Required = false)] + internal sealed class SearchResultCache + { + private readonly IEntityCache? _cache; + + /// + /// Gets a value that indicates if the configuration enabled result caching + /// + public bool IsEnabled => _cache != null; + + public SearchResultCache(PluginBase plugin) : this(plugin, null) + { } + + public SearchResultCache(PluginBase plugin, IConfigScope? config) + { + string? cachePrefix = config?.GetRequiredProperty("cachePrefix", p => p.GetString()!); + bool isEnabled = config?.GetRequiredProperty("enabled", p => p.GetBoolean()) ?? true; + + if (!isEnabled) + { + return; + } + + IGlobalCacheProvider? cache = plugin.GetDefaultGlobalCache(); + if (cache != null) + { + if (cachePrefix != null) + { + _cache = cache.GetPrefixedCache(cachePrefix) + .CreateEntityCache( + new MemPackCacheSerializer(null), + new MemPackCacheSerializer(null) + ); + } + else + { + //non-prefixed cache + _cache = cache.CreateEntityCache( + new MemPackCacheSerializer(null), + new MemPackCacheSerializer(null) + ); + } + } + } + + public async Task GetCachedResultAsync(string[] keys, CancellationToken cancellation) + { + ResultCacheEntry? entry = await _cache!.GetAsync($"{keys}", cancellation); + return entry is null ? null : new ResultResponseReader(entry); + } + + public Task StoreResultAsync(Memory data, string[] keys, CancellationToken cancellation) + { + //Init new entry + ResultCacheEntry entry = new() + { + Payload = data, + Created = DateTime.UtcNow + }; + + return _cache!.UpsertAsync($"{keys}", entry, cancellation); + } + + public Task DeleteEntry(string[] keys, CancellationToken cancellation) => _cache!.RemoveAsync($"{keys}", cancellation); + + private sealed class ResultResponseReader(ResultCacheEntry entry) : IMemoryResponseReader + { + private int _position; + + /// + public int Remaining => entry.Payload.Length - _position; + + /// + public void Advance(int written) => _position += written; + + /// + public void Close() => entry.Dispose(); + + /// + public ReadOnlyMemory GetMemory() => entry.Payload.Slice(_position); + } + } +} diff --git a/back-end/src/Cache/UserSettingsStore.cs b/back-end/src/Cache/UserSettingsStore.cs index 51d47ff..8887973 100644 --- a/back-end/src/Cache/UserSettingsStore.cs +++ b/back-end/src/Cache/UserSettingsStore.cs @@ -14,11 +14,6 @@ // along with this program. If not, see . -using System; -using System.Buffers; - -using MemoryPack; - using VNLib.Plugins; using VNLib.Plugins.Extensions.Loading; using VNLib.Data.Caching; @@ -27,6 +22,7 @@ using VNLib.Plugins.Extensions.VNCache.DataModel; namespace SimpleBookmark.Cache { + [ConfigurationName("settings")] internal sealed class UserSettingsStore { @@ -47,16 +43,6 @@ namespace SimpleBookmark.Cache Cache = cache.GetPrefixedCache(prefix) .CreateEntityCache(serializer, serializer); } - - } - - private sealed class MemPackCacheSerializer(MemoryPackSerializerOptions? options) : ICacheObjectSerializer, ICacheObjectDeserializer - { - /// - public T? Deserialize(ReadOnlySpan objectData) => MemoryPackSerializer.Deserialize(objectData, options); - - /// - public void Serialize(T obj, IBufferWriter finiteWriter) => MemoryPackSerializer.Serialize(finiteWriter, obj, options); } } } diff --git a/back-end/src/Endpoints/BookmarkEndpoint.cs b/back-end/src/Endpoints/BookmarkEndpoint.cs index 05b72d0..e6e388d 100644 --- a/back-end/src/Endpoints/BookmarkEndpoint.cs +++ b/back-end/src/Endpoints/BookmarkEndpoint.cs @@ -19,7 +19,6 @@ using System.Linq; using System.Buffers; using System.Text.Json; using System.Collections; -using SimpleBookmark.Model; using System.Threading.Tasks; using System.Collections.Generic; using System.Text.Json.Serialization; @@ -43,6 +42,8 @@ using VNLib.Plugins.Extensions.Loading.Sql; using VNLib.Plugins.Extensions.Data.Extensions; using VNLib.Plugins.Extensions.Validation; +using SimpleBookmark.Model; + namespace SimpleBookmark.Endpoints { @@ -123,7 +124,11 @@ namespace SimpleBookmark.Endpoints */ if(entity.QueryArgs.ContainsKey("export")) { - if (entity.Server.Accepts(ContentType.Html)) + bool html = entity.Server.Accept.Contains("text/html"); + bool csv = entity.Server.Accept.Contains("text/csv"); + bool json = entity.Server.Accept.Contains("application/json"); + + if (html | csv | json) { //Get the collection of bookmarks List list = Bookmarks.ListRental.Rent(); @@ -134,20 +139,41 @@ namespace SimpleBookmark.Endpoints try { //Write the bookmarks as a netscape file and return the file - ImportExportUtil.ExportToNetscapeFile(list, output); - output.Seek(0, System.IO.SeekOrigin.Begin); - return VirtualClose(entity, HttpStatusCode.OK, ContentType.Html, output); + if (html) + { + ImportExportUtil.ExportToNetscapeFile(list, output); + + output.Seek(0, System.IO.SeekOrigin.Begin); + return VirtualClose(entity, HttpStatusCode.OK, ContentType.Html, output); + } + else if(csv) + { + ImportExportUtil.ExportAsCsv(list, output); + + output.Seek(0, System.IO.SeekOrigin.Begin); + return VirtualClose(entity, HttpStatusCode.OK, ContentType.Csv, output); + } + else if(json) + { + ImportExportUtil.ExportAsJson(list, output); + + output.Seek(0, System.IO.SeekOrigin.Begin); + return VirtualClose(entity, HttpStatusCode.OK, ContentType.Json, output); + } } catch { output.Dispose(); throw; } + finally + { + list.TrimExcess(); + Bookmarks.ListRental.Return(list); + } } - else - { - return VirtualClose(entity, HttpStatusCode.NotAcceptable); - } + + return VirtualClose(entity, HttpStatusCode.NotAcceptable); } //Get query parameters diff --git a/back-end/src/ImportExportUtil.cs b/back-end/src/ImportExportUtil.cs index 3610ef6..6fa554c 100644 --- a/back-end/src/ImportExportUtil.cs +++ b/back-end/src/ImportExportUtil.cs @@ -15,8 +15,11 @@ using System; using System.IO; +using System.Text.Json; using SimpleBookmark.Model; using System.Collections.Generic; +using System.Text.RegularExpressions; + using VNLib.Utils.IO; @@ -73,5 +76,69 @@ namespace SimpleBookmark writer.WriteLine("

"); writer.Flush(); } + + //Remove illegal characters from a string, ", \, and control characters + private static readonly Regex _illegalChars = new("[\"\\p{Cc}]", RegexOptions.Compiled); + + private static string? Escape(string? input) + { + return input is null ? null : _illegalChars.Replace(input, ""); + } + + public static void ExportAsCsv(IEnumerable bookmarks, Stream outputStream) + { + using VnStreamWriter writer = new(outputStream, System.Text.Encoding.UTF8, 1024) + { + NewLine = "\r\n" + }; + + //Write header + writer.WriteLine("Name,Url,Description,Tags,Created,LastModified"); + + //Write each bookmark + foreach (BookmarkEntry entry in bookmarks) + { + //User params must be escaped with double quotes + + writer.Write("\""); + writer.Write(Escape(entry.Name)); + writer.Write("\",\""); + writer.Write(Escape(entry.Url)); + writer.Write("\",\""); + writer.Write(Escape(entry.Description)); + writer.Write("\",\""); + writer.Write(Escape(entry.Tags)); + writer.Write("\","); + writer.Write(new DateTimeOffset(entry.Created).ToUnixTimeSeconds()); + writer.Write(","); + writer.Write(new DateTimeOffset(entry.LastModified).ToUnixTimeSeconds()); + writer.WriteLine(); + } + + writer.Flush(); + } + + public static void ExportAsJson(IEnumerable bookmarks, Stream outputStream) + { + using Utf8JsonWriter writer = new(outputStream, default); + + writer.WriteStartArray(); + + foreach (BookmarkEntry entry in bookmarks) + { + writer.WriteStartObject(); + + writer.WriteString("Name", entry.Name); + writer.WriteString("Url", entry.Url); + writer.WriteString("Description", entry.Description); + writer.WriteString("Tags", entry.Tags); + writer.WriteNumber("Created", new DateTimeOffset(entry.Created).ToUnixTimeSeconds()); + writer.WriteNumber("LastModified", new DateTimeOffset(entry.LastModified).ToUnixTimeSeconds()); + + writer.WriteEndObject(); + } + + writer.WriteEndArray(); + } } } diff --git a/back-end/src/SimpleBookmarkEntry.cs b/back-end/src/SimpleBookmarkEntry.cs index d44aacb..48fcb2a 100644 --- a/back-end/src/SimpleBookmarkEntry.cs +++ b/back-end/src/SimpleBookmarkEntry.cs @@ -22,6 +22,9 @@ */ using System; +using System.Linq; +using System.Text; +using System.Text.Json; using VNLib.Plugins; using VNLib.Utils.Logging; @@ -37,6 +40,7 @@ namespace SimpleBookmark public sealed class SimpleBookmarkEntry : PluginBase { + /// public override string PluginName { get; } = "SimpleBookmark"; @@ -49,7 +53,8 @@ namespace SimpleBookmark //Ensure database is created after a delay this.ObserveWork(() => this.EnsureDbCreatedAsync(this), 1000); - Log.Information("Plugin loaded"); + Log.Information("Plugin Loaded"); + PrintHelloMessage(); } /// @@ -62,5 +67,43 @@ namespace SimpleBookmark { throw new NotImplementedException(); } + + private void PrintHelloMessage() + { + const string template = +@" +****************************************************************************** + Simple-Bookmark - A linkding inspired, self hosted, bookmark manager + By Vaughn Nugent - vnpublic @proton.me + https://www.vaughnnugent.com/resources/software + License: GNU Affero General Public License v3.0 + This application comes with ABSOLUTELY NO WARRANTY. + + Documentation: https://www.vaughnnugent.com/resources/software/articles?tags=docs,_simple-bookmark + GitHub: https://github.com/VnUgE/simple-bookmark + + Your server is now running at the following locations:{0} +******************************************************************************"; + + string[] interfaces = HostConfig.GetProperty("virtual_hosts") + .EnumerateArray() + .Select(e => + { + JsonElement el = e.GetProperty("interface"); + string ipAddress = el.GetProperty("address").GetString()!; + int port = el.GetProperty("port").GetInt32(); + return $"{ipAddress}:{port}"; + }) + .ToArray(); + + StringBuilder sb = new(); + foreach (string intf in interfaces) + { + sb.Append("\n\t"); + sb.AppendLine(intf); + } + + Log.Information(template, sb); + } } } diff --git a/front-end/src/buttons.scss b/front-end/src/buttons.scss index 409f405..7088deb 100644 --- a/front-end/src/buttons.scss +++ b/front-end/src/buttons.scss @@ -1,5 +1,5 @@ .btn{ - @apply focus:ring-2 focus:outline-none font-medium rounded text-sm px-4 py-2 text-center me-2 text-white; + @apply focus:ring-2 focus:outline-none font-medium rounded text-sm px-4 py-2 text-center text-white; &.round{ @apply rounded-full; diff --git a/front-end/src/components/Settings/Bookmarks.vue b/front-end/src/components/Settings/Bookmarks.vue index 68fa86b..7f73921 100644 --- a/front-end/src/components/Settings/Bookmarks.vue +++ b/front-end/src/components/Settings/Bookmarks.vue @@ -1,33 +1,87 @@ \ No newline at end of file diff --git a/front-end/src/components/Settings/PkiSettings.vue b/front-end/src/components/Settings/PkiSettings.vue index 2564cf6..dfa4cad 100644 --- a/front-end/src/components/Settings/PkiSettings.vue +++ b/front-end/src/components/Settings/PkiSettings.vue @@ -129,7 +129,7 @@ const onAddKey = async () => {

Authentication Keys

-
-
+
diff --git a/front-end/src/store/bookmarks.ts b/front-end/src/store/bookmarks.ts index b0595e9..76cc5b9 100644 --- a/front-end/src/store/bookmarks.ts +++ b/front-end/src/store/bookmarks.ts @@ -43,6 +43,8 @@ export interface BookmarkError{ }> } +export type DownloadContentType = 'application/json' | 'text/html' | 'text/csv' | 'text/plain' + export interface BookmarkApi{ list: (page: number, limit: number, search: BookmarkSearch) => Promise add: (bookmark: Bookmark) => Promise @@ -51,7 +53,7 @@ export interface BookmarkApi{ getTags: () => Promise delete: (bookmark: Bookmark | Bookmark[]) => Promise count: () => Promise - downloadAll: () => Promise + downloadAll: (contentType: DownloadContentType) => Promise } export interface BookmarkSearch{ @@ -141,10 +143,10 @@ const useBookmarkApi = (endpoint: MaybeRef): BookmarkApi => { return data.result; } - const downloadAll = async () => { + const downloadAll = async (contentType: DownloadContentType) => { //download the bookmarks as a html file const { data } = await axios.get(`${get(endpoint)}?export=true`, { - headers: { 'Content-Type': 'application/htlm' } + headers: { 'Accept': contentType } }) return data; } diff --git a/front-end/src/store/index.ts b/front-end/src/store/index.ts index c13edcb..bcd79ad 100644 --- a/front-end/src/store/index.ts +++ b/front-end/src/store/index.ts @@ -19,6 +19,8 @@ import { noop, toSafeInteger, toString, defaults } from "lodash-es"; import { defineStore } from "pinia"; import { computed, shallowRef, watch } from "vue"; +export type { DownloadContentType } from './bookmarks' + export const useQuery = (name: string) => { const getQuery = () => { -- cgit