Difference between revisions of "Google Summer of Code 2022"

Jump to navigation Jump to search
m
 
(48 intermediate revisions by 6 users not shown)
Line 12: Line 12:


Otherwise, all other info is on [https://summerofcode.withgoogle.com/get-started/ GSoC page]
Otherwise, all other info is on [https://summerofcode.withgoogle.com/get-started/ GSoC page]
[https://developers.google.com/open-source/gsoc/faq Find their FAQ.]
=== Overview ===
{| class="wikitable"
! Date
! Meeting
! Participants
|-
| 2021-12-21
| Kick-off Meeting
| flow, vanitasviate, emus
|-
| 2021-01
| Organisation Application preparation
| emus & XSF members
|-
| 2021-02
| Organisation Application
| emus
|-
| 2021-02
| Projects Application
| Project maintainers
|}


== Overview ==
== Overview ==
Line 20: Line 46:


As there are several disparate projects here, there's variety across several codebases in different languages and with significantly different aims, so take a look through all the ideas - there should be something for everyone here :)
As there are several disparate projects here, there's variety across several codebases in different languages and with significantly different aims, so take a look through all the ideas - there should be something for everyone here :)
* [https://wiki.xmpp.org/web/GSoC#Overview Archive of previous GSoC participation]
* [[Application details from Feb 2022]]
= How to get started? =
* Read the [https://summerofcode.withgoogle.com/help Google Summer of Code 2022 guidelines]!
* Review the projects below and inform yourself if that could be of interested for you [https://wiki.xmpp.org/web/Google_Summer_of_Code_2022#Project_Ideas Link]
* Reach out the projects contact, tell about yourself and why you are interested (see project section)
* Join our GSoC group chat channel via XMPP (you can reach out via mail of course as well, but we really recommend to also use the technology) [https://wiki.xmpp.org/web/Google_Summer_of_Code_2022#Join_the_group_chat! Link]
* Continue to discuss teaser tasks with the project contact [https://wiki.xmpp.org/web/Google_Summer_of_Code_2022#Teaser_Tasks Link]
* If everything is fine, start preparing a proposal and if reviewed submit the application [https://wiki.xmpp.org/web/Google_Summer_of_Code_2022#Student_Proposal Link]
== Join the group chat! ==
Use a regular XMPP client and join the GSoC chat room '''[xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org]'''.
How to join:
* Download and [https://xmpp.org/getting-started/ install a client], or [https://xmpp.org/chat#converse/room?jid=gsoc@muc.xmpp.org use a web client]
* Create an account, or use an existing one
* Find, join, and bookmark: [xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org].


== Teaser Tasks ==
== Teaser Tasks ==
Line 26: Line 74:


A list of teaser tasks is given in the [[#Project_Ideas|Project Ideas]] overview, but please join the chat rooms for the respective projects and discuss them there, where mentors will be able to help you and know what you're up to. There are different teasers for different codebases, and more teasers will be appearing here over the next few days.
A list of teaser tasks is given in the [[#Project_Ideas|Project Ideas]] overview, but please join the chat rooms for the respective projects and discuss them there, where mentors will be able to help you and know what you're up to. There are different teasers for different codebases, and more teasers will be appearing here over the next few days.
== Student Proposal ==
In addition to writing a proposal, engagement with the actual projects before the application is very important. Showing motivation by taking interest in the project and communicating with the mentors is very advantageous. Solving a typical small problem can show that a student is serious with their plans.
Of course, a good proposal is fine, too. We would be interested in the motivation behind the application. Additionally, the student's background, the possible experiences and preferred technologies, the outcome of a preliminary research on the protocol and codesbases the student might work on. Furthermore, their own perspective on how the collaboration and organization through the Google Summer of Code with the mentors should look like and a review of which possible problems may be faced are also helpful.
Furthermore we recommend a bit of research on online guides to write a proposal or motivational letter. The official guidelines of the [https://developers.google.com/open-source/gsoc/help/student-advice Google Summer of Code 2022] are highly recommended to read first.


= Project Ideas =
= Project Ideas =


= Dino =
== Dino ==


''Website:'' https://dino.im/<br/>
''Website:'' https://dino.im/<br/>
Line 37: Line 93:
''Relevant readings:'' [https://wiki.gnome.org/Projects/Vala/Tutorial Vala Tutorial]<br/>
''Relevant readings:'' [https://wiki.gnome.org/Projects/Vala/Tutorial Vala Tutorial]<br/>
''Teaser Tasks:'' [https://github.com/dino/dino/labels/good%20first%20issue Good first issues]<br/>
''Teaser Tasks:'' [https://github.com/dino/dino/labels/good%20first%20issue Good first issues]<br/>
''Chat:'' [xmpp:chat@dino.im?join chat@dino.im]
''Chat:'' [xmpp:chat@dino.im?join chat@dino.im] or [https://xmpp.org/chat#converse/room?jid=chat@dino.im Webchat]
 
'''Note:''' Feel invited to combine small projects into a large project, if you want to do a large project. Combinations of the 3 projects related to file transfers are a particular fit for a large project.


=== Inline link preview ===
=== Inline link preview ===
Line 44: Line 102:
''Involved Technologies:'' Vala, XMPP, HTML, OpenGraph<br/>
''Involved Technologies:'' Vala, XMPP, HTML, OpenGraph<br/>
''Relevant readings:'' [http://ogp.me/ OpenGraph protocol]<br/>
''Relevant readings:'' [http://ogp.me/ OpenGraph protocol]<br/>
''Project size:'' Small (175h)<br/>
''Difficulty:'' Easy<br/>
''Deliverables / Expected Results:''<br/>
''Deliverables / Expected Results:''<br/>
* User interface widget to display metadata, suitable for preview image, title, abstract and the original url/domain.
* User interface widget to display metadata, suitable for preview image, title, abstract and the original url/domain.
* Automatic generation of metadata, working with major websites. This should be done in a generic fassion, not targeting a specific website
* Automatic generation of metadata, working with major websites. This should be done in a generic fashion, not targeting a specific website
* Design or reuse a specification for sending metadata with XMPP messages
* Design or reuse a specification for sending metadata with XMPP messages


= Mellium =
=== Stateless file sharing ===


''Website:'' https://melluim.im/<br/>
''Brief explanation:'' Attach metadata to HTTP file transfers and display it.<br/>
''Source Code:'' https://mellium.im/code<br/>
''Involved Technologies:'' Vala, XMPP, HTTP<br/>
''Description:'' Mellium is a collection of Go modules related to XMPP.<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0446.html XEP-0446], [https://xmpp.org/extensions/xep-0447.html XEP-0447], [https://xmpp.org/extensions/xep-0363.html XEP-0363]<br/>
''Project Contact:'' [[User:SamWhited|Sam Whited]]<br/>
''Project size:'' Small (175h)<br/>
''Relevant readings:'' [https://golang.org/doc/effective_go Effective Go], [https://mellium.im/docs/ Mellium docs], [https://pkg.go.dev/mellium.im/xmpp Mellium API docs]<br/>
''Difficulty:'' Medium<br/>
''Teaser Tasks:'' [https://github.com/mellium/xmpp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 Good first issues]<br/>
''Deliverables / Expected Results:''<br/>
''Chat:'' [xmpp:users@mellium.chat?join users@mellium.chat]
* Use [https://xmpp.org/extensions/xep-0447.html Stateless file sharing (SFS)] for outgoing HTTP file transfers.
* Send minimal thumbnails (less than 16 pixels) for image file transfers
* Display minimal thumbnails blurred on incoming file transfers (before file is fetched).


=== Audio/Video Chat ===
=== On-demand p2p file sharing ===
 
''Brief explanation:'' Allow for on-demand multi-party peer-to-peer file transfers.<br/>
''Brief explanation:'' Add support for Audio/Video Communication via Jingle.<br/>
''Involved Technologies:'' Vala, XMPP, Jingle<br/>
''Involved Technologies:'' Go, WebRTC, Jingle<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0447.html XEP-0447], [https://xmpp.org/extensions/xep-0234.html XEP-0234]<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0167.html XEP-0167], [https://xmpp.org/extensions/xep-0353.html XEP-0353]<br />
''Project size:'' Small (175h)<br/>
''Difficulty:'' Medium<br/>
''Important Note:'' This project can only be achieved by first implementing the "Stateless file sharing" project.<br/>
''Deliverables / Expected Results:''<br/>
''Deliverables / Expected Results:''<br/>
* A separate Go library for Jingle that is not XMPP specific (probably, we can discuss design later)
* Implement [https://xmpp.org/extensions/xep-0234.html#requesting Jingle File Transfer requests] to request and deliver files.
* Audio and video chat in mellium.im/xmpp that is compatible with [https://conversations.im Conversations]
* Announce availability of Jingle file transfer using [https://xmpp.org/extensions/xep-0447.html Stateless file sharing (SFS)] for outgoing file transfers and after retrieval.
* File transfer in in mellium.im/xmpp using Jingle sessions (also compatible with Conversations)
* A demo app to start a conversation


=== Group Chat ===
=== WebRTC file transfer ===


''Brief explanation:'' Add support for group chats using either Multi-User Chat or Mediated Information Exchange (MIX).<br/>
''Brief explanation:'' Add support for WebRTC-based file transfers using WebRTC data channels for web compatibility and improved NAT traversal.<br/>
''Involved Technologies:'' Go<br/>
''Involved Technologies:'' Vala, XMPP, Jingle, WebRTC<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0369.html XEP-0369: Mediated Information eXchange (MIX)], [https://xmpp.org/extensions/xep-0045.html XEP-0045: Multi-User Chat]<br />
''Relevant readings:'' [https://xmpp.org/extensions/xep-0343.html XEP-0343], [https://xmpp.org/extensions/xep-0234.html XEP-0234]<br/>
''Project size:'' Small (175h)<br/>
''Difficulty:'' Hard<br/>
''Deliverables / Expected Results:''<br/>
''Deliverables / Expected Results:''<br/>
* A well tested library for joining or serving MUC or MIX and a set of integration tests that work against Prosody or Ejabberd server
* Implement SCTP protocol
* A simple component for hosting MUC or MIX chats
* WebRTC data channel protocol
* Use [https://xmpp.org/extensions/xep-0343.html Jingle WebRTC data channel signalling] for file transfers when supported by peer.


=== End-to-End Encryption ===
=== Rich message support ===


''Brief explanation:'' Add support for end-to-end (E2E) encryption using OMEMO, or MLS<br/>
''Brief explanation:'' Add support for creating and displaying rich test messages.<br/>
''Involved Technologies:'' Go, Go Subrepos, OMEMO or MLS<br/>
''Involved Technologies:'' Vala, XMPP, GTK+, Pango<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0384.html XEP-0384: OMEMO Encryption], [https://datatracker.ietf.org/doc/draft-ietf-mls-protocol/ The Messaging Layer Security (MLS) Protocol (draft-ietf-mls-protocol)]<br />
''Relevant readings:'' [https://xmpp.org/extensions/xep-0393.html XEP-0393], [https://xmpp.org/extensions/xep-0394.html XEP-0394], [https://xmpp.org/extensions/xep-0372.html XEP-0372]<br/>
''Project size:'' Small (175h)<br/>
''Difficulty:'' Easy<br/>
''Deliverables / Expected Results:''<br/>
''Deliverables / Expected Results:''<br/>
* If using MLS, an XEP describing behavior and how MLS should be integrated with XMPP
* Add rich text features to Dino's chat input box using buttons and well-known keyboard shortcuts for bold, italic, strikethrough, monospace, lists, blockquotes, code blocks, links and mentions.
* A well-designed API and well-tested library for encrypting messages with OMEMO or MLS
* Allow users to activate Markdown input, which is instantly converted to rich text during input.
* Changes to the Go standard library and sub-repositories to add any missing cryptographic primitives or expose operations that are currently internal only.
* Send rich text messages using [https://xmpp.org/extensions/xep-0394.html Message Markup] and [https://xmpp.org/extensions/xep-0372.html References] as well as a fallback using [https://xmpp.org/extensions/xep-0393.html Message Styling]
* Apply markup to messages in conversation history via Pango Attributes


= Psi =
== Psi ==


''Website:'' https://psi-im.org/<br/>
''Website:'' https://psi-im.org/<br/>
''Source Code:'' https://github.com/psi-im/psi<br/>
''Source Code:'' https://github.com/psi-im/psi<br/>
''Description:'' An XMPP client for advanced users.</br>
''Description:'' An XMPP client for advanced users.</br>
''Project Contact:'' [[User:Rion|rion]], Tehnick, VitoZz<br/>
''Project Contact:'' [[User:Rion|Sergei Ilinykh]], Tehnick (Boris Pek), VitoZz (Vitaly Tonkacheyevb)<br/>
''Relevant readings:'' [https://psi-plus.com/wiki/en:main]<br/>
''Relevant readings:'' [https://psi-plus.com/wiki/en:main]<br/>
''Teaser Tasks:'' [https://github.com/psi-im/psi/milestone/4]<br/>
''Teaser Tasks:'' [https://github.com/psi-im/psi/milestone/4]<br/>
''Chat:'' [xmpp:psi-dev@conference.jabber.ru?join psi-dev@conference.jabber.ru]
''Chat:'' [xmpp:psi-dev@conference.jabber.ru?join psi-dev@conference.jabber.ru] or [https://xmpp.org/chat#converse/room?jid=psi-dev@conference.jabber.ru Webchat]


=== Mediated Information Exchange (MIX) ===
=== Mediated Information Exchange (MIX) ===
Line 104: Line 172:
''Involved Technologies:'' Qt, C++<br/>
''Involved Technologies:'' Qt, C++<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0369.html XEP-0369: Mediated Information eXchange (MIX)]<br />
''Relevant readings:'' [https://xmpp.org/extensions/xep-0369.html XEP-0369: Mediated Information eXchange (MIX)]<br />
''Size:'' large<br/>
''Difficulty:'' Hard<br/>
''Deliverables / Expected Results:''<br/>
''Deliverables / Expected Results:''<br/>
* A set of classes in [https://github.com/psi-im/iris iris] library to support MIX extensions.
* A set of classes in [https://github.com/psi-im/iris iris] library to support MIX extensions.
Line 115: Line 185:
''Involved Technologies:'' Qt, QML, JavaScript, C++<br/>
''Involved Technologies:'' Qt, QML, JavaScript, C++<br/>
''Relevant readings:'' https://en.wikipedia.org/wiki/QML<br/>
''Relevant readings:'' https://en.wikipedia.org/wiki/QML<br/>
''Size:'' large<br/>
''Difficulty:'' Medium<br/>
''Deliverables / Expected Results:''<br/>
''Deliverables / Expected Results:''<br/>
* It's a huge task, so expected an implementation of standalone QML/*cross-platform* UI with clear and well-documented API interfaces.
* It's a huge task, so expected an implementation of standalone QML/*cross-platform* UI with clear and well-documented API interfaces.
* The UI may be backed by some mocked C++ code where Psi code should be taken as a guidance. This is perfectly fine to borrow design/API ideas from other clients too.
* The UI may be backed by some mocked C++ code where Psi code should be taken as a guidance. This is perfectly fine to borrow design/API ideas from other clients too. This mocked code is mostly needed to initiate some UI actions unrelated to self user (e.g. some contact changes their status) and catch/log UI events.
* It's assumed the UI will be used not just with Psi. So the branded parts preferably should be kept aside and instead set via API.
* It's assumed the UI will be used not just with Psi. So the branded parts preferably should be kept aside and instead set via API.
* The UI should provide next functions: model/view-based chat/group-chat, roster, avatars, statuses, recent (group-)chats, contact list (with groups/tags), contacts management, own status management.
* The UI should provide next functions: model/view-based chat/group-chat, roster, avatars, statuses, recent (group-)chats, fetching unlimited message log, contact list (with groups/tags), contacts management, own status management.
* The UI should be adaptable to screen size (read: there plans to use it for mobile platforms too).
* The UI should be compilable at least on Linux, MacOS and Windows.
 
=== Message Archive Management ===
 
''Brief explanation:'' Support for server-based message archive
''Involved Technologies:'' Qt, C++<br/>
''Relevant readings:'' https://xmpp.org/extensions/xep-0313.html<br/>
''Size:'' small<br/>
''Difficulty:'' Medium<br/>
''Deliverables / Expected Results:''<br/>
* Implement MAM in iris (https://github.com/psi-im/iris) library.
* Integrate the new message storage with current local history management in Psi (which is based on iris).
* Keep the ability to use local history (for cases when server MAM is unavailable or undesired) and combine both sources seamlessly
* If it's necessary update Psi UI to make it work with the new mechanism.
* Keep in mind related to MAM XEPs to not make something completely incompatible.


== PGPainless ==


= Join the group chat! =
[https://pgpainless.org/ PGPainless] is a Java OpenPGP library. While it is not strictly an XMPP related project, it has it has its origins in GSoC and the XMPP community, since it was created as a [https://blog.jabberhead.tk/summer-of-code-2018/ Summer of Code project in 2018].


Use a regular XMPP client and join the GSoC chat room '''[xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org]'''.
Interested students are encouraged to join '''[xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org]'''
 
=== OpenPGP Message Parsing using Parser Generator ===
 
''Size:'' Small<br/>
''Brief explanation:'' Enforce OpenPGP message syntax during parsing by using a Parser Generator such as JavaCC<br/>
''Involved Technologies:'' Java, Bouncy Castle, EBNF<br/>
''Relevant readings:'' [https://datatracker.ietf.org/doc/html/rfc4880 RFC4880: OpenPGP Message Format]<br/>
''Deliverables / Expected Results:''<br/>
* In the OpenPGP Interoperability Test Suite PGPainless currently fails some tests related to [https://tests.sequoia-pgp.org/#Unusual_Message_Structure unusual message structures].
* The project has the goal to improve PGPainless' score in this category by rewriting/improving the libraries' rather naive [https://github.com/pgpainless/pgpainless/blob/master/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/DecryptionStreamFactory.java message parser logic].
* An ideal implementation would enforce the OpenPGP message structure syntax defined as EBNF. This could be done by using a parser generator such as [https://javacc.github.io/javacc/ JavaCC].
 
== Converse.js ==
 
[https://conversejs.org/ Converse] is a web-based XMPP client. It has different modes, allowing it to be integrated into existing websites, used as a webchat for a specific chatroom, or used as a full-fledged XMPP client on its own. There is also an [https://www.electronjs.org/ electron]-based version available.
 
* [https://xmpp.org/chat#converse/room?jid=discuss@conference.conversejs.org Webchat]


How to join:
=== Support Audio/Video calls in Converse ===


* Download and [https://xmpp.org/getting-started/ install a client], or [https://xmpp.org/chat?gsoc use a web client]
''Size:'' small (175hrs)<br/>
* Create an account, or use an existing one
''Brief explanation:'' Add support for Audio/Video Communication via Jingle.<br/>
* Find, join, and bookmark: [xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org].
''Involved Technologies:'' JavaScript, WebRTC, Jingle<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0166.html XEP-0166], [https://xmpp.org/extensions/xep-0167.html XEP-0167], [https://xmpp.org/extensions/xep-0353.html XEP-0353]<br />
''Deliverables / Expected Results:''<br/>
* The goal is to create a Converse plugin that adds the ability to make one-on-one audio/video calls from Converse
* The audio/video calls must be compatible with other XMPP clients such as [https://conversations.im Conversations]
178

edits

Navigation menu