├── data ├── locale │ ├── en │ │ ├── faq │ │ ├── README.md │ │ ├── projects │ │ └── book.json │ └── LANGS.md ├── admins.json ├── faq.liquid └── projects.liquid ├── .gitignore ├── book.json ├── favicon.ico ├── resources ├── images │ ├── coala.png │ └── coala-404.png ├── js │ ├── analytics.js │ └── app.js ├── vendors │ ├── markdown │ │ └── markdown.js │ ├── bootstrap │ │ └── css │ │ │ └── bootstrap.min.css │ └── angular-sanitize │ │ └── angular-sanitize.js └── css │ ├── 404.css │ ├── style.css │ └── coala.css ├── _faq ├── i-want-to-do-a-gsoc.md ├── working-out-the-proposal.md ├── contact-mentor.md ├── gsoc-requirements.md ├── own-project-idea.md ├── project-participation.md ├── is-mentor-necessary.md ├── student-obligations.md ├── mentor-obligations.md ├── steal-project-idea.md ├── writing-a-great-proposal.md └── application-template.md ├── Gemfile ├── partials └── tabs │ ├── faq.html │ ├── mentors.html │ └── projects.html ├── _config.yml ├── gsod-ideas.md ├── old_projects ├── pyquotient.md ├── dendrite-implement-and-extend-media-apis.md ├── fun-riot-features.md ├── dendrite-implement-registration-login-apis.md ├── dendrite.md ├── add-e2ee-to-more-clients.md ├── quotient-embed-dendrite.md ├── quaternion-timeline-navigation.md ├── bifrost.md ├── exporting-conversations.md ├── maths.md ├── html-embeddable-chat-rooms.md ├── hydrogen.md ├── email-bridge.md ├── opsdroid.md ├── nheko-room-upgrades.md └── nheko-polish.md ├── _projects ├── element_knocking.md ├── rust-sdk-python-bindings.md └── _template.md ├── Gemfile.lock ├── index.html ├── README.md ├── IDEAS.md └── LICENSE /data/locale/en/faq: -------------------------------------------------------------------------------- 1 | ../../../_faq/ -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | _site/ 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /data/locale/en/README.md: -------------------------------------------------------------------------------- 1 | ../../../README.md -------------------------------------------------------------------------------- /data/locale/en/projects: -------------------------------------------------------------------------------- 1 | ../../../_projects/ -------------------------------------------------------------------------------- /book.json: -------------------------------------------------------------------------------- 1 | { 2 | "root": "data/locale/" 3 | } 4 | -------------------------------------------------------------------------------- /data/locale/en/book.json: -------------------------------------------------------------------------------- 1 | { 2 | "root": "." 3 | } 4 | -------------------------------------------------------------------------------- /data/locale/LANGS.md: -------------------------------------------------------------------------------- 1 | # Languages 2 | 3 | * [English](en/) 4 | 5 | -------------------------------------------------------------------------------- /favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matrix-org/gsoc/HEAD/favicon.ico -------------------------------------------------------------------------------- /data/admins.json: -------------------------------------------------------------------------------- 1 | ["Cadair", "ara4n", "thibaultamartin", "neilisfragile"] 2 | -------------------------------------------------------------------------------- /resources/images/coala.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matrix-org/gsoc/HEAD/resources/images/coala.png -------------------------------------------------------------------------------- /resources/images/coala-404.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matrix-org/gsoc/HEAD/resources/images/coala-404.png -------------------------------------------------------------------------------- /_faq/i-want-to-do-a-gsoc.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "I want to do a GSoC!" 3 | --- 4 | Great! This is the right place. Check out the other questions and 5 | most importantly the projects page. 6 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | ruby "3.1.0" 3 | 4 | gem "jekyll" 5 | gem "jekyll-netlify" 6 | gem "html-proofer" 7 | gem "kramdown-parser-gfm" 8 | 9 | gem "webrick", "~> 1.7" 10 | -------------------------------------------------------------------------------- /_faq/working-out-the-proposal.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "When should I start working out the proposal?" 3 | --- 4 | You can start right now! Ping any mentor and start discussing. 5 | The earlier you start, the better! 6 | -------------------------------------------------------------------------------- /data/faq.liquid: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | [ 4 | {% for faq in site.faq %} 5 | { 6 | "question" : "{{ faq.question }}", 7 | "url" : "{{ faq.url | remove_first:'/' }}", 8 | "markdown" : "{{ faq.path | replace: '_faq/', ''}}" 9 | }{% unless forloop.last %},{% endunless %}{% endfor %} 10 | ] 11 | -------------------------------------------------------------------------------- /_faq/contact-mentor.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "I found a great project! How can I contact my mentor?" 3 | --- 4 | Almost all mentors are active on [matrix](https://matrix.to/#/!WZbLERcNJxrvkxPfyV:matrix.org?via=sw1v.org&via=matrix.org&via=thebeckmeyers.xyz) (obviously!!). 5 | Just drop by and leave us a message! 6 | -------------------------------------------------------------------------------- /_faq/gsoc-requirements.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "What are the requirements to be accepted for GSoC?" 3 | --- 4 | You need to meet the [requirements from Google](https://developers.google.com/open-source/gsoc/faq#what_are_the_eligibility_requirements_for_participation) **and opened at least one PR to a matrix project**. 5 | -------------------------------------------------------------------------------- /_faq/own-project-idea.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "I have an own project idea! (Mentors and students!)" 3 | --- 4 | Superb! We recommend you submit your idea to [our projects 5 | repository](https://github.com/matrix-org/gsoc) as a pull request, and to come chat in [#gsoc:matrix.org](https://matrix.to/#/!WZbLERcNJxrvkxPfyV:matrix.org?via=sw1v.org&via=matrix.org&via=thebeckmeyers.xyz). 6 | -------------------------------------------------------------------------------- /_faq/project-participation.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "Will all the listed projects will be part of GSoC?" 3 | --- 4 | No. 5 | We have way too many projects and you are even invited to add your own ideas. 6 | This means that the listed projects are just ideas for you. 7 | 8 | But as long as we have good applications and spots, projects will happen. 9 | Where there are good students, good projects will happen ;) 10 | -------------------------------------------------------------------------------- /resources/js/analytics.js: -------------------------------------------------------------------------------- 1 | (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ 2 | (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), 3 | m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) 4 | })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); 5 | 6 | ga('create', 'UA-76769778-4', 'auto'); 7 | ga('send', 'pageview'); 8 | -------------------------------------------------------------------------------- /partials/tabs/faq.html: -------------------------------------------------------------------------------- 1 | 2 |
3 | 13 |
14 | 20 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | title: matrix.org GSoC 2 | license: GNU AFFERO GENERAL PUBLIC LICENSE V3.0 3 | organization: matrix.org 4 | description: An open network for secure, decentralized communication. 5 | baseurl: "/gsoc" # the subpath of your site, e.g. /blog 6 | url: "http://matrix-org.github.io" # the base hostname & protocol for your site 7 | githuburl: "https://github.com/matrix-org/gsoc" 8 | 9 | gsoc_switch_month: 6 10 | 11 | # Build settings 12 | exclude: [vendor, _projects/example.md] 13 | markdown: kramdown 14 | collections: 15 | projects: 16 | output: true 17 | reports: 18 | output: true 19 | faq: 20 | output: true 21 | -------------------------------------------------------------------------------- /_faq/is-mentor-necessary.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "A showcased project on the website doesn't have a mentor, but 3 | I'm interested in that project?" 4 | --- 5 | You just have to choose a project and write an awesome proposal. 6 | Mentors are set after we choose the projects (which is done by choosing the students). 7 | 8 | Our policy is that we'll always mentor awesome projects, so as long as your proposal 9 | is one of the winning ones, there will be a mentor for the project. 10 | But as for all other projects it might help to talk to your possible mentors, and in 11 | that case it also means trying to maybe find a mentor or at least talk to 12 | devs/maintainers about your ideas possibly in [#gsoc:matrix.org](https://matrix.to/#/!WZbLERcNJxrvkxPfyV:matrix.org?via=sw1v.org&via=matrix.org&via=thebeckmeyers.xyz). 13 | -------------------------------------------------------------------------------- /_faq/student-obligations.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "What are my obligations as a student during the GSoC?" 3 | --- 4 | We expect you to: 5 | 6 | * Be active on matrix, specifically in [#gsoc:matrix.org](https://matrix.to/#/!WZbLERcNJxrvkxPfyV:matrix.org?via=sw1v.org&via=matrix.org&via=thebeckmeyers.xyz). 7 | * Blog at least once per week. 8 | * Participate in regular meetings with your mentor. 9 | * Review PRs of other students and contributors. This is a big part of open 10 | source work and we'll make sure to help you get started. 11 | * All code you want to merge has to have full test coverage and documentation. 12 | * If anything, for whatever reason, looks 13 | to be problematic, talk to your mentor or an admin! 14 | 15 | And Again: 16 | __Get in contact with your mentors or the admins if any even remotely 17 | potential problems arise!__ 18 | -------------------------------------------------------------------------------- /_faq/mentor-obligations.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "What are my obligations as a mentor during the GSoC?" 3 | --- 4 | 5 | We expect you to: 6 | 7 | * Be active on matrix!. 8 | * Participate in weekly meetings with your student. 9 | * Review your students pull requests timely. 10 | * Get in contact with the admins if any even remotely potential problems arise. 11 | 12 | 13 | If you are interested in having a student work on your Matrix project, then you 14 | can submit a Pull Request with a project idea to our 15 | [GSoC repo](https://github.com/matrix-org/gsoc). Your project idea must: 16 | 17 | * Use Matrix 18 | * Have at least three defined milestones, corresponding to the three GSoC evaluation periods. 19 | * Be achievable within the GSoC time frame. 20 | 21 | 22 | If you have any questions contact any of the [GSoC admins](http://matrix-org.github.io/gsoc/#/mentors). 23 | -------------------------------------------------------------------------------- /gsod-ideas.md: -------------------------------------------------------------------------------- 1 | # Google Season of Docs Ideas 2 | 3 | * The Matrix Spec (https://matrix.org/docs/spec) is currently generated onto a single page per specification, and doesn't look good. Improve the layout of these pages by taking inspiration from the API documentation of other projects, and from tools such as Slate (https://github.com/lord/slate) 4 | * Update the Matrix specification documentation to contain more inline examples of usage of the various endpoints. For example, almost all endpoints are adequately described, but an improvement could be to add greater context to each section. 5 | * The Matrix Spec is a rapidly evolving living document. Work with the team to ensure that the Spec is up to date. 6 | * Create a series of documents which are "top-down" rather than "bottom-up". For example, take a real-world use case and write a tutorial or article explaining how Matrix would be used in solving it. -------------------------------------------------------------------------------- /_faq/steal-project-idea.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "What happens if someone steals my unique idea for solving a project?" 3 | --- 4 | The whole point of "Open Source Software" is to encourage celebration of 5 | complete independence in sharing and writing code. 6 | If you do honor original authors, licenses, and the "creator" of an original 7 | idea, there is no shame in saying "he had a great idea, I think I can implement 8 | it". 9 | It's called "collaboration". 10 | Note though, that not following licenses and not disclosing an original 11 | creator of something is considered stealing and can have legal consequences. 12 | On the plus side, we will always take into account who came up with something 13 | and if you help others succeed, we'll definitely credit you for that. 14 | Most importantly, we want our contributors to work as a team and not like some 15 | "lone hackers" keeping secrets from fellow contributors, and sending 16 | unnecessary private messages to the project mentors. 17 | 18 | -------------------------------------------------------------------------------- /old_projects/pyquotient.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: PyQuotient 3 | desc: Python bindings for libQuotient 4 | requirements: 5 | - "Necessary: C++11 and Qt" 6 | - "Helpful: C++17" 7 | - "Big plus: PySide/PyQt knowledge" 8 | difficulty: average 9 | issues: 10 | mentors: 11 | - KitsuneRal 12 | initiatives: 13 | - GSoC 14 | tags: 15 | - Python 16 | - Qt 17 | --- 18 | 19 | #### Description 20 | 21 | This is a relatively straightforward (especially if you have the right background - 22 | see the requirements) project to add Python bindings to libQuotient, a Qt-based 23 | library to make client applications for Matrix. You'll use Shiboken Generator to 24 | produce the wrappers in Python for libQuotient's classes and implement a basic 25 | client application in Python using these wrappers. 26 | 27 | #### Milestones 28 | 29 | ##### GSOC CODING STARTS 30 | 31 | * Produce the first draft of bindings and iterate on it. 32 | 33 | ##### GSOC MIDTERM 34 | 35 | * Make a minimal workable client application using PyQuotient modules. 36 | 37 | ##### GSOC FINAL 38 | 39 | * Advanced use of PyQuotient by adding functionality to the application. 40 | -------------------------------------------------------------------------------- /old_projects/dendrite-implement-and-extend-media-apis.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "Dendrite: Implement and extend media APIs" 3 | desc: "This involves implementing media endpoints over federation, as well as extending the APIs to support being backed by AWS S3 and an in-memory store for peer-to-peer in-browser servers." 4 | difficulty: "Hard" 5 | issues: 6 | - https://github.com/matrix-org/dendrite/issues/775 7 | - https://github.com/matrix-org/dendrite/issues/629 8 | - https://github.com/matrix-org/dendrite/issues/621 9 | mentors: 10 | - Kegsay 11 | - neilalexander 12 | initiatives: 13 | - GSoC 14 | tags: 15 | - Server 16 | - Dendrite 17 | --- 18 | 19 | [Dendrite](https://github.com/matrix-org/dendrite) is a work in progress matrix homeserver written in Go. 20 | 21 | This project involves implementing media endpoints over federation, as well as extending the APIs to support being backed by AWS S3 and an in-memory store for peer-to-peer in-browser servers. 22 | 23 | * S3 for mediaapi #775 24 | * Media API: Media metadata (hash, size…) aren't stored in db for media fetched remotely #629 25 | * Implement missing media APIs #621 26 | * in-memory gzip for p2p 27 | -------------------------------------------------------------------------------- /resources/vendors/markdown/markdown.js: -------------------------------------------------------------------------------- 1 | /* 2 | * angular-markdown-directive v0.3.1 3 | * (c) 2013-2014 Brian Ford http://briantford.com 4 | * License: MIT 5 | */ 6 | 7 | 'use strict'; 8 | 9 | angular.module('btford.markdown', ['ngSanitize']). 10 | provider('markdownConverter', function () { 11 | var opts = {}; 12 | return { 13 | config: function (newOpts) { 14 | opts = newOpts; 15 | }, 16 | $get: function () { 17 | return new Showdown.converter(opts); 18 | } 19 | }; 20 | }). 21 | directive('btfMarkdown', ['$sanitize', 'markdownConverter', function ($sanitize, markdownConverter) { 22 | return { 23 | restrict: 'AE', 24 | link: function (scope, element, attrs) { 25 | if (attrs.btfMarkdown) { 26 | scope.$watch(attrs.btfMarkdown, function (newVal) { 27 | var html = newVal ? $sanitize(markdownConverter.makeHtml(newVal)) : ''; 28 | element.html(html); 29 | }); 30 | } else { 31 | var html = $sanitize(markdownConverter.makeHtml(element.text())); 32 | element.html(html); 33 | } 34 | } 35 | }; 36 | }]); 37 | -------------------------------------------------------------------------------- /data/projects.liquid: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | [ 4 | {% for post in site.projects %} 5 | { 6 | "name" : "{{ post.name }}", 7 | "desc" : "{{ post.desc }}", 8 | "requirements" : [{% for req in post.requirements %}"{{ req }}"{% unless forloop.last %},{% endunless %} 9 | {% endfor %}], 10 | "difficulty" : "{{ post.difficulty }}", 11 | "issues" : [{% for post in post.issues %}"{{ post }}"{% unless forloop.last %},{% endunless %} 12 | {% endfor %}], 13 | "mentors" : [{% for mentor in post.mentors %}"{{ mentor }}" {% unless forloop.last %},{% endunless %}{% endfor %}], 14 | "initiatives" : [{% for initiative in post.initiatives %} "{{ initiative }}" {% unless forloop.last %},{% endunless %}{% endfor %}], 15 | "tags" : [{% for tag in post.tags %} "{{ tag }}"{% unless forloop.last %},{% endunless %}{% endfor %}], 16 | "collaborating_projects" : [{% for cp in post.collaborating_projects %}"{{ cp }}"{% unless forloop.last %},{% endunless %}{% endfor %}], 17 | "content_url" : "{{ post.url | remove_first:'/'}}", 18 | "path" : "{{post.path}}", 19 | "status" : [{% for status in post.status %} "{{ status }}" {% unless forloop.last %},{% endunless %}{% endfor %}], 20 | "markdown" : "{{post.path | replace: '_projects/',''}}" 21 | }{% unless forloop.last %},{% endunless %}{% endfor %} 22 | ] 23 | -------------------------------------------------------------------------------- /old_projects/fun-riot-features.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "Fun features for Riot-Web and Riot-iOS" 3 | desc: "Add new features to Riot-Web and Riot-iOS" 4 | difficulty: "Medium" 5 | issues: 6 | - https://github.com/matrix-org/matrix-react-sdk/pull/596 7 | mentors: 8 | - dbkr 9 | - giomfo 10 | - manuroe 11 | initiatives: 12 | - GSoC 13 | tags: 14 | - New Features 15 | - Riot 16 | - Client 17 | --- 18 | 19 | Riot is a flagship Matrix client; an Apache-licensed set of communication apps for Web (React), iOS & Android. Some nice refinements that would be good GSoC projects include: 20 | 21 | * Ability to share maps of locations! We have a PR from the community for Riot/Web (https://github.com/matrix-org/matrix-react-sdk/pull/596) - adding to mobile would be cool too! 22 | * Adding custom emojis to the message composer and timeline on all platforms! 23 | * Support for using multiple accounts simultaneously. 24 | * Quick actions on iOS for replying to notifications. 25 | * Rich-text Editor! Riot/Web has a Rich-text Editor thanks to GSoC 2016 - why not add to the mobile platforms? 26 | * Sending and displaying mathematics 27 | 28 | #### Expected Results 29 | 30 | Fun new features for mobile clients 31 | 32 | #### Knowledge pre-req 33 | 34 | iOS, Web dev (JavaScript and React) -------------------------------------------------------------------------------- /old_projects/dendrite-implement-registration-login-apis.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "Dendrite: Implement registration/login APIs" 3 | desc: "This involves implementing missing registration features, adding support for Application Services, shared secrets and Single Sign-On. This can be complemented by implementing the OpenID module." 4 | difficulty: "Hard" 5 | issues: 6 | - https://github.com/matrix-org/dendrite/issues/708 7 | - https://github.com/matrix-org/dendrite/issues/644 8 | - https://github.com/matrix-org/dendrite/issues/630 9 | - https://github.com/matrix-org/dendrite/issues/599 10 | mentors: 11 | - Kegsay 12 | - neilalexander 13 | initiatives: 14 | - GSoC 15 | tags: 16 | - Server 17 | - Dendrite 18 | --- 19 | 20 | [Dendrite](https://github.com/matrix-org/dendrite) is a work in progress matrix homeserver written in Go. 21 | 22 | This project involves implementing missing registration features, adding support for Application Services, shared secrets and Single Sign-On. This can be complemented by implementing the OpenID module. 23 | 24 | * Dendrite needs to care about login flow ordering #708 25 | * Implement missing registration features #644 26 | * Special case /register for application services #630 27 | * Implement OpenID module #599 28 | * impl rest of register/login APIs, SSO, etc 29 | -------------------------------------------------------------------------------- /old_projects/dendrite.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "Contribute to Dendrite" 3 | desc: "Dendrite is a work in progress matrix homeserver written in Go, help implement some aspect of the Matrix Federation API" 4 | difficulty: "Ranges from Easy through to Hard depending on the API!" 5 | issues: 6 | - https://github.com/matrix-org/dendrite/issues/671 7 | mentors: 8 | - erikjohnston 9 | - babolivier 10 | initiatives: 11 | - GSoC 12 | tags: 13 | - Server 14 | - Federation 15 | --- 16 | 17 | [Dendrite](https://github.com/matrix-org/dendrite) is a work in progress matrix homeserver written in Go. Being a large project there are many areas of the homeserver APIs that a GSoC project could work on, there is a [project board](https://github.com/matrix-org/dendrite/projects/2) that tracks the current implementation status of the various APIs. A good GSoC proposal would use this and discussion with mentors and the community to find an appropriate and realistic subset of these APIs to work on during the project. 18 | 19 | #### Expected Results 20 | 21 | Add implementations, unit tests & integration tests for an agreed set of missing APIs for Dendrite, based on the Matrix Spec and/or taking inspiration from the legacy Python implementation. 22 | 23 | #### Knowledge pre-req 24 | 25 | Good knowledge of Golang and HTTP/REST APIs in general. 26 | -------------------------------------------------------------------------------- /resources/css/404.css: -------------------------------------------------------------------------------- 1 | html, body { 2 | padding: 0; 3 | margin: 0; 4 | width: 100%; 5 | height: 100%; 6 | overflow-x: hidden; 7 | } 8 | main { 9 | display: flex; 10 | flex-direction: row; 11 | justify-content: center; 12 | align-items: center; 13 | background-color: #fafafa; 14 | } 15 | main .container { 16 | padding: 3% 5%; 17 | } 18 | .error { 19 | margin-left: -12.5%; 20 | font-family: "Open Sans","Helvetica Neue",Helvetica,Roboto,Arial,sans-serif; 21 | } 22 | .error .message { 23 | display: block; 24 | font-weight: bold; 25 | font-size: 4.5vw; 26 | color: #004D40; 27 | } 28 | .error p { 29 | font-size: 2vw; 30 | font-weight: 200; 31 | } 32 | .error p span { 33 | font-weight: 400; 34 | } 35 | .error .home { 36 | text-transform: uppercase; 37 | } 38 | .error .buttons { 39 | padding: 3%; 40 | } 41 | .coala-book { 42 | text-align: center; 43 | opacity: 0.85; 44 | } 45 | .coala-book img { 46 | width: 80%; 47 | } 48 | @media only screen and (max-width:760px) { 49 | main { 50 | flex-direction: column; 51 | } 52 | .error { 53 | margin-left: auto; 54 | text-align: center; 55 | } 56 | .error p { 57 | font-size: 3.5vw; 58 | } 59 | .coala-book img { 60 | width: 100%; 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /_projects/element_knocking.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Implement Support for Knocking in Element Web 3 | desc: Add support for Matrix's knocking feature in Element Web 4 | requirements: 5 | - Matrix Client-Server API familiarity 6 | - Javascript & React 7 | difficulty: high 8 | issues: 9 | - https://github.com/vector-im/element-web/issues/18655 10 | mentors: 11 | - kerryarchibald 12 | initiatives: 13 | - GSoC 14 | tags: 15 | - Javascript 16 | - React 17 | - 175h 18 | --- 19 | 20 | #### Description 21 | 22 | [Knocking](https://spec.matrix.org/v1.2/client-server-api/#knocking-on-rooms) 23 | is a feature added in version 1.1 of the Matrix specification which allows 24 | prospective members of a room to ask for an invite directly instead of having 25 | to go through alternative, out of band, means to get an invite. If their knock 26 | is accepted, they can join the room. 27 | 28 | Element Web/Desktop doesn't currently offer a way to knock on rooms 29 | easily though - the scope of this project would be to fix that, and to expose 30 | knocks to room moderators for review. 31 | 32 | #### Milestones 33 | 34 | ##### GSOC CODING STARTS 35 | 36 | * Have setup a local Element web development environment and made a small Pull 37 | Request to Element Web. 38 | 39 | ##### GSOC MIDTERM 40 | 41 | * Ability to send knocks from room directory and peeks, and alter room settings 42 | to allow people to knock. 43 | * Ability to respond to knocks as a room moderator
 44 | 45 | ##### GSOC FINAL 46 | 47 | * Ability to see your pending knocks somewhere 48 | -------------------------------------------------------------------------------- /old_projects/add-e2ee-to-more-clients.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "Adding end-to-end encryption to more clients" 3 | desc: "All Matrix clients should support end-to-end encryption" 4 | difficulty: "Hard" 5 | issues: 6 | mentors: 7 | - ara4n 8 | - uhoreg 9 | initiatives: 10 | - GSoC 11 | tags: 12 | - Encryption 13 | - Client 14 | --- 15 | 16 | A lot of effort in Matrix is being put into End-to-End Encryption using the Olm & Megolm cryptographic ratchets (as assessed by NCC Group - see https://matrix.org/blog/2016/11/21/matrixs-olm-end-to-end-encryption-security-assessment-released-and-implemented-cross-platform-on-riot-at-last/ for details. 17 | 18 | However, the current implementation has only landed in matrix-js-sdk, matrix-ios-sdk, matrix-android-sdk, and matrix-nio (Python). Some end-to-end encryption support is present in libQuotient (done as part of a previous GSoC project), nheko, fluffychat, and matrix-purple. As a result, any client or bridge or bot which isn't built on one of those codebases is currently out of luck. 19 | 20 | In this project, you would port the application-layer E2E implementation to one or more other clients - e.g. to Golang for use with go-neb, or complete the implementation for matrix-purple (as used by Pidgin). 21 | 22 | This would be a great way to improve your cryptography skills and learn about one of the most exciting and ambitious E2E cryptography projects out there. 23 | 24 | #### Expected Results 25 | 26 | Extend other Matrix clients to speak E2E 27 | 28 | #### Knowledge pre-req 29 | 30 | Cryptography. The language for the platform you are targetting. 31 | -------------------------------------------------------------------------------- /_faq/writing-a-great-proposal.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "How do I work out a great proposal?" 3 | --- 4 | Please design your project in a way that you have **multiple 5 | checkpoints**. We'd like you to specify at least three milestones with 6 | specific goals: if something goes wrong for a valid reason, we can rearrange 7 | your schedule meaningfully. 8 | You should be aware of what that involves for you (writing tests, writing docs, going 9 | through extensive code review, learning :), reiterating). 10 | 11 | You can use any project idea listed here or one that came out of your mind - 12 | however be sure to make us aware of your plans and start planning your project 13 | with us so we can coordinate and - in the worst case - prohibit waste of time 14 | from your side. At all cost make sure you find something that interests you. 15 | We want this to be a fun and educating experience for you! 16 | 17 | Use the"draft" feature on the GSoC system, submit your draft early, get a 18 | lot of helpful feedback from us! 19 | 20 | 21 | #### Writing the proposal 22 | 23 | Please follow the **application template** in the faq. All fields are required if not explicitly indicated otherwise. While following the application template you can consider doing an illustration of your proposed solution as it makes the application much more intuitive. 24 | 25 | For writing your proposal we recommend using [Google Docs](https://www.google.com/docs/about/) as this will be supported by the Google submission system. 26 | 27 | If needed, you can get further information about GSoC [here](http://write.flossmanuals.net/gsocstudentguide/what-is-google-summer-of-code/). 28 | -------------------------------------------------------------------------------- /_projects/rust-sdk-python-bindings.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Matrix-Rust-SDK-Python 3 | desc: Building Python bindings for using the Matrix Rust SDK 4 | requirements: 5 | # Student requirements: 6 | - Worked with Rust FFI 7 | - Familiar with building Python Bindings 8 | difficulty: medium 9 | issues: 10 | # Related issues (if any) to this project. 11 | mentors: 12 | # First person in contact; mentors may change before project starts. 13 | - Poljar 14 | initiatives: 15 | - GSoC 16 | tags: 17 | # Different technologies needed 18 | - Python 19 | - Rust 20 | - FFI 21 | - matrix-nio 22 | - 350h 23 | --- 24 | 25 | #### Description 26 | 27 | [matrix-nio](https://github.com/poljar/matrix-nio), a Python Matrix client 28 | library, lacks some important features, up-to-date cryptography, the ability to 29 | store state, support for reactions, etc. All of those missing features are 30 | supported by the new 31 | [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk). 32 | 33 | This project aims to create Python bindings for the Rust SDK and integrate them 34 | in the matrix-nio library. matrix-nio already contains multiple `Client` 35 | classes for different use-cases, the `AsyncClient` class API is similar to the 36 | Rust SDK API. The project should introduce a new `Client` class to `matrix-nio` 37 | which would replace the `AsyncClient` class. 38 | 39 | #### Milestones 40 | 41 | ##### GSOC CODING STARTS 42 | 43 | * Initial Python bindings for Rust SDK 44 | 45 | ##### GSOC MIDTERM 46 | 47 | * Integration into matrix-nio as a separate client implementation. 48 | 49 | ##### GSOC FINAL 50 | 51 | * Fully working matrix-nio backed by the Rust SDK 52 | -------------------------------------------------------------------------------- /_projects/_template.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Example Project 3 | desc: This is an awesome project idea 4 | # add a short one line description of your project 5 | requirements: 6 | # Student requirements: 7 | - Knowledge on spherical astronomy. 8 | - Familiar with numerical methods 9 | difficulty: low 10 | issues: 11 | # Related issues (if any) to this project. 12 | - https://github.com/matrix-org/synapse/issues/4556 13 | mentors: 14 | # First person in contact; mentors may change before project starts. 15 | - Cadair 16 | initiatives: 17 | - GSoC 18 | tags: 19 | # Different technologies needed 20 | - python 21 | - GUI 22 | --- 23 | This is an awesome project idea. 24 | 25 | #### Description 26 | 27 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus aliquam 28 | turpis neque, vel fermentum diam gravida id. Maecenas tempor magna libero, non 29 | faucibus dolor tincidunt non. Sed condimentum imperdiet odio sed volutpat. 30 | Mauris imperdiet viverra turpis a porttitor. Duis laoreet leo sit amet odio 31 | suscipit aliquet. Etiam vel malesuada est, in molestie nibh. Sed efficitur 32 | pharetra lorem, sed tempor sapien commodo ac. Vivamus sollicitudin pretium erat. 33 | Pellentesque luctus vehicula tortor, nec volutpat turpis euismod vel. Sed neque 34 | ipsum, imperdiet nec massa sit amet, accumsan lobortis augue. Donec luctus massa 35 | vitae velit scelerisque volutpat ut nec ex. Sed in velit tincidunt, volutpat 36 | turpis sit amet, dignissim nisi. Donec a mattis eros. Pellentesque vitae leo 37 | quam. 38 | 39 | #### Milestones 40 | 41 | ##### GSOC CODING STARTS 42 | 43 | * Be awesome 44 | 45 | ##### GSOC MIDTERM 46 | 47 | * Have done awesome stuff. 48 | 49 | ##### GSOC FINAL 50 | 51 | * Finished the awesome stuff. 52 | -------------------------------------------------------------------------------- /old_projects/quotient-embed-dendrite.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Peer-to-peer Quotient 3 | desc: Embed a homeserver into libQuotient 4 | requirements: 5 | - Good C++11 (C++17 is a plus) 6 | - Basic knowledge of Qt (QObject, signals/slots) 7 | - Understanding of Matrix architecture 8 | - Backround in p2p systems is a plus 9 | - Experience in Dendrite configuration is a big plus 10 | difficulty: high 11 | issues: 12 | mentors: 13 | - KitsuneRal 14 | initiatives: 15 | - GSoC 16 | tags: 17 | - Qt 18 | - Golang 19 | --- 20 | 21 | #### Description 22 | 23 | One of the actively researched areas in Matrix is making it work in peer-to-peer 24 | setting, when a homeserver resides right next to the client and the two are 25 | deployed together. Dendrite has recently reached a good level of feature parity 26 | to participate in the public federation, and has been used for experiments 27 | to embed a homeserver in a web-based Matrix client. 28 | 29 | libQuotient is a client-side library based on Qt to interact with Matrix servers. 30 | You're invited to repeat the exercise with embedding Dendrite, this time into 31 | a desktop client. You can use either Quaternion or NeoChat as the client 32 | application to bundle Dendrite with. 33 | 34 | #### Milestones 35 | 36 | ##### GSOC CODING STARTS 37 | 38 | * Learn what's been done on the topic of embedding homeservers so far 39 | * Get familiar with libQuotient and the client application code base 40 | 41 | ##### GSOC MIDTERM 42 | 43 | * Show a fixed homeserver configuration deployed and managed together with a client 44 | 45 | ##### GSOC FINAL 46 | 47 | * Complete a distributable package of Dendrite and the client application that 48 | installs and provides necessary configuration controls to run both as a whole. 49 | -------------------------------------------------------------------------------- /old_projects/quaternion-timeline-navigation.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Better timeline navigation in Quaternion 3 | desc: Introduce new ways of moving around vast numbers of events in the timeline 4 | requirements: 5 | - QML 6 | - Understanding of usability (UI design/UX) concepts 7 | - C++11 (desirable) 8 | difficulty: low to average 9 | issues: 10 | mentors: 11 | - KitsuneRal 12 | initiatives: 13 | - GSoC 14 | tags: 15 | - Qt 16 | - QML 17 | - GUI 18 | --- 19 | 20 | #### Description 21 | 22 | Traditional scrollbars don't work well with extremely long (1000's of events) 23 | timelines: they don't guide you across days, periods of more active and less 24 | active conversation. They also have another technical issue: since events are 25 | usually rendered dynamically, the timeline "canvas" constantly changes its 26 | height, leading to erratic movements of the scrollbar. One of desktop clients, 27 | Quaternion, has an unconventional navigation control - shuttle dial - to deal 28 | with the latter problem; but it still doesn't address the former one. This 29 | project is an opportunity to work out a way to efficiently move around long 30 | timelines without resorting to hit-and-miss clicks on the scrollbar. 31 | If successful, the result may become a source of inspiration not only for other 32 | Qt-based clients (NeoChat, Nheko) but also web-based ones, such as Element! 33 | 34 | #### Milestones 35 | 36 | ##### GSOC CODING STARTS 37 | 38 | * Get acquainted with the problem and map out possible research areas 39 | * Investigate available prior art in navigating long feeds. 40 | 41 | ##### GSOC MIDTERM 42 | 43 | * Implement a proof of concept for the navigation control. 44 | 45 | ##### GSOC FINAL 46 | 47 | * Complete implementation of the navigation control within Quaternion. 48 | -------------------------------------------------------------------------------- /old_projects/bifrost.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: New backends for Bifrost 3 | desc: Connect other protocols to Matrix using the new Bifrost bridge! 4 | requirements: 5 | # Student requirements: 6 | - Keen interest in bridging networks together 7 | difficulty: Medium 8 | issues: 9 | mentors: 10 | # First person in contact; mentors may change before project starts. 11 | - Half-Shot 12 | initiatives: 13 | - GSoC 14 | tags: 15 | - Node.JS 16 | - Typescript 17 | - Bridges 18 | --- 19 | Bifrost is a new bridge for Matrix, which lets Matrix users chat to people on 20 | other protocols seamlessly. It is designed to work with multiple protocols 21 | and currently supports XMPP, and basic support for a variety of libpurple protocols. 22 | 23 | The project uses various "backends" to connect protocols up, which 24 | are abstracted away from the Matrix code. You can hack away support for your favorite 25 | protocol in isolation from the Matrix code, and then simply run it. 26 | 27 | #### And this is where you come in 28 | 29 | We need more backends to other networks on the bridge, as well as more refinements 30 | to Bifrost itself. Existing bridges can be found on 31 | https://matrix.org/docs/projects/bridges which might be useful. There is also 32 | a [wishlist](https://github.com/turt2live/matrix-wishlist/issues?q=is%3Aopen+is%3Aissue+label%3Abridge) 33 | of protocols that could be added to the bridge. 34 | 35 | A familiarity with Node.JS or Javascript will be helpful to you, but this is not 36 | a hard requirement. 37 | 38 | #### Expected Results 39 | The output of this project should be a somewhat stable backend 40 | which can be used to talk to another protocol. Any features or bug fixes to 41 | Bifrost's Matrix layers are a bonus! 42 | 43 | Please check out https://github.com/matrix-org/matrix-bifrost for information 44 | on the project. 45 | -------------------------------------------------------------------------------- /old_projects/exporting-conversations.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Exporting Conversations 3 | desc: Add support for exporting conversations from Element in a variety of formats. 4 | # add a short one line description of your project 5 | requirements: 6 | # Student requirements: 7 | - Understanding of Matrix fundamentals such as rooms & events 8 | - Familiarity with Web technologies 9 | difficulty: medium 10 | issues: 11 | # Related issues (if any) to this project. 12 | - https://github.com/vector-im/element-web/issues/2630 13 | mentors: 14 | # First person in contact; mentors may change before project starts. 15 | - t3chguy 16 | initiatives: 17 | - GSoC 18 | tags: 19 | # Different technologies needed 20 | - TypeScript 21 | - ES6 22 | --- 23 | This is an awesome project idea. 24 | 25 | #### Description 26 | 27 | Whilst Matrix & Element are obviously great, 28 | sometimes you need to export your chat history 29 | to share with outsiders, for print, or archival 30 | purposes. Encryption makes this even harder as 31 | you can't just simply and safely run an external 32 | tool for this. 33 | https://github.com/russelldavies/matrix-archive/ 34 | is such an existing tool but this is not massively 35 | user friendly. 36 | 37 | In this project you would add the ability for Element 38 | to be able to export chat history for a given room & 39 | period of time into a format (or formats) of your choosing. 40 | 41 | #### Milestones 42 | 43 | ##### GSOC CODING STARTS 44 | 45 | * Plan which output formats to implement 46 | * Plan what the code will do 47 | 48 | ##### GSOC MIDTERM 49 | 50 | * Write up a simple export tool for the chosen format for a single room which only considers the loaded timeline 51 | 52 | ##### GSOC FINAL 53 | 54 | * Extend the implementation to support going back until a chosen start date to export a longer period of time 55 | 56 | ##### Stretch Goals 57 | 58 | * Multiple output formats 59 | -------------------------------------------------------------------------------- /old_projects/maths.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Maths support 3 | desc: Add support for sending an displaying messages with mathematical notation. 4 | requirements: 5 | # Student requirements: 6 | - Python 7 | - JavaScript 8 | difficulty: easy 9 | issues: 10 | # Related issues (if any) to this project. 11 | - https://github.com/vector-im/riot-web/issues/1945 12 | - https://github.com/matrix-org/matrix-doc/pull/2191 13 | mentors: 14 | # First person in contact; mentors may change before project starts. 15 | - uhoreg 16 | - Cadair 17 | initiatives: 18 | - GSoC 19 | tags: 20 | # Different technologies needed 21 | - MathJax 22 | - python 23 | - javascript 24 | --- 25 | #### Description 26 | 27 | The ability to send messages with mathematical notation is a frequently 28 | requested feature in Matrix and Riot. The [riot-web 29 | issue](https://github.com/vector-im/riot-web/issues/1945) is one of the issues 30 | with the most thumbs up reactions in riot-web. Implementing the ability send 31 | mathematical notation would require ensuring that it is done in a way that is 32 | consistent with the Matrix specification, and ensuring that other receiving 33 | clients display something usable to users, even if they don't have maths 34 | support built-in. 35 | 36 | A [Matrix spec change 37 | proposal](https://github.com/matrix-org/matrix-doc/pull/2191) has been made for 38 | adding this capability, and a [partial 39 | implementation](https://github.com/matrix-org/matrix-react-sdk/pull/3251) has 40 | been made. 41 | 42 | In this project, you would pick a client, or multiple clients, to implement 43 | maths support in. There may be a server-side component to the work, as one 44 | possibility is to add an endpoint in the homeserver to render an image of the 45 | mathematical notation, to help clients in generating a fallback representation. 46 | 47 | #### Expected Results 48 | 49 | Extend one or more Matrix clients to allow users to write messages with 50 | mathematical notation, and to display messages written by others. 51 | -------------------------------------------------------------------------------- /old_projects/html-embeddable-chat-rooms.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "HTML Embeddable Matrix Chat Rooms" 3 | desc: "Create an embeddable component backed by a Matrix-room" 4 | difficulty: "Medium" 5 | issues: 6 | mentors: 7 | - dbkr 8 | initiatives: 9 | - GSoC 10 | tags: 11 | - New Features 12 | - Riot 13 | - Client 14 | --- 15 | 16 | Blogs and articles that allow users to engage with the author and comment on the content are standard in today's web and hugely popular. The implementations of these are largely from the authors of the blog or often completely proprietary in the case of newspaper or magzine articles. If I comment on a article and start discussing it with someone else, I now have to keep going back to that article to continue the discussion. 17 | 18 | Matrix could be used as a platform where users can arrive at a random website, sign in with their Matrix ID, comment on a blog post or article and then continue that discussion through a standard Matrix client. 19 | 20 | #### Expected Results 21 | 22 | Create a reusable web component that a website author can download, style/theme, and embed into their website to make comments work with minimal integration difficulty. Could require user to log in with a matrix account to post (so your Matrix account would let you post comments on any website which used this), or support anonymous guest access. 23 | 24 | The blog author would be able to add their own comments and moderate comments. VoIP and Video calling support would be an added bonus. Other extensions would be plugins for blogging platforms so users of WordPress or similar can use the software on their blogs by just installing the plugin. 25 | 26 | There is some related prior art at https://live.hello-matrix.net/ and https://github.com/Half-Shot/matrix-gsoc-bark but neither of these are specifically for embedded rooms. 27 | 28 | There are different ways to complete this task, but the most natural would be to extend https://github.com/matrix-org/matrix-react-sdk to be able to create an embeddable component. It is also possible to use https://github.com/matrix-org/matrix-js-sdk for a lower-level implementation. 29 | 30 | #### Knowledge pre-req 31 | 32 | HTML, Javascript, React, Web dev -------------------------------------------------------------------------------- /old_projects/hydrogen.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Hydrogen 3 | desc: Various suggested improvements for Hydrogen 4 | requirements: 5 | - modern javascript, indexeddb & service workers 6 | difficulty: varies 7 | issues: 8 | mentors: 9 | - bwindels 10 | initiatives: 11 | - GSoC 12 | tags: 13 | - Client 14 | - JavaScript 15 | --- 16 | 17 | Hydrogen is an alternative matrix client developed by Element. We want to gear Hydrogen a bit more towards personal communication, where Element Web/Desktop is geared more towards group communication. It aims to be fast, lightweight, embeddable and available on a multitude of platforms, especially mobile, by being a great Progressive Web Application. Most contributions towards this goal will be welcome, here some possible ideas: 18 | 19 | * Alternative login methods like SSO/social login 20 | * Reactions, edits, redactions or replies 21 | * Create an SDK from the existing code to be used inside and outside the project 22 | * Room management (accept invites, join public room, leave room, …) 23 | * Add right panel with room details, member list & member details 24 | * Improve room list (split by DM/rooms, show last message, …) 25 | * Better theming support 26 | * Read receipts 27 | * Timeline improvements 28 | * Improve accessibility 29 | * Better gesture support on touch screens 30 | * ... 31 | 32 | Some of these are big topics, and any applicant wouldn’t necessarily be expected to complete the whole thing, let alone multiple items on the list. 33 | 34 | While contributing to this project, you’ll likely also learn a lot about matrix, open source, web development, building performant software, and write code that works on a lot of browsers. 35 | 36 | 37 | #### Before GSOC 38 | 39 | If possibly, familiarize yourself with modern javascript, indexeddb & service workers. 40 | 41 | 42 | #### GSOC coding starts 43 | 44 | 45 | 46 | * Start out building some confidence by digging into some “good-first-issue” tickets 47 | * Together with your mentor, pick a large topic you feel motivated by, or keep fixing bugs if that’s your thing 48 | 49 | 50 | #### Contacts 51 | 52 | 53 | 54 | * Simply join the dedicated room on Matrix: [#hydrogen-gsoc:matrix.org](https://matrix.to/#/#hydrogen-gsoc:matrix.org) -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | GEM 2 | remote: https://rubygems.org/ 3 | specs: 4 | addressable (2.8.0) 5 | public_suffix (>= 2.0.2, < 5.0) 6 | colorator (1.1.0) 7 | concurrent-ruby (1.1.9) 8 | em-websocket (0.5.3) 9 | eventmachine (>= 0.12.9) 10 | http_parser.rb (~> 0) 11 | ethon (0.15.0) 12 | ffi (>= 1.15.0) 13 | eventmachine (1.2.7) 14 | ffi (1.15.5) 15 | forwardable-extended (2.6.0) 16 | html-proofer (3.19.3) 17 | addressable (~> 2.3) 18 | mercenary (~> 0.3) 19 | nokogiri (~> 1.12) 20 | parallel (~> 1.3) 21 | rainbow (~> 3.0) 22 | typhoeus (~> 1.3) 23 | yell (~> 2.0) 24 | http_parser.rb (0.8.0) 25 | i18n (0.9.5) 26 | concurrent-ruby (~> 1.0) 27 | jekyll (3.9.1) 28 | addressable (~> 2.4) 29 | colorator (~> 1.0) 30 | em-websocket (~> 0.5) 31 | i18n (~> 0.7) 32 | jekyll-sass-converter (~> 1.0) 33 | jekyll-watch (~> 2.0) 34 | kramdown (>= 1.17, < 3) 35 | liquid (~> 4.0) 36 | mercenary (~> 0.3.3) 37 | pathutil (~> 0.9) 38 | rouge (>= 1.7, < 4) 39 | safe_yaml (~> 1.0) 40 | jekyll-netlify (0.2.0) 41 | jekyll (~> 3.0) 42 | jekyll-sass-converter (1.5.2) 43 | sass (~> 3.4) 44 | jekyll-watch (2.2.1) 45 | listen (~> 3.0) 46 | kramdown (2.3.1) 47 | rexml 48 | kramdown-parser-gfm (1.1.0) 49 | kramdown (~> 2.0) 50 | liquid (4.0.3) 51 | listen (3.7.1) 52 | rb-fsevent (~> 0.10, >= 0.10.3) 53 | rb-inotify (~> 0.9, >= 0.9.10) 54 | mercenary (0.3.6) 55 | mini_portile2 (2.7.1) 56 | nokogiri (1.13.1) 57 | mini_portile2 (~> 2.7.0) 58 | racc (~> 1.4) 59 | parallel (1.21.0) 60 | pathutil (0.16.2) 61 | forwardable-extended (~> 2.6) 62 | public_suffix (4.0.6) 63 | racc (1.6.0) 64 | rainbow (3.1.1) 65 | rb-fsevent (0.11.1) 66 | rb-inotify (0.10.1) 67 | ffi (~> 1.0) 68 | rexml (3.2.5) 69 | rouge (3.28.0) 70 | safe_yaml (1.0.5) 71 | sass (3.7.4) 72 | sass-listen (~> 4.0.0) 73 | sass-listen (4.0.0) 74 | rb-fsevent (~> 0.9, >= 0.9.4) 75 | rb-inotify (~> 0.9, >= 0.9.7) 76 | typhoeus (1.4.0) 77 | ethon (>= 0.9.0) 78 | webrick (1.7.0) 79 | yell (2.2.2) 80 | 81 | PLATFORMS 82 | ruby 83 | 84 | DEPENDENCIES 85 | html-proofer 86 | jekyll 87 | jekyll-netlify 88 | kramdown-parser-gfm 89 | webrick (~> 1.7) 90 | 91 | RUBY VERSION 92 | ruby 3.1.0p0 93 | 94 | BUNDLED WITH 95 | 1.16.2 96 | -------------------------------------------------------------------------------- /resources/css/style.css: -------------------------------------------------------------------------------- 1 | .hash_value_dup { 2 | position: 'absolute'; 3 | left: '-9999px'; 4 | } 5 | .hinttext { 6 | visibility: hidden; 7 | width: 120px; 8 | background-color: gray; 9 | color: #fff; 10 | text-align: center; 11 | padding: 5px 0; 12 | border-radius: 6px; 13 | position: absolute; 14 | z-index: 1; 15 | top: 95%; 16 | left: 60%; 17 | margin-left: -60px; 18 | } 19 | .hinttext::after { 20 | content: " "; 21 | position: absolute; 22 | bottom: 100%; 23 | left: 50%; 24 | margin-left: -5px; 25 | border-width: 5px; 26 | border-style: solid; 27 | border-color: transparent transparent gray transparent; 28 | } 29 | .fa-clipboard:hover { 30 | cursor: pointer; 31 | } 32 | .fa-clipboard:hover .hinttext { 33 | visibility: visible; 34 | } 35 | .project-detail-element > .clickable:hover, .clickable:hover .chip:hover { 36 | cursor: pointer; 37 | background-color: #f3f5f8; 38 | } 39 | .report .card { 40 | box-shadow: 0 1px 1px 0 rgba(0, 0, 0, 0.0), 0 1px 1px 0 rgba(0, 0, 0, 0.0), 0 1px 1px 0px rgba(0, 0, 0, 0.05); 41 | margin-bottom: 0 !important; 42 | } 43 | .report { 44 | background-color: #f3f5f8; 45 | } 46 | .report .card .card-content { 47 | padding: 12px; 48 | } 49 | .report .link { 50 | padding: 0.5em; 51 | } 52 | .tab { 53 | cursor: pointer; 54 | } 55 | .report .fullh { 56 | height: 100%; 57 | } 58 | .report .blog-title { 59 | letter-spacing: 0.1em; 60 | font-weight: 500; 61 | text-align: center; 62 | } 63 | .report .links-section a { 64 | text-decoration: none; 65 | color: lightslategray; 66 | padding: 0.1em; 67 | } 68 | .report .row { 69 | display: -webkit-box; 70 | display: -webkit-flex; 71 | display: -ms-flexbox; 72 | display: flex; 73 | flex-wrap: wrap; 74 | } 75 | .report .row > [class*='col'] { 76 | display: flex; 77 | flex-direction: column; 78 | } 79 | .report .flex1 { 80 | flex: 1; 81 | } 82 | .report .activity { 83 | white-space: pre; 84 | } 85 | .report .fl { 86 | background: lightcyan; 87 | text-align: center; 88 | } 89 | .report .card { 90 | word-break: break-word; 91 | } 92 | .report td p { 93 | display: inline; 94 | } 95 | .report .padding-table tbody tr { 96 | border-bottom: 1px solid aliceblue; 97 | } 98 | @media only screen and (min-width: 993px) { 99 | .container { 100 | width: 90% !important; 101 | } 102 | .for-mobile { 103 | display: none; 104 | } 105 | } 106 | @media only screen and (max-width: 992px) { 107 | .for-non-mobile { 108 | display: none; 109 | } 110 | } 111 | .ribbon { 112 | position: absolute; 113 | top: 0; right: 0; 114 | border: 0; 115 | z-index: 9; 116 | } 117 | .sha256sum_hash { 118 | display: flex; 119 | justify-content: space-evenly; 120 | } 121 | .theatre .name { 122 | padding-left: 0.5em; 123 | padding-right: 0.5em; 124 | } 125 | 126 | #sha256sum_hash_value { 127 | word-wrap: break-word; 128 | } 129 | -------------------------------------------------------------------------------- /old_projects/email-bridge.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: First-Class Email Bridge 3 | desc: Build a gateway-style email bridge to Matrix 4 | requirements: 5 | - Keen interest in bridging networks together 6 | difficulty: Hard 7 | issues: 8 | mentors: 9 | - Half-Shot 10 | initiatives: 11 | - GSoC 12 | tags: 13 | - Node.JS 14 | - Typescript 15 | - Bridges 16 | - Email 17 | - SMTP 18 | --- 19 | 20 | Email is one of the most ubiquitous methods on the internet to communicate today, having 21 | been around for a very long time. It's been a dream of ours that that one day Matrix 22 | could be connected up to Email by translating incoming [SMTP](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol) 23 | traffic to Matrix messages, and then bridging Matrix messages back into emails. 24 | 25 | Matrix has a long history of being the best place to bridge different networks together. It 26 | has a [rich ecosystem of bridges](https://matrix.org/bridges/), making full use of the 27 | [Application Service API](https://matrix.org/docs/spec/application_service/r0.1.2). There 28 | are some Email bridges in existence already but here we are looking for someone to go 29 | above and beyond and build a native SMTP - Email bridge. 30 | 31 | ### And this is where you come in 32 | 33 | We'd like you to build a Email bridge to Matrix. This would ideally take the form of a 34 | bridge process that handles its own SMTP traffic rather than using an existing mail 35 | server, and would bridge messages to and from Matrix rooms based upon the room membership 36 | rather than any kind of storage in the bridge. This is typically what we call a gateway 37 | bridge where the user has to do no extra configuration to make rooms magically bridge! 38 | 39 | Ideally, a user could send an email to an address like `room+matrix_matrix.org@matrix.org` 40 | and the user would be automatically joined to `#matrix:matrix.org`, and the message 41 | would appear in the room. The user would also be subscribed to the room similar to a 42 | mailing list so they could see responses. In a similar vein, you could add support for sending 43 | DMs via an email to `user+alice_matrix.org@matrix.org`. 44 | 45 | Several base libraries exist such as: 46 | - [matrix-appservice-bridge](https://github.com/matrix-org/matrix-appservice-bridge/) (Typescript/JavaScript) 47 | - [matrix-bot-sdk](https://github.com/turt2live/matrix-bot-sdk) (Typescript/JavaScript) 48 | - [mautrix-go](https://github.com/tulir/mautrix-go) (Go) 49 | - Or any other library that supports the appservice API 🚀 50 | 51 | ### Expected Results 52 | 53 | At its most basic form, the bridge would be able to send messages to a Matrix room 54 | and send messages from a Matrix room to a set of subscribers. There is scope for extra 55 | features like HTML handling, attachments, End-2-End encryption support and more though! 56 | 57 | Come hang out and chat to us in [#bridges:matrix.org](https://matrix.to/#/#bridges:matrix.org?via=half-shot.uk&via=matrix.org&via=vector.modular.im) 58 | and take a look at the bridges listed on [matrix.org](https://matrix.org) to see if you'd 59 | like to give this one a shot! 60 | -------------------------------------------------------------------------------- /partials/tabs/mentors.html: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |
