feature: /ignore command #19

nogaems · 2018-12-23T00:12:13Z

This code adds /ignore command which is not buffer specific and can be used from any tox plugin's buffer.

 [tox]  /ignore  list
                 add <name>
                 del <name>

 ommit messages from people with certain nicks

 list: show the list of ignores
 add: add a nick to the list
 del: delete a nick from the list

When you add a nickname to the ignore list using this command it will filter all the messages in group chats you've joined and show only messages from people not it the list.
It indicates muted people in the nicklist of a group chat with "-" prefix (like "devoice" in IRC) and refreshes this prefix after any changes on the ignore list or changing names of peers in groups.
The list of ignores is preserved across restarts by writing it to the file specified in options (tox.profile.<profile_name>.ignore_file) and it can be manually saved by issuing /save command.

Also I've reverted "clang-format" commit since it leads to multiple merge conflicts and it's way easier to apply it again after merging this branch.
And there's a little fix for #18 that doesn't worth a separate pull request.

haavard

This looks sweet! My main concern is the storage format for the ignore list. WeeChat's IRC plugin stores its ignores in irc.conf in a format like this:

[ignore]
ignore = *;*;^foo$
ignore = *;*;^bar$

I think I prefer something like this over a bespoke file that lives outside of WeeChat's configuration "ecosystem". I'm also not sure what happens if someone puts a newline in their nickname; this might break the ignore list on disk as it is right now.

I also think this could be made more powerful by supporting ignoring a Tox ID instead of just a nick. Even if this isn't implemented in this iteration, designing the /ignore command to be extensible for this in the future seems like a good idea.

haavard · 2018-12-23T15:41:19Z

src/twc-tfer.c

@@ -160,7 +160,8 @@ twc_tfer_update_downloading_path(struct t_twc_profile *profile)
        free(bad_path);
        weechat_mkdir_parents(full_path, 0755);
    }
-    free(profile->tfer->downloading_path);
+    if (profile->tfer->downloading_path)
+        free(profile->tfer->downloading_path);


This is not necessary, as calling free(3) on NULL is a no-op.

haavard · 2018-12-23T15:43:35Z

CMakeLists.txt

@@ -64,4 +65,3 @@ endif()
 set(PLUGIN_PATH "lib/weechat/plugins" CACHE PATH
    "Path to install the plugin binary to.")
 install(TARGETS tox DESTINATION "${PLUGIN_PATH}")
-


Unnecessary whitespace change.

nogaems · 2018-12-25T15:40:12Z

Hi @haavard
Well, I actually share your concern about this ad-hoc solution for the storage of nicknames. I got to take a look deeper in weechat documentation and how is this feature implemented in IRC /ignore command, so I think I'll get this done soon.

supporting ignoring a Tox ID instead of just a nick

Unfortunately, it is impossible since uint32_t peer_number you get from callbacks is just an index in tox library representation of participants of a group chat. It's not deriving from a Tox ID and the same person can have different uint32_t peer_number in several chats. This is a part of Tox protocol specification and this is not going to be changed, so it's just as planned.
And by the way, the lacking of persistent group chats is the reason why this feature cannot be implemented "per group chat" and not globally, because there is nothing you can identify a group chat by across restarts of a client. In c-toxcore they always say that it's almost done and going to come out soon, but it already lasts for more than a year and it's better not to wait for it any soon.

haavard · 2018-12-26T12:56:25Z

Hi @haavard
Well, I actually share your concern about this ad-hoc solution for the storage of nicknames. I got to take a look deeper in weechat documentation and how is this feature implemented in IRC /ignore command, so I think I'll get this done soon.

Great! For these things I usually just dive into the WeeChat source code to get inspiration and see how the APIs are used there.

supporting ignoring a Tox ID instead of just a nick

Unfortunately, it is impossible since uint32_t peer_number you get from callbacks is just an index in tox library representation of participants of a group chat. It's not deriving from a Tox ID and the same person can have different uint32_t peer_number in several chats. This is a part of Tox protocol specification and this is not going to be changed, so it's just as planned.

Can't you pretty easily get the Tox ID (public key, technically) with tox_conference_peer_get_public_key?

nogaems · 2019-03-27T05:32:30Z

Hi, @haavard
I've changed a lot of things here according to your notes.
First off, I've managed to store ignores list in tox.conf such as the irc plugin does. Now it stores profile-specific options in [ignore] section and loads up the values on startup. All the ignores get dumped to the file on /exit or /save command.
Also as long as we have #21 the ingore has been changed to work with Tox IDs, now you can put in the ignore list a substring of hex representation of a Tox ID and the filtering is going to work using it instead of just presented nicknames that don't identify anything.
This has to be merged only after and if #21 gets merged.

Like it's already implemented in irc plugin, this commit adds the /ignore command. Now you can filter messages in group chats to not be shown, based on a part of Tox ID. The ignore list of IDs is manageable in this way: [tox] /ignore list add <ID part> del <ID part> ommit messages from people with certain Tox IDs list: show the list of ignores add: add an ID to the list del: delete an ID from the list

Even though it's a pretty rare case to happen, it's still possible to occure that there are two+ peers in a group chat with the same first 2 bytes of the ID. Since we're using 2 (that means 4 character length) as a minimal possible value for the shortened ID form, I've changed the ignore list storage in the way that you can now store as many bytes as you want regardless of the option `tox.look.short_id_size`. If the ID collision happens, you can increase the value of that option and you don't have to change your ignore list.

haavard requested changes Dec 23, 2018

View reviewed changes

nogaems mentioned this pull request Mar 18, 2019

feature: nickname disambiguation #21

Open

feature: nickname disambiguation

fe55894

nogaems force-pushed the mute branch from ecb2eb8 to 9bf88de Compare March 27, 2019 05:17

nogaems changed the title ~~Implement /ignore feature~~ feature: /ignore command Mar 27, 2019

nogaems force-pushed the mute branch from 9bf88de to 5c8f9bc Compare March 27, 2019 19:59

haavard self-assigned this Mar 31, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: /ignore command #19

feature: /ignore command #19

nogaems commented Dec 23, 2018 •

edited

Loading

haavard left a comment •

edited

Loading

haavard Dec 23, 2018

haavard Dec 23, 2018

nogaems commented Dec 25, 2018

haavard commented Dec 26, 2018

nogaems commented Mar 27, 2019

feature: /ignore command #19

Are you sure you want to change the base?

feature: /ignore command #19

Conversation

nogaems commented Dec 23, 2018 • edited Loading

haavard left a comment • edited Loading

Choose a reason for hiding this comment

haavard Dec 23, 2018

Choose a reason for hiding this comment

haavard Dec 23, 2018

Choose a reason for hiding this comment

nogaems commented Dec 25, 2018

haavard commented Dec 26, 2018

nogaems commented Mar 27, 2019

nogaems commented Dec 23, 2018 •

edited

Loading

haavard left a comment •

edited

Loading