Add RoomTicker struct for representing tickers

It's nicer to work with than a 2D array.

Author: mathiascode

src/db.d

@@ -8,7 +8,8 @@ module soulfind.db;
 
 import soulfind.defines : blue, default_max_users, default_motd, default_port,
                           default_private_mode, log_db, log_user, norm,
-                          RoomMemberType, RoomType, SearchFilterType;
+                          RoomMemberType, RoomTicker, RoomType,
+                          SearchFilterType, UserStats;
 import std.array : Appender;
 import std.conv : ConvException, text, to;
 import std.datetime : Clock, days, Duration, SysTime, UTC;
@@ -79,17 +80,6 @@ enum tickers_table         = "tickers";
 enum search_filters_table  = "search_filters";
 enum search_query_table    = "temp.search_query";
 
-struct SdbUserStats
-{
-    bool    exists;
-    uint    upload_speed;
-    uint    shared_files;
-    uint    shared_folders;
-
-    bool    updating_speed;
-    bool    updating_shared;
-}
-
 final class SdbException : Exception
 {
     this(string msg, string file = __FILE__, size_t line = __LINE__) {
@@ -749,15 +739,15 @@ final class Sdb
         return SysTime.fromUnixTime(banned_until, UTC());
     }
 
-    SdbUserStats user_stats(string username)
+    UserStats user_stats(string username)
     {
         enum sql = text(
             "SELECT speed,files,folders",
             " FROM ", users_table,
             " WHERE username = ?;"
         );
         const res = query(sql, [username]);
-        auto user_stats = SdbUserStats();
+        auto user_stats = UserStats();
 
         if (res.length > 0) {
             const record                   = res[0];
@@ -775,7 +765,7 @@ final class Sdb
         return user_stats;
     }
 
-    void user_update_stats(string username, SdbUserStats stats)
+    void user_update_stats(string username, UserStats stats)
     {
         Appender!(string[]) fields;
         Appender!(string[]) parameters;
@@ -1029,18 +1019,26 @@ final class Sdb
         return username;
     }
 
-    string[][] room_tickers(string room_name)
+    RoomTicker[] room_tickers(string room_name)
     {
+        Appender!(RoomTicker[]) tickers;
         enum sql = text(
             "SELECT username, content FROM ", tickers_table,
             " WHERE room = ?",
             " ORDER BY rowid;"
         );
-        return query(sql, [room_name]);
+
+        const res = query(sql, [room_name]);
+        foreach (ref record ; res) {
+            const username = record[0], content = record[1];
+            tickers ~= RoomTicker(room_name, username, content);
+        }
+        return tickers[];
     }
 
-    string[][] user_tickers(RoomType type)(string username)
+    RoomTicker[] user_tickers(RoomType type)(string username)
     {
+        Appender!(RoomTicker[]) tickers;
         auto sql = text(
             "SELECT t.room, t.content FROM ", tickers_table, " t",
             " JOIN ", rooms_table, " r ON t.room = r.room",
@@ -1054,7 +1052,12 @@ final class Sdb
         }
         sql ~= " ORDER BY t.rowid;";
 
-        return query(sql, parameters);
+        const res = query(sql, parameters);
+        foreach (ref record ; res) {
+            const room_name = record[0], content = record[1];
+            tickers ~= RoomTicker(room_name, username, content);
+        }
+        return tickers[];
     }
 
     ulong num_room_tickers(string room_name)

src/defines.d

@@ -11,28 +11,6 @@ import std.string : join, split;
 
 // Constants
 
-enum RoomType : int
-{
-    any           = -2,
-    non_existent  = -1,
-    _public       = 0,
-    _private      = 1
-}
-
-enum RoomMemberType : int
-{
-    any           = -2,
-    non_existent  = -1,
-    normal        = 0,
-    operator      = 1
-}
-
-enum SearchFilterType : uint
-{
-    server  = 0,
-    client  = 1
-}
-
 enum VERSION                     = __DATE__.split.join("-");
 enum default_db_filename         = "soulfind.db";
 enum default_port                = 2242;
@@ -64,6 +42,52 @@ enum server_username             = "server";
 enum exit_message                = "A la prochaine...";
 
 
+// Types
+
+enum RoomType : int
+{
+    any           = -2,
+    non_existent  = -1,
+    _public       = 0,
+    _private      = 1
+}
+
+enum RoomMemberType : int
+{
+    any           = -2,
+    non_existent  = -1,
+    normal        = 0,
+    operator      = 1
+}
+
+enum SearchFilterType : uint
+{
+    server  = 0,
+    client  = 1
+}
+
+
+// Structs
+
+struct RoomTicker
+{
+    string  room_name;
+    string  username;
+    string  content;
+}
+
+struct UserStats
+{
+    bool  exists;
+    uint  upload_speed;
+    uint  shared_files;
+    uint  shared_folders;
+
+    bool  updating_speed;
+    bool  updating_shared;
+}
+
+
 // Terminal Colors
 
 enum norm                        = "\033[0m";        // reset to normal

src/server/cmdhandler.d

@@ -446,9 +446,8 @@ final class CommandHandler
         output ~= text("\nTickers (", tickers.length, "):");
 
         foreach (ref ticker ; tickers) {
-            const username = ticker[0], content = ticker[1];
-            output ~= text("\n    [", username, "] ");
-            output ~= content;
+            output ~= text("\n    [", ticker.username, "] ");
+            output ~= ticker.content;
         }
 
         return output[];
@@ -630,10 +629,10 @@ final class CommandHandler
         );
 
         if (tickers.length > 0) {
-            foreach (ticker ; tickers) {
-                const room_name = ticker[0], content = ticker[1];
-                output ~= text("\n        [", room_name, "] ", content);
-            }
+            foreach (ticker ; tickers)
+                output ~= text(
+                    "\n        [", ticker.room_name, "] ", ticker.content
+                );
         }
 
         return output[];
@@ -712,10 +711,10 @@ final class CommandHandler
         if (tickers.length > 0) {
             auto first = true;
             foreach (ticker ; tickers) {
-                const room_name = ticker[0], content = ticker[1];
                 if (!first) output ~= ",";
                 output ~= text(
-                    "\n            \"", room_name, "\": \"", content, "\""
+                    "\n            \"", ticker.room_name, "\": \"",
+                    ticker.content, "\""
                 );
                 first = false;
             }

src/server/messages.d

@@ -6,7 +6,7 @@
 module soulfind.server.messages;
 @safe:
 
-import soulfind.defines : blue, log_msg, norm;
+import soulfind.defines : blue, log_msg, norm, RoomTicker;
 import soulfind.server.user : User;
 import std.array : Appender;
 import std.bitmanip : Endian, nativeToLittleEndian, peek;
@@ -122,7 +122,7 @@ enum WishlistInterval             = 104;
 enum SimilarUsers                 = 110;
 enum ItemRecommendations          = 111;
 enum ItemSimilarUsers             = 112;
-enum RoomTicker                   = 113;
+enum RoomTickers                  = 113;
 enum RoomTickerAdd                = 114;
 enum RoomTickerRemove             = 115;
 enum SetRoomTicker                = 116;
@@ -1483,19 +1483,17 @@ final class SItemSimilarUsers : SMessage
     }
 }
 
