Skip to content

Commit 3086d9e

Browse files
authored
Rename protocol messages related to private rooms and tickers (#70)
The existing names have been vague and confusing for a long time. Improve naming while keeping it consistent with other protocol messages.
1 parent 63ce1b1 commit 3086d9e

File tree

6 files changed

+108
-110
lines changed

6 files changed

+108
-110
lines changed

src/db.d

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1018,7 +1018,7 @@ final class Database
10181018
return rooms[];
10191019
}
10201020

1021-
bool add_room_member(string room_name, string username)
1021+
bool grant_room_membership(string room_name, string username)
10221022
{
10231023
enum sql = text(
10241024
"INSERT OR IGNORE INTO ", room_members_table,
@@ -1037,7 +1037,7 @@ final class Database
10371037
return true;
10381038
}
10391039

1040-
bool del_room_member(string room_name, string username)
1040+
bool revoke_room_membership(string room_name, string username)
10411041
{
10421042
enum sql = text(
10431043
"DELETE FROM ", room_members_table,

src/server/messages.d

Lines changed: 63 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ enum SimilarUsers = 110;
123123
enum ItemRecommendations = 111;
124124
enum ItemSimilarUsers = 112;
125125
enum RoomTickers = 113;
126-
enum RoomTickerAdd = 114;
127-
enum RoomTickerRemove = 115;
126+
enum RoomTickerAdded = 114;
127+
enum RoomTickerRemoved = 115;
128128
enum SetRoomTicker = 116;
129129
enum AddThingIHate = 117;
130130
enum RemoveThingIHate = 118;
@@ -134,21 +134,21 @@ enum UserPrivileged = 122; // Obsolete
134134
enum GivePrivileges = 123;
135135
enum NotifyPrivileges = 124; // Obsolete
136136
enum AckNotifyPrivileges = 125; // Obsolete
137-
enum PrivateRoomUsers = 133;
138-
enum PrivateRoomAddUser = 134;
139-
enum PrivateRoomRemoveUser = 135;
140-
enum PrivateRoomCancelMembership = 136;
141-
enum PrivateRoomDisown = 137;
142-
enum PrivateRoomAdded = 139;
143-
enum PrivateRoomRemoved = 140;
144-
enum PrivateRoomToggle = 141;
137+
enum RoomMembers = 133;
138+
enum AddRoomMember = 134;
139+
enum RemoveRoomMember = 135;
140+
enum CancelRoomMembership = 136;
141+
enum CancelRoomOwnership = 137;
142+
enum RoomMembershipGranted = 139;
143+
enum RoomMembershipRevoked = 140;
144+
enum EnableRoomInvitations = 141;
145145
enum ChangePassword = 142;
146-
enum PrivateRoomAddOperator = 143;
147-
enum PrivateRoomRemoveOperator = 144;
148-
enum PrivateRoomOperatorAdded = 145;
149-
enum PrivateRoomOperatorRemoved = 146;
150-
enum PrivateRoomCancelOperatorship = 147;
151-
enum PrivateRoomOperators = 148;
146+
enum AddRoomOperator = 143;
147+
enum RemoveRoomOperator = 144;
148+
enum RoomOperatorshipGranted = 145;
149+
enum RoomOperatorshipRevoked = 146;
150+
enum CancelRoomOperatorship = 147;
151+
enum RoomOperators = 148;
152152
enum MessageUsers = 149;
153153
enum JoinGlobalRoom = 150;
154154
enum LeaveGlobalRoom = 151;
@@ -792,7 +792,7 @@ final class UNotifyPrivileges : UMessage
792792
}
793793
}
794794

795-
final class UPrivateRoomAddUser : UMessage
795+
final class UAddRoomMember : UMessage
796796
{
797797
string room_name;
798798
string username;
@@ -806,7 +806,7 @@ final class UPrivateRoomAddUser : UMessage
806806
}
807807
}
808808

809-
final class UPrivateRoomRemoveUser : UMessage
809+
final class URemoveRoomMember : UMessage
810810
{
811811
string room_name;
812812
string username;
@@ -820,7 +820,7 @@ final class UPrivateRoomRemoveUser : UMessage
820820
}
821821
}
822822

823-
final class UPrivateRoomCancelMembership : UMessage
823+
final class UCancelRoomMembership : UMessage
824824
{
825825
string room_name;
826826

@@ -832,7 +832,7 @@ final class UPrivateRoomCancelMembership : UMessage
832832
}
833833
}
834834

