Merge remote-tracking branch 'upstream/master' into chatterino7

.github/workflows/build.yml

@@ -192,8 +192,8 @@ jobs:
         shell: powershell
 
       - name: Setup sccache (Windows)
-        # sccache v0.5.3
-        uses: nerixyz/ccache-action@9a7e8d00116ede600ee7717350c6594b8af6aaa5
+        # sccache v0.7.4
+        uses: hendrikmuhs/ccache-action@v1.2.12
         if: startsWith(matrix.os, 'windows')
         with:
           variant: sccache

.github/workflows/test-macos.yml

@@ -9,6 +9,8 @@ on:
 env:
   TWITCH_PUBSUB_SERVER_TAG: v1.0.7
   QT_QPA_PLATFORM: minimal
+  HOMEBREW_NO_AUTO_UPDATE: 1
+  HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1
 
 concurrency:
   group: test-macos-${{ github.ref }}

.github/workflows/test-windows.yml

@@ -72,8 +72,8 @@ jobs:
           "C2_CONAN_CACHE_SUFFIX=$(if ($Env:C2_BUILD_WITH_QT6 -eq "on") { "-QT6" } else { "`" })" >> "$Env:GITHUB_ENV"
 
       - name: Setup sccache
-        # sccache v0.5.3
-        uses: nerixyz/ccache-action@9a7e8d00116ede600ee7717350c6594b8af6aaa5
+        # sccache v0.7.4
+        uses: hendrikmuhs/ccache-action@v1.2.12
         with:
           variant: sccache
           # only save on the default (master) branch

CHANGELOG.md

@@ -20,8 +20,9 @@
 - Minor: Updated the flatpakref link included with nightly builds to point to up-to-date flathub-beta builds. (#5008)
 - Minor: Add a new completion API for experimental plugins feature. (#5000, #5047)
 - Minor: Re-enabled _Restart on crash_ option on Windows. (#5012)
+- Minor: The chatter list button is now hidden if you don't have moderator privileges. (#5245)
 - Minor: The whisper highlight color can now be configured through the settings. (#5053)
-- Minor: Added an option to always include the broadcaster in user completions. This is enabled by default. (#5193)
+- Minor: Added an option to always include the broadcaster in user completions. This is enabled by default. (#5193, #5244)
 - Minor: Added missing periods at various moderator messages and commands. (#5061)
 - Minor: Improved color selection and display. (#5057)
 - Minor: Improved Streamlink documentation in the settings dialog. (#5076)
@@ -35,13 +36,17 @@
 - Minor: Add a new Channel API for experimental plugins feature. (#5141, #5184, #5187)
 - Minor: Added the ability to change the top-most status of a window regardless of the _Always on top_ setting (right click the notebook). (#5135)
 - Minor: Introduce `c2.later()` function to Lua API. (#5154)
-- Minor: Live streams that are marked as reruns now mark a tab as yellow instead of red. (#5176)
+- Minor: Live streams that are marked as reruns now mark a tab as yellow instead of red. (#5176, #5237)
 - Minor: Updated to Emoji v15.1. Google emojis are now used as the fallback instead of Twitter emojis. (#5182)
+- Minor: Added the ability to show AutoMod caught messages in mentions. (#5215)
+- Minor: Added the ability to configure the color of highlighted AutoMod caught messages. (#5215)
 - Minor: Allow theming of tab live and rerun indicators. (#5188)
 - Minor: Added a fallback theme field to custom themes that will be used in case the custom theme does not contain a color Chatterino needs. If no fallback theme is specified, we'll pull the color from the included Dark or Light theme. (#5198)
 - Minor: Image links now reflect the scale of their image instead of an internal label. (#5201)
 - Minor: IPC files are now stored in the Chatterino directory instead of system directories on Windows. (#5226)
 - Minor: 7TV emotes now have a 4x image rather than a 3x image. (#5209)
+- Minor: Add wrappers for Lua `io` library for experimental plugins feature. (#5231)
+- Minor: Add permissions to experimental plugins feature. (#5231)
 - Bugfix: Fixed an issue where certain emojis did not send to Twitch chat correctly. (#4840)
 - Bugfix: Fixed capitalized channel names in log inclusion list not being logged. (#4848)
 - Bugfix: Trimmed custom streamlink paths on all platforms making sure you don't accidentally add spaces at the beginning or end of its path. (#4834)
@@ -73,6 +78,7 @@
 - Bugfix: Fixed triple click on message also selecting moderation buttons. (#4961)
 - Bugfix: Fixed a freeze from a bad regex in _Ignores_. (#4965, #5126)
 - Bugfix: Fixed badge highlight changes not immediately being reflected. (#5110)
+- Bugfix: Fixed emotes being reloaded when pressing "Cancel" in the settings dialog, causing a slowdown. (#5240)
 - Bugfix: Fixed some emotes not appearing when using _Ignores_. (#4965, #5126)
 - Bugfix: Fixed lookahead/-behind not working in _Ignores_. (#4965, #5126)
 - Bugfix: Fixed Image Uploader accidentally deleting images with some hosts when link resolver was enabled. (#4971)
@@ -85,6 +91,7 @@
 - Bugfix: Fixed a crash that could occur when using certain features in a Reply popup after closing the split from which it was created. (#5036, #5051)
 - Bugfix: Fixed a bug on Wayland where tooltips would spawn as separate windows instead of behaving like tooltips. (#4998, #5040)
 - Bugfix: Fixes to section deletion in text input fields. (#5013)
+- Bugfix: Truncated IRC messages to be at most 512 bytes. (#5246)
 - Bugfix: Show user text input within watch streak notices. (#5029)
 - Bugfix: Fixed avatar in usercard and moderation button triggering when releasing the mouse outside their area. (#5052)
 - Bugfix: Fixed moderator-only topics being subscribed to for non-moderators. (#5056)
@@ -98,6 +105,9 @@
 - Bugfix: Fixed link info not updating without moving the cursor. (#5178)
 - Bugfix: Fixed an upload sometimes failing when copying an image from a browser if it contained extra properties. (#5156)
 - Bugfix: Fixed tooltips getting out of bounds when loading images. (#5186)
+- Bugfix: Fixed the "Cancel" button in the settings dialog only working after opening the settings dialog twice. (#5229)
+- Bugfix: Fixed split header tooltips showing in the wrong position on Windows. (#5230)
+- Bugfix: Fixed split header tooltips appearing too tall. (#5232)
 - Dev: Run miniaudio in a separate thread, and simplify it to not manage the device ourselves. There's a chance the simplification is a bad idea. (#4978)
 - Dev: Change clang-format from v14 to v16. (#4929)
 - Dev: Fixed UTF16 encoding of `modes` file for the installer. (#4791)
@@ -141,6 +151,7 @@
 - Dev: Move `clang-tidy` checker to its own CI job. (#4996)
 - Dev: Refactored the Image Uploader feature. (#4971)
 - Dev: Refactored the SplitOverlay code. (#5082)
+- Dev: Refactored the Fonts code, making it less of a singleton. (#5228)
 - Dev: Refactored the TwitchBadges structure, making it less of a singleton. (#5096, #5144)
 - Dev: Refactored emotes out of TwitchIrcServer. (#5120, #5146)
 - Dev: Refactored the ChatterinoBadges structure, making it less of a singleton. (#5103)
@@ -170,7 +181,7 @@
 - Dev: Added estimation for image sizes to avoid layout shifts. (#5192)
 - Dev: Added the `launachable` entry to Linux AppData. (#5210)
 - Dev: Cleaned up and optimized resources. (#5222)
-- Dev: Refactor `StreamerMode`. (#5216)
+- Dev: Refactor `StreamerMode`. (#5216, #5236)
 - Dev: Cleaned up unused code in `MessageElement` and `MessageLayoutElement`. (#5225)
 
 ## 2.4.6

docs/plugin-info.schema.json

@@ -41,9 +41,21 @@
     },
     "license": {
       "type": "string",
-      "description": "A small description of your license.",
+      "description": "SPDX identifier for license of this plugin. See https://spdx.org/licenses/",
       "examples": ["MIT", "GPL-2.0-or-later"]
     },
+    "permissions": {
+      "type": "array",
+      "description": "The permissions the plugin needs to work.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "enum": ["FilesystemRead", "FilesystemWrite"]
+          }
+        }
+      }
+    },
     "$schema": { "type": "string" }
   },
   "required": ["name", "description", "authors", "version", "license"]

docs/wip-plugins.md

@@ -14,7 +14,9 @@ Each plugin should have its own directory.
 Chatterino Plugins dir/
 └── plugin_name/
     ├── init.lua
-    └── info.json
+    ├── info.json
+    └── data/
+        └── This is where your data/configs can be dumped
 ```
 
 `init.lua` will be the file loaded when the plugin is enabled. You may load other files using [`require` global function](#requiremodname).
@@ -35,12 +37,54 @@ Example file:
   "homepage": "https://github.com/Chatterino/Chatterino2",
   "tags": ["test"],
   "version": "0.0.0",
-  "license": "MIT"
+  "license": "MIT",
+  "permissions": []
 }
 ```
 
 An example plugin is available at [https://github.com/Mm2PL/Chatterino-test-plugin](https://github.com/Mm2PL/Chatterino-test-plugin)
 
+## Permissions
+
+Plugins can have permissions associated to them. Unless otherwise noted functions don't require permissions.
+These are the valid permissions:
+
+### FilesystemRead
+
+Allows the plugin to read from its data directory.
+
+Example:
+
+```json
+{
+  ...,
+  "permissions": [
+    {
+      "type": "FilesystemRead"
+    },
+    ...
+  ]
+}
+```
+
+### FilesystemWrite
+
+Allows the plugin to write to files and create files in its data directory.
+
+Example:
+
+```json
+{
+  ...,
+  "permissions": [
+    {
+      "type": "FilesystemWrite"
+    },
+    ...
+  ]
+}
+```
+
 ## Plugins with Typescript
 
 If you prefer, you may use [TypescriptToLua](https://typescripttolua.github.io)
@@ -60,9 +104,10 @@ script](../scripts/make_luals_meta.py).
 The following parts of the Lua standard library are loaded:
 
 - `_G` (most globals)
-- `table`
-- `string`
+- `io` - except `stdin`, `stdout`, `stderr`. Some functions require permissions.
 - `math`
+- `string`
+- `table`
 - `utf8`
 
 The official manual for them is available [here](https://www.lua.org/manual/5.4/manual.html#6).
@@ -325,6 +370,117 @@ Returns `true` if the channel can be moderated by the current user.
 
 Returns `true` if the current user is a VIP in the channel.
 
+### Input/Output API
+
+These functions are wrappers for Lua's I/O library. Functions on file pointer
+objects (`FILE*`) are not modified or replaced. [You can read the documentation
+for them here](https://www.lua.org/manual/5.4/manual.html#pdf-file:close).
+Chatterino does _not_ give you stdin and stdout as default input and output
+respectively. The following objects are missing from the `io` table exposed by
+Chatterino compared to Lua's native library: `stdin`, `stdout`, `stderr`.
+
+#### `close([file])`
+
+Closes a file. If not given, `io.output()` is used instead.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.close)
+
+#### `flush()`
+
+Flushes `io.output()`.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.flush)
+
+#### `input([file_or_name])`
+
+When called with no arguments this function returns the default input file.
+This variant requires no permissions.
+
+When called with a file object, it will set the default input file to the one
+given. This one also requires no permissions.
+
+When called with a filename as a string, it will open that file for reading.
+Equivalent to: `io.input(io.open(filename))`. This variant requires
+the `FilesystemRead` permission and the given file to be within the plugin's
+data directory.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.input)
+
+#### `lines([filename, ...])`
+
+With no arguments this function is equivalent to `io.input():lines("l")`. See
+[Lua documentation for file:flush()](https://www.lua.org/manual/5.4/manual.html#pdf-file:flush).
+This variant requires no permissions.
+
+With `filename` given it is most like `io.open(filename):lines(...)`. This
+variant requires the `FilesystemRead` permission and the given file to be
+within the plugin's data directory.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.lines)
+
+#### `open(filename [, mode])`
+
+This functions opens the given file with a mode. It requires `filename` to be
+within the plugin's data directory. A call with no mode given is equivalent to
+one with `mode="r"`.
+Depending on the mode this function has slightly different behavior:
+
+| Mode        | Permission        | Read? | Write? | Truncate? | Create? |
+| ----------- | ----------------- | ----- | ------ | --------- | ------- |
+| `r` read    | `FilesystemRead`  | Yes   | No     | No        | No      |
+| `w` write   | `FilesystemWrite` | No    | Yes    | Yes       | Yes     |
+| `a` append  | `FilesystemWrite` | No    | Append | No        | Yes     |
+| `r+` update | `FilesystemWrite` | Yes   | Yes    | No        | No      |
+| `w+` update | `FilesystemWrite` | Yes   | Yes    | Yes       | Yes     |
+| `a+` update | `FilesystemWrite` | Yes   | Append | No        | Yes     |
+
+To open a file in binary mode add a `b` at the end of the mode.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.open)
+
+#### `output([file_or_name])`
+
+This is identical to [`io.input()`](#inputfile_or_name) but operates on the
+default output and opens the file in write mode instead. Requires
+`FilesystemWrite` instead of `FilesystemRead`.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.output)
+
+#### `popen(exe [, mode])`
+
+This function is unavailable in Chatterino. Calling it results in an error
+message to let you know that it's not available, no permissions needed.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.popen)
+
+#### `read(...)`
+
+Equivalent to `io.input():read(...)`. See [`io.input()`](#inputfile_or_name)
+and [`file:read()`](https://www.lua.org/manual/5.4/manual.html#pdf-file:read).
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.read)
+
+#### `tmpfile()`
+
+This function is unavailable in Chatterino. Calling it results in an error
+message to let you know that it's not available, no permissions needed.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.tmpfile)
+
+#### `type(obj)`
+
+This functions allows you to tell if the object is a `file`, a `closed file` or
+a different bit of data.
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.type)
+
+#### `write(...)`
+
+Equivalent to `io.output():write(...)`. See [`io.output()`](#outputfile_or_name)
+and [`file:write()`](https://www.lua.org/manual/5.4/manual.html#pdf-file:write).
+
+See [official documentation](https://www.lua.org/manual/5.4/manual.html#pdf-io.write)
+
 ### Changed globals
 
 #### `load(chunk [, chunkname [, mode [, env]]])`
@@ -344,7 +500,8 @@ However, the searcher and load configuration is notably different from the defau
 - `package.path` is not used, in its place are two searchers,
 - when `require()` is used, first a file relative to the currently executing
   file will be checked, then a file relative to the plugin directory,
-- binary chunks are never loaded
+- binary chunks are never loaded,
+- files inside of the plugin `data` directory are never loaded
 
 As in normal Lua, dots are converted to the path separators (`'/'` on Linux and Mac, `'\'` on Windows).
 