-final class SRoomTicker : SMessage
+final class SRoomTickers : SMessage
 {
-    this(string room_name, string[][] tickers) scope
+    this(string room_name, RoomTicker[] tickers) scope
     {
-        super(RoomTicker);
+        super(RoomTickers);
 
         write!string(room_name);
         write!uint(cast(uint) tickers.length);
-        foreach (ref ticker ; tickers)
-        {
-            const username = ticker[0], content = ticker[1];
-            write!string(username);
-            write!string(content);
+        foreach (ref ticker ; tickers) {
+            write!string(ticker.username);
+            write!string(ticker.content);
         }
     }
 }

src/server/room.d

@@ -9,7 +9,7 @@ module soulfind.server.room;
 import soulfind.db : Sdb;
 import soulfind.defines : blue, log_msg, max_chat_message_length,
                           max_room_ticker_length, max_room_tickers, norm,
-                          RoomType;
+                          RoomTicker, RoomType;
 import soulfind.server.conns : Logging;
 import soulfind.server.messages;
 import soulfind.server.user : User;
@@ -59,7 +59,7 @@ final class Room
         scope join_room_msg = new SJoinRoom(
             name, users, db.get_room_owner(name), null
         );
-        scope tickers_msg = new SRoomTicker(name, tickers);
+        scope tickers_msg = new SRoomTickers(name, tickers);
 
         send_to_all(joined_room_msg);
         user.send_message(join_room_msg);
@@ -184,7 +184,7 @@ final class Room
         return db.get_ticker(name, username);
     }
 
