me-web? skeleton: Avalonia 12 app, server, packaging and CI
Build / Desktop, server and tools (push) Successful in 1m7s

The first screen (online or not, a Check button, every language with a
draft notice), the desktop and Android heads, the server's /api/info and
/api/ip, a release tool that builds deb, rpm, a Windows exe, macOS zips,
a signed APK and the server, and the Gitea workflows that run it. Rules
adapted from passolo; AGPL-3.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012CzABvBkbcFqoHdmi8b9WB
This commit is contained in:
thepraandClaude Opus 5.5 committed 2026-10-15 01:14:44 +02:00
commit 7589121846
76 files changed
+3082

No files matched your search

+51
View File
@@ -0,0 +1,51 @@
root = true
[*]
indent_style = space
indent_size = 2
tab_width = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false
[*.cs]
dotnet_style_require_accessibility_modifiers = omit_if_default:warning
dotnet_diagnostic.IDE0040.severity = warning
csharp_style_var_for_built_in_types = true:warning
csharp_style_var_when_type_is_apparent = true:warning
csharp_style_var_elsewhere = true:warning
dotnet_diagnostic.IDE0007.severity = warning
dotnet_diagnostic.IDE0008.severity = none
csharp_style_namespace_declarations = file_scoped:warning
dotnet_diagnostic.IDE0161.severity = warning
csharp_style_prefer_primary_constructors = true:suggestion
dotnet_diagnostic.IDE0290.severity = suggestion
dotnet_style_allow_multiple_blank_lines_experimental = false:warning
dotnet_diagnostic.IDE2000.severity = warning
dotnet_diagnostic.IDE0005.severity = suggestion
csharp_new_line_before_open_brace = all
csharp_prefer_braces = when_multiline:suggestion
csharp_using_directive_placement = outside_namespace
dotnet_sort_system_directives_first = true
dotnet_style_qualification_for_field = false
dotnet_style_qualification_for_property = false
dotnet_style_qualification_for_method = false
dotnet_style_qualification_for_event = false
dotnet_style_predefined_type_for_locals_parameters_members = true
dotnet_style_collection_initializer = true:suggestion
dotnet_style_prefer_collection_expression = when_types_loosely_match:suggestion
csharp_style_expression_bodied_properties = true:suggestion
csharp_style_expression_bodied_accessors = true:suggestion
[*.py]
indent_size = 4
+13
View File
@@ -0,0 +1,13 @@
#!/bin/sh
set -e
if [ -z "$MEWEB_KEYSTORE_B64" ] || [ -z "$MEWEB_KEYSTORE_PASS" ]; then
echo "::error::the repository secrets MEWEB_KEYSTORE_B64 and MEWEB_KEYSTORE_PASS are not set"
exit 1
fi
MEWEB_KEYSTORE="${RUNNER_TEMP:-/tmp}/meweb-$$.keystore"
export MEWEB_KEYSTORE MEWEB_KEYSTORE_PASS
trap 'rm -f "$MEWEB_KEYSTORE"' EXIT
umask 077
printf '%s' "$MEWEB_KEYSTORE_B64" | base64 -d > "$MEWEB_KEYSTORE"
unset MEWEB_KEYSTORE_B64
tools/release.sh android --commit "$COMMIT"
+41
View File
@@ -0,0 +1,41 @@
#!/bin/sh
set -eu
archive=$1
app=/var/www/meweb.arasaka.software
backups=/var/backups/meweb.arasaka.software
health=http://127.0.0.1:5480/api/info
stamp=$(date -u +%Y%m%d%H%M%S)
stage=$(mktemp -d)
trap 'rm -rf "$stage"' EXIT
tar -xzf "$archive" -C "$stage"
test -x "$stage/MeWeb.Server"
snapshot=""
if [ -x "$app/MeWeb.Server" ]; then
snapshot="$backups/meweb-$stamp"
rsync -a "$app/" "$snapshot/"
ls -1dt "$backups"/meweb-* 2>/dev/null | tail -n +4 | xargs -r rm -rf
fi
sudo systemctl stop meweb || true
rsync -a --delete "$stage/" "$app/"
sudo systemctl start meweb
for attempt in $(seq 1 30); do
if curl -fsS "$health" | grep -q "\"commit\":\"$COMMIT\""; then
echo "deployed $COMMIT: $(curl -fsS "$health")"
exit 0
fi
sleep 1
done
echo "::error::the new server did not answer with commit $COMMIT"
sudo systemctl status meweb --no-pager | tail -20 || true
if [ -n "$snapshot" ]; then
sudo systemctl stop meweb || true
rsync -a --delete "$snapshot/" "$app/"
sudo systemctl start meweb
echo "rolled back to $snapshot"
fi
exit 1
+17
View File
@@ -0,0 +1,17 @@
#!/bin/sh
set -e
version=$(sed -n 's:.*<Version>\(.*\)</Version>.*:\1:p' Directory.Build.props | head -n 1)
if [ "$GITHUB_REF_TYPE" = "tag" ] && [ "$GITHUB_REF_NAME" != "v$version" ]; then
echo "::error::tag $GITHUB_REF_NAME does not match Version $version in Directory.Build.props"
exit 1
fi
echo "VERSION=$version" >> "$GITHUB_ENV"
echo "COMMIT=$(echo "$GITHUB_SHA" | cut -c1-8)" >> "$GITHUB_ENV"
keep="$HOME/.cache/meweb"
for dir in tools/cache tools/jdk tools/packaging tools/android-sdk; do
mkdir -p "$keep/$dir"
rm -rf "$dir"
ln -s "$keep/$dir" "$dir"
done
rm -rf releases dist
echo "version $version, tools cached in $keep"
+23
View File
@@ -0,0 +1,23 @@
#!/bin/sh
set -eu
tag=$1; shift
api="${GITHUB_SERVER_URL:-https://git.thepra.dev}/api/v1/repos/$GITHUB_REPOSITORY"
call() { printf 'header = "Authorization: token %s"\n' "$RELEASE_TOKEN" | curl -K - -fsS "$@"; }
json() { python3 -c "import json,sys; d=json.load(sys.stdin); print($1)"; }
if id=$(call "$api/releases/tags/$tag" 2>/dev/null | json 'd["id"]'); then
echo "release $tag exists (id $id)"
else
body=$(python3 -c 'import json,sys; print(json.dumps({"tag_name": sys.argv[1], "name": sys.argv[1], "draft": False, "prerelease": sys.argv[1].startswith("v0.")}))' "$tag")
id=$(call -X POST -H 'Content-Type: application/json' -d "$body" "$api/releases" | json 'd["id"]')
echo "created release $tag (id $id)"
fi
for file in "$@"; do
name=$(basename "$file")
call "$api/releases/$id/assets" | python3 -c 'import json,sys; [print(a["id"]) for a in json.load(sys.stdin) if a["name"] == sys.argv[1]]' "$name" | while read -r old; do
call -o /dev/null -X DELETE "$api/releases/$id/assets/$old"
done
call -o /dev/null -F "attachment=@$file" "$api/releases/$id/assets?name=$name"
echo "attached $name ($(du -h "$file" | cut -f1))"
done
+15
View File
@@ -0,0 +1,15 @@
name: Build
on:
push:
branches:
- master
jobs:
build:
name: Desktop, server and tools
runs-on: nuvola
steps:
- uses: actions/checkout@v4
- name: Build
run: tools/ci.sh
+39
View File
@@ -0,0 +1,39 @@
name: Release
on:
push:
tags:
- 'v*'
workflow_dispatch:
inputs:
publish:
description: "Create the Gitea release too (false builds every platform and deploys the server only)"
default: "false"
jobs:
release:
name: Every platform, the server, the release
runs-on: nuvola
steps:
- uses: actions/checkout@v4
- name: Prepare
run: .gitea/scripts/prepare.sh
- name: Linux, Windows, macOS and the server
run: tools/release.sh linux windows macos server --commit "$COMMIT"
- name: Android, signed
env:
MEWEB_KEYSTORE_B64: ${{ secrets.MEWEB_KEYSTORE_B64 }}
MEWEB_KEYSTORE_PASS: ${{ secrets.MEWEB_KEYSTORE_PASS }}
run: .gitea/scripts/android.sh
- name: Deploy the server
run: .gitea/scripts/deploy-server.sh "releases/$VERSION/MeWeb-Server-$VERSION-linux-x64.tar.gz"
- name: Publish the release
if: ${{ github.ref_type == 'tag' || inputs.publish == 'true' }}
env:
RELEASE_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: .gitea/scripts/release.sh "v$VERSION" releases/"$VERSION"/*
+21
View File
@@ -0,0 +1,21 @@
bin/
obj/
*.user
*.suo
.vs/
.idea/
*.swp
*.keystore
*.jks
*.pem
*.p12
appsettings.*.local.json
/dist/
/releases/
/tools/bin/
/tools/jdk/
/tools/packaging/
/tools/android-sdk/
/tools/cache/
/tools/logs/
/.claude/settings.local.json
+51
View File
@@ -0,0 +1,51 @@
# AGENT.md — operating contract for agents working on MeWeb
Read this first. **`PATTERNS.md` is canonical for how code is written** (cite "PATTERNS #n"); **`CLAUDE.md` is the
quick reference** (commands, map, pitfalls). When a tool in the repo enforces a rule (the compiler, `.editorconfig`,
`tools/lint.cs`), the tool is the source of truth.
## What MeWeb is
**me-web?** tells an ordinary person whether their own connection and device can host a server, and what stands in
the way: no public address (CGNAT), blocked ports, a firewall on the provider's router, a dynamic address, a mail
port closed, a residential blocklist. It runs every automatic check it can, draws the path from the device to the
provider, explains each finding in plain words, and works mostly offline from an embedded knowledge database.
Avalonia 12 on .NET 10 for Linux, Windows, macOS and Android (`src/MeWeb.App` + heads), a small server for the
checks that need a vantage point outside the user's network (`src/MeWeb.Server`, `meweb.arasaka.software`).
Free software under AGPL-3.0, published by Arasaka di Hvozdikov Yevheniy.
## Conventions that differ from defaults (full rulings in `PATTERNS.md`)
- **No comments in source** — none, of any kind (#42).
- **No `private`**, no `_` prefixes, **`Nullable` disabled**, **2-space indent**, **`var` everywhere** (#92).
- **Primary constructors**, `IOptionsMonitor<T>`, `CancellationToken` last and forwarded (#1, #87, #88).
- **Routes only in `src/MeWeb.Shared/Endpoints.cs`** (#9); DTOs are classes named `View*`, `Upsert*`, `*Form` (#34).
- **UI text:** resx keys only, sentence case, every language present, drafts labelled (#39, #50, #125).
- **Every outbound host is declared** in the app's "What this app contacts" screen (#120).
## Hard rules — DO NOT
1. **Never commit a secret.** This repository is public. The Android keystore, the update-feed key, Mongo
credentials and blocklist keys live in Gitea Actions secrets or in `/etc/meweb/meweb.env` on the server, never in
git, never in a log, never printed.
2. **Never regenerate or delete the Android signing key.** A new key stops every installed app from updating.
3. **Never run the release workflow on code from a pull request.** CI runs on the production box: only pushes to
`master` and `v*` tags trigger it.
4. **Never `pkill -f` / `killall`.** Stop exactly the PID you started.
5. **Never create a branch, force-push or rewrite history** (#46).
6. **Never widen what the app contacts** without updating the declared list in the same change (#120).
7. **Never change a user's network without consent** (#122), and never point the probe at anything but the
caller's own address (#123).
8. **Never recreate a test project.** Verification is the `/verify` ladder.
## Evidence
Report the evidence level honestly: **E1** code-traced, **E2** exercised here (build, curl, headless screenshots),
**E3** live on a real device or a real network. Never report E3 from an E2 check.
## Git policy
- Trunk only: `master`, remote `git.thepra.dev/Arasaka/MeWeb` (public).
- A `v<Version>` tag releases every platform and deploys the server; the tag must equal `Version` in
`Directory.Build.props`.
- Stage explicit paths, review `git status` and `git diff --cached --stat` before committing.
+49
View File
@@ -0,0 +1,49 @@
# CLAUDE.md — MeWeb quick reference
Read `AGENT.md` first and cite `PATTERNS.md` for code rules. This file holds commands, the map and the pitfalls.
## Commands
```bash
dotnet build src/MeWeb.Desktop/MeWeb.Desktop.csproj
dotnet run --project src/MeWeb.Desktop
dotnet run --project src/MeWeb.Server # ASPNETCORE_URLS=http://127.0.0.1:5481
dotnet run tools/setup.cs -- --group jdk # pinned JDK 21 into tools/jdk
dotnet run tools/setup.cs -- --group packaging # pinned nfpm into tools/packaging
dotnet build src/MeWeb.Android/MeWeb.Android.csproj \
-p:JavaSdkDirectory=$PWD/tools/jdk/linux-x64/jdk-21.0.12+8 -p:AndroidSdkDirectory=$HOME/Android/Sdk
dotnet run --project tools/Screenshots -- dist/screenshots [en,it,...]
dotnet publish src/MeWeb.Desktop -c Release -r win-x64 --self-contained -p:PublishSingleFile=true \
-p:IncludeNativeLibrariesForSelfExtract=true -p:EnableCompressionInSingleFile=true
dotnet publish src/MeWeb.Desktop -c Release -r osx-arm64 --self-contained
```
The Android workload installs into the user SDK (`dotnet workload install android`); the system SDK in `/opt/dotnet`
is root-owned, so CI uses the runner user's own `~/.dotnet` (passolo's `tools/release.sh` pattern).
## Map
| Path | What |
|---|---|
| `src/MeWeb.Shared` | `Endpoints.cs` (routes and hosts), wire contracts, `MeWebJsonContext`, generated `BuildInfo` |
| `src/MeWeb.App` | Avalonia views and view models, `Services/Localizer.cs` (+ `{s:Tr Key}`), `Strings/*.resx`, `Resources/Colors.axaml` |
| `src/MeWeb.Desktop` | desktop head (`meweb` executable), Windows manifest |
| `src/MeWeb.Android` | Android head (`software.arasaka.meweb`), resources, manifest |
| `src/MeWeb.Server` | `meweb.arasaka.software`: `/api/info`, `/api/ip` |
| `data/languages.json` | every language with `reviewed` or `draft` |
| `tools/setup.cs` + `setup.json` | pinned build tools |
| `tools/Screenshots` | headless renders of every view in every language |
| `branding/` | the icon (SVG source, PNG, ICO) |
## Pitfalls
- **Avalonia 12 Android head:** `[Application] MainApplication : AvaloniaAndroidApplication<App>` plus a non-generic
`AvaloniaMainActivity`; the main view comes through `IActivityApplicationLifetime.MainViewFactory`, checked before
`ISingleViewApplicationLifetime`.
- **`ApplicationVersion` must be an integer**: computed from `Version` through separate `VersionMajor/Minor/Patch`
properties; one nested property function left it unevaluated (`XA0003`).
- **A headless Avalonia session does not end on its own** while the pulse animation runs: the screenshot tool calls
`Environment.Exit(0)` after dispatching.
- **The macOS apphost is ad-hoc signed by the .NET 10 SDK even on Linux** (`LC_CODE_SIGNATURE` present); Apple
Silicon refuses unsigned arm64 code, so never strip it.
- **The Windows single-file publish drops native `.pdb` files beside the exe**; only `meweb.exe` ships.
+17
View File
@@ -0,0 +1,17 @@
<Project>
<PropertyGroup>
<Version>0.1.0</Version>
<Product>me-web?</Product>
<Company>Arasaka di Hvozdikov Yevheniy</Company>
<Copyright>© 2026 Arasaka di Hvozdikov Yevheniy</Copyright>
<RepositoryUrl>https://git.thepra.dev/Arasaka/MeWeb</RepositoryUrl>
<PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
<Nullable>disable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<LangVersion>latest</LangVersion>
<TreatWarningsAsErrors>false</TreatWarningsAsErrors>
<GenerateDocumentationFile>false</GenerateDocumentationFile>
<InvariantGlobalization>false</InvariantGlobalization>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
</PropertyGroup>
</Project>
+21
View File
@@ -0,0 +1,21 @@
<Project>
<PropertyGroup>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
<AvaloniaVersion>12.1.4</AvaloniaVersion>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="Avalonia" Version="$(AvaloniaVersion)" />
<PackageVersion Include="Avalonia.Themes.Fluent" Version="$(AvaloniaVersion)" />
<PackageVersion Include="Avalonia.Fonts.Inter" Version="$(AvaloniaVersion)" />
<PackageVersion Include="Avalonia.Desktop" Version="$(AvaloniaVersion)" />
<PackageVersion Include="Avalonia.Android" Version="$(AvaloniaVersion)" />
<PackageVersion Include="Avalonia.Headless" Version="$(AvaloniaVersion)" />
<PackageVersion Include="Avalonia.Skia" Version="$(AvaloniaVersion)" />
<PackageVersion Include="Avalonia.HarfBuzz" Version="$(AvaloniaVersion)" />
<PackageVersion Include="AvaloniaUI.DiagnosticsSupport" Version="2.2.3" />
<PackageVersion Include="CommunityToolkit.Mvvm" Version="8.4.2" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.13" />
<PackageVersion Include="Microsoft.Extensions.Http" Version="10.0.13" />
<PackageVersion Include="Xamarin.AndroidX.Core.SplashScreen" Version="1.0.1.15" />
</ItemGroup>
</Project>
+661
View File
@@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
+9
View File
@@ -0,0 +1,9 @@
<Solution>
<Folder Name="/src/">
<Project Path="src/MeWeb.Shared/MeWeb.Shared.csproj" />
<Project Path="src/MeWeb.App/MeWeb.App.csproj" />
<Project Path="src/MeWeb.Desktop/MeWeb.Desktop.csproj" />
<Project Path="src/MeWeb.Android/MeWeb.Android.csproj" />
<Project Path="src/MeWeb.Server/MeWeb.Server.csproj" />
</Folder>
</Solution>
+178
View File
@@ -0,0 +1,178 @@
# PATTERNS.md — MeWeb house rulings
The canonical standards doc. **On any conflict about how to write code, a ruling here wins**; cite it in review as
"PATTERNS #n". `AGENT.md` is the operational contract, `CLAUDE.md` the quick reference and pitfalls.
Numbering is shared with the house lineage (SimpleSchool, passolo, odysseus, zigzag.academy): **#42, #51, #86–#93
mean the same thing in every repo**, and the text below follows passolo's wording wherever the subject is the same.
A number whose subject does not exist here is kept as a one-line **n/a** so the numbering never drifts. Rulings
only MeWeb needs start at **#120**.
Scope: `src/`, `tools/`. Out of scope: generated files (`obj/`, `*.g.cs`), third-party trees, the licence text.
---
## A. Dependency injection and services
1. **Primary-constructor DI is the default.** `class ServerClient(IHttpClientFactory factory)`. Constructors with
logic stay explicit; a constructor that only assigns fields is a primary constructor. Applies to server services,
App services and view models alike.
2. **Registration only through extension methods**, one group per area: `AddMeWebApp` (App), `AddMeWebHosting`,
`AddMeWebData` (server). `Program.cs` reads as a list of calls.
3. **Lifetime discipline.** Server: stateless per-request → `AddScoped`; process-global state, caches, rate counters →
`AddSingleton`. App: services singleton, view models transient.
4. **Interface fan-in via factory re-registration** when one instance serves two contracts; never register it twice.
86. **A service never takes `IHttpContextAccessor`** — the endpoint reads the caller's address and passes it in.
## B. Web boundary
5. **`WebResult` envelope + early return** on every server endpoint that can refuse; the happy path stays flat.
6. **Pure or internal code may return tuples** (`(value, error)`), never across the web boundary.
7. **`try/catch` placement: few at the top, few at the bottom, none in the middle.** Top: host startup, background
loops. Bottom: sockets, DNS, UPnP/PCP, file IO, platform APIs — the IO edges where a check meets the network.
8. **Endpoints are minimal-API handlers**, static methods mapped in one `Map*` extension per area, thin bodies that
call a service. (passolo's controller shape: n/a.)
9. **Routes centralized in `src/MeWeb.Shared/Endpoints.cs`** (`GET_Name`, `GET_M_Name(args)`), shared by server and
App. No `"/api/` literal anywhere else.
10. **Prefer the `WebResult` path over inline `try/catch`** in endpoints.
11. **n/a — SSE.**
12. **Subprocesses: argv only, never a shell string.** `ProcessStartInfo.ArgumentList`; no `sh -c`, no `cmd /c`
(`tracepath`, `ip`, `netsh` are run this way, if at all).
13. **Long-running server work is registered and stoppable** (probe runs, the per-address limiter).
53. n/a — no request-bound streams.
## C. Verification (there is no test project)
14. **Pure static helpers for IO-free logic** (verdicts, address classification, PTR patterns). They are exercised
by the CLI mode and the screenshot tool, not by a test project.
15. **n/a — xUnit theories.** No test project by owner decision.
16. **Hand-written fakes, no mocking framework.**
17. **Server endpoints are verified by the curl ladder** against a scratch database (`/verify`).
54. **UI work is verified by running the app and looking at it** — desktop, Android device, or the headless
screenshots from `tools/Screenshots` (evidence E2), a real device for E3. A compile is not a UI verification.
55. n/a — no model output.
63. **An inventory that lives in a check rots; keep one map and assert it against reality.**
64. **A sweep asserts what must hold and records what is a judgement call.**
65. **Prefer a source lint to a runtime check when the bug is visible in the source** (`tools/lint.cs`).
66. **A check that has always failed is a decision nobody made** — fix it or delete it.
67. **Two paths that resolve the same thing must degrade the same way** (the v4 and v6 echo, the system resolver and
the server-side blocklist fallback).
68. **Seed data before judging a surface** — the screenshot tool runs every language and two sizes.
69. n/a. 70. **Intermittent failures are usually an assertion on something transient** (network timing): fix the
assertion, not the retry count. 71. **A filter check asserts both directions.** 72. **Verify tooling against
every case it claims to cover.** 73. n/a — CSS selectors (corollary: `AutomationId`s are unique). 79. n/a.
80. n/a. 81. **Shared Mongo is not scratch space**: verification uses `meweb_<scratch>` and drops it. 82. **A new
verification mode is a rung of `/verify`.** 83. **A bulk change is bracketed by a full verification before and
after.**
## D. Configuration
18. **`record` types only for local, performance-oriented data.** Wire DTOs, options classes and everything in
`MeWeb.Shared` and `MeWeb.App` are classes.
19. **Config layering:** `appsettings.json` → environment variables (`Section__Key`) from
`/etc/meweb/meweb.env` on the box. **This repository is public: no secret is ever committed** (the house carve-out
of committing secrets does not apply here).
20. **Signing keys never touch git**: the Android keystore, the update-feed key and any packaging key live in Gitea
Actions secrets and are decoded into `$RUNNER_TEMP` by the release job.
87. **`IOptionsMonitor<T>` + `.CurrentValue` — never `IOptions<T>`.**
## E. Lifecycle and concurrency
21. **Three lifecycle idioms:** `IHostedService` for start/stop hooks, `BackgroundService` for periodic work with a
per-tick catch, explicit `IAsyncDisposable` for sockets and listeners.
22. **Disposable-lease mutex** (`TryBegin → IDisposable`) when an operation must not overlap (one probe run per
address).
23. n/a. 24. n/a.
88. **`CancellationToken` is the last parameter of every async method, and it is forwarded.** Relay commands take
one (the toolkit cancels them). Best-effort cleanup (removing a port mapping on exit) passes `CancellationToken.None`
on purpose.
## F. Data
25. **One data accessor per store**: `MongoContext` on the server, `KnowledgeStore` and `HistoryStore` in the App.
26. **Entity → view is a hand-written `ToView()`.** No mapper library.
56. **A multi-row mutation is one server call.**
74. **No in-between DTOs — a response DTO is pure data; `WebResult` carries ok/error.**
75. **A list is `[]` by construction end to end** — never `null`, never `?? []` at a use site.
84. **Never hand-roll a `JsonSerializerOptions`.** One source-generated context per assembly
(`MeWebJsonContext`, `AppJsonContext`) with Web defaults.
85. n/a.
89. **No `= string.Empty` property defaults — anywhere.**
## G. App (Avalonia)
27. **Client calls never throw** across the view-model boundary: a probe returns a result the view model can show;
transport failures become a state ("can't tell from here"), never an exception in a page.
28. **One screen = `XView.axaml` + `XViewModel`**, the view model resolved from DI.
29. n/a.
30. **Resilience engages on connection failure only**; a definite answer is never retried.
31. **`AutomationProperties.AutomationId` on every interactive element** (`<view>-<slug>`).
32. **Subscription discipline:** every `+=` has its `-=` in the matching unload/dispose; timers are `PeriodicTimer`
with a cancellation source cancelled on leave.
33. n/a.
34. **DTO naming by direction:** `View*` (response), `Upsert*` (create/update), `*Form` (any other input). Contracts
grouped by area in `MeWeb.Shared/<Area>Contracts.cs`.
35. n/a. 36. **Path safety** for anything served from disk by name. 37. **Layered gating: the UI hides; the server
refuses.** 57. n/a.
43. **Every submit-shaped screen is a real form** with a `*Form` object and one submit command whose `CanExecute`
follows validity and busy state.
44. **No converters or inline logic for display values:** the view model exposes `Show*` booleans and `*Formatted`
strings; XAML binds to them.
45. **No service locator in views**: a view receives its view model; `App.Services` is read only where Avalonia
builds the root view.
58. n/a. 59. n/a. 60. n/a — `prefers-reduced-motion` is not read (as on arasaka.software). 62. n/a. 76. n/a.
77. **Editable rows bind straight to their item.**
78. **No `record` types in the App** — classes only.
90. n/a.
91. **Never write `.Value` on a localizer indexer.** `Localizer.Instance[key]` returns a string.
93. **Never `try/catch` a client call — it already handed you the failure.**
## H. Logging, localization, packages, docs
38. **Structured logging with `{Placeholder}` templates**, never interpolated strings (Microsoft.Extensions.Logging,
as passolo).
39. **Localization-first:** every user-facing string is a resx key in `src/MeWeb.App/Strings/Strings*.resx`; no
literals in XAML or view models (the product name `me-web?` excepted).
40. **Central Package Management** (`Directory.Packages.props`); Avalonia packages move together through
`AvaloniaVersion`.
41. **Docs as convention:** `AGENT.md` (operational), `CLAUDE.md` (quick reference + pitfalls), `PATTERNS.md`
(rulings), `README.md` (public, English).
42. **Code comments — strict ban.** No `//`, `/* */`, `///`, `<!-- -->` in owned source (C#, AXAML, csproj, props,
manifests, plist, scripts, workflows). Intent goes in names, structure and the markdown docs.
61. **Binaries only through `tools/setup.cs`** (versions and SHA-256 pinned in `tools/setup.json`).
## I. Version control
46. **Never create a branch.** Commit on `master`; never force-push, never rewrite pushed history.
## J. Styling and UI text
47. **Colors only through tokens** in `src/MeWeb.App/Resources/Colors.axaml`; no hex literal in a view. Every
text/background pair passes WCAG AA.
48. **One icon source** (`Resources/Icons.axaml`, Lucide geometries, ISC); no inline path data in a view.
49. **Action rows run `[destructive] … [Cancel] [Primary]`** — primary on the end side (mirrored in RTL).
50. **All UI text is sentence case — never Title Case.**
51. **A helper must earn its existence** — 3+ call sites or extracted pure logic (#14); otherwise inline it.
52. **Zero-call-site code is deleted.**
92. **`var` for every local**; a local with no initializer is `var x = default(T)`.
---
## K. MeWeb-only rulings
120. **Every outbound contact is declared.** The app talks only to the hosts listed in "What this app contacts"
(Arasaka's server, the STUN servers, the MX hosts tested on port 25, blocklists through the user's own
resolver). A new host is a change to that screen in the same commit. No telemetry, analytics or crash
reporting.
121. **A verdict states what was measured, not what is hoped.** Each card says what it tried, what answered, and
what that means; "can't tell from here" is a valid result and never rendered as success or failure.
122. **Nothing is changed on the user's network without consent**: a port mapping is asked for first, leased for
at most ten minutes, removed after the run and recorded so a leftover is removed at the next start.
123. **The probe only ever connects back to the caller's own address**, bound to a single-use ticket; it refuses
private, loopback, link-local, CGNAT, ULA and the server's own prefixes.
124. **Shared findings leave only after the person has read exactly what is sent**, and every submission can be
deleted with the id and token the app keeps.
125. **Every language ships; drafts say so.** `data/languages.json` marks each language `reviewed` or `draft`; a
draft shows its notice and the "suggest a correction" link. The root `FlowDirection` follows the language.
126. **`?` appears only in display text.** File names, package ids and paths use `MeWeb`, `meweb` and
`software.arasaka.meweb`.
+41
View File
@@ -0,0 +1,41 @@
# me-web?
**Can you run your own server from here?** me-web? checks your connection and your device and tells you, in plain
words, what you could host at home, what stands in the way, and what would fix it.
> Status: early development (0.1). Nothing is released yet.
## What it checks
- whether you are online, or behind a login page;
- your public address, and whether your provider shares it with other customers (CGNAT) or puts more than one
router between you and the internet;
- whether your router lets an app open a port, and whether the outside world can actually reach you, over IPv4 and
IPv6;
- whether you can send mail directly, whether your address is on a residential blocklist, and what its reverse name
says;
- your DNS, your speed, and whether this device is a sensible server.
Each check ends with what it means: a website at home, reaching home from outside, a mail server, a game server,
family photos and files — possible, possible with a workaround, or not possible from here.
## Platforms
Linux (deb, rpm), Windows, macOS and Android. Builds are published as releases of this repository.
## Privacy
me-web? sends nothing anywhere unless a check needs it, and lists every host it contacts. It has no telemetry. At
the end you can choose to share your findings to improve the next release's map of providers; you see exactly
what is sent first, and you can delete it afterwards.
## Building
See `CLAUDE.md`. .NET 10, Avalonia 12.
## Licence
GNU Affero General Public License v3.0 (`LICENSE`). © 2026 Arasaka di Hvozdikov Yevheniy.
Translations other than English and Italian are machine drafts until someone reviews them. Corrections are welcome
as issues on this repository.
Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.
Binary file not shown.

After

Width:  |  Height:  |  Size: 361 KiB

+9
View File
@@ -0,0 +1,9 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" width="512" height="512">
<rect x="0" y="0" width="512" height="512" rx="112" fill="#1B141C"/>
<rect x="16" y="16" width="480" height="480" rx="98" fill="none" stroke="#3A2E3B" stroke-width="8"/>
<path d="M110 300 L230 196 L350 300 L350 404 L110 404 Z" fill="#2C222D" stroke="#F0EAEF" stroke-width="18" stroke-linejoin="round"/>
<rect x="200" y="320" width="60" height="84" rx="8" fill="#E04A55"/>
<path d="M330 170 A70 70 0 0 1 400 240" fill="none" stroke="#E04A55" stroke-width="18" stroke-linecap="round"/>
<path d="M330 116 A124 124 0 0 1 454 240" fill="none" stroke="#E04A55" stroke-width="18" stroke-linecap="round" opacity="0.7"/>
<circle cx="330" cy="240" r="18" fill="#E04A55"/>
</svg>

After

Width:  |  Height:  |  Size: 771 B

+4
View File
@@ -0,0 +1,4 @@
[
{ "code": "en", "name": "English", "status": "reviewed" },
{ "code": "it", "name": "Italiano", "status": "reviewed" }
]
+65
View File
@@ -0,0 +1,65 @@
#!/bin/bash
set -euo pipefail
here="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
site=meweb.arasaka.software
names=(meweb.arasaka.software v4.meweb.arasaka.software v6.meweb.arasaka.software)
app=/var/www/$site
backups=/var/backups/$site
etc=/etc/meweb
env=$etc/meweb.env
unit=/etc/systemd/system/meweb.service
sudoers=/etc/sudoers.d/gitea-runner
acme=/root/.acme.sh/acme.sh
cert=/root/.acme.sh/${site}_ecc/fullchain.cer
[ "$(id -u)" = 0 ] || { echo "run as root"; exit 1; }
id meweb >/dev/null 2>&1 || useradd --system --no-create-home --shell /usr/sbin/nologin meweb
install -d -o gitea-runner -g gitea-runner -m 755 "$app" "$backups"
install -d -o root -g meweb -m 750 "$etc"
if [ ! -f "$env" ]; then
printf '%s\n' \
'ASPNETCORE_ENVIRONMENT=Production' \
'ASPNETCORE_URLS=http://127.0.0.1:5480' \
'DOTNET_PRINT_TELEMETRY_MESSAGE=false' \
'DOTNET_CLI_TELEMETRY_OPTOUT=1' > "$env"
chown root:meweb "$env"
chmod 640 "$env"
echo "wrote $env"
fi
install -m 644 "$here/meweb.service" "$unit"
systemctl daemon-reload
systemctl enable meweb.service >/dev/null 2>&1
line="gitea-runner ALL=(root) NOPASSWD: /usr/bin/systemctl start meweb, /usr/bin/systemctl stop meweb, /usr/bin/systemctl restart meweb, /usr/bin/systemctl is-active meweb, /usr/bin/systemctl show meweb*, /usr/bin/systemctl status meweb*"
if ! grep -qF "$line" "$sudoers"; then
cp "$sudoers" "$sudoers.new"
echo "$line" >> "$sudoers.new"
visudo -cf "$sudoers.new" >/dev/null
install -m 440 "$sudoers.new" "$sudoers"
rm -f "$sudoers.new"
echo "sudoers: meweb added for gitea-runner"
fi
if [ ! -f "$cert" ]; then
install -m 644 "$here/nginx/$site.http.conf" "/etc/nginx/sites-enabled/$site.conf"
nginx -t
systemctl reload nginx
args=()
for name in "${names[@]}"; do args+=(-d "$name"); done
"$acme" --issue --webroot /var/www/acme "${args[@]}" --keylength ec-256 --reloadcmd "systemctl reload nginx"
fi
install -m 644 "$here/nginx/$site.conf" "/etc/nginx/sites-enabled/$site.conf"
nginx -t
systemctl reload nginx
if [ -x "$app/MeWeb.Server" ]; then
systemctl restart meweb
systemctl is-active meweb
else
echo "no build in $app yet: the release workflow deploys it"
fi
echo "setup done"
+24
View File
@@ -0,0 +1,24 @@
[Unit]
Description=me-web? server (meweb.arasaka.software)
After=network-online.target mongod.service
Wants=network-online.target
[Service]
User=meweb
Group=meweb
WorkingDirectory=/var/www/meweb.arasaka.software
ExecStart=/var/www/meweb.arasaka.software/MeWeb.Server
EnvironmentFile=/etc/meweb/meweb.env
Restart=always
RestartSec=5
KillSignal=SIGINT
SyslogIdentifier=meweb
NoNewPrivileges=true
PrivateTmp=true
ProtectSystem=strict
ProtectHome=true
ReadOnlyPaths=/var/www/meweb.arasaka.software
MemoryMax=512M
[Install]
WantedBy=multi-user.target
+50
View File
@@ -0,0 +1,50 @@
server {
listen 80;
listen [::]:80;
server_name meweb.arasaka.software v4.meweb.arasaka.software v6.meweb.arasaka.software;
location ^~ /.well-known/acme-challenge/ {
root /var/www/acme;
default_type "text/plain";
allow all;
}
location / {
return 301 https://$host$request_uri;
}
}
server {
listen 443 ssl;
listen 8444 ssl proxy_protocol;
listen [::]:443 ssl;
server_name meweb.arasaka.software v4.meweb.arasaka.software v6.meweb.arasaka.software;
ssl_certificate /root/.acme.sh/meweb.arasaka.software_ecc/fullchain.cer;
ssl_certificate_key /root/.acme.sh/meweb.arasaka.software_ecc/meweb.arasaka.software.key;
add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" always;
add_header Referrer-Policy "no-referrer" always;
add_header X-Content-Type-Options "nosniff" always;
add_header X-Frame-Options "DENY" always;
access_log /var/log/nginx/meweb.arasaka.software.access.log;
error_log /var/log/nginx/meweb.arasaka.software.error.log;
client_max_body_size 128k;
location ^~ /.well-known/acme-challenge/ {
root /var/www/acme;
default_type "text/plain";
allow all;
}
location / {
proxy_pass http://127.0.0.1:5480;
proxy_http_version 1.1;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto https;
proxy_set_header Connection "";
}
}
@@ -0,0 +1,15 @@
server {
listen 80;
listen [::]:80;
server_name meweb.arasaka.software v4.meweb.arasaka.software v6.meweb.arasaka.software;
location ^~ /.well-known/acme-challenge/ {
root /var/www/acme;
default_type "text/plain";
allow all;
}
location / {
return 301 https://$host$request_uri;
}
}
+6
View File
@@ -0,0 +1,6 @@
{
"sdk": {
"version": "10.0.401",
"rollForward": "latestFeature"
}
}
+16
View File
@@ -0,0 +1,16 @@
using Android.App;
using Android.Content.PM;
using Avalonia.Android;
namespace MeWeb.Android;
[Activity(
Label = "me-web?",
Theme = "@style/MeWebTheme.NoActionBar",
Icon = "@drawable/icon",
MainLauncher = true,
ConfigurationChanges = ConfigChanges.Orientation | ConfigChanges.ScreenSize | ConfigChanges.UiMode | ConfigChanges.Locale | ConfigChanges.LayoutDirection)]
public class MainActivity : AvaloniaMainActivity
{
}
+17
View File
@@ -0,0 +1,17 @@
using Android.App;
using Android.Runtime;
using Avalonia;
using Avalonia.Android;
namespace MeWeb.Android;
[Application]
public class MainApplication : AvaloniaAndroidApplication<MeWeb.App.App>
{
protected MainApplication(nint javaReference, JniHandleOwnership transfer) : base(javaReference, transfer)
{
}
protected override AppBuilder CustomizeAppBuilder(AppBuilder builder) => base.CustomizeAppBuilder(builder).WithInterFont();
}
+27
View File
@@ -0,0 +1,27 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net10.0-android</TargetFramework>
<SupportedOSPlatformVersion>24</SupportedOSPlatformVersion>
<RootNamespace>MeWeb.Android</RootNamespace>
<ApplicationId>software.arasaka.meweb</ApplicationId>
<ApplicationTitle>me-web?</ApplicationTitle>
<ApplicationDisplayVersion>$(Version)</ApplicationDisplayVersion>
<VersionMajor>$([System.Version]::Parse('$(Version)').Major)</VersionMajor>
<VersionMinor>$([System.Version]::Parse('$(Version)').Minor)</VersionMinor>
<VersionPatch>$([System.Version]::Parse('$(Version)').Build)</VersionPatch>
<ApplicationVersion>$([MSBuild]::Add($([MSBuild]::Multiply($(VersionMajor), 10000)), $([MSBuild]::Add($([MSBuild]::Multiply($(VersionMinor), 100)), $(VersionPatch)))))</ApplicationVersion>
<AndroidPackageFormats>apk</AndroidPackageFormats>
<AndroidEnableProfiledAot>false</AndroidEnableProfiledAot>
<JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Avalonia.Android" />
<PackageReference Include="Xamarin.AndroidX.Core.SplashScreen" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\MeWeb.App\MeWeb.App.csproj" />
</ItemGroup>
</Project>
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:installLocation="auto">
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />
<application android:label="me-web?" android:icon="@drawable/icon" android:supportsRtl="true" />
</manifest>
Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
<item>
<color android:color="@color/splash_background" />
</item>
<item android:drawable="@drawable/icon" android:width="120dp" android:height="120dp" android:gravity="center" />
</layer-list>
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<resources>
<style name="MeWebTheme" />
<style name="MeWebTheme.NoActionBar" parent="@style/Theme.AppCompat.NoActionBar">
<item name="android:windowActionBar">false</item>
<item name="android:windowBackground">@null</item>
<item name="android:windowNoTitle">true</item>
<item name="android:windowSplashScreenBackground">@color/splash_background</item>
<item name="android:windowSplashScreenAnimatedIcon">@drawable/icon</item>
<item name="postSplashScreenTheme">@style/MeWebTheme.Main</item>
</style>
<style name="MeWebTheme.Main" parent="MeWebTheme.NoActionBar">
<item name="android:windowIsTranslucent">true</item>
</style>
</resources>
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<resources>
<color name="splash_background">#1B141C</color>
</resources>
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<resources>
<style name="MeWebTheme" />
<style name="MeWebTheme.NoActionBar" parent="@style/Theme.AppCompat.NoActionBar">
<item name="android:windowActionBar">false</item>
<item name="android:windowBackground">@drawable/splash_screen</item>
<item name="android:windowNoTitle">true</item>
</style>
</resources>
+29
View File
@@ -0,0 +1,29 @@
<Application xmlns="https://github.com/avaloniaui"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
x:Class="MeWeb.App.App"
Name="me-web?"
RequestedThemeVariant="Dark">
<Application.Resources>
<ResourceDictionary>
<ResourceDictionary.MergedDictionaries>
<ResourceInclude Source="avares://MeWeb.App/Resources/Colors.axaml" />
</ResourceDictionary.MergedDictionaries>
</ResourceDictionary>
</Application.Resources>
<Application.Styles>
<FluentTheme>
<FluentTheme.Palettes>
<ColorPaletteResources x:Key="Dark"
Accent="#E04A55"
RegionColor="#1B141C"
AltHigh="#1B141C"
BaseHigh="#F0EAEF"
ChromeMediumLow="#2C222D"
ChromeMedium="#352A36"
ChromeLow="#231B24" />
</FluentTheme.Palettes>
</FluentTheme>
<StyleInclude Source="avares://MeWeb.App/Resources/Styles.axaml" />
</Application.Styles>
</Application>
+43
View File
@@ -0,0 +1,43 @@
using Avalonia;
using Avalonia.Controls;
using Avalonia.Controls.ApplicationLifetimes;
using Avalonia.Markup.Xaml;
using MeWeb.App.Services;
using MeWeb.App.ViewModels;
using MeWeb.App.Views;
using Microsoft.Extensions.DependencyInjection;
namespace MeWeb.App;
public partial class App : Application
{
public static IServiceProvider Services { get; private set; }
public override void Initialize()
{
AvaloniaXamlLoader.Load(this);
#if DEBUG
this.AttachDeveloperTools();
#endif
}
public override void OnFrameworkInitializationCompleted()
{
Services = new ServiceCollection().AddMeWebApp().BuildServiceProvider();
var stored = AppSettings.Read();
Localizer.Instance.SetLanguage(Languages.Find(stored.Language) ?? Languages.ForCulture(System.Globalization.CultureInfo.CurrentUICulture));
if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
desktop.MainWindow = new MainWindow { Content = CreateMainView() };
else if (ApplicationLifetime is IActivityApplicationLifetime activity)
activity.MainViewFactory = CreateMainView;
else if (ApplicationLifetime is ISingleViewApplicationLifetime single)
single.MainView = CreateMainView();
base.OnFrameworkInitializationCompleted();
}
static Control CreateMainView() => new MainView { DataContext = Services.GetRequiredService<MainViewModel>() };
}
+22
View File
@@ -0,0 +1,22 @@
using MeWeb.App.Services;
using MeWeb.App.ViewModels;
using MeWeb.Shared;
using Microsoft.Extensions.DependencyInjection;
namespace MeWeb.App;
public static class AppServices
{
public static IServiceCollection AddMeWebApp(this IServiceCollection services)
{
services.AddHttpClient(ServerClient.Name, http =>
{
http.BaseAddress = new Uri(Endpoints.Base);
http.DefaultRequestHeaders.UserAgent.ParseAdd($"me-web/{BuildInfo.Version}");
});
services.AddSingleton<ServerClient>();
services.AddTransient<MainViewModel>();
return services;
}
}
Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

+30
View File
@@ -0,0 +1,30 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<RootNamespace>MeWeb.App</RootNamespace>
<AvaloniaUseCompiledBindingsByDefault>true</AvaloniaUseCompiledBindingsByDefault>
<JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
</PropertyGroup>
<ItemGroup>
<AvaloniaResource Include="Assets\**" />
<EmbeddedResource Include="..\..\data\languages.json" LogicalName="languages.json" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="Avalonia" />
<PackageReference Include="Avalonia.Themes.Fluent" />
<PackageReference Include="Avalonia.Fonts.Inter" />
<PackageReference Include="AvaloniaUI.DiagnosticsSupport">
<IncludeAssets Condition="'$(Configuration)' != 'Debug'">None</IncludeAssets>
<PrivateAssets Condition="'$(Configuration)' != 'Debug'">All</PrivateAssets>
</PackageReference>
<PackageReference Include="CommunityToolkit.Mvvm" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" />
<PackageReference Include="Microsoft.Extensions.Http" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\MeWeb.Shared\MeWeb.Shared.csproj" />
</ItemGroup>
</Project>
+26
View File
@@ -0,0 +1,26 @@
<ResourceDictionary xmlns="https://github.com/avaloniaui"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
<Color x:Key="BrandRed">#E04A55</Color>
<Color x:Key="BrandRedDark">#B23640</Color>
<Color x:Key="BrandRedLight">#EC7A82</Color>
<Color x:Key="Ground">#1B141C</Color>
<Color x:Key="Surface">#2C222D</Color>
<Color x:Key="SurfaceRaised">#352A36</Color>
<Color x:Key="Line">#3A2E3B</Color>
<Color x:Key="TextStrong">#F0EAEF</Color>
<Color x:Key="TextSoft">#A79AA6</Color>
<Color x:Key="Good">#6FCF97</Color>
<Color x:Key="Caution">#F2C14E</Color>
<Color x:Key="Bad">#E85D6C</Color>
<SolidColorBrush x:Key="BrandRedBrush" Color="{StaticResource BrandRed}" />
<SolidColorBrush x:Key="GroundBrush" Color="{StaticResource Ground}" />
<SolidColorBrush x:Key="SurfaceBrush" Color="{StaticResource Surface}" />
<SolidColorBrush x:Key="SurfaceRaisedBrush" Color="{StaticResource SurfaceRaised}" />
<SolidColorBrush x:Key="LineBrush" Color="{StaticResource Line}" />
<SolidColorBrush x:Key="TextStrongBrush" Color="{StaticResource TextStrong}" />
<SolidColorBrush x:Key="TextSoftBrush" Color="{StaticResource TextSoft}" />
<SolidColorBrush x:Key="GoodBrush" Color="{StaticResource Good}" />
<SolidColorBrush x:Key="CautionBrush" Color="{StaticResource Caution}" />
<SolidColorBrush x:Key="BadBrush" Color="{StaticResource Bad}" />
</ResourceDictionary>
+56
View File
@@ -0,0 +1,56 @@
<Styles xmlns="https://github.com/avaloniaui"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
<Style Selector="TextBlock.title">
<Setter Property="FontSize" Value="34" />
<Setter Property="FontWeight" Value="Bold" />
<Setter Property="Foreground" Value="{StaticResource TextStrongBrush}" />
</Style>
<Style Selector="TextBlock.lead">
<Setter Property="FontSize" Value="18" />
<Setter Property="Foreground" Value="{StaticResource TextSoftBrush}" />
<Setter Property="TextWrapping" Value="Wrap" />
<Setter Property="TextAlignment" Value="Center" />
</Style>
<Style Selector="TextBlock.status">
<Setter Property="FontSize" Value="22" />
<Setter Property="FontWeight" Value="SemiBold" />
<Setter Property="Foreground" Value="{StaticResource TextStrongBrush}" />
<Setter Property="TextAlignment" Value="Center" />
</Style>
<Style Selector="TextBlock.small">
<Setter Property="FontSize" Value="13" />
<Setter Property="Foreground" Value="{StaticResource TextSoftBrush}" />
</Style>
<Style Selector="Button.primary">
<Setter Property="Background" Value="{StaticResource BrandRedBrush}" />
<Setter Property="Foreground" Value="{StaticResource TextStrongBrush}" />
<Setter Property="FontSize" Value="20" />
<Setter Property="FontWeight" Value="SemiBold" />
<Setter Property="Padding" Value="40,14" />
<Setter Property="CornerRadius" Value="28" />
<Setter Property="HorizontalAlignment" Value="Center" />
</Style>
<Style Selector="Button.link">
<Setter Property="Background" Value="Transparent" />
<Setter Property="Foreground" Value="{StaticResource BrandRedBrush}" />
<Setter Property="Padding" Value="4,2" />
<Setter Property="FontSize" Value="13" />
<Setter Property="Cursor" Value="Hand" />
</Style>
<Style Selector="Ellipse.pulse">
<Style.Animations>
<Animation Duration="0:0:1.6" IterationCount="Infinite">
<KeyFrame Cue="0%">
<Setter Property="Opacity" Value="0.85" />
<Setter Property="ScaleTransform.ScaleX" Value="0.8" />
<Setter Property="ScaleTransform.ScaleY" Value="0.8" />
</KeyFrame>
<KeyFrame Cue="100%">
<Setter Property="Opacity" Value="0" />
<Setter Property="ScaleTransform.ScaleX" Value="1.5" />
<Setter Property="ScaleTransform.ScaleY" Value="1.5" />
</KeyFrame>
</Animation>
</Style.Animations>
</Style>
</Styles>
+11
View File
@@ -0,0 +1,11 @@
using System.Text.Json;
using System.Text.Json.Serialization;
namespace MeWeb.App.Services;
[JsonSourceGenerationOptions(JsonSerializerDefaults.Web, WriteIndented = true)]
[JsonSerializable(typeof(List<Language>))]
[JsonSerializable(typeof(StoredSettings))]
public partial class AppJsonContext : JsonSerializerContext
{
}
+43
View File
@@ -0,0 +1,43 @@
using System.Text.Json;
namespace MeWeb.App.Services;
public class StoredSettings
{
public string Language { get; set; }
}
public static class AppSettings
{
static readonly string Folder = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "MeWeb");
static readonly string FilePath = Path.Combine(Folder, "settings.json");
public static StoredSettings Read()
{
try
{
if (!File.Exists(FilePath)) return new StoredSettings();
using var stream = File.OpenRead(FilePath);
return JsonSerializer.Deserialize(stream, AppJsonContext.Default.StoredSettings) ?? new StoredSettings();
}
catch (Exception ex) when (ex is IOException or JsonException or UnauthorizedAccessException)
{
return new StoredSettings();
}
}
public static void Write(StoredSettings settings)
{
try
{
Directory.CreateDirectory(Folder);
var temporary = FilePath + ".tmp";
using (var stream = File.Create(temporary))
JsonSerializer.Serialize(stream, settings, AppJsonContext.Default.StoredSettings);
File.Move(temporary, FilePath, overwrite: true);
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
{
}
}
}
+41
View File
@@ -0,0 +1,41 @@
using System.Globalization;
using System.Text.Json;
namespace MeWeb.App.Services;
public class Language
{
public string Code { get; set; }
public string Name { get; set; }
public string Status { get; set; }
public bool IsDraft => Status == "draft";
}
public static class Languages
{
public static Language Fallback { get; } = new() { Code = "en", Name = "English", Status = "reviewed" };
public static IReadOnlyList<Language> All { get; } = Load();
public static Language Find(string code) =>
string.IsNullOrEmpty(code) ? null : All.FirstOrDefault(l => string.Equals(l.Code, code, StringComparison.OrdinalIgnoreCase));
public static Language ForCulture(CultureInfo culture)
{
for (var current = culture; current is not null && !string.IsNullOrEmpty(current.Name); current = current.Parent)
{
var found = Find(current.Name);
if (found is not null) return found;
}
return Fallback;
}
static List<Language> Load()
{
using var stream = typeof(Languages).Assembly.GetManifestResourceStream("languages.json");
if (stream is null) return [Fallback];
var list = JsonSerializer.Deserialize(stream, AppJsonContext.Default.ListLanguage) ?? [];
return list.Count == 0 ? [Fallback] : list.OrderBy(l => l.Name, StringComparer.Create(CultureInfo.InvariantCulture, CompareOptions.IgnoreCase)).ToList();
}
}
+52
View File
@@ -0,0 +1,52 @@
using System.ComponentModel;
using System.Globalization;
using System.Resources;
using Avalonia.Data;
using Avalonia.Markup.Xaml;
using Avalonia.Markup.Xaml.MarkupExtensions;
namespace MeWeb.App.Services;
public sealed class Localizer : INotifyPropertyChanged
{
readonly ResourceManager resources = new("MeWeb.App.Strings.Strings", typeof(Localizer).Assembly);
public static Localizer Instance { get; } = new();
public event PropertyChangedEventHandler PropertyChanged;
public Language Language { get; private set; } = Languages.Fallback;
public CultureInfo Culture { get; private set; } = CultureInfo.GetCultureInfo(Languages.Fallback.Code);
public bool IsRightToLeft => Culture.TextInfo.IsRightToLeft;
public string this[string key] => resources.GetString(key, Culture) ?? key;
public string Format(string key, params object[] args) => string.Format(Culture, this[key], args);
public void SetLanguage(Language language)
{
Language = language ?? Languages.Fallback;
Culture = CultureInfo.GetCultureInfo(Language.Code);
CultureInfo.DefaultThreadCurrentCulture = CultureInfo.DefaultThreadCurrentUICulture = Culture;
CultureInfo.CurrentCulture = CultureInfo.CurrentUICulture = Culture;
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs("Item[]"));
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(string.Empty));
}
}
public sealed class TrExtension : MarkupExtension
{
public TrExtension()
{
}
public TrExtension(string key) => Key = key;
public string Key { get; set; }
public override object ProvideValue(IServiceProvider serviceProvider) =>
new ReflectionBindingExtension($"[{Key}]") { Mode = BindingMode.OneWay, Source = Localizer.Instance }.ProvideValue(serviceProvider);
}
+33
View File
@@ -0,0 +1,33 @@
using System.Net.Http.Json;
using MeWeb.Shared;
namespace MeWeb.App.Services;
public enum Reachability
{
Unknown,
Online,
Offline,
}
public class ServerClient(IHttpClientFactory factory)
{
public const string Name = "server";
public async Task<(Reachability State, ViewInfo Info)> Probe(CancellationToken ct)
{
try
{
var http = factory.CreateClient(Name);
using var timeout = CancellationTokenSource.CreateLinkedTokenSource(ct);
timeout.CancelAfter(TimeSpan.FromSeconds(6));
var info = await http.GetFromJsonAsync(Endpoints.Server.GET_Info, MeWebJsonContext.Default.ViewInfo, timeout.Token);
return (Reachability.Online, info);
}
catch (Exception ex) when (ex is HttpRequestException or TaskCanceledException && !ct.IsCancellationRequested)
{
return (Reachability.Offline, null);
}
}
}
+42
View File
@@ -0,0 +1,42 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="AppTagline" xml:space="preserve">
<value>Scopra se da questa connessione può ospitare un server suo, e che cosa lo impedisce.</value>
</data>
<data name="Check" xml:space="preserve">
<value>Verifica</value>
</data>
<data name="DraftNotice" xml:space="preserve">
<value>Questa traduzione è una bozza automatica.</value>
</data>
<data name="Language" xml:space="preserve">
<value>Lingua</value>
</data>
<data name="StatusChecking" xml:space="preserve">
<value>Verifico la connessione…</value>
</data>
<data name="StatusOffline" xml:space="preserve">
<value>Non connesso a internet</value>
</data>
<data name="StatusOnline" xml:space="preserve">
<value>Connesso a internet</value>
</data>
<data name="SuggestCorrection" xml:space="preserve">
<value>Proponi una correzione</value>
</data>
<data name="VersionLine" xml:space="preserve">
<value>me-web? {0} · software libero (AGPL-3.0)</value>
</data>
</root>
+42
View File
@@ -0,0 +1,42 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="AppTagline" xml:space="preserve">
<value>Find out whether you can run your own server from this connection, and what stands in the way.</value>
</data>
<data name="Check" xml:space="preserve">
<value>Check</value>
</data>
<data name="DraftNotice" xml:space="preserve">
<value>This translation is a machine draft.</value>
</data>
<data name="Language" xml:space="preserve">
<value>Language</value>
</data>
<data name="StatusChecking" xml:space="preserve">
<value>Checking the connection…</value>
</data>
<data name="StatusOffline" xml:space="preserve">
<value>Not connected to the internet</value>
</data>
<data name="StatusOnline" xml:space="preserve">
<value>Connected to the internet</value>
</data>
<data name="SuggestCorrection" xml:space="preserve">
<value>Suggest a correction</value>
</data>
<data name="VersionLine" xml:space="preserve">
<value>me-web? {0} · free software (AGPL-3.0)</value>
</data>
</root>
+70
View File
@@ -0,0 +1,70 @@
using Avalonia.Media;
using Avalonia.Platform.Storage;
using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;
using MeWeb.App.Services;
using MeWeb.Shared;
namespace MeWeb.App.ViewModels;
public partial class MainViewModel(ServerClient server) : ObservableObject
{
public const string CorrectionsUrl = "https://git.thepra.dev/Arasaka/MeWeb/issues";
public IReadOnlyList<Language> Languages { get; } = Services.Languages.All;
public ILauncher Launcher { get; set; }
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(StatusFormatted), nameof(ShowOnline), nameof(ShowOffline), nameof(ShowChecking))]
public partial Reachability Status { get; set; } = Reachability.Unknown;
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(ShowDraftNotice), nameof(Flow))]
public partial Language SelectedLanguage { get; set; } = Localizer.Instance.Language;
public bool ShowChecking => Status == Reachability.Unknown;
public bool ShowOnline => Status == Reachability.Online;
public bool ShowOffline => Status == Reachability.Offline;
public bool ShowDraftNotice => SelectedLanguage?.IsDraft == true;
public FlowDirection Flow => Localizer.Instance.IsRightToLeft ? FlowDirection.RightToLeft : FlowDirection.LeftToRight;
public string StatusFormatted => Status switch
{
Reachability.Online => Localizer.Instance["StatusOnline"],
Reachability.Offline => Localizer.Instance["StatusOffline"],
_ => Localizer.Instance["StatusChecking"],
};
public string VersionFormatted => Localizer.Instance.Format("VersionLine", BuildInfo.Version);
[RelayCommand]
async Task Refresh(CancellationToken ct)
{
Status = Reachability.Unknown;
var (state, _) = await server.Probe(ct);
Status = state;
}
[RelayCommand]
async Task OpenCorrections()
{
if (Launcher is null) return;
await Launcher.LaunchUriAsync(new Uri(CorrectionsUrl));
}
partial void OnSelectedLanguageChanged(Language value)
{
if (value is null || value.Code == Localizer.Instance.Language.Code) return;
Localizer.Instance.SetLanguage(value);
var settings = AppSettings.Read();
settings.Language = value.Code;
AppSettings.Write(settings);
OnPropertyChanged(nameof(StatusFormatted));
OnPropertyChanged(nameof(VersionFormatted));
OnPropertyChanged(nameof(Flow));
}
}
+50
View File
@@ -0,0 +1,50 @@
<UserControl xmlns="https://github.com/avaloniaui"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:vm="using:MeWeb.App.ViewModels"
xmlns:s="using:MeWeb.App.Services"
x:Class="MeWeb.App.Views.MainView"
x:DataType="vm:MainViewModel"
FlowDirection="{Binding Flow}"
Background="{StaticResource GroundBrush}">
<DockPanel Margin="24,18">
<Grid DockPanel.Dock="Top" ColumnDefinitions="*,Auto">
<TextBlock Grid.Column="0" Classes="title" Text="me-web?" VerticalAlignment="Center" />
<ComboBox Grid.Column="1" MinWidth="180" VerticalAlignment="Center"
AutomationProperties.AutomationId="main-language"
AutomationProperties.Name="{s:Tr Language}"
ItemsSource="{Binding Languages}"
SelectedItem="{Binding SelectedLanguage}">
<ComboBox.ItemTemplate>
<DataTemplate x:DataType="s:Language">
<TextBlock Text="{Binding Name}" />
</DataTemplate>
</ComboBox.ItemTemplate>
</ComboBox>
</Grid>
<StackPanel DockPanel.Dock="Bottom" Spacing="6" HorizontalAlignment="Center">
<StackPanel Orientation="Horizontal" Spacing="8" HorizontalAlignment="Center" IsVisible="{Binding ShowDraftNotice}">
<TextBlock Classes="small" Text="{s:Tr DraftNotice}" VerticalAlignment="Center" />
<Button Classes="link" Content="{s:Tr SuggestCorrection}"
AutomationProperties.AutomationId="main-suggest-correction"
Command="{Binding OpenCorrectionsCommand}" />
</StackPanel>
<TextBlock Classes="small" Text="{Binding VersionFormatted}" HorizontalAlignment="Center" />
</StackPanel>
<StackPanel Spacing="22" VerticalAlignment="Center" HorizontalAlignment="Center" MaxWidth="560">
<Grid Width="140" Height="140" HorizontalAlignment="Center">
<Ellipse Classes="pulse" Width="140" Height="140" Fill="{StaticResource BrandRedBrush}" IsVisible="{Binding ShowChecking}" />
<Ellipse Width="112" Height="112" Fill="{StaticResource SurfaceRaisedBrush}" Stroke="{StaticResource LineBrush}" StrokeThickness="2" />
<Ellipse Width="64" Height="64" Fill="{StaticResource GoodBrush}" IsVisible="{Binding ShowOnline}" />
<Ellipse Width="64" Height="64" Fill="{StaticResource BadBrush}" IsVisible="{Binding ShowOffline}" />
<Ellipse Width="64" Height="64" Fill="{StaticResource TextSoftBrush}" Opacity="0.4" IsVisible="{Binding ShowChecking}" />
</Grid>
<TextBlock Classes="status" Text="{Binding StatusFormatted}" />
<TextBlock Classes="lead" Text="{s:Tr AppTagline}" />
<Button Classes="primary" Content="{s:Tr Check}"
AutomationProperties.AutomationId="main-check"
Command="{Binding RefreshCommand}" />
</StackPanel>
</DockPanel>
</UserControl>
+21
View File
@@ -0,0 +1,21 @@
using Avalonia.Controls;
using Avalonia.Interactivity;
using MeWeb.App.ViewModels;
namespace MeWeb.App.Views;
public partial class MainView : UserControl
{
public MainView() => InitializeComponent();
protected override void OnLoaded(RoutedEventArgs e)
{
base.OnLoaded(e);
if (DataContext is MainViewModel model)
{
model.Launcher = TopLevel.GetTopLevel(this)?.Launcher;
model.RefreshCommand.Execute(null);
}
}
}
+8
View File
@@ -0,0 +1,8 @@
<Window xmlns="https://github.com/avaloniaui"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
x:Class="MeWeb.App.Views.MainWindow"
Title="me-web?"
Icon="/Assets/meweb.png"
Width="1100" Height="760" MinWidth="380" MinHeight="560"
Background="{StaticResource GroundBrush}"
WindowStartupLocation="CenterScreen" />
+8
View File
@@ -0,0 +1,8 @@
using Avalonia.Controls;
namespace MeWeb.App.Views;
public partial class MainWindow : Window
{
public MainWindow() => InitializeComponent();
}
+20
View File
@@ -0,0 +1,20 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>WinExe</OutputType>
<TargetFramework>net10.0</TargetFramework>
<RootNamespace>MeWeb.Desktop</RootNamespace>
<AssemblyName>meweb</AssemblyName>
<ApplicationManifest>app.manifest</ApplicationManifest>
<ApplicationIcon>..\..\branding\meweb.ico</ApplicationIcon>
<BuiltInComInteropSupport>false</BuiltInComInteropSupport>
<JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Avalonia.Desktop" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\MeWeb.App\MeWeb.App.csproj" />
</ItemGroup>
</Project>
+14
View File
@@ -0,0 +1,14 @@
using Avalonia;
namespace MeWeb.Desktop;
static class Program
{
[STAThread]
public static void Main(string[] args) => BuildAvaloniaApp().StartWithClassicDesktopLifetime(args);
public static AppBuilder BuildAvaloniaApp() => AppBuilder.Configure<MeWeb.App.App>()
.UsePlatformDetect()
.WithInterFont()
.LogToTrace();
}
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<assembly manifestVersion="1.0" xmlns="urn:schemas-microsoft-com:asm.v1">
<assemblyIdentity version="1.0.0.0" name="MeWeb.Desktop"/>
<compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
<application>
<supportedOS Id="{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}" />
</application>
</compatibility>
</assembly>
+31
View File
@@ -0,0 +1,31 @@
using System.Net;
using MeWeb.Shared;
using Microsoft.AspNetCore.HttpOverrides;
namespace MeWeb.Server;
public static class Hosting
{
public static IServiceCollection AddMeWebHosting(this IServiceCollection services)
{
services.Configure<ForwardedHeadersOptions>(options =>
{
options.ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto;
options.ForwardLimit = 1;
options.KnownProxies.Clear();
options.KnownIPNetworks.Clear();
options.KnownProxies.Add(IPAddress.Loopback);
options.KnownProxies.Add(IPAddress.IPv6Loopback);
});
services.ConfigureHttpJsonOptions(options => options.SerializerOptions.TypeInfoResolverChain.Insert(0, MeWebJsonContext.Default));
return services;
}
public static WebApplication UseMeWebHosting(this WebApplication app)
{
app.UseForwardedHeaders();
return app;
}
}
+11
View File
@@ -0,0 +1,11 @@
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<RootNamespace>MeWeb.Server</RootNamespace>
<JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\MeWeb.Shared\MeWeb.Shared.csproj" />
</ItemGroup>
</Project>
+9
View File
@@ -0,0 +1,9 @@
using MeWeb.Server;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddMeWebHosting();
var app = builder.Build();
app.UseMeWebHosting();
app.MapMeWebApi();
app.Run();
+26
View File
@@ -0,0 +1,26 @@
using System.Net.Sockets;
using MeWeb.Shared;
namespace MeWeb.Server;
public static class ServerApi
{
public static WebApplication MapMeWebApi(this WebApplication app)
{
app.MapGet(Endpoints.Server.GET_Info, Info);
app.MapGet(Endpoints.Server.GET_Ip, Ip);
return app;
}
static ViewInfo Info() => new() { Version = BuildInfo.Version, Commit = BuildInfo.Commit, BuiltAt = BuildInfo.BuiltAt };
static IResult Ip(HttpContext context)
{
var address = context.Connection.RemoteIpAddress;
if (address is null) return Results.BadRequest();
if (address.IsIPv4MappedToIPv6) address = address.MapToIPv4();
var family = address.AddressFamily == AddressFamily.InterNetworkV6 ? "ipv6" : "ipv4";
return Results.Ok(new ViewIp { Address = address.ToString(), Family = family });
}
}
+9
View File
@@ -0,0 +1,9 @@
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*"
}
+27
View File
@@ -0,0 +1,27 @@
namespace MeWeb.Shared;
public static class Endpoints
{
public const string Host = "meweb.arasaka.software";
public const string HostV4 = "v4.meweb.arasaka.software";
public const string HostV6 = "v6.meweb.arasaka.software";
public static string Base => $"https://{Host}";
public static string BaseV4 => $"https://{HostV4}";
public static string BaseV6 => $"https://{HostV6}";
public const string Api = "/api";
public static class Server
{
public const string GET_Info = $"{Api}/info";
public const string GET_Ip = $"{Api}/ip";
}
public static class Downloads
{
public const string GET_Platform = "/download/{platform}";
public static string GET_M_Platform(string platform) => $"/download/{platform}";
}
}
+28
View File
@@ -0,0 +1,28 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<RootNamespace>MeWeb.Shared</RootNamespace>
<BuildCommit Condition="'$(BuildCommit)' == ''">dev</BuildCommit>
<BuildTimeUtc Condition="'$(BuildTimeUtc)' == ''">2000-01-01T00:00:00Z</BuildTimeUtc>
</PropertyGroup>
<Target Name="GenerateBuildInfo" BeforeTargets="BeforeCompile">
<PropertyGroup>
<BuildInfoPath>$(IntermediateOutputPath)BuildInfo.g.cs</BuildInfoPath>
</PropertyGroup>
<ItemGroup>
<BuildInfoLine Include="namespace MeWeb.Shared%3B" />
<BuildInfoLine Include="public static class BuildInfo" />
<BuildInfoLine Include="{" />
<BuildInfoLine Include=" public const string Version = &quot;$(Version)&quot;%3B" />
<BuildInfoLine Include=" public const string Commit = &quot;$(BuildCommit)&quot;%3B" />
<BuildInfoLine Include=" public const string BuiltAt = &quot;$(BuildTimeUtc)&quot;%3B" />
<BuildInfoLine Include="}" />
</ItemGroup>
<WriteLinesToFile File="$(BuildInfoPath)" Lines="@(BuildInfoLine)" Overwrite="true" WriteOnlyWhenDifferent="true" />
<ItemGroup>
<Compile Include="$(BuildInfoPath)" />
<FileWrites Include="$(BuildInfoPath)" />
</ItemGroup>
</Target>
</Project>
+11
View File
@@ -0,0 +1,11 @@
using System.Text.Json;
using System.Text.Json.Serialization;
namespace MeWeb.Shared;
[JsonSourceGenerationOptions(JsonSerializerDefaults.Web)]
[JsonSerializable(typeof(ViewInfo))]
[JsonSerializable(typeof(ViewIp))]
public partial class MeWebJsonContext : JsonSerializerContext
{
}
+14
View File
@@ -0,0 +1,14 @@
namespace MeWeb.Shared;
public class ViewInfo
{
public string Version { get; set; }
public string Commit { get; set; }
public string BuiltAt { get; set; }
}
public class ViewIp
{
public string Address { get; set; }
public string Family { get; set; }
}
+51
View File
@@ -0,0 +1,51 @@
using Avalonia;
using Avalonia.Controls;
using Avalonia.Headless;
using Avalonia.Media.Imaging;
using Avalonia.Threading;
using MeWeb.App;
using MeWeb.App.Services;
using MeWeb.App.ViewModels;
using MeWeb.App.Views;
using Microsoft.Extensions.DependencyInjection;
var output = args.Length > 0 ? args[0] : Path.Combine("dist", "screenshots");
var codes = args.Length > 1 ? args[1].Split(',', StringSplitOptions.RemoveEmptyEntries) : Languages.All.Select(l => l.Code).ToArray();
Directory.CreateDirectory(output);
var session = HeadlessUnitTestSession.StartNew(typeof(ScreenshotEntry));
await session.Dispatch(() =>
{
foreach (var (width, height, label) in new[] { (1100, 760, "desktop"), (400, 820, "phone") })
{
foreach (var code in codes)
{
Localizer.Instance.SetLanguage(Languages.Find(code) ?? Languages.Fallback);
var model = App.Services.GetRequiredService<MainViewModel>();
var window = new Window { Width = width, Height = height, Content = new MainView { DataContext = model } };
window.Show();
Dispatcher.UIThread.RunJobs();
var frame = window.CaptureRenderedFrame();
var path = Path.Combine(output, $"main-{label}-{code}.png");
if (frame is not null)
{
using var file = File.Create(path);
frame.Save(file, new PngBitmapEncoderOptions());
}
Console.WriteLine($"{path} {(frame is null ? "no frame" : "ok")}");
window.Close();
}
}
}, CancellationToken.None);
Environment.Exit(0);
public static class ScreenshotEntry
{
public static AppBuilder BuildAvaloniaApp() => AppBuilder.Configure<MeWeb.App.App>()
.UseSkia()
.UseHarfBuzz()
.WithInterFont()
.UseHeadless(new AvaloniaHeadlessPlatformOptions { UseHeadlessDrawing = false });
}
+18
View File
@@ -0,0 +1,18 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net10.0</TargetFramework>
<RootNamespace>MeWeb.Screenshots</RootNamespace>
<IsPackable>false</IsPackable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Avalonia.Headless" />
<PackageReference Include="Avalonia.Skia" />
<PackageReference Include="Avalonia.HarfBuzz" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\src\MeWeb.App\MeWeb.App.csproj" />
</ItemGroup>
</Project>
Executable
+8
View File
@@ -0,0 +1,8 @@
#!/bin/sh
set -e
. "$(dirname "$0")/sdk.sh"
dotnet --version
for project in src/MeWeb.Desktop/MeWeb.Desktop.csproj src/MeWeb.Server/MeWeb.Server.csproj tools/Screenshots/Screenshots.csproj; do
echo "== $project"
dotnet build "$project" -c Release -nologo -nodeReuse:false -warnaserror
done
+26
View File
@@ -0,0 +1,26 @@
#!/usr/bin/env bash
set -euo pipefail
GITEA=${GITEA_URL:-https://git.thepra.dev}
ORG=${GITEA_ORG:-Arasaka}
NAME=${1:-MeWeb}
ROOT=$(cd "$(dirname "$0")/../.." && pwd)
cred=$(printf 'protocol=https\nhost=%s\n\n' "${GITEA#https://}" | git credential fill)
user=$(printf '%s\n' "$cred" | sed -n 's/^username=//p')
pass=$(printf '%s\n' "$cred" | sed -n 's/^password=//p')
[ -n "$user" ] && [ -n "$pass" ] || { echo "no stored git credential for $GITEA"; exit 1; }
out=$(mktemp)
trap 'rm -f "$out"' EXIT
body=$(printf '{"name":"%s","private":false,"default_branch":"master","description":"me-web? Can you run your own server from here? Checks your connection and device and explains what stands in the way."}' "$NAME")
code=$(curl -s -o "$out" -w '%{http_code}' -u "$user:$pass" -H 'Content-Type: application/json' \
-X POST "$GITEA/api/v1/orgs/$ORG/repos" -d "$body")
case "$code" in
201) echo "created $GITEA/$ORG/$NAME" ;;
409) echo "already exists: $GITEA/$ORG/$NAME" ;;
*) echo "Gitea answered $code:"; cat "$out"; echo; exit 1 ;;
esac
cd "$ROOT"
git remote get-url origin >/dev/null 2>&1 || git remote add origin "$GITEA/$ORG/$NAME.git"
git push -u origin master
+21
View File
@@ -0,0 +1,21 @@
#!/usr/bin/env bash
set -euo pipefail
GITEA=${GITEA_URL:-https://git.thepra.dev}
ORG=${GITEA_ORG:-Arasaka}
REPO=${GITEA_REPO:-MeWeb}
name=$1
file=$2
[ -f "$file" ] || { echo "usage: set_secret.sh NAME FILE (the file holds the value)"; exit 1; }
cred=$(printf 'protocol=https\nhost=%s\n\n' "${GITEA#https://}" | git credential fill)
user=$(printf '%s\n' "$cred" | sed -n 's/^username=//p')
pass=$(printf '%s\n' "$cred" | sed -n 's/^password=//p')
[ -n "$user" ] && [ -n "$pass" ] || { echo "no stored git credential for $GITEA"; exit 1; }
body=$(python3 -c 'import json,sys; print(json.dumps({"data": open(sys.argv[1]).read().strip()}))' "$file")
code=$(printf '%s' "$body" | curl -s -o /dev/null -w '%{http_code}' -u "$user:$pass" -H 'Content-Type: application/json' \
-X PUT "$GITEA/api/v1/repos/$ORG/$REPO/actions/secrets/$name" --data-binary @-)
case "$code" in
201|204) echo "secret $name set on $ORG/$REPO" ;;
*) echo "Gitea answered $code for $name"; exit 1 ;;
esac
+367
View File
@@ -0,0 +1,367 @@
using System.Diagnostics;
using System.Formats.Tar;
using System.IO.Compression;
using System.Security.Cryptography;
using System.Text.RegularExpressions;
using System.Xml.Linq;
const string KeystoreVariable = "MEWEB_KEYSTORE";
const string KeystorePasswordVariable = "MEWEB_KEYSTORE_PASS";
const string KeyAlias = "meweb";
string[] targetNames = ["linux", "windows", "macos", "android", "server"];
const UnixFileMode ExecutableMode = UnixFileMode.UserRead | UnixFileMode.UserWrite | UnixFileMode.UserExecute | UnixFileMode.GroupRead
| UnixFileMode.GroupExecute | UnixFileMode.OtherRead | UnixFileMode.OtherExecute;
const UnixFileMode RegularMode = UnixFileMode.UserRead | UnixFileMode.UserWrite | UnixFileMode.GroupRead | UnixFileMode.OtherRead;
var root = FindRoot();
var version = XDocument.Load(Path.Combine(root, "Directory.Build.props")).Descendants("Version").FirstOrDefault()?.Value.Trim();
if (version is null || !Regex.IsMatch(version, @"^\d+\.\d{1,2}\.\d{1,2}$"))
{
Console.Error.WriteLine($"invalid Version in Directory.Build.props: '{version}' (expected x.y.z)");
return 2;
}
var words = args.Where((a, i) => !a.StartsWith("--", StringComparison.Ordinal) && (i == 0 || !args[i - 1].StartsWith("--", StringComparison.Ordinal)))
.Select(a => a.ToLowerInvariant()).ToList();
if (words.Count == 0 || words.Any(w => w != "all" && !targetNames.Contains(w)))
{
Console.Error.WriteLine("usage: tools/release.sh <all|linux|windows|macos|android|server>... [--commit <sha>]");
return 2;
}
var targets = words.Contains("all") ? targetNames.ToList() : targetNames.Where(words.Contains).ToList();
var commit = Option("--commit") ?? "dev";
var builtAt = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ");
var output = Path.Combine(root, "releases", version);
var desktop = Path.Combine(root, "src", "MeWeb.Desktop", "MeWeb.Desktop.csproj");
var android = Path.Combine(root, "src", "MeWeb.Android", "MeWeb.Android.csproj");
var server = Path.Combine(root, "src", "MeWeb.Server", "MeWeb.Server.csproj");
var branding = Path.Combine(root, "branding");
Directory.CreateDirectory(output);
Console.WriteLine($"me-web? {version} ({commit}): {string.Join(", ", targets)} -> {output}");
var failed = false;
foreach (var target in targets)
{
try
{
Console.WriteLine($"== {target}");
var detail = target switch
{
"linux" => Linux(),
"windows" => Windows(),
"macos" => MacOs(),
"android" => Android(),
_ => Server(),
};
Console.WriteLine($"ok {target}: {detail}");
}
catch (Exception ex)
{
failed = true;
Console.Error.WriteLine($"FAIL {target}: {ex.Message}");
}
}
WriteSums();
return failed ? 1 : 0;
string[] Stamp() => [$"-p:Version={version}", $"-p:BuildCommit={commit}", $"-p:BuildTimeUtc={builtAt}"];
string Linux()
{
var stage = Reset(Path.Combine(root, "dist", "linux"));
var installed = Path.Combine(stage, "app");
Dotnet(["publish", desktop, "-c", "Release", "-r", "linux-x64", "--self-contained", "true", "-p:DebugType=none", "-o", installed, .. Stamp()]);
foreach (var required in new[] { "meweb", "libSkiaSharp.so", "libHarfBuzzSharp.so" })
if (!File.Exists(Path.Combine(installed, required))) throw new InvalidOperationException($"{required} missing from the Linux build");
foreach (var junk in Directory.GetFiles(installed, "*.pdb").Append(Path.Combine(installed, "libcoreclrtraceptprovider.so")))
if (File.Exists(junk)) File.Delete(junk);
NormaliseModes(installed, ["meweb", "createdump"]);
File.WriteAllText(Path.Combine(stage, "software.arasaka.meweb.desktop"), """
[Desktop Entry]
Type=Application
Name=me-web?
Comment=Can you run your own server from here?
Comment[it]=Si può ospitare un server da questa connessione?
Exec=meweb
TryExec=meweb
Icon=software.arasaka.meweb
Terminal=false
Categories=Network;Utility;
StartupWMClass=meweb
""");
File.WriteAllText(Path.Combine(stage, "postinstall.sh"), """
#!/bin/sh
if command -v update-desktop-database >/dev/null 2>&1; then update-desktop-database -q /usr/share/applications || true; fi
if command -v gtk-update-icon-cache >/dev/null 2>&1; then gtk-update-icon-cache -q -f -t /usr/share/icons/hicolor || true; fi
exit 0
""");
File.Copy(Path.Combine(stage, "postinstall.sh"), Path.Combine(stage, "postremove.sh"), overwrite: true);
var png = Path.Combine(branding, "meweb-512.png");
var svg = Path.Combine(branding, "meweb.svg");
var yaml = Path.Combine(stage, "nfpm.yaml");
File.WriteAllText(yaml, $"""
name: meweb
arch: amd64
platform: linux
version: {version}
release: "1"
section: net
priority: optional
maintainer: Arasaka di Hvozdikov Yevheniy <https://arasaka.software/contact>
vendor: Arasaka di Hvozdikov Yevheniy
homepage: https://git.thepra.dev/Arasaka/MeWeb
license: AGPL-3.0-only
description: |
Can you run your own server from here? me-web? checks your connection and device and
explains, in plain words, what you could host at home and what stands in the way.
contents:
- src: {installed}
dst: /opt/meweb
type: tree
- src: /opt/meweb/meweb
dst: /usr/bin/meweb
type: symlink
- src: {stage}/software.arasaka.meweb.desktop
dst: /usr/share/applications/software.arasaka.meweb.desktop
file_info:
mode: 0644
- src: {png}
dst: /usr/share/icons/hicolor/512x512/apps/software.arasaka.meweb.png
file_info:
mode: 0644
- src: {svg}
dst: /usr/share/icons/hicolor/scalable/apps/software.arasaka.meweb.svg
file_info:
mode: 0644
scripts:
postinstall: {stage}/postinstall.sh
postremove: {stage}/postremove.sh
overrides:
deb:
depends:
- libc6 (>= 2.28)
- libgcc-s1
- libstdc++6
- libfontconfig1
- libx11-6
- libice6
- libsm6
- libssl3t64 | libssl3
- libicu78 | libicu76 | libicu74 | libicu72 | libicu70
- xdg-utils
recommends:
- fonts-noto-core
- fonts-noto-cjk
rpm:
depends:
- libc.so.6(GLIBC_2.28)(64bit)
- libstdc++.so.6(GLIBCXX_3.4.22)(64bit)
- libgcc_s.so.1()(64bit)
- libfontconfig.so.1()(64bit)
- libX11.so.6()(64bit)
- libICE.so.6()(64bit)
- libSM.so.6()(64bit)
- libssl.so.3()(64bit)
- libcrypto.so.3()(64bit)
- libicu
- /usr/bin/xdg-open
recommends:
- google-noto-sans-fonts
- google-noto-sans-cjk-fonts
rpm:
summary: Can you run your own server from here?
compression: zstd
deb:
compression: zstd
""");
var nfpm = Path.Combine(root, "tools", "packaging", "linux-x64", "nfpm");
if (!File.Exists(nfpm)) RunTool("setup.cs", "--group", "packaging");
var names = new List<string>();
foreach (var packager in new[] { "deb", "rpm" })
{
var name = $"MeWeb-{version}-linux-x64.{packager}";
Run(nfpm, "package", "--config", yaml, "--packager", packager, "--target", Path.Combine(output, name));
names.Add($"{name} ({Size(Path.Combine(output, name))})");
}
return string.Join(", ", names);
}
string Windows()
{
var stage = Reset(Path.Combine(root, "dist", "windows"));
Dotnet(["publish", desktop, "-c", "Release", "-r", "win-x64", "--self-contained", "true", "-p:PublishSingleFile=true",
"-p:IncludeNativeLibrariesForSelfExtract=true", "-p:EnableCompressionInSingleFile=true", "-p:DebugType=none", "-o", stage, .. Stamp()]);
var exe = Path.Combine(stage, "meweb.exe");
if (!File.Exists(exe)) throw new InvalidOperationException("meweb.exe missing from the Windows build");
var name = $"MeWeb-{version}-windows-x64.exe";
File.Copy(exe, Path.Combine(output, name), overwrite: true);
return $"{name} ({Size(Path.Combine(output, name))})";
}
string MacOs()
{
var names = new List<string>();
foreach (var (rid, label) in new[] { ("osx-arm64", "arm64"), ("osx-x64", "x64") })
{
var stage = Reset(Path.Combine(root, "dist", "macos-" + label));
var bundle = Path.Combine(stage, "me-web.app");
var contents = Path.Combine(bundle, "Contents");
var binaries = Path.Combine(contents, "MacOS");
var resources = Path.Combine(contents, "Resources");
Directory.CreateDirectory(resources);
Dotnet(["publish", desktop, "-c", "Release", "-r", rid, "--self-contained", "true", "-p:DebugType=none", "-o", binaries, .. Stamp()]);
if (!File.Exists(Path.Combine(binaries, "meweb"))) throw new InvalidOperationException($"meweb missing from the {rid} build");
foreach (var pdb in Directory.GetFiles(binaries, "*.pdb")) File.Delete(pdb);
File.Copy(Path.Combine(branding, "meweb.icns"), Path.Combine(resources, "meweb.icns"), overwrite: true);
File.WriteAllText(Path.Combine(contents, "Info.plist"), $"""
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleName</key><string>me-web?</string>
<key>CFBundleDisplayName</key><string>me-web?</string>
<key>CFBundleIdentifier</key><string>software.arasaka.meweb</string>
<key>CFBundleVersion</key><string>{version}</string>
<key>CFBundleShortVersionString</key><string>{version}</string>
<key>CFBundleExecutable</key><string>meweb</string>
<key>CFBundleIconFile</key><string>meweb.icns</string>
<key>CFBundlePackageType</key><string>APPL</string>
<key>LSMinimumSystemVersion</key><string>13.0</string>
<key>NSHighResolutionCapable</key><true/>
<key>NSLocalNetworkUsageDescription</key><string>me-web? looks for your router to see whether it can open a port for a test.</string>
</dict>
</plist>
""");
NormaliseModes(binaries, ["meweb", "createdump"]);
var name = $"MeWeb-{version}-macos-{label}.zip";
var zip = Path.Combine(output, name);
if (File.Exists(zip)) File.Delete(zip);
RunIn(stage, "zip", "-q", "-r", "-y", zip, "me-web.app");
names.Add($"{name} ({Size(zip)})");
}
return string.Join(", ", names);
}
string Android()
{
var keystore = Environment.GetEnvironmentVariable(KeystoreVariable);
if (string.IsNullOrEmpty(keystore) || !File.Exists(keystore) || string.IsNullOrEmpty(Environment.GetEnvironmentVariable(KeystorePasswordVariable)))
throw new InvalidOperationException($"{KeystoreVariable} (a keystore file) and {KeystorePasswordVariable} must be set to sign the APK");
var jdk = Jdk();
var sdk = AndroidSdk(jdk);
EnsureWorkload("android");
var stage = Reset(Path.Combine(root, "dist", "android"));
Dotnet(["publish", android, "-c", "Release", "-f", "net10.0-android", "-o", stage, $"-p:JavaSdkDirectory={jdk}", $"-p:AndroidSdkDirectory={sdk}",
"-p:AndroidKeyStore=true", $"-p:AndroidSigningKeyStore={keystore}", $"-p:AndroidSigningKeyAlias={KeyAlias}",
$"-p:AndroidSigningStorePass=env:{KeystorePasswordVariable}", $"-p:AndroidSigningKeyPass=env:{KeystorePasswordVariable}", .. Stamp()]);
var apk = Directory.GetFiles(stage, "*-Signed.apk").SingleOrDefault() ?? throw new InvalidOperationException("signed APK not found");
var name = $"MeWeb-{version}-android.apk";
File.Copy(apk, Path.Combine(output, name), overwrite: true);
return $"{name} ({Size(Path.Combine(output, name))})";
}
string Server()
{
var stage = Reset(Path.Combine(root, "dist", "server"));
Dotnet(["publish", server, "-c", "Release", "-r", "linux-x64", "--self-contained", "true", "-p:DebugType=none", "-o", stage, .. Stamp()]);
if (!File.Exists(Path.Combine(stage, "MeWeb.Server"))) throw new InvalidOperationException("MeWeb.Server missing from the server build");
NormaliseModes(stage, ["MeWeb.Server", "createdump"]);
var name = $"MeWeb-Server-{version}-linux-x64.tar.gz";
var archive = Path.Combine(output, name);
using (var file = File.Create(archive))
using (var gzip = new GZipStream(file, CompressionLevel.Optimal))
TarFile.CreateFromDirectory(stage, gzip, includeBaseDirectory: false);
return $"{name} ({Size(archive)})";
}
string Jdk()
{
var candidate = Directory.Exists(Path.Combine(root, "tools", "jdk", "linux-x64"))
? Directory.GetDirectories(Path.Combine(root, "tools", "jdk", "linux-x64")).FirstOrDefault(d => File.Exists(Path.Combine(d, "bin", "javac")))
: null;
if (candidate is not null) return candidate;
RunTool("setup.cs", "--group", "jdk");
return Directory.GetDirectories(Path.Combine(root, "tools", "jdk", "linux-x64")).First(d => File.Exists(Path.Combine(d, "bin", "javac")));
}
string AndroidSdk(string jdk)
{
var home = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile);
string[] candidates = [Environment.GetEnvironmentVariable("ANDROID_HOME"), Path.Combine(home, "Android", "Sdk"), Path.Combine(root, "tools", "android-sdk")];
var sdk = candidates.FirstOrDefault(c => !string.IsNullOrEmpty(c) && Directory.Exists(Path.Combine(c, "platforms", "android-36"))) ?? Path.Combine(root, "tools", "android-sdk");
if (!Directory.Exists(Path.Combine(sdk, "platforms", "android-36")) || !Directory.Exists(Path.Combine(sdk, "build-tools")))
Dotnet(["build", android, "-t:InstallAndroidDependencies", "-f", "net10.0-android", $"-p:AndroidSdkDirectory={sdk}", $"-p:JavaSdkDirectory={jdk}",
"-p:AcceptAndroidSDKLicenses=True"]);
return sdk;
}
void EnsureWorkload(string name)
{
var installed = Capture("dotnet", "workload", "list");
if (!installed.Split('\n').Any(l => l.Trim().StartsWith(name + " ", StringComparison.Ordinal))) Dotnet(["workload", "install", name]);
}
void WriteSums()
{
var lines = Directory.GetFiles(output).Where(f => !f.EndsWith("SHA256SUMS.txt", StringComparison.Ordinal)).OrderBy(f => f, StringComparer.Ordinal)
.Select(f => $"{Convert.ToHexStringLower(SHA256.HashData(File.ReadAllBytes(f)))} {Path.GetFileName(f)}");
File.WriteAllLines(Path.Combine(output, "SHA256SUMS.txt"), lines);
}
void NormaliseModes(string folder, string[] executables)
{
if (OperatingSystem.IsWindows()) return;
foreach (var file in Directory.EnumerateFiles(folder, "*", SearchOption.AllDirectories))
File.SetUnixFileMode(file, executables.Contains(Path.GetFileName(file)) ? ExecutableMode : RegularMode);
foreach (var dir in Directory.EnumerateDirectories(folder, "*", SearchOption.AllDirectories)) File.SetUnixFileMode(dir, ExecutableMode);
}
string Reset(string folder)
{
if (Directory.Exists(folder)) Directory.Delete(folder, recursive: true);
Directory.CreateDirectory(folder);
return folder;
}
string Size(string file) => $"{new FileInfo(file).Length / 1024.0 / 1024.0:0.0} MB";
string Option(string key)
{
var i = Array.IndexOf(args, key);
return i >= 0 && i + 1 < args.Length ? args[i + 1] : null;
}
void Dotnet(string[] arguments) => Run("dotnet", [.. arguments, "-nologo", "-nodeReuse:false"]);
void RunTool(string script, params string[] arguments) => RunIn(root, "dotnet", ["run", Path.Combine("tools", script), "--", .. arguments]);
void Run(string file, params string[] arguments) => RunIn(root, file, arguments);
void RunIn(string directory, string file, params string[] arguments)
{
var info = new ProcessStartInfo(file) { UseShellExecute = false, WorkingDirectory = directory };
foreach (var argument in arguments) info.ArgumentList.Add(argument);
using var process = Process.Start(info) ?? throw new InvalidOperationException($"cannot start {file}");
process.WaitForExit();
if (process.ExitCode != 0) throw new InvalidOperationException($"{file} {string.Join(' ', arguments.Take(2))} exited with code {process.ExitCode}");
}
string Capture(string file, params string[] arguments)
{
var info = new ProcessStartInfo(file) { UseShellExecute = false, RedirectStandardOutput = true };
foreach (var argument in arguments) info.ArgumentList.Add(argument);
using var process = Process.Start(info) ?? throw new InvalidOperationException($"cannot start {file}");
var text = process.StandardOutput.ReadToEnd();
process.WaitForExit();
return text;
}
static string FindRoot()
{
var dir = new DirectoryInfo(Directory.GetCurrentDirectory());
while (dir is not null && !File.Exists(Path.Combine(dir.FullName, "MeWeb.slnx"))) dir = dir.Parent;
return dir?.FullName ?? throw new InvalidOperationException("run from inside the repository (MeWeb.slnx not found)");
}
+4
View File
@@ -0,0 +1,4 @@
#!/bin/sh
set -e
. "$(dirname "$0")/sdk.sh"
exec dotnet run tools/release.cs -- "$@"
Executable
+16
View File
@@ -0,0 +1,16 @@
root="$(cd "$(dirname "$0")/.." && pwd)"
sdk=$(sed -n 's/.*"version": *"\([^"]*\)".*/\1/p' "$root/global.json" | head -n 1)
has_sdk() { [ -x "$1/dotnet" ] && [ -w "$1" ] && (cd "$root" && "$1/dotnet" --version >/dev/null 2>&1); }
dotnet_dir=""
for candidate in "$DOTNET_ROOT" "$HOME/.dotnet"; do
if [ -n "$candidate" ] && has_sdk "$candidate"; then dotnet_dir="$candidate"; break; fi
done
if [ -z "$dotnet_dir" ]; then
dotnet_dir="$HOME/.dotnet"
echo ".NET SDK $sdk not found: installing it into $dotnet_dir"
script="${TMPDIR:-/tmp}/dotnet-install.sh"
curl -fsSL https://dot.net/v1/dotnet-install.sh -o "$script"
bash "$script" --version "$sdk" --install-dir "$dotnet_dir"
fi
export DOTNET_ROOT="$dotnet_dir" PATH="$dotnet_dir:$PATH" DOTNET_CLI_TELEMETRY_OPTOUT=1 DOTNET_NOLOGO=1
cd "$root"
+160
View File
@@ -0,0 +1,160 @@
using System.Diagnostics;
using System.IO.Compression;
using System.Runtime.InteropServices;
using System.Security.Cryptography;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Text.Json.Nodes;
var root = FindRoot();
var manifestPath = Path.Combine(root, "tools", "setup.json");
var cache = Path.Combine(root, "tools", "cache");
var group = Option("--group");
var rid = Option("--rid") ?? HostRid();
var only = Option("--only")?.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
var force = args.Contains("--force");
var pin = args.Contains("--pin");
var verify = args.Contains("--verify");
var manifest = JsonNode.Parse(File.ReadAllText(manifestPath));
var assets = manifest["assets"].AsArray();
var failures = 0;
var pinned = false;
using var http = new HttpClient { Timeout = TimeSpan.FromHours(1) };
http.DefaultRequestHeaders.UserAgent.ParseAdd("meweb-setup/1.0");
foreach (var asset in assets)
{
var name = (string)asset["name"];
if (group is not null && (string)asset["group"] != group) continue;
var assetRid = (string)asset["rid"];
if (assetRid is not null && assetRid != rid) continue;
if (only is not null && !only.Contains(name)) continue;
var check = Path.Combine(root, (string)asset["check"]);
var present = File.Exists(check) || Directory.Exists(check);
if (verify)
{
Console.WriteLine($"{(present ? "ok " : "MISSING")} {name,-12} {asset["version"],-28} {asset["license"]}");
if (!present) failures++;
continue;
}
if (present && !force)
{
Console.WriteLine($"ok {name} (already present)");
continue;
}
try
{
var url = (string)asset["url"];
var expected = ((string)asset["sha256"] ?? "").ToLowerInvariant();
if (expected.Length == 0 && !pin)
throw new InvalidOperationException("SHA-256 not pinned in the manifest: run once with --pin and review the value written");
Directory.CreateDirectory(cache);
var file = Path.Combine(cache, $"{name}-{asset["version"]}-{Path.GetFileName(new Uri(url).LocalPath)}".Replace(' ', '_'));
if (!File.Exists(file) || force) await Download(http, url, file, name);
var actual = await Hash(file);
if (expected.Length == 0)
{
asset["sha256"] = actual;
pinned = true;
Console.WriteLine($"pin {name} sha256={actual}");
}
else if (actual != expected)
{
File.Delete(file);
throw new InvalidOperationException($"SHA-256 mismatch: expected {expected}, got {actual}");
}
var dest = Path.Combine(root, (string)asset["dest"]);
Directory.CreateDirectory(dest);
switch ((string)asset["kind"])
{
case "file":
File.Copy(file, Path.Combine(dest, Path.GetFileName(new Uri(url).LocalPath)), overwrite: true);
break;
case "zip":
ZipFile.ExtractToDirectory(file, dest, overwriteFiles: true);
break;
case "tar":
Run("tar", "-xf", file, "-C", dest);
break;
default:
throw new InvalidOperationException($"unknown kind: {asset["kind"]}");
}
if (!File.Exists(check) && !Directory.Exists(check))
throw new InvalidOperationException($"{asset["check"]} is missing after extraction");
Console.WriteLine($"done {name}");
}
catch (Exception ex)
{
failures++;
Console.Error.WriteLine($"ERROR {name}: {ex.Message}");
}
}
if (pinned)
File.WriteAllText(manifestPath, manifest.ToJsonString(new JsonSerializerOptions { WriteIndented = true, Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping }) + Environment.NewLine);
return failures == 0 ? 0 : 1;
string Option(string key)
{
var i = Array.IndexOf(args, key);
return i >= 0 && i + 1 < args.Length ? args[i + 1] : null;
}
static string FindRoot()
{
var dir = new DirectoryInfo(Directory.GetCurrentDirectory());
while (dir is not null && !File.Exists(Path.Combine(dir.FullName, "MeWeb.slnx"))) dir = dir.Parent;
return dir?.FullName ?? throw new InvalidOperationException("run from inside the repository (MeWeb.slnx not found)");
}
static async Task Download(HttpClient http, string url, string file, string name)
{
var partial = file + ".part";
using var response = await http.GetAsync(url, HttpCompletionOption.ResponseHeadersRead);
response.EnsureSuccessStatusCode();
var total = response.Content.Headers.ContentLength ?? -1;
await using (var source = await response.Content.ReadAsStreamAsync())
await using (var target = File.Create(partial))
{
var buffer = new byte[1 << 20];
var done = 0L;
var lastReport = Stopwatch.StartNew();
var read = default(int);
while ((read = await source.ReadAsync(buffer)) > 0)
{
await target.WriteAsync(buffer.AsMemory(0, read));
done += read;
if (lastReport.ElapsedMilliseconds < 2000) continue;
lastReport.Restart();
Console.WriteLine(total > 0 ? $"fetch {name}: {done * 100 / total}% ({done >> 20}/{total >> 20} MB)" : $"fetch {name}: {done >> 20} MB");
}
}
File.Move(partial, file, overwrite: true);
}
static async Task<string> Hash(string file)
{
await using var stream = File.OpenRead(file);
return Convert.ToHexStringLower(await SHA256.HashDataAsync(stream));
}
static void Run(string file, params string[] arguments)
{
var info = new ProcessStartInfo(file) { UseShellExecute = false };
foreach (var argument in arguments) info.ArgumentList.Add(argument);
using var process = Process.Start(info) ?? throw new InvalidOperationException($"cannot start {file}");
process.WaitForExit();
if (process.ExitCode != 0) throw new InvalidOperationException($"{file} exited with code {process.ExitCode}");
}
static string HostRid() =>
RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "win-x64"
: RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? "osx-arm64"
: "linux-x64";
+52
View File
@@ -0,0 +1,52 @@
{
"assets": [
{
"name": "nfpm",
"group": "packaging",
"version": "2.47.0",
"license": "MIT (build tool, not distributed)",
"rid": "linux-x64",
"url": "https://github.com/goreleaser/nfpm/releases/download/v2.47.0/nfpm_2.47.0_Linux_x86_64.tar.gz",
"sha256": "0660ca602b2d2d2ae4781a06c692b3eeb9d437ffea05b831d76e41f4a3188783",
"kind": "tar",
"dest": "tools/packaging/linux-x64",
"check": "tools/packaging/linux-x64/nfpm"
},
{
"name": "jdk",
"group": "jdk",
"version": "Microsoft OpenJDK 21.0.12",
"license": "GPL-2.0 with Classpath Exception (build tool, not distributed)",
"rid": "linux-x64",
"url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.12-linux-x64.tar.gz",
"sha256": "f2a84ad31ebeaf3a26252dd86a4a8e1b74aefb6bfc8e55fd20190110d1353c0f",
"kind": "tar",
"dest": "tools/jdk/linux-x64",
"check": "tools/jdk/linux-x64/jdk-21.0.12+8/bin/java"
},
{
"name": "jdk",
"group": "jdk",
"version": "Microsoft OpenJDK 21.0.12",
"license": "GPL-2.0 with Classpath Exception (build tool, not distributed)",
"rid": "win-x64",
"url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.12-windows-x64.zip",
"sha256": "bf27a5d6298c736af8daf5b8c883098e83291446e5766118d8a5ea6a2617195d",
"kind": "zip",
"dest": "tools/jdk/win-x64",
"check": "tools/jdk/win-x64/jdk-21.0.12+8/bin/java.exe"
},
{
"name": "jdk",
"group": "jdk",
"version": "Microsoft OpenJDK 21.0.12",
"license": "GPL-2.0 with Classpath Exception (build tool, not distributed)",
"rid": "osx-arm64",
"url": "https://aka.ms/download-jdk/microsoft-jdk-21.0.12-macos-aarch64.tar.gz",
"sha256": "56f338a3c6af071649047e78f2d31a2ca97c57be6c1b2c213823acb016463ee1",
"kind": "tar",
"dest": "tools/jdk/osx-arm64",
"check": "tools/jdk/osx-arm64/jdk-21.0.12+8/Contents/Home/bin/java"
}
]
}