@@ -354,6 +511,7 @@ Example:
 require("stuff") -- executes Plugins/name/stuff.lua or $(dirname $CURR_FILE)/stuff.lua
 require("dir.name") -- executes Plugins/name/dir/name.lua or $(dirname $CURR_FILE)/dir/name.lua
 require("binary") -- tried to load Plugins/name/binary.lua and errors because binary is not a text file
+require("data.file") -- tried to load Plugins/name/data/file.lua and errors because that is not allowed
 ```
 
 #### `print(Args...)`

mocks/include/mocks/EmptyApplication.hpp

@@ -5,6 +5,8 @@
 #include "singletons/Paths.hpp"
 #include "singletons/Updates.hpp"
 
+#include <QTemporaryDir>
+
 namespace chatterino::mock {
 
 class EmptyApplication : public IApplication
@@ -249,7 +251,8 @@ class EmptyApplication : public IApplication
         return nullptr;
     }
 
-private:
+protected:
+    QTemporaryDir settingsDir;
     Paths paths_;
     Args args_;
     Updates updates_;

resources/contributors.txt

@@ -68,6 +68,7 @@ chrrs | https://github.com/chrrs | | Contributor
 crazysmc | https://github.com/crazysmc | :/avatars/crazysmc.png | Contributor
 SputNikPlop | https://github.com/SputNikPlop | | Contributor
 fraxx | https://github.com/fraxxio | :/avatars/fraxx.png | Contributor
+KleberPF | https://github.com/KleberPF | | Contributor
 
 # If you are a contributor add yourself above this line