include download stats

PluginBuilder/APIModels/PublishedVersion.cs

@@ -8,6 +8,7 @@ public class PublishedVersion
         public string ProjectSlug { get; set; }
         public string Version { get; set; }
         public long BuildId { get; set; }
+        public long DownloadStat { get; set; }
         public JObject BuildInfo { get; set; }
         public JObject ManifestInfo { get; set; }
         public string Documentation { get; set; }

PluginBuilder/Controllers/ApiController.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Reflection;
 using Dapper;
 using Microsoft.AspNetCore.Authorization;
@@ -70,8 +71,8 @@ public async Task<IActionResult> Plugins(
         };
         await using var conn = await ConnectionFactory.Open();
         // This query probably doesn't have right indexes
-        var rows = await conn.QueryAsync<(string plugin_slug, int[] ver, string settings, long id, string manifest_info, string build_info)>(
-            $"SELECT lv.plugin_slug, lv.ver, p.settings, b.id, b.manifest_info, b.build_info FROM {getVersions}(@btcpayVersion, @includePreRelease) lv " +
+        var rows = await conn.QueryAsync<(string plugin_slug, int[] ver, string settings, long id, string manifest_info, string build_info, long download_stat)>(
+            $"SELECT lv.plugin_slug, lv.ver, p.settings, b.id, b.manifest_info, b.build_info, lv.download_stat FROM {getVersions}(@btcpayVersion, @includePreRelease) lv " +
             "JOIN builds b ON b.plugin_slug = lv.plugin_slug AND b.id = lv.build_id " +
             "JOIN plugins p ON b.plugin_slug = p.slug " +
             "WHERE b.manifest_info IS NOT NULL AND b.build_info IS NOT NULL " +
@@ -88,6 +89,7 @@ public async Task<IActionResult> Plugins(
             var v = new PublishedVersion
             {
                 ProjectSlug = r.plugin_slug,
+                DownloadStat = r.download_stat,
                 Version = string.Join('.', r.ver),
                 BuildId = r.id,
                 BuildInfo = JObject.Parse(r.build_info),
@@ -106,24 +108,65 @@ public async Task<IActionResult> Download(
         [ModelBinder(typeof(PluginVersionModelBinder))] PluginVersion version)
     {
         await using var conn = await ConnectionFactory.Open();
-        var url = await conn.ExecuteScalarAsync<string?>(
-            "SELECT b.build_info->>'url' FROM versions v " +
+
+        var result = await conn.QueryFirstOrDefaultAsync<(string? Url, long BuildId)>(
+            "SELECT b.build_info->>'url' AS Url, v.build_id AS BuildId " +
+            "FROM versions v " +
             "JOIN builds b ON b.plugin_slug = v.plugin_slug AND b.id = v.build_id " +
             "WHERE v.plugin_slug=@plugin_slug AND v.ver=@version",
             new
             {
                 plugin_slug = pluginSlug.ToString(),
                 version = version.VersionParts
             });
-        if (url is null)
+
+        if (result.Url is null)
             return NotFound();
 
-        await conn.InsertEvent("Download", new JObject
+        var clientIp = HttpContext.Connection.RemoteIpAddress?.ToString();
+
+        var lastEventType = await conn.GetLastEventTypeForIpAsync(clientIp, pluginSlug);
+        var eventInsertionResponse = await conn.InsertEvent("Download", new JObject
         {
             ["pluginSlug"] = pluginSlug.ToString(),
             ["version"] = version.ToString()
-        });
-        return Redirect(url);
+        }, clientIp, pluginSlug, result.BuildId);
+        if (eventInsertionResponse || lastEventType?.ToLower() == "uninstall")
+        {
+            await conn.RecordPluginDownloadStatistics(pluginSlug, "install", version.VersionParts);
+        }
+        return Redirect(result.Url);
+    }
+
+
+    [AllowAnonymous]
+    [HttpGet("plugins/{pluginSlug}/versions/{version}/uninstall")]
+    public async Task<IActionResult> Uninstall(
+    [ModelBinder(typeof(PluginSlugModelBinder))] PluginSlug pluginSlug,
+    [ModelBinder(typeof(PluginVersionModelBinder))] PluginVersion version)
+    {
+        await using var conn = await ConnectionFactory.Open();
+        var buildId = await conn.QuerySingleOrDefaultAsync<long>(
+            "SELECT build_id FROM versions WHERE plugin_slug = @plugin_slug AND ver = @version",
+            new
+            {
+                plugin_slug = pluginSlug.ToString(),
+                version = version.VersionParts
+            });
+
+        var clientIp = HttpContext.Connection.RemoteIpAddress?.ToString();
+        var lastEventType = await conn.GetLastEventTypeForIpAsync(clientIp, pluginSlug);
+        var eventInsertionResponse = await conn.InsertEvent("Uninstall", new JObject
+        {
+            ["pluginSlug"] = pluginSlug.ToString(),
+            ["version"] = version.ToString()
+        }, clientIp, pluginSlug, buildId);
+
+        if (eventInsertionResponse || lastEventType?.ToLower() == "download")
+        {
+            await conn.RecordPluginDownloadStatistics(pluginSlug, "delete", version.VersionParts);
+        }
+        return NoContent();
     }
 
     [HttpPost("plugins/{pluginSlug}/builds")]

PluginBuilder/Data/Scripts/03.Init.sql

@@ -69,18 +69,3 @@ CREATE TABLE builds_logs
     FOREIGN KEY (plugin_slug, build_id) REFERENCES builds (plugin_slug, id) ON DELETE CASCADE
 );
 CREATE INDEX builds_logs_idx ON builds_logs (plugin_slug, build_id, created_at);
-
-
-CREATE OR REPLACE FUNCTION get_latest_versions (btcpayVersion INT[], includePreRelease BOOLEAN)
-RETURNS TABLE(plugin_slug TEXT, ver INT[], build_id BIGINT)
-AS $$
-WITH latest_versions AS
-(
-    SELECT plugin_slug, MAX(ver) ver FROM versions
-    WHERE btcpay_min_ver <= btcpayVersion AND (includePreRelease OR pre_release IS FALSE)
-    GROUP BY plugin_slug
-)
-SELECT v.plugin_slug, v.ver, v.build_id FROM latest_versions lv
-JOIN versions v USING (plugin_slug, ver)
-
-$$ LANGUAGE SQL STABLE;

PluginBuilder/Data/Scripts/08.MultiVersionReturn.sql

@@ -1,12 +1,46 @@
+ALTER TABLE versions ADD COLUMN download_stat BIGINT NOT NULL DEFAULT 0;
+
+ALTER TABLE evts
+ADD COLUMN plugin_slug TEXT,
+ADD COLUMN build_id BIGINT,
+ALTER COLUMN type TYPE VARCHAR(16),
+ADD COLUMN id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+ADD COLUMN ip VARCHAR(45),
+ADD CONSTRAINT unique_event UNIQUE (ip, plugin_slug, type);
+
+CREATE INDEX idx_evts_plugin_slug ON evts(plugin_slug);
+CREATE INDEX idx_evts_type ON evts(type);
+CREATE INDEX idx_evts_build_id ON evts(build_id);
+
+DROP FUNCTION IF EXISTS get_latest_versions(btcpayVersion INT[], includePreRelease BOOLEAN);
+DROP FUNCTION IF EXISTS get_all_versions(btcpayVersion INT[], includePreRelease BOOLEAN);
+
+
+CREATE OR REPLACE FUNCTION get_latest_versions (btcpayVersion INT[], includePreRelease BOOLEAN)
+RETURNS TABLE(plugin_slug TEXT, ver INT[], build_id BIGINT, download_stat BIGINT)
+AS $$
+WITH latest_versions AS
+(
+    SELECT plugin_slug, MAX(ver) ver FROM versions
+    WHERE (btcpayVersion IS NULL OR btcpay_min_ver <= btcpayVersion) AND (includePreRelease OR pre_release IS FALSE)
+    GROUP BY plugin_slug
+)
+SELECT v.plugin_slug, v.ver, v.build_id, v.download_stat FROM latest_versions lv
+JOIN versions v USING (plugin_slug, ver)
+
+$$ LANGUAGE SQL STABLE;
+
+
 CREATE OR REPLACE FUNCTION get_all_versions (btcpayVersion INT[], includePreRelease BOOLEAN)
-RETURNS TABLE(plugin_slug TEXT, ver INT[], build_id BIGINT)
+RETURNS TABLE(plugin_slug TEXT, ver INT[], build_id BIGINT, download_stat BIGINT)
 AS $$
 WITH latest_versions AS
 (
     SELECT plugin_slug, ver FROM versions
     WHERE (btcpayVersion IS NULL OR btcpay_min_ver <= btcpayVersion) AND (includePreRelease OR pre_release IS FALSE)
     ORDER BY plugin_slug, ver DESC
 )
-SELECT v.plugin_slug, v.ver, v.build_id
+SELECT v.plugin_slug, v.ver, v.build_id, v.download_stat
 FROM latest_versions lv
          JOIN versions v USING (plugin_slug, ver) $$ LANGUAGE SQL STABLE;
+

PluginBuilder/NpgsqlConnectionExtensions.cs

@@ -1,4 +1,5 @@
 #nullable enable
+using System;
 using Dapper;
 using Microsoft.Extensions.Hosting;
 using Newtonsoft.Json;
@@ -145,13 +146,32 @@ public static async Task<bool> EnsureIdentifierOwnership(this NpgsqlConnection c
             return null;
         }
 
-        public static Task InsertEvent(this NpgsqlConnection connection, string evtType, JObject data)
+        public static async Task<bool> InsertEvent(this NpgsqlConnection connection, string evtType, JObject data, string? ipAddress, PluginSlug pluginSlug, long buildId)
         {
-            return connection.ExecuteAsync("INSERT INTO evts VALUES (@evtType, @evt::JSONB);", new
-            {
-                evtType = evtType,
-                evt = data.ToString()
-            });
+            var result = await connection.ExecuteScalarAsync<int>(
+                @"INSERT INTO evts (type, data, ip, plugin_slug, build_id) 
+                  VALUES (@evtType, @evt::JSONB, @ip, @plugin_slug, @build_id)
+                  ON CONFLICT (ip, plugin_slug, type) DO UPDATE SET created_at = NOW()
+                  RETURNING (xmax = 0)::int;",
+                new
+                {
+                    evtType,
+                    evt = data.ToString(),
+                    ip = ipAddress,
+                    plugin_slug = pluginSlug.ToString(),
+                    build_id = buildId
+                });
+            return result == 1;
+        }
+
+        public static async Task<string?> GetLastEventTypeForIpAsync(this NpgsqlConnection connection, string? ipAddress, PluginSlug pluginSlug)
+        {
+            return await connection.QuerySingleOrDefaultAsync<string?>(
+                @"SELECT type FROM evts 
+                  WHERE @ip IS NOT NULL 
+                  AND ip = @ip AND plugin_slug = @plugin_slug 
+                  ORDER BY created_at DESC LIMIT 1",
+                new { ip = ipAddress, plugin_slug = pluginSlug.ToString() });
         }
 
         public static async Task<bool> SetVersionBuild(this NpgsqlConnection connection, FullBuildId fullBuildId, PluginVersion version, PluginVersion? minBTCPayVersion, bool preRelease)
@@ -195,5 +215,28 @@ public static Task<long> NewBuild(this NpgsqlConnection connection, PluginSlug p
                     buildInfo = bi.ToString()
                 });
         }
+
+        public static async Task RecordPluginDownloadStatistics(this NpgsqlConnection connection, PluginSlug pluginSlug, string action, int[]? version = null)
+        {
+            string versionCondition = version != null
+                ? "ver = @version"
+                : "ver = (SELECT MAX(ver) FROM versions WHERE plugin_slug = @plugin_slug AND pre_release IS FALSE)";
+
+            string updateStat = action.ToLower() switch
+            {
+                "install" => "UPDATE versions AS v SET download_stat = v.download_stat + 1 WHERE v.pre_release IS FALSE AND plugin_slug = @plugin_slug AND " + versionCondition,
+                "delete" => "UPDATE versions AS v SET download_stat = GREATEST(v.download_stat - 1, 0) WHERE v.pre_release IS FALSE AND plugin_slug = @plugin_slug AND " + versionCondition,
+                _ => null
+            };
+
+            if (updateStat != null)
+            {
+                await connection.ExecuteAsync(updateStat, new
+                {
+                    plugin_slug = pluginSlug.ToString(),
+                    version
+                });
+            }
+        }
     }
 }