Giter Club home page Giter Club logo

mastodon.el's Introduction

mastodon.el updated

This is an updated version of the great but seemingly dormant mastodon client for emacs.

[The original readme is below.]

It adds the following features:

Profiles:
display profile metadata fields
display pinned toots first
display relationship (follows you/followed by you)
display toots/follows/followers counts
links/tags/mentions in profile bios are active links
show a lock icon for locked accounts
R, C-c a, C-c rview/accept/reject follow requests
Vview your favorited toots
itoggle pinning of toots
S-C-Pjump to your profile
Uupdate your profile bio note
Ojump to own profile
Notifications:
follow requests now also appear in notifications
a, raccept/reject follow request
notifications for when a user posts (mastodon-tl--enable-notify-user-posts)
Timelines:
Ccopy url of toot at point
ddelete your toot at point, and reload current timeline
Ddelete and redraft toot at point, preserving reply/CW/visibility
W, M, B(un)follow, (un)mute, (un)block author of toot at point
k, Ktoggle bookmark of toot at point, view bookmarked toots
display polls and vote on them
images are links to the full image, can be zoomed/rotated/saved (see image keymap)
images scale properly
toot visibility (direct, followers only) icon appears in toot bylines
display toot’s number of favorites, boosts and replies
customize option to cache images
Toots:
mention booster in replies by default
replies preserve visibility status/CW of original toot
autocompletion of user mentions, via company-mode (must be installed to work)
C-c C-amedia uploads, asynchronous
media upload previews displayed in toot compose buffer
C-c C-nand sensitive media/nsfw flag
C-c C-eadd emoji (if emojify installed)
download and use your instance’s custom emoji
server’s maximum toot length shown in toot compose buffer
Search:
Ssearch (posts, users, tags) (NB: only posts you have interacted with are searched)

It also makes some small cosmetic changes to make timelines easier to read, and makes some functions asynchronous, based on https://github.com/ieure/mastodon.el.

The minimum Emacs version is now 27.1. But if you are running an older version it shouldn’t be very hard to get it working.

live-updating timelines: mastodon-async-mode

