81236f1b70830b10d3ba8f1456d82f879952c392
2 # Copyright (C) 2019 Alex Schroeder <alex@gnu.org>
4 # This program is free software: you can redistribute it and/or modify it under
5 # the terms of the GNU Affero General Public License as published by the Free
6 # Software Foundation, either version 3 of the License, or (at your option) any
9 # This program is distributed in the hope that it will be useful, but WITHOUT
10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 # FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
14 # You should have received a copy of the GNU Affero General Public License along
15 # with this program. If not, see <https://www.gnu.org/licenses/>.
26 "~/.config/jan-pona-mute/login",
27 "~/.jan-pona-mute.d/login"
32 "~/.config/jan-pona-mute/notes",
33 "~/.jan-pona-mute.d/notes"
57 "g": "notifications reload",
61 """Init file finder"""
62 for path
in _RC_PATHS
:
63 path
= os
.path
.expanduser(path
)
64 if os
.path
.exists(path
):
69 """Notes directory finder"""
71 for path
in _NOTE_DIRS
:
72 path
= os
.path
.expanduser(path
)
73 if os
.path
.isdir(path
):
77 dir = os
.path
.expanduser(_NOTE_DIRS
[0])
78 if not os
.path
.isdir(dir):
85 bin
= shutil
.which(cmd
)
91 return get_binary(_PAGERS
)
95 return get_binary(_EDITORS
)
97 class DiasporaClient(cmd
.Cmd
):
99 prompt
= "\x1b[38;5;255m" + "> " + "\x1b[0m"
100 intro
= "Welcome to Diaspora! Use the intro command for a quick introduction."
102 header_format
= "\x1b[1;38;5;255m" + "%s" + "\x1b[0m"
113 numbers_refer_to
= None
115 post_cache
= {} # key is self.post.uid, and notification.id
120 # dict mapping user ids to usernames
123 def get_username(self
, guid
):
124 if guid
in self
.users
:
125 return self
.users
[guid
]
127 user
= diaspy
.people
.User(connection
= self
.connection
, guid
= guid
)
128 self
.users
[guid
] = user
.handle()
129 return self
.users
[guid
]
131 def do_intro(self
, line
):
134 Use the 'account' and 'password' commands to set up your connection,
135 then use the 'login' command to log in. If everything works as
136 intended, use the 'save' command to save these commands to an init
139 Once you've listed things such as notifications or the home stream,
140 enter a number to select the corresponding item.
143 def do_account(self
, account
):
144 """Set username and pod using the format username@pod."""
146 (self
.username
, self
.pod
) = account
.split('@')
147 print("Username and pod set: %s@%s" % (self
.username
, self
.pod
))
149 print("The account must contain an @ character, e.g. kensanata@pluspora.com.")
150 print("Use the account comand to set the account.")
152 def do_info(self
, line
):
153 """Get some info about things. By default, it is info about yourself."""
154 print(self
.header("Info"))
155 print("Username: %s" % self
.username
)
156 print("Password: %s" % ("None" if self
.password
== None else "set"))
157 print("Pod: %s" % self
.pod
)
158 print("Pager: %s" % self
.pager
)
159 print("Editor: %s" % self
.editor
)
160 print("Cache: %s posts" % len(self
.post_cache
))
162 def do_password(self
, password
):
163 """Set the password."""
164 self
.password
= (None if self
.password
== "" else password
)
165 print("Password %s" % ("unset" if self
.password
== "" else "set"))
167 def do_save(self
, line
):
168 """Save your login information to the init file."""
169 if self
.username
== None or self
.pod
== None:
170 print("Use the 'account' command to set username and pod.")
171 elif self
.password
== None:
172 print("Use the 'password' command.")
174 rcfile
= get_rcfile()
178 seen_password
= False
182 with
open(rcfile
, "r") as fp
:
184 words
= line
.strip().split()
186 if words
[0] == "account":
188 account
= "%s@%s" % (self
.username
, self
.pod
)
189 if len(words
) > 1 and words
[1] != account
:
190 line
= "account %s\n" % account
192 elif words
[0] == "password":
194 if len(words
) > 1 and words
[1] != self
.password
:
195 line
= "password %s\n" % self
.password
197 elif words
[0] == "login":
198 if seen_account
and seen_password
:
201 # skip login if no account or no password given
207 file.append("account %s@%s\n" % (self
.username
, self
.pod
))
209 if not seen_password
:
210 file.append("password %s\n" % self
.password
)
213 file.append("login\n")
216 if os
.path
.isfile(rcfile
):
217 os
.rename(rcfile
, rcfile
+ "~")
218 if not os
.path
.isdir(os
.path
.dirname(rcfile
)):
219 os
.makedirs(os
.path
.dirname(rcfile
))
220 with
open(rcfile
, "w") as fp
:
221 fp
.write("".join(file))
222 print("Wrote %s" % rcfile
)
224 print("No changes made, %s left unchanged" % rcfile
)
226 def do_login(self
, line
):
229 self
.onecmd("account %s" % line
)
230 if self
.username
== None or self
.pod
== None:
231 print("Use the 'account' command to set username and pod.")
232 elif self
.password
== None:
233 print("Use the 'password' command.")
235 print("Setting up a connection...")
236 self
.connection
= diaspy
.connection
.Connection(
237 pod
= "https://%s" % self
.pod
, username
= self
.username
, password
= self
.password
)
239 print("Logging in...")
240 self
.connection
.login()
241 except diaspy
.errors
.LoginError
:
242 print("Login failed.")
244 def do_pager(self
, pager
):
245 """Set the pager, e.g. to cat"""
247 print("Pager set: %s" % self
.pager
)
249 def do_editor(self
, editor
):
250 """Set the editor, e.g. to ed"""
252 print("Editor set: %s" % self
.editor
)
254 def header(self
, line
):
255 """Wrap line in header format."""
256 return self
.header_format
% line
258 def do_notifications(self
, line
):
259 """List notifications. Use 'notifications reload' to reload them."""
260 if line
== "" and self
.notifications
:
261 print("Redisplaying the notifications in the cache.")
262 print("Use 'notifications reload' to reload them.")
263 elif line
== "reload" or not self
.notifications
:
264 if self
.connection
== None:
265 print("Use the 'login' command, first.")
267 self
.notifications
= diaspy
.notifications
.Notifications(self
.connection
).last()
269 print("The 'notifications' command only takes the optional argument 'reload'.")
271 if self
.notifications
:
272 for n
, notification
in enumerate(self
.notifications
):
273 if notification
.unread
:
274 print(self
.header("%2d. %s %s") % (n
+1, notification
.when(), notification
))
276 print("%2d. %s %s" % (n
+1, notification
.when(), notification
))
277 print("Enter a number to select the notification.")
278 self
.numbers_refer_to
= 'notifications'
280 print("There are no notifications. 😢")
283 def do_quit(self
, *args
):
284 """Exit jan-pona-mute."""
288 def default(self
, line
):
289 if line
.strip() == "EOF":
290 return self
.onecmd("quit")
292 # Expand abbreviated commands
293 first_word
= line
.split()[0].strip()
294 if first_word
in shortcuts
:
295 full_cmd
= shortcuts
[first_word
]
296 expanded
= line
.replace(first_word
, full_cmd
, 1)
297 return self
.onecmd(expanded
)
299 # Finally, see if it's a notification and show it
302 def do_show(self
, line
):
303 """Show the post given by the index number.
304 The index number must refer to the current list of notifications
305 or the home stream. If no index number is given, show the current
307 if not self
.notifications
and not self
.home
:
308 print("Use the 'login' command to load notifications.")
310 if line
== "" and self
.post
== None:
311 print("Please specify a number.")
315 n
= int(line
.strip())
316 if self
.numbers_refer_to
== 'notifications':
317 notification
= self
.notifications
[n
-1]
318 self
.show(notification
)
319 self
.load(notification
.about())
320 elif self
.numbers_refer_to
== 'home':
321 posts
= sorted(self
.home
, key
=lambda x
: x
.data()["created_at"])
322 self
.post
= posts
[n
-1]
324 print("Internal error: not sure what numbers '%s' refer to." % self
.numbers_refer_to
)
327 print("The 'show' command takes a notification number but '%s' is not a number" % line
)
330 print("Index too high!")
334 print(self
.header("%2d. %s %s") % (n
, self
.post
.data()["created_at"], self
.post
.author()))
339 if(self
.post
.comments
):
340 print("%d comment%s" % (len(self
.post
.comments
), "s" if len(self
.post
.comments
) != 1 else ""))
341 print("Use the 'comments' command to list the latest comments.")
342 print("Use the 'comment' command to leave a comment.")
345 """Load the post belonging to the id (from a notification),
346 or get it from the cache."""
347 if id in self
.post_cache
:
348 self
.post
= self
.post_cache
[id]
349 print("Retrieved post from the cache.")
352 self
.post
= diaspy
.models
.Post(connection
= self
.connection
, id = id)
353 self
.post_cache
[id] = self
.post
356 def do_reload(self
, line
):
357 """Reload the current post."""
358 if self
.post
== None:
359 print("Use the 'show' command to show a post, first.")
361 print("Reloading...")
362 self
.post
= diaspy
.models
.Post(connection
= self
.connection
, id = self
.post
.id)
363 self
.post_cache
[id] = self
.post
365 def show(self
, item
):
366 """Show the current item."""
368 subprocess
.run(self
.pager
, input = str(item
), text
= True)
372 def do_comments(self
, line
):
373 """Show the comments for the current post.
374 Use the 'all' argument to show them all. Use a numerical argument to
375 show that many. The default is to load the last five."""
376 if self
.post
== None:
377 print("Use the 'show' command to show a post, first.")
379 if self
.post
.comments
== None:
380 print("The current post has no comments.")
384 comments
= self
.post
.comments
390 n
= int(line
.strip())
392 print("The 'comments' command takes a number as its argument, or 'all'.")
393 print("The default is to show the last 5 comments.")
400 start
= max(len(comments
) - n
, 0)
403 for n
, comment
in enumerate(comments
[start
:], start
):
405 print(self
.header("%2d. %s %s") % (n
+1, comment
.when(), comment
.author()))
410 print("There are no comments on the selected post.")
411 print("Use the 'comment' command to post a comment.")
413 def do_comment(self
, line
):
414 """Leave a comment on the current post.
415 If you just use a number as your comment, it will refer to a note.
416 Use the 'edit' command to edit notes."""
417 if self
.post
== None:
418 print("Use the 'show' command to show a post, first.")
421 # if the comment is just a number, use a note to post
422 n
= int(line
.strip())
423 notes
= self
.get_notes()
426 line
= self
.read_note(notes
[n
-1])
427 print("Using note #%d: %s" % (n
, notes
[n
-1]))
429 print("Use the 'list notes' command to list valid numbers.")
432 print("There are no notes to use.")
435 # in which case we'll simply comment with the line
437 comment
= self
.post
.comment(line
)
438 self
.post
.comments
.add(comment
)
439 self
.undo
.append("delete comment %s from %s" % (comment
.id, self
.post
.id))
440 print("Comment posted.")
442 def do_post(self
, line
):
443 """Write a post on the current stream.
444 If you just use a number as your post, it will refer to a note.
445 Use the 'edit' command to edit notes."""
446 if self
.home
== None:
447 self
.home
= diaspy
.streams
.Stream(self
.connection
)
449 # if the post is just a number, use a note to post
450 n
= int(line
.strip())
451 notes
= self
.get_notes()
454 line
= self
.read_note(notes
[n
-1])
455 print("Using note #%d: %s" % (n
, notes
[n
-1]))
457 print("Use the 'list notes' command to list valid numbers.")
460 print("There are no notes to use.")
463 # in which case we'll simply post the line
465 self
.post
= self
.home
.post(text
= line
)
466 self
.post_cache
[self
.post
.id] = self
.post
467 self
.undo
.append("delete post %s" % self
.post
.id)
468 print("Posted. Use the 'show' command to show it.")
470 def do_delete(self
, line
):
471 """Delete a comment."""
472 words
= line
.strip().split()
474 if words
[0] == "post":
476 print("Deleting a post takes no argument. It always deletes the selected post.")
479 print("Use the 'show' command to select a post.")
481 if self
.home
and self
.post
in self
.home
:
482 self
.home
._stream
.remove(self
.post
)
483 if self
.post
.id in self
.post_cache
:
484 self
.post_cache
.pop(self
.post
.id)
486 print("Post deleted.")
488 if words
[0] == "comment":
490 post
= self
.post_cache
[words
[3]]
491 post
.delete_comment(words
[1])
492 comments
= [c
.id for c
in post
.comments
if c
.id != id]
493 post
.comments
= diaspy
.models
.Comments(comments
)
494 print("Comment deleted.")
496 if self
.post
== None:
497 print("Use the 'show' command to show a post, first.")
502 comment
= self
.post
.comments
[n
-1]
505 print("Deleting a comment requires an integer.")
508 print("Use the 'comments' command to find valid comment numbers.")
510 # not catching any errors from diaspy
511 self
.post
.delete_comment(id)
512 # there is no self.post.comments.remove(id)
513 comments
= [c
.id for c
in self
.post
.comments
if c
.id != id]
514 self
.post
.comments
= diaspy
.models
.Comments(comments
)
515 print("Comment deleted.")
518 print("Deleting a comment requires a comment id and a post id, or a number.")
519 print("delete comment <comment id> from <post id>")
520 print("delete comment 5")
522 if words
[0] == "note":
524 print("Deleting a note requires a number.")
529 print("Deleting a note requires an integer.")
531 notes
= self
.get_notes()
534 os
.unlink(self
.get_note_path(notes
[n
-1]))
535 print("Deleted note #%d: %s" % (n
, notes
[n
-1]))
537 print("Use the 'list notes' command to list valid numbers.")
539 print("There are no notes to delete.")
541 print("Things to delete: post, comment, note.")
544 print("Delete what?")
546 def do_undo(self
, line
):
547 """Undo an action."""
549 print("The 'undo' command does not take an argument.")
552 print("There is nothing to undo.")
554 return self
.onecmd(self
.undo
.pop())
556 def do_edit(self
, line
):
557 """Edit a note with a given name."""
559 print("Edit takes the name of a note as an argument.")
561 file = self
.get_note_path(line
)
563 subprocess
.run([self
.editor
, file])
566 print("Use the 'editor' command to set an editor.")
568 def do_notes(self
, line
):
571 print("The 'notes' command does not take an argument.")
573 notes
= self
.get_notes()
575 for n
, note
in enumerate(notes
):
576 print(self
.header("%2d. %s") % (n
+1, note
))
577 print("Use the 'edit' command to edit a note.")
578 print("Use the 'preview' command to look at a note.")
579 print("Use the 'post' command to post a note.")
580 print("Use the 'comment' command to post a comment.")
582 print("Use 'edit' to create a note.")
585 """Get the list of notes."""
586 return os
.listdir(get_notes_dir())
588 def get_note_path(self
, filename
):
589 """Get the correct path for a note."""
590 return os
.path
.join(get_notes_dir(), filename
)
592 def read_note(self
, filename
):
593 """Get text of a note."""
594 with
open(self
.get_note_path(filename
), mode
= 'r', encoding
= 'utf-8') as fp
:
597 def do_preview(self
, line
):
598 """Preview a note using your pager.
599 Use the 'pager' command to set your pager to something like 'mdcat'."""
601 print("The 'preview' command the number of a note as an argument.")
602 print("Use the 'notes' command to list all your notes.")
605 n
= int(line
.strip())
606 notes
= self
.get_notes()
609 self
.show(self
.read_note(notes
[n
-1]))
611 print("Use the 'list notes' command to list valid numbers.")
614 print("There are no notes to preview.")
617 print("The 'preview' command takes a number as its argument.")
620 def do_home(self
, line
):
621 """Show the main stream containing the combined posts of the
622 followed users and tags and the community spotlights posts if
623 the user enabled those."""
626 print("Redisplaying the cached statuses of the home stream.")
627 print("Use the 'reload' argument to reload them.")
628 print("Use the 'all' argument to show them all.")
629 print("Use a number to show only that many.")
630 print("The default is 5.")
633 self
.home
= diaspy
.streams
.Stream(self
.connection
)
635 for post
in self
.home
:
636 if post
.id not in self
.post_cache
:
637 self
.post_cache
[post
.id] = post
638 elif line
== "reload":
639 if self
.connection
== None:
640 print("Use the 'login' command, first.")
643 print("Reloading...")
647 self
.home
= diaspy
.streams
.Stream(self
.connection
)
651 posts
= sorted(self
.home
, key
=lambda x
: x
.data()["created_at"])
657 n
= int(line
.strip())
659 print("The 'home' command takes a number as its argument, or 'reload' or 'all'.")
660 print("The default is to show the last 5 posts.")
667 start
= max(len(posts
) - n
, 0)
670 for n
, post
in enumerate(posts
[start
:], start
):
672 print(self
.header("%2d. %s %s") % (n
+1, post
.data()["created_at"], post
.author()))
676 print("%d comment%s" % (len(post
.comments
), "s" if len(post
.comments
) != 1 else ""))
679 print("Enter a number to select the post.")
680 self
.numbers_refer_to
= 'home'
682 print("The people you follow have nothing to say.")
683 print("The tags you follow are empty. 😢")
685 def do_shortcuts(self
, line
):
686 """List all shortcuts."""
688 print("The 'shortcuts' command does not take an argument.")
690 print(self
.header("Shortcuts"))
691 for shortcut
in sorted(shortcuts
):
692 print("%s\t%s" % (shortcut
, shortcuts
[shortcut
]))
693 print("Use the 'shortcut' command to change or add shortcuts.")
695 def do_shortcut(self
, line
):
696 """Define a new shortcut."""
697 words
= line
.strip().split(maxsplit
= 1)
699 return self
.onecmd("shortcuts")
700 elif len(words
) == 1:
702 if shortcut
in shortcuts
:
703 print("%s\t%s" % (shortcut
, shortcuts
[shortcut
]))
705 print("%s is not a shortcut" % shortcut
)
707 shortcuts
[words
[0]] = words
[1]
713 parser
= argparse
.ArgumentParser(description
='A command line Diaspora client.')
714 parser
.add_argument('--no-init-file', dest
='init_file', action
='store_const',
715 const
=False, default
=True, help='Do not load a init file')
716 args
= parser
.parse_args()
725 rcfile
= get_rcfile()
727 print("Using init file %s" % rcfile
)
728 with
open(rcfile
, "r") as fp
:
732 c
.cmdqueue
.append(line
)
734 seen_pager
= line
.startswith("pager ");
736 seen_editor
= line
.startswith("editor ");
738 print("Use the 'save' command to save your login sequence to an init file.")
742 c
.cmdqueue
.insert(0, "pager %s" % get_pager())
745 c
.cmdqueue
.insert(0, "editor %s" % get_editor())
747 # Endless interpret loop
751 except KeyboardInterrupt:
754 if __name__
== '__main__':