colorize_nicks.py 33: add many improvements, features, and fixes

[ryoskzypu]

Script info

• Script name:  colorize_nicks.py
• Version:  33

• Requirements: 

• Min WeeChat version: 

• Script tags: 

Description

Changes:

• Remove the VALID_NICK regex to not be dependent on RFC spec and change the loop to split only on spaces, so the nick regex is free to match any suffix.

• Add nick_prefixes and nick_suffixes options to configure charset affixes.

• Replace the default 'greedy' matching with improved 'lazy' matching, because 'greedy' matches nicks incorrectly and crashes weechat.

  • 'lazy' matching does not match nicks in substrings, so remove ignore_nicks_in_urls option.

  • fixes [colorize_nicks.py] Freeze on lines with repeated nick and greedy_matching = on #133 and colorize_nicks.py: Freezes weechat with too many nicks on one line #197.

  • Rationale:

    • The greedy matching code recolors duplicated strings because of the way replace() works, so it crashes weechat on multiple duplicated nicks.
    • colorize_nicks.py: fix freezes from too many nicks in one line #259 does not really prevent that, since it can still be reproduced by mentioning a short nick e.g. F1, repeatedly in a message.
    • It can be fixed by iterating on unique words, but it still colorizes nicks in substrings if a nick is mentioned before (e.g. alice https://www.alice.com), hence the option ignore_nicks_in_urls fails.

• Replace hook_modifier() with hook_line() for a more granular parsing (e.g. prefix is separated from message, get filtered lines, etc).

  • fixes colorize_nicks.py prefixes all prefixless nicks with F10 #70, fixes [colorize_nicks.py] Mentioning nick "F1" breaks line prefix #135.

• Add preserving of message colors logic.

  • fixes [colorize_nicks.py] IRC color overriding #49, fixes colorize_nicks breaks the surrounding colors #175.

• Add irc_only option to ignore non IRC messages (i.e. set buffer restrictions: plugin = irc, tags = irc_privmsg and irc_notice, type = channel and private).

• Add do not colorize nicks in filtered messages, and colorize_filtered option.

• Add colorizing of IRC prefixes and nicks on IRC private buffers.

• Update colorized_input_cb() with the changes, and add decoding of IRC colors from input.

• Update config_init() parsing of options.

• Remove 'so,root' from blacklist_nicks default option. (These nicks do not make sense for defaults.)

• Change min_nick_length default option to 1. (Single char nicks should not be excluded by default.)

• Remove hook_modifier() that has the modifier colorize_nicks. (Is it possible to pass custom modifiers?)

• Replace % formatting strings with f-strings, " with ', and some code to use the := operator.

• Update identifiers, comments, and add some whitespace in code for readability.

• Remove unused global keywords and add error handlings.

• Remove utf-8 encoding header, add SPDX copyright + license tags, and add upstream link.

Checklist (script update)

• Author has been contacted
• Single commit, single file added
• Commit message format: script_name.py X.Y: …
• Script version and Changelog have been updated
• For Python script: works with Python 3 (Python 2 support is optional)
• Score 100 / 100 displayed by weechat-script-lint

[weechatter]

works for me

[flashcode]

Hi @ryoskzypu,

Thanks for all these improvements.

To trace the history, could you please add all new features and fixes into the body of the
commit message (using (closes #1234) to close bugs).

And then you can remove (see Changes in the PR #574 for details) fro the script comment, as it's better to have detail of changes in git itself.

Thanks!

[ryoskzypu]

@weechatter: Thanks for testing.

@flashcode: Done! Is it okay? I tried my best to fit the changes in commit for git log.

Thanks for all these improvements.

You're welcome and thank you for this great piece of software (WeeChat ofc). ;-)

[flashcode]

Thanks, merged.

[serious-angel]

Thank you, heartfelt, for the awesome work, marvel you do, dear Developers and Artists! ✨