[#166] Add LIST Support

pydle/features/rfc1459/client.py

@@ -4,7 +4,7 @@
 import datetime
 import ipaddress
 import itertools
-
+import asyncio
 from pydle.client import BasicClient, NotInChannel, AlreadyInChannel
 from . import parsing, protocol
 
@@ -59,6 +59,24 @@ def _reset_attributes(self):
         self.channels = parsing.NormalizingDict(self.channels, case_mapping=self._case_mapping)
         self.users = parsing.NormalizingDict(self.users, case_mapping=self._case_mapping)
 
+        # List.
+        self.all_channels = []
+        self._list_client = []
+        self._list_channel = []
+        self._list_count = []
+        self._list_topic = []
+        self._list_query = asyncio.Queue()
+
+    async def channel_list(self):
+        await self.rawmsg("LIST")
+        future = asyncio.get_running_loop().create_future()
+        await self._list_query.put(future)
+        try:
+            await future
+            return self.all_channels
+        except asyncio.CancelledError:
+            pass
+
     def _reset_connection_attributes(self):
         super()._reset_connection_attributes()
         self.password = None
@@ -869,6 +887,41 @@ async def on_raw_319(self, message):
         if nickname in self._pending['whois']:
             self._whois_info[nickname].update(info)
 
+    async def on_raw_321(self, message):
+        """RPL_LISTSTART, an OPTIONAL indication a LIST is starting."""
+        ...
+
+    async def on_raw_322(self, message):
+        """RPL_LIST, the list of channels from the server"""
+        # The * channel doesn't exist but some IRCds return * as the server itself.
+        if message.params[1] != "*":
+            self._list_client.append(message.params[0])
+            self._list_channel.append(message.params[1])
+            self._list_count.append(message.params[2])
+            self._list_topic.append(message.params[3])
+
+    async def on_raw_323(self, message):
+        """RPL_LISTEND, end of the channel list"""
+        self.all_channels = []
+
+        for counter, channel in enumerate(self._list_channel):
+            channel_dict = {
+                "client": self._list_client[counter],
+                "channel": self._list_channel[counter],
+                "client_count": self._list_count[counter],
+                "topic": self._list_topic[counter],
+            }
+            self.all_channels.append(channel_dict)
+
+        # Clear the supporting lists
+        self._list_client.clear()
+        self._list_channel.clear()
+        self._list_count.clear()
+        self._list_topic.clear()
+        if not self._list_query.empty():
+            future = await self._list_query.get()
+            future.set_result(self.all_channels)
+
     async def on_raw_324(self, message):
         """ Channel mode. """
         target, channel = message.params[:2]