(code taken from https://github.com/alexjgriffith/mastodon-future.el.)

Works for federated, local, and home timelines and for notifications. It’s a little touchy, one thing to avoid is trying to load a timeline more than once at a time. It can go off the rails a bit, but it’s still pretty cool.

To enable, it, add (require 'mastodon-async) to your init.el. Then you can view a timeline with one of the commands that begin with mastodon-async--stream-.

NB: dependencies

This version depends on the library request (for uploading attachments). You can install it from MELPA, or https://github.com/tkf/emacs-request. It also depends on seq.

Optional dependencies are company for autocompletion of mentions when composing a toot, and emojify for inserting and viewing emojis.

NB: bugs

This repo also incorporates fixes for two bugs that were never merged into the upstream repo:

2FA

It looks like 2-factor auth was never completed in the original repo. It’s not a priority for me, auth ain’t my thing. If you want to hack on it, its on the develop branch in the original repo.

contributing

Contributions are welcome. Registration is disabled by default on the gitea instance, but if you are interested, get in touch with me on mastodon: @[email protected]. Or just leave an issue on github.

For now, to get started with hacking, pull off the develop branch of the blast repo.

Original README

Installation

Clone this repository and add the lisp directory to your load path. Then, require it and go.

(add-to-list 'load-path "/path/to/mastodon.el/lisp")
(require 'mastodon)

Or, with use-package:

(use-package mastodon
  :ensure t)

MELPA

Add MELPA to your archives:

(require 'package)
(add-to-list 'package-archives
             '("melpa" . "http://melpa.org/packages/") t)

Update and install:

M-x package-refresh-contents RET

M-x package-install RET mastodon RET

Emoji

mastodon-mode will enable Emojify if it is loaded in your Emacs environment, so there’s no need to write your own hook anymore. emojify-mode is not required.

Discover

mastodon-mode can provide a context menu for its keybindings if Discover is installed. It is not required.

if you have Discover, add the following to your Emacs init configuration:

(require 'mastodon-discover)
(with-eval-after-load 'mastodon (mastodon-discover))

Or, with use-package:

(use-package mastodon
  :ensure t
  :config
  (mastodon-discover))

Usage

2 Factor Auth

2FA is not supported yet. It is in the plans for the 1.0.0 release.

If you have 2FA enabled and try to use mastodon.el, your Emacs client will hang until you `C-g` your way out.

Instance

Set mastodon-instance-url in your .emacs or customize. Defaults to the flagship.

(setq mastodon-instance-url "https://my.instance.url")

There is an option to have your user credentials (email address and password) saved to disk so you don’t have to re-enter them on every restart. The default is not to do this because if not properly configured it would save these unencrypted which is not a good default to have. Customize the variable mastodon-auth-source-file if you want to enable this feature.

Timelines

M-x mastodon

Opens a *mastodon-home* buffer in the major mode so you can see toots. You will be prompted for email and password. The app registration process will take place if your mastodon-token-file does not contain :client_id and :client_secret.

Keybindings

KeyAction
Help
?Open context menu if discover is available
Timeline actions
nGo to next item (toot, notification)
pGo to previous item (toot, notification)
M-n=/=<tab>Go to the next interesting thing that has an action
M-p=/=<S-tab>Go to the previous interesting thing that has an action
uUpdate timeline
#Prompt for tag and open its timeline
AOpen author profile of toot under point
FOpen federated timeline
HOpen home timeline
LOpen local timeline
NOpen notifications timeline
POpen profile of user attached to toot under point
TOpen thread buffer for toot under point
Toot actions
cToggle content warning content
bBoost toot under point
fFavourite toot under point
rReply to toot under point
nCompose a new toot
Switching to other buffers
Quitting
qQuit mastodon buffer, leave window open
QQuit mastodon buffer and kill window

Legend

MarkerMeaning
(B)I boosted this toot.
(F)I favourited this toot.

Toot toot

M-x mastodon-toot

Pops a new buffer/window with a mastodon-toot minor mode. Enter the contents of your toot here. C-c C-c sends the toot. C-c C-k cancels. Both actions kill the buffer and window.

If you have not previously authenticated, you will be prompted for your account email and password. NOTE: Email and password are NOT stored by mastodon.el.

Authentication stores your access token in the mastodon-auth--token variable. It is not stored on your filesystem, so you will have to re-authenticate when you close/reopen Emacs.

Customization

The default toot visibility can be changed by setting or customizing the mastodon-toot--default-visibility variable. Valid values are =”public”=, =”unlisted”=, =”private”=, or direct.

Toot visibility can also be changed on a per-toot basis from the new toot buffer.

Keybindings

KeyAction
C-c C-cSend toot
C-c C-kCancel toot
C-c C-wAdd content warning
C-c C-vChange toot visibility

Roadmap

Here are the features I plan to implement before putting mastodon.el on MELPA.

Here are the plans I have for the 1.0.0 release.

Contributing

PRs, issues, and feature requests are very welcome!

Features

  1. Create an issue detailing the feature you’d like to add.
  2. Fork the repository and create a branch off of develop.
  3. Create a pull request referencing the issue created in step 1.

Fixes

  1. In an issue, let me know that you’re working to fix it.
  2. Fork the repository and create a branch off of develop.
  3. Create a pull request referencing the issue from step 1.

Connect

If you want to get in touch with me, give me a toot or leave an issue.

mastodon.el's People

Contributors

alexjgriffith avatar clarkenciel avatar hdurer avatar ieure avatar jdenen avatar jdormit avatar juergenhoetzel avatar mooseyboots avatar saper avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mastodon.el's Issues

Dev environment

I need a clean working Emacs state. Since I use Spacemacs, I risk some contamination from other packages. A Docker image with a clean Emacs is probably the easiest solution.

If 2FA is enabled, mastodon.el goes into an infinite auth loop

When a user has 2 Factor Auth enabled, mastodon.el is unable to authenticate and will prompt for the username and password until the user either (a) disables their 2 Factor Auth, or (b) exits emacs.

Mastodon.el should do one of the following if 2FA is turned on:

  • Use OAuth to get a token
  • Prompt for the 2FA auth code and submit it for the user
  • Cleanly exit/error out so that the user can turn off 2FA

Refactor to use synchronous calls in mastodon-http

The asynch default of url-retrieve makes things too complicated, especially the HTTP actions taken in mastodon-auth. Look at mastodon-http--get for an example of how much url-retreive-synchronously makes life easier.

Travis

Continuous integration is good too. Once I've got some tests to run ( #5 ), I should setup CI with Travis.

JSON readtable error

Hello,

I have configured mastodon.el as follows:

(add-to-list 'load-path "~/.emacs.d/elisp/mastodon/lisp")
(require 'mastodon)
(setq mastodon-instance-url "https://mastodon.zaclys.com")

When I then try to M-x mastodon, I am asked for my e-mail and password and then get the following error:

Contacting host: mastodon.zaclys.com:443
error in process filter: url-http-parse-headers: Wrong type argument: char-or-string-p, nil
error in process filter: Wrong type argument: char-or-string-p, nil
json-read: JSON readtable error

My Emacs version is GNU Emacs 24.4.1 (x86_64-pc-linux-gnu, GTK+ Version 3.14.5) of 2015-03-07 on trouble, modified by Debian.

Thank you for making this Mastodon Emacs client, I hope that I will soon be able to test it!

Does not work with non-ASCII characters

In mastodon-mode, non-ASCII characters in usernames or in toots are displayed by escape sequences of the UTF-8 (\303\251 instead of é).

mastodon.el just git pulled

GNU Emacs 24.5.1 (x86_64-pc-linux-gnu, GTK+ Version 3.18.9) of 2016-04-17 on lgw01-04, modified by Debian (can display Unicode just fine)

Add to MELPA

  • Submit PR to MEPLA
  • Wait for PR to be merged
  • Update README

CW toot modifier

We should be able to do the following from a mastodon-toot mode buffer:

  • Add a content warning
  • Add CW spoiler text

Scope issue on new toot

mastodon-toot returns a 403 Forbidden error response. The error message mentions a scope issue:

{"error":"This action is outside the authorized scopes"}

Since mastodon.el registers with "read write follow" scopes, this doesn't make much sense.

I can use the same token from mastodon--api-token-string to GET posts.

curl --header "Authorization: Bearer ${TOKEN}" -sS https://mastodon.social/api/v1/statuses/1895661

This returns a 200 and the toot data.

Request more toots

When I use the mastodon-tl--goto-next-toot function from the last toot in my buffer, it should request toots older than toot at point and append the response data to the buffer.

Remove mastodon-register-client function

This was useful before the major mode existed. Now, it is out of date and will throw an error when used.

  • Remove function
  • Remove references to the function from the README

IWBN to have a roadmap

For instance, is there a plan to add the ability to display toots, not just create them?

IWBN to have automatic refresh

Apparently, mastodon.el does not automatically refrshes the open timeline: I need to call mastodon-tl--update (which has no key binding by default). Why not a periodic automatic resfresh, with a period configured by a variable?

Use unwind-protect?

Look into the unwind-protect function for cleaning up buffers on TL switches, new toots, replies, etc.

Mastodon major mode

This is more an epic level issue that should be broken down. The major mode should provide:

  • Read access to timelines:
    • Home
    • Local
    • Federated
    • Tags
    • Update to latest toots
  • Interactions with toots:
    • Boost
    • Favourite
    • Reply
    • See thread
  • Keybindings
    • Switch between timelines
    • Move to next/previous toot
    • Boost, Favourite, Reply to, Open thread
    • New toot

Missing a license file

The headings in mastodon.el state it's licensed under the GPLv3 but this repository doesn't have a copy of it

`Replaced 0 occurrences` from `mastodon-tl--update` and the favourited toot is not marked with `(F)`

How to reproduce:

  1. open a timeline in Emacs
  2. pick some existing toot from the timeline
  3. open mastodon in the web browser
  4. use the web interface to favourite the toot picked
  5. update Emacs timeline

Expected:

  1. (F) marker on a toot

Actual:

  1. Replaced 0 occurrences message
  2. Nothing changes

After this when favourite the toot from the emacs buffer I get:

Favourited #3825346

and I get the new buffer with

HTTP/1.1 422 Unprocessable Entity
Date: Sat, 22 Apr 2017 20:53:01 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Server: Mastodon
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 2017-04-22T20:55:00.151905Z
Vary: Accept-Encoding, Origin
Content-Encoding: gzip
Cache-Control: no-cache
X-Request-Id: bee31336-e2c2-4208-aa47-c22c131d7044
X-Runtime: 0.059796

{"error":"Validation failed: Status has already been taken"}

(not a good "success" callback by the way)

Integration environment

Right now, I'm developing/testing against the flagship API. It would probably be better to use a locally running Mastodon instance. Add a docker-compose file that spins up an instance. Integrates with the dev environment from #2 too?

Default "colors" are bot really usable

The default color for toots is a very pale grey, almost unreadable. The blue for the user names is not much better.

I suggest to change the default and (probably more important) to document how the user could change it (my own preference would be to use the default font/color for everything).

Better success callback

Right now, the success callback on a new toot opens the response buffer from url-retrieve. It should just message a success, perhaps with the toot id.

  • new toot
  • reply
  • boost
  • favourite

Detect and invoke emojify

With discover, we auto-detect it in the user's Emacs environment and use it if it's there. This keeps the user from having to write their own hook. I'd like to do the same with emojify now that the UTF-8 encoding issue is fixed.

IWBN to have Oauth

This would allow to get a permanent authorization, avoiding to type the password each time you run Emacs. The Twitter twittering-mode does it.

Success callback triggered before failure buffer pops

  1. Favourite a toot
  2. Favourite again

You'll get the successful feedback:

Favourited #12345

And then a buffer:

HTTP/1.1 422 Unprocessable Entity
Date: Sat, 22 Apr 2017 20:53:01 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Server: Mastodon
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 2017-04-22T20:55:00.151905Z
Vary: Accept-Encoding, Origin
Content-Encoding: gzip
Cache-Control: no-cache
X-Request-Id: bee31336-e2c2-4208-aa47-c22c131d7044
X-Runtime: 0.059796

{"error":"Validation failed: Status has already been taken"}

Handle 422 response

You can't favourite an already favourited toot. You get a 422 response. We should handle this gracefully instead of popping the failed response buffer. Options:

  1. Message feedback that says something like Already favourited #12345
  2. Make favourite function a toggle between favourite/unfavourite

Fix should be applied to the boost function too.

Evil support

Many of my keybindings are Vim inspired. This proposes a problem for evil users in normal mode. Look into what it would take to support evil users out of the box.

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.