-    private string[][] tickers()
+    private RoomTicker[] tickers()
     {
         return db.room_tickers(name);
     }

src/server/server.d

@@ -450,10 +450,8 @@ final class Server
                 room.del_ticker(username);
 
         // Stored rooms
-        foreach (ref ticker ; db.user_tickers!type(username)) {
-            const room_name = ticker[0];
-            db.del_ticker(room_name, username);
-        }
+        foreach (ref ticker ; db.user_tickers!type(username))
+            db.del_ticker(ticker.room_name, username);
     }
 
     Room get_room(string room_name)

src/server/user.d

@@ -6,13 +6,14 @@
 module soulfind.server.user;
 @safe:
 
-import soulfind.db : Sdb, SdbUserStats;
+import soulfind.db : Sdb;
 import soulfind.defines : blue, bold, log_user, login_timeout,
                           max_interest_length, max_room_name_length,
                           max_user_interests, max_username_length, norm,
                           pbkdf2_iterations, red, RoomMemberType, RoomType,
                           server_username, speed_weight, user_check_interval,
-                          VERSION, wish_interval, wish_interval_privileged;
+                          UserStats, VERSION, wish_interval,
+                          wish_interval_privileged;
 import soulfind.pwhash : create_salt, hash_password_async,
                          verify_password_async;
 import soulfind.server.conns : Logging, UserConnection;
@@ -420,7 +421,7 @@ final class User
         );
         server.send_to_watching(username, msg);
 
-        auto stats = SdbUserStats();
+        auto stats = UserStats();
         stats.upload_speed = upload_speed;
         stats.updating_speed = true;
 
@@ -432,7 +433,7 @@ final class User
         shared_files = new_files;
         shared_folders = new_folders;
 
-        auto stats = SdbUserStats();
+        auto stats = UserStats();
         stats.shared_files = new_files;
         stats.shared_folders = new_folders;
         stats.updating_shared = true;

src/setup/setup.d

@@ -602,10 +602,10 @@ final class Setup
         );
 
         if (tickers.length > 0) {
-            foreach (ticker ; tickers) {
-                const room_name = ticker[0], content = ticker[1];
-                output ~= text("\n\t   [", room_name, "] ", content);
-            }
+            foreach (ticker ; tickers)
+                output ~= text(
+                    "\n\t   [", ticker.room_name, "] ", ticker.content
+                );
         }
 
         writeln(output[]);
@@ -667,10 +667,10 @@ final class Setup
         if (tickers.length > 0) {
             auto first = true;
             foreach (ticker ; tickers) {
-                const room_name = ticker[0], content = ticker[1];
                 if (!first) output ~= ",";
                 output ~= text(
-                    "\n            \"", room_name, "\": \"", content, "\""
+                    "\n            \"", ticker.room_name, "\": \"",
+                    ticker.content, "\""
                 );
                 first = false;
             }