Compare commits

..
Author SHA1 Message Date
deepend 9e3daf494f msi/msix support 2026-10-13 19:13:50 -06:00
deepend 4f7add046c match theme better 2026-10-12 19:05:31 -06:00
deepend-tildeclub 61ec9af5e3 Merge pull request #420 from ZoiteChat/docs-theme-update
update theme to match new site
2026-10-12 17:11:27 -07:00
deepend 412dc92b10 update theme to match new site 2026-10-12 18:04:49 -06:00
deepend-tildeclub 04dab3dcd6 Merge pull request #412 from TehPeGaSuS/wrap-align-no-indent
Add option to align wrapped lines under the nick or message
2026-10-12 15:28:33 -07:00
ThePeGaSuS c51f885253 add option to align wrapped lines under the nick or message
When nick indentation is off, lines after the first wrap back to the
left edge, under the timestamp. Add a text_wrap_align preference
(start of line, prefix, message) so they can line up under the nick or
the message text instead. It is applied at wrap time, so existing
scrollback is re-wrapped when the setting changes, and the menu is
greyed out while nick indentation is on.
2026-10-12 17:43:09 +02:00
deepend-tildeclub aa7e20fee9 Merge pull request #417 from botovq/push-kwovwrnwwuzn
Minor simplification of _SSL_get_cert_info ()
2026-10-12 06:40:46 -07:00
deepend-tildeclub 480b99b1e7 Merge pull request #413 from B4reMetal/hex-color-parsing
feat(xtext): render \x04 hex color codes in chat text
2026-10-12 06:37:19 -07:00
BareMetal 0a4367b1da fix(xtext): move hexcolor_parse to its own file for the standalone xtext tests
master's new xtext_tests target compiles xtext.c on its own with only
GTK linked, so hexcolor_parse cannot live in util.c. Keep it in a
dependency-free hexcolor.c that both test targets compile, and register
it in the Visual Studio project for the Windows build.