5 |

Hello there!

6 |

7 | We are the mentors for matrix.org in GSoC 2023. 8 |

9 |

10 | Just drop a message in #gsoc:matrix.org 11 |

12 |
13 |
14 |
15 |
16 |
17 | 35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |

Admins

43 |

44 | We are the admins for matrix.org in GSoC 2023. 45 |

46 |

47 | Just drop a message in #gsoc:matrix.org 48 |

49 |
50 |
51 |
52 |
53 |
54 | 72 |
73 |
74 | -------------------------------------------------------------------------------- /old_projects/opsdroid.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Enabling End to End Encryption in Opsdroid 3 | desc: Opsdroid is a Python bot framework, by transitioning the matrix connector to use matrix-nio e2ee support can be added. 4 | requirements: 5 | - Python 6 | difficulty: low 7 | issues: 8 | - https://github.com/opsdroid/opsdroid/issues/992 9 | mentors: 10 | - Cadair 11 | - SolarDrew 12 | - jacobtomlinson 13 | initiatives: 14 | - GSoC 15 | tags: 16 | - Python 17 | - asyncio 18 | collaborating_projects: 19 | - opsdroid 20 | --- 21 | 22 | #### Description 23 | 24 | Opsdroid is a bot framework which works with many chat services, such as matrix, slack, telegram. 25 | It aims to have a very low barrier to entry and be very user friendly. 26 | The support for these different services are implemented in modules named "connectors", the matrix connector currently uses an [asyncio wrapper](https://github.com/Cadair/matrix_api_async) around the [matrix-python-sdk](https://github.com/matrix-org/matrix-python-sdk). 27 | This SDK is largely unmaintained and a more modern Python SDK [matrix-nio](https://github.com/poljar/matrix-nio) has been created in that time, which powers projects like [pantalaimon](https://github.com/matrix-org/pantalaimon/) and [weechat-matrix](https://github.com/poljar/weechat-matrix). 28 | As well as being a more modular SDK with pluggable IO support, this SDK also has well tested and complete end to end encryption support, which would be a great addition to opsdroid. 29 | 30 | 31 | The main component of this project would be to transition the opsdroid matrix connector to use matrix-nio and update all tests, documentation and official skills to use the new APIs. 32 | Having achieved this, you should write a how to get started with opsdroid and matrix in an accessible guide, with an introduction to using end to end encryption. 33 | 34 | In addition to this there are multiple other ways the matrix support in opsdroid could be extended, some ideas (in increasing order of complexity) are: 35 | 36 | * Update [database-matrix](https://github.com/solardrew/database-matrix) to use matrix-nio and integrate it into core. 37 | * Support .well-known lookups for the client-server API endpoint. 38 | * Support room upgrades. 39 | * Add support for sending and receiving all common matrix event types. 40 | * Improving user documentation of how different events are handled [#1293](https://github.com/opsdroid/opsdroid/issues/1293). 41 | * Develop a scheme for device verification with the bot user. 42 | * Develop a matrix connector which can utilise the appservice API. 43 | 44 | 45 | #### Milestones 46 | 47 | Below is an example timeline for this project, it prioritises the matrix-nio transition and does a couple of extra improvements after that. 48 | 49 | ##### Before GSOC 50 | 51 | * Get familiar with the opsdroid codebase, make a Pull Request and write a skill. 52 | 53 | ##### GSOC CODING STARTS 54 | 55 | * Transition the connector code over to `matrix-nio`. 56 | * Work through the unit tests to update them for the new library, improving them as you go. 57 | 58 | ##### GSOC MIDTERM 59 | 60 | * Update and integrate [database-matrix](https://github.com/solardrew/database-matrix) into core. 61 | * Documentation, covering docstrings in the connector, narrative documentation in opsdroid and guides for the opsdroid or matrix.org website. 62 | 63 | ##### GSOC FINAL 64 | 65 | * Add more events to the matrix connector. 66 | * Add support for well-known lookups. 67 | -------------------------------------------------------------------------------- /old_projects/nheko-room-upgrades.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Room Upgrade Support for Nheko 3 | desc: Implement a visually pleasing way to handle upgraded rooms and upgrade rooms in Nheko. 4 | requirements: 5 | - C++, some understanding of lambdas and C++17's std::variant will be beneficial 6 | - Qt, mainly Qml and Models 7 | difficulty: medium 8 | issues: 9 | mentors: 10 | - redsky17 11 | - deepbluev7 12 | initiatives: 13 | - GSOC 14 | tags: 15 | - C++ 16 | - GUI 17 | collaborating_projects: 18 | - Nheko 19 | --- 20 | 21 | #### Description 22 | 23 | Nheko is a native Matrix client written in C++ using the Qt toolkit using a mix of Qt Widgets and Qml. It uses the [mtxclient](https://github.com/Nheko-Reborn/mtxclient) Matrix 24 | library as in the backend, which is based on Boost.Asio and Boost.Beast. Nheko does support E2EE and other advanced matrix features. 25 | 26 | Rooms in Matrix are distributed over multiple servers. To handle such a heterogenous server infrastructure, rooms have a version. This specifies how a server should handle certain 27 | things regarding state resolution, default values and more. From time to time it may be necessary to upgrade a room to fix issues. This means, that the old room gets "thombstoned" 28 | and should effectively be read only, while a new successor room is created, that inherits some of the old state and can be used to continue the conversation. 29 | 30 | Currently both of those rooms are shown as regular rooms in nheko, which can be very confusing and disruptive. It would be preferable to show them as a single room, which can be 31 | scrolled seamlessly. Nheko should make this experience as pleasant as possible. State resets or members leaving the old room shouldn't disrupt the new room for example. You should 32 | also be possible to upgrade a room using Nheko. 33 | 34 | #### Contacts 35 | 36 | You can reach the mentors for questions via Matrix in the #nheko-reborn:matrix.org room or directly: 37 | - red_sky (@red_sky:ocean.joedonofry.com) 38 | - Nico (@deepbluev7:neko.dev) 39 | 40 | #### Milestones 41 | 42 | The milestones are just a general timeline, you may want to move some elements to a closer milestone to have more time for fixing bugs in the last few weeks, since time can be an 43 | issue shortly before the deadline. 44 | 45 | ##### Before GSOC 46 | 47 | * Get familiar with the concept of rooms, room versions and upgrades. The [spec for room upgrades may be helpful](https://matrix.org/docs/spec/client_server/latest#id160). Also ask 48 | around, what pitfalls others experience with room upgrades. 49 | * Join #nheko-reborn:matrix.org and get to know the contributors and community. 50 | * Clone the [nheko repo](https://github.com/Nheko-Reborn/nheko/) and compile the current dev branch. 51 | * Maybe you can find something small to contribute to get familiar with the code, development and the contribution process. There is probably a typo or a bad ui layout somewhere in the 52 | code. 53 | 54 | ##### GSOC CODING STARTS 55 | 56 | * Add the request for upgrading a room to mtxclient including unit tests. 57 | * Implement upgrading a room, by adding a respective command or button to Nheko, probably in the room settings. 58 | * Get familiar with the relation of room creation and thombstone events. 59 | 60 | ##### GSOC MIDTERM 61 | 62 | * Extend the timeline to allow events from multiple rooms. 63 | * Show a visual distinction where the break between the rooms is. 64 | * Implement paginating old messages in a room, even over a room upgrade boundary. 65 | 66 | ##### GSOC FINAL 67 | 68 | * Fix the remaining issues with room upgrades, so that all features work in upgraded rooms as usual. 69 | * Consider allowing the user to invite old users, when upgrading invite only rooms. 70 | * Make sure upgraded rooms don't appear twice in the room list 71 | * Maybe use the cache more agressively for messages. 72 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | 4 | 5 | 6 | 7 | {{ site.title }} 8 | {% if jekyll.environment != "production" %} 9 | - Development {{ site.netlify.context }} - {{ site.netlify.branch }} @ {{ site.netlify.commit }} 10 | {% endif %} 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 |
35 |
36 |
37 |
38 |
39 | 47 |
48 |
49 |
50 |
51 |
52 |
53 | 55 |
56 |
57 | 60 | 61 | 62 | 63 | 64 | 65 | 72 | 79 | -------------------------------------------------------------------------------- /old_projects/nheko-polish.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Polish Nheko 3 | desc: Add features and polish existing features, that make Nheko useable as someone's/your primary client. 4 | requirements: 5 | - C++, some understanding of lambdas and C++17's std::variant will be beneficial 6 | - Qt, mainly Qml and Models 7 | difficulty: easy 8 | issues: 9 | mentors: 10 | - redsky17 11 | - deepbluev7 12 | initiatives: 13 | - GSOC 14 | tags: 15 | - C++ 16 | - GUI 17 | collaborating_projects: 18 | - Nheko 19 | --- 20 | 21 | #### Description 22 | 23 | Nheko is a native Matrix client written in C++ using the Qt toolkit using a mix of Qt Widgets and Qml. It uses the [mtxclient](https://github.com/Nheko-Reborn/mtxclient) Matrix 24 | library as in the backend, which is based on Boost.Asio and Boost.Beast. Nheko does support E2EE and other advanced matrix features. 25 | 26 | Nheko added a lot of big features recently, but it is missing a lot of smaller features. This lack of smaller features pushes folks to Element and other clients. 27 | There are a lot of open GitHub issues for a lot of these features, but for others they don't exist. Asking around should yield enough results. You can also 28 | just check, which features you are missing personally. An unordered list of what this could include: 29 | 30 | - Set and show canonical and secondary aliases for rooms. 31 | - Edit power_levels. 32 | - Restrict certain actions, if a user does not have the power to do them. 33 | - View user profiles from the member list in a room. 34 | - Manage logged in devices. 35 | - Fix theming issues on different platforms. 36 | - You should be able to autocomplete room names, aliases and `/commands`. 37 | - Read markers are don't always behave as a user would expect (rooms not being marked read correctly and such). 38 | - Improve scrolling behaviour (on mobile especially). 39 | - Improve behaviour on network loss. For example: 40 | - Improve UI for notifying the user that they are offline 41 | - Sometimes the client stops receiving new messages until restart when network communications are lost 42 | - Improve support for mobile and touch devices (like the PinePhone). 43 | 44 | This list of issues is not definitive and should not be considered the requirements for the GSOC project. There are probably more issues, that could apply and not all of them have to be fixed as part of GSoC. Pick some you like and include them in your proposal. 45 | 46 | #### Contacts 47 | 48 | You can reach the mentors for questions via Matrix in the #nheko-reborn:matrix.org room or directly: 49 | - red_sky (@red_sky:ocean.joedonofry.com) 50 | - Nico (@deepbluev7:neko.dev) 51 | 52 | #### Milestones 53 | 54 | The milestones are just a general timeline, you may want to move some elements to a closer milestone to have more time for fixing bugs in the last few weeks, since time can be an issue shortly before the deadline. 55 | 56 | ##### Before GSOC 57 | 58 | * Get familiar with Nheko. 59 | * Get familiar with Matrix terms. Start [here](https://matrix.org/docs/guides/introduction). 60 | * Join #nheko-reborn:matrix.org and get to know the contributors and community. 61 | * Ask around for issues others would like to have fixed or discover your own bugs or missing features. 62 | * Clone the [nheko repo](https://github.com/Nheko-Reborn/nheko/) and compile the current dev branch. 63 | * Maybe you can find something small to contribute to get familiar with the code, development and the contribution process. There is probably a typo or a bad ui layout somewhere in the code. 64 | 65 | ##### GSOC CODING STARTS 66 | 67 | * Pick a few issues, that you think you can finish in Phase 1. 68 | * Communicate what you are working on and start implementing and discussing solutions. 69 | * Let your issues be reviewed sequentially, when they are ready. You may start working on the next issue, while the first is in review and so on. 70 | * See that your Pull Requests get merged and the corresponding issues get closed. 71 | 72 | ##### GSOC FINAL 73 | 74 | * Ensure all previous issues have come to a close. 75 | * Pick a few more issues and solve them. 76 | * Only start issues, that you are confident you will be able to complete before the final evaluation! 77 | -------------------------------------------------------------------------------- /_faq/application-template.md: -------------------------------------------------------------------------------- 1 | --- 2 | question: "Do you have an application template?" 3 | --- 4 | {% assign month = "now" | date: "%-m" | plus: 0 %} 5 | {% if month >= site.gsoc_switch_month %} 6 | # Matrix {{ "now" | date: "%Y" | plus: 1 }} Application Template 7 | {% else %} 8 | # Matrix {{ "now" | date: "%Y" }} Application Template 9 | {% endif %} 10 | 11 | ``` 12 | Student Info 13 | ------------ 14 | 15 | - Name: 16 | - GitHub username: 17 | - Alternative-/Nickname: 18 | - Email: 19 | - Matrix ID: (i.e. @cadair:cadair.com) 20 | - Which country will you reside in during the project? 21 | - Time Zone: 22 | - GSoC blog RSS feed URL: (if you have one for weekly posts, otherwise we'll 23 | use TWIM) 24 | 25 | 26 | Code Sample 27 | ----------- 28 | 29 | Link all your contributions to matrix and any other open source project here. 30 | 31 | You may also mention specific issues/commits using the commit id if you want 32 | us to take a look at that. 33 | 34 | 35 | Project Info 36 | ------------ 37 | 38 | - Which project from https://matrix-org.github.io/gsoc are you applying for? 39 | If you have your own idea, please add it to our projects list: 40 | https://github.com/matrix-org/gsoc 41 | 42 | - What is the final goal for this project? What would make it a total 43 | and perfect success? 44 | 45 | - Are you already engaged with the project's possible mentors and do 46 | you have any preference for a particular mentor? 47 | We will try to get you your first choice for a mentor, usually it will 48 | be the first listed mentor as primary and another as secondary. 49 | All projects will have a primary and a secondary mentor. 50 | 51 | - What parts of the matrix ecosystem do you have to work with in order to complete 52 | this project? What else are you planning on using? 53 | 54 | - Why are you the right person to work on this project? 55 | 56 | - How do you plan to achieve completion of your project? 57 | - Please provide a schedule with dates and important 58 | milestones/deliverables (preferably in two week increments). 59 | This is a great help in evaluating your own progress and helps you 60 | achieving your goal as it forces you to plan your work preemptively. 61 | 62 | Add all ideas you have to solve the project here. 63 | 64 | 65 | Other Commitments 66 | ----------------- 67 | 68 | - Do you have any other commitments during the GSoC period, 69 | May 27th to August 19th? 70 | 71 | - We don't penalize students for needing adjustments to schedule if 72 | they're up-front about them and have a plan to mitigate any issues. 73 | However, we *will* fail students for lying about their availability 74 | and subsequently falling behind in their work. Be honest! 75 | 76 | - Do you have exams or classes that overlap with this period? 77 | 78 | - Do you have plans to have any other job or internship during this 79 | period? 80 | - This is __NOT RECOMMENDED AT ALL__ as GSoC is intended to be a 81 | full time job. But can be worked around if it only a small overlap. 82 | 83 | - Do you have any other short term commitments during this period? 84 | - e.g. family wedding, conferences, volunteer projects, planned 85 | vacation days 86 | 87 | - Have you applied to any other organizations? If so, to whom and do you have a 88 | preferred project/org? (This will help us in the event that more than one 89 | org decides they wish to accept your proposal.) 90 | 91 | 92 | Extra Information 93 | ----------------- 94 | 95 | This additional information isn't needed but can help us to learn 96 | more about you. All fields in this section are optional. 97 | 98 | - Link to openhub account: 99 | - University info 100 | - University name: 101 | - Major: 102 | - Current year and expected graduation date: 103 | - Degree: 104 | - Other Contact info: 105 | - Alternate contact info in case primary mail above stops working: 106 | - Homepage: 107 | 108 | - We love having twitter handles so we can tell people publicly about your 109 | great project and successes at https://twitter.com/matrixdotorg! 110 | (Not required but recommended.) 111 | 112 | - Anything else you want us to know: 113 | 114 | ``` 115 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Matrix - Google Summer of Code 2 | ============================== 3 | 4 | Getting in touch 5 | ---------------- 6 | 7 | You can contact the Matrix team via our [Matrix GSoC room](https://matrix.to/#/#gsoc:matrix.org) or alternatively our [Matrix HQ room](https://matrix.to/#/#matrix:matrix.org) - or on IRC in [#matrix on freenode](irc://irc.freenode.net/matrix) 8 | 9 | How do I pick a project? 10 | ------------------------ 11 | 12 | The first thing to do, is to have a play with Matrix. Register an account on the matrix.org homeserver via a client like [Element](https://app.element.io) (or any of the clients listed on the ["try matrix now"](https://matrix.org/docs/projects/try-matrix-now.html) page). Join some rooms, for example [#matrix:matrix.org](https://matrix.to/#/#matrix:matrix.org), and say hello - in fact you can now even join as an anonymous user via that link. 13 | 14 | [This guide](https://matrix.org/docs/guides/getting_involved.html) has a lot of information about getting involved. Perhaps you might want to run your own client, or even set up your own homeserver? Check out [the code](https://github.com/matrix-org/synapse) and have a look at the [client-server API](https://matrix.org/docs/api/client-server/). 15 | 16 | In order to find a project you would like to work on, we suggest reading our latest [status update](https://matrix.org/blog/2017/12/25/the-matrix-holiday-mini-special-2017-edition/) and looking at the [ideas](https://github.com/matrix-org/gsoc/tree/master/_projects) list - and then thinking about what you would like to add to the Matrix ecosystem. Of course, please also come talk and discuss your idea with us (in [#gsoc:matrix.org](https://matrix.to/#/#gsoc:matrix.org) or [#matrix:matrix.org](https://matrix.to/#/#matrix:matrix.org) for example), but it's important that you find a project that you find interesting yourself! 17 | 18 | 19 | How do I write my GSoC application? 20 | ----------------------------------- 21 | 22 | GSoC's intentions is for you, as a student, to find an open source project you like and suggest a project that would be interesting for you to spend your summer on - and also beneficial to the open source project overall. We have written a list of [project ideas for Matrix](https://github.com/matrix-org/gsoc/tree/master/_projects) (higher priority first) - but these are just some examples, and we hope you will have a play with Matrix and also potentially suggest your own idea - ideally something that you think would add value to Matrix, and that would be interesting for yourself to spend 3 months working on. 23 | 24 | It's **your** project, so you should prepare for it in the best way possible. Your mentor will of course help by answering questions and pointing you in the right direction, but ultimately you are the one implementing it. Therefore you should make sure you have a good understanding of Matrix - both the standard itself, and also any relevant implementations. For example, if you want to add a bridge to some service, you should make yourself familiar with [application services](https://matrix.org/docs/guides/application_services.html) and the [application service framework](https://github.com/matrix-org/matrix-appservice-node). 25 | 26 | Of course, you can chat to Matrix devs (in [#gsoc:matrix.org](https://matrix.to/#/#gsoc:matrix.org) via [any Matrix client](https://matrix.org/docs/projects/try-matrix-now.html)) to see if your idea is something we would like to see added to the Matrix ecosystem, and also to get pointers to existing code that might be useful for your project. 27 | 28 | In terms of the proposal itself, we suggest including the following: 29 | 30 | * a brief description of what you want to achieve with your project. 31 | * a paragraph on why this project is needed, e.g. which problem you are solving. 32 | * more details on how the project will be designed and implemented. 33 | * a timeline on what will be done at what time. More detail is better, and this should be a good help for yourself to try and scope your project to fit in the 3 month space. Make sure you have a bit of buffer for unforeseen problems! 34 | * also describe features that will not be added as part of the project - but that can be added at a later stage. 35 | * finally, make a case for why you are the best person to tackle this project. Good things to mention are past projects (with links to code if possible), an explanation of why this particular area interests you, and your prior experience. 36 | 37 | Once you have a draft of your application, feel free to ask if we can have a look at it in [#gsoc:matrix.org](https://matrix.to/#/#gsoc:matrix.org) - we are happy to read drafts and project ideas before you go ahead and submit them to GSoC! 38 | 39 | Good luck! 40 | -------------------------------------------------------------------------------- /partials/tabs/projects.html: -------------------------------------------------------------------------------- 1 | 2 | 4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 | Google Summer of Code 2023 suggested projects list
12 | The projects below are only suggestions. There are even 13 | 14 | more project ideas in a previous document, and we also encourage you to use Matrix 15 | for yourself and come up with new ones. Finally, 16 | come and talk to us 17 | in #gsoc:matrix.org to discuss your ideas and learn more. 18 |
19 |
20 | 22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
{{ project.name }}
36 |
37 |
38 | 39 |
{{ initiative }} 40 |
41 |
{{ project }} 42 |
43 |
HIGH INVOLVEMENT 44 |
If you haven't put work into this, look out for other projects for better chances!
45 |
IN PROGRESS 46 |
Work on this project is going on at full pace!
47 |
IN PROGRESS 48 |
Work on this project is going on at full pace!
49 |
COMPLETED 50 |
Hooray!
51 |
DISABLED 52 |
This project is currently unavailable. See project description for details
53 |
54 |
55 |
56 |
57 |
58 |
59 | 96 | 97 | 98 |
99 | 100 | 101 | 126 | -------------------------------------------------------------------------------- /resources/vendors/bootstrap/css/bootstrap.min.css: -------------------------------------------------------------------------------- 1 | .container { 2 | margin-right: auto; 3 | margin-left: auto; 4 | padding-left: 15px; 5 | padding-right: 15px 6 | } 7 | @media (min-width:768px) { 8 | .container { 9 | width: 750px 10 | } 11 | } 12 | @media (min-width:992px) { 13 | .container { 14 | width: 970px 15 | } 16 | } 17 | @media (min-width:1200px) { 18 | .container { 19 | width: 1170px 20 | } 21 | } 22 | .container-fluid { 23 | margin-right: auto; 24 | margin-left: auto; 25 | padding-left: 15px; 26 | padding-right: 15px 27 | } 28 | .row { 29 | margin-left: -15px; 30 | margin-right: -15px 31 | } 32 | .col-xs-1, .col-sm-1, .col-md-1, .col-lg-1, .col-xs-2, .col-sm-2, .col-md-2, .col-lg-2, .col-xs-3, .col-sm-3, .col-md-3, .col-lg-3, .col-xs-4, .col-sm-4, .col-md-4, .col-lg-4, .col-xs-5, .col-sm-5, .col-md-5, .col-lg-5, .col-xs-6, .col-sm-6, .col-md-6, .col-lg-6, .col-xs-7, .col-sm-7, .col-md-7, .col-lg-7, .col-xs-8, .col-sm-8, .col-md-8, .col-lg-8, .col-xs-9, .col-sm-9, .col-md-9, .col-lg-9, .col-xs-10, .col-sm-10, .col-md-10, .col-lg-10, .col-xs-11, .col-sm-11, .col-md-11, .col-lg-11, .col-xs-12, .col-sm-12, .col-md-12, .col-lg-12 { 33 | position: relative; 34 | min-height: 1px; 35 | padding-left: 15px; 36 | padding-right: 15px 37 | } 38 | .col-xs-1, .col-xs-2, .col-xs-3, .col-xs-4, .col-xs-5, .col-xs-6, .col-xs-7, .col-xs-8, .col-xs-9, .col-xs-10, .col-xs-11, .col-xs-12 { 39 | float: left 40 | } 41 | .col-xs-12 { 42 | width: 100% 43 | } 44 | .col-xs-11 { 45 | width: 91.66666667% 46 | } 47 | .col-xs-10 { 48 | width: 83.33333333% 49 | } 50 | .col-xs-9 { 51 | width: 75% 52 | } 53 | .col-xs-8 { 54 | width: 66.66666667% 55 | } 56 | .col-xs-7 { 57 | width: 58.33333333% 58 | } 59 | .col-xs-6 { 60 | width: 50% 61 | } 62 | .col-xs-5 { 63 | width: 41.66666667% 64 | } 65 | .col-xs-4 { 66 | width: 33.33333333% 67 | } 68 | .col-xs-3 { 69 | width: 25% 70 | } 71 | .col-xs-2 { 72 | width: 16.66666667% 73 | } 74 | .col-xs-1 { 75 | width: 8.33333333% 76 | } 77 | .col-xs-pull-12 { 78 | right: 100% 79 | } 80 | .col-xs-pull-11 { 81 | right: 91.66666667% 82 | } 83 | .col-xs-pull-10 { 84 | right: 83.33333333% 85 | } 86 | .col-xs-pull-9 { 87 | right: 75% 88 | } 89 | .col-xs-pull-8 { 90 | right: 66.66666667% 91 | } 92 | .col-xs-pull-7 { 93 | right: 58.33333333% 94 | } 95 | .col-xs-pull-6 { 96 | right: 50% 97 | } 98 | .col-xs-pull-5 { 99 | right: 41.66666667% 100 | } 101 | .col-xs-pull-4 { 102 | right: 33.33333333% 103 | } 104 | .col-xs-pull-3 { 105 | right: 25% 106 | } 107 | .col-xs-pull-2 { 108 | right: 16.66666667% 109 | } 110 | .col-xs-pull-1 { 111 | right: 8.33333333% 112 | } 113 | .col-xs-pull-0 { 114 | right: auto 115 | } 116 | .col-xs-push-12 { 117 | left: 100% 118 | } 119 | .col-xs-push-11 { 120 | left: 91.66666667% 121 | } 122 | .col-xs-push-10 { 123 | left: 83.33333333% 124 | } 125 | .col-xs-push-9 { 126 | left: 75% 127 | } 128 | .col-xs-push-8 { 129 | left: 66.66666667% 130 | } 131 | .col-xs-push-7 { 132 | left: 58.33333333% 133 | } 134 | .col-xs-push-6 { 135 | left: 50% 136 | } 137 | .col-xs-push-5 { 138 | left: 41.66666667% 139 | } 140 | .col-xs-push-4 { 141 | left: 33.33333333% 142 | } 143 | .col-xs-push-3 { 144 | left: 25% 145 | } 146 | .col-xs-push-2 { 147 | left: 16.66666667% 148 | } 149 | .col-xs-push-1 { 150 | left: 8.33333333% 151 | } 152 | .col-xs-push-0 { 153 | left: auto 154 | } 155 | .col-xs-offset-12 { 156 | margin-left: 100% 157 | } 158 | .col-xs-offset-11 { 159 | margin-left: 91.66666667% 160 | } 161 | .col-xs-offset-10 { 162 | margin-left: 83.33333333% 163 | } 164 | .col-xs-offset-9 { 165 | margin-left: 75% 166 | } 167 | .col-xs-offset-8 { 168 | margin-left: 66.66666667% 169 | } 170 | .col-xs-offset-7 { 171 | margin-left: 58.33333333% 172 | } 173 | .col-xs-offset-6 { 174 | margin-left: 50% 175 | } 176 | .col-xs-offset-5 { 177 | margin-left: 41.66666667% 178 | } 179 | .col-xs-offset-4 { 180 | margin-left: 33.33333333% 181 | } 182 | .col-xs-offset-3 { 183 | margin-left: 25% 184 | } 185 | .col-xs-offset-2 { 186 | margin-left: 16.66666667% 187 | } 188 | .col-xs-offset-1 { 189 | margin-left: 8.33333333% 190 | } 191 | .col-xs-offset-0 { 192 | margin-left: 0 193 | } 194 | @media (min-width:768px) { 195 | .col-sm-1, .col-sm-2, .col-sm-3, .col-sm-4, .col-sm-5, .col-sm-6, .col-sm-7, .col-sm-8, .col-sm-9, .col-sm-10, .col-sm-11, .col-sm-12 { 196 | float: left 197 | } 198 | .col-sm-12 { 199 | width: 100% 200 | } 201 | .col-sm-11 { 202 | width: 91.66666667% 203 | } 204 | .col-sm-10 { 205 | width: 83.33333333% 206 | } 207 | .col-sm-9 { 208 | width: 75% 209 | } 210 | .col-sm-8 { 211 | width: 66.66666667% 212 | } 213 | .col-sm-7 { 214 | width: 58.33333333% 215 | } 216 | .col-sm-6 { 217 | width: 50% 218 | } 219 | .col-sm-5 { 220 | width: 41.66666667% 221 | } 222 | .col-sm-4 { 223 | width: 33.33333333% 224 | } 225 | .col-sm-3 { 226 | width: 25% 227 | } 228 | .col-sm-2 { 229 | width: 16.66666667% 230 | } 231 | .col-sm-1 { 232 | width: 8.33333333% 233 | } 234 | .col-sm-pull-12 { 235 | right: 100% 236 | } 237 | .col-sm-pull-11 { 238 | right: 91.66666667% 239 | } 240 | .col-sm-pull-10 { 241 | right: 83.33333333% 242 | } 243 | .col-sm-pull-9 { 244 | right: 75% 245 | } 246 | .col-sm-pull-8 { 247 | right: 66.66666667% 248 | } 249 | .col-sm-pull-7 { 250 | right: 58.33333333% 251 | } 252 | .col-sm-pull-6 { 253 | right: 50% 254 | } 255 | .col-sm-pull-5 { 256 | right: 41.66666667% 257 | } 258 | .col-sm-pull-4 { 259 | right: 33.33333333% 260 | } 261 | .col-sm-pull-3 { 262 | right: 25% 263 | } 264 | .col-sm-pull-2 { 265 | right: 16.66666667% 266 | } 267 | .col-sm-pull-1 { 268 | right: 8.33333333% 269 | } 270 | .col-sm-pull-0 { 271 | right: auto 272 | } 273 | .col-sm-push-12 { 274 | left: 100% 275 | } 276 | .col-sm-push-11 { 277 | left: 91.66666667% 278 | } 279 | .col-sm-push-10 { 280 | left: 83.33333333% 281 | } 282 | .col-sm-push-9 { 283 | left: 75% 284 | } 285 | .col-sm-push-8 { 286 | left: 66.66666667% 287 | } 288 | .col-sm-push-7 { 289 | left: 58.33333333% 290 | } 291 | .col-sm-push-6 { 292 | left: 50% 293 | } 294 | .col-sm-push-5 { 295 | left: 41.66666667% 296 | } 297 | .col-sm-push-4 { 298 | left: 33.33333333% 299 | } 300 | .col-sm-push-3 { 301 | left: 25% 302 | } 303 | .col-sm-push-2 { 304 | left: 16.66666667% 305 | } 306 | .col-sm-push-1 { 307 | left: 8.33333333% 308 | } 309 | .col-sm-push-0 { 310 | left: auto 311 | } 312 | .col-sm-offset-12 { 313 | margin-left: 100% 314 | } 315 | .col-sm-offset-11 { 316 | margin-left: 91.66666667% 317 | } 318 | .col-sm-offset-10 { 319 | margin-left: 83.33333333% 320 | } 321 | .col-sm-offset-9 { 322 | margin-left: 75% 323 | } 324 | .col-sm-offset-8 { 325 | margin-left: 66.66666667% 326 | } 327 | .col-sm-offset-7 { 328 | margin-left: 58.33333333% 329 | } 330 | .col-sm-offset-6 { 331 | margin-left: 50% 332 | } 333 | .col-sm-offset-5 { 334 | margin-left: 41.66666667% 335 | } 336 | .col-sm-offset-4 { 337 | margin-left: 33.33333333% 338 | } 339 | .col-sm-offset-3 { 340 | margin-left: 25% 341 | } 342 | .col-sm-offset-2 { 343 | margin-left: 16.66666667% 344 | } 345 | .col-sm-offset-1 { 346 | margin-left: 8.33333333% 347 | } 348 | .col-sm-offset-0 { 349 | margin-left: 0 350 | } 351 | } 352 | @media (min-width:992px) { 353 | .col-md-1, .col-md-2, .col-md-3, .col-md-4, .col-md-5, .col-md-6, .col-md-7, .col-md-8, .col-md-9, .col-md-10, .col-md-11, .col-md-12 { 354 | float: left 355 | } 356 | .col-md-12 { 357 | width: 100% 358 | } 359 | .col-md-11 { 360 | width: 91.66666667% 361 | } 362 | .col-md-10 { 363 | width: 83.33333333% 364 | } 365 | .col-md-9 { 366 | width: 75% 367 | } 368 | .col-md-8 { 369 | width: 66.66666667% 370 | } 371 | .col-md-7 { 372 | width: 58.33333333% 373 | } 374 | .col-md-6 { 375 | width: 50% 376 | } 377 | .col-md-5 { 378 | width: 41.66666667% 379 | } 380 | .col-md-4 { 381 | width: 33.33333333% 382 | } 383 | .col-md-3 { 384 | width: 25% 385 | } 386 | .col-md-2 { 387 | width: 16.66666667% 388 | } 389 | .col-md-1 { 390 | width: 8.33333333% 391 | } 392 | .col-md-pull-12 { 393 | right: 100% 394 | } 395 | .col-md-pull-11 { 396 | right: 91.66666667% 397 | } 398 | .col-md-pull-10 { 399 | right: 83.33333333% 400 | } 401 | .col-md-pull-9 { 402 | right: 75% 403 | } 404 | .col-md-pull-8 { 405 | right: 66.66666667% 406 | } 407 | .col-md-pull-7 { 408 | right: 58.33333333% 409 | } 410 | .col-md-pull-6 { 411 | right: 50% 412 | } 413 | .col-md-pull-5 { 414 | right: 41.66666667% 415 | } 416 | .col-md-pull-4 { 417 | right: 33.33333333% 418 | } 419 | .col-md-pull-3 { 420 | right: 25% 421 | } 422 | .col-md-pull-2 { 423 | right: 16.66666667% 424 | } 425 | .col-md-pull-1 { 426 | right: 8.33333333% 427 | } 428 | .col-md-pull-0 { 429 | right: auto 430 | } 431 | .col-md-push-12 { 432 | left: 100% 433 | } 434 | .col-md-push-11 { 435 | left: 91.66666667% 436 | } 437 | .col-md-push-10 { 438 | left: 83.33333333% 439 | } 440 | .col-md-push-9 { 441 | left: 75% 442 | } 443 | .col-md-push-8 { 444 | left: 66.66666667% 445 | } 446 | .col-md-push-7 { 447 | left: 58.33333333% 448 | } 449 | .col-md-push-6 { 450 | left: 50% 451 | } 452 | .col-md-push-5 { 453 | left: 41.66666667% 454 | } 455 | .col-md-push-4 { 456 | left: 33.33333333% 457 | } 458 | .col-md-push-3 { 459 | left: 25% 460 | } 461 | .col-md-push-2 { 462 | left: 16.66666667% 463 | } 464 | .col-md-push-1 { 465 | left: 8.33333333% 466 | } 467 | .col-md-push-0 { 468 | left: auto 469 | } 470 | .col-md-offset-12 { 471 | margin-left: 100% 472 | } 473 | .col-md-offset-11 { 474 | margin-left: 91.66666667% 475 | } 476 | .col-md-offset-10 { 477 | margin-left: 83.33333333% 478 | } 479 | .col-md-offset-9 { 480 | margin-left: 75% 481 | } 482 | .col-md-offset-8 { 483 | margin-left: 66.66666667% 484 | } 485 | .col-md-offset-7 { 486 | margin-left: 58.33333333% 487 | } 488 | .col-md-offset-6 { 489 | margin-left: 50% 490 | } 491 | .col-md-offset-5 { 492 | margin-left: 41.66666667% 493 | } 494 | .col-md-offset-4 { 495 | margin-left: 33.33333333% 496 | } 497 | .col-md-offset-3 { 498 | margin-left: 25% 499 | } 500 | .col-md-offset-2 { 501 | margin-left: 16.66666667% 502 | } 503 | .col-md-offset-1 { 504 | margin-left: 8.33333333% 505 | } 506 | .col-md-offset-0 { 507 | margin-left: 0 508 | } 509 | } 510 | @media (min-width:1200px) { 511 | .col-lg-1, .col-lg-2, .col-lg-3, .col-lg-4, .col-lg-5, .col-lg-6, .col-lg-7, .col-lg-8, .col-lg-9, .col-lg-10, .col-lg-11, .col-lg-12 { 512 | float: left 513 | } 514 | .col-lg-12 { 515 | width: 100% 516 | } 517 | .col-lg-11 { 518 | width: 91.66666667% 519 | } 520 | .col-lg-10 { 521 | width: 83.33333333% 522 | } 523 | .col-lg-9 { 524 | width: 75% 525 | } 526 | .col-lg-8 { 527 | width: 66.66666667% 528 | } 529 | .col-lg-7 { 530 | width: 58.33333333% 531 | } 532 | .col-lg-6 { 533 | width: 50% 534 | } 535 | .col-lg-5 { 536 | width: 41.66666667% 537 | } 538 | .col-lg-4 { 539 | width: 33.33333333% 540 | } 541 | .col-lg-3 { 542 | width: 25% 543 | } 544 | .col-lg-2 { 545 | width: 16.66666667% 546 | } 547 | .col-lg-1 { 548 | width: 8.33333333% 549 | } 550 | .col-lg-pull-12 { 551 | right: 100% 552 | } 553 | .col-lg-pull-11 { 554 | right: 91.66666667% 555 | } 556 | .col-lg-pull-10 { 557 | right: 83.33333333% 558 | } 559 | .col-lg-pull-9 { 560 | right: 75% 561 | } 562 | .col-lg-pull-8 { 563 | right: 66.66666667% 564 | } 565 | .col-lg-pull-7 { 566 | right: 58.33333333% 567 | } 568 | .col-lg-pull-6 { 569 | right: 50% 570 | } 571 | .col-lg-pull-5 { 572 | right: 41.66666667% 573 | } 574 | .col-lg-pull-4 { 575 | right: 33.33333333% 576 | } 577 | .col-lg-pull-3 { 578 | right: 25% 579 | } 580 | .col-lg-pull-2 { 581 | right: 16.66666667% 582 | } 583 | .col-lg-pull-1 { 584 | right: 8.33333333% 585 | } 586 | .col-lg-pull-0 { 587 | right: auto 588 | } 589 | .col-lg-push-12 { 590 | left: 100% 591 | } 592 | .col-lg-push-11 { 593 | left: 91.66666667% 594 | } 595 | .col-lg-push-10 { 596 | left: 83.33333333% 597 | } 598 | .col-lg-push-9 { 599 | left: 75% 600 | } 601 | .col-lg-push-8 { 602 | left: 66.66666667% 603 | } 604 | .col-lg-push-7 { 605 | left: 58.33333333% 606 | } 607 | .col-lg-push-6 { 608 | left: 50% 609 | } 610 | .col-lg-push-5 { 611 | left: 41.66666667% 612 | } 613 | .col-lg-push-4 { 614 | left: 33.33333333% 615 | } 616 | .col-lg-push-3 { 617 | left: 25% 618 | } 619 | .col-lg-push-2 { 620 | left: 16.66666667% 621 | } 622 | .col-lg-push-1 { 623 | left: 8.33333333% 624 | } 625 | .col-lg-push-0 { 626 | left: auto 627 | } 628 | .col-lg-offset-12 { 629 | margin-left: 100% 630 | } 631 | .col-lg-offset-11 { 632 | margin-left: 91.66666667% 633 | } 634 | .col-lg-offset-10 { 635 | margin-left: 83.33333333% 636 | } 637 | .col-lg-offset-9 { 638 | margin-left: 75% 639 | } 640 | .col-lg-offset-8 { 641 | margin-left: 66.66666667% 642 | } 643 | .col-lg-offset-7 { 644 | margin-left: 58.33333333% 645 | } 646 | .col-lg-offset-6 { 647 | margin-left: 50% 648 | } 649 | .col-lg-offset-5 { 650 | margin-left: 41.66666667% 651 | } 652 | .col-lg-offset-4 { 653 | margin-left: 33.33333333% 654 | } 655 | .col-lg-offset-3 { 656 | margin-left: 25% 657 | } 658 | .col-lg-offset-2 { 659 | margin-left: 16.66666667% 660 | } 661 | .col-lg-offset-1 { 662 | margin-left: 8.33333333% 663 | } 664 | .col-lg-offset-0 { 665 | margin-left: 0 666 | } 667 | } 668 | .clearfix:before, .clearfix:after, .container:before, .container:after, .container-fluid:before, .container-fluid:after, .row:before, .row:after { 669 | content: " "; 670 | display: table 671 | } 672 | .clearfix:after, .container:after, .container-fluid:after, .row:after { 673 | clear: both 674 | } 675 | .center-block { 676 | display: block; 677 | margin-left: auto; 678 | margin-right: auto 679 | } 680 | .pull-right { 681 | float: right !important 682 | } 683 | .pull-left { 684 | float: left !important 685 | } 686 | .hide { 687 | display: none !important 688 | } 689 | .show { 690 | display: block !important 691 | } 692 | .invisible { 693 | visibility: hidden 694 | } 695 | .text-hide { 696 | font: 0/0 a; 697 | color: transparent; 698 | text-shadow: none; 699 | background-color: transparent; 700 | border: 0 701 | } 702 | .hidden { 703 | display: none !important 704 | } 705 | .affix { 706 | position: fixed 707 | } 708 | -------------------------------------------------------------------------------- /resources/css/coala.css: -------------------------------------------------------------------------------- 1 | /* Misc */ 2 | 3 | .clickable { 4 | cursor: pointer; 5 | } 6 | 7 | /* Tab Navigation */ 8 | 9 | .tabs { 10 | display: flex; 11 | font-family: Roboto; 12 | text-transform: uppercase; 13 | letter-spacing: 0.1em; 14 | } 15 | 16 | .tabs .tab { 17 | display: inline-block; 18 | text-align: center; 19 | line-height: 48px; 20 | height: 48px; 21 | padding: 0; 22 | margin: 0; 23 | flex-grow: 1; 24 | width: calc(100% * (1/5) - 10px - 1px); 25 | } 26 | 27 | .tabs .tab a { 28 | color: lightslategrey !important; 29 | display: block; 30 | width: 100%; 31 | height: 100%; 32 | padding: 0 24px; 33 | font-size: 14px; 34 | text-overflow: ellipsis; 35 | overflow: hidden; 36 | transition: color .28s ease; 37 | } 38 | 39 | .tabs .tab a:hover, 40 | .tabs .tab a.active { 41 | background-color: transparent; 42 | color: black !important; 43 | } 44 | 45 | .tabs .tab.disabled a, 46 | .tabs .tab.disabled a:hover { 47 | color: rgba(238, 110, 115, 0.7); 48 | cursor: default; 49 | } 50 | 51 | .tabs .indicator { 52 | position: absolute; 53 | bottom: 0; 54 | height: 2px; 55 | background-color: black !important; 56 | will-change: left, right; 57 | } 58 | 59 | nav { 60 | background: transparent; 61 | box-shadow: 0 0 0 0; 62 | } 63 | 64 | nav a { 65 | color: black; 66 | } 67 | 68 | ul li { 69 | color: inherit; 70 | } 71 | 72 | @media (max-width: 768px) { 73 | nav { 74 | box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 75 | 0 1px 5px 0 rgba(0,0,0,0.12), 76 | 0 3px 1px -2px rgba(0,0,0,0.2); 77 | } 78 | } 79 | 80 | /* Titles */ 81 | 82 | .title { 83 | font-family: -apple-system, BlinkMacSystemFont, Roboto, sans-serif; 84 | font-size: 14em; 85 | font-weight: 100; 86 | text-align: center; 87 | } 88 | 89 | .logo { 90 | height: 15em; 91 | margin-top: 4em; 92 | } 93 | 94 | @media screen and (max-width: 992px) { 95 | .title { 96 | font-size: 11em; 97 | } 98 | } 99 | 100 | /* Typography */ 101 | 102 | h1, 103 | h2, 104 | h3, 105 | h4, 106 | h5, 107 | h6 { 108 | font-family: Roboto; 109 | } 110 | 111 | h1 { 112 | font-size: 5em; 113 | } 114 | 115 | h2 { 116 | font-size: 3em; 117 | } 118 | 119 | h3 { 120 | font-size: 2em; 121 | } 122 | 123 | h4 { 124 | font-size: 1.6em; 125 | } 126 | 127 | h5 { 128 | font-size: 1.5em; 129 | } 130 | 131 | h6 { 132 | font-size: 1em; 133 | } 134 | 135 | .fine { 136 | font-weight: 100; 137 | } 138 | 139 | .tiny { 140 | font-size: 0.8em; 141 | } 142 | 143 | .tiny-label { 144 | font-size: 10px; 145 | letter-spacing: 0.1em; 146 | text-align: center; 147 | font-weight: 500; 148 | opacity: 0.2; 149 | } 150 | 151 | .uppercase { 152 | text-transform: uppercase; 153 | } 154 | 155 | .lowercase { 156 | text-transform: lowercase; 157 | } 158 | 159 | /* Code Blocks */ 160 | 161 | pre, 162 | pre.card, 163 | .pre { 164 | background-color: #2b2b2b; 165 | color: #fff; 166 | padding: .8em; 167 | font-family: 'Roboto Mono', Menlo, "Ubuntu Mono", monospace; 168 | } 169 | 170 | textarea.pre { 171 | height: 7rem; 172 | resize: vertical; 173 | } 174 | 175 | .card pre { 176 | overflow: scroll; 177 | max-height: 300px; 178 | } 179 | 180 | 181 | /* Select box */ 182 | 183 | span.caret { 184 | padding-left: 10px; 185 | } 186 | 187 | .select-wrapper input.select-dropdown { 188 | background-color: rgba(40, 53, 147, 0.1); 189 | width: 100%; 190 | padding: 0; 191 | border: 1px solid #f2f2f2; 192 | border-top-color: rgb(242, 242, 242); 193 | border-top-style: solid; 194 | border-top-width: 1px; 195 | border-right-color: rgb(242, 242, 242); 196 | border-right-style: solid; 197 | border-right-width: 1px; 198 | border-bottom-color: rgb(242, 242, 242); 199 | border-bottom-style: solid; 200 | border-bottom-width: 1px; 201 | border-left-color: rgb(242, 242, 242); 202 | border-left-style: solid; 203 | border-left-width: 1px; 204 | border-image-source: initial; 205 | border-image-slice: initial; 206 | border-image-width: initial; 207 | border-image-outset: initial; 208 | border-image-repeat: initial; 209 | border-radius: 2px; 210 | height: 3rem; 211 | } 212 | 213 | .select-wrapper input[type=text] { 214 | padding-left: 0.5em; 215 | } 216 | 217 | 218 | /* Containers */ 219 | 220 | .thin-row-small { 221 | padding-left: 1.5vw; 222 | padding-right: 1.5vw; 223 | padding-top: 1.5vw; 224 | padding-bottom: 1.5vw; 225 | margin-bottom: 0; 226 | } 227 | 228 | .thin-row-medium { 229 | margin-left: 4vw; 230 | margin-right: 4vw; 231 | margin-bottom: 0; 232 | } 233 | 234 | .parent-wrapper { 235 | height: 100%; 236 | width: 100%; 237 | } 238 | 239 | .parent { 240 | display: flex; 241 | flex-wrap: wrap; 242 | margin: -10px 0 0 -10px; 243 | justify-content: center; 244 | } 245 | 246 | .child { 247 | display: inline-grid; 248 | margin: 10px 0 0 10px; 249 | width: 300px; 250 | flex-grow: 0; 251 | } 252 | 253 | @media only screen and (min-width: 993px) { 254 | .container { 255 | width: 80%; 256 | } 257 | } 258 | 259 | 260 | /* Margins & Borders */ 261 | 262 | .no-border { 263 | border: 0; 264 | } 265 | 266 | .no-margin { 267 | margin: 0; 268 | } 269 | 270 | .no-outline { 271 | outline: none; 272 | } 273 | 274 | /* Footer */ 275 | 276 | footer.page-footer { 277 | margin-top: 20px; 278 | padding-top: 20px; 279 | background-color: #37474f; 280 | } 281 | 282 | .footer-btn-row { 283 | text-transform: uppercase; 284 | margin-top: 1.5em; 285 | } 286 | 287 | .footer-btn-text { 288 | vertical-align: top; 289 | padding-left: 1em; 290 | } 291 | 292 | .footer-small-title { 293 | text-transform: uppercase; 294 | color: lightcyan; 295 | letter-spacing: 0.1em; 296 | padding: 1em; 297 | text-align: center; 298 | } 299 | 300 | footer.page-footer .footer-copyright { 301 | overflow: hidden; 302 | height: 50px; 303 | line-height: 50px; 304 | background-color: #263238; 305 | } 306 | 307 | .footer-light .footer-title{ 308 | font-size: 42px; 309 | font-family: -apple-system,BlinkMacSystemFont,Roboto,sans-serif; 310 | font-weight: 100; 311 | vertical-align: text-bottom; 312 | } 313 | 314 | .page-footer li { 315 | padding: 0.2em; 316 | } 317 | 318 | body { 319 | display: flex; 320 | min-height: 100vh; 321 | flex-direction: column; 322 | } 323 | 324 | main { 325 | flex: 1 0 auto; 326 | } 327 | 328 | 329 | /* Buttons */ 330 | 331 | .btn, 332 | .btn-large { 333 | background-color: black; 334 | } 335 | 336 | .btn:hover, 337 | .btn-large:hover { 338 | background-color: #424242; 339 | } 340 | 341 | /* Stamp Buttons */ 342 | 343 | .stamp .fa-github-alt, .stamp .fa-rocket{ 344 | font-size: 3em; 345 | padding-left: 0.2em; 346 | background: rgba(0, 0, 0, 0.2); 347 | } 348 | 349 | .stamp { 350 | display: inline-flex; 351 | color: grey ; 352 | justify-content: center; 353 | } 354 | 355 | .stamp:hover { 356 | cursor: pointer; 357 | background: rgba(0, 0, 0, 0.7) !important; 358 | } 359 | 360 | .stamp span { 361 | font-size: 1.2em; 362 | padding: 0.5em 0.5em 0em 1em; 363 | background: rgba(0, 0, 0, 0.2); 364 | } 365 | 366 | /* Chips */ 367 | 368 | a.chip { 369 | width: max-content; 370 | } 371 | 372 | a.chip i { 373 | float: left; 374 | margin: 0 8px 0 -12px; 375 | height: 32px; 376 | width: 32px; 377 | border-radius: 50%; 378 | font-size: 1.5em; 379 | padding: 0.3em 0 0 0.3em; 380 | } 381 | 382 | 383 | /* Cards */ 384 | 385 | .card-content li { 386 | margin-bottom: 1em; 387 | } 388 | 389 | /* User Card */ 390 | 391 | .user .parent-wrapper { 392 | display: flex; 393 | justify-content: center; 394 | flex-wrap: wrap; 395 | margin-top: 1em; 396 | } 397 | 398 | .user .parent { 399 | justify-content: center; 400 | } 401 | 402 | .user .card { 403 | width: 200px; 404 | margin-left: 0.5em; 405 | margin-right: 0.5em; 406 | display: inline-grid; 407 | } 408 | 409 | .user .card .card-action a:not(.btn):not(.btn-large):not(.btn-floating) { 410 | margin-right: 0; 411 | } 412 | 413 | .user .data.thumbnail { 414 | max-height: 100px; 415 | } 416 | 417 | .user .empty { 418 | background-color: #eceff1; 419 | height: 5em; 420 | } 421 | 422 | .user .data { 423 | background-color: #263238; 424 | color: white; 425 | height: 300px; 426 | padding: 10px; 427 | } 428 | 429 | .user .dp { 430 | margin-top: -5em; 431 | border-radius: 100%; 432 | } 433 | 434 | .user .name { 435 | font-size: 1.1em; 436 | font-weight: 300; 437 | text-align: center; 438 | } 439 | 440 | .user .handle { 441 | font-size: 1em; 442 | text-align: center; 443 | opacity: 0.7; 444 | padding: 0.5em; 445 | } 446 | 447 | .user .bio { 448 | font-size: 0.8em; 449 | text-align: center; 450 | padding-top: 0.5em; 451 | } 452 | 453 | .user .stats { 454 | margin-bottom: 0px; 455 | text-align: center; 456 | bottom: 0; 457 | position: absolute; 458 | padding-bottom: 1em; 459 | left: 0; 460 | right: 0; 461 | word-wrap: break-word; 462 | margin-top: 2em; 463 | text-align: center; 464 | letter-spacing: 0.1em; 465 | } 466 | 467 | .user .stats .row { 468 | margin-bottom: 5px; 469 | display: flex; 470 | text-align: center; 471 | } 472 | 473 | .user .link { 474 | bottom: 0; 475 | margin-top: 1em; 476 | } 477 | 478 | .user .stats .row .stat { 479 | flex-grow: 1; 480 | } 481 | 482 | /* Outline card */ 483 | 484 | .outline .card-content { 485 | height: 250px; 486 | } 487 | 488 | .outline .card-action { 489 | padding: 10px; 490 | min-height: 70px; 491 | } 492 | 493 | .outline .card-action span { 494 | display: inline-block; 495 | } 496 | 497 | .outline .card-action span a { 498 | font-size: 1.2em; 499 | color: darkcyan!important; 500 | text-transform: none!important; 501 | font-family: 'Roboto Mono',menlo,monospace; 502 | } 503 | 504 | .outline .flag { 505 | bottom: 0; 506 | position: absolute; 507 | width: 100%; 508 | } 509 | 510 | /* Search Bar */ 511 | 512 | .searchbar.input-field { 513 | padding-left: 4em; 514 | } 515 | 516 | .searchbar #search { 517 | font-size: 2em; 518 | border: none; 519 | font-family: Roboto; 520 | font-weight: 500; 521 | color: black; 522 | box-shadow: none; 523 | } 524 | 525 | .searchbar.input-field input[type=search] { 526 | background-color: lightgray; 527 | padding-left: 0.5em; 528 | } 529 | 530 | .searchbar ::-webkit-input-placeholder { 531 | font-weight: 200; 532 | color: #9e9e9e; 533 | } 534 | 535 | .searchbar ::-moz-placeholder { 536 | text-align: center; 537 | font-weight: 200; 538 | color: black; 539 | } 540 | 541 | .searchbar :-ms-input-placeholder { 542 | font-weight: 200; 543 | color: black; 544 | } 545 | 546 | 547 | /* Theatre View */ 548 | 549 | .theatre.modal { 550 | width: 100%; 551 | border-radius: 0; 552 | z-index: 1003; 553 | opacity: 1; 554 | transform: scaleX(1); 555 | top: 10%; 556 | bottom: 0; 557 | } 558 | 559 | .theatre.modal.margin { 560 | width: 90%; 561 | } 562 | 563 | .theatre .modal-content { 564 | display: flex; 565 | padding: 0; 566 | } 567 | 568 | .theatre .profile, 569 | .theatre .dashboard { 570 | max-width: none; 571 | padding-left: 1vw; 572 | padding-right: 1vw; 573 | } 574 | 575 | .theatre .profile { 576 | padding-bottom: 1vw; 577 | } 578 | 579 | .theatre .dashboard { 580 | background-color: darkslategrey; 581 | width: 70%; 582 | } 583 | 584 | .theatre .profile { 585 | background-color: #000; 586 | color: #fff; 587 | width: 30%; 588 | } 589 | 590 | .theatre .name { 591 | font-size: 3.5vw; 592 | text-align: center; 593 | padding-right: 1em; 594 | padding-top: 1em; 595 | padding-bottom: 0.1em; 596 | font-weight: 100; 597 | overflow-wrap: break-word; 598 | } 599 | 600 | .theatre .small-heading { 601 | font-size: 0.9em; 602 | padding: 0.5em; 603 | font-weight: 400; 604 | color: lightgoldenrodyellow; 605 | letter-spacing: 0.1em; 606 | } 607 | 608 | .theatre .description { 609 | color: lightgrey; 610 | text-align: justify; 611 | font-size: 1.1em; 612 | font-family: Roboto; 613 | font-weight: 300; 614 | padding: 1em; 615 | overflow-wrap: break-word; 616 | } 617 | 618 | .theatre .settings-options { 619 | color: lightgrey; 620 | } 621 | 622 | .theatre .settings { 623 | padding: 0 0 0.5em 0; 624 | } 625 | 626 | .theatre .label { 627 | font-size: 13px; 628 | text-transform: uppercase; 629 | letter-spacing: 0.1em; 630 | } 631 | 632 | .theatre .settings, 633 | .theatre .settings .chip { 634 | color: cadetblue; 635 | border-radius: 0px; 636 | } 637 | 638 | .theatre .detail-row { 639 | bottom: 0; 640 | left: 0; 641 | right: 0; 642 | } 643 | 644 | .theatre ul:not(.browser-default) { 645 | margin-left: 1em; 646 | } 647 | 648 | .theatre ul:not(.browser-default) li { 649 | margin-left: 1em; 650 | list-style-type: disc; 651 | } 652 | 653 | .theatre li { 654 | list-style-type: inherit; 655 | } 656 | 657 | .theatre .description h4 { 658 | font-size: 1.1em; 659 | letter-spacing: 0.1em; 660 | color: wheat; 661 | text-transform: uppercase; 662 | } 663 | 664 | .theatre .description h5 { 665 | letter-spacing: 0.1em; 666 | color: wheat; 667 | font-size: 1em; 668 | } 669 | 670 | .arrows { 671 | position: fixed; 672 | left: 0px; 673 | bottom: 0px; 674 | height: 60px; 675 | width: 100%; 676 | background: transparent; 677 | z-index: 9999; 678 | padding-top: 1em; 679 | } 680 | 681 | .arrow-click { 682 | font-size: 2em!important; 683 | color: lightgrey; 684 | cursor: pointer; 685 | } 686 | 687 | .arrow-move-right, .arrow-move-left { 688 | display: inline; 689 | position: fixed; 690 | bottom: 40px; 691 | z-index: 9999; 692 | } 693 | 694 | .arrow-move-right { 695 | right: 20%; 696 | } 697 | 698 | .arrow-move-left { 699 | left: 20%; 700 | } 701 | 702 | .theatre .description a { 703 | color: azure; 704 | } 705 | 706 | .theatre .dashboard span { 707 | color: white; 708 | } 709 | 710 | /* Results View */ 711 | 712 | .results { 713 | padding: 1em; 714 | margin-top: 1em; 715 | } 716 | 717 | .results .origin { 718 | padding: 0.5em; 719 | background-color: #263238; 720 | color: white; 721 | } 722 | 723 | .results .severity { 724 | padding: 0.5em; 725 | background-color: #37474f; 726 | color: white; 727 | } 728 | 729 | .results div.label { 730 | margin-top: 1em; 731 | padding: 0.5em; 732 | background-color: #455a64; 733 | color: white; 734 | } 735 | 736 | /* coala Online View */ 737 | 738 | .coala-online select { 739 | display: block; 740 | } 741 | 742 | .coala-online .card-panel { 743 | padding: 12px; 744 | margin: 0rem 0 0rem 0; 745 | border-radius: 2px; 746 | background-color: #fff; 747 | } 748 | 749 | .coala-online .section-title { 750 | padding: 12px; 751 | margin: 0em 0em 2em 0em; 752 | display: flex; 753 | } 754 | 755 | .coala-online .coalasection { 756 | padding-bottom: 0.1em; 757 | margin-bottom: 2em; 758 | } 759 | 760 | .coala-online .coalasection input { 761 | margin-bottom: 0; 762 | } 763 | 764 | .coala-online .section-name { 765 | flex-grow: 1; 766 | padding: 0.7em 1em 0 0; 767 | font-family: 'Roboto Mono'; 768 | } 769 | 770 | .coala-online .bears-icon { 771 | font-size: 2em; 772 | cursor: pointer; 773 | padding: 0.2em 774 | } 775 | 776 | .coala-online .bears-icon-small { 777 | font-weight: 600; 778 | padding: 1em; 779 | font-size: 1em; 780 | cursor: pointer; 781 | } 782 | 783 | .coala-online .autocomplete-content { 784 | margin-top: 0; 785 | } 786 | 787 | .coala-online .new-section input { 788 | margin-bottom: 0 !important; 789 | } 790 | 791 | .coala-online .new-section .col { 792 | padding: 1em; 793 | } 794 | 795 | .coala-online .new-section i { 796 | float: left; 797 | margin: 0 8px 0 -12px; 798 | height: 32px; 799 | width: 32px; 800 | font-size: 1.5em; 801 | padding: 0; 802 | } 803 | 804 | .coala-online .coafile { 805 | background: #263238; 806 | white-space: pre-line; 807 | padding: 1em; 808 | color: white; 809 | font-family: "Roboto Mono"; 810 | overflow-x: auto; 811 | } 812 | 813 | .coala-online .results-data { 814 | background: #263238; 815 | padding-left: 0.2em; 816 | padding-right: 0.2em; 817 | border-top: 0.1em solid; 818 | border-bottom: 0.1em solid; 819 | max-height: 100vh; 820 | overflow: scroll; 821 | } 822 | 823 | .coala-online .run-coala { 824 | display: inline-flex; 825 | padding: 0 1em 0 2em; 826 | font-size: 1em; 827 | align-items: center; 828 | } 829 | 830 | .coala-online .run-coala img { 831 | height: 3em; 832 | margin-left: 1em; 833 | } 834 | 835 | .coala-online input[type=text]:focus:not([readonly]).git-link{ 836 | border-bottom: 0 !important; 837 | box-shadow: 0 6px 10px 0 rgba(0, 0, 0, 0.14), 0 1px 18px 0 rgba(0, 0, 0, 0.12), 0 3px 5px -1px rgba(0, 0, 0, 0.3) !important; 838 | } 839 | 840 | .coala-online input[type=text].git-link { 841 | border-bottom: 0 !important; 842 | box-shadow: initial !important ; 843 | text-indent: 1em; 844 | box-shadow: 0 6px 10px 0 rgba(0, 0, 0, 0.14), 0 1px 18px 0 rgba(0, 0, 0, 0.12), 0 3px 5px -1px rgba(0, 0, 0, 0.3) !important; 845 | } 846 | -------------------------------------------------------------------------------- /resources/js/app.js: -------------------------------------------------------------------------------- 1 | (function(){ 2 | var app = angular.module('coala', ['ngSanitize','btford.markdown', 'ngRoute']); 3 | 4 | app.factory('Languages', function ($location) { 5 | langs = [{ 6 | 'name' : 'English', 7 | 'code' : 'en' 8 | }]; 9 | selected_language = JSON.parse(window.localStorage.getItem('lang')) || langs[0]; 10 | 11 | return { 12 | setData: function (val) { 13 | angular.forEach(langs, function(v, k){ 14 | if (v.code == val){ 15 | window.localStorage.setItem('lang', JSON.stringify(v)); 16 | selected_language = v; 17 | } 18 | }); 19 | }, 20 | getData: function () { 21 | return selected_language['code']; 22 | 23 | }, 24 | getAllLanguages: function () { 25 | return langs; 26 | }, 27 | getLanguageObject: function () { 28 | return selected_language; 29 | } 30 | } 31 | }); 32 | 33 | app.config(['$routeProvider', 34 | function($routeProvider) { 35 | $routeProvider. 36 | when('/projects', { 37 | template: '', 38 | reloadOnSearch: false 39 | }). 40 | when('/mentors', { 41 | template: '' 42 | }). 43 | when('/faq', { 44 | template: '' 45 | }). 46 | otherwise({ 47 | redirectTo: '/projects' 48 | }); 49 | }]); 50 | 51 | app.controller('LanguageController', function ($scope, Languages) { 52 | $scope.langs = Languages.getAllLanguages(); 53 | $scope.update = function () { 54 | Languages.setData($scope.language.code); 55 | } 56 | $scope.init_language = Languages.getLanguageObject(); 57 | $scope.getLanguage = function () { 58 | $scope.init_language = Languages.getLanguageObject(); 59 | $(document).ready(function(){ 60 | $('select').material_select(); 61 | }) 62 | $scope.$evalAsync(); 63 | return $scope.init_language; 64 | } 65 | }) 66 | 67 | app.controller('TabController', function ($location) { 68 | this.tab = $location.path() 69 | this.setTab = function (stab) { 70 | this.tab = stab 71 | $location.path(stab); 72 | } 73 | this.isSet = function (stab) { 74 | return $location.path() == stab 75 | } 76 | }) 77 | 78 | app.directive('projects', ['$http', '$timeout', '$location', 'Languages', function ($http, $timeout, $location, Languages) { 79 | return { 80 | restrict: 'E', 81 | templateUrl: 'partials/tabs/projects.html', 82 | controller: function ($scope, $location, Languages) { 83 | self = this 84 | 85 | var mapping = { 86 | '': 0, 87 | 'crowded': 1, 88 | 'in_progress': 2, 89 | 'completed': 3 90 | } 91 | 92 | $scope.sortOrder = function(project) { 93 | return mapping[project.status]; 94 | } 95 | 96 | $scope.getDefaultProjectsMetadata = function () { 97 | $http.get('data/projects.liquid') 98 | .then(function (res) { 99 | $scope.projectList = res.data; 100 | $scope.projectRequest(); 101 | }) 102 | } 103 | 104 | $scope.lang = Languages.getData(); 105 | 106 | $scope.getDefaultProjectsMetadata(); 107 | 108 | $scope.$watch( function () { 109 | return Languages.getData(); 110 | }, function () { 111 | $scope.setLanguage(Languages.getData()); 112 | }, true); 113 | 114 | 115 | $scope.setLanguage = function (val) { 116 | $scope.lang = val; 117 | $scope.updateProjects(); 118 | } 119 | 120 | $scope.updateProjects = function () { 121 | if ($scope.lang != 'en') { 122 | $http.get('data/locale/'+$scope.lang+'/projects.json') 123 | .then(function (res) { 124 | $scope.projectList.map(function (project) { 125 | if (res.data[project.markdown]) { 126 | Object.keys(project).map(function (key) { 127 | if (res.data[project.markdown][key]) { 128 | project[key] = res.data[project.markdown][key] 129 | } 130 | }); 131 | } 132 | }); 133 | 134 | $scope.projectRequest(); 135 | }); 136 | } else { 137 | $scope.getDefaultProjectsMetadata(); 138 | $scope.projectRequest(); 139 | } 140 | } 141 | 142 | function generateMarkdown() { 143 | 144 | function setFromDefault() { 145 | $http.get($scope.currentProject.content_url) 146 | .then(function (res) { 147 | $scope.currentProject.content = res.data 148 | }, function() { 149 | $scope.currentProject.content = 'No content' 150 | }); 151 | } 152 | 153 | if ($scope.lang != 'en') { 154 | $http.get('data/locale/' + $scope.lang + '/projects/' + $scope.currentProject.markdown).then(function (res) { 155 | $scope.currentProject.content = res.data 156 | }, function () { 157 | setFromDefault() 158 | }); 159 | } else { 160 | setFromDefault() 161 | } 162 | } 163 | 164 | self.showProject = function (project) { 165 | 166 | $scope.currentProject = project 167 | 168 | $(document).ready(function () { 169 | $('.modal').modal('open'); 170 | }); 171 | 172 | mval = encodeURIComponent(project["name"].split(' ').join('_').toLowerCase()); 173 | $location.url('?project=' + mval + ( $scope.lang ? '&lang=' + $scope.lang : '' )) 174 | $scope.$evalAsync(); 175 | 176 | generateMarkdown() 177 | } 178 | 179 | self.showProjectOnArrowClick = function (project) { 180 | 181 | $scope.currentProject = project 182 | mval = encodeURIComponent(project["name"].split(' ').join('_').toLowerCase()); 183 | $location.url('?project=' + mval + ( $scope.lang ? '&lang=' + $scope.lang : '' )) 184 | $scope.$evalAsync(); 185 | generateMarkdown() 186 | } 187 | 188 | $scope.search = function (arg) { 189 | $scope.searchText = arg 190 | } 191 | 192 | $scope.redirect = function (arg) { 193 | window.open(arg, '_blank'); 194 | } 195 | 196 | $scope.updateLink = function () { 197 | $scope.currentProject = null; 198 | $location.url($location.path()); 199 | } 200 | 201 | $scope.encode_URI = function (project_name) { 202 | return encodeURIComponent(project_name.split(' ').join('_').toLowerCase()); 203 | } 204 | 205 | $scope.arrowPressed = function (e) { 206 | if(e.keyCode == 37){ 207 | keyPressed = "left" 208 | $scope.moveToNext(keyPressed); 209 | } 210 | else if(e.keyCode == 39){ 211 | keyPressed = "right" 212 | $scope.moveToNext(keyPressed); 213 | } 214 | 215 | } 216 | 217 | $scope.moveToNext = function (keyPressed) { 218 | if($scope.currentProject){ 219 | 220 | total_projects = $scope.projectList.length 221 | angular.forEach($scope.projectList, function(value, key){ 222 | if($scope.currentProject.name == value["name"]){ 223 | current_project_index = key 224 | } 225 | }); 226 | 227 | if(keyPressed == "left"){ 228 | if(current_project_index == 0){ 229 | self.showProjectOnArrowClick($scope.projectList[total_projects-1]) 230 | }else{ 231 | self.showProjectOnArrowClick($scope.projectList[--current_project_index]) 232 | } 233 | } 234 | if(keyPressed == "right"){ 235 | if(current_project_index == total_projects-1){ 236 | self.showProjectOnArrowClick($scope.projectList[0]) 237 | }else{ 238 | self.showProjectOnArrowClick($scope.projectList[++current_project_index]) 239 | } 240 | } 241 | } 242 | } 243 | 244 | $scope.projectRequest = function () { 245 | 246 | var redirectTo = { 247 | "integrate_pyflakes-enhanced_ast_into_coala_" : "integrate_pyflakes-enhanced_ast_into_coala" 248 | }; 249 | $scope.projects_url_dict = {} 250 | $scope.projects_url_list = Object.keys($scope.projects_url_dict); 251 | angular.forEach($scope.projectList, function(value, key){ 252 | value["url"] = encodeURIComponent(value["name"].split(' ').join('_').toLowerCase()); 253 | $scope.projects_url_dict[value["url"]] = key 254 | }); 255 | 256 | var project_requested = encodeURIComponent($location.search().project); 257 | if(project_requested){ 258 | if(project_requested in redirectTo){ 259 | project_requested = redirectTo[project_requested] 260 | } 261 | if(Object.keys($scope.projects_url_dict).indexOf(project_requested) > -1){ 262 | self.showProject($scope.projectList[$scope.projects_url_dict[project_requested]]) 263 | } 264 | } 265 | } 266 | 267 | var search_requested = $location.search().q; 268 | if(search_requested){ 269 | $scope.searchText = search_requested 270 | } 271 | 272 | }, 273 | controllerAs: 'lc' 274 | } 275 | }]); 276 | 277 | app.directive('faq',[ '$http', '$templateCache', function ($http, $templateCache, Languages) { 278 | return { 279 | restrict: 'E', 280 | templateUrl: 'partials/tabs/faq.html', 281 | controller: function ($scope, Languages) { 282 | $scope.lang = Languages.getData(); 283 | 284 | $scope.getDefaultFAQMetadata = function () { 285 | $http.get('data/faq.liquid') 286 | .then(function (res) { 287 | $scope.faqs = res.data; 288 | $scope.generateMarkdown(); 289 | }) 290 | } 291 | 292 | $scope.lang = Languages.getData(); 293 | 294 | $scope.getDefaultFAQMetadata(); 295 | 296 | $scope.$watch( function () { 297 | return Languages.getData(); 298 | }, function () { 299 | $scope.setLanguage(Languages.getData()); 300 | }, true); 301 | 302 | 303 | $scope.setLanguage = function (val) { 304 | $scope.lang = val; 305 | $scope.updateFAQ(); 306 | } 307 | 308 | $scope.updateFAQ = function () { 309 | if ($scope.lang != 'en') { 310 | 311 | $http.get('data/locale/'+$scope.lang+'/faq.json') 312 | .then(function (res) { 313 | $scope.faqs.map(function (faq) { 314 | if (res.data[faq.markdown]) { 315 | Object.keys(faq).map(function (key) { 316 | if (res.data[faq.markdown]) { 317 | faq['question'] = res.data[faq.markdown] 318 | 319 | } 320 | }); 321 | } 322 | }); 323 | $scope.generateMarkdown(); 324 | }); 325 | } else { 326 | $scope.getDefaultFAQMetadata(); 327 | } 328 | } 329 | 330 | $scope.generateMarkdown = function() { 331 | 332 | if ($scope.lang != 'en') { 333 | $scope.faqs.forEach(function (faq, key) { 334 | $http.get('data/locale/' + $scope.lang + '/faq/' + faq.markdown) 335 | .then(function (res) { 336 | $scope.faqs[key].answer = res.data 337 | }, function (error) { 338 | $http.get($scope.faqs[key].url) 339 | .then(function (res) { 340 | $scope.faqs[key].answer = res.data; 341 | }) 342 | }); 343 | }) 344 | } else { 345 | $scope.faqs.forEach(function (f, k) { 346 | $http.get($scope.faqs[k].url) 347 | .then(function (res) { 348 | $scope.faqs[k].answer = res.data 349 | }); 350 | }) 351 | } 352 | } 353 | 354 | }, 355 | controllerAs: 'toc' 356 | } 357 | }]); 358 | 359 | app.filter('format_issue', function () { 360 | return function (value) { 361 | if (!value) return ''; 362 | res = value.split('/'); 363 | last = res.length - 1; 364 | return res.slice(3, last - 1).join('/') + '#' + res[last]; 365 | }; 366 | }); 367 | 368 | app.directive('mentors', ['$http', function ($http) { 369 | return { 370 | restrict: 'E', 371 | templateUrl: 'partials/tabs/mentors.html', 372 | controller: function ($scope, $rootScope) { 373 | self = this 374 | self.mentorsList = {} 375 | self.adminsList = {} 376 | 377 | $http.get('data/projects.liquid') 378 | .then(function (res) { 379 | $scope.projects = res.data.filter(project => project.status != "completed") 380 | angular.forEach($scope.projects, function(value, key){ 381 | angular.forEach(value.mentors, function(value, key){ 382 | self.mentorsList[value] = { 383 | "github_handle" : value, 384 | "github_avatar_url": "https://avatars.githubusercontent.com/" +value 385 | } 386 | }); 387 | }); 388 | }) 389 | 390 | $http.get('data/admins.json') 391 | .then(function (res) { 392 | admins = res.data 393 | angular.forEach(admins, function(value, key){ 394 | self.adminsList[value] = { 395 | "github_handle" : value, 396 | "github_avatar_url": "https://avatars.githubusercontent.com/" +value 397 | 398 | } 399 | }); 400 | }) 401 | 402 | }, 403 | controllerAs: "gic" 404 | } 405 | }]); 406 | 407 | })(); 408 | -------------------------------------------------------------------------------- /IDEAS.md: -------------------------------------------------------------------------------- 1 | Google Summer Of Code Matrix Ideas, 2018 Edition!! 2 | ================================================================= 3 | 4 | 5 | 6 | 7 | 8 | - [What is Matrix?](#what-is-matrix) 9 | - [APIs and Architecture](#apis-and-architecture) 10 | - [Code repositories:](#code-repositories) 11 | - [What should my proposal look like?](#what-should-my-proposal-look-like) 12 | - [Potential GSoC ideas:](#potential-gsoc-ideas) 13 | - [Contribute to Dendrite](#contribute-to-dendrite) 14 | - [Building Bridges!](#building-bridges) 15 | - [Bridge Project Suggestions](#bridge-project-suggestions) 16 | - [Bots & Integrations to ALL THE THINGS!!](#bots--integrations-to-all-the-things) 17 | - [Alternative Push Notification Transport](#alternative-push-notification-transport) 18 | - [Matrix Visualisations](#matrix-visualisations) 19 | - [Adding end-to-end encryption to more clients](#adding-end-to-end-encryption-to-more-clients) 20 | - [Alternative Efficient Client-Server Transports and Encodings](#alternative-efficient-client-server-transports-and-encodings) 21 | - [Extending Native Matrix Desktop Clients](#extending-native-matrix-desktop-clients) 22 | - [Finishing matrix-ircd](#finishing-matrix-ircd) 23 | - [IPFS support for content repositories](#ipfs-support-for-content-repositories) 24 | - [Ideas below this point almost certainly require more effort than the GSoC format allows, but are included here for interest's sake.](#ideas-below-this-point-almost-certainly-require-more-effort-than-the-gsoc-format-allows-but-are-included-here-for-interests-sake) 25 | - [Peer-to-peer Matrix](#peer-to-peer-matrix) 26 | - [Decentralised accounts](#decentralised-accounts) 27 | - [Decentralised identity](#decentralised-identity) 28 | - [Decentralised reputation](#decentralised-reputation) 29 | - [Decentralised Search](#decentralised-search) 30 | - [Matrix Virtual World](#matrix-virtual-world) 31 | 32 | 33 | 34 | 35 | What is Matrix? 36 | ------------------ 37 | 38 | Matrix is a decentralised communication specification for clients and servers. It is designed to replicate conversation data across multiple servers via federation, meaning that there are no single points of control or failure for conversations or their history. Anyone can run their own "home" server, or use one hosted by someone else (e.g. ``matrix.org``). All communication uses HTTP(S) and data is represented as JSON objects, scoped to a "room", which consists of a group of users. Matrix is designed to make it easy to bridge existing communication apps and networks, making Matrix a global decentralised "meta-network" for connecting (or matrixing!) together all of today's communication silos. 39 | 40 | Matrix is completely open and transparent: all of our designs, implementations, testing and bug tracking are publicly available on Github and matrix.org, and our day-to-day design discussions take place on public channels on ``matrix.org``. Anyone can contribute to the specification to help improve it. We also provide reference implementations of a [python server](https://github.com/matrix-org/synapse) and clients in [React](https://github.com/vector-im/vector-web), [Android](https://github.com/matrix-org/matrix-android-sdk) and [iOS](https://github.com/matrix-org/matrix-ios-sdk). 41 | 42 | To date, Matrix has been used as a communications protocol for a wide range of technologies, including (but not limited to): 43 | - [Instant messaging](https://vector.im) 44 | - [WebRTC](http://www.webrtcworld.com/videos.aspx?vid=10786) 45 | - [Internet of Things](https://fosdem.org/2015/schedule/event/deviot04/) 46 | - Program-specific data (MIDI, 3D animations) 47 | 48 | In the end, we hope Matrix will crack the problem of a widely successful open federated platform for communication on the internet, which bridges together all of today's existing communication silos into a single open communication meta-network. 49 | 50 | 51 | APIs and Architecture 52 | ------------------------- 53 | In Matrix, a user account belongs to a homeserver and looks like this: *@localpart:domain* - the localpart is the "username" and the domain is the homeserver on which the account belongs. In other words, *@user1:matrix.org* is a different user to *@user1:example.com* as they are registered on different homeservers. 54 | 55 | In the Matrix network, anyone can run a homeserver. Anyone can also run a client, and you can connect to any homeserver from any client. 56 | 57 | A client typically represents a human using a web application or mobile app. Clients use the ["Client-to-Server" (C-S) API](https://matrix.org/docs/spec/client_server/latest) to communicate with their homeserver, which stores their profile data and their record of the conversations in which they participate. 58 | 59 | A "homeserver" is a server where conversation history and user accounts are stored, and provides C-S APIs and has the ability to federate with other HSes to replicate conversation history across all the servers which participate in a given room via the [Federation API](http://matrix.org/docs/spec/r0.0.1/server_server.html). It is typically responsible for multiple clients. "Federation" is the term used to describe the sharing of data between two or more homeservers. 60 | 61 | Finally, "application services" are privileged clients which can provide bridges and integrations to other networks and platforms, exposing 'virtual' users and rooms which map through to concepts outside of Matrix. These are fundamental to bridging existing silos into Matrix, and are specified in the ["Application Service API"](http://matrix.org/docs/spec/r0.0.1/application_service.html). 62 | 63 | Here is a diagram of this architecture: 64 | 65 | How data flows between clients 66 | ============================== 67 | 68 | { Matrix client A } { Matrix client B } 69 | ^ | ^ | 70 | | events | | events | 71 | | C-S API V | C-S API V 72 | +------------------+ +------------------+ +-------------+ 73 | | |----( HTTPS )--->| |----( HTTPS )--->| Application | 74 | | Home Server | | Home Server | | Service | 75 | | |<---( HTTPS )----| |<---( HTTPS )----| | 76 | +------------------+ Federation +------------------+ App Svc API +-------------+ 77 | | ^ 78 | v | 79 | IRC, Slack, Skype etc 80 | 81 | Code repositories: 82 | ------------------ 83 | Projects lead by matrix.org are stored under [https://github.com/matrix-org](https://github.com/matrix-org/): 84 | 85 | * [Reference python server](https://github.com/matrix-org/synapse) 86 | * ['Riot' React client](https://github.com/vector-im/riot-web) 87 | * [Reference react SDK](https://github.com/matrix-org/matrix-react-sdk) 88 | * [JavaScript client SDK](https://github.com/matrix-org/matrix-js-sdk) 89 | * [Reference Android SDK](https://github.com/matrix-org/matrix-android-sdk) 90 | * [Reference iOS SDK](https://github.com/matrix-org/matrix-ios-sdk) 91 | * [Python client SDK](https://github.com/matrix-org/matrix-python-sdk) 92 | 93 | ...and many many more: see https://matrix.org/blog/try-matrix-now for the full list of existing projects. 94 | 95 | 96 | What should my proposal look like? 97 | ---------------------------------- 98 | 99 | Please make sure you have read https://github.com/matrix-org/GSoC/blob/master/README.md#how-do-i-write-my-gsoc-application which has all the details of what we'd expect from your proposal :) 100 | 101 | 102 | Potential GSoC ideas: 103 | --------------------- 104 | Remember that you can also use these as inspiration and suggest your own project ideas. 105 | 106 | **This is list is prioritised - most important suggestions first** 107 | 108 | ### Contribute to Dendrite 109 | 110 | [Dendrite](https://github.com/matrix-org/dendrite) is a work in progress matrix homeserver written in Go. Being a large 111 | project there are many areas of the homeserver APIs that a GSoC project could 112 | work on, there is a 113 | [spreadsheet](https://docs.google.com/spreadsheets/d/1tkMNpIpPjvuDJWjPFbw_xzNzOHBA-Hp50Rkpcr43xTw) 114 | that tracks the current implementation status of the various APIs. A good GSoC 115 | proposal would use this and discussion with mentors and the community to find an 116 | appropriate and realistic subset of these APIs to work on during the project. 117 | 118 | **Expected results**: Add implementations, unit tests & integration tests for an agreed set of missing APIs for Dendrite, based on the Matrix Spec and/or taking inspiration from the legacy Python implementation. 119 | 120 | **Difficulty**: Ranges from Easy through to Hard depending on the API! 121 | 122 | **Knowledge pre-req**: Good knowledge of Golang and HTTP/REST APIs in general. 123 | 124 | Potential mentors: Erik Johnston ([github](https://github.com/erikjohnston)), Richard van der Hoff ([github](https://github.com/richvdh)) 125 | 126 | ### Building Bridges! 127 | 128 | Bridging (linking existing networks into the wider Matrix ecosystem) is one of the most important bits of Matrix, and one of the most rewarding. There are a large number of bridges, in various languages and in various states of maturity. 129 | 130 | matrix.org has a number of bridges, in various states of development: 131 | 132 | * Production grade: 133 | * IRC: https://github.com/matrix-org/matrix-appservice-irc 134 | * Slack: https://github.com/matrix-org/matrix-appservice-slack 135 | * Gitter: https://github.com/matrix-org/matrix-appservice-gitter 136 | * Beta grade: 137 | * RocketChat: https://github.com/matrix-org/matrix-appservice-rocketchat 138 | * Verto (FreeSWITCH): https://github.com/matrix-org/matrix-appservice-verto 139 | * Alpha grade: 140 | * Libpurple https://github.com/matrix-org/node-purple/tree/master/appservice 141 | * Asterisk https://github.com/matrix-org/matrix-appservice-respoke 142 | 143 | There are also a large number of community bridges, for example: 144 | 145 | * Telegram https://github.com/SijmenSchoon/telematrix, https://github.com/tulir/mautrix-telegram/, https://github.com/matrix-org/matrix-appservice-tg 146 | * Hangouts - https://github.com/Cadair/matrix-appservice-hangouts using the [hangups](http://hangups.readthedocs.io/) library. 147 | * Discord - An alpha implementation is here: https://github.com/Half-Shot/matrix-appservice-discord 148 | * XMPP - there are some promising bridges, but none are comprehensive. https://github.com/pztrn/matrix-xmpp-bridge is the most advanced, but there's still lots ot work to go to make it perfect. 149 | * see the full list at https://matrix.org/blog/try-matrix-now under Application Services. 150 | 151 | 152 | #### Bridge Project Suggestions 153 | 154 | There are a *lot* of potential projects in all the various matrix bridges, below 155 | is a few ideas to get you started. A good room to join if you are interested in 156 | working on bridges is 157 | [#bridges:matrix.org](https://matrix.to/#/#bridges:matrix.org) 158 | 159 | 160 | 1. Add user puppeting support to the Slack and Gitter bridges, this would allow 161 | users to login with their account details and send messages to Gitter/Slack 162 | as themselves. In a similar way to the IRC bridge. 163 | 164 | 2. Work with the maintainers of any of the community bridges to develop new 165 | features or improve the reliability. 166 | 167 | 3. Develop a new bridge for the service of your choice. Some suggestions of desired bridges from the community can be found [here](https://github.com/turt2live/matrix-wishlist/issues?q=is%3Aissue+is%3Aopen+label%3Abridge) 168 | 169 | 170 | Bridges are relatively easy and fun to write, and we would *love* for GSoCers to get involved in writing new bridges and polishing the existing ones. 171 | 172 | By default our preferred language for writing bridges is in Node.js (ES6), so we can build on top of the https://github.com/matrix-org/matrix-appservice-bridge library which provides a bunch of useful infrastructure and boilerplate. If there already exists a project in another language or if the remote network lacks good Node library support we consider other languages though. 173 | 174 | **Expected results**: Bridging matrix rooms and users into one or more of the above environments - ideally supporting dynamic users (i.e. auto-creating users on both sides of the bridge on demand) and dynamic rooms (i.e. bridging the whole namespace of the remote network into matrix). 175 | 176 | **Difficulty**: Ranges from Easy through to Hard depending on the network! 177 | 178 | **Knowledge pre-req**: Good knowledge of HTTP/REST APIs in general. 179 | 180 | **Potential mentor**: Matthew Hodgson ([github](https://github.com/Ara4n)) 181 | 182 | 183 | ### Bots & Integrations to ALL THE THINGS!! 184 | 185 | As well as bridging, we're building out a large ecosystem of integrations (also known as bots) to let folks interact with other services from Matrix. Today this is mainly in Go, with https://github.com/matrix-org/go-neb being the flagship bot project. However, there's also the python incarnation (https://github.com/matrix-org/Matrix-NEB) as well as Hubot adaptors like https://github.com/davidar/hubot-matrix and other bot frameworks like https://gitlab.com/argit/hello-matrix-bot or https://github.com/opsdroid/connector-matrix . 186 | 187 | Bots can be written in any language, and we have a wide range of SDKs already available to help people get up and running - from everything from Node to Python to Perl to Ruby to Elixir... 188 | 189 | Platforms we'd love to integrate with via native Matrix bots include: 190 | * Trello bot 191 | * Twitter bot 192 | * Basecamp bot 193 | * IFTTT 194 | * Zapier 195 | * Nagios 196 | * Medium Bot 197 | * Wordpress Bot 198 | * HackerNews Bot 199 | * Reddit Bot 200 | * Tumblr Bot 201 | * NNTP Bot 202 | * VBulletin bot 203 | * phpBB bot 204 | * SMF bot 205 | * Discourse bot 206 | * ... 207 | 208 | Possible standalone bots include: 209 | * Personal assistant bots (integrate with calendar, todo-lists etc) 210 | * "Get started with Riot" guide bot 211 | 212 | Extensions include: 213 | * Extending bots to be metadata aware: https://github.com/matrix-org/matrix-doc/pull/93 once landed 214 | * Building UI modules for Riot to provide a 'conversational interface' UI onto the bots 215 | * Extending bots into bridges, where appropriate. 216 | 217 | **Expected results**: Creating client-server API bots that respond to !-commands to interact with the given integrated services, and/or inject messages into rooms based on those services. 218 | 219 | **Difficulty**: Ranges from Easy through to Medium depending on the service! 220 | 221 | **Knowledge pre-req**: Good knowledge of HTTP/REST APIs in general. 222 | 223 | **Potential mentor**: Dave Baker ([github](https://github.com/dbkr)) 224 | 225 | 226 | ### Alternative Push Notification Transport 227 | 228 | Battery life for matrix-android-sdk apps (e.g. Riot/Android) on Fdroid is currently very bad as in the absence of GCM (Google Cloud Messaging), we have to poll the server for new notifications. This project would build or extend an existing push server to provide an alternative to GCM and APNS that matrix clients like Riot/Android can use to receive push notifications. An example server already exists from the community at https://github.com/slp/matrix-pushgw but nobody has yet written clients for it. This is related to the "Alternative Efficient Client-Server Transports and Encodings" project below, although that aims to replace the whole client-server API transport, whereas this would be optimised strictly for receiving push notifications. 229 | 230 | **Difficulty**: Medium 231 | 232 | **Knowledge pre-req**: Network protocols, Language for the platforms being targeted 233 | 234 | **Potential mentor**: Richard van der Hoff ([github](https://github.com/richvdh)) 235 | 236 | 237 | ### Matrix Visualisations 238 | 239 | When developing on Matrix it's often quite hard to visualise the underlying replicated Directed Acyclic Graph datastructure that describes the conversation history in a room. We've made some basic tools in the past like https://github.com/Kegsay/matrix-vis and https://github.com/matrix-org/synapse/tree/master/contrib/graph and https://github.com/erikjohnston/matrix-introspection but what would be really cool would be a real-time visualisation of the DAG to help folks understand Matrix, and help developers debug interesting edge cases and merge resolution scenarios when the DAG bifurcates. This could be written in any language, talking some combination of the server-server API or an enhanced version of the client-server API or just inspecting your synapse's database to visualise what's going on. 240 | 241 | **Expected results**: A realtime visualisation of the DAG of a given Matrix room, as seen from the perspective of one or more HSes. 242 | 243 | **Difficulty**: Medium 244 | 245 | **Knowledge pre-req**: Good knowledge of HTTP/REST APIs in general. 246 | 247 | **Potential mentor**: Erik Johnston ([github](https://github.com/ErikJohnston)) 248 | 249 | 250 | ### Adding end-to-end encryption to more clients 251 | 252 | A lot of effort in Matrix is being put into End-to-End Encryption using the Olm & Megolm cryptographic ratchets (as assessed by NCC Group - see https://matrix.org/blog/2016/11/21/matrixs-olm-end-to-end-encryption-security-assessment-released-and-implemented-cross-platform-on-riot-at-last/ for details. 253 | 254 | However, the current implementation has only landed in matrix-js-sdk, matrix-ios-sdk and matrix-android-sdk. As a result, any client or bridge or bot which isn't built on one of those codebases is currently out of luck. 255 | 256 | In this project, you would port the application-layer E2E implementation to one or more other clients - e.g. to Golang for use with go-neb, or to C++ for libqmatrixclient (as used by the Quaternion, Spectral & Tensor desktop clients) or to C for matrix-purple (as used by Pidgin). Alternatively, you might consider implementing an E2E-aware matrix proxy which *any* client can connect to (when running locally) to share encrypted communication with the rest of Matrix. 257 | 258 | This would be a great way to improve your cryptography skills and learn about one of the most exciting and ambitious E2E cryptography projects out there. 259 | 260 | **Expected results**: Extend other Matrix clients to speak E2E, or implement an E2E-aware Matrix Proxy 261 | 262 | **Difficulty**: Hard 263 | 264 | **Knowledge pre-req**: Cryptography. The language for the platform you are targetting. 265 | 266 | **Potential mentor**: Hubert Chathi ([github](https://github.com/uhoreg)), Matthew Hodgson ([github](https://github.com/ara4n)) 267 | 268 | ### Alternative Efficient Client-Server Transports and Encodings 269 | 270 | Matrix's baseline Client-Server API is simple long-polling HTTP calls. This is purely for compatibility and simplicity for the widest range of client devices and applications, however - we encourage and expect people to implement more efficient transports and encodings in future. For instance, we've published and implemented a beta Websockets transport draft at https://github.com/matrix-org/matrix-doc/blob/master/drafts/websockets.rst and https://github.com/matrix-org/matrix-websockets-proxy. 271 | 272 | It would be *really* fun to experiment with other transports and encodings to find just how fast, low latency, low CPU or low bandwidth one can make the Client Server API run. This could involve playing around with COaP+CBOR, MQTT, protobufs, capnproto, messagepack, HTTP/2 or any other option in a quest for the holy grail transport/encoding combination! 273 | 274 | **Difficulty**: Medium 275 | 276 | **Knowledge pre-req**: Network protocols 277 | 278 | **Potential mentor**: Richard van der Hoff ([github](https://github.com/richvdh)) 279 | 280 | 281 | ### Extending Native Matrix Desktop Clients 282 | 283 | There are several native Matrix Desktop Clients in development... 284 | 285 | * Nheko (Qt + C++) https://github.com/mujx/nheko 286 | * NaChat (Qt + C++) https://github.com/Ralith/nachat 287 | * Quaternion (QML + C++) https://github.com/fxrh/quaternion 288 | * Tensor (QML + JS) https://github.com/davidar/tensor 289 | * Unplug (JavaFX + Kotlin) https://github.com/UprootLabs/unplug 290 | * MatrixClient (macOS + Swift) https://github.com/aapierce0/MatrixClient 291 | * Pidgin (glib + C + libpurple) https://github.com/matrix-org/purple-matrix 292 | 293 | ...all of which could be extended further. Developers wanting to improve and hack features into fun desktop clients would be welcome here! 294 | 295 | **Expected results**: Add new features to NaChat, Quaternion, Tensor etc. 296 | 297 | **Difficulty**: Easy to Moderate 298 | 299 | **Knowledge pre-req**: Familiarity with web services, the language used for implementing the client (e.g. ObjectiveC, Java) 300 | 301 | **Potential mentor**: David Baker ([github](https://github.com/dbkr)) 302 | 303 | 304 | ### Finishing matrix-ircd 305 | 306 | https://github.com/matrix-org/matrix-ircd is a new project that provides an IRC front-end to any Matrix homeserver, written in Rust, which means anyone can point their existing IRC clients into Matrix, treating as a giant distributed ircd. This helps people get up and running in the Matrix ecosystem without having to jump all the way to a Matrix client (or bridge via an existing IRC network). It's in early beta currently, but fun to hack on with lots of functionality still to be finished. 307 | 308 | **Expected results**: Add features and stability to matrix-ircd and get irc.matrix.org running as an IRC interface into the guts of Matrix! 309 | 310 | **Difficulty**: Easy to Moderate 311 | 312 | **Knowledge pre-req**: Basic Rust and familiarity with web services. 313 | 314 | **Potential mentor**: Erik Johnston ([github](https://github.com/erikjohnston)) 315 | 316 | 317 | ### IPFS support for content repositories 318 | 319 | Currently Matrix uses a basic distributed content repository based on replicating data over HTTPS between its servers. It could be nice to support storing data in IPFS instead, providing dedicated p2p distributed immutable data storage rather than the stop-gap solution that Matrix provides. 320 | 321 | **Expected Results**: Extend synapse to optionally store and load content from IPFS, and extend one or more matrix clients (e.g. Riot) to natively load/store content from IPFS clientside. 322 | 323 | **Difficulty**: Medium 324 | 325 | **Potential mentor**: Matthew Hodgson ([github](https://github.com/ara4n)) 326 | 327 | 328 | --- 329 | 330 | Ideas below this point almost certainly require more effort than the GSoC format allows, but are included here for interest's sake. 331 | ----------------------------------------------------------------------------------------------------------------------------------- 332 | 333 | 334 | ### Peer-to-peer Matrix 335 | 336 | Matrix currently follows a client-server architecture, where the servers federate together. This means that to host your own conversations in Matrix you have to own and maintain a server with a static IP and DNS SRV record etc. This isolates many people from running their own Matrix nodes. An interesting experiment would be to write a homeserver variant (probably in Node.js) which advertises itself via a DHT or similar (e.g. using js-libp2p) and uses WebRTC data channels for p2p synchronisation of message graph data. This could make it much easier to run homeservers - either as a standalone node daemon, or built into a desktop or even web client. Such a server would implement the basic features of today's Matrix C-S API, but obviously break compatibility with today's Matrix S-S API. An extension might be to write a bridge between the two federation protocols. 337 | 338 | **Expected Results**: A proof-of-concept P2P Matrix homeserver in Node 339 | 340 | **Difficulty**: Hard 341 | 342 | **Knowledge pre-req**: P2P tech, JavaScript 343 | 344 | **Potential mentor**: Matthew Hodgson ([github](https://github.com/ara4n)) 345 | 346 | 347 | ### Decentralised accounts 348 | 349 | Currently Matrix accounts are stored on a single homeserver. This is far from decentralised and produces an unfortunate single point of failure and control for the user. It would be fantastic to evolve Matrix to support replicating account data across multiple servers, and let clients pick which home server they talk to. There is significant overlap in solving this with the 'Peer-to-peer Matrix' proposal. 350 | 351 | **Expected Results**: Extend the matrix spec and homeserver to support decoupling accounts from DNS, and allowing multiple trusted servers to host the data. 352 | 353 | **Difficulty**: Hard 354 | 355 | **Potential mentor**: Matthew Hodgson ([github](https://github.com/ara4n)), Erik Johnston ([github](https://github.com/erikjohnston)) 356 | 357 | 358 | ### Decentralised identity 359 | 360 | Currently the mapping of 3rd party IDs (e.g. email addresses) through to Matrix IDs is performed by a logically centralised ID server. This project would create a decentralised datastore of ID mappings - e.g. using DataEntry objects in a stellar-core ledger, or some other distributed secure data structure, with trusted identity providers entering verified ID mappings into the store. 361 | 362 | **Expected Results**: Replace the current `sydent` ID server implementation with a decentralised equivalent. 363 | 364 | **Difficulty**: Hard 365 | 366 | **Knowledge pre-req**: Secure distributed data-structures, Security, Cryptography 367 | 368 | **Potential mentor**: Matthew Hodgson ([github](https://github.com/ara4n)), Erik Johnston ([github](https://github.com/erikjohnston)) 369 | 370 | 371 | 372 | ### Decentralised reputation 373 | 374 | Mitigating abuse is an ongoing area of research in Matrix. Tracking realtime reputation data for Matrix endpoints, such that users can report abuse and filter their communication to hide abusive content is the holy grail. There are some very early thoughts on this [here](https://github.com/matrix-org/matrix-doc/blob/master/drafts/reputation_thoughts.rst). Anyone interested in researching the holy grail of abuse mitigation is welcome to experiment here! 375 | 376 | **Expected Results**: Add upvote/downvote functionality to Matrix spec, gather the data in a secure decentralised datastructure that can be mined for cluster analysis, and publish reputation data that Matrix clients can align themselves with when filtering abusive content. 377 | 378 | **Difficulty**: Hard 379 | 380 | **Knowledge pre-req**: Distributed data-structures; Graph databases; Data analytics 381 | 382 | **Potential mentor**: Matthew Hodgson ([github](https://github.com/ara4n)) 383 | 384 | 385 | ### Decentralised Search 386 | 387 | Matrix provides a basic full-text search API and implementation in Synapse. Would be great to build a cross-Matrix search engine however, especially a decentralised one. 388 | 389 | **Expected results**: A Matrix spider that consumes public event data from Matrix and indexes into a decentralised secure datastructure that can then be queried for rapid cross-Matrix search results. 390 | 391 | **Difficulty**: Moderate/Hard 392 | 393 | **Knowledge pre-req**: Familiarity with web services, the language used for implementing the application service (e.g. Python if using our reference example service framework). Basic HTML/CSS/Javascript needed to implement the search engine interface frontend. 394 | 395 | **Potential mentor**: Matthew Hodgson ([github](https://github.com/ara4n)) 396 | 397 | 398 | 399 | ### Matrix Virtual World 400 | 401 | By integrating WebGL (e.g. using a library like ThreeJS) with Matrix, one can create a collaborative virtual world whose data is persisted in Matrix, replicated over all participating Matrix homeservers with no single points of control or failure. If implemented as a generic platform, one could first start off by sharing 3D geometry in the world, and then defining higher level semantics (perhaps in combination with matrix Application Services) to define business logic for the world. A good example could be building a collaborative 3D model editor on top of Matrix, or a 2D collaborative graphical programming environment. 402 | 403 | **Expected results**: A WebGL Matrix client that renders 3D geometry described in Matrix, allowing direct manipulation and operational transforms for concurrent access. 404 | 405 | **Difficulty**: Hard 406 | 407 | **Knowledge pre-req**: 3D graphics, WebGL, Operational Transform theory all a plus. Would likely require optimisations and/or extensions to the server to support storing object graphs in Matrix. 408 | 409 | **Potential mentor**: Matthew Hodgson ([github](https://github.com/ara4n)) 410 | 411 | -------------------------------------------------------------------------------- /resources/vendors/angular-sanitize/angular-sanitize.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @license AngularJS v1.6.1 3 | * (c) 2010-2016 Google, Inc. http://angularjs.org 4 | * License: MIT 5 | */ 6 | (function(window, angular) {'use strict'; 7 | 8 | /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 9 | * Any commits to this file should be reviewed with security in mind. * 10 | * Changes to this file can potentially create security vulnerabilities. * 11 | * An approval from 2 Core members with history of modifying * 12 | * this file is required. * 13 | * * 14 | * Does the change somehow allow for arbitrary javascript to be executed? * 15 | * Or allows for someone to change the prototype of built-in objects? * 16 | * Or gives undesired access to variables likes document or window? * 17 | * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 18 | 19 | var $sanitizeMinErr = angular.$$minErr('$sanitize'); 20 | var bind; 21 | var extend; 22 | var forEach; 23 | var isDefined; 24 | var lowercase; 25 | var noop; 26 | var htmlParser; 27 | var htmlSanitizeWriter; 28 | 29 | /** 30 | * @ngdoc module 31 | * @name ngSanitize 32 | * @description 33 | * 34 | * # ngSanitize 35 | * 36 | * The `ngSanitize` module provides functionality to sanitize HTML. 37 | * 38 | * 39 | *
40 | * 41 | * See {@link ngSanitize.$sanitize `$sanitize`} for usage. 42 | */ 43 | 44 | /** 45 | * @ngdoc service 46 | * @name $sanitize 47 | * @kind function 48 | * 49 | * @description 50 | * Sanitizes an html string by stripping all potentially dangerous tokens. 51 | * 52 | * The input is sanitized by parsing the HTML into tokens. All safe tokens (from a whitelist) are 53 | * then serialized back to properly escaped html string. This means that no unsafe input can make 54 | * it into the returned string. 55 | * 56 | * The whitelist for URL sanitization of attribute values is configured using the functions 57 | * `aHrefSanitizationWhitelist` and `imgSrcSanitizationWhitelist` of {@link ng.$compileProvider 58 | * `$compileProvider`}. 59 | * 60 | * The input may also contain SVG markup if this is enabled via {@link $sanitizeProvider}. 61 | * 62 | * @param {string} html HTML input. 63 | * @returns {string} Sanitized HTML. 64 | * 65 | * @example 66 | 67 | 68 | 80 |
81 | Snippet: 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 |
DirectiveHowSourceRendered
ng-bind-htmlAutomatically uses $sanitize
<div ng-bind-html="snippet">
</div>
ng-bind-htmlBypass $sanitize by explicitly trusting the dangerous value 99 |
<div ng-bind-html="deliberatelyTrustDangerousSnippet()">
100 | </div>
101 |
ng-bindAutomatically escapes
<div ng-bind="snippet">
</div>
111 |
112 |
113 | 114 | it('should sanitize the html snippet by default', function() { 115 | expect(element(by.css('#bind-html-with-sanitize div')).getAttribute('innerHTML')). 116 | toBe('

an html\nclick here\nsnippet

'); 117 | }); 118 | 119 | it('should inline raw snippet if bound to a trusted value', function() { 120 | expect(element(by.css('#bind-html-with-trust div')).getAttribute('innerHTML')). 121 | toBe("

an html\n" + 122 | "click here\n" + 123 | "snippet

"); 124 | }); 125 | 126 | it('should escape snippet without any filter', function() { 127 | expect(element(by.css('#bind-default div')).getAttribute('innerHTML')). 128 | toBe("<p style=\"color:blue\">an html\n" + 129 | "<em onmouseover=\"this.textContent='PWN3D!'\">click here</em>\n" + 130 | "snippet</p>"); 131 | }); 132 | 133 | it('should update', function() { 134 | element(by.model('snippet')).clear(); 135 | element(by.model('snippet')).sendKeys('new text'); 136 | expect(element(by.css('#bind-html-with-sanitize div')).getAttribute('innerHTML')). 137 | toBe('new text'); 138 | expect(element(by.css('#bind-html-with-trust div')).getAttribute('innerHTML')).toBe( 139 | 'new text'); 140 | expect(element(by.css('#bind-default div')).getAttribute('innerHTML')).toBe( 141 | "new <b onclick=\"alert(1)\">text</b>"); 142 | }); 143 |
144 |
145 | */ 146 | 147 | 148 | /** 149 | * @ngdoc provider 150 | * @name $sanitizeProvider 151 | * @this 152 | * 153 | * @description 154 | * Creates and configures {@link $sanitize} instance. 155 | */ 156 | function $SanitizeProvider() { 157 | var svgEnabled = false; 158 | 159 | this.$get = ['$$sanitizeUri', function($$sanitizeUri) { 160 | if (svgEnabled) { 161 | extend(validElements, svgElements); 162 | } 163 | return function(html) { 164 | var buf = []; 165 | htmlParser(html, htmlSanitizeWriter(buf, function(uri, isImage) { 166 | return !/^unsafe:/.test($$sanitizeUri(uri, isImage)); 167 | })); 168 | return buf.join(''); 169 | }; 170 | }]; 171 | 172 | 173 | /** 174 | * @ngdoc method 175 | * @name $sanitizeProvider#enableSvg 176 | * @kind function 177 | * 178 | * @description 179 | * Enables a subset of svg to be supported by the sanitizer. 180 | * 181 | *
182 | *

By enabling this setting without taking other precautions, you might expose your 183 | * application to click-hijacking attacks. In these attacks, sanitized svg elements could be positioned 184 | * outside of the containing element and be rendered over other elements on the page (e.g. a login 185 | * link). Such behavior can then result in phishing incidents.

186 | * 187 | *

To protect against these, explicitly setup `overflow: hidden` css rule for all potential svg 188 | * tags within the sanitized content:

189 | * 190 | *
191 | * 192 | *

193 |    *   .rootOfTheIncludedContent svg {
194 |    *     overflow: hidden !important;
195 |    *   }
196 |    *   
197 | *
198 | * 199 | * @param {boolean=} flag Enable or disable SVG support in the sanitizer. 200 | * @returns {boolean|ng.$sanitizeProvider} Returns the currently configured value if called 201 | * without an argument or self for chaining otherwise. 202 | */ 203 | this.enableSvg = function(enableSvg) { 204 | if (isDefined(enableSvg)) { 205 | svgEnabled = enableSvg; 206 | return this; 207 | } else { 208 | return svgEnabled; 209 | } 210 | }; 211 | 212 | ////////////////////////////////////////////////////////////////////////////////////////////////// 213 | // Private stuff 214 | ////////////////////////////////////////////////////////////////////////////////////////////////// 215 | 216 | bind = angular.bind; 217 | extend = angular.extend; 218 | forEach = angular.forEach; 219 | isDefined = angular.isDefined; 220 | lowercase = angular.lowercase; 221 | noop = angular.noop; 222 | 223 | htmlParser = htmlParserImpl; 224 | htmlSanitizeWriter = htmlSanitizeWriterImpl; 225 | 226 | // Regular Expressions for parsing tags and attributes 227 | var SURROGATE_PAIR_REGEXP = /[\uD800-\uDBFF][\uDC00-\uDFFF]/g, 228 | // Match everything outside of normal chars and " (quote character) 229 | NON_ALPHANUMERIC_REGEXP = /([^#-~ |!])/g; 230 | 231 | 232 | // Good source of info about elements and attributes 233 | // http://dev.w3.org/html5/spec/Overview.html#semantics 234 | // http://simon.html5.org/html-elements 235 | 236 | // Safe Void Elements - HTML5 237 | // http://dev.w3.org/html5/spec/Overview.html#void-elements 238 | var voidElements = toMap('area,br,col,hr,img,wbr'); 239 | 240 | // Elements that you can, intentionally, leave open (and which close themselves) 241 | // http://dev.w3.org/html5/spec/Overview.html#optional-tags 242 | var optionalEndTagBlockElements = toMap('colgroup,dd,dt,li,p,tbody,td,tfoot,th,thead,tr'), 243 | optionalEndTagInlineElements = toMap('rp,rt'), 244 | optionalEndTagElements = extend({}, 245 | optionalEndTagInlineElements, 246 | optionalEndTagBlockElements); 247 | 248 | // Safe Block Elements - HTML5 249 | var blockElements = extend({}, optionalEndTagBlockElements, toMap('address,article,' + 250 | 'aside,blockquote,caption,center,del,dir,div,dl,figure,figcaption,footer,h1,h2,h3,h4,h5,' + 251 | 'h6,header,hgroup,hr,ins,map,menu,nav,ol,pre,section,table,ul')); 252 | 253 | // Inline Elements - HTML5 254 | var inlineElements = extend({}, optionalEndTagInlineElements, toMap('a,abbr,acronym,b,' + 255 | 'bdi,bdo,big,br,cite,code,del,dfn,em,font,i,img,ins,kbd,label,map,mark,q,ruby,rp,rt,s,' + 256 | 'samp,small,span,strike,strong,sub,sup,time,tt,u,var')); 257 | 258 | // SVG Elements 259 | // https://wiki.whatwg.org/wiki/Sanitization_rules#svg_Elements 260 | // Note: the elements animate,animateColor,animateMotion,animateTransform,set are intentionally omitted. 261 | // They can potentially allow for arbitrary javascript to be executed. See #11290 262 | var svgElements = toMap('circle,defs,desc,ellipse,font-face,font-face-name,font-face-src,g,glyph,' + 263 | 'hkern,image,linearGradient,line,marker,metadata,missing-glyph,mpath,path,polygon,polyline,' + 264 | 'radialGradient,rect,stop,svg,switch,text,title,tspan'); 265 | 266 | // Blocked Elements (will be stripped) 267 | var blockedElements = toMap('script,style'); 268 | 269 | var validElements = extend({}, 270 | voidElements, 271 | blockElements, 272 | inlineElements, 273 | optionalEndTagElements); 274 | 275 | //Attributes that have href and hence need to be sanitized 276 | var uriAttrs = toMap('background,cite,href,longdesc,src,xlink:href'); 277 | 278 | var htmlAttrs = toMap('abbr,align,alt,axis,bgcolor,border,cellpadding,cellspacing,class,clear,' + 279 | 'color,cols,colspan,compact,coords,dir,face,headers,height,hreflang,hspace,' + 280 | 'ismap,lang,language,nohref,nowrap,rel,rev,rows,rowspan,rules,' + 281 | 'scope,scrolling,shape,size,span,start,summary,tabindex,target,title,type,' + 282 | 'valign,value,vspace,width'); 283 | 284 | // SVG attributes (without "id" and "name" attributes) 285 | // https://wiki.whatwg.org/wiki/Sanitization_rules#svg_Attributes 286 | var svgAttrs = toMap('accent-height,accumulate,additive,alphabetic,arabic-form,ascent,' + 287 | 'baseProfile,bbox,begin,by,calcMode,cap-height,class,color,color-rendering,content,' + 288 | 'cx,cy,d,dx,dy,descent,display,dur,end,fill,fill-rule,font-family,font-size,font-stretch,' + 289 | 'font-style,font-variant,font-weight,from,fx,fy,g1,g2,glyph-name,gradientUnits,hanging,' + 290 | 'height,horiz-adv-x,horiz-origin-x,ideographic,k,keyPoints,keySplines,keyTimes,lang,' + 291 | 'marker-end,marker-mid,marker-start,markerHeight,markerUnits,markerWidth,mathematical,' + 292 | 'max,min,offset,opacity,orient,origin,overline-position,overline-thickness,panose-1,' + 293 | 'path,pathLength,points,preserveAspectRatio,r,refX,refY,repeatCount,repeatDur,' + 294 | 'requiredExtensions,requiredFeatures,restart,rotate,rx,ry,slope,stemh,stemv,stop-color,' + 295 | 'stop-opacity,strikethrough-position,strikethrough-thickness,stroke,stroke-dasharray,' + 296 | 'stroke-dashoffset,stroke-linecap,stroke-linejoin,stroke-miterlimit,stroke-opacity,' + 297 | 'stroke-width,systemLanguage,target,text-anchor,to,transform,type,u1,u2,underline-position,' + 298 | 'underline-thickness,unicode,unicode-range,units-per-em,values,version,viewBox,visibility,' + 299 | 'width,widths,x,x-height,x1,x2,xlink:actuate,xlink:arcrole,xlink:role,xlink:show,xlink:title,' + 300 | 'xlink:type,xml:base,xml:lang,xml:space,xmlns,xmlns:xlink,y,y1,y2,zoomAndPan', true); 301 | 302 | var validAttrs = extend({}, 303 | uriAttrs, 304 | svgAttrs, 305 | htmlAttrs); 306 | 307 | function toMap(str, lowercaseKeys) { 308 | var obj = {}, items = str.split(','), i; 309 | for (i = 0; i < items.length; i++) { 310 | obj[lowercaseKeys ? lowercase(items[i]) : items[i]] = true; 311 | } 312 | return obj; 313 | } 314 | 315 | var inertBodyElement; 316 | (function(window) { 317 | var doc; 318 | if (window.document && window.document.implementation) { 319 | doc = window.document.implementation.createHTMLDocument('inert'); 320 | } else { 321 | throw $sanitizeMinErr('noinert', 'Can\'t create an inert html document'); 322 | } 323 | var docElement = doc.documentElement || doc.getDocumentElement(); 324 | var bodyElements = docElement.getElementsByTagName('body'); 325 | 326 | // usually there should be only one body element in the document, but IE doesn't have any, so we need to create one 327 | if (bodyElements.length === 1) { 328 | inertBodyElement = bodyElements[0]; 329 | } else { 330 | var html = doc.createElement('html'); 331 | inertBodyElement = doc.createElement('body'); 332 | html.appendChild(inertBodyElement); 333 | doc.appendChild(html); 334 | } 335 | })(window); 336 | 337 | /** 338 | * @example 339 | * htmlParser(htmlString, { 340 | * start: function(tag, attrs) {}, 341 | * end: function(tag) {}, 342 | * chars: function(text) {}, 343 | * comment: function(text) {} 344 | * }); 345 | * 346 | * @param {string} html string 347 | * @param {object} handler 348 | */ 349 | function htmlParserImpl(html, handler) { 350 | if (html === null || html === undefined) { 351 | html = ''; 352 | } else if (typeof html !== 'string') { 353 | html = '' + html; 354 | } 355 | inertBodyElement.innerHTML = html; 356 | 357 | //mXSS protection 358 | var mXSSAttempts = 5; 359 | do { 360 | if (mXSSAttempts === 0) { 361 | throw $sanitizeMinErr('uinput', 'Failed to sanitize html because the input is unstable'); 362 | } 363 | mXSSAttempts--; 364 | 365 | // strip custom-namespaced attributes on IE<=11 366 | if (window.document.documentMode) { 367 | stripCustomNsAttrs(inertBodyElement); 368 | } 369 | html = inertBodyElement.innerHTML; //trigger mXSS 370 | inertBodyElement.innerHTML = html; 371 | } while (html !== inertBodyElement.innerHTML); 372 | 373 | var node = inertBodyElement.firstChild; 374 | while (node) { 375 | switch (node.nodeType) { 376 | case 1: // ELEMENT_NODE 377 | handler.start(node.nodeName.toLowerCase(), attrToMap(node.attributes)); 378 | break; 379 | case 3: // TEXT NODE 380 | handler.chars(node.textContent); 381 | break; 382 | } 383 | 384 | var nextNode; 385 | if (!(nextNode = node.firstChild)) { 386 | if (node.nodeType === 1) { 387 | handler.end(node.nodeName.toLowerCase()); 388 | } 389 | nextNode = node.nextSibling; 390 | if (!nextNode) { 391 | while (nextNode == null) { 392 | node = node.parentNode; 393 | if (node === inertBodyElement) break; 394 | nextNode = node.nextSibling; 395 | if (node.nodeType === 1) { 396 | handler.end(node.nodeName.toLowerCase()); 397 | } 398 | } 399 | } 400 | } 401 | node = nextNode; 402 | } 403 | 404 | while ((node = inertBodyElement.firstChild)) { 405 | inertBodyElement.removeChild(node); 406 | } 407 | } 408 | 409 | function attrToMap(attrs) { 410 | var map = {}; 411 | for (var i = 0, ii = attrs.length; i < ii; i++) { 412 | var attr = attrs[i]; 413 | map[attr.name] = attr.value; 414 | } 415 | return map; 416 | } 417 | 418 | 419 | /** 420 | * Escapes all potentially dangerous characters, so that the 421 | * resulting string can be safely inserted into attribute or 422 | * element text. 423 | * @param value 424 | * @returns {string} escaped text 425 | */ 426 | function encodeEntities(value) { 427 | return value. 428 | replace(/&/g, '&'). 429 | replace(SURROGATE_PAIR_REGEXP, function(value) { 430 | var hi = value.charCodeAt(0); 431 | var low = value.charCodeAt(1); 432 | return '&#' + (((hi - 0xD800) * 0x400) + (low - 0xDC00) + 0x10000) + ';'; 433 | }). 434 | replace(NON_ALPHANUMERIC_REGEXP, function(value) { 435 | return '&#' + value.charCodeAt(0) + ';'; 436 | }). 437 | replace(//g, '>'); 439 | } 440 | 441 | /** 442 | * create an HTML/XML writer which writes to buffer 443 | * @param {Array} buf use buf.join('') to get out sanitized html string 444 | * @returns {object} in the form of { 445 | * start: function(tag, attrs) {}, 446 | * end: function(tag) {}, 447 | * chars: function(text) {}, 448 | * comment: function(text) {} 449 | * } 450 | */ 451 | function htmlSanitizeWriterImpl(buf, uriValidator) { 452 | var ignoreCurrentElement = false; 453 | var out = bind(buf, buf.push); 454 | return { 455 | start: function(tag, attrs) { 456 | tag = lowercase(tag); 457 | if (!ignoreCurrentElement && blockedElements[tag]) { 458 | ignoreCurrentElement = tag; 459 | } 460 | if (!ignoreCurrentElement && validElements[tag] === true) { 461 | out('<'); 462 | out(tag); 463 | forEach(attrs, function(value, key) { 464 | var lkey = lowercase(key); 465 | var isImage = (tag === 'img' && lkey === 'src') || (lkey === 'background'); 466 | if (validAttrs[lkey] === true && 467 | (uriAttrs[lkey] !== true || uriValidator(value, isImage))) { 468 | out(' '); 469 | out(key); 470 | out('="'); 471 | out(encodeEntities(value)); 472 | out('"'); 473 | } 474 | }); 475 | out('>'); 476 | } 477 | }, 478 | end: function(tag) { 479 | tag = lowercase(tag); 480 | if (!ignoreCurrentElement && validElements[tag] === true && voidElements[tag] !== true) { 481 | out(''); 484 | } 485 | // eslint-disable-next-line eqeqeq 486 | if (tag == ignoreCurrentElement) { 487 | ignoreCurrentElement = false; 488 | } 489 | }, 490 | chars: function(chars) { 491 | if (!ignoreCurrentElement) { 492 | out(encodeEntities(chars)); 493 | } 494 | } 495 | }; 496 | } 497 | 498 | 499 | /** 500 | * When IE9-11 comes across an unknown namespaced attribute e.g. 'xlink:foo' it adds 'xmlns:ns1' attribute to declare 501 | * ns1 namespace and prefixes the attribute with 'ns1' (e.g. 'ns1:xlink:foo'). This is undesirable since we don't want 502 | * to allow any of these custom attributes. This method strips them all. 503 | * 504 | * @param node Root element to process 505 | */ 506 | function stripCustomNsAttrs(node) { 507 | while (node) { 508 | if (node.nodeType === window.Node.ELEMENT_NODE) { 509 | var attrs = node.attributes; 510 | for (var i = 0, l = attrs.length; i < l; i++) { 511 | var attrNode = attrs[i]; 512 | var attrName = attrNode.name.toLowerCase(); 513 | if (attrName === 'xmlns:ns1' || attrName.lastIndexOf('ns1:', 0) === 0) { 514 | node.removeAttributeNode(attrNode); 515 | i--; 516 | l--; 517 | } 518 | } 519 | } 520 | 521 | var nextNode = node.firstChild; 522 | if (nextNode) { 523 | stripCustomNsAttrs(nextNode); 524 | } 525 | 526 | node = node.nextSibling; 527 | } 528 | } 529 | } 530 | 531 | function sanitizeText(chars) { 532 | var buf = []; 533 | var writer = htmlSanitizeWriter(buf, noop); 534 | writer.chars(chars); 535 | return buf.join(''); 536 | } 537 | 538 | 539 | // define ngSanitize module and register $sanitize service 540 | angular.module('ngSanitize', []).provider('$sanitize', $SanitizeProvider); 541 | 542 | /** 543 | * @ngdoc filter 544 | * @name linky 545 | * @kind function 546 | * 547 | * @description 548 | * Finds links in text input and turns them into html links. Supports `http/https/ftp/mailto` and 549 | * plain email address links. 550 | * 551 | * Requires the {@link ngSanitize `ngSanitize`} module to be installed. 552 | * 553 | * @param {string} text Input text. 554 | * @param {string} target Window (`_blank|_self|_parent|_top`) or named frame to open links in. 555 | * @param {object|function(url)} [attributes] Add custom attributes to the link element. 556 | * 557 | * Can be one of: 558 | * 559 | * - `object`: A map of attributes 560 | * - `function`: Takes the url as a parameter and returns a map of attributes 561 | * 562 | * If the map of attributes contains a value for `target`, it overrides the value of 563 | * the target parameter. 564 | * 565 | * 566 | * @returns {string} Html-linkified and {@link $sanitize sanitized} text. 567 | * 568 | * @usage 569 | 570 | * 571 | * @example 572 | 573 | 574 |
575 | Snippet: 576 | 577 | 578 | 579 | 580 | 581 | 582 | 583 | 584 | 587 | 590 | 591 | 592 | 593 | 596 | 599 | 600 | 601 | 602 | 605 | 608 | 609 | 610 | 611 | 612 | 613 | 614 |
FilterSourceRendered
linky filter 585 |
<div ng-bind-html="snippet | linky">
</div>
586 |
588 |
589 |
linky target 594 |
<div ng-bind-html="snippetWithSingleURL | linky:'_blank'">
</div>
595 |
597 |
598 |
linky custom attributes 603 |
<div ng-bind-html="snippetWithSingleURL | linky:'_self':{rel: 'nofollow'}">
</div>
604 |
606 |
607 |
no filter
<div ng-bind="snippet">
</div>
615 | 616 | 617 | angular.module('linkyExample', ['ngSanitize']) 618 | .controller('ExampleController', ['$scope', function($scope) { 619 | $scope.snippet = 620 | 'Pretty text with some links:\n' + 621 | 'http://angularjs.org/,\n' + 622 | 'mailto:us@somewhere.org,\n' + 623 | 'another@somewhere.org,\n' + 624 | 'and one more: ftp://127.0.0.1/.'; 625 | $scope.snippetWithSingleURL = 'http://angularjs.org/'; 626 | }]); 627 | 628 | 629 | it('should linkify the snippet with urls', function() { 630 | expect(element(by.id('linky-filter')).element(by.binding('snippet | linky')).getText()). 631 | toBe('Pretty text with some links: http://angularjs.org/, us@somewhere.org, ' + 632 | 'another@somewhere.org, and one more: ftp://127.0.0.1/.'); 633 | expect(element.all(by.css('#linky-filter a')).count()).toEqual(4); 634 | }); 635 | 636 | it('should not linkify snippet without the linky filter', function() { 637 | expect(element(by.id('escaped-html')).element(by.binding('snippet')).getText()). 638 | toBe('Pretty text with some links: http://angularjs.org/, mailto:us@somewhere.org, ' + 639 | 'another@somewhere.org, and one more: ftp://127.0.0.1/.'); 640 | expect(element.all(by.css('#escaped-html a')).count()).toEqual(0); 641 | }); 642 | 643 | it('should update', function() { 644 | element(by.model('snippet')).clear(); 645 | element(by.model('snippet')).sendKeys('new http://link.'); 646 | expect(element(by.id('linky-filter')).element(by.binding('snippet | linky')).getText()). 647 | toBe('new http://link.'); 648 | expect(element.all(by.css('#linky-filter a')).count()).toEqual(1); 649 | expect(element(by.id('escaped-html')).element(by.binding('snippet')).getText()) 650 | .toBe('new http://link.'); 651 | }); 652 | 653 | it('should work with the target property', function() { 654 | expect(element(by.id('linky-target')). 655 | element(by.binding("snippetWithSingleURL | linky:'_blank'")).getText()). 656 | toBe('http://angularjs.org/'); 657 | expect(element(by.css('#linky-target a')).getAttribute('target')).toEqual('_blank'); 658 | }); 659 | 660 | it('should optionally add custom attributes', function() { 661 | expect(element(by.id('linky-custom-attributes')). 662 | element(by.binding("snippetWithSingleURL | linky:'_self':{rel: 'nofollow'}")).getText()). 663 | toBe('http://angularjs.org/'); 664 | expect(element(by.css('#linky-custom-attributes a')).getAttribute('rel')).toEqual('nofollow'); 665 | }); 666 | 667 | 668 | */ 669 | angular.module('ngSanitize').filter('linky', ['$sanitize', function($sanitize) { 670 | var LINKY_URL_REGEXP = 671 | /((ftp|https?):\/\/|(www\.)|(mailto:)?[A-Za-z0-9._%+-]+@)\S*[^\s.;,(){}<>"\u201d\u2019]/i, 672 | MAILTO_REGEXP = /^mailto:/i; 673 | 674 | var linkyMinErr = angular.$$minErr('linky'); 675 | var isDefined = angular.isDefined; 676 | var isFunction = angular.isFunction; 677 | var isObject = angular.isObject; 678 | var isString = angular.isString; 679 | 680 | return function(text, target, attributes) { 681 | if (text == null || text === '') return text; 682 | if (!isString(text)) throw linkyMinErr('notstring', 'Expected string but received: {0}', text); 683 | 684 | var attributesFn = 685 | isFunction(attributes) ? attributes : 686 | isObject(attributes) ? function getAttributesObject() {return attributes;} : 687 | function getEmptyAttributesObject() {return {};}; 688 | 689 | var match; 690 | var raw = text; 691 | var html = []; 692 | var url; 693 | var i; 694 | while ((match = raw.match(LINKY_URL_REGEXP))) { 695 | // We can not end in these as they are sometimes found at the end of the sentence 696 | url = match[0]; 697 | // if we did not match ftp/http/www/mailto then assume mailto 698 | if (!match[2] && !match[4]) { 699 | url = (match[3] ? 'http://' : 'mailto:') + url; 700 | } 701 | i = match.index; 702 | addText(raw.substr(0, i)); 703 | addLink(url, match[0].replace(MAILTO_REGEXP, '')); 704 | raw = raw.substring(i + match[0].length); 705 | } 706 | addText(raw); 707 | return $sanitize(html.join('')); 708 | 709 | function addText(text) { 710 | if (!text) { 711 | return; 712 | } 713 | html.push(sanitizeText(text)); 714 | } 715 | 716 | function addLink(url, text) { 717 | var key, linkAttributes = attributesFn(url); 718 | html.push(''); 732 | addText(text); 733 | html.push(''); 734 | } 735 | }; 736 | }]); 737 | 738 | 739 | })(window, window.angular); 740 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | --------------------------------------------------------------------------------