861 lines
52 KiB
XML
861 lines
52 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.3.1">Jekyll</generator><link href="https://moxxy.org/feed.xml" rel="self" type="application/atom+xml" /><link href="https://moxxy.org/" rel="alternate" type="text/html" /><updated>2024-01-01T01:08:20+01:00</updated><id>https://moxxy.org/feed.xml</id><title type="html">Moxxy</title><entry><title type="html">GSoC report - Moxxy MUC implementation</title><link href="https://moxxy.org/posts/2023-08-20-Moxxy-MUC-GSoC-Final-Report.html" rel="alternate" type="text/html" title="GSoC report - Moxxy MUC implementation" /><published>2023-08-20T00:00:00+02:00</published><updated>2023-08-20T00:00:00+02:00</updated><id>https://moxxy.org/posts/Moxxy-MUC-GSoC-Final-Report</id><content type="html" xml:base="https://moxxy.org/posts/2023-08-20-Moxxy-MUC-GSoC-Final-Report.html"><h1 id="gsoc-final-report-xmpp-standards-foundation---moxxy-implement-group-chats">GSoC Final Report: XMPP Standards Foundation - Moxxy: Implement Group Chats</h1>
|
|||
|
|
|
|||
|
|
<p><strong>Project:</strong> Moxxy - Implement Group Chats<br />
|
|||
|
|
<strong>Organization:</strong> XMPP Standards Foundation<br />
|
|||
|
|
<strong>Duration:</strong> March 2023 - August 2023<br />
|
|||
|
|
<strong>Student:</strong> Ikjot Singh Dhody<br />
|
|||
|
|
<strong>Mentor:</strong> Alexander</p>
|
|||
|
|
|
|||
|
|
<h2 id="introduction">Introduction</h2>
|
|||
|
|
|
|||
|
|
<p>This report presents the culmination of my work on the GSoC project “Moxxy: Implement Group Chats” under the mentorship of Alexander at the XMPP Standards Foundation. Over the course of this project, I have been engaged in implementing a group chat feature for the Moxxy application, aiming to enhance its functionality and user experience.</p>
|
|||
|
|
|
|||
|
|
<h2 id="about-me">About Me</h2>
|
|||
|
|
|
|||
|
|
<h3 id="personal-and-socialcontact-details">Personal and Social/Contact Details</h3>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li><strong>Name:</strong> Ikjot Singh Dhody</li>
|
|||
|
|
<li><strong>Jabber ID:</strong> ikjot-2605[at]jabber.fr</li>
|
|||
|
|
<li><strong>Email:</strong> ikjotsd[at]gmail.com</li>
|
|||
|
|
<li><strong>GitHub:</strong> <a href="https://github.com/ikjot-2605">ikjot-2605</a></li>
|
|||
|
|
<li><strong>LinkedIn:</strong> <a href="https://www.linkedin.com/in/ikjotsd/">LinkedIn Profile</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h3 id="educational-background">Educational Background</h3>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li><strong>University:</strong> National Institute of Technology Karnataka, Surathkal</li>
|
|||
|
|
<li><strong>Major:</strong> Computer Science and Engineering</li>
|
|||
|
|
<li><strong>Year:</strong> Senior Year</li>
|
|||
|
|
<li><strong>Degree:</strong> Bachelor of Technology (B. Tech)</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h2 id="the-project">The Project</h2>
|
|||
|
|
<p>Before getting into the details of the actual project - here is a demo screencast for the implementation:</p>
|
|||
|
|
|
|||
|
|
<p><img src="../assets/img/moxxy-muc-demo.gif" alt="" /></p>
|
|||
|
|
|
|||
|
|
<p>I have outlined the features I implemented through the GSoC period below.</p>
|
|||
|
|
<h3 id="prs-merged">PRs merged</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li>moxxmpp
|
|||
|
|
<ol>
|
|||
|
|
<li><a href="https://codeberg.org/moxxy/moxxmpp/pulls/45">Add support for XEP-0421</a></li>
|
|||
|
|
<li><a href="https://codeberg.org/moxxy/moxxmpp/pulls/46">Implement XEP-0045 support in moxxmpp</a></li>
|
|||
|
|
</ol>
|
|||
|
|
</li>
|
|||
|
|
<li>Moxxy
|
|||
|
|
<ol>
|
|||
|
|
<li><a href="https://codeberg.org/moxxy/moxxy/pulls/300">Add groupchat support for Moxxy</a></li>
|
|||
|
|
</ol>
|
|||
|
|
</li>
|
|||
|
|
<li>website (blog)
|
|||
|
|
<ol>
|
|||
|
|
<li><a href="https://codeberg.org/moxxy/website/pulls/2">Add blog for GSoC MUC project introduction.</a></li>
|
|||
|
|
<li><a href="https://codeberg.org/moxxy/website/pulls/3">Blog for XEP 0045 support in Moxxmpp</a></li>
|
|||
|
|
<li><a href="https://codeberg.org/moxxy/website/pulls/4"> New blog - Join an MUC with Moxxy!</a></li>
|
|||
|
|
<li><a href="https://codeberg.org/moxxy/website/pulls/5">Final GSoC Report Blog</a>
|
|||
|
|
<h3 id="feature-use-cases">Feature Use-Cases</h3>
|
|||
|
|
</li>
|
|||
|
|
</ol>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<p>The group chat feature required changes to the Moxxy codebase, as well as the moxxmpp codebase. Moxxmpp is the data worker that sends and maintains all the request requirements of the Moxxy frontend. These are the list of contributions across both projects:</p>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>Joining rooms and getting disco info for the room.</li>
|
|||
|
|
<li>Sending messages to a group chat and receiving messages from the group chat.</li>
|
|||
|
|
<li>Leaving the group chat.</li>
|
|||
|
|
<li>Displaying a UI for joining a group chat and providing a nickname.</li>
|
|||
|
|
<li>Handling group chat details and database support.</li>
|
|||
|
|
<li>Handling group chat errors and basic error handling.</li>
|
|||
|
|
<li>Adding a GroupchatDetails model.</li>
|
|||
|
|
<li>Adding UI elements for group chat, such as title and nickname fields.</li>
|
|||
|
|
<li>Adding documentation to group chat service methods.</li>
|
|||
|
|
<li>Minor code refactoring and naming enhancements.</li>
|
|||
|
|
<li>Enhancing enums for conversation types.</li>
|
|||
|
|
<li>Removing unnecessary translation strings.</li>
|
|||
|
|
<li>Improving UI and formatting.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<p>Outlined below are commits made across both codebases throughout the GSoC period.</p>
|
|||
|
|
|
|||
|
|
<h4 id="moxxmpp">Moxxmpp</h4>
|
|||
|
|
|
|||
|
|
<p>There were 2 PRs merged for this codebase.</p>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>XEP-0421 support for occupant ID support.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<table>
|
|||
|
|
<thead>
|
|||
|
|
<tr>
|
|||
|
|
<th>Serial Number</th>
|
|||
|
|
<th>Commit Hash</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr>
|
|||
|
|
<td>1</td>
|
|||
|
|
<td>255d0f88e0</td>
|
|||
|
|
<td>feat(xep): Use cascading operation to return state</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>2</td>
|
|||
|
|
<td>fa11a3a384</td>
|
|||
|
|
<td>feat(xep): Checked for the occupant-id directly.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>3</td>
|
|||
|
|
<td>ac5bb9e461</td>
|
|||
|
|
<td>feat(xep): Implement XEP 0421 in Moxxmpp.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>XEP-0045 support for MUC support.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<table>
|
|||
|
|
<thead>
|
|||
|
|
<tr>
|
|||
|
|
<th>Serial Number</th>
|
|||
|
|
<th>Commit Hash</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr>
|
|||
|
|
<td>1</td>
|
|||
|
|
<td>b2724aba0c</td>
|
|||
|
|
<td>Merge branch ‘master’ into xep_0045</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>2</td>
|
|||
|
|
<td>d3742ea156</td>
|
|||
|
|
<td>feat(xep): Small fixes - MUC Example.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>3</td>
|
|||
|
|
<td>8b00e85167</td>
|
|||
|
|
<td>feat(xep): Add example for XEP 0045 Moxxmpp.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>4</td>
|
|||
|
|
<td>04dfc6d2ac</td>
|
|||
|
|
<td>feat(xep): Replace DiscoError with StanzaError.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>5</td>
|
|||
|
|
<td>9e70e802ef</td>
|
|||
|
|
<td>Merge branch ‘master’ into xep_0045</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>6</td>
|
|||
|
|
<td>3ebd9b86ec</td>
|
|||
|
|
<td>feat(xep): Fix lint issues and use moxlib for result.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>7</td>
|
|||
|
|
<td>a873edb9ec</td>
|
|||
|
|
<td>feat(xep): Check for null nick before leaveRoom.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>8</td>
|
|||
|
|
<td>e6bd6d05cd</td>
|
|||
|
|
<td>feat(xep): Remove NOOP cache access.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>9</td>
|
|||
|
|
<td>b7d53b8f47</td>
|
|||
|
|
<td>feat(xep): Add docstings for the XEP-0045 routines</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>10</td>
|
|||
|
|
<td>217c3ac236</td>
|
|||
|
|
<td>feat(xep): Fix cache issue with join/leaveRoom.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>11</td>
|
|||
|
|
<td>51bca6c25d</td>
|
|||
|
|
<td>feat(xep): XEP-0045 cache fixes.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>12</td>
|
|||
|
|
<td>8728166a4d</td>
|
|||
|
|
<td>feat(xep): Add cache and roomstate to MUC implementation.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>13</td>
|
|||
|
|
<td>1f1321b269</td>
|
|||
|
|
<td>feat(xep): Small fixes - review cycle 1.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>14</td>
|
|||
|
|
<td>66195f66fa</td>
|
|||
|
|
<td>Merge branch ‘master’ into xep_0045</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>15</td>
|
|||
|
|
<td>70fdfaf16d</td>
|
|||
|
|
<td>feat(xep): Fix imports for xep_0045 files.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>16</td>
|
|||
|
|
<td>cd73f89e63</td>
|
|||
|
|
<td>feat(xep): Remove duplicate manager string</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>17</td>
|
|||
|
|
<td>05c41d3185</td>
|
|||
|
|
<td>feat(xep): Refactor sendMessage to allow groupchat</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>18</td>
|
|||
|
|
<td>64a8de6caa</td>
|
|||
|
|
<td>feat(xep): Set base for XEP 0045 implementation</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>19</td>
|
|||
|
|
<td>68809469f6</td>
|
|||
|
|
<td>feat(xep): Add joinRoom, leaveRoom routines.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>20</td>
|
|||
|
|
<td>762cf1c77a</td>
|
|||
|
|
<td>feat(xep): Set base for XEP 0045 implementation</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
<h4 id="moxxy">Moxxy</h4>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>Implement MUCs in Moxxy</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<table>
|
|||
|
|
<thead>
|
|||
|
|
<tr>
|
|||
|
|
<th>Serial Number</th>
|
|||
|
|
<th>Commit Hash</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr>
|
|||
|
|
<td>1</td>
|
|||
|
|
<td>549e61a168</td>
|
|||
|
|
<td>feat(all): Fix linter issues.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>2</td>
|
|||
|
|
<td>26bcaccd81</td>
|
|||
|
|
<td>Merge branch ‘master’ into feat/groupchat</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>3</td>
|
|||
|
|
<td>df5810a347</td>
|
|||
|
|
<td>feat(all): Formatting change, lock file update</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>4</td>
|
|||
|
|
<td>ef931c566f</td>
|
|||
|
|
<td>feat(all): Send messages/chat state from Moxxy to MUC.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>5</td>
|
|||
|
|
<td>a3d4883406</td>
|
|||
|
|
<td>feat(all): Remove unnecessary buttons/options for MUC.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>6</td>
|
|||
|
|
<td>532f0b1bb2</td>
|
|||
|
|
<td>feat(all): Formatting fix, and navigation fix.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>7</td>
|
|||
|
|
<td>a98fe0d9f3</td>
|
|||
|
|
<td>feat(all): Minor fixes - strings, formatting.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>8</td>
|
|||
|
|
<td>a7c3bd507f</td>
|
|||
|
|
<td>Merge branch ‘master’ of https://codeberg.org/moxxy/moxxy into feat/groupchat</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>9</td>
|
|||
|
|
<td>fba2cf86ae</td>
|
|||
|
|
<td>feat(all): Minor formatting changes.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>10</td>
|
|||
|
|
<td>af481bf465</td>
|
|||
|
|
<td>feat(all): remove unnecessary comparator override.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>11</td>
|
|||
|
|
<td>e6ae8182c2</td>
|
|||
|
|
<td>feat(all): Organize import in main.dart.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>12</td>
|
|||
|
|
<td>de7b9adfa6</td>
|
|||
|
|
<td>feat(all): Fix user flow for joining MUC.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>13</td>
|
|||
|
|
<td>e4f98bb82f</td>
|
|||
|
|
<td>feat(all): Add label to nick text field.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>14</td>
|
|||
|
|
<td>56d6f97168</td>
|
|||
|
|
<td>feat(all): Minor changes, fixes.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>15</td>
|
|||
|
|
<td>b0067f055f</td>
|
|||
|
|
<td>feat(all): Move away from exception type design.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>16</td>
|
|||
|
|
<td>bd094dfc9a</td>
|
|||
|
|
<td>feat(all): Remove unnecessary function.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>17</td>
|
|||
|
|
<td>7e9d7d6281</td>
|
|||
|
|
<td>feat(all): Check if Groupchat exists before method.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>18</td>
|
|||
|
|
<td>2cf781459d</td>
|
|||
|
|
<td>feat(all): Debug mode and translatable string</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>19</td>
|
|||
|
|
<td>4ff9e3c81e</td>
|
|||
|
|
<td>feat(all): Remove title from GroupchatDetails.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>20</td>
|
|||
|
|
<td>e337f1c579</td>
|
|||
|
|
<td>feat(all): Minor refactors - naming.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>21</td>
|
|||
|
|
<td>7c840334e1</td>
|
|||
|
|
<td>feat(all): Add docs to groupchat service methods.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>22</td>
|
|||
|
|
<td>06eab1d6f5</td>
|
|||
|
|
<td>feat(all): Make ConversationType an enhanced enum.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>23</td>
|
|||
|
|
<td>008e816d70</td>
|
|||
|
|
<td>feat(all): Rename JoinGroupchatResultEvent.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>24</td>
|
|||
|
|
<td>2bbbc164b5</td>
|
|||
|
|
<td>feat(all): Remove incorrect translations.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>25</td>
|
|||
|
|
<td>11f4fd9932</td>
|
|||
|
|
<td>feat(all): Add title to GroupchatDetails.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>26</td>
|
|||
|
|
<td>a1451c6fbf</td>
|
|||
|
|
<td>feat(all): Refactor groupchat to new object in db.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>27</td>
|
|||
|
|
<td>993da40297</td>
|
|||
|
|
<td>feat(all): Complete join groupchat flow.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>28</td>
|
|||
|
|
<td>09684b1268</td>
|
|||
|
|
<td>feat(all): Fix fromDatabaseJson for MUC details.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>29</td>
|
|||
|
|
<td>0abb89cf38</td>
|
|||
|
|
<td>feat(all): Fix database issues with nick.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>30</td>
|
|||
|
|
<td>7880f51b76</td>
|
|||
|
|
<td>feat(all): Add db support for GroupchatDetails.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>31</td>
|
|||
|
|
<td>f0a79ca0e0</td>
|
|||
|
|
<td>feat(all): Add GroupchatDetails model.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>32</td>
|
|||
|
|
<td>06dcd5491b</td>
|
|||
|
|
<td>feat(all): Basic groupchat error handling set up.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>33</td>
|
|||
|
|
<td>3641be4f56</td>
|
|||
|
|
<td>feat(all): Join room functionality complete.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>34</td>
|
|||
|
|
<td>18e28c3bbf</td>
|
|||
|
|
<td>feat(all): Groupchat service/bloc updated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>35</td>
|
|||
|
|
<td>62e39bf066</td>
|
|||
|
|
<td>feat(all): Set base for groupchat implementation.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
<h2 id="accomplishments">Accomplishments</h2>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p>Was able to produce a working model of groupchats in Moxxy.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Started the design approach from scratch and pretty much stuck to it till the end gave me confidence in my design capability.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Fruitful discussions and review cycles were conducted that allowed for a smooth GSoC experience.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h2 id="challenges-faced">Challenges Faced</h2>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p>Needed to understand 2 different codebases, and the architecture of the project. This was a pretty interesting, albeit challenging task that took me a while to master.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Managing the busy schedule with GSoC work, family, college among other things was difficult. Also, managing a job in the latter parts was also challenging but a rewarding experience.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>The complete virtual approach was slightly difficult, and although not practical - it might have been slightly better with inter-GSoC meetings.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h2 id="learningstakeaways">Learnings/Takeaways</h2>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>Implemented group chat (Multi-User Chat or MUC) support in the Moxxy project.</li>
|
|||
|
|
<li>Successfully added features for joining a group chat room, sending messages to the room, and receiving messages from the room.</li>
|
|||
|
|
<li>Learned to handle various aspects of XMPP communication, including sending and receiving messages, and interacting with group chat services.</li>
|
|||
|
|
<li>Gained insights into implementing complex functionality in a Flutter application, involving UI components, service classes, and database interactions.</li>
|
|||
|
|
<li>Collaborated with experienced developers through code reviews to improve code quality and ensure adherence to best practices.</li>
|
|||
|
|
<li>Acquired knowledge of working with the XMPP protocol, understanding its intricacies and how it relates to group chat interactions.</li>
|
|||
|
|
<li>Learned to manage and address feedback from code reviewers, making necessary adjustments to improve code readability and functionality.</li>
|
|||
|
|
<li>Discovered the importance of proper error handling in real-time communication scenarios, such as handling different types of group chat errors.</li>
|
|||
|
|
<li>Gained experience in integrating new features while maintaining the overall architecture and user experience of the application.</li>
|
|||
|
|
<li>Understood the complexities of XMPP server behavior, including handling discussion history and preventing message loops.</li>
|
|||
|
|
<li>Explored techniques for optimizing communication performance, such as preventing redundant message processing.</li>
|
|||
|
|
<li>Improved skills in project management, including version control practices, managing branches, and resolving merge conflicts.</li>
|
|||
|
|
<li>Gained familiarity with the process of creating, testing, and merging pull requests in a collaborative development environment.</li>
|
|||
|
|
<li>Developed a better understanding of Flutter’s state management, navigation, and widget composition for creating feature-rich user interfaces.</li>
|
|||
|
|
<li>Learned to balance feature development with code quality, addressing both functional and non-functional aspects of the implementation.</li>
|
|||
|
|
<li>Explored advanced Flutter topics, such as handling asynchronous operations, managing state, and integrating with external libraries.</li>
|
|||
|
|
<li>Gained a deeper understanding of how group chat and real-time communication play a significant role in modern applications.</li>
|
|||
|
|
<li>Developed the ability to diagnose and troubleshoot issues related to communication and user interface interactions.</li>
|
|||
|
|
<li>Strengthened communication skills by participating in technical discussions and effectively conveying ideas and solutions.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h2 id="future-work">Future Work</h2>
|
|||
|
|
|
|||
|
|
<p>The future remaining work has been enlisted in this issue by my mentor <a href="https://codeberg.org/moxxy/moxxy/issues/315">here</a>.</p>
|
|||
|
|
|
|||
|
|
<p>This includes a list of improvements, bug fixes and general future requirements that will be needed to make the groupchat experience pleasurable for the users of Moxxy.</p>
|
|||
|
|
|
|||
|
|
<h2 id="conclusion">Conclusion</h2>
|
|||
|
|
|
|||
|
|
<p>Participating in GSoC has been an enriching experience. I’ve learned valuable skills, collaborated with mentors and the open-source community, and contributed to the Moxxy project. I’m grateful to XMPP Standards Foundation for this opportunity and look forward to continuing my journey in the world of open-source software development.</p>
|
|||
|
|
|
|||
|
|
<h2 id="acknowledgments">Acknowledgments</h2>
|
|||
|
|
|
|||
|
|
<p>I would like to express my gratitude to my mentor Alexander for their guidance and support throughout this project. His guidance and understanding is what allowed me to pull through and complete the GSoC with a happy mind. I also want to thank the XMPP Standards Foundation community for their encouragement and feedback.</p></content><author><name>Ikjot Singh Dhody</name></author><summary type="html">GSoC Final Report: XMPP Standards Foundation - Moxxy: Implement Group Chats</summary></entry><entry><title type="html">Joining an MUC with Moxxy!</title><link href="https://moxxy.org/posts/2023-07-24-Join-MUC-With-Moxxy.html" rel="alternate" type="text/html" title="Joining an MUC with Moxxy!" /><published>2023-07-24T00:00:00+02:00</published><updated>2023-07-24T00:00:00+02:00</updated><id>https://moxxy.org/posts/Join-MUC-With%20Moxxy</id><content type="html" xml:base="https://moxxy.org/posts/2023-07-24-Join-MUC-With-Moxxy.html"><p>Greetings, readers!</p>
|
|||
|
|
|
|||
|
|
<p>Welcome back to our series of blogs on the Google Summer of Code (GSoC) project. In this blog post, I’ll be sharing the progress made in implementing Multi-User Chat (MUC) support in Moxxy, the frontend counterpart to my GSoC project.</p>
|
|||
|
|
|
|||
|
|
<h2 id="introduction">Introduction</h2>
|
|||
|
|
|
|||
|
|
<p>As you may recall, Moxxy is a frontend application developed as an innovative XMPP client. To enhance its functionality, my GSoC project focuses on adding MUC support. Before diving into the Moxxy implementation, it was crucial to establish the necessary MUC support in Moxxmpp, which is highlighted in <a href="https://moxxy.org/posts/2023-06-17-XEP-0045-In-Moxxmpp.html">this</a> blog.</p>
|
|||
|
|
|
|||
|
|
<p>Currently, the implementation progress is to allow users to join an MUC through Moxxy, and view incoming live messages in the chat.</p>
|
|||
|
|
|
|||
|
|
<h2 id="design-plan-for-muc-support-in-moxxy">Design Plan for MUC Support in Moxxy</h2>
|
|||
|
|
|
|||
|
|
<p>To implement MUC support in Moxxy, we need to extend its functionality and introduce new components. Let’s outline the design plan for the MUC feature:</p>
|
|||
|
|
|
|||
|
|
<h3 id="new-page">New Page</h3>
|
|||
|
|
|
|||
|
|
<h4 id="joingroupchatpage">JoinGroupchatPage</h4>
|
|||
|
|
|
|||
|
|
<p>This page will contain just 1 text field - for the nickname that the user wants to join with. It also has a button that allows us to join the MUC with said nickname. It is an additional route to the current StartChat page, if the user selects that they want to join a groupchat.</p>
|
|||
|
|
|
|||
|
|
<h3 id="new-command">New Command</h3>
|
|||
|
|
|
|||
|
|
<h4 id="joingroupchatcommand">JoinGroupchatCommand</h4>
|
|||
|
|
|
|||
|
|
<p>This command is sent to the data layer worker (separate thread) from the UI, when the user clicks on the join groupchat button on the new join groupchat page. It contains information about the JID and the nick that the user tried to join with. This will only be sent to the worker thread if the input validations are cleared.</p>
|
|||
|
|
|
|||
|
|
<h3 id="new-event">New Event</h3>
|
|||
|
|
|
|||
|
|
<h4 id="joingroupchatresult">JoinGroupchatResult</h4>
|
|||
|
|
|
|||
|
|
<p>This event is sent back as a result of the JoinGroupchatCommand. Based on whether the request succeeded or failed, it will return the new Conversation object that has just been created.</p>
|
|||
|
|
|
|||
|
|
<h3 id="database-changes">Database changes</h3>
|
|||
|
|
|
|||
|
|
<h4 id="groupchatdetails-table">GroupchatDetails table</h4>
|
|||
|
|
|
|||
|
|
<p>Add a new GrouchatDetails table to the database containing two data items - the jid and the nick. The main reason to have a separate table for the groupchat details, instead of to just have a new nick item in the Conversation table - was to maintain the single responsibility principle.</p>
|
|||
|
|
|
|||
|
|
<p>When the user fetches a conversation of type groupchat from the database, a separate call will be made that fetches the relevant groupchat details from this new table, and attaches it to the Conversation object.</p>
|
|||
|
|
|
|||
|
|
<h3 id="miscellaneous-changes">Miscellaneous changes</h3>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p>Changed the external helpers for the ConversationType to an enhanced enum. This allows us to include the functions within the enum.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>The MUCManager was added to the list of registered managers for Moxxy. Not only this, the OccupantIdManager was also registered which will allow for the unique occupant identification moving forward. This will be required for message reactions/retractions in an MUC.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h3 id="new-service">New Service</h3>
|
|||
|
|
|
|||
|
|
<h4 id="groupchatservice">GroupchatService</h4>
|
|||
|
|
<p>Added a new GroupchatService that allows for the following functions:</p>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li><strong>getRoomInformation</strong>: Sends a request to moxxmpp to receive disco info about the MUC.</li>
|
|||
|
|
<li><strong>joinRoom</strong>: Sends a request to moxxmpp to join the MUC if it’s not password protected.</li>
|
|||
|
|
<li><strong>addGroupchatDetailsFromData</strong>: Adds a new GroupchatDetails object to the database table.</li>
|
|||
|
|
<li><strong>getGroupchatDetailsByJid</strong>: Fetches the GroupchatDetails from the database based on the JID provided. This is required as a separate step while fetching an MUC conversation since the Conversations and GroupchatDetails table are decoupled.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h3 id="handling-errors">Handling Errors</h3>
|
|||
|
|
|
|||
|
|
<p>To prevent avoidable errors, Moxxy performs frontend checks when joining a room. These checks include ensuring to validate the JID input field, and checking for empty nicknames.</p>
|
|||
|
|
|
|||
|
|
<p>Possible errors that users may encounter during the MUC workflow include invalid or already in use nicknames, disallowed registration, invalid stanza format, and invalid disco info response. Moxxy will handle these errors gracefully.</p>
|
|||
|
|
|
|||
|
|
<h2 id="challenges-and-considerations">Challenges and Considerations</h2>
|
|||
|
|
|
|||
|
|
<p>Here is an enumeration of the possible challenges that we could face in the future implementation, and the ones I faced in the current implementation as well:</p>
|
|||
|
|
|
|||
|
|
<ol>
|
|||
|
|
<li>
|
|||
|
|
<p>Differentiating Messages from Oneself: Moxxy/Moxxmpp need to distinguish between messages from other users and self-echoed messages. To address this, Moxxy uses the origin ID of the message. If the origin ID of the response matches the sent origin ID, the message is ignored and not displayed in the UI.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Handling Impersonation in Anonymous MUCs: In anonymous MUCs, users can impersonate others by reusing their nicknames after leaving. To tackle this, Moxxmpp leverages the occupant ID, as described in XEP-0421. Each user joining the group receives a unique occupant ID, which helps track message origins accurately.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>Managing Discussion History on Rejoining: When a user rejoins an MUC, the room history is resent, including errors, self-presence with status code, room history, room subject, and live message/presence updates. To prevent appending duplicate history to the UI, Moxxy/Moxxmpp will have to wait until it receives the room subject before listening for message stanzas.</p>
|
|||
|
|
</li>
|
|||
|
|
</ol>
|
|||
|
|
|
|||
|
|
<h2 id="conclusion-and-future-work">Conclusion and Future Work</h2>
|
|||
|
|
|
|||
|
|
<p>In this blog post, we explored the implementation plan for adding MUC support, specifically XEP-0045, to Moxxy. Moxxmpp serves as the backbone for Moxxy’s XMPP functionality, handling communication between the client and XMPP server. We discussed the directory structure, and key routines required for MUC support in Moxxmpp. Additionally, we addressed various challenges and considerations related to MUC features.</p>
|
|||
|
|
|
|||
|
|
<p>The implementation process has already commenced, with a pull request (PR) underway. Once the PR is complete, Moxxy will support joining a groupchat and listening to live messages. In further PRs, sending messages and leaving the MUC will be supported as well. The addition of MUC support will empower Moxxy users to enjoy enhanced collaboration and communication within XMPP group chats.</p>
|
|||
|
|
|
|||
|
|
<p>Stay tuned for future updates on the progress of MUC support in Moxxy. Until then, happy chatting!</p></content><author><name>Ikjot Singh Dhody</name></author><summary type="html">Greetings, readers!</summary></entry><entry><title type="html">XEP-0045 implementation in Moxxmpp</title><link href="https://moxxy.org/posts/2023-06-17-XEP-0045-In-Moxxmpp.html" rel="alternate" type="text/html" title="XEP-0045 implementation in Moxxmpp" /><published>2023-06-17T00:00:00+02:00</published><updated>2023-06-17T00:00:00+02:00</updated><id>https://moxxy.org/posts/XEP-0045-In-Moxxmpp</id><content type="html" xml:base="https://moxxy.org/posts/2023-06-17-XEP-0045-In-Moxxmpp.html"><p>Hello readers!</p>
|
|||
|
|
|
|||
|
|
<p>Welcome back to the GSoC series of blogs. This one is about my implementation of the MUC XEP (XEP-0045) in Moxxmpp.</p>
|
|||
|
|
|
|||
|
|
<h2 id="introduction">Introduction</h2>
|
|||
|
|
|
|||
|
|
<p>Well, as you probably know, Moxxy is the frontend app that is being developed as a modern new XMPP client.</p>
|
|||
|
|
|
|||
|
|
<p>Moxxmpp is a Dart package that is used by Moxxy for multiple XMPP services. Essentially, the conversation between Moxxy and the XMPP server is handled by Moxxmpp. It is like the middleman that helps ease the communication between the two, keeping Moxxy code clean and free from the intricacies it handles.</p>
|
|||
|
|
|
|||
|
|
<p>Since my GSoC project is all about adding MUC support to Moxxy, it was essential to first add the required support in Moxxmpp before proceeding to Moxxy. This blog will give you an idea of what the responsibilities of Moxxmpp are, and why it was important to separate it from Moxxy.</p>
|
|||
|
|
|
|||
|
|
<h2 id="what-is-moxxmpp">What is Moxxmpp?</h2>
|
|||
|
|
|
|||
|
|
<p>In the words of it’s developer, Moxxmpp is “a pure-Dart XMPP library”. Moxxmpp could be thought of as the backbone of Moxxy. The entire communication/networking part of Moxxy, i.e. how it (as a client) communicates with the user’s XMPP server is outsourced to this Dart library.</p>
|
|||
|
|
|
|||
|
|
<p>Not only this, used as per it’s rules - Moxxmpp could be used by any client to perform XMPP tasks that are currently supported by it. It is a re-usable and versatile XMPP library.</p>
|
|||
|
|
|
|||
|
|
<p>Listed below are some of it’s core responsibilities:</p>
|
|||
|
|
<ol>
|
|||
|
|
<li>Establishing the connection between the client and the XMPP server via the user’s JID and password.</li>
|
|||
|
|
<li>Allowing Moxxy/any front-end client to register managers that provide support for a particular XEP/part of the XMPP flow. For example: the messaging service is handled by a MessageManager.
|
|||
|
|
Similarly here are some other managers with their use:
|
|||
|
|
<ol>
|
|||
|
|
<li>PresenceManager: Handling the presence related stanzas/use.</li>
|
|||
|
|
<li>PubSubManager: Provides support for XEP-0060.</li>
|
|||
|
|
<li>DiscoManager: Provides support for the service discovery: XEP-0030.</li>
|
|||
|
|
<li>RosterManager: Handling roster related tasks.</li>
|
|||
|
|
<li>BlockingManager: For blocking related tasks.</li>
|
|||
|
|
</ol>
|
|||
|
|
|
|||
|
|
<p>As of June 17 2023, there are 35 such managers and 35 XEPs supported in Moxxmpp.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>Managing cache: Moxxmpp manages cache of common requests, such as service discovery requests. If a request is duplicated, the result is provided from the cache - saving bandwidth and time.</li>
|
|||
|
|
</ol>
|
|||
|
|
|
|||
|
|
<p>As explained below, new XEP support is related to adding new managers to Moxxmpp and I will be doing the same for XEP-0045 support in Moxxy. My design plan is elaborated in the next section.</p>
|
|||
|
|
|
|||
|
|
<p>Here is my implementation plan for adding XEP-0045 support to Moxxmpp.</p>
|
|||
|
|
|
|||
|
|
<h2 id="gsoc-moxxmpp-implementation-design-plan">GSoC Moxxmpp Implementation Design Plan</h2>
|
|||
|
|
|
|||
|
|
<h3 id="directory-structure">Directory Structure</h3>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>xep_0045
|
|||
|
|
<ul>
|
|||
|
|
<li>errors.dart</li>
|
|||
|
|
<li>helpers.dart</li>
|
|||
|
|
<li>types.dart</li>
|
|||
|
|
<li>xep_0045.dart</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li>Here, the errors.dart file will contain the abstract classes for different errors that one could get whilst going through all the lifecycle use-cases of the MUC feature.</li>
|
|||
|
|
<li>The helpers.dart file will have some helper functions to maintain (DRY code avoiding repetition) and (modularized code).</li>
|
|||
|
|
<li>types.dart will contain model classes for the events and other entities.</li>
|
|||
|
|
<li>The xep_0045.dart is the main file which will contain the exposed routines as shown below, as well as the incoming stanza handlers.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h3 id="phase-1---query-room-information">Phase 1 - Query Room Information</h3>
|
|||
|
|
|
|||
|
|
<h4 id="futureresultroominformationmucerror-queryroominformationjid-roomjid"><code class="language-plaintext highlighter-rouge">Future&lt;Result&lt;RoomInformation,MUCError&gt;&gt; queryRoomInformation(JID roomJID)</code></h4>
|
|||
|
|
<p>This routine will allow the users to view the features of the room. These will include whether the room is open, moderated, password protected, etc. All this will be stored in a RoomInformation object and sent back as a Result object. It is important to note that the MUC server’s address (for the ‘to’ attribute) will be parsed from the latter half of the room JID (the part post the ‘@’).</p>
|
|||
|
|
|
|||
|
|
<p>The parameters of the RoomInformation class will be represented in the following way:</p>
|
|||
|
|
|
|||
|
|
<ol>
|
|||
|
|
<li><code class="language-plaintext highlighter-rouge">JID roomJID</code></li>
|
|||
|
|
<li><code class="language-plaintext highlighter-rouge">List&lt;String&gt; feature_list</code></li>
|
|||
|
|
</ol>
|
|||
|
|
|
|||
|
|
<h3 id="phase-2---joinleave-roomhandle-errors">Phase 2 - Join/Leave Room(Handle errors)</h3>
|
|||
|
|
<p>To join/leave a room we can send an appropriate presence stanza that will handle the same for us. So we will have two simple routines for the same as well.</p>
|
|||
|
|
|
|||
|
|
<h3 id="routines">Routines</h3>
|
|||
|
|
|
|||
|
|
<h4 id="futureresultbool-mucerror-joinroomjid-roomjid"><code class="language-plaintext highlighter-rouge">Future&lt;Result&gt;bool, MUCError&gt;&gt; joinRoom(JID roomJID)</code></h4>
|
|||
|
|
|
|||
|
|
<p>This routine will send a presence stanza to the MUC server asking it to join the server. It takes the <code class="language-plaintext highlighter-rouge">roomJID</code> as a parameter that will essentially contain the bare JID as well as the nickname (prompted from the user) as the resource. This will be preceded by the queryRoomInformation() routine call to obtain necessary information about the room, for example: if the room is password protected (in which case the user will see a not-implemented error dialog till a time it is supported).</p>
|
|||
|
|
|
|||
|
|
<p>Important to note is that the user’s nickname will be used as the ‘resource’ in the roomJID sent by the frontend. This is because the ‘to’ attribute of a presence stanza to join a room looks as such - <code class="language-plaintext highlighter-rouge">{local/MUC}@{domain/chat server}/{nickname}.</code></p>
|
|||
|
|
|
|||
|
|
<h4 id="futureresultbool-mucerror-leaveroomjid-roomjid"><code class="language-plaintext highlighter-rouge">Future&lt;Result&lt;bool, MUCError&gt;&gt; leaveRoom(JID roomJID)</code></h4>
|
|||
|
|
|
|||
|
|
<p>Similarly this is a routine to allow for leaving the room with a presence stanza.</p>
|
|||
|
|
|
|||
|
|
<p>The boolean return type is just to allow for a simple return object with the Result type. We could move forward with a simple Future<bool> as well, but for the sake of consistency - maybe sticking to the former is better.</bool></p>
|
|||
|
|
|
|||
|
|
<h3 id="phase-3---refactor-sendmessage-to-handle-mucs">Phase 3 - Refactor sendMessage to handle MUCs</h3>
|
|||
|
|
<p>To be able to send messages to groupchats/MUCs, the main requirement is to be able to change the <code class="language-plaintext highlighter-rouge">type</code> attribute in the message stanzas from <code class="language-plaintext highlighter-rouge">chat</code> to <code class="language-plaintext highlighter-rouge">groupchat</code>. This can be done in one of two ways. The first way will be to change the <code class="language-plaintext highlighter-rouge">sendMessage</code> routine’s description to include a <code class="language-plaintext highlighter-rouge">type</code> parameter that will simply transfer over to the stanza that will be sent from moxxmpp as a string. Another was is described below, where a new extension called ConversationTypeData will be added to the <code class="language-plaintext highlighter-rouge">StanzaHandlerExtension</code> object whilst calling the sendMessage routine. The former solution is simpler and will most probably be implemented. The design for both these possibilities is listed below.</p>
|
|||
|
|
|
|||
|
|
<h4 id="solution-1">Solution 1</h4>
|
|||
|
|
|
|||
|
|
<p>The <code class="language-plaintext highlighter-rouge">sendMessage</code> routine will transform from</p>
|
|||
|
|
|
|||
|
|
<pre><code class="language-Dart">Future&lt;void&gt; sendMessage(
|
|||
|
|
JID to,
|
|||
|
|
TypedMap&lt;StanzaHandlerExtension&gt; extensions,
|
|||
|
|
) async {
|
|||
|
|
await getAttributes().sendStanza(
|
|||
|
|
StanzaDetails(
|
|||
|
|
Stanza.message(
|
|||
|
|
to: to.toString(),
|
|||
|
|
id: extensions.get&lt;MessageIdData&gt;()?.id,
|
|||
|
|
type: 'chat',
|
|||
|
|
children: _messageSendingCallbacks
|
|||
|
|
.map((c) =&gt; c(extensions))
|
|||
|
|
.flattened
|
|||
|
|
.toList(),
|
|||
|
|
),
|
|||
|
|
awaitable: false,
|
|||
|
|
),
|
|||
|
|
);
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
|
|||
|
|
<p>to</p>
|
|||
|
|
|
|||
|
|
<pre><code class="language-Dart">Future&lt;void&gt; sendMessage(
|
|||
|
|
JID to,
|
|||
|
|
TypedMap&lt;StanzaHandlerExtension&gt; extensions,
|
|||
|
|
String type,
|
|||
|
|
) async {
|
|||
|
|
await getAttributes().sendStanza(
|
|||
|
|
StanzaDetails(
|
|||
|
|
Stanza.message(
|
|||
|
|
to: to.toString(),
|
|||
|
|
id: extensions.get&lt;MessageIdData&gt;()?.id,
|
|||
|
|
type: type,
|
|||
|
|
children: _messageSendingCallbacks
|
|||
|
|
.map((c) =&gt; c(extensions))
|
|||
|
|
.flattened
|
|||
|
|
.toList(),
|
|||
|
|
),
|
|||
|
|
awaitable: false,
|
|||
|
|
),
|
|||
|
|
);
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
|
|||
|
|
<h4 id="solution-2">Solution 2</h4>
|
|||
|
|
|
|||
|
|
<pre><code class="language-Dart">enum ConversationType {
|
|||
|
|
chat, groupchat, groupchatprivate
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
|
|||
|
|
<p>The <code class="language-plaintext highlighter-rouge">ConversationTypeData</code> class essentially will act as a wrapper over the above enum.</p>
|
|||
|
|
|
|||
|
|
<p>Hence the new type attribute value will be:</p>
|
|||
|
|
<pre><code class="language-Dart">extensions.get&lt;ConversationTypeData&gt;()?.conversationType ==
|
|||
|
|
ConversationType.groupchat
|
|||
|
|
? 'groupchat'
|
|||
|
|
: 'chat',
|
|||
|
|
</code></pre>
|
|||
|
|
|
|||
|
|
<p>Here, <code class="language-plaintext highlighter-rouge">ConversationTypeData</code> is a simple wrapper over <code class="language-plaintext highlighter-rouge">ConversationType</code> so that it can be recognized as a subclass of the <code class="language-plaintext highlighter-rouge">StanzaHandlerExtensions</code> class.</p>
|
|||
|
|
|
|||
|
|
<p>For private MUC messages to a single participant, the <code class="language-plaintext highlighter-rouge">type</code> attribute of the message stanza should be set to <code class="language-plaintext highlighter-rouge">chat</code>. This can be handled very easily in case of either solution implementation.</p>
|
|||
|
|
|
|||
|
|
<hr />
|
|||
|
|
|
|||
|
|
<p>For MUC messages with a stanza reflecting a chat server (type: ‘groupchat’), the type in the MessageEvent will be set to ‘groupchat’ automatically. The rest will be handled similarly to 1:1 chats.</p>
|
|||
|
|
|
|||
|
|
<h3 id="phase-4---miscellaneous-requirements">Phase 4 - Miscellaneous requirements</h3>
|
|||
|
|
<p>Some of the miscellaneous requirements from Moxxmpp could include viewing member list, group subject, change availability status, and more.
|
|||
|
|
For now, I have identified the below as the most crucial requirements for the Moxxmpp feature additions for MUC.</p>
|
|||
|
|
|
|||
|
|
<p>Below are the use-cases and how they are planned to be handled:</p>
|
|||
|
|
|
|||
|
|
<ol>
|
|||
|
|
<li>Get member list</li>
|
|||
|
|
</ol>
|
|||
|
|
|
|||
|
|
<p>After one joins a room, the user receives a presence from all the connected users to the chat. The best way to get the member list is to capture/handle the incoming presence stanzas and send an appropriate <code class="language-plaintext highlighter-rouge">MUCPresenceReceived</code> event to the UI.</p>
|
|||
|
|
|
|||
|
|
<p>This way, whenever a user joins a room, they can see the current member list, and on subsequent presence updates, also change that list.</p>
|
|||
|
|
|
|||
|
|
<ol>
|
|||
|
|
<li>Handling the room subject</li>
|
|||
|
|
</ol>
|
|||
|
|
|
|||
|
|
<p>This is a very simple usecase. When a disco info query about the MUC goes out to the XMPP server, the response contains an identity node containing the chat name. This would be the best way to extract the rom subject. As of now, the <code class="language-plaintext highlighter-rouge">queryRoomInformation</code> routine will be triggered from the UI and the response will be sent to the same. This will be encapsulated in a simple <code class="language-plaintext highlighter-rouge">RoomInformation</code> class which is now updated as follows:</p>
|
|||
|
|
|
|||
|
|
<ol>
|
|||
|
|
<li><code class="language-plaintext highlighter-rouge">JID roomJID</code></li>
|
|||
|
|
<li><code class="language-plaintext highlighter-rouge">List&lt;String&gt; feature_list</code></li>
|
|||
|
|
<li><code class="language-plaintext highlighter-rouge">String name</code></li>
|
|||
|
|
</ol>
|
|||
|
|
|
|||
|
|
<p><strong>Note</strong>: Changing your status seemed like a task that would be slighlty out of scope for the project duration, so that is kept as a stretch goal for now.</p>
|
|||
|
|
|
|||
|
|
<h3 id="errors">Errors</h3>
|
|||
|
|
<p>Frontend checks while joining a room to prevent avoidable errors:</p>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>Nickname must be specified in accordance with the rules of the XEP - to prevent the no nickname specified error.</li>
|
|||
|
|
<li>Validations for JID input field.</li>
|
|||
|
|
<li>Validation for checking empty nickname.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<p>Some of the possible errors that can be faced by the user in an MUC workflow are:</p>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>Invalid/Already in use nickname</li>
|
|||
|
|
<li>Not allowed to register</li>
|
|||
|
|
<li>Invalid stanza format</li>
|
|||
|
|
<li>Invalid Disco Info Response: In case of some rare edge cases (not handled currently) where the response does not contain some information like the room name, or the features of the room.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h2 id="challenges-noted">Challenges noted</h2>
|
|||
|
|
|
|||
|
|
<p>Some challenges/room for error were noted along the way. They are enumerated below:</p>
|
|||
|
|
|
|||
|
|
<ol>
|
|||
|
|
<li>
|
|||
|
|
<p>How will Moxxy/Moxxmpp handle messages from oneself?</p>
|
|||
|
|
|
|||
|
|
<p>When a user sends a message on the MUC, they receive the message themselves as well. How will moxxmpp/moxxy differentiate between other live messages and this echoed message?</p>
|
|||
|
|
|
|||
|
|
<p>The solution to this problem is to use the origin-id of the message. If the origin-id of the response matches with the sent origin-id, then the message is to be ignored and not shown in the UI.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>In anonymous MUCs, one can easily act as someone else by using their nickname once they leave. How will this be handled?</p>
|
|||
|
|
|
|||
|
|
<p>This is fixed by using the occupant-id property as described in XEP-0421. A user (with their unique JID) when joins the group, is assigned a unique occupant-id, which can be used to actually track which message is from which user.</p>
|
|||
|
|
|
|||
|
|
<p>This makes the implementation of reactions/retractions simpler.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p>How will discussion history (sent on joining an MUC) be handled when someone rejoins an MUC?</p>
|
|||
|
|
|
|||
|
|
<p>When a user joins a MUC, they are sent a set of stanzas in the following order:</p>
|
|||
|
|
|
|||
|
|
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code> 1. Errors (if any)
|
|||
|
|
2. Self presence with status code
|
|||
|
|
3. Room history
|
|||
|
|
4. Room subject
|
|||
|
|
5. Live message/presence updates
|
|||
|
|
</code></pre></div> </div>
|
|||
|
|
|
|||
|
|
<p>Now, when a user gets disconnected from an MUC and joins again, then the room history will be sent again as well. To prevent this history from getting appended to the conversation in the UI, we will need to wait till we receive the room subject and only then start listening for message stanzas (since room subject is sent after room history).</p>
|
|||
|
|
</li>
|
|||
|
|
</ol>
|
|||
|
|
|
|||
|
|
<h2 id="conclusion-and-future-work">Conclusion and future work</h2>
|
|||
|
|
|
|||
|
|
<p>In conclusion, this blog post discussed the implementation plan for adding Multi-User Chat (MUC) support, specifically XEP-0045, to Moxxmpp. Moxxmpp serves as the backbone for the Moxxy XMPP client, handling the communication between the client and XMPP server. The blog outlined the directory structure, design plan, and key routines for implementing the MUC support in Moxxmpp. It also addressed some challenges and considerations related to handling MUC features.</p>
|
|||
|
|
|
|||
|
|
<p>Implementation for this has begun, and a <a href="https://codeberg.org/moxxy/moxxmpp/pulls/46">PR</a> is already underway. Once this PR is completed, then work will begin on the front-end and the changes will be integrated into Moxxy.</p></content><author><name>Ikjot Singh Dhody</name></author><summary type="html">Hello readers!</summary></entry><entry><title type="html">Moxxy’s First GSoC Project!</title><link href="https://moxxy.org/posts/2023-05-06-Groupchat-GSoC-Project.html" rel="alternate" type="text/html" title="Moxxy’s First GSoC Project!" /><published>2023-05-06T00:00:00+02:00</published><updated>2023-05-06T00:00:00+02:00</updated><id>https://moxxy.org/posts/Groupchat-GSoC-Project</id><content type="html" xml:base="https://moxxy.org/posts/2023-05-06-Groupchat-GSoC-Project.html"><p>Hello readers!</p>
|
|||
|
|
|
|||
|
|
<p>As we know, Moxxy is an experimental IM for XMPP built using Flutter. While it does have a great set of features as described <a href="https://moxxy.org/">here</a>, it currently lacks support for group chats (or Multi-User-Chats). A great piece of news is that Google has accepted my proposal to add support for multi user chats in Moxxy.</p>
|
|||
|
|
|
|||
|
|
<p>To implement multi user chats in Moxxy, the <a href="https://xmpp.org/extensions/xep-0045.html">XEP-0045</a> standard will be followed and implemented. The project will run in two phases, since the major changes required will be in the <a href="https://codeberg.org/moxxy/moxxmpp">moxxmpp</a> and <a href="https://codeberg.org/moxxy/moxxy">Moxxy</a> codebases. First, XEP-0045 support will be added to moxxmpp with all the handlers, events and routines required to cleanly integrate the same with Moxxy. The second phase will be the UI changes in the Moxxy Flutter application, that builds upon the existing, reusable infrastructure.</p>
|
|||
|
|
|
|||
|
|
<p>The usecases planned to be implemented are listed below (subject to changes before the coding period begins):</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>Join a room</li>
|
|||
|
|
<li>Leave a room</li>
|
|||
|
|
<li>Change availability status</li>
|
|||
|
|
<li>View member list</li>
|
|||
|
|
<li>Send/receive a message to/from all occupants</li>
|
|||
|
|
<li>Send/receive a private message to/from a specific occupant</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<p>Some extra usecases are planned in case time permits:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>Change nickname</li>
|
|||
|
|
<li>Kick an occupant (if user has such a permission)</li>
|
|||
|
|
<li>Ban an occupant (if user has such a permission)</li>
|
|||
|
|
<li>Grant/revoke membership (if user has such a permission)</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<p>The coding period for this project will begin on May 29. In case of any queries/interest, please join the following - <a href="xmpp:dev@muc.moxxy.org?join">xmpp:dev@muc.moxxy.org?join</a>.</p></content><author><name>Ikjot Singh Dhody</name></author><summary type="html">Hello readers!</summary></entry><entry><title type="html">Moxxy’s New Website</title><link href="https://moxxy.org/posts/2023-01-24-Moxxys-New-Website.html" rel="alternate" type="text/html" title="Moxxy’s New Website" /><published>2023-01-24T00:00:00+01:00</published><updated>2023-01-24T00:00:00+01:00</updated><id>https://moxxy.org/posts/Moxxys-New-Website</id><content type="html" xml:base="https://moxxy.org/posts/2023-01-24-Moxxys-New-Website.html"><p>Hello everyone! Welcome on Moxxy’s new website. It currently does not contain
|
|||
|
|
much but that may change in the future.</p>
|
|||
|
|
|
|||
|
|
<p>The page is built using <a href="https://jekyllrb.com/">Jekyll</a> and <a href="https://tailwindcss.com/">TailwindCSS</a>. You can find the page’s
|
|||
|
|
source <a href="https://codeberg.org/moxxy/website">here</a>.</p></content><author><name>PapaTutuWawa</name></author><summary type="html">Hello everyone! Welcome on Moxxy’s new website. It currently does not contain much but that may change in the future.</summary></entry></feed>
|