835-
final class UPrivateRoomDisown : UMessage
835+
final class UCancelRoomOwnership : UMessage
836836
{
837837
string room_name;
838838

@@ -844,7 +844,7 @@ final class UPrivateRoomDisown : UMessage
844844
}
845845
}
846846

847-
final class UPrivateRoomToggle : UMessage
847+
final class UEnableRoomInvitations : UMessage
848848
{
849849
bool enabled;
850850

@@ -868,7 +868,7 @@ final class UChangePassword : UMessage
868868
}
869869
}
870870

871-
final class UPrivateRoomAddOperator : UMessage
871+
final class UAddRoomOperator : UMessage
872872
{
873873
string room_name;
874874
string username;
@@ -882,7 +882,7 @@ final class UPrivateRoomAddOperator : UMessage
882882
}
883883
}
884884

885-
final class UPrivateRoomRemoveOperator : UMessage
885+
final class URemoveRoomOperator : UMessage
886886
{
887887
string room_name;
888888
string username;
@@ -896,7 +896,7 @@ final class UPrivateRoomRemoveOperator : UMessage
896896
}
897897
}
898898

899-
final class UPrivateRoomCancelOperatorship : UMessage
899+
final class UCancelRoomOperatorship : UMessage
900900
{
901901
string room_name;
902902

@@ -1095,9 +1095,9 @@ final class SSayChatroom : SMessage
10951095
final class SRoomList : SMessage
10961096
{
10971097
this(RoomInfo[] rooms,
1098-
RoomInfo[] owned_private_rooms,
1099-
RoomInfo[] other_private_rooms,
1100-
string[] operated_private_rooms) scope
1098+
RoomInfo[] rooms_owner,
1099+
RoomInfo[] rooms_member,
1100+
string[] rooms_operator) scope
11011101
{
11021102
super(RoomList);
11031103

@@ -1109,24 +1109,24 @@ final class SRoomList : SMessage
11091109
foreach (ref room ; rooms)
11101110
write!uint(room.num_users);
11111111

1112-
write!uint(cast(uint) owned_private_rooms.length);
1113-
foreach (ref room ; owned_private_rooms)
1112+
write!uint(cast(uint) rooms_owner.length);
1113+
foreach (ref room ; rooms_owner)
11141114
write!string(room.room_name);
11151115

1116-
write!uint(cast(uint) owned_private_rooms.length);
1117-
foreach (ref room ; owned_private_rooms)
1116+
write!uint(cast(uint) rooms_owner.length);
1117+
foreach (ref room ; rooms_owner)
11181118
write!uint(room.num_users);
11191119

1120-
write!uint(cast(uint) other_private_rooms.length);
1121-
foreach (ref room ; other_private_rooms)
1120+
write!uint(cast(uint) rooms_member.length);
1121+
foreach (ref room ; rooms_member)
11221122
write!string(room.room_name);
11231123

1124-
write!uint(cast(uint) other_private_rooms.length);
1125-
foreach (ref room ; other_private_rooms)
1124+
write!uint(cast(uint) rooms_member.length);
1125+
foreach (ref room ; rooms_member)
11261126
write!uint(room.num_users);
11271127

1128-
write!uint(cast(uint) operated_private_rooms.length);
1129-
foreach (ref room_name ; operated_private_rooms)
1128+
write!uint(cast(uint) rooms_operator.length);
1129+
foreach (ref room_name ; rooms_operator)
11301130
write!string(room_name);
11311131
}
11321132
}
@@ -1514,23 +1514,23 @@ final class SRoomTickers : SMessage
15141514
}
15151515
}
15161516

1517-
final class SRoomTickerAdd : SMessage
1517+
final class SRoomTickerAdded : SMessage
15181518
{
15191519
this(string room_name, string username, string ticker) scope
15201520
{
1521-
super(RoomTickerAdd);
1521+
super(RoomTickerAdded);
15221522

15231523
write!string(room_name);
15241524
write!string(username);
15251525
write!string(ticker);
15261526
}
15271527
}
15281528

1529-
final class SRoomTickerRemove : SMessage
1529+
final class SRoomTickerRemoved : SMessage
15301530
{
15311531
this(string room_name, string username) scope
15321532
{
1533-
super(RoomTickerRemove);
1533+
super(RoomTickerRemoved);
15341534

15351535
write!string(room_name);
15361536
write!string(username);
@@ -1558,65 +1558,65 @@ final class SAckNotifyPrivileges : SMessage
15581558
}
15591559
}
15601560

