Giter VIP home page Giter VIP logo

tootpick's Introduction

Tootpick

Tootpick is a privacy-preserving tooter.

Its purpose is providing an easy link target for a "Mastodon share button", similar to other social media share buttons.

Share on Mastodon โ† demo!

Using Tootpick

To allow visitors to share a message via Mastodon, provide a link to

https://tootpick.org/#text=Everyone%20should%20visit%20https://example.org/

This will let the visitor pick their Mastodon server and post the message "Everyone should visit https://example.org/". When sharing an article or web page, don't forget to include the URL as part of the text. The text must be "URI encoded", i.e. spaces must be replaced by %20, ampersands by %26, etcetera, just like is common for URLs. It is customary to include several relevant hashtags; use %23 for the # sign. For details, see "Fragment parameters" below.

Most Mastodon servers have a 500 character limit so it's wise to keep your message shorter than that. Tootpick does not check the length of the message.

Design goals

Nothing fancy

The functionality is simple and does not requires bells and whistles. In true KISS spirit, Tootpick is a single static HTML page. It can be used through the hosted tootpick.org, or by self-hosting the single HTML file.

Privacy

Tootpick uses the "hash" or "fragment" part of the URL, which is not sent to the HTTP server, for passing the message. Javascript is used to parse the URL and pass the data onto the chosen Mastodon instance. Only the instance server will actually receive the contents of the message to be posted.

Because Tootpick is a static page in between the article that has the "share" link and the mastodon instance, the original Referer URL won't make it to the instance, hiding any possibly sensitive tracking information from the instance admins. (It is not possible for Tootpick to prevent sending the Referer to the server that hosts Tootpick.)

Hi, it's me, the author of Tootpick. Because I'm not collecting any data from Tootpick users, I have no idea who uses it. If you're using Tootpick on your website, and want to let me know, please "star" the project on GitHub or send me a message on Mastodon (@[email protected]) - that way I know whether I should keep maintaining it. Thanks!

Multiple instances

Most existing instance pickers will provide an option to remember the last used instance, but that's not sufficiently helpful for users who use multiple instances, which is not entirely uncommon. Tootpick remembers multiple recently used instances.

Browser support

If the main feature works for 99% of all internet users, and 98% get the site with the intended aesthetics, that's good enough. Tootpick does not support ancient browsers like IE, and may look ugly and have degraded feature availability on old browsers. (The percentages are completely made up and just for illustrating the point.)

It should also be usable by people who use assistive technologies, but that comes for free by using normal HTML.

Fix PEBCAKs

Real people make mistakes, and some common mistakes can be recognised and fixed by the script. A user may provide the wrong domain, a URL instead of the bare domain name, an account, or the account domain instead of the web domain, and Tootpick tries to recover from that and do the right thing.

Why not just link directly to Mastodon?

Mastodon is part of the fediverse, a federated network. By design, there is no central server or central domain name. That direct link option you might be thinking about, does not exist. Please don't make the mistake of picking a large server and linking directly to its /share URL, because the majority of Mastodon users will not be on that server.

Self-hosting

Instead of using the central tootpick.org service, tootpick can also be self-hosted by downloading the static HTML file. Tootpick is AGPL licensed, but as long as it remains a static HTML page, the requirement of sharing the source code of a derivative work is automatically fulfilled.

Self-hosting comes with a privacy trade-off: a self-hosted (modified) copy of Tootpick could be used to collect the Mastodon instances used by the visitor, but on the other hand hides visitor IP addresses from the server that hosts the service on tootpick.org.

Button image

No button image is provided at this point, but the [official Mastodon logo](https://github.com/mastodon/mastodon/tree/main/app/javascript/images) is probably a good starting point for designing your own.

Fragment parameters

Although Tootpick currently only uses a single parameter, `text`, it is ready for accepting more than that.

The parsing of the URI fragment, that is part after the #, is done as described in the Media Fragments URI specification which assumes RFC 3986 URI escaping. (Note: Tootpick does not use media fragments, just the syntax for parameters in URI fragments.)

This means that the reserved characters & and = are used as delimiters. They must be unescaped when used as delimiters, and must be escaped when used in a key or value. The fragment must not be encoded as a whole, because that would encode the delimiters as well; only its part should be individually encoded. Additionally, +, while "reserved", is not treated as a special character, which means that a space must be encoded as %20, not +. RFC 3986 URI encoding functions always encode spaces as %20.

Most programming languages come with a function that does the right thing for use with Tootpick.

// JavaScript example
document.location = 'https://tootpick.org/#text=' + encodeURIComponent(
  document.title + ' ' + document.URL
);
Language Function
Go url.PathEscape() from net/url
JavaScript EncodeURIComponent()
PHP rawurlencode()
Perl uri_escape_utf8() from URI::Escape
Python quote() from urllib.parse
Raku uri-escape() from URI::Escape
Ruby url_encode() from ERB::Util

Some environments don't provide a URI encoding function that can be used for fragments. For these, Tootpick provides a parameter plustospace, which when set to yes, will cause + signs to be changed to space characters, which would normally be wrong. It can be used like https://tootpick.org/#plustospace=yes&text=Your+text+here.

Language Function that can be used with plustospace=yes
Java java.net.URLEncoder.encode()
Jekyll cgi_escape()

Similar projects

Tootpick is not the first of its kind. It draws inspiration from:

Future improvements

At some point in the future, I hope to:
  • Have an alternative "light mode" for people who don't like dark pages.
  • Detect the visitor's language and show translated texts.
  • Supply a list of existing instances. Not sure if it's useful enough to add extra weight, and not sure how to determine which instances to include or exclude. Please let me know what you think!

tootpick's People

Contributors

juerd avatar cubeofcheese avatar onli avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.