Claude-Session: https://claude.ai/code/session_01Jxd4AknGzdAENADWAGHCzx
2026-10-11 23:58:09 -06:00
BareMetal 39daca9d22 feat(xtext): render \x04 hex color codes in chat text 2026-10-11 23:54:08 -06:00
deepend-tildeclub d614e25792 Merge pull request #419 from ZoiteChat/xtext-modernize
modernize rendering and fix scrollback resizing
2026-10-11 22:48:52 -07:00
deepend 30209d0c99 modernize rendering and fix scrollback resizing 2026-10-11 23:02:13 -06:00
Theo Buehler e1c44feb01 Minor simplification of _SSL_get_cert_info ()
Instead of retrieving the AlgorithmIdentifier and then reaching into it
to get the OID, the relevant OID can be obtained directly from the same
function.
2026-10-11 17:45:37 +02:00
deepend 5af8f4ede1 correct echo-message capability negotiation 2026-10-03 19:52:16 -06:00
59 changed files with 4060 additions and 4452 deletions
+428
View File
@@ -0,0 +1,428 @@
name: Windows MSI/MSIX Build
on:
push:
branches:
- master
- 'release/**'
pull_request:
branches:
- master
workflow_dispatch:
jobs:
windows_msi_build:
runs-on: windows-2022
permissions:
contents: read
id-token: write
attestations: write
artifact-metadata: write
strategy:
matrix:
platform: [x64]
arch: [x64]
fail-fast: false
steps:
- uses: actions/checkout@v5
- uses: actions/setup-python@v6
with:
python-version: '3.14.3'
architecture: ${{ matrix.arch }}
- name: Install Dependencies
shell: pwsh
run: |
New-Item -Name "deps" -ItemType "Directory" -Force | Out-Null
python -m pip install --upgrade pip
python -m pip install cffi
python -m pip install zstandard
$ProgressPreference = 'SilentlyContinue'
function Download-WithRetry {
param(
[string]$Url,
[string]$OutFile,
[int]$MaxAttempts = 5,
[int]$InitialDelaySeconds = 2
)
for ($attempt = 1; $attempt -le $MaxAttempts; $attempt++) {
try {
Invoke-WebRequest -Uri $Url -OutFile $OutFile -ErrorAction Stop
return
}
catch {
if ($attempt -eq $MaxAttempts) {
throw
}
Start-Sleep -Seconds ($InitialDelaySeconds * [math]::Pow(2, $attempt - 1))
}
}
}
# The existing solution includes installer.vcxproj, so Inno Setup is
# still required to build the unmodified solution. This workflow does
# not publish that EXE; it packages the same staged rel tree as MSI/MSIX.
Download-WithRetry -Url https://github.com/jrsoftware/issrc/releases/download/is-6_7_1/innosetup-6.7.1.exe -OutFile deps\innosetup-unicode.exe
& deps\innosetup-unicode.exe /VERYSILENT | Out-Null
# Use the same GTK runtime as the existing Windows EXE workflow.
Download-WithRetry -Url https://github.com/ZoiteChat/gvsbuild/releases/download/zoitechat-2.20.0-alpha.1/GTK3_Gvsbuild_zoitechat-2.20.0-alpha.1_x64.zip -OutFile deps\gtk-${{ matrix.arch }}.zip
Expand-Archive -LiteralPath deps\gtk-${{ matrix.arch }}.zip -DestinationPath C:\gtk-build\gtk\x64\release -Force
# The GTK3 bundle does not contain librsvg. Restore the renderer,
# pixbuf loader, and license from the matching GTK4 bundle. Do not
# replace the rest of the GTK3 runtime with GTK4 libraries.
Download-WithRetry -Url https://github.com/ZoiteChat/gvsbuild/releases/download/zoitechat-2.20.0-alpha.1/GTK4_Gvsbuild_zoitechat-2.20.0-alpha.1_x64.zip -OutFile deps\svg-runtime.zip
if ((Get-FileHash deps\svg-runtime.zip -Algorithm SHA256).Hash -ne 'fb657f9ebae3a6807defb15e66091d643a703ee66cb37488e3e11e5646f45adb') {
throw 'Unexpected SVG runtime archive checksum'
}
$svgArchive = [System.IO.Compression.ZipFile]::OpenRead((Resolve-Path deps\svg-runtime.zip))
try {
foreach ($name in @('bin/rsvg-2-2.dll', 'lib/gdk-pixbuf-2.0/2.10.0/loaders/pixbufloader_svg.dll', 'share/doc/librsvg/COPYING.LIB')) {
$entry = $svgArchive.GetEntry($name)
if ($null -eq $entry) { throw "Missing SVG runtime file: $name" }
$destination = Join-Path 'C:\gtk-build\gtk\x64\release' $name
New-Item -ItemType Directory -Path (Split-Path $destination) -Force | Out-Null
[System.IO.Compression.ZipFileExtensions]::ExtractToFile($entry, $destination, $true)
}
}
finally { $svgArchive.Dispose() }
# Ensure SVG remains loadable before compiling or packaging.
& C:\gtk-build\gtk\x64\release\bin\gdk-pixbuf-query-loaders.exe --update-cache
if ($LASTEXITCODE -ne 0) { throw 'Could not generate the pixbuf loader cache' }
if (-not (Select-String -LiteralPath 'C:\gtk-build\gtk\x64\release\lib\gdk-pixbuf-2.0\2.10.0\loaders.cache' -SimpleMatch '"svg"')) {
throw 'SVG loader could not be loaded with the GTK3 runtime'
}
Download-WithRetry -Url https://repo.msys2.org/mingw/x86_64/mingw-w64-x86_64-hicolor-icon-theme-0.18-1-any.pkg.tar.zst -OutFile deps\hicolor-icon-theme.pkg.tar.zst
python -c "import tarfile,zstandard,pathlib;archive=pathlib.Path(r'deps\\hicolor-icon-theme.pkg.tar.zst');target=pathlib.Path(r'C:\\gtk-build\\gtk\\x64\\release');dctx=zstandard.ZstdDecompressor();f=archive.open('rb');reader=dctx.stream_reader(f);tf=tarfile.open(fileobj=reader,mode='r|');[tf.extract(m,path=target) for m in tf if m.name.startswith('mingw64/share/icons/hicolor/')];tf.close();reader.close();f.close()"
Download-WithRetry -Url https://repo.msys2.org/mingw/x86_64/mingw-w64-x86_64-libarchive-3.8.6-1-any.pkg.tar.zst -OutFile deps\libarchive.pkg.tar.zst
python -c "import tarfile,zstandard,pathlib;archive=pathlib.Path(r'deps\\libarchive.pkg.tar.zst');target=pathlib.Path(r'C:\\gtk-build\\gtk\\x64\\release');dctx=zstandard.ZstdDecompressor();f=archive.open('rb');reader=dctx.stream_reader(f);tf=tarfile.open(fileobj=reader,mode='r|');[tf.extract(m,path=target) for m in tf if m.name.startswith(('mingw64/include/archive','mingw64/lib/libarchive','mingw64/bin/libarchive'))];tf.close();reader.close();f.close()"
if (Test-Path C:\gtk-build\gtk\x64\release\mingw64\share\icons\hicolor) {
New-Item -Path C:\gtk-build\gtk\x64\release\share\icons -ItemType Directory -Force | Out-Null
Copy-Item -Path C:\gtk-build\gtk\x64\release\mingw64\share\icons\hicolor -Destination C:\gtk-build\gtk\x64\release\share\icons\hicolor -Recurse -Force
}
if (Test-Path C:\gtk-build\gtk\x64\release\mingw64\include) {
New-Item -Path C:\gtk-build\gtk\x64\release\include -ItemType Directory -Force | Out-Null
Copy-Item -Path C:\gtk-build\gtk\x64\release\mingw64\include\archive* -Destination C:\gtk-build\gtk\x64\release\include -Recurse -Force
}
if (Test-Path C:\gtk-build\gtk\x64\release\mingw64\lib) {
New-Item -Path C:\gtk-build\gtk\x64\release\lib -ItemType Directory -Force | Out-Null
Copy-Item -Path C:\gtk-build\gtk\x64\release\mingw64\lib\libarchive* -Destination C:\gtk-build\gtk\x64\release\lib -Force
}
if (Test-Path C:\gtk-build\gtk\x64\release\mingw64\bin) {
New-Item -Path C:\gtk-build\gtk\x64\release\bin -ItemType Directory -Force | Out-Null
Copy-Item -Path C:\gtk-build\gtk\x64\release\mingw64\bin\libarchive*.dll -Destination C:\gtk-build\gtk\x64\release\bin -Force
}
if (Test-Path C:\gtk-build\gtk\x64\release\mingw64) {
Remove-Item -Path C:\gtk-build\gtk\x64\release\mingw64 -Recurse -Force
}
Download-WithRetry -Url https://github.com/ZoiteChat/gvsbuild/releases/download/zoitechat-2.18.0-pre4/gendef20260315.7z -OutFile deps\gendef.7z
& 7z.exe x deps\gendef.7z -oC:\gtk-build
Download-WithRetry -Url https://github.com/ZoiteChat/gvsbuild/releases/download/zoitechat-2.18.0-pre4/WinSparkle-20260315.7z -OutFile deps\WinSparkle.7z
& 7z.exe x deps\WinSparkle.7z -oC:\gtk-build\WinSparkle
Download-WithRetry -Url https://github.com/ZoiteChat/gvsbuild/releases/download/zoitechat-2.18.0-pre4/perl-5.42.0.1-${{ matrix.arch }}.7z -OutFile deps\perl-${{ matrix.arch }}.7z
& 7z.exe x deps\perl-${{ matrix.arch }}.7z -oC:\gtk-build\perl-5.42.0.1\${{ matrix.platform }}
$pyRoot = $env:pythonLocation
if (-not $pyRoot) { $pyRoot = & python -c "import sys; print(sys.prefix)" }
foreach ($pyDir in @("C:\gtk-build\python-3.14.3", "C:\gtk-build\python-3.14")) {
New-Item -Path $pyDir -ItemType Directory -Force | Out-Null
$target = Join-Path $pyDir "${{ matrix.platform }}"
if (Test-Path $target) { Remove-Item $target -Recurse -Force }
New-Item -Path $pyDir -Name "${{ matrix.platform }}" -ItemType Junction -Value $pyRoot | Out-Null
}
- uses: actions/setup-python@v6
with:
python-version: '3.8.10'
architecture: ${{ matrix.arch }}
- name: Prepare Python 3.8
shell: pwsh
run: |
python -m pip install --upgrade pip
python -m pip install cffi
$pyRoot = $env:pythonLocation
if (-not $pyRoot) { $pyRoot = & python -c "import sys; print(sys.prefix)" }
foreach ($pyDir in @("C:\gtk-build\python-3.8.10", "C:\gtk-build\python-3.8")) {
New-Item -Path $pyDir -ItemType Directory -Force | Out-Null
$target = Join-Path $pyDir "${{ matrix.platform }}"
if (Test-Path $target) { Remove-Item $target -Recurse -Force }
New-Item -Path $pyDir -Name "${{ matrix.platform }}" -ItemType Junction -Value $pyRoot | Out-Null
}
- name: Build
shell: cmd
run: |
call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\Tools\VsDevCmd.bat"
set "PYTHON_DIR=C:\gtk-build\python-3.14.3\${{ matrix.platform }}"
if not exist "%PYTHON_DIR%\libs\python314.lib" (
echo Missing %PYTHON_DIR%\libs\python314.lib
dir "%PYTHON_DIR%\libs"
exit /b 1
)
set "PYTHON38_DIR=C:\gtk-build\python-3.8\${{ matrix.platform }}"
if not exist "%PYTHON38_DIR%\libs\python38.lib" (
echo Missing %PYTHON38_DIR%\libs\python38.lib
dir "%PYTHON38_DIR%\libs"
exit /b 1
)
if not exist "%PYTHON38_DIR%\Lib\site-packages\_cffi_backend.cp38*.pyd" (
echo Missing %PYTHON38_DIR%\Lib\site-packages\_cffi_backend.cp38*.pyd
exit /b 1
)
set "LIB=%PYTHON_DIR%\libs;%LIB%"
set "INCLUDE=%PYTHON_DIR%\include;%INCLUDE%"
powershell -NoProfile -ExecutionPolicy Bypass -Command "$archiveLib='C:\gtk-build\gtk\x64\release\lib\libarchive.lib'; if (-not (Test-Path $archiveLib)) { $archiveDll = Get-ChildItem 'C:\gtk-build\gtk\x64\release\bin\libarchive*.dll' | Select-Object -First 1; if ($archiveDll) { Push-Location 'C:\gtk-build\gtk\x64\release\lib'; & 'C:\gtk-build\gendef\gendef.exe' $archiveDll.FullName | Out-Null; $archiveDef = Get-ChildItem 'libarchive*.def' | Select-Object -First 1; if ($archiveDef) { & lib /def:$archiveDef.Name /machine:${{ matrix.platform }} /out:libarchive.lib | Out-Null }; Pop-Location } }"
msbuild win32\zoitechat.sln /m /verbosity:minimal /p:Configuration=Release /p:Platform=${{ matrix.platform }}
if errorlevel 1 exit /b 1
if not exist "..\zoitechat-build\${{ matrix.platform }}\rel\plugins\hcpython38.dll" (
echo hcpython38.dll was not built
exit /b 1
)
if not exist "..\zoitechat-build\${{ matrix.platform }}\rel\_cffi_backend.cp38*.pyd" (
echo _cffi_backend for Python 3.8 was not staged for the installer
exit /b 1
)
# Master added native emoji font staging and tests after the release
# branch split. Run these before packaging so MSI/MSIX use verified files.
- name: Test emoji catalog, font coverage and picker
shell: cmd
run: |
call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\Tools\VsDevCmd.bat"
set "PATH=%CD%\..\zoitechat-build\x64\rel;%PATH%"
set "GDK_PIXBUF_MODULE_FILE=%CD%\..\zoitechat-build\x64\rel\lib\gdk-pixbuf-2.0\2.10.0\loaders.cache"
set "ZOITECHAT_EMOJI_FONT=%CD%\..\zoitechat-build\x64\rel\share\fonts\zoitechat\NotoColorEmoji.ttf"
fc /b data\fonts\NotoColorEmoji.ttf "%ZOITECHAT_EMOJI_FONT%"
if errorlevel 1 exit /b 1
for %%T in (data font ui) do (
msbuild win32\emoji-tests.vcxproj /m /verbosity:minimal /p:Configuration=Release /p:Platform=x64 /p:EmojiTestKind=%%T
if errorlevel 1 exit /b 1
..\zoitechat-build\x64\tests\emoji-%%T-tests.exe --tap
if errorlevel 1 exit /b 1
)
- name: Install WiX Toolset
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
# Keep this pinned. WiX v6 introduced OSMF terms and WiX v7 adds
# explicit EULA acceptance; do not silently accept new terms in CI.
dotnet tool install --tool-path .wix wix --version 5.0.2
if ($LASTEXITCODE -ne 0) { throw 'Failed to install WiX Toolset 5.0.2' }
& .\.wix\wix.exe --version
if ($LASTEXITCODE -ne 0) { throw 'WiX Toolset could not be executed' }
- name: Build MSI
id: build_msi
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
$rawVersion = (Get-Content VERSION -Raw).Trim()
if ($rawVersion -notmatch '^(\d+)\.(\d+)\.(\d+)') {
throw "VERSION '$rawVersion' does not begin with an MSI-compatible major.minor.patch version"
}
# Keep the full development version in the filename, while MSI's
# ProductVersion is numeric (e.g. 2.20.0-dev -> 2.20.0).
$msiVersion = "$($Matches[1]).$($Matches[2]).$($Matches[3])"
$safeVersion = $rawVersion -replace '[^0-9A-Za-z._-]', '-'
$sourceDir = (Resolve-Path "..\zoitechat-build\${{ matrix.platform }}\rel").Path
$outputPath = Join-Path $PWD "ZoiteChat-${safeVersion}_${{ matrix.arch }}.msi"
if (-not (Test-Path (Join-Path $sourceDir 'zoitechat.exe'))) {
throw "Staged ZoiteChat executable is missing from $sourceDir"
}
& .\.wix\wix.exe build win32\wix\zoitechat.wxs `
-arch x64 `
-d "SourceDir=$sourceDir" `
-d "ProductVersion=$msiVersion" `
-out $outputPath
if ($LASTEXITCODE -ne 0) { throw 'WiX MSI build failed' }
if (-not (Test-Path $outputPath)) {
throw "Expected MSI was not created: $outputPath"
}
"path=$outputPath" >> $env:GITHUB_OUTPUT
"filename=$(Split-Path $outputPath -Leaf)" >> $env:GITHUB_OUTPUT
- name: Test MSI administrative extraction
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
$msi = '${{ steps.build_msi.outputs.path }}'
$adminImage = Join-Path $PWD 'msi-admin-image'
New-Item -ItemType Directory -Path $adminImage -Force | Out-Null
$arguments = "/a `"$msi`" /qn TARGETDIR=`"$adminImage`""
$process = Start-Process -FilePath msiexec.exe -ArgumentList $arguments -Wait -PassThru
if ($process.ExitCode -ne 0) {
throw "MSI administrative extraction failed with exit code $($process.ExitCode)"
}
foreach ($requiredFile in @(
'zoitechat.exe',
'hclua.dll',
'hcupd.dll',
'WinSparkle.dll',
'hcchecksum.dll',
'hcexec.dll',
'hcfishlim.dll',
'hcsysinfo.dll',
'system.png',
'hcperl.dll',
'hcpython3.dll',
'hcpython38.dll',
'NotoColorEmoji.ttf',
'OFL.txt'
)) {
$match = Get-ChildItem -Path $adminImage -Filter $requiredFile -File -Recurse | Select-Object -First 1
if ($null -eq $match) {
throw "Administrative image does not contain required normal-install file: $requiredFile"
}
}
foreach ($requiredPattern in @('_cffi_backend.cp314*.pyd', '_cffi_backend.cp38*.pyd')) {
$match = Get-ChildItem -Path $adminImage -Filter $requiredPattern -File -Recurse | Select-Object -First 1
if ($null -eq $match) {
throw "Administrative image does not contain required Python support file: $requiredPattern"
}
}
foreach ($requiredPythonFile in @('zoitechat.py', '_zoitechat.py', 'hexchat.py', 'xchat.py')) {
$match = Get-ChildItem -Path $adminImage -Filter $requiredPythonFile -File -Recurse |
Where-Object { $_.Directory.Name -eq 'python' } |
Select-Object -First 1
if ($null -eq $match) {
throw "Administrative image does not contain required Python bridge file: $requiredPythonFile"
}
}
foreach ($excludedFile in @(
'portable-mode',
'zoitechat-text.exe'
)) {
$match = Get-ChildItem -Path $adminImage -Filter $excludedFile -File -Recurse | Select-Object -First 1
if ($null -ne $match) {
throw "MSI incorrectly contains Inno custom/portable-only file: $excludedFile"
}
}
- name: Build MSIX
id: build_msix
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
$rawVersion = (Get-Content VERSION -Raw).Trim()
if ($rawVersion -notmatch '^(\d+)\.(\d+)\.(\d+)') {
throw "VERSION '$rawVersion' does not begin with a Store-compatible major.minor.build version"
}
$versionParts = @(
[int]$Matches[1],
[int]$Matches[2],
[int]$Matches[3]
)
if ($versionParts[0] -eq 0) {
throw 'The Microsoft Store requires a non-zero major package version.'
}
foreach ($part in $versionParts) {
if ($part -lt 0 -or $part -gt 65535) {
throw "MSIX version component '$part' is outside the Store-supported 0-65535 range."
}
}
# Partner Center reserves the fourth field as 0. A -dev version
# is packaged as a valid 2.20.0.0, without changing VERSION.
$packageVersion = "$($versionParts[0]).$($versionParts[1]).$($versionParts[2]).0"
$safeVersion = $rawVersion -replace '[^0-9A-Za-z._-]', '-'
$sourceDir = (Resolve-Path "..\zoitechat-build\${{ matrix.platform }}\rel").Path
$outputPath = Join-Path $PWD "ZoiteChat-${safeVersion}_${{ matrix.arch }}.msix"
# Reserved ZoiteChat identity from the release branch. Adjust only
# if the Product identity page in Partner Center changes.
$identityName = 'deependtilde.ZoiteChat'
$publisher = 'CN=6C7766BB-6AC6-488B-A09E-E3F8E68E63E4'
$publisherDisplayName = 'deepend_tilde'
$artifactName = 'MSIX Store Package ${{ matrix.arch }}'
Write-Host "Building Store MSIX for identity: $identityName"
& .\win32\msix\build-msix.ps1 `
-SourceDir $sourceDir `
-OutputPath $outputPath `
-PackageVersion $packageVersion `
-IdentityName $identityName `
-Publisher $publisher `
-PublisherDisplayName $publisherDisplayName `
-SelfSign
if ($LASTEXITCODE -ne 0) {
throw 'MSIX build script failed'
}
if (-not (Test-Path $outputPath)) {
throw "Expected MSIX was not created: $outputPath"
}
"path=$outputPath" >> $env:GITHUB_OUTPUT
"filename=$(Split-Path $outputPath -Leaf)" >> $env:GITHUB_OUTPUT
"package_version=$packageVersion" >> $env:GITHUB_OUTPUT
"store_ready=true" >> $env:GITHUB_OUTPUT
"artifact_name=$artifactName" >> $env:GITHUB_OUTPUT
- name: Upload MSI Installer
id: upload_msi
uses: actions/upload-artifact@v6
with:
name: MSI Installer ${{ matrix.arch }}
path: ${{ steps.build_msi.outputs.path }}
if-no-files-found: error
- name: Attest MSI Installer (Artifact Attestation)
if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}
uses: actions/attest-build-provenance@v3
with:
subject-name: MSI Installer ${{ matrix.arch }}
subject-digest: sha256:${{ steps.upload_msi.outputs.artifact-digest }}
- name: Upload MSIX Package
id: upload_msix
uses: actions/upload-artifact@v6
with:
name: ${{ steps.build_msix.outputs.artifact_name }}
path: ${{ steps.build_msix.outputs.path }}
if-no-files-found: error
- name: Attest MSIX Package (Artifact Attestation)
if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}
uses: actions/attest-build-provenance@v3
with:
subject-name: ${{ steps.build_msix.outputs.artifact_name }}
subject-digest: sha256:${{ steps.upload_msix.outputs.artifact-digest }}
+48 -5
View File
@@ -33,10 +33,53 @@ Example:
that is not visually indented that is not visually indented
``` ```
## Read the Docs theme skin ## HTML theme
The HTML output keeps the existing `basicstrap` Sphinx theme, then applies the The `zoitechat` theme inherits Sphinx's built-in `basic` theme. It uses the
ZoiteChat main-site skin from `_static/css/zoitechat-docs.css`. same compact layout, blue navigation, and system fonts as zoitechat.org.
Appearance starts in System mode on each page. Light and Dark are available
for the current page; no cookies or browser storage are used.
Brand navigation links are set in `conf.py` through `html_context`, and the The theme's templates are in `_theme/zoitechat/`. Its readable CSS and
header logo uses `_static/zoitechat-logo.svg`. JavaScript are in `_static/css/zoitechat-docs.css` and
`_static/js/zoitechat-docs.js`. No minification, JavaScript package manager,
external fonts, or CDN assets are required.
Navigation URLs, including `zoite_atlas_url`, are configured through
`html_context` in `conf.py`. The logo
is `_static/zoitechat-logo.svg`. Standard Sphinx search, indexes, source
links, anchors, translations, and previous/next links remain available.
The HTML output also works as locally installed documentation; project-site
links only access the network when clicked.
Build from the repository root:
```sh
sphinx-build -b html docs docs/_build/html
```
Use a clean output directory when switching themes, so stale Basicstrap
assets from an earlier build are not included in a package.
## Debian packaging
The active theme does not use the bundled Basicstrap, Bootstrap, jQuery,
jQuery Cookie, Font Awesome, or icon fonts. Its font stack includes DejaVu
Sans and DejaVu Sans Mono; no font files are bundled by the theme.
Packagers may exclude `docs/_theme/basicstrap/` from the source package.
The default theme continues to build without that directory. No pre-minified
third-party assets need to be added or rebuilt for this theme.
Build with the distribution's `python3-sphinx`. After installing the HTML
into the package staging directory, use `dh_sphinxdoc` (or `dh --with
sphinxdoc`) to replace Sphinx's standard JavaScript files with system
symlinks. Include `${sphinxdoc:Depends}` in the package dependencies and
`${sphinxdoc:Built-Using}` where required for generated assets. The custom
`zoitechat-docs.js` remains a small, readable project source file.
A built-in theme is still selectable with `-D html_theme=classic` if a
packager needs a different layout. The old RST content has existing build
diagnostics; changing the theme does not suppress or alter them.
Shared website chrome is in `_static/css/zoitechat-site.css`, copied from the main site. Keep that readable stylesheet in sync when changing the shared header, navigation, typography, or colours.
+631 -2218
View File
File diff suppressed because it is too large Load Diff
+526
View File
@@ -0,0 +1,526 @@
/* SPDX-License-Identifier: GPL-2.0-or-later */
/* Shared chrome copied from ZoiteChat/site assets/css/site.css (1df996a). */
:root {
color-scheme: light;
--bg: #fff;
--surface: #fff;
--chrome: #f1f2f3;
--chrome2: #e3e5e7;
--text: #25282c;
--muted: #58616b;
--line: #bdc3c9;
--soft-line: #dce0e4;
--blue: #215a9e;
--link: #174f92;
--selection: #e6effa;
--success: #236741;
--code: #f2f4f6;
--shadow: none;
--mono: Consolas,"Liberation Mono",monospace;
}
html[data-theme=dark] {
color-scheme: dark;
--bg: #111416;
--surface: #191c1f;
--chrome: #25292d;
--chrome2: #30353a;
--text: #eef0f2;
--muted: #b2bbc4;
--line: #50575e;
--soft-line: #353c43;
--blue: #2865a8;
--link: #8dc0ff;
--selection: #233951;
--success: #92d5ab;
--code: #111518;
--shadow: none;
}
* {
box-sizing: border-box;
}
body {
margin: 0;
background: var(--bg);
color: var(--text);
font: 15px/1.6 system-ui,-apple-system,"Segoe UI",sans-serif;
}
a {
color: var(--link);
text-underline-offset: 3px;
}
a:hover {
text-decoration: underline;
}
button, input, select {
font: inherit;
}
button, summary {
cursor: pointer;
}
img {
display: block;
max-width: 100%;
height: auto;
}
button, a, input, select, summary {
touch-action: manipulation;
}
:focus-visible {
outline: 3px solid var(--link);
outline-offset: 3px;
}
[hidden] {
display: none!important;
}
.sr-only {
position: absolute;
width: 1px;
height: 1px;
padding: 0;
margin: -1px;
overflow: hidden;
clip-path: inset(50%);
white-space: nowrap;
border: 0;
}
.skip-link {
position: absolute;
left: 12px;
top: -100px;
z-index: 10;
padding: 10px;
background: var(--surface);
}
.skip-link:focus {
top: 12px;
}
.topbar {
display: flex;
align-items: center;
justify-content: space-between;
gap: 20px;
padding: 0 0 16px;
background: var(--surface);
border-bottom: 1px solid var(--line);
border: 0;
}
.brand {
display: flex;
gap: 12px;
align-items: center;
color: var(--text);
text-decoration: none;
}
.brand img {
width: 38px;
height: 42px;
}
.brand strong {
font-size: 28px;
letter-spacing: -.8px;
font-weight: 650;
}
.brand small {
display: block;
font-size: 12px;
color: var(--muted);
line-height: 1.2;
}
.appearance {
display: flex;
align-items: center;
gap: 10px;
font-size: 11px;
color: var(--muted);
}
select {
border: 1px solid var(--line);
border-radius: 3px;
padding: 5px 8px;
background: var(--surface);
color: var(--text);
}
.navigation {
display: flex;
align-items: center;
justify-content: flex-start;
gap: 12px;
background: var(--chrome);
border-bottom: 1px solid var(--line);
padding: 0;
border: 1px solid var(--line);
border-radius: 0;
}
.nav-links {
display: flex;
align-items: stretch;
flex-wrap: wrap;
gap: 0;
}
.nav-links>a, .nav-menu summary {
display: flex;
align-items: center;
min-height: 36px;
padding: 6px 15px;
color: var(--text);
font-size: 13px;
text-decoration: none;
border-bottom: 0;
}
.nav-links>a[aria-current=page] {
color: #fff;
border-bottom-color: var(--blue);
font-weight: 500;
background: var(--blue);
}
.nav-links>a:hover, .nav-menu summary:hover {
background: var(--selection);
}
.nav-menu {
position: relative;
}
.nav-menu summary {
list-style: none;
}
.nav-menu summary::after {
content: "⌄";
margin-left: 9px;
}
.nav-menu summary::-webkit-details-marker {
display: none;
}
.nav-menu-panel {
position: absolute;
right: 0;
top: 100%;
z-index: 5;
min-width: 280px;
background: var(--surface);
border: 1px solid var(--line);
box-shadow: var(--shadow);
padding: 5px;
}
.nav-menu-panel a {
display: block;
padding: 10px 12px;
text-decoration: none;
}
.nav-menu-panel a:hover {
background: var(--selection);
}
.nav-menu-panel span {
display: block;
font-size: 12px;
color: var(--muted);
}
.site-main {
min-height: 0;
}
h1, h2, h3, p {
margin-top: 0;
}
h1 {
font-size: clamp(30px,3.9vw,46px);
line-height: 1.16;
letter-spacing: -1.5px;
font-weight: 650;
margin-bottom: 20px;
}
h2 {
font-size: 20px;
line-height: 1.3;
letter-spacing: 0;
margin-bottom: 12px;
}
h3 {
font-size: 16px;
line-height: 1.4;
}
p {
color: var(--text);
font-size: 14px;
line-height: 1.7;
margin-bottom: 15px;
}
.site-footer {
padding: 17px 0;
background: var(--surface);
border-top: 1px solid var(--line);
}
.footer-grid {
display: flex;
align-items: start;
justify-content: space-between;
gap: 20px;
}
.footer-copy {
font-size: 11px;
max-width: 62ch;
margin: 0;
color: var(--muted);
}
.footer-links {
display: flex;
flex-wrap: wrap;
gap: 5px 14px;
max-width: 400px;
font-size: 11px;
}
@media (max-width:1000px) {
.navigation {
padding: 0 15px;
}
.nav-links>a, .nav-menu summary {
padding: 8px 10px;
}
}
@media (max-width:650px) {
.topbar {
padding: 13px 16px;
gap: 8px;
}
.brand strong {
font-size: 20px;
}
.brand small {
font-size: 10px;
}
.brand img {
width: 28px;
height: 31px;
}
.appearance {
gap: 5px;
}
.appearance>span {
display: none;
}
.appearance select {
font-size: 12px;
max-width: 98px;
}
.navigation {
padding: 0 6px;
}
.nav-links {
gap: 0;
}
.nav-links>a, .nav-menu summary {
min-height: 44px;
padding: 8px;
font-size: 12px;
}
h1 {
font-size: 34px;
letter-spacing: -1px;
}
.footer-grid {
display: grid;
gap: 20px;
}
.site-footer {
padding: 20px 17px;
}
.nav-menu-panel {
position: fixed;
right: 10px;
left: 10px;
top: auto;
min-width: 0;
}
}
@media (prefers-reduced-motion:reduce) {
* {
scroll-behavior: auto!important;
}
}
.appearance select {
font-size: 12px;
padding: 3px 7px;
}
.nav-links>a:hover {
background: var(--selection);
color: var(--link);
}
h1 {
font-size: 28px;
font-weight: 600;
letter-spacing: -.5px;
line-height: 1.3;
margin: 0 0 16px;
max-width: none;
}
@media (max-width:1100px) {
.navigation {
padding: 0;
}
}
@media (max-width:800px) {
.nav-links>a, .nav-menu summary {
padding: 6px 10px;
}
}
@media (max-width:600px) {
.topbar {
padding: 0 0 14px;
}
.brand strong {
font-size: 25px;
}
.brand img {
width: 32px;
height: 36px;
}
.nav-links>a, .nav-menu summary {
padding: 7px 9px;
min-height: 38px;
font-size: 12px;
}
.footer-grid {
display: block;
}
.footer-links {
margin-top: 10px;
max-width: none;
}
.site-footer {
padding: 14px 0;
}
h1 {
font-size: 26px;
}
}
@media (prefers-color-scheme: dark) {
:root:not([data-theme]) {
color-scheme: dark;
--bg: #111416;
--surface: #191c1f;
--chrome: #25292d;
--chrome2: #30353a;
--text: #eef0f2;
--muted: #b2bbc4;
--line: #50575e;
--soft-line: #353c43;
--blue: #2865a8;
--link: #8dc0ff;
--selection: #233951;
--success: #92d5ab;
--code: #111518;
--shadow: none;
}
}
.site-header, .site-main, .site-footer {
width: min(1040px, calc(100% - 48px));
margin-inline: auto;
}
.site-header {
margin-top: 32px;
}
.site-main {
padding-block: 28px 20px;
}
.site-header .topbar {
padding: 0 0 16px;
}
.site-header .navigation {
padding: 0;
}
@media (max-width: 600px) {
.site-header, .site-main, .site-footer {
width: calc(100% - 30px);
}
.site-header {
margin-top: 18px;
}
.site-main {
padding-top: 23px;
}
}
/* Match the browser's heading defaults used by the main site. */
h2, h3 { font-weight: bold; }
h2 { margin-top: .83em; }
h3 { margin-block: 1em; }
+44
View File
@@ -0,0 +1,44 @@
/* SPDX-License-Identifier: GPL-2.0-or-later */
(() => {
'use strict';
const initialise = () => {
const picker = document.getElementById('theme-picker');
const preference = window.matchMedia('(prefers-color-scheme: dark)');
if (picker instanceof HTMLSelectElement) {
const applyTheme = () => {
const dark = picker.value === 'dark'
|| (picker.value === 'system' && preference.matches);
document.documentElement.dataset.theme = dark ? 'dark' : 'light';
document.querySelectorAll('meta[name="theme-color"]').forEach((meta) => {
meta.setAttribute('content', dark ? '#111416' : '#ffffff');
});
};
// Follow the OS on every visit, including browser back/forward navigation.
const resetTheme = () => {
picker.value = 'system';
applyTheme();
};
picker.addEventListener('change', applyTheme);
preference.addEventListener('change', applyTheme);
window.addEventListener('pageshow', resetTheme);
resetTheme();
}
const navigation = document.getElementById('docs-navigation');
const compact = window.matchMedia('(max-width: 760px)');
if (navigation instanceof HTMLDetailsElement) {
const fitNavigation = () => { navigation.open = !compact.matches; };
compact.addEventListener('change', fitNavigation);
fitNavigation();
}
};
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', initialise, { once: true });
} else {
initialise();
}
})();
+5
View File
@@ -0,0 +1,5 @@
{# SPDX-License-Identifier: GPL-2.0-or-later #}
<nav class="global-toc" aria-label="{{ _('Documentation contents') }}">
<h2>{{ _('Contents') }}</h2>
{{ toctree(maxdepth=2, collapse=true, includehidden=true, titles_only=true) }}
</nav>
+108
View File
@@ -0,0 +1,108 @@
{# SPDX-License-Identifier: GPL-2.0-or-later #}
{% extends "basic/layout.html" %}
{% set docs_root = root_doc|default(master_doc) %}
{% block extrahead %}
{{ super() }}
<meta name="theme-color" content="#ffffff" media="(prefers-color-scheme: light)">
<meta name="theme-color" content="#111416" media="(prefers-color-scheme: dark)">
{% endblock %}
{% block body_tag %}<body id="top">{% endblock %}
{% block header %}
<a class="skip-link" href="#main-content">{{ _('Skip to content') }}</a>
<header class="site-header">
<div class="topbar">
<a class="brand" href="{{ pathto(docs_root)|e }}">
<img src="{{ logo_url|default(pathto('_static/zoitechat-logo.svg', 1), true)|e }}" alt="" width="38" height="42">
<strong>{{ project|e }}</strong>
</a>
<label class="appearance" for="theme-picker">
<span>{{ _('Appearance') }}</span>
<select id="theme-picker" aria-label="{{ _('Documentation appearance') }}">
<option value="system" selected>{{ _('System') }}</option>
<option value="light">{{ _('Light') }}</option>
<option value="dark">{{ _('Dark') }}</option>
</select>
</label>
</div>
<div class="navigation">
<nav class="nav-links" aria-label="{{ _('Primary') }}">
<a href="{{ zoite_site_url|e }}">{{ _('Home') }}</a>
<a href="{{ zoite_download_url|e }}">{{ _('Downloads') }}</a>
<a href="{{ zoite_addons_url|e }}">{{ _('Addons') }}</a>
<a href="{{ zoite_announcements_url|e }}">{{ _('Announcements') }}</a>
<a href="{{ pathto(docs_root)|e }}" aria-current="page">{{ _('Documentation') }}</a>
<a href="{{ zoite_atlas_url|e }}">{{ _('Atlas') }}</a>
<a href="{{ zoite_github_url|e }}" target="_blank" rel="noopener">{{ _('GitHub') }}</a>
<details class="nav-menu">
<summary>{{ _('IRC support') }}</summary>
<div class="nav-menu-panel" aria-label="{{ _('IRC support channels') }}">
<a href="{{ zoite_irc_url|e }}" target="_blank" rel="noopener"><strong>{{ _('Zoite IRC') }}</strong><span>{{ _('Official support') }} · #zoitechat</span></a>
<a href="{{ libera_irc_url|e }}" target="_blank" rel="noopener"><strong>{{ _('Libera.Chat') }}</strong><span>{{ _('Secondary support') }} · #zoitechat</span></a>
</div>
</details>
</nav>
</div>
</header>
{% endblock %}
{% block relbar1 %}{% endblock %}
{% block relbar2 %}{% endblock %}
{% block content %}
<div class="docs-layout{% if not render_sidebar %} no-sidebar{% endif %}">
{% if render_sidebar %}
<aside class="docs-sidebar" aria-label="{{ _('Documentation navigation') }}">
<details class="docs-navigation" id="docs-navigation" open>
<summary>{{ _('Documentation') }}</summary>
<div class="sidebar-content">
{% for sidebartemplate in sidebars %}
{% include sidebartemplate %}
{% endfor %}
</div>
</details>
</aside>
{% endif %}
<main class="docs-content" id="main-content" tabindex="-1">
<div class="docs-location">
<nav aria-label="{{ _('Breadcrumbs') }}">
<a href="{{ pathto(docs_root)|e }}">{{ _('Documentation') }}</a>
{% for parent in parents %}
<span aria-hidden="true">/</span> <a href="{{ parent.link|e }}">{{ parent.title }}</a>
{% endfor %}
{% if pagename != docs_root %}<span aria-hidden="true">/</span> <span>{{ title|striptags|e }}</span>{% endif %}
</nav>
<span class="docs-version">{{ release|e }}</span>
</div>
{% block body %}{% endblock %}
{% if prev or next %}
<nav class="page-relations" aria-label="{{ _('Related pages') }}">
<div>
{% if prev %}<small>{{ _('Previous') }}</small><a href="{{ prev.link|e }}" rel="prev">{{ prev.title }}</a>{% endif %}
</div>
<div>
{% if next %}<small>{{ _('Next') }}</small><a href="{{ next.link|e }}" rel="next">{{ next.title }}</a>{% endif %}
</div>
</nav>
{% endif %}
</main>
</div>
{% endblock %}
{% block footer %}
<footer class="site-footer">
<div class="footer-grid">
<p class="footer-copy">{{ project|e }} {{ _('documentation') }} · {{ release|e }}</p>
<nav class="footer-links" aria-label="{{ _('Footer navigation') }}">
<a href="{{ pathto(docs_root)|e }}">{{ _('Contents') }}</a>
<a href="{{ zoite_atlas_url|e }}">{{ _('Atlas') }}</a>
{% if hasdoc('search') %}<a href="{{ pathto('search')|e }}">{{ _('Search') }}</a>{% endif %}
{% if hasdoc('genindex') %}<a href="{{ pathto('genindex')|e }}">{{ _('Index') }}</a>{% endif %}
<a href="#top">{{ _('Back to top') }}</a>
</nav>
</div>
</footer>
{% endblock %}
+7
View File
@@ -0,0 +1,7 @@
{# SPDX-License-Identifier: GPL-2.0-or-later #}
{% if display_toc %}
<nav class="local-toc" aria-label="{{ _('On this page') }}">
<h2>{{ _('On this page') }}</h2>
{{ toc }}
</nav>
{% endif %}
+10
View File
@@ -0,0 +1,10 @@
{# SPDX-License-Identifier: GPL-2.0-or-later #}
{% if pagename != "search" %}
<form class="docs-search" action="{{ pathto('search')|e }}" method="get" role="search">
<label for="docs-search-input">{{ _('Search documentation') }}</label>
<div class="search-inputs">
<input id="docs-search-input" type="search" name="q" placeholder="{{ _('Search documentation') }}" autocomplete="off" spellcheck="false">
<button type="submit">{{ _('Search') }}</button>
</div>
</form>
{% endif %}
+7
View File
@@ -0,0 +1,7 @@
[theme]
inherit = basic
stylesheet = basic.css
pygments_style = sphinx
sidebars = searchbox.html, globaltoc.html, localtoc.html, sourcelink.html
[options]
+8 -4
View File
@@ -99,7 +99,7 @@ trim_footnote_reference_space = True
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'basicstrap' html_theme = 'zoitechat'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
@@ -127,13 +127,16 @@ html_context = {
'zoite_site_url': 'https://zoitechat.org/', 'zoite_site_url': 'https://zoitechat.org/',
'zoite_download_url': 'https://zoitechat.org/download.php', 'zoite_download_url': 'https://zoitechat.org/download.php',
'zoite_addons_url': 'https://zoitechat.org/addons.php', 'zoite_addons_url': 'https://zoitechat.org/addons.php',
'zoite_announcements_url': 'https://zoitechat.org/announcements.php',
'zoite_github_url': 'https://github.com/ZoiteChat/zoitechat',
'zoite_atlas_url': 'https://atlas.zoitechat.org/',
'zoite_irc_url': 'https://zoite.net/webchat/?join=%23zoitechat', 'zoite_irc_url': 'https://zoite.net/webchat/?join=%23zoitechat',
'libera_irc_url': 'https://web.libera.chat/#zoitechat', 'libera_irc_url': 'https://web.libera.chat/#zoitechat',
} }
# The name of an image file (relative to this directory) to place at the top # The name of an image file (relative to this directory) to place at the top
# of the sidebar. # of the sidebar.
html_logo = 'zoitechat-logo.svg' html_logo = '_static/zoitechat-logo.svg'
# The name of an image file (within the static path) to use as favicon of the # The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -145,8 +148,9 @@ html_favicon = '_static/favicon.ico'
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# Main-site visual skin for Read the Docs/Sphinx HTML output. # Local, readable assets shared by hosted and offline HTML documentation.
html_css_files = ['css/zoitechat-docs.css'] html_css_files = ['css/zoitechat-docs.css', 'css/zoitechat-site.css']
html_js_files = ['js/zoitechat-docs.js']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
-30
View File
@@ -1,30 +0,0 @@
# Optional Python asyncio integration
`run_async(coroutine, context=None, interval=10)` returns an AsyncTask with
`done()`, `cancel()` and `result()`. Each invocation owns a separate event loop
pumped by an existing main-loop timer. A ready stop callback ensures selector
polling never blocks the UI. The captured context is restored after every pump;
a closed context cancels the work. No process-wide event-loop policy is changed.
Existing synchronous scripts are unaffected. Use `asyncio.get_running_loop()`
inside the coroutine. Child tasks use the same loop/context and are cancelled
when the main coroutine finishes or the script unloads. Cancellation cleanup is
bounded; tasks must not suppress cancellation indefinitely. Cleanup uses the
captured context while it remains open; after it closes, cancellation cleanup uses
the current valid context. Use explicit Context methods for context-specific
output in finally blocks, and do not issue context-dependent commands there. This provides normal
asyncio sockets/timers, not Windows subprocess support or a new HTTP library.
Asyncio hostname resolution can use its executor; use a resolver appropriate to
your library if you require no worker threads. Blocking work inside a coroutine
still blocks the client and must be avoided.
```python
import asyncio
import zoitechat
async def later():
await asyncio.sleep(1)
zoitechat.prnt('Still in the context where this task was started')
task = zoitechat.run_async(later())
```
-35
View File
@@ -1,35 +0,0 @@
# Script-supported capabilities
`register_capability(name, userdata=None, connection_id=None)` returns a normal
hook handle. Register before connecting/reconnecting. Core requests the name only
if advertised in CAP LS or CAP NEW. Existing built-in requests remain enabled;
SASL and STS registration is rejected so scripts cannot change authentication or
transport policy through this API. None/-1 means any connection (zero is a valid
connection ID). Names are lowercase ASCII alphanumerics plus - . / _, 1-200 bytes.
Duplicate registrations do not duplicate requests for an advertised token.
`unhook(handle)` or script/plugin unload removes future request ownership. It
intentionally does not disable a capability already acknowledged on a live
connection, because another plugin/core may depend on it. Registering after CAP
LS does not retrospectively negotiate an already-advertised capability: reconnect
or wait for CAP NEW. Core retains ownership of CAP END; this API does not extend
SASL waiting or delay registration awaiting plugin-only CAP ACKs.
`hook_capability(name, callback, userdata=None, priority=PRI_NORM)` independently
observes negotiation through existing raw CAP hooks. Callback receives
`(CapabilityEvent, userdata)` with name, subcommand, value, enabled, context and
connection_id. LS/NEW mean advertised (`enabled=None`), ACK/LIST mean enabled
(unless a negative ACK), NAK means rejected and DEL means removed. Callback
returns are ignored so this observer cannot eat core negotiation. Existing raw
hooks may still eat CAP before this hook according to their normal priorities.
C: `zoitechat_register_capability(ph, name, flags, connection_id, userdata)`;
flags=0, ID=-1 for any. Check get_info("api_plugin_caps") for "1" before using
the appended Windows slot. Use existing server CAP hooks for notifications.
Requests are split at complete token boundaries within the existing wire limit.
```python
registration = zoitechat.register_capability('draft/example')
zoitechat.hook_capability('draft/example', lambda event, data:
event.context.prnt('{}: {}'.format(event.subcommand, event.enabled)))
```
@@ -1,24 +0,0 @@
# Optional plugin API additions (discussion #144)
Existing hooks, callbacks, return values, context lookup, strings and menu behaviour
remain unchanged. The C plugin function table gains four fixed append-only slots;
unused slots are NULL. Older binaries use the unchanged prefix. A plugin must check
the documented get_info() feature key before accessing a new slot on an older host.
New Python modules are installed by Meson and the existing Windows copy/installer
pipeline. Only modules present in the installation are exported; imports of
zoitechat, hexchat and xchat retain their compatibility aliases.
All APIs run on the client main thread unless explicitly documented otherwise.
New reserved flags must be zero. These changes do not make old API calls thread-safe.
Nested hook dispatch defers deleted-hook reclamation until its outermost return,
so new observers can safely emit events and unhook themselves or other hooks.
The optional asyncio module requires Python 3.7 or newer; older supported
interpreters skip that module and retain the existing scripting API.
Python reload drops the script/API modules while retaining the embedding module
so callback and lib.ph pointer types keep the same CFFI identity.
Server-hook insertion matches both raw and attrs hooks so documented priorities
are honoured for mixed registrations, including new filtered attrs callbacks.
-24
View File
@@ -1,24 +0,0 @@
# Connection and context navigation
`get_connections()` returns one Connection snapshot per live connection:
`id`, `network`, `server`, `context`. Connection IDs distinguish simultaneous
connections with identical names. Prefer its server-tab context where present.
`get_connection(context=None)` finds the owner of a live context.
`get_contexts(connection_id=None, types=None)` lists live contexts, optionally
filtered by connection ID (or a Connection object) and session types: server=1,
channel=2, query=3. `connection.contexts(types=None)` is a convenience method.
`find_context_by_id(connection_id, channel=None)` / `connection.find(channel)`
resolve using that connection's IRC comparator; no channel selects the server tab.
Missing/closed contexts return None. Existing find_context() remains unchanged.
These helpers use the existing channels list's ID/context fields, so no new C
context ABI is needed. Snapshots are not persistent IDs across client restarts;
refresh them after closing/recreating connections. Always check Context.set()
when explicitly selecting a context that might have closed.
```python
connection = zoitechat.get_connection()
for context in connection.contexts(types=(2,)):
context.prnt('A channel on this exact connection')
```
-26
View File
@@ -1,26 +0,0 @@
# Semantic IRC hooks
`on_join`, `on_part`, `on_quit`, `on_nick`, `on_kick`, `on_message`, and
`on_notice` accept `(callback, userdata=None, priority=PRI_NORM)`. The general
form is `hook_event(command, callback, userdata=None, priority=PRI_NORM)`.
Callbacks receive `(event, userdata)`, where the immutable IRCEvent has
command, prefix, nick, user, host, params, context, connection_id and time.
`params` preserves the trailing parameter, including spaces; JOIN parameters
also retain extended-join account/realname data when supplied by the server.
These wrappers use existing server hooks, before core command processing;
return the ordinary EAT_* constants. EAT_ZOITECHAT suppresses the entire IRC
command (including client state updates), not just its text. Use EAT_NONE for
observation. Other plugins' priority and eating rules remain unchanged.
The context is the core-selected context, which can be the server tab when a
query/channel does not yet exist. QUIT is one event per incoming command,
not one callback per affected channel. `event.time` is the existing server-time
attribute (zero when unavailable); other message tags are not exposed here.
```python
def joined(event, userdata):
event.context.prnt('{} joined {}'.format(event.nick, event.params[0]))
return zoitechat.EAT_NONE
zoitechat.on_join(joined)
```
-19
View File
@@ -1,19 +0,0 @@
# Python descriptor hooks
`hook_fd(fd, callback, userdata=None, flags=FD_READ)` returns an ordinary hook
handle accepted by `unhook()`. Callback arguments are `(fd, ready_flags, userdata)`;
return True to retain the watch and False/None to remove it. Exceptions print a
traceback and remove the watch. Unloading the script removes its watches.
The callback runs in the context captured during registration, and that context
is restored afterwards. A closed context removes the watch.
Use nonblocking IO and bounded reads/writes. The descriptor belongs to the script;
unhook before closing it. On Windows socket descriptors use the default flags;
CRT descriptors need FD_NOTSOCKET. The existing C API uses int descriptors: values
outside its range are rejected rather than truncated. This does not add threads.
Example:
```python
watch = zoitechat.hook_fd(sock.fileno(), on_readable, flags=zoitechat.FD_READ)
# def on_readable(fd, flags, userdata): ...; return True
```
-24
View File
@@ -1,24 +0,0 @@
# Core-filtered hooks
Python: `hook_server_filtered(name, callback, userdata=None, priority=PRI_NORM,
connection_id=None, channel=None)` and `hook_print_filtered(...)`.
Callbacks match the existing attrs variants: `(word, word_eol, userdata, attrs)`.
The connection ID distinguishes duplicate names; None/-1 means any connection
(including connection ID zero). A channel restriction uses that connection's
IRC comparator. None means any context; an empty string is an exact restriction.
C: the corresponding zoitechat_hook_*_filtered functions accept
`(ph, name, pri, flags, connection_id, channel, callback, userdata)`;
flags=0, ID=-1 for any and NULL channel for any. Check
`get_info("api_context_filters")` for "1" before accessing the new Windows slots.
Filtering takes place before Python/interpreter entry. Existing unrestricted
hooks, priority, EAT semantics and unload/unhook handling are unchanged.
Filters refer to the core-selected context, not an IRC target parsed from the
line: unknown queries/channels can still have a server-tab context, and QUIT
has its usual single server-hook context. Connection IDs last only this process.
```python
zoitechat.hook_print_filtered('Channel Message', callback,
connection_id=zoitechat.get_prefs('id'), channel='#zoitechat')
```
-21
View File
@@ -1,21 +0,0 @@
# Explicit IRC comparison keys
`IRCName(text, context=None, casemapping=None, connection_id=None)` is an
immutable helper, not a str subclass. Construct it explicitly for dictionary/set
keys; existing get_info/list/event values remain normal strings.
Equality and hashing include the connection ID and captured casemapping, so
identical-looking names on different connections are different keys. An IRCName
never compares equal to a plain str. `str(key)` / `key.text` recover the spelling.
`irc_casefold(text, casemapping='rfc1459')` supports ascii, strict-rfc1459 and
rfc1459. Only ASCII IRC characters fold; Unicode casefold would be incorrect.
The new `get_info('casemapping')` reports the comparator actually used by core.
Current master handles ASCII and RFC1459; this patch does not change its handling
of advertised strict-rfc1459. An explicit mapping is available for scripts that
need strict-rfc1459 independently. Keys capture their mapping so hashes stay
stable; rebuild a collection if the connection's mapping changes.
```python
seen = {zoitechat.IRCName('[SomeNick]')}
assert zoitechat.IRCName('{somenick}') in seen # RFC1459 connection
```
-21
View File
@@ -1,21 +0,0 @@
# Post-display print observers
Python: `hook_print_after(name, callback, userdata=None, priority=PRI_NORM)`.
The callback is `(word, word_eol, userdata, attrs)`, matching hook_print_attrs().
It runs after display_event() has handled the text, so prnt() follows the original
text. Return values are ignored. Events eaten by a pre-hook or hidden by client
preferences do not invoke these observers. This is post-display notification,
not a notification that the entire incoming IRC command has finished updating state.
C: `zoitechat_hook_print_after(ph, name, priority, flags, callback, userdata)`;
flags must be zero. Check `get_info("api_hook_print_after")` for "1" before
accessing the appended Windows function-table slot. Existing pre-hook timing is
unchanged. Unhook/unload use existing lifecycle functions. Recursive emission
skips an already-running observer to prevent it immediately invoking itself.
```python
def after(word, word_eol, userdata, attrs):
zoitechat.prnt('This follows the original channel message')
zoitechat.hook_print_after('Channel Message', after)
```
-21
View File
@@ -383,24 +383,3 @@ def find_context(server=None, channel=None):
return None return None
return Context(ctx) return Context(ctx)
# Optional additive APIs live in separate modules so builds can select features.
def __load_additive_features():
import importlib
import os
for suffix in ('fd', 'events', 'async', 'names', 'contexts',
'post', 'filters', 'caps'):
if suffix == 'async' and sys.version_info < (3, 7):
continue
name = '_zoitechat_' + suffix
if not os.path.isfile(os.path.join(os.path.dirname(__file__), name + '.py')):
continue
module = importlib.import_module(name)
for symbol in module.__all__:
globals()[symbol] = getattr(module, symbol)
__all__.append(symbol)
__load_additive_features()
-100
View File
@@ -1,100 +0,0 @@
"""Opt-in asyncio tasks pumped without blocking the client main loop."""
import asyncio
import operator
import traceback
import _zoitechat as api
__all__ = ['AsyncTask', 'run_async']
class AsyncTask:
"""A script-owned task and isolated event loop; cancel() is cooperative."""
def __init__(self, coroutine, plugin, context, interval):
self._plugin = plugin
self._context = context
self._loop = asyncio.new_event_loop()
self._task = self._loop.create_task(coroutine)
self._closed = False
self._unload_hook = api.hook_unload(lambda data: self._close())
self._timer_hook = api.hook_timer(interval, self._tick)
def done(self):
return self._task.done()
def cancel(self):
if not self._closed:
return self._task.cancel()
return False
def result(self):
return self._task.result()
def _pump(self):
# A ready stop callback forces the selector's timeout to zero.
self._loop.call_soon(self._loop.stop)
self._loop.run_forever()
def _close(self):
if self._closed:
return
self._closed = True
previous = api.get_context()
self._context.set()
try:
pending = asyncio.all_tasks(self._loop)
for task in pending:
task.cancel()
# Bound cleanup work; tasks must cooperate with cancellation.
for unused in range(3):
if not any(not task.done() for task in pending):
break
self._pump()
for task in pending:
if not task.done():
self._loop.call_exception_handler({
'message': 'Script task ignored cancellation during unload',
'task': task,
})
finally:
self._loop.close()
previous.set()
def _tick(self, userdata):
if self._closed:
return False
previous = api.get_context()
if not self._context.set():
self._close()
self._plugin.remove_hook(self._unload_hook)
return False
try:
self._pump()
if not self._task.done():
return True
try:
self._task.result()
except asyncio.CancelledError:
pass
except Exception:
traceback.print_exc()
self._close()
self._plugin.remove_hook(self._unload_hook)
return False
except Exception:
traceback.print_exc()
self._close()
self._plugin.remove_hook(self._unload_hook)
return False
finally:
previous.set()
def run_async(coroutine, context=None, interval=10):
"""Schedule a coroutine in a captured context; return an AsyncTask handle."""
interval = operator.index(interval)
if interval < 1 or interval > 2147483647:
raise ValueError('interval must be a positive C int in milliseconds')
if not asyncio.iscoroutine(coroutine):
raise TypeError('run_async expects a coroutine object')
plugin = api.__get_current_plugin()
return AsyncTask(coroutine, plugin, context or api.get_context(), interval)
-64
View File
@@ -1,64 +0,0 @@
"""Script-owned capability requests and structured negotiation observations."""
from collections import namedtuple
import operator
import _zoitechat as api
from _zoitechat_embedded import ffi, lib
__all__ = ['CapabilityEvent', 'register_capability', 'hook_capability']
CapabilityEvent = namedtuple('CapabilityEvent',
'name subcommand value enabled context connection_id')
def register_capability(name, userdata=None, connection_id=None):
"""Request an advertised capability on next negotiation; unhook releases ownership."""
connection_id = -1 if connection_id is None else operator.index(connection_id)
if connection_id < -1 or connection_id > 2147483647:
raise ValueError('connection_id must fit the C API; -1 means any')
plugin = api.__get_current_plugin()
hook = plugin.add_hook(None, userdata)
handle = lib.zoitechat_register_capability(lib.ph, name.encode(), 0,
connection_id, hook.handle)
if handle == ffi.NULL:
hook.is_unload = True
plugin.remove_hook(id(hook))
raise ValueError('invalid capability name, reserved capability or connection ID')
hook.zoitechat_hook = handle
return id(hook)
def hook_capability(name, callback, userdata=None, priority=api.PRI_NORM):
"""Observe LS/NEW/ACK/NAK/DEL/LIST; this hook does not itself request the capability."""
if not callable(callback):
raise TypeError('callback must be callable')
def dispatch(word, word_eol, data):
if not word_eol:
return api.EAT_NONE
line = word_eol[0]
if line.startswith(':'):
unused, separator, line = line.partition(' ')
parts = line.split(' ', 3)
if len(parts) != 4 or parts[0].upper() != 'CAP':
return api.EAT_NONE
subcommand, tokens = parts[2].upper(), parts[3]
if subcommand not in ('LS', 'NEW', 'ACK', 'NAK', 'DEL', 'LIST'):
return api.EAT_NONE
if tokens.startswith('* '):
tokens = tokens[2:]
tokens = tokens.lstrip(':')
for token in tokens.split():
negative = token.startswith('-')
cap, equals, value = token.lstrip('-').partition('=')
if cap != name:
continue
enabled = None
if subcommand in ('ACK', 'LIST'):
enabled = not negative
elif subcommand in ('DEL', 'NAK'):
enabled = False
event = CapabilityEvent(cap, subcommand, value if equals else None,
enabled, api.get_context(), api.get_prefs('id'))
callback(event, data)
return api.EAT_NONE # observing CAP must not suppress core negotiation
return api.hook_server('CAP', dispatch, userdata, priority)
-75
View File
@@ -1,75 +0,0 @@
"""Navigate live connections by ID instead of ambiguous server/network names."""
from collections import namedtuple
import operator
import _zoitechat as api
__all__ = ['Connection', 'get_connections', 'get_connection', 'get_contexts',
'find_context_by_id']
class Connection(namedtuple('_Connection', 'id network server context')):
__slots__ = ()
def contexts(self, types=None):
return get_contexts(self.id, types)
def find(self, channel=None):
return find_context_by_id(self.id, channel)
def _id(connection):
return operator.index(connection.id if isinstance(connection, Connection) else connection)
def get_connections():
"""Return one snapshot per live connection, including disconnected ones."""
entries = api.get_list('channels')
by_id = {}
order = []
for entry in entries:
if entry.id not in by_id:
order.append(entry.id)
if entry.id not in by_id or entry.type == 1:
by_id[entry.id] = Connection(entry.id, entry.network, entry.server,
entry.context)
return [by_id[connection_id] for connection_id in order]
def get_connection(context=None):
"""Find the owning connection of a Context; return None when it has closed."""
context = context or api.get_context()
for entry in api.get_list('channels'):
if entry.context == context:
for connection in get_connections():
if connection.id == entry.id:
return connection
return None
def get_contexts(connection_id=None, types=None):
"""Return contexts, optionally restricted to a connection and session types."""
if connection_id is not None:
connection_id = _id(connection_id)
if types is not None:
types = frozenset(types)
return [entry.context for entry in api.get_list('channels')
if (connection_id is None or entry.id == connection_id)
and (types is None or entry.type in types)]
def find_context_by_id(connection_id, channel=None):
"""Resolve a live context on exactly one connection; None selects its server tab."""
connection_id = _id(connection_id)
previous = api.get_context()
try:
for entry in api.get_list('channels'):
if entry.id != connection_id:
continue
if channel is None:
if entry.type == 1:
return entry.context
elif entry.context.set() and api.nickcmp(entry.channel, channel) == 0:
return entry.context
finally:
previous.set()
return None
-77
View File
@@ -1,77 +0,0 @@
"""Structured, opt-in hooks before the IRC command's core processing."""
from collections import namedtuple
import _zoitechat as api
__all__ = ['IRCEvent', 'hook_event', 'on_join', 'on_part', 'on_quit',
'on_nick', 'on_kick', 'on_message', 'on_notice']
IRCEvent = namedtuple('IRCEvent', 'command prefix nick user host params context connection_id time')
_SUPPORTED = frozenset(('JOIN', 'PART', 'QUIT', 'NICK', 'KICK', 'PRIVMSG', 'NOTICE'))
def _parse(line):
prefix = ''
if line.startswith(':'):
prefix, separator, line = line[1:].partition(' ')
if not separator:
return None
command, separator, rest = line.partition(' ')
params = []
while rest:
rest = rest.lstrip(' ')
if rest.startswith(':'):
params.append(rest[1:])
break
param, separator, rest = rest.partition(' ')
if param:
params.append(param)
nick, marker, userhost = prefix.partition('!')
user, marker, host = userhost.partition('@')
return command.upper(), prefix, nick, user, host, tuple(params)
def hook_event(command, callback, userdata=None, priority=api.PRI_NORM):
"""callback(event, userdata) returns existing EAT_* constants."""
command = command.upper()
if command not in _SUPPORTED:
raise ValueError('unsupported semantic event: ' + command)
if not callable(callback):
raise TypeError('callback must be callable')
def dispatch(word, word_eol, data, attrs):
if not word_eol:
return api.EAT_NONE
parsed = _parse(word_eol[0])
if parsed is None or parsed[0] != command:
return api.EAT_NONE
event = IRCEvent(*(parsed + (api.get_context(), api.get_prefs('id'), attrs.time)))
return callback(event, data)
return api.hook_server_attrs(command, dispatch, userdata, priority)
def on_join(callback, userdata=None, priority=api.PRI_NORM):
return hook_event('JOIN', callback, userdata, priority)
def on_part(callback, userdata=None, priority=api.PRI_NORM):
return hook_event('PART', callback, userdata, priority)
def on_quit(callback, userdata=None, priority=api.PRI_NORM):
return hook_event('QUIT', callback, userdata, priority)
def on_nick(callback, userdata=None, priority=api.PRI_NORM):
return hook_event('NICK', callback, userdata, priority)
def on_kick(callback, userdata=None, priority=api.PRI_NORM):
return hook_event('KICK', callback, userdata, priority)
def on_message(callback, userdata=None, priority=api.PRI_NORM):
return hook_event('PRIVMSG', callback, userdata, priority)
def on_notice(callback, userdata=None, priority=api.PRI_NORM):
return hook_event('NOTICE', callback, userdata, priority)
-39
View File
@@ -1,39 +0,0 @@
"""File descriptor readiness hooks; callbacks execute on the main thread."""
import operator
import _zoitechat as api
from _zoitechat_embedded import ffi, lib
__all__ = ['FD_READ', 'FD_WRITE', 'FD_EXCEPTION', 'FD_NOTSOCKET', 'hook_fd']
FD_READ, FD_WRITE, FD_EXCEPTION, FD_NOTSOCKET = 1, 2, 4, 8
def hook_fd(fd, callback, userdata=None, flags=FD_READ):
"""callback(fd, ready_flags, userdata): True keeps the watch, False removes it."""
fd = operator.index(fd)
flags = operator.index(flags)
if fd < 0 or fd > 2147483647:
raise ValueError('fd must fit the C API nonnegative int descriptor')
if flags & ~15 or not flags & 7:
raise ValueError('flags must select READ, WRITE or EXCEPTION')
if not callable(callback):
raise TypeError('callback must be callable')
plugin = api.__get_current_plugin()
context = api.get_context()
def dispatch(descriptor, ready, data):
previous = api.get_context()
if not context.set():
return False
try:
return callback(descriptor, ready, data)
finally:
previous.set()
hook = plugin.add_hook(dispatch, userdata)
handle = lib.zoitechat_hook_fd(lib.ph, fd, flags, lib._on_fd_hook, hook.handle)
if handle == ffi.NULL:
hook.is_unload = True
plugin.remove_hook(id(hook))
raise RuntimeError('unable to watch descriptor')
hook.zoitechat_hook = handle
return id(hook)
-36
View File
@@ -1,36 +0,0 @@
"""Context restrictions evaluated by core before entering Python."""
import operator
import _zoitechat as api
from _zoitechat_embedded import ffi, lib
__all__ = ['hook_server_filtered', 'hook_print_filtered']
def _register(name, callback, userdata, priority, connection_id, channel, server):
if not callable(callback):
raise TypeError('callback must be callable')
connection_id = -1 if connection_id is None else operator.index(connection_id)
if connection_id < -1 or connection_id > 2147483647:
raise ValueError('connection_id must fit the C API; -1 means any')
plugin = api.__get_current_plugin()
hook = plugin.add_hook(callback, userdata)
register = lib.zoitechat_hook_server_filtered if server else lib.zoitechat_hook_print_filtered
dispatch = lib._on_server_attrs_hook if server else lib._on_print_attrs_hook
handle = register(lib.ph, name.encode(), priority, 0, connection_id,
ffi.NULL if channel is None else channel.encode(), dispatch, hook.handle)
if handle == ffi.NULL:
hook.is_unload = True
plugin.remove_hook(id(hook))
raise RuntimeError('unable to install filtered hook')
hook.zoitechat_hook = handle
return id(hook)
def hook_server_filtered(name, callback, userdata=None, priority=api.PRI_NORM,
connection_id=None, channel=None):
return _register(name, callback, userdata, priority, connection_id, channel, True)
def hook_print_filtered(name, callback, userdata=None, priority=api.PRI_NORM,
connection_id=None, channel=None):
return _register(name, callback, userdata, priority, connection_id, channel, False)
-74
View File
@@ -1,74 +0,0 @@
"""Explicit immutable IRC names; existing string-returning APIs are unchanged."""
import _zoitechat as api
__all__ = ['IRCName', 'irc_casefold']
def irc_casefold(text, casemapping='rfc1459'):
"""Fold ASCII IRC characters only; never apply Unicode lower()/casefold()."""
if casemapping not in ('ascii', 'strict-rfc1459', 'rfc1459'):
raise ValueError('unsupported IRC casemapping')
extra = {'[': '{', ']': '}', '\\': '|'} if casemapping != 'ascii' else {}
if casemapping == 'rfc1459':
extra['^'] = '~'
return ''.join(chr(ord(c) + 32) if 'A' <= c <= 'Z' else extra.get(c, c)
for c in text)
class IRCName:
"""Equality/hash include connection identity and the captured casemapping."""
__slots__ = ('_text', '_casemapping', '_connection_id', '_key')
def __init__(self, text, context=None, casemapping=None, connection_id=None):
context = context or api.get_context()
if casemapping is None:
casemapping = context.get_info('casemapping')
if casemapping is None:
raise RuntimeError('host does not expose its comparison casemapping')
if connection_id is None:
previous = api.get_context()
if not context.set():
raise ValueError('context has closed')
try:
connection_id = api.get_prefs('id')
finally:
previous.set()
object.__setattr__(self, '_text', text)
object.__setattr__(self, '_casemapping', casemapping)
object.__setattr__(self, '_connection_id', connection_id)
object.__setattr__(self, '_key', (connection_id, casemapping,
irc_casefold(text, casemapping)))
def __setattr__(self, name, value):
raise AttributeError('IRCName is immutable')
@property
def text(self):
return self._text
@property
def casemapping(self):
return self._casemapping
@property
def connection_id(self):
return self._connection_id
def __str__(self):
return self._text
def __repr__(self):
return 'IRCName({!r}, casemapping={!r}, connection_id={!r})'.format(
self._text, self._casemapping, self._connection_id)
def __eq__(self, other):
if not isinstance(other, IRCName):
return NotImplemented
return self._key == other._key
def __ne__(self, other):
result = self.__eq__(other)
return NotImplemented if result is NotImplemented else not result
def __hash__(self):
return hash(self._key)
-21
View File
@@ -1,21 +0,0 @@
"""Opt-in post-display print observers."""
import _zoitechat as api
from _zoitechat_embedded import ffi, lib
__all__ = ['hook_print_after']
def hook_print_after(name, callback, userdata=None, priority=api.PRI_NORM):
"""callback(word, word_eol, userdata, attrs); its return value is ignored."""
if not callable(callback):
raise TypeError('callback must be callable')
plugin = api.__get_current_plugin()
hook = plugin.add_hook(callback, userdata)
handle = lib.zoitechat_hook_print_after(lib.ph, name.encode(), priority, 0,
lib._on_print_attrs_hook, hook.handle)
if handle == ffi.NULL:
hook.is_unload = True
plugin.remove_hook(id(hook))
raise RuntimeError('unable to install post-display hook')
hook.zoitechat_hook = handle
return id(hook)
-1
View File
@@ -38,7 +38,6 @@ extern "Python" int _on_print_attrs_hook(char **, zoitechat_event_attrs *, void
extern "Python" int _on_server_hook(char **, char **, void *); extern "Python" int _on_server_hook(char **, char **, void *);
extern "Python" int _on_server_attrs_hook(char **, char **, zoitechat_event_attrs *, void *); extern "Python" int _on_server_attrs_hook(char **, char **, zoitechat_event_attrs *, void *);
extern "Python" int _on_timer_hook(void *); extern "Python" int _on_timer_hook(void *);
extern "Python" int _on_fd_hook(int, int, void *);
extern "Python" int _on_plugin_init(char **, char **, char **, char *, char *); extern "Python" int _on_plugin_init(char **, char **, char **, char *, char *);
extern "Python" int _on_plugin_deinit(void); extern "Python" int _on_plugin_deinit(void);
+1 -5
View File
@@ -27,11 +27,7 @@ python3_source = custom_target('python-bindings',
command: [find_program('generate_plugin.py'), '@INPUT@', '@OUTPUT@'] command: [find_program('generate_plugin.py'), '@INPUT@', '@OUTPUT@']
) )
# Include any selected additive API modules alongside the compatibility modules. install_data(['_zoitechat.py', 'zoitechat.py', 'xchat.py', 'hexchat.py'],
python_api_files = run_command(python3, '-c',
'import glob,sys; print("\\n".join(sorted(glob.glob(sys.argv[1] + "/_zoitechat*.py"))))',
meson.current_source_dir(), check: true).stdout().strip().split('\n')
install_data(python_api_files + ['zoitechat.py', 'xchat.py', 'hexchat.py'],
install_dir: join_paths(get_option('libdir'), 'zoitechat/python') install_dir: join_paths(get_option('libdir'), 'zoitechat/python')
) )
+1 -28
View File
@@ -304,28 +304,6 @@ def _on_timer_hook(userdata):
return 0 return 0
@ffi.def_extern()
def _on_fd_hook(fd, flags, userdata):
hook = ffi.from_handle(userdata)
keep = False
try:
keep = bool(hook.callback(fd, flags, hook.userdata))
except Exception:
traceback.print_exc()
if not keep:
# The C watch removes itself on return; do not unhook it a second time.
try:
hook.is_unload = True
# from_handle() yields a weak proxy: id(proxy) is not id(Hook).
for existing in hook.plugin.hooks:
if existing == hook:
hook.plugin.remove_hook(id(existing))
break
except ReferenceError:
pass # the callback already unhooked itself
return int(keep)
@ffi.def_extern() @ffi.def_extern()
def _on_say_command(word, word_eol, userdata): def _on_say_command(word, word_eol, userdata):
"""Handle input in the special >>python<< tab. """Handle input in the special >>python<< tab.
@@ -612,12 +590,7 @@ def _on_plugin_deinit():
sys.stderr = sys.__stderr__ sys.stderr = sys.__stderr__
pydoc.help = pydoc.Helper() pydoc.help = pydoc.Helper()
# CFFI callbacks keep the embedding module's ffi/lib identity for the for mod in ('_zoitechat', 'zoitechat', 'xchat', '_zoitechat_embedded'):
# process lifetime; deleting it creates incompatible types on reload.
for mod in ('_zoitechat', 'zoitechat', 'hexchat', 'xchat',
'_zoitechat_fd', '_zoitechat_events', '_zoitechat_async',
'_zoitechat_names', '_zoitechat_contexts', '_zoitechat_post',
'_zoitechat_filters', '_zoitechat_caps'):
try: try:
del sys.modules[mod] del sys.modules[mod]
-1
View File
@@ -52,7 +52,6 @@
<None Include="xchat.py" /> <None Include="xchat.py" />
<None Include="hexchat.py" /> <None Include="hexchat.py" />
<None Include="_zoitechat.py" /> <None Include="_zoitechat.py" />
<None Include="_zoitechat_*.py" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<ClCompile Include="$(IntDir)python.c" /> <ClCompile Include="$(IntDir)python.c" />
-1
View File
@@ -52,7 +52,6 @@
<None Include="xchat.py" /> <None Include="xchat.py" />
<None Include="hexchat.py" /> <None Include="hexchat.py" />
<None Include="_zoitechat.py" /> <None Include="_zoitechat.py" />
<None Include="_zoitechat_*.py" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<ClCompile Include="$(IntDir)python.c" /> <ClCompile Include="$(IntDir)python.c" />
+2
View File
@@ -590,6 +590,7 @@ const struct prefs vars[] =
{"gui_gtk3_theme", P_OFFSET (hex_gui_gtk3_theme), TYPE_STR}, {"gui_gtk3_theme", P_OFFSET (hex_gui_gtk3_theme), TYPE_STR},
{"text_indent", P_OFFINT (hex_text_indent), TYPE_BOOL}, {"text_indent", P_OFFINT (hex_text_indent), TYPE_BOOL},
{"text_max_indent", P_OFFINT (hex_text_max_indent), TYPE_INT}, {"text_max_indent", P_OFFINT (hex_text_max_indent), TYPE_INT},
{"text_wrap_align", P_OFFINT (hex_text_wrap_align), TYPE_INT},
{"text_max_lines", P_OFFINT (hex_text_max_lines), TYPE_INT}, {"text_max_lines", P_OFFINT (hex_text_max_lines), TYPE_INT},
{"text_replay", P_OFFINT (hex_text_replay), TYPE_BOOL}, {"text_replay", P_OFFINT (hex_text_replay), TYPE_BOOL},
{"text_search_case_match", P_OFFINT (hex_text_search_case_match), TYPE_BOOL}, {"text_search_case_match", P_OFFINT (hex_text_search_case_match), TYPE_BOOL},
@@ -881,6 +882,7 @@ load_default_config(void)
prefs.hex_net_reconnect_delay = 10; prefs.hex_net_reconnect_delay = 10;
prefs.hex_notify_timeout = 15; prefs.hex_notify_timeout = 15;
prefs.hex_text_max_indent = 256; prefs.hex_text_max_indent = 256;
prefs.hex_text_wrap_align = 0;
prefs.hex_text_max_lines = 5000; prefs.hex_text_max_lines = 5000;
prefs.hex_url_grabber_limit = 100; /* 0 means unlimited */ prefs.hex_url_grabber_limit = 100; /* 0 means unlimited */
+2
View File
@@ -43,6 +43,7 @@
<ClInclude Include="typedef.h" /> <ClInclude Include="typedef.h" />
<ClInclude Include="url.h" /> <ClInclude Include="url.h" />
<ClInclude Include="userlist.h" /> <ClInclude Include="userlist.h" />
<ClInclude Include="hexcolor.h" />
<ClInclude Include="util.h" /> <ClInclude Include="util.h" />
<ClInclude Include="zoitechat-plugin.h" /> <ClInclude Include="zoitechat-plugin.h" />
<ClInclude Include="zoitechat.h" /> <ClInclude Include="zoitechat.h" />
@@ -79,6 +80,7 @@
<ClCompile Include="tree.c" /> <ClCompile Include="tree.c" />
<ClCompile Include="url.c" /> <ClCompile Include="url.c" />
<ClCompile Include="userlist.c" /> <ClCompile Include="userlist.c" />
<ClCompile Include="hexcolor.c" />
<ClCompile Include="util.c" /> <ClCompile Include="util.c" />
<ClCompile Include="zoitechat.c" /> <ClCompile Include="zoitechat.c" />
<ClCompile Include="theme-service.c" /> <ClCompile Include="theme-service.c" />
+6
View File
@@ -98,6 +98,9 @@
<ClInclude Include="userlist.h"> <ClInclude Include="userlist.h">
<Filter>Header Files</Filter> <Filter>Header Files</Filter>
</ClInclude> </ClInclude>
<ClInclude Include="hexcolor.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="util.h"> <ClInclude Include="util.h">
<Filter>Header Files</Filter> <Filter>Header Files</Filter>
</ClInclude> </ClInclude>
@@ -202,6 +205,9 @@
<ClCompile Include="userlist.c"> <ClCompile Include="userlist.c">
<Filter>Source Files</Filter> <Filter>Source Files</Filter>
</ClCompile> </ClCompile>
<ClCompile Include="hexcolor.c">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="util.c"> <ClCompile Include="util.c">
<Filter>Source Files</Filter> <Filter>Source Files</Filter>
</ClCompile> </ClCompile>
+42
View File
@@ -0,0 +1,42 @@
/* ZoiteChat
* Parsing of \004 (hex color) formatting codes: RRGGBB[,RRGGBB].
* Kept free of other application dependencies so the xtext widget tests can
* compile it on its own.
* Distributed under GPL-2.0-or-later; see COPYING. */
#include "hexcolor.h"
static int
hexcolor_component (const char *s, int avail, guint32 *rgb)
{
int i;
guint32 value = 0;
if (avail < 6)
return FALSE;
for (i = 0; i < 6; i++)
{
if (!g_ascii_isxdigit (s[i]))
return FALSE;
value = (value << 4) | g_ascii_xdigit_value (s[i]);
}
if (rgb)
*rgb = value;
return TRUE;
}
int
hexcolor_parse (const char *s, int avail, guint32 *fg, guint32 *bg, int *has_bg)
{
if (has_bg)
*has_bg = FALSE;
if (!hexcolor_component (s, avail, fg))
return 0;
if (avail >= 7 && s[6] == ',' && hexcolor_component (s + 7, avail - 7, bg))
{
if (has_bg)
*has_bg = TRUE;
return 13;
}
return 6;
}
+16
View File
@@ -0,0 +1,16 @@
/* ZoiteChat
* Parsing of \004 (hex color) formatting codes: RRGGBB[,RRGGBB].
* See https://modern.ircdocs.horse/formatting
* Distributed under GPL-2.0-or-later; see COPYING. */
#ifndef ZOITECHAT_HEXCOLOR_H
#define ZOITECHAT_HEXCOLOR_H
#include <glib.h>
/* Parses the parameters following a \004 byte. Returns the number of bytes
* consumed (6 or 13), or 0 if no valid RRGGBB follows. fg, bg and has_bg
* may be NULL. */
int hexcolor_parse (const char *s, int avail, guint32 *fg, guint32 *bg, int *has_bg);
#endif
+75 -105
View File
@@ -41,8 +41,6 @@
#include "network.h" #include "network.h"
#include "notify.h" #include "notify.h"
#include "outbound.h" #include "outbound.h"
#include <gmodule.h>
#include "plugin.h"
#include "inbound.h" #include "inbound.h"
#include "server.h" #include "server.h"
#include "servlist.h" #include "servlist.h"
@@ -1882,38 +1880,51 @@ inbound_toggle_caps (server *serv, const char *extensions_str, gboolean enable)
char **extensions; char **extensions;
gsize i; gsize i;
if (!extensions_str)
return;
extensions = g_strsplit (extensions_str, " ", 0); extensions = g_strsplit (extensions_str, " ", 0);
for (i = 0; extensions[i]; i++) for (i = 0; extensions[i]; i++)
{ {
const char *extension = extensions[i]; const char *extension = extensions[i];
gboolean cap_enable = enable;
/* ACK prefixes disabled capabilities with '-', unlike CAP DEL. */
if (*extension == '-')
{
cap_enable = FALSE;
extension++;
}
if (!strcmp (extension, "solanum.chat/identify-msg")) if (!strcmp (extension, "solanum.chat/identify-msg"))
serv->have_idmsg = enable; serv->have_idmsg = cap_enable;
else if (!strcmp (extension, "multi-prefix")) else if (!strcmp (extension, "multi-prefix"))
serv->have_namesx = enable; serv->have_namesx = cap_enable;
else if (!strcmp (extension, "account-notify")) else if (!strcmp (extension, "account-notify"))
serv->have_accnotify = enable; serv->have_accnotify = cap_enable;
else if (!strcmp (extension, "extended-join")) else if (!strcmp (extension, "extended-join"))
serv->have_extjoin = enable; serv->have_extjoin = cap_enable;
else if (!strcmp (extension, "userhost-in-names")) else if (!strcmp (extension, "userhost-in-names"))
serv->have_uhnames = enable; serv->have_uhnames = cap_enable;
else if (!strcmp (extension, "server-time") else if (!strcmp (extension, "server-time")
|| !strcmp (extension, "znc.in/server-time") || !strcmp (extension, "znc.in/server-time")
|| !strcmp (extension, "znc.in/server-time-iso")) || !strcmp (extension, "znc.in/server-time-iso"))
serv->have_server_time = enable; serv->have_server_time = cap_enable;
else if (!strcmp (extension, "away-notify")) else if (!strcmp (extension, "away-notify"))
serv->have_awaynotify = enable; serv->have_awaynotify = cap_enable;
else if (!strcmp (extension, "account-tag")) else if (!strcmp (extension, "account-tag"))
serv->have_account_tag = enable; serv->have_account_tag = cap_enable;
else if (!strcmp (extension, "message-tags")) else if (!strcmp (extension, "message-tags"))
serv->have_message_tags = enable; serv->have_message_tags = cap_enable;
else if (!strcmp (extension, "echo-message")) else if (!strcmp (extension, "echo-message"))
serv->have_echo_message = enable; serv->have_echo_message = cap_enable;
else if (!strcmp (extension, "sasl")) else if (!strcmp (extension, "sasl"))
{ {
serv->have_sasl = enable; gboolean start_auth = cap_enable && !serv->have_sasl;
if (enable)
serv->have_sasl = cap_enable;
if (start_auth)
{ {
#ifdef USE_OPENSSL #ifdef USE_OPENSSL
if (serv->loginmethod == LOGIN_SASLEXTERNAL) if (serv->loginmethod == LOGIN_SASLEXTERNAL)
@@ -1964,58 +1975,15 @@ inbound_cap_ack (server *serv, char *nick, char *extensions,
inbound_toggle_caps (serv, extensions, TRUE); inbound_toggle_caps (serv, extensions, TRUE);
} }
/* Split requests only at token boundaries, including plugin-added names. */ static void inbound_request_new_caps (server *serv, const char *extensions_str,
static void const message_tags_data *tags_data);
inbound_cap_request_append (server *serv, char *buffer, gsize size,
const char *name, time_t timestamp)
{
if (strlen (buffer) + strlen (name) + 1 >= size)
{
EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPREQ, serv->server_session,
buffer + 9, NULL, NULL, NULL, 0, timestamp);
tcp_sendf (serv, "%s\r\n", g_strchomp (buffer));
g_strlcpy (buffer, "CAP REQ :", size);
}
g_strlcat (buffer, name, size);
g_strlcat (buffer, " ", size);
}
static void
inbound_plugin_cap_new (server *serv, const char *extensions, time_t timestamp)
{
char buffer[500] = "CAP REQ :";
char **tokens = g_strsplit (extensions, " ", 0);
GHashTable *seen = g_hash_table_new (g_str_hash, g_str_equal);
int i;
gboolean requested = FALSE;
for (i = 0; tokens[i]; i++)
{
char *value = strchr (tokens[i], '=');
if (value)
*value = '\0';
if (plugin_requests_capability (serv, tokens[i]) &&
!g_hash_table_contains (seen, tokens[i]))
{
g_hash_table_add (seen, tokens[i]);
inbound_cap_request_append (serv, buffer, sizeof (buffer), tokens[i], timestamp);
requested = TRUE;
}
}
if (requested)
{
EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPREQ, serv->server_session,
buffer + 9, NULL, NULL, NULL, 0, timestamp);
tcp_sendf (serv, "%s\r\n", g_strchomp (buffer));
}
g_hash_table_destroy (seen);
g_strfreev (tokens);
}
void void
inbound_cap_new (server *serv, char *nick, char *extensions, inbound_cap_new (server *serv, char *nick, char *extensions,
const message_tags_data *tags_data) const message_tags_data *tags_data)
{ {
gboolean sts_upgrade_triggered = FALSE; gboolean sts_upgrade_triggered = FALSE;
if (extensions) if (extensions)
{ {
char **tokens = g_strsplit (extensions, " ", 0); char **tokens = g_strsplit (extensions, " ", 0);
@@ -2036,41 +2004,22 @@ inbound_cap_new (server *serv, char *nick, char *extensions,
g_strfreev (tokens); g_strfreev (tokens);
} }
if (extensions && !sts_upgrade_triggered) EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPLIST, serv->server_session, nick, extensions,
inbound_plugin_cap_new (serv, extensions, tags_data->timestamp);
EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPACK, serv->server_session, nick, extensions,
NULL, NULL, 0, tags_data->timestamp); NULL, NULL, 0, tags_data->timestamp);
inbound_toggle_caps (serv, extensions, TRUE); /* NEW advertises availability; only ACK confirms an enabled capability. */
if (!sts_upgrade_triggered)
inbound_request_new_caps (serv, extensions, tags_data);
} }
void void
inbound_cap_del (server *serv, char *nick, char *extensions, inbound_cap_del (server *serv, char *nick, char *extensions,
const message_tags_data *tags_data) const message_tags_data *tags_data)
{ {
if (extensions)
{
char **tokens = g_strsplit (extensions, " ", 0);
int i;
for (i = 0; tokens[i]; i++)
{
if (!g_strcmp0 (tokens[i], "sts") ||
g_str_has_prefix (tokens[i], "sts="))
{
/* STS cannot be disabled via CAP DEL. */
g_strfreev (tokens);
return;
}
}
g_strfreev (tokens);
}
EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPDEL, serv->server_session, nick, extensions, EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPDEL, serv->server_session, nick, extensions,
NULL, NULL, 0, tags_data->timestamp); NULL, NULL, 0, tags_data->timestamp);
/* STS has no toggle, but must not prevent other capabilities being removed. */
inbound_toggle_caps (serv, extensions, FALSE); inbound_toggle_caps (serv, extensions, FALSE);
} }
@@ -2106,6 +2055,44 @@ static const char * const supported_caps[] = {
"solanum.chat/identify-msg", "solanum.chat/identify-msg",
}; };
static void
inbound_request_new_caps (server *serv, const char *extensions_str,
const message_tags_data *tags_data)
{
char **extensions;
gsize i, x;
if (!extensions_str)
return;
extensions = g_strsplit (extensions_str, " ", 0);
for (i = 0; extensions[i]; i++)
{
char *value = strchr (extensions[i], '=');
if (value)
*value = '\0';
}
/* Request each supported capability once, keeping every IRC line bounded.
* SASL is negotiated during login and is not in supported_caps. */
for (x = 0; x < G_N_ELEMENTS (supported_caps); x++)
{
for (i = 0; extensions[i]; i++)
{
if (!strcmp (extensions[i], supported_caps[x]))
{
EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPREQ, serv->server_session,
extensions[i], NULL, NULL, NULL, 0,
tags_data->timestamp);
tcp_sendf (serv, "CAP REQ :%s\r\n", extensions[i]);
break;
}
}
}
g_strfreev (extensions);
}
static int static int
get_supported_mech (server *serv, const char *list) get_supported_mech (server *serv, const char *list)
{ {
@@ -2169,7 +2156,6 @@ inbound_cap_ls (server *serv, char *nick, char *extensions_str,
gboolean want_cap = FALSE; /* format the CAP REQ string based on previous capabilities being requested or not */ gboolean want_cap = FALSE; /* format the CAP REQ string based on previous capabilities being requested or not */
gboolean sts_upgrade_triggered = FALSE; gboolean sts_upgrade_triggered = FALSE;
char **extensions; char **extensions;
GString *requests = g_string_new ("");
int i; int i;
if (g_str_has_prefix (extensions_str, "* ")) if (g_str_has_prefix (extensions_str, "* "))
@@ -2235,7 +2221,7 @@ inbound_cap_ls (server *serv, char *nick, char *extensions_str,
} }
want_cap = TRUE; want_cap = TRUE;
serv->waiting_on_sasl = TRUE; serv->waiting_on_sasl = TRUE;
g_string_append (requests, "sasl "); g_strlcat (buffer, "sasl ", sizeof(buffer));
continue; continue;
} }
@@ -2243,44 +2229,28 @@ inbound_cap_ls (server *serv, char *nick, char *extensions_str,
{ {
if (!g_strcmp0 (extension, supported_caps[x])) if (!g_strcmp0 (extension, supported_caps[x]))
{ {
g_string_append (requests, extension); g_strlcat (buffer, extension, sizeof(buffer));
g_string_append_c (requests, ' '); g_strlcat (buffer, " ", sizeof(buffer));
want_cap = TRUE;
break;
}
}
if (x == G_N_ELEMENTS (supported_caps) && plugin_requests_capability (serv, extension))
{
g_string_append (requests, extension);
g_string_append_c (requests, ' ');
want_cap = TRUE; want_cap = TRUE;
} }
}
} }
g_strfreev (extensions); g_strfreev (extensions);
if (sts_upgrade_triggered) if (sts_upgrade_triggered)
{ {
g_string_free (requests, TRUE);
return; return;
} }
if (want_cap) if (want_cap)
{ {
char **tokens = g_strsplit (requests->str, " ", 0);
/* Defer every batch until STS has decided whether to reconnect. */
for (i = 0; tokens[i]; i++)
if (tokens[i][0])
inbound_cap_request_append (serv, buffer, sizeof (buffer), tokens[i], tags_data->timestamp);
g_strfreev (tokens);
/* buffer + 9 = emit buffer without "CAP REQ :" */ /* buffer + 9 = emit buffer without "CAP REQ :" */
EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPREQ, serv->server_session, EMIT_SIGNAL_TIMESTAMP (XP_TE_CAPREQ, serv->server_session,
buffer + 9, NULL, NULL, NULL, 0, buffer + 9, NULL, NULL, NULL, 0,
tags_data->timestamp); tags_data->timestamp);
tcp_sendf (serv, "%s\r\n", g_strchomp (buffer)); tcp_sendf (serv, "%s\r\n", g_strchomp (buffer));
} }
g_string_free (requests, TRUE);
if (!serv->waiting_on_sasl && !serv->waiting_on_cap) if (!serv->waiting_on_sasl && !serv->waiting_on_cap)
{ {
/* if we use SASL, CAP END is dealt via raw numerics */ /* if we use SASL, CAP END is dealt via raw numerics */
+16
View File
@@ -25,6 +25,7 @@ common_sources = [
'tree.c', 'tree.c',
'url.c', 'url.c',
'userlist.c', 'userlist.c',
'hexcolor.c',
'util.c' 'util.c'
] ]
@@ -197,3 +198,18 @@ test('Emoji Data Tests', emoji_data_tests,
protocol: 'tap', protocol: 'tap',
timeout: 120, timeout: 120,
) )
hexcolor_tests = executable('hexcolor_tests',
[
'tests/test-hexcolor.c',
'hexcolor.c',
'util.c',
],
include_directories: [config_h_include, include_directories('.')],
dependencies: [libgio_dep] + (libssl_dep.found() ? [libssl_dep] : []),
)
test('Hex Color Tests', hexcolor_tests,
protocol: 'tap',
timeout: 120,
)
+2 -149
View File
@@ -99,10 +99,6 @@ struct _zoitechat_hook
int tag; /* for timers & FDs only */ int tag; /* for timers & FDs only */
int type; /* HOOK_* */ int type; /* HOOK_* */
int pri; /* fd */ /* priority / fd for HOOK_FD only */ int pri; /* fd */ /* priority / fd for HOOK_FD only */
int cap_connection_id;
int connection_filter;
char *channel_filter;
gboolean context_filtered;
}; };
struct _zoitechat_list struct _zoitechat_list
@@ -147,8 +143,6 @@ enum
HOOK_PRINT_ATTRS = 1 << 4, /* same as above, with attributes */ HOOK_PRINT_ATTRS = 1 << 4, /* same as above, with attributes */
HOOK_TIMER = 1 << 5, /* timeouts */ HOOK_TIMER = 1 << 5, /* timeouts */
HOOK_FD = 1 << 6, /* sockets & fds */ HOOK_FD = 1 << 6, /* sockets & fds */
HOOK_PRINT_AFTER = 1 << 8, /* opt-in post-display observers */
HOOK_CAPABILITY = 1 << 9, /* script-owned CAP requests */
HOOK_DELETED = 1 << 7 /* marked for deletion */ HOOK_DELETED = 1 << 7 /* marked for deletion */
}; };
@@ -182,7 +176,6 @@ enum
GSList *plugin_list = NULL; /* export for plugingui.c */ GSList *plugin_list = NULL; /* export for plugingui.c */
static GSList *hook_list = NULL; static GSList *hook_list = NULL;
static unsigned int plugin_dispatch_depth;
extern const struct prefs vars[]; /* cfgfiles.c */ extern const struct prefs vars[]; /* cfgfiles.c */
@@ -250,7 +243,7 @@ plugin_list_add (zoitechat_context *ctx, char *filename, const char *name,
{ {
zoitechat_plugin *pl; zoitechat_plugin *pl;
pl = g_new0 (zoitechat_plugin, 1); pl = g_new (zoitechat_plugin, 1);
pl->handle = handle; pl->handle = handle;
pl->filename = filename; pl->filename = filename;
pl->context = ctx; pl->context = ctx;
@@ -357,10 +350,6 @@ plugin_add (session *sess, char *filename, void *handle, void *init_func,
pl->zoitechat_emit_print_attrs = zoitechat_emit_print_attrs; pl->zoitechat_emit_print_attrs = zoitechat_emit_print_attrs;
pl->zoitechat_event_attrs_create = zoitechat_event_attrs_create; pl->zoitechat_event_attrs_create = zoitechat_event_attrs_create;
pl->zoitechat_event_attrs_free = zoitechat_event_attrs_free; pl->zoitechat_event_attrs_free = zoitechat_event_attrs_free;
pl->zoitechat_register_capability = zoitechat_register_capability;
pl->zoitechat_hook_server_filtered = zoitechat_hook_server_filtered;
pl->zoitechat_hook_print_filtered = zoitechat_hook_print_filtered;
pl->zoitechat_hook_print_after = zoitechat_hook_print_after;
/* run zoitechat_plugin_init, if it returns 0, close the plugin */ /* run zoitechat_plugin_init, if it returns 0, close the plugin */
if (((zoitechat_init_func *)init_func) (pl, &pl->name, &pl->desc, &pl->version, arg) == 0) if (((zoitechat_init_func *)init_func) (pl, &pl->name, &pl->desc, &pl->version, arg) == 0)
@@ -621,7 +610,6 @@ plugin_hook_run (session *sess, char *name, char *word[], char *word_eol[],
zoitechat_hook *hook; zoitechat_hook *hook;
int ret, eat = 0; int ret, eat = 0;
plugin_dispatch_depth++;
list = hook_list; list = hook_list;
while (1) while (1)
{ {
@@ -631,22 +619,6 @@ plugin_hook_run (session *sess, char *name, char *word[], char *word_eol[],
hook = list->data; hook = list->data;
next = list->next; next = list->next;
if (hook->context_filtered &&
(!is_session (sess) ||
(hook->connection_filter != -1 && hook->connection_filter != sess->server->id) ||
(hook->channel_filter && sess->server->p_cmp (hook->channel_filter, sess->channel))))
{
list = next;
continue; /* filter in C before entering an interpreter */
}
if (type == HOOK_PRINT_AFTER && hook->tag)
{
list = next;
continue; /* no recursive invocation of this same observer */
}
if (type == HOOK_PRINT_AFTER)
hook->tag = 1;
hook->pl->context = sess; hook->pl->context = sess;
/* run the plugin's callback function */ /* run the plugin's callback function */
@@ -655,7 +627,6 @@ plugin_hook_run (session *sess, char *name, char *word[], char *word_eol[],
case HOOK_COMMAND: case HOOK_COMMAND:
ret = ((zoitechat_cmd_cb *)hook->callback) (word, word_eol, hook->userdata); ret = ((zoitechat_cmd_cb *)hook->callback) (word, word_eol, hook->userdata);
break; break;
case HOOK_PRINT_AFTER:
case HOOK_PRINT_ATTRS: case HOOK_PRINT_ATTRS:
ret = ((zoitechat_print_attrs_cb *)hook->callback) (word, attrs, hook->userdata); ret = ((zoitechat_print_attrs_cb *)hook->callback) (word, attrs, hook->userdata);
break; break;
@@ -670,15 +641,6 @@ plugin_hook_run (session *sess, char *name, char *word[], char *word_eol[],
break; break;
} }
if (type == HOOK_PRINT_AFTER)
{
hook->tag = 0;
if (!is_session (sess))
goto xit;
list = next;
continue; /* display already happened; observers cannot eat it */
}
if ((ret & ZOITECHAT_EAT_ZOITECHAT) && (ret & ZOITECHAT_EAT_PLUGIN)) if ((ret & ZOITECHAT_EAT_ZOITECHAT) && (ret & ZOITECHAT_EAT_PLUGIN))
{ {
eat = 1; eat = 1;
@@ -693,10 +655,6 @@ plugin_hook_run (session *sess, char *name, char *word[], char *word_eol[],
} }
xit: xit:
/* Nested callbacks can unhook entries still used by an outer dispatch.
* Keep both hook objects and list links alive until the outermost return. */
if (--plugin_dispatch_depth != 0)
return eat;
/* really remove deleted hooks now */ /* really remove deleted hooks now */
list = hook_list; list = hook_list;
while (list) while (list)
@@ -761,15 +719,6 @@ plugin_emit_print (session *sess, char *word[], time_t server_time)
HOOK_PRINT | HOOK_PRINT_ATTRS); HOOK_PRINT | HOOK_PRINT_ATTRS);
} }
void
plugin_emit_print_after (session *sess, char *word[], time_t server_time)
{
zoitechat_event_attrs attrs;
attrs.server_time_utc = server_time;
if (is_session (sess))
plugin_hook_run (sess, word[0], word, NULL, &attrs, HOOK_PRINT_AFTER);
}
int int
plugin_emit_dummy_print (session *sess, char *name) plugin_emit_dummy_print (session *sess, char *name)
{ {
@@ -857,7 +806,7 @@ plugin_insert_hook (zoitechat_hook *new_hook)
break; break;
case HOOK_SERVER: case HOOK_SERVER:
case HOOK_SERVER_ATTRS: case HOOK_SERVER_ATTRS:
new_hook_type = HOOK_SERVER | HOOK_SERVER_ATTRS; new_hook_type = HOOK_SERVER | HOOK_PRINT_ATTRS;
break; break;
default: default:
new_hook_type = new_hook->type; new_hook_type = new_hook->type;
@@ -1069,87 +1018,10 @@ zoitechat_unhook (zoitechat_plugin *ph, zoitechat_hook *hook)
g_free (hook->name); /* NULL for timers & fds */ g_free (hook->name); /* NULL for timers & fds */
g_free (hook->help_text); /* NULL for non-commands */ g_free (hook->help_text); /* NULL for non-commands */
g_free (hook->channel_filter);
hook->channel_filter = NULL;
return hook->userdata; return hook->userdata;
} }
zoitechat_hook *
zoitechat_hook_print_after (zoitechat_plugin *ph, const char *name, int pri,
int flags, zoitechat_print_attrs_cb *callback, void *userdata)
{
if (flags != 0 || !name || !callback)
return NULL;
return plugin_add_hook (ph, HOOK_PRINT_AFTER, pri, name, NULL, callback, 0, userdata);
}
static zoitechat_hook *
plugin_add_filtered_hook (zoitechat_plugin *ph, const char *name, int pri,
int flags, int connection_id, const char *channel,
int type, void *callback, void *userdata)
{
zoitechat_hook *hook;
if (flags != 0 || connection_id < -1 || !name || !callback)
return NULL;
hook = plugin_add_hook (ph, type, pri, name, NULL, callback, 0, userdata);
hook->context_filtered = TRUE;
hook->connection_filter = connection_id;
hook->channel_filter = g_strdup (channel);
return hook;
}
zoitechat_hook *
zoitechat_hook_server_filtered (zoitechat_plugin *ph, const char *name, int pri,
int flags, int connection_id, const char *channel,
zoitechat_serv_attrs_cb *callback, void *userdata)
{
return plugin_add_filtered_hook (ph, name, pri, flags, connection_id, channel,
HOOK_SERVER_ATTRS, callback, userdata);
}
zoitechat_hook *
zoitechat_hook_print_filtered (zoitechat_plugin *ph, const char *name, int pri,
int flags, int connection_id, const char *channel,
zoitechat_print_attrs_cb *callback, void *userdata)
{
return plugin_add_filtered_hook (ph, name, pri, flags, connection_id, channel,
HOOK_PRINT_ATTRS, callback, userdata);
}
zoitechat_hook *
zoitechat_register_capability (zoitechat_plugin *ph, const char *name, int flags,
int connection_id, void *userdata)
{
const unsigned char *p;
zoitechat_hook *hook;
if (flags != 0 || connection_id < -1 || !name || !name[0] || strlen (name) > 200 ||
strcmp (name, "sasl") == 0 || strcmp (name, "sts") == 0)
return NULL; /* authentication and transport policy belong to core */
for (p = (const unsigned char *)name; *p; p++)
if (!g_ascii_islower (*p) && !g_ascii_isdigit (*p) &&
*p != '-' && *p != '.' && *p != '/' && *p != '_')
return NULL;
hook = plugin_add_hook (ph, HOOK_CAPABILITY, 0, name, NULL, NULL, 0, userdata);
hook->cap_connection_id = connection_id;
return hook;
}
gboolean
plugin_requests_capability (server *serv, const char *name)
{
GSList *entry;
for (entry = hook_list; entry; entry = entry->next)
{
zoitechat_hook *hook = entry->data;
if (hook && hook->type == HOOK_CAPABILITY &&
(hook->cap_connection_id == -1 || hook->cap_connection_id == serv->id) &&
strcmp (hook->name, name) == 0)
return TRUE;
}
return FALSE;
}
zoitechat_hook * zoitechat_hook *
zoitechat_hook_command (zoitechat_plugin *ph, const char *name, int pri, zoitechat_hook_command (zoitechat_plugin *ph, const char *name, int pri,
zoitechat_cmd_cb *callb, const char *help_text, void *userdata) zoitechat_cmd_cb *callb, const char *help_text, void *userdata)
@@ -1309,25 +1181,6 @@ zoitechat_get_info (zoitechat_plugin *ph, const char *id)
return text_find_format_string (e); return text_find_format_string (e);
} }
/* Report the comparison actually used by this connection, not an
* advertised mapping that the current core does not implement. */
if (strcmp (id, "casemapping") == 0)
{
if (!is_session (ph->context))
return NULL;
return ph->context->server->p_cmp == g_ascii_strcasecmp
? "ascii" : "rfc1459";
}
if (strcmp (id, "api_hook_print_after") == 0)
return "1";
if (strcmp (id, "api_context_filters") == 0)
return "1";
if (strcmp (id, "api_plugin_caps") == 0)
return "1";
hash = str_hash (id); hash = str_hash (id);
/* do the session independant ones first */ /* do the session independant ones first */
switch (hash) switch (hash)
-11
View File
@@ -150,15 +150,6 @@ struct _zoitechat_plugin
void (*zoitechat_event_attrs_free) (zoitechat_plugin *ph, void (*zoitechat_event_attrs_free) (zoitechat_plugin *ph,
zoitechat_event_attrs *attrs); zoitechat_event_attrs *attrs);
/* Additive API slots: append only; old binary offsets are unchanged. */
zoitechat_hook *(*zoitechat_hook_print_after) (zoitechat_plugin *, const char *, int,
int, int (*)(char *[], zoitechat_event_attrs *, void *), void *);
zoitechat_hook *(*zoitechat_hook_server_filtered) (zoitechat_plugin *, const char *, int,
int, int, const char *, int (*)(char *[], char *[], zoitechat_event_attrs *, void *), void *);
zoitechat_hook *(*zoitechat_hook_print_filtered) (zoitechat_plugin *, const char *, int,
int, int, const char *, int (*)(char *[], zoitechat_event_attrs *, void *), void *);
zoitechat_hook *(*zoitechat_register_capability) (zoitechat_plugin *, const char *, int, int, void *);
/* PRIVATE FIELDS! */ /* PRIVATE FIELDS! */
void *handle; /* from dlopen */ void *handle; /* from dlopen */
char *filename; /* loaded from */ char *filename; /* loaded from */
@@ -183,8 +174,6 @@ int plugin_emit_command (session *sess, char *name, char *word[], char *word_eol
int plugin_emit_server (session *sess, char *name, char *word[], char *word_eol[], int plugin_emit_server (session *sess, char *name, char *word[], char *word_eol[],
time_t server_time); time_t server_time);
int plugin_emit_print (session *sess, char *word[], time_t server_time); int plugin_emit_print (session *sess, char *word[], time_t server_time);
gboolean plugin_requests_capability (server *serv, const char *name);
void plugin_emit_print_after (session *sess, char *word[], time_t server_time);
int plugin_emit_dummy_print (session *sess, char *name); int plugin_emit_dummy_print (session *sess, char *name);
int plugin_emit_keypress (session *sess, unsigned int state, unsigned int keyval, gunichar key); int plugin_emit_keypress (session *sess, unsigned int state, unsigned int keyval, gunichar key);
GList* plugin_command_list(GList *tmp_list); GList* plugin_command_list(GList *tmp_list);
+3 -3
View File
@@ -155,7 +155,7 @@ _SSL_get_cert_info (struct cert_info *cert_info, SSL * ssl)
{ {
X509 *peer_cert; X509 *peer_cert;
const X509_PUBKEY *key; const X509_PUBKEY *key;
X509_ALGOR *algor = NULL; ASN1_OBJECT *obj = NULL;
EVP_PKEY *peer_pkey; EVP_PKEY *peer_pkey;
char notBefore[64]; char notBefore[64];
char notAfter[64]; char notAfter[64];
@@ -174,10 +174,10 @@ _SSL_get_cert_info (struct cert_info *cert_info, SSL * ssl)
broke_oneline (cert_info->issuer, cert_info->issuer_word); broke_oneline (cert_info->issuer, cert_info->issuer_word);
key = X509_get_X509_PUBKEY(peer_cert); key = X509_get_X509_PUBKEY(peer_cert);
if (!X509_PUBKEY_get0_param(NULL, NULL, 0, &algor, key)) if (!X509_PUBKEY_get0_param(&obj, NULL, NULL, NULL, key))
return 1; return 1;
alg = OBJ_obj2nid (algor->algorithm); alg = OBJ_obj2nid (obj);
#ifndef HAVE_X509_GET_SIGNATURE_NID #ifndef HAVE_X509_GET_SIGNATURE_NID
sign_alg = OBJ_obj2nid (peer_cert->sig_alg->algorithm); sign_alg = OBJ_obj2nid (peer_cert->sig_alg->algorithm);
#else #else
+117
View File
@@ -0,0 +1,117 @@
/* ZoiteChat
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <string.h>
#include <glib.h>
#include "../hexcolor.h"
#include "../util.h"
static void
test_parse_foreground (void)
{
guint32 fg = 0, bg = 0xDEAD;
int has_bg = TRUE;
g_assert_cmpint (hexcolor_parse ("FF8800text", 10, &fg, &bg, &has_bg), ==, 6);
g_assert_cmphex (fg, ==, 0xFF8800);
g_assert_false (has_bg);
g_assert_cmphex (bg, ==, 0xDEAD);
}
static void
test_parse_foreground_and_background (void)
{
guint32 fg = 0, bg = 0;
int has_bg = FALSE;
g_assert_cmpint (hexcolor_parse ("112233,a0b0c0x", 14, &fg, &bg, &has_bg), ==, 13);
g_assert_cmphex (fg, ==, 0x112233);
g_assert_cmphex (bg, ==, 0xA0B0C0);
g_assert_true (has_bg);
}
static void
test_parse_bad_background_keeps_foreground (void)
{
guint32 fg = 0;
int has_bg = TRUE;
/* ",12" is plain text after a valid foreground, not a background */
g_assert_cmpint (hexcolor_parse ("112233,12 hi", 12, &fg, NULL, &has_bg), ==, 6);
g_assert_cmphex (fg, ==, 0x112233);
g_assert_false (has_bg);
}
static void
test_parse_bare (void)
{
/* a bare \004 resets colors, like a bare \003 */
g_assert_cmpint (hexcolor_parse (" text", 5, NULL, NULL, NULL), ==, 0);
g_assert_cmpint (hexcolor_parse ("12345G", 6, NULL, NULL, NULL), ==, 0);
g_assert_cmpint (hexcolor_parse ("", 0, NULL, NULL, NULL), ==, 0);
}
static void
test_parse_respects_length (void)
{
g_assert_cmpint (hexcolor_parse ("FF8800", 5, NULL, NULL, NULL), ==, 0);
g_assert_cmpint (hexcolor_parse ("FF8800,112233", 12, NULL, NULL, NULL), ==, 6);
}
static void
assert_stripped (const char *in, int flags, const char *expected)
{
char out[128];
strip_color2 (in, -1, out, flags);
g_assert_cmpstr (out, ==, expected);
}
static void
test_strip (void)
{
assert_stripped ("\004FF8800alice\017: hi", STRIP_ALL, "alice: hi");
assert_stripped ("\004112233,445566bg", STRIP_ALL, "bg");
assert_stripped ("a\004 b", STRIP_ALL, "a b");
assert_stripped ("\004FF8800\00312x", STRIP_ALL, "x");
/* a trailing code with too few digits leaves the rest as text */
assert_stripped ("x\004FF88", STRIP_ALL, "xFF88");
}
static void
test_strip_keeps_hex_without_strip_color (void)
{
assert_stripped ("\004FF8800red\002", STRIP_ATTRIB, "\004FF8800red");
}
int
main (int argc, char *argv[])
{
g_test_init (&argc, &argv, NULL);
g_test_add_func ("/hexcolor/parse/foreground", test_parse_foreground);
g_test_add_func ("/hexcolor/parse/foreground-and-background", test_parse_foreground_and_background);
g_test_add_func ("/hexcolor/parse/bad-background", test_parse_bad_background_keeps_foreground);
g_test_add_func ("/hexcolor/parse/bare", test_parse_bare);
g_test_add_func ("/hexcolor/parse/length", test_parse_respects_length);
g_test_add_func ("/hexcolor/strip/all", test_strip);
g_test_add_func ("/hexcolor/strip/attrib-only", test_strip_keeps_hex_without_strip_color);
return g_test_run ();
}
-1
View File
@@ -2306,7 +2306,6 @@ text_emit (int index, session *sess, char *a, char *b, char *c, char *d,
if (!prefs.hex_away_omit_alerts || !sess->server->is_away) if (!prefs.hex_away_omit_alerts || !sess->server->is_away)
sound_play_event (index); sound_play_event (index);
display_event (sess, index, word, stripcolor_args, timestamp); display_event (sess, index, word, stripcolor_args, timestamp);
plugin_emit_print_after (sess, word, timestamp);
} }
char * char *
+9
View File
@@ -47,6 +47,7 @@
#include "zoitechatc.h" #include "zoitechatc.h"
#include <ctype.h> #include <ctype.h>
#include "util.h" #include "util.h"
#include "hexcolor.h"
#if defined (__FreeBSD__) || defined (__APPLE__) #if defined (__FreeBSD__) || defined (__APPLE__)
#include <sys/sysctl.h> #include <sys/sysctl.h>
@@ -330,6 +331,14 @@ strip_color2 (const char *src, int len, char *dst, int flags)
if (!(flags & STRIP_COLOR)) goto pass_char; if (!(flags & STRIP_COLOR)) goto pass_char;
rcol = 2; rcol = 2;
break; break;
case '\004': /*ATTR_HEXCOLOR: */
if (!(flags & STRIP_COLOR)) goto pass_char;
{
int skip = hexcolor_parse (src + 1, len, NULL, NULL, NULL);
src += skip;
len -= skip;
}
break;
case HIDDEN_CHAR: /* CL: invisible text (for event formats only) */ /* this takes care of the topic */ case HIDDEN_CHAR: /* CL: invisible text (for event formats only) */ /* this takes care of the topic */
if (!(flags & STRIP_HIDDEN)) goto pass_char; if (!(flags & STRIP_HIDDEN)) goto pass_char;
break; break;
-33
View File
@@ -193,39 +193,10 @@ struct _zoitechat_plugin
zoitechat_event_attrs *(*zoitechat_event_attrs_create) (zoitechat_plugin *ph); zoitechat_event_attrs *(*zoitechat_event_attrs_create) (zoitechat_plugin *ph);
void (*zoitechat_event_attrs_free) (zoitechat_plugin *ph, void (*zoitechat_event_attrs_free) (zoitechat_plugin *ph,
zoitechat_event_attrs *attrs); zoitechat_event_attrs *attrs);
/* Additive API slots: append only; old binary offsets are unchanged. */
zoitechat_hook *(*zoitechat_hook_print_after) (zoitechat_plugin *, const char *, int,
int, int (*)(char *[], zoitechat_event_attrs *, void *), void *);
zoitechat_hook *(*zoitechat_hook_server_filtered) (zoitechat_plugin *, const char *, int,
int, int, const char *, int (*)(char *[], char *[], zoitechat_event_attrs *, void *), void *);
zoitechat_hook *(*zoitechat_hook_print_filtered) (zoitechat_plugin *, const char *, int,
int, int, const char *, int (*)(char *[], zoitechat_event_attrs *, void *), void *);
zoitechat_hook *(*zoitechat_register_capability) (zoitechat_plugin *, const char *, int, int, void *);
}; };
#endif #endif
/* api_hook_print_after=1: observer returns are ignored; flags must be zero. */
zoitechat_hook *zoitechat_hook_print_after (zoitechat_plugin *ph,
const char *name, int pri, int flags,
int (*callback) (char *word[], zoitechat_event_attrs *attrs, void *userdata),
void *userdata);
/* api_context_filters=1: connection_id -1 is any; NULL channel is any. */
zoitechat_hook *zoitechat_hook_server_filtered (zoitechat_plugin *ph,
const char *name, int pri, int flags, int connection_id, const char *channel,
int (*callback) (char *word[], char *word_eol[], zoitechat_event_attrs *attrs, void *userdata),
void *userdata);
zoitechat_hook *zoitechat_hook_print_filtered (zoitechat_plugin *ph,
const char *name, int pri, int flags, int connection_id, const char *channel,
int (*callback) (char *word[], zoitechat_event_attrs *attrs, void *userdata),
void *userdata);
/* api_plugin_caps=1: register before CAP LS; flags=0, connection_id=-1 for any. */
zoitechat_hook *zoitechat_register_capability (zoitechat_plugin *ph,
const char *name, int flags, int connection_id, void *userdata);
zoitechat_hook * zoitechat_hook *
zoitechat_hook_command (zoitechat_plugin *ph, zoitechat_hook_command (zoitechat_plugin *ph,
const char *name, const char *name,
@@ -445,10 +416,6 @@ zoitechat_pluginpref_list (zoitechat_plugin *ph,
#define zoitechat_hook_server ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_server) #define zoitechat_hook_server ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_server)
#define zoitechat_hook_server_attrs ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_server_attrs) #define zoitechat_hook_server_attrs ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_server_attrs)
#define zoitechat_hook_print ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print) #define zoitechat_hook_print ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print)
#define zoitechat_register_capability ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_register_capability)
#define zoitechat_hook_server_filtered ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_server_filtered)
#define zoitechat_hook_print_filtered ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print_filtered)
#define zoitechat_hook_print_after ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print_after)
#define zoitechat_hook_print_attrs ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print_attrs) #define zoitechat_hook_print_attrs ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print_attrs)
#define zoitechat_hook_timer ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_timer) #define zoitechat_hook_timer ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_timer)
#define zoitechat_hook_fd ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_fd) #define zoitechat_hook_fd ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_fd)
+1
View File
@@ -306,6 +306,7 @@ struct zoitechatprefs
int hex_net_reconnect_delay; int hex_net_reconnect_delay;
int hex_notify_timeout; int hex_notify_timeout;
int hex_text_max_indent; int hex_text_max_indent;
int hex_text_wrap_align;
int hex_text_max_lines; int hex_text_max_lines;
int hex_url_grabber_limit; int hex_url_grabber_limit;
+7
View File
@@ -278,3 +278,10 @@ test('Emoji Font Tests', emoji_font_tests,
protocol: 'tap', protocol: 'tap',
timeout: 120, timeout: 120,
) )
xtext_tests = executable('xtext_tests',
['tests/test-xtext.c', '../common/hexcolor.c'],
include_directories: [config_h_include],
dependencies: [gtk_dep],
)
test('XText Tests', xtext_tests, protocol: 'tap', timeout: 120)
+38
View File
@@ -59,6 +59,8 @@ static struct zoitechatprefs setup_prefs;
static GtkWidget *cancel_button; static GtkWidget *cancel_button;
static GtkWidget *font_dialog = NULL; static GtkWidget *font_dialog = NULL;
static GtkWidget *setup_topicbar_multiline_toggle = NULL; static GtkWidget *setup_topicbar_multiline_toggle = NULL;
static GtkWidget *setup_wrap_align_label = NULL;
static GtkWidget *setup_wrap_align_combo = NULL;
enum enum
{ {
@@ -157,6 +159,14 @@ static const char *const langsmenu[] =
}; };
#endif #endif
static const char *const wrapalignmenu[] =
{
N_("Start of line (default)"),
N_("Prefix (nick name)"),
N_("Message"),
NULL
};
static const setting appearance_settings[] = static const setting appearance_settings[] =
{ {
{ST_HEADER, N_("General"),0,0,0}, {ST_HEADER, N_("General"),0,0,0},
@@ -172,6 +182,7 @@ static const setting appearance_settings[] =
{ST_TOGGLR, N_("Indent nick names"), P_OFFINTNL(hex_text_indent), N_("Make nick names right-justified"),0,0}, {ST_TOGGLR, N_("Indent nick names"), P_OFFINTNL(hex_text_indent), N_("Make nick names right-justified"),0,0},
{ST_TOGGLE, N_ ("Show marker line"), P_OFFINTNL (hex_text_show_marker), N_ ("Insert a red line after the last read text."), 0, 0}, {ST_TOGGLE, N_ ("Show marker line"), P_OFFINTNL (hex_text_show_marker), N_ ("Insert a red line after the last read text."), 0, 0},
{ST_TOGGLE, N_("Keep search position when closing"), P_OFFINTNL(hex_text_search_keep_position), 0, 0, 0}, {ST_TOGGLE, N_("Keep search position when closing"), P_OFFINTNL(hex_text_search_keep_position), 0, 0, 0},
{ST_MENU, N_("Align wrapped lines under:"), P_OFFINTNL(hex_text_wrap_align), N_("Where wrapped lines start when nick names are not indented"), wrapalignmenu, 0},
{ST_HEADER, N_("Timestamps"),0,0,0}, {ST_HEADER, N_("Timestamps"),0,0,0},
{ST_TOGGLE, N_("Enable timestamps"), P_OFFINTNL(hex_stamp_text),0,0,1}, {ST_TOGGLE, N_("Enable timestamps"), P_OFFINTNL(hex_stamp_text),0,0,1},
@@ -857,6 +868,20 @@ setup_topicbar_inline_toggled_cb (GtkToggleButton *but, gpointer userdata)
!gtk_toggle_button_get_active (but)); !gtk_toggle_button_get_active (but));
} }
static void
setup_text_indent_toggled_cb (GtkToggleButton *but, gpointer userdata)
{
gboolean sens = !gtk_toggle_button_get_active (but);
(void) userdata;
/* wrapped line alignment only applies without nick indentation */
if (setup_wrap_align_label)
gtk_widget_set_sensitive (setup_wrap_align_label, sens);
if (setup_wrap_align_combo)
gtk_widget_set_sensitive (setup_wrap_align_combo, sens);
}
static void static void
setup_create_toggleR (GtkWidget *tab, int row, const setting *set) setup_create_toggleR (GtkWidget *tab, int row, const setting *set)
{ {
@@ -867,6 +892,9 @@ setup_create_toggleR (GtkWidget *tab, int row, const setting *set)
setup_get_int (&setup_prefs, set)); setup_get_int (&setup_prefs, set));
g_signal_connect (G_OBJECT (wid), "toggled", g_signal_connect (G_OBJECT (wid), "toggled",
G_CALLBACK (setup_toggle_cb), (gpointer)set); G_CALLBACK (setup_toggle_cb), (gpointer)set);
if (set->offset == STRUCT_OFFSET_INT (struct zoitechatprefs, hex_text_indent))
g_signal_connect (G_OBJECT (wid), "toggled",
G_CALLBACK (setup_text_indent_toggled_cb), NULL);
if (set->tooltip) if (set->tooltip)
gtk_widget_set_tooltip_text (wid, _(set->tooltip)); gtk_widget_set_tooltip_text (wid, _(set->tooltip));
setup_table_attach (tab, wid, 4, 5, row, row + 1, TRUE, FALSE, setup_table_attach (tab, wid, 4, 5, row, row + 1, TRUE, FALSE,
@@ -1279,6 +1307,16 @@ setup_create_menu (GtkWidget *table, int row, const setting *set)
setup_table_attach (table, cbox, 3, 6, row, row + 1, TRUE, FALSE, setup_table_attach (table, cbox, 3, 6, row, row + 1, TRUE, FALSE,
SETUP_ALIGN_FILL, SETUP_ALIGN_FILL, 0, 0); SETUP_ALIGN_FILL, SETUP_ALIGN_FILL, 0, 0);
if (set->offset == STRUCT_OFFSET_INT (struct zoitechatprefs, hex_text_wrap_align))
{
setup_wrap_align_label = wid;
setup_wrap_align_combo = cbox;
g_object_add_weak_pointer (G_OBJECT (wid), (gpointer *)&setup_wrap_align_label);
g_object_add_weak_pointer (G_OBJECT (cbox), (gpointer *)&setup_wrap_align_combo);
gtk_widget_set_sensitive (wid, !setup_prefs.hex_text_indent);
gtk_widget_set_sensitive (cbox, !setup_prefs.hex_text_indent);
}
} }
static void static void
+597
View File
@@ -0,0 +1,597 @@
/* XText regression tests. Distributed under GPL-2.0-or-later; see COPYING.
* Include the implementation to check layout/selection invariants without
* adding test-only symbols to the widget's public API. Application services
* are stubbed; GTK, Pango, Cairo and the widget itself are exercised normally. */
#include "../xtext.c"
#include <glib/gstdio.h>
struct zoitechatprefs prefs;
void emoji_font_apply (GtkWidget *widget) { }
int url_last (int *start, int *end) { return 0; }
gsize strftime_utf8 (char *dest, gsize size, const char *format, time_t stamp)
{
return strftime (dest, size, format, localtime (&stamp));
}
int xtext_get_stamp_str (time_t stamp, char **out)
{
*out = g_strdup ("[12:34] ");
return strlen (*out);
}
void theme_get_xtext_colors_for_widget (GtkWidget *widget, XTextColor *colors, size_t len)
{
size_t i;
for (i = 0; i < len; i++)
{
colors[i].red = colors[i].green = colors[i].blue = 0.0;
colors[i].alpha = 1.0;
}
colors[XTEXT_FG].red = colors[XTEXT_FG].green = colors[XTEXT_FG].blue = 1.0;
colors[XTEXT_MARK_BG].blue = 1.0;
colors[XTEXT_MARK_FG] = colors[XTEXT_FG];
colors[XTEXT_MARKER].red = 1.0;
}
typedef struct { GtkWidget *window; GtkXText *xtext; } Fixture;
static void drain_events (void)
{
while (g_main_context_iteration (NULL, FALSE)) { }
}
static void fixture_setup (Fixture *f, gconstpointer data)
{
XTextColor colors[XTEXT_COLS];
GtkWidget *scrolled = gtk_scrolled_window_new (NULL, NULL);
theme_get_xtext_colors_for_widget (NULL, colors, G_N_ELEMENTS (colors));
f->window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
gtk_window_set_default_size (GTK_WINDOW (f->window), 640, 360);
f->xtext = GTK_XTEXT (gtk_xtext_new (colors, TRUE));
g_object_ref (f->xtext);
gtk_container_add (GTK_CONTAINER (scrolled), GTK_WIDGET (f->xtext));
gtk_container_add (GTK_CONTAINER (f->window), scrolled);
g_assert_true (gtk_xtext_set_font (f->xtext, "monospace 12"));
gtk_widget_show_all (f->window);
drain_events ();
}
static void fixture_teardown (Fixture *f, gconstpointer data)
{
gtk_widget_destroy (f->window);
g_object_unref (f->xtext);
drain_events ();
g_assert_null (image_pending_list);
}
static void append (Fixture *f, const char *text)
{
gtk_xtext_append (f->xtext->buffer, (guchar *)text, -1, 1234);
}
static cairo_surface_t *snapshot (Fixture *f, gboolean partial)
{
GtkWidget *widget = GTK_WIDGET (f->xtext);
int width = gtk_widget_get_allocated_width (widget);
int height = gtk_widget_get_allocated_height (widget);
cairo_surface_t *surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, width, height);
cairo_t *cr = cairo_create (surface);
if (partial)
{
cairo_rectangle (cr, 0, f->xtext->fontsize, width, height - f->xtext->fontsize);
cairo_clip (cr);
}
gtk_widget_draw (widget, cr);
g_assert_cmpint (cairo_status (cr), ==, CAIRO_STATUS_SUCCESS);
cairo_destroy (cr);
cairo_surface_flush (surface);
return surface;
}
static void test_empty_and_bounded_append (Fixture *f, gconstpointer data)
{
const guchar bytes[] = {'a', 'b', 'c'}; /* deliberately no terminating NUL */
append (f, "");
g_assert_cmpstr ((char *)f->xtext->buffer->text_last->str, ==, "");
g_assert_cmpint (f->xtext->buffer->text_last->subline_count, ==, 1);
append (f, "\n");
g_assert_cmpint (f->xtext->buffer->text_last->str_len, ==, 0);
gtk_xtext_append (f->xtext->buffer, (guchar *)bytes, sizeof (bytes), 1234);
g_assert_cmpstr ((char *)f->xtext->buffer->text_last->str, ==, "abc");
gtk_xtext_append_indent (f->xtext->buffer, (guchar *)"", 0, (guchar *)"", 0, 1234);
g_assert_cmpstr ((char *)f->xtext->buffer->text_last->str, ==, " ");
}
static void test_utf8_limits (Fixture *f, gconstpointer data)
{
GString *text = g_string_new (NULL);
int i;
for (i = 0; i < 1500; i++) g_string_append (text, "猫");
gtk_xtext_append (f->xtext->buffer, (guchar *)text->str, text->len, 1234);
g_assert_cmpint (f->xtext->buffer->text_last->str_len, ==, 4095);
g_assert_true (g_utf8_validate ((char *)f->xtext->buffer->text_last->str, -1, NULL));
gtk_xtext_append_indent (f->xtext->buffer, (guchar *)text->str, text->len,
(guchar *)"猫", -1, 1234);
g_assert_cmpint (f->xtext->buffer->text_last->str_len, <=, 4095);
g_assert_true (g_utf8_validate ((char *)f->xtext->buffer->text_last->str, -1, NULL));
gtk_xtext_append (f->xtext->buffer, (guchar *)"hello 猫", 8, 1234);
g_assert_cmpstr ((char *)f->xtext->buffer->text_last->str, ==, "hello ");
gtk_xtext_append (f->xtext->buffer, (guchar *)"ok\xff" "bad", 6, 1234);
g_assert_cmpstr ((char *)f->xtext->buffer->text_last->str, ==, "ok");
g_string_free (text, TRUE);
}
static void test_null_empty_prefix (Fixture *f, gconstpointer data)
{
xtext_buffer *buf = f->xtext->buffer;
/* PrintTextLine passes NULL/0 for indented server text without a tab. */
gtk_xtext_append_indent (buf, NULL, 0, (guchar *)"server notice", -1, 1234);
g_assert_cmpstr ((char *)buf->text_last->str, ==, " server notice");
g_assert_cmpint (buf->text_last->left_len, ==, 0);
g_assert_cmpint (buf->text_last->stamp, ==, 1234);
gtk_xtext_append_indent (buf, (guchar *)"nick", -1, NULL, 0, 1234);
g_assert_cmpstr ((char *)buf->text_last->str, ==, "nick ");
gtk_xtext_append_indent (buf, NULL, 0, NULL, 0, 1234);
g_assert_cmpstr ((char *)buf->text_last->str, ==, " ");
g_assert_cmpint (buf->num_lines, ==, 3);
cairo_surface_destroy (snapshot (f, FALSE));
}
static void test_wrapping (Fixture *f, gconstpointer data)
{
xtext_buffer *buf = f->xtext->buffer;
textentry *ent;
int start = 0, i;
append (f, "猫猫猫猫猫猫猫猫猫猫");
ent = buf->text_last;
/* A character wider than the row must still be kept whole. */
buf->window_width = 3;
gtk_xtext_lines_taken (buf, ent);
g_assert_cmpint (ent->subline_count, ==, 10);
for (i = 0; i < ent->subline_count; i++)
{
int end = gtk_xtext_subline_end (ent, i);
g_assert_cmpint (end, >, start);
g_assert_true (g_utf8_validate ((char *)ent->str + start, end - start, NULL));
start = end;
}
buf->window_width = 120;
gtk_xtext_lines_taken (buf, ent);
g_assert_cmpint (ent->subline_count, >, 1);
buf->window_width = 640;
gtk_xtext_lines_taken (buf, ent);
g_assert_cmpint (ent->subline_count, ==, 1);
}
static void test_font_isolation (Fixture *f, gconstpointer data)
{
Fixture second;
int original = gtk_xtext_text_width (f->xtext, (guchar *)"WWii hello", 10);
fixture_setup (&second, NULL);
g_assert_true (gtk_xtext_set_font (second.xtext, "sans 30"));
g_assert_cmpint (gtk_xtext_text_width (second.xtext, (guchar *)"WWii hello", 10), >, original);
g_assert_cmpint (gtk_xtext_text_width (f->xtext, (guchar *)"WWii hello", 10), ==, original);
fixture_teardown (&second, NULL);
g_assert_cmpint (gtk_xtext_text_width (f->xtext, (guchar *)"WWii hello", 10), ==, original);
}
static void test_wide_metrics (Fixture *f, gconstpointer data)
{
char *text = g_strnfill (4000, 'W');
g_assert_true (gtk_xtext_set_font (f->xtext, "sans 40"));
append (f, text);
g_assert_cmpint (f->xtext->buffer->text_last->str_width, >, 65535);
g_assert_cmpint (f->xtext->buffer->text_last->subline_count, >, 1);
g_free (text);
}
static void test_formatting (Fixture *f, gconstpointer data)
{
const char *formatted = "a\002bold\002 \035italic\035 \00304,02red\017 \037u\037 \036s\036 \026r\026";
char *plain;
GSList *runs = NULL;
int len;
plain = (char *)gtk_xtext_strip_color ((guchar *)formatted, strlen (formatted), NULL, &len, &runs, FALSE);
g_assert_cmpstr (plain, ==, "abold italic red u s r");
g_assert_cmpint (len, ==, strlen (plain));
g_assert_cmpint (((offlen_t *)runs->data)->off, ==, 0);
g_slist_free_full (runs, g_free);
g_free (plain);
plain = (char *)gtk_xtext_strip_color ((guchar *)"a\010secret\010b", 10, NULL, &len, NULL, TRUE);
g_assert_cmpstr (plain, ==, "ab");
g_free (plain);
append (f, formatted);
gtk_xtext_append_indent (f->xtext->buffer, (guchar *)"nick", -1, (guchar *)formatted, -1, 1234);
f->xtext->auto_indent = TRUE;
f->xtext->buffer->time_stamp = TRUE;
f->xtext->buffer->indent = 130;
gtk_xtext_recalc_widths (f->xtext->buffer, FALSE);
cairo_surface_destroy (snapshot (f, FALSE));
g_assert_cmpstr ((char *)f->xtext->buffer->text_last->str, ==,
"nick a\002bold\002 \035italic\035 \00304,02red\017 \037u\037 \036s\036 \026r\026");
}
static void select_entries (Fixture *f, textentry *start, textentry *end)
{
textentry *ent;
for (ent = start; ent; ent = ent->next)
{
ent->mark_start = 0;
ent->mark_end = ent->str_len;
if (ent == end) break;
}
gtk_xtext_selection_render (f->xtext, start, end);
f->xtext->selection_buffer = f->xtext->buffer;
}
static void test_selection_and_clipboard (Fixture *f, gconstpointer data)
{
char *selected;
int len;
append (f, "");
append (f, "\002bold\002 猫");
append (f, "last");
select_entries (f, f->xtext->buffer->text_first, f->xtext->buffer->text_last);
selected = gtk_xtext_selection_get_text (f->xtext, &len);
g_assert_cmpstr (selected, ==, "\nbold 猫\nlast");
g_assert_cmpint (len, ==, strlen (selected));
g_free (selected);
f->xtext->color_paste = TRUE;
f->xtext->mark_stamp = TRUE;
selected = gtk_xtext_selection_get_text (f->xtext, &len);
g_assert_cmpstr (selected, ==, "\n[12:34] \002bold\002 猫\n[12:34] last");
g_free (selected);
f->xtext->color_paste = f->xtext->mark_stamp = FALSE;
gtk_xtext_copy_selection (f->xtext);
selected = gtk_clipboard_wait_for_text (gtk_widget_get_clipboard (GTK_WIDGET (f->xtext), GDK_SELECTION_CLIPBOARD));
g_assert_cmpstr (selected, ==, "\nbold 猫\nlast");
g_free (selected);
selected = gtk_clipboard_wait_for_text (gtk_widget_get_clipboard (GTK_WIDGET (f->xtext), GDK_SELECTION_PRIMARY));
g_assert_cmpstr (selected, ==, "\nbold 猫\nlast");
g_free (selected);
gtk_xtext_unselect (f->xtext);
g_assert_false (gtk_xtext_is_selecting (f->xtext));
}
static void test_search (Fixture *f, gconstpointer data)
{
GError *error = NULL;
textentry *first;
xtext_buffer *buf = f->xtext->buffer;
append (f, "one \002needle\002 then NEEDLE");
first = buf->text_last;
append (f, "second needle");
g_assert_true (gtk_xtext_search (f->xtext, "needle", highlight, &error) == first);
g_assert_no_error (error);
g_assert_cmpint (g_list_length (first->marks), ==, 2);
g_assert_true (gtk_xtext_search (f->xtext, "needle", highlight, &error) == first);
g_assert_true (gtk_xtext_search (f->xtext, "needle", highlight, &error) == buf->text_last);
gtk_xtext_search (f->xtext, "", 0, &error);
g_assert_null (buf->search_found);
g_assert_true (gtk_xtext_search (f->xtext, "needle", backward | case_match, &error) == buf->text_last);
gtk_xtext_search (f->xtext, "n[a-z]+", regexp | case_match, &error);
g_assert_no_error (error);
g_assert_nonnull (buf->search_re);
gtk_xtext_search (f->xtext, "[", regexp, &error);
g_assert_error (error, G_REGEX_ERROR, G_REGEX_ERROR_UNTERMINATED_CHARACTER_CLASS);
g_clear_error (&error);
/* A no-match search must also release its regex/text on clear. */
gtk_xtext_search (f->xtext, "nomatch", regexp, &error);
g_assert_null (buf->search_found);
gtk_xtext_clear (buf, 0);
g_assert_null (buf->search_re);
g_assert_null (buf->search_text);
}
static void test_follow_search (Fixture *f, gconstpointer data)
{
xtext_buffer *buf = f->xtext->buffer;
append (f, "match first");
gtk_xtext_search (f->xtext, "match", 0, NULL);
append (f, "match second");
gtk_xtext_search (f->xtext, NULL, follow, NULL);
g_assert_cmpint (g_list_length (buf->search_found), ==, 2);
GList *current = buf->curmark;
gtk_xtext_search (f->xtext, NULL, 0, NULL);
gtk_xtext_search (f->xtext, NULL, follow, NULL);
g_assert_cmpint (g_list_length (buf->search_found), ==, 2);
g_assert_true (buf->curmark == current);
append (f, "match third");
g_assert_cmpint (g_list_length (buf->search_found), ==, 3);
}
static void test_search_unicode_offsets (Fixture *f, gconstpointer data)
{
xtext_buffer *buf = f->xtext->buffer;
offsets_t mark;
append (f, "İ \002NEEDLE\002 Straße");
gtk_xtext_search (f->xtext, "needle", 0, NULL);
mark.u = GPOINTER_TO_UINT (buf->text_first->marks->data);
g_assert_cmpint (mark.o.start, ==, 4);
/* The established color-offset mapping includes the closing control. */
g_assert_cmpint (mark.o.end, ==, 11);
gtk_xtext_search (f->xtext, "ss", 0, NULL);
mark.u = GPOINTER_TO_UINT (buf->text_first->marks->data);
g_assert_cmpint (mark.o.start, ==, 16);
g_assert_cmpint (mark.o.end, ==, 18);
gtk_xtext_clear (buf, 0);
append (f, "ſ needle");
gtk_xtext_search (f->xtext, "needle", 0, NULL);
mark.u = GPOINTER_TO_UINT (buf->text_first->marks->data);
g_assert_cmpint (mark.o.start, ==, 3);
g_assert_cmpint (mark.o.end, ==, 9);
}
static void test_rawlog_hidden_text (Fixture *f, gconstpointer data)
{
int hidden, visible;
append (f, "a\010secret\010b");
hidden = f->xtext->buffer->text_last->str_width;
f->xtext->ignore_hidden = TRUE;
gtk_xtext_recalc_widths (f->xtext->buffer, TRUE);
visible = f->xtext->buffer->text_last->str_width;
g_assert_cmpint (visible, >, hidden);
g_assert_cmpint (visible, ==, gtk_xtext_text_width (f->xtext, (guchar *)"asecretb", 8));
}
static void test_save (Fixture *f, gconstpointer data)
{
char *path, *saved;
GError *error = NULL;
int fd = g_file_open_tmp ("zoitechat-xtext-XXXXXX", &path, &error);
g_assert_no_error (error);
append (f, "\002bold\002 猫");
append (f, "");
append (f, "last");
gtk_xtext_save (f->xtext, fd);
close (fd);
g_assert_true (g_file_get_contents (path, &saved, NULL, &error));
g_assert_no_error (error);
g_assert_cmpstr (saved, ==, "bold 猫\n\nlast\n");
g_free (saved);
g_unlink (path);
g_free (path);
}
static void test_scrollable_ownership (Fixture *f, gconstpointer data)
{
GtkAdjustment *horizontal = GTK_ADJUSTMENT (gtk_adjustment_new (0, 0, 1, 1, 1, 1));
GtkAdjustment *vertical = GTK_ADJUSTMENT (gtk_adjustment_new (0, 0, 100, 1, 10, 10));
GtkAdjustment *old = g_object_ref (f->xtext->adj);
g_object_set (f->xtext, "hadjustment", horizontal, "vadjustment", vertical, NULL);
g_assert_false (g_object_is_floating (horizontal));
g_assert_false (g_object_is_floating (vertical));
g_assert_true (f->xtext->hadj == horizontal);
g_assert_true (f->xtext->adj == vertical);
/* A replaced adjustment must no longer call into the widget. */
g_assert_cmpuint (g_signal_handler_find (old, G_SIGNAL_MATCH_DATA, 0, 0, NULL, NULL, f->xtext), ==, 0);
g_signal_emit_by_name (f->xtext, "set-scroll-adjustments", horizontal, vertical);
g_assert_true (f->xtext->adj == vertical);
g_object_set (f->xtext, "hadjustment", NULL, "vadjustment", NULL, NULL);
g_assert_true (GTK_IS_ADJUSTMENT (f->xtext->hadj));
g_assert_true (GTK_IS_ADJUSTMENT (f->xtext->adj));
g_object_unref (old);
}
static void test_clear_and_marker (Fixture *f, gconstpointer data)
{
xtext_buffer *buf = f->xtext->buffer;
append (f, "first"); append (f, "second"); append (f, "third");
buf->marker_pos = buf->text_first;
buf->marker_state = MARKER_IS_SET;
gtk_xtext_clear (buf, 1);
g_assert_cmpstr ((char *)buf->text_first->str, ==, "second");
g_assert_cmpint (buf->marker_state, ==, MARKER_RESET_BY_CLEAR);
gtk_xtext_clear (buf, -1);
g_assert_cmpstr ((char *)buf->text_last->str, ==, "second");
select_entries (f, buf->text_first, buf->text_last);
f->xtext->hilight_ent = buf->text_first;
gtk_xtext_clear (buf, 0);
g_assert_null (f->xtext->hilight_ent);
g_assert_null (buf->pagetop_ent);
g_assert_null (buf->last_ent_start);
g_assert_cmpint (buf->num_lines, ==, 0);
g_assert_true (gtk_xtext_is_empty (buf));
append (f, "after clear");
g_assert_cmpint (buf->num_lines, ==, 1);
}
static void test_scrollback_limit (Fixture *f, gconstpointer data)
{
int i;
xtext_buffer *buf = f->xtext->buffer;
gtk_xtext_set_max_lines (f->xtext, 10);
for (i = 0; i < 100; i++) append (f, "line");
g_assert_cmpint (buf->num_lines, ==, 10);
g_assert_null (buf->text_first->prev);
g_assert_null (buf->text_last->next);
g_assert_cmpfloat (gtk_adjustment_get_value (f->xtext->adj), >=, 0);
}
static void test_follow_trim_oversized_entry (Fixture *f, gconstpointer data)
{
char *long_text = g_strnfill (4000, 'W');
gtk_xtext_set_max_lines (f->xtext, 3);
append (f, "needle");
gtk_xtext_search (f->xtext, "W", follow, NULL);
gtk_xtext_clear (f->xtext->buffer, 1);
append (f, long_text);
g_assert_true (gtk_xtext_is_empty (f->xtext->buffer));
g_assert_null (f->xtext->buffer->search_found);
g_free (long_text);
append (f, "after oversized");
gtk_xtext_clear (f->xtext->buffer, G_MININT);
g_assert_true (gtk_xtext_is_empty (f->xtext->buffer));
}
static void test_stress (Fixture *f, gconstpointer data)
{
static const char *tokens[] = {"text ", "猫", "😀", "\002bold\002", "\00304,02red\017", "\010hidden\010", "\037u\037", "\036s\036"};
GRand *random = g_rand_new_with_seed (0x78746578);
xtext_buffer *buf = f->xtext->buffer;
int i;
gtk_xtext_set_max_lines (f->xtext, 80);
for (i = 0; i < 2000; i++)
{
GString *text = g_string_new (NULL);
textentry *ent;
int j, lines = 0;
for (j = 0; j < 30; j++)
g_string_append (text, tokens[g_rand_int_range (random, 0, G_N_ELEMENTS (tokens))]);
if (i % 2)
gtk_xtext_append_indent (buf, (guchar *)"nick", -1, (guchar *)text->str, text->len, 1234);
else
gtk_xtext_append (buf, (guchar *)text->str, text->len, 1234);
g_string_free (text, TRUE);
if (i % 29 == 0) gtk_xtext_search (f->xtext, "text", follow | highlight, NULL);
if (i % 31 == 0) gtk_xtext_clear (buf, 1);
if (i % 37 == 0) gtk_xtext_clear (buf, -1);
if (i % 101 == 0) gtk_xtext_clear (buf, 0);
for (ent = buf->text_first; ent; ent = ent->next)
{
g_assert_true (g_utf8_validate ((char *)ent->str, ent->str_len, NULL));
g_assert_cmpint (ent->subline_count, >, 0);
lines += ent->subline_count;
}
g_assert_cmpint (buf->num_lines, ==, lines);
if (i % 43 == 0) cairo_surface_destroy (snapshot (f, FALSE));
}
g_rand_free (random);
}
static void test_buffers (Fixture *f, gconstpointer data)
{
xtext_buffer *original = f->xtext->buffer;
xtext_buffer *second = gtk_xtext_buffer_new (f->xtext);
append (f, "original");
gtk_xtext_append (second, (guchar *)"alternate", -1, 1234);
gtk_xtext_buffer_show (f->xtext, second, TRUE);
g_assert_true (f->xtext->buffer == second);
cairo_surface_destroy (snapshot (f, FALSE));
gtk_xtext_buffer_show (f->xtext, original, TRUE);
g_assert_cmpstr ((char *)f->xtext->buffer->text_first->str, ==, "original");
gtk_xtext_buffer_free (second);
}
static void test_partial_draw_after_scroll (Fixture *f, gconstpointer data)
{
cairo_surface_t *partial, *full;
int i, stride, height, y;
for (i = 0; i < 80; i++)
{
char *line = g_strdup_printf ("line %d — 猫 \002bold\002", i);
append (f, line);
g_free (line);
}
cairo_surface_destroy (snapshot (f, FALSE));
gtk_adjustment_set_value (f->xtext->adj, 12.5);
partial = snapshot (f, TRUE);
full = snapshot (f, FALSE);
stride = cairo_image_surface_get_stride (full);
height = cairo_image_surface_get_height (full);
for (y = f->xtext->fontsize; y < height; y++)
g_assert_cmpmem (cairo_image_surface_get_data (partial) + y * stride, stride,
cairo_image_surface_get_data (full) + y * stride, stride);
cairo_surface_destroy (partial);
cairo_surface_destroy (full);
}
static void test_image_lifecycle (Fixture *f, gconstpointer data)
{
GdkPixbuf *image = gdk_pixbuf_new (GDK_COLORSPACE_RGB, TRUE, 8, 800, 600);
xtext_buffer *buf = f->xtext->buffer;
textentry *ent;
guint handle;
int before;
gdk_pixbuf_fill (image, 0xff0000ff);
append (f, "image");
ent = buf->text_last;
before = buf->num_lines;
handle = gtk_xtext_image_load_begin (f->xtext, ent, "https://example.invalid/image.png");
g_assert_cmpuint (handle, !=, 0);
g_assert_cmpuint (gtk_xtext_image_load_begin (f->xtext, ent, "duplicate"), ==, 0);
g_assert_true (gtk_xtext_image_load_finish (handle, image));
g_assert_cmpint (buf->num_lines, >, before);
g_assert_true (gtk_xtext_entry_has_image (f->xtext, ent));
g_assert_cmpint (gdk_pixbuf_get_width (ent->image), <=, XTEXT_IMAGE_MAX_WIDTH);
g_assert_true (gtk_xtext_entry_get_full_image (f->xtext, ent) == image);
cairo_surface_destroy (snapshot (f, FALSE));
g_assert_true (gtk_xtext_image_remove (f->xtext, ent));
g_assert_cmpint (buf->num_lines, ==, before);
handle = gtk_xtext_image_load_begin (f->xtext, ent, "late");
gtk_xtext_clear (buf, 0);
g_assert_false (gtk_xtext_image_load_finish (handle, image));
g_assert_false (gtk_xtext_entry_has_image (f->xtext, ent));
g_assert_null (gtk_xtext_entry_get_full_image (f->xtext, ent));
g_object_unref (image);
}
static void test_background (Fixture *f, gconstpointer data)
{
cairo_surface_t *background = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, 32, 32);
cairo_t *cr = cairo_create (background);
cairo_set_source_rgb (cr, 0.2, 0.3, 0.4);
cairo_paint (cr);
cairo_destroy (cr);
gtk_xtext_set_background (f->xtext, background);
cairo_surface_destroy (background);
gtk_xtext_set_background (f->xtext, f->xtext->background_surface);
append (f, "background text");
cairo_surface_destroy (snapshot (f, FALSE));
gtk_xtext_set_background (f->xtext, NULL);
cairo_surface_destroy (snapshot (f, FALSE));
}
static void test_destroy_pending_sources (Fixture *f, gconstpointer data)
{
guint image;
append (f, "pending");
image = gtk_xtext_image_load_begin (f->xtext, f->xtext->buffer->text_last, "late");
f->xtext->io_tag = g_timeout_add (10000, gtk_xtext_adjustment_timeout, f->xtext);
f->xtext->add_io_tag = g_timeout_add (10000, gtk_xtext_render_page_timeout, f->xtext);
f->xtext->scroll_tag = g_timeout_add (10000, gtk_xtext_scrollup_timeout, f->xtext);
gtk_widget_destroy (f->window);
g_assert_cmpint (f->xtext->io_tag, ==, 0);
g_assert_cmpint (f->xtext->add_io_tag, ==, 0);
g_assert_cmpint (f->xtext->scroll_tag, ==, 0);
g_assert_false (gtk_xtext_image_load_finish (image, NULL));
/* GtkWidget destruction must be safe if GObject dispose runs again. */
g_object_run_dispose (G_OBJECT (f->xtext));
f->window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
}
int main (int argc, char **argv)
{
g_test_init (&argc, &argv, NULL);
if (!gtk_init_check (&argc, &argv))
{
g_test_message ("GTK display unavailable; run under Xvfb for widget coverage");
return 77;
}
prefs.hex_gui_mouse_scroll_speed = 10;
#define ADD(name, function) g_test_add ("/xtext/" name, Fixture, NULL, fixture_setup, function, fixture_teardown)
ADD ("append/empty-bounded", test_empty_and_bounded_append);
ADD ("append/utf8-limits", test_utf8_limits);
ADD ("append/null-empty-prefix", test_null_empty_prefix);
ADD ("layout/wrapping", test_wrapping);
ADD ("layout/font-isolation", test_font_isolation);
ADD ("layout/wide-metrics", test_wide_metrics);
ADD ("render/formatting-timestamps", test_formatting);
ADD ("selection/clipboard", test_selection_and_clipboard);
ADD ("search/navigation-regex-clear", test_search);
ADD ("search/follow", test_follow_search);
ADD ("search/unicode-offsets", test_search_unicode_offsets);
ADD ("render/rawlog-hidden", test_rawlog_hidden_text);
ADD ("buffer/save", test_save);
ADD ("lifecycle/scrollable-ownership", test_scrollable_ownership);
ADD ("buffer/clear-marker", test_clear_and_marker);
ADD ("buffer/scrollback-limit", test_scrollback_limit);
ADD ("buffer/follow-trim-oversized", test_follow_trim_oversized_entry);
ADD ("buffer/stress", test_stress);
ADD ("buffer/switch", test_buffers);
ADD ("render/partial-scroll", test_partial_draw_after_scroll);
ADD ("images/lifecycle", test_image_lifecycle);
ADD ("render/background", test_background);
ADD ("lifecycle/pending-sources", test_destroy_pending_sources);
#undef ADD
return g_test_run ();
}
+1 -1
View File
@@ -92,7 +92,7 @@ PrintTextLine (xtext_buffer *xtbuf, unsigned char *text, int len, int indent, ti
memcpy (new_text, stamp, stamp_size); memcpy (new_text, stamp, stamp_size);
g_free (stamp); g_free (stamp);
memcpy (new_text + stamp_size, text, len); memcpy (new_text + stamp_size, text, len);
gtk_xtext_append (xtbuf, new_text, len + stamp_size, timet); gtk_xtext_append_wrap (xtbuf, new_text, len + stamp_size, timet, stamp_size);
g_free (new_text); g_free (new_text);
} else } else
gtk_xtext_append (xtbuf, text, len, timet); gtk_xtext_append (xtbuf, text, len, timet);
+586 -1079
View File
File diff suppressed because it is too large Load Diff
+6
View File
@@ -38,6 +38,7 @@ GType gtk_xtext_get_type (void);
#define ATTR_BOLD '\002' #define ATTR_BOLD '\002'
#define ATTR_COLOR '\003' #define ATTR_COLOR '\003'
#define ATTR_HEXCOLOR '\004'
#define ATTR_BLINK '\006' #define ATTR_BLINK '\006'
#define ATTR_BEEP '\007' #define ATTR_BEEP '\007'
#define ATTR_HIDDEN '\010' #define ATTR_HIDDEN '\010'
@@ -57,6 +58,8 @@ GType gtk_xtext_get_type (void);
#define XTEXT_BG 102 #define XTEXT_BG 102
#define XTEXT_MARKER 103 /* for marker line */ #define XTEXT_MARKER 103 /* for marker line */
#define XTEXT_MAX_COLOR 98 #define XTEXT_MAX_COLOR 98
#define XTEXT_HEX_FG 200 /* not palette slots: colors from \004RRGGBB */
#define XTEXT_HEX_BG 201
typedef struct textentry textentry; typedef struct textentry textentry;
/* /*
@@ -181,6 +184,8 @@ struct _GtkXText
int col_fore; int col_fore;
int col_back; int col_back;
XTextColor hex_fg;
XTextColor hex_bg;
int depth; /* gdk window depth */ int depth; /* gdk window depth */
@@ -276,6 +281,7 @@ struct _GtkXTextClass
GtkWidget *gtk_xtext_new (const XTextColor *palette, int separator); GtkWidget *gtk_xtext_new (const XTextColor *palette, int separator);
void gtk_xtext_append (xtext_buffer *buf, unsigned char *text, int len, time_t stamp); void gtk_xtext_append (xtext_buffer *buf, unsigned char *text, int len, time_t stamp);
void gtk_xtext_append_wrap (xtext_buffer *buf, unsigned char *text, int len, time_t stamp, int stamp_len);
void gtk_xtext_append_indent (xtext_buffer *buf, void gtk_xtext_append_indent (xtext_buffer *buf,
unsigned char *left_text, int left_len, unsigned char *left_text, int left_len,
unsigned char *right_text, int right_len, unsigned char *right_text, int right_len,
-2
View File
@@ -90,7 +90,6 @@
<MSWindowsTheme Include="$(DepsRoot)\share\themes\MS-Windows\**\*" /> <MSWindowsTheme Include="$(DepsRoot)\share\themes\MS-Windows\**\*" />
<HicolorIcons Include="$(DepsRoot)\share\icons\hicolor\index.theme" /> <HicolorIcons Include="$(DepsRoot)\share\icons\hicolor\index.theme" />
<HicolorIcons Include="$(DepsRoot)\share\icons\hicolor\**\*.*" /> <HicolorIcons Include="$(DepsRoot)\share\icons\hicolor\**\*.*" />
<PythonAdditiveApis Include="..\..\plugins\python\_zoitechat_*.py" />
</ItemGroup> </ItemGroup>
<Copy SourceFiles="@(None)" DestinationFolder="$(ZoiteChatRel)" /> <Copy SourceFiles="@(None)" DestinationFolder="$(ZoiteChatRel)" />
@@ -116,7 +115,6 @@
<Copy SourceFiles="..\..\plugins\python\hexchat.py" DestinationFolder="$(ZoiteChatRel)\python" Condition="'$(Python3Enabled)'=='true' or '$(Python38Enabled)'=='true'" /> <Copy SourceFiles="..\..\plugins\python\hexchat.py" DestinationFolder="$(ZoiteChatRel)\python" Condition="'$(Python3Enabled)'=='true' or '$(Python38Enabled)'=='true'" />
<Copy SourceFiles="..\..\plugins\python\zoitechat.py" DestinationFolder="$(ZoiteChatRel)\python" Condition="'$(Python3Enabled)'=='true' or '$(Python38Enabled)'=='true'" /> <Copy SourceFiles="..\..\plugins\python\zoitechat.py" DestinationFolder="$(ZoiteChatRel)\python" Condition="'$(Python3Enabled)'=='true' or '$(Python38Enabled)'=='true'" />
<Copy SourceFiles="..\..\plugins\python\_zoitechat.py" DestinationFolder="$(ZoiteChatRel)\python" Condition="'$(Python3Enabled)'=='true' or '$(Python38Enabled)'=='true'" /> <Copy SourceFiles="..\..\plugins\python\_zoitechat.py" DestinationFolder="$(ZoiteChatRel)\python" Condition="'$(Python3Enabled)'=='true' or '$(Python38Enabled)'=='true'" />
<Copy SourceFiles="@(PythonAdditiveApis)" DestinationFolder="$(ZoiteChatRel)\python" Condition="('$(Python3Enabled)'=='true' or '$(Python38Enabled)'=='true') and '@(PythonAdditiveApis)' != ''" />
<WriteLinesToFile File="$(ZoiteChatRel)portable-mode" Lines="2" Overwrite="true" /> <WriteLinesToFile File="$(ZoiteChatRel)portable-mode" Lines="2" Overwrite="true" />
+82
View File
@@ -0,0 +1,82 @@
<?xml version="1.0" encoding="utf-8"?>
<Package
xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3"
xmlns:uap10="http://schemas.microsoft.com/appx/manifest/uap/windows10/10"
xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
IgnorableNamespaces="uap uap3 uap10 rescap">
<!--
Identity values are filled by build-msix.ps1. For Microsoft Store
submissions they must exactly match Product management > Product identity
in Partner Center.
-->
<Identity
Name="@IDENTITY_NAME@"
Publisher="@PUBLISHER@"
Version="@PACKAGE_VERSION@"
ProcessorArchitecture="x64" />
<Properties>
<DisplayName>ZoiteChat</DisplayName>
<PublisherDisplayName>@PUBLISHER_DISPLAY_NAME@</PublisherDisplayName>
<Description>ZoiteChat IRC client</Description>
<Logo>Assets\StoreLogo.png</Logo>
</Properties>
<Resources>
<Resource Language="en-us" />
</Resources>
<Dependencies>
<TargetDeviceFamily
Name="Windows.Desktop"
MinVersion="10.0.19041.0"
MaxVersionTested="10.0.26100.0" />
<PackageDependency
Name="Microsoft.VCLibs.140.00.UWPDesktop"
Publisher="CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US"
MinVersion="14.0.30704.0" />
</Dependencies>
<Capabilities>
<rescap:Capability Name="runFullTrust" />
</Capabilities>
<Applications>
<Application
Id="ZoiteChat"
Executable="ZoiteChat\zoitechat.exe"
uap10:RuntimeBehavior="packagedClassicApp"
uap10:TrustLevel="mediumIL">
<uap:VisualElements
DisplayName="ZoiteChat"
Description="ZoiteChat IRC client"
BackgroundColor="transparent"
Square150x150Logo="Assets\Square150x150Logo.png"
Square44x44Logo="Assets\Square44x44Logo.png" />
<Extensions>
<uap3:Extension Category="windows.protocol">
<uap3:Protocol
Name="irc"
Parameters="--url=&quot;%1&quot;" />
</uap3:Extension>
<uap3:Extension Category="windows.fileTypeAssociation">
<uap3:FileTypeAssociation
Name="zoitechattheme"
Parameters="&quot;%1&quot;">
<uap:DisplayName>ZoiteChat Theme</uap:DisplayName>
<uap:SupportedFileTypes>
<uap:FileType>.zct</uap:FileType>
<uap:FileType>.hct</uap:FileType>
</uap:SupportedFileTypes>
</uap3:FileTypeAssociation>
</uap3:Extension>
</Extensions>
</Application>
</Applications>
</Package>
+392
View File
@@ -0,0 +1,392 @@
[CmdletBinding()]
param(
[Parameter(Mandatory = $true)]
[string] $SourceDir,
[Parameter(Mandatory = $true)]
[string] $OutputPath,
[Parameter(Mandatory = $true)]
[ValidatePattern('^\d+\.\d+\.\d+\.0$')]
[string] $PackageVersion,
[Parameter(Mandatory = $true)]
[string] $IdentityName,
[Parameter(Mandatory = $true)]
[string] $Publisher,
[Parameter(Mandatory = $true)]
[string] $PublisherDisplayName,
[switch] $SelfSign
)
Set-StrictMode -Version Latest
$ErrorActionPreference = 'Stop'
Add-Type -AssemblyName System.Drawing
function Find-WindowsSdkTool {
param(
[Parameter(Mandatory = $true)]
[string] $ToolName
)
$command = Get-Command $ToolName -ErrorAction SilentlyContinue
if ($command) {
return $command.Source
}
$kitsRoot = Join-Path ${env:ProgramFiles(x86)} 'Windows Kits\10\bin'
if (-not (Test-Path $kitsRoot)) {
throw "Windows SDK bin directory was not found: $kitsRoot"
}
$tool = Get-ChildItem -Path $kitsRoot -Filter $ToolName -File -Recurse |
Where-Object { $_.FullName -match '\\x64\\' } |
Sort-Object {
$versionDirectory = Split-Path (Split-Path $_.DirectoryName -Parent) -Leaf
try {
[version] $versionDirectory
}
catch {
[version] '0.0'
}
} -Descending |
Select-Object -First 1
if (-not $tool) {
throw "$ToolName was not found in the installed Windows SDK."
}
return $tool.FullName
}
function Escape-Xml {
param(
[Parameter(Mandatory = $true)]
[string] $Value
)
return [System.Security.SecurityElement]::Escape($Value)
}
function New-MsixAsset {
param(
[Parameter(Mandatory = $true)]
[System.Drawing.Image] $SourceImage,
[Parameter(Mandatory = $true)]
[int] $Width,
[Parameter(Mandatory = $true)]
[int] $Height,
[Parameter(Mandatory = $true)]
[string] $Path
)
$bitmap = [System.Drawing.Bitmap]::new($Width, $Height)
try {
$graphics = [System.Drawing.Graphics]::FromImage($bitmap)
try {
$graphics.Clear([System.Drawing.Color]::Transparent)
$graphics.InterpolationMode = [System.Drawing.Drawing2D.InterpolationMode]::HighQualityBicubic
$graphics.PixelOffsetMode = [System.Drawing.Drawing2D.PixelOffsetMode]::HighQuality
$graphics.SmoothingMode = [System.Drawing.Drawing2D.SmoothingMode]::HighQuality
$scale = [Math]::Min($Width / $SourceImage.Width, $Height / $SourceImage.Height)
$drawWidth = [Math]::Max(1, [int][Math]::Round($SourceImage.Width * $scale))
$drawHeight = [Math]::Max(1, [int][Math]::Round($SourceImage.Height * $scale))
$x = [int](($Width - $drawWidth) / 2)
$y = [int](($Height - $drawHeight) / 2)
$graphics.DrawImage($SourceImage, $x, $y, $drawWidth, $drawHeight)
}
finally {
$graphics.Dispose()
}
$bitmap.Save($Path, [System.Drawing.Imaging.ImageFormat]::Png)
}
finally {
$bitmap.Dispose()
}
}
$source = (Resolve-Path $SourceDir).Path
if (-not (Test-Path (Join-Path $source 'zoitechat.exe'))) {
throw "Staged ZoiteChat executable is missing from $source"
}
$repoRoot = (Resolve-Path (Join-Path $PSScriptRoot '..\..')).Path
$templatePath = Join-Path $PSScriptRoot 'AppxManifest.xml.in'
$iconPath = Join-Path $repoRoot 'data\icons\zoitechat.png'
if (-not (Test-Path $templatePath)) {
throw "MSIX manifest template is missing: $templatePath"
}
if (-not (Test-Path $iconPath)) {
throw "ZoiteChat PNG icon is missing: $iconPath"
}
if ([System.IO.Path]::IsPathRooted($OutputPath)) {
$output = [System.IO.Path]::GetFullPath($OutputPath)
}
else {
$output = [System.IO.Path]::GetFullPath((Join-Path $PWD $OutputPath))
}
$outputDirectory = Split-Path $output -Parent
New-Item -ItemType Directory -Path $outputDirectory -Force | Out-Null
$stagingRoot = Join-Path $env:RUNNER_TEMP 'zoitechat-msix'
$verifyRoot = Join-Path $env:RUNNER_TEMP 'zoitechat-msix-verify'
$pfxPath = Join-Path $env:RUNNER_TEMP 'zoitechat-msix-dev.pfx'
foreach ($path in @($stagingRoot, $verifyRoot)) {
if (Test-Path $path) {
Remove-Item -Path $path -Recurse -Force
}
}
if (Test-Path $pfxPath) {
Remove-Item -Path $pfxPath -Force
}
New-Item -ItemType Directory -Path $stagingRoot -Force | Out-Null
$appRoot = Join-Path $stagingRoot 'ZoiteChat'
New-Item -ItemType Directory -Path $appRoot -Force | Out-Null
Copy-Item -Path (Join-Path $source '*') -Destination $appRoot -Recurse -Force
# copy.vcxproj stages everything needed by every Inno component. The Store
# package keeps the useful bundled plugins and scripting bridges while letting
# the Microsoft Store own application updates. The WinSparkle updater is the
# only bundled plugin deliberately removed from the Store package.
$excludeFiles = @(
'portable-mode',
'zoitechat-text.exe',
'plugins\hcupd.dll',
'WinSparkle.dll',
'share\download.png'
)
foreach ($relativePath in $excludeFiles) {
$path = Join-Path $appRoot $relativePath
if (Test-Path $path) {
Remove-Item -Path $path -Force
}
}
foreach ($relativePath in @('share\doc\WinSparkle')) {
$path = Join-Path $appRoot $relativePath
if (Test-Path $path) {
Remove-Item -Path $path -Recurse -Force
}
}
foreach ($requiredPath in @(
'zoitechat.exe',
'plugins\hcnotifications-winrt.dll',
'plugins\hcchecksum.dll',
'plugins\hcexec.dll',
'plugins\hcfishlim.dll',
'plugins\hcsysinfo.dll',
'share\system.png',
'share\fonts\zoitechat\NotoColorEmoji.ttf',
'share\doc\zoitechat\fonts\OFL.txt',
'plugins\hclua.dll',
'plugins\hcperl.dll',
'plugins\hcpython3.dll',
'plugins\hcpython38.dll'
)) {
if (-not (Test-Path (Join-Path $appRoot $requiredPath))) {
throw "MSIX staging is missing required file: $requiredPath"
}
}
foreach ($requiredPattern in @('_cffi_backend.cp314*.pyd', '_cffi_backend.cp38*.pyd')) {
$match = Get-ChildItem -Path $appRoot -Filter $requiredPattern -File -ErrorAction SilentlyContinue |
Select-Object -First 1
if ($null -eq $match) {
throw "MSIX staging is missing required Python support file: $requiredPattern"
}
}
foreach ($requiredPythonFile in @('zoitechat.py', '_zoitechat.py', 'hexchat.py', 'xchat.py')) {
$path = Join-Path (Join-Path $appRoot 'python') $requiredPythonFile
if (-not (Test-Path $path)) {
throw "MSIX staging is missing required Python bridge file: $requiredPythonFile"
}
}
$assets = Join-Path $stagingRoot 'Assets'
New-Item -ItemType Directory -Path $assets -Force | Out-Null
$image = [System.Drawing.Image]::FromFile($iconPath)
try {
New-MsixAsset -SourceImage $image -Width 50 -Height 50 `
-Path (Join-Path $assets 'StoreLogo.png')
New-MsixAsset -SourceImage $image -Width 44 -Height 44 `
-Path (Join-Path $assets 'Square44x44Logo.png')
New-MsixAsset -SourceImage $image -Width 150 -Height 150 `
-Path (Join-Path $assets 'Square150x150Logo.png')
}
finally {
$image.Dispose()
}
$manifest = Get-Content $templatePath -Raw -Encoding UTF8
$manifest = $manifest.Replace('@IDENTITY_NAME@', (Escape-Xml $IdentityName))
$manifest = $manifest.Replace('@PUBLISHER@', (Escape-Xml $Publisher))
$manifest = $manifest.Replace('@PUBLISHER_DISPLAY_NAME@', (Escape-Xml $PublisherDisplayName))
$manifest = $manifest.Replace('@PACKAGE_VERSION@', (Escape-Xml $PackageVersion))
if ($manifest -match '@[A-Z0-9_]+@') {
throw "Unexpanded MSIX manifest placeholder: $($Matches[0])"
}
$manifestPath = Join-Path $stagingRoot 'AppxManifest.xml'
[System.IO.File]::WriteAllText(
$manifestPath,
$manifest,
[System.Text.UTF8Encoding]::new($false)
)
# Catch malformed XML before MakeAppx so CI reports a useful error.
[xml](Get-Content $manifestPath -Raw -Encoding UTF8) | Out-Null
$makeAppx = Find-WindowsSdkTool -ToolName 'MakeAppx.exe'
$signtool = Find-WindowsSdkTool -ToolName 'SignTool.exe'
if (Test-Path $output) {
Remove-Item -Path $output -Force
}
& $makeAppx pack /d $stagingRoot /p $output /o
if ($LASTEXITCODE -ne 0) {
throw "MakeAppx failed with exit code $LASTEXITCODE"
}
$certificate = $null
try {
if ($SelfSign) {
# Partner Center replaces this development signature with Microsoft's
# trusted Store signature. The certificate subject must exactly match
# the manifest Publisher for SignTool to accept the package.
$certificate = New-SelfSignedCertificate `
-Type Custom `
-KeyUsage DigitalSignature `
-Subject $Publisher `
-CertStoreLocation 'Cert:\CurrentUser\My' `
-HashAlgorithm SHA256 `
-TextExtension @(
'2.5.29.37={text}1.3.6.1.5.5.7.3.3',
'2.5.29.19={text}'
) `
-FriendlyName 'ZoiteChat MSIX CI signing certificate'
if ($certificate.Subject -cne $Publisher) {
throw "Generated certificate subject '$($certificate.Subject)' does not exactly match manifest Publisher '$Publisher'."
}
$passwordText = [Guid]::NewGuid().ToString('N')
$password = ConvertTo-SecureString -String $passwordText -AsPlainText -Force
Export-PfxCertificate -Cert $certificate -FilePath $pfxPath -Password $password | Out-Null
& $signtool sign /fd SHA256 /f $pfxPath /p $passwordText $output
if ($LASTEXITCODE -ne 0) {
throw "SignTool failed with exit code $LASTEXITCODE"
}
$signature = Get-AuthenticodeSignature -FilePath $output
if (-not $signature.SignerCertificate -or
$signature.SignerCertificate.Subject -cne $Publisher) {
throw 'MSIX signature does not match the manifest Publisher.'
}
}
New-Item -ItemType Directory -Path $verifyRoot -Force | Out-Null
& $makeAppx unpack /p $output /d $verifyRoot /o
if ($LASTEXITCODE -ne 0) {
throw "MakeAppx validation unpack failed with exit code $LASTEXITCODE"
}
[xml] $verifiedManifest = Get-Content (Join-Path $verifyRoot 'AppxManifest.xml') -Raw -Encoding UTF8
$ns = New-Object System.Xml.XmlNamespaceManager($verifiedManifest.NameTable)
$ns.AddNamespace('f', 'http://schemas.microsoft.com/appx/manifest/foundation/windows10')
$identity = $verifiedManifest.SelectSingleNode('/f:Package/f:Identity', $ns)
if (-not $identity) {
throw 'Validated MSIX does not contain a package Identity.'
}
if ($identity.Name -cne $IdentityName -or
$identity.Publisher -cne $Publisher -or
$identity.Version -cne $PackageVersion) {
throw 'Validated MSIX identity does not match the requested Store identity.'
}
foreach ($requiredPath in @(
'ZoiteChat\zoitechat.exe',
'ZoiteChat\plugins\hcnotifications-winrt.dll',
'ZoiteChat\plugins\hcchecksum.dll',
'ZoiteChat\plugins\hcexec.dll',
'ZoiteChat\plugins\hcfishlim.dll',
'ZoiteChat\plugins\hcsysinfo.dll',
'ZoiteChat\share\system.png',
'ZoiteChat\share\fonts\zoitechat\NotoColorEmoji.ttf',
'ZoiteChat\share\doc\zoitechat\fonts\OFL.txt',
'ZoiteChat\plugins\hclua.dll',
'ZoiteChat\plugins\hcperl.dll',
'ZoiteChat\plugins\hcpython3.dll',
'ZoiteChat\plugins\hcpython38.dll'
)) {
if (-not (Test-Path (Join-Path $verifyRoot $requiredPath))) {
throw "Validated MSIX is missing required file: $requiredPath"
}
}
foreach ($requiredPattern in @('_cffi_backend.cp314*.pyd', '_cffi_backend.cp38*.pyd')) {
$match = Get-ChildItem -Path (Join-Path $verifyRoot 'ZoiteChat') -Filter $requiredPattern -File -ErrorAction SilentlyContinue |
Select-Object -First 1
if ($null -eq $match) {
throw "Validated MSIX is missing required Python support file: $requiredPattern"
}
}
foreach ($requiredPythonFile in @('zoitechat.py', '_zoitechat.py', 'hexchat.py', 'xchat.py')) {
$path = Join-Path (Join-Path $verifyRoot 'ZoiteChat\python') $requiredPythonFile
if (-not (Test-Path $path)) {
throw "Validated MSIX is missing required Python bridge file: $requiredPythonFile"
}
}
foreach ($excludedPath in @(
'ZoiteChat\portable-mode',
'ZoiteChat\zoitechat-text.exe',
'ZoiteChat\plugins\hcupd.dll',
'ZoiteChat\WinSparkle.dll',
'ZoiteChat\share\download.png'
)) {
if (Test-Path (Join-Path $verifyRoot $excludedPath)) {
throw "MSIX incorrectly contains excluded file/directory: $excludedPath"
}
}
}
finally {
if ($certificate) {
Remove-Item -Path "Cert:\CurrentUser\My\$($certificate.Thumbprint)" -Force -ErrorAction SilentlyContinue
}
if (Test-Path $pfxPath) {
Remove-Item -Path $pfxPath -Force -ErrorAction SilentlyContinue
}
foreach ($path in @($stagingRoot, $verifyRoot)) {
if (Test-Path $path) {
Remove-Item -Path $path -Recurse -Force -ErrorAction SilentlyContinue
}
}
}
if (-not (Test-Path $output)) {
throw "Expected MSIX was not created: $output"
}
Write-Host "Created MSIX: $output"
+162
View File
@@ -0,0 +1,162 @@
<?xml version="1.0" encoding="UTF-8"?>
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
<!--
This MSI intentionally mirrors the staged portion of the normal Inno Setup
payload. Optional/custom-only files are excluded below. In particular,
portable-mode must never be harvested because copy.vcxproj always stages
that marker. Inno-only download-at-install components remain outside the MSI.
-->
<Package
Name="ZoiteChat"
Manufacturer="ZoiteChat"
Version="$(ProductVersion)"
UpgradeCode="{E9F09DF3-12FA-4BDF-A8AA-A6D62A327ED5}"
Scope="perMachine"
InstallerVersion="500"
Compressed="yes">
<MajorUpgrade
AllowSameVersionUpgrades="yes"
DowngradeErrorMessage="A newer version of ZoiteChat is already installed." />
<MediaTemplate EmbedCab="yes" CompressionLevel="high" />
<Icon Id="ZoiteChat.ico" SourceFile="$(sys.SOURCEFILEDIR)..\..\data\icons\zoitechat.ico" />
<Property Id="ARPPRODUCTICON" Value="ZoiteChat.ico" />
<Property Id="ARPHELPLINK" Value="https://github.com/ZoiteChat/zoitechat/issues" />
<Property Id="ARPURLINFOABOUT" Value="https://zoitechat.org/" />
<Property Id="ARPURLUPDATEINFO" Value="https://zoitechat.org/downloads.html" />
<Property Id="ARPNOMODIFY" Value="1" />
<!--
The Inno installer can bootstrap the VC++ runtime. A plain MSI should not
run an EXE prerequisite as an MSI custom action, so require the runtime.
Administrative extraction is allowed regardless of prerequisite state.
-->
<Property Id="VCREDIST_X64_INSTALLED">
<RegistrySearch
Id="FindVCRedistX64"
Root="HKLM"
Key="SOFTWARE\Microsoft\VisualStudio\14.0\VC\Runtimes\x64"
Name="Installed"
Type="raw"
Bitness="always64" />
</Property>
<Launch
Condition="Installed OR ACTION = &quot;ADMIN&quot; OR VCREDIST_X64_INSTALLED = &quot;#1&quot;"
Message="Microsoft Visual C++ 2015-2022 x64 Redistributable is required before installing ZoiteChat." />
<Launch
Condition="Installed OR ACTION = &quot;ADMIN&quot; OR VersionNT64 &gt; 601 OR (VersionNT64 = 601 AND ServicePackLevel &gt;= 1)"
Message="ZoiteChat requires 64-bit Windows 7 SP1 or later." />
<StandardDirectory Id="ProgramFiles6432Folder">
<Directory Id="INSTALLFOLDER" Name="ZoiteChat" />
</StandardDirectory>
<StandardDirectory Id="ProgramMenuFolder">
<Directory Id="ApplicationProgramsFolder" Name="ZoiteChat" />
</StandardDirectory>
<Feature Id="MainFeature" Title="ZoiteChat" Level="1">
<ComponentGroupRef Id="ApplicationFiles" />
<ComponentRef Id="StartMenuShortcuts" />
<ComponentRef Id="ProtocolAndThemeAssociations" />
</Feature>
</Package>
<Fragment>
<ComponentGroup Id="ApplicationFiles">
<Files Directory="INSTALLFOLDER" Include="$(SourceDir)\**">
<!-- Created by copy.vcxproj for Inno's optional portable task only. -->
<Exclude Files="$(SourceDir)\portable-mode" />
<!-- Inno custom-only application component. -->
<Exclude Files="$(SourceDir)\zoitechat-text.exe" />
<!--
Keep the bundled utility and scripting plugins, including Python
3.14 and 3.8 support, available to non-Inno installations.
-->
</Files>
</ComponentGroup>
</Fragment>
<Fragment>
<Component Id="StartMenuShortcuts" Directory="ApplicationProgramsFolder" Guid="*">
<Shortcut
Id="ZoiteChatShortcut"
Name="ZoiteChat"
Description="ZoiteChat IRC client"
Target="[INSTALLFOLDER]zoitechat.exe"
WorkingDirectory="INSTALLFOLDER"
Icon="ZoiteChat.ico">
<ShortcutProperty Key="System.AppUserModel.ID" Value="ZoiteChat.Desktop.Notify" />
</Shortcut>
<Shortcut
Id="ZoiteChatSafeModeShortcut"
Name="ZoiteChat Safe Mode"
Description="Start ZoiteChat without auto-connect or plugins"
Target="[INSTALLFOLDER]zoitechat.exe"
Arguments="--no-auto --no-plugins"
WorkingDirectory="INSTALLFOLDER"
Icon="ZoiteChat.ico" />
<Shortcut
Id="ZoiteChatChangelogShortcut"
Name="ZoiteChat ChangeLog"
Target="[INSTALLFOLDER]changelog.url" />
<Shortcut
Id="ZoiteChatReadmeShortcut"
Name="ZoiteChat ReadMe"
Target="[INSTALLFOLDER]readme.url" />
<Shortcut
Id="ZoiteChatUninstallShortcut"
Name="Uninstall ZoiteChat"
Target="[System64Folder]msiexec.exe"
Arguments="/x [ProductCode]" />
<RemoveFolder Id="RemoveApplicationProgramsFolder" On="uninstall" />
<RegistryValue
Root="HKLM"
Key="Software\ZoiteChat\Installer"
Name="StartMenuShortcuts"
Type="integer"
Value="1"
KeyPath="yes" />
</Component>
</Fragment>
<Fragment>
<Component Id="ProtocolAndThemeAssociations" Directory="INSTALLFOLDER" Guid="*">
<RegistryValue
Root="HKCR"
Key="irc"
Type="string"
Value="URL:IRC Protocol"
KeyPath="yes" />
<RegistryValue Root="HKCR" Key="irc" Name="URL Protocol" Type="string" Value="" />
<RegistryValue Root="HKCR" Key="irc\DefaultIcon" Type="string" Value="[INSTALLFOLDER]zoitechat.exe,0" />
<RegistryValue Root="HKCR" Key="irc\shell" Type="string" Value="open" />
<RegistryValue
Root="HKCR"
Key="irc\shell\open\command"
Type="string"
Value="&quot;[INSTALLFOLDER]zoitechat.exe&quot; --url=&quot;%1&quot;" />
<RegistryValue Root="HKCR" Key=".zct" Type="string" Value="ZoiteChat.Theme" />
<RegistryValue Root="HKCR" Key=".hct" Type="string" Value="ZoiteChat.Theme" />
<RegistryValue Root="HKCR" Key="ZoiteChat.Theme" Type="string" Value="ZoiteChat Theme" />
<RegistryValue
Root="HKCR"
Key="ZoiteChat.Theme\DefaultIcon"
Type="string"
Value="[INSTALLFOLDER]zoitechat.exe,0" />
<RegistryValue
Root="HKCR"
Key="ZoiteChat.Theme\shell\open\command"
Type="string"
Value="&quot;[INSTALLFOLDER]zoitechat.exe&quot; &quot;%1&quot;" />
</Component>
</Fragment>
</Wix>