1561-
final class SPrivateRoomUsers : SMessage
1561+
final class SRoomMembers : SMessage
15621562
{
15631563
this(string room_name, string[] usernames) scope
15641564
{
1565-
super(PrivateRoomUsers);
1565+
super(RoomMembers);
15661566

15671567
write!string(room_name);
15681568
write!uint(cast(uint) usernames.length);
15691569
foreach (ref username ; usernames) write!string(username);
15701570
}
15711571
}
15721572

1573-
final class SPrivateRoomAddUser : SMessage
1573+
final class SAddRoomMember : SMessage
15741574
{
15751575
this(string room_name, string username) scope
15761576
{
1577-
super(PrivateRoomAddUser);
1577+
super(AddRoomMember);
15781578

15791579
write!string(room_name);
15801580
write!string(username);
15811581
}
15821582
}
15831583

1584-
final class SPrivateRoomRemoveUser : SMessage
1584+
final class SRemoveRoomMember : SMessage
15851585
{
15861586
this(string room_name, string username) scope
15871587
{
1588-
super(PrivateRoomRemoveUser);
1588+
super(RemoveRoomMember);
15891589

15901590
write!string(room_name);
15911591
write!string(username);
15921592
}
15931593
}
15941594

1595-
final class SPrivateRoomAdded : SMessage
1595+
final class SRoomMembershipGranted : SMessage
15961596
{
15971597
this(string room_name) scope
15981598
{
1599-
super(PrivateRoomAdded);
1599+
super(RoomMembershipGranted);
16001600

16011601
write!string(room_name);
16021602
}
16031603
}
16041604

1605-
final class SPrivateRoomRemoved : SMessage
1605+
final class SRoomMembershipRevoked : SMessage
16061606
{
16071607
this(string room_name) scope
16081608
{
1609-
super(PrivateRoomRemoved);
1609+
super(RoomMembershipRevoked);
16101610

16111611
write!string(room_name);
16121612
}
16131613
}
16141614

1615-
final class SPrivateRoomToggle : SMessage
1615+
final class SEnableRoomInvitations : SMessage
16161616
{
16171617
this(bool enabled) scope
16181618
{
1619-
super(PrivateRoomToggle);
1619+
super(EnableRoomInvitations);
16201620

16211621
write!bool(enabled);
16221622
}
@@ -1632,53 +1632,53 @@ final class SChangePassword : SMessage
16321632
}
16331633
}
16341634

1635-
final class SPrivateRoomAddOperator : SMessage
1635+
final class SAddRoomOperator : SMessage
16361636
{
16371637
this(string room_name, string username) scope
16381638
{
1639-
super(PrivateRoomAddOperator);
1639+
super(AddRoomOperator);
16401640

16411641
write!string(room_name);
16421642
write!string(username);
16431643
}
16441644
}
16451645

1646-
final class SPrivateRoomRemoveOperator : SMessage
1646+
final class SRemoveRoomOperator : SMessage
16471647
{
16481648
this(string room_name, string username) scope
16491649
{
1650-
super(PrivateRoomRemoveOperator);
1650+
super(RemoveRoomOperator);
16511651

16521652
write!string(room_name);
16531653
write!string(username);
16541654
}
16551655
}
16561656

1657-
final class SPrivateRoomOperatorAdded : SMessage
1657+
final class SRoomOperatorshipGranted : SMessage
16581658
{
16591659
this(string room_name) scope
16601660
{
1661-
super(PrivateRoomOperatorAdded);
1661+
super(RoomOperatorshipGranted);
16621662

16631663
write!string(room_name);
16641664
}
16651665
}
16661666

1667-
final class SPrivateRoomOperatorRemoved : SMessage
1667+
final class SRoomOperatorshipRevoked : SMessage
16681668
{
16691669
this(string room_name) scope
16701670
{
1671-
super(PrivateRoomOperatorRemoved);
1671+
super(RoomOperatorshipRevoked);
16721672

16731673
write!string(room_name);
16741674
}
16751675
}
16761676

1677-
final class SPrivateRoomOperators : SMessage
1677+
final class SRoomOperators : SMessage
16781678
{
16791679
this(string room_name, string[] usernames) scope
16801680
{
1681-
super(PrivateRoomOperators);
1681+
super(RoomOperators);
16821682

16831683
write!string(room_name);
16841684
write!uint(cast(uint) usernames.length);

0 commit comments

Comments
 (0)